@connectedxm/[email protected]
This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run build
Publishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @connectedxm/[email protected] --save
unPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --save
Documentation
All URIs are relative to https://admin-api.connected.dev
Per-endpoint and per-model reference pages are generated into the docs/
directory of this package. They are intentionally not linked here: npm and
GitHub resolve relative links against the source repository, where the
generated SDK is not committed, so the links would all 404.
For browsable API documentation see the published OpenAPI reference.
Documentation For Authorization
Authentication schemes defined for the API:
ApiKeyAuth
- Type: API key
- API key parameter name: api-key
- Location: HTTP header
OrganizationId
- Type: API key
- API key parameter name: organization
- Location: HTTP header