client

package
v0.0.0-...-6fcb5ef Latest Latest
Warning

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

Go to latest
Published: Jan 27, 2020 License: MPL-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// DefaultHost is the default Host
	// found in Meta (info) section of spec file
	DefaultHost string = "api.thetvdb.com"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/"
)

Variables

View Source
var Default = NewHTTPClient(nil)

Default the tvdb API v3HTTP client.

View Source
var DefaultSchemes = []string{"https"}

DefaultSchemes are the default schemes found in Meta (info) section of spec file

Functions

This section is empty.

Types

type TheTVDBAPIV3

type TheTVDBAPIV3 struct {
	Authentication *authentication.Client

	Episodes *episodes.Client

	Languages *languages.Client

	Movies *movies.Client

	Search *search.Client

	Series *series.Client

	Updates *updates.Client

	Users *users.Client

	Transport runtime.ClientTransport
}

TheTVDBAPIV3 is a client for the tvdb API v3

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) *TheTVDBAPIV3

New creates a new the tvdb API v3client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *TheTVDBAPIV3

NewHTTPClient creates a new the tvdb API v3HTTP client.

func NewHTTPClientWithConfig

func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *TheTVDBAPIV3

NewHTTPClientWithConfig creates a new the tvdb API v3HTTP client, using a customizable transport config.

func (*TheTVDBAPIV3) SetTransport

func (c *TheTVDBAPIV3) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client and all its subresources

type TransportConfig

type TransportConfig struct {
	Host     string
	BasePath string
	Schemes  []string
}

TransportConfig contains the transport related info, found in the meta section of the spec file.

func DefaultTransportConfig

func DefaultTransportConfig() *TransportConfig

DefaultTransportConfig creates a TransportConfig with the default settings taken from the meta section of the spec file.

func (*TransportConfig) WithBasePath

func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig

WithBasePath overrides the default basePath, provided by the meta section of the spec file.

func (*TransportConfig) WithHost

func (cfg *TransportConfig) WithHost(host string) *TransportConfig

WithHost overrides the default host, provided by the meta section of the spec file.

func (*TransportConfig) WithSchemes

func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

WithSchemes overrides the default schemes, provided by the meta section of the spec file.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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