@novu/api 0.0.1-alpha.6

package/src/models/components/removesubscribersrequestdto.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type RemoveSubscribersRequestDto = {
+    /**
+     * List of subscriber identifiers that will be removed to the topic
+     */
+    subscribers: Array<string>;
+};
+
+/** @internal */
+export namespace RemoveSubscribersRequestDto$ {
+    export const inboundSchema: z.ZodType<RemoveSubscribersRequestDto, z.ZodTypeDef, unknown> =
+        z.object({
+            subscribers: z.array(z.string()),
+        });
+
+    export type Outbound = {
+        subscribers: Array<string>;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, RemoveSubscribersRequestDto> =
+        z.object({
+            subscribers: z.array(z.string()),
+        });
+}

package/src/models/components/renameorganizationdto.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type RenameOrganizationDto = {
+    name: string;
+};
+
+/** @internal */
+export namespace RenameOrganizationDto$ {
+    export const inboundSchema: z.ZodType<RenameOrganizationDto, z.ZodTypeDef, unknown> = z.object({
+        name: z.string(),
+    });
+
+    export type Outbound = {
+        name: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, RenameOrganizationDto> =
+        z.object({
+            name: z.string(),
+        });
+}

package/src/models/components/renametopicrequestdto.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type RenameTopicRequestDto = {
+    /**
+     * User defined custom name and provided by the user to rename the topic.
+     */
+    name: string;
+};
+
+/** @internal */
+export namespace RenameTopicRequestDto$ {
+    export const inboundSchema: z.ZodType<RenameTopicRequestDto, z.ZodTypeDef, unknown> = z.object({
+        name: z.string(),
+    });
+
+    export type Outbound = {
+        name: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, RenameTopicRequestDto> =
+        z.object({
+            name: z.string(),
+        });
+}

package/src/models/components/renametopicresponsedto.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import * as z from "zod";
+
+export type RenameTopicResponseDto = {
+    environmentId: string;
+    id?: string | undefined;
+    organizationId: string;
+    key: string;
+    name: string;
+    subscribers: Array<string>;
+};
+
+/** @internal */
+export namespace RenameTopicResponseDto$ {
+    export const inboundSchema: z.ZodType<RenameTopicResponseDto, 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",
+            });
+        });
+
+    export type Outbound = {
+        _environmentId: string;
+        _id?: string | undefined;
+        _organizationId: string;
+        key: string;
+        name: string;
+        subscribers: Array<string>;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, RenameTopicResponseDto> = 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",
+            });
+        });
+}

package/src/models/components/security.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import * as z from "zod";
+
+export type Security = {
+    apiKey?: string | undefined;
+};
+
+/** @internal */
+export namespace Security$ {
+    export const inboundSchema: z.ZodType<Security, z.ZodTypeDef, unknown> = z
+        .object({
+            "api-key": z.string().optional(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                "api-key": "apiKey",
+            });
+        });
+
+    export type Outbound = {
+        "api-key"?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, Security> = z
+        .object({
+            apiKey: z.string().optional(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                apiKey: "api-key",
+            });
+        });
+}

package/src/models/components/stepfilter.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types";
+import { FieldFilterPart, FieldFilterPart$ } from "./fieldfilterpart";
+import * as z from "zod";
+
+export const StepFilterType = {
+    Boolean: "BOOLEAN",
+    Text: "TEXT",
+    Date: "DATE",
+    Number: "NUMBER",
+    Statement: "STATEMENT",
+    List: "LIST",
+    MultiList: "MULTI_LIST",
+    Group: "GROUP",
+} as const;
+export type StepFilterType = ClosedEnum<typeof StepFilterType>;
+
+export const Value = {
+    And: "AND",
+    Or: "OR",
+} as const;
+export type Value = ClosedEnum<typeof Value>;
+
+export type StepFilter = {
+    children: Array<FieldFilterPart>;
+    isNegated: boolean;
+    type: StepFilterType;
+    value: Value;
+};
+
+/** @internal */
+export namespace StepFilterType$ {
+    export const inboundSchema = z.nativeEnum(StepFilterType);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace Value$ {
+    export const inboundSchema = z.nativeEnum(Value);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace StepFilter$ {
+    export const inboundSchema: z.ZodType<StepFilter, z.ZodTypeDef, unknown> = z.object({
+        children: z.array(FieldFilterPart$.inboundSchema),
+        isNegated: z.boolean(),
+        type: StepFilterType$.inboundSchema,
+        value: Value$.inboundSchema,
+    });
+
+    export type Outbound = {
+        children: Array<FieldFilterPart$.Outbound>;
+        isNegated: boolean;
+        type: string;
+        value: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, StepFilter> = z.object({
+        children: z.array(FieldFilterPart$.outboundSchema),
+        isNegated: z.boolean(),
+        type: StepFilterType$.outboundSchema,
+        value: Value$.outboundSchema,
+    });
+}

package/src/models/components/subscriberchanneldto.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { ChannelCredentialsDto, ChannelCredentialsDto$ } from "./channelcredentialsdto";
+import * as z from "zod";
+
+export type SubscriberChannelDtoProviderId = {};
+
+export type SubscriberChannelDto = {
+    credentials: ChannelCredentialsDto;
+    integrationIdentifier?: string | undefined;
+    providerId: SubscriberChannelDtoProviderId;
+};
+
+/** @internal */
+export namespace SubscriberChannelDtoProviderId$ {
+    export const inboundSchema: z.ZodType<SubscriberChannelDtoProviderId, z.ZodTypeDef, unknown> =
+        z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, SubscriberChannelDtoProviderId> =
+        z.object({});
+}
+
+/** @internal */
+export namespace SubscriberChannelDto$ {
+    export const inboundSchema: z.ZodType<SubscriberChannelDto, z.ZodTypeDef, unknown> = z.object({
+        credentials: ChannelCredentialsDto$.inboundSchema,
+        integrationIdentifier: z.string().optional(),
+        providerId: z.lazy(() => SubscriberChannelDtoProviderId$.inboundSchema),
+    });
+
+    export type Outbound = {
+        credentials: ChannelCredentialsDto$.Outbound;
+        integrationIdentifier?: string | undefined;
+        providerId: SubscriberChannelDtoProviderId$.Outbound;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, SubscriberChannelDto> = z.object(
+        {
+            credentials: ChannelCredentialsDto$.outboundSchema,
+            integrationIdentifier: z.string().optional(),
+            providerId: z.lazy(() => SubscriberChannelDtoProviderId$.outboundSchema),
+        }
+    );
+}

package/src/models/components/subscriberpayloaddto.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { SubscriberChannelDto, SubscriberChannelDto$ } from "./subscriberchanneldto";
+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<SubscriberChannelDto> | 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 namespace SubscriberPayloadDtoData$ {
+    export const inboundSchema: z.ZodType<SubscriberPayloadDtoData, z.ZodTypeDef, unknown> =
+        z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, SubscriberPayloadDtoData> =
+        z.object({});
+}
+
+/** @internal */
+export namespace SubscriberPayloadDto$ {
+    export const inboundSchema: z.ZodType<SubscriberPayloadDto, z.ZodTypeDef, unknown> = z.object({
+        avatar: z.string().optional(),
+        channels: z.array(SubscriberChannelDto$.inboundSchema).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(),
+    });
+
+    export type Outbound = {
+        avatar?: string | undefined;
+        channels?: Array<SubscriberChannelDto$.Outbound> | undefined;
+        data?: SubscriberPayloadDtoData$.Outbound | undefined;
+        email?: string | undefined;
+        firstName?: string | undefined;
+        lastName?: string | undefined;
+        locale?: string | undefined;
+        phone?: string | undefined;
+        subscriberId: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, SubscriberPayloadDto> = z.object(
+        {
+            avatar: z.string().optional(),
+            channels: z.array(SubscriberChannelDto$.outboundSchema).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(),
+        }
+    );
+}

package/src/models/components/subscriberresponsedto.ts

@@ -0,0 +1,117 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import { ChannelSettings, ChannelSettings$ } from "./channelsettings";
+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 namespace SubscriberResponseDto$ {
+    export const 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",
+            });
+        });
+
+    export type 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;
+    };
+
+    export const outboundSchema: z.ZodType<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",
+            });
+        });
+}

package/src/models/components/templateresponse.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+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 namespace TemplateResponse$ {
+    export const 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",
+            });
+        });
+
+    export type Outbound = {
+        _id: string;
+        critical: boolean;
+        name: string;
+        triggers: Array<string>;
+    };
+
+    export const outboundSchema: z.ZodType<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",
+            });
+        });
+}

package/src/models/components/tenantpayloaddto.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). 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 namespace TenantPayloadDtoData$ {
+    export const inboundSchema: z.ZodType<TenantPayloadDtoData, z.ZodTypeDef, unknown> = z.object(
+        {}
+    );
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, TenantPayloadDtoData> = z.object(
+        {}
+    );
+}
+
+/** @internal */
+export namespace TenantPayloadDto$ {
+    export const inboundSchema: z.ZodType<TenantPayloadDto, z.ZodTypeDef, unknown> = z.object({
+        data: z.lazy(() => TenantPayloadDtoData$.inboundSchema).optional(),
+        identifier: z.string().optional(),
+        name: z.string().optional(),
+    });
+
+    export type Outbound = {
+        data?: TenantPayloadDtoData$.Outbound | undefined;
+        identifier?: string | undefined;
+        name?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, TenantPayloadDto> = z.object({
+        data: z.lazy(() => TenantPayloadDtoData$.outboundSchema).optional(),
+        identifier: z.string().optional(),
+        name: z.string().optional(),
+    });
+}