magic_info_api v1.0.1

magic_info_api

MagicInfoApi - JavaScript client for magic_info_api magic info api 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 magic_info_api --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 magic_info_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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

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

var api = new MagicInfoApi.AuthApi()

var userLogin = new MagicInfoApi.AuthResource(); // {AuthResource} resource


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

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:7001/MagicInfo

Documentation for Models

• MagicInfoApi.AuthResource
• MagicInfoApi.ContentApproveResource
• MagicInfoApi.ContentFilter
• MagicInfoApi.ContentScheduleItemResource
• MagicInfoApi.ContentScheduleResource
• MagicInfoApi.DeviceApproveResource
• MagicInfoApi.DeviceDisplayConfResource
• MagicInfoApi.DeviceDisplayConfSubResource
• MagicInfoApi.DeviceDisplayCustomLogoResource
• MagicInfoApi.DeviceDownloadServerResource
• MagicInfoApi.DeviceFilter
• MagicInfoApi.DeviceGeneralConfResource
• MagicInfoApi.DeviceLedCabinetResource
• MagicInfoApi.DeviceSecurityConfResource
• MagicInfoApi.DeviceSystemSetupConfResource
• MagicInfoApi.DeviceTimeClockConf
• MagicInfoApi.DeviceTimeHolidayResource
• MagicInfoApi.DeviceTimeTimerConf
• MagicInfoApi.DeviceTimeconfResource
• MagicInfoApi.EnvironmentNoticeFilter
• MagicInfoApi.EnvironmentPriorityFilter
• MagicInfoApi.Error
• MagicInfoApi.HashMapstringobject
• MagicInfoApi.Map
• MagicInfoApi.MessageResource
• MagicInfoApi.MessageScheduleFilter
• MagicInfoApi.MessageScheduleResource
• MagicInfoApi.PlaylistFilter
• MagicInfoApi.PlaylistItemResource
• MagicInfoApi.PlaylistResource
• MagicInfoApi.Property
• MagicInfoApi.Response
• MagicInfoApi.ResponseBody
• MagicInfoApi.ScheduleFilter
• MagicInfoApi.TagResource
• MagicInfoApi.Timestamp
• MagicInfoApi.TokenAuth
• MagicInfoApi.UserFilter
• MagicInfoApi.Xml

Documentation for Authorization

api_key

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