qutee_api
v0.1.1
Published
JS API client generated by OpenAPI Generator
Downloads
2
Readme
qutee_api
QuteeApi - JavaScript client for qutee_api No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:
- API version: 0.1.0
- Package version: 0.1.0
- 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 qutee_api --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 qutee_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 QuteeApi = require('qutee_api');
var api = new QuteeApi.PollsApi()
var pollCreateRequest = new QuteeApi.PollCreateRequest(); // {PollCreateRequest} Markdown description of the request body
api.createPoll(pollCreateRequest).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Documentation for API Endpoints
All URIs are relative to https://ft2om1ik6i.execute-api.us-east-1.amazonaws.com/dev
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- QuteeApi.PollsApi | createPoll | POST /polls | Create a poll QuteeApi.PollsApi | deletePoll | DELETE /polls/{poll_id} | Delete a poll QuteeApi.PollsApi | getPoll | GET /polls/{poll_id} | Get a poll QuteeApi.PollsApi | listPolls | GET /polls | Get a list of polls QuteeApi.PollsApi | updatePoll | PATCH /polls/{poll_id} | Update a poll
Documentation for Models
- QuteeApi.PollCreateRequest
- QuteeApi.PollCreateResponse
- QuteeApi.PollCreateResponseAnyOf
- QuteeApi.PollCreateResponseAnyOf1
Documentation for Authorization
oauth
- Type: OAuth
- Flow: implicit
- Authorization URL: https://devv2-api.qutee.com/oauth2/authorize
- Scopes:
- read_public: read any publicly available info
- write_owned: create, update or delete data owned by you