@wix/auto_sdk_automations_activations 1.0.135 → 1.0.136

package/build/internal/es/index.typings.d.mts

@@ -1894,7 +1894,7 @@ interface ReportEventRequest {
      * For example, `fc81a355-3429-50fc-a4c7-def486e828f3`.
      *
      * Required if your app needs to
-     * [cancel the event](https://dev.wix.com/docs/sdk/backend-modules/automations/triggered-events/cancel-event)
+     * [cancel the event](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/cancel-event)
      * if the automation becomes no longer relevant.
      *
      * Typically, this ID is defined in your system,
@@ -2053,12 +2053,12 @@ interface CancelEventRequest {
 interface CancelEventResponse {
 }
 interface V1RunAutomationRequest extends V1RunAutomationRequestIdentifierOneOf {
-    /** a preinstalled automation identifier */
+    /** Identifies a preinstalled automation by its app ID and component ID. */
     preinstalledIdentifier?: PreinstalledIdentifier;
-    /** a automation of any type identifier that will be available in future */
+    /** Identifies an automation by its ID. */
     automationIdentifier?: AutomationIdentifier;
     /**
-     * identifier MUST be either AUTOMATION or PREINSTALLED
+     * How the automation to run is identified. Set to `AUTOMATION` to use `automationIdentifier`, or `PREINSTALLED` to use `preinstalledIdentifier`.
      * @immutable
      */
     identifierType: IdentifierTypeWithLiterals;
@@ -2085,54 +2085,54 @@ interface V1RunAutomationRequest extends V1RunAutomationRequestIdentifierOneOf {
 }
 /** @oneof */
 interface V1RunAutomationRequestIdentifierOneOf {
-    /** a preinstalled automation identifier */
+    /** Identifies a preinstalled automation by its app ID and component ID. */
     preinstalledIdentifier?: PreinstalledIdentifier;
-    /** a automation of any type identifier that will be available in future */
+    /** Identifies an automation by its ID. */
     automationIdentifier?: AutomationIdentifier;
 }
-/** Specifies how an automation is identified when invoking RunAutomation or TestAutomation endpoints. */
+/** Specifies how an automation is identified when calling Run Automation or Test Automation. */
 declare enum IdentifierType {
-    /** Identifies a pre-installed automation by component ID and app ID. */
+    /** Identifies a preinstalled automation by its app ID and component ID. */
     PREINSTALLED = "PREINSTALLED",
-    /** Identifies a specific automation by its unique automation ID. */
+    /** Identifies an automation by its ID. */
     AUTOMATION = "AUTOMATION"
 }
 /** @enumType */
 type IdentifierTypeWithLiterals = IdentifierType | 'PREINSTALLED' | 'AUTOMATION';
 interface PreinstalledIdentifier {
     /**
-     * identifier for the application of the preinstalled
+     * ID of the app that the preinstalled automation belongs to.
      * @format GUID
      */
     appId?: string;
     /**
-     * application component id
+     * ID of the app component that defines the preinstalled automation.
      * @format GUID
      */
     componentId?: string;
 }
 interface AutomationIdentifier {
     /**
-     * automation id
+     * ID of the automation to run.
      * @format GUID
      */
     automationId?: string;
 }
 interface V1RunAutomationResponse {
     /**
-     * Activation ID generated (for tracking)
+     * ID of the activation created for this run.
      * @format GUID
      */
     activationId?: string | null;
 }
 /** Test mode variant of RunAutomationRequest. */
 interface TestAutomationRequest extends TestAutomationRequestIdentifierOneOf {
-    /** a preinstalled automation identifier */
+    /** Identifies a preinstalled automation by its app ID and component ID. */
     preinstalledIdentifier?: PreinstalledIdentifier;
-    /** a automation of any type identifier that will be available in future */
+    /** Identifies an automation by its ID. */
     automationIdentifier?: AutomationIdentifier;
     /**
-     * identifier MUST be either AUTOMATION or PREINSTALLED
+     * How the automation to run is identified. Set to `AUTOMATION` to use `automationIdentifier`, or `PREINSTALLED` to use `preinstalledIdentifier`.
      * @immutable
      */
     identifierType: IdentifierTypeWithLiterals;
@@ -2154,14 +2154,14 @@ interface TestAutomationRequest extends TestAutomationRequestIdentifierOneOf {
 }
 /** @oneof */
 interface TestAutomationRequestIdentifierOneOf {
-    /** a preinstalled automation identifier */
+    /** Identifies a preinstalled automation by its app ID and component ID. */
     preinstalledIdentifier?: PreinstalledIdentifier;
-    /** a automation of any type identifier that will be available in future */
+    /** Identifies an automation by its ID. */
     automationIdentifier?: AutomationIdentifier;
 }
 interface TestAutomationResponse {
     /**
-     * Activation ID generated (for tracking)
+     * ID of the activation created for this test run.
      * @format GUID
      */
     activationId?: string | null;
@@ -2169,21 +2169,21 @@ interface TestAutomationResponse {
 /** Request to rerun an automation using a previous activation's payload. */
 interface RerunActivationRequest {
     /**
-     * The activation ID whose payload will be used for the rerun.
+     * ID of the activation to rerun. Its original payload and external entity ID are reused.
      * @format GUID
      */
     activationId: string;
-    /** Options controlling execution behavior. */
+    /** Options that control how the activation is rerun. */
     options?: RunOptions;
 }
-/** Options that control how an automation activation is executed. */
+/** Options that control how an activation is executed. */
 interface RunOptions {
-    /** When true, delay actions will be skipped (similar to test mode behavior). */
+    /** Whether to skip the automation's delay actions so it runs immediately. */
     skipDelays?: boolean;
 }
 interface RerunActivationResponse {
     /**
-     * Activation ID generated (for tracking)
+     * ID of the new activation created by the rerun.
      * @format GUID
      */
     activationId?: string | null;
@@ -2781,7 +2781,15 @@ type ReportEventApplicationErrors = {
  *
  * If your app supports canceling events,
  * `externalEntityId` must be provided.
- * `externalEntityId` is required when calling [cancelEvent()](#cancel-event).
+ * `externalEntityId` is required when calling [Cancel Event](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/triggered-events/cancel-event).
+ *
+ * The event is processed asynchronously. A successful response means the event was accepted for processing, not that the automations have finished running.
+ *
+ * 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).
+ *
+ * > You cannot try out this endpoint because
+ * > it can be called only by the app that created the specified `triggerKey`.
+ * > So please ignore the **Try It Out** button.
  * @param triggerKey - Trigger key as defined in your app's trigger configuration
  * in the app dashboard.
  * For example, `form_submitted` or `invoice_due`.
@@ -2815,7 +2823,7 @@ interface ReportEventOptions {
      * For example, `fc81a355-3429-50fc-a4c7-def486e828f3`.
      *
      * Required if your app needs to
-     * [cancel the event](https://dev.wix.com/docs/sdk/backend-modules/automations/triggered-events/cancel-event)
+     * [cancel the event](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/cancel-event)
      * if the automation becomes no longer relevant.
      *
      * Typically, this ID is defined in your system,
@@ -2831,7 +2839,12 @@ interface ReportEventOptions {
     idempotency?: Idempotency;
 }
 /**
- * Bulk reports events and activates site automations with the specified trigger key.
+ * Reports multiple events at once, activating site automations configured with the specified trigger key.
+ *
+ *
+ * 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.
+ *
+ * To report a single event, call [Report Event](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/triggered-events/report-event).
  * @param triggerKey - Trigger key as defined in your app's trigger configuration
  * in the app dashboard.
  * For example, `form_submitted` or `invoice_due`.
@@ -2845,7 +2858,12 @@ interface ReportEventOptions {
  */
 declare function bulkReportEvent(triggerKey: string, eventsInfo: EventInfo[]): Promise<NonNullablePaths<BulkReportEventResponse, `triggerKey` | `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.eventInfo.idempotency.key` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 /**
- * Bulk cancels any remaining actions for a trigger and external entities.
+ * Cancels any remaining actions for multiple events at once, given a trigger key and the events' external entity IDs.
+ *
+ *
+ * Each external entity ID is processed independently, so some cancellations can succeed while others fail. Check `bulkActionMetadata` for the success and failure totals.
+ *
+ * To cancel a single event, call [Cancel Event](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/triggered-events/cancel-event).
  * @param triggerKey - Trigger key whose events you want to cancel.
  * For example, `form_submitted` or `invoice_due`.
  * @param externalEntityIds - Repeated list of external_entity_id, representing the related resources' IDs.
@@ -2864,10 +2882,19 @@ declare function bulkCancelEvent(triggerKey: string, externalEntityIds: string[]
  * Events are not cancelable by default.
  * To make an event cancelable,
  * you must first pass an `externalEntityId`
- * and the applicable `triggerKey` to [reportEvent()](#report-event).
- * When you call cancelEvent() with the same `externalEntityId` and `triggerKey`,
+ * and the applicable `triggerKey` to [Report Event](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/triggered-events/report-event).
+ * When you call Cancel Event with the same `externalEntityId` and `triggerKey`,
  * the event is canceled,
  * as are all other events that share the `externalEntityId` and `triggerKey`.
+ * See
+ * [Reporting and Canceling Events](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/triggered-events/reporting-and-canceling-events)
+ * for more information.
+ *
+ * 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).
+ *
+ * > You cannot try out this endpoint because
+ * > it can be called only by the app that created the specified `triggerKey`.
+ * > So please ignore the **Try It Out** button.
  * @param triggerKey - Trigger key whose event you want to cancel.
  * For example, `form_submitted` or `invoice_due`.
  * @param externalEntityId - ID of the related resource in GUID format.
@@ -2888,23 +2915,18 @@ declare function bulkCancelEvent(triggerKey: string, externalEntityIds: string[]
  */
 declare function cancelEvent(triggerKey: string, externalEntityId: string): Promise<void>;
 /**
- * Runs an automation manually.
+ * Runs an automation directly, without reporting an event.
+ *
+ *
+ * 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.
  *
- * This gives a user the ability to trigger the automation manually,
- * without requiring an event to be reported to start the automation.
- * As an example,
- * consider an automation that sends a confirmation for a hotel booking when a user submits a reservation online.
- * However, if the user calls the hotel directly to make the reservation, the automation isn't triggered.
- * The site owner needs a way to send the automated confirmation without the user making an online booking.
- * Run Automation provides this functionality.
+ * Identify the automation to run in one of these ways:
  *
+ * - `automationIdentifier`: The ID of an existing automation. Retrieve it from the [Automations API](https://dev.wix.com/docs/rest/business-management/automations/introduction).
+ * - `preinstalledIdentifier`: The app ID and component ID of a preinstalled automation.
  *
- * <blockquote class="important">
- * __Permissions__
- * This endpoint requires the Manage Your App
- * [permission scope](https://devforum.wix.com/en/article/available-permissions).
- * </blockquote>
- * @param identifierType - identifier MUST be either AUTOMATION or PREINSTALLED
+ * 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).
+ * @param identifierType - How the automation to run is identified. Set to `AUTOMATION` to use `automationIdentifier`, or `PREINSTALLED` to use `preinstalledIdentifier`.
  * @public
  * @documentationMaturity preview
  * @requiredField identifierType
@@ -2916,9 +2938,9 @@ declare function cancelEvent(triggerKey: string, externalEntityId: string): Prom
  */
 declare function esbConfigResolverRunAutomation(identifierType: IdentifierTypeWithLiterals, options?: NonNullablePaths<EsbConfigResolverRunAutomationOptions, `payload`, 2>): Promise<V1RunAutomationResponse>;
 interface EsbConfigResolverRunAutomationOptions extends EsbConfigResolverRunAutomationOptionsIdentifierOneOf {
-    /** a preinstalled automation identifier */
+    /** Identifies a preinstalled automation by its app ID and component ID. */
     preinstalledIdentifier?: PreinstalledIdentifier;
-    /** a automation of any type identifier that will be available in future */
+    /** Identifies an automation by its ID. */
     automationIdentifier?: AutomationIdentifier;
     /**
      * Event payload, formatted as key:value pairs.
@@ -2943,16 +2965,19 @@ interface EsbConfigResolverRunAutomationOptions extends EsbConfigResolverRunAuto
 }
 /** @oneof */
 interface EsbConfigResolverRunAutomationOptionsIdentifierOneOf {
-    /** a preinstalled automation identifier */
+    /** Identifies a preinstalled automation by its app ID and component ID. */
     preinstalledIdentifier?: PreinstalledIdentifier;
-    /** a automation of any type identifier that will be available in future */
+    /** Identifies an automation by its ID. */
     automationIdentifier?: AutomationIdentifier;
 }
 /**
- * Runs an automation manually in test mode.
+ * Runs an automation in test mode, without reporting an event.
  *
- * Similar to RunAutomation but always executed as TEST to allow running draft automations safely.
- * @param identifierType - identifier MUST be either AUTOMATION or PREINSTALLED
+ *
+ * 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.
+ *
+ * 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).
+ * @param identifierType - How the automation to run is identified. Set to `AUTOMATION` to use `automationIdentifier`, or `PREINSTALLED` to use `preinstalledIdentifier`.
  * @public
  * @documentationMaturity preview
  * @requiredField identifierType
@@ -2965,9 +2990,9 @@ interface EsbConfigResolverRunAutomationOptionsIdentifierOneOf {
  */
 declare function testAutomation(identifierType: IdentifierTypeWithLiterals, options: NonNullablePaths<TestAutomationOptions, `payload`, 2>): Promise<TestAutomationResponse>;
 interface TestAutomationOptions extends TestAutomationOptionsIdentifierOneOf {
-    /** a preinstalled automation identifier */
+    /** Identifies a preinstalled automation by its app ID and component ID. */
     preinstalledIdentifier?: PreinstalledIdentifier;
-    /** a automation of any type identifier that will be available in future */
+    /** Identifies an automation by its ID. */
     automationIdentifier?: AutomationIdentifier;
     /**
      * Event payload, formatted as key:value pairs.
@@ -2987,14 +3012,17 @@ interface TestAutomationOptions extends TestAutomationOptionsIdentifierOneOf {
 }
 /** @oneof */
 interface TestAutomationOptionsIdentifierOneOf {
-    /** a preinstalled automation identifier */
+    /** Identifies a preinstalled automation by its app ID and component ID. */
     preinstalledIdentifier?: PreinstalledIdentifier;
-    /** a automation of any type identifier that will be available in future */
+    /** Identifies an automation by its ID. */
     automationIdentifier?: AutomationIdentifier;
 }
 /**
- * Rerun an automation using a previous activation's payload.
- * @param activationId - The activation ID whose payload will be used for the rerun.
+ * Reruns a previous activation, reusing its original payload and external entity ID.
+ *
+ *
+ * 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.
+ * @param activationId - ID of the activation to rerun. Its original payload and external entity ID are reused.
  * @public
  * @documentationMaturity preview
  * @requiredField activationId
@@ -3004,7 +3032,7 @@ interface TestAutomationOptionsIdentifierOneOf {
  */
 declare function rerunActivation(activationId: string, options?: RerunActivationOptions): Promise<RerunActivationResponse>;
 interface RerunActivationOptions {
-    /** Options controlling execution behavior. */
+    /** Options that control how the activation is rerun. */
     options?: RunOptions;
 }
 /**