rotacloud 1.0.28 → 1.0.31

package/dist/mjs/models/attendance.model.d.ts

@@ -1,7 +1,27 @@
-import { ApiAttendance } from '../interfaces/index.js';
+import { ApiAttendance, ApiAttendanceLocation, ApiShift } from '../interfaces/index.js';
 export declare class Attendance {
     id: number;
+    deleted: boolean;
     approved: boolean;
+    in_time: number;
+    out_time: number;
+    minutes_break: number;
+    user: number;
     location: number;
+    role: number;
+    minutes_late: number;
+    hours: number;
+    hours_auto: number;
+    hours_is_auto: boolean;
+    notes: string | null;
+    shift: ApiShift | null;
+    in_method: string;
+    out_method: string;
+    in_location: ApiAttendanceLocation;
+    out_location: ApiAttendanceLocation;
+    in_device: number;
+    out_device: number;
+    in_terminal: null;
+    out_terminal: null;
     constructor(attendance: ApiAttendance);
 }

package/dist/mjs/models/attendance.model.js

@@ -1,7 +1,27 @@
 export class Attendance {
     constructor(attendance) {
         this.id = attendance.id;
+        this.deleted = attendance.deleted;
         this.approved = attendance.approved;
+        this.in_time = attendance.in_time;
+        this.out_time = attendance.out_time;
+        this.minutes_break = attendance.minutes_break;
+        this.user = attendance.user;
         this.location = attendance.location;
+        this.role = attendance.role;
+        this.minutes_late = attendance.minutes_late;
+        this.hours = attendance.hours;
+        this.hours_auto = attendance.hours_auto;
+        this.hours_is_auto = attendance.hours_is_auto;
+        this.notes = attendance.notes;
+        this.shift = attendance.shift;
+        this.in_method = attendance.in_method;
+        this.out_method = attendance.out_method;
+        this.in_location = attendance.in_location;
+        this.out_location = attendance.out_location;
+        this.in_device = attendance.in_device;
+        this.out_device = attendance.out_device;
+        this.in_terminal = attendance.in_terminal;
+        this.out_terminal = attendance.out_terminal;
     }
 }

package/dist/mjs/models/settings.model.d.ts

@@ -1,8 +1,4 @@
-interface PayCodes {
-    [pay_code_id: string]: string | {
-        [leave_type_id: string]: string;
-    };
-}
+import { ApiSettings, PayCodes } from '../interfaces';
 export declare class Settings {
     attendance_record_breaks: string;
     automatically_clock_in_to_consecutive_shifts: boolean;
@@ -61,5 +57,5 @@ export declare class Settings {
     week_starts: string;
     pay_codes: PayCodes;
     webhook_signing_secret: string;
+    constructor(settings: ApiSettings);
 }
-export {};

package/dist/mjs/models/settings.model.js

@@ -1,2 +1,5 @@
 export class Settings {
+    constructor(settings) {
+        this.attendance_record_breaks = settings.attendance_record_breaks;
+    }
 }

package/dist/mjs/rotacloud.d.ts

@@ -1,8 +1,8 @@
-import { AccountsService, AttendanceService, AuthService, AvailabilityService, DailyBudgetsService, DailyRevenueService, DaysOffService, GroupsService, LeaveEmbargoesService, LeaveRequestService, LeaveService, LocationsService, RolesService, ShiftsService, UsersService } from './services/index.js';
+import { AccountsService, AttendanceService, AuthService, AvailabilityService, DailyBudgetsService, DailyRevenueService, DaysOffService, GroupsService, LeaveEmbargoesService, LeaveRequestService, LeaveService, LocationsService, RolesService, SettingsService, ShiftsService, UsersService } from './services/index.js';
 import { SDKConfig } from './interfaces/index.js';
 export declare class RotaCloud {
     static config: SDKConfig;
-    defaultAPIURI: string;
+    defaultAPIURI: string | undefined;
     accounts: AccountsService;
     attendance: AttendanceService;
     auth: AuthService;
@@ -16,11 +16,13 @@ export declare class RotaCloud {
     leave: LeaveService;
     locations: LocationsService;
     roles: RolesService;
+    settings: SettingsService;
     shifts: ShiftsService;
     users: UsersService;
     constructor(config: SDKConfig);
     get config(): SDKConfig;
     set config(configVal: SDKConfig);
 }
+export { RetryStrategy, RetryOptions } from './services/service.js';
 export * from './interfaces/index.js';
 export * from './interfaces/query-params/index.js';

package/dist/mjs/rotacloud.js

@@ -1,7 +1,11 @@
-import { AccountsService, AttendanceService, AuthService, AvailabilityService, DailyBudgetsService, DailyRevenueService, DaysOffService, GroupsService, LeaveEmbargoesService, LeaveRequestService, LeaveService, LocationsService, RolesService, ShiftsService, UsersService, } from './services/index.js';
+import { AccountsService, AttendanceService, AuthService, AvailabilityService, DailyBudgetsService, DailyRevenueService, DaysOffService, GroupsService, LeaveEmbargoesService, LeaveRequestService, LeaveService, LocationsService, RetryStrategy, RolesService, SettingsService, ShiftsService, UsersService, } from './services/index.js';
+const DEFAULT_CONFIG = {
+    baseUri: 'https://api.rotacloud.com/v1',
+    retry: RetryStrategy.Exponential,
+};
 export class RotaCloud {
     constructor(config) {
-        this.defaultAPIURI = 'https://api.rotacloud.com/v1';
+        this.defaultAPIURI = DEFAULT_CONFIG.baseUri;
         this.accounts = new AccountsService();
         this.attendance = new AttendanceService();
         this.auth = new AuthService();
@@ -15,12 +19,13 @@ export class RotaCloud {
         this.leave = new LeaveService();
         this.locations = new LocationsService();
         this.roles = new RolesService();
+        this.settings = new SettingsService();
         this.shifts = new ShiftsService();
         this.users = new UsersService();
-        if (!config.baseUri) {
-            config.baseUri = this.defaultAPIURI;
-        }
-        this.config = config;
+        this.config = {
+            ...DEFAULT_CONFIG,
+            ...config,
+        };
     }
     get config() {
         return RotaCloud.config;
@@ -29,5 +34,6 @@ export class RotaCloud {
         RotaCloud.config = configVal;
     }
 }
+export { RetryStrategy } from './services/service.js';
 export * from './interfaces/index.js';
 export * from './interfaces/query-params/index.js';

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

@@ -1,10 +1,16 @@
+import { AxiosResponse } from 'axios';
 import { Account } from '../models/account.model.js';
 import { Service, Options } from './index.js';
 import { ApiAccount } from '../interfaces/index.js';
 declare class AccountsService extends Service {
     private apiPath;
+    get(id: number): Promise<Account>;
+    get(id: number, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<ApiAccount, any>>;
+    get(id: number, options: Options): Promise<Account>;
     list(options?: Options): AsyncGenerator<Account, void, unknown>;
     listAll(options?: Options): Promise<Account[]>;
-    listByPage(options?: Options): AsyncGenerator<import("axios").AxiosResponse<ApiAccount[], any>, any, unknown>;
+    listByPage(options?: Options): AsyncGenerator<AxiosResponse<ApiAccount[], any>, any, unknown>;
 }
 export { AccountsService };

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

@@ -1,10 +1,14 @@
 import { Account } from '../models/account.model.js';
 import { Service } from './index.js';
+import { ErrorResponse } from '../models/error-response.model.js';
 class AccountsService extends Service {
     constructor() {
         super(...arguments);
         this.apiPath = '/accounts';
     }
+    get(id, options) {
+        return super.fetch({ url: `${this.apiPath}/${id}` }, options).then((res) => Promise.resolve(options?.rawResponse ? res : new Account(res.data)), (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err)));
+    }
     async *list(options) {
         for await (const res of super.iterator({ url: this.apiPath }, options)) {
             yield new Account(res);

package/dist/mjs/services/index.d.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/dist/mjs/services/index.js

@@ -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/dist/mjs/services/service.d.ts

@@ -1,5 +1,22 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 export declare type RequirementsOf<T, K extends keyof T> = Required<Pick<T, K>> & Partial<T>;
+export declare enum RetryStrategy {
+    Exponential = "expo",
+    Static = "static"
+}
+export declare type RetryOptions = {
+    /** Use exponential back-off */
+    exponential?: false;
+    /** The maximum number of retries before erroring */
+    maxRetries: number;
+    /** Delay in milliseconds between retry attempts - not used in exponential back-off */
+    delay: number;
+} | {
+    /** Use exponential back-off */
+    exponential: true;
+    /** The maximum number of retries before erroring */
+    maxRetries: number;
+};
 export interface Options {
     rawResponse?: boolean;
     expand?: string[];
@@ -7,6 +24,7 @@ export interface Options {
     limit?: number;
 }
 export declare abstract class Service<ApiResponse = any> {
+    protected client: AxiosInstance;
     isLeaveRequest(endpoint?: string): boolean;
     private buildQueryStr;
     private getPagingObject;

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/version.js

@@ -1 +1 @@
-export const Version = { version: '1.0.28' };
+export const Version = { version: '1.0.31' };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rotacloud",
-  "version": "1.0.28",
+  "version": "1.0.31",
   "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/index.ts

@@ -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/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/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/attendance.model.ts

@@ -1,13 +1,53 @@
-import { ApiAttendance } from '../interfaces/index.js';
+import { ApiAttendance, ApiAttendanceLocation, ApiShift } from '../interfaces/index.js';
 
 export class Attendance {
   public id: number;
+  public deleted: boolean;
   public approved: boolean;
+  public in_time: number;
+  public out_time: number;
+  public minutes_break: number;
+  public user: number;
   public location: number;
+  public role: number;
+  public minutes_late: number;
+  public hours: number;
+  public hours_auto: number;
+  public hours_is_auto: boolean;
+  public notes: string | null;
+  public shift: ApiShift | null;
+  public in_method: string;
+  public out_method: string;
+  public in_location: ApiAttendanceLocation;
+  public out_location: ApiAttendanceLocation;
+  public in_device: number;
+  public out_device: number;
+  public in_terminal: null;
+  public out_terminal: null;
 
   constructor(attendance: ApiAttendance) {
     this.id = attendance.id;
+    this.deleted = attendance.deleted;
     this.approved = attendance.approved;
+    this.in_time = attendance.in_time;
+    this.out_time = attendance.out_time;
+    this.minutes_break = attendance.minutes_break;
+    this.user = attendance.user;
     this.location = attendance.location;
+    this.role = attendance.role;
+    this.minutes_late = attendance.minutes_late;
+    this.hours = attendance.hours;
+    this.hours_auto = attendance.hours_auto;
+    this.hours_is_auto = attendance.hours_is_auto;
+    this.notes = attendance.notes;
+    this.shift = attendance.shift;
+    this.in_method = attendance.in_method;
+    this.out_method = attendance.out_method;
+    this.in_location = attendance.in_location;
+    this.out_location = attendance.out_location;
+    this.in_device = attendance.in_device;
+    this.out_device = attendance.out_device;
+    this.in_terminal = attendance.in_terminal;
+    this.out_terminal = attendance.out_terminal;
   }
 }

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,16 +11,23 @@ import {
   LeaveRequestService,
   LeaveService,
   LocationsService,
+  RetryStrategy,
   RolesService,
+  SettingsService,
   ShiftsService,
   UsersService,
 } from './services/index.js';
 import { SDKConfig } from './interfaces/index.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();
@@ -34,14 +41,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 +61,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

@@ -1,11 +1,23 @@
+import { AxiosResponse } from 'axios';
 import { Account } from '../models/account.model.js';
 import { Service, Options } from './index.js';
 
 import { ApiAccount } from '../interfaces/index.js';
+import { ErrorResponse } from '../models/error-response.model.js';
 
 class AccountsService extends Service {
   private apiPath = '/accounts';
 
+  get(id: number): Promise<Account>;
+  get(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<ApiAccount, any>>;
+  get(id: number, options: Options): Promise<Account>;
+  get(id: number, options?: Options) {
+    return super.fetch<ApiAccount>({ url: `${this.apiPath}/${id}` }, options).then(
+      (res) => Promise.resolve(options?.rawResponse ? res : new Account(res.data)),
+      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
+    );
+  }
+
   async *list(options?: Options) {
     for await (const res of super.iterator<ApiAccount>({ url: this.apiPath }, options)) {
       yield new Account(res);

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';