squash_matrix_api

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 # 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/ # Squash Matrix Scrapper There is a ruby SDK for retrieving information from 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 # Contact Join this endeavor and be appart of the community https://www.facebook.com/squashmatrixapi

---

This SDK is automatically generated by the 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:

gem build squash_matrix_api.gemspec

Then either install the gem locally:

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.

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:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# 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	GET /clubs	Get page of clubs
SquashMatrixAPI::DefaultApi	clubs_squash_matrix_id_get	GET /clubs/{squashMatrixId}	Get club by Squash Matrix ID
SquashMatrixAPI::DefaultApi	games_game_id_get	GET /games/{gameId}	Get game by ID
SquashMatrixAPI::DefaultApi	games_get	GET /games	Get page of games
SquashMatrixAPI::DefaultApi	players_get	GET /players	Get page of players
SquashMatrixAPI::DefaultApi	players_squash_matrix_id_get	GET /players/{squashMatrixId}	Get player by Squash Matrix ID

Documentation for Models

• SquashMatrixAPI::ApiResponseErrors
• SquashMatrixAPI::ApiResponseErrorsErrors
• SquashMatrixAPI::Club
• SquashMatrixAPI::Game
• SquashMatrixAPI::InlineResponse200
• SquashMatrixAPI::InlineResponse2001
• SquashMatrixAPI::InlineResponse2002
• SquashMatrixAPI::InlineResponse2003
• SquashMatrixAPI::InlineResponse2004
• SquashMatrixAPI::InlineResponse2005
• SquashMatrixAPI::Player

Documentation for Authorization

All endpoints do not require authorization.