ftc_events_client 0.2.2 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +101 -5
- data/build.sh +0 -0
- data/config.json +1 -1
- data/docs/AdvancementApi.md +120 -0
- data/docs/AdvancementModel.md +9 -0
- data/docs/AdvancementSlot.md +13 -0
- data/docs/AdvancementSourceModel.md +10 -0
- data/docs/AllianceModelVersion2.md +3 -0
- data/docs/AllianceSelectionApi.md +56 -1
- data/docs/AllianceSelectionDetailModel.md +8 -0
- data/docs/ApiAdvancementStatus.md +6 -0
- data/docs/AutoNavigation.md +6 -0
- data/docs/AwardAssignmentModel.md +1 -0
- data/docs/AwardsApi.md +1 -1
- data/docs/Coordinate.md +12 -0
- data/docs/CoordinateEqualityComparer.md +6 -0
- data/docs/CoordinateSequence.md +17 -0
- data/docs/CoordinateSequenceFactory.md +7 -0
- data/docs/Dimension.md +6 -0
- data/docs/EndGameLocation.md +6 -0
- data/docs/Envelope.md +18 -0
- data/docs/FieldSide.md +6 -0
- data/docs/GeneralApi.md +1 -1
- data/docs/Geometry.md +30 -0
- data/docs/GeometryFactory.md +10 -0
- data/docs/GeometryOverlay.md +6 -0
- data/docs/JunctionElement.md +6 -0
- data/docs/LeaguesApi.md +1 -1
- data/docs/MatchResultsApi.md +1 -1
- data/docs/NtsGeometryServices.md +11 -0
- data/docs/OgcGeometryType.md +6 -0
- data/docs/Ordinates.md +6 -0
- data/docs/Point.md +35 -0
- data/docs/PrecisionModel.md +11 -0
- data/docs/PrecisionModels.md +6 -0
- data/docs/RankingsApi.md +1 -1
- data/docs/ScheduleApi.md +1 -1
- data/docs/ScheduleHybridModelTeamVersion2.md +2 -0
- data/docs/ScheduleHybridModelVersion2.md +2 -0
- data/docs/ScheduledMatchTeamModelVersion2.md +3 -0
- data/docs/ScoreDetailAllianceModel2022.md +42 -0
- data/docs/ScoreDetailAllianceModel2023.md +44 -0
- data/docs/ScoreDetailModel2021.md +1 -0
- data/docs/ScoreDetailModel2022.md +11 -0
- data/docs/ScoreDetailModel2023.md +11 -0
- data/docs/ScoreDetailModelSinglePlayer2021.md +1 -0
- data/docs/ScoreDetailModelSinglePlayer2022.md +11 -0
- data/docs/ScoreDetailModelSinglePlayer2023.md +11 -0
- data/docs/ScoreDetailSinglePlayer2022.md +35 -0
- data/docs/ScoreDetailSinglePlayer2023.md +36 -0
- data/docs/SeasonDataApi.md +1 -1
- data/docs/SeasonEventModelVersion2.md +3 -0
- data/docs/SeasonLeagueModelVersion2.md +2 -0
- data/docs/SeasonTeamModelVersion2.md +3 -0
- data/docs/SelectionModel.md +9 -0
- data/docs/SelectionResult.md +6 -0
- data/docs/TeamRankingModel.md +2 -0
- data/ftc_events_client.gemspec +1 -1
- data/git_push.sh +0 -0
- data/lib/ftc_events_client/api/advancement_api.rb +147 -0
- data/lib/ftc_events_client/api/alliance_selection_api.rb +63 -1
- data/lib/ftc_events_client/api/awards_api.rb +1 -1
- data/lib/ftc_events_client/api/general_api.rb +1 -1
- data/lib/ftc_events_client/api/leagues_api.rb +1 -1
- data/lib/ftc_events_client/api/match_results_api.rb +1 -1
- data/lib/ftc_events_client/api/rankings_api.rb +1 -1
- data/lib/ftc_events_client/api/schedule_api.rb +1 -1
- data/lib/ftc_events_client/api/season_data_api.rb +1 -1
- data/lib/ftc_events_client/api_client.rb +3 -13
- data/lib/ftc_events_client/api_error.rb +1 -1
- data/lib/ftc_events_client/configuration.rb +2 -2
- data/lib/ftc_events_client/models/advancement_model.rb +231 -0
- data/lib/ftc_events_client/models/advancement_slot.rb +269 -0
- data/lib/ftc_events_client/models/advancement_source_model.rb +242 -0
- data/lib/ftc_events_client/models/alliance_model_version2.rb +32 -2
- data/lib/ftc_events_client/models/alliance_score_2020.rb +1 -1
- data/lib/ftc_events_client/models/alliance_selection_detail_model.rb +218 -0
- data/lib/ftc_events_client/models/alliance_selection_model_version2.rb +1 -1
- data/lib/ftc_events_client/models/api_advancement_status.rb +31 -0
- data/lib/ftc_events_client/models/api_index_model.rb +1 -1
- data/lib/ftc_events_client/models/auto_navigated_status.rb +1 -1
- data/lib/ftc_events_client/models/auto_navigation.rb +29 -0
- data/lib/ftc_events_client/models/award_assignment_model.rb +12 -2
- data/lib/ftc_events_client/models/awards_model.rb +1 -1
- data/lib/ftc_events_client/models/barcode_element.rb +1 -1
- data/lib/ftc_events_client/models/coordinate.rb +251 -0
- data/lib/ftc_events_client/models/coordinate_equality_comparer.rb +197 -0
- data/lib/ftc_events_client/models/coordinate_sequence.rb +296 -0
- data/lib/ftc_events_client/models/coordinate_sequence_factory.rb +206 -0
- data/lib/ftc_events_client/models/dimension.rb +33 -0
- data/lib/ftc_events_client/models/end_game_location.rb +29 -0
- data/lib/ftc_events_client/models/endgame_parked_status.rb +1 -1
- data/lib/ftc_events_client/models/envelope.rb +305 -0
- data/lib/ftc_events_client/models/event_match_results_model_version2.rb +1 -1
- data/lib/ftc_events_client/models/event_rankings_model.rb +1 -1
- data/lib/ftc_events_client/models/event_schedule_hybrid_model_version2.rb +1 -1
- data/lib/ftc_events_client/models/event_schedule_model_version2.rb +1 -1
- data/lib/ftc_events_client/models/field_side.rb +28 -0
- data/lib/ftc_events_client/models/ftc_event_level.rb +1 -1
- data/lib/ftc_events_client/models/geometry.rb +418 -0
- data/lib/ftc_events_client/models/geometry_factory.rb +233 -0
- data/lib/ftc_events_client/models/geometry_overlay.rb +197 -0
- data/lib/ftc_events_client/models/junction_element.rb +32 -0
- data/lib/ftc_events_client/models/league_member_list_model.rb +1 -1
- data/lib/ftc_events_client/models/match_result_model_version2.rb +1 -1
- data/lib/ftc_events_client/models/match_result_team_model_version2.rb +1 -1
- data/lib/ftc_events_client/models/match_scores_model.rb +1 -1
- data/lib/ftc_events_client/models/nts_geometry_services.rb +242 -0
- data/lib/ftc_events_client/models/ogc_geometry_type.rb +42 -0
- data/lib/ftc_events_client/models/one_of_match_scores_model_match_scores_items.rb +1 -1
- data/lib/ftc_events_client/models/ordinates.rb +66 -0
- data/lib/ftc_events_client/models/point.rb +463 -0
- data/lib/ftc_events_client/models/precision_model.rb +242 -0
- data/lib/ftc_events_client/models/precision_models.rb +29 -0
- data/lib/ftc_events_client/models/schedule_hybrid_model_team_version2.rb +26 -6
- data/lib/ftc_events_client/models/schedule_hybrid_model_version2.rb +22 -2
- data/lib/ftc_events_client/models/scheduled_match_model_version2.rb +1 -1
- data/lib/ftc_events_client/models/scheduled_match_team_model_version2.rb +32 -2
- data/lib/ftc_events_client/models/score_detail_alliance_model_2020.rb +1 -1
- data/lib/ftc_events_client/models/score_detail_alliance_model_2021.rb +1 -1
- data/lib/ftc_events_client/models/score_detail_alliance_model_2022.rb +540 -0
- data/lib/ftc_events_client/models/score_detail_alliance_model_2023.rb +540 -0
- data/lib/ftc_events_client/models/score_detail_model_2019.rb +1 -1
- data/lib/ftc_events_client/models/score_detail_model_2020.rb +1 -1
- data/lib/ftc_events_client/models/score_detail_model_2021.rb +11 -2
- data/lib/ftc_events_client/models/score_detail_model_2022.rb +245 -0
- data/lib/ftc_events_client/models/score_detail_model_2023.rb +245 -0
- data/lib/ftc_events_client/models/score_detail_model_alliance_2019.rb +1 -1
- data/lib/ftc_events_client/models/score_detail_model_single_player_2020.rb +1 -1
- data/lib/ftc_events_client/models/score_detail_model_single_player_2021.rb +11 -2
- data/lib/ftc_events_client/models/score_detail_model_single_player_2022.rb +242 -0
- data/lib/ftc_events_client/models/score_detail_model_single_player_2023.rb +242 -0
- data/lib/ftc_events_client/models/score_detail_single_player_2021.rb +1 -1
- data/lib/ftc_events_client/models/score_detail_single_player_2022.rb +474 -0
- data/lib/ftc_events_client/models/score_detail_single_player_2023.rb +467 -0
- data/lib/ftc_events_client/models/season_award_listings_model.rb +1 -1
- data/lib/ftc_events_client/models/season_awards_model.rb +1 -1
- data/lib/ftc_events_client/models/season_event_listings_model_version2.rb +1 -1
- data/lib/ftc_events_client/models/season_event_model_version2.rb +30 -2
- data/lib/ftc_events_client/models/season_league_listings_model_version2.rb +1 -1
- data/lib/ftc_events_client/models/season_league_model_version2.rb +22 -2
- data/lib/ftc_events_client/models/season_summary_model_championship.rb +1 -1
- data/lib/ftc_events_client/models/season_summary_model_version2.rb +1 -1
- data/lib/ftc_events_client/models/season_team_listings_model_version2.rb +1 -1
- data/lib/ftc_events_client/models/season_team_model_version2.rb +36 -6
- data/lib/ftc_events_client/models/selection_model.rb +224 -0
- data/lib/ftc_events_client/models/selection_result.rb +29 -0
- data/lib/ftc_events_client/models/stone.rb +1 -1
- data/lib/ftc_events_client/models/team_ranking_model.rb +22 -2
- data/lib/ftc_events_client/version.rb +2 -2
- data/lib/ftc_events_client.rb +36 -1
- data/spec/api/advancement_api_spec.rb +61 -0
- data/spec/models/advancement_model_spec.rb +52 -0
- data/spec/models/advancement_slot_spec.rb +76 -0
- data/spec/models/advancement_source_model_spec.rb +58 -0
- data/spec/models/alliance_selection_detail_model_spec.rb +46 -0
- data/spec/models/api_advancement_status_spec.rb +34 -0
- data/spec/models/auto_navigation_spec.rb +34 -0
- data/spec/models/coordinate_equality_comparer_spec.rb +34 -0
- data/spec/models/coordinate_sequence_factory_spec.rb +40 -0
- data/spec/models/coordinate_sequence_spec.rb +100 -0
- data/spec/models/coordinate_spec.rb +70 -0
- data/spec/models/dimension_spec.rb +34 -0
- data/spec/models/end_game_location_spec.rb +34 -0
- data/spec/models/envelope_spec.rb +106 -0
- data/spec/models/field_side_spec.rb +34 -0
- data/spec/models/geometry_factory_spec.rb +58 -0
- data/spec/models/geometry_overlay_spec.rb +34 -0
- data/spec/models/geometry_spec.rb +178 -0
- data/spec/models/junction_element_spec.rb +34 -0
- data/spec/models/nts_geometry_services_spec.rb +64 -0
- data/spec/models/ogc_geometry_type_spec.rb +34 -0
- data/spec/models/ordinates_spec.rb +34 -0
- data/spec/models/point_spec.rb +208 -0
- data/spec/models/precision_model_spec.rb +64 -0
- data/spec/models/precision_models_spec.rb +34 -0
- data/spec/models/score_detail_alliance_model_2022_spec.rb +250 -0
- data/spec/models/score_detail_alliance_model_2023_spec.rb +262 -0
- data/spec/models/score_detail_model_2022_spec.rb +64 -0
- data/spec/models/score_detail_model_2023_spec.rb +64 -0
- data/spec/models/score_detail_model_single_player_2022_spec.rb +64 -0
- data/spec/models/score_detail_model_single_player_2023_spec.rb +64 -0
- data/spec/models/score_detail_single_player_2022_spec.rb +208 -0
- data/spec/models/score_detail_single_player_2023_spec.rb +214 -0
- data/spec/models/selection_model_spec.rb +52 -0
- data/spec/models/selection_result_spec.rb +34 -0
- metadata +144 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7d0a58052bbf8805ac0c78a57ad8ee027683dab1e82fdbd905c8e6235044b13c
|
|
4
|
+
data.tar.gz: d918c860dbab90a333356b3e4996045ade37d85e7c8ce574660001c382a34c14
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d437891051416c0f17d18cc0511686fd772c428774ffd0a4af95137c30136f40f71afa1b25d2a37ebbd40f5951d07393e3e29bed561d3a3df0fee098fcea82f2
|
|
7
|
+
data.tar.gz: a85a20f01cec2d2e84fc9379bb459a135614af286fcef929eef5e9306d7ab36cd88f0079fb7e268742721e5e044379e6ccad1921adcaa293b051a2b63ac13c46
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ FTC Events API is a service to return relevant information about the _FIRST_ Tec
|
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
8
8
|
|
|
9
9
|
- API version: v2.0
|
|
10
|
-
- Package version: 0.
|
|
10
|
+
- Package version: 0.3.0
|
|
11
11
|
- Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen
|
|
12
12
|
|
|
13
13
|
## Installation
|
|
@@ -23,15 +23,15 @@ gem build ftc_events_client.gemspec
|
|
|
23
23
|
Then either install the gem locally:
|
|
24
24
|
|
|
25
25
|
```shell
|
|
26
|
-
gem install ./ftc_events_client-0.
|
|
26
|
+
gem install ./ftc_events_client-0.3.0.gem
|
|
27
27
|
```
|
|
28
|
-
(for development, run `gem install --dev ./ftc_events_client-0.
|
|
28
|
+
(for development, run `gem install --dev ./ftc_events_client-0.3.0.gem` to install the development dependencies)
|
|
29
29
|
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
31
31
|
|
|
32
32
|
Finally add this to the Gemfile:
|
|
33
33
|
|
|
34
|
-
gem 'ftc_events_client', '~> 0.
|
|
34
|
+
gem 'ftc_events_client', '~> 0.3.0'
|
|
35
35
|
|
|
36
36
|
### Install from Git
|
|
37
37
|
|
|
@@ -60,6 +60,46 @@ FtcEventsClient.configure do |config|
|
|
|
60
60
|
config.password = 'YOUR PASSWORD'
|
|
61
61
|
end
|
|
62
62
|
|
|
63
|
+
api_instance = FtcEventsClient::AdvancementApi.new
|
|
64
|
+
season = 56 # Integer | Numeric year of the event from which the event advancement is requested. Must be 4 digits > 2022
|
|
65
|
+
event_code = 'event_code_example' # String | Case insensitive alphanumeric `eventCode` of the event from which the advancement results are requested. Must be at least 3 characters.
|
|
66
|
+
opts = {
|
|
67
|
+
exclude_skipped: true # BOOLEAN | `excludeSkipped=true` to exclude skipped advancement slots. Slots are skipped if no team meets the criteria, the team has already advanced, or the team was ineligible.
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
begin
|
|
71
|
+
#Event Advancement
|
|
72
|
+
result = api_instance.v20_season_advancement_event_code_get(season, event_code, opts)
|
|
73
|
+
p result
|
|
74
|
+
rescue FtcEventsClient::ApiError => e
|
|
75
|
+
puts "Exception when calling AdvancementApi->v20_season_advancement_event_code_get: #{e}"
|
|
76
|
+
end
|
|
77
|
+
# Setup authorization
|
|
78
|
+
FtcEventsClient.configure do |config|
|
|
79
|
+
# Configure HTTP basic authorization: basic
|
|
80
|
+
config.username = 'YOUR USERNAME'
|
|
81
|
+
config.password = 'YOUR PASSWORD'
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
api_instance = FtcEventsClient::AdvancementApi.new
|
|
85
|
+
season = 56 # Integer | Numeric year of the event from which the advancement is requested. Must be 4 digits >= 2022
|
|
86
|
+
event_code = 'event_code_example' # String | Case insensitive alphanumeric `eventCode` of the event for which teams advanced to. Must be at least 3 characters.
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
begin
|
|
90
|
+
#Advancement Source
|
|
91
|
+
result = api_instance.v20_season_advancement_event_code_source_get(season, event_code)
|
|
92
|
+
p result
|
|
93
|
+
rescue FtcEventsClient::ApiError => e
|
|
94
|
+
puts "Exception when calling AdvancementApi->v20_season_advancement_event_code_source_get: #{e}"
|
|
95
|
+
end
|
|
96
|
+
# Setup authorization
|
|
97
|
+
FtcEventsClient.configure do |config|
|
|
98
|
+
# Configure HTTP basic authorization: basic
|
|
99
|
+
config.username = 'YOUR USERNAME'
|
|
100
|
+
config.password = 'YOUR PASSWORD'
|
|
101
|
+
end
|
|
102
|
+
|
|
63
103
|
api_instance = FtcEventsClient::AllianceSelectionApi.new
|
|
64
104
|
season = 56 # Integer | Numeric year of the event from which the event alliances are requested. Must be 4 digits.
|
|
65
105
|
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.
|
|
@@ -79,6 +119,25 @@ FtcEventsClient.configure do |config|
|
|
|
79
119
|
config.password = 'YOUR PASSWORD'
|
|
80
120
|
end
|
|
81
121
|
|
|
122
|
+
api_instance = FtcEventsClient::AllianceSelectionApi.new
|
|
123
|
+
season = 56 # Integer | Numeric year of the event from which the event alliances are requested. Must be 4 digits.
|
|
124
|
+
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.
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
begin
|
|
128
|
+
#Alliance Selection Details
|
|
129
|
+
result = api_instance.v20_season_alliances_event_code_selection_get(season, event_code)
|
|
130
|
+
p result
|
|
131
|
+
rescue FtcEventsClient::ApiError => e
|
|
132
|
+
puts "Exception when calling AllianceSelectionApi->v20_season_alliances_event_code_selection_get: #{e}"
|
|
133
|
+
end
|
|
134
|
+
# Setup authorization
|
|
135
|
+
FtcEventsClient.configure do |config|
|
|
136
|
+
# Configure HTTP basic authorization: basic
|
|
137
|
+
config.username = 'YOUR USERNAME'
|
|
138
|
+
config.password = 'YOUR PASSWORD'
|
|
139
|
+
end
|
|
140
|
+
|
|
82
141
|
api_instance = FtcEventsClient::AwardsApi.new
|
|
83
142
|
season = 56 # Integer | Numeric year of the event from which the award listings are requested. Must be 4 digits
|
|
84
143
|
event_code = 'event_code_example' # String | Case insensitive alphanumeric `eventCode` of the event from which the awards are requested.
|
|
@@ -408,11 +467,14 @@ end
|
|
|
408
467
|
|
|
409
468
|
## Documentation for API Endpoints
|
|
410
469
|
|
|
411
|
-
All URIs are relative to *
|
|
470
|
+
All URIs are relative to *http://ftc-api.firstinspires.org*
|
|
412
471
|
|
|
413
472
|
Class | Method | HTTP request | Description
|
|
414
473
|
------------ | ------------- | ------------- | -------------
|
|
474
|
+
*FtcEventsClient::AdvancementApi* | [**v20_season_advancement_event_code_get**](docs/AdvancementApi.md#v20_season_advancement_event_code_get) | **GET** /v2.0/{season}/advancement/{eventCode} | Event Advancement
|
|
475
|
+
*FtcEventsClient::AdvancementApi* | [**v20_season_advancement_event_code_source_get**](docs/AdvancementApi.md#v20_season_advancement_event_code_source_get) | **GET** /v2.0/{season}/advancement/{eventCode}/source | Advancement Source
|
|
415
476
|
*FtcEventsClient::AllianceSelectionApi* | [**v20_season_alliances_event_code_get**](docs/AllianceSelectionApi.md#v20_season_alliances_event_code_get) | **GET** /v2.0/{season}/alliances/{eventCode} | Event Alliances
|
|
477
|
+
*FtcEventsClient::AllianceSelectionApi* | [**v20_season_alliances_event_code_selection_get**](docs/AllianceSelectionApi.md#v20_season_alliances_event_code_selection_get) | **GET** /v2.0/{season}/alliances/{eventCode}/selection | Alliance Selection Details
|
|
416
478
|
*FtcEventsClient::AwardsApi* | [**v20_season_awards_event_code_get**](docs/AwardsApi.md#v20_season_awards_event_code_get) | **GET** /v2.0/{season}/awards/{eventCode} | Event Awards
|
|
417
479
|
*FtcEventsClient::AwardsApi* | [**v20_season_awards_event_code_team_number_get**](docs/AwardsApi.md#v20_season_awards_event_code_team_number_get) | **GET** /v2.0/{season}/awards/{eventCode}/{teamNumber} | Event Awards
|
|
418
480
|
*FtcEventsClient::AwardsApi* | [**v20_season_awards_list_get**](docs/AwardsApi.md#v20_season_awards_list_get) | **GET** /v2.0/{season}/awards/list | Award Listings
|
|
@@ -432,38 +494,70 @@ Class | Method | HTTP request | Description
|
|
|
432
494
|
|
|
433
495
|
## Documentation for Models
|
|
434
496
|
|
|
497
|
+
- [FtcEventsClient::AdvancementModel](docs/AdvancementModel.md)
|
|
498
|
+
- [FtcEventsClient::AdvancementSlot](docs/AdvancementSlot.md)
|
|
499
|
+
- [FtcEventsClient::AdvancementSourceModel](docs/AdvancementSourceModel.md)
|
|
435
500
|
- [FtcEventsClient::AllianceModelVersion2](docs/AllianceModelVersion2.md)
|
|
436
501
|
- [FtcEventsClient::AllianceScore2020](docs/AllianceScore2020.md)
|
|
502
|
+
- [FtcEventsClient::AllianceSelectionDetailModel](docs/AllianceSelectionDetailModel.md)
|
|
437
503
|
- [FtcEventsClient::AllianceSelectionModelVersion2](docs/AllianceSelectionModelVersion2.md)
|
|
504
|
+
- [FtcEventsClient::ApiAdvancementStatus](docs/ApiAdvancementStatus.md)
|
|
438
505
|
- [FtcEventsClient::ApiIndexModel](docs/ApiIndexModel.md)
|
|
439
506
|
- [FtcEventsClient::AutoNavigatedStatus](docs/AutoNavigatedStatus.md)
|
|
507
|
+
- [FtcEventsClient::AutoNavigation](docs/AutoNavigation.md)
|
|
440
508
|
- [FtcEventsClient::AwardAssignmentModel](docs/AwardAssignmentModel.md)
|
|
441
509
|
- [FtcEventsClient::AwardsModel](docs/AwardsModel.md)
|
|
442
510
|
- [FtcEventsClient::BarcodeElement](docs/BarcodeElement.md)
|
|
511
|
+
- [FtcEventsClient::Coordinate](docs/Coordinate.md)
|
|
512
|
+
- [FtcEventsClient::CoordinateEqualityComparer](docs/CoordinateEqualityComparer.md)
|
|
513
|
+
- [FtcEventsClient::CoordinateSequence](docs/CoordinateSequence.md)
|
|
514
|
+
- [FtcEventsClient::CoordinateSequenceFactory](docs/CoordinateSequenceFactory.md)
|
|
515
|
+
- [FtcEventsClient::Dimension](docs/Dimension.md)
|
|
516
|
+
- [FtcEventsClient::EndGameLocation](docs/EndGameLocation.md)
|
|
443
517
|
- [FtcEventsClient::EndgameParkedStatus](docs/EndgameParkedStatus.md)
|
|
518
|
+
- [FtcEventsClient::Envelope](docs/Envelope.md)
|
|
444
519
|
- [FtcEventsClient::EventMatchResultsModelVersion2](docs/EventMatchResultsModelVersion2.md)
|
|
445
520
|
- [FtcEventsClient::EventRankingsModel](docs/EventRankingsModel.md)
|
|
446
521
|
- [FtcEventsClient::EventScheduleHybridModelVersion2](docs/EventScheduleHybridModelVersion2.md)
|
|
447
522
|
- [FtcEventsClient::EventScheduleModelVersion2](docs/EventScheduleModelVersion2.md)
|
|
448
523
|
- [FtcEventsClient::FTCEventLevel](docs/FTCEventLevel.md)
|
|
524
|
+
- [FtcEventsClient::FieldSide](docs/FieldSide.md)
|
|
525
|
+
- [FtcEventsClient::Geometry](docs/Geometry.md)
|
|
526
|
+
- [FtcEventsClient::GeometryFactory](docs/GeometryFactory.md)
|
|
527
|
+
- [FtcEventsClient::GeometryOverlay](docs/GeometryOverlay.md)
|
|
528
|
+
- [FtcEventsClient::JunctionElement](docs/JunctionElement.md)
|
|
449
529
|
- [FtcEventsClient::LeagueMemberListModel](docs/LeagueMemberListModel.md)
|
|
450
530
|
- [FtcEventsClient::MatchResultModelVersion2](docs/MatchResultModelVersion2.md)
|
|
451
531
|
- [FtcEventsClient::MatchResultTeamModelVersion2](docs/MatchResultTeamModelVersion2.md)
|
|
452
532
|
- [FtcEventsClient::MatchScoresModel](docs/MatchScoresModel.md)
|
|
533
|
+
- [FtcEventsClient::NtsGeometryServices](docs/NtsGeometryServices.md)
|
|
534
|
+
- [FtcEventsClient::OgcGeometryType](docs/OgcGeometryType.md)
|
|
453
535
|
- [FtcEventsClient::OneOfMatchScoresModelMatchScoresItems](docs/OneOfMatchScoresModelMatchScoresItems.md)
|
|
536
|
+
- [FtcEventsClient::Ordinates](docs/Ordinates.md)
|
|
537
|
+
- [FtcEventsClient::Point](docs/Point.md)
|
|
538
|
+
- [FtcEventsClient::PrecisionModel](docs/PrecisionModel.md)
|
|
539
|
+
- [FtcEventsClient::PrecisionModels](docs/PrecisionModels.md)
|
|
454
540
|
- [FtcEventsClient::ScheduleHybridModelTeamVersion2](docs/ScheduleHybridModelTeamVersion2.md)
|
|
455
541
|
- [FtcEventsClient::ScheduleHybridModelVersion2](docs/ScheduleHybridModelVersion2.md)
|
|
456
542
|
- [FtcEventsClient::ScheduledMatchModelVersion2](docs/ScheduledMatchModelVersion2.md)
|
|
457
543
|
- [FtcEventsClient::ScheduledMatchTeamModelVersion2](docs/ScheduledMatchTeamModelVersion2.md)
|
|
458
544
|
- [FtcEventsClient::ScoreDetailAllianceModel2020](docs/ScoreDetailAllianceModel2020.md)
|
|
459
545
|
- [FtcEventsClient::ScoreDetailAllianceModel2021](docs/ScoreDetailAllianceModel2021.md)
|
|
546
|
+
- [FtcEventsClient::ScoreDetailAllianceModel2022](docs/ScoreDetailAllianceModel2022.md)
|
|
547
|
+
- [FtcEventsClient::ScoreDetailAllianceModel2023](docs/ScoreDetailAllianceModel2023.md)
|
|
460
548
|
- [FtcEventsClient::ScoreDetailModel2019](docs/ScoreDetailModel2019.md)
|
|
461
549
|
- [FtcEventsClient::ScoreDetailModel2020](docs/ScoreDetailModel2020.md)
|
|
462
550
|
- [FtcEventsClient::ScoreDetailModel2021](docs/ScoreDetailModel2021.md)
|
|
551
|
+
- [FtcEventsClient::ScoreDetailModel2022](docs/ScoreDetailModel2022.md)
|
|
552
|
+
- [FtcEventsClient::ScoreDetailModel2023](docs/ScoreDetailModel2023.md)
|
|
463
553
|
- [FtcEventsClient::ScoreDetailModelAlliance2019](docs/ScoreDetailModelAlliance2019.md)
|
|
464
554
|
- [FtcEventsClient::ScoreDetailModelSinglePlayer2020](docs/ScoreDetailModelSinglePlayer2020.md)
|
|
465
555
|
- [FtcEventsClient::ScoreDetailModelSinglePlayer2021](docs/ScoreDetailModelSinglePlayer2021.md)
|
|
556
|
+
- [FtcEventsClient::ScoreDetailModelSinglePlayer2022](docs/ScoreDetailModelSinglePlayer2022.md)
|
|
557
|
+
- [FtcEventsClient::ScoreDetailModelSinglePlayer2023](docs/ScoreDetailModelSinglePlayer2023.md)
|
|
466
558
|
- [FtcEventsClient::ScoreDetailSinglePlayer2021](docs/ScoreDetailSinglePlayer2021.md)
|
|
559
|
+
- [FtcEventsClient::ScoreDetailSinglePlayer2022](docs/ScoreDetailSinglePlayer2022.md)
|
|
560
|
+
- [FtcEventsClient::ScoreDetailSinglePlayer2023](docs/ScoreDetailSinglePlayer2023.md)
|
|
467
561
|
- [FtcEventsClient::SeasonAwardListingsModel](docs/SeasonAwardListingsModel.md)
|
|
468
562
|
- [FtcEventsClient::SeasonAwardsModel](docs/SeasonAwardsModel.md)
|
|
469
563
|
- [FtcEventsClient::SeasonEventListingsModelVersion2](docs/SeasonEventListingsModelVersion2.md)
|
|
@@ -474,6 +568,8 @@ Class | Method | HTTP request | Description
|
|
|
474
568
|
- [FtcEventsClient::SeasonSummaryModelVersion2](docs/SeasonSummaryModelVersion2.md)
|
|
475
569
|
- [FtcEventsClient::SeasonTeamListingsModelVersion2](docs/SeasonTeamListingsModelVersion2.md)
|
|
476
570
|
- [FtcEventsClient::SeasonTeamModelVersion2](docs/SeasonTeamModelVersion2.md)
|
|
571
|
+
- [FtcEventsClient::SelectionModel](docs/SelectionModel.md)
|
|
572
|
+
- [FtcEventsClient::SelectionResult](docs/SelectionResult.md)
|
|
477
573
|
- [FtcEventsClient::Stone](docs/Stone.md)
|
|
478
574
|
- [FtcEventsClient::TeamRankingModel](docs/TeamRankingModel.md)
|
|
479
575
|
|
data/build.sh
ADDED
|
File without changes
|
data/config.json
CHANGED
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# FtcEventsClient::AdvancementApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://ftc-api.firstinspires.org*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**v20_season_advancement_event_code_get**](AdvancementApi.md#v20_season_advancement_event_code_get) | **GET** /v2.0/{season}/advancement/{eventCode} | Event Advancement
|
|
8
|
+
[**v20_season_advancement_event_code_source_get**](AdvancementApi.md#v20_season_advancement_event_code_source_get) | **GET** /v2.0/{season}/advancement/{eventCode}/source | Advancement Source
|
|
9
|
+
|
|
10
|
+
# **v20_season_advancement_event_code_get**
|
|
11
|
+
> AdvancementModel v20_season_advancement_event_code_get(season, event_code, opts)
|
|
12
|
+
|
|
13
|
+
Event Advancement
|
|
14
|
+
|
|
15
|
+
The event advancement endpoint returns details about teams advancing from a particular event in a particular season.
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
```ruby
|
|
19
|
+
# load the gem
|
|
20
|
+
require 'ftc_events_client'
|
|
21
|
+
# setup authorization
|
|
22
|
+
FtcEventsClient.configure do |config|
|
|
23
|
+
# Configure HTTP basic authorization: basic
|
|
24
|
+
config.username = 'YOUR USERNAME'
|
|
25
|
+
config.password = 'YOUR PASSWORD'
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
api_instance = FtcEventsClient::AdvancementApi.new
|
|
29
|
+
season = 56 # Integer | Numeric year of the event from which the event advancement is requested. Must be 4 digits > 2022
|
|
30
|
+
event_code = 'event_code_example' # String | Case insensitive alphanumeric `eventCode` of the event from which the advancement results are requested. Must be at least 3 characters.
|
|
31
|
+
opts = {
|
|
32
|
+
exclude_skipped: true # BOOLEAN | `excludeSkipped=true` to exclude skipped advancement slots. Slots are skipped if no team meets the criteria, the team has already advanced, or the team was ineligible.
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
begin
|
|
36
|
+
#Event Advancement
|
|
37
|
+
result = api_instance.v20_season_advancement_event_code_get(season, event_code, opts)
|
|
38
|
+
p result
|
|
39
|
+
rescue FtcEventsClient::ApiError => e
|
|
40
|
+
puts "Exception when calling AdvancementApi->v20_season_advancement_event_code_get: #{e}"
|
|
41
|
+
end
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Parameters
|
|
45
|
+
|
|
46
|
+
Name | Type | Description | Notes
|
|
47
|
+
------------- | ------------- | ------------- | -------------
|
|
48
|
+
**season** | **Integer**| Numeric year of the event from which the event advancement is requested. Must be 4 digits > 2022 |
|
|
49
|
+
**event_code** | **String**| Case insensitive alphanumeric `eventCode` of the event from which the advancement results are requested. Must be at least 3 characters. |
|
|
50
|
+
**exclude_skipped** | **BOOLEAN**| `excludeSkipped=true` to exclude skipped advancement slots. Slots are skipped if no team meets the criteria, the team has already advanced, or the team was ineligible. | [optional]
|
|
51
|
+
|
|
52
|
+
### Return type
|
|
53
|
+
|
|
54
|
+
[**AdvancementModel**](AdvancementModel.md)
|
|
55
|
+
|
|
56
|
+
### Authorization
|
|
57
|
+
|
|
58
|
+
[basic](../README.md#basic)
|
|
59
|
+
|
|
60
|
+
### HTTP request headers
|
|
61
|
+
|
|
62
|
+
- **Content-Type**: Not defined
|
|
63
|
+
- **Accept**: application/json
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
# **v20_season_advancement_event_code_source_get**
|
|
68
|
+
> Array<AdvancementSourceModel> v20_season_advancement_event_code_source_get(season, event_code)
|
|
69
|
+
|
|
70
|
+
Advancement Source
|
|
71
|
+
|
|
72
|
+
The advancement source API returns details about where teams advanced to a specified event from.
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
```ruby
|
|
76
|
+
# load the gem
|
|
77
|
+
require 'ftc_events_client'
|
|
78
|
+
# setup authorization
|
|
79
|
+
FtcEventsClient.configure do |config|
|
|
80
|
+
# Configure HTTP basic authorization: basic
|
|
81
|
+
config.username = 'YOUR USERNAME'
|
|
82
|
+
config.password = 'YOUR PASSWORD'
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
api_instance = FtcEventsClient::AdvancementApi.new
|
|
86
|
+
season = 56 # Integer | Numeric year of the event from which the advancement is requested. Must be 4 digits >= 2022
|
|
87
|
+
event_code = 'event_code_example' # String | Case insensitive alphanumeric `eventCode` of the event for which teams advanced to. Must be at least 3 characters.
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
begin
|
|
91
|
+
#Advancement Source
|
|
92
|
+
result = api_instance.v20_season_advancement_event_code_source_get(season, event_code)
|
|
93
|
+
p result
|
|
94
|
+
rescue FtcEventsClient::ApiError => e
|
|
95
|
+
puts "Exception when calling AdvancementApi->v20_season_advancement_event_code_source_get: #{e}"
|
|
96
|
+
end
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Parameters
|
|
100
|
+
|
|
101
|
+
Name | Type | Description | Notes
|
|
102
|
+
------------- | ------------- | ------------- | -------------
|
|
103
|
+
**season** | **Integer**| Numeric year of the event from which the advancement is requested. Must be 4 digits >= 2022 |
|
|
104
|
+
**event_code** | **String**| Case insensitive alphanumeric `eventCode` of the event for which teams advanced to. Must be at least 3 characters. |
|
|
105
|
+
|
|
106
|
+
### Return type
|
|
107
|
+
|
|
108
|
+
[**Array<AdvancementSourceModel>**](AdvancementSourceModel.md)
|
|
109
|
+
|
|
110
|
+
### Authorization
|
|
111
|
+
|
|
112
|
+
[basic](../README.md#basic)
|
|
113
|
+
|
|
114
|
+
### HTTP request headers
|
|
115
|
+
|
|
116
|
+
- **Content-Type**: Not defined
|
|
117
|
+
- **Accept**: application/json
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# FtcEventsClient::AdvancementModel
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**advances_to** | **String** | The event code of the event this event advanced to. | [optional]
|
|
7
|
+
**slots** | **Integer** | The number of teams that advanced. | [optional]
|
|
8
|
+
**advancement** | [**Array<AdvancementSlot>**](AdvancementSlot.md) | The ordered list of advancement criteria and teams that met them. Null if the event is unpublished. | [optional]
|
|
9
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# FtcEventsClient::AdvancementSlot
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**team** | **Integer** | The team number of the team earning this advancement slot. Null if no team meets the criteria. | [optional]
|
|
7
|
+
**team_id** | **Integer** | | [optional]
|
|
8
|
+
**team_profile_id** | **Integer** | | [optional]
|
|
9
|
+
**display_team** | **String** | The display-friendly string representation of the number of the team earning this advancement slot. Null if no team meets the criteria. | [optional]
|
|
10
|
+
**slot** | **Integer** | The number of the advancement criteria as shown in GM1 section 6.2. | [optional]
|
|
11
|
+
**criteria** | **String** | String describing the advancement criteria as shown in GM1 section 6.2. | [optional]
|
|
12
|
+
**status** | [**ApiAdvancementStatus**](ApiAdvancementStatus.md) | | [optional]
|
|
13
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# FtcEventsClient::AdvancementSourceModel
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**advanced_from** | **String** | The event code of the event this team advanced from. Null if unknown. | [optional]
|
|
7
|
+
**advanced_from_region** | **String** | The region code of the region this team advanced from. Null if target event is a region-level event. | [optional]
|
|
8
|
+
**slots** | **Integer** | The number of teams that advanced from the source event. | [optional]
|
|
9
|
+
**advancement** | [**Array<AdvancementSlot>**](AdvancementSlot.md) | The ordered list of advancement criteria and teams that met them. Null if the event is unpublished. | [optional]
|
|
10
|
+
|
|
@@ -6,8 +6,11 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**number** | **Integer** | | [optional]
|
|
7
7
|
**name** | **String** | | [optional]
|
|
8
8
|
**captain** | **Integer** | | [optional]
|
|
9
|
+
**captain_display** | **String** | | [optional]
|
|
9
10
|
**round1** | **Integer** | | [optional]
|
|
11
|
+
**round1_display** | **String** | | [optional]
|
|
10
12
|
**round2** | **Integer** | | [optional]
|
|
13
|
+
**round2_display** | **String** | | [optional]
|
|
11
14
|
**round3** | **Integer** | | [optional]
|
|
12
15
|
**backup** | **Integer** | | [optional]
|
|
13
16
|
**backup_replaced** | **Integer** | | [optional]
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# FtcEventsClient::AllianceSelectionApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *
|
|
3
|
+
All URIs are relative to *http://ftc-api.firstinspires.org*
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**v20_season_alliances_event_code_get**](AllianceSelectionApi.md#v20_season_alliances_event_code_get) | **GET** /v2.0/{season}/alliances/{eventCode} | Event Alliances
|
|
8
|
+
[**v20_season_alliances_event_code_selection_get**](AllianceSelectionApi.md#v20_season_alliances_event_code_selection_get) | **GET** /v2.0/{season}/alliances/{eventCode}/selection | Alliance Selection Details
|
|
8
9
|
|
|
9
10
|
# **v20_season_alliances_event_code_get**
|
|
10
11
|
> AllianceSelectionModelVersion2 v20_season_alliances_event_code_get(season, event_code)
|
|
@@ -60,3 +61,57 @@ Name | Type | Description | Notes
|
|
|
60
61
|
|
|
61
62
|
|
|
62
63
|
|
|
64
|
+
# **v20_season_alliances_event_code_selection_get**
|
|
65
|
+
> AllianceSelectionDetailModel v20_season_alliances_event_code_selection_get(season, event_code)
|
|
66
|
+
|
|
67
|
+
Alliance Selection Details
|
|
68
|
+
|
|
69
|
+
This returns the in-order details of each step through the alliance selection process for a particular event.
|
|
70
|
+
|
|
71
|
+
### Example
|
|
72
|
+
```ruby
|
|
73
|
+
# load the gem
|
|
74
|
+
require 'ftc_events_client'
|
|
75
|
+
# setup authorization
|
|
76
|
+
FtcEventsClient.configure do |config|
|
|
77
|
+
# Configure HTTP basic authorization: basic
|
|
78
|
+
config.username = 'YOUR USERNAME'
|
|
79
|
+
config.password = 'YOUR PASSWORD'
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
api_instance = FtcEventsClient::AllianceSelectionApi.new
|
|
83
|
+
season = 56 # Integer | Numeric year of the event from which the event alliances are requested. Must be 4 digits.
|
|
84
|
+
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.
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
begin
|
|
88
|
+
#Alliance Selection Details
|
|
89
|
+
result = api_instance.v20_season_alliances_event_code_selection_get(season, event_code)
|
|
90
|
+
p result
|
|
91
|
+
rescue FtcEventsClient::ApiError => e
|
|
92
|
+
puts "Exception when calling AllianceSelectionApi->v20_season_alliances_event_code_selection_get: #{e}"
|
|
93
|
+
end
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
Name | Type | Description | Notes
|
|
99
|
+
------------- | ------------- | ------------- | -------------
|
|
100
|
+
**season** | **Integer**| Numeric year of the event from which the event alliances are requested. Must be 4 digits. |
|
|
101
|
+
**event_code** | **String**| Case insensitive alphanumeric `eventCode` of the event from which the alliance selection results are requested. Must be at least 3 characters. |
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
[**AllianceSelectionDetailModel**](AllianceSelectionDetailModel.md)
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
[basic](../README.md#basic)
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: Not defined
|
|
114
|
+
- **Accept**: application/json
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# FtcEventsClient::AllianceSelectionDetailModel
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**selections** | [**Array<SelectionModel>**](SelectionModel.md) | | [optional]
|
|
7
|
+
**count** | **Integer** | | [optional]
|
|
8
|
+
|
|
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**award_id** | **Integer** | | [optional]
|
|
7
7
|
**team_id** | **Integer** | | [optional]
|
|
8
|
+
**team_profile_id** | **Integer** | | [optional]
|
|
8
9
|
**event_id** | **Integer** | | [optional]
|
|
9
10
|
**event_division_id** | **Integer** | | [optional]
|
|
10
11
|
**event_code** | **String** | | [optional]
|
data/docs/AwardsApi.md
CHANGED
data/docs/Coordinate.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# FtcEventsClient::Coordinate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**x** | **Float** | | [optional]
|
|
7
|
+
**y** | **Float** | | [optional]
|
|
8
|
+
**z** | **Float** | | [optional]
|
|
9
|
+
**m** | **Float** | | [optional]
|
|
10
|
+
**coordinate_value** | [**Coordinate**](Coordinate.md) | | [optional]
|
|
11
|
+
**is_valid** | **BOOLEAN** | | [optional]
|
|
12
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# FtcEventsClient::CoordinateSequence
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**dimension** | **Integer** | | [optional]
|
|
7
|
+
**measures** | **Integer** | | [optional]
|
|
8
|
+
**spatial** | **Integer** | | [optional]
|
|
9
|
+
**ordinates** | [**Ordinates**](Ordinates.md) | | [optional]
|
|
10
|
+
**has_z** | **BOOLEAN** | | [optional]
|
|
11
|
+
**has_m** | **BOOLEAN** | | [optional]
|
|
12
|
+
**z_ordinate_index** | **Integer** | | [optional]
|
|
13
|
+
**m_ordinate_index** | **Integer** | | [optional]
|
|
14
|
+
**first** | [**Coordinate**](Coordinate.md) | | [optional]
|
|
15
|
+
**last** | [**Coordinate**](Coordinate.md) | | [optional]
|
|
16
|
+
**count** | **Integer** | | [optional]
|
|
17
|
+
|
data/docs/Dimension.md
ADDED
data/docs/Envelope.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# FtcEventsClient::Envelope
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**is_null** | **BOOLEAN** | | [optional]
|
|
7
|
+
**width** | **Float** | | [optional]
|
|
8
|
+
**height** | **Float** | | [optional]
|
|
9
|
+
**diameter** | **Float** | | [optional]
|
|
10
|
+
**min_x** | **Float** | | [optional]
|
|
11
|
+
**max_x** | **Float** | | [optional]
|
|
12
|
+
**min_y** | **Float** | | [optional]
|
|
13
|
+
**max_y** | **Float** | | [optional]
|
|
14
|
+
**area** | **Float** | | [optional]
|
|
15
|
+
**min_extent** | **Float** | | [optional]
|
|
16
|
+
**max_extent** | **Float** | | [optional]
|
|
17
|
+
**centre** | [**Coordinate**](Coordinate.md) | | [optional]
|
|
18
|
+
|
data/docs/FieldSide.md
ADDED
data/docs/GeneralApi.md
CHANGED
data/docs/Geometry.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# FtcEventsClient::Geometry
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**factory** | [**GeometryFactory**](GeometryFactory.md) | | [optional]
|
|
7
|
+
**user_data** | [****](.md) | | [optional]
|
|
8
|
+
**srid** | **Integer** | | [optional]
|
|
9
|
+
**geometry_type** | **String** | | [optional]
|
|
10
|
+
**ogc_geometry_type** | [**OgcGeometryType**](OgcGeometryType.md) | | [optional]
|
|
11
|
+
**precision_model** | [**PrecisionModel**](PrecisionModel.md) | | [optional]
|
|
12
|
+
**coordinate** | [**Coordinate**](Coordinate.md) | | [optional]
|
|
13
|
+
**coordinates** | [**Array<Coordinate>**](Coordinate.md) | | [optional]
|
|
14
|
+
**num_points** | **Integer** | | [optional]
|
|
15
|
+
**num_geometries** | **Integer** | | [optional]
|
|
16
|
+
**is_simple** | **BOOLEAN** | | [optional]
|
|
17
|
+
**is_valid** | **BOOLEAN** | | [optional]
|
|
18
|
+
**is_empty** | **BOOLEAN** | | [optional]
|
|
19
|
+
**area** | **Float** | | [optional]
|
|
20
|
+
**length** | **Float** | | [optional]
|
|
21
|
+
**centroid** | [**Point**](Point.md) | | [optional]
|
|
22
|
+
**interior_point** | [**Point**](Point.md) | | [optional]
|
|
23
|
+
**point_on_surface** | [**Point**](Point.md) | | [optional]
|
|
24
|
+
**dimension** | [**Dimension**](Dimension.md) | | [optional]
|
|
25
|
+
**boundary** | [**Geometry**](Geometry.md) | | [optional]
|
|
26
|
+
**boundary_dimension** | [**Dimension**](Dimension.md) | | [optional]
|
|
27
|
+
**envelope** | [**Geometry**](Geometry.md) | | [optional]
|
|
28
|
+
**envelope_internal** | [**Envelope**](Envelope.md) | | [optional]
|
|
29
|
+
**is_rectangle** | **BOOLEAN** | | [optional]
|
|
30
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# FtcEventsClient::GeometryFactory
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**precision_model** | [**PrecisionModel**](PrecisionModel.md) | | [optional]
|
|
7
|
+
**coordinate_sequence_factory** | [**CoordinateSequenceFactory**](CoordinateSequenceFactory.md) | | [optional]
|
|
8
|
+
**srid** | **Integer** | | [optional]
|
|
9
|
+
**geometry_services** | [**NtsGeometryServices**](NtsGeometryServices.md) | | [optional]
|
|
10
|
+
|