@wix/auto_sdk_ecom_subscription-contracts 1.0.119 → 1.0.121
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.d.ts +2 -2
- package/build/cjs/index.js +22 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +62 -2
- package/build/cjs/index.typings.js +12 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +61 -1
- package/build/cjs/meta.js +14 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +80 -0
- package/build/cjs/schemas.js +126 -0
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs +22 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +62 -2
- package/build/es/index.typings.mjs +12 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +61 -1
- package/build/es/meta.mjs +14 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +80 -0
- package/build/es/schemas.mjs +126 -0
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/index.js +22 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +197 -10
- package/build/internal/cjs/index.typings.js +12 -0
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +447 -2
- package/build/internal/cjs/meta.js +14 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +80 -0
- package/build/internal/cjs/schemas.js +126 -0
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/index.mjs +22 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +197 -10
- package/build/internal/es/index.typings.mjs +12 -0
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +447 -2
- package/build/internal/es/meta.mjs +14 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +80 -0
- package/build/internal/es/schemas.mjs +126 -0
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +4 -4
|
@@ -32,6 +32,12 @@ interface SubscriptionContract {
|
|
|
32
32
|
* @readonly
|
|
33
33
|
*/
|
|
34
34
|
_updatedDate?: Date | null;
|
|
35
|
+
/**
|
|
36
|
+
* Corresponding billing subscription id
|
|
37
|
+
* @internal
|
|
38
|
+
* @format GUID
|
|
39
|
+
*/
|
|
40
|
+
billingSubscriptionId?: string | null;
|
|
35
41
|
/**
|
|
36
42
|
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
37
43
|
* @maxLength 500
|
|
@@ -92,6 +98,12 @@ interface SubscriptionContract {
|
|
|
92
98
|
billingInfo?: AddressWithContact;
|
|
93
99
|
/** Shipping info and selected shipping option details. */
|
|
94
100
|
shippingInfo?: ShippingInformation;
|
|
101
|
+
/**
|
|
102
|
+
* Tax information.
|
|
103
|
+
* @internal
|
|
104
|
+
* @readonly
|
|
105
|
+
*/
|
|
106
|
+
taxInfo?: OrderTaxInfo;
|
|
95
107
|
/**
|
|
96
108
|
* Applied discounts.
|
|
97
109
|
* @maxSize 100
|
|
@@ -136,6 +148,16 @@ interface SubscriptionContract {
|
|
|
136
148
|
* @maxSize 100
|
|
137
149
|
*/
|
|
138
150
|
additionalFees?: AdditionalFee[];
|
|
151
|
+
/**
|
|
152
|
+
* Order Location
|
|
153
|
+
* @internal
|
|
154
|
+
*/
|
|
155
|
+
businessLocation?: Location;
|
|
156
|
+
/**
|
|
157
|
+
* Contract-level settings and allowed actions.
|
|
158
|
+
* @internal
|
|
159
|
+
*/
|
|
160
|
+
settings?: SubscriptionContractSettings;
|
|
139
161
|
/**
|
|
140
162
|
* Activities recorded on this contract (e.g. draft commits, status changes).
|
|
141
163
|
* @readonly
|
|
@@ -300,6 +322,12 @@ interface OrderLineItem {
|
|
|
300
322
|
* @readonly
|
|
301
323
|
*/
|
|
302
324
|
priceBeforeDiscounts?: Price;
|
|
325
|
+
/**
|
|
326
|
+
* Line item price per unit before line item discounts and before tax.
|
|
327
|
+
* @internal
|
|
328
|
+
* @readonly
|
|
329
|
+
*/
|
|
330
|
+
priceBeforeDiscountsAndTax?: Price;
|
|
303
331
|
/**
|
|
304
332
|
* Total price after discounts, and before tax.
|
|
305
333
|
* @readonly
|
|
@@ -340,6 +368,17 @@ interface OrderLineItem {
|
|
|
340
368
|
* @readonly
|
|
341
369
|
*/
|
|
342
370
|
depositAmount?: Price;
|
|
371
|
+
/**
|
|
372
|
+
* The item's delivery profile ID.
|
|
373
|
+
* @internal
|
|
374
|
+
* @format GUID
|
|
375
|
+
*/
|
|
376
|
+
deliveryProfileId?: string | null;
|
|
377
|
+
/**
|
|
378
|
+
* @internal
|
|
379
|
+
* @format GUID
|
|
380
|
+
*/
|
|
381
|
+
shippingGroupId?: string | null;
|
|
343
382
|
/**
|
|
344
383
|
* Line item locations.
|
|
345
384
|
*
|
|
@@ -349,6 +388,23 @@ interface OrderLineItem {
|
|
|
349
388
|
locations?: LocationAndQuantity[];
|
|
350
389
|
/** Total price **after** catalog discounts and line item discounts. */
|
|
351
390
|
lineItemPrice?: Price;
|
|
391
|
+
/**
|
|
392
|
+
* Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
|
|
393
|
+
* @internal
|
|
394
|
+
* @readonly
|
|
395
|
+
* @immutable
|
|
396
|
+
*/
|
|
397
|
+
customLineItem?: boolean | null;
|
|
398
|
+
/**
|
|
399
|
+
* In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
|
|
400
|
+
* + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
|
|
401
|
+
* + In most cases, this field has the same value as `catalogReference.catalogItemId`.
|
|
402
|
+
* @internal
|
|
403
|
+
* @minLength 1
|
|
404
|
+
* @maxLength 36
|
|
405
|
+
* @readonly
|
|
406
|
+
*/
|
|
407
|
+
rootCatalogItemId?: string | null;
|
|
352
408
|
/** Address used for tax calculation. */
|
|
353
409
|
taxableAddress?: TaxableAddress;
|
|
354
410
|
/**
|
|
@@ -363,6 +419,20 @@ interface OrderLineItem {
|
|
|
363
419
|
* Default: `false`
|
|
364
420
|
*/
|
|
365
421
|
priceUndetermined?: boolean;
|
|
422
|
+
/**
|
|
423
|
+
* Whether the line item quantity is fixed and cannot be changed.
|
|
424
|
+
*
|
|
425
|
+
* Default: `false`
|
|
426
|
+
*/
|
|
427
|
+
fixedQuantity?: boolean;
|
|
428
|
+
/**
|
|
429
|
+
* Decimal-quantity metadata. Set when the line represents a
|
|
430
|
+
* non-integer purchase (e.g. 2.75 m² of fake grass).
|
|
431
|
+
*
|
|
432
|
+
* When set, the line item must have `fixedQuantity` = true and be set with `quantity` = 1.
|
|
433
|
+
* The decimal value lives in `decimalQuantity.value`.
|
|
434
|
+
*/
|
|
435
|
+
decimalQuantity?: DecimalQuantity;
|
|
366
436
|
/**
|
|
367
437
|
* Custom extended fields for the line item object.
|
|
368
438
|
*
|
|
@@ -383,6 +453,12 @@ interface OrderLineItem {
|
|
|
383
453
|
* @immutable
|
|
384
454
|
*/
|
|
385
455
|
externalLineItemId?: string | null;
|
|
456
|
+
/**
|
|
457
|
+
* Service properties. When relevant, this contains information such as the date and number of participants.
|
|
458
|
+
* @internal
|
|
459
|
+
* @readonly
|
|
460
|
+
*/
|
|
461
|
+
serviceProperties?: ServiceProperties;
|
|
386
462
|
}
|
|
387
463
|
interface ProductName {
|
|
388
464
|
/**
|
|
@@ -452,8 +528,26 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
|
|
|
452
528
|
plainText?: PlainTextValue;
|
|
453
529
|
/** Description line color value. */
|
|
454
530
|
colorInfo?: Color;
|
|
531
|
+
/**
|
|
532
|
+
* Description line plain text value.
|
|
533
|
+
* @internal
|
|
534
|
+
* @deprecated
|
|
535
|
+
*/
|
|
536
|
+
plainTextValue?: PlainTextValue;
|
|
537
|
+
/**
|
|
538
|
+
* Description line color.
|
|
539
|
+
* @internal
|
|
540
|
+
* @deprecated
|
|
541
|
+
*/
|
|
542
|
+
color?: string;
|
|
455
543
|
/** Description line name. */
|
|
456
544
|
name?: DescriptionLineName;
|
|
545
|
+
/**
|
|
546
|
+
* Description line type.
|
|
547
|
+
* @internal
|
|
548
|
+
* @deprecated
|
|
549
|
+
*/
|
|
550
|
+
lineType?: DescriptionLineTypeWithLiterals;
|
|
457
551
|
}
|
|
458
552
|
/** @oneof */
|
|
459
553
|
interface DescriptionLineValueOneOf {
|
|
@@ -464,6 +558,18 @@ interface DescriptionLineValueOneOf {
|
|
|
464
558
|
}
|
|
465
559
|
/** @oneof */
|
|
466
560
|
interface DescriptionLineDescriptionLineValueOneOf {
|
|
561
|
+
/**
|
|
562
|
+
* Description line plain text value.
|
|
563
|
+
* @internal
|
|
564
|
+
* @deprecated
|
|
565
|
+
*/
|
|
566
|
+
plainTextValue?: PlainTextValue;
|
|
567
|
+
/**
|
|
568
|
+
* Description line color.
|
|
569
|
+
* @internal
|
|
570
|
+
* @deprecated
|
|
571
|
+
*/
|
|
572
|
+
color?: string;
|
|
467
573
|
}
|
|
468
574
|
interface DescriptionLineName {
|
|
469
575
|
/**
|
|
@@ -645,6 +751,12 @@ type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' |
|
|
|
645
751
|
interface ItemTaxFullDetails {
|
|
646
752
|
/** Taxable amount of this line item. */
|
|
647
753
|
taxableAmount?: Price;
|
|
754
|
+
/**
|
|
755
|
+
* ID of the item's tax group, if specified.
|
|
756
|
+
* @internal
|
|
757
|
+
* @format GUID
|
|
758
|
+
*/
|
|
759
|
+
taxGroupId?: string | null;
|
|
648
760
|
/**
|
|
649
761
|
* Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`.
|
|
650
762
|
* @decimalValue options { gte:0, maxScale:6 }
|
|
@@ -1002,12 +1114,11 @@ type TaxableAddressTypeWithLiterals = TaxableAddressType | 'BUSINESS' | 'BILLING
|
|
|
1002
1114
|
* than from `lineItem.quantity`.
|
|
1003
1115
|
*/
|
|
1004
1116
|
interface DecimalQuantity extends DecimalQuantityUnitOneOf {
|
|
1005
|
-
/**
|
|
1117
|
+
/** Unit the value is expressed in, selected from the standard `measurementUnit` enum. */
|
|
1006
1118
|
measurementUnit?: MeasurementUnitWithLiterals;
|
|
1007
1119
|
/**
|
|
1008
1120
|
* Free-form unit name for standard units not in the
|
|
1009
1121
|
* `measurementUnit` enum (e.g. "hour", "minute", "session").
|
|
1010
|
-
* @internal
|
|
1011
1122
|
* @minLength 1
|
|
1012
1123
|
* @maxLength 50
|
|
1013
1124
|
*/
|
|
@@ -1019,25 +1130,22 @@ interface DecimalQuantity extends DecimalQuantityUnitOneOf {
|
|
|
1019
1130
|
* rounding, no conversion to an integer.
|
|
1020
1131
|
*
|
|
1021
1132
|
* Examples: "2.75", "1.5", "0.75".
|
|
1022
|
-
* @internal
|
|
1023
1133
|
* @decimalValue options { gt:0, lte:1000000000000000, maxScale:4 }
|
|
1024
1134
|
*/
|
|
1025
1135
|
value?: string;
|
|
1026
1136
|
/**
|
|
1027
|
-
* Human-readable
|
|
1028
|
-
*
|
|
1029
|
-
* @internal
|
|
1137
|
+
* Human-readable, pre-formatted display string for the quantity. For example, "2.75 square meters of fake grass".
|
|
1138
|
+
* Always set alongside `value`; use this directly for display rather than composing your own string from `value` and `unit`.
|
|
1030
1139
|
*/
|
|
1031
1140
|
description?: TranslatableString;
|
|
1032
1141
|
}
|
|
1033
1142
|
/** @oneof */
|
|
1034
1143
|
interface DecimalQuantityUnitOneOf {
|
|
1035
|
-
/**
|
|
1144
|
+
/** Unit the value is expressed in, selected from the standard `measurementUnit` enum. */
|
|
1036
1145
|
measurementUnit?: MeasurementUnitWithLiterals;
|
|
1037
1146
|
/**
|
|
1038
1147
|
* Free-form unit name for standard units not in the
|
|
1039
1148
|
* `measurementUnit` enum (e.g. "hour", "minute", "session").
|
|
1040
|
-
* @internal
|
|
1041
1149
|
* @minLength 1
|
|
1042
1150
|
* @maxLength 50
|
|
1043
1151
|
*/
|
|
@@ -1137,6 +1245,25 @@ interface ItemModifier {
|
|
|
1137
1245
|
/** The price of the modifier. */
|
|
1138
1246
|
price?: Price;
|
|
1139
1247
|
}
|
|
1248
|
+
interface ServiceProperties {
|
|
1249
|
+
/**
|
|
1250
|
+
* Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
1251
|
+
* For example, the start time of a class.
|
|
1252
|
+
*/
|
|
1253
|
+
scheduledDate?: Date | null;
|
|
1254
|
+
/**
|
|
1255
|
+
* The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
|
|
1256
|
+
* @min 1
|
|
1257
|
+
* @max 10000
|
|
1258
|
+
*/
|
|
1259
|
+
numberOfParticipants?: number | null;
|
|
1260
|
+
/**
|
|
1261
|
+
* Date and time the service is to be ended, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
1262
|
+
* For example, the date and time a class will end.
|
|
1263
|
+
* @internal
|
|
1264
|
+
*/
|
|
1265
|
+
endDate?: Date | null;
|
|
1266
|
+
}
|
|
1140
1267
|
/** Buyer information. */
|
|
1141
1268
|
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
1142
1269
|
/**
|
|
@@ -1210,8 +1337,26 @@ interface PriceSummary {
|
|
|
1210
1337
|
tax?: Price;
|
|
1211
1338
|
/** Total discount amount applied to the order. */
|
|
1212
1339
|
discount?: Price;
|
|
1340
|
+
/**
|
|
1341
|
+
* Deprecated - use `total` instead.
|
|
1342
|
+
* @internal
|
|
1343
|
+
* @deprecated
|
|
1344
|
+
*/
|
|
1345
|
+
totalPrice?: Price;
|
|
1213
1346
|
/** Order's total price after discounts and tax. */
|
|
1214
1347
|
total?: Price;
|
|
1348
|
+
/**
|
|
1349
|
+
* Order's total price including gift card.
|
|
1350
|
+
* @internal
|
|
1351
|
+
* @deprecated
|
|
1352
|
+
*/
|
|
1353
|
+
totalWithGiftCard?: Price;
|
|
1354
|
+
/**
|
|
1355
|
+
* Order's total price after without gift card.
|
|
1356
|
+
* @internal
|
|
1357
|
+
* @deprecated
|
|
1358
|
+
*/
|
|
1359
|
+
totalWithoutGiftCard?: Price;
|
|
1215
1360
|
/** Total additional fees before tax. */
|
|
1216
1361
|
totalAdditionalFees?: Price;
|
|
1217
1362
|
}
|
|
@@ -1323,6 +1468,16 @@ interface StreetAddress {
|
|
|
1323
1468
|
number?: string;
|
|
1324
1469
|
/** Street name. */
|
|
1325
1470
|
name?: string;
|
|
1471
|
+
/**
|
|
1472
|
+
* Apartment number.
|
|
1473
|
+
* @internal
|
|
1474
|
+
*/
|
|
1475
|
+
apt?: string;
|
|
1476
|
+
/**
|
|
1477
|
+
* Optional address line 1
|
|
1478
|
+
* @internal
|
|
1479
|
+
*/
|
|
1480
|
+
formattedAddressLine?: string | null;
|
|
1326
1481
|
}
|
|
1327
1482
|
interface AddressLocation {
|
|
1328
1483
|
/** Address latitude. */
|
|
@@ -1483,6 +1638,8 @@ interface PickupAddress {
|
|
|
1483
1638
|
* @readonly
|
|
1484
1639
|
*/
|
|
1485
1640
|
subdivisionFullname?: string | null;
|
|
1641
|
+
/** @internal */
|
|
1642
|
+
location?: AddressLocation;
|
|
1486
1643
|
}
|
|
1487
1644
|
declare enum PickupMethod {
|
|
1488
1645
|
STORE_PICKUP = "STORE_PICKUP",
|
|
@@ -1539,6 +1696,13 @@ interface OrderTaxInfo {
|
|
|
1539
1696
|
* @maxSize 50
|
|
1540
1697
|
*/
|
|
1541
1698
|
taxBreakdown?: OrderTaxBreakdown[];
|
|
1699
|
+
/**
|
|
1700
|
+
* Manual tax rate
|
|
1701
|
+
* @internal
|
|
1702
|
+
* @decimalValue options { gte:0 }
|
|
1703
|
+
* @readonly
|
|
1704
|
+
*/
|
|
1705
|
+
manualTaxRate?: string | null;
|
|
1542
1706
|
/**
|
|
1543
1707
|
* Whether the order is exempt from tax calculations.
|
|
1544
1708
|
*
|
|
@@ -1583,6 +1747,11 @@ interface OrderTaxBreakdown {
|
|
|
1583
1747
|
rate?: string;
|
|
1584
1748
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1585
1749
|
aggregatedTaxAmount?: Price;
|
|
1750
|
+
/**
|
|
1751
|
+
* The sum of all the taxable amount from line items for tax identifiers.
|
|
1752
|
+
* @internal
|
|
1753
|
+
*/
|
|
1754
|
+
aggregatedTaxableAmount?: Price;
|
|
1586
1755
|
/**
|
|
1587
1756
|
* The aggregated exempt amount from all line items for tax identifiers.
|
|
1588
1757
|
* @internal
|
|
@@ -1689,6 +1858,12 @@ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1689
1858
|
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
1690
1859
|
*/
|
|
1691
1860
|
percentage?: string | null;
|
|
1861
|
+
/**
|
|
1862
|
+
* Discount name.
|
|
1863
|
+
* @internal
|
|
1864
|
+
* @maxLength 200
|
|
1865
|
+
*/
|
|
1866
|
+
name?: string | null;
|
|
1692
1867
|
}
|
|
1693
1868
|
/** @oneof */
|
|
1694
1869
|
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
@@ -2347,6 +2522,13 @@ interface GetSubscriptionContractResponse {
|
|
|
2347
2522
|
interface UpdateSubscriptionContractRequest {
|
|
2348
2523
|
/** SubscriptionContract to be updated, may be partial. */
|
|
2349
2524
|
subscriptionContract?: SubscriptionContract;
|
|
2525
|
+
/**
|
|
2526
|
+
* Set of fields to update.
|
|
2527
|
+
*
|
|
2528
|
+
* Fields that aren't included in `fieldMask.paths` are ignored.
|
|
2529
|
+
* @internal
|
|
2530
|
+
*/
|
|
2531
|
+
fieldMask?: string[];
|
|
2350
2532
|
}
|
|
2351
2533
|
interface UpdateSubscriptionContractResponse {
|
|
2352
2534
|
/** Updated SubscriptionContract. */
|
|
@@ -2587,6 +2769,11 @@ interface BulkUpdateSubscriptionContractsRequest {
|
|
|
2587
2769
|
interface MaskedSubscriptionContract {
|
|
2588
2770
|
/** Subscription contract to be updated. */
|
|
2589
2771
|
subscriptionContract?: SubscriptionContract;
|
|
2772
|
+
/**
|
|
2773
|
+
* Field mask of fields to update.
|
|
2774
|
+
* @internal
|
|
2775
|
+
*/
|
|
2776
|
+
fieldMask?: string[];
|
|
2590
2777
|
}
|
|
2591
2778
|
interface BulkUpdateSubscriptionContractsResponse {
|
|
2592
2779
|
/**
|
|
@@ -2844,7 +3031,7 @@ declare function onSubscriptionContractUpdated(handler: (event: SubscriptionCont
|
|
|
2844
3031
|
* @returns The requested SubscriptionContract.
|
|
2845
3032
|
* @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.GetSubscriptionContract
|
|
2846
3033
|
*/
|
|
2847
|
-
declare function getSubscriptionContract(subscriptionContractId: string): Promise<NonNullablePaths<SubscriptionContract, `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `subscriptionSettings.enableCustomerCancellation` | `subscriptionSettings.freeTrialPeriod.frequency` | `subscriptionSettings.freeTrialPeriod.interval` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `weightUnit` | `taxIncludedInPrices` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `activities` | `activities.${number}.changesApplied.draftSubscriptionContractId` | `activities.${number}._id` | `activities.${number}.author.userId` | `activities.${number}.author.appId` | `activities.${number}.activityType`, 6>>;
|
|
3034
|
+
declare function getSubscriptionContract(subscriptionContractId: string): Promise<NonNullablePaths<SubscriptionContract, `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `subscriptionSettings.enableCustomerCancellation` | `subscriptionSettings.freeTrialPeriod.frequency` | `subscriptionSettings.freeTrialPeriod.interval` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `weightUnit` | `taxIncludedInPrices` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `activities` | `activities.${number}.changesApplied.draftSubscriptionContractId` | `activities.${number}._id` | `activities.${number}.author.userId` | `activities.${number}.author.appId` | `activities.${number}.activityType`, 6>>;
|
|
2848
3035
|
/**
|
|
2849
3036
|
* Retrieves a list of SubscriptionContracts, given the provided [paging, filtering, and sorting][1].
|
|
2850
3037
|
*
|
|
@@ -3010,4 +3197,4 @@ declare const utils: {
|
|
|
3010
3197
|
};
|
|
3011
3198
|
};
|
|
3012
3199
|
|
|
3013
|
-
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, ActionInitiator, type ActionInitiatorWithLiterals, type ActivityAuthor, type ActivityAuthorValueOneOf, ActivityType, type ActivityTypeWithLiterals, type AdditionalFee, type AdditionalFeeDelta, type AdditionalFeeDeltaDeltaDetailsOneOf, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AdjustmentTypeWithLiterals, type ApplicationError, type AppliedDiscount, type AppliedDiscountDelta, type AppliedDiscountDeltaDeltaDetailsOneOf, type AppliedDiscountDiscountSourceOneOf, type BaseEventMetadata, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BillingSettings, type BulkActionMetadata, type BulkCreateSubscriptionContractsRequest, type BulkCreateSubscriptionContractsResponse, type BulkSubscriptionContractResult, type BulkUpdateSubscriptionContractsRequest, type BulkUpdateSubscriptionContractsResponse, type BuyerInfo, type BuyerInfoIdOneOf, type CatalogReference, ChangeType, type ChangeTypeWithLiterals, type ChangesAppliedActivity, type ChangesAppliedActivityTargetOneOf, type ChannelInfo, ChannelType, type ChannelTypeWithLiterals, ChargeType, type ChargeTypeWithLiterals, type Color, type CommitSubscriptionContractChangesRequest, type CommitSubscriptionContractChangesResponse, type CommonQueryWithEntityContext, type ContractChange, type ContractChangeValueOneOf, type ContractTarget, type Coupon, type CreateSubscriptionContractRequest, type CreateSubscriptionContractResponse, type CurrencyConversionDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomField, type DecimalQuantity, type DecimalQuantityUnitOneOf, type DeliveryLogistics, type DeliveryLogisticsAddressOneOf, type DeliveryTimeSlot, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type DigitalFile, type Dimensions, DimensionsUnit, type DimensionsUnitWithLiterals, DiscountReason, type DiscountReasonWithLiterals, type DiscountRule, type DiscountRuleName, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type FocalPoint, type FreeTrialPeriod, type FullAddressContactDetails, type GetSubscriptionContractRequest, type GetSubscriptionContractResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemCombination, type ItemCombinationLineItem, type ItemMetadata, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemChanges, type LineItemDelta, type LineItemDiscount, type LineItemQuantityChange, LineItemQuantityChangeType, type LineItemQuantityChangeTypeWithLiterals, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type ManagedAdditionalFee, type ManagedDiscount, type ManagedLineItem, type MaskedSubscriptionContract, MeasurementUnit, type MeasurementUnitWithLiterals, type MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf, type MessageEnvelope, type ModifierGroup, type OrderLineItem, type OrderTaxBreakdown, type OrderTaxInfo, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PickupAddress, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, type PlatformFeeSummary, type Price, type PriceDescription, type PriceSummary, type ProductName, ProductPeriodAlignment, type ProductPeriodAlignmentWithLiterals, type QuerySubscriptionContractsRequest, type QuerySubscriptionContractsResponse, type RestockLocation, type RestoreInfo, type ShippingInformation, type ShippingPrice, type ShippingRegion, SortOrder, type SortOrderWithLiterals, type Sorting, SpecificItemsCouponBehavior, type SpecificItemsCouponBehaviorWithLiterals, type StreetAddress, type SubscriptionCommitSettings, type SubscriptionContract, type SubscriptionContractActivity, type SubscriptionContractActivityContentOneOf, type SubscriptionContractActivityTargetOneOf, type SubscriptionContractCanceled, type SubscriptionContractChangesCommitted, type SubscriptionContractCreatedEnvelope, type SubscriptionContractDeletedEnvelope, type SubscriptionContractDiffs, type SubscriptionContractExpired, type SubscriptionContractQuery, type SubscriptionContractQuerySpec, type SubscriptionContractSettings, type SubscriptionContractUpdatedEnvelope, type SubscriptionContractsQueryBuilder, type SubscriptionContractsQueryResult, type SubscriptionDescription, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionInfo, type SubscriptionSettings, SubscriptionSettingsProductPeriodAlignment, type SubscriptionSettingsProductPeriodAlignmentWithLiterals, type SubscriptionTitle, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TotalPriceChange, type TranslatableString, type TranslatedValue, type UpdateSubscriptionContractRequest, type UpdateSubscriptionContractResponse, type V1BillingSettings, type V1FreeTrialPeriod, type V1SubscriptionDescription, type V1SubscriptionSettings, type V1SubscriptionTitle, V2SubscriptionFrequency, type V2SubscriptionFrequencyWithLiterals, type VatId, VatType, type VatTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, getSubscriptionContract, onSubscriptionContractCreated, onSubscriptionContractDeleted, onSubscriptionContractUpdated, querySubscriptionContracts, typedQuerySubscriptionContracts, utils };
|
|
3200
|
+
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, ActionInitiator, type ActionInitiatorWithLiterals, type ActivityAuthor, type ActivityAuthorValueOneOf, ActivityType, type ActivityTypeWithLiterals, type AdditionalFee, type AdditionalFeeDelta, type AdditionalFeeDeltaDeltaDetailsOneOf, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AdjustmentTypeWithLiterals, type ApplicationError, type AppliedDiscount, type AppliedDiscountDelta, type AppliedDiscountDeltaDeltaDetailsOneOf, type AppliedDiscountDiscountSourceOneOf, type BaseEventMetadata, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BillingSettings, type BulkActionMetadata, type BulkCreateSubscriptionContractsRequest, type BulkCreateSubscriptionContractsResponse, type BulkSubscriptionContractResult, type BulkUpdateSubscriptionContractsRequest, type BulkUpdateSubscriptionContractsResponse, type BuyerInfo, type BuyerInfoIdOneOf, type CatalogReference, ChangeType, type ChangeTypeWithLiterals, type ChangesAppliedActivity, type ChangesAppliedActivityTargetOneOf, type ChannelInfo, ChannelType, type ChannelTypeWithLiterals, ChargeType, type ChargeTypeWithLiterals, type Color, type CommitSubscriptionContractChangesRequest, type CommitSubscriptionContractChangesResponse, type CommonQueryWithEntityContext, type ContractChange, type ContractChangeValueOneOf, type ContractTarget, type Coupon, type CreateSubscriptionContractRequest, type CreateSubscriptionContractResponse, type CurrencyConversionDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomField, type DecimalQuantity, type DecimalQuantityUnitOneOf, type DeliveryLogistics, type DeliveryLogisticsAddressOneOf, type DeliveryTimeSlot, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type DigitalFile, type Dimensions, DimensionsUnit, type DimensionsUnitWithLiterals, DiscountReason, type DiscountReasonWithLiterals, type DiscountRule, type DiscountRuleName, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type FocalPoint, type FreeTrialPeriod, type FullAddressContactDetails, type GetSubscriptionContractRequest, type GetSubscriptionContractResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemCombination, type ItemCombinationLineItem, type ItemMetadata, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemChanges, type LineItemDelta, type LineItemDiscount, type LineItemQuantityChange, LineItemQuantityChangeType, type LineItemQuantityChangeTypeWithLiterals, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type ManagedAdditionalFee, type ManagedDiscount, type ManagedLineItem, type MaskedSubscriptionContract, MeasurementUnit, type MeasurementUnitWithLiterals, type MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf, type MessageEnvelope, type ModifierGroup, type OrderLineItem, type OrderTaxBreakdown, type OrderTaxInfo, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PickupAddress, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, type PlatformFeeSummary, type Price, type PriceDescription, type PriceSummary, type ProductName, ProductPeriodAlignment, type ProductPeriodAlignmentWithLiterals, type QuerySubscriptionContractsRequest, type QuerySubscriptionContractsResponse, type RestockLocation, type RestoreInfo, type ServiceProperties, type ShippingInformation, type ShippingPrice, type ShippingRegion, SortOrder, type SortOrderWithLiterals, type Sorting, SpecificItemsCouponBehavior, type SpecificItemsCouponBehaviorWithLiterals, type StreetAddress, type SubscriptionCommitSettings, type SubscriptionContract, type SubscriptionContractActivity, type SubscriptionContractActivityContentOneOf, type SubscriptionContractActivityTargetOneOf, type SubscriptionContractCanceled, type SubscriptionContractChangesCommitted, type SubscriptionContractCreatedEnvelope, type SubscriptionContractDeletedEnvelope, type SubscriptionContractDiffs, type SubscriptionContractExpired, type SubscriptionContractQuery, type SubscriptionContractQuerySpec, type SubscriptionContractSettings, type SubscriptionContractUpdatedEnvelope, type SubscriptionContractsQueryBuilder, type SubscriptionContractsQueryResult, type SubscriptionDescription, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionInfo, type SubscriptionSettings, SubscriptionSettingsProductPeriodAlignment, type SubscriptionSettingsProductPeriodAlignmentWithLiterals, type SubscriptionTitle, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TotalPriceChange, type TranslatableString, type TranslatedValue, type UpdateSubscriptionContractRequest, type UpdateSubscriptionContractResponse, type V1BillingSettings, type V1FreeTrialPeriod, type V1SubscriptionDescription, type V1SubscriptionSettings, type V1SubscriptionTitle, V2SubscriptionFrequency, type V2SubscriptionFrequencyWithLiterals, type VatId, VatType, type VatTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, getSubscriptionContract, onSubscriptionContractCreated, onSubscriptionContractDeleted, onSubscriptionContractUpdated, querySubscriptionContracts, typedQuerySubscriptionContracts, utils };
|
|
@@ -133,6 +133,12 @@ function getSubscriptionContract(payload) {
|
|
|
133
133
|
{
|
|
134
134
|
path: "subscriptionContract.lineItems.subscriptionInfo.subscriptionSettings.startDate"
|
|
135
135
|
},
|
|
136
|
+
{
|
|
137
|
+
path: "subscriptionContract.lineItems.serviceProperties.scheduledDate"
|
|
138
|
+
},
|
|
139
|
+
{
|
|
140
|
+
path: "subscriptionContract.lineItems.serviceProperties.endDate"
|
|
141
|
+
},
|
|
136
142
|
{
|
|
137
143
|
path: "subscriptionContract.shippingInfo.logistics.deliverByDate"
|
|
138
144
|
},
|
|
@@ -217,6 +223,12 @@ function querySubscriptionContracts(payload) {
|
|
|
217
223
|
{
|
|
218
224
|
path: "subscriptionContracts.lineItems.subscriptionInfo.subscriptionSettings.startDate"
|
|
219
225
|
},
|
|
226
|
+
{
|
|
227
|
+
path: "subscriptionContracts.lineItems.serviceProperties.scheduledDate"
|
|
228
|
+
},
|
|
229
|
+
{
|
|
230
|
+
path: "subscriptionContracts.lineItems.serviceProperties.endDate"
|
|
231
|
+
},
|
|
220
232
|
{
|
|
221
233
|
path: "subscriptionContracts.shippingInfo.logistics.deliverByDate"
|
|
222
234
|
},
|