Class PropertiesApi

Hierarchy (view full)

BaseAPI
- PropertiesApi

Index

Constructors

Properties

Methods

deletePropertiesWithName deletePropertiesWithNameRaw getProperties getPropertiesRaw getPropertiesWithName getPropertiesWithNameRaw isJsonMime patchPropertiesWithName patchPropertiesWithNameRaw postProperties postPropertiesRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deletePropertiesWithName

deletePropertiesWithName(requestParameters, initOverrides?): Promise<void>
Delete CWMS Property Delete cwmsData properties with name
Parameters
- requestParameters: DeletePropertiesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/PropertiesApi.ts:117

deletePropertiesWithNameRaw

deletePropertiesWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete CWMS Property Delete cwmsData properties with name
Parameters
- requestParameters: DeletePropertiesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/PropertiesApi.ts:65

getProperties

getProperties(requestParameters?, initOverrides?): Promise<Property[]>
Returns matching CWMS Property Data. Get cwmsData properties
Parameters
- requestParameters: GetPropertiesRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Property[]>
- Defined in cwmsjs/src/apis/PropertiesApi.ts:160

getPropertiesRaw

getPropertiesRaw(requestParameters, initOverrides?): Promise<ApiResponse<Property[]>>
Returns matching CWMS Property Data. Get cwmsData properties
Parameters
- requestParameters: GetPropertiesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Property[]>>
- Defined in cwmsjs/src/apis/PropertiesApi.ts:125

getPropertiesWithName

getPropertiesWithName(requestParameters, initOverrides?): Promise<Property>
Returns CWMS Property Data Get cwmsData properties with name
Parameters
- requestParameters: GetPropertiesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Property>
- Defined in cwmsjs/src/apis/PropertiesApi.ts:225

getPropertiesWithNameRaw

getPropertiesWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<Property>>
Returns CWMS Property Data Get cwmsData properties with name
Parameters
- requestParameters: GetPropertiesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Property>>
- Defined in cwmsjs/src/apis/PropertiesApi.ts:169

`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

patchPropertiesWithName

patchPropertiesWithName(requestParameters, initOverrides?): Promise<void>
Update CWMS Property Patch cwmsData properties with name
Parameters
- requestParameters: PatchPropertiesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/PropertiesApi.ts:274

patchPropertiesWithNameRaw

patchPropertiesWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Update CWMS Property Patch cwmsData properties with name
Parameters
- requestParameters: PatchPropertiesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/PropertiesApi.ts:234

postProperties

postProperties(requestParameters, initOverrides?): Promise<void>
Create CWMS Property Post cwmsData properties
Parameters
- requestParameters: PostPropertiesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/PropertiesApi.ts:315

postPropertiesRaw

postPropertiesRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create CWMS Property Post cwmsData properties
Parameters
- requestParameters: PostPropertiesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/PropertiesApi.ts:282

`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