Class ClobApi

Hierarchy (view full)

BaseAPI
- ClobApi

Index

Constructors

Properties

Methods

deleteClobsWithClobId deleteClobsWithClobIdRaw getClobs getClobsRaw getClobsWithClobId getClobsWithClobIdRaw isJsonMime patchClobsWithClobId patchClobsWithClobIdRaw postClobs postClobsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteClobsWithClobId

deleteClobsWithClobId(requestParameters, initOverrides?): Promise<void>
Delete clob Delete cwmsData clobs with clobId
Parameters
- requestParameters: DeleteClobsWithClobIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/ClobApi.ts:111

deleteClobsWithClobIdRaw

deleteClobsWithClobIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete clob Delete cwmsData clobs with clobId
Parameters
- requestParameters: DeleteClobsWithClobIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ClobApi.ts:70

getClobs

getClobs(requestParameters?, initOverrides?): Promise<Clobs>
Get cwmsData clobs
Parameters
- requestParameters: GetClobsRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Clobs>
- Defined in cwmsjs/src/apis/ClobApi.ts:156

getClobsRaw

getClobsRaw(requestParameters, initOverrides?): Promise<ApiResponse<Clobs>>
Get cwmsData clobs
Parameters
- requestParameters: GetClobsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Clobs>>
- Defined in cwmsjs/src/apis/ClobApi.ts:118

getClobsWithClobId

getClobsWithClobId(requestParameters, initOverrides?): Promise<Clob>
Get cwmsData clobs with clobId
Parameters
- requestParameters: GetClobsWithClobIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Clob>
- Defined in cwmsjs/src/apis/ClobApi.ts:197

getClobsWithClobIdRaw

getClobsWithClobIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<Clob>>
Get cwmsData clobs with clobId
Parameters
- requestParameters: GetClobsWithClobIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Clob>>
- Defined in cwmsjs/src/apis/ClobApi.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

patchClobsWithClobId

patchClobsWithClobId(requestParameters, initOverrides?): Promise<void>
Update clob Patch cwmsData clobs with clobId
Parameters
- requestParameters: PatchClobsWithClobIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/ClobApi.ts:250

patchClobsWithClobIdRaw

patchClobsWithClobIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Update clob Patch cwmsData clobs with clobId
Parameters
- requestParameters: PatchClobsWithClobIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ClobApi.ts:206

postClobs

postClobs(requestParameters, initOverrides?): Promise<void>
Create new Clob Post cwmsData clobs
Parameters
- requestParameters: PostClobsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/ClobApi.ts:295

postClobsRaw

postClobsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new Clob Post cwmsData clobs
Parameters
- requestParameters: PostClobsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ClobApi.ts:258

`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