cloudos-sdk-node v1.0.0

lifebit_api

LifebitApi - JavaScript client for lifebit_api Lifebit API allows users with API key to programatically control Deploit resources (e.g. run a job) This SDK is automatically generated by the Swagger Codegen project:

• API version: 1-oas3
• Package version: 1-oas3
• Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install lifebit_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var LifebitApi = require('lifebit_api');
var defaultClient = LifebitApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['apikey'] = "Token"

var api = new LifebitApi.DefaultApi()
var id = "id_example"; // {String} ID of a job

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.jobsGet(id, callback);

Documentation for API Endpoints

All URIs are relative to https://api.lifebit.ai

Documentation for Models

• LifebitApi.Body
• LifebitApi.EmbeddedFile
• LifebitApi.EmbeddedFileDataItemEmbedded
• LifebitApi.EmbeddedFileDataItemEmbeddedData
• LifebitApi.EmbeddedFolder
• LifebitApi.EmbeddedFolderDataItemEmbedded
• LifebitApi.EmbeddedFolderDataItemEmbeddedData
• LifebitApi.Job
• LifebitApi.JobResults
• LifebitApi.OneOfbodyParametersItems
• LifebitApi.TextParameter

Documentation for Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: apikey
• Location: HTTP header