@wix/auto_sdk_ecom_orders 1.0.289 → 1.0.290

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