Echaloasuerte-js-sdk NPM

echaloasuerte-js-sdk

EchaloasuerteJsSdk - JavaScript client for echaloasuerte-js-sdk 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.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 echaloasuerte-js-sdk --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 echaloasuerte-js-sdk 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 EchaloasuerteJsSdk = require('echaloasuerte-js-sdk');


var api = new EchaloasuerteJsSdk.CoinApi()
var coin = new EchaloasuerteJsSdk.Coin(); // {Coin} 
api.coinCreate(coin).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://raw.githubusercontent.com/should-be-overriden

Class	Method	HTTP request
EchaloasuerteJsSdk.CoinApi	coinCreate	POST /coin/
EchaloasuerteJsSdk.CoinApi	coinRead	GET /coin/{id}/
EchaloasuerteJsSdk.CoinApi	coinToss	POST /coin/{id}/toss/
EchaloasuerteJsSdk.GroupsApi	groupsCreate	POST /groups/
EchaloasuerteJsSdk.GroupsApi	groupsParticipantsAdd	POST /groups/{id}/participants/
EchaloasuerteJsSdk.GroupsApi	groupsRead	GET /groups/{id}/
EchaloasuerteJsSdk.GroupsApi	groupsToss	POST /groups/{id}/toss/
EchaloasuerteJsSdk.InstagramApi	instagramCreate	POST /instagram/
EchaloasuerteJsSdk.InstagramApi	instagramRead	GET /instagram/{id}/
EchaloasuerteJsSdk.InstagramApi	instagramRetoss	PATCH /instagram/{id}/retoss/
EchaloasuerteJsSdk.InstagramApi	instagramToss	POST /instagram/{id}/toss/
EchaloasuerteJsSdk.LetterApi	letterCreate	POST /letter/
EchaloasuerteJsSdk.LetterApi	letterRead	GET /letter/{id}/
EchaloasuerteJsSdk.LetterApi	letterToss	POST /letter/{id}/toss/
EchaloasuerteJsSdk.LinkApi	linkCreate	POST /link/
EchaloasuerteJsSdk.LinkApi	linkRead	GET /link/{id}/
EchaloasuerteJsSdk.LinkApi	linkToss	POST /link/{id}/toss/
EchaloasuerteJsSdk.LotteryApi	lotteryCreate	POST /lottery/
EchaloasuerteJsSdk.LotteryApi	lotteryParticipantsAdd	POST /lottery/{id}/participants/
EchaloasuerteJsSdk.LotteryApi	lotteryRead	GET /lottery/{id}/
EchaloasuerteJsSdk.LotteryApi	lotteryToss	POST /lottery/{id}/toss/
EchaloasuerteJsSdk.PaypalApi	paypalCreate	POST /paypal/create/
EchaloasuerteJsSdk.PaypalApi	redeemPromoCode	POST /promo-code/redeem/
EchaloasuerteJsSdk.RaffleApi	raffleCreate	POST /raffle/
EchaloasuerteJsSdk.RaffleApi	raffleParticipantsAdd	POST /raffle/{id}/participants/
EchaloasuerteJsSdk.RaffleApi	raffleRead	GET /raffle/{id}/
EchaloasuerteJsSdk.RaffleApi	raffleToss	POST /raffle/{id}/toss/
EchaloasuerteJsSdk.RandomNumberApi	randomNumberCreate	POST /random_number/
EchaloasuerteJsSdk.RandomNumberApi	randomNumberRead	GET /random_number/{id}/
EchaloasuerteJsSdk.RandomNumberApi	randomNumberToss	POST /random_number/{id}/toss/
EchaloasuerteJsSdk.SecretSantaApi	secretSantaCreate	POST /secret-santa/
EchaloasuerteJsSdk.SecretSantaApi	secretSantaResultAdminGet	GET /secret-santa-admin/{id}/
EchaloasuerteJsSdk.SecretSantaApi	secretSantaResultAdminPost	POST /secret-santa-admin/{draw_id}/{result_id}/
EchaloasuerteJsSdk.SecretSantaApi	secretSantaResultGet	GET /secret-santa/{id}/
EchaloasuerteJsSdk.ShiftsApi	shiftsCreate	POST /shifts/
EchaloasuerteJsSdk.ShiftsApi	shiftsRead	GET /shifts/{id}/
EchaloasuerteJsSdk.ShiftsApi	shiftsToss	POST /shifts/{id}/toss/
EchaloasuerteJsSdk.SpinnerApi	spinnerCreate	POST /spinner/
EchaloasuerteJsSdk.SpinnerApi	spinnerRead	GET /spinner/{id}/
EchaloasuerteJsSdk.SpinnerApi	spinnerToss	POST /spinner/{id}/toss/
EchaloasuerteJsSdk.TournamentApi	tournamentCreate	POST /tournament/
EchaloasuerteJsSdk.TournamentApi	tournamentParticipantsAdd	POST /tournament/{id}/participants/
EchaloasuerteJsSdk.TournamentApi	tournamentRead	GET /tournament/{id}/
EchaloasuerteJsSdk.TournamentApi	tournamentToss	POST /tournament/{id}/toss/