1.0.0 • Published 7 years ago

magnetis_dev v1.0.0

Weekly downloads
1
License
Unlicense
Repository
-
Last release
7 years ago

magnetis_dev

MagnetisDev - JavaScript client for magnetis_dev Lorem ipsum alatea narac por pilli This SDK is automatically generated by the Swagger Codegen project:

  • API version: 2017-03-10T10:44:52Z
  • Package version: 2017-03-10T10:44:52Z
  • 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 magnetis_dev --save

git

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

    npm install YOUR_USERNAME/magnetis_dev --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.

Getting Started

Please follow the installation instruction and execute the following JS code:

var MagnetisDev = require('magnetis_dev');

var defaultClient = MagnetisDev.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 MagnetisDev.AccountsApi()

var opts = { 
  'xApiKey': "xApiKey_example" // {String} 
};

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

Documentation for API Endpoints

All URIs are relative to https://jy96bi0oak.execute-api.eu-west-1.amazonaws.com/V1_dev

ClassMethodHTTP requestDescription
MagnetisDev.AccountsApiaccountsChromeGetGET /accounts/chromeChrome
MagnetisDev.AccountsApiaccountsGetGET /accountsAccounts
MagnetisDev.AccountsApiaccountsIdaccCallbydayGetGET /accounts/{idacc}/callbydayCall by day
MagnetisDev.AccountsApiaccountsIdaccCallbymonthGetGET /accounts/{idacc}/callbymonthCall by month
MagnetisDev.AccountsApiaccountsIdaccCallbymonthbynumberGetGET /accounts/{idacc}/callbymonthbynumberCall by month number
MagnetisDev.AccountsApiaccountsIdaccCallgeofranceGetGET /accounts/{idacc}/callgeofranceCall geo France
MagnetisDev.AccountsApiaccountsIdaccNumbersGetlistGetGET /accounts/{idacc}/numbers/getlistList numbers
MagnetisDev.AccountsApiaccountsIdaccNumbersPhonenumberCallsGetGET /accounts/{idacc}/numbers/{phonenumber}/callsNumbers calls per phonenumber
MagnetisDev.AccountsApiaccountsIdaccNumbersPhonenumberDestinationPostPOST /accounts/{idacc}/numbers/{phonenumber}/destinationDestination
MagnetisDev.AccountsApiaccountsIdaccNumbersPhonenumberKpiGetGET /accounts/{idacc}/numbers/{phonenumber}/kpiKpi numbers
MagnetisDev.AccountsApiaccountsIdaccNumbersPostPOST /accounts/{idacc}/numbersNumbers
MagnetisDev.AccountsApiaccountsIdaccRecipientsGetGET /accounts/{idacc}/recipientsGet recipients
MagnetisDev.AccountsApiaccountsIdaccRecipientsPostPOST /accounts/{idacc}/recipientsPost recipients
MagnetisDev.AccountsApiaccountsIdaccRecipientsRecipientnumberTrackednumberGetGET /accounts/{idacc}/recipients/{recipientnumber}/trackednumberTracked number
MagnetisDev.AccountsApiaccountsKpiGetGET /accounts/kpiKpi

Documentation for Models

Documentation for Authorization

api_key

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header