@wix/auto_sdk_automations_automations-v-2 1.0.76 → 1.0.77

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

@@ -1895,93 +1895,123 @@ interface PublishDraftAutomationResponse {
 interface ValidateAutomationRequest {
     /** Automation to validate. */
     automation: Automation;
-    /** Automation validation settings. */
+    /**
+     * Validation settings.
+     *
+     * When not specified, validates the full automation including trigger, actions, and provider validations.
+     *
+     * > **Note**: Trigger and action providers can add custom validation logic by implementing the Validate Configuration method in the [trigger](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/validate-configuration) and [action service plugins](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/validate-configuration).
+     */
     validationSettings?: ValidationSettings;
 }
 interface ValidationSettings {
     /**
-     * IDs of actions to validate. Only actions whose IDs are specified are validated.
+     * IDs of actions to validate.
      *
-     * When action IDs are specified, triggers are not validated. When empty, the full automation is validated, including triggers.
+     * When specified, only these actions are validated. When empty, the full automation is validated including the trigger. Any validations added by the [trigger](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/introduction) and [action providers](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/introduction) are also performed.
      * @maxSize 30
      * @format GUID
      */
     actionIds?: string[];
     /**
-     * Whether to skip provider validations.
+     * Whether to skip [trigger](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/introduction) and [action provider](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/introduction) validations.
      *
      * Default: `false`.
      */
     skipProviderValidations?: boolean;
 }
 interface ValidateAutomationResponse {
-    /** Automation validation status. */
+    /** Validation status. */
     status?: ValidationResultStatusWithLiterals;
     /**
-     * Validation errors related to the automation's trigger configuration.
+     * Errors found in the automation's trigger.
      * @maxSize 100
      */
     triggerValidationErrors?: TriggerValidationError[];
     /**
-     * Validation errors related to the automation's actions configuration.
+     * Errors found in the automation's actions.
      * @maxSize 100
      */
     actionValidationErrors?: ActionValidationError[];
 }
 declare enum ValidationResultStatus {
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
-    /** Automation is valid - no validation errors found. */
+    /**
+     * Automation is valid. No errors found.
+     *
+     * You can save and run valid automations on user sites.
+     */
     VALID = "VALID",
-    /** Automation is partially valid - validation errors with Warning severity were found - might affect automation execution */
+    /**
+     * Automation is valid but contains at least one error with a `WARNING` severity.
+     *
+     * Errors with a `WARNING` allow you to save and run the automation on user sites, but this can result in unexpected behavior.
+     */
     VALID_WITH_WARNINGS = "VALID_WITH_WARNINGS",
-    /** Automation is not valid, validation errors with Critical severity were found - prevents proper automation/action execution and should be fixed. */
+    /**
+     * Automation is not valid. It contains at least one error with a `CRITICAL` severity.
+     *
+     * Errors with a `CRITICAL` severity do not allow you to save and run the automation on user sites.
+     */
     INVALID = "INVALID"
 }
 /** @enumType */
 type ValidationResultStatusWithLiterals = ValidationResultStatus | 'UNKNOWN_STATUS' | 'VALID' | 'VALID_WITH_WARNINGS' | 'INVALID';
 interface TriggerValidationError extends TriggerValidationErrorErrorOneOf {
-    /** Automation's Trigger configuration error. */
+    /** Error found in the automation's [trigger configuration](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/about-triggers#trigger-configuration). */
     configurationError?: TriggerConfigurationError;
-    /** Trigger Provider configuration error. */
+    /** Error found in how the [trigger provider](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/introduction) configured their trigger. */
     providerConfigurationError?: ProviderConfigurationError;
-    /** Validation error type. */
+    /** Error type. */
     errorType?: TriggerValidationErrorValidationErrorTypeWithLiterals;
-    /** Validation error severity */
+    /** Error severity. */
     errorSeverity?: SeverityWithLiterals;
 }
 /** @oneof */
 interface TriggerValidationErrorErrorOneOf {
-    /** Automation's Trigger configuration error. */
+    /** Error found in the automation's [trigger configuration](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/about-triggers#trigger-configuration). */
     configurationError?: TriggerConfigurationError;
-    /** Trigger Provider configuration error. */
+    /** Error found in how the [trigger provider](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/introduction) configured their trigger. */
     providerConfigurationError?: ProviderConfigurationError;
 }
 declare enum TriggerValidationErrorValidationErrorType {
     UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
-    /** Automation's Trigger Configuration error. */
+    /** Error found in the automation's [trigger configuration](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/about-triggers#trigger-configuration). */
     CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
-    /** Trigger Provider related error. */
+    /** Error found in how the [trigger provider](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/introduction) configured their trigger. */
     PROVIDER_ERROR = "PROVIDER_ERROR"
 }
 /** @enumType */
 type TriggerValidationErrorValidationErrorTypeWithLiterals = TriggerValidationErrorValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
 interface TriggerConfigurationError {
-    /** Trigger error type. */
+    /** Type of the trigger error. */
     errorType?: TriggerErrorTypeWithLiterals;
 }
 declare enum TriggerErrorType {
     UNKNOWN_TRIGGER_ERROR_TYPE = "UNKNOWN_TRIGGER_ERROR_TYPE",
-    /** Configured trigger was not found. */
+    /** Trigger was not found. */
     NOT_FOUND = "NOT_FOUND",
-    /** App not installed. */
+    /** Required app is not installed on the site. */
     APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
-    /** Invalid trigger key. */
+    /** Trigger key is invalid. */
     INVALID_TRIGGER_KEY = "INVALID_TRIGGER_KEY",
-    /** Invalid filter field key. */
+    /**
+     * Filter field key is invalid.
+     *
+     * Learn more about [trigger filter](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#filters).
+     */
     INVALID_FILTER_FIELD_KEY = "INVALID_FILTER_FIELD_KEY",
-    /** Invalid filter expression. */
+    /**
+     * Filter expression is invalid.
+     *
+     * Learn more about [trigger filter expressions](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#filters).
+     */
     INVALID_FILTER_EXPRESSION = "INVALID_FILTER_EXPRESSION",
-    /** Missing configuration for a required trigger filter */
+    /**
+     * Required trigger filter was not found.
+     *
+     * Learn more about [required trigger filters](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#filters).
+     */
     MISSING_REQUIRED_FILTER = "MISSING_REQUIRED_FILTER"
 }
 /** @enumType */
@@ -2009,125 +2039,159 @@ declare enum ValidationErrorSeverity {
 type ValidationErrorSeverityWithLiterals = ValidationErrorSeverity | 'UNKNOWN_VALIDATION_ERROR_SEVERITY' | 'WARNING' | 'ERROR';
 declare enum Severity {
     UNKNOWN_SEVERITY = "UNKNOWN_SEVERITY",
-    /** Low severity error - may affect automation execution. */
+    /**
+     * Low-severity error.
+     *
+     * Errors with a `WARNING` severity allow you to save and run the automation, but the results might be unexpected.
+     */
     WARNING = "WARNING",
-    /** Critical severity error - prevents proper automation execution and should be fixed. */
+    /**
+     * High-severity error.
+     *
+     * Errors with a `CRITICAL` severity do not allow you to save and run the automation.
+     */
     CRITICAL = "CRITICAL"
 }
 /** @enumType */
 type SeverityWithLiterals = Severity | 'UNKNOWN_SEVERITY' | 'WARNING' | 'CRITICAL';
 interface ActionValidationInfo {
     /**
-     * Action ID.
+     * ID of the [action as configured in the automation](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#configuring-actions).
      * @format GUID
      */
     actionId?: string | null;
     /**
-     * ID of the app that defined the action.
+     * ID of the [app that created the action](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#app-defined-action).
      * @format GUID
      */
     appId?: string;
     /**
-     * Human-readable action identifier.
+     * Action key.
+     *
+     * This identifies the action in the [app that defined it in the Wix Dev Center](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/introduction#how-to-set-up-an-action). This remains consistent across different automations.
      * @minLength 1
      * @maxLength 100
      */
     actionKey?: string;
     /**
-     * Action validation errors.
+     * Errors found in the action's configuration.
      * @maxSize 100
      */
     validationErrors?: ActionValidationError[];
 }
 interface ActionValidationError extends ActionValidationErrorErrorOneOf {
-    /** Action configuration error. */
+    /** Error found in the [configuration of the action in the automation](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#configuring-actions). */
     configurationError?: ActionConfigurationError;
-    /** Provider configuration error. */
+    /** Error found in the configuration of the action as added by the [action provider](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/introduction). */
     providerConfigurationError?: ProviderConfigurationError;
     /**
-     * Action Identifier in the Automation.
+     * ID of the action as [configured in the automation](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#configuring-actions).
      * @format GUID
      */
     actionId?: string;
     /**
-     * ID of the app that defined the action.
+     * ID of the [app that created the action](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#app-defined-action).
      * @format GUID
      */
     appId?: string;
     /**
-     * Human-readable action identifier.
+     * Action key.
+     *
+     * This remains consistent across different automations.
      * @minLength 1
      * @maxLength 100
      */
     actionKey?: string;
-    /** Validation error type. */
+    /** Error type. */
     errorType?: ValidationErrorTypeWithLiterals;
-    /** Validation error severity */
+    /** Error severity. */
     errorSeverity?: SeverityWithLiterals;
 }
 /** @oneof */
 interface ActionValidationErrorErrorOneOf {
-    /** Action configuration error. */
+    /** Error found in the [configuration of the action in the automation](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#configuring-actions). */
     configurationError?: ActionConfigurationError;
-    /** Provider configuration error. */
+    /** Error found in the configuration of the action as added by the [action provider](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/introduction). */
     providerConfigurationError?: ProviderConfigurationError;
 }
 declare enum ValidationErrorType {
     UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
-    /** Configuration error. */
+    /** Error found in how the [action is configured in the automation](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#configuring-actions). */
     CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
-    /** Provider error. */
+    /** Error found in how the [action provider](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/introduction) configured their action. */
     PROVIDER_ERROR = "PROVIDER_ERROR"
 }
 /** @enumType */
 type ValidationErrorTypeWithLiterals = ValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
 interface ActionConfigurationError {
-    /** Action error type. */
+    /** Error type. */
     errorType?: ActionErrorTypeWithLiterals;
 }
 declare enum ActionErrorType {
     UNKNOWN_ACTION_ERROR_TYPE = "UNKNOWN_ACTION_ERROR_TYPE",
-    /** Configured action was not found. */
+    /** Action was not found. */
     NOT_FOUND = "NOT_FOUND",
-    /** App not installed. */
+    /** Required app is not installed on the site. */
     APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
     /** Invalid action key. */
     INVALID_ACTION_KEY = "INVALID_ACTION_KEY",
-    /** Invalid mapping */
+    /**
+     * Invalid action mapping.
+     *
+     * At least one action parameter doesn't match the action's [input](https://dev.wix.com/docs/api-reference/business-management/automations/actions/about-actions#understanding-input-mapping) or other schema.
+     */
     INVALID_MAPPING = "INVALID_MAPPING",
-    /** Mapping type mismatch. */
+    /**
+     * Action mapping type mismatch.
+     *
+     * The type of at least one action parameter does not match the type configured in the action's [input](https://dev.wix.com/docs/api-reference/business-management/automations/actions/the-action-input-schema) or other schema.
+     */
     MAPPING_TYPE_MISMATCH = "MAPPING_TYPE_MISMATCH",
-    /** Mapping missing required field. */
+    /**
+     * Action mapping missing a required schema field.
+     *
+     * At least one field included in the action schema's [`required` array](https://dev.wix.com/docs/api-reference/business-management/automations/actions/the-action-input-schema#top-level-properties) is missing a matching action parameter.
+     */
     MAPPING_MISSING_REQUIRED_FIELD = "MAPPING_MISSING_REQUIRED_FIELD",
-    /** Mapping schema mismatch. */
+    /**
+     * Action schema mapping mismatch.
+     *
+     * The format or value of at least one action parameter does not match the action's [input](https://dev.wix.com/docs/api-reference/business-management/automations/actions/the-action-input-schema) or other schema.
+     */
     MAPPING_SCHEMA_MISMATCH = "MAPPING_SCHEMA_MISMATCH",
-    /** Mapping variable missing from schema. */
+    /** Action uses a variable not available to it in the current automation. */
     MAPPING_VARIABLE_MISSING_FROM_SCHEMA = "MAPPING_VARIABLE_MISSING_FROM_SCHEMA",
-    /** Configured post action not found. */
+    /**
+     * Configured post action not found.
+     *
+     * Learn more about [configuring actions](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#configuring-actions) in an automation.
+     */
     POST_ACTION_NOT_FOUND = "POST_ACTION_NOT_FOUND"
 }
 /** @enumType */
 type ActionErrorTypeWithLiterals = ActionErrorType | 'UNKNOWN_ACTION_ERROR_TYPE' | 'NOT_FOUND' | 'APP_NOT_INSTALLED' | 'INVALID_ACTION_KEY' | 'INVALID_MAPPING' | 'MAPPING_TYPE_MISMATCH' | 'MAPPING_MISSING_REQUIRED_FIELD' | 'MAPPING_SCHEMA_MISMATCH' | 'MAPPING_VARIABLE_MISSING_FROM_SCHEMA' | 'POST_ACTION_NOT_FOUND';
 interface AutomationValidationError extends AutomationValidationErrorErrorOneOf {
-    /** Automation configuration error. */
+    /** Error caused by an error in the automation's [configuration](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation). */
     configurationError?: AutomationConfigurationError;
-    /** Provider configuration error. */
+    /** Error caused by an error in how the [trigger](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/introduction) or [action provider](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/introduction) configured their trigger or action. */
     providerConfigurationError?: ProviderConfigurationError;
-    /** Validation error type. */
+    /** Error type. */
     errorType?: AutomationValidationErrorValidationErrorTypeWithLiterals;
-    /** Validation error severity */
+    /** Error severity. */
     errorSeverity?: SeverityWithLiterals;
 }
 /** @oneof */
 interface AutomationValidationErrorErrorOneOf {
-    /** Automation configuration error. */
+    /** Error caused by an error in the automation's [configuration](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation). */
     configurationError?: AutomationConfigurationError;
-    /** Provider configuration error. */
+    /** Error caused by an error in how the [trigger](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/introduction) or [action provider](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/introduction) configured their trigger or action. */
     providerConfigurationError?: ProviderConfigurationError;
 }
 declare enum AutomationValidationErrorValidationErrorType {
     UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
+    /** Automation-level error caused by an error in the automation's configuration. */
     CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
+    /** Error caused by an error in how the [trigger](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/introduction) or [action provider](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/introduction) configured the automation. */
     PROVIDER_ERROR = "PROVIDER_ERROR"
 }
 /** @enumType */
@@ -2154,12 +2218,12 @@ interface ValidateAutomationByIdResponse {
     /** Automation validation status. */
     status?: ValidationResultStatusWithLiterals;
     /**
-     * Validation errors related to the automation's trigger configuration.
+     * Errors found in the trigger configuration.
      * @maxSize 100
      */
     triggerValidationErrors?: TriggerValidationError[];
     /**
-     * Validation errors related to the automation's actions configuration.
+     * Errors found in the configuration of one or more of the automation's actions.
      * @maxSize 100
      */
     actionValidationErrors?: ActionValidationError[];
@@ -2940,7 +3004,15 @@ declare function deleteDraftAutomation(automationId: string): Promise<void>;
  */
 declare function publishDraftAutomation(automationId: string): Promise<NonNullablePaths<PublishDraftAutomationResponse, `automation.applicationInfo.appId` | `automation.preinstalledInfo.appId` | `automation.createdBy.userId` | `automation.createdBy.appId` | `automation.name` | `automation.configuration.status` | `automation.configuration.trigger.appId` | `automation.configuration.trigger.triggerKey` | `automation.configuration.trigger.filters` | `automation.configuration.trigger.filters.${number}._id` | `automation.configuration.trigger.filters.${number}.fieldKey` | `automation.configuration.trigger.filters.${number}.filterExpression` | `automation.configuration.trigger.scheduledEventOffset.preScheduledEventOffsetExpression` | `automation.configuration.trigger.scheduledEventOffset.scheduledEventOffsetTimeUnit` | `automation.configuration.trigger.rateLimit.maxActivationsExpression` | `automation.configuration.trigger.rateLimit.durationTimeUnit` | `automation.configuration.rootActionIds` | `automation.origin` | `automation.settings.hidden` | `automation.settings.readonly` | `automation.settings.disableDelete` | `automation.settings.disableStatusChange` | `automation.settings.actionSettings.permanentActionIds` | `automation.settings.actionSettings.readonlyActionIds` | `automation.archived`, 7>>;
 /**
- * Validates the specified automation.
+ * Validates an automation. A valid automation has no validation errors.
+ *
+ * This method:
+ *
+ * - Validates that the [trigger is properly configured](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#configuring-the-trigger).
+ * - Validates that all [actions are properly configured](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#configuring-actions) with correct [input](https://dev.wix.com/docs/api-reference/business-management/automations/actions/about-actions#understanding-input-mapping) and other mappings.
+ * - Validates custom logic added by [trigger](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/validate-configuration) and [action providers](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/validate-configuration).
+ *
+ * > **Note**: This method identifies configuration errors but doesn't fix them. It does not modify the automation.
  * @param automation - Automation to validate.
  * @public
  * @documentationMaturity preview
@@ -2951,7 +3023,13 @@ declare function publishDraftAutomation(automationId: string): Promise<NonNullab
  */
 declare function validateAutomation(automation: Automation, options?: ValidateAutomationOptions): Promise<NonNullablePaths<ValidateAutomationResponse, `status` | `triggerValidationErrors` | `triggerValidationErrors.${number}.configurationError.errorType` | `triggerValidationErrors.${number}.providerConfigurationError.message` | `triggerValidationErrors.${number}.providerConfigurationError.title` | `triggerValidationErrors.${number}.errorType` | `triggerValidationErrors.${number}.errorSeverity` | `actionValidationErrors` | `actionValidationErrors.${number}.configurationError.errorType` | `actionValidationErrors.${number}.providerConfigurationError.message` | `actionValidationErrors.${number}.providerConfigurationError.title` | `actionValidationErrors.${number}.actionId` | `actionValidationErrors.${number}.appId` | `actionValidationErrors.${number}.actionKey` | `actionValidationErrors.${number}.errorType` | `actionValidationErrors.${number}.errorSeverity`, 5>>;
 interface ValidateAutomationOptions {
-    /** Automation validation settings. */
+    /**
+     * Validation settings.
+     *
+     * When not specified, validates the full automation including trigger, actions, and provider validations.
+     *
+     * > **Note**: Trigger and action providers can add custom validation logic by implementing the Validate Configuration method in the [trigger](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/validate-configuration) and [action service plugins](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/validate-configuration).
+     */
     validationSettings?: ValidationSettings;
 }
 /**