Class SourceFiles

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.

Hierarchy (view full)

CrowdinApi
- SourceFiles

Constructors

constructor

new SourceFiles(credentials, config?): SourceFiles
Parameters
- credentials: Credentials
  credentials
- Optionalconfig: ClientConfig
  optional configuration of the client
Returns SourceFiles
Inherited from CrowdinApi.constructor
- Defined in core/index.ts:232

Methods

addAssetReference

addAssetReference(projectId, fileId, request): Promise<ResponseObject<AssetReference>>
Parameters
- projectId: number
  project identifier
- fileId: number
  file identifier
- request: AssetReferenceRequest
  request body
Returns Promise<ResponseObject<AssetReference>>
See
https://support.crowdin.com/developer/api/v2/#tag/Source-Files/operation/api.projects.files.references.post
- Defined in sourceFiles/index.ts:477

buildReviewedSourceFiles

buildReviewedSourceFiles(projectId, request?): Promise<ResponseObject<ReviewedSourceFilesBuild>>
Parameters
- projectId: number
  project identifier
- request: BuildReviewedSourceFilesRequest = {}
  request body
Returns Promise<ResponseObject<ReviewedSourceFilesBuild>>
See
https://support.crowdin.com/enterprise/api/#operation/api.projects.strings.reviewed-builds.post
- Defined in sourceFiles/index.ts:592

checkBranchClonedStatus

checkBranchClonedStatus(projectId, branchId, cloneId): Promise<ResponseObject<Status<object>>>
Parameters
- projectId: number
  project identifier
- branchId: number
  branch identifier
- cloneId: string
  clone branch identifier
Returns Promise<ResponseObject<Status<object>>>
See
https://developer.crowdin.com/api/v2/string-based/#operation/api.projects.branches.clones.get
- Defined in sourceFiles/index.ts:56

checkBranchMergeStatus

checkBranchMergeStatus(projectId, branchId, mergeId): Promise<ResponseObject<Status<MergeBranchAttributes>>>
Parameters
- projectId: number
  project identifier
- branchId: number
  branch identifier
- mergeId: string
  merge branch identifier
Returns Promise<ResponseObject<Status<MergeBranchAttributes>>>
See
https://support.crowdin.com/developer/api/v2/string-based/#tag/Branches/operation/api.projects.branches.merges.get
- Defined in sourceFiles/index.ts:172

checkReviewedSourceFilesBuildStatus

checkReviewedSourceFilesBuildStatus(projectId, buildId): Promise<ResponseObject<ReviewedSourceFilesBuild>>
Parameters
- projectId: number
  project identifier
- buildId: number
  build identifier
Returns Promise<ResponseObject<ReviewedSourceFilesBuild>>
See
https://support.crowdin.com/enterprise/api/#operation/api.projects.strings.reviewed-builds.get
- Defined in sourceFiles/index.ts:605

clonedBranch

clonedBranch(projectId, branchId, request): Promise<ResponseObject<Status<object>>>
Parameters
- projectId: number
  project identifier
- branchId: number
  branch identifier
- request: CloneBranchRequest
  request body
Returns Promise<ResponseObject<Status<object>>>
See
https://developer.crowdin.com/api/v2/string-based/#operation/api.projects.branches.clones.post
- Defined in sourceFiles/index.ts:41

createBranch

createBranch(projectId, request): Promise<ResponseObject<Branch>>
Parameters
- projectId: number
  project identifier
- request: CreateBranchRequest
  request body
Returns Promise<ResponseObject<Branch>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.branches.post
- Defined in sourceFiles/index.ts:108

createDirectory

createDirectory(projectId, request): Promise<ResponseObject<Directory>>
Parameters
- projectId: number
  project identifier
- request: CreateDirectoryRequest
  request body
Returns Promise<ResponseObject<Directory>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.directories.post
- Defined in sourceFiles/index.ts:258

createFile

createFile(projectId, request): Promise<ResponseObject<File>>
Parameters
- projectId: number
  project identifier
- request: CreateFileRequest
  request body
Returns Promise<ResponseObject<File>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.files.post
- Defined in sourceFiles/index.ts:363

deleteAssetReference

deleteAssetReference(projectId, fileId, referenceId): Promise<void>
Parameters
- projectId: number
  project identifier
- fileId: number
  file identifier
- referenceId: number
  reference identifier
Returns Promise<void>
See
https://support.crowdin.com/developer/api/v2/#tag/Source-Files/operation/api.projects.files.references.delete
- Defined in sourceFiles/index.ts:492

deleteBranch

deleteBranch(projectId, branchId): Promise<void>
Parameters
- projectId: number
  project identifier
- branchId: number
  branch identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.branches.delete
- Defined in sourceFiles/index.ts:131

deleteDirectory

deleteDirectory(projectId, directoryId): Promise<void>
Parameters
- projectId: number
  project identifier
- directoryId: number
  directory identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.directories.delete
- Defined in sourceFiles/index.ts:281

deleteFile

deleteFile(projectId, fileId): Promise<void>
Parameters
- projectId: number
  project identifier
- fileId: number
  file identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.files.delete
- Defined in sourceFiles/index.ts:401

downloadFile

downloadFile(projectId, fileId): Promise<ResponseObject<DownloadLink>>
Parameters
- projectId: number
  project identifier
- fileId: number
  file identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.files.download.get
- Defined in sourceFiles/index.ts:436

downloadFilePreview

downloadFilePreview(projectId, fileId): Promise<ResponseObject<DownloadLink>>
Parameters
- projectId: number
  project identifier
- fileId: number
  file identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.files.preview.get
- Defined in sourceFiles/index.ts:426

downloadReviewedSourceFiles

downloadReviewedSourceFiles(projectId, buildId): Promise<ResponseObject<DownloadLink>>
Parameters
- projectId: number
  project identifier
- buildId: number
  build identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://support.crowdin.com/enterprise/api/#operation/api.projects.strings.reviewed-builds.download.download
- Defined in sourceFiles/index.ts:618

editBranch

editBranch(projectId, branchId, request): Promise<ResponseObject<Branch>>
Parameters
- projectId: number
  project identifier
- branchId: number
  branch identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Branch>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.branches.patch
- Defined in sourceFiles/index.ts:142

editDirectory

editDirectory(projectId, directoryId, request): Promise<ResponseObject<Directory>>
Parameters
- projectId: number
  project identifier
- directoryId: number
  directory identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Directory>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.directories.patch
- Defined in sourceFiles/index.ts:292

editFile

editFile(projectId, fileId, request): Promise<ResponseObject<File>>
Parameters
- projectId: number
  project identifier
- fileId: number
  file identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<File>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.files.patch
- Defined in sourceFiles/index.ts:412

getAssetReference

getAssetReference(projectId, fileId, referenceId): Promise<ResponseObject<AssetReference>>
Parameters
- projectId: number
  project identifier
- fileId: number
  file identifier
- referenceId: number
  reference identifier
Returns Promise<ResponseObject<AssetReference>>
See
https://support.crowdin.com/developer/api/v2/#tag/Source-Files/operation/api.projects.files.references.get
- Defined in sourceFiles/index.ts:462

getBranch

getBranch(projectId, branchId): Promise<ResponseObject<Branch>>
Parameters
- projectId: number
  project identifier
- branchId: number
  branch identifier
Returns Promise<ResponseObject<Branch>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.branches.get
- Defined in sourceFiles/index.ts:121

getBranchMergeSummary

getBranchMergeSummary(projectId, branchId, mergeId): Promise<ResponseObject<MergeBranchSummary>>
Parameters
- projectId: number
  project identifier
- branchId: number
  branch identifier
- mergeId: string
  merge branch identifier
Returns Promise<ResponseObject<MergeBranchSummary>>
See
https://support.crowdin.com/developer/api/v2/string-based/#tag/Branches/operation/api.projects.branches.merges.summary.get
- Defined in sourceFiles/index.ts:187

getClonedBranch

getClonedBranch(projectId, branchId, cloneId): Promise<ResponseObject<Branch>>
Parameters
- projectId: number
  project identifier
- branchId: number
  branch identifier
- cloneId: string
  clone branch identifier
Returns Promise<ResponseObject<Branch>>
See
https://developer.crowdin.com/api/v2/string-based/#operation/api.projects.branches.clones.branch.get
- Defined in sourceFiles/index.ts:26

getDirectory

getDirectory(projectId, directoryId): Promise<ResponseObject<Directory>>
Parameters
- projectId: number
  project identifier
- directoryId: number
  directory identifier
Returns Promise<ResponseObject<Directory>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.directories.get
- Defined in sourceFiles/index.ts:271

getFile

getFile(projectId, fileId): Promise<ResponseObject<File>>
Parameters
- projectId: number
  project identifier
- fileId: number
  file identifier
Returns Promise<ResponseObject<File>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.files.get
- Defined in sourceFiles/index.ts:376

getFileRevision

getFileRevision(projectId, fileId, revisionId): Promise<ResponseObject<FileRevision>>
Parameters
- projectId: number
  project identifier
- fileId: number
  file identifier
- revisionId: number
  revision identifier
Returns Promise<ResponseObject<FileRevision>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.files.revisions.get
- Defined in sourceFiles/index.ts:541

graphql

graphql<T>(req, config?): Promise<ResponseObject<T>>
Type Parameters
- T
Parameters
- req: {
      operationName?: string;
      query: string;
      variables?: any;
  }
  - OptionaloperationName?: string
  - query: string
  - Optionalvariables?: any
- config: {
  url?: string;
  } = {}
  - Optionalurl?: string
Returns Promise<ResponseObject<T>>
Inherited from CrowdinApi.graphql
- Defined in core/index.ts:266

listAssetReferences

listAssetReferences(projectId, fileId, options?): Promise<ResponseList<AssetReference>>
Parameters
- projectId: number
  project identifier
- fileId: number
  file identifier
- Optionaloptions: Partial<Pagination>
  optional pagination parameters for the request
Returns Promise<ResponseList<AssetReference>>
See
https://support.crowdin.com/developer/api/v2/#tag/Source-Files/operation/api.projects.files.references.getMany
- Defined in sourceFiles/index.ts:447

listFileRevisions

listFileRevisions(projectId, fileId, options?): Promise<ResponseList<FileRevision>>
Parameters
- projectId: number
  project identifier
- fileId: number
  file identifier
- Optionaloptions: Partial<Pagination>
  optional pagination parameters for the request
Returns Promise<ResponseList<FileRevision>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.files.revisions.getMany
- Defined in sourceFiles/index.ts:503
listFileRevisions(projectId, fileId, limit?, offset?): Promise<ResponseList<FileRevision>>
Parameters
- projectId: number
  project identifier
- fileId: number
  file identifier
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<FileRevision>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.files.revisions.getMany
- Defined in sourceFiles/index.ts:516

listProjectBranches

listProjectBranches(projectId, options?): Promise<ResponseList<Branch>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: ListProjectBranchesOptions
  optional parameters for the request
Returns Promise<ResponseList<Branch>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.branches.getMany
- Defined in sourceFiles/index.ts:70
listProjectBranches(projectId, name?, limit?, offset?): Promise<ResponseList<Branch>>
Parameters
- projectId: number
  project identifier
- Optionalname: string
  filter branch by name
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<Branch>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.branches.getMany
- Defined in sourceFiles/index.ts:82

listProjectDirectories

listProjectDirectories(projectId, options?): Promise<ResponseList<Directory>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: ListProjectDirectoriesOptions
  optional parameters for the request
Returns Promise<ResponseList<Directory>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.directories.getMany
- Defined in sourceFiles/index.ts:201
listProjectDirectories(projectId, branchId?, directoryId?, limit?, offset?, filter?, recursion?): Promise<ResponseList<Directory>>
Parameters
- projectId: number
  project identifier
- OptionalbranchId: number
  filter directories by branchId
- OptionaldirectoryId: number
  filter directories by directoryId
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
- Optionalfilter: string
  use to filter directories by name
- Optionalrecursion: string
  use to list directories recursively (works only when directoryId or branchId parameter is specified)
Returns Promise<ResponseList<Directory>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.directories.getMany
- Defined in sourceFiles/index.ts:216

listProjectFiles

listProjectFiles(projectId, options?): Promise<ResponseList<File>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: ListProjectFilesOptions
  optional parameters for the request
Returns Promise<ResponseList<File>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.files.getMany
- Defined in sourceFiles/index.ts:306
listProjectFiles(projectId, branchId?, directoryId?, limit?, offset?, recursion?, filter?): Promise<ResponseList<File>>
Parameters
- projectId: number
  project identifier
- OptionalbranchId: number
  list branch files (Note! You can either list files for the specified branch (branchId) in the same request)
- OptionaldirectoryId: number
  list directory files (Note! You can either list files for the specified directory (directoryId) in the same request)
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
- Optionalrecursion: any
  use to list files recursively
- Optionalfilter: string
  use to filter files by name
Returns Promise<ResponseList<File>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.files.getMany
- Defined in sourceFiles/index.ts:321

listReviewedSourceFilesBuild

listReviewedSourceFilesBuild(projectId, options?): Promise<ResponseList<ReviewedSourceFilesBuild>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: ListReviewedSourceFilesBuildOptions
  optional parameters for the request
Returns Promise<ResponseList<ReviewedSourceFilesBuild>>
See
https://support.crowdin.com/enterprise/api/#operation/api.projects.strings.reviewed-builds.getMany
- Defined in sourceFiles/index.ts:555
listReviewedSourceFilesBuild(projectId, branchId?, limit?, offset?): Promise<ResponseList<ReviewedSourceFilesBuild>>
Parameters
- projectId: number
  project identifier
- OptionalbranchId: number
  filter builds by branchId
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<ReviewedSourceFilesBuild>>
Deprecated
optional parameters should be passed through an object

See
https://support.crowdin.com/enterprise/api/#operation/api.projects.strings.reviewed-builds.getMany
- Defined in sourceFiles/index.ts:567

mergeBranch

mergeBranch(projectId, branchId, request): Promise<ResponseObject<Status<MergeBranchAttributes>>>
Parameters
- projectId: number
  project identifier
- branchId: number
  branch identifier
- request: MergeBranchRequest
  request body
Returns Promise<ResponseObject<Status<MergeBranchAttributes>>>
See
https://support.crowdin.com/developer/api/v2/string-based/#tag/Branches/operation/api.projects.branches.merges.post
- Defined in sourceFiles/index.ts:157

updateOrRestoreFile

updateOrRestoreFile(projectId, fileId, request): Promise<ResponseObject<File>>
Parameters
- projectId: number
  project identifier
- fileId: number
  file identifier
- request: ReplaceFileFromStorageRequest | RestoreFile
  request body
Returns Promise<ResponseObject<File>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.files.put
- Defined in sourceFiles/index.ts:387

withFetchAll

withFetchAll(maxLimit?): this
Parameters
- OptionalmaxLimit: number
Returns this
Inherited from CrowdinApi.withFetchAll
- Defined in core/index.ts:328

Class SourceFiles

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SourceFiles

Methods

addAssetReference

Parameters

Returns Promise<ResponseObject<AssetReference>>

See

buildReviewedSourceFiles

Parameters

Returns Promise<ResponseObject<ReviewedSourceFilesBuild>>

See

checkBranchClonedStatus

Parameters

Returns Promise<ResponseObject<Status<object>>>

See

checkBranchMergeStatus

Parameters

Returns Promise<ResponseObject<Status<MergeBranchAttributes>>>

See

checkReviewedSourceFilesBuildStatus

Parameters

Returns Promise<ResponseObject<ReviewedSourceFilesBuild>>

See

clonedBranch

Parameters

Returns Promise<ResponseObject<Status<object>>>

See

createBranch

Parameters

Returns Promise<ResponseObject<Branch>>

See

createDirectory

Parameters

Returns Promise<ResponseObject<Directory>>

See

createFile

Parameters

Returns Promise<ResponseObject<File>>

See

deleteAssetReference

Parameters

Returns Promise<void>

See

deleteBranch

Parameters

Returns Promise<void>

See

deleteDirectory

Parameters

Returns Promise<void>

See

deleteFile

Parameters

Returns Promise<void>

See

downloadFile

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

downloadFilePreview

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

downloadReviewedSourceFiles

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

editBranch

Parameters

Returns Promise<ResponseObject<Branch>>

See

editDirectory

Parameters

`Optional`operationName?: string

`Optional`variables?: any

`Optional`url?: string