@novu/api 0.0.1-alpha.99 → 0.0.2

package/src/models/components/buttontypeenum.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Type of button for the action result
+ */
+export const ButtonTypeEnum = {
+  Primary: "primary",
+  Secondary: "secondary",
+} as const;
+/**
+ * Type of button for the action result
+ */
+export type ButtonTypeEnum = ClosedEnum<typeof ButtonTypeEnum>;
+
+/** @internal */
+export const ButtonTypeEnum$inboundSchema: z.ZodNativeEnum<
+  typeof ButtonTypeEnum
+> = z.nativeEnum(ButtonTypeEnum);
+
+/** @internal */
+export const ButtonTypeEnum$outboundSchema: z.ZodNativeEnum<
+  typeof ButtonTypeEnum
+> = ButtonTypeEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ButtonTypeEnum$ {
+  /** @deprecated use `ButtonTypeEnum$inboundSchema` instead. */
+  export const inboundSchema = ButtonTypeEnum$inboundSchema;
+  /** @deprecated use `ButtonTypeEnum$outboundSchema` instead. */
+  export const outboundSchema = ButtonTypeEnum$outboundSchema;
+}

package/src/models/components/channelcredentials.ts

@@ -9,35 +9,35 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ChannelCredentials = {
   /**
-   * Webhook url used by chat app integrations. The webhook should be obtained from the chat app provider.
+   * Webhook URL used by chat app integrations. The webhook should be obtained from the chat app provider.
    */
-  webhookUrl: string;
+  webhookUrl?: string | undefined;
   /**
-   * Channel specification for Mattermost chat notifications
+   * 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
+   * Contains an array of the subscriber device tokens for a given provider. Used on Push integrations.
    */
   deviceTokens?: Array<string> | undefined;
   /**
-   * alert_uid for grafana on-call webhook payload
+   * Alert UID for Grafana on-call webhook payload.
    */
   alertUid?: string | undefined;
   /**
-   * title to be used with grafana on call webhook
+   * Title to be used with Grafana on-call webhook.
    */
   title?: string | undefined;
   /**
-   * image_url property fo grafana on call webhook
+   * Image URL property for Grafana on-call webhook.
    */
   imageUrl?: string | undefined;
   /**
-   * state property fo grafana on call webhook
+   * State property for Grafana on-call webhook.
    */
   state?: string | undefined;
   /**
-   * link_to_upstream_details property fo grafana on call webhook
+   * Link to upstream details property for Grafana on-call webhook.
    */
   externalUrl?: string | undefined;
 };
@@ -48,7 +48,7 @@ export const ChannelCredentials$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  webhookUrl: z.string(),
+  webhookUrl: z.string().optional(),
   channel: z.string().optional(),
   deviceTokens: z.array(z.string()).optional(),
   alertUid: z.string().optional(),
@@ -60,7 +60,7 @@ export const ChannelCredentials$inboundSchema: z.ZodType<
 
 /** @internal */
 export type ChannelCredentials$Outbound = {
-  webhookUrl: string;
+  webhookUrl?: string | undefined;
   channel?: string | undefined;
   deviceTokens?: Array<string> | undefined;
   alertUid?: string | undefined;
@@ -76,7 +76,7 @@ export const ChannelCredentials$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ChannelCredentials
 > = z.object({
-  webhookUrl: z.string(),
+  webhookUrl: z.string().optional(),
   channel: z.string().optional(),
   deviceTokens: z.array(z.string()).optional(),
   alertUid: z.string().optional(),

package/src/models/components/channelctatypeenum.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Type of call to action
+ */
+export const ChannelCTATypeEnum = {
+  Redirect: "redirect",
+} as const;
+/**
+ * Type of call to action
+ */
+export type ChannelCTATypeEnum = ClosedEnum<typeof ChannelCTATypeEnum>;
+
+/** @internal */
+export const ChannelCTATypeEnum$inboundSchema: z.ZodNativeEnum<
+  typeof ChannelCTATypeEnum
+> = z.nativeEnum(ChannelCTATypeEnum);
+
+/** @internal */
+export const ChannelCTATypeEnum$outboundSchema: z.ZodNativeEnum<
+  typeof ChannelCTATypeEnum
+> = ChannelCTATypeEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ChannelCTATypeEnum$ {
+  /** @deprecated use `ChannelCTATypeEnum$inboundSchema` instead. */
+  export const inboundSchema = ChannelCTATypeEnum$inboundSchema;
+  /** @deprecated use `ChannelCTATypeEnum$outboundSchema` instead. */
+  export const outboundSchema = ChannelCTATypeEnum$outboundSchema;
+}

package/src/models/components/channelpreference.ts

@@ -4,63 +4,32 @@
 
 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 type of channel that is enabled or not
- */
-export const Type = {
-  InApp: "in_app",
-  Email: "email",
-  Sms: "sms",
-  Chat: "chat",
-  Push: "push",
-} as const;
-/**
- * The type of channel that is enabled or not
- */
-export type Type = ClosedEnum<typeof Type>;
+import {
+  ChannelTypeEnum,
+  ChannelTypeEnum$inboundSchema,
+  ChannelTypeEnum$outboundSchema,
+} from "./channeltypeenum.js";
 
 export type ChannelPreference = {
   /**
-   * The type of channel that is enabled or not
+   * Channel type through which the message is sent
    */
-  type: Type;
+  type: ChannelTypeEnum;
   /**
    * If channel is enabled or not
    */
   enabled: boolean;
 };
 
-/** @internal */
-export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
-  Type,
-);
-
-/** @internal */
-export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
-  Type$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Type$ {
-  /** @deprecated use `Type$inboundSchema` instead. */
-  export const inboundSchema = Type$inboundSchema;
-  /** @deprecated use `Type$outboundSchema` instead. */
-  export const outboundSchema = Type$outboundSchema;
-}
-
 /** @internal */
 export const ChannelPreference$inboundSchema: z.ZodType<
   ChannelPreference,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: Type$inboundSchema,
+  type: ChannelTypeEnum$inboundSchema,
   enabled: z.boolean(),
 });
 
@@ -76,7 +45,7 @@ export const ChannelPreference$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ChannelPreference
 > = z.object({
-  type: Type$outboundSchema,
+  type: ChannelTypeEnum$outboundSchema,
   enabled: z.boolean(),
 });
 

package/src/models/components/channeltypeenum.ts

@@ -6,7 +6,7 @@ import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
 /**
- * The channel through which the notification is sent.
+ * Channel type through which the message is sent
  */
 export const ChannelTypeEnum = {
   InApp: "in_app",
@@ -16,7 +16,7 @@ export const ChannelTypeEnum = {
   Push: "push",
 } as const;
 /**
- * The channel through which the notification is sent.
+ * Channel type through which the message is sent
  */
 export type ChannelTypeEnum = ClosedEnum<typeof ChannelTypeEnum>;
 

package/src/models/components/createdsubscriberdto.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 CreatedSubscriberDto = {
+  /**
+   * The ID of the subscriber that was created.
+   */
+  subscriberId: string;
+};
+
+/** @internal */
+export const CreatedSubscriberDto$inboundSchema: z.ZodType<
+  CreatedSubscriberDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  subscriberId: z.string(),
+});
+
+/** @internal */
+export type CreatedSubscriberDto$Outbound = {
+  subscriberId: string;
+};
+
+/** @internal */
+export const CreatedSubscriberDto$outboundSchema: z.ZodType<
+  CreatedSubscriberDto$Outbound,
+  z.ZodTypeDef,
+  CreatedSubscriberDto
+> = z.object({
+  subscriberId: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreatedSubscriberDto$ {
+  /** @deprecated use `CreatedSubscriberDto$inboundSchema` instead. */
+  export const inboundSchema = CreatedSubscriberDto$inboundSchema;
+  /** @deprecated use `CreatedSubscriberDto$outboundSchema` instead. */
+  export const outboundSchema = CreatedSubscriberDto$outboundSchema;
+  /** @deprecated use `CreatedSubscriberDto$Outbound` instead. */
+  export type Outbound = CreatedSubscriberDto$Outbound;
+}
+
+export function createdSubscriberDtoToJSON(
+  createdSubscriberDto: CreatedSubscriberDto,
+): string {
+  return JSON.stringify(
+    CreatedSubscriberDto$outboundSchema.parse(createdSubscriberDto),
+  );
+}
+
+export function createdSubscriberDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<CreatedSubscriberDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreatedSubscriberDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreatedSubscriberDto' from JSON`,
+  );
+}

package/src/models/components/createintegrationrequestdto.ts

@@ -15,11 +15,11 @@ import {
   CredentialsDto$outboundSchema,
 } from "./credentialsdto.js";
 import {
-  StepFilter,
-  StepFilter$inboundSchema,
-  StepFilter$Outbound,
-  StepFilter$outboundSchema,
-} from "./stepfilter.js";
+  StepFilterDto,
+  StepFilterDto$inboundSchema,
+  StepFilterDto$Outbound,
+  StepFilterDto$outboundSchema,
+} from "./stepfilterdto.js";
 
 /**
  * The channel type for the integration
@@ -74,7 +74,7 @@ export type CreateIntegrationRequestDto = {
   /**
    * Conditions for the integration
    */
-  conditions?: Array<StepFilter> | undefined;
+  conditions?: Array<StepFilterDto> | undefined;
 };
 
 /** @internal */
@@ -113,7 +113,7 @@ export const CreateIntegrationRequestDto$inboundSchema: z.ZodType<
   credentials: CredentialsDto$inboundSchema.optional(),
   active: z.boolean().optional(),
   check: z.boolean().optional(),
-  conditions: z.array(StepFilter$inboundSchema).optional(),
+  conditions: z.array(StepFilterDto$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "_environmentId": "environmentId",
@@ -130,7 +130,7 @@ export type CreateIntegrationRequestDto$Outbound = {
   credentials?: CredentialsDto$Outbound | undefined;
   active?: boolean | undefined;
   check?: boolean | undefined;
-  conditions?: Array<StepFilter$Outbound> | undefined;
+  conditions?: Array<StepFilterDto$Outbound> | undefined;
 };
 
 /** @internal */
@@ -147,7 +147,7 @@ export const CreateIntegrationRequestDto$outboundSchema: z.ZodType<
   credentials: CredentialsDto$outboundSchema.optional(),
   active: z.boolean().optional(),
   check: z.boolean().optional(),
-  conditions: z.array(StepFilter$outboundSchema).optional(),
+  conditions: z.array(StepFilterDto$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     environmentId: "_environmentId",

package/src/models/components/digestmetadatadto.ts

@@ -0,0 +1,185 @@
+/*
+ * 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";
+import {
+  DigestTimedConfigDto,
+  DigestTimedConfigDto$inboundSchema,
+  DigestTimedConfigDto$Outbound,
+  DigestTimedConfigDto$outboundSchema,
+} from "./digesttimedconfigdto.js";
+import {
+  DigestTypeEnum,
+  DigestTypeEnum$inboundSchema,
+  DigestTypeEnum$outboundSchema,
+} from "./digesttypeenum.js";
+import {
+  DigestUnitEnum,
+  DigestUnitEnum$inboundSchema,
+  DigestUnitEnum$outboundSchema,
+} from "./digestunitenum.js";
+
+/**
+ * Unit of the digest
+ */
+export const Unit = {
+  Seconds: "seconds",
+  Minutes: "minutes",
+  Hours: "hours",
+  Days: "days",
+  Weeks: "weeks",
+  Months: "months",
+} as const;
+/**
+ * Unit of the digest
+ */
+export type Unit = ClosedEnum<typeof Unit>;
+
+export type DigestMetadataDto = {
+  /**
+   * Optional key for the digest
+   */
+  digestKey?: string | undefined;
+  /**
+   * Amount for the digest
+   */
+  amount?: number | undefined;
+  /**
+   * Unit of the digest
+   */
+  unit?: Unit | undefined;
+  /**
+   * The Digest Type
+   */
+  type: DigestTypeEnum;
+  /**
+   * Optional array of events associated with the digest, represented as key-value pairs
+   */
+  events?: Array<{ [k: string]: any }> | undefined;
+  /**
+   * Regular digest: Indicates if backoff is enabled for the regular digest
+   */
+  backoff?: boolean | undefined;
+  /**
+   * Regular digest: Amount for backoff
+   */
+  backoffAmount?: number | undefined;
+  /**
+   * Regular digest: Unit for backoff
+   */
+  backoffUnit?: DigestUnitEnum | undefined;
+  /**
+   * Regular digest: Indicates if the digest should update
+   */
+  updateMode?: boolean | undefined;
+  /**
+   * Configuration for timed digest
+   */
+  timed?: DigestTimedConfigDto | undefined;
+};
+
+/** @internal */
+export const Unit$inboundSchema: z.ZodNativeEnum<typeof Unit> = z.nativeEnum(
+  Unit,
+);
+
+/** @internal */
+export const Unit$outboundSchema: z.ZodNativeEnum<typeof Unit> =
+  Unit$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Unit$ {
+  /** @deprecated use `Unit$inboundSchema` instead. */
+  export const inboundSchema = Unit$inboundSchema;
+  /** @deprecated use `Unit$outboundSchema` instead. */
+  export const outboundSchema = Unit$outboundSchema;
+}
+
+/** @internal */
+export const DigestMetadataDto$inboundSchema: z.ZodType<
+  DigestMetadataDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  digestKey: z.string().optional(),
+  amount: z.number().optional(),
+  unit: Unit$inboundSchema.optional(),
+  type: DigestTypeEnum$inboundSchema,
+  events: z.array(z.record(z.any())).optional(),
+  backoff: z.boolean().optional(),
+  backoffAmount: z.number().optional(),
+  backoffUnit: DigestUnitEnum$inboundSchema.optional(),
+  updateMode: z.boolean().optional(),
+  timed: DigestTimedConfigDto$inboundSchema.optional(),
+});
+
+/** @internal */
+export type DigestMetadataDto$Outbound = {
+  digestKey?: string | undefined;
+  amount?: number | undefined;
+  unit?: string | undefined;
+  type: string;
+  events?: Array<{ [k: string]: any }> | undefined;
+  backoff?: boolean | undefined;
+  backoffAmount?: number | undefined;
+  backoffUnit?: string | undefined;
+  updateMode?: boolean | undefined;
+  timed?: DigestTimedConfigDto$Outbound | undefined;
+};
+
+/** @internal */
+export const DigestMetadataDto$outboundSchema: z.ZodType<
+  DigestMetadataDto$Outbound,
+  z.ZodTypeDef,
+  DigestMetadataDto
+> = z.object({
+  digestKey: z.string().optional(),
+  amount: z.number().optional(),
+  unit: Unit$outboundSchema.optional(),
+  type: DigestTypeEnum$outboundSchema,
+  events: z.array(z.record(z.any())).optional(),
+  backoff: z.boolean().optional(),
+  backoffAmount: z.number().optional(),
+  backoffUnit: DigestUnitEnum$outboundSchema.optional(),
+  updateMode: z.boolean().optional(),
+  timed: DigestTimedConfigDto$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 DigestMetadataDto$ {
+  /** @deprecated use `DigestMetadataDto$inboundSchema` instead. */
+  export const inboundSchema = DigestMetadataDto$inboundSchema;
+  /** @deprecated use `DigestMetadataDto$outboundSchema` instead. */
+  export const outboundSchema = DigestMetadataDto$outboundSchema;
+  /** @deprecated use `DigestMetadataDto$Outbound` instead. */
+  export type Outbound = DigestMetadataDto$Outbound;
+}
+
+export function digestMetadataDtoToJSON(
+  digestMetadataDto: DigestMetadataDto,
+): string {
+  return JSON.stringify(
+    DigestMetadataDto$outboundSchema.parse(digestMetadataDto),
+  );
+}
+
+export function digestMetadataDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DigestMetadataDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DigestMetadataDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DigestMetadataDto' from JSON`,
+  );
+}

package/src/models/components/digestregularmetadata.ts

@@ -8,7 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export const Unit = {
+export const DigestRegularMetadataUnit = {
   Seconds: "seconds",
   Minutes: "minutes",
   Hours: "hours",
@@ -16,7 +16,9 @@ export const Unit = {
   Weeks: "weeks",
   Months: "months",
 } as const;
-export type Unit = ClosedEnum<typeof Unit>;
+export type DigestRegularMetadataUnit = ClosedEnum<
+  typeof DigestRegularMetadataUnit
+>;
 
 export const DigestRegularMetadataType = {
   Regular: "regular",
@@ -38,7 +40,7 @@ export type BackoffUnit = ClosedEnum<typeof BackoffUnit>;
 
 export type DigestRegularMetadata = {
   amount?: number | undefined;
-  unit?: Unit | undefined;
+  unit?: DigestRegularMetadataUnit | undefined;
   digestKey?: string | undefined;
   type: DigestRegularMetadataType;
   backoff?: boolean | undefined;
@@ -48,23 +50,24 @@ export type DigestRegularMetadata = {
 };
 
 /** @internal */
-export const Unit$inboundSchema: z.ZodNativeEnum<typeof Unit> = z.nativeEnum(
-  Unit,
-);
+export const DigestRegularMetadataUnit$inboundSchema: z.ZodNativeEnum<
+  typeof DigestRegularMetadataUnit
+> = z.nativeEnum(DigestRegularMetadataUnit);
 
 /** @internal */
-export const Unit$outboundSchema: z.ZodNativeEnum<typeof Unit> =
-  Unit$inboundSchema;
+export const DigestRegularMetadataUnit$outboundSchema: z.ZodNativeEnum<
+  typeof DigestRegularMetadataUnit
+> = DigestRegularMetadataUnit$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace Unit$ {
-  /** @deprecated use `Unit$inboundSchema` instead. */
-  export const inboundSchema = Unit$inboundSchema;
-  /** @deprecated use `Unit$outboundSchema` instead. */
-  export const outboundSchema = Unit$outboundSchema;
+export namespace DigestRegularMetadataUnit$ {
+  /** @deprecated use `DigestRegularMetadataUnit$inboundSchema` instead. */
+  export const inboundSchema = DigestRegularMetadataUnit$inboundSchema;
+  /** @deprecated use `DigestRegularMetadataUnit$outboundSchema` instead. */
+  export const outboundSchema = DigestRegularMetadataUnit$outboundSchema;
 }
 
 /** @internal */
@@ -114,7 +117,7 @@ export const DigestRegularMetadata$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   amount: z.number().optional(),
-  unit: Unit$inboundSchema.optional(),
+  unit: DigestRegularMetadataUnit$inboundSchema.optional(),
   digestKey: z.string().optional(),
   type: DigestRegularMetadataType$inboundSchema,
   backoff: z.boolean().optional(),
@@ -142,7 +145,7 @@ export const DigestRegularMetadata$outboundSchema: z.ZodType<
   DigestRegularMetadata
 > = z.object({
   amount: z.number().optional(),
-  unit: Unit$outboundSchema.optional(),
+  unit: DigestRegularMetadataUnit$outboundSchema.optional(),
   digestKey: z.string().optional(),
   type: DigestRegularMetadataType$outboundSchema,
   backoff: z.boolean().optional(),