4.3.0 • Published 3 months ago
@commercetools/history-sdk v4.3.0
Typescript SDK for Composable Commerce Audit log (history) APIs.
Usage examples
Browser environment
<script src="https://unpkg.com/@commercetools/sdk-client-v2@latest/dist/commercetools-sdk-client-v2.umd.js"></script>
<script src="https://unpkg.com/@commercetools/history-sdk@latest/dist/commercetools-history-sdk.umd.js"></script>
<script>
// global: @commercetools/sdk-client-v2
// global: @commercetools/history-sdk
;(function () {
// We can now access the sdk-client-v2 and history-sdk object as:
// const { ClientBuilder } = this['@commercetools/sdk-client-v2']
// const { createApiBuilderFromCtpClient } = this['@commercetools/history-sdk']
// or
// const { ClientBuilder } = window['@commercetools/sdk-client-v2']
// const { createApiBuilderFromCtpClient } = window['@commercetools/history-sdk']
})()
</script>
Node environment
npm install --save @commercetools/sdk-client-v2
npm install --save @commercetools/history-sdk
const {
ClientBuilder,
createAuthForClientCredentialsFlow,
createHttpClient,
} = require('@commercetools/sdk-client-v2')
const { createApiBuilderFromCtpClient } = require('@commercetools/history-sdk')
const fetch = require('node-fetch')
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 sdk-client-v2 also has support for the old syntax
import {
createClient,
createHttpClient,
createAuthForClientCredentialsFlow,
} from '@commercetools/sdk-client-v2'
import { createApiBuilderFromCtpClient } from '@commercetools/history-sdk'
import fetch from 'node-fetch'
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) => {
/*...*/
})
4.3.0
3 months ago
4.2.0
3 months ago
4.1.0
5 months ago
3.6.0
8 months ago
3.4.2
10 months ago
3.5.0
9 months ago
4.0.0
7 months ago
3.4.1
11 months ago
3.4.0
12 months ago
3.3.0
12 months ago
3.2.1
1 year ago
3.2.0
1 year ago
3.1.0
2 years ago
3.0.0
2 years ago
2.6.0
2 years ago
2.5.1
2 years ago
2.5.0
2 years ago
2.4.0
2 years ago
2.3.0
2 years ago
2.2.0
2 years ago
2.1.1
2 years ago
2.1.0
2 years ago
2.0.1
2 years ago
2.0.0
2 years ago
1.20.0
2 years ago
1.19.0
3 years ago
1.18.1
3 years ago
1.18.0
3 years ago
1.17.1
3 years ago
1.17.0
3 years ago
1.16.0
3 years ago
1.15.0
3 years ago
1.14.0
3 years ago
1.13.0
3 years ago
1.12.0
3 years ago