@novu/api 0.1.6 → 2.6.5

package/src/funcs/{subscribersDeleteLegacy.ts → workflowsWorkflowControllerPatchWorkflowStepData.ts}

@@ -23,22 +23,15 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
-/**
- * Delete subscriber
- *
- * @remarks
- * Deletes a subscriber entity from the Novu platform
- *
- * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
- */
-export async function subscribersDeleteLegacy(
+export async function workflowsWorkflowControllerPatchWorkflowStepData(
   client: NovuCore,
-  subscriberId: string,
+  workflowId: string,
+  stepId: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): Promise<
   Result<
-    operations.SubscribersV1ControllerRemoveSubscriberResponse,
+    operations.WorkflowControllerPatchWorkflowStepDataResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -52,15 +45,16 @@ export async function subscribersDeleteLegacy(
     | ConnectionError
   >
 > {
-  const input: operations.SubscribersV1ControllerRemoveSubscriberRequest = {
-    subscriberId: subscriberId,
+  const input: operations.WorkflowControllerPatchWorkflowStepDataRequest = {
+    workflowId: workflowId,
+    stepId: stepId,
     idempotencyKey: idempotencyKey,
   };
 
   const parsed = safeParse(
     input,
     (value) =>
-      operations.SubscribersV1ControllerRemoveSubscriberRequest$outboundSchema
+      operations.WorkflowControllerPatchWorkflowStepDataRequest$outboundSchema
         .parse(value),
     "Input validation failed",
   );
@@ -71,13 +65,19 @@ export async function subscribersDeleteLegacy(
   const body = null;
 
   const pathParams = {
-    subscriberId: encodeSimple("subscriberId", payload.subscriberId, {
+    stepId: encodeSimple("stepId", payload.stepId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    workflowId: encodeSimple("workflowId", payload.workflowId, {
       explode: false,
       charEncoding: "percent",
     }),
   };
 
-  const path = pathToFunc("/v1/subscribers/{subscriberId}")(pathParams);
+  const path = pathToFunc("/v2/workflows/{workflowId}/steps/{stepId}")(
+    pathParams,
+  );
 
   const headers = new Headers(compactMap({
     Accept: "application/json",
@@ -88,17 +88,16 @@ export async function subscribersDeleteLegacy(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    operationID: "SubscribersV1Controller_removeSubscriber",
+    operationID: "WorkflowController_patchWorkflowStepData",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {
@@ -117,7 +116,7 @@ export async function subscribersDeleteLegacy(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "DELETE",
+    method: "PATCH",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
@@ -161,7 +160,7 @@ export async function subscribersDeleteLegacy(
   };
 
   const [result] = await M.match<
-    operations.SubscribersV1ControllerRemoveSubscriberResponse,
+    operations.WorkflowControllerPatchWorkflowStepDataResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -176,8 +175,8 @@ export async function subscribersDeleteLegacy(
   >(
     M.json(
       200,
-      operations.SubscribersV1ControllerRemoveSubscriberResponse$inboundSchema,
-      { hdrs: true, key: "Result" },
+      operations.WorkflowControllerPatchWorkflowStepDataResponse$inboundSchema,
+      { key: "Result" },
     ),
     M.jsonErr(414, errors.ErrorDto$inboundSchema),
     M.jsonErr(

package/src/funcs/workflowsWorkflowControllerSearchWorkflows.ts

@@ -0,0 +1,183 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { Result } from "../types/fp.js";
+
+export async function workflowsWorkflowControllerSearchWorkflows(
+  client: NovuCore,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    operations.WorkflowControllerSearchWorkflowsResponse,
+    | errors.ErrorDto
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | errors.ErrorDto
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const input: operations.WorkflowControllerSearchWorkflowsRequest = {
+    idempotencyKey: idempotencyKey,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.WorkflowControllerSearchWorkflowsRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v2/workflows")();
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+    "idempotency-key": encodeSimple(
+      "idempotency-key",
+      payload["idempotency-key"],
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    operationID: "WorkflowController_searchWorkflows",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 1000,
+          maxInterval: 30000,
+          exponent: 1.5,
+          maxElapsedTime: 3600000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["408", "409", "429", "5XX"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: [
+      "400",
+      "401",
+      "403",
+      "404",
+      "405",
+      "409",
+      "413",
+      "414",
+      "415",
+      "422",
+      "429",
+      "4XX",
+      "500",
+      "503",
+      "5XX",
+    ],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.WorkflowControllerSearchWorkflowsResponse,
+    | errors.ErrorDto
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | errors.ErrorDto
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(
+      200,
+      operations.WorkflowControllerSearchWorkflowsResponse$inboundSchema,
+      { key: "Result" },
+    ),
+    M.jsonErr(414, errors.ErrorDto$inboundSchema),
+    M.jsonErr(
+      [400, 401, 403, 404, 405, 409, 413, 415],
+      errors.ErrorDto$inboundSchema,
+      { hdrs: true },
+    ),
+    M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }),
+    M.fail(429),
+    M.jsonErr(500, errors.ErrorDto$inboundSchema, { hdrs: true }),
+    M.fail(503),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/funcs/workflowsWorkflowControllerSync.ts

@@ -0,0 +1,188 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { Result } from "../types/fp.js";
+
+export async function workflowsWorkflowControllerSync(
+  client: NovuCore,
+  workflowId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    operations.WorkflowControllerSyncResponse,
+    | errors.ErrorDto
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | errors.ErrorDto
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const input: operations.WorkflowControllerSyncRequest = {
+    workflowId: workflowId,
+    idempotencyKey: idempotencyKey,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.WorkflowControllerSyncRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    workflowId: encodeSimple("workflowId", payload.workflowId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v2/workflows/{workflowId}/sync")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+    "idempotency-key": encodeSimple(
+      "idempotency-key",
+      payload["idempotency-key"],
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    operationID: "WorkflowController_sync",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 1000,
+          maxInterval: 30000,
+          exponent: 1.5,
+          maxElapsedTime: 3600000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["408", "409", "429", "5XX"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "PUT",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: [
+      "400",
+      "401",
+      "403",
+      "404",
+      "405",
+      "409",
+      "413",
+      "414",
+      "415",
+      "422",
+      "429",
+      "4XX",
+      "500",
+      "503",
+      "5XX",
+    ],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.WorkflowControllerSyncResponse,
+    | errors.ErrorDto
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | errors.ErrorDto
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, operations.WorkflowControllerSyncResponse$inboundSchema, {
+      key: "Result",
+    }),
+    M.jsonErr(414, errors.ErrorDto$inboundSchema),
+    M.jsonErr(
+      [400, 401, 403, 404, 405, 409, 413, 415],
+      errors.ErrorDto$inboundSchema,
+      { hdrs: true },
+    ),
+    M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }),
+    M.fail(429),
+    M.jsonErr(500, errors.ErrorDto$inboundSchema, { hdrs: true }),
+    M.fail(503),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/lib/config.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import * as components from "../models/components/index.js";
 import { HTTPClient } from "./http.js";
 import { Logger } from "./logger.js";
 import { RetryConfig } from "./retries.js";
@@ -16,7 +17,10 @@ export const ServerList = [
 ] as const;
 
 export type SDKOptions = {
-  secretKey?: string | (() => Promise<string>);
+  /**
+   * The security details required to authenticate the SDK
+   */
+  security?: components.Security | (() => Promise<components.Security>);
 
   httpClient?: HTTPClient;
   /**
@@ -55,7 +59,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "0.1.6",
-  genVersion: "2.503.2",
-  userAgent: "speakeasy-sdk/typescript 0.1.6 2.503.2 1.0 @novu/api",
+  sdkVersion: "0.1.19",
+  genVersion: "2.506.0",
+  userAgent: "speakeasy-sdk/typescript 0.1.19 2.506.0 1.0 @novu/api",
 } as const;

package/src/lib/security.ts

@@ -239,6 +239,13 @@ export function resolveGlobalSecurity(
         value: security?.secretKey,
       },
     ],
+    [
+      {
+        fieldName: "Authorization",
+        type: "http:bearer",
+        value: security?.bearerAuth,
+      },
+    ],
   );
 }
 

package/src/models/components/generatepreviewresponsedto.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GeneratePreviewResponseDto = {};
+
+/** @internal */
+export const GeneratePreviewResponseDto$inboundSchema: z.ZodType<
+  GeneratePreviewResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type GeneratePreviewResponseDto$Outbound = {};
+
+/** @internal */
+export const GeneratePreviewResponseDto$outboundSchema: z.ZodType<
+  GeneratePreviewResponseDto$Outbound,
+  z.ZodTypeDef,
+  GeneratePreviewResponseDto
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GeneratePreviewResponseDto$ {
+  /** @deprecated use `GeneratePreviewResponseDto$inboundSchema` instead. */
+  export const inboundSchema = GeneratePreviewResponseDto$inboundSchema;
+  /** @deprecated use `GeneratePreviewResponseDto$outboundSchema` instead. */
+  export const outboundSchema = GeneratePreviewResponseDto$outboundSchema;
+  /** @deprecated use `GeneratePreviewResponseDto$Outbound` instead. */
+  export type Outbound = GeneratePreviewResponseDto$Outbound;
+}
+
+export function generatePreviewResponseDtoToJSON(
+  generatePreviewResponseDto: GeneratePreviewResponseDto,
+): string {
+  return JSON.stringify(
+    GeneratePreviewResponseDto$outboundSchema.parse(generatePreviewResponseDto),
+  );
+}
+
+export function generatePreviewResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GeneratePreviewResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GeneratePreviewResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GeneratePreviewResponseDto' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -23,7 +23,6 @@ export * from "./buttontypeenum.js";
 export * from "./channelcredentials.js";
 export * from "./channelcredentialsdto.js";
 export * from "./channelctatypeenum.js";
-export * from "./channelpreference.js";
 export * from "./channelsettingsdto.js";
 export * from "./channeltypeenum.js";
 export * from "./createdsubscriberdto.js";
@@ -36,7 +35,6 @@ export * from "./databooleandto.js";
 export * from "./delayregularmetadata.js";
 export * from "./delayscheduledmetadata.js";
 export * from "./deletemessageresponsedto.js";
-export * from "./deletesubscriberresponsedto.js";
 export * from "./digestmetadatadto.js";
 export * from "./digestregularmetadata.js";
 export * from "./digesttimedconfigdto.js";
@@ -53,8 +51,8 @@ export * from "./failedoperationdto.js";
 export * from "./feedresponsedto.js";
 export * from "./fieldfilterpartdto.js";
 export * from "./filtertopicsresponsedto.js";
+export * from "./generatepreviewresponsedto.js";
 export * from "./getsubscriberpreferencesdto.js";
-export * from "./getsubscriberpreferencesresponsedto.js";
 export * from "./gettopicresponsedto.js";
 export * from "./globalpreferencedto.js";
 export * from "./integrationresponsedto.js";
@@ -79,16 +77,13 @@ export * from "./notificationstepdata.js";
 export * from "./notificationstepdto.js";
 export * from "./notificationtrigger.js";
 export * from "./notificationtriggerdto.js";
-export * from "./notificationtriggerresponse.js";
 export * from "./notificationtriggervariable.js";
-export * from "./notificationtriggervariableresponse.js";
 export * from "./ordinalenum.js";
 export * from "./ordinalvalueenum.js";
 export * from "./overrides.js";
 export * from "./patchpreferencechannelsdto.js";
 export * from "./patchsubscriberpreferencesdto.js";
 export * from "./patchsubscriberrequestdto.js";
-export * from "./preference.js";
 export * from "./preferencechannels.js";
 export * from "./providersidenum.js";
 export * from "./removesubscriberresponsedto.js";
@@ -103,7 +98,6 @@ export * from "./subscriberchanneldto.js";
 export * from "./subscriberfeedresponsedto.js";
 export * from "./subscriberpayloaddto.js";
 export * from "./subscriberresponsedto.js";
-export * from "./templateresponse.js";
 export * from "./tenantpayloaddto.js";
 export * from "./textalignenum.js";
 export * from "./timedconfig.js";
@@ -114,18 +108,11 @@ export * from "./triggereventrequestdto.js";
 export * from "./triggereventresponsedto.js";
 export * from "./triggereventtoallrequestdto.js";
 export * from "./triggerrecipientstypeenum.js";
-export * from "./triggerreservedvariableresponse.js";
-export * from "./triggertypeenum.js";
 export * from "./unseencountresponse.js";
 export * from "./updatedsubscriberdto.js";
 export * from "./updateintegrationrequestdto.js";
 export * from "./updatesubscriberchannelrequestdto.js";
-export * from "./updatesubscriberglobalpreferencesrequestdto.js";
 export * from "./updatesubscriberonlineflagrequestdto.js";
-export * from "./updatesubscriberpreferenceglobalresponsedto.js";
-export * from "./updatesubscriberpreferencerequestdto.js";
-export * from "./updatesubscriberpreferenceresponsedto.js";
-export * from "./updatesubscriberrequestdto.js";
 export * from "./workflowinfodto.js";
 export * from "./workflowpreferencedto.js";
 export * from "./workflowresponse.js";

package/src/models/components/security.ts

@@ -8,7 +8,8 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type Security = {
-  secretKey: string;
+  secretKey?: string | undefined;
+  bearerAuth?: string | undefined;
 };
 
 /** @internal */
@@ -17,12 +18,14 @@ export const Security$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  secretKey: z.string(),
+  secretKey: z.string().optional(),
+  bearerAuth: z.string().optional(),
 });
 
 /** @internal */
 export type Security$Outbound = {
-  secretKey: string;
+  secretKey?: string | undefined;
+  bearerAuth?: string | undefined;
 };
 
 /** @internal */
@@ -31,7 +34,8 @@ export const Security$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Security
 > = z.object({
-  secretKey: z.string(),
+  secretKey: z.string().optional(),
+  bearerAuth: z.string().optional(),
 });
 
 /**