service

type Admin struct {
	BindAddress string
}

type AuditTrail struct {
	ID        string
	BucketURI string
	BasePath  string // e.g. 'incoming' or 'outgoing'
	GPG       *GPG
}

type ClientConfig struct {
	Timeout             time.Duration
	MaxIdleConns        int
	MaxIdleConnsPerHost int
	MaxConnsPerHost     int
}

type Config struct {
	Logger    log.Logger `json:"-"`
	Clients   *ClientConfig
	Database  database.DatabaseConfig
	Telemetry telemetry.Config
	Admin     Admin
	Inbound   Inbound
	Events    *EventsConfig
	Sharding  Sharding
	Upload    UploadAgents
	Errors    ErrorAlerting
}

type Cutoffs struct {
	Timezone string
	Windows  []string
}

type Email struct {
	ID string

	From string
	To   []string

	// ConnectionURI is a URI used to connect with a remote SFTP server.
	// This config typically needs to contain enough values to successfully
	// authenticate with the server.
	// - insecure_skip_verify is an optional parameter for disabling certificate verification
	//
	// Example: smtps://user:pass@localhost:1025/?insecure_skip_verify=true
	ConnectionURI string
	MaxRetries    int

	Template    string
	CompanyName string
}

type ErrorAlerting struct {
	PagerDuty *PagerDutyAlerting
	Slack     *SlackAlerting
}

type EventsConfig struct {
	Stream    *EventsStream
	Webhook   *WebhookConfig
	Transform *models.TransformConfig
}

type EventsStream struct {
	InMem *InMemory
	Kafka *KafkaConfig
}

type FTP struct {
	Hostname string
	Username string
	Password string

	CAFilepath   string
	DialTimeout  time.Duration
	DisabledEPSV bool
}

type FlattenBatches struct{}

type GPG struct {
	KeyFile string
	Signer  *Signer
}

type GlobalConfig struct {
	ACHGateway Config
}

type HTTPConfig struct {
	BindAddress string
	TLS         TLSConfig

	Transform    *models.TransformConfig
	MaxBodyBytes int64
}

type InMemory struct {
	URL string
}

type Inbound struct {
	HTTP  HTTPConfig
	InMem *InMemory
	Kafka *KafkaConfig
	ODFI  *ODFIFiles
	Audit *AuditTrail
}

type KafkaConfig struct {
	Brokers []string
	Key     string
	Secret  string
	Group   string
	Topic   string
	TLS     bool

	// AutoCommit in Sarama refers to "automated publishing of consumer offsets
	// to the broker" rather than a Kafka broker's meaning of "commit consumer
	// offsets on read" which leads to "at-most-once" delivery.
	AutoCommit bool

	Consumer KafkaConsumerConfig
	Producer KafkaProducerConfig

	Transform *models.TransformConfig
}

type KafkaConsumerConfig struct{}

type KafkaProducerConfig struct {
	MaxMessageBytes int
}

type MergableConfig struct {
	Conditions     *ach.Conditions
	FlattenBatches *FlattenBatches
}

type Merging struct {
	Storage   storage.Config
	Directory string // fallback config for Storage.Filesystem.Directory
}

type MockAgent struct{}

type NotificationRetries struct {
	Interval   time.Duration
	MaxRetries uint64
}

type Notifications struct {
	Email     []Email
	PagerDuty []PagerDuty
	Slack     []Slack
	Retry     *NotificationRetries
}

type ODFICorrections struct {
	Enabled     bool
	PathMatcher string
}

type ODFIFiles struct {
	Processors ODFIProcessors
	Interval   time.Duration
	ShardNames []string
	Storage    ODFIStorage
	Audit      *AuditTrail
}

type ODFIIncoming struct {
	Enabled     bool
	PathMatcher string

	ExcludeCorrections     bool
	ExcludePrenotes        bool
	ExcludeReturns         bool
	ExcludeReconciliations bool
}

type ODFIPrenotes struct {
	Enabled     bool
	PathMatcher string
}

type ODFIProcessors struct {
	Corrections    ODFICorrections
	Incoming       ODFIIncoming
	Reconciliation ODFIReconciliation
	Prenotes       ODFIPrenotes
	Returns        ODFIReturns

	Validation ach.ValidateOpts
}

type ODFIReconciliation struct {
	Enabled     bool
	PathMatcher string

	ProduceFileEvents  bool
	ProduceEntryEvents bool
}

type ODFIReturns struct {
	Enabled     bool
	PathMatcher string
}

type ODFIStorage struct {
	// Directory is the local filesystem path for downloading files into
	Directory string

	// CleanupLocalDirectory determines if we delete the local directory after
	// processing is finished. Leaving these files around helps debugging, but
	// also exposes customer information.
	CleanupLocalDirectory bool

	// KeepRemoteFiles determines if we delete the remote file on an ODFI's server
	// after downloading and processing of each file.
	KeepRemoteFiles bool

	// RemoveZeroByteFiles determines if we should delete files that are zero bytes
	RemoveZeroByteFiles bool
}

type Output struct {
	Format string
}

type PagerDuty struct {
	ID         string
	ApiKey     string
	From       string
	ServiceKey string
}

type PagerDutyAlerting struct {
	ApiKey string

	// To send an alert event we need to provide the value of
	// the Integration Key (add API integration to service in PD to get it)
	// as RoutingKey
	RoutingKey string
}

type PreUpload struct {
	GPG *GPG
}

type SFTP struct {
	Hostname string
	Username string

	Password         string
	ClientPrivateKey string
	HostPublicKey    string

	DialTimeout           time.Duration
	MaxConnectionsPerFile int
	MaxPacketSize         int

	// SkipDirectoryCreation will configure achgateway to create
	// directories on the remote server prior to uploading files.
	SkipDirectoryCreation bool
}

type Shard struct {
	Name                     string
	Cutoffs                  Cutoffs
	PreUpload                *PreUpload
	UploadAgent              string
	Mergable                 MergableConfig
	OutboundFilenameTemplate string
	Output                   *Output
	Notifications            *Notifications
	Audit                    *AuditTrail
}

type ShardMapping struct {
	ShardKey  string
	ShardName string
}

type Sharding struct {
	Shards   []Shard
	Mappings []ShardMapping
	Default  string
}

type Signer struct {
	KeyFile     string
	KeyPassword string
}

type Slack struct {
	ID string

	WebhookURL string
}

type SlackAlerting struct {
	// Oauth 2.0 access tokens are generated manually when creating a slack app
	// https://api.slack.com/authentication/token-types
	AccessToken string

	// A default channel can be specified when creating a Slack app, and this config
	// can override or be used as the default
	ChannelID string
}

type TLSConfig struct {
	// CertFile points to a filename containing an X.509 certificate chain usable to
	// wrap HTTP connections with TLS.
	CertFile string

	// KeyFile points to a filename containing a matching private key for encrypting
	// and signing TLS connections found in CertFile.
	KeyFile string
}

type UploadAgent struct {
	ID            string
	FTP           *FTP
	SFTP          *SFTP
	Mock          *MockAgent
	Paths         UploadPaths
	Notifications *UploadNotifiers

	// AllowedIPs is a comma separated list of IP addresses and CIDR ranges
	// where connections are allowed. If this value is non-empty remote servers
	// not within these ranges will not be connected to.
	AllowedIPs string
}

type UploadAgents struct {
	Agents         []UploadAgent
	Merging        Merging
	Retry          *UploadRetry
	DefaultAgentID string
}

type UploadNotifiers struct {
	Email     []string
	PagerDuty []string
	Slack     []string
}

type UploadPaths struct {
	Inbound        string
	Outbound       string
	Reconciliation string
	Return         string
}

type UploadRetry struct {
	Interval   time.Duration
	MaxRetries uint64
}

type WebhookConfig struct {
	Endpoint string
}