@wix/auto_sdk_ecom_order-payment-requests 1.0.59 → 1.0.60

package/build/internal/cjs/index.typings.d.ts

@@ -14,7 +14,7 @@ interface OrderPaymentRequest {
      */
     source?: Source;
     /**
-     * status.
+     * Payment request status. Set by the system. A new order payment request starts as `UNPAID`, unless `expirationDate` is already in the past at creation time, in which case it is created as `EXPIRED`. The system sets the status to `PAID` once payment is collected, `EXPIRED` when the expiration date passes, or `VOIDED` when the request is voided.
      * @readonly
      */
     status?: StatusWithLiterals;
@@ -31,8 +31,7 @@ interface OrderPaymentRequest {
      */
     orderNumber?: string | null;
     /**
-     * Amount to collect.
-     * > **Note:** The amount can only be set once.
+     * Amount to collect. Set when the order payment request is created and can't be changed afterward.
      * @immutable
      */
     amount?: Price;
@@ -572,7 +571,7 @@ type UpdateOrderPaymentRequestApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 } | {
-    code?: 'CANNOT_UPDATE_SUBSCRIPTION_ORDER_PAYMENT_REQUEST_PRICE';
+    code?: 'CANNOT_UPDATE_ORDER_PAYMENT_REQUEST_AMOUNT';
     description?: string;
     data?: Record<string, any>;
 };
@@ -606,6 +605,187 @@ type VoidOrderPaymentRequestApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+    accountInfo?: AccountInfoMetadata;
+}
+interface AccountInfoMetadata {
+    /** ID of the Wix account associated with the event */
+    accountId: string;
+    /** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
+    siteId?: string;
+    /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
+    parentAccountId?: string;
+}
+interface OrderPaymentRequestCreatedEnvelope {
+    entity: OrderPaymentRequest;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when an order payment request is created.
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ
+ * @webhook
+ * @eventType wix.ecom.v1.order_payment_request_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onOrderPaymentRequestCreated(handler: (event: OrderPaymentRequestCreatedEnvelope) => void | Promise<void>): void;
+interface OrderPaymentRequestDeletedEnvelope {
+    entity: OrderPaymentRequest;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when an order payment request is deleted.
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ
+ * @webhook
+ * @eventType wix.ecom.v1.order_payment_request_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onOrderPaymentRequestDeleted(handler: (event: OrderPaymentRequestDeletedEnvelope) => void | Promise<void>): void;
+interface OrderPaymentRequestExpiredEnvelope {
+    data: OrderPaymentRequestExpired;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when an order payment request status is updated to `"EXPIRED"`.
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ
+ * @webhook
+ * @eventType wix.ecom.v1.order_payment_request_expired
+ * @slug expired
+ * @documentationMaturity preview
+ */
+declare function onOrderPaymentRequestExpired(handler: (event: OrderPaymentRequestExpiredEnvelope) => void | Promise<void>): void;
+interface OrderPaymentRequestPaidEnvelope {
+    data: OrderPaymentRequestPaid;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when an order payment request status is updated to `"PAID"`.
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ
+ * @webhook
+ * @eventType wix.ecom.v1.order_payment_request_paid
+ * @slug paid
+ * @documentationMaturity preview
+ */
+declare function onOrderPaymentRequestPaid(handler: (event: OrderPaymentRequestPaidEnvelope) => void | Promise<void>): void;
+interface OrderPaymentRequestUpdatedEnvelope {
+    entity: OrderPaymentRequest;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when an order payment request is updated.
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ
+ * @webhook
+ * @eventType wix.ecom.v1.order_payment_request_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onOrderPaymentRequestUpdated(handler: (event: OrderPaymentRequestUpdatedEnvelope) => void | Promise<void>): void;
+interface OrderPaymentRequestVoidedEnvelope {
+    data: OrderPaymentRequestVoided;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when an order payment request status is updated to `"VOIDED"`.
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ
+ * @webhook
+ * @eventType wix.ecom.v1.order_payment_request_voided
+ * @slug voided
+ * @documentationMaturity preview
+ */
+declare function onOrderPaymentRequestVoided(handler: (event: OrderPaymentRequestVoidedEnvelope) => void | Promise<void>): void;
 /**
  * Creates a order payment request.
  * @public
@@ -640,9 +820,9 @@ declare function getOrderPaymentRequest(orderPaymentRequestId: string): Promise<
     __applicationErrorsType?: GetOrderPaymentRequestApplicationErrors;
 }>;
 /**
- * Updates a order payment request.
+ * Updates an order payment request.
  *
- * Please note that only `UNPAID` payment requests can be updated.
+ * Only `UNPAID` order payment requests can be updated. The `amount` can't be changed after the order payment request is created.
  * @param _id - Order payment request ID.
  * @public
  * @documentationMaturity preview
@@ -669,7 +849,7 @@ interface UpdateOrderPaymentRequest {
      */
     source?: Source;
     /**
-     * status.
+     * Payment request status. Set by the system. A new order payment request starts as `UNPAID`, unless `expirationDate` is already in the past at creation time, in which case it is created as `EXPIRED`. The system sets the status to `PAID` once payment is collected, `EXPIRED` when the expiration date passes, or `VOIDED` when the request is voided.
      * @readonly
      */
     status?: StatusWithLiterals;
@@ -686,8 +866,7 @@ interface UpdateOrderPaymentRequest {
      */
     orderNumber?: string | null;
     /**
-     * Amount to collect.
-     * > **Note:** The amount can only be set once.
+     * Amount to collect. Set when the order payment request is created and can't be changed afterward.
      * @immutable
      */
     amount?: Price;
@@ -755,9 +934,9 @@ interface UpdateOrderPaymentRequest {
     subscriptionInfo?: SubscriptionInfo[];
 }
 /**
- * Deletes a order payment request.
+ * Deletes an order payment request.
  *
- * Please note that only `UNPAID` and `VOIDED` payment requests can be deleted.
+ * You can delete an order payment request in any status except `PAID`. Attempting to delete a `PAID` order payment request fails with `CANNOT_DELETE_PAID_ORDER_PAYMENT_REQUEST`.
  * @param orderPaymentRequestId - Id of the OrderPaymentRequest to delete.
  * @public
  * @documentationMaturity preview
@@ -989,9 +1168,9 @@ interface UpdateExtendedFieldsOptions {
     namespaceData: Record<string, any> | null;
 }
 /**
- * Voids the given order payment request
+ * Voids the given order payment request.
  *
- * Please note that only `UNPAID` payment requests can be voided.
+ * Only `UNPAID` order payment requests can be voided. Voiding an order payment request that is already `VOIDED` succeeds without making any changes. Voiding a `PAID` or `EXPIRED` order payment request fails.
  * @param orderPaymentRequestId - ID of the order payment request to void.
  * @internal
  * @documentationMaturity preview
@@ -1004,4 +1183,4 @@ declare function voidOrderPaymentRequest(orderPaymentRequestId: string): Promise
     __applicationErrorsType?: VoidOrderPaymentRequestApplicationErrors;
 }>;
 
-export { type AccountInfo, type ActionEvent, type ActionLink, type ActionLinks, type CommonQueryWithEntityContext, type CreateOrderPaymentRequestApplicationErrors, type CreateOrderPaymentRequestOptions, type CreateOrderPaymentRequestRequest, type CreateOrderPaymentRequestResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteOrderPaymentRequestApplicationErrors, type DeleteOrderPaymentRequestRequest, type DeleteOrderPaymentRequestResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetOrderPaymentRequestApplicationErrors, type GetOrderPaymentRequestRequest, type GetOrderPaymentRequestResponse, type GetOrderPaymentRequestURLRequest, type GetOrderPaymentRequestURLResponse, type GetOrderPaymentRequestUrlApplicationErrors, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type OrderPaymentRequest, type OrderPaymentRequestExpired, type OrderPaymentRequestPaid, type OrderPaymentRequestQuery, type OrderPaymentRequestQuerySpec, type OrderPaymentRequestVoided, type OrderPaymentRequestsQueryBuilder, type OrderPaymentRequestsQueryResult, PaymentMethod, type PaymentMethodWithLiterals, type Price, type QueryOrderPaymentRequestsRequest, type QueryOrderPaymentRequestsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type Source, Status, type StatusWithLiterals, type SubscriptionInfo, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateOrderPaymentRequest, type UpdateOrderPaymentRequestApplicationErrors, type UpdateOrderPaymentRequestRequest, type UpdateOrderPaymentRequestResponse, type VoidOrderPaymentRequestApplicationErrors, type VoidOrderPaymentRequestRequest, type VoidOrderPaymentRequestResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createOrderPaymentRequest, deleteOrderPaymentRequest, getOrderPaymentRequest, getOrderPaymentRequestUrl, queryOrderPaymentRequests, typedQueryOrderPaymentRequests, updateExtendedFields, updateOrderPaymentRequest, utils, voidOrderPaymentRequest };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type ActionLink, type ActionLinks, type BaseEventMetadata, type CommonQueryWithEntityContext, type CreateOrderPaymentRequestApplicationErrors, type CreateOrderPaymentRequestOptions, type CreateOrderPaymentRequestRequest, type CreateOrderPaymentRequestResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteOrderPaymentRequestApplicationErrors, type DeleteOrderPaymentRequestRequest, type DeleteOrderPaymentRequestResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetOrderPaymentRequestApplicationErrors, type GetOrderPaymentRequestRequest, type GetOrderPaymentRequestResponse, type GetOrderPaymentRequestURLRequest, type GetOrderPaymentRequestURLResponse, type GetOrderPaymentRequestUrlApplicationErrors, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type OrderPaymentRequest, type OrderPaymentRequestCreatedEnvelope, type OrderPaymentRequestDeletedEnvelope, type OrderPaymentRequestExpired, type OrderPaymentRequestExpiredEnvelope, type OrderPaymentRequestPaid, type OrderPaymentRequestPaidEnvelope, type OrderPaymentRequestQuery, type OrderPaymentRequestQuerySpec, type OrderPaymentRequestUpdatedEnvelope, type OrderPaymentRequestVoided, type OrderPaymentRequestVoidedEnvelope, type OrderPaymentRequestsQueryBuilder, type OrderPaymentRequestsQueryResult, PaymentMethod, type PaymentMethodWithLiterals, type Price, type QueryOrderPaymentRequestsRequest, type QueryOrderPaymentRequestsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type Source, Status, type StatusWithLiterals, type SubscriptionInfo, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateOrderPaymentRequest, type UpdateOrderPaymentRequestApplicationErrors, type UpdateOrderPaymentRequestRequest, type UpdateOrderPaymentRequestResponse, type VoidOrderPaymentRequestApplicationErrors, type VoidOrderPaymentRequestRequest, type VoidOrderPaymentRequestResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createOrderPaymentRequest, deleteOrderPaymentRequest, getOrderPaymentRequest, getOrderPaymentRequestUrl, onOrderPaymentRequestCreated, onOrderPaymentRequestDeleted, onOrderPaymentRequestExpired, onOrderPaymentRequestPaid, onOrderPaymentRequestUpdated, onOrderPaymentRequestVoided, queryOrderPaymentRequests, typedQueryOrderPaymentRequests, updateExtendedFields, updateOrderPaymentRequest, utils, voidOrderPaymentRequest };