openapi

package
v0.5.0 Latest Latest
Warning

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

 Go to latest Published: Jul 8, 2024 License: MIT Imports: 13 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

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
  • 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

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 Artwork added in v0.3.0 

type Artwork struct {
	// contains filtered or unexported fields
}

func (*Artwork) GetArtworkBase added in v0.3.0 

func (s *Artwork) GetArtworkBase(ctx context.Context, id float64) (*operations.GetArtworkBaseResponse, error)

GetArtworkBase - Returns a single artwork base record.

func (*Artwork) GetArtworkExtended added in v0.3.0 

func (s *Artwork) GetArtworkExtended(ctx context.Context, id float64) (*operations.GetArtworkExtendedResponse, error)

GetArtworkExtended - Returns a single artwork extended record.

type ArtworkStatuses added in v0.3.0 

type ArtworkStatuses struct {
	// contains filtered or unexported fields
}

func (*ArtworkStatuses) GetAllArtworkStatuses added in v0.3.0 

func (s *ArtworkStatuses) GetAllArtworkStatuses(ctx context.Context) (*operations.GetAllArtworkStatusesResponse, error)

GetAllArtworkStatuses - Returns list of artwork status records.

type ArtworkTypes added in v0.3.0 

type ArtworkTypes struct {
	// contains filtered or unexported fields
}

func (*ArtworkTypes) GetAllArtworkTypes added in v0.3.0 

func (s *ArtworkTypes) GetAllArtworkTypes(ctx context.Context) (*operations.GetAllArtworkTypesResponse, error)

GetAllArtworkTypes - Returns a list of artworkType records

type AwardCategories added in v0.3.0 

type AwardCategories struct {
	// contains filtered or unexported fields
}

func (*AwardCategories) GetAwardCategory added in v0.3.0 

func (s *AwardCategories) GetAwardCategory(ctx context.Context, id float64) (*operations.GetAwardCategoryResponse, error)

GetAwardCategory - Returns a single award category base record

func (*AwardCategories) GetAwardCategoryExtended added in v0.3.0 

func (s *AwardCategories) GetAwardCategoryExtended(ctx context.Context, id float64) (*operations.GetAwardCategoryExtendedResponse, error)

GetAwardCategoryExtended - Returns a single award category extended record

type Awards added in v0.3.0 

type Awards struct {
	// contains filtered or unexported fields
}

func (*Awards) GetAllAwards added in v0.3.0 

func (s *Awards) GetAllAwards(ctx context.Context) (*operations.GetAllAwardsResponse, error)

GetAllAwards - Returns a list of award base records

func (*Awards) GetAward added in v0.3.0 

func (s *Awards) GetAward(ctx context.Context, id float64) (*operations.GetAwardResponse, error)

GetAward - Returns a single award base record

func (*Awards) GetAwardExtended added in v0.3.0 

func (s *Awards) GetAwardExtended(ctx context.Context, id float64) (*operations.GetAwardExtendedResponse, error)

GetAwardExtended - Returns a single award extended record

type Characters added in v0.3.0 

type Characters struct {
	// contains filtered or unexported fields
}

func (*Characters) GetCharacterBase added in v0.3.0 

func (s *Characters) GetCharacterBase(ctx context.Context, id float64) (*operations.GetCharacterBaseResponse, error)

GetCharacterBase - Returns character base record

type Companies added in v0.3.0 

type Companies struct {
	// contains filtered or unexported fields
}

func (*Companies) GetAllCompanies added in v0.3.0 

func (s *Companies) GetAllCompanies(ctx context.Context, page *float64) (*operations.GetAllCompaniesResponse, error)

GetAllCompanies - returns a paginated list of company records

func (*Companies) GetCompany added in v0.3.0 

func (s *Companies) GetCompany(ctx context.Context, id float64) (*operations.GetCompanyResponse, error)

GetCompany - returns a company record

func (*Companies) GetCompanyTypes added in v0.3.0 

func (s *Companies) GetCompanyTypes(ctx context.Context) (*operations.GetCompanyTypesResponse, error)

GetCompanyTypes - returns all company type records

type ContentRatings added in v0.3.0 

type ContentRatings struct {
	// contains filtered or unexported fields
}

func (*ContentRatings) GetAllContentRatings added in v0.3.0 

func (s *ContentRatings) GetAllContentRatings(ctx context.Context) (*operations.GetAllContentRatingsResponse, error)

GetAllContentRatings - returns list content rating records

type Countries added in v0.3.0 

type Countries struct {
	// contains filtered or unexported fields
}

func (*Countries) GetAllCountries added in v0.3.0 

func (s *Countries) GetAllCountries(ctx context.Context) (*operations.GetAllCountriesResponse, error)

GetAllCountries - returns list of country records

type EntityTypes added in v0.3.0 

type EntityTypes struct {
	// contains filtered or unexported fields
}

func (*EntityTypes) GetEntityTypes added in v0.3.0 

func (s *EntityTypes) GetEntityTypes(ctx context.Context) (*operations.GetEntityTypesResponse, error)

GetEntityTypes - returns the active entity types

type Episodes added in v0.3.0 

type Episodes struct {
	// contains filtered or unexported fields
}

func (*Episodes) GetAllEpisodes added in v0.3.0 

func (s *Episodes) GetAllEpisodes(ctx context.Context, page *float64) (*operations.GetAllEpisodesResponse, error)

GetAllEpisodes - Returns a list of episodes base records with the basic attributes.<br> Note that all episodes are returned, even those that may not be included in a series' default season order.

func (*Episodes) GetEpisodeBase added in v0.3.0 

func (s *Episodes) GetEpisodeBase(ctx context.Context, id float64) (*operations.GetEpisodeBaseResponse, error)

GetEpisodeBase - Returns episode base record

func (*Episodes) GetEpisodeExtended added in v0.3.0 

func (s *Episodes) GetEpisodeExtended(ctx context.Context, id float64, meta *operations.Meta) (*operations.GetEpisodeExtendedResponse, error)

GetEpisodeExtended - Returns episode extended record

func (*Episodes) GetEpisodeTranslation added in v0.3.0 

func (s *Episodes) GetEpisodeTranslation(ctx context.Context, id float64, language string) (*operations.GetEpisodeTranslationResponse, error)

GetEpisodeTranslation - Returns episode translation record

type Favorites added in v0.3.0 

type Favorites struct {
	// contains filtered or unexported fields
}

func (*Favorites) CreateUserFavorites added in v0.3.0 

func (s *Favorites) CreateUserFavorites(ctx context.Context, request *shared.FavoriteRecord) (*operations.CreateUserFavoritesResponse, error)

CreateUserFavorites - creates a new user favorite

func (*Favorites) GetUserFavorites added in v0.3.0 

func (s *Favorites) GetUserFavorites(ctx context.Context) (*operations.GetUserFavoritesResponse, error)

GetUserFavorites - returns user favorites

type Genders added in v0.3.0 

type Genders struct {
	// contains filtered or unexported fields
}

func (*Genders) GetAllGenders added in v0.3.0 

func (s *Genders) GetAllGenders(ctx context.Context) (*operations.GetAllGendersResponse, error)

GetAllGenders - returns list of gender records

type Genres added in v0.3.0 

type Genres struct {
	// contains filtered or unexported fields
}

func (*Genres) GetAllGenres added in v0.3.0 

func (s *Genres) GetAllGenres(ctx context.Context) (*operations.GetAllGenresResponse, error)

GetAllGenres - returns list of genre records

func (*Genres) GetGenreBase added in v0.3.0 

func (s *Genres) GetGenreBase(ctx context.Context, id float64) (*operations.GetGenreBaseResponse, error)

GetGenreBase - Returns genre record

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 InspirationTypes added in v0.3.0 

type InspirationTypes struct {
	// contains filtered or unexported fields
}

func (*InspirationTypes) GetAllInspirationTypes added in v0.3.0 

func (s *InspirationTypes) GetAllInspirationTypes(ctx context.Context) (*operations.GetAllInspirationTypesResponse, error)

GetAllInspirationTypes - returns list of inspiration types records

type Languages added in v0.3.0 

type Languages struct {
	// contains filtered or unexported fields
}

func (*Languages) GetAllLanguages added in v0.3.0 

func (s *Languages) GetAllLanguages(ctx context.Context) (*operations.GetAllLanguagesResponse, error)

GetAllLanguages - returns list of language records

type Lists added in v0.3.0 

type Lists struct {
	// contains filtered or unexported fields
}

func (*Lists) GetAllLists added in v0.3.0 

func (s *Lists) GetAllLists(ctx context.Context, page *float64) (*operations.GetAllListsResponse, error)

GetAllLists - returns list of list base records

func (*Lists) GetList added in v0.3.0 

func (s *Lists) GetList(ctx context.Context, id float64) (*operations.GetListResponse, error)

GetList - returns an list base record

func (*Lists) GetListBySlug added in v0.3.0 

func (s *Lists) GetListBySlug(ctx context.Context, slug string) (*operations.GetListBySlugResponse, error)

GetListBySlug - returns an list base record search by slug

func (*Lists) GetListExtended added in v0.3.0 

func (s *Lists) GetListExtended(ctx context.Context, id float64) (*operations.GetListExtendedResponse, error)

GetListExtended - returns a list extended record

func (*Lists) GetListTranslation added in v0.3.0 

func (s *Lists) GetListTranslation(ctx context.Context, id float64, language string) (*operations.GetListTranslationResponse, error)

GetListTranslation - Returns list translation record

type Login added in v0.3.0 

type Login struct {
	// contains filtered or unexported fields
}

func (*Login) PostLogin added in v0.3.0 

func (s *Login) PostLogin(ctx context.Context, request operations.PostLoginRequestBody) (*operations.PostLoginResponse, error)

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

type MovieStatuses added in v0.3.0 

type MovieStatuses struct {
	// contains filtered or unexported fields
}

func (*MovieStatuses) GetAllMovieStatuses added in v0.3.0 

func (s *MovieStatuses) GetAllMovieStatuses(ctx context.Context) (*operations.GetAllMovieStatusesResponse, error)

GetAllMovieStatuses - returns list of status records

type Movies added in v0.3.0 

type Movies struct {
	// contains filtered or unexported fields
}

func (*Movies) GetAllMovie added in v0.3.0 

func (s *Movies) GetAllMovie(ctx context.Context, page *float64) (*operations.GetAllMovieResponse, error)

GetAllMovie - returns list of movie base records

func (*Movies) GetMovieBase added in v0.3.0 

func (s *Movies) GetMovieBase(ctx context.Context, id float64) (*operations.GetMovieBaseResponse, error)

GetMovieBase - Returns movie base record

func (*Movies) GetMovieBaseBySlug added in v0.3.0 

func (s *Movies) GetMovieBaseBySlug(ctx context.Context, slug string) (*operations.GetMovieBaseBySlugResponse, error)

GetMovieBaseBySlug - Returns movie base record search by slug

func (*Movies) GetMovieExtended added in v0.3.0 

func (s *Movies) GetMovieExtended(ctx context.Context, id float64, meta *operations.QueryParamMeta, short *bool) (*operations.GetMovieExtendedResponse, error)

GetMovieExtended - Returns movie extended record

func (*Movies) GetMovieTranslation added in v0.3.0 

func (s *Movies) GetMovieTranslation(ctx context.Context, id float64, language string) (*operations.GetMovieTranslationResponse, error)

GetMovieTranslation - Returns movie translation record

func (*Movies) GetMoviesFilter added in v0.3.0 

func (s *Movies) GetMoviesFilter(ctx context.Context, request operations.GetMoviesFilterRequest) (*operations.GetMoviesFilterResponse, error)

GetMoviesFilter - Search movies based on filter parameters

type People added in v0.3.0 

type People struct {
	// contains filtered or unexported fields
}

func (*People) GetAllPeople added in v0.3.0 

func (s *People) GetAllPeople(ctx context.Context, page *float64) (*operations.GetAllPeopleResponse, error)

GetAllPeople - Returns a list of people base records with the basic attributes.

func (*People) GetPeopleBase added in v0.3.0 

func (s *People) GetPeopleBase(ctx context.Context, id float64) (*operations.GetPeopleBaseResponse, error)

GetPeopleBase - Returns people base record

func (*People) GetPeopleExtended added in v0.3.0 

func (s *People) GetPeopleExtended(ctx context.Context, id float64, meta *operations.GetPeopleExtendedQueryParamMeta) (*operations.GetPeopleExtendedResponse, error)

GetPeopleExtended - Returns people extended record

func (*People) GetPeopleTranslation added in v0.3.0 

func (s *People) GetPeopleTranslation(ctx context.Context, id float64, language string) (*operations.GetPeopleTranslationResponse, error)

GetPeopleTranslation - Returns people translation record

type PeopleTypes added in v0.3.0 

type PeopleTypes struct {
	// contains filtered or unexported fields
}

func (*PeopleTypes) GetAllPeopleTypes added in v0.3.0 

func (s *PeopleTypes) GetAllPeopleTypes(ctx context.Context) (*operations.GetAllPeopleTypesResponse, error)

GetAllPeopleTypes - returns list of peopleType records

type SDK 

type SDK struct {
	ArtworkStatuses  *ArtworkStatuses
	ArtworkTypes     *ArtworkTypes
	Artwork          *Artwork
	Awards           *Awards
	AwardCategories  *AwardCategories
	Characters       *Characters
	Companies        *Companies
	ContentRatings   *ContentRatings
	Countries        *Countries
	EntityTypes      *EntityTypes
	Episodes         *Episodes
	Genders          *Genders
	Genres           *Genres
	InspirationTypes *InspirationTypes
	Languages        *Languages
	Lists            *Lists
	Login            *Login
	Movies           *Movies
	MovieStatuses    *MovieStatuses
	People           *People
	PeopleTypes      *PeopleTypes
	Search           *Search
	Seasons          *Seasons
	Series           *Series
	SeriesStatuses   *SeriesStatuses
	SourceTypes      *SourceTypes
	Updates          *Updates
	UserInfo         *UserInfo
	Favorites        *Favorites
	// 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 retry.Config) SDKOption

func WithSecurity 

func WithSecurity(security shared.Security) SDKOption

WithSecurity configures the SDK to use the provided security details

func WithSecuritySource added in v0.3.0 

func WithSecuritySource(security func(context.Context) (shared.Security, error)) SDKOption

WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication

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 

type Search struct {
	// contains filtered or unexported fields
}

func (*Search) GetSearchResults added in v0.3.0 

func (s *Search) GetSearchResults(ctx context.Context, request operations.GetSearchResultsRequest) (*operations.GetSearchResultsResponse, error)

GetSearchResults - Our search index includes series, movies, people, and companies. Search is limited to 5k results max.

func (*Search) GetSearchResultsByRemoteID added in v0.3.0 

func (s *Search) GetSearchResultsByRemoteID(ctx context.Context, remoteID string) (*operations.GetSearchResultsByRemoteIDResponse, error)

GetSearchResultsByRemoteID - Search a series, movie, people, episode, company or season by specific remote id and returns a base record for that entity.

type Seasons added in v0.3.0 

type Seasons struct {
	// contains filtered or unexported fields
}

func (*Seasons) GetAllSeasons added in v0.3.0 

func (s *Seasons) GetAllSeasons(ctx context.Context, page *float64) (*operations.GetAllSeasonsResponse, error)

GetAllSeasons - returns list of seasons base records

func (*Seasons) GetSeasonBase added in v0.3.0 

func (s *Seasons) GetSeasonBase(ctx context.Context, id float64) (*operations.GetSeasonBaseResponse, error)

GetSeasonBase - Returns season base record

func (*Seasons) GetSeasonExtended added in v0.3.0 

func (s *Seasons) GetSeasonExtended(ctx context.Context, id float64) (*operations.GetSeasonExtendedResponse, error)

GetSeasonExtended - Returns season extended record

func (*Seasons) GetSeasonTranslation added in v0.3.0 

func (s *Seasons) GetSeasonTranslation(ctx context.Context, id float64, language string) (*operations.GetSeasonTranslationResponse, error)

GetSeasonTranslation - Returns season translation record

func (*Seasons) GetSeasonTypes added in v0.3.0 

func (s *Seasons) GetSeasonTypes(ctx context.Context) (*operations.GetSeasonTypesResponse, error)

GetSeasonTypes - Returns season type records

type Series added in v0.3.0 

type Series struct {
	// contains filtered or unexported fields
}

func (*Series) GetAllSeries added in v0.3.0 

func (s *Series) GetAllSeries(ctx context.Context, page *float64) (*operations.GetAllSeriesResponse, error)

GetAllSeries - returns list of series base records

func (*Series) GetSeriesArtworks added in v0.3.0 

func (s *Series) GetSeriesArtworks(ctx context.Context, id float64, lang *string, type_ *int64) (*operations.GetSeriesArtworksResponse, error)

GetSeriesArtworks - Returns series artworks base on language and type. <br> Note&#58; Artwork type is an id that can be found using **/artwork/types** endpoint.

func (*Series) GetSeriesBase added in v0.3.0 

func (s *Series) GetSeriesBase(ctx context.Context, id float64) (*operations.GetSeriesBaseResponse, error)

GetSeriesBase - Returns series base record

func (*Series) GetSeriesBaseBySlug added in v0.3.0 

func (s *Series) GetSeriesBaseBySlug(ctx context.Context, slug string) (*operations.GetSeriesBaseBySlugResponse, error)

GetSeriesBaseBySlug - Returns series base record searched by slug

func (*Series) GetSeriesEpisodes added in v0.3.0 

func (s *Series) GetSeriesEpisodes(ctx context.Context, request operations.GetSeriesEpisodesRequest) (*operations.GetSeriesEpisodesResponse, error)

GetSeriesEpisodes - Returns series episodes from the specified season type, default returns the episodes in the series default season type

func (*Series) GetSeriesExtended added in v0.3.0 

func (s *Series) GetSeriesExtended(ctx context.Context, id float64, meta *operations.GetSeriesExtendedQueryParamMeta, short *bool) (*operations.GetSeriesExtendedResponse, error)

GetSeriesExtended - Returns series extended record

func (*Series) GetSeriesFilter added in v0.3.0 

func (s *Series) GetSeriesFilter(ctx context.Context, request operations.GetSeriesFilterRequest) (*operations.GetSeriesFilterResponse, error)

GetSeriesFilter - Search series based on filter parameters

func (*Series) GetSeriesNextAired added in v0.3.0 

func (s *Series) GetSeriesNextAired(ctx context.Context, id float64) (*operations.GetSeriesNextAiredResponse, error)

GetSeriesNextAired - Returns series base record including the nextAired field. <br> Note&#58; nextAired was included in the base record endpoint but that field will deprecated in the future so developers should use the nextAired endpoint.

func (*Series) GetSeriesSeasonEpisodesTranslated added in v0.3.0 

func (s *Series) GetSeriesSeasonEpisodesTranslated(ctx context.Context, id float64, lang string, page int64, seasonType string) (*operations.GetSeriesSeasonEpisodesTranslatedResponse, error)

GetSeriesSeasonEpisodesTranslated - Returns series base record with episodes from the specified season type and language. Default returns the episodes in the series default season type.

func (*Series) GetSeriesTranslation added in v0.3.0 

func (s *Series) GetSeriesTranslation(ctx context.Context, id float64, language string) (*operations.GetSeriesTranslationResponse, error)

GetSeriesTranslation - Returns series translation record

type SeriesStatuses added in v0.3.0 

type SeriesStatuses struct {
	// contains filtered or unexported fields
}

func (*SeriesStatuses) GetAllSeriesStatuses added in v0.3.0 

func (s *SeriesStatuses) GetAllSeriesStatuses(ctx context.Context) (*operations.GetAllSeriesStatusesResponse, error)

GetAllSeriesStatuses - returns list of status records

type SourceTypes added in v0.3.0 

type SourceTypes struct {
	// contains filtered or unexported fields
}

func (*SourceTypes) GetAllSourceTypes added in v0.3.0 

func (s *SourceTypes) GetAllSourceTypes(ctx context.Context) (*operations.GetAllSourceTypesResponse, error)

GetAllSourceTypes - returns list of sourceType records

type Updates added in v0.3.0 

type Updates struct {
	// contains filtered or unexported fields
}

func (*Updates) Updates added in v0.3.0 

func (s *Updates) Updates(ctx context.Context, since int64, action *operations.Action, page *float64, type_ *operations.Type) (*operations.UpdatesResponse, error)

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.

type UserInfo added in v0.3.0 

type UserInfo struct {
	// contains filtered or unexported fields
}

func (*UserInfo) GetUserInfo added in v0.3.0 

func (s *UserInfo) GetUserInfo(ctx context.Context) (*operations.GetUserInfoResponse, error)

GetUserInfo - returns user info

func (*UserInfo) GetUserInfoByID added in v0.3.0 

func (s *UserInfo) GetUserInfoByID(ctx context.Context, id float64) (*operations.GetUserInfoByIDResponse, error)

GetUserInfoByID - returns user info by user id

Source Files

View all Source files

Directories

Path Synopsis
internal
hooks
utils
models
operations
sdkerrors
shared

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.