ftc_events_client 0.1.0

data/docs/MatchResultModelVersion2.md

@@ -0,0 +1,44 @@
+# FtcEventsClient::MatchResultModelVersion2
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **actual_start_time** | **Time** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **tournament_level** | **String** |  | [optional] |
+| **series** | **Integer** |  | [optional] |
+| **match_number** | **Integer** |  | [optional] |
+| **score_red_final** | **Integer** |  | [optional] |
+| **score_red_foul** | **Integer** |  | [optional] |
+| **score_red_auto** | **Integer** |  | [optional] |
+| **score_blue_final** | **Integer** |  | [optional] |
+| **score_blue_foul** | **Integer** |  | [optional] |
+| **score_blue_auto** | **Integer** |  | [optional] |
+| **post_result_time** | **Time** |  | [optional] |
+| **teams** | [**Array<MatchResultTeamModelVersion2>**](MatchResultTeamModelVersion2.md) |  | [optional] |
+| **modified_on** | **Time** |  | [optional] |
+
+## Code Sample
+
+```ruby
+require 'ftc_events_client'
+
+instance = FtcEventsClient::MatchResultModelVersion2.new(
+  actual_start_time: null,
+  description: null,
+  tournament_level: null,
+  series: null,
+  match_number: null,
+  score_red_final: null,
+  score_red_foul: null,
+  score_red_auto: null,
+  score_blue_final: null,
+  score_blue_foul: null,
+  score_blue_auto: null,
+  post_result_time: null,
+  teams: null,
+  modified_on: null
+)
+```
+

data/docs/MatchResultTeamModelVersion2.md

@@ -0,0 +1,22 @@
+# FtcEventsClient::MatchResultTeamModelVersion2
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team_number** | **Integer** |  | [optional] |
+| **station** | **String** |  | [optional] |
+| **dq** | **Boolean** |  | [optional] |
+
+## Code Sample
+
+```ruby
+require 'ftc_events_client'
+
+instance = FtcEventsClient::MatchResultTeamModelVersion2.new(
+  team_number: null,
+  station: null,
+  dq: null
+)
+```
+

data/docs/MatchResultsApi.md

@@ -0,0 +1,141 @@
+# FtcEventsClient::MatchResultsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v20_season_matches_event_code_get**](MatchResultsApi.md#v20_season_matches_event_code_get) | **GET** /v2.0/{season}/matches/{eventCode} | Event Match Results |
+| [**v20_season_scores_event_code_tournament_level_get**](MatchResultsApi.md#v20_season_scores_event_code_tournament_level_get) | **GET** /v2.0/{season}/scores/{eventCode}/{tournamentLevel} | Score Details |
+
+
+## v20_season_matches_event_code_get
+
+> EventMatchResultsModelVersion2 v20_season_matches_event_code_get(season, event_code, opts)
+
+Event Match Results
+
+The match results API returns the match results for all matches of a particular event in a particular season. Match results are only available once a match has been played, retrieving info about future matches requires the event schedule API. You cannot receive data about a match that is in progress. You can, however, request the Hybrid Schedule if you would like data about upcoming and played matches at the same time.   If you specify the `matchNumber`, `start` and/or `end` optional parameters, you must also specify a `tournamentLevel`. If you specify the `teamNumber` parameter, you cannot specify a `matchNumber` parameter. If you specify the `matchNumber`, you cannot define a start or end.   Note: If you specify `start`, and it is higher than the maximum match number at the event, you will not receive any match results in the response. The same is true in reverse for the `end` parameter.
+
+### Example
+
+```ruby
+# load the gem
+require 'ftc_events_client'
+# setup authorization
+FtcEventsClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FtcEventsClient::MatchResultsApi.new
+season = 56 # Integer | Numeric year of the event from which the match results are requested. Must be 4 digits.
+event_code = 'event_code_example' # String | Case insensitive alphanumeric `eventCode` of the event from which the results are requested. Must be at least 3 characters.
+opts = {
+  tournament_level: '0', # String | Required tournamentLevel of desired score details.
+  team_number: 56, # Integer | `teamNumber` to search for within the results. Only returns match results in which the requested team was a participant.
+  match_number: 56, # Integer | specific single `matchNumber` of result.
+  start: 0, # Integer | `start` match number for subset of results to return.
+  _end: 999 # Integer | `end` match number for subset of results to return (inclusive).
+}
+
+begin
+  #Event Match Results
+  result = api_instance.v20_season_matches_event_code_get(season, event_code, opts)
+  p result
+rescue FtcEventsClient::ApiError => e
+  puts "Exception when calling MatchResultsApi->v20_season_matches_event_code_get: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **season** | **Integer** | Numeric year of the event from which the match results are requested. Must be 4 digits. |  |
+| **event_code** | **String** | Case insensitive alphanumeric `eventCode` of the event from which the results are requested. Must be at least 3 characters. |  |
+| **tournament_level** | **String** | Required tournamentLevel of desired score details. | [optional][default to '0'] |
+| **team_number** | **Integer** | `teamNumber` to search for within the results. Only returns match results in which the requested team was a participant. | [optional] |
+| **match_number** | **Integer** | specific single `matchNumber` of result. | [optional] |
+| **start** | **Integer** | `start` match number for subset of results to return. | [optional][default to 0] |
+| **_end** | **Integer** | `end` match number for subset of results to return (inclusive). | [optional][default to 999] |
+
+### Return type
+
+[**EventMatchResultsModelVersion2**](EventMatchResultsModelVersion2.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v20_season_scores_event_code_tournament_level_get
+
+> MatchScoresModel v20_season_scores_event_code_tournament_level_get(season, event_code, tournament_level, opts)
+
+Score Details
+
+The score details API returns the score detail for all matches of a particular event in a particular season and a particular tournament level. Score details are only available once a match has been played, retrieving info about future matches requires the event schedule API. You cannot receive data about a match that is in progress.
+
+### Example
+
+```ruby
+# load the gem
+require 'ftc_events_client'
+# setup authorization
+FtcEventsClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FtcEventsClient::MatchResultsApi.new
+season = 56 # Integer | Numeric year of the event from which the match results are requested. Must be 4 digits.
+event_code = 'event_code_example' # String | Case insensitive alphanumeric eventCode of the event from which the details are requested. Must be at least 3 characters.
+tournament_level = 'tournament_level_example' # String | Required tournamentLevel of desired score details.
+opts = {
+  team_number: 56, # Integer | `teamNumber` to search for within the results. Only returns details in which the requested team was a participant.
+  match_number: 56, # Integer | specific single `matchNumber` of result.
+  start: 0, # Integer | `start` match number for subset of results to return (inclusive).
+  _end: 999 # Integer | `end` match number for subset of results to return (inclusive).
+}
+
+begin
+  #Score Details
+  result = api_instance.v20_season_scores_event_code_tournament_level_get(season, event_code, tournament_level, opts)
+  p result
+rescue FtcEventsClient::ApiError => e
+  puts "Exception when calling MatchResultsApi->v20_season_scores_event_code_tournament_level_get: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **season** | **Integer** | Numeric year of the event from which the match results are requested. Must be 4 digits. |  |
+| **event_code** | **String** | Case insensitive alphanumeric eventCode of the event from which the details are requested. Must be at least 3 characters. |  |
+| **tournament_level** | **String** | Required tournamentLevel of desired score details. |  |
+| **team_number** | **Integer** | `teamNumber` to search for within the results. Only returns details in which the requested team was a participant. | [optional] |
+| **match_number** | **Integer** | specific single `matchNumber` of result. | [optional] |
+| **start** | **Integer** | `start` match number for subset of results to return (inclusive). | [optional][default to 0] |
+| **_end** | **Integer** | `end` match number for subset of results to return (inclusive). | [optional][default to 999] |
+
+### Return type
+
+[**MatchScoresModel**](MatchScoresModel.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/MatchScoresModel.md

@@ -0,0 +1,18 @@
+# FtcEventsClient::MatchScoresModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **match_scores** | [**Array<MatchScoresModelMatchScoresOneOf>**](MatchScoresModelMatchScoresOneOf.md) |  | [optional] |
+
+## Code Sample
+
+```ruby
+require 'ftc_events_client'
+
+instance = FtcEventsClient::MatchScoresModel.new(
+  match_scores: null
+)
+```
+

data/docs/MatchScoresModelMatchScoresOneOf.md

@@ -0,0 +1,51 @@
+# FtcEventsClient::MatchScoresModelMatchScoresOneOf
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ftc_events_client'
+
+FtcEventsClient::MatchScoresModelMatchScoresOneOf.openapi_one_of
+# =>
+# [
+#   :'ScoreDetailModel2019',
+#   :'ScoreDetailModel2020',
+#   :'ScoreDetailModelSinglePlayer2020'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ftc_events_client'
+
+FtcEventsClient::MatchScoresModelMatchScoresOneOf.build(data)
+# => #<ScoreDetailModel2019:0x00007fdd4aab02a0>
+
+FtcEventsClient::MatchScoresModelMatchScoresOneOf.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ScoreDetailModel2019`
+- `ScoreDetailModel2020`
+- `ScoreDetailModelSinglePlayer2020`
+- `nil` (if no type matches)
+

data/docs/RankingsApi.md

@@ -0,0 +1,68 @@
+# FtcEventsClient::RankingsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v20_season_rankings_event_code_get**](RankingsApi.md#v20_season_rankings_event_code_get) | **GET** /v2.0/{season}/rankings/{eventCode} | Event Rankings |
+
+
+## v20_season_rankings_event_code_get
+
+> EventRankingsModel v20_season_rankings_event_code_get(season, event_code, opts)
+
+Event Rankings
+
+The rankings API returns team ranking detail from a particular event in a particular season. Optionally, the `top` parameter can be added to the query string to request a subset of the rankings based on the highest ranked teams at the time of the request. Alternately, you can specify the `teamNumber` parameter to retrieve the ranking on one specific team. You cannot specify both a `top` and `teamNumber` in the same call.
+
+### Example
+
+```ruby
+# load the gem
+require 'ftc_events_client'
+# setup authorization
+FtcEventsClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FtcEventsClient::RankingsApi.new
+season = 56 # Integer | Numeric year of the event from which the rankings are requested. Must be 4 digits
+event_code = 'event_code_example' # String | Case insensitive alphanumeric `eventCode` of the event from which the rankings are requested. Must be at least 3 characters.
+opts = {
+  team_number: 0, # Integer | Team number of the team whose ranking is requested.
+  top: 0 # Integer | number of requested `top` ranked teams to return in result.
+}
+
+begin
+  #Event Rankings
+  result = api_instance.v20_season_rankings_event_code_get(season, event_code, opts)
+  p result
+rescue FtcEventsClient::ApiError => e
+  puts "Exception when calling RankingsApi->v20_season_rankings_event_code_get: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **season** | **Integer** | Numeric year of the event from which the rankings are requested. Must be 4 digits |  |
+| **event_code** | **String** | Case insensitive alphanumeric `eventCode` of the event from which the rankings are requested. Must be at least 3 characters. |  |
+| **team_number** | **Integer** | Team number of the team whose ranking is requested. | [optional][default to 0] |
+| **top** | **Integer** | number of requested `top` ranked teams to return in result. | [optional][default to 0] |
+
+### Return type
+
+[**EventRankingsModel**](EventRankingsModel.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ScheduleApi.md

@@ -0,0 +1,135 @@
+# FtcEventsClient::ScheduleApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v20_season_schedule_event_code_get**](ScheduleApi.md#v20_season_schedule_event_code_get) | **GET** /v2.0/{season}/schedule/{eventCode} | Event Schedule |
+| [**v20_season_schedule_event_code_tournament_level_hybrid_get**](ScheduleApi.md#v20_season_schedule_event_code_tournament_level_hybrid_get) | **GET** /v2.0/{season}/schedule/{eventCode}/{tournamentLevel}/hybrid | Hybrid Schedule |
+
+
+## v20_season_schedule_event_code_get
+
+> EventScheduleModelVersion2 v20_season_schedule_event_code_get(season, event_code, opts)
+
+Event Schedule
+
+The schedule API returns the match schedule for the desired tournament level of a particular event in a particular season. You must also specify a `tournamentLevel` from which to return the results. Alternately, you can specify a `teamNumber` to filter the results to only those in which a particular team is participating. There is no validation that the `teamNumber` you request is actually competing at the event, if they are not, the response will be empty. You can also specify the parameters together, but cannot make a request without at least one of the two.
+
+### Example
+
+```ruby
+# load the gem
+require 'ftc_events_client'
+# setup authorization
+FtcEventsClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FtcEventsClient::ScheduleApi.new
+season = 56 # Integer | Numeric year of the event from which the schedule is requested. Must be 4 digits
+event_code = 'event_code_example' # String | Case insensitive alphanumeric `eventCode` of the event from which the schedule are requested. Must be at least 3 characters.
+opts = {
+  tournament_level: '0', # String | Required tournamentLevel of desired score details.
+  team_number: 0, # Integer | `teamNumber` to search for within the schedule. Only returns matches in which the requested team participated.
+  start: 0, # Integer | `start` match number for subset of results to return (inclusive).
+  _end: 999 # Integer | `end` match number for subset of results to return (inclusive).
+}
+
+begin
+  #Event Schedule
+  result = api_instance.v20_season_schedule_event_code_get(season, event_code, opts)
+  p result
+rescue FtcEventsClient::ApiError => e
+  puts "Exception when calling ScheduleApi->v20_season_schedule_event_code_get: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **season** | **Integer** | Numeric year of the event from which the schedule is requested. Must be 4 digits |  |
+| **event_code** | **String** | Case insensitive alphanumeric `eventCode` of the event from which the schedule are requested. Must be at least 3 characters. |  |
+| **tournament_level** | **String** | Required tournamentLevel of desired score details. | [optional][default to '0'] |
+| **team_number** | **Integer** | `teamNumber` to search for within the schedule. Only returns matches in which the requested team participated. | [optional][default to 0] |
+| **start** | **Integer** | `start` match number for subset of results to return (inclusive). | [optional][default to 0] |
+| **_end** | **Integer** | `end` match number for subset of results to return (inclusive). | [optional][default to 999] |
+
+### Return type
+
+[**EventScheduleModelVersion2**](EventScheduleModelVersion2.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v20_season_schedule_event_code_tournament_level_hybrid_get
+
+> EventScheduleHybridModelVersion2 v20_season_schedule_event_code_tournament_level_hybrid_get(season, event_code, tournament_level, opts)
+
+Hybrid Schedule
+
+The schedule API returns the match schedule for the desired tournament level of a particular event in a particular season in the hybrid format. When a match has been played, the match result related details will be filled. When a match has not yet happened, match result related fields will be null. All parameters, except start and end, are required for the hybrid schedule.
+
+### Example
+
+```ruby
+# load the gem
+require 'ftc_events_client'
+# setup authorization
+FtcEventsClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FtcEventsClient::ScheduleApi.new
+season = 56 # Integer | Numeric year of the event from which the hybrid schedule is requested. Must be 4 digits
+event_code = 'event_code_example' # String | Case insensitive alphanumeric eventCode of the event from which the hybrid schedule is requested. Must be at least 3 characters.
+tournament_level = 'tournament_level_example' # String | Required tournamentLevel of desired score details.
+opts = {
+  start: 0, # Integer | `start` match number for subset of results to return (inclusive).
+  _end: 999 # Integer | `end` match number for subset of results to return (inclusive).
+}
+
+begin
+  #Hybrid Schedule
+  result = api_instance.v20_season_schedule_event_code_tournament_level_hybrid_get(season, event_code, tournament_level, opts)
+  p result
+rescue FtcEventsClient::ApiError => e
+  puts "Exception when calling ScheduleApi->v20_season_schedule_event_code_tournament_level_hybrid_get: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **season** | **Integer** | Numeric year of the event from which the hybrid schedule is requested. Must be 4 digits |  |
+| **event_code** | **String** | Case insensitive alphanumeric eventCode of the event from which the hybrid schedule is requested. Must be at least 3 characters. |  |
+| **tournament_level** | **String** | Required tournamentLevel of desired score details. |  |
+| **start** | **Integer** | `start` match number for subset of results to return (inclusive). | [optional][default to 0] |
+| **_end** | **Integer** | `end` match number for subset of results to return (inclusive). | [optional][default to 999] |
+
+### Return type
+
+[**EventScheduleHybridModelVersion2**](EventScheduleHybridModelVersion2.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+