redirect.go

package goshopify

import (
	"fmt"
)

const redirectsBasePath = "redirects"

// RedirectService is an interface for interacting with the redirects
// endpoints of the Shopify API.
// See https://help.shopify.com/api/reference/online_store/redirect
type RedirectService interface {
	List(interface{}) ([]Redirect, error)
	Count(interface{}) (int, error)
	Get(int64, interface{}) (*Redirect, error)
	Create(Redirect) (*Redirect, error)
	Update(Redirect) (*Redirect, error)
	Delete(int64) error
}

// RedirectServiceOp handles communication with the redirect related methods of the
// Shopify API.
type RedirectServiceOp struct {
	client *Client
}

// Redirect represents a Shopify redirect.
type Redirect struct {
	ID     int64  `json:"id"`
	Path   string `json:"path"`
	Target string `json:"target"`
}

// RedirectResource represents the result from the redirects/X.json endpoint
type RedirectResource struct {
	Redirect *Redirect `json:"redirect"`
}

// RedirectsResource represents the result from the redirects.json endpoint
type RedirectsResource struct {
	Redirects []Redirect `json:"redirects"`
}

// List redirects
func (s *RedirectServiceOp) List(options interface{}) ([]Redirect, error) {
	path := fmt.Sprintf("%s/%s.json", globalApiPathPrefix, redirectsBasePath)
	resource := new(RedirectsResource)
	err := s.client.Get(path, resource, options)
	return resource.Redirects, err
}

// Count redirects
func (s *RedirectServiceOp) Count(options interface{}) (int, error) {
	path := fmt.Sprintf("%s/%s/count.json", globalApiPathPrefix, redirectsBasePath)
	return s.client.Count(path, options)
}

// Get individual redirect
func (s *RedirectServiceOp) Get(redirectID int64, options interface{}) (*Redirect, error) {
	path := fmt.Sprintf("%s/%s/%d.json", globalApiPathPrefix, redirectsBasePath, redirectID)
	resource := new(RedirectResource)
	err := s.client.Get(path, resource, options)
	return resource.Redirect, err
}

// Create a new redirect
func (s *RedirectServiceOp) Create(redirect Redirect) (*Redirect, error) {
	path := fmt.Sprintf("%s/%s.json", globalApiPathPrefix, redirectsBasePath)
	wrappedData := RedirectResource{Redirect: &redirect}
	resource := new(RedirectResource)
	err := s.client.Post(path, wrappedData, resource)
	return resource.Redirect, err
}

// Update an existing redirect
func (s *RedirectServiceOp) Update(redirect Redirect) (*Redirect, error) {
	path := fmt.Sprintf("%s/%s/%d.json", globalApiPathPrefix, redirectsBasePath, redirect.ID)
	wrappedData := RedirectResource{Redirect: &redirect}
	resource := new(RedirectResource)
	err := s.client.Put(path, wrappedData, resource)
	return resource.Redirect, err
}

// Delete an existing redirect.
func (s *RedirectServiceOp) Delete(redirectID int64) error {
	return s.client.Delete(fmt.Sprintf("%s/%s/%d.json", globalApiPathPrefix, redirectsBasePath, redirectID))
}