@wix/auto_sdk_automations_activations 1.0.134 → 1.0.136

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.
Files changed (45) hide show
  1. package/build/cjs/index.d.ts +55 -27
  2. package/build/cjs/index.js +8 -0
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +86 -58
  5. package/build/cjs/index.typings.js +8 -0
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +23 -23
  8. package/build/cjs/meta.js +8 -0
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/schemas.js +30 -20
  11. package/build/cjs/schemas.js.map +1 -1
  12. package/build/es/index.d.mts +55 -27
  13. package/build/es/index.mjs +8 -0
  14. package/build/es/index.mjs.map +1 -1
  15. package/build/es/index.typings.d.mts +86 -58
  16. package/build/es/index.typings.mjs +8 -0
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +23 -23
  19. package/build/es/meta.mjs +8 -0
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/es/schemas.mjs +30 -20
  22. package/build/es/schemas.mjs.map +1 -1
  23. package/build/internal/cjs/index.d.ts +55 -27
  24. package/build/internal/cjs/index.js +8 -0
  25. package/build/internal/cjs/index.js.map +1 -1
  26. package/build/internal/cjs/index.typings.d.ts +86 -58
  27. package/build/internal/cjs/index.typings.js +8 -0
  28. package/build/internal/cjs/index.typings.js.map +1 -1
  29. package/build/internal/cjs/meta.d.ts +23 -23
  30. package/build/internal/cjs/meta.js +8 -0
  31. package/build/internal/cjs/meta.js.map +1 -1
  32. package/build/internal/cjs/schemas.js +30 -20
  33. package/build/internal/cjs/schemas.js.map +1 -1
  34. package/build/internal/es/index.d.mts +55 -27
  35. package/build/internal/es/index.mjs +8 -0
  36. package/build/internal/es/index.mjs.map +1 -1
  37. package/build/internal/es/index.typings.d.mts +86 -58
  38. package/build/internal/es/index.typings.mjs +8 -0
  39. package/build/internal/es/index.typings.mjs.map +1 -1
  40. package/build/internal/es/meta.d.mts +23 -23
  41. package/build/internal/es/meta.mjs +8 -0
  42. package/build/internal/es/meta.mjs.map +1 -1
  43. package/build/internal/es/schemas.mjs +30 -20
  44. package/build/internal/es/schemas.mjs.map +1 -1
  45. package/package.json +2 -2
@@ -2056,12 +2056,12 @@ interface CancelEventRequest {
2056
2056
  interface CancelEventResponse {
2057
2057
  }
2058
2058
  interface V1RunAutomationRequest extends V1RunAutomationRequestIdentifierOneOf {
2059
- /** a preinstalled automation identifier */
2059
+ /** Identifies a preinstalled automation by its app ID and component ID. */
2060
2060
  preinstalledIdentifier?: PreinstalledIdentifier;
2061
- /** a automation of any type identifier that will be available in future */
2061
+ /** Identifies an automation by its ID. */
2062
2062
  automationIdentifier?: AutomationIdentifier;
2063
2063
  /**
2064
- * identifier MUST be either AUTOMATION or PREINSTALLED
2064
+ * How the automation to run is identified. Set to `AUTOMATION` to use `automationIdentifier`, or `PREINSTALLED` to use `preinstalledIdentifier`.
2065
2065
  * @immutable
2066
2066
  */
2067
2067
  identifierType: IdentifierTypeWithLiterals;
@@ -2088,54 +2088,54 @@ interface V1RunAutomationRequest extends V1RunAutomationRequestIdentifierOneOf {
2088
2088
  }
2089
2089
  /** @oneof */
2090
2090
  interface V1RunAutomationRequestIdentifierOneOf {
2091
- /** a preinstalled automation identifier */
2091
+ /** Identifies a preinstalled automation by its app ID and component ID. */
2092
2092
  preinstalledIdentifier?: PreinstalledIdentifier;
2093
- /** a automation of any type identifier that will be available in future */
2093
+ /** Identifies an automation by its ID. */
2094
2094
  automationIdentifier?: AutomationIdentifier;
2095
2095
  }
2096
- /** Specifies how an automation is identified when invoking RunAutomation or TestAutomation endpoints. */
2096
+ /** Specifies how an automation is identified when calling Run Automation or Test Automation. */
2097
2097
  declare enum IdentifierType {
2098
- /** Identifies a pre-installed automation by component ID and app ID. */
2098
+ /** Identifies a preinstalled automation by its app ID and component ID. */
2099
2099
  PREINSTALLED = "PREINSTALLED",
2100
- /** Identifies a specific automation by its unique automation ID. */
2100
+ /** Identifies an automation by its ID. */
2101
2101
  AUTOMATION = "AUTOMATION"
2102
2102
  }
2103
2103
  /** @enumType */
2104
2104
  type IdentifierTypeWithLiterals = IdentifierType | 'PREINSTALLED' | 'AUTOMATION';
2105
2105
  interface PreinstalledIdentifier {
2106
2106
  /**
2107
- * identifier for the application of the preinstalled
2107
+ * ID of the app that the preinstalled automation belongs to.
2108
2108
  * @format GUID
2109
2109
  */
2110
2110
  appId?: string;
2111
2111
  /**
2112
- * application component id
2112
+ * ID of the app component that defines the preinstalled automation.
2113
2113
  * @format GUID
2114
2114
  */
2115
2115
  componentId?: string;
2116
2116
  }
2117
2117
  interface AutomationIdentifier {
2118
2118
  /**
2119
- * automation id
2119
+ * ID of the automation to run.
2120
2120
  * @format GUID
2121
2121
  */
2122
2122
  automationId?: string;
2123
2123
  }
2124
2124
  interface V1RunAutomationResponse {
2125
2125
  /**
2126
- * Activation ID generated (for tracking)
2126
+ * ID of the activation created for this run.
2127
2127
  * @format GUID
2128
2128
  */
2129
2129
  activationId?: string | null;
2130
2130
  }
2131
2131
  /** Test mode variant of RunAutomationRequest. */
2132
2132
  interface TestAutomationRequest extends TestAutomationRequestIdentifierOneOf {
2133
- /** a preinstalled automation identifier */
2133
+ /** Identifies a preinstalled automation by its app ID and component ID. */
2134
2134
  preinstalledIdentifier?: PreinstalledIdentifier;
2135
- /** a automation of any type identifier that will be available in future */
2135
+ /** Identifies an automation by its ID. */
2136
2136
  automationIdentifier?: AutomationIdentifier;
2137
2137
  /**
2138
- * identifier MUST be either AUTOMATION or PREINSTALLED
2138
+ * How the automation to run is identified. Set to `AUTOMATION` to use `automationIdentifier`, or `PREINSTALLED` to use `preinstalledIdentifier`.
2139
2139
  * @immutable
2140
2140
  */
2141
2141
  identifierType: IdentifierTypeWithLiterals;
@@ -2157,14 +2157,14 @@ interface TestAutomationRequest extends TestAutomationRequestIdentifierOneOf {
2157
2157
  }
2158
2158
  /** @oneof */
2159
2159
  interface TestAutomationRequestIdentifierOneOf {
2160
- /** a preinstalled automation identifier */
2160
+ /** Identifies a preinstalled automation by its app ID and component ID. */
2161
2161
  preinstalledIdentifier?: PreinstalledIdentifier;
2162
- /** a automation of any type identifier that will be available in future */
2162
+ /** Identifies an automation by its ID. */
2163
2163
  automationIdentifier?: AutomationIdentifier;
2164
2164
  }
2165
2165
  interface TestAutomationResponse {
2166
2166
  /**
2167
- * Activation ID generated (for tracking)
2167
+ * ID of the activation created for this test run.
2168
2168
  * @format GUID
2169
2169
  */
2170
2170
  activationId?: string | null;
@@ -2172,21 +2172,21 @@ interface TestAutomationResponse {
2172
2172
  /** Request to rerun an automation using a previous activation's payload. */
2173
2173
  interface RerunActivationRequest {
2174
2174
  /**
2175
- * The activation ID whose payload will be used for the rerun.
2175
+ * ID of the activation to rerun. Its original payload and external entity ID are reused.
2176
2176
  * @format GUID
2177
2177
  */
2178
2178
  activationId: string;
2179
- /** Options controlling execution behavior. */
2179
+ /** Options that control how the activation is rerun. */
2180
2180
  options?: RunOptions;
2181
2181
  }
2182
- /** Options that control how an automation activation is executed. */
2182
+ /** Options that control how an activation is executed. */
2183
2183
  interface RunOptions {
2184
- /** When true, delay actions will be skipped (similar to test mode behavior). */
2184
+ /** Whether to skip the automation's delay actions so it runs immediately. */
2185
2185
  skipDelays?: boolean;
2186
2186
  }
2187
2187
  interface RerunActivationResponse {
2188
2188
  /**
2189
- * Activation ID generated (for tracking)
2189
+ * ID of the new activation created by the rerun.
2190
2190
  * @format GUID
2191
2191
  */
2192
2192
  activationId?: string | null;
package/build/cjs/meta.js CHANGED
@@ -170,6 +170,10 @@ function resolveWixAutomationsEsbResolverV1EsbConfigResolverUrl(opts) {
170
170
  {
171
171
  srcPath: "/automations/v1/events/test-automation",
172
172
  destPath: "/v1/events/test-automation"
173
+ },
174
+ {
175
+ srcPath: "/automations/esbConfigResolver/v1/events/run-automation",
176
+ destPath: "/v1/events/run-automation"
173
177
  }
174
178
  ],
175
179
  _: [
@@ -196,6 +200,10 @@ function resolveWixAutomationsEsbResolverV1EsbConfigResolverUrl(opts) {
196
200
  {
197
201
  srcPath: "/automations/v1/events/test-automation",
198
202
  destPath: "/v1/events/test-automation"
203
+ },
204
+ {
205
+ srcPath: "/automations/esbConfigResolver/v1/events/run-automation",
206
+ destPath: "/v1/events/run-automation"
199
207
  }
200
208
  ]
201
209
  };