Object for working with calendars of exceptions

Hierarchy

SpecialCalendars

Methods

create

create(): SpecialCalendar

- Defined in src/dts/12_work_calendar.ts:499
Create a new calendar of exception days.

Returns SpecialCalendar

getById

getById(id: string): Promise<SpecialCalendar | undefined>

- Defined in src/dts/12_work_calendar.ts:516
Get calendar of exception days by its ID.

If the calendar cannot be found (for example, it has been deleted), the method returns undefined.

Parameters
- id: string
  
  ID of the celandar of exeption days.
Returns Promise<SpecialCalendar | undefined>

list

list(size?: undefined | number, from?: undefined | number): Promise<SpecialCalendar[]>

- Defined in src/dts/12_work_calendar.ts:508
Get a list of calendars of exception days of the company.

When working with a large number of calendarrs, you can get them in portions and set the start of the selection dynamically.

Parameters
- Optional size: undefined | number
  
  Number of calendars to get. The default value is 10.
- Optional from: undefined | number
  
  Number of entries to skip. The default value is 0.
Returns Promise<SpecialCalendar[]>