@novu/api 0.0.1-alpha.6

package/src/models/components/updatesubscriberpreferencerequestdto.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { ChannelPreference, ChannelPreference$ } from "./channelpreference";
+import * as z from "zod";
+
+export type UpdateSubscriberPreferenceRequestDto = {
+    /**
+     * The subscriber preferences for every ChannelTypeEnum for the workflow assigned.
+     */
+    channel?: ChannelPreference | undefined;
+    /**
+     * Sets if the workflow is fully enabled for all channels or not for the subscriber.
+     */
+    enabled?: boolean | undefined;
+};
+
+/** @internal */
+export namespace UpdateSubscriberPreferenceRequestDto$ {
+    export const inboundSchema: z.ZodType<
+        UpdateSubscriberPreferenceRequestDto,
+        z.ZodTypeDef,
+        unknown
+    > = z.object({
+        channel: ChannelPreference$.inboundSchema.optional(),
+        enabled: z.boolean().optional(),
+    });
+
+    export type Outbound = {
+        channel?: ChannelPreference$.Outbound | undefined;
+        enabled?: boolean | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        UpdateSubscriberPreferenceRequestDto
+    > = z.object({
+        channel: ChannelPreference$.outboundSchema.optional(),
+        enabled: z.boolean().optional(),
+    });
+}

package/src/models/components/updatesubscriberpreferenceresponsedto.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { Preference, Preference$ } from "./preference";
+import { TemplateResponse, TemplateResponse$ } from "./templateresponse";
+import * as z from "zod";
+
+export type UpdateSubscriberPreferenceResponseDto = {
+    /**
+     * The preferences of the subscriber regarding the related workflow
+     */
+    preference: Preference;
+    /**
+     * The workflow information and if it is critical or not
+     */
+    template: TemplateResponse;
+};
+
+/** @internal */
+export namespace UpdateSubscriberPreferenceResponseDto$ {
+    export const inboundSchema: z.ZodType<
+        UpdateSubscriberPreferenceResponseDto,
+        z.ZodTypeDef,
+        unknown
+    > = z.object({
+        preference: Preference$.inboundSchema,
+        template: TemplateResponse$.inboundSchema,
+    });
+
+    export type Outbound = {
+        preference: Preference$.Outbound;
+        template: TemplateResponse$.Outbound;
+    };
+
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        UpdateSubscriberPreferenceResponseDto
+    > = z.object({
+        preference: Preference$.outboundSchema,
+        template: TemplateResponse$.outboundSchema,
+    });
+}

package/src/models/components/updatesubscriberrequestdto.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type UpdateSubscriberRequestDtoData = {};
+
+export type UpdateSubscriberRequestDto = {
+    avatar?: string | undefined;
+    data?: UpdateSubscriberRequestDtoData | undefined;
+    email?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    locale?: string | undefined;
+    phone?: string | undefined;
+};
+
+/** @internal */
+export namespace UpdateSubscriberRequestDtoData$ {
+    export const inboundSchema: z.ZodType<UpdateSubscriberRequestDtoData, z.ZodTypeDef, unknown> =
+        z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UpdateSubscriberRequestDtoData> =
+        z.object({});
+}
+
+/** @internal */
+export namespace UpdateSubscriberRequestDto$ {
+    export const inboundSchema: z.ZodType<UpdateSubscriberRequestDto, z.ZodTypeDef, unknown> =
+        z.object({
+            avatar: z.string().optional(),
+            data: z.lazy(() => UpdateSubscriberRequestDtoData$.inboundSchema).optional(),
+            email: z.string().optional(),
+            firstName: z.string().optional(),
+            lastName: z.string().optional(),
+            locale: z.string().optional(),
+            phone: z.string().optional(),
+        });
+
+    export type Outbound = {
+        avatar?: string | undefined;
+        data?: UpdateSubscriberRequestDtoData$.Outbound | undefined;
+        email?: string | undefined;
+        firstName?: string | undefined;
+        lastName?: string | undefined;
+        locale?: string | undefined;
+        phone?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UpdateSubscriberRequestDto> =
+        z.object({
+            avatar: z.string().optional(),
+            data: z.lazy(() => UpdateSubscriberRequestDtoData$.outboundSchema).optional(),
+            email: z.string().optional(),
+            firstName: z.string().optional(),
+            lastName: z.string().optional(),
+            locale: z.string().optional(),
+            phone: z.string().optional(),
+        });
+}

package/src/models/components/updatetenantrequestdto.ts

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

package/src/models/components/updatetenantresponsedto.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import * as z from "zod";
+
+export type UpdateTenantResponseDtoData = {};
+
+export type UpdateTenantResponseDto = {
+    environmentId: string;
+    id: string;
+    createdAt: string;
+    data?: UpdateTenantResponseDtoData | undefined;
+    identifier: string;
+    name?: string | undefined;
+    updatedAt: string;
+};
+
+/** @internal */
+export namespace UpdateTenantResponseDtoData$ {
+    export const inboundSchema: z.ZodType<UpdateTenantResponseDtoData, z.ZodTypeDef, unknown> =
+        z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UpdateTenantResponseDtoData> =
+        z.object({});
+}
+
+/** @internal */
+export namespace UpdateTenantResponseDto$ {
+    export const inboundSchema: z.ZodType<UpdateTenantResponseDto, z.ZodTypeDef, unknown> = z
+        .object({
+            _environmentId: z.string(),
+            _id: z.string(),
+            createdAt: z.string(),
+            data: z.lazy(() => UpdateTenantResponseDtoData$.inboundSchema).optional(),
+            identifier: z.string(),
+            name: z.string().optional(),
+            updatedAt: z.string(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                _environmentId: "environmentId",
+                _id: "id",
+            });
+        });
+
+    export type Outbound = {
+        _environmentId: string;
+        _id: string;
+        createdAt: string;
+        data?: UpdateTenantResponseDtoData$.Outbound | undefined;
+        identifier: string;
+        name?: string | undefined;
+        updatedAt: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UpdateTenantResponseDto> = z
+        .object({
+            environmentId: z.string(),
+            id: z.string(),
+            createdAt: z.string(),
+            data: z.lazy(() => UpdateTenantResponseDtoData$.outboundSchema).optional(),
+            identifier: z.string(),
+            name: z.string().optional(),
+            updatedAt: z.string(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                environmentId: "_environmentId",
+                id: "_id",
+            });
+        });
+}

package/src/models/components/updateworkflowrequestdto.ts

@@ -0,0 +1,73 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { NotificationStep, NotificationStep$ } from "./notificationstep";
+import { PreferenceChannels, PreferenceChannels$ } from "./preferencechannels";
+import * as z from "zod";
+
+export type UpdateWorkflowRequestDtoData = {};
+
+export type UpdateWorkflowRequestDto = {
+    critical?: boolean | undefined;
+    data?: UpdateWorkflowRequestDtoData | undefined;
+    description?: string | undefined;
+    identifier?: string | undefined;
+    name: string;
+    notificationGroupId: string;
+    preferenceSettings?: PreferenceChannels | undefined;
+    steps?: Array<NotificationStep> | undefined;
+    tags?: Array<string> | undefined;
+};
+
+/** @internal */
+export namespace UpdateWorkflowRequestDtoData$ {
+    export const inboundSchema: z.ZodType<UpdateWorkflowRequestDtoData, z.ZodTypeDef, unknown> =
+        z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UpdateWorkflowRequestDtoData> =
+        z.object({});
+}
+
+/** @internal */
+export namespace UpdateWorkflowRequestDto$ {
+    export const inboundSchema: z.ZodType<UpdateWorkflowRequestDto, z.ZodTypeDef, unknown> =
+        z.object({
+            critical: z.boolean().optional(),
+            data: z.lazy(() => UpdateWorkflowRequestDtoData$.inboundSchema).optional(),
+            description: z.string().optional(),
+            identifier: z.string().optional(),
+            name: z.string(),
+            notificationGroupId: z.string(),
+            preferenceSettings: PreferenceChannels$.inboundSchema.optional(),
+            steps: z.array(NotificationStep$.inboundSchema).optional(),
+            tags: z.array(z.string()).optional(),
+        });
+
+    export type Outbound = {
+        critical?: boolean | undefined;
+        data?: UpdateWorkflowRequestDtoData$.Outbound | undefined;
+        description?: string | undefined;
+        identifier?: string | undefined;
+        name: string;
+        notificationGroupId: string;
+        preferenceSettings?: PreferenceChannels$.Outbound | undefined;
+        steps?: Array<NotificationStep$.Outbound> | undefined;
+        tags?: Array<string> | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UpdateWorkflowRequestDto> =
+        z.object({
+            critical: z.boolean().optional(),
+            data: z.lazy(() => UpdateWorkflowRequestDtoData$.outboundSchema).optional(),
+            description: z.string().optional(),
+            identifier: z.string().optional(),
+            name: z.string(),
+            notificationGroupId: z.string(),
+            preferenceSettings: PreferenceChannels$.outboundSchema.optional(),
+            steps: z.array(NotificationStep$.outboundSchema).optional(),
+            tags: z.array(z.string()).optional(),
+        });
+}

package/src/models/components/variablesresponsedto.ts

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

package/src/models/components/workflowresponse.ts

@@ -0,0 +1,163 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import { NotificationGroup, NotificationGroup$ } from "./notificationgroup";
+import { NotificationStep, NotificationStep$ } from "./notificationstep";
+import { NotificationTrigger, NotificationTrigger$ } from "./notificationtrigger";
+import { PreferenceChannels, PreferenceChannels$ } from "./preferencechannels";
+import * as z from "zod";
+
+export type WorkflowResponseData = {};
+
+export type WorkflowIntegrationStatus = {};
+
+export type WorkflowResponse = {
+    creatorId: string;
+    environmentId: string;
+    id?: string | undefined;
+    notificationGroupId: string;
+    organizationId: string;
+    parentId?: string | undefined;
+    active: boolean;
+    critical: boolean;
+    data?: WorkflowResponseData | undefined;
+    deleted: boolean;
+    deletedAt: string;
+    deletedBy: string;
+    description: string;
+    draft: boolean;
+    name: string;
+    notificationGroup?: NotificationGroup | undefined;
+    preferenceSettings: PreferenceChannels;
+    steps: Array<NotificationStep>;
+    tags: Array<string>;
+    triggers: Array<NotificationTrigger>;
+    workflowIntegrationStatus?: WorkflowIntegrationStatus | undefined;
+};
+
+/** @internal */
+export namespace WorkflowResponseData$ {
+    export const inboundSchema: z.ZodType<WorkflowResponseData, z.ZodTypeDef, unknown> = z.object(
+        {}
+    );
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, WorkflowResponseData> = z.object(
+        {}
+    );
+}
+
+/** @internal */
+export namespace WorkflowIntegrationStatus$ {
+    export const inboundSchema: z.ZodType<WorkflowIntegrationStatus, z.ZodTypeDef, unknown> =
+        z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, WorkflowIntegrationStatus> =
+        z.object({});
+}
+
+/** @internal */
+export namespace WorkflowResponse$ {
+    export const inboundSchema: z.ZodType<WorkflowResponse, z.ZodTypeDef, unknown> = z
+        .object({
+            _creatorId: z.string(),
+            _environmentId: z.string(),
+            _id: z.string().optional(),
+            _notificationGroupId: z.string(),
+            _organizationId: z.string(),
+            _parentId: z.string().optional(),
+            active: z.boolean(),
+            critical: z.boolean(),
+            data: z.lazy(() => WorkflowResponseData$.inboundSchema).optional(),
+            deleted: z.boolean(),
+            deletedAt: z.string(),
+            deletedBy: z.string(),
+            description: z.string(),
+            draft: z.boolean(),
+            name: z.string(),
+            notificationGroup: NotificationGroup$.inboundSchema.optional(),
+            preferenceSettings: PreferenceChannels$.inboundSchema,
+            steps: z.array(NotificationStep$.inboundSchema),
+            tags: z.array(z.string()),
+            triggers: z.array(NotificationTrigger$.inboundSchema),
+            workflowIntegrationStatus: z
+                .lazy(() => WorkflowIntegrationStatus$.inboundSchema)
+                .optional(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                _creatorId: "creatorId",
+                _environmentId: "environmentId",
+                _id: "id",
+                _notificationGroupId: "notificationGroupId",
+                _organizationId: "organizationId",
+                _parentId: "parentId",
+            });
+        });
+
+    export type Outbound = {
+        _creatorId: string;
+        _environmentId: string;
+        _id?: string | undefined;
+        _notificationGroupId: string;
+        _organizationId: string;
+        _parentId?: string | undefined;
+        active: boolean;
+        critical: boolean;
+        data?: WorkflowResponseData$.Outbound | undefined;
+        deleted: boolean;
+        deletedAt: string;
+        deletedBy: string;
+        description: string;
+        draft: boolean;
+        name: string;
+        notificationGroup?: NotificationGroup$.Outbound | undefined;
+        preferenceSettings: PreferenceChannels$.Outbound;
+        steps: Array<NotificationStep$.Outbound>;
+        tags: Array<string>;
+        triggers: Array<NotificationTrigger$.Outbound>;
+        workflowIntegrationStatus?: WorkflowIntegrationStatus$.Outbound | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, WorkflowResponse> = z
+        .object({
+            creatorId: z.string(),
+            environmentId: z.string(),
+            id: z.string().optional(),
+            notificationGroupId: z.string(),
+            organizationId: z.string(),
+            parentId: z.string().optional(),
+            active: z.boolean(),
+            critical: z.boolean(),
+            data: z.lazy(() => WorkflowResponseData$.outboundSchema).optional(),
+            deleted: z.boolean(),
+            deletedAt: z.string(),
+            deletedBy: z.string(),
+            description: z.string(),
+            draft: z.boolean(),
+            name: z.string(),
+            notificationGroup: NotificationGroup$.outboundSchema.optional(),
+            preferenceSettings: PreferenceChannels$.outboundSchema,
+            steps: z.array(NotificationStep$.outboundSchema),
+            tags: z.array(z.string()),
+            triggers: z.array(NotificationTrigger$.outboundSchema),
+            workflowIntegrationStatus: z
+                .lazy(() => WorkflowIntegrationStatus$.outboundSchema)
+                .optional(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                creatorId: "_creatorId",
+                environmentId: "_environmentId",
+                id: "_id",
+                notificationGroupId: "_notificationGroupId",
+                organizationId: "_organizationId",
+                parentId: "_parentId",
+            });
+        });
+}

package/src/models/components/workflowsresponsedto.ts

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

package/src/models/errors/index.ts

@@ -0,0 +1,6 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+export * from "./sdkerror";
+export * from "./sdkvalidationerror";

package/src/models/errors/sdkerror.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+export class SDKError extends Error {
+    public readonly statusCode: number;
+    public readonly contentType: string;
+
+    constructor(
+        message: string,
+        public readonly rawResponse: Response,
+        public readonly body: string = ""
+    ) {
+        const statusCode = rawResponse.status;
+        const contentType = rawResponse.headers.get("content-type") || "";
+        const bodyString = body.length > 0 ? `\n${body}` : "";
+
+        super(`${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`);
+
+        this.statusCode = statusCode;
+        this.contentType = contentType;
+
+        this.name = "SDKError";
+    }
+}