ftc_events_client 0.1.0 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (143) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +351 -101
  3. data/Rakefile +0 -2
  4. data/config.json +1 -1
  5. data/docs/AllianceModelVersion2.md +10 -28
  6. data/docs/AllianceScore2020.md +37 -82
  7. data/docs/AllianceSelectionApi.md +14 -14
  8. data/docs/AllianceSelectionModelVersion2.md +4 -16
  9. data/docs/ApiIndexModel.md +11 -30
  10. data/docs/AutoNavigatedStatus.md +6 -0
  11. data/docs/AwardAssignmentModel.md +13 -34
  12. data/docs/AwardsApi.md +47 -49
  13. data/docs/AwardsModel.md +3 -14
  14. data/docs/BarcodeElement.md +6 -0
  15. data/docs/EndgameParkedStatus.md +6 -0
  16. data/docs/EventMatchResultsModelVersion2.md +3 -14
  17. data/docs/EventRankingsModel.md +3 -14
  18. data/docs/EventScheduleHybridModelVersion2.md +3 -14
  19. data/docs/EventScheduleModelVersion2.md +3 -14
  20. data/docs/FTCEventLevel.md +6 -0
  21. data/docs/GeneralApi.md +9 -11
  22. data/docs/LeagueMemberListModel.md +7 -0
  23. data/docs/LeaguesApi.md +179 -0
  24. data/docs/MatchResultModelVersion2.md +16 -40
  25. data/docs/MatchResultTeamModelVersion2.md +6 -18
  26. data/docs/MatchResultsApi.md +33 -35
  27. data/docs/MatchScoresModel.md +3 -14
  28. data/docs/MatchScoresModelMatchScoresOneOf.md +5 -1
  29. data/docs/OneOfMatchScoresModelMatchScoresItems.md +6 -0
  30. data/docs/RankingsApi.md +16 -17
  31. data/docs/ScheduleApi.md +30 -32
  32. data/docs/ScheduleHybridModelTeamVersion2.md +8 -22
  33. data/docs/ScheduleHybridModelVersion2.md +18 -40
  34. data/docs/ScheduledMatchModelVersion2.md +10 -28
  35. data/docs/ScheduledMatchTeamModelVersion2.md +6 -20
  36. data/docs/ScoreDetailAllianceModel2020.md +39 -86
  37. data/docs/ScoreDetailAllianceModel2021.md +48 -0
  38. data/docs/ScoreDetailModel2019.md +6 -18
  39. data/docs/ScoreDetailModel2020.md +6 -18
  40. data/docs/ScoreDetailModel2021.md +10 -0
  41. data/docs/ScoreDetailModelAlliance2019.md +36 -80
  42. data/docs/ScoreDetailModelSinglePlayer2020.md +6 -20
  43. data/docs/ScoreDetailModelSinglePlayer2021.md +10 -0
  44. data/docs/ScoreDetailSinglePlayer2021.md +39 -0
  45. data/docs/SeasonAwardListingsModel.md +3 -14
  46. data/docs/SeasonAwardsModel.md +6 -20
  47. data/docs/SeasonDataApi.md +35 -37
  48. data/docs/SeasonEventListingsModelVersion2.md +4 -16
  49. data/docs/SeasonEventModelVersion2.md +24 -46
  50. data/docs/SeasonLeagueListingsModelVersion2.md +8 -0
  51. data/docs/SeasonLeagueModelVersion2.md +11 -0
  52. data/docs/SeasonSummaryModelChampionship.md +5 -18
  53. data/docs/SeasonSummaryModelVersion2.md +8 -24
  54. data/docs/SeasonTeamListingsModelVersion2.md +7 -22
  55. data/docs/SeasonTeamModelVersion2.md +14 -36
  56. data/docs/Stone.md +2 -11
  57. data/docs/TeamRankingModel.md +17 -42
  58. data/ftc_events_client.gemspec +5 -5
  59. data/git_push.sh +7 -10
  60. data/lib/ftc_events_client/api/alliance_selection_api.rb +17 -22
  61. data/lib/ftc_events_client/api/awards_api.rb +52 -74
  62. data/lib/ftc_events_client/api/general_api.rb +8 -17
  63. data/lib/ftc_events_client/api/leagues_api.rb +218 -0
  64. data/lib/ftc_events_client/api/match_results_api.rb +44 -45
  65. data/lib/ftc_events_client/api/rankings_api.rb +17 -22
  66. data/lib/ftc_events_client/api/schedule_api.rb +44 -45
  67. data/lib/ftc_events_client/api/season_data_api.rb +30 -53
  68. data/lib/ftc_events_client/api_client.rb +52 -54
  69. data/lib/ftc_events_client/api_error.rb +4 -4
  70. data/lib/ftc_events_client/configuration.rb +6 -76
  71. data/lib/ftc_events_client/models/alliance_model_version2.rb +19 -31
  72. data/lib/ftc_events_client/models/{alliance_score2020.rb → alliance_score_2020.rb} +46 -58
  73. data/lib/ftc_events_client/models/alliance_selection_model_version2.rb +13 -25
  74. data/lib/ftc_events_client/models/api_index_model.rb +20 -32
  75. data/lib/ftc_events_client/models/{tournament_level.rb → auto_navigated_status.rb} +11 -21
  76. data/lib/ftc_events_client/models/award_assignment_model.rb +22 -34
  77. data/lib/ftc_events_client/models/awards_model.rb +12 -24
  78. data/lib/ftc_events_client/models/barcode_element.rb +28 -0
  79. data/lib/ftc_events_client/models/endgame_parked_status.rb +29 -0
  80. data/lib/ftc_events_client/models/event_match_results_model_version2.rb +12 -24
  81. data/lib/ftc_events_client/models/event_rankings_model.rb +12 -24
  82. data/lib/ftc_events_client/models/event_schedule_hybrid_model_version2.rb +12 -24
  83. data/lib/ftc_events_client/models/event_schedule_model_version2.rb +12 -24
  84. data/lib/ftc_events_client/models/ftc_event_level.rb +31 -0
  85. data/lib/ftc_events_client/models/league_member_list_model.rb +209 -0
  86. data/lib/ftc_events_client/models/match_result_model_version2.rb +25 -37
  87. data/lib/ftc_events_client/models/match_result_team_model_version2.rb +26 -29
  88. data/lib/ftc_events_client/models/match_scores_model.rb +12 -24
  89. data/lib/ftc_events_client/models/one_of_match_scores_model_match_scores_items.rb +197 -0
  90. data/lib/ftc_events_client/models/schedule_hybrid_model_team_version2.rb +30 -32
  91. data/lib/ftc_events_client/models/schedule_hybrid_model_version2.rb +46 -38
  92. data/lib/ftc_events_client/models/scheduled_match_model_version2.rb +19 -31
  93. data/lib/ftc_events_client/models/scheduled_match_team_model_version2.rb +15 -27
  94. data/lib/ftc_events_client/models/{score_detail_alliance_model2020.rb → score_detail_alliance_model_2020.rb} +48 -60
  95. data/lib/ftc_events_client/models/score_detail_alliance_model_2021.rb +576 -0
  96. data/lib/ftc_events_client/models/{score_detail_model2019.rb → score_detail_model_2019.rb} +24 -27
  97. data/lib/ftc_events_client/models/{score_detail_model2020.rb → score_detail_model_2020.rb} +24 -27
  98. data/lib/ftc_events_client/models/score_detail_model_2021.rb +236 -0
  99. data/lib/ftc_events_client/models/{score_detail_model_alliance2019.rb → score_detail_model_alliance_2019.rb} +45 -57
  100. data/lib/ftc_events_client/models/{score_detail_model_single_player2020.rb → score_detail_model_single_player_2020.rb} +15 -27
  101. data/lib/ftc_events_client/models/score_detail_model_single_player_2021.rb +233 -0
  102. data/lib/ftc_events_client/models/score_detail_single_player_2021.rb +494 -0
  103. data/lib/ftc_events_client/models/season_award_listings_model.rb +12 -24
  104. data/lib/ftc_events_client/models/season_awards_model.rb +22 -34
  105. data/lib/ftc_events_client/models/season_event_listings_model_version2.rb +13 -25
  106. data/lib/ftc_events_client/models/season_event_model_version2.rb +77 -41
  107. data/lib/ftc_events_client/models/season_league_listings_model_version2.rb +218 -0
  108. data/lib/ftc_events_client/models/season_league_model_version2.rb +247 -0
  109. data/lib/ftc_events_client/models/season_summary_model_championship.rb +14 -26
  110. data/lib/ftc_events_client/models/season_summary_model_version2.rb +17 -29
  111. data/lib/ftc_events_client/models/season_team_listings_model_version2.rb +16 -28
  112. data/lib/ftc_events_client/models/season_team_model_version2.rb +23 -35
  113. data/lib/ftc_events_client/models/stone.rb +6 -15
  114. data/lib/ftc_events_client/models/team_ranking_model.rb +26 -38
  115. data/lib/ftc_events_client/version.rb +4 -5
  116. data/lib/ftc_events_client.rb +22 -12
  117. data/spec/api/leagues_api_spec.rb +77 -0
  118. data/spec/base_object_spec.rb +109 -0
  119. data/spec/configuration_spec.rb +3 -3
  120. data/spec/models/alliance_score_2020_spec.rb +244 -0
  121. data/spec/models/auto_navigated_status_spec.rb +28 -0
  122. data/spec/models/barcode_element_spec.rb +28 -0
  123. data/spec/models/endgame_parked_status_spec.rb +28 -0
  124. data/spec/models/ftc_event_level_spec.rb +28 -0
  125. data/spec/models/league_member_list_model_spec.rb +34 -0
  126. data/spec/models/one_of_match_scores_model_match_scores_items_spec.rb +34 -0
  127. data/spec/models/score_detail_alliance_model2021_spec.rb +280 -0
  128. data/spec/models/score_detail_alliance_model_2020_spec.rb +256 -0
  129. data/spec/models/score_detail_alliance_model_2021_spec.rb +286 -0
  130. data/spec/models/score_detail_model2021_spec.rb +52 -0
  131. data/spec/models/score_detail_model_2019_spec.rb +58 -0
  132. data/spec/models/score_detail_model_2020_spec.rb +58 -0
  133. data/spec/models/score_detail_model_2021_spec.rb +58 -0
  134. data/spec/models/score_detail_model_alliance_2019_spec.rb +238 -0
  135. data/spec/models/score_detail_model_single_player2021_spec.rb +52 -0
  136. data/spec/models/score_detail_model_single_player_2020_spec.rb +58 -0
  137. data/spec/models/score_detail_model_single_player_2021_spec.rb +58 -0
  138. data/spec/models/score_detail_single_player2021_spec.rb +226 -0
  139. data/spec/models/score_detail_single_player_2021_spec.rb +232 -0
  140. data/spec/models/season_league_listings_model_version2_spec.rb +40 -0
  141. data/{lib/ftc_events_client/models/match_scores_model_match_scores_one_of.rb → spec/models/season_league_model_version2_spec.rb} +35 -83
  142. data/update.sh +2 -2
  143. metadata +103 -11
@@ -1,18 +1,7 @@
1
1
  # FtcEventsClient::EventRankingsModel
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **rankings** | [**Array<TeamRankingModel>**](TeamRankingModel.md) | | [optional] |
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'ftc_events_client'
13
-
14
- instance = FtcEventsClient::EventRankingsModel.new(
15
- rankings: null
16
- )
17
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **rankings** | [**Array<TeamRankingModel>**](TeamRankingModel.md) | | [optional]
18
7
 
@@ -1,18 +1,7 @@
1
1
  # FtcEventsClient::EventScheduleHybridModelVersion2
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **schedule** | [**Array<ScheduleHybridModelVersion2>**](ScheduleHybridModelVersion2.md) | | [optional] |
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'ftc_events_client'
13
-
14
- instance = FtcEventsClient::EventScheduleHybridModelVersion2.new(
15
- schedule: null
16
- )
17
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **schedule** | [**Array<ScheduleHybridModelVersion2>**](ScheduleHybridModelVersion2.md) | | [optional]
18
7
 
@@ -1,18 +1,7 @@
1
1
  # FtcEventsClient::EventScheduleModelVersion2
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **schedule** | [**Array<ScheduledMatchModelVersion2>**](ScheduledMatchModelVersion2.md) | | [optional] |
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'ftc_events_client'
13
-
14
- instance = FtcEventsClient::EventScheduleModelVersion2.new(
15
- schedule: null
16
- )
17
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **schedule** | [**Array<ScheduledMatchModelVersion2>**](ScheduledMatchModelVersion2.md) | | [optional]
18
7
 
@@ -0,0 +1,6 @@
1
+ # FtcEventsClient::FTCEventLevel
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+
data/docs/GeneralApi.md CHANGED
@@ -1,14 +1,12 @@
1
1
  # FtcEventsClient::GeneralApi
2
2
 
3
- All URIs are relative to *http://localhost*
3
+ All URIs are relative to *http://ftc-api.firstinspires.org*
4
4
 
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**v20_get**](GeneralApi.md#v20_get) | **GET** /v2.0 | API Index |
8
-
9
-
10
- ## v20_get
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**v20_get**](GeneralApi.md#v20_get) | **GET** /v2.0 | API Index
11
8
 
9
+ # **v20_get**
12
10
  > ApiIndexModel v20_get
13
11
 
14
12
  API Index
@@ -16,7 +14,6 @@ API Index
16
14
  Root level call with no parameters.
17
15
 
18
16
  ### Example
19
-
20
17
  ```ruby
21
18
  # load the gem
22
19
  require 'ftc_events_client'
@@ -33,7 +30,6 @@ end
33
30
  ```
34
31
 
35
32
  ### Parameters
36
-
37
33
  This endpoint does not need any parameter.
38
34
 
39
35
  ### Return type
@@ -46,6 +42,8 @@ No authorization required
46
42
 
47
43
  ### HTTP request headers
48
44
 
49
- - **Content-Type**: Not defined
50
- - **Accept**: application/json
45
+ - **Content-Type**: Not defined
46
+ - **Accept**: application/json
47
+
48
+
51
49
 
@@ -0,0 +1,7 @@
1
+ # FtcEventsClient::LeagueMemberListModel
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **members** | **Array<Integer>** | | [optional]
7
+
@@ -0,0 +1,179 @@
1
+ # FtcEventsClient::LeaguesApi
2
+
3
+ All URIs are relative to *http://ftc-api.firstinspires.org*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**v20_season_leagues_get**](LeaguesApi.md#v20_season_leagues_get) | **GET** /v2.0/{season}/leagues | League Listings
8
+ [**v20_season_leagues_members_region_code_league_code_get**](LeaguesApi.md#v20_season_leagues_members_region_code_league_code_get) | **GET** /v2.0/{season}/leagues/members/{regionCode}/{leagueCode} | League Membership
9
+ [**v20_season_leagues_rankings_region_code_league_code_get**](LeaguesApi.md#v20_season_leagues_rankings_region_code_league_code_get) | **GET** /v2.0/{season}/leagues/rankings/{regionCode}/{leagueCode} | League Rankings
10
+
11
+ # **v20_season_leagues_get**
12
+ > SeasonLeagueListingsModelVersion2 v20_season_leagues_get(season, opts)
13
+
14
+ League Listings
15
+
16
+ The league listings API returns all FTC leagues in a particular season. You can specify a `regionCode` to filter to leagues within a particular region. To filter to a specific league, supply both a `regionCode` and a `leagueCode`. The returned objects have a `parentLeagueCode` field, which indicates the league is a child league if not null and provides the code of the parent league. The `regionCode` of the parent league will always match the child.
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'ftc_events_client'
22
+ # setup authorization
23
+ FtcEventsClient.configure do |config|
24
+ # Configure HTTP basic authorization: basic
25
+ config.username = 'YOUR USERNAME'
26
+ config.password = 'YOUR PASSWORD'
27
+ end
28
+
29
+ api_instance = FtcEventsClient::LeaguesApi.new
30
+ season = 56 # Integer | Numeric year from which the league listings are requested. Must be 4 digits
31
+ opts = {
32
+ region_code: 'region_code_example', # String | Case-sensitive alphanumeric `regionCode` of a region to filter for.
33
+ league_code: 'league_code_example' # String | Case-sensitive alphanumeric `leagueCode` of the league within the specified region to query.
34
+ }
35
+
36
+ begin
37
+ #League Listings
38
+ result = api_instance.v20_season_leagues_get(season, opts)
39
+ p result
40
+ rescue FtcEventsClient::ApiError => e
41
+ puts "Exception when calling LeaguesApi->v20_season_leagues_get: #{e}"
42
+ end
43
+ ```
44
+
45
+ ### Parameters
46
+
47
+ Name | Type | Description | Notes
48
+ ------------- | ------------- | ------------- | -------------
49
+ **season** | **Integer**| Numeric year from which the league listings are requested. Must be 4 digits |
50
+ **region_code** | **String**| Case-sensitive alphanumeric `regionCode` of a region to filter for. | [optional]
51
+ **league_code** | **String**| Case-sensitive alphanumeric `leagueCode` of the league within the specified region to query. | [optional]
52
+
53
+ ### Return type
54
+
55
+ [**SeasonLeagueListingsModelVersion2**](SeasonLeagueListingsModelVersion2.md)
56
+
57
+ ### Authorization
58
+
59
+ [basic](../README.md#basic)
60
+
61
+ ### HTTP request headers
62
+
63
+ - **Content-Type**: Not defined
64
+ - **Accept**: application/json
65
+
66
+
67
+
68
+ # **v20_season_leagues_members_region_code_league_code_get**
69
+ > LeagueMemberListModel v20_season_leagues_members_region_code_league_code_get(season, region_code, league_code)
70
+
71
+ League Membership
72
+
73
+ The league membership API returns the list of team numbers for the teams that are members of a particular league. Leagues are specified by a `regionCode` in combination with a `leagueCode`.
74
+
75
+ ### Example
76
+ ```ruby
77
+ # load the gem
78
+ require 'ftc_events_client'
79
+ # setup authorization
80
+ FtcEventsClient.configure do |config|
81
+ # Configure HTTP basic authorization: basic
82
+ config.username = 'YOUR USERNAME'
83
+ config.password = 'YOUR PASSWORD'
84
+ end
85
+
86
+ api_instance = FtcEventsClient::LeaguesApi.new
87
+ season = 56 # Integer | Numeric year. Must be 4 digits
88
+ region_code = 'region_code_example' # String | Case sensitive alphanumeric `regionCode` of the region the league belongs to.
89
+ league_code = 'league_code_example' # String | Case sensitive alphanumeric `leagueCode` of the league.
90
+
91
+
92
+ begin
93
+ #League Membership
94
+ result = api_instance.v20_season_leagues_members_region_code_league_code_get(season, region_code, league_code)
95
+ p result
96
+ rescue FtcEventsClient::ApiError => e
97
+ puts "Exception when calling LeaguesApi->v20_season_leagues_members_region_code_league_code_get: #{e}"
98
+ end
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+ Name | Type | Description | Notes
104
+ ------------- | ------------- | ------------- | -------------
105
+ **season** | **Integer**| Numeric year. Must be 4 digits |
106
+ **region_code** | **String**| Case sensitive alphanumeric `regionCode` of the region the league belongs to. |
107
+ **league_code** | **String**| Case sensitive alphanumeric `leagueCode` of the league. |
108
+
109
+ ### Return type
110
+
111
+ [**LeagueMemberListModel**](LeagueMemberListModel.md)
112
+
113
+ ### Authorization
114
+
115
+ [basic](../README.md#basic)
116
+
117
+ ### HTTP request headers
118
+
119
+ - **Content-Type**: Not defined
120
+ - **Accept**: application/json
121
+
122
+
123
+
124
+ # **v20_season_leagues_rankings_region_code_league_code_get**
125
+ > EventRankingsModel v20_season_leagues_rankings_region_code_league_code_get(season, region_code, league_code)
126
+
127
+ League Rankings
128
+
129
+ The league rankings API returns team ranking detail from a particular league in a particular season. League rankings are only the cumulative rankings from League Meets - they do not include performance at the League Tournament. To get League Tournament Rankings, use the Event Rankings endpoint.
130
+
131
+ ### Example
132
+ ```ruby
133
+ # load the gem
134
+ require 'ftc_events_client'
135
+ # setup authorization
136
+ FtcEventsClient.configure do |config|
137
+ # Configure HTTP basic authorization: basic
138
+ config.username = 'YOUR USERNAME'
139
+ config.password = 'YOUR PASSWORD'
140
+ end
141
+
142
+ api_instance = FtcEventsClient::LeaguesApi.new
143
+ season = 56 # Integer | Numeric year. Must be 4 digits
144
+ region_code = 'region_code_example' # String | Case sensitive alphanumeric `regionCode` of the region the league belongs to.
145
+ league_code = 'league_code_example' # String | Case sensitive alphanumeric `leagueCode` of the league.
146
+
147
+
148
+ begin
149
+ #League Rankings
150
+ result = api_instance.v20_season_leagues_rankings_region_code_league_code_get(season, region_code, league_code)
151
+ p result
152
+ rescue FtcEventsClient::ApiError => e
153
+ puts "Exception when calling LeaguesApi->v20_season_leagues_rankings_region_code_league_code_get: #{e}"
154
+ end
155
+ ```
156
+
157
+ ### Parameters
158
+
159
+ Name | Type | Description | Notes
160
+ ------------- | ------------- | ------------- | -------------
161
+ **season** | **Integer**| Numeric year. Must be 4 digits |
162
+ **region_code** | **String**| Case sensitive alphanumeric `regionCode` of the region the league belongs to. |
163
+ **league_code** | **String**| Case sensitive alphanumeric `leagueCode` of the league. |
164
+
165
+ ### Return type
166
+
167
+ [**EventRankingsModel**](EventRankingsModel.md)
168
+
169
+ ### Authorization
170
+
171
+ [basic](../README.md#basic)
172
+
173
+ ### HTTP request headers
174
+
175
+ - **Content-Type**: Not defined
176
+ - **Accept**: application/json
177
+
178
+
179
+
@@ -1,44 +1,20 @@
1
1
  # FtcEventsClient::MatchResultModelVersion2
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **actual_start_time** | **Time** | | [optional] |
8
- | **description** | **String** | | [optional] |
9
- | **tournament_level** | **String** | | [optional] |
10
- | **series** | **Integer** | | [optional] |
11
- | **match_number** | **Integer** | | [optional] |
12
- | **score_red_final** | **Integer** | | [optional] |
13
- | **score_red_foul** | **Integer** | | [optional] |
14
- | **score_red_auto** | **Integer** | | [optional] |
15
- | **score_blue_final** | **Integer** | | [optional] |
16
- | **score_blue_foul** | **Integer** | | [optional] |
17
- | **score_blue_auto** | **Integer** | | [optional] |
18
- | **post_result_time** | **Time** | | [optional] |
19
- | **teams** | [**Array<MatchResultTeamModelVersion2>**](MatchResultTeamModelVersion2.md) | | [optional] |
20
- | **modified_on** | **Time** | | [optional] |
21
-
22
- ## Code Sample
23
-
24
- ```ruby
25
- require 'ftc_events_client'
26
-
27
- instance = FtcEventsClient::MatchResultModelVersion2.new(
28
- actual_start_time: null,
29
- description: null,
30
- tournament_level: null,
31
- series: null,
32
- match_number: null,
33
- score_red_final: null,
34
- score_red_foul: null,
35
- score_red_auto: null,
36
- score_blue_final: null,
37
- score_blue_foul: null,
38
- score_blue_auto: null,
39
- post_result_time: null,
40
- teams: null,
41
- modified_on: null
42
- )
43
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **actual_start_time** | **DateTime** | | [optional]
7
+ **description** | **String** | | [optional]
8
+ **tournament_level** | **String** | | [optional]
9
+ **series** | **Integer** | | [optional]
10
+ **match_number** | **Integer** | | [optional]
11
+ **score_red_final** | **Integer** | | [optional]
12
+ **score_red_foul** | **Integer** | | [optional]
13
+ **score_red_auto** | **Integer** | | [optional]
14
+ **score_blue_final** | **Integer** | | [optional]
15
+ **score_blue_foul** | **Integer** | | [optional]
16
+ **score_blue_auto** | **Integer** | | [optional]
17
+ **post_result_time** | **DateTime** | | [optional]
18
+ **teams** | [**Array<MatchResultTeamModelVersion2>**](MatchResultTeamModelVersion2.md) | | [optional]
19
+ **modified_on** | **DateTime** | | [optional]
44
20
 
@@ -1,22 +1,10 @@
1
1
  # FtcEventsClient::MatchResultTeamModelVersion2
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **team_number** | **Integer** | | [optional] |
8
- | **station** | **String** | | [optional] |
9
- | **dq** | **Boolean** | | [optional] |
10
-
11
- ## Code Sample
12
-
13
- ```ruby
14
- require 'ftc_events_client'
15
-
16
- instance = FtcEventsClient::MatchResultTeamModelVersion2.new(
17
- team_number: null,
18
- station: null,
19
- dq: null
20
- )
21
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **team_number** | **Integer** | | [optional]
7
+ **station** | **String** | | [optional]
8
+ **dq** | **BOOLEAN** | | [optional]
9
+ **on_field** | **BOOLEAN** | | [optional]
22
10
 
@@ -1,15 +1,13 @@
1
1
  # FtcEventsClient::MatchResultsApi
2
2
 
3
- All URIs are relative to *http://localhost*
3
+ All URIs are relative to *http://ftc-api.firstinspires.org*
4
4
 
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**v20_season_matches_event_code_get**](MatchResultsApi.md#v20_season_matches_event_code_get) | **GET** /v2.0/{season}/matches/{eventCode} | Event Match Results |
8
- | [**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 |
9
-
10
-
11
- ## v20_season_matches_event_code_get
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**v20_season_matches_event_code_get**](MatchResultsApi.md#v20_season_matches_event_code_get) | **GET** /v2.0/{season}/matches/{eventCode} | Event Match Results
8
+ [**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
12
9
 
10
+ # **v20_season_matches_event_code_get**
13
11
  > EventMatchResultsModelVersion2 v20_season_matches_event_code_get(season, event_code, opts)
14
12
 
15
13
  Event Match Results
@@ -17,7 +15,6 @@ Event Match Results
17
15
  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.
18
16
 
19
17
  ### Example
20
-
21
18
  ```ruby
22
19
  # load the gem
23
20
  require 'ftc_events_client'
@@ -31,7 +28,7 @@ end
31
28
  api_instance = FtcEventsClient::MatchResultsApi.new
32
29
  season = 56 # Integer | Numeric year of the event from which the match results are requested. Must be 4 digits.
33
30
  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.
34
- opts = {
31
+ opts = {
35
32
  tournament_level: '0', # String | Required tournamentLevel of desired score details.
36
33
  team_number: 56, # Integer | `teamNumber` to search for within the results. Only returns match results in which the requested team was a participant.
37
34
  match_number: 56, # Integer | specific single `matchNumber` of result.
@@ -50,15 +47,15 @@ end
50
47
 
51
48
  ### Parameters
52
49
 
53
- | Name | Type | Description | Notes |
54
- | ---- | ---- | ----------- | ----- |
55
- | **season** | **Integer** | Numeric year of the event from which the match results are requested. Must be 4 digits. | |
56
- | **event_code** | **String** | Case insensitive alphanumeric `eventCode` of the event from which the results are requested. Must be at least 3 characters. | |
57
- | **tournament_level** | **String** | Required tournamentLevel of desired score details. | [optional][default to '0'] |
58
- | **team_number** | **Integer** | `teamNumber` to search for within the results. Only returns match results in which the requested team was a participant. | [optional] |
59
- | **match_number** | **Integer** | specific single `matchNumber` of result. | [optional] |
60
- | **start** | **Integer** | `start` match number for subset of results to return. | [optional][default to 0] |
61
- | **_end** | **Integer** | `end` match number for subset of results to return (inclusive). | [optional][default to 999] |
50
+ Name | Type | Description | Notes
51
+ ------------- | ------------- | ------------- | -------------
52
+ **season** | **Integer**| Numeric year of the event from which the match results are requested. Must be 4 digits. |
53
+ **event_code** | **String**| Case insensitive alphanumeric `eventCode` of the event from which the results are requested. Must be at least 3 characters. |
54
+ **tournament_level** | **String**| Required tournamentLevel of desired score details. | [optional] [default to 0]
55
+ **team_number** | **Integer**| `teamNumber` to search for within the results. Only returns match results in which the requested team was a participant. | [optional]
56
+ **match_number** | **Integer**| specific single `matchNumber` of result. | [optional]
57
+ **start** | **Integer**| `start` match number for subset of results to return. | [optional] [default to 0]
58
+ **_end** | **Integer**| `end` match number for subset of results to return (inclusive). | [optional] [default to 999]
62
59
 
63
60
  ### Return type
64
61
 
@@ -70,12 +67,12 @@ end
70
67
 
71
68
  ### HTTP request headers
72
69
 
73
- - **Content-Type**: Not defined
74
- - **Accept**: application/json
70
+ - **Content-Type**: Not defined
71
+ - **Accept**: application/json
75
72
 
76
73
 
77
- ## v20_season_scores_event_code_tournament_level_get
78
74
 
75
+ # **v20_season_scores_event_code_tournament_level_get**
79
76
  > MatchScoresModel v20_season_scores_event_code_tournament_level_get(season, event_code, tournament_level, opts)
80
77
 
81
78
  Score Details
@@ -83,7 +80,6 @@ Score Details
83
80
  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.
84
81
 
85
82
  ### Example
86
-
87
83
  ```ruby
88
84
  # load the gem
89
85
  require 'ftc_events_client'
@@ -98,7 +94,7 @@ api_instance = FtcEventsClient::MatchResultsApi.new
98
94
  season = 56 # Integer | Numeric year of the event from which the match results are requested. Must be 4 digits.
99
95
  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.
100
96
  tournament_level = 'tournament_level_example' # String | Required tournamentLevel of desired score details.
101
- opts = {
97
+ opts = {
102
98
  team_number: 56, # Integer | `teamNumber` to search for within the results. Only returns details in which the requested team was a participant.
103
99
  match_number: 56, # Integer | specific single `matchNumber` of result.
104
100
  start: 0, # Integer | `start` match number for subset of results to return (inclusive).
@@ -116,15 +112,15 @@ end
116
112
 
117
113
  ### Parameters
118
114
 
119
- | Name | Type | Description | Notes |
120
- | ---- | ---- | ----------- | ----- |
121
- | **season** | **Integer** | Numeric year of the event from which the match results are requested. Must be 4 digits. | |
122
- | **event_code** | **String** | Case insensitive alphanumeric eventCode of the event from which the details are requested. Must be at least 3 characters. | |
123
- | **tournament_level** | **String** | Required tournamentLevel of desired score details. | |
124
- | **team_number** | **Integer** | `teamNumber` to search for within the results. Only returns details in which the requested team was a participant. | [optional] |
125
- | **match_number** | **Integer** | specific single `matchNumber` of result. | [optional] |
126
- | **start** | **Integer** | `start` match number for subset of results to return (inclusive). | [optional][default to 0] |
127
- | **_end** | **Integer** | `end` match number for subset of results to return (inclusive). | [optional][default to 999] |
115
+ Name | Type | Description | Notes
116
+ ------------- | ------------- | ------------- | -------------
117
+ **season** | **Integer**| Numeric year of the event from which the match results are requested. Must be 4 digits. |
118
+ **event_code** | **String**| Case insensitive alphanumeric eventCode of the event from which the details are requested. Must be at least 3 characters. |
119
+ **tournament_level** | **String**| Required tournamentLevel of desired score details. |
120
+ **team_number** | **Integer**| `teamNumber` to search for within the results. Only returns details in which the requested team was a participant. | [optional]
121
+ **match_number** | **Integer**| specific single `matchNumber` of result. | [optional]
122
+ **start** | **Integer**| `start` match number for subset of results to return (inclusive). | [optional] [default to 0]
123
+ **_end** | **Integer**| `end` match number for subset of results to return (inclusive). | [optional] [default to 999]
128
124
 
129
125
  ### Return type
130
126
 
@@ -136,6 +132,8 @@ end
136
132
 
137
133
  ### HTTP request headers
138
134
 
139
- - **Content-Type**: Not defined
140
- - **Accept**: application/json
135
+ - **Content-Type**: Not defined
136
+ - **Accept**: application/json
137
+
138
+
141
139
 
@@ -1,18 +1,7 @@
1
1
  # FtcEventsClient::MatchScoresModel
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **match_scores** | [**Array<MatchScoresModelMatchScoresOneOf>**](MatchScoresModelMatchScoresOneOf.md) | | [optional] |
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'ftc_events_client'
13
-
14
- instance = FtcEventsClient::MatchScoresModel.new(
15
- match_scores: null
16
- )
17
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **match_scores** | [**Array<OneOfMatchScoresModelMatchScoresItems>**](.md) | | [optional]
18
7
 
@@ -16,7 +16,9 @@ FtcEventsClient::MatchScoresModelMatchScoresOneOf.openapi_one_of
16
16
  # [
17
17
  # :'ScoreDetailModel2019',
18
18
  # :'ScoreDetailModel2020',
19
- # :'ScoreDetailModelSinglePlayer2020'
19
+ # :'ScoreDetailModel2021',
20
+ # :'ScoreDetailModelSinglePlayer2020',
21
+ # :'ScoreDetailModelSinglePlayer2021'
20
22
  # ]
21
23
  ```
22
24
 
@@ -46,6 +48,8 @@ FtcEventsClient::MatchScoresModelMatchScoresOneOf.build(data_that_doesnt_match)
46
48
 
47
49
  - `ScoreDetailModel2019`
48
50
  - `ScoreDetailModel2020`
51
+ - `ScoreDetailModel2021`
49
52
  - `ScoreDetailModelSinglePlayer2020`
53
+ - `ScoreDetailModelSinglePlayer2021`
50
54
  - `nil` (if no type matches)
51
55
 
@@ -0,0 +1,6 @@
1
+ # FtcEventsClient::OneOfMatchScoresModelMatchScoresItems
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+
data/docs/RankingsApi.md CHANGED
@@ -1,14 +1,12 @@
1
1
  # FtcEventsClient::RankingsApi
2
2
 
3
- All URIs are relative to *http://localhost*
3
+ All URIs are relative to *http://ftc-api.firstinspires.org*
4
4
 
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**v20_season_rankings_event_code_get**](RankingsApi.md#v20_season_rankings_event_code_get) | **GET** /v2.0/{season}/rankings/{eventCode} | Event Rankings |
8
-
9
-
10
- ## v20_season_rankings_event_code_get
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**v20_season_rankings_event_code_get**](RankingsApi.md#v20_season_rankings_event_code_get) | **GET** /v2.0/{season}/rankings/{eventCode} | Event Rankings
11
8
 
9
+ # **v20_season_rankings_event_code_get**
12
10
  > EventRankingsModel v20_season_rankings_event_code_get(season, event_code, opts)
13
11
 
14
12
  Event Rankings
@@ -16,7 +14,6 @@ Event Rankings
16
14
  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.
17
15
 
18
16
  ### Example
19
-
20
17
  ```ruby
21
18
  # load the gem
22
19
  require 'ftc_events_client'
@@ -30,7 +27,7 @@ end
30
27
  api_instance = FtcEventsClient::RankingsApi.new
31
28
  season = 56 # Integer | Numeric year of the event from which the rankings are requested. Must be 4 digits
32
29
  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.
33
- opts = {
30
+ opts = {
34
31
  team_number: 0, # Integer | Team number of the team whose ranking is requested.
35
32
  top: 0 # Integer | number of requested `top` ranked teams to return in result.
36
33
  }
@@ -46,12 +43,12 @@ end
46
43
 
47
44
  ### Parameters
48
45
 
49
- | Name | Type | Description | Notes |
50
- | ---- | ---- | ----------- | ----- |
51
- | **season** | **Integer** | Numeric year of the event from which the rankings are requested. Must be 4 digits | |
52
- | **event_code** | **String** | Case insensitive alphanumeric `eventCode` of the event from which the rankings are requested. Must be at least 3 characters. | |
53
- | **team_number** | **Integer** | Team number of the team whose ranking is requested. | [optional][default to 0] |
54
- | **top** | **Integer** | number of requested `top` ranked teams to return in result. | [optional][default to 0] |
46
+ Name | Type | Description | Notes
47
+ ------------- | ------------- | ------------- | -------------
48
+ **season** | **Integer**| Numeric year of the event from which the rankings are requested. Must be 4 digits |
49
+ **event_code** | **String**| Case insensitive alphanumeric `eventCode` of the event from which the rankings are requested. Must be at least 3 characters. |
50
+ **team_number** | **Integer**| Team number of the team whose ranking is requested. | [optional] [default to 0]
51
+ **top** | **Integer**| number of requested `top` ranked teams to return in result. | [optional] [default to 0]
55
52
 
56
53
  ### Return type
57
54
 
@@ -63,6 +60,8 @@ end
63
60
 
64
61
  ### HTTP request headers
65
62
 
66
- - **Content-Type**: Not defined
67
- - **Accept**: application/json
63
+ - **Content-Type**: Not defined
64
+ - **Accept**: application/json
65
+
66
+
68
67