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