heathcliff

Heathcliff - JavaScript client for heathcliff A RESTful API for terrain and propagation tools. This SDK is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: v1
• Build date: 2018-03-14T13:32:17.211-06:00
• Build package: class 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 heathcliff --save

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.

Getting Started

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

var Heathcliff = require('heathcliff');

var defaultClient = Heathcliff.ApiClient.instance;

// Configure HTTP basic authorization: Basic
var Basic = defaultClient.authentications['Basic'];
Basic.username = 'YOUR USERNAME'
Basic.password = 'YOUR PASSWORD'

var api = new Heathcliff.VApi()

var data = new Heathcliff.AntennaPatternFile(); // {AntennaPatternFile} 


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

Documentation for API Endpoints

All URIs are relative to https://localhost/api

Class	Method	HTTP request	Description
Heathcliff.VApi	v1AntennasFilesCreate	POST /v1/antennas/files/
Heathcliff.VApi	v1AntennasFilesDelete	DELETE /v1/antennas/files/{id}/
Heathcliff.VApi	v1AntennasFilesList	GET /v1/antennas/files/
Heathcliff.VApi	v1AntennasFilesPartialUpdate	PATCH /v1/antennas/files/{id}/
Heathcliff.VApi	v1AntennasFilesRead	GET /v1/antennas/files/{id}/
Heathcliff.VApi	v1AntennasFilesUpdate	PUT /v1/antennas/files/{id}/
Heathcliff.VApi	v1AntennasPatternsCreate	POST /v1/antennas/patterns/
Heathcliff.VApi	v1AntennasPatternsDelete	DELETE /v1/antennas/patterns/{id}/
Heathcliff.VApi	v1AntennasPatternsList	GET /v1/antennas/patterns/
Heathcliff.VApi	v1AntennasPatternsPartialUpdate	PATCH /v1/antennas/patterns/{id}/
Heathcliff.VApi	v1AntennasPatternsRead	GET /v1/antennas/patterns/{id}/
Heathcliff.VApi	v1AntennasPatternsUpdate	PUT /v1/antennas/patterns/{id}/
Heathcliff.VApi	v1CollectionsCreate	POST /v1/collections/
Heathcliff.VApi	v1CollectionsDelete	DELETE /v1/collections/{id}/
Heathcliff.VApi	v1CollectionsList	GET /v1/collections/
Heathcliff.VApi	v1CollectionsPartialUpdate	PATCH /v1/collections/{id}/
Heathcliff.VApi	v1CollectionsRead	GET /v1/collections/{id}/
Heathcliff.VApi	v1CollectionsUpdate	PUT /v1/collections/{id}/
Heathcliff.VApi	v1FeaturesPointCreate	POST /v1/features/point/
Heathcliff.VApi	v1FeaturesPointDelete	DELETE /v1/features/point/{id}/
Heathcliff.VApi	v1FeaturesPointList	GET /v1/features/point/
Heathcliff.VApi	v1FeaturesPointPartialUpdate	PATCH /v1/features/point/{id}/
Heathcliff.VApi	v1FeaturesPointRead	GET /v1/features/point/{id}/
Heathcliff.VApi	v1FeaturesPointUpdate	PUT /v1/features/point/{id}/
Heathcliff.VApi	v1FeaturesProfileCreate	POST /v1/features/profile/
Heathcliff.VApi	v1FeaturesProfileDelete	DELETE /v1/features/profile/{id}/
Heathcliff.VApi	v1FeaturesProfileList	GET /v1/features/profile/
Heathcliff.VApi	v1FeaturesProfilePartialUpdate	PATCH /v1/features/profile/{id}/
Heathcliff.VApi	v1FeaturesProfileRead	GET /v1/features/profile/{id}/
Heathcliff.VApi	v1FeaturesProfileUpdate	PUT /v1/features/profile/{id}/
Heathcliff.VApi	v1FilesCreate	POST /v1/files/
Heathcliff.VApi	v1FilesDelete	DELETE /v1/files/{id}/
Heathcliff.VApi	v1FilesList	GET /v1/files/
Heathcliff.VApi	v1FilesPartialUpdate	PATCH /v1/files/{id}/
Heathcliff.VApi	v1FilesRead	GET /v1/files/{id}/
Heathcliff.VApi	v1FilesUpdate	PUT /v1/files/{id}/
Heathcliff.VApi	v1JobsCreate	POST /v1/jobs/
Heathcliff.VApi	v1JobsDelete	DELETE /v1/jobs/{id}/
Heathcliff.VApi	v1JobsList	GET /v1/jobs/
Heathcliff.VApi	v1JobsPartialUpdate	PATCH /v1/jobs/{id}/
Heathcliff.VApi	v1JobsRead	GET /v1/jobs/{id}/
Heathcliff.VApi	v1JobsUpdate	PUT /v1/jobs/{id}/
Heathcliff.VApi	v1List	GET /v1/
Heathcliff.VApi	v1PropagationList	GET /v1/propagation/
Heathcliff.VApi	v1PropagationP526knifeedgeCreate	POST /v1/propagation/p526knifeedge/
Heathcliff.VApi	v1PropagationP526knifeedgeDelete	DELETE /v1/propagation/p526knifeedge/{id}/
Heathcliff.VApi	v1PropagationP526knifeedgeList	GET /v1/propagation/p526knifeedge/
Heathcliff.VApi	v1PropagationP526knifeedgePartialUpdate	PATCH /v1/propagation/p526knifeedge/{id}/
Heathcliff.VApi	v1PropagationP526knifeedgeRead	GET /v1/propagation/p526knifeedge/{id}/
Heathcliff.VApi	v1PropagationP526knifeedgeUpdate	PUT /v1/propagation/p526knifeedge/{id}/
Heathcliff.VApi	v1UsersList	GET /v1/users/
Heathcliff.VApi	v1UsersRead	GET /v1/users/{id}/

Documentation for Models

• Heathcliff.Antenna
• Heathcliff.AntennaPatternFile
• Heathcliff.DatasetCollections
• Heathcliff.GeoDataset
• Heathcliff.Job
• Heathcliff.P526KnifeEdge
• Heathcliff.Point
• Heathcliff.Profile
• Heathcliff.User

Documentation for Authorization

Basic

• Type: HTTP basic authentication