@wix/auto_sdk_ecom_checkout 1.0.5 → 1.0.7
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/src/ecom-v1-checkout-checkout.types.d.ts +42 -37
- package/build/cjs/src/ecom-v1-checkout-checkout.types.js +6 -6
- package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +38 -36
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +6 -6
- package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
- package/build/es/src/ecom-v1-checkout-checkout.types.d.ts +42 -37
- package/build/es/src/ecom-v1-checkout-checkout.types.js +6 -6
- package/build/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
- package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +38 -36
- package/build/es/src/ecom-v1-checkout-checkout.universal.js +6 -6
- package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.d.ts +42 -37
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js +6 -6
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +40 -38
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +6 -6
- package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.d.ts +42 -37
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.js +6 -6
- package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +40 -38
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +6 -6
- package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -19,7 +19,7 @@ export interface Checkout {
|
|
|
19
19
|
/** Shipping information. */
|
|
20
20
|
shippingInfo?: ShippingInfo;
|
|
21
21
|
/**
|
|
22
|
-
* [Buyer note](https://support.wix.com/en/article/
|
|
22
|
+
* [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
|
|
23
23
|
* @maxLength 1000
|
|
24
24
|
*/
|
|
25
25
|
buyerNote?: string | null;
|
|
@@ -44,7 +44,7 @@ export interface Checkout {
|
|
|
44
44
|
/**
|
|
45
45
|
* Applied gift card details.
|
|
46
46
|
*
|
|
47
|
-
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/
|
|
47
|
+
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
|
|
48
48
|
* @readonly
|
|
49
49
|
*/
|
|
50
50
|
giftCard?: GiftCard;
|
|
@@ -56,7 +56,7 @@ export interface Checkout {
|
|
|
56
56
|
/** Custom fields. */
|
|
57
57
|
customFields?: CustomField[];
|
|
58
58
|
/**
|
|
59
|
-
* Weight measurement unit
|
|
59
|
+
* Weight measurement unit. Defaults to a site's weight unit.
|
|
60
60
|
* @readonly
|
|
61
61
|
*/
|
|
62
62
|
weightUnit?: WeightUnit;
|
|
@@ -136,7 +136,7 @@ export interface Checkout {
|
|
|
136
136
|
*/
|
|
137
137
|
cartId?: string | null;
|
|
138
138
|
/**
|
|
139
|
-
* List of validation violations raised by the
|
|
139
|
+
* List of validation violations raised by the Validations service plugin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/validations/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction)).
|
|
140
140
|
* @readonly
|
|
141
141
|
*/
|
|
142
142
|
violations?: Violation[];
|
|
@@ -156,7 +156,7 @@ export interface Checkout {
|
|
|
156
156
|
* Additional settings for customization of the checkout process.
|
|
157
157
|
*
|
|
158
158
|
* > **Notes:**
|
|
159
|
-
* > * Custom settings can only be set when
|
|
159
|
+
* > * Custom settings can only be set when creating a checkout.
|
|
160
160
|
* > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
|
|
161
161
|
* @immutable
|
|
162
162
|
*/
|
|
@@ -170,7 +170,8 @@ export interface Checkout {
|
|
|
170
170
|
customContentReference?: CustomContentReference;
|
|
171
171
|
/**
|
|
172
172
|
* The business location ID associated with the checkout.
|
|
173
|
-
*
|
|
173
|
+
*
|
|
174
|
+
* To learn more, see the Locations API.
|
|
174
175
|
* @format GUID
|
|
175
176
|
*/
|
|
176
177
|
businessLocationId?: string | null;
|
|
@@ -364,7 +365,7 @@ export interface CatalogReference {
|
|
|
364
365
|
/**
|
|
365
366
|
* Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
|
|
366
367
|
*
|
|
367
|
-
* For products and variants from a Wix Stores catalog, learn more about
|
|
368
|
+
* For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
|
|
368
369
|
*/
|
|
369
370
|
options?: Record<string, any> | null;
|
|
370
371
|
}
|
|
@@ -604,11 +605,11 @@ export interface ItemAvailabilityInfo {
|
|
|
604
605
|
}
|
|
605
606
|
export declare enum ItemAvailabilityStatus {
|
|
606
607
|
AVAILABLE = "AVAILABLE",
|
|
607
|
-
/** Item does not exist */
|
|
608
|
+
/** Item does not exist. */
|
|
608
609
|
NOT_FOUND = "NOT_FOUND",
|
|
609
|
-
/** Item not in stock */
|
|
610
|
+
/** Item is not in stock. */
|
|
610
611
|
NOT_AVAILABLE = "NOT_AVAILABLE",
|
|
611
|
-
/** Available quantity is less than requested */
|
|
612
|
+
/** Available quantity is less than requested. */
|
|
612
613
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
613
614
|
}
|
|
614
615
|
export interface PhysicalProperties {
|
|
@@ -691,12 +692,12 @@ export declare enum SubscriptionFrequency {
|
|
|
691
692
|
YEAR = "YEAR"
|
|
692
693
|
}
|
|
693
694
|
export interface FreeTrialPeriod {
|
|
694
|
-
/** Frequency of
|
|
695
|
+
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
695
696
|
frequency?: SubscriptionFrequency;
|
|
696
697
|
/**
|
|
697
698
|
* interval of period
|
|
698
699
|
* @min 1
|
|
699
|
-
* @max
|
|
700
|
+
* @max 999
|
|
700
701
|
*/
|
|
701
702
|
interval?: number;
|
|
702
703
|
}
|
|
@@ -1236,7 +1237,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
1236
1237
|
*/
|
|
1237
1238
|
memberId?: string;
|
|
1238
1239
|
/**
|
|
1239
|
-
* Contact ID. Auto-created if one does not yet exist. For more information, see
|
|
1240
|
+
* Contact ID. Auto-created if one does not yet exist. For more information, see the Contacts API.
|
|
1240
1241
|
* @format GUID
|
|
1241
1242
|
* @readonly
|
|
1242
1243
|
*/
|
|
@@ -1535,11 +1536,11 @@ export interface CustomField {
|
|
|
1535
1536
|
translatedTitle?: string | null;
|
|
1536
1537
|
}
|
|
1537
1538
|
export declare enum WeightUnit {
|
|
1538
|
-
/** Weight unit can't be classified
|
|
1539
|
+
/** Weight unit can't be classified due to an error. */
|
|
1539
1540
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1540
|
-
/** Kilograms */
|
|
1541
|
+
/** Kilograms. */
|
|
1541
1542
|
KG = "KG",
|
|
1542
|
-
/** Pounds */
|
|
1543
|
+
/** Pounds. */
|
|
1543
1544
|
LB = "LB"
|
|
1544
1545
|
}
|
|
1545
1546
|
export interface TaxSummary {
|
|
@@ -1668,23 +1669,23 @@ export declare enum ChannelType {
|
|
|
1668
1669
|
}
|
|
1669
1670
|
export interface CreatedBy extends CreatedByIdOneOf {
|
|
1670
1671
|
/**
|
|
1671
|
-
* User ID
|
|
1672
|
+
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
1672
1673
|
* For example, via POS (point of service).
|
|
1673
1674
|
* @format GUID
|
|
1674
1675
|
*/
|
|
1675
1676
|
userId?: string;
|
|
1676
1677
|
/**
|
|
1677
|
-
* Member ID
|
|
1678
|
+
* Member ID. When the order was created by a **logged in** site visitor.
|
|
1678
1679
|
* @format GUID
|
|
1679
1680
|
*/
|
|
1680
1681
|
memberId?: string;
|
|
1681
1682
|
/**
|
|
1682
|
-
* Visitor ID
|
|
1683
|
+
* Visitor ID. When the order was created by a site visitor that was **not** logged in.
|
|
1683
1684
|
* @format GUID
|
|
1684
1685
|
*/
|
|
1685
1686
|
visitorId?: string;
|
|
1686
1687
|
/**
|
|
1687
|
-
* App ID
|
|
1688
|
+
* App ID. When the order was created by an external application or Wix service.
|
|
1688
1689
|
* @format GUID
|
|
1689
1690
|
*/
|
|
1690
1691
|
appId?: string;
|
|
@@ -1692,23 +1693,23 @@ export interface CreatedBy extends CreatedByIdOneOf {
|
|
|
1692
1693
|
/** @oneof */
|
|
1693
1694
|
export interface CreatedByIdOneOf {
|
|
1694
1695
|
/**
|
|
1695
|
-
* User ID
|
|
1696
|
+
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
1696
1697
|
* For example, via POS (point of service).
|
|
1697
1698
|
* @format GUID
|
|
1698
1699
|
*/
|
|
1699
1700
|
userId?: string;
|
|
1700
1701
|
/**
|
|
1701
|
-
* Member ID
|
|
1702
|
+
* Member ID. When the order was created by a **logged in** site visitor.
|
|
1702
1703
|
* @format GUID
|
|
1703
1704
|
*/
|
|
1704
1705
|
memberId?: string;
|
|
1705
1706
|
/**
|
|
1706
|
-
* Visitor ID
|
|
1707
|
+
* Visitor ID. When the order was created by a site visitor that was **not** logged in.
|
|
1707
1708
|
* @format GUID
|
|
1708
1709
|
*/
|
|
1709
1710
|
visitorId?: string;
|
|
1710
1711
|
/**
|
|
1711
|
-
* App ID
|
|
1712
|
+
* App ID. When the order was created by an external application or Wix service.
|
|
1712
1713
|
* @format GUID
|
|
1713
1714
|
*/
|
|
1714
1715
|
appId?: string;
|
|
@@ -2059,13 +2060,13 @@ export interface CreateCheckoutRequest {
|
|
|
2059
2060
|
*
|
|
2060
2061
|
* The checkout can only hold 1 `giftCardCode` at a time. If an additional `giftCardCode` is added, it will override the existing `giftCardCode`.
|
|
2061
2062
|
*
|
|
2062
|
-
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/
|
|
2063
|
+
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
|
|
2063
2064
|
*/
|
|
2064
2065
|
giftCardCode?: string | null;
|
|
2065
2066
|
/**
|
|
2066
2067
|
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
2067
2068
|
*
|
|
2068
|
-
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the
|
|
2069
|
+
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
|
|
2069
2070
|
* to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
|
|
2070
2071
|
* standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
2071
2072
|
* @maxLength 1000
|
|
@@ -2218,7 +2219,7 @@ export interface GetCheckoutRequest {
|
|
|
2218
2219
|
id: string;
|
|
2219
2220
|
}
|
|
2220
2221
|
export interface GetCheckoutResponse {
|
|
2221
|
-
/**
|
|
2222
|
+
/** Retrieved checkout. */
|
|
2222
2223
|
checkout?: Checkout;
|
|
2223
2224
|
}
|
|
2224
2225
|
export interface GetCheckoutWithAllExtendedFieldsRequest {
|
|
@@ -2229,7 +2230,7 @@ export interface GetCheckoutWithAllExtendedFieldsRequest {
|
|
|
2229
2230
|
id?: string;
|
|
2230
2231
|
}
|
|
2231
2232
|
export interface GetCheckoutWithAllExtendedFieldsResponse {
|
|
2232
|
-
/**
|
|
2233
|
+
/** Retrieved checkout. */
|
|
2233
2234
|
checkout?: Checkout;
|
|
2234
2235
|
}
|
|
2235
2236
|
export interface GetCheckoutByCartIdRequest {
|
|
@@ -2240,7 +2241,7 @@ export interface GetCheckoutByCartIdRequest {
|
|
|
2240
2241
|
id: string;
|
|
2241
2242
|
}
|
|
2242
2243
|
export interface GetCheckoutByCartIdResponse {
|
|
2243
|
-
/**
|
|
2244
|
+
/** Retrieved checkout. */
|
|
2244
2245
|
checkout?: Checkout;
|
|
2245
2246
|
}
|
|
2246
2247
|
export interface GetWixCheckoutURLRequest {
|
|
@@ -2279,7 +2280,7 @@ export interface UpdateCheckoutRequest {
|
|
|
2279
2280
|
/**
|
|
2280
2281
|
* `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
|
|
2281
2282
|
*
|
|
2282
|
-
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the
|
|
2283
|
+
* This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
|
|
2283
2284
|
* to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
|
|
2284
2285
|
* standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
|
|
2285
2286
|
* @maxLength 1000
|
|
@@ -2368,6 +2369,10 @@ export interface RemoveLineItemsRequest {
|
|
|
2368
2369
|
id: string;
|
|
2369
2370
|
/**
|
|
2370
2371
|
* IDs of the line items to remove from the checkout.
|
|
2372
|
+
*
|
|
2373
|
+
* To find the IDs of the checkout line items you'd like to remove,
|
|
2374
|
+
* pass the checkout ID to Get Checkout and look for the IDs under
|
|
2375
|
+
* `lineItems`.
|
|
2371
2376
|
* @format GUID
|
|
2372
2377
|
* @minSize 1
|
|
2373
2378
|
* @maxSize 300
|
|
@@ -2384,9 +2389,9 @@ export interface CreateOrderRequest {
|
|
|
2384
2389
|
* @format GUID
|
|
2385
2390
|
*/
|
|
2386
2391
|
id: string;
|
|
2387
|
-
/**
|
|
2392
|
+
/** Whether the payment method should be saved on the order. */
|
|
2388
2393
|
savePaymentMethod?: boolean;
|
|
2389
|
-
/**
|
|
2394
|
+
/** Whether to authorize the payment and delay the capture. */
|
|
2390
2395
|
delayCapture?: boolean;
|
|
2391
2396
|
}
|
|
2392
2397
|
export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
@@ -2407,8 +2412,8 @@ export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
|
2407
2412
|
* `paymentGatewayOrderId` will be returned if money needs to be charged.
|
|
2408
2413
|
*
|
|
2409
2414
|
* In some cases, money cannot be charged:
|
|
2410
|
-
* + When the total price (the `priceSummary.total.amount` field in the checkout/order objects) is 0
|
|
2411
|
-
* + If the total price is not 0
|
|
2415
|
+
* + When the total price (the `priceSummary.total.amount` field in the checkout/order objects) is `0`. For example, in the case of a free item or an item with a 100% discount.
|
|
2416
|
+
* + If the total price is not `0`, but the payment is covered by alternative payment methods, such as a gift card.
|
|
2412
2417
|
*/
|
|
2413
2418
|
paymentGatewayOrderId?: string | null;
|
|
2414
2419
|
}
|
|
@@ -2458,9 +2463,9 @@ export interface CreateOrderAndChargeRequest {
|
|
|
2458
2463
|
id: string;
|
|
2459
2464
|
/** Payment token. */
|
|
2460
2465
|
paymentToken?: string | null;
|
|
2461
|
-
/**
|
|
2466
|
+
/** Whether the payment method should be saved on the order. */
|
|
2462
2467
|
savePaymentMethod?: boolean;
|
|
2463
|
-
/**
|
|
2468
|
+
/** Whether to authorize the payment and delay the capture. */
|
|
2464
2469
|
delayCapture?: boolean;
|
|
2465
2470
|
}
|
|
2466
2471
|
export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
|
|
@@ -2523,7 +2528,7 @@ export interface MarkCheckoutAsCompletedRequest {
|
|
|
2523
2528
|
}
|
|
2524
2529
|
export interface MarkCheckoutAsCompletedResponse {
|
|
2525
2530
|
}
|
|
2526
|
-
/** Triggered when
|
|
2531
|
+
/** Triggered when an order created from this checkout is successfully paid for or when a checkout is marked as completed. */
|
|
2527
2532
|
export interface CheckoutMarkedAsCompleted {
|
|
2528
2533
|
checkout?: Checkout;
|
|
2529
2534
|
}
|
|
@@ -23,11 +23,11 @@ var DescriptionLineType;
|
|
|
23
23
|
var ItemAvailabilityStatus;
|
|
24
24
|
(function (ItemAvailabilityStatus) {
|
|
25
25
|
ItemAvailabilityStatus["AVAILABLE"] = "AVAILABLE";
|
|
26
|
-
/** Item does not exist */
|
|
26
|
+
/** Item does not exist. */
|
|
27
27
|
ItemAvailabilityStatus["NOT_FOUND"] = "NOT_FOUND";
|
|
28
|
-
/** Item not in stock */
|
|
28
|
+
/** Item is not in stock. */
|
|
29
29
|
ItemAvailabilityStatus["NOT_AVAILABLE"] = "NOT_AVAILABLE";
|
|
30
|
-
/** Available quantity is less than requested */
|
|
30
|
+
/** Available quantity is less than requested. */
|
|
31
31
|
ItemAvailabilityStatus["PARTIALLY_AVAILABLE"] = "PARTIALLY_AVAILABLE";
|
|
32
32
|
})(ItemAvailabilityStatus || (exports.ItemAvailabilityStatus = ItemAvailabilityStatus = {}));
|
|
33
33
|
var ItemTypeItemType;
|
|
@@ -129,11 +129,11 @@ var DiscountType;
|
|
|
129
129
|
})(DiscountType || (exports.DiscountType = DiscountType = {}));
|
|
130
130
|
var WeightUnit;
|
|
131
131
|
(function (WeightUnit) {
|
|
132
|
-
/** Weight unit can't be classified
|
|
132
|
+
/** Weight unit can't be classified due to an error. */
|
|
133
133
|
WeightUnit["UNSPECIFIED_WEIGHT_UNIT"] = "UNSPECIFIED_WEIGHT_UNIT";
|
|
134
|
-
/** Kilograms */
|
|
134
|
+
/** Kilograms. */
|
|
135
135
|
WeightUnit["KG"] = "KG";
|
|
136
|
-
/** Pounds */
|
|
136
|
+
/** Pounds. */
|
|
137
137
|
WeightUnit["LB"] = "LB";
|
|
138
138
|
})(WeightUnit || (exports.WeightUnit = WeightUnit = {}));
|
|
139
139
|
var RateType;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ecom-v1-checkout-checkout.types.js","sourceRoot":"","sources":["../../../../src/ecom-v1-checkout-checkout.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"ecom-v1-checkout-checkout.types.js","sourceRoot":"","sources":["../../../../src/ecom-v1-checkout-checkout.types.ts"],"names":[],"mappings":";;;AAgfA,0IAA0I;AAC1I,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;IACnB,mCAAe,CAAA;IACf,qCAAiB,CAAA;IACjB,iCAAa,CAAA;IACb,uCAAmB,CAAA;AACrB,CAAC,EAPW,gBAAgB,gCAAhB,gBAAgB,QAO3B;AAuED,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,yBAAyB;IACzB,oDAA6B,CAAA;IAC7B,uBAAuB;IACvB,gDAAyB,CAAA;IACzB,kBAAkB;IAClB,sCAAe,CAAA;AACjB,CAAC,EAPW,mBAAmB,mCAAnB,mBAAmB,QAO9B;AA4CD,IAAY,sBAQX;AARD,WAAY,sBAAsB;IAChC,iDAAuB,CAAA;IACvB,2BAA2B;IAC3B,iDAAuB,CAAA;IACvB,4BAA4B;IAC5B,yDAA+B,CAAA;IAC/B,iDAAiD;IACjD,qEAA2C,CAAA;AAC7C,CAAC,EARW,sBAAsB,sCAAtB,sBAAsB,QAQjC;AA2CD,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,iDAA6B,CAAA;IAC7B,yCAAqB,CAAA;IACrB,uCAAmB,CAAA;IACnB,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;AACrB,CAAC,EANW,gBAAgB,gCAAhB,gBAAgB,QAM3B;AAgCD,0CAA0C;AAC1C,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,gDAAuB,CAAA;IACvB,oCAAW,CAAA;IACX,sCAAa,CAAA;IACb,wCAAe,CAAA;IACf,sCAAa,CAAA;AACf,CAAC,EANW,qBAAqB,qCAArB,qBAAqB,QAMhC;AA4DD,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,uCAA2B,CAAA;IAC3B,6CAAiC,CAAA;IACjC,yCAA6B,CAAA;IAC7B,+CAAmC,CAAA;IACnC,yCAA6B,CAAA;IAC7B,6CAAiC,CAAA;AACnC,CAAC,EAPW,QAAQ,wBAAR,QAAQ,QAOnB;AAED,uDAAuD;AACvD,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,wEAAwE;IACxE,gEAA2C,CAAA;IAC3C,sIAAsI;IACtI,kEAA6C,CAAA;IAC7C,6FAA6F;IAC7F,8CAAyB,CAAA;IACzB,4IAA4I;IAC5I,sDAAiC,CAAA;IACjC,uKAAuK;IACvK,8DAAyC,CAAA;AAC3C,CAAC,EAXW,iBAAiB,iCAAjB,iBAAiB,QAW5B;AAwGD,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,yEAAmD,CAAA;IACnD,2CAAqB,CAAA;IACrB,yCAAmB,CAAA;IACnB,2CAAqB,CAAA;AACvB,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B;AAwID,qBAAqB;AACrB,IAAY,aAMX;AAND,WAAY,aAAa;IACvB,4CAA2B,CAAA;IAC3B,uCAAuC;IACvC,4BAAW,CAAA;IACX,8BAA8B;IAC9B,8BAAa,CAAA;AACf,CAAC,EANW,aAAa,6BAAb,aAAa,QAMxB;AA0FD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,6CAA6B,CAAA;AAC/B,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB;AAkCD,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,2CAA6B,CAAA;IAC7B,qCAAuB,CAAA;AACzB,CAAC,EAHW,UAAU,0BAAV,UAAU,QAGrB;AAsQD,IAAY,QAsBX;AAtBD,WAAY,QAAQ;IAClB,qCAAyB,CAAA;IACzB,2BAAe,CAAA;IACf,uBAAW,CAAA;IACX,uBAAW,CAAA;IACX,qCAAyB,CAAA;IACzB,qCAAyB,CAAA;IACzB,iCAAqB,CAAA;IACrB,iCAAqB,CAAA;IACrB,6BAAiB,CAAA;IACjB,uCAA2B,CAAA;IAC3B,uCAA2B,CAAA;IAC3B,qCAAyB,CAAA;IACzB,qCAAyB,CAAA;IACzB,mDAAuC,CAAA;IACvC,qDAAyC,CAAA;IACzC,6CAAiC,CAAA;IACjC,mDAAuC,CAAA;IACvC,iDAAqC,CAAA;IACrC,yCAA6B,CAAA;IAC7B,qCAAyB,CAAA;IACzB,2DAA+C,CAAA;AACjD,CAAC,EAtBW,QAAQ,wBAAR,QAAQ,QAsBnB;AAiFD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,iDAAiC,CAAA;IACjC,qCAAqB,CAAA;AACvB,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB;AA+ED,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,uDAAuD;IACvD,iEAAmD,CAAA;IACnD,iBAAiB;IACjB,uBAAS,CAAA;IACT,cAAc;IACd,uBAAS,CAAA;AACX,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AAsCD,IAAY,QASX;AATD,WAAY,QAAQ;IAClB,0EAA0E;IAC1E,iDAAqC,CAAA;IACrC,uCAAuC;IACvC,uCAA2B,CAAA;IAC3B,wCAAwC;IACxC,mCAAuB,CAAA;IACvB,yCAAyC;IACzC,2CAA+B,CAAA;AACjC,CAAC,EATW,QAAQ,wBAAR,QAAQ,QASnB;AAED,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,2DAA2D;IAC3D,gFAAqD,CAAA;IACrD,0EAA0E;IAC1E,gFAAqD,CAAA;AACvD,CAAC,EALW,uBAAuB,uCAAvB,uBAAuB,QAKlC;AASD,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,uCAAuC;IACvC,qDAAmC,CAAA;IACnC,6DAA6D;IAC7D,+DAA6C,CAAA;AAC/C,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AAiCD,IAAY,WAiCX;AAjCD,WAAY,WAAW;IACrB,8DAA8D;IAC9D,0CAA2B,CAAA;IAC3B,oBAAoB;IACpB,0BAAW,CAAA;IACX,oFAAoF;IACpF,0BAAW,CAAA;IACX,yGAAyG;IACzG,4BAAa,CAAA;IACb,6GAA6G;IAC7G,gCAAiB,CAAA;IACjB,4BAA4B;IAC5B,gDAAiC,CAAA;IACjC,kFAAkF;IAClF,8CAA+B,CAAA;IAC/B,mRAAmR;IACnR,4CAA6B,CAAA;IAC7B,+BAA+B;IAC/B,0DAA2C,CAAA;IAC3C,0BAA0B;IAC1B,4BAAa,CAAA;IACb,oIAAoI;IACpI,wCAAyB,CAAA;IACzB,8BAA8B;IAC9B,oCAAqB,CAAA;IACrB,gGAAgG;IAChG,oCAAqB,CAAA;IACrB,kHAAkH;IAClH,4BAAa,CAAA;IACb,sHAAsH;IACtH,gCAAiB,CAAA;IACjB,6IAA6I;IAC7I,sCAAuB,CAAA;AACzB,CAAC,EAjCW,WAAW,2BAAX,WAAW,QAiCtB;AAwMD,IAAY,mBAQX;AARD,WAAY,mBAAmB;IAC7B,sFAA+D,CAAA;IAC/D,uEAAuE;IACvE,wDAAiC,CAAA;IACjC,6FAA6F;IAC7F,oCAAa,CAAA;IACb,2DAA2D;IAC3D,wCAAiB,CAAA;AACnB,CAAC,EARW,mBAAmB,mCAAnB,mBAAmB,QAQ9B;AA8BD,IAAY,QAQX;AARD,WAAY,QAAQ;IAClB,uDAAuD;IACvD,+BAAmB,CAAA;IACnB;;;OAGG;IACH,2BAAe,CAAA;AACjB,CAAC,EARW,QAAQ,wBAAR,QAAQ,QAQnB;AAiBD,yCAAyC;AACzC,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,mEAAmE;IACnE,8CAA+B,CAAA;AACjC,CAAC,EAHW,WAAW,2BAAX,WAAW,QAGtB;AAED,2CAA2C;AAC3C,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,mEAAmE;IACnE,yDAAuC,CAAA;AACzC,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AAED,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,8GAA8G;IAC9G,+DAA+C,CAAA;IAC/C,0FAA0F;IAC1F,qDAAqC,CAAA;AACvC,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAssBD,IAAY,+CAGX;AAHD,WAAY,+CAA+C;IACzD,oGAAiD,CAAA;IACjD,oEAAiB,CAAA;AACnB,CAAC,EAHW,+CAA+C,+DAA/C,+CAA+C,QAG1D;AA2FD,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,uEAAuD,CAAA;IACvD,kBAAkB;IAClB,iCAAiB,CAAA;IACjB,cAAc;IACd,mCAAmB,CAAA;AACrB,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AA8ID,IAAY,YASX;AATD,WAAY,YAAY;IACtB,0DAA0D;IAC1D,yEAAyD,CAAA;IACzD,yBAAyB;IACzB,qCAAqB,CAAA;IACrB,wBAAwB;IACxB,mCAAmB,CAAA;IACnB,wBAAwB;IACxB,yDAAyC,CAAA;AAC3C,CAAC,EATW,YAAY,4BAAZ,YAAY,QASvB;AAqCD,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,2DAA2D;IAC3D,4EAA2D,CAAA;IAC3D,sBAAsB;IACtB,gCAAe,CAAA;AACjB,CAAC,EALW,aAAa,6BAAb,aAAa,QAKxB;AAoKD,+BAA+B;AAC/B,IAAY,OAOX;AAPD,WAAY,OAAO;IACjB,kEAAkE;IAClE,wDAA6C,CAAA;IAC7C,sCAAsC;IACtC,sBAAW,CAAA;IACX,8BAA8B;IAC9B,wBAAa,CAAA;AACf,CAAC,EAPW,OAAO,uBAAP,OAAO,QAOlB;AA6ID,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,+CAAuB,CAAA;IACvB,kBAAkB;IAClB,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;AACrB,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B;AAOD,IAAY,sBAKX;AALD,WAAY,sBAAsB;IAChC,qDAA2B,CAAA;IAC3B,qCAAW,CAAA;IACX,2DAAiC,CAAA;IACjC,yDAA+B,CAAA;AACjC,CAAC,EALW,sBAAsB,sCAAtB,sBAAsB,QAKjC;AAoLD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
|
|
@@ -44,7 +44,7 @@ export interface Checkout {
|
|
|
44
44
|
/**
|
|
45
45
|
* Applied gift card details.
|
|
46
46
|
*
|
|
47
|
-
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/
|
|
47
|
+
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
|
|
48
48
|
* @readonly
|
|
49
49
|
*/
|
|
50
50
|
giftCard?: GiftCard;
|
|
@@ -56,7 +56,7 @@ export interface Checkout {
|
|
|
56
56
|
/** Custom fields. */
|
|
57
57
|
customFields?: CustomField[];
|
|
58
58
|
/**
|
|
59
|
-
* Weight measurement unit
|
|
59
|
+
* Weight measurement unit. Defaults to a site's weight unit.
|
|
60
60
|
* @readonly
|
|
61
61
|
*/
|
|
62
62
|
weightUnit?: WeightUnit;
|
|
@@ -183,7 +183,8 @@ export interface Checkout {
|
|
|
183
183
|
payAfterFreeTrial?: PriceSummary;
|
|
184
184
|
/**
|
|
185
185
|
* The business location ID associated with the checkout.
|
|
186
|
-
*
|
|
186
|
+
*
|
|
187
|
+
* To learn more, see the Locations API.
|
|
187
188
|
* @format GUID
|
|
188
189
|
*/
|
|
189
190
|
businessLocationId?: string | null;
|
|
@@ -198,7 +199,7 @@ export interface Checkout {
|
|
|
198
199
|
*/
|
|
199
200
|
paymentRequired?: boolean;
|
|
200
201
|
/**
|
|
201
|
-
* Charges information for each subscription in the
|
|
202
|
+
* Charges information for each subscription in the checkout.
|
|
202
203
|
* @internal
|
|
203
204
|
* @readonly
|
|
204
205
|
* @maxSize 100
|
|
@@ -654,11 +655,11 @@ export interface ItemAvailabilityInfo {
|
|
|
654
655
|
}
|
|
655
656
|
export declare enum ItemAvailabilityStatus {
|
|
656
657
|
AVAILABLE = "AVAILABLE",
|
|
657
|
-
/** Item does not exist */
|
|
658
|
+
/** Item does not exist. */
|
|
658
659
|
NOT_FOUND = "NOT_FOUND",
|
|
659
|
-
/** Item not in stock */
|
|
660
|
+
/** Item is not in stock. */
|
|
660
661
|
NOT_AVAILABLE = "NOT_AVAILABLE",
|
|
661
|
-
/** Available quantity is less than requested */
|
|
662
|
+
/** Available quantity is less than requested. */
|
|
662
663
|
PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
|
|
663
664
|
}
|
|
664
665
|
export interface PhysicalProperties {
|
|
@@ -757,12 +758,12 @@ export declare enum SubscriptionFrequency {
|
|
|
757
758
|
YEAR = "YEAR"
|
|
758
759
|
}
|
|
759
760
|
export interface FreeTrialPeriod {
|
|
760
|
-
/** Frequency of
|
|
761
|
+
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
761
762
|
frequency?: SubscriptionFrequency;
|
|
762
763
|
/**
|
|
763
764
|
* interval of period
|
|
764
765
|
* @min 1
|
|
765
|
-
* @max
|
|
766
|
+
* @max 999
|
|
766
767
|
*/
|
|
767
768
|
interval?: number;
|
|
768
769
|
}
|
|
@@ -1597,11 +1598,11 @@ export interface CustomField {
|
|
|
1597
1598
|
translatedTitle?: string | null;
|
|
1598
1599
|
}
|
|
1599
1600
|
export declare enum WeightUnit {
|
|
1600
|
-
/** Weight unit can't be classified
|
|
1601
|
+
/** Weight unit can't be classified due to an error. */
|
|
1601
1602
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1602
|
-
/** Kilograms */
|
|
1603
|
+
/** Kilograms. */
|
|
1603
1604
|
KG = "KG",
|
|
1604
|
-
/** Pounds */
|
|
1605
|
+
/** Pounds. */
|
|
1605
1606
|
LB = "LB"
|
|
1606
1607
|
}
|
|
1607
1608
|
export interface TaxSummary {
|
|
@@ -1730,23 +1731,23 @@ export declare enum ChannelType {
|
|
|
1730
1731
|
}
|
|
1731
1732
|
export interface CreatedBy extends CreatedByIdOneOf {
|
|
1732
1733
|
/**
|
|
1733
|
-
* User ID
|
|
1734
|
+
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
1734
1735
|
* For example, via POS (point of service).
|
|
1735
1736
|
* @format GUID
|
|
1736
1737
|
*/
|
|
1737
1738
|
userId?: string;
|
|
1738
1739
|
/**
|
|
1739
|
-
* Member ID
|
|
1740
|
+
* Member ID. When the order was created by a **logged in** site visitor.
|
|
1740
1741
|
* @format GUID
|
|
1741
1742
|
*/
|
|
1742
1743
|
memberId?: string;
|
|
1743
1744
|
/**
|
|
1744
|
-
* Visitor ID
|
|
1745
|
+
* Visitor ID. When the order was created by a site visitor that was **not** logged in.
|
|
1745
1746
|
* @format GUID
|
|
1746
1747
|
*/
|
|
1747
1748
|
visitorId?: string;
|
|
1748
1749
|
/**
|
|
1749
|
-
* App ID
|
|
1750
|
+
* App ID. When the order was created by an external application or Wix service.
|
|
1750
1751
|
* @format GUID
|
|
1751
1752
|
*/
|
|
1752
1753
|
appId?: string;
|
|
@@ -1754,23 +1755,23 @@ export interface CreatedBy extends CreatedByIdOneOf {
|
|
|
1754
1755
|
/** @oneof */
|
|
1755
1756
|
export interface CreatedByIdOneOf {
|
|
1756
1757
|
/**
|
|
1757
|
-
* User ID
|
|
1758
|
+
* User ID. When the order was created by a Wix user on behalf of a buyer.
|
|
1758
1759
|
* For example, via POS (point of service).
|
|
1759
1760
|
* @format GUID
|
|
1760
1761
|
*/
|
|
1761
1762
|
userId?: string;
|
|
1762
1763
|
/**
|
|
1763
|
-
* Member ID
|
|
1764
|
+
* Member ID. When the order was created by a **logged in** site visitor.
|
|
1764
1765
|
* @format GUID
|
|
1765
1766
|
*/
|
|
1766
1767
|
memberId?: string;
|
|
1767
1768
|
/**
|
|
1768
|
-
* Visitor ID
|
|
1769
|
+
* Visitor ID. When the order was created by a site visitor that was **not** logged in.
|
|
1769
1770
|
* @format GUID
|
|
1770
1771
|
*/
|
|
1771
1772
|
visitorId?: string;
|
|
1772
1773
|
/**
|
|
1773
|
-
* App ID
|
|
1774
|
+
* App ID. When the order was created by an external application or Wix service.
|
|
1774
1775
|
* @format GUID
|
|
1775
1776
|
*/
|
|
1776
1777
|
appId?: string;
|
|
@@ -2134,7 +2135,7 @@ export interface CreateCheckoutRequest {
|
|
|
2134
2135
|
*
|
|
2135
2136
|
* The checkout can only hold 1 `giftCardCode` at a time. If an additional `giftCardCode` is added, it will override the existing `giftCardCode`.
|
|
2136
2137
|
*
|
|
2137
|
-
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/
|
|
2138
|
+
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
|
|
2138
2139
|
*/
|
|
2139
2140
|
giftCardCode?: string | null;
|
|
2140
2141
|
/**
|
|
@@ -2331,7 +2332,7 @@ export interface GetCheckoutRequest {
|
|
|
2331
2332
|
_id: string;
|
|
2332
2333
|
}
|
|
2333
2334
|
export interface GetCheckoutResponse {
|
|
2334
|
-
/**
|
|
2335
|
+
/** Retrieved checkout. */
|
|
2335
2336
|
checkout?: Checkout;
|
|
2336
2337
|
}
|
|
2337
2338
|
export interface GetCheckoutWithAllExtendedFieldsRequest {
|
|
@@ -2342,7 +2343,7 @@ export interface GetCheckoutWithAllExtendedFieldsRequest {
|
|
|
2342
2343
|
_id?: string;
|
|
2343
2344
|
}
|
|
2344
2345
|
export interface GetCheckoutWithAllExtendedFieldsResponse {
|
|
2345
|
-
/**
|
|
2346
|
+
/** Retrieved checkout. */
|
|
2346
2347
|
checkout?: Checkout;
|
|
2347
2348
|
}
|
|
2348
2349
|
export interface GetCheckoutByCartIdRequest {
|
|
@@ -2353,7 +2354,7 @@ export interface GetCheckoutByCartIdRequest {
|
|
|
2353
2354
|
_id: string;
|
|
2354
2355
|
}
|
|
2355
2356
|
export interface GetCheckoutByCartIdResponse {
|
|
2356
|
-
/**
|
|
2357
|
+
/** Retrieved checkout. */
|
|
2357
2358
|
checkout?: Checkout;
|
|
2358
2359
|
}
|
|
2359
2360
|
export interface GetWixCheckoutURLRequest {
|
|
@@ -2491,9 +2492,9 @@ export interface CreateOrderRequest {
|
|
|
2491
2492
|
* @format GUID
|
|
2492
2493
|
*/
|
|
2493
2494
|
_id: string;
|
|
2494
|
-
/**
|
|
2495
|
+
/** Whether the payment method should be saved on the order. */
|
|
2495
2496
|
savePaymentMethod?: boolean;
|
|
2496
|
-
/**
|
|
2497
|
+
/** Whether to authorize the payment and delay the capture. */
|
|
2497
2498
|
delayCapture?: boolean;
|
|
2498
2499
|
}
|
|
2499
2500
|
export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
|
|
@@ -2564,9 +2565,9 @@ export interface CreateOrderAndChargeRequest {
|
|
|
2564
2565
|
_id: string;
|
|
2565
2566
|
/** Payment token. */
|
|
2566
2567
|
paymentToken?: string | null;
|
|
2567
|
-
/**
|
|
2568
|
+
/** Whether the payment method should be saved on the order. */
|
|
2568
2569
|
savePaymentMethod?: boolean;
|
|
2569
|
-
/**
|
|
2570
|
+
/** Whether to authorize the payment and delay the capture. */
|
|
2570
2571
|
delayCapture?: boolean;
|
|
2571
2572
|
}
|
|
2572
2573
|
export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
|
|
@@ -2636,7 +2637,7 @@ export interface MarkCheckoutAsCompletedRequest {
|
|
|
2636
2637
|
}
|
|
2637
2638
|
export interface MarkCheckoutAsCompletedResponse {
|
|
2638
2639
|
}
|
|
2639
|
-
/** Triggered when
|
|
2640
|
+
/** Triggered when an order created from this checkout is successfully paid for or when a checkout is marked as completed. */
|
|
2640
2641
|
export interface CheckoutMarkedAsCompleted {
|
|
2641
2642
|
checkout?: Checkout;
|
|
2642
2643
|
}
|
|
@@ -4190,7 +4191,7 @@ export interface CreateCheckoutOptions {
|
|
|
4190
4191
|
*
|
|
4191
4192
|
* The checkout can only hold 1 `giftCardCode` at a time. If an additional `giftCardCode` is added, it will override the existing `giftCardCode`.
|
|
4192
4193
|
*
|
|
4193
|
-
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/
|
|
4194
|
+
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
|
|
4194
4195
|
*/
|
|
4195
4196
|
giftCardCode?: string | null;
|
|
4196
4197
|
/**
|
|
@@ -4406,7 +4407,7 @@ export interface UpdateCheckout {
|
|
|
4406
4407
|
/**
|
|
4407
4408
|
* Applied gift card details.
|
|
4408
4409
|
*
|
|
4409
|
-
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/
|
|
4410
|
+
* >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
|
|
4410
4411
|
* @readonly
|
|
4411
4412
|
*/
|
|
4412
4413
|
giftCard?: GiftCard;
|
|
@@ -4418,7 +4419,7 @@ export interface UpdateCheckout {
|
|
|
4418
4419
|
/** Custom fields. */
|
|
4419
4420
|
customFields?: CustomField[];
|
|
4420
4421
|
/**
|
|
4421
|
-
* Weight measurement unit
|
|
4422
|
+
* Weight measurement unit. Defaults to a site's weight unit.
|
|
4422
4423
|
* @readonly
|
|
4423
4424
|
*/
|
|
4424
4425
|
weightUnit?: WeightUnit;
|
|
@@ -4545,7 +4546,8 @@ export interface UpdateCheckout {
|
|
|
4545
4546
|
payAfterFreeTrial?: PriceSummary;
|
|
4546
4547
|
/**
|
|
4547
4548
|
* The business location ID associated with the checkout.
|
|
4548
|
-
*
|
|
4549
|
+
*
|
|
4550
|
+
* To learn more, see the Locations API.
|
|
4549
4551
|
* @format GUID
|
|
4550
4552
|
*/
|
|
4551
4553
|
businessLocationId?: string | null;
|
|
@@ -4560,7 +4562,7 @@ export interface UpdateCheckout {
|
|
|
4560
4562
|
*/
|
|
4561
4563
|
paymentRequired?: boolean;
|
|
4562
4564
|
/**
|
|
4563
|
-
* Charges information for each subscription in the
|
|
4565
|
+
* Charges information for each subscription in the checkout.
|
|
4564
4566
|
* @internal
|
|
4565
4567
|
* @readonly
|
|
4566
4568
|
* @maxSize 100
|
|
@@ -4777,9 +4779,9 @@ export declare function removeLineItems(_id: string, lineItemIds: string[]): Pro
|
|
|
4777
4779
|
*/
|
|
4778
4780
|
export declare function createOrder(_id: string, options?: CreateOrderOptions): Promise<CreateOrderResponse & CreateOrderResponseNonNullableFields>;
|
|
4779
4781
|
export interface CreateOrderOptions {
|
|
4780
|
-
/**
|
|
4782
|
+
/** Whether the payment method should be saved on the order. */
|
|
4781
4783
|
savePaymentMethod?: boolean;
|
|
4782
|
-
/**
|
|
4784
|
+
/** Whether to authorize the payment and delay the capture. */
|
|
4783
4785
|
delayCapture?: boolean;
|
|
4784
4786
|
}
|
|
4785
4787
|
/**
|
|
@@ -4805,9 +4807,9 @@ export declare function createOrderAndCharge(_id: string, options?: CreateOrderA
|
|
|
4805
4807
|
export interface CreateOrderAndChargeOptions {
|
|
4806
4808
|
/** Payment token. */
|
|
4807
4809
|
paymentToken?: string | null;
|
|
4808
|
-
/**
|
|
4810
|
+
/** Whether the payment method should be saved on the order. */
|
|
4809
4811
|
savePaymentMethod?: boolean;
|
|
4810
|
-
/**
|
|
4812
|
+
/** Whether to authorize the payment and delay the capture. */
|
|
4811
4813
|
delayCapture?: boolean;
|
|
4812
4814
|
}
|
|
4813
4815
|
/**
|
|
@@ -56,11 +56,11 @@ var DescriptionLineType;
|
|
|
56
56
|
var ItemAvailabilityStatus;
|
|
57
57
|
(function (ItemAvailabilityStatus) {
|
|
58
58
|
ItemAvailabilityStatus["AVAILABLE"] = "AVAILABLE";
|
|
59
|
-
/** Item does not exist */
|
|
59
|
+
/** Item does not exist. */
|
|
60
60
|
ItemAvailabilityStatus["NOT_FOUND"] = "NOT_FOUND";
|
|
61
|
-
/** Item not in stock */
|
|
61
|
+
/** Item is not in stock. */
|
|
62
62
|
ItemAvailabilityStatus["NOT_AVAILABLE"] = "NOT_AVAILABLE";
|
|
63
|
-
/** Available quantity is less than requested */
|
|
63
|
+
/** Available quantity is less than requested. */
|
|
64
64
|
ItemAvailabilityStatus["PARTIALLY_AVAILABLE"] = "PARTIALLY_AVAILABLE";
|
|
65
65
|
})(ItemAvailabilityStatus || (exports.ItemAvailabilityStatus = ItemAvailabilityStatus = {}));
|
|
66
66
|
var ItemTypeItemType;
|
|
@@ -162,11 +162,11 @@ var DiscountType;
|
|
|
162
162
|
})(DiscountType || (exports.DiscountType = DiscountType = {}));
|
|
163
163
|
var WeightUnit;
|
|
164
164
|
(function (WeightUnit) {
|
|
165
|
-
/** Weight unit can't be classified
|
|
165
|
+
/** Weight unit can't be classified due to an error. */
|
|
166
166
|
WeightUnit["UNSPECIFIED_WEIGHT_UNIT"] = "UNSPECIFIED_WEIGHT_UNIT";
|
|
167
|
-
/** Kilograms */
|
|
167
|
+
/** Kilograms. */
|
|
168
168
|
WeightUnit["KG"] = "KG";
|
|
169
|
-
/** Pounds */
|
|
169
|
+
/** Pounds. */
|
|
170
170
|
WeightUnit["LB"] = "LB";
|
|
171
171
|
})(WeightUnit || (exports.WeightUnit = WeightUnit = {}));
|
|
172
172
|
var RateType;
|