Update a workflow

export interface Response {
  /**
   * Name of the workflow
   */
  name: string;
  /**
   * Description of the workflow
   */
  description?: string;
  /**
   * Tags associated with the workflow
   *
   * @minItems 0
   */
  tags?: string[];
  /**
   * Whether the workflow is active
   */
  active?: boolean;
  /**
   * Enable or disable payload schema validation
   */
  validatePayload?: boolean;
  /**
   * The payload JSON Schema for the workflow
   */
  payloadSchema?: {
    [k: string]: unknown;
  } | null;
  /**
   * Enable or disable translations for this workflow
   */
  isTranslationEnabled?: boolean;
  /**
   * Unique identifier of the workflow
   */
  _id: string;
  /**
   * Workflow identifier
   */
  workflowId: string;
  /**
   * Slug of the workflow
   */
  slug: {};
  /**
   * Last updated timestamp
   */
  updatedAt: string;
  /**
   * Creation timestamp
   */
  createdAt: string;
  /**
   * User who last updated the workflow
   */
  updatedBy?: UserResponseDto;
  /**
   * Steps of the workflow
   *
   * @minItems 0
   */
  steps: (
    | InAppStepResponseDto
    | EmailStepResponseDto
    | SmsStepResponseDto
    | PushStepResponseDto
    | ChatStepResponseDto
    | DelayStepResponseDto
    | DigestStepResponseDto
    | CustomStepResponseDto
  )[];
  /**
   * Origin of the workflow
   */
  origin: "novu-cloud" | "novu-cloud-v1" | "external";
  /**
   * Preferences for the workflow
   */
  preferences: WorkflowPreferencesResponseDto;
  /**
   * Status of the workflow
   */
  status: "ACTIVE" | "INACTIVE" | "ERROR";
  /**
   * Runtime issues for workflow creation and update
   */
  issues?: {
    [k: string]: RuntimeIssueDto;
  };
  /**
   * Timestamp of the last workflow trigger
   */
  lastTriggeredAt?: string | null;
  /**
   * Generated payload example based on the payload schema
   */
  payloadExample?: {
    [k: string]: unknown;
  } | null;
}
export interface UserResponseDto {
  /**
   * User ID
   */
  _id: string;
  /**
   * User first name
   */
  firstName?: string | null;
  /**
   * User last name
   */
  lastName?: {} | null;
  /**
   * User external ID
   */
  externalId?: string | null;
}
export interface InAppStepResponseDto {
  /**
   * Controls metadata for the in-app step
   */
  controls: InAppControlsMetadataResponseDto;
  /**
   * Control values for the in-app step
   */
  controlValues?: InAppControlDto1;
  /**
   * JSON Schema for variables, follows the JSON Schema standard
   */
  variables: {
    [k: string]: unknown;
  };
  /**
   * Unique identifier of the step
   */
  stepId: string;
  /**
   * Database identifier of the step
   */
  _id: string;
  /**
   * Name of the step
   */
  name: string;
  /**
   * Slug of the step
   */
  slug: {};
  /**
   * Type of the step
   */
  type: "in_app" | "email" | "sms" | "chat" | "push" | "digest" | "trigger" | "delay" | "custom";
  /**
   * Origin of the workflow
   */
  origin: "novu-cloud" | "novu-cloud-v1" | "external";
  /**
   * Workflow identifier
   */
  workflowId: string;
  /**
   * Workflow database identifier
   */
  workflowDatabaseId: string;
  /**
   * Issues associated with the step
   */
  issues?: StepIssuesDto;
}
export interface InAppControlsMetadataResponseDto {
  /**
   * JSON Schema for data
   */
  dataSchema?: {
    [k: string]: unknown;
  };
  /**
   * UI Schema for rendering
   */
  uiSchema?: UiSchema;
  /**
   * Control values specific to In-App
   */
  values: InAppControlDto;
}
export interface UiSchema {
  /**
   * Group of the UI Schema
   */
  group?: "IN_APP" | "EMAIL" | "DIGEST" | "DELAY" | "SMS" | "CHAT" | "PUSH" | "SKIP" | "LAYOUT";
  /**
   * Properties of the UI Schema
   */
  properties?: {
    [k: string]: UiSchemaProperty;
  };
}
export interface UiSchemaProperty {
  /**
   * Placeholder for the UI Schema Property
   */
  placeholder?:
    | string
    | number
    | boolean
    | {
        [k: string]: unknown;
      }
    | (
        | string
        | number
        | boolean
        | {
            [k: string]: unknown;
          }
      )[];
  /**
   * Component type for the UI Schema Property
   */
  component:
    | "EMAIL_EDITOR_SELECT"
    | "LAYOUT_SELECT"
    | "BLOCK_EDITOR"
    | "EMAIL_BODY"
    | "TEXT_FULL_LINE"
    | "TEXT_INLINE_LABEL"
    | "IN_APP_BODY"
    | "IN_APP_AVATAR"
    | "IN_APP_PRIMARY_SUBJECT"
    | "IN_APP_BUTTON_DROPDOWN"
    | "IN_APP_DISABLE_SANITIZATION_SWITCH"
    | "DISABLE_SANITIZATION_SWITCH"
    | "URL_TEXT_BOX"
    | "DIGEST_AMOUNT"
    | "DIGEST_UNIT"
    | "DIGEST_KEY"
    | "DIGEST_CRON"
    | "DELAY_TYPE"
    | "DELAY_AMOUNT"
    | "DELAY_UNIT"
    | "SMS_BODY"
    | "CHAT_BODY"
    | "PUSH_BODY"
    | "PUSH_SUBJECT"
    | "QUERY_EDITOR"
    | "DATA"
    | "LAYOUT_EMAIL";
  /**
   * Properties of the UI Schema
   */
  properties?: {
    [k: string]: UiSchemaProperty1;
  };
}
export interface UiSchemaProperty1 {
  /**
   * Placeholder for the UI Schema Property
   */
  placeholder?:
    | string
    | number
    | boolean
    | {
        [k: string]: unknown;
      }
    | (
        | string
        | number
        | boolean
        | {
            [k: string]: unknown;
          }
      )[];
  /**
   * Component type for the UI Schema Property
   */
  component:
    | "EMAIL_EDITOR_SELECT"
    | "LAYOUT_SELECT"
    | "BLOCK_EDITOR"
    | "EMAIL_BODY"
    | "TEXT_FULL_LINE"
    | "TEXT_INLINE_LABEL"
    | "IN_APP_BODY"
    | "IN_APP_AVATAR"
    | "IN_APP_PRIMARY_SUBJECT"
    | "IN_APP_BUTTON_DROPDOWN"
    | "IN_APP_DISABLE_SANITIZATION_SWITCH"
    | "DISABLE_SANITIZATION_SWITCH"
    | "URL_TEXT_BOX"
    | "DIGEST_AMOUNT"
    | "DIGEST_UNIT"
    | "DIGEST_KEY"
    | "DIGEST_CRON"
    | "DELAY_TYPE"
    | "DELAY_AMOUNT"
    | "DELAY_UNIT"
    | "SMS_BODY"
    | "CHAT_BODY"
    | "PUSH_BODY"
    | "PUSH_SUBJECT"
    | "QUERY_EDITOR"
    | "DATA"
    | "LAYOUT_EMAIL";
  /**
   * Properties of the UI Schema
   */
  properties?: {
    [k: string]: UiSchemaProperty1;
  };
}
export interface InAppControlDto {
  /**
   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
   */
  skip?: {
    [k: string]: unknown;
  };
  /**
   * Content/body of the in-app message. Required if subject is empty.
   */
  body?: string;
  /**
   * Subject/title of the in-app message. Required if body is empty.
   */
  subject?: string;
  /**
   * URL for an avatar image. Must be a valid URL or start with / or {{ variable }}.
   */
  avatar?: string;
  /**
   * Primary action button details.
   */
  primaryAction?: ActionDto;
  /**
   * Secondary action button details.
   */
  secondaryAction?: ActionDto1;
  /**
   * Redirection URL configuration for the main content click (if no actions defined/clicked)..
   */
  redirect?: RedirectDto1;
  /**
   * Disable sanitization of the output.
   */
  disableOutputSanitization?: boolean;
  /**
   * Additional data payload for the step.
   */
  data?: {
    [k: string]: unknown;
  };
}
export interface ActionDto {
  /**
   * Label for the action button.
   */
  label?: string;
  /**
   * Redirect configuration for the action.
   */
  redirect?: RedirectDto;
}
export interface RedirectDto {
  /**
   * URL for redirection. Must be a valid URL or start with / or {{ variable }}.
   */
  url?: string;
  /**
   * Target window for the redirection.
   */
  target?: "_self" | "_blank" | "_parent" | "_top" | "_unfencedTop";
}
export interface ActionDto1 {
  /**
   * Label for the action button.
   */
  label?: string;
  /**
   * Redirect configuration for the action.
   */
  redirect?: RedirectDto;
}
export interface RedirectDto1 {
  /**
   * URL for redirection. Must be a valid URL or start with / or {{ variable }}.
   */
  url?: string;
  /**
   * Target window for the redirection.
   */
  target?: "_self" | "_blank" | "_parent" | "_top" | "_unfencedTop";
}
export interface InAppControlDto1 {
  /**
   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
   */
  skip?: {
    [k: string]: unknown;
  };
  /**
   * Content/body of the in-app message. Required if subject is empty.
   */
  body?: string;
  /**
   * Subject/title of the in-app message. Required if body is empty.
   */
  subject?: string;
  /**
   * URL for an avatar image. Must be a valid URL or start with / or {{ variable }}.
   */
  avatar?: string;
  /**
   * Primary action button details.
   */
  primaryAction?: ActionDto;
  /**
   * Secondary action button details.
   */
  secondaryAction?: ActionDto1;
  /**
   * Redirection URL configuration for the main content click (if no actions defined/clicked)..
   */
  redirect?: RedirectDto1;
  /**
   * Disable sanitization of the output.
   */
  disableOutputSanitization?: boolean;
  /**
   * Additional data payload for the step.
   */
  data?: {
    [k: string]: unknown;
  };
}
export interface StepIssuesDto {
  /**
   * Controls-related issues
   */
  controls?: {
    /**
     * @minItems 0
     */
    [k: string]: StepContentIssueDto[];
  };
  /**
   * Integration-related issues
   */
  integration?: {
    /**
     * @minItems 0
     */
    [k: string]: StepIntegrationIssue[];
  };
}
export interface StepContentIssueDto {
  /**
   * Type of step content issue
   */
  issueType:
    | "ILLEGAL_VARIABLE_IN_CONTROL_VALUE"
    | "INVALID_FILTER_ARG_IN_VARIABLE"
    | "MISSING_VALUE"
    | "TIER_LIMIT_EXCEEDED";
  /**
   * Name of the variable related to the issue
   */
  variableName?: string;
  /**
   * Detailed message describing the issue
   */
  message: string;
}
export interface StepIntegrationIssue {
  /**
   * Type of integration issue
   */
  issueType: "MISSING_INTEGRATION";
  /**
   * Name of the variable related to the issue
   */
  variableName?: string;
  /**
   * Detailed message describing the issue
   */
  message: string;
}
export interface EmailStepResponseDto {
  /**
   * Controls metadata for the email step
   */
  controls: EmailControlsMetadataResponseDto;
  /**
   * Control values for the email step
   */
  controlValues?: EmailControlDto1;
  /**
   * JSON Schema for variables, follows the JSON Schema standard
   */
  variables: {
    [k: string]: unknown;
  };
  /**
   * Unique identifier of the step
   */
  stepId: string;
  /**
   * Database identifier of the step
   */
  _id: string;
  /**
   * Name of the step
   */
  name: string;
  /**
   * Slug of the step
   */
  slug: {};
  /**
   * Type of the step
   */
  type: "in_app" | "email" | "sms" | "chat" | "push" | "digest" | "trigger" | "delay" | "custom";
  /**
   * Origin of the workflow
   */
  origin: "novu-cloud" | "novu-cloud-v1" | "external";
  /**
   * Workflow identifier
   */
  workflowId: string;
  /**
   * Workflow database identifier
   */
  workflowDatabaseId: string;
  /**
   * Issues associated with the step
   */
  issues?: StepIssuesDto1;
}
export interface EmailControlsMetadataResponseDto {
  /**
   * JSON Schema for data
   */
  dataSchema?: {
    [k: string]: unknown;
  };
  /**
   * UI Schema for rendering
   */
  uiSchema?: UiSchema1;
  /**
   * Control values specific to Email
   */
  values: EmailControlDto;
}
export interface UiSchema1 {
  /**
   * Group of the UI Schema
   */
  group?: "IN_APP" | "EMAIL" | "DIGEST" | "DELAY" | "SMS" | "CHAT" | "PUSH" | "SKIP" | "LAYOUT";
  /**
   * Properties of the UI Schema
   */
  properties?: {
    [k: string]: UiSchemaProperty;
  };
}
export interface EmailControlDto {
  /**
   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
   */
  skip?: {
    [k: string]: unknown;
  };
  /**
   * Subject of the email.
   */
  subject: string;
  /**
   * Body content of the email, either a valid Maily JSON object, or html string.
   */
  body: string;
  /**
   * Type of editor to use for the body.
   */
  editorType?: "block" | "html";
  /**
   * Disable sanitization of the output.
   */
  disableOutputSanitization?: boolean;
  /**
   * Layout ID to use for the email. Null means no layout, undefined means default layout.
   */
  layoutId?: string | null;
}
export interface EmailControlDto1 {
  /**
   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
   */
  skip?: {
    [k: string]: unknown;
  };
  /**
   * Subject of the email.
   */
  subject: string;
  /**
   * Body content of the email, either a valid Maily JSON object, or html string.
   */
  body: string;
  /**
   * Type of editor to use for the body.
   */
  editorType?: "block" | "html";
  /**
   * Disable sanitization of the output.
   */
  disableOutputSanitization?: boolean;
  /**
   * Layout ID to use for the email. Null means no layout, undefined means default layout.
   */
  layoutId?: string | null;
}
export interface StepIssuesDto1 {
  /**
   * Controls-related issues
   */
  controls?: {
    /**
     * @minItems 0
     */
    [k: string]: StepContentIssueDto[];
  };
  /**
   * Integration-related issues
   */
  integration?: {
    /**
     * @minItems 0
     */
    [k: string]: StepIntegrationIssue[];
  };
}
export interface SmsStepResponseDto {
  /**
   * Controls metadata for the SMS step
   */
  controls: SmsControlsMetadataResponseDto;
  /**
   * Control values for the SMS step
   */
  controlValues?: SmsControlDto1;
  /**
   * JSON Schema for variables, follows the JSON Schema standard
   */
  variables: {
    [k: string]: unknown;
  };
  /**
   * Unique identifier of the step
   */
  stepId: string;
  /**
   * Database identifier of the step
   */
  _id: string;
  /**
   * Name of the step
   */
  name: string;
  /**
   * Slug of the step
   */
  slug: {};
  /**
   * Type of the step
   */
  type: "in_app" | "email" | "sms" | "chat" | "push" | "digest" | "trigger" | "delay" | "custom";
  /**
   * Origin of the workflow
   */
  origin: "novu-cloud" | "novu-cloud-v1" | "external";
  /**
   * Workflow identifier
   */
  workflowId: string;
  /**
   * Workflow database identifier
   */
  workflowDatabaseId: string;
  /**
   * Issues associated with the step
   */
  issues?: StepIssuesDto2;
}
export interface SmsControlsMetadataResponseDto {
  /**
   * JSON Schema for data
   */
  dataSchema?: {
    [k: string]: unknown;
  };
  /**
   * UI Schema for rendering
   */
  uiSchema?: UiSchema2;
  /**
   * Control values specific to SMS
   */
  values: SmsControlDto;
}
export interface UiSchema2 {
  /**
   * Group of the UI Schema
   */
  group?: "IN_APP" | "EMAIL" | "DIGEST" | "DELAY" | "SMS" | "CHAT" | "PUSH" | "SKIP" | "LAYOUT";
  /**
   * Properties of the UI Schema
   */
  properties?: {
    [k: string]: UiSchemaProperty;
  };
}
export interface SmsControlDto {
  /**
   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
   */
  skip?: {
    [k: string]: unknown;
  };
  /**
   * Content of the SMS message.
   */
  body?: string;
}
export interface SmsControlDto1 {
  /**
   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
   */
  skip?: {
    [k: string]: unknown;
  };
  /**
   * Content of the SMS message.
   */
  body?: string;
}
export interface StepIssuesDto2 {
  /**
   * Controls-related issues
   */
  controls?: {
    /**
     * @minItems 0
     */
    [k: string]: StepContentIssueDto[];
  };
  /**
   * Integration-related issues
   */
  integration?: {
    /**
     * @minItems 0
     */
    [k: string]: StepIntegrationIssue[];
  };
}
export interface PushStepResponseDto {
  /**
   * Controls metadata for the push step
   */
  controls: PushControlsMetadataResponseDto;
  /**
   * Control values for the push step
   */
  controlValues?: PushControlDto1;
  /**
   * JSON Schema for variables, follows the JSON Schema standard
   */
  variables: {
    [k: string]: unknown;
  };
  /**
   * Unique identifier of the step
   */
  stepId: string;
  /**
   * Database identifier of the step
   */
  _id: string;
  /**
   * Name of the step
   */
  name: string;
  /**
   * Slug of the step
   */
  slug: {};
  /**
   * Type of the step
   */
  type: "in_app" | "email" | "sms" | "chat" | "push" | "digest" | "trigger" | "delay" | "custom";
  /**
   * Origin of the workflow
   */
  origin: "novu-cloud" | "novu-cloud-v1" | "external";
  /**
   * Workflow identifier
   */
  workflowId: string;
  /**
   * Workflow database identifier
   */
  workflowDatabaseId: string;
  /**
   * Issues associated with the step
   */
  issues?: StepIssuesDto3;
}
export interface PushControlsMetadataResponseDto {
  /**
   * JSON Schema for data
   */
  dataSchema?: {
    [k: string]: unknown;
  };
  /**
   * UI Schema for rendering
   */
  uiSchema?: UiSchema3;
  /**
   * Control values specific to Push
   */
  values: PushControlDto;
}
export interface UiSchema3 {
  /**
   * Group of the UI Schema
   */
  group?: "IN_APP" | "EMAIL" | "DIGEST" | "DELAY" | "SMS" | "CHAT" | "PUSH" | "SKIP" | "LAYOUT";
  /**
   * Properties of the UI Schema
   */
  properties?: {
    [k: string]: UiSchemaProperty;
  };
}
export interface PushControlDto {
  /**
   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
   */
  skip?: {
    [k: string]: unknown;
  };
  /**
   * Subject/title of the push notification.
   */
  subject?: string;
  /**
   * Body content of the push notification.
   */
  body?: string;
}
export interface PushControlDto1 {
  /**
   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
   */
  skip?: {
    [k: string]: unknown;
  };
  /**
   * Subject/title of the push notification.
   */
  subject?: string;
  /**
   * Body content of the push notification.
   */
  body?: string;
}
export interface StepIssuesDto3 {
  /**
   * Controls-related issues
   */
  controls?: {
    /**
     * @minItems 0
     */
    [k: string]: StepContentIssueDto[];
  };
  /**
   * Integration-related issues
   */
  integration?: {
    /**
     * @minItems 0
     */
    [k: string]: StepIntegrationIssue[];
  };
}
export interface ChatStepResponseDto {
  /**
   * Controls metadata for the chat step
   */
  controls: ChatControlsMetadataResponseDto;
  /**
   * Control values for the chat step
   */
  controlValues?: ChatControlDto1;
  /**
   * JSON Schema for variables, follows the JSON Schema standard
   */
  variables: {
    [k: string]: unknown;
  };
  /**
   * Unique identifier of the step
   */
  stepId: string;
  /**
   * Database identifier of the step
   */
  _id: string;
  /**
   * Name of the step
   */
  name: string;
  /**
   * Slug of the step
   */
  slug: {};
  /**
   * Type of the step
   */
  type: "in_app" | "email" | "sms" | "chat" | "push" | "digest" | "trigger" | "delay" | "custom";
  /**
   * Origin of the workflow
   */
  origin: "novu-cloud" | "novu-cloud-v1" | "external";
  /**
   * Workflow identifier
   */
  workflowId: string;
  /**
   * Workflow database identifier
   */
  workflowDatabaseId: string;
  /**
   * Issues associated with the step
   */
  issues?: StepIssuesDto4;
}
export interface ChatControlsMetadataResponseDto {
  /**
   * JSON Schema for data
   */
  dataSchema?: {
    [k: string]: unknown;
  };
  /**
   * UI Schema for rendering
   */
  uiSchema?: UiSchema4;
  /**
   * Control values specific to Chat
   */
  values: ChatControlDto;
}
export interface UiSchema4 {
  /**
   * Group of the UI Schema
   */
  group?: "IN_APP" | "EMAIL" | "DIGEST" | "DELAY" | "SMS" | "CHAT" | "PUSH" | "SKIP" | "LAYOUT";
  /**
   * Properties of the UI Schema
   */
  properties?: {
    [k: string]: UiSchemaProperty;
  };
}
export interface ChatControlDto {
  /**
   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
   */
  skip?: {
    [k: string]: unknown;
  };
  /**
   * Content of the chat message.
   */
  body?: string;
}
export interface ChatControlDto1 {
  /**
   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
   */
  skip?: {
    [k: string]: unknown;
  };
  /**
   * Content of the chat message.
   */
  body?: string;
}
export interface StepIssuesDto4 {
  /**
   * Controls-related issues
   */
  controls?: {
    /**
     * @minItems 0
     */
    [k: string]: StepContentIssueDto[];
  };
  /**
   * Integration-related issues
   */
  integration?: {
    /**
     * @minItems 0
     */
    [k: string]: StepIntegrationIssue[];
  };
}
export interface DelayStepResponseDto {
  /**
   * Controls metadata for the delay step
   */
  controls: DelayControlsMetadataResponseDto;
  /**
   * Control values for the delay step
   */
  controlValues?: DelayControlDto1;
  /**
   * JSON Schema for variables, follows the JSON Schema standard
   */
  variables: {
    [k: string]: unknown;
  };
  /**
   * Unique identifier of the step
   */
  stepId: string;
  /**
   * Database identifier of the step
   */
  _id: string;
  /**
   * Name of the step
   */
  name: string;
  /**
   * Slug of the step
   */
  slug: {};
  /**
   * Type of the step
   */
  type: "in_app" | "email" | "sms" | "chat" | "push" | "digest" | "trigger" | "delay" | "custom";
  /**
   * Origin of the workflow
   */
  origin: "novu-cloud" | "novu-cloud-v1" | "external";
  /**
   * Workflow identifier
   */
  workflowId: string;
  /**
   * Workflow database identifier
   */
  workflowDatabaseId: string;
  /**
   * Issues associated with the step
   */
  issues?: StepIssuesDto5;
}
export interface DelayControlsMetadataResponseDto {
  /**
   * JSON Schema for data
   */
  dataSchema?: {
    [k: string]: unknown;
  };
  /**
   * UI Schema for rendering
   */
  uiSchema?: UiSchema5;
  /**
   * Control values specific to Delay
   */
  values: DelayControlDto;
}
export interface UiSchema5 {
  /**
   * Group of the UI Schema
   */
  group?: "IN_APP" | "EMAIL" | "DIGEST" | "DELAY" | "SMS" | "CHAT" | "PUSH" | "SKIP" | "LAYOUT";
  /**
   * Properties of the UI Schema
   */
  properties?: {
    [k: string]: UiSchemaProperty;
  };
}
export interface DelayControlDto {
  /**
   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
   */
  skip?: {
    [k: string]: unknown;
  };
  /**
   * Type of the delay. Currently only 'regular' is supported by the schema.
   */
  type: "regular";
  /**
   * Amount of time to delay.
   */
  amount: number;
  /**
   * Unit of time for the delay amount.
   */
  unit: "seconds" | "minutes" | "hours" | "days" | "weeks" | "months";
}
export interface DelayControlDto1 {
  /**
   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
   */
  skip?: {
    [k: string]: unknown;
  };
  /**
   * Type of the delay. Currently only 'regular' is supported by the schema.
   */
  type: "regular";
  /**
   * Amount of time to delay.
   */
  amount: number;
  /**
   * Unit of time for the delay amount.
   */
  unit: "seconds" | "minutes" | "hours" | "days" | "weeks" | "months";
}
export interface StepIssuesDto5 {
  /**
   * Controls-related issues
   */
  controls?: {
    /**
     * @minItems 0
     */
    [k: string]: StepContentIssueDto[];
  };
  /**
   * Integration-related issues
   */
  integration?: {
    /**
     * @minItems 0
     */
    [k: string]: StepIntegrationIssue[];
  };
}
export interface DigestStepResponseDto {
  /**
   * Controls metadata for the digest step
   */
  controls: DigestControlsMetadataResponseDto;
  /**
   * Control values for the digest step
   */
  controlValues?: DigestControlDto1;
  /**
   * JSON Schema for variables, follows the JSON Schema standard
   */
  variables: {
    [k: string]: unknown;
  };
  /**
   * Unique identifier of the step
   */
  stepId: string;
  /**
   * Database identifier of the step
   */
  _id: string;
  /**
   * Name of the step
   */
  name: string;
  /**
   * Slug of the step
   */
  slug: {};
  /**
   * Type of the step
   */
  type: "in_app" | "email" | "sms" | "chat" | "push" | "digest" | "trigger" | "delay" | "custom";
  /**
   * Origin of the workflow
   */
  origin: "novu-cloud" | "novu-cloud-v1" | "external";
  /**
   * Workflow identifier
   */
  workflowId: string;
  /**
   * Workflow database identifier
   */
  workflowDatabaseId: string;
  /**
   * Issues associated with the step
   */
  issues?: StepIssuesDto6;
}
export interface DigestControlsMetadataResponseDto {
  /**
   * JSON Schema for data
   */
  dataSchema?: {
    [k: string]: unknown;
  };
  /**
   * UI Schema for rendering
   */
  uiSchema?: UiSchema6;
  /**
   * Control values specific to Digest
   */
  values: DigestControlDto;
}
export interface UiSchema6 {
  /**
   * Group of the UI Schema
   */
  group?: "IN_APP" | "EMAIL" | "DIGEST" | "DELAY" | "SMS" | "CHAT" | "PUSH" | "SKIP" | "LAYOUT";
  /**
   * Properties of the UI Schema
   */
  properties?: {
    [k: string]: UiSchemaProperty;
  };
}
export interface DigestControlDto {
  /**
   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
   */
  skip?: {
    [k: string]: unknown;
  };
  /**
   * The type of digest strategy. Determines which fields are applicable.
   */
  type?: "regular" | "timed";
  /**
   * The amount of time for the digest interval (for REGULAR type). Min 1.
   */
  amount?: number;
  /**
   * The unit of time for the digest interval (for REGULAR type).
   */
  unit?: "seconds" | "minutes" | "hours" | "days" | "weeks" | "months";
  /**
   * Configuration for look-back window (for REGULAR type).
   */
  lookBackWindow?: LookBackWindowDto;
  /**
   * Cron expression for TIMED digest. Min length 1.
   */
  cron?: string;
  /**
   * Specify a custom key for digesting events instead of the default event key.
   */
  digestKey?: string;
}
export interface LookBackWindowDto {
  /**
   * Amount of time for the look-back window.
   */
  amount: number;
  /**
   * Unit of time for the look-back window.
   */
  unit: "seconds" | "minutes" | "hours" | "days" | "weeks" | "months";
}
export interface DigestControlDto1 {
  /**
   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
   */
  skip?: {
    [k: string]: unknown;
  };
  /**
   * The type of digest strategy. Determines which fields are applicable.
   */
  type?: "regular" | "timed";
  /**
   * The amount of time for the digest interval (for REGULAR type). Min 1.
   */
  amount?: number;
  /**
   * The unit of time for the digest interval (for REGULAR type).
   */
  unit?: "seconds" | "minutes" | "hours" | "days" | "weeks" | "months";
  /**
   * Configuration for look-back window (for REGULAR type).
   */
  lookBackWindow?: LookBackWindowDto;
  /**
   * Cron expression for TIMED digest. Min length 1.
   */
  cron?: string;
  /**
   * Specify a custom key for digesting events instead of the default event key.
   */
  digestKey?: string;
}
export interface StepIssuesDto6 {
  /**
   * Controls-related issues
   */
  controls?: {
    /**
     * @minItems 0
     */
    [k: string]: StepContentIssueDto[];
  };
  /**
   * Integration-related issues
   */
  integration?: {
    /**
     * @minItems 0
     */
    [k: string]: StepIntegrationIssue[];
  };
}
export interface CustomStepResponseDto {
  /**
   * Controls metadata for the custom step
   */
  controls: CustomControlsMetadataResponseDto;
  /**
   * Control values for the custom step
   */
  controlValues?: CustomControlDto1;
  /**
   * JSON Schema for variables, follows the JSON Schema standard
   */
  variables: {
    [k: string]: unknown;
  };
  /**
   * Unique identifier of the step
   */
  stepId: string;
  /**
   * Database identifier of the step
   */
  _id: string;
  /**
   * Name of the step
   */
  name: string;
  /**
   * Slug of the step
   */
  slug: {};
  /**
   * Type of the step
   */
  type: "in_app" | "email" | "sms" | "chat" | "push" | "digest" | "trigger" | "delay" | "custom";
  /**
   * Origin of the workflow
   */
  origin: "novu-cloud" | "novu-cloud-v1" | "external";
  /**
   * Workflow identifier
   */
  workflowId: string;
  /**
   * Workflow database identifier
   */
  workflowDatabaseId: string;
  /**
   * Issues associated with the step
   */
  issues?: StepIssuesDto7;
}
export interface CustomControlsMetadataResponseDto {
  /**
   * JSON Schema for data
   */
  dataSchema?: {
    [k: string]: unknown;
  };
  /**
   * UI Schema for rendering
   */
  uiSchema?: UiSchema7;
  /**
   * Control values specific to Custom step
   */
  values: CustomControlDto;
}
export interface UiSchema7 {
  /**
   * Group of the UI Schema
   */
  group?: "IN_APP" | "EMAIL" | "DIGEST" | "DELAY" | "SMS" | "CHAT" | "PUSH" | "SKIP" | "LAYOUT";
  /**
   * Properties of the UI Schema
   */
  properties?: {
    [k: string]: UiSchemaProperty;
  };
}
export interface CustomControlDto {
  /**
   * Custom control values for the step.
   */
  custom?: {
    [k: string]: unknown;
  };
}
export interface CustomControlDto1 {
  /**
   * Custom control values for the step.
   */
  custom?: {
    [k: string]: unknown;
  };
}
export interface StepIssuesDto7 {
  /**
   * Controls-related issues
   */
  controls?: {
    /**
     * @minItems 0
     */
    [k: string]: StepContentIssueDto[];
  };
  /**
   * Integration-related issues
   */
  integration?: {
    /**
     * @minItems 0
     */
    [k: string]: StepIntegrationIssue[];
  };
}
export interface WorkflowPreferencesResponseDto {
  /**
   * User-specific workflow preferences
   */
  user?: WorkflowPreferencesDto;
  /**
   * Default workflow preferences
   */
  default: WorkflowPreferencesDto1;
}
export interface WorkflowPreferencesDto {
  /**
   * A preference for the workflow. The values specified here will be used if no preference is specified for a channel.
   */
  all: WorkflowPreferenceDto & WorkflowPreferenceDto1;
  /**
   * Preferences for different communication channels
   */
  channels: {
    [k: string]: ChannelPreferenceDto;
  };
}
export interface WorkflowPreferenceDto {
  /**
   * A flag specifying if notification delivery is enabled for the workflow. If true, notification delivery is enabled by default for all channels. This setting can be overridden by the channel preferences.
   */
  enabled: boolean;
  /**
   * A flag specifying if the preference is read-only. If true, the preference cannot be changed by the Subscriber.
   */
  readOnly: boolean;
}
export interface WorkflowPreferenceDto1 {
  /**
   * A flag specifying if notification delivery is enabled for the workflow. If true, notification delivery is enabled by default for all channels. This setting can be overridden by the channel preferences.
   */
  enabled: boolean;
  /**
   * A flag specifying if the preference is read-only. If true, the preference cannot be changed by the Subscriber.
   */
  readOnly: boolean;
}
export interface ChannelPreferenceDto {
  /**
   * A flag specifying if notification delivery is enabled for the channel. If true, notification delivery is enabled.
   */
  enabled: boolean;
}
export interface WorkflowPreferencesDto1 {
  /**
   * A preference for the workflow. The values specified here will be used if no preference is specified for a channel.
   */
  all: WorkflowPreferenceDto & WorkflowPreferenceDto1;
  /**
   * Preferences for different communication channels
   */
  channels: {
    [k: string]: ChannelPreferenceDto;
  };
}
export interface RuntimeIssueDto {
  issueType:
    | "MISSING_VALUE"
    | "MAX_LENGTH_ACCESSED"
    | "WORKFLOW_ID_ALREADY_EXISTS"
    | "DUPLICATED_VALUE"
    | "LIMIT_REACHED";
  variableName?: string;
  message: string;
}