@wix/auto_sdk_automations_automations-v-2 1.0.77 → 1.0.78

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