openapi

package
v0.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 28, 2023 License: MIT Imports: 11 Imported by: 0

README ΒΆ

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

package main

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

func main() {
	s := openapi.New(
		openapi.WithSecurity(""),
	)

	var id int64 = 605048

	ctx := context.Background()
	res, err := s.Artwork.GetArtworkBase(ctx, id)
	if err != nil {
		log.Fatal(err)
	}

	if res.GetArtworkBase200ApplicationJSONObject != nil {
		// handle response
	}
}

Available Resources and Operations

Artwork

ArtworkStatuses

ArtworkTypes

AwardCategories

Awards

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

Favorites

Genders

Genres

InspirationTypes

Languages

Lists

Login

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

MovieStatuses

Movies

People

PeopleTypes

  • 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

Error Handling

Handling errors in your 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.

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

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(""),
		openapi.WithServerIndex(0),
	)

	var id int64 = 605048

	ctx := context.Background()
	res, err := s.Artwork.GetArtworkBase(ctx, id)
	if err != nil {
		log.Fatal(err)
	}

	if res.GetArtworkBase200ApplicationJSONObject != 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.WithSecurity(""),
		openapi.WithServerURL("https://api4.thetvdb.com/v4"),
	)

	var id int64 = 605048

	ctx := context.Background()
	res, err := s.Artwork.GetArtworkBase(ctx, id)
	if err != nil {
		log.Fatal(err)
	}

	if res.GetArtworkBase200ApplicationJSONObject != 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.

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. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy

Documentation ΒΆ

Index ΒΆ

Constants ΒΆ

This section is empty.

Variables ΒΆ

View Source
var ServerList = []string{
	"https://api4.thetvdb.com/v4",
}

ServerList contains the list of servers available to the SDK

Functions ΒΆ

func Bool ΒΆ

func Bool(b bool) *bool

Bool provides a helper function to return a pointer to a bool

func Float32 ΒΆ

func Float32(f float32) *float32

Float32 provides a helper function to return a pointer to a float32

func Float64 ΒΆ

func Float64(f float64) *float64

Float64 provides a helper function to return a pointer to a float64

func Int ΒΆ

func Int(i int) *int

Int provides a helper function to return a pointer to an int

func Int64 ΒΆ

func Int64(i int64) *int64

Int64 provides a helper function to return a pointer to an int64

func String ΒΆ

func String(s string) *string

String provides a helper function to return a pointer to a string

Types ΒΆ

type HTTPClient ΒΆ

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

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.

func New ΒΆ

func New(opts ...SDKOption) *SDK

New creates a new instance of the SDK with the provided options

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 WithSecurity(bearerAuth string) SDKOption

func WithServerIndex ΒΆ

func WithServerIndex(serverIndex int) SDKOption

WithServerIndex allows the overriding of the default server by index

func WithServerURL ΒΆ

func WithServerURL(serverURL string) SDKOption

WithServerURL allows the overriding of the default server URL

func WithTemplatedServerURL ΒΆ

func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters

Directories ΒΆ

Path Synopsis
models

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL