@novu/api 3.14.1 → 3.14.2-rc.1

package/src/models/components/inboxnotificationdto.ts

@@ -0,0 +1,170 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ChannelTypeEnum,
+  ChannelTypeEnum$inboundSchema,
+} from "./channeltypeenum.js";
+import {
+  InboxActionDto,
+  InboxActionDto$inboundSchema,
+} from "./inboxactiondto.js";
+import {
+  InboxSubscriberResponseDto,
+  InboxSubscriberResponseDto$inboundSchema,
+} from "./inboxsubscriberresponsedto.js";
+import {
+  NotificationWorkflowDto,
+  NotificationWorkflowDto$inboundSchema,
+} from "./notificationworkflowdto.js";
+import { RedirectDto, RedirectDto$inboundSchema } from "./redirectdto.js";
+import {
+  SeverityLevelEnum,
+  SeverityLevelEnum$inboundSchema,
+} from "./severitylevelenum.js";
+
+export type InboxNotificationDto = {
+  /**
+   * Unique identifier of the notification
+   */
+  id: string;
+  /**
+   * Transaction identifier of the notification
+   */
+  transactionId: string;
+  /**
+   * Subject of the notification
+   */
+  subject?: string | undefined;
+  /**
+   * Body content of the notification
+   */
+  body: string;
+  /**
+   * Subscriber this notification was sent to
+   */
+  to: InboxSubscriberResponseDto;
+  /**
+   * Whether the notification has been read
+   */
+  isRead: boolean;
+  /**
+   * Whether the notification has been seen
+   */
+  isSeen: boolean;
+  /**
+   * Whether the notification has been archived
+   */
+  isArchived: boolean;
+  /**
+   * Whether the notification is snoozed
+   */
+  isSnoozed: boolean;
+  /**
+   * ISO timestamp when the notification will be unsnoozed
+   */
+  snoozedUntil?: string | null | undefined;
+  /**
+   * Timestamps when the notification was delivered
+   */
+  deliveredAt?: Array<string> | undefined;
+  /**
+   * ISO timestamp when the notification was created
+   */
+  createdAt: string;
+  /**
+   * ISO timestamp when the notification was read
+   */
+  readAt?: string | null | undefined;
+  /**
+   * ISO timestamp when the notification was first seen
+   */
+  firstSeenAt?: string | null | undefined;
+  /**
+   * ISO timestamp when the notification was archived
+   */
+  archivedAt?: string | null | undefined;
+  /**
+   * Avatar URL for the notification
+   */
+  avatar?: string | undefined;
+  /**
+   * Primary action button for the notification
+   */
+  primaryAction?: InboxActionDto | undefined;
+  /**
+   * Secondary action button for the notification
+   */
+  secondaryAction?: InboxActionDto | undefined;
+  /**
+   * Channel type through which the message is sent
+   */
+  channelType: ChannelTypeEnum;
+  /**
+   * Tags associated with the notification
+   */
+  tags?: Array<string> | undefined;
+  /**
+   * Custom data payload of the notification
+   */
+  data?: { [k: string]: any } | undefined;
+  /**
+   * Redirect configuration for the notification
+   */
+  redirect?: RedirectDto | undefined;
+  /**
+   * Workflow associated with the notification
+   */
+  workflow?: NotificationWorkflowDto | undefined;
+  /**
+   * Severity of the workflow
+   */
+  severity: SeverityLevelEnum;
+};
+
+/** @internal */
+export const InboxNotificationDto$inboundSchema: z.ZodType<
+  InboxNotificationDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  transactionId: z.string(),
+  subject: z.string().optional(),
+  body: z.string(),
+  to: InboxSubscriberResponseDto$inboundSchema,
+  isRead: z.boolean(),
+  isSeen: z.boolean(),
+  isArchived: z.boolean(),
+  isSnoozed: z.boolean(),
+  snoozedUntil: z.nullable(z.string()).optional(),
+  deliveredAt: z.array(z.string()).optional(),
+  createdAt: z.string(),
+  readAt: z.nullable(z.string()).optional(),
+  firstSeenAt: z.nullable(z.string()).optional(),
+  archivedAt: z.nullable(z.string()).optional(),
+  avatar: z.string().optional(),
+  primaryAction: InboxActionDto$inboundSchema.optional(),
+  secondaryAction: InboxActionDto$inboundSchema.optional(),
+  channelType: ChannelTypeEnum$inboundSchema,
+  tags: z.array(z.string()).optional(),
+  data: z.record(z.any()).optional(),
+  redirect: RedirectDto$inboundSchema.optional(),
+  workflow: NotificationWorkflowDto$inboundSchema.optional(),
+  severity: SeverityLevelEnum$inboundSchema,
+});
+
+export function inboxNotificationDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<InboxNotificationDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InboxNotificationDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InboxNotificationDto' from JSON`,
+  );
+}

package/src/models/components/inboxsubscriberresponsedto.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type InboxSubscriberResponseDto = {
+  /**
+   * Unique identifier of the subscriber
+   */
+  id: string;
+  /**
+   * First name of the subscriber
+   */
+  firstName?: string | undefined;
+  /**
+   * Last name of the subscriber
+   */
+  lastName?: string | undefined;
+  /**
+   * Avatar URL of the subscriber
+   */
+  avatar?: string | undefined;
+  /**
+   * External subscriber identifier
+   */
+  subscriberId: string;
+};
+
+/** @internal */
+export const InboxSubscriberResponseDto$inboundSchema: z.ZodType<
+  InboxSubscriberResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  firstName: z.string().optional(),
+  lastName: z.string().optional(),
+  avatar: z.string().optional(),
+  subscriberId: z.string(),
+});
+
+export function inboxSubscriberResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<InboxSubscriberResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InboxSubscriberResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InboxSubscriberResponseDto' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -33,6 +33,7 @@ export * from "./channeltypeenum.js";
 export * from "./chatcontroldto.js";
 export * from "./chatcontrolsmetadataresponsedto.js";
 export * from "./chatorpushproviderenum.js";
+export * from "./chatrenderoutput.js";
 export * from "./chatstepresponsedto.js";
 export * from "./chatstepupsertdto.js";
 export * from "./configurationsdto.js";
@@ -43,6 +44,7 @@ export * from "./createchannelconnectionrequestdto.js";
 export * from "./createcontextrequestdto.js";
 export * from "./createdsubscriberdto.js";
 export * from "./createenvironmentrequestdto.js";
+export * from "./createenvironmentvariablerequestdto.js";
 export * from "./createintegrationrequestdto.js";
 export * from "./createlayoutdto.js";
 export * from "./createmsteamschannelendpointdto.js";
@@ -82,6 +84,7 @@ export * from "./digestcontroldto.js";
 export * from "./digestcontrolsmetadataresponsedto.js";
 export * from "./digestmetadatadto.js";
 export * from "./digestregularmetadata.js";
+export * from "./digestregularoutput.js";
 export * from "./digeststepresponsedto.js";
 export * from "./digeststepupsertdto.js";
 export * from "./digesttimedconfigdto.js";
@@ -98,10 +101,15 @@ export * from "./emailcontroldto.js";
 export * from "./emailcontrolsdto.js";
 export * from "./emailcontrolsmetadataresponsedto.js";
 export * from "./emaillayoutrenderoutput.js";
+export * from "./emailrenderoutput.js";
 export * from "./emailstepresponsedto.js";
 export * from "./emailstepupsertdto.js";
 export * from "./environmentdiffsummarydto.js";
 export * from "./environmentresponsedto.js";
+export * from "./environmentvariableresponsedto.js";
+export * from "./environmentvariablevaluedto.js";
+export * from "./environmentvariablevalueresponsedto.js";
+export * from "./environmentvariableworkflowinfodto.js";
 export * from "./eventbody.js";
 export * from "./executiondetailssourceenum.js";
 export * from "./executiondetailsstatusenum.js";
@@ -112,23 +120,38 @@ export * from "./fieldfilterpartdto.js";
 export * from "./generatechatoauthurlrequestdto.js";
 export * from "./generatechatoauthurlresponsedto.js";
 export * from "./generatelayoutpreviewresponsedto.js";
+export * from "./generatepreviewrequestdto.js";
+export * from "./generatepreviewresponsedto.js";
 export * from "./getchannelconnectionresponsedto.js";
 export * from "./getchannelendpointresponsedto.js";
 export * from "./getcontextresponsedto.js";
 export * from "./getenvironmenttagsdto.js";
+export * from "./getenvironmentvariableusageresponsedto.js";
 export * from "./getlayoutusageresponsedto.js";
 export * from "./getmasterjsonresponsedto.js";
 export * from "./getpreferencesresponsedto.js";
+export * from "./getsubscribernotificationscountresponsedto.js";
+export * from "./getsubscribernotificationsresponsedto.js";
 export * from "./getsubscriberpreferencesdto.js";
 export * from "./grouppreferencefilterdetailsdto.js";
 export * from "./grouppreferencefilterdto.js";
+export * from "./httpmethodenum.js";
+export * from "./httprequestcontroldto.js";
+export * from "./httprequestcontrolsmetadataresponsedto.js";
+export * from "./httprequestkeyvaluepairdto.js";
+export * from "./httprequeststepresponsedto.js";
+export * from "./httprequeststepupsertdto.js";
 export * from "./importmasterjsonrequestdto.js";
 export * from "./importmasterjsonresponsedto.js";
 export * from "./inappcontroldto.js";
 export * from "./inappcontrolsmetadataresponsedto.js";
+export * from "./inapprenderoutput.js";
 export * from "./inappstepresponsedto.js";
 export * from "./inappstepupsertdto.js";
 export * from "./inboundparsedomaindto.js";
+export * from "./inboxactiondto.js";
+export * from "./inboxnotificationdto.js";
+export * from "./inboxsubscriberresponsedto.js";
 export * from "./integrationissueenum.js";
 export * from "./integrationresponsedto.js";
 export * from "./layoutcontrolsdto.js";
@@ -149,6 +172,7 @@ export * from "./listworkflowresponse.js";
 export * from "./lookbackwindowdto.js";
 export * from "./markallmessageasrequestdto.js";
 export * from "./markmessageactionasseendto.js";
+export * from "./marksubscribernotificationsasseendto.js";
 export * from "./messageaction.js";
 export * from "./messageactionresult.js";
 export * from "./messageactionstatusenum.js";
@@ -172,6 +196,7 @@ export * from "./notificationstepdto.js";
 export * from "./notificationtrigger.js";
 export * from "./notificationtriggerdto.js";
 export * from "./notificationtriggervariable.js";
+export * from "./notificationworkflowdto.js";
 export * from "./ordinalenum.js";
 export * from "./ordinalvalueenum.js";
 export * from "./patchpreferencechannelsdto.js";
@@ -183,12 +208,15 @@ export * from "./phoneendpointdto.js";
 export * from "./preferencelevelenum.js";
 export * from "./preferenceoverridesourceenum.js";
 export * from "./preferencesrequestdto.js";
+export * from "./previewerrordto.js";
+export * from "./previewpayloaddto.js";
 export * from "./providersidenum.js";
 export * from "./publishenvironmentrequestdto.js";
 export * from "./publishenvironmentresponsedto.js";
 export * from "./publishsummarydto.js";
 export * from "./pushcontroldto.js";
 export * from "./pushcontrolsmetadataresponsedto.js";
+export * from "./pushrenderoutput.js";
 export * from "./pushstepresponsedto.js";
 export * from "./pushstepupsertdto.js";
 export * from "./redirectdto.js";
@@ -209,8 +237,10 @@ export * from "./slackchannelendpointdto.js";
 export * from "./slackuserendpointdto.js";
 export * from "./smscontroldto.js";
 export * from "./smscontrolsmetadataresponsedto.js";
+export * from "./smsrenderoutput.js";
 export * from "./smsstepresponsedto.js";
 export * from "./smsstepupsertdto.js";
+export * from "./snoozesubscribernotificationdto.js";
 export * from "./stepcontentissuedto.js";
 export * from "./stepfilterdto.js";
 export * from "./stepintegrationissue.js";
@@ -247,6 +277,7 @@ export * from "./throttlestepresponsedto.js";
 export * from "./throttlestepupsertdto.js";
 export * from "./timedconfig.js";
 export * from "./timerangedto.js";
+export * from "./timeunitenum.js";
 export * from "./topicdto.js";
 export * from "./topicpayloaddto.js";
 export * from "./topicresponsedto.js";
@@ -264,11 +295,13 @@ export * from "./uischema.js";
 export * from "./uischemagroupenum.js";
 export * from "./uischemaproperty.js";
 export * from "./unseencountresponse.js";
+export * from "./updateallsubscribernotificationsdto.js";
 export * from "./updatechannelconnectionrequestdto.js";
 export * from "./updatechannelendpointrequestdto.js";
 export * from "./updatecontextrequestdto.js";
 export * from "./updatedsubscriberdto.js";
 export * from "./updateenvironmentrequestdto.js";
+export * from "./updateenvironmentvariablerequestdto.js";
 export * from "./updateintegrationrequestdto.js";
 export * from "./updatelayoutdto.js";
 export * from "./updatesubscriberchannelrequestdto.js";

package/src/models/components/integrationresponsedto.ts

@@ -19,7 +19,7 @@ import {
 import { StepFilterDto, StepFilterDto$inboundSchema } from "./stepfilterdto.js";
 
 /**
- * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
+ * The channel type for the integration, which defines how it communicates (e.g., email, SMS).
  */
 export const IntegrationResponseDtoChannel = {
   InApp: "in_app",
@@ -29,7 +29,7 @@ export const IntegrationResponseDtoChannel = {
   Push: "push",
 } as const;
 /**
- * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
+ * The channel type for the integration, which defines how it communicates (e.g., email, SMS).
  */
 export type IntegrationResponseDtoChannel = ClosedEnum<
   typeof IntegrationResponseDtoChannel
@@ -61,7 +61,7 @@ export type IntegrationResponseDto = {
    */
   providerId: string;
   /**
-   * The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).
+   * The channel type for the integration, which defines how it communicates (e.g., email, SMS).
    */
   channel: IntegrationResponseDtoChannel;
   /**

package/src/models/components/marksubscribernotificationsasseendto.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type MarkSubscriberNotificationsAsSeenDto = {
+  /**
+   * Specific notification IDs to mark as seen
+   */
+  notificationIds?: Array<string> | undefined;
+  /**
+   * Filter notifications by workflow tags
+   */
+  tags?: Array<string> | undefined;
+  /**
+   * Filter notifications by data attributes (JSON string)
+   */
+  data?: string | undefined;
+  /**
+   * Context keys for filtering notifications
+   */
+  contextKeys?: Array<string> | undefined;
+};
+
+/** @internal */
+export type MarkSubscriberNotificationsAsSeenDto$Outbound = {
+  notificationIds?: Array<string> | undefined;
+  tags?: Array<string> | undefined;
+  data?: string | undefined;
+  contextKeys?: Array<string> | undefined;
+};
+
+/** @internal */
+export const MarkSubscriberNotificationsAsSeenDto$outboundSchema: z.ZodType<
+  MarkSubscriberNotificationsAsSeenDto$Outbound,
+  z.ZodTypeDef,
+  MarkSubscriberNotificationsAsSeenDto
+> = z.object({
+  notificationIds: z.array(z.string()).optional(),
+  tags: z.array(z.string()).optional(),
+  data: z.string().optional(),
+  contextKeys: z.array(z.string()).optional(),
+});
+
+export function markSubscriberNotificationsAsSeenDtoToJSON(
+  markSubscriberNotificationsAsSeenDto: MarkSubscriberNotificationsAsSeenDto,
+): string {
+  return JSON.stringify(
+    MarkSubscriberNotificationsAsSeenDto$outboundSchema.parse(
+      markSubscriberNotificationsAsSeenDto,
+    ),
+  );
+}

package/src/models/components/notificationworkflowdto.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  SeverityLevelEnum,
+  SeverityLevelEnum$inboundSchema,
+} from "./severitylevelenum.js";
+
+export type NotificationWorkflowDto = {
+  /**
+   * Unique identifier of the workflow
+   */
+  id: string;
+  /**
+   * Workflow identifier used for triggering
+   */
+  identifier: string;
+  /**
+   * Human-readable name of the workflow
+   */
+  name: string;
+  /**
+   * Whether this workflow is marked as critical
+   */
+  critical: boolean;
+  /**
+   * Tags associated with the workflow
+   */
+  tags?: Array<string> | undefined;
+  /**
+   * Custom data associated with the workflow
+   */
+  data?: { [k: string]: any } | undefined;
+  /**
+   * Severity of the workflow
+   */
+  severity: SeverityLevelEnum;
+};
+
+/** @internal */
+export const NotificationWorkflowDto$inboundSchema: z.ZodType<
+  NotificationWorkflowDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  identifier: z.string(),
+  name: z.string(),
+  critical: z.boolean(),
+  tags: z.array(z.string()).optional(),
+  data: z.record(z.any()).optional(),
+  severity: SeverityLevelEnum$inboundSchema,
+});
+
+export function notificationWorkflowDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<NotificationWorkflowDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NotificationWorkflowDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NotificationWorkflowDto' from JSON`,
+  );
+}

package/src/models/components/previewerrordto.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PreviewErrorDto = {
+  /**
+   * Short error title
+   */
+  title: string;
+  /**
+   * Detailed error message
+   */
+  message: string;
+  /**
+   * Actionable hint for the user
+   */
+  hint: string;
+};
+
+/** @internal */
+export const PreviewErrorDto$inboundSchema: z.ZodType<
+  PreviewErrorDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  message: z.string(),
+  hint: z.string(),
+});
+
+export function previewErrorDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PreviewErrorDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PreviewErrorDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PreviewErrorDto' from JSON`,
+  );
+}