@wix/auto_sdk_ecom_order-transactions 1.0.26 → 1.0.28

package/build/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
 import { ListTransactionsForSingleOrderResponse, ListTransactionsForMultipleOrdersResponse, Payment, AddPaymentsResponse, UpdatePaymentStatusIdentifiers, UpdatePaymentStatusOptions, UpdatePaymentStatusResponse, PaymentAndOrderId, BulkUpdatePaymentStatusesOptions, BulkUpdatePaymentStatusesResponse } from './index.typings.js';
 export { ActionEvent, ActionType, Activity, ActivityType, AddChargebackRequest, AddChargebackResponse, AddInvoiceToOrderRequest, AddInvoiceToOrderResponse, AddPaymentsRequest, AddRefundRequest, AddRefundResponse, AdditionalFeeRefund, Address, AddressAddressLine1OptionsOneOf, AggregatedRefundSummary, ApplicationError, AppliedCoupon, AuthorizationActionFailureDetails, AuthorizationCapture, AuthorizationCaptureStatus, AuthorizationDetails, AuthorizationVoid, AuthorizationVoidStatus, BillingInfo, BulkActionMetadata, BulkGenerateInvoicesRequest, BulkGenerateInvoicesResponse, BulkInvoiceResult, BulkPaymentResult, BulkUpdatePaymentStatusesRequest, BuyerDetails, BuyerInfo, CalculateRefundItemRequest, CalculateRefundItemResponse, CalculateRefundRequest, CalculateRefundResponse, ChannelInfo, ChannelType, Chargeback, ChargebackApproved, ChargebackReversed, ChargebackStatus, CreditCardPaymentMethodDetails, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomField, CustomTextFieldSelection, DiffmatokyPayload, DigitalFile, Discount, DomainEvent, DomainEventBodyOneOf, EnteredBy, EnteredByIdentityType, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ErrorInformation, ExternalReceiptInfo, Fulfillment, FulfillmentLineItem, FulfillmentStatus, FulfillmentTrackingInfo, FullName, GenerateInvoiceRequest, GenerateInvoiceResponse, GetRefundabilityStatusRequest, GetRefundabilityStatusResponse, GiftCard, GiftCardPaymentDetails, IdentificationData, IdentificationDataIdOneOf, IdentityType, IndexingMessage, InvoiceForOrder, InvoiceInfo, InvoiceSource, InvoicesForOrder, ItemMetadata, LineItem, LineItemPriceData, LineItemRefund, LineItemRefundSummary, LineItemType, ListInvoicesForMultipleOrdersRequest, ListInvoicesForMultipleOrdersResponse, ListInvoicesForSingleOrderRequest, ListInvoicesForSingleOrderResponse, ListTransactionsForMultipleOrdersRequest, ListTransactionsForSingleOrderRequest, ManuallyRefundableReason, MaskedPayment, MediaItem, MediaItemType, MembershipName, MembershipPaymentDetails, MembershipPaymentStatus, MessageEnvelope, NonRefundableReason, OptionSelection, Order, OrderRefunded, OrderTransactions, PaymentDetailsUpdated, PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentRefund, PaymentStatus, PaymentsUpdated, PickupAddress, PickupDetails, Price, QueryOrderTransactionsRequest, QueryOrderTransactionsResponse, Reason, Refund, RefundCompleted, RefundCreated, RefundDetails, RefundItem, RefundItemsBreakdown, RefundSideEffects, RefundStatus, RefundStatusInfo, RefundTransaction, Refundability, RefundabilityAdditionalRefundabilityInfoOneOf, RefundableStatus, RegularPaymentDetails, RegularPaymentDetailsPaymentMethodDetailsOneOf, RestockInfo, RestockItem, RestockType, RestoreInfo, ScheduledAction, ShipmentDetails, ShippingInfo, ShippingInfoDetailsOneOf, ShippingPriceData, ShippingRefund, SnapshotMessage, SortOrder, Sorting, Street, SubscriptionFrequency, SubscriptionInfo, SubscriptionOptionInfo, SubscriptionSettings, Totals, TrackingInfo, TransactionStatus, TriggerRefundRequest, TriggerRefundResponse, UpdateChargebackRequest, UpdateChargebackResponse, UpdatePaymentStatusRequest, UpdatePaymentsRequest, UpdatePaymentsResponse, UpdateRefundRequest, UpdateRefundResponse, UpdateRefundTransactionRequest, UpdateRefundTransactionResponse, V2InvoiceInfo, V2Refund, VatId, VatType, WebhookIdentityType, WeightUnit, WixReceiptInfo } from './index.typings.js';
 
+type OrderTransactionsNonNullablePaths = `orderId` | `payments` | `payments.${number}.regularPaymentDetails.offlinePayment` | `payments.${number}.regularPaymentDetails.status` | `payments.${number}.regularPaymentDetails.savedPaymentMethod` | `payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `payments.${number}.giftcardPaymentDetails.appId` | `payments.${number}.giftcardPaymentDetails.voided` | `payments.${number}.refundDisabled` | `refunds` | `refunds.${number}._id` | `refunds.${number}.details.shippingIncluded` | `refunds.${number}.summary.pending`;
 declare function listTransactionsForSingleOrder$1(httpClient: HttpClient): ListTransactionsForSingleOrderSignature;
 interface ListTransactionsForSingleOrderSignature {
     /**
@@ -11,7 +12,9 @@ interface ListTransactionsForSingleOrderSignature {
      * The `listTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
      * @param - Order ID.
      */
-    (orderId: string): Promise<ListTransactionsForSingleOrderResponse>;
+    (orderId: string): Promise<NonNullablePaths<ListTransactionsForSingleOrderResponse, {
+        [P in OrderTransactionsNonNullablePaths]: `orderTransactions.${P}`;
+    }[OrderTransactionsNonNullablePaths]>>;
 }
 declare function listTransactionsForMultipleOrders$1(httpClient: HttpClient): ListTransactionsForMultipleOrdersSignature;
 interface ListTransactionsForMultipleOrdersSignature {
@@ -22,7 +25,9 @@ interface ListTransactionsForMultipleOrdersSignature {
      * The `listTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
      * @param - Order IDs for which to retrieve transactions.
      */
-    (orderIds: string[]): Promise<ListTransactionsForMultipleOrdersResponse>;
+    (orderIds: string[]): Promise<NonNullablePaths<ListTransactionsForMultipleOrdersResponse, {
+        [P in OrderTransactionsNonNullablePaths]: `orderTransactions.${number}.${P}`;
+    }[OrderTransactionsNonNullablePaths]>>;
 }
 declare function addPayments$1(httpClient: HttpClient): AddPaymentsSignature;
 interface AddPaymentsSignature {
@@ -36,7 +41,9 @@ interface AddPaymentsSignature {
      * @param - Order ID.
      * @param - Payments to be added to order.
      */
-    (orderId: string, payments: Payment[]): Promise<AddPaymentsResponse>;
+    (orderId: string, payments: NonNullablePaths<Payment, `amount` | `giftcardPaymentDetails.giftCardPaymentId`>[]): Promise<NonNullablePaths<AddPaymentsResponse, {
+        [P in OrderTransactionsNonNullablePaths]: `orderTransactions.${P}`;
+    }[OrderTransactionsNonNullablePaths] | `paymentsIds`>>;
 }
 declare function updatePaymentStatus$1(httpClient: HttpClient): UpdatePaymentStatusSignature;
 interface UpdatePaymentStatusSignature {
@@ -46,7 +53,9 @@ interface UpdatePaymentStatusSignature {
      *
      * The `updatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
      */
-    (identifiers: UpdatePaymentStatusIdentifiers, options?: UpdatePaymentStatusOptions | undefined): Promise<UpdatePaymentStatusResponse>;
+    (identifiers: NonNullablePaths<UpdatePaymentStatusIdentifiers, `orderId` | `paymentId`>, options?: UpdatePaymentStatusOptions): Promise<NonNullablePaths<UpdatePaymentStatusResponse, {
+        [P in OrderTransactionsNonNullablePaths]: `orderTransactions.${P}`;
+    }[OrderTransactionsNonNullablePaths]>>;
 }
 declare function bulkUpdatePaymentStatuses$1(httpClient: HttpClient): BulkUpdatePaymentStatusesSignature;
 interface BulkUpdatePaymentStatusesSignature {
@@ -57,7 +66,7 @@ interface BulkUpdatePaymentStatusesSignature {
      * The `bulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
      * @param - Order and payment IDs for which to update payment status.
      */
-    (paymentAndOrderIds: PaymentAndOrderId[], options?: BulkUpdatePaymentStatusesOptions | undefined): Promise<BulkUpdatePaymentStatusesResponse>;
+    (paymentAndOrderIds: PaymentAndOrderId[], options?: BulkUpdatePaymentStatusesOptions): Promise<NonNullablePaths<BulkUpdatePaymentStatusesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.regularPaymentDetails.offlinePayment` | `results.${number}.item.regularPaymentDetails.status` | `results.${number}.item.regularPaymentDetails.savedPaymentMethod` | `results.${number}.item.regularPaymentDetails.authorizationDetails.delayedCapture` | `results.${number}.item.regularPaymentDetails.authorizationDetails.void.status` | `results.${number}.item.regularPaymentDetails.authorizationDetails.void.reason` | `results.${number}.item.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `results.${number}.item.giftcardPaymentDetails.giftCardPaymentId` | `results.${number}.item.giftcardPaymentDetails.appId` | `results.${number}.item.giftcardPaymentDetails.voided` | `results.${number}.item.refundDisabled` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 
 declare const listTransactionsForSingleOrder: MaybeContext<BuildRESTFunction<typeof listTransactionsForSingleOrder$1> & typeof listTransactionsForSingleOrder$1>;