Skip to content

Latest commit

 

History

History
355 lines (228 loc) · 9.23 KB

SeriesAPI.md

File metadata and controls

355 lines (228 loc) · 9.23 KB

\SeriesAPI

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

Method HTTP request Description
CreateSeries Post /api/v3/series
DeleteSeries Delete /api/v3/series/{id}
GetSeriesById Get /api/v3/series/{id}
ListSeries Get /api/v3/series
UpdateSeries Put /api/v3/series/{id}

CreateSeries

SeriesResource CreateSeries(ctx).SeriesResource(seriesResource).Execute()

Example

package main

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

func main() {
	seriesResource := *sonarrClient.NewSeriesResource() // SeriesResource |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
seriesResource SeriesResource

Return type

SeriesResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

DeleteSeries

DeleteSeries(ctx, id).DeleteFiles(deleteFiles).AddImportListExclusion(addImportListExclusion).Execute()

Example

package main

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

func main() {
	id := int32(56) // int32 | 
	deleteFiles := true // bool |  (optional) (default to false)
	addImportListExclusion := true // bool |  (optional) (default to false)

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	r, err := apiClient.SeriesAPI.DeleteSeries(context.Background(), id).DeleteFiles(deleteFiles).AddImportListExclusion(addImportListExclusion).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SeriesAPI.DeleteSeries``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

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 apiDeleteSeriesRequest struct via the builder pattern

Name Type Description Notes

deleteFiles | bool | | [default to false] addImportListExclusion | bool | | [default to false]

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

GetSeriesById

SeriesResource GetSeriesById(ctx, id).IncludeSeasonImages(includeSeasonImages).Execute()

Example

package main

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

func main() {
	id := int32(56) // int32 | 
	includeSeasonImages := true // bool |  (optional) (default to false)

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SeriesAPI.GetSeriesById(context.Background(), id).IncludeSeasonImages(includeSeasonImages).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SeriesAPI.GetSeriesById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSeriesById`: SeriesResource
	fmt.Fprintf(os.Stdout, "Response from `SeriesAPI.GetSeriesById`: %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 apiGetSeriesByIdRequest struct via the builder pattern

Name Type Description Notes

includeSeasonImages | bool | | [default to false]

Return type

SeriesResource

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]

ListSeries

[]SeriesResource ListSeries(ctx).TvdbId(tvdbId).IncludeSeasonImages(includeSeasonImages).Execute()

Example

package main

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

func main() {
	tvdbId := int32(56) // int32 |  (optional)
	includeSeasonImages := true // bool |  (optional) (default to false)

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.SeriesAPI.ListSeries(context.Background()).TvdbId(tvdbId).IncludeSeasonImages(includeSeasonImages).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SeriesAPI.ListSeries``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListSeries`: []SeriesResource
	fmt.Fprintf(os.Stdout, "Response from `SeriesAPI.ListSeries`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
tvdbId int32
includeSeasonImages bool [default to false]

Return type

[]SeriesResource

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]

UpdateSeries

SeriesResource UpdateSeries(ctx, id).MoveFiles(moveFiles).SeriesResource(seriesResource).Execute()

Example

package main

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

func main() {
	id := "id_example" // string | 
	moveFiles := true // bool |  (optional) (default to false)
	seriesResource := *sonarrClient.NewSeriesResource() // SeriesResource |  (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

moveFiles | bool | | [default to false] seriesResource | SeriesResource | |

Return type

SeriesResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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