History

Steven Polley 7ce58c03d7 continuous-integration/drone/push Build is passing Details continuous-integration/drone Build is passing Details comments and formatting		2024-03-30 19:42:58 -06:00
..
bitcoin	Do not export when not required	2024-03-23 14:06:38 -06:00
questrade	refresh questrade client if it's nil	2024-02-23 23:01:36 -07:00
staticjsonFinnhub	move providers into providers subdirectory	2023-11-13 17:39:22 -07:00
staticjsonYahooFinance	comments and formatting	2024-03-30 19:42:58 -06:00
README.md	add README.md for providers	2023-11-13 17:40:13 -07:00

README.md

Provider Packages

Provider packages are used for any integration and are found in their own sub directories. Providers must adhere to the interface speficied in accountProviders.go.

// AccountProvider is the base set of requirements to be implemented for any integration
type AccountProvider interface {
	Name() string                          // Returns the name of the provider
	Configure() error                      // Configures the provider for first use - if an error is returned the provider is not used
	GetBalances() ([]int, []string, error) // A slice of balances, and an index mapped slice of ynab account IDs this provider handles is returned
}

By convention, these methods are implemented in a file called providerImpl.go in each of the provider packages.

The following providers are currently available:

bitcoin
questrade
staticjsonFinnhub
staticjsonYahooFinance