@wix/automations 1.0.0

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

@@ -0,0 +1,445 @@
+interface ReportEventRequest$1 {
+    /**
+     * Trigger key as defined in your app's trigger configuration
+     * in the Wix Developers Center.
+     * For example, `form_submitted` or `invoice_due`.
+     */
+    triggerKey: string;
+    /**
+     * Event payload, formatted as key:value pairs.
+     * Must comply with the payload schema
+     * if you provided one when configuring your trigger.
+     *
+     * Key names can include only alphanumeric characters or underscores
+     * (`A-Z`, `a-z`, `0-9`, `_`).
+     * They cannot start with an underscore.
+     *
+     * Values can be strings, numbers, integers, booleans, or arrays.
+     * If a value is an array, the array items must be objects,
+     * and nested object properties must be
+     * strings, numbers, integers, or booleans only.
+     */
+    payload?: Record<string, any> | null;
+    /**
+     * ID of the related resource in GUID format.
+     * For example, `fc81a355-3429-50fc-a4c7-def486e828f3`.
+     *
+     * Required if your app needs to
+     * [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,
+     * 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#about-canceling-events)
+     * for more information.
+     */
+    externalEntityId?: string | null;
+    /** Idempotency information for the event */
+    idempotency?: Idempotency$1;
+}
+interface Idempotency$1 {
+    /**
+     * A unique identifier for the event.
+     * If you send the same idempotency key in multiple report event requests, for the same trigger key and app id,
+     * consecutive requests will be ignored after the first one. Note that the idempotency key is kept for a week before it expires.
+     */
+    key?: string;
+    /** Optional. The time to live (TTL) in milliseconds before the key will expire. Default is a week. */
+    ttlInMilliseconds?: string | null;
+}
+interface ReportEventResponse$1 {
+    /** The activation IDs of triggered ReportEvents. */
+    activationIds?: string[];
+}
+interface BulkReportEventRequest$1 {
+    /**
+     * Trigger key as defined in your app's trigger configuration
+     * in the Wix Developers Center.
+     * For example, `form_submitted` or `invoice_due`.
+     */
+    triggerKey: string;
+    /** Repeated list of event details for bulk reporting */
+    eventsInfo: EventInfo$1[];
+}
+interface EventInfo$1 {
+    /**
+     * Event payload, formatted as key:value pairs.
+     * Must comply with the payload schema
+     * if you provided one when configuring your trigger.
+     */
+    payload?: Record<string, any> | null;
+    /** ID of the related resource in GUID format. */
+    externalEntityId?: string | null;
+    /** Idempotency information for the event */
+    idempotency?: Idempotency$1;
+}
+interface BulkReportEventResponse$1 {
+    /** Trigger key associated with the event */
+    triggerKey?: string;
+    /** List of results for each item in the bulk report event request */
+    results?: BulkReportEventResult$1[];
+    /** Metadata for the overall bulk action, including success and failure counts */
+    bulkActionMetadata?: BulkActionMetadata$1;
+}
+interface BulkReportEventResult$1 {
+    /** Metadata for the individual item in the request */
+    itemMetadata?: ItemMetadata$1;
+    /** Event details for the item in the request */
+    eventInfo?: EventInfo$1;
+    /** The activation IDs of triggered ReportEvents. */
+    activationIds?: string[];
+}
+interface ItemMetadata$1 {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError$1;
+}
+interface ApplicationError$1 {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkActionMetadata$1 {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface BulkCancelEventRequest$1 {
+    /**
+     * Trigger key whose events you want to cancel.
+     * For example, `form_submitted` or `invoice_due`.
+     */
+    triggerKey: string;
+    /** Repeated list of external_entity_id, representing the related resources' IDs */
+    externalEntityIds: string[];
+}
+interface BulkCancelEventResponse$1 {
+    /** Trigger key related to the cancelled event */
+    triggerKey?: string;
+    /** List of results for each item in the bulk cancel event request */
+    results?: BulkCancelEventResult$1[];
+    /** Metadata for the overall bulk action, including success and failure counts */
+    bulkActionMetadata?: BulkActionMetadata$1;
+}
+interface BulkCancelEventResult$1 {
+    /** Metadata of the item, including its ID and success or failure status */
+    itemMetadata?: ItemMetadata$1;
+    /** ID of the related resource in GUID format */
+    externalEntityId?: string;
+}
+interface CancelEventRequest$1 {
+    /**
+     * 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.
+     */
+    externalEntityId: string;
+    /**
+     * Trigger key whose event you want to cancel.
+     * For example, `form_submitted` or `invoice_due`.
+     */
+    triggerKey: string;
+}
+interface CancelEventResponse$1 {
+}
+interface ReportEventResponseNonNullableFields$1 {
+    activationIds: string[];
+}
+interface BulkReportEventResponseNonNullableFields$1 {
+    triggerKey: string;
+    results: {
+        itemMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        eventInfo?: {
+            idempotency?: {
+                key: string;
+            };
+        };
+        activationIds: string[];
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+        undetailedFailures: number;
+    };
+}
+interface BulkCancelEventResponseNonNullableFields$1 {
+    triggerKey: string;
+    results: {
+        itemMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        externalEntityId: string;
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+        undetailedFailures: number;
+    };
+}
+
+interface ReportEventRequest {
+    /**
+     * Trigger key as defined in your app's trigger configuration
+     * in the Wix Developers Center.
+     * For example, `form_submitted` or `invoice_due`.
+     */
+    triggerKey: string;
+    /**
+     * Event payload, formatted as key:value pairs.
+     * Must comply with the payload schema
+     * if you provided one when configuring your trigger.
+     *
+     * Key names can include only alphanumeric characters or underscores
+     * (`A-Z`, `a-z`, `0-9`, `_`).
+     * They cannot start with an underscore.
+     *
+     * Values can be strings, numbers, integers, booleans, or arrays.
+     * If a value is an array, the array items must be objects,
+     * and nested object properties must be
+     * strings, numbers, integers, or booleans only.
+     */
+    payload?: Record<string, any> | null;
+    /**
+     * ID of the related resource in GUID format.
+     * For example, `fc81a355-3429-50fc-a4c7-def486e828f3`.
+     *
+     * Required if your app needs to
+     * [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,
+     * 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#about-canceling-events)
+     * for more information.
+     */
+    externalEntityId?: string | null;
+    /** Idempotency information for the event */
+    idempotency?: Idempotency;
+}
+interface Idempotency {
+    /**
+     * A unique identifier for the event.
+     * If you send the same idempotency key in multiple report event requests, for the same trigger key and app id,
+     * consecutive requests will be ignored after the first one. Note that the idempotency key is kept for a week before it expires.
+     */
+    key?: string;
+    /** Optional. The time to live (TTL) in milliseconds before the key will expire. Default is a week. */
+    ttlInMilliseconds?: string | null;
+}
+interface ReportEventResponse {
+    /** The activation IDs of triggered ReportEvents. */
+    activationIds?: string[];
+}
+interface BulkReportEventRequest {
+    /**
+     * Trigger key as defined in your app's trigger configuration
+     * in the Wix Developers Center.
+     * For example, `form_submitted` or `invoice_due`.
+     */
+    triggerKey: string;
+    /** Repeated list of event details for bulk reporting */
+    eventsInfo: EventInfo[];
+}
+interface EventInfo {
+    /**
+     * Event payload, formatted as key:value pairs.
+     * Must comply with the payload schema
+     * if you provided one when configuring your trigger.
+     */
+    payload?: Record<string, any> | null;
+    /** ID of the related resource in GUID format. */
+    externalEntityId?: string | null;
+    /** Idempotency information for the event */
+    idempotency?: Idempotency;
+}
+interface BulkReportEventResponse {
+    /** Trigger key associated with the event */
+    triggerKey?: string;
+    /** List of results for each item in the bulk report event request */
+    results?: BulkReportEventResult[];
+    /** Metadata for the overall bulk action, including success and failure counts */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkReportEventResult {
+    /** Metadata for the individual item in the request */
+    itemMetadata?: ItemMetadata;
+    /** Event details for the item in the request */
+    eventInfo?: EventInfo;
+    /** The activation IDs of triggered ReportEvents. */
+    activationIds?: string[];
+}
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface BulkCancelEventRequest {
+    /**
+     * Trigger key whose events you want to cancel.
+     * For example, `form_submitted` or `invoice_due`.
+     */
+    triggerKey: string;
+    /** Repeated list of external_entity_id, representing the related resources' IDs */
+    externalEntityIds: string[];
+}
+interface BulkCancelEventResponse {
+    /** Trigger key related to the cancelled event */
+    triggerKey?: string;
+    /** List of results for each item in the bulk cancel event request */
+    results?: BulkCancelEventResult[];
+    /** Metadata for the overall bulk action, including success and failure counts */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkCancelEventResult {
+    /** Metadata of the item, including its ID and success or failure status */
+    itemMetadata?: ItemMetadata;
+    /** ID of the related resource in GUID format */
+    externalEntityId?: string;
+}
+interface CancelEventRequest {
+    /**
+     * 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.
+     */
+    externalEntityId: string;
+    /**
+     * Trigger key whose event you want to cancel.
+     * For example, `form_submitted` or `invoice_due`.
+     */
+    triggerKey: string;
+}
+interface CancelEventResponse {
+}
+interface ReportEventResponseNonNullableFields {
+    activationIds: string[];
+}
+interface BulkReportEventResponseNonNullableFields {
+    triggerKey: string;
+    results: {
+        itemMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        eventInfo?: {
+            idempotency?: {
+                key: string;
+            };
+        };
+        activationIds: string[];
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+        undetailedFailures: number;
+    };
+}
+interface BulkCancelEventResponseNonNullableFields {
+    triggerKey: string;
+    results: {
+        itemMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        externalEntityId: string;
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+        undetailedFailures: number;
+    };
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function reportEvent(): __PublicMethodMetaInfo<'POST', {}, ReportEventRequest, ReportEventRequest$1, ReportEventResponse & ReportEventResponseNonNullableFields, ReportEventResponse$1 & ReportEventResponseNonNullableFields$1>;
+declare function bulkReportEvent(): __PublicMethodMetaInfo<'POST', {}, BulkReportEventRequest, BulkReportEventRequest$1, BulkReportEventResponse & BulkReportEventResponseNonNullableFields, BulkReportEventResponse$1 & BulkReportEventResponseNonNullableFields$1>;
+declare function bulkCancelEvent(): __PublicMethodMetaInfo<'POST', {}, BulkCancelEventRequest, BulkCancelEventRequest$1, BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields, BulkCancelEventResponse$1 & BulkCancelEventResponseNonNullableFields$1>;
+declare function cancelEvent(): __PublicMethodMetaInfo<'POST', {}, CancelEventRequest, CancelEventRequest$1, CancelEventResponse, CancelEventResponse$1>;
+
+type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
+declare const meta_bulkCancelEvent: typeof bulkCancelEvent;
+declare const meta_bulkReportEvent: typeof bulkReportEvent;
+declare const meta_cancelEvent: typeof cancelEvent;
+declare const meta_reportEvent: typeof reportEvent;
+declare namespace meta {
+  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_bulkCancelEvent as bulkCancelEvent, meta_bulkReportEvent as bulkReportEvent, meta_cancelEvent as cancelEvent, meta_reportEvent as reportEvent };
+}
+
+export { meta as activations };