api

Documentation

Index

• Constants
• type APIConfig
• type Client
  • func New(c Config) *Client
  • func (c *Client) AllMembersInGroup(ctx context.Context) ([]Member, error)
  • func (c *Client) AllTransactionsInGroup(ctx context.Context) ([]Transaction, error)
  • func (c *Client) AuthedRequest(req *http.Request) ([]byte, error)
  • func (c *Client) CreateTransactionInGroup(ctx context.Context, t Transaction) (*CreateTransactionRes, error)
  • func (c *Client) Login(ctx context.Context) (string, error)
  • func (c *Client) Request(req *http.Request) ([]byte, error)
• type Config
• type CreateTransactionRes
• type Item
• type Member
• type PayingUser
• type SettleUpConfig
• type SettleUpTime
  • func (sut SettleUpTime) MarshalJSON() ([]byte, error)
  • func (sut *SettleUpTime) UnmarshalJSON(b []byte) error
• type Transaction

Constants

const (
	CurrencyCodeEuro currencyCode = "EUR"
)

const (
	TransactionTypeExpense transactionType = "expense"
)

Types

type APIConfig

type APIConfig struct {
	BaseURL string
	Key     string

	SettleUpConf SettleUpConfig
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func New

func New(c Config) *Client

func (*Client) AllMembersInGroup

func (c *Client) AllMembersInGroup(ctx context.Context) ([]Member, error)

func (*Client) AllTransactionsInGroup

func (c *Client) AllTransactionsInGroup(ctx context.Context) ([]Transaction, error)

func (*Client) AuthedRequest

func (c *Client) AuthedRequest(req *http.Request) ([]byte, error)

func (*Client) CreateTransactionInGroup

func (c *Client) CreateTransactionInGroup(ctx context.Context, t Transaction) (*CreateTransactionRes, error)

func (*Client) Login

func (c *Client) Login(ctx context.Context) (string, error)

func (*Client) Request

func (c *Client) Request(req *http.Request) ([]byte, error)

type Config

type Config struct {
	Logger *slog.Logger

	HTTPClient *http.Client

	APIConf APIConfig
}

type CreateTransactionRes

type CreateTransactionRes struct {
	ID string `json:"name"`
}

type Item

type Item struct {
	Amount  float32      `json:"amount,string"`
	ForWhom []PayingUser `json:"forWhom"`
}

type Member

type Member struct {
	ID *string `json:"id,omitempty"`

	Name          string  `json:"name"`
	Active        bool    `json:"active"`
	DefaultWeight float32 `json:"defaultWeight,string"`
}

type PayingUser

type PayingUser struct {
	MemberID string  `json:"memberId"`
	Weight   float32 `json:"weight,string"`
}

type SettleUpConfig

type SettleUpConfig struct {
	Username string
	Password string

	GroupID string
}

type SettleUpTime

type SettleUpTime struct {
	time.Time
}

func (SettleUpTime) MarshalJSON

func (sut SettleUpTime) MarshalJSON() ([]byte, error)

func (*SettleUpTime) UnmarshalJSON

func (sut *SettleUpTime) UnmarshalJSON(b []byte) error

type Transaction

type Transaction struct {
	ID *string `json:"id,omitempty"`

	Category          *string         `json:"category,omitempty"`
	CurrencyCode      currencyCode    `json:"currencyCode"`
	DateTime          SettleUpTime    `json:"dateTime"`
	ExchangeRates     any             `json:"exchangeRates"`
	FixedExchangeRate bool            `json:"fixedExchangeRate"`
	Items             []Item          `json:"items"`
	Purpose           string          `json:"purpose"`
	ReceiptURL        *string         `json:"receiptUrl,omitempty"`
	Type              transactionType `json:"type"`
	WhoPaid           []PayingUser    `json:"whoPaid"`
}