@wix/auto_sdk_ecom_subscription-contracts 1.0.148 → 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.
@@ -35,11 +35,12 @@ declare const querySubscriptionContracts: MaybeContext<BuildRESTFunction<typeof
35
35
  */
36
36
  declare const onSubscriptionContractCommitted: BuildEventDefinition<typeof onSubscriptionContractCommitted$1> & typeof onSubscriptionContractCommitted$1;
37
37
  /**
38
- * Triggered when a subscription contract is created. A subscription contract is created when a buyer checks out with a subscription item.
38
+ * 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.
39
39
  */
40
40
  declare const onSubscriptionContractCreated: BuildEventDefinition<typeof onSubscriptionContractCreated$1> & typeof onSubscriptionContractCreated$1;
41
41
  /**
42
- * 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.
42
+ * Triggered when a subscription contract is deleted because the buyer's personal data is erased.
43
+ * 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.
43
44
  */
44
45
  declare const onSubscriptionContractDeleted: BuildEventDefinition<typeof onSubscriptionContractDeleted$1> & typeof onSubscriptionContractDeleted$1;
45
46
  /**
@@ -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
  */
@@ -3482,6 +3482,8 @@ interface SubscriptionContractCommittedEnvelope {
3482
3482
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3483
3483
  * @permissionScope Read eCommerce - all read permissions
3484
3484
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3485
+ * @permissionScope Manage subscription contracts
3486
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
3485
3487
  * @permissionScope Manage Restaurants - all permissions
3486
3488
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3487
3489
  * @permissionScope Manage eCommerce - all permissions
@@ -3498,11 +3500,13 @@ interface SubscriptionContractCreatedEnvelope {
3498
3500
  metadata: EventMetadata;
3499
3501
  }
3500
3502
  /**
3501
- * Triggered when a subscription contract is created. A subscription contract is created when a buyer checks out with a subscription item.
3503
+ * 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.
3502
3504
  * @permissionScope Manage Stores - all permissions
3503
3505
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3504
3506
  * @permissionScope Read eCommerce - all read permissions
3505
3507
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3508
+ * @permissionScope Manage subscription contracts
3509
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
3506
3510
  * @permissionScope Manage Restaurants - all permissions
3507
3511
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3508
3512
  * @permissionScope Manage eCommerce - all permissions
@@ -3518,11 +3522,14 @@ interface SubscriptionContractDeletedEnvelope {
3518
3522
  metadata: EventMetadata;
3519
3523
  }
3520
3524
  /**
3521
- * 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.
3525
+ * Triggered when a subscription contract is deleted because the buyer's personal data is erased.
3526
+ * 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.
3522
3527
  * @permissionScope Manage Stores - all permissions
3523
3528
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3524
3529
  * @permissionScope Read eCommerce - all read permissions
3525
3530
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3531
+ * @permissionScope Manage subscription contracts
3532
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
3526
3533
  * @permissionScope Manage Restaurants - all permissions
3527
3534
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3528
3535
  * @permissionScope Manage eCommerce - all permissions
@@ -3548,6 +3555,8 @@ interface SubscriptionContractUpdatedEnvelope {
3548
3555
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3549
3556
  * @permissionScope Read eCommerce - all read permissions
3550
3557
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3558
+ * @permissionScope Manage subscription contracts
3559
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
3551
3560
  * @permissionScope Manage Restaurants - all permissions
3552
3561
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3553
3562
  * @permissionScope Manage eCommerce - all permissions
@@ -4,7 +4,7 @@ import '@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
  */
@@ -35,11 +35,12 @@ declare const querySubscriptionContracts: MaybeContext<BuildRESTFunction<typeof
35
35
  */
36
36
  declare const onSubscriptionContractCommitted: BuildEventDefinition<typeof onSubscriptionContractCommitted$1> & typeof onSubscriptionContractCommitted$1;
37
37
  /**
38
- * Triggered when a subscription contract is created. A subscription contract is created when a buyer checks out with a subscription item.
38
+ * 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.
39
39
  */
40
40
  declare const onSubscriptionContractCreated: BuildEventDefinition<typeof onSubscriptionContractCreated$1> & typeof onSubscriptionContractCreated$1;
41
41
  /**
42
- * 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.
42
+ * Triggered when a subscription contract is deleted because the buyer's personal data is erased.
43
+ * 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.
43
44
  */
44
45
  declare const onSubscriptionContractDeleted: BuildEventDefinition<typeof onSubscriptionContractDeleted$1> & typeof onSubscriptionContractDeleted$1;
45
46
  /**
@@ -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
  */
@@ -3482,6 +3482,8 @@ interface SubscriptionContractCommittedEnvelope {
3482
3482
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3483
3483
  * @permissionScope Read eCommerce - all read permissions
3484
3484
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3485
+ * @permissionScope Manage subscription contracts
3486
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
3485
3487
  * @permissionScope Manage Restaurants - all permissions
3486
3488
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3487
3489
  * @permissionScope Manage eCommerce - all permissions
@@ -3498,11 +3500,13 @@ interface SubscriptionContractCreatedEnvelope {
3498
3500
  metadata: EventMetadata;
3499
3501
  }
3500
3502
  /**
3501
- * Triggered when a subscription contract is created. A subscription contract is created when a buyer checks out with a subscription item.
3503
+ * 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.
3502
3504
  * @permissionScope Manage Stores - all permissions
3503
3505
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3504
3506
  * @permissionScope Read eCommerce - all read permissions
3505
3507
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3508
+ * @permissionScope Manage subscription contracts
3509
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
3506
3510
  * @permissionScope Manage Restaurants - all permissions
3507
3511
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3508
3512
  * @permissionScope Manage eCommerce - all permissions
@@ -3518,11 +3522,14 @@ interface SubscriptionContractDeletedEnvelope {
3518
3522
  metadata: EventMetadata;
3519
3523
  }
3520
3524
  /**
3521
- * 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.
3525
+ * Triggered when a subscription contract is deleted because the buyer's personal data is erased.
3526
+ * 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.
3522
3527
  * @permissionScope Manage Stores - all permissions
3523
3528
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3524
3529
  * @permissionScope Read eCommerce - all read permissions
3525
3530
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3531
+ * @permissionScope Manage subscription contracts
3532
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
3526
3533
  * @permissionScope Manage Restaurants - all permissions
3527
3534
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3528
3535
  * @permissionScope Manage eCommerce - all permissions
@@ -3548,6 +3555,8 @@ interface SubscriptionContractUpdatedEnvelope {
3548
3555
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3549
3556
  * @permissionScope Read eCommerce - all read permissions
3550
3557
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3558
+ * @permissionScope Manage subscription contracts
3559
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
3551
3560
  * @permissionScope Manage Restaurants - all permissions
3552
3561
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3553
3562
  * @permissionScope Manage eCommerce - all permissions
@@ -4,7 +4,7 @@ import '@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
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_ecom_subscription-contracts",
3
- "version": "1.0.148",
3
+ "version": "1.0.149",
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": "9c8f3e65c5eea46da5a46d533324477216c760cc98e1f80c4ea35091"
53
+ "falconPackageHash": "0de2d6e57d65debdffef98e47c5f3d5b854f8f3a1d5d02e6536b45fc"
54
54
  }