@wix/auto_sdk_ecom_subscription-contracts 1.0.146 → 1.0.147

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

@@ -6,7 +6,7 @@ import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
  *
  * 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.
  *
- * To change a subscription contract, create a draft subscription contract, edit it, and commit it.
+ * 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.
  */
 interface SubscriptionContract {
     /**
@@ -190,9 +190,13 @@ interface V1SubscriptionSettings {
 }
 declare enum SubscriptionFrequency {
     UNDEFINED = "UNDEFINED",
+    /** Day. */
     DAY = "DAY",
+    /** Week. */
     WEEK = "WEEK",
+    /** Month. */
     MONTH = "MONTH",
+    /** Year. */
     YEAR = "YEAR"
 }
 /** @enumType */
@@ -757,10 +761,16 @@ interface DigitalFile {
 interface SubscriptionInfo {
     /**
      * Subscription ID.
+     *
+     * For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
+     * 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).
      * @format GUID
      */
     _id?: string | null;
-    /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
+    /**
+     * Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
+     * When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
+     */
     cycleNumber?: number;
     /**
      * Subscription option title. For example, `"Monthly coffee Subscription"`.
@@ -815,7 +825,7 @@ interface SubscriptionDescription {
     translated?: string | null;
 }
 interface SubscriptionSettings {
-    /** Frequency of recurring payment. */
+    /** Frequency unit of the billing cycle. */
     frequency?: V2SubscriptionFrequencyWithLiterals;
     /**
      * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -823,16 +833,20 @@ interface SubscriptionSettings {
      * @max 3650
      */
     interval?: number | null;
-    /** Whether subscription is renewed automatically at the end of each period. */
+    /** Whether the subscription renews automatically at the end of each billing cycle. */
     autoRenewal?: boolean;
     /**
-     * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
+     * Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
      * @min 1
      */
     billingCycles?: number | null;
-    /** Whether to allow the customer to cancel the subscription. */
+    /** Whether the buyer can cancel the subscription. */
     enableCustomerCancellation?: boolean;
-    /** Period until first cycle starts. If None => no free trial */
+    /**
+     * Free trial period before the first billing cycle starts.
+     *
+     * Returned only when the subscription has a free trial.
+     */
     freeTrialPeriod?: FreeTrialPeriod;
 }
 /** Frequency unit of recurring payment */
@@ -846,7 +860,7 @@ declare enum V2SubscriptionFrequency {
 /** @enumType */
 type V2SubscriptionFrequencyWithLiterals = V2SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
 interface FreeTrialPeriod {
-    /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
+    /** Frequency unit of the free trial period. */
     frequency?: V2SubscriptionFrequencyWithLiterals;
     /**
      * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
@@ -2334,7 +2348,7 @@ interface SubscriptionContractChangesCommitted {
      * @maxLength 200
      */
     reason?: string | null;
-    /** Price summary of the contract after the commit. */
+    /** Price summary of the subscription contract after the commit. Same as `changes.priceSummary`. */
     priceSummary?: PriceSummary;
 }
 interface SubscriptionContractDiffs {
@@ -2361,7 +2375,7 @@ interface SubscriptionContractDiffs {
     additionalFees?: AdditionalFeeDelta[];
     /** Price summary after the changes. Replaces the subscription contract's previous price summary. */
     priceSummary?: PriceSummary;
-    /** Tax information after the changes. Replaces the subscription contract's previous tax information. */
+    /** Tax information after the changes. */
     taxInfo?: OrderTaxInfo;
     /** Shipping information after the changes. Replaces the subscription contract's previous shipping information. */
     shippingInfo?: ShippingInformation;
@@ -2384,104 +2398,104 @@ interface LineItemDeltaDeltaDetailsOneOf {
     /** Values the line item had before the change. */
     changed?: ItemChangedDetails;
 }
-/** The catalog reference options before the change. */
+/** Catalog reference options before the change. */
 interface CatalogReferenceOptionsBeforeChange {
-    /** The catalog reference options. Absent when the line item had no options. */
+    /** Catalog reference options. Absent when the line item had no options. */
     options?: Record<string, any> | null;
 }
-/** The product name before the change. */
+/** Product name before the change. */
 interface ProductNameBeforeChange {
-    /** The product name. Absent when the line item had no product name. */
+    /** Product name. Absent when the line item had no product name. */
     productName?: ProductName;
 }
-/** The description lines before the change. */
+/** Description lines before the change. */
 interface DescriptionLinesBeforeChange {
     /**
-     * The description lines. Empty when the line item had no description lines.
+     * Description lines. Empty when the line item had no description lines.
      * @maxSize 20
      */
     descriptionLines?: DescriptionLine[];
 }
-/** The image before the change. */
+/** Image before the change. */
 interface ImageBeforeChange {
-    /** The image. Absent when the line item had no image. */
+    /** Image. Absent when the line item had no image. */
     image?: string;
 }
-/** The physical properties before the change. */
+/** Physical properties before the change. */
 interface PhysicalPropertiesBeforeChange {
-    /** The physical properties. Absent when the line item had no physical properties. */
+    /** Physical properties. Absent when the line item had no physical properties. */
     physicalProperties?: PhysicalProperties;
 }
-/** The item type before the change. */
+/** Item type before the change. */
 interface ItemTypeBeforeChange {
-    /** The item type. Absent when the line item had no item type. */
+    /** Item type. Absent when the line item had no item type. */
     itemType?: ItemType;
 }
-/** The fulfiller ID before the change. */
+/** Fulfiller ID before the change. */
 interface FulfillerIdBeforeChange {
     /**
-     * The fulfiller ID. Absent when the line item had no fulfiller.
+     * Fulfiller ID. Absent when the line item had no fulfiller.
      * @format GUID
      */
     fulfillerId?: string | null;
 }
-/** The digital file before the change. */
+/** Digital file before the change. */
 interface DigitalFileBeforeChange {
-    /** The digital file. Absent when the line item had no digital file. */
+    /** Digital file. Absent when the line item had no digital file. */
     digitalFile?: DigitalFile;
 }
-/** The price description before the change. */
+/** Price description before the change. */
 interface PriceDescriptionBeforeChange {
-    /** The price description. Absent when the line item had no price description. */
+    /** Price description. Absent when the line item had no price description. */
     priceDescription?: PriceDescription;
 }
-/** The delivery profile ID before the change. */
+/** Delivery profile ID before the change. */
 interface DeliveryProfileIdBeforeChange {
     /**
-     * The delivery profile ID. Absent when the line item had no delivery profile.
+     * Delivery profile ID. Absent when the line item had no delivery profile.
      * @format GUID
      */
     deliveryProfileId?: string | null;
 }
-/** The shipping group ID before the change. */
+/** Shipping group ID before the change. */
 interface ShippingGroupIdBeforeChange {
     /**
-     * The shipping group ID. Absent when the line item had no shipping group.
+     * Shipping group ID. Absent when the line item had no shipping group.
      * @format GUID
      */
     shippingGroupId?: string | null;
 }
-/** The tax info before the change. */
+/** Tax info before the change. */
 interface TaxInfoBeforeChange {
-    /** The tax info. Absent when the line item had no tax info. */
+    /** Tax info. Absent when the line item had no tax info. */
     taxInfo?: LineItemTaxInfo;
 }
-/** The inventory app ID before the change. */
+/** Inventory app ID before the change. */
 interface InventoryAppIdBeforeChange {
     /**
-     * The inventory app ID. Absent when the line item had no inventory app.
+     * Inventory app ID. Absent when the line item had no inventory app.
      * @format GUID
      */
     inventoryAppId?: string | null;
 }
-/** The root catalog item ID before the change. */
+/** Root catalog item ID before the change. */
 interface RootCatalogItemIdBeforeChange {
     /**
-     * The root catalog item ID. Absent when the line item had no root catalog item.
+     * Root catalog item ID. Absent when the line item had no root catalog item.
      * @minLength 1
      * @maxLength 36
      */
     rootCatalogItemId?: string | null;
 }
-/** The modifier groups before the change. */
+/** Modifier groups before the change. */
 interface ModifierGroupsBeforeChange {
     /**
-     * The modifier groups. Empty when the line item had no modifier groups.
+     * Modifier groups. Empty when the line item had no modifier groups.
      * @maxSize 10
      */
     modifierGroups?: ModifierGroup[];
 }
-/** The price undetermined flag before the change. */
+/** Price undetermined flag before the change. */
 interface PriceUndeterminedBeforeChange {
     /** Whether the price of the line item was undetermined. */
     priceUndetermined?: boolean;
@@ -2501,36 +2515,36 @@ declare enum ChangeType {
 type ChangeTypeWithLiterals = ChangeType | 'UNKNOWN_CHANGE_TYPE' | 'ADDED' | 'CHANGED' | 'REMOVED';
 interface ItemChangedDetails {
     /**
-     * The quantity before the change. Set only when the quantity changed.
+     * Quantity before the change. Set only when the quantity changed.
      * @min 1
      * @max 1000000
      */
     quantityBeforeChange?: number | null;
-    /** The price before the change. Set only when the price changed. */
+    /** Price before the change. Set only when the price changed. */
     priceBeforeChange?: Price;
-    /** The catalog reference options before the change. Set only when the catalog reference options changed. */
+    /** Catalog reference options before the change. Set only when the catalog reference options changed. */
     catalogReferenceOptionsBeforeChange?: CatalogReferenceOptionsBeforeChange;
-    /** The product name before the change. Set only when the product name changed. */
+    /** Product name before the change. Set only when the product name changed. */
     productNameBeforeChange?: ProductNameBeforeChange;
-    /** The description lines before the change. Set only when the description lines changed. */
+    /** Description lines before the change. Set only when the description lines changed. */
     descriptionLinesBeforeChange?: DescriptionLinesBeforeChange;
-    /** The image before the change. Set only when the image changed. */
+    /** Image before the change. Set only when the image changed. */
     imageBeforeChange?: ImageBeforeChange;
-    /** The physical properties before the change. Set only when the physical properties changed. */
+    /** Physical properties before the change. Set only when the physical properties changed. */
     physicalPropertiesBeforeChange?: PhysicalPropertiesBeforeChange;
-    /** The item type before the change. Set only when the item type changed. */
+    /** Item type before the change. Set only when the item type changed. */
     itemTypeBeforeChange?: ItemTypeBeforeChange;
-    /** The fulfiller ID before the change. Set only when the fulfiller ID changed. */
+    /** Fulfiller ID before the change. Set only when the fulfiller ID changed. */
     fulfillerIdBeforeChange?: FulfillerIdBeforeChange;
-    /** The digital file before the change. Set only when the digital file changed. */
+    /** Digital file before the change. Set only when the digital file changed. */
     digitalFileBeforeChange?: DigitalFileBeforeChange;
-    /** The price description before the change. Set only when the price description changed. */
+    /** Price description before the change. Set only when the price description changed. */
     priceDescriptionBeforeChange?: PriceDescriptionBeforeChange;
-    /** The tax info before the change. Set only when the line item's tax group changed because its catalog options changed. */
+    /** Tax info before the change. Set only when the line item's tax group changed. */
     taxInfoBeforeChange?: TaxInfoBeforeChange;
-    /** The modifier groups before the change. Set only when the modifier groups changed. */
+    /** Modifier groups before the change. Set only when the modifier groups changed. */
     modifierGroupsBeforeChange?: ModifierGroupsBeforeChange;
-    /** The price undetermined flag before the change. Set only when the price undetermined flag changed. */
+    /** Price undetermined flag before the change. Set only when the price undetermined flag changed. */
     priceUndeterminedBeforeChange?: PriceUndeterminedBeforeChange;
 }
 interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaDetailsOneOf {