added OrderNotification, OrderNotifications, client.GetOrderNotifications

go.mod

@@ -3,7 +3,7 @@ module github.com/debyltech/go-snipcart
 go 1.19
 
 require (
-	github.com/debyltech/go-helpers v1.1.0
+	github.com/debyltech/go-helpers v1.1.1
 	github.com/debyltech/go-shippr v0.1.0
 	github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e
 )

snipcart/common.go

@@ -12,6 +12,8 @@ var (
 	orderUri      = apiUri + ordersPath
 	productsUri   = apiUri + productsPath
 	validationUri = apiUri + validationPath
+
+	orderNotificationPath = "notifications"
 )
 
 type Address struct {
@@ -37,6 +39,9 @@ type Client struct {
 }
 
 type CustomField struct {
-	Name  string `json:"name"`
+	Name     string `json:"name"`
-	Value string `json:"value"`
+	Value    string `json:"value"`
+	Type     string `json:"type,omitempty"`
+	Options  string `json:"options,omitempty"`
+	Required bool   `json:"required"`
 }

snipcart/enums.go

@@ -5,16 +5,16 @@ type NotificationType string
 
 const (
 	Processed  OrderStatus = "Processed"
-	Disputed               = "Disputed"
+	Disputed   OrderStatus = "Disputed"
-	Shipped                = "Shipped"
+	Shipped    OrderStatus = "Shipped"
-	Delivered              = "Delivered"
+	Delivered  OrderStatus = "Delivered"
-	Pending                = "Pending"
+	Pending    OrderStatus = "Pending"
-	Cancelled              = "Cancelled"
+	Cancelled  OrderStatus = "Cancelled"
-	Dispatched             = "Dispatched"
+	Dispatched OrderStatus = "Dispatched"
 
 	Comment            NotificationType = "Comment"
-	OrderStatusChanged                  = "OrderStatusChanged"
+	OrderStatusChanged NotificationType = "OrderStatusChanged"
-	OrderShipped                        = "OrderShipped"
+	OrderShipped       NotificationType = "OrderShipped"
-	TrackingNumber                      = "TrackingNumber"
+	TrackingNumber     NotificationType = "TrackingNumber"
-	Invoice                             = "Invice"
+	Invoice            NotificationType = "Invice"
 )

snipcart/snipcart.go

@@ -26,35 +26,63 @@ type Item struct {
 	Shippable    bool          `json:"shippable,omitempty"`
 }
 
+type OrderTax struct {
+	Name             string  `json:"taxName"`
+	Rate             float64 `json:"taxRate"`
+	Amount           float64 `json:"amount"`
+	NumberForInvoice string  `json:"numberForInvoice"`
+}
+
+type OrderNotification struct {
+	Id             string           `json:"id"`
+	Created        time.Time        `json:"creationDate"`
+	Type           NotificationType `json:"type"`
+	DeliveryMethod string           `json:"deliveryMethod"`
+	Message        string           `json:"message,omitempty"`
+	SendDate       time.Time        `json:"sentOn,omitempty"`
+	Subject        string           `json:"subject,omitempty"`
+}
+
+type OrderNotifications struct {
+	TotalNotifications int                 `json:"totalItems"`
+	Offset             int                 `json:"offset"`
+	Limit              int                 `json:"limit"`
+	Notifications      []OrderNotification `json:"items"`
+}
+
 type Order struct {
-	Token            string    `json:"token"`
+	Token            string     `json:"token"`
-	Created          time.Time `json:"creationDate"`
+	Created          time.Time  `json:"creationDate"`
-	Modified         time.Time `json:"modificationDate"`
+	Modified         time.Time  `json:"modificationDate"`
-	Invoice          string    `json:"invoiceNumber"`
+	Completed        time.Time  `json:"completionDate"`
-	Subtotal         float64   `json:"subtotal,omitempty"`
+	Invoice          string     `json:"invoiceNumber"`
-	Currency         string    `json:"currency,omitempty"`
+	Subtotal         float64    `json:"subtotal,omitempty"`
-	Total            float64   `json:"grandTotal,omitempty"`
+	Currency         string     `json:"currency,omitempty"`
-	Status           string    `json:"status"`
+	Total            float64    `json:"grandTotal,omitempty"`
-	TotalWeight      float64   `json:"totalWeight"`
+	TotalTaxable     float64    `json:"taxableTotal,omitempty"`
-	ShippingAddress  Address   `json:"shippingAddress,omitempty"`
+	TotalTaxes       float64    `json:"taxesTotal,omitempty"`
-	Name             string    `json:"shippingAddressName,omitempty"`
+	Status           string     `json:"status"`
-	Company          string    `json:"shippingAddressCompanyName,omitempty"`
+	TotalWeight      float64    `json:"totalWeight"`
-	Address1         string    `json:"shippingAddressAddress1,omitempty"`
+	ShippingAddress  Address    `json:"shippingAddress,omitempty"`
-	Address2         string    `json:"shippingAddressAddress2,omitempty"`
+	Name             string     `json:"shippingAddressName,omitempty"`
-	City             string    `json:"shippingAddressCity,omitempty"`
+	Company          string     `json:"shippingAddressCompanyName,omitempty"`
-	Province         string    `json:"shippingAddressProvince,omitempty"`
+	Address1         string     `json:"shippingAddressAddress1,omitempty"`
-	Country          string    `json:"shippingAddressCountry,omitempty"`
+	Address2         string     `json:"shippingAddressAddress2,omitempty"`
-	PostalCode       string    `json:"shippingAddressPostalCode,omitempty"`
+	City             string     `json:"shippingAddressCity,omitempty"`
-	Phone            string    `json:"shippingAddressPhone,omitempty"`
+	Province         string     `json:"shippingAddressProvince,omitempty"`
-	Email            string    `json:"email,omitempty"`
+	Country          string     `json:"shippingAddressCountry,omitempty"`
-	TrackingNumber   string    `json:"trackingNumber"`
+	PostalCode       string     `json:"shippingAddressPostalCode,omitempty"`
-	TrackingUrl      string    `json:"trackingUrl"`
+	Phone            string     `json:"shippingAddressPhone,omitempty"`
-	ShippingCost     float64   `json:"shippingFees"`
+	Email            string     `json:"email,omitempty"`
-	ShippingProvider string    `json:"shippingProvider,omitempty"`
+	TrackingNumber   string     `json:"trackingNumber"`
-	ShippingMethod   string    `json:"shippingMethod,omitempty"`
+	TrackingUrl      string     `json:"trackingUrl"`
-	ShippingRateId   string    `json:"shippingRateUserDefinedId,omitempty"`
+	ShippingCost     float64    `json:"shippingFees"`
-	Items            []Item    `json:"items"`
+	ShippingProvider string     `json:"shippingProvider,omitempty"`
-	Metadata         any       `json:"metadata"`
+	ShippingMethod   string     `json:"shippingMethod,omitempty"`
+	ShippingRateId   string     `json:"shippingRateUserDefinedId,omitempty"`
+	Items            []Item     `json:"items"`
+	Taxes            []OrderTax `json:"taxes,omitempty"`
+	Metadata         any        `json:"metadata"`
 }
 
 type OrderUpdate struct {
@@ -68,6 +96,8 @@ type OrderUpdate struct {
 
 type Orders struct {
 	TotalItems int
+	Offest     int
+	Limit      int
 	Items      []Order
 }
 
@@ -159,6 +189,26 @@ func (s *Client) GetOrder(token string) (*Order, error) {
 	return &order, nil
 }
 
+func (s *Client) GetOrderNotifications(token string) (*OrderNotifications, error) {
+	response, err := helper.Get(orderUri+"/"+token+"/"+orderNotificationPath, "Basic", s.AuthBase64, nil)
+	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 notifications OrderNotifications
+	err = json.NewDecoder(response.Body).Decode(&notifications)
+	if err != nil {
+		return nil, err
+	}
+
+	return &notifications, nil
+}
+
 func (s *Client) GetOrders(queries map[string]string) (*Orders, error) {
 	response, err := helper.Get(orderUri, "Basic", s.AuthBase64, queries)
 	if err != nil {