Skip to content

OtherAPI.md

Latest commit

 

History

History
275 lines (172 loc) · 6.88 KB

OtherAPI.md

File metadata and controls

275 lines (172 loc) · 6.88 KB

\OtherAPI

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

Method HTTP request Description
GetKeywordByKeywordId Get /keyword/{keywordId} Get keyword
ListWatchprovidersMovies Get /watchproviders/movies Get watch provider movies
ListWatchprovidersRegions Get /watchproviders/regions Get watch provider regions
ListWatchprovidersTv Get /watchproviders/tv Get watch provider series

GetKeywordByKeywordId

Keyword GetKeywordByKeywordId(ctx, keywordId).Execute()

Get keyword

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	keywordId := float32(1) // float32 | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

Keyword

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]

ListWatchprovidersMovies

[]WatchProviderDetails ListWatchprovidersMovies(ctx).WatchRegion(watchRegion).Execute()

Get watch provider movies

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	watchRegion := "US" // string | 

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.OtherAPI.ListWatchprovidersMovies(context.Background()).WatchRegion(watchRegion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OtherAPI.ListWatchprovidersMovies``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListWatchprovidersMovies`: []WatchProviderDetails
	fmt.Fprintf(os.Stdout, "Response from `OtherAPI.ListWatchprovidersMovies`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
watchRegion string

Return type

[]WatchProviderDetails

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]

ListWatchprovidersRegions

[]WatchProviderRegion ListWatchprovidersRegions(ctx).Execute()

Get watch provider regions

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.OtherAPI.ListWatchprovidersRegions(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OtherAPI.ListWatchprovidersRegions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListWatchprovidersRegions`: []WatchProviderRegion
	fmt.Fprintf(os.Stdout, "Response from `OtherAPI.ListWatchprovidersRegions`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]WatchProviderRegion

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]

ListWatchprovidersTv

[]WatchProviderDetails ListWatchprovidersTv(ctx).WatchRegion(watchRegion).Execute()

Get watch provider series

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	watchRegion := "US" // string | 

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.OtherAPI.ListWatchprovidersTv(context.Background()).WatchRegion(watchRegion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OtherAPI.ListWatchprovidersTv``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListWatchprovidersTv`: []WatchProviderDetails
	fmt.Fprintf(os.Stdout, "Response from `OtherAPI.ListWatchprovidersTv`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
watchRegion string

Return type

[]WatchProviderDetails

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]