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,84 +1,40 @@
1
1
  # FtcEventsClient::ScoreDetailModelAlliance2019
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **alliance** | **String** | | [optional] |
8
- | **robot1_navigated** | **Boolean** | | [optional] |
9
- | **robot1_parked** | **Boolean** | | [optional] |
10
- | **robot1_capstone_level** | **Integer** | | [optional] |
11
- | **robot2_navigated** | **Boolean** | | [optional] |
12
- | **robot2_parked** | **Boolean** | | [optional] |
13
- | **robot2_capstone_level** | **Integer** | | [optional] |
14
- | **auto_stones** | [**Array<Stone>**](Stone.md) | | [optional] |
15
- | **auto_delivered** | **Integer** | | [optional] |
16
- | **auto_returned** | **Integer** | | [optional] |
17
- | **first_returned_is_skystone** | **Boolean** | | [optional] |
18
- | **auto_placed** | **Integer** | | [optional] |
19
- | **foundation_repositioned** | **Boolean** | | [optional] |
20
- | **foundation_moved** | **Boolean** | | [optional] |
21
- | **driver_controlled_delivered** | **Integer** | | [optional] |
22
- | **driver_controlled_returned** | **Integer** | | [optional] |
23
- | **driver_controlled_placed** | **Integer** | | [optional] |
24
- | **tallest_skyscraper** | **Integer** | | [optional] |
25
- | **auto_delivery_points** | **Integer** | | [optional] |
26
- | **auto_placed_points** | **Integer** | | [optional] |
27
- | **autonomous_points** | **Integer** | | [optional] |
28
- | **repositioned_points** | **Integer** | | [optional] |
29
- | **navigation_points** | **Integer** | | [optional] |
30
- | **driver_controlled_delivery_points** | **Integer** | | [optional] |
31
- | **driver_controlled_placed_points** | **Integer** | | [optional] |
32
- | **skyscraper_bonus_points** | **Integer** | | [optional] |
33
- | **capstone_points** | **Integer** | | [optional] |
34
- | **driver_controlled_points** | **Integer** | | [optional] |
35
- | **parking_points** | **Integer** | | [optional] |
36
- | **end_game_points** | **Integer** | | [optional] |
37
- | **minor_penalties** | **Integer** | | [optional] |
38
- | **major_penalties** | **Integer** | | [optional] |
39
- | **penalty_points** | **Integer** | | [optional] |
40
- | **total_points** | **Integer** | | [optional] |
41
-
42
- ## Code Sample
43
-
44
- ```ruby
45
- require 'ftc_events_client'
46
-
47
- instance = FtcEventsClient::ScoreDetailModelAlliance2019.new(
48
- alliance: null,
49
- robot1_navigated: null,
50
- robot1_parked: null,
51
- robot1_capstone_level: null,
52
- robot2_navigated: null,
53
- robot2_parked: null,
54
- robot2_capstone_level: null,
55
- auto_stones: null,
56
- auto_delivered: null,
57
- auto_returned: null,
58
- first_returned_is_skystone: null,
59
- auto_placed: null,
60
- foundation_repositioned: null,
61
- foundation_moved: null,
62
- driver_controlled_delivered: null,
63
- driver_controlled_returned: null,
64
- driver_controlled_placed: null,
65
- tallest_skyscraper: null,
66
- auto_delivery_points: null,
67
- auto_placed_points: null,
68
- autonomous_points: null,
69
- repositioned_points: null,
70
- navigation_points: null,
71
- driver_controlled_delivery_points: null,
72
- driver_controlled_placed_points: null,
73
- skyscraper_bonus_points: null,
74
- capstone_points: null,
75
- driver_controlled_points: null,
76
- parking_points: null,
77
- end_game_points: null,
78
- minor_penalties: null,
79
- major_penalties: null,
80
- penalty_points: null,
81
- total_points: null
82
- )
83
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **alliance** | **String** | | [optional]
7
+ **robot1_navigated** | **BOOLEAN** | | [optional]
8
+ **robot1_parked** | **BOOLEAN** | | [optional]
9
+ **robot1_capstone_level** | **Integer** | | [optional]
10
+ **robot2_navigated** | **BOOLEAN** | | [optional]
11
+ **robot2_parked** | **BOOLEAN** | | [optional]
12
+ **robot2_capstone_level** | **Integer** | | [optional]
13
+ **auto_stones** | [**Array<Stone>**](Stone.md) | | [optional]
14
+ **auto_delivered** | **Integer** | | [optional]
15
+ **auto_returned** | **Integer** | | [optional]
16
+ **first_returned_is_skystone** | **BOOLEAN** | | [optional]
17
+ **auto_placed** | **Integer** | | [optional]
18
+ **foundation_repositioned** | **BOOLEAN** | | [optional]
19
+ **foundation_moved** | **BOOLEAN** | | [optional]
20
+ **driver_controlled_delivered** | **Integer** | | [optional]
21
+ **driver_controlled_returned** | **Integer** | | [optional]
22
+ **driver_controlled_placed** | **Integer** | | [optional]
23
+ **tallest_skyscraper** | **Integer** | | [optional]
24
+ **auto_delivery_points** | **Integer** | | [optional]
25
+ **auto_placed_points** | **Integer** | | [optional]
26
+ **autonomous_points** | **Integer** | | [optional]
27
+ **repositioned_points** | **Integer** | | [optional]
28
+ **navigation_points** | **Integer** | | [optional]
29
+ **driver_controlled_delivery_points** | **Integer** | | [optional]
30
+ **driver_controlled_placed_points** | **Integer** | | [optional]
31
+ **skyscraper_bonus_points** | **Integer** | | [optional]
32
+ **capstone_points** | **Integer** | | [optional]
33
+ **driver_controlled_points** | **Integer** | | [optional]
34
+ **parking_points** | **Integer** | | [optional]
35
+ **end_game_points** | **Integer** | | [optional]
36
+ **minor_penalties** | **Integer** | | [optional]
37
+ **major_penalties** | **Integer** | | [optional]
38
+ **penalty_points** | **Integer** | | [optional]
39
+ **total_points** | **Integer** | | [optional]
84
40
 
@@ -1,24 +1,10 @@
1
1
  # FtcEventsClient::ScoreDetailModelSinglePlayer2020
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **match_level** | [**TournamentLevel**](TournamentLevel.md) | | [optional] |
8
- | **match_number** | **Integer** | | [optional] |
9
- | **team_number** | **Integer** | | [optional] |
10
- | **scores** | [**AllianceScore2020**](AllianceScore2020.md) | | [optional] |
11
-
12
- ## Code Sample
13
-
14
- ```ruby
15
- require 'ftc_events_client'
16
-
17
- instance = FtcEventsClient::ScoreDetailModelSinglePlayer2020.new(
18
- match_level: null,
19
- match_number: null,
20
- team_number: null,
21
- scores: null
22
- )
23
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **match_level** | [**FTCEventLevel**](FTCEventLevel.md) | | [optional]
7
+ **match_number** | **Integer** | | [optional]
8
+ **team_number** | **Integer** | | [optional]
9
+ **scores** | [**AllianceScore2020**](AllianceScore2020.md) | | [optional]
24
10
 
@@ -0,0 +1,10 @@
1
+ # FtcEventsClient::ScoreDetailModelSinglePlayer2021
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **match_level** | [**FTCEventLevel**](FTCEventLevel.md) | | [optional]
7
+ **match_number** | **Integer** | | [optional]
8
+ **team_number** | **Integer** | | [optional]
9
+ **scores** | [**ScoreDetailSinglePlayer2021**](ScoreDetailSinglePlayer2021.md) | | [optional]
10
+
@@ -0,0 +1,39 @@
1
+ # FtcEventsClient::ScoreDetailSinglePlayer2021
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **barcode_element** | [**BarcodeElement**](BarcodeElement.md) | | [optional]
7
+ **carousel** | **BOOLEAN** | | [optional]
8
+ **auto_navigated** | [**AutoNavigatedStatus**](AutoNavigatedStatus.md) | | [optional]
9
+ **auto_bonus** | **BOOLEAN** | | [optional]
10
+ **auto_storage_freight** | **Integer** | | [optional]
11
+ **auto_freight1** | **Integer** | | [optional]
12
+ **auto_freight2** | **Integer** | | [optional]
13
+ **auto_freight3** | **Integer** | | [optional]
14
+ **driver_controlled_storage_freight** | **Integer** | | [optional]
15
+ **driver_controlled_freight1** | **Integer** | | [optional]
16
+ **driver_controlled_freight2** | **Integer** | | [optional]
17
+ **driver_controlled_freight3** | **Integer** | | [optional]
18
+ **endgame_delivered** | **Integer** | | [optional]
19
+ **alliance_balanced** | **BOOLEAN** | | [optional]
20
+ **endgame_parked** | [**EndgameParkedStatus**](EndgameParkedStatus.md) | | [optional]
21
+ **capped** | **Integer** | | [optional]
22
+ **minor_penalties** | **Integer** | | [optional]
23
+ **major_penalties** | **Integer** | | [optional]
24
+ **carousel_points** | **Integer** | | [optional]
25
+ **auto_navigation_points** | **Integer** | | [optional]
26
+ **auto_freight_points** | **Integer** | | [optional]
27
+ **auto_bonus_points** | **Integer** | | [optional]
28
+ **driver_controlled_alliance_hub_points** | **Integer** | | [optional]
29
+ **driver_controlled_storage_points** | **Integer** | | [optional]
30
+ **endgame_delivery_points** | **Integer** | | [optional]
31
+ **alliance_balanced_points** | **Integer** | | [optional]
32
+ **endgame_parking_points** | **Integer** | | [optional]
33
+ **capping_points** | **Integer** | | [optional]
34
+ **auto_points** | **Integer** | | [optional]
35
+ **driver_controlled_points** | **Integer** | | [optional]
36
+ **endgame_points** | **Integer** | | [optional]
37
+ **penalty_points** | **Integer** | | [optional]
38
+ **total_points** | **Integer** | | [optional]
39
+
@@ -1,18 +1,7 @@
1
1
  # FtcEventsClient::SeasonAwardListingsModel
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **awards** | [**Array<SeasonAwardsModel>**](SeasonAwardsModel.md) | | [optional] |
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'ftc_events_client'
13
-
14
- instance = FtcEventsClient::SeasonAwardListingsModel.new(
15
- awards: null
16
- )
17
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **awards** | [**Array<SeasonAwardsModel>**](SeasonAwardsModel.md) | | [optional]
18
7
 
@@ -1,24 +1,10 @@
1
1
  # FtcEventsClient::SeasonAwardsModel
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **award_id** | **Integer** | | [optional] |
8
- | **event_type** | **String** | | [optional] |
9
- | **description** | **String** | | [optional] |
10
- | **for_person** | **Boolean** | | [optional] |
11
-
12
- ## Code Sample
13
-
14
- ```ruby
15
- require 'ftc_events_client'
16
-
17
- instance = FtcEventsClient::SeasonAwardsModel.new(
18
- award_id: null,
19
- event_type: null,
20
- description: null,
21
- for_person: null
22
- )
23
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **award_id** | **Integer** | | [optional]
7
+ **name** | **String** | | [optional]
8
+ **description** | **String** | | [optional]
9
+ **for_person** | **BOOLEAN** | | [optional]
24
10
 
@@ -1,16 +1,14 @@
1
1
  # FtcEventsClient::SeasonDataApi
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_events_get**](SeasonDataApi.md#v20_season_events_get) | **GET** /v2.0/{season}/events | Event Listings |
8
- | [**v20_season_get**](SeasonDataApi.md#v20_season_get) | **GET** /v2.0/{season} | Season Summary |
9
- | [**v20_season_teams_get**](SeasonDataApi.md#v20_season_teams_get) | **GET** /v2.0/{season}/teams | Team Listings |
10
-
11
-
12
- ## v20_season_events_get
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**v20_season_events_get**](SeasonDataApi.md#v20_season_events_get) | **GET** /v2.0/{season}/events | Event Listings
8
+ [**v20_season_get**](SeasonDataApi.md#v20_season_get) | **GET** /v2.0/{season} | Season Summary
9
+ [**v20_season_teams_get**](SeasonDataApi.md#v20_season_teams_get) | **GET** /v2.0/{season}/teams | Team Listings
13
10
 
11
+ # **v20_season_events_get**
14
12
  > SeasonEventListingsModelVersion2 v20_season_events_get(season, opts)
15
13
 
16
14
  Event Listings
@@ -18,7 +16,6 @@ Event Listings
18
16
  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.
19
17
 
20
18
  ### Example
21
-
22
19
  ```ruby
23
20
  # load the gem
24
21
  require 'ftc_events_client'
@@ -31,7 +28,7 @@ end
31
28
 
32
29
  api_instance = FtcEventsClient::SeasonDataApi.new
33
30
  season = 56 # Integer | Numeric year from which the event listings are requested. Must be 4 digits
34
- opts = {
31
+ opts = {
35
32
  event_code: '0', # String | Case insensitive alphanumeric `eventCode` of the event about which details are requested.
36
33
  team_number: 0 # Integer | Numeric `teamNumber` of the team from which the attending event listings are requested.
37
34
  }
@@ -47,11 +44,11 @@ end
47
44
 
48
45
  ### Parameters
49
46
 
50
- | Name | Type | Description | Notes |
51
- | ---- | ---- | ----------- | ----- |
52
- | **season** | **Integer** | Numeric year from which the event listings are requested. Must be 4 digits | |
53
- | **event_code** | **String** | Case insensitive alphanumeric `eventCode` of the event about which details are requested. | [optional][default to '0'] |
54
- | **team_number** | **Integer** | Numeric `teamNumber` of the team from which the attending event listings are requested. | [optional][default to 0] |
47
+ Name | Type | Description | Notes
48
+ ------------- | ------------- | ------------- | -------------
49
+ **season** | **Integer**| Numeric year from which the event listings are requested. Must be 4 digits |
50
+ **event_code** | **String**| Case insensitive alphanumeric `eventCode` of the event about which details are requested. | [optional] [default to 0]
51
+ **team_number** | **Integer**| Numeric `teamNumber` of the team from which the attending event listings are requested. | [optional] [default to 0]
55
52
 
56
53
  ### Return type
57
54
 
@@ -63,12 +60,12 @@ 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
68
65
 
69
66
 
70
- ## v20_season_get
71
67
 
68
+ # **v20_season_get**
72
69
  > SeasonSummaryModelVersion2 v20_season_get(season)
73
70
 
74
71
  Season Summary
@@ -76,7 +73,6 @@ Season Summary
76
73
  The season summary API returns a high level glance of a particular FTC season.
77
74
 
78
75
  ### Example
79
-
80
76
  ```ruby
81
77
  # load the gem
82
78
  require 'ftc_events_client'
@@ -90,6 +86,7 @@ end
90
86
  api_instance = FtcEventsClient::SeasonDataApi.new
91
87
  season = 56 # Integer | Numeric year of the event from which the season summary is requested. Must be 4 digits.
92
88
 
89
+
93
90
  begin
94
91
  #Season Summary
95
92
  result = api_instance.v20_season_get(season)
@@ -101,9 +98,9 @@ end
101
98
 
102
99
  ### Parameters
103
100
 
104
- | Name | Type | Description | Notes |
105
- | ---- | ---- | ----------- | ----- |
106
- | **season** | **Integer** | Numeric year of the event from which the season summary is requested. Must be 4 digits. | |
101
+ Name | Type | Description | Notes
102
+ ------------- | ------------- | ------------- | -------------
103
+ **season** | **Integer**| Numeric year of the event from which the season summary is requested. Must be 4 digits. |
107
104
 
108
105
  ### Return type
109
106
 
@@ -115,12 +112,12 @@ end
115
112
 
116
113
  ### HTTP request headers
117
114
 
118
- - **Content-Type**: Not defined
119
- - **Accept**: application/json
115
+ - **Content-Type**: Not defined
116
+ - **Accept**: application/json
120
117
 
121
118
 
122
- ## v20_season_teams_get
123
119
 
120
+ # **v20_season_teams_get**
124
121
  > SeasonTeamListingsModelVersion2 v20_season_teams_get(season, opts)
125
122
 
126
123
  Team Listings
@@ -128,7 +125,6 @@ Team Listings
128
125
  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.
129
126
 
130
127
  ### Example
131
-
132
128
  ```ruby
133
129
  # load the gem
134
130
  require 'ftc_events_client'
@@ -141,7 +137,7 @@ end
141
137
 
142
138
  api_instance = FtcEventsClient::SeasonDataApi.new
143
139
  season = 56 # Integer | Numeric year from which the team listings are requested. Must be 4 digits.
144
- opts = {
140
+ opts = {
145
141
  team_number: 0, # Integer | Numeric `teamNumber` of the team about which information is requested. Must be 1 to 5 digits.
146
142
  event_code: '0', # String | Case insensitive alphanumeric `eventCode` of the event from which details are requested.
147
143
  state: '', # String | Full legal name of the US state or international state/prov
@@ -159,13 +155,13 @@ end
159
155
 
160
156
  ### Parameters
161
157
 
162
- | Name | Type | Description | Notes |
163
- | ---- | ---- | ----------- | ----- |
164
- | **season** | **Integer** | Numeric year from which the team listings are requested. Must be 4 digits. | |
165
- | **team_number** | **Integer** | Numeric `teamNumber` of the team about which information is requested. Must be 1 to 5 digits. | [optional][default to 0] |
166
- | **event_code** | **String** | Case insensitive alphanumeric `eventCode` of the event from which details are requested. | [optional][default to '0'] |
167
- | **state** | **String** | Full legal name of the US state or international state/prov | [optional][default to ''] |
168
- | **page** | **Integer** | Numeric page of results to return. | [optional][default to 1] |
158
+ Name | Type | Description | Notes
159
+ ------------- | ------------- | ------------- | -------------
160
+ **season** | **Integer**| Numeric year from which the team listings are requested. Must be 4 digits. |
161
+ **team_number** | **Integer**| Numeric `teamNumber` of the team about which information is requested. Must be 1 to 5 digits. | [optional] [default to 0]
162
+ **event_code** | **String**| Case insensitive alphanumeric `eventCode` of the event from which details are requested. | [optional] [default to 0]
163
+ **state** | **String**| Full legal name of the US state or international state/prov | [optional]
164
+ **page** | **Integer**| Numeric page of results to return. | [optional] [default to 1]
169
165
 
170
166
  ### Return type
171
167
 
@@ -177,6 +173,8 @@ end
177
173
 
178
174
  ### HTTP request headers
179
175
 
180
- - **Content-Type**: Not defined
181
- - **Accept**: application/json
176
+ - **Content-Type**: Not defined
177
+ - **Accept**: application/json
178
+
179
+
182
180
 
@@ -1,20 +1,8 @@
1
1
  # FtcEventsClient::SeasonEventListingsModelVersion2
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **events** | [**Array<SeasonEventModelVersion2>**](SeasonEventModelVersion2.md) | | [optional] |
8
- | **event_count** | **Integer** | | [optional] |
9
-
10
- ## Code Sample
11
-
12
- ```ruby
13
- require 'ftc_events_client'
14
-
15
- instance = FtcEventsClient::SeasonEventListingsModelVersion2.new(
16
- events: null,
17
- event_count: null
18
- )
19
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **events** | [**Array<SeasonEventModelVersion2>**](SeasonEventModelVersion2.md) | | [optional]
7
+ **event_count** | **Integer** | | [optional]
20
8
 
@@ -1,50 +1,28 @@
1
1
  # FtcEventsClient::SeasonEventModelVersion2
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **code** | **String** | | [optional] |
8
- | **division_code** | **String** | | [optional] |
9
- | **name** | **String** | | [optional] |
10
- | **remote** | **Boolean** | | [optional] |
11
- | **published** | **Boolean** | | [optional] |
12
- | **type** | **String** | | [optional] |
13
- | **district_code** | **String** | | [optional] |
14
- | **venue** | **String** | | [optional] |
15
- | **address** | **String** | | [optional] |
16
- | **city** | **String** | | [optional] |
17
- | **stateprov** | **String** | | [optional] |
18
- | **country** | **String** | | [optional] |
19
- | **website** | **String** | | [optional] |
20
- | **webcasts** | **Array<String>** | | [optional] |
21
- | **timezone** | **String** | | [optional] |
22
- | **date_start** | **Time** | | [optional] |
23
- | **date_end** | **Time** | | [optional] |
24
-
25
- ## Code Sample
26
-
27
- ```ruby
28
- require 'ftc_events_client'
29
-
30
- instance = FtcEventsClient::SeasonEventModelVersion2.new(
31
- code: null,
32
- division_code: null,
33
- name: null,
34
- remote: null,
35
- published: null,
36
- type: null,
37
- district_code: null,
38
- venue: null,
39
- address: null,
40
- city: null,
41
- stateprov: null,
42
- country: null,
43
- website: null,
44
- webcasts: null,
45
- timezone: null,
46
- date_start: null,
47
- date_end: null
48
- )
49
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **code** | **String** | | [optional]
7
+ **division_code** | **String** | | [optional]
8
+ **name** | **String** | | [optional]
9
+ **remote** | **BOOLEAN** | | [optional]
10
+ **hybrid** | **BOOLEAN** | | [optional]
11
+ **field_count** | **Integer** | | [optional]
12
+ **published** | **BOOLEAN** | | [optional]
13
+ **type** | **String** | | [optional]
14
+ **type_name** | **String** | | [optional]
15
+ **region_code** | **String** | | [optional]
16
+ **league_code** | **String** | | [optional]
17
+ **district_code** | **String** | | [optional]
18
+ **venue** | **String** | | [optional]
19
+ **address** | **String** | | [optional]
20
+ **city** | **String** | | [optional]
21
+ **stateprov** | **String** | | [optional]
22
+ **country** | **String** | | [optional]
23
+ **website** | **String** | | [optional]
24
+ **webcasts** | **Array<String>** | | [optional]
25
+ **timezone** | **String** | | [optional]
26
+ **date_start** | **DateTime** | | [optional]
27
+ **date_end** | **DateTime** | | [optional]
50
28
 
@@ -0,0 +1,8 @@
1
+ # FtcEventsClient::SeasonLeagueListingsModelVersion2
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **leagues** | [**Array<SeasonLeagueModelVersion2>**](SeasonLeagueModelVersion2.md) | | [optional]
7
+ **league_count** | **Integer** | | [optional]
8
+
@@ -0,0 +1,11 @@
1
+ # FtcEventsClient::SeasonLeagueModelVersion2
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **region** | **String** | | [optional]
7
+ **code** | **String** | | [optional]
8
+ **name** | **String** | | [optional]
9
+ **parent_league_code** | **String** | | [optional]
10
+ **location** | **String** | | [optional]
11
+
@@ -1,22 +1,9 @@
1
1
  # FtcEventsClient::SeasonSummaryModelChampionship
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
- | **start_date** | **Time** | | [optional] |
9
- | **location** | **String** | | [optional] |
10
-
11
- ## Code Sample
12
-
13
- ```ruby
14
- require 'ftc_events_client'
15
-
16
- instance = FtcEventsClient::SeasonSummaryModelChampionship.new(
17
- name: null,
18
- start_date: null,
19
- location: null
20
- )
21
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | | [optional]
7
+ **start_date** | **DateTime** | | [optional]
8
+ **location** | **String** | | [optional]
22
9
 
@@ -1,28 +1,12 @@
1
1
  # FtcEventsClient::SeasonSummaryModelVersion2
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **event_count** | **Integer** | | [optional] |
8
- | **game_name** | **String** | | [optional] |
9
- | **kickoff** | **Time** | | [optional] |
10
- | **rookie_start** | **Integer** | | [optional] |
11
- | **team_count** | **Integer** | | [optional] |
12
- | **frc_championships** | [**Array<SeasonSummaryModelChampionship>**](SeasonSummaryModelChampionship.md) | | [optional] |
13
-
14
- ## Code Sample
15
-
16
- ```ruby
17
- require 'ftc_events_client'
18
-
19
- instance = FtcEventsClient::SeasonSummaryModelVersion2.new(
20
- event_count: null,
21
- game_name: null,
22
- kickoff: null,
23
- rookie_start: null,
24
- team_count: null,
25
- frc_championships: null
26
- )
27
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **event_count** | **Integer** | | [optional]
7
+ **game_name** | **String** | | [optional]
8
+ **kickoff** | **DateTime** | | [optional]
9
+ **rookie_start** | **Integer** | | [optional]
10
+ **team_count** | **Integer** | | [optional]
11
+ **frc_championships** | [**Array<SeasonSummaryModelChampionship>**](SeasonSummaryModelChampionship.md) | | [optional]
28
12
 
@@ -1,26 +1,11 @@
1
1
  # FtcEventsClient::SeasonTeamListingsModelVersion2
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **teams** | [**Array<SeasonTeamModelVersion2>**](SeasonTeamModelVersion2.md) | | [optional] |
8
- | **team_count_total** | **Integer** | | [optional] |
9
- | **team_count_page** | **Integer** | | [optional] |
10
- | **page_current** | **Integer** | | [optional] |
11
- | **page_total** | **Integer** | | [optional] |
12
-
13
- ## Code Sample
14
-
15
- ```ruby
16
- require 'ftc_events_client'
17
-
18
- instance = FtcEventsClient::SeasonTeamListingsModelVersion2.new(
19
- teams: null,
20
- team_count_total: null,
21
- team_count_page: null,
22
- page_current: null,
23
- page_total: null
24
- )
25
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **teams** | [**Array<SeasonTeamModelVersion2>**](SeasonTeamModelVersion2.md) | | [optional]
7
+ **team_count_total** | **Integer** | | [optional]
8
+ **team_count_page** | **Integer** | | [optional]
9
+ **page_current** | **Integer** | | [optional]
10
+ **page_total** | **Integer** | | [optional]
26
11