@novu/api 3.14.2 → 3.14.3

package/src/models/operations/subscriberscontrollerarchivenotification.ts

@@ -0,0 +1,102 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 SubscribersControllerArchiveNotificationRequest = {
+  /**
+   * The identifier of the subscriber
+   */
+  subscriberId: string;
+  /**
+   * The identifier of the notification
+   */
+  notificationId: string;
+  /**
+   * Context keys for filtering
+   */
+  contextKeys?: Array<string> | undefined;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type SubscribersControllerArchiveNotificationResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.InboxNotificationDto;
+};
+
+/** @internal */
+export type SubscribersControllerArchiveNotificationRequest$Outbound = {
+  subscriberId: string;
+  notificationId: string;
+  contextKeys?: Array<string> | undefined;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const SubscribersControllerArchiveNotificationRequest$outboundSchema:
+  z.ZodType<
+    SubscribersControllerArchiveNotificationRequest$Outbound,
+    z.ZodTypeDef,
+    SubscribersControllerArchiveNotificationRequest
+  > = z.object({
+    subscriberId: z.string(),
+    notificationId: z.string(),
+    contextKeys: z.array(z.string()).optional(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
+  });
+
+export function subscribersControllerArchiveNotificationRequestToJSON(
+  subscribersControllerArchiveNotificationRequest:
+    SubscribersControllerArchiveNotificationRequest,
+): string {
+  return JSON.stringify(
+    SubscribersControllerArchiveNotificationRequest$outboundSchema.parse(
+      subscribersControllerArchiveNotificationRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const SubscribersControllerArchiveNotificationResponse$inboundSchema:
+  z.ZodType<
+    SubscribersControllerArchiveNotificationResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.InboxNotificationDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function subscribersControllerArchiveNotificationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SubscribersControllerArchiveNotificationResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscribersControllerArchiveNotificationResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SubscribersControllerArchiveNotificationResponse' from JSON`,
+  );
+}

package/src/models/operations/subscriberscontrollerbulkupdatesubscriberpreferences.ts

@@ -10,6 +10,9 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SubscribersControllerBulkUpdateSubscriberPreferencesRequest = {
+  /**
+   * The identifier of the subscriber
+   */
   subscriberId: string;
   /**
    * A header for idempotency purposes

package/src/models/operations/subscriberscontrollercompletenotificationaction.ts

@@ -0,0 +1,124 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The type of action (primary or secondary)
+ */
+export const ActionType = {
+  Primary: "primary",
+  Secondary: "secondary",
+} as const;
+/**
+ * The type of action (primary or secondary)
+ */
+export type ActionType = ClosedEnum<typeof ActionType>;
+
+export type SubscribersControllerCompleteNotificationActionRequest = {
+  /**
+   * The identifier of the subscriber
+   */
+  subscriberId: string;
+  /**
+   * The identifier of the notification
+   */
+  notificationId: string;
+  /**
+   * The type of action (primary or secondary)
+   */
+  actionType: ActionType;
+  /**
+   * Context keys for filtering
+   */
+  contextKeys?: Array<string> | undefined;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type SubscribersControllerCompleteNotificationActionResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.InboxNotificationDto;
+};
+
+/** @internal */
+export const ActionType$outboundSchema: z.ZodNativeEnum<typeof ActionType> = z
+  .nativeEnum(ActionType);
+
+/** @internal */
+export type SubscribersControllerCompleteNotificationActionRequest$Outbound = {
+  subscriberId: string;
+  notificationId: string;
+  actionType: string;
+  contextKeys?: Array<string> | undefined;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const SubscribersControllerCompleteNotificationActionRequest$outboundSchema:
+  z.ZodType<
+    SubscribersControllerCompleteNotificationActionRequest$Outbound,
+    z.ZodTypeDef,
+    SubscribersControllerCompleteNotificationActionRequest
+  > = z.object({
+    subscriberId: z.string(),
+    notificationId: z.string(),
+    actionType: ActionType$outboundSchema,
+    contextKeys: z.array(z.string()).optional(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
+  });
+
+export function subscribersControllerCompleteNotificationActionRequestToJSON(
+  subscribersControllerCompleteNotificationActionRequest:
+    SubscribersControllerCompleteNotificationActionRequest,
+): string {
+  return JSON.stringify(
+    SubscribersControllerCompleteNotificationActionRequest$outboundSchema.parse(
+      subscribersControllerCompleteNotificationActionRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const SubscribersControllerCompleteNotificationActionResponse$inboundSchema:
+  z.ZodType<
+    SubscribersControllerCompleteNotificationActionResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.InboxNotificationDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function subscribersControllerCompleteNotificationActionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SubscribersControllerCompleteNotificationActionResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscribersControllerCompleteNotificationActionResponse$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'SubscribersControllerCompleteNotificationActionResponse' from JSON`,
+  );
+}

package/src/models/operations/subscriberscontrollerdeleteallnotifications.ts

@@ -0,0 +1,95 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 SubscribersControllerDeleteAllNotificationsRequest = {
+  /**
+   * The identifier of the subscriber
+   */
+  subscriberId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  updateAllSubscriberNotificationsDto:
+    components.UpdateAllSubscriberNotificationsDto;
+};
+
+export type SubscribersControllerDeleteAllNotificationsResponse = {
+  headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export type SubscribersControllerDeleteAllNotificationsRequest$Outbound = {
+  subscriberId: string;
+  "idempotency-key"?: string | undefined;
+  UpdateAllSubscriberNotificationsDto:
+    components.UpdateAllSubscriberNotificationsDto$Outbound;
+};
+
+/** @internal */
+export const SubscribersControllerDeleteAllNotificationsRequest$outboundSchema:
+  z.ZodType<
+    SubscribersControllerDeleteAllNotificationsRequest$Outbound,
+    z.ZodTypeDef,
+    SubscribersControllerDeleteAllNotificationsRequest
+  > = z.object({
+    subscriberId: z.string(),
+    idempotencyKey: z.string().optional(),
+    updateAllSubscriberNotificationsDto:
+      components.UpdateAllSubscriberNotificationsDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+      updateAllSubscriberNotificationsDto:
+        "UpdateAllSubscriberNotificationsDto",
+    });
+  });
+
+export function subscribersControllerDeleteAllNotificationsRequestToJSON(
+  subscribersControllerDeleteAllNotificationsRequest:
+    SubscribersControllerDeleteAllNotificationsRequest,
+): string {
+  return JSON.stringify(
+    SubscribersControllerDeleteAllNotificationsRequest$outboundSchema.parse(
+      subscribersControllerDeleteAllNotificationsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const SubscribersControllerDeleteAllNotificationsResponse$inboundSchema:
+  z.ZodType<
+    SubscribersControllerDeleteAllNotificationsResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+    });
+  });
+
+export function subscribersControllerDeleteAllNotificationsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SubscribersControllerDeleteAllNotificationsResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscribersControllerDeleteAllNotificationsResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SubscribersControllerDeleteAllNotificationsResponse' from JSON`,
+  );
+}

package/src/models/operations/subscriberscontrollerdeletenotification.ts

@@ -0,0 +1,98 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SubscribersControllerDeleteNotificationRequest = {
+  /**
+   * The identifier of the subscriber
+   */
+  subscriberId: string;
+  /**
+   * The identifier of the notification
+   */
+  notificationId: string;
+  /**
+   * Context keys for filtering
+   */
+  contextKeys?: Array<string> | undefined;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type SubscribersControllerDeleteNotificationResponse = {
+  headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export type SubscribersControllerDeleteNotificationRequest$Outbound = {
+  subscriberId: string;
+  notificationId: string;
+  contextKeys?: Array<string> | undefined;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const SubscribersControllerDeleteNotificationRequest$outboundSchema:
+  z.ZodType<
+    SubscribersControllerDeleteNotificationRequest$Outbound,
+    z.ZodTypeDef,
+    SubscribersControllerDeleteNotificationRequest
+  > = z.object({
+    subscriberId: z.string(),
+    notificationId: z.string(),
+    contextKeys: z.array(z.string()).optional(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
+  });
+
+export function subscribersControllerDeleteNotificationRequestToJSON(
+  subscribersControllerDeleteNotificationRequest:
+    SubscribersControllerDeleteNotificationRequest,
+): string {
+  return JSON.stringify(
+    SubscribersControllerDeleteNotificationRequest$outboundSchema.parse(
+      subscribersControllerDeleteNotificationRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const SubscribersControllerDeleteNotificationResponse$inboundSchema:
+  z.ZodType<
+    SubscribersControllerDeleteNotificationResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+    });
+  });
+
+export function subscribersControllerDeleteNotificationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SubscribersControllerDeleteNotificationResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscribersControllerDeleteNotificationResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SubscribersControllerDeleteNotificationResponse' from JSON`,
+  );
+}

package/src/models/operations/subscriberscontrollergetsubscriber.ts

@@ -10,6 +10,9 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SubscribersControllerGetSubscriberRequest = {
+  /**
+   * The identifier of the subscriber
+   */
   subscriberId: string;
   /**
    * A header for idempotency purposes

package/src/models/operations/subscriberscontrollergetsubscribernotifications.ts

@@ -0,0 +1,171 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const Severity = {
+  High: "high",
+  Medium: "medium",
+  Low: "low",
+  None: "none",
+} as const;
+export type Severity = ClosedEnum<typeof Severity>;
+
+export type SubscribersControllerGetSubscriberNotificationsRequest = {
+  /**
+   * The identifier of the subscriber
+   */
+  subscriberId: string;
+  limit?: number | undefined;
+  after?: string | undefined;
+  offset?: number | undefined;
+  /**
+   * Filter by workflow tags
+   */
+  tags?: Array<string> | undefined;
+  /**
+   * Filter by read/unread state
+   */
+  read?: boolean | undefined;
+  /**
+   * Filter by archived state
+   */
+  archived?: boolean | undefined;
+  /**
+   * Filter by snoozed state
+   */
+  snoozed?: boolean | undefined;
+  /**
+   * Filter by seen state
+   */
+  seen?: boolean | undefined;
+  /**
+   * Filter by data attributes (JSON string)
+   */
+  data?: string | undefined;
+  /**
+   * Filter by severity levels
+   */
+  severity?: Array<Severity> | undefined;
+  /**
+   * Filter notifications created on or after this timestamp (Unix timestamp in milliseconds)
+   */
+  createdGte?: number | undefined;
+  /**
+   * Filter notifications created on or before this timestamp (Unix timestamp in milliseconds)
+   */
+  createdLte?: number | undefined;
+  /**
+   * Context keys for filtering notifications in multi-context scenarios
+   */
+  contextKeys?: Array<string> | undefined;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type SubscribersControllerGetSubscriberNotificationsResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.GetSubscriberNotificationsResponseDto;
+};
+
+/** @internal */
+export const Severity$outboundSchema: z.ZodNativeEnum<typeof Severity> = z
+  .nativeEnum(Severity);
+
+/** @internal */
+export type SubscribersControllerGetSubscriberNotificationsRequest$Outbound = {
+  subscriberId: string;
+  limit: number;
+  after?: string | undefined;
+  offset?: number | undefined;
+  tags?: Array<string> | undefined;
+  read?: boolean | undefined;
+  archived?: boolean | undefined;
+  snoozed?: boolean | undefined;
+  seen?: boolean | undefined;
+  data?: string | undefined;
+  severity?: Array<string> | undefined;
+  createdGte?: number | undefined;
+  createdLte?: number | undefined;
+  contextKeys?: Array<string> | undefined;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const SubscribersControllerGetSubscriberNotificationsRequest$outboundSchema:
+  z.ZodType<
+    SubscribersControllerGetSubscriberNotificationsRequest$Outbound,
+    z.ZodTypeDef,
+    SubscribersControllerGetSubscriberNotificationsRequest
+  > = z.object({
+    subscriberId: z.string(),
+    limit: z.number().default(10),
+    after: z.string().optional(),
+    offset: z.number().optional(),
+    tags: z.array(z.string()).optional(),
+    read: z.boolean().optional(),
+    archived: z.boolean().optional(),
+    snoozed: z.boolean().optional(),
+    seen: z.boolean().optional(),
+    data: z.string().optional(),
+    severity: z.array(Severity$outboundSchema).optional(),
+    createdGte: z.number().optional(),
+    createdLte: z.number().optional(),
+    contextKeys: z.array(z.string()).optional(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
+  });
+
+export function subscribersControllerGetSubscriberNotificationsRequestToJSON(
+  subscribersControllerGetSubscriberNotificationsRequest:
+    SubscribersControllerGetSubscriberNotificationsRequest,
+): string {
+  return JSON.stringify(
+    SubscribersControllerGetSubscriberNotificationsRequest$outboundSchema.parse(
+      subscribersControllerGetSubscriberNotificationsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const SubscribersControllerGetSubscriberNotificationsResponse$inboundSchema:
+  z.ZodType<
+    SubscribersControllerGetSubscriberNotificationsResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.GetSubscriberNotificationsResponseDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function subscribersControllerGetSubscriberNotificationsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SubscribersControllerGetSubscriberNotificationsResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscribersControllerGetSubscriberNotificationsResponse$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'SubscribersControllerGetSubscriberNotificationsResponse' from JSON`,
+  );
+}