@novu/api 0.0.1-alpha.6

package/src/models/components/bulkapplychangedto.ts

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

package/src/models/components/bulksubscribercreatedto.ts

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

package/src/models/components/bulktriggereventdto.ts

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

package/src/models/components/changeresponsedto.ts

@@ -0,0 +1,113 @@
+/*
+ * 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 Change = {};
+
+export const Type = {
+    Feed: "Feed",
+    MessageTemplate: "MessageTemplate",
+    Layout: "Layout",
+    DefaultLayout: "DefaultLayout",
+    NotificationTemplate: "NotificationTemplate",
+    NotificationGroup: "NotificationGroup",
+    TranslationGroup: "TranslationGroup",
+    Translation: "Translation",
+} as const;
+export type Type = ClosedEnum<typeof Type>;
+
+export type ChangeResponseDto = {
+    creatorId: string;
+    entityId: string;
+    environmentId: string;
+    id?: string | undefined;
+    organizationId: string;
+    parentId?: string | undefined;
+    change: Change;
+    createdAt: string;
+    enabled: boolean;
+    type: Type;
+};
+
+/** @internal */
+export namespace Change$ {
+    export const inboundSchema: z.ZodType<Change, z.ZodTypeDef, unknown> = z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, Change> = z.object({});
+}
+
+/** @internal */
+export namespace Type$ {
+    export const inboundSchema = z.nativeEnum(Type);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace ChangeResponseDto$ {
+    export const inboundSchema: z.ZodType<ChangeResponseDto, z.ZodTypeDef, unknown> = z
+        .object({
+            _creatorId: z.string(),
+            _entityId: z.string(),
+            _environmentId: z.string(),
+            _id: z.string().optional(),
+            _organizationId: z.string(),
+            _parentId: z.string().optional(),
+            change: z.lazy(() => Change$.inboundSchema),
+            createdAt: z.string(),
+            enabled: z.boolean(),
+            type: Type$.inboundSchema,
+        })
+        .transform((v) => {
+            return remap$(v, {
+                _creatorId: "creatorId",
+                _entityId: "entityId",
+                _environmentId: "environmentId",
+                _id: "id",
+                _organizationId: "organizationId",
+                _parentId: "parentId",
+            });
+        });
+
+    export type Outbound = {
+        _creatorId: string;
+        _entityId: string;
+        _environmentId: string;
+        _id?: string | undefined;
+        _organizationId: string;
+        _parentId?: string | undefined;
+        change: Change$.Outbound;
+        createdAt: string;
+        enabled: boolean;
+        type: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, ChangeResponseDto> = z
+        .object({
+            creatorId: z.string(),
+            entityId: z.string(),
+            environmentId: z.string(),
+            id: z.string().optional(),
+            organizationId: z.string(),
+            parentId: z.string().optional(),
+            change: z.lazy(() => Change$.outboundSchema),
+            createdAt: z.string(),
+            enabled: z.boolean(),
+            type: Type$.outboundSchema,
+        })
+        .transform((v) => {
+            return remap$(v, {
+                creatorId: "_creatorId",
+                entityId: "_entityId",
+                environmentId: "_environmentId",
+                id: "_id",
+                organizationId: "_organizationId",
+                parentId: "_parentId",
+            });
+        });
+}

package/src/models/components/changesresponsedto.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { ChangeResponseDto, ChangeResponseDto$ } from "./changeresponsedto";
+import * as z from "zod";
+
+export type ChangesResponseDto = {
+    data: Array<ChangeResponseDto>;
+    page: number;
+    pageSize: number;
+    totalCount: number;
+};
+
+/** @internal */
+export namespace ChangesResponseDto$ {
+    export const inboundSchema: z.ZodType<ChangesResponseDto, z.ZodTypeDef, unknown> = z.object({
+        data: z.array(ChangeResponseDto$.inboundSchema),
+        page: z.number(),
+        pageSize: z.number(),
+        totalCount: z.number(),
+    });
+
+    export type Outbound = {
+        data: Array<ChangeResponseDto$.Outbound>;
+        page: number;
+        pageSize: number;
+        totalCount: number;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, ChangesResponseDto> = z.object({
+        data: z.array(ChangeResponseDto$.outboundSchema),
+        page: z.number(),
+        pageSize: z.number(),
+        totalCount: z.number(),
+    });
+}

package/src/models/components/changeworkflowstatusrequestdto.ts

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

package/src/models/components/channelcredentials.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type ChannelCredentials = {
+    /**
+     * alert_uid for grafana on-call webhook payload
+     */
+    alertUid?: string | undefined;
+    /**
+     * Channel specification for Mattermost chat notifications
+     */
+    channel?: string | undefined;
+    /**
+     * Contains an array of the subscriber device tokens for a given provider. Used on Push integrations
+     */
+    deviceTokens?: Array<string> | undefined;
+    /**
+     * link_to_upstream_details property fo grafana on call webhook
+     */
+    externalUrl?: string | undefined;
+    /**
+     * image_url property fo grafana on call webhook
+     */
+    imageUrl?: string | undefined;
+    /**
+     * state property fo grafana on call webhook
+     */
+    state?: string | undefined;
+    /**
+     * title to be used with grafana on call webhook
+     */
+    title?: string | undefined;
+    /**
+     * Webhook url used by chat app integrations. The webhook should be obtained from the chat app provider.
+     */
+    webhookUrl: string;
+};
+
+/** @internal */
+export namespace ChannelCredentials$ {
+    export const inboundSchema: z.ZodType<ChannelCredentials, z.ZodTypeDef, unknown> = z.object({
+        alertUid: z.string().optional(),
+        channel: z.string().optional(),
+        deviceTokens: z.array(z.string()).optional(),
+        externalUrl: z.string().optional(),
+        imageUrl: z.string().optional(),
+        state: z.string().optional(),
+        title: z.string().optional(),
+        webhookUrl: z.string(),
+    });
+
+    export type Outbound = {
+        alertUid?: string | undefined;
+        channel?: string | undefined;
+        deviceTokens?: Array<string> | undefined;
+        externalUrl?: string | undefined;
+        imageUrl?: string | undefined;
+        state?: string | undefined;
+        title?: string | undefined;
+        webhookUrl: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, ChannelCredentials> = z.object({
+        alertUid: z.string().optional(),
+        channel: z.string().optional(),
+        deviceTokens: z.array(z.string()).optional(),
+        externalUrl: z.string().optional(),
+        imageUrl: z.string().optional(),
+        state: z.string().optional(),
+        title: z.string().optional(),
+        webhookUrl: z.string(),
+    });
+}

package/src/models/components/channelcredentialsdto.ts

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

package/src/models/components/channelpreference.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types";
+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 namespace ChannelPreferenceType$ {
+    export const inboundSchema = z.nativeEnum(ChannelPreferenceType);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace ChannelPreference$ {
+    export const inboundSchema: z.ZodType<ChannelPreference, z.ZodTypeDef, unknown> = z.object({
+        enabled: z.boolean(),
+        type: ChannelPreferenceType$.inboundSchema,
+    });
+
+    export type Outbound = {
+        enabled: boolean;
+        type: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, ChannelPreference> = z.object({
+        enabled: z.boolean(),
+        type: ChannelPreferenceType$.outboundSchema,
+    });
+}

package/src/models/components/channelsettings.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import { ClosedEnum } from "../../types";
+import { ChannelCredentials, ChannelCredentials$ } from "./channelcredentials";
+import * as z from "zod";
+
+/**
+ * The provider identifier for the credentials
+ */
+export const ChannelSettingsProviderId = {
+    Slack: "slack",
+    Discord: "discord",
+    Msteams: "msteams",
+    Mattermost: "mattermost",
+    Ryver: "ryver",
+    Zulip: "zulip",
+    GrafanaOnCall: "grafana-on-call",
+    Getstream: "getstream",
+    RocketChat: "rocket-chat",
+    WhatsappBusiness: "whatsapp-business",
+    Fcm: "fcm",
+    Apns: "apns",
+    Expo: "expo",
+    OneSignal: "one-signal",
+    Pushpad: "pushpad",
+    PushWebhook: "push-webhook",
+    PusherBeams: "pusher-beams",
+} as const;
+/**
+ * The provider identifier for the credentials
+ */
+export type ChannelSettingsProviderId = ClosedEnum<typeof ChannelSettingsProviderId>;
+
+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: ChannelSettingsProviderId;
+};
+
+/** @internal */
+export namespace ChannelSettingsProviderId$ {
+    export const inboundSchema = z.nativeEnum(ChannelSettingsProviderId);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace ChannelSettings$ {
+    export const inboundSchema: z.ZodType<ChannelSettings, z.ZodTypeDef, unknown> = z
+        .object({
+            _integrationId: z.string(),
+            credentials: ChannelCredentials$.inboundSchema,
+            integrationIdentifier: z.string().optional(),
+            providerId: ChannelSettingsProviderId$.inboundSchema,
+        })
+        .transform((v) => {
+            return remap$(v, {
+                _integrationId: "integrationId",
+            });
+        });
+
+    export type Outbound = {
+        _integrationId: string;
+        credentials: ChannelCredentials$.Outbound;
+        integrationIdentifier?: string | undefined;
+        providerId: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, ChannelSettings> = z
+        .object({
+            integrationId: z.string(),
+            credentials: ChannelCredentials$.outboundSchema,
+            integrationIdentifier: z.string().optional(),
+            providerId: ChannelSettingsProviderId$.outboundSchema,
+        })
+        .transform((v) => {
+            return remap$(v, {
+                integrationId: "_integrationId",
+            });
+        });
+}

package/src/models/components/createfeedrequestdto.ts

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

package/src/models/components/createintegrationrequestdto.ts

@@ -0,0 +1,90 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import { ClosedEnum } from "../../types";
+import { CredentialsDto, CredentialsDto$ } from "./credentialsdto";
+import { StepFilter, StepFilter$ } from "./stepfilter";
+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 namespace Channel$ {
+    export const inboundSchema = z.nativeEnum(Channel);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace CreateIntegrationRequestDto$ {
+    export const 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",
+            });
+        });
+
+    export type 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;
+    };
+
+    export const outboundSchema: z.ZodType<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",
+            });
+        });
+}

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