rotacloud 1.0.55 → 1.0.56

package/dist/mjs/interfaces/leave-request.interface.d.ts

@@ -0,0 +1,13 @@
+import { ApiLeaveDate } from './leave-date.interface';
+export interface ApiLeaveRequest {
+    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[];
+}

package/dist/mjs/interfaces/leave-request.interface.js

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

package/dist/mjs/interfaces/leave-type.interface.d.ts

@@ -0,0 +1,8 @@
+export interface ApiLeaveType {
+    id: number;
+    name: string;
+    short_name: string;
+    colour: string;
+    can_request: boolean;
+    time_attendance_only: boolean;
+}

package/dist/mjs/interfaces/leave-type.interface.js

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

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

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

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

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

package/dist/mjs/interfaces/location-coordinate.interface.d.ts

@@ -0,0 +1,5 @@
+export interface ApiLocationCoordinate {
+    lat: number;
+    lng: number;
+    radius: number;
+}

package/dist/mjs/interfaces/location-coordinate.interface.js

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

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

@@ -0,0 +1,13 @@
+import { ApiLocationCoordinate } from './index.js';
+export interface ApiLocation {
+    id: number;
+    name: string;
+    deleted: boolean;
+    address: string;
+    location: ApiLocationCoordinate;
+    timezone: number;
+    users: number[];
+    managers: number[];
+    metadata: object;
+    clock_in_ips: string[];
+}

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

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

package/dist/mjs/interfaces/logbook-category.interface.d.ts

@@ -0,0 +1,5 @@
+export interface ApiLogbookCategory {
+    id: number;
+    name: string;
+    deleted?: boolean | null;
+}

package/dist/mjs/interfaces/logbook-category.interface.js

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

package/dist/mjs/interfaces/logbook-event.interface.d.ts

@@ -0,0 +1,16 @@
+export interface ApiLogbookEvent {
+    id: number;
+    created_at: number;
+    created_by: number;
+    updated_at: string;
+    updated_by: string;
+    deleted: boolean;
+    deleted_at: string;
+    deleted_by: string;
+    user: number;
+    category: number;
+    date: string;
+    time: string;
+    name: string;
+    description: string;
+}

package/dist/mjs/interfaces/logbook-event.interface.js

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

package/dist/mjs/interfaces/pay-period.interface.d.ts

@@ -0,0 +1,16 @@
+export interface ApiPayPeriod {
+    id: number;
+    start_date: string;
+    end_date: string;
+    name: string;
+    locked: boolean;
+    locked_at: number;
+    locked_by: number;
+    unlocked_at: null;
+    unlocked_by: null;
+    finalised: boolean;
+    finalised_at: number;
+    finalised_by: number;
+    unfinalised_at: null;
+    unfinalised_by: null;
+}

package/dist/mjs/interfaces/pay-period.interface.js

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

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

@@ -0,0 +1,3 @@
+import { ApiUser } from './index.js';
+export interface ApiPin extends Omit<ApiUser, 'created_at' | 'created_by' | 'deleted_at' | 'deleted_by' | 'middle_name' | 'preferred_name' | 'two_factor_enabled' | 'has_account' | 'invite_sent' | 'pin'> {
+}

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

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

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

@@ -0,0 +1,9 @@
+export interface AttendanceQueryParams {
+    start: number;
+    end: number;
+    users?: number[];
+    locations?: number[];
+    roles?: number[];
+    approved?: boolean;
+    include_deleted?: boolean;
+}

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

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

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

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

package/dist/mjs/interfaces/query-params/availability-patterns-query-params.interface.js

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

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

@@ -0,0 +1,12 @@
+export interface AvailabilityQueryParams {
+    /** Start of date range for fetching availability (ISO date format `YYYY-MM-DD`) */
+    start?: string;
+    /** End of date range for fetching availability (inclusive) (ISO date format `YYYY-MM-DD`)  */
+    end?: string;
+    /**
+     * List of user IDs to get availability for
+     *
+     * If undefined, all users on the account will be selected
+     */
+    users?: number[];
+}

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

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

package/dist/mjs/interfaces/query-params/common-shift-times-query-params.interface.d.ts

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

package/dist/mjs/interfaces/query-params/common-shift-times-query-params.interface.js

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

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

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

package/dist/mjs/interfaces/query-params/daily-budgets-query-params.interface.js

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

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

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

package/dist/mjs/interfaces/query-params/daily-revenue-query-params.interface.js

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

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

@@ -0,0 +1,5 @@
+export interface DayNotesQueryParams {
+    start: string;
+    end: string;
+    location?: number;
+}

package/dist/mjs/interfaces/query-params/day-notes-query-params.interface.js

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

package/dist/mjs/interfaces/query-params/days-off-patterns-query-params.interface.d.ts

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

package/dist/mjs/interfaces/query-params/days-off-patterns-query-params.interface.js

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

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

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

package/dist/mjs/interfaces/query-params/days-off-query-params.interface.js

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

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

@@ -0,0 +1,4 @@
+export interface DocumentsQueryParams {
+    users?: number[];
+    search?: string;
+}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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/query-params/shifts-query-params.interface.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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;
+}