portal_api_javascript_client v0.0.2
portal_api
PortalApi - JavaScript client for portal_api This is the Portal API for the Vinyl Factory This SDK is automatically generated by the OpenAPI Generator project:
- API version: 0.0.1
- Package version: 0.0.1
- Build package: org.openapitools.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 portal_api_javascript_client --save
Finally, you need to build the module:
npm run build
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
To use the link you just defined in your project, switch to the directory you want to use your portal_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
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.
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 PortalApi = require('portal_api');
var api = new PortalApi.CutterApi()
var slot = 1; // {Number} The slot number; an integer between 1 - 12.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getSlotLength(slot, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
PortalApi.CutterApi | getSlotLength | GET /slot/{slot}/cut/length | Get the audio length set on the cutter. |
PortalApi.CutterApi | getSlotPitches | GET /slot/{slot}/cut/pitches | Get the currently set pitches on the specified cutter |
PortalApi.CutterApi | getSlotSize | GET /slot/{slot}/cut/size | Get the current disc size set on the cutter. |
PortalApi.CutterApi | getSlotSpeed | GET /slot/{slot}/cut/speed | Get the current speed set on the cutter. |
PortalApi.CutterApi | getSlotWidths | GET /slot/{slot}/cut/widths | Get the currently set widths on the specificed cutter |
PortalApi.CutterApi | setSlotCue | POST /slot/{slot}/cut/cue | Initialize cutting procedure on the record. |
PortalApi.CutterApi | setSlotLength | POST /slot/{slot}/cut/length | Set the audio length on the cutter. |
PortalApi.CutterApi | setSlotPitches | POST /slot/{slot}/cut/pitches | Set the pitches on the cutter |
PortalApi.CutterApi | setSlotSize | POST /slot/{slot}/cut/size | Set the disc size on the slot. |
PortalApi.CutterApi | setSlotSpeed | POST /slot/{slot}/cut/speed | Set the speed on the slot. |
PortalApi.CutterApi | setSlotWidths | POST /slot/{slot}/cut/widths | Set the widths on the cutter |
PortalApi.PortalApi | collectSlot | POST /slot/{slot}/collect | Collect a disc from a slot |
PortalApi.PortalApi | flipSlot | POST /slot/{slot}/flip | Flip a disc in a slot |
PortalApi.PortalApi | rejectSlot | POST /slot/{slot}/reject | Reject a disc from a slot |
PortalApi.PortalApi | supplySlot | POST /slot/{slot}/supply | Supply a disc to a slot |
Documentation for Models
- PortalApi.Cue
- PortalApi.Length
- PortalApi.Pitches
- PortalApi.Size
- PortalApi.Speed
- PortalApi.Validation
- PortalApi.ValidationDetails
- PortalApi.ValidationDetailsBody
- PortalApi.Widths
Documentation for Authorization
All endpoints do not require authorization.