@novu/api 0.0.1-alpha.10

package/src/models/components/subscriberpayloaddto.ts

@@ -0,0 +1,115 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type SubscriberPayloadDtoData = {};
+
+export type SubscriberPayloadDto = {
+    /**
+     * An http url to the profile image of your subscriber
+     */
+    avatar?: string | undefined;
+    channels?: Array<string> | undefined;
+    data?: SubscriberPayloadDtoData | undefined;
+    email?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    locale?: string | undefined;
+    phone?: string | undefined;
+    /**
+     * The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems
+     */
+    subscriberId: string;
+};
+
+/** @internal */
+export const SubscriberPayloadDtoData$inboundSchema: z.ZodType<
+    SubscriberPayloadDtoData,
+    z.ZodTypeDef,
+    unknown
+> = z.object({});
+
+/** @internal */
+export type SubscriberPayloadDtoData$Outbound = {};
+
+/** @internal */
+export const SubscriberPayloadDtoData$outboundSchema: z.ZodType<
+    SubscriberPayloadDtoData$Outbound,
+    z.ZodTypeDef,
+    SubscriberPayloadDtoData
+> = 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 SubscriberPayloadDtoData$ {
+    /** @deprecated use `SubscriberPayloadDtoData$inboundSchema` instead. */
+    export const inboundSchema = SubscriberPayloadDtoData$inboundSchema;
+    /** @deprecated use `SubscriberPayloadDtoData$outboundSchema` instead. */
+    export const outboundSchema = SubscriberPayloadDtoData$outboundSchema;
+    /** @deprecated use `SubscriberPayloadDtoData$Outbound` instead. */
+    export type Outbound = SubscriberPayloadDtoData$Outbound;
+}
+
+/** @internal */
+export const SubscriberPayloadDto$inboundSchema: z.ZodType<
+    SubscriberPayloadDto,
+    z.ZodTypeDef,
+    unknown
+> = z.object({
+    avatar: z.string().optional(),
+    channels: z.array(z.string()).optional(),
+    data: z.lazy(() => SubscriberPayloadDtoData$inboundSchema).optional(),
+    email: z.string().optional(),
+    firstName: z.string().optional(),
+    lastName: z.string().optional(),
+    locale: z.string().optional(),
+    phone: z.string().optional(),
+    subscriberId: z.string(),
+});
+
+/** @internal */
+export type SubscriberPayloadDto$Outbound = {
+    avatar?: string | undefined;
+    channels?: Array<string> | undefined;
+    data?: SubscriberPayloadDtoData$Outbound | undefined;
+    email?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    locale?: string | undefined;
+    phone?: string | undefined;
+    subscriberId: string;
+};
+
+/** @internal */
+export const SubscriberPayloadDto$outboundSchema: z.ZodType<
+    SubscriberPayloadDto$Outbound,
+    z.ZodTypeDef,
+    SubscriberPayloadDto
+> = z.object({
+    avatar: z.string().optional(),
+    channels: z.array(z.string()).optional(),
+    data: z.lazy(() => SubscriberPayloadDtoData$outboundSchema).optional(),
+    email: z.string().optional(),
+    firstName: z.string().optional(),
+    lastName: z.string().optional(),
+    locale: z.string().optional(),
+    phone: z.string().optional(),
+    subscriberId: 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 SubscriberPayloadDto$ {
+    /** @deprecated use `SubscriberPayloadDto$inboundSchema` instead. */
+    export const inboundSchema = SubscriberPayloadDto$inboundSchema;
+    /** @deprecated use `SubscriberPayloadDto$outboundSchema` instead. */
+    export const outboundSchema = SubscriberPayloadDto$outboundSchema;
+    /** @deprecated use `SubscriberPayloadDto$Outbound` instead. */
+    export type Outbound = SubscriberPayloadDto$Outbound;
+}

package/src/models/components/subscriberresponsedto.ts

@@ -0,0 +1,143 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+    ChannelSettings,
+    ChannelSettings$inboundSchema,
+    ChannelSettings$Outbound,
+    ChannelSettings$outboundSchema,
+} from "./channelsettings.js";
+import * as z from "zod";
+
+export type SubscriberResponseDto = {
+    v?: number | undefined;
+    environmentId: string;
+    /**
+     * The internal id novu generated for your subscriber, this is not the subscriberId matching your query. See `subscriberId` for that
+     */
+    id?: string | undefined;
+    organizationId: string;
+    avatar?: string | undefined;
+    /**
+     * Channels settings for subscriber
+     */
+    channels?: Array<ChannelSettings> | undefined;
+    createdAt: string;
+    deleted: boolean;
+    email?: string | undefined;
+    firstName?: string | undefined;
+    isOnline?: boolean | undefined;
+    lastName?: string | undefined;
+    lastOnlineAt?: string | undefined;
+    locale?: string | undefined;
+    phone?: string | undefined;
+    /**
+     * The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems
+     */
+    subscriberId: string;
+    updatedAt: string;
+};
+
+/** @internal */
+export const SubscriberResponseDto$inboundSchema: z.ZodType<
+    SubscriberResponseDto,
+    z.ZodTypeDef,
+    unknown
+> = z
+    .object({
+        __v: z.number().optional(),
+        _environmentId: z.string(),
+        _id: z.string().optional(),
+        _organizationId: z.string(),
+        avatar: z.string().optional(),
+        channels: z.array(ChannelSettings$inboundSchema).optional(),
+        createdAt: z.string(),
+        deleted: z.boolean(),
+        email: z.string().optional(),
+        firstName: z.string().optional(),
+        isOnline: z.boolean().optional(),
+        lastName: z.string().optional(),
+        lastOnlineAt: z.string().optional(),
+        locale: z.string().optional(),
+        phone: z.string().optional(),
+        subscriberId: z.string(),
+        updatedAt: z.string(),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            __v: "v",
+            _environmentId: "environmentId",
+            _id: "id",
+            _organizationId: "organizationId",
+        });
+    });
+
+/** @internal */
+export type SubscriberResponseDto$Outbound = {
+    __v?: number | undefined;
+    _environmentId: string;
+    _id?: string | undefined;
+    _organizationId: string;
+    avatar?: string | undefined;
+    channels?: Array<ChannelSettings$Outbound> | undefined;
+    createdAt: string;
+    deleted: boolean;
+    email?: string | undefined;
+    firstName?: string | undefined;
+    isOnline?: boolean | undefined;
+    lastName?: string | undefined;
+    lastOnlineAt?: string | undefined;
+    locale?: string | undefined;
+    phone?: string | undefined;
+    subscriberId: string;
+    updatedAt: string;
+};
+
+/** @internal */
+export const SubscriberResponseDto$outboundSchema: z.ZodType<
+    SubscriberResponseDto$Outbound,
+    z.ZodTypeDef,
+    SubscriberResponseDto
+> = z
+    .object({
+        v: z.number().optional(),
+        environmentId: z.string(),
+        id: z.string().optional(),
+        organizationId: z.string(),
+        avatar: z.string().optional(),
+        channels: z.array(ChannelSettings$outboundSchema).optional(),
+        createdAt: z.string(),
+        deleted: z.boolean(),
+        email: z.string().optional(),
+        firstName: z.string().optional(),
+        isOnline: z.boolean().optional(),
+        lastName: z.string().optional(),
+        lastOnlineAt: z.string().optional(),
+        locale: z.string().optional(),
+        phone: z.string().optional(),
+        subscriberId: z.string(),
+        updatedAt: z.string(),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            v: "__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 SubscriberResponseDto$ {
+    /** @deprecated use `SubscriberResponseDto$inboundSchema` instead. */
+    export const inboundSchema = SubscriberResponseDto$inboundSchema;
+    /** @deprecated use `SubscriberResponseDto$outboundSchema` instead. */
+    export const outboundSchema = SubscriberResponseDto$outboundSchema;
+    /** @deprecated use `SubscriberResponseDto$Outbound` instead. */
+    export type Outbound = SubscriberResponseDto$Outbound;
+}

package/src/models/components/templateresponse.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as z from "zod";
+
+export type TemplateResponse = {
+    /**
+     * Unique identifier of the workflow
+     */
+    id: string;
+    /**
+     * Critical templates will always be delivered to the end user and should be hidden from the subscriber preferences screen
+     */
+    critical: boolean;
+    /**
+     * Name of the workflow
+     */
+    name: string;
+    /**
+     * Triggers are the events that will trigger the workflow.
+     */
+    triggers: Array<string>;
+};
+
+/** @internal */
+export const TemplateResponse$inboundSchema: z.ZodType<TemplateResponse, z.ZodTypeDef, unknown> = z
+    .object({
+        _id: z.string(),
+        critical: z.boolean(),
+        name: z.string(),
+        triggers: z.array(z.string()),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            _id: "id",
+        });
+    });
+
+/** @internal */
+export type TemplateResponse$Outbound = {
+    _id: string;
+    critical: boolean;
+    name: string;
+    triggers: Array<string>;
+};
+
+/** @internal */
+export const TemplateResponse$outboundSchema: z.ZodType<
+    TemplateResponse$Outbound,
+    z.ZodTypeDef,
+    TemplateResponse
+> = z
+    .object({
+        id: z.string(),
+        critical: z.boolean(),
+        name: z.string(),
+        triggers: z.array(z.string()),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            id: "_id",
+        });
+    });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TemplateResponse$ {
+    /** @deprecated use `TemplateResponse$inboundSchema` instead. */
+    export const inboundSchema = TemplateResponse$inboundSchema;
+    /** @deprecated use `TemplateResponse$outboundSchema` instead. */
+    export const outboundSchema = TemplateResponse$outboundSchema;
+    /** @deprecated use `TemplateResponse$Outbound` instead. */
+    export type Outbound = TemplateResponse$Outbound;
+}

package/src/models/components/tenantpayloaddto.ts

@@ -0,0 +1,82 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type TenantPayloadDtoData = {};
+
+export type TenantPayloadDto = {
+    data?: TenantPayloadDtoData | undefined;
+    identifier?: string | undefined;
+    name?: string | undefined;
+};
+
+/** @internal */
+export const TenantPayloadDtoData$inboundSchema: z.ZodType<
+    TenantPayloadDtoData,
+    z.ZodTypeDef,
+    unknown
+> = z.object({});
+
+/** @internal */
+export type TenantPayloadDtoData$Outbound = {};
+
+/** @internal */
+export const TenantPayloadDtoData$outboundSchema: z.ZodType<
+    TenantPayloadDtoData$Outbound,
+    z.ZodTypeDef,
+    TenantPayloadDtoData
+> = 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 TenantPayloadDtoData$ {
+    /** @deprecated use `TenantPayloadDtoData$inboundSchema` instead. */
+    export const inboundSchema = TenantPayloadDtoData$inboundSchema;
+    /** @deprecated use `TenantPayloadDtoData$outboundSchema` instead. */
+    export const outboundSchema = TenantPayloadDtoData$outboundSchema;
+    /** @deprecated use `TenantPayloadDtoData$Outbound` instead. */
+    export type Outbound = TenantPayloadDtoData$Outbound;
+}
+
+/** @internal */
+export const TenantPayloadDto$inboundSchema: z.ZodType<TenantPayloadDto, z.ZodTypeDef, unknown> =
+    z.object({
+        data: z.lazy(() => TenantPayloadDtoData$inboundSchema).optional(),
+        identifier: z.string().optional(),
+        name: z.string().optional(),
+    });
+
+/** @internal */
+export type TenantPayloadDto$Outbound = {
+    data?: TenantPayloadDtoData$Outbound | undefined;
+    identifier?: string | undefined;
+    name?: string | undefined;
+};
+
+/** @internal */
+export const TenantPayloadDto$outboundSchema: z.ZodType<
+    TenantPayloadDto$Outbound,
+    z.ZodTypeDef,
+    TenantPayloadDto
+> = z.object({
+    data: z.lazy(() => TenantPayloadDtoData$outboundSchema).optional(),
+    identifier: z.string().optional(),
+    name: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TenantPayloadDto$ {
+    /** @deprecated use `TenantPayloadDto$inboundSchema` instead. */
+    export const inboundSchema = TenantPayloadDto$inboundSchema;
+    /** @deprecated use `TenantPayloadDto$outboundSchema` instead. */
+    export const outboundSchema = TenantPayloadDto$outboundSchema;
+    /** @deprecated use `TenantPayloadDto$Outbound` instead. */
+    export type Outbound = TenantPayloadDto$Outbound;
+}

package/src/models/components/timedconfig.ts

@@ -0,0 +1,175 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types/enums.js";
+import * as z from "zod";
+
+export const MonthlyType = {
+    Each: "each",
+    On: "on",
+} as const;
+export type MonthlyType = ClosedEnum<typeof MonthlyType>;
+
+export const Ordinal = {
+    One: "1",
+    Two: "2",
+    Three: "3",
+    Four: "4",
+    Five: "5",
+    Last: "last",
+} as const;
+export type Ordinal = ClosedEnum<typeof Ordinal>;
+
+export const OrdinalValue = {
+    Day: "day",
+    Weekday: "weekday",
+    Weekend: "weekend",
+    Sunday: "sunday",
+    Monday: "monday",
+    Tuesday: "tuesday",
+    Wednesday: "wednesday",
+    Thursday: "thursday",
+    Friday: "friday",
+    Saturday: "saturday",
+} as const;
+export type OrdinalValue = ClosedEnum<typeof OrdinalValue>;
+
+export const WeekDays = {
+    Monday: "monday",
+    Tuesday: "tuesday",
+    Wednesday: "wednesday",
+    Thursday: "thursday",
+    Friday: "friday",
+    Saturday: "saturday",
+    Sunday: "sunday",
+} as const;
+export type WeekDays = ClosedEnum<typeof WeekDays>;
+
+export type TimedConfig = {
+    atTime?: string | undefined;
+    monthDays?: Array<string> | undefined;
+    monthlyType?: MonthlyType | undefined;
+    ordinal?: Ordinal | undefined;
+    ordinalValue?: OrdinalValue | undefined;
+    weekDays?: Array<WeekDays> | undefined;
+};
+
+/** @internal */
+export const MonthlyType$inboundSchema: z.ZodNativeEnum<typeof MonthlyType> =
+    z.nativeEnum(MonthlyType);
+
+/** @internal */
+export const MonthlyType$outboundSchema: z.ZodNativeEnum<typeof MonthlyType> =
+    MonthlyType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MonthlyType$ {
+    /** @deprecated use `MonthlyType$inboundSchema` instead. */
+    export const inboundSchema = MonthlyType$inboundSchema;
+    /** @deprecated use `MonthlyType$outboundSchema` instead. */
+    export const outboundSchema = MonthlyType$outboundSchema;
+}
+
+/** @internal */
+export const Ordinal$inboundSchema: z.ZodNativeEnum<typeof Ordinal> = z.nativeEnum(Ordinal);
+
+/** @internal */
+export const Ordinal$outboundSchema: z.ZodNativeEnum<typeof Ordinal> = Ordinal$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Ordinal$ {
+    /** @deprecated use `Ordinal$inboundSchema` instead. */
+    export const inboundSchema = Ordinal$inboundSchema;
+    /** @deprecated use `Ordinal$outboundSchema` instead. */
+    export const outboundSchema = Ordinal$outboundSchema;
+}
+
+/** @internal */
+export const OrdinalValue$inboundSchema: z.ZodNativeEnum<typeof OrdinalValue> =
+    z.nativeEnum(OrdinalValue);
+
+/** @internal */
+export const OrdinalValue$outboundSchema: z.ZodNativeEnum<typeof OrdinalValue> =
+    OrdinalValue$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OrdinalValue$ {
+    /** @deprecated use `OrdinalValue$inboundSchema` instead. */
+    export const inboundSchema = OrdinalValue$inboundSchema;
+    /** @deprecated use `OrdinalValue$outboundSchema` instead. */
+    export const outboundSchema = OrdinalValue$outboundSchema;
+}
+
+/** @internal */
+export const WeekDays$inboundSchema: z.ZodNativeEnum<typeof WeekDays> = z.nativeEnum(WeekDays);
+
+/** @internal */
+export const WeekDays$outboundSchema: z.ZodNativeEnum<typeof WeekDays> = WeekDays$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WeekDays$ {
+    /** @deprecated use `WeekDays$inboundSchema` instead. */
+    export const inboundSchema = WeekDays$inboundSchema;
+    /** @deprecated use `WeekDays$outboundSchema` instead. */
+    export const outboundSchema = WeekDays$outboundSchema;
+}
+
+/** @internal */
+export const TimedConfig$inboundSchema: z.ZodType<TimedConfig, z.ZodTypeDef, unknown> = z.object({
+    atTime: z.string().optional(),
+    monthDays: z.array(z.string()).optional(),
+    monthlyType: MonthlyType$inboundSchema.optional(),
+    ordinal: Ordinal$inboundSchema.optional(),
+    ordinalValue: OrdinalValue$inboundSchema.optional(),
+    weekDays: z.array(WeekDays$inboundSchema).optional(),
+});
+
+/** @internal */
+export type TimedConfig$Outbound = {
+    atTime?: string | undefined;
+    monthDays?: Array<string> | undefined;
+    monthlyType?: string | undefined;
+    ordinal?: string | undefined;
+    ordinalValue?: string | undefined;
+    weekDays?: Array<string> | undefined;
+};
+
+/** @internal */
+export const TimedConfig$outboundSchema: z.ZodType<
+    TimedConfig$Outbound,
+    z.ZodTypeDef,
+    TimedConfig
+> = z.object({
+    atTime: z.string().optional(),
+    monthDays: z.array(z.string()).optional(),
+    monthlyType: MonthlyType$outboundSchema.optional(),
+    ordinal: Ordinal$outboundSchema.optional(),
+    ordinalValue: OrdinalValue$outboundSchema.optional(),
+    weekDays: z.array(WeekDays$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 TimedConfig$ {
+    /** @deprecated use `TimedConfig$inboundSchema` instead. */
+    export const inboundSchema = TimedConfig$inboundSchema;
+    /** @deprecated use `TimedConfig$outboundSchema` instead. */
+    export const outboundSchema = TimedConfig$outboundSchema;
+    /** @deprecated use `TimedConfig$Outbound` instead. */
+    export type Outbound = TimedConfig$Outbound;
+}

package/src/models/components/topicdto.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as z from "zod";
+
+export type TopicDto = {
+    environmentId: string;
+    id?: string | undefined;
+    organizationId: string;
+    key: string;
+    name: string;
+    subscribers: Array<string>;
+};
+
+/** @internal */
+export const TopicDto$inboundSchema: z.ZodType<TopicDto, z.ZodTypeDef, unknown> = z
+    .object({
+        _environmentId: z.string(),
+        _id: z.string().optional(),
+        _organizationId: z.string(),
+        key: z.string(),
+        name: z.string(),
+        subscribers: z.array(z.string()),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            _environmentId: "environmentId",
+            _id: "id",
+            _organizationId: "organizationId",
+        });
+    });
+
+/** @internal */
+export type TopicDto$Outbound = {
+    _environmentId: string;
+    _id?: string | undefined;
+    _organizationId: string;
+    key: string;
+    name: string;
+    subscribers: Array<string>;
+};
+
+/** @internal */
+export const TopicDto$outboundSchema: z.ZodType<TopicDto$Outbound, z.ZodTypeDef, TopicDto> = z
+    .object({
+        environmentId: z.string(),
+        id: z.string().optional(),
+        organizationId: z.string(),
+        key: z.string(),
+        name: z.string(),
+        subscribers: z.array(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 TopicDto$ {
+    /** @deprecated use `TopicDto$inboundSchema` instead. */
+    export const inboundSchema = TopicDto$inboundSchema;
+    /** @deprecated use `TopicDto$outboundSchema` instead. */
+    export const outboundSchema = TopicDto$outboundSchema;
+    /** @deprecated use `TopicDto$Outbound` instead. */
+    export type Outbound = TopicDto$Outbound;
+}