corrected SnipcartProductsResponse, added GetProductById

examples/example.go

@@ -15,9 +15,9 @@ func main() {
 		log.Fatal("missing -key flag")
 	}
 
-	snipcartProvider := snipcart.NewSnipcartProvider(*snipcartApiKey)
+	Client := snipcart.NewClient(*snipcartApiKey)
 
-	response, err := snipcartProvider.GetOrdersByStatus(snipcart.Processed)
+	response, err := Client.GetOrdersByStatus(snipcart.Processed)
 	if err != nil {
 		log.Fatal(err)
 	}

examples/example_get_order.go

@@ -17,9 +17,9 @@ func main() {
 		log.Fatal("missing -key flag")
 	}
 
-	snipcartProvider := snipcart.NewSnipcartProvider(*snipcartApiKey)
+	Client := snipcart.NewClient(*snipcartApiKey)
 
-	response, err := snipcartProvider.GetOrder("b35990df-c0ca-4014-94de-1caa7bd7bb51")
+	response, err := Client.GetOrder("b35990df-c0ca-4014-94de-1caa7bd7bb51")
 	if err != nil {
 		log.Fatal(err)
 	}

examples/example_update_order.go

@@ -15,13 +15,13 @@ func main() {
 		log.Fatal("missing -key flag")
 	}
 
-	snipcartProvider := snipcart.NewSnipcartProvider(*snipcartApiKey)
+	Client := snipcart.NewClient(*snipcartApiKey)
 
 	updateOrder := snipcart.SnipcartOrderUpdate{
 		Status: snipcart.Delivered,
 	}
 
-	response, err := snipcartProvider.UpdateOrder("b35990df-c0ca-4014-94de-1caa7bd7bb51", &updateOrder)
+	response, err := Client.UpdateOrder("b35990df-c0ca-4014-94de-1caa7bd7bb51", &updateOrder)
 	if err != nil {
 		log.Fatal(err)
 	}

go.mod

@@ -1,8 +1,9 @@
 module github.com/debyltech/go-snipcart
 
-go 1.20
+go 1.19
 
 require (
-	github.com/debyltech/go-helpers v1.0.5
+	github.com/debyltech/go-helpers v1.1.0
+	github.com/debyltech/go-shippr v0.1.0
 	github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e
 )

snipcart/enums.go

@@ -1,6 +1,7 @@
 package snipcart
 
 type OrderStatus string
+type NotificationType string
 
 const (
 	Processed  OrderStatus = "Processed"
@@ -10,4 +11,10 @@ const (
 	Pending                = "Pending"
 	Cancelled              = "Cancelled"
 	Dispatched             = "Dispatched"
+
+	Comment            NotificationType = "Comment"
+	OrderStatusChanged                  = "OrderStatusChanged"
+	OrderShipped                        = "OrderShipped"
+	TrackingNumber                      = "TrackingNumber"
+	Invoice                             = "Invice"
 )

snipcart/snipcart.go

@@ -5,22 +5,28 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"net/http"
+	"time"
 
-	helper "github.com/debyltech/go-helpers"
+	helper "github.com/debyltech/go-helpers/json"
 	"github.com/skip2/go-qrcode"
 )
 
 const (
-	defaultLimit = 50
+	defaultLimit   = 50
-	apiUri       = "https://app.snipcart.com"
+	apiUri         = "https://app.snipcart.com"
-	ordersPath   = "/api/orders"
+	ordersPath     = "/api/orders"
+	productsPath   = "/api/products"
+	validationPath = "/api/requestvalidation/"
 )
 
 var (
-	orderUri = apiUri + ordersPath
+	orderUri      = apiUri + ordersPath
+	productsUri   = apiUri + productsPath
+	validationUri = apiUri + validationPath
 )
 
-type SnipcartProvider struct {
+type Client struct {
 	SnipcartKey string
 	AuthBase64  string
 	Limit       int
@@ -37,6 +43,7 @@ type SnipcartItem struct {
 	Name         string                `json:"name"`
 	Quantity     int                   `json:"quantity"`
 	TotalWeight  float64               `json:"totalWeight,omitempty"`
+	TotalPrice   float64               `json:"totalPrice,omitempty"`
 	CustomFields []SnipcartCustomField `json:"customFields"`
 	Length       float64               `json:"length,omitempty"`
 	Width        float64               `json:"width,omitempty"`
@@ -46,23 +53,34 @@ type SnipcartItem struct {
 }
 
 type SnipcartOrder struct {
-	Token          string         `json:"token"`
+	Token            string                  `json:"token"`
-	Invoice        string         `json:"invoiceNumber"`
+	Created          time.Time               `json:"creationDate"`
-	Status         string         `json:"status"`
+	Modified         time.Time               `json:"modificationDate"`
-	TotalWeight    float64        `json:"totalWeight"`
+	Invoice          string                  `json:"invoiceNumber"`
-	Email          string         `json:"email"`
+	Subtotal         float64                 `json:"subtotal,omitempty"`
-	Name           string         `json:"shippingAddressName"`
+	Currency         string                  `json:"currency,omitempty"`
-	Address1       string         `json:"shippingAddressAddress1"`
+	Total            float64                 `json:"grandTotal,omitempty"`
-	Address2       string         `json:"shippingAddressAddress2"`
+	Status           string                  `json:"status"`
-	City           string         `json:"shippingAddressCity"`
+	TotalWeight      float64                 `json:"totalWeight"`
-	Province       string         `json:"shippingAddressProvince"`
+	ShippingAddress  SnipcartShippingAddress `json:"shippingAddress,omitempty"`
-	Country        string         `json:"shippingAddressCountry"`
+	Name             string                  `json:"shippingAddressName,omitempty"`
-	PostalCode     string         `json:"shippingAddressPostalCode"`
+	Company          string                  `json:"shippingAddressCompanyName,omitempty"`
-	Phone          string         `json:"shippingAddressPhone"`
+	Address1         string                  `json:"shippingAddressAddress1,omitempty"`
-	TrackingNumber string         `json:"trackingNumber"`
+	Address2         string                  `json:"shippingAddressAddress2,omitempty"`
-	TrackingUrl    string         `json:"trackingUrl"`
+	City             string                  `json:"shippingAddressCity,omitempty"`
-	ShippingCost   float64        `json:"shippingFees"`
+	Province         string                  `json:"shippingAddressProvince,omitempty"`
-	Items          []SnipcartItem `json:"items"`
+	Country          string                  `json:"shippingAddressCountry,omitempty"`
+	PostalCode       string                  `json:"shippingAddressPostalCode,omitempty"`
+	Phone            string                  `json:"shippingAddressPhone,omitempty"`
+	Email            string                  `json:"email,omitempty"`
+	TrackingNumber   string                  `json:"trackingNumber"`
+	TrackingUrl      string                  `json:"trackingUrl"`
+	ShippingCost     float64                 `json:"shippingFees"`
+	ShippingProvider string                  `json:"shippingProvider,omitempty"`
+	ShippingMethod   string                  `json:"shippingMethod,omitempty"`
+	ShippingRateId   string                  `json:"shippingRateUserDefinedId,omitempty"`
+	Items            []SnipcartItem          `json:"items"`
+	Metadata         any                     `json:"metadata"`
 }
 
 type SnipcartOrderUpdate struct {
@@ -70,6 +88,7 @@ type SnipcartOrderUpdate struct {
 	PaymentStatus  string      `json:"paymentStatus,omitempty"`
 	TrackingNumber string      `json:"trackingNumber,omitempty"`
 	TrackingUrl    string      `json:"trackingUrl,omitempty"`
+	ShippingRateId string      `json:"shippingRateUserDefinedId,omitempty"`
 	Metadata       any         `json:"metadata,omitempty"`
 }
 
@@ -78,14 +97,69 @@ type SnipcartOrders struct {
 	Items      []SnipcartOrder
 }
 
-func NewSnipcartProvider(snipcartApiKey string) SnipcartProvider {
+type SnipcartTax struct {
-	return SnipcartProvider{
+	Name             string  `json:"name"`
+	Amount           float64 `json:"amount"`
+	NumberForInvoice string  `json:"numberForInvoice"`
+	Rate             float64 `json:"rate"`
+}
+
+type SnipcartNotification struct {
+	Type           NotificationType `json:"type"`
+	DeliveryMethod string           `json:"deliveryMethod"`
+	Message        string           `json:"message,omitempty"`
+}
+
+type SnipcartNotificationResponse struct {
+	Id             string           `json:"id"`
+	Created        time.Time        `json:"creationDate"`
+	Type           NotificationType `json:"type"`
+	DeliveryMethod string           `json:"deliveryMethod"`
+	Body           string           `json:"body"`
+	Message        string           `json:"message"`
+	Subject        string           `json:"subject"`
+	SentOn         time.Time        `json:"sentOn"`
+}
+
+type SnipcartProductVariant struct {
+	Stock          int   `json:"stock"`
+	Variation      []any `json:"variation"`
+	AllowBackorder bool  `json:"allowOutOfStockPurchases"`
+}
+
+type SnipcartProduct struct {
+	Token          string                   `json:"id"`
+	Id             string                   `json:"userDefinedId"`
+	Name           string                   `json:"name"`
+	Stock          int                      `json:"stock"`
+	TotalStock     int                      `json:"totalStock"`
+	AllowBackorder bool                     `json:"allowOutOfStockPurchases"`
+	Variants       []SnipcartProductVariant `json:"variants"`
+}
+
+type SnipcartProductsResponse struct {
+	Keywords      string            `json:"keywords"`
+	UserDefinedId string            `json:"userDefinedId"`
+	Archived      bool              `json:"archived"`
+	From          time.Time         `json:"from"`
+	To            time.Time         `json:"to"`
+	OrderBy       string            `json:"orderBy"`
+	Paginated     bool              `json:"hasMoreResults"`
+	TotalItems    int               `json:"totalItems"`
+	Offset        int               `json:"offset"`
+	Limit         int               `json:"limit"`
+	Sort          []any             `json:"sort"`
+	Items         []SnipcartProduct `json:"items"`
+}
+
+func NewClient(snipcartApiKey string) *Client {
+	return &Client{
 		SnipcartKey: snipcartApiKey,
 		AuthBase64:  base64.StdEncoding.EncodeToString([]byte(snipcartApiKey + ":")),
 	}
 }
 
-func (s *SnipcartProvider) GetOrder(token string) (*SnipcartOrder, error) {
+func (s *Client) GetOrder(token string) (*SnipcartOrder, error) {
 	response, err := helper.Get(orderUri+"/"+token, "Basic", s.AuthBase64, nil)
 	if err != nil {
 		return nil, err
@@ -105,7 +179,7 @@ func (s *SnipcartProvider) GetOrder(token string) (*SnipcartOrder, error) {
 	return &order, nil
 }
 
-func (s *SnipcartProvider) GetOrders(queries map[string]string) (*SnipcartOrders, error) {
+func (s *Client) GetOrders(queries map[string]string) (*SnipcartOrders, error) {
 	response, err := helper.Get(orderUri, "Basic", s.AuthBase64, queries)
 	if err != nil {
 		return nil, err
@@ -125,7 +199,7 @@ func (s *SnipcartProvider) GetOrders(queries map[string]string) (*SnipcartOrders
 	return &orders, nil
 }
 
-func (s *SnipcartProvider) GetOrdersByStatus(status OrderStatus) (*SnipcartOrders, error) {
+func (s *Client) GetOrdersByStatus(status OrderStatus) (*SnipcartOrders, error) {
 	if status == "" {
 		return nil, errors.New("status is not set")
 	}
@@ -142,7 +216,7 @@ func (o *SnipcartOrder) TokenPNGBase64() (string, error) {
 	return base64.StdEncoding.EncodeToString(img), nil
 }
 
-func (s *SnipcartProvider) UpdateOrder(token string, orderUpdate *SnipcartOrderUpdate) (*SnipcartOrder, error) {
+func (s *Client) UpdateOrder(token string, orderUpdate *SnipcartOrderUpdate) (*SnipcartOrder, error) {
 	response, err := helper.Put(orderUri+"/"+token, "Basic", s.AuthBase64, orderUpdate)
 	if err != nil {
 		return nil, err
@@ -150,7 +224,6 @@ func (s *SnipcartProvider) UpdateOrder(token string, orderUpdate *SnipcartOrderU
 	if response.StatusCode < 200 && response.StatusCode >= 300 {
 		return nil, fmt.Errorf("unexpected response received: %s", response.Status)
 	}
-	fmt.Println(response.Status)
 
 	defer response.Body.Close()
 
@@ -162,3 +235,84 @@ func (s *SnipcartProvider) UpdateOrder(token string, orderUpdate *SnipcartOrderU
 
 	return &responseOrder, nil
 }
+
+func (s *Client) SendNotification(token string, notification *SnipcartNotification) (*SnipcartNotificationResponse, error) {
+	response, err := helper.Post(orderUri+"/"+token+"/notifications", "Basic", s.AuthBase64, notification)
+	if err != nil {
+		return nil, err
+	}
+
+	defer response.Body.Close()
+
+	var responseNotification SnipcartNotificationResponse
+	err = json.NewDecoder(response.Body).Decode(&responseNotification)
+	if err != nil {
+		return nil, err
+	}
+
+	return &responseNotification, nil
+}
+
+func (s *Client) ValidateWebhook(token string) error {
+	validateRequest, err := http.NewRequest("GET", validationUri+token, nil)
+	if err != nil {
+		return err
+	}
+
+	client := &http.Client{}
+
+	auth := base64.StdEncoding.EncodeToString([]byte(s.SnipcartKey + ":"))
+	validateRequest.Header.Set("Authorization", fmt.Sprintf("Basic %s", auth))
+	validateRequest.Header.Set("Accept", "application/json")
+
+	validateResponse, err := client.Do(validateRequest)
+	if err != nil {
+		return fmt.Errorf("error validating webhook: %s", err.Error())
+	}
+
+	if validateResponse.StatusCode < 200 || validateResponse.StatusCode >= 300 {
+		return fmt.Errorf("non-2XX status code for validating webhook: %d", validateResponse.StatusCode)
+	}
+
+	return nil
+}
+
+func (s *Client) GetProducts(queries map[string]string) (*SnipcartProductsResponse, error) {
+	response, err := helper.Get(productsUri, "Basic", s.AuthBase64, queries)
+	if err != nil {
+		return nil, err
+	}
+	if response.StatusCode < 200 && response.StatusCode >= 300 {
+		return nil, fmt.Errorf("unexpected response received: %s", response.Status)
+	}
+
+	defer response.Body.Close()
+
+	var products SnipcartProductsResponse
+	err = json.NewDecoder(response.Body).Decode(&products)
+	if err != nil {
+		return nil, err
+	}
+
+	return &products, nil
+}
+
+func (s *Client) GetProductById(id string) (*SnipcartProduct, error) {
+	response, err := helper.Get(productsUri, "Basic", s.AuthBase64, map[string]string{"userDefinedId": id})
+	if err != nil {
+		return nil, err
+	}
+	if response.StatusCode < 200 && response.StatusCode >= 300 {
+		return nil, fmt.Errorf("unexpected response received: %s", response.Status)
+	}
+
+	defer response.Body.Close()
+
+	var product SnipcartProduct
+	err = json.NewDecoder(response.Body).Decode(&product)
+	if err != nil {
+		return nil, err
+	}
+
+	return &product, nil
+}

snipcart/webhook.go

@@ -0,0 +1,21 @@
+package snipcart
+
+type SnipcartShippingAddress struct {
+	FullName    string `json:"fullName"`
+	FirstName   string `json:"firstName"`
+	Name        string `json:"name"`
+	Company     string `json:"company"`
+	Address1    string `json:"address1"`
+	Address2    string `json:"address2"`
+	FullAddress string `json:"fullAddress"`
+	City        string `json:"city"`
+	Country     string `json:"country"`
+	PostalCode  string `json:"postalCode"`
+	Province    string `json:"province"`
+	Phone       string `json:"phone"`
+	VatNumber   string `json:"vatNumber,omitempty"`
+}
+
+type SnipcartWebhookTaxResponse struct {
+	Taxes []SnipcartTax `json:"taxes"`
+}