ftc_api_v3_client 0.1.0

data/docs/ApiV3SelectionOperation.md

@@ -0,0 +1,15 @@
+# FtcApiV3Client::ApiV3SelectionOperation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3SelectionOperation.new()
+```
+

data/docs/ApiV3SeriesAllianceDescription.md

@@ -0,0 +1,22 @@
+# FtcApiV3Client::ApiV3SeriesAllianceDescription
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **series_id** | **Integer** |  |  |
+| **state** | [**ApiV3SeriesAllianceState**](ApiV3SeriesAllianceState.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3SeriesAllianceDescription.new(
+  type: null,
+  series_id: null,
+  state: null
+)
+```
+

data/docs/ApiV3SeriesAllianceState.md

@@ -0,0 +1,15 @@
+# FtcApiV3Client::ApiV3SeriesAllianceState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3SeriesAllianceState.new()
+```
+

data/docs/ApiV3SimpleEvent.md

@@ -0,0 +1,48 @@
+# FtcApiV3Client::ApiV3SimpleEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  |  |
+| **name** | **String** |  |  |
+| **type** | [**ApiV3EventType**](ApiV3EventType.md) |  |  |
+| **format** | [**ApiV3EventFormat**](ApiV3EventFormat.md) |  |  |
+| **start_date** | **Date** |  |  |
+| **end_date** | **Date** |  |  |
+| **region_code** | **String** |  |  |
+| **venue** | **String** |  | [optional] |
+| **street_address** | **String** |  | [optional] |
+| **street_address2** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+| **website** | **String** |  | [optional] |
+| **published** | **Boolean** |  |  |
+| **timezone** | **String** | All timestamps related to the event are exposed in the API as local date/times in the event timezone |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3SimpleEvent.new(
+  code: null,
+  name: null,
+  type: null,
+  format: null,
+  start_date: null,
+  end_date: null,
+  region_code: null,
+  venue: null,
+  street_address: null,
+  street_address2: null,
+  city: null,
+  state: null,
+  country: null,
+  website: null,
+  published: null,
+  timezone: null
+)
+```
+

data/docs/ApiV3SimpleTeam.md

@@ -0,0 +1,22 @@
+# FtcApiV3Client::ApiV3SimpleTeam
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **number** | **String** |  |  |
+| **name** | **String** |  |  |
+| **display_number** | **String** | Use this for presentation purposes; it may include a shorter representation of the official team number for some teams in some seasons. |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3SimpleTeam.new(
+  number: null,
+  name: null,
+  display_number: null
+)
+```
+

data/docs/ApiV3SingleAwardRecipient.md

@@ -0,0 +1,30 @@
+# FtcApiV3Client::ApiV3SingleAwardRecipient
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ApiV3AwardType**](ApiV3AwardType.md) |  |  |
+| **name** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **ordered** | **Boolean** |  |  |
+| **individual** | **Boolean** |  |  |
+| **sub_name** | **String** | For division awards (e.g. winner/finalist), the division name. For conference awards from POWERPLAY championship, the conference name. Null otherwise. | [optional] |
+| **place** | **Integer** | Only populated for awards that are ordered | [optional] |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3SingleAwardRecipient.new(
+  type: null,
+  name: null,
+  description: null,
+  ordered: null,
+  individual: null,
+  sub_name: null,
+  place: null
+)
+```
+

data/docs/ApiV3SingleTeamMatch.md

@@ -0,0 +1,44 @@
+# FtcApiV3Client::ApiV3SingleTeamMatch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **short_name** | **String** |  |  |
+| **field** | **Integer** |  |  |
+| **tournament_level** | [**ApiV3TournamentLevel**](ApiV3TournamentLevel.md) |  |  |
+| **scheduled_start_time** | **Time** |  | [optional] |
+| **start_time** | **Time** |  | [optional] |
+| **post_time** | **Time** |  | [optional] |
+| **random** | **Integer** |  | [optional] |
+| **display_name** | **String** | For display purposes. May include event-specific customization and therefore may not match for equivalent matches between events. |  |
+| **series** | **Integer** | For practice and qualification matches, this is always 0. For playoff matches, the series number as described in the playoff structure object. |  |
+| **number** | **Integer** | For practice and qualification matches, the number of the match as shown on the schedule. For playoff matches, the number within the series (almost always 1 for double-elimination). |  |
+| **commit_time** | **Time** | The time the match was last committed. This can change after initial commit/post and can be used to determine if match details are stale. | [optional] |
+| **match_results** | [**ApiV3SingleTeamMatchResults**](ApiV3SingleTeamMatchResults.md) |  | [optional] |
+| **teams** | [**ApiV3SingleTeamMatchParticipants**](ApiV3SingleTeamMatchParticipants.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3SingleTeamMatch.new(
+  type: null,
+  short_name: null,
+  field: null,
+  tournament_level: null,
+  scheduled_start_time: null,
+  start_time: null,
+  post_time: null,
+  random: null,
+  display_name: null,
+  series: null,
+  number: null,
+  commit_time: null,
+  match_results: null,
+  teams: null
+)
+```
+

data/docs/ApiV3SingleTeamMatchDetails.md

@@ -0,0 +1,46 @@
+# FtcApiV3Client::ApiV3SingleTeamMatchDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **short_name** | **String** |  |  |
+| **field** | **Integer** |  |  |
+| **tournament_level** | [**ApiV3TournamentLevel**](ApiV3TournamentLevel.md) |  |  |
+| **scheduled_start_time** | **Time** |  | [optional] |
+| **start_time** | **Time** |  | [optional] |
+| **post_time** | **Time** |  | [optional] |
+| **random** | **Integer** |  | [optional] |
+| **display_name** | **String** | For display purposes. May include event-specific customization and therefore may not match for equivalent matches between events. |  |
+| **series** | **Integer** | For practice and qualification matches, this is always 0. For playoff matches, the series number as described in the playoff structure object. |  |
+| **number** | **Integer** | For practice and qualification matches, the number of the match as shown on the schedule. For playoff matches, the number within the series (almost always 1 for double-elimination). |  |
+| **commit_time** | **Time** | The time the match was last committed. This can change after initial commit/post and can be used to determine if match details are stale. | [optional] |
+| **match_results** | [**ApiV3SingleTeamMatchResults**](ApiV3SingleTeamMatchResults.md) |  | [optional] |
+| **teams** | [**ApiV3SingleTeamMatchParticipants**](ApiV3SingleTeamMatchParticipants.md) |  |  |
+| **match_results_details** | [**ApiV3SingleTeamMatchResultsDetails**](ApiV3SingleTeamMatchResultsDetails.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3SingleTeamMatchDetails.new(
+  type: null,
+  short_name: null,
+  field: null,
+  tournament_level: null,
+  scheduled_start_time: null,
+  start_time: null,
+  post_time: null,
+  random: null,
+  display_name: null,
+  series: null,
+  number: null,
+  commit_time: null,
+  match_results: null,
+  teams: null,
+  match_results_details: null
+)
+```
+

data/docs/ApiV3SingleTeamMatchParticipants.md

@@ -0,0 +1,18 @@
+# FtcApiV3Client::ApiV3SingleTeamMatchParticipants
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team** | [**ApiV3MatchTeam**](ApiV3MatchTeam.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3SingleTeamMatchParticipants.new(
+  team: null
+)
+```
+

data/docs/ApiV3SingleTeamMatchResults.md

@@ -0,0 +1,18 @@
+# FtcApiV3Client::ApiV3SingleTeamMatchResults
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **score** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3SingleTeamMatchResults.new(
+  score: null
+)
+```
+

data/docs/ApiV3SingleTeamMatchResultsDetails.md

@@ -0,0 +1,18 @@
+# FtcApiV3Client::ApiV3SingleTeamMatchResultsDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **details** | [**ApiV3RemoteScoreDetail**](ApiV3RemoteScoreDetail.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3SingleTeamMatchResultsDetails.new(
+  details: null
+)
+```
+

data/docs/ApiV3SkystoneAchievementsDetail.md

@@ -0,0 +1,54 @@
+# FtcApiV3Client::ApiV3SkystoneAchievementsDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **robot1_navigated** | **Boolean** |  |  |
+| **robot2_navigated** | **Boolean** |  |  |
+| **auto_stones** | [**Array<ApiV3Stone>**](ApiV3Stone.md) |  |  |
+| **auto_delivered** | **Integer** |  |  |
+| **auto_returned** | **Integer** |  |  |
+| **auto_placed** | **Integer** |  |  |
+| **first_returned_is_skystone** | **Boolean** |  |  |
+| **foundation_repositioned** | **Boolean** |  |  |
+| **driver_controlled_delivered** | **Integer** |  |  |
+| **driver_controlled_returned** | **Integer** |  |  |
+| **driver_controlled_placed** | **Integer** |  |  |
+| **tallest_skyscraper** | **Integer** |  |  |
+| **robot1_parked** | **Boolean** |  |  |
+| **robot2_parked** | **Boolean** |  |  |
+| **robot1_capstone_level** | **Integer** |  |  |
+| **robot2_capstone_level** | **Integer** |  |  |
+| **foundation_moved** | **Boolean** |  |  |
+| **minor_penalties** | **Integer** |  |  |
+| **major_penalties** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3SkystoneAchievementsDetail.new(
+  robot1_navigated: null,
+  robot2_navigated: null,
+  auto_stones: null,
+  auto_delivered: null,
+  auto_returned: null,
+  auto_placed: null,
+  first_returned_is_skystone: null,
+  foundation_repositioned: null,
+  driver_controlled_delivered: null,
+  driver_controlled_returned: null,
+  driver_controlled_placed: null,
+  tallest_skyscraper: null,
+  robot1_parked: null,
+  robot2_parked: null,
+  robot1_capstone_level: null,
+  robot2_capstone_level: null,
+  foundation_moved: null,
+  minor_penalties: null,
+  major_penalties: null
+)
+```
+

data/docs/ApiV3SkystonePointsDetail.md

@@ -0,0 +1,46 @@
+# FtcApiV3Client::ApiV3SkystonePointsDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_delivery_points** | **Integer** |  |  |
+| **auto_placed_points** | **Integer** |  |  |
+| **repositioned_points** | **Integer** |  |  |
+| **navigation_points** | **Integer** |  |  |
+| **driver_controlled_delivery_points** | **Integer** |  |  |
+| **driver_controlled_placed_points** | **Integer** |  |  |
+| **skyscraper_bonus_points** | **Integer** |  |  |
+| **capstone_points** | **Integer** |  |  |
+| **parking_points** | **Integer** |  |  |
+| **autonomous_points** | **Integer** |  |  |
+| **driver_controlled_points** | **Integer** |  |  |
+| **end_game_points** | **Integer** |  |  |
+| **penalty_points** | **Integer** |  |  |
+| **total_points** | **Integer** |  |  |
+| **adjust_points** | **Integer** | Used to indicate the winner in double-red-card playoff matches |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3SkystonePointsDetail.new(
+  auto_delivery_points: null,
+  auto_placed_points: null,
+  repositioned_points: null,
+  navigation_points: null,
+  driver_controlled_delivery_points: null,
+  driver_controlled_placed_points: null,
+  skyscraper_bonus_points: null,
+  capstone_points: null,
+  parking_points: null,
+  autonomous_points: null,
+  driver_controlled_points: null,
+  end_game_points: null,
+  penalty_points: null,
+  total_points: null,
+  adjust_points: null
+)
+```
+

data/docs/ApiV3SkystoneScoreDetail.md

@@ -0,0 +1,22 @@
+# FtcApiV3Client::ApiV3SkystoneScoreDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **achievements** | [**ApiV3SkystoneAchievementsDetail**](ApiV3SkystoneAchievementsDetail.md) |  |  |
+| **points** | [**ApiV3SkystonePointsDetail**](ApiV3SkystonePointsDetail.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3SkystoneScoreDetail.new(
+  type: null,
+  achievements: null,
+  points: null
+)
+```
+

data/docs/ApiV3Stone.md

@@ -0,0 +1,15 @@
+# FtcApiV3Client::ApiV3Stone
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3Stone.new()
+```
+

data/docs/ApiV3Team.md

@@ -0,0 +1,38 @@
+# FtcApiV3Client::ApiV3Team
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **number** | **String** |  |  |
+| **name** | **String** |  |  |
+| **affiliations** | **String** |  |  |
+| **city** | **String** |  | [optional] |
+| **state_prov** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+| **rookie_cmp_year** | **Integer** |  |  |
+| **website** | **String** |  | [optional] |
+| **home_region_code** | **String** |  | [optional] |
+| **display_number** | **String** | Use this for presentation purposes; it may include a shorter representation of the official team number for some teams in some seasons. |  |
+| **coordinates** | [**ApiV3Coordinates**](ApiV3Coordinates.md) | Coordinates are for the team's city | [optional] |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3Team.new(
+  number: null,
+  name: null,
+  affiliations: null,
+  city: null,
+  state_prov: null,
+  country: null,
+  rookie_cmp_year: null,
+  website: null,
+  home_region_code: null,
+  display_number: null,
+  coordinates: null
+)
+```
+

data/docs/ApiV3TeamAvatar.md

@@ -0,0 +1,20 @@
+# FtcApiV3Client::ApiV3TeamAvatar
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team** | [**ApiV3SimpleTeam**](ApiV3SimpleTeam.md) |  |  |
+| **avatar_url** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3TeamAvatar.new(
+  team: null,
+  avatar_url: null
+)
+```
+

data/docs/ApiV3TeamAvatars.md

@@ -0,0 +1,18 @@
+# FtcApiV3Client::ApiV3TeamAvatars
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **avatars** | [**Array<ApiV3TeamAvatar>**](ApiV3TeamAvatar.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3TeamAvatars.new(
+  avatars: null
+)
+```
+

data/docs/ApiV3TeamDetails.md

@@ -0,0 +1,24 @@
+# FtcApiV3Client::ApiV3TeamDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team** | [**ApiV3Team**](ApiV3Team.md) |  |  |
+| **region** | [**ApiV3Region**](ApiV3Region.md) |  |  |
+| **events** | [**Array<ApiV3TeamEventParticipationDetails>**](ApiV3TeamEventParticipationDetails.md) |  |  |
+| **leagues** | [**Array<ApiV3LeagueMembershipDetails>**](ApiV3LeagueMembershipDetails.md) | In most cases, this list will have one entry, or possibly two where one is a child league of the other. If a region does unusual things, however, there can be more leagues listed. |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3TeamDetails.new(
+  team: null,
+  region: null,
+  events: null,
+  leagues: null
+)
+```
+

data/docs/ApiV3TeamEventParticipation.md

@@ -0,0 +1,20 @@
+# FtcApiV3Client::ApiV3TeamEventParticipation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | [**ApiV3SimpleEvent**](ApiV3SimpleEvent.md) |  |  |
+| **awards** | [**Array<ApiV3SingleAwardRecipient>**](ApiV3SingleAwardRecipient.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3TeamEventParticipation.new(
+  event: null,
+  awards: null
+)
+```
+

data/docs/ApiV3TeamEventParticipationDetails.md

@@ -0,0 +1,26 @@
+# FtcApiV3Client::ApiV3TeamEventParticipationDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | [**ApiV3SimpleEvent**](ApiV3SimpleEvent.md) |  |  |
+| **awards** | [**Array<ApiV3SingleAwardRecipient>**](ApiV3SingleAwardRecipient.md) |  |  |
+| **alliance** | [**ApiV3PlayoffAlliance**](ApiV3PlayoffAlliance.md) |  | [optional] |
+| **ranking** | [**ApiV3Ranking**](ApiV3Ranking.md) |  | [optional] |
+| **matches** | [**Array<ApiV3Match>**](ApiV3Match.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3TeamEventParticipationDetails.new(
+  event: null,
+  awards: null,
+  alliance: null,
+  ranking: null,
+  matches: null
+)
+```
+

data/docs/ApiV3TeamHistory.md

@@ -0,0 +1,36 @@
+# FtcApiV3Client::ApiV3TeamHistory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **number** | **String** |  |  |
+| **name** | **String** |  |  |
+| **affiliations** | **String** |  |  |
+| **city** | **String** |  | [optional] |
+| **state_prov** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+| **rookie_cmp_year** | **Integer** |  |  |
+| **seasons** | [**Array<ApiV3TeamSeasonHistory>**](ApiV3TeamSeasonHistory.md) |  |  |
+| **display_number** | **String** | Use this for presentation purposes; it may include a shorter representation of the official team number for some teams in some seasons. |  |
+| **coordinates** | [**ApiV3Coordinates**](ApiV3Coordinates.md) | Coordinates are for the team's city | [optional] |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3TeamHistory.new(
+  number: null,
+  name: null,
+  affiliations: null,
+  city: null,
+  state_prov: null,
+  country: null,
+  rookie_cmp_year: null,
+  seasons: null,
+  display_number: null,
+  coordinates: null
+)
+```
+

data/docs/ApiV3TeamSeasonHistory.md

@@ -0,0 +1,20 @@
+# FtcApiV3Client::ApiV3TeamSeasonHistory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **season** | [**ApiV3Season**](ApiV3Season.md) |  |  |
+| **events** | [**Array<ApiV3TeamEventParticipation>**](ApiV3TeamEventParticipation.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3TeamSeasonHistory.new(
+  season: null,
+  events: null
+)
+```
+

data/docs/ApiV3Teams.md

@@ -0,0 +1,18 @@
+# FtcApiV3Client::ApiV3Teams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **teams** | [**Array<ApiV3Team>**](ApiV3Team.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3Teams.new(
+  teams: null
+)
+```
+