Class RatingsApi

Hierarchy (view full)

BaseAPI
- RatingsApi

Index

Constructors

Properties

Methods

deleteRatingsSpecWithRatingId deleteRatingsSpecWithRatingIdRaw deleteRatingsTemplateWithTemplateId deleteRatingsTemplateWithTemplateIdRaw deleteRatingsWithRatingId deleteRatingsWithRatingIdRaw getRatings getRatingsEffectiveDates getRatingsEffectiveDatesRaw getRatingsMetadata getRatingsMetadataRaw getRatingsRaw getRatingsSpec getRatingsSpecRaw getRatingsSpecWithRatingId getRatingsSpecWithRatingIdRaw getRatingsTemplate getRatingsTemplateRaw getRatingsTemplateWithTemplateId getRatingsTemplateWithTemplateIdRaw getRatingsWithRatingId getRatingsWithRatingIdLatest getRatingsWithRatingIdLatestRaw getRatingsWithRatingIdRaw patchRatingsWithRatingId patchRatingsWithRatingIdRaw postRatings postRatingsRateTsWithOfficeWithRatingId postRatingsRateTsWithOfficeWithRatingIdRaw postRatingsRateValuesWithOfficeWithRatingId postRatingsRateValuesWithOfficeWithRatingIdRaw postRatingsRaw postRatingsReverseRateTsWithOfficeWithRatingId postRatingsReverseRateTsWithOfficeWithRatingIdRaw postRatingsReverseRateValuesWithOfficeWithRatingId postRatingsReverseRateValuesWithOfficeWithRatingIdRaw postRatingsSpec postRatingsSpecRaw postRatingsTemplate postRatingsTemplateRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteRatingsSpecWithRatingId

deleteRatingsSpecWithRatingId(requestParameters, initOverrides?): Promise<void>
Deletes requested rating specification Delete ratings spec with ratingId
Parameters
- requestParameters: DeleteRatingsSpecWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/RatingsApi.ts:244

deleteRatingsSpecWithRatingIdRaw

deleteRatingsSpecWithRatingIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Deletes requested rating specification Delete ratings spec with ratingId
Parameters
- requestParameters: DeleteRatingsSpecWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:201

deleteRatingsTemplateWithTemplateId

deleteRatingsTemplateWithTemplateId(requestParameters, initOverrides?): Promise<void>
Deletes requested rating specification Delete ratings template with templateId
Parameters
- requestParameters: DeleteRatingsTemplateWithTemplateIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/RatingsApi.ts:295

deleteRatingsTemplateWithTemplateIdRaw

deleteRatingsTemplateWithTemplateIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Deletes requested rating specification Delete ratings template with templateId
Parameters
- requestParameters: DeleteRatingsTemplateWithTemplateIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:252

deleteRatingsWithRatingId

deleteRatingsWithRatingId(requestParameters, initOverrides?): Promise<void>
Delete ratings with ratingId
Parameters
- requestParameters: DeleteRatingsWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/RatingsApi.ts:356

deleteRatingsWithRatingIdRaw

deleteRatingsWithRatingIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete ratings with ratingId
Parameters
- requestParameters: DeleteRatingsWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:302

getRatings

getRatings(requestParameters?, initOverrides?): Promise<object>
Get ratings
Parameters
- requestParameters: GetRatingsRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<object>
- Defined in cwmsjs/src/apis/RatingsApi.ts:417

getRatingsEffectiveDates

getRatingsEffectiveDates(requestParameters?, initOverrides?): Promise<RatingEffectiveDatesMap>
Returns mapping of office -> spec id -> effective date-times for all matching offices and spec ids. Get ratings effectiveDates
Parameters
- requestParameters: GetRatingsEffectiveDatesRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<RatingEffectiveDatesMap>
- Defined in cwmsjs/src/apis/RatingsApi.ts:469

getRatingsEffectiveDatesRaw

getRatingsEffectiveDatesRaw(requestParameters, initOverrides?): Promise<ApiResponse<RatingEffectiveDatesMap>>
Returns mapping of office -> spec id -> effective date-times for all matching offices and spec ids. Get ratings effectiveDates
Parameters
- requestParameters: GetRatingsEffectiveDatesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<RatingEffectiveDatesMap>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:426

getRatingsMetadata

getRatingsMetadata(requestParameters?, initOverrides?): Promise<RatingMetadataList>
Get ratings metadata
Parameters
- requestParameters: GetRatingsMetadataRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<RatingMetadataList>
- Defined in cwmsjs/src/apis/RatingsApi.ts:527

getRatingsMetadataRaw

getRatingsMetadataRaw(requestParameters, initOverrides?): Promise<ApiResponse<RatingMetadataList>>
Get ratings metadata
Parameters
- requestParameters: GetRatingsMetadataRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<RatingMetadataList>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:477

getRatingsRaw

getRatingsRaw(requestParameters, initOverrides?): Promise<ApiResponse<object>>
Get ratings
Parameters
- requestParameters: GetRatingsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<object>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:363

getRatingsSpec

getRatingsSpec(requestParameters?, initOverrides?): Promise<RatingSpecs>
Get ratings spec
Parameters
- requestParameters: GetRatingsSpecRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<RatingSpecs>
- Defined in cwmsjs/src/apis/RatingsApi.ts:573

getRatingsSpecRaw

getRatingsSpecRaw(requestParameters, initOverrides?): Promise<ApiResponse<RatingSpecs>>
Get ratings spec
Parameters
- requestParameters: GetRatingsSpecRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<RatingSpecs>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:535

getRatingsSpecWithRatingId

getRatingsSpecWithRatingId(requestParameters, initOverrides?): Promise<RatingSpec>
Get ratings spec with ratingId
Parameters
- requestParameters: GetRatingsSpecWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<RatingSpec>
- Defined in cwmsjs/src/apis/RatingsApi.ts:615

getRatingsSpecWithRatingIdRaw

getRatingsSpecWithRatingIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<RatingSpec>>
Get ratings spec with ratingId
Parameters
- requestParameters: GetRatingsSpecWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<RatingSpec>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:581

getRatingsTemplate

getRatingsTemplate(requestParameters?, initOverrides?): Promise<RatingTemplates>
Get ratings template
Parameters
- requestParameters: GetRatingsTemplateRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<RatingTemplates>
- Defined in cwmsjs/src/apis/RatingsApi.ts:661

getRatingsTemplateRaw

getRatingsTemplateRaw(requestParameters, initOverrides?): Promise<ApiResponse<RatingTemplates>>
Get ratings template
Parameters
- requestParameters: GetRatingsTemplateRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<RatingTemplates>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:623

getRatingsTemplateWithTemplateId

getRatingsTemplateWithTemplateId(requestParameters, initOverrides?): Promise<RatingTemplate[]>
Get ratings template with templateId
Parameters
- requestParameters: GetRatingsTemplateWithTemplateIdRequest
- Optional initOverrides: RequestInit
Returns Promise<RatingTemplate[]>
- Defined in cwmsjs/src/apis/RatingsApi.ts:703

getRatingsTemplateWithTemplateIdRaw

getRatingsTemplateWithTemplateIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<RatingTemplate[]>>
Get ratings template with templateId
Parameters
- requestParameters: GetRatingsTemplateWithTemplateIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<RatingTemplate[]>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:669

getRatingsWithRatingId

getRatingsWithRatingId(requestParameters, initOverrides?): Promise<object>
Returns CWMS Rating Data. Supports accept header formatting. For more information about accept header usage, <a href="legacy-format/">see this page. Get ratings with ratingId
Parameters
- requestParameters: GetRatingsWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<object>
- Defined in cwmsjs/src/apis/RatingsApi.ts:763

getRatingsWithRatingIdLatest

getRatingsWithRatingIdLatest(requestParameters, initOverrides?): Promise<object>
Returns CWMS Rating Data Get ratings with ratingId latest
Parameters
- requestParameters: GetRatingsWithRatingIdLatestRequest
- Optional initOverrides: RequestInit
Returns Promise<object>
- Defined in cwmsjs/src/apis/RatingsApi.ts:807

getRatingsWithRatingIdLatestRaw

getRatingsWithRatingIdLatestRaw(requestParameters, initOverrides?): Promise<ApiResponse<object>>
Returns CWMS Rating Data Get ratings with ratingId latest
Parameters
- requestParameters: GetRatingsWithRatingIdLatestRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<object>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:772

getRatingsWithRatingIdRaw

getRatingsWithRatingIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<object>>
Returns CWMS Rating Data. Supports accept header formatting. For more information about accept header usage, <a href="legacy-format/">see this page. Get ratings with ratingId
Parameters
- requestParameters: GetRatingsWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<object>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:712

patchRatingsWithRatingId

patchRatingsWithRatingId(requestParameters, initOverrides?): Promise<void>
Update a RatingSet Patch ratings with ratingId
Parameters
- requestParameters: PatchRatingsWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/RatingsApi.ts:858

patchRatingsWithRatingIdRaw

patchRatingsWithRatingIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Update a RatingSet Patch ratings with ratingId
Parameters
- requestParameters: PatchRatingsWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:816

postRatings

postRatings(requestParameters, initOverrides?): Promise<void>
Create new RatingSet Post ratings
Parameters
- requestParameters: PostRatingsRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/RatingsApi.ts:900

postRatingsRateTsWithOfficeWithRatingId

postRatingsRateTsWithOfficeWithRatingId(requestParameters, initOverrides?): Promise<RatedOutputTimeSeries>
Rates input values using CWMS ratings. The input format RateInputTimeSeries DTO supports an array of CWMS time series ids, each corresponding to an independent parameter in the rating curve.The output format RatedOutputTimeSeries will contain a singular double array corresponding to the dependent parameter of the rating curve. Post ratings rateTs with office with ratingId
Parameters
- requestParameters: PostRatingsRateTsWithOfficeWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<RatedOutputTimeSeries>
- Defined in cwmsjs/src/apis/RatingsApi.ts:946

postRatingsRateTsWithOfficeWithRatingIdRaw

postRatingsRateTsWithOfficeWithRatingIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<RatedOutputTimeSeries>>
Rates input values using CWMS ratings. The input format RateInputTimeSeries DTO supports an array of CWMS time series ids, each corresponding to an independent parameter in the rating curve.The output format RatedOutputTimeSeries will contain a singular double array corresponding to the dependent parameter of the rating curve. Post ratings rateTs with office with ratingId
Parameters
- requestParameters: PostRatingsRateTsWithOfficeWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<RatedOutputTimeSeries>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:908

postRatingsRateValuesWithOfficeWithRatingId

postRatingsRateValuesWithOfficeWithRatingId(requestParameters, initOverrides?): Promise<RatedOutputValues>
Rates input values using CWMS ratings. The input format RatingInputValues includes a two dimensional array with each dimension corresponding to an independent parameter in the rating curve. The output format RatedOutputTimeSeries will contain a singular double array corresponding to the dependent parameter of the rating curve. Post ratings rateValues with office with ratingId
Parameters
- requestParameters: PostRatingsRateValuesWithOfficeWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<RatedOutputValues>
- Defined in cwmsjs/src/apis/RatingsApi.ts:993

postRatingsRateValuesWithOfficeWithRatingIdRaw

postRatingsRateValuesWithOfficeWithRatingIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<RatedOutputValues>>
Rates input values using CWMS ratings. The input format RatingInputValues includes a two dimensional array with each dimension corresponding to an independent parameter in the rating curve. The output format RatedOutputTimeSeries will contain a singular double array corresponding to the dependent parameter of the rating curve. Post ratings rateValues with office with ratingId
Parameters
- requestParameters: PostRatingsRateValuesWithOfficeWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<RatedOutputValues>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:955

postRatingsRaw

postRatingsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new RatingSet Post ratings
Parameters
- requestParameters: PostRatingsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:866

postRatingsReverseRateTsWithOfficeWithRatingId

postRatingsReverseRateTsWithOfficeWithRatingId(requestParameters, initOverrides?): Promise<RatedOutputTimeSeries>
Reverse rates input values using CWMS ratings. The input format RateInputTimeSeries requires a singular time series id corresponding to the dependent parameter in the rating curve. The output format RatedOutputTimeSeries will contain a singular double array corresponding to the independent parameter of the rating curve. Note: This endpoint only works on monotonically increase/decreasing table ratings with a single independent parameter. Post ratings reverseRateTs with office with ratingId
Parameters
- requestParameters: PostRatingsReverseRateTsWithOfficeWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<RatedOutputTimeSeries>
- Defined in cwmsjs/src/apis/RatingsApi.ts:1040

postRatingsReverseRateTsWithOfficeWithRatingIdRaw

postRatingsReverseRateTsWithOfficeWithRatingIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<RatedOutputTimeSeries>>
Reverse rates input values using CWMS ratings. The input format RateInputTimeSeries requires a singular time series id corresponding to the dependent parameter in the rating curve. The output format RatedOutputTimeSeries will contain a singular double array corresponding to the independent parameter of the rating curve. Note: This endpoint only works on monotonically increase/decreasing table ratings with a single independent parameter. Post ratings reverseRateTs with office with ratingId
Parameters
- requestParameters: PostRatingsReverseRateTsWithOfficeWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<RatedOutputTimeSeries>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:1002

postRatingsReverseRateValuesWithOfficeWithRatingId

postRatingsReverseRateValuesWithOfficeWithRatingId(requestParameters, initOverrides?): Promise<RatedOutputValues>
Reverse rates input values using CWMS ratings. The input format RateInputValues requires a singular array of doubles corresponding to the dependent parameter in the rating curve. The output format RatedOutputValues will contain a singular double array corresponding to the independent parameter of the rating curve. Note: This endpoint only works on monotonically increase/decreasing table ratings with a single independent parameter. Post ratings reverseRateValues with office with ratingId
Parameters
- requestParameters: PostRatingsReverseRateValuesWithOfficeWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<RatedOutputValues>
- Defined in cwmsjs/src/apis/RatingsApi.ts:1087

postRatingsReverseRateValuesWithOfficeWithRatingIdRaw

postRatingsReverseRateValuesWithOfficeWithRatingIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<RatedOutputValues>>
Reverse rates input values using CWMS ratings. The input format RateInputValues requires a singular array of doubles corresponding to the dependent parameter in the rating curve. The output format RatedOutputValues will contain a singular double array corresponding to the independent parameter of the rating curve. Note: This endpoint only works on monotonically increase/decreasing table ratings with a single independent parameter. Post ratings reverseRateValues with office with ratingId
Parameters
- requestParameters: PostRatingsReverseRateValuesWithOfficeWithRatingIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<RatedOutputValues>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:1049

postRatingsSpec

postRatingsSpec(requestParameters, initOverrides?): Promise<void>
Create new Rating Specification Post ratings spec
Parameters
- requestParameters: PostRatingsSpecRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/RatingsApi.ts:1130

postRatingsSpecRaw

postRatingsSpecRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new Rating Specification Post ratings spec
Parameters
- requestParameters: PostRatingsSpecRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:1096

postRatingsTemplate

postRatingsTemplate(requestParameters, initOverrides?): Promise<void>
Create new Rating Template Post ratings template
Parameters
- requestParameters: PostRatingsTemplateRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/RatingsApi.ts:1172

postRatingsTemplateRaw

postRatingsTemplateRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new Rating Template Post ratings template
Parameters
- requestParameters: PostRatingsTemplateRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:1138

`Protected` request

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

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:31

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:42

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:37

Class RatingsApi

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RatingsApi

Properties

Protected configuration

Methods

deleteRatingsSpecWithRatingId

Parameters

Returns Promise<void>

deleteRatingsSpecWithRatingIdRaw

Parameters

Returns Promise<ApiResponse<void>>

deleteRatingsTemplateWithTemplateId

Parameters

Returns Promise<void>

deleteRatingsTemplateWithTemplateIdRaw

Parameters

Returns Promise<ApiResponse<void>>

deleteRatingsWithRatingId

Parameters

Returns Promise<void>

deleteRatingsWithRatingIdRaw

Parameters

Returns Promise<ApiResponse<void>>

getRatings

Parameters

Returns Promise<object>

getRatingsEffectiveDates

Parameters

Returns Promise<RatingEffectiveDatesMap>

getRatingsEffectiveDatesRaw

Parameters

Returns Promise<ApiResponse<RatingEffectiveDatesMap>>

getRatingsMetadata

Parameters

Returns Promise<RatingMetadataList>

getRatingsMetadataRaw

Parameters

Returns Promise<ApiResponse<RatingMetadataList>>

getRatingsRaw

Parameters

Returns Promise<ApiResponse<object>>

getRatingsSpec

Parameters

Returns Promise<RatingSpecs>

getRatingsSpecRaw

Parameters

Returns Promise<ApiResponse<RatingSpecs>>

getRatingsSpecWithRatingId

Parameters

Returns Promise<RatingSpec>

getRatingsSpecWithRatingIdRaw

Parameters

Returns Promise<ApiResponse<RatingSpec>>

getRatingsTemplate

Parameters

Returns Promise<RatingTemplates>

getRatingsTemplateRaw

Parameters

Returns Promise<ApiResponse<RatingTemplates>>

getRatingsTemplateWithTemplateId

Parameters

Returns Promise<RatingTemplate[]>

getRatingsTemplateWithTemplateIdRaw

Parameters

Returns Promise<ApiResponse<RatingTemplate[]>>

getRatingsWithRatingId

Parameters

Returns Promise<object>

getRatingsWithRatingIdLatest

Parameters

Returns Promise<object>

getRatingsWithRatingIdLatestRaw

`Protected` configuration

`Protected` request