@wix/auto_sdk_automations_activations 1.0.135 → 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.
@@ -223,32 +223,36 @@ var RunAutomationRequest = z.object({
223
223
  z.object({
224
224
  automationIdentifier: z.never().optional(),
225
225
  preinstalledIdentifier: z.object({
226
- appId: z.string().describe("identifier for the application of the preinstalled").regex(
226
+ appId: z.string().describe(
227
+ "ID of the app that the preinstalled automation belongs to."
228
+ ).regex(
227
229
  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
228
230
  "Must be a valid GUID"
229
231
  ).optional(),
230
- componentId: z.string().describe("application component id").regex(
232
+ componentId: z.string().describe(
233
+ "ID of the app component that defines the preinstalled automation."
234
+ ).regex(
231
235
  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
232
236
  "Must be a valid GUID"
233
237
  ).optional()
234
- }).describe("a preinstalled automation identifier")
238
+ }).describe(
239
+ "Identifies a preinstalled automation by its app ID and component ID."
240
+ )
235
241
  }),
236
242
  z.object({
237
243
  preinstalledIdentifier: z.never().optional(),
238
244
  automationIdentifier: z.object({
239
- automationId: z.string().describe("automation id").regex(
245
+ automationId: z.string().describe("ID of the automation to run.").regex(
240
246
  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
241
247
  "Must be a valid GUID"
242
248
  ).optional()
243
- }).describe(
244
- "a automation of any type identifier that will be available in future"
245
- )
249
+ }).describe("Identifies an automation by its ID.")
246
250
  })
247
251
  ])
248
252
  )
249
253
  });
250
254
  var RunAutomationResponse = z.object({
251
- activationId: z.string().describe("Activation ID generated (for tracking)").regex(
255
+ activationId: z.string().describe("ID of the activation created for this run.").regex(
252
256
  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
253
257
  "Must be a valid GUID"
254
258
  ).optional().nullable()
@@ -265,51 +269,57 @@ var TestAutomationRequest = z.object({
265
269
  z.object({
266
270
  automationIdentifier: z.never().optional(),
267
271
  preinstalledIdentifier: z.object({
268
- appId: z.string().describe("identifier for the application of the preinstalled").regex(
272
+ appId: z.string().describe(
273
+ "ID of the app that the preinstalled automation belongs to."
274
+ ).regex(
269
275
  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
270
276
  "Must be a valid GUID"
271
277
  ).optional(),
272
- componentId: z.string().describe("application component id").regex(
278
+ componentId: z.string().describe(
279
+ "ID of the app component that defines the preinstalled automation."
280
+ ).regex(
273
281
  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
274
282
  "Must be a valid GUID"
275
283
  ).optional()
276
- }).describe("a preinstalled automation identifier")
284
+ }).describe(
285
+ "Identifies a preinstalled automation by its app ID and component ID."
286
+ )
277
287
  }),
278
288
  z.object({
279
289
  preinstalledIdentifier: z.never().optional(),
280
290
  automationIdentifier: z.object({
281
- automationId: z.string().describe("automation id").regex(
291
+ automationId: z.string().describe("ID of the automation to run.").regex(
282
292
  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
283
293
  "Must be a valid GUID"
284
294
  ).optional()
285
- }).describe(
286
- "a automation of any type identifier that will be available in future"
287
- )
295
+ }).describe("Identifies an automation by its ID.")
288
296
  })
289
297
  ])
290
298
  )
291
299
  });
292
300
  var TestAutomationResponse = z.object({
293
- activationId: z.string().describe("Activation ID generated (for tracking)").regex(
301
+ activationId: z.string().describe("ID of the activation created for this test run.").regex(
294
302
  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
295
303
  "Must be a valid GUID"
296
304
  ).optional().nullable()
297
305
  });
298
306
  var RerunActivationRequest = z.object({
299
- activationId: z.string().describe("The activation ID whose payload will be used for the rerun.").regex(
307
+ activationId: z.string().describe(
308
+ "ID of the activation to rerun. Its original payload and external entity ID are reused."
309
+ ).regex(
300
310
  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
301
311
  "Must be a valid GUID"
302
312
  ),
303
313
  options: z.object({
304
314
  options: z.object({
305
315
  skipDelays: z.boolean().describe(
306
- "When true, delay actions will be skipped (similar to test mode behavior)."
316
+ "Whether to skip the automation's delay actions so it runs immediately."
307
317
  ).optional()
308
- }).describe("Options controlling execution behavior.").optional()
318
+ }).describe("Options that control how the activation is rerun.").optional()
309
319
  }).optional()
310
320
  });
311
321
  var RerunActivationResponse = z.object({
312
- activationId: z.string().describe("Activation ID generated (for tracking)").regex(
322
+ activationId: z.string().describe("ID of the new activation created by the rerun.").regex(
313
323
  /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
314
324
  "Must be a valid GUID"
315
325
  ).optional().nullable()
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../schemas.ts","../../../src/automations-v2-activation-activations.schemas.ts"],"sourcesContent":["export * from './src/automations-v2-activation-activations.schemas.js';\n","import * as z from 'zod';\n\nexport const ReportEventRequest = z.object({\n triggerKey: z\n .string()\n .describe(\n \"Trigger key as defined in your app's trigger configuration\\nin the app dashboard.\\nFor example, `form_submitted` or `invoice_due`.\"\n )\n .min(1)\n .max(100),\n options: z\n .object({\n payload: z\n .record(z.string(), z.any())\n .describe(\n 'Event payload, formatted as key:value pairs.\\nMust comply with the payload schema\\nif you provided one when configuring your trigger.\\n\\nKey names can include only alphanumeric characters or underscores\\n(`A-Z`, `a-z`, `0-9`, `_`).\\nThey cannot start with an underscore.\\n\\nValues can be strings, numbers, integers, booleans, or arrays.\\nIf a value is an array, the array items must be objects,\\nand nested object properties must be\\nstrings, numbers, integers, or booleans only.'\n )\n .optional()\n .nullable(),\n externalEntityId: z\n .string()\n .describe(\n 'ID of the related resource in GUID format.\\nFor example, `fc81a355-3429-50fc-a4c7-def486e828f3`.\\n\\nRequired if your app needs to\\n[cancel the event](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/cancel-event)\\nif the automation becomes no longer relevant.\\n\\nTypically, this ID is defined in your system,\\nbut you can also use any Wix resource GUID,\\nsuch as contact ID, member ID, or invoice ID.\\nSee\\n[Choose the right `externalEntityId`](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/reporting-and-canceling-events#about-canceling-events)\\nfor more information.'\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n idempotency: z\n .object({\n key: z\n .string()\n .describe(\n 'A unique identifier for the event.\\nIf you send the same idempotency key in multiple report event requests, for the same trigger key and app id,\\nconsecutive requests will be ignored after the first one. Note that the idempotency key is kept for a week before it expires.'\n )\n .min(1)\n .max(80)\n .optional(),\n ttlInMilliseconds: z\n .string()\n .regex(/^-?\\d+$/, 'Must be a valid Int64 string')\n .describe(\n 'Optional. The time to live (TTL) in milliseconds before the key will expire. Default is a week.'\n )\n .optional()\n .nullable(),\n })\n .describe('Idempotency information for the event.')\n .optional(),\n })\n .optional(),\n});\nexport const ReportEventResponse = z.object({\n activationIds: z.array(z.string()).max(100).optional(),\n});\nexport const BulkReportEventRequest = z.object({\n triggerKey: z\n .string()\n .describe(\n \"Trigger key as defined in your app's trigger configuration\\nin the app dashboard.\\nFor example, `form_submitted` or `invoice_due`.\"\n )\n .min(1)\n .max(100),\n eventsInfo: z\n .array(\n z.object({\n payload: z\n .record(z.string(), z.any())\n .describe(\n 'Event payload, formatted as key:value pairs.\\nMust comply with the payload schema\\nif you provided one when configuring your trigger.'\n )\n .optional()\n .nullable(),\n externalEntityId: z\n .string()\n .describe('ID of the related resource in GUID format.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n idempotency: z\n .object({\n key: z\n .string()\n .describe(\n 'A unique identifier for the event.\\nIf you send the same idempotency key in multiple report event requests, for the same trigger key and app id,\\nconsecutive requests will be ignored after the first one. Note that the idempotency key is kept for a week before it expires.'\n )\n .min(1)\n .max(80)\n .optional(),\n ttlInMilliseconds: z\n .string()\n .regex(/^-?\\d+$/, 'Must be a valid Int64 string')\n .describe(\n 'Optional. The time to live (TTL) in milliseconds before the key will expire. Default is a week.'\n )\n .optional()\n .nullable(),\n })\n .describe('Idempotency information for the event.')\n .optional(),\n })\n )\n .min(1)\n .max(100),\n});\nexport const BulkReportEventResponse = z.object({\n triggerKey: z\n .string()\n .describe('Trigger key associated with the event.')\n .min(1)\n .max(100)\n .optional(),\n results: z\n .array(\n z.object({\n itemMetadata: z\n .object({\n _id: z\n .string()\n .describe(\n \"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).\"\n )\n .optional()\n .nullable(),\n originalIndex: z\n .number()\n .int()\n .describe(\n 'Index of the item within the request array. Allows for correlation between request and response items.'\n )\n .optional(),\n success: z\n .boolean()\n .describe(\n 'Whether the requested action was successful for this item. When `false`, the `error` field is populated.'\n )\n .optional(),\n error: z\n .object({\n code: z.string().describe('Error code.').optional(),\n description: z\n .string()\n .describe('Description of the error.')\n .optional(),\n data: z\n .record(z.string(), z.any())\n .describe('Data related to the error.')\n .optional()\n .nullable(),\n })\n .describe('Details about the error in case of failure.')\n .optional(),\n })\n .describe('Metadata for the individual item in the request.')\n .optional(),\n eventInfo: z\n .object({\n payload: z\n .record(z.string(), z.any())\n .describe(\n 'Event payload, formatted as key:value pairs.\\nMust comply with the payload schema\\nif you provided one when configuring your trigger.'\n )\n .optional()\n .nullable(),\n externalEntityId: z\n .string()\n .describe('ID of the related resource in GUID format.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n idempotency: z\n .object({\n key: z\n .string()\n .describe(\n 'A unique identifier for the event.\\nIf you send the same idempotency key in multiple report event requests, for the same trigger key and app id,\\nconsecutive requests will be ignored after the first one. Note that the idempotency key is kept for a week before it expires.'\n )\n .min(1)\n .max(80)\n .optional(),\n ttlInMilliseconds: z\n .string()\n .regex(/^-?\\d+$/, 'Must be a valid Int64 string')\n .describe(\n 'Optional. The time to live (TTL) in milliseconds before the key will expire. Default is a week.'\n )\n .optional()\n .nullable(),\n })\n .describe('Idempotency information for the event.')\n .optional(),\n })\n .describe('Event details for the item in the request.')\n .optional(),\n activationIds: z.array(z.string()).max(100).optional(),\n })\n )\n .optional(),\n bulkActionMetadata: z\n .object({\n totalSuccesses: z\n .number()\n .int()\n .describe('Number of items that were successfully processed.')\n .optional(),\n totalFailures: z\n .number()\n .int()\n .describe(\"Number of items that couldn't be processed.\")\n .optional(),\n undetailedFailures: z\n .number()\n .int()\n .describe(\n 'Number of failures without details because detailed failure threshold was exceeded.'\n )\n .optional(),\n })\n .describe(\n 'Metadata for the overall bulk action, including success and failure counts.'\n )\n .optional(),\n});\nexport const BulkCancelEventRequest = z.object({\n triggerKey: z\n .string()\n .describe(\n 'Trigger key whose events you want to cancel.\\nFor example, `form_submitted` or `invoice_due`.'\n )\n .min(1)\n .max(100),\n externalEntityIds: z.array(z.string()).min(1).max(100),\n});\nexport const BulkCancelEventResponse = z.object({\n triggerKey: z\n .string()\n .describe('Trigger key related to the canceled event.')\n .min(1)\n .max(100)\n .optional(),\n results: z\n .array(\n z.object({\n itemMetadata: z\n .object({\n _id: z\n .string()\n .describe(\n \"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).\"\n )\n .optional()\n .nullable(),\n originalIndex: z\n .number()\n .int()\n .describe(\n 'Index of the item within the request array. Allows for correlation between request and response items.'\n )\n .optional(),\n success: z\n .boolean()\n .describe(\n 'Whether the requested action was successful for this item. When `false`, the `error` field is populated.'\n )\n .optional(),\n error: z\n .object({\n code: z.string().describe('Error code.').optional(),\n description: z\n .string()\n .describe('Description of the error.')\n .optional(),\n data: z\n .record(z.string(), z.any())\n .describe('Data related to the error.')\n .optional()\n .nullable(),\n })\n .describe('Details about the error in case of failure.')\n .optional(),\n })\n .describe(\n 'Metadata of the item, including its ID and success or failure status.'\n )\n .optional(),\n externalEntityId: z\n .string()\n .describe('ID of the related resource in GUID format.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n })\n )\n .optional(),\n bulkActionMetadata: z\n .object({\n totalSuccesses: z\n .number()\n .int()\n .describe('Number of items that were successfully processed.')\n .optional(),\n totalFailures: z\n .number()\n .int()\n .describe(\"Number of items that couldn't be processed.\")\n .optional(),\n undetailedFailures: z\n .number()\n .int()\n .describe(\n 'Number of failures without details because detailed failure threshold was exceeded.'\n )\n .optional(),\n })\n .describe(\n 'Metadata for the overall bulk action, including success and failure counts.'\n )\n .optional(),\n});\nexport const CancelEventRequest = z.object({\n triggerKey: z\n .string()\n .describe(\n 'Trigger key whose event you want to cancel.\\nFor example, `form_submitted` or `invoice_due`.'\n )\n .min(1)\n .max(100),\n externalEntityId: z\n .string()\n .describe(\n 'ID of the related resource in GUID format.\\nFor example, `fc81a355-3429-50fc-a4c7-def486e828f3`.\\n\\nTypically, this ID is defined in your system,\\nbut you can also use any Wix resource GUID,\\nsuch as contact ID, member ID, or invoice ID.\\nSee\\n[Choose the right `externalEntityId`](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/reporting-and-canceling-events#choose-the-right-externalentityid)\\nfor more information.'\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n ),\n});\nexport const CancelEventResponse = z.object({});\nexport const RunAutomationRequest = z.object({\n identifierType: z.enum(['PREINSTALLED', 'AUTOMATION']),\n options: z.intersection(\n z.object({\n payload: z\n .record(z.string(), z.any())\n .describe(\n 'Event payload, formatted as key:value pairs.\\nMust comply with the payload schema\\nif you provided one when configuring your trigger.\\n\\nKey names can include only alphanumeric characters or underscores\\n(`A-Z`, `a-z`, `0-9`, `_`).\\nThey cannot start with an underscore.\\n\\nValues can be strings, numbers, integers, booleans, or arrays.\\nIf a value is an array, the array items must be objects,\\nand nested object properties must be\\nstrings, numbers, integers, or booleans only.'\n ),\n migrationFlow: z\n .boolean()\n .describe(\n 'When true, indicates this is a migration flow and should bypass\\nthe check for future dates that have already passed.'\n )\n .optional(),\n }),\n z.xor([\n z.object({\n automationIdentifier: z.never().optional(),\n preinstalledIdentifier: z\n .object({\n appId: z\n .string()\n .describe('identifier for the application of the preinstalled')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n componentId: z\n .string()\n .describe('application component id')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n })\n .describe('a preinstalled automation identifier'),\n }),\n z.object({\n preinstalledIdentifier: z.never().optional(),\n automationIdentifier: z\n .object({\n automationId: z\n .string()\n .describe('automation id')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n })\n .describe(\n 'a automation of any type identifier that will be available in future'\n ),\n }),\n ])\n ),\n});\nexport const RunAutomationResponse = z.object({\n activationId: z\n .string()\n .describe('Activation ID generated (for tracking)')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n});\nexport const TestAutomationRequest = z.object({\n identifierType: z.enum(['PREINSTALLED', 'AUTOMATION']),\n options: z.intersection(\n z.object({\n payload: z\n .record(z.string(), z.any())\n .describe(\n 'Event payload, formatted as key:value pairs.\\nMust comply with the payload schema\\nif you provided one when configuring your trigger.\\n\\nKey names can include only alphanumeric characters or underscores\\n(`A-Z`, `a-z`, `0-9`, `_`).\\nThey cannot start with an underscore.\\n\\nValues can be strings, numbers, integers, booleans, or arrays.\\nIf a value is an array, the array items must be objects,\\nand nested object properties must be\\nstrings, numbers, integers, or booleans only.'\n ),\n }),\n z.xor([\n z.object({\n automationIdentifier: z.never().optional(),\n preinstalledIdentifier: z\n .object({\n appId: z\n .string()\n .describe('identifier for the application of the preinstalled')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n componentId: z\n .string()\n .describe('application component id')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n })\n .describe('a preinstalled automation identifier'),\n }),\n z.object({\n preinstalledIdentifier: z.never().optional(),\n automationIdentifier: z\n .object({\n automationId: z\n .string()\n .describe('automation id')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n })\n .describe(\n 'a automation of any type identifier that will be available in future'\n ),\n }),\n ])\n ),\n});\nexport const TestAutomationResponse = z.object({\n activationId: z\n .string()\n .describe('Activation ID generated (for tracking)')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n});\nexport const RerunActivationRequest = z.object({\n activationId: z\n .string()\n .describe('The activation ID whose payload will be used for the rerun.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n ),\n options: z\n .object({\n options: z\n .object({\n skipDelays: z\n .boolean()\n .describe(\n 'When true, delay actions will be skipped (similar to test mode behavior).'\n )\n .optional(),\n })\n .describe('Options controlling execution behavior.')\n .optional(),\n })\n .optional(),\n});\nexport const RerunActivationResponse = z.object({\n activationId: z\n .string()\n .describe('Activation ID generated (for tracking)')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n});\nexport const ReportActionInvocationCompletedRequest = z.object({\n status: z.enum(['UNKNOWN_STATUS', 'SUCCESS', 'FAILURE']),\n invocationToken: z\n .string()\n .describe(\n \"Invocation token from Wix's original call to [Invoke](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/invoke). Wix uses this token to match your results with the correct automation run.\\n\\nLearn more about [running an invoked action with a timeout](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/sample-flow#run-an-invoked-action-with-a-timeout).\"\n )\n .max(2048),\n options: z\n .intersection(\n z.object({}),\n z.xor([\n z.object({\n successInfo: z.never().optional(),\n failureInfo: z.never().optional(),\n }),\n z.object({\n failureInfo: z.never().optional(),\n successInfo: z\n .object({\n result: z\n .record(z.string(), z.any())\n .describe(\n \"Your action's results as specified in its [output schema](https://dev.wix.com/docs/api-reference/business-management/automations/actions/about-actions#the-output-schema).\"\n )\n .optional()\n .nullable(),\n })\n .describe(\"When the `status` is `SUCCESS`, your action's results.\"),\n }),\n z.object({\n successInfo: z.never().optional(),\n failureInfo: z\n .object({\n errorDescription: z\n .string()\n .describe('Why the action failed.')\n .max(1000)\n .optional(),\n })\n .describe('When the `status` is `FAILURE`, why the action failed.'),\n }),\n ])\n )\n .optional(),\n});\nexport const ReportActionInvocationCompletedResponse = z.object({});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,QAAmB;AAEZ,IAAM,qBAAuB,SAAO;AAAA,EACzC,YACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,IAAI,CAAC,EACL,IAAI,GAAG;AAAA,EACV,SACG,SAAO;AAAA,IACN,SACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B;AAAA,MACC;AAAA,IACF,EACC,SAAS,EACT,SAAS;AAAA,IACZ,kBACG,SAAO,EACP;AAAA,MACC;AAAA,IACF,EACC;AAAA,MACC;AAAA,MACA;AAAA,IACF,EACC,SAAS,EACT,SAAS;AAAA,IACZ,aACG,SAAO;AAAA,MACN,KACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,CAAC,EACL,IAAI,EAAE,EACN,SAAS;AAAA,MACZ,mBACG,SAAO,EACP,MAAM,WAAW,8BAA8B,EAC/C;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,IACd,CAAC,EACA,SAAS,wCAAwC,EACjD,SAAS;AAAA,EACd,CAAC,EACA,SAAS;AACd,CAAC;AACM,IAAM,sBAAwB,SAAO;AAAA,EAC1C,eAAiB,QAAQ,SAAO,CAAC,EAAE,IAAI,GAAG,EAAE,SAAS;AACvD,CAAC;AACM,IAAM,yBAA2B,SAAO;AAAA,EAC7C,YACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,IAAI,CAAC,EACL,IAAI,GAAG;AAAA,EACV,YACG;AAAA,IACG,SAAO;AAAA,MACP,SACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,kBACG,SAAO,EACP,SAAS,4CAA4C,EACrD;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,aACG,SAAO;AAAA,QACN,KACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC,IAAI,CAAC,EACL,IAAI,EAAE,EACN,SAAS;AAAA,QACZ,mBACG,SAAO,EACP,MAAM,WAAW,8BAA8B,EAC/C;AAAA,UACC;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,MACd,CAAC,EACA,SAAS,wCAAwC,EACjD,SAAS;AAAA,IACd,CAAC;AAAA,EACH,EACC,IAAI,CAAC,EACL,IAAI,GAAG;AACZ,CAAC;AACM,IAAM,0BAA4B,SAAO;AAAA,EAC9C,YACG,SAAO,EACP,SAAS,wCAAwC,EACjD,IAAI,CAAC,EACL,IAAI,GAAG,EACP,SAAS;AAAA,EACZ,SACG;AAAA,IACG,SAAO;AAAA,MACP,cACG,SAAO;AAAA,QACN,KACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,QACZ,eACG,SAAO,EACP,IAAI,EACJ;AAAA,UACC;AAAA,QACF,EACC,SAAS;AAAA,QACZ,SACG,UAAQ,EACR;AAAA,UACC;AAAA,QACF,EACC,SAAS;AAAA,QACZ,OACG,SAAO;AAAA,UACN,MAAQ,SAAO,EAAE,SAAS,aAAa,EAAE,SAAS;AAAA,UAClD,aACG,SAAO,EACP,SAAS,2BAA2B,EACpC,SAAS;AAAA,UACZ,MACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B,SAAS,4BAA4B,EACrC,SAAS,EACT,SAAS;AAAA,QACd,CAAC,EACA,SAAS,6CAA6C,EACtD,SAAS;AAAA,MACd,CAAC,EACA,SAAS,kDAAkD,EAC3D,SAAS;AAAA,MACZ,WACG,SAAO;AAAA,QACN,SACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B;AAAA,UACC;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,QACZ,kBACG,SAAO,EACP,SAAS,4CAA4C,EACrD;AAAA,UACC;AAAA,UACA;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,QACZ,aACG,SAAO;AAAA,UACN,KACG,SAAO,EACP;AAAA,YACC;AAAA,UACF,EACC,IAAI,CAAC,EACL,IAAI,EAAE,EACN,SAAS;AAAA,UACZ,mBACG,SAAO,EACP,MAAM,WAAW,8BAA8B,EAC/C;AAAA,YACC;AAAA,UACF,EACC,SAAS,EACT,SAAS;AAAA,QACd,CAAC,EACA,SAAS,wCAAwC,EACjD,SAAS;AAAA,MACd,CAAC,EACA,SAAS,4CAA4C,EACrD,SAAS;AAAA,MACZ,eAAiB,QAAQ,SAAO,CAAC,EAAE,IAAI,GAAG,EAAE,SAAS;AAAA,IACvD,CAAC;AAAA,EACH,EACC,SAAS;AAAA,EACZ,oBACG,SAAO;AAAA,IACN,gBACG,SAAO,EACP,IAAI,EACJ,SAAS,mDAAmD,EAC5D,SAAS;AAAA,IACZ,eACG,SAAO,EACP,IAAI,EACJ,SAAS,6CAA6C,EACtD,SAAS;AAAA,IACZ,oBACG,SAAO,EACP,IAAI,EACJ;AAAA,MACC;AAAA,IACF,EACC,SAAS;AAAA,EACd,CAAC,EACA;AAAA,IACC;AAAA,EACF,EACC,SAAS;AACd,CAAC;AACM,IAAM,yBAA2B,SAAO;AAAA,EAC7C,YACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,IAAI,CAAC,EACL,IAAI,GAAG;AAAA,EACV,mBAAqB,QAAQ,SAAO,CAAC,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG;AACvD,CAAC;AACM,IAAM,0BAA4B,SAAO;AAAA,EAC9C,YACG,SAAO,EACP,SAAS,4CAA4C,EACrD,IAAI,CAAC,EACL,IAAI,GAAG,EACP,SAAS;AAAA,EACZ,SACG;AAAA,IACG,SAAO;AAAA,MACP,cACG,SAAO;AAAA,QACN,KACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,QACZ,eACG,SAAO,EACP,IAAI,EACJ;AAAA,UACC;AAAA,QACF,EACC,SAAS;AAAA,QACZ,SACG,UAAQ,EACR;AAAA,UACC;AAAA,QACF,EACC,SAAS;AAAA,QACZ,OACG,SAAO;AAAA,UACN,MAAQ,SAAO,EAAE,SAAS,aAAa,EAAE,SAAS;AAAA,UAClD,aACG,SAAO,EACP,SAAS,2BAA2B,EACpC,SAAS;AAAA,UACZ,MACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B,SAAS,4BAA4B,EACrC,SAAS,EACT,SAAS;AAAA,QACd,CAAC,EACA,SAAS,6CAA6C,EACtD,SAAS;AAAA,MACd,CAAC,EACA;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,kBACG,SAAO,EACP,SAAS,4CAA4C,EACrD;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,IACd,CAAC;AAAA,EACH,EACC,SAAS;AAAA,EACZ,oBACG,SAAO;AAAA,IACN,gBACG,SAAO,EACP,IAAI,EACJ,SAAS,mDAAmD,EAC5D,SAAS;AAAA,IACZ,eACG,SAAO,EACP,IAAI,EACJ,SAAS,6CAA6C,EACtD,SAAS;AAAA,IACZ,oBACG,SAAO,EACP,IAAI,EACJ;AAAA,MACC;AAAA,IACF,EACC,SAAS;AAAA,EACd,CAAC,EACA;AAAA,IACC;AAAA,EACF,EACC,SAAS;AACd,CAAC;AACM,IAAM,qBAAuB,SAAO;AAAA,EACzC,YACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,IAAI,CAAC,EACL,IAAI,GAAG;AAAA,EACV,kBACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC;AAAA,IACC;AAAA,IACA;AAAA,EACF;AACJ,CAAC;AACM,IAAM,sBAAwB,SAAO,CAAC,CAAC;AACvC,IAAM,uBAAyB,SAAO;AAAA,EAC3C,gBAAkB,OAAK,CAAC,gBAAgB,YAAY,CAAC;AAAA,EACrD,SAAW;AAAA,IACP,SAAO;AAAA,MACP,SACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B;AAAA,QACC;AAAA,MACF;AAAA,MACF,eACG,UAAQ,EACR;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,IACd,CAAC;AAAA,IACC,MAAI;AAAA,MACF,SAAO;AAAA,QACP,sBAAwB,QAAM,EAAE,SAAS;AAAA,QACzC,wBACG,SAAO;AAAA,UACN,OACG,SAAO,EACP,SAAS,oDAAoD,EAC7D;AAAA,YACC;AAAA,YACA;AAAA,UACF,EACC,SAAS;AAAA,UACZ,aACG,SAAO,EACP,SAAS,0BAA0B,EACnC;AAAA,YACC;AAAA,YACA;AAAA,UACF,EACC,SAAS;AAAA,QACd,CAAC,EACA,SAAS,sCAAsC;AAAA,MACpD,CAAC;AAAA,MACC,SAAO;AAAA,QACP,wBAA0B,QAAM,EAAE,SAAS;AAAA,QAC3C,sBACG,SAAO;AAAA,UACN,cACG,SAAO,EACP,SAAS,eAAe,EACxB;AAAA,YACC;AAAA,YACA;AAAA,UACF,EACC,SAAS;AAAA,QACd,CAAC,EACA;AAAA,UACC;AAAA,QACF;AAAA,MACJ,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACF,CAAC;AACM,IAAM,wBAA0B,SAAO;AAAA,EAC5C,cACG,SAAO,EACP,SAAS,wCAAwC,EACjD;AAAA,IACC;AAAA,IACA;AAAA,EACF,EACC,SAAS,EACT,SAAS;AACd,CAAC;AACM,IAAM,wBAA0B,SAAO;AAAA,EAC5C,gBAAkB,OAAK,CAAC,gBAAgB,YAAY,CAAC;AAAA,EACrD,SAAW;AAAA,IACP,SAAO;AAAA,MACP,SACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B;AAAA,QACC;AAAA,MACF;AAAA,IACJ,CAAC;AAAA,IACC,MAAI;AAAA,MACF,SAAO;AAAA,QACP,sBAAwB,QAAM,EAAE,SAAS;AAAA,QACzC,wBACG,SAAO;AAAA,UACN,OACG,SAAO,EACP,SAAS,oDAAoD,EAC7D;AAAA,YACC;AAAA,YACA;AAAA,UACF,EACC,SAAS;AAAA,UACZ,aACG,SAAO,EACP,SAAS,0BAA0B,EACnC;AAAA,YACC;AAAA,YACA;AAAA,UACF,EACC,SAAS;AAAA,QACd,CAAC,EACA,SAAS,sCAAsC;AAAA,MACpD,CAAC;AAAA,MACC,SAAO;AAAA,QACP,wBAA0B,QAAM,EAAE,SAAS;AAAA,QAC3C,sBACG,SAAO;AAAA,UACN,cACG,SAAO,EACP,SAAS,eAAe,EACxB;AAAA,YACC;AAAA,YACA;AAAA,UACF,EACC,SAAS;AAAA,QACd,CAAC,EACA;AAAA,UACC;AAAA,QACF;AAAA,MACJ,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACF,CAAC;AACM,IAAM,yBAA2B,SAAO;AAAA,EAC7C,cACG,SAAO,EACP,SAAS,wCAAwC,EACjD;AAAA,IACC;AAAA,IACA;AAAA,EACF,EACC,SAAS,EACT,SAAS;AACd,CAAC;AACM,IAAM,yBAA2B,SAAO;AAAA,EAC7C,cACG,SAAO,EACP,SAAS,6DAA6D,EACtE;AAAA,IACC;AAAA,IACA;AAAA,EACF;AAAA,EACF,SACG,SAAO;AAAA,IACN,SACG,SAAO;AAAA,MACN,YACG,UAAQ,EACR;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,IACd,CAAC,EACA,SAAS,yCAAyC,EAClD,SAAS;AAAA,EACd,CAAC,EACA,SAAS;AACd,CAAC;AACM,IAAM,0BAA4B,SAAO;AAAA,EAC9C,cACG,SAAO,EACP,SAAS,wCAAwC,EACjD;AAAA,IACC;AAAA,IACA;AAAA,EACF,EACC,SAAS,EACT,SAAS;AACd,CAAC;AACM,IAAM,yCAA2C,SAAO;AAAA,EAC7D,QAAU,OAAK,CAAC,kBAAkB,WAAW,SAAS,CAAC;AAAA,EACvD,iBACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,IAAI,IAAI;AAAA,EACX,SACG;AAAA,IACG,SAAO,CAAC,CAAC;AAAA,IACT,MAAI;AAAA,MACF,SAAO;AAAA,QACP,aAAe,QAAM,EAAE,SAAS;AAAA,QAChC,aAAe,QAAM,EAAE,SAAS;AAAA,MAClC,CAAC;AAAA,MACC,SAAO;AAAA,QACP,aAAe,QAAM,EAAE,SAAS;AAAA,QAChC,aACG,SAAO;AAAA,UACN,QACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B;AAAA,YACC;AAAA,UACF,EACC,SAAS,EACT,SAAS;AAAA,QACd,CAAC,EACA,SAAS,wDAAwD;AAAA,MACtE,CAAC;AAAA,MACC,SAAO;AAAA,QACP,aAAe,QAAM,EAAE,SAAS;AAAA,QAChC,aACG,SAAO;AAAA,UACN,kBACG,SAAO,EACP,SAAS,wBAAwB,EACjC,IAAI,GAAI,EACR,SAAS;AAAA,QACd,CAAC,EACA,SAAS,wDAAwD;AAAA,MACtE,CAAC;AAAA,IACH,CAAC;AAAA,EACH,EACC,SAAS;AACd,CAAC;AACM,IAAM,0CAA4C,SAAO,CAAC,CAAC;","names":[]}
1
+ {"version":3,"sources":["../../../schemas.ts","../../../src/automations-v2-activation-activations.schemas.ts"],"sourcesContent":["export * from './src/automations-v2-activation-activations.schemas.js';\n","import * as z from 'zod';\n\nexport const ReportEventRequest = z.object({\n triggerKey: z\n .string()\n .describe(\n \"Trigger key as defined in your app's trigger configuration\\nin the app dashboard.\\nFor example, `form_submitted` or `invoice_due`.\"\n )\n .min(1)\n .max(100),\n options: z\n .object({\n payload: z\n .record(z.string(), z.any())\n .describe(\n 'Event payload, formatted as key:value pairs.\\nMust comply with the payload schema\\nif you provided one when configuring your trigger.\\n\\nKey names can include only alphanumeric characters or underscores\\n(`A-Z`, `a-z`, `0-9`, `_`).\\nThey cannot start with an underscore.\\n\\nValues can be strings, numbers, integers, booleans, or arrays.\\nIf a value is an array, the array items must be objects,\\nand nested object properties must be\\nstrings, numbers, integers, or booleans only.'\n )\n .optional()\n .nullable(),\n externalEntityId: z\n .string()\n .describe(\n 'ID of the related resource in GUID format.\\nFor example, `fc81a355-3429-50fc-a4c7-def486e828f3`.\\n\\nRequired if your app needs to\\n[cancel the event](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/cancel-event)\\nif the automation becomes no longer relevant.\\n\\nTypically, this ID is defined in your system,\\nbut you can also use any Wix resource GUID,\\nsuch as contact ID, member ID, or invoice ID.\\nSee\\n[Choose the right `externalEntityId`](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/reporting-and-canceling-events#about-canceling-events)\\nfor more information.'\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n idempotency: z\n .object({\n key: z\n .string()\n .describe(\n 'A unique identifier for the event.\\nIf you send the same idempotency key in multiple report event requests, for the same trigger key and app id,\\nconsecutive requests will be ignored after the first one. Note that the idempotency key is kept for a week before it expires.'\n )\n .min(1)\n .max(80)\n .optional(),\n ttlInMilliseconds: z\n .string()\n .regex(/^-?\\d+$/, 'Must be a valid Int64 string')\n .describe(\n 'Optional. The time to live (TTL) in milliseconds before the key will expire. Default is a week.'\n )\n .optional()\n .nullable(),\n })\n .describe('Idempotency information for the event.')\n .optional(),\n })\n .optional(),\n});\nexport const ReportEventResponse = z.object({\n activationIds: z.array(z.string()).max(100).optional(),\n});\nexport const BulkReportEventRequest = z.object({\n triggerKey: z\n .string()\n .describe(\n \"Trigger key as defined in your app's trigger configuration\\nin the app dashboard.\\nFor example, `form_submitted` or `invoice_due`.\"\n )\n .min(1)\n .max(100),\n eventsInfo: z\n .array(\n z.object({\n payload: z\n .record(z.string(), z.any())\n .describe(\n 'Event payload, formatted as key:value pairs.\\nMust comply with the payload schema\\nif you provided one when configuring your trigger.'\n )\n .optional()\n .nullable(),\n externalEntityId: z\n .string()\n .describe('ID of the related resource in GUID format.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n idempotency: z\n .object({\n key: z\n .string()\n .describe(\n 'A unique identifier for the event.\\nIf you send the same idempotency key in multiple report event requests, for the same trigger key and app id,\\nconsecutive requests will be ignored after the first one. Note that the idempotency key is kept for a week before it expires.'\n )\n .min(1)\n .max(80)\n .optional(),\n ttlInMilliseconds: z\n .string()\n .regex(/^-?\\d+$/, 'Must be a valid Int64 string')\n .describe(\n 'Optional. The time to live (TTL) in milliseconds before the key will expire. Default is a week.'\n )\n .optional()\n .nullable(),\n })\n .describe('Idempotency information for the event.')\n .optional(),\n })\n )\n .min(1)\n .max(100),\n});\nexport const BulkReportEventResponse = z.object({\n triggerKey: z\n .string()\n .describe('Trigger key associated with the event.')\n .min(1)\n .max(100)\n .optional(),\n results: z\n .array(\n z.object({\n itemMetadata: z\n .object({\n _id: z\n .string()\n .describe(\n \"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).\"\n )\n .optional()\n .nullable(),\n originalIndex: z\n .number()\n .int()\n .describe(\n 'Index of the item within the request array. Allows for correlation between request and response items.'\n )\n .optional(),\n success: z\n .boolean()\n .describe(\n 'Whether the requested action was successful for this item. When `false`, the `error` field is populated.'\n )\n .optional(),\n error: z\n .object({\n code: z.string().describe('Error code.').optional(),\n description: z\n .string()\n .describe('Description of the error.')\n .optional(),\n data: z\n .record(z.string(), z.any())\n .describe('Data related to the error.')\n .optional()\n .nullable(),\n })\n .describe('Details about the error in case of failure.')\n .optional(),\n })\n .describe('Metadata for the individual item in the request.')\n .optional(),\n eventInfo: z\n .object({\n payload: z\n .record(z.string(), z.any())\n .describe(\n 'Event payload, formatted as key:value pairs.\\nMust comply with the payload schema\\nif you provided one when configuring your trigger.'\n )\n .optional()\n .nullable(),\n externalEntityId: z\n .string()\n .describe('ID of the related resource in GUID format.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n idempotency: z\n .object({\n key: z\n .string()\n .describe(\n 'A unique identifier for the event.\\nIf you send the same idempotency key in multiple report event requests, for the same trigger key and app id,\\nconsecutive requests will be ignored after the first one. Note that the idempotency key is kept for a week before it expires.'\n )\n .min(1)\n .max(80)\n .optional(),\n ttlInMilliseconds: z\n .string()\n .regex(/^-?\\d+$/, 'Must be a valid Int64 string')\n .describe(\n 'Optional. The time to live (TTL) in milliseconds before the key will expire. Default is a week.'\n )\n .optional()\n .nullable(),\n })\n .describe('Idempotency information for the event.')\n .optional(),\n })\n .describe('Event details for the item in the request.')\n .optional(),\n activationIds: z.array(z.string()).max(100).optional(),\n })\n )\n .optional(),\n bulkActionMetadata: z\n .object({\n totalSuccesses: z\n .number()\n .int()\n .describe('Number of items that were successfully processed.')\n .optional(),\n totalFailures: z\n .number()\n .int()\n .describe(\"Number of items that couldn't be processed.\")\n .optional(),\n undetailedFailures: z\n .number()\n .int()\n .describe(\n 'Number of failures without details because detailed failure threshold was exceeded.'\n )\n .optional(),\n })\n .describe(\n 'Metadata for the overall bulk action, including success and failure counts.'\n )\n .optional(),\n});\nexport const BulkCancelEventRequest = z.object({\n triggerKey: z\n .string()\n .describe(\n 'Trigger key whose events you want to cancel.\\nFor example, `form_submitted` or `invoice_due`.'\n )\n .min(1)\n .max(100),\n externalEntityIds: z.array(z.string()).min(1).max(100),\n});\nexport const BulkCancelEventResponse = z.object({\n triggerKey: z\n .string()\n .describe('Trigger key related to the canceled event.')\n .min(1)\n .max(100)\n .optional(),\n results: z\n .array(\n z.object({\n itemMetadata: z\n .object({\n _id: z\n .string()\n .describe(\n \"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).\"\n )\n .optional()\n .nullable(),\n originalIndex: z\n .number()\n .int()\n .describe(\n 'Index of the item within the request array. Allows for correlation between request and response items.'\n )\n .optional(),\n success: z\n .boolean()\n .describe(\n 'Whether the requested action was successful for this item. When `false`, the `error` field is populated.'\n )\n .optional(),\n error: z\n .object({\n code: z.string().describe('Error code.').optional(),\n description: z\n .string()\n .describe('Description of the error.')\n .optional(),\n data: z\n .record(z.string(), z.any())\n .describe('Data related to the error.')\n .optional()\n .nullable(),\n })\n .describe('Details about the error in case of failure.')\n .optional(),\n })\n .describe(\n 'Metadata of the item, including its ID and success or failure status.'\n )\n .optional(),\n externalEntityId: z\n .string()\n .describe('ID of the related resource in GUID format.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n })\n )\n .optional(),\n bulkActionMetadata: z\n .object({\n totalSuccesses: z\n .number()\n .int()\n .describe('Number of items that were successfully processed.')\n .optional(),\n totalFailures: z\n .number()\n .int()\n .describe(\"Number of items that couldn't be processed.\")\n .optional(),\n undetailedFailures: z\n .number()\n .int()\n .describe(\n 'Number of failures without details because detailed failure threshold was exceeded.'\n )\n .optional(),\n })\n .describe(\n 'Metadata for the overall bulk action, including success and failure counts.'\n )\n .optional(),\n});\nexport const CancelEventRequest = z.object({\n triggerKey: z\n .string()\n .describe(\n 'Trigger key whose event you want to cancel.\\nFor example, `form_submitted` or `invoice_due`.'\n )\n .min(1)\n .max(100),\n externalEntityId: z\n .string()\n .describe(\n 'ID of the related resource in GUID format.\\nFor example, `fc81a355-3429-50fc-a4c7-def486e828f3`.\\n\\nTypically, this ID is defined in your system,\\nbut you can also use any Wix resource GUID,\\nsuch as contact ID, member ID, or invoice ID.\\nSee\\n[Choose the right `externalEntityId`](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/reporting-and-canceling-events#choose-the-right-externalentityid)\\nfor more information.'\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n ),\n});\nexport const CancelEventResponse = z.object({});\nexport const RunAutomationRequest = z.object({\n identifierType: z.enum(['PREINSTALLED', 'AUTOMATION']),\n options: z.intersection(\n z.object({\n payload: z\n .record(z.string(), z.any())\n .describe(\n 'Event payload, formatted as key:value pairs.\\nMust comply with the payload schema\\nif you provided one when configuring your trigger.\\n\\nKey names can include only alphanumeric characters or underscores\\n(`A-Z`, `a-z`, `0-9`, `_`).\\nThey cannot start with an underscore.\\n\\nValues can be strings, numbers, integers, booleans, or arrays.\\nIf a value is an array, the array items must be objects,\\nand nested object properties must be\\nstrings, numbers, integers, or booleans only.'\n ),\n migrationFlow: z\n .boolean()\n .describe(\n 'When true, indicates this is a migration flow and should bypass\\nthe check for future dates that have already passed.'\n )\n .optional(),\n }),\n z.xor([\n z.object({\n automationIdentifier: z.never().optional(),\n preinstalledIdentifier: z\n .object({\n appId: z\n .string()\n .describe(\n 'ID of the app that the preinstalled automation belongs to.'\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n componentId: z\n .string()\n .describe(\n 'ID of the app component that defines the preinstalled automation.'\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n })\n .describe(\n 'Identifies a preinstalled automation by its app ID and component ID.'\n ),\n }),\n z.object({\n preinstalledIdentifier: z.never().optional(),\n automationIdentifier: z\n .object({\n automationId: z\n .string()\n .describe('ID of the automation to run.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n })\n .describe('Identifies an automation by its ID.'),\n }),\n ])\n ),\n});\nexport const RunAutomationResponse = z.object({\n activationId: z\n .string()\n .describe('ID of the activation created for this run.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n});\nexport const TestAutomationRequest = z.object({\n identifierType: z.enum(['PREINSTALLED', 'AUTOMATION']),\n options: z.intersection(\n z.object({\n payload: z\n .record(z.string(), z.any())\n .describe(\n 'Event payload, formatted as key:value pairs.\\nMust comply with the payload schema\\nif you provided one when configuring your trigger.\\n\\nKey names can include only alphanumeric characters or underscores\\n(`A-Z`, `a-z`, `0-9`, `_`).\\nThey cannot start with an underscore.\\n\\nValues can be strings, numbers, integers, booleans, or arrays.\\nIf a value is an array, the array items must be objects,\\nand nested object properties must be\\nstrings, numbers, integers, or booleans only.'\n ),\n }),\n z.xor([\n z.object({\n automationIdentifier: z.never().optional(),\n preinstalledIdentifier: z\n .object({\n appId: z\n .string()\n .describe(\n 'ID of the app that the preinstalled automation belongs to.'\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n componentId: z\n .string()\n .describe(\n 'ID of the app component that defines the preinstalled automation.'\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n })\n .describe(\n 'Identifies a preinstalled automation by its app ID and component ID.'\n ),\n }),\n z.object({\n preinstalledIdentifier: z.never().optional(),\n automationIdentifier: z\n .object({\n automationId: z\n .string()\n .describe('ID of the automation to run.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional(),\n })\n .describe('Identifies an automation by its ID.'),\n }),\n ])\n ),\n});\nexport const TestAutomationResponse = z.object({\n activationId: z\n .string()\n .describe('ID of the activation created for this test run.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n});\nexport const RerunActivationRequest = z.object({\n activationId: z\n .string()\n .describe(\n 'ID of the activation to rerun. Its original payload and external entity ID are reused.'\n )\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n ),\n options: z\n .object({\n options: z\n .object({\n skipDelays: z\n .boolean()\n .describe(\n \"Whether to skip the automation's delay actions so it runs immediately.\"\n )\n .optional(),\n })\n .describe('Options that control how the activation is rerun.')\n .optional(),\n })\n .optional(),\n});\nexport const RerunActivationResponse = z.object({\n activationId: z\n .string()\n .describe('ID of the new activation created by the rerun.')\n .regex(\n /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,\n 'Must be a valid GUID'\n )\n .optional()\n .nullable(),\n});\nexport const ReportActionInvocationCompletedRequest = z.object({\n status: z.enum(['UNKNOWN_STATUS', 'SUCCESS', 'FAILURE']),\n invocationToken: z\n .string()\n .describe(\n \"Invocation token from Wix's original call to [Invoke](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/invoke). Wix uses this token to match your results with the correct automation run.\\n\\nLearn more about [running an invoked action with a timeout](https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-provider-service-plugin/sample-flow#run-an-invoked-action-with-a-timeout).\"\n )\n .max(2048),\n options: z\n .intersection(\n z.object({}),\n z.xor([\n z.object({\n successInfo: z.never().optional(),\n failureInfo: z.never().optional(),\n }),\n z.object({\n failureInfo: z.never().optional(),\n successInfo: z\n .object({\n result: z\n .record(z.string(), z.any())\n .describe(\n \"Your action's results as specified in its [output schema](https://dev.wix.com/docs/api-reference/business-management/automations/actions/about-actions#the-output-schema).\"\n )\n .optional()\n .nullable(),\n })\n .describe(\"When the `status` is `SUCCESS`, your action's results.\"),\n }),\n z.object({\n successInfo: z.never().optional(),\n failureInfo: z\n .object({\n errorDescription: z\n .string()\n .describe('Why the action failed.')\n .max(1000)\n .optional(),\n })\n .describe('When the `status` is `FAILURE`, why the action failed.'),\n }),\n ])\n )\n .optional(),\n});\nexport const ReportActionInvocationCompletedResponse = z.object({});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,QAAmB;AAEZ,IAAM,qBAAuB,SAAO;AAAA,EACzC,YACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,IAAI,CAAC,EACL,IAAI,GAAG;AAAA,EACV,SACG,SAAO;AAAA,IACN,SACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B;AAAA,MACC;AAAA,IACF,EACC,SAAS,EACT,SAAS;AAAA,IACZ,kBACG,SAAO,EACP;AAAA,MACC;AAAA,IACF,EACC;AAAA,MACC;AAAA,MACA;AAAA,IACF,EACC,SAAS,EACT,SAAS;AAAA,IACZ,aACG,SAAO;AAAA,MACN,KACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,CAAC,EACL,IAAI,EAAE,EACN,SAAS;AAAA,MACZ,mBACG,SAAO,EACP,MAAM,WAAW,8BAA8B,EAC/C;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,IACd,CAAC,EACA,SAAS,wCAAwC,EACjD,SAAS;AAAA,EACd,CAAC,EACA,SAAS;AACd,CAAC;AACM,IAAM,sBAAwB,SAAO;AAAA,EAC1C,eAAiB,QAAQ,SAAO,CAAC,EAAE,IAAI,GAAG,EAAE,SAAS;AACvD,CAAC;AACM,IAAM,yBAA2B,SAAO;AAAA,EAC7C,YACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,IAAI,CAAC,EACL,IAAI,GAAG;AAAA,EACV,YACG;AAAA,IACG,SAAO;AAAA,MACP,SACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,kBACG,SAAO,EACP,SAAS,4CAA4C,EACrD;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,aACG,SAAO;AAAA,QACN,KACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC,IAAI,CAAC,EACL,IAAI,EAAE,EACN,SAAS;AAAA,QACZ,mBACG,SAAO,EACP,MAAM,WAAW,8BAA8B,EAC/C;AAAA,UACC;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,MACd,CAAC,EACA,SAAS,wCAAwC,EACjD,SAAS;AAAA,IACd,CAAC;AAAA,EACH,EACC,IAAI,CAAC,EACL,IAAI,GAAG;AACZ,CAAC;AACM,IAAM,0BAA4B,SAAO;AAAA,EAC9C,YACG,SAAO,EACP,SAAS,wCAAwC,EACjD,IAAI,CAAC,EACL,IAAI,GAAG,EACP,SAAS;AAAA,EACZ,SACG;AAAA,IACG,SAAO;AAAA,MACP,cACG,SAAO;AAAA,QACN,KACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,QACZ,eACG,SAAO,EACP,IAAI,EACJ;AAAA,UACC;AAAA,QACF,EACC,SAAS;AAAA,QACZ,SACG,UAAQ,EACR;AAAA,UACC;AAAA,QACF,EACC,SAAS;AAAA,QACZ,OACG,SAAO;AAAA,UACN,MAAQ,SAAO,EAAE,SAAS,aAAa,EAAE,SAAS;AAAA,UAClD,aACG,SAAO,EACP,SAAS,2BAA2B,EACpC,SAAS;AAAA,UACZ,MACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B,SAAS,4BAA4B,EACrC,SAAS,EACT,SAAS;AAAA,QACd,CAAC,EACA,SAAS,6CAA6C,EACtD,SAAS;AAAA,MACd,CAAC,EACA,SAAS,kDAAkD,EAC3D,SAAS;AAAA,MACZ,WACG,SAAO;AAAA,QACN,SACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B;AAAA,UACC;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,QACZ,kBACG,SAAO,EACP,SAAS,4CAA4C,EACrD;AAAA,UACC;AAAA,UACA;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,QACZ,aACG,SAAO;AAAA,UACN,KACG,SAAO,EACP;AAAA,YACC;AAAA,UACF,EACC,IAAI,CAAC,EACL,IAAI,EAAE,EACN,SAAS;AAAA,UACZ,mBACG,SAAO,EACP,MAAM,WAAW,8BAA8B,EAC/C;AAAA,YACC;AAAA,UACF,EACC,SAAS,EACT,SAAS;AAAA,QACd,CAAC,EACA,SAAS,wCAAwC,EACjD,SAAS;AAAA,MACd,CAAC,EACA,SAAS,4CAA4C,EACrD,SAAS;AAAA,MACZ,eAAiB,QAAQ,SAAO,CAAC,EAAE,IAAI,GAAG,EAAE,SAAS;AAAA,IACvD,CAAC;AAAA,EACH,EACC,SAAS;AAAA,EACZ,oBACG,SAAO;AAAA,IACN,gBACG,SAAO,EACP,IAAI,EACJ,SAAS,mDAAmD,EAC5D,SAAS;AAAA,IACZ,eACG,SAAO,EACP,IAAI,EACJ,SAAS,6CAA6C,EACtD,SAAS;AAAA,IACZ,oBACG,SAAO,EACP,IAAI,EACJ;AAAA,MACC;AAAA,IACF,EACC,SAAS;AAAA,EACd,CAAC,EACA;AAAA,IACC;AAAA,EACF,EACC,SAAS;AACd,CAAC;AACM,IAAM,yBAA2B,SAAO;AAAA,EAC7C,YACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,IAAI,CAAC,EACL,IAAI,GAAG;AAAA,EACV,mBAAqB,QAAQ,SAAO,CAAC,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG;AACvD,CAAC;AACM,IAAM,0BAA4B,SAAO;AAAA,EAC9C,YACG,SAAO,EACP,SAAS,4CAA4C,EACrD,IAAI,CAAC,EACL,IAAI,GAAG,EACP,SAAS;AAAA,EACZ,SACG;AAAA,IACG,SAAO;AAAA,MACP,cACG,SAAO;AAAA,QACN,KACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,QACZ,eACG,SAAO,EACP,IAAI,EACJ;AAAA,UACC;AAAA,QACF,EACC,SAAS;AAAA,QACZ,SACG,UAAQ,EACR;AAAA,UACC;AAAA,QACF,EACC,SAAS;AAAA,QACZ,OACG,SAAO;AAAA,UACN,MAAQ,SAAO,EAAE,SAAS,aAAa,EAAE,SAAS;AAAA,UAClD,aACG,SAAO,EACP,SAAS,2BAA2B,EACpC,SAAS;AAAA,UACZ,MACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B,SAAS,4BAA4B,EACrC,SAAS,EACT,SAAS;AAAA,QACd,CAAC,EACA,SAAS,6CAA6C,EACtD,SAAS;AAAA,MACd,CAAC,EACA;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,kBACG,SAAO,EACP,SAAS,4CAA4C,EACrD;AAAA,QACC;AAAA,QACA;AAAA,MACF,EACC,SAAS;AAAA,IACd,CAAC;AAAA,EACH,EACC,SAAS;AAAA,EACZ,oBACG,SAAO;AAAA,IACN,gBACG,SAAO,EACP,IAAI,EACJ,SAAS,mDAAmD,EAC5D,SAAS;AAAA,IACZ,eACG,SAAO,EACP,IAAI,EACJ,SAAS,6CAA6C,EACtD,SAAS;AAAA,IACZ,oBACG,SAAO,EACP,IAAI,EACJ;AAAA,MACC;AAAA,IACF,EACC,SAAS;AAAA,EACd,CAAC,EACA;AAAA,IACC;AAAA,EACF,EACC,SAAS;AACd,CAAC;AACM,IAAM,qBAAuB,SAAO;AAAA,EACzC,YACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,IAAI,CAAC,EACL,IAAI,GAAG;AAAA,EACV,kBACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC;AAAA,IACC;AAAA,IACA;AAAA,EACF;AACJ,CAAC;AACM,IAAM,sBAAwB,SAAO,CAAC,CAAC;AACvC,IAAM,uBAAyB,SAAO;AAAA,EAC3C,gBAAkB,OAAK,CAAC,gBAAgB,YAAY,CAAC;AAAA,EACrD,SAAW;AAAA,IACP,SAAO;AAAA,MACP,SACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B;AAAA,QACC;AAAA,MACF;AAAA,MACF,eACG,UAAQ,EACR;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,IACd,CAAC;AAAA,IACC,MAAI;AAAA,MACF,SAAO;AAAA,QACP,sBAAwB,QAAM,EAAE,SAAS;AAAA,QACzC,wBACG,SAAO;AAAA,UACN,OACG,SAAO,EACP;AAAA,YACC;AAAA,UACF,EACC;AAAA,YACC;AAAA,YACA;AAAA,UACF,EACC,SAAS;AAAA,UACZ,aACG,SAAO,EACP;AAAA,YACC;AAAA,UACF,EACC;AAAA,YACC;AAAA,YACA;AAAA,UACF,EACC,SAAS;AAAA,QACd,CAAC,EACA;AAAA,UACC;AAAA,QACF;AAAA,MACJ,CAAC;AAAA,MACC,SAAO;AAAA,QACP,wBAA0B,QAAM,EAAE,SAAS;AAAA,QAC3C,sBACG,SAAO;AAAA,UACN,cACG,SAAO,EACP,SAAS,8BAA8B,EACvC;AAAA,YACC;AAAA,YACA;AAAA,UACF,EACC,SAAS;AAAA,QACd,CAAC,EACA,SAAS,qCAAqC;AAAA,MACnD,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACF,CAAC;AACM,IAAM,wBAA0B,SAAO;AAAA,EAC5C,cACG,SAAO,EACP,SAAS,4CAA4C,EACrD;AAAA,IACC;AAAA,IACA;AAAA,EACF,EACC,SAAS,EACT,SAAS;AACd,CAAC;AACM,IAAM,wBAA0B,SAAO;AAAA,EAC5C,gBAAkB,OAAK,CAAC,gBAAgB,YAAY,CAAC;AAAA,EACrD,SAAW;AAAA,IACP,SAAO;AAAA,MACP,SACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B;AAAA,QACC;AAAA,MACF;AAAA,IACJ,CAAC;AAAA,IACC,MAAI;AAAA,MACF,SAAO;AAAA,QACP,sBAAwB,QAAM,EAAE,SAAS;AAAA,QACzC,wBACG,SAAO;AAAA,UACN,OACG,SAAO,EACP;AAAA,YACC;AAAA,UACF,EACC;AAAA,YACC;AAAA,YACA;AAAA,UACF,EACC,SAAS;AAAA,UACZ,aACG,SAAO,EACP;AAAA,YACC;AAAA,UACF,EACC;AAAA,YACC;AAAA,YACA;AAAA,UACF,EACC,SAAS;AAAA,QACd,CAAC,EACA;AAAA,UACC;AAAA,QACF;AAAA,MACJ,CAAC;AAAA,MACC,SAAO;AAAA,QACP,wBAA0B,QAAM,EAAE,SAAS;AAAA,QAC3C,sBACG,SAAO;AAAA,UACN,cACG,SAAO,EACP,SAAS,8BAA8B,EACvC;AAAA,YACC;AAAA,YACA;AAAA,UACF,EACC,SAAS;AAAA,QACd,CAAC,EACA,SAAS,qCAAqC;AAAA,MACnD,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACF,CAAC;AACM,IAAM,yBAA2B,SAAO;AAAA,EAC7C,cACG,SAAO,EACP,SAAS,iDAAiD,EAC1D;AAAA,IACC;AAAA,IACA;AAAA,EACF,EACC,SAAS,EACT,SAAS;AACd,CAAC;AACM,IAAM,yBAA2B,SAAO;AAAA,EAC7C,cACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC;AAAA,IACC;AAAA,IACA;AAAA,EACF;AAAA,EACF,SACG,SAAO;AAAA,IACN,SACG,SAAO;AAAA,MACN,YACG,UAAQ,EACR;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,IACd,CAAC,EACA,SAAS,mDAAmD,EAC5D,SAAS;AAAA,EACd,CAAC,EACA,SAAS;AACd,CAAC;AACM,IAAM,0BAA4B,SAAO;AAAA,EAC9C,cACG,SAAO,EACP,SAAS,gDAAgD,EACzD;AAAA,IACC;AAAA,IACA;AAAA,EACF,EACC,SAAS,EACT,SAAS;AACd,CAAC;AACM,IAAM,yCAA2C,SAAO;AAAA,EAC7D,QAAU,OAAK,CAAC,kBAAkB,WAAW,SAAS,CAAC;AAAA,EACvD,iBACG,SAAO,EACP;AAAA,IACC;AAAA,EACF,EACC,IAAI,IAAI;AAAA,EACX,SACG;AAAA,IACG,SAAO,CAAC,CAAC;AAAA,IACT,MAAI;AAAA,MACF,SAAO;AAAA,QACP,aAAe,QAAM,EAAE,SAAS;AAAA,QAChC,aAAe,QAAM,EAAE,SAAS;AAAA,MAClC,CAAC;AAAA,MACC,SAAO;AAAA,QACP,aAAe,QAAM,EAAE,SAAS;AAAA,QAChC,aACG,SAAO;AAAA,UACN,QACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B;AAAA,YACC;AAAA,UACF,EACC,SAAS,EACT,SAAS;AAAA,QACd,CAAC,EACA,SAAS,wDAAwD;AAAA,MACtE,CAAC;AAAA,MACC,SAAO;AAAA,QACP,aAAe,QAAM,EAAE,SAAS;AAAA,QAChC,aACG,SAAO;AAAA,UACN,kBACG,SAAO,EACP,SAAS,wBAAwB,EACjC,IAAI,GAAI,EACR,SAAS;AAAA,QACd,CAAC,EACA,SAAS,wDAAwD;AAAA,MACtE,CAAC;AAAA,IACH,CAAC;AAAA,EACH,EACC,SAAS;AACd,CAAC;AACM,IAAM,0CAA4C,SAAO,CAAC,CAAC;","names":[]}
@@ -14,7 +14,15 @@ interface ReportEventSignature {
14
14
  *
15
15
  * If your app supports canceling events,
16
16
  * `externalEntityId` must be provided.
17
- * `externalEntityId` is required when calling [cancelEvent()](#cancel-event).
17
+ * `externalEntityId` is required when calling [Cancel Event](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/triggered-events/cancel-event).
18
+ *
19
+ * The event is processed asynchronously. A successful response means the event was accepted for processing, not that the automations have finished running.
20
+ *
21
+ * To report multiple events in a single call, call [Bulk Report Event](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/triggered-events/bulk-report-event).
22
+ *
23
+ * > You cannot try out this endpoint because
24
+ * > it can be called only by the app that created the specified `triggerKey`.
25
+ * > So please ignore the **Try It Out** button.
18
26
  * @param - Trigger key as defined in your app's trigger configuration
19
27
  * in the app dashboard.
20
28
  * For example, `form_submitted` or `invoice_due`.
@@ -26,7 +34,12 @@ interface ReportEventSignature {
26
34
  declare function bulkReportEvent$1(httpClient: HttpClient): BulkReportEventSignature;
27
35
  interface BulkReportEventSignature {
28
36
  /**
29
- * Bulk reports events and activates site automations with the specified trigger key.
37
+ * Reports multiple events at once, activating site automations configured with the specified trigger key.
38
+ *
39
+ *
40
+ * Each event in `eventsInfo` is processed independently and asynchronously, so some events can succeed while others fail. Check `bulkActionMetadata` for the success and failure totals.
41
+ *
42
+ * To report a single event, call [Report Event](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/triggered-events/report-event).
30
43
  * @param - Trigger key as defined in your app's trigger configuration
31
44
  * in the app dashboard.
32
45
  * For example, `form_submitted` or `invoice_due`.
@@ -37,7 +50,12 @@ interface BulkReportEventSignature {
37
50
  declare function bulkCancelEvent$1(httpClient: HttpClient): BulkCancelEventSignature;
38
51
  interface BulkCancelEventSignature {
39
52
  /**
40
- * Bulk cancels any remaining actions for a trigger and external entities.
53
+ * Cancels any remaining actions for multiple events at once, given a trigger key and the events' external entity IDs.
54
+ *
55
+ *
56
+ * Each external entity ID is processed independently, so some cancellations can succeed while others fail. Check `bulkActionMetadata` for the success and failure totals.
57
+ *
58
+ * To cancel a single event, call [Cancel Event](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/triggered-events/cancel-event).
41
59
  * @param - Trigger key whose events you want to cancel.
42
60
  * For example, `form_submitted` or `invoice_due`.
43
61
  * @param - Repeated list of external_entity_id, representing the related resources' IDs.
@@ -53,10 +71,19 @@ interface CancelEventSignature {
53
71
  * Events are not cancelable by default.
54
72
  * To make an event cancelable,
55
73
  * you must first pass an `externalEntityId`
56
- * and the applicable `triggerKey` to [reportEvent()](#report-event).
57
- * When you call cancelEvent() with the same `externalEntityId` and `triggerKey`,
74
+ * and the applicable `triggerKey` to [Report Event](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/triggered-events/report-event).
75
+ * When you call Cancel Event with the same `externalEntityId` and `triggerKey`,
58
76
  * the event is canceled,
59
77
  * as are all other events that share the `externalEntityId` and `triggerKey`.
78
+ * See
79
+ * [Reporting and Canceling Events](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/triggered-events/reporting-and-canceling-events)
80
+ * for more information.
81
+ *
82
+ * To cancel events for multiple external entities in a single call, call [Bulk Cancel Event](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/triggered-events/bulk-cancel-event).
83
+ *
84
+ * > You cannot try out this endpoint because
85
+ * > it can be called only by the app that created the specified `triggerKey`.
86
+ * > So please ignore the **Try It Out** button.
60
87
  * @param - Trigger key whose event you want to cancel.
61
88
  * For example, `form_submitted` or `invoice_due`.
62
89
  * @param - ID of the related resource in GUID format.
@@ -74,41 +101,42 @@ interface CancelEventSignature {
74
101
  declare function esbConfigResolverRunAutomation$1(httpClient: HttpClient): EsbConfigResolverRunAutomationSignature;
75
102
  interface EsbConfigResolverRunAutomationSignature {
76
103
  /**
77
- * Runs an automation manually.
78
- *
79
- * This gives a user the ability to trigger the automation manually,
80
- * without requiring an event to be reported to start the automation.
81
- * As an example,
82
- * consider an automation that sends a confirmation for a hotel booking when a user submits a reservation online.
83
- * However, if the user calls the hotel directly to make the reservation, the automation isn't triggered.
84
- * The site owner needs a way to send the automated confirmation without the user making an online booking.
85
- * Run Automation provides this functionality.
86
- *
87
- *
88
- * <blockquote class="important">
89
- * __Permissions__
90
- * This endpoint requires the Manage Your App
91
- * [permission scope](https://devforum.wix.com/en/article/available-permissions).
92
- * </blockquote>
93
- * @param - identifier MUST be either AUTOMATION or PREINSTALLED
104
+ * Runs an automation directly, without reporting an event.
105
+ *
106
+ *
107
+ * Use this to activate an automation manually when no triggering event occurs in your system. For example, an automation that sends a confirmation when a customer books online won't run if the customer books by phone instead. Run Automation lets the site owner send that confirmation anyway.
108
+ *
109
+ * Identify the automation to run in one of these ways:
110
+ *
111
+ * - `automationIdentifier`: The ID of an existing automation. Retrieve it from the [Automations API](https://dev.wix.com/docs/rest/business-management/automations/introduction).
112
+ * - `preinstalledIdentifier`: The app ID and component ID of a preinstalled automation.
113
+ *
114
+ * To run an automation in test mode, including unpublished draft automations, call [Test Automation](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/triggered-events/test-automation).
115
+ * @param - How the automation to run is identified. Set to `AUTOMATION` to use `automationIdentifier`, or `PREINSTALLED` to use `preinstalledIdentifier`.
94
116
  */
95
117
  (identifierType: IdentifierTypeWithLiterals, options?: NonNullablePaths<EsbConfigResolverRunAutomationOptions, `payload`, 2>): Promise<V1RunAutomationResponse>;
96
118
  }
97
119
  declare function testAutomation$1(httpClient: HttpClient): TestAutomationSignature;
98
120
  interface TestAutomationSignature {
99
121
  /**
100
- * Runs an automation manually in test mode.
122
+ * Runs an automation in test mode, without reporting an event.
123
+ *
124
+ *
125
+ * Test mode runs the automation and its actions for real, but it can also run unpublished draft automations and skips any configured delays so you see the results immediately. Use it to verify an automation's behavior before publishing it.
101
126
  *
102
- * Similar to RunAutomation but always executed as TEST to allow running draft automations safely.
103
- * @param - identifier MUST be either AUTOMATION or PREINSTALLED
127
+ * Identify the automation to run the same way as in [Run Automation](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/triggered-events/run-automation).
128
+ * @param - How the automation to run is identified. Set to `AUTOMATION` to use `automationIdentifier`, or `PREINSTALLED` to use `preinstalledIdentifier`.
104
129
  */
105
130
  (identifierType: IdentifierTypeWithLiterals, options: NonNullablePaths<TestAutomationOptions, `payload`, 2>): Promise<TestAutomationResponse>;
106
131
  }
107
132
  declare function rerunActivation$1(httpClient: HttpClient): RerunActivationSignature;
108
133
  interface RerunActivationSignature {
109
134
  /**
110
- * Rerun an automation using a previous activation's payload.
111
- * @param - The activation ID whose payload will be used for the rerun.
135
+ * Reruns a previous activation, reusing its original payload and external entity ID.
136
+ *
137
+ *
138
+ * Use this to retry an activation that failed, after you've resolved the underlying issue. A rerun creates a new activation. You can find the original `activationId` in the automation's run log on the automations page.
139
+ * @param - ID of the activation to rerun. Its original payload and external entity ID are reused.
112
140
  */
113
141
  (activationId: string, options?: RerunActivationOptions): Promise<RerunActivationResponse>;
114
142
  }