@wix/auto_sdk_ecom_subscription-contracts 1.0.120 → 1.0.121

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

@@ -32,6 +32,12 @@ interface SubscriptionContract {
      * @readonly
      */
     _updatedDate?: Date | null;
+    /**
+     * Corresponding billing subscription id
+     * @internal
+     * @format GUID
+     */
+    billingSubscriptionId?: string | null;
     /**
      * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
      * @maxLength 500
@@ -92,6 +98,12 @@ interface SubscriptionContract {
     billingInfo?: AddressWithContact;
     /** Shipping info and selected shipping option details. */
     shippingInfo?: ShippingInformation;
+    /**
+     * Tax information.
+     * @internal
+     * @readonly
+     */
+    taxInfo?: OrderTaxInfo;
     /**
      * Applied discounts.
      * @maxSize 100
@@ -136,6 +148,16 @@ interface SubscriptionContract {
      * @maxSize 100
      */
     additionalFees?: AdditionalFee[];
+    /**
+     * Order Location
+     * @internal
+     */
+    businessLocation?: Location;
+    /**
+     * Contract-level settings and allowed actions.
+     * @internal
+     */
+    settings?: SubscriptionContractSettings;
     /**
      * Activities recorded on this contract (e.g. draft commits, status changes).
      * @readonly
@@ -300,6 +322,12 @@ interface OrderLineItem {
      * @readonly
      */
     priceBeforeDiscounts?: Price;
+    /**
+     * Line item price per unit before line item discounts and before tax.
+     * @internal
+     * @readonly
+     */
+    priceBeforeDiscountsAndTax?: Price;
     /**
      * Total price after discounts, and before tax.
      * @readonly
@@ -340,6 +368,17 @@ interface OrderLineItem {
      * @readonly
      */
     depositAmount?: Price;
+    /**
+     * The item's delivery profile ID.
+     * @internal
+     * @format GUID
+     */
+    deliveryProfileId?: string | null;
+    /**
+     * @internal
+     * @format GUID
+     */
+    shippingGroupId?: string | null;
     /**
      * Line item locations.
      *
@@ -349,6 +388,23 @@ interface OrderLineItem {
     locations?: LocationAndQuantity[];
     /** Total price **after** catalog discounts and line item discounts. */
     lineItemPrice?: Price;
+    /**
+     * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
+     * @internal
+     * @readonly
+     * @immutable
+     */
+    customLineItem?: boolean | null;
+    /**
+     * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
+     * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
+     * + In most cases, this field has the same value as `catalogReference.catalogItemId`.
+     * @internal
+     * @minLength 1
+     * @maxLength 36
+     * @readonly
+     */
+    rootCatalogItemId?: string | null;
     /** Address used for tax calculation. */
     taxableAddress?: TaxableAddress;
     /**
@@ -397,6 +453,12 @@ interface OrderLineItem {
      * @immutable
      */
     externalLineItemId?: string | null;
+    /**
+     * Service properties. When relevant, this contains information such as the date and number of participants.
+     * @internal
+     * @readonly
+     */
+    serviceProperties?: ServiceProperties;
 }
 interface ProductName {
     /**
@@ -466,8 +528,26 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
     plainText?: PlainTextValue;
     /** Description line color value. */
     colorInfo?: Color;
+    /**
+     * Description line plain text value.
+     * @internal
+     * @deprecated
+     */
+    plainTextValue?: PlainTextValue;
+    /**
+     * Description line color.
+     * @internal
+     * @deprecated
+     */
+    color?: string;
     /** Description line name. */
     name?: DescriptionLineName;
+    /**
+     * Description line type.
+     * @internal
+     * @deprecated
+     */
+    lineType?: DescriptionLineTypeWithLiterals;
 }
 /** @oneof */
 interface DescriptionLineValueOneOf {
@@ -478,6 +558,18 @@ interface DescriptionLineValueOneOf {
 }
 /** @oneof */
 interface DescriptionLineDescriptionLineValueOneOf {
+    /**
+     * Description line plain text value.
+     * @internal
+     * @deprecated
+     */
+    plainTextValue?: PlainTextValue;
+    /**
+     * Description line color.
+     * @internal
+     * @deprecated
+     */
+    color?: string;
 }
 interface DescriptionLineName {
     /**
@@ -659,6 +751,12 @@ type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' |
 interface ItemTaxFullDetails {
     /** Taxable amount of this line item. */
     taxableAmount?: Price;
+    /**
+     * ID of the item's tax group, if specified.
+     * @internal
+     * @format GUID
+     */
+    taxGroupId?: string | null;
     /**
      * Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`.
      * @decimalValue options { gte:0, maxScale:6 }
@@ -1147,6 +1245,25 @@ interface ItemModifier {
     /** The price of the modifier. */
     price?: Price;
 }
+interface ServiceProperties {
+    /**
+     * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
+     * For example, the start time of a class.
+     */
+    scheduledDate?: Date | null;
+    /**
+     * The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
+     * @min 1
+     * @max 10000
+     */
+    numberOfParticipants?: number | null;
+    /**
+     * Date and time the service is to be ended, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
+     * For example, the date and time a class will end.
+     * @internal
+     */
+    endDate?: Date | null;
+}
 /** Buyer information. */
 interface BuyerInfo extends BuyerInfoIdOneOf {
     /**
@@ -1220,8 +1337,26 @@ interface PriceSummary {
     tax?: Price;
     /** Total discount amount applied to the order. */
     discount?: Price;
+    /**
+     * Deprecated - use `total` instead.
+     * @internal
+     * @deprecated
+     */
+    totalPrice?: Price;
     /** Order's total price after discounts and tax. */
     total?: Price;
+    /**
+     * Order's total price including gift card.
+     * @internal
+     * @deprecated
+     */
+    totalWithGiftCard?: Price;
+    /**
+     * Order's total price after without gift card.
+     * @internal
+     * @deprecated
+     */
+    totalWithoutGiftCard?: Price;
     /** Total additional fees before tax. */
     totalAdditionalFees?: Price;
 }
@@ -1333,6 +1468,16 @@ interface StreetAddress {
     number?: string;
     /** Street name. */
     name?: string;
+    /**
+     * Apartment number.
+     * @internal
+     */
+    apt?: string;
+    /**
+     * Optional address line 1
+     * @internal
+     */
+    formattedAddressLine?: string | null;
 }
 interface AddressLocation {
     /** Address latitude. */
@@ -1493,6 +1638,8 @@ interface PickupAddress {
      * @readonly
      */
     subdivisionFullname?: string | null;
+    /** @internal */
+    location?: AddressLocation;
 }
 declare enum PickupMethod {
     STORE_PICKUP = "STORE_PICKUP",
@@ -1549,6 +1696,13 @@ interface OrderTaxInfo {
      * @maxSize 50
      */
     taxBreakdown?: OrderTaxBreakdown[];
+    /**
+     * Manual tax rate
+     * @internal
+     * @decimalValue options { gte:0 }
+     * @readonly
+     */
+    manualTaxRate?: string | null;
     /**
      * Whether the order is exempt from tax calculations.
      *
@@ -1593,6 +1747,11 @@ interface OrderTaxBreakdown {
     rate?: string;
     /** The sum of all the tax from line items that calculated by the tax identifiers. */
     aggregatedTaxAmount?: Price;
+    /**
+     * The sum of all the taxable amount from line items for tax identifiers.
+     * @internal
+     */
+    aggregatedTaxableAmount?: Price;
     /**
      * The aggregated exempt amount from all line items for tax identifiers.
      * @internal
@@ -1699,6 +1858,12 @@ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
      * @decimalValue options { gte:0, lte:100, maxScale:2 }
      */
     percentage?: string | null;
+    /**
+     * Discount name.
+     * @internal
+     * @maxLength 200
+     */
+    name?: string | null;
 }
 /** @oneof */
 interface MerchantDiscountMerchantDiscountReasonOneOf {
@@ -2357,6 +2522,13 @@ interface GetSubscriptionContractResponse {
 interface UpdateSubscriptionContractRequest {
     /** SubscriptionContract to be updated, may be partial. */
     subscriptionContract?: SubscriptionContract;
+    /**
+     * Set of fields to update.
+     *
+     * Fields that aren't included in `fieldMask.paths` are ignored.
+     * @internal
+     */
+    fieldMask?: string[];
 }
 interface UpdateSubscriptionContractResponse {
     /** Updated SubscriptionContract. */
@@ -2597,6 +2769,11 @@ interface BulkUpdateSubscriptionContractsRequest {
 interface MaskedSubscriptionContract {
     /** Subscription contract to be updated. */
     subscriptionContract?: SubscriptionContract;
+    /**
+     * Field mask of fields to update.
+     * @internal
+     */
+    fieldMask?: string[];
 }
 interface BulkUpdateSubscriptionContractsResponse {
     /**
@@ -3020,4 +3197,4 @@ declare const utils: {
     };
 };
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, ActionInitiator, type ActionInitiatorWithLiterals, type ActivityAuthor, type ActivityAuthorValueOneOf, ActivityType, type ActivityTypeWithLiterals, type AdditionalFee, type AdditionalFeeDelta, type AdditionalFeeDeltaDeltaDetailsOneOf, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AdjustmentTypeWithLiterals, type ApplicationError, type AppliedDiscount, type AppliedDiscountDelta, type AppliedDiscountDeltaDeltaDetailsOneOf, type AppliedDiscountDiscountSourceOneOf, type BaseEventMetadata, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BillingSettings, type BulkActionMetadata, type BulkCreateSubscriptionContractsRequest, type BulkCreateSubscriptionContractsResponse, type BulkSubscriptionContractResult, type BulkUpdateSubscriptionContractsRequest, type BulkUpdateSubscriptionContractsResponse, type BuyerInfo, type BuyerInfoIdOneOf, type CatalogReference, ChangeType, type ChangeTypeWithLiterals, type ChangesAppliedActivity, type ChangesAppliedActivityTargetOneOf, type ChannelInfo, ChannelType, type ChannelTypeWithLiterals, ChargeType, type ChargeTypeWithLiterals, type Color, type CommitSubscriptionContractChangesRequest, type CommitSubscriptionContractChangesResponse, type CommonQueryWithEntityContext, type ContractChange, type ContractChangeValueOneOf, type ContractTarget, type Coupon, type CreateSubscriptionContractRequest, type CreateSubscriptionContractResponse, type CurrencyConversionDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomField, type DecimalQuantity, type DecimalQuantityUnitOneOf, type DeliveryLogistics, type DeliveryLogisticsAddressOneOf, type DeliveryTimeSlot, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type DigitalFile, type Dimensions, DimensionsUnit, type DimensionsUnitWithLiterals, DiscountReason, type DiscountReasonWithLiterals, type DiscountRule, type DiscountRuleName, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type FocalPoint, type FreeTrialPeriod, type FullAddressContactDetails, type GetSubscriptionContractRequest, type GetSubscriptionContractResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemCombination, type ItemCombinationLineItem, type ItemMetadata, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemChanges, type LineItemDelta, type LineItemDiscount, type LineItemQuantityChange, LineItemQuantityChangeType, type LineItemQuantityChangeTypeWithLiterals, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type ManagedAdditionalFee, type ManagedDiscount, type ManagedLineItem, type MaskedSubscriptionContract, MeasurementUnit, type MeasurementUnitWithLiterals, type MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf, type MessageEnvelope, type ModifierGroup, type OrderLineItem, type OrderTaxBreakdown, type OrderTaxInfo, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PickupAddress, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, type PlatformFeeSummary, type Price, type PriceDescription, type PriceSummary, type ProductName, ProductPeriodAlignment, type ProductPeriodAlignmentWithLiterals, type QuerySubscriptionContractsRequest, type QuerySubscriptionContractsResponse, type RestockLocation, type RestoreInfo, type ShippingInformation, type ShippingPrice, type ShippingRegion, SortOrder, type SortOrderWithLiterals, type Sorting, SpecificItemsCouponBehavior, type SpecificItemsCouponBehaviorWithLiterals, type StreetAddress, type SubscriptionCommitSettings, type SubscriptionContract, type SubscriptionContractActivity, type SubscriptionContractActivityContentOneOf, type SubscriptionContractActivityTargetOneOf, type SubscriptionContractCanceled, type SubscriptionContractChangesCommitted, type SubscriptionContractCreatedEnvelope, type SubscriptionContractDeletedEnvelope, type SubscriptionContractDiffs, type SubscriptionContractExpired, type SubscriptionContractQuery, type SubscriptionContractQuerySpec, type SubscriptionContractSettings, type SubscriptionContractUpdatedEnvelope, type SubscriptionContractsQueryBuilder, type SubscriptionContractsQueryResult, type SubscriptionDescription, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionInfo, type SubscriptionSettings, SubscriptionSettingsProductPeriodAlignment, type SubscriptionSettingsProductPeriodAlignmentWithLiterals, type SubscriptionTitle, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TotalPriceChange, type TranslatableString, type TranslatedValue, type UpdateSubscriptionContractRequest, type UpdateSubscriptionContractResponse, type V1BillingSettings, type V1FreeTrialPeriod, type V1SubscriptionDescription, type V1SubscriptionSettings, type V1SubscriptionTitle, V2SubscriptionFrequency, type V2SubscriptionFrequencyWithLiterals, type VatId, VatType, type VatTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, getSubscriptionContract, onSubscriptionContractCreated, onSubscriptionContractDeleted, onSubscriptionContractUpdated, querySubscriptionContracts, typedQuerySubscriptionContracts, utils };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, ActionInitiator, type ActionInitiatorWithLiterals, type ActivityAuthor, type ActivityAuthorValueOneOf, ActivityType, type ActivityTypeWithLiterals, type AdditionalFee, type AdditionalFeeDelta, type AdditionalFeeDeltaDeltaDetailsOneOf, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AdjustmentTypeWithLiterals, type ApplicationError, type AppliedDiscount, type AppliedDiscountDelta, type AppliedDiscountDeltaDeltaDetailsOneOf, type AppliedDiscountDiscountSourceOneOf, type BaseEventMetadata, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BillingSettings, type BulkActionMetadata, type BulkCreateSubscriptionContractsRequest, type BulkCreateSubscriptionContractsResponse, type BulkSubscriptionContractResult, type BulkUpdateSubscriptionContractsRequest, type BulkUpdateSubscriptionContractsResponse, type BuyerInfo, type BuyerInfoIdOneOf, type CatalogReference, ChangeType, type ChangeTypeWithLiterals, type ChangesAppliedActivity, type ChangesAppliedActivityTargetOneOf, type ChannelInfo, ChannelType, type ChannelTypeWithLiterals, ChargeType, type ChargeTypeWithLiterals, type Color, type CommitSubscriptionContractChangesRequest, type CommitSubscriptionContractChangesResponse, type CommonQueryWithEntityContext, type ContractChange, type ContractChangeValueOneOf, type ContractTarget, type Coupon, type CreateSubscriptionContractRequest, type CreateSubscriptionContractResponse, type CurrencyConversionDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomField, type DecimalQuantity, type DecimalQuantityUnitOneOf, type DeliveryLogistics, type DeliveryLogisticsAddressOneOf, type DeliveryTimeSlot, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type DigitalFile, type Dimensions, DimensionsUnit, type DimensionsUnitWithLiterals, DiscountReason, type DiscountReasonWithLiterals, type DiscountRule, type DiscountRuleName, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type FocalPoint, type FreeTrialPeriod, type FullAddressContactDetails, type GetSubscriptionContractRequest, type GetSubscriptionContractResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemCombination, type ItemCombinationLineItem, type ItemMetadata, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemChanges, type LineItemDelta, type LineItemDiscount, type LineItemQuantityChange, LineItemQuantityChangeType, type LineItemQuantityChangeTypeWithLiterals, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type ManagedAdditionalFee, type ManagedDiscount, type ManagedLineItem, type MaskedSubscriptionContract, MeasurementUnit, type MeasurementUnitWithLiterals, type MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf, type MessageEnvelope, type ModifierGroup, type OrderLineItem, type OrderTaxBreakdown, type OrderTaxInfo, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PickupAddress, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, type PlatformFeeSummary, type Price, type PriceDescription, type PriceSummary, type ProductName, ProductPeriodAlignment, type ProductPeriodAlignmentWithLiterals, type QuerySubscriptionContractsRequest, type QuerySubscriptionContractsResponse, type RestockLocation, type RestoreInfo, type ServiceProperties, type ShippingInformation, type ShippingPrice, type ShippingRegion, SortOrder, type SortOrderWithLiterals, type Sorting, SpecificItemsCouponBehavior, type SpecificItemsCouponBehaviorWithLiterals, type StreetAddress, type SubscriptionCommitSettings, type SubscriptionContract, type SubscriptionContractActivity, type SubscriptionContractActivityContentOneOf, type SubscriptionContractActivityTargetOneOf, type SubscriptionContractCanceled, type SubscriptionContractChangesCommitted, type SubscriptionContractCreatedEnvelope, type SubscriptionContractDeletedEnvelope, type SubscriptionContractDiffs, type SubscriptionContractExpired, type SubscriptionContractQuery, type SubscriptionContractQuerySpec, type SubscriptionContractSettings, type SubscriptionContractUpdatedEnvelope, type SubscriptionContractsQueryBuilder, type SubscriptionContractsQueryResult, type SubscriptionDescription, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionInfo, type SubscriptionSettings, SubscriptionSettingsProductPeriodAlignment, type SubscriptionSettingsProductPeriodAlignmentWithLiterals, type SubscriptionTitle, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TotalPriceChange, type TranslatableString, type TranslatedValue, type UpdateSubscriptionContractRequest, type UpdateSubscriptionContractResponse, type V1BillingSettings, type V1FreeTrialPeriod, type V1SubscriptionDescription, type V1SubscriptionSettings, type V1SubscriptionTitle, V2SubscriptionFrequency, type V2SubscriptionFrequencyWithLiterals, type VatId, VatType, type VatTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, getSubscriptionContract, onSubscriptionContractCreated, onSubscriptionContractDeleted, onSubscriptionContractUpdated, querySubscriptionContracts, typedQuerySubscriptionContracts, utils };

package/build/internal/es/index.typings.mjs

@@ -80,6 +80,12 @@ function getSubscriptionContract(payload) {
             {
               path: "subscriptionContract.lineItems.subscriptionInfo.subscriptionSettings.startDate"
             },
+            {
+              path: "subscriptionContract.lineItems.serviceProperties.scheduledDate"
+            },
+            {
+              path: "subscriptionContract.lineItems.serviceProperties.endDate"
+            },
             {
               path: "subscriptionContract.shippingInfo.logistics.deliverByDate"
             },
@@ -164,6 +170,12 @@ function querySubscriptionContracts(payload) {
             {
               path: "subscriptionContracts.lineItems.subscriptionInfo.subscriptionSettings.startDate"
             },
+            {
+              path: "subscriptionContracts.lineItems.serviceProperties.scheduledDate"
+            },
+            {
+              path: "subscriptionContracts.lineItems.serviceProperties.endDate"
+            },
             {
               path: "subscriptionContracts.shippingInfo.logistics.deliverByDate"
             },