Class LookupTypesApi

Hierarchy (view full)

BaseAPI
- LookupTypesApi

Index

Constructors

Properties

Methods

deleteLookupTypesWithName deleteLookupTypesWithNameRaw getLookupTypes getLookupTypesRaw isJsonMime patchLookupTypesWithName patchLookupTypesWithNameRaw postLookupTypes postLookupTypesRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteLookupTypesWithName

deleteLookupTypesWithName(requestParameters, initOverrides?): Promise<void>
Delete CWMS Lookup Type Delete cwmsData lookupTypes with name
Parameters
- requestParameters: DeleteLookupTypesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/LookupTypesApi.ts:126

deleteLookupTypesWithNameRaw

deleteLookupTypesWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete CWMS Lookup Type Delete cwmsData lookupTypes with name
Parameters
- requestParameters: DeleteLookupTypesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LookupTypesApi.ts:63

getLookupTypes

getLookupTypes(requestParameters, initOverrides?): Promise<LookupType[]>
Returns matching CWMS Lookup Type Data. Get cwmsData lookupTypes
Parameters
- requestParameters: GetLookupTypesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<LookupType[]>
- Defined in cwmsjs/src/apis/LookupTypesApi.ts:190

getLookupTypesRaw

getLookupTypesRaw(requestParameters, initOverrides?): Promise<ApiResponse<LookupType[]>>
Returns matching CWMS Lookup Type Data. Get cwmsData lookupTypes
Parameters
- requestParameters: GetLookupTypesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<LookupType[]>>
- Defined in cwmsjs/src/apis/LookupTypesApi.ts:134

`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

patchLookupTypesWithName

patchLookupTypesWithName(requestParameters, initOverrides?): Promise<void>
Update CWMS Lookup Type Patch cwmsData lookupTypes with name
Parameters
- requestParameters: PatchLookupTypesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/LookupTypesApi.ts:261

patchLookupTypesWithNameRaw

patchLookupTypesWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Update CWMS Lookup Type Patch cwmsData lookupTypes with name
Parameters
- requestParameters: PatchLookupTypesWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LookupTypesApi.ts:199

postLookupTypes

postLookupTypes(requestParameters, initOverrides?): Promise<void>
Create CWMS Lookup Type Post cwmsData lookupTypes
Parameters
- requestParameters: PostLookupTypesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/LookupTypesApi.ts:324

postLookupTypesRaw

postLookupTypesRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create CWMS Lookup Type Post cwmsData lookupTypes
Parameters
- requestParameters: PostLookupTypesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LookupTypesApi.ts:269

`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