Documentation ¶
Index ¶
- type Account
- type AccountsList
- type Connection
- type ConnectionData
- type ConnectionFilter
- type ConnectionList
- type ConnectionService
- func (cs *ConnectionService) DeleteConnection(connectionId string) *errors.APIError
- func (cs *ConnectionService) ForConnection(connectionId string) Connection
- func (cs *ConnectionService) GetConnection(connectionId string) (Connection, *errors.APIError)
- func (cs *ConnectionService) GetJob(jobId string) (Job, *errors.APIError)
- func (cs *ConnectionService) NewConnection(connectionData *ConnectionData) (Job, *errors.APIError)
- func (cs *ConnectionService) RefreshConnection(connectionId string) (Job, *errors.APIError)
- func (cs *ConnectionService) UpdateConnection(connectionId, password string) (Job, *errors.APIError)
- type Institution
- type InstitutionData
- type InstitutionService
- type InstitutionsList
- type Job
- type JobLinks
- type JobStep
- type Session
- func (s *Session) CreateUser(createData *UserData) (User, *errors.APIError)
- func (s *Session) ForUser(userId string) User
- func (s *Session) GetInstitution(id string) (Institution, *errors.APIError)
- func (s *Session) GetInstitutions() (InstitutionsList, *errors.APIError)
- func (s *Session) RefreshToken() *errors.APIError
- type Statement
- type StatementList
- type StatementService
- type Transaction
- type TransactionService
- type TransactionsList
- type User
- func (u *User) CreateConnection(connectionData *ConnectionData) (Job, *errors.APIError)
- func (u *User) Delete() *errors.APIError
- func (u *User) GetAccount(accountId string) (Account, *errors.APIError)
- func (u *User) GetAccounts(filter *utilities.FilterBuilder) (AccountsList, *errors.APIError)
- func (u *User) GetTransaction(transactionId string) (Transaction, *errors.APIError)
- func (u *User) GetTransactions(filter *utilities.FilterBuilder) (TransactionsList, *errors.APIError)
- func (u *User) ListAllConnections(filter *utilities.FilterBuilder) (ConnectionList, *errors.APIError)
- func (u *User) RefreshAllConnections() *errors.APIError
- func (u *User) Update(update *UserData) *errors.APIError
- type UserData
- type UserService
- func (us *UserService) CreateUser(createData *UserData) (User, *errors.APIError)
- func (us *UserService) DeleteUser(userId string) *errors.APIError
- func (us *UserService) ForUser(userId string) User
- func (us *UserService) GetAccount(userId string, accountId string) (Account, *errors.APIError)
- func (us *UserService) GetAccounts(userId string, filter *utilities.FilterBuilder) (AccountsList, *errors.APIError)
- func (us *UserService) GetTransaction(userId string, transactionId string) (Transaction, *errors.APIError)
- func (us *UserService) GetTransactions(userId string, filter *utilities.FilterBuilder) (TransactionsList, *errors.APIError)
- func (us *UserService) GetUser(userId string) (User, *errors.APIError)
- func (us *UserService) ListAllConnections(userId string, filter *utilities.FilterBuilder) (ConnectionList, *errors.APIError)
- func (us *UserService) RefreshAllConnections(userId string) *errors.APIError
- func (us *UserService) UpdateUser(userId string, updateData *UserData) (User, *errors.APIError)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Account ¶
type Account struct { Id string `json:"id"` AccountNo string `json:"accountNo"` Name string `json:"name"` Currency string `json:"currency"` Balance string `json:"balance"` AvailableFunds string `json:"availableFunds"` LastUpdated string `json:"lastUpdated"` Class struct { Type string `json:"type"` Product string `json:"product"` Meta struct { AccountNumber string `json:"accountNumber"` AvailableRedraw string `json:"availableRedraw"` EndDate string `json:"endDate"` Fee string `json:"fee"` InstalmentAmount string `json:"instalmentAmount"` InterestRate string `json:"interestRate"` InterestType string `json:"interestType"` NextInstalmentDate string `json:"nextInstalmentDate"` OffsetAccountNumber string `json:"offsetAccountNumber"` RepaymentFrequency string `json:"repaymentFrequency"` RepaymentType string `json:"repaymentType"` } `json:"meta"` } `json:"class"` Status string `json:"status"` Institution string `json:"institution"` Connection string `json:"connection"` }
type AccountsList ¶
type Connection ¶
type Connection struct { Id string `json:"id"` Status string `json:"status"` LastUsed string `json:"lastUsed"` Institution Institution `json:"institution"` Accounts AccountsList `json:"accounts"` Service *ConnectionService }
func (*Connection) Delete ¶
func (c *Connection) Delete() *errors.APIError
type ConnectionData ¶
type ConnectionData struct { Institution *InstitutionData `json:"institution"` LoginId string `json:"loginId"` Password string `json:"password"` SecurityCode string `json:"securityCode,omitempty"` }
type ConnectionFilter ¶
type ConnectionList ¶
type ConnectionList struct { Count int `json:"count"` Data []Connection `json:"data"` }
type ConnectionService ¶
type ConnectionService struct { Session Session // contains filtered or unexported fields }
func NewConnectionService ¶
func NewConnectionService(session *Session, user *User) *ConnectionService
func (*ConnectionService) DeleteConnection ¶
func (cs *ConnectionService) DeleteConnection(connectionId string) *errors.APIError
func (*ConnectionService) ForConnection ¶
func (cs *ConnectionService) ForConnection(connectionId string) Connection
func (*ConnectionService) GetConnection ¶
func (cs *ConnectionService) GetConnection(connectionId string) (Connection, *errors.APIError)
func (*ConnectionService) GetJob ¶
func (cs *ConnectionService) GetJob(jobId string) (Job, *errors.APIError)
func (*ConnectionService) NewConnection ¶
func (cs *ConnectionService) NewConnection(connectionData *ConnectionData) (Job, *errors.APIError)
func (*ConnectionService) RefreshConnection ¶
func (cs *ConnectionService) RefreshConnection(connectionId string) (Job, *errors.APIError)
func (*ConnectionService) UpdateConnection ¶
func (cs *ConnectionService) UpdateConnection(connectionId, password string) (Job, *errors.APIError)
type Institution ¶
type Institution struct { Id string `json:"id"` Name string `json:"name"` ShortName string `json:"shortName"` Country string `json:"country"` ServiceName string `json:"serviceName"` ServiceType string `json:"serviceType"` LoginIdCaption string `json:"loginIdCaption"` PasswordCaption string `json:"PasswordCaption"` Logo struct { Type string `json:"type"` Colors string `json:"colors"` Links struct { Square string `json:"square"` Full string `json:"full"` } `json:"links"` } `json:"logo"` Links struct { Self string `json:"self"` } `json:"links"` }
type InstitutionData ¶
type InstitutionData struct {
Id string `json:"id"`
}
type InstitutionService ¶
type InstitutionService struct {
Session Session
}
func NewInstitutionService ¶
func NewInstitutionService(session *Session) *InstitutionService
func (*InstitutionService) GetInstitution ¶
func (is *InstitutionService) GetInstitution(institutionId string) (Institution, *errors.APIError)
func (*InstitutionService) GetInstitutions ¶
func (is *InstitutionService) GetInstitutions() (InstitutionsList, *errors.APIError)
type InstitutionsList ¶
type InstitutionsList struct { Count int `json:"count"` Data []Institution `json:"data"` }
type Job ¶
type Job struct { Id string `json:"id"` Steps []JobStep `json:"steps"` Created string `json:"created"` Updated string `json:"updated"` Links JobLinks `json:"links"` Service *ConnectionService }
func (*Job) GetConnection ¶
func (j *Job) GetConnection() (Connection, *errors.APIError)
func (*Job) GetConnectionId ¶
func (*Job) WaitForCredentials ¶
func (*Job) WaitForTransactions ¶
type Session ¶
func (*Session) CreateUser ¶
func (*Session) GetInstitution ¶
func (s *Session) GetInstitution(id string) (Institution, *errors.APIError)
func (*Session) GetInstitutions ¶
func (s *Session) GetInstitutions() (InstitutionsList, *errors.APIError)
func (*Session) RefreshToken ¶
type StatementList ¶
type StatementService ¶
type StatementService struct { Session *Session // contains filtered or unexported fields }
func NewStatementService ¶
func NewStatementService(session *Session, user *User) *StatementService
func (*StatementService) GetStatement ¶
func (is *StatementService) GetStatement(statementId string) (Statement, *errors.APIError)
func (*StatementService) GetStatements ¶
func (is *StatementService) GetStatements() (StatementList, *errors.APIError)
type Transaction ¶
type Transaction struct { Id string `json:"id"` Status string `json:"status"` Description string `json:"description"` PostDate string `json:"postDate"` TransactionDate string `json:"transactionDate"` Amount string `json:"amount"` Balance string `json:"balance"` BankCategory string `json:"bankCategory"` Account string `json:"account"` Institution string `json:"institution"` Connection string `json:"connection"` Class string `json:"class"` SubClass struct { Code string `json:"code"` Title string `json:"title"` } `json:"subClass"` Direction string `json:"direction"` }
type TransactionService ¶
type TransactionService struct {
Session *Session
}
func NewTransactionService ¶
func NewTransactionService(session *Session) *TransactionService
func (*TransactionService) GetTransaction ¶
func (ts *TransactionService) GetTransaction(userId, transactionId string) (Transaction, *errors.APIError)
func (*TransactionService) GetTransactions ¶
func (ts *TransactionService) GetTransactions(userId string, filter *utilities.FilterBuilder) (TransactionsList, *errors.APIError)
type TransactionsList ¶
type TransactionsList struct { Count int `json:"count"` Data []Transaction `json:"data"` Links map[string]string `json:"links"` Service *TransactionService }
type User ¶
type User struct { Id string `json:"id"` Email string `json:"email"` Mobile string `json:"mobile"` Connections ConnectionList `json:"connections"` Service *UserService }
func (*User) CreateConnection ¶
func (u *User) CreateConnection(connectionData *ConnectionData) (Job, *errors.APIError)
func (*User) GetAccounts ¶
func (u *User) GetAccounts(filter *utilities.FilterBuilder) (AccountsList, *errors.APIError)
func (*User) GetTransaction ¶
func (u *User) GetTransaction(transactionId string) (Transaction, *errors.APIError)
func (*User) GetTransactions ¶
func (u *User) GetTransactions(filter *utilities.FilterBuilder) (TransactionsList, *errors.APIError)
func (*User) ListAllConnections ¶
func (u *User) ListAllConnections(filter *utilities.FilterBuilder) (ConnectionList, *errors.APIError)
func (*User) RefreshAllConnections ¶
type UserService ¶
type UserService struct {
Session Session
}
func NewUserService ¶
func NewUserService(session *Session) *UserService
func (*UserService) CreateUser ¶
func (us *UserService) CreateUser(createData *UserData) (User, *errors.APIError)
func (*UserService) DeleteUser ¶
func (us *UserService) DeleteUser(userId string) *errors.APIError
func (*UserService) ForUser ¶
func (us *UserService) ForUser(userId string) User
func (*UserService) GetAccount ¶
func (*UserService) GetAccounts ¶
func (us *UserService) GetAccounts(userId string, filter *utilities.FilterBuilder) (AccountsList, *errors.APIError)
func (*UserService) GetTransaction ¶
func (us *UserService) GetTransaction(userId string, transactionId string) (Transaction, *errors.APIError)
func (*UserService) GetTransactions ¶
func (us *UserService) GetTransactions(userId string, filter *utilities.FilterBuilder) (TransactionsList, *errors.APIError)
func (*UserService) GetUser ¶
func (us *UserService) GetUser(userId string) (User, *errors.APIError)
func (*UserService) ListAllConnections ¶
func (us *UserService) ListAllConnections(userId string, filter *utilities.FilterBuilder) (ConnectionList, *errors.APIError)
func (*UserService) RefreshAllConnections ¶
func (us *UserService) RefreshAllConnections(userId string) *errors.APIError
func (*UserService) UpdateUser ¶
Click to show internal directories.
Click to hide internal directories.