@crowdin/crowdin-api-client

import { CrowdinApi, DownloadLink, PaginationOptions, PatchRequest, ResponseList, ResponseObject, Status } from '../core'; /** * Source files are resources for translation. You can keep files structure using folders or manage different versions of the content via branches. * * Use API to keep the source files up to date, check on file revisions, and manage project branches. * Before adding source files to the project, upload each file to the Storage first. */ export declare class SourceFiles extends CrowdinApi { /** * @param projectId project identifier * @param branchId branch identifier * @param cloneId clone branch identifier * @see https://developer.crowdin.com/api/v2/string-based/#operation/api.projects.branches.clones.branch.get */ getClonedBranch(projectId: number, branchId: number, cloneId: string): Promise<ResponseObject<SourceFilesModel.Branch>>; /** * @param projectId project identifier * @param branchId branch identifier * @param request request body * @see https://developer.crowdin.com/api/v2/string-based/#operation/api.projects.branches.clones.post */ clonedBranch(projectId: number, branchId: number, request: SourceFilesModel.CloneBranchRequest): Promise<ResponseObject<Status<object>>>; /** * @param projectId project identifier * @param branchId branch identifier * @param cloneId clone branch identifier * @see https://developer.crowdin.com/api/v2/string-based/#operation/api.projects.branches.clones.get */ checkBranchClonedStatus(projectId: number, branchId: number, cloneId: string): Promise<ResponseObject<Status<object>>>; /** * @param projectId project identifier * @param options optional parameters for the request * @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.getMany */ listProjectBranches(projectId: number, options?: SourceFilesModel.ListProjectBranchesOptions): Promise<ResponseList<SourceFilesModel.Branch>>; /** * @param projectId project identifier * @param name filter branch by name * @param limit maximum number of items to retrieve (default 25) * @param offset starting offset in the collection (default 0) * @deprecated optional parameters should be passed through an object * @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.getMany */ listProjectBranches(projectId: number, name?: string, limit?: number, offset?: number): Promise<ResponseList<SourceFilesModel.Branch>>; /** * @param projectId project identifier * @param request request body * @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.post */ createBranch(projectId: number, request: SourceFilesModel.CreateBranchRequest): Promise<ResponseObject<SourceFilesModel.Branch>>; /** * @param projectId project identifier * @param branchId branch identifier * @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.get */ getBranch(projectId: number, branchId: number): Promise<ResponseObject<SourceFilesModel.Branch>>; /** * @param projectId project identifier * @param branchId branch identifier * @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.delete */ deleteBranch(projectId: number, branchId: number): Promise<void>; /** * @param projectId project identifier * @param branchId branch identifier * @param request request body * @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.patch */ editBranch(projectId: number, branchId: number, request: PatchRequest[]): Promise<ResponseObject<SourceFilesModel.Branch>>; /** * @param projectId project identifier * @param branchId branch identifier * @param request request body * @see https://support.crowdin.com/developer/api/v2/string-based/#tag/Branches/operation/api.projects.branches.merges.post */ mergeBranch(projectId: number, branchId: number, request: SourceFilesModel.MergeBranchRequest): Promise<ResponseObject<Status<SourceFilesModel.MergeBranchAttributes>>>; /** * @param projectId project identifier * @param branchId branch identifier * @param mergeId merge branch identifier * @see https://support.crowdin.com/developer/api/v2/string-based/#tag/Branches/operation/api.projects.branches.merges.get */ checkBranchMergeStatus(projectId: number, branchId: number, mergeId: string): Promise<ResponseObject<Status<SourceFilesModel.MergeBranchAttributes>>>; /** * @param projectId project identifier * @param branchId branch identifier * @param mergeId merge branch identifier * @see https://support.crowdin.com/developer/api/v2/string-based/#tag/Branches/operation/api.projects.branches.merges.summary.get */ getBranchMergeSummary(projectId: number, branchId: number, mergeId: string): Promise<ResponseObject<SourceFilesModel.MergeBranchSummary>>; /** * @param projectId project identifier * @param options optional parameters for the request * @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.getMany */ listProjectDirectories(projectId: number, options?: SourceFilesModel.ListProjectDirectoriesOptions): Promise<ResponseList<SourceFilesModel.Directory>>; /** * @param projectId project identifier * @param branchId filter directories by branchId * @param directoryId filter directories by directoryId * @param limit maximum number of items to retrieve (default 25) * @param offset starting offset in the collection (default 0) * @param filter use to filter directories by name * @param recursion use to list directories recursively (works only when directoryId or branchId parameter is specified) * @deprecated optional parameters should be passed through an object * @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.getMany */ listProjectDirectories(projectId: number, branchId?: number, directoryId?: number, limit?: number, offset?: number, filter?: string, recursion?: string): Promise<ResponseList<SourceFilesModel.Directory>>; /** * @param projectId project identifier * @param request request body * @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.post */ createDirectory(projectId: number, request: SourceFilesModel.CreateDirectoryRequest): Promise<ResponseObject<SourceFilesModel.Directory>>; /** * @param projectId project identifier * @param directoryId directory identifier * @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.get */ getDirectory(projectId: number, directoryId: number): Promise<ResponseObject<SourceFilesModel.Directory>>; /** * @param projectId project identifier * @param directoryId directory identifier * @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.delete */ deleteDirectory(projectId: number, directoryId: number): Promise<void>; /** * @param projectId project identifier * @param directoryId directory identifier * @param request request body * @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.patch */ editDirectory(projectId: number, directoryId: number, request: PatchRequest[]): Promise<ResponseObject<SourceFilesModel.Directory>>; /** * @param projectId project identifier * @param options optional parameters for the request * @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.getMany */ listProjectFiles(projectId: number, options?: SourceFilesModel.ListProjectFilesOptions): Promise<ResponseList<SourceFilesModel.File>>; /** * @param projectId project identifier * @param branchId list branch files (Note! You can either list files for the specified branch (branchId) in the same request) * @param directoryId list directory files (Note! You can either list files for the specified directory (directoryId) in the same request) * @param limit maximum number of items to retrieve (default 25) * @param offset starting offset in the collection (default 0) * @param recursion use to list files recursively * @param filter use to filter files by name * @deprecated optional parameters should be passed through an object * @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.getMany */ listProjectFiles(projectId: number, branchId?: number, directoryId?: number, limit?: number, offset?: number, recursion?: any, filter?: string): Promise<ResponseList<SourceFilesModel.File>>; /** * @param projectId project identifier * @param request request body * @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.post */ createFile(projectId: number, request: SourceFilesModel.CreateFileRequest): Promise<ResponseObject<SourceFilesModel.File>>; /** * @param projectId project identifier * @param fileId file identifier * @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.get */ getFile(projectId: number, fileId: number): Promise<ResponseObject<SourceFilesModel.File>>; /** * @param projectId project identifier * @param fileId file identifier * @param request request body * @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.put */ updateOrRestoreFile(projectId: number, fileId: number, request: SourceFilesModel.ReplaceFileFromStorageRequest | SourceFilesModel.RestoreFile): Promise<ResponseObject<SourceFilesModel.File>>; /** * @param projectId project identifier * @param fileId file identifier * @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.delete */ deleteFile(projectId: number, fileId: number): Promise<void>; /** * @param projectId project identifier * @param fileId file identifier * @param request request body * @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.patch */ editFile(projectId: number, fileId: number, request: PatchRequest[]): Promise<ResponseObject<SourceFilesModel.File>>; /** * @param projectId project identifier * @param fileId file identifier * @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.preview.get */ downloadFilePreview(projectId: number, fileId: number): Promise<ResponseObject<DownloadLink>>; /** * @param projectId project identifier * @param fileId file identifier * @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.download.get */ downloadFile(projectId: number, fileId: number): Promise<ResponseObject<DownloadLink>>; /** * @param projectId project identifier * @param fileId file identifier * @param options optional pagination parameters for the request * @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.revisions.getMany */ listFileRevisions(projectId: number, fileId: number, options?: PaginationOptions): Promise<ResponseList<SourceFilesModel.FileRevision>>; /** * @param projectId project identifier * @param fileId file identifier * @param limit maximum number of items to retrieve (default 25) * @param offset starting offset in the collection (default 0) * @deprecated optional parameters should be passed through an object * @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.revisions.getMany */ listFileRevisions(projectId: number, fileId: number, limit?: number, offset?: number): Promise<ResponseList<SourceFilesModel.FileRevision>>; /** * @param projectId project identifier * @param fileId file identifier * @param revisionId revision identifier * @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.revisions.get */ getFileRevision(projectId: number, fileId: number, revisionId: number): Promise<ResponseObject<SourceFilesModel.FileRevision>>; /** * @param projectId project identifier * @param options optional parameters for the request * @see https://support.crowdin.com/enterprise/api/#operation/api.projects.strings.reviewed-builds.getMany */ listReviewedSourceFilesBuild(projectId: number, options?: SourceFilesModel.ListReviewedSourceFilesBuildOptions): Promise<ResponseList<SourceFilesModel.ReviewedSourceFilesBuild>>; /** * @param projectId project identifier * @param branchId filter builds by branchId * @param limit maximum number of items to retrieve (default 25) * @param offset starting offset in the collection (default 0) * @deprecated optional parameters should be passed through an object * @see https://support.crowdin.com/enterprise/api/#operation/api.projects.strings.reviewed-builds.getMany */ listReviewedSourceFilesBuild(projectId: number, branchId?: number, limit?: number, offset?: number): Promise<ResponseList<SourceFilesModel.ReviewedSourceFilesBuild>>; /** * @param projectId project identifier * @param request request body * @see https://support.crowdin.com/enterprise/api/#operation/api.projects.strings.reviewed-builds.post */ buildReviewedSourceFiles(projectId: number, request?: SourceFilesModel.BuildReviewedSourceFilesRequest): Promise<ResponseObject<SourceFilesModel.ReviewedSourceFilesBuild>>; /** * @param projectId project identifier * @param buildId build identifier * @see https://support.crowdin.com/enterprise/api/#operation/api.projects.strings.reviewed-builds.get */ checkReviewedSourceFilesBuildStatus(projectId: number, buildId: number): Promise<ResponseObject<SourceFilesModel.ReviewedSourceFilesBuild>>; /** * @param projectId project identifier * @param buildId build identifier * @see https://support.crowdin.com/enterprise/api/#operation/api.projects.strings.reviewed-builds.download.download */ downloadReviewedSourceFiles(projectId: number, buildId: number): Promise<ResponseObject<DownloadLink>>; } export declare namespace SourceFilesModel { interface Branch { id: number; projectId: number; name: string; title: string; exportPattern: string; priority: Priority; createdAt: string; updatedAt: string; } interface CreateBranchRequest { name: string; title?: string; exportPattern?: string; priority?: Priority; } interface CloneBranchRequest { name: string; title?: string; } interface MergeBranchRequest { deleteAfterMerge?: boolean; sourceBranchId: number; dryRun?: boolean; } interface MergeBranchAttributes { sourceBranchId: number; deleteAfterMerge: boolean; } interface MergeBranchSummary { status: string; sourceBranchId: number; targetBranchId: number; dryRun: boolean; details: { added: number; deleted: number; updated: number; conflicted: number; }; } type Priority = 'low' | 'normal' | 'high'; interface ListProjectDirectoriesOptions extends PaginationOptions { branchId?: number; directoryId?: number; filter?: string; recursion?: string; orderBy?: string; } interface Directory { id: number; projectId: number; branchId: number; directoryId: number; name: string; title: string; exportPattern: string; path: string; priority: Priority; createdAt: string; updatedAt: string; } interface CreateDirectoryRequest { name: string; branchId?: number; directoryId?: number; title?: string; exportPattern?: string; priority?: Priority; } interface ListProjectFilesOptions extends PaginationOptions { branchId?: number; directoryId?: number; recursion?: any; filter?: string; orderBy?: string; } interface File { id: number; projectId: number; branchId: number; directoryId: number; name: string; title: string; context: string; type: string; path: string; status: string; revisionId: number; priority: Priority; importOptions: ImportOptions; exportOptions: GeneralExportOptions | PropertyExportOptions; excludedTargetLanguages: string[]; parserVersion: number; createdAt: string; updatedAt: string; } interface CreateFileRequest { storageId: number; name: string; branchId?: number; directoryId?: number; title?: string; context?: string; type?: FileType; parserVersion?: number; importOptions?: ImportOptions; exportOptions?: ExportOptions; excludedTargetLanguages?: string[]; attachLabelIds?: number[]; } interface ReplaceFileFromStorageRequest { storageId: number; name?: string; updateOption?: UpdateOption; importOptions?: ImportOptions; exportOptions?: ExportOptions; attachLabelIds?: number[]; detachLabelIds?: number[]; replaceModifiedContext?: boolean; } type ExportOptions = GeneralExportOptions | PropertyExportOptions | JavaScriptExportOptions | MdExportOptions; type ImportOptions = SpreadsheetImportOptions | XmlImportOptions | WebXmlImportOptions | DocxFileImportOptions | HtmlFileImportOptions | HtmlFrontMatterFileImportOptions | MdxFileImportOptions | MdFileImportOptions | StringCatalogFileImportOptions | AdocFileImportOptions | OtherImportOptions; interface RestoreFile { revisionId: number; } interface FileRevision { id: number; projectId: number; fileId: number; restoreToRevision: number; info: FileRevisionInfo; date: string; } interface FileRevisionInfo { added: FileRevisionInfoAttribute; deleted: FileRevisionInfoAttribute; updated: FileRevisionInfoAttribute; } interface FileRevisionInfoAttribute { strings: number; words: number; } type FileType = 'auto' | 'android' | 'macosx' | 'resx' | 'properties' | 'gettext' | 'yaml' | 'php' | 'json' | 'xml' | 'ini' | 'rc' | 'resw' | 'resjson' | 'qtts' | 'joomla' | 'chrome' | 'dtd' | 'dklang' | 'flex' | 'nsh' | 'wxl' | 'xliff' | 'xliff_two' | 'html' | 'haml' | 'txt' | 'csv' | 'md' | 'flsnp' | 'fm_html' | 'fm_md' | 'mediawiki' | 'docx' | 'xlsx' | 'sbv' | 'properties_play' | 'properties_xml' | 'maxthon' | 'go_json' | 'dita' | 'mif' | 'idml' | 'stringsdict' | 'plist' | 'vtt' | 'vdf' | 'srt' | 'stf' | 'toml' | 'contentful_rt' | 'svg' | 'js' | 'coffee' | 'nestjs_i18n' | 'webxml'; interface SpreadsheetImportOptions { firstLineContainsHeader?: boolean; contentSegmentation?: boolean; srxStorageId?: number; importTranslations?: boolean; scheme?: Scheme; } interface Scheme { none: number; identifier: number; sourcePhrase: number; sourceOrTranslation: number; translation: number; context: number; maxLength: number; labels: number; [key: string]: number; } interface XmlImportOptions { translateContent?: boolean; translateAttributes?: boolean; inlineTags?: string[]; contentSegmentation?: boolean; translatableElements?: string[]; srxStorageId?: number; } interface WebXmlImportOptions { inlineTags?: string[]; contentSegmentation?: boolean; srxStorageId?: number; } interface DocxFileImportOptions { cleanTagsAggressively?: boolean; translateHiddenText?: boolean; translateHyperlinkUrls?: boolean; translateHiddenRowsAndColumns?: boolean; importNotes?: boolean; importHiddenSlides?: boolean; contentSegmentation?: boolean; srxStorageId?: number; } interface HtmlFileImportOptions { excludedElements?: string[]; inlineTags?: string[]; contentSegmentation?: boolean; srxStorageId?: number; } interface HtmlFrontMatterFileImportOptions extends HtmlFileImportOptions { excludedFrontMatterElements?: string[]; } interface MdxFileImportOptions { excludedFrontMatterElements?: string[]; excludeCodeBlocks?: boolean; contentSegmentation?: boolean; srxStorageId?: number; } interface MdFileImportOptions { excludedFrontMatterElements?: string[]; excludeCodeBlocks?: boolean; inlineTags?: string[]; contentSegmentation?: boolean; srxStorageId?: number; } interface StringCatalogFileImportOptions { importKeyAsSource?: boolean; } interface AdocFileImportOptions { excludeIncludeDirectives?: boolean; } interface OtherImportOptions { contentSegmentation: boolean; srxStorageId: number; } interface GeneralExportOptions { exportPattern?: string; } interface PropertyExportOptions { escapeQuotes?: EscapeQuotes; exportPattern?: string; escapeSpecialCharacters?: 0 | 1; } interface JavaScriptExportOptions { exportPattern?: string; exportQuotes?: ExportQuotes; } interface MdExportOptions { exportPattern?: string; strongMarker?: 'asterisk' | 'underscore'; emphasisMarker?: 'asterisk' | 'underscore'; unorderedListBullet?: 'asterisks' | 'plus' | 'plus'; tableColumnWidth?: 'consolidate' | 'evenly_distribute_cells'; } enum EscapeQuotes { ZERO = 0, ONE = 1, TWO = 2, THREE = 3 } enum ExportQuotes { SINGLE = "single", DOUBLE = "double" } type UpdateOption = 'clear_translations_and_approvals' | 'keep_translations' | 'keep_translations_and_approvals'; interface ReviewedSourceFilesBuild { id: number; projectId: number; status: string; progress: number; attributes: ReviewedSourceFilesBuildAttributes; } interface ReviewedSourceFilesBuildAttributes { branchId: number; targetLanguageId: string; } interface BuildReviewedSourceFilesRequest { branchId?: number; } interface ListProjectBranchesOptions extends PaginationOptions { name?: string; orderBy?: string; } interface ListReviewedSourceFilesBuildOptions extends PaginationOptions { branchId?: number; } }