Class TextTimeSeriesApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

deleteTimeSeriesTextWithName deleteTimeSeriesTextWithNameRaw getTimeSeriesText getTimeSeriesTextRaw getTimeSeriesTextWithNameValue getTimeSeriesTextWithNameValueRaw patchTimeSeriesTextWithName patchTimeSeriesTextWithNameRaw postTimeSeriesText postTimeSeriesTextRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = ...

Methods

deleteTimeSeriesTextWithName

  • deleteTimeSeriesTextWithName(requestParameters, initOverrides?): Promise<void>

  • Deletes requested text timeseries id Delete timeseries text with name

    Parameters

    Returns Promise<void>

deleteTimeSeriesTextWithNameRaw

  • deleteTimeSeriesTextWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

  • Deletes requested text timeseries id Delete timeseries text with name

    Parameters

    Returns Promise<ApiResponse<void>>

getTimeSeriesText

  • getTimeSeriesText(requestParameters, initOverrides?): Promise<TextTimeSeries>

  • Retrieve text time series values for a provided time window and date version.If individual values exceed 64 kilobytes, a URL to a separate download is provided instead of being included in the returned payload from this request.

    Parameters

    Returns Promise<TextTimeSeries>

getTimeSeriesTextRaw

  • getTimeSeriesTextRaw(requestParameters, initOverrides?): Promise<ApiResponse<TextTimeSeries>>

  • Retrieve text time series values for a provided time window and date version.If individual values exceed 64 kilobytes, a URL to a separate download is provided instead of being included in the returned payload from this request.

    Parameters

    Returns Promise<ApiResponse<TextTimeSeries>>

getTimeSeriesTextWithNameValue

  • getTimeSeriesTextWithNameValue(requestParameters, initOverrides?): Promise<string>

  • Get timeseries text with name value

    Parameters

    Returns Promise<string>

getTimeSeriesTextWithNameValueRaw

  • getTimeSeriesTextWithNameValueRaw(requestParameters, initOverrides?): Promise<ApiResponse<string>>

  • Get timeseries text with name value

    Parameters

    Returns Promise<ApiResponse<string>>

patchTimeSeriesTextWithName

  • patchTimeSeriesTextWithName(requestParameters, initOverrides?): Promise<void>

  • Updates a text timeseries Patch timeseries text with name

    Parameters

    Returns Promise<void>

patchTimeSeriesTextWithNameRaw

  • patchTimeSeriesTextWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

  • Updates a text timeseries Patch timeseries text with name

    Parameters

    Returns Promise<ApiResponse<void>>

postTimeSeriesText

  • postTimeSeriesText(requestParameters, initOverrides?): Promise<void>

  • Create new TextTimeSeries Post timeseries text

    Parameters

    Returns Promise<void>

postTimeSeriesTextRaw

  • postTimeSeriesTextRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

  • Create new TextTimeSeries Post timeseries text

    Parameters

    Returns Promise<ApiResponse<void>>

Protected request

  • request(context, initOverrides?): Promise<Response>

  • Parameters

    • context: RequestOpts
    • Optional initOverrides: RequestInit

    Returns Promise<Response>

withMiddleware

withPostMiddleware

  • withPostMiddleware<T>(this, ...postMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]

    Returns T

withPreMiddleware

  • withPreMiddleware<T>(this, ...preMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]

    Returns T

Settings

Member Visibility

Theme

On This Page

constructorconfigurationdeleteTimeSeriesTextWithNamedeleteTimeSeriesTextWithNameRawgetTimeSeriesTextgetTimeSeriesTextRawgetTimeSeriesTextWithNameValuegetTimeSeriesTextWithNameValueRawpatchTimeSeriesTextWithNamepatchTimeSeriesTextWithNameRawpostTimeSeriesTextpostTimeSeriesTextRawrequestwithMiddlewarewithPostMiddlewarewithPreMiddleware