@wix/auto_sdk_ecom_subscription-contracts 1.0.143 → 1.0.145

package/build/cjs/index.d.ts

@@ -1,16 +1,24 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { SubscriptionContract, SubscriptionContractCreatedEnvelope, SubscriptionContractDeletedEnvelope, SubscriptionContractUpdatedEnvelope, SubscriptionContractsQueryBuilder, SubscriptionContractQuery, typedQuerySubscriptionContracts } from './index.typings.js';
-export { AccountInfo, AccountInfoMetadata, ActionEvent, ActionInitiator, ActionInitiatorWithLiterals, ActivityAuthor, ActivityAuthorValueOneOf, ActivityType, ActivityTypeWithLiterals, AdditionalFee, AdditionalFeeDelta, AdditionalFeeDeltaDeltaDetailsOneOf, AdditionalFeeSource, AdditionalFeeSourceWithLiterals, Address, AddressLocation, AddressWithContact, AdjustmentType, AdjustmentTypeWithLiterals, ApplicationError, AppliedDiscount, AppliedDiscountDelta, AppliedDiscountDeltaDeltaDetailsOneOf, AppliedDiscountDiscountSourceOneOf, BaseEventMetadata, BillingAdjustment, BillingAdjustmentPriceSummary, BillingSettings, BulkActionMetadata, BulkCreateSubscriptionContractsRequest, BulkCreateSubscriptionContractsResponse, BulkSubscriptionContractResult, BulkUpdateSubscriptionContractsRequest, BulkUpdateSubscriptionContractsResponse, BuyerInfo, BuyerInfoIdOneOf, CatalogReference, CatalogReferenceOptionsBeforeChange, ChangeType, ChangeTypeWithLiterals, ChangesAppliedActivity, ChangesAppliedActivityTargetOneOf, ChannelInfo, ChannelType, ChannelTypeWithLiterals, ChargeType, ChargeTypeWithLiterals, Color, CommitSubscriptionContractChangesRequest, CommitSubscriptionContractChangesResponse, CommonQueryWithEntityContext, ContractChange, ContractChangeValueOneOf, ContractTarget, Coupon, CreateSubscriptionContractRequest, CreateSubscriptionContractResponse, CurrencyConversionDetails, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomField, CyclePriceOverride, DecimalQuantity, DecimalQuantityUnitOneOf, DeliveryLogistics, DeliveryLogisticsAddressOneOf, DeliveryProfileIdBeforeChange, DeliveryTimeSlot, DescriptionLine, DescriptionLineDescriptionLineValueOneOf, DescriptionLineName, DescriptionLineType, DescriptionLineTypeWithLiterals, DescriptionLineValueOneOf, DescriptionLinesBeforeChange, DigitalFile, DigitalFileBeforeChange, Dimensions, DimensionsUnit, DimensionsUnitWithLiterals, DiscountReason, DiscountReasonWithLiterals, DiscountRule, DiscountRuleName, DiscountType, DiscountTypeWithLiterals, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, FocalPoint, FreeTrialPeriod, FulfillerIdBeforeChange, FullAddressContactDetails, GetSubscriptionContractRequest, GetSubscriptionContractResponse, IdentificationData, IdentificationDataIdOneOf, ImageBeforeChange, InventoryAppIdBeforeChange, ItemChangedDetails, ItemCombination, ItemCombinationLineItem, ItemMetadata, ItemModifier, ItemTaxFullDetails, ItemType, ItemTypeBeforeChange, ItemTypeItemTypeDataOneOf, ItemTypePreset, ItemTypePresetWithLiterals, JurisdictionType, JurisdictionTypeWithLiterals, LineItemChanges, LineItemCyclePriceOverrides, LineItemDelta, LineItemDeltaDeltaDetailsOneOf, LineItemDiscount, LineItemQuantityChange, LineItemQuantityChangeType, LineItemQuantityChangeTypeWithLiterals, LineItemTaxBreakdown, LineItemTaxInfo, Location, LocationAndQuantity, ManagedAdditionalFee, ManagedDiscount, ManagedLineItem, MaskedSubscriptionContract, MeasurementUnit, MeasurementUnitWithLiterals, MerchantDiscount, MerchantDiscountMerchantDiscountReasonOneOf, MessageEnvelope, ModifierGroup, ModifierGroupsBeforeChange, OrderLineItem, OrderTaxBreakdown, OrderTaxInfo, PaymentOptionType, PaymentOptionTypeWithLiterals, PhysicalProperties, PhysicalPropertiesBeforeChange, PickupAddress, PickupDetails, PickupMethod, PickupMethodWithLiterals, PlainTextValue, PlatformFee, PlatformFeeSummary, Price, PriceDescription, PriceDescriptionBeforeChange, PriceSummary, PriceUndeterminedBeforeChange, ProductName, ProductNameBeforeChange, ProductPeriodAlignment, ProductPeriodAlignmentWithLiterals, QuerySubscriptionContractsRequest, QuerySubscriptionContractsResponse, RestockLocation, RestoreInfo, RootCatalogItemIdBeforeChange, ServiceProperties, ShippingGroupIdBeforeChange, ShippingInformation, ShippingPrice, ShippingRegion, SortOrder, SortOrderWithLiterals, Sorting, SpecificItemsCouponBehavior, SpecificItemsCouponBehaviorWithLiterals, StreetAddress, SubscriptionCommitSettings, SubscriptionContractActivity, SubscriptionContractActivityContentOneOf, SubscriptionContractActivityTargetOneOf, SubscriptionContractCanceled, SubscriptionContractChangesCommitted, SubscriptionContractChargeUpcoming, SubscriptionContractDiffs, SubscriptionContractExpired, SubscriptionContractQuerySpec, SubscriptionContractSettings, SubscriptionContractsQueryResult, SubscriptionDescription, SubscriptionFrequency, SubscriptionFrequencyWithLiterals, SubscriptionInfo, SubscriptionSettings, SubscriptionSettingsProductPeriodAlignment, SubscriptionSettingsProductPeriodAlignmentWithLiterals, SubscriptionTitle, TaxInfoBeforeChange, TaxableAddress, TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, TaxableAddressTypeWithLiterals, TotalPriceChange, TranslatableString, TranslatedValue, UpdateSubscriptionContractRequest, UpdateSubscriptionContractResponse, V1BillingSettings, V1CyclePriceOverride, V1FreeTrialPeriod, V1SubscriptionDescription, V1SubscriptionSettings, V1SubscriptionTitle, V2SubscriptionFrequency, V2SubscriptionFrequencyWithLiterals, VatId, VatType, VatTypeWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WeightUnit, WeightUnitWithLiterals, utils } from './index.typings.js';
+import { SubscriptionContract, GetSubscriptionContractApplicationErrors, SubscriptionContractCommittedEnvelope, SubscriptionContractCreatedEnvelope, SubscriptionContractDeletedEnvelope, SubscriptionContractUpdatedEnvelope, SubscriptionContractsQueryBuilder, SubscriptionContractQuery, typedQuerySubscriptionContracts } from './index.typings.js';
+export { AccountInfo, AccountInfoMetadata, ActionEvent, ActionInitiator, ActionInitiatorWithLiterals, ActivityAuthor, ActivityAuthorValueOneOf, ActivityType, ActivityTypeWithLiterals, AdditionalFee, AdditionalFeeDelta, AdditionalFeeDeltaDeltaDetailsOneOf, AdditionalFeeSource, AdditionalFeeSourceWithLiterals, AdditionalFeeSummary, Address, AddressLocation, AddressWithContact, AdjustmentType, AdjustmentTypeWithLiterals, ApplicationError, AppliedDiscount, AppliedDiscountDelta, AppliedDiscountDeltaDeltaDetailsOneOf, AppliedDiscountDiscountSourceOneOf, BaseEventMetadata, BillingAdjustment, BillingAdjustmentPriceSummary, BillingSettings, BulkActionMetadata, BulkCreateSubscriptionContractsRequest, BulkCreateSubscriptionContractsResponse, BulkSubscriptionContractResult, BulkUpdateSubscriptionContractsRequest, BulkUpdateSubscriptionContractsResponse, BuyerInfo, BuyerInfoIdOneOf, CatalogReference, CatalogReferenceOptionsBeforeChange, ChangeType, ChangeTypeWithLiterals, ChangesAppliedActivity, ChangesAppliedActivityTargetOneOf, ChannelInfo, ChannelType, ChannelTypeWithLiterals, ChargeType, ChargeTypeWithLiterals, Color, CommitSubscriptionContractChangesRequest, CommitSubscriptionContractChangesResponse, CommonQueryWithEntityContext, ContractChange, ContractChangeChangeDetailsOneOf, ContractChangeType, ContractChangeTypeWithLiterals, ContractTarget, Coupon, CreateSubscriptionContractRequest, CreateSubscriptionContractResponse, CurrencyConversionDetails, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomField, CyclePriceOverride, DecimalQuantity, DecimalQuantityUnitOneOf, DeliveryLogistics, DeliveryLogisticsAddressOneOf, DeliveryProfileIdBeforeChange, DeliveryTimeSlot, DescriptionLine, DescriptionLineDescriptionLineValueOneOf, DescriptionLineName, DescriptionLineType, DescriptionLineTypeWithLiterals, DescriptionLineValueOneOf, DescriptionLinesBeforeChange, DigitalFile, DigitalFileBeforeChange, Dimensions, DimensionsUnit, DimensionsUnitWithLiterals, DiscountReason, DiscountReasonWithLiterals, DiscountRule, DiscountRuleName, DiscountSummary, DiscountType, DiscountTypeWithLiterals, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, FocalPoint, FreeTrialPeriod, FulfillerIdBeforeChange, FullAddressContactDetails, GetSubscriptionContractRequest, GetSubscriptionContractResponse, IdentificationData, IdentificationDataIdOneOf, ImageBeforeChange, InventoryAppIdBeforeChange, ItemChangedDetails, ItemCombination, ItemCombinationLineItem, ItemMetadata, ItemModifier, ItemTaxFullDetails, ItemType, ItemTypeBeforeChange, ItemTypeItemTypeDataOneOf, ItemTypePreset, ItemTypePresetWithLiterals, JurisdictionType, JurisdictionTypeWithLiterals, LineItemChanges, LineItemCyclePriceOverrides, LineItemDelta, LineItemDeltaDeltaDetailsOneOf, LineItemDiscount, LineItemQuantityChange, LineItemQuantityChangeType, LineItemQuantityChangeTypeWithLiterals, LineItemSummary, LineItemTaxBreakdown, LineItemTaxInfo, Location, LocationAndQuantity, MaskedSubscriptionContract, MeasurementUnit, MeasurementUnitWithLiterals, MerchantDiscount, MerchantDiscountMerchantDiscountReasonOneOf, MessageEnvelope, ModifierGroup, ModifierGroupsBeforeChange, OrderLineItem, OrderTaxBreakdown, OrderTaxInfo, PaymentOptionType, PaymentOptionTypeWithLiterals, PhysicalProperties, PhysicalPropertiesBeforeChange, PickupAddress, PickupDetails, PickupMethod, PickupMethodWithLiterals, PlainTextValue, PlatformFee, PlatformFeeSummary, Price, PriceDescription, PriceDescriptionBeforeChange, PriceSummary, PriceUndeterminedBeforeChange, ProductName, ProductNameBeforeChange, ProductPeriodAlignment, ProductPeriodAlignmentWithLiterals, QuerySubscriptionContractsRequest, QuerySubscriptionContractsResponse, RestockLocation, RestoreInfo, RootCatalogItemIdBeforeChange, ServiceProperties, ShippingGroupIdBeforeChange, ShippingInformation, ShippingPrice, ShippingRegion, SortOrder, SortOrderWithLiterals, Sorting, SpecificItemsCouponBehavior, SpecificItemsCouponBehaviorWithLiterals, StreetAddress, SubscriptionCommitSettings, SubscriptionContractActivity, SubscriptionContractActivityContentOneOf, SubscriptionContractActivityTargetOneOf, SubscriptionContractCanceled, SubscriptionContractChangesCommitted, SubscriptionContractChargeUpcoming, SubscriptionContractDiffs, SubscriptionContractExpired, SubscriptionContractQuerySpec, SubscriptionContractSettings, SubscriptionContractsQueryResult, SubscriptionDescription, SubscriptionFrequency, SubscriptionFrequencyWithLiterals, SubscriptionInfo, SubscriptionSettings, SubscriptionSettingsProductPeriodAlignment, SubscriptionSettingsProductPeriodAlignmentWithLiterals, SubscriptionTitle, TaxInfoBeforeChange, TaxableAddress, TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, TaxableAddressTypeWithLiterals, TotalPriceChange, TranslatableString, TranslatedValue, UpdateSubscriptionContractRequest, UpdateSubscriptionContractResponse, V1BillingSettings, V1CyclePriceOverride, V1FreeTrialPeriod, V1SubscriptionDescription, V1SubscriptionSettings, V1SubscriptionTitle, V2SubscriptionFrequency, V2SubscriptionFrequencyWithLiterals, VatId, VatType, VatTypeWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WeightUnit, WeightUnitWithLiterals, utils } from './index.typings.js';
 
 declare function getSubscriptionContract$1(httpClient: HttpClient): GetSubscriptionContractSignature;
 interface GetSubscriptionContractSignature {
     /**
-     * Retrieves a SubscriptionContract.
-     * @param - ID of the SubscriptionContract to retrieve.
-     * @returns The requested SubscriptionContract.
+     * Retrieves a subscription contract.
+     *
+     *
+     * To retrieve the subscription contract an order was created from, specify the order's `lineItems.subscriptionInfo.id` as `subscriptionContractId`. You can retrieve the order with [Get Order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/orders/get-order).
+     *
+     * To retrieve the orders created from a subscription contract, call [Search Orders](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/orders/search-orders) with a filter on `lineItems.subscriptionInfo.id`.
+     * @param - ID of the subscription contract to retrieve.
+     * @returns Retrieved subscription contract.
      */
-    (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`, 4>>;
+    (subscriptionContractId: string): Promise<NonNullablePaths<SubscriptionContract, `subscriptionDescription.original` | `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` | `subscriptionTitle.original` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source`, 4> & {
+        __applicationErrorsType?: GetSubscriptionContractApplicationErrors;
+    }>;
 }
+declare const onSubscriptionContractCommitted$1: EventDefinition<SubscriptionContractCommittedEnvelope, "wix.ecom.subscription_contracts.v1.subscription_contract_committed">;
 declare const onSubscriptionContractCreated$1: EventDefinition<SubscriptionContractCreatedEnvelope, "wix.ecom.subscription_contracts.v1.subscription_contract_created">;
 declare const onSubscriptionContractDeleted$1: EventDefinition<SubscriptionContractDeletedEnvelope, "wix.ecom.subscription_contracts.v1.subscription_contract_deleted">;
 declare const onSubscriptionContractUpdated$1: EventDefinition<SubscriptionContractUpdatedEnvelope, "wix.ecom.subscription_contracts.v1.subscription_contract_updated">;
@@ -21,11 +29,24 @@ declare function customQuerySubscriptionContracts(httpClient: HttpClient): {
 };
 declare const getSubscriptionContract: MaybeContext<BuildRESTFunction<typeof getSubscriptionContract$1> & typeof getSubscriptionContract$1>;
 declare const querySubscriptionContracts: MaybeContext<BuildRESTFunction<typeof customQuerySubscriptionContracts> & typeof customQuerySubscriptionContracts>;
-/** */
+/**
+ * Triggered when changes from a draft subscription contract are committed to a subscription contract.
+ * The event holds the updated contract and every change that was applied.
+ */
+declare const onSubscriptionContractCommitted: BuildEventDefinition<typeof onSubscriptionContractCommitted$1> & typeof onSubscriptionContractCommitted$1;
+/**
+ * Triggered when a subscription contract is created. A subscription contract is created when a buyer checks out with a subscription item.
+ */
 declare const onSubscriptionContractCreated: BuildEventDefinition<typeof onSubscriptionContractCreated$1> & typeof onSubscriptionContractCreated$1;
-/** */
+/**
+ * Triggered when a subscription contract is deleted. A subscription contract is deleted when the buyer's personal data is erased. It isn't deleted when the subscription ends.
+ */
 declare const onSubscriptionContractDeleted: BuildEventDefinition<typeof onSubscriptionContractDeleted$1> & typeof onSubscriptionContractDeleted$1;
-/** */
+/**
+ * Triggered when a subscription contract is updated.
+ * Fires when changes from a draft subscription contract are committed, and when the contract's `priceSummary` is set to the billed totals at the start of the first billing cycle.
+ * 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.
+ */
 declare const onSubscriptionContractUpdated: BuildEventDefinition<typeof onSubscriptionContractUpdated$1> & typeof onSubscriptionContractUpdated$1;
 
-export { SubscriptionContract, SubscriptionContractCreatedEnvelope, SubscriptionContractDeletedEnvelope, SubscriptionContractQuery, SubscriptionContractUpdatedEnvelope, SubscriptionContractsQueryBuilder, getSubscriptionContract, onSubscriptionContractCreated, onSubscriptionContractDeleted, onSubscriptionContractUpdated, querySubscriptionContracts };
+export { GetSubscriptionContractApplicationErrors, SubscriptionContract, SubscriptionContractCommittedEnvelope, SubscriptionContractCreatedEnvelope, SubscriptionContractDeletedEnvelope, SubscriptionContractQuery, SubscriptionContractUpdatedEnvelope, SubscriptionContractsQueryBuilder, getSubscriptionContract, onSubscriptionContractCommitted, onSubscriptionContractCreated, onSubscriptionContractDeleted, onSubscriptionContractUpdated, querySubscriptionContracts };

package/build/cjs/index.js

@@ -27,6 +27,7 @@ __export(index_exports, {
   ChangeType: () => ChangeType,
   ChannelType: () => ChannelType,
   ChargeType: () => ChargeType,
+  ContractChangeType: () => ContractChangeType,
   DescriptionLineType: () => DescriptionLineType,
   DimensionsUnit: () => DimensionsUnit,
   DiscountReason: () => DiscountReason,
@@ -48,6 +49,7 @@ __export(index_exports, {
   WebhookIdentityType: () => WebhookIdentityType,
   WeightUnit: () => WeightUnit,
   getSubscriptionContract: () => getSubscriptionContract4,
+  onSubscriptionContractCommitted: () => onSubscriptionContractCommitted2,
   onSubscriptionContractCreated: () => onSubscriptionContractCreated2,
   onSubscriptionContractDeleted: () => onSubscriptionContractDeleted2,
   onSubscriptionContractUpdated: () => onSubscriptionContractUpdated2,
@@ -476,10 +478,23 @@ var SpecificItemsCouponBehavior = /* @__PURE__ */ ((SpecificItemsCouponBehavior2
   return SpecificItemsCouponBehavior2;
 })(SpecificItemsCouponBehavior || {});
 var LineItemQuantityChangeType = /* @__PURE__ */ ((LineItemQuantityChangeType2) => {
+  LineItemQuantityChangeType2["UNKNOWN_LINE_ITEM_QUANTITY_CHANGE_TYPE"] = "UNKNOWN_LINE_ITEM_QUANTITY_CHANGE_TYPE";
   LineItemQuantityChangeType2["QUANTITY_INCREASED"] = "QUANTITY_INCREASED";
   LineItemQuantityChangeType2["QUANTITY_DECREASED"] = "QUANTITY_DECREASED";
   return LineItemQuantityChangeType2;
 })(LineItemQuantityChangeType || {});
+var ContractChangeType = /* @__PURE__ */ ((ContractChangeType2) => {
+  ContractChangeType2["UNKNOWN_CONTRACT_CHANGE_TYPE"] = "UNKNOWN_CONTRACT_CHANGE_TYPE";
+  ContractChangeType2["LINE_ITEM_CHANGED"] = "LINE_ITEM_CHANGED";
+  ContractChangeType2["LINE_ITEM_ADDED"] = "LINE_ITEM_ADDED";
+  ContractChangeType2["LINE_ITEM_REMOVED"] = "LINE_ITEM_REMOVED";
+  ContractChangeType2["DISCOUNT_ADDED"] = "DISCOUNT_ADDED";
+  ContractChangeType2["DISCOUNT_REMOVED"] = "DISCOUNT_REMOVED";
+  ContractChangeType2["ADDITIONAL_FEE_ADDED"] = "ADDITIONAL_FEE_ADDED";
+  ContractChangeType2["ADDITIONAL_FEE_REMOVED"] = "ADDITIONAL_FEE_REMOVED";
+  ContractChangeType2["TOTAL_PRICE_CHANGED"] = "TOTAL_PRICE_CHANGED";
+  return ContractChangeType2;
+})(ContractChangeType || {});
 var ActivityType = /* @__PURE__ */ ((ActivityType2) => {
   ActivityType2["UNKNOWN_ACTIVITY_TYPE"] = "UNKNOWN_ACTIVITY_TYPE";
   ActivityType2["CHANGES_APPLIED"] = "CHANGES_APPLIED";
@@ -494,6 +509,7 @@ var ActionInitiator = /* @__PURE__ */ ((ActionInitiator2) => {
   return ActionInitiator2;
 })(ActionInitiator || {});
 var ChangeType = /* @__PURE__ */ ((ChangeType2) => {
+  ChangeType2["UNKNOWN_CHANGE_TYPE"] = "UNKNOWN_CHANGE_TYPE";
   ChangeType2["ADDED"] = "ADDED";
   ChangeType2["CHANGED"] = "CHANGED";
   ChangeType2["REMOVED"] = "REMOVED";
@@ -648,6 +664,65 @@ var utils = {
 
 // src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.ts
 var TRANSFORM_PATHS_03 = [
+  { path: "data.commitDate" },
+  { path: "data.subscriptionContract.createdDate" },
+  { path: "data.subscriptionContract.updatedDate" },
+  { path: "data.subscriptionContract.subscriptionSettings.startDate" },
+  { path: "data.subscriptionContract.lineItems.digitalFile.expirationDate" },
+  {
+    path: "data.subscriptionContract.lineItems.subscriptionInfo.subscriptionSettings.startDate"
+  },
+  {
+    path: "data.subscriptionContract.lineItems.serviceProperties.scheduledDate"
+  },
+  { path: "data.subscriptionContract.lineItems.serviceProperties.endDate" },
+  { path: "data.subscriptionContract.shippingInfo.logistics.deliverByDate" },
+  {
+    path: "data.subscriptionContract.shippingInfo.logistics.deliveryTimeSlot.from"
+  },
+  {
+    path: "data.subscriptionContract.shippingInfo.logistics.deliveryTimeSlot.to"
+  },
+  { path: "data.subscriptionContract.activities.createdDate" },
+  {
+    path: "data.changes.lineItems.changed.digitalFileBeforeChange.digitalFile.expirationDate"
+  },
+  { path: "data.changes.lineItems.lineItem.digitalFile.expirationDate" },
+  {
+    path: "data.changes.lineItems.lineItem.subscriptionInfo.subscriptionSettings.startDate"
+  },
+  { path: "data.changes.lineItems.lineItem.serviceProperties.scheduledDate" },
+  { path: "data.changes.lineItems.lineItem.serviceProperties.endDate" },
+  { path: "data.changes.shippingInfo.logistics.deliverByDate" },
+  { path: "data.changes.shippingInfo.logistics.deliveryTimeSlot.from" },
+  { path: "data.changes.shippingInfo.logistics.deliveryTimeSlot.to" },
+  { path: "metadata.eventTime" }
+];
+var TRANSFORM_PATHS_13 = [
+  { path: "data.subscriptionContract.lineItems.image" },
+  { path: "data.changes.lineItems.changed.imageBeforeChange.image" },
+  { path: "data.changes.lineItems.lineItem.image" }
+];
+var TRANSFORM_PATHS_23 = [
+  { path: "data.subscriptionContract.lineItems.physicalProperties.weight" },
+  {
+    path: "data.changes.lineItems.changed.physicalPropertiesBeforeChange.physicalProperties.weight"
+  },
+  { path: "data.changes.lineItems.lineItem.physicalProperties.weight" }
+];
+var TRANSFORM_PATHS_33 = [
+  { path: "data.subscriptionContract.billingInfo.address" },
+  {
+    path: "data.subscriptionContract.shippingInfo.logistics.shippingDestination.address"
+  },
+  {
+    path: "data.subscriptionContract.shippingInfo.logistics.pickupDetails.address"
+  },
+  { path: "data.subscriptionContract.recipientInfo.address" },
+  { path: "data.changes.shippingInfo.logistics.shippingDestination.address" },
+  { path: "data.changes.shippingInfo.logistics.pickupDetails.address" }
+];
+var TRANSFORM_PATHS_4 = [
   { path: "entity.createdDate" },
   { path: "entity.updatedDate" },
   { path: "entity.subscriptionSettings.startDate" },
@@ -661,17 +736,17 @@ var TRANSFORM_PATHS_03 = [
   { path: "entity.activities.createdDate" },
   { path: "metadata.eventTime" }
 ];
-var TRANSFORM_PATHS_13 = [{ path: "entity.lineItems.image" }];
-var TRANSFORM_PATHS_23 = [
+var TRANSFORM_PATHS_5 = [{ path: "entity.lineItems.image" }];
+var TRANSFORM_PATHS_6 = [
   { path: "entity.lineItems.physicalProperties.weight" }
 ];
-var TRANSFORM_PATHS_33 = [
+var TRANSFORM_PATHS_7 = [
   { path: "entity.billingInfo.address" },
   { path: "entity.shippingInfo.logistics.shippingDestination.address" },
   { path: "entity.shippingInfo.logistics.pickupDetails.address" },
   { path: "entity.recipientInfo.address" }
 ];
-var TRANSFORM_PATHS_4 = [
+var TRANSFORM_PATHS_8 = [
   { path: "undefined.createdDate" },
   { path: "undefined.updatedDate" },
   { path: "undefined.subscriptionSettings.startDate" },
@@ -687,17 +762,17 @@ var TRANSFORM_PATHS_4 = [
   { path: "undefined.activities.createdDate" },
   { path: "metadata.eventTime" }
 ];
-var TRANSFORM_PATHS_5 = [{ path: "undefined.lineItems.image" }];
-var TRANSFORM_PATHS_6 = [
+var TRANSFORM_PATHS_9 = [{ path: "undefined.lineItems.image" }];
+var TRANSFORM_PATHS_10 = [
   { path: "undefined.lineItems.physicalProperties.weight" }
 ];
-var TRANSFORM_PATHS_7 = [
+var TRANSFORM_PATHS_11 = [
   { path: "undefined.billingInfo.address" },
   { path: "undefined.shippingInfo.logistics.shippingDestination.address" },
   { path: "undefined.shippingInfo.logistics.pickupDetails.address" },
   { path: "undefined.recipientInfo.address" }
 ];
-var TRANSFORM_PATHS_8 = [
+var TRANSFORM_PATHS_122 = [
   { path: "entity.createdDate" },
   { path: "entity.updatedDate" },
   { path: "entity.subscriptionSettings.startDate" },
@@ -724,15 +799,15 @@ var TRANSFORM_PATHS_8 = [
   { path: "modifiedFields.shippingInfo.logistics.deliveryTimeSlot.to" },
   { path: "modifiedFields.activities.createdDate" }
 ];
-var TRANSFORM_PATHS_9 = [
+var TRANSFORM_PATHS_132 = [
   { path: "entity.lineItems.image" },
   { path: "modifiedFields.lineItems.image" }
 ];
-var TRANSFORM_PATHS_10 = [
+var TRANSFORM_PATHS_14 = [
   { path: "entity.lineItems.physicalProperties.weight" },
   { path: "modifiedFields.lineItems.physicalProperties.weight" }
 ];
-var TRANSFORM_PATHS_11 = [
+var TRANSFORM_PATHS_15 = [
   { path: "entity.billingInfo.address" },
   { path: "entity.shippingInfo.logistics.shippingDestination.address" },
   { path: "entity.shippingInfo.logistics.pickupDetails.address" },
@@ -762,8 +837,8 @@ function typedQuerySubscriptionContracts2(httpClient) {
     { httpClient }
   );
 }
-var onSubscriptionContractCreated = /* @__PURE__ */ (0, import_sdk_types.EventDefinition)(
-  "wix.ecom.subscription_contracts.v1.subscription_contract_created",
+var onSubscriptionContractCommitted = /* @__PURE__ */ (0, import_sdk_types.EventDefinition)(
+  "wix.ecom.subscription_contracts.v1.subscription_contract_committed",
   true,
   (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
     (0, import_transform_paths3.transformPaths)(event, [
@@ -786,8 +861,8 @@ var onSubscriptionContractCreated = /* @__PURE__ */ (0, import_sdk_types.EventDe
     ])
   )
 )();
-var onSubscriptionContractDeleted = /* @__PURE__ */ (0, import_sdk_types.EventDefinition)(
-  "wix.ecom.subscription_contracts.v1.subscription_contract_deleted",
+var onSubscriptionContractCreated = /* @__PURE__ */ (0, import_sdk_types.EventDefinition)(
+  "wix.ecom.subscription_contracts.v1.subscription_contract_created",
   true,
   (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
     (0, import_transform_paths3.transformPaths)(event, [
@@ -810,8 +885,8 @@ var onSubscriptionContractDeleted = /* @__PURE__ */ (0, import_sdk_types.EventDe
     ])
   )
 )();
-var onSubscriptionContractUpdated = /* @__PURE__ */ (0, import_sdk_types.EventDefinition)(
-  "wix.ecom.subscription_contracts.v1.subscription_contract_updated",
+var onSubscriptionContractDeleted = /* @__PURE__ */ (0, import_sdk_types.EventDefinition)(
+  "wix.ecom.subscription_contracts.v1.subscription_contract_deleted",
   true,
   (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
     (0, import_transform_paths3.transformPaths)(event, [
@@ -834,6 +909,30 @@ var onSubscriptionContractUpdated = /* @__PURE__ */ (0, import_sdk_types.EventDe
     ])
   )
 )();
+var onSubscriptionContractUpdated = /* @__PURE__ */ (0, import_sdk_types.EventDefinition)(
+  "wix.ecom.subscription_contracts.v1.subscription_contract_updated",
+  true,
+  (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
+    (0, import_transform_paths3.transformPaths)(event, [
+      {
+        transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
+        paths: TRANSFORM_PATHS_122
+      },
+      {
+        transformFn: import_image2.transformRESTImageToSDKImage,
+        paths: TRANSFORM_PATHS_132
+      },
+      {
+        transformFn: import_float2.transformRESTFloatToSDKFloat,
+        paths: TRANSFORM_PATHS_14
+      },
+      {
+        transformFn: import_address2.transformRESTAddressToSDKAddress,
+        paths: TRANSFORM_PATHS_15
+      }
+    ])
+  )
+)();
 
 // src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.ts
 var import_rest_modules3 = require("@wix/sdk-runtime/rest-modules");
@@ -852,6 +951,7 @@ function customQuerySubscriptionContracts(httpClient) {
 }
 var getSubscriptionContract4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getSubscriptionContract3);
 var querySubscriptionContracts4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(customQuerySubscriptionContracts);
+var onSubscriptionContractCommitted2 = /* @__PURE__ */ (0, import_event_definition_modules.createEventModule)(onSubscriptionContractCommitted);
 var onSubscriptionContractCreated2 = /* @__PURE__ */ (0, import_event_definition_modules.createEventModule)(
   onSubscriptionContractCreated
 );
@@ -870,6 +970,7 @@ var onSubscriptionContractUpdated2 = /* @__PURE__ */ (0, import_event_definition
   ChangeType,
   ChannelType,
   ChargeType,
+  ContractChangeType,
   DescriptionLineType,
   DimensionsUnit,
   DiscountReason,
@@ -891,6 +992,7 @@ var onSubscriptionContractUpdated2 = /* @__PURE__ */ (0, import_event_definition
   WebhookIdentityType,
   WeightUnit,
   getSubscriptionContract,
+  onSubscriptionContractCommitted,
   onSubscriptionContractCreated,
   onSubscriptionContractDeleted,
   onSubscriptionContractUpdated,