@novu/api 0.0.1-alpha.6

package/src/models/components/triggereventtoallrequestdto.ts

@@ -0,0 +1,173 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { SubscriberPayloadDto, SubscriberPayloadDto$ } from "./subscriberpayloaddto";
+import { TenantPayloadDto, TenantPayloadDto$ } from "./tenantpayloaddto";
+import * as z from "zod";
+
+/**
+ * It is used to display the Avatar of the provided actor's subscriber id or actor object.
+ *
+ * @remarks
+ *     If a new actor object is provided, we will create a new subscriber in our system
+ *
+ */
+export type TriggerEventToAllRequestDtoActor = SubscriberPayloadDto | string;
+
+/**
+ * This could be used to override provider specific configurations
+ */
+export type TriggerEventToAllRequestDtoOverrides = {};
+
+/**
+ * The payload object is used to pass additional custom information that could be used to render the template, or perform routing rules based on it.
+ *
+ * @remarks
+ *       This data will also be available when fetching the notifications feed from the API to display certain parts of the UI.
+ */
+export type TriggerEventToAllRequestDtoPayload = {};
+
+/**
+ * It is used to specify a tenant context during trigger event.
+ *
+ * @remarks
+ *     If a new tenant object is provided, we will create a new tenant.
+ *
+ */
+export type TriggerEventToAllRequestDtoTenant = TenantPayloadDto | string;
+
+export type TriggerEventToAllRequestDto = {
+    /**
+     * It is used to display the Avatar of the provided actor's subscriber id or actor object.
+     *
+     * @remarks
+     *     If a new actor object is provided, we will create a new subscriber in our system
+     *
+     */
+    actor?: SubscriberPayloadDto | string | undefined;
+    /**
+     * The trigger identifier associated for the template you wish to send. This identifier can be found on the template page.
+     */
+    name: string;
+    /**
+     * This could be used to override provider specific configurations
+     */
+    overrides?: TriggerEventToAllRequestDtoOverrides | undefined;
+    /**
+     * The payload object is used to pass additional custom information that could be used to render the template, or perform routing rules based on it.
+     *
+     * @remarks
+     *       This data will also be available when fetching the notifications feed from the API to display certain parts of the UI.
+     */
+    payload: TriggerEventToAllRequestDtoPayload;
+    /**
+     * It is used to specify a tenant context during trigger event.
+     *
+     * @remarks
+     *     If a new tenant object is provided, we will create a new tenant.
+     *
+     */
+    tenant?: TenantPayloadDto | string | undefined;
+    /**
+     * A unique identifier for this transaction, we will generated a UUID if not provided.
+     */
+    transactionId?: string | undefined;
+};
+
+/** @internal */
+export namespace TriggerEventToAllRequestDtoActor$ {
+    export const inboundSchema: z.ZodType<TriggerEventToAllRequestDtoActor, z.ZodTypeDef, unknown> =
+        z.union([SubscriberPayloadDto$.inboundSchema, z.string()]);
+
+    export type Outbound = SubscriberPayloadDto$.Outbound | string;
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        TriggerEventToAllRequestDtoActor
+    > = z.union([SubscriberPayloadDto$.outboundSchema, z.string()]);
+}
+
+/** @internal */
+export namespace TriggerEventToAllRequestDtoOverrides$ {
+    export const inboundSchema: z.ZodType<
+        TriggerEventToAllRequestDtoOverrides,
+        z.ZodTypeDef,
+        unknown
+    > = z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        TriggerEventToAllRequestDtoOverrides
+    > = z.object({});
+}
+
+/** @internal */
+export namespace TriggerEventToAllRequestDtoPayload$ {
+    export const inboundSchema: z.ZodType<
+        TriggerEventToAllRequestDtoPayload,
+        z.ZodTypeDef,
+        unknown
+    > = z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        TriggerEventToAllRequestDtoPayload
+    > = z.object({});
+}
+
+/** @internal */
+export namespace TriggerEventToAllRequestDtoTenant$ {
+    export const inboundSchema: z.ZodType<
+        TriggerEventToAllRequestDtoTenant,
+        z.ZodTypeDef,
+        unknown
+    > = z.union([TenantPayloadDto$.inboundSchema, z.string()]);
+
+    export type Outbound = TenantPayloadDto$.Outbound | string;
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        TriggerEventToAllRequestDtoTenant
+    > = z.union([TenantPayloadDto$.outboundSchema, z.string()]);
+}
+
+/** @internal */
+export namespace TriggerEventToAllRequestDto$ {
+    export const inboundSchema: z.ZodType<TriggerEventToAllRequestDto, z.ZodTypeDef, unknown> =
+        z.object({
+            actor: z.union([SubscriberPayloadDto$.inboundSchema, z.string()]).optional(),
+            name: z.string(),
+            overrides: z.lazy(() => TriggerEventToAllRequestDtoOverrides$.inboundSchema).optional(),
+            payload: z.lazy(() => TriggerEventToAllRequestDtoPayload$.inboundSchema),
+            tenant: z.union([TenantPayloadDto$.inboundSchema, z.string()]).optional(),
+            transactionId: z.string().optional(),
+        });
+
+    export type Outbound = {
+        actor?: SubscriberPayloadDto$.Outbound | string | undefined;
+        name: string;
+        overrides?: TriggerEventToAllRequestDtoOverrides$.Outbound | undefined;
+        payload: TriggerEventToAllRequestDtoPayload$.Outbound;
+        tenant?: TenantPayloadDto$.Outbound | string | undefined;
+        transactionId?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, TriggerEventToAllRequestDto> =
+        z.object({
+            actor: z.union([SubscriberPayloadDto$.outboundSchema, z.string()]).optional(),
+            name: z.string(),
+            overrides: z
+                .lazy(() => TriggerEventToAllRequestDtoOverrides$.outboundSchema)
+                .optional(),
+            payload: z.lazy(() => TriggerEventToAllRequestDtoPayload$.outboundSchema),
+            tenant: z.union([TenantPayloadDto$.outboundSchema, z.string()]).optional(),
+            transactionId: z.string().optional(),
+        });
+}

package/src/models/components/unseencountresponse.ts

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

package/src/models/components/updatebrandingdetailsdto.ts

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

package/src/models/components/updateintegrationrequestdto.ts

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import { CredentialsDto, CredentialsDto$ } from "./credentialsdto";
+import { StepFilter, StepFilter$ } from "./stepfilter";
+import * as z from "zod";
+
+export type UpdateIntegrationRequestDto = {
+    environmentId?: string | undefined;
+    /**
+     * If the integration is active the validation on the credentials field will run
+     */
+    active?: boolean | undefined;
+    check?: boolean | undefined;
+    conditions?: Array<StepFilter> | undefined;
+    credentials?: CredentialsDto | undefined;
+    identifier?: string | undefined;
+    name?: string | undefined;
+};
+
+/** @internal */
+export namespace UpdateIntegrationRequestDto$ {
+    export const inboundSchema: z.ZodType<UpdateIntegrationRequestDto, z.ZodTypeDef, unknown> = z
+        .object({
+            _environmentId: z.string().optional(),
+            active: z.boolean().optional(),
+            check: z.boolean().optional(),
+            conditions: z.array(StepFilter$.inboundSchema).optional(),
+            credentials: CredentialsDto$.inboundSchema.optional(),
+            identifier: z.string().optional(),
+            name: z.string().optional(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                _environmentId: "environmentId",
+            });
+        });
+
+    export type Outbound = {
+        _environmentId?: string | undefined;
+        active?: boolean | undefined;
+        check?: boolean | undefined;
+        conditions?: Array<StepFilter$.Outbound> | undefined;
+        credentials?: CredentialsDto$.Outbound | undefined;
+        identifier?: string | undefined;
+        name?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UpdateIntegrationRequestDto> = z
+        .object({
+            environmentId: z.string().optional(),
+            active: z.boolean().optional(),
+            check: z.boolean().optional(),
+            conditions: z.array(StepFilter$.outboundSchema).optional(),
+            credentials: CredentialsDto$.outboundSchema.optional(),
+            identifier: z.string().optional(),
+            name: z.string().optional(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                environmentId: "_environmentId",
+            });
+        });
+}

package/src/models/components/updatelayoutrequestdto.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type UpdateLayoutRequestDtoVariables = {};
+
+export type UpdateLayoutRequestDto = {
+    /**
+     * User defined content for the layout.
+     */
+    content?: string | undefined;
+    /**
+     * User defined description of the layout
+     */
+    description?: string | undefined;
+    /**
+     * User defined custom key that will be a unique identifier for the Layout updated.
+     */
+    identifier: string;
+    /**
+     * Variable that defines if the layout is chosen as default when creating a layout.
+     */
+    isDefault?: boolean | undefined;
+    /**
+     * User defined custom name and provided by the user that will name the Layout updated.
+     */
+    name?: string | undefined;
+    /**
+     * User defined variables to render in the layout placeholders.
+     */
+    variables?: Array<UpdateLayoutRequestDtoVariables> | undefined;
+};
+
+/** @internal */
+export namespace UpdateLayoutRequestDtoVariables$ {
+    export const inboundSchema: z.ZodType<UpdateLayoutRequestDtoVariables, z.ZodTypeDef, unknown> =
+        z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        UpdateLayoutRequestDtoVariables
+    > = z.object({});
+}
+
+/** @internal */
+export namespace UpdateLayoutRequestDto$ {
+    export const inboundSchema: z.ZodType<UpdateLayoutRequestDto, z.ZodTypeDef, unknown> = z.object(
+        {
+            content: z.string().optional(),
+            description: z.string().optional(),
+            identifier: z.string(),
+            isDefault: z.boolean().optional(),
+            name: z.string().optional(),
+            variables: z
+                .array(z.lazy(() => UpdateLayoutRequestDtoVariables$.inboundSchema))
+                .optional(),
+        }
+    );
+
+    export type Outbound = {
+        content?: string | undefined;
+        description?: string | undefined;
+        identifier: string;
+        isDefault?: boolean | undefined;
+        name?: string | undefined;
+        variables?: Array<UpdateLayoutRequestDtoVariables$.Outbound> | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UpdateLayoutRequestDto> =
+        z.object({
+            content: z.string().optional(),
+            description: z.string().optional(),
+            identifier: z.string(),
+            isDefault: z.boolean().optional(),
+            name: z.string().optional(),
+            variables: z
+                .array(z.lazy(() => UpdateLayoutRequestDtoVariables$.outboundSchema))
+                .optional(),
+        });
+}

package/src/models/components/updatelayoutresponsedto.ts

@@ -0,0 +1,141 @@
+/*
+ * 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 UpdateLayoutResponseDtoChannel = {
+    InApp: "in_app",
+    Email: "email",
+    Sms: "sms",
+    Chat: "chat",
+    Push: "push",
+} as const;
+export type UpdateLayoutResponseDtoChannel = ClosedEnum<typeof UpdateLayoutResponseDtoChannel>;
+
+export type UpdateLayoutResponseDtoVariables = {};
+
+export type UpdateLayoutResponseDto = {
+    creatorId: string;
+    environmentId: string;
+    id?: string | undefined;
+    organizationId: string;
+    parentId?: string | undefined;
+    channel: UpdateLayoutResponseDtoChannel;
+    content: string;
+    contentType: string;
+    createdAt?: string | undefined;
+    description?: string | undefined;
+    identifier: string;
+    isDefault: boolean;
+    isDeleted: boolean;
+    name: string;
+    updatedAt?: string | undefined;
+    variables?: Array<UpdateLayoutResponseDtoVariables> | undefined;
+};
+
+/** @internal */
+export namespace UpdateLayoutResponseDtoChannel$ {
+    export const inboundSchema = z.nativeEnum(UpdateLayoutResponseDtoChannel);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace UpdateLayoutResponseDtoVariables$ {
+    export const inboundSchema: z.ZodType<UpdateLayoutResponseDtoVariables, z.ZodTypeDef, unknown> =
+        z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        UpdateLayoutResponseDtoVariables
+    > = z.object({});
+}
+
+/** @internal */
+export namespace UpdateLayoutResponseDto$ {
+    export const inboundSchema: z.ZodType<UpdateLayoutResponseDto, z.ZodTypeDef, unknown> = z
+        .object({
+            _creatorId: z.string(),
+            _environmentId: z.string(),
+            _id: z.string().optional(),
+            _organizationId: z.string(),
+            _parentId: z.string().optional(),
+            channel: UpdateLayoutResponseDtoChannel$.inboundSchema,
+            content: z.string(),
+            contentType: z.string(),
+            createdAt: z.string().optional(),
+            description: z.string().optional(),
+            identifier: z.string(),
+            isDefault: z.boolean(),
+            isDeleted: z.boolean(),
+            name: z.string(),
+            updatedAt: z.string().optional(),
+            variables: z
+                .array(z.lazy(() => UpdateLayoutResponseDtoVariables$.inboundSchema))
+                .optional(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                _creatorId: "creatorId",
+                _environmentId: "environmentId",
+                _id: "id",
+                _organizationId: "organizationId",
+                _parentId: "parentId",
+            });
+        });
+
+    export type Outbound = {
+        _creatorId: string;
+        _environmentId: string;
+        _id?: string | undefined;
+        _organizationId: string;
+        _parentId?: string | undefined;
+        channel: string;
+        content: string;
+        contentType: string;
+        createdAt?: string | undefined;
+        description?: string | undefined;
+        identifier: string;
+        isDefault: boolean;
+        isDeleted: boolean;
+        name: string;
+        updatedAt?: string | undefined;
+        variables?: Array<UpdateLayoutResponseDtoVariables$.Outbound> | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, UpdateLayoutResponseDto> = z
+        .object({
+            creatorId: z.string(),
+            environmentId: z.string(),
+            id: z.string().optional(),
+            organizationId: z.string(),
+            parentId: z.string().optional(),
+            channel: UpdateLayoutResponseDtoChannel$.outboundSchema,
+            content: z.string(),
+            contentType: z.string(),
+            createdAt: z.string().optional(),
+            description: z.string().optional(),
+            identifier: z.string(),
+            isDefault: z.boolean(),
+            isDeleted: z.boolean(),
+            name: z.string(),
+            updatedAt: z.string().optional(),
+            variables: z
+                .array(z.lazy(() => UpdateLayoutResponseDtoVariables$.outboundSchema))
+                .optional(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                creatorId: "_creatorId",
+                environmentId: "_environmentId",
+                id: "_id",
+                organizationId: "_organizationId",
+                parentId: "_parentId",
+            });
+        });
+}

package/src/models/components/updatesubscriberchannelrequestdto.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types";
+import { ChannelCredentials, ChannelCredentials$ } from "./channelcredentials";
+import * as z from "zod";
+
+/**
+ * The provider identifier for the credentials
+ */
+export const UpdateSubscriberChannelRequestDtoProviderId = {
+    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 UpdateSubscriberChannelRequestDtoProviderId = ClosedEnum<
+    typeof UpdateSubscriberChannelRequestDtoProviderId
+>;
+
+export type UpdateSubscriberChannelRequestDto = {
+    /**
+     * Credentials payload for the specified provider
+     */
+    credentials: ChannelCredentials;
+    /**
+     * The integration identifier
+     */
+    integrationIdentifier?: string | undefined;
+    /**
+     * The provider identifier for the credentials
+     */
+    providerId: UpdateSubscriberChannelRequestDtoProviderId;
+};
+
+/** @internal */
+export namespace UpdateSubscriberChannelRequestDtoProviderId$ {
+    export const inboundSchema = z.nativeEnum(UpdateSubscriberChannelRequestDtoProviderId);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace UpdateSubscriberChannelRequestDto$ {
+    export const inboundSchema: z.ZodType<
+        UpdateSubscriberChannelRequestDto,
+        z.ZodTypeDef,
+        unknown
+    > = z.object({
+        credentials: ChannelCredentials$.inboundSchema,
+        integrationIdentifier: z.string().optional(),
+        providerId: UpdateSubscriberChannelRequestDtoProviderId$.inboundSchema,
+    });
+
+    export type Outbound = {
+        credentials: ChannelCredentials$.Outbound;
+        integrationIdentifier?: string | undefined;
+        providerId: string;
+    };
+
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        UpdateSubscriberChannelRequestDto
+    > = z.object({
+        credentials: ChannelCredentials$.outboundSchema,
+        integrationIdentifier: z.string().optional(),
+        providerId: UpdateSubscriberChannelRequestDtoProviderId$.outboundSchema,
+    });
+}

package/src/models/components/updatesubscriberglobalpreferencesrequestdto.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 UpdateSubscriberGlobalPreferencesRequestDto = {
+    /**
+     * Enable or disable the subscriber global preferences.
+     */
+    enabled?: boolean | undefined;
+    /**
+     * The subscriber global preferences for every ChannelTypeEnum.
+     */
+    preferences?: Array<ChannelPreference> | undefined;
+};
+
+/** @internal */
+export namespace UpdateSubscriberGlobalPreferencesRequestDto$ {
+    export const inboundSchema: z.ZodType<
+        UpdateSubscriberGlobalPreferencesRequestDto,
+        z.ZodTypeDef,
+        unknown
+    > = z.object({
+        enabled: z.boolean().optional(),
+        preferences: z.array(ChannelPreference$.inboundSchema).optional(),
+    });
+
+    export type Outbound = {
+        enabled?: boolean | undefined;
+        preferences?: Array<ChannelPreference$.Outbound> | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        UpdateSubscriberGlobalPreferencesRequestDto
+    > = z.object({
+        enabled: z.boolean().optional(),
+        preferences: z.array(ChannelPreference$.outboundSchema).optional(),
+    });
+}

package/src/models/components/updatesubscriberonlineflagrequestdto.ts

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