Class BinaryTimeSeriesApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

deleteTimeSeriesBinaryWithName deleteTimeSeriesBinaryWithNameRaw getTimeSeriesBinary getTimeSeriesBinaryRaw getTimeSeriesBinaryWithNameValue getTimeSeriesBinaryWithNameValueRaw patchTimeSeriesBinaryWithName patchTimeSeriesBinaryWithNameRaw postTimeSeriesBinary postTimeSeriesBinaryRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = ...

Methods

deleteTimeSeriesBinaryWithName

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

  • Deletes requested binary timeseries id Delete timeseries binary with name

    Parameters

    Returns Promise<void>

deleteTimeSeriesBinaryWithNameRaw

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

  • Deletes requested binary timeseries id Delete timeseries binary with name

    Parameters

    Returns Promise<ApiResponse<void>>

getTimeSeriesBinary

  • getTimeSeriesBinary(requestParameters, initOverrides?): Promise<BinaryTimeSeries>

  • Retrieve binary 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<BinaryTimeSeries>

getTimeSeriesBinaryRaw

  • getTimeSeriesBinaryRaw(requestParameters, initOverrides?): Promise<ApiResponse<BinaryTimeSeries>>

  • Retrieve binary 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<BinaryTimeSeries>>

getTimeSeriesBinaryWithNameValue

  • getTimeSeriesBinaryWithNameValue(requestParameters, initOverrides?): Promise<Blob>

  • Get timeseries binary with name value

    Parameters

    Returns Promise<Blob>

getTimeSeriesBinaryWithNameValueRaw

  • getTimeSeriesBinaryWithNameValueRaw(requestParameters, initOverrides?): Promise<ApiResponse<Blob>>

  • Get timeseries binary with name value

    Parameters

    Returns Promise<ApiResponse<Blob>>

patchTimeSeriesBinaryWithName

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

  • Updates a binary timeseries Patch timeseries binary with name

    Parameters

    Returns Promise<void>

patchTimeSeriesBinaryWithNameRaw

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

  • Updates a binary timeseries Patch timeseries binary with name

    Parameters

    Returns Promise<ApiResponse<void>>

postTimeSeriesBinary

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

  • Create new BinaryTimeSeries Post timeseries binary

    Parameters

    Returns Promise<void>

postTimeSeriesBinaryRaw

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

  • Create new BinaryTimeSeries Post timeseries binary

    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

constructorconfigurationdeleteTimeSeriesBinaryWithNamedeleteTimeSeriesBinaryWithNameRawgetTimeSeriesBinarygetTimeSeriesBinaryRawgetTimeSeriesBinaryWithNameValuegetTimeSeriesBinaryWithNameValueRawpatchTimeSeriesBinaryWithNamepatchTimeSeriesBinaryWithNameRawpostTimeSeriesBinarypostTimeSeriesBinaryRawrequestwithMiddlewarewithPostMiddlewarewithPreMiddleware