@wix/auto_sdk_ecom_subscription-contracts 1.0.148 → 1.0.150

package/build/es/index.typings.d.mts

@@ -4,7 +4,7 @@ import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 /**
  * 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.
  *
- * 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.
+ * 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.
  *
  * 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.
  */
@@ -3085,6 +3085,8 @@ interface SubscriptionContractCommittedEnvelope {
  * The event holds the updated contract and every change that was applied.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Read subscription contracts
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
  * @permissionScope Manage Restaurants - all permissions
@@ -3103,9 +3105,11 @@ interface SubscriptionContractCreatedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when a subscription contract is created. A subscription contract is created when a buyer checks out with a subscription item.
+ * 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.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Read subscription contracts
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
  * @permissionScope Manage Restaurants - all permissions
@@ -3123,9 +3127,12 @@ interface SubscriptionContractDeletedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * 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.
+ * Triggered when a subscription contract is deleted because the buyer's personal data is erased.
+ * 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.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Read subscription contracts
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
  * @permissionScope Manage Restaurants - all permissions
@@ -3151,6 +3158,8 @@ interface SubscriptionContractUpdatedEnvelope {
  * Also fires right after a subscription contract is created, while billing for the subscription is set up. These updates can leave every documented field unchanged.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Read subscription contracts
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
  * @permissionScope Manage Restaurants - all permissions