@novu/api 0.0.1-alpha.10

package/src/models/components/index.ts

@@ -0,0 +1,108 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./activitiesresponsedto.js";
+export * from "./activitygraphstatesresponse.js";
+export * from "./activitynotificationresponsedto.js";
+export * from "./activitynotificationsubscriberresponsedto.js";
+export * from "./activitynotificationtemplateresponsedto.js";
+export * from "./activitystatsresponsedto.js";
+export * from "./addsubscribersrequestdto.js";
+export * from "./apikey.js";
+export * from "./bulkapplychangedto.js";
+export * from "./bulksubscribercreatedto.js";
+export * from "./bulktriggereventdto.js";
+export * from "./changeresponsedto.js";
+export * from "./changesresponsedto.js";
+export * from "./changeworkflowstatusrequestdto.js";
+export * from "./channelcredentials.js";
+export * from "./channelpreference.js";
+export * from "./channelsettings.js";
+export * from "./createfeedrequestdto.js";
+export * from "./createintegrationrequestdto.js";
+export * from "./createlayoutresponsedto.js";
+export * from "./createnotificationgrouprequestdto.js";
+export * from "./createsubscriberrequestdto.js";
+export * from "./createtenantrequestdto.js";
+export * from "./createtenantresponsedto.js";
+export * from "./createtopicrequestdto.js";
+export * from "./createtopicresponsedto.js";
+export * from "./createworkflowrequestdto.js";
+export * from "./credentialsdto.js";
+export * from "./databooleandto.js";
+export * from "./datanumberdto.js";
+export * from "./delayregularmetadata.js";
+export * from "./delayscheduledmetadata.js";
+export * from "./deletemessageresponsedto.js";
+export * from "./deletenotificationgroupresponsedto.js";
+export * from "./deletesubscriberresponsedto.js";
+export * from "./digestregularmetadata.js";
+export * from "./digesttimedmetadata.js";
+export * from "./emailblock.js";
+export * from "./emailblockstyles.js";
+export * from "./environmentresponsedto.js";
+export * from "./executiondetailsresponsedto.js";
+export * from "./feedresponsedto.js";
+export * from "./fieldfilterpart.js";
+export * from "./filtertopicsresponsedto.js";
+export * from "./getlayoutresponsedto.js";
+export * from "./getsubscriberpreferencesresponsedto.js";
+export * from "./gettenantresponsedto.js";
+export * from "./gettopicresponsedto.js";
+export * from "./integrationresponsedto.js";
+export * from "./markallmessageasrequestdto.js";
+export * from "./markmessageactionasseendto.js";
+export * from "./messageaction.js";
+export * from "./messageactionresult.js";
+export * from "./messagebutton.js";
+export * from "./messagecta.js";
+export * from "./messagectadata.js";
+export * from "./messageentity.js";
+export * from "./messagemarkasrequestdto.js";
+export * from "./messageresponsedto.js";
+export * from "./messagetemplate.js";
+export * from "./notificationgroup.js";
+export * from "./notificationgroupresponsedto.js";
+export * from "./notificationstep.js";
+export * from "./notificationstepvariant.js";
+export * from "./notificationtrigger.js";
+export * from "./notificationtriggervariable.js";
+export * from "./organizationbrandingresponsedto.js";
+export * from "./organizationresponsedto.js";
+export * from "./preference.js";
+export * from "./preferencechannels.js";
+export * from "./removesubscribersrequestdto.js";
+export * from "./renameorganizationdto.js";
+export * from "./renametopicrequestdto.js";
+export * from "./renametopicresponsedto.js";
+export * from "./security.js";
+export * from "./stepfilter.js";
+export * from "./subscriberpayloaddto.js";
+export * from "./subscriberresponsedto.js";
+export * from "./templateresponse.js";
+export * from "./tenantpayloaddto.js";
+export * from "./timedconfig.js";
+export * from "./topicdto.js";
+export * from "./topicpayloaddto.js";
+export * from "./topicsubscriberdto.js";
+export * from "./triggereventrequestdto.js";
+export * from "./triggereventresponsedto.js";
+export * from "./triggereventtoallrequestdto.js";
+export * from "./unseencountresponse.js";
+export * from "./updatebrandingdetailsdto.js";
+export * from "./updateintegrationrequestdto.js";
+export * from "./updatelayoutrequestdto.js";
+export * from "./updatelayoutresponsedto.js";
+export * from "./updatesubscriberchannelrequestdto.js";
+export * from "./updatesubscriberglobalpreferencesrequestdto.js";
+export * from "./updatesubscriberonlineflagrequestdto.js";
+export * from "./updatesubscriberpreferencerequestdto.js";
+export * from "./updatesubscriberpreferenceresponsedto.js";
+export * from "./updatesubscriberrequestdto.js";
+export * from "./updatetenantrequestdto.js";
+export * from "./updatetenantresponsedto.js";
+export * from "./updateworkflowrequestdto.js";
+export * from "./variablesresponsedto.js";
+export * from "./workflowresponse.js";
+export * from "./workflowsresponsedto.js";

package/src/models/components/integrationresponsedto.ts

@@ -0,0 +1,157 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+    CredentialsDto,
+    CredentialsDto$inboundSchema,
+    CredentialsDto$Outbound,
+    CredentialsDto$outboundSchema,
+} from "./credentialsdto.js";
+import {
+    StepFilter,
+    StepFilter$inboundSchema,
+    StepFilter$Outbound,
+    StepFilter$outboundSchema,
+} from "./stepfilter.js";
+import * as z from "zod";
+
+export const IntegrationResponseDtoChannel = {
+    InApp: "in_app",
+    Email: "email",
+    Sms: "sms",
+    Chat: "chat",
+    Push: "push",
+} as const;
+export type IntegrationResponseDtoChannel = ClosedEnum<typeof IntegrationResponseDtoChannel>;
+
+export type IntegrationResponseDto = {
+    environmentId: string;
+    id?: string | undefined;
+    organizationId: string;
+    active: boolean;
+    channel: IntegrationResponseDtoChannel;
+    conditions?: Array<StepFilter> | undefined;
+    credentials: CredentialsDto;
+    deleted: boolean;
+    deletedAt: string;
+    deletedBy: string;
+    identifier: string;
+    name: string;
+    primary: boolean;
+    providerId: string;
+};
+
+/** @internal */
+export const IntegrationResponseDtoChannel$inboundSchema: z.ZodNativeEnum<
+    typeof IntegrationResponseDtoChannel
+> = z.nativeEnum(IntegrationResponseDtoChannel);
+
+/** @internal */
+export const IntegrationResponseDtoChannel$outboundSchema: z.ZodNativeEnum<
+    typeof IntegrationResponseDtoChannel
+> = IntegrationResponseDtoChannel$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace IntegrationResponseDtoChannel$ {
+    /** @deprecated use `IntegrationResponseDtoChannel$inboundSchema` instead. */
+    export const inboundSchema = IntegrationResponseDtoChannel$inboundSchema;
+    /** @deprecated use `IntegrationResponseDtoChannel$outboundSchema` instead. */
+    export const outboundSchema = IntegrationResponseDtoChannel$outboundSchema;
+}
+
+/** @internal */
+export const IntegrationResponseDto$inboundSchema: z.ZodType<
+    IntegrationResponseDto,
+    z.ZodTypeDef,
+    unknown
+> = z
+    .object({
+        _environmentId: z.string(),
+        _id: z.string().optional(),
+        _organizationId: z.string(),
+        active: z.boolean(),
+        channel: IntegrationResponseDtoChannel$inboundSchema,
+        conditions: z.array(StepFilter$inboundSchema).optional(),
+        credentials: CredentialsDto$inboundSchema,
+        deleted: z.boolean(),
+        deletedAt: z.string(),
+        deletedBy: z.string(),
+        identifier: z.string(),
+        name: z.string(),
+        primary: z.boolean(),
+        providerId: z.string(),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            _environmentId: "environmentId",
+            _id: "id",
+            _organizationId: "organizationId",
+        });
+    });
+
+/** @internal */
+export type IntegrationResponseDto$Outbound = {
+    _environmentId: string;
+    _id?: string | undefined;
+    _organizationId: string;
+    active: boolean;
+    channel: string;
+    conditions?: Array<StepFilter$Outbound> | undefined;
+    credentials: CredentialsDto$Outbound;
+    deleted: boolean;
+    deletedAt: string;
+    deletedBy: string;
+    identifier: string;
+    name: string;
+    primary: boolean;
+    providerId: string;
+};
+
+/** @internal */
+export const IntegrationResponseDto$outboundSchema: z.ZodType<
+    IntegrationResponseDto$Outbound,
+    z.ZodTypeDef,
+    IntegrationResponseDto
+> = z
+    .object({
+        environmentId: z.string(),
+        id: z.string().optional(),
+        organizationId: z.string(),
+        active: z.boolean(),
+        channel: IntegrationResponseDtoChannel$outboundSchema,
+        conditions: z.array(StepFilter$outboundSchema).optional(),
+        credentials: CredentialsDto$outboundSchema,
+        deleted: z.boolean(),
+        deletedAt: z.string(),
+        deletedBy: z.string(),
+        identifier: z.string(),
+        name: z.string(),
+        primary: z.boolean(),
+        providerId: z.string(),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            environmentId: "_environmentId",
+            id: "_id",
+            organizationId: "_organizationId",
+        });
+    });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace IntegrationResponseDto$ {
+    /** @deprecated use `IntegrationResponseDto$inboundSchema` instead. */
+    export const inboundSchema = IntegrationResponseDto$inboundSchema;
+    /** @deprecated use `IntegrationResponseDto$outboundSchema` instead. */
+    export const outboundSchema = IntegrationResponseDto$outboundSchema;
+    /** @deprecated use `IntegrationResponseDto$Outbound` instead. */
+    export type Outbound = IntegrationResponseDto$Outbound;
+}

package/src/models/components/markallmessageasrequestdto.ts

@@ -0,0 +1,119 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types/enums.js";
+import * as z from "zod";
+
+/**
+ * Optional feed identifier or array of feed identifiers
+ */
+export type FeedIdentifier = string | Array<string>;
+
+/**
+ * Mark all subscriber messages as read, unread, seen or unseen
+ */
+export const MarkAs = {
+    Read: "read",
+    Seen: "seen",
+    Unread: "unread",
+    Unseen: "unseen",
+} as const;
+/**
+ * Mark all subscriber messages as read, unread, seen or unseen
+ */
+export type MarkAs = ClosedEnum<typeof MarkAs>;
+
+export type MarkAllMessageAsRequestDto = {
+    /**
+     * Optional feed identifier or array of feed identifiers
+     */
+    feedIdentifier?: string | Array<string> | undefined;
+    /**
+     * Mark all subscriber messages as read, unread, seen or unseen
+     */
+    markAs: MarkAs;
+};
+
+/** @internal */
+export const FeedIdentifier$inboundSchema: z.ZodType<FeedIdentifier, z.ZodTypeDef, unknown> =
+    z.union([z.string(), z.array(z.string())]);
+
+/** @internal */
+export type FeedIdentifier$Outbound = string | Array<string>;
+
+/** @internal */
+export const FeedIdentifier$outboundSchema: z.ZodType<
+    FeedIdentifier$Outbound,
+    z.ZodTypeDef,
+    FeedIdentifier
+> = z.union([z.string(), z.array(z.string())]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace FeedIdentifier$ {
+    /** @deprecated use `FeedIdentifier$inboundSchema` instead. */
+    export const inboundSchema = FeedIdentifier$inboundSchema;
+    /** @deprecated use `FeedIdentifier$outboundSchema` instead. */
+    export const outboundSchema = FeedIdentifier$outboundSchema;
+    /** @deprecated use `FeedIdentifier$Outbound` instead. */
+    export type Outbound = FeedIdentifier$Outbound;
+}
+
+/** @internal */
+export const MarkAs$inboundSchema: z.ZodNativeEnum<typeof MarkAs> = z.nativeEnum(MarkAs);
+
+/** @internal */
+export const MarkAs$outboundSchema: z.ZodNativeEnum<typeof MarkAs> = MarkAs$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MarkAs$ {
+    /** @deprecated use `MarkAs$inboundSchema` instead. */
+    export const inboundSchema = MarkAs$inboundSchema;
+    /** @deprecated use `MarkAs$outboundSchema` instead. */
+    export const outboundSchema = MarkAs$outboundSchema;
+}
+
+/** @internal */
+export const MarkAllMessageAsRequestDto$inboundSchema: z.ZodType<
+    MarkAllMessageAsRequestDto,
+    z.ZodTypeDef,
+    unknown
+> = z.object({
+    feedIdentifier: z.union([z.string(), z.array(z.string())]).optional(),
+    markAs: MarkAs$inboundSchema,
+});
+
+/** @internal */
+export type MarkAllMessageAsRequestDto$Outbound = {
+    feedIdentifier?: string | Array<string> | undefined;
+    markAs: string;
+};
+
+/** @internal */
+export const MarkAllMessageAsRequestDto$outboundSchema: z.ZodType<
+    MarkAllMessageAsRequestDto$Outbound,
+    z.ZodTypeDef,
+    MarkAllMessageAsRequestDto
+> = z.object({
+    feedIdentifier: z.union([z.string(), z.array(z.string())]).optional(),
+    markAs: MarkAs$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MarkAllMessageAsRequestDto$ {
+    /** @deprecated use `MarkAllMessageAsRequestDto$inboundSchema` instead. */
+    export const inboundSchema = MarkAllMessageAsRequestDto$inboundSchema;
+    /** @deprecated use `MarkAllMessageAsRequestDto$outboundSchema` instead. */
+    export const outboundSchema = MarkAllMessageAsRequestDto$outboundSchema;
+    /** @deprecated use `MarkAllMessageAsRequestDto$Outbound` instead. */
+    export type Outbound = MarkAllMessageAsRequestDto$Outbound;
+}

package/src/models/components/markmessageactionasseendto.ts

@@ -0,0 +1,118 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types/enums.js";
+import * as z from "zod";
+
+/**
+ * Message action payload
+ */
+export type Payload = {};
+
+/**
+ * Message action status
+ */
+export const MarkMessageActionAsSeenDtoStatus = {
+    Pending: "pending",
+    Done: "done",
+} as const;
+/**
+ * Message action status
+ */
+export type MarkMessageActionAsSeenDtoStatus = ClosedEnum<typeof MarkMessageActionAsSeenDtoStatus>;
+
+export type MarkMessageActionAsSeenDto = {
+    /**
+     * Message action payload
+     */
+    payload?: Payload | undefined;
+    /**
+     * Message action status
+     */
+    status: MarkMessageActionAsSeenDtoStatus;
+};
+
+/** @internal */
+export const Payload$inboundSchema: z.ZodType<Payload, z.ZodTypeDef, unknown> = z.object({});
+
+/** @internal */
+export type Payload$Outbound = {};
+
+/** @internal */
+export const Payload$outboundSchema: z.ZodType<Payload$Outbound, z.ZodTypeDef, Payload> = 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 Payload$ {
+    /** @deprecated use `Payload$inboundSchema` instead. */
+    export const inboundSchema = Payload$inboundSchema;
+    /** @deprecated use `Payload$outboundSchema` instead. */
+    export const outboundSchema = Payload$outboundSchema;
+    /** @deprecated use `Payload$Outbound` instead. */
+    export type Outbound = Payload$Outbound;
+}
+
+/** @internal */
+export const MarkMessageActionAsSeenDtoStatus$inboundSchema: z.ZodNativeEnum<
+    typeof MarkMessageActionAsSeenDtoStatus
+> = z.nativeEnum(MarkMessageActionAsSeenDtoStatus);
+
+/** @internal */
+export const MarkMessageActionAsSeenDtoStatus$outboundSchema: z.ZodNativeEnum<
+    typeof MarkMessageActionAsSeenDtoStatus
+> = MarkMessageActionAsSeenDtoStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MarkMessageActionAsSeenDtoStatus$ {
+    /** @deprecated use `MarkMessageActionAsSeenDtoStatus$inboundSchema` instead. */
+    export const inboundSchema = MarkMessageActionAsSeenDtoStatus$inboundSchema;
+    /** @deprecated use `MarkMessageActionAsSeenDtoStatus$outboundSchema` instead. */
+    export const outboundSchema = MarkMessageActionAsSeenDtoStatus$outboundSchema;
+}
+
+/** @internal */
+export const MarkMessageActionAsSeenDto$inboundSchema: z.ZodType<
+    MarkMessageActionAsSeenDto,
+    z.ZodTypeDef,
+    unknown
+> = z.object({
+    payload: z.lazy(() => Payload$inboundSchema).optional(),
+    status: MarkMessageActionAsSeenDtoStatus$inboundSchema,
+});
+
+/** @internal */
+export type MarkMessageActionAsSeenDto$Outbound = {
+    payload?: Payload$Outbound | undefined;
+    status: string;
+};
+
+/** @internal */
+export const MarkMessageActionAsSeenDto$outboundSchema: z.ZodType<
+    MarkMessageActionAsSeenDto$Outbound,
+    z.ZodTypeDef,
+    MarkMessageActionAsSeenDto
+> = z.object({
+    payload: z.lazy(() => Payload$outboundSchema).optional(),
+    status: MarkMessageActionAsSeenDtoStatus$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MarkMessageActionAsSeenDto$ {
+    /** @deprecated use `MarkMessageActionAsSeenDto$inboundSchema` instead. */
+    export const inboundSchema = MarkMessageActionAsSeenDto$inboundSchema;
+    /** @deprecated use `MarkMessageActionAsSeenDto$outboundSchema` instead. */
+    export const outboundSchema = MarkMessageActionAsSeenDto$outboundSchema;
+    /** @deprecated use `MarkMessageActionAsSeenDto$Outbound` instead. */
+    export type Outbound = MarkMessageActionAsSeenDto$Outbound;
+}

package/src/models/components/messageaction.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types/enums.js";
+import {
+    MessageActionResult,
+    MessageActionResult$inboundSchema,
+    MessageActionResult$Outbound,
+    MessageActionResult$outboundSchema,
+} from "./messageactionresult.js";
+import {
+    MessageButton,
+    MessageButton$inboundSchema,
+    MessageButton$Outbound,
+    MessageButton$outboundSchema,
+} from "./messagebutton.js";
+import * as z from "zod";
+
+export const MessageActionStatus = {
+    Pending: "pending",
+    Done: "done",
+} as const;
+export type MessageActionStatus = ClosedEnum<typeof MessageActionStatus>;
+
+export type MessageAction = {
+    buttons?: Array<MessageButton> | undefined;
+    result?: MessageActionResult | undefined;
+    status?: MessageActionStatus | undefined;
+};
+
+/** @internal */
+export const MessageActionStatus$inboundSchema: z.ZodNativeEnum<typeof MessageActionStatus> =
+    z.nativeEnum(MessageActionStatus);
+
+/** @internal */
+export const MessageActionStatus$outboundSchema: z.ZodNativeEnum<typeof MessageActionStatus> =
+    MessageActionStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MessageActionStatus$ {
+    /** @deprecated use `MessageActionStatus$inboundSchema` instead. */
+    export const inboundSchema = MessageActionStatus$inboundSchema;
+    /** @deprecated use `MessageActionStatus$outboundSchema` instead. */
+    export const outboundSchema = MessageActionStatus$outboundSchema;
+}
+
+/** @internal */
+export const MessageAction$inboundSchema: z.ZodType<MessageAction, z.ZodTypeDef, unknown> =
+    z.object({
+        buttons: z.array(MessageButton$inboundSchema).optional(),
+        result: MessageActionResult$inboundSchema.optional(),
+        status: MessageActionStatus$inboundSchema.optional(),
+    });
+
+/** @internal */
+export type MessageAction$Outbound = {
+    buttons?: Array<MessageButton$Outbound> | undefined;
+    result?: MessageActionResult$Outbound | undefined;
+    status?: string | undefined;
+};
+
+/** @internal */
+export const MessageAction$outboundSchema: z.ZodType<
+    MessageAction$Outbound,
+    z.ZodTypeDef,
+    MessageAction
+> = z.object({
+    buttons: z.array(MessageButton$outboundSchema).optional(),
+    result: MessageActionResult$outboundSchema.optional(),
+    status: MessageActionStatus$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MessageAction$ {
+    /** @deprecated use `MessageAction$inboundSchema` instead. */
+    export const inboundSchema = MessageAction$inboundSchema;
+    /** @deprecated use `MessageAction$outboundSchema` instead. */
+    export const outboundSchema = MessageAction$outboundSchema;
+    /** @deprecated use `MessageAction$Outbound` instead. */
+    export type Outbound = MessageAction$Outbound;
+}