@wix/auto_sdk_ecom_order-transactions 1.0.96 → 1.0.98

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

@@ -22,7 +22,7 @@ interface OrderTransactions {
      */
     refunds?: Refund[];
 }
-interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
+interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
     /** Regular payment details. */
     regularPaymentDetails?: RegularPaymentDetails;
     /** Gift card payment details. */
@@ -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 {
@@ -59,6 +61,9 @@ interface PaymentPaymentDetailsOneOf {
 /** @oneof */
 interface PaymentReceiptInfoOneOf {
 }
+/** @oneof */
+interface PaymentStatusDetailsOneOf {
+}
 interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
     /** Credit card details. */
     creditCardDetails?: CreditCardPaymentMethodDetails;
@@ -480,6 +485,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 {
     /**
@@ -506,11 +523,6 @@ declare enum PaymentStatus {
 }
 /** @enumType */
 type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
-interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
-}
-/** @oneof */
-interface PaymentStatusDetailsStatusDetailsOneOf {
-}
 interface CanceledStatusDetails {
     reason?: CanceledReasonWithLiterals;
 }
@@ -548,6 +560,11 @@ declare enum VoidedReason {
 }
 /** @enumType */
 type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
+interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
+}
+/** @oneof */
+interface PaymentStatusDetailsStatusDetailsOneOf {
+}
 interface Refund {
     /**
      * Refund ID.
@@ -1918,7 +1935,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.
  *
@@ -1950,7 +1967,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.
  *
@@ -1964,7 +1981,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.
@@ -2003,4 +2020,4 @@ interface BulkUpdatePaymentStatusesOptions {
 interface UpdateRefundTransactionOptions {
 }
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, ActionType, type ActionTypeWithLiterals, type AddChargebackRequest, type AddChargebackResponse, type AddInvoiceToOrderRequest, type AddInvoiceToOrderResponse, type AddPaymentsRequest, type AddPaymentsResponse, type AddRefundRequest, type AddRefundResponse, type AdditionalFeeRefund, type AggregatedRefundSummary, type ApplicationError, type AuthorizationActionFailureDetails, type AuthorizationCapture, AuthorizationCaptureStatus, type AuthorizationCaptureStatusWithLiterals, type AuthorizationDetails, type AuthorizationVoid, AuthorizationVoidStatus, type AuthorizationVoidStatusWithLiterals, type BaseEventMetadata, type BulkActionMetadata, type BulkGenerateInvoicesRequest, type BulkGenerateInvoicesResponse, type BulkInvoiceResult, type BulkPaymentResult, type BulkUpdatePaymentStatusesOptions, type BulkUpdatePaymentStatusesRequest, type BulkUpdatePaymentStatusesResponse, type CalculateRefundItemRequest, type CalculateRefundItemResponse, type CalculateRefundRequest, type CalculateRefundResponse, CanceledReason, type CanceledReasonWithLiterals, type CanceledStatusDetails, type CashRounding, type CashRoundingDetails, type Chargeback, type ChargebackApproved, type ChargebackReversed, ChargebackStatus, type ChargebackStatusWithLiterals, type CreditCardPaymentMethodDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, DeclinedReason, type DeclinedReasonWithLiterals, type DeclinedStatusDetails, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExternalReceiptInfo, type FutureMembershipDetails, type GenerateInvoiceRequest, type GenerateInvoiceResponse, type GetRefundabilityStatusRequest, type GetRefundabilityStatusResponse, type GiftCardPaymentDetails, type IdentificationData, type IdentificationDataIdOneOf, type InvoiceForOrder, type InvoiceInfo, type InvoicesForOrder, type ItemMetadata, type LineItemRefund, type LineItemRefundSummary, type ListInvoicesForMultipleOrdersRequest, type ListInvoicesForMultipleOrdersResponse, type ListInvoicesForSingleOrderRequest, type ListInvoicesForSingleOrderResponse, type ListTransactionsForMultipleOrdersRequest, type ListTransactionsForMultipleOrdersResponse, type ListTransactionsForSingleOrderRequest, type ListTransactionsForSingleOrderResponse, ManuallyRefundableReason, type ManuallyRefundableReasonWithLiterals, type MaskedPayment, type MembershipName, type MembershipPaymentDetails, MembershipPaymentStatus, type MembershipPaymentStatusWithLiterals, type MessageEnvelope, NonRefundableReason, type NonRefundableReasonWithLiterals, type OrderTransactions, type OrderTransactionsChargebackApprovedEnvelope, type OrderTransactionsChargebackReversedEnvelope, type OrderTransactionsDetailsUpdatedEnvelope, type OrderTransactionsRefundCompletedEnvelope, type OrderTransactionsUpdatedEnvelope, type Payment, type PaymentAndOrderId, type PaymentDetailsUpdated, type PaymentMethodName, type PaymentPaymentDetailsOneOf, type PaymentReceiptInfoOneOf, type PaymentRefund, PaymentStatus, type PaymentStatusDetails, type PaymentStatusDetailsStatusDetailsOneOf, type PaymentStatusWithLiterals, type PaymentsUpdated, PredefinedPaymentMethod, type PredefinedPaymentMethodWithLiterals, type Price, type QueryOrderTransactionsRequest, type QueryOrderTransactionsResponse, Reason, type ReasonWithLiterals, type Refund, type RefundCompleted, type RefundCreated, type RefundDetails, type RefundItem, type RefundItemsBreakdown, type RefundSideEffects, RefundStatus, type RefundStatusInfo, type RefundStatusWithLiterals, type RefundTransaction, type Refundability, type RefundabilityAdditionalRefundabilityInfoOneOf, RefundableStatus, type RefundableStatusWithLiterals, type RegularPaymentDetails, type RegularPaymentDetailsPaymentMethodDetailsOneOf, type RestockInfo, type RestockItem, type RestockLocation, RestockType, type RestockTypeWithLiterals, type RestoreInfo, type ReverseChargebackRequest, type ReverseChargebackResponse, type ScheduledAction, type ShippingRefund, SortOrder, type SortOrderWithLiterals, type Sorting, TransactionStatus, type TransactionStatusWithLiterals, type TriggerRefundRequest, type TriggerRefundResponse, type UpdatePaymentStatusIdentifiers, type UpdatePaymentStatusOptions, type UpdatePaymentStatusRequest, type UpdatePaymentStatusResponse, type UpdatePaymentsApplicationErrors, type UpdatePaymentsRequest, type UpdatePaymentsResponse, type UpdateRefundRequest, type UpdateRefundResponse, type UpdateRefundTransactionApplicationErrors, type UpdateRefundTransactionOptions, type UpdateRefundTransactionRequest, type UpdateRefundTransactionResponse, type UserDefinedPaymentMethodName, type UserDefinedPaymentMethodNameKindOneOf, VoidedReason, type VoidedReasonWithLiterals, type VoidedStatusDetails, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixReceiptInfo, addPayments, bulkUpdatePaymentStatuses, listTransactionsForMultipleOrders, listTransactionsForSingleOrder, onOrderTransactionsChargebackApproved, onOrderTransactionsChargebackReversed, onOrderTransactionsDetailsUpdated, onOrderTransactionsRefundCompleted, onOrderTransactionsUpdated, updatePaymentStatus };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, ActionType, type ActionTypeWithLiterals, type AddChargebackRequest, type AddChargebackResponse, type AddInvoiceToOrderRequest, type AddInvoiceToOrderResponse, type AddPaymentsRequest, type AddPaymentsResponse, type AddRefundRequest, type AddRefundResponse, type AdditionalFeeRefund, type AggregatedRefundSummary, type ApplicationError, type AuthorizationActionFailureDetails, type AuthorizationCapture, AuthorizationCaptureStatus, type AuthorizationCaptureStatusWithLiterals, type AuthorizationDetails, type AuthorizationVoid, AuthorizationVoidStatus, type AuthorizationVoidStatusWithLiterals, type BaseEventMetadata, type BulkActionMetadata, type BulkGenerateInvoicesRequest, type BulkGenerateInvoicesResponse, type BulkInvoiceResult, type BulkPaymentResult, type BulkUpdatePaymentStatusesOptions, type BulkUpdatePaymentStatusesRequest, type BulkUpdatePaymentStatusesResponse, type CalculateRefundItemRequest, type CalculateRefundItemResponse, type CalculateRefundRequest, type CalculateRefundResponse, CanceledReason, type CanceledReasonWithLiterals, type CanceledStatusDetails, type CashRounding, type CashRoundingDetails, type Chargeback, type ChargebackApproved, type ChargebackReversed, ChargebackStatus, type ChargebackStatusWithLiterals, type CreditCardPaymentMethodDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, DeclinedReason, type DeclinedReasonWithLiterals, type DeclinedStatusDetails, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExternalReceiptInfo, type FutureMembershipDetails, type GenerateInvoiceRequest, type GenerateInvoiceResponse, type GetRefundabilityStatusRequest, type GetRefundabilityStatusResponse, type GiftCardPaymentDetails, type IdentificationData, type IdentificationDataIdOneOf, type InvoiceForOrder, type InvoiceInfo, type InvoicesForOrder, type ItemMetadata, type LineItemRefund, type LineItemRefundSummary, type ListInvoicesForMultipleOrdersRequest, type ListInvoicesForMultipleOrdersResponse, type ListInvoicesForSingleOrderRequest, type ListInvoicesForSingleOrderResponse, type ListTransactionsForMultipleOrdersRequest, type ListTransactionsForMultipleOrdersResponse, type ListTransactionsForSingleOrderRequest, type ListTransactionsForSingleOrderResponse, ManuallyRefundableReason, type ManuallyRefundableReasonWithLiterals, type MaskedPayment, type MembershipName, type MembershipPaymentDetails, MembershipPaymentStatus, type MembershipPaymentStatusWithLiterals, type MessageEnvelope, NonRefundableReason, type NonRefundableReasonWithLiterals, type OrderTransactions, type OrderTransactionsChargebackApprovedEnvelope, type OrderTransactionsChargebackReversedEnvelope, type OrderTransactionsDetailsUpdatedEnvelope, type OrderTransactionsRefundCompletedEnvelope, type OrderTransactionsUpdatedEnvelope, type Payment, type PaymentAndOrderId, type PaymentDetailsUpdated, type PaymentMethodName, type PaymentPaymentDetailsOneOf, type PaymentReceiptInfoOneOf, type PaymentRefund, PaymentStatus, type PaymentStatusDetails, type PaymentStatusDetailsOneOf, type PaymentStatusDetailsStatusDetailsOneOf, type PaymentStatusWithLiterals, type PaymentsUpdated, PredefinedPaymentMethod, type PredefinedPaymentMethodWithLiterals, type Price, type QueryOrderTransactionsRequest, type QueryOrderTransactionsResponse, Reason, type ReasonWithLiterals, type Refund, type RefundCompleted, type RefundCreated, type RefundDetails, type RefundItem, type RefundItemsBreakdown, type RefundSideEffects, RefundStatus, type RefundStatusInfo, type RefundStatusWithLiterals, type RefundTransaction, type Refundability, type RefundabilityAdditionalRefundabilityInfoOneOf, RefundableStatus, type RefundableStatusWithLiterals, type RegularPaymentDetails, type RegularPaymentDetailsPaymentMethodDetailsOneOf, type RestockInfo, type RestockItem, type RestockLocation, RestockType, type RestockTypeWithLiterals, type RestoreInfo, type ReverseChargebackRequest, type ReverseChargebackResponse, type ScheduledAction, type ShippingRefund, SortOrder, type SortOrderWithLiterals, type Sorting, TransactionStatus, type TransactionStatusWithLiterals, type TriggerRefundRequest, type TriggerRefundResponse, type UpdatePaymentStatusIdentifiers, type UpdatePaymentStatusOptions, type UpdatePaymentStatusRequest, type UpdatePaymentStatusResponse, type UpdatePaymentsApplicationErrors, type UpdatePaymentsRequest, type UpdatePaymentsResponse, type UpdateRefundRequest, type UpdateRefundResponse, type UpdateRefundTransactionApplicationErrors, type UpdateRefundTransactionOptions, type UpdateRefundTransactionRequest, type UpdateRefundTransactionResponse, type UserDefinedPaymentMethodName, type UserDefinedPaymentMethodNameKindOneOf, VoidedReason, type VoidedReasonWithLiterals, type VoidedStatusDetails, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixReceiptInfo, addPayments, bulkUpdatePaymentStatuses, listTransactionsForMultipleOrders, listTransactionsForSingleOrder, onOrderTransactionsChargebackApproved, onOrderTransactionsChargebackReversed, onOrderTransactionsDetailsUpdated, onOrderTransactionsRefundCompleted, onOrderTransactionsUpdated, updatePaymentStatus };