ftc_events_client 0.1.0

data/docs/ScheduleHybridModelTeamVersion2.md

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

data/docs/ScheduleHybridModelVersion2.md

@@ -0,0 +1,44 @@
+# FtcEventsClient::ScheduleHybridModelVersion2
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** |  | [optional] |
+| **tournament_level** | **String** |  | [optional] |
+| **series** | **Integer** |  | [optional] |
+| **match_number** | **Integer** |  | [optional] |
+| **start_time** | **Time** |  | [optional] |
+| **actual_start_time** | **Time** |  | [optional] |
+| **post_result_time** | **Time** |  | [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] |
+| **teams** | [**Array<ScheduleHybridModelTeamVersion2>**](ScheduleHybridModelTeamVersion2.md) |  | [optional] |
+
+## Code Sample
+
+```ruby
+require 'ftc_events_client'
+
+instance = FtcEventsClient::ScheduleHybridModelVersion2.new(
+  description: null,
+  tournament_level: null,
+  series: null,
+  match_number: null,
+  start_time: null,
+  actual_start_time: null,
+  post_result_time: 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,
+  teams: null
+)
+```
+

data/docs/ScheduledMatchModelVersion2.md

@@ -0,0 +1,32 @@
+# FtcEventsClient::ScheduledMatchModelVersion2
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** |  | [optional] |
+| **field** | **String** |  | [optional] |
+| **tournament_level** | **String** |  | [optional] |
+| **start_time** | **Time** |  | [optional] |
+| **series** | **Integer** |  | [optional] |
+| **match_number** | **Integer** |  | [optional] |
+| **teams** | [**Array<ScheduledMatchTeamModelVersion2>**](ScheduledMatchTeamModelVersion2.md) |  | [optional] |
+| **modified_on** | **Time** |  | [optional] |
+
+## Code Sample
+
+```ruby
+require 'ftc_events_client'
+
+instance = FtcEventsClient::ScheduledMatchModelVersion2.new(
+  description: null,
+  field: null,
+  tournament_level: null,
+  start_time: null,
+  series: null,
+  match_number: null,
+  teams: null,
+  modified_on: null
+)
+```
+

data/docs/ScheduledMatchTeamModelVersion2.md

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

data/docs/ScoreDetailAllianceModel2020.md

@@ -0,0 +1,90 @@
+# FtcEventsClient::ScoreDetailAllianceModel2020
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **adjust** | **Integer** |  | [optional] |
+| **dc_points** | **Integer** |  | [optional] |
+| **auto_points** | **Integer** |  | [optional] |
+| **dc_tower_low** | **Integer** |  | [optional] |
+| **dc_tower_mid** | **Integer** |  | [optional] |
+| **dc_tower_high** | **Integer** |  | [optional] |
+| **navigated1** | **Boolean** |  | [optional] |
+| **navigated2** | **Boolean** |  | [optional] |
+| **wobble_delivered1** | **Boolean** |  | [optional] |
+| **wobble_delivered2** | **Boolean** |  | [optional] |
+| **auto_tower_low** | **Integer** |  | [optional] |
+| **auto_tower_mid** | **Integer** |  | [optional] |
+| **auto_tower_high** | **Integer** |  | [optional] |
+| **auto_tower_points** | **Integer** |  | [optional] |
+| **auto_power_shot_left** | **Boolean** |  | [optional] |
+| **auto_power_shot_center** | **Boolean** |  | [optional] |
+| **auto_power_shot_right** | **Boolean** |  | [optional] |
+| **auto_power_shot_points** | **Integer** |  | [optional] |
+| **wobble_rings1** | **Integer** |  | [optional] |
+| **wobble_rings2** | **Integer** |  | [optional] |
+| **wobble_end1** | **Integer** |  | [optional] |
+| **wobble_end2** | **Integer** |  | [optional] |
+| **wobble_end_points** | **Integer** |  | [optional] |
+| **wobble_ring_points** | **Integer** |  | [optional] |
+| **auto_wobble_points** | **Integer** |  | [optional] |
+| **end_power_shot_left** | **Boolean** |  | [optional] |
+| **end_power_shot_center** | **Boolean** |  | [optional] |
+| **end_power_shot_right** | **Boolean** |  | [optional] |
+| **end_power_shot_points** | **Integer** |  | [optional] |
+| **penalty_points** | **Integer** |  | [optional] |
+| **major_penalties** | **Integer** |  | [optional] |
+| **minor_penalties** | **Integer** |  | [optional] |
+| **navigation_points** | **Integer** |  | [optional] |
+| **endgame_points** | **Integer** |  | [optional] |
+| **total_points** | **Integer** |  | [optional] |
+| **alliance** | **String** |  | [optional] |
+| **team** | **Integer** |  | [optional] |
+
+## Code Sample
+
+```ruby
+require 'ftc_events_client'
+
+instance = FtcEventsClient::ScoreDetailAllianceModel2020.new(
+  adjust: null,
+  dc_points: null,
+  auto_points: null,
+  dc_tower_low: null,
+  dc_tower_mid: null,
+  dc_tower_high: null,
+  navigated1: null,
+  navigated2: null,
+  wobble_delivered1: null,
+  wobble_delivered2: null,
+  auto_tower_low: null,
+  auto_tower_mid: null,
+  auto_tower_high: null,
+  auto_tower_points: null,
+  auto_power_shot_left: null,
+  auto_power_shot_center: null,
+  auto_power_shot_right: null,
+  auto_power_shot_points: null,
+  wobble_rings1: null,
+  wobble_rings2: null,
+  wobble_end1: null,
+  wobble_end2: null,
+  wobble_end_points: null,
+  wobble_ring_points: null,
+  auto_wobble_points: null,
+  end_power_shot_left: null,
+  end_power_shot_center: null,
+  end_power_shot_right: null,
+  end_power_shot_points: null,
+  penalty_points: null,
+  major_penalties: null,
+  minor_penalties: null,
+  navigation_points: null,
+  endgame_points: null,
+  total_points: null,
+  alliance: null,
+  team: null
+)
+```
+

data/docs/ScoreDetailModel2019.md

@@ -0,0 +1,22 @@
+# FtcEventsClient::ScoreDetailModel2019
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **match_level** | [**TournamentLevel**](TournamentLevel.md) |  | [optional] |
+| **match_number** | **Integer** |  | [optional] |
+| **alliances** | [**Array<ScoreDetailModelAlliance2019>**](ScoreDetailModelAlliance2019.md) |  | [optional] |
+
+## Code Sample
+
+```ruby
+require 'ftc_events_client'
+
+instance = FtcEventsClient::ScoreDetailModel2019.new(
+  match_level: null,
+  match_number: null,
+  alliances: null
+)
+```
+

data/docs/ScoreDetailModel2020.md

@@ -0,0 +1,22 @@
+# FtcEventsClient::ScoreDetailModel2020
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **match_level** | [**TournamentLevel**](TournamentLevel.md) |  | [optional] |
+| **match_number** | **Integer** |  | [optional] |
+| **alliances** | [**Array<ScoreDetailAllianceModel2020>**](ScoreDetailAllianceModel2020.md) |  | [optional] |
+
+## Code Sample
+
+```ruby
+require 'ftc_events_client'
+
+instance = FtcEventsClient::ScoreDetailModel2020.new(
+  match_level: null,
+  match_number: null,
+  alliances: null
+)
+```
+

data/docs/ScoreDetailModelAlliance2019.md

@@ -0,0 +1,84 @@
+# FtcEventsClient::ScoreDetailModelAlliance2019
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **alliance** | **String** |  | [optional] |
+| **robot1_navigated** | **Boolean** |  | [optional] |
+| **robot1_parked** | **Boolean** |  | [optional] |
+| **robot1_capstone_level** | **Integer** |  | [optional] |
+| **robot2_navigated** | **Boolean** |  | [optional] |
+| **robot2_parked** | **Boolean** |  | [optional] |
+| **robot2_capstone_level** | **Integer** |  | [optional] |
+| **auto_stones** | [**Array<Stone>**](Stone.md) |  | [optional] |
+| **auto_delivered** | **Integer** |  | [optional] |
+| **auto_returned** | **Integer** |  | [optional] |
+| **first_returned_is_skystone** | **Boolean** |  | [optional] |
+| **auto_placed** | **Integer** |  | [optional] |
+| **foundation_repositioned** | **Boolean** |  | [optional] |
+| **foundation_moved** | **Boolean** |  | [optional] |
+| **driver_controlled_delivered** | **Integer** |  | [optional] |
+| **driver_controlled_returned** | **Integer** |  | [optional] |
+| **driver_controlled_placed** | **Integer** |  | [optional] |
+| **tallest_skyscraper** | **Integer** |  | [optional] |
+| **auto_delivery_points** | **Integer** |  | [optional] |
+| **auto_placed_points** | **Integer** |  | [optional] |
+| **autonomous_points** | **Integer** |  | [optional] |
+| **repositioned_points** | **Integer** |  | [optional] |
+| **navigation_points** | **Integer** |  | [optional] |
+| **driver_controlled_delivery_points** | **Integer** |  | [optional] |
+| **driver_controlled_placed_points** | **Integer** |  | [optional] |
+| **skyscraper_bonus_points** | **Integer** |  | [optional] |
+| **capstone_points** | **Integer** |  | [optional] |
+| **driver_controlled_points** | **Integer** |  | [optional] |
+| **parking_points** | **Integer** |  | [optional] |
+| **end_game_points** | **Integer** |  | [optional] |
+| **minor_penalties** | **Integer** |  | [optional] |
+| **major_penalties** | **Integer** |  | [optional] |
+| **penalty_points** | **Integer** |  | [optional] |
+| **total_points** | **Integer** |  | [optional] |
+
+## Code Sample
+
+```ruby
+require 'ftc_events_client'
+
+instance = FtcEventsClient::ScoreDetailModelAlliance2019.new(
+  alliance: null,
+  robot1_navigated: null,
+  robot1_parked: null,
+  robot1_capstone_level: null,
+  robot2_navigated: null,
+  robot2_parked: null,
+  robot2_capstone_level: null,
+  auto_stones: null,
+  auto_delivered: null,
+  auto_returned: null,
+  first_returned_is_skystone: null,
+  auto_placed: null,
+  foundation_repositioned: null,
+  foundation_moved: null,
+  driver_controlled_delivered: null,
+  driver_controlled_returned: null,
+  driver_controlled_placed: null,
+  tallest_skyscraper: null,
+  auto_delivery_points: null,
+  auto_placed_points: null,
+  autonomous_points: null,
+  repositioned_points: null,
+  navigation_points: null,
+  driver_controlled_delivery_points: null,
+  driver_controlled_placed_points: null,
+  skyscraper_bonus_points: null,
+  capstone_points: null,
+  driver_controlled_points: null,
+  parking_points: null,
+  end_game_points: null,
+  minor_penalties: null,
+  major_penalties: null,
+  penalty_points: null,
+  total_points: null
+)
+```
+

data/docs/ScoreDetailModelSinglePlayer2020.md

@@ -0,0 +1,24 @@
+# FtcEventsClient::ScoreDetailModelSinglePlayer2020
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **match_level** | [**TournamentLevel**](TournamentLevel.md) |  | [optional] |
+| **match_number** | **Integer** |  | [optional] |
+| **team_number** | **Integer** |  | [optional] |
+| **scores** | [**AllianceScore2020**](AllianceScore2020.md) |  | [optional] |
+
+## Code Sample
+
+```ruby
+require 'ftc_events_client'
+
+instance = FtcEventsClient::ScoreDetailModelSinglePlayer2020.new(
+  match_level: null,
+  match_number: null,
+  team_number: null,
+  scores: null
+)
+```
+

data/docs/SeasonAwardListingsModel.md

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

data/docs/SeasonAwardsModel.md

@@ -0,0 +1,24 @@
+# FtcEventsClient::SeasonAwardsModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **award_id** | **Integer** |  | [optional] |
+| **event_type** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **for_person** | **Boolean** |  | [optional] |
+
+## Code Sample
+
+```ruby
+require 'ftc_events_client'
+
+instance = FtcEventsClient::SeasonAwardsModel.new(
+  award_id: null,
+  event_type: null,
+  description: null,
+  for_person: null
+)
+```
+

data/docs/SeasonDataApi.md

@@ -0,0 +1,182 @@
+# FtcEventsClient::SeasonDataApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v20_season_events_get**](SeasonDataApi.md#v20_season_events_get) | **GET** /v2.0/{season}/events | Event Listings |
+| [**v20_season_get**](SeasonDataApi.md#v20_season_get) | **GET** /v2.0/{season} | Season Summary |
+| [**v20_season_teams_get**](SeasonDataApi.md#v20_season_teams_get) | **GET** /v2.0/{season}/teams | Team Listings |
+
+
+## v20_season_events_get
+
+> SeasonEventListingsModelVersion2 v20_season_events_get(season, opts)
+
+Event Listings
+
+The event listings API returns all FTC official regional events in a particular season. You can specify an `eventCode` if you would only like data about one specific event. If you specify an `eventCode` you cannot specify any other optional parameters. Alternately, you can specify a `teamNumber` to retrieve only the listings of events being attended by the particular team. If you specify a `teamNumber` you cannot specify an `eventCode`.  The response for event listings contains a special field called divisionCode. For example, the FIRST Championship contains two Divisions. As an example of a response, the event listings for a Division will have a divisionCode that matches the FIRST Championship event code (as they are divisions of that event). This allows you to see the full structure of events, and how they relate to each other.
+
+### 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::SeasonDataApi.new
+season = 56 # Integer | Numeric year from which the event listings are requested. Must be 4 digits
+opts = {
+  event_code: '0', # String | Case insensitive alphanumeric `eventCode` of the event about which details are requested.
+  team_number: 0 # Integer | Numeric `teamNumber` of the team from which the attending event listings are requested.
+}
+
+begin
+  #Event Listings
+  result = api_instance.v20_season_events_get(season, opts)
+  p result
+rescue FtcEventsClient::ApiError => e
+  puts "Exception when calling SeasonDataApi->v20_season_events_get: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **season** | **Integer** | Numeric year from which the event listings are requested. Must be 4 digits |  |
+| **event_code** | **String** | Case insensitive alphanumeric `eventCode` of the event about which details are requested. | [optional][default to '0'] |
+| **team_number** | **Integer** | Numeric `teamNumber` of the team from which the attending event listings are requested. | [optional][default to 0] |
+
+### Return type
+
+[**SeasonEventListingsModelVersion2**](SeasonEventListingsModelVersion2.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v20_season_get
+
+> SeasonSummaryModelVersion2 v20_season_get(season)
+
+Season Summary
+
+The season summary API returns a high level glance of a particular FTC season.
+
+### 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::SeasonDataApi.new
+season = 56 # Integer | Numeric year of the event from which the season summary is requested. Must be 4 digits.
+
+begin
+  #Season Summary
+  result = api_instance.v20_season_get(season)
+  p result
+rescue FtcEventsClient::ApiError => e
+  puts "Exception when calling SeasonDataApi->v20_season_get: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **season** | **Integer** | Numeric year of the event from which the season summary is requested. Must be 4 digits. |  |
+
+### Return type
+
+[**SeasonSummaryModelVersion2**](SeasonSummaryModelVersion2.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v20_season_teams_get
+
+> SeasonTeamListingsModelVersion2 v20_season_teams_get(season, opts)
+
+Team Listings
+
+The team listings API returns all FTC official teams in a particular season. If specified, the `teamNumber` parameter will return only one result with the details of the requested `teamNumber`. Alternately, the `eventCode` parameter allows sorting of the team list to only those teams attending a particular event in the particular season. If you specify a teamNumber parameter, you cannot additionally specify an `eventCode` and/or `state` in the same request, or you will receive an HTTP 501. If you specify the `state` parameter, it should be the full legal name of the US state or international state/prov, such as New Hampshire or Ontario. Values on this endpoint are \"pass through\" values from the TIMS registration system. As such, if the team does not specify a value for a field, it may be presented in the API as null.
+
+### 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::SeasonDataApi.new
+season = 56 # Integer | Numeric year from which the team listings are requested. Must be 4 digits.
+opts = {
+  team_number: 0, # Integer | Numeric `teamNumber` of the team about which information is requested. Must be 1 to 5 digits.
+  event_code: '0', # String | Case insensitive alphanumeric `eventCode` of the event from which details are requested.
+  state: '', # String | Full legal name of the US state or international state/prov
+  page: 1 # Integer | Numeric page of results to return.
+}
+
+begin
+  #Team Listings
+  result = api_instance.v20_season_teams_get(season, opts)
+  p result
+rescue FtcEventsClient::ApiError => e
+  puts "Exception when calling SeasonDataApi->v20_season_teams_get: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **season** | **Integer** | Numeric year from which the team listings are requested. Must be 4 digits. |  |
+| **team_number** | **Integer** | Numeric `teamNumber` of the team about which information is requested. Must be 1 to 5 digits. | [optional][default to 0] |
+| **event_code** | **String** | Case insensitive alphanumeric `eventCode` of the event from which details are requested. | [optional][default to '0'] |
+| **state** | **String** | Full legal name of the US state or international state/prov | [optional][default to ''] |
+| **page** | **Integer** | Numeric page of results to return. | [optional][default to 1] |
+
+### Return type
+
+[**SeasonTeamListingsModelVersion2**](SeasonTeamListingsModelVersion2.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+