ftc_events_client 0.2.2 → 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 +3 -13
  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,245 @@
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 ScoreDetailModel2022
16
+ attr_accessor :match_level
17
+
18
+ attr_accessor :match_series
19
+
20
+ attr_accessor :match_number
21
+
22
+ attr_accessor :randomization
23
+
24
+ attr_accessor :alliances
25
+
26
+ # Attribute mapping from ruby-style variable name to JSON key.
27
+ def self.attribute_map
28
+ {
29
+ :'match_level' => :'matchLevel',
30
+ :'match_series' => :'matchSeries',
31
+ :'match_number' => :'matchNumber',
32
+ :'randomization' => :'randomization',
33
+ :'alliances' => :'alliances'
34
+ }
35
+ end
36
+
37
+ # Attribute type mapping.
38
+ def self.openapi_types
39
+ {
40
+ :'match_level' => :'Object',
41
+ :'match_series' => :'Object',
42
+ :'match_number' => :'Object',
43
+ :'randomization' => :'Object',
44
+ :'alliances' => :'Object'
45
+ }
46
+ end
47
+
48
+ # List of attributes with nullable: true
49
+ def self.openapi_nullable
50
+ Set.new([
51
+ :'alliances'
52
+ ])
53
+ end
54
+
55
+ # Initializes the object
56
+ # @param [Hash] attributes Model attributes in the form of hash
57
+ def initialize(attributes = {})
58
+ if (!attributes.is_a?(Hash))
59
+ fail ArgumentError, "The input argument (attributes) must be a hash in `FtcEventsClient::ScoreDetailModel2022` initialize method"
60
+ end
61
+
62
+ # check to see if the attribute exists and convert string to symbol for hash key
63
+ attributes = attributes.each_with_object({}) { |(k, v), h|
64
+ if (!self.class.attribute_map.key?(k.to_sym))
65
+ fail ArgumentError, "`#{k}` is not a valid attribute in `FtcEventsClient::ScoreDetailModel2022`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
66
+ end
67
+ h[k.to_sym] = v
68
+ }
69
+
70
+ if attributes.key?(:'match_level')
71
+ self.match_level = attributes[:'match_level']
72
+ end
73
+
74
+ if attributes.key?(:'match_series')
75
+ self.match_series = attributes[:'match_series']
76
+ end
77
+
78
+ if attributes.key?(:'match_number')
79
+ self.match_number = attributes[:'match_number']
80
+ end
81
+
82
+ if attributes.key?(:'randomization')
83
+ self.randomization = attributes[:'randomization']
84
+ end
85
+
86
+ if attributes.key?(:'alliances')
87
+ if (value = attributes[:'alliances']).is_a?(Array)
88
+ self.alliances = value
89
+ end
90
+ end
91
+ end
92
+
93
+ # Show invalid properties with the reasons. Usually used together with valid?
94
+ # @return Array for valid properties with the reasons
95
+ def list_invalid_properties
96
+ invalid_properties = Array.new
97
+ invalid_properties
98
+ end
99
+
100
+ # Check to see if the all the properties in the model are valid
101
+ # @return true if the model is valid
102
+ def valid?
103
+ true
104
+ end
105
+
106
+ # Checks equality by comparing each attribute.
107
+ # @param [Object] Object to be compared
108
+ def ==(o)
109
+ return true if self.equal?(o)
110
+ self.class == o.class &&
111
+ match_level == o.match_level &&
112
+ match_series == o.match_series &&
113
+ match_number == o.match_number &&
114
+ randomization == o.randomization &&
115
+ alliances == o.alliances
116
+ end
117
+
118
+ # @see the `==` method
119
+ # @param [Object] Object to be compared
120
+ def eql?(o)
121
+ self == o
122
+ end
123
+
124
+ # Calculates hash code according to all attributes.
125
+ # @return [Integer] Hash code
126
+ def hash
127
+ [match_level, match_series, match_number, randomization, alliances].hash
128
+ end
129
+
130
+ # Builds the object from hash
131
+ # @param [Hash] attributes Model attributes in the form of hash
132
+ # @return [Object] Returns the model itself
133
+ def self.build_from_hash(attributes)
134
+ new.build_from_hash(attributes)
135
+ end
136
+
137
+ # Builds the object from hash
138
+ # @param [Hash] attributes Model attributes in the form of hash
139
+ # @return [Object] Returns the model itself
140
+ def build_from_hash(attributes)
141
+ return nil unless attributes.is_a?(Hash)
142
+ self.class.openapi_types.each_pair do |key, type|
143
+ if type =~ /\AArray<(.*)>/i
144
+ # check to ensure the input is an array given that the attribute
145
+ # is documented as an array but the input is not
146
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
147
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
148
+ end
149
+ elsif !attributes[self.class.attribute_map[key]].nil?
150
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
151
+ elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
152
+ self.send("#{key}=", nil)
153
+ end
154
+ end
155
+
156
+ self
157
+ end
158
+
159
+ # Deserializes the data based on type
160
+ # @param string type Data type
161
+ # @param string value Value to be deserialized
162
+ # @return [Object] Deserialized data
163
+ def _deserialize(type, value)
164
+ case type.to_sym
165
+ when :DateTime
166
+ DateTime.parse(value)
167
+ when :Date
168
+ Date.parse(value)
169
+ when :String
170
+ value.to_s
171
+ when :Integer
172
+ value.to_i
173
+ when :Float
174
+ value.to_f
175
+ when :Boolean
176
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
177
+ true
178
+ else
179
+ false
180
+ end
181
+ when :Object
182
+ # generic object (usually a Hash), return directly
183
+ value
184
+ when /\AArray<(?<inner_type>.+)>\z/
185
+ inner_type = Regexp.last_match[:inner_type]
186
+ value.map { |v| _deserialize(inner_type, v) }
187
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
188
+ k_type = Regexp.last_match[:k_type]
189
+ v_type = Regexp.last_match[:v_type]
190
+ {}.tap do |hash|
191
+ value.each do |k, v|
192
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
193
+ end
194
+ end
195
+ else # model
196
+ FtcEventsClient.const_get(type).build_from_hash(value)
197
+ end
198
+ end
199
+
200
+ # Returns the string representation of the object
201
+ # @return [String] String presentation of the object
202
+ def to_s
203
+ to_hash.to_s
204
+ end
205
+
206
+ # to_body is an alias to to_hash (backward compatibility)
207
+ # @return [Hash] Returns the object in the form of hash
208
+ def to_body
209
+ to_hash
210
+ end
211
+
212
+ # Returns the object in the form of hash
213
+ # @return [Hash] Returns the object in the form of hash
214
+ def to_hash
215
+ hash = {}
216
+ self.class.attribute_map.each_pair do |attr, param|
217
+ value = self.send(attr)
218
+ if value.nil?
219
+ is_nullable = self.class.openapi_nullable.include?(attr)
220
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
221
+ end
222
+
223
+ hash[param] = _to_hash(value)
224
+ end
225
+ hash
226
+ end
227
+
228
+ # Outputs non-array value in the form of hash
229
+ # For object, use to_hash. Otherwise, just return the value
230
+ # @param [Object] value Any valid value
231
+ # @return [Hash] Returns the value in the form of hash
232
+ def _to_hash(value)
233
+ if value.is_a?(Array)
234
+ value.compact.map { |v| _to_hash(v) }
235
+ elsif value.is_a?(Hash)
236
+ {}.tap do |hash|
237
+ value.each { |k, v| hash[k] = _to_hash(v) }
238
+ end
239
+ elsif value.respond_to? :to_hash
240
+ value.to_hash
241
+ else
242
+ value
243
+ end
244
+ end end
245
+ end
@@ -0,0 +1,245 @@
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 ScoreDetailModel2023
16
+ attr_accessor :match_level
17
+
18
+ attr_accessor :match_series
19
+
20
+ attr_accessor :match_number
21
+
22
+ attr_accessor :randomization
23
+
24
+ attr_accessor :alliances
25
+
26
+ # Attribute mapping from ruby-style variable name to JSON key.
27
+ def self.attribute_map
28
+ {
29
+ :'match_level' => :'matchLevel',
30
+ :'match_series' => :'matchSeries',
31
+ :'match_number' => :'matchNumber',
32
+ :'randomization' => :'randomization',
33
+ :'alliances' => :'alliances'
34
+ }
35
+ end
36
+
37
+ # Attribute type mapping.
38
+ def self.openapi_types
39
+ {
40
+ :'match_level' => :'Object',
41
+ :'match_series' => :'Object',
42
+ :'match_number' => :'Object',
43
+ :'randomization' => :'Object',
44
+ :'alliances' => :'Object'
45
+ }
46
+ end
47
+
48
+ # List of attributes with nullable: true
49
+ def self.openapi_nullable
50
+ Set.new([
51
+ :'alliances'
52
+ ])
53
+ end
54
+
55
+ # Initializes the object
56
+ # @param [Hash] attributes Model attributes in the form of hash
57
+ def initialize(attributes = {})
58
+ if (!attributes.is_a?(Hash))
59
+ fail ArgumentError, "The input argument (attributes) must be a hash in `FtcEventsClient::ScoreDetailModel2023` initialize method"
60
+ end
61
+
62
+ # check to see if the attribute exists and convert string to symbol for hash key
63
+ attributes = attributes.each_with_object({}) { |(k, v), h|
64
+ if (!self.class.attribute_map.key?(k.to_sym))
65
+ fail ArgumentError, "`#{k}` is not a valid attribute in `FtcEventsClient::ScoreDetailModel2023`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
66
+ end
67
+ h[k.to_sym] = v
68
+ }
69
+
70
+ if attributes.key?(:'match_level')
71
+ self.match_level = attributes[:'match_level']
72
+ end
73
+
74
+ if attributes.key?(:'match_series')
75
+ self.match_series = attributes[:'match_series']
76
+ end
77
+
78
+ if attributes.key?(:'match_number')
79
+ self.match_number = attributes[:'match_number']
80
+ end
81
+
82
+ if attributes.key?(:'randomization')
83
+ self.randomization = attributes[:'randomization']
84
+ end
85
+
86
+ if attributes.key?(:'alliances')
87
+ if (value = attributes[:'alliances']).is_a?(Array)
88
+ self.alliances = value
89
+ end
90
+ end
91
+ end
92
+
93
+ # Show invalid properties with the reasons. Usually used together with valid?
94
+ # @return Array for valid properties with the reasons
95
+ def list_invalid_properties
96
+ invalid_properties = Array.new
97
+ invalid_properties
98
+ end
99
+
100
+ # Check to see if the all the properties in the model are valid
101
+ # @return true if the model is valid
102
+ def valid?
103
+ true
104
+ end
105
+
106
+ # Checks equality by comparing each attribute.
107
+ # @param [Object] Object to be compared
108
+ def ==(o)
109
+ return true if self.equal?(o)
110
+ self.class == o.class &&
111
+ match_level == o.match_level &&
112
+ match_series == o.match_series &&
113
+ match_number == o.match_number &&
114
+ randomization == o.randomization &&
115
+ alliances == o.alliances
116
+ end
117
+
118
+ # @see the `==` method
119
+ # @param [Object] Object to be compared
120
+ def eql?(o)
121
+ self == o
122
+ end
123
+
124
+ # Calculates hash code according to all attributes.
125
+ # @return [Integer] Hash code
126
+ def hash
127
+ [match_level, match_series, match_number, randomization, alliances].hash
128
+ end
129
+
130
+ # Builds the object from hash
131
+ # @param [Hash] attributes Model attributes in the form of hash
132
+ # @return [Object] Returns the model itself
133
+ def self.build_from_hash(attributes)
134
+ new.build_from_hash(attributes)
135
+ end
136
+
137
+ # Builds the object from hash
138
+ # @param [Hash] attributes Model attributes in the form of hash
139
+ # @return [Object] Returns the model itself
140
+ def build_from_hash(attributes)
141
+ return nil unless attributes.is_a?(Hash)
142
+ self.class.openapi_types.each_pair do |key, type|
143
+ if type =~ /\AArray<(.*)>/i
144
+ # check to ensure the input is an array given that the attribute
145
+ # is documented as an array but the input is not
146
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
147
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
148
+ end
149
+ elsif !attributes[self.class.attribute_map[key]].nil?
150
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
151
+ elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
152
+ self.send("#{key}=", nil)
153
+ end
154
+ end
155
+
156
+ self
157
+ end
158
+
159
+ # Deserializes the data based on type
160
+ # @param string type Data type
161
+ # @param string value Value to be deserialized
162
+ # @return [Object] Deserialized data
163
+ def _deserialize(type, value)
164
+ case type.to_sym
165
+ when :DateTime
166
+ DateTime.parse(value)
167
+ when :Date
168
+ Date.parse(value)
169
+ when :String
170
+ value.to_s
171
+ when :Integer
172
+ value.to_i
173
+ when :Float
174
+ value.to_f
175
+ when :Boolean
176
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
177
+ true
178
+ else
179
+ false
180
+ end
181
+ when :Object
182
+ # generic object (usually a Hash), return directly
183
+ value
184
+ when /\AArray<(?<inner_type>.+)>\z/
185
+ inner_type = Regexp.last_match[:inner_type]
186
+ value.map { |v| _deserialize(inner_type, v) }
187
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
188
+ k_type = Regexp.last_match[:k_type]
189
+ v_type = Regexp.last_match[:v_type]
190
+ {}.tap do |hash|
191
+ value.each do |k, v|
192
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
193
+ end
194
+ end
195
+ else # model
196
+ FtcEventsClient.const_get(type).build_from_hash(value)
197
+ end
198
+ end
199
+
200
+ # Returns the string representation of the object
201
+ # @return [String] String presentation of the object
202
+ def to_s
203
+ to_hash.to_s
204
+ end
205
+
206
+ # to_body is an alias to to_hash (backward compatibility)
207
+ # @return [Hash] Returns the object in the form of hash
208
+ def to_body
209
+ to_hash
210
+ end
211
+
212
+ # Returns the object in the form of hash
213
+ # @return [Hash] Returns the object in the form of hash
214
+ def to_hash
215
+ hash = {}
216
+ self.class.attribute_map.each_pair do |attr, param|
217
+ value = self.send(attr)
218
+ if value.nil?
219
+ is_nullable = self.class.openapi_nullable.include?(attr)
220
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
221
+ end
222
+
223
+ hash[param] = _to_hash(value)
224
+ end
225
+ hash
226
+ end
227
+
228
+ # Outputs non-array value in the form of hash
229
+ # For object, use to_hash. Otherwise, just return the value
230
+ # @param [Object] value Any valid value
231
+ # @return [Hash] Returns the value in the form of hash
232
+ def _to_hash(value)
233
+ if value.is_a?(Array)
234
+ value.compact.map { |v| _to_hash(v) }
235
+ elsif value.is_a?(Hash)
236
+ {}.tap do |hash|
237
+ value.each { |k, v| hash[k] = _to_hash(v) }
238
+ end
239
+ elsif value.respond_to? :to_hash
240
+ value.to_hash
241
+ else
242
+ value
243
+ end
244
+ end end
245
+ 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'
@@ -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'
@@ -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'
@@ -17,6 +17,8 @@ module FtcEventsClient
17
17
 
18
18
  attr_accessor :match_number
19
19
 
20
+ attr_accessor :randomization
21
+
20
22
  attr_accessor :team_number
21
23
 
22
24
  attr_accessor :scores
@@ -26,6 +28,7 @@ module FtcEventsClient
26
28
  {
27
29
  :'match_level' => :'matchLevel',
28
30
  :'match_number' => :'matchNumber',
31
+ :'randomization' => :'randomization',
29
32
  :'team_number' => :'teamNumber',
30
33
  :'scores' => :'scores'
31
34
  }
@@ -36,6 +39,7 @@ module FtcEventsClient
36
39
  {
37
40
  :'match_level' => :'Object',
38
41
  :'match_number' => :'Object',
42
+ :'randomization' => :'Object',
39
43
  :'team_number' => :'Object',
40
44
  :'scores' => :'Object'
41
45
  }
@@ -70,6 +74,10 @@ module FtcEventsClient
70
74
  self.match_number = attributes[:'match_number']
71
75
  end
72
76
 
77
+ if attributes.key?(:'randomization')
78
+ self.randomization = attributes[:'randomization']
79
+ end
80
+
73
81
  if attributes.key?(:'team_number')
74
82
  self.team_number = attributes[:'team_number']
75
83
  end
@@ -99,6 +107,7 @@ module FtcEventsClient
99
107
  self.class == o.class &&
100
108
  match_level == o.match_level &&
101
109
  match_number == o.match_number &&
110
+ randomization == o.randomization &&
102
111
  team_number == o.team_number &&
103
112
  scores == o.scores
104
113
  end
@@ -112,7 +121,7 @@ module FtcEventsClient
112
121
  # Calculates hash code according to all attributes.
113
122
  # @return [Integer] Hash code
114
123
  def hash
115
- [match_level, match_number, team_number, scores].hash
124
+ [match_level, match_number, randomization, team_number, scores].hash
116
125
  end
117
126
 
118
127
  # Builds the object from hash