http

Documentation

Index

• func ParseMillidollars(millidollars int64) (int64, int16)
• func ToMillidollars(dollars int64, cents int16) int64
• type APIError
• type Client
  • func NewClient(accessToken string) (*Client, error)
  • func (c *Client) Get(requestPath string) (*http.Response, error)
  • func (c *Client) GetBudgets() ([]*model.Budget, error)
  • func (c *Client) GetCategories(budget *model.Budget) ([]*model.BudgetCategoryGroup, error)
  • func (c *Client) GetJSON(requestPath string, result interface{}) error
  • func (c *Client) GetMonthlyAverageSpent(budget *model.Budget, category *model.BudgetCategory, monthLookback int) (int64, int16, error)
  • func (c *Client) GetReadyToAssign(budget *model.Budget) (int64, int16, error)
  • func (c *Client) Patch(requestPath string, requestBody io.Reader) (*http.Response, error)
  • func (c *Client) PatchJSON(requestPath string, requestBody interface{}) error
  • func (c *Client) SetBudget(budget *model.Budget, category *model.BudgetCategory, newDollars int64, ...) error
• type ErrorContainer
  • func (ec *ErrorContainer) Error() string

Functions

func ParseMillidollars

func ParseMillidollars(millidollars int64) (int64, int16)

ParseMillidollars parses the "millidollar" unit returned by YNAB into dollars and cents

func ToMillidollars

func ToMillidollars(dollars int64, cents int16) int64

ToMillidollars converts the given dollars and cents to millidollars for YNAB's API

Types

type APIError

type APIError struct {
	ID     string `json:"id"`
	Name   string `json:"name"`
	Detail string `json:"detail"`
}

type Client

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

func NewClient

func NewClient(accessToken string) (*Client, error)

func (*Client) Get

func (c *Client) Get(requestPath string) (*http.Response, error)

Get issues an HTTP GET request to the given request path

func (*Client) GetBudgets

func (c *Client) GetBudgets() ([]*model.Budget, error)

func (*Client) GetCategories

func (c *Client) GetCategories(budget *model.Budget) ([]*model.BudgetCategoryGroup, error)

func (*Client) GetJSON

func (c *Client) GetJSON(requestPath string, result interface{}) error

GetJSON issues a GET request for JSON data to the given request path and populates the given result with the body of the response

func (*Client) GetMonthlyAverageSpent

func (c *Client) GetMonthlyAverageSpent(budget *model.Budget, category *model.BudgetCategory, monthLookback int) (int64, int16, error)

func (*Client) GetReadyToAssign

func (c *Client) GetReadyToAssign(budget *model.Budget) (int64, int16, error)

func (*Client) Patch

func (c *Client) Patch(requestPath string, requestBody io.Reader) (*http.Response, error)

Patch issues a PATCH request to the given request path with the given request body

func (*Client) PatchJSON

func (c *Client) PatchJSON(requestPath string, requestBody interface{}) error

PatchJSON submits a PATCH request formatted as JSON

func (*Client) SetBudget

func (c *Client) SetBudget(budget *model.Budget, category *model.BudgetCategory, newDollars int64, newCents int16) error

type ErrorContainer

type ErrorContainer struct {
	APIError *APIError `json:"error"`
}

func (*ErrorContainer) Error

func (ec *ErrorContainer) Error() string