rotacloud 1.0.30 → 1.0.31

package/README.md

@@ -6,7 +6,7 @@ Please ensure you perform the `npm run version:bump` command before commiting an
 
 ## Configuration
 
-Configuration is simple, just import the core rotacloud.js SDK and supply your API key as necessary.
+Configuration is simple, just import the core RotaCloud SDK and supply your API key as necessary.
 
 ```typescript
 import { RotaCloud } from 'rotacloud';
@@ -29,3 +29,29 @@ try {
   console.log(e);
 }
 ```
+
+## Retry Policies
+
+Our SDK supports both basic and customisable retry polices. Both can be easily configured in the SDKConfig object at time of instantiation. Both exponential and static value based back offs are supported.
+
+Only idempotent requests will be retried.
+
+```typescript
+import { RotaCloud } from 'rotacloud';
+
+const rc = new RotaCloud({
+  apiKey: 'YOUR_API_KEY',
+  retry: 'expo' | 'static',
+});
+```
+
+If more granular control is required of the internal retry policy values, an object can be passed through the `retry` field.
+
+```typescript
+import { RotaCloud } from 'rotacloud';
+
+const rc = new RotaCloud({
+  apiKey: 'YOUR_API_KEY',
+  retry: { delay: 2000, exponential: false, maxRetries: 10 },
+});
+```

package/dist/cjs/interfaces/index.d.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/dist/cjs/interfaces/index.js

@@ -38,5 +38,6 @@ __exportStar(require("./pay-period.interface.js"), exports);
 __exportStar(require("./role-rate.interface.js"), exports);
 __exportStar(require("./role.interface.js"), exports);
 __exportStar(require("./sdk-config.interface.js"), exports);
-__exportStar(require("./user.interface.js"), exports);
+__exportStar(require("./settings.interface.js"), exports);
 __exportStar(require("./shift.interface.js"), exports);
+__exportStar(require("./user.interface.js"), exports);

package/dist/cjs/interfaces/query-params/index.d.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/dist/cjs/interfaces/query-params/index.js

@@ -29,6 +29,7 @@ __exportStar(require("./locations-query-params.interface.js"), exports);
 __exportStar(require("./logbook-events-query-params.interface.js"), exports);
 __exportStar(require("./pay-periods-query-params.interface.js"), exports);
 __exportStar(require("./roles-query-params.interface.js"), exports);
+__exportStar(require("./settings-query-params.interface.js"), exports);
 __exportStar(require("./shifts-query-params.interface.js"), exports);
 __exportStar(require("./swap-requests-query-params.interface.js"), exports);
 __exportStar(require("./terminals-query-params.interface.js"), exports);

package/dist/cjs/interfaces/query-params/settings-query-params.interface.d.ts

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

package/dist/cjs/interfaces/query-params/settings-query-params.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/interfaces/sdk-config.interface.d.ts

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

package/dist/cjs/interfaces/settings.interface.d.ts

@@ -0,0 +1,64 @@
+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/dist/cjs/interfaces/settings.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/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/cjs/models/settings.model.js

@@ -2,5 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Settings = void 0;
 class Settings {
+    constructor(settings) {
+        this.attendance_record_breaks = settings.attendance_record_breaks;
+    }
 }
 exports.Settings = Settings;

package/dist/cjs/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/cjs/rotacloud.js

@@ -10,11 +10,15 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RotaCloud = void 0;
+exports.RetryStrategy = exports.RotaCloud = void 0;
 const index_js_1 = require("./services/index.js");
+const DEFAULT_CONFIG = {
+    baseUri: 'https://api.rotacloud.com/v1',
+    retry: index_js_1.RetryStrategy.Exponential,
+};
 class RotaCloud {
     constructor(config) {
-        this.defaultAPIURI = 'https://api.rotacloud.com/v1';
+        this.defaultAPIURI = DEFAULT_CONFIG.baseUri;
         this.accounts = new index_js_1.AccountsService();
         this.attendance = new index_js_1.AttendanceService();
         this.auth = new index_js_1.AuthService();
@@ -28,12 +32,10 @@ class RotaCloud {
         this.leave = new index_js_1.LeaveService();
         this.locations = new index_js_1.LocationsService();
         this.roles = new index_js_1.RolesService();
+        this.settings = new index_js_1.SettingsService();
         this.shifts = new index_js_1.ShiftsService();
         this.users = new index_js_1.UsersService();
-        if (!config.baseUri) {
-            config.baseUri = this.defaultAPIURI;
-        }
-        this.config = config;
+        this.config = Object.assign(Object.assign({}, DEFAULT_CONFIG), config);
     }
     get config() {
         return RotaCloud.config;
@@ -43,5 +45,7 @@ class RotaCloud {
     }
 }
 exports.RotaCloud = RotaCloud;
+var service_js_1 = require("./services/service.js");
+Object.defineProperty(exports, "RetryStrategy", { enumerable: true, get: function () { return service_js_1.RetryStrategy; } });
 __exportStar(require("./interfaces/index.js"), exports);
 __exportStar(require("./interfaces/query-params/index.js"), exports);

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

@@ -24,5 +24,6 @@ __exportStar(require("./leave-embargoes.service.js"), exports);
 __exportStar(require("./leave.service.js"), exports);
 __exportStar(require("./locations.service.js"), exports);
 __exportStar(require("./roles.service.js"), exports);
+__exportStar(require("./settings.service.js"), exports);
 __exportStar(require("./shifts.service.js"), exports);
 __exportStar(require("./users.service.js"), exports);

package/dist/cjs/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/cjs/services/service.js

@@ -36,12 +36,33 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Service = void 0;
+exports.Service = exports.RetryStrategy = void 0;
 const axios_1 = __importDefault(require("axios"));
+const axios_retry_1 = __importDefault(require("axios-retry"));
 const rotacloud_js_1 = require("../rotacloud.js");
 const version_js_1 = require("../version.js");
+var RetryStrategy;
+(function (RetryStrategy) {
+    RetryStrategy["Exponential"] = "expo";
+    RetryStrategy["Static"] = "static";
+})(RetryStrategy = exports.RetryStrategy || (exports.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,
+    },
+};
 class Service {
-    // rate limit tracking could be implemented here statically
+    constructor() {
+        this.client = axios_1.default.create();
+    }
     isLeaveRequest(endpoint) {
         return endpoint === '/leave_requests';
     }
@@ -84,7 +105,21 @@ class Service {
             const reqObject = Object.assign(Object.assign({}, httpOptions), { baseURL: rotacloud_js_1.RotaCloud.config.baseUri, headers, params: Object.assign({ expand: options === null || options === void 0 ? void 0 : options.expand, fields: options === null || options === void 0 ? void 0 : options.fields, limit: options === null || options === void 0 ? void 0 : options.limit }, httpOptions === null || httpOptions === void 0 ? void 0 : httpOptions.params), paramsSerializer: (params) => {
                     return params ? this.buildQueryStr(params) : '';
                 } });
-            const response = yield axios_1.default.request(reqObject);
+            if (rotacloud_js_1.RotaCloud.config.retry) {
+                const retryConfig = typeof rotacloud_js_1.RotaCloud.config.retry === 'string'
+                    ? DEFAULT_RETRY_STRATEGY_OPTIONS[rotacloud_js_1.RotaCloud.config.retry]
+                    : rotacloud_js_1.RotaCloud.config.retry;
+                (0, axios_retry_1.default)(this.client, {
+                    retries: retryConfig.maxRetries,
+                    retryDelay: (retryCount) => {
+                        if (retryConfig.exponential) {
+                            return axios_retry_1.default.exponentialDelay(retryCount);
+                        }
+                        return retryConfig.delay;
+                    },
+                });
+            }
+            const response = yield this.client.request(reqObject);
             return response;
         });
     }

package/dist/cjs/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/cjs/services/settings.service.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SettingsService = void 0;
+const settings_model_js_1 = require("../models/settings.model.js");
+const index_js_1 = require("./index.js");
+const error_response_model_js_1 = require("../models/error-response.model.js");
+class SettingsService extends index_js_1.Service {
+    constructor() {
+        super(...arguments);
+        this.apiPath = '/settings';
+    }
+    get(query, options) {
+        return super.fetch({ url: `${this.apiPath}`, params: query }, options).then((res) => Promise.resolve((options === null || options === void 0 ? void 0 : options.rawResponse) ? res : new settings_model_js_1.Settings(res.data)), (err) => Promise.reject((options === null || options === void 0 ? void 0 : options.rawResponse) ? err : new error_response_model_js_1.ErrorResponse(err)));
+    }
+}
+exports.SettingsService = SettingsService;

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Version = void 0;
-exports.Version = { version: '1.0.30' };
+exports.Version = { version: '1.0.31' };

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

@@ -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/dist/mjs/interfaces/query-params/settings-query-params.interface.d.ts

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

package/dist/mjs/interfaces/query-params/settings-query-params.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/mjs/interfaces/sdk-config.interface.d.ts

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

package/dist/mjs/interfaces/settings.interface.d.ts

@@ -0,0 +1,64 @@
+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/dist/mjs/interfaces/settings.interface.js

@@ -0,0 +1 @@
+export {};

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/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.30' };
+export const Version = { version: '1.0.31' };

package/package.json

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

@@ -1,9 +1,46 @@
-import axios, { AxiosRequestConfig, AxiosRequestHeaders, AxiosResponse } from 'axios';
+import axios, { AxiosInstance, AxiosRequestConfig, AxiosRequestHeaders, AxiosResponse } from 'axios';
+import axiosRetry from 'axios-retry';
 import { RotaCloud } from '../rotacloud.js';
 import { Version } from '../version.js';
 
 export type RequirementsOf<T, K extends keyof T> = Required<Pick<T, K>> & Partial<T>;
 
+export enum RetryStrategy {
+  Exponential = 'expo',
+  Static = 'static',
+}
+
+export 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;
+    };
+
+const DEFAULT_RETRIES = 3;
+const DEFAULT_RETRY_DELAY = 2000;
+
+const DEFAULT_RETRY_STRATEGY_OPTIONS: Record<RetryStrategy, RetryOptions> = {
+  [RetryStrategy.Exponential]: {
+    exponential: true,
+    maxRetries: DEFAULT_RETRIES,
+  },
+  [RetryStrategy.Static]: {
+    exponential: false,
+    maxRetries: DEFAULT_RETRIES,
+    delay: DEFAULT_RETRY_DELAY,
+  },
+};
+
 export interface Options {
   rawResponse?: boolean;
   expand?: string[];
@@ -22,7 +59,7 @@ type ParameterPrimitive = string | boolean | number | null;
 type ParameterValue = ParameterPrimitive | ParameterPrimitive[] | undefined;
 
 export abstract class Service<ApiResponse = any> {
-  // rate limit tracking could be implemented here statically
+  protected client: AxiosInstance = axios.create();
 
   public isLeaveRequest(endpoint?: string): boolean {
     return endpoint === '/leave_requests';
@@ -80,7 +117,24 @@ export abstract class Service<ApiResponse = any> {
       },
     };
 
-    const response = await axios.request<T>(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<T>(reqObject);
     return response;
   }
 

package/src/services/settings.service.ts

@@ -0,0 +1,23 @@
+import { AxiosResponse } from 'axios';
+import { Settings } from '../models/settings.model.js';
+import { Service, Options } from './index.js';
+
+import { ApiSettings } from '../interfaces/index.js';
+import { ErrorResponse } from '../models/error-response.model.js';
+import { SettingsQueryParams } from '../rotacloud.js';
+
+class SettingsService extends Service {
+  private apiPath = '/settings';
+
+  get(query: SettingsQueryParams): Promise<Settings>;
+  get(query: SettingsQueryParams, options: { rawResponse: true } & Options): Promise<AxiosResponse<ApiSettings, any>>;
+  get(query: SettingsQueryParams, options: Options): Promise<Settings>;
+  get(query: SettingsQueryParams, options?: Options) {
+    return super.fetch<ApiSettings>({ 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/src/version.ts

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