ftc_events_client 0.1.0

data/docs/AllianceSelectionModelVersion2.md

@@ -0,0 +1,20 @@
+# FtcEventsClient::AllianceSelectionModelVersion2
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **alliances** | [**Array<AllianceModelVersion2>**](AllianceModelVersion2.md) |  | [optional] |
+| **count** | **Integer** |  | [optional] |
+
+## Code Sample
+
+```ruby
+require 'ftc_events_client'
+
+instance = FtcEventsClient::AllianceSelectionModelVersion2.new(
+  alliances: null,
+  count: null
+)
+```
+

data/docs/ApiIndexModel.md

@@ -0,0 +1,34 @@
+# FtcEventsClient::ApiIndexModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | api name | [optional] |
+| **api_version** | **String** | api version | [optional] |
+| **service_mainifest_name** | **String** |  | [optional] |
+| **service_mainifest_version** | **String** |  | [optional] |
+| **code_package_name** | **String** |  | [optional] |
+| **code_package_version** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **current_season** | **Integer** | current season in the eyes of FTC | [optional] |
+| **max_season** | **Integer** | max season that can be retrieved from the API/webpages | [optional] |
+
+## Code Sample
+
+```ruby
+require 'ftc_events_client'
+
+instance = FtcEventsClient::ApiIndexModel.new(
+  name: FIRST TECH CHALLENGE API,
+  api_version: 2.0,
+  service_mainifest_name: null,
+  service_mainifest_version: null,
+  code_package_name: null,
+  code_package_version: null,
+  status: null,
+  current_season: 2020,
+  max_season: 2020
+)
+```
+

data/docs/AwardAssignmentModel.md

@@ -0,0 +1,38 @@
+# FtcEventsClient::AwardAssignmentModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **award_id** | **Integer** |  | [optional] |
+| **team_id** | **Integer** |  | [optional] |
+| **event_id** | **Integer** |  | [optional] |
+| **event_division_id** | **Integer** |  | [optional] |
+| **event_code** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **series** | **Integer** |  | [optional] |
+| **team_number** | **Integer** |  | [optional] |
+| **school_name** | **String** |  | [optional] |
+| **full_team_name** | **String** |  | [optional] |
+| **person** | **String** |  | [optional] |
+
+## Code Sample
+
+```ruby
+require 'ftc_events_client'
+
+instance = FtcEventsClient::AwardAssignmentModel.new(
+  award_id: null,
+  team_id: null,
+  event_id: null,
+  event_division_id: null,
+  event_code: null,
+  name: null,
+  series: null,
+  team_number: null,
+  school_name: null,
+  full_team_name: null,
+  person: null
+)
+```
+

data/docs/AwardsApi.md

@@ -0,0 +1,235 @@
+# FtcEventsClient::AwardsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v20_season_awards_event_code_get**](AwardsApi.md#v20_season_awards_event_code_get) | **GET** /v2.0/{season}/awards/{eventCode} | Event Awards |
+| [**v20_season_awards_event_code_team_number_get**](AwardsApi.md#v20_season_awards_event_code_team_number_get) | **GET** /v2.0/{season}/awards/{eventCode}/{teamNumber} | Event Awards |
+| [**v20_season_awards_list_get**](AwardsApi.md#v20_season_awards_list_get) | **GET** /v2.0/{season}/awards/list | Award Listings |
+| [**v20_season_awards_team_number_get**](AwardsApi.md#v20_season_awards_team_number_get) | **GET** /v2.0/{season}/awards/{teamNumber} | Event Awards |
+
+
+## v20_season_awards_event_code_get
+
+> AwardsModel v20_season_awards_event_code_get(season, event_code, opts)
+
+Event Awards
+
+The event awards API returns details about awards presented at a particular event in a particular season. Return values may contain either `teamNumber` or `person` values, and if the winner was a `person`, and that person is from a team, the `teamNumber` value *might* be set with their `teamNumber`. You must specify either an `eventCode` or a `teamNumber` or both. If you specify the `teamNumber` parameter, you will receive only awards where the team was listed as the winner, regardless of whether or not the `person` field is `null` or empty. If you specify only the `eventCode` field, you will receive all award listings for the requested event. If you specify both, you will receive all awards won by the `teamNumber` at the `eventCode`.
+
+### 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::AwardsApi.new
+season = 56 # Integer | Numeric year of the event from which the award listings are requested. Must be 4 digits
+event_code = '' # String | Case insensitive alphanumeric `eventCode` of the event from which the awards are requested.
+opts = {
+  team_number: 0 # Integer | `teamNumber` to search for within the results.
+}
+
+begin
+  #Event Awards
+  result = api_instance.v20_season_awards_event_code_get(season, event_code, opts)
+  p result
+rescue FtcEventsClient::ApiError => e
+  puts "Exception when calling AwardsApi->v20_season_awards_event_code_get: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **season** | **Integer** | Numeric year of the event from which the award listings are requested. Must be 4 digits |  |
+| **event_code** | **String** | Case insensitive alphanumeric `eventCode` of the event from which the awards are requested. | [default to ''] |
+| **team_number** | **Integer** | `teamNumber` to search for within the results. | [optional][default to 0] |
+
+### Return type
+
+[**AwardsModel**](AwardsModel.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v20_season_awards_event_code_team_number_get
+
+> AwardsModel v20_season_awards_event_code_team_number_get(season, event_code, team_number)
+
+Event Awards
+
+The event awards API returns details about awards presented at a particular event in a particular season. Return values may contain either `teamNumber` or `person` values, and if the winner was a `person`, and that person is from a team, the `teamNumber` value *might* be set with their `teamNumber`. You must specify either an `eventCode` or a `teamNumber` or both. If you specify the `teamNumber` parameter, you will receive only awards where the team was listed as the winner, regardless of whether or not the `person` field is `null` or empty. If you specify only the `eventCode` field, you will receive all award listings for the requested event. If you specify both, you will receive all awards won by the `teamNumber` at the `eventCode`.
+
+### 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::AwardsApi.new
+season = 56 # Integer | Numeric year of the event from which the award listings are requested. Must be 4 digits
+event_code = '' # String | Case insensitive alphanumeric `eventCode` of the event from which the awards are requested.
+team_number = 0 # Integer | `teamNumber` to search for within the results.
+
+begin
+  #Event Awards
+  result = api_instance.v20_season_awards_event_code_team_number_get(season, event_code, team_number)
+  p result
+rescue FtcEventsClient::ApiError => e
+  puts "Exception when calling AwardsApi->v20_season_awards_event_code_team_number_get: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **season** | **Integer** | Numeric year of the event from which the award listings are requested. Must be 4 digits |  |
+| **event_code** | **String** | Case insensitive alphanumeric `eventCode` of the event from which the awards are requested. | [default to ''] |
+| **team_number** | **Integer** | `teamNumber` to search for within the results. | [default to 0] |
+
+### Return type
+
+[**AwardsModel**](AwardsModel.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v20_season_awards_list_get
+
+> SeasonAwardListingsModel v20_season_awards_list_get(season)
+
+Award Listings
+
+The award listings API returns a listing of the various awards that can be distributed in the requested season. This is especially useful in order to avoid having to use the name field of the event awards API to know which award was won. Instead the awardId field can be matched between the two APIs.
+
+### 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::AwardsApi.new
+season = 56 # Integer | Numeric year of the event from which the award listings are requested. Must be 4 digits
+
+begin
+  #Award Listings
+  result = api_instance.v20_season_awards_list_get(season)
+  p result
+rescue FtcEventsClient::ApiError => e
+  puts "Exception when calling AwardsApi->v20_season_awards_list_get: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **season** | **Integer** | Numeric year of the event from which the award listings are requested. Must be 4 digits |  |
+
+### Return type
+
+[**SeasonAwardListingsModel**](SeasonAwardListingsModel.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v20_season_awards_team_number_get
+
+> AwardsModel v20_season_awards_team_number_get(season, team_number, opts)
+
+Event Awards
+
+The event awards API returns details about awards presented at a particular event in a particular season. Return values may contain either `teamNumber` or `person` values, and if the winner was a `person`, and that person is from a team, the `teamNumber` value *might* be set with their `teamNumber`. You must specify either an `eventCode` or a `teamNumber` or both. If you specify the `teamNumber` parameter, you will receive only awards where the team was listed as the winner, regardless of whether or not the `person` field is `null` or empty. If you specify only the `eventCode` field, you will receive all award listings for the requested event. If you specify both, you will receive all awards won by the `teamNumber` at the `eventCode`.
+
+### 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::AwardsApi.new
+season = 56 # Integer | Numeric year of the event from which the award listings are requested. Must be 4 digits
+team_number = 0 # Integer | `teamNumber` to search for within the results.
+opts = {
+  event_code: '' # String | Case insensitive alphanumeric `eventCode` of the event from which the awards are requested.
+}
+
+begin
+  #Event Awards
+  result = api_instance.v20_season_awards_team_number_get(season, team_number, opts)
+  p result
+rescue FtcEventsClient::ApiError => e
+  puts "Exception when calling AwardsApi->v20_season_awards_team_number_get: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **season** | **Integer** | Numeric year of the event from which the award listings are requested. Must be 4 digits |  |
+| **team_number** | **Integer** | `teamNumber` to search for within the results. | [default to 0] |
+| **event_code** | **String** | Case insensitive alphanumeric `eventCode` of the event from which the awards are requested. | [optional][default to ''] |
+
+### Return type
+
+[**AwardsModel**](AwardsModel.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AwardsModel.md

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

data/docs/EventMatchResultsModelVersion2.md

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

data/docs/EventRankingsModel.md

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

data/docs/EventScheduleHybridModelVersion2.md

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

data/docs/EventScheduleModelVersion2.md

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

data/docs/GeneralApi.md

@@ -0,0 +1,51 @@
+# FtcEventsClient::GeneralApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v20_get**](GeneralApi.md#v20_get) | **GET** /v2.0 | API Index |
+
+
+## v20_get
+
+> ApiIndexModel v20_get
+
+API Index
+
+Root level call with no parameters.
+
+### Example
+
+```ruby
+# load the gem
+require 'ftc_events_client'
+
+api_instance = FtcEventsClient::GeneralApi.new
+
+begin
+  #API Index
+  result = api_instance.v20_get
+  p result
+rescue FtcEventsClient::ApiError => e
+  puts "Exception when calling GeneralApi->v20_get: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ApiIndexModel**](ApiIndexModel.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+