Feat add nodejs sdk methods for workflow overrides api

packages/node/README.md

@@ -155,6 +155,7 @@ Novu provides a single API to manage providers across multiple channels with a s
 - [Organizations](#organizations)
 - [Inbound Parse](#inbound-parse)
 - [Execution Details](#execution-details)
+- [Workflow Overrides](#workflow-override)
 
 ### Subscribers
 
@@ -1267,3 +1268,92 @@ const executionDetailsParams = {
 // get execution details
 await novu.executionDetails.get(executionDetailsParams)
 ```
+
+### Workflow Overrides
+
+- #### create new workflow override
+```ts
+import { Novu } from '@novu/node';
+
+const novu = new Novu('<NOVU_API_KEY>');
+
+await novu.workflowoverrides.create({
+  workflowId: 'workdflowId_123',
+  tenantId: 'tenantID_123',
+  active: false,
+})
+```
+
+- #### get all workflow overrides
+```ts
+import { Novu } from '@novu/node';
+
+const novu = new Novu('<NOVU_API_KEY>');
+
+await novu.workflowoverrides.getWorkflowOverrides();
+```
+
+- #### get all workflow overrides from the 3rd page and with a limit of 20
+```ts
+import { Novu } from '@novu/node';
+
+const novu = new Novu('<NOVU_API_KEY>');
+
+await novu.workflowoverrides.getWorkflowOverrides(3,20)
+```
+
+- #### get workflow override by overrideId
+```ts
+import { Novu } from '@novu/node';
+
+const novu = new Novu('<NOVU_API_KEY>');
+
+await novu.workflowoverrides.getworkflowOverrideById('overrideId_123');
+```
+
+- #### get workflow override by tenant
+```ts
+import { Novu } from '@novu/node';
+
+const novu = new Novu('<NOVU_API_KEY>');
+
+await novu.workflowoverrides.getWorkflowOverrideByTenant(
+      'workflowId_123',
+      'tenantId_123'
+    );
+```
+
+- #### Update workflow override
+```ts
+import { Novu } from '@novu/node';
+
+const novu = new Novu('<NOVU_API_KEY>');
+
+await novu.workflowoverrides.updateWorkflowOverride(
+      'overrideId_123',
+      'tenantId_123',
+      {
+        active: false,
+      }
+    );
+```
+
+- #### Update workflow override by tenantId
+```ts
+import { Novu } from '@novu/node';
+
+const novu = new Novu('<NOVU_API_KEY>');
+
+await novu.workflowoverrides.updateWorkflowOverrideById('OVERRIDE_ID', {
+      active: false,
+    });
+```
+
+- #### Delete workflow override
+```ts
+import { Novu } from '@novu/node';
+
+const novu = new Novu('<NOVU_API_KEY>');
+
+await novu.workflowoverrides.delete('overrideId_123');
+```

packages/node/src/index.ts

@@ -31,4 +31,5 @@ export * from './lib/topics/topic.interface';
 export * from './lib/integrations/integrations.interface';
 export * from './lib/messages/messages.interface';
 export * from './lib/organizations/organizations.interface';
+export * from './lib/workflow-override/workflow-override.interface';
 export { defaultRetryCondition } from './lib/retry';

packages/node/src/lib/novu.ts

@@ -16,6 +16,7 @@ import { Tenants } from './tenants/tenants';
 import { ExecutionDetails } from './execution-details/execution-details';
 import { InboundParse } from './inbound-parse/inbound-parse';
 import { Organizations } from './organizations/organizations';
+import { WorkflowOverrides } from './workflow-override/workflow-override';
 
 import { makeRetryable } from './retry';
 
@@ -37,6 +38,7 @@ export class Novu extends EventEmitter {
   readonly executionDetails: ExecutionDetails;
   readonly inboundParse: InboundParse;
   readonly organizations: Organizations;
+  readonly workflowoverrides: WorkflowOverrides;
 
   constructor(apiKey: string, config?: INovuConfiguration) {
     super();
@@ -69,6 +71,7 @@ export class Novu extends EventEmitter {
     this.executionDetails = new ExecutionDetails(this.http);
     this.inboundParse = new InboundParse(this.http);
     this.organizations = new Organizations(this.http);
+    this.workflowoverrides = new WorkflowOverrides(this.http);
 
     this.trigger = this.events.trigger;
     this.bulkTrigger = this.events.bulkTrigger;

packages/node/src/lib/workflow-override/workflow-override.interface.ts

@@ -0,0 +1,30 @@
+import { IPreferenceChannels, WorkflowOverrideId } from '@novu/shared';
+
+export interface IWorkflowOverrides {
+  create(data: IWorkflowOverridePayload);
+  getWorkflowOverrides(page?: number, limit?: number);
+  getworkflowOverrideById(overrideId: string);
+  getWorkflowOverrideByTenant(workflowId: string, tenantId: string);
+  updateWorkflowOverrideById(
+    overrideId: string,
+    data: IWorkflowOverrideUpdatePayload
+  );
+  updateWorkflowOverride(
+    overrideId: string,
+    tenantId: string,
+    data: IWorkflowOverrideUpdatePayload
+  );
+  delete(overrideId: string);
+}
+
+export interface IWorkflowOverridePayload {
+  workflowId: WorkflowOverrideId;
+  tenantId: string;
+  active?: boolean;
+  preferenceSettings?: IPreferenceChannels;
+}
+
+export interface IWorkflowOverrideUpdatePayload {
+  active?: boolean;
+  preferenceSettings?: IPreferenceChannels;
+}

packages/node/src/lib/workflow-override/workflow-override.ts

@@ -0,0 +1,83 @@
+import {
+  IWorkflowOverridePayload,
+  IWorkflowOverrides,
+  IWorkflowOverrideUpdatePayload,
+} from './workflow-override.interface';
+import { WithHttp } from '../novu.interface';
+
+export class WorkflowOverrides extends WithHttp implements IWorkflowOverrides {
+  /**
+   * @param {string} overrideId - overrideId of the workflow-override to update
+   * @param {IWorkflowOverrideUpdatePayload} data - All the additional parameters to update a worflow-override
+   */
+  async updateWorkflowOverrideById(
+    overrideId: string,
+    data: IWorkflowOverrideUpdatePayload
+  ) {
+    return await this.http.put(`/workflow-overrides/${overrideId}`, {
+      ...data,
+    });
+  }
+
+  /**
+   * @param {IWorkflowOverridePayload} data - All the additional parameters to create a workflow-override
+   */
+  async create(data: IWorkflowOverridePayload) {
+    return await this.http.post(`/workflow-overrides`, {
+      ...data,
+    });
+  }
+
+  /**
+   * @param {string} overrideId - overrideId of the workflow
+   */
+  async getworkflowOverrideById(overrideId: string) {
+    return await this.http.get(`/workflow-overrides/${overrideId}`);
+  }
+
+  /**
+   * @param {number} page - Page number to fetch
+   * @param {number} limit - Number of results to fetch in one page
+   */
+  async getWorkflowOverrides(page = 0, limit = 10) {
+    return await this.http.get(`/workflow-overrides`, {
+      params: { page, limit },
+    });
+  }
+
+  /**
+   * @param {string} workflowId - workflowId
+   * @param {string} tenantId - tenantId
+   */
+  async getWorkflowOverrideByTenant(workflowId: string, tenantId: string) {
+    return await this.http.get(
+      `/workflow-overrides/workflows/${workflowId}/tenants/${tenantId}`
+    );
+  }
+
+  /**
+   * @param {string} overrideId - workflowId
+   * @param {string} tenantId - tenantId
+   * @param {IWorkflowOverrideUpdatePayload} data - All the additional paramters to update workflow override
+   */
+  async updateWorkflowOverride(
+    overrideId: string,
+    tenantId: string,
+    data: IWorkflowOverrideUpdatePayload
+  ) {
+    return await this.http.put(
+      `/workflow-overrides/workflows/${overrideId}/tenants/${tenantId}`,
+      {
+        ...data,
+      }
+    );
+  }
+
+  /**
+   *
+   * @param {string} overrideId - overrideID of the workflow
+   */
+  async delete(overrideId: string) {
+    return await this.http.delete(`/workflow-overrides/${overrideId}`);
+  }
+}