@wix/auto_sdk_ecom_subscription-contracts 1.0.148 → 1.0.150

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
  */
@@ -3480,6 +3480,8 @@ interface SubscriptionContractCommittedEnvelope {
3480
3480
  * The event holds the updated contract and every change that was applied.
3481
3481
  * @permissionScope Manage Stores - all permissions
3482
3482
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3483
+ * @permissionScope Read subscription contracts
3484
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
3483
3485
  * @permissionScope Read eCommerce - all read permissions
3484
3486
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3485
3487
  * @permissionScope Manage Restaurants - all permissions
@@ -3498,9 +3500,11 @@ 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
3506
+ * @permissionScope Read subscription contracts
3507
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
3504
3508
  * @permissionScope Read eCommerce - all read permissions
3505
3509
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3506
3510
  * @permissionScope Manage Restaurants - all permissions
@@ -3518,9 +3522,12 @@ 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
3529
+ * @permissionScope Read subscription contracts
3530
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
3524
3531
  * @permissionScope Read eCommerce - all read permissions
3525
3532
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3526
3533
  * @permissionScope Manage Restaurants - all permissions
@@ -3546,6 +3553,8 @@ interface SubscriptionContractUpdatedEnvelope {
3546
3553
  * 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.
3547
3554
  * @permissionScope Manage Stores - all permissions
3548
3555
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3556
+ * @permissionScope Read subscription contracts
3557
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
3549
3558
  * @permissionScope Read eCommerce - all read permissions
3550
3559
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3551
3560
  * @permissionScope Manage Restaurants - 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
  */
@@ -3480,6 +3480,8 @@ interface SubscriptionContractCommittedEnvelope {
3480
3480
  * The event holds the updated contract and every change that was applied.
3481
3481
  * @permissionScope Manage Stores - all permissions
3482
3482
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3483
+ * @permissionScope Read subscription contracts
3484
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
3483
3485
  * @permissionScope Read eCommerce - all read permissions
3484
3486
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3485
3487
  * @permissionScope Manage Restaurants - all permissions
@@ -3498,9 +3500,11 @@ 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
3506
+ * @permissionScope Read subscription contracts
3507
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
3504
3508
  * @permissionScope Read eCommerce - all read permissions
3505
3509
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3506
3510
  * @permissionScope Manage Restaurants - all permissions
@@ -3518,9 +3522,12 @@ 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
3529
+ * @permissionScope Read subscription contracts
3530
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
3524
3531
  * @permissionScope Read eCommerce - all read permissions
3525
3532
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3526
3533
  * @permissionScope Manage Restaurants - all permissions
@@ -3546,6 +3553,8 @@ interface SubscriptionContractUpdatedEnvelope {
3546
3553
  * 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.
3547
3554
  * @permissionScope Manage Stores - all permissions
3548
3555
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3556
+ * @permissionScope Read subscription contracts
3557
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
3549
3558
  * @permissionScope Read eCommerce - all read permissions
3550
3559
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3551
3560
  * @permissionScope Manage Restaurants - 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.150",
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": "634b96a31ede3661a33624a60ef295e5337553a55fd4ea25eb9f2544"
54
54
  }