Class TimeSeriesGroupsApi

Hierarchy (view full)

BaseAPI
- TimeSeriesGroupsApi

Index

Constructors

Properties

Methods

deleteTimeSeriesGroupWithGroupId deleteTimeSeriesGroupWithGroupIdRaw getTimeSeriesGroup getTimeSeriesGroupRaw getTimeSeriesGroupWithGroupId getTimeSeriesGroupWithGroupIdRaw isJsonMime patchTimeSeriesGroupWithGroupId patchTimeSeriesGroupWithGroupIdRaw postTimeSeriesGroup postTimeSeriesGroupRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new TimeSeriesGroupsApi(configuration?): TimeSeriesGroupsApi
Parameters
- configuration: Configuration = DefaultConfig
Returns TimeSeriesGroupsApi
Inherited from BaseAPI.constructor
- Defined in cwmsjs/src/runtime.ts:97

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteTimeSeriesGroupWithGroupId

deleteTimeSeriesGroupWithGroupId(requestParameters, initOverrides?): Promise<void>
Deletes requested time series group Delete cwmsData timeseries group with groupId
Parameters
- requestParameters: DeleteTimeSeriesGroupWithGroupIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/TimeSeriesGroupsApi.ts:120

deleteTimeSeriesGroupWithGroupIdRaw

deleteTimeSeriesGroupWithGroupIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Deletes requested time series group Delete cwmsData timeseries group with groupId
Parameters
- requestParameters: DeleteTimeSeriesGroupWithGroupIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/TimeSeriesGroupsApi.ts:68

getTimeSeriesGroup

getTimeSeriesGroup(requestParameters?, initOverrides?): Promise<TimeSeriesGroup[]>
Returns CWMS Timeseries Groups Data Get cwmsData timeseries group
Parameters
- requestParameters: GetTimeSeriesGroupRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<TimeSeriesGroup[]>
- Defined in cwmsjs/src/apis/TimeSeriesGroupsApi.ts:163

getTimeSeriesGroupRaw

getTimeSeriesGroupRaw(requestParameters, initOverrides?): Promise<ApiResponse<TimeSeriesGroup[]>>
Returns CWMS Timeseries Groups Data Get cwmsData timeseries group
Parameters
- requestParameters: GetTimeSeriesGroupRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<TimeSeriesGroup[]>>
- Defined in cwmsjs/src/apis/TimeSeriesGroupsApi.ts:128

getTimeSeriesGroupWithGroupId

getTimeSeriesGroupWithGroupId(requestParameters, initOverrides?): Promise<TimeSeriesGroup>
Retrieves requested timeseries group Get cwmsData timeseries group with groupId
Parameters
- requestParameters: GetTimeSeriesGroupWithGroupIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<TimeSeriesGroup>
- Defined in cwmsjs/src/apis/TimeSeriesGroupsApi.ts:220

getTimeSeriesGroupWithGroupIdRaw

getTimeSeriesGroupWithGroupIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<TimeSeriesGroup>>
Retrieves requested timeseries group Get cwmsData timeseries group with groupId
Parameters
- requestParameters: GetTimeSeriesGroupWithGroupIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<TimeSeriesGroup>>
- Defined in cwmsjs/src/apis/TimeSeriesGroupsApi.ts:172

`Protected` isJsonMime

isJsonMime(mime): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in cwmsjs/src/runtime.ts:127

patchTimeSeriesGroupWithGroupId

patchTimeSeriesGroupWithGroupId(requestParameters, initOverrides?): Promise<void>
Update existing TimeSeriesGroup Patch cwmsData timeseries group with groupId
Parameters
- requestParameters: PatchTimeSeriesGroupWithGroupIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/TimeSeriesGroupsApi.ts:284

patchTimeSeriesGroupWithGroupIdRaw

patchTimeSeriesGroupWithGroupIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Update existing TimeSeriesGroup Patch cwmsData timeseries group with groupId
Parameters
- requestParameters: PatchTimeSeriesGroupWithGroupIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/TimeSeriesGroupsApi.ts:229

postTimeSeriesGroup

postTimeSeriesGroup(requestParameters, initOverrides?): Promise<void>
Create new TimeSeriesGroup Post cwmsData timeseries group
Parameters
- requestParameters: PostTimeSeriesGroupRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/TimeSeriesGroupsApi.ts:329

postTimeSeriesGroupRaw

postTimeSeriesGroupRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new TimeSeriesGroup Post cwmsData timeseries group
Parameters
- requestParameters: PostTimeSeriesGroupRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/TimeSeriesGroupsApi.ts:292

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in cwmsjs/src/runtime.ts:134

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in cwmsjs/src/runtime.ts:101

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in cwmsjs/src/runtime.ts:112

withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in cwmsjs/src/runtime.ts:107