rotacloud 2.3.18 → 2.3.22

package/README.md

@@ -10,6 +10,37 @@ to start working with the SDK in your project.
 Please ensure you perform the `npm run version:bump` command before commiting and
 pushing your changes to the remote branch.
 
+## Local development
+
+When making changes to the SDK and testing them locally with the web app (`rotacloud-app`), follow these steps, provided you have already followed the above ones:
+
+### Initial setup
+
+1.**Build the SDK:**
+
+`npm run build -- --watch`
+
+2.**Link in the web app:**
+/ cd rotacloud-app
+
+`npm link rotacloud`
+
+3.**Verify the link is correct:**
+
+`npm ls rotacloud`
+
+Expected output:
+
+```
+└── rotacloud@x.x.x -> ./../rotacloud-node
+```
+
+The version displayed is the bumped version you are linking the app to.
+
+Once you are sure you have the web app linked to the correct version of the package, you can start up the app and test your changes:
+
+`npm run start`
+
 ## Configuration
 
 Configuration is simple, import the `createRotaCloudClient` function from the SDK

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

@@ -75,12 +75,13 @@ export interface ProductCatalogueItemPrice {
     unitPrice?: number;
     stairStep?: ProductCatalogueItemStairStep[];
     billingPeriod: number;
-    billingPeriodUnit: 'monthly' | 'yearly';
+    billingPeriodUnit: 'month' | 'year';
+    paymentPeriodUnit: 'monthly' | 'yearly';
 }
 export interface ProductCatalogueItemStairStep {
     startingUnit: number;
     endingUnit?: number;
-    tierPrice: number;
+    price: number;
 }
 export interface ProductCatalogueItem {
     id: string;

package/dist/main.d.ts

@@ -255,7 +255,10 @@ export declare const createRotaCloudClient: (config: import("./interfaces/sdk-co
         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>;
+            update: ({ request, service }: import("./ops.js").OperationContext, params: {
+                id: number;
+                data: import("./interfaces/onboarding.interface.js").UpdateUserWithOnboardingInfo;
+            }) => import("./ops.js").RequestConfig<import("./interfaces/onboarding.interface.js").UpdateUserWithOnboardingInfo, void>;
             create: ({ request, service }: import("./ops.js").OperationContext, addOrOnboard: import("./interfaces/onboarding.interface.js").AddOrOnboard) => import("./ops.js").RequestConfig<typeof addOrOnboard, void>;
         };
     };

package/dist/service.d.ts

@@ -300,7 +300,10 @@ export declare const SERVICES: {
         endpointVersion: "v2";
         operations: ("create" | "update")[];
         customOperations: {
-            update: ({ request, service }: OperationContext, onboardingInfoForm: UpdateUserWithOnboardingInfo) => RequestConfig<typeof onboardingInfoForm, void>;
+            update: ({ request, service }: OperationContext, params: {
+                id: number;
+                data: UpdateUserWithOnboardingInfo;
+            }) => RequestConfig<UpdateUserWithOnboardingInfo, void>;
             create: ({ request, service }: OperationContext, addOrOnboard: AddOrOnboard) => RequestConfig<typeof addOrOnboard, void>;
         };
     };

package/dist/service.js

@@ -399,11 +399,11 @@ export const SERVICES = {
         endpointVersion: 'v2',
         operations: ['update', 'create'],
         customOperations: {
-            update: ({ request, service }, onboardingInfoForm) => ({
+            update: ({ request, service }, params) => ({
                 ...request,
-                url: `${service.endpointVersion}/${service.endpoint}`,
+                url: `${service.endpointVersion}/${service.endpoint}/${params.id}`,
                 method: 'PATCH',
-                data: onboardingInfoForm,
+                data: params.data,
             }),
             create: ({ request, service }, addOrOnboard) => ({
                 ...request,

package/package.json

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

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

@@ -73,13 +73,14 @@ export interface ProductCatalogueItemPrice {
   unitPrice?: number;
   stairStep?: ProductCatalogueItemStairStep[];
   billingPeriod: number;
-  billingPeriodUnit: 'monthly' | 'yearly';
+  billingPeriodUnit: 'month' | 'year';
+  paymentPeriodUnit: 'monthly' | 'yearly';
 }
 
 export interface ProductCatalogueItemStairStep {
   startingUnit: number;
   endingUnit?: number;
-  tierPrice: number;
+  price: number;
 }
 export interface ProductCatalogueItem {
   id: string;

package/src/service.ts

@@ -35,7 +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 } from './interfaces/invoice.interface.js';
-import { CreateUserRequest, CreateUserResponse, PartialUserV2 } from './interfaces/user-v2.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>> = {
@@ -524,12 +524,12 @@ export const SERVICES = {
     customOperations: {
       update: (
         { request, service },
-        onboardingInfoForm: UpdateUserWithOnboardingInfo,
-      ): RequestConfig<typeof onboardingInfoForm, void> => ({
+        params: { id: number; data: UpdateUserWithOnboardingInfo },
+      ): RequestConfig<UpdateUserWithOnboardingInfo, void> => ({
         ...request,
-        url: `${service.endpointVersion}/${service.endpoint}`,
+        url: `${service.endpointVersion}/${service.endpoint}/${params.id}`,
         method: 'PATCH',
-        data: onboardingInfoForm,
+        data: params.data,
       }),
       create: ({ request, service }, addOrOnboard: AddOrOnboard): RequestConfig<typeof addOrOnboard, void> => ({
         ...request,