@wix/auto_sdk_automations_automations-v-2 1.0.84 → 1.0.85

package/build/cjs/index.typings.d.ts

@@ -88,17 +88,19 @@ interface AIMetadata {
 }
 interface ActionSettings {
     /**
-     * Permanent actions. PermanentAction's skipActionExpression cannot be modified.
+     * IDs of actions whose `skipActionExpression` can't be modified.
      *
-     * When empty, all actions can be set as skipped
+     * An action's `skipActionExpression` determines whether the action is skipped. Including an action's ID in this array makes its `skipActionExpression` permanent, so it can't be changed.
+     *
+     * When empty, the `skipActionExpression` of all actions can be edited.
      * @maxSize 30
      * @format GUID
      */
     permanentActionIds?: string[];
     /**
-     * Read-only actions. Read-only actions cannot be edited.
+     * IDs of read-only actions. Read-only actions cannot be modified.
      *
-     * When empty, all actions are editable.
+     * When empty and the automation's `settings.readonly` is `false`, all actions are modifiable.
      * @maxSize 30
      * @format GUID
      */
@@ -308,15 +310,29 @@ declare enum Type {
     UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
     /** Defined by a [Wix app](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/configure-your-automation#app-defined-action). This action type is available in the site dashboard. */
     APP_DEFINED = "APP_DEFINED",
-    /** Condition. This determines which action runs next. */
+    /**
+     * Condition action. Evaluates a condition to determine which action runs next.
+     *
+     * Learn more about [adding and setting up conditions](https://support.wix.com/en/article/the-new-automation-builder-understanding-conditions-operators) in Wix Automations.
+     *
+     * > **Note**: When `skipActionExpression` evaluates to `true`, the actions in `conditionInfo.truePostActionIds` run and those in `conditionInfo.falsePostActionIds` are skipped.
+     */
     CONDITION = "CONDITION",
+    /**
+     * Code condition action. Evaluates custom code to determine which action runs next.
+     *
+     * Learn more about [adding and setting up conditions](https://support.wix.com/en/article/the-new-automation-builder-understanding-conditions-operators) in Wix Automations.
+     *
+     * > **Note**: When `skipActionExpression` evaluates to `true`, the actions in `codeConditionInfo.truePostActionIds` run and those in `codeConditionInfo.falsePostActionIds` are skipped.
+     */
+    CODE_CONDITION = "CODE_CONDITION",
     /** Delay. The automation must wait before executing the next step. */
     DELAY = "DELAY",
     /** Rate-limiter. This stops the automation flow if the subsequent action has reached its maximum allowed executions. */
     RATE_LIMIT = "RATE_LIMIT"
 }
 /** @enumType */
-type TypeWithLiterals = Type | 'UNKNOWN_ACTION_TYPE' | 'APP_DEFINED' | 'CONDITION' | 'DELAY' | 'RATE_LIMIT';
+type TypeWithLiterals = Type | 'UNKNOWN_ACTION_TYPE' | 'APP_DEFINED' | 'CONDITION' | 'CODE_CONDITION' | 'DELAY' | 'RATE_LIMIT';
 interface AppDefinedAction {
     /**
      * ID of the app that defines the action.
@@ -534,15 +550,15 @@ interface Trigger {
     overrideSchema?: Record<string, any> | null;
 }
 interface Action extends ActionInfoOneOf {
-    /** Details of the action when its `type` is `APP_DEFINED`. */
+    /** Details of the action whose `type` is `APP_DEFINED`. */
     appDefinedInfo?: AppDefinedAction;
-    /** Details of the action when its `type` is `CONDITION`. */
+    /** Details of the action whose `type` is `CONDITION`. */
     conditionInfo?: ConditionAction;
-    /** Details of the action when its `type` is `CODE_CONDITION`. */
+    /** Details of the action whose `type` is `CODE_CONDITION`. */
     codeConditionInfo?: CodeConditionAction;
-    /** Details of the action when its `type` is `DELAY`. */
+    /** Details of the action whose `type` is `DELAY`. */
     delayInfo?: DelayAction;
-    /** Details of the action when its `type` is `RATE_LIMIT`. */
+    /** Details of the action whose `type` is `RATE_LIMIT`. */
     rateLimitInfo?: RateLimitAction;
     /**
      * Action ID.
@@ -570,24 +586,24 @@ interface Action extends ActionInfoOneOf {
      */
     namespace?: string | null;
     /**
-     * Evaluated to boolean to decide whether the action is skipped.
-     * For ConditionAction: if skipped, true_post_action_ids execute; false_post_action_ids are skipped
-     * SplitAction and OutputAction do not support skip_action_expression
+     * Evaluated to determine whether the action is skipped. When evaluated to `true`, the action is skipped. Otherwise, the action runs.
+     *
+     * When empty, the action runs.
      * @maxLength 1000
      */
     skipActionExpression?: string | null;
 }
 /** @oneof */
 interface ActionInfoOneOf {
-    /** Details of the action when its `type` is `APP_DEFINED`. */
+    /** Details of the action whose `type` is `APP_DEFINED`. */
     appDefinedInfo?: AppDefinedAction;
-    /** Details of the action when its `type` is `CONDITION`. */
+    /** Details of the action whose `type` is `CONDITION`. */
     conditionInfo?: ConditionAction;
-    /** Details of the action when its `type` is `CODE_CONDITION`. */
+    /** Details of the action whose `type` is `CODE_CONDITION`. */
     codeConditionInfo?: CodeConditionAction;
-    /** Details of the action when its `type` is `DELAY`. */
+    /** Details of the action whose `type` is `DELAY`. */
     delayInfo?: DelayAction;
-    /** Details of the action when its `type` is `RATE_LIMIT`. */
+    /** Details of the action whose `type` is `RATE_LIMIT`. */
     rateLimitInfo?: RateLimitAction;
 }
 interface FilterableAppDefinedActions {
@@ -651,11 +667,12 @@ interface AutomationSettings {
     hidden?: boolean;
     /**
      * Whether the automation is read-only.
-     * If true - modifications to the automation trigger or action/s are disabled.
-     * **Note**: this setting takes precedent over triggerSettings/actionSettings.
-     * If false - allows selective read-only settings via those fields.
      *
-     * Default: `false`
+     * When `true`, site owners can't modify the automation or any of its actions. When `false`, users can configure specific actions as skippable or read-only using `settings.actionSettings`.
+     *
+     * Default: `false`.
+     *
+     * > **Note**: Setting `readOnly` to `true` overrides `settings.actionSettings`.
      */
     readonly?: boolean;
     /**
@@ -665,7 +682,7 @@ interface AutomationSettings {
      */
     disableDelete?: boolean;
     /**
-     * Whether to disable the option to change the automation's `configuration.status`, for example from `ACTIVE` to `INACTIVE`.
+     * Whether to disable the option to change the automation's `configuration.status`.
      *
      * Default: `false`.
      */

package/build/cjs/index.typings.js

@@ -861,6 +861,7 @@ var Type = /* @__PURE__ */ ((Type2) => {
   Type2["UNKNOWN_ACTION_TYPE"] = "UNKNOWN_ACTION_TYPE";
   Type2["APP_DEFINED"] = "APP_DEFINED";
   Type2["CONDITION"] = "CONDITION";
+  Type2["CODE_CONDITION"] = "CODE_CONDITION";
   Type2["DELAY"] = "DELAY";
   Type2["RATE_LIMIT"] = "RATE_LIMIT";
   return Type2;