rotacloud 1.0.6 → 1.0.9

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/{models → mjs/models}/group.model.js

@@ -2,5 +2,6 @@ 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.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/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,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/{models → mjs/models}/location.model.js

@@ -4,5 +4,6 @@ export class Location {
     constructor(locaiton) {
         this.id = locaiton.id;
         this.name = locaiton.name;
+        this.users = locaiton.users;
     }
 }

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/{models → mjs/models}/role.model.js

@@ -2,5 +2,6 @@ export class Role {
     constructor(role) {
         this.id = role.id;
         this.name = role.name;
+        this.users = role.users;
     }
 }

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

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

@@ -0,0 +1,24 @@
+import { ApiShift } from '../interfaces/index.js';
+export declare class Shift {
+    id: number;
+    deleted: boolean;
+    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;
+    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/terminal.model.d.ts

@@ -0,0 +1,19 @@
+export declare class LatLngObject {
+    lat: number;
+    lng: number;
+    radius: number;
+}
+export declare class Terminal {
+    id: number;
+    deleted: boolean;
+    name: string;
+    active: boolean;
+    type: string;
+    device: string;
+    version: string;
+    ip: string;
+    location: LatLngObject;
+    timezone: number;
+    require_photo: boolean;
+    require_photo_breaks: boolean;
+}

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

@@ -0,0 +1,33 @@
+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;
+    first_name: string;
+    last_name: string;
+    photo: string | null;
+    preferred_name: string | null;
+    constructor(user: ApiUser);
+}

package/dist/mjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "module"
+}

package/dist/mjs/rotacloud.d.ts

@@ -0,0 +1,20 @@
+import { AccountsService, AttendanceService, DaysOffService, GroupsService, LeaveEmbargoesService, LeaveRequestService, LeaveService, LocationsService, RolesService, ShiftsService, UsersService } from './services/index.js';
+import { SDKConfig } from './interfaces/index.js';
+export declare class RotaCloud {
+    static config: SDKConfig;
+    defaultAPIURI: string;
+    accounts: AccountsService;
+    attendance: AttendanceService;
+    daysOff: DaysOffService;
+    group: GroupsService;
+    leaveEmbargoes: LeaveEmbargoesService;
+    leaveRequests: LeaveRequestService;
+    leave: LeaveService;
+    locations: LocationsService;
+    roles: RolesService;
+    shifts: ShiftsService;
+    users: UsersService;
+    constructor(config: SDKConfig);
+    get config(): SDKConfig;
+    set config(configVal: SDKConfig);
+}

package/dist/{rotacloud.js → mjs/rotacloud.js}

@@ -1,11 +1,11 @@
-import { AccountsService, AttendanceService, LeaveEmbargoesService, LeaveRequestService, LeaveService, LocationsService, RolesService, ShiftsService, UsersService, } from './services/index.js';
-import { DaysOffService } from './services/days-off.service.js';
+import { AccountsService, AttendanceService, DaysOffService, GroupsService, LeaveEmbargoesService, LeaveRequestService, LeaveService, LocationsService, RolesService, ShiftsService, UsersService, } from './services/index.js';
 export class RotaCloud {
     constructor(config) {
         this.defaultAPIURI = 'https://api.rotacloud.com/v1';
         this.accounts = new AccountsService();
         this.attendance = new AttendanceService();
         this.daysOff = new DaysOffService();
+        this.group = new GroupsService();
         this.leaveEmbargoes = new LeaveEmbargoesService();
         this.leaveRequests = new LeaveRequestService();
         this.leave = new LeaveService();

package/dist/mjs/services/accounts.service.d.ts

@@ -0,0 +1,10 @@
+import { Account } from '../models/account.model.js';
+import { Service, Options } from './index.js';
+import { ApiAccount } from '../interfaces/index.js';
+import { InternalQueryParams } from '../interfaces/query-params/internal-query-params.inteface.js';
+declare class AccountsService extends Service {
+    private apiPath;
+    list(options?: Options<InternalQueryParams>): AsyncGenerator<Account, void, unknown>;
+    listByPage(options?: Options<InternalQueryParams>): AsyncGenerator<import("axios").AxiosResponse<ApiAccount[], any>, any, unknown>;
+}
+export { AccountsService };

package/dist/{services → mjs/services}/accounts.service.js

@@ -2,7 +2,7 @@ import { Account } from '../models/account.model.js';
 import { Service } from './index.js';
 class AccountsService extends Service {
     constructor() {
-        super();
+        super(...arguments);
         this.apiPath = '/accounts';
     }
     async *list(options) {

package/dist/mjs/services/attendance.service.d.ts

@@ -0,0 +1,37 @@
+import { AxiosResponse } from 'axios';
+import { ApiAttendance } from '../interfaces/index.js';
+import { Service, Options, RequirementsOf } from './index.js';
+import { Attendance } from '../models/attendance.model.js';
+import { AttendanceQueryParams } from '../interfaces/query-params/attendance-query-params.interface.js';
+import { InternalQueryParams } from '../interfaces/query-params/internal-query-params.inteface.js';
+declare type RequiredProps = 'user' | 'in_time';
+declare class AttendanceService extends Service {
+    private apiPath;
+    create(data: RequirementsOf<ApiAttendance, RequiredProps>): Promise<Attendance>;
+    create(data: RequirementsOf<ApiAttendance, RequiredProps>, options: {
+        rawResponse: true;
+        params?: InternalQueryParams;
+    }): Promise<AxiosResponse<ApiAttendance, any>>;
+    create(data: RequirementsOf<ApiAttendance, RequiredProps>, options: Options<InternalQueryParams>): Promise<ApiAttendance>;
+    get(id: number): Promise<Attendance>;
+    get(id: number, options: {
+        rawResponse: true;
+        params?: InternalQueryParams;
+    }): Promise<AxiosResponse<ApiAttendance, any>>;
+    get(id: number, options: Options<InternalQueryParams>): Promise<ApiAttendance>;
+    list(options?: Options<AttendanceQueryParams & InternalQueryParams>): AsyncGenerator<Attendance, void, unknown>;
+    listByPage(options?: Options<AttendanceQueryParams & InternalQueryParams>): AsyncGenerator<AxiosResponse<ApiAttendance[], any>, any, unknown>;
+    update(id: number, data: Partial<ApiAttendance>): Promise<Attendance>;
+    update(id: number, data: Partial<ApiAttendance>, options: {
+        rawResponse: true;
+        params?: InternalQueryParams;
+    }): Promise<AxiosResponse<ApiAttendance, any>>;
+    update(id: number, data: Partial<ApiAttendance>, options: Options<InternalQueryParams>): Promise<Attendance>;
+    delete(id: number): Promise<number>;
+    delete(id: number, options: {
+        rawResponse: true;
+        params?: InternalQueryParams;
+    }): Promise<AxiosResponse<ApiAttendance, any>>;
+    delete(id: number, options: Options<InternalQueryParams>): Promise<number>;
+}
+export { AttendanceService };

package/dist/{services → mjs/services}/attendance.service.js

@@ -3,7 +3,7 @@ import { Attendance } from '../models/attendance.model.js';
 import { ErrorResponse } from '../models/error-response.model.js';
 class AttendanceService extends Service {
     constructor() {
-        super();
+        super(...arguments);
         this.apiPath = '/attendance';
     }
     create(data, options) {

package/dist/mjs/services/days-off.service.d.ts

@@ -0,0 +1,24 @@
+import { AxiosResponse } from 'axios';
+import { ApiDaysOff } from '../interfaces/index.js';
+import { Service, Options } from './index.js';
+import { InternalQueryParams } from '../interfaces/query-params/internal-query-params.inteface.js';
+import { DaysOff } from '../models/days-off.model.js';
+import { DaysOffQueryParams } from '../interfaces/query-params/days-off-query-params.interface.js';
+declare class DaysOffService extends Service<ApiDaysOff> {
+    private apiPath;
+    create(dates: string[], users: number[]): Promise<number>;
+    create(dates: string[], users: number[], options: {
+        rawResponse: true;
+        params?: InternalQueryParams;
+    }): Promise<AxiosResponse<ApiDaysOff, any>>;
+    create(dates: string[], users: number[], options: Options<InternalQueryParams>): Promise<number>;
+    list(options?: Options<DaysOffQueryParams & InternalQueryParams>): AsyncGenerator<DaysOff, void, unknown>;
+    listByPage(options?: Options<DaysOffQueryParams & InternalQueryParams>): AsyncGenerator<AxiosResponse<ApiDaysOff[], any>, any, unknown>;
+    delete(dates: string[], users: number[]): Promise<number>;
+    delete(dates: string[], users: number[], options: {
+        rawResponse: true;
+        params?: InternalQueryParams;
+    }): Promise<AxiosResponse<any, any>>;
+    delete(dates: string[], users: number[], options: Options<InternalQueryParams>): Promise<number>;
+}
+export { DaysOffService };

package/dist/mjs/services/groups.service.d.ts

@@ -0,0 +1,37 @@
+import { AxiosResponse } from 'axios';
+import { ApiGroup } from '../interfaces/index.js';
+import { Service, Options, RequirementsOf } from './index.js';
+import { InternalQueryParams } from '../interfaces/query-params/internal-query-params.inteface.js';
+import { Group } from '../models/group.model.js';
+import { GroupsQueryParams } from '../interfaces/query-params/groups-query-params.interface.js';
+declare type RequiredProps = 'name';
+declare class GroupsService extends Service {
+    private apiPath;
+    create(data: RequirementsOf<ApiGroup, RequiredProps>): Promise<Group>;
+    create(data: RequirementsOf<ApiGroup, RequiredProps>, options: {
+        rawResponse: true;
+        params?: InternalQueryParams;
+    }): Promise<AxiosResponse<ApiGroup, any>>;
+    create(data: RequirementsOf<ApiGroup, RequiredProps>, options: Options<InternalQueryParams>): Promise<Group>;
+    get(id: number): Promise<Group>;
+    get(id: number, options: {
+        rawResponse: true;
+        params?: InternalQueryParams;
+    }): Promise<AxiosResponse<ApiGroup, any>>;
+    get(id: number, options: Options<InternalQueryParams>): Promise<Group>;
+    list(options?: Options<GroupsQueryParams & InternalQueryParams>): AsyncGenerator<Group, void, unknown>;
+    listByPage(options?: Options<GroupsQueryParams & InternalQueryParams>): AsyncGenerator<AxiosResponse<ApiGroup[], any>, any, unknown>;
+    update(id: number, data: Partial<ApiGroup>): Promise<Group>;
+    update(id: number, data: Partial<ApiGroup>, options: {
+        rawResponse: true;
+        params?: InternalQueryParams;
+    }): Promise<AxiosResponse<ApiGroup, any>>;
+    update(id: number, data: Partial<ApiGroup>, options: Options<InternalQueryParams>): Promise<Group>;
+    delete(id: number): Promise<number>;
+    delete(id: number, options: {
+        rawResponse: true;
+        params?: InternalQueryParams;
+    }): Promise<AxiosResponse<any, any>>;
+    delete(id: number, options: Options<InternalQueryParams>): Promise<number>;
+}
+export { GroupsService };

package/dist/mjs/services/groups.service.js

@@ -0,0 +1,36 @@
+import { Service } from './index.js';
+import { ErrorResponse } from '../models/error-response.model.js';
+import { Group } from '../models/group.model.js';
+class GroupsService extends Service {
+    constructor() {
+        super(...arguments);
+        this.apiPath = '/groups';
+    }
+    create(data, options) {
+        return super.fetch({ url: this.apiPath, data, method: 'POST' }).then((res) => Promise.resolve(options?.rawResponse ? res : new Group(res.data)), (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err)));
+    }
+    get(id, options) {
+        return super.fetch({ url: `${this.apiPath}/${id}` }, options).then((res) => Promise.resolve(options?.rawResponse ? res : new Group(res.data)), (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err)));
+    }
+    async *list(options) {
+        for await (const res of super.iterator({ url: this.apiPath }, options)) {
+            yield new Group(res);
+        }
+    }
+    listByPage(options) {
+        return super.iterator({ url: this.apiPath }, options).byPage();
+    }
+    update(id, data, options) {
+        return super
+            .fetch({
+            url: `${this.apiPath}/${id}`,
+            data,
+            method: 'POST',
+        })
+            .then((res) => Promise.resolve(options?.rawResponse ? res : new Group(res.data)), (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err)));
+    }
+    delete(id, options) {
+        return super.fetch({ url: `${this.apiPath}/${id}`, method: 'DELETE' }).then((res) => Promise.resolve(options?.rawResponse ? res : res.status), (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err)));
+    }
+}
+export { GroupsService };

package/dist/mjs/services/index.d.ts

@@ -0,0 +1,12 @@
+export * from './service.js';
+export * from './accounts.service.js';
+export * from './attendance.service.js';
+export * from './days-off.service.js';
+export * from './groups.service.js';
+export * from './leave-request.service.js';
+export * from './leave-embargoes.service.js';
+export * from './leave.service.js';
+export * from './locations.service.js';
+export * from './roles.service.js';
+export * from './shifts.service.js';
+export * from './users.service.js';

package/dist/{services → mjs/services}/index.js

@@ -1,6 +1,8 @@
 export * from './service.js';
 export * from './accounts.service.js';
 export * from './attendance.service.js';
+export * from './days-off.service.js';
+export * from './groups.service.js';
 export * from './leave-request.service.js';
 export * from './leave-embargoes.service.js';
 export * from './leave.service.js';