rotacloud 1.0.31 → 1.0.32

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

@@ -18,16 +18,11 @@ export class RolesService extends Service {
         }
     }
     async listAll(query, options) {
-        try {
-            const roles = [];
-            for await (const role of this.list(query, options)) {
-                roles.push(role);
-            }
-            return roles;
-        }
-        catch (err) {
-            return err;
+        const roles = [];
+        for await (const role of this.list(query, options)) {
+            roles.push(role);
         }
+        return roles;
     }
     listByPage(query, options) {
         return super.iterator({ url: this.apiPath, params: query }, options).byPage();

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

@@ -18,16 +18,11 @@ export class ShiftsService extends Service {
         }
     }
     async listAll(query, options) {
-        try {
-            const shifts = [];
-            for await (const shift of this.list(query, options)) {
-                shifts.push(shift);
-            }
-            return shifts;
-        }
-        catch (err) {
-            return err;
+        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();

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

@@ -18,16 +18,11 @@ class UsersService extends Service {
         }
     }
     async listAll(query, options) {
-        try {
-            const users = [];
-            for await (const user of this.list(query, options)) {
-                users.push(user);
-            }
-            return users;
-        }
-        catch (err) {
-            return err;
+        const users = [];
+        for await (const user of this.list(query, options)) {
+            users.push(user);
         }
+        return users;
     }
     listByPage(query, options) {
         return super.iterator({ url: this.apiPath, params: query }, options).byPage();

package/dist/mjs/version.js

@@ -1 +1 @@
-export const Version = { version: '1.0.31' };
+export const Version = { version: '1.0.32' };

package/package.json

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

package/src/interfaces/{day-notes.interface.ts → day-note.interface.ts}

@@ -1,4 +1,4 @@
-export interface ApiDayNotes {
+export interface ApiDayNote {
   id: number;
   start_date: string;
   end_date: string;

package/src/interfaces/index.ts

@@ -9,7 +9,7 @@ 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-notes.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';

package/src/interfaces/query-params/day-notes-query-params.interface.ts

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

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

@@ -1,6 +1,6 @@
 export interface ShiftsQueryParams {
-  start?: number;
-  end?: number;
+  start: number;
+  end: number;
   ids?: number[];
   users?: number[];
   locations?: number[];

package/src/models/day-note.model.ts

@@ -0,0 +1,19 @@
+import { ApiDayNote } from '../interfaces/index.js';
+
+export class DayNote {
+  public id: number;
+  public start_date: string;
+  public end_date: string;
+  public locations: number[];
+  public title: string;
+  public message: string;
+
+  constructor(dayNote: ApiDayNote) {
+    this.id = dayNote.id;
+    this.start_date = dayNote.start_date;
+    this.end_date = dayNote.end_date;
+    this.locations = dayNote.locations;
+    this.title = dayNote.title;
+    this.message = dayNote.message;
+  }
+}

package/src/rotacloud.ts

@@ -18,6 +18,7 @@ import {
   UsersService,
 } from './services/index.js';
 import { SDKConfig } from './interfaces/index.js';
+import { DayNotesService } from './services/day-notes.service.js';
 
 const DEFAULT_CONFIG: Partial<SDKConfig> = {
   baseUri: 'https://api.rotacloud.com/v1',
@@ -34,6 +35,7 @@ export class RotaCloud {
   public availability = new AvailabilityService();
   public dailyBudgets = new DailyBudgetsService();
   public dailyRevenue = new DailyRevenueService();
+  public dayNotes = new DayNotesService();
   public daysOff = new DaysOffService();
   public group = new GroupsService();
   public leaveEmbargoes = new LeaveEmbargoesService();

package/src/services/accounts.service.ts

@@ -26,15 +26,11 @@ class AccountsService extends Service {
 
   listAll(options?: Options): Promise<Account[]>;
   async listAll(options?: Options) {
-    try {
-      const accounts = [] as Account[];
-      for await (const account of this.list(options)) {
-        accounts.push(account);
-      }
-      return accounts;
-    } catch (err) {
-      return err;
+    const accounts = [] as Account[];
+    for await (const account of this.list(options)) {
+      accounts.push(account);
     }
+    return accounts;
   }
 
   listByPage(options?: Options) {

package/src/services/attendance.service.ts

@@ -42,15 +42,11 @@ export class AttendanceService extends Service {
 
   listAll(query: AttendanceQueryParams, options?: Options): Promise<Attendance[]>;
   async listAll(query: AttendanceQueryParams, options?: Options) {
-    try {
-      const attendance = [] as Attendance[];
-      for await (const atten of this.list(query, options)) {
-        attendance.push(atten);
-      }
-      return attendance;
-    } catch (err) {
-      return err;
+    const attendance = [] as Attendance[];
+    for await (const atten of this.list(query, options)) {
+      attendance.push(atten);
     }
+    return attendance;
   }
 
   listByPage(query: AttendanceQueryParams, options?: Options) {

package/src/services/daily-budgets.service.ts

@@ -17,15 +17,11 @@ export class DailyBudgetsService extends Service {
 
   listAll(query: DailyBudgetsQueryParams, options?: Options): Promise<DailyBudgets[]>;
   async listAll(query: DailyBudgetsQueryParams, options?: Options) {
-    try {
-      const attendance = [] as DailyBudgets[];
-      for await (const atten of this.list(query, options)) {
-        attendance.push(atten);
-      }
-      return attendance;
-    } catch (err) {
-      return err;
+    const attendance = [] as DailyBudgets[];
+    for await (const atten of this.list(query, options)) {
+      attendance.push(atten);
     }
+    return attendance;
   }
 
   listByPage(query: DailyBudgetsQueryParams, options?: Options) {

package/src/services/daily-revenue.service.ts

@@ -17,15 +17,11 @@ export class DailyRevenueService extends Service {
 
   listAll(query: DailyRevenueQueryParams, options?: Options): Promise<DailyRevenue[]>;
   async listAll(query: DailyRevenueQueryParams, options?: Options) {
-    try {
-      const attendance = [] as DailyRevenue[];
-      for await (const atten of this.list(query, options)) {
-        attendance.push(atten);
-      }
-      return attendance;
-    } catch (err) {
-      return err;
+    const attendance = [] as DailyRevenue[];
+    for await (const atten of this.list(query, options)) {
+      attendance.push(atten);
     }
+    return attendance;
   }
 
   listByPage(query: DailyRevenueQueryParams, options?: Options) {

package/src/services/day-notes.service.ts

@@ -0,0 +1,81 @@
+import { AxiosResponse } from 'axios';
+import { ApiDayNote } from '../interfaces/index.js';
+import { Service, Options } from './index.js';
+
+import { ErrorResponse } from '../models/error-response.model.js';
+
+import { DayNote } from '../models/day-note.model.js';
+import { DayNotesQueryParams } from '../interfaces/query-params/day-notes-query-params.interface';
+
+export class DayNotesService extends Service {
+  private apiPath = '/day_notes';
+
+  create(data: ApiDayNote): Promise<DayNote>;
+  create(data: ApiDayNote, options: { rawResponse: true } & Options): Promise<AxiosResponse<ApiDayNote, any>>;
+  create(data: ApiDayNote, options: Options): Promise<DayNote>;
+  create(data: ApiDayNote, options?: Options) {
+    return super.fetch<ApiDayNote>({ url: this.apiPath, data, method: 'POST' }).then(
+      (res) => Promise.resolve(options?.rawResponse ? res : new DayNote(res.data)),
+      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
+    );
+  }
+
+  get(id: number): Promise<DayNote>;
+  get(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<ApiDayNote, any>>;
+  get(id: number, options: Options): Promise<DayNote>;
+  get(id: number, options?: Options) {
+    return super.fetch<ApiDayNote>({ url: `${this.apiPath}/${id}` }, options).then(
+      (res) => Promise.resolve(options?.rawResponse ? res : new DayNote(res.data)),
+      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
+    );
+  }
+
+  async *list(query: DayNotesQueryParams, options?: Options) {
+    for await (const res of super.iterator<ApiDayNote>({ url: this.apiPath, params: query }, options)) {
+      yield new DayNote(res);
+    }
+  }
+
+  listAll(query: DayNotesQueryParams, options?: Options): Promise<DayNote[]>;
+  async listAll(query: DayNotesQueryParams, options?: Options) {
+    const dayNotes: DayNote[] = [];
+    for await (const dayNote of this.list(query, options)) {
+      dayNotes.push(dayNote);
+    }
+    return dayNotes;
+  }
+
+  listByPage(query: DayNotesQueryParams, options?: Options) {
+    return super.iterator<ApiDayNote>({ url: this.apiPath, params: query }, options).byPage();
+  }
+
+  update(id: number, data: Partial<ApiDayNote>): Promise<DayNote>;
+  update(
+    id: number,
+    data: Partial<ApiDayNote>,
+    options: { rawResponse: true } & Options
+  ): Promise<AxiosResponse<ApiDayNote, any>>;
+  update(id: number, data: Partial<ApiDayNote>, options: Options): Promise<DayNote>;
+  update(id: number, data: Partial<ApiDayNote>, options?: Options) {
+    return super
+      .fetch<ApiDayNote>({
+        url: `${this.apiPath}/${id}`,
+        data,
+        method: 'POST',
+      })
+      .then(
+        (res) => Promise.resolve(options?.rawResponse ? res : new DayNote(res.data)),
+        (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
+      );
+  }
+
+  delete(id: number): Promise<number>;
+  delete(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<any, any>>;
+  delete(id: number, options: Options): Promise<number>;
+  delete(id: number, options?: Options) {
+    return super.fetch<ApiDayNote>({ url: `${this.apiPath}/${id}`, method: 'DELETE' }).then(
+      (res) => Promise.resolve(options?.rawResponse ? res : res.status),
+      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
+    );
+  }
+}

package/src/services/days-off.service.ts

@@ -41,15 +41,11 @@ export class DaysOffService extends Service<ApiDaysOff> {
 
   listAll(query: DaysOffQueryParams, options?: Options): Promise<DaysOff[]>;
   async listAll(query: DaysOffQueryParams, options?: Options) {
-    try {
-      const daysOff = [] as DaysOff[];
-      for await (const dayOff of this.list(query, options)) {
-        daysOff.push(dayOff);
-      }
-      return daysOff;
-    } catch (err) {
-      return err;
+    const daysOff = [] as DaysOff[];
+    for await (const dayOff of this.list(query, options)) {
+      daysOff.push(dayOff);
     }
+    return daysOff;
   }
 
   listByPage(query: DaysOffQueryParams, options?: Options) {

package/src/services/groups.service.ts

@@ -35,26 +35,22 @@ export class GroupsService extends Service {
     );
   }
 
-  async *list(query: GroupsQueryParams, options?: Options) {
+  async *list(query?: GroupsQueryParams, options?: Options) {
     for await (const res of super.iterator<ApiGroup>({ url: this.apiPath, params: query }, options)) {
       yield new Group(res);
     }
   }
 
-  listAll(query: GroupsQueryParams, options?: Options): Promise<Group[]>;
+  listAll(query?: GroupsQueryParams, options?: Options): Promise<Group[]>;
   async listAll(query: GroupsQueryParams, options?: Options) {
-    try {
-      const groups = [] as Group[];
-      for await (const group of this.list(query, options)) {
-        groups.push(group);
-      }
-      return groups;
-    } catch (err) {
-      return err;
+    const groups = [] as Group[];
+    for await (const group of this.list(query, options)) {
+      groups.push(group);
     }
+    return groups;
   }
 
-  listByPage(query: GroupsQueryParams, options?: Options) {
+  listByPage(query?: GroupsQueryParams, options?: Options) {
     return super.iterator<ApiGroup>({ url: this.apiPath, params: query }, options).byPage();
   }
 

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

@@ -42,15 +42,11 @@ export class LeaveEmbargoesService extends Service {
 
   listAll(query: LeaveEmbargoesQueryParams, options?: Options): Promise<LeaveEmbargo[]>;
   async listAll(query: LeaveEmbargoesQueryParams, options?: Options) {
-    try {
-      const leave = [] as LeaveEmbargo[];
-      for await (const leaveEmbargoRecord of this.list(query, options)) {
-        leave.push(leaveEmbargoRecord);
-      }
-      return leave;
-    } catch (err) {
-      return err;
+    const leave = [] as LeaveEmbargo[];
+    for await (const leaveEmbargoRecord of this.list(query, options)) {
+      leave.push(leaveEmbargoRecord);
     }
+    return leave;
   }
 
   listByPage(query: LeaveEmbargoesQueryParams, options?: Options) {

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

@@ -35,27 +35,23 @@ export class LeaveRequestService extends Service {
     );
   }
 
-  async *list(query: LeaveQueryParams, options?: Options) {
+  async *list(query?: LeaveQueryParams, 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[]>;
+  listAll(query?: LeaveQueryParams, options?: Options): Promise<LeaveRequest[]>;
   async listAll(query: LeaveQueryParams, options?: Options) {
-    try {
-      const leave = [] as LeaveRequest[];
-      for await (const leaveRequestRecord of this.list(query, options)) {
-        leave.push(leaveRequestRecord);
-      }
-      return leave;
-    } catch (err) {
-      return err;
+    const leave = [] as LeaveRequest[];
+    for await (const leaveRequestRecord of this.list(query, options)) {
+      leave.push(leaveRequestRecord);
     }
+    return leave;
   }
 
-  listByPage(options?: Options) {
-    return super.iterator<ApiLeaveRequest>({ url: `${this.apiPath}` }, options).byPage();
+  listByPage(query?: LeaveQueryParams, options?: Options) {
+    return super.iterator<ApiLeaveRequest>({ url: `${this.apiPath}`, params: query }, options).byPage();
   }
 
   update(id: number, data: Partial<ApiLeaveRequest>): Promise<LeaveRequest>;

package/src/services/leave.service.ts

@@ -44,15 +44,11 @@ export class LeaveService extends Service {
 
   listAll(query: LeaveQueryParams, options?: Options): Promise<Leave[]>;
   async listAll(query: LeaveQueryParams, options?: Options) {
-    try {
-      const leave = [] as Leave[];
-      for await (const leaveRecord of this.list(query, options)) {
-        leave.push(leaveRecord);
-      }
-      return leave;
-    } catch (err) {
-      return err;
+    const leave = [] as Leave[];
+    for await (const leaveRecord of this.list(query, options)) {
+      leave.push(leaveRecord);
     }
+    return leave;
   }
 
   async *listLeaveTypes(query: LeaveQueryParams, options?: Options) {

package/src/services/locations.service.ts

@@ -34,26 +34,22 @@ export class LocationsService extends Service {
     );
   }
 
-  async *list(query: LocationsQueryParams, options?: Options) {
+  async *list(query?: LocationsQueryParams, options?: Options) {
     for await (const res of super.iterator<ApiLocation>({ url: this.apiPath, params: query }, options)) {
       yield new Location(res);
     }
   }
 
-  listAll(query: LocationsQueryParams, options?: Options): Promise<Location[]>;
+  listAll(query?: LocationsQueryParams, options?: Options): Promise<Location[]>;
   async listAll(query: LocationsQueryParams, options?: Options) {
-    try {
-      const locations = [] as Location[];
-      for await (const location of this.list(query, options)) {
-        locations.push(location);
-      }
-      return locations;
-    } catch (err) {
-      return err;
+    const locations = [] as Location[];
+    for await (const location of this.list(query, options)) {
+      locations.push(location);
     }
+    return locations;
   }
 
-  listByPage(query: LocationsQueryParams, options?: Options) {
+  listByPage(query?: LocationsQueryParams, options?: Options) {
     return super.iterator<ApiLocation>({ url: this.apiPath, params: query }, options).byPage();
   }
 

package/src/services/roles.service.ts

@@ -34,26 +34,22 @@ export class RolesService extends Service {
     );
   }
 
-  async *list(query: RolesQueryParams, options?: Options) {
+  async *list(query?: RolesQueryParams, options?: Options) {
     for await (const res of super.iterator<ApiRole>({ url: this.apiPath, params: query }, options)) {
       yield new Role(res);
     }
   }
 
-  listAll(query: RolesQueryParams, options?: Options): Promise<Role[]>;
+  listAll(query?: RolesQueryParams, options?: Options): Promise<Role[]>;
   async listAll(query: RolesQueryParams, options?: Options) {
-    try {
-      const roles = [] as Role[];
-      for await (const role of this.list(query, options)) {
-        roles.push(role);
-      }
-      return roles;
-    } catch (err) {
-      return err;
+    const roles = [] as Role[];
+    for await (const role of this.list(query, options)) {
+      roles.push(role);
     }
+    return roles;
   }
 
-  listByPage(query: RolesQueryParams, options?: Options) {
+  listByPage(query?: RolesQueryParams, options?: Options) {
     return super.iterator<ApiRole>({ url: this.apiPath, params: query }, options).byPage();
   }
   update(id: number, data: Partial<ApiRole>): Promise<Role>;

package/src/services/shifts.service.ts

@@ -42,15 +42,11 @@ export class ShiftsService extends Service {
 
   listAll(query: ShiftsQueryParams, options?: Options): Promise<Shift[]>;
   async listAll(query: ShiftsQueryParams, options?: Options) {
-    try {
-      const shifts = [] as Shift[];
-      for await (const shift of this.list(query, options)) {
-        shifts.push(shift);
-      }
-      return shifts;
-    } catch (err) {
-      return err;
+    const shifts = [] as Shift[];
+    for await (const shift of this.list(query, options)) {
+      shifts.push(shift);
     }
+    return shifts;
   }
 
   listByPage(query: ShiftsQueryParams, options?: Options) {

package/src/services/users.service.ts

@@ -42,15 +42,11 @@ class UsersService extends Service {
 
   listAll(query: UsersQueryParams, options?: Options): Promise<User[]>;
   async listAll(query: UsersQueryParams, options?: Options) {
-    try {
-      const users = [] as User[];
-      for await (const user of this.list(query, options)) {
-        users.push(user);
-      }
-      return users;
-    } catch (err) {
-      return err;
+    const users = [] as User[];
+    for await (const user of this.list(query, options)) {
+      users.push(user);
     }
+    return users;
   }
 
   listByPage(query: UsersQueryParams, options?: Options) {

package/src/version.ts

@@ -1 +1 @@
-export const Version = { version: '1.0.31' };
+export const Version = { version: '1.0.32' };

package/dist/cjs/models/day-notes.model.js

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

package/dist/mjs/models/day-notes.model.js

@@ -1,5 +0,0 @@
-export class DayNotes {
-    constructor(dayNotes) {
-        this.id = dayNotes.id;
-    }
-}

package/src/models/day-notes.model.ts

@@ -1,14 +0,0 @@
-import { ApiDayNotes } from '../interfaces/index.js';
-
-export class DayNotes {
-  public id: number;
-  public start_date: string;
-  public end_date: string;
-  public locations: number[];
-  public title: string;
-  public message: string;
-
-  constructor(dayNotes: ApiDayNotes) {
-    this.id = dayNotes.id;
-  }
-}