Skip to content

Sonarr season images fix #184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Fyb3roptik wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Sonarr season images fix #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cd78f8e
Adding support for includeSeasonImages in Sonarr
Fyb3roptik Dec 2, 2025
a304f3f
Adding param for GetAllSeries
Fyb3roptik Dec 2, 2025
53deecc
linter fixes
Fyb3roptik Dec 2, 2025
debbd7b
Adding images to the return
Fyb3roptik Dec 3, 2025
6cd27c8
Merge branch 'main' into sonarr-season-images-fix
davidnewhall Dec 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 22 additions & 13 deletions sonarr/series.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,10 @@ type AlternateTitle struct {

// Season is part of AddSeriesInput and Queue and used in a few places.
type Season struct {
Monitored bool `json:"monitored"`
SeasonNumber int `json:"seasonNumber"`
Statistics *Statistics `json:"statistics,omitempty"`
Monitored bool `json:"monitored"`
SeasonNumber int `json:"seasonNumber"`
Statistics *Statistics `json:"statistics,omitempty"`
Images []*starr.Image `json:"images,omitempty"`
}

// Statistics is part of AddSeriesInput and Queue.
Expand All @@ -137,30 +138,34 @@ type Statistics struct {

// GetAllSeries returns all configured series.
// This may not deal well with pagination atm, let us know?
func (s *Sonarr) GetAllSeries() ([]*Series, error) {
return s.GetAllSeriesContext(context.Background())
func (s *Sonarr) GetAllSeries(includeSeasonImages bool) ([]*Series, error) {
return s.GetAllSeriesContext(context.Background(), includeSeasonImages)
}

// GetAllSeriesContext returns all configured series.
// This may not deal well with pagination atm, let us know?
func (s *Sonarr) GetAllSeriesContext(ctx context.Context) ([]*Series, error) {
return s.GetSeriesContext(ctx, 0)
func (s *Sonarr) GetAllSeriesContext(ctx context.Context, includeSeasonImages bool) ([]*Series, error) {
return s.GetSeriesContext(ctx, 0, includeSeasonImages)
}

// GetSeries locates and returns a series by tvdbID. If tvdbID is 0, returns all series.
func (s *Sonarr) GetSeries(tvdbID int64) ([]*Series, error) {
return s.GetSeriesContext(context.Background(), tvdbID)
func (s *Sonarr) GetSeries(tvdbID int64, includeSeasonImages bool) ([]*Series, error) {
return s.GetSeriesContext(context.Background(), tvdbID, includeSeasonImages)
}

// GetSeriesContext locates and returns a series by tvdbID. If tvdbID is 0, returns all series.
func (s *Sonarr) GetSeriesContext(ctx context.Context, tvdbID int64) ([]*Series, error) {
func (s *Sonarr) GetSeriesContext(ctx context.Context, tvdbID int64, includeSeasonImages bool) ([]*Series, error) {
var output []*Series

req := starr.Request{URI: bpSeries, Query: make(url.Values)}
if tvdbID != 0 {
req.Query.Add("tvdbId", starr.Str(tvdbID))
}

if includeSeasonImages {
Copy link
Contributor

@davidnewhall davidnewhall Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the value of making this optional? Can it always be true?

req.Query.Add("includeSeasonImages", "true")
}

if err := s.GetInto(ctx, req, &output); err != nil {
return nil, fmt.Errorf("api.Get(%s): %w", &req, err)
}
Expand Down Expand Up @@ -220,14 +225,18 @@ func (s *Sonarr) AddSeriesContext(ctx context.Context, series *AddSeriesInput) (

// GetSeriesByID locates and returns a series by DB [series] ID.
func (s *Sonarr) GetSeriesByID(seriesID int64) (*Series, error) {
return s.GetSeriesByIDContext(context.Background(), seriesID)
return s.GetSeriesByIDContext(context.Background(), seriesID, false)
}

// GetSeriesByIDContext locates and returns a series by DB [series] ID.
func (s *Sonarr) GetSeriesByIDContext(ctx context.Context, seriesID int64) (*Series, error) {
func (s *Sonarr) GetSeriesByIDContext(ctx context.Context, seriesID int64, includeSeasonImages bool) (*Series, error) {
var output Series

req := starr.Request{URI: path.Join(bpSeries, starr.Str(seriesID))}
req := starr.Request{URI: path.Join(bpSeries, starr.Str(seriesID)), Query: make(url.Values)}
if includeSeasonImages {
req.Query.Add("includeSeasonImages", "true")
}

if err := s.GetInto(ctx, req, &output); err != nil {
return nil, fmt.Errorf("api.Get(%s): %w", &req, err)
}
Expand Down
4 changes: 2 additions & 2 deletions sonarr/series_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -535,7 +535,7 @@ func TestGetAllSeries(t *testing.T) {
t.Parallel()
mockServer := test.GetMockServer(t)
client := sonarr.New(starr.New("mockAPIkey", mockServer.URL, 0))
output, err := client.GetAllSeries()
output, err := client.GetAllSeries(false)
require.ErrorIs(t, err, test.WithError, "error is not the same as expected")
assert.EqualValues(t, output, test.WithResponse, "response is not the same as expected")
})
Expand Down Expand Up @@ -671,7 +671,7 @@ func TestGetSeries(t *testing.T) {
t.Parallel()
mockServer := test.GetMockServer(t)
client := sonarr.New(starr.New("mockAPIkey", mockServer.URL, 0))
output, err := client.GetSeries(int64(test.WithRequest.(int)))
output, err := client.GetSeries(int64(test.WithRequest.(int)), false)
require.ErrorIs(t, err, test.WithError, "error is not the same as expected")
assert.EqualValues(t, output, test.WithResponse, "response is not the same as expected")
})
Expand Down
Loading