m3o-go/currency/currency.go

package currency

import (
	"go.m3o.com/client"
)

func NewCurrencyService(token string) *CurrencyService {
	return &CurrencyService{
		client: client.NewClient(&client.Options{
			Token: token,
		}),
	}
}

type CurrencyService struct {
	client *client.Client
}

// Codes returns the supported currency codes for the API
func (t *CurrencyService) Codes(request *CodesRequest) (*CodesResponse, error) {
	rsp := &CodesResponse{}
	return rsp, t.client.Call("currency", "Codes", request, rsp)
}

// Convert returns the currency conversion rate between two pairs e.g USD/GBP
func (t *CurrencyService) Convert(request *ConvertRequest) (*ConvertResponse, error) {
	rsp := &ConvertResponse{}
	return rsp, t.client.Call("currency", "Convert", request, rsp)
}

// Returns the historic rates for a currency on a given date
func (t *CurrencyService) History(request *HistoryRequest) (*HistoryResponse, error) {
	rsp := &HistoryResponse{}
	return rsp, t.client.Call("currency", "History", request, rsp)
}

// Rates returns the currency rates for a given code e.g USD
func (t *CurrencyService) Rates(request *RatesRequest) (*RatesResponse, error) {
	rsp := &RatesResponse{}
	return rsp, t.client.Call("currency", "Rates", request, rsp)
}

type Code struct {
	// e.g United States Dollar
	Currency string `json:"currency"`
	// e.g USD
	Name string `json:"name"`
}

type CodesRequest struct {
}

type CodesResponse struct {
	Codes []Code `json:"codes"`
}

type ConvertRequest struct {
	// optional amount to convert e.g 10.0
	Amount float64 `json:"amount"`
	// base code to convert from e.g USD
	From string `json:"from"`
	// target code to convert to e.g GBP
	To string `json:"to"`
}

type ConvertResponse struct {
	// converted amount e.g 7.10
	Amount float64 `json:"amount"`
	// the base code e.g USD
	From string `json:"from"`
	// conversion rate e.g 0.71
	Rate float64 `json:"rate"`
	// the target code e.g GBP
	To string `json:"to"`
}

type HistoryRequest struct {
	// currency code e.g USD
	Code string `json:"code"`
	// date formatted as YYYY-MM-DD
	Date string `json:"date"`
}

type HistoryResponse struct {
	// The code of the request
	Code string `json:"code"`
	// The date requested
	Date string `json:"date"`
	// The rate for the day as code:rate
	Rates map[string]float64 `json:"rates"`
}

type RatesRequest struct {
	// The currency code to get rates for e.g USD
	Code string `json:"code"`
}

type RatesResponse struct {
	// The code requested e.g USD
	Code string `json:"code"`
	// The rates for the given code as key-value pairs code:rate
	Rates map[string]float64 `json:"rates"`
}