@wix/auto_sdk_automations_activations 1.0.135 → 1.0.136

package/build/cjs/index.d.ts

@@ -14,7 +14,15 @@ interface ReportEventSignature {
      *
      * 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 - Trigger key as defined in your app's trigger configuration
      * in the app dashboard.
      * For example, `form_submitted` or `invoice_due`.
@@ -26,7 +34,12 @@ interface ReportEventSignature {
 declare function bulkReportEvent$1(httpClient: HttpClient): BulkReportEventSignature;
 interface BulkReportEventSignature {
     /**
-     * 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 - Trigger key as defined in your app's trigger configuration
      * in the app dashboard.
      * For example, `form_submitted` or `invoice_due`.
@@ -37,7 +50,12 @@ interface BulkReportEventSignature {
 declare function bulkCancelEvent$1(httpClient: HttpClient): BulkCancelEventSignature;
 interface BulkCancelEventSignature {
     /**
-     * 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 - Trigger key whose events you want to cancel.
      * For example, `form_submitted` or `invoice_due`.
      * @param - Repeated list of external_entity_id, representing the related resources' IDs.
@@ -53,10 +71,19 @@ interface CancelEventSignature {
      * 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 - Trigger key whose event you want to cancel.
      * For example, `form_submitted` or `invoice_due`.
      * @param - ID of the related resource in GUID format.
@@ -74,41 +101,42 @@ interface CancelEventSignature {
 declare function esbConfigResolverRunAutomation$1(httpClient: HttpClient): EsbConfigResolverRunAutomationSignature;
 interface EsbConfigResolverRunAutomationSignature {
     /**
-     * Runs an automation manually.
-     *
-     * 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.
-     *
-     *
-     * <blockquote class="important">
-     * __Permissions__
-     * This endpoint requires the Manage Your App
-     * [permission scope](https://devforum.wix.com/en/article/available-permissions).
-     * </blockquote>
-     * @param - identifier MUST be either AUTOMATION or PREINSTALLED
+     * 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.
+     *
+     * 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.
+     *
+     * 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 - How the automation to run is identified. Set to `AUTOMATION` to use `automationIdentifier`, or `PREINSTALLED` to use `preinstalledIdentifier`.
      */
     (identifierType: IdentifierTypeWithLiterals, options?: NonNullablePaths<EsbConfigResolverRunAutomationOptions, `payload`, 2>): Promise<V1RunAutomationResponse>;
 }
 declare function testAutomation$1(httpClient: HttpClient): TestAutomationSignature;
 interface TestAutomationSignature {
     /**
-     * Runs an automation manually in test mode.
+     * Runs an automation in test mode, without reporting an event.
+     *
+     *
+     * 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.
      *
-     * Similar to RunAutomation but always executed as TEST to allow running draft automations safely.
-     * @param - identifier MUST be either AUTOMATION or PREINSTALLED
+     * 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 - How the automation to run is identified. Set to `AUTOMATION` to use `automationIdentifier`, or `PREINSTALLED` to use `preinstalledIdentifier`.
      */
     (identifierType: IdentifierTypeWithLiterals, options: NonNullablePaths<TestAutomationOptions, `payload`, 2>): Promise<TestAutomationResponse>;
 }
 declare function rerunActivation$1(httpClient: HttpClient): RerunActivationSignature;
 interface RerunActivationSignature {
     /**
-     * Rerun an automation using a previous activation's payload.
-     * @param - 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 - ID of the activation to rerun. Its original payload and external entity ID are reused.
      */
     (activationId: string, options?: RerunActivationOptions): Promise<RerunActivationResponse>;
 }