Skip to content

MoviesAPI.md

Latest commit

 

History

History
373 lines (239 loc) · 9.93 KB

MoviesAPI.md

File metadata and controls

373 lines (239 loc) · 9.93 KB
Raw

\MoviesAPI

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

Method HTTP request Description
GetMovieByMovieId Get /movie/{movieId} Get movie details
GetMovieRatings Get /movie/{movieId}/ratings Get movie ratings
GetMovieRatingscombined Get /movie/{movieId}/ratingscombined Get RT and IMDB movie ratings combined
GetMovieRecommendations Get /movie/{movieId}/recommendations Get recommended movies
GetMovieSimilar Get /movie/{movieId}/similar Get similar movies

GetMovieByMovieId

MovieDetails GetMovieByMovieId(ctx, movieId).Language(language).Execute()

Get movie details

Example

package main

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

func main() {
	movieId := float32(337401) // float32 | 
	language := "en" // string |  (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

language | string | |

Return type

MovieDetails

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]

GetMovieRatings

GetMovieRatings2XXResponse GetMovieRatings(ctx, movieId).Execute()

Get movie ratings

Example

package main

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

func main() {
	movieId := float32(337401) // float32 | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

GetMovieRatings2XXResponse

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]

GetMovieRatingscombined

GetMovieRatingscombined2XXResponse GetMovieRatingscombined(ctx, movieId).Execute()

Get RT and IMDB movie ratings combined

Example

package main

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

func main() {
	movieId := float32(337401) // float32 | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

GetMovieRatingscombined2XXResponse

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]

GetMovieRecommendations

GetDiscoverMovies2XXResponse GetMovieRecommendations(ctx, movieId).Page(page).Language(language).Execute()

Get recommended movies

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

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

Return type

GetDiscoverMovies2XXResponse

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]

GetMovieSimilar

GetDiscoverMovies2XXResponse GetMovieSimilar(ctx, movieId).Page(page).Language(language).Execute()

Get similar movies

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

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

Return type

GetDiscoverMovies2XXResponse

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]