@gjv-dev/api-client-water-boy NPM

gjv-dev-api-client-water-boy

GjvDevApiClientWaterBoy - JavaScript client for gjv-dev-api-client-water-boy 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: 1.0.0
Package version: 1.0.8
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 gjv-dev-api-client-water-boy --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 gjv-dev-api-client-water-boy 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 GjvDevApiClientWaterBoy = require('gjv-dev-api-client-water-boy');


var api = new GjvDevApiClientWaterBoy.FullstrideGameControllerApi()
var opts = {
  'where': null // {Object} 
};
api.fullstrideGameControllerCount(opts).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://gjv-dev-api-water-boy.herokuapp.com

Class	Method	HTTP request
GjvDevApiClientWaterBoy.FullstrideGameControllerApi	fullstrideGameControllerCount	GET /fullstride-games/count
GjvDevApiClientWaterBoy.FullstrideGameControllerApi	fullstrideGameControllerCreate	POST /fullstride-games
GjvDevApiClientWaterBoy.FullstrideGameControllerApi	fullstrideGameControllerDeleteById	DELETE /fullstride-games/{id}
GjvDevApiClientWaterBoy.FullstrideGameControllerApi	fullstrideGameControllerFind	GET /fullstride-games
GjvDevApiClientWaterBoy.FullstrideGameControllerApi	fullstrideGameControllerFindById	GET /fullstride-games/{id}
GjvDevApiClientWaterBoy.FullstrideGameControllerApi	fullstrideGameControllerReplaceById	PUT /fullstride-games/{id}
GjvDevApiClientWaterBoy.FullstrideGameControllerApi	fullstrideGameControllerUpdateAll	PATCH /fullstride-games
GjvDevApiClientWaterBoy.FullstrideGameControllerApi	fullstrideGameControllerUpdateById	PATCH /fullstride-games/{id}
GjvDevApiClientWaterBoy.LocationControllerApi	locationControllerCount	GET /locations/count
GjvDevApiClientWaterBoy.LocationControllerApi	locationControllerCreate	POST /locations
GjvDevApiClientWaterBoy.LocationControllerApi	locationControllerDeleteById	DELETE /locations/{id}
GjvDevApiClientWaterBoy.LocationControllerApi	locationControllerFind	GET /locations
GjvDevApiClientWaterBoy.LocationControllerApi	locationControllerFindById	GET /locations/{id}
GjvDevApiClientWaterBoy.LocationControllerApi	locationControllerReplaceById	PUT /locations/{id}
GjvDevApiClientWaterBoy.LocationControllerApi	locationControllerUpdateAll	PATCH /locations
GjvDevApiClientWaterBoy.LocationControllerApi	locationControllerUpdateById	PATCH /locations/{id}
GjvDevApiClientWaterBoy.PersonControllerApi	personControllerCount	GET /people/count
GjvDevApiClientWaterBoy.PersonControllerApi	personControllerCreate	POST /people
GjvDevApiClientWaterBoy.PersonControllerApi	personControllerDeleteById	DELETE /people/{id}
GjvDevApiClientWaterBoy.PersonControllerApi	personControllerFind	GET /people
GjvDevApiClientWaterBoy.PersonControllerApi	personControllerFindById	GET /people/{id}
GjvDevApiClientWaterBoy.PersonControllerApi	personControllerReplaceById	PUT /people/{id}
GjvDevApiClientWaterBoy.PersonControllerApi	personControllerUpdateAll	PATCH /people
GjvDevApiClientWaterBoy.PersonControllerApi	personControllerUpdateById	PATCH /people/{id}
GjvDevApiClientWaterBoy.PingControllerApi	pingControllerPing	GET /ping
GjvDevApiClientWaterBoy.ScheduledJobControllerApi	scheduledJobControllerCount	GET /scheduled-jobs/count
GjvDevApiClientWaterBoy.ScheduledJobControllerApi	scheduledJobControllerFindById	GET /scheduled-jobs/{id}
GjvDevApiClientWaterBoy.ScheduledJobControllerApi	scheduledJobControllerGetAll	GET /scheduled-jobs
GjvDevApiClientWaterBoy.SportingEventControllerApi	sportingEventControllerCount	GET /sporting-events/count
GjvDevApiClientWaterBoy.SportingEventControllerApi	sportingEventControllerCreate	POST /sporting-events
GjvDevApiClientWaterBoy.SportingEventControllerApi	sportingEventControllerDeleteById	DELETE /sporting-events/{id}
GjvDevApiClientWaterBoy.SportingEventControllerApi	sportingEventControllerFind	GET /sporting-events
GjvDevApiClientWaterBoy.SportingEventControllerApi	sportingEventControllerFindById	GET /sporting-events/{id}
GjvDevApiClientWaterBoy.SportingEventControllerApi	sportingEventControllerReplaceById	PUT /sporting-events/{id}
GjvDevApiClientWaterBoy.SportingEventControllerApi	sportingEventControllerUpdateAll	PATCH /sporting-events
GjvDevApiClientWaterBoy.SportingEventControllerApi	sportingEventControllerUpdateById	PATCH /sporting-events/{id}
GjvDevApiClientWaterBoy.TeamControllerApi	teamControllerCount	GET /teams/count
GjvDevApiClientWaterBoy.TeamControllerApi	teamControllerCreate	POST /teams
GjvDevApiClientWaterBoy.TeamControllerApi	teamControllerDeleteById	DELETE /teams/{id}
GjvDevApiClientWaterBoy.TeamControllerApi	teamControllerFind	GET /teams
GjvDevApiClientWaterBoy.TeamControllerApi	teamControllerFindById	GET /teams/{id}
GjvDevApiClientWaterBoy.TeamControllerApi	teamControllerReplaceById	PUT /teams/{id}
GjvDevApiClientWaterBoy.TeamControllerApi	teamControllerUpdateAll	PATCH /teams
GjvDevApiClientWaterBoy.TeamControllerApi	teamControllerUpdateById	PATCH /teams/{id}
GjvDevApiClientWaterBoy.UserControllerApi	userControllerCount	GET /users/count
GjvDevApiClientWaterBoy.UserControllerApi	userControllerCreate	POST /users
GjvDevApiClientWaterBoy.UserControllerApi	userControllerDeleteById	DELETE /users/{id}
GjvDevApiClientWaterBoy.UserControllerApi	userControllerFind	GET /users
GjvDevApiClientWaterBoy.UserControllerApi	userControllerFindById	GET /users/{id}
GjvDevApiClientWaterBoy.UserControllerApi	userControllerLogin	POST /users/login
GjvDevApiClientWaterBoy.UserControllerApi	userControllerPrintCurrentUser	GET /users/me
GjvDevApiClientWaterBoy.UserControllerApi	userControllerReplaceById	PUT /users/{id}
GjvDevApiClientWaterBoy.UserControllerApi	userControllerUpdateAll	PATCH /users
GjvDevApiClientWaterBoy.UserControllerApi	userControllerUpdateById	PATCH /users/{id}
GjvDevApiClientWaterBoy.UserGroupControllerApi	userGroupControllerCount	GET /user-groups/count
GjvDevApiClientWaterBoy.UserGroupControllerApi	userGroupControllerCreate	POST /user-groups
GjvDevApiClientWaterBoy.UserGroupControllerApi	userGroupControllerDeleteById	DELETE /user-groups/{id}
GjvDevApiClientWaterBoy.UserGroupControllerApi	userGroupControllerFind	GET /user-groups
GjvDevApiClientWaterBoy.UserGroupControllerApi	userGroupControllerFindById	GET /user-groups/{id}
GjvDevApiClientWaterBoy.UserGroupControllerApi	userGroupControllerReplaceById	PUT /user-groups/{id}
GjvDevApiClientWaterBoy.UserGroupControllerApi	userGroupControllerUpdateAll	PATCH /user-groups
GjvDevApiClientWaterBoy.UserGroupControllerApi	userGroupControllerUpdateById	PATCH /user-groups/{id}