@novu/api - npm Package Compare versions

Comparing version 0.0.1-alpha.52 to 0.0.1-alpha.53

lib/config.d.ts

@@ -30,6 +30,6 @@ import { HTTPClient } from "./http.js";
     readonly openapiDocVersion: "1.0";
-    readonly sdkVersion: "0.0.1-alpha.52";
+    readonly sdkVersion: "0.0.1-alpha.53";
     readonly genVersion: "2.470.1";
-    readonly userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.52 2.470.1 1.0 @novu/api";
+    readonly userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.53 2.470.1 1.0 @novu/api";
 };
 //# sourceMappingURL=config.d.ts.map

lib/config.js

@@ -33,6 +33,6 @@ "use strict";
     openapiDocVersion: "1.0",
-    sdkVersion: "0.0.1-alpha.52",
+    sdkVersion: "0.0.1-alpha.53",
     genVersion: "2.470.1",
-    userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.52 2.470.1 1.0 @novu/api",
+    userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.53 2.470.1 1.0 @novu/api",
 };
 //# sourceMappingURL=config.js.map

models/components/createintegrationrequestdto.d.ts

@@ -7,2 +7,5 @@ import * as z from "zod";
 import { StepFilter, StepFilter$Outbound } from "./stepfilter.js";
+/**
+ * The channel type for the integration
+ */
 export declare const CreateIntegrationRequestDtoChannel: {
@@ -15,15 +18,42 @@ readonly InApp: "in_app";
 };
+/**
+ * The channel type for the integration
+ */
 export type CreateIntegrationRequestDtoChannel = ClosedEnum<typeof CreateIntegrationRequestDtoChannel>;
 export type CreateIntegrationRequestDto = {
+    /**
+     * The name of the integration
+     */
     name?: string | undefined;
+    /**
+     * The unique identifier for the integration
+     */
     identifier?: string | undefined;
+    /**
+     * The ID of the associated environment
+     */
     environmentId?: string | undefined;
+    /**
+     * The provider ID for the integration
+     */
     providerId: string;
+    /**
+     * The channel type for the integration
+     */
     channel: CreateIntegrationRequestDtoChannel;
+    /**
+     * The credentials for the integration
+     */
     credentials?: CredentialsDto | undefined;
     /**
-     * If the integration is active the validation on the credentials field will run
+     * If the integration is active, the validation on the credentials field will run
      */
     active?: boolean | undefined;
+    /**
+     * Flag to check the integration status
+     */
     check?: boolean | undefined;
+    /**
+     * Conditions for the integration
+     */
     conditions?: Array<StepFilter> | undefined;
@@ -30,0 +60,0 @@ };

models/components/createintegrationrequestdto.js

@@ -35,2 +35,5 @@ "use strict";
 const stepfilter_js_1 = require("./stepfilter.js");
+/**
+ * The channel type for the integration
+ */
 exports.CreateIntegrationRequestDtoChannel = {
@@ -37,0 +40,0 @@ InApp: "in_app",

models/components/integrationresponsedto.d.ts

@@ -7,2 +7,5 @@ import * as z from "zod";
 import { StepFilter, StepFilter$Outbound } from "./stepfilter.js";
+/**
+ * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
+ */
 export declare const IntegrationResponseDtoChannel: {
@@ -15,17 +18,62 @@ readonly InApp: "in_app";
 };
+/**
+ * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
+ */
 export type IntegrationResponseDtoChannel = ClosedEnum<typeof IntegrationResponseDtoChannel>;
 export type IntegrationResponseDto = {
+    /**
+     * The unique identifier of the integration record in the database. This is automatically generated.
+     */
     id?: string | undefined;
+    /**
+     * The unique identifier for the environment associated with this integration. This links to the Environment collection.
+     */
     environmentId: string;
+    /**
+     * The unique identifier for the organization that owns this integration. This links to the Organization collection.
+     */
     organizationId: string;
+    /**
+     * The name of the integration, which is used to identify it in the user interface.
+     */
     name: string;
+    /**
+     * A unique string identifier for the integration, often used for API calls or internal references.
+     */
     identifier: string;
+    /**
+     * The identifier for the provider of the integration (e.g., "mailgun", "twilio").
+     */
     providerId: string;
+    /**
+     * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
+     */
     channel: IntegrationResponseDtoChannel;
+    /**
+     * The credentials required for the integration to function, including API keys and other sensitive information.
+     */
     credentials: CredentialsDto;
+    /**
+     * Indicates whether the integration is currently active. An active integration will process events and messages.
+     */
     active: boolean;
+    /**
+     * Indicates whether the integration has been marked as deleted (soft delete).
+     */
     deleted: boolean;
-    deletedAt: string;
-    deletedBy: string;
+    /**
+     * The timestamp indicating when the integration was deleted. This is set when the integration is soft deleted.
+     */
+    deletedAt?: string | undefined;
+    /**
+     * The identifier of the user who performed the deletion of this integration. Useful for audit trails.
+     */
+    deletedBy?: string | undefined;
+    /**
+     * Indicates whether this integration is marked as primary. A primary integration is often the default choice for processing.
+     */
     primary: boolean;
+    /**
+     * An array of conditions associated with the integration that may influence its behavior or processing logic.
+     */
     conditions?: Array<StepFilter> | undefined;
@@ -73,4 +121,4 @@ };
     deleted: boolean;
-    deletedAt: string;
-    deletedBy: string;
+    deletedAt?: string | undefined;
+    deletedBy?: string | undefined;
     primary: boolean;
@@ -77,0 +125,0 @@ conditions?: Array<StepFilter$Outbound> | undefined;

models/components/integrationresponsedto.js

@@ -35,2 +35,5 @@ "use strict";
 const stepfilter_js_1 = require("./stepfilter.js");
+/**
+ * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
+ */
 exports.IntegrationResponseDtoChannel = {
@@ -70,4 +73,4 @@ InApp: "in_app",
     deleted: z.boolean(),
-    deletedAt: z.string(),
-    deletedBy: z.string(),
+    deletedAt: z.string().optional(),
+    deletedBy: z.string().optional(),
     primary: z.boolean(),
@@ -94,4 +97,4 @@ conditions: z.array(stepfilter_js_1.StepFilter$inboundSchema).optional(),
     deleted: z.boolean(),
-    deletedAt: z.string(),
-    deletedBy: z.string(),
+    deletedAt: z.string().optional(),
+    deletedBy: z.string().optional(),
     primary: z.boolean(),
@@ -98,0 +101,0 @@ conditions: z.array(stepfilter_js_1.StepFilter$outboundSchema).optional(),

package.json

 {
   "name": "@novu/api",
-  "version": "0.0.1-alpha.52",
+  "version": "0.0.1-alpha.53",
   "author": "Novu",
@@ -5,0 +5,0 @@ "main": "./index.js",

src/lib/config.ts

@@ -58,5 +58,5 @@ /*
   openapiDocVersion: "1.0",
-  sdkVersion: "0.0.1-alpha.52",
+  sdkVersion: "0.0.1-alpha.53",
   genVersion: "2.470.1",
-  userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.52 2.470.1 1.0 @novu/api",
+  userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.53 2.470.1 1.0 @novu/api",
 } as const;

src/models/components/createintegrationrequestdto.ts

@@ -24,2 +24,5 @@ /*
 
+/**
+ * The channel type for the integration
+ */
 export const CreateIntegrationRequestDtoChannel = {
@@ -32,2 +35,5 @@ InApp: "in_app",
 } as const;
+/**
+ * The channel type for the integration
+ */
 export type CreateIntegrationRequestDtoChannel = ClosedEnum<
@@ -38,13 +44,37 @@ typeof CreateIntegrationRequestDtoChannel
 export type CreateIntegrationRequestDto = {
+  /**
+   * The name of the integration
+   */
   name?: string | undefined;
+  /**
+   * The unique identifier for the integration
+   */
   identifier?: string | undefined;
+  /**
+   * The ID of the associated environment
+   */
   environmentId?: string | undefined;
+  /**
+   * The provider ID for the integration
+   */
   providerId: string;
+  /**
+   * The channel type for the integration
+   */
   channel: CreateIntegrationRequestDtoChannel;
+  /**
+   * The credentials for the integration
+   */
   credentials?: CredentialsDto | undefined;
   /**
-   * If the integration is active the validation on the credentials field will run
+   * If the integration is active, the validation on the credentials field will run
    */
   active?: boolean | undefined;
+  /**
+   * Flag to check the integration status
+   */
   check?: boolean | undefined;
+  /**
+   * Conditions for the integration
+   */
   conditions?: Array<StepFilter> | undefined;
@@ -51,0 +81,0 @@ };

src/models/components/integrationresponsedto.ts

@@ -24,2 +24,5 @@ /*
 
+/**
+ * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
+ */
 export const IntegrationResponseDtoChannel = {
@@ -32,2 +35,5 @@ InApp: "in_app",
 } as const;
+/**
+ * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
+ */
 export type IntegrationResponseDtoChannel = ClosedEnum<
@@ -38,15 +44,57 @@ typeof IntegrationResponseDtoChannel
 export type IntegrationResponseDto = {
+  /**
+   * The unique identifier of the integration record in the database. This is automatically generated.
+   */
   id?: string | undefined;
+  /**
+   * The unique identifier for the environment associated with this integration. This links to the Environment collection.
+   */
   environmentId: string;
+  /**
+   * The unique identifier for the organization that owns this integration. This links to the Organization collection.
+   */
   organizationId: string;
+  /**
+   * The name of the integration, which is used to identify it in the user interface.
+   */
   name: string;
+  /**
+   * A unique string identifier for the integration, often used for API calls or internal references.
+   */
   identifier: string;
+  /**
+   * The identifier for the provider of the integration (e.g., "mailgun", "twilio").
+   */
   providerId: string;
+  /**
+   * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
+   */
   channel: IntegrationResponseDtoChannel;
+  /**
+   * The credentials required for the integration to function, including API keys and other sensitive information.
+   */
   credentials: CredentialsDto;
+  /**
+   * Indicates whether the integration is currently active. An active integration will process events and messages.
+   */
   active: boolean;
+  /**
+   * Indicates whether the integration has been marked as deleted (soft delete).
+   */
   deleted: boolean;
-  deletedAt: string;
-  deletedBy: string;
+  /**
+   * The timestamp indicating when the integration was deleted. This is set when the integration is soft deleted.
+   */
+  deletedAt?: string | undefined;
+  /**
+   * The identifier of the user who performed the deletion of this integration. Useful for audit trails.
+   */
+  deletedBy?: string | undefined;
+  /**
+   * Indicates whether this integration is marked as primary. A primary integration is often the default choice for processing.
+   */
   primary: boolean;
+  /**
+   * An array of conditions associated with the integration that may influence its behavior or processing logic.
+   */
   conditions?: Array<StepFilter> | undefined;
@@ -92,4 +140,4 @@ };
   deleted: z.boolean(),
-  deletedAt: z.string(),
-  deletedBy: z.string(),
+  deletedAt: z.string().optional(),
+  deletedBy: z.string().optional(),
   primary: z.boolean(),
@@ -117,4 +165,4 @@ conditions: z.array(StepFilter$inboundSchema).optional(),
   deleted: boolean;
-  deletedAt: string;
-  deletedBy: string;
+  deletedAt?: string | undefined;
+  deletedBy?: string | undefined;
   primary: boolean;
@@ -140,4 +188,4 @@ conditions?: Array<StepFilter$Outbound> | undefined;
   deleted: z.boolean(),
-  deletedAt: z.string(),
-  deletedBy: z.string(),
+  deletedAt: z.string().optional(),
+  deletedBy: z.string().optional(),
   primary: z.boolean(),
@@ -144,0 +192,0 @@ conditions: z.array(StepFilter$outboundSchema).optional(),

No alert changes

Improved metrics

Total package byte prevSize

4010392

increased by0.14%

Lines of code

64494

increased by0.25%

No dependency changes