@novu/api 1.3.0 → 1.5.0

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";
@@ -10,13 +11,20 @@ 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 { Environments } from "./environments.js";
 import { Integrations } from "./integrations.js";
 import { Messages } from "./messages.js";
 import { Notifications } from "./notifications.js";
 import { Subscribers } from "./subscribers.js";
 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));
@@ -27,6 +35,11 @@ export class Novu extends ClientSDK {
     return (this._topics ??= new Topics(this._options));
   }
 
+  private _workflows?: Workflows;
+  get workflows(): Workflows {
+    return (this._workflows ??= new Workflows(this._options));
+  }
+
   private _integrations?: Integrations;
   get integrations(): Integrations {
     return (this._integrations ??= new Integrations(this._options));
@@ -125,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/sdk/steps.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { workflowsStepsRetrieve } from "../funcs/workflowsStepsRetrieve.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Steps extends ClientSDK {
+  /**
+   * Retrieve workflow step
+   *
+   * @remarks
+   * Retrieves data for a specific step in a workflow
+   */
+  async retrieve(
+    workflowId: string,
+    stepId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.WorkflowControllerGetWorkflowStepDataResponse> {
+    return unwrapAsync(workflowsStepsRetrieve(
+      this,
+      workflowId,
+      stepId,
+      idempotencyKey,
+      options,
+    ));
+  }
+}

package/src/sdk/workflows.ts

@@ -0,0 +1,162 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { workflowsCreate } from "../funcs/workflowsCreate.js";
+import { workflowsDelete } from "../funcs/workflowsDelete.js";
+import { workflowsGet } from "../funcs/workflowsGet.js";
+import { workflowsList } from "../funcs/workflowsList.js";
+import { workflowsPatch } from "../funcs/workflowsPatch.js";
+import { workflowsSync } from "../funcs/workflowsSync.js";
+import { workflowsUpdate } from "../funcs/workflowsUpdate.js";
+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 { Steps } from "./steps.js";
+
+export class Workflows extends ClientSDK {
+  private _steps?: Steps;
+  get steps(): Steps {
+    return (this._steps ??= new Steps(this._options));
+  }
+
+  /**
+   * Create a workflow
+   *
+   * @remarks
+   * Creates a new workflow in the Novu Cloud environment
+   */
+  async create(
+    createWorkflowDto: components.CreateWorkflowDto,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.WorkflowControllerCreateResponse> {
+    return unwrapAsync(workflowsCreate(
+      this,
+      createWorkflowDto,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * List all workflows
+   *
+   * @remarks
+   * Retrieves a list of workflows with optional filtering and pagination
+   */
+  async list(
+    request: operations.WorkflowControllerSearchWorkflowsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.WorkflowControllerSearchWorkflowsResponse> {
+    return unwrapAsync(workflowsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a workflow
+   *
+   * @remarks
+   * Updates the details of an existing workflow, here **workflowId** is the identifier of the workflow
+   */
+  async update(
+    updateWorkflowDto: components.UpdateWorkflowDto,
+    workflowId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.WorkflowControllerUpdateResponse> {
+    return unwrapAsync(workflowsUpdate(
+      this,
+      updateWorkflowDto,
+      workflowId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a workflow
+   *
+   * @remarks
+   * Fetches details of a specific workflow by its unique identifier **workflowId**
+   */
+  async get(
+    workflowId: string,
+    environmentId?: string | undefined,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.WorkflowControllerGetWorkflowResponse> {
+    return unwrapAsync(workflowsGet(
+      this,
+      workflowId,
+      environmentId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a workflow
+   *
+   * @remarks
+   * Removes a specific workflow by its unique identifier **workflowId**
+   */
+  async delete(
+    workflowId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.WorkflowControllerRemoveWorkflowResponse | undefined> {
+    return unwrapAsync(workflowsDelete(
+      this,
+      workflowId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Update a workflow
+   *
+   * @remarks
+   * Partially updates a workflow by its unique identifier **workflowId**
+   */
+  async patch(
+    patchWorkflowDto: components.PatchWorkflowDto,
+    workflowId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.WorkflowControllerPatchWorkflowResponse> {
+    return unwrapAsync(workflowsPatch(
+      this,
+      patchWorkflowDto,
+      workflowId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Sync a workflow
+   *
+   * @remarks
+   * Synchronizes a workflow to the target environment
+   */
+  async sync(
+    syncWorkflowDto: components.SyncWorkflowDto,
+    workflowId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.WorkflowControllerSyncResponse> {
+    return unwrapAsync(workflowsSync(
+      this,
+      syncWorkflowDto,
+      workflowId,
+      idempotencyKey,
+      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/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;
-}