@wix/automations 1.0.20 → 1.0.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/automations",
-  "version": "1.0.20",
+  "version": "1.0.21",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,9 +18,9 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/automations_activations": "1.0.16",
-    "@wix/automations_automations-service": "1.0.8",
-    "@wix/automations_automations-service-v-2": "1.0.8"
+    "@wix/automations_activations": "1.0.17",
+    "@wix/automations_automations-service": "1.0.9",
+    "@wix/automations_automations-service-v-2": "1.0.9"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -45,5 +45,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "8502082edba5d35caba8a29962f76fbd573dc6f7da69a61b3c5ee566"
+  "falconPackageHash": "57fda055d80edeb84d09cd78cd8f82a3a836815475f787d3e6fcc0dd"
 }

package/type-bundles/context.bundle.d.ts

@@ -1,3 +1,47 @@
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
 /** Automation */
 interface Automation$2 {
     /**
@@ -1595,61 +1639,93 @@ interface GenerateActionInputMappingFromTemplateOptions {
     actionInputMappingTemplate: Record<string, any> | null;
 }
 
-type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: typeof fetch;
-    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+declare function createAutomation$3(httpClient: HttpClient): CreateAutomationSignature$1;
+interface CreateAutomationSignature$1 {
+    /**
+     * Creates a new Automation
+     * @param - Automation to be created
+     * @returns The created Automation
+     */
+    (automation: Automation$2): Promise<Automation$2 & AutomationNonNullableFields$1>;
 }
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-type EventDefinition<Payload = unknown, Type extends string = string> = {
-    __type: 'event-definition';
-    type: Type;
-    isDomainEvent?: boolean;
-    transformations?: (envelope: unknown) => Payload;
-    __payload: Payload;
-};
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
-type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
-type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function getAutomation$3(httpClient: HttpClient): GetAutomationSignature$1;
+interface GetAutomationSignature$1 {
+    /**
+     * Get a Automation by id
+     * @param - Automation ID
+     * @returns Automation
+     */
+    (automationId: string, options?: GetAutomationOptions$1 | undefined): Promise<Automation$2 & AutomationNonNullableFields$1>;
+}
+declare function updateAutomation$3(httpClient: HttpClient): UpdateAutomationSignature$1;
+interface UpdateAutomationSignature$1 {
+    /**
+     * Update a Automation, supports partial update
+     * Pass the latest `revision` for a successful update
+     * @param - Automation ID
+     * @returns The updated Automation
+     */
+    (_id: string | null, automation: UpdateAutomation$1): Promise<Automation$2 & AutomationNonNullableFields$1>;
+}
+declare function deleteAutomation$3(httpClient: HttpClient): DeleteAutomationSignature$1;
+interface DeleteAutomationSignature$1 {
+    /**
+     * Delete an Automation
+     * @param - Id of the Automation to delete
+     */
+    (automationId: string, options?: DeleteAutomationOptions | undefined): Promise<void>;
+}
+declare function queryAutomations$3(httpClient: HttpClient): QueryAutomationsSignature$1;
+interface QueryAutomationsSignature$1 {
+    /**
+     * Query Automations using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+     */
+    (options?: QueryAutomationsOptions | undefined): AutomationsQueryBuilder$1;
+}
+declare function overrideApplicationAutomation$1(httpClient: HttpClient): OverrideApplicationAutomationSignature;
+interface OverrideApplicationAutomationSignature {
+    /**
+     * Creates a new Automation
+     * @param - Application Automation
+     */
+    (automation: Automation$2): Promise<OverrideApplicationAutomationResponse & OverrideApplicationAutomationResponseNonNullableFields>;
+}
+declare function validateAutomationById$1(httpClient: HttpClient): ValidateAutomationByIdSignature;
+interface ValidateAutomationByIdSignature {
+    /**
+     * Validate Automation by Id
+     * @param - Automation ID
+     */
+    (automationId: string, options?: ValidateAutomationByIdOptions | undefined): Promise<ValidateAutomationByIdResponse & ValidateAutomationByIdResponseNonNullableFields>;
+}
+declare function validateAutomation$3(httpClient: HttpClient): ValidateAutomationSignature$1;
+interface ValidateAutomationSignature$1 {
+    /**
+     * Validate Automation
+     * @param - Automation to validate
+     */
+    (automation: Automation$2): Promise<ValidateAutomationResponse$1 & ValidateAutomationResponseNonNullableFields$1>;
+}
+declare function getAutomationActivationStats$1(httpClient: HttpClient): GetAutomationActivationStatsSignature;
+interface GetAutomationActivationStatsSignature {
+    /** @param - Automation ID */
+    (automationId: string, options?: GetAutomationActivationStatsOptions | undefined): Promise<GetAutomationActivationReportsResponse & GetAutomationActivationReportsResponseNonNullableFields>;
+}
+declare function getActionsQuotaInfo$1(httpClient: HttpClient): GetActionsQuotaInfoSignature;
+interface GetActionsQuotaInfoSignature {
+    /**
+     * Get actions quota information
+     */
+    (): Promise<GetActionsQuotaInfoResponse$1 & GetActionsQuotaInfoResponseNonNullableFields>;
+}
+declare function generateActionInputMappingFromTemplate$1(httpClient: HttpClient): GenerateActionInputMappingFromTemplateSignature;
+interface GenerateActionInputMappingFromTemplateSignature {
+    /**
+     * Generate action input mapping from a template
+     * @param - action app id
+     */
+    (appId: string, options: GenerateActionInputMappingFromTemplateOptions): Promise<GenerateActionInputMappingFromTemplateResponse>;
 }
-
-declare function createAutomation$3(httpClient: HttpClient): (automation: Automation$2) => Promise<Automation$2 & AutomationNonNullableFields$1>;
-declare function getAutomation$3(httpClient: HttpClient): (automationId: string, options?: GetAutomationOptions$1) => Promise<Automation$2 & AutomationNonNullableFields$1>;
-declare function updateAutomation$3(httpClient: HttpClient): (_id: string | null, automation: UpdateAutomation$1) => Promise<Automation$2 & AutomationNonNullableFields$1>;
-declare function deleteAutomation$3(httpClient: HttpClient): (automationId: string, options?: DeleteAutomationOptions) => Promise<void>;
-declare function queryAutomations$3(httpClient: HttpClient): (options?: QueryAutomationsOptions) => AutomationsQueryBuilder$1;
-declare function overrideApplicationAutomation$1(httpClient: HttpClient): (automation: Automation$2) => Promise<OverrideApplicationAutomationResponse & OverrideApplicationAutomationResponseNonNullableFields>;
-declare function validateAutomationById$1(httpClient: HttpClient): (automationId: string, options?: ValidateAutomationByIdOptions) => Promise<ValidateAutomationByIdResponse & ValidateAutomationByIdResponseNonNullableFields>;
-declare function validateAutomation$3(httpClient: HttpClient): (automation: Automation$2) => Promise<ValidateAutomationResponse$1 & ValidateAutomationResponseNonNullableFields$1>;
-declare function getAutomationActivationStats$1(httpClient: HttpClient): (automationId: string, options?: GetAutomationActivationStatsOptions) => Promise<GetAutomationActivationReportsResponse & GetAutomationActivationReportsResponseNonNullableFields>;
-declare function getActionsQuotaInfo$1(httpClient: HttpClient): () => Promise<GetActionsQuotaInfoResponse$1 & GetActionsQuotaInfoResponseNonNullableFields>;
-declare function generateActionInputMappingFromTemplate$1(httpClient: HttpClient): (appId: string, options: GenerateActionInputMappingFromTemplateOptions) => Promise<GenerateActionInputMappingFromTemplateResponse>;
 declare const onAutomationCreated$3: EventDefinition<AutomationCreatedEnvelope$1, "wix.automations.v1.automation_created">;
 declare const onAutomationUpdated$3: EventDefinition<AutomationUpdatedEnvelope$1, "wix.automations.v1.automation_updated">;
 declare const onAutomationDeleted$3: EventDefinition<AutomationDeletedEnvelope$1, "wix.automations.v1.automation_deleted">;
@@ -1684,18 +1760,23 @@ type _publicGenerateActionInputMappingFromTemplateType = typeof generateActionIn
 declare const generateActionInputMappingFromTemplate: ReturnType<typeof createRESTModule$2<_publicGenerateActionInputMappingFromTemplateType>>;
 
 type _publicOnAutomationCreatedType$1 = typeof onAutomationCreated$3;
+/** */
 declare const onAutomationCreated$2: ReturnType<typeof createEventModule$2<_publicOnAutomationCreatedType>>;
 
 type _publicOnAutomationUpdatedType$1 = typeof onAutomationUpdated$3;
+/** */
 declare const onAutomationUpdated$2: ReturnType<typeof createEventModule$2<_publicOnAutomationUpdatedType>>;
 
 type _publicOnAutomationDeletedType$1 = typeof onAutomationDeleted$3;
+/** */
 declare const onAutomationDeleted$2: ReturnType<typeof createEventModule$2<_publicOnAutomationDeletedType>>;
 
 type _publicOnAutomationUpdatedWithPreviousEntityType$1 = typeof onAutomationUpdatedWithPreviousEntity$3;
+/** */
 declare const onAutomationUpdatedWithPreviousEntity$2: ReturnType<typeof createEventModule$2<_publicOnAutomationUpdatedWithPreviousEntityType>>;
 
 type _publicOnAutomationDeletedWithEntityType$1 = typeof onAutomationDeletedWithEntity$3;
+/** */
 declare const onAutomationDeletedWithEntity$2: ReturnType<typeof createEventModule$2<_publicOnAutomationDeletedWithEntityType>>;
 
 type context$2_ActivationReport = ActivationReport;
@@ -3312,10 +3393,73 @@ interface ReportEventOptions {
     idempotency?: Idempotency;
 }
 
-declare function reportEvent$1(httpClient: HttpClient): (triggerKey: string, options?: ReportEventOptions) => Promise<ReportEventResponse & ReportEventResponseNonNullableFields>;
-declare function bulkReportEvent$1(httpClient: HttpClient): (triggerKey: string, eventsInfo: EventInfo[]) => Promise<BulkReportEventResponse & BulkReportEventResponseNonNullableFields>;
-declare function bulkCancelEvent$1(httpClient: HttpClient): (triggerKey: string, externalEntityIds: string[]) => Promise<BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields>;
-declare function cancelEvent$1(httpClient: HttpClient): (triggerKey: string, externalEntityId: string) => Promise<void>;
+declare function reportEvent$1(httpClient: HttpClient): ReportEventSignature;
+interface ReportEventSignature {
+    /**
+     * Reports an event and activates site automations with the specified trigger key.
+     *
+     *
+     * Only the app that created a trigger can report events for it.
+     * This means other apps can't report events for your triggers,
+     * and you can't report events for another app's triggers.
+     *
+     * If your app supports canceling events,
+     * `externalEntityId` must be provided.
+     * `externalEntityId` is required when calling [cancelEvent()](#cancel-event).
+     * @param - Trigger key as defined in your app's trigger configuration
+     * in the Wix Developers Center.
+     * For example, `form_submitted` or `invoice_due`.
+     */
+    (triggerKey: string, options?: ReportEventOptions | undefined): Promise<ReportEventResponse & ReportEventResponseNonNullableFields>;
+}
+declare function bulkReportEvent$1(httpClient: HttpClient): BulkReportEventSignature;
+interface BulkReportEventSignature {
+    /**
+     * Bulk reports events and activates site automations with the specified trigger key.
+     * @param - Trigger key as defined in your app's trigger configuration
+     * in the Wix Developers Center.
+     * For example, `form_submitted` or `invoice_due`.
+     * @param - Repeated list of event details for bulk reporting
+     */
+    (triggerKey: string, eventsInfo: EventInfo[]): Promise<BulkReportEventResponse & BulkReportEventResponseNonNullableFields>;
+}
+declare function bulkCancelEvent$1(httpClient: HttpClient): BulkCancelEventSignature;
+interface BulkCancelEventSignature {
+    /**
+     * Bulk cancels any remaining actions for a trigger and external entities.
+     * @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
+     */
+    (triggerKey: string, externalEntityIds: string[]): Promise<BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields>;
+}
+declare function cancelEvent$1(httpClient: HttpClient): CancelEventSignature;
+interface CancelEventSignature {
+    /**
+     * Cancels any remaining actions for a trigger and external entity.
+     *
+     *
+     * 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`,
+     * the event is canceled,
+     * as are all other events that share the `externalEntityId` and `triggerKey`.
+     * @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.
+     * For example, `fc81a355-3429-50fc-a4c7-def486e828f3`.
+     *
+     * Typically, this ID is defined in your system,
+     * but you can also use any Wix resource GUID,
+     * such as contact ID, member ID, or invoice ID.
+     * See
+     * [Choose the right `externalEntityId`](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/reporting-and-canceling-events#choose-the-right-externalentityid)
+     * for more information.
+     */
+    (triggerKey: string, externalEntityId: string): Promise<void>;
+}
 declare const onActivationStatusChanged$1: EventDefinition<ActivationStatusChangedEnvelope, "wix.automations.v2.activation_activation_status_changed">;
 
 declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
@@ -3332,6 +3476,9 @@ type _publicCancelEventType = typeof cancelEvent$1;
 declare const cancelEvent: ReturnType<typeof createRESTModule$1<_publicCancelEventType>>;
 
 type _publicOnActivationStatusChangedType = typeof onActivationStatusChanged$1;
+/**
+ * activation status changed message
+ */
 declare const onActivationStatusChanged: ReturnType<typeof createEventModule$1<_publicOnActivationStatusChangedType>>;
 
 type context$1_ActionActionOneOf = ActionActionOneOf;
@@ -4971,13 +5118,79 @@ interface ValidateAutomationOptions {
     validationSettings?: ValidationSettings;
 }
 
-declare function createAutomation$1(httpClient: HttpClient): (automation: Automation) => Promise<Automation & AutomationNonNullableFields>;
-declare function getAutomation$1(httpClient: HttpClient): (automationId: string, options?: GetAutomationOptions) => Promise<Automation & AutomationNonNullableFields>;
-declare function updateAutomation$1(httpClient: HttpClient): (_id: string | null, automation: UpdateAutomation) => Promise<Automation & AutomationNonNullableFields>;
-declare function deleteAutomation$1(httpClient: HttpClient): (automationId: string) => Promise<void>;
-declare function bulkDeleteAutomations$1(httpClient: HttpClient): (automationIds: string[]) => Promise<BulkDeleteAutomationsResponse & BulkDeleteAutomationsResponseNonNullableFields>;
-declare function queryAutomations$1(httpClient: HttpClient): () => AutomationsQueryBuilder;
-declare function validateAutomation$1(httpClient: HttpClient): (automation: Automation, options?: ValidateAutomationOptions) => Promise<ValidateAutomationResponse & ValidateAutomationResponseNonNullableFields>;
+declare function createAutomation$1(httpClient: HttpClient): CreateAutomationSignature;
+interface CreateAutomationSignature {
+    /**
+     * Creates an automation.
+     * @param - Automation to be created.
+     * @returns The created automation.
+     */
+    (automation: Automation): Promise<Automation & AutomationNonNullableFields>;
+}
+declare function getAutomation$1(httpClient: HttpClient): GetAutomationSignature;
+interface GetAutomationSignature {
+    /**
+     * Retrieves an automation.
+     * @param - Automation ID.
+     * @returns The requested automation.
+     */
+    (automationId: string, options?: GetAutomationOptions | undefined): Promise<Automation & AutomationNonNullableFields>;
+}
+declare function updateAutomation$1(httpClient: HttpClient): UpdateAutomationSignature;
+interface UpdateAutomationSignature {
+    /**
+     * Updates an automation.
+     *
+     * Each time the automation is updated,
+     * `revision` increments by 1.
+     * The current `revision` must be passed when updating the automation.
+     * This ensures you're working with the latest automation
+     * and prevents unintended overwrites.
+     * @param - Automation ID.
+     * @returns Updated automation.
+     */
+    (_id: string | null, automation: UpdateAutomation): Promise<Automation & AutomationNonNullableFields>;
+}
+declare function deleteAutomation$1(httpClient: HttpClient): DeleteAutomationSignature;
+interface DeleteAutomationSignature {
+    /**
+     * Deletes an Automation.
+     * @param - Automation ID.
+     */
+    (automationId: string): Promise<void>;
+}
+declare function bulkDeleteAutomations$1(httpClient: HttpClient): BulkDeleteAutomationsSignature;
+interface BulkDeleteAutomationsSignature {
+    /**
+     * Deletes multiple automations.
+     * @param - Automation IDs to delete.
+     */
+    (automationIds: string[]): Promise<BulkDeleteAutomationsResponse & BulkDeleteAutomationsResponseNonNullableFields>;
+}
+declare function queryAutomations$1(httpClient: HttpClient): QueryAutomationsSignature;
+interface QueryAutomationsSignature {
+    /**
+     * Retrieves a list of automations. Max query filter depth is 3.
+     *
+     * Relevant automations for the query are returned. This includes automations created on the site and pre-installed automations.
+     * If there's an existing override for a pre-installed automation, the override is returned in the query result.
+     * The query only returns automations from apps that are installed on the site.
+     *
+     * To learn about working with _Query_ endpoints, see
+     * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
+     * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
+     * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
+     */
+    (): AutomationsQueryBuilder;
+}
+declare function validateAutomation$1(httpClient: HttpClient): ValidateAutomationSignature;
+interface ValidateAutomationSignature {
+    /**
+     * Validates the automation without requiring the automation ID to be passed in.
+     * @param - Automation to validate.
+     */
+    (automation: Automation, options?: ValidateAutomationOptions | undefined): Promise<ValidateAutomationResponse & ValidateAutomationResponseNonNullableFields>;
+}
 declare const onAutomationCreated$1: EventDefinition<AutomationCreatedEnvelope, "wix.automations.v2.automation_created">;
 declare const onAutomationUpdated$1: EventDefinition<AutomationUpdatedEnvelope, "wix.automations.v2.automation_updated">;
 declare const onAutomationDeleted$1: EventDefinition<AutomationDeletedEnvelope, "wix.automations.v2.automation_deleted">;
@@ -5004,18 +5217,23 @@ type _publicValidateAutomationType = typeof validateAutomation$1;
 declare const validateAutomation: ReturnType<typeof createRESTModule<_publicValidateAutomationType>>;
 
 type _publicOnAutomationCreatedType = typeof onAutomationCreated$1;
+/** */
 declare const onAutomationCreated: ReturnType<typeof createEventModule<_publicOnAutomationCreatedType>>;
 
 type _publicOnAutomationUpdatedType = typeof onAutomationUpdated$1;
+/** */
 declare const onAutomationUpdated: ReturnType<typeof createEventModule<_publicOnAutomationUpdatedType>>;
 
 type _publicOnAutomationDeletedType = typeof onAutomationDeleted$1;
+/** */
 declare const onAutomationDeleted: ReturnType<typeof createEventModule<_publicOnAutomationDeletedType>>;
 
 type _publicOnAutomationUpdatedWithPreviousEntityType = typeof onAutomationUpdatedWithPreviousEntity$1;
+/** */
 declare const onAutomationUpdatedWithPreviousEntity: ReturnType<typeof createEventModule<_publicOnAutomationUpdatedWithPreviousEntityType>>;
 
 type _publicOnAutomationDeletedWithEntityType = typeof onAutomationDeletedWithEntity$1;
+/** */
 declare const onAutomationDeletedWithEntity: ReturnType<typeof createEventModule<_publicOnAutomationDeletedWithEntityType>>;
 
 type context_Action = Action;

package/type-bundles/index.bundle.d.ts

@@ -1,3 +1,47 @@
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
 /** Automation */
 interface Automation$2 {
     /**
@@ -1595,61 +1639,93 @@ interface GenerateActionInputMappingFromTemplateOptions {
     actionInputMappingTemplate: Record<string, any> | null;
 }
 
-type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: typeof fetch;
-    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+declare function createAutomation$3(httpClient: HttpClient): CreateAutomationSignature$1;
+interface CreateAutomationSignature$1 {
+    /**
+     * Creates a new Automation
+     * @param - Automation to be created
+     * @returns The created Automation
+     */
+    (automation: Automation$2): Promise<Automation$2 & AutomationNonNullableFields$1>;
 }
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-type EventDefinition<Payload = unknown, Type extends string = string> = {
-    __type: 'event-definition';
-    type: Type;
-    isDomainEvent?: boolean;
-    transformations?: (envelope: unknown) => Payload;
-    __payload: Payload;
-};
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
-type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
-type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function getAutomation$3(httpClient: HttpClient): GetAutomationSignature$1;
+interface GetAutomationSignature$1 {
+    /**
+     * Get a Automation by id
+     * @param - Automation ID
+     * @returns Automation
+     */
+    (automationId: string, options?: GetAutomationOptions$1 | undefined): Promise<Automation$2 & AutomationNonNullableFields$1>;
+}
+declare function updateAutomation$3(httpClient: HttpClient): UpdateAutomationSignature$1;
+interface UpdateAutomationSignature$1 {
+    /**
+     * Update a Automation, supports partial update
+     * Pass the latest `revision` for a successful update
+     * @param - Automation ID
+     * @returns The updated Automation
+     */
+    (_id: string | null, automation: UpdateAutomation$1): Promise<Automation$2 & AutomationNonNullableFields$1>;
+}
+declare function deleteAutomation$3(httpClient: HttpClient): DeleteAutomationSignature$1;
+interface DeleteAutomationSignature$1 {
+    /**
+     * Delete an Automation
+     * @param - Id of the Automation to delete
+     */
+    (automationId: string, options?: DeleteAutomationOptions | undefined): Promise<void>;
+}
+declare function queryAutomations$3(httpClient: HttpClient): QueryAutomationsSignature$1;
+interface QueryAutomationsSignature$1 {
+    /**
+     * Query Automations using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+     */
+    (options?: QueryAutomationsOptions | undefined): AutomationsQueryBuilder$1;
+}
+declare function overrideApplicationAutomation$1(httpClient: HttpClient): OverrideApplicationAutomationSignature;
+interface OverrideApplicationAutomationSignature {
+    /**
+     * Creates a new Automation
+     * @param - Application Automation
+     */
+    (automation: Automation$2): Promise<OverrideApplicationAutomationResponse & OverrideApplicationAutomationResponseNonNullableFields>;
+}
+declare function validateAutomationById$1(httpClient: HttpClient): ValidateAutomationByIdSignature;
+interface ValidateAutomationByIdSignature {
+    /**
+     * Validate Automation by Id
+     * @param - Automation ID
+     */
+    (automationId: string, options?: ValidateAutomationByIdOptions | undefined): Promise<ValidateAutomationByIdResponse & ValidateAutomationByIdResponseNonNullableFields>;
+}
+declare function validateAutomation$3(httpClient: HttpClient): ValidateAutomationSignature$1;
+interface ValidateAutomationSignature$1 {
+    /**
+     * Validate Automation
+     * @param - Automation to validate
+     */
+    (automation: Automation$2): Promise<ValidateAutomationResponse$1 & ValidateAutomationResponseNonNullableFields$1>;
+}
+declare function getAutomationActivationStats$1(httpClient: HttpClient): GetAutomationActivationStatsSignature;
+interface GetAutomationActivationStatsSignature {
+    /** @param - Automation ID */
+    (automationId: string, options?: GetAutomationActivationStatsOptions | undefined): Promise<GetAutomationActivationReportsResponse & GetAutomationActivationReportsResponseNonNullableFields>;
+}
+declare function getActionsQuotaInfo$1(httpClient: HttpClient): GetActionsQuotaInfoSignature;
+interface GetActionsQuotaInfoSignature {
+    /**
+     * Get actions quota information
+     */
+    (): Promise<GetActionsQuotaInfoResponse$1 & GetActionsQuotaInfoResponseNonNullableFields>;
+}
+declare function generateActionInputMappingFromTemplate$1(httpClient: HttpClient): GenerateActionInputMappingFromTemplateSignature;
+interface GenerateActionInputMappingFromTemplateSignature {
+    /**
+     * Generate action input mapping from a template
+     * @param - action app id
+     */
+    (appId: string, options: GenerateActionInputMappingFromTemplateOptions): Promise<GenerateActionInputMappingFromTemplateResponse>;
 }
-
-declare function createAutomation$3(httpClient: HttpClient): (automation: Automation$2) => Promise<Automation$2 & AutomationNonNullableFields$1>;
-declare function getAutomation$3(httpClient: HttpClient): (automationId: string, options?: GetAutomationOptions$1) => Promise<Automation$2 & AutomationNonNullableFields$1>;
-declare function updateAutomation$3(httpClient: HttpClient): (_id: string | null, automation: UpdateAutomation$1) => Promise<Automation$2 & AutomationNonNullableFields$1>;
-declare function deleteAutomation$3(httpClient: HttpClient): (automationId: string, options?: DeleteAutomationOptions) => Promise<void>;
-declare function queryAutomations$3(httpClient: HttpClient): (options?: QueryAutomationsOptions) => AutomationsQueryBuilder$1;
-declare function overrideApplicationAutomation$1(httpClient: HttpClient): (automation: Automation$2) => Promise<OverrideApplicationAutomationResponse & OverrideApplicationAutomationResponseNonNullableFields>;
-declare function validateAutomationById$1(httpClient: HttpClient): (automationId: string, options?: ValidateAutomationByIdOptions) => Promise<ValidateAutomationByIdResponse & ValidateAutomationByIdResponseNonNullableFields>;
-declare function validateAutomation$3(httpClient: HttpClient): (automation: Automation$2) => Promise<ValidateAutomationResponse$1 & ValidateAutomationResponseNonNullableFields$1>;
-declare function getAutomationActivationStats$1(httpClient: HttpClient): (automationId: string, options?: GetAutomationActivationStatsOptions) => Promise<GetAutomationActivationReportsResponse & GetAutomationActivationReportsResponseNonNullableFields>;
-declare function getActionsQuotaInfo$1(httpClient: HttpClient): () => Promise<GetActionsQuotaInfoResponse$1 & GetActionsQuotaInfoResponseNonNullableFields>;
-declare function generateActionInputMappingFromTemplate$1(httpClient: HttpClient): (appId: string, options: GenerateActionInputMappingFromTemplateOptions) => Promise<GenerateActionInputMappingFromTemplateResponse>;
 declare const onAutomationCreated$3: EventDefinition<AutomationCreatedEnvelope$1, "wix.automations.v1.automation_created">;
 declare const onAutomationUpdated$3: EventDefinition<AutomationUpdatedEnvelope$1, "wix.automations.v1.automation_updated">;
 declare const onAutomationDeleted$3: EventDefinition<AutomationDeletedEnvelope$1, "wix.automations.v1.automation_deleted">;
@@ -1684,18 +1760,23 @@ type _publicGenerateActionInputMappingFromTemplateType = typeof generateActionIn
 declare const generateActionInputMappingFromTemplate: ReturnType<typeof createRESTModule$2<_publicGenerateActionInputMappingFromTemplateType>>;
 
 type _publicOnAutomationCreatedType$1 = typeof onAutomationCreated$3;
+/** */
 declare const onAutomationCreated$2: ReturnType<typeof createEventModule$2<_publicOnAutomationCreatedType>>;
 
 type _publicOnAutomationUpdatedType$1 = typeof onAutomationUpdated$3;
+/** */
 declare const onAutomationUpdated$2: ReturnType<typeof createEventModule$2<_publicOnAutomationUpdatedType>>;
 
 type _publicOnAutomationDeletedType$1 = typeof onAutomationDeleted$3;
+/** */
 declare const onAutomationDeleted$2: ReturnType<typeof createEventModule$2<_publicOnAutomationDeletedType>>;
 
 type _publicOnAutomationUpdatedWithPreviousEntityType$1 = typeof onAutomationUpdatedWithPreviousEntity$3;
+/** */
 declare const onAutomationUpdatedWithPreviousEntity$2: ReturnType<typeof createEventModule$2<_publicOnAutomationUpdatedWithPreviousEntityType>>;
 
 type _publicOnAutomationDeletedWithEntityType$1 = typeof onAutomationDeletedWithEntity$3;
+/** */
 declare const onAutomationDeletedWithEntity$2: ReturnType<typeof createEventModule$2<_publicOnAutomationDeletedWithEntityType>>;
 
 type index_d$2_ActivationReport = ActivationReport;
@@ -3312,10 +3393,73 @@ interface ReportEventOptions {
     idempotency?: Idempotency;
 }
 
-declare function reportEvent$1(httpClient: HttpClient): (triggerKey: string, options?: ReportEventOptions) => Promise<ReportEventResponse & ReportEventResponseNonNullableFields>;
-declare function bulkReportEvent$1(httpClient: HttpClient): (triggerKey: string, eventsInfo: EventInfo[]) => Promise<BulkReportEventResponse & BulkReportEventResponseNonNullableFields>;
-declare function bulkCancelEvent$1(httpClient: HttpClient): (triggerKey: string, externalEntityIds: string[]) => Promise<BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields>;
-declare function cancelEvent$1(httpClient: HttpClient): (triggerKey: string, externalEntityId: string) => Promise<void>;
+declare function reportEvent$1(httpClient: HttpClient): ReportEventSignature;
+interface ReportEventSignature {
+    /**
+     * Reports an event and activates site automations with the specified trigger key.
+     *
+     *
+     * Only the app that created a trigger can report events for it.
+     * This means other apps can't report events for your triggers,
+     * and you can't report events for another app's triggers.
+     *
+     * If your app supports canceling events,
+     * `externalEntityId` must be provided.
+     * `externalEntityId` is required when calling [cancelEvent()](#cancel-event).
+     * @param - Trigger key as defined in your app's trigger configuration
+     * in the Wix Developers Center.
+     * For example, `form_submitted` or `invoice_due`.
+     */
+    (triggerKey: string, options?: ReportEventOptions | undefined): Promise<ReportEventResponse & ReportEventResponseNonNullableFields>;
+}
+declare function bulkReportEvent$1(httpClient: HttpClient): BulkReportEventSignature;
+interface BulkReportEventSignature {
+    /**
+     * Bulk reports events and activates site automations with the specified trigger key.
+     * @param - Trigger key as defined in your app's trigger configuration
+     * in the Wix Developers Center.
+     * For example, `form_submitted` or `invoice_due`.
+     * @param - Repeated list of event details for bulk reporting
+     */
+    (triggerKey: string, eventsInfo: EventInfo[]): Promise<BulkReportEventResponse & BulkReportEventResponseNonNullableFields>;
+}
+declare function bulkCancelEvent$1(httpClient: HttpClient): BulkCancelEventSignature;
+interface BulkCancelEventSignature {
+    /**
+     * Bulk cancels any remaining actions for a trigger and external entities.
+     * @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
+     */
+    (triggerKey: string, externalEntityIds: string[]): Promise<BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields>;
+}
+declare function cancelEvent$1(httpClient: HttpClient): CancelEventSignature;
+interface CancelEventSignature {
+    /**
+     * Cancels any remaining actions for a trigger and external entity.
+     *
+     *
+     * 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`,
+     * the event is canceled,
+     * as are all other events that share the `externalEntityId` and `triggerKey`.
+     * @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.
+     * For example, `fc81a355-3429-50fc-a4c7-def486e828f3`.
+     *
+     * Typically, this ID is defined in your system,
+     * but you can also use any Wix resource GUID,
+     * such as contact ID, member ID, or invoice ID.
+     * See
+     * [Choose the right `externalEntityId`](https://dev.wix.com/docs/rest/business-management/automations/triggered-events/reporting-and-canceling-events#choose-the-right-externalentityid)
+     * for more information.
+     */
+    (triggerKey: string, externalEntityId: string): Promise<void>;
+}
 declare const onActivationStatusChanged$1: EventDefinition<ActivationStatusChangedEnvelope, "wix.automations.v2.activation_activation_status_changed">;
 
 declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
@@ -3332,6 +3476,9 @@ type _publicCancelEventType = typeof cancelEvent$1;
 declare const cancelEvent: ReturnType<typeof createRESTModule$1<_publicCancelEventType>>;
 
 type _publicOnActivationStatusChangedType = typeof onActivationStatusChanged$1;
+/**
+ * activation status changed message
+ */
 declare const onActivationStatusChanged: ReturnType<typeof createEventModule$1<_publicOnActivationStatusChangedType>>;
 
 type index_d$1_ActionActionOneOf = ActionActionOneOf;
@@ -4971,13 +5118,79 @@ interface ValidateAutomationOptions {
     validationSettings?: ValidationSettings;
 }
 
-declare function createAutomation$1(httpClient: HttpClient): (automation: Automation) => Promise<Automation & AutomationNonNullableFields>;
-declare function getAutomation$1(httpClient: HttpClient): (automationId: string, options?: GetAutomationOptions) => Promise<Automation & AutomationNonNullableFields>;
-declare function updateAutomation$1(httpClient: HttpClient): (_id: string | null, automation: UpdateAutomation) => Promise<Automation & AutomationNonNullableFields>;
-declare function deleteAutomation$1(httpClient: HttpClient): (automationId: string) => Promise<void>;
-declare function bulkDeleteAutomations$1(httpClient: HttpClient): (automationIds: string[]) => Promise<BulkDeleteAutomationsResponse & BulkDeleteAutomationsResponseNonNullableFields>;
-declare function queryAutomations$1(httpClient: HttpClient): () => AutomationsQueryBuilder;
-declare function validateAutomation$1(httpClient: HttpClient): (automation: Automation, options?: ValidateAutomationOptions) => Promise<ValidateAutomationResponse & ValidateAutomationResponseNonNullableFields>;
+declare function createAutomation$1(httpClient: HttpClient): CreateAutomationSignature;
+interface CreateAutomationSignature {
+    /**
+     * Creates an automation.
+     * @param - Automation to be created.
+     * @returns The created automation.
+     */
+    (automation: Automation): Promise<Automation & AutomationNonNullableFields>;
+}
+declare function getAutomation$1(httpClient: HttpClient): GetAutomationSignature;
+interface GetAutomationSignature {
+    /**
+     * Retrieves an automation.
+     * @param - Automation ID.
+     * @returns The requested automation.
+     */
+    (automationId: string, options?: GetAutomationOptions | undefined): Promise<Automation & AutomationNonNullableFields>;
+}
+declare function updateAutomation$1(httpClient: HttpClient): UpdateAutomationSignature;
+interface UpdateAutomationSignature {
+    /**
+     * Updates an automation.
+     *
+     * Each time the automation is updated,
+     * `revision` increments by 1.
+     * The current `revision` must be passed when updating the automation.
+     * This ensures you're working with the latest automation
+     * and prevents unintended overwrites.
+     * @param - Automation ID.
+     * @returns Updated automation.
+     */
+    (_id: string | null, automation: UpdateAutomation): Promise<Automation & AutomationNonNullableFields>;
+}
+declare function deleteAutomation$1(httpClient: HttpClient): DeleteAutomationSignature;
+interface DeleteAutomationSignature {
+    /**
+     * Deletes an Automation.
+     * @param - Automation ID.
+     */
+    (automationId: string): Promise<void>;
+}
+declare function bulkDeleteAutomations$1(httpClient: HttpClient): BulkDeleteAutomationsSignature;
+interface BulkDeleteAutomationsSignature {
+    /**
+     * Deletes multiple automations.
+     * @param - Automation IDs to delete.
+     */
+    (automationIds: string[]): Promise<BulkDeleteAutomationsResponse & BulkDeleteAutomationsResponseNonNullableFields>;
+}
+declare function queryAutomations$1(httpClient: HttpClient): QueryAutomationsSignature;
+interface QueryAutomationsSignature {
+    /**
+     * Retrieves a list of automations. Max query filter depth is 3.
+     *
+     * Relevant automations for the query are returned. This includes automations created on the site and pre-installed automations.
+     * If there's an existing override for a pre-installed automation, the override is returned in the query result.
+     * The query only returns automations from apps that are installed on the site.
+     *
+     * To learn about working with _Query_ endpoints, see
+     * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
+     * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
+     * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
+     */
+    (): AutomationsQueryBuilder;
+}
+declare function validateAutomation$1(httpClient: HttpClient): ValidateAutomationSignature;
+interface ValidateAutomationSignature {
+    /**
+     * Validates the automation without requiring the automation ID to be passed in.
+     * @param - Automation to validate.
+     */
+    (automation: Automation, options?: ValidateAutomationOptions | undefined): Promise<ValidateAutomationResponse & ValidateAutomationResponseNonNullableFields>;
+}
 declare const onAutomationCreated$1: EventDefinition<AutomationCreatedEnvelope, "wix.automations.v2.automation_created">;
 declare const onAutomationUpdated$1: EventDefinition<AutomationUpdatedEnvelope, "wix.automations.v2.automation_updated">;
 declare const onAutomationDeleted$1: EventDefinition<AutomationDeletedEnvelope, "wix.automations.v2.automation_deleted">;
@@ -5004,18 +5217,23 @@ type _publicValidateAutomationType = typeof validateAutomation$1;
 declare const validateAutomation: ReturnType<typeof createRESTModule<_publicValidateAutomationType>>;
 
 type _publicOnAutomationCreatedType = typeof onAutomationCreated$1;
+/** */
 declare const onAutomationCreated: ReturnType<typeof createEventModule<_publicOnAutomationCreatedType>>;
 
 type _publicOnAutomationUpdatedType = typeof onAutomationUpdated$1;
+/** */
 declare const onAutomationUpdated: ReturnType<typeof createEventModule<_publicOnAutomationUpdatedType>>;
 
 type _publicOnAutomationDeletedType = typeof onAutomationDeleted$1;
+/** */
 declare const onAutomationDeleted: ReturnType<typeof createEventModule<_publicOnAutomationDeletedType>>;
 
 type _publicOnAutomationUpdatedWithPreviousEntityType = typeof onAutomationUpdatedWithPreviousEntity$1;
+/** */
 declare const onAutomationUpdatedWithPreviousEntity: ReturnType<typeof createEventModule<_publicOnAutomationUpdatedWithPreviousEntityType>>;
 
 type _publicOnAutomationDeletedWithEntityType = typeof onAutomationDeletedWithEntity$1;
+/** */
 declare const onAutomationDeletedWithEntity: ReturnType<typeof createEventModule<_publicOnAutomationDeletedWithEntityType>>;
 
 type index_d_Action = Action;