@novu/api 1.4.0 → 1.6.0

package/docs/sdks/topics/README.md

@@ -22,6 +22,7 @@ This api returns a paginated list of topics.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="TopicsController_listTopics" method="get" path="/v2/topics" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -90,10 +91,11 @@ run();
 
 ## create
 
-Creates a new topic if it does not exist, or updates an existing topic if it already exists
+Creates a new topic if it does not exist, or updates an existing topic if it already exists. Use ?failIfExists=true to prevent updates.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="TopicsController_upsertTopic" method="post" path="/v2/topics" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -148,6 +150,7 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `createUpdateTopicRequestDto`                                                                                                                                                  | [components.CreateUpdateTopicRequestDto](../../models/components/createupdatetopicrequestdto.md)                                                                               | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `failIfExists`                                                                                                                                                                 | *boolean*                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                             | If true, the request will fail if a topic with the same key already exists                                                                                                     |
 | `idempotencyKey`                                                                                                                                                               | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | A header for idempotency purposes                                                                                                                                              |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
@@ -159,13 +162,14 @@ run();
 
 ### Errors
 
-| Error Type                             | Status Code                            | Content Type                           |
-| -------------------------------------- | -------------------------------------- | -------------------------------------- |
-| errors.ErrorDto                        | 414                                    | application/json                       |
-| errors.ErrorDto                        | 400, 401, 403, 404, 405, 409, 413, 415 | application/json                       |
-| errors.ValidationErrorDto              | 422                                    | application/json                       |
-| errors.ErrorDto                        | 500                                    | application/json                       |
-| errors.SDKError                        | 4XX, 5XX                               | \*/\*                                  |
+| Error Type                        | Status Code                       | Content Type                      |
+| --------------------------------- | --------------------------------- | --------------------------------- |
+| errors.TopicResponseDto           | 409                               | application/json                  |
+| errors.ErrorDto                   | 414                               | application/json                  |
+| errors.ErrorDto                   | 400, 401, 403, 404, 405, 413, 415 | application/json                  |
+| errors.ValidationErrorDto         | 422                               | application/json                  |
+| errors.ErrorDto                   | 500                               | application/json                  |
+| errors.SDKError                   | 4XX, 5XX                          | \*/\*                             |
 
 ## get
 
@@ -173,6 +177,7 @@ Retrieve a topic by its unique key identifier **topicKey**
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="TopicsController_getTopic" method="get" path="/v2/topics/{topicKey}" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -246,6 +251,7 @@ Update a topic name by its unique key identifier **topicKey**
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="TopicsController_updateTopic" method="patch" path="/v2/topics/{topicKey}" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -325,6 +331,7 @@ Delete a topic by its unique key identifier **topicKey**.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="TopicsController_deleteTopic" method="delete" path="/v2/topics/{topicKey}" -->
 ```typescript
 import { Novu } from "@novu/api";
 

package/docs/sdks/workflows/README.md

@@ -22,6 +22,7 @@ Creates a new workflow in the Novu Cloud environment
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="WorkflowController_create" method="post" path="/v2/workflows" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -159,6 +160,7 @@ Retrieves a list of workflows with optional filtering and pagination
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="WorkflowController_searchWorkflows" method="get" path="/v2/workflows" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -231,6 +233,7 @@ Updates the details of an existing workflow, here **workflowId** is the identifi
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="WorkflowController_update" method="put" path="/v2/workflows/{workflowId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -369,6 +372,7 @@ Fetches details of a specific workflow by its unique identifier **workflowId**
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="WorkflowController_getWorkflow" method="get" path="/v2/workflows/{workflowId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -443,6 +447,7 @@ Removes a specific workflow by its unique identifier **workflowId**
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="WorkflowController_removeWorkflow" method="delete" path="/v2/workflows/{workflowId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -516,6 +521,7 @@ Partially updates a workflow by its unique identifier **workflowId**
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="WorkflowController_patchWorkflow" method="patch" path="/v2/workflows/{workflowId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -590,6 +596,7 @@ Synchronizes a workflow to the target environment
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="WorkflowController_sync" method="put" path="/v2/workflows/{workflowId}/sync" -->
 ```typescript
 import { Novu } from "@novu/api";
 

package/examples/README.md

@@ -0,0 +1,31 @@
+# @novu/api Examples
+
+This directory contains example scripts demonstrating how to use the @novu/api SDK.
+
+## Prerequisites
+
+- Node.js (v18 or higher)
+- npm
+
+## Setup
+
+1. Copy `.env.template` to `.env`:
+   ```bash
+   cp .env.template .env
+   ```
+
+2. Edit `.env` and add your actual credentials
+
+## Running the Examples
+
+To run an example file from the examples directory:
+
+```bash
+npm run build && npx tsx example.ts
+```
+
+## Creating new examples
+
+Duplicate an existing example file, they won't be overwritten by the generation process.
+
+