@commercetools/history-sdk 2.3.0 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @commercetools/history-sdk
 
+## 2.4.0
+
+### Minor Changes
+
+- [#241](https://github.com/commercetools/commercetools-sdk-typescript/pull/241) [`85f5be3`](https://github.com/commercetools/commercetools-sdk-typescript/commit/85f5be349a9b0fa46539259981bfd8d5fc2ffdc6) Thanks [@ajimae](https://github.com/ajimae)! - Releasing the TS SDK with the following changelogs
+
+  - added functionalities to extend client user agent
+  - custom field added to OrderFromCardDraft
+
+### Patch Changes
+
+- Updated dependencies [[`85f5be3`](https://github.com/commercetools/commercetools-sdk-typescript/commit/85f5be349a9b0fa46539259981bfd8d5fc2ffdc6)]:
+  - @commercetools/sdk-client-v2@1.3.0
+
 ## 2.3.0
 
 ### Minor Changes

package/dist/declarations/src/generated/client/by-project-key-by-resource-type-by-id-request-builder.d.ts

@@ -3,7 +3,7 @@
  * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
  * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
  */
-import { PlatformInitiatedChange, RecordPagedQueryResponse } from '../models/common';
+import { PlatformInitiatedChange, RecordPagedQueryResponse } from '../models/change-history';
 import { executeRequest, QueryParam } from '../shared/utils/common-types';
 import { ApiRequest } from '../shared/utils/requests-utils';
 export declare class ByProjectKeyByResourceTypeByIDRequestBuilder {
@@ -36,6 +36,7 @@ export declare class ByProjectKeyByResourceTypeByIDRequestBuilder {
             clientId?: string;
             source?: string;
             changes?: string | string[];
+            stores?: string | string[];
             customerId?: string;
             excludePlatformInitiatedChanges?: PlatformInitiatedChange | PlatformInitiatedChange[];
             expand?: boolean;

package/dist/declarations/src/generated/client/by-project-key-by-resource-type-request-builder.d.ts

@@ -3,7 +3,7 @@
  * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
  * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
  */
-import { PlatformInitiatedChange, RecordPagedQueryResponse } from '../models/common';
+import { PlatformInitiatedChange, RecordPagedQueryResponse } from '../models/change-history';
 import { executeRequest, QueryParam } from '../shared/utils/common-types';
 import { ApiRequest } from '../shared/utils/requests-utils';
 import { ByProjectKeyByResourceTypeByIDRequestBuilder } from './by-project-key-by-resource-type-by-id-request-builder';
@@ -39,6 +39,7 @@ export declare class ByProjectKeyByResourceTypeRequestBuilder {
             resourceId?: string;
             source?: string;
             changes?: string | string[];
+            stores?: string | string[];
             customerId?: string;
             excludePlatformInitiatedChanges?: PlatformInitiatedChange | PlatformInitiatedChange[];
             expand?: boolean;

package/dist/declarations/src/generated/client/by-project-key-request-builder.d.ts

@@ -3,7 +3,7 @@
  * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
  * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
  */
-import { ChangeHistoryResourceType, PlatformInitiatedChange, RecordPagedQueryResponse } from '../models/common';
+import { ChangeHistoryResourceType, PlatformInitiatedChange, RecordPagedQueryResponse } from '../models/change-history';
 import { executeRequest, QueryParam } from '../shared/utils/common-types';
 import { ApiRequest } from '../shared/utils/requests-utils';
 import { ByProjectKeyByResourceTypeRequestBuilder } from './by-project-key-by-resource-type-request-builder';
@@ -38,6 +38,7 @@ export declare class ByProjectKeyRequestBuilder {
             resourceId?: string;
             source?: string;
             changes?: string | string[];
+            stores?: string | string[];
             customerId?: string;
             excludePlatformInitiatedChanges?: PlatformInitiatedChange | PlatformInitiatedChange[];
             expand?: boolean;

package/dist/declarations/src/generated/index.d.ts

@@ -5,6 +5,7 @@
 */
 export * from './client/api-root';
 export * from './models/change';
+export * from './models/change-history';
 export * from './models/change-value';
 export * from './models/common';
 export * from './models/label';

package/dist/declarations/src/generated/models/change-history.d.ts

@@ -0,0 +1,211 @@
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+import { Change } from './change';
+import { KeyReference, Reference } from './common';
+import { Label } from './label';
+/**
+ *	A Record captures the differences in a resource between one version and the next.
+ *	(Recall that the version number is not always incremented by one; see [Optimistic Concurrency Control](/general-concepts#optimistic-concurrency-control).)
+ *
+ */
+export interface Record {
+    /**
+     *	Version of the resource after the change.
+     *
+     */
+    readonly version: number;
+    /**
+     *	Version of the resource before the change.
+     *
+     */
+    readonly previousVersion: number;
+    /**
+     *	Type of the change (creation, update or deletion).
+     *
+     */
+    readonly type: string;
+    /**
+     *	Information about the user or the API client who performed the change.
+     *
+     */
+    readonly modifiedBy: ModifiedBy;
+    /**
+     *	Date and time when the change was made.
+     *
+     */
+    readonly modifiedAt: string;
+    /**
+     *	Information that describes the resource after the change.
+     *
+     */
+    readonly label: Label;
+    /**
+     *	Information that describes the resource before the change.
+     *
+     */
+    readonly previousLabel: Label;
+    /**
+     *	Shows the differences in the resource between `previousVersion` and `version`.
+     *	The value is not identical to the actual array of update actions that was sent to the platform and is not limited to update actions (see, for example, [Optimistic  Concurrency Control](/general-concepts#optimistic-concurrency-control)).
+     *
+     *
+     */
+    readonly changes: Change[];
+    /**
+     *	Reference to the changed resource.
+     *
+     *
+     */
+    readonly resource: Reference;
+    /**
+     *	References to the [Stores](ctp:api:type:Store) attached to the [Change](ctp:history:type:Change).
+     *
+     *
+     */
+    readonly stores: KeyReference[];
+    /**
+     *	`true` if no change was detected.
+     *	The version number of the resource can be increased even without any change in the resource.
+     *
+     *
+     */
+    readonly withoutChanges: boolean;
+}
+/**
+ *	Response to a query request for [Record](#record).
+ *
+ */
+export interface RecordPagedQueryResponse {
+    /**
+     *	Maximum number of results requested in the query request.
+     *
+     *
+     */
+    readonly limit: number;
+    /**
+     *	Actual number of results returned.
+     *
+     *
+     */
+    readonly count: number;
+    /**
+     *	Total number of results matching the query.
+     *	This number is an estimation and not [strongly consistent](/general-concepts#strong-consistency).
+     *
+     *
+     */
+    readonly total: number;
+    /**
+     *	The number of elements skipped, not a page number. Supplied by the client or the server default.
+     *
+     *
+     */
+    readonly offset: number;
+    /**
+     *
+     */
+    readonly results: Record[];
+}
+/**
+ *	This data type represents the supported resource types.
+ *	The value must be one of the following:
+ *
+ */
+export declare type ChangeHistoryResourceType = 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-group' | 'discount-code' | 'inventory-entry' | 'key-value-document' | 'order' | 'payment' | 'product' | 'product-discount' | 'product-type' | 'review' | 'shopping-list' | 'state' | 'store' | 'tax-category' | 'type' | 'zone';
+/**
+ *	This type consists of one enum value:
+ *
+ */
+export declare type DateStringFilter = 'now';
+export interface ErrorObject {
+    /**
+     *
+     */
+    readonly code: string;
+    /**
+     *
+     */
+    readonly message: string;
+}
+export interface ErrorResponse {
+    /**
+     *
+     */
+    readonly statusCode: number;
+    /**
+     *
+     */
+    readonly message: string;
+    /**
+     *
+     */
+    readonly error?: string;
+    /**
+     *
+     */
+    readonly error_description?: string;
+    /**
+     *
+     */
+    readonly errors?: ErrorObject[];
+}
+/**
+ *	Information about the user or the API client who performed the change. This is a variant of
+ *	[LastModifiedBy](/types#lastmodifiedby).
+ *
+ */
+export interface ModifiedBy {
+    /**
+     *	[ID](/general-concepts#identifier) of the Merchant Center user who made the change.
+     *	Present only if the change was made in the Merchant Center.
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Indicates whether the change was made by a user or the API client with or without an
+     *	[External user ID](/client-logging#external-user-ids).
+     *
+     *
+     */
+    readonly type: string;
+    /**
+     *	[Reference](/types#reference) to the
+     *	[Customer](/projects/customers#customer) who made the change. Present only if
+     *	the change was made using a token from the [Password
+     *	Flow](/authorization#password-flow).
+     *
+     *
+     */
+    readonly customer?: Reference;
+    /**
+     *	Present only if the change was made using a token from an [Anonymous
+     *	Session](/authorization#tokens-for-anonymous-sessions).
+     *
+     *
+     */
+    readonly anonymousId?: string;
+    /**
+     *	[ID](/general-concepts#identifier) of the [API
+     *	Client](/projects/api-clients#apiclient) that made the change. Present only if
+     *	the change was made using an API Client.
+     *
+     *
+     */
+    readonly clientId?: string;
+    /**
+     *	`true` if the change was made via Merchant Center or [ImpEx](https://impex.europe-west1.gcp.commercetools.com/).
+     *
+     *
+     */
+    readonly isPlatformClient: boolean;
+}
+export declare type PlatformInitiatedChange = 'changeLineItemName' | 'changeReviewRatingStatistics' | 'excludeAll' | 'setApplicationVersion' | 'setIsValid' | 'setVariantAvailability';
+/**
+ *	Values for the Source enumeration.
+ */
+export declare type Source = 'ApiClient' | 'ImpEx' | 'MerchantCenter';
+export declare type UpdateType = 'addAddress' | 'addAsset' | 'addAttributeDefinition' | 'addBillingAddressId' | 'addDelivery' | 'addEnumValue' | 'addExternalImage' | 'addFieldDefinition' | 'addInterfaceInteraction' | 'addItemShippingAddress' | 'addLineItem' | 'addLocalizedEnumValue' | 'addLocation' | 'addParcelToDelivery' | 'addPayment' | 'addPlainEnumValue' | 'addPrice' | 'addReturnInfo' | 'addRoles' | 'addShippingAddressId' | 'addTaxRate' | 'addTextLineItem' | 'addToCategory' | 'addTransaction' | 'addVariant' | 'changeAddress' | 'changeAmountPlanned' | 'changeAssetName' | 'changeAssetOrder' | 'changeAttributeConstraint' | 'changeAttributeName' | 'changeAttributeOrderByName' | 'changeCartDiscounts' | 'changeCartPredicate' | 'changeDescription' | 'changeEmail' | 'changeEnumKey' | 'changeEnumValueLabel' | 'changeEnumValueOrder' | 'changeFieldDefinitionOrder' | 'changeGroups' | 'changeInitial' | 'changeInputHint' | 'changeIsActive' | 'changeIsSearchable' | 'changeKey' | 'changeLabel' | 'changeLineItemQuantity' | 'changeLineItemsOrder' | 'changeLocalizedEnumValueLabel' | 'changeLocalizedEnumValueOrder' | 'changeMasterVariant' | 'changeName' | 'changeOrderHint' | 'changeOrderState' | 'changeParent' | 'changePaymentState' | 'changePlainEnumValueLabel' | 'changePredicate' | 'changePrice' | 'changeQuantity' | 'changeRequiresDiscountCode' | 'changeReviewRatingStatistics' | 'changeShipmentState' | 'changeSlug' | 'changeSortOrder' | 'changeStackingMode' | 'changeTarget' | 'changeTextLineItemName' | 'changeTextLineItemQuantity' | 'changeTextLineItemsOrder' | 'changeTransactionInteractionId' | 'changeTransactionState' | 'changeTransactionTimestamp' | 'changeType' | 'changeValue' | 'publish' | 'removeAddress' | 'removeAsset' | 'removeAttributeDefinition' | 'removeBillingAddressId' | 'removeDelivery' | 'removeEnumValues' | 'removeFieldDefinition' | 'removeFromCategory' | 'removeImage' | 'removeItemShippingAddress' | 'removeLineItem' | 'removeLocation' | 'removeParcelFromDelivery' | 'removePayment' | 'removePrice' | 'removeRoles' | 'removeShippingAddressId' | 'removeTaxRate' | 'removeTextLineItem' | 'removeVariant' | 'setAddress' | 'setAnonymousId' | 'setAssetCustomField' | 'setAssetCustomType' | 'setAssetDescription' | 'setAssetSources' | 'setAssetTags' | 'setAsssetKey' | 'setAttribute' | 'setAuthorName' | 'setBillingAddress' | 'setCartPredicate' | 'setCategoryOrderHint' | 'setCompanyName' | 'setCustomField' | 'setCustomLineItemCustomField' | 'setCustomLineItemCustomType' | 'setCustomLineItemShippingDetails' | 'setCustomType' | 'setCustomer' | 'setCustomerEmail' | 'setCustomerGroup' | 'setCustomerId' | 'setCustomerNumber' | 'setDateOfBirth' | 'setDefaultBillingAddress' | 'setDefaultShippingAddress' | 'setDeleteDaysAfterLastModification' | 'setDeliveryAddress' | 'setDeliveryItems' | 'setDescription' | 'setDiscountedPrice' | 'setDistributionChannels' | 'setExpectedDelivery' | 'setExternalId' | 'setFirstName' | 'setGeoLocation' | 'setImageLabel' | 'setInputTip' | 'setInterfaceId' | 'setKey' | 'setLanguages' | 'setLastName' | 'setLineItemCustomField' | 'setLineItemCustomType' | 'setLineItemShippingDetails' | 'setLocale' | 'setMaxApplications' | 'setMaxApplicationsPerCustomer' | 'setMetaDescription' | 'setMetaKeywords' | 'setMetaTitle' | 'setMethodInfoInterface' | 'setMethodInfoMethod' | 'setMethodInfoName' | 'setMiddleName' | 'setName' | 'setOrderNumber' | 'setParcelItems' | 'setParcelMeasurements' | 'setParcelTrackingData' | 'setPassword' | 'setProductPriceCustomField' | 'setProductPriceCustomType' | 'setProductVariantKey' | 'setRating' | 'setRestockableInDays' | 'setReturnPaymentState' | 'setReturnShipmentState' | 'setRoles' | 'setSalutation' | 'setSearchKeywords' | 'setShippingAddress' | 'setSku' | 'setSlug' | 'setStatusInterfaceCode' | 'setStatusInterfaceText' | 'setStore' | 'setStores' | 'setSupplyChannel' | 'setTarget' | 'setTaxCategory' | 'setText' | 'setTextLineItemCustomField' | 'setTextLineItemCustomType' | 'setTextLineItemDescription' | 'setTitle' | 'setTransitions' | 'setValidFrom' | 'setValidFromAndUntil' | 'setValidUntil' | 'setVariantAvailability' | 'setVatId' | 'transitionCustomLineItemState' | 'transitionLineItemState' | 'transitionState' | 'unpublish' | 'updateItemShippingAddress' | 'updateSyncInfo' | 'verifyEmail';

package/dist/declarations/src/generated/models/change-value.d.ts

@@ -3,7 +3,7 @@
  * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
  * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
  */
-import { Address, DeliveryItem, LocalizedString, Money, Parcel, Reference, SelectionMode } from './common';
+import { Address, DeliveryItem, LocalizedString, Money, Parcel, Reference, SelectionMode, TaxedPrice, TaxRate } from './common';
 export declare type ChangeTargetChangeValue = ChangeTargetCustomLineItemsChangeValue | ChangeTargetLineItemsChangeValue | ChangeTargetMultiBuyCustomLineItemsChangeValue | ChangeTargetMultiBuyLineItemsChangeValue | ChangeTargetShippingChangeValue;
 export declare type ChangeValueChangeValue = ChangeValueAbsoluteChangeValue | ChangeValueExternalChangeValue | ChangeValueGiftLineItemChangeValue | ChangeValueRelativeChangeValue;
 export interface AssetChangeValue {
@@ -16,6 +16,16 @@ export interface AssetChangeValue {
      */
     readonly name: LocalizedString;
 }
+export interface AttributeValue {
+    /**
+     *
+     */
+    readonly name: string;
+    /**
+     *
+     */
+    readonly value: any;
+}
 /**
  *	Shape of the value for cart discounts line item and custom line items target.
  */
@@ -279,6 +289,17 @@ export interface ShippingMethodChangeValue {
      */
     readonly name: string;
 }
+export interface ShippingMethodTaxAmountChangeValue {
+    /**
+     *
+     */
+    readonly taxedPrice: TaxedPrice;
+    /**
+     *	Shape of the value for `addTaxRate` and `removeTaxRate` actions
+     *
+     */
+    readonly taxRate: TaxRate;
+}
 export interface ShoppingListLineItemValue {
     /**
      *

package/dist/declarations/src/generated/models/change.d.ts

@@ -3,7 +3,7 @@
  * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
  * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
  */
-import { AssetChangeValue, ChangeTargetChangeValue, ChangeValueChangeValue, CustomFieldExpandedValue, CustomShippingMethodChangeValue, DeliveryChangeValue, EnumValue, FieldDefinitionOrderValue, InventoryQuantityValue, LocalizedEnumValue, ParcelChangeValue, SetCartClassificationShippingRateInputValue, SetCartScoreShippingRateInputValue, ShippingMethodChangeValue, ShoppingListLineItemValue, TextLineItemValue, TransactionChangeValue, ValidFromAndUntilValue } from './change-value';
+import { AssetChangeValue, AttributeValue, ChangeTargetChangeValue, ChangeValueChangeValue, CustomFieldExpandedValue, CustomShippingMethodChangeValue, DeliveryChangeValue, EnumValue, FieldDefinitionOrderValue, InventoryQuantityValue, LocalizedEnumValue, ParcelChangeValue, SetCartClassificationShippingRateInputValue, SetCartScoreShippingRateInputValue, ShippingMethodChangeValue, ShippingMethodTaxAmountChangeValue, ShoppingListLineItemValue, TextLineItemValue, TransactionChangeValue, ValidFromAndUntilValue } from './change-value';
 import { Address, Asset, AssetSource, AttributeConstraintEnum, AttributeDefinition, CategoryOrderHints, ChannelRole, CustomFields, CustomLineItem, Delivery, DeliveryItem, DiscountCodeInfo, DiscountedLineItemPrice, DiscountedLineItemPriceForQuantity, FieldDefinition, GeoLocation, Image, ItemShippingDetails, ItemState, LineItem, LocalizedString, Location, Money, OrderState, Parcel, ParcelMeasurements, PaymentInfo, PaymentState, Price, ProductVariantAvailability, Reference, Reservation, ReturnInfo, ReturnPaymentState, ReturnShipmentState, ReviewRatingStatistics, RoundingMode, SearchKeywords, ShipmentState, StackingMode, StateRole, StateType, SyncInfo, TaxCalculationMode, TaxedItemPrice, TaxedPrice, TaxMode, TaxRate, TextInputHint, TextLineItem, TrackingData, Transaction, TransactionState, Variant } from './common';
 export declare type Change = AddAddressChange | AddAssetChange | AddAttributeDefinitionChange | AddBillingAddressIdChange | AddChannelRolesChange | AddCustomLineItemChange | AddDeliveryChange | AddDiscountCodeChange | AddEnumValueChange | AddExternalImageChange | AddFieldDefinitionChange | AddInterfaceInteractionChange | AddItemShippingAddressesChange | AddLocalizedEnumValueChange | AddLocationChange | AddOrderLineItemChange | AddParcelToDeliveryChange | AddPaymentChange | AddPlainEnumValueChange | AddPriceChange | AddPropertyChange | AddReturnInfoChange | AddShippingAddressIdChange | AddShoppingListLineItemChange | AddStateRolesChange | AddTaxRateChange | AddTextLineItemChange | AddToCategoryChange | AddTransactionChange | AddVariantChange | ChangeAddressChange | ChangeAmountAuthorizedChange | ChangeAmountPlannedChange | ChangeAssetNameChange | ChangeAssetOrderChange | ChangeAttributeConstraintChange | ChangeAttributeOrderByNameChange | ChangeCartDiscountsChange | ChangeCartPredicateChange | ChangeCustomLineItemQuantityChange | ChangeDescriptionChange | ChangeEmailChange | ChangeEnumValueLabelChange | ChangeEnumValueOrderChange | ChangeFieldDefinitionOrderChange | ChangeGroupsChange | ChangeInitialChange | ChangeInputHintChange | ChangeIsActiveChange | ChangeIsSearchableChange | ChangeKeyChange | ChangeLabelChange | ChangeLineItemQuantityChange | ChangeLocalizedDescriptionChange | ChangeLocalizedEnumValueLabelChange | ChangeLocalizedEnumValueOrderChange | ChangeLocalizedNameChange | ChangeMasterVariantChange | ChangeNameChange | ChangeOrderHintChange | ChangeOrderStateChange | ChangeParentChange | ChangePaymentStateChange | ChangePlainEnumValueLabelChange | ChangePlainEnumValueOrderChange | ChangePredicateChange | ChangePriceChange | ChangeQuantityChange | ChangeRequiresDiscountCodeChange | ChangeReviewRatingStatisticsChange | ChangeShipmentStateChange | ChangeShoppingListLineItemQuantityChange | ChangeShoppingListLineItemsOrderChange | ChangeSlugChange | ChangeSortOrderChange | ChangeStackingModeChange | ChangeStateTypeChange | ChangeTargetChange | ChangeTaxCalculationModeChange | ChangeTaxModeChange | ChangeTaxRoundingModeChange | ChangeTextLineItemNameChange | ChangeTextLineItemQuantityChange | ChangeTextLineItemsOrderChange | ChangeTransactionInteractionIdChange | ChangeTransactionStateChange | ChangeTransactionTimestampChange | ChangeValueChange | MoveImageToPositionChange | PublishChange | RemoveAddressChange | RemoveAssetChange | RemoveAttributeDefinitionChange | RemoveBillingAddressIdChange | RemoveChannelRolesChange | RemoveCustomLineItemChange | RemoveDeliveryItemsChange | RemoveDiscountCodeChange | RemoveEnumValuesChange | RemoveFieldDefinitionChange | RemoveFromCategoryChange | RemoveImageChange | RemoveItemShippingAddressesChange | RemoveLocalizedEnumValuesChange | RemoveLocationChange | RemoveOrderLineItemChange | RemoveParcelFromDeliveryChange | RemovePaymentChange | RemovePriceChange | RemovePropertyChange | RemoveShippingAddressIdChange | RemoveShoppingListLineItemChange | RemoveStateRolesChange | RemoveTaxRateChange | RemoveTextLineItemChange | RemoveVariantChange | SetAddressChange | SetAnonymousIdChange | SetApplicationVersionChange | SetAssetCustomFieldChange | SetAssetCustomTypeChange | SetAssetDescriptionChange | SetAssetKeyChange | SetAssetSourcesChange | SetAssetTagsChange | SetAttributeChange | SetAuthorNameChange | SetBillingAddressChange | SetCartPredicateChange | SetCategoryOrderHintChange | SetChannelRolesChange | SetCompanyNameChange | SetCountryChange | SetCustomFieldChange | SetCustomLineItemCustomFieldChange | SetCustomLineItemCustomTypeChange | SetCustomLineItemMoneyChange | SetCustomLineItemShippingDetailsChange | SetCustomLineItemTaxAmountChange | SetCustomLineItemTaxCategoryChange | SetCustomLineItemTaxRateChange | SetCustomLineItemTaxedPriceChange | SetCustomLineItemTotalPriceChange | SetCustomShippingMethodChange | SetCustomTypeChange | SetCustomerChange | SetCustomerEmailChange | SetCustomerGroupChange | SetCustomerIdChange | SetCustomerNumberChange | SetDateOfBirthChange | SetDefaultBillingAddressChange | SetDefaultShippingAddressChange | SetDeleteDaysAfterLastModificationChange | SetDeliveryAddressChange | SetDeliveryItemsChange | SetDescriptionChange | SetDiscountedPriceChange | SetDistributionChannelsChange | SetExpectedDeliveryChange | SetExternalIdChange | SetFirstNameChange | SetGeoLocationChange | SetImageLabelChange | SetInputTipChange | SetInterfaceIdChange | SetIsValidChange | SetKeyChange | SetLanguagesChange | SetLastNameChange | SetLineItemDiscountedPriceChange | SetLineItemDiscountedPricePerQuantityChange | SetLineItemDistributionChannelChange | SetLineItemPriceChange | SetLineItemProductSlugChange | SetLineItemShippingDetailsChange | SetLineItemTaxAmountChange | SetLineItemTaxRateChange | SetLineItemTaxedPriceChange | SetLineItemTotalPriceChange | SetLocaleChange | SetLocalizedDescriptionChange | SetMaxApplicationsChange | SetMaxApplicationsPerCustomerChange | SetMetaDescriptionChange | SetMetaKeywordsChange | SetMetaTitleChange | SetMethodInfoInterfaceChange | SetMethodInfoMethodChange | SetMethodInfoNameChange | SetMiddleNameChange | SetNameChange | SetOrderLineItemCustomFieldChange | SetOrderLineItemCustomTypeChange | SetOrderNumberChange | SetOrderTaxedPriceChange | SetOrderTotalPriceChange | SetOrderTotalTaxChange | SetParcelItemsChange | SetParcelMeasurementsChange | SetParcelTrackingDataChange | SetPricesChange | SetProductPriceCustomFieldChange | SetProductPriceCustomTypeChange | SetProductVariantKeyChange | SetPropertyChange | SetRatingChange | SetReservationsChange | SetRestockableInDaysChange | SetReturnPaymentStateChange | SetReturnShipmentStateChange | SetSalutationChange | SetSearchKeywordsChange | SetShippingAddressChange | SetShippingInfoPriceChange | SetShippingInfoTaxedPriceChange | SetShippingMethodChange | SetShippingMethodTaxAmountChange | SetShippingMethodTaxRateChange | SetShippingRateChange | SetShippingRateInputChange | SetShoppingListLineItemCustomFieldChange | SetShoppingListLineItemCustomTypeChange | SetSkuChange | SetSlugChange | SetStateRolesChange | SetStatusInterfaceCodeChange | SetStatusInterfaceTextChange | SetStoreChange | SetStoresChange | SetSupplyChannelChange | SetSupplyChannelsChange | SetTargetChange | SetTaxCategoryChange | SetTextChange | SetTextLineItemCustomFieldChange | SetTextLineItemCustomTypeChange | SetTextLineItemDescriptionChange | SetTitleChange | SetTransitionsChange | SetValidFromAndUntilChange | SetValidFromChange | SetValidUntilChange | SetValueChange | SetVariantAvailabilityChange | SetVatIdChange | TransitionCustomLineItemStateChange | TransitionLineItemStateChange | TransitionStateChange | UnknownChange | UnpublishChange | UpdateSyncInfoChange | VerifyEmailChange;
 export interface AddAddressChange {
@@ -2191,11 +2191,11 @@ export interface SetAttributeChange {
     /**
      *
      */
-    readonly previousValue: any;
+    readonly previousValue: AttributeValue;
     /**
      *
      */
-    readonly nextValue: any;
+    readonly nextValue: AttributeValue;
 }
 export interface SetAuthorNameChange {
     readonly type: 'SetAuthorNameChange';
@@ -3953,11 +3953,11 @@ export interface SetShippingMethodTaxAmountChange {
     /**
      *
      */
-    readonly nextValue: any;
+    readonly nextValue: ShippingMethodTaxAmountChangeValue;
     /**
      *
      */
-    readonly previousValue: any;
+    readonly previousValue: ShippingMethodTaxAmountChangeValue;
 }
 export interface SetShippingMethodTaxRateChange {
     readonly type: 'SetShippingMethodTaxRateChange';

package/dist/declarations/src/generated/models/common.d.ts

@@ -3,204 +3,6 @@
  * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
  * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
  */
-import { Change } from './change';
-import { Label } from './label';
-/**
- *	A Record captures the differences in a resource between one version and the next.
- *	(Recall that the version number is not always incremented by one; see [Optimistic Concurrency Control](/general-concepts#optimistic-concurrency-control).)
- *
- */
-export interface Record {
-    /**
-     *	Version of the resource after the change.
-     *
-     */
-    readonly version: number;
-    /**
-     *	Version of the resource before the change.
-     *
-     */
-    readonly previousVersion: number;
-    /**
-     *	Type of the change (creation, update or deletion).
-     *
-     */
-    readonly type: string;
-    /**
-     *	Information about the user or the API client who performed the change.
-     *
-     */
-    readonly modifiedBy: ModifiedBy;
-    /**
-     *	Date and time when the change was made.
-     *
-     */
-    readonly modifiedAt: string;
-    /**
-     *	Information that describes the resource after the change.
-     *
-     */
-    readonly label: Label;
-    /**
-     *	Information that describes the resource before the change.
-     *
-     */
-    readonly previousLabel: Label;
-    /**
-     *	Shows the differences in the resource between `previousVersion` and `version`.
-     *	The value is not identical to the actual array of update actions that was sent to the platform and is not limited to update actions (see, for example, [Optimistic  Concurrency Control](/general-concepts#optimistic-concurrency-control)).
-     *
-     *
-     */
-    readonly changes: Change[];
-    /**
-     *	[Reference](/types#reference) to the changed resource.
-     *
-     *
-     */
-    readonly resource: Reference;
-    /**
-     *	`true` if no change was detected.
-     *	The version number of the resource can be increased even without any change in the resource.
-     *
-     *
-     */
-    readonly withoutChanges: boolean;
-}
-/**
- *	Response to a query request for [Record](#record).
- *
- */
-export interface RecordPagedQueryResponse {
-    /**
-     *	Maximum number of results requested in the query request.
-     *
-     *
-     */
-    readonly limit: number;
-    /**
-     *	Actual number of results returned.
-     *
-     *
-     */
-    readonly count: number;
-    /**
-     *	Total number of results matching the query.
-     *	This number is an estimation and not [strongly consistent](/general-concepts#strong-consistency).
-     *
-     *
-     */
-    readonly total: number;
-    /**
-     *	The number of elements skipped, not a page number. Supplied by the client or the server default.
-     *
-     *
-     */
-    readonly offset: number;
-    /**
-     *
-     */
-    readonly results: Record[];
-}
-/**
- *	This data type represents the supported resource types.
- *	The value must be one of the following:
- *
- */
-export declare type ChangeHistoryResourceType = 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-group' | 'discount-code' | 'inventory-entry' | 'key-value-document' | 'order' | 'payment' | 'product' | 'product-discount' | 'product-type' | 'review' | 'shopping-list' | 'state' | 'store' | 'tax-category' | 'type' | 'zone';
-/**
- *	This type consists of one enum value:
- *
- */
-export declare type DateStringFilter = 'now';
-export interface ErrorObject {
-    /**
-     *
-     */
-    readonly code: string;
-    /**
-     *
-     */
-    readonly message: string;
-}
-export interface ErrorResponse {
-    /**
-     *
-     */
-    readonly statusCode: number;
-    /**
-     *
-     */
-    readonly message: string;
-    /**
-     *
-     */
-    readonly error?: string;
-    /**
-     *
-     */
-    readonly error_description?: string;
-    /**
-     *
-     */
-    readonly errors?: ErrorObject[];
-}
-/**
- *	Information about the user or the API client who performed the change. This is a variant of
- *	[LastModifiedBy](/types#lastmodifiedby).
- *
- */
-export interface ModifiedBy {
-    /**
-     *	[ID](/general-concepts#identifier) of the Merchant Center user who made the change.
-     *	Present only if the change was made in the Merchant Center.
-     *
-     *
-     */
-    readonly id: string;
-    /**
-     *	Indicates whether the change was made by a user or the API client with or without an
-     *	[External user ID](/client-logging#external-user-ids).
-     *
-     *
-     */
-    readonly type: string;
-    /**
-     *	[Reference](/types#reference) to the
-     *	[Customer](/projects/customers#customer) who made the change. Present only if
-     *	the change was made using a token from the [Password
-     *	Flow](/authorization#password-flow).
-     *
-     *
-     */
-    readonly customer?: Reference;
-    /**
-     *	Present only if the change was made using a token from an [Anonymous
-     *	Session](/authorization#tokens-for-anonymous-sessions).
-     *
-     *
-     */
-    readonly anonymousId?: string;
-    /**
-     *	[ID](/general-concepts#identifier) of the [API
-     *	Client](/projects/api-clients#apiclient) that made the change. Present only if
-     *	the change was made using an API Client.
-     *
-     *
-     */
-    readonly clientId?: string;
-    /**
-     *	`true` if the change was made via Merchant Center or [ImpEx](https://impex.europe-west1.gcp.commercetools.com/).
-     *
-     *
-     */
-    readonly isPlatformClient: boolean;
-}
-/**
- *	Values for the Source enumeration.
- */
-export declare type Source = 'ApiClient' | 'ImpEx' | 'MerchantCenter';
-export declare type UpdateType = 'addAddress' | 'addAsset' | 'addAttributeDefinition' | 'addBillingAddressId' | 'addDelivery' | 'addEnumValue' | 'addExternalImage' | 'addFieldDefinition' | 'addInterfaceInteraction' | 'addItemShippingAddress' | 'addLineItem' | 'addLocalizedEnumValue' | 'addLocation' | 'addParcelToDelivery' | 'addPayment' | 'addPlainEnumValue' | 'addPrice' | 'addReturnInfo' | 'addRoles' | 'addShippingAddressId' | 'addTaxRate' | 'addTextLineItem' | 'addToCategory' | 'addTransaction' | 'addVariant' | 'changeAddress' | 'changeAmountPlanned' | 'changeAssetName' | 'changeAssetOrder' | 'changeAttributeConstraint' | 'changeAttributeName' | 'changeAttributeOrderByName' | 'changeCartDiscounts' | 'changeCartPredicate' | 'changeDescription' | 'changeEmail' | 'changeEnumKey' | 'changeEnumValueLabel' | 'changeEnumValueOrder' | 'changeFieldDefinitionOrder' | 'changeGroups' | 'changeInitial' | 'changeInputHint' | 'changeIsActive' | 'changeIsSearchable' | 'changeKey' | 'changeLabel' | 'changeLineItemQuantity' | 'changeLineItemsOrder' | 'changeLocalizedEnumValueLabel' | 'changeLocalizedEnumValueOrder' | 'changeMasterVariant' | 'changeName' | 'changeOrderHint' | 'changeOrderState' | 'changeParent' | 'changePaymentState' | 'changePlainEnumValueLabel' | 'changePredicate' | 'changePrice' | 'changeQuantity' | 'changeRequiresDiscountCode' | 'changeReviewRatingStatistics' | 'changeShipmentState' | 'changeSlug' | 'changeSortOrder' | 'changeStackingMode' | 'changeTarget' | 'changeTextLineItemName' | 'changeTextLineItemQuantity' | 'changeTextLineItemsOrder' | 'changeTransactionInteractionId' | 'changeTransactionState' | 'changeTransactionTimestamp' | 'changeType' | 'changeValue' | 'publish' | 'removeAddress' | 'removeAsset' | 'removeAttributeDefinition' | 'removeBillingAddressId' | 'removeDelivery' | 'removeEnumValues' | 'removeFieldDefinition' | 'removeFromCategory' | 'removeImage' | 'removeItemShippingAddress' | 'removeLineItem' | 'removeLocation' | 'removeParcelFromDelivery' | 'removePayment' | 'removePrice' | 'removeRoles' | 'removeShippingAddressId' | 'removeTaxRate' | 'removeTextLineItem' | 'removeVariant' | 'setAddress' | 'setAnonymousId' | 'setAssetCustomField' | 'setAssetCustomType' | 'setAssetDescription' | 'setAssetSources' | 'setAssetTags' | 'setAsssetKey' | 'setAttribute' | 'setAuthorName' | 'setBillingAddress' | 'setCartPredicate' | 'setCategoryOrderHint' | 'setCompanyName' | 'setCustomField' | 'setCustomLineItemCustomField' | 'setCustomLineItemCustomType' | 'setCustomLineItemShippingDetails' | 'setCustomType' | 'setCustomer' | 'setCustomerEmail' | 'setCustomerGroup' | 'setCustomerId' | 'setCustomerNumber' | 'setDateOfBirth' | 'setDefaultBillingAddress' | 'setDefaultShippingAddress' | 'setDeleteDaysAfterLastModification' | 'setDeliveryAddress' | 'setDeliveryItems' | 'setDescription' | 'setDiscountedPrice' | 'setDistributionChannels' | 'setExpectedDelivery' | 'setExternalId' | 'setFirstName' | 'setGeoLocation' | 'setImageLabel' | 'setInputTip' | 'setInterfaceId' | 'setKey' | 'setLanguages' | 'setLastName' | 'setLineItemCustomField' | 'setLineItemCustomType' | 'setLineItemShippingDetails' | 'setLocale' | 'setMaxApplications' | 'setMaxApplicationsPerCustomer' | 'setMetaDescription' | 'setMetaKeywords' | 'setMetaTitle' | 'setMethodInfoInterface' | 'setMethodInfoMethod' | 'setMethodInfoName' | 'setMiddleName' | 'setName' | 'setOrderNumber' | 'setParcelItems' | 'setParcelMeasurements' | 'setParcelTrackingData' | 'setPassword' | 'setProductPriceCustomField' | 'setProductPriceCustomType' | 'setProductVariantKey' | 'setRating' | 'setRestockableInDays' | 'setReturnPaymentState' | 'setReturnShipmentState' | 'setRoles' | 'setSalutation' | 'setSearchKeywords' | 'setShippingAddress' | 'setSku' | 'setSlug' | 'setStatusInterfaceCode' | 'setStatusInterfaceText' | 'setStore' | 'setStores' | 'setSupplyChannel' | 'setTarget' | 'setTaxCategory' | 'setText' | 'setTextLineItemCustomField' | 'setTextLineItemCustomType' | 'setTextLineItemDescription' | 'setTitle' | 'setTransitions' | 'setValidFrom' | 'setValidFromAndUntil' | 'setValidUntil' | 'setVariantAvailability' | 'setVatId' | 'transitionCustomLineItemState' | 'transitionLineItemState' | 'transitionState' | 'unpublish' | 'updateItemShippingAddress' | 'updateSyncInfo' | 'verifyEmail';
 export interface LocalizedString {
     [key: string]: string;
 }
@@ -362,7 +164,7 @@ export interface AttributeDefinition {
     /**
      *
      */
-    readonly type: any;
+    readonly type: AttributeType;
     /**
      *	The unique name of the attribute used in the API. The name must be between two and 256 characters long and can contain the ASCII letters A to Z in lowercase or uppercase, digits, underscores (`_`) and the hyphen-minus (`-`). When using the same `name` for an attribute in two or more product types all fields of the AttributeDefinition of this attribute need to be the same across the product types, otherwise an AttributeDefinitionAlreadyExists error code will be returned. An exception to this are the values of an `enum` or `lenum` type and sets thereof.
      *
@@ -395,6 +197,12 @@ export interface AttributeDefinition {
      */
     readonly isSearchable: boolean;
 }
+export interface AttributeType {
+    /**
+     *
+     */
+    readonly name: string;
+}
 export interface CategoryOrderHints {
     [key: string]: string;
 }
@@ -523,10 +331,9 @@ export interface DiscountedLineItemPriceForQuantity {
 }
 export interface FieldDefinition {
     /**
-     *	Describes the type of the field.
      *
      */
-    readonly type: any;
+    readonly type: FieldType;
     /**
      *	The name of the field. The name must be between two and 36 characters long and can contain the ASCII letters A to Z in lowercase or uppercase, digits, underscores (`_`) and the hyphen-minus (`-`). The name must be unique for a given resource type ID. In case there is a field with the same name in another type it has to have the same FieldType also.
      *
@@ -541,6 +348,12 @@ export interface FieldDefinition {
      */
     readonly inputHint: TextInputHint;
 }
+export interface FieldType {
+    /**
+     *
+     */
+    readonly name: string;
+}
 export interface GeoLocation {
     /**
      *
@@ -608,6 +421,16 @@ export interface ItemState {
      */
     readonly state: Reference;
 }
+export interface KeyReference {
+    /**
+     *
+     */
+    readonly key: string;
+    /**
+     *
+     */
+    readonly typeId: ReferenceTypeId;
+}
 export interface LineItem {
     /**
      *
@@ -733,7 +556,6 @@ export interface PaymentInfo {
     readonly payments: Reference[];
 }
 export declare type PaymentState = 'BalanceDue' | 'CreditOwed' | 'Failed' | 'Paid' | 'Pending';
-export declare type PlatformInitiatedChange = 'changeLineItemName' | 'changeReviewRatingStatistics' | 'excludeAll' | 'setApplicationVersion' | 'setIsValid' | 'setVariantAvailability';
 export interface Price {
     /**
      *

package/package.json

@@ -4,7 +4,7 @@
     "access": "public"
   },
   "name": "@commercetools/history-sdk",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Type script sdk for commercetools audit log features",
   "keywords": ["commercetools", "typescript", "sdk", "history"],
   "homepage": "https://github.com/commercetools/commercetools-typescript-sdks/packages/history-sdk",
@@ -23,14 +23,14 @@
     "./dist/commercetools-history-sdk.esm.js": "./dist/commercetools-history-sdk.browser.esm.js"
   },
   "dependencies": {
-    "@commercetools/sdk-client-v2": "^1.2.0",
+    "@commercetools/sdk-client-v2": "^1.3.0",
     "@commercetools/sdk-middleware-auth": "^6.0.4",
     "@commercetools/sdk-middleware-http": "^6.0.4",
     "@commercetools/sdk-middleware-logger": "^2.1.1",
     "querystring": "^0.2.1"
   },
   "devDependencies": {
-    "@commercetools/platform-sdk": "2.5.0",
+    "@commercetools/platform-sdk": "2.6.0",
     "@types/uuid": "8.3.4",
     "organize-imports-cli": "0.9.0",
     "tsconfig-replace-paths": "0.0.11",