Class Glossaries

Glossaries help to explain some specific terms or the ones often used in the project so that they can be properly and consistently translated.

Use API to manage glossaries or specific terms. Glossary export and import are asynchronous operations and shall be completed with sequence of API methods.

Hierarchy (view full)

CrowdinApi
- Glossaries

Constructors

constructor

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

Methods

addGlossary

addGlossary(request): Promise<ResponseObject<Glossary>>
Parameters
- request: CreateGlossaryRequest
  request body
Returns Promise<ResponseObject<Glossary>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.post
- Defined in glossaries/index.ts:51

addTerm

addTerm(glossaryId, request): Promise<ResponseObject<Term>>
Parameters
- glossaryId: number
  glossary identifier
- request: CreateTermRequest
  request body
Returns Promise<ResponseObject<Term>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.post
- Defined in glossaries/index.ts:209

checkGlossaryExportStatus

checkGlossaryExportStatus(glossaryId, exportId): Promise<ResponseObject<Status<GlossaryExportStatusAttribute>>>
Parameters
- glossaryId: number
  glossary identifier
- exportId: string
  export identifier
Returns Promise<ResponseObject<Status<GlossaryExportStatusAttribute>>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.exports.get
- Defined in glossaries/index.ts:102

checkGlossaryImportStatus

checkGlossaryImportStatus(glossaryId, importId): Promise<ResponseObject<Status<GlossaryImportStatusAttribute>>>
Parameters
- glossaryId: number
  glossary identifier
- importId: string
  import identifier
Returns Promise<ResponseObject<Status<GlossaryImportStatusAttribute>>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.imports.get
- Defined in glossaries/index.ts:138

clearGlossary

clearGlossary(glossaryId, options?): Promise<ResponseObject<Term>>
Parameters
- glossaryId: number
  glossary identifier
- Optionaloptions: ClearGlossaryOptions
  optional parameters for the request
Returns Promise<ResponseObject<Term>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.deleteMany
- Defined in glossaries/index.ts:222
clearGlossary(glossaryId, languageId?, translationOfTermId?, conceptId?): Promise<ResponseObject<Term>>
Parameters
- glossaryId: number
  glossary identifier
- OptionallanguageId: number
  languageId identifier
- OptionaltranslationOfTermId: number
  term translation identifier
- OptionalconceptId: number
  concept identifier
Returns Promise<ResponseObject<Term>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.deleteMany
- Defined in glossaries/index.ts:234

concordanceSearch

concordanceSearch(projectId, request): Promise<ResponseList<GlossariesModel.ConcordanceSearchResponse>>
Parameters
- projectId: number
  project identifier
- request: GlossariesModel.ConcordanceSearchRequest
  request body
Returns Promise<ResponseList<GlossariesModel.ConcordanceSearchResponse>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.glossaries.concordance.post
- Defined in glossaries/index.ts:349

deleteConcept

deleteConcept(glossaryId, conceptId): Promise<void>
Parameters
- glossaryId: number
  glossary identifier
- conceptId: number
  concept identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.concepts.delete
- Defined in glossaries/index.ts:339

deleteGlossary

deleteGlossary(glossaryId): Promise<void>
Parameters
- glossaryId: number
  glossary identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.delete
- Defined in glossaries/index.ts:69

deleteTerm

deleteTerm(glossaryId, termId): Promise<void>
Parameters
- glossaryId: number
  glossary identifier
- termId: number
  term identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.delete
- Defined in glossaries/index.ts:275

downloadGlossary

downloadGlossary(glossaryId, exportId): Promise<ResponseObject<DownloadLink>>
Parameters
- glossaryId: number
  glossary identifier
- exportId: string
  export identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.exports.download.download
- Defined in glossaries/index.ts:115

editGlossary

editGlossary(glossaryId, request): Promise<ResponseObject<Glossary>>
Parameters
- glossaryId: number
  glossary identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Glossary>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.patch
- Defined in glossaries/index.ts:79

editTerm

editTerm(glossaryId, termId, request): Promise<ResponseObject<Term>>
Parameters
- glossaryId: number
  glossary identifier
- termId: number
  term identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Term>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.patch
- Defined in glossaries/index.ts:286

exportGlossary

exportGlossary(glossaryId, request): Promise<ResponseObject<Status<GlossaryExportStatusAttribute>>>
Parameters
- glossaryId: number
  glossary identifier
- request: ExportGlossaryRequest
  request body
Returns Promise<ResponseObject<Status<GlossaryExportStatusAttribute>>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.exports.post
- Defined in glossaries/index.ts:89

getConcept

getConcept(glossaryId, conceptId): Promise<ResponseObject<Concept>>
Parameters
- glossaryId: number
  glossary identifier
- conceptId: number
  concept identifier
Returns Promise<ResponseObject<Concept>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.concepts.get
- Defined in glossaries/index.ts:314

getGlossary

getGlossary(glossaryId): Promise<ResponseObject<Glossary>>
Parameters
- glossaryId: number
  glossary identifier
Returns Promise<ResponseObject<Glossary>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.get
- Defined in glossaries/index.ts:60

getTerm

getTerm(glossaryId, termId): Promise<ResponseObject<Term>>
Parameters
- glossaryId: number
  glossary identifier
- termId: number
  term identifier
Returns Promise<ResponseObject<Term>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.get
- Defined in glossaries/index.ts:265

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

importGlossaryFile

importGlossaryFile(glossaryId, request): Promise<ResponseObject<Status<GlossaryImportStatusAttribute>>>
Parameters
- glossaryId: number
  glossary identifier
- request: GlossaryFile
  request body
Returns Promise<ResponseObject<Status<GlossaryImportStatusAttribute>>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.imports.post
- Defined in glossaries/index.ts:125

listConcepts

listConcepts(glossaryId, options?): Promise<ResponseList<Concept>>
Parameters
- glossaryId: number
  glossary identifier
- Optionaloptions: {
  orderBy?: string;
  } & Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<Concept>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.concepts.getMany
- Defined in glossaries/index.ts:300

listGlossaries

listGlossaries(options?): Promise<ResponseList<Glossary>>
Parameters
- Optionaloptions: ListGlossariesOptions
  optional parameters for the request
Returns Promise<ResponseList<Glossary>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.getMany
- Defined in glossaries/index.ts:23
listGlossaries(groupId?, limit?, offset?): Promise<ResponseList<Glossary>>
Parameters
- OptionalgroupId: number
  group identifier
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<Glossary>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.getMany
- Defined in glossaries/index.ts:31

listTerms

listTerms(glossaryId, options?): Promise<ResponseList<Term>>
Parameters
- glossaryId: number
  glossary identifier
- Optionaloptions: ListTermsOptions
  optional parameters for the request
Returns Promise<ResponseList<Term>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.getMany
- Defined in glossaries/index.ts:151
listTerms(glossaryId, userId?, limit?, offset?, languageId?, translationOfTermId?, conceptId?): Promise<ResponseList<Term>>
Parameters
- glossaryId: number
  glossary identifier
- OptionaluserId: number
  list user glossaries
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
- OptionallanguageId: string
  term language identifier
- OptionaltranslationOfTermId: number
  filter terms by termId
- OptionalconceptId: number
  filter terms by conceptId
Returns Promise<ResponseList<Term>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.getMany
- Defined in glossaries/index.ts:166

updateConcept

updateConcept(glossaryId, conceptId, request): Promise<ResponseObject<Concept>>
Parameters
- glossaryId: number
  glossary identifier
- conceptId: number
  concept identifier
- request: UpdateConceptRequest
  request body
Returns Promise<ResponseObject<Concept>>
See
https://developer.crowdin.com/api/v2/#operation/api.glossaries.concepts.put
- Defined in glossaries/index.ts:325

withFetchAll

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

Class Glossaries

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Glossaries

Methods

addGlossary

Parameters

Returns Promise<ResponseObject<Glossary>>

See

addTerm

Parameters

Returns Promise<ResponseObject<Term>>

See

checkGlossaryExportStatus

Parameters

Returns Promise<ResponseObject<Status<GlossaryExportStatusAttribute>>>

See

checkGlossaryImportStatus

Parameters

Returns Promise<ResponseObject<Status<GlossaryImportStatusAttribute>>>

See

clearGlossary

Parameters

Returns Promise<ResponseObject<Term>>

See

Parameters

Returns Promise<ResponseObject<Term>>

Deprecated

See

concordanceSearch

Parameters

Returns Promise<ResponseList<GlossariesModel.ConcordanceSearchResponse>>

See

deleteConcept

Parameters

Returns Promise<void>

See

deleteGlossary

Parameters

Returns Promise<void>

See

deleteTerm

Parameters

Returns Promise<void>

See

downloadGlossary

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

editGlossary

Parameters

Returns Promise<ResponseObject<Glossary>>

See

editTerm

Parameters

Returns Promise<ResponseObject<Term>>

See

exportGlossary

Parameters

Returns Promise<ResponseObject<Status<GlossaryExportStatusAttribute>>>

See

getConcept

Parameters

Returns Promise<ResponseObject<Concept>>

See

getGlossary

Parameters

Returns Promise<ResponseObject<Glossary>>

See

getTerm

Parameters

Returns Promise<ResponseObject<Term>>

See

graphql

Type Parameters

`Optional`operationName?: string

`Optional`variables?: any

`Optional`url?: string