@aghanim1206/[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 @aghanim1206/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- APIKeysApi | apiKeysControllerActivate | PATCH /api-keys/{id}/activate | Activate an API key (master only) APIKeysApi | apiKeysControllerCreate | POST /api-keys | Create a new API key (master only) APIKeysApi | apiKeysControllerDeactivate | PATCH /api-keys/{id}/deactivate | Deactivate an API key (master only) APIKeysApi | apiKeysControllerDelete | DELETE /api-keys/{id} | Delete an API key (master only) APIKeysApi | apiKeysControllerGetAll | GET /api-keys | List all API keys (master only) APIKeysApi | apiKeysControllerGetById | GET /api-keys/{id} | Get an API key by ID (master only) APIKeysApi | apiKeysControllerRegenerate | PATCH /api-keys/{id}/regenerate | Regenerate the key for an existing API key (master only) FilesApi | filesControllerDelete | DELETE /files/{id} | Delete a file by its ID FilesApi | filesControllerGetFile | GET /files/{id} | Download a file by its ID FilesApi | filesControllerGetFileMetadata | GET /files/{id}/metadata | Get metadata of a file by its ID FilesApi | filesControllerUpdate | PUT /files/{id} | Replace an existing file by its ID FilesApi | filesControllerUpload | POST /files/upload | Upload a new file

Documentation For Models

• ApiKeyDto
• ApiKeyWithKeyDto
• CreateApiKeyDto
• FileMetadataDto

Documentation For Authorization

Authentication schemes defined for the API:

x-api-key

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header