@novu/api 2.6.5 → 3.11.0

package/src/models/operations/contextscontrollercreatecontext.ts

@@ -0,0 +1,86 @@
+/*
+ * 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 ContextsControllerCreateContextRequest = {
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  createContextRequestDto: components.CreateContextRequestDto;
+};
+
+export type ContextsControllerCreateContextResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.GetContextResponseDto;
+};
+
+/** @internal */
+export type ContextsControllerCreateContextRequest$Outbound = {
+  "idempotency-key"?: string | undefined;
+  CreateContextRequestDto: components.CreateContextRequestDto$Outbound;
+};
+
+/** @internal */
+export const ContextsControllerCreateContextRequest$outboundSchema: z.ZodType<
+  ContextsControllerCreateContextRequest$Outbound,
+  z.ZodTypeDef,
+  ContextsControllerCreateContextRequest
+> = z.object({
+  idempotencyKey: z.string().optional(),
+  createContextRequestDto: components.CreateContextRequestDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+    createContextRequestDto: "CreateContextRequestDto",
+  });
+});
+
+export function contextsControllerCreateContextRequestToJSON(
+  contextsControllerCreateContextRequest:
+    ContextsControllerCreateContextRequest,
+): string {
+  return JSON.stringify(
+    ContextsControllerCreateContextRequest$outboundSchema.parse(
+      contextsControllerCreateContextRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ContextsControllerCreateContextResponse$inboundSchema: z.ZodType<
+  ContextsControllerCreateContextResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.GetContextResponseDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+export function contextsControllerCreateContextResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ContextsControllerCreateContextResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ContextsControllerCreateContextResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ContextsControllerCreateContextResponse' from JSON`,
+  );
+}

package/src/models/operations/contextscontrollerdeletecontext.ts

@@ -0,0 +1,90 @@
+/*
+ * 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 ContextsControllerDeleteContextRequest = {
+  /**
+   * Context ID
+   */
+  id: string;
+  /**
+   * Context type
+   */
+  type: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type ContextsControllerDeleteContextResponse = {
+  headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export type ContextsControllerDeleteContextRequest$Outbound = {
+  id: string;
+  type: string;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const ContextsControllerDeleteContextRequest$outboundSchema: z.ZodType<
+  ContextsControllerDeleteContextRequest$Outbound,
+  z.ZodTypeDef,
+  ContextsControllerDeleteContextRequest
+> = z.object({
+  id: z.string(),
+  type: z.string(),
+  idempotencyKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+  });
+});
+
+export function contextsControllerDeleteContextRequestToJSON(
+  contextsControllerDeleteContextRequest:
+    ContextsControllerDeleteContextRequest,
+): string {
+  return JSON.stringify(
+    ContextsControllerDeleteContextRequest$outboundSchema.parse(
+      contextsControllerDeleteContextRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ContextsControllerDeleteContextResponse$inboundSchema: z.ZodType<
+  ContextsControllerDeleteContextResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+  });
+});
+
+export function contextsControllerDeleteContextResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ContextsControllerDeleteContextResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ContextsControllerDeleteContextResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ContextsControllerDeleteContextResponse' from JSON`,
+  );
+}

package/src/models/operations/contextscontrollergetcontext.ts

@@ -0,0 +1,88 @@
+/*
+ * 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 ContextsControllerGetContextRequest = {
+  /**
+   * Context ID
+   */
+  id: string;
+  /**
+   * Context type
+   */
+  type: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type ContextsControllerGetContextResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.GetContextResponseDto;
+};
+
+/** @internal */
+export type ContextsControllerGetContextRequest$Outbound = {
+  id: string;
+  type: string;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const ContextsControllerGetContextRequest$outboundSchema: z.ZodType<
+  ContextsControllerGetContextRequest$Outbound,
+  z.ZodTypeDef,
+  ContextsControllerGetContextRequest
+> = z.object({
+  id: z.string(),
+  type: z.string(),
+  idempotencyKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+  });
+});
+
+export function contextsControllerGetContextRequestToJSON(
+  contextsControllerGetContextRequest: ContextsControllerGetContextRequest,
+): string {
+  return JSON.stringify(
+    ContextsControllerGetContextRequest$outboundSchema.parse(
+      contextsControllerGetContextRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ContextsControllerGetContextResponse$inboundSchema: z.ZodType<
+  ContextsControllerGetContextResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.GetContextResponseDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+export function contextsControllerGetContextResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ContextsControllerGetContextResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ContextsControllerGetContextResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ContextsControllerGetContextResponse' from JSON`,
+  );
+}

package/src/models/operations/contextscontrollerlistcontexts.ts

@@ -0,0 +1,142 @@
+/*
+ * 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 OrderDirection = {
+  Asc: "ASC",
+  Desc: "DESC",
+} as const;
+/**
+ * Direction of sorting
+ */
+export type OrderDirection = ClosedEnum<typeof OrderDirection>;
+
+export type ContextsControllerListContextsRequest = {
+  /**
+   * 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
+   */
+  limit?: number | undefined;
+  /**
+   * Direction of sorting
+   */
+  orderDirection?: OrderDirection | undefined;
+  /**
+   * Field to order by
+   */
+  orderBy?: string | undefined;
+  /**
+   * Include cursor item in response
+   */
+  includeCursor?: boolean | undefined;
+  /**
+   * Filter contexts by id
+   */
+  id?: string | undefined;
+  /**
+   * Search contexts by type or id (supports partial matching across both fields)
+   */
+  search?: string | undefined;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type ContextsControllerListContextsResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.ListContextsResponseDto;
+};
+
+/** @internal */
+export const OrderDirection$outboundSchema: z.ZodNativeEnum<
+  typeof OrderDirection
+> = z.nativeEnum(OrderDirection);
+
+/** @internal */
+export type ContextsControllerListContextsRequest$Outbound = {
+  after?: string | undefined;
+  before?: string | undefined;
+  limit?: number | undefined;
+  orderDirection?: string | undefined;
+  orderBy?: string | undefined;
+  includeCursor?: boolean | undefined;
+  id?: string | undefined;
+  search?: string | undefined;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const ContextsControllerListContextsRequest$outboundSchema: z.ZodType<
+  ContextsControllerListContextsRequest$Outbound,
+  z.ZodTypeDef,
+  ContextsControllerListContextsRequest
+> = z.object({
+  after: z.string().optional(),
+  before: z.string().optional(),
+  limit: z.number().optional(),
+  orderDirection: OrderDirection$outboundSchema.optional(),
+  orderBy: z.string().optional(),
+  includeCursor: z.boolean().optional(),
+  id: z.string().optional(),
+  search: z.string().optional(),
+  idempotencyKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+  });
+});
+
+export function contextsControllerListContextsRequestToJSON(
+  contextsControllerListContextsRequest: ContextsControllerListContextsRequest,
+): string {
+  return JSON.stringify(
+    ContextsControllerListContextsRequest$outboundSchema.parse(
+      contextsControllerListContextsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ContextsControllerListContextsResponse$inboundSchema: z.ZodType<
+  ContextsControllerListContextsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.ListContextsResponseDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+export function contextsControllerListContextsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ContextsControllerListContextsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ContextsControllerListContextsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ContextsControllerListContextsResponse' from JSON`,
+  );
+}

package/src/models/operations/contextscontrollerupdatecontext.ts

@@ -0,0 +1,98 @@
+/*
+ * 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 ContextsControllerUpdateContextRequest = {
+  /**
+   * Context ID
+   */
+  id: string;
+  /**
+   * Context type
+   */
+  type: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  updateContextRequestDto: components.UpdateContextRequestDto;
+};
+
+export type ContextsControllerUpdateContextResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.GetContextResponseDto;
+};
+
+/** @internal */
+export type ContextsControllerUpdateContextRequest$Outbound = {
+  id: string;
+  type: string;
+  "idempotency-key"?: string | undefined;
+  UpdateContextRequestDto: components.UpdateContextRequestDto$Outbound;
+};
+
+/** @internal */
+export const ContextsControllerUpdateContextRequest$outboundSchema: z.ZodType<
+  ContextsControllerUpdateContextRequest$Outbound,
+  z.ZodTypeDef,
+  ContextsControllerUpdateContextRequest
+> = z.object({
+  id: z.string(),
+  type: z.string(),
+  idempotencyKey: z.string().optional(),
+  updateContextRequestDto: components.UpdateContextRequestDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+    updateContextRequestDto: "UpdateContextRequestDto",
+  });
+});
+
+export function contextsControllerUpdateContextRequestToJSON(
+  contextsControllerUpdateContextRequest:
+    ContextsControllerUpdateContextRequest,
+): string {
+  return JSON.stringify(
+    ContextsControllerUpdateContextRequest$outboundSchema.parse(
+      contextsControllerUpdateContextRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ContextsControllerUpdateContextResponse$inboundSchema: z.ZodType<
+  ContextsControllerUpdateContextResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.GetContextResponseDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+export function contextsControllerUpdateContextResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ContextsControllerUpdateContextResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ContextsControllerUpdateContextResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ContextsControllerUpdateContextResponse' from JSON`,
+  );
+}

package/src/models/operations/environmentscontrollergetenvironmenttags.ts

@@ -0,0 +1,90 @@
+/*
+ * 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 EnvironmentsControllerGetEnvironmentTagsRequest = {
+  /**
+   * Environment internal ID (MongoDB ObjectId) or identifier
+   */
+  environmentId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type EnvironmentsControllerGetEnvironmentTagsResponse = {
+  headers: { [k: string]: Array<string> };
+  result: Array<components.GetEnvironmentTagsDto>;
+};
+
+/** @internal */
+export type EnvironmentsControllerGetEnvironmentTagsRequest$Outbound = {
+  environmentId: string;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const EnvironmentsControllerGetEnvironmentTagsRequest$outboundSchema:
+  z.ZodType<
+    EnvironmentsControllerGetEnvironmentTagsRequest$Outbound,
+    z.ZodTypeDef,
+    EnvironmentsControllerGetEnvironmentTagsRequest
+  > = z.object({
+    environmentId: z.string(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
+  });
+
+export function environmentsControllerGetEnvironmentTagsRequestToJSON(
+  environmentsControllerGetEnvironmentTagsRequest:
+    EnvironmentsControllerGetEnvironmentTagsRequest,
+): string {
+  return JSON.stringify(
+    EnvironmentsControllerGetEnvironmentTagsRequest$outboundSchema.parse(
+      environmentsControllerGetEnvironmentTagsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const EnvironmentsControllerGetEnvironmentTagsResponse$inboundSchema:
+  z.ZodType<
+    EnvironmentsControllerGetEnvironmentTagsResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: z.array(components.GetEnvironmentTagsDto$inboundSchema),
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function environmentsControllerGetEnvironmentTagsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EnvironmentsControllerGetEnvironmentTagsResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EnvironmentsControllerGetEnvironmentTagsResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EnvironmentsControllerGetEnvironmentTagsResponse' from JSON`,
+  );
+}

package/src/models/operations/environmentscontrollerv1createenvironment.ts

@@ -0,0 +1,89 @@
+/*
+ * 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 EnvironmentsControllerV1CreateEnvironmentRequest = {
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  createEnvironmentRequestDto: components.CreateEnvironmentRequestDto;
+};
+
+export type EnvironmentsControllerV1CreateEnvironmentResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.EnvironmentResponseDto;
+};
+
+/** @internal */
+export type EnvironmentsControllerV1CreateEnvironmentRequest$Outbound = {
+  "idempotency-key"?: string | undefined;
+  CreateEnvironmentRequestDto: components.CreateEnvironmentRequestDto$Outbound;
+};
+
+/** @internal */
+export const EnvironmentsControllerV1CreateEnvironmentRequest$outboundSchema:
+  z.ZodType<
+    EnvironmentsControllerV1CreateEnvironmentRequest$Outbound,
+    z.ZodTypeDef,
+    EnvironmentsControllerV1CreateEnvironmentRequest
+  > = z.object({
+    idempotencyKey: z.string().optional(),
+    createEnvironmentRequestDto:
+      components.CreateEnvironmentRequestDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+      createEnvironmentRequestDto: "CreateEnvironmentRequestDto",
+    });
+  });
+
+export function environmentsControllerV1CreateEnvironmentRequestToJSON(
+  environmentsControllerV1CreateEnvironmentRequest:
+    EnvironmentsControllerV1CreateEnvironmentRequest,
+): string {
+  return JSON.stringify(
+    EnvironmentsControllerV1CreateEnvironmentRequest$outboundSchema.parse(
+      environmentsControllerV1CreateEnvironmentRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const EnvironmentsControllerV1CreateEnvironmentResponse$inboundSchema:
+  z.ZodType<
+    EnvironmentsControllerV1CreateEnvironmentResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.EnvironmentResponseDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function environmentsControllerV1CreateEnvironmentResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EnvironmentsControllerV1CreateEnvironmentResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EnvironmentsControllerV1CreateEnvironmentResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EnvironmentsControllerV1CreateEnvironmentResponse' from JSON`,
+  );
+}