smartling

type APIClient interface {
	Authenticate() error
	DeleteFile(projectID string, uri string) error
	DownloadFile(projectID string, uri string) (io.Reader, error)
	DownloadTranslation(projectID string, localeID string, request FileDownloadRequest) (io.Reader, error)
	GetFileStatus(projectID string, fileURI string) (*smfile.FileStatus, error)
	GetProjectDetails(projectID string) (*ProjectDetails, error)
	Import(projectID string, localeID string, request smfile.ImportRequest) (*FileImportResult, error)
	ListAllFiles(projectID string, request smfile.FilesListRequest) ([]smfile.File, error)
	ListProjects(accountID string, request smfile.ProjectsListRequest) (*ProjectsList, error)
	RenameFile(projectID string, oldURI string, newURI string) error
}

type FileDownloadRequest struct {
	smfile.FileURIRequest

	Type            RetrievalType
	IncludeOriginal bool
}

type FileImportResult struct {
	WordCount               int
	StringCount             int
	TranslationImportErrors []string
}

type FilesList struct {
	// TotalCount is a total files count.
	TotalCount int

	// Items contains all files matched by request.
	Items []smfile.File
}

type HttpAPIClient struct {
	Client *smclient.Client
}

type Locale struct {
	// LocaleID is a unique locale ID.
	LocaleID string

	// Description describes locale.
	Description string

	// Enabled is a flag that represents is locale enabled or not.
	Enabled bool
}

type Project struct {
	// ProjectID is a unique project ID.
	ProjectID string

	// ProjectName is a human-friendly project name.
	ProjectName string

	// AccountUID is undocumented by Smartling API.
	AccountUID string

	// SourceLocaleID represents source locale ID for project.
	SourceLocaleID string

	// SourceLocaleDescription describes project's locale.
	SourceLocaleDescription string

	// Archived will be true if project is archived.
	Archived bool
}

type ProjectDetails struct {
	Project

	// TargetLocales represents target locales list.
	TargetLocales []Locale
}

type ProjectsList struct {
	// TotalCount represents total count of projects.
	TotalCount int64

	// Items contains projects list by specified request.
	Items []Project
}

type RetrievalType string