1 unstable release
4.7.8 |
|
---|---|
0.1.0 | Jan 14, 2024 |
#2270 in Web programming
490KB
7K
SLoC
Rust client for TVDB API v4
This API is generated from the official OpenAPI spec using OpenAPI Generator. However, there's some known errors with the data returned, so use at your own risk and this lib is not affiliated with thetvdb.com in any way
Notices from the TVDB
Authentication
- Use the /login endpoint and provide your API key as "apikey". If you have a user-supported key, also provide your subscriber PIN as "pin". Otherwise completely remove "pin" from your call.
- Executing this call will provide you with a bearer token, which is valid for 1 month.
- Provide your bearer token for subsequent API calls by including it in headers.
Notes
- "score" is a field across almost all entities. We generate scores for different types of entities in various ways, so no assumptions should be made about the meaning of this value. It is simply used to hint at relative popularity for sorting purposes.
Overview
- API version: 4.7.8
- Package version: 4.7.8
Installation
Add following line to Cargo.toml
of your project:
[dependencies]
tvdb4 = "4.7.8"
Documentation for API Endpoints
All URIs are relative to https://api4.thetvdb.com/v4
Class | Method | HTTP request | Description |
---|---|---|---|
ArtworkApi | get_artwork_base | GET /artwork/{id} | |
ArtworkApi | get_artwork_extended | GET /artwork/{id}/extended | |
ArtworkStatusesApi | get_all_artwork_statuses | GET /artwork/statuses | |
ArtworkTypesApi | get_all_artwork_types | GET /artwork/types | |
AwardCategoriesApi | get_award_category | GET /awards/categories/{id} | |
AwardCategoriesApi | get_award_category_extended | GET /awards/categories/{id}/extended | |
AwardsApi | get_all_awards | GET /awards | |
AwardsApi | get_award | GET /awards/{id} | |
AwardsApi | get_award_extended | GET /awards/{id}/extended | |
CharactersApi | get_character_base | GET /characters/{id} | |
CompaniesApi | get_all_companies | GET /companies | |
CompaniesApi | get_company | GET /companies/{id} | |
CompaniesApi | get_company_types | GET /companies/types | |
ContentRatingsApi | get_all_content_ratings | GET /content/ratings | |
CountriesApi | get_all_countries | GET /countries | |
EntityTypesApi | get_entity_types | GET /entities | |
EpisodesApi | get_all_episodes | GET /episodes | |
EpisodesApi | get_episode_base | GET /episodes/{id} | |
EpisodesApi | get_episode_extended | GET /episodes/{id}/extended | |
EpisodesApi | get_episode_translation | GET /episodes/{id}/translations/{language} | |
FavoritesApi | create_user_favorites | POST /user/favorites | |
FavoritesApi | get_user_favorites | GET /user/favorites | |
GendersApi | get_all_genders | GET /genders | |
GenresApi | get_all_genres | GET /genres | |
GenresApi | get_genre_base | GET /genres/{id} | |
InspirationTypesApi | get_all_inspiration_types | GET /inspiration/types | |
LanguagesApi | get_all_languages | GET /languages | |
ListsApi | get_all_lists | GET /lists | |
ListsApi | get_list | GET /lists/{id} | |
ListsApi | get_list_by_slug | GET /lists/slug/{slug} | |
ListsApi | get_list_extended | GET /lists/{id}/extended | |
ListsApi | get_list_translation | GET /lists/{id}/translations/{language} | |
LoginApi | login_post | POST /login | create an auth token. The token has one month validation length. |
MovieStatusesApi | get_all_movie_statuses | GET /movies/statuses | |
MoviesApi | get_all_movie | GET /movies | |
MoviesApi | get_movie_base | GET /movies/{id} | |
MoviesApi | get_movie_base_by_slug | GET /movies/slug/{slug} | |
MoviesApi | get_movie_extended | GET /movies/{id}/extended | |
MoviesApi | get_movie_translation | GET /movies/{id}/translations/{language} | |
MoviesApi | get_movies_filter | GET /movies/filter | |
PeopleApi | get_all_people | GET /people | |
PeopleApi | get_people_base | GET /people/{id} | |
PeopleApi | get_people_extended | GET /people/{id}/extended | |
PeopleApi | get_people_translation | GET /people/{id}/translations/{language} | |
PeopleTypesApi | get_all_people_types | GET /people/types | |
SearchApi | get_search_results | GET /search | |
SearchApi | get_search_results_by_remote_id | GET /search/remoteid/{remoteId} | |
SeasonsApi | get_all_seasons | GET /seasons | |
SeasonsApi | get_season_base | GET /seasons/{id} | |
SeasonsApi | get_season_extended | GET /seasons/{id}/extended | |
SeasonsApi | get_season_translation | GET /seasons/{id}/translations/{language} | |
SeasonsApi | get_season_types | GET /seasons/types | |
SeriesApi | get_all_series | GET /series | |
SeriesApi | get_series_artworks | GET /series/{id}/artworks | |
SeriesApi | get_series_base | GET /series/{id} | |
SeriesApi | get_series_base_by_slug | GET /series/slug/{slug} | |
SeriesApi | get_series_episodes | GET /series/{id}/episodes/{season-type} | |
SeriesApi | get_series_extended | GET /series/{id}/extended | |
SeriesApi | get_series_filter | GET /series/filter | |
SeriesApi | get_series_next_aired | GET /series/{id}/nextAired | |
SeriesApi | get_series_season_episodes_translated | GET /series/{id}/episodes/{season-type}/{lang} | |
SeriesApi | get_series_translation | GET /series/{id}/translations/{language} | |
SeriesStatusesApi | get_all_series_statuses | GET /series/statuses | |
SourceTypesApi | get_all_source_types | GET /sources/types | |
UpdatesApi | updates | GET /updates | |
UserInfoApi | get_user_info | GET /user | |
UserInfoApi | get_user_info_by_id | GET /user/{id} |
Documentation For Models
- Alias
- ArtworkBaseRecord
- ArtworkExtendedRecord
- ArtworkStatus
- ArtworkType
- AwardBaseRecord
- AwardCategoryBaseRecord
- AwardCategoryExtendedRecord
- AwardExtendedRecord
- AwardNomineeBaseRecord
- Biography
- Character
- Companies
- Company
- CompanyRelationShip
- CompanyType
- ContentRating
- Country
- Entity
- EntityType
- EntityUpdate
- EpisodeBaseRecord
- EpisodeExtendedRecord
- FavoriteRecord
- Favorites
- Gender
- GenreBaseRecord
- GetAllArtworkStatuses200Response
- GetAllArtworkTypes200Response
- GetAllAwards200Response
- GetAllCompanies200Response
- GetAllContentRatings200Response
- GetAllCountries200Response
- GetAllEpisodes200Response
- GetAllGenders200Response
- GetAllGenres200Response
- GetAllInspirationTypes200Response
- GetAllLanguages200Response
- GetAllLists200Response
- GetAllMovie200Response
- GetAllMovieStatuses200Response
- GetAllPeople200Response
- GetAllPeopleTypes200Response
- GetAllSeasons200Response
- GetAllSeries200Response
- GetAllSourceTypes200Response
- GetArtworkBase200Response
- GetArtworkExtended200Response
- GetAward200Response
- GetAwardCategory200Response
- GetAwardCategoryExtended200Response
- GetAwardExtended200Response
- GetCharacterBase200Response
- GetCompany200Response
- GetCompanyTypes200Response
- GetEntityTypes200Response
- GetEpisodeBase200Response
- GetEpisodeExtended200Response
- GetEpisodeTranslation200Response
- GetGenreBase200Response
- GetList200Response
- GetListExtended200Response
- GetListTranslation200Response
- GetMovieBase200Response
- GetMovieExtended200Response
- GetMoviesFilter200Response
- GetPeopleBase200Response
- GetPeopleExtended200Response
- GetSearchResults200Response
- GetSearchResultsByRemoteId200Response
- GetSeasonBase200Response
- GetSeasonExtended200Response
- GetSeasonTypes200Response
- GetSeriesArtworks200Response
- GetSeriesBase200Response
- GetSeriesEpisodes200Response
- GetSeriesEpisodes200ResponseData
- GetSeriesFilter200Response
- GetSeriesSeasonEpisodesTranslated200Response
- GetSeriesSeasonEpisodesTranslated200ResponseData
- GetUserFavorites200Response
- GetUserInfo200Response
- Inspiration
- InspirationType
- Language
- Links
- ListBaseRecord
- ListExtendedRecord
- LoginPost200Response
- LoginPost200ResponseData
- LoginPostRequest
- MovieBaseRecord
- MovieExtendedRecord
- ParentCompany
- PeopleBaseRecord
- PeopleExtendedRecord
- PeopleType
- ProductionCountry
- RecordInfo
- Release
- RemoteId
- SearchByRemoteIdResult
- SearchResult
- SeasonBaseRecord
- SeasonExtendedRecord
- SeasonType
- SeriesAirsDays
- SeriesBaseRecord
- SeriesExtendedRecord
- SourceType
- Status
- StudioBaseRecord
- Tag
- TagOption
- TagOptionEntity
- Trailer
- Translation
- TranslationExtended
- TranslationSimple
- Updates200Response
- UserInfo
Dependencies
~4–16MB
~228K SLoC