com.crowdin.client.glossaries

Class GlossariesApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.glossaries.GlossariesApi

public class GlossariesApi
extends CrowdinApi

Field Summary

Fields inherited from class com.crowdin.client.core.CrowdinApi

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

Constructor and Description
GlossariesApi(Credentials credentials)
GlossariesApi(Credentials credentials, ClientConfig clientConfig)

Method Summary

Modifier and Type	Method and Description
ResponseObject<Glossary>	addGlossary(AddGlossaryRequest request)
ResponseObject<Term>	addTerm(java.lang.Long glossaryId, AddTermRequest request)
ResponseObject<GlossaryExportStatus>	checkGlossaryExportStatus(java.lang.Long glossaryId, java.lang.String exportId)
ResponseObject<GlossaryImportStatus>	checkGlossaryImportStatus(java.lang.Long glossaryId, java.lang.String importId)
void	clearGlossary(java.lang.Long glossaryId, java.lang.String languageId, java.lang.Long conceptId, java.lang.Long translationOfTermId)
void	deleteConcept(java.lang.Long glossaryId, java.lang.Long conceptId)
void	deleteGlossary(java.lang.Long glossaryId)
void	deleteTerm(java.lang.Long glossaryId, java.lang.Long termId)
ResponseObject<DownloadLink>	downloadGlossary(java.lang.Long glossaryId, java.lang.String exportId)
ResponseObject<Glossary>	editGlossary(java.lang.Long glossaryId, java.util.List<PatchRequest> request)
ResponseObject<Term>	editTerm(java.lang.Long glossaryId, java.lang.Long termId, java.util.List<PatchRequest> request)
ResponseObject<GlossaryExportStatus>	exportGlossary(java.lang.Long glossaryId, ExportGlossaryRequest request)
ResponseObject<Concept>	getConcept(java.lang.Long glossaryId, java.lang.Long conceptId)
ResponseObject<Glossary>	getGlossary(java.lang.Long glossaryId)
ResponseObject<Term>	getTerm(java.lang.Long glossaryId, java.lang.Long termId)
ResponseObject<GlossaryImportStatus>	importGlossary(java.lang.Long glossaryId, ImportGlossaryRequest request)
ResponseList<Concept>	listConcepts(java.lang.Long glossaryId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<Concept>	listConcepts(java.lang.Long glossaryId, java.lang.Integer limit, java.lang.Integer offset, java.util.List<OrderByField> orderBy)
ResponseList<Concept>	listConcepts(java.lang.Long glossaryId, ListConceptsParams params)
ResponseList<Glossary>	listGlossaries(ListGlossariesParams params)
ResponseList<Glossary>	listGlossaries(java.lang.Long groupId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<Glossary>	listGlossaries(java.lang.Long groupId, java.lang.Integer limit, java.lang.Integer offset, java.util.List<OrderByField> orderBy)
ResponseList<Term>	listTerms(java.lang.Long glossaryId, ListTermsParams params)
ResponseList<Term>	listTerms(java.lang.Long glossaryId, java.lang.Long userId, java.lang.String languageId, java.lang.Long conceptId, java.lang.Long translationOfTermId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<Term>	listTerms(java.lang.Long glossaryId, java.lang.Long userId, java.lang.String languageId, java.lang.Long conceptId, java.lang.Long translationOfTermId, java.lang.Integer limit, java.lang.Integer offset, java.util.List<OrderByField> orderBy)
ResponseList<SearchConcordance>	searchConcordance(java.lang.Long projectId, SearchConcordanceRequest request)
ResponseObject<Concept>	updateConcept(java.lang.Long glossaryId, java.lang.Long conceptId, Concept request)

Methods inherited from class com.crowdin.client.core.CrowdinApi

graphql, graphql

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GlossariesApi

public GlossariesApi(Credentials credentials)

GlossariesApi

public GlossariesApi(Credentials credentials,
                     ClientConfig clientConfig)

Method Detail

searchConcordance

public ResponseList<SearchConcordance> searchConcordance(java.lang.Long projectId,
                                                         SearchConcordanceRequest request)

Parameters:

projectId - project identifier

request - request object

Returns:

list of search results

See Also:

• API Documentation
• Enterprise API Documentation

listConcepts

public ResponseList<Concept> listConcepts(java.lang.Long glossaryId,
                                          java.lang.Integer limit,
                                          java.lang.Integer offset)
                                   throws HttpException,
                                          HttpBadRequestException

Parameters:

glossaryId - glossary identifier

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

Returns:

list of concepts

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listConcepts

public ResponseList<Concept> listConcepts(java.lang.Long glossaryId,
                                          java.lang.Integer limit,
                                          java.lang.Integer offset,
                                          java.util.List<OrderByField> orderBy)
                                   throws HttpException,
                                          HttpBadRequestException

Parameters:

glossaryId - glossary identifier

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

orderBy - list of OrderByFields

Returns:

list of concepts

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listConcepts

public ResponseList<Concept> listConcepts(java.lang.Long glossaryId,
                                          ListConceptsParams params)
                                   throws HttpException,
                                          HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

getConcept

public ResponseObject<Concept> getConcept(java.lang.Long glossaryId,
                                          java.lang.Long conceptId)
                                   throws HttpException,
                                          HttpBadRequestException

Parameters:

glossaryId - glossary identifier

conceptId - concept identifier

Returns:

concept

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

updateConcept

public ResponseObject<Concept> updateConcept(java.lang.Long glossaryId,
                                             java.lang.Long conceptId,
                                             Concept request)
                                      throws HttpException,
                                             HttpBadRequestException

Parameters:

glossaryId - glossary identifier

conceptId - concept identifier

request - request object

Returns:

updated concept

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteConcept

public void deleteConcept(java.lang.Long glossaryId,
                          java.lang.Long conceptId)
                   throws HttpException,
                          HttpBadRequestException

Parameters:

glossaryId - glossary identifier

conceptId - concept identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listGlossaries

public ResponseList<Glossary> listGlossaries(java.lang.Long groupId,
                                             java.lang.Integer limit,
                                             java.lang.Integer offset)
                                      throws HttpException,
                                             HttpBadRequestException

Parameters:

groupId - group identifier

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

Returns:

list of glossaries

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listGlossaries

public ResponseList<Glossary> listGlossaries(java.lang.Long groupId,
                                             java.lang.Integer limit,
                                             java.lang.Integer offset,
                                             java.util.List<OrderByField> orderBy)
                                      throws HttpException,
                                             HttpBadRequestException

Parameters:

groupId - group identifier

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

orderBy - list of OrderByField

Returns:

list of glossaries

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listGlossaries

public ResponseList<Glossary> listGlossaries(ListGlossariesParams params)
                                      throws HttpException,
                                             HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

addGlossary

public ResponseObject<Glossary> addGlossary(AddGlossaryRequest request)
                                     throws HttpException,
                                            HttpBadRequestException

Parameters:

request - request object

Returns:

newly created glossary

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getGlossary

public ResponseObject<Glossary> getGlossary(java.lang.Long glossaryId)
                                     throws HttpException,
                                            HttpBadRequestException

Parameters:

glossaryId - glossary identifier

Returns:

glossary

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteGlossary

public void deleteGlossary(java.lang.Long glossaryId)
                    throws HttpException,
                           HttpBadRequestException

Parameters:

glossaryId - glossary identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editGlossary

public ResponseObject<Glossary> editGlossary(java.lang.Long glossaryId,
                                             java.util.List<PatchRequest> request)
                                      throws HttpException,
                                             HttpBadRequestException

Parameters:

glossaryId - glossary identifier

request - request object

Returns:

updated glossary

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

exportGlossary

public ResponseObject<GlossaryExportStatus> exportGlossary(java.lang.Long glossaryId,
                                                           ExportGlossaryRequest request)
                                                    throws HttpException,
                                                           HttpBadRequestException

Parameters:

glossaryId - glossary identifier

request - request object

Returns:

export status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

checkGlossaryExportStatus

public ResponseObject<GlossaryExportStatus> checkGlossaryExportStatus(java.lang.Long glossaryId,
                                                                      java.lang.String exportId)
                                                               throws HttpException,
                                                                      HttpBadRequestException

Parameters:

glossaryId - glossary identifier

exportId - export identifier

Returns:

export status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

downloadGlossary

public ResponseObject<DownloadLink> downloadGlossary(java.lang.Long glossaryId,
                                                     java.lang.String exportId)
                                              throws HttpException,
                                                     HttpBadRequestException

Parameters:

glossaryId - glossary identifier

exportId - export identifier

Returns:

download link

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

importGlossary

public ResponseObject<GlossaryImportStatus> importGlossary(java.lang.Long glossaryId,
                                                           ImportGlossaryRequest request)
                                                    throws HttpException,
                                                           HttpBadRequestException

Parameters:

glossaryId - glossary identifier

request - request object

Returns:

import status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

checkGlossaryImportStatus

public ResponseObject<GlossaryImportStatus> checkGlossaryImportStatus(java.lang.Long glossaryId,
                                                                      java.lang.String importId)
                                                               throws HttpException,
                                                                      HttpBadRequestException

Parameters:

glossaryId - glossary identifier

importId - import identifier

Returns:

import status

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listTerms

public ResponseList<Term> listTerms(java.lang.Long glossaryId,
                                    java.lang.Long userId,
                                    java.lang.String languageId,
                                    java.lang.Long conceptId,
                                    @Deprecated
                                    java.lang.Long translationOfTermId,
                                    java.lang.Integer limit,
                                    java.lang.Integer offset)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

glossaryId - glossary identifier

userId - user identifier

languageId - language identifier

conceptId - concept identifier

translationOfTermId - term identifier

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

Returns:

list of terms

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listTerms

public ResponseList<Term> listTerms(java.lang.Long glossaryId,
                                    java.lang.Long userId,
                                    java.lang.String languageId,
                                    java.lang.Long conceptId,
                                    @Deprecated
                                    java.lang.Long translationOfTermId,
                                    java.lang.Integer limit,
                                    java.lang.Integer offset,
                                    java.util.List<OrderByField> orderBy)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

glossaryId - glossary identifier

userId - user identifier

languageId - language identifier

conceptId - concept identifier

translationOfTermId - term identifier

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

orderBy - list of OrderByField

Returns:

list of terms

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listTerms

public ResponseList<Term> listTerms(java.lang.Long glossaryId,
                                    ListTermsParams params)
                             throws HttpException,
                                    HttpBadRequestException

Throws:

HttpException

HttpBadRequestException

addTerm

public ResponseObject<Term> addTerm(java.lang.Long glossaryId,
                                    AddTermRequest request)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

glossaryId - glossary identifier

request - request object

Returns:

newly created term

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

clearGlossary

public void clearGlossary(java.lang.Long glossaryId,
                          java.lang.String languageId,
                          java.lang.Long conceptId,
                          @Deprecated
                          java.lang.Long translationOfTermId)
                   throws HttpException,
                          HttpBadRequestException

Parameters:

glossaryId - glossary identifier

languageId - language identifier

conceptId - concept identifier

translationOfTermId - translationOfTerm identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getTerm

public ResponseObject<Term> getTerm(java.lang.Long glossaryId,
                                    java.lang.Long termId)
                             throws HttpException,
                                    HttpBadRequestException

Parameters:

glossaryId - glossary identifier

termId - term identifier

Returns:

term

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteTerm

public void deleteTerm(java.lang.Long glossaryId,
                       java.lang.Long termId)
                throws HttpException,
                       HttpBadRequestException

Parameters:

glossaryId - glossary identifier

termId - term identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editTerm

public ResponseObject<Term> editTerm(java.lang.Long glossaryId,
                                     java.lang.Long termId,
                                     java.util.List<PatchRequest> request)
                              throws HttpException,
                                     HttpBadRequestException

Parameters:

glossaryId - glossary identifier

termId - term identifier

request - request object

Returns:

updated term

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation