@wix/auto_sdk_ecom_draft-orders 1.0.187 → 1.0.188

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.
@@ -923,10 +923,16 @@ interface DigitalFile {
923
923
  interface SubscriptionInfo {
924
924
  /**
925
925
  * Subscription ID.
926
+ *
927
+ * For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
928
+ * 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).
926
929
  * @format GUID
927
930
  */
928
931
  _id?: string | null;
929
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
932
+ /**
933
+ * Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
934
+ * When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
935
+ */
930
936
  cycleNumber?: number;
931
937
  /**
932
938
  * Subscription option title. For example, `"Monthly coffee Subscription"`.
@@ -1002,7 +1008,7 @@ interface SubscriptionDescription {
1002
1008
  translated?: string | null;
1003
1009
  }
1004
1010
  interface SubscriptionSettings {
1005
- /** Frequency of recurring payment. */
1011
+ /** Frequency unit of the billing cycle. */
1006
1012
  frequency?: SubscriptionFrequencyWithLiterals;
1007
1013
  /**
1008
1014
  * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -1010,16 +1016,20 @@ interface SubscriptionSettings {
1010
1016
  * @max 3650
1011
1017
  */
1012
1018
  interval?: number | null;
1013
- /** Whether subscription is renewed automatically at the end of each period. */
1019
+ /** Whether the subscription renews automatically at the end of each billing cycle. */
1014
1020
  autoRenewal?: boolean;
1015
1021
  /**
1016
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
1022
+ * Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
1017
1023
  * @min 1
1018
1024
  */
1019
1025
  billingCycles?: number | null;
1020
- /** Whether to allow the customer to cancel the subscription. */
1026
+ /** Whether the buyer can cancel the subscription. */
1021
1027
  enableCustomerCancellation?: boolean;
1022
- /** Period until first cycle starts. If None => no free trial */
1028
+ /**
1029
+ * Free trial period before the first billing cycle starts.
1030
+ *
1031
+ * Returned only when the subscription has a free trial.
1032
+ */
1023
1033
  freeTrialPeriod?: FreeTrialPeriod;
1024
1034
  /**
1025
1035
  * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
@@ -1048,7 +1058,7 @@ declare enum SubscriptionFrequency {
1048
1058
  /** @enumType */
1049
1059
  type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
1050
1060
  interface FreeTrialPeriod {
1051
- /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
1061
+ /** Frequency unit of the free trial period. */
1052
1062
  frequency?: SubscriptionFrequencyWithLiterals;
1053
1063
  /**
1054
1064
  * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
@@ -964,10 +964,16 @@ interface DigitalFile {
964
964
  interface SubscriptionInfo {
965
965
  /**
966
966
  * Subscription ID.
967
+ *
968
+ * For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
969
+ * 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).
967
970
  * @format GUID
968
971
  */
969
972
  id?: string | null;
970
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
973
+ /**
974
+ * Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
975
+ * When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
976
+ */
971
977
  cycleNumber?: number;
972
978
  /**
973
979
  * Subscription option title. For example, `"Monthly coffee Subscription"`.
@@ -1043,7 +1049,7 @@ interface SubscriptionDescription {
1043
1049
  translated?: string | null;
1044
1050
  }
1045
1051
  interface SubscriptionSettings {
1046
- /** Frequency of recurring payment. */
1052
+ /** Frequency unit of the billing cycle. */
1047
1053
  frequency?: SubscriptionFrequencyWithLiterals;
1048
1054
  /**
1049
1055
  * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -1051,16 +1057,20 @@ interface SubscriptionSettings {
1051
1057
  * @max 3650
1052
1058
  */
1053
1059
  interval?: number | null;
1054
- /** Whether subscription is renewed automatically at the end of each period. */
1060
+ /** Whether the subscription renews automatically at the end of each billing cycle. */
1055
1061
  autoRenewal?: boolean;
1056
1062
  /**
1057
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
1063
+ * Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
1058
1064
  * @min 1
1059
1065
  */
1060
1066
  billingCycles?: number | null;
1061
- /** Whether to allow the customer to cancel the subscription. */
1067
+ /** Whether the buyer can cancel the subscription. */
1062
1068
  enableCustomerCancellation?: boolean;
1063
- /** Period until first cycle starts. If None => no free trial */
1069
+ /**
1070
+ * Free trial period before the first billing cycle starts.
1071
+ *
1072
+ * Returned only when the subscription has a free trial.
1073
+ */
1064
1074
  freeTrialPeriod?: FreeTrialPeriod;
1065
1075
  /**
1066
1076
  * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
@@ -1089,7 +1099,7 @@ declare enum SubscriptionFrequency {
1089
1099
  /** @enumType */
1090
1100
  type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
1091
1101
  interface FreeTrialPeriod {
1092
- /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
1102
+ /** Frequency unit of the free trial period. */
1093
1103
  frequency?: SubscriptionFrequencyWithLiterals;
1094
1104
  /**
1095
1105
  * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
@@ -923,10 +923,16 @@ interface DigitalFile {
923
923
  interface SubscriptionInfo {
924
924
  /**
925
925
  * Subscription ID.
926
+ *
927
+ * For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
928
+ * 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).
926
929
  * @format GUID
927
930
  */
928
931
  _id?: string | null;
929
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
932
+ /**
933
+ * Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
934
+ * When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
935
+ */
930
936
  cycleNumber?: number;
931
937
  /**
932
938
  * Subscription option title. For example, `"Monthly coffee Subscription"`.
@@ -1002,7 +1008,7 @@ interface SubscriptionDescription {
1002
1008
  translated?: string | null;
1003
1009
  }
1004
1010
  interface SubscriptionSettings {
1005
- /** Frequency of recurring payment. */
1011
+ /** Frequency unit of the billing cycle. */
1006
1012
  frequency?: SubscriptionFrequencyWithLiterals;
1007
1013
  /**
1008
1014
  * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -1010,16 +1016,20 @@ interface SubscriptionSettings {
1010
1016
  * @max 3650
1011
1017
  */
1012
1018
  interval?: number | null;
1013
- /** Whether subscription is renewed automatically at the end of each period. */
1019
+ /** Whether the subscription renews automatically at the end of each billing cycle. */
1014
1020
  autoRenewal?: boolean;
1015
1021
  /**
1016
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
1022
+ * Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
1017
1023
  * @min 1
1018
1024
  */
1019
1025
  billingCycles?: number | null;
1020
- /** Whether to allow the customer to cancel the subscription. */
1026
+ /** Whether the buyer can cancel the subscription. */
1021
1027
  enableCustomerCancellation?: boolean;
1022
- /** Period until first cycle starts. If None => no free trial */
1028
+ /**
1029
+ * Free trial period before the first billing cycle starts.
1030
+ *
1031
+ * Returned only when the subscription has a free trial.
1032
+ */
1023
1033
  freeTrialPeriod?: FreeTrialPeriod;
1024
1034
  /**
1025
1035
  * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
@@ -1048,7 +1058,7 @@ declare enum SubscriptionFrequency {
1048
1058
  /** @enumType */
1049
1059
  type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
1050
1060
  interface FreeTrialPeriod {
1051
- /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
1061
+ /** Frequency unit of the free trial period. */
1052
1062
  frequency?: SubscriptionFrequencyWithLiterals;
1053
1063
  /**
1054
1064
  * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
@@ -964,10 +964,16 @@ interface DigitalFile {
964
964
  interface SubscriptionInfo {
965
965
  /**
966
966
  * Subscription ID.
967
+ *
968
+ * For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
969
+ * 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).
967
970
  * @format GUID
968
971
  */
969
972
  id?: string | null;
970
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
973
+ /**
974
+ * Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
975
+ * When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
976
+ */
971
977
  cycleNumber?: number;
972
978
  /**
973
979
  * Subscription option title. For example, `"Monthly coffee Subscription"`.
@@ -1043,7 +1049,7 @@ interface SubscriptionDescription {
1043
1049
  translated?: string | null;
1044
1050
  }
1045
1051
  interface SubscriptionSettings {
1046
- /** Frequency of recurring payment. */
1052
+ /** Frequency unit of the billing cycle. */
1047
1053
  frequency?: SubscriptionFrequencyWithLiterals;
1048
1054
  /**
1049
1055
  * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -1051,16 +1057,20 @@ interface SubscriptionSettings {
1051
1057
  * @max 3650
1052
1058
  */
1053
1059
  interval?: number | null;
1054
- /** Whether subscription is renewed automatically at the end of each period. */
1060
+ /** Whether the subscription renews automatically at the end of each billing cycle. */
1055
1061
  autoRenewal?: boolean;
1056
1062
  /**
1057
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
1063
+ * Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
1058
1064
  * @min 1
1059
1065
  */
1060
1066
  billingCycles?: number | null;
1061
- /** Whether to allow the customer to cancel the subscription. */
1067
+ /** Whether the buyer can cancel the subscription. */
1062
1068
  enableCustomerCancellation?: boolean;
1063
- /** Period until first cycle starts. If None => no free trial */
1069
+ /**
1070
+ * Free trial period before the first billing cycle starts.
1071
+ *
1072
+ * Returned only when the subscription has a free trial.
1073
+ */
1064
1074
  freeTrialPeriod?: FreeTrialPeriod;
1065
1075
  /**
1066
1076
  * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
@@ -1089,7 +1099,7 @@ declare enum SubscriptionFrequency {
1089
1099
  /** @enumType */
1090
1100
  type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
1091
1101
  interface FreeTrialPeriod {
1092
- /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
1102
+ /** Frequency unit of the free trial period. */
1093
1103
  frequency?: SubscriptionFrequencyWithLiterals;
1094
1104
  /**
1095
1105
  * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_ecom_draft-orders",
3
- "version": "1.0.187",
3
+ "version": "1.0.188",
4
4
  "license": "MIT",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
50
50
  "fqdn": "wix.ecom.v1.draft_order"
51
51
  }
52
52
  },
53
- "falconPackageHash": "ebf5a8e837603b742b81db6cf255042ef91bdc36bf55cb46dfd43ba7"
53
+ "falconPackageHash": "550e4f8d24e56149032d568608702dabd7dc8ea7aff6333de79e1ce0"
54
54
  }