make the inputs to bulk optional

golift · Jul 7, 2024 · 38b86ef · 38b86ef
1 parent 10d52d4
commit 38b86ef
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 34 deletions.
diff --git a/pointers.go b/pointers.go
@@ -1,23 +1,28 @@
 package starr
 
-// String returns a pointer to a string.
-func String(s string) *string {
-	return &s
+// Ptr returns a pointer to the provided "whatever".
+func Ptr[P any](p P) *P {
+	return &p
 }
 
 // True returns a pointer to a true boolean.
 func True() *bool {
-	s := true
-	return &s
+	return Ptr(true)
 }
 
 // False returns a pointer to a false boolean.
 func False() *bool {
-	s := false
+	return Ptr(false)
+}
+
+// String returns a pointer to a string.
+// Deprecated: Use Ptr() function instead.
+func String(s string) *string {
 	return &s
 }
 
 // Int64 returns a pointer to the provided integer.
+// Deprecated: Use Ptr() function instead.
 func Int64(s int64) *int64 {
 	return &s
 }
diff --git a/prowlarr/indexer.go b/prowlarr/indexer.go
@@ -205,18 +205,18 @@ func (p *Prowlarr) DeleteIndexerContext(ctx context.Context, indexerID int64) er
 	return nil
 }
 
-// BulkIndexer is the input to UpdateIndexers.
+// BulkIndexer is the input to UpdateIndexers. Use the starr.Ptr(any) func to create the pointers.
 type BulkIndexer struct {
 	IDs            []int64         `json:"ids"`
-	Tags           []int           `json:"tags"`
-	ApplyTags      starr.ApplyTags `json:"applyTags"`
-	Enable         bool            `json:"enable"`
-	AppProfileID   int64           `json:"appProfileId"`
-	Priority       int64           `json:"priority"`
-	MinimumSeeders int             `json:"minimumSeeders"`
-	SeedRatio      int             `json:"seedRatio"`
-	SeedTime       int             `json:"seedTime"`
-	PackSeedTime   int             `json:"packSeedTime"`
+	Tags           []int           `json:"tags,omitempty"`
+	ApplyTags      starr.ApplyTags `json:"applyTags,omitempty"`
+	Enable         *bool           `json:"enable,omitempty"`
+	AppProfileID   *int64          `json:"appProfileId,omitempty"`
+	Priority       *int64          `json:"priority,omitempty"`
+	MinimumSeeders *int            `json:"minimumSeeders,omitempty"`
+	SeedRatio      *int            `json:"seedRatio,omitempty"`
+	SeedTime       *int            `json:"seedTime,omitempty"`
+	PackSeedTime   *int            `json:"packSeedTime,omitempty"`
 }
 
 // UpdateIndexers bulk updates indexers.

diff --git a/radarr/indexer.go b/radarr/indexer.go
@@ -172,14 +172,14 @@ func (r *Radarr) DeleteIndexerContext(ctx context.Context, indexerID int64) erro
 }
 
 // UpdateIndexers bulk updates indexers.
-func (r *Radarr) UpdateIndexers(indexer *starr.BulkIndexer) (*IndexerOutput, error) {
+func (r *Radarr) UpdateIndexers(indexer *starr.BulkIndexer) ([]*IndexerOutput, error) {
 	return r.UpdateIndexersContext(context.Background(), indexer)
 }
 
 // UpdateIndexersContext bulk updates indexers.
-func (r *Radarr) UpdateIndexersContext(ctx context.Context, indexer *starr.BulkIndexer) (*IndexerOutput, error) {
+func (r *Radarr) UpdateIndexersContext(ctx context.Context, indexer *starr.BulkIndexer) ([]*IndexerOutput, error) {
 	var (
-		output IndexerOutput
+		output []*IndexerOutput
 		body   bytes.Buffer
 	)
 
@@ -192,5 +192,5 @@ func (r *Radarr) UpdateIndexersContext(ctx context.Context, indexer *starr.BulkI
 		return nil, fmt.Errorf("api.Put(%s): %w", &req, err)
 	}
 
-	return &output, nil
+	return output, nil
 }
diff --git a/readarr/indexer.go b/readarr/indexer.go
@@ -170,14 +170,14 @@ func (r *Readarr) DeleteIndexerContext(ctx context.Context, indexerID int64) err
 }
 
 // UpdateIndexers bulk updates indexers.
-func (r *Readarr) UpdateIndexers(indexer *starr.BulkIndexer) (*IndexerOutput, error) {
+func (r *Readarr) UpdateIndexers(indexer *starr.BulkIndexer) ([]*IndexerOutput, error) {
 	return r.UpdateIndexersContext(context.Background(), indexer)
 }
 
 // UpdateIndexersContext bulk updates indexers.
-func (r *Readarr) UpdateIndexersContext(ctx context.Context, indexer *starr.BulkIndexer) (*IndexerOutput, error) {
+func (r *Readarr) UpdateIndexersContext(ctx context.Context, indexer *starr.BulkIndexer) ([]*IndexerOutput, error) {
 	var (
-		output IndexerOutput
+		output []*IndexerOutput
 		body   bytes.Buffer
 	)
 
@@ -190,5 +190,5 @@ func (r *Readarr) UpdateIndexersContext(ctx context.Context, indexer *starr.Bulk
 		return nil, fmt.Errorf("api.Put(%s): %w", &req, err)
 	}
 
-	return &output, nil
+	return output, nil
 }
diff --git a/shared.go b/shared.go
@@ -346,12 +346,13 @@ const (
 )
 
 // BulkIndexer is the input to UpdateIndexers on all apps except Prowlarr.
+// Use the starr.True/False/Int64() funcs to create the pointers.
 type BulkIndexer struct {
 	IDs                     []int64   `json:"ids"`
-	Tags                    []int     `json:"tags"`
-	ApplyTags               ApplyTags `json:"applyTags"`
-	EnableRss               bool      `json:"enableRss"`
-	EnableAutomaticSearch   bool      `json:"enableAutomaticSearch"`
-	EnableInteractiveSearch bool      `json:"enableInteractiveSearch"`
-	Priority                int64     `json:"priority"`
+	Tags                    []int     `json:"tags,omitempty"`
+	ApplyTags               ApplyTags `json:"applyTags,omitempty"`
+	EnableRss               *bool     `json:"enableRss,omitempty"`
+	EnableAutomaticSearch   *bool     `json:"enableAutomaticSearch,omitempty"`
+	EnableInteractiveSearch *bool     `json:"enableInteractiveSearch,omitempty"`
+	Priority                *int64    `json:"priority,omitempty"`
 }
diff --git a/sonarr/indexer.go b/sonarr/indexer.go
@@ -176,14 +176,14 @@ func (s *Sonarr) DeleteIndexerContext(ctx context.Context, indexerID int64) erro
 }
 
 // UpdateIndexers bulk updates indexers.
-func (s *Sonarr) UpdateIndexers(indexer *starr.BulkIndexer) (*IndexerOutput, error) {
+func (s *Sonarr) UpdateIndexers(indexer *starr.BulkIndexer) ([]*IndexerOutput, error) {
 	return s.UpdateIndexersContext(context.Background(), indexer)
 }
 
 // UpdateIndexersContext bulk updates indexers.
-func (s *Sonarr) UpdateIndexersContext(ctx context.Context, indexer *starr.BulkIndexer) (*IndexerOutput, error) {
+func (s *Sonarr) UpdateIndexersContext(ctx context.Context, indexer *starr.BulkIndexer) ([]*IndexerOutput, error) {
 	var (
-		output IndexerOutput
+		output []*IndexerOutput
 		body   bytes.Buffer
 	)
 
@@ -196,5 +196,5 @@ func (s *Sonarr) UpdateIndexersContext(ctx context.Context, indexer *starr.BulkI
 		return nil, fmt.Errorf("api.Put(%s): %w", &req, err)
 	}
 
-	return &output, nil
+	return output, nil
 }