test_ridock_npm v0.1.6
echaloasuerte-api
EchaloasuerteApi - JavaScript client for echaloasuerte-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: v1
- Package version: v1
- 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 echaloasuerte-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.
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 EchaloasuerteApi = require('echaloasuerte-api');
var api = new EchaloasuerteApi.RaffleApi()
var data = new EchaloasuerteApi.Raffle(); // {Raffle}
api.raffleCreate(data).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://localhost/api
Class | Method | HTTP request | Description |
---|---|---|---|
EchaloasuerteApi.RaffleApi | raffleCreate | POST /raffle/ | |
EchaloasuerteApi.RaffleApi | raffleRead | GET /raffle/{id}/ | |
EchaloasuerteApi.RaffleApi | raffleToss | POST /raffle/{id}/toss/ | |
EchaloasuerteApi.RandomNumberApi | randomNumberCreate | POST /random_number/ | |
EchaloasuerteApi.RandomNumberApi | randomNumberRead | GET /random_number/{id}/ | |
EchaloasuerteApi.RandomNumberApi | randomNumberToss | POST /random_number/{id}/toss/ |
Documentation for Models
- EchaloasuerteApi.DrawMetadata
- EchaloasuerteApi.DrawTossPayload
- EchaloasuerteApi.Participant
- EchaloasuerteApi.Prize
- EchaloasuerteApi.Raffle
- EchaloasuerteApi.RaffleResult
- EchaloasuerteApi.RaffleResultParticipant
- EchaloasuerteApi.RaffleResultPrize
- EchaloasuerteApi.RaffleResultValue
- EchaloasuerteApi.RandomNumber
- EchaloasuerteApi.RandomNumberResult
Documentation for Authorization
All endpoints do not require authorization.