@wix/auto_sdk_ecom_order-transactions 1.0.95 → 1.0.97

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

@@ -48,6 +48,8 @@ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
      * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
      */
     refundDisabled?: boolean;
+    /** Details about cash rounding applied to this payment, when relevant. */
+    cashRounding?: CashRoundingDetails;
 }
 /** @oneof */
 interface PaymentPaymentDetailsOneOf {
@@ -96,10 +98,7 @@ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetail
     offlinePayment?: boolean;
     /** Payment status. */
     status?: TransactionStatusWithLiterals;
-    /**
-     * Whether there is a payment agreement that allows for future charges.
-     * @immutable
-     */
+    /** Whether there is a payment agreement that allows for future charges. */
     savedPaymentMethod?: boolean;
     /** Authorization details. */
     authorizationDetails?: AuthorizationDetails;
@@ -483,6 +482,18 @@ interface ExternalReceiptInfo {
     displayNumber?: string | null;
 }
 interface CashRoundingDetails {
+    /**
+     * Payment amount before cash rounding was applied.
+     * When provided, balance and status calculations use this value instead of `amount`
+     * to prevent false overpayment or underpayment due to rounding.
+     */
+    unroundedAmount?: Price;
+    /**
+     * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
+     * A positive value indicates the price was rounded up; a negative value indicates a round-down.
+     * @readonly
+     */
+    roundingAdjustment?: CashRounding;
 }
 interface CashRounding {
     /**
@@ -1921,7 +1932,7 @@ declare function onOrderTransactionsUpdated(handler: (event: OrderTransactionsUp
  * @applicableIdentity APP
  * @fqn com.wix.ecom.orders.payments.v1.Payments.ListTransactionsForSingleOrder
  */
-declare function listTransactionsForSingleOrder(orderId: string): Promise<NonNullablePaths<ListTransactionsForSingleOrderResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.formattedAmount` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`, 7>>;
+declare function listTransactionsForSingleOrder(orderId: string): Promise<NonNullablePaths<ListTransactionsForSingleOrderResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.formattedAmount` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.amount` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.formattedAmount` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`, 7>>;
 /**
  * Retrieves information about payments and refunds associated with all specified orders.
  *
@@ -1953,7 +1964,7 @@ declare function listTransactionsForMultipleOrders(orderIds: string[]): Promise<
  * @applicableIdentity APP
  * @fqn com.wix.ecom.orders.payments.v1.Payments.AddPayments
  */
-declare function addPayments(orderId: string, payments: NonNullablePaths<Payment, `amount`, 2>[]): Promise<NonNullablePaths<AddPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.formattedAmount` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending` | `paymentsIds`, 7>>;
+declare function addPayments(orderId: string, payments: NonNullablePaths<Payment, `amount`, 2>[]): Promise<NonNullablePaths<AddPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.formattedAmount` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.amount` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.formattedAmount` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending` | `paymentsIds`, 7>>;
 /**
  * Updates the status of an order's payment.
  *
@@ -1967,7 +1978,7 @@ declare function addPayments(orderId: string, payments: NonNullablePaths<Payment
  * @applicableIdentity APP
  * @fqn com.wix.ecom.orders.payments.v1.Payments.UpdatePaymentStatus
  */
-declare function updatePaymentStatus(identifiers: NonNullablePaths<UpdatePaymentStatusIdentifiers, `orderId` | `paymentId`, 2>, options?: UpdatePaymentStatusOptions): Promise<NonNullablePaths<UpdatePaymentStatusResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.formattedAmount` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`, 7>>;
+declare function updatePaymentStatus(identifiers: NonNullablePaths<UpdatePaymentStatusIdentifiers, `orderId` | `paymentId`, 2>, options?: UpdatePaymentStatusOptions): Promise<NonNullablePaths<UpdatePaymentStatusResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.formattedAmount` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.amount` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.formattedAmount` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`, 7>>;
 interface UpdatePaymentStatusIdentifiers {
     /**
      * Payment ID.