Module crowdin_api.api_resources.projects.types

Classes

class AiPreTranslate (*args, **kwargs)

Crowdin only.

Ancestors

• builtins.dict

Class variables

var aiPrompts : Iterable[AiPreTranslatePromptSettings]

var enabled : bool

class AiPreTranslatePromptSettings (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var aiPromptId : int

var languageIds : Iterable[str]

class AndroidStringsExporterSettings (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var convertLineBreaks : bool

var convertPlaceholders : bool

var useCdataForStringsWithTags : bool

class DocxFileFormatSettings (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var addLineSeparatorAsCharacter : bool

var addTabAsCharacter : bool

var allowWordStyleOptimization : bool

var cleanTagsAggressively : bool

var complexFieldDefinitionsToExtract : Iterable[str]

var contentSegmentation : bool

var excelExcludedColors : Iterable[str]

var excludeWordStyles : Iterable[str]

var exportPattern : str

var ignoreSoftHyphenTag : bool

var ignoreWhitespaceStyles : bool

var ignoreWordFontColors : bool

var importHiddenSlides : bool

var importNotes : bool

var lineSeparatorReplacement : str

var replaceNoBreakHyphenTag : bool

var srxStorageId : int

var translateComments : bool

var translateDocProperties : bool

var translateExcelCellsCopied : bool

var translateExcelDiagramData : bool

var translateExcelDrawings : bool

var translateExcelExcludeColors : bool

var translateExcelSheetNames : bool

var translateHiddenRowsAndColumns : bool

var translateHiddenText : bool

var translateHyperlinkUrls : bool

var translateWordExcludeColors : bool

var translateWordGraphicDescription : bool

var translateWordGraphicName : bool

var translateWordHeadersFooters : bool

var translateWordInExcludeHighlightMode : bool

var translateWordInExcludeStyleMode : bool

var wordExcludedColors : Iterable[str]

var wordFontColorsMaxIgnoranceThreshold : str

var wordFontColorsMinIgnoranceThreshold : str

var wordHighlightColors : Iterable[str]

class JavaScriptFileFormatSettings (*args, **kwargs)

JavaScript file format settings.

Values available for exportQuotes: "single", "double".

Ancestors

• builtins.dict

Class variables

var exportPattern : str

var exportQuotes : str

class JsonFileFormatSettings (*args, **kwargs)

Json file format settings.

Values available for type: "i18next_json", "nestjs_i18n".

Ancestors

• builtins.dict

Class variables

var contentSegmentation : bool

var exportPattern : str

var srxStorageId : int

var type : str

class MacOSXStringsExporterSettings (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var convertLineBreaks : bool

var convertPlaceholders : bool

var exportContext : bool

class MdFileFormatSettings (*args, **kwargs)

Markdown file format settings.

Values available: - strongMarker, emphasisMarker: "asterisk", "underscore" - unorderedListBullet: "asterisks", "plus", "dash" - tableColumnWidth: "consolidate", "evenly_distribute_cells" - frontMatterQuotes: "auto", "single", "double"

Ancestors

• builtins.dict

Class variables

var contentSegmentation : bool

var emphasisMarker : str

var exportPattern : str

var frontMatterQuotes : str

var inlineTags : Iterable[str]

var srxStorageId : int

var strongMarker : str

var tableColumnWidth : str

var unorderedListBullet : str

class MdxFileFormatSettings (*args, **kwargs)

Mdx v1 / Mdx v2 file format settings.

Values available: - type (Mdx v1 only): "mdx_v1", "mdx_v2" - strongMarker, emphasisMarker: "asterisk", "underscore" - unorderedListBullet: "asterisks", "plus", "dash" - tableColumnWidth: "consolidate", "evenly_distribute_cells"

Ancestors

• builtins.dict

Class variables

var contentSegmentation : bool

var emphasisMarker : str

var excludeCodeBlocks : bool

var excludedFrontMatterElements : Iterable[str]

var exportPattern : str

var srxStorageId : int

var strongMarker : str

var tableColumnWidth : str

var type : str

var unorderedListBullet : str

class MediaWikiFileFormatSettings (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var exportPattern : str

var srxStorageId : int

class MtPreTranslate (*args, **kwargs)

Crowdin only.

Ancestors

• builtins.dict

Class variables

var enabled : bool

var mts : Iterable[MtPreTranslateEngineSettings]

class MtPreTranslateEngineSettings (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var languageIds : Iterable[str]

var mtId : int

class NotificationSettings (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var managerLanguageCompleted : bool

var managerNewStrings : bool

var translatorNewStrings : bool

class OtherFileFormatSettings (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var exportPattern : str

class ProjectFilePatchRequest (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var op : PatchOperation

var path : ProjectFilePatchPath

var value : Union[str, List[str], Dict[str, Any]]

class ProjectPatchRequest (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var op : PatchOperation

var path : ProjectPatchPath

var value : Any

class PropertyFileFormatSettings (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var escapeQuotes : EscapeQuotes

var escapeSpecialCharacters : EscapeSpecialCharacters

var exportPattern : str

class QACheckCategories (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var ai : bool

var android : bool

var duplicate : bool

var empty : bool

var ftl : bool

var icu : bool

var mdx : bool

var numbers : bool

var outdated : bool

var punctuation : bool

var size : bool

var spaces : bool

var specialSymbols : bool

var spellcheck : bool

var symbolRegister : bool

var tags : bool

var terms : bool

var unifiedPlaceholders : bool

var variables : bool

var wrongTranslation : bool

class QAChecksIgnorableCategories (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var ai : bool

var android : bool

var duplicate : bool

var empty : bool

var ftl : bool

var icu : bool

var mdx : bool

var numbers : bool

var outdated : bool

var punctuation : bool

var size : bool

var spaces : bool

var specialSymbols : bool

var spellcheck : bool

var symbolRegister : bool

var tags : bool

var terms : bool

var unifiedPlaceholders : bool

var variables : bool

var wrongTranslation : bool

class SpecificFileFormatSettings (*args, **kwargs)

Includes kind standard file format settings: - WebXml file (inlineTags) - Html file (inlineTags, excludedElements) - Adoc file (excludeIncludeDirectives) - Android file - FmMd file - FmHtml file (inlineTags, excludedElements, excludedFrontMatterElements) - MadcapFlsnp file - Idml file (inlineHyperlinkText) - Mif file - Dita file - Arb file - Fjs file - MacOSX file - Chrome file - CSV file - XLSX file - Xliff file - Xliff 2.0 file - React intl file

Ancestors

• builtins.dict

Class variables

var contentSegmentation : bool

var excludeIncludeDirectives : bool

var excludedElements : Iterable[str]

var excludedFrontMatterElements : Iterable[str]

var exportPattern : str

var inlineHyperlinkText : bool

var inlineTags : Iterable[str]

var srxStorageId : int

class StringCatalogFileFormatSettings (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var exportPattern : str

var importKeyAsSource : bool

var importTranslations : bool

class StringsExporterSettingsPatchRequest (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var op : PatchOperation

var path : StringsExporterSettingsPatchPath

var value : Any

class TmPreTranslate (*args, **kwargs)

Crowdin only.

Ancestors

• builtins.dict

Class variables

var autoApproveOption : TmPreTranslateAutoApproveOption

var enabled : bool

var minimumMatchRatio : TmPreTranslateMinimumMatchRatio

class TxtFileFormatSettings (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var exportPattern : str

var srxStorageId : int

class VdfFileFormatSettings (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var addGenderArgument : bool

var convertIcu : bool

var exportPattern : str

class WorkflowStepConfig (*args, **kwargs)

Keys are Language Identifiers, values are User (assignees) or Team (assignedTeams) Identifiers.

Ancestors

• builtins.dict

Class variables

var assignedTeams : Dict[str, Iterable[int]]

var assignees : Dict[str, Iterable[int]]

class WorkflowStepSettings (*args, **kwargs)

Crowdin Enterprise only. Workflow Template Step configuration.

Use config for Translation and Proofreading steps, vendorId for vendor steps, mtId for machine translation steps and promptId for AI steps.

Ancestors

• builtins.dict

Class variables

var config : WorkflowStepConfig

var id : int

var languages : Iterable[str]

var mtId : int

var promptId : int

var vendorId : int

class XliffStringsExporterSettings (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var copySourceToEmptyTarget : bool

var exportTranslatorsComment : bool

var languagePairMapping : Dict[str, str]

class XmlFileFormatSettings (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Ancestors

• builtins.dict

Class variables

var contentSegmentation : bool

var exportPattern : str

var inlineTags : Iterable[str]

var srxStorageId : int

var translatableElements : Iterable[str]

var translateAttributes : bool

var translateContent : bool