@wix/auto_sdk_automations_activations 1.0.19 → 1.0.21

package/build/internal/cjs/src/automations-v2-activation-activations.universal.d.ts

@@ -1,3 +1,4 @@
+import { NonNullablePaths } from '@wix/sdk-types';
 export interface Activation {
     /**
      * Activation ID
@@ -8,9 +9,9 @@ export interface Activation {
     automation?: Automation;
 }
 export interface Automation extends AutomationOriginInfoOneOf {
-    /** Application info */
+    /** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
     applicationInfo?: ApplicationOrigin;
-    /** Preinstalled info */
+    /** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
     preinstalledInfo?: PreinstalledOrigin;
     /**
      * Automation ID.
@@ -19,37 +20,33 @@ export interface Automation extends AutomationOriginInfoOneOf {
      */
     _id?: string | null;
     /**
-     * Revision number, which increments by 1 each time the automation is updated.
-     * To prevent conflicting changes,
-     * the current revision must be passed when updating the automation.
-     *
-     * Ignored when creating an automation.
+     * Revision number. This increments by 1 whenever the automation is updated. Specify the current revision number whenever updating an existing automation.
      * @readonly
      */
     revision?: string | null;
     /**
-     * Information about the creator of the automation.
+     * Who created the automation.
      * @immutable
      * @readonly
      */
     createdBy?: AuditInfo;
     /**
-     * Date and time the automation was created.
+     * When the automation was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * The entity that last updated the automation.
+     * Who last updated the automation.
      * @readonly
      */
     updatedBy?: AuditInfo;
     /**
-     * Date and time the automation was last updated.
+     * When the automation was last updated.
      * @readonly
      */
     _updatedDate?: Date | null;
     /**
-     * Automation name that is displayed on the user's site.
+     * Automation name as displayed on the user's site.
      * @minLength 1
      * @maxLength 500
      */
@@ -59,60 +56,71 @@ export interface Automation extends AutomationOriginInfoOneOf {
      * @maxLength 2000
      */
     description?: string | null;
-    /** Object that defines the automation's trigger, actions, and activation status. */
+    /** Automation configuration. */
     configuration?: AutomationConfiguration;
     /**
-     * Defines how the automation was added to the site.
+     * How the automation was added to the user's site.
      * @immutable
      */
     origin?: Origin;
     /** Automation settings. */
     settings?: AutomationSettings;
     /**
-     * Draft info (optional - only if the automation is a draft)
+     * When the automation is a draft, the draft details.
      * @readonly
      */
     draftInfo?: DraftInfo;
     /**
-     * Namespace
-     * @maxLength 50
+     * Whether the automation is archived.
+     *
+     * To archive an automation, set this to `true`. To restore an archived automation, set this to `false`.
      */
-    namespace?: string | null;
-    /** Extended Fields */
-    extendedFields?: ExtendedFields;
+    archived?: boolean;
 }
 /** @oneof */
 export interface AutomationOriginInfoOneOf {
-    /** Application info */
+    /** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
     applicationInfo?: ApplicationOrigin;
-    /** Preinstalled info */
+    /** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
     preinstalledInfo?: PreinstalledOrigin;
 }
 export interface ActionSettings {
     /**
-     * List of actions that cannot be deleted.
-     * Default: Empty. All actions are deletable by default.
+     * Permanent actions. Permanent actions cannot be deleted.
+     *
+     * When empty, all actions can be deleted by the user.
      * @maxSize 30
      * @format GUID
      */
     permanentActionIds?: string[];
     /**
-     * List of actions that cannot be edited.
-     * Default: Empty. All actions are editable by default.
+     * Read-only actions. Read-only actions cannot be edited.
+     *
+     * When empty, all actions are editable.
      * @maxSize 30
      * @format GUID
      */
     readonlyActionIds?: string[];
-    /** Whether the option to add a delay is disabled for the automation. */
+    /**
+     * Whether to disable the ability to add a delay to the automation.
+     *
+     * Default: `false`.
+     */
     disableDelayAddition?: boolean;
-    /** Whether the option to add a condition is disabled for the automation. */
+    /**
+     * Whether to disable the ability to add a condition to the automation.
+     *
+     * Default: `false`.
+     */
     disableConditionAddition?: boolean;
 }
 export declare enum Domain {
     /** User domain (default). */
     USER = "USER",
     /** Wix domain. */
-    WIX = "WIX"
+    WIX = "WIX",
+    /** Wix account-level domain. */
+    WIX_ACCOUNT = "WIX_ACCOUNT"
 }
 export interface Enrichment {
     /**
@@ -123,12 +131,14 @@ export interface Enrichment {
 }
 export interface AuditInfo extends AuditInfoIdOneOf {
     /**
-     * User ID.
+     * [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
      * @format GUID
      */
     userId?: string;
     /**
-     * Application ID.
+     * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
+     *
+     * You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
      * @format GUID
      */
     appId?: string;
@@ -136,40 +146,45 @@ export interface AuditInfo extends AuditInfoIdOneOf {
 /** @oneof */
 export interface AuditInfoIdOneOf {
     /**
-     * User ID.
+     * [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
      * @format GUID
      */
     userId?: string;
     /**
-     * Application ID.
+     * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
+     *
+     * You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
      * @format GUID
      */
     appId?: string;
 }
-/** Automation runtime configuration */
 export interface AutomationConfiguration {
     /** Status of the automation on the site. */
     status?: AutomationConfigurationStatus;
-    /** Automation trigger configuration. */
+    /** Trigger configuration. */
     trigger?: Trigger;
     /**
-     * List of IDs of root actions. Root actions are the first actions to run after the trigger. The actions in the list run in parallel.
+     * Root action IDs. A root action is the first action that runs after the trigger occurs. Root actions run in parallel.
+     *
+     * > **Note**: You can currently only specify 1 root action.
      * @maxSize 20
      * @format GUID
      */
     rootActionIds?: string[];
-    /**
-     * Map of all actions that the automation may execute.
-     * The key is the action ID, and the value is the action configuration.
-     */
+    /** Actions the automation can execute, as key:value pairs. For the key, specify the action ID. The value must be an object structured as described below. */
     actions?: Record<string, AutomationConfigurationAction>;
 }
 export declare enum TimeUnit {
     UNKNOWN_TIME_UNIT = "UNKNOWN_TIME_UNIT",
+    /** Minutes. */
     MINUTES = "MINUTES",
+    /** Hours. */
     HOURS = "HOURS",
+    /** Days. */
     DAYS = "DAYS",
+    /** Weeks. */
     WEEKS = "WEEKS",
+    /** Months. */
     MONTHS = "MONTHS"
 }
 export interface Filter {
@@ -179,42 +194,49 @@ export interface Filter {
      */
     _id?: string;
     /**
-     * Field key from the payload schema, for example "formId".
+     * Field key.
+     *
+     * You can find the field key in [the trigger payload schema](https://dev.wix.com/docs/rest/business-management/automations/triggers/the-trigger-payload-schema).
      * @minLength 1
      * @maxLength 110
      */
     fieldKey?: string;
     /**
-     * Filter expression that evaluates to a boolean.
+     * Filter expression.
+     *
+     * For the automation to run, the expression must evaluate to `true`.
      * @maxLength 2500
      */
     filterExpression?: string;
 }
 export interface FutureDateActivationOffset {
     /**
-     * The offset value. The value is always taken as negative, so that the automation runs before the trigger date.
-     * To create an offset that causes the automation to run after the trigger date, use a delay action.
+     * Amount of time before the trigger to run the automation.
+     *
+     * > **Note**: To delay an automation after the trigger event occurs, use a [delay action](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#delay-action).
      * @maxLength 1000
      */
     preScheduledEventOffsetExpression?: string;
-    /** Time unit for the scheduled event offset. */
+    /** Unit in which to set the action offset. */
     scheduledEventOffsetTimeUnit?: TimeUnit;
 }
 export interface RateLimit {
     /**
-     * Value expressing the maximum number of times the trigger can be activated.
+     * Maximum number of times the trigger can be activated.
      * @maxLength 1000
      */
     maxActivationsExpression?: string;
     /**
-     * Duration of the rate limiting window in the selected time unit. If no value is set, the rate limit is permanent.
+     * Duration of the rate limit. The rate limit applies for the specified duration and then expires.
+     *
+     * When empty, the rate limit does not expire.
      * @maxLength 1000
      */
     durationExpression?: string | null;
-    /** Time unit for the rate limit duration. */
+    /** Unit in which to set the duration of the rate limit. */
     durationTimeUnit?: TimeUnit;
     /**
-     * Unique identifier of each activation, by which rate limiter will count activations.
+     * Activation identifier used to count the number of activations.
      * @minLength 1
      * @maxLength 400
      */
@@ -222,17 +244,17 @@ export interface RateLimit {
 }
 export interface FilterValueSelection {
     /**
-     * Values that can help the user filter certain automations, values will look like "<filter_id>__<selected_value>"
+     * Values that can help the user filter certain automations. Specify values in the following format: `<filter_id>__<selected_value>`.
      * @maxLength 80
      * @maxSize 50
      */
     selectedFilterValues?: string[];
 }
 export interface ConditionExpressionGroup {
-    /** Expression group operator. */
+    /** Logical operator used to evaluate the condition expressions. */
     operator?: Operator;
     /**
-     * List of boolean expressions to be evaluated with the given operator.
+     * Expressions evaluated using the selected operator.
      * @minSize 1
      * @maxSize 20
      * @maxLength 2500
@@ -240,25 +262,58 @@ export interface ConditionExpressionGroup {
     booleanExpressions?: string[];
 }
 export declare enum Operator {
+    /** Unknown. */
     UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
+    /** `OR` operator. */
     OR = "OR",
+    /** `AND` operator. */
     AND = "AND"
 }
+export interface ActionCodeSnippet {
+    /** Logical operator used to evaluate the condition expressions. */
+    language?: CodeSnippetLanguage;
+    /**
+     * Expressions evaluated using the selected operator. this code should comply the language syntax. and format
+     * @maxLength 1000
+     */
+    code?: string;
+}
+export declare enum CodeSnippetLanguage {
+    /** Unknown. */
+    UNKNOWN_LANGUAGE = "UNKNOWN_LANGUAGE",
+    /** `JAVASCRIPT` language. */
+    JAVASCRIPT = "JAVASCRIPT"
+}
+/** Path definition */
+export interface Path {
+    /**
+     * Unique path ID.
+     * @format GUID
+     */
+    _id?: string;
+    /**
+     * Path display name.
+     * @minLength 1
+     * @maxLength 100
+     */
+    name?: string;
+    /**
+     * ID of the action to run when this path is taken.
+     * @format GUID
+     */
+    postActionId?: string | null;
+}
 export declare enum Type {
-    /** Automation will be triggered according to the trigger configuration. */
+    /** Based on the trigger. */
     UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
-    /** App defined Action. */
+    /** Defined by a [Wix app](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#app-defined-actions). This action type is available in the site dashboard. */
     APP_DEFINED = "APP_DEFINED",
-    /** Condition Action. */
+    /** Condition. This determines which action runs next. */
     CONDITION = "CONDITION",
-    /** Delay Action. */
+    /** Delay. The automation must wait before executing the next step. */
     DELAY = "DELAY",
-    /** RateLimit Action. */
-    RATE_LIMIT = "RATE_LIMIT",
-    /** Set Variables Action. */
-    SET_VARIABLES = "SET_VARIABLES",
-    /** Output Action. */
-    OUTPUT = "OUTPUT"
+    /** Rate-limiter. This stops the automation flow if the subsequent action has reached its maximum allowed executions. */
+    RATE_LIMIT = "RATE_LIMIT"
 }
 export interface AppDefinedAction {
     /**
@@ -272,39 +327,55 @@ export interface AppDefinedAction {
      * @maxLength 100
      */
     actionKey?: string;
-    /** Action input mapping. */
+    /** Action input mapping as defined in the action's [input schema](https://dev.wix.com/docs/rest/business-management/automations/actions/the-action-input-schema). */
     inputMapping?: Record<string, any> | null;
     /**
-     * Array of conditions determining whether to skip the action in the automation flow.
-     * The action will be skipped if any of the expression groups evaluate to `true`.
-     * Actions following a skipped action will still run.
+     * Action skip conditions. An action is skipped if any of the specified conditions evaluates to `true`.
+     *
+     * > **Note**: Actions that follow a skipped action still run.
      * @maxSize 10
      */
     skipConditionOrExpressionGroups?: ConditionExpressionGroup[];
     /**
-     * List of IDs of actions to run in parallel once the action completes.
+     * IDs of actions that run in parallel after the action completes.
      * @maxSize 20
      * @format GUID
      */
     postActionIds?: string[];
-    /** Optional output schema of the action. It will be used instead the action schema in case it's provided. */
+    /** Action output schema. When specified, this replaces the action schema. */
     overrideOutputSchema?: Record<string, any> | null;
 }
 export interface ConditionAction {
     /**
-     * The condition evaluates to `true` if either of the expression groups evaluate to `true`.
+     * Condition is `true` if one or more of the expression groups evaluates to `true`.
      * @minSize 1
      * @maxSize 10
      */
     orExpressionGroups?: ConditionExpressionGroup[];
     /**
-     * List of IDs of actions to run when the entire condition is evaluated to `true`.
+     * IDs of actions to run when the condition evaluates to `true`.
      * @maxSize 20
      * @format GUID
      */
     truePostActionIds?: string[];
     /**
-     * List of IDs of actions to run when the entire condition is evaluated to `false`.
+     * IDs of actions to run when the condition evaluates to `false`.
+     * @maxSize 20
+     * @format GUID
+     */
+    falsePostActionIds?: string[];
+}
+export interface CodeConditionAction {
+    /** condition code. This is a code that can be used to identify the condition in the automation. code should return a boolean value. otherwise the value will be tried to be casted to boolean. */
+    snippet?: ActionCodeSnippet;
+    /**
+     * IDs of actions to run when the condition evaluates to `true`.
+     * @maxSize 20
+     * @format GUID
+     */
+    truePostActionIds?: string[];
+    /**
+     * IDs of actions to run when the condition evaluates to `false`.
      * @maxSize 20
      * @format GUID
      */
@@ -312,21 +383,23 @@ export interface ConditionAction {
 }
 export interface DelayAction {
     /**
-     * Value expressing the amount of time to wait from a specific date or from the time the action is executed.
+     * Time to wait before running the action. The wait time starts from when the current action completes.
+     *
+     * > **Note**: To define the wait time from a specific moment in time, use `dueDateEpochExpression`.
      * @maxLength 1000
      */
     offsetExpression?: string | null;
-    /** Time unit for delay offset. */
+    /** Unit in which to set the wait time to wait before the action runs. */
     offsetTimeUnit?: TimeUnit;
     /**
-     * The action due date. If defined without an offset, the automation will wait until this date to execute the next step.
-     * If an offset is defined, it's calculated from this date.
-     * The date is expressed in the number of milliseconds since the Unix Epoch (1 January, 1970 UTC).
+     * Action run date in milliseconds elapsed since January 1, 1970 UTC.
+     *
+     * > **Note**: If an `offsetExpression` is defined, the delay is calculated from the time of the offset.
      * @maxLength 1000
      */
     dueDateEpochExpression?: string | null;
     /**
-     * List of IDs of actions to run in parallel after the delay.
+     * IDs of actions to run in parallel after the time delay.
      * @maxSize 20
      * @format GUID
      */
@@ -334,17 +407,18 @@ export interface DelayAction {
 }
 export interface RateLimitAction {
     /**
-     * The maximum number of activations allowed for the action.
+     * Maximum number of times the action can run.
      * @maxLength 1000
      */
     maxActivationsExpression?: string;
     /**
-     * Duration of the rate limiting window, expressed in selected time unit.
-     * If no value is set, then there is no time limit on the rate limiter.
+     * Rate limit duration.
+     *
+     * When empty, the rate limit does not expire.
      * @maxLength 1000
      */
     rateLimitDurationExpression?: string | null;
-    /** Time unit for the rate limit duration. */
+    /** Unit in which to set the duration of the rate limit. */
     rateLimitDurationTimeUnit?: TimeUnit;
     /**
      * Unique identifier of each activation by which rate limiter counts activations.
@@ -353,25 +427,23 @@ export interface RateLimitAction {
      */
     uniqueIdentifierExpression?: string | null;
     /**
-     * List of IDs of actions to run in parallel once the action completes.
+     * IDs of actions to run in parallel after the action completes.
      * @maxSize 20
      * @format GUID
      */
     postActionIds?: string[];
 }
 export interface SetVariablesAction {
-    /**
-     * output mapping
-     * for example: {"someField": "{{10}}", "someOtherField": "{{multiply( var('account.points.balance') ;2 )}}" }
-     */
+    /** Output mapping. For example: `{"someField": "{{10}}", "someOtherField": "{{multiply( var('account.points.balance') ;2 )}}" }`. */
     outputMapping?: Record<string, any> | null;
     /**
-     * output json schema representation
-     * could be string instead of Struct (and introduce some compression to minimize the size of it)
+     * Output JSON schema representation.
+     *
+     * > **Note**: To minimize request size, you can also specify a string.
      */
     outputSchema?: Record<string, any> | null;
     /**
-     * List of IDs of actions to run in parallel after variable initialization.
+     * IDs of actions to run in parallel after variable initialization.
      * @maxSize 20
      * @format GUID
      */
@@ -381,12 +453,20 @@ export interface OutputAction {
     /** Output action output mapping. */
     outputMapping?: Record<string, any> | null;
 }
+export interface SplitAction {
+    /**
+     * List of paths to split execution into.
+     * @minSize 2
+     * @maxSize 10
+     */
+    paths?: Path[];
+}
 export declare enum AutomationConfigurationStatus {
-    /** unused */
+    /** Unknown. */
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
-    /** Automation will be triggered according to the trigger configuration */
+    /** Active. Active automations can be triggered. */
     ACTIVE = "ACTIVE",
-    /** Automation will not be triggered */
+    /** Inactive. Inactive automations cannot be triggered. */
     INACTIVE = "INACTIVE"
 }
 export interface Trigger {
@@ -397,51 +477,54 @@ export interface Trigger {
     appId?: string;
     /**
      * Trigger key.
+     *
+     * Learn about [setting up a trigger](https://dev.wix.com/docs/rest/business-management/automations/triggers/add-a-trigger-to-your-app#step-1--set-up-the-trigger).
      * @minLength 1
      * @maxLength 100
      */
     triggerKey?: string;
     /**
-     * List of filters on schema fields.
-     * In order for the automation to run, all filter expressions must evaluate to `true` for a given payload.
+     * Schema field filters. All filter conditions must be met for the automation to run.
+     *
+     * Learn more about setting up [automation filters](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#filters).
      * @maxSize 5
      */
     filters?: Filter[];
-    /** Defines the time offset between the trigger date and when the automation runs. */
-    scheduledEventOffset?: FutureDateActivationOffset;
-    /** Limits the number of times an automation can be triggered. */
-    rateLimit?: RateLimit;
     /**
-     * An optional configuration, per automation, of a schema that is optionally offered by the trigger provider to affect the behavior of the trigger.
-     * For example, a trigger provider may offer a schema that allows the user to configure the trigger to happen at a certain time of day,
-     * He would define a schema with a field called "startDate" and using this parameter the user can define his preferred startDate, per automation.
+     * Automation offset. You can schedule automations to run before the trigger occurs.
+     *
+     * Learn more about [scheduled events](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/configure-your-automation#scheduled-events).
      */
-    automationConfigMapping?: Record<string, any> | null;
-    /** Optional schema of the trigger. It will be used instead the trigger schema in case it's provided. */
+    scheduledEventOffset?: FutureDateActivationOffset;
+    /** Limit on the number of times an automation can be triggered. */
+    rateLimit?: RateLimit;
+    /** Trigger schema override. When specified, this replaces the trigger schema. */
     overrideSchema?: Record<string, any> | null;
 }
 export interface AutomationConfigurationAction extends AutomationConfigurationActionInfoOneOf {
-    /** Action defined by an app (via RPC, HTTP or Velo). */
+    /** Details of the action when its `type` is `APP_DEFINED`. */
     appDefinedInfo?: AppDefinedAction;
-    /** Condition action. */
+    /** Details of the action when its `type` is `CONDITION`. */
     conditionInfo?: ConditionAction;
-    /** Delay action. */
+    /** Details of the action when its `type` is `CODE_CONDITION`. */
+    codeConditionInfo?: CodeConditionAction;
+    /** Details of the action when its `type` is `DELAY`. */
     delayInfo?: DelayAction;
-    /** Rate-limiting action. */
+    /** Details of the action when its `type` is `RATE_LIMIT`. */
     rateLimitInfo?: RateLimitAction;
     /**
-     * Action ID. If not specified, a new ID is generated.
+     * Action ID.
+     *
+     * If not specified, automatically generated by Wix.
      * @format GUID
      */
     _id?: string | null;
-    /** Action type. */
+    /** [Action type](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#action-type). */
     type?: Type;
     /**
-     * Human-readable name to differentiate the action from other actions of the same type.
-     * The name can contain only alphanumeric characters and underscores. If not provided, a namespace in the form `actionkey-indexOfAction` is
-     * generated automatically.
-     * If the action has output, the output will be available in the payload under this name.
-     * If the user has multiple actions with the same appId and actionKey, previous action output will be overwritten.
+     * [Action namespace](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#namespace). This differentiates it from other actions of the same type.
+     *
+     * If the action outputs any data, the data appears under the namespace in the payload sent to the subsequent steps in the automation. If the user has multiple actions with the same `appId` and `actionKey`, the output of the previous action is overwritten.
      * @minLength 1
      * @maxLength 100
      */
@@ -449,18 +532,20 @@ export interface AutomationConfigurationAction extends AutomationConfigurationAc
 }
 /** @oneof */
 export interface AutomationConfigurationActionInfoOneOf {
-    /** Action defined by an app (via RPC, HTTP or Velo). */
+    /** Details of the action when its `type` is `APP_DEFINED`. */
     appDefinedInfo?: AppDefinedAction;
-    /** Condition action. */
+    /** Details of the action when its `type` is `CONDITION`. */
     conditionInfo?: ConditionAction;
-    /** Delay action. */
+    /** Details of the action when its `type` is `CODE_CONDITION`. */
+    codeConditionInfo?: CodeConditionAction;
+    /** Details of the action when its `type` is `DELAY`. */
     delayInfo?: DelayAction;
-    /** Rate-limiting action. */
+    /** Details of the action when its `type` is `RATE_LIMIT`. */
     rateLimitInfo?: RateLimitAction;
 }
 export interface FilterableAppDefinedActions {
     /**
-     * App defined action identifiers, each identifier in form `${appId}_${actionKey}`
+     * App-defined action identifiers. Identifiers have the following format: `${appId}_${actionKey}`.
      * @minSize 1
      * @maxSize 100
      * @minLength 1
@@ -469,48 +554,40 @@ export interface FilterableAppDefinedActions {
     actionIdentifiers?: string[];
 }
 export declare enum Origin {
-    /** Default value. This is unused. */
+    /** Default value. */
     UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
-    /** User created automation. */
+    /** Created by a [Wix user](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#wix-user). */
     USER = "USER",
-    /** Automation created by application (site specific). */
+    /** Created by a [Wix app](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#wix-app) for a particular site. */
     APPLICATION = "APPLICATION",
-    /** Preinstalled application automation. */
-    PREINSTALLED = "PREINSTALLED",
-    /** Automation created from a recipe. */
-    RECIPE = "RECIPE"
+    /** [Preinstalled automation](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/pre-installed-automations/about-pre-installed-automations). */
+    PREINSTALLED = "PREINSTALLED"
 }
 export interface ApplicationOrigin {
     /**
-     * Application ID.
+     * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
+     *
+     * You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
      * @format GUID
      */
     appId?: string;
-    /**
-     * External ID to correlate multiple sites to an automation
-     * @format GUID
-     */
-    appDefinedExternalId?: string | null;
 }
 export interface PreinstalledOrigin {
     /**
-     * ID of the app that defines the preinstalled automation.
+     * ID of the app that added the [preinstalled automation](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/pre-installed-automations/about-pre-installed-automations).
      * @format GUID
      */
     appId?: string;
     /**
-     * Application component ID.
-     * @format GUID
-     */
-    componentId?: string;
-    /** Application component version. */
-    componentVersion?: number;
-    /**
-     * Whether the automation is an override automation. If the user modifies the preinstalled automation installed on their site, a site-specific
-     * automation is created that overrides the original one. If the user makes no modifications this boolean is set to `false` and the original
-     * preinstalled automation is used.
+     * Whether the automation is an override.
      *
-     * Default: `false`
+     * When a user modifies the preinstalled automation installed on their site, a site-specific version of the automation is created that overrides the automation that was originally installed. This override automation has the same automation ID as the original preinstalled automation.
+     *
+     * > **Note**: An override automation can no longer be updated by the app that originally installed it.
+     * >
+     * > To revert to the original preinstalled version, the user must delete the override by calling the Delete Automation method. Calling Delete Automation on an override automation removes the override method and restores the preinstalled automation that was previously installed.
+     *
+     * Default: `false`.
      * @immutable
      * @readonly
      */
@@ -519,22 +596,26 @@ export interface PreinstalledOrigin {
 export interface AutomationSettings {
     /**
      * Whether the automation is hidden from users.
+     *
      * Default: `false`
      */
     hidden?: boolean;
     /**
      * Whether the automation is read-only.
+     *
      * Default: `false`
      */
     readonly?: boolean;
     /**
-     * Whether the option to delete the automation from the site is disabled.
-     * Default: `false`
+     * Whether to disable the option to delete the automation from the site.
+     *
+     * Default: `false`.
      */
     disableDelete?: boolean;
     /**
-     * Whether the option to change the automation status (from active to inactive and vice versa) is disabled.
-     * Default: `false`
+     * Whether to disable the option to change the automation's `configuration.status`, for example from `ACTIVE` to `INACTIVE`.
+     *
+     * Default: `false`.
      */
     disableStatusChange?: boolean;
     /** Automation action settings. */
@@ -542,7 +623,7 @@ export interface AutomationSettings {
 }
 export interface DraftInfo {
     /**
-     * Optional - automationId of the original automation.
+     * ID of the original automation.
      * @format GUID
      * @readonly
      */
@@ -668,6 +749,14 @@ export declare enum ActivationStatusChangedStatus {
      */
     SKIPPED = "SKIPPED"
 }
+export interface Metadata {
+    /**
+     * Identity field keys that are collected from the trigger payload schema, including contact and member ids
+     * @maxSize 100
+     * @maxLength 100
+     */
+    identityFieldKeys?: string[];
+}
 export interface InitiatedStatusInfo {
     /** Activation target */
     target?: Target;
@@ -884,25 +973,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
     _id?: string;
     /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
      */
     entityFqdn?: string;
     /**
-     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
-     * This is although the created/updated/deleted notion is duplication of the oneof types
-     * Example: created/updated/deleted/started/completed/email_opened
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
      */
     slug?: string;
     /** ID of the entity associated with the event. */
     entityId?: string;
-    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
     eventTime?: Date | null;
     /**
      * Whether the event was triggered as a result of a privacy regulation application
@@ -912,12 +997,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     /** If present, indicates the action that triggered the event. */
     originatedFrom?: string | null;
     /**
-     * A sequence number defining the order of updates to the underlying entity.
-     * For example, given that some entity was updated at 16:00 and than again at 16:01,
-     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
-     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
-     * To do so, you will need to persist this number on your end, and compare the sequence number from the
-     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
      */
     entityEventSequence?: string | null;
 }
@@ -943,7 +1024,7 @@ export interface EntityUpdatedEvent {
     currentEntity?: string;
 }
 export interface EntityDeletedEvent {
-    /** Entity that was deleted */
+    /** Entity that was deleted. */
     deletedEntity?: string | null;
 }
 export interface ActionEvent {
@@ -1262,6 +1343,41 @@ export interface ConditionBlock {
      */
     lineExpressions?: string[];
 }
+export interface CodeConditionFilter {
+    /** Code Snippet */
+    snippet?: CodeSnippet;
+    /**
+     * Actions to perform when condition_blocks evaluates to `true`.
+     * @maxSize 2000
+     */
+    postActions?: ActionData[];
+    /**
+     * Action's post actions ids.
+     * @format GUID
+     * @maxSize 20
+     */
+    postActionsIds?: string[];
+    /**
+     * Actions to perform when condition_blocks evaluates to `false`.
+     * @maxSize 2000
+     */
+    elsePostActions?: ActionData[];
+}
+export interface CodeSnippet {
+    /** Logical operator used to evaluate the condition expressions. */
+    language?: Language;
+    /**
+     * Expressions evaluated using the selected operator.
+     * @maxLength 1000
+     */
+    code?: string;
+}
+export declare enum Language {
+    /** Unknown. */
+    UNKNOWN_LANGUAGE = "UNKNOWN_LANGUAGE",
+    /** `JAVASCRIPT` language. */
+    JAVASCRIPT = "JAVASCRIPT"
+}
 export interface Output {
     /**
      * The jsonata to use to produce the output
@@ -1296,6 +1412,8 @@ export interface SetVariables {
      * @maxLength 100
      */
     namespace?: string | null;
+    /** Json Schema for the output mapping */
+    outputSchema?: Record<string, any> | null;
 }
 export interface Service {
     /** Action's service mapping. */
@@ -1330,6 +1448,7 @@ export interface SystemHelper extends SystemHelperHelperOneOf {
     delay?: DelayHelper;
     rateLimiting?: RateLimiting;
     conditionFilter?: ConditionFilter;
+    codeConditionFilter?: CodeConditionFilter;
     output?: Output;
     setVariables?: SetVariables;
 }
@@ -1340,6 +1459,7 @@ export interface SystemHelperHelperOneOf {
     delay?: DelayHelper;
     rateLimiting?: RateLimiting;
     conditionFilter?: ConditionFilter;
+    codeConditionFilter?: CodeConditionFilter;
     output?: Output;
     setVariables?: SetVariables;
 }
@@ -1757,6 +1877,64 @@ export interface ActivationScheduleCompleted {
      */
     externalEntityId?: string | null;
 }
+export interface ActionRetryRequest {
+    /** The activation context */
+    activationContext?: ActivationContext;
+    /** The action to retry */
+    actionToRetryData?: ActionData;
+}
+export interface ActivationContext {
+    /**
+     * Activation ID
+     * @format GUID
+     */
+    activationId?: string;
+    /**
+     * Action ID
+     * @format GUID
+     */
+    actionId?: string;
+    /**
+     * Configuration ID
+     * @format GUID
+     */
+    configurationId?: string;
+    /**
+     * Configuration Correlation ID
+     * @format GUID
+     */
+    configurationCorrelationId?: string;
+    /** name of the event. intended to keep backwards compatibility, probably not in use. */
+    eventName?: string;
+    /** Event slug, also probably not in use */
+    eventSlug?: string | null;
+    /** Enriched event payload */
+    enrichedEventPayload?: string;
+    /** Raw event payload */
+    rawEventPayload?: string;
+    /** Actions */
+    actions?: ActionData[];
+    /** Activation status */
+    activationStatus?: RuntimeStatus;
+    /** External ID */
+    externalId?: string;
+    /** Automation */
+    automationV2?: Automation;
+    /** Output */
+    output?: string | null;
+}
+export declare enum RuntimeStatus {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    STARTED = "STARTED",
+    ENDED = "ENDED",
+    ERROR = "ERROR",
+    SCHEDULED = "SCHEDULED",
+    FROM_SCHEDULER = "FROM_SCHEDULER",
+    RETRY = "RETRY",
+    RESUMED = "RESUMED",
+    PAUSED = "PAUSED",
+    ACTION_SKIPPED = "ACTION_SKIPPED"
+}
 export interface ResumeAfterAsyncActionCompleted extends ResumeAfterAsyncActionCompletedStatusInfoOneOf {
     /** Success info */
     successInfo?: SuccessInfo;
@@ -1895,6 +2073,10 @@ export interface ConditionActionInfo {
     /** Collects results per each expression evaluation that took place */
     expressionResults?: Record<string, ExpressionEvaluationResult>;
 }
+export interface CodeConditionActionInfo {
+    /** Indicates that the code condition `if` clause evaluated to `true`. */
+    passed?: boolean;
+}
 export interface RateLimitActionInfo {
     /** Indicates if the rate limiter passed (not reached the quota) */
     passed?: boolean;
@@ -2014,6 +2196,8 @@ export interface EndedStatusInfo extends EndedStatusInfoTypeInfoOneOf {
     appDefinedActionInfo?: EndedStatusInfoAppDefinedActionInfo;
     /** Condition action additional info */
     conditionActionInfo?: ConditionActionInfo;
+    /** Code Condition action additional info */
+    codeConditionActionInfo?: CodeConditionActionInfo;
     /** Rate limit action additional info */
     rateLimitActionInfo?: RateLimitActionInfo;
     /** Delay action additional info */
@@ -2027,6 +2211,8 @@ export interface EndedStatusInfoTypeInfoOneOf {
     appDefinedActionInfo?: EndedStatusInfoAppDefinedActionInfo;
     /** Condition action additional info */
     conditionActionInfo?: ConditionActionInfo;
+    /** Code Condition action additional info */
+    codeConditionActionInfo?: CodeConditionActionInfo;
     /** Rate limit action additional info */
     rateLimitActionInfo?: RateLimitActionInfo;
     /** Delay action additional info */
@@ -2149,48 +2335,6 @@ export interface ReportActionInvocationCompletedRequestStatusInfoOneOf {
 }
 export interface ReportActionInvocationCompletedResponse {
 }
-export interface ReportEventResponseNonNullableFields {
-    activationIds: string[];
-}
-interface ApplicationErrorNonNullableFields {
-    code: string;
-    description: string;
-}
-interface ItemMetadataNonNullableFields {
-    originalIndex: number;
-    success: boolean;
-    error?: ApplicationErrorNonNullableFields;
-}
-interface IdempotencyNonNullableFields {
-    key: string;
-}
-interface EventInfoNonNullableFields {
-    idempotency?: IdempotencyNonNullableFields;
-}
-interface BulkReportEventResultNonNullableFields {
-    itemMetadata?: ItemMetadataNonNullableFields;
-    eventInfo?: EventInfoNonNullableFields;
-    activationIds: string[];
-}
-interface BulkActionMetadataNonNullableFields {
-    totalSuccesses: number;
-    totalFailures: number;
-    undetailedFailures: number;
-}
-export interface BulkReportEventResponseNonNullableFields {
-    triggerKey: string;
-    results: BulkReportEventResultNonNullableFields[];
-    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
-}
-interface BulkCancelEventResultNonNullableFields {
-    itemMetadata?: ItemMetadataNonNullableFields;
-    externalEntityId: string;
-}
-export interface BulkCancelEventResponseNonNullableFields {
-    triggerKey: string;
-    results: BulkCancelEventResultNonNullableFields[];
-    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
-}
 /**
  * Reports an event and activates site automations with the specified trigger key.
  *
@@ -2208,6 +2352,8 @@ export interface BulkCancelEventResponseNonNullableFields {
  * @public
  * @requiredField triggerKey
  * @permissionId AUTOMATIONS.REPORT_EVENT
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Your App
  * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
  * @permissionScope Read site, business, and email details
@@ -2217,7 +2363,7 @@ export interface BulkCancelEventResponseNonNullableFields {
  * @applicableIdentity APP
  * @fqn wix.automations.esb.resolver.v1.EsbConfigResolver.ReportEvent
  */
-export declare function reportEvent(triggerKey: string, options?: ReportEventOptions): Promise<ReportEventResponse & ReportEventResponseNonNullableFields>;
+export declare function reportEvent(triggerKey: string, options?: ReportEventOptions): Promise<NonNullablePaths<ReportEventResponse, `activationIds`>>;
 export interface ReportEventOptions {
     /**
      * Event payload, formatted as key:value pairs.
@@ -2264,6 +2410,8 @@ export interface ReportEventOptions {
  * @requiredField eventsInfo
  * @requiredField triggerKey
  * @permissionId AUTOMATIONS.REPORT_EVENT
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Your App
  * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
  * @permissionScope Read site, business, and email details
@@ -2273,7 +2421,7 @@ export interface ReportEventOptions {
  * @applicableIdentity APP
  * @fqn wix.automations.esb.resolver.v1.EsbConfigResolver.BulkReportEvent
  */
-export declare function bulkReportEvent(triggerKey: string, eventsInfo: EventInfo[]): Promise<BulkReportEventResponse & BulkReportEventResponseNonNullableFields>;
+export declare function bulkReportEvent(triggerKey: string, eventsInfo: EventInfo[]): Promise<NonNullablePaths<BulkReportEventResponse, `triggerKey` | `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.eventInfo.idempotency.key` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 /**
  * Bulk cancels any remaining actions for a trigger and external entities.
  * @param triggerKey - Trigger key whose events you want to cancel.
@@ -2290,7 +2438,7 @@ export declare function bulkReportEvent(triggerKey: string, eventsInfo: EventInf
  * @applicableIdentity APP
  * @fqn wix.automations.esb.resolver.v1.EsbConfigResolver.BulkCancelEvent
  */
-export declare function bulkCancelEvent(triggerKey: string, externalEntityIds: string[]): Promise<BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields>;
+export declare function bulkCancelEvent(triggerKey: string, externalEntityIds: string[]): Promise<NonNullablePaths<BulkCancelEventResponse, `triggerKey` | `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.externalEntityId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 /**
  * Cancels any remaining actions for a trigger and external entity.
  *
@@ -2325,4 +2473,3 @@ export declare function bulkCancelEvent(triggerKey: string, externalEntityIds: s
  * @fqn wix.automations.esb.resolver.v1.EsbConfigResolver.CancelEvent
  */
 export declare function cancelEvent(triggerKey: string, externalEntityId: string): Promise<void>;
-export {};