Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 2.09 KB

GenerateSDK.md

File metadata and controls

35 lines (24 loc) · 2.09 KB

Composable Commerce TypeScript SDKs Generation

This repo contains Composable Commerce SDKs and this is a guide on how to generate the Typescript SDK.

Requirements

  • Have java (> 8) installed in your environment.
  • have rm-codegen cli installed.

Building the projects

  • yarn install
  • yarn build

Generating the sdks

run yarn generate to generate the sdks. (make sure the environment variables are set first)

Environment variables

Variable name Description
ML_API_REF The path to Composable Commerce Machine Learning API reference
API_RAML_FILE The path to Composable Commerce HTTP API reference

Test environnement variables

Variable name Description
CTP_PROJECT_KEY Composable Commerce Project key
CTP_CLIENT_ID the client id
CTP_CLIENT_SECRET the client secret
CTP_API_URL the API url (contains infos about the region)
CTP_AUTH_URL the auth url (contains infos about the region)
CTP_ML_API_URL the Machine Learning API uses a different pattern than the HTTP API, use this to access ML services