phrase

type BlacklistService struct {
	// contains filtered or unexported fields
}

type Client struct {
	BaseURL   *url.URL
	UserAgent string

	// Authentication token that is required for all API requests.
	// It can either be the the project authentication token, or
	// in the case of signed requests, the user authentication token,
	// in which case the ProjectAuthToken should contain the project
	// authentication token.
	AuthToken string

	// Project authentication token which is only required when AuthToken
	// contains the user auth token which is required in signed requests.
	ProjectAuthToken string

	// Services used for talking to different parts of the PhraseApp API.
	Sessions     *SessionsService
	Projects     *ProjectsService
	Locales      *LocalesService
	Keys         *KeysService
	Blacklist    *BlacklistService
	Tags         *TagsService
	Translations *TranslationsService
	FileImports  *FileImportsService
	Orders       *OrdersService
	// contains filtered or unexported fields
}

type DownloadRequest struct {
	// Name of the locale that should be downloaded. This field is mandatory.
	Locale string `url:"locale"`

	// Name of the format that should be downloaded. This field is mandatory.
	// http://docs.phraseapp.com/guides/formats/
	Format string `url:"format"`

	// Encoding of the downloaded file
	Encoding string `url:"encoding,omitempty"`

	// Date since the last update. Only return translations that were modified after the given date.
	UpdatedSince time.Time `url:"updated_since,omitempty"`
	Tag          string    `url:"tag,omitempty"`

	// Include empty translations in the result as well.
	IncludeEmptyTranslations bool `url:"include_empty_translations,int,omitempty"`

	// Do not remove NOTRANSLATE tags in the downloaded translations.
	KeepNotranslateTags bool `url:"keep_notranslate_tags,int,omitempty"`

	// Enable Emoji conversion.
	ConvertEmoji bool `url:"convert_emoji,int,omitempty"`

	// Skip unverified translations from appearing in the downloaded file.
	SkipUnverifiedTranslations bool `url:"skip_unverified_translations,int,omitempty"`
}

type ErrorResponse struct {
	*http.Response

	ErrorRaw    json.RawMessage `json:"error"`
	MessagesRaw json.RawMessage `json:"messages"`

	// Message represents the error message.
	Message string `json:"-"`

	// ValidationError represents validation errors pertaining to the request, containing a map of field to error message.
	ValidationError errorMap `json:"-"`
}

type FileImportRequest struct {
	Locale   string `url:"file_import[locale_code]"`
	Filename string `url:"file_import[filename],omitempty"`

	// http://docs.phraseapp.com/guides/formats/
	Format string   `url:"file_import[format],omitempty"`
	Tags   []string `url:"file_import[tag_names],comma,omitempty"`

	// Force the update of all translations with the file content.
	UpdateTranslations bool `url:"file_import[update_translations],int,omitempty"`

	// Do not initiate verification process for existing translations when updating translations.
	SkipUnverification bool `url:"file_import[skip_unverification],int,omitempty"`

	// Prevent creating an upload tag automatically.
	SkipUploadTags bool `url:"file_import[skip_upload_tags],int,omitempty"`

	// Enable Emoji conversion.
	ConvertEmoji bool `url:"file_import[convert_emoji],int,omitempty"`

	// Some formats can have additional options. Please check the format guide for more information about available options.
	FormatOptions formatOptions `url:"file_import[format_options],omitempty"`
}

type FileImportsService struct {
	// contains filtered or unexported fields
}

type Key struct {
	ID int `json:"id" url:",omitempty"`

	// Name of the key. This is the only required field.
	Name string `json:"name" url:"translation_key[name]"`

	// Plural name of the key, e.g. for use in Gettext format.
	NamePlural  string `json:"name_plural" url:"translation_key[name_plural],omitempty"`
	Description string `json:"description" url:"translation_key[description]"`
	Pluralized  bool   `json:"pluralized" url:"translation_key[pluralized],int,omitempty"`

	// Data type of the key. The values can be string, number, boolean, or array
	DataType string   `json:"data_type" url:"translation_key[data_type],omitempty"`
	Tags     []string `json:"tag_list" url:"translation_key[tag_names],comma"`

	// Mark key as unformatted.
	Unformatted bool `json:"unformatted" url:"translation_key[unformatted],int,omitempty"`

	// Mark xml:space="preserve" as true, i.e. for Android XML format.
	MaxCharacters int `json:"max_characters_allowed" url:"translation_key[max_characters_allowed]"`

	// Max. number of characters for this key, default is 0 (unlimited).
	XMLSpacePreserve bool `json:"xml_space_preserve" url:"translation_key[xml_space_preserve],int,omitempty"`
}

type KeyTranslation struct {
	String string
	Map    map[string]string
}

type KeysService struct {
	// contains filtered or unexported fields
}

type Locale struct {
	ID             int                          `json:"id"`
	Name           string                       `json:"name"`
	Code           string                       `json:"code"`
	CountryCode    string                       `json:"country_code"`
	Direction      string                       `json:"writing_direction"`
	Default        bool                         `json:"is_default"`
	Pluralizations map[string]map[string]string `json:"pluralizations"`
}

type LocaleProgress struct {
	Locale   Locale   `json:"locale"`
	Progress Progress `json:"progress"`
}

type LocalesService struct {
	// contains filtered or unexported fields
}

type Order struct {
	AmountInCents int `json:"amount_in_cents" url:"-"`

	// Name of the LSP you want to use for this order (can be "gengo" or "textmaster").
	LSP      string `json:"lsp" url:"lsp"`
	Code     string `json:"code" url:"-"`
	Currency string `json:"currency" url:"-"`

	// Give an optional message to be delivered to the translators.
	Message string `json:"message" url:"message,omitempty"`
	State   string `json:"state" url:"-"`

	// Quality level of the translations. Can be "standard" or "pro" for Gengo orders and "regular" or "premium" for TextMaster orders.
	TranslationType string `json:"translation_type" url:"translation_type"`
	ProgressPercent int    `json:"progress_percent" url:"-"`

	// Name of the source locale. This locale must already exist in your project. This usually is your default locale.
	SourceLocaleName string `json:"source_locale_name" url:"source_locale_name"`
	SourceLocaleCode string `json:"source_locale_code" url:"-"`

	// Name of the locale to translate your content into. This locale must already exist in your project.
	TargetLocaleNames []string `json:"target_locale_names" url:"target_locale_name[]"`
	TargetLocaleCodes []string `json:"target_locale_codes" url:"-"`

	// Name of a tag to limit the translations to. If none given, it is assumed that all existing keys should be translated.
	Tag           string `json:"tag_name" url:"tag_name,omitempty"`
	StyleguideURL string `json:"styleguide_url" url:"-"`
	Styleguide    string `json:"styleguide" url:"-"`

	// Identification code of the style guide to attach with this order.
	StyleguideCode string `json:"styleguide_code" url:"styleguide_code,omitempty"`

	// Enable unverifying translations upon delivery.
	UnverifyTranslationsUponDelivery bool `json:"unverify_translations_upon_delivery" url:"unverify_translations_upon_delivery,int,omitempty"`

	// Use this option to order translations for keys with unverified content in the selected target locales.
	IncludeUnverifiedTranslations bool `json:"include_unverified_translations" url:"include_unverified_translations,int,omitempty"`

	// Use this option to order translations for keys with untranslated content in the selected target locales.
	IncludeUntranslatedKeys bool `json:"include_untranslated_keys" url:"include_untranslated_keys,int,omitempty"`

	// Translations will be proofread by TextMaster to ensure consistency in vocabulary and style. Will cause additional costs! Only available for TextMaster!
	Quality bool `json:"quality" url:"quality,int,omitempty"`

	// Your project will be assigned a higher priority status, which decreases turnaround time by 30%. Will cause additional costs! Only available for TextMaster!
	Priority bool `json:"priority" url:"priority,int,omitempty"`

	// TextMaster provides you with an expert in the selected category. Will cause additional costs! Only available for TextMaster!
	Expertise bool `json:"expertise" url:"expertise,int,omitempty"`

	// Category ID to use (only required for orders through TextMaster).
	// http://docs.phraseapp.com/api/v1/translation_orders/#categories
	Category int `json:"category" url:"category,omitempty"`
}

type OrdersService struct {
	// contains filtered or unexported fields
}

type Progress struct {
	TranslationsCount int `json:"translations_count"`
	TranslatedCount   int `json:"translated_count"`
	UnverifiedCount   int `json:"unverified_count"`
	UntranslatedCount int `json:"untranslated_count"`
}

type Project struct {
	ID   int    `json:"id"`
	Name string `json:"name"`
	Slug string `json:"slug"`
}

type ProjectsService struct {
	// contains filtered or unexported fields
}

type RateLimit struct {
	// Number of max requests allowed in the current time period.
	Limit int

	// Number of remaining requests in the current time period.
	Remaining int

	// Timestamp of end of current time period as UNIX timestamp.
	Reset time.Time
}

type SessionsService struct {
	// contains filtered or unexported fields
}

type Tag struct {
	ID   int    `json:"id"`
	Name string `json:"name"`
}

type TagProgress struct {
	Tag      Tag                       `json:"tag"`
	Progress map[string]LocaleProgress `json:"progress"`
}

type TagsService struct {
	// contains filtered or unexported fields
}

type Translation struct {
	ID      int    `json:"id" url:"-"`
	Content string `json:"content" url:"content"`

	// A plural suffix (only required when the key is pluralized).
	PluralSuffix string   `json:"plural_suffix" url:"plural_suffix"`
	Placeholders []string `json:"placeholders" url:"-"`
	Unverified   bool     `json:"unverified" url:"-"`

	// Whether the translation should be excluded from file downloads.
	ExcludedFromExport bool `json:"excluded_from_export" url:"excluded_from_export,int,omitempty"`
	Key                Key  `json:"translation_key" url:"-"`
}

type TranslationsService struct {
	// contains filtered or unexported fields
}

type UploadRequest struct {
	Filename           string   `url:"filename"`
	FileContent        string   `url:"file_content"`
	Tags               []string `url:"tags[],omitempty"`
	Locale             string   `url:"locale_name,omitempty"`
	Format             string   `url:"file_format,omitempty"`
	UpdateTranslations bool     `url:"update_translations,int,omitempty"`
	SkipUnverification bool     `url:"skip_unverification,int,omitempty"`
	SkipUploadTags     bool     `url:"skip_upload_tags,int,omitempty"`
	ConvertEmoji       bool     `url:"convert_emoji,int,omitempty"`
}

type User struct {
	ID       int    `json:"id"`
	Username string `json:"username"`
	Email    string `json:"email"`
	Name     string `json:"name"`
	Role     string `json:"role_name"`
}