@wix/auto_sdk_ecom_order-payment-requests 1.0.63 → 1.0.64

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

@@ -316,6 +316,13 @@ interface GetOrderPaymentRequestResponse {
 interface UpdateOrderPaymentRequestRequest {
     /** Order payment request to update. */
     orderPaymentRequest: OrderPaymentRequest;
+    /**
+     * Set of fields to update.
+     *
+     * Fields that aren't included in `fieldMask.paths` are ignored.
+     * @internal
+     */
+    fieldMask?: string[];
 }
 interface UpdateOrderPaymentRequestResponse {
     /** Updated order payment request. */
@@ -366,6 +373,20 @@ interface Sorting {
     fieldName?: string;
     /** Sort order. */
     order?: SortOrderWithLiterals;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
+     */
+    selectItemsBy?: Record<string, any>[] | null;
 }
 declare enum SortOrder {
     ASC = "ASC",
@@ -472,7 +493,7 @@ interface ChargeOrderPaymentRequestRequest {
 }
 interface ChargeOrderPaymentRequestResponse {
     /**
-     * Token for completing a payment that requires an additional step from the customer, such as 3D Secure verification or an off-site redirect. Returned only when such a step is required. Pass it to `paymentsApi.continuePayment()` in the Wix Cashier payments client SDK.
+     * Token for completing the payment. Returned for every charge that reaches the payment provider. Pass it to `paymentsApi.continuePayment()` in the Wix Cashier payments client SDK, which completes any remaining step the provider requires from the customer, such as 3D Secure verification or an off-site redirect.
      * @minLength 1
      * @maxLength 1000
      */
@@ -726,6 +747,14 @@ type ChargeOrderPaymentRequestApplicationErrors = {
     code?: 'PAYMENT_IN_PROGRESS';
     description?: string;
     data?: Record<string, any>;
+} | {
+    code?: 'PAYMENT_ATTEMPT_EXPIRED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'PAYMENT_METHOD_UNAVAILABLE';
+    description?: string;
+    data?: Record<string, any>;
 };
 interface BaseEventMetadata {
     /**
@@ -1284,6 +1313,20 @@ type OrderPaymentRequestQuery = {
       Sort order.
       */
         order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+        /**
+      When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+      a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+    
+      If multiple filters are provided, they are combined with AND operator.
+    
+      Example:
+      Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+      and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+      { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+      @internal: undefined,
+      @maxSize: 10
+      */
+        selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
     }[];
 };
 declare const utils: {
@@ -1345,9 +1388,7 @@ declare function voidOrderPaymentRequest(orderPaymentRequestId: string): Promise
  *
  * Collects the order payment request's `amount` from the payment method the customer entered in the Wix Cashier payments widget on your page. Before calling this method, call `paymentsApi.initializePayment()` on the `paymentsApi` object provided by the Wix Cashier payments client SDK to collect the customer's payment details, then pass the token it returns as `paymentToken`.
  *
- * A successful response doesn't mean the payment was collected:
- * - If `paymentResponseToken` is returned, the customer must complete an additional step, such as 3D Secure verification or an off-site redirect. Pass the token to `paymentsApi.continuePayment()` to complete the payment.
- * - If `paymentResponseToken` isn't returned, no further step is needed. The payment was either collected or declined by the payment provider.
+ * A successful response doesn't mean the payment was collected. Always pass the returned `paymentResponseToken` to `paymentsApi.continuePayment()`. The widget then completes any step the payment provider still requires from the customer, such as 3D Secure verification or an off-site redirect, and does nothing when no step is needed.
  *
  * Either way, the order payment request's `status` is the authoritative outcome. It changes to `PAID` asynchronously, after the payment provider settles the transaction, which can happen after this method returns. To be notified, listen to the [Order Payment Request Paid](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-payment-requests/order-payment-request-paid) webhook, or poll [Get Order Payment Request](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-payment-requests/get-order-payment-request).
  *