npm package: @sporting.services/arbs
Description: You can download the OpenApi spec file and generate a client in your programming language.<br /> If you need additional features for filtering data, please let us know, and we will try to implement them.<br /><br /> It may also be helpful:
Latest version: 1.0.1

# @sporting.services/arbs

SportingServicesArbs - JavaScript client for @sporting.services/arbs
You can download the OpenApi spec file and generate a client in your programming language.<br /> If you need additional features for filtering data, please let us know, and we will try to implement them.<br /><br /> It may also be helpful:
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.0.1
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For more information, please visit [https://sporting.services](https://sporting.services)

## 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 @sporting.services/arbs --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 @sporting.services/arbs 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 SportingServicesArbs = require('@sporting.services/arbs');

var defaultClient = SportingServicesArbs.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new SportingServicesArbs.FilterApi()
var userId = 3654673hg87; // {String} User ID
var opts = {
  'filter': new SportingServicesArbs.Filter() // {Filter} 
};
api.createFilter(userId, 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://arbs.prematch.api.sporting.services*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*SportingServicesArbs.FilterApi* | [**createFilter**](docs/FilterApi.md#createFilter) | **POST** /v1/users/{user_id}/filter | Create or update filter
*SportingServicesArbs.FilterApi* | [**getItems**](docs/FilterApi.md#getItems) | **GET** /v1/users/{user_id}/filter/items | Arbs filtering result
*SportingServicesArbs.FilterApi* | [**getItemsByEventId**](docs/FilterApi.md#getItemsByEventId) | **GET** /v1/users/{user_id}/filter/events/{event_id}/items | Filter result for a specific event
*SportingServicesArbs.FilterApi* | [**updateFilter**](docs/FilterApi.md#updateFilter) | **PUT** /v1/users/{user_id}/filter | Update filter
*SportingServicesArbs.ItemsApi* | [**getItemById**](docs/ItemsApi.md#getItemById) | **GET** /v1/users/{user_id}/items/{arb_id} | Get a specific arb by ID
*SportingServicesArbs.SystemApi* | [**getStatus**](docs/SystemApi.md#getStatus) | **GET** /status | Get status


## Documentation for Models

 - [SportingServicesArbs.Arb](docs/Arb.md)
 - [SportingServicesArbs.ArbsConfig](docs/ArbsConfig.md)
 - [SportingServicesArbs.ArbsConfigInitiatorsOpponents](docs/ArbsConfigInitiatorsOpponents.md)
 - [SportingServicesArbs.ArbsConfigLifetimeMinutes](docs/ArbsConfigLifetimeMinutes.md)
 - [SportingServicesArbs.ArbsConfigLifetimeSeconds](docs/ArbsConfigLifetimeSeconds.md)
 - [SportingServicesArbs.ArbsConfigRoi](docs/ArbsConfigRoi.md)
 - [SportingServicesArbs.ArbsConfigValue](docs/ArbsConfigValue.md)
 - [SportingServicesArbs.BookmakerConfig](docs/BookmakerConfig.md)
 - [SportingServicesArbs.BookmakerConfigCoeffs](docs/BookmakerConfigCoeffs.md)
 - [SportingServicesArbs.Event](docs/Event.md)
 - [SportingServicesArbs.EventsConfig](docs/EventsConfig.md)
 - [SportingServicesArbs.Filter](docs/Filter.md)
 - [SportingServicesArbs.ItemList](docs/ItemList.md)
 - [SportingServicesArbs.Odd](docs/Odd.md)
 - [SportingServicesArbs.OddsConfig](docs/OddsConfig.md)
 - [SportingServicesArbs.SkippedSubEvent](docs/SkippedSubEvent.md)
 - [SportingServicesArbs.SportConfig](docs/SportConfig.md)
 - [SportingServicesArbs.StandartResponse](docs/StandartResponse.md)
 - [SportingServicesArbs.SubEvent](docs/SubEvent.md)
 - [SportingServicesArbs.SubEventsConfig](docs/SubEventsConfig.md)
 - [SportingServicesArbs.ValueRange](docs/ValueRange.md)


## Documentation for Authorization



### bearerAuth

- **Type**: Bearer authentication