@novu/api 0.7.0 → 1.1.0

package/src/models/operations/topicscontrollerupdatetopic.ts

@@ -0,0 +1,173 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type TopicsControllerUpdateTopicRequest = {
+  /**
+   * The key identifier of the topic
+   */
+  topicKey: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  updateTopicRequestDto: components.UpdateTopicRequestDto;
+};
+
+export type TopicsControllerUpdateTopicResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.TopicResponseDto;
+};
+
+/** @internal */
+export const TopicsControllerUpdateTopicRequest$inboundSchema: z.ZodType<
+  TopicsControllerUpdateTopicRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  topicKey: z.string(),
+  "idempotency-key": z.string().optional(),
+  UpdateTopicRequestDto: components.UpdateTopicRequestDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "idempotency-key": "idempotencyKey",
+    "UpdateTopicRequestDto": "updateTopicRequestDto",
+  });
+});
+
+/** @internal */
+export type TopicsControllerUpdateTopicRequest$Outbound = {
+  topicKey: string;
+  "idempotency-key"?: string | undefined;
+  UpdateTopicRequestDto: components.UpdateTopicRequestDto$Outbound;
+};
+
+/** @internal */
+export const TopicsControllerUpdateTopicRequest$outboundSchema: z.ZodType<
+  TopicsControllerUpdateTopicRequest$Outbound,
+  z.ZodTypeDef,
+  TopicsControllerUpdateTopicRequest
+> = z.object({
+  topicKey: z.string(),
+  idempotencyKey: z.string().optional(),
+  updateTopicRequestDto: components.UpdateTopicRequestDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+    updateTopicRequestDto: "UpdateTopicRequestDto",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TopicsControllerUpdateTopicRequest$ {
+  /** @deprecated use `TopicsControllerUpdateTopicRequest$inboundSchema` instead. */
+  export const inboundSchema = TopicsControllerUpdateTopicRequest$inboundSchema;
+  /** @deprecated use `TopicsControllerUpdateTopicRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    TopicsControllerUpdateTopicRequest$outboundSchema;
+  /** @deprecated use `TopicsControllerUpdateTopicRequest$Outbound` instead. */
+  export type Outbound = TopicsControllerUpdateTopicRequest$Outbound;
+}
+
+export function topicsControllerUpdateTopicRequestToJSON(
+  topicsControllerUpdateTopicRequest: TopicsControllerUpdateTopicRequest,
+): string {
+  return JSON.stringify(
+    TopicsControllerUpdateTopicRequest$outboundSchema.parse(
+      topicsControllerUpdateTopicRequest,
+    ),
+  );
+}
+
+export function topicsControllerUpdateTopicRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<TopicsControllerUpdateTopicRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TopicsControllerUpdateTopicRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TopicsControllerUpdateTopicRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const TopicsControllerUpdateTopicResponse$inboundSchema: z.ZodType<
+  TopicsControllerUpdateTopicResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: components.TopicResponseDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type TopicsControllerUpdateTopicResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.TopicResponseDto$Outbound;
+};
+
+/** @internal */
+export const TopicsControllerUpdateTopicResponse$outboundSchema: z.ZodType<
+  TopicsControllerUpdateTopicResponse$Outbound,
+  z.ZodTypeDef,
+  TopicsControllerUpdateTopicResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.TopicResponseDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TopicsControllerUpdateTopicResponse$ {
+  /** @deprecated use `TopicsControllerUpdateTopicResponse$inboundSchema` instead. */
+  export const inboundSchema =
+    TopicsControllerUpdateTopicResponse$inboundSchema;
+  /** @deprecated use `TopicsControllerUpdateTopicResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    TopicsControllerUpdateTopicResponse$outboundSchema;
+  /** @deprecated use `TopicsControllerUpdateTopicResponse$Outbound` instead. */
+  export type Outbound = TopicsControllerUpdateTopicResponse$Outbound;
+}
+
+export function topicsControllerUpdateTopicResponseToJSON(
+  topicsControllerUpdateTopicResponse: TopicsControllerUpdateTopicResponse,
+): string {
+  return JSON.stringify(
+    TopicsControllerUpdateTopicResponse$outboundSchema.parse(
+      topicsControllerUpdateTopicResponse,
+    ),
+  );
+}
+
+export function topicsControllerUpdateTopicResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TopicsControllerUpdateTopicResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TopicsControllerUpdateTopicResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TopicsControllerUpdateTopicResponse' from JSON`,
+  );
+}

package/src/models/operations/topicscontrollerupserttopic.ts

@@ -0,0 +1,168 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type TopicsControllerUpsertTopicRequest = {
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  createUpdateTopicRequestDto: components.CreateUpdateTopicRequestDto;
+};
+
+export type TopicsControllerUpsertTopicResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.TopicResponseDto;
+};
+
+/** @internal */
+export const TopicsControllerUpsertTopicRequest$inboundSchema: z.ZodType<
+  TopicsControllerUpsertTopicRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "idempotency-key": z.string().optional(),
+  CreateUpdateTopicRequestDto:
+    components.CreateUpdateTopicRequestDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "idempotency-key": "idempotencyKey",
+    "CreateUpdateTopicRequestDto": "createUpdateTopicRequestDto",
+  });
+});
+
+/** @internal */
+export type TopicsControllerUpsertTopicRequest$Outbound = {
+  "idempotency-key"?: string | undefined;
+  CreateUpdateTopicRequestDto: components.CreateUpdateTopicRequestDto$Outbound;
+};
+
+/** @internal */
+export const TopicsControllerUpsertTopicRequest$outboundSchema: z.ZodType<
+  TopicsControllerUpsertTopicRequest$Outbound,
+  z.ZodTypeDef,
+  TopicsControllerUpsertTopicRequest
+> = z.object({
+  idempotencyKey: z.string().optional(),
+  createUpdateTopicRequestDto:
+    components.CreateUpdateTopicRequestDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+    createUpdateTopicRequestDto: "CreateUpdateTopicRequestDto",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TopicsControllerUpsertTopicRequest$ {
+  /** @deprecated use `TopicsControllerUpsertTopicRequest$inboundSchema` instead. */
+  export const inboundSchema = TopicsControllerUpsertTopicRequest$inboundSchema;
+  /** @deprecated use `TopicsControllerUpsertTopicRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    TopicsControllerUpsertTopicRequest$outboundSchema;
+  /** @deprecated use `TopicsControllerUpsertTopicRequest$Outbound` instead. */
+  export type Outbound = TopicsControllerUpsertTopicRequest$Outbound;
+}
+
+export function topicsControllerUpsertTopicRequestToJSON(
+  topicsControllerUpsertTopicRequest: TopicsControllerUpsertTopicRequest,
+): string {
+  return JSON.stringify(
+    TopicsControllerUpsertTopicRequest$outboundSchema.parse(
+      topicsControllerUpsertTopicRequest,
+    ),
+  );
+}
+
+export function topicsControllerUpsertTopicRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<TopicsControllerUpsertTopicRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TopicsControllerUpsertTopicRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TopicsControllerUpsertTopicRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const TopicsControllerUpsertTopicResponse$inboundSchema: z.ZodType<
+  TopicsControllerUpsertTopicResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: components.TopicResponseDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type TopicsControllerUpsertTopicResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.TopicResponseDto$Outbound;
+};
+
+/** @internal */
+export const TopicsControllerUpsertTopicResponse$outboundSchema: z.ZodType<
+  TopicsControllerUpsertTopicResponse$Outbound,
+  z.ZodTypeDef,
+  TopicsControllerUpsertTopicResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.TopicResponseDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TopicsControllerUpsertTopicResponse$ {
+  /** @deprecated use `TopicsControllerUpsertTopicResponse$inboundSchema` instead. */
+  export const inboundSchema =
+    TopicsControllerUpsertTopicResponse$inboundSchema;
+  /** @deprecated use `TopicsControllerUpsertTopicResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    TopicsControllerUpsertTopicResponse$outboundSchema;
+  /** @deprecated use `TopicsControllerUpsertTopicResponse$Outbound` instead. */
+  export type Outbound = TopicsControllerUpsertTopicResponse$Outbound;
+}
+
+export function topicsControllerUpsertTopicResponseToJSON(
+  topicsControllerUpsertTopicResponse: TopicsControllerUpsertTopicResponse,
+): string {
+  return JSON.stringify(
+    TopicsControllerUpsertTopicResponse$outboundSchema.parse(
+      topicsControllerUpsertTopicResponse,
+    ),
+  );
+}
+
+export function topicsControllerUpsertTopicResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TopicsControllerUpsertTopicResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TopicsControllerUpsertTopicResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TopicsControllerUpsertTopicResponse' from JSON`,
+  );
+}

package/src/models/operations/topicsv1controllergettopicsubscriber.ts

@@ -0,0 +1,191 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type TopicsV1ControllerGetTopicSubscriberRequest = {
+  /**
+   * The external subscriber id
+   */
+  externalSubscriberId: string;
+  /**
+   * The topic key
+   */
+  topicKey: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type TopicsV1ControllerGetTopicSubscriberResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.TopicSubscriberDto;
+};
+
+/** @internal */
+export const TopicsV1ControllerGetTopicSubscriberRequest$inboundSchema:
+  z.ZodType<
+    TopicsV1ControllerGetTopicSubscriberRequest,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    externalSubscriberId: z.string(),
+    topicKey: z.string(),
+    "idempotency-key": z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "idempotency-key": "idempotencyKey",
+    });
+  });
+
+/** @internal */
+export type TopicsV1ControllerGetTopicSubscriberRequest$Outbound = {
+  externalSubscriberId: string;
+  topicKey: string;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const TopicsV1ControllerGetTopicSubscriberRequest$outboundSchema:
+  z.ZodType<
+    TopicsV1ControllerGetTopicSubscriberRequest$Outbound,
+    z.ZodTypeDef,
+    TopicsV1ControllerGetTopicSubscriberRequest
+  > = z.object({
+    externalSubscriberId: z.string(),
+    topicKey: z.string(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TopicsV1ControllerGetTopicSubscriberRequest$ {
+  /** @deprecated use `TopicsV1ControllerGetTopicSubscriberRequest$inboundSchema` instead. */
+  export const inboundSchema =
+    TopicsV1ControllerGetTopicSubscriberRequest$inboundSchema;
+  /** @deprecated use `TopicsV1ControllerGetTopicSubscriberRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    TopicsV1ControllerGetTopicSubscriberRequest$outboundSchema;
+  /** @deprecated use `TopicsV1ControllerGetTopicSubscriberRequest$Outbound` instead. */
+  export type Outbound = TopicsV1ControllerGetTopicSubscriberRequest$Outbound;
+}
+
+export function topicsV1ControllerGetTopicSubscriberRequestToJSON(
+  topicsV1ControllerGetTopicSubscriberRequest:
+    TopicsV1ControllerGetTopicSubscriberRequest,
+): string {
+  return JSON.stringify(
+    TopicsV1ControllerGetTopicSubscriberRequest$outboundSchema.parse(
+      topicsV1ControllerGetTopicSubscriberRequest,
+    ),
+  );
+}
+
+export function topicsV1ControllerGetTopicSubscriberRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  TopicsV1ControllerGetTopicSubscriberRequest,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TopicsV1ControllerGetTopicSubscriberRequest$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'TopicsV1ControllerGetTopicSubscriberRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const TopicsV1ControllerGetTopicSubscriberResponse$inboundSchema:
+  z.ZodType<
+    TopicsV1ControllerGetTopicSubscriberResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())),
+    Result: components.TopicSubscriberDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+/** @internal */
+export type TopicsV1ControllerGetTopicSubscriberResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.TopicSubscriberDto$Outbound;
+};
+
+/** @internal */
+export const TopicsV1ControllerGetTopicSubscriberResponse$outboundSchema:
+  z.ZodType<
+    TopicsV1ControllerGetTopicSubscriberResponse$Outbound,
+    z.ZodTypeDef,
+    TopicsV1ControllerGetTopicSubscriberResponse
+  > = z.object({
+    headers: z.record(z.array(z.string())),
+    result: components.TopicSubscriberDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      headers: "Headers",
+      result: "Result",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TopicsV1ControllerGetTopicSubscriberResponse$ {
+  /** @deprecated use `TopicsV1ControllerGetTopicSubscriberResponse$inboundSchema` instead. */
+  export const inboundSchema =
+    TopicsV1ControllerGetTopicSubscriberResponse$inboundSchema;
+  /** @deprecated use `TopicsV1ControllerGetTopicSubscriberResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    TopicsV1ControllerGetTopicSubscriberResponse$outboundSchema;
+  /** @deprecated use `TopicsV1ControllerGetTopicSubscriberResponse$Outbound` instead. */
+  export type Outbound = TopicsV1ControllerGetTopicSubscriberResponse$Outbound;
+}
+
+export function topicsV1ControllerGetTopicSubscriberResponseToJSON(
+  topicsV1ControllerGetTopicSubscriberResponse:
+    TopicsV1ControllerGetTopicSubscriberResponse,
+): string {
+  return JSON.stringify(
+    TopicsV1ControllerGetTopicSubscriberResponse$outboundSchema.parse(
+      topicsV1ControllerGetTopicSubscriberResponse,
+    ),
+  );
+}
+
+export function topicsV1ControllerGetTopicSubscriberResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  TopicsV1ControllerGetTopicSubscriberResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TopicsV1ControllerGetTopicSubscriberResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'TopicsV1ControllerGetTopicSubscriberResponse' from JSON`,
+  );
+}

package/src/sdk/credentials.ts

@@ -12,10 +12,11 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Credentials extends ClientSDK {
   /**
-   * Update subscriber credentials
+   * Update provider credentials
    *
    * @remarks
-   * Subscriber credentials associated to the delivery methods such as slack and push tokens.
+   * Update credentials for a provider such as slack and push tokens.
+   *       **providerId** is required field. This API appends the **deviceTokens** to the existing ones.
    */
   async update(
     updateSubscriberChannelRequestDto:
@@ -36,11 +37,11 @@ export class Credentials extends ClientSDK {
   }
 
   /**
-   * Modify subscriber credentials
+   * Upsert provider credentials
    *
    * @remarks
-   * Subscriber credentials associated to the delivery methods such as slack and push tokens.
-   *     This endpoint appends provided credentials and deviceTokens to the existing ones.
+   * Update credentials for a provider such as **slack** and **FCM**.
+   *       **providerId** is required field. This API replaces the existing deviceTokens with the provided ones.
    */
   async append(
     updateSubscriberChannelRequestDto:
@@ -61,10 +62,11 @@ export class Credentials extends ClientSDK {
   }
 
   /**
-   * Delete subscriber credentials by providerId
+   * Delete provider credentials
    *
    * @remarks
-   * Delete subscriber credentials such as slack and expo tokens.
+   * Delete subscriber credentials for a provider such as **slack** and **FCM** by **providerId**.
+   *     This action is irreversible and will remove the credentials for the provider for particular **subscriberId**.
    */
   async delete(
     subscriberId: string,

package/src/sdk/integrations.ts

@@ -12,19 +12,13 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
-import { Webhooks } from "./webhooks.js";
 
 export class Integrations extends ClientSDK {
-  private _webhooks?: Webhooks;
-  get webhooks(): Webhooks {
-    return (this._webhooks ??= new Webhooks(this._options));
-  }
-
   /**
-   * Get integrations
+   * List all integrations
    *
    * @remarks
-   * Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+   * List all the channels integrations created in the organization
    */
   async list(
     idempotencyKey?: string | undefined,
@@ -38,10 +32,11 @@ export class Integrations extends ClientSDK {
   }
 
   /**
-   * Create integration
+   * Create an integration
    *
    * @remarks
-   * Create an integration for the current environment the user is based on the API key provided
+   * Create an integration for the current environment the user is based on the API key provided.
+   *     Each provider supports different credentials, check the provider documentation for more details.
    */
   async create(
     createIntegrationRequestDto: components.CreateIntegrationRequestDto,
@@ -57,7 +52,11 @@ export class Integrations extends ClientSDK {
   }
 
   /**
-   * Update integration
+   * Update an integration
+   *
+   * @remarks
+   * Update an integration by its unique key identifier **integrationId**.
+   *     Each provider supports different credentials, check the provider documentation for more details.
    */
   async update(
     updateIntegrationRequestDto: components.UpdateIntegrationRequestDto,
@@ -75,7 +74,11 @@ export class Integrations extends ClientSDK {
   }
 
   /**
-   * Delete integration
+   * Delete an integration
+   *
+   * @remarks
+   * Delete an integration by its unique key identifier **integrationId**.
+   *     This action is irreversible.
    */
   async delete(
     integrationId: string,
@@ -91,7 +94,12 @@ export class Integrations extends ClientSDK {
   }
 
   /**
-   * Set integration as primary
+   * Update integration as primary
+   *
+   * @remarks
+   * Update an integration as **primary** by its unique key identifier **integrationId**.
+   *     This API will set the integration as primary for that channel in the current environment.
+   *     Primary integration is used to deliver notification for sms and email channels in the workflow.
    */
   async setAsPrimary(
     integrationId: string,
@@ -107,10 +115,10 @@ export class Integrations extends ClientSDK {
   }
 
   /**
-   * Get active integrations
+   * List active integrations
    *
    * @remarks
-   * Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+   * List all the active integrations created in the organization
    */
   async listActive(
     idempotencyKey?: string | undefined,

package/src/sdk/messages.ts

@@ -11,10 +11,12 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Messages extends ClientSDK {
   /**
-   * Get messages
+   * List all messages
    *
    * @remarks
-   * Returns a list of messages, could paginate using the `page` query parameter
+   * List all messages for the current environment.
+   *     This API supports filtering by **channel**, **subscriberId**, and **transactionId**.
+   *     This API returns a paginated list of messages.
    */
   async retrieve(
     request: operations.MessagesControllerGetMessagesRequest,
@@ -28,10 +30,11 @@ export class Messages extends ClientSDK {
   }
 
   /**
-   * Delete message
+   * Delete a message
    *
    * @remarks
-   * Deletes a message entity from the Novu platform
+   * Delete a message entity from the Novu platform by **messageId**.
+   *     This action is irreversible. **messageId** is required and of mongodbId type.
    */
   async delete(
     messageId: string,
@@ -50,7 +53,8 @@ export class Messages extends ClientSDK {
    * Delete messages by transactionId
    *
    * @remarks
-   * Deletes messages entity from the Novu platform using TransactionId of message
+   * Delete multiple messages from the Novu platform using **transactionId** of triggered event.
+   *     This API supports filtering by **channel** and delete all messages associated with the **transactionId**.
    */
   async deleteByTransactionId(
     transactionId: string,