Class AllowanceTypeAPI

Hierarchy

APIBase
- AllowanceTypeAPI

Index

Constructors

Properties

apiClient options

Methods

checkApiKey retrieveAllowanceType retrieveAllowanceTypes setApiAuthorization setApiUrl

Constructors

constructor

new AllowanceTypeAPI(
apiClient: APIClient,
options: ClientOptions,
): AllowanceTypeAPI
Parameters
- apiClient: APIClient
- options: ClientOptions
Returns AllowanceTypeAPI
Overrides APIBase.constructor
- Defined in api/AllowanceTypeAPI.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

retrieveAllowanceType

retrieveAllowanceType(id: string): Promise<Allowance>
Retrieve a single allowance type
Parameters
- id: string
Returns Promise<Allowance>
- Defined in api/AllowanceTypeAPI.ts:16

retrieveAllowanceTypes

retrieveAllowanceTypes(
options?: PaginationOptions,
): Promise<Paginated<Allowance[]>>
Retrieve allowance types
Parameters
- Optionaloptions: PaginationOptions
Returns Promise<Paginated<Allowance[]>>
- Defined in api/AllowanceTypeAPI.ts:26

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