@novu/api 0.0.1-alpha.99 → 0.0.2

package/src/models/components/notificationtriggerresponse.ts

@@ -0,0 +1,126 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  NotificationTriggerVariableResponse,
+  NotificationTriggerVariableResponse$inboundSchema,
+  NotificationTriggerVariableResponse$Outbound,
+  NotificationTriggerVariableResponse$outboundSchema,
+} from "./notificationtriggervariableresponse.js";
+import {
+  TriggerReservedVariableResponse,
+  TriggerReservedVariableResponse$inboundSchema,
+  TriggerReservedVariableResponse$Outbound,
+  TriggerReservedVariableResponse$outboundSchema,
+} from "./triggerreservedvariableresponse.js";
+import {
+  TriggerTypeEnum,
+  TriggerTypeEnum$inboundSchema,
+  TriggerTypeEnum$outboundSchema,
+} from "./triggertypeenum.js";
+
+export type NotificationTriggerResponse = {
+  /**
+   * The type of the trigger
+   */
+  type: TriggerTypeEnum;
+  /**
+   * The identifier of the trigger
+   */
+  identifier: string;
+  /**
+   * The variables of the trigger
+   */
+  variables: Array<NotificationTriggerVariableResponse>;
+  /**
+   * The subscriber variables of the trigger
+   */
+  subscriberVariables?: Array<NotificationTriggerVariableResponse> | undefined;
+  /**
+   * The reserved variables of the trigger
+   */
+  reservedVariables?: Array<TriggerReservedVariableResponse> | undefined;
+};
+
+/** @internal */
+export const NotificationTriggerResponse$inboundSchema: z.ZodType<
+  NotificationTriggerResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: TriggerTypeEnum$inboundSchema,
+  identifier: z.string(),
+  variables: z.array(NotificationTriggerVariableResponse$inboundSchema),
+  subscriberVariables: z.array(
+    NotificationTriggerVariableResponse$inboundSchema,
+  ).optional(),
+  reservedVariables: z.array(TriggerReservedVariableResponse$inboundSchema)
+    .optional(),
+});
+
+/** @internal */
+export type NotificationTriggerResponse$Outbound = {
+  type: string;
+  identifier: string;
+  variables: Array<NotificationTriggerVariableResponse$Outbound>;
+  subscriberVariables?:
+    | Array<NotificationTriggerVariableResponse$Outbound>
+    | undefined;
+  reservedVariables?:
+    | Array<TriggerReservedVariableResponse$Outbound>
+    | undefined;
+};
+
+/** @internal */
+export const NotificationTriggerResponse$outboundSchema: z.ZodType<
+  NotificationTriggerResponse$Outbound,
+  z.ZodTypeDef,
+  NotificationTriggerResponse
+> = z.object({
+  type: TriggerTypeEnum$outboundSchema,
+  identifier: z.string(),
+  variables: z.array(NotificationTriggerVariableResponse$outboundSchema),
+  subscriberVariables: z.array(
+    NotificationTriggerVariableResponse$outboundSchema,
+  ).optional(),
+  reservedVariables: z.array(TriggerReservedVariableResponse$outboundSchema)
+    .optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace NotificationTriggerResponse$ {
+  /** @deprecated use `NotificationTriggerResponse$inboundSchema` instead. */
+  export const inboundSchema = NotificationTriggerResponse$inboundSchema;
+  /** @deprecated use `NotificationTriggerResponse$outboundSchema` instead. */
+  export const outboundSchema = NotificationTriggerResponse$outboundSchema;
+  /** @deprecated use `NotificationTriggerResponse$Outbound` instead. */
+  export type Outbound = NotificationTriggerResponse$Outbound;
+}
+
+export function notificationTriggerResponseToJSON(
+  notificationTriggerResponse: NotificationTriggerResponse,
+): string {
+  return JSON.stringify(
+    NotificationTriggerResponse$outboundSchema.parse(
+      notificationTriggerResponse,
+    ),
+  );
+}
+
+export function notificationTriggerResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<NotificationTriggerResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NotificationTriggerResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NotificationTriggerResponse' from JSON`,
+  );
+}

package/src/models/components/notificationtriggervariable.ts

@@ -8,6 +8,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type NotificationTriggerVariable = {
+  /**
+   * Name of the variable
+   */
   name: string;
 };
 

package/src/models/components/notificationtriggervariableresponse.ts

@@ -0,0 +1,193 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The value of the variable
+ */
+export type NotificationTriggerVariableResponseValue = {};
+
+/**
+ * The type of the variable
+ */
+export const NotificationTriggerVariableResponseType = {
+  String: "String",
+  Array: "Array",
+  Boolean: "Boolean",
+} as const;
+/**
+ * The type of the variable
+ */
+export type NotificationTriggerVariableResponseType = ClosedEnum<
+  typeof NotificationTriggerVariableResponseType
+>;
+
+export type NotificationTriggerVariableResponse = {
+  /**
+   * The name of the variable
+   */
+  name: string;
+  /**
+   * The value of the variable
+   */
+  value?: NotificationTriggerVariableResponseValue | undefined;
+  /**
+   * The type of the variable
+   */
+  type?: NotificationTriggerVariableResponseType | undefined;
+};
+
+/** @internal */
+export const NotificationTriggerVariableResponseValue$inboundSchema: z.ZodType<
+  NotificationTriggerVariableResponseValue,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type NotificationTriggerVariableResponseValue$Outbound = {};
+
+/** @internal */
+export const NotificationTriggerVariableResponseValue$outboundSchema: z.ZodType<
+  NotificationTriggerVariableResponseValue$Outbound,
+  z.ZodTypeDef,
+  NotificationTriggerVariableResponseValue
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace NotificationTriggerVariableResponseValue$ {
+  /** @deprecated use `NotificationTriggerVariableResponseValue$inboundSchema` instead. */
+  export const inboundSchema =
+    NotificationTriggerVariableResponseValue$inboundSchema;
+  /** @deprecated use `NotificationTriggerVariableResponseValue$outboundSchema` instead. */
+  export const outboundSchema =
+    NotificationTriggerVariableResponseValue$outboundSchema;
+  /** @deprecated use `NotificationTriggerVariableResponseValue$Outbound` instead. */
+  export type Outbound = NotificationTriggerVariableResponseValue$Outbound;
+}
+
+export function notificationTriggerVariableResponseValueToJSON(
+  notificationTriggerVariableResponseValue:
+    NotificationTriggerVariableResponseValue,
+): string {
+  return JSON.stringify(
+    NotificationTriggerVariableResponseValue$outboundSchema.parse(
+      notificationTriggerVariableResponseValue,
+    ),
+  );
+}
+
+export function notificationTriggerVariableResponseValueFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  NotificationTriggerVariableResponseValue,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      NotificationTriggerVariableResponseValue$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'NotificationTriggerVariableResponseValue' from JSON`,
+  );
+}
+
+/** @internal */
+export const NotificationTriggerVariableResponseType$inboundSchema:
+  z.ZodNativeEnum<typeof NotificationTriggerVariableResponseType> = z
+    .nativeEnum(NotificationTriggerVariableResponseType);
+
+/** @internal */
+export const NotificationTriggerVariableResponseType$outboundSchema:
+  z.ZodNativeEnum<typeof NotificationTriggerVariableResponseType> =
+    NotificationTriggerVariableResponseType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace NotificationTriggerVariableResponseType$ {
+  /** @deprecated use `NotificationTriggerVariableResponseType$inboundSchema` instead. */
+  export const inboundSchema =
+    NotificationTriggerVariableResponseType$inboundSchema;
+  /** @deprecated use `NotificationTriggerVariableResponseType$outboundSchema` instead. */
+  export const outboundSchema =
+    NotificationTriggerVariableResponseType$outboundSchema;
+}
+
+/** @internal */
+export const NotificationTriggerVariableResponse$inboundSchema: z.ZodType<
+  NotificationTriggerVariableResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  value: z.lazy(() => NotificationTriggerVariableResponseValue$inboundSchema)
+    .optional(),
+  type: NotificationTriggerVariableResponseType$inboundSchema.optional(),
+});
+
+/** @internal */
+export type NotificationTriggerVariableResponse$Outbound = {
+  name: string;
+  value?: NotificationTriggerVariableResponseValue$Outbound | undefined;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const NotificationTriggerVariableResponse$outboundSchema: z.ZodType<
+  NotificationTriggerVariableResponse$Outbound,
+  z.ZodTypeDef,
+  NotificationTriggerVariableResponse
+> = z.object({
+  name: z.string(),
+  value: z.lazy(() => NotificationTriggerVariableResponseValue$outboundSchema)
+    .optional(),
+  type: NotificationTriggerVariableResponseType$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace NotificationTriggerVariableResponse$ {
+  /** @deprecated use `NotificationTriggerVariableResponse$inboundSchema` instead. */
+  export const inboundSchema =
+    NotificationTriggerVariableResponse$inboundSchema;
+  /** @deprecated use `NotificationTriggerVariableResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    NotificationTriggerVariableResponse$outboundSchema;
+  /** @deprecated use `NotificationTriggerVariableResponse$Outbound` instead. */
+  export type Outbound = NotificationTriggerVariableResponse$Outbound;
+}
+
+export function notificationTriggerVariableResponseToJSON(
+  notificationTriggerVariableResponse: NotificationTriggerVariableResponse,
+): string {
+  return JSON.stringify(
+    NotificationTriggerVariableResponse$outboundSchema.parse(
+      notificationTriggerVariableResponse,
+    ),
+  );
+}
+
+export function notificationTriggerVariableResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<NotificationTriggerVariableResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      NotificationTriggerVariableResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NotificationTriggerVariableResponse' from JSON`,
+  );
+}

package/src/models/components/ordinalenum.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Ordinal position for the digest
+ */
+export const OrdinalEnum = {
+  One: "1",
+  Two: "2",
+  Three: "3",
+  Four: "4",
+  Five: "5",
+  Last: "last",
+} as const;
+/**
+ * Ordinal position for the digest
+ */
+export type OrdinalEnum = ClosedEnum<typeof OrdinalEnum>;
+
+/** @internal */
+export const OrdinalEnum$inboundSchema: z.ZodNativeEnum<typeof OrdinalEnum> = z
+  .nativeEnum(OrdinalEnum);
+
+/** @internal */
+export const OrdinalEnum$outboundSchema: z.ZodNativeEnum<typeof OrdinalEnum> =
+  OrdinalEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OrdinalEnum$ {
+  /** @deprecated use `OrdinalEnum$inboundSchema` instead. */
+  export const inboundSchema = OrdinalEnum$inboundSchema;
+  /** @deprecated use `OrdinalEnum$outboundSchema` instead. */
+  export const outboundSchema = OrdinalEnum$outboundSchema;
+}

package/src/models/components/ordinalvalueenum.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Value of the ordinal
+ */
+export const OrdinalValueEnum = {
+  Day: "day",
+  Weekday: "weekday",
+  Weekend: "weekend",
+  Sunday: "sunday",
+  Monday: "monday",
+  Tuesday: "tuesday",
+  Wednesday: "wednesday",
+  Thursday: "thursday",
+  Friday: "friday",
+  Saturday: "saturday",
+} as const;
+/**
+ * Value of the ordinal
+ */
+export type OrdinalValueEnum = ClosedEnum<typeof OrdinalValueEnum>;
+
+/** @internal */
+export const OrdinalValueEnum$inboundSchema: z.ZodNativeEnum<
+  typeof OrdinalValueEnum
+> = z.nativeEnum(OrdinalValueEnum);
+
+/** @internal */
+export const OrdinalValueEnum$outboundSchema: z.ZodNativeEnum<
+  typeof OrdinalValueEnum
+> = OrdinalValueEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OrdinalValueEnum$ {
+  /** @deprecated use `OrdinalValueEnum$inboundSchema` instead. */
+  export const inboundSchema = OrdinalValueEnum$inboundSchema;
+  /** @deprecated use `OrdinalValueEnum$outboundSchema` instead. */
+  export const outboundSchema = OrdinalValueEnum$outboundSchema;
+}

package/src/models/components/providersidenum.ts

@@ -0,0 +1,106 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Provider ID of the job
+ */
+export const ProvidersIdEnum = {
+  Emailjs: "emailjs",
+  Mailgun: "mailgun",
+  Mailjet: "mailjet",
+  Mandrill: "mandrill",
+  Nodemailer: "nodemailer",
+  Postmark: "postmark",
+  Sendgrid: "sendgrid",
+  Sendinblue: "sendinblue",
+  Ses: "ses",
+  Netcore: "netcore",
+  InfobipEmail: "infobip-email",
+  Resend: "resend",
+  Plunk: "plunk",
+  Mailersend: "mailersend",
+  Mailtrap: "mailtrap",
+  Clickatell: "clickatell",
+  Outlook365: "outlook365",
+  NovuEmail: "novu-email",
+  Sparkpost: "sparkpost",
+  EmailWebhook: "email-webhook",
+  Braze: "braze",
+  Nexmo: "nexmo",
+  Plivo: "plivo",
+  Sms77: "sms77",
+  SmsCentral: "sms-central",
+  Sns: "sns",
+  Telnyx: "telnyx",
+  Twilio: "twilio",
+  Gupshup: "gupshup",
+  Firetext: "firetext",
+  InfobipSms: "infobip-sms",
+  BurstSms: "burst-sms",
+  BulkSms: "bulk-sms",
+  IsendSms: "isend-sms",
+  FortySixElks: "forty-six-elks",
+  Kannel: "kannel",
+  Maqsam: "maqsam",
+  Termii: "termii",
+  AfricasTalking: "africas-talking",
+  NovuSms: "novu-sms",
+  Sendchamp: "sendchamp",
+  GenericSms: "generic-sms",
+  Clicksend: "clicksend",
+  Bandwidth: "bandwidth",
+  Messagebird: "messagebird",
+  Simpletexting: "simpletexting",
+  AzureSms: "azure-sms",
+  RingCentral: "ring-central",
+  BrevoSms: "brevo-sms",
+  EazySms: "eazy-sms",
+  Mobishastra: "mobishastra",
+  Fcm: "fcm",
+  Apns: "apns",
+  Expo: "expo",
+  OneSignal: "one-signal",
+  Pushpad: "pushpad",
+  PushWebhook: "push-webhook",
+  PusherBeams: "pusher-beams",
+  Novu: "novu",
+  Slack: "slack",
+  Discord: "discord",
+  Msteams: "msteams",
+  Mattermost: "mattermost",
+  Ryver: "ryver",
+  Zulip: "zulip",
+  GrafanaOnCall: "grafana-on-call",
+  Getstream: "getstream",
+  RocketChat: "rocket-chat",
+  WhatsappBusiness: "whatsapp-business",
+} as const;
+/**
+ * Provider ID of the job
+ */
+export type ProvidersIdEnum = ClosedEnum<typeof ProvidersIdEnum>;
+
+/** @internal */
+export const ProvidersIdEnum$inboundSchema: z.ZodNativeEnum<
+  typeof ProvidersIdEnum
+> = z.nativeEnum(ProvidersIdEnum);
+
+/** @internal */
+export const ProvidersIdEnum$outboundSchema: z.ZodNativeEnum<
+  typeof ProvidersIdEnum
+> = ProvidersIdEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProvidersIdEnum$ {
+  /** @deprecated use `ProvidersIdEnum$inboundSchema` instead. */
+  export const inboundSchema = ProvidersIdEnum$inboundSchema;
+  /** @deprecated use `ProvidersIdEnum$outboundSchema` instead. */
+  export const outboundSchema = ProvidersIdEnum$outboundSchema;
+}

package/src/models/components/replycallback.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ReplyCallback = {
+  /**
+   * Indicates whether the reply callback is active.
+   */
+  active?: boolean | undefined;
+  /**
+   * The URL to which replies should be sent.
+   */
+  url?: string | undefined;
+};
+
+/** @internal */
+export const ReplyCallback$inboundSchema: z.ZodType<
+  ReplyCallback,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  active: z.boolean().optional(),
+  url: z.string().optional(),
+});
+
+/** @internal */
+export type ReplyCallback$Outbound = {
+  active?: boolean | undefined;
+  url?: string | undefined;
+};
+
+/** @internal */
+export const ReplyCallback$outboundSchema: z.ZodType<
+  ReplyCallback$Outbound,
+  z.ZodTypeDef,
+  ReplyCallback
+> = z.object({
+  active: z.boolean().optional(),
+  url: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ReplyCallback$ {
+  /** @deprecated use `ReplyCallback$inboundSchema` instead. */
+  export const inboundSchema = ReplyCallback$inboundSchema;
+  /** @deprecated use `ReplyCallback$outboundSchema` instead. */
+  export const outboundSchema = ReplyCallback$outboundSchema;
+  /** @deprecated use `ReplyCallback$Outbound` instead. */
+  export type Outbound = ReplyCallback$Outbound;
+}
+
+export function replyCallbackToJSON(replyCallback: ReplyCallback): string {
+  return JSON.stringify(ReplyCallback$outboundSchema.parse(replyCallback));
+}
+
+export function replyCallbackFromJSON(
+  jsonString: string,
+): SafeParseResult<ReplyCallback, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReplyCallback$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReplyCallback' from JSON`,
+  );
+}