cloudmersive-configuration-api-client

cloudmersive-configuration-api-client

CloudmersiveConfigurationApiClient - JavaScript client for cloudmersive-configuration-api-client Config API lets you easily manage configuration at scale. Cloudmersive Configuration API provides advanced configuration and orchestration capabilities.

• API version: v1
• Package version: 2.4.3

Installation

For the Cloudmersive Configuration API

npm

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

Then install it via:

npm install cloudmersive-configuration-api-client --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your cloudmersive-configuration-api-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('cloudmersive-configuration-api-client') in javascript files from the directory you ran the last command above from.

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, that's to say your javascript file where you actually use this library):

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 CloudmersiveConfigurationApiClient = require('cloudmersive-configuration-api-client');

var defaultClient = CloudmersiveConfigurationApiClient.ApiClient.instance;

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

var api = new CloudmersiveConfigurationApiClient.OrchestratorApi()

var request = new CloudmersiveConfigurationApiClient.HttpOrchestrationRequest(); // {HttpOrchestrationRequest} 


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

Documentation for API Endpoints

All URIs are relative to https://api.cloudmersive.com

Class	Method	HTTP request	Description
CloudmersiveConfigurationApiClient.OrchestratorApi	orchestratorHttpSimple	POST /config/orchestrator/http/simple	Orchestrate multiple HTTP API calls with a single API call in the order specified. Call other Cloudmersive APIs or third party APIs. For Cloudmersive APIs, the API Key will automatically propogate to the child calls without needing to be set explicitly. Name each task and reference the output of a previous task in the inputs to a given task.
CloudmersiveConfigurationApiClient.SettingsApi	settingsCreateSetting	POST /config/settings/create	Create a setting in the specified bucket
CloudmersiveConfigurationApiClient.SettingsApi	settingsListSettings	POST /config/settings/list	Enumerate the settings in a bucket
CloudmersiveConfigurationApiClient.SettingsApi	settingsUpdateSetting	POST /config/settings/update	Update a setting

Documentation for Models

• CloudmersiveConfigurationApiClient.CreateSettingRequest
• CloudmersiveConfigurationApiClient.CreateSettingResponse
• CloudmersiveConfigurationApiClient.HttpFormDataParameter
• CloudmersiveConfigurationApiClient.HttpGetParameter
• CloudmersiveConfigurationApiClient.HttpOrchestrationHeader
• CloudmersiveConfigurationApiClient.HttpOrchestrationRequest
• CloudmersiveConfigurationApiClient.HttpOrchestrationResponse
• CloudmersiveConfigurationApiClient.HttpOrchestrationTask
• CloudmersiveConfigurationApiClient.HttpRawBinaryParameter
• CloudmersiveConfigurationApiClient.HttpRawTextParameter
• CloudmersiveConfigurationApiClient.HttpWwwFormUrlEncodedParameter
• CloudmersiveConfigurationApiClient.ListSettingsRequest
• CloudmersiveConfigurationApiClient.ListSettingsResponse
• CloudmersiveConfigurationApiClient.SettingValue
• CloudmersiveConfigurationApiClient.TaskOutputReference
• CloudmersiveConfigurationApiClient.UpdateSettingRequest
• CloudmersiveConfigurationApiClient.UpdateSettingResponse

Documentation for Authorization

Apikey

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