Skip to content

Commit 17bf7d6

Browse files
author
Travis CI User
committed
Updating to API version 3.8.0
1 parent efeddcf commit 17bf7d6

114 files changed

Lines changed: 4982 additions & 1844 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ coverage.xml
4545
*,cover
4646
.hypothesis/
4747
venv/
48+
.venv/
4849
.python-version
50+
.pytest_cache
4951

5052
# Translations
5153
*.mo

‎.openapi-generator/VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
4.1.3
1+
4.2.3

‎README.md‎

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
# tba-api-v3client
2-
# Overview Information and statistics about FIRST Robotics Competition teams and events. # Authentication All endpoints require an Auth Key to be passed in the header `X-TBA-Auth-Key`. If you do not have an auth key yet, you can obtain one from your [Account Page](/account). A `User-Agent` header may need to be set to prevent a 403 Unauthorized error.
2+
# Overview
3+
4+
Information and statistics about FIRST Robotics Competition teams and events.
5+
6+
# Authentication
7+
8+
All endpoints require an Auth Key to be passed in the header `X-TBA-Auth-Key`. If you do not have an auth key yet, you can obtain one from your [Account Page](/account).
9+
10+
A `User-Agent` header may need to be set to prevent a 403 Unauthorized error.
311

412
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
513

6-
- API version: 3.5
7-
- Package version: 3.5
14+
- API version: 3.8.0
15+
- Package version: 3.8.0
816
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
917

1018
## Requirements.
@@ -23,7 +31,7 @@ pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
2331

2432
Then import the package:
2533
```python
26-
import tbaapiv3client
34+
import tbaapiv3client
2735
```
2836

2937
### Setuptools
@@ -59,16 +67,18 @@ configuration.api_key['X-TBA-Auth-Key'] = 'YOUR_API_KEY'
5967

6068
# Defining host is optional and default to https://www.thebluealliance.com/api/v3
6169
configuration.host = "https://www.thebluealliance.com/api/v3"
62-
# Create an instance of the API class
63-
api_instance = tbaapiv3client.TBAApi(tbaapiv3client.ApiClient(configuration))
64-
if_modified_since = 'if_modified_since_example' # str | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
65-
66-
try:
67-
api_response = api_instance.get_status(if_modified_since=if_modified_since)
68-
pprint(api_response)
69-
except ApiException as e:
70-
print("Exception when calling TBAApi->get_status: %s\n" % e)
71-
70+
# Enter a context with an instance of the API client
71+
with tbaapiv3client.ApiClient(configuration) as api_client:
72+
# Create an instance of the API class
73+
api_instance = tbaapiv3client.TBAApi(api_client)
74+
if_modified_since = 'if_modified_since_example' # str | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
75+
76+
try:
77+
api_response = api_instance.get_status(if_modified_since=if_modified_since)
78+
pprint(api_response)
79+
except ApiException as e:
80+
print("Exception when calling TBAApi->get_status: %s\n" % e)
81+
7282
```
7383

7484
## Documentation for API Endpoints
@@ -151,6 +161,7 @@ Class | Method | HTTP request | Description
151161
*MatchApi* | [**get_match**](docs/MatchApi.md#get_match) | **GET** /match/{match_key} |
152162
*MatchApi* | [**get_match_simple**](docs/MatchApi.md#get_match_simple) | **GET** /match/{match_key}/simple |
153163
*MatchApi* | [**get_match_timeseries**](docs/MatchApi.md#get_match_timeseries) | **GET** /match/{match_key}/timeseries |
164+
*MatchApi* | [**get_match_zebra**](docs/MatchApi.md#get_match_zebra) | **GET** /match/{match_key}/zebra_motionworks |
154165
*MatchApi* | [**get_team_event_matches**](docs/MatchApi.md#get_team_event_matches) | **GET** /team/{team_key}/event/{event_key}/matches |
155166
*MatchApi* | [**get_team_event_matches_keys**](docs/MatchApi.md#get_team_event_matches_keys) | **GET** /team/{team_key}/event/{event_key}/matches/keys |
156167
*MatchApi* | [**get_team_event_matches_simple**](docs/MatchApi.md#get_team_event_matches_simple) | **GET** /team/{team_key}/event/{event_key}/matches/simple |
@@ -237,6 +248,8 @@ Class | Method | HTTP request | Description
237248
- [MatchScoreBreakdown2018Alliance](docs/MatchScoreBreakdown2018Alliance.md)
238249
- [MatchScoreBreakdown2019](docs/MatchScoreBreakdown2019.md)
239250
- [MatchScoreBreakdown2019Alliance](docs/MatchScoreBreakdown2019Alliance.md)
251+
- [MatchScoreBreakdown2020](docs/MatchScoreBreakdown2020.md)
252+
- [MatchScoreBreakdown2020Alliance](docs/MatchScoreBreakdown2020Alliance.md)
240253
- [MatchSimple](docs/MatchSimple.md)
241254
- [MatchSimpleAlliances](docs/MatchSimpleAlliances.md)
242255
- [MatchTimeseries2018](docs/MatchTimeseries2018.md)
@@ -254,6 +267,9 @@ Class | Method | HTTP request | Description
254267
- [TeamSimple](docs/TeamSimple.md)
255268
- [WLTRecord](docs/WLTRecord.md)
256269
- [Webcast](docs/Webcast.md)
270+
- [Zebra](docs/Zebra.md)
271+
- [ZebraAlliances](docs/ZebraAlliances.md)
272+
- [ZebraTeam](docs/ZebraTeam.md)
257273

258274

259275
## Documentation For Authorization

‎docs/AwardRecipient.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# AwardRecipient
22

3+
An `Award_Recipient` object represents the team and/or person who received an award at an event.
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------

‎docs/DistrictApi.md‎

Lines changed: 100 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,18 @@ configuration.api_key['X-TBA-Auth-Key'] = 'YOUR_API_KEY'
4040

4141
# Defining host is optional and default to https://www.thebluealliance.com/api/v3
4242
configuration.host = "https://www.thebluealliance.com/api/v3"
43-
# Create an instance of the API class
44-
api_instance = tbaapiv3client.DistrictApi(tbaapiv3client.ApiClient(configuration))
45-
district_key = 'district_key_example' # str | TBA District Key, eg `2016fim`
43+
# Enter a context with an instance of the API client
44+
with tbaapiv3client.ApiClient(configuration) as api_client:
45+
# Create an instance of the API class
46+
api_instance = tbaapiv3client.DistrictApi(api_client)
47+
district_key = 'district_key_example' # str | TBA District Key, eg `2016fim`
4648
if_modified_since = 'if_modified_since_example' # str | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
4749

48-
try:
49-
api_response = api_instance.get_district_events(district_key, if_modified_since=if_modified_since)
50-
pprint(api_response)
51-
except ApiException as e:
52-
print("Exception when calling DistrictApi->get_district_events: %s\n" % e)
50+
try:
51+
api_response = api_instance.get_district_events(district_key, if_modified_since=if_modified_since)
52+
pprint(api_response)
53+
except ApiException as e:
54+
print("Exception when calling DistrictApi->get_district_events: %s\n" % e)
5355
```
5456

5557
### Parameters
@@ -105,16 +107,18 @@ configuration.api_key['X-TBA-Auth-Key'] = 'YOUR_API_KEY'
105107

106108
# Defining host is optional and default to https://www.thebluealliance.com/api/v3
107109
configuration.host = "https://www.thebluealliance.com/api/v3"
108-
# Create an instance of the API class
109-
api_instance = tbaapiv3client.DistrictApi(tbaapiv3client.ApiClient(configuration))
110-
district_key = 'district_key_example' # str | TBA District Key, eg `2016fim`
110+
# Enter a context with an instance of the API client
111+
with tbaapiv3client.ApiClient(configuration) as api_client:
112+
# Create an instance of the API class
113+
api_instance = tbaapiv3client.DistrictApi(api_client)
114+
district_key = 'district_key_example' # str | TBA District Key, eg `2016fim`
111115
if_modified_since = 'if_modified_since_example' # str | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
112116

113-
try:
114-
api_response = api_instance.get_district_events_keys(district_key, if_modified_since=if_modified_since)
115-
pprint(api_response)
116-
except ApiException as e:
117-
print("Exception when calling DistrictApi->get_district_events_keys: %s\n" % e)
117+
try:
118+
api_response = api_instance.get_district_events_keys(district_key, if_modified_since=if_modified_since)
119+
pprint(api_response)
120+
except ApiException as e:
121+
print("Exception when calling DistrictApi->get_district_events_keys: %s\n" % e)
118122
```
119123

120124
### Parameters
@@ -170,16 +174,18 @@ configuration.api_key['X-TBA-Auth-Key'] = 'YOUR_API_KEY'
170174

171175
# Defining host is optional and default to https://www.thebluealliance.com/api/v3
172176
configuration.host = "https://www.thebluealliance.com/api/v3"
173-
# Create an instance of the API class
174-
api_instance = tbaapiv3client.DistrictApi(tbaapiv3client.ApiClient(configuration))
175-
district_key = 'district_key_example' # str | TBA District Key, eg `2016fim`
177+
# Enter a context with an instance of the API client
178+
with tbaapiv3client.ApiClient(configuration) as api_client:
179+
# Create an instance of the API class
180+
api_instance = tbaapiv3client.DistrictApi(api_client)
181+
district_key = 'district_key_example' # str | TBA District Key, eg `2016fim`
176182
if_modified_since = 'if_modified_since_example' # str | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
177183

178-
try:
179-
api_response = api_instance.get_district_events_simple(district_key, if_modified_since=if_modified_since)
180-
pprint(api_response)
181-
except ApiException as e:
182-
print("Exception when calling DistrictApi->get_district_events_simple: %s\n" % e)
184+
try:
185+
api_response = api_instance.get_district_events_simple(district_key, if_modified_since=if_modified_since)
186+
pprint(api_response)
187+
except ApiException as e:
188+
print("Exception when calling DistrictApi->get_district_events_simple: %s\n" % e)
183189
```
184190

185191
### Parameters
@@ -235,16 +241,18 @@ configuration.api_key['X-TBA-Auth-Key'] = 'YOUR_API_KEY'
235241

236242
# Defining host is optional and default to https://www.thebluealliance.com/api/v3
237243
configuration.host = "https://www.thebluealliance.com/api/v3"
238-
# Create an instance of the API class
239-
api_instance = tbaapiv3client.DistrictApi(tbaapiv3client.ApiClient(configuration))
240-
district_key = 'district_key_example' # str | TBA District Key, eg `2016fim`
244+
# Enter a context with an instance of the API client
245+
with tbaapiv3client.ApiClient(configuration) as api_client:
246+
# Create an instance of the API class
247+
api_instance = tbaapiv3client.DistrictApi(api_client)
248+
district_key = 'district_key_example' # str | TBA District Key, eg `2016fim`
241249
if_modified_since = 'if_modified_since_example' # str | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
242250

243-
try:
244-
api_response = api_instance.get_district_rankings(district_key, if_modified_since=if_modified_since)
245-
pprint(api_response)
246-
except ApiException as e:
247-
print("Exception when calling DistrictApi->get_district_rankings: %s\n" % e)
251+
try:
252+
api_response = api_instance.get_district_rankings(district_key, if_modified_since=if_modified_since)
253+
pprint(api_response)
254+
except ApiException as e:
255+
print("Exception when calling DistrictApi->get_district_rankings: %s\n" % e)
248256
```
249257

250258
### Parameters
@@ -300,16 +308,18 @@ configuration.api_key['X-TBA-Auth-Key'] = 'YOUR_API_KEY'
300308

301309
# Defining host is optional and default to https://www.thebluealliance.com/api/v3
302310
configuration.host = "https://www.thebluealliance.com/api/v3"
303-
# Create an instance of the API class
304-
api_instance = tbaapiv3client.DistrictApi(tbaapiv3client.ApiClient(configuration))
305-
district_key = 'district_key_example' # str | TBA District Key, eg `2016fim`
311+
# Enter a context with an instance of the API client
312+
with tbaapiv3client.ApiClient(configuration) as api_client:
313+
# Create an instance of the API class
314+
api_instance = tbaapiv3client.DistrictApi(api_client)
315+
district_key = 'district_key_example' # str | TBA District Key, eg `2016fim`
306316
if_modified_since = 'if_modified_since_example' # str | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
307317

308-
try:
309-
api_response = api_instance.get_district_teams(district_key, if_modified_since=if_modified_since)
310-
pprint(api_response)
311-
except ApiException as e:
312-
print("Exception when calling DistrictApi->get_district_teams: %s\n" % e)
318+
try:
319+
api_response = api_instance.get_district_teams(district_key, if_modified_since=if_modified_since)
320+
pprint(api_response)
321+
except ApiException as e:
322+
print("Exception when calling DistrictApi->get_district_teams: %s\n" % e)
313323
```
314324

315325
### Parameters
@@ -365,16 +375,18 @@ configuration.api_key['X-TBA-Auth-Key'] = 'YOUR_API_KEY'
365375

366376
# Defining host is optional and default to https://www.thebluealliance.com/api/v3
367377
configuration.host = "https://www.thebluealliance.com/api/v3"
368-
# Create an instance of the API class
369-
api_instance = tbaapiv3client.DistrictApi(tbaapiv3client.ApiClient(configuration))
370-
district_key = 'district_key_example' # str | TBA District Key, eg `2016fim`
378+
# Enter a context with an instance of the API client
379+
with tbaapiv3client.ApiClient(configuration) as api_client:
380+
# Create an instance of the API class
381+
api_instance = tbaapiv3client.DistrictApi(api_client)
382+
district_key = 'district_key_example' # str | TBA District Key, eg `2016fim`
371383
if_modified_since = 'if_modified_since_example' # str | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
372384

373-
try:
374-
api_response = api_instance.get_district_teams_keys(district_key, if_modified_since=if_modified_since)
375-
pprint(api_response)
376-
except ApiException as e:
377-
print("Exception when calling DistrictApi->get_district_teams_keys: %s\n" % e)
385+
try:
386+
api_response = api_instance.get_district_teams_keys(district_key, if_modified_since=if_modified_since)
387+
pprint(api_response)
388+
except ApiException as e:
389+
print("Exception when calling DistrictApi->get_district_teams_keys: %s\n" % e)
378390
```
379391

380392
### Parameters
@@ -430,16 +442,18 @@ configuration.api_key['X-TBA-Auth-Key'] = 'YOUR_API_KEY'
430442

431443
# Defining host is optional and default to https://www.thebluealliance.com/api/v3
432444
configuration.host = "https://www.thebluealliance.com/api/v3"
433-
# Create an instance of the API class
434-
api_instance = tbaapiv3client.DistrictApi(tbaapiv3client.ApiClient(configuration))
435-
district_key = 'district_key_example' # str | TBA District Key, eg `2016fim`
445+
# Enter a context with an instance of the API client
446+
with tbaapiv3client.ApiClient(configuration) as api_client:
447+
# Create an instance of the API class
448+
api_instance = tbaapiv3client.DistrictApi(api_client)
449+
district_key = 'district_key_example' # str | TBA District Key, eg `2016fim`
436450
if_modified_since = 'if_modified_since_example' # str | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
437451

438-
try:
439-
api_response = api_instance.get_district_teams_simple(district_key, if_modified_since=if_modified_since)
440-
pprint(api_response)
441-
except ApiException as e:
442-
print("Exception when calling DistrictApi->get_district_teams_simple: %s\n" % e)
452+
try:
453+
api_response = api_instance.get_district_teams_simple(district_key, if_modified_since=if_modified_since)
454+
pprint(api_response)
455+
except ApiException as e:
456+
print("Exception when calling DistrictApi->get_district_teams_simple: %s\n" % e)
443457
```
444458

445459
### Parameters
@@ -495,16 +509,18 @@ configuration.api_key['X-TBA-Auth-Key'] = 'YOUR_API_KEY'
495509

496510
# Defining host is optional and default to https://www.thebluealliance.com/api/v3
497511
configuration.host = "https://www.thebluealliance.com/api/v3"
498-
# Create an instance of the API class
499-
api_instance = tbaapiv3client.DistrictApi(tbaapiv3client.ApiClient(configuration))
500-
year = 56 # int | Competition Year (or Season). Must be 4 digits.
512+
# Enter a context with an instance of the API client
513+
with tbaapiv3client.ApiClient(configuration) as api_client:
514+
# Create an instance of the API class
515+
api_instance = tbaapiv3client.DistrictApi(api_client)
516+
year = 56 # int | Competition Year (or Season). Must be 4 digits.
501517
if_modified_since = 'if_modified_since_example' # str | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
502518

503-
try:
504-
api_response = api_instance.get_districts_by_year(year, if_modified_since=if_modified_since)
505-
pprint(api_response)
506-
except ApiException as e:
507-
print("Exception when calling DistrictApi->get_districts_by_year: %s\n" % e)
519+
try:
520+
api_response = api_instance.get_districts_by_year(year, if_modified_since=if_modified_since)
521+
pprint(api_response)
522+
except ApiException as e:
523+
print("Exception when calling DistrictApi->get_districts_by_year: %s\n" % e)
508524
```
509525

510526
### Parameters
@@ -560,16 +576,18 @@ configuration.api_key['X-TBA-Auth-Key'] = 'YOUR_API_KEY'
560576

561577
# Defining host is optional and default to https://www.thebluealliance.com/api/v3
562578
configuration.host = "https://www.thebluealliance.com/api/v3"
563-
# Create an instance of the API class
564-
api_instance = tbaapiv3client.DistrictApi(tbaapiv3client.ApiClient(configuration))
565-
event_key = 'event_key_example' # str | TBA Event Key, eg `2016nytr`
579+
# Enter a context with an instance of the API client
580+
with tbaapiv3client.ApiClient(configuration) as api_client:
581+
# Create an instance of the API class
582+
api_instance = tbaapiv3client.DistrictApi(api_client)
583+
event_key = 'event_key_example' # str | TBA Event Key, eg `2016nytr`
566584
if_modified_since = 'if_modified_since_example' # str | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
567585

568-
try:
569-
api_response = api_instance.get_event_district_points(event_key, if_modified_since=if_modified_since)
570-
pprint(api_response)
571-
except ApiException as e:
572-
print("Exception when calling DistrictApi->get_event_district_points: %s\n" % e)
586+
try:
587+
api_response = api_instance.get_event_district_points(event_key, if_modified_since=if_modified_since)
588+
pprint(api_response)
589+
except ApiException as e:
590+
print("Exception when calling DistrictApi->get_event_district_points: %s\n" % e)
573591
```
574592

575593
### Parameters
@@ -625,16 +643,18 @@ configuration.api_key['X-TBA-Auth-Key'] = 'YOUR_API_KEY'
625643

626644
# Defining host is optional and default to https://www.thebluealliance.com/api/v3
627645
configuration.host = "https://www.thebluealliance.com/api/v3"
628-
# Create an instance of the API class
629-
api_instance = tbaapiv3client.DistrictApi(tbaapiv3client.ApiClient(configuration))
630-
team_key = 'team_key_example' # str | TBA Team Key, eg `frc254`
646+
# Enter a context with an instance of the API client
647+
with tbaapiv3client.ApiClient(configuration) as api_client:
648+
# Create an instance of the API class
649+
api_instance = tbaapiv3client.DistrictApi(api_client)
650+
team_key = 'team_key_example' # str | TBA Team Key, eg `frc254`
631651
if_modified_since = 'if_modified_since_example' # str | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
632652

633-
try:
634-
api_response = api_instance.get_team_districts(team_key, if_modified_since=if_modified_since)
635-
pprint(api_response)
636-
except ApiException as e:
637-
print("Exception when calling DistrictApi->get_team_districts: %s\n" % e)
653+
try:
654+
api_response = api_instance.get_team_districts(team_key, if_modified_since=if_modified_since)
655+
pprint(api_response)
656+
except ApiException as e:
657+
print("Exception when calling DistrictApi->get_team_districts: %s\n" % e)
638658
```
639659

640660
### Parameters

‎docs/DistrictRanking.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# DistrictRanking
22

3+
Rank of a team in a district.
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------

‎docs/EliminationAllianceBackup.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# EliminationAllianceBackup
22

3+
Backup team called in, may be null.
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------

0 commit comments

Comments
 (0)