yumpu_api4_sdk

YumpuApi4Sdk - JavaScript client for yumpu_api4_sdk yumpu api4 sdk This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.1.3
• Package version: 1.1.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 yumpu_api4_sdk --save

git

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

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

var defaultClient = YumpuApi4Sdk.ApiClient.instance;

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

var api = new YumpuApi4Sdk.DefaultApi()

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

Documentation for API Endpoints

All URIs are relative to https://api4.yumpu.com

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- YumpuApi4Sdk.DefaultApi | categoriesGet | GET /categories | YumpuApi4Sdk.DefaultApi | categoriesIdGet | GET /categories/{id} | YumpuApi4Sdk.DefaultApi | categoriesIdOptions | OPTIONS /categories/{id} | YumpuApi4Sdk.DefaultApi | categoriesOptions | OPTIONS /categories | YumpuApi4Sdk.DefaultApi | countriesGet | GET /countries | YumpuApi4Sdk.DefaultApi | countriesIdGet | GET /countries/{id} | YumpuApi4Sdk.DefaultApi | countriesIdOptions | OPTIONS /countries/{id} | YumpuApi4Sdk.DefaultApi | countriesOptions | OPTIONS /countries | YumpuApi4Sdk.DefaultApi | documentsGet | GET /documents | YumpuApi4Sdk.DefaultApi | documentsIdDelete | DELETE /documents/{id} | YumpuApi4Sdk.DefaultApi | documentsIdGet | GET /documents/{id} | YumpuApi4Sdk.DefaultApi | documentsIdOptions | OPTIONS /documents/{id} | YumpuApi4Sdk.DefaultApi | documentsIdPut | PUT /documents/{id} | YumpuApi4Sdk.DefaultApi | documentsOptions | OPTIONS /documents | YumpuApi4Sdk.DefaultApi | languagesGet | GET /languages | YumpuApi4Sdk.DefaultApi | languagesIdGet | GET /languages/{id} | YumpuApi4Sdk.DefaultApi | languagesIdOptions | OPTIONS /languages/{id} | YumpuApi4Sdk.DefaultApi | languagesOptions | OPTIONS /languages | YumpuApi4Sdk.DefaultApi | loginOptions | OPTIONS /login | YumpuApi4Sdk.DefaultApi | loginPost | POST /login | YumpuApi4Sdk.DefaultApi | logoutDelete | DELETE /logout | YumpuApi4Sdk.DefaultApi | logoutOptions | OPTIONS /logout | YumpuApi4Sdk.DefaultApi | rootOptions | OPTIONS / | YumpuApi4Sdk.DefaultApi | usersGet | GET /users | YumpuApi4Sdk.DefaultApi | usersIdActivationLinkOptions | OPTIONS /users/{id}/activation-link | YumpuApi4Sdk.DefaultApi | usersIdActivationLinkPost | POST /users/{id}/activation-link | YumpuApi4Sdk.DefaultApi | usersIdDelete | DELETE /users/{id} | YumpuApi4Sdk.DefaultApi | usersIdDocumentCountsGet | GET /users/{id}/document-counts | YumpuApi4Sdk.DefaultApi | usersIdDocumentCountsOptions | OPTIONS /users/{id}/document-counts | YumpuApi4Sdk.DefaultApi | usersIdGet | GET /users/{id} | YumpuApi4Sdk.DefaultApi | usersIdInvoiceDatasGet | GET /users/{id}/invoice-datas | YumpuApi4Sdk.DefaultApi | usersIdInvoiceDatasOptions | OPTIONS /users/{id}/invoice-datas | YumpuApi4Sdk.DefaultApi | usersIdInvoicesGet | GET /users/{id}/invoices | YumpuApi4Sdk.DefaultApi | usersIdInvoicesInvoiceIdGet | GET /users/{id}/invoices/{invoiceId} | YumpuApi4Sdk.DefaultApi | usersIdInvoicesInvoiceIdOptions | OPTIONS /users/{id}/invoices/{invoiceId} | YumpuApi4Sdk.DefaultApi | usersIdInvoicesOptions | OPTIONS /users/{id}/invoices | YumpuApi4Sdk.DefaultApi | usersIdInvoicesPut | PUT /users/{id}/invoices | YumpuApi4Sdk.DefaultApi | usersIdOptions | OPTIONS /users/{id} | YumpuApi4Sdk.DefaultApi | usersIdPut | PUT /users/{id} | YumpuApi4Sdk.DefaultApi | usersIdSessionsGet | GET /users/{id}/sessions | YumpuApi4Sdk.DefaultApi | usersIdSessionsOptions | OPTIONS /users/{id}/sessions | YumpuApi4Sdk.DefaultApi | usersIdSessionsSessionIdGet | GET /users/{id}/sessions/{sessionId} | YumpuApi4Sdk.DefaultApi | usersIdSessionsSessionIdOptions | OPTIONS /users/{id}/sessions/{sessionId} | YumpuApi4Sdk.DefaultApi | usersIdSessionsSessionIdPut | PUT /users/{id}/sessions/{sessionId} | YumpuApi4Sdk.DefaultApi | usersOptions | OPTIONS /users |

Documentation for Models

Documentation for Authorization

authorization

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