@wix/automations 1.0.65 → 1.0.66

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/automations",
-  "version": "1.0.65",
+  "version": "1.0.66",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -21,7 +21,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/automations_activations": "1.0.38",
+    "@wix/automations_activations": "1.0.39",
     "@wix/automations_automations-service": "1.0.30",
     "@wix/automations_automations-service-v-2": "1.0.38"
   },
@@ -48,5 +48,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "31485e471243aa59e571d9b5f9ff7ed99f6640352deb864e4b438732"
+  "falconPackageHash": "238a9a079e7f3a77451b85eff148d3ad9621c39d10ec5b18f1a8fda5"
 }

package/type-bundles/context.bundle.d.ts

@@ -2405,9 +2405,9 @@ interface ActionSettings$1 {
     disableConditionAddition?: boolean;
 }
 declare enum Domain$1 {
-    /** User domain (default) */
+    /** User domain (default). */
     USER = "USER",
-    /** Wix domain */
+    /** Wix domain. */
     WIX = "WIX"
 }
 interface AuditInfo$1 extends AuditInfoIdOneOf$1 {
@@ -2484,19 +2484,19 @@ declare enum Operator$1 {
     AND = "AND"
 }
 declare enum Type$1 {
-    /** Automation will be triggered according to the trigger configuration */
+    /** Automation will be triggered according to the trigger configuration. */
     UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
-    /** App defined Action */
+    /** App defined Action. */
     APP_DEFINED = "APP_DEFINED",
-    /** Condition Action */
+    /** Condition Action. */
     CONDITION = "CONDITION",
-    /** Delay Action */
+    /** Delay Action. */
     DELAY = "DELAY",
-    /** RateLimit Action */
+    /** RateLimit Action. */
     RATE_LIMIT = "RATE_LIMIT",
-    /** Set Variables Action */
+    /** Set Variables Action. */
     SET_VARIABLES = "SET_VARIABLES",
-    /** Output Action */
+    /** Output Action. */
     OUTPUT = "OUTPUT"
 }
 interface AppDefinedAction$1 {
@@ -2628,13 +2628,13 @@ interface AutomationConfigurationActionInfoOneOf {
     rateLimitInfo?: RateLimitAction$1;
 }
 declare enum Origin$1 {
-    /** default value. this is unused */
+    /** Default value. This is unused. */
     UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
-    /** user created automation */
+    /** User created automation. */
     USER = "USER",
-    /** automation created by application (site specific) */
+    /** Automation created by application (site specific). */
     APPLICATION = "APPLICATION",
-    /** preinstalled application automation */
+    /** Preinstalled application automation. */
     PREINSTALLED = "PREINSTALLED"
 }
 interface ApplicationOrigin$1 {
@@ -2684,7 +2684,7 @@ interface AutomationSettings$1 {
 }
 interface DraftInfo$1 {
     /**
-     * optional - automationId of the original automation
+     * Optional - automationId of the original automation.
      * @readonly
      */
     originalAutomationId?: string | null;
@@ -2747,13 +2747,13 @@ declare enum Target {
 }
 declare enum CancellationReason {
     UNKNOWN_CANCELLATION_REASON = "UNKNOWN_CANCELLATION_REASON",
-    /** Indicating that the activation was cancelled by the provider */
+    /** Indicates that the activation was cancelled directly. */
     EVENT_CANCELLED = "EVENT_CANCELLED",
-    /** Indicating that the activation is cancelled because the automation was deactivated */
+    /** Indicates that the activation was cancelled because the automation was deactivated. */
     AUTOMATION_DEACTIVATED = "AUTOMATION_DEACTIVATED",
-    /** Indicating that the activation is cancelled because the automation was deleted */
+    /** Indicates that the activation was cancelled because the automation was deleted. */
     AUTOMATION_DELETED = "AUTOMATION_DELETED",
-    /** Indicating that the activation is cancelled after the automation schedule time was reached */
+    /** Indicates that the activation was cancelled after the automation schedule time was reached. */
     CANCELLED_BY_REFRESH_PAYLOAD = "CANCELLED_BY_REFRESH_PAYLOAD"
 }
 interface Identity {
@@ -2764,19 +2764,19 @@ interface Identity {
 }
 declare enum ActivationStatusChangedStatus {
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
-    /** This indicates activation is not started yet (no action has run yet) */
+    /** Indicates that activation has not started yet and no actions have been executed. */
     INITIATED = "INITIATED",
-    /** The activation is in scheduled status when the automation has future date or debounce defined and we're in the waiting stage (no action has run yet) */
+    /** Activation is in scheduled status when the automation has a future date or debounce defined and we're in the waiting stage and no actions have been executed. */
     SCHEDULED = "SCHEDULED",
-    /** This indicates the automation activation has started and currently in progress */
+    /** Indicates the automation activation has started and is currently in progress. */
     STARTED = "STARTED",
-    /** This indicates all the automation actions were handled either by invoking them, skipping them etc. */
+    /** Indicates all the automation actions were handled either by invoking them, skipping them, etc. */
     ENDED = "ENDED",
-    /** This indicates the activation was cancelled */
+    /** Indicates the activation was cancelled. */
     CANCELLED = "CANCELLED",
     /**
-     * This indicates the activation failed to start
-     * Note that failure in the activation of a single action will not result a failure in activation of the entire automation
+     * Indicates the activation failed to start.
+     * Note that failure in the activation of a single action will not result in a failure in activation of the entire automation.
      */
     FAILED = "FAILED"
 }
@@ -2793,13 +2793,13 @@ interface InitiatedStatusInfo {
 interface ScheduledStatusInfo {
     /** Schedule identifier */
     scheduleId?: string;
-    /** Indicating when the activation should start */
+    /** Indicates when the activation should start */
     date?: Date | null;
 }
 interface CancelledStatusInfo {
     /** Cancellation reason */
     reason?: CancellationReason;
-    /** The identity (such as user, app etc.) that caused the cancellation */
+    /** Identity (such as user, app, etc.) that caused the cancellation. */
     initiator?: Identity;
 }
 interface ActivationStatusChangedFailedStatusInfo {
@@ -3319,11 +3319,11 @@ interface ExpressionEvaluationResult {
     error?: boolean;
 }
 interface AppDefinedActionInfo {
-    /** The output that the action implementer returned */
+    /** Output returned by the action implementer. */
     output?: Record<string, any> | null;
 }
 interface ConditionActionInfo {
-    /** Indicates that the condition `if` clause evaluated to `true` */
+    /** Indicates that the condition `if` clause evaluated to `true`. */
     passed?: boolean;
     /** Collects results per each expression evaluation that took place */
     expressionResults?: Record<string, ExpressionEvaluationResult>;
@@ -3352,23 +3352,23 @@ interface AutomationInfoOriginInfoOneOf {
 declare enum ActivationActionStatusChangedStatus {
     UNKNOWN_ACTION_ACTIVATION_STATUS = "UNKNOWN_ACTION_ACTIVATION_STATUS",
     /**
-     * Indicating that action activation has been started and it's in progress
-     * Relevant to action types: APP_DEFINED, DELAY
+     * Indicates that action activation has started and is in progress.
+     * Relevant to action types: APP_DEFINED, DELAY.
      */
     STARTED = "STARTED",
     /**
-     * Indicating that the action activation is completed without errors
-     * Relevant to action types: APP_DEFINED, DELAY, CONDITION, RATE_LIMIT
+     * Indicates that the action activation was completed without errors.
+     * Relevant to action types: APP_DEFINED, DELAY, CONDITION, RATE_LIMIT.
      */
     ENDED = "ENDED",
     /**
-     * Indicating that the action is skipped and post actions will not start
-     * Relevant to action types: APP_DEFINED
+     * Indicates that the action was skipped and post actions won't start.
+     * Relevant to action types: APP_DEFINED.
      */
     SKIPPED = "SKIPPED",
     /**
-     * Indicating that the action failed
-     * Relevant to action types: APP_DEFINED, DELAY, RATE_LIMIT
+     * Indicates that the action failed.
+     * Relevant to action types: APP_DEFINED, DELAY, RATE_LIMIT.
      */
     FAILED = "FAILED"
 }

package/type-bundles/index.bundle.d.ts

@@ -2405,9 +2405,9 @@ interface ActionSettings$1 {
     disableConditionAddition?: boolean;
 }
 declare enum Domain$1 {
-    /** User domain (default) */
+    /** User domain (default). */
     USER = "USER",
-    /** Wix domain */
+    /** Wix domain. */
     WIX = "WIX"
 }
 interface AuditInfo$1 extends AuditInfoIdOneOf$1 {
@@ -2484,19 +2484,19 @@ declare enum Operator$1 {
     AND = "AND"
 }
 declare enum Type$1 {
-    /** Automation will be triggered according to the trigger configuration */
+    /** Automation will be triggered according to the trigger configuration. */
     UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
-    /** App defined Action */
+    /** App defined Action. */
     APP_DEFINED = "APP_DEFINED",
-    /** Condition Action */
+    /** Condition Action. */
     CONDITION = "CONDITION",
-    /** Delay Action */
+    /** Delay Action. */
     DELAY = "DELAY",
-    /** RateLimit Action */
+    /** RateLimit Action. */
     RATE_LIMIT = "RATE_LIMIT",
-    /** Set Variables Action */
+    /** Set Variables Action. */
     SET_VARIABLES = "SET_VARIABLES",
-    /** Output Action */
+    /** Output Action. */
     OUTPUT = "OUTPUT"
 }
 interface AppDefinedAction$1 {
@@ -2628,13 +2628,13 @@ interface AutomationConfigurationActionInfoOneOf {
     rateLimitInfo?: RateLimitAction$1;
 }
 declare enum Origin$1 {
-    /** default value. this is unused */
+    /** Default value. This is unused. */
     UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
-    /** user created automation */
+    /** User created automation. */
     USER = "USER",
-    /** automation created by application (site specific) */
+    /** Automation created by application (site specific). */
     APPLICATION = "APPLICATION",
-    /** preinstalled application automation */
+    /** Preinstalled application automation. */
     PREINSTALLED = "PREINSTALLED"
 }
 interface ApplicationOrigin$1 {
@@ -2684,7 +2684,7 @@ interface AutomationSettings$1 {
 }
 interface DraftInfo$1 {
     /**
-     * optional - automationId of the original automation
+     * Optional - automationId of the original automation.
      * @readonly
      */
     originalAutomationId?: string | null;
@@ -2747,13 +2747,13 @@ declare enum Target {
 }
 declare enum CancellationReason {
     UNKNOWN_CANCELLATION_REASON = "UNKNOWN_CANCELLATION_REASON",
-    /** Indicating that the activation was cancelled by the provider */
+    /** Indicates that the activation was cancelled directly. */
     EVENT_CANCELLED = "EVENT_CANCELLED",
-    /** Indicating that the activation is cancelled because the automation was deactivated */
+    /** Indicates that the activation was cancelled because the automation was deactivated. */
     AUTOMATION_DEACTIVATED = "AUTOMATION_DEACTIVATED",
-    /** Indicating that the activation is cancelled because the automation was deleted */
+    /** Indicates that the activation was cancelled because the automation was deleted. */
     AUTOMATION_DELETED = "AUTOMATION_DELETED",
-    /** Indicating that the activation is cancelled after the automation schedule time was reached */
+    /** Indicates that the activation was cancelled after the automation schedule time was reached. */
     CANCELLED_BY_REFRESH_PAYLOAD = "CANCELLED_BY_REFRESH_PAYLOAD"
 }
 interface Identity {
@@ -2764,19 +2764,19 @@ interface Identity {
 }
 declare enum ActivationStatusChangedStatus {
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
-    /** This indicates activation is not started yet (no action has run yet) */
+    /** Indicates that activation has not started yet and no actions have been executed. */
     INITIATED = "INITIATED",
-    /** The activation is in scheduled status when the automation has future date or debounce defined and we're in the waiting stage (no action has run yet) */
+    /** Activation is in scheduled status when the automation has a future date or debounce defined and we're in the waiting stage and no actions have been executed. */
     SCHEDULED = "SCHEDULED",
-    /** This indicates the automation activation has started and currently in progress */
+    /** Indicates the automation activation has started and is currently in progress. */
     STARTED = "STARTED",
-    /** This indicates all the automation actions were handled either by invoking them, skipping them etc. */
+    /** Indicates all the automation actions were handled either by invoking them, skipping them, etc. */
     ENDED = "ENDED",
-    /** This indicates the activation was cancelled */
+    /** Indicates the activation was cancelled. */
     CANCELLED = "CANCELLED",
     /**
-     * This indicates the activation failed to start
-     * Note that failure in the activation of a single action will not result a failure in activation of the entire automation
+     * Indicates the activation failed to start.
+     * Note that failure in the activation of a single action will not result in a failure in activation of the entire automation.
      */
     FAILED = "FAILED"
 }
@@ -2793,13 +2793,13 @@ interface InitiatedStatusInfo {
 interface ScheduledStatusInfo {
     /** Schedule identifier */
     scheduleId?: string;
-    /** Indicating when the activation should start */
+    /** Indicates when the activation should start */
     date?: Date | null;
 }
 interface CancelledStatusInfo {
     /** Cancellation reason */
     reason?: CancellationReason;
-    /** The identity (such as user, app etc.) that caused the cancellation */
+    /** Identity (such as user, app, etc.) that caused the cancellation. */
     initiator?: Identity;
 }
 interface ActivationStatusChangedFailedStatusInfo {
@@ -3319,11 +3319,11 @@ interface ExpressionEvaluationResult {
     error?: boolean;
 }
 interface AppDefinedActionInfo {
-    /** The output that the action implementer returned */
+    /** Output returned by the action implementer. */
     output?: Record<string, any> | null;
 }
 interface ConditionActionInfo {
-    /** Indicates that the condition `if` clause evaluated to `true` */
+    /** Indicates that the condition `if` clause evaluated to `true`. */
     passed?: boolean;
     /** Collects results per each expression evaluation that took place */
     expressionResults?: Record<string, ExpressionEvaluationResult>;
@@ -3352,23 +3352,23 @@ interface AutomationInfoOriginInfoOneOf {
 declare enum ActivationActionStatusChangedStatus {
     UNKNOWN_ACTION_ACTIVATION_STATUS = "UNKNOWN_ACTION_ACTIVATION_STATUS",
     /**
-     * Indicating that action activation has been started and it's in progress
-     * Relevant to action types: APP_DEFINED, DELAY
+     * Indicates that action activation has started and is in progress.
+     * Relevant to action types: APP_DEFINED, DELAY.
      */
     STARTED = "STARTED",
     /**
-     * Indicating that the action activation is completed without errors
-     * Relevant to action types: APP_DEFINED, DELAY, CONDITION, RATE_LIMIT
+     * Indicates that the action activation was completed without errors.
+     * Relevant to action types: APP_DEFINED, DELAY, CONDITION, RATE_LIMIT.
      */
     ENDED = "ENDED",
     /**
-     * Indicating that the action is skipped and post actions will not start
-     * Relevant to action types: APP_DEFINED
+     * Indicates that the action was skipped and post actions won't start.
+     * Relevant to action types: APP_DEFINED.
      */
     SKIPPED = "SKIPPED",
     /**
-     * Indicating that the action failed
-     * Relevant to action types: APP_DEFINED, DELAY, RATE_LIMIT
+     * Indicates that the action failed.
+     * Relevant to action types: APP_DEFINED, DELAY, RATE_LIMIT.
      */
     FAILED = "FAILED"
 }