@wix/auto_sdk_automations_automations-v-2 1.0.78 → 1.0.79

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1895,107 +1895,139 @@ interface PublishDraftAutomationResponse {
1895
1895
  interface ValidateAutomationRequest {
1896
1896
  /** Automation to validate. */
1897
1897
  automation: Automation;
1898
- /** Automation validation settings. */
1898
+ /**
1899
+ * Validation settings.
1900
+ *
1901
+ * When not specified, the method validates the full automation. This includes the trigger, actions, and provider validation logic.
1902
+ *
1903
+ * > **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).
1904
+ */
1899
1905
  validationSettings?: ValidationSettings;
1900
1906
  }
1901
1907
  interface ValidationSettings {
1902
1908
  /**
1903
- * IDs of actions to validate. Only actions whose IDs are specified are validated.
1909
+ * IDs of actions to validate.
1904
1910
  *
1905
- * When action IDs are specified, triggers are not validated. When empty, the full automation is validated, including triggers.
1911
+ * When specified, only these actions are validated.
1912
+ *
1913
+ * 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).
1906
1914
  * @maxSize 30
1907
1915
  * @format GUID
1908
1916
  */
1909
1917
  actionIds?: string[];
1910
1918
  /**
1911
- * Whether to skip provider validations.
1919
+ * 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.
1912
1920
  *
1913
1921
  * Default: `false`.
1914
1922
  */
1915
1923
  skipProviderValidations?: boolean;
1916
1924
  }
1917
1925
  interface ValidateAutomationResponse {
1918
- /** Automation validation status. */
1926
+ /** Validation status. */
1919
1927
  status?: ValidationResultStatusWithLiterals;
1920
1928
  /**
1921
- * Validation errors related to the automation's trigger configuration.
1929
+ * Errors found in the automation's [trigger](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/about-triggers).
1922
1930
  * @maxSize 100
1923
1931
  */
1924
1932
  triggerValidationErrors?: TriggerValidationError[];
1925
1933
  /**
1926
- * Validation errors related to the automation's actions configuration.
1934
+ * 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).
1927
1935
  * @maxSize 100
1928
1936
  */
1929
1937
  actionValidationErrors?: ActionValidationError[];
1930
1938
  }
1931
1939
  declare enum ValidationResultStatus {
1932
1940
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
1933
- /** Automation is valid - no validation errors found. */
1941
+ /**
1942
+ * Automation is valid. No errors found.
1943
+ *
1944
+ * You can save and run valid automations on user sites.
1945
+ */
1934
1946
  VALID = "VALID",
1935
- /** Automation is partially valid - validation errors with Warning severity were found - might affect automation execution */
1947
+ /**
1948
+ * Automation is valid but contains at least one error with a `WARNING` severity.
1949
+ *
1950
+ * Errors with a `WARNING` allow you to save and run the automation on user sites, but this can result in unexpected behavior.
1951
+ */
1936
1952
  VALID_WITH_WARNINGS = "VALID_WITH_WARNINGS",
1937
- /** Automation is not valid, validation errors with Critical severity were found - prevents proper automation/action execution and should be fixed. */
1953
+ /**
1954
+ * Automation is not valid. It contains at least one error with a `CRITICAL` severity.
1955
+ *
1956
+ * Errors with a `CRITICAL` severity do not allow you to save and run the automation on user sites.
1957
+ */
1938
1958
  INVALID = "INVALID"
1939
1959
  }
1940
1960
  /** @enumType */
1941
1961
  type ValidationResultStatusWithLiterals = ValidationResultStatus | 'UNKNOWN_STATUS' | 'VALID' | 'VALID_WITH_WARNINGS' | 'INVALID';
1942
1962
  interface TriggerValidationError extends TriggerValidationErrorErrorOneOf {
1943
- /** Automation's Trigger configuration error. */
1963
+ /** 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). */
1944
1964
  configurationError?: TriggerConfigurationError;
1945
- /** Trigger Provider configuration error. */
1965
+ /** 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. */
1946
1966
  providerConfigurationError?: ProviderConfigurationError;
1947
- /** Validation error type. */
1967
+ /** Error type. */
1948
1968
  errorType?: TriggerValidationErrorValidationErrorTypeWithLiterals;
1949
- /** Validation error severity */
1969
+ /** Error severity. */
1950
1970
  errorSeverity?: SeverityWithLiterals;
1951
1971
  }
1952
1972
  /** @oneof */
1953
1973
  interface TriggerValidationErrorErrorOneOf {
1954
- /** Automation's Trigger configuration error. */
1974
+ /** 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). */
1955
1975
  configurationError?: TriggerConfigurationError;
1956
- /** Trigger Provider configuration error. */
1976
+ /** 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. */
1957
1977
  providerConfigurationError?: ProviderConfigurationError;
1958
1978
  }
1959
1979
  declare enum TriggerValidationErrorValidationErrorType {
1960
1980
  UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
1961
- /** Automation's Trigger Configuration error. */
1981
+ /** 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). */
1962
1982
  CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
1963
- /** Trigger Provider related error. */
1983
+ /** 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. */
1964
1984
  PROVIDER_ERROR = "PROVIDER_ERROR"
1965
1985
  }
1966
1986
  /** @enumType */
1967
1987
  type TriggerValidationErrorValidationErrorTypeWithLiterals = TriggerValidationErrorValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
1968
1988
  interface TriggerConfigurationError {
1969
- /** Trigger error type. */
1989
+ /** Type of the trigger error. */
1970
1990
  errorType?: TriggerErrorTypeWithLiterals;
1971
1991
  }
1972
1992
  declare enum TriggerErrorType {
1973
1993
  UNKNOWN_TRIGGER_ERROR_TYPE = "UNKNOWN_TRIGGER_ERROR_TYPE",
1974
- /** Configured trigger was not found. */
1994
+ /** Trigger was not found. */
1975
1995
  NOT_FOUND = "NOT_FOUND",
1976
- /** App not installed. */
1996
+ /** Required app is not installed on the site. */
1977
1997
  APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
1978
- /** Invalid trigger key. */
1998
+ /** Trigger key is invalid. */
1979
1999
  INVALID_TRIGGER_KEY = "INVALID_TRIGGER_KEY",
1980
- /** Invalid filter field key. */
2000
+ /**
2001
+ * Filter field key is invalid.
2002
+ *
2003
+ * Learn more about [trigger filter](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#filters).
2004
+ */
1981
2005
  INVALID_FILTER_FIELD_KEY = "INVALID_FILTER_FIELD_KEY",
1982
- /** Invalid filter expression. */
2006
+ /**
2007
+ * Filter expression is invalid.
2008
+ *
2009
+ * Learn more about [trigger filter expressions](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#filters).
2010
+ */
1983
2011
  INVALID_FILTER_EXPRESSION = "INVALID_FILTER_EXPRESSION",
1984
- /** Missing configuration for a required trigger filter */
2012
+ /**
2013
+ * Required trigger filter was not found.
2014
+ *
2015
+ * Learn more about [required trigger filters](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#filters).
2016
+ */
1985
2017
  MISSING_REQUIRED_FILTER = "MISSING_REQUIRED_FILTER"
1986
2018
  }
1987
2019
  /** @enumType */
1988
2020
  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';
1989
2021
  interface ProviderConfigurationError {
1990
- /** Key corresponding to the field in the schema. */
2022
+ /** Scheme field key. */
1991
2023
  fieldKey?: string | null;
1992
2024
  /** Error message. */
1993
2025
  message?: string;
1994
- /** Label for a call-to-action button that's displayed with the error. Translated according to the SPI language context. */
2026
+ /** Label for the call-to-action button displayed with the error. */
1995
2027
  ctaLabel?: string | null;
1996
- /** URL to redirect to when the call-to-action button is clicked. */
2028
+ /** When the call-to-action button is clicked, the redirect URL. */
1997
2029
  ctaUrl?: string | null;
1998
- /** Title for the error. */
2030
+ /** Error title. */
1999
2031
  title?: string;
2000
2032
  }
2001
2033
  declare enum ValidationErrorSeverity {
@@ -2009,125 +2041,159 @@ declare enum ValidationErrorSeverity {
2009
2041
  type ValidationErrorSeverityWithLiterals = ValidationErrorSeverity | 'UNKNOWN_VALIDATION_ERROR_SEVERITY' | 'WARNING' | 'ERROR';
2010
2042
  declare enum Severity {
2011
2043
  UNKNOWN_SEVERITY = "UNKNOWN_SEVERITY",
2012
- /** Low severity error - may affect automation execution. */
2044
+ /**
2045
+ * Low-severity error.
2046
+ *
2047
+ * Errors with a `WARNING` severity allow you to save and run the automation, but the results might be unexpected.
2048
+ */
2013
2049
  WARNING = "WARNING",
2014
- /** Critical severity error - prevents proper automation execution and should be fixed. */
2050
+ /**
2051
+ * High-severity error.
2052
+ *
2053
+ * Errors with a `CRITICAL` severity do not allow you to save and run the automation.
2054
+ */
2015
2055
  CRITICAL = "CRITICAL"
2016
2056
  }
2017
2057
  /** @enumType */
2018
2058
  type SeverityWithLiterals = Severity | 'UNKNOWN_SEVERITY' | 'WARNING' | 'CRITICAL';
2019
2059
  interface ActionValidationInfo {
2020
2060
  /**
2021
- * Action ID.
2061
+ * 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).
2022
2062
  * @format GUID
2023
2063
  */
2024
2064
  actionId?: string | null;
2025
2065
  /**
2026
- * ID of the app that defined the action.
2066
+ * 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).
2027
2067
  * @format GUID
2028
2068
  */
2029
2069
  appId?: string;
2030
2070
  /**
2031
- * Human-readable action identifier.
2071
+ * Action key.
2072
+ *
2073
+ * 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.
2032
2074
  * @minLength 1
2033
2075
  * @maxLength 100
2034
2076
  */
2035
2077
  actionKey?: string;
2036
2078
  /**
2037
- * Action validation errors.
2079
+ * Errors found in the action's configuration.
2038
2080
  * @maxSize 100
2039
2081
  */
2040
2082
  validationErrors?: ActionValidationError[];
2041
2083
  }
2042
2084
  interface ActionValidationError extends ActionValidationErrorErrorOneOf {
2043
- /** Action configuration error. */
2085
+ /** 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). */
2044
2086
  configurationError?: ActionConfigurationError;
2045
- /** Provider configuration error. */
2087
+ /** 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). */
2046
2088
  providerConfigurationError?: ProviderConfigurationError;
2047
2089
  /**
2048
- * Action Identifier in the Automation.
2090
+ * 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).
2049
2091
  * @format GUID
2050
2092
  */
2051
2093
  actionId?: string;
2052
2094
  /**
2053
- * ID of the app that defined the action.
2095
+ * 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).
2054
2096
  * @format GUID
2055
2097
  */
2056
2098
  appId?: string;
2057
2099
  /**
2058
- * Human-readable action identifier.
2100
+ * Action key.
2101
+ *
2102
+ * This remains consistent across different automations.
2059
2103
  * @minLength 1
2060
2104
  * @maxLength 100
2061
2105
  */
2062
2106
  actionKey?: string;
2063
- /** Validation error type. */
2107
+ /** Error type. */
2064
2108
  errorType?: ValidationErrorTypeWithLiterals;
2065
- /** Validation error severity */
2109
+ /** Error severity. */
2066
2110
  errorSeverity?: SeverityWithLiterals;
2067
2111
  }
2068
2112
  /** @oneof */
2069
2113
  interface ActionValidationErrorErrorOneOf {
2070
- /** Action configuration error. */
2114
+ /** 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). */
2071
2115
  configurationError?: ActionConfigurationError;
2072
- /** Provider configuration error. */
2116
+ /** 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). */
2073
2117
  providerConfigurationError?: ProviderConfigurationError;
2074
2118
  }
2075
2119
  declare enum ValidationErrorType {
2076
2120
  UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
2077
- /** Configuration error. */
2121
+ /** Error in the [action configuration](https://dev.wix.com/docs/api-reference/business-management/automations/automations/automations-v2/configure-your-automation#configuring-actions). */
2078
2122
  CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
2079
- /** Provider error. */
2123
+ /** Error in the [action provider configuration](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/introduction). */
2080
2124
  PROVIDER_ERROR = "PROVIDER_ERROR"
2081
2125
  }
2082
2126
  /** @enumType */
2083
2127
  type ValidationErrorTypeWithLiterals = ValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
2084
2128
  interface ActionConfigurationError {
2085
- /** Action error type. */
2129
+ /** Error type. */
2086
2130
  errorType?: ActionErrorTypeWithLiterals;
2087
2131
  }
2088
2132
  declare enum ActionErrorType {
2089
2133
  UNKNOWN_ACTION_ERROR_TYPE = "UNKNOWN_ACTION_ERROR_TYPE",
2090
- /** Configured action was not found. */
2134
+ /** Action was not found. */
2091
2135
  NOT_FOUND = "NOT_FOUND",
2092
- /** App not installed. */
2136
+ /** Required app is not installed on the site. */
2093
2137
  APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
2094
2138
  /** Invalid action key. */
2095
2139
  INVALID_ACTION_KEY = "INVALID_ACTION_KEY",
2096
- /** Invalid mapping */
2140
+ /**
2141
+ * Invalid action mapping.
2142
+ *
2143
+ * 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.
2144
+ */
2097
2145
  INVALID_MAPPING = "INVALID_MAPPING",
2098
- /** Mapping type mismatch. */
2146
+ /**
2147
+ * Action mapping type mismatch.
2148
+ *
2149
+ * 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.
2150
+ */
2099
2151
  MAPPING_TYPE_MISMATCH = "MAPPING_TYPE_MISMATCH",
2100
- /** Mapping missing required field. */
2152
+ /**
2153
+ * Action mapping missing a required schema field.
2154
+ *
2155
+ * 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.
2156
+ */
2101
2157
  MAPPING_MISSING_REQUIRED_FIELD = "MAPPING_MISSING_REQUIRED_FIELD",
2102
- /** Mapping schema mismatch. */
2158
+ /**
2159
+ * Action schema mapping mismatch.
2160
+ *
2161
+ * 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.
2162
+ */
2103
2163
  MAPPING_SCHEMA_MISMATCH = "MAPPING_SCHEMA_MISMATCH",
2104
- /** Mapping variable missing from schema. */
2164
+ /** Action uses a variable not available to it in the current automation. */
2105
2165
  MAPPING_VARIABLE_MISSING_FROM_SCHEMA = "MAPPING_VARIABLE_MISSING_FROM_SCHEMA",
2106
- /** Configured post action not found. */
2166
+ /**
2167
+ * Configured post action not found.
2168
+ *
2169
+ * 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.
2170
+ */
2107
2171
  POST_ACTION_NOT_FOUND = "POST_ACTION_NOT_FOUND"
2108
2172
  }
2109
2173
  /** @enumType */
2110
2174
  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';
2111
2175
  interface AutomationValidationError extends AutomationValidationErrorErrorOneOf {
2112
- /** Automation configuration error. */
2176
+ /** 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). */
2113
2177
  configurationError?: AutomationConfigurationError;
2114
- /** Provider configuration error. */
2178
+ /** 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. */
2115
2179
  providerConfigurationError?: ProviderConfigurationError;
2116
- /** Validation error type. */
2180
+ /** Error type. */
2117
2181
  errorType?: AutomationValidationErrorValidationErrorTypeWithLiterals;
2118
- /** Validation error severity */
2182
+ /** Error severity. */
2119
2183
  errorSeverity?: SeverityWithLiterals;
2120
2184
  }
2121
2185
  /** @oneof */
2122
2186
  interface AutomationValidationErrorErrorOneOf {
2123
- /** Automation configuration error. */
2187
+ /** 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). */
2124
2188
  configurationError?: AutomationConfigurationError;
2125
- /** Provider configuration error. */
2189
+ /** 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. */
2126
2190
  providerConfigurationError?: ProviderConfigurationError;
2127
2191
  }
2128
2192
  declare enum AutomationValidationErrorValidationErrorType {
2129
2193
  UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
2194
+ /** Automation-level error caused by an error in the automation's configuration. */
2130
2195
  CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
2196
+ /** 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. */
2131
2197
  PROVIDER_ERROR = "PROVIDER_ERROR"
2132
2198
  }
2133
2199
  /** @enumType */
@@ -2154,12 +2220,12 @@ interface ValidateAutomationByIdResponse {
2154
2220
  /** Automation validation status. */
2155
2221
  status?: ValidationResultStatusWithLiterals;
2156
2222
  /**
2157
- * Validation errors related to the automation's trigger configuration.
2223
+ * Errors found in the trigger configuration.
2158
2224
  * @maxSize 100
2159
2225
  */
2160
2226
  triggerValidationErrors?: TriggerValidationError[];
2161
2227
  /**
2162
- * Validation errors related to the automation's actions configuration.
2228
+ * Errors found in the configuration of one or more of the automation's actions.
2163
2229
  * @maxSize 100
2164
2230
  */
2165
2231
  actionValidationErrors?: ActionValidationError[];
@@ -2940,7 +3006,15 @@ declare function deleteDraftAutomation(automationId: string): Promise<void>;
2940
3006
  */
2941
3007
  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>>;
2942
3008
  /**
2943
- * Validates the specified automation.
3009
+ * Validates an automation. A valid automation has no validation errors.
3010
+ *
3011
+ * This method:
3012
+ *
3013
+ * - 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).
3014
+ * - 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.
3015
+ * - 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).
3016
+ *
3017
+ * > **Note**: This method identifies configuration errors but doesn't fix them. It does not modify the automation.
2944
3018
  * @param automation - Automation to validate.
2945
3019
  * @public
2946
3020
  * @documentationMaturity preview
@@ -2951,7 +3025,13 @@ declare function publishDraftAutomation(automationId: string): Promise<NonNullab
2951
3025
  */
2952
3026
  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>>;
2953
3027
  interface ValidateAutomationOptions {
2954
- /** Automation validation settings. */
3028
+ /**
3029
+ * Validation settings.
3030
+ *
3031
+ * When not specified, the method validates the full automation. This includes the trigger, actions, and provider validation logic.
3032
+ *
3033
+ * > **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).
3034
+ */
2955
3035
  validationSettings?: ValidationSettings;
2956
3036
  }
2957
3037
  /**