api

type API interface {
	CodesGetter
	CodeGetter
	LanguagesGetter
	LanguageGetter
	ProjectsGetter
	ProjectGetter
	NamespacesGetter
	NamespaceGetter
	BatchesGetter
	BatchGetter
	BatchHeader
	BatchReader
	BatchDownloader
	SnapshotsGetter
	SnapshotGetter
	SnapshotHeader
	SnapshotDownloader
	SnapshotReader
	AllReader
	AccessTokenSetter
	ArticlesGetter
	ArticlesStreamer
	ThingsGetter
}

type AccessTokenSetter interface {
	SetAccessToken(tkn string)
}

type AllReader interface {
	ReadAll(ctx context.Context, rdr io.Reader, cbk ReadCallback) error
}

type ArticlesGetter interface {
	GetArticles(ctx context.Context, nme string, req *Request) ([]*schema.Article, error)
}

type ArticlesStreamer interface {
	StreamArticles(ctx context.Context, req *Request, cbk ReadCallback) error
}

type BatchDownloader interface {
	DownloadBatch(ctx context.Context, dte *time.Time, idr string, wsk io.WriteSeeker) error
}

type BatchGetter interface {
	GetBatch(ctx context.Context, dte *time.Time, idr string, req *Request) (*schema.Batch, error)
}

type BatchHeader interface {
	HeadBatch(ctx context.Context, dte *time.Time, idr string) (*schema.Headers, error)
}

type BatchReader interface {
	ReadBatch(ctx context.Context, dte *time.Time, idr string, cbk ReadCallback) error
}

type BatchesGetter interface {
	GetBatches(ctx context.Context, dte *time.Time, req *Request) ([]*schema.Batch, error)
}

type Client struct {
	HTTPClient           *http.Client // HTTP client used to send requests.
	UserAgent            string       // User-agent header value sent with each request.
	BaseUrl              string       // Base URL for all API requests.
	RealtimeURL          string       // Streaming URL endpoint for streaming.
	AccessToken          string       // Access token used to authenticate requests.
	DownloadMinChunkSize int          // Minimum chunk size used for downloading resources.
	DownloadChunkSize    int          // Chunk size used for downloading resources.
	DownloadConcurrency  int          // Number of simultaneous downloads allowed.
}

type CodeGetter interface {
	GetCode(ctx context.Context, idr string, req *Request) (*schema.Code, error)
}

type CodesGetter interface {
	GetCodes(ctx context.Context, req *Request) ([]*schema.Code, error)
}

type Filter struct {
	// Field specifies the field in the dataset that the filter should be applied to.
	Field string `json:"field"`

	// Value specifies the value that the field should be compared to.
	Value interface{} `json:"value"`
}

type LanguageGetter interface {
	GetLanguage(ctx context.Context, idr string, req *Request) (*schema.Language, error)
}

type LanguagesGetter interface {
	GetLanguages(ctx context.Context, req *Request) ([]*schema.Language, error)
}

type NamespaceGetter interface {
	GetNamespace(ctx context.Context, idr int, req *Request) (*schema.Namespace, error)
}

type NamespacesGetter interface {
	GetNamespaces(ctx context.Context, req *Request) ([]*schema.Namespace, error)
}

type ProjectGetter interface {
	GetProject(ctx context.Context, idr string, req *Request) (*schema.Project, error)
}

type ProjectsGetter interface {
	GetProjects(ctx context.Context, req *Request) ([]*schema.Project, error)
}

type ReadCallback func(art *schema.Article) error

type Request struct {
	// Since is a parameter used only for streaming endpoints.
	// Will pick up the reading of stream from this timestamp.
	// For the articles endpoint it will be restricted to 48h.
	Since *time.Time `json:"since,omitempty"`

	// Fields represents a list of fields to retrieve from the API.
	// This is an optional argument.
	Fields []string `json:"fields,omitempty"`

	// Filters represents a list of filters to apply to the response.
	// This is an optional argument.
	Filters []*Filter `json:"filters,omitempty"`

	// Limits the amount of results from the API (for now works only with Articles API).
	// This is an optional argument.
	Limit int `json:"limit,omitempty"`
}

type SnapshotDownloader interface {
	DownloadSnapshot(ctx context.Context, idr string, wsk io.WriteSeeker) error
}

type SnapshotGetter interface {
	GetSnapshot(ctx context.Context, idr string, req *Request) (*schema.Snapshot, error)
}

type SnapshotHeader interface {
	HeadSnapshot(ctx context.Context, idr string) (*schema.Headers, error)
}

type SnapshotReader interface {
	ReadSnapshot(ctx context.Context, idr string, cbk ReadCallback) error
}

type SnapshotsGetter interface {
	GetSnapshots(ctx context.Context, req *Request) ([]*schema.Snapshot, error)
}

type ThingsGetter interface {
	GetThings(ctx context.Context, nme string, req *Request) ([]*schema.Thing, error)
}