rotacloud 1.0.38 → 1.0.40

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

@@ -1,5 +1,4 @@
 export interface LeaveRequestsQueryParams {
-    users?: number[];
-    status?: string;
+    status?: 'requested' | 'approved' | 'denied' | 'expired';
     include_deleted?: boolean;
 }

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

@@ -1,6 +1,14 @@
 export interface UsersQueryParams {
     ids?: number[];
     locations?: number[];
+    /**
+     * Works different from {UserQueryParams.locations},
+     * When filtering out employees for rota, this is more suggested,
+     * one scenario would be filtering out employees base on their starting and
+     * final working date, using {UserQueryParams.locations} will not work in tandem
+     * of {UserQueryParams.start_date} and {UserQueryParams.end_date}
+     */
+    location?: number;
     roles?: number[];
     only_managed?: boolean;
     include_self?: boolean;

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

@@ -8,7 +8,7 @@ export interface ApiShift {
     start_time: number;
     end_time: number;
     minutes_break: number;
-    user: number;
+    user: number | null;
     location: number;
     role: number | null;
     notes: string | null;

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

@@ -0,0 +1,29 @@
+export * from './account.model.js';
+export * from './attendance.model.js';
+export * from './auth.model.js';
+export * from './availability-pattern.model.js';
+export * from './availability.model.js';
+export * from './daily-budgets.model.js';
+export * from './daily-revenue.model.js';
+export * from './day-note.model.js';
+export * from './days-off-pattern.model.js';
+export * from './days-off.model.js';
+export * from './document.model.js';
+export * from './error-response.model.js';
+export * from './group.model.js';
+export * from './holiday-allowance-custom.model.js';
+export * from './holiday-allowance.model.js';
+export * from './leave-embargo.model.js';
+export * from './leave-request.model.js';
+export * from './leave-type.model.js';
+export * from './leave.model.js';
+export * from './location.model.js';
+export * from './logbook-category.model.js';
+export * from './logbook-event.model.js';
+export * from './memo.model.js';
+export * from './pay-period.model.js';
+export * from './role.model.js';
+export * from './settings.model.js';
+export * from './shift.model.js';
+export * from './terminal.model.js';
+export * from './user.model.js';

package/dist/cjs/models/index.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./account.model.js"), exports);
+__exportStar(require("./attendance.model.js"), exports);
+__exportStar(require("./auth.model.js"), exports);
+__exportStar(require("./availability-pattern.model.js"), exports);
+__exportStar(require("./availability.model.js"), exports);
+__exportStar(require("./daily-budgets.model.js"), exports);
+__exportStar(require("./daily-revenue.model.js"), exports);
+__exportStar(require("./day-note.model.js"), exports);
+__exportStar(require("./days-off-pattern.model.js"), exports);
+__exportStar(require("./days-off.model.js"), exports);
+__exportStar(require("./document.model.js"), exports);
+__exportStar(require("./error-response.model.js"), exports);
+__exportStar(require("./group.model.js"), exports);
+__exportStar(require("./holiday-allowance-custom.model.js"), exports);
+__exportStar(require("./holiday-allowance.model.js"), exports);
+__exportStar(require("./leave-embargo.model.js"), exports);
+__exportStar(require("./leave-request.model.js"), exports);
+__exportStar(require("./leave-type.model.js"), exports);
+__exportStar(require("./leave.model.js"), exports);
+__exportStar(require("./location.model.js"), exports);
+__exportStar(require("./logbook-category.model.js"), exports);
+__exportStar(require("./logbook-event.model.js"), exports);
+__exportStar(require("./memo.model.js"), exports);
+__exportStar(require("./pay-period.model.js"), exports);
+__exportStar(require("./role.model.js"), exports);
+__exportStar(require("./settings.model.js"), exports);
+__exportStar(require("./shift.model.js"), exports);
+__exportStar(require("./terminal.model.js"), exports);
+__exportStar(require("./user.model.js"), exports);

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

@@ -1,15 +1,10 @@
-import { ApiLocation } from '../interfaces/index.js';
-export declare class LatLngObject {
-    lat: number;
-    lng: number;
-    radius: number;
-}
+import { ApiLocation, ApiLocationCoordinate } from '../interfaces/index.js';
 export declare class Location {
     id: number;
     name: string;
     deleted: boolean;
     address: string;
-    location: LatLngObject;
+    location: ApiLocationCoordinate;
     timezone: number;
     users: number[];
     managers: number[];

package/dist/cjs/models/location.model.js

@@ -1,9 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Location = exports.LatLngObject = void 0;
-class LatLngObject {
-}
-exports.LatLngObject = LatLngObject;
+exports.Location = void 0;
 class Location {
     constructor(location) {
         this.id = location.id;

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

@@ -9,7 +9,7 @@ export declare class Shift {
     start_time: number;
     end_time: number;
     minutes_break: number;
-    user: number;
+    user: number | null;
     location: number;
     role: number | null;
     notes: string | null;

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

@@ -1,8 +1,4 @@
-export declare class LatLngObject {
-    lat: number;
-    lng: number;
-    radius: number;
-}
+import { ApiLocationCoordinate } from '../interfaces/index.js';
 export declare class Terminal {
     id: number;
     deleted: boolean;
@@ -12,7 +8,7 @@ export declare class Terminal {
     device: string;
     version: string;
     ip: string;
-    location: LatLngObject;
+    location: ApiLocationCoordinate;
     timezone: number;
     require_photo: boolean;
     require_photo_breaks: boolean;

package/dist/cjs/models/terminal.model.js

@@ -1,9 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Terminal = exports.LatLngObject = void 0;
-class LatLngObject {
-}
-exports.LatLngObject = LatLngObject;
+exports.Terminal = void 0;
 class Terminal {
 }
 exports.Terminal = Terminal;

package/dist/cjs/rotacloud.d.ts

@@ -28,3 +28,4 @@ export declare class RotaCloud {
 export { RetryStrategy, RetryOptions } from './services/service.js';
 export * from './interfaces/index.js';
 export * from './interfaces/query-params/index.js';
+export * from './models/index.js';

package/dist/cjs/rotacloud.js

@@ -51,3 +51,4 @@ var service_js_1 = require("./services/service.js");
 Object.defineProperty(exports, "RetryStrategy", { enumerable: true, get: function () { return service_js_1.RetryStrategy; } });
 __exportStar(require("./interfaces/index.js"), exports);
 __exportStar(require("./interfaces/query-params/index.js"), exports);
+__exportStar(require("./models/index.js"), exports);

package/dist/cjs/services/leave-request.service.d.ts

@@ -1,7 +1,7 @@
 import { AxiosResponse } from 'axios';
 import { ApiLeaveRequest } from '../interfaces/index.js';
 import { Service, Options, RequirementsOf } from './index.js';
-import { LeaveQueryParams } from '../interfaces/query-params/leave-query-params.interface.js';
+import { LeaveRequestsQueryParams } from '../interfaces/query-params/leave-requests-query-params.interface.js';
 import { LeaveRequest } from '../models/leave-request.model.js';
 declare type RequiredProps = 'start_date' | 'end_date' | 'type' | 'user';
 export declare class LeaveRequestService extends Service {
@@ -16,9 +16,9 @@ export declare class LeaveRequestService extends Service {
         rawResponse: true;
     }): Promise<AxiosResponse<ApiLeaveRequest, any>>;
     get(id: number, options: Options): Promise<LeaveRequest>;
-    list(query?: LeaveQueryParams, options?: Options): AsyncGenerator<LeaveRequest, void, unknown>;
-    listAll(query?: LeaveQueryParams, options?: Options): Promise<LeaveRequest[]>;
-    listByPage(query?: LeaveQueryParams, options?: Options): AsyncGenerator<AxiosResponse<ApiLeaveRequest[], any>, any, unknown>;
+    list(query?: LeaveRequestsQueryParams, options?: Options): AsyncGenerator<LeaveRequest, void, unknown>;
+    listAll(query?: LeaveRequestsQueryParams, options?: Options): Promise<LeaveRequest[]>;
+    listByPage(query?: LeaveRequestsQueryParams, options?: Options): AsyncGenerator<AxiosResponse<ApiLeaveRequest[], any>, any, unknown>;
     update(id: number, data: Partial<ApiLeaveRequest>): Promise<LeaveRequest>;
     update(id: number, data: Partial<ApiLeaveRequest>, options: {
         rawResponse: true;

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.38' };
+exports.Version = { version: '1.0.40' };

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

@@ -1,5 +1,4 @@
 export interface LeaveRequestsQueryParams {
-    users?: number[];
-    status?: string;
+    status?: 'requested' | 'approved' | 'denied' | 'expired';
     include_deleted?: boolean;
 }

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

@@ -1,6 +1,14 @@
 export interface UsersQueryParams {
     ids?: number[];
     locations?: number[];
+    /**
+     * Works different from {UserQueryParams.locations},
+     * When filtering out employees for rota, this is more suggested,
+     * one scenario would be filtering out employees base on their starting and
+     * final working date, using {UserQueryParams.locations} will not work in tandem
+     * of {UserQueryParams.start_date} and {UserQueryParams.end_date}
+     */
+    location?: number;
     roles?: number[];
     only_managed?: boolean;
     include_self?: boolean;

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

@@ -8,7 +8,7 @@ export interface ApiShift {
     start_time: number;
     end_time: number;
     minutes_break: number;
-    user: number;
+    user: number | null;
     location: number;
     role: number | null;
     notes: string | null;

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

@@ -0,0 +1,29 @@
+export * from './account.model.js';
+export * from './attendance.model.js';
+export * from './auth.model.js';
+export * from './availability-pattern.model.js';
+export * from './availability.model.js';
+export * from './daily-budgets.model.js';
+export * from './daily-revenue.model.js';
+export * from './day-note.model.js';
+export * from './days-off-pattern.model.js';
+export * from './days-off.model.js';
+export * from './document.model.js';
+export * from './error-response.model.js';
+export * from './group.model.js';
+export * from './holiday-allowance-custom.model.js';
+export * from './holiday-allowance.model.js';
+export * from './leave-embargo.model.js';
+export * from './leave-request.model.js';
+export * from './leave-type.model.js';
+export * from './leave.model.js';
+export * from './location.model.js';
+export * from './logbook-category.model.js';
+export * from './logbook-event.model.js';
+export * from './memo.model.js';
+export * from './pay-period.model.js';
+export * from './role.model.js';
+export * from './settings.model.js';
+export * from './shift.model.js';
+export * from './terminal.model.js';
+export * from './user.model.js';

package/dist/mjs/models/index.js

@@ -0,0 +1,29 @@
+export * from './account.model.js';
+export * from './attendance.model.js';
+export * from './auth.model.js';
+export * from './availability-pattern.model.js';
+export * from './availability.model.js';
+export * from './daily-budgets.model.js';
+export * from './daily-revenue.model.js';
+export * from './day-note.model.js';
+export * from './days-off-pattern.model.js';
+export * from './days-off.model.js';
+export * from './document.model.js';
+export * from './error-response.model.js';
+export * from './group.model.js';
+export * from './holiday-allowance-custom.model.js';
+export * from './holiday-allowance.model.js';
+export * from './leave-embargo.model.js';
+export * from './leave-request.model.js';
+export * from './leave-type.model.js';
+export * from './leave.model.js';
+export * from './location.model.js';
+export * from './logbook-category.model.js';
+export * from './logbook-event.model.js';
+export * from './memo.model.js';
+export * from './pay-period.model.js';
+export * from './role.model.js';
+export * from './settings.model.js';
+export * from './shift.model.js';
+export * from './terminal.model.js';
+export * from './user.model.js';

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

@@ -1,15 +1,10 @@
-import { ApiLocation } from '../interfaces/index.js';
-export declare class LatLngObject {
-    lat: number;
-    lng: number;
-    radius: number;
-}
+import { ApiLocation, ApiLocationCoordinate } from '../interfaces/index.js';
 export declare class Location {
     id: number;
     name: string;
     deleted: boolean;
     address: string;
-    location: LatLngObject;
+    location: ApiLocationCoordinate;
     timezone: number;
     users: number[];
     managers: number[];

package/dist/mjs/models/location.model.js

@@ -1,5 +1,3 @@
-export class LatLngObject {
-}
 export class Location {
     constructor(location) {
         this.id = location.id;

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

@@ -9,7 +9,7 @@ export declare class Shift {
     start_time: number;
     end_time: number;
     minutes_break: number;
-    user: number;
+    user: number | null;
     location: number;
     role: number | null;
     notes: string | null;

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

@@ -1,8 +1,4 @@
-export declare class LatLngObject {
-    lat: number;
-    lng: number;
-    radius: number;
-}
+import { ApiLocationCoordinate } from '../interfaces/index.js';
 export declare class Terminal {
     id: number;
     deleted: boolean;
@@ -12,7 +8,7 @@ export declare class Terminal {
     device: string;
     version: string;
     ip: string;
-    location: LatLngObject;
+    location: ApiLocationCoordinate;
     timezone: number;
     require_photo: boolean;
     require_photo_breaks: boolean;

package/dist/mjs/models/terminal.model.js

@@ -1,4 +1,2 @@
-export class LatLngObject {
-}
 export class Terminal {
 }

package/dist/mjs/rotacloud.d.ts

@@ -28,3 +28,4 @@ export declare class RotaCloud {
 export { RetryStrategy, RetryOptions } from './services/service.js';
 export * from './interfaces/index.js';
 export * from './interfaces/query-params/index.js';
+export * from './models/index.js';

package/dist/mjs/rotacloud.js

@@ -39,3 +39,4 @@ export class RotaCloud {
 export { RetryStrategy } from './services/service.js';
 export * from './interfaces/index.js';
 export * from './interfaces/query-params/index.js';
+export * from './models/index.js';

package/dist/mjs/services/leave-request.service.d.ts

@@ -1,7 +1,7 @@
 import { AxiosResponse } from 'axios';
 import { ApiLeaveRequest } from '../interfaces/index.js';
 import { Service, Options, RequirementsOf } from './index.js';
-import { LeaveQueryParams } from '../interfaces/query-params/leave-query-params.interface.js';
+import { LeaveRequestsQueryParams } from '../interfaces/query-params/leave-requests-query-params.interface.js';
 import { LeaveRequest } from '../models/leave-request.model.js';
 declare type RequiredProps = 'start_date' | 'end_date' | 'type' | 'user';
 export declare class LeaveRequestService extends Service {
@@ -16,9 +16,9 @@ export declare class LeaveRequestService extends Service {
         rawResponse: true;
     }): Promise<AxiosResponse<ApiLeaveRequest, any>>;
     get(id: number, options: Options): Promise<LeaveRequest>;
-    list(query?: LeaveQueryParams, options?: Options): AsyncGenerator<LeaveRequest, void, unknown>;
-    listAll(query?: LeaveQueryParams, options?: Options): Promise<LeaveRequest[]>;
-    listByPage(query?: LeaveQueryParams, options?: Options): AsyncGenerator<AxiosResponse<ApiLeaveRequest[], any>, any, unknown>;
+    list(query?: LeaveRequestsQueryParams, options?: Options): AsyncGenerator<LeaveRequest, void, unknown>;
+    listAll(query?: LeaveRequestsQueryParams, options?: Options): Promise<LeaveRequest[]>;
+    listByPage(query?: LeaveRequestsQueryParams, options?: Options): AsyncGenerator<AxiosResponse<ApiLeaveRequest[], any>, any, unknown>;
     update(id: number, data: Partial<ApiLeaveRequest>): Promise<LeaveRequest>;
     update(id: number, data: Partial<ApiLeaveRequest>, options: {
         rawResponse: true;

package/dist/mjs/version.js

@@ -1 +1 @@
-export const Version = { version: '1.0.38' };
+export const Version = { version: '1.0.40' };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rotacloud",
-  "version": "1.0.38",
+  "version": "1.0.40",
   "description": "The RotaCloud SDK for the RotaCloud API",
   "engines": {
     "node": ">=14.17.0"
@@ -47,7 +47,6 @@
   "dependencies": {
     "@types/node": "^16.11.6",
     "axios": "^0.23.0",
-    "axios-retry": "^3.3.1",
-    "cross-var": "^1.1.0"
+    "axios-retry": "^3.3.1"
   }
 }

package/src/interfaces/query-params/leave-requests-query-params.interface.ts

@@ -1,5 +1,4 @@
 export interface LeaveRequestsQueryParams {
-  users?: number[];
-  status?: string;
+  status?: 'requested' | 'approved' | 'denied' | 'expired';
   include_deleted?: boolean;
 }

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

@@ -1,6 +1,14 @@
 export interface UsersQueryParams {
   ids?: number[];
   locations?: number[];
+  /**
+   * Works different from {UserQueryParams.locations},
+   * When filtering out employees for rota, this is more suggested,
+   * one scenario would be filtering out employees base on their starting and
+   * final working date, using {UserQueryParams.locations} will not work in tandem
+   * of {UserQueryParams.start_date} and {UserQueryParams.end_date}
+   */
+  location?: number;
   roles?: number[];
   only_managed?: boolean;
   include_self?: boolean;

package/src/interfaces/shift.interface.ts

@@ -8,7 +8,7 @@ export interface ApiShift {
   start_time: number;
   end_time: number;
   minutes_break: number;
-  user: number;
+  user: number | null;
   location: number;
   role: number | null;
   notes: string | null;

package/src/models/index.ts

@@ -0,0 +1,29 @@
+export * from './account.model.js';
+export * from './attendance.model.js';
+export * from './auth.model.js';
+export * from './availability-pattern.model.js';
+export * from './availability.model.js';
+export * from './daily-budgets.model.js';
+export * from './daily-revenue.model.js';
+export * from './day-note.model.js';
+export * from './days-off-pattern.model.js';
+export * from './days-off.model.js';
+export * from './document.model.js';
+export * from './error-response.model.js';
+export * from './group.model.js';
+export * from './holiday-allowance-custom.model.js';
+export * from './holiday-allowance.model.js';
+export * from './leave-embargo.model.js';
+export * from './leave-request.model.js';
+export * from './leave-type.model.js';
+export * from './leave.model.js';
+export * from './location.model.js';
+export * from './logbook-category.model.js';
+export * from './logbook-event.model.js';
+export * from './memo.model.js';
+export * from './pay-period.model.js';
+export * from './role.model.js';
+export * from './settings.model.js';
+export * from './shift.model.js';
+export * from './terminal.model.js';
+export * from './user.model.js';

package/src/models/location.model.ts

@@ -1,17 +1,11 @@
-import { ApiLocation } from '../interfaces/index.js';
-
-export class LatLngObject {
-  public lat: number;
-  public lng: number;
-  public radius: number;
-}
+import { ApiLocation, ApiLocationCoordinate } from '../interfaces/index.js';
 
 export class Location {
   public id: number;
   public name: string;
   public deleted: boolean;
   public address: string;
-  public location: LatLngObject;
+  public location: ApiLocationCoordinate;
   public timezone: number;
   public users: number[];
   public managers: number[];

package/src/models/shift.model.ts

@@ -10,7 +10,7 @@ export class Shift {
   public start_time: number;
   public end_time: number;
   public minutes_break: number;
-  public user: number;
+  public user: number | null;
   public location: number;
   public role: number | null;
   public notes: string | null;

package/src/models/terminal.model.ts

@@ -1,8 +1,4 @@
-export class LatLngObject {
-  public lat: number;
-  public lng: number;
-  public radius: number;
-}
+import { ApiLocationCoordinate } from '../interfaces/index.js';
 
 export class Terminal {
   public id: number;
@@ -13,7 +9,7 @@ export class Terminal {
   public device: string;
   public version: string;
   public ip: string;
-  public location: LatLngObject;
+  public location: ApiLocationCoordinate;
   public timezone: number;
   public require_photo: boolean;
   public require_photo_breaks: boolean;

package/src/rotacloud.ts

@@ -66,3 +66,4 @@ export class RotaCloud {
 export { RetryStrategy, RetryOptions } from './services/service.js';
 export * from './interfaces/index.js';
 export * from './interfaces/query-params/index.js';
+export * from './models/index.js';

package/src/services/leave-request.service.ts

@@ -3,7 +3,7 @@ import { ApiLeaveRequest } from '../interfaces/index.js';
 import { Service, Options, RequirementsOf } from './index.js';
 
 import { ErrorResponse } from '../models/error-response.model.js';
-import { LeaveQueryParams } from '../interfaces/query-params/leave-query-params.interface.js';
+import { LeaveRequestsQueryParams } from '../interfaces/query-params/leave-requests-query-params.interface.js';
 
 import { LeaveRequest } from '../models/leave-request.model.js';
 
@@ -35,14 +35,14 @@ export class LeaveRequestService extends Service {
     );
   }
 
-  async *list(query?: LeaveQueryParams, options?: Options) {
+  async *list(query?: LeaveRequestsQueryParams, options?: Options) {
     for await (const res of super.iterator<ApiLeaveRequest>({ url: this.apiPath, params: query }, options)) {
       yield new LeaveRequest(res);
     }
   }
 
-  listAll(query?: LeaveQueryParams, options?: Options): Promise<LeaveRequest[]>;
-  async listAll(query: LeaveQueryParams, options?: Options) {
+  listAll(query?: LeaveRequestsQueryParams, options?: Options): Promise<LeaveRequest[]>;
+  async listAll(query: LeaveRequestsQueryParams, options?: Options) {
     const leave = [] as LeaveRequest[];
     for await (const leaveRequestRecord of this.list(query, options)) {
       leave.push(leaveRequestRecord);
@@ -50,7 +50,7 @@ export class LeaveRequestService extends Service {
     return leave;
   }
 
-  listByPage(query?: LeaveQueryParams, options?: Options) {
+  listByPage(query?: LeaveRequestsQueryParams, options?: Options) {
     return super.iterator<ApiLeaveRequest>({ url: `${this.apiPath}`, params: query }, options).byPage();
   }
 

package/src/version.ts

@@ -1 +1 @@
-export const Version = { version: '1.0.38' };
+export const Version = { version: '1.0.40' };