ftc_api_v3_client 0.1.0

data/docs/ApiV3ItdAchievementsDetail.md

@@ -0,0 +1,48 @@
+# FtcApiV3Client::ApiV3ItdAchievementsDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **robot1_auto** | [**ApiV3ItdAutoLocation**](ApiV3ItdAutoLocation.md) |  |  |
+| **robot2_auto** | [**ApiV3ItdAutoLocation**](ApiV3ItdAutoLocation.md) |  |  |
+| **auto_sample_net** | **Integer** |  |  |
+| **auto_sample_low** | **Integer** |  |  |
+| **auto_sample_high** | **Integer** |  |  |
+| **auto_specimen_low** | **Integer** |  |  |
+| **auto_specimen_high** | **Integer** |  |  |
+| **teleop_sample_net** | **Integer** |  |  |
+| **teleop_sample_low** | **Integer** |  |  |
+| **teleop_sample_high** | **Integer** |  |  |
+| **teleop_specimen_low** | **Integer** |  |  |
+| **teleop_specimen_high** | **Integer** |  |  |
+| **robot1_teleop** | [**ApiV3ItdTeleopLocation**](ApiV3ItdTeleopLocation.md) |  |  |
+| **robot2_teleop** | [**ApiV3ItdTeleopLocation**](ApiV3ItdTeleopLocation.md) |  |  |
+| **minor_fouls** | **Integer** |  |  |
+| **major_fouls** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3ItdAchievementsDetail.new(
+  robot1_auto: null,
+  robot2_auto: null,
+  auto_sample_net: null,
+  auto_sample_low: null,
+  auto_sample_high: null,
+  auto_specimen_low: null,
+  auto_specimen_high: null,
+  teleop_sample_net: null,
+  teleop_sample_low: null,
+  teleop_sample_high: null,
+  teleop_specimen_low: null,
+  teleop_specimen_high: null,
+  robot1_teleop: null,
+  robot2_teleop: null,
+  minor_fouls: null,
+  major_fouls: null
+)
+```
+

data/docs/ApiV3ItdAutoLocation.md

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

data/docs/ApiV3ItdPointsDetail.md

@@ -0,0 +1,42 @@
+# FtcApiV3Client::ApiV3ItdPointsDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_sample_points** | **Integer** |  |  |
+| **auto_specimen_points** | **Integer** |  |  |
+| **auto_park_points** | **Integer** |  |  |
+| **auto_ascent_points** | **Integer** |  |  |
+| **teleop_sample_points** | **Integer** |  |  |
+| **teleop_specimen_points** | **Integer** |  |  |
+| **teleop_park_points** | **Integer** |  |  |
+| **teleop_ascent_points** | **Integer** |  |  |
+| **auto_points** | **Integer** |  |  |
+| **teleop_points** | **Integer** |  |  |
+| **foul_points_committed** | **Integer** |  |  |
+| **pre_foul_total** | **Integer** |  |  |
+| **adjust_points** | **Integer** | Used to indicate the winner in double-red-card playoff matches |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3ItdPointsDetail.new(
+  auto_sample_points: null,
+  auto_specimen_points: null,
+  auto_park_points: null,
+  auto_ascent_points: null,
+  teleop_sample_points: null,
+  teleop_specimen_points: null,
+  teleop_park_points: null,
+  teleop_ascent_points: null,
+  auto_points: null,
+  teleop_points: null,
+  foul_points_committed: null,
+  pre_foul_total: null,
+  adjust_points: null
+)
+```
+

data/docs/ApiV3ItdTeleopLocation.md

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

data/docs/ApiV3JunctionElement.md

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

data/docs/ApiV3League.md

@@ -0,0 +1,26 @@
+# FtcApiV3Client::ApiV3League
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  |  |
+| **name** | **String** |  |  |
+| **remote** | **Boolean** |  | [optional] |
+| **location** | **String** |  | [optional] |
+| **parent_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3League.new(
+  code: null,
+  name: null,
+  remote: null,
+  location: null,
+  parent_code: null
+)
+```
+

data/docs/ApiV3LeagueDetails.md

@@ -0,0 +1,28 @@
+# FtcApiV3Client::ApiV3LeagueDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  |  |
+| **name** | **String** |  |  |
+| **remote** | **Boolean** |  | [optional] |
+| **location** | **String** |  | [optional] |
+| **parent_code** | **String** |  | [optional] |
+| **children** | [**Array<ApiV3League>**](ApiV3League.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3LeagueDetails.new(
+  code: null,
+  name: null,
+  remote: null,
+  location: null,
+  parent_code: null,
+  children: null
+)
+```
+

data/docs/ApiV3LeagueMembershipDetails.md

@@ -0,0 +1,20 @@
+# FtcApiV3Client::ApiV3LeagueMembershipDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **league** | [**ApiV3League**](ApiV3League.md) |  |  |
+| **ranking** | [**ApiV3Ranking**](ApiV3Ranking.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3LeagueMembershipDetails.new(
+  league: null,
+  ranking: null
+)
+```
+

data/docs/ApiV3Leagues.md

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

data/docs/ApiV3Match.md

@@ -0,0 +1,79 @@
+# FtcApiV3Client::ApiV3Match
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+FtcApiV3Client::ApiV3Match.openapi_one_of
+# =>
+# [
+#   :'ApiV3AllianceMatch',
+#   :'ApiV3SingleTeamMatch'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+FtcApiV3Client::ApiV3Match.openapi_discriminator_name
+# => :'type'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+FtcApiV3Client::ApiV3Match.openapi_discriminator_mapping
+# =>
+# {
+#   :'ApiV3AllianceMatch' => :'ApiV3AllianceMatch',
+#   :'ApiV3SingleTeamMatch' => :'ApiV3SingleTeamMatch'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+FtcApiV3Client::ApiV3Match.build(data)
+# => #<ApiV3AllianceMatch:0x00007fdd4aab02a0>
+
+FtcApiV3Client::ApiV3Match.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ApiV3AllianceMatch`
+- `ApiV3SingleTeamMatch`
+- `nil` (if no type matches)
+

data/docs/ApiV3MatchAlliance.md

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

data/docs/ApiV3MatchDetails.md

@@ -0,0 +1,79 @@
+# FtcApiV3Client::ApiV3MatchDetails
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+FtcApiV3Client::ApiV3MatchDetails.openapi_one_of
+# =>
+# [
+#   :'ApiV3AllianceMatchDetails',
+#   :'ApiV3SingleTeamMatchDetails'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+FtcApiV3Client::ApiV3MatchDetails.openapi_discriminator_name
+# => :'type'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+FtcApiV3Client::ApiV3MatchDetails.openapi_discriminator_mapping
+# =>
+# {
+#   :'ApiV3AllianceMatchDetails' => :'ApiV3AllianceMatchDetails',
+#   :'ApiV3SingleTeamMatchDetails' => :'ApiV3SingleTeamMatchDetails'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+FtcApiV3Client::ApiV3MatchDetails.build(data)
+# => #<ApiV3AllianceMatchDetails:0x00007fdd4aab02a0>
+
+FtcApiV3Client::ApiV3MatchDetails.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ApiV3AllianceMatchDetails`
+- `ApiV3SingleTeamMatchDetails`
+- `nil` (if no type matches)
+

data/docs/ApiV3MatchTeam.md

@@ -0,0 +1,24 @@
+# FtcApiV3Client::ApiV3MatchTeam
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team** | [**ApiV3SimpleTeam**](ApiV3SimpleTeam.md) |  |  |
+| **surrogate** | **Boolean** |  |  |
+| **on_field** | **Boolean** |  | [optional] |
+| **disqualified** | **Boolean** | In seasons before INTO THE DEEP, this includes \"no-shows\" | [optional] |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3MatchTeam.new(
+  team: null,
+  surrogate: null,
+  on_field: null,
+  disqualified: null
+)
+```
+

data/docs/ApiV3Matches.md

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

data/docs/ApiV3PitMap.md

@@ -0,0 +1,30 @@
+# FtcApiV3Client::ApiV3PitMap
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **min_x** | **Integer** |  |  |
+| **min_y** | **Integer** |  |  |
+| **width** | **Integer** |  |  |
+| **height** | **Integer** |  |  |
+| **show_pit_numbers** | **Boolean** |  |  |
+| **show_pit_addresses** | **Boolean** |  |  |
+| **elements** | [**Array<ApiV3PitMapElement>**](ApiV3PitMapElement.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3PitMap.new(
+  min_x: null,
+  min_y: null,
+  width: null,
+  height: null,
+  show_pit_numbers: null,
+  show_pit_addresses: null,
+  elements: null
+)
+```
+

data/docs/ApiV3PitMapCellType.md

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

data/docs/ApiV3PitMapElement.md

@@ -0,0 +1,40 @@
+# FtcApiV3Client::ApiV3PitMapElement
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ApiV3PitMapCellType**](ApiV3PitMapCellType.md) |  | [optional] |
+| **x** | **Integer** |  |  |
+| **y** | **Integer** |  |  |
+| **width** | **Integer** |  |  |
+| **height** | **Integer** |  |  |
+| **label** | **String** |  | [optional] |
+| **label_orientation** | [**ApiV3PitMapLabelOrientation**](ApiV3PitMapLabelOrientation.md) |  | [optional] |
+| **index** | **Integer** |  | [optional] |
+| **team** | [**ApiV3SimpleTeam**](ApiV3SimpleTeam.md) |  | [optional] |
+| **address** | **String** |  | [optional] |
+| **address_group** | **String** |  | [optional] |
+| **color** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3PitMapElement.new(
+  type: null,
+  x: null,
+  y: null,
+  width: null,
+  height: null,
+  label: null,
+  label_orientation: null,
+  index: null,
+  team: null,
+  address: null,
+  address_group: null,
+  color: null
+)
+```
+

data/docs/ApiV3PitMapLabelOrientation.md

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

data/docs/ApiV3PlayoffAlliance.md

@@ -0,0 +1,24 @@
+# FtcApiV3Client::ApiV3PlayoffAlliance
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **seed** | **Integer** |  |  |
+| **teams** | [**Array<ApiV3SimpleTeam>**](ApiV3SimpleTeam.md) |  |  |
+| **name** | **String** | Only present for multi-division events. | [optional] |
+| **abbrev** | **String** | Only present for multi-division events. | [optional] |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3PlayoffAlliance.new(
+  seed: null,
+  teams: null,
+  name: null,
+  abbrev: null
+)
+```
+

data/docs/ApiV3PlayoffAlliances.md

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

data/docs/ApiV3PlayoffMatchAlliance.md

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

data/docs/ApiV3PlayoffRanking.md

@@ -0,0 +1,32 @@
+# FtcApiV3Client::ApiV3PlayoffRanking
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rank** | **Integer** |  |  |
+| **alliance** | [**ApiV3PlayoffAlliance**](ApiV3PlayoffAlliance.md) |  |  |
+| **sort_orders** | **Array<String>** |  |  |
+| **wins** | **Integer** |  |  |
+| **losses** | **Integer** |  |  |
+| **ties** | **Integer** |  |  |
+| **matches_counted** | **Integer** |  |  |
+| **matches_played** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3PlayoffRanking.new(
+  rank: null,
+  alliance: null,
+  sort_orders: null,
+  wins: null,
+  losses: null,
+  ties: null,
+  matches_counted: null,
+  matches_played: null
+)
+```
+

data/docs/ApiV3PlayoffRankings.md

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