Skip to content

TvAPI.md

Latest commit

 

History

History
378 lines (243 loc) · 9.7 KB

TvAPI.md

File metadata and controls

378 lines (243 loc) · 9.7 KB

\TvAPI

All URIs are relative to http://localhost:5055/api/v1

Method HTTP request Description
GetTvByTvId Get /tv/{tvId} Get TV details
GetTvRatings Get /tv/{tvId}/ratings Get TV ratings
GetTvRecommendations Get /tv/{tvId}/recommendations Get recommended TV series
GetTvSeasonBySeasonNumber Get /tv/{tvId}/season/{seasonNumber} Get season details and episode list
GetTvSimilar Get /tv/{tvId}/similar Get similar TV series

GetTvByTvId

TvDetails GetTvByTvId(ctx, tvId).Language(language).Execute()

Get TV details

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {
	tvId := float32(76479) // float32 | 
	language := "en" // string |  (optional)

	configuration := seerrClient.NewConfiguration()
	apiClient := seerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.TvAPI.GetTvByTvId(context.Background(), tvId).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TvAPI.GetTvByTvId``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetTvByTvId`: TvDetails
	fmt.Fprintf(os.Stdout, "Response from `TvAPI.GetTvByTvId`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
tvId float32

Other Parameters

Other parameters are passed through a pointer to a apiGetTvByTvIdRequest struct via the builder pattern

Name Type Description Notes

language | string | |

Return type

TvDetails

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTvRatings

GetTvRatings2XXResponse GetTvRatings(ctx, tvId).Execute()

Get TV ratings

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {
	tvId := float32(76479) // float32 | 

	configuration := seerrClient.NewConfiguration()
	apiClient := seerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.TvAPI.GetTvRatings(context.Background(), tvId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TvAPI.GetTvRatings``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetTvRatings`: GetTvRatings2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `TvAPI.GetTvRatings`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
tvId float32

Other Parameters

Other parameters are passed through a pointer to a apiGetTvRatingsRequest struct via the builder pattern

Name Type Description Notes

Return type

GetTvRatings2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTvRecommendations

GetDiscoverTv2XXResponse GetTvRecommendations(ctx, tvId).Page(page).Language(language).Execute()

Get recommended TV series

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {
	tvId := float32(76479) // float32 | 
	page := float32(1) // float32 |  (optional) (default to 1)
	language := "en" // string |  (optional)

	configuration := seerrClient.NewConfiguration()
	apiClient := seerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.TvAPI.GetTvRecommendations(context.Background(), tvId).Page(page).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TvAPI.GetTvRecommendations``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetTvRecommendations`: GetDiscoverTv2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `TvAPI.GetTvRecommendations`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
tvId float32

Other Parameters

Other parameters are passed through a pointer to a apiGetTvRecommendationsRequest struct via the builder pattern

Name Type Description Notes

page | float32 | | [default to 1] language | string | |

Return type

GetDiscoverTv2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTvSeasonBySeasonNumber

Season GetTvSeasonBySeasonNumber(ctx, tvId, seasonNumber).Language(language).Execute()

Get season details and episode list

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {
	tvId := float32(76479) // float32 | 
	seasonNumber := float32(123456) // float32 | 
	language := "en" // string |  (optional)

	configuration := seerrClient.NewConfiguration()
	apiClient := seerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.TvAPI.GetTvSeasonBySeasonNumber(context.Background(), tvId, seasonNumber).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TvAPI.GetTvSeasonBySeasonNumber``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetTvSeasonBySeasonNumber`: Season
	fmt.Fprintf(os.Stdout, "Response from `TvAPI.GetTvSeasonBySeasonNumber`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
tvId float32
seasonNumber float32

Other Parameters

Other parameters are passed through a pointer to a apiGetTvSeasonBySeasonNumberRequest struct via the builder pattern

Name Type Description Notes

language | string | |

Return type

Season

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTvSimilar

GetDiscoverTv2XXResponse GetTvSimilar(ctx, tvId).Page(page).Language(language).Execute()

Get similar TV series

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {
	tvId := float32(76479) // float32 | 
	page := float32(1) // float32 |  (optional) (default to 1)
	language := "en" // string |  (optional)

	configuration := seerrClient.NewConfiguration()
	apiClient := seerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.TvAPI.GetTvSimilar(context.Background(), tvId).Page(page).Language(language).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TvAPI.GetTvSimilar``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetTvSimilar`: GetDiscoverTv2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `TvAPI.GetTvSimilar`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
tvId float32

Other Parameters

Other parameters are passed through a pointer to a apiGetTvSimilarRequest struct via the builder pattern

Name Type Description Notes

page | float32 | | [default to 1] language | string | |

Return type

GetDiscoverTv2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]