Class RatingsApi

Hierarchy (view full)

BaseAPI
- RatingsApi

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteRatingsSpecWithRatingId

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

deleteRatingsSpecWithRatingIdRaw

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

deleteRatingsTemplateWithTemplateId

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

deleteRatingsTemplateWithTemplateIdRaw

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

deleteRatingsWithRatingId

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

deleteRatingsWithRatingIdRaw

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

getRatings

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

getRatingsMetadata

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

getRatingsMetadataRaw

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

getRatingsRaw

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

getRatingsSpec

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

getRatingsSpecRaw

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

getRatingsSpecWithRatingId

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

getRatingsSpecWithRatingIdRaw

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

getRatingsTemplate

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

getRatingsTemplateRaw

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

getRatingsTemplateWithTemplateId

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

getRatingsTemplateWithTemplateIdRaw

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

getRatingsWithRatingId

getRatingsWithRatingId(requestParameters, initOverrides?): Promise<object>
Returns CWMS Rating Data Get cwmsData ratings with ratingId
Parameters
- requestParameters: GetRatingsWithRatingIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in cwmsjs/src/apis/RatingsApi.ts:680

getRatingsWithRatingIdRaw

getRatingsWithRatingIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<object>>
Returns CWMS Rating Data Get cwmsData ratings with ratingId
Parameters
- requestParameters: GetRatingsWithRatingIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in cwmsjs/src/apis/RatingsApi.ts:627

`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

patchRatingsWithRatingId

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

patchRatingsWithRatingIdRaw

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

postRatings

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

postRatingsRaw

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

postRatingsSpec

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

postRatingsSpecRaw

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

postRatingsTemplate

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

postRatingsTemplateRaw

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

`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