@novu/api 3.14.2 → 3.14.4

package/src/models/operations/subscriberscontrollersnoozenotification.ts

@@ -0,0 +1,108 @@
+/*
+ * 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 SubscribersControllerSnoozeNotificationRequest = {
+  /**
+   * The identifier of the subscriber
+   */
+  subscriberId: string;
+  /**
+   * The identifier of the notification
+   */
+  notificationId: string;
+  /**
+   * Context keys for filtering
+   */
+  contextKeys?: Array<string> | undefined;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  snoozeSubscriberNotificationDto: components.SnoozeSubscriberNotificationDto;
+};
+
+export type SubscribersControllerSnoozeNotificationResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.InboxNotificationDto;
+};
+
+/** @internal */
+export type SubscribersControllerSnoozeNotificationRequest$Outbound = {
+  subscriberId: string;
+  notificationId: string;
+  contextKeys?: Array<string> | undefined;
+  "idempotency-key"?: string | undefined;
+  SnoozeSubscriberNotificationDto:
+    components.SnoozeSubscriberNotificationDto$Outbound;
+};
+
+/** @internal */
+export const SubscribersControllerSnoozeNotificationRequest$outboundSchema:
+  z.ZodType<
+    SubscribersControllerSnoozeNotificationRequest$Outbound,
+    z.ZodTypeDef,
+    SubscribersControllerSnoozeNotificationRequest
+  > = z.object({
+    subscriberId: z.string(),
+    notificationId: z.string(),
+    contextKeys: z.array(z.string()).optional(),
+    idempotencyKey: z.string().optional(),
+    snoozeSubscriberNotificationDto:
+      components.SnoozeSubscriberNotificationDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+      snoozeSubscriberNotificationDto: "SnoozeSubscriberNotificationDto",
+    });
+  });
+
+export function subscribersControllerSnoozeNotificationRequestToJSON(
+  subscribersControllerSnoozeNotificationRequest:
+    SubscribersControllerSnoozeNotificationRequest,
+): string {
+  return JSON.stringify(
+    SubscribersControllerSnoozeNotificationRequest$outboundSchema.parse(
+      subscribersControllerSnoozeNotificationRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const SubscribersControllerSnoozeNotificationResponse$inboundSchema:
+  z.ZodType<
+    SubscribersControllerSnoozeNotificationResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.InboxNotificationDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function subscribersControllerSnoozeNotificationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SubscribersControllerSnoozeNotificationResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscribersControllerSnoozeNotificationResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SubscribersControllerSnoozeNotificationResponse' from JSON`,
+  );
+}

package/src/models/operations/subscriberscontrollerunarchivenotification.ts

@@ -0,0 +1,102 @@
+/*
+ * 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 SubscribersControllerUnarchiveNotificationRequest = {
+  /**
+   * The identifier of the subscriber
+   */
+  subscriberId: string;
+  /**
+   * The identifier of the notification
+   */
+  notificationId: string;
+  /**
+   * Context keys for filtering
+   */
+  contextKeys?: Array<string> | undefined;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type SubscribersControllerUnarchiveNotificationResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.InboxNotificationDto;
+};
+
+/** @internal */
+export type SubscribersControllerUnarchiveNotificationRequest$Outbound = {
+  subscriberId: string;
+  notificationId: string;
+  contextKeys?: Array<string> | undefined;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const SubscribersControllerUnarchiveNotificationRequest$outboundSchema:
+  z.ZodType<
+    SubscribersControllerUnarchiveNotificationRequest$Outbound,
+    z.ZodTypeDef,
+    SubscribersControllerUnarchiveNotificationRequest
+  > = z.object({
+    subscriberId: z.string(),
+    notificationId: z.string(),
+    contextKeys: z.array(z.string()).optional(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
+  });
+
+export function subscribersControllerUnarchiveNotificationRequestToJSON(
+  subscribersControllerUnarchiveNotificationRequest:
+    SubscribersControllerUnarchiveNotificationRequest,
+): string {
+  return JSON.stringify(
+    SubscribersControllerUnarchiveNotificationRequest$outboundSchema.parse(
+      subscribersControllerUnarchiveNotificationRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const SubscribersControllerUnarchiveNotificationResponse$inboundSchema:
+  z.ZodType<
+    SubscribersControllerUnarchiveNotificationResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.InboxNotificationDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function subscribersControllerUnarchiveNotificationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SubscribersControllerUnarchiveNotificationResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscribersControllerUnarchiveNotificationResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SubscribersControllerUnarchiveNotificationResponse' from JSON`,
+  );
+}

package/src/models/operations/subscriberscontrollerunsnoozenotification.ts

@@ -0,0 +1,102 @@
+/*
+ * 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 SubscribersControllerUnsnoozeNotificationRequest = {
+  /**
+   * The identifier of the subscriber
+   */
+  subscriberId: string;
+  /**
+   * The identifier of the notification
+   */
+  notificationId: string;
+  /**
+   * Context keys for filtering
+   */
+  contextKeys?: Array<string> | undefined;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type SubscribersControllerUnsnoozeNotificationResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.InboxNotificationDto;
+};
+
+/** @internal */
+export type SubscribersControllerUnsnoozeNotificationRequest$Outbound = {
+  subscriberId: string;
+  notificationId: string;
+  contextKeys?: Array<string> | undefined;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const SubscribersControllerUnsnoozeNotificationRequest$outboundSchema:
+  z.ZodType<
+    SubscribersControllerUnsnoozeNotificationRequest$Outbound,
+    z.ZodTypeDef,
+    SubscribersControllerUnsnoozeNotificationRequest
+  > = z.object({
+    subscriberId: z.string(),
+    notificationId: z.string(),
+    contextKeys: z.array(z.string()).optional(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
+  });
+
+export function subscribersControllerUnsnoozeNotificationRequestToJSON(
+  subscribersControllerUnsnoozeNotificationRequest:
+    SubscribersControllerUnsnoozeNotificationRequest,
+): string {
+  return JSON.stringify(
+    SubscribersControllerUnsnoozeNotificationRequest$outboundSchema.parse(
+      subscribersControllerUnsnoozeNotificationRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const SubscribersControllerUnsnoozeNotificationResponse$inboundSchema:
+  z.ZodType<
+    SubscribersControllerUnsnoozeNotificationResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.InboxNotificationDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function subscribersControllerUnsnoozeNotificationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SubscribersControllerUnsnoozeNotificationResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscribersControllerUnsnoozeNotificationResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SubscribersControllerUnsnoozeNotificationResponse' from JSON`,
+  );
+}

package/src/models/operations/subscriberscontrollerupdatesubscriberpreferences.ts

@@ -10,6 +10,9 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SubscribersControllerUpdateSubscriberPreferencesRequest = {
+  /**
+   * The identifier of the subscriber
+   */
   subscriberId: string;
   /**
    * A header for idempotency purposes

package/src/models/operations/workflowcontrollergeneratepreview.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 WorkflowControllerGeneratePreviewRequest = {
+  workflowId: string;
+  stepId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  /**
+   * Preview generation details
+   */
+  generatePreviewRequestDto: components.GeneratePreviewRequestDto;
+};
+
+export type WorkflowControllerGeneratePreviewResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.GeneratePreviewResponseDto;
+};
+
+/** @internal */
+export type WorkflowControllerGeneratePreviewRequest$Outbound = {
+  workflowId: string;
+  stepId: string;
+  "idempotency-key"?: string | undefined;
+  GeneratePreviewRequestDto: components.GeneratePreviewRequestDto$Outbound;
+};
+
+/** @internal */
+export const WorkflowControllerGeneratePreviewRequest$outboundSchema: z.ZodType<
+  WorkflowControllerGeneratePreviewRequest$Outbound,
+  z.ZodTypeDef,
+  WorkflowControllerGeneratePreviewRequest
+> = z.object({
+  workflowId: z.string(),
+  stepId: z.string(),
+  idempotencyKey: z.string().optional(),
+  generatePreviewRequestDto:
+    components.GeneratePreviewRequestDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+    generatePreviewRequestDto: "GeneratePreviewRequestDto",
+  });
+});
+
+export function workflowControllerGeneratePreviewRequestToJSON(
+  workflowControllerGeneratePreviewRequest:
+    WorkflowControllerGeneratePreviewRequest,
+): string {
+  return JSON.stringify(
+    WorkflowControllerGeneratePreviewRequest$outboundSchema.parse(
+      workflowControllerGeneratePreviewRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const WorkflowControllerGeneratePreviewResponse$inboundSchema: z.ZodType<
+  WorkflowControllerGeneratePreviewResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.GeneratePreviewResponseDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+export function workflowControllerGeneratePreviewResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  WorkflowControllerGeneratePreviewResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      WorkflowControllerGeneratePreviewResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'WorkflowControllerGeneratePreviewResponse' from JSON`,
+  );
+}

package/src/sdk/environmentvariables.ts

@@ -0,0 +1,147 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { environmentVariablesCreate } from "../funcs/environmentVariablesCreate.js";
+import { environmentVariablesDelete } from "../funcs/environmentVariablesDelete.js";
+import { environmentVariablesList } from "../funcs/environmentVariablesList.js";
+import { environmentVariablesRetrieve } from "../funcs/environmentVariablesRetrieve.js";
+import { environmentVariablesUpdate } from "../funcs/environmentVariablesUpdate.js";
+import { environmentVariablesUsage } from "../funcs/environmentVariablesUsage.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class EnvironmentVariables extends ClientSDK {
+  /**
+   * List all variables
+   *
+   * @remarks
+   * Returns all environment variables for the current organization. Secret values are masked.
+   */
+  async list(
+    search?: string | undefined,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.EnvironmentVariablesControllerListEnvironmentVariablesResponse
+  > {
+    return unwrapAsync(environmentVariablesList(
+      this,
+      search,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Create a variable
+   *
+   * @remarks
+   * Creates a new environment variable. Keys must be uppercase with underscores only (e.g. BASE_URL). Secret variables are encrypted at rest and masked in API responses.
+   */
+  async create(
+    createEnvironmentVariableRequestDto:
+      components.CreateEnvironmentVariableRequestDto,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.EnvironmentVariablesControllerCreateEnvironmentVariableResponse
+  > {
+    return unwrapAsync(environmentVariablesCreate(
+      this,
+      createEnvironmentVariableRequestDto,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a variable
+   *
+   * @remarks
+   * Returns a single environment variable by id. Secret values are masked.
+   */
+  async retrieve(
+    variableId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.EnvironmentVariablesControllerGetEnvironmentVariableResponse
+  > {
+    return unwrapAsync(environmentVariablesRetrieve(
+      this,
+      variableId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Update a variable
+   *
+   * @remarks
+   * Updates an existing environment variable. Providing values replaces all existing per-environment values.
+   */
+  async update(
+    updateEnvironmentVariableRequestDto:
+      components.UpdateEnvironmentVariableRequestDto,
+    variableId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.EnvironmentVariablesControllerUpdateEnvironmentVariableResponse
+  > {
+    return unwrapAsync(environmentVariablesUpdate(
+      this,
+      updateEnvironmentVariableRequestDto,
+      variableId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a variable
+   *
+   * @remarks
+   * Deletes an environment variable by id.
+   */
+  async delete(
+    variableId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    | operations.EnvironmentVariablesControllerDeleteEnvironmentVariableResponse
+    | undefined
+  > {
+    return unwrapAsync(environmentVariablesDelete(
+      this,
+      variableId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a variable usage
+   *
+   * @remarks
+   * Returns the workflows that reference this environment variable via `{{env.KEY}}` in their step controls. **variableId** is required.
+   */
+  async usage(
+    variableId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.EnvironmentVariablesControllerGetEnvironmentVariableUsageResponse
+  > {
+    return unwrapAsync(environmentVariablesUsage(
+      this,
+      variableId,
+      idempotencyKey,
+      options,
+    ));
+  }
+}