@wix/auto_sdk_automations_automations-v-2 1.0.78 → 1.0.80

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

@@ -1,4 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
 interface Automation extends AutomationOriginInfoOneOf {
     /** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
@@ -1895,107 +1895,139 @@ interface PublishDraftAutomationResponse {
 interface ValidateAutomationRequest {
     /** Automation to validate. */
     automation: Automation;
-    /** Automation validation settings. */
+    /**
+     * Validation settings.
+     *
+     * 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).
+     */
     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 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
      */
     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](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/about-triggers).
      * @maxSize 100
      */
     triggerValidationErrors?: TriggerValidationError[];
     /**
-     * Validation errors related to the automation's actions configuration.
+     * 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[];
 }
 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 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;
-    /** 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 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;
-    /** 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/automations/automations-v2/configure-your-automation#configuring-the-trigger). */
     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 */
 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 {
@@ -2009,125 +2041,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 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",
-    /** Provider error. */
+    /** 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 */
 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 +2220,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[];
@@ -2696,7 +2762,87 @@ interface AutomationsQueryBuilder {
  * @fqn wix.automations.v2.AutomationsService.QueryAutomations
  * @requiredField query
  */
-declare function typedQueryAutomations(query: CursorQuery, options?: QueryAutomationsOptions): Promise<NonNullablePaths<QueryAutomationsResponse, `automations` | `automations.${number}.applicationInfo.appId` | `automations.${number}.preinstalledInfo.appId` | `automations.${number}.createdBy.userId` | `automations.${number}.createdBy.appId` | `automations.${number}.name` | `automations.${number}.configuration.status` | `automations.${number}.configuration.trigger.appId` | `automations.${number}.configuration.trigger.triggerKey` | `automations.${number}.origin` | `automations.${number}.settings.hidden` | `automations.${number}.settings.readonly` | `automations.${number}.settings.disableDelete` | `automations.${number}.settings.disableStatusChange` | `automations.${number}.archived`, 6>>;
+declare function typedQueryAutomations(query: AutomationQuery, options?: QueryAutomationsOptions): Promise<NonNullablePaths<QueryAutomationsResponse, `automations` | `automations.${number}.applicationInfo.appId` | `automations.${number}.preinstalledInfo.appId` | `automations.${number}.createdBy.userId` | `automations.${number}.createdBy.appId` | `automations.${number}.name` | `automations.${number}.configuration.status` | `automations.${number}.configuration.trigger.appId` | `automations.${number}.configuration.trigger.triggerKey` | `automations.${number}.origin` | `automations.${number}.settings.hidden` | `automations.${number}.settings.readonly` | `automations.${number}.settings.disableDelete` | `automations.${number}.settings.disableStatusChange` | `automations.${number}.archived`, 6>>;
+interface AutomationQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: [
+                'configuration.trigger.filterValueSelection.selectedFilterValues',
+                'configuration.trigger.filters',
+                'settings.actionSettings.permanentActionIds',
+                'settings.actionSettings.readonlyActionIds'
+            ];
+            operators: ['$hasAll', '$hasSome'];
+            sort: 'BOTH';
+        },
+        {
+            fields: [
+                'archived',
+                'configuration.status',
+                'configuration.trigger.appId',
+                'configuration.trigger.triggerKey',
+                'createdBy.appId',
+                'name',
+                'origin',
+                'settings',
+                'settings.actionSettings',
+                'settings.disableDelete',
+                'settings.disableStatusChange',
+                'settings.readonly'
+            ];
+            operators: '*';
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Automation, AutomationQuerySpec>;
+type AutomationQuery = {
+    /**
+    Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 500
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 64000
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object in the following format:
+    `"filter" : {
+    "fieldName1": "value1",
+    "fieldName2": { "$operator": "value2" }
+    }`
+  
+    Learn more about [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort configuration in the following format:
+    `[{ "fieldName": "sortField1", "order": "ASC" }, { "fieldName":" sortField2", "order": "DESC" }]`
+    @maxSize: 5
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
 /**
  * Get aggregated info
  * @public
@@ -2940,7 +3086,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 +3105,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, 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).
+     */
     validationSettings?: ValidationSettings;
 }
 /**
@@ -2990,4 +3150,4 @@ interface GetAutomationRevisionOptions {
     fields?: RequestedFieldsWithLiterals[];
 }
 
-export { type AIMetadata, type Action, type ActionConfigurationError, ActionErrorType, type ActionErrorTypeWithLiterals, type ActionEvent, type ActionInfoOneOf, type ActionProviderQuotaInfo, type ActionQuotaInfo, type ActionSettings, type ActionUsageSummary, type ActionValidationError, type ActionValidationErrorErrorOneOf, type ActionValidationInfo, type AdditionalInfo, type AppDefinedAction, type ApplicationError, type ApplicationOrigin, type Asset, type AuditInfo, type AuditInfoIdOneOf, type AutoArchivePolicy, type Automation, type AutomationConfiguration, type AutomationConfigurationError, type AutomationCreatedEnvelope, type AutomationDeletedEnvelope, AutomationErrorType, type AutomationErrorTypeWithLiterals, type AutomationOriginInfoOneOf, type AutomationSettings, type AutomationUpdatedEnvelope, type AutomationValidationError, type AutomationValidationErrorErrorOneOf, AutomationValidationErrorValidationErrorType, type AutomationValidationErrorValidationErrorTypeWithLiterals, type AutomationsQueryBuilder, type AutomationsQueryResult, type BaseEventMetadata, type BulkActionMetadata, type BulkCountAutomationsWithDraftsOptions, type BulkCountAutomationsWithDraftsRequest, type BulkCountAutomationsWithDraftsResponse, type BulkDeleteAutomationsRequest, type BulkDeleteAutomationsResponse, type BulkDeleteResult, type CTA, type CodeConditionAction, type CodeSnippet, type ConditionAction, type ConditionExpressionGroup, type CopyAutomationOptions, type CopyAutomationRequest, type CopyAutomationResponse, type CreateAutomationRequest, type CreateAutomationResponse, type CreateDraftAutomationOptions, type CreateDraftAutomationRequest, type CreateDraftAutomationResponse, type CreatePreinstalledAutomationRequest, type CreatePreinstalledAutomationResponse, type CreatedByAppIdUsageSummary, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DelayAction, type DeleteAutomationRequest, type DeleteAutomationResponse, type DeleteContext, type DeleteDraftAutomationRequest, type DeleteDraftAutomationResponse, type DeletePreinstalledAutomationRequest, type DeletePreinstalledAutomationResponse, DeleteStatus, type DeleteStatusWithLiterals, type Dimensions, Domain, type DomainEvent, type DomainEventBodyOneOf, type DomainWithLiterals, type DraftInfo, type DraftPublished, type DraftsInfo, type Empty, type Enrichment, type Enrichments, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type Filter, type FilterValueSelection, type FilterableAppDefinedActions, type FutureDateActivationOffset, type GeneratePreinstalledAutomationOptions, type GeneratePreinstalledAutomationRequest, type GeneratePreinstalledAutomationResponse, type GetActionsQuotaInfoRequest, type GetActionsQuotaInfoResponse, type GetAggregatedUsageInfoOptions, type GetAggregatedUsageInfoRequest, type GetAggregatedUsageInfoResponse, type GetAutomationActionSchemaRequest, type GetAutomationActionSchemaResponse, type GetAutomationRequest, type GetAutomationResponse, type GetAutomationRevisionOptions, type GetAutomationRevisionRequest, type GetAutomationRevisionResponse, type GetOrCreateDraftAutomationRequest, type GetOrCreateDraftAutomationResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, Language, type LanguageWithLiterals, type MergeOverridePreinstalledWithRuntimeVersionRequest, type MergeOverridePreinstalledWithRuntimeVersionResponse, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type MigrateVeloActionAutomationsRequest, type MigrateVeloActionAutomationsResponse, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type Note, type Notes, type OdeditorAssigned, type OdeditorUnassigned, type Offset, Operator, type OperatorWithLiterals, Origin, type OriginAutomationInfo, type OriginWithLiterals, type OutputAction, type Path, type PicassoAssigned, type PicassoUnassigned, type Plan, type Position, type PreinstalledAutomationSpecInfo, type PreinstalledOrigin, type ProviderConfigurationError, type PublishDraftAutomationRequest, type PublishDraftAutomationResponse, type QueryAutomationsOptions, type QueryAutomationsRequest, type QueryAutomationsResponse, type QueryAutomationsWithDraftsOptions, type QueryAutomationsWithDraftsRequest, type QueryAutomationsWithDraftsResponse, type QueryDraftAutomationsRequest, type QueryDraftAutomationsResponse, type QueryPreinstalledAutomationsForAppRequest, type QueryPreinstalledAutomationsForAppResponse, type QueryPreinstalledAutomationsRequest, type QueryPreinstalledAutomationsResponse, type Quota, type QuotaInfo, type RateLimit, type RateLimitAction, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type ServiceProvisioned, type ServiceRemoved, type SetVariablesAction, Severity, type SeverityWithLiterals, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, type SplitAction, State, type StateWithLiterals, Status, type StatusWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, TimeUnit, type TimeUnitWithLiterals, type Trigger, type TriggerConfigurationError, TriggerErrorType, type TriggerErrorTypeWithLiterals, type TriggerSettings, type TriggerUsageSummary, type TriggerValidationError, type TriggerValidationErrorErrorOneOf, TriggerValidationErrorValidationErrorType, type TriggerValidationErrorValidationErrorTypeWithLiterals, Type, type TypeWithLiterals, type UpdateAutomation, type UpdateAutomationRequest, type UpdateAutomationResponse, type UpdateDraftAutomation, type UpdateDraftAutomationRequest, type UpdateDraftAutomationResponse, type UpdatePreinstalledAutomationRequest, type UpdatePreinstalledAutomationResponse, type UpgradeCTA, type ValidateAutomationByIdOptions, type ValidateAutomationByIdRequest, type ValidateAutomationByIdResponse, type ValidateAutomationOptions, type ValidateAutomationRequest, type ValidateAutomationResponse, ValidationErrorSeverity, type ValidationErrorSeverityWithLiterals, ValidationErrorType, type ValidationErrorTypeWithLiterals, ValidationResultStatus, type ValidationResultStatusWithLiterals, type ValidationSettings, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, bulkCountAutomationsWithDrafts, bulkDeleteAutomations, copyAutomation, createAutomation, createDraftAutomation, deleteAutomation, deleteDraftAutomation, generatePreinstalledAutomation, getAggregatedUsageInfo, getAutomation, getAutomationRevision, getOrCreateDraftAutomation, onAutomationCreated, onAutomationDeleted, onAutomationUpdated, publishDraftAutomation, queryAutomations, queryAutomationsWithDrafts, typedQueryAutomations, updateAutomation, updateDraftAutomation, validateAutomation, validateAutomationById };
+export { type AIMetadata, type Action, type ActionConfigurationError, ActionErrorType, type ActionErrorTypeWithLiterals, type ActionEvent, type ActionInfoOneOf, type ActionProviderQuotaInfo, type ActionQuotaInfo, type ActionSettings, type ActionUsageSummary, type ActionValidationError, type ActionValidationErrorErrorOneOf, type ActionValidationInfo, type AdditionalInfo, type AppDefinedAction, type ApplicationError, type ApplicationOrigin, type Asset, type AuditInfo, type AuditInfoIdOneOf, type AutoArchivePolicy, type Automation, type AutomationConfiguration, type AutomationConfigurationError, type AutomationCreatedEnvelope, type AutomationDeletedEnvelope, AutomationErrorType, type AutomationErrorTypeWithLiterals, type AutomationOriginInfoOneOf, type AutomationQuery, type AutomationQuerySpec, type AutomationSettings, type AutomationUpdatedEnvelope, type AutomationValidationError, type AutomationValidationErrorErrorOneOf, AutomationValidationErrorValidationErrorType, type AutomationValidationErrorValidationErrorTypeWithLiterals, type AutomationsQueryBuilder, type AutomationsQueryResult, type BaseEventMetadata, type BulkActionMetadata, type BulkCountAutomationsWithDraftsOptions, type BulkCountAutomationsWithDraftsRequest, type BulkCountAutomationsWithDraftsResponse, type BulkDeleteAutomationsRequest, type BulkDeleteAutomationsResponse, type BulkDeleteResult, type CTA, type CodeConditionAction, type CodeSnippet, type CommonQueryWithEntityContext, type ConditionAction, type ConditionExpressionGroup, type CopyAutomationOptions, type CopyAutomationRequest, type CopyAutomationResponse, type CreateAutomationRequest, type CreateAutomationResponse, type CreateDraftAutomationOptions, type CreateDraftAutomationRequest, type CreateDraftAutomationResponse, type CreatePreinstalledAutomationRequest, type CreatePreinstalledAutomationResponse, type CreatedByAppIdUsageSummary, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DelayAction, type DeleteAutomationRequest, type DeleteAutomationResponse, type DeleteContext, type DeleteDraftAutomationRequest, type DeleteDraftAutomationResponse, type DeletePreinstalledAutomationRequest, type DeletePreinstalledAutomationResponse, DeleteStatus, type DeleteStatusWithLiterals, type Dimensions, Domain, type DomainEvent, type DomainEventBodyOneOf, type DomainWithLiterals, type DraftInfo, type DraftPublished, type DraftsInfo, type Empty, type Enrichment, type Enrichments, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type Filter, type FilterValueSelection, type FilterableAppDefinedActions, type FutureDateActivationOffset, type GeneratePreinstalledAutomationOptions, type GeneratePreinstalledAutomationRequest, type GeneratePreinstalledAutomationResponse, type GetActionsQuotaInfoRequest, type GetActionsQuotaInfoResponse, type GetAggregatedUsageInfoOptions, type GetAggregatedUsageInfoRequest, type GetAggregatedUsageInfoResponse, type GetAutomationActionSchemaRequest, type GetAutomationActionSchemaResponse, type GetAutomationRequest, type GetAutomationResponse, type GetAutomationRevisionOptions, type GetAutomationRevisionRequest, type GetAutomationRevisionResponse, type GetOrCreateDraftAutomationRequest, type GetOrCreateDraftAutomationResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, Language, type LanguageWithLiterals, type MergeOverridePreinstalledWithRuntimeVersionRequest, type MergeOverridePreinstalledWithRuntimeVersionResponse, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type MigrateVeloActionAutomationsRequest, type MigrateVeloActionAutomationsResponse, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type Note, type Notes, type OdeditorAssigned, type OdeditorUnassigned, type Offset, Operator, type OperatorWithLiterals, Origin, type OriginAutomationInfo, type OriginWithLiterals, type OutputAction, type Path, type PicassoAssigned, type PicassoUnassigned, type Plan, type Position, type PreinstalledAutomationSpecInfo, type PreinstalledOrigin, type ProviderConfigurationError, type PublishDraftAutomationRequest, type PublishDraftAutomationResponse, type QueryAutomationsOptions, type QueryAutomationsRequest, type QueryAutomationsResponse, type QueryAutomationsWithDraftsOptions, type QueryAutomationsWithDraftsRequest, type QueryAutomationsWithDraftsResponse, type QueryDraftAutomationsRequest, type QueryDraftAutomationsResponse, type QueryPreinstalledAutomationsForAppRequest, type QueryPreinstalledAutomationsForAppResponse, type QueryPreinstalledAutomationsRequest, type QueryPreinstalledAutomationsResponse, type Quota, type QuotaInfo, type RateLimit, type RateLimitAction, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type ServiceProvisioned, type ServiceRemoved, type SetVariablesAction, Severity, type SeverityWithLiterals, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, type SplitAction, State, type StateWithLiterals, Status, type StatusWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, TimeUnit, type TimeUnitWithLiterals, type Trigger, type TriggerConfigurationError, TriggerErrorType, type TriggerErrorTypeWithLiterals, type TriggerSettings, type TriggerUsageSummary, type TriggerValidationError, type TriggerValidationErrorErrorOneOf, TriggerValidationErrorValidationErrorType, type TriggerValidationErrorValidationErrorTypeWithLiterals, Type, type TypeWithLiterals, type UpdateAutomation, type UpdateAutomationRequest, type UpdateAutomationResponse, type UpdateDraftAutomation, type UpdateDraftAutomationRequest, type UpdateDraftAutomationResponse, type UpdatePreinstalledAutomationRequest, type UpdatePreinstalledAutomationResponse, type UpgradeCTA, type ValidateAutomationByIdOptions, type ValidateAutomationByIdRequest, type ValidateAutomationByIdResponse, type ValidateAutomationOptions, type ValidateAutomationRequest, type ValidateAutomationResponse, ValidationErrorSeverity, type ValidationErrorSeverityWithLiterals, ValidationErrorType, type ValidationErrorTypeWithLiterals, ValidationResultStatus, type ValidationResultStatusWithLiterals, type ValidationSettings, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, bulkCountAutomationsWithDrafts, bulkDeleteAutomations, copyAutomation, createAutomation, createDraftAutomation, deleteAutomation, deleteDraftAutomation, generatePreinstalledAutomation, getAggregatedUsageInfo, getAutomation, getAutomationRevision, getOrCreateDraftAutomation, onAutomationCreated, onAutomationDeleted, onAutomationUpdated, publishDraftAutomation, queryAutomations, queryAutomationsWithDrafts, typedQueryAutomations, updateAutomation, updateDraftAutomation, validateAutomation, validateAutomationById };