@novu/api 0.0.1-alpha.6

package/src/models/components/activitygraphstatesresponse.ts

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import { ClosedEnum } from "../../types";
+import * as z from "zod";
+
+export const Channels = {
+    InApp: "in_app",
+    Email: "email",
+    Sms: "sms",
+    Chat: "chat",
+    Push: "push",
+} as const;
+export type Channels = ClosedEnum<typeof Channels>;
+
+export type ActivityGraphStatesResponse = {
+    id: string;
+    channels: Array<Channels>;
+    count: number;
+    templates: Array<string>;
+};
+
+/** @internal */
+export namespace Channels$ {
+    export const inboundSchema = z.nativeEnum(Channels);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace ActivityGraphStatesResponse$ {
+    export const inboundSchema: z.ZodType<ActivityGraphStatesResponse, z.ZodTypeDef, unknown> = z
+        .object({
+            _id: z.string(),
+            channels: z.array(Channels$.inboundSchema),
+            count: z.number(),
+            templates: z.array(z.string()),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                _id: "id",
+            });
+        });
+
+    export type Outbound = {
+        _id: string;
+        channels: Array<string>;
+        count: number;
+        templates: Array<string>;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, ActivityGraphStatesResponse> = z
+        .object({
+            id: z.string(),
+            channels: z.array(Channels$.outboundSchema),
+            count: z.number(),
+            templates: z.array(z.string()),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                id: "_id",
+            });
+        });
+}

package/src/models/components/activitynotificationexecutiondetailresponsedto.ts

@@ -0,0 +1,121 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import { ClosedEnum } from "../../types";
+import * as z from "zod";
+
+export type ProviderId = {};
+
+export const Source = {
+    Credentials: "Credentials",
+    Internal: "Internal",
+    Payload: "Payload",
+    Webhook: "Webhook",
+} as const;
+export type Source = ClosedEnum<typeof Source>;
+
+export const Status = {
+    Success: "Success",
+    Warning: "Warning",
+    Failed: "Failed",
+    Pending: "Pending",
+    Queued: "Queued",
+    ReadConfirmation: "ReadConfirmation",
+} as const;
+export type Status = ClosedEnum<typeof Status>;
+
+export type ActivityNotificationExecutionDetailResponseDto = {
+    id: string;
+    jobId: string;
+    detail: string;
+    isRetry: boolean;
+    isTest: boolean;
+    providerId: ProviderId;
+    raw?: string | undefined;
+    source: Source;
+    status: Status;
+};
+
+/** @internal */
+export namespace ProviderId$ {
+    export const inboundSchema: z.ZodType<ProviderId, z.ZodTypeDef, unknown> = z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, ProviderId> = z.object({});
+}
+
+/** @internal */
+export namespace Source$ {
+    export const inboundSchema = z.nativeEnum(Source);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace Status$ {
+    export const inboundSchema = z.nativeEnum(Status);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace ActivityNotificationExecutionDetailResponseDto$ {
+    export const inboundSchema: z.ZodType<
+        ActivityNotificationExecutionDetailResponseDto,
+        z.ZodTypeDef,
+        unknown
+    > = z
+        .object({
+            _id: z.string(),
+            _jobId: z.string(),
+            detail: z.string(),
+            isRetry: z.boolean(),
+            isTest: z.boolean(),
+            providerId: z.lazy(() => ProviderId$.inboundSchema),
+            raw: z.string().optional(),
+            source: Source$.inboundSchema,
+            status: Status$.inboundSchema,
+        })
+        .transform((v) => {
+            return remap$(v, {
+                _id: "id",
+                _jobId: "jobId",
+            });
+        });
+
+    export type Outbound = {
+        _id: string;
+        _jobId: string;
+        detail: string;
+        isRetry: boolean;
+        isTest: boolean;
+        providerId: ProviderId$.Outbound;
+        raw?: string | undefined;
+        source: string;
+        status: string;
+    };
+
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        ActivityNotificationExecutionDetailResponseDto
+    > = z
+        .object({
+            id: z.string(),
+            jobId: z.string(),
+            detail: z.string(),
+            isRetry: z.boolean(),
+            isTest: z.boolean(),
+            providerId: z.lazy(() => ProviderId$.outboundSchema),
+            raw: z.string().optional(),
+            source: Source$.outboundSchema,
+            status: Status$.outboundSchema,
+        })
+        .transform((v) => {
+            return remap$(v, {
+                id: "_id",
+                jobId: "_jobId",
+            });
+        });
+}

package/src/models/components/activitynotificationjobresponsedto.ts

@@ -0,0 +1,126 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import {
+    ActivityNotificationExecutionDetailResponseDto,
+    ActivityNotificationExecutionDetailResponseDto$,
+} from "./activitynotificationexecutiondetailresponsedto";
+import {
+    ActivityNotificationStepResponseDto,
+    ActivityNotificationStepResponseDto$,
+} from "./activitynotificationstepresponsedto";
+import * as z from "zod";
+
+export type Digest = {};
+
+export type Payload = {};
+
+export type ActivityNotificationJobResponseDtoProviderId = {};
+
+export type ActivityNotificationJobResponseDto = {
+    id: string;
+    digest?: Digest | undefined;
+    executionDetails: Array<ActivityNotificationExecutionDetailResponseDto>;
+    payload?: Payload | undefined;
+    providerId: ActivityNotificationJobResponseDtoProviderId;
+    status: string;
+    step: ActivityNotificationStepResponseDto;
+    type: string;
+};
+
+/** @internal */
+export namespace Digest$ {
+    export const inboundSchema: z.ZodType<Digest, z.ZodTypeDef, unknown> = z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, Digest> = z.object({});
+}
+
+/** @internal */
+export namespace Payload$ {
+    export const inboundSchema: z.ZodType<Payload, z.ZodTypeDef, unknown> = z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, Payload> = z.object({});
+}
+
+/** @internal */
+export namespace ActivityNotificationJobResponseDtoProviderId$ {
+    export const inboundSchema: z.ZodType<
+        ActivityNotificationJobResponseDtoProviderId,
+        z.ZodTypeDef,
+        unknown
+    > = z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        ActivityNotificationJobResponseDtoProviderId
+    > = z.object({});
+}
+
+/** @internal */
+export namespace ActivityNotificationJobResponseDto$ {
+    export const inboundSchema: z.ZodType<
+        ActivityNotificationJobResponseDto,
+        z.ZodTypeDef,
+        unknown
+    > = z
+        .object({
+            _id: z.string(),
+            digest: z.lazy(() => Digest$.inboundSchema).optional(),
+            executionDetails: z.array(
+                ActivityNotificationExecutionDetailResponseDto$.inboundSchema
+            ),
+            payload: z.lazy(() => Payload$.inboundSchema).optional(),
+            providerId: z.lazy(() => ActivityNotificationJobResponseDtoProviderId$.inboundSchema),
+            status: z.string(),
+            step: ActivityNotificationStepResponseDto$.inboundSchema,
+            type: z.string(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                _id: "id",
+            });
+        });
+
+    export type Outbound = {
+        _id: string;
+        digest?: Digest$.Outbound | undefined;
+        executionDetails: Array<ActivityNotificationExecutionDetailResponseDto$.Outbound>;
+        payload?: Payload$.Outbound | undefined;
+        providerId: ActivityNotificationJobResponseDtoProviderId$.Outbound;
+        status: string;
+        step: ActivityNotificationStepResponseDto$.Outbound;
+        type: string;
+    };
+
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        ActivityNotificationJobResponseDto
+    > = z
+        .object({
+            id: z.string(),
+            digest: z.lazy(() => Digest$.outboundSchema).optional(),
+            executionDetails: z.array(
+                ActivityNotificationExecutionDetailResponseDto$.outboundSchema
+            ),
+            payload: z.lazy(() => Payload$.outboundSchema).optional(),
+            providerId: z.lazy(() => ActivityNotificationJobResponseDtoProviderId$.outboundSchema),
+            status: z.string(),
+            step: ActivityNotificationStepResponseDto$.outboundSchema,
+            type: z.string(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                id: "_id",
+            });
+        });
+}

package/src/models/components/activitynotificationresponsedto.ts

@@ -0,0 +1,112 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import { ClosedEnum } from "../../types";
+import {
+    ActivityNotificationJobResponseDto,
+    ActivityNotificationJobResponseDto$,
+} from "./activitynotificationjobresponsedto";
+import {
+    ActivityNotificationSubscriberResponseDto,
+    ActivityNotificationSubscriberResponseDto$,
+} from "./activitynotificationsubscriberresponsedto";
+import {
+    ActivityNotificationTemplateResponseDto,
+    ActivityNotificationTemplateResponseDto$,
+} from "./activitynotificationtemplateresponsedto";
+import * as z from "zod";
+
+export const ActivityNotificationResponseDtoChannels = {
+    InApp: "in_app",
+    Email: "email",
+    Sms: "sms",
+    Chat: "chat",
+    Push: "push",
+    Digest: "digest",
+    Trigger: "trigger",
+    Delay: "delay",
+    Custom: "custom",
+} as const;
+export type ActivityNotificationResponseDtoChannels = ClosedEnum<
+    typeof ActivityNotificationResponseDtoChannels
+>;
+
+export type ActivityNotificationResponseDto = {
+    environmentId: string;
+    id?: string | undefined;
+    organizationId: string;
+    channels?: ActivityNotificationResponseDtoChannels | undefined;
+    createdAt?: string | undefined;
+    jobs?: Array<ActivityNotificationJobResponseDto> | undefined;
+    subscriber?: ActivityNotificationSubscriberResponseDto | undefined;
+    template?: ActivityNotificationTemplateResponseDto | undefined;
+    transactionId: string;
+};
+
+/** @internal */
+export namespace ActivityNotificationResponseDtoChannels$ {
+    export const inboundSchema = z.nativeEnum(ActivityNotificationResponseDtoChannels);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace ActivityNotificationResponseDto$ {
+    export const inboundSchema: z.ZodType<ActivityNotificationResponseDto, z.ZodTypeDef, unknown> =
+        z
+            .object({
+                _environmentId: z.string(),
+                _id: z.string().optional(),
+                _organizationId: z.string(),
+                channels: ActivityNotificationResponseDtoChannels$.inboundSchema.optional(),
+                createdAt: z.string().optional(),
+                jobs: z.array(ActivityNotificationJobResponseDto$.inboundSchema).optional(),
+                subscriber: ActivityNotificationSubscriberResponseDto$.inboundSchema.optional(),
+                template: ActivityNotificationTemplateResponseDto$.inboundSchema.optional(),
+                transactionId: z.string(),
+            })
+            .transform((v) => {
+                return remap$(v, {
+                    _environmentId: "environmentId",
+                    _id: "id",
+                    _organizationId: "organizationId",
+                });
+            });
+
+    export type Outbound = {
+        _environmentId: string;
+        _id?: string | undefined;
+        _organizationId: string;
+        channels?: string | undefined;
+        createdAt?: string | undefined;
+        jobs?: Array<ActivityNotificationJobResponseDto$.Outbound> | undefined;
+        subscriber?: ActivityNotificationSubscriberResponseDto$.Outbound | undefined;
+        template?: ActivityNotificationTemplateResponseDto$.Outbound | undefined;
+        transactionId: string;
+    };
+
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        ActivityNotificationResponseDto
+    > = z
+        .object({
+            environmentId: z.string(),
+            id: z.string().optional(),
+            organizationId: z.string(),
+            channels: ActivityNotificationResponseDtoChannels$.outboundSchema.optional(),
+            createdAt: z.string().optional(),
+            jobs: z.array(ActivityNotificationJobResponseDto$.outboundSchema).optional(),
+            subscriber: ActivityNotificationSubscriberResponseDto$.outboundSchema.optional(),
+            template: ActivityNotificationTemplateResponseDto$.outboundSchema.optional(),
+            transactionId: z.string(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                environmentId: "_environmentId",
+                id: "_id",
+                organizationId: "_organizationId",
+            });
+        });
+}

package/src/models/components/activitynotificationstepresponsedto.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import { MessageTemplateDto, MessageTemplateDto$ } from "./messagetemplatedto";
+import { StepFilter, StepFilter$ } from "./stepfilter";
+import * as z from "zod";
+
+export type ActivityNotificationStepResponseDto = {
+    id: string;
+    active: boolean;
+    filters: StepFilter;
+    template?: MessageTemplateDto | undefined;
+};
+
+/** @internal */
+export namespace ActivityNotificationStepResponseDto$ {
+    export const inboundSchema: z.ZodType<
+        ActivityNotificationStepResponseDto,
+        z.ZodTypeDef,
+        unknown
+    > = z
+        .object({
+            _id: z.string(),
+            active: z.boolean(),
+            filters: StepFilter$.inboundSchema,
+            template: MessageTemplateDto$.inboundSchema.optional(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                _id: "id",
+            });
+        });
+
+    export type Outbound = {
+        _id: string;
+        active: boolean;
+        filters: StepFilter$.Outbound;
+        template?: MessageTemplateDto$.Outbound | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        ActivityNotificationStepResponseDto
+    > = z
+        .object({
+            id: z.string(),
+            active: z.boolean(),
+            filters: StepFilter$.outboundSchema,
+            template: MessageTemplateDto$.outboundSchema.optional(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                id: "_id",
+            });
+        });
+}

package/src/models/components/activitynotificationsubscriberresponsedto.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 ActivityNotificationSubscriberResponseDto = {
+    id: string;
+    email?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    phone?: string | undefined;
+};
+
+/** @internal */
+export namespace ActivityNotificationSubscriberResponseDto$ {
+    export const inboundSchema: z.ZodType<
+        ActivityNotificationSubscriberResponseDto,
+        z.ZodTypeDef,
+        unknown
+    > = z
+        .object({
+            _id: z.string(),
+            email: z.string().optional(),
+            firstName: z.string().optional(),
+            lastName: z.string().optional(),
+            phone: z.string().optional(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                _id: "id",
+            });
+        });
+
+    export type Outbound = {
+        _id: string;
+        email?: string | undefined;
+        firstName?: string | undefined;
+        lastName?: string | undefined;
+        phone?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        ActivityNotificationSubscriberResponseDto
+    > = z
+        .object({
+            id: z.string(),
+            email: z.string().optional(),
+            firstName: z.string().optional(),
+            lastName: z.string().optional(),
+            phone: z.string().optional(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                id: "_id",
+            });
+        });
+}

package/src/models/components/activitynotificationtemplateresponsedto.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import { NotificationTrigger, NotificationTrigger$ } from "./notificationtrigger";
+import * as z from "zod";
+
+export type ActivityNotificationTemplateResponseDto = {
+    id?: string | undefined;
+    name: string;
+    triggers: Array<NotificationTrigger>;
+};
+
+/** @internal */
+export namespace ActivityNotificationTemplateResponseDto$ {
+    export const inboundSchema: z.ZodType<
+        ActivityNotificationTemplateResponseDto,
+        z.ZodTypeDef,
+        unknown
+    > = z
+        .object({
+            _id: z.string().optional(),
+            name: z.string(),
+            triggers: z.array(NotificationTrigger$.inboundSchema),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                _id: "id",
+            });
+        });
+
+    export type Outbound = {
+        _id?: string | undefined;
+        name: string;
+        triggers: Array<NotificationTrigger$.Outbound>;
+    };
+
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        ActivityNotificationTemplateResponseDto
+    > = z
+        .object({
+            id: z.string().optional(),
+            name: z.string(),
+            triggers: z.array(NotificationTrigger$.outboundSchema),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                id: "_id",
+            });
+        });
+}

package/src/models/components/activitystatsresponsedto.ts

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

package/src/models/components/addsubscribersrequestdto.ts

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

package/src/models/components/apikey.ts

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