ftc_events_client 0.2.1 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (188) 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.gemspec +1 -1
  60. data/git_push.sh +0 -0
  61. data/lib/ftc_events_client/api/advancement_api.rb +147 -0
  62. data/lib/ftc_events_client/api/alliance_selection_api.rb +63 -1
  63. data/lib/ftc_events_client/api/awards_api.rb +1 -1
  64. data/lib/ftc_events_client/api/general_api.rb +1 -1
  65. data/lib/ftc_events_client/api/leagues_api.rb +1 -1
  66. data/lib/ftc_events_client/api/match_results_api.rb +1 -1
  67. data/lib/ftc_events_client/api/rankings_api.rb +1 -1
  68. data/lib/ftc_events_client/api/schedule_api.rb +1 -1
  69. data/lib/ftc_events_client/api/season_data_api.rb +1 -1
  70. data/lib/ftc_events_client/api_client.rb +1 -1
  71. data/lib/ftc_events_client/api_error.rb +1 -1
  72. data/lib/ftc_events_client/configuration.rb +2 -2
  73. data/lib/ftc_events_client/models/advancement_model.rb +231 -0
  74. data/lib/ftc_events_client/models/advancement_slot.rb +269 -0
  75. data/lib/ftc_events_client/models/advancement_source_model.rb +242 -0
  76. data/lib/ftc_events_client/models/alliance_model_version2.rb +32 -2
  77. data/lib/ftc_events_client/models/alliance_score_2020.rb +1 -1
  78. data/lib/ftc_events_client/models/alliance_selection_detail_model.rb +218 -0
  79. data/lib/ftc_events_client/models/alliance_selection_model_version2.rb +1 -1
  80. data/lib/ftc_events_client/models/api_advancement_status.rb +31 -0
  81. data/lib/ftc_events_client/models/api_index_model.rb +1 -1
  82. data/lib/ftc_events_client/models/auto_navigated_status.rb +1 -1
  83. data/lib/ftc_events_client/models/auto_navigation.rb +29 -0
  84. data/lib/ftc_events_client/models/award_assignment_model.rb +12 -2
  85. data/lib/ftc_events_client/models/awards_model.rb +1 -1
  86. data/lib/ftc_events_client/models/barcode_element.rb +1 -1
  87. data/lib/ftc_events_client/models/coordinate.rb +251 -0
  88. data/lib/ftc_events_client/models/coordinate_equality_comparer.rb +197 -0
  89. data/lib/ftc_events_client/models/coordinate_sequence.rb +296 -0
  90. data/lib/ftc_events_client/models/coordinate_sequence_factory.rb +206 -0
  91. data/lib/ftc_events_client/models/dimension.rb +33 -0
  92. data/lib/ftc_events_client/models/end_game_location.rb +29 -0
  93. data/lib/ftc_events_client/models/endgame_parked_status.rb +1 -1
  94. data/lib/ftc_events_client/models/envelope.rb +305 -0
  95. data/lib/ftc_events_client/models/event_match_results_model_version2.rb +1 -1
  96. data/lib/ftc_events_client/models/event_rankings_model.rb +1 -1
  97. data/lib/ftc_events_client/models/event_schedule_hybrid_model_version2.rb +1 -1
  98. data/lib/ftc_events_client/models/event_schedule_model_version2.rb +1 -1
  99. data/lib/ftc_events_client/models/field_side.rb +28 -0
  100. data/lib/ftc_events_client/models/ftc_event_level.rb +1 -1
  101. data/lib/ftc_events_client/models/geometry.rb +418 -0
  102. data/lib/ftc_events_client/models/geometry_factory.rb +233 -0
  103. data/lib/ftc_events_client/models/geometry_overlay.rb +197 -0
  104. data/lib/ftc_events_client/models/junction_element.rb +32 -0
  105. data/lib/ftc_events_client/models/league_member_list_model.rb +1 -1
  106. data/lib/ftc_events_client/models/match_result_model_version2.rb +1 -1
  107. data/lib/ftc_events_client/models/match_result_team_model_version2.rb +1 -1
  108. data/lib/ftc_events_client/models/match_scores_model.rb +1 -1
  109. data/lib/ftc_events_client/models/nts_geometry_services.rb +242 -0
  110. data/lib/ftc_events_client/models/ogc_geometry_type.rb +42 -0
  111. data/lib/ftc_events_client/models/one_of_match_scores_model_match_scores_items.rb +1 -1
  112. data/lib/ftc_events_client/models/ordinates.rb +66 -0
  113. data/lib/ftc_events_client/models/point.rb +463 -0
  114. data/lib/ftc_events_client/models/precision_model.rb +242 -0
  115. data/lib/ftc_events_client/models/precision_models.rb +29 -0
  116. data/lib/ftc_events_client/models/schedule_hybrid_model_team_version2.rb +26 -6
  117. data/lib/ftc_events_client/models/schedule_hybrid_model_version2.rb +22 -2
  118. data/lib/ftc_events_client/models/scheduled_match_model_version2.rb +1 -1
  119. data/lib/ftc_events_client/models/scheduled_match_team_model_version2.rb +32 -2
  120. data/lib/ftc_events_client/models/score_detail_alliance_model_2020.rb +1 -1
  121. data/lib/ftc_events_client/models/score_detail_alliance_model_2021.rb +1 -1
  122. data/lib/ftc_events_client/models/score_detail_alliance_model_2022.rb +540 -0
  123. data/lib/ftc_events_client/models/score_detail_alliance_model_2023.rb +540 -0
  124. data/lib/ftc_events_client/models/score_detail_model_2019.rb +1 -1
  125. data/lib/ftc_events_client/models/score_detail_model_2020.rb +1 -1
  126. data/lib/ftc_events_client/models/score_detail_model_2021.rb +11 -2
  127. data/lib/ftc_events_client/models/score_detail_model_2022.rb +245 -0
  128. data/lib/ftc_events_client/models/score_detail_model_2023.rb +245 -0
  129. data/lib/ftc_events_client/models/score_detail_model_alliance_2019.rb +1 -1
  130. data/lib/ftc_events_client/models/score_detail_model_single_player_2020.rb +1 -1
  131. data/lib/ftc_events_client/models/score_detail_model_single_player_2021.rb +11 -2
  132. data/lib/ftc_events_client/models/score_detail_model_single_player_2022.rb +242 -0
  133. data/lib/ftc_events_client/models/score_detail_model_single_player_2023.rb +242 -0
  134. data/lib/ftc_events_client/models/score_detail_single_player_2021.rb +1 -1
  135. data/lib/ftc_events_client/models/score_detail_single_player_2022.rb +474 -0
  136. data/lib/ftc_events_client/models/score_detail_single_player_2023.rb +467 -0
  137. data/lib/ftc_events_client/models/season_award_listings_model.rb +1 -1
  138. data/lib/ftc_events_client/models/season_awards_model.rb +1 -1
  139. data/lib/ftc_events_client/models/season_event_listings_model_version2.rb +1 -1
  140. data/lib/ftc_events_client/models/season_event_model_version2.rb +30 -2
  141. data/lib/ftc_events_client/models/season_league_listings_model_version2.rb +1 -1
  142. data/lib/ftc_events_client/models/season_league_model_version2.rb +22 -2
  143. data/lib/ftc_events_client/models/season_summary_model_championship.rb +1 -1
  144. data/lib/ftc_events_client/models/season_summary_model_version2.rb +1 -1
  145. data/lib/ftc_events_client/models/season_team_listings_model_version2.rb +1 -1
  146. data/lib/ftc_events_client/models/season_team_model_version2.rb +36 -6
  147. data/lib/ftc_events_client/models/selection_model.rb +224 -0
  148. data/lib/ftc_events_client/models/selection_result.rb +29 -0
  149. data/lib/ftc_events_client/models/stone.rb +1 -1
  150. data/lib/ftc_events_client/models/team_ranking_model.rb +22 -2
  151. data/lib/ftc_events_client/version.rb +2 -2
  152. data/lib/ftc_events_client.rb +36 -1
  153. data/spec/api/advancement_api_spec.rb +61 -0
  154. data/spec/models/advancement_model_spec.rb +52 -0
  155. data/spec/models/advancement_slot_spec.rb +76 -0
  156. data/spec/models/advancement_source_model_spec.rb +58 -0
  157. data/spec/models/alliance_selection_detail_model_spec.rb +46 -0
  158. data/spec/models/api_advancement_status_spec.rb +34 -0
  159. data/spec/models/auto_navigation_spec.rb +34 -0
  160. data/spec/models/coordinate_equality_comparer_spec.rb +34 -0
  161. data/spec/models/coordinate_sequence_factory_spec.rb +40 -0
  162. data/spec/models/coordinate_sequence_spec.rb +100 -0
  163. data/spec/models/coordinate_spec.rb +70 -0
  164. data/spec/models/dimension_spec.rb +34 -0
  165. data/spec/models/end_game_location_spec.rb +34 -0
  166. data/spec/models/envelope_spec.rb +106 -0
  167. data/spec/models/field_side_spec.rb +34 -0
  168. data/spec/models/geometry_factory_spec.rb +58 -0
  169. data/spec/models/geometry_overlay_spec.rb +34 -0
  170. data/spec/models/geometry_spec.rb +178 -0
  171. data/spec/models/junction_element_spec.rb +34 -0
  172. data/spec/models/nts_geometry_services_spec.rb +64 -0
  173. data/spec/models/ogc_geometry_type_spec.rb +34 -0
  174. data/spec/models/ordinates_spec.rb +34 -0
  175. data/spec/models/point_spec.rb +208 -0
  176. data/spec/models/precision_model_spec.rb +64 -0
  177. data/spec/models/precision_models_spec.rb +34 -0
  178. data/spec/models/score_detail_alliance_model_2022_spec.rb +250 -0
  179. data/spec/models/score_detail_alliance_model_2023_spec.rb +262 -0
  180. data/spec/models/score_detail_model_2022_spec.rb +64 -0
  181. data/spec/models/score_detail_model_2023_spec.rb +64 -0
  182. data/spec/models/score_detail_model_single_player_2022_spec.rb +64 -0
  183. data/spec/models/score_detail_model_single_player_2023_spec.rb +64 -0
  184. data/spec/models/score_detail_single_player_2022_spec.rb +208 -0
  185. data/spec/models/score_detail_single_player_2023_spec.rb +214 -0
  186. data/spec/models/selection_model_spec.rb +52 -0
  187. data/spec/models/selection_result_spec.rb +34 -0
  188. metadata +144 -3
@@ -0,0 +1,296 @@
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 CoordinateSequence
16
+ attr_accessor :dimension
17
+
18
+ attr_accessor :measures
19
+
20
+ attr_accessor :spatial
21
+
22
+ attr_accessor :ordinates
23
+
24
+ attr_accessor :has_z
25
+
26
+ attr_accessor :has_m
27
+
28
+ attr_accessor :z_ordinate_index
29
+
30
+ attr_accessor :m_ordinate_index
31
+
32
+ attr_accessor :first
33
+
34
+ attr_accessor :last
35
+
36
+ attr_accessor :count
37
+
38
+ # Attribute mapping from ruby-style variable name to JSON key.
39
+ def self.attribute_map
40
+ {
41
+ :'dimension' => :'dimension',
42
+ :'measures' => :'measures',
43
+ :'spatial' => :'spatial',
44
+ :'ordinates' => :'ordinates',
45
+ :'has_z' => :'hasZ',
46
+ :'has_m' => :'hasM',
47
+ :'z_ordinate_index' => :'zOrdinateIndex',
48
+ :'m_ordinate_index' => :'mOrdinateIndex',
49
+ :'first' => :'first',
50
+ :'last' => :'last',
51
+ :'count' => :'count'
52
+ }
53
+ end
54
+
55
+ # Attribute type mapping.
56
+ def self.openapi_types
57
+ {
58
+ :'dimension' => :'Object',
59
+ :'measures' => :'Object',
60
+ :'spatial' => :'Object',
61
+ :'ordinates' => :'Object',
62
+ :'has_z' => :'Object',
63
+ :'has_m' => :'Object',
64
+ :'z_ordinate_index' => :'Object',
65
+ :'m_ordinate_index' => :'Object',
66
+ :'first' => :'Object',
67
+ :'last' => :'Object',
68
+ :'count' => :'Object'
69
+ }
70
+ end
71
+
72
+ # List of attributes with nullable: true
73
+ def self.openapi_nullable
74
+ Set.new([
75
+ ])
76
+ end
77
+
78
+ # Initializes the object
79
+ # @param [Hash] attributes Model attributes in the form of hash
80
+ def initialize(attributes = {})
81
+ if (!attributes.is_a?(Hash))
82
+ fail ArgumentError, "The input argument (attributes) must be a hash in `FtcEventsClient::CoordinateSequence` initialize method"
83
+ end
84
+
85
+ # check to see if the attribute exists and convert string to symbol for hash key
86
+ attributes = attributes.each_with_object({}) { |(k, v), h|
87
+ if (!self.class.attribute_map.key?(k.to_sym))
88
+ fail ArgumentError, "`#{k}` is not a valid attribute in `FtcEventsClient::CoordinateSequence`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
89
+ end
90
+ h[k.to_sym] = v
91
+ }
92
+
93
+ if attributes.key?(:'dimension')
94
+ self.dimension = attributes[:'dimension']
95
+ end
96
+
97
+ if attributes.key?(:'measures')
98
+ self.measures = attributes[:'measures']
99
+ end
100
+
101
+ if attributes.key?(:'spatial')
102
+ self.spatial = attributes[:'spatial']
103
+ end
104
+
105
+ if attributes.key?(:'ordinates')
106
+ self.ordinates = attributes[:'ordinates']
107
+ end
108
+
109
+ if attributes.key?(:'has_z')
110
+ self.has_z = attributes[:'has_z']
111
+ end
112
+
113
+ if attributes.key?(:'has_m')
114
+ self.has_m = attributes[:'has_m']
115
+ end
116
+
117
+ if attributes.key?(:'z_ordinate_index')
118
+ self.z_ordinate_index = attributes[:'z_ordinate_index']
119
+ end
120
+
121
+ if attributes.key?(:'m_ordinate_index')
122
+ self.m_ordinate_index = attributes[:'m_ordinate_index']
123
+ end
124
+
125
+ if attributes.key?(:'first')
126
+ self.first = attributes[:'first']
127
+ end
128
+
129
+ if attributes.key?(:'last')
130
+ self.last = attributes[:'last']
131
+ end
132
+
133
+ if attributes.key?(:'count')
134
+ self.count = attributes[:'count']
135
+ end
136
+ end
137
+
138
+ # Show invalid properties with the reasons. Usually used together with valid?
139
+ # @return Array for valid properties with the reasons
140
+ def list_invalid_properties
141
+ invalid_properties = Array.new
142
+ invalid_properties
143
+ end
144
+
145
+ # Check to see if the all the properties in the model are valid
146
+ # @return true if the model is valid
147
+ def valid?
148
+ true
149
+ end
150
+
151
+ # Checks equality by comparing each attribute.
152
+ # @param [Object] Object to be compared
153
+ def ==(o)
154
+ return true if self.equal?(o)
155
+ self.class == o.class &&
156
+ dimension == o.dimension &&
157
+ measures == o.measures &&
158
+ spatial == o.spatial &&
159
+ ordinates == o.ordinates &&
160
+ has_z == o.has_z &&
161
+ has_m == o.has_m &&
162
+ z_ordinate_index == o.z_ordinate_index &&
163
+ m_ordinate_index == o.m_ordinate_index &&
164
+ first == o.first &&
165
+ last == o.last &&
166
+ count == o.count
167
+ end
168
+
169
+ # @see the `==` method
170
+ # @param [Object] Object to be compared
171
+ def eql?(o)
172
+ self == o
173
+ end
174
+
175
+ # Calculates hash code according to all attributes.
176
+ # @return [Integer] Hash code
177
+ def hash
178
+ [dimension, measures, spatial, ordinates, has_z, has_m, z_ordinate_index, m_ordinate_index, first, last, count].hash
179
+ end
180
+
181
+ # Builds the object from hash
182
+ # @param [Hash] attributes Model attributes in the form of hash
183
+ # @return [Object] Returns the model itself
184
+ def self.build_from_hash(attributes)
185
+ new.build_from_hash(attributes)
186
+ end
187
+
188
+ # Builds the object from hash
189
+ # @param [Hash] attributes Model attributes in the form of hash
190
+ # @return [Object] Returns the model itself
191
+ def build_from_hash(attributes)
192
+ return nil unless attributes.is_a?(Hash)
193
+ self.class.openapi_types.each_pair do |key, type|
194
+ if type =~ /\AArray<(.*)>/i
195
+ # check to ensure the input is an array given that the attribute
196
+ # is documented as an array but the input is not
197
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
198
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
199
+ end
200
+ elsif !attributes[self.class.attribute_map[key]].nil?
201
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
202
+ elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
203
+ self.send("#{key}=", nil)
204
+ end
205
+ end
206
+
207
+ self
208
+ end
209
+
210
+ # Deserializes the data based on type
211
+ # @param string type Data type
212
+ # @param string value Value to be deserialized
213
+ # @return [Object] Deserialized data
214
+ def _deserialize(type, value)
215
+ case type.to_sym
216
+ when :DateTime
217
+ DateTime.parse(value)
218
+ when :Date
219
+ Date.parse(value)
220
+ when :String
221
+ value.to_s
222
+ when :Integer
223
+ value.to_i
224
+ when :Float
225
+ value.to_f
226
+ when :Boolean
227
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
228
+ true
229
+ else
230
+ false
231
+ end
232
+ when :Object
233
+ # generic object (usually a Hash), return directly
234
+ value
235
+ when /\AArray<(?<inner_type>.+)>\z/
236
+ inner_type = Regexp.last_match[:inner_type]
237
+ value.map { |v| _deserialize(inner_type, v) }
238
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
239
+ k_type = Regexp.last_match[:k_type]
240
+ v_type = Regexp.last_match[:v_type]
241
+ {}.tap do |hash|
242
+ value.each do |k, v|
243
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
244
+ end
245
+ end
246
+ else # model
247
+ FtcEventsClient.const_get(type).build_from_hash(value)
248
+ end
249
+ end
250
+
251
+ # Returns the string representation of the object
252
+ # @return [String] String presentation of the object
253
+ def to_s
254
+ to_hash.to_s
255
+ end
256
+
257
+ # to_body is an alias to to_hash (backward compatibility)
258
+ # @return [Hash] Returns the object in the form of hash
259
+ def to_body
260
+ to_hash
261
+ end
262
+
263
+ # Returns the object in the form of hash
264
+ # @return [Hash] Returns the object in the form of hash
265
+ def to_hash
266
+ hash = {}
267
+ self.class.attribute_map.each_pair do |attr, param|
268
+ value = self.send(attr)
269
+ if value.nil?
270
+ is_nullable = self.class.openapi_nullable.include?(attr)
271
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
272
+ end
273
+
274
+ hash[param] = _to_hash(value)
275
+ end
276
+ hash
277
+ end
278
+
279
+ # Outputs non-array value in the form of hash
280
+ # For object, use to_hash. Otherwise, just return the value
281
+ # @param [Object] value Any valid value
282
+ # @return [Hash] Returns the value in the form of hash
283
+ def _to_hash(value)
284
+ if value.is_a?(Array)
285
+ value.compact.map { |v| _to_hash(v) }
286
+ elsif value.is_a?(Hash)
287
+ {}.tap do |hash|
288
+ value.each { |k, v| hash[k] = _to_hash(v) }
289
+ end
290
+ elsif value.respond_to? :to_hash
291
+ value.to_hash
292
+ else
293
+ value
294
+ end
295
+ end end
296
+ end
@@ -0,0 +1,206 @@
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 CoordinateSequenceFactory
16
+ attr_accessor :ordinates
17
+
18
+ # Attribute mapping from ruby-style variable name to JSON key.
19
+ def self.attribute_map
20
+ {
21
+ :'ordinates' => :'ordinates'
22
+ }
23
+ end
24
+
25
+ # Attribute type mapping.
26
+ def self.openapi_types
27
+ {
28
+ :'ordinates' => :'Object'
29
+ }
30
+ end
31
+
32
+ # List of attributes with nullable: true
33
+ def self.openapi_nullable
34
+ Set.new([
35
+ ])
36
+ end
37
+
38
+ # Initializes the object
39
+ # @param [Hash] attributes Model attributes in the form of hash
40
+ def initialize(attributes = {})
41
+ if (!attributes.is_a?(Hash))
42
+ fail ArgumentError, "The input argument (attributes) must be a hash in `FtcEventsClient::CoordinateSequenceFactory` initialize method"
43
+ end
44
+
45
+ # check to see if the attribute exists and convert string to symbol for hash key
46
+ attributes = attributes.each_with_object({}) { |(k, v), h|
47
+ if (!self.class.attribute_map.key?(k.to_sym))
48
+ fail ArgumentError, "`#{k}` is not a valid attribute in `FtcEventsClient::CoordinateSequenceFactory`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
49
+ end
50
+ h[k.to_sym] = v
51
+ }
52
+
53
+ if attributes.key?(:'ordinates')
54
+ self.ordinates = attributes[:'ordinates']
55
+ end
56
+ end
57
+
58
+ # Show invalid properties with the reasons. Usually used together with valid?
59
+ # @return Array for valid properties with the reasons
60
+ def list_invalid_properties
61
+ invalid_properties = Array.new
62
+ invalid_properties
63
+ end
64
+
65
+ # Check to see if the all the properties in the model are valid
66
+ # @return true if the model is valid
67
+ def valid?
68
+ true
69
+ end
70
+
71
+ # Checks equality by comparing each attribute.
72
+ # @param [Object] Object to be compared
73
+ def ==(o)
74
+ return true if self.equal?(o)
75
+ self.class == o.class &&
76
+ ordinates == o.ordinates
77
+ end
78
+
79
+ # @see the `==` method
80
+ # @param [Object] Object to be compared
81
+ def eql?(o)
82
+ self == o
83
+ end
84
+
85
+ # Calculates hash code according to all attributes.
86
+ # @return [Integer] Hash code
87
+ def hash
88
+ [ordinates].hash
89
+ end
90
+
91
+ # Builds the object from hash
92
+ # @param [Hash] attributes Model attributes in the form of hash
93
+ # @return [Object] Returns the model itself
94
+ def self.build_from_hash(attributes)
95
+ new.build_from_hash(attributes)
96
+ end
97
+
98
+ # Builds the object from hash
99
+ # @param [Hash] attributes Model attributes in the form of hash
100
+ # @return [Object] Returns the model itself
101
+ def build_from_hash(attributes)
102
+ return nil unless attributes.is_a?(Hash)
103
+ self.class.openapi_types.each_pair do |key, type|
104
+ if type =~ /\AArray<(.*)>/i
105
+ # check to ensure the input is an array given that the attribute
106
+ # is documented as an array but the input is not
107
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
108
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
109
+ end
110
+ elsif !attributes[self.class.attribute_map[key]].nil?
111
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
112
+ elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
113
+ self.send("#{key}=", nil)
114
+ end
115
+ end
116
+
117
+ self
118
+ end
119
+
120
+ # Deserializes the data based on type
121
+ # @param string type Data type
122
+ # @param string value Value to be deserialized
123
+ # @return [Object] Deserialized data
124
+ def _deserialize(type, value)
125
+ case type.to_sym
126
+ when :DateTime
127
+ DateTime.parse(value)
128
+ when :Date
129
+ Date.parse(value)
130
+ when :String
131
+ value.to_s
132
+ when :Integer
133
+ value.to_i
134
+ when :Float
135
+ value.to_f
136
+ when :Boolean
137
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
138
+ true
139
+ else
140
+ false
141
+ end
142
+ when :Object
143
+ # generic object (usually a Hash), return directly
144
+ value
145
+ when /\AArray<(?<inner_type>.+)>\z/
146
+ inner_type = Regexp.last_match[:inner_type]
147
+ value.map { |v| _deserialize(inner_type, v) }
148
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
149
+ k_type = Regexp.last_match[:k_type]
150
+ v_type = Regexp.last_match[:v_type]
151
+ {}.tap do |hash|
152
+ value.each do |k, v|
153
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
154
+ end
155
+ end
156
+ else # model
157
+ FtcEventsClient.const_get(type).build_from_hash(value)
158
+ end
159
+ end
160
+
161
+ # Returns the string representation of the object
162
+ # @return [String] String presentation of the object
163
+ def to_s
164
+ to_hash.to_s
165
+ end
166
+
167
+ # to_body is an alias to to_hash (backward compatibility)
168
+ # @return [Hash] Returns the object in the form of hash
169
+ def to_body
170
+ to_hash
171
+ end
172
+
173
+ # Returns the object in the form of hash
174
+ # @return [Hash] Returns the object in the form of hash
175
+ def to_hash
176
+ hash = {}
177
+ self.class.attribute_map.each_pair do |attr, param|
178
+ value = self.send(attr)
179
+ if value.nil?
180
+ is_nullable = self.class.openapi_nullable.include?(attr)
181
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
182
+ end
183
+
184
+ hash[param] = _to_hash(value)
185
+ end
186
+ hash
187
+ end
188
+
189
+ # Outputs non-array value in the form of hash
190
+ # For object, use to_hash. Otherwise, just return the value
191
+ # @param [Object] value Any valid value
192
+ # @return [Hash] Returns the value in the form of hash
193
+ def _to_hash(value)
194
+ if value.is_a?(Array)
195
+ value.compact.map { |v| _to_hash(v) }
196
+ elsif value.is_a?(Hash)
197
+ {}.tap do |hash|
198
+ value.each { |k, v| hash[k] = _to_hash(v) }
199
+ end
200
+ elsif value.respond_to? :to_hash
201
+ value.to_hash
202
+ else
203
+ value
204
+ end
205
+ end end
206
+ end
@@ -0,0 +1,33 @@
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 Dimension
16
+ POINT = 'Point'.freeze
17
+ CURVE = 'Curve'.freeze
18
+ SURFACE = 'Surface'.freeze
19
+ COLLAPSE = 'Collapse'.freeze
20
+ DONTCARE = 'Dontcare'.freeze
21
+ TRUE = 'True'.freeze
22
+ FALSE = 'False'.freeze
23
+
24
+ # Builds the enum from string
25
+ # @param [String] The enum value in the form of the string
26
+ # @return [String] The enum value
27
+ def build_from_hash(value)
28
+ constantValues = Dimension.constants.select { |c| Dimension::const_get(c) == value }
29
+ raise "Invalid ENUM value #{value} for class #Dimension" if constantValues.empty?
30
+ value
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,29 @@
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 EndGameLocation
16
+ NONE = 'NONE'.freeze
17
+ BACKSTAGE = 'BACKSTAGE'.freeze
18
+ RIGGING = 'RIGGING'.freeze
19
+
20
+ # Builds the enum from string
21
+ # @param [String] The enum value in the form of the string
22
+ # @return [String] The enum value
23
+ def build_from_hash(value)
24
+ constantValues = EndGameLocation.constants.select { |c| EndGameLocation::const_get(c) == value }
25
+ raise "Invalid ENUM value #{value} for class #EndGameLocation" if constantValues.empty?
26
+ value
27
+ end
28
+ end
29
+ end
@@ -6,7 +6,7 @@
6
6
  OpenAPI spec version: v2.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.29
9
+ Swagger Codegen version: 3.0.52
10
10
  =end
11
11
 
12
12
  require 'date'