ftc_api_v3_client 0.1.0

data/docs/LeaguesApi.md

@@ -0,0 +1,385 @@
+# FtcApiV3Client::LeaguesApi
+
+All URIs are relative to *https://ftc-api.firstinspires.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_league**](LeaguesApi.md#get_league) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode}/leagues/{leagueCode} | Gets a single league from a region |
+| [**get_league_rankings**](LeaguesApi.md#get_league_rankings) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode}/leagues/{leagueCode}/rankings | Get rankings for a league |
+| [**list_league_events**](LeaguesApi.md#list_league_events) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode}/leagues/{leagueCode}/events | List events for a league |
+| [**list_league_teams**](LeaguesApi.md#list_league_teams) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode}/leagues/{leagueCode}/teams | List teams for a league |
+| [**list_leagues**](LeaguesApi.md#list_leagues) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode}/leagues | Lists leagues for a region |
+
+
+## get_league
+
+> <ApiV3LeagueDetails> get_league(cmp_year, region_code, league_code)
+
+Gets a single league from a region
+
+Gets a leagues for a region in a season, including any children
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::LeaguesApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+region_code = 'region_code_example' # String | The code (abbreviation) for the region
+league_code = 'league_code_example' # String | The code (abbreviation) for the league
+
+begin
+  # Gets a single league from a region
+  result = api_instance.get_league(cmp_year, region_code, league_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling LeaguesApi->get_league: #{e}"
+end
+```
+
+#### Using the get_league_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3LeagueDetails>, Integer, Hash)> get_league_with_http_info(cmp_year, region_code, league_code)
+
+```ruby
+begin
+  # Gets a single league from a region
+  data, status_code, headers = api_instance.get_league_with_http_info(cmp_year, region_code, league_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3LeagueDetails>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling LeaguesApi->get_league_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **region_code** | **String** | The code (abbreviation) for the region |  |
+| **league_code** | **String** | The code (abbreviation) for the league |  |
+
+### Return type
+
+[**ApiV3LeagueDetails**](ApiV3LeagueDetails.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_league_rankings
+
+> <ApiV3Rankings> get_league_rankings(cmp_year, region_code, league_code)
+
+Get rankings for a league
+
+Gets league rankings for a given league. This only includes matches played in League Meets. For rankings including the League Tournament, use the tournament event's rankings endpoint instead. Each sort order field is season-specific: see the season's competition manual for definitions. The last non-zero sort order is the scoring system randomly generated tiebreaker value.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::LeaguesApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+region_code = 'region_code_example' # String | The code (abbreviation) for the region
+league_code = 'league_code_example' # String | The code (abbreviation) for the league
+
+begin
+  # Get rankings for a league
+  result = api_instance.get_league_rankings(cmp_year, region_code, league_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling LeaguesApi->get_league_rankings: #{e}"
+end
+```
+
+#### Using the get_league_rankings_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Rankings>, Integer, Hash)> get_league_rankings_with_http_info(cmp_year, region_code, league_code)
+
+```ruby
+begin
+  # Get rankings for a league
+  data, status_code, headers = api_instance.get_league_rankings_with_http_info(cmp_year, region_code, league_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Rankings>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling LeaguesApi->get_league_rankings_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **region_code** | **String** | The code (abbreviation) for the region |  |
+| **league_code** | **String** | The code (abbreviation) for the league |  |
+
+### Return type
+
+[**ApiV3Rankings**](ApiV3Rankings.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_league_events
+
+> <ApiV3Events> list_league_events(cmp_year, region_code, league_code)
+
+List events for a league
+
+Lists all events in a league, including events in child leagues.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::LeaguesApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+region_code = 'region_code_example' # String | The code (abbreviation) for the region
+league_code = 'league_code_example' # String | The code (abbreviation) for the league
+
+begin
+  # List events for a league
+  result = api_instance.list_league_events(cmp_year, region_code, league_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling LeaguesApi->list_league_events: #{e}"
+end
+```
+
+#### Using the list_league_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Events>, Integer, Hash)> list_league_events_with_http_info(cmp_year, region_code, league_code)
+
+```ruby
+begin
+  # List events for a league
+  data, status_code, headers = api_instance.list_league_events_with_http_info(cmp_year, region_code, league_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Events>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling LeaguesApi->list_league_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **region_code** | **String** | The code (abbreviation) for the region |  |
+| **league_code** | **String** | The code (abbreviation) for the league |  |
+
+### Return type
+
+[**ApiV3Events**](ApiV3Events.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_league_teams
+
+> <ApiV3Teams> list_league_teams(cmp_year, region_code, league_code)
+
+List teams for a league
+
+Lists all teams assigned to the given league.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::LeaguesApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+region_code = 'region_code_example' # String | The code (abbreviation) for the region
+league_code = 'league_code_example' # String | The code (abbreviation) for the league
+
+begin
+  # List teams for a league
+  result = api_instance.list_league_teams(cmp_year, region_code, league_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling LeaguesApi->list_league_teams: #{e}"
+end
+```
+
+#### Using the list_league_teams_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Teams>, Integer, Hash)> list_league_teams_with_http_info(cmp_year, region_code, league_code)
+
+```ruby
+begin
+  # List teams for a league
+  data, status_code, headers = api_instance.list_league_teams_with_http_info(cmp_year, region_code, league_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Teams>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling LeaguesApi->list_league_teams_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **region_code** | **String** | The code (abbreviation) for the region |  |
+| **league_code** | **String** | The code (abbreviation) for the league |  |
+
+### Return type
+
+[**ApiV3Teams**](ApiV3Teams.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_leagues
+
+> <ApiV3Leagues> list_leagues(cmp_year, region_code)
+
+Lists leagues for a region
+
+Lists all leagues for a region in a season. Parent/child relationships can be determined from the `parentCode` field of each league. League parents are guaranteed to be in the same region as their children.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::LeaguesApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+region_code = 'region_code_example' # String | The code (abbreviation) for the region
+
+begin
+  # Lists leagues for a region
+  result = api_instance.list_leagues(cmp_year, region_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling LeaguesApi->list_leagues: #{e}"
+end
+```
+
+#### Using the list_leagues_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Leagues>, Integer, Hash)> list_leagues_with_http_info(cmp_year, region_code)
+
+```ruby
+begin
+  # Lists leagues for a region
+  data, status_code, headers = api_instance.list_leagues_with_http_info(cmp_year, region_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Leagues>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling LeaguesApi->list_leagues_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **region_code** | **String** | The code (abbreviation) for the region |  |
+
+### Return type
+
+[**ApiV3Leagues**](ApiV3Leagues.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RegionsApi.md

@@ -0,0 +1,301 @@
+# FtcApiV3Client::RegionsApi
+
+All URIs are relative to *https://ftc-api.firstinspires.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_region**](RegionsApi.md#get_region) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode} | Get region from a season |
+| [**list_region_events**](RegionsApi.md#list_region_events) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode}/events | List events for a regions |
+| [**list_region_teams**](RegionsApi.md#list_region_teams) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode}/teams | List teams for a region |
+| [**list_regions**](RegionsApi.md#list_regions) | **GET** /api/v3/seasons/{cmpYear}/regions | List regions for a season |
+
+
+## get_region
+
+> <ApiV3Region> get_region(cmp_year, region_code)
+
+Get region from a season
+
+Gets details for a single region for a season.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::RegionsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+region_code = 'region_code_example' # String | The code (abbreviation) for the region
+
+begin
+  # Get region from a season
+  result = api_instance.get_region(cmp_year, region_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling RegionsApi->get_region: #{e}"
+end
+```
+
+#### Using the get_region_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Region>, Integer, Hash)> get_region_with_http_info(cmp_year, region_code)
+
+```ruby
+begin
+  # Get region from a season
+  data, status_code, headers = api_instance.get_region_with_http_info(cmp_year, region_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Region>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling RegionsApi->get_region_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **region_code** | **String** | The code (abbreviation) for the region |  |
+
+### Return type
+
+[**ApiV3Region**](ApiV3Region.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_region_events
+
+> <ApiV3Events> list_region_events(cmp_year, region_code)
+
+List events for a regions
+
+Lists all events in a region
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::RegionsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+region_code = 'region_code_example' # String | The code (abbreviation) for the region
+
+begin
+  # List events for a regions
+  result = api_instance.list_region_events(cmp_year, region_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling RegionsApi->list_region_events: #{e}"
+end
+```
+
+#### Using the list_region_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Events>, Integer, Hash)> list_region_events_with_http_info(cmp_year, region_code)
+
+```ruby
+begin
+  # List events for a regions
+  data, status_code, headers = api_instance.list_region_events_with_http_info(cmp_year, region_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Events>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling RegionsApi->list_region_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **region_code** | **String** | The code (abbreviation) for the region |  |
+
+### Return type
+
+[**ApiV3Events**](ApiV3Events.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_region_teams
+
+> <ApiV3Teams> list_region_teams(cmp_year, region_code)
+
+List teams for a region
+
+Lists all registered teams assigned to the given region.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::RegionsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+region_code = 'region_code_example' # String | The code (abbreviation) for the region
+
+begin
+  # List teams for a region
+  result = api_instance.list_region_teams(cmp_year, region_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling RegionsApi->list_region_teams: #{e}"
+end
+```
+
+#### Using the list_region_teams_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Teams>, Integer, Hash)> list_region_teams_with_http_info(cmp_year, region_code)
+
+```ruby
+begin
+  # List teams for a region
+  data, status_code, headers = api_instance.list_region_teams_with_http_info(cmp_year, region_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Teams>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling RegionsApi->list_region_teams_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **region_code** | **String** | The code (abbreviation) for the region |  |
+
+### Return type
+
+[**ApiV3Teams**](ApiV3Teams.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_regions
+
+> <ApiV3Regions> list_regions(cmp_year)
+
+List regions for a season
+
+Lists all active regions for a season.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ftc_api_v3_client'
+# setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::RegionsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+
+begin
+  # List regions for a season
+  result = api_instance.list_regions(cmp_year)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling RegionsApi->list_regions: #{e}"
+end
+```
+
+#### Using the list_regions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Regions>, Integer, Hash)> list_regions_with_http_info(cmp_year)
+
+```ruby
+begin
+  # List regions for a season
+  data, status_code, headers = api_instance.list_regions_with_http_info(cmp_year)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Regions>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling RegionsApi->list_regions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+
+### Return type
+
+[**ApiV3Regions**](ApiV3Regions.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+