rotacloud 2.2.4 → 2.2.6

package/dist/endpoint.d.ts

@@ -1,4 +1,4 @@
-import { Account, Attendance, Auth, Availability, DailyBudgets, DailyRevenue, DayNote, DaysOff, Group, Leave, Role, Shift, TimeZone, Document, LeaveEmbargo, LeaveRequest, LeaveType, Location, Pin, Terminal, ToilAccrual, ToilAllowance, UserClockedIn, User, Settings, LogbookCategory, DayNoteV2, DayNoteV2QueryParameters } from './interfaces/index.js';
+import { Account, Attendance, Auth, Availability, DailyBudgets, DailyRevenue, DayNote, DaysOff, Group, Leave, Role, Shift, TimeZone, Document, LeaveEmbargo, LeaveRequest, LeaveType, Location, Pin, Terminal, ToilAccrual, ToilAllowance, UserClockedIn, User, Settings, LogbookCategory, DayNoteV2, DayNoteV2QueryParameters, PartialUserV2 } from './interfaces/index.js';
 import { LogbookEntry, LogbookQueryParameters } from './interfaces/logbook.interface.js';
 import { Message } from './interfaces/message.interface.js';
 import { AttendanceQueryParams, AvailabilityQueryParams, DailyBudgetsQueryParams, DailyRevenueQueryParams, DayNotesQueryParams, DaysOffQueryParams, DocumentsQueryParams, GroupsQueryParams, LeaveEmbargoesQueryParams, LeaveQueryParams, LeaveRequestsQueryParams, LocationsQueryParams, RolesQueryParams, SettingsQueryParams, ShiftsQueryParams, TerminalsQueryParams, ToilAccrualsQueryParams, ToilAllowanceQueryParams, UsersQueryParams } from './interfaces/query-params/index.js';
@@ -59,5 +59,9 @@ export interface EndpointEntityMap extends Record<EndpointVersion, Record<string
         invoices: Endpoint<Invoice, InvoiceQueryParameters>;
         dayNotes: Endpoint<DayNoteV2, DayNoteV2QueryParameters, 'title' | 'message' | 'startDate' | 'endDate' | 'locations' | 'visibleToEmployees'>;
         'logbook/categories': Endpoint<LogbookCategory, undefined, Pick<LogbookCategory, 'name'>>;
+        users: Endpoint<User, undefined, {
+            users: RequirementsOf<PartialUserV2, 'firstName' | 'lastName' | 'roles'>[];
+            sendInvite?: boolean;
+        }>;
     };
 }

package/dist/interfaces/index.d.ts

@@ -34,6 +34,7 @@ export * from './time-zone.interface.js';
 export * from './toil-accrual.interface.js';
 export * from './toil-allowance.interface.js';
 export * from './user.interface.js';
+export * from './user-v2.interface.js';
 export * from './users-clocked-in.interface.js';
 export * from './users-clocked-out.interface.js';
 export * from './document.interface.js';

package/dist/interfaces/index.js

@@ -34,6 +34,7 @@ export * from './time-zone.interface.js';
 export * from './toil-accrual.interface.js';
 export * from './toil-allowance.interface.js';
 export * from './user.interface.js';
+export * from './user-v2.interface.js';
 export * from './users-clocked-in.interface.js';
 export * from './users-clocked-out.interface.js';
 export * from './document.interface.js';

package/dist/interfaces/user-v2.interface.d.ts

@@ -0,0 +1,26 @@
+import { ManagerPermission } from './user.interface.js';
+export interface CreateUserRequest extends PartialUserV2 {
+    permissions?: ManagerPermission[];
+    coverLocations?: number[];
+    managedLocations?: number[];
+}
+export interface CreateUserResponse extends PartialUserV2 {
+    id: number;
+}
+export interface PartialUserV2 {
+    firstName: string;
+    lastName: string;
+    locations: number[];
+    roles: UserRole[];
+    email: string | null;
+    level: 'admin' | 'employee' | 'manager';
+    salary: number;
+    salaryType: 'annual' | 'hourly';
+}
+export interface UserRole {
+    id: number;
+    perShift?: number;
+    perHour?: number;
+    payCode?: string;
+    isDefault?: boolean;
+}

package/dist/interfaces/user-v2.interface.js

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

package/dist/main.d.ts

@@ -239,4 +239,15 @@ export declare const createRotaCloudClient: (config: import("./interfaces/sdk-co
         endpointVersion: "v1";
         operations: ("get" | "delete" | "list" | "listAll" | "create" | "update")[];
     };
+    userV2: {
+        endpoint: "users";
+        endpointVersion: "v2";
+        operations: "create"[];
+        customOperations: {
+            create: ({ request, service }: import("./ops.js").OperationContext, userSpec: {
+                users: import("./utils.js").RequirementsOf<import("./interfaces/user-v2.interface.js").CreateUserRequest, "firstName" | "lastName" | "roles">[];
+                sendInvite?: boolean;
+            }) => import("./ops.js").RequestConfig<typeof userSpec, import("./interfaces/user-v2.interface.js").CreateUserResponse>;
+        };
+    };
 }>;

package/dist/service.d.ts

@@ -10,6 +10,7 @@ import { ToilAllowanceQueryParams } from './interfaces/query-params/index.js';
 import { LogbookEntry, LogbookQueryParameters } from './interfaces/logbook.interface.js';
 import { Message } from './interfaces/message.interface.js';
 import { Invoice, InvoiceDownload } from './interfaces/invoice.interface.js';
+import { CreateUserRequest, CreateUserResponse } from './interfaces/user-v2.interface.js';
 export type ServiceSpecification<CustomOp extends OpDef<unknown> = OpDef<any>> = {
     /** Operations allowed and usable for the endpoint */
     operations: Operation[];
@@ -282,4 +283,15 @@ export declare const SERVICES: {
         endpointVersion: "v1";
         operations: ("get" | "delete" | "list" | "listAll" | "create" | "update")[];
     };
+    userV2: {
+        endpoint: "users";
+        endpointVersion: "v2";
+        operations: "create"[];
+        customOperations: {
+            create: ({ request, service }: OperationContext, userSpec: {
+                users: RequirementsOf<CreateUserRequest, "firstName" | "lastName" | "roles">[];
+                sendInvite?: boolean;
+            }) => RequestConfig<typeof userSpec, CreateUserResponse>;
+        };
+    };
 };

package/dist/service.js

@@ -381,4 +381,17 @@ export const SERVICES = {
         endpointVersion: 'v1',
         operations: ['create', 'get', 'list', 'listAll', 'update', 'delete'],
     },
+    userV2: {
+        endpoint: 'users',
+        endpointVersion: 'v2',
+        operations: ['create'],
+        customOperations: {
+            create: ({ request, service }, userSpec) => ({
+                ...request,
+                url: `${service.endpointVersion}/${service.endpoint}`,
+                method: 'POST',
+                data: userSpec,
+            }),
+        },
+    },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rotacloud",
-  "version": "2.2.4",
+  "version": "2.2.6",
   "description": "The RotaCloud SDK for the RotaCloud API",
   "type": "module",
   "engines": {

package/src/endpoint.ts

@@ -27,6 +27,7 @@ import {
   LogbookCategory,
   DayNoteV2,
   DayNoteV2QueryParameters,
+  PartialUserV2,
 } from './interfaces/index.js';
 import { LogbookEntry, LogbookQueryParameters } from './interfaces/logbook.interface.js';
 import { Message } from './interfaces/message.interface.js';
@@ -128,5 +129,13 @@ export interface EndpointEntityMap extends Record<EndpointVersion, Record<string
       'title' | 'message' | 'startDate' | 'endDate' | 'locations' | 'visibleToEmployees'
     >;
     'logbook/categories': Endpoint<LogbookCategory, undefined, Pick<LogbookCategory, 'name'>>;
+    users: Endpoint<
+      User,
+      undefined,
+      {
+        users: RequirementsOf<PartialUserV2, 'firstName' | 'lastName' | 'roles'>[];
+        sendInvite?: boolean;
+      }
+    >;
   };
 }

package/src/interfaces/index.ts

@@ -34,6 +34,7 @@ export * from './time-zone.interface.js';
 export * from './toil-accrual.interface.js';
 export * from './toil-allowance.interface.js';
 export * from './user.interface.js';
+export * from './user-v2.interface.js';
 export * from './users-clocked-in.interface.js';
 export * from './users-clocked-out.interface.js';
 export * from './document.interface.js';

package/src/interfaces/user-v2.interface.ts

@@ -0,0 +1,30 @@
+import { ManagerPermission } from './user.interface.js';
+
+export interface CreateUserRequest extends PartialUserV2 {
+  permissions?: ManagerPermission[];
+  coverLocations?: number[];
+  managedLocations?: number[];
+}
+
+export interface CreateUserResponse extends PartialUserV2 {
+  id: number;
+}
+
+export interface PartialUserV2 {
+  firstName: string;
+  lastName: string;
+  locations: number[];
+  roles: UserRole[];
+  email: string | null;
+  level: 'admin' | 'employee' | 'manager';
+  salary: number;
+  salaryType: 'annual' | 'hourly';
+}
+
+export interface UserRole {
+  id: number;
+  perShift?: number;
+  perHour?: number;
+  payCode?: string;
+  isDefault?: boolean;
+}

package/src/service.ts

@@ -9,6 +9,7 @@ import {
   ShiftHistoryRecord,
   Terminal,
   ToilAllowance,
+  User,
   UserBreak,
   UserClockedIn,
   UserClockedOut,
@@ -34,6 +35,7 @@ import { ToilAllowanceQueryParams } from './interfaces/query-params/index.js';
 import { LogbookEntry, LogbookQueryParameters } from './interfaces/logbook.interface.js';
 import { Message } from './interfaces/message.interface.js';
 import { Invoice, InvoiceDownload } from './interfaces/invoice.interface.js';
+import { CreateUserRequest, CreateUserResponse, PartialUserV2 } from './interfaces/user-v2.interface.js';
 
 export type ServiceSpecification<CustomOp extends OpDef<unknown> = OpDef<any>> = {
   /** Operations allowed and usable for the endpoint */
@@ -495,4 +497,23 @@ export const SERVICES = {
     endpointVersion: 'v1',
     operations: ['create', 'get', 'list', 'listAll', 'update', 'delete'],
   },
+  userV2: {
+    endpoint: 'users',
+    endpointVersion: 'v2',
+    operations: ['create'],
+    customOperations: {
+      create: (
+        { request, service },
+        userSpec: {
+          users: RequirementsOf<CreateUserRequest, 'firstName' | 'lastName' | 'roles'>[];
+          sendInvite?: boolean;
+        },
+      ): RequestConfig<typeof userSpec, CreateUserResponse> => ({
+        ...request,
+        url: `${service.endpointVersion}/${service.endpoint}`,
+        method: 'POST',
+        data: userSpec,
+      }),
+    },
+  },
 } satisfies Record<string, ServiceSpecification>;