@novu/api 0.0.1-alpha.10

package/src/lib/security.ts

@@ -0,0 +1,203 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as components from "../models/components/index.js";
+
+export enum SecurityErrorCode {
+    Incomplete = "incomplete",
+    UnrecognisedSecurityType = "unrecognized_security_type",
+}
+
+export class SecurityError extends Error {
+    constructor(public code: SecurityErrorCode, message: string) {
+        super(message);
+        this.name = "SecurityError";
+    }
+
+    static incomplete(): SecurityError {
+        return new SecurityError(
+            SecurityErrorCode.Incomplete,
+            "Security requirements not met in order to perform the operation"
+        );
+    }
+    static unrecognizedType(type: string): SecurityError {
+        return new SecurityError(
+            SecurityErrorCode.UnrecognisedSecurityType,
+            `Unrecognised security type: ${type}`
+        );
+    }
+}
+
+export type SecurityState = {
+    basic: { username?: string | undefined; password?: string | undefined };
+    headers: Record<string, string>;
+    queryParams: Record<string, string>;
+    cookies: Record<string, string>;
+};
+
+type SecurityInputBasic = {
+    type: "http:basic";
+    value: { username?: string | undefined; password?: string | undefined } | null | undefined;
+};
+
+type SecurityInputBearer = {
+    type: "http:bearer";
+    value: string | null | undefined;
+    fieldName: string;
+};
+
+type SecurityInputAPIKey = {
+    type: "apiKey:header" | "apiKey:query" | "apiKey:cookie";
+    value: string | null | undefined;
+    fieldName: string;
+};
+
+type SecurityInputOIDC = {
+    type: "openIdConnect";
+    value: string | null | undefined;
+    fieldName: string;
+};
+
+type SecurityInputOAuth2 = {
+    type: "oauth2";
+    value: string | null | undefined;
+    fieldName: string;
+};
+
+type SecurityInputOAuth2ClientCredentials = {
+    type: "oauth2:client_credentials";
+    value: string | null | undefined;
+    fieldName: string;
+};
+
+type SecurityInputCustom = {
+    type: "http:custom";
+    value: any | null | undefined;
+    fieldName: string;
+};
+
+export type SecurityInput =
+    | SecurityInputBasic
+    | SecurityInputBearer
+    | SecurityInputAPIKey
+    | SecurityInputOAuth2
+    | SecurityInputOAuth2ClientCredentials
+    | SecurityInputOIDC
+    | SecurityInputCustom;
+
+export function resolveSecurity(...options: SecurityInput[][]): SecurityState | null {
+    const state: SecurityState = {
+        basic: { username: "", password: "" },
+        headers: {},
+        queryParams: {},
+        cookies: {},
+    };
+
+    const option = options.find((opts) => {
+        return opts.every((o) => {
+            if (o.value == null) {
+                return false;
+            } else if (o.type === "http:basic") {
+                return o.value.username != null || o.value.password != null;
+            } else if (o.type === "http:custom") {
+                return null;
+            } else if (typeof o.value === "string") {
+                return !!o.value;
+            } else {
+                throw new Error(
+                    `Unrecognized security type: ${o.type} (value type: ${typeof o.value})`
+                );
+            }
+        });
+    });
+    if (option == null) {
+        return null;
+    }
+
+    option.forEach((spec) => {
+        if (spec.value == null) {
+            return;
+        }
+
+        const { type } = spec;
+
+        switch (type) {
+            case "apiKey:header":
+                state.headers[spec.fieldName] = spec.value;
+                break;
+            case "apiKey:query":
+                state.queryParams[spec.fieldName] = spec.value;
+                break;
+            case "apiKey:cookie":
+                state.cookies[spec.fieldName] = spec.value;
+                break;
+            case "http:basic":
+                applyBasic(state, spec);
+                break;
+            case "http:custom":
+                break;
+            case "http:bearer":
+                applyBearer(state, spec);
+                break;
+            case "oauth2":
+                applyBearer(state, spec);
+                break;
+            case "oauth2:client_credentials":
+                break;
+            case "openIdConnect":
+                applyBearer(state, spec);
+                break;
+            default:
+                spec satisfies never;
+                throw SecurityError.unrecognizedType(type);
+        }
+    });
+
+    return state;
+}
+
+function applyBasic(state: SecurityState, spec: SecurityInputBasic) {
+    if (spec.value == null) {
+        return;
+    }
+
+    state.basic = spec.value;
+}
+
+function applyBearer(
+    state: SecurityState,
+    spec: SecurityInputBearer | SecurityInputOAuth2 | SecurityInputOIDC
+) {
+    if (spec.value == null) {
+        return;
+    }
+
+    let value = spec.value;
+    if (value.slice(0, 7).toLowerCase() !== "bearer ") {
+        value = `Bearer ${value}`;
+    }
+
+    state.headers[spec.fieldName] = value;
+}
+export function resolveGlobalSecurity(
+    security: Partial<components.Security> | null | undefined
+): SecurityState | null {
+    return resolveSecurity([
+        {
+            fieldName: "Authorization",
+            type: "apiKey:header",
+            value: security?.apiKey,
+        },
+    ]);
+}
+
+export async function extractSecurity<T extends string | Record<string, unknown>>(
+    sec: T | (() => Promise<T>) | undefined
+): Promise<T | undefined> {
+    if (sec == null) {
+        return;
+    }
+
+    return typeof sec === "function" ? sec() : sec;
+}

package/src/lib/url.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+const hasOwn = Object.prototype.hasOwnProperty;
+
+export type Params = Partial<Record<string, string | number>>;
+
+export function pathToFunc(
+  pathPattern: string,
+  options?: { charEncoding?: "percent" | "none" },
+): (params?: Params) => string {
+  const paramRE = /\{([a-zA-Z0-9_]+?)\}/g;
+
+  return function buildURLPath(params: Record<string, unknown> = {}): string {
+    return pathPattern.replace(paramRE, function (_, placeholder) {
+      if (!hasOwn.call(params, placeholder)) {
+        throw new Error(`Parameter '${placeholder}' is required`);
+      }
+
+      const value = params[placeholder];
+      if (typeof value !== "string" && typeof value !== "number") {
+        throw new Error(
+          `Parameter '${placeholder}' must be a string or number`,
+        );
+      }
+
+      return options?.charEncoding === "percent"
+        ? encodeURIComponent(`${value}`)
+        : `${value}`;
+    });
+  };
+}

package/src/models/components/activitiesresponsedto.ts

@@ -0,0 +1,57 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type ActivitiesResponseDto = {
+    data: Array<string>;
+    hasMore: boolean;
+    page: number;
+    pageSize: number;
+};
+
+/** @internal */
+export const ActivitiesResponseDto$inboundSchema: z.ZodType<
+    ActivitiesResponseDto,
+    z.ZodTypeDef,
+    unknown
+> = z.object({
+    data: z.array(z.string()),
+    hasMore: z.boolean(),
+    page: z.number(),
+    pageSize: z.number(),
+});
+
+/** @internal */
+export type ActivitiesResponseDto$Outbound = {
+    data: Array<string>;
+    hasMore: boolean;
+    page: number;
+    pageSize: number;
+};
+
+/** @internal */
+export const ActivitiesResponseDto$outboundSchema: z.ZodType<
+    ActivitiesResponseDto$Outbound,
+    z.ZodTypeDef,
+    ActivitiesResponseDto
+> = z.object({
+    data: z.array(z.string()),
+    hasMore: z.boolean(),
+    page: z.number(),
+    pageSize: z.number(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ActivitiesResponseDto$ {
+    /** @deprecated use `ActivitiesResponseDto$inboundSchema` instead. */
+    export const inboundSchema = ActivitiesResponseDto$inboundSchema;
+    /** @deprecated use `ActivitiesResponseDto$outboundSchema` instead. */
+    export const outboundSchema = ActivitiesResponseDto$outboundSchema;
+    /** @deprecated use `ActivitiesResponseDto$Outbound` instead. */
+    export type Outbound = ActivitiesResponseDto$Outbound;
+}

package/src/models/components/activitygraphstatesresponse.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+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 const Channels$inboundSchema: z.ZodNativeEnum<typeof Channels> = z.nativeEnum(Channels);
+
+/** @internal */
+export const Channels$outboundSchema: z.ZodNativeEnum<typeof Channels> = Channels$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Channels$ {
+    /** @deprecated use `Channels$inboundSchema` instead. */
+    export const inboundSchema = Channels$inboundSchema;
+    /** @deprecated use `Channels$outboundSchema` instead. */
+    export const outboundSchema = Channels$outboundSchema;
+}
+
+/** @internal */
+export const ActivityGraphStatesResponse$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",
+        });
+    });
+
+/** @internal */
+export type ActivityGraphStatesResponse$Outbound = {
+    _id: string;
+    channels: Array<string>;
+    count: number;
+    templates: Array<string>;
+};
+
+/** @internal */
+export const ActivityGraphStatesResponse$outboundSchema: z.ZodType<
+    ActivityGraphStatesResponse$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",
+        });
+    });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ActivityGraphStatesResponse$ {
+    /** @deprecated use `ActivityGraphStatesResponse$inboundSchema` instead. */
+    export const inboundSchema = ActivityGraphStatesResponse$inboundSchema;
+    /** @deprecated use `ActivityGraphStatesResponse$outboundSchema` instead. */
+    export const outboundSchema = ActivityGraphStatesResponse$outboundSchema;
+    /** @deprecated use `ActivityGraphStatesResponse$Outbound` instead. */
+    export type Outbound = ActivityGraphStatesResponse$Outbound;
+}

package/src/models/components/activitynotificationresponsedto.ts

@@ -0,0 +1,143 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+    ActivityNotificationSubscriberResponseDto,
+    ActivityNotificationSubscriberResponseDto$inboundSchema,
+    ActivityNotificationSubscriberResponseDto$Outbound,
+    ActivityNotificationSubscriberResponseDto$outboundSchema,
+} from "./activitynotificationsubscriberresponsedto.js";
+import {
+    ActivityNotificationTemplateResponseDto,
+    ActivityNotificationTemplateResponseDto$inboundSchema,
+    ActivityNotificationTemplateResponseDto$Outbound,
+    ActivityNotificationTemplateResponseDto$outboundSchema,
+} from "./activitynotificationtemplateresponsedto.js";
+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<string> | undefined;
+    subscriber?: ActivityNotificationSubscriberResponseDto | undefined;
+    template?: ActivityNotificationTemplateResponseDto | undefined;
+    transactionId: string;
+};
+
+/** @internal */
+export const ActivityNotificationResponseDtoChannels$inboundSchema: z.ZodNativeEnum<
+    typeof ActivityNotificationResponseDtoChannels
+> = z.nativeEnum(ActivityNotificationResponseDtoChannels);
+
+/** @internal */
+export const ActivityNotificationResponseDtoChannels$outboundSchema: z.ZodNativeEnum<
+    typeof ActivityNotificationResponseDtoChannels
+> = ActivityNotificationResponseDtoChannels$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ActivityNotificationResponseDtoChannels$ {
+    /** @deprecated use `ActivityNotificationResponseDtoChannels$inboundSchema` instead. */
+    export const inboundSchema = ActivityNotificationResponseDtoChannels$inboundSchema;
+    /** @deprecated use `ActivityNotificationResponseDtoChannels$outboundSchema` instead. */
+    export const outboundSchema = ActivityNotificationResponseDtoChannels$outboundSchema;
+}
+
+/** @internal */
+export const ActivityNotificationResponseDto$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(z.string()).optional(),
+        subscriber: ActivityNotificationSubscriberResponseDto$inboundSchema.optional(),
+        template: ActivityNotificationTemplateResponseDto$inboundSchema.optional(),
+        transactionId: z.string(),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            _environmentId: "environmentId",
+            _id: "id",
+            _organizationId: "organizationId",
+        });
+    });
+
+/** @internal */
+export type ActivityNotificationResponseDto$Outbound = {
+    _environmentId: string;
+    _id?: string | undefined;
+    _organizationId: string;
+    channels?: string | undefined;
+    createdAt?: string | undefined;
+    jobs?: Array<string> | undefined;
+    subscriber?: ActivityNotificationSubscriberResponseDto$Outbound | undefined;
+    template?: ActivityNotificationTemplateResponseDto$Outbound | undefined;
+    transactionId: string;
+};
+
+/** @internal */
+export const ActivityNotificationResponseDto$outboundSchema: z.ZodType<
+    ActivityNotificationResponseDto$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(z.string()).optional(),
+        subscriber: ActivityNotificationSubscriberResponseDto$outboundSchema.optional(),
+        template: ActivityNotificationTemplateResponseDto$outboundSchema.optional(),
+        transactionId: z.string(),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            environmentId: "_environmentId",
+            id: "_id",
+            organizationId: "_organizationId",
+        });
+    });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ActivityNotificationResponseDto$ {
+    /** @deprecated use `ActivityNotificationResponseDto$inboundSchema` instead. */
+    export const inboundSchema = ActivityNotificationResponseDto$inboundSchema;
+    /** @deprecated use `ActivityNotificationResponseDto$outboundSchema` instead. */
+    export const outboundSchema = ActivityNotificationResponseDto$outboundSchema;
+    /** @deprecated use `ActivityNotificationResponseDto$Outbound` instead. */
+    export type Outbound = ActivityNotificationResponseDto$Outbound;
+}

package/src/models/components/activitynotificationsubscriberresponsedto.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as z from "zod";
+
+export type ActivityNotificationSubscriberResponseDto = {
+    id: string;
+    email?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    phone?: string | undefined;
+};
+
+/** @internal */
+export const ActivityNotificationSubscriberResponseDto$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",
+        });
+    });
+
+/** @internal */
+export type ActivityNotificationSubscriberResponseDto$Outbound = {
+    _id: string;
+    email?: string | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    phone?: string | undefined;
+};
+
+/** @internal */
+export const ActivityNotificationSubscriberResponseDto$outboundSchema: z.ZodType<
+    ActivityNotificationSubscriberResponseDto$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",
+        });
+    });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ActivityNotificationSubscriberResponseDto$ {
+    /** @deprecated use `ActivityNotificationSubscriberResponseDto$inboundSchema` instead. */
+    export const inboundSchema = ActivityNotificationSubscriberResponseDto$inboundSchema;
+    /** @deprecated use `ActivityNotificationSubscriberResponseDto$outboundSchema` instead. */
+    export const outboundSchema = ActivityNotificationSubscriberResponseDto$outboundSchema;
+    /** @deprecated use `ActivityNotificationSubscriberResponseDto$Outbound` instead. */
+    export type Outbound = ActivityNotificationSubscriberResponseDto$Outbound;
+}

package/src/models/components/activitynotificationtemplateresponsedto.ts

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as z from "zod";
+
+export type ActivityNotificationTemplateResponseDto = {
+    id?: string | undefined;
+    name: string;
+    triggers: Array<string>;
+};
+
+/** @internal */
+export const ActivityNotificationTemplateResponseDto$inboundSchema: z.ZodType<
+    ActivityNotificationTemplateResponseDto,
+    z.ZodTypeDef,
+    unknown
+> = z
+    .object({
+        _id: z.string().optional(),
+        name: z.string(),
+        triggers: z.array(z.string()),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            _id: "id",
+        });
+    });
+
+/** @internal */
+export type ActivityNotificationTemplateResponseDto$Outbound = {
+    _id?: string | undefined;
+    name: string;
+    triggers: Array<string>;
+};
+
+/** @internal */
+export const ActivityNotificationTemplateResponseDto$outboundSchema: z.ZodType<
+    ActivityNotificationTemplateResponseDto$Outbound,
+    z.ZodTypeDef,
+    ActivityNotificationTemplateResponseDto
+> = z
+    .object({
+        id: z.string().optional(),
+        name: z.string(),
+        triggers: z.array(z.string()),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            id: "_id",
+        });
+    });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ActivityNotificationTemplateResponseDto$ {
+    /** @deprecated use `ActivityNotificationTemplateResponseDto$inboundSchema` instead. */
+    export const inboundSchema = ActivityNotificationTemplateResponseDto$inboundSchema;
+    /** @deprecated use `ActivityNotificationTemplateResponseDto$outboundSchema` instead. */
+    export const outboundSchema = ActivityNotificationTemplateResponseDto$outboundSchema;
+    /** @deprecated use `ActivityNotificationTemplateResponseDto$Outbound` instead. */
+    export type Outbound = ActivityNotificationTemplateResponseDto$Outbound;
+}