@wix/auto_sdk_ecom_orders 1.0.280 → 1.0.281

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