@wix/auto_sdk_ecom_subscription-contracts 1.0.118 → 1.0.120

package/build/internal/cjs/index.typings.d.ts

@@ -363,6 +363,20 @@ interface OrderLineItem {
      * Default: `false`
      */
     priceUndetermined?: boolean;
+    /**
+     * Whether the line item quantity is fixed and cannot be changed.
+     *
+     * Default: `false`
+     */
+    fixedQuantity?: boolean;
+    /**
+     * Decimal-quantity metadata. Set when the line represents a
+     * non-integer purchase (e.g. 2.75 m² of fake grass).
+     *
+     * When set, the line item must have `fixedQuantity` = true and be set with `quantity` = 1.
+     * The decimal value lives in `decimalQuantity.value`.
+     */
+    decimalQuantity?: DecimalQuantity;
     /**
      * Custom extended fields for the line item object.
      *
@@ -1002,12 +1016,11 @@ type TaxableAddressTypeWithLiterals = TaxableAddressType | 'BUSINESS' | 'BILLING
  * than from `lineItem.quantity`.
  */
 interface DecimalQuantity extends DecimalQuantityUnitOneOf {
-    /** @internal */
+    /** Unit the value is expressed in, selected from the standard `measurementUnit` enum. */
     measurementUnit?: MeasurementUnitWithLiterals;
     /**
      * Free-form unit name for standard units not in the
      * `measurementUnit` enum (e.g. "hour", "minute", "session").
-     * @internal
      * @minLength 1
      * @maxLength 50
      */
@@ -1019,25 +1032,22 @@ interface DecimalQuantity extends DecimalQuantityUnitOneOf {
      * rounding, no conversion to an integer.
      *
      * Examples: "2.75", "1.5", "0.75".
-     * @internal
      * @decimalValue options { gt:0, lte:1000000000000000, maxScale:4 }
      */
     value?: string;
     /**
-     * Human-readable description of the quantity
-     * e.g. "2.75 square meters of fake grass".
-     * @internal
+     * Human-readable, pre-formatted display string for the quantity. For example, "2.75 square meters of fake grass".
+     * Always set alongside `value`; use this directly for display rather than composing your own string from `value` and `unit`.
      */
     description?: TranslatableString;
 }
 /** @oneof */
 interface DecimalQuantityUnitOneOf {
-    /** @internal */
+    /** Unit the value is expressed in, selected from the standard `measurementUnit` enum. */
     measurementUnit?: MeasurementUnitWithLiterals;
     /**
      * Free-form unit name for standard units not in the
      * `measurementUnit` enum (e.g. "hour", "minute", "session").
-     * @internal
      * @minLength 1
      * @maxLength 50
      */
@@ -1931,10 +1941,7 @@ interface AdditionalFee {
     subscriptionCycles?: number | null;
     /** Specifies the entity that added the additional fee. */
     source?: AdditionalFeeSourceWithLiterals;
-    /**
-     * Address type tax was calculated against for this fee.
-     * @internal
-     */
+    /** Address type tax was calculated against for this fee. */
     taxableAddress?: TaxableAddress;
 }
 declare enum AdditionalFeeSource {
@@ -2847,7 +2854,7 @@ declare function onSubscriptionContractUpdated(handler: (event: SubscriptionCont
  * @returns The requested SubscriptionContract.
  * @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.GetSubscriptionContract
  */
-declare function getSubscriptionContract(subscriptionContractId: string): Promise<NonNullablePaths<SubscriptionContract, `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `subscriptionSettings.enableCustomerCancellation` | `subscriptionSettings.freeTrialPeriod.frequency` | `subscriptionSettings.freeTrialPeriod.interval` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `weightUnit` | `taxIncludedInPrices` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `activities` | `activities.${number}.changesApplied.draftSubscriptionContractId` | `activities.${number}._id` | `activities.${number}.author.userId` | `activities.${number}.author.appId` | `activities.${number}.activityType`, 6>>;
+declare function getSubscriptionContract(subscriptionContractId: string): Promise<NonNullablePaths<SubscriptionContract, `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `subscriptionSettings.enableCustomerCancellation` | `subscriptionSettings.freeTrialPeriod.frequency` | `subscriptionSettings.freeTrialPeriod.interval` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `weightUnit` | `taxIncludedInPrices` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `activities` | `activities.${number}.changesApplied.draftSubscriptionContractId` | `activities.${number}._id` | `activities.${number}.author.userId` | `activities.${number}.author.appId` | `activities.${number}.activityType`, 6>>;
 /**
  * Retrieves a list of SubscriptionContracts, given the provided [paging, filtering, and sorting][1].
  *