@novu/api 1.4.0 → 1.5.0

package/src/models/operations/notificationscontrollerlistnotifications.ts

@@ -41,7 +41,7 @@ export type NotificationsControllerListNotificationsRequest = {
    */
   limit?: number | undefined;
   /**
-   * Transaction ID for filtering
+   * The transaction ID to filter by
    */
   transactionId?: string | undefined;
   /**

package/src/sdk/credentials.ts

@@ -12,11 +12,11 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Credentials extends ClientSDK {
   /**
-   * Update provider credentials
+   * Upsert provider credentials
    *
    * @remarks
-   * Update credentials for a provider such as slack and push tokens.
-   *       **providerId** is required field. This API appends the **deviceTokens** to the existing ones.
+   * Upsert credentials for a provider such as slack and push tokens.
+   *       **providerId** is required field. This API creates **deviceTokens** or appends to the existing ones.
    */
   async update(
     updateSubscriberChannelRequestDto:
@@ -37,11 +37,11 @@ export class Credentials extends ClientSDK {
   }
 
   /**
-   * Upsert provider credentials
+   * Create or Partially Update provider credentials
    *
    * @remarks
-   * Update credentials for a provider such as **slack** and **FCM**.
-   *       **providerId** is required field. This API replaces the existing deviceTokens with the provided ones.
+   * Create or Partially credentials for a provider such as **slack** and **FCM**.
+   *       **providerId** is required field. This API creates the **deviceTokens** or replaces the existing ones.
    */
   async append(
     updateSubscriberChannelRequestDto:

package/src/sdk/environments.ts

@@ -4,6 +4,7 @@
 
 import { environmentsCreate } from "../funcs/environmentsCreate.js";
 import { environmentsDelete } from "../funcs/environmentsDelete.js";
+import { environmentsGetTags } from "../funcs/environmentsGetTags.js";
 import { environmentsList } from "../funcs/environmentsList.js";
 import { environmentsUpdate } from "../funcs/environmentsUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -12,6 +13,25 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Environments extends ClientSDK {
+  /**
+   * Get environment tags
+   *
+   * @remarks
+   * Retrieve all unique tags used in workflows within the specified environment. These tags can be used for filtering workflows.
+   */
+  async getTags(
+    environmentId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.EnvironmentsControllerGetEnvironmentTagsResponse> {
+    return unwrapAsync(environmentsGetTags(
+      this,
+      environmentId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
   /**
    * Create an environment
    *

package/src/sdk/sdk.ts

@@ -3,6 +3,7 @@
  */
 
 import { cancel } from "../funcs/cancel.js";
+import { retrieve } from "../funcs/retrieve.js";
 import { trigger } from "../funcs/trigger.js";
 import { triggerBroadcast } from "../funcs/triggerBroadcast.js";
 import { triggerBulk } from "../funcs/triggerBulk.js";
@@ -19,6 +20,11 @@ import { Topics } from "./topics.js";
 import { Workflows } from "./workflows.js";
 
 export class Novu extends ClientSDK {
+  private _environments?: Environments;
+  get environments(): Environments {
+    return (this._environments ??= new Environments(this._options));
+  }
+
   private _subscribers?: Subscribers;
   get subscribers(): Subscribers {
     return (this._subscribers ??= new Subscribers(this._options));
@@ -34,11 +40,6 @@ export class Novu extends ClientSDK {
     return (this._workflows ??= new Workflows(this._options));
   }
 
-  private _environments?: Environments;
-  get environments(): Environments {
-    return (this._environments ??= new Environments(this._options));
-  }
-
   private _integrations?: Integrations;
   get integrations(): Integrations {
     return (this._integrations ??= new Integrations(this._options));
@@ -137,4 +138,15 @@ export class Novu extends ClientSDK {
       options,
     ));
   }
+
+  async retrieve(
+    request: operations.LogsControllerGetLogsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.LogsControllerGetLogsResponseBody> {
+    return unwrapAsync(retrieve(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/types/constdatetime.ts

@@ -11,5 +11,5 @@ export function constDateTime(
     return (
       typeof v === "string" && new Date(v).getTime() === new Date(val).getTime()
     );
-  }, `Value must be equivelant to ${val}`);
+  }, `Value must be equivalent to ${val}`);
 }

package/types/constdatetime.js

@@ -31,7 +31,7 @@ const z = __importStar(require("zod"));
 function constDateTime(val) {
     return z.custom((v) => {
         return (typeof v === "string" && new Date(v).getTime() === new Date(val).getTime());
-    }, `Value must be equivelant to ${val}`);
+    }, `Value must be equivalent to ${val}`);
 }
 exports.constDateTime = constDateTime;
 //# sourceMappingURL=constdatetime.js.map

package/models/components/stepcontentissueenum.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"stepcontentissueenum.d.ts","sourceRoot":"","sources":["../../src/models/components/stepcontentissueenum.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;CAKvB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAE3E,gBAAgB;AAChB,eAAO,MAAM,kCAAkC,EAAE,CAAC,CAAC,aAAa,CAC9D,OAAO,oBAAoB,CACS,CAAC;AAEvC,gBAAgB;AAChB,eAAO,MAAM,mCAAmC,EAAE,CAAC,CAAC,aAAa,CAC/D,OAAO,oBAAoB,CACS,CAAC;AAEvC;;;GAGG;AACH,yBAAiB,qBAAqB,CAAC;IACrC,oEAAoE;IAC7D,MAAM,aAAa;;;;;MAAqC,CAAC;IAChE,qEAAqE;IAC9D,MAAM,cAAc;;;;;MAAsC,CAAC;CACnE"}

package/models/components/stepcontentissueenum.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"stepcontentissueenum.js","sourceRoot":"","sources":["../../src/models/components/stepcontentissueenum.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AAGzB;;GAEG;AACU,QAAA,oBAAoB,GAAG;IAClC,6BAA6B,EAAE,mCAAmC;IAClE,0BAA0B,EAAE,gCAAgC;IAC5D,YAAY,EAAE,eAAe;IAC7B,iBAAiB,EAAE,qBAAqB;CAChC,CAAC;AAMX,gBAAgB;AACH,QAAA,kCAAkC,GAE3C,CAAC,CAAC,UAAU,CAAC,4BAAoB,CAAC,CAAC;AAEvC,gBAAgB;AACH,QAAA,mCAAmC,GAE5C,0CAAkC,CAAC;AAEvC;;;GAGG;AACH,IAAiB,qBAAqB,CAKrC;AALD,WAAiB,qBAAqB;IACpC,oEAAoE;IACvD,mCAAa,GAAG,0CAAkC,CAAC;IAChE,qEAAqE;IACxD,oCAAc,GAAG,2CAAmC,CAAC;AACpE,CAAC,EALgB,qBAAqB,qCAArB,qBAAqB,QAKrC"}

package/models/components/stepintegrationissueenum.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"stepintegrationissueenum.d.ts","sourceRoot":"","sources":["../../src/models/components/stepintegrationissueenum.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,wBAAwB;;CAE3B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,UAAU,CAC/C,OAAO,wBAAwB,CAChC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,aAAa,CAClE,OAAO,wBAAwB,CACS,CAAC;AAE3C,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,aAAa,CACnE,OAAO,wBAAwB,CACS,CAAC;AAE3C;;;GAGG;AACH,yBAAiB,yBAAyB,CAAC;IACzC,wEAAwE;IACjE,MAAM,aAAa;;MAAyC,CAAC;IACpE,yEAAyE;IAClE,MAAM,cAAc;;MAA0C,CAAC;CACvE"}

package/models/components/stepintegrationissueenum.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"stepintegrationissueenum.js","sourceRoot":"","sources":["../../src/models/components/stepintegrationissueenum.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AAGzB;;GAEG;AACU,QAAA,wBAAwB,GAAG;IACtC,kBAAkB,EAAE,qBAAqB;CACjC,CAAC;AAQX,gBAAgB;AACH,QAAA,sCAAsC,GAE/C,CAAC,CAAC,UAAU,CAAC,gCAAwB,CAAC,CAAC;AAE3C,gBAAgB;AACH,QAAA,uCAAuC,GAEhD,8CAAsC,CAAC;AAE3C;;;GAGG;AACH,IAAiB,yBAAyB,CAKzC;AALD,WAAiB,yBAAyB;IACxC,wEAAwE;IAC3D,uCAAa,GAAG,8CAAsC,CAAC;IACpE,yEAAyE;IAC5D,wCAAc,GAAG,+CAAuC,CAAC;AACxE,CAAC,EALgB,yBAAyB,yCAAzB,yBAAyB,QAKzC"}

package/src/models/components/stepcontentissueenum.ts

@@ -1,41 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { ClosedEnum } from "../../types/enums.js";
-
-/**
- * Type of step content issue
- */
-export const StepContentIssueEnum = {
-  IllegalVariableInControlValue: "ILLEGAL_VARIABLE_IN_CONTROL_VALUE",
-  InvalidFilterArgInVariable: "INVALID_FILTER_ARG_IN_VARIABLE",
-  MissingValue: "MISSING_VALUE",
-  TierLimitExceeded: "TIER_LIMIT_EXCEEDED",
-} as const;
-/**
- * Type of step content issue
- */
-export type StepContentIssueEnum = ClosedEnum<typeof StepContentIssueEnum>;
-
-/** @internal */
-export const StepContentIssueEnum$inboundSchema: z.ZodNativeEnum<
-  typeof StepContentIssueEnum
-> = z.nativeEnum(StepContentIssueEnum);
-
-/** @internal */
-export const StepContentIssueEnum$outboundSchema: z.ZodNativeEnum<
-  typeof StepContentIssueEnum
-> = StepContentIssueEnum$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace StepContentIssueEnum$ {
-  /** @deprecated use `StepContentIssueEnum$inboundSchema` instead. */
-  export const inboundSchema = StepContentIssueEnum$inboundSchema;
-  /** @deprecated use `StepContentIssueEnum$outboundSchema` instead. */
-  export const outboundSchema = StepContentIssueEnum$outboundSchema;
-}

package/src/models/components/stepintegrationissueenum.ts

@@ -1,40 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { ClosedEnum } from "../../types/enums.js";
-
-/**
- * Type of integration issue
- */
-export const StepIntegrationIssueEnum = {
-  MissingIntegration: "MISSING_INTEGRATION",
-} as const;
-/**
- * Type of integration issue
- */
-export type StepIntegrationIssueEnum = ClosedEnum<
-  typeof StepIntegrationIssueEnum
->;
-
-/** @internal */
-export const StepIntegrationIssueEnum$inboundSchema: z.ZodNativeEnum<
-  typeof StepIntegrationIssueEnum
-> = z.nativeEnum(StepIntegrationIssueEnum);
-
-/** @internal */
-export const StepIntegrationIssueEnum$outboundSchema: z.ZodNativeEnum<
-  typeof StepIntegrationIssueEnum
-> = StepIntegrationIssueEnum$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace StepIntegrationIssueEnum$ {
-  /** @deprecated use `StepIntegrationIssueEnum$inboundSchema` instead. */
-  export const inboundSchema = StepIntegrationIssueEnum$inboundSchema;
-  /** @deprecated use `StepIntegrationIssueEnum$outboundSchema` instead. */
-  export const outboundSchema = StepIntegrationIssueEnum$outboundSchema;
-}

package/src/models/components/workfloworiginenum.ts

@@ -1,40 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { ClosedEnum } from "../../types/enums.js";
-
-/**
- * Origin of the workflow
- */
-export const WorkflowOriginEnum = {
-  NovuCloud: "novu-cloud",
-  NovuCloudV1: "novu-cloud-v1",
-  External: "external",
-} as const;
-/**
- * Origin of the workflow
- */
-export type WorkflowOriginEnum = ClosedEnum<typeof WorkflowOriginEnum>;
-
-/** @internal */
-export const WorkflowOriginEnum$inboundSchema: z.ZodNativeEnum<
-  typeof WorkflowOriginEnum
-> = z.nativeEnum(WorkflowOriginEnum);
-
-/** @internal */
-export const WorkflowOriginEnum$outboundSchema: z.ZodNativeEnum<
-  typeof WorkflowOriginEnum
-> = WorkflowOriginEnum$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace WorkflowOriginEnum$ {
-  /** @deprecated use `WorkflowOriginEnum$inboundSchema` instead. */
-  export const inboundSchema = WorkflowOriginEnum$inboundSchema;
-  /** @deprecated use `WorkflowOriginEnum$outboundSchema` instead. */
-  export const outboundSchema = WorkflowOriginEnum$outboundSchema;
-}