rotacloud 1.0.55 → 1.0.57

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

@@ -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/mjs/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/mjs/models/leave-embargo.model.js

@@ -0,0 +1,6 @@
+export class LeaveEmbargo {
+    constructor(leaveEmbargo) {
+        this.id = leaveEmbargo.id;
+        this.message = leaveEmbargo.message;
+    }
+}

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

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

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

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

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

@@ -0,0 +1,28 @@
+import { ApiLeave, ApiLeaveDate } from '../interfaces/index.js';
+export declare class Leave {
+    id: number;
+    type: number;
+    user: number;
+    start_date: string;
+    end_date: string;
+    dates: ApiLeaveDate[];
+    paid: boolean;
+    status: string;
+    requested: boolean;
+    admin_message: string | null;
+    user_message: string | null;
+    deleted: boolean;
+    deleted_at: number | null;
+    deleted_by: number | null;
+    admin: number;
+    start_am_pm: string;
+    end_am_pm: string;
+    hours: {
+        [key: string]: number | null;
+    };
+    hours_method: string;
+    hours_set: boolean;
+    requested_at: number;
+    replied_at: number;
+    constructor(leave: ApiLeave);
+}

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

@@ -0,0 +1,26 @@
+export class Leave {
+    constructor(leave) {
+        this.id = leave.id;
+        this.type = leave.type;
+        this.dates = leave.dates;
+        this.user = leave.user;
+        this.start_date = leave.start_date;
+        this.end_date = leave.end_date;
+        this.paid = leave.paid;
+        this.status = leave.status;
+        this.requested = leave.requested;
+        this.admin_message = leave.admin_message;
+        this.user_message = leave.user_message;
+        this.deleted = leave.deleted;
+        this.deleted_at = leave.deleted_at;
+        this.deleted_by = leave.deleted_by;
+        this.admin = leave.admin;
+        this.start_am_pm = leave.start_am_pm;
+        this.end_am_pm = leave.end_am_pm;
+        this.hours = leave.hours;
+        this.hours_method = leave.hours_method;
+        this.hours_set = leave.hours_set;
+        this.requested_at = leave.requested_at;
+        this.replied_at = leave.replied_at;
+    }
+}

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

@@ -0,0 +1,14 @@
+import { ApiLocation, ApiLocationCoordinate } from '../interfaces/index.js';
+export declare class Location {
+    id: number;
+    name: string;
+    deleted: boolean;
+    address: string;
+    location: ApiLocationCoordinate;
+    timezone: number;
+    users: number[];
+    managers: number[];
+    metadata: object;
+    clock_in_ips: string[];
+    constructor(location: ApiLocation);
+}

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

@@ -0,0 +1,14 @@
+export class Location {
+    constructor(location) {
+        this.id = location.id;
+        this.name = location.name;
+        this.deleted = location.deleted;
+        this.address = location.address;
+        this.location = location.location;
+        this.timezone = location.timezone;
+        this.users = location.users;
+        this.managers = location.managers;
+        this.metadata = location.metadata;
+        this.clock_in_ips = location.clock_in_ips;
+    }
+}

package/dist/mjs/models/logbook-category.model.d.ts

@@ -0,0 +1,7 @@
+import { ApiLogbookCategory } from '../interfaces/index.js';
+export declare class LogbookCategory {
+    id: number;
+    name: string;
+    deleted: boolean | null;
+    constructor(logbookCategory: ApiLogbookCategory);
+}

package/dist/mjs/models/logbook-category.model.js

@@ -0,0 +1,7 @@
+export class LogbookCategory {
+    constructor(logbookCategory) {
+        this.id = logbookCategory.id;
+        this.name = logbookCategory.name;
+        this.deleted = logbookCategory.deleted ?? null;
+    }
+}

package/dist/mjs/models/logbook-event.model.d.ts

@@ -0,0 +1,5 @@
+import { ApiLogbookEvent } from '../interfaces/index.js';
+export declare class LogBookEvent {
+    id: number;
+    constructor(logbookEvent: ApiLogbookEvent);
+}

package/dist/mjs/models/logbook-event.model.js

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

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

@@ -0,0 +1,8 @@
+export declare class Memo {
+    id: number;
+    sent_at: number;
+    sent_by: number;
+    subject: string;
+    message: string;
+    users: number[];
+}

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

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

package/dist/mjs/models/pay-period.model.d.ts

@@ -0,0 +1,6 @@
+import { ApiPayPeriod } from '../interfaces/index.js';
+export declare class PayPeriod {
+    id: number;
+    name: string;
+    constructor(payPeriod: ApiPayPeriod);
+}

package/dist/mjs/models/pay-period.model.js

@@ -0,0 +1,6 @@
+export class PayPeriod {
+    constructor(payPeriod) {
+        this.id = payPeriod.id;
+        this.name = payPeriod.name;
+    }
+}

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

@@ -0,0 +1,11 @@
+import { ApiRole } from '../interfaces/index.js';
+export declare class Role {
+    id: number;
+    deleted: boolean;
+    name: string;
+    colour: string;
+    default_break: number;
+    users: number[];
+    pay_code: string;
+    constructor(role: ApiRole);
+}

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

@@ -0,0 +1,11 @@
+export class Role {
+    constructor(role) {
+        this.id = role.id;
+        this.deleted = role.deleted;
+        this.name = role.name;
+        this.colour = role.colour;
+        this.default_break = role.default_break;
+        this.users = role.users;
+        this.pay_code = role.pay_code;
+    }
+}

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

@@ -0,0 +1,61 @@
+import { ApiSettings, PayCodes } from '../interfaces';
+export declare class Settings {
+    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;
+    constructor(settings: ApiSettings);
+}

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

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

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

@@ -0,0 +1,27 @@
+import { ApiShift } from '../interfaces/index.js';
+export declare class Shift {
+    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[];
+    constructor(shift: ApiShift);
+}

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

@@ -0,0 +1,27 @@
+export class Shift {
+    constructor(shift) {
+        this.id = shift.id;
+        this.deleted = shift.deleted;
+        this.deleted_at = shift.deleted_at;
+        this.deleted_by = shift.deleted_by;
+        this.published = shift.published;
+        this.open = shift.open;
+        this.start_time = shift.start_time;
+        this.end_time = shift.end_time;
+        this.minutes_break = shift.minutes_break;
+        this.user = shift.user;
+        this.location = shift.location;
+        this.role = shift.role;
+        this.notes = shift.notes;
+        this.created_at = shift.created_at;
+        this.created_by = shift.created_by;
+        this.updated_at = shift.updated_at;
+        this.updated_by = shift.updated_by;
+        this.claimed = shift.claimed;
+        this.claimed_at = shift.claimed_at;
+        this.acknowledged = shift.acknowledged;
+        this.acknowledged_at = shift.acknowledged_at;
+        this.swap_requests = shift.swap_requests;
+        this.unavailability_requests = shift.unavailability_requests;
+    }
+}

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

@@ -0,0 +1,17 @@
+import { ApiTerminalLocation, ApiTerminal } from '../interfaces/index.js';
+export declare class Terminal {
+    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;
+    secret: string | null;
+    constructor(terminal: ApiTerminal);
+}

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

@@ -0,0 +1,17 @@
+export class Terminal {
+    constructor(terminal) {
+        this.id = terminal.id;
+        this.deleted = terminal.deleted;
+        this.name = terminal.name;
+        this.active = terminal.active;
+        this.platform = terminal.platform;
+        this.device = terminal.device;
+        this.version = terminal.version;
+        this.ip = terminal.ip;
+        this.location = terminal.location;
+        this.timezone = terminal.timezone;
+        this.require_photo = terminal.require_photo;
+        this.require_photo_breaks = terminal.require_photo_breaks;
+        this.secret = terminal.secret;
+    }
+}

package/dist/mjs/models/toil-accrual.model.d.ts

@@ -0,0 +1,16 @@
+import { ApiToilAccrual } from '../interfaces/toil-accrual.interface';
+export declare class ToilAccrual {
+    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;
+    constructor(accrual: ApiToilAccrual);
+}

package/dist/mjs/models/toil-accrual.model.js

@@ -0,0 +1,16 @@
+export class ToilAccrual {
+    constructor(accrual) {
+        this.comments = accrual.comments;
+        this.created_at = accrual.created_at;
+        this.created_by = accrual.created_by;
+        this.date = accrual.date;
+        this.deleted = accrual.deleted;
+        this.deleted_at = accrual.deleted_at;
+        this.deleted_by = accrual.deleted_by;
+        this.duration_hours = accrual.duration_hours;
+        this.id = accrual.id;
+        this.leave_year = accrual.leave_year;
+        this.location_id = accrual.location_id;
+        this.user_id = accrual.user_id;
+    }
+}

package/dist/mjs/models/toil-allowance.model.d.ts

@@ -0,0 +1,9 @@
+import { ApiToilAllowance } from '../interfaces/toil-allowance.interface';
+export declare class ToilAllowance {
+    user: number;
+    accrued_hours: number;
+    remaining_hours: number;
+    used_hours: number;
+    has_toil_records: boolean;
+    constructor(allowance: ApiToilAllowance);
+}

package/dist/mjs/models/toil-allowance.model.js

@@ -0,0 +1,9 @@
+export class ToilAllowance {
+    constructor(allowance) {
+        this.user = allowance.user;
+        this.accrued_hours = allowance.accrued_hours;
+        this.remaining_hours = allowance.remaining_hours;
+        this.used_hours = allowance.used_hours;
+        this.has_toil_records = allowance.has_toil_records;
+    }
+}

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

@@ -0,0 +1,63 @@
+import { ApiUser } from '../interfaces/user.interface.js';
+export interface LeaveRates {
+    [leave_type_id: string]: number;
+}
+export interface RolePayCodes {
+    [role_id: string]: string;
+}
+export interface RoleRates {
+    [role_id: string]: {
+        per_hour: number;
+        per_shift: number;
+    };
+}
+export interface Preferences {
+    setup_steps_hidden: boolean;
+}
+export interface TeamProperties {
+    admin?: boolean;
+    features?: string[];
+    permissions?: string[];
+    product_updates_access_key?: string;
+    product_updates_access_secret?: string;
+    intercom?: any;
+    [other_properties: string]: any;
+}
+export declare class User {
+    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: LeaveRates;
+    leave_rates: RoleRates;
+    leave_rates_unit: string;
+    leave_rates_type: string;
+    notes: string | null;
+    constructor(user: ApiUser);
+}

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

@@ -0,0 +1,40 @@
+// Models should be an abstraction over Api Models/Responses
+export class User {
+    constructor(user) {
+        this.id = user.id;
+        this.created_at = user.created_at;
+        this.created_by = user.created_by;
+        this.deleted = user.deleted;
+        this.deleted_at = user.deleted_at;
+        this.deleted_by = user.deleted_by;
+        this.level = user.level;
+        this.first_name = user.first_name;
+        this.middle_name = user.middle_name;
+        this.last_name = user.last_name;
+        this.preferred_name = user.preferred_name;
+        this.photo = user.photo;
+        this.two_factor_enabled = user.two_factor_enabled;
+        this.email = user.email;
+        this.has_account = user.has_account;
+        this.invite_sent = user.invite_sent;
+        this.group = user.group;
+        this.locations = user.locations;
+        this.roles = user.roles;
+        this.default_role = user.default_role;
+        this.dob = user.dob;
+        this.start_date = user.start_date;
+        this.final_working_date = user.final_working_date;
+        this.weekly_hours = user.weekly_hours;
+        this.holiday_allowance = user.holiday_allowance;
+        this.holiday_allowance_unit = user.holiday_allowance_unit;
+        this.payroll_id = user.payroll_id;
+        this.salary = user.salary;
+        this.salary_type = user.salary_type;
+        this.overtime_rate = user.overtime_rate;
+        this.role_rates = user.role_rates;
+        this.leave_rates = user.leave_rates;
+        this.leave_rates_unit = user.leave_rates_unit;
+        this.leave_rates_type = user.leave_rates_type;
+        this.notes = user.notes;
+    }
+}

package/dist/mjs/models/users-clocked-in.model.d.ts

@@ -0,0 +1,14 @@
+import { ApiUserClockedIn, ApiShift, ApiTerminalLocation } from '../interfaces/index.js';
+export declare class UserClockedIn {
+    user: number;
+    location: unknown;
+    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;
+    constructor(apiUserClockedIn: ApiUserClockedIn);
+}

package/dist/mjs/models/users-clocked-in.model.js

@@ -0,0 +1,14 @@
+export class UserClockedIn {
+    constructor(apiUserClockedIn) {
+        this.user = apiUserClockedIn.user;
+        this.location = apiUserClockedIn.location;
+        this.role = apiUserClockedIn.role;
+        this.in_time = apiUserClockedIn.in_time;
+        this.minutes_late = apiUserClockedIn.minutes_late;
+        this.shift = apiUserClockedIn.shift;
+        this.in_method = apiUserClockedIn.in_method;
+        this.in_location = apiUserClockedIn.in_location;
+        this.in_device = apiUserClockedIn.in_device ?? null;
+        this.in_terminal = apiUserClockedIn.in_terminal ?? null;
+    }
+}