ftc_api_v3_client 0.1.0

data/docs/EventsApi.md

@@ -0,0 +1,977 @@
+# FtcApiV3Client::EventsApi
+
+All URIs are relative to *https://ftc-api.firstinspires.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_event**](EventsApi.md#get_event) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode} | Get event from season |
+| [**get_event_advancement_from**](EventsApi.md#get_event_advancement_from) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/advancement/from | Get event advancement (from) |
+| [**get_event_alliance_selections**](EventsApi.md#get_event_alliance_selections) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/alliances/selections | Get event alliance selections |
+| [**get_event_alliances**](EventsApi.md#get_event_alliances) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/alliances | Get event alliances |
+| [**get_event_awards**](EventsApi.md#get_event_awards) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/awards | Get event awards |
+| [**get_event_match**](EventsApi.md#get_event_match) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/matches/{tournamentLevel}/{series}/{number} | Get match details |
+| [**get_event_pit_map**](EventsApi.md#get_event_pit_map) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/pitMap | Get pit map |
+| [**get_event_playoff_rankings**](EventsApi.md#get_event_playoff_rankings) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/playoffRankings | Get event playoff rankings |
+| [**get_event_playoff_structure**](EventsApi.md#get_event_playoff_structure) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/playoffStructure | Get playoff structure |
+| [**get_event_rankings**](EventsApi.md#get_event_rankings) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/rankings | Get event rankings |
+| [**list_event_matches**](EventsApi.md#list_event_matches) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/matches | List event matches |
+| [**list_event_teams**](EventsApi.md#list_event_teams) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/teams | List teams for an event |
+| [**list_events**](EventsApi.md#list_events) | **GET** /api/v3/seasons/{cmpYear}/events | List events for a season |
+
+
+## get_event
+
+> <ApiV3Event> get_event(cmp_year, event_code)
+
+Get event from season
+
+Get detailed information about a single event
+
+### 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::EventsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+event_code = 'event_code_example' # String | The code (abbreviation) for the event
+
+begin
+  # Get event from season
+  result = api_instance.get_event(cmp_year, event_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event: #{e}"
+end
+```
+
+#### Using the get_event_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Event>, Integer, Hash)> get_event_with_http_info(cmp_year, event_code)
+
+```ruby
+begin
+  # Get event from season
+  data, status_code, headers = api_instance.get_event_with_http_info(cmp_year, event_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Event>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **event_code** | **String** | The code (abbreviation) for the event |  |
+
+### Return type
+
+[**ApiV3Event**](ApiV3Event.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_event_advancement_from
+
+> <ApiV3AdvancementFrom> get_event_advancement_from(cmp_year, event_code)
+
+Get event advancement (from)
+
+Gets advancement list for teams advancing from this event to the next level of competition
+
+### 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::EventsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+event_code = 'event_code_example' # String | The code (abbreviation) for the event
+
+begin
+  # Get event advancement (from)
+  result = api_instance.get_event_advancement_from(cmp_year, event_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_advancement_from: #{e}"
+end
+```
+
+#### Using the get_event_advancement_from_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3AdvancementFrom>, Integer, Hash)> get_event_advancement_from_with_http_info(cmp_year, event_code)
+
+```ruby
+begin
+  # Get event advancement (from)
+  data, status_code, headers = api_instance.get_event_advancement_from_with_http_info(cmp_year, event_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3AdvancementFrom>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_advancement_from_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **event_code** | **String** | The code (abbreviation) for the event |  |
+
+### Return type
+
+[**ApiV3AdvancementFrom**](ApiV3AdvancementFrom.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_event_alliance_selections
+
+> <ApiV3AllianceSelections> get_event_alliance_selections(cmp_year, event_code)
+
+Get event alliance selections
+
+        Gets alliance selection operations for the given event, including accepts and declines. These         are presented in the order in which they occurred. Refer to the season's competition manual to         confirm the order of alliance selections that year. If you are looking for the final alliances         and are not interested in analyzing the selection process itself, we recommend using the         GetEventAlliances endpoint instead. 
+
+### 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::EventsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+event_code = 'event_code_example' # String | The code (abbreviation) for the event
+
+begin
+  # Get event alliance selections
+  result = api_instance.get_event_alliance_selections(cmp_year, event_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_alliance_selections: #{e}"
+end
+```
+
+#### Using the get_event_alliance_selections_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3AllianceSelections>, Integer, Hash)> get_event_alliance_selections_with_http_info(cmp_year, event_code)
+
+```ruby
+begin
+  # Get event alliance selections
+  data, status_code, headers = api_instance.get_event_alliance_selections_with_http_info(cmp_year, event_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3AllianceSelections>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_alliance_selections_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **event_code** | **String** | The code (abbreviation) for the event |  |
+
+### Return type
+
+[**ApiV3AllianceSelections**](ApiV3AllianceSelections.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_event_alliances
+
+> <ApiV3PlayoffAlliances> get_event_alliances(cmp_year, event_code)
+
+Get event alliances
+
+Gets playoff alliances for the given event
+
+### 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::EventsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+event_code = 'event_code_example' # String | The code (abbreviation) for the event
+
+begin
+  # Get event alliances
+  result = api_instance.get_event_alliances(cmp_year, event_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_alliances: #{e}"
+end
+```
+
+#### Using the get_event_alliances_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3PlayoffAlliances>, Integer, Hash)> get_event_alliances_with_http_info(cmp_year, event_code)
+
+```ruby
+begin
+  # Get event alliances
+  data, status_code, headers = api_instance.get_event_alliances_with_http_info(cmp_year, event_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3PlayoffAlliances>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_alliances_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **event_code** | **String** | The code (abbreviation) for the event |  |
+
+### Return type
+
+[**ApiV3PlayoffAlliances**](ApiV3PlayoffAlliances.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_event_awards
+
+> <ApiV3Awards> get_event_awards(cmp_year, event_code)
+
+Get event awards
+
+Gets award information and recipients for the given event.
+
+### 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::EventsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+event_code = 'event_code_example' # String | The code (abbreviation) for the event
+
+begin
+  # Get event awards
+  result = api_instance.get_event_awards(cmp_year, event_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_awards: #{e}"
+end
+```
+
+#### Using the get_event_awards_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Awards>, Integer, Hash)> get_event_awards_with_http_info(cmp_year, event_code)
+
+```ruby
+begin
+  # Get event awards
+  data, status_code, headers = api_instance.get_event_awards_with_http_info(cmp_year, event_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Awards>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_awards_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **event_code** | **String** | The code (abbreviation) for the event |  |
+
+### Return type
+
+[**ApiV3Awards**](ApiV3Awards.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_event_match
+
+> <ApiV3MatchDetails> get_event_match(cmp_year, event_code, tournament_level, series, number)
+
+Get match details
+
+Gets details for a single match, including season-specific score details.
+
+### 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::EventsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+event_code = 'event_code_example' # String | The code (abbreviation) for the event
+tournament_level = FtcApiV3Client::ApiV3TournamentLevel::QUALIFICATION # ApiV3TournamentLevel | The tournament level of the match
+series = 'series_example' # String | The series of the match (0 for non-playoff matches). For remote events, the team number for the match.
+number = 56 # Integer | The match number
+
+begin
+  # Get match details
+  result = api_instance.get_event_match(cmp_year, event_code, tournament_level, series, number)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_match: #{e}"
+end
+```
+
+#### Using the get_event_match_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3MatchDetails>, Integer, Hash)> get_event_match_with_http_info(cmp_year, event_code, tournament_level, series, number)
+
+```ruby
+begin
+  # Get match details
+  data, status_code, headers = api_instance.get_event_match_with_http_info(cmp_year, event_code, tournament_level, series, number)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3MatchDetails>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_match_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **event_code** | **String** | The code (abbreviation) for the event |  |
+| **tournament_level** | [**ApiV3TournamentLevel**](.md) | The tournament level of the match |  |
+| **series** | **String** | The series of the match (0 for non-playoff matches). For remote events, the team number for the match. |  |
+| **number** | **Integer** | The match number |  |
+
+### Return type
+
+[**ApiV3MatchDetails**](ApiV3MatchDetails.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_event_pit_map
+
+> <ApiV3PitMap> get_event_pit_map(cmp_year, event_code)
+
+Get pit map
+
+Gets data representation of pit map
+
+### 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::EventsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+event_code = 'event_code_example' # String | The code (abbreviation) for the event
+
+begin
+  # Get pit map
+  result = api_instance.get_event_pit_map(cmp_year, event_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_pit_map: #{e}"
+end
+```
+
+#### Using the get_event_pit_map_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3PitMap>, Integer, Hash)> get_event_pit_map_with_http_info(cmp_year, event_code)
+
+```ruby
+begin
+  # Get pit map
+  data, status_code, headers = api_instance.get_event_pit_map_with_http_info(cmp_year, event_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3PitMap>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_pit_map_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **event_code** | **String** | The code (abbreviation) for the event |  |
+
+### Return type
+
+[**ApiV3PitMap**](ApiV3PitMap.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_event_playoff_rankings
+
+> <ApiV3PlayoffRankings> get_event_playoff_rankings(cmp_year, event_code)
+
+Get event playoff rankings
+
+Gets playoff rankings for a given event. Each sort order field is season-specific: see the season's competition manual for definitions. Only applicable to events using round-robin playoffs (e.g. FIRST Championship da Vinci)
+
+### 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::EventsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+event_code = 'event_code_example' # String | The code (abbreviation) for the event
+
+begin
+  # Get event playoff rankings
+  result = api_instance.get_event_playoff_rankings(cmp_year, event_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_playoff_rankings: #{e}"
+end
+```
+
+#### Using the get_event_playoff_rankings_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3PlayoffRankings>, Integer, Hash)> get_event_playoff_rankings_with_http_info(cmp_year, event_code)
+
+```ruby
+begin
+  # Get event playoff rankings
+  data, status_code, headers = api_instance.get_event_playoff_rankings_with_http_info(cmp_year, event_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3PlayoffRankings>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_playoff_rankings_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **event_code** | **String** | The code (abbreviation) for the event |  |
+
+### Return type
+
+[**ApiV3PlayoffRankings**](ApiV3PlayoffRankings.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_event_playoff_structure
+
+> <ApiV3PlayoffStructure> get_event_playoff_structure(cmp_year, event_code)
+
+Get playoff structure
+
+Gets programmatic description of the playoff structure (e.g. bracket) structure for event. Contains sufficient information to construct a bracket display.
+
+### 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::EventsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+event_code = 'event_code_example' # String | The code (abbreviation) for the event
+
+begin
+  # Get playoff structure
+  result = api_instance.get_event_playoff_structure(cmp_year, event_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_playoff_structure: #{e}"
+end
+```
+
+#### Using the get_event_playoff_structure_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3PlayoffStructure>, Integer, Hash)> get_event_playoff_structure_with_http_info(cmp_year, event_code)
+
+```ruby
+begin
+  # Get playoff structure
+  data, status_code, headers = api_instance.get_event_playoff_structure_with_http_info(cmp_year, event_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3PlayoffStructure>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_playoff_structure_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **event_code** | **String** | The code (abbreviation) for the event |  |
+
+### Return type
+
+[**ApiV3PlayoffStructure**](ApiV3PlayoffStructure.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_event_rankings
+
+> <ApiV3Rankings> get_event_rankings(cmp_year, event_code)
+
+Get event rankings
+
+Gets rankings for a given event. Each sort order field is season-specific: see the season's competition manual for definitions. Do not use for league meets or multi-division parent events
+
+### 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::EventsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+event_code = 'event_code_example' # String | The code (abbreviation) for the event
+
+begin
+  # Get event rankings
+  result = api_instance.get_event_rankings(cmp_year, event_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_rankings: #{e}"
+end
+```
+
+#### Using the get_event_rankings_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Rankings>, Integer, Hash)> get_event_rankings_with_http_info(cmp_year, event_code)
+
+```ruby
+begin
+  # Get event rankings
+  data, status_code, headers = api_instance.get_event_rankings_with_http_info(cmp_year, event_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Rankings>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->get_event_rankings_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **event_code** | **String** | The code (abbreviation) for the event |  |
+
+### Return type
+
+[**ApiV3Rankings**](ApiV3Rankings.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_event_matches
+
+> <ApiV3Matches> list_event_matches(cmp_year, event_code, opts)
+
+List event matches
+
+Gets matches for a given event. Includes winner and score information if available. Score details must be fetched per match.
+
+### 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::EventsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+event_code = 'event_code_example' # String | The code (abbreviation) for the event
+opts = {
+  phase: FtcApiV3Client::ApiV3TournamentLevel::QUALIFICATION # ApiV3TournamentLevel | Filter matches to a specific phase
+}
+
+begin
+  # List event matches
+  result = api_instance.list_event_matches(cmp_year, event_code, opts)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->list_event_matches: #{e}"
+end
+```
+
+#### Using the list_event_matches_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Matches>, Integer, Hash)> list_event_matches_with_http_info(cmp_year, event_code, opts)
+
+```ruby
+begin
+  # List event matches
+  data, status_code, headers = api_instance.list_event_matches_with_http_info(cmp_year, event_code, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Matches>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->list_event_matches_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **event_code** | **String** | The code (abbreviation) for the event |  |
+| **phase** | [**ApiV3TournamentLevel**](.md) | Filter matches to a specific phase | [optional] |
+
+### Return type
+
+[**ApiV3Matches**](ApiV3Matches.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_event_teams
+
+> <ApiV3EventParticipants> list_event_teams(cmp_year, event_code)
+
+List teams for an event
+
+Lists all teams competing at the event. This includes division assignments if published for this event (and this event is a multi-division parent event). In some cases, teams may be award recipients but not returned in this list. Their information can be fetched individually by number.
+
+### 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::EventsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+event_code = 'event_code_example' # String | The code (abbreviation) for the event
+
+begin
+  # List teams for an event
+  result = api_instance.list_event_teams(cmp_year, event_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->list_event_teams: #{e}"
+end
+```
+
+#### Using the list_event_teams_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3EventParticipants>, Integer, Hash)> list_event_teams_with_http_info(cmp_year, event_code)
+
+```ruby
+begin
+  # List teams for an event
+  data, status_code, headers = api_instance.list_event_teams_with_http_info(cmp_year, event_code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3EventParticipants>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->list_event_teams_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cmp_year** | **String** | The year of the FIRST Championship for the requested season |  |
+| **event_code** | **String** | The code (abbreviation) for the event |  |
+
+### Return type
+
+[**ApiV3EventParticipants**](ApiV3EventParticipants.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_events
+
+> <ApiV3Events> list_events(cmp_year)
+
+List events for a season
+
+Lists all events 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::EventsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+
+begin
+  # List events for a season
+  result = api_instance.list_events(cmp_year)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->list_events: #{e}"
+end
+```
+
+#### Using the list_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV3Events>, Integer, Hash)> list_events_with_http_info(cmp_year)
+
+```ruby
+begin
+  # List events for a season
+  data, status_code, headers = api_instance.list_events_with_http_info(cmp_year)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV3Events>
+rescue FtcApiV3Client::ApiError => e
+  puts "Error when calling EventsApi->list_events_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
+
+[**ApiV3Events**](ApiV3Events.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+