@novu/api 0.1.2 → 0.1.5

package/src/models/operations/subscriberscontrollergetsubscriberpreferences.ts

@@ -0,0 +1,183 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 SubscribersControllerGetSubscriberPreferencesRequest = {
+  subscriberId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type SubscribersControllerGetSubscriberPreferencesResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.GetSubscriberPreferencesDto;
+};
+
+/** @internal */
+export const SubscribersControllerGetSubscriberPreferencesRequest$inboundSchema:
+  z.ZodType<
+    SubscribersControllerGetSubscriberPreferencesRequest,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    subscriberId: z.string(),
+    "idempotency-key": z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "idempotency-key": "idempotencyKey",
+    });
+  });
+
+/** @internal */
+export type SubscribersControllerGetSubscriberPreferencesRequest$Outbound = {
+  subscriberId: string;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const SubscribersControllerGetSubscriberPreferencesRequest$outboundSchema:
+  z.ZodType<
+    SubscribersControllerGetSubscriberPreferencesRequest$Outbound,
+    z.ZodTypeDef,
+    SubscribersControllerGetSubscriberPreferencesRequest
+  > = z.object({
+    subscriberId: z.string(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SubscribersControllerGetSubscriberPreferencesRequest$ {
+  /** @deprecated use `SubscribersControllerGetSubscriberPreferencesRequest$inboundSchema` instead. */
+  export const inboundSchema =
+    SubscribersControllerGetSubscriberPreferencesRequest$inboundSchema;
+  /** @deprecated use `SubscribersControllerGetSubscriberPreferencesRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    SubscribersControllerGetSubscriberPreferencesRequest$outboundSchema;
+  /** @deprecated use `SubscribersControllerGetSubscriberPreferencesRequest$Outbound` instead. */
+  export type Outbound =
+    SubscribersControllerGetSubscriberPreferencesRequest$Outbound;
+}
+
+export function subscribersControllerGetSubscriberPreferencesRequestToJSON(
+  subscribersControllerGetSubscriberPreferencesRequest:
+    SubscribersControllerGetSubscriberPreferencesRequest,
+): string {
+  return JSON.stringify(
+    SubscribersControllerGetSubscriberPreferencesRequest$outboundSchema.parse(
+      subscribersControllerGetSubscriberPreferencesRequest,
+    ),
+  );
+}
+
+export function subscribersControllerGetSubscriberPreferencesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SubscribersControllerGetSubscriberPreferencesRequest,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscribersControllerGetSubscriberPreferencesRequest$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SubscribersControllerGetSubscriberPreferencesRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const SubscribersControllerGetSubscriberPreferencesResponse$inboundSchema:
+  z.ZodType<
+    SubscribersControllerGetSubscriberPreferencesResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())),
+    Result: components.GetSubscriberPreferencesDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+/** @internal */
+export type SubscribersControllerGetSubscriberPreferencesResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.GetSubscriberPreferencesDto$Outbound;
+};
+
+/** @internal */
+export const SubscribersControllerGetSubscriberPreferencesResponse$outboundSchema:
+  z.ZodType<
+    SubscribersControllerGetSubscriberPreferencesResponse$Outbound,
+    z.ZodTypeDef,
+    SubscribersControllerGetSubscriberPreferencesResponse
+  > = z.object({
+    headers: z.record(z.array(z.string())),
+    result: components.GetSubscriberPreferencesDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      headers: "Headers",
+      result: "Result",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SubscribersControllerGetSubscriberPreferencesResponse$ {
+  /** @deprecated use `SubscribersControllerGetSubscriberPreferencesResponse$inboundSchema` instead. */
+  export const inboundSchema =
+    SubscribersControllerGetSubscriberPreferencesResponse$inboundSchema;
+  /** @deprecated use `SubscribersControllerGetSubscriberPreferencesResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    SubscribersControllerGetSubscriberPreferencesResponse$outboundSchema;
+  /** @deprecated use `SubscribersControllerGetSubscriberPreferencesResponse$Outbound` instead. */
+  export type Outbound =
+    SubscribersControllerGetSubscriberPreferencesResponse$Outbound;
+}
+
+export function subscribersControllerGetSubscriberPreferencesResponseToJSON(
+  subscribersControllerGetSubscriberPreferencesResponse:
+    SubscribersControllerGetSubscriberPreferencesResponse,
+): string {
+  return JSON.stringify(
+    SubscribersControllerGetSubscriberPreferencesResponse$outboundSchema.parse(
+      subscribersControllerGetSubscriberPreferencesResponse,
+    ),
+  );
+}
+
+export function subscribersControllerGetSubscriberPreferencesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SubscribersControllerGetSubscriberPreferencesResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscribersControllerGetSubscriberPreferencesResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SubscribersControllerGetSubscriberPreferencesResponse' from JSON`,
+  );
+}

package/src/models/operations/subscriberscontrollerupdatesubscriberpreferences.ts

@@ -0,0 +1,189 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 SubscribersControllerUpdateSubscriberPreferencesRequest = {
+  subscriberId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  patchSubscriberPreferencesDto: components.PatchSubscriberPreferencesDto;
+};
+
+export type SubscribersControllerUpdateSubscriberPreferencesResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.GetSubscriberPreferencesDto;
+};
+
+/** @internal */
+export const SubscribersControllerUpdateSubscriberPreferencesRequest$inboundSchema:
+  z.ZodType<
+    SubscribersControllerUpdateSubscriberPreferencesRequest,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    subscriberId: z.string(),
+    "idempotency-key": z.string().optional(),
+    PatchSubscriberPreferencesDto:
+      components.PatchSubscriberPreferencesDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "idempotency-key": "idempotencyKey",
+      "PatchSubscriberPreferencesDto": "patchSubscriberPreferencesDto",
+    });
+  });
+
+/** @internal */
+export type SubscribersControllerUpdateSubscriberPreferencesRequest$Outbound = {
+  subscriberId: string;
+  "idempotency-key"?: string | undefined;
+  PatchSubscriberPreferencesDto:
+    components.PatchSubscriberPreferencesDto$Outbound;
+};
+
+/** @internal */
+export const SubscribersControllerUpdateSubscriberPreferencesRequest$outboundSchema:
+  z.ZodType<
+    SubscribersControllerUpdateSubscriberPreferencesRequest$Outbound,
+    z.ZodTypeDef,
+    SubscribersControllerUpdateSubscriberPreferencesRequest
+  > = z.object({
+    subscriberId: z.string(),
+    idempotencyKey: z.string().optional(),
+    patchSubscriberPreferencesDto:
+      components.PatchSubscriberPreferencesDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+      patchSubscriberPreferencesDto: "PatchSubscriberPreferencesDto",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SubscribersControllerUpdateSubscriberPreferencesRequest$ {
+  /** @deprecated use `SubscribersControllerUpdateSubscriberPreferencesRequest$inboundSchema` instead. */
+  export const inboundSchema =
+    SubscribersControllerUpdateSubscriberPreferencesRequest$inboundSchema;
+  /** @deprecated use `SubscribersControllerUpdateSubscriberPreferencesRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    SubscribersControllerUpdateSubscriberPreferencesRequest$outboundSchema;
+  /** @deprecated use `SubscribersControllerUpdateSubscriberPreferencesRequest$Outbound` instead. */
+  export type Outbound =
+    SubscribersControllerUpdateSubscriberPreferencesRequest$Outbound;
+}
+
+export function subscribersControllerUpdateSubscriberPreferencesRequestToJSON(
+  subscribersControllerUpdateSubscriberPreferencesRequest:
+    SubscribersControllerUpdateSubscriberPreferencesRequest,
+): string {
+  return JSON.stringify(
+    SubscribersControllerUpdateSubscriberPreferencesRequest$outboundSchema
+      .parse(subscribersControllerUpdateSubscriberPreferencesRequest),
+  );
+}
+
+export function subscribersControllerUpdateSubscriberPreferencesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SubscribersControllerUpdateSubscriberPreferencesRequest,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscribersControllerUpdateSubscriberPreferencesRequest$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'SubscribersControllerUpdateSubscriberPreferencesRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const SubscribersControllerUpdateSubscriberPreferencesResponse$inboundSchema:
+  z.ZodType<
+    SubscribersControllerUpdateSubscriberPreferencesResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())),
+    Result: components.GetSubscriberPreferencesDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+/** @internal */
+export type SubscribersControllerUpdateSubscriberPreferencesResponse$Outbound =
+  {
+    Headers: { [k: string]: Array<string> };
+    Result: components.GetSubscriberPreferencesDto$Outbound;
+  };
+
+/** @internal */
+export const SubscribersControllerUpdateSubscriberPreferencesResponse$outboundSchema:
+  z.ZodType<
+    SubscribersControllerUpdateSubscriberPreferencesResponse$Outbound,
+    z.ZodTypeDef,
+    SubscribersControllerUpdateSubscriberPreferencesResponse
+  > = z.object({
+    headers: z.record(z.array(z.string())),
+    result: components.GetSubscriberPreferencesDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      headers: "Headers",
+      result: "Result",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SubscribersControllerUpdateSubscriberPreferencesResponse$ {
+  /** @deprecated use `SubscribersControllerUpdateSubscriberPreferencesResponse$inboundSchema` instead. */
+  export const inboundSchema =
+    SubscribersControllerUpdateSubscriberPreferencesResponse$inboundSchema;
+  /** @deprecated use `SubscribersControllerUpdateSubscriberPreferencesResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    SubscribersControllerUpdateSubscriberPreferencesResponse$outboundSchema;
+  /** @deprecated use `SubscribersControllerUpdateSubscriberPreferencesResponse$Outbound` instead. */
+  export type Outbound =
+    SubscribersControllerUpdateSubscriberPreferencesResponse$Outbound;
+}
+
+export function subscribersControllerUpdateSubscriberPreferencesResponseToJSON(
+  subscribersControllerUpdateSubscriberPreferencesResponse:
+    SubscribersControllerUpdateSubscriberPreferencesResponse,
+): string {
+  return JSON.stringify(
+    SubscribersControllerUpdateSubscriberPreferencesResponse$outboundSchema
+      .parse(subscribersControllerUpdateSubscriberPreferencesResponse),
+  );
+}
+
+export function subscribersControllerUpdateSubscriberPreferencesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SubscribersControllerUpdateSubscriberPreferencesResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscribersControllerUpdateSubscriberPreferencesResponse$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'SubscribersControllerUpdateSubscriberPreferencesResponse' from JSON`,
+  );
+}

package/src/sdk/preferences.ts

@@ -3,9 +3,11 @@
  */
 
 import { subscribersPreferencesList } from "../funcs/subscribersPreferencesList.js";
+import { subscribersPreferencesRetrieve } from "../funcs/subscribersPreferencesRetrieve.js";
 import { subscribersPreferencesRetrieveByLevel } from "../funcs/subscribersPreferencesRetrieveByLevel.js";
 import { subscribersPreferencesUpdate } from "../funcs/subscribersPreferencesUpdate.js";
 import { subscribersPreferencesUpdateGlobal } from "../funcs/subscribersPreferencesUpdateGlobal.js";
+import { subscribersPreferencesUpdateLegacy } from "../funcs/subscribersPreferencesUpdateLegacy.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
@@ -73,17 +75,59 @@ export class Preferences extends ClientSDK {
   /**
    * Update subscriber preference
    */
-  async update(
+  async updateLegacy(
     request:
       operations.SubscribersV1ControllerUpdateSubscriberPreferenceRequest,
     options?: RequestOptions,
   ): Promise<
     operations.SubscribersV1ControllerUpdateSubscriberPreferenceResponse
   > {
-    return unwrapAsync(subscribersPreferencesUpdate(
+    return unwrapAsync(subscribersPreferencesUpdateLegacy(
       this,
       request,
       options,
     ));
   }
+
+  /**
+   * Get subscriber preferences
+   *
+   * @remarks
+   * Get subscriber global and workflow specific preferences
+   */
+  async retrieve(
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerGetSubscriberPreferencesResponse> {
+    return unwrapAsync(subscribersPreferencesRetrieve(
+      this,
+      subscriberId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Update subscriber global or workflow specific preferences
+   *
+   * @remarks
+   * Update subscriber global or workflow specific preferences
+   */
+  async update(
+    patchSubscriberPreferencesDto: components.PatchSubscriberPreferencesDto,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerUpdateSubscriberPreferencesResponse
+  > {
+    return unwrapAsync(subscribersPreferencesUpdate(
+      this,
+      patchSubscriberPreferencesDto,
+      subscriberId,
+      idempotencyKey,
+      options,
+    ));
+  }
 }