rotacloud 1.0.30 → 1.0.32

package/dist/mjs/services/service.js

@@ -1,8 +1,29 @@
 import axios from 'axios';
+import axiosRetry from 'axios-retry';
 import { RotaCloud } from '../rotacloud.js';
 import { Version } from '../version.js';
+export var RetryStrategy;
+(function (RetryStrategy) {
+    RetryStrategy["Exponential"] = "expo";
+    RetryStrategy["Static"] = "static";
+})(RetryStrategy || (RetryStrategy = {}));
+const DEFAULT_RETRIES = 3;
+const DEFAULT_RETRY_DELAY = 2000;
+const DEFAULT_RETRY_STRATEGY_OPTIONS = {
+    [RetryStrategy.Exponential]: {
+        exponential: true,
+        maxRetries: DEFAULT_RETRIES,
+    },
+    [RetryStrategy.Static]: {
+        exponential: false,
+        maxRetries: DEFAULT_RETRIES,
+        delay: DEFAULT_RETRY_DELAY,
+    },
+};
 export class Service {
-    // rate limit tracking could be implemented here statically
+    constructor() {
+        this.client = axios.create();
+    }
     isLeaveRequest(endpoint) {
         return endpoint === '/leave_requests';
     }
@@ -55,7 +76,21 @@ export class Service {
                 return params ? this.buildQueryStr(params) : '';
             },
         };
-        const response = await axios.request(reqObject);
+        if (RotaCloud.config.retry) {
+            const retryConfig = typeof RotaCloud.config.retry === 'string'
+                ? DEFAULT_RETRY_STRATEGY_OPTIONS[RotaCloud.config.retry]
+                : RotaCloud.config.retry;
+            axiosRetry(this.client, {
+                retries: retryConfig.maxRetries,
+                retryDelay: (retryCount) => {
+                    if (retryConfig.exponential) {
+                        return axiosRetry.exponentialDelay(retryCount);
+                    }
+                    return retryConfig.delay;
+                },
+            });
+        }
+        const response = await this.client.request(reqObject);
         return response;
     }
     async *listFetch(reqObject, options) {

package/dist/mjs/services/settings.service.d.ts

@@ -0,0 +1,14 @@
+import { AxiosResponse } from 'axios';
+import { Settings } from '../models/settings.model.js';
+import { Service, Options } from './index.js';
+import { ApiSettings } from '../interfaces/index.js';
+import { SettingsQueryParams } from '../rotacloud.js';
+declare class SettingsService extends Service {
+    private apiPath;
+    get(query: SettingsQueryParams): Promise<Settings>;
+    get(query: SettingsQueryParams, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<ApiSettings, any>>;
+    get(query: SettingsQueryParams, options: Options): Promise<Settings>;
+}
+export { SettingsService };

package/dist/mjs/services/settings.service.js

@@ -0,0 +1,13 @@
+import { Settings } from '../models/settings.model.js';
+import { Service } from './index.js';
+import { ErrorResponse } from '../models/error-response.model.js';
+class SettingsService extends Service {
+    constructor() {
+        super(...arguments);
+        this.apiPath = '/settings';
+    }
+    get(query, options) {
+        return super.fetch({ url: `${this.apiPath}`, params: query }, options).then((res) => Promise.resolve(options?.rawResponse ? res : new Settings(res.data)), (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err)));
+    }
+}
+export { SettingsService };

package/dist/mjs/services/shifts.service.js

@@ -18,16 +18,11 @@ export class ShiftsService extends Service {
         }
     }
     async listAll(query, options) {
-        try {
-            const shifts = [];
-            for await (const shift of this.list(query, options)) {
-                shifts.push(shift);
-            }
-            return shifts;
-        }
-        catch (err) {
-            return err;
+        const shifts = [];
+        for await (const shift of this.list(query, options)) {
+            shifts.push(shift);
         }
+        return shifts;
     }
     listByPage(query, options) {
         return super.iterator({ url: this.apiPath, params: query }, options).byPage();

package/dist/mjs/services/users.service.js

@@ -18,16 +18,11 @@ class UsersService extends Service {
         }
     }
     async listAll(query, options) {
-        try {
-            const users = [];
-            for await (const user of this.list(query, options)) {
-                users.push(user);
-            }
-            return users;
-        }
-        catch (err) {
-            return err;
+        const users = [];
+        for await (const user of this.list(query, options)) {
+            users.push(user);
         }
+        return users;
     }
     listByPage(query, options) {
         return super.iterator({ url: this.apiPath, params: query }, options).byPage();

package/dist/mjs/version.js

@@ -1 +1 @@
-export const Version = { version: '1.0.30' };
+export const Version = { version: '1.0.32' };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rotacloud",
-  "version": "1.0.30",
+  "version": "1.0.32",
   "description": "The RotaCloud SDK for the RotaCloud API",
   "engines": {
     "node": ">=14.17.0"
@@ -47,6 +47,7 @@
   "dependencies": {
     "@types/node": "^16.11.6",
     "axios": "^0.23.0",
+    "axios-retry": "^3.3.1",
     "cross-var": "^1.1.0"
   }
 }

package/src/interfaces/{day-notes.interface.ts → day-note.interface.ts}

@@ -1,4 +1,4 @@
-export interface ApiDayNotes {
+export interface ApiDayNote {
   id: number;
   start_date: string;
   end_date: string;

package/src/interfaces/index.ts

@@ -9,7 +9,7 @@ export * from './daily-budgets.interface.js';
 export * from './daily-revenue.interface.js';
 export * from './days-off.interface.js';
 export * from './days-off-pattern.interface.js';
-export * from './day-notes.interface.js';
+export * from './day-note.interface.js';
 export * from './group.interface.js';
 export * from './holiday_allowance.interface.js';
 export * from './leave-date.interface.js';
@@ -26,5 +26,6 @@ export * from './pay-period.interface.js';
 export * from './role-rate.interface.js';
 export * from './role.interface.js';
 export * from './sdk-config.interface.js';
-export * from './user.interface.js';
+export * from './settings.interface.js';
 export * from './shift.interface.js';
+export * from './user.interface.js';

package/src/interfaces/query-params/day-notes-query-params.interface.ts

@@ -1,5 +1,5 @@
 export interface DayNotesQueryParams {
-  start?: string;
-  end?: string;
+  start: string;
+  end: string;
   locations?: number[];
 }

package/src/interfaces/query-params/index.ts

@@ -17,6 +17,7 @@ export * from './locations-query-params.interface.js';
 export * from './logbook-events-query-params.interface.js';
 export * from './pay-periods-query-params.interface.js';
 export * from './roles-query-params.interface.js';
+export * from './settings-query-params.interface.js';
 export * from './shifts-query-params.interface.js';
 export * from './swap-requests-query-params.interface.js';
 export * from './terminals-query-params.interface.js';

package/src/interfaces/query-params/settings-query-params.interface.ts

@@ -0,0 +1,3 @@
+export interface SettingsQueryParams {
+  only_values?: boolean;
+}

package/src/interfaces/query-params/shifts-query-params.interface.ts

@@ -1,6 +1,6 @@
 export interface ShiftsQueryParams {
-  start?: number;
-  end?: number;
+  start: number;
+  end: number;
   ids?: number[];
   users?: number[];
   locations?: number[];

package/src/interfaces/sdk-config.interface.ts

@@ -1,6 +1,9 @@
+import { RetryOptions, RetryStrategy } from '../services/service.js';
+
 export interface SDKConfig {
   baseUri?: string;
   apiKey: string;
   accountId?: number;
   userId?: number;
+  retry?: false | `${RetryStrategy}` | RetryOptions;
 }

package/src/interfaces/settings.interface.ts

@@ -0,0 +1,63 @@
+export interface PayCodes {
+  [pay_code_id: string]: string | { [leave_type_id: string]: string };
+}
+
+export interface ApiSettings {
+  attendance_record_breaks: string;
+  automatically_clock_in_to_consecutive_shifts: boolean;
+  availability_employees_can_edit: boolean;
+  availability_managers_can_edit: boolean;
+  breaks_paid: boolean;
+  clock_in_out_reminders_minutes: number;
+  clock_in_without_shift_allowed: string;
+  currency_symbol: string;
+  dashboard_show_unpublished_shifts: boolean;
+  early_clock_ins_paid_from: string;
+  early_clock_in_minutes: number;
+  employee_shift_note_visibility: string;
+  employees_can_edit_timesheets: boolean;
+  employees_can_only_see_self: boolean;
+  employees_can_see_all_locations: boolean;
+  employees_can_see_everyones_leave: boolean;
+  flag_in_out_discrepancies_minutes: number;
+  holiday_accrual_rate: number;
+  late_clock_outs_paid_until: string;
+  lateness_added_after_minutes: number;
+  leave_can_request_over_allowance: boolean;
+  leave_prorate_allowances: boolean;
+  leave_requests_enabled: boolean;
+  leave_requests_notice_days: number;
+  leave_year_start_day: number;
+  leave_year_start_month: number;
+  metadata_enabled: boolean;
+  mobile_clocking_enabled: boolean;
+  no_show_notifications_minutes: number;
+  open_shift_claiming_enabled: boolean;
+  public_holiday_affects_allowance: boolean;
+  reminders_enabled: boolean;
+  rota_grouping: string;
+  rota_salaried_cost_method: string;
+  rota_show_employee_photos: boolean;
+  round_breaks: string;
+  round_breaks_direction: string;
+  round_currency: string;
+  round_currency_direction: string;
+  round_hours: string;
+  round_hours_direction: string;
+  shift_acknowledgement_enabled: boolean;
+  shift_swaps_across_locations_enabled: boolean;
+  shift_swaps_enabled: boolean;
+  shift_swaps_notice_hours: number;
+  shift_swaps_require_approval: boolean;
+  shift_swaps_shift_range_days: number;
+  show_open_shifts_from_other_locations: boolean;
+  show_shifts_from_other_locations: boolean;
+  time_format: string;
+  unavailability_notice_hours: number;
+  unavailability_requests_enabled: boolean;
+  unpaid_leave_types_included_in_accrual: number[];
+  paid_leave_types_included_in_accrual: number[];
+  week_starts: string;
+  pay_codes: PayCodes;
+  webhook_signing_secret: string;
+}

package/src/models/day-note.model.ts

@@ -0,0 +1,19 @@
+import { ApiDayNote } from '../interfaces/index.js';
+
+export class DayNote {
+  public id: number;
+  public start_date: string;
+  public end_date: string;
+  public locations: number[];
+  public title: string;
+  public message: string;
+
+  constructor(dayNote: ApiDayNote) {
+    this.id = dayNote.id;
+    this.start_date = dayNote.start_date;
+    this.end_date = dayNote.end_date;
+    this.locations = dayNote.locations;
+    this.title = dayNote.title;
+    this.message = dayNote.message;
+  }
+}

package/src/models/settings.model.ts

@@ -1,6 +1,4 @@
-interface PayCodes {
-  [pay_code_id: string]: string | { [leave_type_id: string]: string };
-}
+import { ApiSettings, PayCodes } from '../interfaces';
 
 export class Settings {
   public attendance_record_breaks: string;
@@ -60,4 +58,8 @@ export class Settings {
   public week_starts: string;
   public pay_codes: PayCodes;
   public webhook_signing_secret: string;
+
+  constructor(settings: ApiSettings) {
+    this.attendance_record_breaks = settings.attendance_record_breaks;
+  }
 }

package/src/rotacloud.ts

@@ -11,22 +11,31 @@ import {
   LeaveRequestService,
   LeaveService,
   LocationsService,
+  RetryStrategy,
   RolesService,
+  SettingsService,
   ShiftsService,
   UsersService,
 } from './services/index.js';
 import { SDKConfig } from './interfaces/index.js';
+import { DayNotesService } from './services/day-notes.service.js';
+
+const DEFAULT_CONFIG: Partial<SDKConfig> = {
+  baseUri: 'https://api.rotacloud.com/v1',
+  retry: RetryStrategy.Exponential,
+};
 
 export class RotaCloud {
   public static config: SDKConfig;
 
-  public defaultAPIURI = 'https://api.rotacloud.com/v1';
+  public defaultAPIURI = DEFAULT_CONFIG.baseUri;
   public accounts = new AccountsService();
   public attendance = new AttendanceService();
   public auth = new AuthService();
   public availability = new AvailabilityService();
   public dailyBudgets = new DailyBudgetsService();
   public dailyRevenue = new DailyRevenueService();
+  public dayNotes = new DayNotesService();
   public daysOff = new DaysOffService();
   public group = new GroupsService();
   public leaveEmbargoes = new LeaveEmbargoesService();
@@ -34,14 +43,15 @@ export class RotaCloud {
   public leave = new LeaveService();
   public locations = new LocationsService();
   public roles = new RolesService();
+  public settings = new SettingsService();
   public shifts = new ShiftsService();
   public users = new UsersService();
 
   constructor(config: SDKConfig) {
-    if (!config.baseUri) {
-      config.baseUri = this.defaultAPIURI;
-    }
-    this.config = config;
+    this.config = {
+      ...DEFAULT_CONFIG,
+      ...config,
+    };
   }
 
   get config() {
@@ -53,5 +63,6 @@ export class RotaCloud {
   }
 }
 
+export { RetryStrategy, RetryOptions } from './services/service.js';
 export * from './interfaces/index.js';
 export * from './interfaces/query-params/index.js';

package/src/services/accounts.service.ts

@@ -26,15 +26,11 @@ class AccountsService extends Service {
 
   listAll(options?: Options): Promise<Account[]>;
   async listAll(options?: Options) {
-    try {
-      const accounts = [] as Account[];
-      for await (const account of this.list(options)) {
-        accounts.push(account);
-      }
-      return accounts;
-    } catch (err) {
-      return err;
+    const accounts = [] as Account[];
+    for await (const account of this.list(options)) {
+      accounts.push(account);
     }
+    return accounts;
   }
 
   listByPage(options?: Options) {

package/src/services/attendance.service.ts

@@ -42,15 +42,11 @@ export class AttendanceService extends Service {
 
   listAll(query: AttendanceQueryParams, options?: Options): Promise<Attendance[]>;
   async listAll(query: AttendanceQueryParams, options?: Options) {
-    try {
-      const attendance = [] as Attendance[];
-      for await (const atten of this.list(query, options)) {
-        attendance.push(atten);
-      }
-      return attendance;
-    } catch (err) {
-      return err;
+    const attendance = [] as Attendance[];
+    for await (const atten of this.list(query, options)) {
+      attendance.push(atten);
     }
+    return attendance;
   }
 
   listByPage(query: AttendanceQueryParams, options?: Options) {

package/src/services/daily-budgets.service.ts

@@ -17,15 +17,11 @@ export class DailyBudgetsService extends Service {
 
   listAll(query: DailyBudgetsQueryParams, options?: Options): Promise<DailyBudgets[]>;
   async listAll(query: DailyBudgetsQueryParams, options?: Options) {
-    try {
-      const attendance = [] as DailyBudgets[];
-      for await (const atten of this.list(query, options)) {
-        attendance.push(atten);
-      }
-      return attendance;
-    } catch (err) {
-      return err;
+    const attendance = [] as DailyBudgets[];
+    for await (const atten of this.list(query, options)) {
+      attendance.push(atten);
     }
+    return attendance;
   }
 
   listByPage(query: DailyBudgetsQueryParams, options?: Options) {

package/src/services/daily-revenue.service.ts

@@ -17,15 +17,11 @@ export class DailyRevenueService extends Service {
 
   listAll(query: DailyRevenueQueryParams, options?: Options): Promise<DailyRevenue[]>;
   async listAll(query: DailyRevenueQueryParams, options?: Options) {
-    try {
-      const attendance = [] as DailyRevenue[];
-      for await (const atten of this.list(query, options)) {
-        attendance.push(atten);
-      }
-      return attendance;
-    } catch (err) {
-      return err;
+    const attendance = [] as DailyRevenue[];
+    for await (const atten of this.list(query, options)) {
+      attendance.push(atten);
     }
+    return attendance;
   }
 
   listByPage(query: DailyRevenueQueryParams, options?: Options) {

package/src/services/day-notes.service.ts

@@ -0,0 +1,81 @@
+import { AxiosResponse } from 'axios';
+import { ApiDayNote } from '../interfaces/index.js';
+import { Service, Options } from './index.js';
+
+import { ErrorResponse } from '../models/error-response.model.js';
+
+import { DayNote } from '../models/day-note.model.js';
+import { DayNotesQueryParams } from '../interfaces/query-params/day-notes-query-params.interface';
+
+export class DayNotesService extends Service {
+  private apiPath = '/day_notes';
+
+  create(data: ApiDayNote): Promise<DayNote>;
+  create(data: ApiDayNote, options: { rawResponse: true } & Options): Promise<AxiosResponse<ApiDayNote, any>>;
+  create(data: ApiDayNote, options: Options): Promise<DayNote>;
+  create(data: ApiDayNote, options?: Options) {
+    return super.fetch<ApiDayNote>({ url: this.apiPath, data, method: 'POST' }).then(
+      (res) => Promise.resolve(options?.rawResponse ? res : new DayNote(res.data)),
+      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
+    );
+  }
+
+  get(id: number): Promise<DayNote>;
+  get(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<ApiDayNote, any>>;
+  get(id: number, options: Options): Promise<DayNote>;
+  get(id: number, options?: Options) {
+    return super.fetch<ApiDayNote>({ url: `${this.apiPath}/${id}` }, options).then(
+      (res) => Promise.resolve(options?.rawResponse ? res : new DayNote(res.data)),
+      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
+    );
+  }
+
+  async *list(query: DayNotesQueryParams, options?: Options) {
+    for await (const res of super.iterator<ApiDayNote>({ url: this.apiPath, params: query }, options)) {
+      yield new DayNote(res);
+    }
+  }
+
+  listAll(query: DayNotesQueryParams, options?: Options): Promise<DayNote[]>;
+  async listAll(query: DayNotesQueryParams, options?: Options) {
+    const dayNotes: DayNote[] = [];
+    for await (const dayNote of this.list(query, options)) {
+      dayNotes.push(dayNote);
+    }
+    return dayNotes;
+  }
+
+  listByPage(query: DayNotesQueryParams, options?: Options) {
+    return super.iterator<ApiDayNote>({ url: this.apiPath, params: query }, options).byPage();
+  }
+
+  update(id: number, data: Partial<ApiDayNote>): Promise<DayNote>;
+  update(
+    id: number,
+    data: Partial<ApiDayNote>,
+    options: { rawResponse: true } & Options
+  ): Promise<AxiosResponse<ApiDayNote, any>>;
+  update(id: number, data: Partial<ApiDayNote>, options: Options): Promise<DayNote>;
+  update(id: number, data: Partial<ApiDayNote>, options?: Options) {
+    return super
+      .fetch<ApiDayNote>({
+        url: `${this.apiPath}/${id}`,
+        data,
+        method: 'POST',
+      })
+      .then(
+        (res) => Promise.resolve(options?.rawResponse ? res : new DayNote(res.data)),
+        (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
+      );
+  }
+
+  delete(id: number): Promise<number>;
+  delete(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<any, any>>;
+  delete(id: number, options: Options): Promise<number>;
+  delete(id: number, options?: Options) {
+    return super.fetch<ApiDayNote>({ url: `${this.apiPath}/${id}`, method: 'DELETE' }).then(
+      (res) => Promise.resolve(options?.rawResponse ? res : res.status),
+      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
+    );
+  }
+}

package/src/services/days-off.service.ts

@@ -41,15 +41,11 @@ export class DaysOffService extends Service<ApiDaysOff> {
 
   listAll(query: DaysOffQueryParams, options?: Options): Promise<DaysOff[]>;
   async listAll(query: DaysOffQueryParams, options?: Options) {
-    try {
-      const daysOff = [] as DaysOff[];
-      for await (const dayOff of this.list(query, options)) {
-        daysOff.push(dayOff);
-      }
-      return daysOff;
-    } catch (err) {
-      return err;
+    const daysOff = [] as DaysOff[];
+    for await (const dayOff of this.list(query, options)) {
+      daysOff.push(dayOff);
     }
+    return daysOff;
   }
 
   listByPage(query: DaysOffQueryParams, options?: Options) {

package/src/services/groups.service.ts

@@ -35,26 +35,22 @@ export class GroupsService extends Service {
     );
   }
 
-  async *list(query: GroupsQueryParams, options?: Options) {
+  async *list(query?: GroupsQueryParams, options?: Options) {
     for await (const res of super.iterator<ApiGroup>({ url: this.apiPath, params: query }, options)) {
       yield new Group(res);
     }
   }
 
-  listAll(query: GroupsQueryParams, options?: Options): Promise<Group[]>;
+  listAll(query?: GroupsQueryParams, options?: Options): Promise<Group[]>;
   async listAll(query: GroupsQueryParams, options?: Options) {
-    try {
-      const groups = [] as Group[];
-      for await (const group of this.list(query, options)) {
-        groups.push(group);
-      }
-      return groups;
-    } catch (err) {
-      return err;
+    const groups = [] as Group[];
+    for await (const group of this.list(query, options)) {
+      groups.push(group);
     }
+    return groups;
   }
 
-  listByPage(query: GroupsQueryParams, options?: Options) {
+  listByPage(query?: GroupsQueryParams, options?: Options) {
     return super.iterator<ApiGroup>({ url: this.apiPath, params: query }, options).byPage();
   }
 

package/src/services/index.ts

@@ -12,5 +12,6 @@ export * from './leave-embargoes.service.js';
 export * from './leave.service.js';
 export * from './locations.service.js';
 export * from './roles.service.js';
+export * from './settings.service.js';
 export * from './shifts.service.js';
 export * from './users.service.js';

package/src/services/leave-embargoes.service.ts

@@ -42,15 +42,11 @@ export class LeaveEmbargoesService extends Service {
 
   listAll(query: LeaveEmbargoesQueryParams, options?: Options): Promise<LeaveEmbargo[]>;
   async listAll(query: LeaveEmbargoesQueryParams, options?: Options) {
-    try {
-      const leave = [] as LeaveEmbargo[];
-      for await (const leaveEmbargoRecord of this.list(query, options)) {
-        leave.push(leaveEmbargoRecord);
-      }
-      return leave;
-    } catch (err) {
-      return err;
+    const leave = [] as LeaveEmbargo[];
+    for await (const leaveEmbargoRecord of this.list(query, options)) {
+      leave.push(leaveEmbargoRecord);
     }
+    return leave;
   }
 
   listByPage(query: LeaveEmbargoesQueryParams, options?: Options) {