@wix/auto_sdk_ecom_subscription-contracts 1.0.149 → 1.0.151

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

@@ -1709,6 +1709,7 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
     merchantDiscount?: MerchantDiscount;
     /** Automatic discount applied by the system based on configured discount rules. */
     discountRule?: DiscountRule;
+    /** Discount type. */
     discountType?: DiscountTypeWithLiterals;
     /**
      * __Deprecated.__ Use `lineItemDiscounts` instead.
@@ -1756,16 +1757,24 @@ declare enum DiscountType {
 /** @enumType */
 type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
 /** Coupon */
-interface Coupon {
+interface Coupon extends CouponDiscountValueOneOf {
     /** Coupon ID. */
     _id?: string;
     /** Coupon code. */
     code?: string;
     /** Coupon name. */
     name?: string;
-    /** Coupon value. */
+    /** Total amount the coupon took off. */
     amount?: Price;
 }
+/** @oneof */
+interface CouponDiscountValueOneOf {
+}
+/** How a coupon's or discount rule's discount value is expressed. */
+declare enum DiscountValueType {
+}
+/** @enumType */
+type DiscountValueTypeWithLiterals = DiscountValueType;
 /** Discount applied manually by the merchant through the dashboard. */
 interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
     /** Predefined discount reason. */
@@ -1799,7 +1808,7 @@ declare enum DiscountReason {
 }
 /** @enumType */
 type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
-interface DiscountRule {
+interface DiscountRule extends DiscountRuleDiscountValueOneOf {
     /**
      * Discount rule ID
      * @format GUID
@@ -1807,9 +1816,12 @@ interface DiscountRule {
     _id?: string;
     /** Discount rule name */
     name?: DiscountRuleName;
-    /** Discount value. */
+    /** Total amount the discount rule took off. */
     amount?: Price;
 }
+/** @oneof */
+interface DiscountRuleDiscountValueOneOf {
+}
 interface DiscountRuleName {
     /**
      * Original discount rule name (in site's default language).
@@ -3085,10 +3097,10 @@ interface SubscriptionContractCommittedEnvelope {
  * The event holds the updated contract and every change that was applied.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Read subscription contracts
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
- * @permissionScope Manage subscription contracts
- * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -3108,10 +3120,10 @@ interface SubscriptionContractCreatedEnvelope {
  * 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.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Read subscription contracts
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
- * @permissionScope Manage subscription contracts
- * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -3131,10 +3143,10 @@ interface SubscriptionContractDeletedEnvelope {
  * 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.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Read subscription contracts
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
- * @permissionScope Manage subscription contracts
- * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -3158,10 +3170,10 @@ interface SubscriptionContractUpdatedEnvelope {
  * 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.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Read subscription contracts
+ * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACT-READ
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
- * @permissionScope Manage subscription contracts
- * @permissionScopeId SCOPE.ECOM.SUBSCRIPTION-CONTRACTS
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
@@ -3354,4 +3366,4 @@ declare const utils: {
     query: _wix_sdk_types.QueryHelpers<SubscriptionContract, SubscriptionContractQuerySpec, SubscriptionContractQuery>;
 };
 
-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 AdditionalFeeSummary, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AdjustmentTypeWithLiterals, type ApplicationError, type AppliedDiscount, type AppliedDiscountDelta, type AppliedDiscountDeltaDeltaDetailsOneOf, type AppliedDiscountDiscountSourceOneOf, type BaseEventMetadata, BaseRateSource, type BaseRateSourceWithLiterals, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BillingSettings, type BulkActionMetadata, type BulkCreateSubscriptionContractsRequest, type BulkCreateSubscriptionContractsResponse, type BulkSubscriptionContractResult, type BulkUpdateSubscriptionContractsRequest, type BulkUpdateSubscriptionContractsResponse, type BuyerInfo, type BuyerInfoIdOneOf, type CatalogReference, type CatalogReferenceOptionsBeforeChange, 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 ContractChangeChangeDetailsOneOf, ContractChangeType, type ContractChangeTypeWithLiterals, type ContractTarget, type Coupon, type CreateSubscriptionContractRequest, type CreateSubscriptionContractResponse, type CrossBorderCalculation, CrossBorderNotApplicableReason, type CrossBorderNotApplicableReasonWithLiterals, type CrossBorderPriceAdjustment, CrossBorderRepricingMode, type CrossBorderRepricingModeWithLiterals, type CurrencyConversionDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomField, type CyclePriceOverride, type DecimalQuantity, type DecimalQuantityUnitOneOf, type DeliveryLogistics, type DeliveryLogisticsAddressOneOf, type DeliveryProfileIdBeforeChange, type DeliveryTimeSlot, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type DescriptionLinesBeforeChange, type DigitalFile, type DigitalFileBeforeChange, type Dimensions, DimensionsUnit, type DimensionsUnitWithLiterals, DiscountReason, type DiscountReasonWithLiterals, type DiscountRule, type DiscountRuleName, type DiscountSummary, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type FocalPoint, type FreeTrialPeriod, type FulfillerIdBeforeChange, type FullAddressContactDetails, type GetSubscriptionContractApplicationErrors, type GetSubscriptionContractRequest, type GetSubscriptionContractResponse, type IdentificationData, type IdentificationDataIdOneOf, type ImageBeforeChange, type InventoryAppIdBeforeChange, type ItemChangedDetails, type ItemCombination, type ItemCombinationLineItem, type ItemMetadata, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeBeforeChange, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemChanges, type LineItemCyclePriceOverrides, type LineItemDelta, type LineItemDeltaDeltaDetailsOneOf, type LineItemDiscount, type LineItemQuantityChange, LineItemQuantityChangeType, type LineItemQuantityChangeTypeWithLiterals, type LineItemSummary, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type MaskedSubscriptionContract, MeasurementUnit, type MeasurementUnitWithLiterals, type MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf, type MessageEnvelope, type ModifierGroup, type ModifierGroupsBeforeChange, type OrderLineItem, type OrderTaxBreakdown, type OrderTaxInfo, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PhysicalPropertiesBeforeChange, type PickupAddress, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, type PlatformFeeSummary, type Price, type PriceDescription, type PriceDescriptionBeforeChange, type PriceSummary, type PriceUndeterminedBeforeChange, type ProductName, type ProductNameBeforeChange, ProductPeriodAlignment, type ProductPeriodAlignmentWithLiterals, type QuerySubscriptionContractsRequest, type QuerySubscriptionContractsResponse, RepriceStatus, type RepriceStatusWithLiterals, type RestockLocation, type RestoreInfo, type RootCatalogItemIdBeforeChange, type ServiceProperties, type ShippingGroupIdBeforeChange, 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 SubscriptionContractChargeUpcoming, type SubscriptionContractCommittedEnvelope, 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 TaxInfoBeforeChange, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TotalPriceChange, type TranslatableString, type TranslatedValue, type UpdateSubscriptionContractRequest, type UpdateSubscriptionContractResponse, type V1BillingSettings, type V1CyclePriceOverride, type V1FreeTrialPeriod, type V1SubscriptionDescription, type V1SubscriptionSettings, type V1SubscriptionTitle, V2SubscriptionFrequency, type V2SubscriptionFrequencyWithLiterals, type VatId, VatType, type VatTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, getSubscriptionContract, onSubscriptionContractCommitted, 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 AdditionalFeeSummary, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AdjustmentTypeWithLiterals, type ApplicationError, type AppliedDiscount, type AppliedDiscountDelta, type AppliedDiscountDeltaDeltaDetailsOneOf, type AppliedDiscountDiscountSourceOneOf, type BaseEventMetadata, BaseRateSource, type BaseRateSourceWithLiterals, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BillingSettings, type BulkActionMetadata, type BulkCreateSubscriptionContractsRequest, type BulkCreateSubscriptionContractsResponse, type BulkSubscriptionContractResult, type BulkUpdateSubscriptionContractsRequest, type BulkUpdateSubscriptionContractsResponse, type BuyerInfo, type BuyerInfoIdOneOf, type CatalogReference, type CatalogReferenceOptionsBeforeChange, 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 ContractChangeChangeDetailsOneOf, ContractChangeType, type ContractChangeTypeWithLiterals, type ContractTarget, type Coupon, type CouponDiscountValueOneOf, type CreateSubscriptionContractRequest, type CreateSubscriptionContractResponse, type CrossBorderCalculation, CrossBorderNotApplicableReason, type CrossBorderNotApplicableReasonWithLiterals, type CrossBorderPriceAdjustment, CrossBorderRepricingMode, type CrossBorderRepricingModeWithLiterals, type CurrencyConversionDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomField, type CyclePriceOverride, type DecimalQuantity, type DecimalQuantityUnitOneOf, type DeliveryLogistics, type DeliveryLogisticsAddressOneOf, type DeliveryProfileIdBeforeChange, type DeliveryTimeSlot, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type DescriptionLinesBeforeChange, type DigitalFile, type DigitalFileBeforeChange, type Dimensions, DimensionsUnit, type DimensionsUnitWithLiterals, DiscountReason, type DiscountReasonWithLiterals, type DiscountRule, type DiscountRuleDiscountValueOneOf, type DiscountRuleName, type DiscountSummary, DiscountType, type DiscountTypeWithLiterals, DiscountValueType, type DiscountValueTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type FocalPoint, type FreeTrialPeriod, type FulfillerIdBeforeChange, type FullAddressContactDetails, type GetSubscriptionContractApplicationErrors, type GetSubscriptionContractRequest, type GetSubscriptionContractResponse, type IdentificationData, type IdentificationDataIdOneOf, type ImageBeforeChange, type InventoryAppIdBeforeChange, type ItemChangedDetails, type ItemCombination, type ItemCombinationLineItem, type ItemMetadata, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeBeforeChange, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemChanges, type LineItemCyclePriceOverrides, type LineItemDelta, type LineItemDeltaDeltaDetailsOneOf, type LineItemDiscount, type LineItemQuantityChange, LineItemQuantityChangeType, type LineItemQuantityChangeTypeWithLiterals, type LineItemSummary, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type MaskedSubscriptionContract, MeasurementUnit, type MeasurementUnitWithLiterals, type MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf, type MessageEnvelope, type ModifierGroup, type ModifierGroupsBeforeChange, type OrderLineItem, type OrderTaxBreakdown, type OrderTaxInfo, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PhysicalPropertiesBeforeChange, type PickupAddress, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, type PlatformFeeSummary, type Price, type PriceDescription, type PriceDescriptionBeforeChange, type PriceSummary, type PriceUndeterminedBeforeChange, type ProductName, type ProductNameBeforeChange, ProductPeriodAlignment, type ProductPeriodAlignmentWithLiterals, type QuerySubscriptionContractsRequest, type QuerySubscriptionContractsResponse, RepriceStatus, type RepriceStatusWithLiterals, type RestockLocation, type RestoreInfo, type RootCatalogItemIdBeforeChange, type ServiceProperties, type ShippingGroupIdBeforeChange, 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 SubscriptionContractChargeUpcoming, type SubscriptionContractCommittedEnvelope, 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 TaxInfoBeforeChange, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TotalPriceChange, type TranslatableString, type TranslatedValue, type UpdateSubscriptionContractRequest, type UpdateSubscriptionContractResponse, type V1BillingSettings, type V1CyclePriceOverride, type V1FreeTrialPeriod, type V1SubscriptionDescription, type V1SubscriptionSettings, type V1SubscriptionTitle, V2SubscriptionFrequency, type V2SubscriptionFrequencyWithLiterals, type VatId, VatType, type VatTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, getSubscriptionContract, onSubscriptionContractCommitted, onSubscriptionContractCreated, onSubscriptionContractDeleted, onSubscriptionContractUpdated, querySubscriptionContracts, typedQuerySubscriptionContracts, utils };

package/build/cjs/index.typings.js

@@ -35,6 +35,7 @@ __export(index_typings_exports, {
   DimensionsUnit: () => DimensionsUnit,
   DiscountReason: () => DiscountReason,
   DiscountType: () => DiscountType,
+  DiscountValueType: () => DiscountValueType,
   ItemTypePreset: () => ItemTypePreset,
   JurisdictionType: () => JurisdictionType,
   LineItemQuantityChangeType: () => LineItemQuantityChangeType,
@@ -510,6 +511,13 @@ var DiscountType = /* @__PURE__ */ ((DiscountType2) => {
   DiscountType2["SHIPPING"] = "SHIPPING";
   return DiscountType2;
 })(DiscountType || {});
+var DiscountValueType = /* @__PURE__ */ ((DiscountValueType2) => {
+  DiscountValueType2["PERCENTAGE"] = "PERCENTAGE";
+  DiscountValueType2["FIXED_AMOUNT"] = "FIXED_AMOUNT";
+  DiscountValueType2["FIXED_PRICE"] = "FIXED_PRICE";
+  DiscountValueType2["QUANTITY_BASED"] = "QUANTITY_BASED";
+  return DiscountValueType2;
+})(DiscountValueType || {});
 var DiscountReason = /* @__PURE__ */ ((DiscountReason2) => {
   DiscountReason2["UNSPECIFIED"] = "UNSPECIFIED";
   DiscountReason2["EXCHANGED_ITEMS"] = "EXCHANGED_ITEMS";
@@ -756,6 +764,7 @@ var utils = {
   DimensionsUnit,
   DiscountReason,
   DiscountType,
+  DiscountValueType,
   ItemTypePreset,
   JurisdictionType,
   LineItemQuantityChangeType,