rotacloud 2.3.4 → 2.3.9

package/dist/endpoint.d.ts

@@ -4,6 +4,7 @@ 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';
 import { RequirementsOf } from './utils.js';
 import { Invoice, InvoiceQueryParameters } from './interfaces/invoice.interface.js';
+import { UpdateUserWithOnboardingInfo } from './interfaces/onboarding.interface.js';
 /** Endpoint versions supported by the API */
 export type EndpointVersion = 'v1' | 'v2';
 /** Associated types for a given API endpoint */
@@ -63,5 +64,7 @@ export interface EndpointEntityMap extends Record<EndpointVersion, Record<string
             users: RequirementsOf<PartialUserV2, 'firstName' | 'lastName' | 'roles'>[];
             sendInvite?: boolean;
         }>;
+        'users/onboard': Endpoint<void, number, UpdateUserWithOnboardingInfo>;
+        'users/onboard/resend': Endpoint<void, number>;
     };
 }

package/dist/interfaces/account-subscription.interface.d.ts

@@ -68,10 +68,6 @@ export interface SubscriptionUpdateReq {
     billingEmail?: string;
     country?: number;
 }
-export interface EstimatesRes {
-    owed: number;
-    totalPrice: number;
-}
 export interface ProductCatalogueItemPrice {
     id: string;
     currency: string;
@@ -111,3 +107,34 @@ export interface CancelSubscriptionReq {
     message?: string;
     detail?: string;
 }
+export interface EstimateLineItem {
+    id: string;
+    description: string;
+    amount: number;
+    discountAmount: number;
+}
+export interface UpdatedPlan {
+    planId: string;
+    trial?: boolean;
+}
+export interface UpdatedAddon {
+    addonId: string;
+    trial?: boolean;
+}
+export interface EstimatesReq {
+    plans?: UpdatedPlan[];
+    addons?: UpdatedAddon[];
+    paymentFrequency: 'monthly' | 'yearly';
+}
+export interface Estimate {
+    subTotal: number;
+    creditsApplied: number;
+    lineItems: EstimateLineItem[];
+}
+export interface EstimatesRes {
+    paymentFrequency: 'monthly' | 'yearly';
+    quantity: number;
+    immediateEstimates: Estimate;
+    nextEstimates: Estimate;
+    nextBillingDate: string;
+}

package/dist/interfaces/onboarding.interface.d.ts

@@ -0,0 +1,22 @@
+import { RequirementsOf } from '../utils.js';
+import { User } from './user.interface.js';
+export interface UpdateUserWithOnboardingInfo {
+    title: string;
+    gender: string;
+    dob: string;
+    nationalInsuranceNumber?: string;
+    address1: string;
+    address2: string;
+    county: string;
+    phone: string;
+    postcode: string;
+    city: string;
+    emergencyContactName: string;
+    emergencyContactPhone: string;
+    emergencyContactRelationship: string;
+}
+export type PendingV1User = RequirementsOf<User, 'first_name' | 'last_name' | 'locations' | 'email'>;
+export interface AddOrOnboard {
+    users: PendingV1User[];
+    locations: number[];
+}

package/dist/interfaces/onboarding.interface.js

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

package/dist/interfaces/sdk-config.interface.d.ts

@@ -25,6 +25,7 @@ export type SDKConfig = ({
     apiKey?: never;
     basicAuth: string;
 }) & {
+    stripeKey?: string;
     baseUri?: string;
     accountId?: number;
     userId?: number;

package/dist/main.d.ts

@@ -250,4 +250,23 @@ export declare const createRotaCloudClient: (config: import("./interfaces/sdk-co
             }) => import("./ops.js").RequestConfig<typeof userSpec, import("./interfaces/user-v2.interface.js").CreateUserResponse>;
         };
     };
+    onboarding: {
+        endpoint: "users/onboard";
+        endpointVersion: "v2";
+        operations: ("create" | "update")[];
+        customOperations: {
+            update: ({ request, service }: import("./ops.js").OperationContext, onboardingInfoForm: import("./interfaces/onboarding.interface.js").UpdateUserWithOnboardingInfo) => import("./ops.js").RequestConfig<typeof onboardingInfoForm, void>;
+            create: ({ request, service }: import("./ops.js").OperationContext, addOrOnboard: import("./interfaces/onboarding.interface.js").AddOrOnboard) => import("./ops.js").RequestConfig<typeof addOrOnboard, void>;
+        };
+    };
+    resendOnboardingLink: {
+        endpoint: "users/onboard/resend";
+        endpointVersion: "v2";
+        operations: "create"[];
+        customOperations: {
+            create: ({ request, service }: import("./ops.js").OperationContext, entity: {
+                id: number;
+            }) => import("./ops.js").RequestConfig<void, void>;
+        };
+    };
 }>;

package/dist/ops.d.ts

@@ -166,7 +166,7 @@ export declare function getOpMap<E extends Endpoint<any, any>, T extends E['type
         }) | undefined) => Promise<T[]>;
         listByPage: (ctx: OperationContext, query: E["queryParameters"], opts?: (RequestOptions<T[]> & {
             offset?: number;
-        }) | undefined) => AsyncGenerator<AxiosResponse<T[], any>, any, any>;
+        }) | undefined) => AsyncGenerator<AxiosResponse<T[], any, {}>, any, any>;
         create: (ctx: OperationContext, newEntity: E["createType"]) => RequestConfig<E["createType"], T>;
         update: (ctx: OperationContext, entity: T extends {
             id: number;
@@ -189,7 +189,7 @@ export declare function getOpMap<E extends Endpoint<any, any>, T extends E['type
         deleteBatch: typeof deleteBatchOp;
         list: (ctx: OperationContext, query: E["queryParameters"], opts?: RequestOptions<T[]> | undefined) => AsyncGenerator<T, any, any>;
         listAll: (ctx: OperationContext, query: E["queryParameters"], opts?: RequestOptions<T[]> | undefined) => Promise<T[]>;
-        listByPage: (ctx: OperationContext, query: E["queryParameters"], opts?: RequestOptions<T[]> | undefined) => AsyncGenerator<AxiosResponse<PagedResponse<T>, any>, any, any>;
+        listByPage: (ctx: OperationContext, query: E["queryParameters"], opts?: RequestOptions<T[]> | undefined) => AsyncGenerator<AxiosResponse<PagedResponse<T>, any, {}>, any, any>;
         create: (ctx: OperationContext, newEntity: E["createType"]) => RequestConfig<E["createType"], T>;
         update: (ctx: OperationContext, entity: T extends {
             id: number;

package/dist/service.d.ts

@@ -11,6 +11,7 @@ import { LogbookEntry, LogbookQueryParameters } from './interfaces/logbook.inter
 import { Message } from './interfaces/message.interface.js';
 import { Invoice, InvoiceDownload } from './interfaces/invoice.interface.js';
 import { CreateUserRequest, CreateUserResponse } from './interfaces/user-v2.interface.js';
+import { AddOrOnboard, UpdateUserWithOnboardingInfo } from './interfaces/onboarding.interface.js';
 export type ServiceSpecification<CustomOp extends OpDef<unknown> = OpDef<any>> = {
     /** Operations allowed and usable for the endpoint */
     operations: Operation[];
@@ -294,4 +295,23 @@ export declare const SERVICES: {
             }) => RequestConfig<typeof userSpec, CreateUserResponse>;
         };
     };
+    onboarding: {
+        endpoint: "users/onboard";
+        endpointVersion: "v2";
+        operations: ("create" | "update")[];
+        customOperations: {
+            update: ({ request, service }: OperationContext, onboardingInfoForm: UpdateUserWithOnboardingInfo) => RequestConfig<typeof onboardingInfoForm, void>;
+            create: ({ request, service }: OperationContext, addOrOnboard: AddOrOnboard) => RequestConfig<typeof addOrOnboard, void>;
+        };
+    };
+    resendOnboardingLink: {
+        endpoint: "users/onboard/resend";
+        endpointVersion: "v2";
+        operations: "create"[];
+        customOperations: {
+            create: ({ request, service }: OperationContext, entity: {
+                id: number;
+            }) => RequestConfig<void, void>;
+        };
+    };
 };

package/dist/service.js

@@ -394,4 +394,35 @@ export const SERVICES = {
             }),
         },
     },
+    onboarding: {
+        endpoint: 'users/onboard',
+        endpointVersion: 'v2',
+        operations: ['update', 'create'],
+        customOperations: {
+            update: ({ request, service }, onboardingInfoForm) => ({
+                ...request,
+                url: `${service.endpointVersion}/${service.endpoint}`,
+                method: 'PATCH',
+                data: onboardingInfoForm,
+            }),
+            create: ({ request, service }, addOrOnboard) => ({
+                ...request,
+                url: `${service.endpointVersion}/${service.endpoint}`,
+                method: 'POST',
+                data: addOrOnboard,
+            }),
+        },
+    },
+    resendOnboardingLink: {
+        endpoint: 'users/onboard/resend',
+        endpointVersion: 'v2',
+        operations: ['create'],
+        customOperations: {
+            create: ({ request, service }, entity) => ({
+                ...request,
+                url: `${service.endpointVersion}/${service.endpoint}/${entity.id}/resend`,
+                method: 'POST',
+            }),
+        },
+    },
 };

package/package.json

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

package/src/endpoint.ts

@@ -54,6 +54,7 @@ import {
 } from './interfaces/query-params/index.js';
 import { RequirementsOf } from './utils.js';
 import { Invoice, InvoiceQueryParameters } from './interfaces/invoice.interface.js';
+import { UpdateUserWithOnboardingInfo } from './interfaces/onboarding.interface.js';
 
 /** Endpoint versions supported by the API */
 export type EndpointVersion = 'v1' | 'v2';
@@ -137,5 +138,7 @@ export interface EndpointEntityMap extends Record<EndpointVersion, Record<string
         sendInvite?: boolean;
       }
     >;
+    'users/onboard': Endpoint<void, number, UpdateUserWithOnboardingInfo>;
+    'users/onboard/resend': Endpoint<void, number>;
   };
 }

package/src/interfaces/account-subscription.interface.ts

@@ -66,11 +66,6 @@ export interface SubscriptionUpdateReq {
   country?: number;
 }
 
-export interface EstimatesRes {
-  owed: number;
-  totalPrice: number;
-}
-
 export interface ProductCatalogueItemPrice {
   id: string;
   currency: string;
@@ -108,3 +103,40 @@ export interface CancelSubscriptionReq {
   message?: string;
   detail?: string;
 }
+
+export interface EstimateLineItem {
+  id: string;
+  description: string;
+  amount: number;
+  discountAmount: number;
+}
+
+export interface UpdatedPlan {
+  planId: string;
+  trial?: boolean;
+}
+
+export interface UpdatedAddon {
+  addonId: string;
+  trial?: boolean;
+}
+
+export interface EstimatesReq {
+  plans?: UpdatedPlan[];
+  addons?: UpdatedAddon[];
+  paymentFrequency: 'monthly' | 'yearly';
+}
+
+export interface Estimate {
+  subTotal: number;
+  creditsApplied: number;
+  lineItems: EstimateLineItem[];
+}
+
+export interface EstimatesRes {
+  paymentFrequency: 'monthly' | 'yearly';
+  quantity: number;
+  immediateEstimates: Estimate;
+  nextEstimates: Estimate;
+  nextBillingDate: string;
+}

package/src/interfaces/onboarding.interface.ts

@@ -0,0 +1,25 @@
+import { RequirementsOf } from '../utils.js';
+import { User } from './user.interface.js';
+
+export interface UpdateUserWithOnboardingInfo {
+  title: string;
+  gender: string;
+  dob: string;
+  nationalInsuranceNumber?: string;
+  address1: string;
+  address2: string;
+  county: string;
+  phone: string;
+  postcode: string;
+  city: string;
+  emergencyContactName: string;
+  emergencyContactPhone: string;
+  emergencyContactRelationship: string;
+}
+
+export type PendingV1User = RequirementsOf<User, 'first_name' | 'last_name' | 'locations' | 'email'>;
+
+export interface AddOrOnboard {
+  users: PendingV1User[];
+  locations: number[];
+}

package/src/interfaces/sdk-config.interface.ts

@@ -34,6 +34,7 @@ export type SDKConfig = (
       basicAuth: string;
     }
 ) & {
+  stripeKey?: string;
   baseUri?: string;
   accountId?: number;
   userId?: number;

package/src/service.ts

@@ -36,6 +36,7 @@ import { LogbookEntry, LogbookQueryParameters } from './interfaces/logbook.inter
 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';
+import { AddOrOnboard, UpdateUserWithOnboardingInfo } from './interfaces/onboarding.interface.js';
 
 export type ServiceSpecification<CustomOp extends OpDef<unknown> = OpDef<any>> = {
   /** Operations allowed and usable for the endpoint */
@@ -516,4 +517,38 @@ export const SERVICES = {
       }),
     },
   },
+  onboarding: {
+    endpoint: 'users/onboard',
+    endpointVersion: 'v2',
+    operations: ['update', 'create'],
+    customOperations: {
+      update: (
+        { request, service },
+        onboardingInfoForm: UpdateUserWithOnboardingInfo,
+      ): RequestConfig<typeof onboardingInfoForm, void> => ({
+        ...request,
+        url: `${service.endpointVersion}/${service.endpoint}`,
+        method: 'PATCH',
+        data: onboardingInfoForm,
+      }),
+      create: ({ request, service }, addOrOnboard: AddOrOnboard): RequestConfig<typeof addOrOnboard, void> => ({
+        ...request,
+        url: `${service.endpointVersion}/${service.endpoint}`,
+        method: 'POST',
+        data: addOrOnboard,
+      }),
+    },
+  },
+  resendOnboardingLink: {
+    endpoint: 'users/onboard/resend',
+    endpointVersion: 'v2',
+    operations: ['create'],
+    customOperations: {
+      create: ({ request, service }, entity: { id: number }): RequestConfig<void, void> => ({
+        ...request,
+        url: `${service.endpointVersion}/${service.endpoint}/${entity.id}/resend`,
+        method: 'POST',
+      }),
+    },
+  },
 } satisfies Record<string, ServiceSpecification>;