rotacloud 1.0.58 → 1.1.1

package/src/interfaces/availability-pattern.interface.ts

@@ -1,8 +1,8 @@
-import { ApiAvailabilityPeriod } from './index.js';
+import { AvailabilityPeriod } from './index.js';
 
-export interface ApiAvailabilityPatternAvailability {
-  available: ApiAvailabilityPeriod[];
-  unavailable: ApiAvailabilityPeriod[];
+export interface AvailabilityPatternAvailability {
+  available: AvailabilityPeriod[];
+  unavailable: AvailabilityPeriod[];
 }
 
 export interface ApiAvailabilityPattern {
@@ -12,11 +12,11 @@ export interface ApiAvailabilityPattern {
   start_date: string;
   end_date: string;
   repeat_weeks: number;
-  mon: ApiAvailabilityPatternAvailability;
-  tue: ApiAvailabilityPatternAvailability;
-  wed: ApiAvailabilityPatternAvailability;
-  thu: ApiAvailabilityPatternAvailability;
-  fri: ApiAvailabilityPatternAvailability;
-  sat: ApiAvailabilityPatternAvailability;
-  sun: ApiAvailabilityPatternAvailability;
+  mon: AvailabilityPatternAvailability;
+  tue: AvailabilityPatternAvailability;
+  wed: AvailabilityPatternAvailability;
+  thu: AvailabilityPatternAvailability;
+  fri: AvailabilityPatternAvailability;
+  sat: AvailabilityPatternAvailability;
+  sun: AvailabilityPatternAvailability;
 }

package/src/interfaces/availability.interface.ts

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

package/src/interfaces/daily-budgets.interface.ts

@@ -1,4 +1,4 @@
-export interface ApiDailyBudgets {
+export interface DailyBudgets {
   date: string;
   location: number;
   hours_budget: number;

package/src/interfaces/daily-revenue.interface.ts

@@ -1,4 +1,4 @@
-export interface ApiDailyRevenue {
+export interface DailyRevenue {
   date: string;
   location: number;
   labour_percentage: number;

package/src/interfaces/day-note.interface.ts

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

package/src/interfaces/days-off-pattern.interface.ts

@@ -1,4 +1,4 @@
-export interface ApiDaysOffPattern {
+export interface DaysOffPattern {
   id: number;
   user: number;
   start_date: string;

package/src/interfaces/days-off.interface.ts

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

package/src/interfaces/group.interface.ts

@@ -1,4 +1,4 @@
-export interface ApiGroup {
+export interface Group {
   id: number;
   name: string;
   users: number[];

package/src/interfaces/holiday_allowance.interface.ts

@@ -1,4 +1,4 @@
-export interface ApiHolidayAllowance {
+export interface HolidayAllowance {
   user: number;
   default_holiday_allowance: number;
   default_holiday_allowance_unit: string;

package/src/interfaces/leave-date.interface.ts

@@ -1,6 +1,6 @@
-export interface ApiLeaveDate {
+export interface LeaveDate {
   date: string;
-  year: string;
+  year: number;
   days: number;
   hours: number | null;
   day_off: boolean;

package/src/interfaces/leave-embargo.interface.ts

@@ -1,4 +1,4 @@
-export interface ApiLeaveEmbargo {
+export interface LeaveEmbargo {
   id: number;
   start_date: string;
   start_am_pm: string;

package/src/interfaces/leave-rate.interface.ts

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

package/src/interfaces/leave-request.interface.ts

@@ -1,14 +1,22 @@
-import { ApiLeaveDate } from './leave-date.interface';
+import { LeaveDate } from './leave-date.interface';
 
-export interface ApiLeaveRequest {
+export interface LeaveRequest {
   id: number;
   deleted: boolean;
+  deleted_at: number | null;
+  deleted_by: number | null;
+  requested_at: number;
   type: number;
+  paid: boolean;
   user: number;
+  status: 'approved' | 'denied' | 'expired' | 'requested' | 'pending';
   user_message: string | null;
   start_date: string;
   start_am_pm: string;
   end_date: string;
   end_am_pm: string;
-  dates: ApiLeaveDate[];
+  hours: { [year: number]: number | null };
+  hours_method: string;
+  hours_set: boolean;
+  dates: LeaveDate[];
 }

package/src/interfaces/leave-type.interface.ts

@@ -1,4 +1,4 @@
-export interface ApiLeaveType {
+export interface LeaveType {
   id: number;
   name: string;
   short_name: string;

package/src/interfaces/leave.interface.ts

@@ -1,28 +1,10 @@
-import { ApiLeaveDate } from './index.js';
+import { LeaveRequest } from './leave-request.interface';
 
-export interface ApiLeave {
-  id: number;
-  deleted: boolean;
-  deleted_at: number | null;
-  deleted_by: number | null;
-  type: number;
-  user: number;
+export interface Leave extends LeaveRequest {
   admin: number;
-  status: string;
-  requested: boolean;
-  user_message: string | null;
   admin_message: string | null;
-  start_date: string;
-  start_am_pm: string;
-  end_date: string;
-  end_am_pm: string;
-  hours: { [key: string]: number | null };
-  hours_method: string;
-  hours_set: boolean;
-  dates: ApiLeaveDate[];
-  requested_at: number;
-  paid: boolean;
   replied_at: number;
+  requested: boolean;
   // for creating leave
   users?: number[];
 }

package/src/interfaces/location-coordinate.interface.ts

@@ -1,4 +1,4 @@
-export interface ApiLocationCoordinate {
+export interface LocationCoordinate {
   lat: number;
   lng: number;
   radius: number;

package/src/interfaces/location.interface.ts

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

package/src/interfaces/logbook-category.interface.ts

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

package/src/interfaces/logbook-event.interface.ts

@@ -1,4 +1,4 @@
-export interface ApiLogbookEvent {
+export interface LogbookEvent {
   id: number;
   created_at: number;
   created_by: number;

package/src/interfaces/pay-period.interface.ts

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

package/src/interfaces/pin.interface.ts

@@ -1,8 +1,8 @@
-import { ApiUser } from './index.js';
+import { User } from './index.js';
 
-export interface ApiPin
+export interface Pin
   extends Omit<
-    ApiUser,
+    User,
     | 'created_at'
     | 'created_by'
     | 'deleted_at'

package/src/interfaces/role-rate.interface.ts

@@ -1,4 +1,4 @@
-export interface ApiRoleRate {
+export interface RoleRate {
   [key: string]: {
     per_hour: number;
     per_shift: number;

package/src/interfaces/role.interface.ts

@@ -1,4 +1,4 @@
-export interface ApiRole {
+export interface Role {
   id: number;
   deleted: boolean;
   name: string;

package/src/interfaces/settings.interface.ts

@@ -2,7 +2,7 @@ export interface PayCodes {
   [pay_code_id: string]: string | { [leave_type_id: string]: string };
 }
 
-export interface ApiSettings {
+export interface Settings {
   attendance_record_breaks: string;
   automatically_clock_in_to_consecutive_shifts: boolean;
   availability_employees_can_edit: boolean;

package/src/interfaces/shift.interface.ts

@@ -1,4 +1,4 @@
-export interface ApiShift {
+export interface Shift {
   id: number;
   deleted: boolean;
   deleted_at: number | null;

package/src/interfaces/terminal.interface.ts

@@ -1,4 +1,4 @@
-export interface ApiTerminal {
+export interface Terminal {
   id: number;
   deleted: boolean;
   name: string;
@@ -7,7 +7,7 @@ export interface ApiTerminal {
   device: string | null;
   version: string | null;
   ip: string | null;
-  location: ApiTerminalLocation | null;
+  location: TerminalLocation | null;
   timezone: number;
   require_photo: boolean;
   require_photo_breaks: boolean;
@@ -15,7 +15,7 @@ export interface ApiTerminal {
   secret: string | null;
 }
 
-export interface ApiTerminalLocation {
+export interface TerminalLocation {
   lat: number;
   lng: number;
   accuracy: number;

package/src/interfaces/toil-accrual.interface.ts

@@ -1,4 +1,4 @@
-export interface ApiToilAccrual {
+export interface ToilAccrual {
   comments: string;
   created_at: number;
   created_by: number | null;

package/src/interfaces/toil-allowance.interface.ts

@@ -1,4 +1,4 @@
-export interface ApiToilAllowance {
+export interface ToilAllowance {
   user: number;
   accrued_hours: number;
   remaining_hours: number;

package/src/interfaces/user.interface.ts

@@ -1,6 +1,6 @@
-import { ApiLeaveRate, ApiRoleRate, ApiTerminalLocation } from './index.js';
+import { LeaveRate, RoleRate, TerminalLocation } from './index.js';
 
-export interface ApiUser {
+export interface User {
   id: number;
   created_at: number;
   created_by: number;
@@ -31,17 +31,17 @@ export interface ApiUser {
   salary: number;
   salary_type: string;
   overtime_rate: number;
-  role_rates: ApiLeaveRate;
-  leave_rates: ApiRoleRate;
+  role_rates: LeaveRate;
+  leave_rates: RoleRate;
   leave_rates_unit: string;
   leave_rates_type: string;
   notes: string | null;
   pin: string | null;
 }
 
-export interface ApiUserBreak {
+export interface UserBreak {
   start_time: number;
-  start_location: ApiTerminalLocation;
+  start_location: TerminalLocation;
   end_time?: number;
-  end_location?: ApiTerminalLocation;
+  end_location?: TerminalLocation;
 }

package/src/interfaces/users-clocked-in.interface.ts

@@ -1,14 +1,14 @@
-import { ApiShift, ApiTerminalLocation } from '../interfaces/index.js';
+import { Shift, TerminalLocation } from '../interfaces/index.js';
 
-export interface ApiUserClockedIn {
+export interface UserClockedIn {
   user: number;
   location: number;
   role: number;
   in_time: number;
   minutes_late: number;
-  shift: Pick<ApiShift, 'id' | 'start_time' | 'end_time' | 'minutes_break' | 'location' | 'role'>;
+  shift: Pick<Shift, 'id' | 'start_time' | 'end_time' | 'minutes_break' | 'location' | 'role'>;
   in_method: string;
-  in_location: ApiTerminalLocation;
+  in_location: TerminalLocation;
   in_device: string | null;
   in_terminal: number | null;
 }

package/src/interfaces/users-clocked-out.interface.ts

@@ -1,6 +1,6 @@
-import { ApiShift, ApiTerminalLocation } from './index.js';
+import { Shift, TerminalLocation } from './index.js';
 
-export interface ApiUserClockedOut {
+export interface UserClockedOut {
   id: number;
   deleted: boolean;
   approved: boolean;
@@ -15,13 +15,13 @@ export interface ApiUserClockedOut {
   hours_auto: number;
   hours_is_auto: boolean;
   notes: string | null;
-  shift: Pick<ApiShift, 'id' | 'start_time' | 'end_time' | 'minutes_break' | 'location' | 'role'>;
+  shift: Pick<Shift, 'id' | 'start_time' | 'end_time' | 'minutes_break' | 'location' | 'role'>;
   in_method: string;
-  in_location: ApiTerminalLocation;
+  in_location: TerminalLocation;
   in_device: string | null;
   in_terminal: number | null;
   out_method: string;
-  out_location: ApiTerminalLocation;
+  out_location: TerminalLocation;
   out_device: string | null;
   out_terminal: number | null;
 }

package/src/models/index.ts

@@ -1,33 +1 @@
-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 './SDKError.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 './toil-accrual.model.js';
-export * from './toil-allowance.model.js';
-export * from './user.model.js';
-export * from './users-clocked-in.model.js';
-export * from './users-clocked-out.model.js';

package/src/services/accounts.service.ts

@@ -1,24 +1,23 @@
 import { AxiosResponse } from 'axios';
-import { Account } from '../models/account.model.js';
 import { Service, Options } from './index.js';
 
-import { ApiAccount } from '../interfaces/index.js';
+import { Account } from '../interfaces/index.js';
 
-class AccountsService extends Service {
+export class AccountsService extends Service {
   private apiPath = '/accounts';
 
   get(id: number): Promise<Account>;
-  get(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<ApiAccount, any>>;
+  get(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<Account, any>>;
   get(id: number, options: Options): Promise<Account>;
   get(id: number, options?: Options) {
     return super
-      .fetch<ApiAccount>({ url: `${this.apiPath}/${id}` }, options)
-      .then((res) => Promise.resolve(options?.rawResponse ? res : new Account(res.data)));
+      .fetch<Account>({ url: `${this.apiPath}/${id}` }, options)
+      .then((res) => Promise.resolve(options?.rawResponse ? res : res.data));
   }
 
   async *list(options?: Options) {
-    for await (const res of super.iterator<ApiAccount>({ url: this.apiPath }, options)) {
-      yield new Account(res);
+    for await (const res of super.iterator<Account>({ url: this.apiPath }, options)) {
+      yield res;
     }
   }
 
@@ -32,8 +31,6 @@ class AccountsService extends Service {
   }
 
   listByPage(options?: Options) {
-    return super.iterator<ApiAccount>({ url: this.apiPath }, options).byPage();
+    return super.iterator<Account>({ url: this.apiPath }, options).byPage();
   }
 }
-
-export { AccountsService };

package/src/services/attendance.service.ts

@@ -1,8 +1,7 @@
 import { AxiosResponse } from 'axios';
-import { ApiAttendance } from '../interfaces/index.js';
+import { Attendance } from '../interfaces/index.js';
 import { Service, Options, RequirementsOf } from './index.js';
 
-import { Attendance } from '../models/attendance.model.js';
 import { AttendanceQueryParams } from '../interfaces/query-params/attendance-query-params.interface.js';
 
 type RequiredProps = 'user' | 'in_time';
@@ -10,28 +9,30 @@ type RequiredProps = 'user' | 'in_time';
 export class AttendanceService extends Service {
   private apiPath = '/attendance';
 
-  create(data: RequirementsOf<ApiAttendance, RequiredProps>): Promise<Attendance>;
+  create(data: RequirementsOf<Attendance, RequiredProps>): Promise<Attendance>;
   create(
-    data: RequirementsOf<ApiAttendance, RequiredProps>,
-    options: { rawResponse: true } & Options
-  ): Promise<AxiosResponse<ApiAttendance, any>>;
-  create(data: RequirementsOf<ApiAttendance, RequiredProps>, options: Options): Promise<ApiAttendance>;
-  create(data: RequirementsOf<ApiAttendance, RequiredProps>, options?: Options) {
+    data: RequirementsOf<Attendance, RequiredProps>,
+    options: { rawResponse: true } & Options,
+  ): Promise<AxiosResponse<Attendance, any>>;
+  create(data: RequirementsOf<Attendance, RequiredProps>, options: Options): Promise<Attendance>;
+  create(data: RequirementsOf<Attendance, RequiredProps>, options?: Options) {
     return super
-      .fetch<ApiAttendance>({ url: this.apiPath, data, method: 'POST' })
-      .then((res) => Promise.resolve(options?.rawResponse ? res : new Attendance(res.data)));
+      .fetch<Attendance>({ url: this.apiPath, data, method: 'POST' })
+      .then((res) => Promise.resolve(options?.rawResponse ? res : res.data));
   }
 
   get(id: number): Promise<Attendance>;
-  get(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<ApiAttendance, any>>;
+  get(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<Attendance, any>>;
   get(id: number, options: Options): Promise<Attendance>;
   get(id: number, options?: Options) {
-    return super.fetch<ApiAttendance>({ url: `${this.apiPath}/${id}` }, options).then((res) => Promise.resolve(options?.rawResponse ? res : new Attendance(res.data)));
+    return super
+      .fetch<Attendance>({ url: `${this.apiPath}/${id}` }, options)
+      .then((res) => Promise.resolve(options?.rawResponse ? res : res.data));
   }
 
   async *list(query: AttendanceQueryParams, options?: Options) {
-    for await (const res of super.iterator<ApiAttendance>({ url: this.apiPath, params: query }, options)) {
-      yield new Attendance(res);
+    for await (const res of super.iterator<Attendance>({ url: this.apiPath, params: query }, options)) {
+      yield res;
     }
   }
 
@@ -45,32 +46,32 @@ export class AttendanceService extends Service {
   }
 
   listByPage(query: AttendanceQueryParams, options?: Options) {
-    return super.iterator<ApiAttendance>({ url: this.apiPath, params: query }, options).byPage();
+    return super.iterator<Attendance>({ url: this.apiPath, params: query }, options).byPage();
   }
 
-  update(id: number, data: Partial<ApiAttendance>): Promise<Attendance>;
+  update(id: number, data: Partial<Attendance>): Promise<Attendance>;
   update(
     id: number,
-    data: Partial<ApiAttendance>,
-    options: { rawResponse: true } & Options
-  ): Promise<AxiosResponse<ApiAttendance, any>>;
-  update(id: number, data: Partial<ApiAttendance>, options: Options): Promise<Attendance>;
-  update(id: number, data: Partial<ApiAttendance>, options?: Options) {
+    data: Partial<Attendance>,
+    options: { rawResponse: true } & Options,
+  ): Promise<AxiosResponse<Attendance, any>>;
+  update(id: number, data: Partial<Attendance>, options: Options): Promise<Attendance>;
+  update(id: number, data: Partial<Attendance>, options?: Options) {
     return super
-      .fetch<ApiAttendance>({
+      .fetch<Attendance>({
         url: `${this.apiPath}/${id}`,
         data,
         method: 'POST',
       })
-      .then((res) => Promise.resolve(options?.rawResponse ? res : new Attendance(res.data)));
+      .then((res) => Promise.resolve(options?.rawResponse ? res : res.data));
   }
 
   delete(id: number): Promise<number>;
-  delete(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<ApiAttendance, any>>;
+  delete(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<Attendance, any>>;
   delete(id: number, options: Options): Promise<number>;
   delete(id: number, options?: Options) {
     return super
-      .fetch<ApiAttendance>({ url: `${this.apiPath}/${id}`, method: 'DELETE' })
+      .fetch<Attendance>({ url: `${this.apiPath}/${id}`, method: 'DELETE' })
       .then((res) => Promise.resolve(options?.rawResponse ? res : res.status));
   }
 }

package/src/services/auth.service.ts

@@ -1,17 +1,15 @@
 import { AxiosResponse } from 'axios';
-import { ApiAuth } from '../interfaces/index.js';
+import { Auth } from '../interfaces/index.js';
 import { Service, Options } from './index.js';
 
-import { Auth } from '../models/auth.model.js';
-
 export class AuthService extends Service {
   private apiPath = '/auth';
 
-  get(options?: { rawResponse: true } & Options): Promise<AxiosResponse<ApiAuth, any>>;
+  get(options?: { rawResponse: true } & Options): Promise<AxiosResponse<Auth, any>>;
   get(options?: Options): Promise<Auth>;
   get(options?: Options) {
     return super
-      .fetch<ApiAuth>({ url: this.apiPath }, options)
-      .then((res) => Promise.resolve(options?.rawResponse ? res : new Auth(res.data)));
+      .fetch<Auth>({ url: this.apiPath }, options)
+      .then((res) => Promise.resolve(options?.rawResponse ? res : res.data));
   }
 }