rotacloud 1.0.55 → 1.0.57

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/interfaces/shift.interface.d.ts

@@ -0,0 +1,25 @@
+export interface ApiShift {
+    id: number;
+    deleted: boolean;
+    deleted_at: number | null;
+    deleted_by: number | null;
+    published: boolean;
+    open: boolean;
+    start_time: number;
+    end_time: number;
+    minutes_break: number;
+    user: number | null;
+    location: number;
+    role: number | null;
+    notes: string | null;
+    created_at: number;
+    created_by: number;
+    updated_at: number | null;
+    updated_by: number | null;
+    claimed: boolean;
+    claimed_at: number | null;
+    acknowledged: boolean;
+    acknowledged_at: number | null;
+    swap_requests: number[];
+    unavailability_requests: number[];
+}

package/dist/mjs/interfaces/shift.interface.js

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

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

@@ -0,0 +1,21 @@
+export interface ApiTerminal {
+    id: number;
+    deleted: boolean;
+    name: string;
+    active: boolean;
+    platform: string | null;
+    device: string | null;
+    version: string | null;
+    ip: string | null;
+    location: ApiTerminalLocation | null;
+    timezone: number;
+    require_photo: boolean;
+    require_photo_breaks: boolean;
+    debug: boolean;
+    secret: string;
+}
+export interface ApiTerminalLocation {
+    lat: number;
+    lng: number;
+    accuracy: number;
+}

package/dist/mjs/interfaces/terminal.interface.js

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

package/dist/mjs/interfaces/toil-accrual.interface.d.ts

@@ -0,0 +1,14 @@
+export interface ApiToilAccrual {
+    comments: string;
+    created_at: number;
+    created_by: number | null;
+    date: string;
+    deleted: boolean;
+    deleted_at: string | null;
+    deleted_by: number | null;
+    duration_hours: number;
+    id: number;
+    leave_year: number;
+    location_id: number | null;
+    user_id: number;
+}

package/dist/mjs/interfaces/toil-accrual.interface.js

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

package/dist/mjs/interfaces/toil-allowance.interface.d.ts

@@ -0,0 +1,7 @@
+export interface ApiToilAllowance {
+    user: number;
+    accrued_hours: number;
+    remaining_hours: number;
+    used_hours: number;
+    has_toil_records: boolean;
+}

package/dist/mjs/interfaces/toil-allowance.interface.js

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

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

@@ -0,0 +1,45 @@
+import { ApiLeaveRate, ApiRoleRate, ApiTerminalLocation } from './index.js';
+export interface ApiUser {
+    id: number;
+    created_at: number;
+    created_by: number;
+    deleted: boolean;
+    deleted_at: number | null;
+    deleted_by: number | null;
+    level: string;
+    first_name: string;
+    middle_name: string | null;
+    last_name: string;
+    preferred_name: string | null;
+    photo: string | null;
+    two_factor_enabled: boolean;
+    email: string;
+    has_account: boolean;
+    invite_sent: boolean;
+    group: number | null;
+    locations: number[];
+    roles: number[];
+    default_role: number | null;
+    dob: string | null;
+    start_date: string | null;
+    final_working_date: string | null;
+    weekly_hours: number | null;
+    holiday_allowance: number;
+    holiday_allowance_unit: string;
+    payroll_id: string | null;
+    salary: number;
+    salary_type: string;
+    overtime_rate: number;
+    role_rates: ApiLeaveRate;
+    leave_rates: ApiRoleRate;
+    leave_rates_unit: string;
+    leave_rates_type: string;
+    notes: string | null;
+    pin: string | null;
+}
+export interface ApiUserBreak {
+    start_time: number;
+    start_location: ApiTerminalLocation;
+    end_time?: number;
+    end_location?: ApiTerminalLocation;
+}

package/dist/mjs/interfaces/user.interface.js

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

package/dist/mjs/interfaces/users-clocked-in.interface.d.ts

@@ -0,0 +1,13 @@
+import { ApiShift, ApiTerminalLocation } from '../interfaces/index.js';
+export interface ApiUserClockedIn {
+    user: number;
+    location: number;
+    role: number;
+    in_time: number;
+    minutes_late: number;
+    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;
+}

package/dist/mjs/interfaces/users-clocked-in.interface.js

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

package/dist/mjs/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/mjs/interfaces/users-clocked-out.interface.js

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

package/dist/mjs/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/mjs/models/SDKError.model.js

@@ -0,0 +1,10 @@
+export class SDKError extends Error {
+    constructor(errorConfig) {
+        super(errorConfig.message);
+        this.name = 'SDKError';
+        Error.captureStackTrace?.(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;
+    }
+}

package/dist/mjs/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/mjs/models/account.model.js

@@ -0,0 +1,5 @@
+export class Account {
+    constructor(account) {
+        Object.assign(this, account);
+    }
+}

package/dist/mjs/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/mjs/models/attendance.model.js

@@ -0,0 +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/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/mjs/models/auth.model.js

@@ -0,0 +1,6 @@
+export class Auth {
+    constructor(auth) {
+        this.two_factor_enabled = auth.two_factor_enabled;
+        this.accounts = auth.accounts;
+    }
+}

package/dist/mjs/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/mjs/models/availability-pattern.model.js

@@ -0,0 +1,17 @@
+export 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;
+    }
+}

package/dist/mjs/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/mjs/models/availability.model.js

@@ -0,0 +1,6 @@
+export class Availability {
+    constructor(availability) {
+        this.user = availability.user;
+        this.dates = availability.dates;
+    }
+}

package/dist/mjs/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/mjs/models/daily-budgets.model.js

@@ -0,0 +1,8 @@
+export class DailyBudgets {
+    constructor(dailyBudgets) {
+        this.date = dailyBudgets.date;
+        this.location = dailyBudgets.location;
+        this.hours_budget = dailyBudgets.hours_budget;
+        this.salary_budget = dailyBudgets.salary_budget;
+    }
+}

package/dist/mjs/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/mjs/models/daily-revenue.model.js

@@ -0,0 +1,9 @@
+export 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;
+    }
+}

package/dist/mjs/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/mjs/models/day-note.model.js

@@ -0,0 +1,11 @@
+export 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;
+    }
+}

package/dist/mjs/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/mjs/models/days-off-pattern.model.js

@@ -0,0 +1,5 @@
+export class DaysOffPattern {
+    constructor(daysOffPattern) {
+        this.id = daysOffPattern.id;
+    }
+}

package/dist/mjs/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/mjs/models/days-off.model.js

@@ -0,0 +1,6 @@
+export class DaysOff {
+    constructor(daysoff) {
+        this.user = daysoff.user;
+        this.dates = daysoff.dates;
+    }
+}

package/dist/mjs/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/mjs/models/document.model.js

@@ -0,0 +1,2 @@
+export class Document {
+}

package/dist/mjs/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/mjs/models/group.model.js

@@ -0,0 +1,7 @@
+export class Group {
+    constructor(group) {
+        this.id = group.id;
+        this.name = group.name;
+        this.users = group.users;
+    }
+}

package/dist/mjs/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/mjs/models/holiday-allowance-custom.model.js

@@ -0,0 +1,2 @@
+export class HolidayAllowanceCustom {
+}

package/dist/mjs/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/mjs/models/holiday-allowance.model.js

@@ -0,0 +1,5 @@
+export class HolidayAllowance {
+    constructor(holidayAllowance) {
+        this.user = holidayAllowance.user;
+    }
+}