@wix/auto_sdk_automations_automations-v-2 1.0.77 → 1.0.79

package/build/es/index.typings.d.mts

@@ -1898,7 +1898,7 @@ interface ValidateAutomationRequest {
     /**
      * Validation settings.
      *
-     * When not specified, validates the full automation including trigger, actions, and provider validations.
+     * When not specified, the method validates the full automation. This includes the trigger, actions, and provider validation logic.
      *
      * > **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).
      */
@@ -1908,7 +1908,9 @@ interface ValidationSettings {
     /**
      * IDs of actions to validate.
      *
-     * 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.
+     * When specified, only these actions are validated.
+     *
+     * When not specified, the full automation is validated. This includes the trigger, actions, and custom logic added by the [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).
      * @maxSize 30
      * @format GUID
      */
@@ -1924,12 +1926,12 @@ interface ValidateAutomationResponse {
     /** Validation status. */
     status?: ValidationResultStatusWithLiterals;
     /**
-     * Errors found in the automation's trigger.
+     * Errors found in the automation's [trigger](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/about-triggers).
      * @maxSize 100
      */
     triggerValidationErrors?: TriggerValidationError[];
     /**
-     * Errors found in the automation's actions.
+     * Errors in the automation's [action configurations](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#configuring-actions).
      * @maxSize 100
      */
     actionValidationErrors?: ActionValidationError[];
@@ -1958,7 +1960,7 @@ declare enum ValidationResultStatus {
 /** @enumType */
 type ValidationResultStatusWithLiterals = ValidationResultStatus | 'UNKNOWN_STATUS' | 'VALID' | 'VALID_WITH_WARNINGS' | 'INVALID';
 interface TriggerValidationError extends TriggerValidationErrorErrorOneOf {
-    /** Error found in the automation's [trigger configuration](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/about-triggers#trigger-configuration). */
+    /** Error in the automation's [trigger configuration](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#configuring-the-trigger). */
     configurationError?: TriggerConfigurationError;
     /** 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;
@@ -1969,14 +1971,14 @@ interface TriggerValidationError extends TriggerValidationErrorErrorOneOf {
 }
 /** @oneof */
 interface TriggerValidationErrorErrorOneOf {
-    /** Error found in the automation's [trigger configuration](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/about-triggers#trigger-configuration). */
+    /** Error in the automation's [trigger configuration](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#configuring-the-trigger). */
     configurationError?: TriggerConfigurationError;
     /** 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",
-    /** Error found in the automation's [trigger configuration](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/about-triggers#trigger-configuration). */
+    /** Error found in the automation's [trigger configuration](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#configuring-the-trigger). */
     CONFIGURATION_ERROR = "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. */
     PROVIDER_ERROR = "PROVIDER_ERROR"
@@ -2017,15 +2019,15 @@ declare enum TriggerErrorType {
 /** @enumType */
 type TriggerErrorTypeWithLiterals = TriggerErrorType | 'UNKNOWN_TRIGGER_ERROR_TYPE' | 'NOT_FOUND' | 'APP_NOT_INSTALLED' | 'INVALID_TRIGGER_KEY' | 'INVALID_FILTER_FIELD_KEY' | 'INVALID_FILTER_EXPRESSION' | 'MISSING_REQUIRED_FILTER';
 interface ProviderConfigurationError {
-    /** Key corresponding to the field in the schema. */
+    /** Scheme field key. */
     fieldKey?: string | null;
     /** Error message. */
     message?: string;
-    /** Label for a call-to-action button that's displayed with the error. Translated according to the SPI language context. */
+    /** Label for the call-to-action button displayed with the error. */
     ctaLabel?: string | null;
-    /** URL to redirect to when the call-to-action button is clicked. */
+    /** When the call-to-action button is clicked, the redirect URL. */
     ctaUrl?: string | null;
-    /** Title for the error. */
+    /** Error title. */
     title?: string;
 }
 declare enum ValidationErrorSeverity {
@@ -2116,9 +2118,9 @@ interface ActionValidationErrorErrorOneOf {
 }
 declare enum ValidationErrorType {
     UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
-    /** 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). */
+    /** Error in the [action configuration](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#configuring-actions). */
     CONFIGURATION_ERROR = "CONFIGURATION_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. */
+    /** Error in the [action provider configuration](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/introduction). */
     PROVIDER_ERROR = "PROVIDER_ERROR"
 }
 /** @enumType */
@@ -3026,7 +3028,7 @@ interface ValidateAutomationOptions {
     /**
      * Validation settings.
      *
-     * When not specified, validates the full automation including trigger, actions, and provider validations.
+     * When not specified, the method validates the full automation. This includes the trigger, actions, and provider validation logic.
      *
      * > **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).
      */