deeplclient

type ApiFormality string

type ApiLang string

type AuthFailedErr struct {
	*KnownRequestErrData
}

type Client struct {
	*http.Client
	// AuthKey stores the authentication key required to get access DeepL's API.
	AuthKey     []byte
	EndpointUrl string
}

type DocumentTranslationDownloadRequest DocumentTranslationStartResponse

type DocumentTranslationStartRequest struct {
	// SourceLang is the language of the text to be translated. If parameter is omitted, the API will detect the
	// language of the text and translate it.
	SourceLang ApiLang

	// TargetLang determines the language into which you want to translate.
	TargetLang ApiLang

	// File is the file to be translated (only .docx, .pptx, .pdf, .htm(l) and .txt are allowed)
	File []byte

	// Filename describes the name of the file to be translated
	Filename string

	// Formality Sets whether the translated text should lean towards formal or informal language. This feature
	// currently only works for target languages DE (German), FR (French), IT (Italian), ES (Spanish), NL (Dutch),
	// PL (Polish), PT-PT, PT-BR (Portuguese) and RU (Russian).
	Formality ApiFormality

	// GlossaryId A unique ID assigned to a glossary.
	GlossaryId ApiLang
}

type DocumentTranslationStartResponse struct {
	// DocumentId is a unique ID which is being used in subsequent API requests regarding the uploaded document
	DocumentId string `json:"document_id"`

	// DocumentKey is an encryption key which is necessary to decrypt this document on download
	DocumentKey string `json:"document_key"`
}

type DocumentTranslationStatus string

type DocumentTranslationStatusRequest DocumentTranslationStartResponse

type DocumentTranslationStatusResponse struct {
	// DocumentID is the unique ID of the document
	DocumentId string

	// Status defines the current state of the translation process
	Status DocumentTranslationStatus

	// SecondsRemaining describes the estimated time until the translation is done
	SecondsRemaining uint

	// BilledCharacters is the amount of characters billed
	BilledCharacters uint

	// ErrorMessage describes an error during translation, if one occurred (if not the value is nil)
	ErrorMessage *string
}

type KnownRequestErrData struct {
	// Message holds the error message returned by the server.
	Message string `json:"message"`
}

type NotFoundErr struct {
	*KnownRequestErrData
}

type QuotaExceededErr struct {
	*KnownRequestErrData
}

type RequestEntityTooLargeErr struct {
	*KnownRequestErrData
}

type TooManyRequestsErr struct {
	*KnownRequestErrData
}

type TranslationRequest struct {

	// Text to be translated. Only UTF8-encoded plain text is supported. The parameter may be specified multiple times
	// and translations are returned in the same order as in the input. Each of the parameter values may contain
	// multiple sentences.
	Text string
	// SourceLang is the language of the text to be translated. If parameter is omitted, the API will detect the
	// language of the text and translate it.
	SourceLang ApiLang
	// TargetLang determines the language into which you want to translate.
	TargetLang ApiLang
	// TagHandling sets which kind of tags should be handled. Comma-separated list of one or more values. See official
	// DeepL API documentation for more details about tag handling.
	TagHandling []string
	// NonSplittingTags contains a list of XML tags which never split sentences. See official DeepL API documentation
	// for more details about tag handling.
	NonSplittingTags []string
	// IgnoreTags contains a list of XML tags whose content is never translated. See official DeepL API documentation
	// for more details about tag handling.
	IgnoreTags []string
	// DoNotSplitSentences sets whether the translation engine should first split the input into sentences. False by
	// default.
	//
	// For applications which are sending one sentence per text parameter, it is advisable to set this to false, in
	// order to prevent the engine from splitting the sentence unintentionally.
	DoNotSplitSentences bool
	// Sets whether the translation engine should preserve some aspects of the formatting, even if it would usually
	// correct some aspects. False by default.
	//
	// The formatting aspects controlled by the setting include:
	// 	punctuation at the beginning and end of the sentence,
	// 	upper/lower case at the beginning of the sentence.
	PreserveFormatting bool
	// Formality Sets whether the translated text should lean towards formal or informal language. This feature
	// currently only works for target languages DE (German), FR (French), IT (Italian), ES (Spanish), NL (Dutch),
	// PL (Polish), PT-PT, PT-BR (Portuguese) and RU (Russian).
	Formality ApiFormality
	// GlossaryId Specify the glossary to use for the translation. Important: This requires the source_lang parameter to
	// be set and the language pair of the glossary has to match the language pair of the request.
	GlossaryId ApiLang
}

type TranslationResponse struct {
	// Translations contains all requested translations and their results.
	Translations []struct {
		// DetectedSourceLanguage contains the ApiLang detected by the DeepL API.
		DetectedSourceLanguage ApiLang `json:"detected_source_language"`
		// Text contains the translated text.
		Text string `json:"text"`
	} `json:"translations"`
}

type UnwrappedApiResponseCodeErr int

type UsageResponse struct {
	// CharacterCount contains the amount of characters translated so far in the current billing period.
	CharacterCount int64 `json:"character_count"`
	// CharacterLimit contains the maximum volume of characters that can be translated in the current billing period.
	CharacterLimit int64 `json:"character_limit"`
}

type WrongRequestErr struct {
	*KnownRequestErrData
}