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