rotacloud 1.0.8 → 1.0.9

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

@@ -0,0 +1,5 @@
+export interface LeaveRequestsQueryParams {
+    users?: number[];
+    status?: string;
+    include_deleted?: boolean;
+}

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

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

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

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

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

@@ -0,0 +1,17 @@
+export interface UsersQueryParams {
+    ids?: number[];
+    locations?: number[];
+    roles?: number[];
+    only_managed?: boolean;
+    include_self?: boolean;
+    level?: string;
+    search?: string;
+    order?: string;
+    period?: string;
+    location?: number;
+    start_time?: number;
+    end_time?: number;
+    start_date?: string;
+    end_date?: string;
+    include_deleted?: boolean;
+}

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.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/sdk-config.interface.d.ts

@@ -0,0 +1,6 @@
+export interface SDKConfig {
+    baseUri?: string;
+    apiKey: string;
+    accountId?: number;
+    userId?: number;
+}

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;
+    location: number;
+    role: number | null;
+    notes: string | null;
+    created_by: number;
+    created_at: 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/user.interface.d.ts

@@ -0,0 +1,38 @@
+import { ApiLeaveRate, ApiRoleRate } 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;
+}

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

@@ -0,0 +1,8 @@
+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/attendance.model.d.ts

@@ -0,0 +1,7 @@
+import { ApiAttendance } from '../interfaces/index.js';
+export declare class Attendance {
+    id: number;
+    approved: boolean;
+    location: number;
+    constructor(attendance: ApiAttendance);
+}

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.model.d.ts

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

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-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/day-notes.model.d.ts

@@ -0,0 +1,10 @@
+import { ApiDayNotes } from '../interfaces/index.js';
+export declare class DayNotes {
+    id: number;
+    start_date: string;
+    end_date: string;
+    locations: number[];
+    title: string;
+    message: string;
+    constructor(dayNotes: ApiDayNotes);
+}

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.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/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/error-response.model.d.ts

@@ -0,0 +1,8 @@
+import { AxiosError } from 'axios';
+export declare class ErrorResponse {
+    status: number | undefined;
+    statusText: string | undefined;
+    message: string;
+    data: any;
+    constructor(err: AxiosError<any, any>);
+}

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/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.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/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-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: null;
+    end_date: string;
+    end_am_pm: null;
+    dates: ApiLeaveDate[];
+    constructor(leaveRequest: ApiLeaveRequest);
+}

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.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;
+    };
+    hours_method: string;
+    hours_set: boolean;
+    requested_at: number;
+    replied_at: number;
+    constructor(leave: ApiLeave);
+}

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

@@ -0,0 +1,12 @@
+import { ApiLocation } from '../interfaces/index.js';
+export declare class LatLngObject {
+    lat: number;
+    lng: number;
+    radius: number;
+}
+export declare class Location {
+    id: number;
+    name: string;
+    users: number[];
+    constructor(locaiton: ApiLocation);
+}

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;
+    constructor(logbookCategory: ApiLogbookCategory);
+}

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/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/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/role.model.d.ts

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

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

@@ -0,0 +1,65 @@
+interface PayCodes {
+    [pay_code_id: string]: string | {
+        [leave_type_id: string]: string;
+    };
+}
+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;
+}
+export {};