Documentation
¶
Overview ¶
Package fireflyiii implements the Firefly III adapter for the finance capability.
Index ¶
- Constants
- func Register(app string, svc Service) error
- type Adapter
- func (a *Adapter) About(ctx context.Context) (*capability.FinanceAbout, error)
- func (a *Adapter) CreateTransaction(ctx context.Context, in CreateTransactionInput) (*capability.Transaction, error)
- func (a *Adapter) CurrentUser(ctx context.Context) (*capability.FinanceUser, error)
- func (a *Adapter) HealthCheck(ctx context.Context) (bool, error)
- type CreateTransactionInput
- type Service
Constants ¶
const ( OpCreateTransaction = "create_transaction" OpAbout = "about" OpCurrentUser = "current_user" OpHealth = "health" )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Adapter ¶
type Adapter struct {
// contains filtered or unexported fields
}
Adapter implements Service using the Firefly III provider client.
func (*Adapter) About ¶
func (a *Adapter) About(ctx context.Context) (*capability.FinanceAbout, error)
About returns Firefly III instance metadata.
func (*Adapter) CreateTransaction ¶
func (a *Adapter) CreateTransaction(ctx context.Context, in CreateTransactionInput) (*capability.Transaction, error)
CreateTransaction creates a new finance transaction. Source and destination must each be identified by id and/or name. ApplyRules and FireWebhooks are enabled so Firefly processes rules and notifies listeners.
func (*Adapter) CurrentUser ¶
func (a *Adapter) CurrentUser(ctx context.Context) (*capability.FinanceUser, error)
CurrentUser returns the authenticated Firefly III user.
type CreateTransactionInput ¶
type CreateTransactionInput struct {
Type string
Date string
Amount string
Description string
SourceID string
SourceName string
DestinationID string
DestinationName string
CategoryName string
Notes string
}
CreateTransactionInput holds parameters for creating a finance transaction.
type Service ¶
type Service interface {
CreateTransaction(ctx context.Context, in CreateTransactionInput) (*capability.Transaction, error)
About(ctx context.Context) (*capability.FinanceAbout, error)
CurrentUser(ctx context.Context) (*capability.FinanceUser, error)
HealthCheck(ctx context.Context) (bool, error)
}
Service defines the fireflyiii finance capability contract.
func New ¶
func New() Service
New creates an Adapter using the default provider client (reads config from YAML). Returns nil when the provider is not configured.
func NewWithClient ¶
func NewWithClient(c client) Service
NewWithClient creates an Adapter with a specific client, useful for testing.
Source Files