@wix/auto_sdk_ecom_order-transactions 1.0.11 → 1.0.13

package/build/meta.d.mts

@@ -1,602 +0,0 @@
-import { aX as ListTransactionsForSingleOrderRequest$1, L as ListTransactionsForSingleOrderResponse$1, aY as ListTransactionsForMultipleOrdersRequest$1, a as ListTransactionsForMultipleOrdersResponse$1, aZ as AddPaymentsRequest$1, A as AddPaymentsResponse$1, b0 as UpdatePaymentStatusRequest$1, c as UpdatePaymentStatusResponse$1, b1 as BulkUpdatePaymentStatusesRequest$1, e as BulkUpdatePaymentStatusesResponse$1, b8 as UpdateRefundTransactionRequest$1, b9 as UpdateRefundTransactionResponse$1, ba as UpdatePaymentsRequest$1, bc as UpdatePaymentsResponse$1 } from './ecom-v1-order-transactions-order-transactions.universal-DgIVKgiJ.mjs';
-
-interface OrderTransactions {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    orderId?: string;
-    /**
-     * Record of payments made to the merchant.
-     * @maxSize 100
-     */
-    payments?: Payment[];
-    /**
-     * Record of refunds made to the buyer.
-     * @maxSize 300
-     */
-    refunds?: Refund[];
-}
-interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
-    /** Regular payment details. */
-    regularPaymentDetails?: RegularPaymentDetails;
-    /** Gift card payment details. */
-    giftcardPaymentDetails?: GiftCardPaymentDetails;
-    /**
-     * Payment ID.
-     * @format GUID
-     * @readonly
-     */
-    id?: string | null;
-    /** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
-    createdDate?: Date | null;
-    /**
-     * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
-     * @readonly
-     */
-    updatedDate?: Date | null;
-    /** Payment amount. */
-    amount?: Price;
-    /**
-     * Whether refunds for this payment are disabled.
-     * + `true`: This payment is not refundable.
-     * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
-     */
-    refundDisabled?: boolean;
-}
-/** @oneof */
-interface PaymentPaymentDetailsOneOf {
-    /** Regular payment details. */
-    regularPaymentDetails?: RegularPaymentDetails;
-    /** Gift card payment details. */
-    giftcardPaymentDetails?: GiftCardPaymentDetails;
-}
-/** @oneof */
-interface PaymentReceiptInfoOneOf {
-}
-interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
-    /** Whether regular card used */
-    creditCardDetails?: CreditCardPaymentMethodDetails;
-    /**
-     * Wix Payments order ID.
-     * @maxLength 100
-     */
-    paymentOrderId?: string | null;
-    /**
-     * Payment gateway's transaction ID.
-     * This field is only returned when the value of `offline_payment` is `false`.
-     * @maxLength 100
-     */
-    gatewayTransactionId?: string | null;
-    /**
-     * Payment method. Non-exhaustive list of supported values:
-     * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
-     * @maxLength 100
-     */
-    paymentMethod?: string | null;
-    /**
-     * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
-     * @maxLength 100
-     */
-    providerTransactionId?: string | null;
-    /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
-    offlinePayment?: boolean;
-    /** Payment status. */
-    status?: TransactionStatus;
-    /**
-     * Whether there is a payment agreement that allows for future charges.
-     * @immutable
-     */
-    savedPaymentMethod?: boolean;
-    /** Authorization details. */
-    authorizationDetails?: AuthorizationDetails;
-}
-/** @oneof */
-interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
-    /** Whether regular card used */
-    creditCardDetails?: CreditCardPaymentMethodDetails;
-}
-declare enum TransactionStatus {
-    UNDEFINED = "UNDEFINED",
-    APPROVED = "APPROVED",
-    PENDING = "PENDING",
-    PENDING_MERCHANT = "PENDING_MERCHANT",
-    CANCELED = "CANCELED",
-    DECLINED = "DECLINED",
-    REFUNDED = "REFUNDED",
-    PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
-    AUTHORIZED = "AUTHORIZED",
-    VOIDED = "VOIDED"
-}
-interface CreditCardPaymentMethodDetails {
-    /**
-     * The last 4 digits of the card number.
-     * @maxLength 4
-     */
-    lastFourDigits?: string | null;
-    /**
-     * Card issuer's brand.
-     * @maxLength 100
-     */
-    brand?: string | null;
-}
-interface AuthorizationDetails {
-    /**
-     * Whether the authorized payment is of a delayed capture.
-     * @readonly
-     */
-    delayedCapture?: boolean;
-    /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
-    authorizedDate?: Date | null;
-    /**
-     * List of captures associated with payment
-     * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
-     * @maxSize 1
-     */
-    captures?: AuthorizationCapture[];
-    /** Void associated with payment */
-    void?: AuthorizationVoid;
-    /** Scheduled action for this transaction */
-    scheduledAction?: ScheduledAction;
-}
-interface AuthorizationCapture {
-    /**
-     * Capture ID.
-     * @format GUID
-     * @readonly
-     */
-    id?: string | null;
-    /** Status of this capture action */
-    status?: AuthorizationCaptureStatus;
-    /**
-     * Amount of this capture
-     * @immutable
-     */
-    amount?: Price;
-    /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
-    createdDate?: Date | null;
-    /** In case of status is FAILED may contain failure details */
-    failureDetails?: AuthorizationActionFailureDetails;
-}
-declare enum AuthorizationCaptureStatus {
-    UNKNOWN_STATUS = "UNKNOWN_STATUS",
-    /** Capture operation still in progress. */
-    PENDING = "PENDING",
-    /** Capture operation succeeded. */
-    SUCCEEDED = "SUCCEEDED",
-    /** Capture operation failed. */
-    FAILED = "FAILED"
-}
-interface Price {
-    /**
-     * Amount.
-     * @decimalValue options { gte:0, lte:1000000000000000 }
-     */
-    amount?: string;
-    /**
-     * Amount formatted with currency symbol.
-     * @readonly
-     */
-    formattedAmount?: string;
-}
-interface AuthorizationActionFailureDetails {
-    /** @maxLength 100 */
-    failureCode?: string;
-}
-interface AuthorizationVoid {
-    /** Status of this void action */
-    status?: AuthorizationVoidStatus;
-    /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
-    voidedDate?: Date | null;
-    /** In case of status is FAILED may contain failure details */
-    failureDetails?: AuthorizationActionFailureDetails;
-    /** Reason of void action */
-    reason?: Reason;
-}
-declare enum AuthorizationVoidStatus {
-    UNKNOWN_STATUS = "UNKNOWN_STATUS",
-    /** Void operation still in progress. */
-    PENDING = "PENDING",
-    /** Void operation succeeded. */
-    SUCCEEDED = "SUCCEEDED",
-    /** Void operation failed. */
-    FAILED = "FAILED"
-}
-/** Reason the authorization was voided. */
-declare enum Reason {
-    UNKNOWN_REASON = "UNKNOWN_REASON",
-    /** Authorization was voided by user. */
-    MANUAL = "MANUAL",
-    /** Authorization passed execution date. */
-    SCHEDULED = "SCHEDULED"
-}
-interface ScheduledAction {
-    /** Type of the action. */
-    actionType?: ActionType;
-    /** The date and time of the action. */
-    executionDate?: Date | null;
-}
-declare enum ActionType {
-    UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
-    VOID = "VOID",
-    CAPTURE = "CAPTURE"
-}
-interface GiftCardPaymentDetails {
-    /**
-     * Gift card payment ID.
-     * @minLength 1
-     * @maxLength 100
-     */
-    giftCardPaymentId?: string;
-    /**
-     * ID of the app that created the gift card.
-     * @format GUID
-     */
-    appId?: string;
-    /**
-     * Whether the gift card is voided.
-     * @readonly
-     */
-    voided?: boolean;
-}
-interface Refund {
-    /**
-     * Refund ID.
-     * @format GUID
-     * @readonly
-     */
-    id?: string;
-    /**
-     * List of transactions.
-     * @maxSize 50
-     */
-    transactions?: RefundTransaction[];
-    /** Refund business details. */
-    details?: RefundDetails;
-    /**
-     * Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
-     * @readonly
-     * @immutable
-     */
-    createdDate?: Date | null;
-    /**
-     * Aggregated refund summary.
-     * @readonly
-     */
-    summary?: AggregatedRefundSummary;
-    /**
-     * ID of the app that initiated this refund.
-     * @format GUID
-     * @readonly
-     * @immutable
-     */
-    requestingServiceAppId?: string | null;
-}
-interface RefundTransaction {
-    /**
-     * ID of the payment associated with this refund.
-     * @format GUID
-     * @immutable
-     */
-    paymentId?: string;
-    /**
-     * Refund amount.
-     * @immutable
-     */
-    amount?: Price;
-    /** Refund status. */
-    refundStatus?: RefundStatus;
-    /** Optional details of current refund status. */
-    refundStatusInfo?: RefundStatusInfo;
-    /**
-     * Payment gateway's refund ID.
-     * This field is only returned when the value of `external_refund` is `false`.
-     * @format GUID
-     */
-    gatewayRefundId?: string | null;
-    /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
-    providerRefundId?: string | null;
-    /**
-     * Whether refund was made externally and manually on the payment provider's side.
-     * @immutable
-     */
-    externalRefund?: boolean;
-}
-/** Refund transaction status. */
-declare enum RefundStatus {
-    /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
-    PENDING = "PENDING",
-    /** Refund transaction succeeded. */
-    SUCCEEDED = "SUCCEEDED",
-    /** Refund transaction failed. */
-    FAILED = "FAILED",
-    /** Refund request acknowledged, and will be executed soon. */
-    SCHEDULED = "SCHEDULED",
-    /** Refund was initiated on payment provider side. */
-    STARTED = "STARTED"
-}
-interface RefundStatusInfo {
-    /**
-     * Reason code for the refund's current status.
-     *
-     * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
-     * @minLength 1
-     * @maxLength 10
-     */
-    paymentGatewayReasonCode?: string | null;
-    /**
-     * Free text explanation of current refund status.
-     * @minLength 1
-     * @maxLength 1000
-     */
-    description?: string | null;
-}
-/** Business model of a refund request */
-interface RefundDetails {
-    /**
-     * Order line item IDs and quantities that were refunded.
-     * @maxSize 300
-     */
-    items?: RefundItem[];
-    /** Whether the shipping fee was also refunded. */
-    shippingIncluded?: boolean;
-    /**
-     * Reason for the refund, provided by customer (optional).
-     * @maxLength 200
-     */
-    reason?: string | null;
-    /**
-     * Line items that were refunded.
-     * @maxSize 300
-     */
-    lineItems?: LineItemRefund[];
-    /**
-     * Additional fees that were refunded.
-     * @maxSize 100
-     */
-    additionalFees?: AdditionalFeeRefund[];
-    /** Shipping amount that was refunded. */
-    shipping?: ShippingRefund;
-}
-interface RefundItem {
-    /**
-     * Line item ID the refunded line item.
-     * @format GUID
-     */
-    lineItemId?: string;
-    /**
-     * Line item quantity refunded.
-     * @min 1
-     * @max 100000
-     */
-    quantity?: number;
-}
-interface LineItemRefund {
-    /**
-     * Line item ID.
-     * @format GUID
-     * @immutable
-     */
-    lineItemId?: string;
-    /**
-     * Refund quantity.
-     * @min 1
-     * @max 100000
-     * @immutable
-     */
-    quantity?: number;
-}
-interface AdditionalFeeRefund {
-    /**
-     * Additional fee ID.
-     * @format GUID
-     * @immutable
-     */
-    additionalFeeId?: string;
-    /**
-     * Refund amount.
-     * @immutable
-     */
-    amount?: Price;
-}
-interface ShippingRefund {
-    /**
-     * Refund amount.
-     * @immutable
-     */
-    amount?: Price;
-}
-interface AggregatedRefundSummary {
-    /** Total amount requested for refund. */
-    requestedRefund?: Price;
-    /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
-    pendingRefund?: Price;
-    /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
-    refunded?: Price;
-    /** Failed refund amount - the portion of `requestedRefund` that failed. */
-    failedRefundAmount?: Price;
-    /** Whether at least one refund transaction is still in `"PENDING"` status. */
-    pending?: boolean;
-    /** Breakdown of refunded items. Available only after refund is complete. */
-    breakdown?: RefundItemsBreakdown;
-}
-interface RefundItemsBreakdown {
-    /**
-     * Refunded line items and the amount refunded for each.
-     * @maxSize 300
-     */
-    lineItems?: LineItemRefundSummary[];
-}
-interface LineItemRefundSummary {
-    /**
-     * ID of the refunded line item.
-     * @format GUID
-     */
-    lineItemId?: string;
-    /** Total refunded amount for the line item. */
-    totalRefundedAmount?: Price;
-}
-interface ListTransactionsForSingleOrderRequest {
-    /**
-     * Order ID.
-     * @minLength 1
-     * @maxLength 100
-     */
-    orderId: string;
-}
-interface ListTransactionsForSingleOrderResponse {
-    /** Order ID and its associated transactions. */
-    orderTransactions?: OrderTransactions;
-}
-interface ListTransactionsForMultipleOrdersRequest {
-    /**
-     * Order IDs for which to retrieve transactions.
-     * @minSize 1
-     * @maxSize 100
-     * @minLength 1
-     * @maxLength 100
-     */
-    orderIds: string[];
-}
-interface ListTransactionsForMultipleOrdersResponse {
-    /** List of order IDs and their associated transactions. */
-    orderTransactions?: OrderTransactions[];
-}
-interface AddPaymentsRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    orderId: string;
-    /**
-     * Payments to be added to order.
-     * @minSize 1
-     * @maxSize 50
-     */
-    payments: Payment[];
-}
-interface AddPaymentsResponse {
-    /** Order ID and its associated transactions. */
-    orderTransactions?: OrderTransactions;
-    /** IDs of added order payments. */
-    paymentsIds?: string[];
-}
-interface UpdatePaymentStatusRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    orderId: string;
-    /**
-     * Payment ID.
-     * @format GUID
-     */
-    paymentId: string;
-    /** Payment status. */
-    status?: TransactionStatus;
-}
-interface UpdatePaymentStatusResponse {
-    /** Order ID and its associated transactions after update. */
-    orderTransactions?: OrderTransactions;
-}
-interface BulkUpdatePaymentStatusesRequest {
-    /**
-     * Order and payment IDs for which to update payment status.
-     * @minSize 1
-     * @maxSize 300
-     */
-    paymentAndOrderIds: PaymentAndOrderId[];
-    /** Whether to return the full payment entity (`results.item`) in the response. */
-    returnFullEntity?: boolean;
-    /** Payment status. */
-    status?: TransactionStatus;
-}
-interface PaymentAndOrderId {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    orderId?: string;
-    /**
-     * Payment ID.
-     * todo: remove comment once UI will use BulkMarkOrderAsPaid
-     */
-    paymentId?: string;
-}
-interface BulkUpdatePaymentStatusesResponse {
-    /** Bulk operation results. */
-    results?: BulkPaymentResult[];
-    /** Bulk operation metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-interface BulkPaymentResult {
-    /** Item metadata. */
-    itemMetadata?: ItemMetadata;
-    /** Updated payment. Returned if `return_full_entity` set to `true`. */
-    item?: Payment;
-}
-interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
-    id?: string | null;
-    /** Index of the item within the request array. Allows for correlation between request and response items. */
-    originalIndex?: number;
-    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
-    success?: boolean;
-    /** Details about the error in case of failure. */
-    error?: ApplicationError;
-}
-interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-interface BulkActionMetadata {
-    /** Number of items that were successfully processed. */
-    totalSuccesses?: number;
-    /** Number of items that couldn't be processed. */
-    totalFailures?: number;
-    /** Number of failures without details because detailed failure threshold was exceeded. */
-    undetailedFailures?: number;
-}
-interface UpdateRefundTransactionRequest {
-}
-interface UpdateRefundTransactionResponse {
-}
-interface UpdatePaymentsRequest {
-}
-interface UpdatePaymentsResponse {
-}
-
-type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
-    getUrl: (context: any) => string;
-    httpMethod: K;
-    path: string;
-    pathParams: M;
-    __requestType: T;
-    __originalRequestType: S;
-    __responseType: Q;
-    __originalResponseType: R;
-};
-declare function listTransactionsForSingleOrder(): __PublicMethodMetaInfo<'GET', {
-    orderId: string;
-}, ListTransactionsForSingleOrderRequest$1, ListTransactionsForSingleOrderRequest, ListTransactionsForSingleOrderResponse$1, ListTransactionsForSingleOrderResponse>;
-declare function listTransactionsForMultipleOrders(): __PublicMethodMetaInfo<'POST', {}, ListTransactionsForMultipleOrdersRequest$1, ListTransactionsForMultipleOrdersRequest, ListTransactionsForMultipleOrdersResponse$1, ListTransactionsForMultipleOrdersResponse>;
-declare function addPayments(): __PublicMethodMetaInfo<'POST', {
-    orderId: string;
-}, AddPaymentsRequest$1, AddPaymentsRequest, AddPaymentsResponse$1, AddPaymentsResponse>;
-declare function updatePaymentStatus(): __PublicMethodMetaInfo<'POST', {
-    paymentId: string;
-    orderId: string;
-}, UpdatePaymentStatusRequest$1, UpdatePaymentStatusRequest, UpdatePaymentStatusResponse$1, UpdatePaymentStatusResponse>;
-declare function bulkUpdatePaymentStatuses(): __PublicMethodMetaInfo<'POST', {}, BulkUpdatePaymentStatusesRequest$1, BulkUpdatePaymentStatusesRequest, BulkUpdatePaymentStatusesResponse$1, BulkUpdatePaymentStatusesResponse>;
-declare function updateRefundTransaction(): __PublicMethodMetaInfo<'POST', {
-    orderId: string;
-}, UpdateRefundTransactionRequest$1, UpdateRefundTransactionRequest, UpdateRefundTransactionResponse$1, UpdateRefundTransactionResponse>;
-declare function updatePayments(): __PublicMethodMetaInfo<'POST', {
-    orderId: string;
-}, UpdatePaymentsRequest$1, UpdatePaymentsRequest, UpdatePaymentsResponse$1, UpdatePaymentsResponse>;
-
-export { type __PublicMethodMetaInfo, addPayments, bulkUpdatePaymentStatuses, listTransactionsForMultipleOrders, listTransactionsForSingleOrder, updatePaymentStatus, updatePayments, updateRefundTransaction };