Documentation ΒΆ
Index ΒΆ
- Variables
- func Bool(b bool) *bool
- func Float32(f float32) *float32
- func Float64(f float64) *float64
- func Int(i int) *int
- func Int64(i int64) *int64
- func String(s string) *string
- type HTTPClient
- type SDK
- type SDKOption
- func WithClient(client HTTPClient) SDKOption
- func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption
- func WithSecurity(bearerAuth string) SDKOption
- func WithServerIndex(serverIndex int) SDKOption
- func WithServerURL(serverURL string) SDKOption
- func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption
Constants ΒΆ
This section is empty.
Variables ΒΆ
var ServerList = []string{
"https://api4.thetvdb.com/v4",
}
ServerList contains the list of servers available to the SDK
Functions ΒΆ
Types ΒΆ
type HTTPClient ΒΆ
HTTPClient provides an interface for suplying the SDK with a custom HTTP client
type SDK ΒΆ
type SDK struct { Artwork *artwork ArtworkStatuses *artworkStatuses ArtworkTypes *artworkTypes AwardCategories *awardCategories Awards *awards Characters *characters Companies *companies ContentRatings *contentRatings Countries *countries EntityTypes *entityTypes Episodes *episodes Favorites *favorites Genders *genders Genres *genres InspirationTypes *inspirationTypes Languages *languages Lists *lists Login *login MovieStatuses *movieStatuses Movies *movies People *people PeopleTypes *peopleTypes Search *search Seasons *seasons Series *series SeriesStatuses *seriesStatuses SourceTypes *sourceTypes Updates *updates UserInfo *userInfo // contains filtered or unexported fields }
SDK - TVDB API V4: Documentation of [TheTVDB](https://thetvdb.com/) API V4. All related information is linked from our [Github repo](https://github.com/thetvdb/v4-api). You might also want to use our [Postman collection] (https://www.getpostman.com/collections/7a9397ce69ff246f74d0) ## Authentication 1. 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. 2. Executing this call will provide you with a bearer token, which is valid for 1 month. 3. Provide your bearer token for subsequent API calls by clicking Authorize below or including in the header of all direct API calls: `Authorization: Bearer [your-token]`
## Notes 1. "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.
type SDKOption ΒΆ
type SDKOption func(*SDK)
func WithClient ΒΆ
func WithClient(client HTTPClient) SDKOption
WithClient allows the overriding of the default HTTP client used by the SDK
func WithRetryConfig ΒΆ
func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption
func WithSecurity ΒΆ
func WithServerIndex ΒΆ
WithServerIndex allows the overriding of the default server by index
func WithServerURL ΒΆ
WithServerURL allows the overriding of the default server URL
Source Files ΒΆ
- artwork.go
- artworkstatuses.go
- artworktypes.go
- awardcategories.go
- awards.go
- characters.go
- companies.go
- contentratings.go
- countries.go
- entitytypes.go
- episodes.go
- favorites.go
- genders.go
- genres.go
- inspirationtypes.go
- languages.go
- lists.go
- login.go
- movies.go
- moviestatuses.go
- people.go
- peopletypes.go
- sdk.go
- search.go
- seasons.go
- series.go
- seriesstatuses.go
- sourcetypes.go
- updates.go
- userinfo.go