rotacloud 1.5.2 → 2.0.1

package/dist/cjs/services/users.service.d.ts

@@ -1,51 +0,0 @@
-import { AxiosResponse } from 'axios';
-import { User } from '../interfaces/index.js';
-import { Service, Options, RequirementsOf, OptionsExtended } from './index.js';
-import { UsersQueryParams } from '../interfaces/query-params/users-query-params.interface.js';
-type RequiredProps = 'first_name' | 'last_name';
-export declare class UsersService extends Service<User> {
-    private apiPath;
-    create(data: RequirementsOf<User, RequiredProps>): Promise<User>;
-    create(data: RequirementsOf<User, RequiredProps>, options: {
-        rawResponse: true;
-    } & Options): Promise<AxiosResponse<User>>;
-    create(data: RequirementsOf<User, RequiredProps>, options: Options): Promise<User>;
-    get(id: number): Promise<User>;
-    get<F extends keyof User>(id: number, options: {
-        fields: F[];
-        rawResponse: true;
-    } & OptionsExtended<User>): Promise<AxiosResponse<Pick<User, F>>>;
-    get<F extends keyof User>(id: number, options: {
-        fields: F[];
-    } & OptionsExtended<User>): Promise<Pick<User, F>>;
-    get(id: number, options: {
-        rawResponse: true;
-    } & Options): Promise<AxiosResponse<User>>;
-    get(id: number, options?: OptionsExtended<User>): Promise<User>;
-    list(query?: UsersQueryParams): AsyncGenerator<User>;
-    list<F extends keyof User>(query: UsersQueryParams, options: {
-        fields: F[];
-    } & OptionsExtended<User>): AsyncGenerator<Pick<User, F>>;
-    list(query?: UsersQueryParams, options?: OptionsExtended<User>): AsyncGenerator<User>;
-    listAll(query?: UsersQueryParams): Promise<User[]>;
-    listAll<F extends keyof User>(query: UsersQueryParams, options: {
-        fields: F[];
-    } & OptionsExtended<User>): Promise<Pick<User, F>[]>;
-    listAll(query?: UsersQueryParams, options?: OptionsExtended<User>): Promise<User[]>;
-    listByPage(query?: UsersQueryParams): AsyncGenerator<AxiosResponse<User[]>>;
-    listByPage<F extends keyof User>(query: UsersQueryParams, options: {
-        fields: F[];
-    } & OptionsExtended<User>): AsyncGenerator<AxiosResponse<Pick<User, F>[]>>;
-    listByPage(query?: UsersQueryParams, options?: OptionsExtended<User>): AsyncGenerator<AxiosResponse<User[]>>;
-    update(id: number, data: Partial<User>): Promise<User>;
-    update(id: number, data: Partial<User>, options: {
-        rawResponse: true;
-    } & Options): Promise<AxiosResponse<User, any>>;
-    update(id: number, data: Partial<User>, options: Options): Promise<User>;
-    delete(id: number): Promise<number>;
-    delete(id: number, options: {
-        rawResponse: true;
-    } & Options): Promise<AxiosResponse<void>>;
-    delete(id: number, options: Options): Promise<number>;
-}
-export {};

package/dist/cjs/services/users.service.js

@@ -1,102 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __asyncValues = (this && this.__asyncValues) || function (o) {
-    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
-    var m = o[Symbol.asyncIterator], i;
-    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
-    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
-    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
-};
-var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
-var __asyncDelegator = (this && this.__asyncDelegator) || function (o) {
-    var i, p;
-    return i = {}, verb("next"), verb("throw", function (e) { throw e; }), verb("return"), i[Symbol.iterator] = function () { return this; }, i;
-    function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: false } : f ? f(v) : v; } : f; }
-};
-var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
-    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
-    var g = generator.apply(thisArg, _arguments || []), i, q = [];
-    return i = {}, verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
-    function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
-    function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
-    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
-    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
-    function fulfill(value) { resume("next", value); }
-    function reject(value) { resume("throw", value); }
-    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UsersService = void 0;
-const index_js_1 = require("./index.js");
-class UsersService extends index_js_1.Service {
-    constructor() {
-        super(...arguments);
-        this.apiPath = '/users';
-    }
-    create(data, options) {
-        return super
-            .fetch({ url: this.apiPath, data, method: 'POST' }, options)
-            .then((res) => ((options === null || options === void 0 ? void 0 : options.rawResponse) ? res : res.data));
-    }
-    get(id, options) {
-        return super
-            .fetch({ url: `${this.apiPath}/${id}` }, options)
-            .then((res) => ((options === null || options === void 0 ? void 0 : options.rawResponse) ? res : res.data));
-    }
-    list(query, options) {
-        const _super = Object.create(null, {
-            iterator: { get: () => super.iterator }
-        });
-        return __asyncGenerator(this, arguments, function* list_1() {
-            yield __await(yield* __asyncDelegator(__asyncValues(_super.iterator.call(this, { url: this.apiPath, params: query }, options))));
-        });
-    }
-    listAll(query, options) {
-        var _a, e_1, _b, _c;
-        return __awaiter(this, void 0, void 0, function* () {
-            const users = [];
-            try {
-                for (var _d = true, _e = __asyncValues(this.list(query, options)), _f; _f = yield _e.next(), _a = _f.done, !_a; _d = true) {
-                    _c = _f.value;
-                    _d = false;
-                    const user = _c;
-                    users.push(user);
-                }
-            }
-            catch (e_1_1) { e_1 = { error: e_1_1 }; }
-            finally {
-                try {
-                    if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
-                }
-                finally { if (e_1) throw e_1.error; }
-            }
-            return users;
-        });
-    }
-    listByPage(query, options) {
-        return super.iterator({ url: this.apiPath, params: query }, options).byPage();
-    }
-    update(id, data, options) {
-        return super
-            .fetch({
-            url: `${this.apiPath}/${id}`,
-            data,
-            method: 'POST',
-        }, options)
-            .then((res) => ((options === null || options === void 0 ? void 0 : options.rawResponse) ? res : res.data));
-    }
-    delete(id, options) {
-        return super
-            .fetch({ url: `${this.apiPath}/${id}`, method: 'DELETE' }, options)
-            .then((res) => ((options === null || options === void 0 ? void 0 : options.rawResponse) ? res : res.status));
-    }
-}
-exports.UsersService = UsersService;

package/dist/cjs/version.d.ts

@@ -1,3 +0,0 @@
-export declare const Version: {
-    version: string;
-};

package/dist/cjs/version.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Version = void 0;
-exports.Version = { version: '1.5.2' };

package/dist/mjs/interfaces/account-service.interface.d.ts

@@ -1,6 +0,0 @@
-export interface AccountService {
-    active: boolean;
-    billed: boolean;
-    hidden: boolean;
-    trial_expires?: string;
-}

package/dist/mjs/interfaces/account-services.interface.d.ts

@@ -1,6 +0,0 @@
-import { AccountService } from './index.js';
-export interface AccountServices {
-    time_attendance: AccountService;
-    sms: AccountService;
-    pro: AccountService;
-}

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

@@ -1,40 +0,0 @@
-import { AccountServices } from './index.js';
-export interface Account {
-    id: number;
-    name: string;
-    level: string;
-    created: number;
-    expired: boolean;
-    owner: number;
-    timezone: number;
-    industry: number;
-    phone: string | null;
-    address_1: string | null;
-    address_2: string | null;
-    city: string | null;
-    county: string | null;
-    postcode: string | null;
-    country: number;
-    services: AccountServices[];
-    total_price: number;
-    pricing: object;
-    expires_in: number;
-    features_disabled: string[];
-    first_billed: string | null;
-    owed: number;
-    trial: boolean;
-    can_restart_trial: boolean;
-    next_billed: string;
-    hide_billing: boolean;
-    total_employees: number;
-    payment_card: string | null;
-    billing_type: string;
-    billing_term: string;
-    billing_email: string | null;
-    billing_address: string | null;
-    grouped_billing_parent: number | null;
-    grouped_billing_children: number[] | null;
-    vat_number: string | null;
-    suspended: boolean;
-    suspended_message: string | null;
-}

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

@@ -1,31 +0,0 @@
-import { Shift } from './index.js';
-export interface AttendanceLocation {
-    lat: number;
-    lng: number;
-    accuracy: number;
-}
-export interface 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: Shift | null;
-    in_method: string;
-    out_method: string;
-    in_location: AttendanceLocation;
-    out_location: AttendanceLocation;
-    in_device: number;
-    out_device: number;
-    in_terminal: null;
-    out_terminal: null;
-}

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

@@ -1,8 +0,0 @@
-export interface AuthAccount {
-    id: number;
-    name: string;
-}
-export interface Auth {
-    two_factor_enabled: boolean;
-    accounts: AuthAccount[];
-}

package/dist/mjs/interfaces/availability-pattern.interface.d.ts

@@ -1,20 +0,0 @@
-import { AvailabilityPeriod } from './index.js';
-export interface AvailabilityPatternAvailability {
-    available: AvailabilityPeriod[];
-    unavailable: AvailabilityPeriod[];
-}
-export interface ApiAvailabilityPattern {
-    id: number;
-    user: number;
-    name: string;
-    start_date: string;
-    end_date: string;
-    repeat_weeks: number;
-    mon: AvailabilityPatternAvailability;
-    tue: AvailabilityPatternAvailability;
-    wed: AvailabilityPatternAvailability;
-    thu: AvailabilityPatternAvailability;
-    fri: AvailabilityPatternAvailability;
-    sat: AvailabilityPatternAvailability;
-    sun: AvailabilityPatternAvailability;
-}

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

@@ -1,13 +0,0 @@
-export interface AvailabilityPeriod {
-    start_time: string;
-    end_time: string;
-}
-export interface AvailabilityDate {
-    date: string;
-    available: AvailabilityPeriod[];
-    unavailable: AvailabilityPeriod[];
-}
-export interface Availability {
-    user: number;
-    dates: AvailabilityDate[];
-}

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

@@ -1,6 +0,0 @@
-export interface DailyBudgets {
-    date: string;
-    location: number;
-    hours_budget: number;
-    salary_budget: number;
-}

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

@@ -1,7 +0,0 @@
-export interface DailyRevenue {
-    date: string;
-    location: number;
-    labour_percentage: number | null;
-    revenue_target: number | null;
-    revenue_actual: number | null;
-}

package/dist/mjs/interfaces/day-note.interface.d.ts

@@ -1,9 +0,0 @@
-export interface DayNote {
-    id: number;
-    start_date: string;
-    end_date: string;
-    locations: number[];
-    title: string;
-    message: string;
-    visible_employees: boolean;
-}

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

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

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

@@ -1,8 +0,0 @@
-export interface DayOff {
-    date: string;
-    day_off: boolean;
-}
-export interface DaysOff {
-    user: number;
-    dates: DayOff[];
-}

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

@@ -1,36 +0,0 @@
-export interface Document {
-    id: number;
-    account_id: number;
-    name: string;
-    user: number;
-    users: number[];
-    folder_id: number | null;
-    expires: number | null;
-    public: boolean;
-    created_at: number;
-    created_by: number | null;
-    deleted: boolean;
-    deleted_at: number | null;
-    deleted_by: number | null;
-    size_kb: number;
-    extension: string;
-    bucket: string;
-    key: string;
-    requires_acknowledgement: boolean;
-    shared: boolean;
-    acknowledgements: {
-        id: number;
-        accountId: number;
-        user: number;
-        /** Date in ISO 8601 format  */
-        acknowledged_at: string;
-    }[];
-    requires_signing: boolean;
-    signature: {
-        signature: string;
-        /** Date in ISO 8601 format  */
-        signed_at: string;
-        /** IPv4 address */
-        ip: string;
-    } | null;
-}

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

@@ -1,13 +0,0 @@
-export type RequestStatus = 'expired' | 'shift_changed' | 'approved' | 'denied' | 'requested';
-export interface ShiftDropRequest {
-    id: number;
-    deleted: boolean;
-    status: RequestStatus;
-    requested_at: number;
-    shift: number;
-    user: number;
-    user_message: string;
-    admin?: number;
-    admin_message?: string;
-    replied_at?: number;
-}

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

@@ -1,7 +0,0 @@
-export interface Group {
-    id: number;
-    name: string;
-    users: number[];
-    deleted: boolean;
-    order: number;
-}

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

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

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

@@ -1,39 +0,0 @@
-export * from './account-service.interface.js';
-export * from './account-services.interface.js';
-export * from './account.interface.js';
-export * from './attendance.interface.js';
-export * from './auth.interface.js';
-export * from './availability-pattern.interface.js';
-export * from './availability.interface.js';
-export * from './daily-budgets.interface.js';
-export * from './daily-revenue.interface.js';
-export * from './days-off.interface.js';
-export * from './days-off-pattern.interface.js';
-export * from './day-note.interface.js';
-export * from './group.interface.js';
-export * from './holiday_allowance.interface.js';
-export * from './leave-date.interface.js';
-export * from './leave-embargo.interface.js';
-export * from './leave-rate.interface.js';
-export * from './leave-request.interface.js';
-export * from './leave-type.interface.js';
-export * from './leave.interface.js';
-export * from './location-coordinate.interface.js';
-export * from './location.interface.js';
-export * from './logbook-category.interface.js';
-export * from './logbook-event.interface.js';
-export * from './pay-period.interface.js';
-export * from './pin.interface.js';
-export * from './role-rate.interface.js';
-export * from './role.interface.js';
-export * from './sdk-config.interface.js';
-export * from './settings.interface.js';
-export * from './shift.interface.js';
-export * from './terminal.interface.js';
-export * from './time-zone.interface.js';
-export * from './toil-accrual.interface.js';
-export * from './toil-allowance.interface.js';
-export * from './user.interface.js';
-export * from './users-clocked-in.interface.js';
-export * from './users-clocked-out.interface.js';
-export * from './document.interface.js';

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

@@ -1,8 +0,0 @@
-export interface LeaveDate {
-    date: string;
-    year: number;
-    days: number;
-    hours: number | null;
-    day_off: boolean;
-    id?: number;
-}

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

@@ -1,10 +0,0 @@
-export interface LeaveEmbargo {
-    id: number;
-    start_date: string;
-    start_am_pm: string;
-    end_date: string;
-    end_am_pm: string;
-    everyone: boolean;
-    users: number[];
-    message: string;
-}

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

@@ -1,3 +0,0 @@
-export interface LeaveRate {
-    [key: string]: number;
-}

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

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

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

@@ -1,8 +0,0 @@
-import { LeaveRequest } from './leave-request.interface';
-export interface Leave extends LeaveRequest {
-    admin: number;
-    admin_message: string | null;
-    replied_at: number;
-    requested: boolean;
-    users?: number[];
-}

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

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

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

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

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

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

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

@@ -1,16 +0,0 @@
-export interface LogbookEvent {
-    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/pay-period.interface.d.ts

@@ -1,16 +0,0 @@
-export interface PayPeriod {
-    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/pin.interface.d.ts

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

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

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

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

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

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

@@ -1,12 +0,0 @@
-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/common-shift-times-query-params.interface.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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