Class default

Hierarchy

default
- default

Index

Constructors

Properties

Methods

createAndSendRequest deleteHolidayScheme deleteHolidaySchemeHoliday get getForUser getHolidayScheme getHolidaySchemeFloatingHolidays getHolidaySchemeHoliday getHolidaySchemeHolidays getHolidaySchemeMembers post postHolidaySchemeHoliday postHolidaySchemeMembers putHolidayScheme putHolidaySchemeDefault putHolidaySchemeHoliday

Constructors

constructor

new default(__namedParameters: {
requestBuilder: default;
requestHandler: default;
}): default
Parameters
- __namedParameters: {
  requestBuilder: default;
  requestHandler: default;
  }
  - requestBuilder: default
  - requestHandler: default
Returns default
Inherited from default.constructor
- Defined in collections/abstractCollection.ts:13

Properties

`Protected` requestBuilder

requestBuilder: default

`Protected` requestHandler

requestHandler: default

Methods

`Protected` createAndSendRequest

createAndSendRequest(pathname: string, __namedParameters?: {
    body?: unknown;
    method?: Method;
    query?: {
        [key: string]: number | string | string[];
    };
}): Promise<any>
Parameters
- pathname: string
- __namedParameters: {
      body?: unknown;
      method?: Method;
      query?: {
          [key: string]: number | string | string[];
      };
  } = {}
  - Optional body?: unknown
  - Optional method?: Method
  - Optional query?: {
    [key: string]: number | string | string[];
    }
    - [key: string]: number | string | string[]
Returns Promise<any>
Inherited from default.createAndSendRequest
- Defined in collections/abstractCollection.ts:24

deleteHolidayScheme

deleteHolidayScheme(id: string): Promise<void>
Delete a holiday scheme
Parameters
- id: string
Returns Promise<void>
- Defined in collections/holidaySchemes.ts:52

deleteHolidaySchemeHoliday

deleteHolidaySchemeHoliday(id: string, holidayId: string): Promise<void>
Delete a holiday
Parameters
- id: string
- holidayId: string
Returns Promise<void>
- Defined in collections/holidaySchemes.ts:116

get

get(): Promise<ResultSetResponse<HolidaySchemeResponse>>
Retrieve all holiday schemes

Returns Promise<ResultSetResponse<HolidaySchemeResponse>>
- Defined in collections/holidaySchemes.ts:15

getForUser

getForUser(accountId: string): Promise<ResultSetResponse<HolidaySchemeResponse>>
Get user scheme
Parameters
- accountId: string
Returns Promise<ResultSetResponse<HolidaySchemeResponse>>
- Defined in collections/holidaySchemes.ts:153

getHolidayScheme

getHolidayScheme(id: string): Promise<HolidaySchemeResponse>
Retrieve an existing holiday scheme
Parameters
- id: string
Returns Promise<HolidaySchemeResponse>
- Defined in collections/holidaySchemes.ts:32

getHolidaySchemeFloatingHolidays

getHolidaySchemeFloatingHolidays(id: string): Promise<ResultSetResponse<HolidayResponse>>
Retrieve all floating holidays for an existing holiday scheme.
Parameters
- id: string
Returns Promise<ResultSetResponse<HolidayResponse>>
- Defined in collections/holidaySchemes.ts:125

getHolidaySchemeHoliday

getHolidaySchemeHoliday(id: string, holidayId: string): Promise<HolidayResponse>
Retrieve an existing holiday
Parameters
- id: string
- holidayId: string
Returns Promise<HolidayResponse>
- Defined in collections/holidaySchemes.ts:92

getHolidaySchemeHolidays

getHolidaySchemeHolidays(id: string, options: Year): Promise<ResultSetResponse<HolidayResponse>>
Retrieve holidays for an existing holiday scheme
Parameters
- id: string
- options: Year
Returns Promise<ResultSetResponse<HolidayResponse>>
- Defined in collections/holidaySchemes.ts:70

getHolidaySchemeMembers

getHolidaySchemeMembers(id: string): Promise<ResultSetResponse<UserResponse>>
Get members in a holiday scheme

Note: Tempo.io documentation seems to be broken.
Parameters
- id: string
Returns Promise<ResultSetResponse<UserResponse>>
- Defined in collections/holidaySchemes.ts:136

post

post(holidayScheme: HolidayScheme): Promise<HolidaySchemeResponse>
Create a Holiday scheme
Parameters
- holidayScheme: HolidayScheme
Returns Promise<HolidaySchemeResponse>
- Defined in collections/holidaySchemes.ts:22

postHolidaySchemeHoliday

postHolidaySchemeHoliday(id: string, holiday: Holiday): Promise<HolidayResponse>
Create a Holiday
Parameters
- id: string
- holiday: Holiday
Returns Promise<HolidayResponse>
- Defined in collections/holidaySchemes.ts:82

postHolidaySchemeMembers

postHolidaySchemeMembers(id: string, accountIds: string[]): Promise<void>
Assign a holiday scheme to members
Parameters
- id: string
- accountIds: string[]
Returns Promise<void>
- Defined in collections/holidaySchemes.ts:143

putHolidayScheme

putHolidayScheme(id: string, holidayScheme: HolidayScheme): Promise<HolidaySchemeResponse>
Update a holiday scheme
Parameters
- id: string
- holidayScheme: HolidayScheme
Returns Promise<HolidaySchemeResponse>
- Defined in collections/holidaySchemes.ts:39

putHolidaySchemeDefault

putHolidaySchemeDefault(id: string): Promise<HolidaySchemeResponse>
Set the default holiday scheme
Parameters
- id: string
Returns Promise<HolidaySchemeResponse>
- Defined in collections/holidaySchemes.ts:61

putHolidaySchemeHoliday

putHolidaySchemeHoliday(id: string, holidayId: string, holiday: Holiday): Promise<HolidayResponse>
Update a holiday
Parameters
- id: string
- holidayId: string
- holiday: Holiday
Returns Promise<HolidayResponse>
- Defined in collections/holidaySchemes.ts:102

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: { requestBuilder: default; requestHandler: default; }

requestBuilder: default

requestHandler: default

Returns default

Properties

Protected requestBuilder

Protected requestHandler

Methods

Protected createAndSendRequest

Parameters

pathname: string

__namedParameters: { body?: unknown; method?: Method; query?: { [key: string]: number | string | string[]; }; } = {}

Optional body?: unknown

Optional method?: Method

Optional query?: { [key: string]: number | string | string[]; }

[key: string]: number | string | string[]

Returns Promise<any>

deleteHolidayScheme

Parameters

id: string

Returns Promise<void>

deleteHolidaySchemeHoliday

Parameters

id: string

holidayId: string

Returns Promise<void>

get

Returns Promise<ResultSetResponse<HolidaySchemeResponse>>

getForUser

Parameters

accountId: string

Returns Promise<ResultSetResponse<HolidaySchemeResponse>>

getHolidayScheme

Parameters

id: string

Returns Promise<HolidaySchemeResponse>

getHolidaySchemeFloatingHolidays

Parameters

id: string

Returns Promise<ResultSetResponse<HolidayResponse>>

getHolidaySchemeHoliday

Parameters

id: string

holidayId: string

Returns Promise<HolidayResponse>

getHolidaySchemeHolidays

Parameters

id: string

options: Year

Returns Promise<ResultSetResponse<HolidayResponse>>

getHolidaySchemeMembers

Parameters

id: string

Returns Promise<ResultSetResponse<UserResponse>>

post

Parameters

holidayScheme: HolidayScheme

Returns Promise<HolidaySchemeResponse>

postHolidaySchemeHoliday

Parameters

id: string

holiday: Holiday

Returns Promise<HolidayResponse>

postHolidaySchemeMembers

Parameters

id: string

accountIds: string[]

Returns Promise<void>

putHolidayScheme

Parameters

id: string

__namedParameters: {
requestBuilder: default;
requestHandler: default;
}

`Protected` requestBuilder

`Protected` requestHandler

`Protected` createAndSendRequest

__namedParameters: {
body?: unknown;
method?: Method;
query?: {
[key: string]: number | string | string[];
};
} = {}

`Optional` body?: unknown

`Optional` method?: Method

`Optional` query?: {
[key: string]: number | string | string[];
}