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