@novu/api 3.12.0-rc.0 → 3.12.0

package/src/models/operations/topicscontrollergettopicsubscription.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 TopicsControllerGetTopicSubscriptionRequest = {
+  /**
+   * The key identifier of the topic
+   */
+  topicKey: string;
+  /**
+   * The unique identifier of the subscription
+   */
+  identifier: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type TopicsControllerGetTopicSubscriptionResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.SubscriptionResponseDto;
+};
+
+/** @internal */
+export type TopicsControllerGetTopicSubscriptionRequest$Outbound = {
+  topicKey: string;
+  identifier: string;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const TopicsControllerGetTopicSubscriptionRequest$outboundSchema:
+  z.ZodType<
+    TopicsControllerGetTopicSubscriptionRequest$Outbound,
+    z.ZodTypeDef,
+    TopicsControllerGetTopicSubscriptionRequest
+  > = z.object({
+    topicKey: z.string(),
+    identifier: z.string(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
+  });
+
+export function topicsControllerGetTopicSubscriptionRequestToJSON(
+  topicsControllerGetTopicSubscriptionRequest:
+    TopicsControllerGetTopicSubscriptionRequest,
+): string {
+  return JSON.stringify(
+    TopicsControllerGetTopicSubscriptionRequest$outboundSchema.parse(
+      topicsControllerGetTopicSubscriptionRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const TopicsControllerGetTopicSubscriptionResponse$inboundSchema:
+  z.ZodType<
+    TopicsControllerGetTopicSubscriptionResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.SubscriptionResponseDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function topicsControllerGetTopicSubscriptionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  TopicsControllerGetTopicSubscriptionResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TopicsControllerGetTopicSubscriptionResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'TopicsControllerGetTopicSubscriptionResponse' from JSON`,
+  );
+}

package/src/models/operations/topicscontrollerupdatetopicsubscription.ts

@@ -17,7 +17,7 @@ export type TopicsControllerUpdateTopicSubscriptionRequest = {
   /**
    * The unique identifier of the subscription
    */
-  subscriptionIdOrIdentifier: string;
+  identifier: string;
   /**
    * A header for idempotency purposes
    */
@@ -34,7 +34,7 @@ export type TopicsControllerUpdateTopicSubscriptionResponse = {
 /** @internal */
 export type TopicsControllerUpdateTopicSubscriptionRequest$Outbound = {
   topicKey: string;
-  subscriptionIdOrIdentifier: string;
+  identifier: string;
   "idempotency-key"?: string | undefined;
   UpdateTopicSubscriptionRequestDto:
     components.UpdateTopicSubscriptionRequestDto$Outbound;
@@ -48,7 +48,7 @@ export const TopicsControllerUpdateTopicSubscriptionRequest$outboundSchema:
     TopicsControllerUpdateTopicSubscriptionRequest
   > = z.object({
     topicKey: z.string(),
-    subscriptionIdOrIdentifier: z.string(),
+    identifier: z.string(),
     idempotencyKey: z.string().optional(),
     updateTopicSubscriptionRequestDto:
       components.UpdateTopicSubscriptionRequestDto$outboundSchema,

package/src/sdk/channelconnections.ts

@@ -14,10 +14,10 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class ChannelConnections extends ClientSDK {
   /**
-   * List channel connections
+   * List all channel connections
    *
    * @remarks
-   * Retrieve all channel connections for a resource.
+   * List all channel connections for a resource.
    */
   async list(
     request:
@@ -34,7 +34,7 @@ export class ChannelConnections extends ClientSDK {
   }
 
   /**
-   * Create channel connection for a resource and integration
+   * Create a channel connection
    *
    * @remarks
    * Create a new channel connection for a resource for given integration. Only one channel connection is allowed per resource and integration.
@@ -56,7 +56,7 @@ export class ChannelConnections extends ClientSDK {
   }
 
   /**
-   * Retrieve channel connection by identifier
+   * Retrieve a channel connection
    *
    * @remarks
    * Retrieve a specific channel connection by its unique identifier.
@@ -77,7 +77,7 @@ export class ChannelConnections extends ClientSDK {
   }
 
   /**
-   * Update channel connection
+   * Update a channel connection
    *
    * @remarks
    * Update an existing channel connection by its unique identifier.
@@ -101,7 +101,7 @@ export class ChannelConnections extends ClientSDK {
   }
 
   /**
-   * Delete channel connection
+   * Delete a channel connection
    *
    * @remarks
    * Delete a specific channel connection by its unique identifier.

package/src/sdk/channelendpoints.ts

@@ -14,10 +14,10 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class ChannelEndpoints extends ClientSDK {
   /**
-   * List channel endpoints
+   * List all channel endpoints
    *
    * @remarks
-   * Retrieve all channel endpoints for a resource based on query filters.
+   * List all channel endpoints for a resource based on query filters.
    */
   async list(
     request: operations.ChannelEndpointsControllerListChannelEndpointsRequest,
@@ -33,7 +33,7 @@ export class ChannelEndpoints extends ClientSDK {
   }
 
   /**
-   * Create channel endpoint for a resource
+   * Create a channel endpoint
    *
    * @remarks
    * Create a new channel endpoint for a resource.
@@ -55,7 +55,7 @@ export class ChannelEndpoints extends ClientSDK {
   }
 
   /**
-   * Retrieve channel endpoint by identifier
+   * Retrieve a channel endpoint
    *
    * @remarks
    * Retrieve a specific channel endpoint by its unique identifier.
@@ -74,7 +74,7 @@ export class ChannelEndpoints extends ClientSDK {
   }
 
   /**
-   * Update channel endpoint
+   * Update a channel endpoint
    *
    * @remarks
    * Update an existing channel endpoint by its unique identifier.
@@ -97,7 +97,7 @@ export class ChannelEndpoints extends ClientSDK {
   }
 
   /**
-   * Delete channel endpoint by identifier
+   * Delete a channel endpoint
    *
    * @remarks
    * Delete a specific channel endpoint by its unique identifier.

package/src/sdk/sdk.ts

@@ -95,7 +95,7 @@ export class Novu extends ClientSDK {
    *
    * @remarks
    *
-   *     Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Additional information can be passed according the body interface below.
+   *     Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Maximum number of recipients can be 100. Additional information can be passed according the body interface below.
    *     To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.
    */
   async trigger(

package/src/sdk/subscriptions.ts

@@ -4,6 +4,7 @@
 
 import { topicsSubscriptionsCreate } from "../funcs/topicsSubscriptionsCreate.js";
 import { topicsSubscriptionsDelete } from "../funcs/topicsSubscriptionsDelete.js";
+import { topicsSubscriptionsGetSubscription } from "../funcs/topicsSubscriptionsGetSubscription.js";
 import { topicsSubscriptionsList } from "../funcs/topicsSubscriptionsList.js";
 import { topicsSubscriptionsUpdate } from "../funcs/topicsSubscriptionsUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -75,11 +76,32 @@ export class Subscriptions extends ClientSDK {
     ));
   }
 
+  /**
+   * Get a topic subscription
+   *
+   * @remarks
+   * Get a subscription by its unique identifier for a topic.
+   */
+  async getSubscription(
+    topicKey: string,
+    identifier: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.TopicsControllerGetTopicSubscriptionResponse> {
+    return unwrapAsync(topicsSubscriptionsGetSubscription(
+      this,
+      topicKey,
+      identifier,
+      idempotencyKey,
+      options,
+    ));
+  }
+
   /**
    * Update a topic subscription
    *
    * @remarks
-   * Update a subscription by its unique identifier **subscriptionIdOrIdentifier** for a topic. You can update the preferences and name associated with the subscription.
+   * Update a subscription by its unique identifier for a topic. You can update the preferences and name associated with the subscription.
    */
   async update(
     request: operations.TopicsControllerUpdateTopicSubscriptionRequest,