@novu/api 3.11.0 → 3.11.2

package/src/models/operations/channelconnectionscontrollerdeletechannelconnection.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ChannelConnectionsControllerDeleteChannelConnectionRequest = {
+  /**
+   * The unique identifier of the channel connection
+   */
+  identifier: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type ChannelConnectionsControllerDeleteChannelConnectionResponse = {
+  headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export type ChannelConnectionsControllerDeleteChannelConnectionRequest$Outbound =
+  {
+    identifier: string;
+    "idempotency-key"?: string | undefined;
+  };
+
+/** @internal */
+export const ChannelConnectionsControllerDeleteChannelConnectionRequest$outboundSchema:
+  z.ZodType<
+    ChannelConnectionsControllerDeleteChannelConnectionRequest$Outbound,
+    z.ZodTypeDef,
+    ChannelConnectionsControllerDeleteChannelConnectionRequest
+  > = z.object({
+    identifier: z.string(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
+  });
+
+export function channelConnectionsControllerDeleteChannelConnectionRequestToJSON(
+  channelConnectionsControllerDeleteChannelConnectionRequest:
+    ChannelConnectionsControllerDeleteChannelConnectionRequest,
+): string {
+  return JSON.stringify(
+    ChannelConnectionsControllerDeleteChannelConnectionRequest$outboundSchema
+      .parse(channelConnectionsControllerDeleteChannelConnectionRequest),
+  );
+}
+
+/** @internal */
+export const ChannelConnectionsControllerDeleteChannelConnectionResponse$inboundSchema:
+  z.ZodType<
+    ChannelConnectionsControllerDeleteChannelConnectionResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+    });
+  });
+
+export function channelConnectionsControllerDeleteChannelConnectionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ChannelConnectionsControllerDeleteChannelConnectionResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ChannelConnectionsControllerDeleteChannelConnectionResponse$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'ChannelConnectionsControllerDeleteChannelConnectionResponse' from JSON`,
+  );
+}

package/src/models/operations/channelconnectionscontrollergetchannelconnectionbyidentifier.ts

@@ -0,0 +1,93 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ChannelConnectionsControllerGetChannelConnectionByIdentifierRequest =
+  {
+    /**
+     * The unique identifier of the channel connection
+     */
+    identifier: string;
+    /**
+     * A header for idempotency purposes
+     */
+    idempotencyKey?: string | undefined;
+  };
+
+export type ChannelConnectionsControllerGetChannelConnectionByIdentifierResponse =
+  {
+    headers: { [k: string]: Array<string> };
+    result: components.GetChannelConnectionResponseDto;
+  };
+
+/** @internal */
+export type ChannelConnectionsControllerGetChannelConnectionByIdentifierRequest$Outbound =
+  {
+    identifier: string;
+    "idempotency-key"?: string | undefined;
+  };
+
+/** @internal */
+export const ChannelConnectionsControllerGetChannelConnectionByIdentifierRequest$outboundSchema:
+  z.ZodType<
+    ChannelConnectionsControllerGetChannelConnectionByIdentifierRequest$Outbound,
+    z.ZodTypeDef,
+    ChannelConnectionsControllerGetChannelConnectionByIdentifierRequest
+  > = z.object({
+    identifier: z.string(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
+  });
+
+export function channelConnectionsControllerGetChannelConnectionByIdentifierRequestToJSON(
+  channelConnectionsControllerGetChannelConnectionByIdentifierRequest:
+    ChannelConnectionsControllerGetChannelConnectionByIdentifierRequest,
+): string {
+  return JSON.stringify(
+    ChannelConnectionsControllerGetChannelConnectionByIdentifierRequest$outboundSchema
+      .parse(
+        channelConnectionsControllerGetChannelConnectionByIdentifierRequest,
+      ),
+  );
+}
+
+/** @internal */
+export const ChannelConnectionsControllerGetChannelConnectionByIdentifierResponse$inboundSchema:
+  z.ZodType<
+    ChannelConnectionsControllerGetChannelConnectionByIdentifierResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.GetChannelConnectionResponseDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function channelConnectionsControllerGetChannelConnectionByIdentifierResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ChannelConnectionsControllerGetChannelConnectionByIdentifierResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ChannelConnectionsControllerGetChannelConnectionByIdentifierResponse$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'ChannelConnectionsControllerGetChannelConnectionByIdentifierResponse' from JSON`,
+  );
+}

package/src/models/operations/channelconnectionscontrollerlistchannelconnections.ts

@@ -0,0 +1,197 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Direction of sorting
+ */
+export const ChannelConnectionsControllerListChannelConnectionsQueryParamOrderDirection =
+  {
+    Asc: "ASC",
+    Desc: "DESC",
+  } as const;
+/**
+ * Direction of sorting
+ */
+export type ChannelConnectionsControllerListChannelConnectionsQueryParamOrderDirection =
+  ClosedEnum<
+    typeof ChannelConnectionsControllerListChannelConnectionsQueryParamOrderDirection
+  >;
+
+/**
+ * Filter by channel type (email, sms, push, chat, etc.).
+ */
+export const Channel = {
+  InApp: "in_app",
+  Email: "email",
+  Sms: "sms",
+  Chat: "chat",
+  Push: "push",
+} as const;
+/**
+ * Filter by channel type (email, sms, push, chat, etc.).
+ */
+export type Channel = ClosedEnum<typeof Channel>;
+
+export type ChannelConnectionsControllerListChannelConnectionsRequest = {
+  /**
+   * Cursor for pagination indicating the starting point after which to fetch results.
+   */
+  after?: string | undefined;
+  /**
+   * Cursor for pagination indicating the ending point before which to fetch results.
+   */
+  before?: string | undefined;
+  /**
+   * Limit the number of items to return (max 100)
+   */
+  limit?: number | undefined;
+  /**
+   * Direction of sorting
+   */
+  orderDirection?:
+    | ChannelConnectionsControllerListChannelConnectionsQueryParamOrderDirection
+    | undefined;
+  /**
+   * Field to order by
+   */
+  orderBy?: string | undefined;
+  /**
+   * Include cursor item in response
+   */
+  includeCursor?: boolean | undefined;
+  /**
+   * The subscriber ID to filter results by
+   */
+  subscriberId?: string | undefined;
+  /**
+   * Filter by channel type (email, sms, push, chat, etc.).
+   */
+  channel?: Channel | undefined;
+  /**
+   * Filter by provider identifier (e.g., sendgrid, twilio, slack, etc.).
+   */
+  providerId?: components.ProvidersIdEnum | undefined;
+  /**
+   * Filter by integration identifier.
+   */
+  integrationIdentifier?: string | undefined;
+  /**
+   * Filter by exact context keys, order insensitive (format: "type:id")
+   */
+  contextKeys?: Array<string> | undefined;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type ChannelConnectionsControllerListChannelConnectionsResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.ListChannelConnectionsResponseDto;
+};
+
+/** @internal */
+export const ChannelConnectionsControllerListChannelConnectionsQueryParamOrderDirection$outboundSchema:
+  z.ZodNativeEnum<
+    typeof ChannelConnectionsControllerListChannelConnectionsQueryParamOrderDirection
+  > = z.nativeEnum(
+    ChannelConnectionsControllerListChannelConnectionsQueryParamOrderDirection,
+  );
+
+/** @internal */
+export const Channel$outboundSchema: z.ZodNativeEnum<typeof Channel> = z
+  .nativeEnum(Channel);
+
+/** @internal */
+export type ChannelConnectionsControllerListChannelConnectionsRequest$Outbound =
+  {
+    after?: string | undefined;
+    before?: string | undefined;
+    limit?: number | undefined;
+    orderDirection?: string | undefined;
+    orderBy?: string | undefined;
+    includeCursor?: boolean | undefined;
+    subscriberId?: string | undefined;
+    channel?: string | undefined;
+    providerId?: string | undefined;
+    integrationIdentifier?: string | undefined;
+    contextKeys?: Array<string> | undefined;
+    "idempotency-key"?: string | undefined;
+  };
+
+/** @internal */
+export const ChannelConnectionsControllerListChannelConnectionsRequest$outboundSchema:
+  z.ZodType<
+    ChannelConnectionsControllerListChannelConnectionsRequest$Outbound,
+    z.ZodTypeDef,
+    ChannelConnectionsControllerListChannelConnectionsRequest
+  > = z.object({
+    after: z.string().optional(),
+    before: z.string().optional(),
+    limit: z.number().optional(),
+    orderDirection:
+      ChannelConnectionsControllerListChannelConnectionsQueryParamOrderDirection$outboundSchema
+        .optional(),
+    orderBy: z.string().optional(),
+    includeCursor: z.boolean().optional(),
+    subscriberId: z.string().optional(),
+    channel: Channel$outboundSchema.optional(),
+    providerId: components.ProvidersIdEnum$outboundSchema.optional(),
+    integrationIdentifier: z.string().optional(),
+    contextKeys: z.array(z.string()).optional(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
+  });
+
+export function channelConnectionsControllerListChannelConnectionsRequestToJSON(
+  channelConnectionsControllerListChannelConnectionsRequest:
+    ChannelConnectionsControllerListChannelConnectionsRequest,
+): string {
+  return JSON.stringify(
+    ChannelConnectionsControllerListChannelConnectionsRequest$outboundSchema
+      .parse(channelConnectionsControllerListChannelConnectionsRequest),
+  );
+}
+
+/** @internal */
+export const ChannelConnectionsControllerListChannelConnectionsResponse$inboundSchema:
+  z.ZodType<
+    ChannelConnectionsControllerListChannelConnectionsResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.ListChannelConnectionsResponseDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function channelConnectionsControllerListChannelConnectionsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ChannelConnectionsControllerListChannelConnectionsResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ChannelConnectionsControllerListChannelConnectionsResponse$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'ChannelConnectionsControllerListChannelConnectionsResponse' from JSON`,
+  );
+}

package/src/models/operations/channelconnectionscontrollerupdatechannelconnection.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ChannelConnectionsControllerUpdateChannelConnectionRequest = {
+  /**
+   * The unique identifier of the channel connection
+   */
+  identifier: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  updateChannelConnectionRequestDto:
+    components.UpdateChannelConnectionRequestDto;
+};
+
+export type ChannelConnectionsControllerUpdateChannelConnectionResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.GetChannelConnectionResponseDto;
+};
+
+/** @internal */
+export type ChannelConnectionsControllerUpdateChannelConnectionRequest$Outbound =
+  {
+    identifier: string;
+    "idempotency-key"?: string | undefined;
+    UpdateChannelConnectionRequestDto:
+      components.UpdateChannelConnectionRequestDto$Outbound;
+  };
+
+/** @internal */
+export const ChannelConnectionsControllerUpdateChannelConnectionRequest$outboundSchema:
+  z.ZodType<
+    ChannelConnectionsControllerUpdateChannelConnectionRequest$Outbound,
+    z.ZodTypeDef,
+    ChannelConnectionsControllerUpdateChannelConnectionRequest
+  > = z.object({
+    identifier: z.string(),
+    idempotencyKey: z.string().optional(),
+    updateChannelConnectionRequestDto:
+      components.UpdateChannelConnectionRequestDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+      updateChannelConnectionRequestDto: "UpdateChannelConnectionRequestDto",
+    });
+  });
+
+export function channelConnectionsControllerUpdateChannelConnectionRequestToJSON(
+  channelConnectionsControllerUpdateChannelConnectionRequest:
+    ChannelConnectionsControllerUpdateChannelConnectionRequest,
+): string {
+  return JSON.stringify(
+    ChannelConnectionsControllerUpdateChannelConnectionRequest$outboundSchema
+      .parse(channelConnectionsControllerUpdateChannelConnectionRequest),
+  );
+}
+
+/** @internal */
+export const ChannelConnectionsControllerUpdateChannelConnectionResponse$inboundSchema:
+  z.ZodType<
+    ChannelConnectionsControllerUpdateChannelConnectionResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.GetChannelConnectionResponseDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function channelConnectionsControllerUpdateChannelConnectionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ChannelConnectionsControllerUpdateChannelConnectionResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ChannelConnectionsControllerUpdateChannelConnectionResponse$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'ChannelConnectionsControllerUpdateChannelConnectionResponse' from JSON`,
+  );
+}

package/src/models/operations/channelendpointscontrollercreatechannelendpoint.ts

@@ -0,0 +1,154 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Channel endpoint creation request. The structure varies based on the type field.
+ */
+export type ChannelEndpointsControllerCreateChannelEndpointRequestBody =
+  | components.CreateSlackChannelEndpointDto
+  | components.CreateSlackUserEndpointDto
+  | components.CreateWebhookEndpointDto
+  | components.CreatePhoneEndpointDto
+  | components.CreateMsTeamsChannelEndpointDto
+  | components.CreateMsTeamsUserEndpointDto;
+
+export type ChannelEndpointsControllerCreateChannelEndpointRequest = {
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  /**
+   * Channel endpoint creation request. The structure varies based on the type field.
+   */
+  requestBody:
+    | components.CreateSlackChannelEndpointDto
+    | components.CreateSlackUserEndpointDto
+    | components.CreateWebhookEndpointDto
+    | components.CreatePhoneEndpointDto
+    | components.CreateMsTeamsChannelEndpointDto
+    | components.CreateMsTeamsUserEndpointDto;
+};
+
+export type ChannelEndpointsControllerCreateChannelEndpointResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.GetChannelEndpointResponseDto;
+};
+
+/** @internal */
+export type ChannelEndpointsControllerCreateChannelEndpointRequestBody$Outbound =
+  | components.CreateSlackChannelEndpointDto$Outbound
+  | components.CreateSlackUserEndpointDto$Outbound
+  | components.CreateWebhookEndpointDto$Outbound
+  | components.CreatePhoneEndpointDto$Outbound
+  | components.CreateMsTeamsChannelEndpointDto$Outbound
+  | components.CreateMsTeamsUserEndpointDto$Outbound;
+
+/** @internal */
+export const ChannelEndpointsControllerCreateChannelEndpointRequestBody$outboundSchema:
+  z.ZodType<
+    ChannelEndpointsControllerCreateChannelEndpointRequestBody$Outbound,
+    z.ZodTypeDef,
+    ChannelEndpointsControllerCreateChannelEndpointRequestBody
+  > = z.union([
+    components.CreateSlackChannelEndpointDto$outboundSchema,
+    components.CreateSlackUserEndpointDto$outboundSchema,
+    components.CreateWebhookEndpointDto$outboundSchema,
+    components.CreatePhoneEndpointDto$outboundSchema,
+    components.CreateMsTeamsChannelEndpointDto$outboundSchema,
+    components.CreateMsTeamsUserEndpointDto$outboundSchema,
+  ]);
+
+export function channelEndpointsControllerCreateChannelEndpointRequestBodyToJSON(
+  channelEndpointsControllerCreateChannelEndpointRequestBody:
+    ChannelEndpointsControllerCreateChannelEndpointRequestBody,
+): string {
+  return JSON.stringify(
+    ChannelEndpointsControllerCreateChannelEndpointRequestBody$outboundSchema
+      .parse(channelEndpointsControllerCreateChannelEndpointRequestBody),
+  );
+}
+
+/** @internal */
+export type ChannelEndpointsControllerCreateChannelEndpointRequest$Outbound = {
+  "idempotency-key"?: string | undefined;
+  RequestBody:
+    | components.CreateSlackChannelEndpointDto$Outbound
+    | components.CreateSlackUserEndpointDto$Outbound
+    | components.CreateWebhookEndpointDto$Outbound
+    | components.CreatePhoneEndpointDto$Outbound
+    | components.CreateMsTeamsChannelEndpointDto$Outbound
+    | components.CreateMsTeamsUserEndpointDto$Outbound;
+};
+
+/** @internal */
+export const ChannelEndpointsControllerCreateChannelEndpointRequest$outboundSchema:
+  z.ZodType<
+    ChannelEndpointsControllerCreateChannelEndpointRequest$Outbound,
+    z.ZodTypeDef,
+    ChannelEndpointsControllerCreateChannelEndpointRequest
+  > = z.object({
+    idempotencyKey: z.string().optional(),
+    requestBody: z.union([
+      components.CreateSlackChannelEndpointDto$outboundSchema,
+      components.CreateSlackUserEndpointDto$outboundSchema,
+      components.CreateWebhookEndpointDto$outboundSchema,
+      components.CreatePhoneEndpointDto$outboundSchema,
+      components.CreateMsTeamsChannelEndpointDto$outboundSchema,
+      components.CreateMsTeamsUserEndpointDto$outboundSchema,
+    ]),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+      requestBody: "RequestBody",
+    });
+  });
+
+export function channelEndpointsControllerCreateChannelEndpointRequestToJSON(
+  channelEndpointsControllerCreateChannelEndpointRequest:
+    ChannelEndpointsControllerCreateChannelEndpointRequest,
+): string {
+  return JSON.stringify(
+    ChannelEndpointsControllerCreateChannelEndpointRequest$outboundSchema.parse(
+      channelEndpointsControllerCreateChannelEndpointRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ChannelEndpointsControllerCreateChannelEndpointResponse$inboundSchema:
+  z.ZodType<
+    ChannelEndpointsControllerCreateChannelEndpointResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.GetChannelEndpointResponseDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function channelEndpointsControllerCreateChannelEndpointResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ChannelEndpointsControllerCreateChannelEndpointResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ChannelEndpointsControllerCreateChannelEndpointResponse$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'ChannelEndpointsControllerCreateChannelEndpointResponse' from JSON`,
+  );
+}