Class DepartmentAPI

Hierarchy

APIBase
- DepartmentAPI

Index

Constructors

Properties

apiClient options

Methods

checkApiKey deleteDepartment retrieveDepartment retrieveDepartments setApiAuthorization setApiUrl

Constructors

constructor

new DepartmentAPI(apiClient: APIClient, options: ClientOptions): DepartmentAPI
Parameters
- apiClient: APIClient
- options: ClientOptions
Returns DepartmentAPI
Overrides APIBase.constructor
- Defined in api/DepartmentAPI.ts:9

Properties

`Protected` `Readonly`apiClient

apiClient: APIClient

`Protected` `Readonly`options

options: ClientOptions

Methods

`Protected`checkApiKey

checkApiKey(apiName?: string): void
Parameters
- OptionalapiName: string
Returns void
Inherited from APIBase.checkApiKey
- Defined in api/APIBase.ts:41

deleteDepartment

deleteDepartment(id: string): Promise<void>
Deletes a department
Parameters
- id: string
  The department id
Returns Promise<void>
- Defined in api/DepartmentAPI.ts:17

retrieveDepartment

retrieveDepartment(id: string): Promise<Department>
Retrieve a single department
Parameters
- id: string
Returns Promise<Department>
- Defined in api/DepartmentAPI.ts:26

retrieveDepartments

retrieveDepartments(
options?: PaginationOptions,
): Promise<Paginated<Department[]>>
Retrieve departments
Parameters
- Optionaloptions: PaginationOptions
Returns Promise<Paginated<Department[]>>
- Defined in api/DepartmentAPI.ts:36

setApiAuthorization

setApiAuthorization(authorization: Authorization): void
Set a new API key.
Parameters
- authorization: Authorization
  The API authorization data
Returns void
Inherited from APIBase.setApiAuthorization
- Defined in api/APIBase.ts:20

setApiUrl

setApiUrl(newURL: string): void
Set a new API URL.
Parameters
- newURL: string
  The new API url
Returns void
Inherited from APIBase.setApiUrl
- Defined in api/APIBase.ts:37