rotacloud 1.0.12 → 1.0.13

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

@@ -2,12 +2,12 @@ export interface ApiAvailabilityPeriod {
     start_time: string;
     end_time: string;
 }
-export interface ApiAvailabilityDates {
+export interface ApiAvailabilityDate {
     date: string;
     available: ApiAvailabilityPeriod[];
     unavailable: ApiAvailabilityPeriod[];
 }
 export interface ApiAvailability {
     user: number;
-    dates: ApiAvailabilityDates[];
+    dates: ApiAvailabilityDate[];
 }

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

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

package/dist/cjs/models/availability.model.d.ts

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

package/dist/cjs/rotacloud.d.ts

@@ -1,10 +1,11 @@
-import { AccountsService, AttendanceService, DaysOffService, GroupsService, LeaveEmbargoesService, LeaveRequestService, LeaveService, LocationsService, RolesService, ShiftsService, UsersService } from './services/index.js';
+import { AccountsService, AttendanceService, AvailabilityService, 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;
+    availability: AvailabilityService;
     daysOff: DaysOffService;
     group: GroupsService;
     leaveEmbargoes: LeaveEmbargoesService;

package/dist/cjs/rotacloud.js

@@ -7,6 +7,7 @@ class RotaCloud {
         this.defaultAPIURI = 'https://api.rotacloud.com/v1';
         this.accounts = new index_js_1.AccountsService();
         this.attendance = new index_js_1.AttendanceService();
+        this.availability = new index_js_1.AvailabilityService();
         this.daysOff = new index_js_1.DaysOffService();
         this.group = new index_js_1.GroupsService();
         this.leaveEmbargoes = new index_js_1.LeaveEmbargoesService();

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

@@ -0,0 +1,13 @@
+import { Service, Options, RequirementsOf } from './index.js';
+import { InternalQueryParams } from '../interfaces/query-params/internal-query-params.inteface.js';
+import { AvailabilityQueryParams } from '../interfaces/query-params/availability-query-params.interface.js';
+import { Availability } from '../models/availability.model.js';
+import { ApiAvailability } from '../interfaces/availability.interface.js';
+declare type RequiredProps = 'start' | 'end';
+declare type RequiredOptions<T> = RequirementsOf<Options<T>, 'params'>;
+export declare class AvailabilityService extends Service {
+    private apiPath;
+    list(options: RequiredOptions<RequirementsOf<AvailabilityQueryParams, RequiredProps> & InternalQueryParams>): AsyncGenerator<Availability, void, unknown>;
+    listByPage(options: RequiredOptions<RequirementsOf<AvailabilityQueryParams, RequiredProps> & InternalQueryParams>): AsyncGenerator<import("axios").AxiosResponse<ApiAvailability[], any>, any, unknown>;
+}
+export {};

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

@@ -0,0 +1,55 @@
+"use strict";
+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 __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"), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
+    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.AvailabilityService = void 0;
+const index_js_1 = require("./index.js");
+const availability_model_js_1 = require("../models/availability.model.js");
+class AvailabilityService extends index_js_1.Service {
+    constructor() {
+        super(...arguments);
+        this.apiPath = '/availability';
+    }
+    list(options) {
+        const _super = Object.create(null, {
+            iterator: { get: () => super.iterator }
+        });
+        return __asyncGenerator(this, arguments, function* list_1() {
+            var e_1, _a;
+            try {
+                for (var _b = __asyncValues(_super.iterator.call(this, { url: this.apiPath }, options)), _c; _c = yield __await(_b.next()), !_c.done;) {
+                    const res = _c.value;
+                    yield yield __await(new availability_model_js_1.Availability(res));
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (_c && !_c.done && (_a = _b.return)) yield __await(_a.call(_b));
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        });
+    }
+    listByPage(options) {
+        return super.iterator({ url: this.apiPath }, options).byPage();
+    }
+}
+exports.AvailabilityService = AvailabilityService;

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

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

package/dist/cjs/services/index.js

@@ -13,6 +13,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./service.js"), exports);
 __exportStar(require("./accounts.service.js"), exports);
 __exportStar(require("./attendance.service.js"), exports);
+__exportStar(require("./availability.service.js"), exports);
 __exportStar(require("./days-off.service.js"), exports);
 __exportStar(require("./groups.service.js"), exports);
 __exportStar(require("./leave-request.service.js"), exports);

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.0.12" };
+exports.Version = { version: "1.0.13" };

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

@@ -2,12 +2,12 @@ export interface ApiAvailabilityPeriod {
     start_time: string;
     end_time: string;
 }
-export interface ApiAvailabilityDates {
+export interface ApiAvailabilityDate {
     date: string;
     available: ApiAvailabilityPeriod[];
     unavailable: ApiAvailabilityPeriod[];
 }
 export interface ApiAvailability {
     user: number;
-    dates: ApiAvailabilityDates[];
+    dates: ApiAvailabilityDate[];
 }

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

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

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

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

package/dist/mjs/rotacloud.d.ts

@@ -1,10 +1,11 @@
-import { AccountsService, AttendanceService, DaysOffService, GroupsService, LeaveEmbargoesService, LeaveRequestService, LeaveService, LocationsService, RolesService, ShiftsService, UsersService } from './services/index.js';
+import { AccountsService, AttendanceService, AvailabilityService, 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;
+    availability: AvailabilityService;
     daysOff: DaysOffService;
     group: GroupsService;
     leaveEmbargoes: LeaveEmbargoesService;

package/dist/mjs/rotacloud.js

@@ -1,9 +1,10 @@
-import { AccountsService, AttendanceService, DaysOffService, GroupsService, LeaveEmbargoesService, LeaveRequestService, LeaveService, LocationsService, RolesService, ShiftsService, UsersService, } from './services/index.js';
+import { AccountsService, AttendanceService, AvailabilityService, 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.availability = new AvailabilityService();
         this.daysOff = new DaysOffService();
         this.group = new GroupsService();
         this.leaveEmbargoes = new LeaveEmbargoesService();

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

@@ -0,0 +1,13 @@
+import { Service, Options, RequirementsOf } from './index.js';
+import { InternalQueryParams } from '../interfaces/query-params/internal-query-params.inteface.js';
+import { AvailabilityQueryParams } from '../interfaces/query-params/availability-query-params.interface.js';
+import { Availability } from '../models/availability.model.js';
+import { ApiAvailability } from '../interfaces/availability.interface.js';
+declare type RequiredProps = 'start' | 'end';
+declare type RequiredOptions<T> = RequirementsOf<Options<T>, 'params'>;
+export declare class AvailabilityService extends Service {
+    private apiPath;
+    list(options: RequiredOptions<RequirementsOf<AvailabilityQueryParams, RequiredProps> & InternalQueryParams>): AsyncGenerator<Availability, void, unknown>;
+    listByPage(options: RequiredOptions<RequirementsOf<AvailabilityQueryParams, RequiredProps> & InternalQueryParams>): AsyncGenerator<import("axios").AxiosResponse<ApiAvailability[], any>, any, unknown>;
+}
+export {};

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

@@ -0,0 +1,16 @@
+import { Service } from './index.js';
+import { Availability } from '../models/availability.model.js';
+export class AvailabilityService extends Service {
+    constructor() {
+        super(...arguments);
+        this.apiPath = '/availability';
+    }
+    async *list(options) {
+        for await (const res of super.iterator({ url: this.apiPath }, options)) {
+            yield new Availability(res);
+        }
+    }
+    listByPage(options) {
+        return super.iterator({ url: this.apiPath }, options).byPage();
+    }
+}

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

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

package/dist/mjs/services/index.js

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

package/dist/mjs/version.js

@@ -1 +1 @@
-export const Version = { version: "1.0.12" };
+export const Version = { version: "1.0.13" };

package/fixup

@@ -1,3 +1,4 @@
+#!/bin/bash
 cat >dist/cjs/package.json <<!EOF
 {
     "type": "commonjs"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rotacloud",
-  "version": "1.0.12",
+  "version": "1.0.13",
   "description": "The RotaCloud SDK for the RotaCloud API",
   "engines": {
     "node": ">=14.17.0"

package/src/interfaces/availability.interface.ts

@@ -3,7 +3,7 @@ export interface ApiAvailabilityPeriod {
   end_time: string;
 }
 
-export interface ApiAvailabilityDates {
+export interface ApiAvailabilityDate {
   date: string;
   available: ApiAvailabilityPeriod[];
   unavailable: ApiAvailabilityPeriod[];
@@ -11,5 +11,5 @@ export interface ApiAvailabilityDates {
 
 export interface ApiAvailability {
   user: number;
-  dates: ApiAvailabilityDates[];
+  dates: ApiAvailabilityDate[];
 }

package/src/interfaces/query-params/availability-query-params.interface.ts

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

package/src/models/availability.model.ts

@@ -1,8 +1,8 @@
-import { ApiAvailability, ApiAvailabilityDates } from '../interfaces/index.js';
+import { ApiAvailability, ApiAvailabilityDate } from '../interfaces/index.js';
 
 export class Availability {
   public user: number;
-  public dates: ApiAvailabilityDates[];
+  public dates: ApiAvailabilityDate[];
 
   constructor(availability: ApiAvailability) {
     this.user = availability.user;

package/src/rotacloud.ts

@@ -1,6 +1,7 @@
 import {
   AccountsService,
   AttendanceService,
+  AvailabilityService,
   DaysOffService,
   GroupsService,
   LeaveEmbargoesService,
@@ -19,6 +20,7 @@ export class RotaCloud {
   public defaultAPIURI = 'https://api.rotacloud.com/v1';
   public accounts = new AccountsService();
   public attendance = new AttendanceService();
+  public availability = new AvailabilityService();
   public daysOff = new DaysOffService();
   public group = new GroupsService();
   public leaveEmbargoes = new LeaveEmbargoesService();

package/src/services/availability.service.ts

@@ -0,0 +1,23 @@
+import { Service, Options, RequirementsOf } from './index.js';
+
+import { InternalQueryParams } from '../interfaces/query-params/internal-query-params.inteface.js';
+import { AvailabilityQueryParams } from '../interfaces/query-params/availability-query-params.interface.js';
+import { Availability } from '../models/availability.model.js';
+import { ApiAvailability } from '../interfaces/availability.interface.js';
+
+type RequiredProps = 'start' | 'end';
+type RequiredOptions<T> = RequirementsOf<Options<T>, 'params'>;
+
+export class AvailabilityService extends Service {
+  private apiPath = '/availability';
+
+  async *list(options: RequiredOptions<RequirementsOf<AvailabilityQueryParams, RequiredProps> & InternalQueryParams>) {
+    for await (const res of super.iterator<ApiAvailability>({ url: this.apiPath }, options)) {
+      yield new Availability(res);
+    }
+  }
+
+  listByPage(options: RequiredOptions<RequirementsOf<AvailabilityQueryParams, RequiredProps> & InternalQueryParams>) {
+    return super.iterator<ApiAvailability>({ url: this.apiPath }, options).byPage();
+  }
+}

package/src/services/index.ts

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

package/src/version.ts

@@ -1 +1 @@
-export const Version = { version: "1.0.12" }
+export const Version = { version: "1.0.13" }