@wix/auto_sdk_ecom_subscription-contracts 1.0.78 → 1.0.80

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

@@ -84,6 +84,11 @@ interface SubscriptionContract {
      * @readonly
      */
     priceSummary?: PriceSummary;
+    /**
+     * Summary of all platform fees added to the order.
+     * @internal
+     */
+    platformFeeSummary?: PlatformFeeSummary;
     /** Billing address and contact details. */
     billingInfo?: AddressWithContact;
     /** Shipping info and selected shipping option details. */
@@ -1003,6 +1008,56 @@ interface PriceSummary {
     /** Total price of additional fees before tax. */
     totalAdditionalFees?: Price;
 }
+interface PlatformFeeSummary {
+    /** Total sum of all platform fees. */
+    total?: Price;
+    /** Total amount of platform fees with `PASS_ON` charge type. */
+    totalPassOn?: Price;
+    /** Total amount of platform fees with `ABSORBED` charge type. */
+    totalAbsorbed?: Price;
+    /**
+     * Specific information about each platform fee.
+     * @maxSize 300
+     */
+    fees?: PlatformFee[];
+}
+interface PlatformFee {
+    /** Platform fee name. */
+    name?: TranslatableString;
+    /** Platform fee amount. */
+    amount?: Price;
+    /**
+     * ID of the line item the platform fee applies to.
+     * @format GUID
+     */
+    lineItemId?: string;
+    /** Platform fee charge type. */
+    chargeType?: ChargeTypeWithLiterals;
+    /**
+     * Percentage rate charged as platform fee.
+     * The fee rate expressed as a decimal fraction between 0 and 1. For example, `0.05` for 5%.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, lte:1, maxScale:4 }
+     */
+    percentageRate?: string;
+}
+declare enum ChargeType {
+    UNKNOWN_CHARGE_TYPE = "UNKNOWN_CHARGE_TYPE",
+    /**
+     * Platform fee passed on to buyer.
+     *
+     * This type increases the order total, and is visible to the buyer and merchant as an additional fee.
+     */
+    PASS_ON = "PASS_ON",
+    /**
+     * Platform fee absorbed by merchant.
+     *
+     * This type does not increase the order total, and is only visible to the merchant.
+     */
+    ABSORBED = "ABSORBED"
+}
+/** @enumType */
+type ChargeTypeWithLiterals = ChargeType | 'UNKNOWN_CHARGE_TYPE' | 'PASS_ON' | 'ABSORBED';
 /** Billing Info and shipping details */
 interface AddressWithContact {
     /** Address. */
@@ -1608,7 +1663,27 @@ interface AdditionalFee {
      * @max 999
      */
     subscriptionCycles?: number | null;
+    /**
+     * Specifies the entity that added the additional fee.
+     * @internal
+     */
+    source?: AdditionalFeeSourceWithLiterals;
+}
+declare enum AdditionalFeeSource {
+    UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
+    /** The additional fee was added by an additional fee service plugin. */
+    SERVICE_PLUGIN = "SERVICE_PLUGIN",
+    /** The additional fee was added to the item by a catalog or custom line item. */
+    ITEM = "ITEM",
+    /** The additional fee was added manually on request. */
+    MANUAL = "MANUAL",
+    /** The additional fee was added by the shipping provider. */
+    SHIPPING = "SHIPPING",
+    /** The additional fee was added by the Wix eCommerce platform. */
+    PLATFORM = "PLATFORM"
 }
+/** @enumType */
+type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING' | 'PLATFORM';
 interface Location {
     /**
      * Location ID.
@@ -2053,6 +2128,7 @@ declare function onSubscriptionContractDeleted(handler: (event: SubscriptionCont
 interface SubscriptionContractUpdatedEnvelope {
     entity: SubscriptionContract;
     metadata: EventMetadata;
+    /** @hidden */
     modifiedFields: Record<string, any>;
 }
 /** @permissionScope Manage Stores - all permissions
@@ -2240,4 +2316,4 @@ type SubscriptionContractQuery = {
     }[];
 };
 
-export { type ActionEvent, type AdditionalFee, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AdjustmentTypeWithLiterals, type ApplicationError, type AppliedDiscount, type AppliedDiscountDiscountSourceOneOf, type BaseEventMetadata, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BulkActionMetadata, type BulkCreateSubscriptionContractsRequest, type BulkCreateSubscriptionContractsResponse, type BulkSubscriptionContractResult, type BulkUpdateSubscriptionContractsRequest, type BulkUpdateSubscriptionContractsResponse, type BuyerInfo, type BuyerInfoIdOneOf, type CatalogReference, type ChannelInfo, ChannelType, type ChannelTypeWithLiterals, type Color, type CommonQueryWithEntityContext, type Coupon, type CreateSubscriptionContractRequest, type CreateSubscriptionContractResponse, type CurrencyConversionDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomField, type DeliveryLogistics, type DeliveryLogisticsAddressOneOf, type DeliveryTimeSlot, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type DigitalFile, 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 ItemMetadata, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemDiscount, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type MaskedSubscriptionContract, 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 Price, type PriceDescription, type PriceSummary, type ProductName, type QuerySubscriptionContractsRequest, type QuerySubscriptionContractsResponse, type RestoreInfo, type ShippingInformation, type ShippingPrice, type ShippingRegion, SortOrder, type SortOrderWithLiterals, type Sorting, type StreetAddress, type SubscriptionContract, type SubscriptionContractCreatedEnvelope, type SubscriptionContractDeletedEnvelope, type SubscriptionContractQuery, type SubscriptionContractQuerySpec, type SubscriptionContractUpdatedEnvelope, type SubscriptionContractsQueryBuilder, type SubscriptionContractsQueryResult, type SubscriptionDescription, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionInfo, type SubscriptionSettings, type SubscriptionTitle, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TranslatableString, type UpdateSubscriptionContractRequest, type UpdateSubscriptionContractResponse, 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 };
+export { type ActionEvent, type AdditionalFee, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AdjustmentTypeWithLiterals, type ApplicationError, type AppliedDiscount, type AppliedDiscountDiscountSourceOneOf, type BaseEventMetadata, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BulkActionMetadata, type BulkCreateSubscriptionContractsRequest, type BulkCreateSubscriptionContractsResponse, type BulkSubscriptionContractResult, type BulkUpdateSubscriptionContractsRequest, type BulkUpdateSubscriptionContractsResponse, type BuyerInfo, type BuyerInfoIdOneOf, type CatalogReference, type ChannelInfo, ChannelType, type ChannelTypeWithLiterals, ChargeType, type ChargeTypeWithLiterals, type Color, type CommonQueryWithEntityContext, type Coupon, type CreateSubscriptionContractRequest, type CreateSubscriptionContractResponse, type CurrencyConversionDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomField, type DeliveryLogistics, type DeliveryLogisticsAddressOneOf, type DeliveryTimeSlot, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type DigitalFile, 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 ItemMetadata, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemDiscount, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type MaskedSubscriptionContract, 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, type QuerySubscriptionContractsRequest, type QuerySubscriptionContractsResponse, type RestoreInfo, type ShippingInformation, type ShippingPrice, type ShippingRegion, SortOrder, type SortOrderWithLiterals, type Sorting, type StreetAddress, type SubscriptionContract, type SubscriptionContractCreatedEnvelope, type SubscriptionContractDeletedEnvelope, type SubscriptionContractQuery, type SubscriptionContractQuerySpec, type SubscriptionContractUpdatedEnvelope, type SubscriptionContractsQueryBuilder, type SubscriptionContractsQueryResult, type SubscriptionDescription, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionInfo, type SubscriptionSettings, type SubscriptionTitle, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TranslatableString, type UpdateSubscriptionContractRequest, type UpdateSubscriptionContractResponse, 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 };

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

@@ -285,6 +285,12 @@ var WeightUnit = /* @__PURE__ */ ((WeightUnit2) => {
   WeightUnit2["LB"] = "LB";
   return WeightUnit2;
 })(WeightUnit || {});
+var ChargeType = /* @__PURE__ */ ((ChargeType2) => {
+  ChargeType2["UNKNOWN_CHARGE_TYPE"] = "UNKNOWN_CHARGE_TYPE";
+  ChargeType2["PASS_ON"] = "PASS_ON";
+  ChargeType2["ABSORBED"] = "ABSORBED";
+  return ChargeType2;
+})(ChargeType || {});
 var VatType = /* @__PURE__ */ ((VatType2) => {
   VatType2["UNSPECIFIED"] = "UNSPECIFIED";
   VatType2["CPF"] = "CPF";
@@ -329,6 +335,15 @@ var ChannelType = /* @__PURE__ */ ((ChannelType2) => {
   ChannelType2["PAYPAL_AGENTIC_CHECKOUT"] = "PAYPAL_AGENTIC_CHECKOUT";
   return ChannelType2;
 })(ChannelType || {});
+var AdditionalFeeSource = /* @__PURE__ */ ((AdditionalFeeSource2) => {
+  AdditionalFeeSource2["UNKNOWN_ADDITIONAL_FEE_SOURCE"] = "UNKNOWN_ADDITIONAL_FEE_SOURCE";
+  AdditionalFeeSource2["SERVICE_PLUGIN"] = "SERVICE_PLUGIN";
+  AdditionalFeeSource2["ITEM"] = "ITEM";
+  AdditionalFeeSource2["MANUAL"] = "MANUAL";
+  AdditionalFeeSource2["SHIPPING"] = "SHIPPING";
+  AdditionalFeeSource2["PLATFORM"] = "PLATFORM";
+  return AdditionalFeeSource2;
+})(AdditionalFeeSource || {});
 var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
   SortOrder2["ASC"] = "ASC";
   SortOrder2["DESC"] = "DESC";
@@ -500,8 +515,10 @@ async function typedQuerySubscriptionContracts(query) {
   }
 }
 export {
+  AdditionalFeeSource,
   AdjustmentType,
   ChannelType,
+  ChargeType,
   DescriptionLineType,
   DiscountReason,
   DiscountType,