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.
- checksums.yaml +4 -4
- data/README.md +351 -101
- data/Rakefile +0 -2
- data/config.json +1 -1
- data/docs/AllianceModelVersion2.md +10 -28
- data/docs/AllianceScore2020.md +37 -82
- data/docs/AllianceSelectionApi.md +14 -14
- data/docs/AllianceSelectionModelVersion2.md +4 -16
- data/docs/ApiIndexModel.md +11 -30
- data/docs/AutoNavigatedStatus.md +6 -0
- data/docs/AwardAssignmentModel.md +13 -34
- data/docs/AwardsApi.md +47 -49
- data/docs/AwardsModel.md +3 -14
- data/docs/BarcodeElement.md +6 -0
- data/docs/EndgameParkedStatus.md +6 -0
- data/docs/EventMatchResultsModelVersion2.md +3 -14
- data/docs/EventRankingsModel.md +3 -14
- data/docs/EventScheduleHybridModelVersion2.md +3 -14
- data/docs/EventScheduleModelVersion2.md +3 -14
- data/docs/FTCEventLevel.md +6 -0
- data/docs/GeneralApi.md +9 -11
- data/docs/LeagueMemberListModel.md +7 -0
- data/docs/LeaguesApi.md +179 -0
- data/docs/MatchResultModelVersion2.md +16 -40
- data/docs/MatchResultTeamModelVersion2.md +6 -18
- data/docs/MatchResultsApi.md +33 -35
- data/docs/MatchScoresModel.md +3 -14
- data/docs/MatchScoresModelMatchScoresOneOf.md +5 -1
- data/docs/OneOfMatchScoresModelMatchScoresItems.md +6 -0
- data/docs/RankingsApi.md +16 -17
- data/docs/ScheduleApi.md +30 -32
- data/docs/ScheduleHybridModelTeamVersion2.md +8 -22
- data/docs/ScheduleHybridModelVersion2.md +18 -40
- data/docs/ScheduledMatchModelVersion2.md +10 -28
- data/docs/ScheduledMatchTeamModelVersion2.md +6 -20
- data/docs/ScoreDetailAllianceModel2020.md +39 -86
- data/docs/ScoreDetailAllianceModel2021.md +48 -0
- data/docs/ScoreDetailModel2019.md +6 -18
- data/docs/ScoreDetailModel2020.md +6 -18
- data/docs/ScoreDetailModel2021.md +10 -0
- data/docs/ScoreDetailModelAlliance2019.md +36 -80
- data/docs/ScoreDetailModelSinglePlayer2020.md +6 -20
- data/docs/ScoreDetailModelSinglePlayer2021.md +10 -0
- data/docs/ScoreDetailSinglePlayer2021.md +39 -0
- data/docs/SeasonAwardListingsModel.md +3 -14
- data/docs/SeasonAwardsModel.md +6 -20
- data/docs/SeasonDataApi.md +35 -37
- data/docs/SeasonEventListingsModelVersion2.md +4 -16
- data/docs/SeasonEventModelVersion2.md +24 -46
- data/docs/SeasonLeagueListingsModelVersion2.md +8 -0
- data/docs/SeasonLeagueModelVersion2.md +11 -0
- data/docs/SeasonSummaryModelChampionship.md +5 -18
- data/docs/SeasonSummaryModelVersion2.md +8 -24
- data/docs/SeasonTeamListingsModelVersion2.md +7 -22
- data/docs/SeasonTeamModelVersion2.md +14 -36
- data/docs/Stone.md +2 -11
- data/docs/TeamRankingModel.md +17 -42
- data/ftc_events_client.gemspec +5 -5
- data/git_push.sh +7 -10
- data/lib/ftc_events_client/api/alliance_selection_api.rb +17 -22
- data/lib/ftc_events_client/api/awards_api.rb +52 -74
- data/lib/ftc_events_client/api/general_api.rb +8 -17
- data/lib/ftc_events_client/api/leagues_api.rb +218 -0
- data/lib/ftc_events_client/api/match_results_api.rb +44 -45
- data/lib/ftc_events_client/api/rankings_api.rb +17 -22
- data/lib/ftc_events_client/api/schedule_api.rb +44 -45
- data/lib/ftc_events_client/api/season_data_api.rb +30 -53
- data/lib/ftc_events_client/api_client.rb +52 -54
- data/lib/ftc_events_client/api_error.rb +4 -4
- data/lib/ftc_events_client/configuration.rb +6 -76
- data/lib/ftc_events_client/models/alliance_model_version2.rb +19 -31
- data/lib/ftc_events_client/models/{alliance_score2020.rb → alliance_score_2020.rb} +46 -58
- data/lib/ftc_events_client/models/alliance_selection_model_version2.rb +13 -25
- data/lib/ftc_events_client/models/api_index_model.rb +20 -32
- data/lib/ftc_events_client/models/{tournament_level.rb → auto_navigated_status.rb} +11 -21
- data/lib/ftc_events_client/models/award_assignment_model.rb +22 -34
- data/lib/ftc_events_client/models/awards_model.rb +12 -24
- data/lib/ftc_events_client/models/barcode_element.rb +28 -0
- data/lib/ftc_events_client/models/endgame_parked_status.rb +29 -0
- data/lib/ftc_events_client/models/event_match_results_model_version2.rb +12 -24
- data/lib/ftc_events_client/models/event_rankings_model.rb +12 -24
- data/lib/ftc_events_client/models/event_schedule_hybrid_model_version2.rb +12 -24
- data/lib/ftc_events_client/models/event_schedule_model_version2.rb +12 -24
- data/lib/ftc_events_client/models/ftc_event_level.rb +31 -0
- data/lib/ftc_events_client/models/league_member_list_model.rb +209 -0
- data/lib/ftc_events_client/models/match_result_model_version2.rb +25 -37
- data/lib/ftc_events_client/models/match_result_team_model_version2.rb +26 -29
- data/lib/ftc_events_client/models/match_scores_model.rb +12 -24
- data/lib/ftc_events_client/models/one_of_match_scores_model_match_scores_items.rb +197 -0
- data/lib/ftc_events_client/models/schedule_hybrid_model_team_version2.rb +30 -32
- data/lib/ftc_events_client/models/schedule_hybrid_model_version2.rb +46 -38
- data/lib/ftc_events_client/models/scheduled_match_model_version2.rb +19 -31
- data/lib/ftc_events_client/models/scheduled_match_team_model_version2.rb +15 -27
- data/lib/ftc_events_client/models/{score_detail_alliance_model2020.rb → score_detail_alliance_model_2020.rb} +48 -60
- data/lib/ftc_events_client/models/score_detail_alliance_model_2021.rb +576 -0
- data/lib/ftc_events_client/models/{score_detail_model2019.rb → score_detail_model_2019.rb} +24 -27
- data/lib/ftc_events_client/models/{score_detail_model2020.rb → score_detail_model_2020.rb} +24 -27
- data/lib/ftc_events_client/models/score_detail_model_2021.rb +236 -0
- data/lib/ftc_events_client/models/{score_detail_model_alliance2019.rb → score_detail_model_alliance_2019.rb} +45 -57
- data/lib/ftc_events_client/models/{score_detail_model_single_player2020.rb → score_detail_model_single_player_2020.rb} +15 -27
- data/lib/ftc_events_client/models/score_detail_model_single_player_2021.rb +233 -0
- data/lib/ftc_events_client/models/score_detail_single_player_2021.rb +494 -0
- data/lib/ftc_events_client/models/season_award_listings_model.rb +12 -24
- data/lib/ftc_events_client/models/season_awards_model.rb +22 -34
- data/lib/ftc_events_client/models/season_event_listings_model_version2.rb +13 -25
- data/lib/ftc_events_client/models/season_event_model_version2.rb +77 -41
- data/lib/ftc_events_client/models/season_league_listings_model_version2.rb +218 -0
- data/lib/ftc_events_client/models/season_league_model_version2.rb +247 -0
- data/lib/ftc_events_client/models/season_summary_model_championship.rb +14 -26
- data/lib/ftc_events_client/models/season_summary_model_version2.rb +17 -29
- data/lib/ftc_events_client/models/season_team_listings_model_version2.rb +16 -28
- data/lib/ftc_events_client/models/season_team_model_version2.rb +23 -35
- data/lib/ftc_events_client/models/stone.rb +6 -15
- data/lib/ftc_events_client/models/team_ranking_model.rb +26 -38
- data/lib/ftc_events_client/version.rb +4 -5
- data/lib/ftc_events_client.rb +22 -12
- data/spec/api/leagues_api_spec.rb +77 -0
- data/spec/base_object_spec.rb +109 -0
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/alliance_score_2020_spec.rb +244 -0
- data/spec/models/auto_navigated_status_spec.rb +28 -0
- data/spec/models/barcode_element_spec.rb +28 -0
- data/spec/models/endgame_parked_status_spec.rb +28 -0
- data/spec/models/ftc_event_level_spec.rb +28 -0
- data/spec/models/league_member_list_model_spec.rb +34 -0
- data/spec/models/one_of_match_scores_model_match_scores_items_spec.rb +34 -0
- data/spec/models/score_detail_alliance_model2021_spec.rb +280 -0
- data/spec/models/score_detail_alliance_model_2020_spec.rb +256 -0
- data/spec/models/score_detail_alliance_model_2021_spec.rb +286 -0
- data/spec/models/score_detail_model2021_spec.rb +52 -0
- data/spec/models/score_detail_model_2019_spec.rb +58 -0
- data/spec/models/score_detail_model_2020_spec.rb +58 -0
- data/spec/models/score_detail_model_2021_spec.rb +58 -0
- data/spec/models/score_detail_model_alliance_2019_spec.rb +238 -0
- data/spec/models/score_detail_model_single_player2021_spec.rb +52 -0
- data/spec/models/score_detail_model_single_player_2020_spec.rb +58 -0
- data/spec/models/score_detail_model_single_player_2021_spec.rb +58 -0
- data/spec/models/score_detail_single_player2021_spec.rb +226 -0
- data/spec/models/score_detail_single_player_2021_spec.rb +232 -0
- data/spec/models/season_league_listings_model_version2_spec.rb +40 -0
- data/{lib/ftc_events_client/models/match_scores_model_match_scores_one_of.rb → spec/models/season_league_model_version2_spec.rb} +35 -83
- data/update.sh +2 -2
- metadata +103 -11
|
@@ -1,32 +1,14 @@
|
|
|
1
1
|
# FtcEventsClient::AllianceModelVersion2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
| **backup_replaced** | **Integer** | | [optional] |
|
|
15
|
-
|
|
16
|
-
## Code Sample
|
|
17
|
-
|
|
18
|
-
```ruby
|
|
19
|
-
require 'ftc_events_client'
|
|
20
|
-
|
|
21
|
-
instance = FtcEventsClient::AllianceModelVersion2.new(
|
|
22
|
-
number: null,
|
|
23
|
-
name: null,
|
|
24
|
-
captain: null,
|
|
25
|
-
round1: null,
|
|
26
|
-
round2: null,
|
|
27
|
-
round3: null,
|
|
28
|
-
backup: null,
|
|
29
|
-
backup_replaced: null
|
|
30
|
-
)
|
|
31
|
-
```
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**number** | **Integer** | | [optional]
|
|
7
|
+
**name** | **String** | | [optional]
|
|
8
|
+
**captain** | **Integer** | | [optional]
|
|
9
|
+
**round1** | **Integer** | | [optional]
|
|
10
|
+
**round2** | **Integer** | | [optional]
|
|
11
|
+
**round3** | **Integer** | | [optional]
|
|
12
|
+
**backup** | **Integer** | | [optional]
|
|
13
|
+
**backup_replaced** | **Integer** | | [optional]
|
|
32
14
|
|
data/docs/AllianceScore2020.md
CHANGED
|
@@ -1,86 +1,41 @@
|
|
|
1
1
|
# FtcEventsClient::AllianceScore2020
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
| **total_points** | **Integer** | | [optional] |
|
|
42
|
-
|
|
43
|
-
## Code Sample
|
|
44
|
-
|
|
45
|
-
```ruby
|
|
46
|
-
require 'ftc_events_client'
|
|
47
|
-
|
|
48
|
-
instance = FtcEventsClient::AllianceScore2020.new(
|
|
49
|
-
adjust: null,
|
|
50
|
-
dc_points: null,
|
|
51
|
-
auto_points: null,
|
|
52
|
-
dc_tower_low: null,
|
|
53
|
-
dc_tower_mid: null,
|
|
54
|
-
dc_tower_high: null,
|
|
55
|
-
navigated1: null,
|
|
56
|
-
navigated2: null,
|
|
57
|
-
wobble_delivered1: null,
|
|
58
|
-
wobble_delivered2: null,
|
|
59
|
-
auto_tower_low: null,
|
|
60
|
-
auto_tower_mid: null,
|
|
61
|
-
auto_tower_high: null,
|
|
62
|
-
auto_tower_points: null,
|
|
63
|
-
auto_power_shot_left: null,
|
|
64
|
-
auto_power_shot_center: null,
|
|
65
|
-
auto_power_shot_right: null,
|
|
66
|
-
auto_power_shot_points: null,
|
|
67
|
-
wobble_rings1: null,
|
|
68
|
-
wobble_rings2: null,
|
|
69
|
-
wobble_end1: null,
|
|
70
|
-
wobble_end2: null,
|
|
71
|
-
wobble_end_points: null,
|
|
72
|
-
wobble_ring_points: null,
|
|
73
|
-
auto_wobble_points: null,
|
|
74
|
-
end_power_shot_left: null,
|
|
75
|
-
end_power_shot_center: null,
|
|
76
|
-
end_power_shot_right: null,
|
|
77
|
-
end_power_shot_points: null,
|
|
78
|
-
penalty_points: null,
|
|
79
|
-
major_penalties: null,
|
|
80
|
-
minor_penalties: null,
|
|
81
|
-
navigation_points: null,
|
|
82
|
-
endgame_points: null,
|
|
83
|
-
total_points: null
|
|
84
|
-
)
|
|
85
|
-
```
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**adjust** | **Integer** | | [optional]
|
|
7
|
+
**dc_points** | **Integer** | | [optional]
|
|
8
|
+
**auto_points** | **Integer** | | [optional]
|
|
9
|
+
**dc_tower_low** | **Integer** | | [optional]
|
|
10
|
+
**dc_tower_mid** | **Integer** | | [optional]
|
|
11
|
+
**dc_tower_high** | **Integer** | | [optional]
|
|
12
|
+
**navigated1** | **BOOLEAN** | | [optional]
|
|
13
|
+
**navigated2** | **BOOLEAN** | | [optional]
|
|
14
|
+
**wobble_delivered1** | **BOOLEAN** | | [optional]
|
|
15
|
+
**wobble_delivered2** | **BOOLEAN** | | [optional]
|
|
16
|
+
**auto_tower_low** | **Integer** | | [optional]
|
|
17
|
+
**auto_tower_mid** | **Integer** | | [optional]
|
|
18
|
+
**auto_tower_high** | **Integer** | | [optional]
|
|
19
|
+
**auto_tower_points** | **Integer** | | [optional]
|
|
20
|
+
**auto_power_shot_left** | **BOOLEAN** | | [optional]
|
|
21
|
+
**auto_power_shot_center** | **BOOLEAN** | | [optional]
|
|
22
|
+
**auto_power_shot_right** | **BOOLEAN** | | [optional]
|
|
23
|
+
**auto_power_shot_points** | **Integer** | | [optional]
|
|
24
|
+
**wobble_rings1** | **Integer** | | [optional]
|
|
25
|
+
**wobble_rings2** | **Integer** | | [optional]
|
|
26
|
+
**wobble_end1** | **Integer** | | [optional]
|
|
27
|
+
**wobble_end2** | **Integer** | | [optional]
|
|
28
|
+
**wobble_end_points** | **Integer** | | [optional]
|
|
29
|
+
**wobble_ring_points** | **Integer** | | [optional]
|
|
30
|
+
**auto_wobble_points** | **Integer** | | [optional]
|
|
31
|
+
**end_power_shot_left** | **BOOLEAN** | | [optional]
|
|
32
|
+
**end_power_shot_center** | **BOOLEAN** | | [optional]
|
|
33
|
+
**end_power_shot_right** | **BOOLEAN** | | [optional]
|
|
34
|
+
**end_power_shot_points** | **Integer** | | [optional]
|
|
35
|
+
**penalty_points** | **Integer** | | [optional]
|
|
36
|
+
**major_penalties** | **Integer** | | [optional]
|
|
37
|
+
**minor_penalties** | **Integer** | | [optional]
|
|
38
|
+
**navigation_points** | **Integer** | | [optional]
|
|
39
|
+
**endgame_points** | **Integer** | | [optional]
|
|
40
|
+
**total_points** | **Integer** | | [optional]
|
|
86
41
|
|
|
@@ -1,14 +1,12 @@
|
|
|
1
1
|
# FtcEventsClient::AllianceSelectionApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *http://
|
|
3
|
+
All URIs are relative to *http://ftc-api.firstinspires.org*
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
## v20_season_alliances_event_code_get
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**v20_season_alliances_event_code_get**](AllianceSelectionApi.md#v20_season_alliances_event_code_get) | **GET** /v2.0/{season}/alliances/{eventCode} | Event Alliances
|
|
11
8
|
|
|
9
|
+
# **v20_season_alliances_event_code_get**
|
|
12
10
|
> AllianceSelectionModelVersion2 v20_season_alliances_event_code_get(season, event_code)
|
|
13
11
|
|
|
14
12
|
Event Alliances
|
|
@@ -16,7 +14,6 @@ Event Alliances
|
|
|
16
14
|
The alliances API returns details about alliance selection at a particular event in a particular season.
|
|
17
15
|
|
|
18
16
|
### Example
|
|
19
|
-
|
|
20
17
|
```ruby
|
|
21
18
|
# load the gem
|
|
22
19
|
require 'ftc_events_client'
|
|
@@ -31,6 +28,7 @@ api_instance = FtcEventsClient::AllianceSelectionApi.new
|
|
|
31
28
|
season = 56 # Integer | Numeric year of the event from which the event alliances are requested. Must be 4 digits.
|
|
32
29
|
event_code = 'event_code_example' # String | Case insensitive alphanumeric `eventCode` of the event from which the alliance selection results are requested. Must be at least 3 characters.
|
|
33
30
|
|
|
31
|
+
|
|
34
32
|
begin
|
|
35
33
|
#Event Alliances
|
|
36
34
|
result = api_instance.v20_season_alliances_event_code_get(season, event_code)
|
|
@@ -42,10 +40,10 @@ end
|
|
|
42
40
|
|
|
43
41
|
### Parameters
|
|
44
42
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
43
|
+
Name | Type | Description | Notes
|
|
44
|
+
------------- | ------------- | ------------- | -------------
|
|
45
|
+
**season** | **Integer**| Numeric year of the event from which the event alliances are requested. Must be 4 digits. |
|
|
46
|
+
**event_code** | **String**| Case insensitive alphanumeric `eventCode` of the event from which the alliance selection results are requested. Must be at least 3 characters. |
|
|
49
47
|
|
|
50
48
|
### Return type
|
|
51
49
|
|
|
@@ -57,6 +55,8 @@ end
|
|
|
57
55
|
|
|
58
56
|
### HTTP request headers
|
|
59
57
|
|
|
60
|
-
- **Content-Type**: Not defined
|
|
61
|
-
- **Accept**: application/json
|
|
58
|
+
- **Content-Type**: Not defined
|
|
59
|
+
- **Accept**: application/json
|
|
60
|
+
|
|
61
|
+
|
|
62
62
|
|
|
@@ -1,20 +1,8 @@
|
|
|
1
1
|
# FtcEventsClient::AllianceSelectionModelVersion2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
| **count** | **Integer** | | [optional] |
|
|
9
|
-
|
|
10
|
-
## Code Sample
|
|
11
|
-
|
|
12
|
-
```ruby
|
|
13
|
-
require 'ftc_events_client'
|
|
14
|
-
|
|
15
|
-
instance = FtcEventsClient::AllianceSelectionModelVersion2.new(
|
|
16
|
-
alliances: null,
|
|
17
|
-
count: null
|
|
18
|
-
)
|
|
19
|
-
```
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**alliances** | [**Array<AllianceModelVersion2>**](AllianceModelVersion2.md) | | [optional]
|
|
7
|
+
**count** | **Integer** | | [optional]
|
|
20
8
|
|
data/docs/ApiIndexModel.md
CHANGED
|
@@ -1,34 +1,15 @@
|
|
|
1
1
|
# FtcEventsClient::ApiIndexModel
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
| **max_season** | **Integer** | max season that can be retrieved from the API/webpages | [optional] |
|
|
16
|
-
|
|
17
|
-
## Code Sample
|
|
18
|
-
|
|
19
|
-
```ruby
|
|
20
|
-
require 'ftc_events_client'
|
|
21
|
-
|
|
22
|
-
instance = FtcEventsClient::ApiIndexModel.new(
|
|
23
|
-
name: FIRST TECH CHALLENGE API,
|
|
24
|
-
api_version: 2.0,
|
|
25
|
-
service_mainifest_name: null,
|
|
26
|
-
service_mainifest_version: null,
|
|
27
|
-
code_package_name: null,
|
|
28
|
-
code_package_version: null,
|
|
29
|
-
status: null,
|
|
30
|
-
current_season: 2020,
|
|
31
|
-
max_season: 2020
|
|
32
|
-
)
|
|
33
|
-
```
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | api name | [optional]
|
|
7
|
+
**api_version** | **String** | api version | [optional]
|
|
8
|
+
**service_mainifest_name** | **String** | | [optional]
|
|
9
|
+
**service_mainifest_version** | **String** | | [optional]
|
|
10
|
+
**code_package_name** | **String** | | [optional]
|
|
11
|
+
**code_package_version** | **String** | | [optional]
|
|
12
|
+
**status** | **String** | | [optional]
|
|
13
|
+
**current_season** | **Integer** | current season in the eyes of FTC | [optional]
|
|
14
|
+
**max_season** | **Integer** | max season that can be retrieved from the API/webpages | [optional]
|
|
34
15
|
|
|
@@ -1,38 +1,17 @@
|
|
|
1
1
|
# FtcEventsClient::AwardAssignmentModel
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| **person** | **String** | | [optional] |
|
|
18
|
-
|
|
19
|
-
## Code Sample
|
|
20
|
-
|
|
21
|
-
```ruby
|
|
22
|
-
require 'ftc_events_client'
|
|
23
|
-
|
|
24
|
-
instance = FtcEventsClient::AwardAssignmentModel.new(
|
|
25
|
-
award_id: null,
|
|
26
|
-
team_id: null,
|
|
27
|
-
event_id: null,
|
|
28
|
-
event_division_id: null,
|
|
29
|
-
event_code: null,
|
|
30
|
-
name: null,
|
|
31
|
-
series: null,
|
|
32
|
-
team_number: null,
|
|
33
|
-
school_name: null,
|
|
34
|
-
full_team_name: null,
|
|
35
|
-
person: null
|
|
36
|
-
)
|
|
37
|
-
```
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**award_id** | **Integer** | | [optional]
|
|
7
|
+
**team_id** | **Integer** | | [optional]
|
|
8
|
+
**event_id** | **Integer** | | [optional]
|
|
9
|
+
**event_division_id** | **Integer** | | [optional]
|
|
10
|
+
**event_code** | **String** | | [optional]
|
|
11
|
+
**name** | **String** | | [optional]
|
|
12
|
+
**series** | **Integer** | | [optional]
|
|
13
|
+
**team_number** | **Integer** | | [optional]
|
|
14
|
+
**school_name** | **String** | | [optional]
|
|
15
|
+
**full_team_name** | **String** | | [optional]
|
|
16
|
+
**person** | **String** | | [optional]
|
|
38
17
|
|
data/docs/AwardsApi.md
CHANGED
|
@@ -1,17 +1,15 @@
|
|
|
1
1
|
# FtcEventsClient::AwardsApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *http://
|
|
3
|
+
All URIs are relative to *http://ftc-api.firstinspires.org*
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
## v20_season_awards_event_code_get
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**v20_season_awards_event_code_get**](AwardsApi.md#v20_season_awards_event_code_get) | **GET** /v2.0/{season}/awards/{eventCode} | Event Awards
|
|
8
|
+
[**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
|
|
9
|
+
[**v20_season_awards_list_get**](AwardsApi.md#v20_season_awards_list_get) | **GET** /v2.0/{season}/awards/list | Award Listings
|
|
10
|
+
[**v20_season_awards_team_number_get**](AwardsApi.md#v20_season_awards_team_number_get) | **GET** /v2.0/{season}/awards/{teamNumber} | Event Awards
|
|
14
11
|
|
|
12
|
+
# **v20_season_awards_event_code_get**
|
|
15
13
|
> AwardsModel v20_season_awards_event_code_get(season, event_code, opts)
|
|
16
14
|
|
|
17
15
|
Event Awards
|
|
@@ -19,7 +17,6 @@ Event Awards
|
|
|
19
17
|
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`.
|
|
20
18
|
|
|
21
19
|
### Example
|
|
22
|
-
|
|
23
20
|
```ruby
|
|
24
21
|
# load the gem
|
|
25
22
|
require 'ftc_events_client'
|
|
@@ -32,8 +29,8 @@ end
|
|
|
32
29
|
|
|
33
30
|
api_instance = FtcEventsClient::AwardsApi.new
|
|
34
31
|
season = 56 # Integer | Numeric year of the event from which the award listings are requested. Must be 4 digits
|
|
35
|
-
event_code = '' # String | Case insensitive alphanumeric `eventCode` of the event from which the awards are requested.
|
|
36
|
-
opts = {
|
|
32
|
+
event_code = 'event_code_example' # String | Case insensitive alphanumeric `eventCode` of the event from which the awards are requested.
|
|
33
|
+
opts = {
|
|
37
34
|
team_number: 0 # Integer | `teamNumber` to search for within the results.
|
|
38
35
|
}
|
|
39
36
|
|
|
@@ -48,11 +45,11 @@ end
|
|
|
48
45
|
|
|
49
46
|
### Parameters
|
|
50
47
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
48
|
+
Name | Type | Description | Notes
|
|
49
|
+
------------- | ------------- | ------------- | -------------
|
|
50
|
+
**season** | **Integer**| Numeric year of the event from which the award listings are requested. Must be 4 digits |
|
|
51
|
+
**event_code** | **String**| Case insensitive alphanumeric `eventCode` of the event from which the awards are requested. |
|
|
52
|
+
**team_number** | **Integer**| `teamNumber` to search for within the results. | [optional] [default to 0]
|
|
56
53
|
|
|
57
54
|
### Return type
|
|
58
55
|
|
|
@@ -64,12 +61,12 @@ end
|
|
|
64
61
|
|
|
65
62
|
### HTTP request headers
|
|
66
63
|
|
|
67
|
-
- **Content-Type**: Not defined
|
|
68
|
-
- **Accept**: application/json
|
|
64
|
+
- **Content-Type**: Not defined
|
|
65
|
+
- **Accept**: application/json
|
|
69
66
|
|
|
70
67
|
|
|
71
|
-
## v20_season_awards_event_code_team_number_get
|
|
72
68
|
|
|
69
|
+
# **v20_season_awards_event_code_team_number_get**
|
|
73
70
|
> AwardsModel v20_season_awards_event_code_team_number_get(season, event_code, team_number)
|
|
74
71
|
|
|
75
72
|
Event Awards
|
|
@@ -77,7 +74,6 @@ Event Awards
|
|
|
77
74
|
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`.
|
|
78
75
|
|
|
79
76
|
### Example
|
|
80
|
-
|
|
81
77
|
```ruby
|
|
82
78
|
# load the gem
|
|
83
79
|
require 'ftc_events_client'
|
|
@@ -90,8 +86,9 @@ end
|
|
|
90
86
|
|
|
91
87
|
api_instance = FtcEventsClient::AwardsApi.new
|
|
92
88
|
season = 56 # Integer | Numeric year of the event from which the award listings are requested. Must be 4 digits
|
|
93
|
-
event_code = '' # String | Case insensitive alphanumeric `eventCode` of the event from which the awards are requested.
|
|
94
|
-
team_number =
|
|
89
|
+
event_code = 'event_code_example' # String | Case insensitive alphanumeric `eventCode` of the event from which the awards are requested.
|
|
90
|
+
team_number = 56 # Integer | `teamNumber` to search for within the results.
|
|
91
|
+
|
|
95
92
|
|
|
96
93
|
begin
|
|
97
94
|
#Event Awards
|
|
@@ -104,11 +101,11 @@ end
|
|
|
104
101
|
|
|
105
102
|
### Parameters
|
|
106
103
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
104
|
+
Name | Type | Description | Notes
|
|
105
|
+
------------- | ------------- | ------------- | -------------
|
|
106
|
+
**season** | **Integer**| Numeric year of the event from which the award listings are requested. Must be 4 digits |
|
|
107
|
+
**event_code** | **String**| Case insensitive alphanumeric `eventCode` of the event from which the awards are requested. |
|
|
108
|
+
**team_number** | **Integer**| `teamNumber` to search for within the results. |
|
|
112
109
|
|
|
113
110
|
### Return type
|
|
114
111
|
|
|
@@ -120,12 +117,12 @@ end
|
|
|
120
117
|
|
|
121
118
|
### HTTP request headers
|
|
122
119
|
|
|
123
|
-
- **Content-Type**: Not defined
|
|
124
|
-
- **Accept**: application/json
|
|
120
|
+
- **Content-Type**: Not defined
|
|
121
|
+
- **Accept**: application/json
|
|
125
122
|
|
|
126
123
|
|
|
127
|
-
## v20_season_awards_list_get
|
|
128
124
|
|
|
125
|
+
# **v20_season_awards_list_get**
|
|
129
126
|
> SeasonAwardListingsModel v20_season_awards_list_get(season)
|
|
130
127
|
|
|
131
128
|
Award Listings
|
|
@@ -133,7 +130,6 @@ Award Listings
|
|
|
133
130
|
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.
|
|
134
131
|
|
|
135
132
|
### Example
|
|
136
|
-
|
|
137
133
|
```ruby
|
|
138
134
|
# load the gem
|
|
139
135
|
require 'ftc_events_client'
|
|
@@ -147,6 +143,7 @@ end
|
|
|
147
143
|
api_instance = FtcEventsClient::AwardsApi.new
|
|
148
144
|
season = 56 # Integer | Numeric year of the event from which the award listings are requested. Must be 4 digits
|
|
149
145
|
|
|
146
|
+
|
|
150
147
|
begin
|
|
151
148
|
#Award Listings
|
|
152
149
|
result = api_instance.v20_season_awards_list_get(season)
|
|
@@ -158,9 +155,9 @@ end
|
|
|
158
155
|
|
|
159
156
|
### Parameters
|
|
160
157
|
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
158
|
+
Name | Type | Description | Notes
|
|
159
|
+
------------- | ------------- | ------------- | -------------
|
|
160
|
+
**season** | **Integer**| Numeric year of the event from which the award listings are requested. Must be 4 digits |
|
|
164
161
|
|
|
165
162
|
### Return type
|
|
166
163
|
|
|
@@ -172,12 +169,12 @@ end
|
|
|
172
169
|
|
|
173
170
|
### HTTP request headers
|
|
174
171
|
|
|
175
|
-
- **Content-Type**: Not defined
|
|
176
|
-
- **Accept**: application/json
|
|
172
|
+
- **Content-Type**: Not defined
|
|
173
|
+
- **Accept**: application/json
|
|
177
174
|
|
|
178
175
|
|
|
179
|
-
## v20_season_awards_team_number_get
|
|
180
176
|
|
|
177
|
+
# **v20_season_awards_team_number_get**
|
|
181
178
|
> AwardsModel v20_season_awards_team_number_get(season, team_number, opts)
|
|
182
179
|
|
|
183
180
|
Event Awards
|
|
@@ -185,7 +182,6 @@ Event Awards
|
|
|
185
182
|
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`.
|
|
186
183
|
|
|
187
184
|
### Example
|
|
188
|
-
|
|
189
185
|
```ruby
|
|
190
186
|
# load the gem
|
|
191
187
|
require 'ftc_events_client'
|
|
@@ -198,8 +194,8 @@ end
|
|
|
198
194
|
|
|
199
195
|
api_instance = FtcEventsClient::AwardsApi.new
|
|
200
196
|
season = 56 # Integer | Numeric year of the event from which the award listings are requested. Must be 4 digits
|
|
201
|
-
team_number =
|
|
202
|
-
opts = {
|
|
197
|
+
team_number = 56 # Integer | `teamNumber` to search for within the results.
|
|
198
|
+
opts = {
|
|
203
199
|
event_code: '' # String | Case insensitive alphanumeric `eventCode` of the event from which the awards are requested.
|
|
204
200
|
}
|
|
205
201
|
|
|
@@ -214,11 +210,11 @@ end
|
|
|
214
210
|
|
|
215
211
|
### Parameters
|
|
216
212
|
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
213
|
+
Name | Type | Description | Notes
|
|
214
|
+
------------- | ------------- | ------------- | -------------
|
|
215
|
+
**season** | **Integer**| Numeric year of the event from which the award listings are requested. Must be 4 digits |
|
|
216
|
+
**team_number** | **Integer**| `teamNumber` to search for within the results. |
|
|
217
|
+
**event_code** | **String**| Case insensitive alphanumeric `eventCode` of the event from which the awards are requested. | [optional]
|
|
222
218
|
|
|
223
219
|
### Return type
|
|
224
220
|
|
|
@@ -230,6 +226,8 @@ end
|
|
|
230
226
|
|
|
231
227
|
### HTTP request headers
|
|
232
228
|
|
|
233
|
-
- **Content-Type**: Not defined
|
|
234
|
-
- **Accept**: application/json
|
|
229
|
+
- **Content-Type**: Not defined
|
|
230
|
+
- **Accept**: application/json
|
|
231
|
+
|
|
232
|
+
|
|
235
233
|
|
data/docs/AwardsModel.md
CHANGED
|
@@ -1,18 +1,7 @@
|
|
|
1
1
|
# FtcEventsClient::AwardsModel
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
| **awards** | [**Array<AwardAssignmentModel>**](AwardAssignmentModel.md) | | [optional] |
|
|
8
|
-
|
|
9
|
-
## Code Sample
|
|
10
|
-
|
|
11
|
-
```ruby
|
|
12
|
-
require 'ftc_events_client'
|
|
13
|
-
|
|
14
|
-
instance = FtcEventsClient::AwardsModel.new(
|
|
15
|
-
awards: null
|
|
16
|
-
)
|
|
17
|
-
```
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**awards** | [**Array<AwardAssignmentModel>**](AwardAssignmentModel.md) | | [optional]
|
|
18
7
|
|
|
@@ -1,18 +1,7 @@
|
|
|
1
1
|
# FtcEventsClient::EventMatchResultsModelVersion2
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
| **matches** | [**Array<MatchResultModelVersion2>**](MatchResultModelVersion2.md) | | [optional] |
|
|
8
|
-
|
|
9
|
-
## Code Sample
|
|
10
|
-
|
|
11
|
-
```ruby
|
|
12
|
-
require 'ftc_events_client'
|
|
13
|
-
|
|
14
|
-
instance = FtcEventsClient::EventMatchResultsModelVersion2.new(
|
|
15
|
-
matches: null
|
|
16
|
-
)
|
|
17
|
-
```
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**matches** | [**Array<MatchResultModelVersion2>**](MatchResultModelVersion2.md) | | [optional]
|
|
18
7
|
|