black_bear_api v1.0.0
black_bear_api
BlackBearApi - JavaScript client for black_bear_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:
- API version:
- 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 black_bear_api --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 BlackBearApi = require('black_bear_api');
var api = new BlackBearApi.AssetsApi()
var name = "name_example"; // {String}
var opts = {
'description': "description_example", // {String}
'image': "/path/to/file.txt" // {File}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.assetsCreate(name, opts, callback);
Documentation for API Endpoints
All URIs are relative to https://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
BlackBearApi.AssetsApi | assetsCreate | POST /api/assets/ | Asset resource. |
BlackBearApi.AssetsApi | assetsDelete | DELETE /api/assets/{id}/ | Asset resource. |
BlackBearApi.AssetsApi | assetsList | GET /api/assets/ | Asset resource. |
BlackBearApi.AssetsApi | assetsPartialUpdate | PATCH /api/assets/{id}/ | Asset resource. |
BlackBearApi.AssetsApi | assetsRead | GET /api/assets/{id}/ | Asset resource. |
BlackBearApi.AssetsApi | assetsUpdate | PUT /api/assets/{id}/ | Asset resource. |
BlackBearApi.AuthApi | authTokenCreate | POST /api/auth/token/ | |
BlackBearApi.BeaconsApi | beaconsCreate | POST /api/beacons/ | Beacon resource. |
BlackBearApi.BeaconsApi | beaconsDelete | DELETE /api/beacons/{id}/ | Beacon resource. |
BlackBearApi.BeaconsApi | beaconsList | GET /api/beacons/ | Beacon resource. |
BlackBearApi.BeaconsApi | beaconsPartialUpdate | PATCH /api/beacons/{id}/ | Beacon resource. |
BlackBearApi.BeaconsApi | beaconsRead | GET /api/beacons/{id}/ | Beacon resource. |
BlackBearApi.BeaconsApi | beaconsUpdate | PUT /api/beacons/{id}/ | Beacon resource. |
BlackBearApi.ContentApi | contentRead | GET /api/content/{uuid}/{major}/{minor} | |
BlackBearApi.DevicesApi | devicesCreateCreate | POST /api/devices/create/ | |
BlackBearApi.DevicesApi | devicesDeleteDelete | DELETE /api/devices/{id}/delete/ | |
BlackBearApi.DevicesApi | devicesEditPartialUpdate | PATCH /api/devices/{id}/edit/ | |
BlackBearApi.DevicesApi | devicesEditUpdate | PUT /api/devices/{id}/edit/ | |
BlackBearApi.DevicesApi | devicesList | GET /api/devices/ | |
BlackBearApi.DevicesApi | devicesRead | GET /api/devices/{id}/ | |
BlackBearApi.InteractionsApi | interactionsCreateCreate | POST /api/interactions/create/ | |
BlackBearApi.InteractionsApi | interactionsList | GET /api/interactions/ | |
BlackBearApi.InteractionsApi | interactionsRead | GET /api/interactions/{id}/ | |
BlackBearApi.LocationsApi | locationsCreateCreate | POST /api/locations/create/ | |
BlackBearApi.LocationsApi | locationsList | GET /api/locations/ | |
BlackBearApi.LocationsApi | locationsRead | GET /api/locations/{id}/ | |
BlackBearApi.UsersApi | usersLoginCreate | POST /api/users/login/ | |
BlackBearApi.UsersApi | usersRegisterCreate | POST /api/users/register/ | |
BlackBearApi.VenuesApi | venuesCreateCreate | POST /api/venues/create/ | |
BlackBearApi.VenuesApi | venuesDeleteDelete | DELETE /api/venues/{slug}/delete/ | |
BlackBearApi.VenuesApi | venuesEditList | GET /api/venues/{slug}/edit/ | |
BlackBearApi.VenuesApi | venuesEditPartialUpdate | PATCH /api/venues/{slug}/edit/ | |
BlackBearApi.VenuesApi | venuesEditUpdate | PUT /api/venues/{slug}/edit/ | |
BlackBearApi.VenuesApi | venuesList | GET /api/venues/ | |
BlackBearApi.VenuesApi | venuesRead | GET /api/venues/{slug}/ |
Documentation for Models
- BlackBearApi.Data
- BlackBearApi.Data1
- BlackBearApi.Data2
- BlackBearApi.Data3
- BlackBearApi.Data4
- BlackBearApi.Data5
- BlackBearApi.Data6
- BlackBearApi.Data7
- BlackBearApi.Data8
Documentation for Authorization
basic
- Type: HTTP basic authentication
7 years ago