@wix/auto_sdk_ecom_subscription-contracts 1.0.146 → 1.0.148
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.js +32 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +69 -55
- package/build/cjs/index.typings.js +32 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +69 -55
- package/build/cjs/meta.js +32 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.mjs +32 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +69 -55
- package/build/es/index.typings.mjs +32 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +69 -55
- package/build/es/meta.mjs +32 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +73 -59
- package/build/internal/cjs/meta.d.ts +73 -59
- package/build/internal/es/index.typings.d.mts +73 -59
- package/build/internal/es/meta.d.mts +73 -59
- package/package.json +2 -2
|
@@ -6,7 +6,7 @@ import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
|
|
|
6
6
|
*
|
|
7
7
|
* A subscription contract is created when a buyer checks out with a subscription item. Each billing cycle, an order is created from the contract's current content. The order's `lineItems.subscriptionInfo.id` holds the contract ID, and `lineItems.subscriptionInfo.cycleNumber` holds the billing cycle the order is for.
|
|
8
8
|
*
|
|
9
|
-
* To change a subscription contract, create a draft subscription contract, edit it, and commit it.
|
|
9
|
+
* To change a subscription contract, create a [draft subscription contract](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/subscriptions/draft-subscription-contracts/introduction), edit it, and commit it.
|
|
10
10
|
*/
|
|
11
11
|
interface SubscriptionContract {
|
|
12
12
|
/**
|
|
@@ -241,9 +241,13 @@ interface V1SubscriptionSettings {
|
|
|
241
241
|
}
|
|
242
242
|
declare enum SubscriptionFrequency {
|
|
243
243
|
UNDEFINED = "UNDEFINED",
|
|
244
|
+
/** Day. */
|
|
244
245
|
DAY = "DAY",
|
|
246
|
+
/** Week. */
|
|
245
247
|
WEEK = "WEEK",
|
|
248
|
+
/** Month. */
|
|
246
249
|
MONTH = "MONTH",
|
|
250
|
+
/** Year. */
|
|
247
251
|
YEAR = "YEAR"
|
|
248
252
|
}
|
|
249
253
|
/** @enumType */
|
|
@@ -944,10 +948,16 @@ interface DigitalFile {
|
|
|
944
948
|
interface SubscriptionInfo {
|
|
945
949
|
/**
|
|
946
950
|
* Subscription ID.
|
|
951
|
+
*
|
|
952
|
+
* For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
|
|
953
|
+
* To retrieve the subscription contract, call [Get Subscription Contract](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/subscriptions/subscription-contracts/get-subscription-contract).
|
|
947
954
|
* @format GUID
|
|
948
955
|
*/
|
|
949
956
|
_id?: string | null;
|
|
950
|
-
/**
|
|
957
|
+
/**
|
|
958
|
+
* Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
|
|
959
|
+
* When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
|
|
960
|
+
*/
|
|
951
961
|
cycleNumber?: number;
|
|
952
962
|
/**
|
|
953
963
|
* Subscription option title. For example, `"Monthly coffee Subscription"`.
|
|
@@ -1023,7 +1033,7 @@ interface SubscriptionDescription {
|
|
|
1023
1033
|
translated?: string | null;
|
|
1024
1034
|
}
|
|
1025
1035
|
interface SubscriptionSettings {
|
|
1026
|
-
/** Frequency of
|
|
1036
|
+
/** Frequency unit of the billing cycle. */
|
|
1027
1037
|
frequency?: V2SubscriptionFrequencyWithLiterals;
|
|
1028
1038
|
/**
|
|
1029
1039
|
* Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
|
|
@@ -1031,16 +1041,20 @@ interface SubscriptionSettings {
|
|
|
1031
1041
|
* @max 3650
|
|
1032
1042
|
*/
|
|
1033
1043
|
interval?: number | null;
|
|
1034
|
-
/** Whether subscription
|
|
1044
|
+
/** Whether the subscription renews automatically at the end of each billing cycle. */
|
|
1035
1045
|
autoRenewal?: boolean;
|
|
1036
1046
|
/**
|
|
1037
|
-
* Number of billing cycles before subscription ends. Ignored
|
|
1047
|
+
* Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
|
|
1038
1048
|
* @min 1
|
|
1039
1049
|
*/
|
|
1040
1050
|
billingCycles?: number | null;
|
|
1041
|
-
/** Whether
|
|
1051
|
+
/** Whether the buyer can cancel the subscription. */
|
|
1042
1052
|
enableCustomerCancellation?: boolean;
|
|
1043
|
-
/**
|
|
1053
|
+
/**
|
|
1054
|
+
* Free trial period before the first billing cycle starts.
|
|
1055
|
+
*
|
|
1056
|
+
* Returned only when the subscription has a free trial.
|
|
1057
|
+
*/
|
|
1044
1058
|
freeTrialPeriod?: FreeTrialPeriod;
|
|
1045
1059
|
/**
|
|
1046
1060
|
* The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
|
|
@@ -1069,7 +1083,7 @@ declare enum V2SubscriptionFrequency {
|
|
|
1069
1083
|
/** @enumType */
|
|
1070
1084
|
type V2SubscriptionFrequencyWithLiterals = V2SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
1071
1085
|
interface FreeTrialPeriod {
|
|
1072
|
-
/** Frequency of
|
|
1086
|
+
/** Frequency unit of the free trial period. */
|
|
1073
1087
|
frequency?: V2SubscriptionFrequencyWithLiterals;
|
|
1074
1088
|
/**
|
|
1075
1089
|
* Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
|
|
@@ -2697,7 +2711,7 @@ interface SubscriptionContractChangesCommitted {
|
|
|
2697
2711
|
* @maxLength 200
|
|
2698
2712
|
*/
|
|
2699
2713
|
reason?: string | null;
|
|
2700
|
-
/** Price summary of the contract after the commit. */
|
|
2714
|
+
/** Price summary of the subscription contract after the commit. Same as `changes.priceSummary`. */
|
|
2701
2715
|
priceSummary?: PriceSummary;
|
|
2702
2716
|
}
|
|
2703
2717
|
interface SubscriptionContractDiffs {
|
|
@@ -2724,7 +2738,7 @@ interface SubscriptionContractDiffs {
|
|
|
2724
2738
|
additionalFees?: AdditionalFeeDelta[];
|
|
2725
2739
|
/** Price summary after the changes. Replaces the subscription contract's previous price summary. */
|
|
2726
2740
|
priceSummary?: PriceSummary;
|
|
2727
|
-
/** Tax information after the changes.
|
|
2741
|
+
/** Tax information after the changes. */
|
|
2728
2742
|
taxInfo?: OrderTaxInfo;
|
|
2729
2743
|
/** Shipping information after the changes. Replaces the subscription contract's previous shipping information. */
|
|
2730
2744
|
shippingInfo?: ShippingInformation;
|
|
@@ -2747,104 +2761,104 @@ interface LineItemDeltaDeltaDetailsOneOf {
|
|
|
2747
2761
|
/** Values the line item had before the change. */
|
|
2748
2762
|
changed?: ItemChangedDetails;
|
|
2749
2763
|
}
|
|
2750
|
-
/**
|
|
2764
|
+
/** Catalog reference options before the change. */
|
|
2751
2765
|
interface CatalogReferenceOptionsBeforeChange {
|
|
2752
|
-
/**
|
|
2766
|
+
/** Catalog reference options. Absent when the line item had no options. */
|
|
2753
2767
|
options?: Record<string, any> | null;
|
|
2754
2768
|
}
|
|
2755
|
-
/**
|
|
2769
|
+
/** Product name before the change. */
|
|
2756
2770
|
interface ProductNameBeforeChange {
|
|
2757
|
-
/**
|
|
2771
|
+
/** Product name. Absent when the line item had no product name. */
|
|
2758
2772
|
productName?: ProductName;
|
|
2759
2773
|
}
|
|
2760
|
-
/**
|
|
2774
|
+
/** Description lines before the change. */
|
|
2761
2775
|
interface DescriptionLinesBeforeChange {
|
|
2762
2776
|
/**
|
|
2763
|
-
*
|
|
2777
|
+
* Description lines. Empty when the line item had no description lines.
|
|
2764
2778
|
* @maxSize 20
|
|
2765
2779
|
*/
|
|
2766
2780
|
descriptionLines?: DescriptionLine[];
|
|
2767
2781
|
}
|
|
2768
|
-
/**
|
|
2782
|
+
/** Image before the change. */
|
|
2769
2783
|
interface ImageBeforeChange {
|
|
2770
|
-
/**
|
|
2784
|
+
/** Image. Absent when the line item had no image. */
|
|
2771
2785
|
image?: string;
|
|
2772
2786
|
}
|
|
2773
|
-
/**
|
|
2787
|
+
/** Physical properties before the change. */
|
|
2774
2788
|
interface PhysicalPropertiesBeforeChange {
|
|
2775
|
-
/**
|
|
2789
|
+
/** Physical properties. Absent when the line item had no physical properties. */
|
|
2776
2790
|
physicalProperties?: PhysicalProperties;
|
|
2777
2791
|
}
|
|
2778
|
-
/**
|
|
2792
|
+
/** Item type before the change. */
|
|
2779
2793
|
interface ItemTypeBeforeChange {
|
|
2780
|
-
/**
|
|
2794
|
+
/** Item type. Absent when the line item had no item type. */
|
|
2781
2795
|
itemType?: ItemType;
|
|
2782
2796
|
}
|
|
2783
|
-
/**
|
|
2797
|
+
/** Fulfiller ID before the change. */
|
|
2784
2798
|
interface FulfillerIdBeforeChange {
|
|
2785
2799
|
/**
|
|
2786
|
-
*
|
|
2800
|
+
* Fulfiller ID. Absent when the line item had no fulfiller.
|
|
2787
2801
|
* @format GUID
|
|
2788
2802
|
*/
|
|
2789
2803
|
fulfillerId?: string | null;
|
|
2790
2804
|
}
|
|
2791
|
-
/**
|
|
2805
|
+
/** Digital file before the change. */
|
|
2792
2806
|
interface DigitalFileBeforeChange {
|
|
2793
|
-
/**
|
|
2807
|
+
/** Digital file. Absent when the line item had no digital file. */
|
|
2794
2808
|
digitalFile?: DigitalFile;
|
|
2795
2809
|
}
|
|
2796
|
-
/**
|
|
2810
|
+
/** Price description before the change. */
|
|
2797
2811
|
interface PriceDescriptionBeforeChange {
|
|
2798
|
-
/**
|
|
2812
|
+
/** Price description. Absent when the line item had no price description. */
|
|
2799
2813
|
priceDescription?: PriceDescription;
|
|
2800
2814
|
}
|
|
2801
|
-
/**
|
|
2815
|
+
/** Delivery profile ID before the change. */
|
|
2802
2816
|
interface DeliveryProfileIdBeforeChange {
|
|
2803
2817
|
/**
|
|
2804
|
-
*
|
|
2818
|
+
* Delivery profile ID. Absent when the line item had no delivery profile.
|
|
2805
2819
|
* @format GUID
|
|
2806
2820
|
*/
|
|
2807
2821
|
deliveryProfileId?: string | null;
|
|
2808
2822
|
}
|
|
2809
|
-
/**
|
|
2823
|
+
/** Shipping group ID before the change. */
|
|
2810
2824
|
interface ShippingGroupIdBeforeChange {
|
|
2811
2825
|
/**
|
|
2812
|
-
*
|
|
2826
|
+
* Shipping group ID. Absent when the line item had no shipping group.
|
|
2813
2827
|
* @format GUID
|
|
2814
2828
|
*/
|
|
2815
2829
|
shippingGroupId?: string | null;
|
|
2816
2830
|
}
|
|
2817
|
-
/**
|
|
2831
|
+
/** Tax info before the change. */
|
|
2818
2832
|
interface TaxInfoBeforeChange {
|
|
2819
|
-
/**
|
|
2833
|
+
/** Tax info. Absent when the line item had no tax info. */
|
|
2820
2834
|
taxInfo?: LineItemTaxInfo;
|
|
2821
2835
|
}
|
|
2822
|
-
/**
|
|
2836
|
+
/** Inventory app ID before the change. */
|
|
2823
2837
|
interface InventoryAppIdBeforeChange {
|
|
2824
2838
|
/**
|
|
2825
|
-
*
|
|
2839
|
+
* Inventory app ID. Absent when the line item had no inventory app.
|
|
2826
2840
|
* @format GUID
|
|
2827
2841
|
*/
|
|
2828
2842
|
inventoryAppId?: string | null;
|
|
2829
2843
|
}
|
|
2830
|
-
/**
|
|
2844
|
+
/** Root catalog item ID before the change. */
|
|
2831
2845
|
interface RootCatalogItemIdBeforeChange {
|
|
2832
2846
|
/**
|
|
2833
|
-
*
|
|
2847
|
+
* Root catalog item ID. Absent when the line item had no root catalog item.
|
|
2834
2848
|
* @minLength 1
|
|
2835
2849
|
* @maxLength 36
|
|
2836
2850
|
*/
|
|
2837
2851
|
rootCatalogItemId?: string | null;
|
|
2838
2852
|
}
|
|
2839
|
-
/**
|
|
2853
|
+
/** Modifier groups before the change. */
|
|
2840
2854
|
interface ModifierGroupsBeforeChange {
|
|
2841
2855
|
/**
|
|
2842
|
-
*
|
|
2856
|
+
* Modifier groups. Empty when the line item had no modifier groups.
|
|
2843
2857
|
* @maxSize 10
|
|
2844
2858
|
*/
|
|
2845
2859
|
modifierGroups?: ModifierGroup[];
|
|
2846
2860
|
}
|
|
2847
|
-
/**
|
|
2861
|
+
/** Price undetermined flag before the change. */
|
|
2848
2862
|
interface PriceUndeterminedBeforeChange {
|
|
2849
2863
|
/** Whether the price of the line item was undetermined. */
|
|
2850
2864
|
priceUndetermined?: boolean;
|
|
@@ -2864,56 +2878,56 @@ declare enum ChangeType {
|
|
|
2864
2878
|
type ChangeTypeWithLiterals = ChangeType | 'UNKNOWN_CHANGE_TYPE' | 'ADDED' | 'CHANGED' | 'REMOVED';
|
|
2865
2879
|
interface ItemChangedDetails {
|
|
2866
2880
|
/**
|
|
2867
|
-
*
|
|
2881
|
+
* Quantity before the change. Set only when the quantity changed.
|
|
2868
2882
|
* @min 1
|
|
2869
2883
|
* @max 1000000
|
|
2870
2884
|
*/
|
|
2871
2885
|
quantityBeforeChange?: number | null;
|
|
2872
|
-
/**
|
|
2886
|
+
/** Price before the change. Set only when the price changed. */
|
|
2873
2887
|
priceBeforeChange?: Price;
|
|
2874
|
-
/**
|
|
2888
|
+
/** Catalog reference options before the change. Set only when the catalog reference options changed. */
|
|
2875
2889
|
catalogReferenceOptionsBeforeChange?: CatalogReferenceOptionsBeforeChange;
|
|
2876
|
-
/**
|
|
2890
|
+
/** Product name before the change. Set only when the product name changed. */
|
|
2877
2891
|
productNameBeforeChange?: ProductNameBeforeChange;
|
|
2878
|
-
/**
|
|
2892
|
+
/** Description lines before the change. Set only when the description lines changed. */
|
|
2879
2893
|
descriptionLinesBeforeChange?: DescriptionLinesBeforeChange;
|
|
2880
|
-
/**
|
|
2894
|
+
/** Image before the change. Set only when the image changed. */
|
|
2881
2895
|
imageBeforeChange?: ImageBeforeChange;
|
|
2882
|
-
/**
|
|
2896
|
+
/** Physical properties before the change. Set only when the physical properties changed. */
|
|
2883
2897
|
physicalPropertiesBeforeChange?: PhysicalPropertiesBeforeChange;
|
|
2884
|
-
/**
|
|
2898
|
+
/** Item type before the change. Set only when the item type changed. */
|
|
2885
2899
|
itemTypeBeforeChange?: ItemTypeBeforeChange;
|
|
2886
|
-
/**
|
|
2900
|
+
/** Fulfiller ID before the change. Set only when the fulfiller ID changed. */
|
|
2887
2901
|
fulfillerIdBeforeChange?: FulfillerIdBeforeChange;
|
|
2888
|
-
/**
|
|
2902
|
+
/** Digital file before the change. Set only when the digital file changed. */
|
|
2889
2903
|
digitalFileBeforeChange?: DigitalFileBeforeChange;
|
|
2890
|
-
/**
|
|
2904
|
+
/** Price description before the change. Set only when the price description changed. */
|
|
2891
2905
|
priceDescriptionBeforeChange?: PriceDescriptionBeforeChange;
|
|
2892
2906
|
/**
|
|
2893
|
-
*
|
|
2907
|
+
* Delivery profile ID before the change. Set only when the delivery profile ID changed.
|
|
2894
2908
|
* @internal
|
|
2895
2909
|
*/
|
|
2896
2910
|
deliveryProfileIdBeforeChange?: DeliveryProfileIdBeforeChange;
|
|
2897
2911
|
/**
|
|
2898
|
-
*
|
|
2912
|
+
* Shipping group ID before the change. Set only when the shipping group ID changed.
|
|
2899
2913
|
* @internal
|
|
2900
2914
|
*/
|
|
2901
2915
|
shippingGroupIdBeforeChange?: ShippingGroupIdBeforeChange;
|
|
2902
|
-
/**
|
|
2916
|
+
/** Tax info before the change. Set only when the line item's tax group changed. */
|
|
2903
2917
|
taxInfoBeforeChange?: TaxInfoBeforeChange;
|
|
2904
2918
|
/**
|
|
2905
|
-
*
|
|
2919
|
+
* Inventory app ID before the change. Set only when the inventory app ID changed.
|
|
2906
2920
|
* @internal
|
|
2907
2921
|
*/
|
|
2908
2922
|
inventoryAppIdBeforeChange?: InventoryAppIdBeforeChange;
|
|
2909
2923
|
/**
|
|
2910
|
-
*
|
|
2924
|
+
* Root catalog item ID before the change. Set only when the root catalog item ID changed.
|
|
2911
2925
|
* @internal
|
|
2912
2926
|
*/
|
|
2913
2927
|
rootCatalogItemIdBeforeChange?: RootCatalogItemIdBeforeChange;
|
|
2914
|
-
/**
|
|
2928
|
+
/** Modifier groups before the change. Set only when the modifier groups changed. */
|
|
2915
2929
|
modifierGroupsBeforeChange?: ModifierGroupsBeforeChange;
|
|
2916
|
-
/**
|
|
2930
|
+
/** Price undetermined flag before the change. Set only when the price undetermined flag changed. */
|
|
2917
2931
|
priceUndeterminedBeforeChange?: PriceUndeterminedBeforeChange;
|
|
2918
2932
|
}
|
|
2919
2933
|
interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaDetailsOneOf {
|
|
@@ -6,7 +6,7 @@ import '@wix/sdk-types';
|
|
|
6
6
|
*
|
|
7
7
|
* A subscription contract is created when a buyer checks out with a subscription item. Each billing cycle, an order is created from the contract's current content. The order's `lineItems.subscriptionInfo.id` holds the contract ID, and `lineItems.subscriptionInfo.cycleNumber` holds the billing cycle the order is for.
|
|
8
8
|
*
|
|
9
|
-
* To change a subscription contract, create a draft subscription contract, edit it, and commit it.
|
|
9
|
+
* To change a subscription contract, create a [draft subscription contract](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/subscriptions/draft-subscription-contracts/introduction), edit it, and commit it.
|
|
10
10
|
*/
|
|
11
11
|
interface SubscriptionContract {
|
|
12
12
|
/**
|
|
@@ -241,9 +241,13 @@ interface V1SubscriptionSettings {
|
|
|
241
241
|
}
|
|
242
242
|
declare enum SubscriptionFrequency {
|
|
243
243
|
UNDEFINED = "UNDEFINED",
|
|
244
|
+
/** Day. */
|
|
244
245
|
DAY = "DAY",
|
|
246
|
+
/** Week. */
|
|
245
247
|
WEEK = "WEEK",
|
|
248
|
+
/** Month. */
|
|
246
249
|
MONTH = "MONTH",
|
|
250
|
+
/** Year. */
|
|
247
251
|
YEAR = "YEAR"
|
|
248
252
|
}
|
|
249
253
|
/** @enumType */
|
|
@@ -985,10 +989,16 @@ interface DigitalFile {
|
|
|
985
989
|
interface SubscriptionInfo {
|
|
986
990
|
/**
|
|
987
991
|
* Subscription ID.
|
|
992
|
+
*
|
|
993
|
+
* For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
|
|
994
|
+
* To retrieve the subscription contract, call [Get Subscription Contract](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/subscriptions/subscription-contracts/get-subscription-contract).
|
|
988
995
|
* @format GUID
|
|
989
996
|
*/
|
|
990
997
|
id?: string | null;
|
|
991
|
-
/**
|
|
998
|
+
/**
|
|
999
|
+
* Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
|
|
1000
|
+
* When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
|
|
1001
|
+
*/
|
|
992
1002
|
cycleNumber?: number;
|
|
993
1003
|
/**
|
|
994
1004
|
* Subscription option title. For example, `"Monthly coffee Subscription"`.
|
|
@@ -1064,7 +1074,7 @@ interface SubscriptionDescription {
|
|
|
1064
1074
|
translated?: string | null;
|
|
1065
1075
|
}
|
|
1066
1076
|
interface SubscriptionSettings {
|
|
1067
|
-
/** Frequency of
|
|
1077
|
+
/** Frequency unit of the billing cycle. */
|
|
1068
1078
|
frequency?: V2SubscriptionFrequencyWithLiterals;
|
|
1069
1079
|
/**
|
|
1070
1080
|
* Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
|
|
@@ -1072,16 +1082,20 @@ interface SubscriptionSettings {
|
|
|
1072
1082
|
* @max 3650
|
|
1073
1083
|
*/
|
|
1074
1084
|
interval?: number | null;
|
|
1075
|
-
/** Whether subscription
|
|
1085
|
+
/** Whether the subscription renews automatically at the end of each billing cycle. */
|
|
1076
1086
|
autoRenewal?: boolean;
|
|
1077
1087
|
/**
|
|
1078
|
-
* Number of billing cycles before subscription ends. Ignored
|
|
1088
|
+
* Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
|
|
1079
1089
|
* @min 1
|
|
1080
1090
|
*/
|
|
1081
1091
|
billingCycles?: number | null;
|
|
1082
|
-
/** Whether
|
|
1092
|
+
/** Whether the buyer can cancel the subscription. */
|
|
1083
1093
|
enableCustomerCancellation?: boolean;
|
|
1084
|
-
/**
|
|
1094
|
+
/**
|
|
1095
|
+
* Free trial period before the first billing cycle starts.
|
|
1096
|
+
*
|
|
1097
|
+
* Returned only when the subscription has a free trial.
|
|
1098
|
+
*/
|
|
1085
1099
|
freeTrialPeriod?: FreeTrialPeriod;
|
|
1086
1100
|
/**
|
|
1087
1101
|
* The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
|
|
@@ -1110,7 +1124,7 @@ declare enum V2SubscriptionFrequency {
|
|
|
1110
1124
|
/** @enumType */
|
|
1111
1125
|
type V2SubscriptionFrequencyWithLiterals = V2SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
1112
1126
|
interface FreeTrialPeriod {
|
|
1113
|
-
/** Frequency of
|
|
1127
|
+
/** Frequency unit of the free trial period. */
|
|
1114
1128
|
frequency?: V2SubscriptionFrequencyWithLiterals;
|
|
1115
1129
|
/**
|
|
1116
1130
|
* Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
|
|
@@ -2738,7 +2752,7 @@ interface SubscriptionContractChangesCommitted {
|
|
|
2738
2752
|
* @maxLength 200
|
|
2739
2753
|
*/
|
|
2740
2754
|
reason?: string | null;
|
|
2741
|
-
/** Price summary of the contract after the commit. */
|
|
2755
|
+
/** Price summary of the subscription contract after the commit. Same as `changes.priceSummary`. */
|
|
2742
2756
|
priceSummary?: PriceSummary;
|
|
2743
2757
|
}
|
|
2744
2758
|
interface SubscriptionContractDiffs {
|
|
@@ -2765,7 +2779,7 @@ interface SubscriptionContractDiffs {
|
|
|
2765
2779
|
additionalFees?: AdditionalFeeDelta[];
|
|
2766
2780
|
/** Price summary after the changes. Replaces the subscription contract's previous price summary. */
|
|
2767
2781
|
priceSummary?: PriceSummary;
|
|
2768
|
-
/** Tax information after the changes.
|
|
2782
|
+
/** Tax information after the changes. */
|
|
2769
2783
|
taxInfo?: OrderTaxInfo;
|
|
2770
2784
|
/** Shipping information after the changes. Replaces the subscription contract's previous shipping information. */
|
|
2771
2785
|
shippingInfo?: ShippingInformation;
|
|
@@ -2821,104 +2835,104 @@ interface CommonImage {
|
|
|
2821
2835
|
*/
|
|
2822
2836
|
filename?: string | null;
|
|
2823
2837
|
}
|
|
2824
|
-
/**
|
|
2838
|
+
/** Catalog reference options before the change. */
|
|
2825
2839
|
interface CatalogReferenceOptionsBeforeChange {
|
|
2826
|
-
/**
|
|
2840
|
+
/** Catalog reference options. Absent when the line item had no options. */
|
|
2827
2841
|
options?: Record<string, any> | null;
|
|
2828
2842
|
}
|
|
2829
|
-
/**
|
|
2843
|
+
/** Product name before the change. */
|
|
2830
2844
|
interface ProductNameBeforeChange {
|
|
2831
|
-
/**
|
|
2845
|
+
/** Product name. Absent when the line item had no product name. */
|
|
2832
2846
|
productName?: ProductName;
|
|
2833
2847
|
}
|
|
2834
|
-
/**
|
|
2848
|
+
/** Description lines before the change. */
|
|
2835
2849
|
interface DescriptionLinesBeforeChange {
|
|
2836
2850
|
/**
|
|
2837
|
-
*
|
|
2851
|
+
* Description lines. Empty when the line item had no description lines.
|
|
2838
2852
|
* @maxSize 20
|
|
2839
2853
|
*/
|
|
2840
2854
|
descriptionLines?: DescriptionLine[];
|
|
2841
2855
|
}
|
|
2842
|
-
/**
|
|
2856
|
+
/** Image before the change. */
|
|
2843
2857
|
interface ImageBeforeChange {
|
|
2844
|
-
/**
|
|
2858
|
+
/** Image. Absent when the line item had no image. */
|
|
2845
2859
|
image?: CommonImage;
|
|
2846
2860
|
}
|
|
2847
|
-
/**
|
|
2861
|
+
/** Physical properties before the change. */
|
|
2848
2862
|
interface PhysicalPropertiesBeforeChange {
|
|
2849
|
-
/**
|
|
2863
|
+
/** Physical properties. Absent when the line item had no physical properties. */
|
|
2850
2864
|
physicalProperties?: PhysicalProperties;
|
|
2851
2865
|
}
|
|
2852
|
-
/**
|
|
2866
|
+
/** Item type before the change. */
|
|
2853
2867
|
interface ItemTypeBeforeChange {
|
|
2854
|
-
/**
|
|
2868
|
+
/** Item type. Absent when the line item had no item type. */
|
|
2855
2869
|
itemType?: ItemType;
|
|
2856
2870
|
}
|
|
2857
|
-
/**
|
|
2871
|
+
/** Fulfiller ID before the change. */
|
|
2858
2872
|
interface FulfillerIdBeforeChange {
|
|
2859
2873
|
/**
|
|
2860
|
-
*
|
|
2874
|
+
* Fulfiller ID. Absent when the line item had no fulfiller.
|
|
2861
2875
|
* @format GUID
|
|
2862
2876
|
*/
|
|
2863
2877
|
fulfillerId?: string | null;
|
|
2864
2878
|
}
|
|
2865
|
-
/**
|
|
2879
|
+
/** Digital file before the change. */
|
|
2866
2880
|
interface DigitalFileBeforeChange {
|
|
2867
|
-
/**
|
|
2881
|
+
/** Digital file. Absent when the line item had no digital file. */
|
|
2868
2882
|
digitalFile?: DigitalFile;
|
|
2869
2883
|
}
|
|
2870
|
-
/**
|
|
2884
|
+
/** Price description before the change. */
|
|
2871
2885
|
interface PriceDescriptionBeforeChange {
|
|
2872
|
-
/**
|
|
2886
|
+
/** Price description. Absent when the line item had no price description. */
|
|
2873
2887
|
priceDescription?: PriceDescription;
|
|
2874
2888
|
}
|
|
2875
|
-
/**
|
|
2889
|
+
/** Delivery profile ID before the change. */
|
|
2876
2890
|
interface DeliveryProfileIdBeforeChange {
|
|
2877
2891
|
/**
|
|
2878
|
-
*
|
|
2892
|
+
* Delivery profile ID. Absent when the line item had no delivery profile.
|
|
2879
2893
|
* @format GUID
|
|
2880
2894
|
*/
|
|
2881
2895
|
deliveryProfileId?: string | null;
|
|
2882
2896
|
}
|
|
2883
|
-
/**
|
|
2897
|
+
/** Shipping group ID before the change. */
|
|
2884
2898
|
interface ShippingGroupIdBeforeChange {
|
|
2885
2899
|
/**
|
|
2886
|
-
*
|
|
2900
|
+
* Shipping group ID. Absent when the line item had no shipping group.
|
|
2887
2901
|
* @format GUID
|
|
2888
2902
|
*/
|
|
2889
2903
|
shippingGroupId?: string | null;
|
|
2890
2904
|
}
|
|
2891
|
-
/**
|
|
2905
|
+
/** Tax info before the change. */
|
|
2892
2906
|
interface TaxInfoBeforeChange {
|
|
2893
|
-
/**
|
|
2907
|
+
/** Tax info. Absent when the line item had no tax info. */
|
|
2894
2908
|
taxInfo?: LineItemTaxInfo;
|
|
2895
2909
|
}
|
|
2896
|
-
/**
|
|
2910
|
+
/** Inventory app ID before the change. */
|
|
2897
2911
|
interface InventoryAppIdBeforeChange {
|
|
2898
2912
|
/**
|
|
2899
|
-
*
|
|
2913
|
+
* Inventory app ID. Absent when the line item had no inventory app.
|
|
2900
2914
|
* @format GUID
|
|
2901
2915
|
*/
|
|
2902
2916
|
inventoryAppId?: string | null;
|
|
2903
2917
|
}
|
|
2904
|
-
/**
|
|
2918
|
+
/** Root catalog item ID before the change. */
|
|
2905
2919
|
interface RootCatalogItemIdBeforeChange {
|
|
2906
2920
|
/**
|
|
2907
|
-
*
|
|
2921
|
+
* Root catalog item ID. Absent when the line item had no root catalog item.
|
|
2908
2922
|
* @minLength 1
|
|
2909
2923
|
* @maxLength 36
|
|
2910
2924
|
*/
|
|
2911
2925
|
rootCatalogItemId?: string | null;
|
|
2912
2926
|
}
|
|
2913
|
-
/**
|
|
2927
|
+
/** Modifier groups before the change. */
|
|
2914
2928
|
interface ModifierGroupsBeforeChange {
|
|
2915
2929
|
/**
|
|
2916
|
-
*
|
|
2930
|
+
* Modifier groups. Empty when the line item had no modifier groups.
|
|
2917
2931
|
* @maxSize 10
|
|
2918
2932
|
*/
|
|
2919
2933
|
modifierGroups?: ModifierGroup[];
|
|
2920
2934
|
}
|
|
2921
|
-
/**
|
|
2935
|
+
/** Price undetermined flag before the change. */
|
|
2922
2936
|
interface PriceUndeterminedBeforeChange {
|
|
2923
2937
|
/** Whether the price of the line item was undetermined. */
|
|
2924
2938
|
priceUndetermined?: boolean;
|
|
@@ -2938,56 +2952,56 @@ declare enum ChangeType {
|
|
|
2938
2952
|
type ChangeTypeWithLiterals = ChangeType | 'UNKNOWN_CHANGE_TYPE' | 'ADDED' | 'CHANGED' | 'REMOVED';
|
|
2939
2953
|
interface ItemChangedDetails {
|
|
2940
2954
|
/**
|
|
2941
|
-
*
|
|
2955
|
+
* Quantity before the change. Set only when the quantity changed.
|
|
2942
2956
|
* @min 1
|
|
2943
2957
|
* @max 1000000
|
|
2944
2958
|
*/
|
|
2945
2959
|
quantityBeforeChange?: number | null;
|
|
2946
|
-
/**
|
|
2960
|
+
/** Price before the change. Set only when the price changed. */
|
|
2947
2961
|
priceBeforeChange?: Price;
|
|
2948
|
-
/**
|
|
2962
|
+
/** Catalog reference options before the change. Set only when the catalog reference options changed. */
|
|
2949
2963
|
catalogReferenceOptionsBeforeChange?: CatalogReferenceOptionsBeforeChange;
|
|
2950
|
-
/**
|
|
2964
|
+
/** Product name before the change. Set only when the product name changed. */
|
|
2951
2965
|
productNameBeforeChange?: ProductNameBeforeChange;
|
|
2952
|
-
/**
|
|
2966
|
+
/** Description lines before the change. Set only when the description lines changed. */
|
|
2953
2967
|
descriptionLinesBeforeChange?: DescriptionLinesBeforeChange;
|
|
2954
|
-
/**
|
|
2968
|
+
/** Image before the change. Set only when the image changed. */
|
|
2955
2969
|
imageBeforeChange?: ImageBeforeChange;
|
|
2956
|
-
/**
|
|
2970
|
+
/** Physical properties before the change. Set only when the physical properties changed. */
|
|
2957
2971
|
physicalPropertiesBeforeChange?: PhysicalPropertiesBeforeChange;
|
|
2958
|
-
/**
|
|
2972
|
+
/** Item type before the change. Set only when the item type changed. */
|
|
2959
2973
|
itemTypeBeforeChange?: ItemTypeBeforeChange;
|
|
2960
|
-
/**
|
|
2974
|
+
/** Fulfiller ID before the change. Set only when the fulfiller ID changed. */
|
|
2961
2975
|
fulfillerIdBeforeChange?: FulfillerIdBeforeChange;
|
|
2962
|
-
/**
|
|
2976
|
+
/** Digital file before the change. Set only when the digital file changed. */
|
|
2963
2977
|
digitalFileBeforeChange?: DigitalFileBeforeChange;
|
|
2964
|
-
/**
|
|
2978
|
+
/** Price description before the change. Set only when the price description changed. */
|
|
2965
2979
|
priceDescriptionBeforeChange?: PriceDescriptionBeforeChange;
|
|
2966
2980
|
/**
|
|
2967
|
-
*
|
|
2981
|
+
* Delivery profile ID before the change. Set only when the delivery profile ID changed.
|
|
2968
2982
|
* @internal
|
|
2969
2983
|
*/
|
|
2970
2984
|
deliveryProfileIdBeforeChange?: DeliveryProfileIdBeforeChange;
|
|
2971
2985
|
/**
|
|
2972
|
-
*
|
|
2986
|
+
* Shipping group ID before the change. Set only when the shipping group ID changed.
|
|
2973
2987
|
* @internal
|
|
2974
2988
|
*/
|
|
2975
2989
|
shippingGroupIdBeforeChange?: ShippingGroupIdBeforeChange;
|
|
2976
|
-
/**
|
|
2990
|
+
/** Tax info before the change. Set only when the line item's tax group changed. */
|
|
2977
2991
|
taxInfoBeforeChange?: TaxInfoBeforeChange;
|
|
2978
2992
|
/**
|
|
2979
|
-
*
|
|
2993
|
+
* Inventory app ID before the change. Set only when the inventory app ID changed.
|
|
2980
2994
|
* @internal
|
|
2981
2995
|
*/
|
|
2982
2996
|
inventoryAppIdBeforeChange?: InventoryAppIdBeforeChange;
|
|
2983
2997
|
/**
|
|
2984
|
-
*
|
|
2998
|
+
* Root catalog item ID before the change. Set only when the root catalog item ID changed.
|
|
2985
2999
|
* @internal
|
|
2986
3000
|
*/
|
|
2987
3001
|
rootCatalogItemIdBeforeChange?: RootCatalogItemIdBeforeChange;
|
|
2988
|
-
/**
|
|
3002
|
+
/** Modifier groups before the change. Set only when the modifier groups changed. */
|
|
2989
3003
|
modifierGroupsBeforeChange?: ModifierGroupsBeforeChange;
|
|
2990
|
-
/**
|
|
3004
|
+
/** Price undetermined flag before the change. Set only when the price undetermined flag changed. */
|
|
2991
3005
|
priceUndeterminedBeforeChange?: PriceUndeterminedBeforeChange;
|
|
2992
3006
|
}
|
|
2993
3007
|
interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaDetailsOneOf {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/auto_sdk_ecom_subscription-contracts",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.148",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/",
|
|
@@ -50,5 +50,5 @@
|
|
|
50
50
|
"fqdn": "wix.ecom.subscription_contracts.v1.subscription_contract"
|
|
51
51
|
}
|
|
52
52
|
},
|
|
53
|
-
"falconPackageHash": "
|
|
53
|
+
"falconPackageHash": "9c8f3e65c5eea46da5a46d533324477216c760cc98e1f80c4ea35091"
|
|
54
54
|
}
|