@wix/auto_sdk_ecom_subscription-contracts 1.0.134 → 1.0.136

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -238,7 +238,7 @@ interface OrderLineItem {
238
238
  itemType?: ItemType;
239
239
  /**
240
240
  * Fulfiller ID. Field is empty when the line item is self-fulfilled.
241
- * To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
241
+ * To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-fulfillments/list-fulfillments-for-single-order).
242
242
  * @format GUID
243
243
  */
244
244
  fulfillerId?: string | null;
@@ -335,7 +335,7 @@ interface OrderLineItem {
335
335
  /**
336
336
  * Custom extended fields for the line item object.
337
337
  *
338
- * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
338
+ * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
339
339
  */
340
340
  extendedFields?: ExtendedFields;
341
341
  /**
@@ -2152,6 +2152,108 @@ interface LineItemDelta extends LineItemDeltaDeltaDetailsOneOf {
2152
2152
  interface LineItemDeltaDeltaDetailsOneOf {
2153
2153
  changed?: ItemChangedDetails;
2154
2154
  }
2155
+ /** the catalog reference options before the change. */
2156
+ interface CatalogReferenceOptionsBeforeChange {
2157
+ /** the catalog reference options. Absent when the line item had no options. */
2158
+ options?: Record<string, any> | null;
2159
+ }
2160
+ /** the product name before the change. */
2161
+ interface ProductNameBeforeChange {
2162
+ /** the product name. Absent when the line item had no product name. */
2163
+ productName?: ProductName;
2164
+ }
2165
+ /** the description lines before the change. */
2166
+ interface DescriptionLinesBeforeChange {
2167
+ /**
2168
+ * the description lines. Empty when the line item had no description lines.
2169
+ * @maxSize 20
2170
+ */
2171
+ descriptionLines?: DescriptionLine[];
2172
+ }
2173
+ /** the image before the change. */
2174
+ interface ImageBeforeChange {
2175
+ /** the image. Absent when the line item had no image. */
2176
+ image?: string;
2177
+ }
2178
+ /** the physical properties before the change. */
2179
+ interface PhysicalPropertiesBeforeChange {
2180
+ /** the physical properties. Absent when the line item had no physical properties. */
2181
+ physicalProperties?: PhysicalProperties;
2182
+ }
2183
+ /** the item type before the change. */
2184
+ interface ItemTypeBeforeChange {
2185
+ /** the item type. Absent when the line item had no item type. */
2186
+ itemType?: ItemType;
2187
+ }
2188
+ /** the fulfiller ID before the change. */
2189
+ interface FulfillerIdBeforeChange {
2190
+ /**
2191
+ * the fulfiller ID. Absent when the line item had no fulfiller.
2192
+ * @format GUID
2193
+ */
2194
+ fulfillerId?: string | null;
2195
+ }
2196
+ /** the digital file before the change. */
2197
+ interface DigitalFileBeforeChange {
2198
+ /** the digital file. Absent when the line item had no digital file. */
2199
+ digitalFile?: DigitalFile;
2200
+ }
2201
+ /** the price description before the change. */
2202
+ interface PriceDescriptionBeforeChange {
2203
+ /** the price description. Absent when the line item had no price description. */
2204
+ priceDescription?: PriceDescription;
2205
+ }
2206
+ /** the delivery profile ID before the change. */
2207
+ interface DeliveryProfileIdBeforeChange {
2208
+ /**
2209
+ * the delivery profile ID. Absent when the line item had no delivery profile.
2210
+ * @format GUID
2211
+ */
2212
+ deliveryProfileId?: string | null;
2213
+ }
2214
+ /** the shipping group ID before the change. */
2215
+ interface ShippingGroupIdBeforeChange {
2216
+ /**
2217
+ * the shipping group ID. Absent when the line item had no shipping group.
2218
+ * @format GUID
2219
+ */
2220
+ shippingGroupId?: string | null;
2221
+ }
2222
+ /** the tax info before the change. */
2223
+ interface TaxInfoBeforeChange {
2224
+ /** the tax info. Absent when the line item had no tax info. */
2225
+ taxInfo?: LineItemTaxInfo;
2226
+ }
2227
+ /** the inventory app ID before the change. */
2228
+ interface InventoryAppIdBeforeChange {
2229
+ /**
2230
+ * the inventory app ID. Absent when the line item had no inventory app.
2231
+ * @format GUID
2232
+ */
2233
+ inventoryAppId?: string | null;
2234
+ }
2235
+ /** the root catalog item ID before the change. */
2236
+ interface RootCatalogItemIdBeforeChange {
2237
+ /**
2238
+ * the root catalog item ID. Absent when the line item had no root catalog item.
2239
+ * @minLength 1
2240
+ * @maxLength 36
2241
+ */
2242
+ rootCatalogItemId?: string | null;
2243
+ }
2244
+ /** the modifier groups before the change. */
2245
+ interface ModifierGroupsBeforeChange {
2246
+ /**
2247
+ * the modifier groups. Empty when the line item had no modifier groups.
2248
+ * @maxSize 10
2249
+ */
2250
+ modifierGroups?: ModifierGroup[];
2251
+ }
2252
+ /** the price undetermined flag before the change. */
2253
+ interface PriceUndeterminedBeforeChange {
2254
+ /** whether the price of the line item was undetermined. */
2255
+ priceUndetermined?: boolean;
2256
+ }
2155
2257
  /** Describes the type of change applied to an element. */
2156
2258
  declare enum ChangeType {
2157
2259
  /** Element was added (absent in the original contract). */
@@ -2172,11 +2274,32 @@ interface ItemChangedDetails {
2172
2274
  quantityBeforeChange?: number | null;
2173
2275
  /** The price before the change. */
2174
2276
  priceBeforeChange?: Price;
2175
- /**
2176
- * The modifier groups before the change. Set when a price change cleared the modifier prices.
2177
- * @maxSize 10
2178
- */
2179
- modifierGroupsBeforeChange?: ModifierGroup[];
2277
+ /** the catalog reference options before the change. Set only when the catalog reference options changed. */
2278
+ catalogReferenceOptionsBeforeChange?: CatalogReferenceOptionsBeforeChange;
2279
+ /** the product name before the change. Set only when the product name changed. */
2280
+ productNameBeforeChange?: ProductNameBeforeChange;
2281
+ /** the description lines before the change. Set only when the description lines changed. */
2282
+ descriptionLinesBeforeChange?: DescriptionLinesBeforeChange;
2283
+ /** the image before the change. Set only when the image changed. */
2284
+ imageBeforeChange?: ImageBeforeChange;
2285
+ /** the physical properties before the change. Set only when the physical properties changed. */
2286
+ physicalPropertiesBeforeChange?: PhysicalPropertiesBeforeChange;
2287
+ /** the item type before the change. Set only when the item type changed. */
2288
+ itemTypeBeforeChange?: ItemTypeBeforeChange;
2289
+ /** the fulfiller ID before the change. Set only when the fulfiller ID changed. */
2290
+ fulfillerIdBeforeChange?: FulfillerIdBeforeChange;
2291
+ /** the digital file before the change. Set only when the digital file changed. */
2292
+ digitalFileBeforeChange?: DigitalFileBeforeChange;
2293
+ /** the price description before the change. Set only when the price description changed. */
2294
+ priceDescriptionBeforeChange?: PriceDescriptionBeforeChange;
2295
+ /** the tax info before the change. Set only when the tax group changed. */
2296
+ taxInfoBeforeChange?: TaxInfoBeforeChange;
2297
+ /** the inventory app ID before the change. Set only when the inventory app ID changed. */
2298
+ inventoryAppIdBeforeChange?: InventoryAppIdBeforeChange;
2299
+ /** the modifier groups before the change. Set only when the modifier groups changed. */
2300
+ modifierGroupsBeforeChange?: ModifierGroupsBeforeChange;
2301
+ /** the price undetermined flag before the change. Set only when the price undetermined flag changed. */
2302
+ priceUndeterminedBeforeChange?: PriceUndeterminedBeforeChange;
2180
2303
  }
2181
2304
  interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaDetailsOneOf {
2182
2305
  /** Discount content after the change. */
@@ -2886,4 +3009,4 @@ declare const utils: {
2886
3009
  query: _wix_sdk_types.QueryHelpers<SubscriptionContract, SubscriptionContractQuerySpec, SubscriptionContractQuery>;
2887
3010
  };
2888
3011
 
2889
- 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 ItemChangedDetails, 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 LineItemDeltaDeltaDetailsOneOf, 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 };
3012
+ 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, 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 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 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, 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 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 LineItemDelta, type LineItemDeltaDeltaDetailsOneOf, 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 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, 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 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 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 };