ftc_api_v3_client 0.1.0

data/docs/ApiV3AllianceMatchResults.md

@@ -0,0 +1,22 @@
+# FtcApiV3Client::ApiV3AllianceMatchResults
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **winner** | [**ApiV3AllianceColor**](ApiV3AllianceColor.md) |  | [optional] |
+| **red_score** | **Integer** |  |  |
+| **blue_score** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3AllianceMatchResults.new(
+  winner: null,
+  red_score: null,
+  blue_score: null
+)
+```
+

data/docs/ApiV3AllianceMatchResultsDetails.md

@@ -0,0 +1,20 @@
+# FtcApiV3Client::ApiV3AllianceMatchResultsDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **red_details** | [**ApiV3ScoreDetail**](ApiV3ScoreDetail.md) |  |  |
+| **blue_details** | [**ApiV3ScoreDetail**](ApiV3ScoreDetail.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3AllianceMatchResultsDetails.new(
+  red_details: null,
+  blue_details: null
+)
+```
+

data/docs/ApiV3AlliancePlayoffMatchParticipants.md

@@ -0,0 +1,22 @@
+# FtcApiV3Client::ApiV3AlliancePlayoffMatchParticipants
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **red_alliance** | [**ApiV3PlayoffMatchAlliance**](ApiV3PlayoffMatchAlliance.md) |  |  |
+| **blue_alliance** | [**ApiV3PlayoffMatchAlliance**](ApiV3PlayoffMatchAlliance.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3AlliancePlayoffMatchParticipants.new(
+  type: null,
+  red_alliance: null,
+  blue_alliance: null
+)
+```
+

data/docs/ApiV3AllianceSelection.md

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

data/docs/ApiV3AllianceSelections.md

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

data/docs/ApiV3AllianceSimpleMatchParticipants.md

@@ -0,0 +1,22 @@
+# FtcApiV3Client::ApiV3AllianceSimpleMatchParticipants
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **red_alliance** | [**ApiV3MatchAlliance**](ApiV3MatchAlliance.md) |  |  |
+| **blue_alliance** | [**ApiV3MatchAlliance**](ApiV3MatchAlliance.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3AllianceSimpleMatchParticipants.new(
+  type: null,
+  red_alliance: null,
+  blue_alliance: null
+)
+```
+

data/docs/ApiV3Award.md

@@ -0,0 +1,30 @@
+# FtcApiV3Client::ApiV3Award
+
+## 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] |
+| **recipients** | [**Array<ApiV3AwardRecipient>**](ApiV3AwardRecipient.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3Award.new(
+  type: null,
+  name: null,
+  description: null,
+  ordered: null,
+  individual: null,
+  sub_name: null,
+  recipients: null
+)
+```
+

data/docs/ApiV3AwardRecipient.md

@@ -0,0 +1,24 @@
+# FtcApiV3Client::ApiV3AwardRecipient
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team** | [**ApiV3SimpleTeam**](ApiV3SimpleTeam.md) |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **place** | **Integer** | Only populated for awards that are ordered | [optional] |
+| **comment** | **String** | Not populated for seasons before DECODE | [optional] |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3AwardRecipient.new(
+  team: null,
+  name: null,
+  place: null,
+  comment: null
+)
+```
+

data/docs/ApiV3AwardType.md

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

data/docs/ApiV3Awards.md

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

data/docs/ApiV3BasePlayoffSeriesDescription.md

@@ -0,0 +1,79 @@
+# FtcApiV3Client::ApiV3BasePlayoffSeriesDescription
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+FtcApiV3Client::ApiV3BasePlayoffSeriesDescription.openapi_one_of
+# =>
+# [
+#   :'ApiV3DoubleEliminationSeriesDescription',
+#   :'ApiV3PlayoffSeriesDescription'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+FtcApiV3Client::ApiV3BasePlayoffSeriesDescription.openapi_discriminator_name
+# => :'type'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+FtcApiV3Client::ApiV3BasePlayoffSeriesDescription.openapi_discriminator_mapping
+# =>
+# {
+#   :'ApiV3DoubleEliminationSeriesDescription' => :'ApiV3DoubleEliminationSeriesDescription',
+#   :'ApiV3PlayoffSeriesDescription' => :'ApiV3PlayoffSeriesDescription'
+# }
+```
+
+### 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::ApiV3BasePlayoffSeriesDescription.build(data)
+# => #<ApiV3DoubleEliminationSeriesDescription:0x00007fdd4aab02a0>
+
+FtcApiV3Client::ApiV3BasePlayoffSeriesDescription.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ApiV3DoubleEliminationSeriesDescription`
+- `ApiV3PlayoffSeriesDescription`
+- `nil` (if no type matches)
+

data/docs/ApiV3BasicAllianceDescription.md

@@ -0,0 +1,20 @@
+# FtcApiV3Client::ApiV3BasicAllianceDescription
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **alliance_seed** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3BasicAllianceDescription.new(
+  type: null,
+  alliance_seed: null
+)
+```
+

data/docs/ApiV3CenterStageRemoteScoreDetail.md

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

data/docs/ApiV3CenterStageScoreDetail.md

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

data/docs/ApiV3CompetingType.md

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

data/docs/ApiV3Coordinates.md

@@ -0,0 +1,20 @@
+# FtcApiV3Client::ApiV3Coordinates
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **latitude** | **Float** |  |  |
+| **longitude** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3Coordinates.new(
+  latitude: null,
+  longitude: null
+)
+```
+

data/docs/ApiV3CsAchievementsDetail.md

@@ -0,0 +1,56 @@
+# FtcApiV3Client::ApiV3CsAchievementsDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **init_team_prop1** | **Boolean** |  |  |
+| **init_team_prop2** | **Boolean** |  |  |
+| **robot1_auto** | **Boolean** |  |  |
+| **robot2_auto** | **Boolean** |  |  |
+| **spike_mark_pixel1** | **Boolean** |  |  |
+| **spike_mark_pixel2** | **Boolean** |  |  |
+| **target_backdrop_pixel1** | **Boolean** |  |  |
+| **target_backdrop_pixel2** | **Boolean** |  |  |
+| **auto_backdrop** | **Integer** |  |  |
+| **auto_backstage** | **Integer** |  |  |
+| **dc_backdrop** | **Integer** |  |  |
+| **dc_backstage** | **Integer** |  |  |
+| **mosaics** | **Integer** |  |  |
+| **max_set_line** | **Integer** |  |  |
+| **eg_robot1** | [**ApiV3CsEndLocation**](ApiV3CsEndLocation.md) |  |  |
+| **eg_robot2** | [**ApiV3CsEndLocation**](ApiV3CsEndLocation.md) |  |  |
+| **drone1** | **Integer** |  |  |
+| **drone2** | **Integer** |  |  |
+| **minor_penalties** | **Integer** |  |  |
+| **major_penalties** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3CsAchievementsDetail.new(
+  init_team_prop1: null,
+  init_team_prop2: null,
+  robot1_auto: null,
+  robot2_auto: null,
+  spike_mark_pixel1: null,
+  spike_mark_pixel2: null,
+  target_backdrop_pixel1: null,
+  target_backdrop_pixel2: null,
+  auto_backdrop: null,
+  auto_backstage: null,
+  dc_backdrop: null,
+  dc_backstage: null,
+  mosaics: null,
+  max_set_line: null,
+  eg_robot1: null,
+  eg_robot2: null,
+  drone1: null,
+  drone2: null,
+  minor_penalties: null,
+  major_penalties: null
+)
+```
+

data/docs/ApiV3CsEndLocation.md

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

data/docs/ApiV3CsPointsDetail.md

@@ -0,0 +1,48 @@
+# FtcApiV3Client::ApiV3CsPointsDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_navigating_points** | **Integer** |  |  |
+| **auto_randomization_points** | **Integer** |  |  |
+| **auto_backdrop_points** | **Integer** |  |  |
+| **auto_backstage_points** | **Integer** |  |  |
+| **dc_backdrop_points** | **Integer** |  |  |
+| **dc_backstage_points** | **Integer** |  |  |
+| **mosaic_points** | **Integer** |  |  |
+| **set_bonus_points** | **Integer** |  |  |
+| **eg_location_points** | **Integer** |  |  |
+| **eg_drone_points** | **Integer** |  |  |
+| **auto_points** | **Integer** |  |  |
+| **dc_points** | **Integer** |  |  |
+| **endgame_points** | **Integer** |  |  |
+| **penalty_points_committed** | **Integer** |  |  |
+| **pre_penalty_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::ApiV3CsPointsDetail.new(
+  auto_navigating_points: null,
+  auto_randomization_points: null,
+  auto_backdrop_points: null,
+  auto_backstage_points: null,
+  dc_backdrop_points: null,
+  dc_backstage_points: null,
+  mosaic_points: null,
+  set_bonus_points: null,
+  eg_location_points: null,
+  eg_drone_points: null,
+  auto_points: null,
+  dc_points: null,
+  endgame_points: null,
+  penalty_points_committed: null,
+  pre_penalty_total: null,
+  adjust_points: null
+)
+```
+

data/docs/ApiV3CsRemoteAchievementsDetail.md

@@ -0,0 +1,44 @@
+# FtcApiV3Client::ApiV3CsRemoteAchievementsDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **init_team_prop** | **Boolean** |  |  |
+| **robot_auto** | **Boolean** |  |  |
+| **spike_mark_pixel** | **Boolean** |  |  |
+| **target_backdrop_pixel** | **Boolean** |  |  |
+| **auto_backdrop** | **Integer** |  |  |
+| **auto_backstage** | **Integer** |  |  |
+| **dc_backdrop** | **Integer** |  |  |
+| **dc_backstage** | **Integer** |  |  |
+| **mosaics** | **Integer** |  |  |
+| **max_set_line** | **Integer** |  |  |
+| **eg_robot** | [**ApiV3CsEndLocation**](ApiV3CsEndLocation.md) |  |  |
+| **drone** | **Integer** |  |  |
+| **minor_penalties** | **Integer** |  |  |
+| **major_penalties** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3CsRemoteAchievementsDetail.new(
+  init_team_prop: null,
+  robot_auto: null,
+  spike_mark_pixel: null,
+  target_backdrop_pixel: null,
+  auto_backdrop: null,
+  auto_backstage: null,
+  dc_backdrop: null,
+  dc_backstage: null,
+  mosaics: null,
+  max_set_line: null,
+  eg_robot: null,
+  drone: null,
+  minor_penalties: null,
+  major_penalties: null
+)
+```
+

data/docs/ApiV3CsRemotePointsDetail.md

@@ -0,0 +1,46 @@
+# FtcApiV3Client::ApiV3CsRemotePointsDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_navigating_points** | **Integer** |  |  |
+| **auto_randomization_points** | **Integer** |  |  |
+| **auto_backdrop_points** | **Integer** |  |  |
+| **auto_backstage_points** | **Integer** |  |  |
+| **dc_backdrop_points** | **Integer** |  |  |
+| **dc_backstage_points** | **Integer** |  |  |
+| **mosaic_points** | **Integer** |  |  |
+| **set_bonus_points** | **Integer** |  |  |
+| **eg_location_points** | **Integer** |  |  |
+| **eg_drone_points** | **Integer** |  |  |
+| **auto_points** | **Integer** |  |  |
+| **dc_points** | **Integer** |  |  |
+| **endgame_points** | **Integer** |  |  |
+| **penalty_points_committed** | **Integer** |  |  |
+| **pre_penalty_total** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3CsRemotePointsDetail.new(
+  auto_navigating_points: null,
+  auto_randomization_points: null,
+  auto_backdrop_points: null,
+  auto_backstage_points: null,
+  dc_backdrop_points: null,
+  dc_backstage_points: null,
+  mosaic_points: null,
+  set_bonus_points: null,
+  eg_location_points: null,
+  eg_drone_points: null,
+  auto_points: null,
+  dc_points: null,
+  endgame_points: null,
+  penalty_points_committed: null,
+  pre_penalty_total: null
+)
+```
+

data/docs/ApiV3DecodeAchievementsDetail.md

@@ -0,0 +1,42 @@
+# FtcApiV3Client::ApiV3DecodeAchievementsDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_classified_artifacts** | **Integer** |  |  |
+| **auto_overflow_artifacts** | **Integer** |  |  |
+| **auto_classifier_state** | [**Array<ApiV3DecodeArtifactType>**](ApiV3DecodeArtifactType.md) |  |  |
+| **robot1_auto** | **Boolean** |  |  |
+| **robot2_auto** | **Boolean** |  |  |
+| **teleop_classified_artifacts** | **Integer** |  |  |
+| **teleop_overflow_artifacts** | **Integer** |  |  |
+| **teleop_depot_artifacts** | **Integer** |  |  |
+| **teleop_classifier_state** | [**Array<ApiV3DecodeArtifactType>**](ApiV3DecodeArtifactType.md) |  |  |
+| **robot1_teleop** | [**ApiV3DecodeTeleopBaseLocation**](ApiV3DecodeTeleopBaseLocation.md) |  |  |
+| **robot2_teleop** | [**ApiV3DecodeTeleopBaseLocation**](ApiV3DecodeTeleopBaseLocation.md) |  |  |
+| **minor_fouls** | **Integer** |  |  |
+| **major_fouls** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3DecodeAchievementsDetail.new(
+  auto_classified_artifacts: null,
+  auto_overflow_artifacts: null,
+  auto_classifier_state: null,
+  robot1_auto: null,
+  robot2_auto: null,
+  teleop_classified_artifacts: null,
+  teleop_overflow_artifacts: null,
+  teleop_depot_artifacts: null,
+  teleop_classifier_state: null,
+  robot1_teleop: null,
+  robot2_teleop: null,
+  minor_fouls: null,
+  major_fouls: null
+)
+```
+

data/docs/ApiV3DecodeArtifactType.md

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