squash_matrix_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3119f263d657b160e9e5aceda7ce872cf166d363f39c57f8fc5c86c1fe261256
+  data.tar.gz: 5a227895805cd16784dfedc3aff9ec06243f4e95948e68e5561d9e3ab0a99814
+SHA512:
+  metadata.gz: 8f2c02129ed394a31de53402b93a904d27441676dcb36eb95d58097707aca9086048966d0fbc5e3363d75d5913645c317d26b95fd7a5bf47f59abe1e344e3c8a
+  data.tar.gz: 5ea602e24aba6bbc16e6710323e253d772d822b4acfbe7b3c86feebf5867540c88e289f88630abac72ba786eeac883b58f61fd1a862abec62607c6b04600b60e

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -0,0 +1,106 @@
+# squash_matrix_api
+
+SquashMatrixAPI - the Ruby gem for the Squash Matrix API
+
+# Endeavor The squash matrix API enables clubs, players, and regions to own their information, with results being updated weekly. The API information sits ontop of squash matrix australia website [https://squashmatrix.com](https://squashmatrix.com) # API Aside from the documentation provided below, there is also a `{json:api}` available and can be accessed in the same manner, with the addition of the accept header `{accept: application/vnd.api+json}`. More information about json api can be viewed on their website at [http://jsonapi.org/](http://jsonapi.org/) # Squash Matrix Scrapper There is a ruby SDK for retrieving information from [https://squashmatrix.com](https://squashmatrix.com) which can be found at https://rubygems.org/gems/squash_matrix # SDK's Please stay posted! Client sdk's for the following will be provided shortly:    - Javascript   - Java   - Ruby  # Blog Find relevent and interesting media on [wilkosz.com.au](http://wilkosz.com.au) # Contact Join this endeavor and be appart of the community [https://www.facebook.com/squashmatrixapi](https://www.facebook.com/squashmatrixapi) <hr />
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build squash_matrix_api.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./squash_matrix_api-1.0.0.gem
+```
+(for development, run `gem install --dev ./squash_matrix_api-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'squash_matrix_api', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'squash_matrix_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'squash_matrix_api'
+
+api_instance = SquashMatrixAPI::DefaultApi.new
+
+opts = { 
+  page: 56, # Integer | The page of clubs
+  page_size: 56 # Integer | The size of page
+}
+
+begin
+  #Get page of clubs
+  result = api_instance.clubs_get(opts)
+  p result
+rescue SquashMatrixAPI::ApiError => e
+  puts "Exception when calling DefaultApi->clubs_get: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.squashmatrix.io/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*SquashMatrixAPI::DefaultApi* | [**clubs_get**](docs/DefaultApi.md#clubs_get) | **GET** /clubs | Get page of clubs
+*SquashMatrixAPI::DefaultApi* | [**clubs_squash_matrix_id_get**](docs/DefaultApi.md#clubs_squash_matrix_id_get) | **GET** /clubs/{squashMatrixId} | Get club by Squash Matrix ID
+*SquashMatrixAPI::DefaultApi* | [**games_game_id_get**](docs/DefaultApi.md#games_game_id_get) | **GET** /games/{gameId} | Get game by ID
+*SquashMatrixAPI::DefaultApi* | [**games_get**](docs/DefaultApi.md#games_get) | **GET** /games | Get page of games
+*SquashMatrixAPI::DefaultApi* | [**players_get**](docs/DefaultApi.md#players_get) | **GET** /players | Get page of players
+*SquashMatrixAPI::DefaultApi* | [**players_squash_matrix_id_get**](docs/DefaultApi.md#players_squash_matrix_id_get) | **GET** /players/{squashMatrixId} | Get player by Squash Matrix ID
+
+
+## Documentation for Models
+
+ - [SquashMatrixAPI::ApiResponseErrors](docs/ApiResponseErrors.md)
+ - [SquashMatrixAPI::ApiResponseErrorsErrors](docs/ApiResponseErrorsErrors.md)
+ - [SquashMatrixAPI::Club](docs/Club.md)
+ - [SquashMatrixAPI::Game](docs/Game.md)
+ - [SquashMatrixAPI::InlineResponse200](docs/InlineResponse200.md)
+ - [SquashMatrixAPI::InlineResponse2001](docs/InlineResponse2001.md)
+ - [SquashMatrixAPI::InlineResponse2002](docs/InlineResponse2002.md)
+ - [SquashMatrixAPI::InlineResponse2003](docs/InlineResponse2003.md)
+ - [SquashMatrixAPI::InlineResponse2004](docs/InlineResponse2004.md)
+ - [SquashMatrixAPI::InlineResponse2005](docs/InlineResponse2005.md)
+ - [SquashMatrixAPI::Player](docs/Player.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/ApiResponseErrors.md

@@ -0,0 +1,8 @@
+# SquashMatrixAPI::ApiResponseErrors
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<ApiResponseErrorsErrors>**](ApiResponseErrorsErrors.md) |  | [optional] 
+
+

data/docs/ApiResponseErrorsErrors.md

@@ -0,0 +1,10 @@
+# SquashMatrixAPI::ApiResponseErrorsErrors
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | 
+**detail** | **String** |  | 
+**message** | **String** |  | [optional] 
+
+

data/docs/Club.md

@@ -0,0 +1,10 @@
+# SquashMatrixAPI::Club
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**name** | **String** |  | [optional] 
+**player_ids** | **Array<Integer>** | Players associated with the club | [optional] 
+
+

data/docs/DefaultApi.md

@@ -0,0 +1,293 @@
+# SquashMatrixAPI::DefaultApi
+
+All URIs are relative to *https://api.squashmatrix.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**clubs_get**](DefaultApi.md#clubs_get) | **GET** /clubs | Get page of clubs
+[**clubs_squash_matrix_id_get**](DefaultApi.md#clubs_squash_matrix_id_get) | **GET** /clubs/{squashMatrixId} | Get club by Squash Matrix ID
+[**games_game_id_get**](DefaultApi.md#games_game_id_get) | **GET** /games/{gameId} | Get game by ID
+[**games_get**](DefaultApi.md#games_get) | **GET** /games | Get page of games
+[**players_get**](DefaultApi.md#players_get) | **GET** /players | Get page of players
+[**players_squash_matrix_id_get**](DefaultApi.md#players_squash_matrix_id_get) | **GET** /players/{squashMatrixId} | Get player by Squash Matrix ID
+
+
+# **clubs_get**
+> InlineResponse200 clubs_get(opts)
+
+Get page of clubs
+
+### Example
+```ruby
+# load the gem
+require 'squash_matrix_api'
+
+api_instance = SquashMatrixAPI::DefaultApi.new
+
+opts = { 
+  page: 56, # Integer | The page of clubs
+  page_size: 56 # Integer | The size of page
+}
+
+begin
+  #Get page of clubs
+  result = api_instance.clubs_get(opts)
+  p result
+rescue SquashMatrixAPI::ApiError => e
+  puts "Exception when calling DefaultApi->clubs_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| The page of clubs | [optional] 
+ **page_size** | **Integer**| The size of page | [optional] 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **clubs_squash_matrix_id_get**
+> InlineResponse2001 clubs_squash_matrix_id_get(squash_matrix_id)
+
+Get club by Squash Matrix ID
+
+### Example
+```ruby
+# load the gem
+require 'squash_matrix_api'
+
+api_instance = SquashMatrixAPI::DefaultApi.new
+
+squash_matrix_id = 56 # Integer | Squash Matrix ID of club
+
+
+begin
+  #Get club by Squash Matrix ID
+  result = api_instance.clubs_squash_matrix_id_get(squash_matrix_id)
+  p result
+rescue SquashMatrixAPI::ApiError => e
+  puts "Exception when calling DefaultApi->clubs_squash_matrix_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **squash_matrix_id** | **Integer**| Squash Matrix ID of club | 
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **games_game_id_get**
+> InlineResponse2005 games_game_id_get(game_id)
+
+Get game by ID
+
+### Example
+```ruby
+# load the gem
+require 'squash_matrix_api'
+
+api_instance = SquashMatrixAPI::DefaultApi.new
+
+game_id = 56 # Integer | Numeric ID of game
+
+
+begin
+  #Get game by ID
+  result = api_instance.games_game_id_get(game_id)
+  p result
+rescue SquashMatrixAPI::ApiError => e
+  puts "Exception when calling DefaultApi->games_game_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **game_id** | **Integer**| Numeric ID of game | 
+
+### Return type
+
+[**InlineResponse2005**](InlineResponse2005.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **games_get**
+> InlineResponse2004 games_get(opts)
+
+Get page of games
+
+### Example
+```ruby
+# load the gem
+require 'squash_matrix_api'
+
+api_instance = SquashMatrixAPI::DefaultApi.new
+
+opts = { 
+  page: 56, # Integer | The page of games
+  page_size: 56 # Integer | The size of page
+}
+
+begin
+  #Get page of games
+  result = api_instance.games_get(opts)
+  p result
+rescue SquashMatrixAPI::ApiError => e
+  puts "Exception when calling DefaultApi->games_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| The page of games | [optional] 
+ **page_size** | **Integer**| The size of page | [optional] 
+
+### Return type
+
+[**InlineResponse2004**](InlineResponse2004.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **players_get**
+> InlineResponse2002 players_get(opts)
+
+Get page of players
+
+### Example
+```ruby
+# load the gem
+require 'squash_matrix_api'
+
+api_instance = SquashMatrixAPI::DefaultApi.new
+
+opts = { 
+  page: 56, # Integer | The page of players
+  page_size: 56 # Integer | The size of page
+}
+
+begin
+  #Get page of players
+  result = api_instance.players_get(opts)
+  p result
+rescue SquashMatrixAPI::ApiError => e
+  puts "Exception when calling DefaultApi->players_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| The page of players | [optional] 
+ **page_size** | **Integer**| The size of page | [optional] 
+
+### Return type
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **players_squash_matrix_id_get**
+> InlineResponse2003 players_squash_matrix_id_get(squash_matrix_id)
+
+Get player by Squash Matrix ID
+
+### Example
+```ruby
+# load the gem
+require 'squash_matrix_api'
+
+api_instance = SquashMatrixAPI::DefaultApi.new
+
+squash_matrix_id = 56 # Integer | Squash Matrix ID of player
+
+
+begin
+  #Get player by Squash Matrix ID
+  result = api_instance.players_squash_matrix_id_get(squash_matrix_id)
+  p result
+rescue SquashMatrixAPI::ApiError => e
+  puts "Exception when calling DefaultApi->players_squash_matrix_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **squash_matrix_id** | **Integer**| Squash Matrix ID of player | 
+
+### Return type
+
+[**InlineResponse2003**](InlineResponse2003.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+