mammoth_publish_app v1.0.0

publish_app

PublishApp - JavaScript client for publish_app No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.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 publish_app --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 publish_app from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('publish_app') 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/YOUR_USERNAME/publish_app then install it via:

    npm install YOUR_USERNAME/publish_app --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 PublishApp = require('publish_app');

var defaultClient = PublishApp.ApiClient.instance;

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

var api = new PublishApp.CreateApi()

var body = new PublishApp.CreateReport(); // {CreateReport} Info about workspace and report name.

var X_ACCOUNT_ID = 8.14; // {Number} account id


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

Documentation for API Endpoints

All URIs are relative to https://doraemon.mammoth.io/api/v1/

Documentation for Models

• PublishApp.CreateReport
• PublishApp.ReadAllReports
• PublishApp.ReadAllReportsInner
• PublishApp.ReadOneReport
• PublishApp.ReadOneReportComponents
• PublishApp.ReportCreated

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header