1.0.0 • Published 7 years ago

black_bear_api v1.0.0

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

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

ClassMethodHTTP requestDescription
BlackBearApi.AssetsApiassetsCreatePOST /api/assets/Asset resource.
BlackBearApi.AssetsApiassetsDeleteDELETE /api/assets/{id}/Asset resource.
BlackBearApi.AssetsApiassetsListGET /api/assets/Asset resource.
BlackBearApi.AssetsApiassetsPartialUpdatePATCH /api/assets/{id}/Asset resource.
BlackBearApi.AssetsApiassetsReadGET /api/assets/{id}/Asset resource.
BlackBearApi.AssetsApiassetsUpdatePUT /api/assets/{id}/Asset resource.
BlackBearApi.AuthApiauthTokenCreatePOST /api/auth/token/
BlackBearApi.BeaconsApibeaconsCreatePOST /api/beacons/Beacon resource.
BlackBearApi.BeaconsApibeaconsDeleteDELETE /api/beacons/{id}/Beacon resource.
BlackBearApi.BeaconsApibeaconsListGET /api/beacons/Beacon resource.
BlackBearApi.BeaconsApibeaconsPartialUpdatePATCH /api/beacons/{id}/Beacon resource.
BlackBearApi.BeaconsApibeaconsReadGET /api/beacons/{id}/Beacon resource.
BlackBearApi.BeaconsApibeaconsUpdatePUT /api/beacons/{id}/Beacon resource.
BlackBearApi.ContentApicontentReadGET /api/content/{uuid}/{major}/{minor}
BlackBearApi.DevicesApidevicesCreateCreatePOST /api/devices/create/
BlackBearApi.DevicesApidevicesDeleteDeleteDELETE /api/devices/{id}/delete/
BlackBearApi.DevicesApidevicesEditPartialUpdatePATCH /api/devices/{id}/edit/
BlackBearApi.DevicesApidevicesEditUpdatePUT /api/devices/{id}/edit/
BlackBearApi.DevicesApidevicesListGET /api/devices/
BlackBearApi.DevicesApidevicesReadGET /api/devices/{id}/
BlackBearApi.InteractionsApiinteractionsCreateCreatePOST /api/interactions/create/
BlackBearApi.InteractionsApiinteractionsListGET /api/interactions/
BlackBearApi.InteractionsApiinteractionsReadGET /api/interactions/{id}/
BlackBearApi.LocationsApilocationsCreateCreatePOST /api/locations/create/
BlackBearApi.LocationsApilocationsListGET /api/locations/
BlackBearApi.LocationsApilocationsReadGET /api/locations/{id}/
BlackBearApi.UsersApiusersLoginCreatePOST /api/users/login/
BlackBearApi.UsersApiusersRegisterCreatePOST /api/users/register/
BlackBearApi.VenuesApivenuesCreateCreatePOST /api/venues/create/
BlackBearApi.VenuesApivenuesDeleteDeleteDELETE /api/venues/{slug}/delete/
BlackBearApi.VenuesApivenuesEditListGET /api/venues/{slug}/edit/
BlackBearApi.VenuesApivenuesEditPartialUpdatePATCH /api/venues/{slug}/edit/
BlackBearApi.VenuesApivenuesEditUpdatePUT /api/venues/{slug}/edit/
BlackBearApi.VenuesApivenuesListGET /api/venues/
BlackBearApi.VenuesApivenuesReadGET /api/venues/{slug}/

Documentation for Models

Documentation for Authorization

basic

  • Type: HTTP basic authentication
1.0.0

7 years ago