ftc_api_v3_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3216188be2cc7d72ad3e3cd8ac66f4f67c640cd940b958748d6377fce9b3634
+  data.tar.gz: a19efbf95021404a5acc51859727d9d853245de940ffdaf16dff49edf1b6e022
+SHA512:
+  metadata.gz: b785d2debee43d5e02a53399ea4a1ec4b10dd1f306dd8132910822d33b78a438440e13c1b251a0f92e4dafd1c27441053262566ad8ae6632e2106ea871583ad7
+  data.tar.gz: 271c33d90c21861e4ebf5216d66a3825c737b048c86ef6f17009716607bf58c5debcce5b27ae3ca9d6f4889dec719de786cc3a4def851234f708a6f8a0f4d8e4

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,283 @@
+# ftc_api_v3_client
+
+FtcApiV3Client - the Ruby gem for the FTC Scoring Data API
+
+THIS API IS CURRENTLY IN EARLY DEVELOPMENT AND MAY CHANGE WITHOUT WARNING.
+THIS PAGE WILL BE UPDATED ONCE THE API IS OFFICIALLY RELEASED.
+
+This API provides event and scoring data for FIRST Tech Challenge. Applications that
+present result data directly are encouraged to directly call this API rather than
+maintaining their own copies of the data. All endpoints are cached by our CDN and
+may return data up to one hour old for data that changes infrequently. During an event,
+data that changes frequently (e.g. match results and rankings) should not be more than
+30 seconds old.
+
+NOTE: For developers who have integrated with the v2 API in the past, this is a policy
+shift, as previously developers were encouraged to maintain their own copy of relevant data.
+In the interest of providing the community with the most up-to-date data and reducing the
+burden for applications that are not performing their own analytics on event data, we are
+now encouraging directly integrating our API into websites and apps.
+
+Also note that all endpoints that accept a year argument now expect the year in which
+the FIRST Championship for that season is held. This is a change from the previous API
+and FTC-events website, which used the kickoff year.
+
+To report any issues, please report an issue here: https://github.com/FIRST-Tech-Challenge/scorekeeper/issues/new?template=api-bug-report.md
+To request additional data, please submit a feature request here: https://github.com/FIRST-Tech-Challenge/scorekeeper/issues/new?template=api-feature-request.md
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: v3
+- Package version: 0.1.0
+- Generator version: 7.20.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build ftc_api_v3_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./ftc_api_v3_client-0.1.0.gem
+```
+
+(for development, run `gem install --dev ./ftc_api_v3_client-0.1.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'ftc_api_v3_client', '~> 0.1.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'ftc_api_v3_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'ftc_api_v3_client'
+
+# Setup authorization
+FtcApiV3Client.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FtcApiV3Client::EventsApi.new
+cmp_year = 'cmp_year_example' # String | The year of the FIRST Championship for the requested season
+event_code = 'event_code_example' # String | The code (abbreviation) for the event
+
+begin
+  #Get event from season
+  result = api_instance.get_event(cmp_year, event_code)
+  p result
+rescue FtcApiV3Client::ApiError => e
+  puts "Exception when calling EventsApi->get_event: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://ftc-api.firstinspires.org*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*FtcApiV3Client::EventsApi* | [**get_event**](docs/EventsApi.md#get_event) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode} | Get event from season
+*FtcApiV3Client::EventsApi* | [**get_event_advancement_from**](docs/EventsApi.md#get_event_advancement_from) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/advancement/from | Get event advancement (from)
+*FtcApiV3Client::EventsApi* | [**get_event_alliance_selections**](docs/EventsApi.md#get_event_alliance_selections) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/alliances/selections | Get event alliance selections
+*FtcApiV3Client::EventsApi* | [**get_event_alliances**](docs/EventsApi.md#get_event_alliances) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/alliances | Get event alliances
+*FtcApiV3Client::EventsApi* | [**get_event_awards**](docs/EventsApi.md#get_event_awards) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/awards | Get event awards
+*FtcApiV3Client::EventsApi* | [**get_event_match**](docs/EventsApi.md#get_event_match) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/matches/{tournamentLevel}/{series}/{number} | Get match details
+*FtcApiV3Client::EventsApi* | [**get_event_pit_map**](docs/EventsApi.md#get_event_pit_map) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/pitMap | Get pit map
+*FtcApiV3Client::EventsApi* | [**get_event_playoff_rankings**](docs/EventsApi.md#get_event_playoff_rankings) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/playoffRankings | Get event playoff rankings
+*FtcApiV3Client::EventsApi* | [**get_event_playoff_structure**](docs/EventsApi.md#get_event_playoff_structure) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/playoffStructure | Get playoff structure
+*FtcApiV3Client::EventsApi* | [**get_event_rankings**](docs/EventsApi.md#get_event_rankings) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/rankings | Get event rankings
+*FtcApiV3Client::EventsApi* | [**list_event_matches**](docs/EventsApi.md#list_event_matches) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/matches | List event matches
+*FtcApiV3Client::EventsApi* | [**list_event_teams**](docs/EventsApi.md#list_event_teams) | **GET** /api/v3/seasons/{cmpYear}/events/{eventCode}/teams | List teams for an event
+*FtcApiV3Client::EventsApi* | [**list_events**](docs/EventsApi.md#list_events) | **GET** /api/v3/seasons/{cmpYear}/events | List events for a season
+*FtcApiV3Client::LeaguesApi* | [**get_league**](docs/LeaguesApi.md#get_league) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode}/leagues/{leagueCode} | Gets a single league from a region
+*FtcApiV3Client::LeaguesApi* | [**get_league_rankings**](docs/LeaguesApi.md#get_league_rankings) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode}/leagues/{leagueCode}/rankings | Get rankings for a league
+*FtcApiV3Client::LeaguesApi* | [**list_league_events**](docs/LeaguesApi.md#list_league_events) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode}/leagues/{leagueCode}/events | List events for a league
+*FtcApiV3Client::LeaguesApi* | [**list_league_teams**](docs/LeaguesApi.md#list_league_teams) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode}/leagues/{leagueCode}/teams | List teams for a league
+*FtcApiV3Client::LeaguesApi* | [**list_leagues**](docs/LeaguesApi.md#list_leagues) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode}/leagues | Lists leagues for a region
+*FtcApiV3Client::RegionsApi* | [**get_region**](docs/RegionsApi.md#get_region) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode} | Get region from a season
+*FtcApiV3Client::RegionsApi* | [**list_region_events**](docs/RegionsApi.md#list_region_events) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode}/events | List events for a regions
+*FtcApiV3Client::RegionsApi* | [**list_region_teams**](docs/RegionsApi.md#list_region_teams) | **GET** /api/v3/seasons/{cmpYear}/regions/{regionCode}/teams | List teams for a region
+*FtcApiV3Client::RegionsApi* | [**list_regions**](docs/RegionsApi.md#list_regions) | **GET** /api/v3/seasons/{cmpYear}/regions | List regions for a season
+*FtcApiV3Client::SeasonsApi* | [**get_season**](docs/SeasonsApi.md#get_season) | **GET** /api/v3/seasons/{cmpYear} | Get single FTC season
+*FtcApiV3Client::SeasonsApi* | [**list_seasons**](docs/SeasonsApi.md#list_seasons) | **GET** /api/v3/seasons | List all FTC seasons
+*FtcApiV3Client::TeamsApi* | [**get_team**](docs/TeamsApi.md#get_team) | **GET** /api/v3/seasons/{cmpYear}/teams/{number} | Get teams information
+*FtcApiV3Client::TeamsApi* | [**get_team_details**](docs/TeamsApi.md#get_team_details) | **GET** /api/v3/seasons/{cmpYear}/teams/{number}/details | Get detailed team information
+*FtcApiV3Client::TeamsApi* | [**get_team_history**](docs/TeamsApi.md#get_team_history) | **GET** /api/v3/teams/{number} | Get team history
+*FtcApiV3Client::TeamsApi* | [**list_team_avatars**](docs/TeamsApi.md#list_team_avatars) | **GET** /api/v3/seasons/{cmpYear}/avatars | List team avatars for a season
+*FtcApiV3Client::TeamsApi* | [**list_teams**](docs/TeamsApi.md#list_teams) | **GET** /api/v3/seasons/{cmpYear}/teams | List teams for a season
+
+
+## Documentation for Models
+
+ - [FtcApiV3Client::ApiV3AdvancementFrom](docs/ApiV3AdvancementFrom.md)
+ - [FtcApiV3Client::ApiV3AdvancementFromSlot](docs/ApiV3AdvancementFromSlot.md)
+ - [FtcApiV3Client::ApiV3AdvancementStatus](docs/ApiV3AdvancementStatus.md)
+ - [FtcApiV3Client::ApiV3AllianceColor](docs/ApiV3AllianceColor.md)
+ - [FtcApiV3Client::ApiV3AllianceDescription](docs/ApiV3AllianceDescription.md)
+ - [FtcApiV3Client::ApiV3AllianceMatch](docs/ApiV3AllianceMatch.md)
+ - [FtcApiV3Client::ApiV3AllianceMatchDetails](docs/ApiV3AllianceMatchDetails.md)
+ - [FtcApiV3Client::ApiV3AllianceMatchParticipants](docs/ApiV3AllianceMatchParticipants.md)
+ - [FtcApiV3Client::ApiV3AllianceMatchResults](docs/ApiV3AllianceMatchResults.md)
+ - [FtcApiV3Client::ApiV3AllianceMatchResultsDetails](docs/ApiV3AllianceMatchResultsDetails.md)
+ - [FtcApiV3Client::ApiV3AlliancePlayoffMatchParticipants](docs/ApiV3AlliancePlayoffMatchParticipants.md)
+ - [FtcApiV3Client::ApiV3AllianceSelection](docs/ApiV3AllianceSelection.md)
+ - [FtcApiV3Client::ApiV3AllianceSelections](docs/ApiV3AllianceSelections.md)
+ - [FtcApiV3Client::ApiV3AllianceSimpleMatchParticipants](docs/ApiV3AllianceSimpleMatchParticipants.md)
+ - [FtcApiV3Client::ApiV3Award](docs/ApiV3Award.md)
+ - [FtcApiV3Client::ApiV3AwardRecipient](docs/ApiV3AwardRecipient.md)
+ - [FtcApiV3Client::ApiV3AwardType](docs/ApiV3AwardType.md)
+ - [FtcApiV3Client::ApiV3Awards](docs/ApiV3Awards.md)
+ - [FtcApiV3Client::ApiV3BasePlayoffSeriesDescription](docs/ApiV3BasePlayoffSeriesDescription.md)
+ - [FtcApiV3Client::ApiV3BasicAllianceDescription](docs/ApiV3BasicAllianceDescription.md)
+ - [FtcApiV3Client::ApiV3CenterStageRemoteScoreDetail](docs/ApiV3CenterStageRemoteScoreDetail.md)
+ - [FtcApiV3Client::ApiV3CenterStageScoreDetail](docs/ApiV3CenterStageScoreDetail.md)
+ - [FtcApiV3Client::ApiV3CompetingType](docs/ApiV3CompetingType.md)
+ - [FtcApiV3Client::ApiV3Coordinates](docs/ApiV3Coordinates.md)
+ - [FtcApiV3Client::ApiV3CsAchievementsDetail](docs/ApiV3CsAchievementsDetail.md)
+ - [FtcApiV3Client::ApiV3CsEndLocation](docs/ApiV3CsEndLocation.md)
+ - [FtcApiV3Client::ApiV3CsPointsDetail](docs/ApiV3CsPointsDetail.md)
+ - [FtcApiV3Client::ApiV3CsRemoteAchievementsDetail](docs/ApiV3CsRemoteAchievementsDetail.md)
+ - [FtcApiV3Client::ApiV3CsRemotePointsDetail](docs/ApiV3CsRemotePointsDetail.md)
+ - [FtcApiV3Client::ApiV3DecodeAchievementsDetail](docs/ApiV3DecodeAchievementsDetail.md)
+ - [FtcApiV3Client::ApiV3DecodeArtifactType](docs/ApiV3DecodeArtifactType.md)
+ - [FtcApiV3Client::ApiV3DecodePointsDetail](docs/ApiV3DecodePointsDetail.md)
+ - [FtcApiV3Client::ApiV3DecodeScoreDetail](docs/ApiV3DecodeScoreDetail.md)
+ - [FtcApiV3Client::ApiV3DecodeTeleopBaseLocation](docs/ApiV3DecodeTeleopBaseLocation.md)
+ - [FtcApiV3Client::ApiV3Division](docs/ApiV3Division.md)
+ - [FtcApiV3Client::ApiV3DoubleEliminationSeriesDescription](docs/ApiV3DoubleEliminationSeriesDescription.md)
+ - [FtcApiV3Client::ApiV3DoubleElimsBracketHalf](docs/ApiV3DoubleElimsBracketHalf.md)
+ - [FtcApiV3Client::ApiV3Event](docs/ApiV3Event.md)
+ - [FtcApiV3Client::ApiV3EventFormat](docs/ApiV3EventFormat.md)
+ - [FtcApiV3Client::ApiV3EventLiveStream](docs/ApiV3EventLiveStream.md)
+ - [FtcApiV3Client::ApiV3EventParticipant](docs/ApiV3EventParticipant.md)
+ - [FtcApiV3Client::ApiV3EventParticipants](docs/ApiV3EventParticipants.md)
+ - [FtcApiV3Client::ApiV3EventType](docs/ApiV3EventType.md)
+ - [FtcApiV3Client::ApiV3Events](docs/ApiV3Events.md)
+ - [FtcApiV3Client::ApiV3FFAchievementsDetail](docs/ApiV3FFAchievementsDetail.md)
+ - [FtcApiV3Client::ApiV3FFAutoLocation](docs/ApiV3FFAutoLocation.md)
+ - [FtcApiV3Client::ApiV3FFEndLocation](docs/ApiV3FFEndLocation.md)
+ - [FtcApiV3Client::ApiV3FFPointsDetail](docs/ApiV3FFPointsDetail.md)
+ - [FtcApiV3Client::ApiV3FFRemoteAchievementsDetail](docs/ApiV3FFRemoteAchievementsDetail.md)
+ - [FtcApiV3Client::ApiV3FFRemotePointsDetail](docs/ApiV3FFRemotePointsDetail.md)
+ - [FtcApiV3Client::ApiV3FreightFrenzyRemoteScoreDetail](docs/ApiV3FreightFrenzyRemoteScoreDetail.md)
+ - [FtcApiV3Client::ApiV3FreightFrenzyScoreDetail](docs/ApiV3FreightFrenzyScoreDetail.md)
+ - [FtcApiV3Client::ApiV3IntoTheDeepScoreDetail](docs/ApiV3IntoTheDeepScoreDetail.md)
+ - [FtcApiV3Client::ApiV3ItdAchievementsDetail](docs/ApiV3ItdAchievementsDetail.md)
+ - [FtcApiV3Client::ApiV3ItdAutoLocation](docs/ApiV3ItdAutoLocation.md)
+ - [FtcApiV3Client::ApiV3ItdPointsDetail](docs/ApiV3ItdPointsDetail.md)
+ - [FtcApiV3Client::ApiV3ItdTeleopLocation](docs/ApiV3ItdTeleopLocation.md)
+ - [FtcApiV3Client::ApiV3JunctionElement](docs/ApiV3JunctionElement.md)
+ - [FtcApiV3Client::ApiV3League](docs/ApiV3League.md)
+ - [FtcApiV3Client::ApiV3LeagueDetails](docs/ApiV3LeagueDetails.md)
+ - [FtcApiV3Client::ApiV3LeagueMembershipDetails](docs/ApiV3LeagueMembershipDetails.md)
+ - [FtcApiV3Client::ApiV3Leagues](docs/ApiV3Leagues.md)
+ - [FtcApiV3Client::ApiV3Match](docs/ApiV3Match.md)
+ - [FtcApiV3Client::ApiV3MatchAlliance](docs/ApiV3MatchAlliance.md)
+ - [FtcApiV3Client::ApiV3MatchDetails](docs/ApiV3MatchDetails.md)
+ - [FtcApiV3Client::ApiV3MatchTeam](docs/ApiV3MatchTeam.md)
+ - [FtcApiV3Client::ApiV3Matches](docs/ApiV3Matches.md)
+ - [FtcApiV3Client::ApiV3PitMap](docs/ApiV3PitMap.md)
+ - [FtcApiV3Client::ApiV3PitMapCellType](docs/ApiV3PitMapCellType.md)
+ - [FtcApiV3Client::ApiV3PitMapElement](docs/ApiV3PitMapElement.md)
+ - [FtcApiV3Client::ApiV3PitMapLabelOrientation](docs/ApiV3PitMapLabelOrientation.md)
+ - [FtcApiV3Client::ApiV3PlayoffAlliance](docs/ApiV3PlayoffAlliance.md)
+ - [FtcApiV3Client::ApiV3PlayoffAlliances](docs/ApiV3PlayoffAlliances.md)
+ - [FtcApiV3Client::ApiV3PlayoffMatchAlliance](docs/ApiV3PlayoffMatchAlliance.md)
+ - [FtcApiV3Client::ApiV3PlayoffRanking](docs/ApiV3PlayoffRanking.md)
+ - [FtcApiV3Client::ApiV3PlayoffRankings](docs/ApiV3PlayoffRankings.md)
+ - [FtcApiV3Client::ApiV3PlayoffSeriesDescription](docs/ApiV3PlayoffSeriesDescription.md)
+ - [FtcApiV3Client::ApiV3PlayoffStructure](docs/ApiV3PlayoffStructure.md)
+ - [FtcApiV3Client::ApiV3PlayoffType](docs/ApiV3PlayoffType.md)
+ - [FtcApiV3Client::ApiV3PowerPlayAchievementsDetail](docs/ApiV3PowerPlayAchievementsDetail.md)
+ - [FtcApiV3Client::ApiV3PowerPlayAutoLocation](docs/ApiV3PowerPlayAutoLocation.md)
+ - [FtcApiV3Client::ApiV3PowerPlayPointsDetail](docs/ApiV3PowerPlayPointsDetail.md)
+ - [FtcApiV3Client::ApiV3PowerPlayRemoteAchievementsDetail](docs/ApiV3PowerPlayRemoteAchievementsDetail.md)
+ - [FtcApiV3Client::ApiV3PowerPlayRemotePointsDetail](docs/ApiV3PowerPlayRemotePointsDetail.md)
+ - [FtcApiV3Client::ApiV3PowerPlayRemoteScoreDetail](docs/ApiV3PowerPlayRemoteScoreDetail.md)
+ - [FtcApiV3Client::ApiV3PowerPlayScoreDetail](docs/ApiV3PowerPlayScoreDetail.md)
+ - [FtcApiV3Client::ApiV3Ranking](docs/ApiV3Ranking.md)
+ - [FtcApiV3Client::ApiV3Rankings](docs/ApiV3Rankings.md)
+ - [FtcApiV3Client::ApiV3Region](docs/ApiV3Region.md)
+ - [FtcApiV3Client::ApiV3Regions](docs/ApiV3Regions.md)
+ - [FtcApiV3Client::ApiV3RemoteJunctionElement](docs/ApiV3RemoteJunctionElement.md)
+ - [FtcApiV3Client::ApiV3RemoteScoreDetail](docs/ApiV3RemoteScoreDetail.md)
+ - [FtcApiV3Client::ApiV3RoundRobinAllianceDescription](docs/ApiV3RoundRobinAllianceDescription.md)
+ - [FtcApiV3Client::ApiV3ScoreDetail](docs/ApiV3ScoreDetail.md)
+ - [FtcApiV3Client::ApiV3Season](docs/ApiV3Season.md)
+ - [FtcApiV3Client::ApiV3Seasons](docs/ApiV3Seasons.md)
+ - [FtcApiV3Client::ApiV3SelectionOperation](docs/ApiV3SelectionOperation.md)
+ - [FtcApiV3Client::ApiV3SeriesAllianceDescription](docs/ApiV3SeriesAllianceDescription.md)
+ - [FtcApiV3Client::ApiV3SeriesAllianceState](docs/ApiV3SeriesAllianceState.md)
+ - [FtcApiV3Client::ApiV3SimpleEvent](docs/ApiV3SimpleEvent.md)
+ - [FtcApiV3Client::ApiV3SimpleTeam](docs/ApiV3SimpleTeam.md)
+ - [FtcApiV3Client::ApiV3SingleAwardRecipient](docs/ApiV3SingleAwardRecipient.md)
+ - [FtcApiV3Client::ApiV3SingleTeamMatch](docs/ApiV3SingleTeamMatch.md)
+ - [FtcApiV3Client::ApiV3SingleTeamMatchDetails](docs/ApiV3SingleTeamMatchDetails.md)
+ - [FtcApiV3Client::ApiV3SingleTeamMatchParticipants](docs/ApiV3SingleTeamMatchParticipants.md)
+ - [FtcApiV3Client::ApiV3SingleTeamMatchResults](docs/ApiV3SingleTeamMatchResults.md)
+ - [FtcApiV3Client::ApiV3SingleTeamMatchResultsDetails](docs/ApiV3SingleTeamMatchResultsDetails.md)
+ - [FtcApiV3Client::ApiV3SkystoneAchievementsDetail](docs/ApiV3SkystoneAchievementsDetail.md)
+ - [FtcApiV3Client::ApiV3SkystonePointsDetail](docs/ApiV3SkystonePointsDetail.md)
+ - [FtcApiV3Client::ApiV3SkystoneScoreDetail](docs/ApiV3SkystoneScoreDetail.md)
+ - [FtcApiV3Client::ApiV3Stone](docs/ApiV3Stone.md)
+ - [FtcApiV3Client::ApiV3Team](docs/ApiV3Team.md)
+ - [FtcApiV3Client::ApiV3TeamAvatar](docs/ApiV3TeamAvatar.md)
+ - [FtcApiV3Client::ApiV3TeamAvatars](docs/ApiV3TeamAvatars.md)
+ - [FtcApiV3Client::ApiV3TeamDetails](docs/ApiV3TeamDetails.md)
+ - [FtcApiV3Client::ApiV3TeamEventParticipation](docs/ApiV3TeamEventParticipation.md)
+ - [FtcApiV3Client::ApiV3TeamEventParticipationDetails](docs/ApiV3TeamEventParticipationDetails.md)
+ - [FtcApiV3Client::ApiV3TeamHistory](docs/ApiV3TeamHistory.md)
+ - [FtcApiV3Client::ApiV3TeamSeasonHistory](docs/ApiV3TeamSeasonHistory.md)
+ - [FtcApiV3Client::ApiV3Teams](docs/ApiV3Teams.md)
+ - [FtcApiV3Client::ApiV3TournamentLevel](docs/ApiV3TournamentLevel.md)
+ - [FtcApiV3Client::ApiV3UgAchievementsDetail](docs/ApiV3UgAchievementsDetail.md)
+ - [FtcApiV3Client::ApiV3UgPointsDetail](docs/ApiV3UgPointsDetail.md)
+ - [FtcApiV3Client::ApiV3UgRemoteAchievementsDetail](docs/ApiV3UgRemoteAchievementsDetail.md)
+ - [FtcApiV3Client::ApiV3UgRemotePointsDetail](docs/ApiV3UgRemotePointsDetail.md)
+ - [FtcApiV3Client::ApiV3UgWobbleLocation](docs/ApiV3UgWobbleLocation.md)
+ - [FtcApiV3Client::ApiV3UltimateGoalRemoteScoreDetail](docs/ApiV3UltimateGoalRemoteScoreDetail.md)
+ - [FtcApiV3Client::ApiV3UltimateGoalScoreDetail](docs/ApiV3UltimateGoalScoreDetail.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### ApiKeyAuth
+
+
+- **Type**: API key
+- **API key parameter name**: api_key
+- **Location**: URL query string
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/config.json

@@ -0,0 +1,8 @@
+{
+  "gemVersion": "0.1.0",
+  "gemName": "ftc_api_v3_client",
+  "moduleName": "FtcApiV3Client",
+  "gemRequiredRubyVersion": ">= 3.1",
+  "gemHomepage": "https://github.com/maths22/ftc-api-v3-client-ruby",
+  "gemDescription": "API Client for the FTC API (v3)"
+}

data/docs/ApiV3AdvancementFrom.md

@@ -0,0 +1,22 @@
+# FtcApiV3Client::ApiV3AdvancementFrom
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **advancing_team_count** | **Integer** |  |  |
+| **slots** | [**Array<ApiV3AdvancementFromSlot>**](ApiV3AdvancementFromSlot.md) |  |  |
+| **target_event_code** | **String** | The code for the event where teams advance from this event | [optional] |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3AdvancementFrom.new(
+  advancing_team_count: null,
+  slots: null,
+  target_event_code: null
+)
+```
+

data/docs/ApiV3AdvancementFromSlot.md

@@ -0,0 +1,24 @@
+# FtcApiV3Client::ApiV3AdvancementFromSlot
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team** | [**ApiV3SimpleTeam**](ApiV3SimpleTeam.md) |  |  |
+| **criteria** | **String** |  |  |
+| **status** | [**ApiV3AdvancementStatus**](ApiV3AdvancementStatus.md) | This can be null, in which case the team is not currently advancing but the reason is unspecified (e.g. the event is not complete) | [optional] |
+| **points** | **Array<String>** | Total advancement points are the first value; additional values are presented in the order of tiebreaks defined by the competition manual. Only populated for DECODE and later seasons. | [optional] |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3AdvancementFromSlot.new(
+  team: null,
+  criteria: null,
+  status: null,
+  points: null
+)
+```
+

data/docs/ApiV3AdvancementStatus.md

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

data/docs/ApiV3AllianceColor.md

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

data/docs/ApiV3AllianceDescription.md

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

data/docs/ApiV3AllianceMatch.md

@@ -0,0 +1,44 @@
+# FtcApiV3Client::ApiV3AllianceMatch
+
+## 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** | [**ApiV3AllianceMatchResults**](ApiV3AllianceMatchResults.md) |  | [optional] |
+| **teams** | [**ApiV3AllianceMatchParticipants**](ApiV3AllianceMatchParticipants.md) |  |  |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3AllianceMatch.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/ApiV3AllianceMatchDetails.md

@@ -0,0 +1,46 @@
+# FtcApiV3Client::ApiV3AllianceMatchDetails
+
+## 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** | [**ApiV3AllianceMatchResults**](ApiV3AllianceMatchResults.md) |  | [optional] |
+| **teams** | [**ApiV3AllianceMatchParticipants**](ApiV3AllianceMatchParticipants.md) |  |  |
+| **match_results_details** | [**ApiV3AllianceMatchResultsDetails**](ApiV3AllianceMatchResultsDetails.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ftc_api_v3_client'
+
+instance = FtcApiV3Client::ApiV3AllianceMatchDetails.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/ApiV3AllianceMatchParticipants.md

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