Skip to content

Latest commit

 

History

History
156 lines (103 loc) · 4.64 KB

CutoffAPI.md

File metadata and controls

156 lines (103 loc) · 4.64 KB

\CutoffAPI

All URIs are relative to http://localhost:8989

Method HTTP request Description
GetWantedCutoff Get /api/v3/wanted/cutoff
GetWantedCutoffById Get /api/v3/wanted/cutoff/{id}

GetWantedCutoff

EpisodeResourcePagingResource GetWantedCutoff(ctx).Page(page).PageSize(pageSize).SortKey(sortKey).SortDirection(sortDirection).IncludeSeries(includeSeries).IncludeEpisodeFile(includeEpisodeFile).IncludeImages(includeImages).Monitored(monitored).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

func main() {
	page := int32(56) // int32 |  (optional) (default to 1)
	pageSize := int32(56) // int32 |  (optional) (default to 10)
	sortKey := "sortKey_example" // string |  (optional)
	sortDirection := sonarrClient.SortDirection("default") // SortDirection |  (optional)
	includeSeries := true // bool |  (optional) (default to false)
	includeEpisodeFile := true // bool |  (optional) (default to false)
	includeImages := true // bool |  (optional) (default to false)
	monitored := true // bool |  (optional) (default to true)

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.CutoffAPI.GetWantedCutoff(context.Background()).Page(page).PageSize(pageSize).SortKey(sortKey).SortDirection(sortDirection).IncludeSeries(includeSeries).IncludeEpisodeFile(includeEpisodeFile).IncludeImages(includeImages).Monitored(monitored).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CutoffAPI.GetWantedCutoff``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetWantedCutoff`: EpisodeResourcePagingResource
	fmt.Fprintf(os.Stdout, "Response from `CutoffAPI.GetWantedCutoff`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
page int32 [default to 1]
pageSize int32 [default to 10]
sortKey string
sortDirection SortDirection
includeSeries bool [default to false]
includeEpisodeFile bool [default to false]
includeImages bool [default to false]
monitored bool [default to true]

Return type

EpisodeResourcePagingResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

GetWantedCutoffById

EpisodeResource GetWantedCutoffById(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

func main() {
	id := int32(56) // int32 | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

EpisodeResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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