@wix/auto_sdk_ecom_subscription-contracts 1.0.113 → 1.0.115

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 +31 -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 +26 -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 +28 -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 +23 -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 +31 -3
  27. package/build/internal/cjs/index.js.map +1 -1
  28. package/build/internal/cjs/index.typings.d.ts +371 -13
  29. package/build/internal/cjs/index.typings.js +26 -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 +28 -3
  39. package/build/internal/es/index.mjs.map +1 -1
  40. package/build/internal/es/index.typings.d.mts +371 -13
  41. package/build/internal/es/index.typings.mjs +23 -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
@@ -61,6 +61,7 @@ interface SubscriptionContract {
61
61
  /**
62
62
  * Language for communication with the buyer. Defaults to the site language.
63
63
  * For a site that supports multiple languages, this is the language the buyer selected.
64
+ * @maxLength 10
64
65
  */
65
66
  buyerLanguage?: string | null;
66
67
  /** Weight measurement unit - defaults to site's weight unit. */
@@ -91,11 +92,17 @@ interface SubscriptionContract {
91
92
  billingInfo?: AddressWithContact;
92
93
  /** Shipping info and selected shipping option details. */
93
94
  shippingInfo?: ShippingInformation;
94
- /** Applied discounts. */
95
+ /**
96
+ * Applied discounts.
97
+ * @maxSize 100
98
+ */
95
99
  appliedDiscounts?: AppliedDiscount[];
96
100
  /** Information about the sales channel that submitted this order. */
97
101
  channelInfo?: ChannelInfo;
98
- /** Custom fields. */
102
+ /**
103
+ * Custom fields.
104
+ * @maxSize 100
105
+ */
99
106
  customFields?: CustomField[];
100
107
  /**
101
108
  * Order recipient address and contact details.
@@ -129,6 +136,12 @@ interface SubscriptionContract {
129
136
  * @maxSize 100
130
137
  */
131
138
  additionalFees?: AdditionalFee[];
139
+ /**
140
+ * Activities recorded on this contract (e.g. draft commits, status changes).
141
+ * @readonly
142
+ * @maxSize 500
143
+ */
144
+ activities?: SubscriptionContractActivity[];
132
145
  }
133
146
  interface V1SubscriptionDescription {
134
147
  /**
@@ -441,14 +454,6 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
441
454
  colorInfo?: Color;
442
455
  /** Description line name. */
443
456
  name?: DescriptionLineName;
444
- /**
445
- * Whether the description line originates from a modifier.
446
- * @internal
447
- * @deprecated Whether the description line originates from a modifier.
448
- * @replacedBy none
449
- * @targetRemovalDate 2025-12-31
450
- */
451
- modifierDescriptionLine?: boolean;
452
457
  }
453
458
  /** @oneof */
454
459
  interface DescriptionLineValueOneOf {
@@ -1893,13 +1898,239 @@ declare enum SpecificItemsCouponBehavior {
1893
1898
  }
1894
1899
  /** @enumType */
1895
1900
  type SpecificItemsCouponBehaviorWithLiterals = SpecificItemsCouponBehavior | 'UNDEFINED_COUPON_BEHAVIOR' | 'ITEM_SUBTOTAL_INCLUDES_DISCOUNT' | 'LEGACY_ITEM_SUBTOTAL_DOES_NOT_INCLUDE_DISCOUNT';
1901
+ interface SubscriptionContractActivity extends SubscriptionContractActivityTargetOneOf, SubscriptionContractActivityContentOneOf {
1902
+ /** Scopes the draft to the contract level, applying to all future cycles. */
1903
+ contractTarget?: ContractTarget;
1904
+ /** Changes committed from a DraftSubscriptionContract. */
1905
+ changesApplied?: ChangesAppliedActivity;
1906
+ /**
1907
+ * Activity ID.
1908
+ * @format GUID
1909
+ * @readonly
1910
+ */
1911
+ _id?: string;
1912
+ /**
1913
+ * When the activity occurred.
1914
+ * @readonly
1915
+ */
1916
+ _createdDate?: Date | null;
1917
+ /**
1918
+ * Identity of the draft order's initiator.
1919
+ * @readonly
1920
+ */
1921
+ author?: ActivityAuthor;
1922
+ /** Activity type. */
1923
+ activityType?: ActivityTypeWithLiterals;
1924
+ }
1925
+ /** @oneof */
1926
+ interface SubscriptionContractActivityTargetOneOf {
1927
+ /** Scopes the draft to the contract level, applying to all future cycles. */
1928
+ contractTarget?: ContractTarget;
1929
+ }
1930
+ /** @oneof */
1931
+ interface SubscriptionContractActivityContentOneOf {
1932
+ /** Changes committed from a DraftSubscriptionContract. */
1933
+ changesApplied?: ChangesAppliedActivity;
1934
+ }
1935
+ /** Scopes the draft to the contract level, applying to all future cycles. */
1936
+ interface ContractTarget {
1937
+ /** Cycle number of the next billing cycle (1-based). Set by the caller; returned by the server on read. */
1938
+ nextCycleNumber?: number | null;
1939
+ }
1940
+ interface ActivityAuthor extends ActivityAuthorValueOneOf {
1941
+ /**
1942
+ * User ID. When the draft order was created by a Wix user.
1943
+ * @format GUID
1944
+ */
1945
+ userId?: string;
1946
+ /**
1947
+ * App ID. When the draft order was created by an app.
1948
+ * @format GUID
1949
+ */
1950
+ appId?: string;
1951
+ }
1952
+ /** @oneof */
1953
+ interface ActivityAuthorValueOneOf {
1954
+ /**
1955
+ * User ID. When the draft order was created by a Wix user.
1956
+ * @format GUID
1957
+ */
1958
+ userId?: string;
1959
+ /**
1960
+ * App ID. When the draft order was created by an app.
1961
+ * @format GUID
1962
+ */
1963
+ appId?: string;
1964
+ }
1965
+ interface ChangesAppliedActivity extends ChangesAppliedActivityTargetOneOf {
1966
+ /** Scopes the draft to the contract level, applying to all future cycles. */
1967
+ contractTarget?: ContractTarget;
1968
+ /**
1969
+ * ID of the DraftSubscriptionContract that was committed.
1970
+ * @format GUID
1971
+ */
1972
+ draftSubscriptionContractId?: string;
1973
+ /**
1974
+ * Individual typed changes applied.
1975
+ * @maxSize 100
1976
+ */
1977
+ changes?: ContractChange[];
1978
+ /**
1979
+ * Reason for the edit, provided by the merchant (optional).
1980
+ * @maxLength 200
1981
+ */
1982
+ reason?: string | null;
1983
+ }
1984
+ /** @oneof */
1985
+ interface ChangesAppliedActivityTargetOneOf {
1986
+ /** Scopes the draft to the contract level, applying to all future cycles. */
1987
+ contractTarget?: ContractTarget;
1988
+ }
1989
+ interface ContractChange extends ContractChangeValueOneOf {
1990
+ /** Line item was modified. */
1991
+ lineItemChanged?: LineItemChanges;
1992
+ /** Line item was added to the contract. */
1993
+ lineItemAdded?: ManagedLineItem;
1994
+ /** Line item was removed from the contract. */
1995
+ lineItemRemoved?: ManagedLineItem;
1996
+ /** Discount was added to the contract. */
1997
+ discountAdded?: ManagedDiscount;
1998
+ /** Discount was removed from the contract. */
1999
+ discountRemoved?: ManagedDiscount;
2000
+ /** Additional fee was added to the contract. */
2001
+ additionalFeeAdded?: ManagedAdditionalFee;
2002
+ /** Additional fee was removed from the contract. */
2003
+ additionalFeeRemoved?: ManagedAdditionalFee;
2004
+ /** Total price changed. */
2005
+ totalPriceChanged?: TotalPriceChange;
2006
+ }
2007
+ /** @oneof */
2008
+ interface ContractChangeValueOneOf {
2009
+ /** Line item was modified. */
2010
+ lineItemChanged?: LineItemChanges;
2011
+ /** Line item was added to the contract. */
2012
+ lineItemAdded?: ManagedLineItem;
2013
+ /** Line item was removed from the contract. */
2014
+ lineItemRemoved?: ManagedLineItem;
2015
+ /** Discount was added to the contract. */
2016
+ discountAdded?: ManagedDiscount;
2017
+ /** Discount was removed from the contract. */
2018
+ discountRemoved?: ManagedDiscount;
2019
+ /** Additional fee was added to the contract. */
2020
+ additionalFeeAdded?: ManagedAdditionalFee;
2021
+ /** Additional fee was removed from the contract. */
2022
+ additionalFeeRemoved?: ManagedAdditionalFee;
2023
+ /** Total price changed. */
2024
+ totalPriceChanged?: TotalPriceChange;
2025
+ }
2026
+ interface LineItemChanges {
2027
+ /**
2028
+ * Line item ID.
2029
+ * @format GUID
2030
+ */
2031
+ _id?: string;
2032
+ /** Item name after change. */
2033
+ name?: ProductName;
2034
+ /** Item quantity change. */
2035
+ quantity?: LineItemQuantityChange;
2036
+ }
2037
+ declare enum LineItemQuantityChangeType {
2038
+ QUANTITY_INCREASED = "QUANTITY_INCREASED",
2039
+ QUANTITY_DECREASED = "QUANTITY_DECREASED"
2040
+ }
2041
+ /** @enumType */
2042
+ type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
2043
+ interface LineItemQuantityChange {
2044
+ /**
2045
+ * Original item quantity before the change.
2046
+ * @max 1000000
2047
+ */
2048
+ originalQuantity?: number;
2049
+ /**
2050
+ * New item quantity after the change.
2051
+ * @max 1000000
2052
+ */
2053
+ newQuantity?: number;
2054
+ /**
2055
+ * Difference between new and original quantities.
2056
+ * @min 1
2057
+ * @max 1000000
2058
+ */
2059
+ diff?: number;
2060
+ /** Direction of the quantity change. */
2061
+ deltaType?: LineItemQuantityChangeTypeWithLiterals;
2062
+ }
2063
+ interface ManagedLineItem {
2064
+ /**
2065
+ * Line item ID.
2066
+ * @format GUID
2067
+ */
2068
+ _id?: string;
2069
+ /** Item name. */
2070
+ name?: ProductName;
2071
+ /**
2072
+ * Added or removed item quantity.
2073
+ * @min 1
2074
+ * @max 1000000
2075
+ */
2076
+ quantity?: number;
2077
+ }
2078
+ interface ManagedDiscount {
2079
+ /**
2080
+ * Discount ID.
2081
+ * @format GUID
2082
+ */
2083
+ _id?: string;
2084
+ /** Discount name. */
2085
+ name?: TranslatedValue;
2086
+ /** Discount amount. */
2087
+ totalAmount?: Price;
2088
+ }
2089
+ interface TranslatedValue {
2090
+ /**
2091
+ * Value in site default language.
2092
+ * @minLength 1
2093
+ */
2094
+ original?: string;
2095
+ /**
2096
+ * Translated value.
2097
+ * @minLength 1
2098
+ */
2099
+ translated?: string | null;
2100
+ }
2101
+ interface ManagedAdditionalFee {
2102
+ /**
2103
+ * Additional fee ID.
2104
+ * @format GUID
2105
+ */
2106
+ _id?: string;
2107
+ /** Additional fee name. */
2108
+ name?: TranslatedValue;
2109
+ /** Additional fee amount. */
2110
+ totalAmount?: Price;
2111
+ }
2112
+ interface TotalPriceChange {
2113
+ /** Total price before the commit. */
2114
+ originalTotal?: Price;
2115
+ /** Total price after the commit. */
2116
+ newTotal?: Price;
2117
+ }
2118
+ declare enum ActivityType {
2119
+ UNKNOWN_ACTIVITY_TYPE = "UNKNOWN_ACTIVITY_TYPE",
2120
+ CHANGES_APPLIED = "CHANGES_APPLIED"
2121
+ }
2122
+ /** @enumType */
2123
+ type ActivityTypeWithLiterals = ActivityType | 'UNKNOWN_ACTIVITY_TYPE' | 'CHANGES_APPLIED';
1896
2124
  /** Triggered when a subscription contract has been canceled before its designated end date. */
1897
2125
  interface SubscriptionContractCanceled {
1898
2126
  /** The subscription contract that was canceled. */
1899
2127
  subscriptionContract?: SubscriptionContract;
1900
2128
  /** Who initiated the cancellation. */
1901
2129
  initiator?: ActionInitiatorWithLiterals;
1902
- /** Reason for cancellation. */
2130
+ /**
2131
+ * Reason for cancellation.
2132
+ * @maxLength 500
2133
+ */
1903
2134
  reason?: string | null;
1904
2135
  }
1905
2136
  declare enum ActionInitiator {
@@ -1916,6 +2147,102 @@ interface SubscriptionContractExpired {
1916
2147
  /** The subscription contract that expired. */
1917
2148
  subscriptionContract?: SubscriptionContract;
1918
2149
  }
2150
+ /**
2151
+ * ACTION event payload emitted after a successful commit.
2152
+ * Carries the full delta — downstream consumers (email notifications, activity feed)
2153
+ * subscribe to this event and have all details inline without fetching the draft.
2154
+ */
2155
+ interface SubscriptionContractChangesCommitted {
2156
+ /** Updated SubscriptionContract after commit. */
2157
+ subscriptionContract?: SubscriptionContract;
2158
+ /**
2159
+ * ID of the DraftSubscriptionContract that triggered this commit.
2160
+ * @format GUID
2161
+ */
2162
+ draftSubscriptionContractId?: string;
2163
+ /** The actual delta applied. */
2164
+ changes?: SubscriptionContractDiffs;
2165
+ /**
2166
+ * Date and time the changes were committed.
2167
+ * @readonly
2168
+ */
2169
+ commitDate?: Date | null;
2170
+ }
2171
+ interface SubscriptionContractDiffs {
2172
+ /**
2173
+ * Per-item deltas: added, changed, or removed line items.
2174
+ * @maxSize 100
2175
+ */
2176
+ lineItems?: LineItemDelta[];
2177
+ /**
2178
+ * Per-discount deltas.
2179
+ * @maxSize 100
2180
+ */
2181
+ appliedDiscounts?: AppliedDiscountDelta[];
2182
+ /**
2183
+ * Per-fee deltas.
2184
+ * @maxSize 100
2185
+ */
2186
+ additionalFees?: AdditionalFeeDelta[];
2187
+ /** Updated price summary (overwrites existing). */
2188
+ priceSummary?: PriceSummary;
2189
+ /** Updated tax info (overwrites existing). */
2190
+ taxInfo?: OrderTaxInfo;
2191
+ }
2192
+ interface LineItemDelta {
2193
+ /**
2194
+ * Line item ID.
2195
+ * @format GUID
2196
+ */
2197
+ lineItemId?: string;
2198
+ /** Full line item content (absent for removed items). */
2199
+ lineItem?: OrderLineItem;
2200
+ /** Type of change applied to this line item. */
2201
+ changeType?: ChangeTypeWithLiterals;
2202
+ }
2203
+ /** Describes the type of change applied to an element. */
2204
+ declare enum ChangeType {
2205
+ /** Element was added (absent in the original contract). */
2206
+ ADDED = "ADDED",
2207
+ /** Element was modified from the original contract. */
2208
+ CHANGED = "CHANGED",
2209
+ /** Element was removed from the contract. */
2210
+ REMOVED = "REMOVED"
2211
+ }
2212
+ /** @enumType */
2213
+ type ChangeTypeWithLiterals = ChangeType | 'ADDED' | 'CHANGED' | 'REMOVED';
2214
+ interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaDetailsOneOf {
2215
+ /** Discount content after the change. */
2216
+ changed?: AppliedDiscount;
2217
+ /**
2218
+ * Discount ID.
2219
+ * @format GUID
2220
+ */
2221
+ discountId?: string;
2222
+ /** Type of change applied to this discount. */
2223
+ changeType?: ChangeTypeWithLiterals;
2224
+ }
2225
+ /** @oneof */
2226
+ interface AppliedDiscountDeltaDeltaDetailsOneOf {
2227
+ /** Discount content after the change. */
2228
+ changed?: AppliedDiscount;
2229
+ }
2230
+ interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaDetailsOneOf {
2231
+ /** Additional fee content after the change. */
2232
+ changed?: AdditionalFee;
2233
+ /**
2234
+ * Additional fee ID.
2235
+ * @format GUID
2236
+ */
2237
+ additionalFeeId?: string;
2238
+ /** Type of change applied to this additional fee. */
2239
+ changeType?: ChangeTypeWithLiterals;
2240
+ }
2241
+ /** @oneof */
2242
+ interface AdditionalFeeDeltaDeltaDetailsOneOf {
2243
+ /** Additional fee content after the change. */
2244
+ changed?: AdditionalFee;
2245
+ }
1919
2246
  interface CreateSubscriptionContractRequest {
1920
2247
  /** SubscriptionContract to be created. */
1921
2248
  subscriptionContract?: SubscriptionContract;
@@ -2189,6 +2516,37 @@ interface BulkUpdateSubscriptionContractsResponse {
2189
2516
  /** Metadata about the bulk operation. */
2190
2517
  bulkActionMetadata?: BulkActionMetadata;
2191
2518
  }
2519
+ interface CommitSubscriptionContractChangesRequest {
2520
+ /**
2521
+ * ID of the SubscriptionContract to update.
2522
+ * @format GUID
2523
+ */
2524
+ subscriptionContractId?: string;
2525
+ /**
2526
+ * ID of the originating DraftSubscriptionContract (for traceability).
2527
+ * @format GUID
2528
+ */
2529
+ draftSubscriptionContractId?: string;
2530
+ /** Delta changes to apply. */
2531
+ changes?: SubscriptionContractDiffs;
2532
+ /**
2533
+ * Reason for the edit, provided by the merchant (optional).
2534
+ * @maxLength 200
2535
+ */
2536
+ reason?: string | null;
2537
+ /** Side-effects to happen after contract is updated */
2538
+ settings?: SubscriptionCommitSettings;
2539
+ }
2540
+ interface SubscriptionCommitSettings {
2541
+ /** If false, do not send notifications to buyer. Default is true. */
2542
+ sendNotificationsToBuyer?: boolean | null;
2543
+ /** If false, do not send notifications to business. Default is true. */
2544
+ sendNotificationsToBusiness?: boolean | null;
2545
+ }
2546
+ interface CommitSubscriptionContractChangesResponse {
2547
+ /** Updated SubscriptionContract. */
2548
+ subscriptionContract?: SubscriptionContract;
2549
+ }
2192
2550
  interface MessageEnvelope {
2193
2551
  /**
2194
2552
  * App instance ID.
@@ -2404,7 +2762,7 @@ declare function onSubscriptionContractUpdated(handler: (event: SubscriptionCont
2404
2762
  * @returns The requested SubscriptionContract.
2405
2763
  * @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.GetSubscriptionContract
2406
2764
  */
2407
- 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>>;
2765
+ 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>>;
2408
2766
  /**
2409
2767
  * Retrieves a list of SubscriptionContracts, given the provided [paging, filtering, and sorting][1].
2410
2768
  *
@@ -2570,4 +2928,4 @@ declare const utils: {
2570
2928
  };
2571
2929
  };
2572
2930
 
2573
- 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 };
2931
+ 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 };
@@ -88,7 +88,8 @@ function getSubscriptionContract(payload) {
88
88
  },
89
89
  {
90
90
  path: "subscriptionContract.shippingInfo.logistics.deliveryTimeSlot.to"
91
- }
91
+ },
92
+ { path: "subscriptionContract.activities.createdDate" }
92
93
  ]
93
94
  },
94
95
  {
@@ -171,7 +172,8 @@ function querySubscriptionContracts(payload) {
171
172
  },
172
173
  {
173
174
  path: "subscriptionContracts.shippingInfo.logistics.deliveryTimeSlot.to"
174
- }
175
+ },
176
+ { path: "subscriptionContracts.activities.createdDate" }
175
177
  ]
176
178
  },
177
179
  {
@@ -381,6 +383,16 @@ var SpecificItemsCouponBehavior = /* @__PURE__ */ ((SpecificItemsCouponBehavior2
381
383
  SpecificItemsCouponBehavior2["LEGACY_ITEM_SUBTOTAL_DOES_NOT_INCLUDE_DISCOUNT"] = "LEGACY_ITEM_SUBTOTAL_DOES_NOT_INCLUDE_DISCOUNT";
382
384
  return SpecificItemsCouponBehavior2;
383
385
  })(SpecificItemsCouponBehavior || {});
386
+ var LineItemQuantityChangeType = /* @__PURE__ */ ((LineItemQuantityChangeType2) => {
387
+ LineItemQuantityChangeType2["QUANTITY_INCREASED"] = "QUANTITY_INCREASED";
388
+ LineItemQuantityChangeType2["QUANTITY_DECREASED"] = "QUANTITY_DECREASED";
389
+ return LineItemQuantityChangeType2;
390
+ })(LineItemQuantityChangeType || {});
391
+ var ActivityType = /* @__PURE__ */ ((ActivityType2) => {
392
+ ActivityType2["UNKNOWN_ACTIVITY_TYPE"] = "UNKNOWN_ACTIVITY_TYPE";
393
+ ActivityType2["CHANGES_APPLIED"] = "CHANGES_APPLIED";
394
+ return ActivityType2;
395
+ })(ActivityType || {});
384
396
  var ActionInitiator = /* @__PURE__ */ ((ActionInitiator2) => {
385
397
  ActionInitiator2["UNKNOWN_ACTION_INITIATOR"] = "UNKNOWN_ACTION_INITIATOR";
386
398
  ActionInitiator2["BUSINESS"] = "BUSINESS";
@@ -389,6 +401,12 @@ var ActionInitiator = /* @__PURE__ */ ((ActionInitiator2) => {
389
401
  ActionInitiator2["PAYMENT_FAILURE"] = "PAYMENT_FAILURE";
390
402
  return ActionInitiator2;
391
403
  })(ActionInitiator || {});
404
+ var ChangeType = /* @__PURE__ */ ((ChangeType2) => {
405
+ ChangeType2["ADDED"] = "ADDED";
406
+ ChangeType2["CHANGED"] = "CHANGED";
407
+ ChangeType2["REMOVED"] = "REMOVED";
408
+ return ChangeType2;
409
+ })(ChangeType || {});
392
410
  var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
393
411
  SortOrder2["ASC"] = "ASC";
394
412
  SortOrder2["DESC"] = "DESC";
@@ -566,8 +584,10 @@ var utils = {
566
584
  };
567
585
  export {
568
586
  ActionInitiator,
587
+ ActivityType,
569
588
  AdditionalFeeSource,
570
589
  AdjustmentType,
590
+ ChangeType,
571
591
  ChannelType,
572
592
  ChargeType,
573
593
  DescriptionLineType,
@@ -576,6 +596,7 @@ export {
576
596
  DiscountType,
577
597
  ItemTypePreset,
578
598
  JurisdictionType,
599
+ LineItemQuantityChangeType,
579
600
  PaymentOptionType,
580
601
  PickupMethod,
581
602
  ProductPeriodAlignment,