@novu/api 0.1.2 → 0.1.6

package/src/funcs/{subscribersPreferencesUpdateGlobal.ts → subscribersPreferencesLegacyUpdateGlobal.ts}

@@ -27,7 +27,7 @@ import { Result } from "../types/fp.js";
 /**
  * Update subscriber global preferences
  */
-export async function subscribersPreferencesUpdateGlobal(
+export async function subscribersPreferencesLegacyUpdateGlobal(
   client: NovuCore,
   updateSubscriberGlobalPreferencesRequestDto:
     components.UpdateSubscriberGlobalPreferencesRequestDto,

package/src/funcs/{subscribersPreferencesList.ts → subscribersPreferencesListLegacy.ts}

@@ -25,8 +25,10 @@ import { Result } from "../types/fp.js";
 
 /**
  * Get subscriber preferences
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
-export async function subscribersPreferencesList(
+export async function subscribersPreferencesListLegacy(
   client: NovuCore,
   subscriberId: string,
   includeInactiveChannels?: boolean | undefined,

package/src/funcs/subscribersPreferencesRetrieve.ts

@@ -0,0 +1,203 @@
+/*
+ * 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";
+
+/**
+ * Get subscriber preferences
+ *
+ * @remarks
+ * Get subscriber global and workflow specific preferences
+ */
+export async function subscribersPreferencesRetrieve(
+  client: NovuCore,
+  subscriberId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    operations.SubscribersControllerGetSubscriberPreferencesResponse,
+    | errors.ErrorDto
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | errors.ErrorDto
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const input: operations.SubscribersControllerGetSubscriberPreferencesRequest =
+    {
+      subscriberId: subscriberId,
+      idempotencyKey: idempotencyKey,
+    };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations
+        .SubscribersControllerGetSubscriberPreferencesRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    subscriberId: encodeSimple("subscriberId", payload.subscriberId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v2/subscribers/{subscriberId}/preferences")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+    "idempotency-key": encodeSimple(
+      "idempotency-key",
+      payload["idempotency-key"],
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const secConfig = await extractSecurity(client._options.secretKey);
+  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    operationID: "SubscribersController_getSubscriberPreferences",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.secretKey,
+    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.SubscribersControllerGetSubscriberPreferencesResponse,
+    | errors.ErrorDto
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | errors.ErrorDto
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(
+      200,
+      operations
+        .SubscribersControllerGetSubscriberPreferencesResponse$inboundSchema,
+      { hdrs: true, 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/{subscribersPreferencesRetrieveByLevel.ts → subscribersPreferencesRetrieveByLevelLegacy.ts}

@@ -25,8 +25,10 @@ import { Result } from "../types/fp.js";
 
 /**
  * Get subscriber preferences by level
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
-export async function subscribersPreferencesRetrieveByLevel(
+export async function subscribersPreferencesRetrieveByLevelLegacy(
   client: NovuCore,
   request:
     operations.SubscribersV1ControllerGetSubscriberPreferenceByLevelRequest,

package/src/funcs/subscribersPreferencesUpdate.ts

@@ -10,6 +10,7 @@ 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 * as components from "../models/components/index.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -24,15 +25,20 @@ import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update subscriber preference
+ * Update subscriber global or workflow specific preferences
+ *
+ * @remarks
+ * Update subscriber global or workflow specific preferences
  */
 export async function subscribersPreferencesUpdate(
   client: NovuCore,
-  request: operations.SubscribersV1ControllerUpdateSubscriberPreferenceRequest,
+  patchSubscriberPreferencesDto: components.PatchSubscriberPreferencesDto,
+  subscriberId: string,
+  idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): Promise<
   Result<
-    operations.SubscribersV1ControllerUpdateSubscriberPreferenceResponse,
+    operations.SubscribersControllerUpdateSubscriberPreferencesResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -46,11 +52,18 @@ export async function subscribersPreferencesUpdate(
     | ConnectionError
   >
 > {
+  const input:
+    operations.SubscribersControllerUpdateSubscriberPreferencesRequest = {
+      patchSubscriberPreferencesDto: patchSubscriberPreferencesDto,
+      subscriberId: subscriberId,
+      idempotencyKey: idempotencyKey,
+    };
+
   const parsed = safeParse(
-    request,
+    input,
     (value) =>
       operations
-        .SubscribersV1ControllerUpdateSubscriberPreferenceRequest$outboundSchema
+        .SubscribersControllerUpdateSubscriberPreferencesRequest$outboundSchema
         .parse(value),
     "Input validation failed",
   );
@@ -58,26 +71,20 @@ export async function subscribersPreferencesUpdate(
     return parsed;
   }
   const payload = parsed.value;
-  const body = encodeJSON(
-    "body",
-    payload.UpdateSubscriberPreferenceRequestDto,
-    { explode: true },
-  );
+  const body = encodeJSON("body", payload.PatchSubscriberPreferencesDto, {
+    explode: true,
+  });
 
   const pathParams = {
     subscriberId: encodeSimple("subscriberId", payload.subscriberId, {
       explode: false,
       charEncoding: "percent",
     }),
-    parameter: encodeSimple("parameter", payload.workflowId, {
-      explode: false,
-      charEncoding: "percent",
-    }),
   };
 
-  const path = pathToFunc(
-    "/v1/subscribers/{subscriberId}/preferences/{parameter}",
-  )(pathParams);
+  const path = pathToFunc("/v2/subscribers/{subscriberId}/preferences")(
+    pathParams,
+  );
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -94,7 +101,7 @@ export async function subscribersPreferencesUpdate(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    operationID: "SubscribersV1Controller_updateSubscriberPreference",
+    operationID: "SubscribersController_updateSubscriberPreferences",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
@@ -162,7 +169,7 @@ export async function subscribersPreferencesUpdate(
   };
 
   const [result] = await M.match<
-    operations.SubscribersV1ControllerUpdateSubscriberPreferenceResponse,
+    operations.SubscribersControllerUpdateSubscriberPreferencesResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -178,7 +185,7 @@ export async function subscribersPreferencesUpdate(
     M.json(
       200,
       operations
-        .SubscribersV1ControllerUpdateSubscriberPreferenceResponse$inboundSchema,
+        .SubscribersControllerUpdateSubscriberPreferencesResponse$inboundSchema,
       { hdrs: true, key: "Result" },
     ),
     M.jsonErr(414, errors.ErrorDto$inboundSchema),

package/src/funcs/subscribersPreferencesUpdateLegacy.ts

@@ -0,0 +1,202 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { encodeJSON, 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";
+
+/**
+ * Update subscriber preference
+ */
+export async function subscribersPreferencesUpdateLegacy(
+  client: NovuCore,
+  request: operations.SubscribersV1ControllerUpdateSubscriberPreferenceRequest,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    operations.SubscribersV1ControllerUpdateSubscriberPreferenceResponse,
+    | errors.ErrorDto
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | errors.ErrorDto
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations
+        .SubscribersV1ControllerUpdateSubscriberPreferenceRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = encodeJSON(
+    "body",
+    payload.UpdateSubscriberPreferenceRequestDto,
+    { explode: true },
+  );
+
+  const pathParams = {
+    subscriberId: encodeSimple("subscriberId", payload.subscriberId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    parameter: encodeSimple("parameter", payload.workflowId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc(
+    "/v1/subscribers/{subscriberId}/preferences/{parameter}",
+  )(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+    "idempotency-key": encodeSimple(
+      "idempotency-key",
+      payload["idempotency-key"],
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const secConfig = await extractSecurity(client._options.secretKey);
+  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    operationID: "SubscribersV1Controller_updateSubscriberPreference",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.secretKey,
+    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: "PATCH",
+    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.SubscribersV1ControllerUpdateSubscriberPreferenceResponse,
+    | errors.ErrorDto
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | errors.ErrorDto
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(
+      200,
+      operations
+        .SubscribersV1ControllerUpdateSubscriberPreferenceResponse$inboundSchema,
+      { hdrs: true, 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/{subscribersUpdate.ts → subscribersUpdateLegacy.ts}

@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Used to update the subscriber entity with new information
  */
-export async function subscribersUpdate(
+export async function subscribersUpdateLegacy(
   client: NovuCore,
   updateSubscriberRequestDto: components.UpdateSubscriberRequestDto,
   subscriberId: string,

package/src/lib/config.ts

@@ -55,7 +55,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "0.1.2",
-  genVersion: "2.499.0",
-  userAgent: "speakeasy-sdk/typescript 0.1.2 2.499.0 1.0 @novu/api",
+  sdkVersion: "0.1.6",
+  genVersion: "2.503.2",
+  userAgent: "speakeasy-sdk/typescript 0.1.6 2.503.2 1.0 @novu/api",
 } as const;

package/src/models/components/getsubscriberpreferencesdto.ts

@@ -0,0 +1,90 @@
+/*
+ * 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";
+import {
+  GlobalPreferenceDto,
+  GlobalPreferenceDto$inboundSchema,
+  GlobalPreferenceDto$Outbound,
+  GlobalPreferenceDto$outboundSchema,
+} from "./globalpreferencedto.js";
+import {
+  WorkflowPreferenceDto,
+  WorkflowPreferenceDto$inboundSchema,
+  WorkflowPreferenceDto$Outbound,
+  WorkflowPreferenceDto$outboundSchema,
+} from "./workflowpreferencedto.js";
+
+export type GetSubscriberPreferencesDto = {
+  /**
+   * Global preference settings
+   */
+  global: GlobalPreferenceDto;
+  /**
+   * Workflow-specific preference settings
+   */
+  workflows: Array<WorkflowPreferenceDto>;
+};
+
+/** @internal */
+export const GetSubscriberPreferencesDto$inboundSchema: z.ZodType<
+  GetSubscriberPreferencesDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  global: GlobalPreferenceDto$inboundSchema,
+  workflows: z.array(WorkflowPreferenceDto$inboundSchema),
+});
+
+/** @internal */
+export type GetSubscriberPreferencesDto$Outbound = {
+  global: GlobalPreferenceDto$Outbound;
+  workflows: Array<WorkflowPreferenceDto$Outbound>;
+};
+
+/** @internal */
+export const GetSubscriberPreferencesDto$outboundSchema: z.ZodType<
+  GetSubscriberPreferencesDto$Outbound,
+  z.ZodTypeDef,
+  GetSubscriberPreferencesDto
+> = z.object({
+  global: GlobalPreferenceDto$outboundSchema,
+  workflows: z.array(WorkflowPreferenceDto$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSubscriberPreferencesDto$ {
+  /** @deprecated use `GetSubscriberPreferencesDto$inboundSchema` instead. */
+  export const inboundSchema = GetSubscriberPreferencesDto$inboundSchema;
+  /** @deprecated use `GetSubscriberPreferencesDto$outboundSchema` instead. */
+  export const outboundSchema = GetSubscriberPreferencesDto$outboundSchema;
+  /** @deprecated use `GetSubscriberPreferencesDto$Outbound` instead. */
+  export type Outbound = GetSubscriberPreferencesDto$Outbound;
+}
+
+export function getSubscriberPreferencesDtoToJSON(
+  getSubscriberPreferencesDto: GetSubscriberPreferencesDto,
+): string {
+  return JSON.stringify(
+    GetSubscriberPreferencesDto$outboundSchema.parse(
+      getSubscriberPreferencesDto,
+    ),
+  );
+}
+
+export function getSubscriberPreferencesDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubscriberPreferencesDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSubscriberPreferencesDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubscriberPreferencesDto' from JSON`,
+  );
+}