rotacloud 1.0.53 → 1.0.55

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

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

package/dist/mjs/interfaces/query-params/groups-query-params.interface.d.ts

@@ -1,3 +0,0 @@
-export interface GroupsQueryParams {
-    order?: string;
-}

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

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

package/dist/mjs/interfaces/query-params/index.d.ts

@@ -1,27 +0,0 @@
-export * from './attendance-query-params.interface.js';
-export * from './availability-patterns-query-params.interface.js';
-export * from './availability-query-params.interface.js';
-export * from './common-shift-times-query-params.interface.js';
-export * from './daily-budgets-query-params.interface.js';
-export * from './daily-revenue-query-params.interface.js';
-export * from './day-notes-query-params.interface.js';
-export * from './days-off-patterns-query-params.interface.js';
-export * from './days-off-query-params.interface.js';
-export * from './documents-query-params.interface.js';
-export * from './groups-query-params.interface.js';
-export * from './internal-query-params.interface.js';
-export * from './leave-embargoes-query-params.interface.js';
-export * from './leave-query-params.interface.js';
-export * from './leave-requests-query-params.interface.js';
-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';
-export * from './toil-accruals-query-params.interface.js';
-export * from './toil-allowance-query-params.interface.js';
-export * from './unavailability-requests-query-params.interface.js';
-export * from './users-query-params.interface.js';

package/dist/mjs/interfaces/query-params/index.js

@@ -1,27 +0,0 @@
-export * from './attendance-query-params.interface.js';
-export * from './availability-patterns-query-params.interface.js';
-export * from './availability-query-params.interface.js';
-export * from './common-shift-times-query-params.interface.js';
-export * from './daily-budgets-query-params.interface.js';
-export * from './daily-revenue-query-params.interface.js';
-export * from './day-notes-query-params.interface.js';
-export * from './days-off-patterns-query-params.interface.js';
-export * from './days-off-query-params.interface.js';
-export * from './documents-query-params.interface.js';
-export * from './groups-query-params.interface.js';
-export * from './internal-query-params.interface.js';
-export * from './leave-embargoes-query-params.interface.js';
-export * from './leave-query-params.interface.js';
-export * from './leave-requests-query-params.interface.js';
-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';
-export * from './toil-accruals-query-params.interface.js';
-export * from './toil-allowance-query-params.interface.js';
-export * from './unavailability-requests-query-params.interface.js';
-export * from './users-query-params.interface.js';

package/dist/mjs/interfaces/query-params/internal-query-params.interface.d.ts

@@ -1,5 +0,0 @@
-export interface InternalQueryParams {
-    expand?: string[];
-    fields?: string[];
-    limit?: number;
-}

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

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

package/dist/mjs/interfaces/query-params/leave-embargoes-query-params.interface.d.ts

@@ -1,5 +0,0 @@
-export interface LeaveEmbargoesQueryParams {
-    start?: string;
-    end?: string;
-    users?: number[];
-}

package/dist/mjs/interfaces/query-params/leave-embargoes-query-params.interface.js

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

package/dist/mjs/interfaces/query-params/leave-query-params.interface.d.ts

@@ -1,13 +0,0 @@
-export interface LeaveQueryParams {
-    start?: string;
-    end?: string;
-    year?: number;
-    users?: number[];
-    types?: number[];
-    order?: string;
-    only_managed?: boolean;
-    include_deleted?: boolean;
-    include_denied?: boolean;
-    include_requested?: boolean;
-    include_expired?: boolean;
-}

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

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

package/dist/mjs/interfaces/query-params/leave-requests-query-params.interface.d.ts

@@ -1,4 +0,0 @@
-export interface LeaveRequestsQueryParams {
-    status?: 'requested' | 'approved' | 'denied' | 'expired';
-    include_deleted?: boolean;
-}

package/dist/mjs/interfaces/query-params/leave-requests-query-params.interface.js

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

package/dist/mjs/interfaces/query-params/locations-query-params.interface.d.ts

@@ -1,7 +0,0 @@
-export interface LocationsQueryParams {
-    ids?: number[];
-    search?: string;
-    only_visible?: boolean;
-    only_managed?: boolean;
-    include_deleted?: boolean;
-}

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

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

package/dist/mjs/interfaces/query-params/logbook-events-query-params.interface.d.ts

@@ -1,3 +0,0 @@
-export interface LogbookEventsQueryParams {
-    user?: number;
-}

package/dist/mjs/interfaces/query-params/logbook-events-query-params.interface.js

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

package/dist/mjs/interfaces/query-params/pay-periods-query-params.interface.d.ts

@@ -1,4 +0,0 @@
-export interface PayPeriodsQueryParams {
-    start?: string;
-    end?: string;
-}

package/dist/mjs/interfaces/query-params/pay-periods-query-params.interface.js

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

package/dist/mjs/interfaces/query-params/roles-query-params.interface.d.ts

@@ -1,5 +0,0 @@
-export interface RolesQueryParams {
-    ids?: number[];
-    search?: string;
-    include_deleted?: boolean;
-}

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

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

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

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

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

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

package/dist/mjs/interfaces/query-params/shifts-query-params.interface.d.ts

@@ -1,14 +0,0 @@
-export interface ShiftsQueryParams {
-    start: number;
-    end: number;
-    ids?: number[];
-    users?: number[];
-    locations?: number[];
-    roles?: number[];
-    open?: boolean;
-    published?: boolean;
-    acknowledged?: boolean;
-    deleted?: boolean;
-    sort?: string;
-    include_deleted?: boolean;
-}

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

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

package/dist/mjs/interfaces/query-params/swap-requests-query-params.interface.d.ts

@@ -1,8 +0,0 @@
-export interface SwapRequestsQueryParams {
-    status?: string;
-    start?: number;
-    end?: number;
-    old_user?: number;
-    new_user?: number;
-    include_deleted?: boolean;
-}

package/dist/mjs/interfaces/query-params/swap-requests-query-params.interface.js

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

package/dist/mjs/interfaces/query-params/terminals-query-params.interface.d.ts

@@ -1,3 +0,0 @@
-export interface TerminalsQueryParams {
-    include_deleted?: boolean;
-}

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

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

package/dist/mjs/interfaces/query-params/toil-accruals-query-params.interface.d.ts

@@ -1,4 +0,0 @@
-export interface ToilAccrualsQueryParams {
-    year?: number;
-    users?: number[];
-}

package/dist/mjs/interfaces/query-params/toil-accruals-query-params.interface.js

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

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

@@ -1,3 +0,0 @@
-export interface ToilAllowanceQueryParams {
-    users?: number[];
-}

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

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

package/dist/mjs/interfaces/query-params/unavailability-requests-query-params.interface.d.ts

@@ -1,8 +0,0 @@
-export interface UnavailabilityRequestsQueryParams {
-    status?: string;
-    start?: number;
-    end?: number;
-    shift_start?: number;
-    shift_end?: number;
-    include_deleted?: boolean;
-}

package/dist/mjs/interfaces/query-params/unavailability-requests-query-params.interface.js

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

package/dist/mjs/interfaces/query-params/users-query-params.interface.d.ts

@@ -1,24 +0,0 @@
-export interface UsersQueryParams {
-    ids?: number[];
-    locations?: number[];
-    /**
-     * Works different from {UserQueryParams.locations},
-     * When filtering out employees for rota, this is more suggested,
-     * one scenario would be filtering out employees base on their starting and
-     * final working date, using {UserQueryParams.locations} will not work in tandem
-     * of {UserQueryParams.start_date} and {UserQueryParams.end_date}
-     */
-    location?: number;
-    roles?: number[];
-    only_managed?: boolean;
-    include_self?: boolean;
-    level?: string;
-    search?: string;
-    order?: string;
-    period?: string;
-    start_time?: number;
-    end_time?: number;
-    start_date?: string;
-    end_date?: string;
-    include_deleted?: boolean;
-}

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

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

package/dist/mjs/interfaces/role-rate.interface.d.ts

@@ -1,6 +0,0 @@
-export interface ApiRoleRate {
-    [key: string]: {
-        per_hour: number;
-        per_shift: number;
-    };
-}

package/dist/mjs/interfaces/role-rate.interface.js

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

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

@@ -1,9 +0,0 @@
-export interface ApiRole {
-    id: number;
-    deleted: boolean;
-    name: string;
-    colour: string;
-    default_break: number;
-    users: number[];
-    pay_code: string;
-}

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

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

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

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

package/dist/mjs/interfaces/sdk-config.interface.js

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

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

@@ -1,64 +0,0 @@
-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

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

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

@@ -1,25 +0,0 @@
-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

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

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

@@ -1,20 +0,0 @@
-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;
-}
-export interface ApiTerminalLocation {
-    lat: number;
-    lng: number;
-    accuracy: number;
-}

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

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

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

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

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

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

@@ -1,7 +0,0 @@
-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

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

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

@@ -1,45 +0,0 @@
-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

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

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

@@ -1,13 +0,0 @@
-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

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

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

@@ -1,26 +0,0 @@
-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

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

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

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

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

@@ -1,8 +0,0 @@
-import { ApiAccount } from '../interfaces/index.js';
-export declare class Account {
-    id: number;
-    name: string;
-    level: string;
-    created: number;
-    constructor(account: ApiAccount);
-}

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

@@ -1,8 +0,0 @@
-export class Account {
-    constructor(account) {
-        this.id = account.id;
-        this.name = account.name;
-        this.level = account.level;
-        this.created = account.created;
-    }
-}

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

@@ -1,27 +0,0 @@
-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);
-}