Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@commercetools/history-sdk

commercetools4.7kMIT5.2.1TypeScript support: included

Typescript SDK for Composable Commerce Audit Log features

commercetools, composable commerce, typescript, sdk, history

readme

Typescript SDK for Composable Commerce Audit log (history) APIs.

Usage examples

Browser environment

<script src="https://unpkg.com/@commercetools/ts-client@latest/dist/commercetools-sdk-client-v3.umd.js"></script>
<script src="https://unpkg.com/@commercetools/history-sdk@latest/dist/commercetools-history-sdk.umd.js"></script>
<script>
  // global: @commercetools/ts-client
  // global: @commercetools/history-sdk
  ;(function () {
    //  We can now access the ts-client and history-sdk object as:
    //  const { ClientBuilder } = this['@commercetools/ts-client']
    //  const { createApiBuilderFromCtpClient } = this['@commercetools/history-sdk']
    //  or
    //  const { ClientBuilder } = window['@commercetools/ts-client']
    //  const { createApiBuilderFromCtpClient } = window['@commercetools/history-sdk']
  })()
</script>

Node environment

npm install --save @commercetools/ts-client
npm install --save @commercetools/history-sdk
const {
  ClientBuilder,
  createAuthForClientCredentialsFlow,
  createHttpClient,
} = require('@commercetools/ts-client')
const { createApiBuilderFromCtpClient } = require('@commercetools/history-sdk')

const projectKey = 'mc-project-key'
const authMiddlewareOptions = {
  host: 'https://auth.europe-west1.gcp.commercetools.com',
  projectKey,
  credentials: {
    clientId: 'mc-client-id',
    clientSecret: 'mc-client-secrets',
  },
  oauthUri: '/oauth/token', // - optional: custom oauthUri
  scopes: [`manage_project:${projectKey}`],
  fetch,
}

const httpMiddlewareOptions = {
  host: 'https://history.europe-west1.gcp.commercetools.com',
  fetch,
}

const client = new ClientBuilder()
  .withProjectKey(projectKey)
  .withMiddleware(createAuthForClientCredentialsFlow(authMiddlewareOptions))
  .withMiddleware(createHttpClient(httpMiddlewareOptions))
  .withUserAgentMiddleware()
  .build()

// or
const client = new ClientBuilder()
  .withProjectKey(projectKey)
  .withClientCredentialsFlow(authMiddlewareOptions)
  .withHttpMiddleware(httpMiddlewareOptions)
  .withUserAgentMiddleware()
  .build()

const apiRoot = createApiBuilderFromCtpClient(client)

// calling the history-sdk functions
// get project details
apiRoot
  .withProjectKey({ projectKey })
  .recommendations()
  .projectCategories()
  .withProductId({
    productId: product.id,
  })
  .get()
  .execute()
  .then((x) => {
    /*...*/
  })

apiRoot
  .withProjectKey({ projectKey })
  .imageSearch()
  .post({
    queryArgs: {
      limit: 20,
    },
    body: image,
    headers: {
      'Content-Type': 'image/jpeg',
    },
  })
  .execute()
  .then((x) => {
    /*...*/
  })

// -----------------------------------------------------------------------
// The ts-client also has support for the old syntax
import {
  createClient,
  createHttpClient,
  createAuthForClientCredentialsFlow,
} from '@commercetools/ts-client'
import { createApiBuilderFromCtpClient } from '@commercetools/history-sdk'

const projectKey = 'some_project_key'

const authMiddleware = createAuthForClientCredentialsFlow({
  host: 'https://auth.europe-west1.gcp.commercetools.com',
  projectKey,
  credentials: {
    clientId: 'some_id',
    clientSecret: 'some_secret',
  },
  fetch,
})

const httpMiddleware = createHttpClient({
  host: 'https://history.europe-west1.gcp.commercetools.com',
  fetch,
})

const ctpClient = createClient({
  middlewares: [authMiddleware, httpMiddleware],
})

const apiRoot = createApiBuilderFromCtpClient(ctpClient)

apiRoot
  .withProjectKey({ projectKey })
  .recommendations()
  .projectCategories()
  .withProductId({
    productId: product.id,
  })
  .get()
  .execute()
  .then((x) => {
    /*...*/
  })

apiRoot
  .withProjectKey({ projectKey })
  .imageSearch()
  .post({
    queryArgs: {
      limit: 20,
    },
    body: image,
    headers: {
      'Content-Type': 'image/jpeg',
    },
  })
  .execute()
  .then((x) => {
    /*...*/
  })

changelog

@commercetools/history-sdk

5.2.1

Patch Changes

5.2.0

Minor Changes

  • #941 745f2c0 Thanks @ct-sdks! - History changes

    <summary>Removed Enum(s)</summary>
    • :warning: removed enum setAsssetKey from type UpdateType
<summary>Added Enum(s)</summary>
  • added enum setAssetKey to type UpdateType
  • #936 f702837 Thanks @barbara79! - updated documentation with client v3

  • 5.1.0

    Minor Changes

    • #907 c5344e3 Thanks @ct-sdks! - History changes

      <summary>Required Property(s)</summary>
      • :warning: changed property triggerPattern of type ChangeTargetPatternChangeValue to be required

    5.0.0

    Major Changes

    Patch Changes

    4.10.0

    Minor Changes

    • #891 4a003ca Thanks @ct-sdks! - History changes

      <summary>Added Resource(s)</summary>
      • added resource /{projectKey}/graphql
    <summary>Added Method(s)</summary>
    • added method apiRoot.withProjectKeyValue().graphql().post()
    <summary>Added Type(s)</summary>
    • added type GraphQLRequest
    • added type GraphQLResponse
    • added type GraphQLError
    • added type GraphQLErrorLocation
    • added type GraphQLVariablesMap
    • added type ChangeTargetPatternChangeValue
    • added type PatternComponent
    <summary>Required Property(s)</summary>
    • changed property id of type ModifiedBy to be optional

    4.9.0

    Minor Changes

    • #890 9da41f4 Thanks @ct-sdks! - History changes

      <summary>Added Resource(s)</summary>
      • added resource /{projectKey}/graphql
    <summary>Added Method(s)</summary>
    • added method apiRoot.withProjectKeyValue().graphql().post()
    <summary>Added Type(s)</summary>
    • added type GraphQLRequest
    • added type GraphQLResponse
    • added type GraphQLError
    • added type GraphQLErrorLocation
    • added type GraphQLVariablesMap
    • added type ChangeTargetPatternChangeValue
    • added type PatternComponent
    <summary>Required Property(s)</summary>
    • changed property id of type ModifiedBy to be optional

    4.8.0

    Minor Changes

    • #878 90ece88 Thanks @ct-sdks! - History changes

      <summary>Required Property(s)</summary>
      • changed property id of type ModifiedBy to be optional

    4.7.0

    Minor Changes

    • #865 15e3913 Thanks @ct-sdks! - History changes

      <summary>Required Property(s)</summary>
      • changed property id of type ModifiedBy to be optional

    4.6.0

    Minor Changes

    • #853 74f1c30 Thanks @ct-sdks! - History changes

      <summary>Required Property(s)</summary>
      • changed property id of type ModifiedBy to be optional

    4.5.0

    Minor Changes

    • #844 03e722b Thanks @ct-sdks! - History changes

      <summary>Required Property(s)</summary>
      • changed property id of type ModifiedBy to be optional

    4.4.0

    Minor Changes

    • #837 cd54482 Thanks @ct-sdks! - History changes

      <summary>Required Property(s)</summary>
      • changed property id of type ModifiedBy to be optional

    4.3.0

    Minor Changes

    4.2.0

    Minor Changes

    • #587 4b14237 Thanks @ct-sdks! - History changes

      <summary>Removed Type(s)</summary>
      • :warning: removed type ChannelRole
      • :warning: removed type StateRole
      • :warning: removed type StateType
    <summary>Added Type(s)</summary>
    • added type AttributeLocalizedEnumValue
    • added type AttributePlainEnumValue
    • added type ChannelRoleEnum
    • added type StateRoleEnum
    • added type StateTypeEnum
    <summary>Removed Property(s)</summary>
    • :warning: removed property previousValue from type AddAddressChange
    • :warning: removed property previousValue from type AddLocationChange
    • :warning: removed property nextValue from type RemoveLocationChange
    • :warning: removed property nextValue from type RemoveTaxRateChange
    <summary>Changed Property(s)</summary>
    • :warning: changed property previousValue of type AddChannelRolesChange from type ChannelRole[] to ChannelRoleEnum[]
    • :warning: changed property nextValue of type AddChannelRolesChange from type ChannelRole[] to ChannelRoleEnum[]
    • :warning: changed property nextValue of type AddLocalizedEnumValueChange from type LocalizedEnumValue to AttributeLocalizedEnumValue
    • :warning: changed property nextValue of type AddPlainEnumValueChange from type EnumValue to AttributePlainEnumValue
    • :warning: changed property previousValue of type AddStateRolesChange from type StateRole[] to StateRoleEnum[]
    • :warning: changed property nextValue of type AddStateRolesChange from type StateRole[] to StateRoleEnum[]
    • :warning: changed property previousValue of type ChangeStateTypeChange from type StateType to StateTypeEnum
    • :warning: changed property nextValue of type ChangeStateTypeChange from type StateType to StateTypeEnum
    • :warning: changed property previousValue of type RemoveChannelRolesChange from type ChannelRole[] to ChannelRoleEnum[]
    • :warning: changed property nextValue of type RemoveChannelRolesChange from type ChannelRole[] to ChannelRoleEnum[]
    • :warning: changed property previousValue of type RemoveStateRolesChange from type StateRole[] to StateRoleEnum[]
    • :warning: changed property nextValue of type RemoveStateRolesChange from type StateRole[] to StateRoleEnum[]
    • :warning: changed property previousValue of type SetChannelRolesChange from type ChannelRole[] to ChannelRoleEnum[]
    • :warning: changed property nextValue of type SetChannelRolesChange from type ChannelRole[] to ChannelRoleEnum[]
    • :warning: changed property previousValue of type SetStateRolesChange from type StateRole[] to StateRoleEnum[]
    • :warning: changed property nextValue of type SetStateRolesChange from type StateRole[] to StateRoleEnum[]

    4.1.0

    Minor Changes

    • #553 8e0a312 Thanks @github-actions! - Api changes

      <summary>Added QueryParameter(s)</summary>
      • added query parameter expand to method get /{projectKey}/in-store/key={storeKey}/cart-discounts
      • added query parameter sort to method get /{projectKey}/in-store/key={storeKey}/cart-discounts
      • added query parameter limit to method get /{projectKey}/in-store/key={storeKey}/cart-discounts
      • added query parameter offset to method get /{projectKey}/in-store/key={storeKey}/cart-discounts
      • added query parameter withTotal to method get /{projectKey}/in-store/key={storeKey}/cart-discounts
      • added query parameter where to method get /{projectKey}/in-store/key={storeKey}/cart-discounts
      • added query parameter /^var[.][a-zA-Z0-9]+$/ to method get /{projectKey}/in-store/key={storeKey}/cart-discounts
      • added query parameter expand to method post /{projectKey}/in-store/key={storeKey}/cart-discounts
    <summary>Changed MethodResponseBody(s)</summary>
    • :warning: changed response body for 200: application/json of method get /{projectKey}/in-store/key={storeKey}/cart-discounts from type CartDiscount to CartDiscountPagedQueryResponse

    4.0.0

    Major Changes

    Minor Changes

    • #527 00c6176 Thanks @github-actions! - History changes

      <summary>Added Property(s)</summary>
      • added property businessUnit to type Record
    <summary>Changed Property(s)</summary>
    • :warning: changed property previousValue of type SetNameChange from type LocalizedString to string
    • :warning: changed property nextValue of type SetNameChange from type LocalizedString to string
    <summary>Added QueryParameter(s)</summary>
    • added query parameter businessUnit to method get /{projectKey}
    • added query parameter businessUnit to method get /{projectKey}/{resourceType}
    • added query parameter businessUnit to method get /{projectKey}/{resourceType}/{ID}

    Patch Changes

    3.6.0

    Minor Changes

    • 0e0c5bf Thanks @jenschude! - History changes

      <summary>Added QueryParameter(s)</summary>
      • added query parameter associateId to method get /{projectKey}
      • added query parameter associateId to method get /{projectKey}/{resourceType}
      • added query parameter associateId to method get /{projectKey}/{resourceType}/{ID}
    <summary>Added Property(s)</summary>
    • added property associate to type ModifiedBy

    3.5.0

    Minor Changes

    • #514 800c52f Thanks @github-actions! - History changes

      <summary>Added Type(s)</summary>
      • added type AddInheritedAssociateChange
      • added type AssociateRoleLabel
      • added type ChangeBuyerAssignableChange
      • added type ChangeInheritedAssociateChange
      • added type InheritedAssociate
      • added type InheritedAssociateRoleAssignment
      • added type Permission
      • added type RemoveInheritedAssociateChange
      • added type SetLocalizedNameChange
      • added type SetPermissionsChange
    <summary>Added Enum(s)</summary>
    • added enum associate-role to type ChangeHistoryResourceType

    3.4.2

    Patch Changes

    • #487 d22b639 Thanks @github-actions! - Update generated SDKs

      Api (Platform) changes

      <summary>Added Property(s)</summary>
      • added property perMethodTaxRate to type CustomLineItem
      • added property key to type LineItem
      • added property key to type LineItemDraft
      • added property key to type CartAddLineItemAction
      • added property lineItemKey to type CartApplyDeltaToLineItemShippingDetailsTargetsAction
      • added property lineItemKey to type CartChangeLineItemQuantityAction
      • added property lineItemKey to type CartRemoveLineItemAction
      • added property lineItemKey to type CartSetLineItemCustomFieldAction
      • added property lineItemKey to type CartSetLineItemCustomTypeAction
      • added property lineItemKey to type CartSetLineItemDistributionChannelAction
      • added property lineItemKey to type CartSetLineItemInventoryModeAction
      • added property lineItemKey to type CartSetLineItemPriceAction
      • added property lineItemKey to type CartSetLineItemShippingDetailsAction
      • added property lineItemKey to type CartSetLineItemSupplyChannelAction
      • added property lineItemKey to type CartSetLineItemTaxAmountAction
      • added property lineItemKey to type CartSetLineItemTaxRateAction
      • added property lineItemKey to type CartSetLineItemTotalPriceAction
      • added property key to type MyLineItemDraft
      • added property key to type MyCartAddLineItemAction
      • added property lineItemKey to type MyCartApplyDeltaToLineItemShippingDetailsTargetsAction
      • added property lineItemKey to type MyCartChangeLineItemQuantityAction
      • added property lineItemKey to type MyCartRemoveLineItemAction
      • added property lineItemKey to type MyCartSetLineItemCustomFieldAction
      • added property lineItemKey to type MyCartSetLineItemCustomTypeAction
      • added property lineItemKey to type MyCartSetLineItemDistributionChannelAction
      • added property lineItemKey to type MyCartSetLineItemShippingDetailsAction
      • added property lineItemKey to type MyCartSetLineItemSupplyChannelAction
      • added property lineItemKey to type MyShoppingListChangeLineItemQuantityAction
      • added property sku to type StandalonePriceDeletedMessage
      • added property sku to type StandalonePriceDeletedMessagePayload
      • added property key to type StagedOrderAddLineItemAction
      • added property parcelKey to type StagedOrderAddParcelToDeliveryAction
      • added property lineItemKey to type StagedOrderChangeLineItemQuantityAction
      • added property lineItemKey to type StagedOrderRemoveLineItemAction
      • added property parcelKey to type StagedOrderRemoveParcelFromDeliveryAction
      • added property lineItemKey to type StagedOrderSetLineItemCustomFieldAction
      • added property lineItemKey to type StagedOrderSetLineItemCustomTypeAction
      • added property lineItemKey to type StagedOrderSetLineItemDistributionChannelAction
      • added property lineItemKey to type StagedOrderSetLineItemPriceAction
      • added property lineItemKey to type StagedOrderSetLineItemShippingDetailsAction
      • added property lineItemKey to type StagedOrderSetLineItemTaxAmountAction
      • added property lineItemKey to type StagedOrderSetLineItemTaxRateAction
      • added property lineItemKey to type StagedOrderSetLineItemTotalPriceAction
      • added property parcelKey to type StagedOrderSetParcelCustomFieldAction
      • added property parcelKey to type StagedOrderSetParcelCustomTypeAction
      • added property parcelKey to type StagedOrderSetParcelItemsAction
      • added property parcelKey to type StagedOrderSetParcelMeasurementsAction
      • added property parcelKey to type StagedOrderSetParcelTrackingDataAction
      • added property key to type Parcel
      • added property key to type ParcelDraft
      • added property parcelKey to type OrderAddParcelToDeliveryAction
      • added property parcelKey to type OrderRemoveParcelFromDeliveryAction
      • added property lineItemKey to type OrderSetLineItemCustomFieldAction
      • added property lineItemKey to type OrderSetLineItemCustomTypeAction
      • added property lineItemKey to type OrderSetLineItemShippingDetailsAction
      • added property parcelKey to type OrderSetParcelCustomFieldAction
      • added property parcelKey to type OrderSetParcelCustomTypeAction
      • added property parcelKey to type OrderSetParcelItemsAction
      • added property parcelKey to type OrderSetParcelMeasurementsAction
      • added property parcelKey to type OrderSetParcelTrackingDataAction
    <summary>Required Property(s)</summary>
    • changed property lineItemId of type CartApplyDeltaToLineItemShippingDetailsTargetsAction to be optional
    • changed property lineItemId of type CartChangeLineItemQuantityAction to be optional
    • changed property lineItemId of type CartRemoveLineItemAction to be optional
    • changed property lineItemId of type CartSetLineItemCustomFieldAction to be optional
    • changed property lineItemId of type CartSetLineItemCustomTypeAction to be optional
    • changed property lineItemId of type CartSetLineItemDistributionChannelAction to be optional
    • changed property lineItemId of type CartSetLineItemInventoryModeAction to be optional
    • changed property lineItemId of type CartSetLineItemPriceAction to be optional
    • changed property lineItemId of type CartSetLineItemShippingDetailsAction to be optional
    • changed property lineItemId of type CartSetLineItemSupplyChannelAction to be optional
    • changed property lineItemId of type CartSetLineItemTaxAmountAction to be optional
    • changed property lineItemId of type CartSetLineItemTaxRateAction to be optional
    • changed property lineItemId of type CartSetLineItemTotalPriceAction to be optional
    • changed property lineItemId of type MyCartApplyDeltaToLineItemShippingDetailsTargetsAction to be optional
    • changed property lineItemId of type MyCartChangeLineItemQuantityAction to be optional
    • changed property lineItemId of type MyCartRemoveLineItemAction to be optional
    • changed property lineItemId of type MyCartSetLineItemCustomFieldAction to be optional
    • changed property lineItemId of type MyCartSetLineItemCustomTypeAction to be optional
    • changed property lineItemId of type MyCartSetLineItemDistributionChannelAction to be optional
    • changed property lineItemId of type MyCartSetLineItemShippingDetailsAction to be optional
    • changed property lineItemId of type MyCartSetLineItemSupplyChannelAction to be optional
    • changed property lineItemId of type MyShoppingListChangeLineItemQuantityAction to be optional
    • changed property lineItemId of type StagedOrderChangeLineItemQuantityAction to be optional
    • changed property lineItemId of type StagedOrderRemoveLineItemAction to be optional
    • changed property parcelId of type StagedOrderRemoveParcelFromDeliveryAction to be optional
    • changed property lineItemId of type StagedOrderSetLineItemCustomFieldAction to be optional
    • changed property lineItemId of type StagedOrderSetLineItemCustomTypeAction to be optional
    • changed property lineItemId of type StagedOrderSetLineItemDistributionChannelAction to be optional
    • changed property lineItemId of type StagedOrderSetLineItemPriceAction to be optional
    • changed property lineItemId of type StagedOrderSetLineItemShippingDetailsAction to be optional
    • changed property lineItemId of type StagedOrderSetLineItemTaxAmountAction to be optional
    • changed property lineItemId of type StagedOrderSetLineItemTaxRateAction to be optional
    • changed property lineItemId of type StagedOrderSetLineItemTotalPriceAction to be optional
    • changed property parcelId of type StagedOrderSetParcelCustomFieldAction to be optional
    • changed property parcelId of type StagedOrderSetParcelCustomTypeAction to be optional
    • changed property parcelId of type StagedOrderSetParcelItemsAction to be optional
    • changed property parcelId of type StagedOrderSetParcelMeasurementsAction to be optional
    • changed property parcelId of type StagedOrderSetParcelTrackingDataAction to be optional
    • changed property parcelId of type OrderRemoveParcelFromDeliveryAction to be optional
    • changed property lineItemId of type OrderSetLineItemCustomFieldAction to be optional
    • changed property lineItemId of type OrderSetLineItemCustomTypeAction to be optional
    • changed property lineItemId of type OrderSetLineItemShippingDetailsAction to be optional
    • changed property parcelId of type OrderSetParcelCustomFieldAction to be optional
    • changed property parcelId of type OrderSetParcelCustomTypeAction to be optional
    • changed property parcelId of type OrderSetParcelItemsAction to be optional
    • changed property parcelId of type OrderSetParcelMeasurementsAction to be optional
    • changed property parcelId of type OrderSetParcelTrackingDataAction to be optional
    <summary>Deprecated Property(s)</summary>
    • property MyCartChangeLineItemQuantityAction::externalPrice is removed
    • property MyCartChangeLineItemQuantityAction::externalTotalPrice is removed
    <summary>Deprecated Type(s)</summary>
    • type ProductVariantSelectionExclusion is removed
    • type ProductVariantSelectionInclusion is removed
    <summary>Removed Type(s)</summary>
    • :warning: removed type MyCartSetDirectDiscountsAction
    <summary>Added Type(s)</summary>
    • added type StandalonePriceTierAddedMessage
    • added type StandalonePriceTierRemovedMessage
    • added type StandalonePriceTiersSetMessage
    • added type StandalonePriceValidFromAndUntilSetMessage
    • added type StandalonePriceValidFromSetMessage
    • added type StandalonePriceValidUntilSetMessage
    • added type StandalonePriceTierAddedMessagePayload
    • added type StandalonePriceTierRemovedMessagePayload
    • added type StandalonePriceTiersSetMessagePayload
    • added type StandalonePriceValidFromAndUntilSetMessagePayload
    • added type StandalonePriceValidFromSetMessagePayload
    • added type StandalonePriceValidUntilSetMessagePayload
    • added type StandalonePriceAddPriceTierAction
    • added type StandalonePriceRemovePriceTierAction
    • added type StandalonePriceSetPriceTiersAction
    • added type StandalonePriceSetValidFromAction
    • added type StandalonePriceSetValidFromAndUntilAction
    • added type StandalonePriceSetValidUntilAction
    • added type ConfluentCloudDestination
    <summary>Added Enum(s)</summary>
    • added enum associate-role to type CustomFieldReferenceValue
    • added enum business-unit to type CustomFieldReferenceValue

    Import changes

    <summary>Added Enum(s)</summary>
    • added enum associate-role to type CustomFieldReferenceValue
    • added enum business-unit to type CustomFieldReferenceValue

    History change

    <summary>Added Property(s)</summary>
    • added property variantSelection to type AddProductChange
    <summary>Changed Property(s)</summary>
    • :warning: changed property resource of type Record from type Reference to ResourceIdentifier
    <summary>Added QueryParameter(s)</summary>
    • added query parameter resourceKey to method get /{projectKey}
    • added query parameter resourceKey to method get /{projectKey}/{resourceType}
    <summary>Removed QueryParameter(s)</summary>
    • :warning: removed query parameter resourceId from method get /{projectKey}/{resourceType}
    <summary>Added Type(s)</summary>
    • added type AddAssociateChange
    • added type AddProductSelectionChange
    • added type Associate
    • added type AssociateRoleAssignment
    • added type AssociateRoleInheritanceMode
    • added type BusinessUnitAssociateMode
    • added type BusinessUnitLabel
    • added type BusinessUnitStatus
    • added type BusinessUnitStoreMode
    • added type ChangeAssociateChange
    • added type ChangeAssociateModeChange
    • added type ChangeParentUnitChange
    • added type ChangeProductSelectionActiveChange
    • added type ChangeStatusChange
    • added type ProductVariantSelection
    • added type ProductVariantSelectionTypeEnum
    • added type RemoveAssociateChange
    • added type RemoveProductSelectionChange
    • added type RequestQuoteRenegotiationChange
    • added type ResourceIdentifier
    • added type SetAddressCustomFieldChange
    • added type SetAddressCustomTypeChange
    • added type SetContactEmailChange
    • added type SetStoreModeChange
    • added type SetVariantSelectionChange
    <summary>Added Enum(s)</summary>
    • added enum business-unit to type ChangeHistoryResourceType
    • added enum addAssociate to type UpdateType
    • added enum addCustomLineItem to type UpdateType
    • added enum addDiscountCode to type UpdateType
    • added enum addProduct to type UpdateType
    • added enum addProductSelection to type UpdateType
    • added enum addProperty to type UpdateType
    • added enum changeAmountAuthorized to type UpdateType
    • added enum changeAssociate to type UpdateType
    • added enum changeAssociateMode to type UpdateType
    • added enum changeCustomLineItemQuantity to type UpdateType
    • added enum changeLineItemName to type UpdateType
    • added enum changeParentUnit to type UpdateType
    • added enum changeProductSelectionActive to type UpdateType
    • added enum changeQuoteRequestState to type UpdateType
    • added enum changeQuoteState to type UpdateType
    • added enum changeStagedQuoteState to type UpdateType
    • added enum changeStatus to type UpdateType
    • added enum changeTaxCalculationMode to type UpdateType
    • added enum changeTaxMode to type UpdateType
    • added enum changeTaxRoundingMode to type UpdateType
    • added enum moveImageToPosition to type UpdateType
    • added enum removeAssociate to type UpdateType
    • added enum removeCustomLineItem to type UpdateType
    • added enum removeDiscountCode to type UpdateType
    • added enum removeProduct to type UpdateType
    • added enum removeProductSelection to type UpdateType
    • added enum removeProperty to type UpdateType
    • added enum requestQuoteRenegotiation to type UpdateType
    • added enum setAddressCustomField to type UpdateType
    • added enum setAddressCustomType to type UpdateType
    • added enum setApplicationVersion to type UpdateType
    • added enum setAuthenticationMode to type UpdateType
    • added enum setContactEmail to type UpdateType
    • added enum setCountries to type UpdateType
    • added enum setCountry to type UpdateType
    • added enum setCustomLineItemMoney to type UpdateType
    • added enum setCustomLineItemTaxAmount to type UpdateType
    • added enum setCustomLineItemTaxCategory to type UpdateType
    • added enum setCustomLineItemTaxRate to type UpdateType
    • added enum setCustomLineItemTaxedPrice to type UpdateType
    • added enum setCustomLineItemTotalPrice to type UpdateType
    • added enum setCustomShippingMethod to type UpdateType
    • added enum setIsValid to type UpdateType
    • added enum setLineItemDeactivatedAt to type UpdateType
    • added enum setLineItemDiscountedPrice to type UpdateType
    • added enum setLineItemDiscountedPricePerQuantity to type UpdateType
    • added enum setLineItemDistributionChannel to type UpdateType
    • added enum setLineItemPrice to type UpdateType
    • added enum setLineItemProductKey to type UpdateType
    • added enum setLineItemProductSlug to type UpdateType
    • added enum setLineItemTaxAmount to type UpdateType
    • added enum setLineItemTaxRate to type UpdateType
    • added enum setLineItemTaxedPrice to type UpdateType
    • added enum setLineItemTotalPrice to type UpdateType
    • added enum setOrderTaxedPrice to type UpdateType
    • added enum setOrderTotalPrice to type UpdateType
    • added enum setOrderTotalTax to type UpdateType
    • added enum setPrices to type UpdateType
    • added enum setProductCount to type UpdateType
    • added enum setProductSelections to type UpdateType
    • added enum setProperty to type UpdateType
    • added enum setPurchaseOrderNumber to type UpdateType
    • added enum setReservations to type UpdateType
    • added enum setSellerComment to type UpdateType
    • added enum setShippingInfoPrice to type UpdateType
    • added enum setShippingInfoTaxedPrice to type UpdateType
    • added enum setShippingMethod to type UpdateType
    • added enum setShippingMethodTaxAmount to type UpdateType
    • added enum setShippingMethodTaxRate to type UpdateType
    • added enum setShippingRate to type UpdateType
    • added enum setShippingRateInput to type UpdateType
    • added enum setStoreMode to type UpdateType
    • added enum setSupplyChannels to type UpdateType
    • added enum setValidTo to type UpdateType
    • added enum setValue to type UpdateType
    • added enum setVariantSelection to type UpdateType
    • added enum DeclinedForRenegotiation to type QuoteState
    • added enum associate-role to type ReferenceTypeId
    • added enum business-unit to type ReferenceTypeId

    3.4.1

    Patch Changes

    3.4.0

    Minor Changes

    3.3.0

    Minor Changes

    • #465 efa9194 Thanks @github-actions! - ## Update generated SDKs

      Api changes

      <summary>Changed Type(s)</summary>
      • :warning: changed type AssociateRole from type string to BaseResource
    <summary>Added Type(s)</summary>
    • added type AssociateRoleDraft
    • added type AssociateRoleKeyReference
    • added type AssociateRolePagedQueryResponse
    • added type AssociateRoleReference
    • added type AssociateRoleResourceIdentifier
    • added type AssociateRoleUpdate
    • added type AssociateRoleUpdateAction
    • added type Permission
    • added type AssociateRoleAddPermissionAction
    • added type AssociateRoleChangeBuyerAssignableAction
    • added type AssociateRoleRemovePermissionAction
    • added type AssociateRoleSetCustomFieldAction
    • added type AssociateRoleSetCustomTypeAction
    • added type AssociateRoleSetNameAction
    • added type AssociateRoleSetPermissionsAction
    • added type AssociateRoleAssignment
    • added type AssociateRoleAssignmentDraft
    • added type AssociateRoleDeprecated
    • added type AssociateRoleInheritanceMode
    • added type BusinessUnitAssociateMode
    • added type InheritedAssociate
    • added type InheritedAssociateRoleAssignment
    • added type BusinessUnitChangeAssociateModeAction
    • added type AssociateMissingPermissionError
    • added type GraphQLAssociateMissingPermissionError
    • added type AssociateRoleBuyerAssignableChangedMessage
    • added type AssociateRoleCreatedMessage
    • added type AssociateRoleDeletedMessage
    • added type AssociateRoleNameChangedMessage
    • added type AssociateRolePermissionAddedMessage
    • added type AssociateRolePermissionRemovedMessage
    • added type AssociateRolePermissionsSetMessage
    • added type BusinessUnitAssociateModeChangedMessage
    • added type AssociateRoleBuyerAssignableChangedMessagePayload
    • added type AssociateRoleCreatedMessagePayload
    • added type AssociateRoleDeletedMessagePayload
    • added type AssociateRoleNameChangedMessagePayload
    • added type AssociateRolePermissionAddedMessagePayload
    • added type AssociateRolePermissionRemovedMessagePayload
    • added type AssociateRolePermissionsSetMessagePayload
    • added type BusinessUnitAssociateModeChangedMessagePayload
    • added type ProjectSetBusinessUnitAssociateRoleOnCreationAction
    <summary>Added Enum(s)</summary>
    • added enum associate-role to type ReferenceTypeId
    • added enum associate-role to type MessageSubscriptionResourceTypeId
    • added enum associate-role to type ResourceTypeId
    <summary>Added Property(s)</summary>
    • added property associateRoleAssignments to type Associate
    • added property associateRoleAssignments to type AssociateDraft
    • added property associateMode to type BusinessUnit
    • added property inheritedAssociates to type BusinessUnit
    • added property associateMode to type BusinessUnitDraft
    • added property associateMode to type Company
    • added property inheritedAssociates to type Company
    • added property associateMode to type CompanyDraft
    • added property associateMode to type Division
    • added property inheritedAssociates to type Division
    • added property associateMode to type DivisionDraft
    • added property myBusinessUnitAssociateRoleOnCreation to type BusinessUnitConfiguration
    <summary>Changed Property(s)</summary>
    • :warning: changed property roles of type Associate from type AssociateRole[] to AssociateRoleDeprecated[]
    • :warning: changed property roles of type AssociateDraft from type AssociateRole[] to AssociateRoleDeprecated[]
    <summary>MarkDeprecated Property(s)</summary>
    • marked property Associate::roles as deprecated
    • marked property AssociateDraft::roles as deprecated
    <summary>Added Resource(s)</summary>
    • added resource /{projectKey}/as-associate
    • added resource /{projectKey}/associate-roles
    • added resource /{projectKey}/as-associate/{associateId}
    • added resource /{projectKey}/as-associate/{associateId}/business-units
    • added resource /{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}
    • added resource /{projectKey}/as-associate/{associateId}/business-units/key={key}
    • added resource /{projectKey}/as-associate/{associateId}/business-units/{ID}
    • added resource /{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts
    • added resource /{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders
    • added resource /{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/quotes
    • added resource /{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/quote-requests
    • added resource /{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts/key={key}
    • added resource /{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts/{ID}
    • added resource /{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders/quotes
    • added resource /{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders/order-number={orderNumber}
    • added resource /{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders/{ID}
    • added resource /{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/quotes/key={key}
    • added resource /{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/quotes/{ID}
    • added resource /{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/quote-requests/key={key}
    • added resource /{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/quote-requests/{ID}
    • added resource /{projectKey}/associate-roles/key={key}
    • added resource /{projectKey}/associate-roles/{ID}
    <summary>Added Method(s)</summary>
    • added method apiRoot.withProjectKey().associateRoles().get()
    • added method apiRoot.withProjectKey().associateRoles().post()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().businessUnits().get()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().businessUnits().post()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().businessUnits().withKey().get()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().businessUnits().withKey().post()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().businessUnits().withId().get()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().businessUnits().withId().post()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().carts().get()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().carts().post()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().orders().get()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().orders().post()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().quotes().get()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().quoteRequests().get()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().quoteRequests().post()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().carts().withKey().get()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().carts().withKey().post()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().carts().withKey().delete()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().carts().withId().get()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().carts().withId().post()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().carts().withId().delete()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().orders().orderQuote().post()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().orders().withOrderNumber().get()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().orders().withOrderNumber().post()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().orders().withId().get()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().orders().withId().post()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().quotes().withKey().get()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().quotes().withKey().post()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().quotes().withId().get()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().quotes().withId().post()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().quoteRequests().withKey().get()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().quoteRequests().withKey().post()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().quoteRequests().withId().get()
    • added method apiRoot.withProjectKey().asAssociate().withAssociateIdValue().inBusinessUnitKeyWithBusinessUnitKeyValue().quoteRequests().withId().post()
    • added method apiRoot.withProjectKey().associateRoles().withKey().get()
    • added method apiRoot.withProjectKey().associateRoles().withKey().post()
    • added method apiRoot.withProjectKey().associateRoles().withKey().delete()
    • added method apiRoot.withProjectKey().associateRoles().withId().get()
    • added method apiRoot.withProjectKey().associateRoles().withId().post()
    • added method apiRoot.withProjectKey().associateRoles().withId().delete()

    Import changes

    <summary>Added Enum(s)</summary>
    • added enum type to type ImportResourceType
    <summary>Added Resource(s)</summary>
    • added resource /{projectKey}/types
    • added resource /{projectKey}/types/import-containers
    • added resource /{projectKey}/types/import-containers/{importContainerKey}
    <summary>Added Method(s)</summary>
    • added method apiRoot.withProjectKeyValue().types().importContainers().withImportContainerKeyValue().post()
    <summary>Added Type(s)</summary>
    • added type TypeImportRequest
    • added type TypeTextInputHint
    • added type ResourceTypeId
    • added type FieldType
    • added type CustomFieldBooleanType
    • added type CustomFieldDateTimeType
    • added type CustomFieldDateType
    • added type CustomFieldEnumType
    • added type CustomFieldEnumValue
    • added type CustomFieldLocalizedEnumType
    • added type CustomFieldLocalizedEnumValue
    • added type CustomFieldLocalizedStringType
    • added type CustomFieldMoneyType
    • added type CustomFieldNumberType
    • added type CustomFieldReferenceType
    • added type CustomFieldReferenceValue
    • added type CustomFieldSetType
    • added type CustomFieldStringType
    • added type CustomFieldTimeType
    • added type FieldDefinition
    • added type TypeImport

    History changes

    <summary>Added QueryParameter(s)</summary>
    • added query parameter resourceTypes to method get /{projectKey}
    <summary>Removed QueryParameter(s)</summary>
    • :warning: removed query parameter resourceType from method get /{projectKey}
    <summary>Added Type(s)</summary>
    • added type SetCountriesChange
    • added type SetPurchaseOrderNumberChange
    • added type StoreCountry

    3.2.1

    Patch Changes

    3.2.0

    Minor Changes

    • #371 f6bd1fe Thanks @github-actions! - Update generated SDKs

      Summary

      • The get method of ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDRequestBuilder class now supports an optional stage property
      • The get method of ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyRequestBuilder class now supports an optional stage property

      Snippet

      ...
        queryArgs?: {
      +   staged?: boolean
          priceCurrency?: string
          priceCountry?: string
          priceCustomerGroup?: string,
          ...
        }
        ...
      }) {}
      • The get, post and delete method query args. of ByProjectKeyProductsByIDRequestBuilder class now supports optional localeProjection property
      • The get and post method query args. of the ByProjectKeyProductsRequestBuilder class now supports an optional localeProjection property.
      ...
        queryArgs?: {
          where?: string | string[]
          priceCurrency?: string
          priceCountry?: string
          priceCustomerGroup?: string
          priceChannel?: string
      +   localeProjection?: string | string[]
          expand?: string | string[]
          sort?: string | string[]
          limit?: number
          offset?: number
          withTotal?: boolean
          [key: string]: QueryParam
        }
      ...

      The complete changes can be found here

    Patch Changes

    3.1.0

    Minor Changes

    • #351 9c93a8e Thanks @ajimae! - Update packages

      Update the history-sdk DateStringFilter, ChangeHistoryResourceType, Source and PlatformInitiatedChange etc. models to include a string type

      Diff Diff

      Add builder class and method for standalone-prices for importapi-sdk

      Diff Diff Diff Diff

      Update the importapi-sdk MoneyType, ReferenceType, ProcessingState, ImportOperationState ProductPriceModeEnum etc models to include a string type

      Diff Diff Diff Diff

      Add class and builder methods for ByProjectKeyBusinessUnitsByIDRequestBuilder, ByProjectKeyBusinessUnitsRequestBuilder, ByProjectKeyMeBusinessUnitsKeyByKeyRequestBuilder, ByProjectKeyMeBusinessUnitsRequestBuilder, ByProjectKeyBusinessUnitsKeyByKeyRequestBuilder ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeCustomersRequestBuilder, ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyMeRequestBuilder, ByProjectKeyInBusinessUnitKeyByBusinessUnitKeyRequestBuilder in the platform-sdk

      Diff Diff Diff Diff Diff Diff Diff

      Complete changes can be found here

    Patch Changes

    3.0.0

    Major Changes

    Patch Changes

    2.6.0

    Minor Changes

    • #291 cde61f4 Thanks @github-actions! - ### History API

      • add support for quotes
      • add support for authentication mode
      • add product selection support

      Import API

      • add support for inventory imports
      • remove import sink endpoints

      Platform API

      • add support for quotes
      • fix localeProjection query parameter type
      • add missing query parameters to product selection assigment
      • add HEAD request to product types
      • add DeliveryDraft model
      • removed deprecated fields from Payment models

    2.5.1

    Patch Changes

    2.5.0

    Minor Changes

    Patch Changes

    2.4.0

    Minor Changes

    • #241 85f5be3 Thanks @ajimae! - Releasing the TS SDK with the following changelogs

      • added functionalities to extend client user agent
      • custom field added to OrderFromCardDraft

    Patch Changes

    2.3.0

    Minor Changes

    Patch Changes

    2.2.0

    Minor Changes

    Patch Changes

    2.1.1

    Patch Changes

    2.1.0

    Minor Changes

    Patch Changes

    2.0.1

    Patch Changes

    • #161 f28520f Thanks @ajimae! - Restructure dependencies, remove sdk-client-v2 from devDependencies into dependencies.

    2.0.0

    Major Changes

    1.20.0

    Minor Changes

    Patch Changes

    1.19.0

    Minor Changes

    1.18.1

    Patch Changes

    1.18.0

    Minor Changes

    Patch Changes

    1.17.1

    Patch Changes