npm package: @gjv-dev/api-client-water-boy
Description: JS API client generated by OpenAPI Generator
Latest version: 1.0.8

# 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](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.0.8
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install gjv-dev-api-client-water-boy --save
```

Finally, you need to build the module:

```shell
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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
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:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

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


## Documentation for Models

 - [GjvDevApiClientWaterBoy.Filter](docs/Filter.md)
 - [GjvDevApiClientWaterBoy.Filter1](docs/Filter1.md)
 - [GjvDevApiClientWaterBoy.Filter2](docs/Filter2.md)
 - [GjvDevApiClientWaterBoy.Filter3](docs/Filter3.md)
 - [GjvDevApiClientWaterBoy.Filter4](docs/Filter4.md)
 - [GjvDevApiClientWaterBoy.Filter5](docs/Filter5.md)
 - [GjvDevApiClientWaterBoy.Filter6](docs/Filter6.md)
 - [GjvDevApiClientWaterBoy.FullstrideGame](docs/FullstrideGame.md)
 - [GjvDevApiClientWaterBoy.FullstridegamesFields](docs/FullstridegamesFields.md)
 - [GjvDevApiClientWaterBoy.InlineObject](docs/InlineObject.md)
 - [GjvDevApiClientWaterBoy.InlineResponse200](docs/InlineResponse200.md)
 - [GjvDevApiClientWaterBoy.InlineResponse2001](docs/InlineResponse2001.md)
 - [GjvDevApiClientWaterBoy.InlineResponse2002](docs/InlineResponse2002.md)
 - [GjvDevApiClientWaterBoy.InlineResponse2003](docs/InlineResponse2003.md)
 - [GjvDevApiClientWaterBoy.Location](docs/Location.md)
 - [GjvDevApiClientWaterBoy.LocationsFields](docs/LocationsFields.md)
 - [GjvDevApiClientWaterBoy.PeopleFields](docs/PeopleFields.md)
 - [GjvDevApiClientWaterBoy.Person](docs/Person.md)
 - [GjvDevApiClientWaterBoy.ScheduledJobModel](docs/ScheduledJobModel.md)
 - [GjvDevApiClientWaterBoy.SportingEvent](docs/SportingEvent.md)
 - [GjvDevApiClientWaterBoy.SportingeventsFields](docs/SportingeventsFields.md)
 - [GjvDevApiClientWaterBoy.Team](docs/Team.md)
 - [GjvDevApiClientWaterBoy.TeamsFields](docs/TeamsFields.md)
 - [GjvDevApiClientWaterBoy.User](docs/User.md)
 - [GjvDevApiClientWaterBoy.UserGroup](docs/UserGroup.md)
 - [GjvDevApiClientWaterBoy.UsergroupsFields](docs/UsergroupsFields.md)
 - [GjvDevApiClientWaterBoy.UsersFields](docs/UsersFields.md)


## Documentation for Authorization

All endpoints do not require authorization.