Documentation ¶
Index ¶
- func RegisterAdminServer(svc *admin.Server)
- func RenderACHFilename(raw string, data FilenameData) (string, error)
- type Agent
- type CreatedAgents
- type FTPTransferAgent
- func (agent *FTPTransferAgent) Close() error
- func (agent *FTPTransferAgent) Delete(path string) error
- func (agent *FTPTransferAgent) GetInboundFiles() ([]string, error)
- func (agent *FTPTransferAgent) GetReconciliationFiles() ([]string, error)
- func (agent *FTPTransferAgent) GetReturnFiles() ([]string, error)
- func (agent *FTPTransferAgent) Hostname() string
- func (agent *FTPTransferAgent) ID() string
- func (agent *FTPTransferAgent) InboundPath() string
- func (agent *FTPTransferAgent) OutboundPath() string
- func (agent *FTPTransferAgent) Ping() error
- func (agent *FTPTransferAgent) ReadFile(path string) (*File, error)
- func (agent *FTPTransferAgent) ReconciliationPath() string
- func (agent *FTPTransferAgent) ReturnPath() string
- func (agent *FTPTransferAgent) UploadFile(f File) error
- type File
- type FilenameData
- type MockAgent
- func (a *MockAgent) Close() error
- func (a *MockAgent) Delete(path string) error
- func (a *MockAgent) GetInboundFiles() ([]string, error)
- func (a *MockAgent) GetReconciliationFiles() ([]string, error)
- func (a *MockAgent) GetReturnFiles() ([]string, error)
- func (a *MockAgent) Hostname() string
- func (a *MockAgent) ID() string
- func (a *MockAgent) InboundPath() string
- func (a *MockAgent) OutboundPath() string
- func (a *MockAgent) Ping() error
- func (a *MockAgent) ReadFile(path string) (*File, error)
- func (a *MockAgent) ReconciliationPath() string
- func (a *MockAgent) ReturnPath() string
- func (a *MockAgent) UploadFile(f File) error
- type RetryAgent
- func (rt *RetryAgent) Close() error
- func (rt *RetryAgent) Delete(path string) error
- func (rt *RetryAgent) GetInboundFiles() ([]string, error)
- func (rt *RetryAgent) GetReconciliationFiles() ([]string, error)
- func (rt *RetryAgent) GetReturnFiles() ([]string, error)
- func (rt *RetryAgent) Hostname() string
- func (rt *RetryAgent) ID() string
- func (rt *RetryAgent) InboundPath() string
- func (rt *RetryAgent) OutboundPath() string
- func (rt *RetryAgent) Ping() error
- func (rt *RetryAgent) ReadFile(path string) (*File, error)
- func (rt *RetryAgent) ReconciliationPath() string
- func (rt *RetryAgent) ReturnPath() string
- func (rt *RetryAgent) String() string
- func (rt *RetryAgent) UploadFile(f File) error
- type SFTPTransferAgent
- func (agent *SFTPTransferAgent) Close() error
- func (agent *SFTPTransferAgent) Delete(path string) error
- func (agent *SFTPTransferAgent) GetInboundFiles() ([]string, error)
- func (agent *SFTPTransferAgent) GetReconciliationFiles() ([]string, error)
- func (agent *SFTPTransferAgent) GetReturnFiles() ([]string, error)
- func (agent *SFTPTransferAgent) Hostname() string
- func (agent *SFTPTransferAgent) ID() string
- func (agent *SFTPTransferAgent) InboundPath() string
- func (agent *SFTPTransferAgent) OutboundPath() string
- func (agent *SFTPTransferAgent) Ping() error
- func (agent *SFTPTransferAgent) ReadFile(path string) (*File, error)
- func (agent *SFTPTransferAgent) ReconciliationPath() string
- func (agent *SFTPTransferAgent) ReturnPath() string
- func (agent *SFTPTransferAgent) UploadFile(f File) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterAdminServer ¶
func RenderACHFilename ¶
func RenderACHFilename(raw string, data FilenameData) (string, error)
Types ¶
type Agent ¶
type Agent interface { ID() string GetInboundFiles() ([]string, error) GetReconciliationFiles() ([]string, error) GetReturnFiles() ([]string, error) UploadFile(f File) error Delete(path string) error ReadFile(path string) (*File, error) InboundPath() string OutboundPath() string ReconciliationPath() string ReturnPath() string Hostname() string Ping() error Close() error }
Agent represents an interface for uploading and retrieving ACH files from a remote service.
type CreatedAgents ¶
type CreatedAgents struct {
// contains filtered or unexported fields
}
type FTPTransferAgent ¶
type FTPTransferAgent struct {
// contains filtered or unexported fields
}
FTPTransferAgent is an FTP implementation of a Agent
func (*FTPTransferAgent) Close ¶
func (agent *FTPTransferAgent) Close() error
func (*FTPTransferAgent) Delete ¶
func (agent *FTPTransferAgent) Delete(path string) error
func (*FTPTransferAgent) GetInboundFiles ¶
func (agent *FTPTransferAgent) GetInboundFiles() ([]string, error)
func (*FTPTransferAgent) GetReconciliationFiles ¶
func (agent *FTPTransferAgent) GetReconciliationFiles() ([]string, error)
func (*FTPTransferAgent) GetReturnFiles ¶
func (agent *FTPTransferAgent) GetReturnFiles() ([]string, error)
func (*FTPTransferAgent) Hostname ¶
func (agent *FTPTransferAgent) Hostname() string
func (*FTPTransferAgent) ID ¶
func (agent *FTPTransferAgent) ID() string
func (*FTPTransferAgent) InboundPath ¶
func (agent *FTPTransferAgent) InboundPath() string
func (*FTPTransferAgent) OutboundPath ¶
func (agent *FTPTransferAgent) OutboundPath() string
func (*FTPTransferAgent) Ping ¶
func (agent *FTPTransferAgent) Ping() error
func (*FTPTransferAgent) ReadFile ¶ added in v0.23.4
func (agent *FTPTransferAgent) ReadFile(path string) (*File, error)
func (*FTPTransferAgent) ReconciliationPath ¶
func (agent *FTPTransferAgent) ReconciliationPath() string
func (*FTPTransferAgent) ReturnPath ¶
func (agent *FTPTransferAgent) ReturnPath() string
func (*FTPTransferAgent) UploadFile ¶
func (agent *FTPTransferAgent) UploadFile(f File) error
uploadFile saves the content of File at the given filename in the OutboundPath directory
The File's contents will always be closed
type File ¶
type File struct { Filepath string Contents io.ReadCloser }
type FilenameData ¶
type MockAgent ¶
type MockAgent struct { InboundFilepaths []string ReconciliationFilepaths []string ReturnFilepaths []string UploadedFile *File // non-nil on file upload DeletedFile string // filepath of last deleted file ReadableFile *File Err error // contains filtered or unexported fields }
func (*MockAgent) GetInboundFiles ¶
func (*MockAgent) GetReconciliationFiles ¶
func (*MockAgent) GetReturnFiles ¶
func (*MockAgent) InboundPath ¶
func (*MockAgent) OutboundPath ¶
func (*MockAgent) ReconciliationPath ¶
func (*MockAgent) ReturnPath ¶
func (*MockAgent) UploadFile ¶
type RetryAgent ¶
type RetryAgent struct {
// contains filtered or unexported fields
}
func (*RetryAgent) Close ¶
func (rt *RetryAgent) Close() error
func (*RetryAgent) Delete ¶
func (rt *RetryAgent) Delete(path string) error
func (*RetryAgent) GetInboundFiles ¶
func (rt *RetryAgent) GetInboundFiles() ([]string, error)
Network'd calls
func (*RetryAgent) GetReconciliationFiles ¶
func (rt *RetryAgent) GetReconciliationFiles() ([]string, error)
func (*RetryAgent) GetReturnFiles ¶
func (rt *RetryAgent) GetReturnFiles() ([]string, error)
func (*RetryAgent) Hostname ¶
func (rt *RetryAgent) Hostname() string
func (*RetryAgent) ID ¶
func (rt *RetryAgent) ID() string
func (*RetryAgent) InboundPath ¶
func (rt *RetryAgent) InboundPath() string
Non-Network calls, so pass-through
func (*RetryAgent) OutboundPath ¶
func (rt *RetryAgent) OutboundPath() string
func (*RetryAgent) Ping ¶
func (rt *RetryAgent) Ping() error
func (*RetryAgent) ReadFile ¶ added in v0.23.4
func (rt *RetryAgent) ReadFile(path string) (*File, error)
func (*RetryAgent) ReconciliationPath ¶
func (rt *RetryAgent) ReconciliationPath() string
func (*RetryAgent) ReturnPath ¶
func (rt *RetryAgent) ReturnPath() string
func (*RetryAgent) String ¶
func (rt *RetryAgent) String() string
func (*RetryAgent) UploadFile ¶
func (rt *RetryAgent) UploadFile(f File) error
type SFTPTransferAgent ¶
type SFTPTransferAgent struct {
// contains filtered or unexported fields
}
func (*SFTPTransferAgent) Close ¶
func (agent *SFTPTransferAgent) Close() error
func (*SFTPTransferAgent) Delete ¶
func (agent *SFTPTransferAgent) Delete(path string) error
func (*SFTPTransferAgent) GetInboundFiles ¶
func (agent *SFTPTransferAgent) GetInboundFiles() ([]string, error)
func (*SFTPTransferAgent) GetReconciliationFiles ¶
func (agent *SFTPTransferAgent) GetReconciliationFiles() ([]string, error)
func (*SFTPTransferAgent) GetReturnFiles ¶
func (agent *SFTPTransferAgent) GetReturnFiles() ([]string, error)
func (*SFTPTransferAgent) Hostname ¶
func (agent *SFTPTransferAgent) Hostname() string
func (*SFTPTransferAgent) ID ¶
func (agent *SFTPTransferAgent) ID() string
func (*SFTPTransferAgent) InboundPath ¶
func (agent *SFTPTransferAgent) InboundPath() string
func (*SFTPTransferAgent) OutboundPath ¶
func (agent *SFTPTransferAgent) OutboundPath() string
func (*SFTPTransferAgent) Ping ¶
func (agent *SFTPTransferAgent) Ping() error
func (*SFTPTransferAgent) ReadFile ¶ added in v0.23.4
func (agent *SFTPTransferAgent) ReadFile(path string) (*File, error)
func (*SFTPTransferAgent) ReconciliationPath ¶
func (agent *SFTPTransferAgent) ReconciliationPath() string
func (*SFTPTransferAgent) ReturnPath ¶
func (agent *SFTPTransferAgent) ReturnPath() string
func (*SFTPTransferAgent) UploadFile ¶
func (agent *SFTPTransferAgent) UploadFile(f File) error
uploadFile saves the content of File at the given filename in the OutboundPath directory
The File's contents will always be closed
Click to show internal directories.
Click to hide internal directories.