Class StandardTextApi

Hierarchy (view full)

BaseAPI
- StandardTextApi

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteStandardTextIdWithStandardTextId

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

deleteStandardTextIdWithStandardTextIdRaw

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

getStandardTextId

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

getStandardTextIdRaw

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

getStandardTextIdWithStandardTextId

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

getStandardTextIdWithStandardTextIdRaw

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

`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

postStandardTextId

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

postStandardTextIdRaw

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

`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