@wix/auto_sdk_ecom_orders 1.0.48 → 1.0.50
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/index.typings.d.ts +42 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/cjs/src/ecom-v1-order-orders.public.d.ts +4 -3
- package/build/cjs/src/ecom-v1-order-orders.public.js +1 -1
- package/build/cjs/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/cjs/src/ecom-v1-order-orders.types.d.ts +181 -61
- package/build/cjs/src/ecom-v1-order-orders.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-order-orders.universal.d.ts +353 -73
- package/build/cjs/src/ecom-v1-order-orders.universal.js +6 -6
- package/build/cjs/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/build/es/index.typings.d.ts +42 -0
- package/build/es/index.typings.js.map +1 -1
- package/build/es/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/es/src/ecom-v1-order-orders.public.d.ts +4 -3
- package/build/es/src/ecom-v1-order-orders.public.js +1 -1
- package/build/es/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/es/src/ecom-v1-order-orders.types.d.ts +181 -61
- package/build/es/src/ecom-v1-order-orders.types.js.map +1 -1
- package/build/es/src/ecom-v1-order-orders.universal.d.ts +353 -73
- package/build/es/src/ecom-v1-order-orders.universal.js +6 -6
- package/build/es/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +42 -0
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.public.d.ts +5 -4
- package/build/internal/cjs/src/ecom-v1-order-orders.public.js +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.types.d.ts +181 -61
- package/build/internal/cjs/src/ecom-v1-order-orders.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.d.ts +359 -74
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.js +6 -6
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/build/internal/es/index.typings.d.ts +42 -0
- package/build/internal/es/index.typings.js.map +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.context.d.ts +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.public.d.ts +5 -4
- package/build/internal/es/src/ecom-v1-order-orders.public.js +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.public.js.map +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.types.d.ts +181 -61
- package/build/internal/es/src/ecom-v1-order-orders.types.js.map +1 -1
- package/build/internal/es/src/ecom-v1-order-orders.universal.d.ts +359 -74
- package/build/internal/es/src/ecom-v1-order-orders.universal.js +6 -6
- package/build/internal/es/src/ecom-v1-order-orders.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { NonNullablePaths } from '@wix/sdk-types';
|
|
1
|
+
import { Search as SearchSdkType, NonNullablePaths, SearchSpec } from '@wix/sdk-types';
|
|
2
2
|
export interface Order {
|
|
3
3
|
/**
|
|
4
4
|
* Order ID.
|
|
@@ -32,19 +32,19 @@ export interface Order {
|
|
|
32
32
|
/** Buyer information. */
|
|
33
33
|
buyerInfo?: BuyerInfo;
|
|
34
34
|
/** Order payment status. */
|
|
35
|
-
paymentStatus?:
|
|
35
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
36
36
|
/**
|
|
37
37
|
* Order fulfillment status.
|
|
38
38
|
* @readonly
|
|
39
39
|
*/
|
|
40
|
-
fulfillmentStatus?:
|
|
40
|
+
fulfillmentStatus?: FulfillmentStatusWithLiterals;
|
|
41
41
|
/**
|
|
42
42
|
* Language for communication with the buyer. Defaults to the site language.
|
|
43
43
|
* For a site that supports multiple languages, this is the language the buyer selected.
|
|
44
44
|
*/
|
|
45
45
|
buyerLanguage?: string | null;
|
|
46
46
|
/** Weight measurement unit - defaults to site's weight unit. */
|
|
47
|
-
weightUnit?:
|
|
47
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
48
48
|
/**
|
|
49
49
|
* Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
50
50
|
* @format CURRENCY
|
|
@@ -78,7 +78,7 @@ export interface Order {
|
|
|
78
78
|
*/
|
|
79
79
|
buyerNote?: string | null;
|
|
80
80
|
/** Order status. */
|
|
81
|
-
status?:
|
|
81
|
+
status?: OrderStatusWithLiterals;
|
|
82
82
|
/** Whether order is archived. */
|
|
83
83
|
archived?: boolean | null;
|
|
84
84
|
/**
|
|
@@ -106,7 +106,7 @@ export interface Order {
|
|
|
106
106
|
*/
|
|
107
107
|
activities?: Activity[];
|
|
108
108
|
/** Order attribution source. */
|
|
109
|
-
attributionSource?:
|
|
109
|
+
attributionSource?: AttributionSourceWithLiterals;
|
|
110
110
|
/**
|
|
111
111
|
* ID of the order's initiator.
|
|
112
112
|
* @readonly
|
|
@@ -248,7 +248,7 @@ export interface OrderLineItem {
|
|
|
248
248
|
*
|
|
249
249
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
250
250
|
*/
|
|
251
|
-
paymentOption?:
|
|
251
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
252
252
|
/**
|
|
253
253
|
* Deprecated. Use `taxInfo` instead.
|
|
254
254
|
* This field will be removed on September 30, 2024.
|
|
@@ -371,6 +371,11 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
371
371
|
colorInfo?: Color;
|
|
372
372
|
/** Description line name. */
|
|
373
373
|
name?: DescriptionLineName;
|
|
374
|
+
/**
|
|
375
|
+
* Whether the description line originates from a modifier.
|
|
376
|
+
* @internal
|
|
377
|
+
*/
|
|
378
|
+
modifierDescriptionLine?: boolean;
|
|
374
379
|
}
|
|
375
380
|
/** @oneof */
|
|
376
381
|
export interface DescriptionLineValueOneOf {
|
|
@@ -434,6 +439,8 @@ export declare enum DescriptionLineType {
|
|
|
434
439
|
/** Color type. */
|
|
435
440
|
COLOR = "COLOR"
|
|
436
441
|
}
|
|
442
|
+
/** @enumType */
|
|
443
|
+
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
437
444
|
export interface FocalPoint {
|
|
438
445
|
/** X-coordinate of the focal point. */
|
|
439
446
|
x?: number;
|
|
@@ -457,14 +464,14 @@ export interface PhysicalProperties {
|
|
|
457
464
|
}
|
|
458
465
|
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
459
466
|
/** Preset item type. */
|
|
460
|
-
preset?:
|
|
467
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
461
468
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
462
469
|
custom?: string;
|
|
463
470
|
}
|
|
464
471
|
/** @oneof */
|
|
465
472
|
export interface ItemTypeItemTypeDataOneOf {
|
|
466
473
|
/** Preset item type. */
|
|
467
|
-
preset?:
|
|
474
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
468
475
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
469
476
|
custom?: string;
|
|
470
477
|
}
|
|
@@ -475,6 +482,8 @@ export declare enum ItemTypeItemType {
|
|
|
475
482
|
GIFT_CARD = "GIFT_CARD",
|
|
476
483
|
SERVICE = "SERVICE"
|
|
477
484
|
}
|
|
485
|
+
/** @enumType */
|
|
486
|
+
export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
478
487
|
/** Type of selected payment option for catalog item */
|
|
479
488
|
export declare enum PaymentOptionType {
|
|
480
489
|
/** The entire payment for this item happens as part of the checkout. */
|
|
@@ -488,6 +497,8 @@ export declare enum PaymentOptionType {
|
|
|
488
497
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
489
498
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
490
499
|
}
|
|
500
|
+
/** @enumType */
|
|
501
|
+
export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
491
502
|
export interface ItemTaxFullDetails {
|
|
492
503
|
/** Taxable amount of this line item. */
|
|
493
504
|
taxableAmount?: Price;
|
|
@@ -553,7 +564,7 @@ export interface LineItemTaxBreakdown {
|
|
|
553
564
|
*/
|
|
554
565
|
taxName?: string | null;
|
|
555
566
|
/** Type of jurisdiction that taxes were calculated for. */
|
|
556
|
-
jurisdictionType?:
|
|
567
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
557
568
|
/** Non-taxable amount of the line item price. */
|
|
558
569
|
nonTaxableAmount?: Price;
|
|
559
570
|
/** Taxable amount of the line item price. */
|
|
@@ -568,6 +579,8 @@ export declare enum JurisdictionType {
|
|
|
568
579
|
CITY = "CITY",
|
|
569
580
|
SPECIAL = "SPECIAL"
|
|
570
581
|
}
|
|
582
|
+
/** @enumType */
|
|
583
|
+
export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
571
584
|
export interface DigitalFile {
|
|
572
585
|
/**
|
|
573
586
|
* ID of the secure file in media.
|
|
@@ -671,7 +684,7 @@ export interface SubscriptionDescription {
|
|
|
671
684
|
}
|
|
672
685
|
export interface SubscriptionSettings {
|
|
673
686
|
/** Frequency of recurring payment. */
|
|
674
|
-
frequency?:
|
|
687
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
675
688
|
/**
|
|
676
689
|
* Interval of recurring payment.
|
|
677
690
|
* @min 1
|
|
@@ -703,9 +716,11 @@ export declare enum SubscriptionFrequency {
|
|
|
703
716
|
MONTH = "MONTH",
|
|
704
717
|
YEAR = "YEAR"
|
|
705
718
|
}
|
|
719
|
+
/** @enumType */
|
|
720
|
+
export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
706
721
|
export interface FreeTrialPeriod {
|
|
707
722
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
708
|
-
frequency?:
|
|
723
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
709
724
|
/**
|
|
710
725
|
* interval of period
|
|
711
726
|
* @min 1
|
|
@@ -715,7 +730,7 @@ export interface FreeTrialPeriod {
|
|
|
715
730
|
}
|
|
716
731
|
export interface BillingAdjustment {
|
|
717
732
|
/** The type of adjustment. */
|
|
718
|
-
type?:
|
|
733
|
+
type?: AdjustmentTypeWithLiterals;
|
|
719
734
|
/** Summary of the prorated adjustment amount. */
|
|
720
735
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
721
736
|
}
|
|
@@ -726,6 +741,8 @@ export declare enum AdjustmentType {
|
|
|
726
741
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
727
742
|
CREDIT = "CREDIT"
|
|
728
743
|
}
|
|
744
|
+
/** @enumType */
|
|
745
|
+
export type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
|
|
729
746
|
export interface BillingAdjustmentPriceSummary {
|
|
730
747
|
/** Subtotal of adjustment, before tax. */
|
|
731
748
|
subtotal?: Price;
|
|
@@ -778,12 +795,12 @@ export interface LocationAndQuantity {
|
|
|
778
795
|
}
|
|
779
796
|
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
780
797
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
781
|
-
addressType?:
|
|
798
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
782
799
|
}
|
|
783
800
|
/** @oneof */
|
|
784
801
|
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
785
802
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
786
|
-
addressType?:
|
|
803
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
787
804
|
}
|
|
788
805
|
export declare enum TaxableAddressType {
|
|
789
806
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
@@ -791,6 +808,8 @@ export declare enum TaxableAddressType {
|
|
|
791
808
|
BILLING = "BILLING",
|
|
792
809
|
SHIPPING = "SHIPPING"
|
|
793
810
|
}
|
|
811
|
+
/** @enumType */
|
|
812
|
+
export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
794
813
|
export interface ExtendedFields {
|
|
795
814
|
/**
|
|
796
815
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
@@ -936,6 +955,8 @@ export declare enum PaymentStatus {
|
|
|
936
955
|
*/
|
|
937
956
|
DECLINED = "DECLINED"
|
|
938
957
|
}
|
|
958
|
+
/** @enumType */
|
|
959
|
+
export type PaymentStatusWithLiterals = PaymentStatus | 'UNSPECIFIED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_REFUNDED' | 'FULLY_REFUNDED' | 'PENDING' | 'PARTIALLY_PAID' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED';
|
|
939
960
|
export declare enum FulfillmentStatus {
|
|
940
961
|
/** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
|
|
941
962
|
NOT_FULFILLED = "NOT_FULFILLED",
|
|
@@ -947,6 +968,8 @@ export declare enum FulfillmentStatus {
|
|
|
947
968
|
/** Some, but not all, of the order items are fulfilled. */
|
|
948
969
|
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
949
970
|
}
|
|
971
|
+
/** @enumType */
|
|
972
|
+
export type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'PARTIALLY_FULFILLED';
|
|
950
973
|
export declare enum WeightUnit {
|
|
951
974
|
/** Weight unit can't be classified due to an error. */
|
|
952
975
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
@@ -955,6 +978,8 @@ export declare enum WeightUnit {
|
|
|
955
978
|
/** Pounds. */
|
|
956
979
|
LB = "LB"
|
|
957
980
|
}
|
|
981
|
+
/** @enumType */
|
|
982
|
+
export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
958
983
|
export interface CurrencyConversionDetails {
|
|
959
984
|
/**
|
|
960
985
|
* Currency used for the pricing of this order, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
@@ -1086,7 +1111,7 @@ export interface VatId {
|
|
|
1086
1111
|
* + `CPF`: for individual tax payers
|
|
1087
1112
|
* + `CNPJ`: for corporations
|
|
1088
1113
|
*/
|
|
1089
|
-
type?:
|
|
1114
|
+
type?: VatTypeWithLiterals;
|
|
1090
1115
|
}
|
|
1091
1116
|
/** tax info types */
|
|
1092
1117
|
export declare enum VatType {
|
|
@@ -1096,6 +1121,8 @@ export declare enum VatType {
|
|
|
1096
1121
|
/** CNPJ - for corporations */
|
|
1097
1122
|
CNPJ = "CNPJ"
|
|
1098
1123
|
}
|
|
1124
|
+
/** @enumType */
|
|
1125
|
+
export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1099
1126
|
export interface V1ShippingInformation {
|
|
1100
1127
|
/**
|
|
1101
1128
|
* App Def Id of external provider which was a source of shipping info
|
|
@@ -1156,7 +1183,7 @@ export interface PickupDetails {
|
|
|
1156
1183
|
/** Pickup address. */
|
|
1157
1184
|
address?: PickupAddress;
|
|
1158
1185
|
/** Pickup method */
|
|
1159
|
-
pickupMethod?:
|
|
1186
|
+
pickupMethod?: PickupMethodWithLiterals;
|
|
1160
1187
|
}
|
|
1161
1188
|
/** Physical address */
|
|
1162
1189
|
export interface PickupAddress {
|
|
@@ -1208,6 +1235,8 @@ export declare enum PickupMethod {
|
|
|
1208
1235
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1209
1236
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1210
1237
|
}
|
|
1238
|
+
/** @enumType */
|
|
1239
|
+
export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1211
1240
|
export interface DeliveryTimeSlot {
|
|
1212
1241
|
/** Delivery slot starting time. */
|
|
1213
1242
|
from?: Date | null;
|
|
@@ -1267,6 +1296,8 @@ export declare enum OrderStatus {
|
|
|
1267
1296
|
*/
|
|
1268
1297
|
REJECTED = "REJECTED"
|
|
1269
1298
|
}
|
|
1299
|
+
/** @enumType */
|
|
1300
|
+
export type OrderStatusWithLiterals = OrderStatus | 'INITIALIZED' | 'APPROVED' | 'CANCELED' | 'PENDING' | 'REJECTED';
|
|
1270
1301
|
export interface TaxSummary {
|
|
1271
1302
|
/**
|
|
1272
1303
|
* Total tax.
|
|
@@ -1311,7 +1342,7 @@ export interface OrderTaxBreakdown {
|
|
|
1311
1342
|
*/
|
|
1312
1343
|
jurisdiction?: string;
|
|
1313
1344
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1314
|
-
jurisdictionType?:
|
|
1345
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
1315
1346
|
/**
|
|
1316
1347
|
* The rate at which this tax detail was calculated.
|
|
1317
1348
|
* @format DECIMAL_VALUE
|
|
@@ -1334,7 +1365,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1334
1365
|
* * `"SPECIFIC-ITEMS"` - discount applies to specific items.
|
|
1335
1366
|
* * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
|
|
1336
1367
|
*/
|
|
1337
|
-
discountType?:
|
|
1368
|
+
discountType?: DiscountTypeWithLiterals;
|
|
1338
1369
|
/**
|
|
1339
1370
|
* IDs of line items discount applies to.
|
|
1340
1371
|
* Deprecated. Use `line_item_discounts` instead.
|
|
@@ -1375,6 +1406,8 @@ export declare enum DiscountType {
|
|
|
1375
1406
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1376
1407
|
SHIPPING = "SHIPPING"
|
|
1377
1408
|
}
|
|
1409
|
+
/** @enumType */
|
|
1410
|
+
export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1378
1411
|
/** Coupon */
|
|
1379
1412
|
export interface Coupon {
|
|
1380
1413
|
/** Coupon ID. */
|
|
@@ -1391,7 +1424,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1391
1424
|
* Pre-defined discount reason (optional).
|
|
1392
1425
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1393
1426
|
*/
|
|
1394
|
-
discountReason?:
|
|
1427
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1395
1428
|
/**
|
|
1396
1429
|
* Discount description as free text (optional).
|
|
1397
1430
|
* @maxLength 200
|
|
@@ -1413,7 +1446,7 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1413
1446
|
* Pre-defined discount reason (optional).
|
|
1414
1447
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1415
1448
|
*/
|
|
1416
|
-
discountReason?:
|
|
1449
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1417
1450
|
/**
|
|
1418
1451
|
* Discount description as free text (optional).
|
|
1419
1452
|
* @maxLength 200
|
|
@@ -1425,6 +1458,8 @@ export declare enum DiscountReason {
|
|
|
1425
1458
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1426
1459
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1427
1460
|
}
|
|
1461
|
+
/** @enumType */
|
|
1462
|
+
export type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
|
|
1428
1463
|
export interface DiscountRule {
|
|
1429
1464
|
/**
|
|
1430
1465
|
* Discount rule ID
|
|
@@ -1538,7 +1573,7 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
1538
1573
|
*/
|
|
1539
1574
|
_createdDate?: Date | null;
|
|
1540
1575
|
/** Activity type. */
|
|
1541
|
-
type?:
|
|
1576
|
+
type?: ActivityTypeWithLiterals;
|
|
1542
1577
|
}
|
|
1543
1578
|
/** @oneof */
|
|
1544
1579
|
export interface ActivityContentOneOf {
|
|
@@ -1735,7 +1770,7 @@ export interface LineItemQuantityChange {
|
|
|
1735
1770
|
*/
|
|
1736
1771
|
diff?: number;
|
|
1737
1772
|
/** Type of quantity change: increase or decrease. */
|
|
1738
|
-
deltaType?:
|
|
1773
|
+
deltaType?: LineItemQuantityChangeTypeWithLiterals;
|
|
1739
1774
|
}
|
|
1740
1775
|
export declare enum LineItemQuantityChangeType {
|
|
1741
1776
|
/** Quantity increased. */
|
|
@@ -1743,6 +1778,8 @@ export declare enum LineItemQuantityChangeType {
|
|
|
1743
1778
|
/** Quantity decreased. */
|
|
1744
1779
|
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
1745
1780
|
}
|
|
1781
|
+
/** @enumType */
|
|
1782
|
+
export type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
|
|
1746
1783
|
export interface LineItemPriceChange {
|
|
1747
1784
|
/** Item price before update. */
|
|
1748
1785
|
originalPrice?: Price;
|
|
@@ -2173,10 +2210,14 @@ export declare enum ActivityType {
|
|
|
2173
2210
|
/** @documentationMaturity preview */
|
|
2174
2211
|
ORDER_REJECTED = "ORDER_REJECTED"
|
|
2175
2212
|
}
|
|
2213
|
+
/** @enumType */
|
|
2214
|
+
export type ActivityTypeWithLiterals = ActivityType | 'ORDER_REFUNDED' | 'ORDER_PLACED' | 'ORDER_PAID' | 'ORDER_FULFILLED' | 'ORDER_NOT_FULFILLED' | 'ORDER_CANCELED' | 'DOWNLOAD_LINK_SENT' | 'TRACKING_NUMBER_ADDED' | 'TRACKING_NUMBER_EDITED' | 'TRACKING_LINK_ADDED' | 'SHIPPING_CONFIRMATION_EMAIL_SENT' | 'INVOICE_ADDED' | 'INVOICE_REMOVED' | 'INVOICE_SENT' | 'FULFILLER_EMAIL_SENT' | 'SHIPPING_ADDRESS_EDITED' | 'EMAIL_EDITED' | 'PICKUP_READY_EMAIL_SENT' | 'CUSTOM_ACTIVITY' | 'MERCHANT_COMMENT' | 'ORDER_CREATED_FROM_EXCHANGE' | 'NEW_EXCHANGE_ORDER_CREATED' | 'ORDER_PARTIALLY_PAID' | 'DRAFT_ORDER_CHANGES_APPLIED' | 'SAVED_PAYMENT_METHOD' | 'PAYMENT_PENDING' | 'PAYMENT_CANCELED' | 'PAYMENT_DECLINED' | 'ORDER_PENDING' | 'ORDER_REJECTED';
|
|
2176
2215
|
export declare enum AttributionSource {
|
|
2177
2216
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2178
2217
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
2179
2218
|
}
|
|
2219
|
+
/** @enumType */
|
|
2220
|
+
export type AttributionSourceWithLiterals = AttributionSource | 'UNSPECIFIED' | 'FACEBOOK_ADS';
|
|
2180
2221
|
export interface CreatedBy extends CreatedByStringOneOf {
|
|
2181
2222
|
/**
|
|
2182
2223
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
@@ -2226,7 +2267,7 @@ export interface CreatedByStringOneOf {
|
|
|
2226
2267
|
}
|
|
2227
2268
|
export interface ChannelInfo {
|
|
2228
2269
|
/** Sales channel that submitted the order. */
|
|
2229
|
-
type?:
|
|
2270
|
+
type?: ChannelTypeWithLiterals;
|
|
2230
2271
|
/**
|
|
2231
2272
|
* Reference to an order ID from an external system.
|
|
2232
2273
|
* @maxLength 100
|
|
@@ -2272,6 +2313,8 @@ export declare enum ChannelType {
|
|
|
2272
2313
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
2273
2314
|
FAIRE_COM = "FAIRE_COM"
|
|
2274
2315
|
}
|
|
2316
|
+
/** @enumType */
|
|
2317
|
+
export type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM';
|
|
2275
2318
|
export interface CustomField {
|
|
2276
2319
|
/** Custom field value. */
|
|
2277
2320
|
value?: any;
|
|
@@ -2545,7 +2588,7 @@ export interface RedirectUrls {
|
|
|
2545
2588
|
}
|
|
2546
2589
|
export interface DelayedCaptureSettings {
|
|
2547
2590
|
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
2548
|
-
scheduledAction?:
|
|
2591
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
2549
2592
|
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
2550
2593
|
delayDuration?: Duration;
|
|
2551
2594
|
}
|
|
@@ -2556,6 +2599,8 @@ export declare enum ScheduledAction {
|
|
|
2556
2599
|
/** Whether payment will be auto-captured when duration passes */
|
|
2557
2600
|
CAPTURE = "CAPTURE"
|
|
2558
2601
|
}
|
|
2602
|
+
/** @enumType */
|
|
2603
|
+
export type ScheduledActionWithLiterals = ScheduledAction | 'UNSPECIFIED' | 'VOID' | 'CAPTURE';
|
|
2559
2604
|
export interface Duration {
|
|
2560
2605
|
/**
|
|
2561
2606
|
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
@@ -2563,7 +2608,7 @@ export interface Duration {
|
|
|
2563
2608
|
*/
|
|
2564
2609
|
count?: number;
|
|
2565
2610
|
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
2566
|
-
unit?:
|
|
2611
|
+
unit?: DurationUnitWithLiterals;
|
|
2567
2612
|
}
|
|
2568
2613
|
export declare enum DurationUnit {
|
|
2569
2614
|
UNKNOWN_DURATION_UNIT = "UNKNOWN_DURATION_UNIT",
|
|
@@ -2571,6 +2616,8 @@ export declare enum DurationUnit {
|
|
|
2571
2616
|
HOURS = "HOURS",
|
|
2572
2617
|
DAYS = "DAYS"
|
|
2573
2618
|
}
|
|
2619
|
+
/** @enumType */
|
|
2620
|
+
export type DurationUnitWithLiterals = DurationUnit | 'UNKNOWN_DURATION_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
2574
2621
|
export interface PreparePaymentCollectionResponse {
|
|
2575
2622
|
/** Payment gateway order id which is associated with given payment */
|
|
2576
2623
|
paymentGatewayOrderId?: string;
|
|
@@ -2585,7 +2632,7 @@ export interface GetPaymentCollectabilityStatusRequest {
|
|
|
2585
2632
|
}
|
|
2586
2633
|
export interface GetPaymentCollectabilityStatusResponse {
|
|
2587
2634
|
/** Payment collectability status */
|
|
2588
|
-
status?:
|
|
2635
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
2589
2636
|
/** Collectable order amount */
|
|
2590
2637
|
amount?: Price;
|
|
2591
2638
|
}
|
|
@@ -2599,6 +2646,8 @@ export declare enum PaymentCollectabilityStatus {
|
|
|
2599
2646
|
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
2600
2647
|
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
|
|
2601
2648
|
}
|
|
2649
|
+
/** @enumType */
|
|
2650
|
+
export 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';
|
|
2602
2651
|
export interface RecordManuallyCollectedPaymentRequest {
|
|
2603
2652
|
/**
|
|
2604
2653
|
* Order ID.
|
|
@@ -2628,7 +2677,7 @@ export interface PaymentStatusUpdated {
|
|
|
2628
2677
|
/** The order that was updated */
|
|
2629
2678
|
order?: Order;
|
|
2630
2679
|
/** The previous status (before the update) */
|
|
2631
|
-
previousPaymentStatus?:
|
|
2680
|
+
previousPaymentStatus?: PaymentStatusWithLiterals;
|
|
2632
2681
|
}
|
|
2633
2682
|
export interface BulkMarkOrdersAsPaidRequest {
|
|
2634
2683
|
/**
|
|
@@ -2707,28 +2756,30 @@ export interface GetRefundabilityStatusResponse {
|
|
|
2707
2756
|
}
|
|
2708
2757
|
export interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2709
2758
|
/** Reason why payment is not refundable. */
|
|
2710
|
-
nonRefundableReason?:
|
|
2759
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2711
2760
|
/** Reason why payment is only refundable manually. */
|
|
2712
|
-
manuallyRefundableReason?:
|
|
2761
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
2713
2762
|
/** Payment ID. */
|
|
2714
2763
|
paymentId?: string;
|
|
2715
2764
|
/** Payment refundability status. */
|
|
2716
|
-
refundabilityStatus?:
|
|
2765
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
2717
2766
|
/** Link to payment provider dashboard. */
|
|
2718
2767
|
providerLink?: string | null;
|
|
2719
2768
|
}
|
|
2720
2769
|
/** @oneof */
|
|
2721
2770
|
export interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
2722
2771
|
/** Reason why payment is not refundable. */
|
|
2723
|
-
nonRefundableReason?:
|
|
2772
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
2724
2773
|
/** Reason why payment is only refundable manually. */
|
|
2725
|
-
manuallyRefundableReason?:
|
|
2774
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
2726
2775
|
}
|
|
2727
2776
|
export declare enum RefundableStatus {
|
|
2728
2777
|
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
2729
2778
|
MANUAL = "MANUAL",
|
|
2730
2779
|
REFUNDABLE = "REFUNDABLE"
|
|
2731
2780
|
}
|
|
2781
|
+
/** @enumType */
|
|
2782
|
+
export type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
2732
2783
|
export declare enum NonRefundableReason {
|
|
2733
2784
|
NONE = "NONE",
|
|
2734
2785
|
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
@@ -2744,12 +2795,16 @@ export declare enum NonRefundableReason {
|
|
|
2744
2795
|
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
2745
2796
|
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
2746
2797
|
}
|
|
2798
|
+
/** @enumType */
|
|
2799
|
+
export 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';
|
|
2747
2800
|
export declare enum ManuallyRefundableReason {
|
|
2748
2801
|
EXPIRED = "EXPIRED",
|
|
2749
2802
|
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
2750
2803
|
OFFLINE = "OFFLINE",
|
|
2751
2804
|
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
2752
2805
|
}
|
|
2806
|
+
/** @enumType */
|
|
2807
|
+
export type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
2753
2808
|
export interface CreatePaymentGatewayOrderRequest {
|
|
2754
2809
|
/**
|
|
2755
2810
|
* Ecom order ID.
|
|
@@ -2981,7 +3036,7 @@ export interface RefundSideEffects {
|
|
|
2981
3036
|
}
|
|
2982
3037
|
export interface RestockInfo {
|
|
2983
3038
|
/** Restock type. */
|
|
2984
|
-
type?:
|
|
3039
|
+
type?: RestockTypeWithLiterals;
|
|
2985
3040
|
/**
|
|
2986
3041
|
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
2987
3042
|
* @maxSize 300
|
|
@@ -2993,6 +3048,8 @@ export declare enum RestockType {
|
|
|
2993
3048
|
ALL_ITEMS = "ALL_ITEMS",
|
|
2994
3049
|
SOME_ITEMS = "SOME_ITEMS"
|
|
2995
3050
|
}
|
|
3051
|
+
/** @enumType */
|
|
3052
|
+
export type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
2996
3053
|
export interface RestockItem {
|
|
2997
3054
|
/**
|
|
2998
3055
|
* ID of the line item being restocked.
|
|
@@ -3124,7 +3181,7 @@ export interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMetho
|
|
|
3124
3181
|
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
3125
3182
|
offlinePayment?: boolean;
|
|
3126
3183
|
/** Payment status. */
|
|
3127
|
-
status?:
|
|
3184
|
+
status?: TransactionStatusWithLiterals;
|
|
3128
3185
|
/**
|
|
3129
3186
|
* Whether there is a payment agreement that allows for future charges.
|
|
3130
3187
|
* @immutable
|
|
@@ -3156,6 +3213,8 @@ export declare enum TransactionStatus {
|
|
|
3156
3213
|
AUTHORIZED = "AUTHORIZED",
|
|
3157
3214
|
VOIDED = "VOIDED"
|
|
3158
3215
|
}
|
|
3216
|
+
/** @enumType */
|
|
3217
|
+
export type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
3159
3218
|
export interface CreditCardPaymentMethodDetails {
|
|
3160
3219
|
/**
|
|
3161
3220
|
* The last 4 digits of the card number.
|
|
@@ -3195,7 +3254,7 @@ export interface AuthorizationCapture {
|
|
|
3195
3254
|
*/
|
|
3196
3255
|
_id?: string | null;
|
|
3197
3256
|
/** Status of this capture action */
|
|
3198
|
-
status?:
|
|
3257
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
3199
3258
|
/**
|
|
3200
3259
|
* Amount of this capture
|
|
3201
3260
|
* @immutable
|
|
@@ -3215,19 +3274,21 @@ export declare enum AuthorizationCaptureStatus {
|
|
|
3215
3274
|
/** Capture operation failed. */
|
|
3216
3275
|
FAILED = "FAILED"
|
|
3217
3276
|
}
|
|
3277
|
+
/** @enumType */
|
|
3278
|
+
export type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3218
3279
|
export interface AuthorizationActionFailureDetails {
|
|
3219
3280
|
/** @maxLength 100 */
|
|
3220
3281
|
failureCode?: string;
|
|
3221
3282
|
}
|
|
3222
3283
|
export interface AuthorizationVoid {
|
|
3223
3284
|
/** Status of this void action */
|
|
3224
|
-
status?:
|
|
3285
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
3225
3286
|
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
3226
3287
|
voidedDate?: Date | null;
|
|
3227
3288
|
/** In case of status is FAILED may contain failure details */
|
|
3228
3289
|
failureDetails?: AuthorizationActionFailureDetails;
|
|
3229
3290
|
/** Reason of void action */
|
|
3230
|
-
reason?:
|
|
3291
|
+
reason?: ReasonWithLiterals;
|
|
3231
3292
|
}
|
|
3232
3293
|
export declare enum AuthorizationVoidStatus {
|
|
3233
3294
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
@@ -3238,6 +3299,8 @@ export declare enum AuthorizationVoidStatus {
|
|
|
3238
3299
|
/** Void operation failed. */
|
|
3239
3300
|
FAILED = "FAILED"
|
|
3240
3301
|
}
|
|
3302
|
+
/** @enumType */
|
|
3303
|
+
export type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
3241
3304
|
/** Reason the authorization was voided. */
|
|
3242
3305
|
export declare enum Reason {
|
|
3243
3306
|
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
@@ -3246,9 +3309,11 @@ export declare enum Reason {
|
|
|
3246
3309
|
/** Authorization passed execution date. */
|
|
3247
3310
|
SCHEDULED = "SCHEDULED"
|
|
3248
3311
|
}
|
|
3312
|
+
/** @enumType */
|
|
3313
|
+
export type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
|
|
3249
3314
|
export interface V1ScheduledAction {
|
|
3250
3315
|
/** Type of the action. */
|
|
3251
|
-
actionType?:
|
|
3316
|
+
actionType?: ActionTypeWithLiterals;
|
|
3252
3317
|
/** The date and time of the action. */
|
|
3253
3318
|
executionDate?: Date | null;
|
|
3254
3319
|
}
|
|
@@ -3257,6 +3322,8 @@ export declare enum ActionType {
|
|
|
3257
3322
|
VOID = "VOID",
|
|
3258
3323
|
CAPTURE = "CAPTURE"
|
|
3259
3324
|
}
|
|
3325
|
+
/** @enumType */
|
|
3326
|
+
export type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
|
|
3260
3327
|
export interface GiftCardPaymentDetails {
|
|
3261
3328
|
/**
|
|
3262
3329
|
* Gift card payment ID.
|
|
@@ -3296,7 +3363,7 @@ export interface MembershipPaymentDetails {
|
|
|
3296
3363
|
*/
|
|
3297
3364
|
lineItemId?: string;
|
|
3298
3365
|
/** Payment status. */
|
|
3299
|
-
status?:
|
|
3366
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
3300
3367
|
/** Membership name. */
|
|
3301
3368
|
name?: MembershipName;
|
|
3302
3369
|
/**
|
|
@@ -3322,6 +3389,8 @@ export declare enum MembershipPaymentStatus {
|
|
|
3322
3389
|
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
3323
3390
|
CHARGE_FAILED = "CHARGE_FAILED"
|
|
3324
3391
|
}
|
|
3392
|
+
/** @enumType */
|
|
3393
|
+
export type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED';
|
|
3325
3394
|
export interface WixReceiptInfo {
|
|
3326
3395
|
/**
|
|
3327
3396
|
* Receipt ID
|
|
@@ -3399,7 +3468,7 @@ export interface RefundTransaction {
|
|
|
3399
3468
|
*/
|
|
3400
3469
|
amount?: Price;
|
|
3401
3470
|
/** Refund status. */
|
|
3402
|
-
refundStatus?:
|
|
3471
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
3403
3472
|
/** Optional details of current refund status. */
|
|
3404
3473
|
refundStatusInfo?: RefundStatusInfo;
|
|
3405
3474
|
/**
|
|
@@ -3429,6 +3498,8 @@ export declare enum RefundStatus {
|
|
|
3429
3498
|
/** Refund was initiated on payment provider side. */
|
|
3430
3499
|
STARTED = "STARTED"
|
|
3431
3500
|
}
|
|
3501
|
+
/** @enumType */
|
|
3502
|
+
export type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
3432
3503
|
export interface RefundStatusInfo {
|
|
3433
3504
|
/**
|
|
3434
3505
|
* Reason code for the refund's current status.
|
|
@@ -3696,7 +3767,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3696
3767
|
*/
|
|
3697
3768
|
appId?: string;
|
|
3698
3769
|
/** @readonly */
|
|
3699
|
-
identityType?:
|
|
3770
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3700
3771
|
}
|
|
3701
3772
|
/** @oneof */
|
|
3702
3773
|
export interface IdentificationDataIdOneOf {
|
|
@@ -3728,6 +3799,8 @@ export declare enum WebhookIdentityType {
|
|
|
3728
3799
|
WIX_USER = "WIX_USER",
|
|
3729
3800
|
APP = "APP"
|
|
3730
3801
|
}
|
|
3802
|
+
/** @enumType */
|
|
3803
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3731
3804
|
export declare enum TextDetection {
|
|
3732
3805
|
/** No detection was made */
|
|
3733
3806
|
UNKNOWN_TEXT_DETECTION = "UNKNOWN_TEXT_DETECTION",
|
|
@@ -3736,6 +3809,8 @@ export declare enum TextDetection {
|
|
|
3736
3809
|
/** The image does not contain text */
|
|
3737
3810
|
NO_TEXT = "NO_TEXT"
|
|
3738
3811
|
}
|
|
3812
|
+
/** @enumType */
|
|
3813
|
+
export type TextDetectionWithLiterals = TextDetection | 'UNKNOWN_TEXT_DETECTION' | 'CONTAINS_TEXT' | 'NO_TEXT';
|
|
3739
3814
|
export declare enum AnimationDetection {
|
|
3740
3815
|
/** No detection was made */
|
|
3741
3816
|
UNKNOWN_ANIMATION_DETECTION = "UNKNOWN_ANIMATION_DETECTION",
|
|
@@ -3744,11 +3819,13 @@ export declare enum AnimationDetection {
|
|
|
3744
3819
|
/** The image does not contain animation */
|
|
3745
3820
|
NO_ANIMATION = "NO_ANIMATION"
|
|
3746
3821
|
}
|
|
3822
|
+
/** @enumType */
|
|
3823
|
+
export type AnimationDetectionWithLiterals = AnimationDetection | 'UNKNOWN_ANIMATION_DETECTION' | 'CONTAINS_ANIMATION' | 'NO_ANIMATION';
|
|
3747
3824
|
export interface ImageContent {
|
|
3748
3825
|
/** Text detection */
|
|
3749
|
-
text?:
|
|
3826
|
+
text?: TextDetectionWithLiterals;
|
|
3750
3827
|
/** Animation detection */
|
|
3751
|
-
animation?:
|
|
3828
|
+
animation?: AnimationDetectionWithLiterals;
|
|
3752
3829
|
}
|
|
3753
3830
|
export interface SendBuyerConfirmationEmailRequest {
|
|
3754
3831
|
/** @format GUID */
|
|
@@ -3865,7 +3942,7 @@ export interface SendMerchantOrderReceivedPushRequest {
|
|
|
3865
3942
|
export interface SendMerchantOrderReceivedPushResponse {
|
|
3866
3943
|
}
|
|
3867
3944
|
export interface PreviewEmailByTypeRequest {
|
|
3868
|
-
emailType?:
|
|
3945
|
+
emailType?: PreviewEmailTypeWithLiterals;
|
|
3869
3946
|
}
|
|
3870
3947
|
export declare enum PreviewEmailType {
|
|
3871
3948
|
ORDER_PLACED = "ORDER_PLACED",
|
|
@@ -3873,6 +3950,8 @@ export declare enum PreviewEmailType {
|
|
|
3873
3950
|
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
3874
3951
|
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
3875
3952
|
}
|
|
3953
|
+
/** @enumType */
|
|
3954
|
+
export type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
3876
3955
|
export interface PreviewEmailByTypeResponse {
|
|
3877
3956
|
emailPreview?: string;
|
|
3878
3957
|
}
|
|
@@ -4042,7 +4121,7 @@ export interface MetaSite {
|
|
|
4042
4121
|
*/
|
|
4043
4122
|
apps?: App[];
|
|
4044
4123
|
/** Namespace of meta site. */
|
|
4045
|
-
namespace?:
|
|
4124
|
+
namespace?: NamespaceWithLiterals;
|
|
4046
4125
|
/**
|
|
4047
4126
|
* Indicates whether https should be used for viewing a site.
|
|
4048
4127
|
*
|
|
@@ -4143,7 +4222,7 @@ export interface App {
|
|
|
4143
4222
|
* State of this app (see docs for state).
|
|
4144
4223
|
* @readonly
|
|
4145
4224
|
*/
|
|
4146
|
-
state?:
|
|
4225
|
+
state?: StateWithLiterals;
|
|
4147
4226
|
/**
|
|
4148
4227
|
* Identifier of the originating application. For example, if this app was part of a template,
|
|
4149
4228
|
* then an app will get instance_id of that app as origin instance id.
|
|
@@ -4170,6 +4249,8 @@ export declare enum State {
|
|
|
4170
4249
|
/** App is not installed, there is a user intention for it only (user will see the pimpl in the editor). */
|
|
4171
4250
|
PENDING = "PENDING"
|
|
4172
4251
|
}
|
|
4252
|
+
/** @enumType */
|
|
4253
|
+
export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'TEMPLATE' | 'PENDING';
|
|
4173
4254
|
export declare enum Namespace {
|
|
4174
4255
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
4175
4256
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
@@ -4252,6 +4333,8 @@ export declare enum Namespace {
|
|
|
4252
4333
|
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
4253
4334
|
MIMIR = "MIMIR"
|
|
4254
4335
|
}
|
|
4336
|
+
/** @enumType */
|
|
4337
|
+
export 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';
|
|
4255
4338
|
export interface SeoData {
|
|
4256
4339
|
/**
|
|
4257
4340
|
* A title.
|
|
@@ -4377,12 +4460,14 @@ export interface Sorting {
|
|
|
4377
4460
|
*/
|
|
4378
4461
|
fieldName?: string;
|
|
4379
4462
|
/** Sort order. */
|
|
4380
|
-
order?:
|
|
4463
|
+
order?: SortOrderWithLiterals;
|
|
4381
4464
|
}
|
|
4382
4465
|
export declare enum SortOrder {
|
|
4383
4466
|
ASC = "ASC",
|
|
4384
4467
|
DESC = "DESC"
|
|
4385
4468
|
}
|
|
4469
|
+
/** @enumType */
|
|
4470
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
4386
4471
|
export interface PlatformPaging {
|
|
4387
4472
|
/**
|
|
4388
4473
|
* Number of items to load.
|
|
@@ -4496,6 +4581,7 @@ export interface GetOrderOutOfBoxRequest {
|
|
|
4496
4581
|
}
|
|
4497
4582
|
export interface GetOrderOutOfBoxResponse {
|
|
4498
4583
|
/**
|
|
4584
|
+
* Order id if found
|
|
4499
4585
|
* @minLength 1
|
|
4500
4586
|
* @maxLength 100
|
|
4501
4587
|
*/
|
|
@@ -4511,6 +4597,23 @@ export interface GetOrderAgcRequest {
|
|
|
4511
4597
|
}
|
|
4512
4598
|
export interface GetOrderAgcResponse {
|
|
4513
4599
|
/**
|
|
4600
|
+
* Order id if found
|
|
4601
|
+
* @minLength 1
|
|
4602
|
+
* @maxLength 100
|
|
4603
|
+
*/
|
|
4604
|
+
orderId?: string;
|
|
4605
|
+
}
|
|
4606
|
+
export interface GetOrderWithFilterByLocationRequest {
|
|
4607
|
+
/**
|
|
4608
|
+
* Order Id for EP order to retrieve
|
|
4609
|
+
* @minLength 1
|
|
4610
|
+
* @maxLength 100
|
|
4611
|
+
*/
|
|
4612
|
+
_id?: string;
|
|
4613
|
+
}
|
|
4614
|
+
export interface GetOrderWithFilterByLocationResponse {
|
|
4615
|
+
/**
|
|
4616
|
+
* Order id if found
|
|
4514
4617
|
* @minLength 1
|
|
4515
4618
|
* @maxLength 100
|
|
4516
4619
|
*/
|
|
@@ -4603,7 +4706,7 @@ export interface VersionedDocumentUpdateOperation {
|
|
|
4603
4706
|
/** documents to create or overwrite */
|
|
4604
4707
|
documents?: InternalDocument[];
|
|
4605
4708
|
/** versioning mode to use instead of default */
|
|
4606
|
-
versioningMode?:
|
|
4709
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
4607
4710
|
}
|
|
4608
4711
|
export declare enum VersioningMode {
|
|
4609
4712
|
/** use default versioning mode agreed with search team */
|
|
@@ -4613,6 +4716,8 @@ export declare enum VersioningMode {
|
|
|
4613
4716
|
/** execute only if version is greater or equal to existing */
|
|
4614
4717
|
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
4615
4718
|
}
|
|
4719
|
+
/** @enumType */
|
|
4720
|
+
export type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
4616
4721
|
export interface VersionedDeleteByIdsOperation {
|
|
4617
4722
|
/** ids with version of the documents to delete */
|
|
4618
4723
|
documentIds?: VersionedDocumentId[];
|
|
@@ -4623,7 +4728,7 @@ export interface VersionedDocumentId {
|
|
|
4623
4728
|
/** document version */
|
|
4624
4729
|
version?: string;
|
|
4625
4730
|
/** versioning mode to use instead of default */
|
|
4626
|
-
versioningMode?:
|
|
4731
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
4627
4732
|
}
|
|
4628
4733
|
export interface TriggerReindexRequest {
|
|
4629
4734
|
/** @format GUID */
|
|
@@ -4760,7 +4865,7 @@ export interface OrderCreationSettings {
|
|
|
4760
4865
|
* Condition for the order to be approved.
|
|
4761
4866
|
* Default: `DEFAULT`
|
|
4762
4867
|
*/
|
|
4763
|
-
orderApprovalStrategy?:
|
|
4868
|
+
orderApprovalStrategy?: OrderApprovalStrategyWithLiterals;
|
|
4764
4869
|
/** Notification settings to be applied on order creation */
|
|
4765
4870
|
notifications?: OrderCreateNotifications;
|
|
4766
4871
|
}
|
|
@@ -4772,6 +4877,8 @@ export declare enum OrderApprovalStrategy {
|
|
|
4772
4877
|
/** Order is automatically approved when payment method is saved for it. */
|
|
4773
4878
|
PAYMENT_METHOD_SAVED = "PAYMENT_METHOD_SAVED"
|
|
4774
4879
|
}
|
|
4880
|
+
/** @enumType */
|
|
4881
|
+
export type OrderApprovalStrategyWithLiterals = OrderApprovalStrategy | 'DEFAULT' | 'PAYMENT_RECEIVED' | 'PAYMENT_METHOD_SAVED';
|
|
4775
4882
|
export interface OrderCreateNotifications {
|
|
4776
4883
|
/**
|
|
4777
4884
|
* Whether to send notification to the buyer.
|
|
@@ -5031,7 +5138,7 @@ export interface OrderLineItemChangedDetails {
|
|
|
5031
5138
|
* + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
5032
5139
|
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
5033
5140
|
*/
|
|
5034
|
-
paymentOption?:
|
|
5141
|
+
paymentOption?: DeltaPaymentOptionTypeWithLiterals;
|
|
5035
5142
|
/**
|
|
5036
5143
|
* Deprecated. Use `taxInfo` instead.
|
|
5037
5144
|
* This field will be removed on September 30, 2024.
|
|
@@ -5084,6 +5191,8 @@ export declare enum DeltaPaymentOptionType {
|
|
|
5084
5191
|
*/
|
|
5085
5192
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
5086
5193
|
}
|
|
5194
|
+
/** @enumType */
|
|
5195
|
+
export type DeltaPaymentOptionTypeWithLiterals = DeltaPaymentOptionType | 'UNKNOWN_PAYMENT_OPTION' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP_OFFLINE';
|
|
5087
5196
|
export interface ItemChangedDetails {
|
|
5088
5197
|
/**
|
|
5089
5198
|
* The quantity before the change.
|
|
@@ -5141,7 +5250,7 @@ export interface DraftOrderCommitSettings {
|
|
|
5141
5250
|
}
|
|
5142
5251
|
export interface InventoryUpdateDetails {
|
|
5143
5252
|
/** Action to be applied - decrease or restock */
|
|
5144
|
-
actionType?:
|
|
5253
|
+
actionType?: InventoryActionWithLiterals;
|
|
5145
5254
|
/** Order line item id */
|
|
5146
5255
|
lineItemId?: string;
|
|
5147
5256
|
/** The amount to be increased or restocked */
|
|
@@ -5153,6 +5262,8 @@ export declare enum InventoryAction {
|
|
|
5153
5262
|
/** Decrease inventory. Without failing on negative inventory. */
|
|
5154
5263
|
DECREASE = "DECREASE"
|
|
5155
5264
|
}
|
|
5265
|
+
/** @enumType */
|
|
5266
|
+
export type InventoryActionWithLiterals = InventoryAction | 'RESTOCK' | 'DECREASE';
|
|
5156
5267
|
export interface CommitDeltasResponse {
|
|
5157
5268
|
/** Order after deltas are applied */
|
|
5158
5269
|
order?: Order;
|
|
@@ -5858,7 +5969,7 @@ export interface UpdateOrderStatusRequest {
|
|
|
5858
5969
|
*/
|
|
5859
5970
|
orderId: string;
|
|
5860
5971
|
/** New order status. */
|
|
5861
|
-
status:
|
|
5972
|
+
status: OrderStatusWithLiterals;
|
|
5862
5973
|
}
|
|
5863
5974
|
export interface UpdateOrderStatusResponse {
|
|
5864
5975
|
/** Updated order. */
|
|
@@ -5881,9 +5992,9 @@ export interface FulfillmentStatusUpdated {
|
|
|
5881
5992
|
/** The order that was updated */
|
|
5882
5993
|
order?: Order;
|
|
5883
5994
|
/** The previous status (before the update) */
|
|
5884
|
-
previousFulfillmentStatus?:
|
|
5995
|
+
previousFulfillmentStatus?: FulfillmentStatusWithLiterals;
|
|
5885
5996
|
/** the new status (after the update) */
|
|
5886
|
-
newFulfillmentStatus?:
|
|
5997
|
+
newFulfillmentStatus?: FulfillmentStatusWithLiterals;
|
|
5887
5998
|
/** the action that caused this update */
|
|
5888
5999
|
action?: string;
|
|
5889
6000
|
}
|
|
@@ -6138,7 +6249,7 @@ export interface InvoiceSentEvent {
|
|
|
6138
6249
|
/** @readonly */
|
|
6139
6250
|
data?: InvoiceFields;
|
|
6140
6251
|
/** @readonly */
|
|
6141
|
-
status?:
|
|
6252
|
+
status?: InvoiceStatusWithLiterals;
|
|
6142
6253
|
}
|
|
6143
6254
|
export interface IdAndVersion {
|
|
6144
6255
|
/** @format GUID */
|
|
@@ -6242,7 +6353,7 @@ export interface QuotesAddress {
|
|
|
6242
6353
|
}
|
|
6243
6354
|
export interface AddressDescription {
|
|
6244
6355
|
content?: string;
|
|
6245
|
-
placement?:
|
|
6356
|
+
placement?: PlacementWithLiterals;
|
|
6246
6357
|
}
|
|
6247
6358
|
export declare enum Placement {
|
|
6248
6359
|
Unknown = "Unknown",
|
|
@@ -6250,6 +6361,8 @@ export declare enum Placement {
|
|
|
6250
6361
|
Before = "Before",
|
|
6251
6362
|
After = "After"
|
|
6252
6363
|
}
|
|
6364
|
+
/** @enumType */
|
|
6365
|
+
export type PlacementWithLiterals = Placement | 'Unknown' | 'Replace' | 'Before' | 'After';
|
|
6253
6366
|
export interface Phone {
|
|
6254
6367
|
number?: string;
|
|
6255
6368
|
}
|
|
@@ -6305,6 +6418,8 @@ export declare enum SubdivisionType {
|
|
|
6305
6418
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
6306
6419
|
COUNTRY = "COUNTRY"
|
|
6307
6420
|
}
|
|
6421
|
+
/** @enumType */
|
|
6422
|
+
export type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
6308
6423
|
/** Subdivision Concordance values */
|
|
6309
6424
|
export interface StandardDetails {
|
|
6310
6425
|
/**
|
|
@@ -6361,7 +6476,7 @@ export interface Source {
|
|
|
6361
6476
|
* App or service type.
|
|
6362
6477
|
* @readonly
|
|
6363
6478
|
*/
|
|
6364
|
-
sourceType?:
|
|
6479
|
+
sourceType?: SourceTypeWithLiterals;
|
|
6365
6480
|
}
|
|
6366
6481
|
export declare enum SourceType {
|
|
6367
6482
|
UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
|
|
@@ -6370,6 +6485,8 @@ export declare enum SourceType {
|
|
|
6370
6485
|
ADMIN = "ADMIN",
|
|
6371
6486
|
OTHER = "OTHER"
|
|
6372
6487
|
}
|
|
6488
|
+
/** @enumType */
|
|
6489
|
+
export type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'WIX_APP' | 'EXTERNAL' | 'ADMIN' | 'OTHER';
|
|
6373
6490
|
export interface LineItemMetaData {
|
|
6374
6491
|
metadata?: Record<string, string>;
|
|
6375
6492
|
}
|
|
@@ -6468,7 +6585,7 @@ export interface CustomFieldValue {
|
|
|
6468
6585
|
/** The optional namespace of the custom field value. This field may be used to indicate intended usage or source. */
|
|
6469
6586
|
namespace?: string | null;
|
|
6470
6587
|
/** The group of the custom field indicates its intended placement in the financial document */
|
|
6471
|
-
group?:
|
|
6588
|
+
group?: CustomFieldGroupWithLiterals;
|
|
6472
6589
|
/** The value of the custom field */
|
|
6473
6590
|
value?: Value;
|
|
6474
6591
|
/**
|
|
@@ -6485,9 +6602,11 @@ export declare enum CustomFieldGroup {
|
|
|
6485
6602
|
FOOTER = "FOOTER",
|
|
6486
6603
|
OTHER = "OTHER"
|
|
6487
6604
|
}
|
|
6605
|
+
/** @enumType */
|
|
6606
|
+
export type CustomFieldGroupWithLiterals = CustomFieldGroup | 'UNKNOWN_CUSTOM_FIELD_GROUP' | 'BUSINESS_DETAILS' | 'CUSTOMER_DETAILS' | 'DOCUMENT' | 'FOOTER' | 'OTHER';
|
|
6488
6607
|
export interface Value {
|
|
6489
6608
|
value?: string;
|
|
6490
|
-
valueType?:
|
|
6609
|
+
valueType?: ValueTypeWithLiterals;
|
|
6491
6610
|
}
|
|
6492
6611
|
export declare enum ValueType {
|
|
6493
6612
|
UNKNOWN_VALUE_TYPE = "UNKNOWN_VALUE_TYPE",
|
|
@@ -6496,6 +6615,8 @@ export declare enum ValueType {
|
|
|
6496
6615
|
BOOLEAN = "BOOLEAN",
|
|
6497
6616
|
NUMBER = "NUMBER"
|
|
6498
6617
|
}
|
|
6618
|
+
/** @enumType */
|
|
6619
|
+
export type ValueTypeWithLiterals = ValueType | 'UNKNOWN_VALUE_TYPE' | 'STRING' | 'DATE' | 'BOOLEAN' | 'NUMBER';
|
|
6499
6620
|
export interface Deposit {
|
|
6500
6621
|
/**
|
|
6501
6622
|
* The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total.
|
|
@@ -6512,13 +6633,15 @@ export interface Deposit {
|
|
|
6512
6633
|
*/
|
|
6513
6634
|
percentage?: string;
|
|
6514
6635
|
/** The type of the deposit. The default is FLAT. */
|
|
6515
|
-
type?:
|
|
6636
|
+
type?: DepositTypeWithLiterals;
|
|
6516
6637
|
}
|
|
6517
6638
|
export declare enum DepositType {
|
|
6518
6639
|
UNKNOWN = "UNKNOWN",
|
|
6519
6640
|
FLAT = "FLAT",
|
|
6520
6641
|
PERCENTAGE = "PERCENTAGE"
|
|
6521
6642
|
}
|
|
6643
|
+
/** @enumType */
|
|
6644
|
+
export type DepositTypeWithLiterals = DepositType | 'UNKNOWN' | 'FLAT' | 'PERCENTAGE';
|
|
6522
6645
|
/**
|
|
6523
6646
|
* InvoiceStatus allowed transitions based on current status:
|
|
6524
6647
|
* Draft -> Deleted, Paid, Partially Paid, Sent
|
|
@@ -6540,6 +6663,8 @@ export declare enum InvoiceStatus {
|
|
|
6540
6663
|
PartiallyPaid = "PartiallyPaid",
|
|
6541
6664
|
PartialAndOverdue = "PartialAndOverdue"
|
|
6542
6665
|
}
|
|
6666
|
+
/** @enumType */
|
|
6667
|
+
export type InvoiceStatusWithLiterals = InvoiceStatus | 'Draft' | 'Sent' | 'Processing' | 'Paid' | 'Overdue' | 'Void' | 'Deleted' | 'PartiallyPaid' | 'PartialAndOverdue';
|
|
6543
6668
|
export interface TriggerSideEffectsFromLegacyData {
|
|
6544
6669
|
storeId?: string;
|
|
6545
6670
|
orderId?: string;
|
|
@@ -7065,7 +7190,9 @@ export declare function getOrder(_id: string): Promise<NonNullablePaths<Order, O
|
|
|
7065
7190
|
* To learn about working with _Search_ endpoints, see
|
|
7066
7191
|
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language), and
|
|
7067
7192
|
* [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
7193
|
+
* @param search - Search options.
|
|
7068
7194
|
* @public
|
|
7195
|
+
* @requiredField search
|
|
7069
7196
|
* @permissionId ECOM.READ_ORDERS
|
|
7070
7197
|
* @permissionScope Manage Stores - all permissions
|
|
7071
7198
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
@@ -7086,13 +7213,171 @@ export declare function getOrder(_id: string): Promise<NonNullablePaths<Order, O
|
|
|
7086
7213
|
* @applicableIdentity APP
|
|
7087
7214
|
* @fqn com.wix.ecom.orders.v1.Orders.SearchOrders
|
|
7088
7215
|
*/
|
|
7089
|
-
export declare function searchOrders(
|
|
7216
|
+
export declare function searchOrders(search: OrderSearch): Promise<NonNullablePaths<SearchOrdersResponse, {
|
|
7090
7217
|
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
7091
7218
|
}[OrderNonNullablePaths]>>;
|
|
7092
|
-
export interface
|
|
7093
|
-
|
|
7094
|
-
|
|
7095
|
-
|
|
7219
|
+
export interface OrderSearchSpec extends SearchSpec {
|
|
7220
|
+
aggregatable: [
|
|
7221
|
+
'_createdDate',
|
|
7222
|
+
'_id',
|
|
7223
|
+
'_updatedDate',
|
|
7224
|
+
'archived',
|
|
7225
|
+
'balanceSummary.authorized.amount',
|
|
7226
|
+
'balanceSummary.pending.amount',
|
|
7227
|
+
'balanceSummary.pendingRefund.amount',
|
|
7228
|
+
'businessLocation._id',
|
|
7229
|
+
'businessLocation.name',
|
|
7230
|
+
'buyerInfo.contactId',
|
|
7231
|
+
'buyerInfo.memberId',
|
|
7232
|
+
'channelInfo.externalOrderId',
|
|
7233
|
+
'channelInfo.type',
|
|
7234
|
+
'checkoutId',
|
|
7235
|
+
'createdBy.userId',
|
|
7236
|
+
'fulfillmentStatus',
|
|
7237
|
+
'fulfillmentStatusesAggregate.statuses',
|
|
7238
|
+
'lineItems.catalogReference.appId',
|
|
7239
|
+
'lineItems.catalogReference.catalogItemId',
|
|
7240
|
+
'lineItems.locations._id',
|
|
7241
|
+
'lineItems.productName.original',
|
|
7242
|
+
'lineItems.subscriptionInfo._id',
|
|
7243
|
+
'number',
|
|
7244
|
+
'paymentStatus',
|
|
7245
|
+
'priceSummary.total.amount',
|
|
7246
|
+
'purchasedDate',
|
|
7247
|
+
'seenByAHuman',
|
|
7248
|
+
'shippingInfo.logistics.deliveryTime',
|
|
7249
|
+
'shippingInfo.logistics.deliveryTimeSlot.from',
|
|
7250
|
+
'shippingInfo.logistics.deliveryTimeSlot.to',
|
|
7251
|
+
'shippingInfo.region.name',
|
|
7252
|
+
'shippingInfo.title',
|
|
7253
|
+
'status'
|
|
7254
|
+
];
|
|
7255
|
+
paging: 'cursor';
|
|
7256
|
+
wql: [
|
|
7257
|
+
{
|
|
7258
|
+
operators: ['$eq', '$in', '$ne', '$nin'];
|
|
7259
|
+
fields: [
|
|
7260
|
+
'channelInfo.type',
|
|
7261
|
+
'fulfillmentStatus',
|
|
7262
|
+
'paymentStatus',
|
|
7263
|
+
'shippingInfo.region.name',
|
|
7264
|
+
'shippingInfo.title',
|
|
7265
|
+
'status'
|
|
7266
|
+
];
|
|
7267
|
+
sort: 'BOTH';
|
|
7268
|
+
},
|
|
7269
|
+
{
|
|
7270
|
+
operators: '*';
|
|
7271
|
+
fields: [
|
|
7272
|
+
'_createdDate',
|
|
7273
|
+
'_updatedDate',
|
|
7274
|
+
'balanceSummary.authorized.amount',
|
|
7275
|
+
'balanceSummary.pending.amount',
|
|
7276
|
+
'balanceSummary.pendingRefund.amount',
|
|
7277
|
+
'billingInfo.contactDetails.firstName',
|
|
7278
|
+
'billingInfo.contactDetails.lastName',
|
|
7279
|
+
'businessLocation._id',
|
|
7280
|
+
'businessLocation.name',
|
|
7281
|
+
'buyerInfo.email',
|
|
7282
|
+
'number',
|
|
7283
|
+
'priceSummary.total.amount',
|
|
7284
|
+
'purchasedDate',
|
|
7285
|
+
'shippingInfo.logistics.deliveryTime',
|
|
7286
|
+
'shippingInfo.logistics.deliveryTimeSlot.from',
|
|
7287
|
+
'shippingInfo.logistics.deliveryTimeSlot.to'
|
|
7288
|
+
];
|
|
7289
|
+
sort: 'BOTH';
|
|
7290
|
+
},
|
|
7291
|
+
{
|
|
7292
|
+
operators: '*';
|
|
7293
|
+
fields: ['archived', 'seenByAHuman'];
|
|
7294
|
+
sort: 'NONE';
|
|
7295
|
+
},
|
|
7296
|
+
{
|
|
7297
|
+
operators: ['$eq', '$in', '$ne', '$nin'];
|
|
7298
|
+
fields: [
|
|
7299
|
+
'_id',
|
|
7300
|
+
'buyerInfo.contactId',
|
|
7301
|
+
'buyerInfo.memberId',
|
|
7302
|
+
'channelInfo.externalOrderId',
|
|
7303
|
+
'checkoutId',
|
|
7304
|
+
'createdBy.userId',
|
|
7305
|
+
'lineItems.subscriptionInfo._id'
|
|
7306
|
+
];
|
|
7307
|
+
sort: 'NONE';
|
|
7308
|
+
},
|
|
7309
|
+
{
|
|
7310
|
+
operators: ['$all', '$any'];
|
|
7311
|
+
fields: [
|
|
7312
|
+
'lineItems.catalogReference.appId',
|
|
7313
|
+
'lineItems.catalogReference.catalogItemId',
|
|
7314
|
+
'lineItems.locations._id'
|
|
7315
|
+
];
|
|
7316
|
+
sort: 'NONE';
|
|
7317
|
+
},
|
|
7318
|
+
{
|
|
7319
|
+
operators: ['$all', '$any'];
|
|
7320
|
+
fields: [
|
|
7321
|
+
'fulfillmentStatusesAggregate.statuses',
|
|
7322
|
+
'lineItems.productName.original'
|
|
7323
|
+
];
|
|
7324
|
+
sort: 'BOTH';
|
|
7325
|
+
}
|
|
7326
|
+
];
|
|
7327
|
+
}
|
|
7328
|
+
export type CommonSearchWithEntityContext = SearchSdkType<Order, OrderSearchSpec>;
|
|
7329
|
+
export type OrderSearch = {
|
|
7330
|
+
/**
|
|
7331
|
+
Cursor paging options.
|
|
7332
|
+
Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
7333
|
+
*/
|
|
7334
|
+
cursorPaging?: {
|
|
7335
|
+
/**
|
|
7336
|
+
Maximum number of items to return in the results.
|
|
7337
|
+
@max: 100
|
|
7338
|
+
*/
|
|
7339
|
+
limit?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['limit'] | null;
|
|
7340
|
+
/**
|
|
7341
|
+
Pointer to the next or previous page in the list of results.
|
|
7342
|
+
|
|
7343
|
+
Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
7344
|
+
Not relevant for the first request.
|
|
7345
|
+
@maxLength: 16000
|
|
7346
|
+
*/
|
|
7347
|
+
cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
|
|
7348
|
+
};
|
|
7349
|
+
/**
|
|
7350
|
+
Filter object.
|
|
7351
|
+
|
|
7352
|
+
For example, the following `filter` object will only return orders with payment statuses of paid and/or partially paid:
|
|
7353
|
+
|
|
7354
|
+
`"filter": {"paymentStatus": {"$in": ["PAID", "PARTIALLY_PAID"]}}`
|
|
7355
|
+
|
|
7356
|
+
Learn more about the [filter format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
7357
|
+
*/
|
|
7358
|
+
filter?: CommonSearchWithEntityContext['filter'] | null;
|
|
7359
|
+
/**
|
|
7360
|
+
Array of sort objects that specify the order in which results should be sorted.
|
|
7361
|
+
|
|
7362
|
+
For example, the following `sort` array will sort by `createdDate` in descending order:
|
|
7363
|
+
|
|
7364
|
+
`"sort": [{"fieldName": "createdDate", "order":"DESC"}]`.
|
|
7365
|
+
|
|
7366
|
+
Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
7367
|
+
@maxSize: 4
|
|
7368
|
+
*/
|
|
7369
|
+
sort?: {
|
|
7370
|
+
/**
|
|
7371
|
+
Name of the field to sort by.
|
|
7372
|
+
@maxLength: 512
|
|
7373
|
+
*/
|
|
7374
|
+
fieldName?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['fieldName'];
|
|
7375
|
+
/**
|
|
7376
|
+
Sort order.
|
|
7377
|
+
*/
|
|
7378
|
+
order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
|
|
7379
|
+
}[];
|
|
7380
|
+
};
|
|
7096
7381
|
/**
|
|
7097
7382
|
* Creates an order.
|
|
7098
7383
|
*
|
|
@@ -7219,19 +7504,19 @@ export interface UpdateOrder {
|
|
|
7219
7504
|
/** Buyer information. */
|
|
7220
7505
|
buyerInfo?: BuyerInfo;
|
|
7221
7506
|
/** Order payment status. */
|
|
7222
|
-
paymentStatus?:
|
|
7507
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
7223
7508
|
/**
|
|
7224
7509
|
* Order fulfillment status.
|
|
7225
7510
|
* @readonly
|
|
7226
7511
|
*/
|
|
7227
|
-
fulfillmentStatus?:
|
|
7512
|
+
fulfillmentStatus?: FulfillmentStatusWithLiterals;
|
|
7228
7513
|
/**
|
|
7229
7514
|
* Language for communication with the buyer. Defaults to the site language.
|
|
7230
7515
|
* For a site that supports multiple languages, this is the language the buyer selected.
|
|
7231
7516
|
*/
|
|
7232
7517
|
buyerLanguage?: string | null;
|
|
7233
7518
|
/** Weight measurement unit - defaults to site's weight unit. */
|
|
7234
|
-
weightUnit?:
|
|
7519
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
7235
7520
|
/**
|
|
7236
7521
|
* Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
7237
7522
|
* @format CURRENCY
|
|
@@ -7265,7 +7550,7 @@ export interface UpdateOrder {
|
|
|
7265
7550
|
*/
|
|
7266
7551
|
buyerNote?: string | null;
|
|
7267
7552
|
/** Order status. */
|
|
7268
|
-
status?:
|
|
7553
|
+
status?: OrderStatusWithLiterals;
|
|
7269
7554
|
/** Whether order is archived. */
|
|
7270
7555
|
archived?: boolean | null;
|
|
7271
7556
|
/**
|
|
@@ -7293,7 +7578,7 @@ export interface UpdateOrder {
|
|
|
7293
7578
|
*/
|
|
7294
7579
|
activities?: Activity[];
|
|
7295
7580
|
/** Order attribution source. */
|
|
7296
|
-
attributionSource?:
|
|
7581
|
+
attributionSource?: AttributionSourceWithLiterals;
|
|
7297
7582
|
/**
|
|
7298
7583
|
* ID of the order's initiator.
|
|
7299
7584
|
* @readonly
|
|
@@ -7563,7 +7848,7 @@ export interface UpdateOrderLineItem {
|
|
|
7563
7848
|
*
|
|
7564
7849
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
7565
7850
|
*/
|
|
7566
|
-
paymentOption?:
|
|
7851
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
7567
7852
|
/**
|
|
7568
7853
|
* Deprecated. Use `taxInfo` instead.
|
|
7569
7854
|
* This field will be removed on September 30, 2024.
|
|
@@ -7795,7 +8080,7 @@ export interface CancelOrderOptions {
|
|
|
7795
8080
|
* @applicableIdentity APP
|
|
7796
8081
|
* @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderStatus
|
|
7797
8082
|
*/
|
|
7798
|
-
export declare function updateOrderStatus(orderId: string, status:
|
|
8083
|
+
export declare function updateOrderStatus(orderId: string, status: OrderStatusWithLiterals): Promise<NonNullablePaths<UpdateOrderStatusResponse, {
|
|
7799
8084
|
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
7800
8085
|
}[OrderNonNullablePaths]>>;
|
|
7801
8086
|
/** @internal
|