ftc_events_client 0.2.2 → 0.3.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (190) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +101 -5
  3. data/build.sh +0 -0
  4. data/config.json +1 -1
  5. data/docs/AdvancementApi.md +120 -0
  6. data/docs/AdvancementModel.md +9 -0
  7. data/docs/AdvancementSlot.md +13 -0
  8. data/docs/AdvancementSourceModel.md +10 -0
  9. data/docs/AllianceModelVersion2.md +3 -0
  10. data/docs/AllianceSelectionApi.md +56 -1
  11. data/docs/AllianceSelectionDetailModel.md +8 -0
  12. data/docs/ApiAdvancementStatus.md +6 -0
  13. data/docs/AutoNavigation.md +6 -0
  14. data/docs/AwardAssignmentModel.md +1 -0
  15. data/docs/AwardsApi.md +1 -1
  16. data/docs/Coordinate.md +12 -0
  17. data/docs/CoordinateEqualityComparer.md +6 -0
  18. data/docs/CoordinateSequence.md +17 -0
  19. data/docs/CoordinateSequenceFactory.md +7 -0
  20. data/docs/Dimension.md +6 -0
  21. data/docs/EndGameLocation.md +6 -0
  22. data/docs/Envelope.md +18 -0
  23. data/docs/FieldSide.md +6 -0
  24. data/docs/GeneralApi.md +1 -1
  25. data/docs/Geometry.md +30 -0
  26. data/docs/GeometryFactory.md +10 -0
  27. data/docs/GeometryOverlay.md +6 -0
  28. data/docs/JunctionElement.md +6 -0
  29. data/docs/LeaguesApi.md +1 -1
  30. data/docs/MatchResultsApi.md +1 -1
  31. data/docs/NtsGeometryServices.md +11 -0
  32. data/docs/OgcGeometryType.md +6 -0
  33. data/docs/Ordinates.md +6 -0
  34. data/docs/Point.md +35 -0
  35. data/docs/PrecisionModel.md +11 -0
  36. data/docs/PrecisionModels.md +6 -0
  37. data/docs/RankingsApi.md +1 -1
  38. data/docs/ScheduleApi.md +1 -1
  39. data/docs/ScheduleHybridModelTeamVersion2.md +2 -0
  40. data/docs/ScheduleHybridModelVersion2.md +2 -0
  41. data/docs/ScheduledMatchTeamModelVersion2.md +3 -0
  42. data/docs/ScoreDetailAllianceModel2022.md +42 -0
  43. data/docs/ScoreDetailAllianceModel2023.md +44 -0
  44. data/docs/ScoreDetailModel2021.md +1 -0
  45. data/docs/ScoreDetailModel2022.md +11 -0
  46. data/docs/ScoreDetailModel2023.md +11 -0
  47. data/docs/ScoreDetailModelSinglePlayer2021.md +1 -0
  48. data/docs/ScoreDetailModelSinglePlayer2022.md +11 -0
  49. data/docs/ScoreDetailModelSinglePlayer2023.md +11 -0
  50. data/docs/ScoreDetailSinglePlayer2022.md +35 -0
  51. data/docs/ScoreDetailSinglePlayer2023.md +36 -0
  52. data/docs/SeasonDataApi.md +1 -1
  53. data/docs/SeasonEventModelVersion2.md +3 -0
  54. data/docs/SeasonLeagueModelVersion2.md +2 -0
  55. data/docs/SeasonTeamModelVersion2.md +3 -0
  56. data/docs/SelectionModel.md +9 -0
  57. data/docs/SelectionResult.md +6 -0
  58. data/docs/TeamRankingModel.md +2 -0
  59. data/ftc_events_client-0.3.0.gem +0 -0
  60. data/ftc_events_client.gemspec +1 -1
  61. data/git_push.sh +0 -0
  62. data/lib/ftc_events_client/api/advancement_api.rb +147 -0
  63. data/lib/ftc_events_client/api/alliance_selection_api.rb +63 -1
  64. data/lib/ftc_events_client/api/awards_api.rb +1 -1
  65. data/lib/ftc_events_client/api/general_api.rb +1 -1
  66. data/lib/ftc_events_client/api/leagues_api.rb +1 -1
  67. data/lib/ftc_events_client/api/match_results_api.rb +1 -1
  68. data/lib/ftc_events_client/api/rankings_api.rb +1 -1
  69. data/lib/ftc_events_client/api/schedule_api.rb +1 -1
  70. data/lib/ftc_events_client/api/season_data_api.rb +1 -1
  71. data/lib/ftc_events_client/api_client.rb +3 -13
  72. data/lib/ftc_events_client/api_error.rb +1 -1
  73. data/lib/ftc_events_client/configuration.rb +3 -3
  74. data/lib/ftc_events_client/models/advancement_model.rb +231 -0
  75. data/lib/ftc_events_client/models/advancement_slot.rb +269 -0
  76. data/lib/ftc_events_client/models/advancement_source_model.rb +242 -0
  77. data/lib/ftc_events_client/models/alliance_model_version2.rb +32 -2
  78. data/lib/ftc_events_client/models/alliance_score_2020.rb +1 -1
  79. data/lib/ftc_events_client/models/alliance_selection_detail_model.rb +218 -0
  80. data/lib/ftc_events_client/models/alliance_selection_model_version2.rb +1 -1
  81. data/lib/ftc_events_client/models/api_advancement_status.rb +31 -0
  82. data/lib/ftc_events_client/models/api_index_model.rb +1 -1
  83. data/lib/ftc_events_client/models/auto_navigated_status.rb +1 -1
  84. data/lib/ftc_events_client/models/auto_navigation.rb +29 -0
  85. data/lib/ftc_events_client/models/award_assignment_model.rb +12 -2
  86. data/lib/ftc_events_client/models/awards_model.rb +1 -1
  87. data/lib/ftc_events_client/models/barcode_element.rb +1 -1
  88. data/lib/ftc_events_client/models/coordinate.rb +251 -0
  89. data/lib/ftc_events_client/models/coordinate_equality_comparer.rb +197 -0
  90. data/lib/ftc_events_client/models/coordinate_sequence.rb +296 -0
  91. data/lib/ftc_events_client/models/coordinate_sequence_factory.rb +206 -0
  92. data/lib/ftc_events_client/models/dimension.rb +33 -0
  93. data/lib/ftc_events_client/models/end_game_location.rb +29 -0
  94. data/lib/ftc_events_client/models/endgame_parked_status.rb +1 -1
  95. data/lib/ftc_events_client/models/envelope.rb +305 -0
  96. data/lib/ftc_events_client/models/event_match_results_model_version2.rb +1 -1
  97. data/lib/ftc_events_client/models/event_rankings_model.rb +1 -1
  98. data/lib/ftc_events_client/models/event_schedule_hybrid_model_version2.rb +1 -1
  99. data/lib/ftc_events_client/models/event_schedule_model_version2.rb +1 -1
  100. data/lib/ftc_events_client/models/field_side.rb +28 -0
  101. data/lib/ftc_events_client/models/ftc_event_level.rb +1 -1
  102. data/lib/ftc_events_client/models/geometry.rb +418 -0
  103. data/lib/ftc_events_client/models/geometry_factory.rb +233 -0
  104. data/lib/ftc_events_client/models/geometry_overlay.rb +197 -0
  105. data/lib/ftc_events_client/models/junction_element.rb +32 -0
  106. data/lib/ftc_events_client/models/league_member_list_model.rb +1 -1
  107. data/lib/ftc_events_client/models/match_result_model_version2.rb +1 -1
  108. data/lib/ftc_events_client/models/match_result_team_model_version2.rb +1 -1
  109. data/lib/ftc_events_client/models/match_scores_model.rb +1 -1
  110. data/lib/ftc_events_client/models/nts_geometry_services.rb +242 -0
  111. data/lib/ftc_events_client/models/ogc_geometry_type.rb +42 -0
  112. data/lib/ftc_events_client/models/one_of_match_scores_model_match_scores_items.rb +1 -1
  113. data/lib/ftc_events_client/models/ordinates.rb +66 -0
  114. data/lib/ftc_events_client/models/point.rb +463 -0
  115. data/lib/ftc_events_client/models/precision_model.rb +242 -0
  116. data/lib/ftc_events_client/models/precision_models.rb +29 -0
  117. data/lib/ftc_events_client/models/schedule_hybrid_model_team_version2.rb +26 -6
  118. data/lib/ftc_events_client/models/schedule_hybrid_model_version2.rb +22 -2
  119. data/lib/ftc_events_client/models/scheduled_match_model_version2.rb +1 -1
  120. data/lib/ftc_events_client/models/scheduled_match_team_model_version2.rb +32 -2
  121. data/lib/ftc_events_client/models/score_detail_alliance_model_2020.rb +1 -1
  122. data/lib/ftc_events_client/models/score_detail_alliance_model_2021.rb +1 -1
  123. data/lib/ftc_events_client/models/score_detail_alliance_model_2022.rb +540 -0
  124. data/lib/ftc_events_client/models/score_detail_alliance_model_2023.rb +540 -0
  125. data/lib/ftc_events_client/models/score_detail_model_2019.rb +1 -1
  126. data/lib/ftc_events_client/models/score_detail_model_2020.rb +1 -1
  127. data/lib/ftc_events_client/models/score_detail_model_2021.rb +11 -2
  128. data/lib/ftc_events_client/models/score_detail_model_2022.rb +245 -0
  129. data/lib/ftc_events_client/models/score_detail_model_2023.rb +245 -0
  130. data/lib/ftc_events_client/models/score_detail_model_alliance_2019.rb +1 -1
  131. data/lib/ftc_events_client/models/score_detail_model_single_player_2020.rb +1 -1
  132. data/lib/ftc_events_client/models/score_detail_model_single_player_2021.rb +11 -2
  133. data/lib/ftc_events_client/models/score_detail_model_single_player_2022.rb +242 -0
  134. data/lib/ftc_events_client/models/score_detail_model_single_player_2023.rb +242 -0
  135. data/lib/ftc_events_client/models/score_detail_single_player_2021.rb +1 -1
  136. data/lib/ftc_events_client/models/score_detail_single_player_2022.rb +474 -0
  137. data/lib/ftc_events_client/models/score_detail_single_player_2023.rb +467 -0
  138. data/lib/ftc_events_client/models/season_award_listings_model.rb +1 -1
  139. data/lib/ftc_events_client/models/season_awards_model.rb +1 -1
  140. data/lib/ftc_events_client/models/season_event_listings_model_version2.rb +1 -1
  141. data/lib/ftc_events_client/models/season_event_model_version2.rb +30 -2
  142. data/lib/ftc_events_client/models/season_league_listings_model_version2.rb +1 -1
  143. data/lib/ftc_events_client/models/season_league_model_version2.rb +22 -2
  144. data/lib/ftc_events_client/models/season_summary_model_championship.rb +1 -1
  145. data/lib/ftc_events_client/models/season_summary_model_version2.rb +1 -1
  146. data/lib/ftc_events_client/models/season_team_listings_model_version2.rb +1 -1
  147. data/lib/ftc_events_client/models/season_team_model_version2.rb +36 -6
  148. data/lib/ftc_events_client/models/selection_model.rb +224 -0
  149. data/lib/ftc_events_client/models/selection_result.rb +29 -0
  150. data/lib/ftc_events_client/models/stone.rb +1 -1
  151. data/lib/ftc_events_client/models/team_ranking_model.rb +22 -2
  152. data/lib/ftc_events_client/version.rb +2 -2
  153. data/lib/ftc_events_client.rb +36 -1
  154. data/spec/api/advancement_api_spec.rb +61 -0
  155. data/spec/models/advancement_model_spec.rb +52 -0
  156. data/spec/models/advancement_slot_spec.rb +76 -0
  157. data/spec/models/advancement_source_model_spec.rb +58 -0
  158. data/spec/models/alliance_selection_detail_model_spec.rb +46 -0
  159. data/spec/models/api_advancement_status_spec.rb +34 -0
  160. data/spec/models/auto_navigation_spec.rb +34 -0
  161. data/spec/models/coordinate_equality_comparer_spec.rb +34 -0
  162. data/spec/models/coordinate_sequence_factory_spec.rb +40 -0
  163. data/spec/models/coordinate_sequence_spec.rb +100 -0
  164. data/spec/models/coordinate_spec.rb +70 -0
  165. data/spec/models/dimension_spec.rb +34 -0
  166. data/spec/models/end_game_location_spec.rb +34 -0
  167. data/spec/models/envelope_spec.rb +106 -0
  168. data/spec/models/field_side_spec.rb +34 -0
  169. data/spec/models/geometry_factory_spec.rb +58 -0
  170. data/spec/models/geometry_overlay_spec.rb +34 -0
  171. data/spec/models/geometry_spec.rb +178 -0
  172. data/spec/models/junction_element_spec.rb +34 -0
  173. data/spec/models/nts_geometry_services_spec.rb +64 -0
  174. data/spec/models/ogc_geometry_type_spec.rb +34 -0
  175. data/spec/models/ordinates_spec.rb +34 -0
  176. data/spec/models/point_spec.rb +208 -0
  177. data/spec/models/precision_model_spec.rb +64 -0
  178. data/spec/models/precision_models_spec.rb +34 -0
  179. data/spec/models/score_detail_alliance_model_2022_spec.rb +250 -0
  180. data/spec/models/score_detail_alliance_model_2023_spec.rb +262 -0
  181. data/spec/models/score_detail_model_2022_spec.rb +64 -0
  182. data/spec/models/score_detail_model_2023_spec.rb +64 -0
  183. data/spec/models/score_detail_model_single_player_2022_spec.rb +64 -0
  184. data/spec/models/score_detail_model_single_player_2023_spec.rb +64 -0
  185. data/spec/models/score_detail_single_player_2022_spec.rb +208 -0
  186. data/spec/models/score_detail_single_player_2023_spec.rb +214 -0
  187. data/spec/models/selection_model_spec.rb +52 -0
  188. data/spec/models/selection_result_spec.rb +34 -0
  189. data/update.sh +1 -1
  190. metadata +145 -3
@@ -0,0 +1,66 @@
1
+ =begin
2
+ #FTC Events API
3
+
4
+ #FTC Events API is a service to return relevant information about the _FIRST_ Tech Challenge (FTC). Information is made available from events operating around the world Information is currently made available after the conclusion of the tournament. The API will provide data as soon as it has synced, and we do not add any artificial delays. ## Documentation Notes ### Timezones All times are listed in the local time to the event venue. HTTP-date values will show their timezone. ### Query Parameters If you specify a parameter, but no value for that parameter, it will be ignored. For example, if you request `URL?teamNumber=` the `teamNumber` parameter would be ignored. For all APIs that accept a query string in addition to the base URI, the order of parameters do not matter, but the name shown in the documentation must match exactly, as does the associated value format as described in details. For response codes that are not HTTP 200 (OK), the documentation will show a body message that represents a possible response value. While the \"title\" of the HTTP Status Code will match those shown in the response codes documentation section exactly, the body of the response will be a more detailed explanation of why that status code is being returned and may not always be exactly as shown in the examples. ### Experimenting with the API This documentation is rendered at both [api-docs](https://ftc-events.firstinspires.org/api-docs) and [try-it-out](https://ftc-events.firstinspires.org/try-it-out). [api-docs](https://ftc-events.firstinspires.org/api-docs) has a three panel, easy to read layout, while [try-it-out](https://ftc-events.firstinspires.org/try-it-out) has a feature that allows you try out endpoints from within the page. Additionally, the Open API Json is availabe at [Open API](https://ftc-events.firstinspires.org/swagger/v2.0/swagger.json). This can be imported into a tool such as [Postman](https://www.postman.com) for experimentation as well. ### Last-Modified, FMS-OnlyModifiedSince, and If-Modified-Since Headers The FTC Events API utilizes the `Last-Modified` and `If-Modified-Since` Headers to communicate with consumers regarding the age of the data they are requesting. With a couple of exceptions, all calls will return a `Last-Modified` Header set with the time at which the data at that endpoint was last modified. The Header will always be set in the HTTP-date format, as described in the HTTP Protocol. There are two exceptions: the `Last-Modified` Header is not set if the endpoint returns no results (such as a request for a schedule with no matches). Consumers should keep track of the `Last-Modified` Header, and return it on subsequent calls to the same endpoint as the If-Modified-Since. The server will recognize this request, and will only return a result if the data has been modified since the last request. If no changes have been made, an HTTP 304 will be returned. If data has been modified, ALL data on that call will be returned (for \"only modified\" data, see below). The FTC Events API also allows a custom header used to filter the return data to a specific subset. This is done by specifying a `FMS-OnlyModifiedSince` header with each call. As with the `If-Modified-Since` header, consumers should keep track of the Last-Modified Header, and return it on subsequent calls to the same endpoint as the `FMS-OnlyModifiedSince` Header. The server will recognize this request, and will only return a result if the data has been modified since the last request, and, if returned, the data will only be those portions modified since the included date. If no changes, have been made, an HTTP 304 will be returned. Using this method, the server and consumer save processing time by only receiving modified data that is in need of update on the consumer side. If the Headers are improperly passed (such as the wrong Day of Week for the matching date, or a date in the future), the endpoint will simply ignore the Header and return all results. If both headers are specified, the request will be denied. ## Response Codes The FTC Events API HTTP Status Codes correspond with the [common codes](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html), but occasionally with different \"titles\". The \"title\" used by the API is shown next to each of the below possible response HTTP Status Codes. Throughout the documentation, Apiary may automatically show the common \"title\" in example returns (like \"Not Found\" for 404) but on the production server, the \"title\" will instead match those listed below. ### HTTP 200 - \"OK\" The request has succeeded. An entity corresponding to the requested resource is sent in the response. This will be returned as the HTTP Status Code for all request that succeed, even if the body is empty (such as an event that has no rankings, but with a valid season and event code were used) ### HTTP 304 - \"Not Modified\" When utilizing a Header that allows filtered data returns, such as `If-Modified-Since`, this response indicates that no data meets the request. ### HTTP 400 - \"Invalid Season Requested\"/\"Malformed Parameter Format In Request\"/\"Missing Parameter In Request\"/\"Invalid API Version Requested\": The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. Specifically for this API, a 400 response indicates that the requested URI matches with a valid API, but one or more required parameter was malformed or invalid. Examples include an event code that is too short or team number that contains a letter. ### HTTP 401 - \"Unauthorized\" All requests against the API require authentication via a valid user token. Failing to provide one, or providing an invalid one, will warrant a 401 response. The client MAY repeat the request with a suitable Authorization header field. ### HTTP 404 - \"Invalid Event Requested\" Even though the 404 code usually indicates any not found status, a 404 will only be issued in this API when an event cannot be found for the requested season and event code. If the request didn't match a valid API or there were malformed parameters, the response would not receive a 404 but rather a 400 or 501. If this HTTP code is received, the season was a valid season and the event code matched the acceptable style of an event code, but there were no records of an event matching the combination of that season and event code. For example, HTTP 404 would be issued when the event had a different code in the requested season (the codes can change year to year based on event location). ### HTTP 500 - \"Internal Server Error\" The server encountered an unexpected condition which prevented it from fulfilling the request. This is a code sent directly by the server, and has no special alternate definition specific to this API. ### HTTP 501 - \"Request Did Not Match Any Current API Pattern\" The server does not support the functionality required to fulfill the request. Specifically, the request pattern did not match any of the possible APIs, and thus processing was discontinued. This code is also issued when too many optional parameters were included in a single request and fulfilling it would make the result confusing or misleading. Each API will specify which parameters or combination of parameters can be used at the same time. ### HTTP 503 - \"Service Unavailable\" The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a `Retry-After` header. This code will not always appear, sometimes the server may outright refuse the connection instead. This is a code sent directly by the server, and has no special alternate definition specific to this API. ## Authorization In order to make calls against the FTC Events API, you must include an HTTP Header called `Authorization` with the value set as specified below. If a request is made without this header, processing stops and an HTTP 401 is issued. All `Authorization` headers follow the same format: ``` Authorization: Basic 000000000000000000000000000000000000000000000000000000000000 ``` Where the Zeros are replaced by your Token. The Token can be formed by taking your username and your AuthorizationKey and adding a colon. For example, if your username is `sampleuser` and your AuthorizationKey is `7eaa6338-a097-4221-ac04-b6120fcc4d49` you would have this string: ``` sampleuser:7eaa6338-a097-4221-ac04-b6120fcc4d49 ``` This string must then be encoded using Base64 Encoded to form the Token, which will be the same length as the example above, but include letters and numbers. For our example, we would have: ``` c2FtcGxldXNlcjo3ZWFhNjMzOC1hMDk3LTQyMjEtYWMwNC1iNjEyMGZjYzRkNDk= ``` Most API client libraries can handle computing the authorization header using a username and password for you NOTICE: Publicly distributing an application, code snippet, etc, that has your username and token in it, encoded or not, WILL result in your token being blocked from the API. Each user should apply for their own token. If you wish to acquire a token for your development, you may do so by requesting a token through our automated system on this website.
5
+
6
+ OpenAPI spec version: v2.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 3.0.52
10
+ =end
11
+
12
+ require 'date'
13
+
14
+ module FtcEventsClient
15
+ class Ordinates
16
+ NONE = 'None'.freeze
17
+ X = 'X'.freeze
18
+ Y = 'Y'.freeze
19
+ XY = 'XY'.freeze
20
+ Z = 'Z'.freeze
21
+ XYZ = 'XYZ'.freeze
22
+ SPATIAL4 = 'Spatial4'.freeze
23
+ SPATIAL5 = 'Spatial5'.freeze
24
+ SPATIAL6 = 'Spatial6'.freeze
25
+ SPATIAL7 = 'Spatial7'.freeze
26
+ SPATIAL8 = 'Spatial8'.freeze
27
+ SPATIAL9 = 'Spatial9'.freeze
28
+ SPATIAL10 = 'Spatial10'.freeze
29
+ SPATIAL11 = 'Spatial11'.freeze
30
+ SPATIAL12 = 'Spatial12'.freeze
31
+ SPATIAL13 = 'Spatial13'.freeze
32
+ SPATIAL14 = 'Spatial14'.freeze
33
+ SPATIAL15 = 'Spatial15'.freeze
34
+ SPATIAL16 = 'Spatial16'.freeze
35
+ ALL_SPATIAL_ORDINATES = 'AllSpatialOrdinates'.freeze
36
+ M = 'M'.freeze
37
+ XYM = 'XYM'.freeze
38
+ XYZM = 'XYZM'.freeze
39
+ MEASURE2 = 'Measure2'.freeze
40
+ MEASURE3 = 'Measure3'.freeze
41
+ MEASURE4 = 'Measure4'.freeze
42
+ MEASURE5 = 'Measure5'.freeze
43
+ MEASURE6 = 'Measure6'.freeze
44
+ MEASURE7 = 'Measure7'.freeze
45
+ MEASURE8 = 'Measure8'.freeze
46
+ MEASURE9 = 'Measure9'.freeze
47
+ MEASURE10 = 'Measure10'.freeze
48
+ MEASURE11 = 'Measure11'.freeze
49
+ MEASURE12 = 'Measure12'.freeze
50
+ MEASURE13 = 'Measure13'.freeze
51
+ MEASURE14 = 'Measure14'.freeze
52
+ MEASURE15 = 'Measure15'.freeze
53
+ MEASURE16 = 'Measure16'.freeze
54
+ ALL_MEASURE_ORDINATES = 'AllMeasureOrdinates'.freeze
55
+ ALL_ORDINATES = 'AllOrdinates'.freeze
56
+
57
+ # Builds the enum from string
58
+ # @param [String] The enum value in the form of the string
59
+ # @return [String] The enum value
60
+ def build_from_hash(value)
61
+ constantValues = Ordinates.constants.select { |c| Ordinates::const_get(c) == value }
62
+ raise "Invalid ENUM value #{value} for class #Ordinates" if constantValues.empty?
63
+ value
64
+ end
65
+ end
66
+ end
@@ -0,0 +1,463 @@
1
+ =begin
2
+ #FTC Events API
3
+
4
+ #FTC Events API is a service to return relevant information about the _FIRST_ Tech Challenge (FTC). Information is made available from events operating around the world Information is currently made available after the conclusion of the tournament. The API will provide data as soon as it has synced, and we do not add any artificial delays. ## Documentation Notes ### Timezones All times are listed in the local time to the event venue. HTTP-date values will show their timezone. ### Query Parameters If you specify a parameter, but no value for that parameter, it will be ignored. For example, if you request `URL?teamNumber=` the `teamNumber` parameter would be ignored. For all APIs that accept a query string in addition to the base URI, the order of parameters do not matter, but the name shown in the documentation must match exactly, as does the associated value format as described in details. For response codes that are not HTTP 200 (OK), the documentation will show a body message that represents a possible response value. While the \"title\" of the HTTP Status Code will match those shown in the response codes documentation section exactly, the body of the response will be a more detailed explanation of why that status code is being returned and may not always be exactly as shown in the examples. ### Experimenting with the API This documentation is rendered at both [api-docs](https://ftc-events.firstinspires.org/api-docs) and [try-it-out](https://ftc-events.firstinspires.org/try-it-out). [api-docs](https://ftc-events.firstinspires.org/api-docs) has a three panel, easy to read layout, while [try-it-out](https://ftc-events.firstinspires.org/try-it-out) has a feature that allows you try out endpoints from within the page. Additionally, the Open API Json is availabe at [Open API](https://ftc-events.firstinspires.org/swagger/v2.0/swagger.json). This can be imported into a tool such as [Postman](https://www.postman.com) for experimentation as well. ### Last-Modified, FMS-OnlyModifiedSince, and If-Modified-Since Headers The FTC Events API utilizes the `Last-Modified` and `If-Modified-Since` Headers to communicate with consumers regarding the age of the data they are requesting. With a couple of exceptions, all calls will return a `Last-Modified` Header set with the time at which the data at that endpoint was last modified. The Header will always be set in the HTTP-date format, as described in the HTTP Protocol. There are two exceptions: the `Last-Modified` Header is not set if the endpoint returns no results (such as a request for a schedule with no matches). Consumers should keep track of the `Last-Modified` Header, and return it on subsequent calls to the same endpoint as the If-Modified-Since. The server will recognize this request, and will only return a result if the data has been modified since the last request. If no changes have been made, an HTTP 304 will be returned. If data has been modified, ALL data on that call will be returned (for \"only modified\" data, see below). The FTC Events API also allows a custom header used to filter the return data to a specific subset. This is done by specifying a `FMS-OnlyModifiedSince` header with each call. As with the `If-Modified-Since` header, consumers should keep track of the Last-Modified Header, and return it on subsequent calls to the same endpoint as the `FMS-OnlyModifiedSince` Header. The server will recognize this request, and will only return a result if the data has been modified since the last request, and, if returned, the data will only be those portions modified since the included date. If no changes, have been made, an HTTP 304 will be returned. Using this method, the server and consumer save processing time by only receiving modified data that is in need of update on the consumer side. If the Headers are improperly passed (such as the wrong Day of Week for the matching date, or a date in the future), the endpoint will simply ignore the Header and return all results. If both headers are specified, the request will be denied. ## Response Codes The FTC Events API HTTP Status Codes correspond with the [common codes](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html), but occasionally with different \"titles\". The \"title\" used by the API is shown next to each of the below possible response HTTP Status Codes. Throughout the documentation, Apiary may automatically show the common \"title\" in example returns (like \"Not Found\" for 404) but on the production server, the \"title\" will instead match those listed below. ### HTTP 200 - \"OK\" The request has succeeded. An entity corresponding to the requested resource is sent in the response. This will be returned as the HTTP Status Code for all request that succeed, even if the body is empty (such as an event that has no rankings, but with a valid season and event code were used) ### HTTP 304 - \"Not Modified\" When utilizing a Header that allows filtered data returns, such as `If-Modified-Since`, this response indicates that no data meets the request. ### HTTP 400 - \"Invalid Season Requested\"/\"Malformed Parameter Format In Request\"/\"Missing Parameter In Request\"/\"Invalid API Version Requested\": The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. Specifically for this API, a 400 response indicates that the requested URI matches with a valid API, but one or more required parameter was malformed or invalid. Examples include an event code that is too short or team number that contains a letter. ### HTTP 401 - \"Unauthorized\" All requests against the API require authentication via a valid user token. Failing to provide one, or providing an invalid one, will warrant a 401 response. The client MAY repeat the request with a suitable Authorization header field. ### HTTP 404 - \"Invalid Event Requested\" Even though the 404 code usually indicates any not found status, a 404 will only be issued in this API when an event cannot be found for the requested season and event code. If the request didn't match a valid API or there were malformed parameters, the response would not receive a 404 but rather a 400 or 501. If this HTTP code is received, the season was a valid season and the event code matched the acceptable style of an event code, but there were no records of an event matching the combination of that season and event code. For example, HTTP 404 would be issued when the event had a different code in the requested season (the codes can change year to year based on event location). ### HTTP 500 - \"Internal Server Error\" The server encountered an unexpected condition which prevented it from fulfilling the request. This is a code sent directly by the server, and has no special alternate definition specific to this API. ### HTTP 501 - \"Request Did Not Match Any Current API Pattern\" The server does not support the functionality required to fulfill the request. Specifically, the request pattern did not match any of the possible APIs, and thus processing was discontinued. This code is also issued when too many optional parameters were included in a single request and fulfilling it would make the result confusing or misleading. Each API will specify which parameters or combination of parameters can be used at the same time. ### HTTP 503 - \"Service Unavailable\" The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a `Retry-After` header. This code will not always appear, sometimes the server may outright refuse the connection instead. This is a code sent directly by the server, and has no special alternate definition specific to this API. ## Authorization In order to make calls against the FTC Events API, you must include an HTTP Header called `Authorization` with the value set as specified below. If a request is made without this header, processing stops and an HTTP 401 is issued. All `Authorization` headers follow the same format: ``` Authorization: Basic 000000000000000000000000000000000000000000000000000000000000 ``` Where the Zeros are replaced by your Token. The Token can be formed by taking your username and your AuthorizationKey and adding a colon. For example, if your username is `sampleuser` and your AuthorizationKey is `7eaa6338-a097-4221-ac04-b6120fcc4d49` you would have this string: ``` sampleuser:7eaa6338-a097-4221-ac04-b6120fcc4d49 ``` This string must then be encoded using Base64 Encoded to form the Token, which will be the same length as the example above, but include letters and numbers. For our example, we would have: ``` c2FtcGxldXNlcjo3ZWFhNjMzOC1hMDk3LTQyMjEtYWMwNC1iNjEyMGZjYzRkNDk= ``` Most API client libraries can handle computing the authorization header using a username and password for you NOTICE: Publicly distributing an application, code snippet, etc, that has your username and token in it, encoded or not, WILL result in your token being blocked from the API. Each user should apply for their own token. If you wish to acquire a token for your development, you may do so by requesting a token through our automated system on this website.
5
+
6
+ OpenAPI spec version: v2.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 3.0.52
10
+ =end
11
+
12
+ require 'date'
13
+
14
+ module FtcEventsClient
15
+ class Point
16
+ attr_accessor :factory
17
+
18
+ attr_accessor :user_data
19
+
20
+ attr_accessor :srid
21
+
22
+ attr_accessor :precision_model
23
+
24
+ attr_accessor :num_geometries
25
+
26
+ attr_accessor :is_simple
27
+
28
+ attr_accessor :is_valid
29
+
30
+ attr_accessor :area
31
+
32
+ attr_accessor :length
33
+
34
+ attr_accessor :centroid
35
+
36
+ attr_accessor :interior_point
37
+
38
+ attr_accessor :point_on_surface
39
+
40
+ attr_accessor :envelope
41
+
42
+ attr_accessor :envelope_internal
43
+
44
+ attr_accessor :is_rectangle
45
+
46
+ attr_accessor :coordinate_sequence
47
+
48
+ attr_accessor :coordinates
49
+
50
+ attr_accessor :num_points
51
+
52
+ attr_accessor :is_empty
53
+
54
+ attr_accessor :dimension
55
+
56
+ attr_accessor :boundary_dimension
57
+
58
+ attr_accessor :x
59
+
60
+ attr_accessor :y
61
+
62
+ attr_accessor :coordinate
63
+
64
+ attr_accessor :geometry_type
65
+
66
+ attr_accessor :ogc_geometry_type
67
+
68
+ attr_accessor :boundary
69
+
70
+ attr_accessor :z
71
+
72
+ attr_accessor :m
73
+
74
+ # Attribute mapping from ruby-style variable name to JSON key.
75
+ def self.attribute_map
76
+ {
77
+ :'factory' => :'factory',
78
+ :'user_data' => :'userData',
79
+ :'srid' => :'srid',
80
+ :'precision_model' => :'precisionModel',
81
+ :'num_geometries' => :'numGeometries',
82
+ :'is_simple' => :'isSimple',
83
+ :'is_valid' => :'isValid',
84
+ :'area' => :'area',
85
+ :'length' => :'length',
86
+ :'centroid' => :'centroid',
87
+ :'interior_point' => :'interiorPoint',
88
+ :'point_on_surface' => :'pointOnSurface',
89
+ :'envelope' => :'envelope',
90
+ :'envelope_internal' => :'envelopeInternal',
91
+ :'is_rectangle' => :'isRectangle',
92
+ :'coordinate_sequence' => :'coordinateSequence',
93
+ :'coordinates' => :'coordinates',
94
+ :'num_points' => :'numPoints',
95
+ :'is_empty' => :'isEmpty',
96
+ :'dimension' => :'dimension',
97
+ :'boundary_dimension' => :'boundaryDimension',
98
+ :'x' => :'x',
99
+ :'y' => :'y',
100
+ :'coordinate' => :'coordinate',
101
+ :'geometry_type' => :'geometryType',
102
+ :'ogc_geometry_type' => :'ogcGeometryType',
103
+ :'boundary' => :'boundary',
104
+ :'z' => :'z',
105
+ :'m' => :'m'
106
+ }
107
+ end
108
+
109
+ # Attribute type mapping.
110
+ def self.openapi_types
111
+ {
112
+ :'factory' => :'Object',
113
+ :'user_data' => :'Object',
114
+ :'srid' => :'Object',
115
+ :'precision_model' => :'Object',
116
+ :'num_geometries' => :'Object',
117
+ :'is_simple' => :'Object',
118
+ :'is_valid' => :'Object',
119
+ :'area' => :'Object',
120
+ :'length' => :'Object',
121
+ :'centroid' => :'Object',
122
+ :'interior_point' => :'Object',
123
+ :'point_on_surface' => :'Object',
124
+ :'envelope' => :'Object',
125
+ :'envelope_internal' => :'Object',
126
+ :'is_rectangle' => :'Object',
127
+ :'coordinate_sequence' => :'Object',
128
+ :'coordinates' => :'Object',
129
+ :'num_points' => :'Object',
130
+ :'is_empty' => :'Object',
131
+ :'dimension' => :'Object',
132
+ :'boundary_dimension' => :'Object',
133
+ :'x' => :'Object',
134
+ :'y' => :'Object',
135
+ :'coordinate' => :'Object',
136
+ :'geometry_type' => :'Object',
137
+ :'ogc_geometry_type' => :'Object',
138
+ :'boundary' => :'Object',
139
+ :'z' => :'Object',
140
+ :'m' => :'Object'
141
+ }
142
+ end
143
+
144
+ # List of attributes with nullable: true
145
+ def self.openapi_nullable
146
+ Set.new([
147
+ :'user_data',
148
+ :'coordinates',
149
+ :'geometry_type',
150
+ ])
151
+ end
152
+
153
+ # Initializes the object
154
+ # @param [Hash] attributes Model attributes in the form of hash
155
+ def initialize(attributes = {})
156
+ if (!attributes.is_a?(Hash))
157
+ fail ArgumentError, "The input argument (attributes) must be a hash in `FtcEventsClient::Point` initialize method"
158
+ end
159
+
160
+ # check to see if the attribute exists and convert string to symbol for hash key
161
+ attributes = attributes.each_with_object({}) { |(k, v), h|
162
+ if (!self.class.attribute_map.key?(k.to_sym))
163
+ fail ArgumentError, "`#{k}` is not a valid attribute in `FtcEventsClient::Point`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
164
+ end
165
+ h[k.to_sym] = v
166
+ }
167
+
168
+ if attributes.key?(:'factory')
169
+ self.factory = attributes[:'factory']
170
+ end
171
+
172
+ if attributes.key?(:'user_data')
173
+ self.user_data = attributes[:'user_data']
174
+ end
175
+
176
+ if attributes.key?(:'srid')
177
+ self.srid = attributes[:'srid']
178
+ end
179
+
180
+ if attributes.key?(:'precision_model')
181
+ self.precision_model = attributes[:'precision_model']
182
+ end
183
+
184
+ if attributes.key?(:'num_geometries')
185
+ self.num_geometries = attributes[:'num_geometries']
186
+ end
187
+
188
+ if attributes.key?(:'is_simple')
189
+ self.is_simple = attributes[:'is_simple']
190
+ end
191
+
192
+ if attributes.key?(:'is_valid')
193
+ self.is_valid = attributes[:'is_valid']
194
+ end
195
+
196
+ if attributes.key?(:'area')
197
+ self.area = attributes[:'area']
198
+ end
199
+
200
+ if attributes.key?(:'length')
201
+ self.length = attributes[:'length']
202
+ end
203
+
204
+ if attributes.key?(:'centroid')
205
+ self.centroid = attributes[:'centroid']
206
+ end
207
+
208
+ if attributes.key?(:'interior_point')
209
+ self.interior_point = attributes[:'interior_point']
210
+ end
211
+
212
+ if attributes.key?(:'point_on_surface')
213
+ self.point_on_surface = attributes[:'point_on_surface']
214
+ end
215
+
216
+ if attributes.key?(:'envelope')
217
+ self.envelope = attributes[:'envelope']
218
+ end
219
+
220
+ if attributes.key?(:'envelope_internal')
221
+ self.envelope_internal = attributes[:'envelope_internal']
222
+ end
223
+
224
+ if attributes.key?(:'is_rectangle')
225
+ self.is_rectangle = attributes[:'is_rectangle']
226
+ end
227
+
228
+ if attributes.key?(:'coordinate_sequence')
229
+ self.coordinate_sequence = attributes[:'coordinate_sequence']
230
+ end
231
+
232
+ if attributes.key?(:'coordinates')
233
+ if (value = attributes[:'coordinates']).is_a?(Array)
234
+ self.coordinates = value
235
+ end
236
+ end
237
+
238
+ if attributes.key?(:'num_points')
239
+ self.num_points = attributes[:'num_points']
240
+ end
241
+
242
+ if attributes.key?(:'is_empty')
243
+ self.is_empty = attributes[:'is_empty']
244
+ end
245
+
246
+ if attributes.key?(:'dimension')
247
+ self.dimension = attributes[:'dimension']
248
+ end
249
+
250
+ if attributes.key?(:'boundary_dimension')
251
+ self.boundary_dimension = attributes[:'boundary_dimension']
252
+ end
253
+
254
+ if attributes.key?(:'x')
255
+ self.x = attributes[:'x']
256
+ end
257
+
258
+ if attributes.key?(:'y')
259
+ self.y = attributes[:'y']
260
+ end
261
+
262
+ if attributes.key?(:'coordinate')
263
+ self.coordinate = attributes[:'coordinate']
264
+ end
265
+
266
+ if attributes.key?(:'geometry_type')
267
+ self.geometry_type = attributes[:'geometry_type']
268
+ end
269
+
270
+ if attributes.key?(:'ogc_geometry_type')
271
+ self.ogc_geometry_type = attributes[:'ogc_geometry_type']
272
+ end
273
+
274
+ if attributes.key?(:'boundary')
275
+ self.boundary = attributes[:'boundary']
276
+ end
277
+
278
+ if attributes.key?(:'z')
279
+ self.z = attributes[:'z']
280
+ end
281
+
282
+ if attributes.key?(:'m')
283
+ self.m = attributes[:'m']
284
+ end
285
+ end
286
+
287
+ # Show invalid properties with the reasons. Usually used together with valid?
288
+ # @return Array for valid properties with the reasons
289
+ def list_invalid_properties
290
+ invalid_properties = Array.new
291
+ invalid_properties
292
+ end
293
+
294
+ # Check to see if the all the properties in the model are valid
295
+ # @return true if the model is valid
296
+ def valid?
297
+ true
298
+ end
299
+
300
+ # Checks equality by comparing each attribute.
301
+ # @param [Object] Object to be compared
302
+ def ==(o)
303
+ return true if self.equal?(o)
304
+ self.class == o.class &&
305
+ factory == o.factory &&
306
+ user_data == o.user_data &&
307
+ srid == o.srid &&
308
+ precision_model == o.precision_model &&
309
+ num_geometries == o.num_geometries &&
310
+ is_simple == o.is_simple &&
311
+ is_valid == o.is_valid &&
312
+ area == o.area &&
313
+ length == o.length &&
314
+ centroid == o.centroid &&
315
+ interior_point == o.interior_point &&
316
+ point_on_surface == o.point_on_surface &&
317
+ envelope == o.envelope &&
318
+ envelope_internal == o.envelope_internal &&
319
+ is_rectangle == o.is_rectangle &&
320
+ coordinate_sequence == o.coordinate_sequence &&
321
+ coordinates == o.coordinates &&
322
+ num_points == o.num_points &&
323
+ is_empty == o.is_empty &&
324
+ dimension == o.dimension &&
325
+ boundary_dimension == o.boundary_dimension &&
326
+ x == o.x &&
327
+ y == o.y &&
328
+ coordinate == o.coordinate &&
329
+ geometry_type == o.geometry_type &&
330
+ ogc_geometry_type == o.ogc_geometry_type &&
331
+ boundary == o.boundary &&
332
+ z == o.z &&
333
+ m == o.m
334
+ end
335
+
336
+ # @see the `==` method
337
+ # @param [Object] Object to be compared
338
+ def eql?(o)
339
+ self == o
340
+ end
341
+
342
+ # Calculates hash code according to all attributes.
343
+ # @return [Integer] Hash code
344
+ def hash
345
+ [factory, user_data, srid, precision_model, num_geometries, is_simple, is_valid, area, length, centroid, interior_point, point_on_surface, envelope, envelope_internal, is_rectangle, coordinate_sequence, coordinates, num_points, is_empty, dimension, boundary_dimension, x, y, coordinate, geometry_type, ogc_geometry_type, boundary, z, m].hash
346
+ end
347
+
348
+ # Builds the object from hash
349
+ # @param [Hash] attributes Model attributes in the form of hash
350
+ # @return [Object] Returns the model itself
351
+ def self.build_from_hash(attributes)
352
+ new.build_from_hash(attributes)
353
+ end
354
+
355
+ # Builds the object from hash
356
+ # @param [Hash] attributes Model attributes in the form of hash
357
+ # @return [Object] Returns the model itself
358
+ def build_from_hash(attributes)
359
+ return nil unless attributes.is_a?(Hash)
360
+ self.class.openapi_types.each_pair do |key, type|
361
+ if type =~ /\AArray<(.*)>/i
362
+ # check to ensure the input is an array given that the attribute
363
+ # is documented as an array but the input is not
364
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
365
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
366
+ end
367
+ elsif !attributes[self.class.attribute_map[key]].nil?
368
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
369
+ elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
370
+ self.send("#{key}=", nil)
371
+ end
372
+ end
373
+
374
+ self
375
+ end
376
+
377
+ # Deserializes the data based on type
378
+ # @param string type Data type
379
+ # @param string value Value to be deserialized
380
+ # @return [Object] Deserialized data
381
+ def _deserialize(type, value)
382
+ case type.to_sym
383
+ when :DateTime
384
+ DateTime.parse(value)
385
+ when :Date
386
+ Date.parse(value)
387
+ when :String
388
+ value.to_s
389
+ when :Integer
390
+ value.to_i
391
+ when :Float
392
+ value.to_f
393
+ when :Boolean
394
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
395
+ true
396
+ else
397
+ false
398
+ end
399
+ when :Object
400
+ # generic object (usually a Hash), return directly
401
+ value
402
+ when /\AArray<(?<inner_type>.+)>\z/
403
+ inner_type = Regexp.last_match[:inner_type]
404
+ value.map { |v| _deserialize(inner_type, v) }
405
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
406
+ k_type = Regexp.last_match[:k_type]
407
+ v_type = Regexp.last_match[:v_type]
408
+ {}.tap do |hash|
409
+ value.each do |k, v|
410
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
411
+ end
412
+ end
413
+ else # model
414
+ FtcEventsClient.const_get(type).build_from_hash(value)
415
+ end
416
+ end
417
+
418
+ # Returns the string representation of the object
419
+ # @return [String] String presentation of the object
420
+ def to_s
421
+ to_hash.to_s
422
+ end
423
+
424
+ # to_body is an alias to to_hash (backward compatibility)
425
+ # @return [Hash] Returns the object in the form of hash
426
+ def to_body
427
+ to_hash
428
+ end
429
+
430
+ # Returns the object in the form of hash
431
+ # @return [Hash] Returns the object in the form of hash
432
+ def to_hash
433
+ hash = {}
434
+ self.class.attribute_map.each_pair do |attr, param|
435
+ value = self.send(attr)
436
+ if value.nil?
437
+ is_nullable = self.class.openapi_nullable.include?(attr)
438
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
439
+ end
440
+
441
+ hash[param] = _to_hash(value)
442
+ end
443
+ hash
444
+ end
445
+
446
+ # Outputs non-array value in the form of hash
447
+ # For object, use to_hash. Otherwise, just return the value
448
+ # @param [Object] value Any valid value
449
+ # @return [Hash] Returns the value in the form of hash
450
+ def _to_hash(value)
451
+ if value.is_a?(Array)
452
+ value.compact.map { |v| _to_hash(v) }
453
+ elsif value.is_a?(Hash)
454
+ {}.tap do |hash|
455
+ value.each { |k, v| hash[k] = _to_hash(v) }
456
+ end
457
+ elsif value.respond_to? :to_hash
458
+ value.to_hash
459
+ else
460
+ value
461
+ end
462
+ end end
463
+ end