Class AbsenceAPI

Hierarchy

APIBase
- AbsenceAPI

Index

Constructors

Properties

apiClient options

Methods

checkApiKey createAbsence deleteAbsence retrieveAbsence retrieveAbsences setApiAuthorization setApiUrl updateAbsence

Constructors

constructor

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

createAbsence

createAbsence(absenceData: NewAbsence): Promise<Absence>
Create absences
Parameters
- absenceData: NewAbsence
Returns Promise<Absence>
- Defined in api/AbsenceAPI.ts:16

deleteAbsence

deleteAbsence(id: string): Promise<void>
Deletes one absence
Parameters
- id: string
  The absence id
Returns Promise<void>
- Defined in api/AbsenceAPI.ts:27

retrieveAbsence

retrieveAbsence(id: string): Promise<Absence>
Retrieve an absence
Parameters
- id: string
Returns Promise<Absence>
- Defined in api/AbsenceAPI.ts:36

retrieveAbsences

retrieveAbsences(options?: PaginationOptions): Promise<Paginated<Absence[]>>
Retrieve absences
Parameters
- Optionaloptions: PaginationOptions
Returns Promise<Paginated<Absence[]>>
- Defined in api/AbsenceAPI.ts:46

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

updateAbsence

updateAbsence(id: string, absenceData: Partial<Absence>): Promise<Absence>
Update an existing absence
Parameters
- id: string
- absenceData: Partial<Absence>
Returns Promise<Absence>
- Defined in api/AbsenceAPI.ts:56