@wix/auto_sdk_ecom_subscription-contracts 1.0.112 → 1.0.114

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.
Files changed (49) hide show
  1. package/build/cjs/index.d.ts +2 -2
  2. package/build/cjs/index.js +32 -3
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +371 -5
  5. package/build/cjs/index.typings.js +27 -2
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +370 -4
  8. package/build/cjs/meta.js +26 -2
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/schemas.d.ts +394 -0
  11. package/build/cjs/schemas.js +682 -8
  12. package/build/cjs/schemas.js.map +1 -1
  13. package/build/es/index.d.mts +2 -2
  14. package/build/es/index.mjs +29 -3
  15. package/build/es/index.mjs.map +1 -1
  16. package/build/es/index.typings.d.mts +371 -5
  17. package/build/es/index.typings.mjs +24 -2
  18. package/build/es/index.typings.mjs.map +1 -1
  19. package/build/es/meta.d.mts +370 -4
  20. package/build/es/meta.mjs +23 -2
  21. package/build/es/meta.mjs.map +1 -1
  22. package/build/es/schemas.d.mts +394 -0
  23. package/build/es/schemas.mjs +682 -8
  24. package/build/es/schemas.mjs.map +1 -1
  25. package/build/internal/cjs/index.d.ts +2 -2
  26. package/build/internal/cjs/index.js +32 -3
  27. package/build/internal/cjs/index.js.map +1 -1
  28. package/build/internal/cjs/index.typings.d.ts +378 -6
  29. package/build/internal/cjs/index.typings.js +27 -2
  30. package/build/internal/cjs/index.typings.js.map +1 -1
  31. package/build/internal/cjs/meta.d.ts +370 -4
  32. package/build/internal/cjs/meta.js +26 -2
  33. package/build/internal/cjs/meta.js.map +1 -1
  34. package/build/internal/cjs/schemas.d.ts +394 -0
  35. package/build/internal/cjs/schemas.js +682 -8
  36. package/build/internal/cjs/schemas.js.map +1 -1
  37. package/build/internal/es/index.d.mts +2 -2
  38. package/build/internal/es/index.mjs +29 -3
  39. package/build/internal/es/index.mjs.map +1 -1
  40. package/build/internal/es/index.typings.d.mts +378 -6
  41. package/build/internal/es/index.typings.mjs +24 -2
  42. package/build/internal/es/index.typings.mjs.map +1 -1
  43. package/build/internal/es/meta.d.mts +370 -4
  44. package/build/internal/es/meta.mjs +23 -2
  45. package/build/internal/es/meta.mjs.map +1 -1
  46. package/build/internal/es/schemas.d.mts +394 -0
  47. package/build/internal/es/schemas.mjs +682 -8
  48. package/build/internal/es/schemas.mjs.map +1 -1
  49. package/package.json +2 -2
@@ -56,6 +56,7 @@ interface SubscriptionContract {
56
56
  /**
57
57
  * Language for communication with the buyer. Defaults to the site language.
58
58
  * For a site that supports multiple languages, this is the language the buyer selected.
59
+ * @maxLength 10
59
60
  */
60
61
  buyerLanguage?: string | null;
61
62
  /** Weight measurement unit - defaults to site's weight unit. */
@@ -86,11 +87,17 @@ interface SubscriptionContract {
86
87
  billingInfo?: AddressWithContact;
87
88
  /** Shipping info and selected shipping option details. */
88
89
  shippingInfo?: ShippingInformation;
89
- /** Applied discounts. */
90
+ /**
91
+ * Applied discounts.
92
+ * @maxSize 100
93
+ */
90
94
  appliedDiscounts?: AppliedDiscount[];
91
95
  /** Information about the sales channel that submitted this order. */
92
96
  channelInfo?: ChannelInfo;
93
- /** Custom fields. */
97
+ /**
98
+ * Custom fields.
99
+ * @maxSize 100
100
+ */
94
101
  customFields?: CustomField[];
95
102
  /**
96
103
  * Order recipient address and contact details.
@@ -119,6 +126,12 @@ interface SubscriptionContract {
119
126
  * @maxSize 100
120
127
  */
121
128
  additionalFees?: AdditionalFee[];
129
+ /**
130
+ * Activities recorded on this contract (e.g. draft commits, status changes).
131
+ * @readonly
132
+ * @maxSize 500
133
+ */
134
+ activities?: SubscriptionContractActivity[];
122
135
  }
123
136
  interface V1SubscriptionDescription {
124
137
  /**
@@ -1724,13 +1737,239 @@ declare enum SpecificItemsCouponBehavior {
1724
1737
  }
1725
1738
  /** @enumType */
1726
1739
  type SpecificItemsCouponBehaviorWithLiterals = SpecificItemsCouponBehavior | 'UNDEFINED_COUPON_BEHAVIOR' | 'ITEM_SUBTOTAL_INCLUDES_DISCOUNT' | 'LEGACY_ITEM_SUBTOTAL_DOES_NOT_INCLUDE_DISCOUNT';
1740
+ interface SubscriptionContractActivity extends SubscriptionContractActivityTargetOneOf, SubscriptionContractActivityContentOneOf {
1741
+ /** Scopes the draft to the contract level, applying to all future cycles. */
1742
+ contractTarget?: ContractTarget;
1743
+ /** Changes committed from a DraftSubscriptionContract. */
1744
+ changesApplied?: ChangesAppliedActivity;
1745
+ /**
1746
+ * Activity ID.
1747
+ * @format GUID
1748
+ * @readonly
1749
+ */
1750
+ _id?: string;
1751
+ /**
1752
+ * When the activity occurred.
1753
+ * @readonly
1754
+ */
1755
+ _createdDate?: Date | null;
1756
+ /**
1757
+ * Identity of the draft order's initiator.
1758
+ * @readonly
1759
+ */
1760
+ author?: ActivityAuthor;
1761
+ /** Activity type. */
1762
+ activityType?: ActivityTypeWithLiterals;
1763
+ }
1764
+ /** @oneof */
1765
+ interface SubscriptionContractActivityTargetOneOf {
1766
+ /** Scopes the draft to the contract level, applying to all future cycles. */
1767
+ contractTarget?: ContractTarget;
1768
+ }
1769
+ /** @oneof */
1770
+ interface SubscriptionContractActivityContentOneOf {
1771
+ /** Changes committed from a DraftSubscriptionContract. */
1772
+ changesApplied?: ChangesAppliedActivity;
1773
+ }
1774
+ /** Scopes the draft to the contract level, applying to all future cycles. */
1775
+ interface ContractTarget {
1776
+ /** Cycle number of the next billing cycle (1-based). Set by the caller; returned by the server on read. */
1777
+ nextCycleNumber?: number | null;
1778
+ }
1779
+ interface ActivityAuthor extends ActivityAuthorValueOneOf {
1780
+ /**
1781
+ * User ID. When the draft order was created by a Wix user.
1782
+ * @format GUID
1783
+ */
1784
+ userId?: string;
1785
+ /**
1786
+ * App ID. When the draft order was created by an app.
1787
+ * @format GUID
1788
+ */
1789
+ appId?: string;
1790
+ }
1791
+ /** @oneof */
1792
+ interface ActivityAuthorValueOneOf {
1793
+ /**
1794
+ * User ID. When the draft order was created by a Wix user.
1795
+ * @format GUID
1796
+ */
1797
+ userId?: string;
1798
+ /**
1799
+ * App ID. When the draft order was created by an app.
1800
+ * @format GUID
1801
+ */
1802
+ appId?: string;
1803
+ }
1804
+ interface ChangesAppliedActivity extends ChangesAppliedActivityTargetOneOf {
1805
+ /** Scopes the draft to the contract level, applying to all future cycles. */
1806
+ contractTarget?: ContractTarget;
1807
+ /**
1808
+ * ID of the DraftSubscriptionContract that was committed.
1809
+ * @format GUID
1810
+ */
1811
+ draftSubscriptionContractId?: string;
1812
+ /**
1813
+ * Individual typed changes applied.
1814
+ * @maxSize 100
1815
+ */
1816
+ changes?: ContractChange[];
1817
+ /**
1818
+ * Reason for the edit, provided by the merchant (optional).
1819
+ * @maxLength 200
1820
+ */
1821
+ reason?: string | null;
1822
+ }
1823
+ /** @oneof */
1824
+ interface ChangesAppliedActivityTargetOneOf {
1825
+ /** Scopes the draft to the contract level, applying to all future cycles. */
1826
+ contractTarget?: ContractTarget;
1827
+ }
1828
+ interface ContractChange extends ContractChangeValueOneOf {
1829
+ /** Line item was modified. */
1830
+ lineItemChanged?: LineItemChanges;
1831
+ /** Line item was added to the contract. */
1832
+ lineItemAdded?: ManagedLineItem;
1833
+ /** Line item was removed from the contract. */
1834
+ lineItemRemoved?: ManagedLineItem;
1835
+ /** Discount was added to the contract. */
1836
+ discountAdded?: ManagedDiscount;
1837
+ /** Discount was removed from the contract. */
1838
+ discountRemoved?: ManagedDiscount;
1839
+ /** Additional fee was added to the contract. */
1840
+ additionalFeeAdded?: ManagedAdditionalFee;
1841
+ /** Additional fee was removed from the contract. */
1842
+ additionalFeeRemoved?: ManagedAdditionalFee;
1843
+ /** Total price changed. */
1844
+ totalPriceChanged?: TotalPriceChange;
1845
+ }
1846
+ /** @oneof */
1847
+ interface ContractChangeValueOneOf {
1848
+ /** Line item was modified. */
1849
+ lineItemChanged?: LineItemChanges;
1850
+ /** Line item was added to the contract. */
1851
+ lineItemAdded?: ManagedLineItem;
1852
+ /** Line item was removed from the contract. */
1853
+ lineItemRemoved?: ManagedLineItem;
1854
+ /** Discount was added to the contract. */
1855
+ discountAdded?: ManagedDiscount;
1856
+ /** Discount was removed from the contract. */
1857
+ discountRemoved?: ManagedDiscount;
1858
+ /** Additional fee was added to the contract. */
1859
+ additionalFeeAdded?: ManagedAdditionalFee;
1860
+ /** Additional fee was removed from the contract. */
1861
+ additionalFeeRemoved?: ManagedAdditionalFee;
1862
+ /** Total price changed. */
1863
+ totalPriceChanged?: TotalPriceChange;
1864
+ }
1865
+ interface LineItemChanges {
1866
+ /**
1867
+ * Line item ID.
1868
+ * @format GUID
1869
+ */
1870
+ _id?: string;
1871
+ /** Item name after change. */
1872
+ name?: ProductName;
1873
+ /** Item quantity change. */
1874
+ quantity?: LineItemQuantityChange;
1875
+ }
1876
+ declare enum LineItemQuantityChangeType {
1877
+ QUANTITY_INCREASED = "QUANTITY_INCREASED",
1878
+ QUANTITY_DECREASED = "QUANTITY_DECREASED"
1879
+ }
1880
+ /** @enumType */
1881
+ type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
1882
+ interface LineItemQuantityChange {
1883
+ /**
1884
+ * Original item quantity before the change.
1885
+ * @max 1000000
1886
+ */
1887
+ originalQuantity?: number;
1888
+ /**
1889
+ * New item quantity after the change.
1890
+ * @max 1000000
1891
+ */
1892
+ newQuantity?: number;
1893
+ /**
1894
+ * Difference between new and original quantities.
1895
+ * @min 1
1896
+ * @max 1000000
1897
+ */
1898
+ diff?: number;
1899
+ /** Direction of the quantity change. */
1900
+ deltaType?: LineItemQuantityChangeTypeWithLiterals;
1901
+ }
1902
+ interface ManagedLineItem {
1903
+ /**
1904
+ * Line item ID.
1905
+ * @format GUID
1906
+ */
1907
+ _id?: string;
1908
+ /** Item name. */
1909
+ name?: ProductName;
1910
+ /**
1911
+ * Added or removed item quantity.
1912
+ * @min 1
1913
+ * @max 1000000
1914
+ */
1915
+ quantity?: number;
1916
+ }
1917
+ interface ManagedDiscount {
1918
+ /**
1919
+ * Discount ID.
1920
+ * @format GUID
1921
+ */
1922
+ _id?: string;
1923
+ /** Discount name. */
1924
+ name?: TranslatedValue;
1925
+ /** Discount amount. */
1926
+ totalAmount?: Price;
1927
+ }
1928
+ interface TranslatedValue {
1929
+ /**
1930
+ * Value in site default language.
1931
+ * @minLength 1
1932
+ */
1933
+ original?: string;
1934
+ /**
1935
+ * Translated value.
1936
+ * @minLength 1
1937
+ */
1938
+ translated?: string | null;
1939
+ }
1940
+ interface ManagedAdditionalFee {
1941
+ /**
1942
+ * Additional fee ID.
1943
+ * @format GUID
1944
+ */
1945
+ _id?: string;
1946
+ /** Additional fee name. */
1947
+ name?: TranslatedValue;
1948
+ /** Additional fee amount. */
1949
+ totalAmount?: Price;
1950
+ }
1951
+ interface TotalPriceChange {
1952
+ /** Total price before the commit. */
1953
+ originalTotal?: Price;
1954
+ /** Total price after the commit. */
1955
+ newTotal?: Price;
1956
+ }
1957
+ declare enum ActivityType {
1958
+ UNKNOWN_ACTIVITY_TYPE = "UNKNOWN_ACTIVITY_TYPE",
1959
+ CHANGES_APPLIED = "CHANGES_APPLIED"
1960
+ }
1961
+ /** @enumType */
1962
+ type ActivityTypeWithLiterals = ActivityType | 'UNKNOWN_ACTIVITY_TYPE' | 'CHANGES_APPLIED';
1727
1963
  /** Triggered when a subscription contract has been canceled before its designated end date. */
1728
1964
  interface SubscriptionContractCanceled {
1729
1965
  /** The subscription contract that was canceled. */
1730
1966
  subscriptionContract?: SubscriptionContract;
1731
1967
  /** Who initiated the cancellation. */
1732
1968
  initiator?: ActionInitiatorWithLiterals;
1733
- /** Reason for cancellation. */
1969
+ /**
1970
+ * Reason for cancellation.
1971
+ * @maxLength 500
1972
+ */
1734
1973
  reason?: string | null;
1735
1974
  }
1736
1975
  declare enum ActionInitiator {
@@ -1747,6 +1986,102 @@ interface SubscriptionContractExpired {
1747
1986
  /** The subscription contract that expired. */
1748
1987
  subscriptionContract?: SubscriptionContract;
1749
1988
  }
1989
+ /**
1990
+ * ACTION event payload emitted after a successful commit.
1991
+ * Carries the full delta — downstream consumers (email notifications, activity feed)
1992
+ * subscribe to this event and have all details inline without fetching the draft.
1993
+ */
1994
+ interface SubscriptionContractChangesCommitted {
1995
+ /** Updated SubscriptionContract after commit. */
1996
+ subscriptionContract?: SubscriptionContract;
1997
+ /**
1998
+ * ID of the DraftSubscriptionContract that triggered this commit.
1999
+ * @format GUID
2000
+ */
2001
+ draftSubscriptionContractId?: string;
2002
+ /** The actual delta applied. */
2003
+ changes?: SubscriptionContractDiffs;
2004
+ /**
2005
+ * Date and time the changes were committed.
2006
+ * @readonly
2007
+ */
2008
+ commitDate?: Date | null;
2009
+ }
2010
+ interface SubscriptionContractDiffs {
2011
+ /**
2012
+ * Per-item deltas: added, changed, or removed line items.
2013
+ * @maxSize 100
2014
+ */
2015
+ lineItems?: LineItemDelta[];
2016
+ /**
2017
+ * Per-discount deltas.
2018
+ * @maxSize 100
2019
+ */
2020
+ appliedDiscounts?: AppliedDiscountDelta[];
2021
+ /**
2022
+ * Per-fee deltas.
2023
+ * @maxSize 100
2024
+ */
2025
+ additionalFees?: AdditionalFeeDelta[];
2026
+ /** Updated price summary (overwrites existing). */
2027
+ priceSummary?: PriceSummary;
2028
+ /** Updated tax info (overwrites existing). */
2029
+ taxInfo?: OrderTaxInfo;
2030
+ }
2031
+ interface LineItemDelta {
2032
+ /**
2033
+ * Line item ID.
2034
+ * @format GUID
2035
+ */
2036
+ lineItemId?: string;
2037
+ /** Full line item content (absent for removed items). */
2038
+ lineItem?: OrderLineItem;
2039
+ /** Type of change applied to this line item. */
2040
+ changeType?: ChangeTypeWithLiterals;
2041
+ }
2042
+ /** Describes the type of change applied to an element. */
2043
+ declare enum ChangeType {
2044
+ /** Element was added (absent in the original contract). */
2045
+ ADDED = "ADDED",
2046
+ /** Element was modified from the original contract. */
2047
+ CHANGED = "CHANGED",
2048
+ /** Element was removed from the contract. */
2049
+ REMOVED = "REMOVED"
2050
+ }
2051
+ /** @enumType */
2052
+ type ChangeTypeWithLiterals = ChangeType | 'ADDED' | 'CHANGED' | 'REMOVED';
2053
+ interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaDetailsOneOf {
2054
+ /** Discount content after the change. */
2055
+ changed?: AppliedDiscount;
2056
+ /**
2057
+ * Discount ID.
2058
+ * @format GUID
2059
+ */
2060
+ discountId?: string;
2061
+ /** Type of change applied to this discount. */
2062
+ changeType?: ChangeTypeWithLiterals;
2063
+ }
2064
+ /** @oneof */
2065
+ interface AppliedDiscountDeltaDeltaDetailsOneOf {
2066
+ /** Discount content after the change. */
2067
+ changed?: AppliedDiscount;
2068
+ }
2069
+ interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaDetailsOneOf {
2070
+ /** Additional fee content after the change. */
2071
+ changed?: AdditionalFee;
2072
+ /**
2073
+ * Additional fee ID.
2074
+ * @format GUID
2075
+ */
2076
+ additionalFeeId?: string;
2077
+ /** Type of change applied to this additional fee. */
2078
+ changeType?: ChangeTypeWithLiterals;
2079
+ }
2080
+ /** @oneof */
2081
+ interface AdditionalFeeDeltaDeltaDetailsOneOf {
2082
+ /** Additional fee content after the change. */
2083
+ changed?: AdditionalFee;
2084
+ }
1750
2085
  interface CreateSubscriptionContractRequest {
1751
2086
  /** SubscriptionContract to be created. */
1752
2087
  subscriptionContract?: SubscriptionContract;
@@ -2020,6 +2355,37 @@ interface BulkUpdateSubscriptionContractsResponse {
2020
2355
  /** Metadata about the bulk operation. */
2021
2356
  bulkActionMetadata?: BulkActionMetadata;
2022
2357
  }
2358
+ interface CommitSubscriptionContractChangesRequest {
2359
+ /**
2360
+ * ID of the SubscriptionContract to update.
2361
+ * @format GUID
2362
+ */
2363
+ subscriptionContractId?: string;
2364
+ /**
2365
+ * ID of the originating DraftSubscriptionContract (for traceability).
2366
+ * @format GUID
2367
+ */
2368
+ draftSubscriptionContractId?: string;
2369
+ /** Delta changes to apply. */
2370
+ changes?: SubscriptionContractDiffs;
2371
+ /**
2372
+ * Reason for the edit, provided by the merchant (optional).
2373
+ * @maxLength 200
2374
+ */
2375
+ reason?: string | null;
2376
+ /** Side-effects to happen after contract is updated */
2377
+ settings?: SubscriptionCommitSettings;
2378
+ }
2379
+ interface SubscriptionCommitSettings {
2380
+ /** If false, do not send notifications to buyer. Default is true. */
2381
+ sendNotificationsToBuyer?: boolean | null;
2382
+ /** If false, do not send notifications to business. Default is true. */
2383
+ sendNotificationsToBusiness?: boolean | null;
2384
+ }
2385
+ interface CommitSubscriptionContractChangesResponse {
2386
+ /** Updated SubscriptionContract. */
2387
+ subscriptionContract?: SubscriptionContract;
2388
+ }
2023
2389
  interface MessageEnvelope {
2024
2390
  /**
2025
2391
  * App instance ID.
@@ -2235,7 +2601,7 @@ declare function onSubscriptionContractUpdated(handler: (event: SubscriptionCont
2235
2601
  * @returns The requested SubscriptionContract.
2236
2602
  * @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.GetSubscriptionContract
2237
2603
  */
2238
- declare function getSubscriptionContract(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` | `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`, 6>>;
2604
+ declare function getSubscriptionContract(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` | `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`, 6>>;
2239
2605
  /**
2240
2606
  * Retrieves a list of SubscriptionContracts, given the provided [paging, filtering, and sorting][1].
2241
2607
  *
@@ -2401,4 +2767,4 @@ declare const utils: {
2401
2767
  };
2402
2768
  };
2403
2769
 
2404
- export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, ActionInitiator, type ActionInitiatorWithLiterals, 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 BillingSettings, 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, 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 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, 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 SubscriptionContract, type SubscriptionContractCanceled, type SubscriptionContractCreatedEnvelope, type SubscriptionContractDeletedEnvelope, 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 TranslatableString, 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 };
2770
+ 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 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, 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 };
@@ -21,8 +21,10 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
21
21
  var index_typings_exports = {};
22
22
  __export(index_typings_exports, {
23
23
  ActionInitiator: () => ActionInitiator,
24
+ ActivityType: () => ActivityType,
24
25
  AdditionalFeeSource: () => AdditionalFeeSource,
25
26
  AdjustmentType: () => AdjustmentType,
27
+ ChangeType: () => ChangeType,
26
28
  ChannelType: () => ChannelType,
27
29
  ChargeType: () => ChargeType,
28
30
  DescriptionLineType: () => DescriptionLineType,
@@ -31,6 +33,7 @@ __export(index_typings_exports, {
31
33
  DiscountType: () => DiscountType,
32
34
  ItemTypePreset: () => ItemTypePreset,
33
35
  JurisdictionType: () => JurisdictionType,
36
+ LineItemQuantityChangeType: () => LineItemQuantityChangeType,
34
37
  PaymentOptionType: () => PaymentOptionType,
35
38
  PickupMethod: () => PickupMethod,
36
39
  ProductPeriodAlignment: () => ProductPeriodAlignment,
@@ -137,7 +140,8 @@ function getSubscriptionContract(payload) {
137
140
  },
138
141
  {
139
142
  path: "subscriptionContract.shippingInfo.logistics.deliveryTimeSlot.to"
140
- }
143
+ },
144
+ { path: "subscriptionContract.activities.createdDate" }
141
145
  ]
142
146
  },
143
147
  {
@@ -220,7 +224,8 @@ function querySubscriptionContracts(payload) {
220
224
  },
221
225
  {
222
226
  path: "subscriptionContracts.shippingInfo.logistics.deliveryTimeSlot.to"
223
- }
227
+ },
228
+ { path: "subscriptionContracts.activities.createdDate" }
224
229
  ]
225
230
  },
226
231
  {
@@ -413,6 +418,7 @@ var ChannelType = /* @__PURE__ */ ((ChannelType2) => {
413
418
  ChannelType2["PAYPAL_AGENTIC_CHECKOUT"] = "PAYPAL_AGENTIC_CHECKOUT";
414
419
  ChannelType2["STRIPE_AGENTIC_CHECKOUT"] = "STRIPE_AGENTIC_CHECKOUT";
415
420
  ChannelType2["WIX_INVOICES_PLATFORM"] = "WIX_INVOICES_PLATFORM";
421
+ ChannelType2["UCP_AGENTIC_CHECKOUT"] = "UCP_AGENTIC_CHECKOUT";
416
422
  return ChannelType2;
417
423
  })(ChannelType || {});
418
424
  var AdditionalFeeSource = /* @__PURE__ */ ((AdditionalFeeSource2) => {
@@ -429,6 +435,16 @@ var SpecificItemsCouponBehavior = /* @__PURE__ */ ((SpecificItemsCouponBehavior2
429
435
  SpecificItemsCouponBehavior2["LEGACY_ITEM_SUBTOTAL_DOES_NOT_INCLUDE_DISCOUNT"] = "LEGACY_ITEM_SUBTOTAL_DOES_NOT_INCLUDE_DISCOUNT";
430
436
  return SpecificItemsCouponBehavior2;
431
437
  })(SpecificItemsCouponBehavior || {});
438
+ var LineItemQuantityChangeType = /* @__PURE__ */ ((LineItemQuantityChangeType2) => {
439
+ LineItemQuantityChangeType2["QUANTITY_INCREASED"] = "QUANTITY_INCREASED";
440
+ LineItemQuantityChangeType2["QUANTITY_DECREASED"] = "QUANTITY_DECREASED";
441
+ return LineItemQuantityChangeType2;
442
+ })(LineItemQuantityChangeType || {});
443
+ var ActivityType = /* @__PURE__ */ ((ActivityType2) => {
444
+ ActivityType2["UNKNOWN_ACTIVITY_TYPE"] = "UNKNOWN_ACTIVITY_TYPE";
445
+ ActivityType2["CHANGES_APPLIED"] = "CHANGES_APPLIED";
446
+ return ActivityType2;
447
+ })(ActivityType || {});
432
448
  var ActionInitiator = /* @__PURE__ */ ((ActionInitiator2) => {
433
449
  ActionInitiator2["UNKNOWN_ACTION_INITIATOR"] = "UNKNOWN_ACTION_INITIATOR";
434
450
  ActionInitiator2["BUSINESS"] = "BUSINESS";
@@ -437,6 +453,12 @@ var ActionInitiator = /* @__PURE__ */ ((ActionInitiator2) => {
437
453
  ActionInitiator2["PAYMENT_FAILURE"] = "PAYMENT_FAILURE";
438
454
  return ActionInitiator2;
439
455
  })(ActionInitiator || {});
456
+ var ChangeType = /* @__PURE__ */ ((ChangeType2) => {
457
+ ChangeType2["ADDED"] = "ADDED";
458
+ ChangeType2["CHANGED"] = "CHANGED";
459
+ ChangeType2["REMOVED"] = "REMOVED";
460
+ return ChangeType2;
461
+ })(ChangeType || {});
440
462
  var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
441
463
  SortOrder2["ASC"] = "ASC";
442
464
  SortOrder2["DESC"] = "DESC";
@@ -615,8 +637,10 @@ var utils = {
615
637
  // Annotate the CommonJS export names for ESM import in node:
616
638
  0 && (module.exports = {
617
639
  ActionInitiator,
640
+ ActivityType,
618
641
  AdditionalFeeSource,
619
642
  AdjustmentType,
643
+ ChangeType,
620
644
  ChannelType,
621
645
  ChargeType,
622
646
  DescriptionLineType,
@@ -625,6 +649,7 @@ var utils = {
625
649
  DiscountType,
626
650
  ItemTypePreset,
627
651
  JurisdictionType,
652
+ LineItemQuantityChangeType,
628
653
  PaymentOptionType,
629
654
  PickupMethod,
630
655
  ProductPeriodAlignment,