@novu/api 0.0.1-alpha.10

package/src/models/components/channelpreference.ts

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types/enums.js";
+import * as z from "zod";
+
+/**
+ * The type of channel that is enabled or not
+ */
+export const ChannelPreferenceType = {
+    InApp: "in_app",
+    Email: "email",
+    Sms: "sms",
+    Chat: "chat",
+    Push: "push",
+} as const;
+/**
+ * The type of channel that is enabled or not
+ */
+export type ChannelPreferenceType = ClosedEnum<typeof ChannelPreferenceType>;
+
+export type ChannelPreference = {
+    /**
+     * If channel is enabled or not
+     */
+    enabled: boolean;
+    /**
+     * The type of channel that is enabled or not
+     */
+    type: ChannelPreferenceType;
+};
+
+/** @internal */
+export const ChannelPreferenceType$inboundSchema: z.ZodNativeEnum<typeof ChannelPreferenceType> =
+    z.nativeEnum(ChannelPreferenceType);
+
+/** @internal */
+export const ChannelPreferenceType$outboundSchema: z.ZodNativeEnum<typeof ChannelPreferenceType> =
+    ChannelPreferenceType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ChannelPreferenceType$ {
+    /** @deprecated use `ChannelPreferenceType$inboundSchema` instead. */
+    export const inboundSchema = ChannelPreferenceType$inboundSchema;
+    /** @deprecated use `ChannelPreferenceType$outboundSchema` instead. */
+    export const outboundSchema = ChannelPreferenceType$outboundSchema;
+}
+
+/** @internal */
+export const ChannelPreference$inboundSchema: z.ZodType<ChannelPreference, z.ZodTypeDef, unknown> =
+    z.object({
+        enabled: z.boolean(),
+        type: ChannelPreferenceType$inboundSchema,
+    });
+
+/** @internal */
+export type ChannelPreference$Outbound = {
+    enabled: boolean;
+    type: string;
+};
+
+/** @internal */
+export const ChannelPreference$outboundSchema: z.ZodType<
+    ChannelPreference$Outbound,
+    z.ZodTypeDef,
+    ChannelPreference
+> = z.object({
+    enabled: z.boolean(),
+    type: ChannelPreferenceType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ChannelPreference$ {
+    /** @deprecated use `ChannelPreference$inboundSchema` instead. */
+    export const inboundSchema = ChannelPreference$inboundSchema;
+    /** @deprecated use `ChannelPreference$outboundSchema` instead. */
+    export const outboundSchema = ChannelPreference$outboundSchema;
+    /** @deprecated use `ChannelPreference$Outbound` instead. */
+    export type Outbound = ChannelPreference$Outbound;
+}

package/src/models/components/channelsettings.ts

@@ -0,0 +1,84 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+    ChannelCredentials,
+    ChannelCredentials$inboundSchema,
+    ChannelCredentials$Outbound,
+    ChannelCredentials$outboundSchema,
+} from "./channelcredentials.js";
+import * as z from "zod";
+
+export type ChannelSettings = {
+    /**
+     * Id of the integration that is used for this channel
+     */
+    integrationId: string;
+    /**
+     * Credentials payload for the specified provider
+     */
+    credentials: ChannelCredentials;
+    /**
+     * The integration identifier
+     */
+    integrationIdentifier?: string | undefined;
+    /**
+     * The provider identifier for the credentials
+     */
+    providerId: number;
+};
+
+/** @internal */
+export const ChannelSettings$inboundSchema: z.ZodType<ChannelSettings, z.ZodTypeDef, unknown> = z
+    .object({
+        _integrationId: z.string(),
+        credentials: ChannelCredentials$inboundSchema,
+        integrationIdentifier: z.string().optional(),
+        providerId: z.number(),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            _integrationId: "integrationId",
+        });
+    });
+
+/** @internal */
+export type ChannelSettings$Outbound = {
+    _integrationId: string;
+    credentials: ChannelCredentials$Outbound;
+    integrationIdentifier?: string | undefined;
+    providerId: number;
+};
+
+/** @internal */
+export const ChannelSettings$outboundSchema: z.ZodType<
+    ChannelSettings$Outbound,
+    z.ZodTypeDef,
+    ChannelSettings
+> = z
+    .object({
+        integrationId: z.string(),
+        credentials: ChannelCredentials$outboundSchema,
+        integrationIdentifier: z.string().optional(),
+        providerId: z.number(),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            integrationId: "_integrationId",
+        });
+    });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ChannelSettings$ {
+    /** @deprecated use `ChannelSettings$inboundSchema` instead. */
+    export const inboundSchema = ChannelSettings$inboundSchema;
+    /** @deprecated use `ChannelSettings$outboundSchema` instead. */
+    export const outboundSchema = ChannelSettings$outboundSchema;
+    /** @deprecated use `ChannelSettings$Outbound` instead. */
+    export type Outbound = ChannelSettings$Outbound;
+}

package/src/models/components/createfeedrequestdto.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type CreateFeedRequestDto = {
+    name: string;
+};
+
+/** @internal */
+export const CreateFeedRequestDto$inboundSchema: z.ZodType<
+    CreateFeedRequestDto,
+    z.ZodTypeDef,
+    unknown
+> = z.object({
+    name: z.string(),
+});
+
+/** @internal */
+export type CreateFeedRequestDto$Outbound = {
+    name: string;
+};
+
+/** @internal */
+export const CreateFeedRequestDto$outboundSchema: z.ZodType<
+    CreateFeedRequestDto$Outbound,
+    z.ZodTypeDef,
+    CreateFeedRequestDto
+> = z.object({
+    name: 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 CreateFeedRequestDto$ {
+    /** @deprecated use `CreateFeedRequestDto$inboundSchema` instead. */
+    export const inboundSchema = CreateFeedRequestDto$inboundSchema;
+    /** @deprecated use `CreateFeedRequestDto$outboundSchema` instead. */
+    export const outboundSchema = CreateFeedRequestDto$outboundSchema;
+    /** @deprecated use `CreateFeedRequestDto$Outbound` instead. */
+    export type Outbound = CreateFeedRequestDto$Outbound;
+}

package/src/models/components/createintegrationrequestdto.ts

@@ -0,0 +1,132 @@
+/*
+ * 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 Channel = {
+    InApp: "in_app",
+    Email: "email",
+    Sms: "sms",
+    Chat: "chat",
+    Push: "push",
+} as const;
+export type Channel = ClosedEnum<typeof Channel>;
+
+export type CreateIntegrationRequestDto = {
+    environmentId?: string | undefined;
+    /**
+     * If the integration is active the validation on the credentials field will run
+     */
+    active?: boolean | undefined;
+    channel: Channel;
+    check?: boolean | undefined;
+    conditions?: Array<StepFilter> | undefined;
+    credentials?: CredentialsDto | undefined;
+    identifier?: string | undefined;
+    name?: string | undefined;
+    providerId: string;
+};
+
+/** @internal */
+export const Channel$inboundSchema: z.ZodNativeEnum<typeof Channel> = z.nativeEnum(Channel);
+
+/** @internal */
+export const Channel$outboundSchema: z.ZodNativeEnum<typeof Channel> = Channel$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Channel$ {
+    /** @deprecated use `Channel$inboundSchema` instead. */
+    export const inboundSchema = Channel$inboundSchema;
+    /** @deprecated use `Channel$outboundSchema` instead. */
+    export const outboundSchema = Channel$outboundSchema;
+}
+
+/** @internal */
+export const CreateIntegrationRequestDto$inboundSchema: z.ZodType<
+    CreateIntegrationRequestDto,
+    z.ZodTypeDef,
+    unknown
+> = z
+    .object({
+        _environmentId: z.string().optional(),
+        active: z.boolean().optional(),
+        channel: Channel$inboundSchema,
+        check: z.boolean().optional(),
+        conditions: z.array(StepFilter$inboundSchema).optional(),
+        credentials: CredentialsDto$inboundSchema.optional(),
+        identifier: z.string().optional(),
+        name: z.string().optional(),
+        providerId: z.string(),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            _environmentId: "environmentId",
+        });
+    });
+
+/** @internal */
+export type CreateIntegrationRequestDto$Outbound = {
+    _environmentId?: string | undefined;
+    active?: boolean | undefined;
+    channel: string;
+    check?: boolean | undefined;
+    conditions?: Array<StepFilter$Outbound> | undefined;
+    credentials?: CredentialsDto$Outbound | undefined;
+    identifier?: string | undefined;
+    name?: string | undefined;
+    providerId: string;
+};
+
+/** @internal */
+export const CreateIntegrationRequestDto$outboundSchema: z.ZodType<
+    CreateIntegrationRequestDto$Outbound,
+    z.ZodTypeDef,
+    CreateIntegrationRequestDto
+> = z
+    .object({
+        environmentId: z.string().optional(),
+        active: z.boolean().optional(),
+        channel: Channel$outboundSchema,
+        check: z.boolean().optional(),
+        conditions: z.array(StepFilter$outboundSchema).optional(),
+        credentials: CredentialsDto$outboundSchema.optional(),
+        identifier: z.string().optional(),
+        name: z.string().optional(),
+        providerId: z.string(),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            environmentId: "_environmentId",
+        });
+    });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateIntegrationRequestDto$ {
+    /** @deprecated use `CreateIntegrationRequestDto$inboundSchema` instead. */
+    export const inboundSchema = CreateIntegrationRequestDto$inboundSchema;
+    /** @deprecated use `CreateIntegrationRequestDto$outboundSchema` instead. */
+    export const outboundSchema = CreateIntegrationRequestDto$outboundSchema;
+    /** @deprecated use `CreateIntegrationRequestDto$Outbound` instead. */
+    export type Outbound = CreateIntegrationRequestDto$Outbound;
+}

package/src/models/components/createlayoutresponsedto.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 CreateLayoutResponseDto = {
+    /**
+     * The unique identifier for the Layout created.
+     */
+    id: string;
+};
+
+/** @internal */
+export const CreateLayoutResponseDto$inboundSchema: z.ZodType<
+    CreateLayoutResponseDto,
+    z.ZodTypeDef,
+    unknown
+> = z
+    .object({
+        _id: z.string(),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            _id: "id",
+        });
+    });
+
+/** @internal */
+export type CreateLayoutResponseDto$Outbound = {
+    _id: string;
+};
+
+/** @internal */
+export const CreateLayoutResponseDto$outboundSchema: z.ZodType<
+    CreateLayoutResponseDto$Outbound,
+    z.ZodTypeDef,
+    CreateLayoutResponseDto
+> = z
+    .object({
+        id: 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 CreateLayoutResponseDto$ {
+    /** @deprecated use `CreateLayoutResponseDto$inboundSchema` instead. */
+    export const inboundSchema = CreateLayoutResponseDto$inboundSchema;
+    /** @deprecated use `CreateLayoutResponseDto$outboundSchema` instead. */
+    export const outboundSchema = CreateLayoutResponseDto$outboundSchema;
+    /** @deprecated use `CreateLayoutResponseDto$Outbound` instead. */
+    export type Outbound = CreateLayoutResponseDto$Outbound;
+}

package/src/models/components/createnotificationgrouprequestdto.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type CreateNotificationGroupRequestDto = {
+    name: string;
+};
+
+/** @internal */
+export const CreateNotificationGroupRequestDto$inboundSchema: z.ZodType<
+    CreateNotificationGroupRequestDto,
+    z.ZodTypeDef,
+    unknown
+> = z.object({
+    name: z.string(),
+});
+
+/** @internal */
+export type CreateNotificationGroupRequestDto$Outbound = {
+    name: string;
+};
+
+/** @internal */
+export const CreateNotificationGroupRequestDto$outboundSchema: z.ZodType<
+    CreateNotificationGroupRequestDto$Outbound,
+    z.ZodTypeDef,
+    CreateNotificationGroupRequestDto
+> = z.object({
+    name: 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 CreateNotificationGroupRequestDto$ {
+    /** @deprecated use `CreateNotificationGroupRequestDto$inboundSchema` instead. */
+    export const inboundSchema = CreateNotificationGroupRequestDto$inboundSchema;
+    /** @deprecated use `CreateNotificationGroupRequestDto$outboundSchema` instead. */
+    export const outboundSchema = CreateNotificationGroupRequestDto$outboundSchema;
+    /** @deprecated use `CreateNotificationGroupRequestDto$Outbound` instead. */
+    export type Outbound = CreateNotificationGroupRequestDto$Outbound;
+}

package/src/models/components/createsubscriberrequestdto.ts

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

package/src/models/components/createtenantrequestdto.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type CreateTenantRequestDtoData = {};
+
+export type CreateTenantRequestDto = {
+    data?: CreateTenantRequestDtoData | undefined;
+    identifier: string;
+    name: string;
+};
+
+/** @internal */
+export const CreateTenantRequestDtoData$inboundSchema: z.ZodType<
+    CreateTenantRequestDtoData,
+    z.ZodTypeDef,
+    unknown
+> = z.object({});
+
+/** @internal */
+export type CreateTenantRequestDtoData$Outbound = {};
+
+/** @internal */
+export const CreateTenantRequestDtoData$outboundSchema: z.ZodType<
+    CreateTenantRequestDtoData$Outbound,
+    z.ZodTypeDef,
+    CreateTenantRequestDtoData
+> = 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 CreateTenantRequestDtoData$ {
+    /** @deprecated use `CreateTenantRequestDtoData$inboundSchema` instead. */
+    export const inboundSchema = CreateTenantRequestDtoData$inboundSchema;
+    /** @deprecated use `CreateTenantRequestDtoData$outboundSchema` instead. */
+    export const outboundSchema = CreateTenantRequestDtoData$outboundSchema;
+    /** @deprecated use `CreateTenantRequestDtoData$Outbound` instead. */
+    export type Outbound = CreateTenantRequestDtoData$Outbound;
+}
+
+/** @internal */
+export const CreateTenantRequestDto$inboundSchema: z.ZodType<
+    CreateTenantRequestDto,
+    z.ZodTypeDef,
+    unknown
+> = z.object({
+    data: z.lazy(() => CreateTenantRequestDtoData$inboundSchema).optional(),
+    identifier: z.string(),
+    name: z.string(),
+});
+
+/** @internal */
+export type CreateTenantRequestDto$Outbound = {
+    data?: CreateTenantRequestDtoData$Outbound | undefined;
+    identifier: string;
+    name: string;
+};
+
+/** @internal */
+export const CreateTenantRequestDto$outboundSchema: z.ZodType<
+    CreateTenantRequestDto$Outbound,
+    z.ZodTypeDef,
+    CreateTenantRequestDto
+> = z.object({
+    data: z.lazy(() => CreateTenantRequestDtoData$outboundSchema).optional(),
+    identifier: z.string(),
+    name: 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 CreateTenantRequestDto$ {
+    /** @deprecated use `CreateTenantRequestDto$inboundSchema` instead. */
+    export const inboundSchema = CreateTenantRequestDto$inboundSchema;
+    /** @deprecated use `CreateTenantRequestDto$outboundSchema` instead. */
+    export const outboundSchema = CreateTenantRequestDto$outboundSchema;
+    /** @deprecated use `CreateTenantRequestDto$Outbound` instead. */
+    export type Outbound = CreateTenantRequestDto$Outbound;
+}