@wix/auto_sdk_ecom_subscription-contracts 1.0.147 → 1.0.149

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.
@@ -4,7 +4,7 @@ import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
4
4
  /**
5
5
  * A subscription contract holds the terms of a buyer's subscription: the items, prices, billing frequency, and buyer, billing, and shipping details agreed on at checkout, or as later changed through draft subscription contracts.
6
6
  *
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.
7
+ * When a buyer checks out with subscription items, a subscription contract is created for each group of items that are billed together. Physical items from the same catalog with identical `subscriptionInfo.subscriptionSettings` share a subscription contract. Every other subscription item gets its own subscription contract. 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
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
  */
@@ -3087,6 +3087,8 @@ interface SubscriptionContractCommittedEnvelope {
3087
3087
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3088
3088
  * @permissionScope Read eCommerce - all read permissions
3089
3089
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3090
+ * @permissionScope Manage subscription contracts
3091
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
3090
3092
  * @permissionScope Manage Restaurants - all permissions
3091
3093
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3092
3094
  * @permissionScope Manage eCommerce - all permissions
@@ -3103,11 +3105,13 @@ interface SubscriptionContractCreatedEnvelope {
3103
3105
  metadata: EventMetadata;
3104
3106
  }
3105
3107
  /**
3106
- * Triggered when a subscription contract is created. A subscription contract is created when a buyer checks out with a subscription item.
3108
+ * Triggered when a subscription contract is created. Subscription contracts are created at checkout, 1 for each group of subscription items that are billed together, so 1 checkout can trigger this event more than once.
3107
3109
  * @permissionScope Manage Stores - all permissions
3108
3110
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3109
3111
  * @permissionScope Read eCommerce - all read permissions
3110
3112
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3113
+ * @permissionScope Manage subscription contracts
3114
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
3111
3115
  * @permissionScope Manage Restaurants - all permissions
3112
3116
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3113
3117
  * @permissionScope Manage eCommerce - all permissions
@@ -3123,11 +3127,14 @@ interface SubscriptionContractDeletedEnvelope {
3123
3127
  metadata: EventMetadata;
3124
3128
  }
3125
3129
  /**
3126
- * Triggered when a subscription contract is deleted. A subscription contract is deleted when the buyer's personal data is erased. It isn't deleted when the subscription ends.
3130
+ * Triggered when a subscription contract is deleted because the buyer's personal data is erased.
3131
+ * Doesn't fire when the subscription ends, because the subscription contract isn't deleted then. Also doesn't fire when the site is permanently deleted, even though its subscription contracts are deleted with it.
3127
3132
  * @permissionScope Manage Stores - all permissions
3128
3133
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3129
3134
  * @permissionScope Read eCommerce - all read permissions
3130
3135
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3136
+ * @permissionScope Manage subscription contracts
3137
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
3131
3138
  * @permissionScope Manage Restaurants - all permissions
3132
3139
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3133
3140
  * @permissionScope Manage eCommerce - all permissions
@@ -3153,6 +3160,8 @@ interface SubscriptionContractUpdatedEnvelope {
3153
3160
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3154
3161
  * @permissionScope Read eCommerce - all read permissions
3155
3162
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3163
+ * @permissionScope Manage subscription contracts
3164
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
3156
3165
  * @permissionScope Manage Restaurants - all permissions
3157
3166
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3158
3167
  * @permissionScope Manage eCommerce - all permissions
@@ -174,6 +174,14 @@ function resolveWixEcomSubscriptionContractsV1SubscriptionContractsUrl(opts) {
174
174
  {
175
175
  srcPath: "/ecom/subscription-contracts/v1/bulk/subscription-contracts",
176
176
  destPath: "/v1/bulk/subscription-contracts"
177
+ },
178
+ {
179
+ srcPath: "/ecom/v1/subscription-contracts",
180
+ destPath: "/v1/subscription-contracts"
181
+ },
182
+ {
183
+ srcPath: "/ecom/v1/bulk/subscription-contracts",
184
+ destPath: "/v1/bulk/subscription-contracts"
177
185
  }
178
186
  ],
179
187
  "*.dev.wix-code.com": [
@@ -184,6 +192,14 @@ function resolveWixEcomSubscriptionContractsV1SubscriptionContractsUrl(opts) {
184
192
  {
185
193
  srcPath: "/ecom/subscription-contracts/v1/bulk/subscription-contracts",
186
194
  destPath: "/v1/bulk/subscription-contracts"
195
+ },
196
+ {
197
+ srcPath: "/_api/ecom/v1/subscription-contracts",
198
+ destPath: "/v1/subscription-contracts"
199
+ },
200
+ {
201
+ srcPath: "/_api/ecom/v1/bulk/subscription-contracts",
202
+ destPath: "/v1/bulk/subscription-contracts"
187
203
  }
188
204
  ],
189
205
  _: [
@@ -194,6 +210,14 @@ function resolveWixEcomSubscriptionContractsV1SubscriptionContractsUrl(opts) {
194
210
  {
195
211
  srcPath: "/ecom/subscription-contracts/v1/bulk/subscription-contracts",
196
212
  destPath: "/v1/bulk/subscription-contracts"
213
+ },
214
+ {
215
+ srcPath: "/_api/ecom/v1/subscription-contracts",
216
+ destPath: "/v1/subscription-contracts"
217
+ },
218
+ {
219
+ srcPath: "/_api/ecom/v1/bulk/subscription-contracts",
220
+ destPath: "/v1/bulk/subscription-contracts"
197
221
  }
198
222
  ],
199
223
  "manage._base_domain_": [
@@ -204,6 +228,14 @@ function resolveWixEcomSubscriptionContractsV1SubscriptionContractsUrl(opts) {
204
228
  {
205
229
  srcPath: "/ecom/subscription-contracts/v1/bulk/subscription-contracts",
206
230
  destPath: "/v1/bulk/subscription-contracts"
231
+ },
232
+ {
233
+ srcPath: "/_api/ecom/v1/subscription-contracts",
234
+ destPath: "/v1/subscription-contracts"
235
+ },
236
+ {
237
+ srcPath: "/_api/ecom/v1/bulk/subscription-contracts",
238
+ destPath: "/v1/bulk/subscription-contracts"
207
239
  }
208
240
  ]
209
241
  };