rotacloud 1.0.55 → 1.0.57

package/dist/cjs/interfaces/users-clocked-out.interface.d.ts

@@ -0,0 +1,26 @@
+import { ApiShift, ApiTerminalLocation } from './index.js';
+export interface ApiUserClockedOut {
+    id: number;
+    deleted: boolean;
+    approved: boolean;
+    user: number;
+    location: number;
+    role: number;
+    in_time: number;
+    out_time: number;
+    minutes_break: number;
+    minutes_late: number;
+    hours: number;
+    hours_auto: number;
+    hours_is_auto: boolean;
+    notes: string | null;
+    shift: Pick<ApiShift, 'id' | 'start_time' | 'end_time' | 'minutes_break' | 'location' | 'role'>;
+    in_method: string;
+    in_location: ApiTerminalLocation;
+    in_device: string | null;
+    in_terminal: number | null;
+    out_method: string;
+    out_location: ApiTerminalLocation;
+    out_device: string | null;
+    out_terminal: number | null;
+}

package/dist/cjs/interfaces/users-clocked-out.interface.js

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

package/dist/cjs/models/SDKError.model.d.ts

@@ -0,0 +1,11 @@
+export interface SDKErrorConfig {
+    message?: string;
+    code?: number;
+    data?: unknown;
+}
+export declare class SDKError extends Error {
+    name: string;
+    readonly code?: number;
+    readonly data?: unknown;
+    constructor(errorConfig: SDKErrorConfig);
+}

package/dist/cjs/models/SDKError.model.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SDKError = void 0;
+class SDKError extends Error {
+    constructor(errorConfig) {
+        var _a;
+        super(errorConfig.message);
+        this.name = 'SDKError';
+        (_a = Error.captureStackTrace) === null || _a === void 0 ? void 0 : _a.call(Error, this, SDKError);
+        // optional chaining needed as is v8 specific https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error#static_methods
+        this.data = errorConfig.data;
+        this.code = errorConfig.code;
+    }
+}
+exports.SDKError = SDKError;

package/dist/cjs/models/account.model.d.ts

@@ -0,0 +1,46 @@
+import { ApiAccount } from '../interfaces/index.js';
+export declare class Account {
+    id: number;
+    name: string;
+    level: string;
+    created: number;
+    expired: boolean;
+    owner: number;
+    timezone: number;
+    industry: number;
+    phone: string | null;
+    address_1: string | null;
+    address_2: string | null;
+    city: string | null;
+    county: string | null;
+    postcode: string | null;
+    country: number;
+    services: any;
+    total_price: number;
+    pricing: {
+        current: boolean;
+        name: string;
+        max_employees: number;
+        total_price: number;
+    };
+    expires_in: number;
+    features_disabled: string[];
+    first_billed: string | null;
+    owed: number;
+    trial: boolean;
+    can_restart_trial: boolean;
+    next_billed: string;
+    hide_billing: boolean;
+    total_employees: number;
+    payment_card: string | null;
+    billing_type: string;
+    billing_term: string;
+    billing_email: string | null;
+    billing_address: string | null;
+    grouped_billing_parent: number | null;
+    grouped_billing_children: number[] | null;
+    vat_number: string | null;
+    suspended: boolean;
+    suspended_message: string | null;
+    constructor(account: ApiAccount);
+}

package/dist/cjs/models/account.model.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Account = void 0;
+class Account {
+    constructor(account) {
+        Object.assign(this, account);
+    }
+}
+exports.Account = Account;

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

@@ -0,0 +1,27 @@
+import { ApiAttendance, ApiTerminalLocation, 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: ApiTerminalLocation;
+    out_location: ApiTerminalLocation;
+    in_device: number;
+    out_device: number;
+    in_terminal: number | null;
+    out_terminal: number | null;
+    constructor(attendance: ApiAttendance);
+}

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

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Attendance = void 0;
+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;
+    }
+}
+exports.Attendance = Attendance;

package/dist/cjs/models/auth.model.d.ts

@@ -0,0 +1,6 @@
+import { ApiAuth, ApiAuthAccount } from '../interfaces/index.js';
+export declare class Auth {
+    two_factor_enabled: boolean;
+    accounts: ApiAuthAccount[];
+    constructor(auth: ApiAuth);
+}

package/dist/cjs/models/auth.model.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Auth = void 0;
+class Auth {
+    constructor(auth) {
+        this.two_factor_enabled = auth.two_factor_enabled;
+        this.accounts = auth.accounts;
+    }
+}
+exports.Auth = Auth;

package/dist/cjs/models/availability-pattern.model.d.ts

@@ -0,0 +1,17 @@
+import { ApiAvailabilityPatternAvailability, ApiAvailabilityPattern } from '../interfaces/index.js';
+export declare class AvailabilityPattern {
+    id: number;
+    user: number;
+    name: string;
+    start_date: string;
+    end_date: string;
+    repeat_weeks: number;
+    mon: ApiAvailabilityPatternAvailability;
+    tue: ApiAvailabilityPatternAvailability;
+    wed: ApiAvailabilityPatternAvailability;
+    thu: ApiAvailabilityPatternAvailability;
+    fri: ApiAvailabilityPatternAvailability;
+    sat: ApiAvailabilityPatternAvailability;
+    sun: ApiAvailabilityPatternAvailability;
+    constructor(apiAvailabilityPatterns: ApiAvailabilityPattern);
+}

package/dist/cjs/models/availability-pattern.model.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AvailabilityPattern = void 0;
+class AvailabilityPattern {
+    constructor(apiAvailabilityPatterns) {
+        this.id = apiAvailabilityPatterns.id;
+        this.user = apiAvailabilityPatterns.user;
+        this.name = apiAvailabilityPatterns.name;
+        this.start_date = apiAvailabilityPatterns.start_date;
+        this.end_date = apiAvailabilityPatterns.end_date;
+        this.repeat_weeks = apiAvailabilityPatterns.repeat_weeks;
+        this.mon = apiAvailabilityPatterns.mon;
+        this.tue = apiAvailabilityPatterns.tue;
+        this.wed = apiAvailabilityPatterns.wed;
+        this.thu = apiAvailabilityPatterns.thu;
+        this.fri = apiAvailabilityPatterns.fri;
+        this.sat = apiAvailabilityPatterns.sat;
+        this.sun = apiAvailabilityPatterns.sun;
+    }
+}
+exports.AvailabilityPattern = AvailabilityPattern;

package/dist/cjs/models/availability.model.d.ts

@@ -0,0 +1,6 @@
+import { ApiAvailability, ApiAvailabilityDate } from '../interfaces/index.js';
+export declare class Availability {
+    user: number;
+    dates: ApiAvailabilityDate[];
+    constructor(availability: ApiAvailability);
+}

package/dist/cjs/models/availability.model.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Availability = void 0;
+class Availability {
+    constructor(availability) {
+        this.user = availability.user;
+        this.dates = availability.dates;
+    }
+}
+exports.Availability = Availability;

package/dist/cjs/models/daily-budgets.model.d.ts

@@ -0,0 +1,8 @@
+import { ApiDailyBudgets } from '../interfaces/index.js';
+export declare class DailyBudgets {
+    date: string;
+    location: number;
+    hours_budget: number;
+    salary_budget: number;
+    constructor(dailyBudgets: ApiDailyBudgets);
+}

package/dist/cjs/models/daily-budgets.model.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DailyBudgets = void 0;
+class DailyBudgets {
+    constructor(dailyBudgets) {
+        this.date = dailyBudgets.date;
+        this.location = dailyBudgets.location;
+        this.hours_budget = dailyBudgets.hours_budget;
+        this.salary_budget = dailyBudgets.salary_budget;
+    }
+}
+exports.DailyBudgets = DailyBudgets;

package/dist/cjs/models/daily-revenue.model.d.ts

@@ -0,0 +1,9 @@
+import { ApiDailyRevenue } from '../interfaces/index.js';
+export declare class DailyRevenue {
+    date: string;
+    location: number;
+    labour_percentage: number;
+    revenue_target: number;
+    revenue_actual: number;
+    constructor(dailyRevenue: ApiDailyRevenue);
+}

package/dist/cjs/models/daily-revenue.model.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DailyRevenue = void 0;
+class DailyRevenue {
+    constructor(dailyRevenue) {
+        this.date = dailyRevenue.date;
+        this.location = dailyRevenue.location;
+        this.labour_percentage = dailyRevenue.labour_percentage;
+        this.revenue_target = dailyRevenue.revenue_target;
+        this.revenue_actual = dailyRevenue.revenue_actual;
+    }
+}
+exports.DailyRevenue = DailyRevenue;

package/dist/cjs/models/day-note.model.d.ts

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

package/dist/cjs/models/day-note.model.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DayNote = void 0;
+class DayNote {
+    constructor(dayNote) {
+        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;
+        this.visible_employees = dayNote.visible_employees;
+    }
+}
+exports.DayNote = DayNote;

package/dist/cjs/models/days-off-pattern.model.d.ts

@@ -0,0 +1,15 @@
+import { ApiDaysOffPattern } from '../interfaces/index.js';
+export declare class DaysOffPattern {
+    id: number;
+    user: number;
+    start_date: string;
+    end_date: string;
+    mon_day_off: boolean;
+    tue_day_off: boolean;
+    wed_day_off: boolean;
+    thu_day_off: boolean;
+    fri_day_off: boolean;
+    sat_day_off: boolean;
+    sun_day_off: boolean;
+    constructor(daysOffPattern: ApiDaysOffPattern);
+}

package/dist/cjs/models/days-off-pattern.model.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DaysOffPattern = void 0;
+class DaysOffPattern {
+    constructor(daysOffPattern) {
+        this.id = daysOffPattern.id;
+    }
+}
+exports.DaysOffPattern = DaysOffPattern;

package/dist/cjs/models/days-off.model.d.ts

@@ -0,0 +1,6 @@
+import { ApiDaysOff, ApiDayOff } from '../interfaces/index.js';
+export declare class DaysOff {
+    user: number;
+    dates: ApiDayOff[];
+    constructor(daysoff: ApiDaysOff);
+}

package/dist/cjs/models/days-off.model.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DaysOff = void 0;
+class DaysOff {
+    constructor(daysoff) {
+        this.user = daysoff.user;
+        this.dates = daysoff.dates;
+    }
+}
+exports.DaysOff = DaysOff;

package/dist/cjs/models/document.model.d.ts

@@ -0,0 +1,12 @@
+export declare class Document {
+    id: number;
+    deleted: boolean;
+    created_at: number;
+    created_by: number;
+    name: string;
+    public: boolean;
+    extension: string;
+    size_kb: number;
+    user: number;
+    users: number[];
+}

package/dist/cjs/models/document.model.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Document = void 0;
+class Document {
+}
+exports.Document = Document;

package/dist/cjs/models/group.model.d.ts

@@ -0,0 +1,7 @@
+import { ApiGroup } from '../interfaces/index.js';
+export declare class Group {
+    id: number;
+    name: string;
+    users: number[];
+    constructor(group: ApiGroup);
+}

package/dist/cjs/models/group.model.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Group = void 0;
+class Group {
+    constructor(group) {
+        this.id = group.id;
+        this.name = group.name;
+        this.users = group.users;
+    }
+}
+exports.Group = Group;

package/dist/cjs/models/holiday-allowance-custom.model.d.ts

@@ -0,0 +1,5 @@
+export declare class HolidayAllowanceCustom {
+    user: number;
+    holiday_allowance: number;
+    holiday_allowance_unit: string;
+}

package/dist/cjs/models/holiday-allowance-custom.model.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HolidayAllowanceCustom = void 0;
+class HolidayAllowanceCustom {
+}
+exports.HolidayAllowanceCustom = HolidayAllowanceCustom;

package/dist/cjs/models/holiday-allowance.model.d.ts

@@ -0,0 +1,13 @@
+import { ApiHolidayAllowance } from '../interfaces/index.js';
+export declare class HolidayAllowance {
+    user: number;
+    default_holiday_allowance: number;
+    default_holiday_allowance_unit: string;
+    custom_holiday_allowance: null;
+    custom_holiday_allowance_unit: null;
+    adjusted_start_date: boolean;
+    adjusted_final_working_date: boolean;
+    holiday_allowance: number;
+    holiday_allowance_unit: string;
+    constructor(holidayAllowance: ApiHolidayAllowance);
+}

package/dist/cjs/models/holiday-allowance.model.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HolidayAllowance = void 0;
+class HolidayAllowance {
+    constructor(holidayAllowance) {
+        this.user = holidayAllowance.user;
+    }
+}
+exports.HolidayAllowance = HolidayAllowance;

package/dist/cjs/models/index.d.ts

@@ -0,0 +1,33 @@
+export * from './account.model.js';
+export * from './attendance.model.js';
+export * from './auth.model.js';
+export * from './availability-pattern.model.js';
+export * from './availability.model.js';
+export * from './daily-budgets.model.js';
+export * from './daily-revenue.model.js';
+export * from './day-note.model.js';
+export * from './days-off-pattern.model.js';
+export * from './days-off.model.js';
+export * from './document.model.js';
+export * from './SDKError.model.js';
+export * from './group.model.js';
+export * from './holiday-allowance-custom.model.js';
+export * from './holiday-allowance.model.js';
+export * from './leave-embargo.model.js';
+export * from './leave-request.model.js';
+export * from './leave-type.model.js';
+export * from './leave.model.js';
+export * from './location.model.js';
+export * from './logbook-category.model.js';
+export * from './logbook-event.model.js';
+export * from './memo.model.js';
+export * from './pay-period.model.js';
+export * from './role.model.js';
+export * from './settings.model.js';
+export * from './shift.model.js';
+export * from './terminal.model.js';
+export * from './toil-accrual.model.js';
+export * from './toil-allowance.model.js';
+export * from './user.model.js';
+export * from './users-clocked-in.model.js';
+export * from './users-clocked-out.model.js';

package/dist/cjs/models/index.js

@@ -0,0 +1,49 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./account.model.js"), exports);
+__exportStar(require("./attendance.model.js"), exports);
+__exportStar(require("./auth.model.js"), exports);
+__exportStar(require("./availability-pattern.model.js"), exports);
+__exportStar(require("./availability.model.js"), exports);
+__exportStar(require("./daily-budgets.model.js"), exports);
+__exportStar(require("./daily-revenue.model.js"), exports);
+__exportStar(require("./day-note.model.js"), exports);
+__exportStar(require("./days-off-pattern.model.js"), exports);
+__exportStar(require("./days-off.model.js"), exports);
+__exportStar(require("./document.model.js"), exports);
+__exportStar(require("./SDKError.model.js"), exports);
+__exportStar(require("./group.model.js"), exports);
+__exportStar(require("./holiday-allowance-custom.model.js"), exports);
+__exportStar(require("./holiday-allowance.model.js"), exports);
+__exportStar(require("./leave-embargo.model.js"), exports);
+__exportStar(require("./leave-request.model.js"), exports);
+__exportStar(require("./leave-type.model.js"), exports);
+__exportStar(require("./leave.model.js"), exports);
+__exportStar(require("./location.model.js"), exports);
+__exportStar(require("./logbook-category.model.js"), exports);
+__exportStar(require("./logbook-event.model.js"), exports);
+__exportStar(require("./memo.model.js"), exports);
+__exportStar(require("./pay-period.model.js"), exports);
+__exportStar(require("./role.model.js"), exports);
+__exportStar(require("./settings.model.js"), exports);
+__exportStar(require("./shift.model.js"), exports);
+__exportStar(require("./terminal.model.js"), exports);
+__exportStar(require("./toil-accrual.model.js"), exports);
+__exportStar(require("./toil-allowance.model.js"), exports);
+__exportStar(require("./user.model.js"), exports);
+__exportStar(require("./users-clocked-in.model.js"), exports);
+__exportStar(require("./users-clocked-out.model.js"), exports);

package/dist/cjs/models/leave-embargo.model.d.ts

@@ -0,0 +1,6 @@
+import { ApiLeaveEmbargo } from '../interfaces/index.js';
+export declare class LeaveEmbargo {
+    id: number;
+    message: string;
+    constructor(leaveEmbargo: ApiLeaveEmbargo);
+}

package/dist/cjs/models/leave-embargo.model.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LeaveEmbargo = void 0;
+class LeaveEmbargo {
+    constructor(leaveEmbargo) {
+        this.id = leaveEmbargo.id;
+        this.message = leaveEmbargo.message;
+    }
+}
+exports.LeaveEmbargo = LeaveEmbargo;

package/dist/cjs/models/leave-request.model.d.ts

@@ -0,0 +1,14 @@
+import { ApiLeaveDate, ApiLeaveRequest } from '../interfaces';
+export declare class LeaveRequest {
+    id: number;
+    deleted: boolean;
+    type: number;
+    user: number;
+    user_message: string | null;
+    start_date: string;
+    start_am_pm: string;
+    end_date: string;
+    end_am_pm: string;
+    dates: ApiLeaveDate[];
+    constructor(leaveRequest: ApiLeaveRequest);
+}

package/dist/cjs/models/leave-request.model.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LeaveRequest = void 0;
+class LeaveRequest {
+    constructor(leaveRequest) {
+        this.id = leaveRequest.id;
+        this.deleted = leaveRequest.deleted;
+        this.type = leaveRequest.type;
+        this.user = leaveRequest.user;
+        this.user_message = leaveRequest.user_message;
+        this.start_date = leaveRequest.start_date;
+        this.start_am_pm = leaveRequest.start_am_pm;
+        this.end_date = leaveRequest.end_date;
+        this.end_am_pm = leaveRequest.end_am_pm;
+        this.dates = leaveRequest.dates;
+    }
+}
+exports.LeaveRequest = LeaveRequest;

package/dist/cjs/models/leave-type.model.d.ts

@@ -0,0 +1,10 @@
+import { ApiLeaveType } from '../interfaces/index.js';
+export declare class LeaveType {
+    id: number;
+    name: string;
+    short_name: string;
+    colour: string;
+    can_request: boolean;
+    time_attendance_only: boolean;
+    constructor(leaveType: ApiLeaveType);
+}

package/dist/cjs/models/leave-type.model.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LeaveType = void 0;
+class LeaveType {
+    constructor(leaveType) {
+        this.id = leaveType.id;
+        this.name = leaveType.name;
+        this.short_name = leaveType.short_name;
+        this.colour = leaveType.colour;
+        this.can_request = leaveType.can_request;
+        this.time_attendance_only = leaveType.time_attendance_only;
+    }
+}
+exports.LeaveType = LeaveType;