rotacloud 1.4.5 → 1.4.8

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

@@ -0,0 +1,36 @@
+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/cjs/interfaces/document.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -36,3 +36,4 @@ 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/cjs/interfaces/index.js

@@ -52,3 +52,4 @@ __exportStar(require("./toil-allowance.interface.js"), exports);
 __exportStar(require("./user.interface.js"), exports);
 __exportStar(require("./users-clocked-in.interface.js"), exports);
 __exportStar(require("./users-clocked-out.interface.js"), exports);
+__exportStar(require("./document.interface.js"), exports);

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

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

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

@@ -2,7 +2,7 @@ export interface Role {
     id: number;
     deleted: boolean;
     name: string;
-    colour: string;
+    colour: string | null;
     default_break: number;
     users: number[];
     pay_code: string;

package/dist/cjs/rotacloud.d.ts

@@ -1,6 +1,7 @@
 import { AccountsService, AttendanceService, AuthService, AvailabilityService, DailyBudgetsService, DailyRevenueService, DayNotesService, DaysOffService, GroupsService, LeaveEmbargoesService, LeaveRequestService, LeaveTypesService, LeaveService, LocationsService, RolesService, SettingsService, ShiftsService, TerminalsService, TerminalsActiveService, TimeZoneService, ToilAccrualsService, ToilAllowanceService, UsersService, UsersClockInService } from './services/index.js';
 import { RetryOptions, RetryStrategy, SDKConfig } from './interfaces/index.js';
 import { PinsService } from './services/pins.service.js';
+import { DocumentsService } from './services/documents.service.js';
 export declare class RotaCloud {
     private client;
     private sdkConfig;
@@ -13,6 +14,7 @@ export declare class RotaCloud {
     dailyRevenue: DailyRevenueService;
     dayNotes: DayNotesService;
     daysOff: DaysOffService;
+    documents: DocumentsService;
     group: GroupsService;
     leaveEmbargoes: LeaveEmbargoesService;
     leaveRequests: LeaveRequestService;

package/dist/cjs/rotacloud.js

@@ -34,6 +34,7 @@ const index_js_2 = require("./interfaces/index.js");
 Object.defineProperty(exports, "RetryStrategy", { enumerable: true, get: function () { return index_js_2.RetryStrategy; } });
 const pins_service_js_1 = require("./services/pins.service.js");
 const index_js_3 = require("./models/index.js");
+const documents_service_js_1 = require("./services/documents.service.js");
 const DEFAULT_RETRIES = 3;
 const DEFAULT_RETRY_DELAY = 2000;
 const DEFAULT_RETRY_STRATEGY_OPTIONS = {
@@ -70,7 +71,7 @@ class RotaCloud {
         const options = {
             get config() {
                 return client.config;
-            }
+            },
         };
         this.accounts = new index_js_1.AccountsService(this.client, options);
         this.attendance = new index_js_1.AttendanceService(this.client, options);
@@ -80,6 +81,7 @@ class RotaCloud {
         this.dailyRevenue = new index_js_1.DailyRevenueService(this.client, options);
         this.dayNotes = new index_js_1.DayNotesService(this.client, options);
         this.daysOff = new index_js_1.DaysOffService(this.client, options);
+        this.documents = new documents_service_js_1.DocumentsService(this.client, options);
         this.group = new index_js_1.GroupsService(this.client, options);
         this.leaveEmbargoes = new index_js_1.LeaveEmbargoesService(this.client, options);
         this.leaveRequests = new index_js_1.LeaveRequestService(this.client, options);

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

@@ -0,0 +1,73 @@
+import { AxiosResponse } from 'axios';
+import { Document } from '../interfaces/index.js';
+import { Service, Options, RequirementsOf, OptionsExtended } from './index.js';
+import { DocumentsQueryParams } from '../interfaces/query-params/index.js';
+type RequiredProps = 'name' | 'bucket' | 'key';
+export declare class DocumentsService extends Service<Document> {
+    private apiPath;
+    create(data: RequirementsOf<Document, RequiredProps>): Promise<Document>;
+    create(data: RequirementsOf<Document, RequiredProps>, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<Document>>;
+    create(data: RequirementsOf<Document, RequiredProps>, options: Options): Promise<Document>;
+    get(id: number): Promise<Document>;
+    get<F extends keyof Document>(id: number, options: {
+        fields: F[];
+        rawResponse: true;
+    } & OptionsExtended<Document>): Promise<AxiosResponse<Pick<Document, F>>>;
+    get<F extends keyof Document>(id: number, options: {
+        fields: F[];
+    } & OptionsExtended<Document>): Promise<Pick<Document, F>>;
+    get(id: number, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<Document>>;
+    get(id: number, options?: OptionsExtended<Document>): Promise<Document>;
+    list(query?: DocumentsQueryParams): AsyncGenerator<Document>;
+    list<F extends keyof Document>(query: DocumentsQueryParams, options: {
+        fields: F[];
+    } & OptionsExtended<Document>): AsyncGenerator<Pick<Document, F>>;
+    list(query?: DocumentsQueryParams, options?: OptionsExtended<Document>): AsyncGenerator<Document>;
+    listAll(query?: DocumentsQueryParams): Promise<Document[]>;
+    listAll<F extends keyof Document>(query: DocumentsQueryParams, options: {
+        fields: F[];
+    } & OptionsExtended<Document>): Promise<Pick<Document, F>[]>;
+    listAll(query?: DocumentsQueryParams, options?: OptionsExtended<Document>): Promise<Document[]>;
+    listByPage(query?: DocumentsQueryParams): AsyncGenerator<AxiosResponse<Document[]>>;
+    listByPage<F extends keyof Document>(query: DocumentsQueryParams, options: {
+        fields: F[];
+    } & OptionsExtended<Document>): AsyncGenerator<AxiosResponse<Pick<Document, F>[]>>;
+    listByPage(query?: DocumentsQueryParams, options?: OptionsExtended<Document>): AsyncGenerator<AxiosResponse<Document[]>>;
+    update(document: RequirementsOf<Document, 'id'>): Promise<Document>;
+    update(document: RequirementsOf<Document, 'id'>, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<Document>>;
+    update(document: RequirementsOf<Document, 'id'>, options: Options): Promise<Document>;
+    update(documents: RequirementsOf<Document, 'id'>[]): Promise<{
+        success: Document[];
+        failed: {
+            id: number;
+            error: string;
+        }[];
+    }>;
+    update(document: RequirementsOf<Document, 'id'>, options: Options): Promise<Document>;
+    update(documents: RequirementsOf<Document, 'id'>[], options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<{
+        code: number;
+        data?: Document;
+        error?: string;
+    }[]>>;
+    update(documents: RequirementsOf<Document, 'id'>[], options: Options): Promise<{
+        success: Document[];
+        failed: {
+            id: number;
+            error: string;
+        }[];
+    }>;
+    delete(ids: number | number[]): Promise<number>;
+    delete(ids: number | number[], options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<void>>;
+    delete(ids: number | number[], options: Options): Promise<number>;
+}
+export {};

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

@@ -0,0 +1,125 @@
+"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.DocumentsService = void 0;
+const index_js_1 = require("./index.js");
+class DocumentsService extends index_js_1.Service {
+    constructor() {
+        super(...arguments);
+        this.apiPath = '/documents';
+    }
+    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 shifts = [];
+            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 shift = _c;
+                    shifts.push(shift);
+                }
+            }
+            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 shifts;
+        });
+    }
+    listByPage(query, options) {
+        return super.iterator({ url: this.apiPath, params: query }, options).byPage();
+    }
+    update(documents, options) {
+        if (!Array.isArray(documents)) {
+            return super
+                .fetch({
+                url: `${this.apiPath}/${documents.id}`,
+                data: documents,
+                method: 'POST',
+            }, options)
+                .then((res) => ((options === null || options === void 0 ? void 0 : options.rawResponse) ? res : res.data));
+        }
+        return super
+            .fetch({
+            url: this.apiPath,
+            data: documents,
+            method: 'POST',
+        }, options)
+            .then((res) => {
+            if (options === null || options === void 0 ? void 0 : options.rawResponse)
+                return res;
+            const success = [];
+            const failed = [];
+            for (let documentIdx = 0; documentIdx < res.data.length; documentIdx += 1) {
+                const { data, error } = res.data[documentIdx];
+                if (data)
+                    success.push(data);
+                if (error)
+                    failed.push({ id: documents[documentIdx].id, error });
+            }
+            return { success, failed };
+        });
+    }
+    delete(ids, options) {
+        const params = Array.isArray(ids)
+            ? { url: this.apiPath, data: { ids }, method: 'DELETE' }
+            : { url: `${this.apiPath}/${ids}`, method: 'DELETE' };
+        return super.fetch(params, options).then((res) => ((options === null || options === void 0 ? void 0 : options.rawResponse) ? res : res.status));
+    }
+}
+exports.DocumentsService = DocumentsService;

package/dist/cjs/version.js

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

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

@@ -0,0 +1,36 @@
+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/document.interface.js

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

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

@@ -36,3 +36,4 @@ 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/index.js

@@ -36,3 +36,4 @@ 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/query-params/documents-query-params.interface.d.ts

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

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

@@ -2,7 +2,7 @@ export interface Role {
     id: number;
     deleted: boolean;
     name: string;
-    colour: string;
+    colour: string | null;
     default_break: number;
     users: number[];
     pay_code: string;

package/dist/mjs/rotacloud.d.ts

@@ -1,6 +1,7 @@
 import { AccountsService, AttendanceService, AuthService, AvailabilityService, DailyBudgetsService, DailyRevenueService, DayNotesService, DaysOffService, GroupsService, LeaveEmbargoesService, LeaveRequestService, LeaveTypesService, LeaveService, LocationsService, RolesService, SettingsService, ShiftsService, TerminalsService, TerminalsActiveService, TimeZoneService, ToilAccrualsService, ToilAllowanceService, UsersService, UsersClockInService } from './services/index.js';
 import { RetryOptions, RetryStrategy, SDKConfig } from './interfaces/index.js';
 import { PinsService } from './services/pins.service.js';
+import { DocumentsService } from './services/documents.service.js';
 export declare class RotaCloud {
     private client;
     private sdkConfig;
@@ -13,6 +14,7 @@ export declare class RotaCloud {
     dailyRevenue: DailyRevenueService;
     dayNotes: DayNotesService;
     daysOff: DaysOffService;
+    documents: DocumentsService;
     group: GroupsService;
     leaveEmbargoes: LeaveEmbargoesService;
     leaveRequests: LeaveRequestService;

package/dist/mjs/rotacloud.js

@@ -4,6 +4,7 @@ import { AccountsService, AttendanceService, AuthService, AvailabilityService, D
 import { RetryStrategy } from './interfaces/index.js';
 import { PinsService } from './services/pins.service.js';
 import { SDKError } from './models/index.js';
+import { DocumentsService } from './services/documents.service.js';
 const DEFAULT_RETRIES = 3;
 const DEFAULT_RETRY_DELAY = 2000;
 const DEFAULT_RETRY_STRATEGY_OPTIONS = {
@@ -39,7 +40,7 @@ export class RotaCloud {
         const options = {
             get config() {
                 return client.config;
-            }
+            },
         };
         this.accounts = new AccountsService(this.client, options);
         this.attendance = new AttendanceService(this.client, options);
@@ -49,6 +50,7 @@ export class RotaCloud {
         this.dailyRevenue = new DailyRevenueService(this.client, options);
         this.dayNotes = new DayNotesService(this.client, options);
         this.daysOff = new DaysOffService(this.client, options);
+        this.documents = new DocumentsService(this.client, options);
         this.group = new GroupsService(this.client, options);
         this.leaveEmbargoes = new LeaveEmbargoesService(this.client, options);
         this.leaveRequests = new LeaveRequestService(this.client, options);

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

@@ -0,0 +1,73 @@
+import { AxiosResponse } from 'axios';
+import { Document } from '../interfaces/index.js';
+import { Service, Options, RequirementsOf, OptionsExtended } from './index.js';
+import { DocumentsQueryParams } from '../interfaces/query-params/index.js';
+type RequiredProps = 'name' | 'bucket' | 'key';
+export declare class DocumentsService extends Service<Document> {
+    private apiPath;
+    create(data: RequirementsOf<Document, RequiredProps>): Promise<Document>;
+    create(data: RequirementsOf<Document, RequiredProps>, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<Document>>;
+    create(data: RequirementsOf<Document, RequiredProps>, options: Options): Promise<Document>;
+    get(id: number): Promise<Document>;
+    get<F extends keyof Document>(id: number, options: {
+        fields: F[];
+        rawResponse: true;
+    } & OptionsExtended<Document>): Promise<AxiosResponse<Pick<Document, F>>>;
+    get<F extends keyof Document>(id: number, options: {
+        fields: F[];
+    } & OptionsExtended<Document>): Promise<Pick<Document, F>>;
+    get(id: number, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<Document>>;
+    get(id: number, options?: OptionsExtended<Document>): Promise<Document>;
+    list(query?: DocumentsQueryParams): AsyncGenerator<Document>;
+    list<F extends keyof Document>(query: DocumentsQueryParams, options: {
+        fields: F[];
+    } & OptionsExtended<Document>): AsyncGenerator<Pick<Document, F>>;
+    list(query?: DocumentsQueryParams, options?: OptionsExtended<Document>): AsyncGenerator<Document>;
+    listAll(query?: DocumentsQueryParams): Promise<Document[]>;
+    listAll<F extends keyof Document>(query: DocumentsQueryParams, options: {
+        fields: F[];
+    } & OptionsExtended<Document>): Promise<Pick<Document, F>[]>;
+    listAll(query?: DocumentsQueryParams, options?: OptionsExtended<Document>): Promise<Document[]>;
+    listByPage(query?: DocumentsQueryParams): AsyncGenerator<AxiosResponse<Document[]>>;
+    listByPage<F extends keyof Document>(query: DocumentsQueryParams, options: {
+        fields: F[];
+    } & OptionsExtended<Document>): AsyncGenerator<AxiosResponse<Pick<Document, F>[]>>;
+    listByPage(query?: DocumentsQueryParams, options?: OptionsExtended<Document>): AsyncGenerator<AxiosResponse<Document[]>>;
+    update(document: RequirementsOf<Document, 'id'>): Promise<Document>;
+    update(document: RequirementsOf<Document, 'id'>, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<Document>>;
+    update(document: RequirementsOf<Document, 'id'>, options: Options): Promise<Document>;
+    update(documents: RequirementsOf<Document, 'id'>[]): Promise<{
+        success: Document[];
+        failed: {
+            id: number;
+            error: string;
+        }[];
+    }>;
+    update(document: RequirementsOf<Document, 'id'>, options: Options): Promise<Document>;
+    update(documents: RequirementsOf<Document, 'id'>[], options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<{
+        code: number;
+        data?: Document;
+        error?: string;
+    }[]>>;
+    update(documents: RequirementsOf<Document, 'id'>[], options: Options): Promise<{
+        success: Document[];
+        failed: {
+            id: number;
+            error: string;
+        }[];
+    }>;
+    delete(ids: number | number[]): Promise<number>;
+    delete(ids: number | number[], options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<void>>;
+    delete(ids: number | number[], options: Options): Promise<number>;
+}
+export {};

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

@@ -0,0 +1,67 @@
+import { Service } from './index.js';
+export class DocumentsService extends Service {
+    constructor() {
+        super(...arguments);
+        this.apiPath = '/documents';
+    }
+    create(data, options) {
+        return super
+            .fetch({ url: this.apiPath, data, method: 'POST' }, options)
+            .then((res) => (options?.rawResponse ? res : res.data));
+    }
+    get(id, options) {
+        return super
+            .fetch({ url: `${this.apiPath}/${id}` }, options)
+            .then((res) => (options?.rawResponse ? res : res.data));
+    }
+    async *list(query, options) {
+        yield* super.iterator({ url: this.apiPath, params: query }, options);
+    }
+    async listAll(query, options) {
+        const shifts = [];
+        for await (const shift of this.list(query, options)) {
+            shifts.push(shift);
+        }
+        return shifts;
+    }
+    listByPage(query, options) {
+        return super.iterator({ url: this.apiPath, params: query }, options).byPage();
+    }
+    update(documents, options) {
+        if (!Array.isArray(documents)) {
+            return super
+                .fetch({
+                url: `${this.apiPath}/${documents.id}`,
+                data: documents,
+                method: 'POST',
+            }, options)
+                .then((res) => (options?.rawResponse ? res : res.data));
+        }
+        return super
+            .fetch({
+            url: this.apiPath,
+            data: documents,
+            method: 'POST',
+        }, options)
+            .then((res) => {
+            if (options?.rawResponse)
+                return res;
+            const success = [];
+            const failed = [];
+            for (let documentIdx = 0; documentIdx < res.data.length; documentIdx += 1) {
+                const { data, error } = res.data[documentIdx];
+                if (data)
+                    success.push(data);
+                if (error)
+                    failed.push({ id: documents[documentIdx].id, error });
+            }
+            return { success, failed };
+        });
+    }
+    delete(ids, options) {
+        const params = Array.isArray(ids)
+            ? { url: this.apiPath, data: { ids }, method: 'DELETE' }
+            : { url: `${this.apiPath}/${ids}`, method: 'DELETE' };
+        return super.fetch(params, options).then((res) => (options?.rawResponse ? res : res.status));
+    }
+}

package/dist/mjs/version.js

@@ -1 +1 @@
-export const Version = { version: '1.4.5' };
+export const Version = { version: '1.4.8' };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rotacloud",
-  "version": "1.4.5",
+  "version": "1.4.8",
   "description": "The RotaCloud SDK for the RotaCloud API",
   "engines": {
     "node": ">=16.10.0"

package/src/interfaces/document.interface.ts

@@ -0,0 +1,36 @@
+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/src/interfaces/index.ts

@@ -36,3 +36,4 @@ 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/src/interfaces/query-params/documents-query-params.interface.ts

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

package/src/interfaces/role.interface.ts

@@ -2,7 +2,7 @@ export interface Role {
   id: number;
   deleted: boolean;
   name: string;
-  colour: string;
+  colour: string | null;
   default_break: number;
   users: number[];
   pay_code: string;

package/src/rotacloud.ts

@@ -29,6 +29,7 @@ import {
 import { RetryOptions, RetryStrategy, SDKBase, SDKConfig } from './interfaces/index.js';
 import { PinsService } from './services/pins.service.js';
 import { SDKError } from './models/index.js';
+import { DocumentsService } from './services/documents.service.js';
 
 const DEFAULT_RETRIES = 3;
 const DEFAULT_RETRY_DELAY = 2000;
@@ -73,6 +74,7 @@ export class RotaCloud {
   dailyRevenue: DailyRevenueService;
   dayNotes: DayNotesService;
   daysOff: DaysOffService;
+  documents: DocumentsService;
   group: GroupsService;
   leaveEmbargoes: LeaveEmbargoesService;
   leaveRequests: LeaveRequestService;
@@ -97,8 +99,8 @@ export class RotaCloud {
     const options = {
       get config(): SDKConfig {
         return client.config;
-      }
-    }
+      },
+    };
 
     this.accounts = new AccountsService(this.client, options);
     this.attendance = new AttendanceService(this.client, options);
@@ -108,6 +110,7 @@ export class RotaCloud {
     this.dailyRevenue = new DailyRevenueService(this.client, options);
     this.dayNotes = new DayNotesService(this.client, options);
     this.daysOff = new DaysOffService(this.client, options);
+    this.documents = new DocumentsService(this.client, options);
     this.group = new GroupsService(this.client, options);
     this.leaveEmbargoes = new LeaveEmbargoesService(this.client, options);
     this.leaveRequests = new LeaveRequestService(this.client, options);

package/src/services/documents.service.ts

@@ -0,0 +1,142 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { Document } from '../interfaces/index.js';
+import { Service, Options, RequirementsOf, OptionsExtended } from './index.js';
+import { DocumentsQueryParams } from '../interfaces/query-params/index.js';
+
+type RequiredProps = 'name' | 'bucket' | 'key';
+
+export class DocumentsService extends Service<Document> {
+  private apiPath = '/documents';
+
+  create(data: RequirementsOf<Document, RequiredProps>): Promise<Document>;
+  create(
+    data: RequirementsOf<Document, RequiredProps>,
+    options: { rawResponse: true } & Options,
+  ): Promise<AxiosResponse<Document>>;
+  create(data: RequirementsOf<Document, RequiredProps>, options: Options): Promise<Document>;
+  create(data: RequirementsOf<Document, RequiredProps>, options?: Options) {
+    return super
+      .fetch<Document>({ url: this.apiPath, data, method: 'POST' }, options)
+      .then((res) => (options?.rawResponse ? res : res.data));
+  }
+
+  get(id: number): Promise<Document>;
+  get<F extends keyof Document>(
+    id: number,
+    options: { fields: F[]; rawResponse: true } & OptionsExtended<Document>,
+  ): Promise<AxiosResponse<Pick<Document, F>>>;
+  get<F extends keyof Document>(
+    id: number,
+    options: { fields: F[] } & OptionsExtended<Document>,
+  ): Promise<Pick<Document, F>>;
+  get(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<Document>>;
+  get(id: number, options?: OptionsExtended<Document>): Promise<Document>;
+  get(id: number, options?: OptionsExtended<Document>) {
+    return super
+      .fetch<Document>({ url: `${this.apiPath}/${id}` }, options)
+      .then((res) => (options?.rawResponse ? res : res.data));
+  }
+
+  list(query?: DocumentsQueryParams): AsyncGenerator<Document>;
+  list<F extends keyof Document>(
+    query: DocumentsQueryParams,
+    options: { fields: F[] } & OptionsExtended<Document>,
+  ): AsyncGenerator<Pick<Document, F>>;
+  list(query?: DocumentsQueryParams, options?: OptionsExtended<Document>): AsyncGenerator<Document>;
+  async *list(query?: DocumentsQueryParams, options?: OptionsExtended<Document>) {
+    yield* super.iterator({ url: this.apiPath, params: query }, options);
+  }
+
+  listAll(query?: DocumentsQueryParams): Promise<Document[]>;
+  listAll<F extends keyof Document>(
+    query: DocumentsQueryParams,
+    options: { fields: F[] } & OptionsExtended<Document>,
+  ): Promise<Pick<Document, F>[]>;
+  listAll(query?: DocumentsQueryParams, options?: OptionsExtended<Document>): Promise<Document[]>;
+  async listAll(query?: DocumentsQueryParams, options?: OptionsExtended<Document>) {
+    const shifts = [] as Document[];
+    for await (const shift of this.list(query, options)) {
+      shifts.push(shift);
+    }
+    return shifts;
+  }
+
+  listByPage(query?: DocumentsQueryParams): AsyncGenerator<AxiosResponse<Document[]>>;
+  listByPage<F extends keyof Document>(
+    query: DocumentsQueryParams,
+    options: { fields: F[] } & OptionsExtended<Document>,
+  ): AsyncGenerator<AxiosResponse<Pick<Document, F>[]>>;
+  listByPage(
+    query?: DocumentsQueryParams,
+    options?: OptionsExtended<Document>,
+  ): AsyncGenerator<AxiosResponse<Document[]>>;
+  listByPage(query?: DocumentsQueryParams, options?: OptionsExtended<Document>) {
+    return super.iterator<Document>({ url: this.apiPath, params: query }, options).byPage();
+  }
+
+  update(document: RequirementsOf<Document, 'id'>): Promise<Document>;
+  update(
+    document: RequirementsOf<Document, 'id'>,
+    options: { rawResponse: true } & Options,
+  ): Promise<AxiosResponse<Document>>;
+  update(document: RequirementsOf<Document, 'id'>, options: Options): Promise<Document>;
+  update(
+    documents: RequirementsOf<Document, 'id'>[],
+  ): Promise<{ success: Document[]; failed: { id: number; error: string }[] }>;
+  update(document: RequirementsOf<Document, 'id'>, options: Options): Promise<Document>;
+  update(
+    documents: RequirementsOf<Document, 'id'>[],
+    options: { rawResponse: true } & Options,
+  ): Promise<AxiosResponse<{ code: number; data?: Document; error?: string }[]>>;
+  update(
+    documents: RequirementsOf<Document, 'id'>[],
+    options: Options,
+  ): Promise<{ success: Document[]; failed: { id: number; error: string }[] }>;
+  update(documents: RequirementsOf<Document, 'id'> | RequirementsOf<Document, 'id'>[], options?: Options) {
+    if (!Array.isArray(documents)) {
+      return super
+        .fetch<Document>(
+          {
+            url: `${this.apiPath}/${documents.id}`,
+            data: documents,
+            method: 'POST',
+          },
+          options,
+        )
+        .then((res) => (options?.rawResponse ? res : res.data));
+    }
+
+    return super
+      .fetch<{ code: number; data?: Document; error?: string }[]>(
+        {
+          url: this.apiPath,
+          data: documents,
+          method: 'POST',
+        },
+        options,
+      )
+      .then((res) => {
+        if (options?.rawResponse) return res;
+
+        const success: Document[] = [];
+        const failed: { id: number; error: string }[] = [];
+        for (let documentIdx = 0; documentIdx < res.data.length; documentIdx += 1) {
+          const { data, error } = res.data[documentIdx];
+          if (data) success.push(data);
+          if (error) failed.push({ id: documents[documentIdx].id, error });
+        }
+        return { success, failed };
+      });
+  }
+
+  delete(ids: number | number[]): Promise<number>;
+  delete(ids: number | number[], options: { rawResponse: true } & Options): Promise<AxiosResponse<void>>;
+  delete(ids: number | number[], options: Options): Promise<number>;
+  delete(ids: number | number[], options?: Options) {
+    const params: AxiosRequestConfig = Array.isArray(ids)
+      ? { url: this.apiPath, data: { ids }, method: 'DELETE' }
+      : { url: `${this.apiPath}/${ids}`, method: 'DELETE' };
+
+    return super.fetch<void>(params, options).then((res) => (options?.rawResponse ? res : res.status));
+  }
+}

package/src/version.ts

@@ -1 +1 @@
-export const Version = { version: '1.4.5' };
+export const Version = { version: '1.4.8' };