ftc_api_v3_client 0.1.0

data/docs/ApiV3DecodePointsDetail.md

@@ -0,0 +1,46 @@
+# FtcApiV3Client::ApiV3DecodePointsDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_leave_points** | **Integer** |  |  |
+| **auto_artifact_points** | **Integer** |  |  |
+| **auto_pattern_points** | **Integer** |  |  |
+| **teleop_artifact_points** | **Integer** |  |  |
+| **teleop_depot_points** | **Integer** |  |  |
+| **teleop_pattern_points** | **Integer** |  |  |
+| **teleop_base_points** | **Integer** |  |  |
+| **auto_points** | **Integer** |  |  |
+| **teleop_points** | **Integer** |  |  |
+| **foul_points_committed** | **Integer** |  |  |
+| **pre_foul_total** | **Integer** |  |  |
+| **movement_rp** | **Boolean** |  |  |
+| **goal_rp** | **Boolean** |  |  |
+| **pattern_rp** | **Boolean** |  |  |
+| **adjust_points** | **Integer** | Used to indicate the winner in double-red-card playoff matches |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3DecodePointsDetail.new(
+  auto_leave_points: null,
+  auto_artifact_points: null,
+  auto_pattern_points: null,
+  teleop_artifact_points: null,
+  teleop_depot_points: null,
+  teleop_pattern_points: null,
+  teleop_base_points: null,
+  auto_points: null,
+  teleop_points: null,
+  foul_points_committed: null,
+  pre_foul_total: null,
+  movement_rp: null,
+  goal_rp: null,
+  pattern_rp: null,
+  adjust_points: null
+)
+```
+

data/docs/ApiV3DecodeScoreDetail.md

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

data/docs/ApiV3DecodeTeleopBaseLocation.md

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

data/docs/ApiV3Division.md

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

data/docs/ApiV3DoubleEliminationSeriesDescription.md

@@ -0,0 +1,36 @@
+# FtcApiV3Client::ApiV3DoubleEliminationSeriesDescription
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **series_id** | **Integer** |  |  |
+| **name** | **String** |  |  |
+| **short_name** | **String** |  |  |
+| **matches_to_win** | **Integer** |  |  |
+| **round** | **Integer** |  |  |
+| **red** | [**ApiV3AllianceDescription**](ApiV3AllianceDescription.md) |  |  |
+| **blue** | [**ApiV3AllianceDescription**](ApiV3AllianceDescription.md) |  |  |
+| **finals** | **Boolean** |  |  |
+| **bracket_half** | [**ApiV3DoubleElimsBracketHalf**](ApiV3DoubleElimsBracketHalf.md) |  | [optional] |
+| **optional** | **Boolean** | This series is only played if necessary (e.g. if the alliance from the lower bracket wins the first finals match) |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3DoubleEliminationSeriesDescription.new(
+  series_id: null,
+  name: null,
+  short_name: null,
+  matches_to_win: null,
+  round: null,
+  red: null,
+  blue: null,
+  finals: null,
+  bracket_half: null,
+  optional: null
+)
+```
+

data/docs/ApiV3DoubleElimsBracketHalf.md

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

data/docs/ApiV3Event.md

@@ -0,0 +1,62 @@
+# FtcApiV3Client::ApiV3Event
+
+## 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** |  |  |
+| **league_code** | **String** |  | [optional] |
+| **parent_event_code** | **String** |  | [optional] |
+| **divisions** | [**Array<ApiV3Division>**](ApiV3Division.md) |  |  |
+| **venue** | **String** |  | [optional] |
+| **street_address** | **String** |  | [optional] |
+| **street_address2** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+| **coordinates** | [**ApiV3Coordinates**](ApiV3Coordinates.md) |  | [optional] |
+| **website** | **String** |  | [optional] |
+| **live_streams** | [**Array<ApiV3EventLiveStream>**](ApiV3EventLiveStream.md) |  | [optional] |
+| **field_count** | **Integer** |  |  |
+| **capacity** | **Integer** |  | [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::ApiV3Event.new(
+  code: null,
+  name: null,
+  type: null,
+  format: null,
+  start_date: null,
+  end_date: null,
+  region_code: null,
+  league_code: null,
+  parent_event_code: null,
+  divisions: null,
+  venue: null,
+  street_address: null,
+  street_address2: null,
+  city: null,
+  state: null,
+  country: null,
+  coordinates: null,
+  website: null,
+  live_streams: null,
+  field_count: null,
+  capacity: null,
+  published: null,
+  timezone: null
+)
+```
+

data/docs/ApiV3EventFormat.md

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

data/docs/ApiV3EventLiveStream.md

@@ -0,0 +1,22 @@
+# FtcApiV3Client::ApiV3EventLiveStream
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** |  |  |
+| **date** | **Date** |  | [optional] |
+| **label** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3EventLiveStream.new(
+  url: null,
+  date: null,
+  label: null
+)
+```
+

data/docs/ApiV3EventParticipant.md

@@ -0,0 +1,22 @@
+# FtcApiV3Client::ApiV3EventParticipant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team** | [**ApiV3Team**](ApiV3Team.md) |  |  |
+| **competing_type** | [**ApiV3CompetingType**](ApiV3CompetingType.md) |  |  |
+| **division_event_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3EventParticipant.new(
+  team: null,
+  competing_type: null,
+  division_event_code: null
+)
+```
+

data/docs/ApiV3EventParticipants.md

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

data/docs/ApiV3EventType.md

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

data/docs/ApiV3Events.md

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

data/docs/ApiV3FFAchievementsDetail.md

@@ -0,0 +1,64 @@
+# FtcApiV3Client::ApiV3FFAchievementsDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_delivered** | **Boolean** |  |  |
+| **auto_robot1** | [**ApiV3FFAutoLocation**](ApiV3FFAutoLocation.md) |  |  |
+| **auto_robot2** | [**ApiV3FFAutoLocation**](ApiV3FFAutoLocation.md) |  |  |
+| **preload1** | **Boolean** |  |  |
+| **preload2** | **Boolean** |  |  |
+| **auto_storage_freight** | **Integer** |  |  |
+| **auto_freight1** | **Integer** |  |  |
+| **auto_freight2** | **Integer** |  |  |
+| **auto_freight3** | **Integer** |  |  |
+| **dc_storage_freight** | **Integer** |  |  |
+| **dc_freight1** | **Integer** |  |  |
+| **dc_freight2** | **Integer** |  |  |
+| **dc_freight3** | **Integer** |  |  |
+| **shared_freight** | **Integer** |  |  |
+| **eg_delivered** | **Integer** |  |  |
+| **balanced** | **Boolean** |  |  |
+| **eg_robot1** | [**ApiV3FFEndLocation**](ApiV3FFEndLocation.md) |  |  |
+| **eg_robot2** | [**ApiV3FFEndLocation**](ApiV3FFEndLocation.md) |  |  |
+| **capped** | **Integer** |  |  |
+| **minor_penalties** | **Integer** |  |  |
+| **major_penalties** | **Integer** |  |  |
+| **init_tse1** | **Boolean** | Indicates if team 1 used a team shipping element |  |
+| **init_tse2** | **Boolean** | Indicates if team 2 used a team shipping element |  |
+| **shared_tipped** | **Boolean** | Indicates if the shared shipping hub was tipped towards this alliance |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3FFAchievementsDetail.new(
+  auto_delivered: null,
+  auto_robot1: null,
+  auto_robot2: null,
+  preload1: null,
+  preload2: null,
+  auto_storage_freight: null,
+  auto_freight1: null,
+  auto_freight2: null,
+  auto_freight3: null,
+  dc_storage_freight: null,
+  dc_freight1: null,
+  dc_freight2: null,
+  dc_freight3: null,
+  shared_freight: null,
+  eg_delivered: null,
+  balanced: null,
+  eg_robot1: null,
+  eg_robot2: null,
+  capped: null,
+  minor_penalties: null,
+  major_penalties: null,
+  init_tse1: null,
+  init_tse2: null,
+  shared_tipped: null
+)
+```
+

data/docs/ApiV3FFAutoLocation.md

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

data/docs/ApiV3FFEndLocation.md

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

data/docs/ApiV3FFPointsDetail.md

@@ -0,0 +1,54 @@
+# FtcApiV3Client::ApiV3FFPointsDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **carousel_points** | **Integer** |  |  |
+| **navigation_points** | **Integer** |  |  |
+| **auto_freight_points** | **Integer** |  |  |
+| **auto_bonus_points** | **Integer** |  |  |
+| **dc_hub_points** | **Integer** |  |  |
+| **dc_shared_points** | **Integer** |  |  |
+| **dc_storage_points** | **Integer** |  |  |
+| **eg_delivery_points** | **Integer** |  |  |
+| **balanced_points** | **Integer** |  |  |
+| **tipped_points** | **Integer** |  |  |
+| **parking_points** | **Integer** |  |  |
+| **capping_points** | **Integer** |  |  |
+| **auto_points** | **Integer** |  |  |
+| **dc_points** | **Integer** |  |  |
+| **endgame_points** | **Integer** |  |  |
+| **penalty_points** | **Integer** |  |  |
+| **scored_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::ApiV3FFPointsDetail.new(
+  carousel_points: null,
+  navigation_points: null,
+  auto_freight_points: null,
+  auto_bonus_points: null,
+  dc_hub_points: null,
+  dc_shared_points: null,
+  dc_storage_points: null,
+  eg_delivery_points: null,
+  balanced_points: null,
+  tipped_points: null,
+  parking_points: null,
+  capping_points: null,
+  auto_points: null,
+  dc_points: null,
+  endgame_points: null,
+  penalty_points: null,
+  scored_points: null,
+  total_points: null,
+  adjust_points: null
+)
+```
+

data/docs/ApiV3FFRemoteAchievementsDetail.md

@@ -0,0 +1,52 @@
+# FtcApiV3Client::ApiV3FFRemoteAchievementsDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_delivered** | **Boolean** |  |  |
+| **auto_robot** | [**ApiV3FFAutoLocation**](ApiV3FFAutoLocation.md) |  |  |
+| **preload** | **Boolean** |  |  |
+| **auto_storage_freight** | **Integer** |  |  |
+| **auto_freight1** | **Integer** |  |  |
+| **auto_freight2** | **Integer** |  |  |
+| **auto_freight3** | **Integer** |  |  |
+| **dc_storage_freight** | **Integer** |  |  |
+| **dc_freight1** | **Integer** |  |  |
+| **dc_freight2** | **Integer** |  |  |
+| **dc_freight3** | **Integer** |  |  |
+| **eg_delivered** | **Integer** |  |  |
+| **balanced** | **Boolean** |  |  |
+| **eg_robot** | [**ApiV3FFEndLocation**](ApiV3FFEndLocation.md) |  |  |
+| **capped** | **Integer** |  |  |
+| **minor_penalties** | **Integer** |  |  |
+| **major_penalties** | **Integer** |  |  |
+| **init_tse** | **Boolean** | Indicates if team used a team shipping element |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3FFRemoteAchievementsDetail.new(
+  auto_delivered: null,
+  auto_robot: null,
+  preload: null,
+  auto_storage_freight: null,
+  auto_freight1: null,
+  auto_freight2: null,
+  auto_freight3: null,
+  dc_storage_freight: null,
+  dc_freight1: null,
+  dc_freight2: null,
+  dc_freight3: null,
+  eg_delivered: null,
+  balanced: null,
+  eg_robot: null,
+  capped: null,
+  minor_penalties: null,
+  major_penalties: null,
+  init_tse: null
+)
+```
+

data/docs/ApiV3FFRemotePointsDetail.md

@@ -0,0 +1,48 @@
+# FtcApiV3Client::ApiV3FFRemotePointsDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **carousel_points** | **Integer** |  |  |
+| **navigation_points** | **Integer** |  |  |
+| **auto_freight_points** | **Integer** |  |  |
+| **auto_bonus_points** | **Integer** |  |  |
+| **dc_hub_points** | **Integer** |  |  |
+| **dc_storage_points** | **Integer** |  |  |
+| **eg_delivery_points** | **Integer** |  |  |
+| **balanced_points** | **Integer** |  |  |
+| **parking_points** | **Integer** |  |  |
+| **capping_points** | **Integer** |  |  |
+| **auto_points** | **Integer** |  |  |
+| **dc_points** | **Integer** |  |  |
+| **endgame_points** | **Integer** |  |  |
+| **penalty_points** | **Integer** |  |  |
+| **scored_points** | **Integer** |  |  |
+| **total_points** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3FFRemotePointsDetail.new(
+  carousel_points: null,
+  navigation_points: null,
+  auto_freight_points: null,
+  auto_bonus_points: null,
+  dc_hub_points: null,
+  dc_storage_points: null,
+  eg_delivery_points: null,
+  balanced_points: null,
+  parking_points: null,
+  capping_points: null,
+  auto_points: null,
+  dc_points: null,
+  endgame_points: null,
+  penalty_points: null,
+  scored_points: null,
+  total_points: null
+)
+```
+

data/docs/ApiV3FreightFrenzyRemoteScoreDetail.md

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

data/docs/ApiV3FreightFrenzyScoreDetail.md

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

data/docs/ApiV3IntoTheDeepScoreDetail.md

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