Skip to content

Latest commit

 

History

History
435 lines (310 loc) · 16.6 KB

README.md

File metadata and controls

435 lines (310 loc) · 16.6 KB

github.com/dashotv/tvdb/openapi

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

SDK Installation

go get github.com/dashotv/tvdb/openapi

SDK Example Usage

Example

package main

import (
	"context"
	"github.com/dashotv/tvdb/openapi"
	"github.com/dashotv/tvdb/openapi/models/shared"
	"log"
)

func main() {
	s := openapi.New(
		openapi.WithSecurity(shared.Security{
			BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
		}),
	)

	ctx := context.Background()
	res, err := s.ArtworkStatuses.GetAllArtworkStatuses(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Available Resources and Operations

ArtworkStatuses

ArtworkTypes

Artwork

Awards

AwardCategories

Characters

Companies

ContentRatings

Countries

EntityTypes

Episodes

  • GetAllEpisodes - Returns a list of episodes base records with the basic attributes.
    Note that all episodes are returned, even those that may not be included in a series' default season order.
  • GetEpisodeBase - Returns episode base record
  • GetEpisodeExtended - Returns episode extended record
  • GetEpisodeTranslation - Returns episode translation record

Genders

Genres

InspirationTypes

Languages

Lists

Login

  • PostLogin - create an auth token. The token has one month validation length.

Movies

MovieStatuses

People

PeopleTypes

Search

  • GetSearchResults - Our search index includes series, movies, people, and companies. Search is limited to 5k results max.
  • GetSearchResultsByRemoteID - Search a series, movie, people, episode, company or season by specific remote id and returns a base record for that entity.

Seasons

Series

  • GetAllSeries - returns list of series base records
  • GetSeriesArtworks - Returns series artworks base on language and type.
    Note: Artwork type is an id that can be found using /artwork/types endpoint.
  • GetSeriesBase - Returns series base record
  • GetSeriesBaseBySlug - Returns series base record searched by slug
  • GetSeriesEpisodes - Returns series episodes from the specified season type, default returns the episodes in the series default season type
  • GetSeriesExtended - Returns series extended record
  • GetSeriesFilter - Search series based on filter parameters
  • GetSeriesNextAired - Returns series base record including the nextAired field.
    Note: nextAired was included in the base record endpoint but that field will deprecated in the future so developers should use the nextAired endpoint.
  • GetSeriesSeasonEpisodesTranslated - Returns series base record with episodes from the specified season type and language. Default returns the episodes in the series default season type.
  • GetSeriesTranslation - Returns series translation record

SeriesStatuses

SourceTypes

Updates

  • Updates - Returns updated entities. methodInt indicates a created record (1), an updated record (2), or a deleted record (3). If a record is deleted because it was a duplicate of another record, the target record's information is provided in mergeToType and mergeToId.

UserInfo

Favorites

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

Example

package main

import (
	"context"
	"errors"
	"github.com/dashotv/tvdb/openapi"
	"github.com/dashotv/tvdb/openapi/models/sdkerrors"
	"github.com/dashotv/tvdb/openapi/models/shared"
	"log"
)

func main() {
	s := openapi.New(
		openapi.WithSecurity(shared.Security{
			BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
		}),
	)

	ctx := context.Background()
	res, err := s.ArtworkStatuses.GetAllArtworkStatuses(ctx)
	if err != nil {

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Select Server by Index

You can override the default server globally using the WithServerIndex option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Variables
0 https://api4.thetvdb.com/v4 None

Example

package main

import (
	"context"
	"github.com/dashotv/tvdb/openapi"
	"github.com/dashotv/tvdb/openapi/models/shared"
	"log"
)

func main() {
	s := openapi.New(
		openapi.WithServerIndex(0),
		openapi.WithSecurity(shared.Security{
			BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
		}),
	)

	ctx := context.Background()
	res, err := s.ArtworkStatuses.GetAllArtworkStatuses(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL option when initializing the SDK client instance. For example:

package main

import (
	"context"
	"github.com/dashotv/tvdb/openapi"
	"github.com/dashotv/tvdb/openapi/models/shared"
	"log"
)

func main() {
	s := openapi.New(
		openapi.WithServerURL("https://api4.thetvdb.com/v4"),
		openapi.WithSecurity(shared.Security{
			BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
		}),
	)

	ctx := context.Background()
	res, err := s.ArtworkStatuses.GetAllArtworkStatuses(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"
	"github.com/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
BearerAuth http HTTP Bearer

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	"github.com/dashotv/tvdb/openapi"
	"github.com/dashotv/tvdb/openapi/models/shared"
	"log"
)

func main() {
	s := openapi.New(
		openapi.WithSecurity(shared.Security{
			BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
		}),
	)

	ctx := context.Background()
	res, err := s.ArtworkStatuses.GetAllArtworkStatuses(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Special Types

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy