mh-sdk-test

v0.8.9

Published

4 years ago

This_is_a_specification_for_Mail_Hub_API_Authentication___ReDoc_Inject_security_definitions___

0High
0Medium
0Low

vilan

mail_hub_api

MailHubApi - JavaScript client for mail_hub_api This is a specification for Mail-Hub API

Authentication

This SDK is automatically generated by the OpenAPI Generator project:

API version: 0.8.0
Package version: 0.8.0
Build package: org.openapitools.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 mail_hub_api --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your mail_hub_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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 MailHubApi = require('mail_hub_api');

var defaultClient = MailHubApi.ApiClient.instance;
// Configure Bearer (uuid) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

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

Documentation for API Endpoints

All URIs are relative to https://api.mail-hub.io/api/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- MailHubApi.DestinationMailboxesApi | destinationsMailboxesGet | GET /destinations/mailboxes | Get all destination mailboxes MailHubApi.DestinationMailboxesApi | destinationsMailboxesIdDelete | DELETE /destinations/mailboxes/{id} | Delete destination mailbox MailHubApi.DestinationMailboxesApi | destinationsMailboxesPost | POST /destinations/mailboxes | Add one destination mailbox MailHubApi.DomainsApi | domainsGet | GET /domains | Get all domains MailHubApi.DomainsApi | domainsIdDelete | DELETE /domains/{id} | Delete domain MailHubApi.DomainsApi | domainsIdGet | GET /domains/{id} | Get one domain by id MailHubApi.DomainsApi | domainsIdPut | PUT /domains/{id} | Update domain MailHubApi.DomainsApi | domainsNameNameGet | GET /domains/name/{name} | Get one domain by name MailHubApi.DomainsApi | domainsPost | POST /domains | Add domain MailHubApi.DomainsApi | infoBasedomainsGet | GET /info/basedomains | Get base domains MailHubApi.DomainsApi | infoDomainGet | GET /info/domain | Check domain availability MailHubApi.InfoApi | infoMailserversGet | GET /info/mailservers | Get mail servers information MailHubApi.MailboxesApi | mailboxesGet | GET /mailboxes | Get all mailboxes MailHubApi.MailsApi | mailsGet | GET /mails | Get all mails MailHubApi.MailsApi | mailsIdAttachmentsAttachmentIdGet | GET /mails/{id}/attachments/{attachment_id} | Get one attachment MailHubApi.MailsApi | mailsIdAttachmentsGet | GET /mails/{id}/attachments | Get all attachments MailHubApi.MailsApi | mailsIdDelete | DELETE /mails/{id} | Delete one mail MailHubApi.MailsApi | mailsIdGet | GET /mails/{id} | Get one mail MailHubApi.MailsApi | mailsIdSourcesGet | GET /mails/{id}/sources | Get source of mail MailHubApi.OrganizationApi | organizationsBillingAuthPost | POST /organizations/billing/auth | Get access to billing area MailHubApi.OrganizationApi | organizationsGet | GET /organizations | Get organization MailHubApi.OrganizationApi | organizationsIdDelete | DELETE /organizations/{id} | Delete organization MailHubApi.OrganizationApi | organizationsIdPut | PUT /organizations/{id} | Change organization MailHubApi.OrganizationApi | organizationsPost | POST /organizations | Create organization MailHubApi.OrganizationApi | organizationsQuotasGet | GET /organizations/quotas | Get quotas usage MailHubApi.UsersApi | usersGet | GET /users | Get all users MailHubApi.UsersApi | usersIdDelete | DELETE /users/{id} | Delete user MailHubApi.UsersApi | usersIdGet | GET /users/{id} | Get one user MailHubApi.UsersApi | usersIdPasswordPut | PUT /users/{id}/password | Change user's password MailHubApi.UsersApi | usersIdPatch | PATCH /users/{id} | Change user MailHubApi.UsersApi | usersLoginPost | POST /users/login | Authenticate user MailHubApi.UsersApi | usersOnboardPost | POST /users/onboard | Onboard user MailHubApi.UsersApi | usersPost | POST /users | Add user MailHubApi.VerificationsApi | verificationsCodeGet | GET /verifications/{code} | Verify operation MailHubApi.VerificationsApi | verificationsPut | PUT /verifications | Resend email address verification

Documentation for Models

Documentation for Authorization

bearerAuth

Type: Bearer authentication (uuid)