mandrill__minimal

mandrill__minimal

MandrillMinimal - JavaScript client for mandrill__minimal Full documentation for the Mandrill api can be found at https://mandrillapp.com/api/docs This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0.3
• Package version: 0.0.3
• 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 mandrill__minimal --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 mandrill__minimal from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('mandrill__minimal') 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 MandrillMinimal = require('mandrill__minimal');

var api = new MandrillMinimal.UsersApi()

var key = new MandrillMinimal.ApiKey(); // {ApiKey} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getUserInfo(key, callback);

Documentation for API Endpoints

All URIs are relative to https://mandrillapp.com/api/1.0

Class	Method	HTTP request	Description
MandrillMinimal.UsersApi	getUserInfo	POST /users/info	/users/info
MandrillMinimal.UsersApi	ping	POST /users/ping	/users/ping

Documentation for Models

• MandrillMinimal.ApiKey

Documentation for Authorization

All endpoints do not require authorization.