Class StandardTextApi

Hierarchy (view full)

BaseAPI
- StandardTextApi

Index

Constructors

Properties

Methods

deleteStandardTextIdWithStandardTextId deleteStandardTextIdWithStandardTextIdRaw getStandardTextId getStandardTextIdRaw getStandardTextIdWithStandardTextId getStandardTextIdWithStandardTextIdRaw postStandardTextId postStandardTextIdRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteStandardTextIdWithStandardTextId

deleteStandardTextIdWithStandardTextId(requestParameters, initOverrides?): Promise<void>
Delete a single Standard Text value Delete standardTextId with standardTextId
Parameters
- requestParameters: DeleteStandardTextIdWithStandardTextIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/StandardTextApi.ts:105

deleteStandardTextIdWithStandardTextIdRaw

deleteStandardTextIdWithStandardTextIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete a single Standard Text value Delete standardTextId with standardTextId
Parameters
- requestParameters: DeleteStandardTextIdWithStandardTextIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/StandardTextApi.ts:62

getStandardTextId

getStandardTextId(requestParameters?, initOverrides?): Promise<StandardTextCatalog>
Retrieve a Standard Text catalog Get standardTextId
Parameters
- requestParameters: GetStandardTextIdRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<StandardTextCatalog>
- Defined in cwmsjs/src/apis/StandardTextApi.ts:144

getStandardTextIdRaw

getStandardTextIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<StandardTextCatalog>>
Retrieve a Standard Text catalog Get standardTextId
Parameters
- requestParameters: GetStandardTextIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<StandardTextCatalog>>
- Defined in cwmsjs/src/apis/StandardTextApi.ts:113

getStandardTextIdWithStandardTextId

getStandardTextIdWithStandardTextId(requestParameters, initOverrides?): Promise<StandardTextValue>
Retrieve a single Standard Text value Get standardTextId with standardTextId
Parameters
- requestParameters: GetStandardTextIdWithStandardTextIdRequest
- Optional initOverrides: RequestInit
Returns Promise<StandardTextValue>
- Defined in cwmsjs/src/apis/StandardTextApi.ts:188

getStandardTextIdWithStandardTextIdRaw

getStandardTextIdWithStandardTextIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<StandardTextValue>>
Retrieve a single Standard Text value Get standardTextId with standardTextId
Parameters
- requestParameters: GetStandardTextIdWithStandardTextIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<StandardTextValue>>
- Defined in cwmsjs/src/apis/StandardTextApi.ts:153

postStandardTextId

postStandardTextId(requestParameters, initOverrides?): Promise<void>
Create new Standard Text Post standardTextId
Parameters
- requestParameters: PostStandardTextIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/StandardTextApi.ts:231

postStandardTextIdRaw

postStandardTextIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new Standard Text Post standardTextId
Parameters
- requestParameters: PostStandardTextIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/StandardTextApi.ts:197

`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