Class OfficesApi

Hierarchy (view full)

BaseAPI
- OfficesApi

Index

Constructors

Properties

Methods

getOffices getOfficesRaw getOfficesWithOffice getOfficesWithOfficeRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

getOffices

getOffices(requestParameters?, initOverrides?): Promise<Office[]>
Get offices
Parameters
- requestParameters: GetOfficesRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<Office[]>
- Defined in cwmsjs/src/apis/OfficesApi.ts:77

getOfficesRaw

getOfficesRaw(requestParameters, initOverrides?): Promise<ApiResponse<Office[]>>
Get offices
Parameters
- requestParameters: GetOfficesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Office[]>>
- Defined in cwmsjs/src/apis/OfficesApi.ts:47

getOfficesWithOffice

getOfficesWithOffice(requestParameters, initOverrides?): Promise<OfficeFormatV1>
Get offices with office
Parameters
- requestParameters: GetOfficesWithOfficeRequest
- Optional initOverrides: RequestInit
Returns Promise<OfficeFormatV1>
- Defined in cwmsjs/src/apis/OfficesApi.ts:115

getOfficesWithOfficeRaw

getOfficesWithOfficeRaw(requestParameters, initOverrides?): Promise<ApiResponse<OfficeFormatV1>>
Get offices with office
Parameters
- requestParameters: GetOfficesWithOfficeRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<OfficeFormatV1>>
- Defined in cwmsjs/src/apis/OfficesApi.ts:85

`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