@wix/auto_sdk_ecom_orders 1.0.314 → 1.0.316

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/build/cjs/{ecom-v1-order-orders.universal-C1f2gjpe.d.ts → ecom-v1-order-orders.universal-DXcKuMZ8.d.ts} +1680 -1680
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +82 -80
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +2 -2
  6. package/build/cjs/index.typings.js +82 -80
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1680 -1680
  9. package/build/cjs/meta.js +82 -80
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-C1f2gjpe.d.mts → ecom-v1-order-orders.universal-DXcKuMZ8.d.mts} +1680 -1680
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +82 -80
  14. package/build/es/index.mjs.map +1 -1
  15. package/build/es/index.typings.d.mts +2 -2
  16. package/build/es/index.typings.mjs +82 -80
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1680 -1680
  19. package/build/es/meta.mjs +82 -80
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-Domg4hcP.d.ts → ecom-v1-order-orders.universal-BOZydR9Q.d.ts} +1827 -1815
  22. package/build/internal/cjs/index.d.ts +2 -2
  23. package/build/internal/cjs/index.typings.d.ts +2 -2
  24. package/build/internal/cjs/meta.d.ts +1827 -1815
  25. package/build/internal/es/{ecom-v1-order-orders.universal-Domg4hcP.d.mts → ecom-v1-order-orders.universal-BOZydR9Q.d.mts} +1827 -1815
  26. package/build/internal/es/index.d.mts +2 -2
  27. package/build/internal/es/index.typings.d.mts +2 -2
  28. package/build/internal/es/meta.d.mts +1827 -1815
  29. package/package.json +2 -2
@@ -3196,7 +3196,19 @@ declare enum ChannelType {
3196
3196
  * @documentationMaturity preview
3197
3197
  * @internal
3198
3198
  */
3199
- UCP_AGENTIC_CHECKOUT = "UCP_AGENTIC_CHECKOUT"
3199
+ UCP_AGENTIC_CHECKOUT = "UCP_AGENTIC_CHECKOUT",
3200
+ /**
3201
+ * Meta Agentic Checkout sales channel.
3202
+ * @documentationMaturity preview
3203
+ * @internal
3204
+ */
3205
+ META_AGENTIC_CHECKOUT = "META_AGENTIC_CHECKOUT",
3206
+ /**
3207
+ * Google Agentic Checkout sales channel.
3208
+ * @documentationMaturity preview
3209
+ * @internal
3210
+ */
3211
+ GOOGLE_AGENTIC_CHECKOUT = "GOOGLE_AGENTIC_CHECKOUT"
3200
3212
  }
3201
3213
  /** @enumType */
3202
3214
  type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM' | 'PAYPAL_AGENTIC_CHECKOUT' | 'STRIPE_AGENTIC_CHECKOUT';
@@ -4485,2328 +4497,2328 @@ interface BulkDeleteImportedOrdersResponse {
4485
4497
  */
4486
4498
  jobId?: string;
4487
4499
  }
4488
- interface V1TriggerReindexRequest {
4500
+ interface SendBuyerConfirmationEmailRequest {
4489
4501
  /** @format GUID */
4490
- metasiteId?: string;
4502
+ orderId?: string;
4503
+ }
4504
+ interface SendBuyerConfirmationEmailResponse {
4505
+ }
4506
+ interface SendBuyerPaymentsReceivedEmailRequest {
4491
4507
  /**
4492
4508
  * @minLength 1
4493
4509
  * @maxLength 100
4494
- * @maxSize 100
4495
4510
  */
4496
- orderIds?: string[];
4511
+ orderId?: string;
4497
4512
  }
4498
- interface V1TriggerReindexResponse {
4513
+ interface SendBuyerPaymentsReceivedEmailResponse {
4499
4514
  }
4500
- interface V1TriggerReindexOrderRequest {
4501
- /** @format GUID */
4502
- metasiteId?: string;
4515
+ interface SendBuyerPickupConfirmationEmailRequest {
4503
4516
  /**
4504
4517
  * @minLength 1
4505
4518
  * @maxLength 100
4506
4519
  */
4507
4520
  orderId?: string;
4508
4521
  }
4509
- interface PreparePaymentCollectionRequest {
4522
+ interface SendBuyerPickupConfirmationEmailResponse {
4523
+ }
4524
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
4525
+ /**
4526
+ * IDs of orders to send pickup emails for.
4527
+ * @minSize 1
4528
+ * @maxSize 300
4529
+ */
4530
+ orderIds?: string[];
4531
+ }
4532
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
4533
+ }
4534
+ interface SendBuyerShippingConfirmationEmailRequest {
4510
4535
  /**
4511
- * Ecom order ID.
4512
4536
  * @minLength 1
4513
4537
  * @maxLength 100
4514
4538
  */
4515
- ecomOrderId: string;
4516
- /** Amount to collect */
4517
- amount: Price;
4539
+ orderId?: string;
4540
+ }
4541
+ interface SendBuyerShippingConfirmationEmailResponse {
4542
+ }
4543
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
4518
4544
  /**
4519
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4520
- * Existing payment gateway order will be updated with a new amount.
4521
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4545
+ * IDs of orders to send pickup emails for.
4546
+ * @minSize 1
4547
+ * @maxSize 300
4522
4548
  */
4523
- paymentGatewayOrderId?: string | null;
4549
+ orderIds?: string[];
4550
+ }
4551
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
4552
+ }
4553
+ interface SendMerchantOrderReceivedNotificationRequest {
4524
4554
  /**
4525
- * Whether to delay capture of the payment.
4526
- * Default: false
4527
- * @deprecated Whether to delay capture of the payment.
4528
- * Default: false
4529
- * @replacedBy delayed_capture_settings.scheduled_action
4530
- * @targetRemovalDate 2024-09-30
4555
+ * @minLength 1
4556
+ * @maxLength 100
4531
4557
  */
4532
- delayedCapture?: boolean;
4558
+ orderId?: string;
4559
+ }
4560
+ interface SendMerchantOrderReceivedNotificationResponse {
4561
+ }
4562
+ interface SendCancelRefundEmailRequest {
4533
4563
  /**
4534
- * Specifies whether payment collection is initiated by Merchant or User of User
4535
- * Default: `true`
4536
- * @internal
4564
+ * The ID of order that is canceled/refunded
4565
+ * @minLength 1
4566
+ * @maxLength 100
4537
4567
  */
4538
- merchantInitiated?: boolean | null;
4568
+ orderId?: string;
4539
4569
  /**
4540
- * Redirect urls which are used to return buyer to third party system.
4541
- * @internal
4570
+ * Personal note added to the email (optional)
4571
+ * @minLength 1
4572
+ * @maxLength 1000
4542
4573
  */
4543
- redirectUrls?: RedirectUrls;
4544
- /** Delayed capture payment settings */
4545
- delayedCaptureSettings?: DelayedCaptureSettings;
4546
- }
4547
- interface RedirectUrls {
4574
+ customMessage?: string | null;
4575
+ /** Refund amount */
4576
+ refundAmount?: Price;
4548
4577
  /**
4549
- * URL to redirect buyer in case of approved (successful) transaction
4550
- * @format WEB_URL
4578
+ * Refund ID. (Optional)
4579
+ * @format GUID
4551
4580
  */
4552
- successUrl?: string | null;
4581
+ refundId?: string | null;
4582
+ }
4583
+ interface SendCancelRefundEmailResponse {
4584
+ }
4585
+ interface SendRefundEmailRequest {
4553
4586
  /**
4554
- * URL to redirect buyer in case of buyer canceled the transaction
4555
- * @format WEB_URL
4587
+ * The ID of order that is refunded
4588
+ * @format GUID
4556
4589
  */
4557
- cancelUrl?: string | null;
4590
+ orderId?: string;
4558
4591
  /**
4559
- * URL to redirect buyer in case of failed/rejected transaction
4560
- * @format WEB_URL
4592
+ * Refund ID
4593
+ * @format GUID
4561
4594
  */
4562
- errorUrl?: string | null;
4595
+ refundId?: string;
4563
4596
  /**
4564
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4565
- * @format WEB_URL
4597
+ * Personal note added to the email (optional)
4598
+ * @minLength 1
4599
+ * @maxLength 1000
4566
4600
  */
4567
- pendingUrl?: string | null;
4601
+ customMessage?: string | null;
4568
4602
  }
4569
- interface DelayedCaptureSettings {
4570
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4571
- scheduledAction?: ScheduledActionWithLiterals;
4572
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4573
- delayDuration?: Duration;
4603
+ interface SendRefundEmailResponse {
4574
4604
  }
4575
- declare enum ScheduledAction {
4576
- /** Whether payment will be auto-voided when duration passes */
4577
- VOID = "VOID",
4578
- /** Whether payment will be auto-captured when duration passes */
4579
- CAPTURE = "CAPTURE"
4605
+ interface SendFulfillmentEmailRequest {
4606
+ /** @format GUID */
4607
+ orderId?: string;
4608
+ /** @format GUID */
4609
+ fulfillerId?: string;
4580
4610
  }
4581
- /** @enumType */
4582
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4583
- interface Duration {
4611
+ interface SendFulfillmentEmailResponse {
4612
+ }
4613
+ interface SendMerchantOrderReceivedPushRequest {
4584
4614
  /**
4585
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4586
- * @min 1
4615
+ * @minLength 1
4616
+ * @maxLength 100
4587
4617
  */
4588
- count?: number;
4589
- /** Duration unit: MINUTES, HOURS and DAYS */
4590
- unit?: DurationUnitWithLiterals;
4618
+ orderId?: string;
4591
4619
  }
4592
- declare enum DurationUnit {
4593
- MINUTES = "MINUTES",
4594
- HOURS = "HOURS",
4595
- DAYS = "DAYS"
4620
+ interface SendMerchantOrderReceivedPushResponse {
4621
+ }
4622
+ interface PreviewEmailByTypeRequest {
4623
+ emailType?: PreviewEmailTypeWithLiterals;
4624
+ }
4625
+ declare enum PreviewEmailType {
4626
+ ORDER_PLACED = "ORDER_PLACED",
4627
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4628
+ ORDER_SHIPPED = "ORDER_SHIPPED",
4629
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4596
4630
  }
4597
4631
  /** @enumType */
4598
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4599
- interface PreparePaymentCollectionResponse {
4600
- /** Payment gateway order id which is associated with given payment */
4601
- paymentGatewayOrderId?: string;
4632
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4633
+ interface PreviewEmailByTypeResponse {
4634
+ emailPreview?: string;
4602
4635
  }
4603
- interface GetPaymentCollectabilityStatusRequest {
4636
+ interface PreviewRefundEmailRequest {
4604
4637
  /**
4605
- * Ecom order ID.
4606
4638
  * @minLength 1
4607
4639
  * @maxLength 100
4608
4640
  */
4609
- ecomOrderId: string;
4610
- }
4611
- interface GetPaymentCollectabilityStatusResponse {
4612
- /** Payment collectability status */
4613
- status?: PaymentCollectabilityStatusWithLiterals;
4614
- /** Collectable order amount */
4615
- amount?: Price;
4641
+ orderId?: string;
4642
+ /** Refund amount */
4643
+ refundAmount?: Price;
4644
+ /** Refund business details */
4645
+ details?: RefundDetails;
4616
4646
  /**
4617
- * Whether authorization supported
4618
- * @internal
4647
+ * Personal note added to the email (optional)
4648
+ * @minLength 1
4649
+ * @maxLength 1000
4619
4650
  */
4620
- authorizationSupported?: boolean;
4651
+ customMessage?: string | null;
4621
4652
  /**
4622
- * Whether custom amount is supported for payment collection
4623
- * @internal
4653
+ * Refund ID. (Optional)
4654
+ * @format GUID
4624
4655
  */
4625
- customAmountSupported?: boolean;
4626
- }
4627
- declare enum PaymentCollectabilityStatus {
4628
- UNKNOWN = "UNKNOWN",
4629
- COLLECTABLE = "COLLECTABLE",
4630
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4631
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4632
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4633
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4634
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4635
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4636
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4637
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4638
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4639
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4640
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4656
+ refundId?: string | null;
4641
4657
  }
4642
- /** @enumType */
4643
- type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
4644
- interface RecordManuallyCollectedPaymentRequest {
4658
+ /** Business model of a refund request */
4659
+ interface RefundDetails {
4645
4660
  /**
4646
- * Order ID.
4647
- * @minLength 1
4648
- * @maxLength 100
4661
+ * Order line item IDs and quantities that were refunded.
4662
+ * @maxSize 300
4649
4663
  */
4650
- orderId: string;
4651
- /** Amount to be recorded as approved manual payment for given order */
4652
- amount: Price;
4664
+ items?: RefundItem[];
4665
+ /** Whether the shipping fee was also refunded. */
4666
+ shippingIncluded?: boolean;
4653
4667
  /**
4654
- * Payment method name provided by user.
4655
- *
4656
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4657
- * @internal
4668
+ * Reason for the refund, provided by customer (optional).
4669
+ * @maxLength 200
4658
4670
  */
4659
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4660
- }
4661
- /**
4662
- * User-defined payment method name.
4663
- * Allows specifying either a predefined type or a custom name.
4664
- */
4665
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4666
- /** Predefined payment method. */
4667
- predefined?: PredefinedPaymentMethodWithLiterals;
4671
+ reason?: string | null;
4668
4672
  /**
4669
- * Custom payment method name provided by user.
4670
- *
4671
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4672
- * @minLength 1
4673
- * @maxLength 150
4674
- */
4675
- custom?: string | null;
4676
- }
4677
- /** @oneof */
4678
- interface UserDefinedPaymentMethodNameKindOneOf {
4679
- /** Predefined payment method. */
4680
- predefined?: PredefinedPaymentMethodWithLiterals;
4673
+ * Line items that were refunded.
4674
+ * @maxSize 300
4675
+ */
4676
+ lineItems?: LineItemRefund[];
4681
4677
  /**
4682
- * Custom payment method name provided by user.
4683
- *
4684
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4685
- * @minLength 1
4686
- * @maxLength 150
4678
+ * Additional fees that were refunded.
4679
+ * @maxSize 100
4687
4680
  */
4688
- custom?: string | null;
4689
- }
4690
- /** Predefined payment method types for offline/manual payments. */
4691
- declare enum PredefinedPaymentMethod {
4692
- /** Cash payment. */
4693
- CASH = "CASH",
4694
- /** Bank transfer. */
4695
- BANK_TRANSFER = "BANK_TRANSFER",
4696
- /** Payment by check. */
4697
- CHECK = "CHECK"
4698
- }
4699
- /** @enumType */
4700
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4701
- interface RecordManuallyCollectedPaymentResponse {
4681
+ additionalFees?: AdditionalFeeRefund[];
4682
+ /** Shipping amount that was refunded. */
4683
+ shipping?: ShippingRefund;
4702
4684
  }
4703
- interface MarkOrderAsPaidRequest {
4685
+ interface RefundItem {
4704
4686
  /**
4705
- * Ecom order ID.
4706
- * @minLength 1
4707
- * @maxLength 100
4687
+ * Line item ID the refunded line item.
4688
+ * @format GUID
4708
4689
  */
4709
- ecomOrderId: string;
4690
+ lineItemId?: string;
4710
4691
  /**
4711
- * Payment method name provided by user.
4712
- *
4713
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4714
- * @internal
4692
+ * Line item quantity refunded.
4693
+ * @min 1
4694
+ * @max 100000
4715
4695
  */
4716
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4717
- }
4718
- interface MarkOrderAsPaidResponse {
4719
- /** Updated order. */
4720
- order?: Order;
4696
+ quantity?: number;
4721
4697
  }
4722
- interface BulkMarkOrdersAsPaidRequest {
4698
+ interface LineItemRefund {
4723
4699
  /**
4724
- * IDs of orders to mark as paid.
4725
- * @minSize 1
4726
- * @maxSize 100
4727
- * @minLength 1
4728
- * @maxLength 100
4700
+ * Line item ID.
4701
+ * @format GUID
4702
+ * @immutable
4729
4703
  */
4730
- ecomOrderIds: string[];
4731
- }
4732
- interface BulkMarkOrdersAsPaidResponse {
4704
+ lineItemId?: string;
4733
4705
  /**
4734
- * Items updated by the bulk action.
4735
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4706
+ * Refund quantity.
4707
+ * @min 1
4708
+ * @max 100000
4709
+ * @immutable
4736
4710
  */
4737
- results?: BulkOrderResult[];
4738
- /** Bulk action metadata. */
4739
- bulkActionMetadata?: BulkActionMetadata;
4711
+ quantity?: number;
4740
4712
  }
4741
- interface BulkOrderResult {
4742
- /** Item metadata. */
4743
- itemMetadata?: ItemMetadata;
4713
+ interface AdditionalFeeRefund {
4744
4714
  /**
4745
- * Updated order.
4746
- *
4747
- * Returned when `returnFullEntity = true`.
4715
+ * Additional fee ID.
4716
+ * @format GUID
4717
+ * @immutable
4748
4718
  */
4749
- item?: Order;
4750
- }
4751
- interface ItemMetadata {
4752
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4753
- _id?: string | null;
4754
- /** Index of the item within the request array. Allows for correlation between request and response items. */
4755
- originalIndex?: number;
4756
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4757
- success?: boolean;
4758
- /** Details about the error in case of failure. */
4759
- error?: ApplicationError;
4760
- }
4761
- interface ApplicationError {
4762
- /** Error code. */
4763
- code?: string;
4764
- /** Description of the error. */
4765
- description?: string;
4766
- /** Data related to the error. */
4767
- data?: Record<string, any> | null;
4768
- }
4769
- interface BulkActionMetadata {
4770
- /** Number of items that were successfully processed. */
4771
- totalSuccesses?: number;
4772
- /** Number of items that couldn't be processed. */
4773
- totalFailures?: number;
4774
- /** Number of failures without details because detailed failure threshold was exceeded. */
4775
- undetailedFailures?: number;
4776
- }
4777
- interface GetRefundabilityStatusRequest {
4719
+ additionalFeeId?: string;
4778
4720
  /**
4779
- * Order ID.
4780
- * @minLength 1
4781
- * @maxLength 100
4721
+ * Refund amount.
4722
+ * @immutable
4782
4723
  */
4783
- ecomOrderId: string;
4724
+ amount?: Price;
4784
4725
  }
4785
- interface GetRefundabilityStatusResponse {
4786
- /**
4787
- * Refundability details.
4788
- * @maxSize 300
4789
- */
4790
- refundabilities?: Refundability[];
4726
+ interface ShippingRefund {
4791
4727
  /**
4792
- * Whether the order supports refunding per item.
4793
- * @deprecated
4728
+ * Refund amount.
4729
+ * @immutable
4794
4730
  */
4795
- refundablePerItem?: boolean;
4796
- }
4797
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4798
- /** Reason why payment is not refundable. */
4799
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4800
- /** Reason why payment is only refundable manually. */
4801
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4802
- /** Payment ID. */
4803
- paymentId?: string;
4804
- /** Payment refundability status. */
4805
- refundabilityStatus?: RefundableStatusWithLiterals;
4806
- /** Link to payment provider dashboard. */
4807
- providerLink?: string | null;
4808
- }
4809
- /** @oneof */
4810
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
4811
- /** Reason why payment is not refundable. */
4812
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4813
- /** Reason why payment is only refundable manually. */
4814
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4815
- }
4816
- declare enum RefundableStatus {
4817
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
4818
- MANUAL = "MANUAL",
4819
- REFUNDABLE = "REFUNDABLE"
4820
- }
4821
- /** @enumType */
4822
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4823
- declare enum NonRefundableReason {
4824
- NONE = "NONE",
4825
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
4826
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4827
- INTERNAL_ERROR = "INTERNAL_ERROR",
4828
- NOT_PAID = "NOT_PAID",
4829
- ACCESS_DENIED = "ACCESS_DENIED",
4830
- ZERO_PRICE = "ZERO_PRICE",
4831
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4832
- PENDING_REFUND = "PENDING_REFUND",
4833
- FORBIDDEN = "FORBIDDEN",
4834
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4835
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
4836
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4731
+ amount?: Price;
4837
4732
  }
4838
- /** @enumType */
4839
- type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
4840
- declare enum ManuallyRefundableReason {
4841
- EXPIRED = "EXPIRED",
4842
- NOT_SUPPORTED = "NOT_SUPPORTED",
4843
- OFFLINE = "OFFLINE",
4844
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4733
+ interface PreviewRefundEmailResponse {
4734
+ emailPreview?: string;
4845
4735
  }
4846
- /** @enumType */
4847
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4848
- interface CreatePaymentGatewayOrderRequest {
4736
+ interface PreviewCancelEmailRequest {
4849
4737
  /**
4850
- * Ecom order ID.
4851
4738
  * @minLength 1
4852
4739
  * @maxLength 100
4853
4740
  */
4854
- ecomOrderId: string;
4855
- /** Information about the user who initiated the payment. */
4856
- chargedBy?: ChargedBy;
4857
- /**
4858
- * Whether to delay capture of the payment.
4859
- *
4860
- * Default: false
4861
- * @internal
4862
- */
4863
- delayedCapture?: boolean;
4864
- }
4865
- interface ChargedBy {
4866
- /**
4867
- * ID - id of the user who initiated the payment
4868
- * @format GUID
4869
- */
4870
- _id?: string;
4741
+ orderId?: string;
4871
4742
  /**
4872
- * Full name - name of the user who initiated the payment
4743
+ * Personal note added to the email (optional)
4873
4744
  * @minLength 1
4874
- * @maxLength 200
4745
+ * @maxLength 1000
4875
4746
  */
4876
- fullName?: string | null;
4747
+ customMessage?: string | null;
4877
4748
  }
4878
- interface CreatePaymentGatewayOrderResponse {
4879
- /** ID of the order created in the payment gateway */
4880
- paymentGatewayOrderId?: string;
4749
+ interface PreviewCancelEmailResponse {
4750
+ emailPreview?: string;
4881
4751
  }
4882
- interface ChargeMembershipsRequest {
4752
+ interface PreviewCancelRefundEmailRequest {
4883
4753
  /**
4884
- * Order ID.
4885
4754
  * @minLength 1
4886
4755
  * @maxLength 100
4887
4756
  */
4888
- ecomOrderId: string;
4889
- /**
4890
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4891
- * but a user which is using the membership on behalf of the a member
4892
- * @format GUID
4893
- */
4894
- memberId: string;
4895
- /**
4896
- * List of items to be paid by memberships
4897
- * @minSize 1
4898
- * @maxSize 300
4899
- */
4900
- membershipCharges?: MembershipChargeItem[];
4901
- }
4902
- interface MembershipChargeItem {
4757
+ orderId?: string;
4903
4758
  /**
4904
- * The id of used membership
4759
+ * Personal note added to the email (optional)
4905
4760
  * @minLength 1
4906
- * @maxLength 100
4761
+ * @maxLength 1000
4907
4762
  */
4908
- membershipId?: string;
4763
+ customMessage?: string | null;
4764
+ /** Refund amount */
4765
+ refundAmount?: Price;
4909
4766
  /**
4910
- * ID of the application providing this payment option
4767
+ * Refund ID. (Optional)
4911
4768
  * @format GUID
4912
4769
  */
4913
- appId?: string;
4914
- /** The name of used membership */
4915
- membershipName?: MembershipName;
4916
- /** Additional data about this membership */
4917
- membershipAdditionalData?: Record<string, any> | null;
4918
- /** Catalog and item reference info. */
4919
- catalogReference?: CatalogReference;
4920
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
4921
- serviceProperties?: ServiceProperties;
4922
- /**
4923
- * Usually would be the same as catalogReference.catalogItemId
4924
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
4925
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4926
- * @minLength 1
4927
- * @maxLength 36
4928
- */
4929
- rootCatalogItemId?: string | null;
4930
- /**
4931
- * line item id of Checkout/Order line item
4932
- * @minLength 1
4933
- * @maxLength 100
4934
- */
4935
- lineItemId?: string;
4770
+ refundId?: string | null;
4936
4771
  }
4937
- interface MembershipName {
4938
- /**
4939
- * Membership name in the site's original language.
4940
- * @maxLength 100
4941
- */
4942
- original?: string;
4943
- /**
4944
- * Membership name translated into the buyer's language.
4945
- *
4946
- * Default: The value of `original`
4947
- * @maxLength 100
4948
- */
4949
- translated?: string | null;
4772
+ interface PreviewCancelRefundEmailResponse {
4773
+ emailPreview?: string;
4950
4774
  }
4951
- interface ChargeMembershipsResponse {
4775
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
4952
4776
  }
4953
- interface TriggerRefundRequest {
4954
- /**
4955
- * The order this refund related to
4956
- * @minLength 1
4957
- * @maxLength 100
4958
- */
4959
- ecomOrderId: string;
4960
- /**
4961
- * Refund operations information
4962
- * @minSize 1
4963
- * @maxSize 1
4964
- */
4965
- payments: PaymentRefund[];
4966
- /** Business model of a refund */
4967
- details?: RefundDetails;
4968
- /** Side effect details related to refund */
4969
- sideEffects?: RefundSideEffects;
4777
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
4778
+ emailPreview?: string;
4970
4779
  }
4971
- interface PaymentRefund {
4972
- /**
4973
- * Specific payment within the order to refund
4974
- * @format GUID
4975
- */
4976
- paymentId?: string;
4977
- /** Refund amount. Not relevant for membership and gift card refunds. */
4978
- amount?: Price;
4979
- /**
4980
- * Whether refund is made externally and manually (on the payment provider's side)
4981
- * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
4982
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4983
- */
4984
- externalRefund?: boolean;
4985
- /**
4986
- * Gateway refund id. When param is present, new refund is not created.
4987
- * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
4988
- * and all side effects from request will be executed.
4989
- * @internal
4990
- * @minLength 1
4991
- * @maxLength 100
4992
- */
4993
- gatewayRefundId?: string | null;
4780
+ interface PreviewBuyerConfirmationEmailRequest {
4994
4781
  }
4995
- /** Business model of a refund request */
4996
- interface RefundDetails {
4997
- /**
4998
- * Order line item IDs and quantities that were refunded.
4999
- * @maxSize 300
5000
- */
5001
- items?: RefundItem[];
5002
- /** Whether the shipping fee was also refunded. */
5003
- shippingIncluded?: boolean;
5004
- /**
5005
- * Reason for the refund, provided by customer (optional).
5006
- * @maxLength 200
5007
- */
5008
- reason?: string | null;
5009
- /**
5010
- * Line items that were refunded.
5011
- * @maxSize 300
5012
- */
5013
- lineItems?: LineItemRefund[];
5014
- /**
5015
- * Additional fees that were refunded.
5016
- * @maxSize 100
5017
- */
5018
- additionalFees?: AdditionalFeeRefund[];
5019
- /** Shipping amount that was refunded. */
5020
- shipping?: ShippingRefund;
4782
+ interface PreviewBuyerConfirmationEmailResponse {
4783
+ emailPreview?: string;
5021
4784
  }
5022
- interface RefundItem {
5023
- /**
5024
- * Line item ID the refunded line item.
5025
- * @format GUID
5026
- */
5027
- lineItemId?: string;
5028
- /**
5029
- * Line item quantity refunded.
5030
- * @min 1
5031
- * @max 100000
5032
- */
5033
- quantity?: number;
4785
+ interface PreviewBuyerPickupConfirmationEmailRequest {
5034
4786
  }
5035
- interface LineItemRefund {
5036
- /**
5037
- * Line item ID.
5038
- * @format GUID
5039
- * @immutable
5040
- */
5041
- lineItemId?: string;
5042
- /**
5043
- * Refund quantity.
5044
- * @min 1
5045
- * @max 100000
5046
- * @immutable
5047
- */
5048
- quantity?: number;
4787
+ interface PreviewBuyerPickupConfirmationEmailResponse {
4788
+ emailPreview?: string;
5049
4789
  }
5050
- interface AdditionalFeeRefund {
4790
+ interface PreviewShippingConfirmationEmailRequest {
4791
+ }
4792
+ interface PreviewShippingConfirmationEmailResponse {
4793
+ emailPreview?: string;
4794
+ }
4795
+ interface PreviewResendDownloadLinksEmailRequest {
4796
+ }
4797
+ interface PreviewResendDownloadLinksEmailResponse {
4798
+ emailPreview?: string;
4799
+ }
4800
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4801
+ /** Emitted on a meta site creation. */
4802
+ siteCreated?: SiteCreated;
4803
+ /** Emitted on a meta site transfer completion. */
4804
+ siteTransferred?: SiteTransferred;
4805
+ /** Emitted on a meta site deletion. */
4806
+ siteDeleted?: SiteDeleted;
4807
+ /** Emitted on a meta site restoration. */
4808
+ siteUndeleted?: SiteUndeleted;
4809
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4810
+ sitePublished?: SitePublished;
4811
+ /** Emitted on a meta site unpublish. */
4812
+ siteUnpublished?: SiteUnpublished;
4813
+ /** Emitted when meta site is marked as template. */
4814
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4815
+ /** Emitted when meta site is marked as a WixSite. */
4816
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4817
+ /** Emitted when an application is provisioned (installed). */
4818
+ serviceProvisioned?: ServiceProvisioned;
4819
+ /** Emitted when an application is removed (uninstalled). */
4820
+ serviceRemoved?: ServiceRemoved;
4821
+ /** Emitted when meta site name (URL slug) is changed. */
4822
+ siteRenamedPayload?: SiteRenamed;
4823
+ /** Emitted when meta site was permanently deleted. */
4824
+ hardDeleted?: SiteHardDeleted;
4825
+ /** Emitted on a namespace change. */
4826
+ namespaceChanged?: NamespaceChanged;
4827
+ /** Emitted when Studio is attached. */
4828
+ studioAssigned?: StudioAssigned;
4829
+ /** Emitted when Studio is detached. */
4830
+ studioUnassigned?: StudioUnassigned;
5051
4831
  /**
5052
- * Additional fee ID.
5053
- * @format GUID
5054
- * @immutable
4832
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4833
+ * the actual URL.
4834
+ *
4835
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4836
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5055
4837
  */
5056
- additionalFeeId?: string;
4838
+ urlChanged?: SiteUrlChanged;
4839
+ /** Site is marked as PurgedExternally */
4840
+ sitePurgedExternally?: SitePurgedExternally;
4841
+ /** Emitted when Odeditor is attached. */
4842
+ odeditorAssigned?: OdeditorAssigned;
4843
+ /** Emitted when Odeditor is detached. */
4844
+ odeditorUnassigned?: OdeditorUnassigned;
4845
+ /** Emitted when Picasso is attached. */
4846
+ picassoAssigned?: PicassoAssigned;
4847
+ /** Emitted when Picasso is detached. */
4848
+ picassoUnassigned?: PicassoUnassigned;
4849
+ /** Emitted when Wixel is attached. */
4850
+ wixelAssigned?: WixelAssigned;
4851
+ /** Emitted when Wixel is detached. */
4852
+ wixelUnassigned?: WixelUnassigned;
4853
+ /** Emitted when StudioTwo is attached. */
4854
+ studioTwoAssigned?: StudioTwoAssigned;
4855
+ /** Emitted when StudioTwo is detached. */
4856
+ studioTwoUnassigned?: StudioTwoUnassigned;
4857
+ /** Emitted when media from user domain is enabled. */
4858
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4859
+ /** Emitted when media from user domain is disabled. */
4860
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4861
+ /** Emitted when Editorless is attached. */
4862
+ editorlessAssigned?: EditorlessAssigned;
4863
+ /** Emitted when Editorless is detached. */
4864
+ editorlessUnassigned?: EditorlessUnassigned;
5057
4865
  /**
5058
- * Refund amount.
5059
- * @immutable
4866
+ * A meta site id.
4867
+ * @format GUID
5060
4868
  */
5061
- amount?: Price;
5062
- }
5063
- interface ShippingRefund {
4869
+ metaSiteId?: string;
4870
+ /** A meta site version. Monotonically increasing. */
4871
+ version?: string;
4872
+ /** A timestamp of the event. */
4873
+ timestamp?: string;
5064
4874
  /**
5065
- * Refund amount.
5066
- * @immutable
4875
+ * TODO(meta-site): Change validation once validations are disabled for consumers
4876
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4877
+ * @maxSize 4000
5067
4878
  */
5068
- amount?: Price;
4879
+ assets?: Asset[];
5069
4880
  }
5070
- interface RefundSideEffects {
5071
- /** Inventory restock details as part of this refund. */
5072
- restockInfo?: RestockInfo;
5073
- /** Whether to send a refund confirmation email to the customer. */
5074
- sendOrderRefundedEmail?: boolean;
4881
+ /** @oneof */
4882
+ interface MetaSiteSpecialEventPayloadOneOf {
4883
+ /** Emitted on a meta site creation. */
4884
+ siteCreated?: SiteCreated;
4885
+ /** Emitted on a meta site transfer completion. */
4886
+ siteTransferred?: SiteTransferred;
4887
+ /** Emitted on a meta site deletion. */
4888
+ siteDeleted?: SiteDeleted;
4889
+ /** Emitted on a meta site restoration. */
4890
+ siteUndeleted?: SiteUndeleted;
4891
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4892
+ sitePublished?: SitePublished;
4893
+ /** Emitted on a meta site unpublish. */
4894
+ siteUnpublished?: SiteUnpublished;
4895
+ /** Emitted when meta site is marked as template. */
4896
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4897
+ /** Emitted when meta site is marked as a WixSite. */
4898
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4899
+ /** Emitted when an application is provisioned (installed). */
4900
+ serviceProvisioned?: ServiceProvisioned;
4901
+ /** Emitted when an application is removed (uninstalled). */
4902
+ serviceRemoved?: ServiceRemoved;
4903
+ /** Emitted when meta site name (URL slug) is changed. */
4904
+ siteRenamedPayload?: SiteRenamed;
4905
+ /** Emitted when meta site was permanently deleted. */
4906
+ hardDeleted?: SiteHardDeleted;
4907
+ /** Emitted on a namespace change. */
4908
+ namespaceChanged?: NamespaceChanged;
4909
+ /** Emitted when Studio is attached. */
4910
+ studioAssigned?: StudioAssigned;
4911
+ /** Emitted when Studio is detached. */
4912
+ studioUnassigned?: StudioUnassigned;
5075
4913
  /**
5076
- * Custom message added to the refund confirmation email.
5077
- * @minLength 1
5078
- * @maxLength 1000
4914
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4915
+ * the actual URL.
4916
+ *
4917
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4918
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5079
4919
  */
5080
- customMessage?: string | null;
4920
+ urlChanged?: SiteUrlChanged;
4921
+ /** Site is marked as PurgedExternally */
4922
+ sitePurgedExternally?: SitePurgedExternally;
4923
+ /** Emitted when Odeditor is attached. */
4924
+ odeditorAssigned?: OdeditorAssigned;
4925
+ /** Emitted when Odeditor is detached. */
4926
+ odeditorUnassigned?: OdeditorUnassigned;
4927
+ /** Emitted when Picasso is attached. */
4928
+ picassoAssigned?: PicassoAssigned;
4929
+ /** Emitted when Picasso is detached. */
4930
+ picassoUnassigned?: PicassoUnassigned;
4931
+ /** Emitted when Wixel is attached. */
4932
+ wixelAssigned?: WixelAssigned;
4933
+ /** Emitted when Wixel is detached. */
4934
+ wixelUnassigned?: WixelUnassigned;
4935
+ /** Emitted when StudioTwo is attached. */
4936
+ studioTwoAssigned?: StudioTwoAssigned;
4937
+ /** Emitted when StudioTwo is detached. */
4938
+ studioTwoUnassigned?: StudioTwoUnassigned;
4939
+ /** Emitted when media from user domain is enabled. */
4940
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4941
+ /** Emitted when media from user domain is disabled. */
4942
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4943
+ /** Emitted when Editorless is attached. */
4944
+ editorlessAssigned?: EditorlessAssigned;
4945
+ /** Emitted when Editorless is detached. */
4946
+ editorlessUnassigned?: EditorlessUnassigned;
5081
4947
  }
5082
- interface RestockInfo {
5083
- /** Restock type. */
5084
- type?: RestockTypeWithLiterals;
4948
+ interface Asset {
5085
4949
  /**
5086
- * Deprecated, use items instead
5087
- * @internal
5088
- * @maxSize 300
5089
- * @deprecated
4950
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4951
+ * @maxLength 36
5090
4952
  */
5091
- lineItemIds?: string[];
4953
+ appDefId?: string;
5092
4954
  /**
5093
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5094
- * @maxSize 300
4955
+ * An instance id. For legacy reasons may be UUID or a string.
4956
+ * @maxLength 200
5095
4957
  */
5096
- items?: RestockItem[];
4958
+ instanceId?: string;
4959
+ /** An application state. */
4960
+ state?: StateWithLiterals;
5097
4961
  }
5098
- declare enum RestockType {
5099
- NO_ITEMS = "NO_ITEMS",
5100
- ALL_ITEMS = "ALL_ITEMS",
5101
- SOME_ITEMS = "SOME_ITEMS"
4962
+ declare enum State {
4963
+ UNKNOWN = "UNKNOWN",
4964
+ ENABLED = "ENABLED",
4965
+ DISABLED = "DISABLED",
4966
+ PENDING = "PENDING",
4967
+ DEMO = "DEMO"
5102
4968
  }
5103
4969
  /** @enumType */
5104
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5105
- interface RestockItem {
4970
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
4971
+ interface SiteCreated {
5106
4972
  /**
5107
- * ID of the line item being restocked.
4973
+ * A template identifier (empty if not created from a template).
4974
+ * @maxLength 36
4975
+ */
4976
+ originTemplateId?: string;
4977
+ /**
4978
+ * An account id of the owner.
5108
4979
  * @format GUID
5109
4980
  */
5110
- lineItemId?: string;
4981
+ ownerId?: string;
4982
+ /** A context in which meta site was created. */
4983
+ context?: SiteCreatedContextWithLiterals;
5111
4984
  /**
5112
- * Line item quantity being restocked.
5113
- * @min 1
5114
- * @max 100000
4985
+ * A meta site id from which this site was created.
4986
+ *
4987
+ * In case of a creation from a template it's a template id.
4988
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
4989
+ * @format GUID
5115
4990
  */
5116
- quantity?: number;
4991
+ originMetaSiteId?: string | null;
5117
4992
  /**
5118
- * Per-location breakdown of restock quantities.
5119
- * @internal
5120
- * @maxSize 5
4993
+ * A meta site name (URL slug).
4994
+ * @maxLength 20
5121
4995
  */
5122
- restockLocations?: RestockLocation[];
4996
+ siteName?: string;
4997
+ /** A namespace. */
4998
+ namespace?: NamespaceWithLiterals;
5123
4999
  }
5124
- interface TriggerRefundResponse {
5125
- /** All order's transactions after the refunds were added */
5126
- orderTransactions?: OrderTransactions;
5127
- /** Created refund ID */
5128
- refundId?: string | null;
5129
- /** Payment ID's that the refund execution had failed for */
5130
- failedPaymentIds?: ItemMetadata[];
5000
+ declare enum SiteCreatedContext {
5001
+ /** A valid option, we don't expose all reasons why site might be created. */
5002
+ OTHER = "OTHER",
5003
+ /** A meta site was created from template. */
5004
+ FROM_TEMPLATE = "FROM_TEMPLATE",
5005
+ /** A meta site was created by copying of the transfferred meta site. */
5006
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5007
+ /** A copy of existing meta site. */
5008
+ DUPLICATE = "DUPLICATE",
5009
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5010
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5011
+ /** deprecated A meta site was created for Flash editor. */
5012
+ FLASH = "FLASH"
5131
5013
  }
5132
- /**
5133
- * A record of all payments and refunds associated with an order.
5134
- *
5135
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5136
- */
5137
- interface OrderTransactions {
5014
+ /** @enumType */
5015
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5016
+ declare enum Namespace {
5017
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5018
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5019
+ WIX = "WIX",
5020
+ /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5021
+ SHOUT_OUT = "SHOUT_OUT",
5022
+ /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5023
+ ALBUMS = "ALBUMS",
5024
+ /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5025
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5026
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5027
+ HOTELS = "HOTELS",
5028
+ /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5029
+ CLUBS = "CLUBS",
5030
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5031
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5138
5032
  /**
5139
- * Order ID.
5140
- * @format GUID
5033
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5034
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5141
5035
  */
5142
- orderId?: string;
5036
+ DEV_SITE = "DEV_SITE",
5037
+ /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5038
+ LOGOS = "LOGOS",
5039
+ /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5040
+ VIDEO_MAKER = "VIDEO_MAKER",
5041
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5042
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5043
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5044
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5143
5045
  /**
5144
- * Record of payments made to the merchant.
5145
- * @maxSize 100
5046
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5047
+ *
5048
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
5146
5049
  */
5147
- payments?: Payment[];
5050
+ HTML_DRAFT = "HTML_DRAFT",
5148
5051
  /**
5149
- * Record of refunds made to the buyer.
5150
- * @maxSize 300
5052
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5053
+ * Will be accessible from Site List and will not have a website app.
5054
+ * Once the user attaches a site, the site will become a regular wixsite.
5151
5055
  */
5152
- refunds?: Refund[];
5153
- }
5154
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5155
- /** Regular payment details. */
5156
- regularPaymentDetails?: RegularPaymentDetails;
5157
- /** Gift card payment details. */
5158
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5159
- /** Membership payment details. */
5160
- membershipPaymentDetails?: MembershipPaymentDetails;
5056
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
5057
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5058
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
5059
+ /** It is to be used in the Business First efforts. */
5060
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
5061
+ /** Bookings business flow with no site. */
5062
+ ANYWHERE = "ANYWHERE",
5063
+ /** Namespace for Headless Backoffice with no editor */
5064
+ HEADLESS = "HEADLESS",
5161
5065
  /**
5162
- * Receipt created by Wix
5163
- * @internal
5066
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5067
+ * The site will be used for account level CSM feature for enterprise
5164
5068
  */
5165
- wixReceipt?: WixReceiptInfo;
5069
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5070
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5071
+ RISE = "RISE",
5166
5072
  /**
5167
- * Receipt created by an external system.
5168
- * @internal
5073
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5074
+ * There's a blank site behind the scene but it's blank).
5075
+ * The Mobile company will be the owner of this namespace.
5169
5076
  */
5170
- externalReceipt?: ExternalReceiptInfo;
5171
- /** @internal */
5172
- canceled?: CanceledStatusDetails;
5173
- /** @internal */
5174
- declined?: DeclinedStatusDetails;
5175
- /** @internal */
5176
- voided?: VoidedStatusDetails;
5077
+ BRANDED_FIRST = "BRANDED_FIRST",
5078
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5079
+ NOWNIA = "NOWNIA",
5177
5080
  /**
5178
- * Payment ID.
5179
- * @format GUID
5180
- * @readonly
5081
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
5082
+ * The Partners company owns this namespace.
5181
5083
  */
5182
- _id?: string | null;
5183
- /** 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. */
5184
- _createdDate?: Date | null;
5084
+ UGC_TEMPLATE = "UGC_TEMPLATE",
5085
+ /** Codux Headless Sites */
5086
+ CODUX = "CODUX",
5087
+ /** Bobb - AI Design Creator. */
5088
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5185
5089
  /**
5186
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5187
- * @readonly
5090
+ * Shared Blog Site is a unique single site across Enterprise account,
5091
+ * This site will hold all Blog posts related to the Marketing product.
5188
5092
  */
5189
- _updatedDate?: Date | null;
5190
- /** Payment amount. */
5191
- amount?: Price;
5093
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5094
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5095
+ STANDALONE_FORMS = "STANDALONE_FORMS",
5096
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5097
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
5098
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5099
+ MIMIR = "MIMIR",
5100
+ /** Wix Twins platform. */
5101
+ TWINS = "TWINS",
5102
+ /** Wix Nano. */
5103
+ NANO = "NANO",
5104
+ /** Base44 headless sites. */
5105
+ BASE44 = "BASE44",
5106
+ /** Wix Channels Sites */
5107
+ CHANNELS = "CHANNELS",
5108
+ /** Nautilus platform. */
5109
+ NAUTILUS = "NAUTILUS",
5192
5110
  /**
5193
- * Whether refunds for this payment are disabled.
5194
- * + `true`: This payment is not refundable.
5195
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5111
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5112
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5196
5113
  */
5197
- refundDisabled?: boolean;
5114
+ SYMPHONY = "SYMPHONY",
5115
+ /** Nautilus platform app. */
5116
+ NAUTILUS_APPS = "NAUTILUS_APPS",
5198
5117
  /**
5199
- * Whether receipt generation is allowed for this payment.
5200
- * + `true`: This payment supports receipt generation.
5201
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5202
- * @readonly
5118
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5119
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5203
5120
  */
5204
- supportReceiptGeneration?: boolean;
5205
- /** Details about cash rounding applied to this payment, when relevant. */
5206
- cashRounding?: CashRoundingDetails;
5121
+ VIBU = "VIBU",
5207
5122
  /**
5208
- * Overall payment status.
5209
- *
5210
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5123
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5124
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
5125
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5126
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
5211
5127
  */
5212
- status?: PaymentStatusWithLiterals;
5128
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5213
5129
  /**
5214
- * Detailed payment status information including gateway reason codes and status-specific details.
5215
- * @internal
5130
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
5131
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5216
5132
  */
5217
- paymentStatusDetails?: PaymentStatusDetails;
5133
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5134
+ }
5135
+ /** @enumType */
5136
+ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
5137
+ /** Site transferred to another user. */
5138
+ interface SiteTransferred {
5218
5139
  /**
5219
- * Location where the payment was processed.
5220
- * @internal
5140
+ * A previous owner id (user that transfers meta site).
5221
5141
  * @format GUID
5222
- * @immutable
5223
5142
  */
5224
- locationId?: string | null;
5143
+ oldOwnerId?: string;
5225
5144
  /**
5226
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5145
+ * A new owner id (user that accepts meta site).
5227
5146
  * @format GUID
5228
5147
  */
5229
- chargeCorrelationId?: string | null;
5148
+ newOwnerId?: string;
5230
5149
  }
5231
- /** @oneof */
5232
- interface PaymentPaymentDetailsOneOf {
5233
- /** Regular payment details. */
5234
- regularPaymentDetails?: RegularPaymentDetails;
5235
- /** Gift card payment details. */
5236
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5237
- /** Membership payment details. */
5238
- membershipPaymentDetails?: MembershipPaymentDetails;
5150
+ /** Soft deletion of the meta site. Could be restored. */
5151
+ interface SiteDeleted {
5152
+ /** A deletion context. */
5153
+ deleteContext?: DeleteContext;
5239
5154
  }
5240
- /** @oneof */
5241
- interface PaymentReceiptInfoOneOf {
5155
+ interface DeleteContext {
5156
+ /** When the meta site was deleted. */
5157
+ dateDeleted?: Date | null;
5158
+ /** A status. */
5159
+ deleteStatus?: DeleteStatusWithLiterals;
5242
5160
  /**
5243
- * Receipt created by Wix
5244
- * @internal
5161
+ * A reason (flow).
5162
+ * @maxLength 255
5245
5163
  */
5246
- wixReceipt?: WixReceiptInfo;
5164
+ deleteOrigin?: string;
5247
5165
  /**
5248
- * Receipt created by an external system.
5249
- * @internal
5166
+ * A service that deleted it.
5167
+ * @maxLength 255
5250
5168
  */
5251
- externalReceipt?: ExternalReceiptInfo;
5169
+ initiatorId?: string | null;
5252
5170
  }
5253
- /** @oneof */
5254
- interface PaymentStatusDetailsOneOf {
5255
- /** @internal */
5256
- canceled?: CanceledStatusDetails;
5257
- /** @internal */
5258
- declined?: DeclinedStatusDetails;
5259
- /** @internal */
5260
- voided?: VoidedStatusDetails;
5171
+ declare enum DeleteStatus {
5172
+ UNKNOWN = "UNKNOWN",
5173
+ TRASH = "TRASH",
5174
+ DELETED = "DELETED",
5175
+ PENDING_PURGE = "PENDING_PURGE",
5176
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5261
5177
  }
5262
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5263
- /** Credit card details. */
5264
- creditCardDetails?: CreditCardPaymentMethodDetails;
5178
+ /** @enumType */
5179
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5180
+ /** Restoration of the meta site. */
5181
+ interface SiteUndeleted {
5182
+ }
5183
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
5184
+ interface SitePublished {
5185
+ }
5186
+ interface SiteUnpublished {
5265
5187
  /**
5266
- * Wix Payments order ID.
5267
- * @maxLength 100
5188
+ * A list of URLs previously associated with the meta site.
5189
+ * @maxLength 4000
5190
+ * @maxSize 10000
5268
5191
  */
5269
- paymentOrderId?: string | null;
5192
+ urls?: string[];
5193
+ }
5194
+ interface SiteMarkedAsTemplate {
5195
+ }
5196
+ interface SiteMarkedAsWixSite {
5197
+ }
5198
+ /**
5199
+ * Represents a service provisioned a site.
5200
+ *
5201
+ * Note on `origin_instance_id`:
5202
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5203
+ * This is because of the following scenario:
5204
+ *
5205
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
5206
+ * such as a product catalog. When you create a site from this template, you inherit this
5207
+ * default product catalog. However, if the template's product catalog is modified,
5208
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
5209
+ * your site remains consistent with what you initially received and does not include any
5210
+ * changes made to the original template afterward.
5211
+ * To ensure this, the TPA on the template gets a new instance_id.
5212
+ */
5213
+ interface ServiceProvisioned {
5270
5214
  /**
5271
- * Payment gateway's transaction ID.
5272
- * This field is only returned when the value of `offline_payment` is `false`.
5273
- * @maxLength 100
5215
+ * Either UUID or EmbeddedServiceType.
5216
+ * @maxLength 36
5274
5217
  */
5275
- gatewayTransactionId?: string | null;
5218
+ appDefId?: string;
5276
5219
  /**
5277
- * Payment method.
5278
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5279
- * Non-exhaustive list of supported values:
5280
- * + `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`
5281
- * @maxLength 150
5282
- * @deprecated Payment method.
5283
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5284
- * Non-exhaustive list of supported values:
5285
- * + `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`
5286
- * @replacedBy payment_method_name
5287
- * @targetRemovalDate 2026-07-01
5220
+ * Not only UUID. Something here could be something weird.
5221
+ * @maxLength 36
5288
5222
  */
5289
- paymentMethod?: string | null;
5223
+ instanceId?: string;
5290
5224
  /**
5291
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5292
- * @maxLength 100
5225
+ * An instance id from which this instance is originated.
5226
+ * @maxLength 36
5293
5227
  */
5294
- providerTransactionId?: string | null;
5295
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5296
- offlinePayment?: boolean;
5228
+ originInstanceId?: string;
5297
5229
  /**
5298
- * Payment status.
5299
- * @deprecated Payment status.
5300
- * @replacedBy payment.status
5301
- * @targetRemovalDate 2026-11-01
5230
+ * A version.
5231
+ * @maxLength 500
5302
5232
  */
5303
- status?: TransactionStatusWithLiterals;
5304
- /** Whether there is a payment agreement that allows for future charges. */
5305
- savedPaymentMethod?: boolean;
5306
- /** Authorization details. */
5307
- authorizationDetails?: AuthorizationDetails;
5233
+ version?: string | null;
5308
5234
  /**
5309
- * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
5310
- * @internal
5311
- * @maxLength 300
5235
+ * The origin meta site id
5236
+ * @format GUID
5312
5237
  */
5313
- paymentProvider?: string | null;
5238
+ originMetaSiteId?: string | null;
5239
+ }
5240
+ interface ServiceRemoved {
5314
5241
  /**
5315
- * Record of chargebacks made by the buyer.
5316
- * @maxSize 6
5242
+ * Either UUID or EmbeddedServiceType.
5243
+ * @maxLength 36
5317
5244
  */
5318
- chargebacks?: Chargeback[];
5245
+ appDefId?: string;
5319
5246
  /**
5320
- * Payment method ID.
5321
- * @internal
5247
+ * Not only UUID. Something here could be something weird.
5322
5248
  * @maxLength 36
5323
5249
  */
5324
- paymentMethodId?: string | null;
5325
- /** Platform fee amount associated with this payment. */
5326
- platformFee?: Price;
5250
+ instanceId?: string;
5327
5251
  /**
5328
- * Payment method with buyer and optional owner translations.
5329
- * Non-exhaustive list of supported values:
5330
- * + `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`
5252
+ * A version.
5253
+ * @maxLength 500
5331
5254
  */
5332
- paymentMethodName?: PaymentMethodName;
5333
- }
5334
- /** @oneof */
5335
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5336
- /** Credit card details. */
5337
- creditCardDetails?: CreditCardPaymentMethodDetails;
5338
- }
5339
- declare enum TransactionStatus {
5340
- UNDEFINED = "UNDEFINED",
5341
- APPROVED = "APPROVED",
5342
- PENDING = "PENDING",
5343
- PENDING_MERCHANT = "PENDING_MERCHANT",
5344
- CANCELED = "CANCELED",
5345
- DECLINED = "DECLINED",
5346
- REFUNDED = "REFUNDED",
5347
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5348
- AUTHORIZED = "AUTHORIZED",
5349
- VOIDED = "VOIDED"
5255
+ version?: string | null;
5350
5256
  }
5351
- /** @enumType */
5352
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5353
- interface CreditCardPaymentMethodDetails {
5257
+ /** Rename of the site. Meaning, free public url has been changed as well. */
5258
+ interface SiteRenamed {
5354
5259
  /**
5355
- * The last 4 digits of the card number.
5356
- * @maxLength 4
5260
+ * A new meta site name (URL slug).
5261
+ * @maxLength 20
5357
5262
  */
5358
- lastFourDigits?: string | null;
5263
+ newSiteName?: string;
5359
5264
  /**
5360
- * Card issuer's brand.
5361
- * @maxLength 100
5265
+ * A previous meta site name (URL slug).
5266
+ * @maxLength 255
5362
5267
  */
5363
- brand?: string | null;
5268
+ oldSiteName?: string;
5364
5269
  }
5365
- interface AuthorizationDetails {
5366
- /**
5367
- * Whether the authorized payment is of a delayed capture.
5368
- * @readonly
5369
- */
5370
- delayedCapture?: boolean;
5371
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5372
- authorizedDate?: Date | null;
5373
- /**
5374
- * List of captures associated with payment
5375
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5376
- * @maxSize 1
5377
- */
5378
- captures?: AuthorizationCapture[];
5379
- /** Void associated with payment */
5380
- void?: AuthorizationVoid;
5381
- /** Scheduled action for this transaction */
5382
- scheduledAction?: V1ScheduledAction;
5270
+ /**
5271
+ * Hard deletion of the meta site.
5272
+ *
5273
+ * Could not be restored. Therefore it's desirable to cleanup data.
5274
+ */
5275
+ interface SiteHardDeleted {
5276
+ /** A deletion context. */
5277
+ deleteContext?: DeleteContext;
5383
5278
  }
5384
- interface AuthorizationCapture {
5385
- /**
5386
- * Capture ID.
5387
- * @format GUID
5388
- * @readonly
5389
- */
5390
- _id?: string | null;
5391
- /** Status of this capture action */
5392
- status?: AuthorizationCaptureStatusWithLiterals;
5279
+ interface NamespaceChanged {
5280
+ /** A previous namespace. */
5281
+ oldNamespace?: NamespaceWithLiterals;
5282
+ /** A new namespace. */
5283
+ newNamespace?: NamespaceWithLiterals;
5284
+ }
5285
+ /** Assigned Studio editor */
5286
+ interface StudioAssigned {
5287
+ }
5288
+ /** Unassigned Studio editor */
5289
+ interface StudioUnassigned {
5290
+ }
5291
+ /**
5292
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5293
+ *
5294
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5295
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
5296
+ *
5297
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5298
+ */
5299
+ interface SiteUrlChanged {
5300
+ }
5301
+ /**
5302
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5303
+ * Consumed by other teams to remove relevant data.
5304
+ */
5305
+ interface SitePurgedExternally {
5393
5306
  /**
5394
- * Amount of this capture
5395
- * @immutable
5307
+ * @maxLength 2048
5308
+ * @maxSize 100
5309
+ * @deprecated
5310
+ * @targetRemovalDate 2025-04-15
5396
5311
  */
5397
- amount?: Price;
5398
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5399
- _createdDate?: Date | null;
5400
- /** In case of status is FAILED may contain failure details */
5401
- failureDetails?: AuthorizationActionFailureDetails;
5312
+ appDefId?: string[];
5402
5313
  }
5403
- declare enum AuthorizationCaptureStatus {
5404
- /** Capture operation still in progress. */
5405
- PENDING = "PENDING",
5406
- /** Capture operation succeeded. */
5407
- SUCCEEDED = "SUCCEEDED",
5408
- /** Capture operation failed. */
5409
- FAILED = "FAILED"
5314
+ /** Assigned Odeditor */
5315
+ interface OdeditorAssigned {
5410
5316
  }
5411
- /** @enumType */
5412
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5413
- interface AuthorizationActionFailureDetails {
5414
- /** @maxLength 100 */
5415
- failureCode?: string;
5317
+ /** Unassigned Odeditor */
5318
+ interface OdeditorUnassigned {
5416
5319
  }
5417
- interface AuthorizationVoid {
5418
- /** Status of this void action */
5419
- status?: AuthorizationVoidStatusWithLiterals;
5420
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5421
- voidedDate?: Date | null;
5422
- /** In case of status is FAILED may contain failure details */
5423
- failureDetails?: AuthorizationActionFailureDetails;
5424
- /** Reason of void action */
5425
- reason?: ReasonWithLiterals;
5320
+ /** Assigned Picasso editor */
5321
+ interface PicassoAssigned {
5426
5322
  }
5427
- declare enum AuthorizationVoidStatus {
5428
- /** Void operation still in progress. */
5429
- PENDING = "PENDING",
5430
- /** Void operation succeeded. */
5431
- SUCCEEDED = "SUCCEEDED",
5432
- /** Void operation failed. */
5433
- FAILED = "FAILED"
5323
+ /** Unassigned Picasso */
5324
+ interface PicassoUnassigned {
5434
5325
  }
5435
- /** @enumType */
5436
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5437
- /** Reason the authorization was voided. */
5438
- declare enum Reason {
5439
- /** Authorization was voided by user. */
5440
- MANUAL = "MANUAL",
5441
- /** Authorization passed execution date. */
5442
- SCHEDULED = "SCHEDULED"
5326
+ /** Assigned Wixel */
5327
+ interface WixelAssigned {
5443
5328
  }
5444
- /** @enumType */
5445
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5446
- interface V1ScheduledAction {
5447
- /** Type of the action. */
5448
- actionType?: ActionTypeWithLiterals;
5449
- /** The date and time of the action. */
5450
- executionDate?: Date | null;
5329
+ /** Unassigned Wixel */
5330
+ interface WixelUnassigned {
5451
5331
  }
5452
- declare enum ActionType {
5453
- VOID = "VOID",
5454
- CAPTURE = "CAPTURE"
5332
+ /** Assigned StudioTwo */
5333
+ interface StudioTwoAssigned {
5334
+ }
5335
+ /** Unassigned StudioTwo */
5336
+ interface StudioTwoUnassigned {
5337
+ }
5338
+ /** Media from user domain is enabled. */
5339
+ interface UserDomainMediaEnabled {
5340
+ }
5341
+ /** Media from user domain is disabled. */
5342
+ interface UserDomainMediaDisabled {
5343
+ }
5344
+ /** Assigned Editorless */
5345
+ interface EditorlessAssigned {
5346
+ }
5347
+ /** Unassigned Editorless */
5348
+ interface EditorlessUnassigned {
5349
+ }
5350
+ interface HasCustomEmailConfigurationsRequest {
5351
+ }
5352
+ interface HasCustomEmailConfigurationsResponse {
5353
+ hasCustomConfigurations?: boolean;
5354
+ }
5355
+ interface AddToAutomationMigrationPopulationRequest {
5356
+ /** When true, sends custom email configurations to automation system via email */
5357
+ sendCustomEmailConfigs?: boolean;
5358
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5359
+ origin?: OriginWithLiterals;
5360
+ }
5361
+ declare enum Origin {
5362
+ OPT_IN = "OPT_IN",
5363
+ MIGRATION = "MIGRATION"
5455
5364
  }
5456
5365
  /** @enumType */
5457
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5458
- interface Chargeback {
5459
- /**
5460
- * Chargeback ID.
5461
- * @format GUID
5462
- * @readonly
5463
- * @immutable
5464
- */
5465
- _id?: string;
5466
- /**
5467
- * Date and time the chargeback 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.
5468
- * @readonly
5469
- * @immutable
5470
- */
5471
- _createdDate?: Date | null;
5366
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5367
+ interface AddToAutomationMigrationPopulationResponse {
5368
+ success?: boolean;
5369
+ }
5370
+ interface IsInAutomationMigrationPopulationRequest {
5371
+ }
5372
+ interface IsInAutomationMigrationPopulationResponse {
5373
+ inPopulation?: boolean;
5374
+ }
5375
+ interface PreparePaymentCollectionRequest {
5472
5376
  /**
5473
- * Date and time the chargeback was updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
5474
- * @readonly
5377
+ * Ecom order ID.
5378
+ * @minLength 1
5379
+ * @maxLength 100
5475
5380
  */
5476
- _updatedDate?: Date | null;
5381
+ ecomOrderId: string;
5382
+ /** Amount to collect */
5383
+ amount: Price;
5477
5384
  /**
5478
- * Amount.
5479
- * @readonly
5480
- * @immutable
5385
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
5386
+ * Existing payment gateway order will be updated with a new amount.
5387
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
5481
5388
  */
5482
- amount?: Price;
5389
+ paymentGatewayOrderId?: string | null;
5483
5390
  /**
5484
- * Reversal amount. Present only when status is REVERSED.
5485
- * @readonly
5391
+ * Whether to delay capture of the payment.
5392
+ * Default: false
5393
+ * @deprecated Whether to delay capture of the payment.
5394
+ * Default: false
5395
+ * @replacedBy delayed_capture_settings.scheduled_action
5396
+ * @targetRemovalDate 2024-09-30
5486
5397
  */
5487
- reversalAmount?: Price;
5398
+ delayedCapture?: boolean;
5488
5399
  /**
5489
- * Status.
5490
- *
5491
- * Default: `"APPROVED"`.
5400
+ * Specifies whether payment collection is initiated by Merchant or User of User
5401
+ * Default: `true`
5402
+ * @internal
5492
5403
  */
5493
- status?: ChargebackStatusWithLiterals;
5404
+ merchantInitiated?: boolean | null;
5494
5405
  /**
5495
- * External chargeback ID.
5496
- * @format GUID
5497
- * @readonly
5498
- * @immutable
5406
+ * Redirect urls which are used to return buyer to third party system.
5407
+ * @internal
5499
5408
  */
5500
- externalId?: string | null;
5501
- }
5502
- declare enum ChargebackStatus {
5503
- /** Chargeback was approved. */
5504
- APPROVED = "APPROVED",
5505
- /** Chargeback was reversed. */
5506
- REVERSED = "REVERSED"
5409
+ redirectUrls?: RedirectUrls;
5410
+ /** Delayed capture payment settings */
5411
+ delayedCaptureSettings?: DelayedCaptureSettings;
5507
5412
  }
5508
- /** @enumType */
5509
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5510
- interface PaymentMethodName {
5413
+ interface RedirectUrls {
5511
5414
  /**
5512
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5513
- * @maxLength 150
5415
+ * URL to redirect buyer in case of approved (successful) transaction
5416
+ * @format WEB_URL
5514
5417
  */
5515
- buyerLanguageName?: string | null;
5418
+ successUrl?: string | null;
5516
5419
  /**
5517
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5518
- *
5519
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5520
- * @maxLength 150
5420
+ * URL to redirect buyer in case of buyer canceled the transaction
5421
+ * @format WEB_URL
5521
5422
  */
5522
- siteLanguageName?: string | null;
5423
+ cancelUrl?: string | null;
5523
5424
  /**
5524
- * User-provided payment method name.
5525
- *
5526
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5425
+ * URL to redirect buyer in case of failed/rejected transaction
5426
+ * @format WEB_URL
5527
5427
  */
5528
- userDefinedName?: UserDefinedPaymentMethodName;
5529
- }
5530
- interface GiftCardPaymentDetails {
5428
+ errorUrl?: string | null;
5531
5429
  /**
5532
- * Gift card payment ID.
5533
- * @maxLength 100
5430
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
5431
+ * @format WEB_URL
5534
5432
  */
5535
- giftCardPaymentId?: string;
5433
+ pendingUrl?: string | null;
5434
+ }
5435
+ interface DelayedCaptureSettings {
5436
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5437
+ scheduledAction?: ScheduledActionWithLiterals;
5438
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
5439
+ delayDuration?: Duration;
5440
+ }
5441
+ declare enum ScheduledAction {
5442
+ /** Whether payment will be auto-voided when duration passes */
5443
+ VOID = "VOID",
5444
+ /** Whether payment will be auto-captured when duration passes */
5445
+ CAPTURE = "CAPTURE"
5446
+ }
5447
+ /** @enumType */
5448
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5449
+ interface Duration {
5536
5450
  /**
5537
- * Gift card ID.
5538
- * @internal
5539
- * @deprecated
5451
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5452
+ * @min 1
5540
5453
  */
5541
- giftCardId?: string;
5454
+ count?: number;
5455
+ /** Duration unit: MINUTES, HOURS and DAYS */
5456
+ unit?: DurationUnitWithLiterals;
5457
+ }
5458
+ declare enum DurationUnit {
5459
+ MINUTES = "MINUTES",
5460
+ HOURS = "HOURS",
5461
+ DAYS = "DAYS"
5462
+ }
5463
+ /** @enumType */
5464
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5465
+ interface PreparePaymentCollectionResponse {
5466
+ /** Payment gateway order id which is associated with given payment */
5467
+ paymentGatewayOrderId?: string;
5468
+ }
5469
+ interface GetPaymentCollectabilityStatusRequest {
5542
5470
  /**
5543
- * ID of the app that created the gift card.
5544
- * @format GUID
5471
+ * Ecom order ID.
5472
+ * @minLength 1
5473
+ * @maxLength 100
5545
5474
  */
5546
- appId?: string;
5475
+ ecomOrderId: string;
5476
+ }
5477
+ interface GetPaymentCollectabilityStatusResponse {
5478
+ /** Payment collectability status */
5479
+ status?: PaymentCollectabilityStatusWithLiterals;
5480
+ /** Collectable order amount */
5481
+ amount?: Price;
5547
5482
  /**
5548
- * Whether the gift card is voided.
5549
- * @readonly
5550
- * @deprecated Whether the gift card is voided.
5551
- * @replacedBy payment.status
5552
- * @targetRemovalDate 2026-11-01
5483
+ * Whether authorization supported
5484
+ * @internal
5553
5485
  */
5554
- voided?: boolean;
5486
+ authorizationSupported?: boolean;
5555
5487
  /**
5556
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5557
- * @maxLength 30
5558
- * @immutable
5488
+ * Whether custom amount is supported for payment collection
5489
+ * @internal
5559
5490
  */
5560
- obfuscatedCode?: string | null;
5491
+ customAmountSupported?: boolean;
5561
5492
  }
5562
- interface MembershipPaymentDetails {
5563
- /**
5564
- * Membership ID.
5565
- * @maxLength 200
5566
- */
5567
- membershipId?: string;
5493
+ declare enum PaymentCollectabilityStatus {
5494
+ UNKNOWN = "UNKNOWN",
5495
+ COLLECTABLE = "COLLECTABLE",
5496
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5497
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5498
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5499
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5500
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5501
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5502
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5503
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5504
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5505
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5506
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5507
+ }
5508
+ /** @enumType */
5509
+ type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
5510
+ interface RecordManuallyCollectedPaymentRequest {
5568
5511
  /**
5569
- * ID of the line item this membership applies to.
5512
+ * Order ID.
5570
5513
  * @minLength 1
5571
5514
  * @maxLength 100
5572
5515
  */
5573
- lineItemId?: string;
5516
+ orderId: string;
5517
+ /** Amount to be recorded as approved manual payment for given order */
5518
+ amount: Price;
5574
5519
  /**
5575
- * Payment status.
5576
- * @deprecated Payment status.
5577
- * @replacedBy payment.status
5578
- * @targetRemovalDate 2026-11-01
5520
+ * Payment method name provided by user.
5521
+ *
5522
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5523
+ * @internal
5579
5524
  */
5580
- status?: MembershipPaymentStatusWithLiterals;
5581
- /** Membership name. */
5582
- name?: MembershipName;
5525
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5526
+ }
5527
+ /**
5528
+ * User-defined payment method name.
5529
+ * Allows specifying either a predefined type or a custom name.
5530
+ */
5531
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5532
+ /** Predefined payment method. */
5533
+ predefined?: PredefinedPaymentMethodWithLiterals;
5583
5534
  /**
5584
- * The transaction ID in the membership system. Can be used to void the transaction.
5535
+ * Custom payment method name provided by user.
5536
+ *
5537
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5585
5538
  * @minLength 1
5586
- * @maxLength 100
5587
- */
5588
- externalTransactionId?: string | null;
5589
- /**
5590
- * Whether the membership is voided.
5591
- * @readonly
5592
- * @deprecated Whether the membership is voided.
5593
- * @replacedBy payment.status
5594
- * @targetRemovalDate 2026-11-01
5539
+ * @maxLength 150
5595
5540
  */
5596
- voided?: boolean;
5541
+ custom?: string | null;
5542
+ }
5543
+ /** @oneof */
5544
+ interface UserDefinedPaymentMethodNameKindOneOf {
5545
+ /** Predefined payment method. */
5546
+ predefined?: PredefinedPaymentMethodWithLiterals;
5597
5547
  /**
5598
- * ID of the application providing this payment option.
5599
- * @format GUID
5548
+ * Custom payment method name provided by user.
5549
+ *
5550
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5551
+ * @minLength 1
5552
+ * @maxLength 150
5600
5553
  */
5601
- providerAppId?: string;
5602
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5603
- futureMembership?: FutureMembershipDetails;
5554
+ custom?: string | null;
5604
5555
  }
5605
- declare enum MembershipPaymentStatus {
5606
- /** Payment was charged. */
5607
- CHARGED = "CHARGED",
5608
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5609
- CHARGE_FAILED = "CHARGE_FAILED",
5610
- /** Payment is pending. */
5611
- CHARGE_PENDING = "CHARGE_PENDING",
5612
- /** Payment was voided. */
5613
- VOIDED = "VOIDED"
5556
+ /** Predefined payment method types for offline/manual payments. */
5557
+ declare enum PredefinedPaymentMethod {
5558
+ /** Cash payment. */
5559
+ CASH = "CASH",
5560
+ /** Bank transfer. */
5561
+ BANK_TRANSFER = "BANK_TRANSFER",
5562
+ /** Payment by check. */
5563
+ CHECK = "CHECK"
5614
5564
  }
5615
5565
  /** @enumType */
5616
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5617
- interface FutureMembershipDetails {
5566
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5567
+ interface RecordManuallyCollectedPaymentResponse {
5568
+ }
5569
+ interface MarkOrderAsPaidRequest {
5618
5570
  /**
5619
- * ID of the plan line item in the order from which the membership will be created.
5620
- * @format GUID
5571
+ * Ecom order ID.
5572
+ * @minLength 1
5573
+ * @maxLength 100
5621
5574
  */
5622
- lineItemId?: string;
5575
+ ecomOrderId: string;
5623
5576
  /**
5624
- * ID of the benefit the future membership will grant.
5625
- * @maxLength 200
5577
+ * Payment method name provided by user.
5578
+ *
5579
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5580
+ * @internal
5626
5581
  */
5627
- benefitId?: string;
5582
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5628
5583
  }
5629
- interface WixReceiptInfo {
5630
- /**
5631
- * Receipt ID
5632
- * @format GUID
5633
- */
5634
- receiptId?: string;
5584
+ interface MarkOrderAsPaidResponse {
5585
+ /** Updated order. */
5586
+ order?: Order;
5587
+ }
5588
+ interface BulkMarkOrdersAsPaidRequest {
5635
5589
  /**
5636
- * Display number of receipt
5590
+ * IDs of orders to mark as paid.
5591
+ * @minSize 1
5592
+ * @maxSize 100
5637
5593
  * @minLength 1
5638
- * @maxLength 40
5594
+ * @maxLength 100
5639
5595
  */
5640
- displayNumber?: string | null;
5596
+ ecomOrderIds: string[];
5641
5597
  }
5642
- interface ExternalReceiptInfo {
5598
+ interface BulkMarkOrdersAsPaidResponse {
5643
5599
  /**
5644
- * External receipt ID
5645
- * @maxLength 100
5600
+ * Items updated by the bulk action.
5601
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5646
5602
  */
5647
- receiptId?: string | null;
5603
+ results?: BulkOrderResult[];
5604
+ /** Bulk action metadata. */
5605
+ bulkActionMetadata?: BulkActionMetadata;
5606
+ }
5607
+ interface BulkOrderResult {
5608
+ /** Item metadata. */
5609
+ itemMetadata?: ItemMetadata;
5648
5610
  /**
5649
- * ID of the app providing the receipt
5650
- * @format GUID
5611
+ * Updated order.
5612
+ *
5613
+ * Returned when `returnFullEntity = true`.
5651
5614
  */
5652
- appId?: string | null;
5615
+ item?: Order;
5616
+ }
5617
+ interface ItemMetadata {
5618
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5619
+ _id?: string | null;
5620
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
5621
+ originalIndex?: number;
5622
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5623
+ success?: boolean;
5624
+ /** Details about the error in case of failure. */
5625
+ error?: ApplicationError;
5626
+ }
5627
+ interface ApplicationError {
5628
+ /** Error code. */
5629
+ code?: string;
5630
+ /** Description of the error. */
5631
+ description?: string;
5632
+ /** Data related to the error. */
5633
+ data?: Record<string, any> | null;
5634
+ }
5635
+ interface BulkActionMetadata {
5636
+ /** Number of items that were successfully processed. */
5637
+ totalSuccesses?: number;
5638
+ /** Number of items that couldn't be processed. */
5639
+ totalFailures?: number;
5640
+ /** Number of failures without details because detailed failure threshold was exceeded. */
5641
+ undetailedFailures?: number;
5642
+ }
5643
+ interface GetRefundabilityStatusRequest {
5653
5644
  /**
5654
- * Display number of receipt
5645
+ * Order ID.
5655
5646
  * @minLength 1
5656
- * @maxLength 40
5647
+ * @maxLength 100
5657
5648
  */
5658
- displayNumber?: string | null;
5649
+ ecomOrderId: string;
5659
5650
  }
5660
- interface CashRoundingDetails {
5661
- /**
5662
- * Payment amount before cash rounding was applied.
5663
- * When provided, balance and status calculations use this value instead of `amount`
5664
- * to prevent false overpayment or underpayment due to rounding.
5665
- */
5666
- unroundedAmount?: Price;
5651
+ interface GetRefundabilityStatusResponse {
5667
5652
  /**
5668
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5669
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5670
- * @readonly
5653
+ * Refundability details.
5654
+ * @maxSize 300
5671
5655
  */
5672
- roundingAdjustment?: CashRounding;
5673
- }
5674
- declare enum PaymentStatus {
5675
- /** Payment was charged successfully. */
5676
- APPROVED = "APPROVED",
5677
- /** Payment is being processed and hasn't been confirmed yet. */
5678
- PENDING = "PENDING",
5679
- /** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
5680
- PENDING_MERCHANT = "PENDING_MERCHANT",
5681
- /** Payment was canceled before it was charged. */
5682
- CANCELED = "CANCELED",
5683
- /** Payment was declined by the payment provider. */
5684
- DECLINED = "DECLINED",
5685
- /** Payment was fully refunded. */
5686
- REFUNDED = "REFUNDED",
5687
- /** Part of the payment amount was refunded. */
5688
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5689
- /** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
5690
- AUTHORIZED = "AUTHORIZED",
5656
+ refundabilities?: Refundability[];
5691
5657
  /**
5692
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5693
- *
5694
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5658
+ * Whether the order supports refunding per item.
5659
+ * @deprecated
5695
5660
  */
5696
- VOIDED = "VOIDED"
5697
- }
5698
- /** @enumType */
5699
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5700
- interface CanceledStatusDetails {
5701
- reason?: CanceledReasonWithLiterals;
5661
+ refundablePerItem?: boolean;
5702
5662
  }
5703
- declare enum CanceledReason {
5704
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5705
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5706
- /** Payment was not completed by user and expired. */
5707
- EXPIRED = "EXPIRED"
5663
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5664
+ /** Reason why payment is not refundable. */
5665
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5666
+ /** Reason why payment is only refundable manually. */
5667
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5668
+ /** Payment ID. */
5669
+ paymentId?: string;
5670
+ /** Payment refundability status. */
5671
+ refundabilityStatus?: RefundableStatusWithLiterals;
5672
+ /** Link to payment provider dashboard. */
5673
+ providerLink?: string | null;
5708
5674
  }
5709
- /** @enumType */
5710
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5711
- interface DeclinedStatusDetails {
5712
- reason?: DeclinedReasonWithLiterals;
5675
+ /** @oneof */
5676
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
5677
+ /** Reason why payment is not refundable. */
5678
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5679
+ /** Reason why payment is only refundable manually. */
5680
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5713
5681
  }
5714
- declare enum DeclinedReason {
5715
- /** Corresponding charge failed. */
5716
- CHARGE_FAILED = "CHARGE_FAILED",
5717
- /** Payment details expired. */
5718
- EXPIRED = "EXPIRED",
5719
- /** Insufficient funds. */
5720
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5721
- /** Gift card was disabled before charge was attempted. */
5722
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5682
+ declare enum RefundableStatus {
5683
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5684
+ MANUAL = "MANUAL",
5685
+ REFUNDABLE = "REFUNDABLE"
5723
5686
  }
5724
5687
  /** @enumType */
5725
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5726
- interface VoidedStatusDetails {
5727
- reason?: VoidedReasonWithLiterals;
5688
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5689
+ declare enum NonRefundableReason {
5690
+ NONE = "NONE",
5691
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
5692
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5693
+ INTERNAL_ERROR = "INTERNAL_ERROR",
5694
+ NOT_PAID = "NOT_PAID",
5695
+ ACCESS_DENIED = "ACCESS_DENIED",
5696
+ ZERO_PRICE = "ZERO_PRICE",
5697
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5698
+ PENDING_REFUND = "PENDING_REFUND",
5699
+ FORBIDDEN = "FORBIDDEN",
5700
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5701
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
5702
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5728
5703
  }
5729
- declare enum VoidedReason {
5730
- /** Payment was voided by merchant request. */
5731
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
5732
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5733
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5704
+ /** @enumType */
5705
+ type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
5706
+ declare enum ManuallyRefundableReason {
5707
+ EXPIRED = "EXPIRED",
5708
+ NOT_SUPPORTED = "NOT_SUPPORTED",
5709
+ OFFLINE = "OFFLINE",
5710
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5734
5711
  }
5735
5712
  /** @enumType */
5736
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5737
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5738
- /** @internal */
5739
- canceled?: CanceledStatusDetails;
5740
- /** @internal */
5741
- declined?: DeclinedStatusDetails;
5742
- /** @internal */
5743
- voided?: VoidedStatusDetails;
5713
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5714
+ interface CreatePaymentGatewayOrderRequest {
5744
5715
  /**
5745
- * Reason code from the payment gateway.
5746
- * @internal
5716
+ * Ecom order ID.
5747
5717
  * @minLength 1
5748
- * @maxLength 10
5718
+ * @maxLength 100
5749
5719
  */
5750
- paymentGatewayReasonCode?: string | null;
5751
- }
5752
- /** @oneof */
5753
- interface PaymentStatusDetailsStatusDetailsOneOf {
5754
- /** @internal */
5755
- canceled?: CanceledStatusDetails;
5756
- /** @internal */
5757
- declined?: DeclinedStatusDetails;
5758
- /** @internal */
5759
- voided?: VoidedStatusDetails;
5720
+ ecomOrderId: string;
5721
+ /** Information about the user who initiated the payment. */
5722
+ chargedBy?: ChargedBy;
5723
+ /**
5724
+ * Whether to delay capture of the payment.
5725
+ *
5726
+ * Default: false
5727
+ * @internal
5728
+ */
5729
+ delayedCapture?: boolean;
5760
5730
  }
5761
- interface Refund {
5731
+ interface ChargedBy {
5762
5732
  /**
5763
- * Refund ID.
5733
+ * ID - id of the user who initiated the payment
5764
5734
  * @format GUID
5765
- * @readonly
5766
5735
  */
5767
5736
  _id?: string;
5768
5737
  /**
5769
- * List of transactions.
5770
- * @maxSize 50
5738
+ * Full name - name of the user who initiated the payment
5739
+ * @minLength 1
5740
+ * @maxLength 200
5771
5741
  */
5772
- transactions?: RefundTransaction[];
5773
- /** Refund business details. */
5774
- details?: RefundDetails;
5742
+ fullName?: string | null;
5743
+ }
5744
+ interface CreatePaymentGatewayOrderResponse {
5745
+ /** ID of the order created in the payment gateway */
5746
+ paymentGatewayOrderId?: string;
5747
+ }
5748
+ interface ChargeMembershipsRequest {
5775
5749
  /**
5776
- * 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.
5777
- * @readonly
5778
- * @immutable
5750
+ * Order ID.
5751
+ * @minLength 1
5752
+ * @maxLength 100
5779
5753
  */
5780
- _createdDate?: Date | null;
5754
+ ecomOrderId: string;
5781
5755
  /**
5782
- * Aggregated refund summary.
5783
- * @readonly
5756
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5757
+ * but a user which is using the membership on behalf of the a member
5758
+ * @format GUID
5784
5759
  */
5785
- summary?: AggregatedRefundSummary;
5760
+ memberId: string;
5786
5761
  /**
5787
- * ID of the app that initiated this refund.
5788
- * @format GUID
5789
- * @readonly
5790
- * @immutable
5762
+ * List of items to be paid by memberships
5763
+ * @minSize 1
5764
+ * @maxSize 300
5791
5765
  */
5792
- requestingServiceAppId?: string | null;
5766
+ membershipCharges?: MembershipChargeItem[];
5793
5767
  }
5794
- interface RefundTransaction {
5768
+ interface MembershipChargeItem {
5795
5769
  /**
5796
- * ID of the payment associated with this refund.
5770
+ * The id of used membership
5771
+ * @minLength 1
5772
+ * @maxLength 100
5773
+ */
5774
+ membershipId?: string;
5775
+ /**
5776
+ * ID of the application providing this payment option
5797
5777
  * @format GUID
5798
- * @immutable
5799
5778
  */
5800
- paymentId?: string;
5779
+ appId?: string;
5780
+ /** The name of used membership */
5781
+ membershipName?: MembershipName;
5782
+ /** Additional data about this membership */
5783
+ membershipAdditionalData?: Record<string, any> | null;
5784
+ /** Catalog and item reference info. */
5785
+ catalogReference?: CatalogReference;
5786
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
5787
+ serviceProperties?: ServiceProperties;
5801
5788
  /**
5802
- * Refund amount.
5803
- * @immutable
5789
+ * Usually would be the same as catalogReference.catalogItemId
5790
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
5791
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5792
+ * @minLength 1
5793
+ * @maxLength 36
5804
5794
  */
5805
- amount?: Price;
5806
- /** Refund status. */
5807
- refundStatus?: RefundStatusWithLiterals;
5808
- /** Optional details of current refund status. */
5809
- refundStatusInfo?: RefundStatusInfo;
5795
+ rootCatalogItemId?: string | null;
5810
5796
  /**
5811
- * Payment gateway's refund ID.
5812
- * This field is only returned when the value of `external_refund` is `false`.
5813
- * @format GUID
5797
+ * line item id of Checkout/Order line item
5798
+ * @minLength 1
5799
+ * @maxLength 100
5814
5800
  */
5815
- gatewayRefundId?: string | null;
5816
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5817
- providerRefundId?: string | null;
5801
+ lineItemId?: string;
5802
+ }
5803
+ interface MembershipName {
5818
5804
  /**
5819
- * Whether refund was made externally and manually on the payment provider's side.
5820
- * @immutable
5805
+ * Membership name in the site's original language.
5806
+ * @maxLength 100
5821
5807
  */
5822
- externalRefund?: boolean;
5808
+ original?: string;
5823
5809
  /**
5824
- * Location where the refund was processed.
5825
- * @internal
5826
- * @format GUID
5827
- * @immutable
5810
+ * Membership name translated into the buyer's language.
5811
+ *
5812
+ * Default: The value of `original`
5813
+ * @maxLength 100
5828
5814
  */
5829
- locationId?: string | null;
5815
+ translated?: string | null;
5830
5816
  }
5831
- /** Refund transaction status. */
5832
- declare enum RefundStatus {
5833
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5834
- PENDING = "PENDING",
5835
- /** Refund transaction succeeded. */
5836
- SUCCEEDED = "SUCCEEDED",
5837
- /** Refund transaction failed. */
5838
- FAILED = "FAILED",
5839
- /** Refund request acknowledged, and will be executed soon. */
5840
- SCHEDULED = "SCHEDULED",
5841
- /** Refund was initiated on payment provider side. */
5842
- STARTED = "STARTED"
5817
+ interface ChargeMembershipsResponse {
5843
5818
  }
5844
- /** @enumType */
5845
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5846
- interface RefundStatusInfo {
5819
+ interface TriggerRefundRequest {
5820
+ /**
5821
+ * The order this refund related to
5822
+ * @minLength 1
5823
+ * @maxLength 100
5824
+ */
5825
+ ecomOrderId: string;
5826
+ /**
5827
+ * Refund operations information
5828
+ * @minSize 1
5829
+ * @maxSize 1
5830
+ */
5831
+ payments: PaymentRefund[];
5832
+ /** Business model of a refund */
5833
+ details?: RefundDetails;
5834
+ /** Side effect details related to refund */
5835
+ sideEffects?: RefundSideEffects;
5836
+ }
5837
+ interface PaymentRefund {
5838
+ /**
5839
+ * Specific payment within the order to refund
5840
+ * @format GUID
5841
+ */
5842
+ paymentId?: string;
5843
+ /** Refund amount. Not relevant for membership and gift card refunds. */
5844
+ amount?: Price;
5847
5845
  /**
5848
- * Reason code for the refund's current status.
5849
- *
5850
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5846
+ * Whether refund is made externally and manually (on the payment provider's side)
5847
+ * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
5848
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5849
+ */
5850
+ externalRefund?: boolean;
5851
+ /**
5852
+ * Gateway refund id. When param is present, new refund is not created.
5853
+ * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5854
+ * and all side effects from request will be executed.
5855
+ * @internal
5851
5856
  * @minLength 1
5852
- * @maxLength 10
5857
+ * @maxLength 100
5853
5858
  */
5854
- paymentGatewayReasonCode?: string | null;
5859
+ gatewayRefundId?: string | null;
5860
+ }
5861
+ interface RefundSideEffects {
5862
+ /** Inventory restock details as part of this refund. */
5863
+ restockInfo?: RestockInfo;
5864
+ /** Whether to send a refund confirmation email to the customer. */
5865
+ sendOrderRefundedEmail?: boolean;
5855
5866
  /**
5856
- * Free text explanation of current refund status.
5867
+ * Custom message added to the refund confirmation email.
5857
5868
  * @minLength 1
5858
5869
  * @maxLength 1000
5859
5870
  */
5860
- description?: string | null;
5861
- }
5862
- interface AggregatedRefundSummary {
5863
- /** Total amount requested for refund. */
5864
- requestedRefund?: Price;
5865
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5866
- pendingRefund?: Price;
5867
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5868
- refunded?: Price;
5869
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
5870
- failedRefundAmount?: Price;
5871
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
5872
- pending?: boolean;
5873
- /** Breakdown of refunded items. Available only after refund is complete. */
5874
- breakdown?: RefundItemsBreakdown;
5871
+ customMessage?: string | null;
5875
5872
  }
5876
- interface RefundItemsBreakdown {
5873
+ interface RestockInfo {
5874
+ /** Restock type. */
5875
+ type?: RestockTypeWithLiterals;
5877
5876
  /**
5878
- * Refunded line items and the amount refunded for each.
5877
+ * Deprecated, use items instead
5878
+ * @internal
5879
5879
  * @maxSize 300
5880
+ * @deprecated
5880
5881
  */
5881
- lineItems?: LineItemRefundSummary[];
5882
+ lineItemIds?: string[];
5883
+ /**
5884
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5885
+ * @maxSize 300
5886
+ */
5887
+ items?: RestockItem[];
5882
5888
  }
5883
- interface LineItemRefundSummary {
5889
+ declare enum RestockType {
5890
+ NO_ITEMS = "NO_ITEMS",
5891
+ ALL_ITEMS = "ALL_ITEMS",
5892
+ SOME_ITEMS = "SOME_ITEMS"
5893
+ }
5894
+ /** @enumType */
5895
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5896
+ interface RestockItem {
5884
5897
  /**
5885
- * ID of the refunded line item.
5898
+ * ID of the line item being restocked.
5886
5899
  * @format GUID
5887
5900
  */
5888
5901
  lineItemId?: string;
5889
- /** Total refunded amount for the line item. */
5890
- totalRefundedAmount?: Price;
5891
- }
5892
- interface CalculateRefundRequest {
5893
5902
  /**
5894
- * Order ID
5895
- * @minLength 1
5896
- * @maxLength 100
5903
+ * Line item quantity being restocked.
5904
+ * @min 1
5905
+ * @max 100000
5897
5906
  */
5898
- ecomOrderId?: string;
5907
+ quantity?: number;
5899
5908
  /**
5900
- * Refunded line items and quantity
5901
- * @maxSize 300
5909
+ * Per-location breakdown of restock quantities.
5910
+ * @internal
5911
+ * @maxSize 5
5902
5912
  */
5903
- refundItems?: CalculateRefundItemRequest[];
5904
- /** Should include shipping in refund calculation */
5905
- refundShipping?: boolean;
5913
+ restockLocations?: RestockLocation[];
5906
5914
  }
5907
- interface CalculateRefundItemRequest {
5915
+ interface TriggerRefundResponse {
5916
+ /** All order's transactions after the refunds were added */
5917
+ orderTransactions?: OrderTransactions;
5918
+ /** Created refund ID */
5919
+ refundId?: string | null;
5920
+ /** Payment ID's that the refund execution had failed for */
5921
+ failedPaymentIds?: ItemMetadata[];
5922
+ }
5923
+ /**
5924
+ * A record of all payments and refunds associated with an order.
5925
+ *
5926
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5927
+ */
5928
+ interface OrderTransactions {
5908
5929
  /**
5909
- * ID of the line item being refunded
5930
+ * Order ID.
5910
5931
  * @format GUID
5911
5932
  */
5912
- _id?: string;
5933
+ orderId?: string;
5913
5934
  /**
5914
- * How much of that line item is being refunded
5915
- * @min 1
5916
- * @max 100000
5935
+ * Record of payments made to the merchant.
5936
+ * @maxSize 100
5917
5937
  */
5918
- quantity?: number;
5919
- }
5920
- interface CalculateRefundResponse {
5921
- /** Total refundable amount */
5922
- total?: Price;
5923
- /** Tax cost of the order */
5924
- tax?: Price;
5925
- /** Discount given for this order */
5926
- discount?: Price;
5927
- /** Total cost of the order (without tax) */
5928
- subtotal?: Price;
5929
- /** Total shipping cost for order */
5930
- shipping?: Price;
5931
- /** Previous refund given on that order */
5932
- previouslyRefundedAmount?: Price;
5938
+ payments?: Payment[];
5933
5939
  /**
5934
- * The refundable items of that order
5940
+ * Record of refunds made to the buyer.
5935
5941
  * @maxSize 300
5936
5942
  */
5937
- items?: CalculateRefundItemResponse[];
5943
+ refunds?: Refund[];
5938
5944
  }
5939
- interface CalculateRefundItemResponse {
5945
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5946
+ /** Regular payment details. */
5947
+ regularPaymentDetails?: RegularPaymentDetails;
5948
+ /** Gift card payment details. */
5949
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5950
+ /** Membership payment details. */
5951
+ membershipPaymentDetails?: MembershipPaymentDetails;
5940
5952
  /**
5941
- * Line item ID
5953
+ * Receipt created by Wix
5954
+ * @internal
5955
+ */
5956
+ wixReceipt?: WixReceiptInfo;
5957
+ /**
5958
+ * Receipt created by an external system.
5959
+ * @internal
5960
+ */
5961
+ externalReceipt?: ExternalReceiptInfo;
5962
+ /** @internal */
5963
+ canceled?: CanceledStatusDetails;
5964
+ /** @internal */
5965
+ declined?: DeclinedStatusDetails;
5966
+ /** @internal */
5967
+ voided?: VoidedStatusDetails;
5968
+ /**
5969
+ * Payment ID.
5942
5970
  * @format GUID
5971
+ * @readonly
5943
5972
  */
5944
- _id?: string;
5945
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5946
- price?: Price;
5947
- }
5948
- interface VoidAuthorizedPaymentsRequest {
5973
+ _id?: string | null;
5974
+ /** 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. */
5975
+ _createdDate?: Date | null;
5949
5976
  /**
5950
- * Wix eCommerce order ID
5951
- * @minLength 1
5952
- * @maxLength 100
5977
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5978
+ * @readonly
5953
5979
  */
5954
- ecomOrderId: string;
5980
+ _updatedDate?: Date | null;
5981
+ /** Payment amount. */
5982
+ amount?: Price;
5955
5983
  /**
5956
- * Payment IDs
5957
- * @minSize 1
5958
- * @maxSize 100
5984
+ * Whether refunds for this payment are disabled.
5985
+ * + `true`: This payment is not refundable.
5986
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5987
+ */
5988
+ refundDisabled?: boolean;
5989
+ /**
5990
+ * Whether receipt generation is allowed for this payment.
5991
+ * + `true`: This payment supports receipt generation.
5992
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5993
+ * @readonly
5994
+ */
5995
+ supportReceiptGeneration?: boolean;
5996
+ /** Details about cash rounding applied to this payment, when relevant. */
5997
+ cashRounding?: CashRoundingDetails;
5998
+ /**
5999
+ * Overall payment status.
6000
+ *
6001
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
6002
+ */
6003
+ status?: PaymentStatusWithLiterals;
6004
+ /**
6005
+ * Detailed payment status information including gateway reason codes and status-specific details.
6006
+ * @internal
6007
+ */
6008
+ paymentStatusDetails?: PaymentStatusDetails;
6009
+ /**
6010
+ * Location where the payment was processed.
6011
+ * @internal
5959
6012
  * @format GUID
6013
+ * @immutable
5960
6014
  */
5961
- paymentIds: string[];
6015
+ locationId?: string | null;
6016
+ /**
6017
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
6018
+ * @format GUID
6019
+ */
6020
+ chargeCorrelationId?: string | null;
5962
6021
  }
5963
- interface VoidAuthorizedPaymentsResponse {
5964
- /** All order's transactions after the void was triggered */
5965
- orderTransactions?: OrderTransactions;
6022
+ /** @oneof */
6023
+ interface PaymentPaymentDetailsOneOf {
6024
+ /** Regular payment details. */
6025
+ regularPaymentDetails?: RegularPaymentDetails;
6026
+ /** Gift card payment details. */
6027
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
6028
+ /** Membership payment details. */
6029
+ membershipPaymentDetails?: MembershipPaymentDetails;
5966
6030
  }
5967
- interface CaptureAuthorizedPaymentsRequest {
6031
+ /** @oneof */
6032
+ interface PaymentReceiptInfoOneOf {
5968
6033
  /**
5969
- * Wix eCommerce order ID
5970
- * @minLength 1
5971
- * @maxLength 100
6034
+ * Receipt created by Wix
6035
+ * @internal
5972
6036
  */
5973
- ecomOrderId: string;
6037
+ wixReceipt?: WixReceiptInfo;
6038
+ /**
6039
+ * Receipt created by an external system.
6040
+ * @internal
6041
+ */
6042
+ externalReceipt?: ExternalReceiptInfo;
6043
+ }
6044
+ /** @oneof */
6045
+ interface PaymentStatusDetailsOneOf {
6046
+ /** @internal */
6047
+ canceled?: CanceledStatusDetails;
6048
+ /** @internal */
6049
+ declined?: DeclinedStatusDetails;
6050
+ /** @internal */
6051
+ voided?: VoidedStatusDetails;
6052
+ }
6053
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
6054
+ /** Credit card details. */
6055
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5974
6056
  /**
5975
- * Capture payments information
5976
- * @minSize 1
5977
- * @maxSize 100
6057
+ * Wix Payments order ID.
6058
+ * @maxLength 100
5978
6059
  */
5979
- payments: PaymentCapture[];
5980
- }
5981
- interface PaymentCapture {
6060
+ paymentOrderId?: string | null;
5982
6061
  /**
5983
- * Payment ID
5984
- * @format GUID
6062
+ * Payment gateway's transaction ID.
6063
+ * This field is only returned when the value of `offline_payment` is `false`.
6064
+ * @maxLength 100
5985
6065
  */
5986
- paymentId?: string | null;
6066
+ gatewayTransactionId?: string | null;
5987
6067
  /**
5988
- * Capture amount.
5989
- * If not provided - full authorized amount will be captured.
6068
+ * Payment method.
6069
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6070
+ * Non-exhaustive list of supported values:
6071
+ * + `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`
6072
+ * @maxLength 150
6073
+ * @deprecated Payment method.
6074
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6075
+ * Non-exhaustive list of supported values:
6076
+ * + `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`
6077
+ * @replacedBy payment_method_name
6078
+ * @targetRemovalDate 2026-07-01
5990
6079
  */
5991
- amount?: Price;
5992
- }
5993
- interface CaptureAuthorizedPaymentsResponse {
5994
- /** All order's transactions after the capture was triggered */
5995
- orderTransactions?: OrderTransactions;
5996
- }
5997
- interface ChargeSavedPaymentMethodRequest {
6080
+ paymentMethod?: string | null;
5998
6081
  /**
5999
- * Ecom Order ID.
6000
- * @minLength 1
6082
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
6001
6083
  * @maxLength 100
6002
6084
  */
6003
- ecomOrderId?: string;
6004
- /** Amount to be charged */
6005
- amount?: Price;
6006
- }
6007
- interface ChargeSavedPaymentMethodResponse {
6008
- /** Payment gateway's order ID (e.g Wix Payments) */
6009
- paymentGatewayOrderId?: string;
6010
- }
6011
- interface SendBuyerConfirmationEmailRequest {
6012
- /** @format GUID */
6013
- orderId?: string;
6014
- }
6015
- interface SendBuyerConfirmationEmailResponse {
6016
- }
6017
- interface SendBuyerPaymentsReceivedEmailRequest {
6085
+ providerTransactionId?: string | null;
6086
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
6087
+ offlinePayment?: boolean;
6018
6088
  /**
6019
- * @minLength 1
6020
- * @maxLength 100
6089
+ * Payment status.
6090
+ * @deprecated Payment status.
6091
+ * @replacedBy payment.status
6092
+ * @targetRemovalDate 2026-11-01
6021
6093
  */
6022
- orderId?: string;
6023
- }
6024
- interface SendBuyerPaymentsReceivedEmailResponse {
6025
- }
6026
- interface SendBuyerPickupConfirmationEmailRequest {
6094
+ status?: TransactionStatusWithLiterals;
6095
+ /** Whether there is a payment agreement that allows for future charges. */
6096
+ savedPaymentMethod?: boolean;
6097
+ /** Authorization details. */
6098
+ authorizationDetails?: AuthorizationDetails;
6027
6099
  /**
6028
- * @minLength 1
6029
- * @maxLength 100
6100
+ * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
6101
+ * @internal
6102
+ * @maxLength 300
6030
6103
  */
6031
- orderId?: string;
6032
- }
6033
- interface SendBuyerPickupConfirmationEmailResponse {
6034
- }
6035
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
6104
+ paymentProvider?: string | null;
6036
6105
  /**
6037
- * IDs of orders to send pickup emails for.
6038
- * @minSize 1
6039
- * @maxSize 300
6106
+ * Record of chargebacks made by the buyer.
6107
+ * @maxSize 6
6040
6108
  */
6041
- orderIds?: string[];
6042
- }
6043
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
6044
- }
6045
- interface SendBuyerShippingConfirmationEmailRequest {
6109
+ chargebacks?: Chargeback[];
6046
6110
  /**
6047
- * @minLength 1
6048
- * @maxLength 100
6111
+ * Payment method ID.
6112
+ * @internal
6113
+ * @maxLength 36
6049
6114
  */
6050
- orderId?: string;
6051
- }
6052
- interface SendBuyerShippingConfirmationEmailResponse {
6053
- }
6054
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
6115
+ paymentMethodId?: string | null;
6116
+ /** Platform fee amount associated with this payment. */
6117
+ platformFee?: Price;
6055
6118
  /**
6056
- * IDs of orders to send pickup emails for.
6057
- * @minSize 1
6058
- * @maxSize 300
6119
+ * Payment method with buyer and optional owner translations.
6120
+ * Non-exhaustive list of supported values:
6121
+ * + `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`
6059
6122
  */
6060
- orderIds?: string[];
6123
+ paymentMethodName?: PaymentMethodName;
6061
6124
  }
6062
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
6125
+ /** @oneof */
6126
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
6127
+ /** Credit card details. */
6128
+ creditCardDetails?: CreditCardPaymentMethodDetails;
6063
6129
  }
6064
- interface SendMerchantOrderReceivedNotificationRequest {
6130
+ declare enum TransactionStatus {
6131
+ UNDEFINED = "UNDEFINED",
6132
+ APPROVED = "APPROVED",
6133
+ PENDING = "PENDING",
6134
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6135
+ CANCELED = "CANCELED",
6136
+ DECLINED = "DECLINED",
6137
+ REFUNDED = "REFUNDED",
6138
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6139
+ AUTHORIZED = "AUTHORIZED",
6140
+ VOIDED = "VOIDED"
6141
+ }
6142
+ /** @enumType */
6143
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6144
+ interface CreditCardPaymentMethodDetails {
6065
6145
  /**
6066
- * @minLength 1
6067
- * @maxLength 100
6146
+ * The last 4 digits of the card number.
6147
+ * @maxLength 4
6068
6148
  */
6069
- orderId?: string;
6070
- }
6071
- interface SendMerchantOrderReceivedNotificationResponse {
6072
- }
6073
- interface SendCancelRefundEmailRequest {
6149
+ lastFourDigits?: string | null;
6074
6150
  /**
6075
- * The ID of order that is canceled/refunded
6076
- * @minLength 1
6151
+ * Card issuer's brand.
6077
6152
  * @maxLength 100
6078
6153
  */
6079
- orderId?: string;
6154
+ brand?: string | null;
6155
+ }
6156
+ interface AuthorizationDetails {
6080
6157
  /**
6081
- * Personal note added to the email (optional)
6082
- * @minLength 1
6083
- * @maxLength 1000
6158
+ * Whether the authorized payment is of a delayed capture.
6159
+ * @readonly
6084
6160
  */
6085
- customMessage?: string | null;
6086
- /** Refund amount */
6087
- refundAmount?: Price;
6161
+ delayedCapture?: boolean;
6162
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6163
+ authorizedDate?: Date | null;
6088
6164
  /**
6089
- * Refund ID. (Optional)
6090
- * @format GUID
6165
+ * List of captures associated with payment
6166
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
6167
+ * @maxSize 1
6091
6168
  */
6092
- refundId?: string | null;
6093
- }
6094
- interface SendCancelRefundEmailResponse {
6169
+ captures?: AuthorizationCapture[];
6170
+ /** Void associated with payment */
6171
+ void?: AuthorizationVoid;
6172
+ /** Scheduled action for this transaction */
6173
+ scheduledAction?: V1ScheduledAction;
6095
6174
  }
6096
- interface SendRefundEmailRequest {
6097
- /**
6098
- * The ID of order that is refunded
6099
- * @format GUID
6100
- */
6101
- orderId?: string;
6175
+ interface AuthorizationCapture {
6102
6176
  /**
6103
- * Refund ID
6177
+ * Capture ID.
6104
6178
  * @format GUID
6179
+ * @readonly
6105
6180
  */
6106
- refundId?: string;
6181
+ _id?: string | null;
6182
+ /** Status of this capture action */
6183
+ status?: AuthorizationCaptureStatusWithLiterals;
6107
6184
  /**
6108
- * Personal note added to the email (optional)
6109
- * @minLength 1
6110
- * @maxLength 1000
6185
+ * Amount of this capture
6186
+ * @immutable
6111
6187
  */
6112
- customMessage?: string | null;
6188
+ amount?: Price;
6189
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6190
+ _createdDate?: Date | null;
6191
+ /** In case of status is FAILED may contain failure details */
6192
+ failureDetails?: AuthorizationActionFailureDetails;
6113
6193
  }
6114
- interface SendRefundEmailResponse {
6194
+ declare enum AuthorizationCaptureStatus {
6195
+ /** Capture operation still in progress. */
6196
+ PENDING = "PENDING",
6197
+ /** Capture operation succeeded. */
6198
+ SUCCEEDED = "SUCCEEDED",
6199
+ /** Capture operation failed. */
6200
+ FAILED = "FAILED"
6115
6201
  }
6116
- interface SendFulfillmentEmailRequest {
6117
- /** @format GUID */
6118
- orderId?: string;
6119
- /** @format GUID */
6120
- fulfillerId?: string;
6202
+ /** @enumType */
6203
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6204
+ interface AuthorizationActionFailureDetails {
6205
+ /** @maxLength 100 */
6206
+ failureCode?: string;
6121
6207
  }
6122
- interface SendFulfillmentEmailResponse {
6208
+ interface AuthorizationVoid {
6209
+ /** Status of this void action */
6210
+ status?: AuthorizationVoidStatusWithLiterals;
6211
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6212
+ voidedDate?: Date | null;
6213
+ /** In case of status is FAILED may contain failure details */
6214
+ failureDetails?: AuthorizationActionFailureDetails;
6215
+ /** Reason of void action */
6216
+ reason?: ReasonWithLiterals;
6123
6217
  }
6124
- interface SendMerchantOrderReceivedPushRequest {
6125
- /**
6126
- * @minLength 1
6127
- * @maxLength 100
6128
- */
6129
- orderId?: string;
6218
+ declare enum AuthorizationVoidStatus {
6219
+ /** Void operation still in progress. */
6220
+ PENDING = "PENDING",
6221
+ /** Void operation succeeded. */
6222
+ SUCCEEDED = "SUCCEEDED",
6223
+ /** Void operation failed. */
6224
+ FAILED = "FAILED"
6130
6225
  }
6131
- interface SendMerchantOrderReceivedPushResponse {
6226
+ /** @enumType */
6227
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6228
+ /** Reason the authorization was voided. */
6229
+ declare enum Reason {
6230
+ /** Authorization was voided by user. */
6231
+ MANUAL = "MANUAL",
6232
+ /** Authorization passed execution date. */
6233
+ SCHEDULED = "SCHEDULED"
6132
6234
  }
6133
- interface PreviewEmailByTypeRequest {
6134
- emailType?: PreviewEmailTypeWithLiterals;
6235
+ /** @enumType */
6236
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
6237
+ interface V1ScheduledAction {
6238
+ /** Type of the action. */
6239
+ actionType?: ActionTypeWithLiterals;
6240
+ /** The date and time of the action. */
6241
+ executionDate?: Date | null;
6135
6242
  }
6136
- declare enum PreviewEmailType {
6137
- ORDER_PLACED = "ORDER_PLACED",
6138
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
6139
- ORDER_SHIPPED = "ORDER_SHIPPED",
6140
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
6243
+ declare enum ActionType {
6244
+ VOID = "VOID",
6245
+ CAPTURE = "CAPTURE"
6141
6246
  }
6142
6247
  /** @enumType */
6143
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
6144
- interface PreviewEmailByTypeResponse {
6145
- emailPreview?: string;
6146
- }
6147
- interface PreviewRefundEmailRequest {
6148
- /**
6149
- * @minLength 1
6150
- * @maxLength 100
6151
- */
6152
- orderId?: string;
6153
- /** Refund amount */
6154
- refundAmount?: Price;
6155
- /** Refund business details */
6156
- details?: RefundDetails;
6248
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
6249
+ interface Chargeback {
6157
6250
  /**
6158
- * Personal note added to the email (optional)
6159
- * @minLength 1
6160
- * @maxLength 1000
6251
+ * Chargeback ID.
6252
+ * @format GUID
6253
+ * @readonly
6254
+ * @immutable
6161
6255
  */
6162
- customMessage?: string | null;
6256
+ _id?: string;
6163
6257
  /**
6164
- * Refund ID. (Optional)
6165
- * @format GUID
6258
+ * Date and time the chargeback 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.
6259
+ * @readonly
6260
+ * @immutable
6166
6261
  */
6167
- refundId?: string | null;
6168
- }
6169
- interface PreviewRefundEmailResponse {
6170
- emailPreview?: string;
6171
- }
6172
- interface PreviewCancelEmailRequest {
6262
+ _createdDate?: Date | null;
6173
6263
  /**
6174
- * @minLength 1
6175
- * @maxLength 100
6264
+ * Date and time the chargeback was updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
6265
+ * @readonly
6176
6266
  */
6177
- orderId?: string;
6267
+ _updatedDate?: Date | null;
6178
6268
  /**
6179
- * Personal note added to the email (optional)
6180
- * @minLength 1
6181
- * @maxLength 1000
6269
+ * Amount.
6270
+ * @readonly
6271
+ * @immutable
6182
6272
  */
6183
- customMessage?: string | null;
6184
- }
6185
- interface PreviewCancelEmailResponse {
6186
- emailPreview?: string;
6187
- }
6188
- interface PreviewCancelRefundEmailRequest {
6273
+ amount?: Price;
6189
6274
  /**
6190
- * @minLength 1
6191
- * @maxLength 100
6275
+ * Reversal amount. Present only when status is REVERSED.
6276
+ * @readonly
6192
6277
  */
6193
- orderId?: string;
6278
+ reversalAmount?: Price;
6194
6279
  /**
6195
- * Personal note added to the email (optional)
6196
- * @minLength 1
6197
- * @maxLength 1000
6280
+ * Status.
6281
+ *
6282
+ * Default: `"APPROVED"`.
6198
6283
  */
6199
- customMessage?: string | null;
6200
- /** Refund amount */
6201
- refundAmount?: Price;
6284
+ status?: ChargebackStatusWithLiterals;
6202
6285
  /**
6203
- * Refund ID. (Optional)
6286
+ * External chargeback ID.
6204
6287
  * @format GUID
6288
+ * @readonly
6289
+ * @immutable
6205
6290
  */
6206
- refundId?: string | null;
6207
- }
6208
- interface PreviewCancelRefundEmailResponse {
6209
- emailPreview?: string;
6210
- }
6211
- interface PreviewBuyerPaymentsReceivedEmailRequest {
6212
- }
6213
- interface PreviewBuyerPaymentsReceivedEmailResponse {
6214
- emailPreview?: string;
6215
- }
6216
- interface PreviewBuyerConfirmationEmailRequest {
6217
- }
6218
- interface PreviewBuyerConfirmationEmailResponse {
6219
- emailPreview?: string;
6220
- }
6221
- interface PreviewBuyerPickupConfirmationEmailRequest {
6222
- }
6223
- interface PreviewBuyerPickupConfirmationEmailResponse {
6224
- emailPreview?: string;
6225
- }
6226
- interface PreviewShippingConfirmationEmailRequest {
6227
- }
6228
- interface PreviewShippingConfirmationEmailResponse {
6229
- emailPreview?: string;
6230
- }
6231
- interface PreviewResendDownloadLinksEmailRequest {
6291
+ externalId?: string | null;
6232
6292
  }
6233
- interface PreviewResendDownloadLinksEmailResponse {
6234
- emailPreview?: string;
6293
+ declare enum ChargebackStatus {
6294
+ /** Chargeback was approved. */
6295
+ APPROVED = "APPROVED",
6296
+ /** Chargeback was reversed. */
6297
+ REVERSED = "REVERSED"
6235
6298
  }
6236
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
6237
- /** Emitted on a meta site creation. */
6238
- siteCreated?: SiteCreated;
6239
- /** Emitted on a meta site transfer completion. */
6240
- siteTransferred?: SiteTransferred;
6241
- /** Emitted on a meta site deletion. */
6242
- siteDeleted?: SiteDeleted;
6243
- /** Emitted on a meta site restoration. */
6244
- siteUndeleted?: SiteUndeleted;
6245
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6246
- sitePublished?: SitePublished;
6247
- /** Emitted on a meta site unpublish. */
6248
- siteUnpublished?: SiteUnpublished;
6249
- /** Emitted when meta site is marked as template. */
6250
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6251
- /** Emitted when meta site is marked as a WixSite. */
6252
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6253
- /** Emitted when an application is provisioned (installed). */
6254
- serviceProvisioned?: ServiceProvisioned;
6255
- /** Emitted when an application is removed (uninstalled). */
6256
- serviceRemoved?: ServiceRemoved;
6257
- /** Emitted when meta site name (URL slug) is changed. */
6258
- siteRenamedPayload?: SiteRenamed;
6259
- /** Emitted when meta site was permanently deleted. */
6260
- hardDeleted?: SiteHardDeleted;
6261
- /** Emitted on a namespace change. */
6262
- namespaceChanged?: NamespaceChanged;
6263
- /** Emitted when Studio is attached. */
6264
- studioAssigned?: StudioAssigned;
6265
- /** Emitted when Studio is detached. */
6266
- studioUnassigned?: StudioUnassigned;
6299
+ /** @enumType */
6300
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
6301
+ interface PaymentMethodName {
6267
6302
  /**
6268
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6269
- * the actual URL.
6270
- *
6271
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6272
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6303
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
6304
+ * @maxLength 150
6273
6305
  */
6274
- urlChanged?: SiteUrlChanged;
6275
- /** Site is marked as PurgedExternally */
6276
- sitePurgedExternally?: SitePurgedExternally;
6277
- /** Emitted when Odeditor is attached. */
6278
- odeditorAssigned?: OdeditorAssigned;
6279
- /** Emitted when Odeditor is detached. */
6280
- odeditorUnassigned?: OdeditorUnassigned;
6281
- /** Emitted when Picasso is attached. */
6282
- picassoAssigned?: PicassoAssigned;
6283
- /** Emitted when Picasso is detached. */
6284
- picassoUnassigned?: PicassoUnassigned;
6285
- /** Emitted when Wixel is attached. */
6286
- wixelAssigned?: WixelAssigned;
6287
- /** Emitted when Wixel is detached. */
6288
- wixelUnassigned?: WixelUnassigned;
6289
- /** Emitted when StudioTwo is attached. */
6290
- studioTwoAssigned?: StudioTwoAssigned;
6291
- /** Emitted when StudioTwo is detached. */
6292
- studioTwoUnassigned?: StudioTwoUnassigned;
6293
- /** Emitted when media from user domain is enabled. */
6294
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6295
- /** Emitted when media from user domain is disabled. */
6296
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6297
- /** Emitted when Editorless is attached. */
6298
- editorlessAssigned?: EditorlessAssigned;
6299
- /** Emitted when Editorless is detached. */
6300
- editorlessUnassigned?: EditorlessUnassigned;
6306
+ buyerLanguageName?: string | null;
6301
6307
  /**
6302
- * A meta site id.
6303
- * @format GUID
6308
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
6309
+ *
6310
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
6311
+ * @maxLength 150
6304
6312
  */
6305
- metaSiteId?: string;
6306
- /** A meta site version. Monotonically increasing. */
6307
- version?: string;
6308
- /** A timestamp of the event. */
6309
- timestamp?: string;
6313
+ siteLanguageName?: string | null;
6310
6314
  /**
6311
- * TODO(meta-site): Change validation once validations are disabled for consumers
6312
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
6313
- * @maxSize 4000
6315
+ * User-provided payment method name.
6316
+ *
6317
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
6314
6318
  */
6315
- assets?: Asset[];
6319
+ userDefinedName?: UserDefinedPaymentMethodName;
6316
6320
  }
6317
- /** @oneof */
6318
- interface MetaSiteSpecialEventPayloadOneOf {
6319
- /** Emitted on a meta site creation. */
6320
- siteCreated?: SiteCreated;
6321
- /** Emitted on a meta site transfer completion. */
6322
- siteTransferred?: SiteTransferred;
6323
- /** Emitted on a meta site deletion. */
6324
- siteDeleted?: SiteDeleted;
6325
- /** Emitted on a meta site restoration. */
6326
- siteUndeleted?: SiteUndeleted;
6327
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6328
- sitePublished?: SitePublished;
6329
- /** Emitted on a meta site unpublish. */
6330
- siteUnpublished?: SiteUnpublished;
6331
- /** Emitted when meta site is marked as template. */
6332
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6333
- /** Emitted when meta site is marked as a WixSite. */
6334
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6335
- /** Emitted when an application is provisioned (installed). */
6336
- serviceProvisioned?: ServiceProvisioned;
6337
- /** Emitted when an application is removed (uninstalled). */
6338
- serviceRemoved?: ServiceRemoved;
6339
- /** Emitted when meta site name (URL slug) is changed. */
6340
- siteRenamedPayload?: SiteRenamed;
6341
- /** Emitted when meta site was permanently deleted. */
6342
- hardDeleted?: SiteHardDeleted;
6343
- /** Emitted on a namespace change. */
6344
- namespaceChanged?: NamespaceChanged;
6345
- /** Emitted when Studio is attached. */
6346
- studioAssigned?: StudioAssigned;
6347
- /** Emitted when Studio is detached. */
6348
- studioUnassigned?: StudioUnassigned;
6321
+ interface GiftCardPaymentDetails {
6322
+ /**
6323
+ * Gift card payment ID.
6324
+ * @maxLength 100
6325
+ */
6326
+ giftCardPaymentId?: string;
6327
+ /**
6328
+ * Gift card ID.
6329
+ * @internal
6330
+ * @deprecated
6331
+ */
6332
+ giftCardId?: string;
6349
6333
  /**
6350
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6351
- * the actual URL.
6352
- *
6353
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6354
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6334
+ * ID of the app that created the gift card.
6335
+ * @format GUID
6355
6336
  */
6356
- urlChanged?: SiteUrlChanged;
6357
- /** Site is marked as PurgedExternally */
6358
- sitePurgedExternally?: SitePurgedExternally;
6359
- /** Emitted when Odeditor is attached. */
6360
- odeditorAssigned?: OdeditorAssigned;
6361
- /** Emitted when Odeditor is detached. */
6362
- odeditorUnassigned?: OdeditorUnassigned;
6363
- /** Emitted when Picasso is attached. */
6364
- picassoAssigned?: PicassoAssigned;
6365
- /** Emitted when Picasso is detached. */
6366
- picassoUnassigned?: PicassoUnassigned;
6367
- /** Emitted when Wixel is attached. */
6368
- wixelAssigned?: WixelAssigned;
6369
- /** Emitted when Wixel is detached. */
6370
- wixelUnassigned?: WixelUnassigned;
6371
- /** Emitted when StudioTwo is attached. */
6372
- studioTwoAssigned?: StudioTwoAssigned;
6373
- /** Emitted when StudioTwo is detached. */
6374
- studioTwoUnassigned?: StudioTwoUnassigned;
6375
- /** Emitted when media from user domain is enabled. */
6376
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6377
- /** Emitted when media from user domain is disabled. */
6378
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6379
- /** Emitted when Editorless is attached. */
6380
- editorlessAssigned?: EditorlessAssigned;
6381
- /** Emitted when Editorless is detached. */
6382
- editorlessUnassigned?: EditorlessUnassigned;
6383
- }
6384
- interface Asset {
6337
+ appId?: string;
6385
6338
  /**
6386
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
6387
- * @maxLength 36
6339
+ * Whether the gift card is voided.
6340
+ * @readonly
6341
+ * @deprecated Whether the gift card is voided.
6342
+ * @replacedBy payment.status
6343
+ * @targetRemovalDate 2026-11-01
6388
6344
  */
6389
- appDefId?: string;
6345
+ voided?: boolean;
6390
6346
  /**
6391
- * An instance id. For legacy reasons may be UUID or a string.
6347
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
6348
+ * @maxLength 30
6349
+ * @immutable
6350
+ */
6351
+ obfuscatedCode?: string | null;
6352
+ }
6353
+ interface MembershipPaymentDetails {
6354
+ /**
6355
+ * Membership ID.
6392
6356
  * @maxLength 200
6393
6357
  */
6394
- instanceId?: string;
6395
- /** An application state. */
6396
- state?: StateWithLiterals;
6358
+ membershipId?: string;
6359
+ /**
6360
+ * ID of the line item this membership applies to.
6361
+ * @minLength 1
6362
+ * @maxLength 100
6363
+ */
6364
+ lineItemId?: string;
6365
+ /**
6366
+ * Payment status.
6367
+ * @deprecated Payment status.
6368
+ * @replacedBy payment.status
6369
+ * @targetRemovalDate 2026-11-01
6370
+ */
6371
+ status?: MembershipPaymentStatusWithLiterals;
6372
+ /** Membership name. */
6373
+ name?: MembershipName;
6374
+ /**
6375
+ * The transaction ID in the membership system. Can be used to void the transaction.
6376
+ * @minLength 1
6377
+ * @maxLength 100
6378
+ */
6379
+ externalTransactionId?: string | null;
6380
+ /**
6381
+ * Whether the membership is voided.
6382
+ * @readonly
6383
+ * @deprecated Whether the membership is voided.
6384
+ * @replacedBy payment.status
6385
+ * @targetRemovalDate 2026-11-01
6386
+ */
6387
+ voided?: boolean;
6388
+ /**
6389
+ * ID of the application providing this payment option.
6390
+ * @format GUID
6391
+ */
6392
+ providerAppId?: string;
6393
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6394
+ futureMembership?: FutureMembershipDetails;
6397
6395
  }
6398
- declare enum State {
6399
- UNKNOWN = "UNKNOWN",
6400
- ENABLED = "ENABLED",
6401
- DISABLED = "DISABLED",
6402
- PENDING = "PENDING",
6403
- DEMO = "DEMO"
6396
+ declare enum MembershipPaymentStatus {
6397
+ /** Payment was charged. */
6398
+ CHARGED = "CHARGED",
6399
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
6400
+ CHARGE_FAILED = "CHARGE_FAILED",
6401
+ /** Payment is pending. */
6402
+ CHARGE_PENDING = "CHARGE_PENDING",
6403
+ /** Payment was voided. */
6404
+ VOIDED = "VOIDED"
6404
6405
  }
6405
6406
  /** @enumType */
6406
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
6407
- interface SiteCreated {
6407
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6408
+ interface FutureMembershipDetails {
6408
6409
  /**
6409
- * A template identifier (empty if not created from a template).
6410
- * @maxLength 36
6410
+ * ID of the plan line item in the order from which the membership will be created.
6411
+ * @format GUID
6411
6412
  */
6412
- originTemplateId?: string;
6413
+ lineItemId?: string;
6413
6414
  /**
6414
- * An account id of the owner.
6415
- * @format GUID
6415
+ * ID of the benefit the future membership will grant.
6416
+ * @maxLength 200
6416
6417
  */
6417
- ownerId?: string;
6418
- /** A context in which meta site was created. */
6419
- context?: SiteCreatedContextWithLiterals;
6418
+ benefitId?: string;
6419
+ }
6420
+ interface WixReceiptInfo {
6420
6421
  /**
6421
- * A meta site id from which this site was created.
6422
- *
6423
- * In case of a creation from a template it's a template id.
6424
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
6422
+ * Receipt ID
6425
6423
  * @format GUID
6426
6424
  */
6427
- originMetaSiteId?: string | null;
6425
+ receiptId?: string;
6428
6426
  /**
6429
- * A meta site name (URL slug).
6430
- * @maxLength 20
6427
+ * Display number of receipt
6428
+ * @minLength 1
6429
+ * @maxLength 40
6431
6430
  */
6432
- siteName?: string;
6433
- /** A namespace. */
6434
- namespace?: NamespaceWithLiterals;
6435
- }
6436
- declare enum SiteCreatedContext {
6437
- /** A valid option, we don't expose all reasons why site might be created. */
6438
- OTHER = "OTHER",
6439
- /** A meta site was created from template. */
6440
- FROM_TEMPLATE = "FROM_TEMPLATE",
6441
- /** A meta site was created by copying of the transfferred meta site. */
6442
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
6443
- /** A copy of existing meta site. */
6444
- DUPLICATE = "DUPLICATE",
6445
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
6446
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
6447
- /** deprecated A meta site was created for Flash editor. */
6448
- FLASH = "FLASH"
6431
+ displayNumber?: string | null;
6449
6432
  }
6450
- /** @enumType */
6451
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
6452
- declare enum Namespace {
6453
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
6454
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
6455
- WIX = "WIX",
6456
- /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6457
- SHOUT_OUT = "SHOUT_OUT",
6458
- /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6459
- ALBUMS = "ALBUMS",
6460
- /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6461
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
6462
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6463
- HOTELS = "HOTELS",
6464
- /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6465
- CLUBS = "CLUBS",
6466
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6467
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
6433
+ interface ExternalReceiptInfo {
6468
6434
  /**
6469
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
6470
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
6435
+ * External receipt ID
6436
+ * @maxLength 100
6471
6437
  */
6472
- DEV_SITE = "DEV_SITE",
6473
- /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6474
- LOGOS = "LOGOS",
6475
- /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6476
- VIDEO_MAKER = "VIDEO_MAKER",
6477
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6478
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
6479
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6480
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
6438
+ receiptId?: string | null;
6481
6439
  /**
6482
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
6483
- *
6484
- * Meta site with this namespace will *not* be shown in a user's site list by default.
6440
+ * ID of the app providing the receipt
6441
+ * @format GUID
6485
6442
  */
6486
- HTML_DRAFT = "HTML_DRAFT",
6443
+ appId?: string | null;
6487
6444
  /**
6488
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
6489
- * Will be accessible from Site List and will not have a website app.
6490
- * Once the user attaches a site, the site will become a regular wixsite.
6445
+ * Display number of receipt
6446
+ * @minLength 1
6447
+ * @maxLength 40
6491
6448
  */
6492
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
6493
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
6494
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
6495
- /** It is to be used in the Business First efforts. */
6496
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
6497
- /** Bookings business flow with no site. */
6498
- ANYWHERE = "ANYWHERE",
6499
- /** Namespace for Headless Backoffice with no editor */
6500
- HEADLESS = "HEADLESS",
6449
+ displayNumber?: string | null;
6450
+ }
6451
+ interface CashRoundingDetails {
6501
6452
  /**
6502
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
6503
- * The site will be used for account level CSM feature for enterprise
6453
+ * Payment amount before cash rounding was applied.
6454
+ * When provided, balance and status calculations use this value instead of `amount`
6455
+ * to prevent false overpayment or underpayment due to rounding.
6504
6456
  */
6505
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
6506
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
6507
- RISE = "RISE",
6457
+ unroundedAmount?: Price;
6458
+ /**
6459
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6460
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6461
+ * @readonly
6462
+ */
6463
+ roundingAdjustment?: CashRounding;
6464
+ }
6465
+ declare enum PaymentStatus {
6466
+ /** Payment was charged successfully. */
6467
+ APPROVED = "APPROVED",
6468
+ /** Payment is being processed and hasn't been confirmed yet. */
6469
+ PENDING = "PENDING",
6470
+ /** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
6471
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6472
+ /** Payment was canceled before it was charged. */
6473
+ CANCELED = "CANCELED",
6474
+ /** Payment was declined by the payment provider. */
6475
+ DECLINED = "DECLINED",
6476
+ /** Payment was fully refunded. */
6477
+ REFUNDED = "REFUNDED",
6478
+ /** Part of the payment amount was refunded. */
6479
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6480
+ /** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
6481
+ AUTHORIZED = "AUTHORIZED",
6508
6482
  /**
6509
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
6510
- * There's a blank site behind the scene but it's blank).
6511
- * The Mobile company will be the owner of this namespace.
6483
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6484
+ *
6485
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6512
6486
  */
6513
- BRANDED_FIRST = "BRANDED_FIRST",
6514
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
6515
- NOWNIA = "NOWNIA",
6487
+ VOIDED = "VOIDED"
6488
+ }
6489
+ /** @enumType */
6490
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6491
+ interface CanceledStatusDetails {
6492
+ reason?: CanceledReasonWithLiterals;
6493
+ }
6494
+ declare enum CanceledReason {
6495
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
6496
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6497
+ /** Payment was not completed by user and expired. */
6498
+ EXPIRED = "EXPIRED"
6499
+ }
6500
+ /** @enumType */
6501
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6502
+ interface DeclinedStatusDetails {
6503
+ reason?: DeclinedReasonWithLiterals;
6504
+ }
6505
+ declare enum DeclinedReason {
6506
+ /** Corresponding charge failed. */
6507
+ CHARGE_FAILED = "CHARGE_FAILED",
6508
+ /** Payment details expired. */
6509
+ EXPIRED = "EXPIRED",
6510
+ /** Insufficient funds. */
6511
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6512
+ /** Gift card was disabled before charge was attempted. */
6513
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6514
+ }
6515
+ /** @enumType */
6516
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6517
+ interface VoidedStatusDetails {
6518
+ reason?: VoidedReasonWithLiterals;
6519
+ }
6520
+ declare enum VoidedReason {
6521
+ /** Payment was voided by merchant request. */
6522
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
6523
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6524
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6525
+ }
6526
+ /** @enumType */
6527
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6528
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6529
+ /** @internal */
6530
+ canceled?: CanceledStatusDetails;
6531
+ /** @internal */
6532
+ declined?: DeclinedStatusDetails;
6533
+ /** @internal */
6534
+ voided?: VoidedStatusDetails;
6516
6535
  /**
6517
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
6518
- * The Partners company owns this namespace.
6536
+ * Reason code from the payment gateway.
6537
+ * @internal
6538
+ * @minLength 1
6539
+ * @maxLength 10
6519
6540
  */
6520
- UGC_TEMPLATE = "UGC_TEMPLATE",
6521
- /** Codux Headless Sites */
6522
- CODUX = "CODUX",
6523
- /** Bobb - AI Design Creator. */
6524
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
6541
+ paymentGatewayReasonCode?: string | null;
6542
+ }
6543
+ /** @oneof */
6544
+ interface PaymentStatusDetailsStatusDetailsOneOf {
6545
+ /** @internal */
6546
+ canceled?: CanceledStatusDetails;
6547
+ /** @internal */
6548
+ declined?: DeclinedStatusDetails;
6549
+ /** @internal */
6550
+ voided?: VoidedStatusDetails;
6551
+ }
6552
+ interface Refund {
6525
6553
  /**
6526
- * Shared Blog Site is a unique single site across Enterprise account,
6527
- * This site will hold all Blog posts related to the Marketing product.
6554
+ * Refund ID.
6555
+ * @format GUID
6556
+ * @readonly
6528
6557
  */
6529
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6530
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6531
- STANDALONE_FORMS = "STANDALONE_FORMS",
6532
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6533
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
6534
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6535
- MIMIR = "MIMIR",
6536
- /** Wix Twins platform. */
6537
- TWINS = "TWINS",
6538
- /** Wix Nano. */
6539
- NANO = "NANO",
6540
- /** Base44 headless sites. */
6541
- BASE44 = "BASE44",
6542
- /** Wix Channels Sites */
6543
- CHANNELS = "CHANNELS",
6544
- /** Nautilus platform. */
6545
- NAUTILUS = "NAUTILUS",
6558
+ _id?: string;
6546
6559
  /**
6547
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6548
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6560
+ * List of transactions.
6561
+ * @maxSize 50
6549
6562
  */
6550
- SYMPHONY = "SYMPHONY",
6551
- /** Nautilus platform app. */
6552
- NAUTILUS_APPS = "NAUTILUS_APPS",
6563
+ transactions?: RefundTransaction[];
6564
+ /** Refund business details. */
6565
+ details?: RefundDetails;
6553
6566
  /**
6554
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6555
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6567
+ * 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.
6568
+ * @readonly
6569
+ * @immutable
6556
6570
  */
6557
- VIBU = "VIBU",
6571
+ _createdDate?: Date | null;
6558
6572
  /**
6559
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6560
- * (an Enterprise account may have several), holding that BrandKit's brand definition
6561
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6562
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
6573
+ * Aggregated refund summary.
6574
+ * @readonly
6563
6575
  */
6564
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6576
+ summary?: AggregatedRefundSummary;
6565
6577
  /**
6566
- * Dev-center development sites (com.wixpress.devcenter.dsm).
6567
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6578
+ * ID of the app that initiated this refund.
6579
+ * @format GUID
6580
+ * @readonly
6581
+ * @immutable
6568
6582
  */
6569
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6583
+ requestingServiceAppId?: string | null;
6570
6584
  }
6571
- /** @enumType */
6572
- type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
6573
- /** Site transferred to another user. */
6574
- interface SiteTransferred {
6585
+ interface RefundTransaction {
6575
6586
  /**
6576
- * A previous owner id (user that transfers meta site).
6587
+ * ID of the payment associated with this refund.
6577
6588
  * @format GUID
6589
+ * @immutable
6578
6590
  */
6579
- oldOwnerId?: string;
6591
+ paymentId?: string;
6580
6592
  /**
6581
- * A new owner id (user that accepts meta site).
6593
+ * Refund amount.
6594
+ * @immutable
6595
+ */
6596
+ amount?: Price;
6597
+ /** Refund status. */
6598
+ refundStatus?: RefundStatusWithLiterals;
6599
+ /** Optional details of current refund status. */
6600
+ refundStatusInfo?: RefundStatusInfo;
6601
+ /**
6602
+ * Payment gateway's refund ID.
6603
+ * This field is only returned when the value of `external_refund` is `false`.
6582
6604
  * @format GUID
6583
6605
  */
6584
- newOwnerId?: string;
6585
- }
6586
- /** Soft deletion of the meta site. Could be restored. */
6587
- interface SiteDeleted {
6588
- /** A deletion context. */
6589
- deleteContext?: DeleteContext;
6590
- }
6591
- interface DeleteContext {
6592
- /** When the meta site was deleted. */
6593
- dateDeleted?: Date | null;
6594
- /** A status. */
6595
- deleteStatus?: DeleteStatusWithLiterals;
6606
+ gatewayRefundId?: string | null;
6607
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6608
+ providerRefundId?: string | null;
6596
6609
  /**
6597
- * A reason (flow).
6598
- * @maxLength 255
6610
+ * Whether refund was made externally and manually on the payment provider's side.
6611
+ * @immutable
6599
6612
  */
6600
- deleteOrigin?: string;
6613
+ externalRefund?: boolean;
6601
6614
  /**
6602
- * A service that deleted it.
6603
- * @maxLength 255
6615
+ * Location where the refund was processed.
6616
+ * @internal
6617
+ * @format GUID
6618
+ * @immutable
6604
6619
  */
6605
- initiatorId?: string | null;
6620
+ locationId?: string | null;
6606
6621
  }
6607
- declare enum DeleteStatus {
6608
- UNKNOWN = "UNKNOWN",
6609
- TRASH = "TRASH",
6610
- DELETED = "DELETED",
6611
- PENDING_PURGE = "PENDING_PURGE",
6612
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6622
+ /** Refund transaction status. */
6623
+ declare enum RefundStatus {
6624
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6625
+ PENDING = "PENDING",
6626
+ /** Refund transaction succeeded. */
6627
+ SUCCEEDED = "SUCCEEDED",
6628
+ /** Refund transaction failed. */
6629
+ FAILED = "FAILED",
6630
+ /** Refund request acknowledged, and will be executed soon. */
6631
+ SCHEDULED = "SCHEDULED",
6632
+ /** Refund was initiated on payment provider side. */
6633
+ STARTED = "STARTED"
6613
6634
  }
6614
6635
  /** @enumType */
6615
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6616
- /** Restoration of the meta site. */
6617
- interface SiteUndeleted {
6618
- }
6619
- /** First publish of a meta site. Or subsequent publish after unpublish. */
6620
- interface SitePublished {
6621
- }
6622
- interface SiteUnpublished {
6636
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6637
+ interface RefundStatusInfo {
6623
6638
  /**
6624
- * A list of URLs previously associated with the meta site.
6625
- * @maxLength 4000
6626
- * @maxSize 10000
6639
+ * Reason code for the refund's current status.
6640
+ *
6641
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6642
+ * @minLength 1
6643
+ * @maxLength 10
6627
6644
  */
6628
- urls?: string[];
6629
- }
6630
- interface SiteMarkedAsTemplate {
6631
- }
6632
- interface SiteMarkedAsWixSite {
6645
+ paymentGatewayReasonCode?: string | null;
6646
+ /**
6647
+ * Free text explanation of current refund status.
6648
+ * @minLength 1
6649
+ * @maxLength 1000
6650
+ */
6651
+ description?: string | null;
6633
6652
  }
6634
- /**
6635
- * Represents a service provisioned a site.
6636
- *
6637
- * Note on `origin_instance_id`:
6638
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6639
- * This is because of the following scenario:
6640
- *
6641
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
6642
- * such as a product catalog. When you create a site from this template, you inherit this
6643
- * default product catalog. However, if the template's product catalog is modified,
6644
- * your site will retain the catalog as it was at the time of site creation. This ensures that
6645
- * your site remains consistent with what you initially received and does not include any
6646
- * changes made to the original template afterward.
6647
- * To ensure this, the TPA on the template gets a new instance_id.
6648
- */
6649
- interface ServiceProvisioned {
6653
+ interface AggregatedRefundSummary {
6654
+ /** Total amount requested for refund. */
6655
+ requestedRefund?: Price;
6656
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6657
+ pendingRefund?: Price;
6658
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6659
+ refunded?: Price;
6660
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
6661
+ failedRefundAmount?: Price;
6662
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
6663
+ pending?: boolean;
6664
+ /** Breakdown of refunded items. Available only after refund is complete. */
6665
+ breakdown?: RefundItemsBreakdown;
6666
+ }
6667
+ interface RefundItemsBreakdown {
6650
6668
  /**
6651
- * Either UUID or EmbeddedServiceType.
6652
- * @maxLength 36
6669
+ * Refunded line items and the amount refunded for each.
6670
+ * @maxSize 300
6653
6671
  */
6654
- appDefId?: string;
6672
+ lineItems?: LineItemRefundSummary[];
6673
+ }
6674
+ interface LineItemRefundSummary {
6655
6675
  /**
6656
- * Not only UUID. Something here could be something weird.
6657
- * @maxLength 36
6676
+ * ID of the refunded line item.
6677
+ * @format GUID
6658
6678
  */
6659
- instanceId?: string;
6679
+ lineItemId?: string;
6680
+ /** Total refunded amount for the line item. */
6681
+ totalRefundedAmount?: Price;
6682
+ }
6683
+ interface CalculateRefundRequest {
6660
6684
  /**
6661
- * An instance id from which this instance is originated.
6662
- * @maxLength 36
6685
+ * Order ID
6686
+ * @minLength 1
6687
+ * @maxLength 100
6663
6688
  */
6664
- originInstanceId?: string;
6689
+ ecomOrderId?: string;
6665
6690
  /**
6666
- * A version.
6667
- * @maxLength 500
6691
+ * Refunded line items and quantity
6692
+ * @maxSize 300
6668
6693
  */
6669
- version?: string | null;
6694
+ refundItems?: CalculateRefundItemRequest[];
6695
+ /** Should include shipping in refund calculation */
6696
+ refundShipping?: boolean;
6697
+ }
6698
+ interface CalculateRefundItemRequest {
6670
6699
  /**
6671
- * The origin meta site id
6700
+ * ID of the line item being refunded
6672
6701
  * @format GUID
6673
6702
  */
6674
- originMetaSiteId?: string | null;
6675
- }
6676
- interface ServiceRemoved {
6703
+ _id?: string;
6677
6704
  /**
6678
- * Either UUID or EmbeddedServiceType.
6679
- * @maxLength 36
6705
+ * How much of that line item is being refunded
6706
+ * @min 1
6707
+ * @max 100000
6680
6708
  */
6681
- appDefId?: string;
6709
+ quantity?: number;
6710
+ }
6711
+ interface CalculateRefundResponse {
6712
+ /** Total refundable amount */
6713
+ total?: Price;
6714
+ /** Tax cost of the order */
6715
+ tax?: Price;
6716
+ /** Discount given for this order */
6717
+ discount?: Price;
6718
+ /** Total cost of the order (without tax) */
6719
+ subtotal?: Price;
6720
+ /** Total shipping cost for order */
6721
+ shipping?: Price;
6722
+ /** Previous refund given on that order */
6723
+ previouslyRefundedAmount?: Price;
6682
6724
  /**
6683
- * Not only UUID. Something here could be something weird.
6684
- * @maxLength 36
6725
+ * The refundable items of that order
6726
+ * @maxSize 300
6685
6727
  */
6686
- instanceId?: string;
6728
+ items?: CalculateRefundItemResponse[];
6729
+ }
6730
+ interface CalculateRefundItemResponse {
6687
6731
  /**
6688
- * A version.
6689
- * @maxLength 500
6732
+ * Line item ID
6733
+ * @format GUID
6690
6734
  */
6691
- version?: string | null;
6735
+ _id?: string;
6736
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6737
+ price?: Price;
6692
6738
  }
6693
- /** Rename of the site. Meaning, free public url has been changed as well. */
6694
- interface SiteRenamed {
6739
+ interface VoidAuthorizedPaymentsRequest {
6695
6740
  /**
6696
- * A new meta site name (URL slug).
6697
- * @maxLength 20
6741
+ * Wix eCommerce order ID
6742
+ * @minLength 1
6743
+ * @maxLength 100
6698
6744
  */
6699
- newSiteName?: string;
6745
+ ecomOrderId: string;
6700
6746
  /**
6701
- * A previous meta site name (URL slug).
6702
- * @maxLength 255
6747
+ * Payment IDs
6748
+ * @minSize 1
6749
+ * @maxSize 100
6750
+ * @format GUID
6703
6751
  */
6704
- oldSiteName?: string;
6705
- }
6706
- /**
6707
- * Hard deletion of the meta site.
6708
- *
6709
- * Could not be restored. Therefore it's desirable to cleanup data.
6710
- */
6711
- interface SiteHardDeleted {
6712
- /** A deletion context. */
6713
- deleteContext?: DeleteContext;
6714
- }
6715
- interface NamespaceChanged {
6716
- /** A previous namespace. */
6717
- oldNamespace?: NamespaceWithLiterals;
6718
- /** A new namespace. */
6719
- newNamespace?: NamespaceWithLiterals;
6720
- }
6721
- /** Assigned Studio editor */
6722
- interface StudioAssigned {
6723
- }
6724
- /** Unassigned Studio editor */
6725
- interface StudioUnassigned {
6752
+ paymentIds: string[];
6726
6753
  }
6727
- /**
6728
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6729
- *
6730
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6731
- * with sites and its urls, you need to listen to another topic/event. Read about it:
6732
- *
6733
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6734
- */
6735
- interface SiteUrlChanged {
6754
+ interface VoidAuthorizedPaymentsResponse {
6755
+ /** All order's transactions after the void was triggered */
6756
+ orderTransactions?: OrderTransactions;
6736
6757
  }
6737
- /**
6738
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6739
- * Consumed by other teams to remove relevant data.
6740
- */
6741
- interface SitePurgedExternally {
6758
+ interface CaptureAuthorizedPaymentsRequest {
6742
6759
  /**
6743
- * @maxLength 2048
6760
+ * Wix eCommerce order ID
6761
+ * @minLength 1
6762
+ * @maxLength 100
6763
+ */
6764
+ ecomOrderId: string;
6765
+ /**
6766
+ * Capture payments information
6767
+ * @minSize 1
6744
6768
  * @maxSize 100
6745
- * @deprecated
6746
- * @targetRemovalDate 2025-04-15
6747
6769
  */
6748
- appDefId?: string[];
6749
- }
6750
- /** Assigned Odeditor */
6751
- interface OdeditorAssigned {
6752
- }
6753
- /** Unassigned Odeditor */
6754
- interface OdeditorUnassigned {
6755
- }
6756
- /** Assigned Picasso editor */
6757
- interface PicassoAssigned {
6758
- }
6759
- /** Unassigned Picasso */
6760
- interface PicassoUnassigned {
6761
- }
6762
- /** Assigned Wixel */
6763
- interface WixelAssigned {
6764
- }
6765
- /** Unassigned Wixel */
6766
- interface WixelUnassigned {
6767
- }
6768
- /** Assigned StudioTwo */
6769
- interface StudioTwoAssigned {
6770
- }
6771
- /** Unassigned StudioTwo */
6772
- interface StudioTwoUnassigned {
6773
- }
6774
- /** Media from user domain is enabled. */
6775
- interface UserDomainMediaEnabled {
6776
- }
6777
- /** Media from user domain is disabled. */
6778
- interface UserDomainMediaDisabled {
6779
- }
6780
- /** Assigned Editorless */
6781
- interface EditorlessAssigned {
6782
- }
6783
- /** Unassigned Editorless */
6784
- interface EditorlessUnassigned {
6770
+ payments: PaymentCapture[];
6785
6771
  }
6786
- interface HasCustomEmailConfigurationsRequest {
6772
+ interface PaymentCapture {
6773
+ /**
6774
+ * Payment ID
6775
+ * @format GUID
6776
+ */
6777
+ paymentId?: string | null;
6778
+ /**
6779
+ * Capture amount.
6780
+ * If not provided - full authorized amount will be captured.
6781
+ */
6782
+ amount?: Price;
6787
6783
  }
6788
- interface HasCustomEmailConfigurationsResponse {
6789
- hasCustomConfigurations?: boolean;
6784
+ interface CaptureAuthorizedPaymentsResponse {
6785
+ /** All order's transactions after the capture was triggered */
6786
+ orderTransactions?: OrderTransactions;
6790
6787
  }
6791
- interface AddToAutomationMigrationPopulationRequest {
6792
- /** When true, sends custom email configurations to automation system via email */
6793
- sendCustomEmailConfigs?: boolean;
6794
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6795
- origin?: OriginWithLiterals;
6788
+ interface ChargeSavedPaymentMethodRequest {
6789
+ /**
6790
+ * Ecom Order ID.
6791
+ * @minLength 1
6792
+ * @maxLength 100
6793
+ */
6794
+ ecomOrderId?: string;
6795
+ /** Amount to be charged */
6796
+ amount?: Price;
6796
6797
  }
6797
- declare enum Origin {
6798
- OPT_IN = "OPT_IN",
6799
- MIGRATION = "MIGRATION"
6798
+ interface ChargeSavedPaymentMethodResponse {
6799
+ /** Payment gateway's order ID (e.g Wix Payments) */
6800
+ paymentGatewayOrderId?: string;
6800
6801
  }
6801
- /** @enumType */
6802
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6803
- interface AddToAutomationMigrationPopulationResponse {
6804
- success?: boolean;
6802
+ interface V1TriggerReindexRequest {
6803
+ /** @format GUID */
6804
+ metasiteId?: string;
6805
+ /**
6806
+ * @minLength 1
6807
+ * @maxLength 100
6808
+ * @maxSize 100
6809
+ */
6810
+ orderIds?: string[];
6805
6811
  }
6806
- interface IsInAutomationMigrationPopulationRequest {
6812
+ interface V1TriggerReindexResponse {
6807
6813
  }
6808
- interface IsInAutomationMigrationPopulationResponse {
6809
- inPopulation?: boolean;
6814
+ interface V1TriggerReindexOrderRequest {
6815
+ /** @format GUID */
6816
+ metasiteId?: string;
6817
+ /**
6818
+ * @minLength 1
6819
+ * @maxLength 100
6820
+ */
6821
+ orderId?: string;
6810
6822
  }
6811
6823
  interface DiffmatokyPayload {
6812
6824
  left?: string;
@@ -10628,4 +10640,4 @@ interface BulkUpdateOrderTagsOptions {
10628
10640
  unassignTags?: TagsTags;
10629
10641
  }
10630
10642
 
10631
- export { type CancelOrderOptions as $, type UpdateOrderApplicationErrors as A, type BulkDeleteImportedOrdersResponse as B, type CreatePaymentGatewayOrderResponse as C, type MaskedOrder as D, type BulkUpdateOrdersOptions as E, type BulkUpdateOrdersResponse as F, type GetPaymentCollectabilityStatusResponse as G, type UpdateOrderLineItemIdentifiers as H, type ImportOrderResponse as I, type UpdateOrderLineItem as J, type UpdateOrderLineItemResponse as K, type PublicActivity as L, type MarkOrderAsPaidResponse as M, type AddActivityResponse as N, type Order as O, type Price as P, type AddActivitiesOptions as Q, type RecordManuallyCollectedPaymentOptions as R, type SetOrderNumberCounterOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type AddActivitiesResponse as W, type UpdateActivityIdentifiers as X, type UpdateActivityResponse as Y, type DeleteActivityIdentifiers as Z, type DeleteActivityResponse as _, type ImportOrderApplicationErrors as a, MembershipPaymentStatus as a$, type CancelOrderResponse as a0, type CancelOrderApplicationErrors as a1, type OrderStatusWithLiterals as a2, type UpdateOrderStatusResponse as a3, type UpdateOrderStatusApplicationErrors as a4, type AggregateOrdersOptions as a5, type AggregateOrdersResponse as a6, type BulkUpdateOrderTagsOptions as a7, type BulkUpdateOrderTagsResponse as a8, type OrderApprovedEnvelope as a9, LineItemQuantityChangeType as aA, ActivityType as aB, OrderActivityTypeEnumActivityType as aC, AttributionSource as aD, ChannelType as aE, AdditionalFeeSource as aF, OrderActionType as aG, SpecificItemsCouponBehavior as aH, ChargeType as aI, VersioningMode as aJ, DeltaPaymentOptionType as aK, InventoryAction as aL, WebhookIdentityType as aM, ScheduledAction as aN, DurationUnit as aO, PaymentCollectabilityStatus as aP, PredefinedPaymentMethod as aQ, RefundableStatus as aR, NonRefundableReason as aS, ManuallyRefundableReason as aT, RestockType as aU, TransactionStatus as aV, AuthorizationCaptureStatus as aW, AuthorizationVoidStatus as aX, Reason as aY, ActionType as aZ, ChargebackStatus as a_, type OrderCanceledEnvelope as aa, type OrderCommittedEnvelope as ab, type OrderCreatedEnvelope as ac, type OrderFulfilledEnvelope as ad, type OrderImportedEnvelope as ae, type OrderImportedOrderDeletedEnvelope as af, type OrderPaymentStatusUpdatedEnvelope as ag, type OrderUpdatedEnvelope as ah, DescriptionLineType as ai, DimensionsUnit as aj, ItemTypePreset as ak, PaymentOptionType as al, JurisdictionType as am, SubscriptionFrequency as an, ProductPeriodAlignment as ao, AdjustmentType as ap, TaxableAddressType as aq, MeasurementUnit as ar, PaymentStatusEnumPaymentStatus as as, FulfillmentStatus as at, WeightUnit as au, VatType as av, PickupMethod as aw, OrderStatus as ax, DiscountType as ay, DiscountReason as az, type SetOrderNumberCounterResponse as b, type AddressWithContact as b$, PaymentStatus as b0, CanceledReason as b1, DeclinedReason as b2, VoidedReason as b3, RefundStatus as b4, PreviewEmailType as b5, State as b6, SiteCreatedContext as b7, Namespace as b8, DeleteStatus as b9, type LineItemTaxInfo as bA, type LineItemTaxBreakdown as bB, type DigitalFile as bC, type SubscriptionInfo as bD, type SubscriptionTitle as bE, type SubscriptionDescription as bF, type SubscriptionSettings as bG, type FreeTrialPeriod as bH, type BillingSettings as bI, type BillingAdjustment as bJ, type BillingAdjustmentPriceSummary as bK, type CyclePriceOverride as bL, type PriceDescription as bM, type LocationAndQuantity as bN, type TaxableAddress as bO, type TaxableAddressTaxableAddressDataOneOf as bP, type DecimalQuantity as bQ, type DecimalQuantityUnitOneOf as bR, type TranslatableString as bS, type ExtendedFields as bT, type ModifierGroup as bU, type ItemModifier as bV, type ServiceProperties as bW, type BuyerInfo as bX, type BuyerInfoIdOneOf as bY, type CurrencyConversionDetails as bZ, type PriceSummary as b_, Origin as ba, SortOrder as bb, OrderApprovalStrategy as bc, Placement as bd, SubdivisionType as be, SourceType as bf, CustomFieldGroup as bg, ValueType as bh, DepositType as bi, InvoiceStatus as bj, type OrderLineItem as bk, type ProductName as bl, type CatalogReference as bm, type DescriptionLine as bn, type DescriptionLineValueOneOf as bo, type DescriptionLineDescriptionLineValueOneOf as bp, type DescriptionLineName as bq, type PlainTextValue as br, type Color as bs, type FocalPoint as bt, type PhysicalProperties as bu, type Dimensions as bv, type ItemType as bw, type ItemTypeItemTypeDataOneOf as bx, type RestockLocation as by, type ItemTaxFullDetails as bz, type SetOrderNumberCounterApplicationErrors as c, type RefundedAsStoreCredit as c$, type Address as c0, type StreetAddress as c1, type AddressLocation as c2, type FullAddressContactDetails as c3, type VatId as c4, type V1ShippingInformation as c5, type DeliveryLogistics as c6, type DeliveryLogisticsAddressOneOf as c7, type PickupDetails as c8, type PickupAddress as c9, type OrderChangeValueOneOf as cA, type LineItemChanges as cB, type LineItemQuantityChange as cC, type LineItemPriceChange as cD, type LineItemProductNameChange as cE, type LineItemDescriptionLineChange as cF, type LineItemModifiersChange as cG, type ManagedLineItem as cH, type ManagedDiscount as cI, type TranslatedValue as cJ, type LineItemAmount as cK, type ManagedAdditionalFee as cL, type TotalPriceChange as cM, type ShippingInformationChange as cN, type ShippingInformation as cO, type SavedPaymentMethod as cP, type AuthorizedPaymentCreated as cQ, type AuthorizedPaymentCaptured as cR, type AuthorizedPaymentVoided as cS, type RefundInitiated as cT, type RefundedPayment as cU, type RefundedPaymentKindOneOf as cV, type RegularPaymentRefund as cW, type GiftCardPaymentRefund as cX, type MembershipPaymentRefund as cY, type PaymentRefunded as cZ, type PaymentRefundFailed as c_, type DeliveryTimeSlot as ca, type ShippingPrice as cb, type ShippingRegion as cc, type TaxSummary as cd, type OrderTaxInfo as ce, type OrderTaxBreakdown as cf, type AppliedDiscount as cg, type AppliedDiscountDiscountSourceOneOf as ch, type Coupon as ci, type MerchantDiscount as cj, type MerchantDiscountMerchantDiscountReasonOneOf as ck, type DiscountRule as cl, type DiscountRuleName as cm, type LineItemDiscount as cn, type ItemCombination as co, type ItemCombinationLineItem as cp, type Activity as cq, type ActivityContentOneOf as cr, type CustomActivity as cs, type MerchantComment as ct, type OrderRefunded as cu, type OrderCreatedFromExchange as cv, type NewExchangeOrderCreated as cw, type LineItemExchangeData as cx, type DraftOrderChangesApplied as cy, type OrderChange as cz, type PreparePaymentCollectionOptions as d, type ItemChangedDetails as d$, type PaymentPending as d0, type PaymentPendingPaymentDetailsOneOf as d1, type RegularPayment as d2, type RegularPaymentPaymentMethodDetailsOneOf as d3, type CreditCardDetails as d4, type PaymentCanceled as d5, type PaymentCanceledPaymentDetailsOneOf as d6, type PaymentDeclined as d7, type PaymentDeclinedPaymentDetailsOneOf as d8, type ReceiptCreated as d9, type FormIdentifier as dA, type PlatformFeeSummary as dB, type PlatformFee as dC, type UpdateInternalDocumentsEvent as dD, type UpdateInternalDocumentsEventOperationOneOf as dE, type InternalDocument as dF, type InternalDocumentUpdateOperation as dG, type DeleteByIdsOperation as dH, type DeleteByFilterOperation as dI, type InternalDocumentUpdateByFilterOperation as dJ, type InternalUpdateExistingOperation as dK, type VersionedDocumentUpdateOperation as dL, type VersionedDeleteByIdsOperation as dM, type VersionedDocumentId as dN, type OrderApproved as dO, type OrdersExperiments as dP, type OrderRejectedEventOrderRejected as dQ, type OrderItemsRestocked as dR, type V1RestockItem as dS, type OrderImported as dT, type ImportedOrderDeleted as dU, type PaymentStatusUpdated as dV, type FulfillmentStatusUpdated as dW, type OrderCanceledEventOrderCanceled as dX, type OrderDeltasCommitted as dY, type CommittedDiffs as dZ, type CommittedDiffsShippingUpdateInfoOneOf as d_, type ReceiptCreatedReceiptInfoOneOf as da, type WixReceipt as db, type ExternalReceipt as dc, type ReceiptSent as dd, type ReceiptSentReceiptInfoOneOf as de, type ChargebackCreated as df, type ChargebackReversed as dg, type CreatedBy as dh, type CreatedByStringOneOf as di, type ChannelInfo as dj, type CustomField as dk, type BalanceSummary as dl, type Balance as dm, type CashRounding as dn, type AdditionalFee as dp, type FulfillmentStatusesAggregate as dq, type Tags as dr, type TagList as ds, type Location as dt, type OrderSettings as du, type OrderSettingsAllowedActionsOneOf as dv, type OrderSettingsEditableByOneOf as dw, type CustomAllowedActions as dx, type OwnerApps as dy, type FormInfo as dz, type PreparePaymentCollectionResponse as e, type RestockItem as e$, type OrderLineItemChangedDetails as e0, type DecimalQuantityUpdate as e1, type LineItemDelta as e2, type LineItemDeltaDeltaOneOf as e3, type AppliedDiscountDelta as e4, type AppliedDiscountDeltaDeltaOneOf as e5, type AdditionalFeeDelta as e6, type AdditionalFeeDeltaDeltaOneOf as e7, type DraftOrderCommitSettings as e8, type InventoryUpdateDetails as e9, type RecordManuallyCollectedPaymentRequest as eA, type UserDefinedPaymentMethodName as eB, type UserDefinedPaymentMethodNameKindOneOf as eC, type RecordManuallyCollectedPaymentResponse as eD, type MarkOrderAsPaidRequest as eE, type BulkMarkOrdersAsPaidRequest as eF, type BulkOrderResult as eG, type ItemMetadata as eH, type ApplicationError as eI, type BulkActionMetadata as eJ, type GetRefundabilityStatusRequest as eK, type Refundability as eL, type RefundabilityAdditionalRefundabilityInfoOneOf as eM, type CreatePaymentGatewayOrderRequest as eN, type ChargedBy as eO, type ChargeMembershipsRequest as eP, type MembershipChargeItem as eQ, type MembershipName as eR, type ChargeMembershipsResponse as eS, type TriggerRefundRequest as eT, type RefundDetails as eU, type RefundItem as eV, type LineItemRefund as eW, type AdditionalFeeRefund as eX, type ShippingRefund as eY, type RefundSideEffects as eZ, type RestockInfo as e_, type TriggerReindexRequest as ea, type TriggerReindexResponse as eb, type DomainEvent as ec, type DomainEventBodyOneOf as ed, type EntityCreatedEvent as ee, type RestoreInfo as ef, type EntityUpdatedEvent as eg, type EntityDeletedEvent as eh, type ActionEvent as ei, type Empty as ej, type TriggerReindexOrderRequest as ek, type MessageEnvelope as el, type IdentificationData as em, type IdentificationDataIdOneOf as en, type AccountInfo as eo, type ImportOrderRequest as ep, type SetOrderNumberCounterRequest as eq, type BulkDeleteImportedOrdersRequest as er, type V1TriggerReindexRequest as es, type V1TriggerReindexResponse as et, type V1TriggerReindexOrderRequest as eu, type PreparePaymentCollectionRequest as ev, type RedirectUrls as ew, type DelayedCaptureSettings as ex, type Duration as ey, type GetPaymentCollectabilityStatusRequest as ez, type PreparePaymentCollectionApplicationErrors as f, type PreviewEmailByTypeResponse as f$, type OrderTransactions as f0, type Payment as f1, type PaymentPaymentDetailsOneOf as f2, type PaymentReceiptInfoOneOf as f3, type PaymentStatusDetailsOneOf as f4, type RegularPaymentDetails as f5, type RegularPaymentDetailsPaymentMethodDetailsOneOf as f6, type CreditCardPaymentMethodDetails as f7, type AuthorizationDetails as f8, type AuthorizationCapture as f9, type VoidAuthorizedPaymentsRequest as fA, type CaptureAuthorizedPaymentsRequest as fB, type ChargeSavedPaymentMethodRequest as fC, type ChargeSavedPaymentMethodResponse as fD, type SendBuyerConfirmationEmailRequest as fE, type SendBuyerConfirmationEmailResponse as fF, type SendBuyerPaymentsReceivedEmailRequest as fG, type SendBuyerPaymentsReceivedEmailResponse as fH, type SendBuyerPickupConfirmationEmailRequest as fI, type SendBuyerPickupConfirmationEmailResponse as fJ, type BulkSendBuyerPickupConfirmationEmailsRequest as fK, type BulkSendBuyerPickupConfirmationEmailsResponse as fL, type SendBuyerShippingConfirmationEmailRequest as fM, type SendBuyerShippingConfirmationEmailResponse as fN, type BulkSendBuyerShippingConfirmationEmailsRequest as fO, type BulkSendBuyerShippingConfirmationEmailsResponse as fP, type SendMerchantOrderReceivedNotificationRequest as fQ, type SendMerchantOrderReceivedNotificationResponse as fR, type SendCancelRefundEmailRequest as fS, type SendCancelRefundEmailResponse as fT, type SendRefundEmailRequest as fU, type SendRefundEmailResponse as fV, type SendFulfillmentEmailRequest as fW, type SendFulfillmentEmailResponse as fX, type SendMerchantOrderReceivedPushRequest as fY, type SendMerchantOrderReceivedPushResponse as fZ, type PreviewEmailByTypeRequest as f_, type AuthorizationActionFailureDetails as fa, type AuthorizationVoid as fb, type V1ScheduledAction as fc, type Chargeback as fd, type PaymentMethodName as fe, type GiftCardPaymentDetails as ff, type MembershipPaymentDetails as fg, type FutureMembershipDetails as fh, type WixReceiptInfo as fi, type ExternalReceiptInfo as fj, type CashRoundingDetails as fk, type CanceledStatusDetails as fl, type DeclinedStatusDetails as fm, type VoidedStatusDetails as fn, type PaymentStatusDetails as fo, type PaymentStatusDetailsStatusDetailsOneOf as fp, type Refund as fq, type RefundTransaction as fr, type RefundStatusInfo as fs, type AggregatedRefundSummary as ft, type RefundItemsBreakdown as fu, type LineItemRefundSummary as fv, type CalculateRefundRequest as fw, type CalculateRefundItemRequest as fx, type CalculateRefundResponse as fy, type CalculateRefundItemResponse as fz, type RecordManuallyCollectedPaymentApplicationErrors as g, type PlatformPaging as g$, type PreviewRefundEmailRequest as g0, type PreviewRefundEmailResponse as g1, type PreviewCancelEmailRequest as g2, type PreviewCancelEmailResponse as g3, type PreviewCancelRefundEmailRequest as g4, type PreviewCancelRefundEmailResponse as g5, type PreviewBuyerPaymentsReceivedEmailRequest as g6, type PreviewBuyerPaymentsReceivedEmailResponse as g7, type PreviewBuyerConfirmationEmailRequest as g8, type PreviewBuyerConfirmationEmailResponse as g9, type SitePurgedExternally as gA, type OdeditorAssigned as gB, type OdeditorUnassigned as gC, type PicassoAssigned as gD, type PicassoUnassigned as gE, type WixelAssigned as gF, type WixelUnassigned as gG, type StudioTwoAssigned as gH, type StudioTwoUnassigned as gI, type UserDomainMediaEnabled as gJ, type UserDomainMediaDisabled as gK, type EditorlessAssigned as gL, type EditorlessUnassigned as gM, type HasCustomEmailConfigurationsRequest as gN, type HasCustomEmailConfigurationsResponse as gO, type AddToAutomationMigrationPopulationRequest as gP, type AddToAutomationMigrationPopulationResponse as gQ, type IsInAutomationMigrationPopulationRequest as gR, type IsInAutomationMigrationPopulationResponse as gS, type DiffmatokyPayload as gT, type ErrorInformation as gU, type GetOrderRequest as gV, type GetOrderResponse as gW, type InternalQueryOrdersRequest as gX, type PlatformQuery as gY, type PlatformQueryPagingMethodOneOf as gZ, type Sorting as g_, type PreviewBuyerPickupConfirmationEmailRequest as ga, type PreviewBuyerPickupConfirmationEmailResponse as gb, type PreviewShippingConfirmationEmailRequest as gc, type PreviewShippingConfirmationEmailResponse as gd, type PreviewResendDownloadLinksEmailRequest as ge, type PreviewResendDownloadLinksEmailResponse as gf, type MetaSiteSpecialEvent as gg, type MetaSiteSpecialEventPayloadOneOf as gh, type Asset as gi, type SiteCreated as gj, type SiteTransferred as gk, type SiteDeleted as gl, type DeleteContext as gm, type SiteUndeleted as gn, type SitePublished as go, type SiteUnpublished as gp, type SiteMarkedAsTemplate as gq, type SiteMarkedAsWixSite as gr, type ServiceProvisioned as gs, type ServiceRemoved as gt, type SiteRenamed as gu, type SiteHardDeleted as gv, type NamespaceChanged as gw, type StudioAssigned as gx, type StudioUnassigned as gy, type SiteUrlChanged as gz, type PaymentCollectionMarkOrderAsPaidOptions as h, type TrackingLinkAdded as h$, type CursorPaging as h0, type InternalQueryOrdersResponse as h1, type PlatformPagingMetadata as h2, type Cursors as h3, type QueryOrderRequest as h4, type QueryOrderResponse as h5, type SearchOrdersRequest as h6, type CursorSearch as h7, type CursorSearchPagingMethodOneOf as h8, type CursorPagingMetadata as h9, type BulkUnArchiveOrdersResponse as hA, type BulkUnArchiveOrdersByFilterRequest as hB, type BulkUnArchiveOrdersByFilterResponse as hC, type UpdateBuyerInfoRequest as hD, type BuyerInfoUpdate as hE, type UpdateBuyerInfoResponse as hF, type UpdateBuyerEmailRequest as hG, type UpdateBuyerEmailResponse as hH, type UpdateOrderShippingAddressRequest as hI, type UpdateOrderShippingAddressResponse as hJ, type UpdateBillingContactDetailsRequest as hK, type UpdateBillingContactDetailsResponse as hL, type UpdateOrderLineItemRequest as hM, type UpdateOrderLineItemsRequest as hN, type MaskedOrderLineItem as hO, type UpdateOrderLineItemsResponse as hP, type AddInternalActivityRequest as hQ, type InternalActivity as hR, type InternalActivityContentOneOf as hS, type OrderPlaced as hT, type OrderPaid as hU, type OrderFulfilled as hV, type OrderNotFulfilled as hW, type OrderCanceled as hX, type DownloadLinkSent as hY, type TrackingNumberAdded as hZ, type TrackingNumberEdited as h_, type CreateOrderRequest as ha, type OrderCreationSettings as hb, type OrderCreationSettingsEditableByOneOf as hc, type OrderCreateNotifications as hd, type CreateOrderResponse as he, type UpdateOrderRequest as hf, type UpdateOrderResponse as hg, type BulkUpdateOrdersRequest as hh, type CommitDeltasRequest as hi, type DraftOrderDiffs as hj, type DraftOrderDiffsShippingUpdateInfoOneOf as hk, type DraftOrderDiffsBuyerUpdateInfoOneOf as hl, type DraftOrderDiffsBillingUpdateInfoOneOf as hm, type DraftOrderDiffsRecipientUpdateInfoOneOf as hn, type V1LineItemDelta as ho, type V1LineItemDeltaDeltaOneOf as hp, type CommitDeltasResponse as hq, type ArchiveOrderRequest as hr, type ArchiveOrderResponse as hs, type BulkArchiveOrdersRequest as ht, type BulkArchiveOrdersResponse as hu, type BulkArchiveOrdersByFilterRequest as hv, type BulkArchiveOrdersByFilterResponse as hw, type UnArchiveOrderRequest as hx, type UnArchiveOrderResponse as hy, type BulkUnArchiveOrdersRequest as hz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as i, type Cancel as i$, type ShippingConfirmationEmailSent as i0, type InvoiceAdded as i1, type InvoiceSent as i2, type FulfillerEmailSent as i3, type ShippingAddressEdited as i4, type EmailEdited as i5, type PickupReadyEmailSent as i6, type OrderPartiallyPaid as i7, type OrderPending as i8, type OrderRejected as i9, type BulkMarkAsUnfulfilledByFilterResponse as iA, type BulkSetBusinessLocationRequest as iB, type BulkSetBusinessLocationResponse as iC, type BulkSetBusinessLocationResult as iD, type V1MarkOrderAsPaidRequest as iE, type V1MarkOrderAsPaidResponse as iF, type V1BulkMarkOrdersAsPaidRequest as iG, type V1BulkMarkOrdersAsPaidResponse as iH, type V1CreatePaymentGatewayOrderRequest as iI, type V1CreatePaymentGatewayOrderResponse as iJ, type GetShipmentsRequest as iK, type GetShipmentsResponse as iL, type AggregateOrdersRequest as iM, type DecrementItemsQuantityRequest as iN, type DecrementData as iO, type DecrementItemsQuantityResponse as iP, type BulkUpdateOrderTagsRequest as iQ, type TagsTags as iR, type TagsTagList as iS, type BulkUpdateOrderTagsResult as iT, type SendOrderUpdatedDomainEventRequest as iU, type SendOrderUpdatedDomainEventResponse as iV, type Task as iW, type TaskKey as iX, type TaskAction as iY, type TaskActionActionOneOf as iZ, type Complete as i_, type AddInternalActivityResponse as ia, type AddActivityRequest as ib, type PublicActivityContentOneOf as ic, type AddActivitiesRequest as id, type UpdateActivityRequest as ie, type DeleteActivityRequest as ig, type UpdateLineItemsDescriptionLinesRequest as ih, type LineItemUpdate as ii, type UpdateLineItemsDescriptionLinesResponse as ij, type MarkOrderAsSeenByHumanRequest as ik, type MarkOrderAsSeenByHumanResponse as il, type CancelOrderRequest as im, type UpdateOrderStatusRequest as io, type MarkAsFulfilledRequest as ip, type MarkAsFulfilledResponse as iq, type BulkMarkAsFulfilledRequest as ir, type BulkMarkAsFulfilledResponse as is, type BulkMarkAsFulfilledByFilterRequest as it, type BulkMarkAsFulfilledByFilterResponse as iu, type MarkAsUnfulfilledRequest as iv, type MarkAsUnfulfilledResponse as iw, type BulkMarkAsUnfulfilledRequest as ix, type BulkMarkAsUnfulfilledResponse as iy, type BulkMarkAsUnfulfilledByFilterRequest as iz, type BulkMarkOrdersAsPaidResponse as j, type AdditionalFeeSourceWithLiterals as j$, type Reschedule as j0, type InvoiceSentEvent as j1, type IdAndVersion as j2, type InvoiceFields as j3, type Customer as j4, type Email as j5, type QuotesAddress as j6, type AddressDescription as j7, type Phone as j8, type Company as j9, type BaseEventMetadata as jA, type EventMetadata as jB, type AccountInfoMetadata as jC, type OrderSearchSpec as jD, utils as jE, type DescriptionLineTypeWithLiterals as jF, type DimensionsUnitWithLiterals as jG, type ItemTypePresetWithLiterals as jH, type PaymentOptionTypeWithLiterals as jI, type JurisdictionTypeWithLiterals as jJ, type SubscriptionFrequencyWithLiterals as jK, type ProductPeriodAlignmentWithLiterals as jL, type AdjustmentTypeWithLiterals as jM, type TaxableAddressTypeWithLiterals as jN, type MeasurementUnitWithLiterals as jO, type PaymentStatusEnumPaymentStatusWithLiterals as jP, type FulfillmentStatusWithLiterals as jQ, type WeightUnitWithLiterals as jR, type VatTypeWithLiterals as jS, type PickupMethodWithLiterals as jT, type DiscountTypeWithLiterals as jU, type DiscountReasonWithLiterals as jV, type LineItemQuantityChangeTypeWithLiterals as jW, type ActivityTypeWithLiterals as jX, type OrderActivityTypeEnumActivityTypeWithLiterals as jY, type AttributionSourceWithLiterals as jZ, type ChannelTypeWithLiterals as j_, type CommonAddress as ja, type CommonAddressStreetOneOf as jb, type Subdivision as jc, type StandardDetails as jd, type ShippingContactDetails as je, type InvoiceDates as jf, type LineItems as jg, type LineItem as jh, type BigDecimalWrapper as ji, type LineItemTax as jj, type Source as jk, type LineItemMetaData as jl, type Locale as jm, type TotalPrice as jn, type ItemizedFee as jo, type Discount as jp, type DiscountOneDiscountTypeOneOf as jq, type CalculatedTaxes as jr, type CalculatedTax as js, type Payments as jt, type InvoicesPayment as ju, type MetaData as jv, type InvoiceDynamicPriceTotals as jw, type CustomFieldValue as jx, type Value as jy, type Deposit as jz, type GetRefundabilityStatusResponse as k, triggerRefund as k$, type OrderActionTypeWithLiterals as k0, type SpecificItemsCouponBehaviorWithLiterals as k1, type ChargeTypeWithLiterals as k2, type VersioningModeWithLiterals as k3, type DeltaPaymentOptionTypeWithLiterals as k4, type InventoryActionWithLiterals as k5, type WebhookIdentityTypeWithLiterals as k6, type ScheduledActionWithLiterals as k7, type DurationUnitWithLiterals as k8, type PaymentCollectabilityStatusWithLiterals as k9, type SubdivisionTypeWithLiterals as kA, type SourceTypeWithLiterals as kB, type CustomFieldGroupWithLiterals as kC, type ValueTypeWithLiterals as kD, type DepositTypeWithLiterals as kE, type InvoiceStatusWithLiterals as kF, type CommonSearchWithEntityContext as kG, onOrderApproved as kH, onOrderCanceled as kI, onOrderCommitted as kJ, onOrderCreated as kK, onOrderFulfilled as kL, onOrderImported as kM, onOrderImportedOrderDeleted as kN, onOrderPaymentStatusUpdated as kO, onOrderUpdated as kP, importOrder as kQ, setOrderNumberCounter as kR, bulkDeleteImportedOrders as kS, preparePaymentCollection as kT, getPaymentCollectabilityStatus as kU, recordManuallyCollectedPayment as kV, paymentCollectionMarkOrderAsPaid as kW, paymentCollectionBulkMarkOrdersAsPaid as kX, getRefundabilityStatus as kY, paymentCollectionCreatePaymentGatewayOrder as kZ, chargeMemberships as k_, type PredefinedPaymentMethodWithLiterals as ka, type RefundableStatusWithLiterals as kb, type NonRefundableReasonWithLiterals as kc, type ManuallyRefundableReasonWithLiterals as kd, type RestockTypeWithLiterals as ke, type TransactionStatusWithLiterals as kf, type AuthorizationCaptureStatusWithLiterals as kg, type AuthorizationVoidStatusWithLiterals as kh, type ReasonWithLiterals as ki, type ActionTypeWithLiterals as kj, type ChargebackStatusWithLiterals as kk, type MembershipPaymentStatusWithLiterals as kl, type PaymentStatusWithLiterals as km, type CanceledReasonWithLiterals as kn, type DeclinedReasonWithLiterals as ko, type VoidedReasonWithLiterals as kp, type RefundStatusWithLiterals as kq, type PreviewEmailTypeWithLiterals as kr, type StateWithLiterals as ks, type SiteCreatedContextWithLiterals as kt, type NamespaceWithLiterals as ku, type DeleteStatusWithLiterals as kv, type OriginWithLiterals as kw, type SortOrderWithLiterals as kx, type OrderApprovalStrategyWithLiterals as ky, type PlacementWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, voidAuthorizedPayments as l0, captureAuthorizedPayments as l1, getOrder as l2, createOrder as l3, updateOrder as l4, bulkUpdateOrders as l5, updateOrderLineItem as l6, addActivity as l7, addActivities as l8, updateActivity as l9, deleteActivity as la, cancelOrder as lb, updateOrderStatus as lc, aggregateOrders as ld, bulkUpdateOrderTags as le, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as m, type ChargeMembershipsOptions as n, type PaymentRefund as o, type TriggerRefundResponse as p, type TriggerRefundApplicationErrors as q, type VoidAuthorizedPaymentsApplicationErrors as r, type PaymentCapture as s, type CaptureAuthorizedPaymentsResponse as t, type CaptureAuthorizedPaymentsApplicationErrors as u, type GetOrderApplicationErrors as v, type OrderSearch as w, type SearchOrdersResponse as x, type CreateOrderOptions as y, type CreateOrderApplicationErrors as z };
10643
+ export { type CancelOrderOptions as $, type UpdateOrderApplicationErrors as A, type BulkDeleteImportedOrdersResponse as B, type CreatePaymentGatewayOrderResponse as C, type MaskedOrder as D, type BulkUpdateOrdersOptions as E, type BulkUpdateOrdersResponse as F, type GetPaymentCollectabilityStatusResponse as G, type UpdateOrderLineItemIdentifiers as H, type ImportOrderResponse as I, type UpdateOrderLineItem as J, type UpdateOrderLineItemResponse as K, type PublicActivity as L, type MarkOrderAsPaidResponse as M, type AddActivityResponse as N, type Order as O, type Price as P, type AddActivitiesOptions as Q, type RecordManuallyCollectedPaymentOptions as R, type SetOrderNumberCounterOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type AddActivitiesResponse as W, type UpdateActivityIdentifiers as X, type UpdateActivityResponse as Y, type DeleteActivityIdentifiers as Z, type DeleteActivityResponse as _, type ImportOrderApplicationErrors as a, TransactionStatus as a$, type CancelOrderResponse as a0, type CancelOrderApplicationErrors as a1, type OrderStatusWithLiterals as a2, type UpdateOrderStatusResponse as a3, type UpdateOrderStatusApplicationErrors as a4, type AggregateOrdersOptions as a5, type AggregateOrdersResponse as a6, type BulkUpdateOrderTagsOptions as a7, type BulkUpdateOrderTagsResponse as a8, type OrderApprovedEnvelope as a9, LineItemQuantityChangeType as aA, ActivityType as aB, OrderActivityTypeEnumActivityType as aC, AttributionSource as aD, ChannelType as aE, AdditionalFeeSource as aF, OrderActionType as aG, SpecificItemsCouponBehavior as aH, ChargeType as aI, VersioningMode as aJ, DeltaPaymentOptionType as aK, InventoryAction as aL, WebhookIdentityType as aM, PreviewEmailType as aN, State as aO, SiteCreatedContext as aP, Namespace as aQ, DeleteStatus as aR, Origin as aS, ScheduledAction as aT, DurationUnit as aU, PaymentCollectabilityStatus as aV, PredefinedPaymentMethod as aW, RefundableStatus as aX, NonRefundableReason as aY, ManuallyRefundableReason as aZ, RestockType as a_, type OrderCanceledEnvelope as aa, type OrderCommittedEnvelope as ab, type OrderCreatedEnvelope as ac, type OrderFulfilledEnvelope as ad, type OrderImportedEnvelope as ae, type OrderImportedOrderDeletedEnvelope as af, type OrderPaymentStatusUpdatedEnvelope as ag, type OrderUpdatedEnvelope as ah, DescriptionLineType as ai, DimensionsUnit as aj, ItemTypePreset as ak, PaymentOptionType as al, JurisdictionType as am, SubscriptionFrequency as an, ProductPeriodAlignment as ao, AdjustmentType as ap, TaxableAddressType as aq, MeasurementUnit as ar, PaymentStatusEnumPaymentStatus as as, FulfillmentStatus as at, WeightUnit as au, VatType as av, PickupMethod as aw, OrderStatus as ax, DiscountType as ay, DiscountReason as az, type SetOrderNumberCounterResponse as b, type AddressWithContact as b$, AuthorizationCaptureStatus as b0, AuthorizationVoidStatus as b1, Reason as b2, ActionType as b3, ChargebackStatus as b4, MembershipPaymentStatus as b5, PaymentStatus as b6, CanceledReason as b7, DeclinedReason as b8, VoidedReason as b9, type LineItemTaxInfo as bA, type LineItemTaxBreakdown as bB, type DigitalFile as bC, type SubscriptionInfo as bD, type SubscriptionTitle as bE, type SubscriptionDescription as bF, type SubscriptionSettings as bG, type FreeTrialPeriod as bH, type BillingSettings as bI, type BillingAdjustment as bJ, type BillingAdjustmentPriceSummary as bK, type CyclePriceOverride as bL, type PriceDescription as bM, type LocationAndQuantity as bN, type TaxableAddress as bO, type TaxableAddressTaxableAddressDataOneOf as bP, type DecimalQuantity as bQ, type DecimalQuantityUnitOneOf as bR, type TranslatableString as bS, type ExtendedFields as bT, type ModifierGroup as bU, type ItemModifier as bV, type ServiceProperties as bW, type BuyerInfo as bX, type BuyerInfoIdOneOf as bY, type CurrencyConversionDetails as bZ, type PriceSummary as b_, RefundStatus as ba, SortOrder as bb, OrderApprovalStrategy as bc, Placement as bd, SubdivisionType as be, SourceType as bf, CustomFieldGroup as bg, ValueType as bh, DepositType as bi, InvoiceStatus as bj, type OrderLineItem as bk, type ProductName as bl, type CatalogReference as bm, type DescriptionLine as bn, type DescriptionLineValueOneOf as bo, type DescriptionLineDescriptionLineValueOneOf as bp, type DescriptionLineName as bq, type PlainTextValue as br, type Color as bs, type FocalPoint as bt, type PhysicalProperties as bu, type Dimensions as bv, type ItemType as bw, type ItemTypeItemTypeDataOneOf as bx, type RestockLocation as by, type ItemTaxFullDetails as bz, type SetOrderNumberCounterApplicationErrors as c, type RefundedAsStoreCredit as c$, type Address as c0, type StreetAddress as c1, type AddressLocation as c2, type FullAddressContactDetails as c3, type VatId as c4, type V1ShippingInformation as c5, type DeliveryLogistics as c6, type DeliveryLogisticsAddressOneOf as c7, type PickupDetails as c8, type PickupAddress as c9, type OrderChangeValueOneOf as cA, type LineItemChanges as cB, type LineItemQuantityChange as cC, type LineItemPriceChange as cD, type LineItemProductNameChange as cE, type LineItemDescriptionLineChange as cF, type LineItemModifiersChange as cG, type ManagedLineItem as cH, type ManagedDiscount as cI, type TranslatedValue as cJ, type LineItemAmount as cK, type ManagedAdditionalFee as cL, type TotalPriceChange as cM, type ShippingInformationChange as cN, type ShippingInformation as cO, type SavedPaymentMethod as cP, type AuthorizedPaymentCreated as cQ, type AuthorizedPaymentCaptured as cR, type AuthorizedPaymentVoided as cS, type RefundInitiated as cT, type RefundedPayment as cU, type RefundedPaymentKindOneOf as cV, type RegularPaymentRefund as cW, type GiftCardPaymentRefund as cX, type MembershipPaymentRefund as cY, type PaymentRefunded as cZ, type PaymentRefundFailed as c_, type DeliveryTimeSlot as ca, type ShippingPrice as cb, type ShippingRegion as cc, type TaxSummary as cd, type OrderTaxInfo as ce, type OrderTaxBreakdown as cf, type AppliedDiscount as cg, type AppliedDiscountDiscountSourceOneOf as ch, type Coupon as ci, type MerchantDiscount as cj, type MerchantDiscountMerchantDiscountReasonOneOf as ck, type DiscountRule as cl, type DiscountRuleName as cm, type LineItemDiscount as cn, type ItemCombination as co, type ItemCombinationLineItem as cp, type Activity as cq, type ActivityContentOneOf as cr, type CustomActivity as cs, type MerchantComment as ct, type OrderRefunded as cu, type OrderCreatedFromExchange as cv, type NewExchangeOrderCreated as cw, type LineItemExchangeData as cx, type DraftOrderChangesApplied as cy, type OrderChange as cz, type PreparePaymentCollectionOptions as d, type ItemChangedDetails as d$, type PaymentPending as d0, type PaymentPendingPaymentDetailsOneOf as d1, type RegularPayment as d2, type RegularPaymentPaymentMethodDetailsOneOf as d3, type CreditCardDetails as d4, type PaymentCanceled as d5, type PaymentCanceledPaymentDetailsOneOf as d6, type PaymentDeclined as d7, type PaymentDeclinedPaymentDetailsOneOf as d8, type ReceiptCreated as d9, type FormIdentifier as dA, type PlatformFeeSummary as dB, type PlatformFee as dC, type UpdateInternalDocumentsEvent as dD, type UpdateInternalDocumentsEventOperationOneOf as dE, type InternalDocument as dF, type InternalDocumentUpdateOperation as dG, type DeleteByIdsOperation as dH, type DeleteByFilterOperation as dI, type InternalDocumentUpdateByFilterOperation as dJ, type InternalUpdateExistingOperation as dK, type VersionedDocumentUpdateOperation as dL, type VersionedDeleteByIdsOperation as dM, type VersionedDocumentId as dN, type OrderApproved as dO, type OrdersExperiments as dP, type OrderRejectedEventOrderRejected as dQ, type OrderItemsRestocked as dR, type V1RestockItem as dS, type OrderImported as dT, type ImportedOrderDeleted as dU, type PaymentStatusUpdated as dV, type FulfillmentStatusUpdated as dW, type OrderCanceledEventOrderCanceled as dX, type OrderDeltasCommitted as dY, type CommittedDiffs as dZ, type CommittedDiffsShippingUpdateInfoOneOf as d_, type ReceiptCreatedReceiptInfoOneOf as da, type WixReceipt as db, type ExternalReceipt as dc, type ReceiptSent as dd, type ReceiptSentReceiptInfoOneOf as de, type ChargebackCreated as df, type ChargebackReversed as dg, type CreatedBy as dh, type CreatedByStringOneOf as di, type ChannelInfo as dj, type CustomField as dk, type BalanceSummary as dl, type Balance as dm, type CashRounding as dn, type AdditionalFee as dp, type FulfillmentStatusesAggregate as dq, type Tags as dr, type TagList as ds, type Location as dt, type OrderSettings as du, type OrderSettingsAllowedActionsOneOf as dv, type OrderSettingsEditableByOneOf as dw, type CustomAllowedActions as dx, type OwnerApps as dy, type FormInfo as dz, type PreparePaymentCollectionResponse as e, type PreviewBuyerPaymentsReceivedEmailRequest as e$, type OrderLineItemChangedDetails as e0, type DecimalQuantityUpdate as e1, type LineItemDelta as e2, type LineItemDeltaDeltaOneOf as e3, type AppliedDiscountDelta as e4, type AppliedDiscountDeltaDeltaOneOf as e5, type AdditionalFeeDelta as e6, type AdditionalFeeDeltaDeltaOneOf as e7, type DraftOrderCommitSettings as e8, type InventoryUpdateDetails as e9, type SendBuyerShippingConfirmationEmailRequest as eA, type SendBuyerShippingConfirmationEmailResponse as eB, type BulkSendBuyerShippingConfirmationEmailsRequest as eC, type BulkSendBuyerShippingConfirmationEmailsResponse as eD, type SendMerchantOrderReceivedNotificationRequest as eE, type SendMerchantOrderReceivedNotificationResponse as eF, type SendCancelRefundEmailRequest as eG, type SendCancelRefundEmailResponse as eH, type SendRefundEmailRequest as eI, type SendRefundEmailResponse as eJ, type SendFulfillmentEmailRequest as eK, type SendFulfillmentEmailResponse as eL, type SendMerchantOrderReceivedPushRequest as eM, type SendMerchantOrderReceivedPushResponse as eN, type PreviewEmailByTypeRequest as eO, type PreviewEmailByTypeResponse as eP, type PreviewRefundEmailRequest as eQ, type RefundDetails as eR, type RefundItem as eS, type LineItemRefund as eT, type AdditionalFeeRefund as eU, type ShippingRefund as eV, type PreviewRefundEmailResponse as eW, type PreviewCancelEmailRequest as eX, type PreviewCancelEmailResponse as eY, type PreviewCancelRefundEmailRequest as eZ, type PreviewCancelRefundEmailResponse as e_, type TriggerReindexRequest as ea, type TriggerReindexResponse as eb, type DomainEvent as ec, type DomainEventBodyOneOf as ed, type EntityCreatedEvent as ee, type RestoreInfo as ef, type EntityUpdatedEvent as eg, type EntityDeletedEvent as eh, type ActionEvent as ei, type Empty as ej, type TriggerReindexOrderRequest as ek, type MessageEnvelope as el, type IdentificationData as em, type IdentificationDataIdOneOf as en, type AccountInfo as eo, type ImportOrderRequest as ep, type SetOrderNumberCounterRequest as eq, type BulkDeleteImportedOrdersRequest as er, type SendBuyerConfirmationEmailRequest as es, type SendBuyerConfirmationEmailResponse as et, type SendBuyerPaymentsReceivedEmailRequest as eu, type SendBuyerPaymentsReceivedEmailResponse as ev, type SendBuyerPickupConfirmationEmailRequest as ew, type SendBuyerPickupConfirmationEmailResponse as ex, type BulkSendBuyerPickupConfirmationEmailsRequest as ey, type BulkSendBuyerPickupConfirmationEmailsResponse as ez, type PreparePaymentCollectionApplicationErrors as f, type GetRefundabilityStatusRequest as f$, type PreviewBuyerPaymentsReceivedEmailResponse as f0, type PreviewBuyerConfirmationEmailRequest as f1, type PreviewBuyerConfirmationEmailResponse as f2, type PreviewBuyerPickupConfirmationEmailRequest as f3, type PreviewBuyerPickupConfirmationEmailResponse as f4, type PreviewShippingConfirmationEmailRequest as f5, type PreviewShippingConfirmationEmailResponse as f6, type PreviewResendDownloadLinksEmailRequest as f7, type PreviewResendDownloadLinksEmailResponse as f8, type MetaSiteSpecialEvent as f9, type StudioTwoAssigned as fA, type StudioTwoUnassigned as fB, type UserDomainMediaEnabled as fC, type UserDomainMediaDisabled as fD, type EditorlessAssigned as fE, type EditorlessUnassigned as fF, type HasCustomEmailConfigurationsRequest as fG, type HasCustomEmailConfigurationsResponse as fH, type AddToAutomationMigrationPopulationRequest as fI, type AddToAutomationMigrationPopulationResponse as fJ, type IsInAutomationMigrationPopulationRequest as fK, type IsInAutomationMigrationPopulationResponse as fL, type PreparePaymentCollectionRequest as fM, type RedirectUrls as fN, type DelayedCaptureSettings as fO, type Duration as fP, type GetPaymentCollectabilityStatusRequest as fQ, type RecordManuallyCollectedPaymentRequest as fR, type UserDefinedPaymentMethodName as fS, type UserDefinedPaymentMethodNameKindOneOf as fT, type RecordManuallyCollectedPaymentResponse as fU, type MarkOrderAsPaidRequest as fV, type BulkMarkOrdersAsPaidRequest as fW, type BulkOrderResult as fX, type ItemMetadata as fY, type ApplicationError as fZ, type BulkActionMetadata as f_, type MetaSiteSpecialEventPayloadOneOf as fa, type Asset as fb, type SiteCreated as fc, type SiteTransferred as fd, type SiteDeleted as fe, type DeleteContext as ff, type SiteUndeleted as fg, type SitePublished as fh, type SiteUnpublished as fi, type SiteMarkedAsTemplate as fj, type SiteMarkedAsWixSite as fk, type ServiceProvisioned as fl, type ServiceRemoved as fm, type SiteRenamed as fn, type SiteHardDeleted as fo, type NamespaceChanged as fp, type StudioAssigned as fq, type StudioUnassigned as fr, type SiteUrlChanged as fs, type SitePurgedExternally as ft, type OdeditorAssigned as fu, type OdeditorUnassigned as fv, type PicassoAssigned as fw, type PicassoUnassigned as fx, type WixelAssigned as fy, type WixelUnassigned as fz, type RecordManuallyCollectedPaymentApplicationErrors as g, type PlatformPaging as g$, type Refundability as g0, type RefundabilityAdditionalRefundabilityInfoOneOf as g1, type CreatePaymentGatewayOrderRequest as g2, type ChargedBy as g3, type ChargeMembershipsRequest as g4, type MembershipChargeItem as g5, type MembershipName as g6, type ChargeMembershipsResponse as g7, type TriggerRefundRequest as g8, type RefundSideEffects as g9, type PaymentStatusDetails as gA, type PaymentStatusDetailsStatusDetailsOneOf as gB, type Refund as gC, type RefundTransaction as gD, type RefundStatusInfo as gE, type AggregatedRefundSummary as gF, type RefundItemsBreakdown as gG, type LineItemRefundSummary as gH, type CalculateRefundRequest as gI, type CalculateRefundItemRequest as gJ, type CalculateRefundResponse as gK, type CalculateRefundItemResponse as gL, type VoidAuthorizedPaymentsRequest as gM, type CaptureAuthorizedPaymentsRequest as gN, type ChargeSavedPaymentMethodRequest as gO, type ChargeSavedPaymentMethodResponse as gP, type V1TriggerReindexRequest as gQ, type V1TriggerReindexResponse as gR, type V1TriggerReindexOrderRequest as gS, type DiffmatokyPayload as gT, type ErrorInformation as gU, type GetOrderRequest as gV, type GetOrderResponse as gW, type InternalQueryOrdersRequest as gX, type PlatformQuery as gY, type PlatformQueryPagingMethodOneOf as gZ, type Sorting as g_, type RestockInfo as ga, type RestockItem as gb, type OrderTransactions as gc, type Payment as gd, type PaymentPaymentDetailsOneOf as ge, type PaymentReceiptInfoOneOf as gf, type PaymentStatusDetailsOneOf as gg, type RegularPaymentDetails as gh, type RegularPaymentDetailsPaymentMethodDetailsOneOf as gi, type CreditCardPaymentMethodDetails as gj, type AuthorizationDetails as gk, type AuthorizationCapture as gl, type AuthorizationActionFailureDetails as gm, type AuthorizationVoid as gn, type V1ScheduledAction as go, type Chargeback as gp, type PaymentMethodName as gq, type GiftCardPaymentDetails as gr, type MembershipPaymentDetails as gs, type FutureMembershipDetails as gt, type WixReceiptInfo as gu, type ExternalReceiptInfo as gv, type CashRoundingDetails as gw, type CanceledStatusDetails as gx, type DeclinedStatusDetails as gy, type VoidedStatusDetails as gz, type PaymentCollectionMarkOrderAsPaidOptions as h, type TrackingLinkAdded as h$, type CursorPaging as h0, type InternalQueryOrdersResponse as h1, type PlatformPagingMetadata as h2, type Cursors as h3, type QueryOrderRequest as h4, type QueryOrderResponse as h5, type SearchOrdersRequest as h6, type CursorSearch as h7, type CursorSearchPagingMethodOneOf as h8, type CursorPagingMetadata as h9, type BulkUnArchiveOrdersResponse as hA, type BulkUnArchiveOrdersByFilterRequest as hB, type BulkUnArchiveOrdersByFilterResponse as hC, type UpdateBuyerInfoRequest as hD, type BuyerInfoUpdate as hE, type UpdateBuyerInfoResponse as hF, type UpdateBuyerEmailRequest as hG, type UpdateBuyerEmailResponse as hH, type UpdateOrderShippingAddressRequest as hI, type UpdateOrderShippingAddressResponse as hJ, type UpdateBillingContactDetailsRequest as hK, type UpdateBillingContactDetailsResponse as hL, type UpdateOrderLineItemRequest as hM, type UpdateOrderLineItemsRequest as hN, type MaskedOrderLineItem as hO, type UpdateOrderLineItemsResponse as hP, type AddInternalActivityRequest as hQ, type InternalActivity as hR, type InternalActivityContentOneOf as hS, type OrderPlaced as hT, type OrderPaid as hU, type OrderFulfilled as hV, type OrderNotFulfilled as hW, type OrderCanceled as hX, type DownloadLinkSent as hY, type TrackingNumberAdded as hZ, type TrackingNumberEdited as h_, type CreateOrderRequest as ha, type OrderCreationSettings as hb, type OrderCreationSettingsEditableByOneOf as hc, type OrderCreateNotifications as hd, type CreateOrderResponse as he, type UpdateOrderRequest as hf, type UpdateOrderResponse as hg, type BulkUpdateOrdersRequest as hh, type CommitDeltasRequest as hi, type DraftOrderDiffs as hj, type DraftOrderDiffsShippingUpdateInfoOneOf as hk, type DraftOrderDiffsBuyerUpdateInfoOneOf as hl, type DraftOrderDiffsBillingUpdateInfoOneOf as hm, type DraftOrderDiffsRecipientUpdateInfoOneOf as hn, type V1LineItemDelta as ho, type V1LineItemDeltaDeltaOneOf as hp, type CommitDeltasResponse as hq, type ArchiveOrderRequest as hr, type ArchiveOrderResponse as hs, type BulkArchiveOrdersRequest as ht, type BulkArchiveOrdersResponse as hu, type BulkArchiveOrdersByFilterRequest as hv, type BulkArchiveOrdersByFilterResponse as hw, type UnArchiveOrderRequest as hx, type UnArchiveOrderResponse as hy, type BulkUnArchiveOrdersRequest as hz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as i, type Cancel as i$, type ShippingConfirmationEmailSent as i0, type InvoiceAdded as i1, type InvoiceSent as i2, type FulfillerEmailSent as i3, type ShippingAddressEdited as i4, type EmailEdited as i5, type PickupReadyEmailSent as i6, type OrderPartiallyPaid as i7, type OrderPending as i8, type OrderRejected as i9, type BulkMarkAsUnfulfilledByFilterResponse as iA, type BulkSetBusinessLocationRequest as iB, type BulkSetBusinessLocationResponse as iC, type BulkSetBusinessLocationResult as iD, type V1MarkOrderAsPaidRequest as iE, type V1MarkOrderAsPaidResponse as iF, type V1BulkMarkOrdersAsPaidRequest as iG, type V1BulkMarkOrdersAsPaidResponse as iH, type V1CreatePaymentGatewayOrderRequest as iI, type V1CreatePaymentGatewayOrderResponse as iJ, type GetShipmentsRequest as iK, type GetShipmentsResponse as iL, type AggregateOrdersRequest as iM, type DecrementItemsQuantityRequest as iN, type DecrementData as iO, type DecrementItemsQuantityResponse as iP, type BulkUpdateOrderTagsRequest as iQ, type TagsTags as iR, type TagsTagList as iS, type BulkUpdateOrderTagsResult as iT, type SendOrderUpdatedDomainEventRequest as iU, type SendOrderUpdatedDomainEventResponse as iV, type Task as iW, type TaskKey as iX, type TaskAction as iY, type TaskActionActionOneOf as iZ, type Complete as i_, type AddInternalActivityResponse as ia, type AddActivityRequest as ib, type PublicActivityContentOneOf as ic, type AddActivitiesRequest as id, type UpdateActivityRequest as ie, type DeleteActivityRequest as ig, type UpdateLineItemsDescriptionLinesRequest as ih, type LineItemUpdate as ii, type UpdateLineItemsDescriptionLinesResponse as ij, type MarkOrderAsSeenByHumanRequest as ik, type MarkOrderAsSeenByHumanResponse as il, type CancelOrderRequest as im, type UpdateOrderStatusRequest as io, type MarkAsFulfilledRequest as ip, type MarkAsFulfilledResponse as iq, type BulkMarkAsFulfilledRequest as ir, type BulkMarkAsFulfilledResponse as is, type BulkMarkAsFulfilledByFilterRequest as it, type BulkMarkAsFulfilledByFilterResponse as iu, type MarkAsUnfulfilledRequest as iv, type MarkAsUnfulfilledResponse as iw, type BulkMarkAsUnfulfilledRequest as ix, type BulkMarkAsUnfulfilledResponse as iy, type BulkMarkAsUnfulfilledByFilterRequest as iz, type BulkMarkOrdersAsPaidResponse as j, type AdditionalFeeSourceWithLiterals as j$, type Reschedule as j0, type InvoiceSentEvent as j1, type IdAndVersion as j2, type InvoiceFields as j3, type Customer as j4, type Email as j5, type QuotesAddress as j6, type AddressDescription as j7, type Phone as j8, type Company as j9, type BaseEventMetadata as jA, type EventMetadata as jB, type AccountInfoMetadata as jC, type OrderSearchSpec as jD, utils as jE, type DescriptionLineTypeWithLiterals as jF, type DimensionsUnitWithLiterals as jG, type ItemTypePresetWithLiterals as jH, type PaymentOptionTypeWithLiterals as jI, type JurisdictionTypeWithLiterals as jJ, type SubscriptionFrequencyWithLiterals as jK, type ProductPeriodAlignmentWithLiterals as jL, type AdjustmentTypeWithLiterals as jM, type TaxableAddressTypeWithLiterals as jN, type MeasurementUnitWithLiterals as jO, type PaymentStatusEnumPaymentStatusWithLiterals as jP, type FulfillmentStatusWithLiterals as jQ, type WeightUnitWithLiterals as jR, type VatTypeWithLiterals as jS, type PickupMethodWithLiterals as jT, type DiscountTypeWithLiterals as jU, type DiscountReasonWithLiterals as jV, type LineItemQuantityChangeTypeWithLiterals as jW, type ActivityTypeWithLiterals as jX, type OrderActivityTypeEnumActivityTypeWithLiterals as jY, type AttributionSourceWithLiterals as jZ, type ChannelTypeWithLiterals as j_, type CommonAddress as ja, type CommonAddressStreetOneOf as jb, type Subdivision as jc, type StandardDetails as jd, type ShippingContactDetails as je, type InvoiceDates as jf, type LineItems as jg, type LineItem as jh, type BigDecimalWrapper as ji, type LineItemTax as jj, type Source as jk, type LineItemMetaData as jl, type Locale as jm, type TotalPrice as jn, type ItemizedFee as jo, type Discount as jp, type DiscountOneDiscountTypeOneOf as jq, type CalculatedTaxes as jr, type CalculatedTax as js, type Payments as jt, type InvoicesPayment as ju, type MetaData as jv, type InvoiceDynamicPriceTotals as jw, type CustomFieldValue as jx, type Value as jy, type Deposit as jz, type GetRefundabilityStatusResponse as k, triggerRefund as k$, type OrderActionTypeWithLiterals as k0, type SpecificItemsCouponBehaviorWithLiterals as k1, type ChargeTypeWithLiterals as k2, type VersioningModeWithLiterals as k3, type DeltaPaymentOptionTypeWithLiterals as k4, type InventoryActionWithLiterals as k5, type WebhookIdentityTypeWithLiterals as k6, type PreviewEmailTypeWithLiterals as k7, type StateWithLiterals as k8, type SiteCreatedContextWithLiterals as k9, type SubdivisionTypeWithLiterals as kA, type SourceTypeWithLiterals as kB, type CustomFieldGroupWithLiterals as kC, type ValueTypeWithLiterals as kD, type DepositTypeWithLiterals as kE, type InvoiceStatusWithLiterals as kF, type CommonSearchWithEntityContext as kG, onOrderApproved as kH, onOrderCanceled as kI, onOrderCommitted as kJ, onOrderCreated as kK, onOrderFulfilled as kL, onOrderImported as kM, onOrderImportedOrderDeleted as kN, onOrderPaymentStatusUpdated as kO, onOrderUpdated as kP, importOrder as kQ, setOrderNumberCounter as kR, bulkDeleteImportedOrders as kS, preparePaymentCollection as kT, getPaymentCollectabilityStatus as kU, recordManuallyCollectedPayment as kV, paymentCollectionMarkOrderAsPaid as kW, paymentCollectionBulkMarkOrdersAsPaid as kX, getRefundabilityStatus as kY, paymentCollectionCreatePaymentGatewayOrder as kZ, chargeMemberships as k_, type NamespaceWithLiterals as ka, type DeleteStatusWithLiterals as kb, type OriginWithLiterals as kc, type ScheduledActionWithLiterals as kd, type DurationUnitWithLiterals as ke, type PaymentCollectabilityStatusWithLiterals as kf, type PredefinedPaymentMethodWithLiterals as kg, type RefundableStatusWithLiterals as kh, type NonRefundableReasonWithLiterals as ki, type ManuallyRefundableReasonWithLiterals as kj, type RestockTypeWithLiterals as kk, type TransactionStatusWithLiterals as kl, type AuthorizationCaptureStatusWithLiterals as km, type AuthorizationVoidStatusWithLiterals as kn, type ReasonWithLiterals as ko, type ActionTypeWithLiterals as kp, type ChargebackStatusWithLiterals as kq, type MembershipPaymentStatusWithLiterals as kr, type PaymentStatusWithLiterals as ks, type CanceledReasonWithLiterals as kt, type DeclinedReasonWithLiterals as ku, type VoidedReasonWithLiterals as kv, type RefundStatusWithLiterals as kw, type SortOrderWithLiterals as kx, type OrderApprovalStrategyWithLiterals as ky, type PlacementWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, voidAuthorizedPayments as l0, captureAuthorizedPayments as l1, getOrder as l2, createOrder as l3, updateOrder as l4, bulkUpdateOrders as l5, updateOrderLineItem as l6, addActivity as l7, addActivities as l8, updateActivity as l9, deleteActivity as la, cancelOrder as lb, updateOrderStatus as lc, aggregateOrders as ld, bulkUpdateOrderTags as le, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as m, type ChargeMembershipsOptions as n, type PaymentRefund as o, type TriggerRefundResponse as p, type TriggerRefundApplicationErrors as q, type VoidAuthorizedPaymentsApplicationErrors as r, type PaymentCapture as s, type CaptureAuthorizedPaymentsResponse as t, type CaptureAuthorizedPaymentsApplicationErrors as u, type GetOrderApplicationErrors as v, type OrderSearch as w, type SearchOrdersResponse as x, type CreateOrderOptions as y, type CreateOrderApplicationErrors as z };