@wix/auto_sdk_ecom_orders 1.0.304 → 1.0.306

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-BO6gFADZ.d.ts → ecom-v1-order-orders.universal-WyKRc4fh.d.ts} +1674 -1672
  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 +1674 -1672
  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-BO6gFADZ.d.mts → ecom-v1-order-orders.universal-WyKRc4fh.d.mts} +1674 -1672
  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 +1674 -1672
  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-Doi51FeO.d.ts → ecom-v1-order-orders.universal-BJo4OYMU.d.ts} +1826 -1824
  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 +1826 -1824
  25. package/build/internal/es/{ecom-v1-order-orders.universal-Doi51FeO.d.mts → ecom-v1-order-orders.universal-BJo4OYMU.d.mts} +1826 -1824
  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 +1826 -1824
  29. package/package.json +2 -2
@@ -4458,2326 +4458,2328 @@ interface BulkDeleteImportedOrdersResponse {
4458
4458
  */
4459
4459
  jobId?: string;
4460
4460
  }
4461
- interface V1TriggerReindexRequest {
4461
+ interface SendBuyerConfirmationEmailRequest {
4462
4462
  /** @format GUID */
4463
- metasiteId?: string;
4463
+ orderId?: string;
4464
+ }
4465
+ interface SendBuyerConfirmationEmailResponse {
4466
+ }
4467
+ interface SendBuyerPaymentsReceivedEmailRequest {
4464
4468
  /**
4465
4469
  * @minLength 1
4466
4470
  * @maxLength 100
4467
- * @maxSize 100
4468
4471
  */
4469
- orderIds?: string[];
4472
+ orderId?: string;
4470
4473
  }
4471
- interface V1TriggerReindexResponse {
4474
+ interface SendBuyerPaymentsReceivedEmailResponse {
4472
4475
  }
4473
- interface V1TriggerReindexOrderRequest {
4474
- /** @format GUID */
4475
- metasiteId?: string;
4476
+ interface SendBuyerPickupConfirmationEmailRequest {
4476
4477
  /**
4477
4478
  * @minLength 1
4478
4479
  * @maxLength 100
4479
4480
  */
4480
4481
  orderId?: string;
4481
4482
  }
4482
- interface PreparePaymentCollectionRequest {
4483
+ interface SendBuyerPickupConfirmationEmailResponse {
4484
+ }
4485
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
4486
+ /**
4487
+ * IDs of orders to send pickup emails for.
4488
+ * @minSize 1
4489
+ * @maxSize 300
4490
+ */
4491
+ orderIds?: string[];
4492
+ }
4493
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
4494
+ }
4495
+ interface SendBuyerShippingConfirmationEmailRequest {
4483
4496
  /**
4484
- * Ecom order ID.
4485
4497
  * @minLength 1
4486
4498
  * @maxLength 100
4487
4499
  */
4488
- ecomOrderId: string;
4489
- /** Amount to collect */
4490
- amount: Price;
4500
+ orderId?: string;
4501
+ }
4502
+ interface SendBuyerShippingConfirmationEmailResponse {
4503
+ }
4504
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
4491
4505
  /**
4492
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4493
- * Existing payment gateway order will be updated with a new amount.
4494
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4506
+ * IDs of orders to send pickup emails for.
4507
+ * @minSize 1
4508
+ * @maxSize 300
4495
4509
  */
4496
- paymentGatewayOrderId?: string | null;
4510
+ orderIds?: string[];
4511
+ }
4512
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
4513
+ }
4514
+ interface SendMerchantOrderReceivedNotificationRequest {
4497
4515
  /**
4498
- * Whether to delay capture of the payment.
4499
- * Default: false
4500
- * @deprecated Whether to delay capture of the payment.
4501
- * Default: false
4502
- * @replacedBy delayed_capture_settings.scheduled_action
4503
- * @targetRemovalDate 2024-09-30
4516
+ * @minLength 1
4517
+ * @maxLength 100
4504
4518
  */
4505
- delayedCapture?: boolean;
4519
+ orderId?: string;
4520
+ }
4521
+ interface SendMerchantOrderReceivedNotificationResponse {
4522
+ }
4523
+ interface SendCancelRefundEmailRequest {
4506
4524
  /**
4507
- * Specifies whether payment collection is initiated by Merchant or User of User
4508
- * Default: `true`
4509
- * @internal
4525
+ * The ID of order that is canceled/refunded
4526
+ * @minLength 1
4527
+ * @maxLength 100
4510
4528
  */
4511
- merchantInitiated?: boolean | null;
4529
+ orderId?: string;
4512
4530
  /**
4513
- * Redirect urls which are used to return buyer to third party system.
4514
- * @internal
4531
+ * Personal note added to the email (optional)
4532
+ * @minLength 1
4533
+ * @maxLength 1000
4515
4534
  */
4516
- redirectUrls?: RedirectUrls;
4517
- /** Delayed capture payment settings */
4518
- delayedCaptureSettings?: DelayedCaptureSettings;
4519
- }
4520
- interface RedirectUrls {
4535
+ customMessage?: string | null;
4536
+ /** Refund amount */
4537
+ refundAmount?: Price;
4521
4538
  /**
4522
- * URL to redirect buyer in case of approved (successful) transaction
4523
- * @format WEB_URL
4539
+ * Refund ID. (Optional)
4540
+ * @format GUID
4524
4541
  */
4525
- successUrl?: string | null;
4542
+ refundId?: string | null;
4543
+ }
4544
+ interface SendCancelRefundEmailResponse {
4545
+ }
4546
+ interface SendRefundEmailRequest {
4526
4547
  /**
4527
- * URL to redirect buyer in case of buyer canceled the transaction
4528
- * @format WEB_URL
4548
+ * The ID of order that is refunded
4549
+ * @format GUID
4529
4550
  */
4530
- cancelUrl?: string | null;
4551
+ orderId?: string;
4531
4552
  /**
4532
- * URL to redirect buyer in case of failed/rejected transaction
4533
- * @format WEB_URL
4553
+ * Refund ID
4554
+ * @format GUID
4534
4555
  */
4535
- errorUrl?: string | null;
4556
+ refundId?: string;
4536
4557
  /**
4537
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4538
- * @format WEB_URL
4558
+ * Personal note added to the email (optional)
4559
+ * @minLength 1
4560
+ * @maxLength 1000
4539
4561
  */
4540
- pendingUrl?: string | null;
4562
+ customMessage?: string | null;
4541
4563
  }
4542
- interface DelayedCaptureSettings {
4543
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4544
- scheduledAction?: ScheduledActionWithLiterals;
4545
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4546
- delayDuration?: Duration;
4564
+ interface SendRefundEmailResponse {
4547
4565
  }
4548
- declare enum ScheduledAction {
4549
- /** Whether payment will be auto-voided when duration passes */
4550
- VOID = "VOID",
4551
- /** Whether payment will be auto-captured when duration passes */
4552
- CAPTURE = "CAPTURE"
4566
+ interface SendFulfillmentEmailRequest {
4567
+ /** @format GUID */
4568
+ orderId?: string;
4569
+ /** @format GUID */
4570
+ fulfillerId?: string;
4553
4571
  }
4554
- /** @enumType */
4555
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4556
- interface Duration {
4572
+ interface SendFulfillmentEmailResponse {
4573
+ }
4574
+ interface SendMerchantOrderReceivedPushRequest {
4557
4575
  /**
4558
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4559
- * @min 1
4576
+ * @minLength 1
4577
+ * @maxLength 100
4560
4578
  */
4561
- count?: number;
4562
- /** Duration unit: MINUTES, HOURS and DAYS */
4563
- unit?: DurationUnitWithLiterals;
4579
+ orderId?: string;
4564
4580
  }
4565
- declare enum DurationUnit {
4566
- MINUTES = "MINUTES",
4567
- HOURS = "HOURS",
4568
- DAYS = "DAYS"
4581
+ interface SendMerchantOrderReceivedPushResponse {
4582
+ }
4583
+ interface PreviewEmailByTypeRequest {
4584
+ emailType?: PreviewEmailTypeWithLiterals;
4585
+ }
4586
+ declare enum PreviewEmailType {
4587
+ ORDER_PLACED = "ORDER_PLACED",
4588
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4589
+ ORDER_SHIPPED = "ORDER_SHIPPED",
4590
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4569
4591
  }
4570
4592
  /** @enumType */
4571
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4572
- interface PreparePaymentCollectionResponse {
4573
- /** Payment gateway order id which is associated with given payment */
4574
- paymentGatewayOrderId?: string;
4593
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4594
+ interface PreviewEmailByTypeResponse {
4595
+ emailPreview?: string;
4575
4596
  }
4576
- interface GetPaymentCollectabilityStatusRequest {
4597
+ interface PreviewRefundEmailRequest {
4577
4598
  /**
4578
- * Ecom order ID.
4579
4599
  * @minLength 1
4580
4600
  * @maxLength 100
4581
4601
  */
4582
- ecomOrderId: string;
4583
- }
4584
- interface GetPaymentCollectabilityStatusResponse {
4585
- /** Payment collectability status */
4586
- status?: PaymentCollectabilityStatusWithLiterals;
4587
- /** Collectable order amount */
4588
- amount?: Price;
4602
+ orderId?: string;
4603
+ /** Refund amount */
4604
+ refundAmount?: Price;
4605
+ /** Refund business details */
4606
+ details?: RefundDetails;
4589
4607
  /**
4590
- * Whether authorization supported
4591
- * @internal
4608
+ * Personal note added to the email (optional)
4609
+ * @minLength 1
4610
+ * @maxLength 1000
4592
4611
  */
4593
- authorizationSupported?: boolean;
4612
+ customMessage?: string | null;
4594
4613
  /**
4595
- * Whether custom amount is supported for payment collection
4596
- * @internal
4614
+ * Refund ID. (Optional)
4615
+ * @format GUID
4597
4616
  */
4598
- customAmountSupported?: boolean;
4599
- }
4600
- declare enum PaymentCollectabilityStatus {
4601
- UNKNOWN = "UNKNOWN",
4602
- COLLECTABLE = "COLLECTABLE",
4603
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4604
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4605
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4606
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4607
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4608
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4609
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4610
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4611
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4612
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4613
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4617
+ refundId?: string | null;
4614
4618
  }
4615
- /** @enumType */
4616
- type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
4617
- interface RecordManuallyCollectedPaymentRequest {
4619
+ /** Business model of a refund request */
4620
+ interface RefundDetails {
4618
4621
  /**
4619
- * Order ID.
4620
- * @minLength 1
4621
- * @maxLength 100
4622
+ * Order line item IDs and quantities that were refunded.
4623
+ * @maxSize 300
4622
4624
  */
4623
- orderId: string;
4624
- /** Amount to be recorded as approved manual payment for given order */
4625
- amount: Price;
4625
+ items?: RefundItem[];
4626
+ /** Whether the shipping fee was also refunded. */
4627
+ shippingIncluded?: boolean;
4626
4628
  /**
4627
- * Payment method name provided by user.
4628
- *
4629
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4630
- * @internal
4629
+ * Reason for the refund, provided by customer (optional).
4630
+ * @maxLength 200
4631
4631
  */
4632
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4633
- }
4634
- /**
4635
- * User-defined payment method name.
4636
- * Allows specifying either a predefined type or a custom name.
4637
- */
4638
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4639
- /** Predefined payment method. */
4640
- predefined?: PredefinedPaymentMethodWithLiterals;
4632
+ reason?: string | null;
4641
4633
  /**
4642
- * Custom payment method name provided by user.
4643
- *
4644
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4645
- * @minLength 1
4646
- * @maxLength 150
4634
+ * Line items that were refunded.
4635
+ * @maxSize 300
4647
4636
  */
4648
- custom?: string | null;
4649
- }
4650
- /** @oneof */
4651
- interface UserDefinedPaymentMethodNameKindOneOf {
4652
- /** Predefined payment method. */
4653
- predefined?: PredefinedPaymentMethodWithLiterals;
4637
+ lineItems?: LineItemRefund[];
4654
4638
  /**
4655
- * Custom payment method name provided by user.
4656
- *
4657
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4658
- * @minLength 1
4659
- * @maxLength 150
4639
+ * Additional fees that were refunded.
4640
+ * @maxSize 100
4660
4641
  */
4661
- custom?: string | null;
4662
- }
4663
- /** Predefined payment method types for offline/manual payments. */
4664
- declare enum PredefinedPaymentMethod {
4665
- /** Cash payment. */
4666
- CASH = "CASH",
4667
- /** Bank transfer. */
4668
- BANK_TRANSFER = "BANK_TRANSFER",
4669
- /** Payment by check. */
4670
- CHECK = "CHECK"
4671
- }
4672
- /** @enumType */
4673
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4674
- interface RecordManuallyCollectedPaymentResponse {
4642
+ additionalFees?: AdditionalFeeRefund[];
4643
+ /** Shipping amount that was refunded. */
4644
+ shipping?: ShippingRefund;
4675
4645
  }
4676
- interface MarkOrderAsPaidRequest {
4646
+ interface RefundItem {
4677
4647
  /**
4678
- * Ecom order ID.
4679
- * @minLength 1
4680
- * @maxLength 100
4648
+ * Line item ID the refunded line item.
4649
+ * @format GUID
4681
4650
  */
4682
- ecomOrderId: string;
4651
+ lineItemId?: string;
4683
4652
  /**
4684
- * Payment method name provided by user.
4685
- *
4686
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4687
- * @internal
4653
+ * Line item quantity refunded.
4654
+ * @min 1
4655
+ * @max 100000
4688
4656
  */
4689
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4690
- }
4691
- interface MarkOrderAsPaidResponse {
4692
- /** Updated order. */
4693
- order?: Order;
4657
+ quantity?: number;
4694
4658
  }
4695
- interface BulkMarkOrdersAsPaidRequest {
4659
+ interface LineItemRefund {
4696
4660
  /**
4697
- * IDs of orders to mark as paid.
4698
- * @minSize 1
4699
- * @maxSize 100
4700
- * @minLength 1
4701
- * @maxLength 100
4661
+ * Line item ID.
4662
+ * @format GUID
4663
+ * @immutable
4702
4664
  */
4703
- ecomOrderIds: string[];
4704
- }
4705
- interface BulkMarkOrdersAsPaidResponse {
4665
+ lineItemId?: string;
4706
4666
  /**
4707
- * Items updated by the bulk action.
4708
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4667
+ * Refund quantity.
4668
+ * @min 1
4669
+ * @max 100000
4670
+ * @immutable
4709
4671
  */
4710
- results?: BulkOrderResult[];
4711
- /** Bulk action metadata. */
4712
- bulkActionMetadata?: BulkActionMetadata;
4672
+ quantity?: number;
4713
4673
  }
4714
- interface BulkOrderResult {
4715
- /** Item metadata. */
4716
- itemMetadata?: ItemMetadata;
4674
+ interface AdditionalFeeRefund {
4717
4675
  /**
4718
- * Updated order.
4719
- *
4720
- * Returned when `returnFullEntity = true`.
4676
+ * Additional fee ID.
4677
+ * @format GUID
4678
+ * @immutable
4721
4679
  */
4722
- item?: Order;
4723
- }
4724
- interface ItemMetadata {
4725
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4726
- _id?: string | null;
4727
- /** Index of the item within the request array. Allows for correlation between request and response items. */
4728
- originalIndex?: number;
4729
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4730
- success?: boolean;
4731
- /** Details about the error in case of failure. */
4732
- error?: ApplicationError;
4733
- }
4734
- interface ApplicationError {
4735
- /** Error code. */
4736
- code?: string;
4737
- /** Description of the error. */
4738
- description?: string;
4739
- /** Data related to the error. */
4740
- data?: Record<string, any> | null;
4741
- }
4742
- interface BulkActionMetadata {
4743
- /** Number of items that were successfully processed. */
4744
- totalSuccesses?: number;
4745
- /** Number of items that couldn't be processed. */
4746
- totalFailures?: number;
4747
- /** Number of failures without details because detailed failure threshold was exceeded. */
4748
- undetailedFailures?: number;
4749
- }
4750
- interface GetRefundabilityStatusRequest {
4680
+ additionalFeeId?: string;
4751
4681
  /**
4752
- * Order ID.
4753
- * @minLength 1
4754
- * @maxLength 100
4682
+ * Refund amount.
4683
+ * @immutable
4755
4684
  */
4756
- ecomOrderId: string;
4685
+ amount?: Price;
4757
4686
  }
4758
- interface GetRefundabilityStatusResponse {
4759
- /**
4760
- * Refundability details.
4761
- * @maxSize 300
4762
- */
4763
- refundabilities?: Refundability[];
4687
+ interface ShippingRefund {
4764
4688
  /**
4765
- * Whether the order supports refunding per item.
4766
- * @deprecated
4689
+ * Refund amount.
4690
+ * @immutable
4767
4691
  */
4768
- refundablePerItem?: boolean;
4769
- }
4770
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4771
- /** Reason why payment is not refundable. */
4772
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4773
- /** Reason why payment is only refundable manually. */
4774
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4775
- /** Payment ID. */
4776
- paymentId?: string;
4777
- /** Payment refundability status. */
4778
- refundabilityStatus?: RefundableStatusWithLiterals;
4779
- /** Link to payment provider dashboard. */
4780
- providerLink?: string | null;
4781
- }
4782
- /** @oneof */
4783
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
4784
- /** Reason why payment is not refundable. */
4785
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4786
- /** Reason why payment is only refundable manually. */
4787
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4788
- }
4789
- declare enum RefundableStatus {
4790
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
4791
- MANUAL = "MANUAL",
4792
- REFUNDABLE = "REFUNDABLE"
4793
- }
4794
- /** @enumType */
4795
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4796
- declare enum NonRefundableReason {
4797
- NONE = "NONE",
4798
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
4799
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4800
- INTERNAL_ERROR = "INTERNAL_ERROR",
4801
- NOT_PAID = "NOT_PAID",
4802
- ACCESS_DENIED = "ACCESS_DENIED",
4803
- ZERO_PRICE = "ZERO_PRICE",
4804
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4805
- PENDING_REFUND = "PENDING_REFUND",
4806
- FORBIDDEN = "FORBIDDEN",
4807
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4808
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
4809
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4692
+ amount?: Price;
4810
4693
  }
4811
- /** @enumType */
4812
- 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';
4813
- declare enum ManuallyRefundableReason {
4814
- EXPIRED = "EXPIRED",
4815
- NOT_SUPPORTED = "NOT_SUPPORTED",
4816
- OFFLINE = "OFFLINE",
4817
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4694
+ interface PreviewRefundEmailResponse {
4695
+ emailPreview?: string;
4818
4696
  }
4819
- /** @enumType */
4820
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4821
- interface CreatePaymentGatewayOrderRequest {
4697
+ interface PreviewCancelEmailRequest {
4822
4698
  /**
4823
- * Ecom order ID.
4824
4699
  * @minLength 1
4825
4700
  * @maxLength 100
4826
4701
  */
4827
- ecomOrderId: string;
4828
- /** Information about the user who initiated the payment. */
4829
- chargedBy?: ChargedBy;
4830
- /**
4831
- * Whether to delay capture of the payment.
4832
- *
4833
- * Default: false
4834
- * @internal
4835
- */
4836
- delayedCapture?: boolean;
4837
- }
4838
- interface ChargedBy {
4839
- /**
4840
- * ID - id of the user who initiated the payment
4841
- * @format GUID
4842
- */
4843
- _id?: string;
4702
+ orderId?: string;
4844
4703
  /**
4845
- * Full name - name of the user who initiated the payment
4704
+ * Personal note added to the email (optional)
4846
4705
  * @minLength 1
4847
- * @maxLength 200
4706
+ * @maxLength 1000
4848
4707
  */
4849
- fullName?: string | null;
4708
+ customMessage?: string | null;
4850
4709
  }
4851
- interface CreatePaymentGatewayOrderResponse {
4852
- /** ID of the order created in the payment gateway */
4853
- paymentGatewayOrderId?: string;
4710
+ interface PreviewCancelEmailResponse {
4711
+ emailPreview?: string;
4854
4712
  }
4855
- interface ChargeMembershipsRequest {
4713
+ interface PreviewCancelRefundEmailRequest {
4856
4714
  /**
4857
- * Order ID.
4858
4715
  * @minLength 1
4859
4716
  * @maxLength 100
4860
4717
  */
4861
- ecomOrderId: string;
4862
- /**
4863
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4864
- * but a user which is using the membership on behalf of the a member
4865
- * @format GUID
4866
- */
4867
- memberId: string;
4868
- /**
4869
- * List of items to be paid by memberships
4870
- * @minSize 1
4871
- * @maxSize 300
4872
- */
4873
- membershipCharges?: MembershipChargeItem[];
4874
- }
4875
- interface MembershipChargeItem {
4718
+ orderId?: string;
4876
4719
  /**
4877
- * The id of used membership
4720
+ * Personal note added to the email (optional)
4878
4721
  * @minLength 1
4879
- * @maxLength 100
4722
+ * @maxLength 1000
4880
4723
  */
4881
- membershipId?: string;
4724
+ customMessage?: string | null;
4725
+ /** Refund amount */
4726
+ refundAmount?: Price;
4882
4727
  /**
4883
- * ID of the application providing this payment option
4728
+ * Refund ID. (Optional)
4884
4729
  * @format GUID
4885
4730
  */
4886
- appId?: string;
4887
- /** The name of used membership */
4888
- membershipName?: MembershipName;
4889
- /** Additional data about this membership */
4890
- membershipAdditionalData?: Record<string, any> | null;
4891
- /** Catalog and item reference info. */
4892
- catalogReference?: CatalogReference;
4893
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
4894
- serviceProperties?: ServiceProperties;
4895
- /**
4896
- * Usually would be the same as catalogReference.catalogItemId
4897
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
4898
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4899
- * @minLength 1
4900
- * @maxLength 36
4901
- */
4902
- rootCatalogItemId?: string | null;
4903
- /**
4904
- * line item id of Checkout/Order line item
4905
- * @minLength 1
4906
- * @maxLength 100
4907
- */
4908
- lineItemId?: string;
4731
+ refundId?: string | null;
4909
4732
  }
4910
- interface MembershipName {
4911
- /**
4912
- * Membership name.
4913
- * @maxLength 100
4914
- */
4915
- original?: string;
4916
- /**
4917
- * Translated membership name. Defaults to `original` when not provided.
4918
- * @maxLength 100
4919
- */
4920
- translated?: string | null;
4733
+ interface PreviewCancelRefundEmailResponse {
4734
+ emailPreview?: string;
4921
4735
  }
4922
- interface ChargeMembershipsResponse {
4736
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
4923
4737
  }
4924
- interface TriggerRefundRequest {
4738
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
4739
+ emailPreview?: string;
4740
+ }
4741
+ interface PreviewBuyerConfirmationEmailRequest {
4742
+ }
4743
+ interface PreviewBuyerConfirmationEmailResponse {
4744
+ emailPreview?: string;
4745
+ }
4746
+ interface PreviewBuyerPickupConfirmationEmailRequest {
4747
+ }
4748
+ interface PreviewBuyerPickupConfirmationEmailResponse {
4749
+ emailPreview?: string;
4750
+ }
4751
+ interface PreviewShippingConfirmationEmailRequest {
4752
+ }
4753
+ interface PreviewShippingConfirmationEmailResponse {
4754
+ emailPreview?: string;
4755
+ }
4756
+ interface PreviewResendDownloadLinksEmailRequest {
4757
+ }
4758
+ interface PreviewResendDownloadLinksEmailResponse {
4759
+ emailPreview?: string;
4760
+ }
4761
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4762
+ /** Emitted on a meta site creation. */
4763
+ siteCreated?: SiteCreated;
4764
+ /** Emitted on a meta site transfer completion. */
4765
+ siteTransferred?: SiteTransferred;
4766
+ /** Emitted on a meta site deletion. */
4767
+ siteDeleted?: SiteDeleted;
4768
+ /** Emitted on a meta site restoration. */
4769
+ siteUndeleted?: SiteUndeleted;
4770
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4771
+ sitePublished?: SitePublished;
4772
+ /** Emitted on a meta site unpublish. */
4773
+ siteUnpublished?: SiteUnpublished;
4774
+ /** Emitted when meta site is marked as template. */
4775
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4776
+ /** Emitted when meta site is marked as a WixSite. */
4777
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4778
+ /** Emitted when an application is provisioned (installed). */
4779
+ serviceProvisioned?: ServiceProvisioned;
4780
+ /** Emitted when an application is removed (uninstalled). */
4781
+ serviceRemoved?: ServiceRemoved;
4782
+ /** Emitted when meta site name (URL slug) is changed. */
4783
+ siteRenamedPayload?: SiteRenamed;
4784
+ /** Emitted when meta site was permanently deleted. */
4785
+ hardDeleted?: SiteHardDeleted;
4786
+ /** Emitted on a namespace change. */
4787
+ namespaceChanged?: NamespaceChanged;
4788
+ /** Emitted when Studio is attached. */
4789
+ studioAssigned?: StudioAssigned;
4790
+ /** Emitted when Studio is detached. */
4791
+ studioUnassigned?: StudioUnassigned;
4925
4792
  /**
4926
- * The order this refund related to
4927
- * @minLength 1
4928
- * @maxLength 100
4793
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4794
+ * the actual URL.
4795
+ *
4796
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4797
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4929
4798
  */
4930
- ecomOrderId: string;
4799
+ urlChanged?: SiteUrlChanged;
4800
+ /** Site is marked as PurgedExternally */
4801
+ sitePurgedExternally?: SitePurgedExternally;
4802
+ /** Emitted when Odeditor is attached. */
4803
+ odeditorAssigned?: OdeditorAssigned;
4804
+ /** Emitted when Odeditor is detached. */
4805
+ odeditorUnassigned?: OdeditorUnassigned;
4806
+ /** Emitted when Picasso is attached. */
4807
+ picassoAssigned?: PicassoAssigned;
4808
+ /** Emitted when Picasso is detached. */
4809
+ picassoUnassigned?: PicassoUnassigned;
4810
+ /** Emitted when Wixel is attached. */
4811
+ wixelAssigned?: WixelAssigned;
4812
+ /** Emitted when Wixel is detached. */
4813
+ wixelUnassigned?: WixelUnassigned;
4814
+ /** Emitted when StudioTwo is attached. */
4815
+ studioTwoAssigned?: StudioTwoAssigned;
4816
+ /** Emitted when StudioTwo is detached. */
4817
+ studioTwoUnassigned?: StudioTwoUnassigned;
4818
+ /** Emitted when media from user domain is enabled. */
4819
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4820
+ /** Emitted when media from user domain is disabled. */
4821
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4822
+ /** Emitted when Editorless is attached. */
4823
+ editorlessAssigned?: EditorlessAssigned;
4824
+ /** Emitted when Editorless is detached. */
4825
+ editorlessUnassigned?: EditorlessUnassigned;
4931
4826
  /**
4932
- * Refund operations information
4933
- * @minSize 1
4934
- * @maxSize 1
4827
+ * A meta site id.
4828
+ * @format GUID
4935
4829
  */
4936
- payments: PaymentRefund[];
4937
- /** Business model of a refund */
4938
- details?: RefundDetails;
4939
- /** Side effect details related to refund */
4940
- sideEffects?: RefundSideEffects;
4830
+ metaSiteId?: string;
4831
+ /** A meta site version. Monotonically increasing. */
4832
+ version?: string;
4833
+ /** A timestamp of the event. */
4834
+ timestamp?: string;
4835
+ /**
4836
+ * TODO(meta-site): Change validation once validations are disabled for consumers
4837
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4838
+ * @maxSize 4000
4839
+ */
4840
+ assets?: Asset[];
4941
4841
  }
4942
- interface PaymentRefund {
4842
+ /** @oneof */
4843
+ interface MetaSiteSpecialEventPayloadOneOf {
4844
+ /** Emitted on a meta site creation. */
4845
+ siteCreated?: SiteCreated;
4846
+ /** Emitted on a meta site transfer completion. */
4847
+ siteTransferred?: SiteTransferred;
4848
+ /** Emitted on a meta site deletion. */
4849
+ siteDeleted?: SiteDeleted;
4850
+ /** Emitted on a meta site restoration. */
4851
+ siteUndeleted?: SiteUndeleted;
4852
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4853
+ sitePublished?: SitePublished;
4854
+ /** Emitted on a meta site unpublish. */
4855
+ siteUnpublished?: SiteUnpublished;
4856
+ /** Emitted when meta site is marked as template. */
4857
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4858
+ /** Emitted when meta site is marked as a WixSite. */
4859
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4860
+ /** Emitted when an application is provisioned (installed). */
4861
+ serviceProvisioned?: ServiceProvisioned;
4862
+ /** Emitted when an application is removed (uninstalled). */
4863
+ serviceRemoved?: ServiceRemoved;
4864
+ /** Emitted when meta site name (URL slug) is changed. */
4865
+ siteRenamedPayload?: SiteRenamed;
4866
+ /** Emitted when meta site was permanently deleted. */
4867
+ hardDeleted?: SiteHardDeleted;
4868
+ /** Emitted on a namespace change. */
4869
+ namespaceChanged?: NamespaceChanged;
4870
+ /** Emitted when Studio is attached. */
4871
+ studioAssigned?: StudioAssigned;
4872
+ /** Emitted when Studio is detached. */
4873
+ studioUnassigned?: StudioUnassigned;
4943
4874
  /**
4944
- * Specific payment within the order to refund
4945
- * @format GUID
4875
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4876
+ * the actual URL.
4877
+ *
4878
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4879
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4946
4880
  */
4947
- paymentId?: string;
4948
- /** Refund amount. Not relevant for membership and gift card refunds. */
4949
- amount?: Price;
4881
+ urlChanged?: SiteUrlChanged;
4882
+ /** Site is marked as PurgedExternally */
4883
+ sitePurgedExternally?: SitePurgedExternally;
4884
+ /** Emitted when Odeditor is attached. */
4885
+ odeditorAssigned?: OdeditorAssigned;
4886
+ /** Emitted when Odeditor is detached. */
4887
+ odeditorUnassigned?: OdeditorUnassigned;
4888
+ /** Emitted when Picasso is attached. */
4889
+ picassoAssigned?: PicassoAssigned;
4890
+ /** Emitted when Picasso is detached. */
4891
+ picassoUnassigned?: PicassoUnassigned;
4892
+ /** Emitted when Wixel is attached. */
4893
+ wixelAssigned?: WixelAssigned;
4894
+ /** Emitted when Wixel is detached. */
4895
+ wixelUnassigned?: WixelUnassigned;
4896
+ /** Emitted when StudioTwo is attached. */
4897
+ studioTwoAssigned?: StudioTwoAssigned;
4898
+ /** Emitted when StudioTwo is detached. */
4899
+ studioTwoUnassigned?: StudioTwoUnassigned;
4900
+ /** Emitted when media from user domain is enabled. */
4901
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4902
+ /** Emitted when media from user domain is disabled. */
4903
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4904
+ /** Emitted when Editorless is attached. */
4905
+ editorlessAssigned?: EditorlessAssigned;
4906
+ /** Emitted when Editorless is detached. */
4907
+ editorlessUnassigned?: EditorlessUnassigned;
4908
+ }
4909
+ interface Asset {
4950
4910
  /**
4951
- * Whether refund is made externally and manually (on the payment provider's side)
4952
- * 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.
4953
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4911
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4912
+ * @maxLength 36
4954
4913
  */
4955
- externalRefund?: boolean;
4914
+ appDefId?: string;
4956
4915
  /**
4957
- * Gateway refund id. When param is present, new refund is not created.
4958
- * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
4959
- * and all side effects from request will be executed.
4960
- * @internal
4961
- * @minLength 1
4962
- * @maxLength 100
4916
+ * An instance id. For legacy reasons may be UUID or a string.
4917
+ * @maxLength 200
4963
4918
  */
4964
- gatewayRefundId?: string | null;
4919
+ instanceId?: string;
4920
+ /** An application state. */
4921
+ state?: StateWithLiterals;
4965
4922
  }
4966
- /** Business model of a refund request */
4967
- interface RefundDetails {
4923
+ declare enum State {
4924
+ UNKNOWN = "UNKNOWN",
4925
+ ENABLED = "ENABLED",
4926
+ DISABLED = "DISABLED",
4927
+ PENDING = "PENDING",
4928
+ DEMO = "DEMO"
4929
+ }
4930
+ /** @enumType */
4931
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
4932
+ interface SiteCreated {
4968
4933
  /**
4969
- * Order line item IDs and quantities that were refunded.
4970
- * @maxSize 300
4934
+ * A template identifier (empty if not created from a template).
4935
+ * @maxLength 36
4971
4936
  */
4972
- items?: RefundItem[];
4973
- /** Whether the shipping fee was also refunded. */
4974
- shippingIncluded?: boolean;
4937
+ originTemplateId?: string;
4975
4938
  /**
4976
- * Reason for the refund, provided by customer (optional).
4977
- * @maxLength 200
4939
+ * An account id of the owner.
4940
+ * @format GUID
4978
4941
  */
4979
- reason?: string | null;
4942
+ ownerId?: string;
4943
+ /** A context in which meta site was created. */
4944
+ context?: SiteCreatedContextWithLiterals;
4980
4945
  /**
4981
- * Line items that were refunded.
4982
- * @maxSize 300
4946
+ * A meta site id from which this site was created.
4947
+ *
4948
+ * In case of a creation from a template it's a template id.
4949
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
4950
+ * @format GUID
4983
4951
  */
4984
- lineItems?: LineItemRefund[];
4952
+ originMetaSiteId?: string | null;
4985
4953
  /**
4986
- * Additional fees that were refunded.
4987
- * @maxSize 100
4954
+ * A meta site name (URL slug).
4955
+ * @maxLength 20
4988
4956
  */
4989
- additionalFees?: AdditionalFeeRefund[];
4990
- /** Shipping amount that was refunded. */
4991
- shipping?: ShippingRefund;
4957
+ siteName?: string;
4958
+ /** A namespace. */
4959
+ namespace?: NamespaceWithLiterals;
4992
4960
  }
4993
- interface RefundItem {
4961
+ declare enum SiteCreatedContext {
4962
+ /** A valid option, we don't expose all reasons why site might be created. */
4963
+ OTHER = "OTHER",
4964
+ /** A meta site was created from template. */
4965
+ FROM_TEMPLATE = "FROM_TEMPLATE",
4966
+ /** A meta site was created by copying of the transfferred meta site. */
4967
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
4968
+ /** A copy of existing meta site. */
4969
+ DUPLICATE = "DUPLICATE",
4970
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
4971
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
4972
+ /** deprecated A meta site was created for Flash editor. */
4973
+ FLASH = "FLASH"
4974
+ }
4975
+ /** @enumType */
4976
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
4977
+ declare enum Namespace {
4978
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
4979
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
4980
+ WIX = "WIX",
4981
+ /** 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. */
4982
+ SHOUT_OUT = "SHOUT_OUT",
4983
+ /** 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. */
4984
+ ALBUMS = "ALBUMS",
4985
+ /** 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. */
4986
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
4987
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4988
+ HOTELS = "HOTELS",
4989
+ /** 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. */
4990
+ CLUBS = "CLUBS",
4991
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4992
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
4993
+ /**
4994
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
4995
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
4996
+ */
4997
+ DEV_SITE = "DEV_SITE",
4998
+ /** 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. */
4999
+ LOGOS = "LOGOS",
5000
+ /** 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. */
5001
+ VIDEO_MAKER = "VIDEO_MAKER",
5002
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5003
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5004
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5005
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
4994
5006
  /**
4995
- * Line item ID the refunded line item.
4996
- * @format GUID
5007
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5008
+ *
5009
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
4997
5010
  */
4998
- lineItemId?: string;
5011
+ HTML_DRAFT = "HTML_DRAFT",
4999
5012
  /**
5000
- * Line item quantity refunded.
5001
- * @min 1
5002
- * @max 100000
5013
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5014
+ * Will be accessible from Site List and will not have a website app.
5015
+ * Once the user attaches a site, the site will become a regular wixsite.
5003
5016
  */
5004
- quantity?: number;
5005
- }
5006
- interface LineItemRefund {
5017
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
5018
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5019
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
5020
+ /** It is to be used in the Business First efforts. */
5021
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
5022
+ /** Bookings business flow with no site. */
5023
+ ANYWHERE = "ANYWHERE",
5024
+ /** Namespace for Headless Backoffice with no editor */
5025
+ HEADLESS = "HEADLESS",
5007
5026
  /**
5008
- * Line item ID.
5009
- * @format GUID
5010
- * @immutable
5027
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5028
+ * The site will be used for account level CSM feature for enterprise
5011
5029
  */
5012
- lineItemId?: string;
5030
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5031
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5032
+ RISE = "RISE",
5013
5033
  /**
5014
- * Refund quantity.
5015
- * @min 1
5016
- * @max 100000
5017
- * @immutable
5034
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5035
+ * There's a blank site behind the scene but it's blank).
5036
+ * The Mobile company will be the owner of this namespace.
5018
5037
  */
5019
- quantity?: number;
5020
- }
5021
- interface AdditionalFeeRefund {
5038
+ BRANDED_FIRST = "BRANDED_FIRST",
5039
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5040
+ NOWNIA = "NOWNIA",
5022
5041
  /**
5023
- * Additional fee ID.
5024
- * @format GUID
5025
- * @immutable
5042
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
5043
+ * The Partners company owns this namespace.
5026
5044
  */
5027
- additionalFeeId?: string;
5045
+ UGC_TEMPLATE = "UGC_TEMPLATE",
5046
+ /** Codux Headless Sites */
5047
+ CODUX = "CODUX",
5048
+ /** Bobb - AI Design Creator. */
5049
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5028
5050
  /**
5029
- * Refund amount.
5030
- * @immutable
5051
+ * Shared Blog Site is a unique single site across Enterprise account,
5052
+ * This site will hold all Blog posts related to the Marketing product.
5031
5053
  */
5032
- amount?: Price;
5033
- }
5034
- interface ShippingRefund {
5054
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5055
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5056
+ STANDALONE_FORMS = "STANDALONE_FORMS",
5057
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5058
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
5059
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5060
+ MIMIR = "MIMIR",
5061
+ /** Wix Twins platform. */
5062
+ TWINS = "TWINS",
5063
+ /** Wix Nano. */
5064
+ NANO = "NANO",
5065
+ /** Base44 headless sites. */
5066
+ BASE44 = "BASE44",
5067
+ /** Wix Channels Sites */
5068
+ CHANNELS = "CHANNELS",
5069
+ /** Nautilus platform. */
5070
+ NAUTILUS = "NAUTILUS",
5035
5071
  /**
5036
- * Refund amount.
5037
- * @immutable
5072
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5073
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5038
5074
  */
5039
- amount?: Price;
5040
- }
5041
- interface RefundSideEffects {
5042
- /** Inventory restock details as part of this refund. */
5043
- restockInfo?: RestockInfo;
5044
- /** Whether to send a refund confirmation email to the customer. */
5045
- sendOrderRefundedEmail?: boolean;
5075
+ SYMPHONY = "SYMPHONY",
5076
+ /** Nautilus platform app. */
5077
+ NAUTILUS_APPS = "NAUTILUS_APPS",
5046
5078
  /**
5047
- * Custom message added to the refund confirmation email.
5048
- * @minLength 1
5049
- * @maxLength 1000
5079
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5080
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5050
5081
  */
5051
- customMessage?: string | null;
5052
- }
5053
- interface RestockInfo {
5054
- /** Restock type. */
5055
- type?: RestockTypeWithLiterals;
5082
+ VIBU = "VIBU",
5056
5083
  /**
5057
- * Deprecated, use items instead
5058
- * @internal
5059
- * @maxSize 300
5060
- * @deprecated
5084
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5085
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
5086
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5087
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
5061
5088
  */
5062
- lineItemIds?: string[];
5089
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5063
5090
  /**
5064
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5065
- * @maxSize 300
5091
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
5092
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5066
5093
  */
5067
- items?: RestockItem[];
5068
- }
5069
- declare enum RestockType {
5070
- NO_ITEMS = "NO_ITEMS",
5071
- ALL_ITEMS = "ALL_ITEMS",
5072
- SOME_ITEMS = "SOME_ITEMS"
5094
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5073
5095
  }
5074
5096
  /** @enumType */
5075
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5076
- interface RestockItem {
5097
+ 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';
5098
+ /** Site transferred to another user. */
5099
+ interface SiteTransferred {
5077
5100
  /**
5078
- * ID of the line item being restocked.
5101
+ * A previous owner id (user that transfers meta site).
5079
5102
  * @format GUID
5080
5103
  */
5081
- lineItemId?: string;
5082
- /**
5083
- * Line item quantity being restocked.
5084
- * @min 1
5085
- * @max 100000
5086
- */
5087
- quantity?: number;
5104
+ oldOwnerId?: string;
5088
5105
  /**
5089
- * Per-location breakdown of restock quantities.
5090
- * @internal
5091
- * @maxSize 5
5106
+ * A new owner id (user that accepts meta site).
5107
+ * @format GUID
5092
5108
  */
5093
- restockLocations?: RestockLocation[];
5109
+ newOwnerId?: string;
5094
5110
  }
5095
- interface TriggerRefundResponse {
5096
- /** All order's transactions after the refunds were added */
5097
- orderTransactions?: OrderTransactions;
5098
- /** Created refund ID */
5099
- refundId?: string | null;
5100
- /** Payment ID's that the refund execution had failed for */
5101
- failedPaymentIds?: ItemMetadata[];
5111
+ /** Soft deletion of the meta site. Could be restored. */
5112
+ interface SiteDeleted {
5113
+ /** A deletion context. */
5114
+ deleteContext?: DeleteContext;
5102
5115
  }
5103
- /**
5104
- * A record of all payments and refunds associated with an order.
5105
- *
5106
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5107
- */
5108
- interface OrderTransactions {
5109
- /**
5110
- * Order ID.
5111
- * @format GUID
5112
- */
5113
- orderId?: string;
5116
+ interface DeleteContext {
5117
+ /** When the meta site was deleted. */
5118
+ dateDeleted?: Date | null;
5119
+ /** A status. */
5120
+ deleteStatus?: DeleteStatusWithLiterals;
5114
5121
  /**
5115
- * Record of payments made to the merchant.
5116
- * @maxSize 100
5122
+ * A reason (flow).
5123
+ * @maxLength 255
5117
5124
  */
5118
- payments?: Payment[];
5125
+ deleteOrigin?: string;
5119
5126
  /**
5120
- * Record of refunds made to the buyer.
5121
- * @maxSize 300
5127
+ * A service that deleted it.
5128
+ * @maxLength 255
5122
5129
  */
5123
- refunds?: Refund[];
5130
+ initiatorId?: string | null;
5124
5131
  }
5125
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5126
- /** Regular payment details. */
5127
- regularPaymentDetails?: RegularPaymentDetails;
5128
- /** Gift card payment details. */
5129
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5130
- /** Membership payment details. */
5131
- membershipPaymentDetails?: MembershipPaymentDetails;
5132
- /**
5133
- * Receipt created by Wix
5134
- * @internal
5135
- */
5136
- wixReceipt?: WixReceiptInfo;
5137
- /**
5138
- * Receipt created by an external system.
5139
- * @internal
5140
- */
5141
- externalReceipt?: ExternalReceiptInfo;
5142
- /** @internal */
5143
- canceled?: CanceledStatusDetails;
5144
- /** @internal */
5145
- declined?: DeclinedStatusDetails;
5146
- /** @internal */
5147
- voided?: VoidedStatusDetails;
5148
- /**
5149
- * Payment ID.
5150
- * @format GUID
5151
- * @readonly
5152
- */
5153
- _id?: string | null;
5154
- /** 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. */
5155
- _createdDate?: Date | null;
5156
- /**
5157
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5158
- * @readonly
5159
- */
5160
- _updatedDate?: Date | null;
5161
- /** Payment amount. */
5162
- amount?: Price;
5163
- /**
5164
- * Whether refunds for this payment are disabled.
5165
- * + `true`: This payment is not refundable.
5166
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5167
- */
5168
- refundDisabled?: boolean;
5169
- /**
5170
- * Whether receipt generation is allowed for this payment.
5171
- * + `true`: This payment supports receipt generation.
5172
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5173
- * @readonly
5174
- */
5175
- supportReceiptGeneration?: boolean;
5176
- /** Details about cash rounding applied to this payment, when relevant. */
5177
- cashRounding?: CashRoundingDetails;
5132
+ declare enum DeleteStatus {
5133
+ UNKNOWN = "UNKNOWN",
5134
+ TRASH = "TRASH",
5135
+ DELETED = "DELETED",
5136
+ PENDING_PURGE = "PENDING_PURGE",
5137
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5138
+ }
5139
+ /** @enumType */
5140
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5141
+ /** Restoration of the meta site. */
5142
+ interface SiteUndeleted {
5143
+ }
5144
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
5145
+ interface SitePublished {
5146
+ }
5147
+ interface SiteUnpublished {
5178
5148
  /**
5179
- * Overall payment status.
5180
- *
5181
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5149
+ * A list of URLs previously associated with the meta site.
5150
+ * @maxLength 4000
5151
+ * @maxSize 10000
5182
5152
  */
5183
- status?: PaymentStatusWithLiterals;
5153
+ urls?: string[];
5154
+ }
5155
+ interface SiteMarkedAsTemplate {
5156
+ }
5157
+ interface SiteMarkedAsWixSite {
5158
+ }
5159
+ /**
5160
+ * Represents a service provisioned a site.
5161
+ *
5162
+ * Note on `origin_instance_id`:
5163
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5164
+ * This is because of the following scenario:
5165
+ *
5166
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
5167
+ * such as a product catalog. When you create a site from this template, you inherit this
5168
+ * default product catalog. However, if the template's product catalog is modified,
5169
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
5170
+ * your site remains consistent with what you initially received and does not include any
5171
+ * changes made to the original template afterward.
5172
+ * To ensure this, the TPA on the template gets a new instance_id.
5173
+ */
5174
+ interface ServiceProvisioned {
5184
5175
  /**
5185
- * Detailed payment status information including gateway reason codes and status-specific details.
5186
- * @internal
5176
+ * Either UUID or EmbeddedServiceType.
5177
+ * @maxLength 36
5187
5178
  */
5188
- paymentStatusDetails?: PaymentStatusDetails;
5179
+ appDefId?: string;
5189
5180
  /**
5190
- * Location where the payment was processed.
5191
- * @internal
5192
- * @format GUID
5193
- * @immutable
5181
+ * Not only UUID. Something here could be something weird.
5182
+ * @maxLength 36
5194
5183
  */
5195
- locationId?: string | null;
5184
+ instanceId?: string;
5196
5185
  /**
5197
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5198
- * @format GUID
5186
+ * An instance id from which this instance is originated.
5187
+ * @maxLength 36
5199
5188
  */
5200
- chargeCorrelationId?: string | null;
5201
- }
5202
- /** @oneof */
5203
- interface PaymentPaymentDetailsOneOf {
5204
- /** Regular payment details. */
5205
- regularPaymentDetails?: RegularPaymentDetails;
5206
- /** Gift card payment details. */
5207
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5208
- /** Membership payment details. */
5209
- membershipPaymentDetails?: MembershipPaymentDetails;
5210
- }
5211
- /** @oneof */
5212
- interface PaymentReceiptInfoOneOf {
5189
+ originInstanceId?: string;
5213
5190
  /**
5214
- * Receipt created by Wix
5215
- * @internal
5191
+ * A version.
5192
+ * @maxLength 500
5216
5193
  */
5217
- wixReceipt?: WixReceiptInfo;
5194
+ version?: string | null;
5218
5195
  /**
5219
- * Receipt created by an external system.
5220
- * @internal
5196
+ * The origin meta site id
5197
+ * @format GUID
5221
5198
  */
5222
- externalReceipt?: ExternalReceiptInfo;
5223
- }
5224
- /** @oneof */
5225
- interface PaymentStatusDetailsOneOf {
5226
- /** @internal */
5227
- canceled?: CanceledStatusDetails;
5228
- /** @internal */
5229
- declined?: DeclinedStatusDetails;
5230
- /** @internal */
5231
- voided?: VoidedStatusDetails;
5199
+ originMetaSiteId?: string | null;
5232
5200
  }
5233
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5234
- /** Credit card details. */
5235
- creditCardDetails?: CreditCardPaymentMethodDetails;
5201
+ interface ServiceRemoved {
5236
5202
  /**
5237
- * Wix Payments order ID.
5238
- * @maxLength 100
5203
+ * Either UUID or EmbeddedServiceType.
5204
+ * @maxLength 36
5239
5205
  */
5240
- paymentOrderId?: string | null;
5206
+ appDefId?: string;
5241
5207
  /**
5242
- * Payment gateway's transaction ID.
5243
- * This field is only returned when the value of `offline_payment` is `false`.
5244
- * @maxLength 100
5208
+ * Not only UUID. Something here could be something weird.
5209
+ * @maxLength 36
5245
5210
  */
5246
- gatewayTransactionId?: string | null;
5211
+ instanceId?: string;
5247
5212
  /**
5248
- * Payment method.
5249
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5250
- * Non-exhaustive list of supported values:
5251
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
5252
- * @maxLength 150
5253
- * @deprecated Payment method.
5254
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5255
- * Non-exhaustive list of supported values:
5256
- * + `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`
5257
- * @replacedBy payment_method_name
5258
- * @targetRemovalDate 2026-07-01
5213
+ * A version.
5214
+ * @maxLength 500
5259
5215
  */
5260
- paymentMethod?: string | null;
5216
+ version?: string | null;
5217
+ }
5218
+ /** Rename of the site. Meaning, free public url has been changed as well. */
5219
+ interface SiteRenamed {
5261
5220
  /**
5262
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5263
- * @maxLength 100
5221
+ * A new meta site name (URL slug).
5222
+ * @maxLength 20
5264
5223
  */
5265
- providerTransactionId?: string | null;
5266
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5267
- offlinePayment?: boolean;
5224
+ newSiteName?: string;
5268
5225
  /**
5269
- * Payment status.
5270
- * @deprecated Payment status.
5271
- * @replacedBy payment.status
5272
- * @targetRemovalDate 2026-11-01
5226
+ * A previous meta site name (URL slug).
5227
+ * @maxLength 255
5273
5228
  */
5274
- status?: TransactionStatusWithLiterals;
5275
- /** Whether there is a payment agreement that allows for future charges. */
5276
- savedPaymentMethod?: boolean;
5277
- /** Authorization details. */
5278
- authorizationDetails?: AuthorizationDetails;
5229
+ oldSiteName?: string;
5230
+ }
5231
+ /**
5232
+ * Hard deletion of the meta site.
5233
+ *
5234
+ * Could not be restored. Therefore it's desirable to cleanup data.
5235
+ */
5236
+ interface SiteHardDeleted {
5237
+ /** A deletion context. */
5238
+ deleteContext?: DeleteContext;
5239
+ }
5240
+ interface NamespaceChanged {
5241
+ /** A previous namespace. */
5242
+ oldNamespace?: NamespaceWithLiterals;
5243
+ /** A new namespace. */
5244
+ newNamespace?: NamespaceWithLiterals;
5245
+ }
5246
+ /** Assigned Studio editor */
5247
+ interface StudioAssigned {
5248
+ }
5249
+ /** Unassigned Studio editor */
5250
+ interface StudioUnassigned {
5251
+ }
5252
+ /**
5253
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5254
+ *
5255
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5256
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
5257
+ *
5258
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5259
+ */
5260
+ interface SiteUrlChanged {
5261
+ }
5262
+ /**
5263
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5264
+ * Consumed by other teams to remove relevant data.
5265
+ */
5266
+ interface SitePurgedExternally {
5279
5267
  /**
5280
- * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
5281
- * @internal
5282
- * @maxLength 300
5268
+ * @maxLength 2048
5269
+ * @maxSize 100
5270
+ * @deprecated
5271
+ * @targetRemovalDate 2025-04-15
5283
5272
  */
5284
- paymentProvider?: string | null;
5273
+ appDefId?: string[];
5274
+ }
5275
+ /** Assigned Odeditor */
5276
+ interface OdeditorAssigned {
5277
+ }
5278
+ /** Unassigned Odeditor */
5279
+ interface OdeditorUnassigned {
5280
+ }
5281
+ /** Assigned Picasso editor */
5282
+ interface PicassoAssigned {
5283
+ }
5284
+ /** Unassigned Picasso */
5285
+ interface PicassoUnassigned {
5286
+ }
5287
+ /** Assigned Wixel */
5288
+ interface WixelAssigned {
5289
+ }
5290
+ /** Unassigned Wixel */
5291
+ interface WixelUnassigned {
5292
+ }
5293
+ /** Assigned StudioTwo */
5294
+ interface StudioTwoAssigned {
5295
+ }
5296
+ /** Unassigned StudioTwo */
5297
+ interface StudioTwoUnassigned {
5298
+ }
5299
+ /** Media from user domain is enabled. */
5300
+ interface UserDomainMediaEnabled {
5301
+ }
5302
+ /** Media from user domain is disabled. */
5303
+ interface UserDomainMediaDisabled {
5304
+ }
5305
+ /** Assigned Editorless */
5306
+ interface EditorlessAssigned {
5307
+ }
5308
+ /** Unassigned Editorless */
5309
+ interface EditorlessUnassigned {
5310
+ }
5311
+ interface HasCustomEmailConfigurationsRequest {
5312
+ }
5313
+ interface HasCustomEmailConfigurationsResponse {
5314
+ hasCustomConfigurations?: boolean;
5315
+ }
5316
+ interface AddToAutomationMigrationPopulationRequest {
5317
+ /** When true, sends custom email configurations to automation system via email */
5318
+ sendCustomEmailConfigs?: boolean;
5319
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5320
+ origin?: OriginWithLiterals;
5321
+ }
5322
+ declare enum Origin {
5323
+ OPT_IN = "OPT_IN",
5324
+ MIGRATION = "MIGRATION"
5325
+ }
5326
+ /** @enumType */
5327
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5328
+ interface AddToAutomationMigrationPopulationResponse {
5329
+ success?: boolean;
5330
+ }
5331
+ interface IsInAutomationMigrationPopulationRequest {
5332
+ }
5333
+ interface IsInAutomationMigrationPopulationResponse {
5334
+ inPopulation?: boolean;
5335
+ }
5336
+ interface PreparePaymentCollectionRequest {
5285
5337
  /**
5286
- * Record of chargebacks made by the buyer.
5287
- * @maxSize 6
5338
+ * Ecom order ID.
5339
+ * @minLength 1
5340
+ * @maxLength 100
5288
5341
  */
5289
- chargebacks?: Chargeback[];
5342
+ ecomOrderId: string;
5343
+ /** Amount to collect */
5344
+ amount: Price;
5290
5345
  /**
5291
- * Payment method ID.
5292
- * @internal
5293
- * @maxLength 36
5346
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
5347
+ * Existing payment gateway order will be updated with a new amount.
5348
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
5294
5349
  */
5295
- paymentMethodId?: string | null;
5296
- /** Platform fee amount associated with this payment. */
5297
- platformFee?: Price;
5350
+ paymentGatewayOrderId?: string | null;
5298
5351
  /**
5299
- * Payment method with buyer and optional owner translations.
5300
- * Non-exhaustive list of supported values:
5301
- * + `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`
5352
+ * Whether to delay capture of the payment.
5353
+ * Default: false
5354
+ * @deprecated Whether to delay capture of the payment.
5355
+ * Default: false
5356
+ * @replacedBy delayed_capture_settings.scheduled_action
5357
+ * @targetRemovalDate 2024-09-30
5302
5358
  */
5303
- paymentMethodName?: PaymentMethodName;
5304
- }
5305
- /** @oneof */
5306
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5307
- /** Credit card details. */
5308
- creditCardDetails?: CreditCardPaymentMethodDetails;
5309
- }
5310
- declare enum TransactionStatus {
5311
- UNDEFINED = "UNDEFINED",
5312
- APPROVED = "APPROVED",
5313
- PENDING = "PENDING",
5314
- PENDING_MERCHANT = "PENDING_MERCHANT",
5315
- CANCELED = "CANCELED",
5316
- DECLINED = "DECLINED",
5317
- REFUNDED = "REFUNDED",
5318
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5319
- AUTHORIZED = "AUTHORIZED",
5320
- VOIDED = "VOIDED"
5321
- }
5322
- /** @enumType */
5323
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5324
- interface CreditCardPaymentMethodDetails {
5359
+ delayedCapture?: boolean;
5325
5360
  /**
5326
- * The last 4 digits of the card number.
5327
- * @maxLength 4
5361
+ * Specifies whether payment collection is initiated by Merchant or User of User
5362
+ * Default: `true`
5363
+ * @internal
5328
5364
  */
5329
- lastFourDigits?: string | null;
5365
+ merchantInitiated?: boolean | null;
5330
5366
  /**
5331
- * Card issuer's brand.
5332
- * @maxLength 100
5367
+ * Redirect urls which are used to return buyer to third party system.
5368
+ * @internal
5333
5369
  */
5334
- brand?: string | null;
5370
+ redirectUrls?: RedirectUrls;
5371
+ /** Delayed capture payment settings */
5372
+ delayedCaptureSettings?: DelayedCaptureSettings;
5335
5373
  }
5336
- interface AuthorizationDetails {
5374
+ interface RedirectUrls {
5337
5375
  /**
5338
- * Whether the authorized payment is of a delayed capture.
5339
- * @readonly
5376
+ * URL to redirect buyer in case of approved (successful) transaction
5377
+ * @format WEB_URL
5340
5378
  */
5341
- delayedCapture?: boolean;
5342
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5343
- authorizedDate?: Date | null;
5379
+ successUrl?: string | null;
5344
5380
  /**
5345
- * List of captures associated with payment
5346
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5347
- * @maxSize 1
5381
+ * URL to redirect buyer in case of buyer canceled the transaction
5382
+ * @format WEB_URL
5348
5383
  */
5349
- captures?: AuthorizationCapture[];
5350
- /** Void associated with payment */
5351
- void?: AuthorizationVoid;
5352
- /** Scheduled action for this transaction */
5353
- scheduledAction?: V1ScheduledAction;
5354
- }
5355
- interface AuthorizationCapture {
5384
+ cancelUrl?: string | null;
5356
5385
  /**
5357
- * Capture ID.
5358
- * @format GUID
5359
- * @readonly
5386
+ * URL to redirect buyer in case of failed/rejected transaction
5387
+ * @format WEB_URL
5360
5388
  */
5361
- _id?: string | null;
5362
- /** Status of this capture action */
5363
- status?: AuthorizationCaptureStatusWithLiterals;
5389
+ errorUrl?: string | null;
5364
5390
  /**
5365
- * Amount of this capture
5366
- * @immutable
5391
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
5392
+ * @format WEB_URL
5367
5393
  */
5368
- amount?: Price;
5369
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5370
- _createdDate?: Date | null;
5371
- /** In case of status is FAILED may contain failure details */
5372
- failureDetails?: AuthorizationActionFailureDetails;
5373
- }
5374
- declare enum AuthorizationCaptureStatus {
5375
- /** Capture operation still in progress. */
5376
- PENDING = "PENDING",
5377
- /** Capture operation succeeded. */
5378
- SUCCEEDED = "SUCCEEDED",
5379
- /** Capture operation failed. */
5380
- FAILED = "FAILED"
5381
- }
5382
- /** @enumType */
5383
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5384
- interface AuthorizationActionFailureDetails {
5385
- /** @maxLength 100 */
5386
- failureCode?: string;
5387
- }
5388
- interface AuthorizationVoid {
5389
- /** Status of this void action */
5390
- status?: AuthorizationVoidStatusWithLiterals;
5391
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5392
- voidedDate?: Date | null;
5393
- /** In case of status is FAILED may contain failure details */
5394
- failureDetails?: AuthorizationActionFailureDetails;
5395
- /** Reason of void action */
5396
- reason?: ReasonWithLiterals;
5397
- }
5398
- declare enum AuthorizationVoidStatus {
5399
- /** Void operation still in progress. */
5400
- PENDING = "PENDING",
5401
- /** Void operation succeeded. */
5402
- SUCCEEDED = "SUCCEEDED",
5403
- /** Void operation failed. */
5404
- FAILED = "FAILED"
5405
- }
5406
- /** @enumType */
5407
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5408
- /** Reason the authorization was voided. */
5409
- declare enum Reason {
5410
- /** Authorization was voided by user. */
5411
- MANUAL = "MANUAL",
5412
- /** Authorization passed execution date. */
5413
- SCHEDULED = "SCHEDULED"
5394
+ pendingUrl?: string | null;
5414
5395
  }
5415
- /** @enumType */
5416
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5417
- interface V1ScheduledAction {
5418
- /** Type of the action. */
5419
- actionType?: ActionTypeWithLiterals;
5420
- /** The date and time of the action. */
5421
- executionDate?: Date | null;
5396
+ interface DelayedCaptureSettings {
5397
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5398
+ scheduledAction?: ScheduledActionWithLiterals;
5399
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
5400
+ delayDuration?: Duration;
5422
5401
  }
5423
- declare enum ActionType {
5402
+ declare enum ScheduledAction {
5403
+ /** Whether payment will be auto-voided when duration passes */
5424
5404
  VOID = "VOID",
5405
+ /** Whether payment will be auto-captured when duration passes */
5425
5406
  CAPTURE = "CAPTURE"
5426
5407
  }
5427
5408
  /** @enumType */
5428
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5429
- interface Chargeback {
5430
- /**
5431
- * Chargeback ID.
5432
- * @format GUID
5433
- * @readonly
5434
- * @immutable
5435
- */
5436
- _id?: string;
5437
- /**
5438
- * 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.
5439
- * @readonly
5440
- * @immutable
5441
- */
5442
- _createdDate?: Date | null;
5409
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5410
+ interface Duration {
5443
5411
  /**
5444
- * 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.
5445
- * @readonly
5412
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5413
+ * @min 1
5446
5414
  */
5447
- _updatedDate?: Date | null;
5415
+ count?: number;
5416
+ /** Duration unit: MINUTES, HOURS and DAYS */
5417
+ unit?: DurationUnitWithLiterals;
5418
+ }
5419
+ declare enum DurationUnit {
5420
+ MINUTES = "MINUTES",
5421
+ HOURS = "HOURS",
5422
+ DAYS = "DAYS"
5423
+ }
5424
+ /** @enumType */
5425
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5426
+ interface PreparePaymentCollectionResponse {
5427
+ /** Payment gateway order id which is associated with given payment */
5428
+ paymentGatewayOrderId?: string;
5429
+ }
5430
+ interface GetPaymentCollectabilityStatusRequest {
5448
5431
  /**
5449
- * Amount.
5450
- * @readonly
5451
- * @immutable
5432
+ * Ecom order ID.
5433
+ * @minLength 1
5434
+ * @maxLength 100
5452
5435
  */
5436
+ ecomOrderId: string;
5437
+ }
5438
+ interface GetPaymentCollectabilityStatusResponse {
5439
+ /** Payment collectability status */
5440
+ status?: PaymentCollectabilityStatusWithLiterals;
5441
+ /** Collectable order amount */
5453
5442
  amount?: Price;
5454
5443
  /**
5455
- * Reversal amount. Present only when status is REVERSED.
5456
- * @readonly
5457
- */
5458
- reversalAmount?: Price;
5459
- /**
5460
- * Status.
5461
- *
5462
- * Default: `"APPROVED"`.
5444
+ * Whether authorization supported
5445
+ * @internal
5463
5446
  */
5464
- status?: ChargebackStatusWithLiterals;
5447
+ authorizationSupported?: boolean;
5465
5448
  /**
5466
- * External chargeback ID.
5467
- * @format GUID
5468
- * @readonly
5469
- * @immutable
5449
+ * Whether custom amount is supported for payment collection
5450
+ * @internal
5470
5451
  */
5471
- externalId?: string | null;
5452
+ customAmountSupported?: boolean;
5472
5453
  }
5473
- declare enum ChargebackStatus {
5474
- /** Chargeback was approved. */
5475
- APPROVED = "APPROVED",
5476
- /** Chargeback was reversed. */
5477
- REVERSED = "REVERSED"
5454
+ declare enum PaymentCollectabilityStatus {
5455
+ UNKNOWN = "UNKNOWN",
5456
+ COLLECTABLE = "COLLECTABLE",
5457
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5458
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5459
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5460
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5461
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5462
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5463
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5464
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5465
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5466
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5467
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5478
5468
  }
5479
5469
  /** @enumType */
5480
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5481
- interface PaymentMethodName {
5470
+ type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
5471
+ interface RecordManuallyCollectedPaymentRequest {
5472
+ /**
5473
+ * Order ID.
5474
+ * @minLength 1
5475
+ * @maxLength 100
5476
+ */
5477
+ orderId: string;
5478
+ /** Amount to be recorded as approved manual payment for given order */
5479
+ amount: Price;
5482
5480
  /**
5483
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5484
- * @maxLength 150
5481
+ * Payment method name provided by user.
5482
+ *
5483
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5484
+ * @internal
5485
5485
  */
5486
- buyerLanguageName?: string | null;
5486
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5487
+ }
5488
+ /**
5489
+ * User-defined payment method name.
5490
+ * Allows specifying either a predefined type or a custom name.
5491
+ */
5492
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5493
+ /** Predefined payment method. */
5494
+ predefined?: PredefinedPaymentMethodWithLiterals;
5487
5495
  /**
5488
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5496
+ * Custom payment method name provided by user.
5489
5497
  *
5490
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5498
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5499
+ * @minLength 1
5491
5500
  * @maxLength 150
5492
5501
  */
5493
- siteLanguageName?: string | null;
5502
+ custom?: string | null;
5503
+ }
5504
+ /** @oneof */
5505
+ interface UserDefinedPaymentMethodNameKindOneOf {
5506
+ /** Predefined payment method. */
5507
+ predefined?: PredefinedPaymentMethodWithLiterals;
5494
5508
  /**
5495
- * User-provided payment method name.
5509
+ * Custom payment method name provided by user.
5496
5510
  *
5497
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5511
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5512
+ * @minLength 1
5513
+ * @maxLength 150
5498
5514
  */
5499
- userDefinedName?: UserDefinedPaymentMethodName;
5515
+ custom?: string | null;
5500
5516
  }
5501
- interface GiftCardPaymentDetails {
5517
+ /** Predefined payment method types for offline/manual payments. */
5518
+ declare enum PredefinedPaymentMethod {
5519
+ /** Cash payment. */
5520
+ CASH = "CASH",
5521
+ /** Bank transfer. */
5522
+ BANK_TRANSFER = "BANK_TRANSFER",
5523
+ /** Payment by check. */
5524
+ CHECK = "CHECK"
5525
+ }
5526
+ /** @enumType */
5527
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5528
+ interface RecordManuallyCollectedPaymentResponse {
5529
+ }
5530
+ interface MarkOrderAsPaidRequest {
5502
5531
  /**
5503
- * Gift card payment ID.
5532
+ * Ecom order ID.
5533
+ * @minLength 1
5504
5534
  * @maxLength 100
5505
5535
  */
5506
- giftCardPaymentId?: string;
5536
+ ecomOrderId: string;
5507
5537
  /**
5508
- * Gift card ID.
5538
+ * Payment method name provided by user.
5539
+ *
5540
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5509
5541
  * @internal
5510
- * @deprecated
5511
- */
5512
- giftCardId?: string;
5513
- /**
5514
- * ID of the app that created the gift card.
5515
- * @format GUID
5516
- */
5517
- appId?: string;
5518
- /**
5519
- * Whether the gift card is voided.
5520
- * @readonly
5521
- * @deprecated Whether the gift card is voided.
5522
- * @replacedBy payment.status
5523
- * @targetRemovalDate 2026-11-01
5524
- */
5525
- voided?: boolean;
5526
- /**
5527
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5528
- * @maxLength 30
5529
- * @immutable
5530
5542
  */
5531
- obfuscatedCode?: string | null;
5543
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5532
5544
  }
5533
- interface MembershipPaymentDetails {
5534
- /**
5535
- * Membership ID.
5536
- * @maxLength 200
5537
- */
5538
- membershipId?: string;
5545
+ interface MarkOrderAsPaidResponse {
5546
+ /** Updated order. */
5547
+ order?: Order;
5548
+ }
5549
+ interface BulkMarkOrdersAsPaidRequest {
5539
5550
  /**
5540
- * ID of the line item this membership applies to.
5551
+ * IDs of orders to mark as paid.
5552
+ * @minSize 1
5553
+ * @maxSize 100
5541
5554
  * @minLength 1
5542
5555
  * @maxLength 100
5543
5556
  */
5544
- lineItemId?: string;
5557
+ ecomOrderIds: string[];
5558
+ }
5559
+ interface BulkMarkOrdersAsPaidResponse {
5545
5560
  /**
5546
- * Payment status.
5547
- * @deprecated Payment status.
5548
- * @replacedBy payment.status
5549
- * @targetRemovalDate 2026-11-01
5561
+ * Items updated by the bulk action.
5562
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5550
5563
  */
5551
- status?: MembershipPaymentStatusWithLiterals;
5552
- /** Membership name. */
5553
- name?: MembershipName;
5564
+ results?: BulkOrderResult[];
5565
+ /** Bulk action metadata. */
5566
+ bulkActionMetadata?: BulkActionMetadata;
5567
+ }
5568
+ interface BulkOrderResult {
5569
+ /** Item metadata. */
5570
+ itemMetadata?: ItemMetadata;
5554
5571
  /**
5555
- * The transaction ID in the membership system. Can be used to void the transaction.
5572
+ * Updated order.
5573
+ *
5574
+ * Returned when `returnFullEntity = true`.
5575
+ */
5576
+ item?: Order;
5577
+ }
5578
+ interface ItemMetadata {
5579
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5580
+ _id?: string | null;
5581
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
5582
+ originalIndex?: number;
5583
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5584
+ success?: boolean;
5585
+ /** Details about the error in case of failure. */
5586
+ error?: ApplicationError;
5587
+ }
5588
+ interface ApplicationError {
5589
+ /** Error code. */
5590
+ code?: string;
5591
+ /** Description of the error. */
5592
+ description?: string;
5593
+ /** Data related to the error. */
5594
+ data?: Record<string, any> | null;
5595
+ }
5596
+ interface BulkActionMetadata {
5597
+ /** Number of items that were successfully processed. */
5598
+ totalSuccesses?: number;
5599
+ /** Number of items that couldn't be processed. */
5600
+ totalFailures?: number;
5601
+ /** Number of failures without details because detailed failure threshold was exceeded. */
5602
+ undetailedFailures?: number;
5603
+ }
5604
+ interface GetRefundabilityStatusRequest {
5605
+ /**
5606
+ * Order ID.
5556
5607
  * @minLength 1
5557
5608
  * @maxLength 100
5558
5609
  */
5559
- externalTransactionId?: string | null;
5610
+ ecomOrderId: string;
5611
+ }
5612
+ interface GetRefundabilityStatusResponse {
5560
5613
  /**
5561
- * Whether the membership is voided.
5562
- * @readonly
5563
- * @deprecated Whether the membership is voided.
5564
- * @replacedBy payment.status
5565
- * @targetRemovalDate 2026-11-01
5614
+ * Refundability details.
5615
+ * @maxSize 300
5566
5616
  */
5567
- voided?: boolean;
5617
+ refundabilities?: Refundability[];
5568
5618
  /**
5569
- * ID of the application providing this payment option.
5570
- * @format GUID
5619
+ * Whether the order supports refunding per item.
5620
+ * @deprecated
5571
5621
  */
5572
- providerAppId?: string;
5573
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5574
- futureMembership?: FutureMembershipDetails;
5622
+ refundablePerItem?: boolean;
5575
5623
  }
5576
- declare enum MembershipPaymentStatus {
5577
- /** Payment was charged. */
5578
- CHARGED = "CHARGED",
5579
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5580
- CHARGE_FAILED = "CHARGE_FAILED",
5581
- /** Payment is pending. */
5582
- CHARGE_PENDING = "CHARGE_PENDING",
5583
- /** Payment was voided. */
5584
- VOIDED = "VOIDED"
5624
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5625
+ /** Reason why payment is not refundable. */
5626
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5627
+ /** Reason why payment is only refundable manually. */
5628
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5629
+ /** Payment ID. */
5630
+ paymentId?: string;
5631
+ /** Payment refundability status. */
5632
+ refundabilityStatus?: RefundableStatusWithLiterals;
5633
+ /** Link to payment provider dashboard. */
5634
+ providerLink?: string | null;
5635
+ }
5636
+ /** @oneof */
5637
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
5638
+ /** Reason why payment is not refundable. */
5639
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5640
+ /** Reason why payment is only refundable manually. */
5641
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5642
+ }
5643
+ declare enum RefundableStatus {
5644
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5645
+ MANUAL = "MANUAL",
5646
+ REFUNDABLE = "REFUNDABLE"
5585
5647
  }
5586
5648
  /** @enumType */
5587
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5588
- interface FutureMembershipDetails {
5589
- /**
5590
- * ID of the plan line item in the order from which the membership will be created.
5591
- * @format GUID
5592
- */
5593
- lineItemId?: string;
5594
- /**
5595
- * ID of the benefit the future membership will grant.
5596
- * @maxLength 200
5597
- */
5598
- benefitId?: string;
5649
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5650
+ declare enum NonRefundableReason {
5651
+ NONE = "NONE",
5652
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
5653
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5654
+ INTERNAL_ERROR = "INTERNAL_ERROR",
5655
+ NOT_PAID = "NOT_PAID",
5656
+ ACCESS_DENIED = "ACCESS_DENIED",
5657
+ ZERO_PRICE = "ZERO_PRICE",
5658
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5659
+ PENDING_REFUND = "PENDING_REFUND",
5660
+ FORBIDDEN = "FORBIDDEN",
5661
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5662
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
5663
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5599
5664
  }
5600
- interface WixReceiptInfo {
5601
- /**
5602
- * Receipt ID
5603
- * @format GUID
5604
- */
5605
- receiptId?: string;
5665
+ /** @enumType */
5666
+ 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';
5667
+ declare enum ManuallyRefundableReason {
5668
+ EXPIRED = "EXPIRED",
5669
+ NOT_SUPPORTED = "NOT_SUPPORTED",
5670
+ OFFLINE = "OFFLINE",
5671
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5672
+ }
5673
+ /** @enumType */
5674
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5675
+ interface CreatePaymentGatewayOrderRequest {
5606
5676
  /**
5607
- * Display number of receipt
5677
+ * Ecom order ID.
5608
5678
  * @minLength 1
5609
- * @maxLength 40
5679
+ * @maxLength 100
5610
5680
  */
5611
- displayNumber?: string | null;
5612
- }
5613
- interface ExternalReceiptInfo {
5681
+ ecomOrderId: string;
5682
+ /** Information about the user who initiated the payment. */
5683
+ chargedBy?: ChargedBy;
5614
5684
  /**
5615
- * External receipt ID
5616
- * @maxLength 100
5685
+ * Whether to delay capture of the payment.
5686
+ *
5687
+ * Default: false
5688
+ * @internal
5617
5689
  */
5618
- receiptId?: string | null;
5690
+ delayedCapture?: boolean;
5691
+ }
5692
+ interface ChargedBy {
5619
5693
  /**
5620
- * ID of the app providing the receipt
5694
+ * ID - id of the user who initiated the payment
5621
5695
  * @format GUID
5622
5696
  */
5623
- appId?: string | null;
5697
+ _id?: string;
5624
5698
  /**
5625
- * Display number of receipt
5699
+ * Full name - name of the user who initiated the payment
5626
5700
  * @minLength 1
5627
- * @maxLength 40
5701
+ * @maxLength 200
5628
5702
  */
5629
- displayNumber?: string | null;
5703
+ fullName?: string | null;
5630
5704
  }
5631
- interface CashRoundingDetails {
5705
+ interface CreatePaymentGatewayOrderResponse {
5706
+ /** ID of the order created in the payment gateway */
5707
+ paymentGatewayOrderId?: string;
5708
+ }
5709
+ interface ChargeMembershipsRequest {
5632
5710
  /**
5633
- * Payment amount before cash rounding was applied.
5634
- * When provided, balance and status calculations use this value instead of `amount`
5635
- * to prevent false overpayment or underpayment due to rounding.
5711
+ * Order ID.
5712
+ * @minLength 1
5713
+ * @maxLength 100
5636
5714
  */
5637
- unroundedAmount?: Price;
5715
+ ecomOrderId: string;
5638
5716
  /**
5639
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5640
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5641
- * @readonly
5717
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5718
+ * but a user which is using the membership on behalf of the a member
5719
+ * @format GUID
5642
5720
  */
5643
- roundingAdjustment?: CashRounding;
5644
- }
5645
- declare enum PaymentStatus {
5646
- /** Payment was charged successfully. */
5647
- APPROVED = "APPROVED",
5648
- /** Payment is being processed and hasn't been confirmed yet. */
5649
- PENDING = "PENDING",
5650
- /** 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. */
5651
- PENDING_MERCHANT = "PENDING_MERCHANT",
5652
- /** Payment was canceled before it was charged. */
5653
- CANCELED = "CANCELED",
5654
- /** Payment was declined by the payment provider. */
5655
- DECLINED = "DECLINED",
5656
- /** Payment was fully refunded. */
5657
- REFUNDED = "REFUNDED",
5658
- /** Part of the payment amount was refunded. */
5659
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5660
- /** 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. */
5661
- AUTHORIZED = "AUTHORIZED",
5721
+ memberId: string;
5662
5722
  /**
5663
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5664
- *
5665
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5723
+ * List of items to be paid by memberships
5724
+ * @minSize 1
5725
+ * @maxSize 300
5666
5726
  */
5667
- VOIDED = "VOIDED"
5668
- }
5669
- /** @enumType */
5670
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5671
- interface CanceledStatusDetails {
5672
- reason?: CanceledReasonWithLiterals;
5673
- }
5674
- declare enum CanceledReason {
5675
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5676
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5677
- /** Payment was not completed by user and expired. */
5678
- EXPIRED = "EXPIRED"
5679
- }
5680
- /** @enumType */
5681
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5682
- interface DeclinedStatusDetails {
5683
- reason?: DeclinedReasonWithLiterals;
5684
- }
5685
- declare enum DeclinedReason {
5686
- /** Corresponding charge failed. */
5687
- CHARGE_FAILED = "CHARGE_FAILED",
5688
- /** Payment details expired. */
5689
- EXPIRED = "EXPIRED",
5690
- /** Insufficient funds. */
5691
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5692
- /** Gift card was disabled before charge was attempted. */
5693
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5694
- }
5695
- /** @enumType */
5696
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5697
- interface VoidedStatusDetails {
5698
- reason?: VoidedReasonWithLiterals;
5699
- }
5700
- declare enum VoidedReason {
5701
- /** Payment was voided by merchant request. */
5702
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
5703
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5704
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5727
+ membershipCharges?: MembershipChargeItem[];
5705
5728
  }
5706
- /** @enumType */
5707
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5708
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5709
- /** @internal */
5710
- canceled?: CanceledStatusDetails;
5711
- /** @internal */
5712
- declined?: DeclinedStatusDetails;
5713
- /** @internal */
5714
- voided?: VoidedStatusDetails;
5729
+ interface MembershipChargeItem {
5715
5730
  /**
5716
- * Reason code from the payment gateway.
5717
- * @internal
5731
+ * The id of used membership
5718
5732
  * @minLength 1
5719
- * @maxLength 10
5733
+ * @maxLength 100
5720
5734
  */
5721
- paymentGatewayReasonCode?: string | null;
5722
- }
5723
- /** @oneof */
5724
- interface PaymentStatusDetailsStatusDetailsOneOf {
5725
- /** @internal */
5726
- canceled?: CanceledStatusDetails;
5727
- /** @internal */
5728
- declined?: DeclinedStatusDetails;
5729
- /** @internal */
5730
- voided?: VoidedStatusDetails;
5731
- }
5732
- interface Refund {
5735
+ membershipId?: string;
5733
5736
  /**
5734
- * Refund ID.
5737
+ * ID of the application providing this payment option
5735
5738
  * @format GUID
5736
- * @readonly
5737
- */
5738
- _id?: string;
5739
- /**
5740
- * List of transactions.
5741
- * @maxSize 50
5742
- */
5743
- transactions?: RefundTransaction[];
5744
- /** Refund business details. */
5745
- details?: RefundDetails;
5746
- /**
5747
- * 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.
5748
- * @readonly
5749
- * @immutable
5750
5739
  */
5751
- _createdDate?: Date | null;
5740
+ appId?: string;
5741
+ /** The name of used membership */
5742
+ membershipName?: MembershipName;
5743
+ /** Additional data about this membership */
5744
+ membershipAdditionalData?: Record<string, any> | null;
5745
+ /** Catalog and item reference info. */
5746
+ catalogReference?: CatalogReference;
5747
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
5748
+ serviceProperties?: ServiceProperties;
5752
5749
  /**
5753
- * Aggregated refund summary.
5754
- * @readonly
5750
+ * Usually would be the same as catalogReference.catalogItemId
5751
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
5752
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5753
+ * @minLength 1
5754
+ * @maxLength 36
5755
5755
  */
5756
- summary?: AggregatedRefundSummary;
5756
+ rootCatalogItemId?: string | null;
5757
5757
  /**
5758
- * ID of the app that initiated this refund.
5759
- * @format GUID
5760
- * @readonly
5761
- * @immutable
5758
+ * line item id of Checkout/Order line item
5759
+ * @minLength 1
5760
+ * @maxLength 100
5762
5761
  */
5763
- requestingServiceAppId?: string | null;
5762
+ lineItemId?: string;
5764
5763
  }
5765
- interface RefundTransaction {
5764
+ interface MembershipName {
5766
5765
  /**
5767
- * ID of the payment associated with this refund.
5768
- * @format GUID
5769
- * @immutable
5766
+ * Membership name in the site's original language.
5767
+ * @maxLength 100
5770
5768
  */
5771
- paymentId?: string;
5769
+ original?: string;
5772
5770
  /**
5773
- * Refund amount.
5774
- * @immutable
5771
+ * Membership name translated into the buyer's language.
5772
+ *
5773
+ * Default: The value of `original`
5774
+ * @maxLength 100
5775
5775
  */
5776
- amount?: Price;
5777
- /** Refund status. */
5778
- refundStatus?: RefundStatusWithLiterals;
5779
- /** Optional details of current refund status. */
5780
- refundStatusInfo?: RefundStatusInfo;
5776
+ translated?: string | null;
5777
+ }
5778
+ interface ChargeMembershipsResponse {
5779
+ }
5780
+ interface TriggerRefundRequest {
5781
5781
  /**
5782
- * Payment gateway's refund ID.
5783
- * This field is only returned when the value of `external_refund` is `false`.
5784
- * @format GUID
5782
+ * The order this refund related to
5783
+ * @minLength 1
5784
+ * @maxLength 100
5785
5785
  */
5786
- gatewayRefundId?: string | null;
5787
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5788
- providerRefundId?: string | null;
5786
+ ecomOrderId: string;
5789
5787
  /**
5790
- * Whether refund was made externally and manually on the payment provider's side.
5791
- * @immutable
5788
+ * Refund operations information
5789
+ * @minSize 1
5790
+ * @maxSize 1
5792
5791
  */
5793
- externalRefund?: boolean;
5792
+ payments: PaymentRefund[];
5793
+ /** Business model of a refund */
5794
+ details?: RefundDetails;
5795
+ /** Side effect details related to refund */
5796
+ sideEffects?: RefundSideEffects;
5797
+ }
5798
+ interface PaymentRefund {
5794
5799
  /**
5795
- * Location where the refund was processed.
5796
- * @internal
5800
+ * Specific payment within the order to refund
5797
5801
  * @format GUID
5798
- * @immutable
5799
- */
5800
- locationId?: string | null;
5801
- }
5802
- /** Refund transaction status. */
5803
- declare enum RefundStatus {
5804
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5805
- PENDING = "PENDING",
5806
- /** Refund transaction succeeded. */
5807
- SUCCEEDED = "SUCCEEDED",
5808
- /** Refund transaction failed. */
5809
- FAILED = "FAILED",
5810
- /** Refund request acknowledged, and will be executed soon. */
5811
- SCHEDULED = "SCHEDULED",
5812
- /** Refund was initiated on payment provider side. */
5813
- STARTED = "STARTED"
5814
- }
5815
- /** @enumType */
5816
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5817
- interface RefundStatusInfo {
5802
+ */
5803
+ paymentId?: string;
5804
+ /** Refund amount. Not relevant for membership and gift card refunds. */
5805
+ amount?: Price;
5818
5806
  /**
5819
- * Reason code for the refund's current status.
5820
- *
5821
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5807
+ * Whether refund is made externally and manually (on the payment provider's side)
5808
+ * 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.
5809
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5810
+ */
5811
+ externalRefund?: boolean;
5812
+ /**
5813
+ * Gateway refund id. When param is present, new refund is not created.
5814
+ * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5815
+ * and all side effects from request will be executed.
5816
+ * @internal
5822
5817
  * @minLength 1
5823
- * @maxLength 10
5818
+ * @maxLength 100
5824
5819
  */
5825
- paymentGatewayReasonCode?: string | null;
5820
+ gatewayRefundId?: string | null;
5821
+ }
5822
+ interface RefundSideEffects {
5823
+ /** Inventory restock details as part of this refund. */
5824
+ restockInfo?: RestockInfo;
5825
+ /** Whether to send a refund confirmation email to the customer. */
5826
+ sendOrderRefundedEmail?: boolean;
5826
5827
  /**
5827
- * Free text explanation of current refund status.
5828
+ * Custom message added to the refund confirmation email.
5828
5829
  * @minLength 1
5829
5830
  * @maxLength 1000
5830
5831
  */
5831
- description?: string | null;
5832
- }
5833
- interface AggregatedRefundSummary {
5834
- /** Total amount requested for refund. */
5835
- requestedRefund?: Price;
5836
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5837
- pendingRefund?: Price;
5838
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5839
- refunded?: Price;
5840
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
5841
- failedRefundAmount?: Price;
5842
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
5843
- pending?: boolean;
5844
- /** Breakdown of refunded items. Available only after refund is complete. */
5845
- breakdown?: RefundItemsBreakdown;
5832
+ customMessage?: string | null;
5846
5833
  }
5847
- interface RefundItemsBreakdown {
5834
+ interface RestockInfo {
5835
+ /** Restock type. */
5836
+ type?: RestockTypeWithLiterals;
5848
5837
  /**
5849
- * Refunded line items and the amount refunded for each.
5838
+ * Deprecated, use items instead
5839
+ * @internal
5850
5840
  * @maxSize 300
5841
+ * @deprecated
5851
5842
  */
5852
- lineItems?: LineItemRefundSummary[];
5843
+ lineItemIds?: string[];
5844
+ /**
5845
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5846
+ * @maxSize 300
5847
+ */
5848
+ items?: RestockItem[];
5853
5849
  }
5854
- interface LineItemRefundSummary {
5850
+ declare enum RestockType {
5851
+ NO_ITEMS = "NO_ITEMS",
5852
+ ALL_ITEMS = "ALL_ITEMS",
5853
+ SOME_ITEMS = "SOME_ITEMS"
5854
+ }
5855
+ /** @enumType */
5856
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5857
+ interface RestockItem {
5855
5858
  /**
5856
- * ID of the refunded line item.
5859
+ * ID of the line item being restocked.
5857
5860
  * @format GUID
5858
5861
  */
5859
5862
  lineItemId?: string;
5860
- /** Total refunded amount for the line item. */
5861
- totalRefundedAmount?: Price;
5862
- }
5863
- interface CalculateRefundRequest {
5864
5863
  /**
5865
- * Order ID
5866
- * @minLength 1
5867
- * @maxLength 100
5864
+ * Line item quantity being restocked.
5865
+ * @min 1
5866
+ * @max 100000
5868
5867
  */
5869
- ecomOrderId?: string;
5868
+ quantity?: number;
5870
5869
  /**
5871
- * Refunded line items and quantity
5872
- * @maxSize 300
5870
+ * Per-location breakdown of restock quantities.
5871
+ * @internal
5872
+ * @maxSize 5
5873
5873
  */
5874
- refundItems?: CalculateRefundItemRequest[];
5875
- /** Should include shipping in refund calculation */
5876
- refundShipping?: boolean;
5874
+ restockLocations?: RestockLocation[];
5877
5875
  }
5878
- interface CalculateRefundItemRequest {
5876
+ interface TriggerRefundResponse {
5877
+ /** All order's transactions after the refunds were added */
5878
+ orderTransactions?: OrderTransactions;
5879
+ /** Created refund ID */
5880
+ refundId?: string | null;
5881
+ /** Payment ID's that the refund execution had failed for */
5882
+ failedPaymentIds?: ItemMetadata[];
5883
+ }
5884
+ /**
5885
+ * A record of all payments and refunds associated with an order.
5886
+ *
5887
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5888
+ */
5889
+ interface OrderTransactions {
5879
5890
  /**
5880
- * ID of the line item being refunded
5891
+ * Order ID.
5881
5892
  * @format GUID
5882
5893
  */
5883
- _id?: string;
5894
+ orderId?: string;
5884
5895
  /**
5885
- * How much of that line item is being refunded
5886
- * @min 1
5887
- * @max 100000
5896
+ * Record of payments made to the merchant.
5897
+ * @maxSize 100
5888
5898
  */
5889
- quantity?: number;
5890
- }
5891
- interface CalculateRefundResponse {
5892
- /** Total refundable amount */
5893
- total?: Price;
5894
- /** Tax cost of the order */
5895
- tax?: Price;
5896
- /** Discount given for this order */
5897
- discount?: Price;
5898
- /** Total cost of the order (without tax) */
5899
- subtotal?: Price;
5900
- /** Total shipping cost for order */
5901
- shipping?: Price;
5902
- /** Previous refund given on that order */
5903
- previouslyRefundedAmount?: Price;
5899
+ payments?: Payment[];
5904
5900
  /**
5905
- * The refundable items of that order
5901
+ * Record of refunds made to the buyer.
5906
5902
  * @maxSize 300
5907
5903
  */
5908
- items?: CalculateRefundItemResponse[];
5904
+ refunds?: Refund[];
5909
5905
  }
5910
- interface CalculateRefundItemResponse {
5906
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5907
+ /** Regular payment details. */
5908
+ regularPaymentDetails?: RegularPaymentDetails;
5909
+ /** Gift card payment details. */
5910
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5911
+ /** Membership payment details. */
5912
+ membershipPaymentDetails?: MembershipPaymentDetails;
5911
5913
  /**
5912
- * Line item ID
5914
+ * Receipt created by Wix
5915
+ * @internal
5916
+ */
5917
+ wixReceipt?: WixReceiptInfo;
5918
+ /**
5919
+ * Receipt created by an external system.
5920
+ * @internal
5921
+ */
5922
+ externalReceipt?: ExternalReceiptInfo;
5923
+ /** @internal */
5924
+ canceled?: CanceledStatusDetails;
5925
+ /** @internal */
5926
+ declined?: DeclinedStatusDetails;
5927
+ /** @internal */
5928
+ voided?: VoidedStatusDetails;
5929
+ /**
5930
+ * Payment ID.
5913
5931
  * @format GUID
5932
+ * @readonly
5914
5933
  */
5915
- _id?: string;
5916
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5917
- price?: Price;
5918
- }
5919
- interface VoidAuthorizedPaymentsRequest {
5934
+ _id?: string | null;
5935
+ /** 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. */
5936
+ _createdDate?: Date | null;
5920
5937
  /**
5921
- * Wix eCommerce order ID
5922
- * @minLength 1
5923
- * @maxLength 100
5938
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5939
+ * @readonly
5924
5940
  */
5925
- ecomOrderId: string;
5941
+ _updatedDate?: Date | null;
5942
+ /** Payment amount. */
5943
+ amount?: Price;
5926
5944
  /**
5927
- * Payment IDs
5928
- * @minSize 1
5929
- * @maxSize 100
5945
+ * Whether refunds for this payment are disabled.
5946
+ * + `true`: This payment is not refundable.
5947
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5948
+ */
5949
+ refundDisabled?: boolean;
5950
+ /**
5951
+ * Whether receipt generation is allowed for this payment.
5952
+ * + `true`: This payment supports receipt generation.
5953
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5954
+ * @readonly
5955
+ */
5956
+ supportReceiptGeneration?: boolean;
5957
+ /** Details about cash rounding applied to this payment, when relevant. */
5958
+ cashRounding?: CashRoundingDetails;
5959
+ /**
5960
+ * Overall payment status.
5961
+ *
5962
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5963
+ */
5964
+ status?: PaymentStatusWithLiterals;
5965
+ /**
5966
+ * Detailed payment status information including gateway reason codes and status-specific details.
5967
+ * @internal
5968
+ */
5969
+ paymentStatusDetails?: PaymentStatusDetails;
5970
+ /**
5971
+ * Location where the payment was processed.
5972
+ * @internal
5930
5973
  * @format GUID
5974
+ * @immutable
5931
5975
  */
5932
- paymentIds: string[];
5976
+ locationId?: string | null;
5977
+ /**
5978
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5979
+ * @format GUID
5980
+ */
5981
+ chargeCorrelationId?: string | null;
5933
5982
  }
5934
- interface VoidAuthorizedPaymentsResponse {
5935
- /** All order's transactions after the void was triggered */
5936
- orderTransactions?: OrderTransactions;
5983
+ /** @oneof */
5984
+ interface PaymentPaymentDetailsOneOf {
5985
+ /** Regular payment details. */
5986
+ regularPaymentDetails?: RegularPaymentDetails;
5987
+ /** Gift card payment details. */
5988
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5989
+ /** Membership payment details. */
5990
+ membershipPaymentDetails?: MembershipPaymentDetails;
5937
5991
  }
5938
- interface CaptureAuthorizedPaymentsRequest {
5992
+ /** @oneof */
5993
+ interface PaymentReceiptInfoOneOf {
5939
5994
  /**
5940
- * Wix eCommerce order ID
5941
- * @minLength 1
5942
- * @maxLength 100
5995
+ * Receipt created by Wix
5996
+ * @internal
5943
5997
  */
5944
- ecomOrderId: string;
5998
+ wixReceipt?: WixReceiptInfo;
5999
+ /**
6000
+ * Receipt created by an external system.
6001
+ * @internal
6002
+ */
6003
+ externalReceipt?: ExternalReceiptInfo;
6004
+ }
6005
+ /** @oneof */
6006
+ interface PaymentStatusDetailsOneOf {
6007
+ /** @internal */
6008
+ canceled?: CanceledStatusDetails;
6009
+ /** @internal */
6010
+ declined?: DeclinedStatusDetails;
6011
+ /** @internal */
6012
+ voided?: VoidedStatusDetails;
6013
+ }
6014
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
6015
+ /** Credit card details. */
6016
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5945
6017
  /**
5946
- * Capture payments information
5947
- * @minSize 1
5948
- * @maxSize 100
6018
+ * Wix Payments order ID.
6019
+ * @maxLength 100
5949
6020
  */
5950
- payments: PaymentCapture[];
5951
- }
5952
- interface PaymentCapture {
6021
+ paymentOrderId?: string | null;
5953
6022
  /**
5954
- * Payment ID
5955
- * @format GUID
6023
+ * Payment gateway's transaction ID.
6024
+ * This field is only returned when the value of `offline_payment` is `false`.
6025
+ * @maxLength 100
5956
6026
  */
5957
- paymentId?: string | null;
6027
+ gatewayTransactionId?: string | null;
5958
6028
  /**
5959
- * Capture amount.
5960
- * If not provided - full authorized amount will be captured.
6029
+ * Payment method.
6030
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6031
+ * Non-exhaustive list of supported values:
6032
+ * + `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`
6033
+ * @maxLength 150
6034
+ * @deprecated Payment method.
6035
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6036
+ * Non-exhaustive list of supported values:
6037
+ * + `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`
6038
+ * @replacedBy payment_method_name
6039
+ * @targetRemovalDate 2026-07-01
5961
6040
  */
5962
- amount?: Price;
5963
- }
5964
- interface CaptureAuthorizedPaymentsResponse {
5965
- /** All order's transactions after the capture was triggered */
5966
- orderTransactions?: OrderTransactions;
5967
- }
5968
- interface ChargeSavedPaymentMethodRequest {
6041
+ paymentMethod?: string | null;
5969
6042
  /**
5970
- * Ecom Order ID.
5971
- * @minLength 1
6043
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5972
6044
  * @maxLength 100
5973
6045
  */
5974
- ecomOrderId?: string;
5975
- /** Amount to be charged */
5976
- amount?: Price;
5977
- }
5978
- interface ChargeSavedPaymentMethodResponse {
5979
- /** Payment gateway's order ID (e.g Wix Payments) */
5980
- paymentGatewayOrderId?: string;
5981
- }
5982
- interface SendBuyerConfirmationEmailRequest {
5983
- /** @format GUID */
5984
- orderId?: string;
5985
- }
5986
- interface SendBuyerConfirmationEmailResponse {
5987
- }
5988
- interface SendBuyerPaymentsReceivedEmailRequest {
6046
+ providerTransactionId?: string | null;
6047
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
6048
+ offlinePayment?: boolean;
5989
6049
  /**
5990
- * @minLength 1
5991
- * @maxLength 100
6050
+ * Payment status.
6051
+ * @deprecated Payment status.
6052
+ * @replacedBy payment.status
6053
+ * @targetRemovalDate 2026-11-01
5992
6054
  */
5993
- orderId?: string;
5994
- }
5995
- interface SendBuyerPaymentsReceivedEmailResponse {
5996
- }
5997
- interface SendBuyerPickupConfirmationEmailRequest {
6055
+ status?: TransactionStatusWithLiterals;
6056
+ /** Whether there is a payment agreement that allows for future charges. */
6057
+ savedPaymentMethod?: boolean;
6058
+ /** Authorization details. */
6059
+ authorizationDetails?: AuthorizationDetails;
5998
6060
  /**
5999
- * @minLength 1
6000
- * @maxLength 100
6061
+ * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
6062
+ * @internal
6063
+ * @maxLength 300
6001
6064
  */
6002
- orderId?: string;
6003
- }
6004
- interface SendBuyerPickupConfirmationEmailResponse {
6005
- }
6006
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
6065
+ paymentProvider?: string | null;
6007
6066
  /**
6008
- * IDs of orders to send pickup emails for.
6009
- * @minSize 1
6010
- * @maxSize 300
6067
+ * Record of chargebacks made by the buyer.
6068
+ * @maxSize 6
6011
6069
  */
6012
- orderIds?: string[];
6013
- }
6014
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
6015
- }
6016
- interface SendBuyerShippingConfirmationEmailRequest {
6070
+ chargebacks?: Chargeback[];
6017
6071
  /**
6018
- * @minLength 1
6019
- * @maxLength 100
6072
+ * Payment method ID.
6073
+ * @internal
6074
+ * @maxLength 36
6020
6075
  */
6021
- orderId?: string;
6022
- }
6023
- interface SendBuyerShippingConfirmationEmailResponse {
6024
- }
6025
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
6076
+ paymentMethodId?: string | null;
6077
+ /** Platform fee amount associated with this payment. */
6078
+ platformFee?: Price;
6026
6079
  /**
6027
- * IDs of orders to send pickup emails for.
6028
- * @minSize 1
6029
- * @maxSize 300
6080
+ * Payment method with buyer and optional owner translations.
6081
+ * Non-exhaustive list of supported values:
6082
+ * + `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`
6030
6083
  */
6031
- orderIds?: string[];
6084
+ paymentMethodName?: PaymentMethodName;
6032
6085
  }
6033
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
6086
+ /** @oneof */
6087
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
6088
+ /** Credit card details. */
6089
+ creditCardDetails?: CreditCardPaymentMethodDetails;
6034
6090
  }
6035
- interface SendMerchantOrderReceivedNotificationRequest {
6091
+ declare enum TransactionStatus {
6092
+ UNDEFINED = "UNDEFINED",
6093
+ APPROVED = "APPROVED",
6094
+ PENDING = "PENDING",
6095
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6096
+ CANCELED = "CANCELED",
6097
+ DECLINED = "DECLINED",
6098
+ REFUNDED = "REFUNDED",
6099
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6100
+ AUTHORIZED = "AUTHORIZED",
6101
+ VOIDED = "VOIDED"
6102
+ }
6103
+ /** @enumType */
6104
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6105
+ interface CreditCardPaymentMethodDetails {
6036
6106
  /**
6037
- * @minLength 1
6038
- * @maxLength 100
6107
+ * The last 4 digits of the card number.
6108
+ * @maxLength 4
6039
6109
  */
6040
- orderId?: string;
6041
- }
6042
- interface SendMerchantOrderReceivedNotificationResponse {
6043
- }
6044
- interface SendCancelRefundEmailRequest {
6110
+ lastFourDigits?: string | null;
6045
6111
  /**
6046
- * The ID of order that is canceled/refunded
6047
- * @minLength 1
6112
+ * Card issuer's brand.
6048
6113
  * @maxLength 100
6049
6114
  */
6050
- orderId?: string;
6115
+ brand?: string | null;
6116
+ }
6117
+ interface AuthorizationDetails {
6051
6118
  /**
6052
- * Personal note added to the email (optional)
6053
- * @minLength 1
6054
- * @maxLength 1000
6119
+ * Whether the authorized payment is of a delayed capture.
6120
+ * @readonly
6055
6121
  */
6056
- customMessage?: string | null;
6057
- /** Refund amount */
6058
- refundAmount?: Price;
6122
+ delayedCapture?: boolean;
6123
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6124
+ authorizedDate?: Date | null;
6059
6125
  /**
6060
- * Refund ID. (Optional)
6061
- * @format GUID
6126
+ * List of captures associated with payment
6127
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
6128
+ * @maxSize 1
6062
6129
  */
6063
- refundId?: string | null;
6064
- }
6065
- interface SendCancelRefundEmailResponse {
6130
+ captures?: AuthorizationCapture[];
6131
+ /** Void associated with payment */
6132
+ void?: AuthorizationVoid;
6133
+ /** Scheduled action for this transaction */
6134
+ scheduledAction?: V1ScheduledAction;
6066
6135
  }
6067
- interface SendRefundEmailRequest {
6068
- /**
6069
- * The ID of order that is refunded
6070
- * @format GUID
6071
- */
6072
- orderId?: string;
6136
+ interface AuthorizationCapture {
6073
6137
  /**
6074
- * Refund ID
6138
+ * Capture ID.
6075
6139
  * @format GUID
6140
+ * @readonly
6076
6141
  */
6077
- refundId?: string;
6142
+ _id?: string | null;
6143
+ /** Status of this capture action */
6144
+ status?: AuthorizationCaptureStatusWithLiterals;
6078
6145
  /**
6079
- * Personal note added to the email (optional)
6080
- * @minLength 1
6081
- * @maxLength 1000
6146
+ * Amount of this capture
6147
+ * @immutable
6082
6148
  */
6083
- customMessage?: string | null;
6149
+ amount?: Price;
6150
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6151
+ _createdDate?: Date | null;
6152
+ /** In case of status is FAILED may contain failure details */
6153
+ failureDetails?: AuthorizationActionFailureDetails;
6084
6154
  }
6085
- interface SendRefundEmailResponse {
6155
+ declare enum AuthorizationCaptureStatus {
6156
+ /** Capture operation still in progress. */
6157
+ PENDING = "PENDING",
6158
+ /** Capture operation succeeded. */
6159
+ SUCCEEDED = "SUCCEEDED",
6160
+ /** Capture operation failed. */
6161
+ FAILED = "FAILED"
6086
6162
  }
6087
- interface SendFulfillmentEmailRequest {
6088
- /** @format GUID */
6089
- orderId?: string;
6090
- /** @format GUID */
6091
- fulfillerId?: string;
6163
+ /** @enumType */
6164
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6165
+ interface AuthorizationActionFailureDetails {
6166
+ /** @maxLength 100 */
6167
+ failureCode?: string;
6092
6168
  }
6093
- interface SendFulfillmentEmailResponse {
6169
+ interface AuthorizationVoid {
6170
+ /** Status of this void action */
6171
+ status?: AuthorizationVoidStatusWithLiterals;
6172
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6173
+ voidedDate?: Date | null;
6174
+ /** In case of status is FAILED may contain failure details */
6175
+ failureDetails?: AuthorizationActionFailureDetails;
6176
+ /** Reason of void action */
6177
+ reason?: ReasonWithLiterals;
6094
6178
  }
6095
- interface SendMerchantOrderReceivedPushRequest {
6096
- /**
6097
- * @minLength 1
6098
- * @maxLength 100
6099
- */
6100
- orderId?: string;
6179
+ declare enum AuthorizationVoidStatus {
6180
+ /** Void operation still in progress. */
6181
+ PENDING = "PENDING",
6182
+ /** Void operation succeeded. */
6183
+ SUCCEEDED = "SUCCEEDED",
6184
+ /** Void operation failed. */
6185
+ FAILED = "FAILED"
6101
6186
  }
6102
- interface SendMerchantOrderReceivedPushResponse {
6187
+ /** @enumType */
6188
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6189
+ /** Reason the authorization was voided. */
6190
+ declare enum Reason {
6191
+ /** Authorization was voided by user. */
6192
+ MANUAL = "MANUAL",
6193
+ /** Authorization passed execution date. */
6194
+ SCHEDULED = "SCHEDULED"
6103
6195
  }
6104
- interface PreviewEmailByTypeRequest {
6105
- emailType?: PreviewEmailTypeWithLiterals;
6196
+ /** @enumType */
6197
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
6198
+ interface V1ScheduledAction {
6199
+ /** Type of the action. */
6200
+ actionType?: ActionTypeWithLiterals;
6201
+ /** The date and time of the action. */
6202
+ executionDate?: Date | null;
6106
6203
  }
6107
- declare enum PreviewEmailType {
6108
- ORDER_PLACED = "ORDER_PLACED",
6109
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
6110
- ORDER_SHIPPED = "ORDER_SHIPPED",
6111
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
6204
+ declare enum ActionType {
6205
+ VOID = "VOID",
6206
+ CAPTURE = "CAPTURE"
6112
6207
  }
6113
6208
  /** @enumType */
6114
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
6115
- interface PreviewEmailByTypeResponse {
6116
- emailPreview?: string;
6117
- }
6118
- interface PreviewRefundEmailRequest {
6119
- /**
6120
- * @minLength 1
6121
- * @maxLength 100
6122
- */
6123
- orderId?: string;
6124
- /** Refund amount */
6125
- refundAmount?: Price;
6126
- /** Refund business details */
6127
- details?: RefundDetails;
6209
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
6210
+ interface Chargeback {
6128
6211
  /**
6129
- * Personal note added to the email (optional)
6130
- * @minLength 1
6131
- * @maxLength 1000
6212
+ * Chargeback ID.
6213
+ * @format GUID
6214
+ * @readonly
6215
+ * @immutable
6132
6216
  */
6133
- customMessage?: string | null;
6217
+ _id?: string;
6134
6218
  /**
6135
- * Refund ID. (Optional)
6136
- * @format GUID
6219
+ * 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.
6220
+ * @readonly
6221
+ * @immutable
6137
6222
  */
6138
- refundId?: string | null;
6139
- }
6140
- interface PreviewRefundEmailResponse {
6141
- emailPreview?: string;
6142
- }
6143
- interface PreviewCancelEmailRequest {
6223
+ _createdDate?: Date | null;
6144
6224
  /**
6145
- * @minLength 1
6146
- * @maxLength 100
6225
+ * 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.
6226
+ * @readonly
6147
6227
  */
6148
- orderId?: string;
6228
+ _updatedDate?: Date | null;
6149
6229
  /**
6150
- * Personal note added to the email (optional)
6151
- * @minLength 1
6152
- * @maxLength 1000
6230
+ * Amount.
6231
+ * @readonly
6232
+ * @immutable
6153
6233
  */
6154
- customMessage?: string | null;
6155
- }
6156
- interface PreviewCancelEmailResponse {
6157
- emailPreview?: string;
6158
- }
6159
- interface PreviewCancelRefundEmailRequest {
6234
+ amount?: Price;
6160
6235
  /**
6161
- * @minLength 1
6162
- * @maxLength 100
6236
+ * Reversal amount. Present only when status is REVERSED.
6237
+ * @readonly
6163
6238
  */
6164
- orderId?: string;
6239
+ reversalAmount?: Price;
6165
6240
  /**
6166
- * Personal note added to the email (optional)
6167
- * @minLength 1
6168
- * @maxLength 1000
6241
+ * Status.
6242
+ *
6243
+ * Default: `"APPROVED"`.
6169
6244
  */
6170
- customMessage?: string | null;
6171
- /** Refund amount */
6172
- refundAmount?: Price;
6245
+ status?: ChargebackStatusWithLiterals;
6173
6246
  /**
6174
- * Refund ID. (Optional)
6247
+ * External chargeback ID.
6175
6248
  * @format GUID
6249
+ * @readonly
6250
+ * @immutable
6176
6251
  */
6177
- refundId?: string | null;
6178
- }
6179
- interface PreviewCancelRefundEmailResponse {
6180
- emailPreview?: string;
6181
- }
6182
- interface PreviewBuyerPaymentsReceivedEmailRequest {
6183
- }
6184
- interface PreviewBuyerPaymentsReceivedEmailResponse {
6185
- emailPreview?: string;
6186
- }
6187
- interface PreviewBuyerConfirmationEmailRequest {
6188
- }
6189
- interface PreviewBuyerConfirmationEmailResponse {
6190
- emailPreview?: string;
6191
- }
6192
- interface PreviewBuyerPickupConfirmationEmailRequest {
6193
- }
6194
- interface PreviewBuyerPickupConfirmationEmailResponse {
6195
- emailPreview?: string;
6196
- }
6197
- interface PreviewShippingConfirmationEmailRequest {
6198
- }
6199
- interface PreviewShippingConfirmationEmailResponse {
6200
- emailPreview?: string;
6201
- }
6202
- interface PreviewResendDownloadLinksEmailRequest {
6252
+ externalId?: string | null;
6203
6253
  }
6204
- interface PreviewResendDownloadLinksEmailResponse {
6205
- emailPreview?: string;
6254
+ declare enum ChargebackStatus {
6255
+ /** Chargeback was approved. */
6256
+ APPROVED = "APPROVED",
6257
+ /** Chargeback was reversed. */
6258
+ REVERSED = "REVERSED"
6206
6259
  }
6207
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
6208
- /** Emitted on a meta site creation. */
6209
- siteCreated?: SiteCreated;
6210
- /** Emitted on a meta site transfer completion. */
6211
- siteTransferred?: SiteTransferred;
6212
- /** Emitted on a meta site deletion. */
6213
- siteDeleted?: SiteDeleted;
6214
- /** Emitted on a meta site restoration. */
6215
- siteUndeleted?: SiteUndeleted;
6216
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6217
- sitePublished?: SitePublished;
6218
- /** Emitted on a meta site unpublish. */
6219
- siteUnpublished?: SiteUnpublished;
6220
- /** Emitted when meta site is marked as template. */
6221
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6222
- /** Emitted when meta site is marked as a WixSite. */
6223
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6224
- /** Emitted when an application is provisioned (installed). */
6225
- serviceProvisioned?: ServiceProvisioned;
6226
- /** Emitted when an application is removed (uninstalled). */
6227
- serviceRemoved?: ServiceRemoved;
6228
- /** Emitted when meta site name (URL slug) is changed. */
6229
- siteRenamedPayload?: SiteRenamed;
6230
- /** Emitted when meta site was permanently deleted. */
6231
- hardDeleted?: SiteHardDeleted;
6232
- /** Emitted on a namespace change. */
6233
- namespaceChanged?: NamespaceChanged;
6234
- /** Emitted when Studio is attached. */
6235
- studioAssigned?: StudioAssigned;
6236
- /** Emitted when Studio is detached. */
6237
- studioUnassigned?: StudioUnassigned;
6260
+ /** @enumType */
6261
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
6262
+ interface PaymentMethodName {
6238
6263
  /**
6239
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6240
- * the actual URL.
6241
- *
6242
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6243
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6264
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
6265
+ * @maxLength 150
6244
6266
  */
6245
- urlChanged?: SiteUrlChanged;
6246
- /** Site is marked as PurgedExternally */
6247
- sitePurgedExternally?: SitePurgedExternally;
6248
- /** Emitted when Odeditor is attached. */
6249
- odeditorAssigned?: OdeditorAssigned;
6250
- /** Emitted when Odeditor is detached. */
6251
- odeditorUnassigned?: OdeditorUnassigned;
6252
- /** Emitted when Picasso is attached. */
6253
- picassoAssigned?: PicassoAssigned;
6254
- /** Emitted when Picasso is detached. */
6255
- picassoUnassigned?: PicassoUnassigned;
6256
- /** Emitted when Wixel is attached. */
6257
- wixelAssigned?: WixelAssigned;
6258
- /** Emitted when Wixel is detached. */
6259
- wixelUnassigned?: WixelUnassigned;
6260
- /** Emitted when StudioTwo is attached. */
6261
- studioTwoAssigned?: StudioTwoAssigned;
6262
- /** Emitted when StudioTwo is detached. */
6263
- studioTwoUnassigned?: StudioTwoUnassigned;
6264
- /** Emitted when media from user domain is enabled. */
6265
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6266
- /** Emitted when media from user domain is disabled. */
6267
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6268
- /** Emitted when Editorless is attached. */
6269
- editorlessAssigned?: EditorlessAssigned;
6270
- /** Emitted when Editorless is detached. */
6271
- editorlessUnassigned?: EditorlessUnassigned;
6267
+ buyerLanguageName?: string | null;
6272
6268
  /**
6273
- * A meta site id.
6274
- * @format GUID
6269
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
6270
+ *
6271
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
6272
+ * @maxLength 150
6275
6273
  */
6276
- metaSiteId?: string;
6277
- /** A meta site version. Monotonically increasing. */
6278
- version?: string;
6279
- /** A timestamp of the event. */
6280
- timestamp?: string;
6274
+ siteLanguageName?: string | null;
6281
6275
  /**
6282
- * TODO(meta-site): Change validation once validations are disabled for consumers
6283
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
6284
- * @maxSize 4000
6276
+ * User-provided payment method name.
6277
+ *
6278
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
6285
6279
  */
6286
- assets?: Asset[];
6280
+ userDefinedName?: UserDefinedPaymentMethodName;
6287
6281
  }
6288
- /** @oneof */
6289
- interface MetaSiteSpecialEventPayloadOneOf {
6290
- /** Emitted on a meta site creation. */
6291
- siteCreated?: SiteCreated;
6292
- /** Emitted on a meta site transfer completion. */
6293
- siteTransferred?: SiteTransferred;
6294
- /** Emitted on a meta site deletion. */
6295
- siteDeleted?: SiteDeleted;
6296
- /** Emitted on a meta site restoration. */
6297
- siteUndeleted?: SiteUndeleted;
6298
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6299
- sitePublished?: SitePublished;
6300
- /** Emitted on a meta site unpublish. */
6301
- siteUnpublished?: SiteUnpublished;
6302
- /** Emitted when meta site is marked as template. */
6303
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6304
- /** Emitted when meta site is marked as a WixSite. */
6305
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6306
- /** Emitted when an application is provisioned (installed). */
6307
- serviceProvisioned?: ServiceProvisioned;
6308
- /** Emitted when an application is removed (uninstalled). */
6309
- serviceRemoved?: ServiceRemoved;
6310
- /** Emitted when meta site name (URL slug) is changed. */
6311
- siteRenamedPayload?: SiteRenamed;
6312
- /** Emitted when meta site was permanently deleted. */
6313
- hardDeleted?: SiteHardDeleted;
6314
- /** Emitted on a namespace change. */
6315
- namespaceChanged?: NamespaceChanged;
6316
- /** Emitted when Studio is attached. */
6317
- studioAssigned?: StudioAssigned;
6318
- /** Emitted when Studio is detached. */
6319
- studioUnassigned?: StudioUnassigned;
6282
+ interface GiftCardPaymentDetails {
6283
+ /**
6284
+ * Gift card payment ID.
6285
+ * @maxLength 100
6286
+ */
6287
+ giftCardPaymentId?: string;
6288
+ /**
6289
+ * Gift card ID.
6290
+ * @internal
6291
+ * @deprecated
6292
+ */
6293
+ giftCardId?: string;
6320
6294
  /**
6321
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6322
- * the actual URL.
6323
- *
6324
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6325
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6295
+ * ID of the app that created the gift card.
6296
+ * @format GUID
6326
6297
  */
6327
- urlChanged?: SiteUrlChanged;
6328
- /** Site is marked as PurgedExternally */
6329
- sitePurgedExternally?: SitePurgedExternally;
6330
- /** Emitted when Odeditor is attached. */
6331
- odeditorAssigned?: OdeditorAssigned;
6332
- /** Emitted when Odeditor is detached. */
6333
- odeditorUnassigned?: OdeditorUnassigned;
6334
- /** Emitted when Picasso is attached. */
6335
- picassoAssigned?: PicassoAssigned;
6336
- /** Emitted when Picasso is detached. */
6337
- picassoUnassigned?: PicassoUnassigned;
6338
- /** Emitted when Wixel is attached. */
6339
- wixelAssigned?: WixelAssigned;
6340
- /** Emitted when Wixel is detached. */
6341
- wixelUnassigned?: WixelUnassigned;
6342
- /** Emitted when StudioTwo is attached. */
6343
- studioTwoAssigned?: StudioTwoAssigned;
6344
- /** Emitted when StudioTwo is detached. */
6345
- studioTwoUnassigned?: StudioTwoUnassigned;
6346
- /** Emitted when media from user domain is enabled. */
6347
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6348
- /** Emitted when media from user domain is disabled. */
6349
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6350
- /** Emitted when Editorless is attached. */
6351
- editorlessAssigned?: EditorlessAssigned;
6352
- /** Emitted when Editorless is detached. */
6353
- editorlessUnassigned?: EditorlessUnassigned;
6354
- }
6355
- interface Asset {
6298
+ appId?: string;
6356
6299
  /**
6357
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
6358
- * @maxLength 36
6300
+ * Whether the gift card is voided.
6301
+ * @readonly
6302
+ * @deprecated Whether the gift card is voided.
6303
+ * @replacedBy payment.status
6304
+ * @targetRemovalDate 2026-11-01
6359
6305
  */
6360
- appDefId?: string;
6306
+ voided?: boolean;
6361
6307
  /**
6362
- * An instance id. For legacy reasons may be UUID or a string.
6308
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
6309
+ * @maxLength 30
6310
+ * @immutable
6311
+ */
6312
+ obfuscatedCode?: string | null;
6313
+ }
6314
+ interface MembershipPaymentDetails {
6315
+ /**
6316
+ * Membership ID.
6363
6317
  * @maxLength 200
6364
6318
  */
6365
- instanceId?: string;
6366
- /** An application state. */
6367
- state?: StateWithLiterals;
6319
+ membershipId?: string;
6320
+ /**
6321
+ * ID of the line item this membership applies to.
6322
+ * @minLength 1
6323
+ * @maxLength 100
6324
+ */
6325
+ lineItemId?: string;
6326
+ /**
6327
+ * Payment status.
6328
+ * @deprecated Payment status.
6329
+ * @replacedBy payment.status
6330
+ * @targetRemovalDate 2026-11-01
6331
+ */
6332
+ status?: MembershipPaymentStatusWithLiterals;
6333
+ /** Membership name. */
6334
+ name?: MembershipName;
6335
+ /**
6336
+ * The transaction ID in the membership system. Can be used to void the transaction.
6337
+ * @minLength 1
6338
+ * @maxLength 100
6339
+ */
6340
+ externalTransactionId?: string | null;
6341
+ /**
6342
+ * Whether the membership is voided.
6343
+ * @readonly
6344
+ * @deprecated Whether the membership is voided.
6345
+ * @replacedBy payment.status
6346
+ * @targetRemovalDate 2026-11-01
6347
+ */
6348
+ voided?: boolean;
6349
+ /**
6350
+ * ID of the application providing this payment option.
6351
+ * @format GUID
6352
+ */
6353
+ providerAppId?: string;
6354
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6355
+ futureMembership?: FutureMembershipDetails;
6368
6356
  }
6369
- declare enum State {
6370
- UNKNOWN = "UNKNOWN",
6371
- ENABLED = "ENABLED",
6372
- DISABLED = "DISABLED",
6373
- PENDING = "PENDING",
6374
- DEMO = "DEMO"
6357
+ declare enum MembershipPaymentStatus {
6358
+ /** Payment was charged. */
6359
+ CHARGED = "CHARGED",
6360
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
6361
+ CHARGE_FAILED = "CHARGE_FAILED",
6362
+ /** Payment is pending. */
6363
+ CHARGE_PENDING = "CHARGE_PENDING",
6364
+ /** Payment was voided. */
6365
+ VOIDED = "VOIDED"
6375
6366
  }
6376
6367
  /** @enumType */
6377
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
6378
- interface SiteCreated {
6368
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6369
+ interface FutureMembershipDetails {
6379
6370
  /**
6380
- * A template identifier (empty if not created from a template).
6381
- * @maxLength 36
6371
+ * ID of the plan line item in the order from which the membership will be created.
6372
+ * @format GUID
6382
6373
  */
6383
- originTemplateId?: string;
6374
+ lineItemId?: string;
6384
6375
  /**
6385
- * An account id of the owner.
6386
- * @format GUID
6376
+ * ID of the benefit the future membership will grant.
6377
+ * @maxLength 200
6387
6378
  */
6388
- ownerId?: string;
6389
- /** A context in which meta site was created. */
6390
- context?: SiteCreatedContextWithLiterals;
6379
+ benefitId?: string;
6380
+ }
6381
+ interface WixReceiptInfo {
6391
6382
  /**
6392
- * A meta site id from which this site was created.
6393
- *
6394
- * In case of a creation from a template it's a template id.
6395
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
6383
+ * Receipt ID
6396
6384
  * @format GUID
6397
6385
  */
6398
- originMetaSiteId?: string | null;
6386
+ receiptId?: string;
6399
6387
  /**
6400
- * A meta site name (URL slug).
6401
- * @maxLength 20
6388
+ * Display number of receipt
6389
+ * @minLength 1
6390
+ * @maxLength 40
6402
6391
  */
6403
- siteName?: string;
6404
- /** A namespace. */
6405
- namespace?: NamespaceWithLiterals;
6406
- }
6407
- declare enum SiteCreatedContext {
6408
- /** A valid option, we don't expose all reasons why site might be created. */
6409
- OTHER = "OTHER",
6410
- /** A meta site was created from template. */
6411
- FROM_TEMPLATE = "FROM_TEMPLATE",
6412
- /** A meta site was created by copying of the transfferred meta site. */
6413
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
6414
- /** A copy of existing meta site. */
6415
- DUPLICATE = "DUPLICATE",
6416
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
6417
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
6418
- /** deprecated A meta site was created for Flash editor. */
6419
- FLASH = "FLASH"
6392
+ displayNumber?: string | null;
6420
6393
  }
6421
- /** @enumType */
6422
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
6423
- declare enum Namespace {
6424
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
6425
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
6426
- WIX = "WIX",
6427
- /** 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. */
6428
- SHOUT_OUT = "SHOUT_OUT",
6429
- /** 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. */
6430
- ALBUMS = "ALBUMS",
6431
- /** 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. */
6432
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
6433
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6434
- HOTELS = "HOTELS",
6435
- /** 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. */
6436
- CLUBS = "CLUBS",
6437
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6438
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
6394
+ interface ExternalReceiptInfo {
6439
6395
  /**
6440
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
6441
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
6396
+ * External receipt ID
6397
+ * @maxLength 100
6442
6398
  */
6443
- DEV_SITE = "DEV_SITE",
6444
- /** 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. */
6445
- LOGOS = "LOGOS",
6446
- /** 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. */
6447
- VIDEO_MAKER = "VIDEO_MAKER",
6448
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6449
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
6450
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6451
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
6399
+ receiptId?: string | null;
6452
6400
  /**
6453
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
6454
- *
6455
- * Meta site with this namespace will *not* be shown in a user's site list by default.
6401
+ * ID of the app providing the receipt
6402
+ * @format GUID
6456
6403
  */
6457
- HTML_DRAFT = "HTML_DRAFT",
6404
+ appId?: string | null;
6458
6405
  /**
6459
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
6460
- * Will be accessible from Site List and will not have a website app.
6461
- * Once the user attaches a site, the site will become a regular wixsite.
6406
+ * Display number of receipt
6407
+ * @minLength 1
6408
+ * @maxLength 40
6462
6409
  */
6463
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
6464
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
6465
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
6466
- /** It is to be used in the Business First efforts. */
6467
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
6468
- /** Bookings business flow with no site. */
6469
- ANYWHERE = "ANYWHERE",
6470
- /** Namespace for Headless Backoffice with no editor */
6471
- HEADLESS = "HEADLESS",
6410
+ displayNumber?: string | null;
6411
+ }
6412
+ interface CashRoundingDetails {
6472
6413
  /**
6473
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
6474
- * The site will be used for account level CSM feature for enterprise
6414
+ * Payment amount before cash rounding was applied.
6415
+ * When provided, balance and status calculations use this value instead of `amount`
6416
+ * to prevent false overpayment or underpayment due to rounding.
6475
6417
  */
6476
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
6477
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
6478
- RISE = "RISE",
6418
+ unroundedAmount?: Price;
6419
+ /**
6420
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6421
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6422
+ * @readonly
6423
+ */
6424
+ roundingAdjustment?: CashRounding;
6425
+ }
6426
+ declare enum PaymentStatus {
6427
+ /** Payment was charged successfully. */
6428
+ APPROVED = "APPROVED",
6429
+ /** Payment is being processed and hasn't been confirmed yet. */
6430
+ PENDING = "PENDING",
6431
+ /** 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. */
6432
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6433
+ /** Payment was canceled before it was charged. */
6434
+ CANCELED = "CANCELED",
6435
+ /** Payment was declined by the payment provider. */
6436
+ DECLINED = "DECLINED",
6437
+ /** Payment was fully refunded. */
6438
+ REFUNDED = "REFUNDED",
6439
+ /** Part of the payment amount was refunded. */
6440
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6441
+ /** 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. */
6442
+ AUTHORIZED = "AUTHORIZED",
6479
6443
  /**
6480
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
6481
- * There's a blank site behind the scene but it's blank).
6482
- * The Mobile company will be the owner of this namespace.
6444
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6445
+ *
6446
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6483
6447
  */
6484
- BRANDED_FIRST = "BRANDED_FIRST",
6485
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
6486
- NOWNIA = "NOWNIA",
6448
+ VOIDED = "VOIDED"
6449
+ }
6450
+ /** @enumType */
6451
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6452
+ interface CanceledStatusDetails {
6453
+ reason?: CanceledReasonWithLiterals;
6454
+ }
6455
+ declare enum CanceledReason {
6456
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
6457
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6458
+ /** Payment was not completed by user and expired. */
6459
+ EXPIRED = "EXPIRED"
6460
+ }
6461
+ /** @enumType */
6462
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6463
+ interface DeclinedStatusDetails {
6464
+ reason?: DeclinedReasonWithLiterals;
6465
+ }
6466
+ declare enum DeclinedReason {
6467
+ /** Corresponding charge failed. */
6468
+ CHARGE_FAILED = "CHARGE_FAILED",
6469
+ /** Payment details expired. */
6470
+ EXPIRED = "EXPIRED",
6471
+ /** Insufficient funds. */
6472
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6473
+ /** Gift card was disabled before charge was attempted. */
6474
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6475
+ }
6476
+ /** @enumType */
6477
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6478
+ interface VoidedStatusDetails {
6479
+ reason?: VoidedReasonWithLiterals;
6480
+ }
6481
+ declare enum VoidedReason {
6482
+ /** Payment was voided by merchant request. */
6483
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
6484
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6485
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6486
+ }
6487
+ /** @enumType */
6488
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6489
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6490
+ /** @internal */
6491
+ canceled?: CanceledStatusDetails;
6492
+ /** @internal */
6493
+ declined?: DeclinedStatusDetails;
6494
+ /** @internal */
6495
+ voided?: VoidedStatusDetails;
6487
6496
  /**
6488
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
6489
- * The Partners company owns this namespace.
6497
+ * Reason code from the payment gateway.
6498
+ * @internal
6499
+ * @minLength 1
6500
+ * @maxLength 10
6490
6501
  */
6491
- UGC_TEMPLATE = "UGC_TEMPLATE",
6492
- /** Codux Headless Sites */
6493
- CODUX = "CODUX",
6494
- /** Bobb - AI Design Creator. */
6495
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
6502
+ paymentGatewayReasonCode?: string | null;
6503
+ }
6504
+ /** @oneof */
6505
+ interface PaymentStatusDetailsStatusDetailsOneOf {
6506
+ /** @internal */
6507
+ canceled?: CanceledStatusDetails;
6508
+ /** @internal */
6509
+ declined?: DeclinedStatusDetails;
6510
+ /** @internal */
6511
+ voided?: VoidedStatusDetails;
6512
+ }
6513
+ interface Refund {
6496
6514
  /**
6497
- * Shared Blog Site is a unique single site across Enterprise account,
6498
- * This site will hold all Blog posts related to the Marketing product.
6515
+ * Refund ID.
6516
+ * @format GUID
6517
+ * @readonly
6499
6518
  */
6500
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6501
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6502
- STANDALONE_FORMS = "STANDALONE_FORMS",
6503
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6504
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
6505
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6506
- MIMIR = "MIMIR",
6507
- /** Wix Twins platform. */
6508
- TWINS = "TWINS",
6509
- /** Wix Nano. */
6510
- NANO = "NANO",
6511
- /** Base44 headless sites. */
6512
- BASE44 = "BASE44",
6513
- /** Wix Channels Sites */
6514
- CHANNELS = "CHANNELS",
6515
- /** Nautilus platform. */
6516
- NAUTILUS = "NAUTILUS",
6519
+ _id?: string;
6517
6520
  /**
6518
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6519
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6521
+ * List of transactions.
6522
+ * @maxSize 50
6520
6523
  */
6521
- SYMPHONY = "SYMPHONY",
6522
- /** Nautilus platform app. */
6523
- NAUTILUS_APPS = "NAUTILUS_APPS",
6524
+ transactions?: RefundTransaction[];
6525
+ /** Refund business details. */
6526
+ details?: RefundDetails;
6524
6527
  /**
6525
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6526
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6528
+ * 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.
6529
+ * @readonly
6530
+ * @immutable
6527
6531
  */
6528
- VIBU = "VIBU",
6532
+ _createdDate?: Date | null;
6529
6533
  /**
6530
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6531
- * (an Enterprise account may have several), holding that BrandKit's brand definition
6532
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6533
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
6534
+ * Aggregated refund summary.
6535
+ * @readonly
6534
6536
  */
6535
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6537
+ summary?: AggregatedRefundSummary;
6536
6538
  /**
6537
- * Dev-center development sites (com.wixpress.devcenter.dsm).
6538
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6539
+ * ID of the app that initiated this refund.
6540
+ * @format GUID
6541
+ * @readonly
6542
+ * @immutable
6539
6543
  */
6540
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6544
+ requestingServiceAppId?: string | null;
6541
6545
  }
6542
- /** @enumType */
6543
- 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';
6544
- /** Site transferred to another user. */
6545
- interface SiteTransferred {
6546
+ interface RefundTransaction {
6546
6547
  /**
6547
- * A previous owner id (user that transfers meta site).
6548
+ * ID of the payment associated with this refund.
6548
6549
  * @format GUID
6550
+ * @immutable
6549
6551
  */
6550
- oldOwnerId?: string;
6552
+ paymentId?: string;
6551
6553
  /**
6552
- * A new owner id (user that accepts meta site).
6554
+ * Refund amount.
6555
+ * @immutable
6556
+ */
6557
+ amount?: Price;
6558
+ /** Refund status. */
6559
+ refundStatus?: RefundStatusWithLiterals;
6560
+ /** Optional details of current refund status. */
6561
+ refundStatusInfo?: RefundStatusInfo;
6562
+ /**
6563
+ * Payment gateway's refund ID.
6564
+ * This field is only returned when the value of `external_refund` is `false`.
6553
6565
  * @format GUID
6554
6566
  */
6555
- newOwnerId?: string;
6556
- }
6557
- /** Soft deletion of the meta site. Could be restored. */
6558
- interface SiteDeleted {
6559
- /** A deletion context. */
6560
- deleteContext?: DeleteContext;
6561
- }
6562
- interface DeleteContext {
6563
- /** When the meta site was deleted. */
6564
- dateDeleted?: Date | null;
6565
- /** A status. */
6566
- deleteStatus?: DeleteStatusWithLiterals;
6567
+ gatewayRefundId?: string | null;
6568
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6569
+ providerRefundId?: string | null;
6567
6570
  /**
6568
- * A reason (flow).
6569
- * @maxLength 255
6571
+ * Whether refund was made externally and manually on the payment provider's side.
6572
+ * @immutable
6570
6573
  */
6571
- deleteOrigin?: string;
6574
+ externalRefund?: boolean;
6572
6575
  /**
6573
- * A service that deleted it.
6574
- * @maxLength 255
6576
+ * Location where the refund was processed.
6577
+ * @internal
6578
+ * @format GUID
6579
+ * @immutable
6575
6580
  */
6576
- initiatorId?: string | null;
6581
+ locationId?: string | null;
6577
6582
  }
6578
- declare enum DeleteStatus {
6579
- UNKNOWN = "UNKNOWN",
6580
- TRASH = "TRASH",
6581
- DELETED = "DELETED",
6582
- PENDING_PURGE = "PENDING_PURGE",
6583
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6583
+ /** Refund transaction status. */
6584
+ declare enum RefundStatus {
6585
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6586
+ PENDING = "PENDING",
6587
+ /** Refund transaction succeeded. */
6588
+ SUCCEEDED = "SUCCEEDED",
6589
+ /** Refund transaction failed. */
6590
+ FAILED = "FAILED",
6591
+ /** Refund request acknowledged, and will be executed soon. */
6592
+ SCHEDULED = "SCHEDULED",
6593
+ /** Refund was initiated on payment provider side. */
6594
+ STARTED = "STARTED"
6584
6595
  }
6585
6596
  /** @enumType */
6586
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6587
- /** Restoration of the meta site. */
6588
- interface SiteUndeleted {
6589
- }
6590
- /** First publish of a meta site. Or subsequent publish after unpublish. */
6591
- interface SitePublished {
6592
- }
6593
- interface SiteUnpublished {
6597
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6598
+ interface RefundStatusInfo {
6594
6599
  /**
6595
- * A list of URLs previously associated with the meta site.
6596
- * @maxLength 4000
6597
- * @maxSize 10000
6600
+ * Reason code for the refund's current status.
6601
+ *
6602
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6603
+ * @minLength 1
6604
+ * @maxLength 10
6598
6605
  */
6599
- urls?: string[];
6600
- }
6601
- interface SiteMarkedAsTemplate {
6602
- }
6603
- interface SiteMarkedAsWixSite {
6606
+ paymentGatewayReasonCode?: string | null;
6607
+ /**
6608
+ * Free text explanation of current refund status.
6609
+ * @minLength 1
6610
+ * @maxLength 1000
6611
+ */
6612
+ description?: string | null;
6604
6613
  }
6605
- /**
6606
- * Represents a service provisioned a site.
6607
- *
6608
- * Note on `origin_instance_id`:
6609
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6610
- * This is because of the following scenario:
6611
- *
6612
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
6613
- * such as a product catalog. When you create a site from this template, you inherit this
6614
- * default product catalog. However, if the template's product catalog is modified,
6615
- * your site will retain the catalog as it was at the time of site creation. This ensures that
6616
- * your site remains consistent with what you initially received and does not include any
6617
- * changes made to the original template afterward.
6618
- * To ensure this, the TPA on the template gets a new instance_id.
6619
- */
6620
- interface ServiceProvisioned {
6614
+ interface AggregatedRefundSummary {
6615
+ /** Total amount requested for refund. */
6616
+ requestedRefund?: Price;
6617
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6618
+ pendingRefund?: Price;
6619
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6620
+ refunded?: Price;
6621
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
6622
+ failedRefundAmount?: Price;
6623
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
6624
+ pending?: boolean;
6625
+ /** Breakdown of refunded items. Available only after refund is complete. */
6626
+ breakdown?: RefundItemsBreakdown;
6627
+ }
6628
+ interface RefundItemsBreakdown {
6621
6629
  /**
6622
- * Either UUID or EmbeddedServiceType.
6623
- * @maxLength 36
6630
+ * Refunded line items and the amount refunded for each.
6631
+ * @maxSize 300
6624
6632
  */
6625
- appDefId?: string;
6633
+ lineItems?: LineItemRefundSummary[];
6634
+ }
6635
+ interface LineItemRefundSummary {
6626
6636
  /**
6627
- * Not only UUID. Something here could be something weird.
6628
- * @maxLength 36
6637
+ * ID of the refunded line item.
6638
+ * @format GUID
6629
6639
  */
6630
- instanceId?: string;
6640
+ lineItemId?: string;
6641
+ /** Total refunded amount for the line item. */
6642
+ totalRefundedAmount?: Price;
6643
+ }
6644
+ interface CalculateRefundRequest {
6631
6645
  /**
6632
- * An instance id from which this instance is originated.
6633
- * @maxLength 36
6646
+ * Order ID
6647
+ * @minLength 1
6648
+ * @maxLength 100
6634
6649
  */
6635
- originInstanceId?: string;
6650
+ ecomOrderId?: string;
6636
6651
  /**
6637
- * A version.
6638
- * @maxLength 500
6652
+ * Refunded line items and quantity
6653
+ * @maxSize 300
6639
6654
  */
6640
- version?: string | null;
6655
+ refundItems?: CalculateRefundItemRequest[];
6656
+ /** Should include shipping in refund calculation */
6657
+ refundShipping?: boolean;
6658
+ }
6659
+ interface CalculateRefundItemRequest {
6641
6660
  /**
6642
- * The origin meta site id
6661
+ * ID of the line item being refunded
6643
6662
  * @format GUID
6644
6663
  */
6645
- originMetaSiteId?: string | null;
6646
- }
6647
- interface ServiceRemoved {
6664
+ _id?: string;
6648
6665
  /**
6649
- * Either UUID or EmbeddedServiceType.
6650
- * @maxLength 36
6666
+ * How much of that line item is being refunded
6667
+ * @min 1
6668
+ * @max 100000
6651
6669
  */
6652
- appDefId?: string;
6670
+ quantity?: number;
6671
+ }
6672
+ interface CalculateRefundResponse {
6673
+ /** Total refundable amount */
6674
+ total?: Price;
6675
+ /** Tax cost of the order */
6676
+ tax?: Price;
6677
+ /** Discount given for this order */
6678
+ discount?: Price;
6679
+ /** Total cost of the order (without tax) */
6680
+ subtotal?: Price;
6681
+ /** Total shipping cost for order */
6682
+ shipping?: Price;
6683
+ /** Previous refund given on that order */
6684
+ previouslyRefundedAmount?: Price;
6653
6685
  /**
6654
- * Not only UUID. Something here could be something weird.
6655
- * @maxLength 36
6686
+ * The refundable items of that order
6687
+ * @maxSize 300
6656
6688
  */
6657
- instanceId?: string;
6689
+ items?: CalculateRefundItemResponse[];
6690
+ }
6691
+ interface CalculateRefundItemResponse {
6658
6692
  /**
6659
- * A version.
6660
- * @maxLength 500
6693
+ * Line item ID
6694
+ * @format GUID
6661
6695
  */
6662
- version?: string | null;
6696
+ _id?: string;
6697
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6698
+ price?: Price;
6663
6699
  }
6664
- /** Rename of the site. Meaning, free public url has been changed as well. */
6665
- interface SiteRenamed {
6700
+ interface VoidAuthorizedPaymentsRequest {
6666
6701
  /**
6667
- * A new meta site name (URL slug).
6668
- * @maxLength 20
6702
+ * Wix eCommerce order ID
6703
+ * @minLength 1
6704
+ * @maxLength 100
6669
6705
  */
6670
- newSiteName?: string;
6706
+ ecomOrderId: string;
6671
6707
  /**
6672
- * A previous meta site name (URL slug).
6673
- * @maxLength 255
6708
+ * Payment IDs
6709
+ * @minSize 1
6710
+ * @maxSize 100
6711
+ * @format GUID
6674
6712
  */
6675
- oldSiteName?: string;
6676
- }
6677
- /**
6678
- * Hard deletion of the meta site.
6679
- *
6680
- * Could not be restored. Therefore it's desirable to cleanup data.
6681
- */
6682
- interface SiteHardDeleted {
6683
- /** A deletion context. */
6684
- deleteContext?: DeleteContext;
6685
- }
6686
- interface NamespaceChanged {
6687
- /** A previous namespace. */
6688
- oldNamespace?: NamespaceWithLiterals;
6689
- /** A new namespace. */
6690
- newNamespace?: NamespaceWithLiterals;
6691
- }
6692
- /** Assigned Studio editor */
6693
- interface StudioAssigned {
6694
- }
6695
- /** Unassigned Studio editor */
6696
- interface StudioUnassigned {
6713
+ paymentIds: string[];
6697
6714
  }
6698
- /**
6699
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6700
- *
6701
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6702
- * with sites and its urls, you need to listen to another topic/event. Read about it:
6703
- *
6704
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6705
- */
6706
- interface SiteUrlChanged {
6715
+ interface VoidAuthorizedPaymentsResponse {
6716
+ /** All order's transactions after the void was triggered */
6717
+ orderTransactions?: OrderTransactions;
6707
6718
  }
6708
- /**
6709
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6710
- * Consumed by other teams to remove relevant data.
6711
- */
6712
- interface SitePurgedExternally {
6719
+ interface CaptureAuthorizedPaymentsRequest {
6713
6720
  /**
6714
- * @maxLength 2048
6721
+ * Wix eCommerce order ID
6722
+ * @minLength 1
6723
+ * @maxLength 100
6724
+ */
6725
+ ecomOrderId: string;
6726
+ /**
6727
+ * Capture payments information
6728
+ * @minSize 1
6715
6729
  * @maxSize 100
6716
- * @deprecated
6717
- * @targetRemovalDate 2025-04-15
6718
6730
  */
6719
- appDefId?: string[];
6720
- }
6721
- /** Assigned Odeditor */
6722
- interface OdeditorAssigned {
6723
- }
6724
- /** Unassigned Odeditor */
6725
- interface OdeditorUnassigned {
6726
- }
6727
- /** Assigned Picasso editor */
6728
- interface PicassoAssigned {
6729
- }
6730
- /** Unassigned Picasso */
6731
- interface PicassoUnassigned {
6732
- }
6733
- /** Assigned Wixel */
6734
- interface WixelAssigned {
6735
- }
6736
- /** Unassigned Wixel */
6737
- interface WixelUnassigned {
6738
- }
6739
- /** Assigned StudioTwo */
6740
- interface StudioTwoAssigned {
6741
- }
6742
- /** Unassigned StudioTwo */
6743
- interface StudioTwoUnassigned {
6744
- }
6745
- /** Media from user domain is enabled. */
6746
- interface UserDomainMediaEnabled {
6747
- }
6748
- /** Media from user domain is disabled. */
6749
- interface UserDomainMediaDisabled {
6750
- }
6751
- /** Assigned Editorless */
6752
- interface EditorlessAssigned {
6753
- }
6754
- /** Unassigned Editorless */
6755
- interface EditorlessUnassigned {
6731
+ payments: PaymentCapture[];
6756
6732
  }
6757
- interface HasCustomEmailConfigurationsRequest {
6733
+ interface PaymentCapture {
6734
+ /**
6735
+ * Payment ID
6736
+ * @format GUID
6737
+ */
6738
+ paymentId?: string | null;
6739
+ /**
6740
+ * Capture amount.
6741
+ * If not provided - full authorized amount will be captured.
6742
+ */
6743
+ amount?: Price;
6758
6744
  }
6759
- interface HasCustomEmailConfigurationsResponse {
6760
- hasCustomConfigurations?: boolean;
6745
+ interface CaptureAuthorizedPaymentsResponse {
6746
+ /** All order's transactions after the capture was triggered */
6747
+ orderTransactions?: OrderTransactions;
6761
6748
  }
6762
- interface AddToAutomationMigrationPopulationRequest {
6763
- /** When true, sends custom email configurations to automation system via email */
6764
- sendCustomEmailConfigs?: boolean;
6765
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6766
- origin?: OriginWithLiterals;
6749
+ interface ChargeSavedPaymentMethodRequest {
6750
+ /**
6751
+ * Ecom Order ID.
6752
+ * @minLength 1
6753
+ * @maxLength 100
6754
+ */
6755
+ ecomOrderId?: string;
6756
+ /** Amount to be charged */
6757
+ amount?: Price;
6767
6758
  }
6768
- declare enum Origin {
6769
- OPT_IN = "OPT_IN",
6770
- MIGRATION = "MIGRATION"
6759
+ interface ChargeSavedPaymentMethodResponse {
6760
+ /** Payment gateway's order ID (e.g Wix Payments) */
6761
+ paymentGatewayOrderId?: string;
6771
6762
  }
6772
- /** @enumType */
6773
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6774
- interface AddToAutomationMigrationPopulationResponse {
6775
- success?: boolean;
6763
+ interface V1TriggerReindexRequest {
6764
+ /** @format GUID */
6765
+ metasiteId?: string;
6766
+ /**
6767
+ * @minLength 1
6768
+ * @maxLength 100
6769
+ * @maxSize 100
6770
+ */
6771
+ orderIds?: string[];
6776
6772
  }
6777
- interface IsInAutomationMigrationPopulationRequest {
6773
+ interface V1TriggerReindexResponse {
6778
6774
  }
6779
- interface IsInAutomationMigrationPopulationResponse {
6780
- inPopulation?: boolean;
6775
+ interface V1TriggerReindexOrderRequest {
6776
+ /** @format GUID */
6777
+ metasiteId?: string;
6778
+ /**
6779
+ * @minLength 1
6780
+ * @maxLength 100
6781
+ */
6782
+ orderId?: string;
6781
6783
  }
6782
6784
  interface DiffmatokyPayload {
6783
6785
  left?: string;
@@ -10599,4 +10601,4 @@ interface BulkUpdateOrderTagsOptions {
10599
10601
  unassignTags?: TagsTags;
10600
10602
  }
10601
10603
 
10602
- 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 };
10604
+ 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 };