@crowdin/crowdin-api-client
Advanced tools
Comparing version 1.19.2 to 1.20.0
@@ -25,3 +25,3 @@ import { RetryConfig, RetryService } from './internal/retry'; | ||
} | ||
export declare type HttpClientType = 'axios' | 'fetch'; | ||
export type HttpClientType = 'axios' | 'fetch'; | ||
/** | ||
@@ -64,3 +64,3 @@ * Authorization credentials | ||
} | ||
export declare type PaginationOptions = Partial<Pagination>; | ||
export type PaginationOptions = Partial<Pagination>; | ||
/** | ||
@@ -77,3 +77,3 @@ * A JSON Patch document as defined by [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902#section-3) | ||
} | ||
export declare type PatchOperation = 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test'; | ||
export type PatchOperation = 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test'; | ||
export interface DownloadLink { | ||
@@ -185,1 +185,14 @@ url: string; | ||
export declare function isOptionalNumber(parameter: number | unknown, parameterInArgs: boolean): parameter is number | undefined; | ||
export interface ProjectRole { | ||
name: string; | ||
permissions: ProjectRolePermissions; | ||
} | ||
export interface ProjectRolePermissions { | ||
allLanguages: boolean; | ||
languagesAccess: { | ||
[lang: string]: { | ||
allContent: boolean; | ||
workflowStepIds: number[]; | ||
}; | ||
}; | ||
} |
@@ -11,3 +11,3 @@ import { CrowdinApi, PatchRequest, ResponseList, ResponseObject } from '../core'; | ||
* @param options optional parameters for listing dictionaries | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.dictionaries.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.dictionaries.getMany | ||
*/ | ||
@@ -19,3 +19,3 @@ listDictionaries(projectId: number, options?: DictionariesModel.ListDictionariesOptions): Promise<ResponseList<DictionariesModel.Dictionary>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.dictionaries.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.dictionaries.getMany | ||
*/ | ||
@@ -27,3 +27,3 @@ listDictionaries(projectId: number, languageIds?: string): Promise<ResponseList<DictionariesModel.Dictionary>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.dictionaries.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.dictionaries.patch | ||
*/ | ||
@@ -30,0 +30,0 @@ editDictionary(projectId: number, languageId: string, request: PatchRequest[]): Promise<ResponseObject<DictionariesModel.Dictionary>>; |
@@ -23,3 +23,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.dictionaries.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.dictionaries.patch | ||
*/ | ||
@@ -26,0 +26,0 @@ editDictionary(projectId, languageId, request) { |
@@ -6,3 +6,3 @@ import { CrowdinApi, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core'; | ||
* @param options optional pagination parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.distributions.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.getMany | ||
*/ | ||
@@ -15,3 +15,3 @@ listDistributions(projectId: number, options?: PaginationOptions): Promise<ResponseList<DistributionsModel.Distribution>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.distributions.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.getMany | ||
*/ | ||
@@ -22,3 +22,3 @@ listDistributions(projectId: number, limit?: number, offset?: number): Promise<ResponseList<DistributionsModel.Distribution>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.distributions.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.post | ||
*/ | ||
@@ -29,3 +29,3 @@ createDistribution(projectId: number, request: DistributionsModel.CreateDistributionRequest): Promise<ResponseObject<DistributionsModel.Distribution>>; | ||
* @param hash hash | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.distributions.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.get | ||
*/ | ||
@@ -36,3 +36,3 @@ getDistribution(projectId: number, hash: string): Promise<ResponseObject<DistributionsModel.Distribution>>; | ||
* @param hash hash | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.distributions.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.delete | ||
*/ | ||
@@ -44,3 +44,3 @@ deleteDistribution(projectId: number, hash: string): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.distributions.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.patch | ||
*/ | ||
@@ -51,3 +51,3 @@ editDistribution(projectId: number, hash: string, request: PatchRequest[]): Promise<ResponseObject<DistributionsModel.Distribution>>; | ||
* @param hash hash | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.distributions.release.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.release.get | ||
*/ | ||
@@ -59,3 +59,3 @@ getDistributionRelease(projectId: number, hash: string): Promise<ResponseObject<DistributionsModel.DistributionRelease>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.distributions.release.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.release.post | ||
*/ | ||
@@ -62,0 +62,0 @@ createDistributionRelease(projectId: number, hash: string): Promise<ResponseObject<DistributionsModel.DistributionRelease>>; |
@@ -16,3 +16,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.distributions.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.post | ||
*/ | ||
@@ -26,3 +26,3 @@ createDistribution(projectId, request) { | ||
* @param hash hash | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.distributions.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.get | ||
*/ | ||
@@ -36,3 +36,3 @@ getDistribution(projectId, hash) { | ||
* @param hash hash | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.distributions.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.delete | ||
*/ | ||
@@ -47,3 +47,3 @@ deleteDistribution(projectId, hash) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.distributions.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.patch | ||
*/ | ||
@@ -57,3 +57,3 @@ editDistribution(projectId, hash, request) { | ||
* @param hash hash | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.distributions.release.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.release.get | ||
*/ | ||
@@ -68,3 +68,3 @@ getDistributionRelease(projectId, hash) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.distributions.release.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.distributions.release.post | ||
*/ | ||
@@ -71,0 +71,0 @@ createDistributionRelease(projectId, hash) { |
@@ -11,3 +11,3 @@ import { CrowdinApi, DownloadLink, PaginationOptions, PatchRequest, ResponseList, ResponseObject, Status } from '../core'; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.getMany | ||
*/ | ||
@@ -20,3 +20,3 @@ listGlossaries(options?: GlossariesModel.ListGlossariesOptions): Promise<ResponseList<GlossariesModel.Glossary>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.getMany | ||
*/ | ||
@@ -26,3 +26,3 @@ listGlossaries(groupId?: number, limit?: number, offset?: number): Promise<ResponseList<GlossariesModel.Glossary>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.post | ||
*/ | ||
@@ -32,3 +32,3 @@ addGlossary(request: GlossariesModel.CreateGlossaryRequest): Promise<ResponseObject<GlossariesModel.Glossary>>; | ||
* @param glossaryId glossary identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.get | ||
*/ | ||
@@ -38,3 +38,3 @@ getGlossary(glossaryId: number): Promise<ResponseObject<GlossariesModel.Glossary>>; | ||
* @param glossaryId glossary identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.delete | ||
*/ | ||
@@ -45,3 +45,3 @@ deleteGlossary(glossaryId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.patch | ||
*/ | ||
@@ -52,3 +52,3 @@ editGlossary(glossaryId: number, request: PatchRequest[]): Promise<ResponseObject<GlossariesModel.Glossary>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.exports.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.exports.post | ||
*/ | ||
@@ -59,3 +59,3 @@ exportGlossary(glossaryId: number, request: GlossariesModel.ExportGlossaryRequest): Promise<ResponseObject<Status<GlossariesModel.GlossaryExportStatusAttribute>>>; | ||
* @param exportId export identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.exports.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.exports.get | ||
*/ | ||
@@ -66,3 +66,3 @@ checkGlossaryExportStatus(glossaryId: number, exportId: string): Promise<ResponseObject<Status<GlossariesModel.GlossaryExportStatusAttribute>>>; | ||
* @param exportId export identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.exports.download.download | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.exports.download.download | ||
*/ | ||
@@ -73,3 +73,3 @@ downloadGlossary(glossaryId: number, exportId: string): Promise<ResponseObject<DownloadLink>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.imports.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.imports.post | ||
*/ | ||
@@ -80,3 +80,3 @@ importGlossaryFile(glossaryId: number, request: GlossariesModel.GlossaryFile): Promise<ResponseObject<Status<GlossariesModel.GlossaryImportStatusAttribute>>>; | ||
* @param importId import identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.imports.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.imports.get | ||
*/ | ||
@@ -87,3 +87,3 @@ checkGlossaryImportStatus(glossaryId: number, importId: string): Promise<ResponseObject<Status<GlossariesModel.GlossaryImportStatusAttribute>>>; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.terms.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.getMany | ||
*/ | ||
@@ -98,10 +98,11 @@ listTerms(glossaryId: number, options?: GlossariesModel.ListTermsOptions): Promise<ResponseList<GlossariesModel.Term>>; | ||
* @param translationOfTermId filter terms by termId | ||
* @param conceptId filter terms by conceptId | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.terms.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.getMany | ||
*/ | ||
listTerms(glossaryId: number, userId?: number, limit?: number, offset?: number, languageId?: string, translationOfTermId?: number): Promise<ResponseList<GlossariesModel.Term>>; | ||
listTerms(glossaryId: number, userId?: number, limit?: number, offset?: number, languageId?: string, translationOfTermId?: number, conceptId?: number): Promise<ResponseList<GlossariesModel.Term>>; | ||
/** | ||
* @param glossaryId glossary identifier | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.terms.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.post | ||
*/ | ||
@@ -112,3 +113,3 @@ addTerm(glossaryId: number, request: GlossariesModel.CreateTermRequest): Promise<ResponseObject<GlossariesModel.Term>>; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.terms.deleteMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.deleteMany | ||
*/ | ||
@@ -120,10 +121,11 @@ clearGlossary(glossaryId: number, options?: GlossariesModel.ClearGlossaryOptions): Promise<ResponseObject<GlossariesModel.Term>>; | ||
* @param translationOfTermId term translation identifier | ||
* @param conceptId concept identifier | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.terms.deleteMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.deleteMany | ||
*/ | ||
clearGlossary(glossaryId: number, languageId?: number, translationOfTermId?: number): Promise<ResponseObject<GlossariesModel.Term>>; | ||
clearGlossary(glossaryId: number, languageId?: number, translationOfTermId?: number, conceptId?: number): Promise<ResponseObject<GlossariesModel.Term>>; | ||
/** | ||
* @param glossaryId glossary identifier | ||
* @param termId term identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.terms.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.get | ||
*/ | ||
@@ -134,3 +136,3 @@ getTerm(glossaryId: number, termId: number): Promise<ResponseObject<GlossariesModel.Term>>; | ||
* @param termId term identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.terms.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.delete | ||
*/ | ||
@@ -142,5 +144,30 @@ deleteTerm(glossaryId: number, termId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.terms.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.patch | ||
*/ | ||
editTerm(glossaryId: number, termId: number, request: PatchRequest[]): Promise<ResponseObject<GlossariesModel.Term>>; | ||
/** | ||
* @param glossaryId glossary identifier | ||
* @param options optional parameters for the request | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.concepts.getMany | ||
*/ | ||
listConcepts(glossaryId: number, options?: PaginationOptions): Promise<ResponseList<GlossariesModel.Concept>>; | ||
/** | ||
* @param glossaryId glossary identifier | ||
* @param conceptId concept identifier | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.concepts.get | ||
*/ | ||
getConcept(glossaryId: number, conceptId: number): Promise<ResponseObject<GlossariesModel.Concept>>; | ||
/** | ||
* @param glossaryId glossary identifier | ||
* @param conceptId concept identifier | ||
* @param request request body | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.concepts.put | ||
*/ | ||
updateConcept(glossaryId: number, conceptId: number, request: GlossariesModel.UpdateConceptRequest): Promise<ResponseObject<GlossariesModel.Concept>>; | ||
/** | ||
* @param glossaryId glossary identifier | ||
* @param conceptId concept identifier | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.concepts.delete | ||
*/ | ||
deleteConcept(glossaryId: number, conceptId: number): Promise<void>; | ||
} | ||
@@ -164,4 +191,6 @@ export declare namespace GlossariesModel { | ||
} | ||
type ExportField = 'term' | 'description' | 'partOfSpeech' | 'type' | 'status' | 'gender' | 'note' | 'url'; | ||
interface ExportGlossaryRequest { | ||
format: GlossaryFormat; | ||
format?: GlossaryFormat; | ||
exportFields?: ExportField[]; | ||
} | ||
@@ -184,2 +213,6 @@ interface GlossaryExportStatusAttribute { | ||
languageId?: string; | ||
conceptId?: number; | ||
/** | ||
* @deprecated | ||
*/ | ||
translationOfTermId?: number; | ||
@@ -194,3 +227,9 @@ } | ||
description: string; | ||
partOfSpeech: string; | ||
partOfSpeech: PartOfSpeech; | ||
status: Status; | ||
type: Type; | ||
gender: Gender; | ||
note: string; | ||
url: string; | ||
conceptId: number; | ||
lemma: string; | ||
@@ -205,5 +244,16 @@ createdAt: string; | ||
partOfSpeech?: PartOfSpeech; | ||
/** | ||
* @deprecated | ||
*/ | ||
translationOfTermId?: number; | ||
status?: Status; | ||
type?: Type; | ||
gender?: Gender; | ||
note?: string; | ||
conceptId?: number; | ||
} | ||
type GlossaryFormat = 'tbx' | 'csv' | 'xlsx'; | ||
type Status = 'preferred' | 'admitted' | 'not recommended' | 'obsolete'; | ||
type Type = 'full form' | 'acronym' | 'abbreviation' | 'short form' | 'phrase' | 'variant'; | ||
type Gender = 'masculine' | 'feminine' | 'neuter' | 'other'; | ||
type GlossaryFormat = 'tbx' | 'tbx_v3' | 'csv' | 'xlsx'; | ||
interface GlossaryFileScheme { | ||
@@ -218,4 +268,41 @@ [key: string]: number; | ||
languageId?: number; | ||
/** | ||
* @deprecated | ||
*/ | ||
translationOfTermId?: number; | ||
conceptId?: number; | ||
} | ||
interface Concept { | ||
id: number; | ||
userId: number; | ||
glossaryId: number; | ||
subject: string; | ||
definition: string; | ||
note: string; | ||
url: string; | ||
figure: string; | ||
languagesDetails: LanguageDetails[]; | ||
createdAt: string; | ||
updatedAt: string; | ||
} | ||
interface LanguageDetails { | ||
languageId: string; | ||
userId: number; | ||
definition: string; | ||
note: string; | ||
createdAt: string; | ||
updatedAt: string; | ||
} | ||
interface UpdateConceptRequest { | ||
subject?: string; | ||
definition?: string; | ||
note?: string; | ||
url?: string; | ||
figure?: string; | ||
languagesDetails?: { | ||
languageId: string; | ||
definition: string; | ||
note?: string; | ||
}[]; | ||
} | ||
} |
@@ -22,3 +22,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.post | ||
*/ | ||
@@ -31,3 +31,3 @@ addGlossary(request) { | ||
* @param glossaryId glossary identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.get | ||
*/ | ||
@@ -40,3 +40,3 @@ getGlossary(glossaryId) { | ||
* @param glossaryId glossary identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.delete | ||
*/ | ||
@@ -50,3 +50,3 @@ deleteGlossary(glossaryId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.patch | ||
*/ | ||
@@ -60,3 +60,3 @@ editGlossary(glossaryId, request) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.exports.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.exports.post | ||
*/ | ||
@@ -70,3 +70,3 @@ exportGlossary(glossaryId, request) { | ||
* @param exportId export identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.exports.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.exports.get | ||
*/ | ||
@@ -80,3 +80,3 @@ checkGlossaryExportStatus(glossaryId, exportId) { | ||
* @param exportId export identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.exports.download.download | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.exports.download.download | ||
*/ | ||
@@ -90,3 +90,3 @@ downloadGlossary(glossaryId, exportId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.imports.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.imports.post | ||
*/ | ||
@@ -100,3 +100,3 @@ importGlossaryFile(glossaryId, request) { | ||
* @param importId import identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.imports.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.imports.get | ||
*/ | ||
@@ -107,3 +107,3 @@ checkGlossaryImportStatus(glossaryId, importId) { | ||
} | ||
listTerms(glossaryId, options, deprecatedLimit, deprecatedOffset, deprecatedLanguageId, deprecatedTranslationOfTermId) { | ||
listTerms(glossaryId, options, deprecatedLimit, deprecatedOffset, deprecatedLanguageId, deprecatedTranslationOfTermId, deprecatedConceptId) { | ||
let url = `${this.url}/glossaries/${glossaryId}/terms`; | ||
@@ -117,2 +117,3 @@ if ((0, core_1.isOptionalNumber)(options, '1' in arguments)) { | ||
translationOfTermId: deprecatedTranslationOfTermId, | ||
conceptId: deprecatedConceptId, | ||
}; | ||
@@ -123,2 +124,3 @@ } | ||
url = this.addQueryParam(url, 'translationOfTermId', options.translationOfTermId); | ||
url = this.addQueryParam(url, 'conceptId', options.conceptId); | ||
return this.getList(url, options.limit, options.offset); | ||
@@ -129,3 +131,3 @@ } | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.terms.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.post | ||
*/ | ||
@@ -136,5 +138,9 @@ addTerm(glossaryId, request) { | ||
} | ||
clearGlossary(glossaryId, options, deprecatedTranslationOfTermId) { | ||
clearGlossary(glossaryId, options, deprecatedTranslationOfTermId, deprecatedConceptId) { | ||
if ((0, core_1.isOptionalNumber)(options, '1' in arguments)) { | ||
options = { languageId: options, translationOfTermId: deprecatedTranslationOfTermId }; | ||
options = { | ||
languageId: options, | ||
translationOfTermId: deprecatedTranslationOfTermId, | ||
conceptId: deprecatedConceptId, | ||
}; | ||
} | ||
@@ -144,2 +150,3 @@ let url = `${this.url}/glossaries/${glossaryId}/terms`; | ||
url = this.addQueryParam(url, 'translationOfTermId', options.translationOfTermId); | ||
url = this.addQueryParam(url, 'conceptId', options.conceptId); | ||
return this.delete(url, this.defaultConfig()); | ||
@@ -150,3 +157,3 @@ } | ||
* @param termId term identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.terms.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.get | ||
*/ | ||
@@ -160,3 +167,3 @@ getTerm(glossaryId, termId) { | ||
* @param termId term identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.terms.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.delete | ||
*/ | ||
@@ -171,3 +178,3 @@ deleteTerm(glossaryId, termId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.glossaries.terms.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.terms.patch | ||
*/ | ||
@@ -178,3 +185,40 @@ editTerm(glossaryId, termId, request) { | ||
} | ||
/** | ||
* @param glossaryId glossary identifier | ||
* @param options optional parameters for the request | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.concepts.getMany | ||
*/ | ||
listConcepts(glossaryId, options) { | ||
const url = `${this.url}/glossaries/${glossaryId}/concepts`; | ||
return this.getList(url, options === null || options === void 0 ? void 0 : options.limit, options === null || options === void 0 ? void 0 : options.offset); | ||
} | ||
/** | ||
* @param glossaryId glossary identifier | ||
* @param conceptId concept identifier | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.concepts.get | ||
*/ | ||
getConcept(glossaryId, conceptId) { | ||
const url = `${this.url}/glossaries/${glossaryId}/concepts/${conceptId}`; | ||
return this.get(url, this.defaultConfig()); | ||
} | ||
/** | ||
* @param glossaryId glossary identifier | ||
* @param conceptId concept identifier | ||
* @param request request body | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.concepts.put | ||
*/ | ||
updateConcept(glossaryId, conceptId, request) { | ||
const url = `${this.url}/glossaries/${glossaryId}/concepts/${conceptId}`; | ||
return this.put(url, request, this.defaultConfig()); | ||
} | ||
/** | ||
* @param glossaryId glossary identifier | ||
* @param conceptId concept identifier | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.glossaries.concepts.delete | ||
*/ | ||
deleteConcept(glossaryId, conceptId) { | ||
const url = `${this.url}/glossaries/${glossaryId}/concepts/${conceptId}`; | ||
return this.delete(url, this.defaultConfig()); | ||
} | ||
} | ||
exports.Glossaries = Glossaries; |
"use strict"; | ||
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { | ||
if (k2 === undefined) k2 = k; | ||
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); | ||
var desc = Object.getOwnPropertyDescriptor(m, k); | ||
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { | ||
desc = { enumerable: true, get: function() { return m[k]; } }; | ||
} | ||
Object.defineProperty(o, k2, desc); | ||
}) : (function(o, m, k, k2) { | ||
@@ -6,0 +10,0 @@ if (k2 === undefined) k2 = k; |
@@ -10,3 +10,3 @@ import { CrowdinApi, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core'; | ||
* @param options optional parameters for listing reported issues | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.issues.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.issues.getMany | ||
*/ | ||
@@ -21,3 +21,3 @@ listReportedIssues(projectId: number, options?: IssuesModel.ListReportedIssuesOptions): Promise<ResponseList<IssuesModel.Issue>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.issues.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.issues.getMany | ||
*/ | ||
@@ -29,3 +29,3 @@ listReportedIssues(projectId: number, limit?: number, offset?: number, type?: IssuesModel.Type, status?: IssuesModel.Status): Promise<ResponseList<IssuesModel.Issue>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.issues.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.issues.patch | ||
*/ | ||
@@ -32,0 +32,0 @@ editIssue(projectId: number, issueId: number, request: PatchRequest[]): Promise<ResponseObject<IssuesModel.Issue>>; |
@@ -28,3 +28,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.issues.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.issues.patch | ||
*/ | ||
@@ -31,0 +31,0 @@ editIssue(projectId, issueId, request) { |
@@ -7,3 +7,3 @@ import { CrowdinApi, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core'; | ||
* @param options optional pagination parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.labels.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.labels.getMany | ||
*/ | ||
@@ -16,3 +16,3 @@ listLabels(projectId: number, options?: PaginationOptions): Promise<ResponseList<LabelsModel.Label>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.labels.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.labels.getMany | ||
*/ | ||
@@ -23,3 +23,3 @@ listLabels(projectId: number, limit?: number, offset?: number): Promise<ResponseList<LabelsModel.Label>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.labels.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.labels.post | ||
*/ | ||
@@ -30,3 +30,3 @@ addLabel(projectId: number, request: LabelsModel.AddLabelRequest): Promise<ResponseObject<LabelsModel.Label>>; | ||
* @param labelId label identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.labels.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.labels.get | ||
*/ | ||
@@ -37,3 +37,3 @@ getLabel(projectId: number, labelId: number): Promise<ResponseObject<LabelsModel.Label>>; | ||
* @param labelId label identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.labels.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.labels.delete | ||
*/ | ||
@@ -45,3 +45,3 @@ deleteLabel(projectId: number, labelId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.labels.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.labels.patch | ||
*/ | ||
@@ -53,3 +53,3 @@ editLabel(projectId: number, labelId: number, request: PatchRequest[]): Promise<ResponseObject<LabelsModel.Label>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.labels.strings.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.labels.strings.post | ||
*/ | ||
@@ -61,3 +61,3 @@ assignLabelToString(projectId: number, labelId: number, request: LabelsModel.AssignLabelToStringRequet): Promise<ResponseList<SourceStringsModel.String>>; | ||
* @param stringIds string identifiers | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.labels.strings.deleteMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.labels.strings.deleteMany | ||
*/ | ||
@@ -64,0 +64,0 @@ unassignLabelFromString(projectId: number, labelId: number, stringIds: string): Promise<ResponseList<SourceStringsModel.String>>; |
@@ -16,3 +16,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.labels.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.labels.post | ||
*/ | ||
@@ -26,3 +26,3 @@ addLabel(projectId, request) { | ||
* @param labelId label identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.labels.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.labels.get | ||
*/ | ||
@@ -36,3 +36,3 @@ getLabel(projectId, labelId) { | ||
* @param labelId label identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.labels.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.labels.delete | ||
*/ | ||
@@ -47,3 +47,3 @@ deleteLabel(projectId, labelId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.labels.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.labels.patch | ||
*/ | ||
@@ -58,3 +58,3 @@ editLabel(projectId, labelId, request) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.labels.strings.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.labels.strings.post | ||
*/ | ||
@@ -69,3 +69,3 @@ assignLabelToString(projectId, labelId, request) { | ||
* @param stringIds string identifiers | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.labels.strings.deleteMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.labels.strings.deleteMany | ||
*/ | ||
@@ -72,0 +72,0 @@ unassignLabelFromString(projectId, labelId, stringIds) { |
@@ -10,3 +10,3 @@ import { CrowdinApi, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core'; | ||
* @param options optional pagination parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.languages.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.languages.getMany | ||
*/ | ||
@@ -18,3 +18,3 @@ listSupportedLanguages(options?: PaginationOptions): Promise<ResponseList<LanguagesModel.Language>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.languages.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.languages.getMany | ||
*/ | ||
@@ -24,3 +24,3 @@ listSupportedLanguages(limit?: number, offset?: number): Promise<ResponseList<LanguagesModel.Language>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.languages.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.languages.post | ||
*/ | ||
@@ -30,3 +30,3 @@ addCustomLanguage(request: LanguagesModel.AddLanguageRequest): Promise<ResponseObject<LanguagesModel.Language>>; | ||
* @param languageId language identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.languages.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.languages.get | ||
*/ | ||
@@ -36,3 +36,3 @@ getLanguage(languageId: string): Promise<ResponseObject<LanguagesModel.Language>>; | ||
* @param languageId language identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.languages.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.languages.delete | ||
*/ | ||
@@ -43,3 +43,3 @@ deleteCustomLanguage(languageId: string): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.languages.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.languages.patch | ||
*/ | ||
@@ -46,0 +46,0 @@ editCustomLanguage(languageId: string, request: PatchRequest[]): Promise<ResponseObject<LanguagesModel.Language>>; |
@@ -20,3 +20,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.languages.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.languages.post | ||
*/ | ||
@@ -29,3 +29,3 @@ addCustomLanguage(request) { | ||
* @param languageId language identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.languages.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.languages.get | ||
*/ | ||
@@ -38,3 +38,3 @@ getLanguage(languageId) { | ||
* @param languageId language identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.languages.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.languages.delete | ||
*/ | ||
@@ -48,3 +48,3 @@ deleteCustomLanguage(languageId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.languages.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.languages.patch | ||
*/ | ||
@@ -51,0 +51,0 @@ editCustomLanguage(languageId, request) { |
@@ -11,3 +11,3 @@ import { CrowdinApi, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core'; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.mts.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.mts.getMany | ||
*/ | ||
@@ -20,3 +20,3 @@ listMts(options?: MachineTranslationModel.ListMTsOptions): Promise<ResponseList<MachineTranslationModel.MachineTranslation>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.mts.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.mts.getMany | ||
*/ | ||
@@ -31,3 +31,3 @@ listMts(groupId?: number, limit?: number, offset?: number): Promise<ResponseList<MachineTranslationModel.MachineTranslation>>; | ||
* @param mtId mt identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.mts.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.mts.getMany | ||
*/ | ||
@@ -49,3 +49,3 @@ getMt(mtId: number): Promise<ResponseObject<MachineTranslationModel.MachineTranslation>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.mts.translations.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.mts.translations.post | ||
*/ | ||
@@ -52,0 +52,0 @@ translate(mtId: number, request: MachineTranslationModel.TranslateRequest): Promise<ResponseObject<MachineTranslationModel.TranslateResponse>>; |
@@ -30,3 +30,3 @@ "use strict"; | ||
* @param mtId mt identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.mts.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.mts.getMany | ||
*/ | ||
@@ -57,3 +57,3 @@ getMt(mtId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.mts.translations.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.mts.translations.post | ||
*/ | ||
@@ -60,0 +60,0 @@ translate(mtId, request) { |
@@ -49,3 +49,3 @@ import { BooleanInt, CrowdinApi, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core'; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.getMany | ||
*/ | ||
@@ -59,3 +59,3 @@ listProjects(options?: ProjectsGroupsModel.ListProjectsOptions): Promise<ResponseList<ProjectsGroupsModel.Project | ProjectsGroupsModel.ProjectSettings>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.getMany | ||
*/ | ||
@@ -65,3 +65,3 @@ listProjects(groupId?: number, hasManagerAccess?: BooleanInt, limit?: number, offset?: number): Promise<ResponseList<ProjectsGroupsModel.Project | ProjectsGroupsModel.ProjectSettings>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.post | ||
*/ | ||
@@ -71,3 +71,3 @@ addProject(request: ProjectsGroupsModel.CreateProjectEnterpriseRequest | ProjectsGroupsModel.FilesBasedCreateProjectRequest | ProjectsGroupsModel.StringsBasedCreateProjectRequest): Promise<ResponseObject<ProjectsGroupsModel.Project | ProjectsGroupsModel.ProjectSettings>>; | ||
* @param projectId project identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.get | ||
*/ | ||
@@ -77,3 +77,3 @@ getProject(projectId: number): Promise<ResponseObject<ProjectsGroupsModel.Project | ProjectsGroupsModel.ProjectSettings>>; | ||
* @param projectId project identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.delete | ||
*/ | ||
@@ -84,3 +84,3 @@ deleteProject(projectId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.patch | ||
*/ | ||
@@ -87,0 +87,0 @@ editProject(projectId: number, request: PatchRequest[]): Promise<ResponseObject<ProjectsGroupsModel.Project | ProjectsGroupsModel.ProjectSettings>>; |
@@ -77,3 +77,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.post | ||
*/ | ||
@@ -86,3 +86,3 @@ addProject(request) { | ||
* @param projectId project identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.get | ||
*/ | ||
@@ -95,3 +95,3 @@ getProject(projectId) { | ||
* @param projectId project identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.delete | ||
*/ | ||
@@ -105,3 +105,3 @@ deleteProject(projectId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.patch | ||
*/ | ||
@@ -108,0 +108,0 @@ editProject(projectId, request) { |
@@ -46,3 +46,3 @@ import { CrowdinApi, DownloadLink, PaginationOptions, PatchRequest, ResponseList, ResponseObject, Status } from '../core'; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.reports.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.reports.post | ||
*/ | ||
@@ -53,3 +53,3 @@ generateReport(projectId: number, request: ReportsModel.GenerateReportRequest): Promise<ResponseObject<Status<ReportsModel.ReportStatusAttributes>>>; | ||
* @param reportId report identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.reports.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.reports.get | ||
*/ | ||
@@ -60,3 +60,3 @@ checkReportStatus(projectId: number, reportId: string): Promise<ResponseObject<Status<ReportsModel.ReportStatusAttributes>>>; | ||
* @param reportId report identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.reports.download.download | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.reports.download.download | ||
*/ | ||
@@ -63,0 +63,0 @@ downloadReport(projectId: number, reportId: string): Promise<ResponseObject<DownloadLink>>; |
@@ -67,3 +67,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.reports.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.reports.post | ||
*/ | ||
@@ -77,3 +77,3 @@ generateReport(projectId, request) { | ||
* @param reportId report identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.reports.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.reports.get | ||
*/ | ||
@@ -87,3 +87,3 @@ checkReportStatus(projectId, reportId) { | ||
* @param reportId report identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.reports.download.download | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.reports.download.download | ||
*/ | ||
@@ -90,0 +90,0 @@ downloadReport(projectId, reportId) { |
@@ -12,3 +12,3 @@ import { CrowdinApi, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core'; | ||
* @param options optional pagination parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.getMany | ||
*/ | ||
@@ -21,3 +21,3 @@ listScreenshots(projectId: number, options?: PaginationOptions): Promise<ResponseList<ScreenshotsModel.Screenshot>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.getMany | ||
*/ | ||
@@ -28,3 +28,3 @@ listScreenshots(projectId: number, limit?: number, offset?: number): Promise<ResponseList<ScreenshotsModel.Screenshot>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.post | ||
*/ | ||
@@ -35,3 +35,3 @@ addScreenshot(projectId: number, request: ScreenshotsModel.CreateScreenshotRequest): Promise<ResponseObject<ScreenshotsModel.Screenshot>>; | ||
* @param screenshotId screenshot identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.get | ||
*/ | ||
@@ -43,3 +43,3 @@ getScreenshot(projectId: number, screenshotId: number): Promise<ResponseObject<ScreenshotsModel.Screenshot>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.put | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.put | ||
*/ | ||
@@ -50,3 +50,3 @@ updateScreenshot(projectId: number, screenshotId: number, request: ScreenshotsModel.CreateScreenshotRequest): Promise<ResponseObject<ScreenshotsModel.Screenshot>>; | ||
* @param screenshotId screenshot identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.delete | ||
*/ | ||
@@ -58,3 +58,3 @@ deleteScreenshot(projectId: number, screenshotId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.patch | ||
*/ | ||
@@ -66,3 +66,3 @@ editScreenshot(projectId: number, screenshotId: number, request: PatchRequest[]): Promise<ResponseObject<ScreenshotsModel.Screenshot>>; | ||
* @param options optional pagination parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.getMany | ||
*/ | ||
@@ -76,3 +76,3 @@ listScreenshotTags(projectId: number, screenshotId: number, options?: PaginationOptions): Promise<ResponseList<ScreenshotsModel.Tag>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.getMany | ||
*/ | ||
@@ -84,3 +84,3 @@ listScreenshotTags(projectId: number, screenshotId: number, limit?: number, offset?: number): Promise<ResponseList<ScreenshotsModel.Tag>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.putMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.putMany | ||
*/ | ||
@@ -92,3 +92,3 @@ replaceTags(projectId: number, screenshotId: number, request: ScreenshotsModel.AddTagRequest[]): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.post | ||
*/ | ||
@@ -99,3 +99,3 @@ addTag(projectId: number, screenshotId: number, request: ScreenshotsModel.AddTagRequest[]): Promise<ResponseObject<ScreenshotsModel.Tag>>; | ||
* @param screenshotId screenshot identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.deleteMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.deleteMany | ||
*/ | ||
@@ -107,3 +107,3 @@ clearTags(projectId: number, screenshotId: number): Promise<void>; | ||
* @param tagId tag identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.get | ||
*/ | ||
@@ -115,3 +115,3 @@ getTag(projectId: number, screenshotId: number, tagId: number): Promise<ResponseObject<ScreenshotsModel.Tag>>; | ||
* @param tagId tag identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.delete | ||
*/ | ||
@@ -124,3 +124,3 @@ deleteTag(projectId: number, screenshotId: number, tagId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.patch | ||
*/ | ||
@@ -127,0 +127,0 @@ updateTag(projectId: number, screenshotId: number, tagId: number, request: PatchRequest[]): Promise<ResponseObject<ScreenshotsModel.Screenshot>>; |
@@ -22,3 +22,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.post | ||
*/ | ||
@@ -32,3 +32,3 @@ addScreenshot(projectId, request) { | ||
* @param screenshotId screenshot identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.get | ||
*/ | ||
@@ -43,3 +43,3 @@ getScreenshot(projectId, screenshotId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.put | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.put | ||
*/ | ||
@@ -53,3 +53,3 @@ updateScreenshot(projectId, screenshotId, request) { | ||
* @param screenshotId screenshot identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.delete | ||
*/ | ||
@@ -64,3 +64,3 @@ deleteScreenshot(projectId, screenshotId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.patch | ||
*/ | ||
@@ -82,3 +82,3 @@ editScreenshot(projectId, screenshotId, request) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.putMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.putMany | ||
*/ | ||
@@ -93,3 +93,3 @@ replaceTags(projectId, screenshotId, request) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.post | ||
*/ | ||
@@ -103,3 +103,3 @@ addTag(projectId, screenshotId, request) { | ||
* @param screenshotId screenshot identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.deleteMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.deleteMany | ||
*/ | ||
@@ -114,3 +114,3 @@ clearTags(projectId, screenshotId) { | ||
* @param tagId tag identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.get | ||
*/ | ||
@@ -125,3 +125,3 @@ getTag(projectId, screenshotId, tagId) { | ||
* @param tagId tag identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.delete | ||
*/ | ||
@@ -137,3 +137,3 @@ deleteTag(projectId, screenshotId, tagId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.patch | ||
*/ | ||
@@ -140,0 +140,0 @@ updateTag(projectId, screenshotId, tagId, request) { |
@@ -12,3 +12,3 @@ import { CrowdinApi, DownloadLink, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core'; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.branches.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.getMany | ||
*/ | ||
@@ -22,3 +22,3 @@ listProjectBranches(projectId: number, options?: SourceFilesModel.ListProjectBranchesOptions): Promise<ResponseList<SourceFilesModel.Branch>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.branches.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.getMany | ||
*/ | ||
@@ -29,3 +29,3 @@ listProjectBranches(projectId: number, name?: string, limit?: number, offset?: number): Promise<ResponseList<SourceFilesModel.Branch>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.branches.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.post | ||
*/ | ||
@@ -36,3 +36,3 @@ createBranch(projectId: number, request: SourceFilesModel.CreateBranchRequest): Promise<ResponseObject<SourceFilesModel.Branch>>; | ||
* @param branchId branch identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.branches.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.get | ||
*/ | ||
@@ -43,3 +43,3 @@ getBranch(projectId: number, branchId: number): Promise<ResponseObject<SourceFilesModel.Branch>>; | ||
* @param branchId branch identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.branches.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.delete | ||
*/ | ||
@@ -51,3 +51,3 @@ deleteBranch(projectId: number, branchId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.branches.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.patch | ||
*/ | ||
@@ -58,3 +58,3 @@ editBranch(projectId: number, branchId: number, request: PatchRequest[]): Promise<ResponseObject<SourceFilesModel.Branch>>; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.directories.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.getMany | ||
*/ | ||
@@ -71,3 +71,3 @@ listProjectDirectories(projectId: number, options?: SourceFilesModel.ListProjectDirectoriesOptions): Promise<ResponseList<SourceFilesModel.Directory>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.directories.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.getMany | ||
*/ | ||
@@ -78,3 +78,3 @@ listProjectDirectories(projectId: number, branchId?: number, directoryId?: number, limit?: number, offset?: number, filter?: string, recursion?: string): Promise<ResponseList<SourceFilesModel.Directory>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.directories.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.post | ||
*/ | ||
@@ -85,3 +85,3 @@ createDirectory(projectId: number, request: SourceFilesModel.CreateDirectoryRequest): Promise<ResponseObject<SourceFilesModel.Directory>>; | ||
* @param directoryId directory identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.directories.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.get | ||
*/ | ||
@@ -92,3 +92,3 @@ getDirectory(projectId: number, directoryId: number): Promise<ResponseObject<SourceFilesModel.Directory>>; | ||
* @param directoryId directory identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.directories.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.delete | ||
*/ | ||
@@ -100,3 +100,3 @@ deleteDirectory(projectId: number, directoryId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.directories.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.patch | ||
*/ | ||
@@ -107,3 +107,3 @@ editDirectory(projectId: number, directoryId: number, request: PatchRequest[]): Promise<ResponseObject<SourceFilesModel.Directory>>; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.getMany | ||
*/ | ||
@@ -120,3 +120,3 @@ listProjectFiles(projectId: number, options?: SourceFilesModel.ListProjectFilesOptions): Promise<ResponseList<SourceFilesModel.File>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.getMany | ||
*/ | ||
@@ -127,3 +127,3 @@ listProjectFiles(projectId: number, branchId?: number, directoryId?: number, limit?: number, offset?: number, recursion?: any, filter?: string): Promise<ResponseList<SourceFilesModel.File>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.post | ||
*/ | ||
@@ -134,3 +134,3 @@ createFile(projectId: number, request: SourceFilesModel.CreateFileRequest): Promise<ResponseObject<SourceFilesModel.File>>; | ||
* @param fileId file identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.get | ||
*/ | ||
@@ -142,3 +142,3 @@ getFile(projectId: number, fileId: number): Promise<ResponseObject<SourceFilesModel.File>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.put | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.put | ||
*/ | ||
@@ -149,3 +149,3 @@ updateOrRestoreFile(projectId: number, fileId: number, request: SourceFilesModel.ReplaceFileFromStorageRequest | SourceFilesModel.RestoreFile): Promise<ResponseObject<SourceFilesModel.File>>; | ||
* @param fileId file identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.delete | ||
*/ | ||
@@ -157,3 +157,3 @@ deleteFile(projectId: number, fileId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.patch | ||
*/ | ||
@@ -164,3 +164,3 @@ editFile(projectId: number, fileId: number, request: PatchRequest[]): Promise<ResponseObject<SourceFilesModel.File>>; | ||
* @param fileId file identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.download.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.download.get | ||
*/ | ||
@@ -172,3 +172,3 @@ downloadFile(projectId: number, fileId: number): Promise<ResponseObject<DownloadLink>>; | ||
* @param options optional pagination parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.revisions.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.revisions.getMany | ||
*/ | ||
@@ -182,3 +182,3 @@ listFileRevisions(projectId: number, fileId: number, options?: PaginationOptions): Promise<ResponseList<SourceFilesModel.FileRevision>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.revisions.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.revisions.getMany | ||
*/ | ||
@@ -190,3 +190,3 @@ listFileRevisions(projectId: number, fileId: number, limit?: number, offset?: number): Promise<ResponseList<SourceFilesModel.FileRevision>>; | ||
* @param revisionId revision identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.revisions.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.revisions.get | ||
*/ | ||
@@ -193,0 +193,0 @@ getFileRevision(projectId: number, fileId: number, revisionId: number): Promise<ResponseObject<SourceFilesModel.FileRevision>>; |
@@ -23,3 +23,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.branches.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.post | ||
*/ | ||
@@ -33,3 +33,3 @@ createBranch(projectId, request) { | ||
* @param branchId branch identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.branches.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.get | ||
*/ | ||
@@ -43,3 +43,3 @@ getBranch(projectId, branchId) { | ||
* @param branchId branch identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.branches.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.delete | ||
*/ | ||
@@ -54,3 +54,3 @@ deleteBranch(projectId, branchId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.branches.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.patch | ||
*/ | ||
@@ -82,3 +82,3 @@ editBranch(projectId, branchId, request) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.directories.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.post | ||
*/ | ||
@@ -92,3 +92,3 @@ createDirectory(projectId, request) { | ||
* @param directoryId directory identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.directories.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.get | ||
*/ | ||
@@ -102,3 +102,3 @@ getDirectory(projectId, directoryId) { | ||
* @param directoryId directory identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.directories.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.delete | ||
*/ | ||
@@ -113,3 +113,3 @@ deleteDirectory(projectId, directoryId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.directories.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.patch | ||
*/ | ||
@@ -141,3 +141,3 @@ editDirectory(projectId, directoryId, request) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.post | ||
*/ | ||
@@ -151,3 +151,3 @@ createFile(projectId, request) { | ||
* @param fileId file identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.get | ||
*/ | ||
@@ -162,3 +162,3 @@ getFile(projectId, fileId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.put | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.put | ||
*/ | ||
@@ -172,3 +172,3 @@ updateOrRestoreFile(projectId, fileId, request) { | ||
* @param fileId file identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.delete | ||
*/ | ||
@@ -183,3 +183,3 @@ deleteFile(projectId, fileId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.patch | ||
*/ | ||
@@ -193,3 +193,3 @@ editFile(projectId, fileId, request) { | ||
* @param fileId file identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.download.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.download.get | ||
*/ | ||
@@ -211,3 +211,3 @@ downloadFile(projectId, fileId) { | ||
* @param revisionId revision identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.revisions.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.revisions.get | ||
*/ | ||
@@ -214,0 +214,0 @@ getFileRevision(projectId, fileId, revisionId) { |
@@ -11,3 +11,3 @@ import { BooleanInt, CrowdinApi, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core'; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.strings.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.strings.getMany | ||
*/ | ||
@@ -28,3 +28,3 @@ listProjectStrings(projectId: number, options?: SourceStringsModel.ListProjectStringsOptions): Promise<ResponseList<SourceStringsModel.String>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.strings.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.strings.getMany | ||
*/ | ||
@@ -35,3 +35,3 @@ listProjectStrings(projectId: number, fileId?: number, limit?: number, offset?: number, filter?: string, denormalizePlaceholders?: BooleanInt, labelIds?: string, scope?: SourceStringsModel.Scope, croql?: string, branchId?: number, directoryId?: number): Promise<ResponseList<SourceStringsModel.String>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.strings.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.strings.post | ||
*/ | ||
@@ -42,3 +42,3 @@ addString(projectId: number, request: SourceStringsModel.CreateStringRequest): Promise<ResponseObject<SourceStringsModel.String>>; | ||
* @param stringId string identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.strings.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.strings.get | ||
*/ | ||
@@ -49,3 +49,3 @@ getString(projectId: number, stringId: number): Promise<ResponseObject<SourceStringsModel.String>>; | ||
* @param stringId string identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.strings.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.strings.delete | ||
*/ | ||
@@ -57,3 +57,3 @@ deleteString(projectId: number, stringId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.strings.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.strings.patch | ||
*/ | ||
@@ -60,0 +60,0 @@ editString(projectId: number, stringId: number, request: PatchRequest[]): Promise<ResponseObject<SourceStringsModel.String>>; |
@@ -40,3 +40,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.strings.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.strings.post | ||
*/ | ||
@@ -50,3 +50,3 @@ addString(projectId, request) { | ||
* @param stringId string identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.strings.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.strings.get | ||
*/ | ||
@@ -60,3 +60,3 @@ getString(projectId, stringId) { | ||
* @param stringId string identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.strings.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.strings.delete | ||
*/ | ||
@@ -71,3 +71,3 @@ deleteString(projectId, stringId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.strings.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.strings.patch | ||
*/ | ||
@@ -74,0 +74,0 @@ editString(projectId, stringId, request) { |
@@ -9,3 +9,3 @@ import { CrowdinApi, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core'; | ||
* @param options optional parameters for the requesr | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.comments.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.comments.getMany | ||
*/ | ||
@@ -21,3 +21,3 @@ listStringComments(projectId: number, options?: StringCommentsModel.ListStringCommentsOptions): Promise<ResponseList<StringCommentsModel.StringComment>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.comments.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.comments.getMany | ||
*/ | ||
@@ -28,3 +28,3 @@ listStringComments(projectId: number, stringId?: number, type?: StringCommentsModel.Type, targetLanguageId?: string, issueType?: StringCommentsModel.IssueType, issueStatus?: StringCommentsModel.IssueStatus): Promise<ResponseList<StringCommentsModel.StringComment>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.comments.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.comments.post | ||
*/ | ||
@@ -35,3 +35,3 @@ addStringComment(projectId: number, request: StringCommentsModel.AddStringCommentRequest): Promise<ResponseObject<StringCommentsModel.StringComment>>; | ||
* @param stringCommentId string comment identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.comments.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.comments.get | ||
*/ | ||
@@ -42,3 +42,3 @@ getStringComment(projectId: number, stringCommentId: number): Promise<ResponseObject<StringCommentsModel.StringComment>>; | ||
* @param stringCommentId string comment identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.comments.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.comments.delete | ||
*/ | ||
@@ -50,3 +50,3 @@ deleteStringComment(projectId: number, stringCommentId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.comments.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.comments.patch | ||
*/ | ||
@@ -53,0 +53,0 @@ editStringComment(projectId: number, stringCommentId: number, request: PatchRequest[]): Promise<ResponseObject<StringCommentsModel.StringComment>>; |
@@ -30,3 +30,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.comments.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.comments.post | ||
*/ | ||
@@ -40,3 +40,3 @@ addStringComment(projectId, request) { | ||
* @param stringCommentId string comment identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.comments.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.comments.get | ||
*/ | ||
@@ -50,3 +50,3 @@ getStringComment(projectId, stringCommentId) { | ||
* @param stringCommentId string comment identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.comments.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.comments.delete | ||
*/ | ||
@@ -61,3 +61,3 @@ deleteStringComment(projectId, stringCommentId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.comments.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.comments.patch | ||
*/ | ||
@@ -64,0 +64,0 @@ editStringComment(projectId, stringCommentId, request) { |
@@ -9,3 +9,3 @@ import { BooleanInt, CrowdinApi, PaginationOptions, ResponseList, ResponseObject } from '../core'; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.approvals.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.approvals.getMany | ||
*/ | ||
@@ -22,3 +22,3 @@ listTranslationApprovals(projectId: number, options?: StringTranslationsModel.ListTranslationApprovalsOptions): Promise<ResponseList<StringTranslationsModel.Approval>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.approvals.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.approvals.getMany | ||
*/ | ||
@@ -29,3 +29,3 @@ listTranslationApprovals(projectId: number, stringId?: number, languageId?: string, translationId?: number, limit?: number, offset?: number, fileId?: number): Promise<ResponseList<StringTranslationsModel.Approval>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.approvals.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.approvals.post | ||
*/ | ||
@@ -36,3 +36,3 @@ addApproval(projectId: number, request: StringTranslationsModel.AddApprovalRequest): Promise<ResponseObject<StringTranslationsModel.Approval>>; | ||
* @param approvalId approval identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.approvals.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.approvals.get | ||
*/ | ||
@@ -43,3 +43,3 @@ approvalInfo(projectId: number, approvalId: number): Promise<ResponseObject<StringTranslationsModel.Approval>>; | ||
* @param approvalId approval identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.approvals.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.approvals.delete | ||
*/ | ||
@@ -51,3 +51,3 @@ removeApproval(projectId: number, approvalId: number): Promise<void>; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.languages.translations.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.languages.translations.getMany | ||
*/ | ||
@@ -66,3 +66,3 @@ listLanguageTranslations(projectId: number, languageId: string, options?: StringTranslationsModel.ListLanguageTranslationsOptions): Promise<ResponseList<StringTranslationsModel.PlainLanguageTranslation | StringTranslationsModel.PluralLanguageTranslation | StringTranslationsModel.IcuLanguageTranslation>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.languages.translations.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.languages.translations.getMany | ||
*/ | ||
@@ -75,3 +75,3 @@ listLanguageTranslations(projectId: number, languageId: string, stringIds?: string, fileId?: number, limit?: number, offset?: number, labelIds?: string, denormalizePlaceholders?: BooleanInt, croql?: string): Promise<ResponseList<StringTranslationsModel.PlainLanguageTranslation | StringTranslationsModel.PluralLanguageTranslation | StringTranslationsModel.IcuLanguageTranslation>>; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.getMany | ||
*/ | ||
@@ -87,3 +87,3 @@ listStringTranslations(projectId: number, stringId: number, languageId: string, options?: StringTranslationsModel.ListStringTranslationsOptions): Promise<ResponseList<StringTranslationsModel.StringTranslation>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.getMany | ||
*/ | ||
@@ -94,3 +94,3 @@ listStringTranslations(projectId: number, stringId: number, languageId: string, limit?: number, offset?: number, denormalizePlaceholders?: BooleanInt): Promise<ResponseList<StringTranslationsModel.StringTranslation>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.post | ||
*/ | ||
@@ -102,3 +102,3 @@ addTranslation(projectId: number, request: StringTranslationsModel.AddStringTranslationRequest): Promise<ResponseObject<StringTranslationsModel.StringTranslation>>; | ||
* @param languageId language identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.deleteMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.deleteMany | ||
*/ | ||
@@ -109,3 +109,3 @@ deleteAllTranslations(projectId: number, stringId: number, languageId: string): Promise<void>; | ||
* @param translationId translation identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.get | ||
*/ | ||
@@ -116,3 +116,3 @@ translationInfo(projectId: number, translationId: number): Promise<ResponseObject<StringTranslationsModel.StringTranslation>>; | ||
* @param translation translation identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.put | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.put | ||
*/ | ||
@@ -123,3 +123,3 @@ restoreTranslation(projectId: number, translationId: number): Promise<ResponseObject<StringTranslationsModel.StringTranslation>>; | ||
* @param translation translation identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.delete | ||
*/ | ||
@@ -130,3 +130,3 @@ deleteTranslation(projectId: number, translationId: number): Promise<void>; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.votes.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.votes.getMany | ||
*/ | ||
@@ -142,3 +142,3 @@ listTranslationVotes(projectId: number, options?: StringTranslationsModel.ListTranslationVotesOptions): Promise<ResponseList<StringTranslationsModel.Vote>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.votes.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.votes.getMany | ||
*/ | ||
@@ -149,3 +149,3 @@ listTranslationVotes(projectId: number, stringId?: number, languageId?: string, translationId?: number, limit?: number, offset?: number): Promise<ResponseList<StringTranslationsModel.Vote>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.votes.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.votes.post | ||
*/ | ||
@@ -156,3 +156,3 @@ addVote(projectId: number, request: StringTranslationsModel.AddVoteRequest): Promise<ResponseObject<StringTranslationsModel.Vote>>; | ||
* @param voteId vote identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.votes.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.votes.get | ||
*/ | ||
@@ -163,3 +163,3 @@ voteInfo(projectId: number, voteId: number): Promise<ResponseObject<StringTranslationsModel.Vote>>; | ||
* @param voteId vote identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.votes.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.votes.delete | ||
*/ | ||
@@ -166,0 +166,0 @@ cancelVote(projectId: number, voteId: number): Promise<void>; |
@@ -30,3 +30,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.approvals.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.approvals.post | ||
*/ | ||
@@ -40,3 +40,3 @@ addApproval(projectId, request) { | ||
* @param approvalId approval identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.approvals.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.approvals.get | ||
*/ | ||
@@ -50,3 +50,3 @@ approvalInfo(projectId, approvalId) { | ||
* @param approvalId approval identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.approvals.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.approvals.delete | ||
*/ | ||
@@ -94,3 +94,3 @@ removeApproval(projectId, approvalId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.post | ||
*/ | ||
@@ -105,3 +105,3 @@ addTranslation(projectId, request) { | ||
* @param languageId language identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.deleteMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.deleteMany | ||
*/ | ||
@@ -117,3 +117,3 @@ deleteAllTranslations(projectId, stringId, languageId) { | ||
* @param translationId translation identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.get | ||
*/ | ||
@@ -127,3 +127,3 @@ translationInfo(projectId, translationId) { | ||
* @param translation translation identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.put | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.put | ||
*/ | ||
@@ -137,3 +137,3 @@ restoreTranslation(projectId, translationId) { | ||
* @param translation translation identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.delete | ||
*/ | ||
@@ -163,3 +163,3 @@ deleteTranslation(projectId, translationId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.votes.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.votes.post | ||
*/ | ||
@@ -173,3 +173,3 @@ addVote(projectId, request) { | ||
* @param voteId vote identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.votes.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.votes.get | ||
*/ | ||
@@ -183,3 +183,3 @@ voteInfo(projectId, voteId) { | ||
* @param voteId vote identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.votes.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.votes.delete | ||
*/ | ||
@@ -186,0 +186,0 @@ cancelVote(projectId, voteId) { |
@@ -13,3 +13,3 @@ import { BooleanInt, CrowdinApi, DownloadLink, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core'; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.tasks.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.getMany | ||
*/ | ||
@@ -23,3 +23,3 @@ listTasks(projectId: number, options?: TasksModel.ListTasksOptions): Promise<ResponseList<TasksModel.Task>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.tasks.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.getMany | ||
*/ | ||
@@ -30,3 +30,3 @@ listTasks(projectId: number, limit?: number, offset?: number, status?: TasksModel.Status): Promise<ResponseList<TasksModel.Task>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.tasks.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.post | ||
*/ | ||
@@ -37,3 +37,3 @@ addTask(projectId: number, request: TasksModel.CreateTaskEnterpriseRequest | TasksModel.CreateTaskRequest | TasksModel.CreateTaskVendorOhtRequest | TasksModel.CreateTaskVendorGengoRequest | TasksModel.CreateTaskVendorTranslatedRequest): Promise<ResponseObject<TasksModel.Task>>; | ||
* @param taskId task identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.tasks.exports.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.exports.post | ||
*/ | ||
@@ -44,3 +44,3 @@ exportTaskStrings(projectId: number, taskId: number): Promise<ResponseObject<DownloadLink>>; | ||
* @param taskId task identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.tasks.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.get | ||
*/ | ||
@@ -51,3 +51,3 @@ getTask(projectId: number, taskId: number): Promise<ResponseObject<TasksModel.Task>>; | ||
* @param taskId task identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.tasks.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.delete | ||
*/ | ||
@@ -59,3 +59,3 @@ deleteTask(projectId: number, taskId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.tasks.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.patch | ||
*/ | ||
@@ -65,3 +65,3 @@ editTask(projectId: number, taskId: number, request: PatchRequest[]): Promise<ResponseObject<TasksModel.Task>>; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.user.tasks.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.user.tasks.getMany | ||
*/ | ||
@@ -75,3 +75,3 @@ listUserTasks(options?: TasksModel.ListUserTasksOptions): Promise<ResponseList<TasksModel.UserTask>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.user.tasks.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.user.tasks.getMany | ||
*/ | ||
@@ -83,5 +83,36 @@ listUserTasks(limit?: number, offset?: number, status?: TasksModel.Status, isArchived?: BooleanInt): Promise<ResponseList<TasksModel.UserTask>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.user.tasks.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.user.tasks.patch | ||
*/ | ||
editTaskArchivedStatus(projectId: number, taskId: number, request: PatchRequest[]): Promise<ResponseObject<TasksModel.UserTask>>; | ||
/** | ||
* @param projectId project identifier | ||
* @param options optional parameters for the request | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.settings-templates.getMany | ||
*/ | ||
listTaskSettingsTemplates(projectId: number, options?: PaginationOptions): Promise<ResponseList<TasksModel.TaskSettingsTemplate>>; | ||
/** | ||
* @param projectId project identifier | ||
* @param request request body | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.settings-templates.post | ||
*/ | ||
addTaskSettingsTemplate(projectId: number, request: TasksModel.AddTaskSettingsTemplate): Promise<ResponseObject<TasksModel.TaskSettingsTemplate>>; | ||
/** | ||
* @param projectId project identifier | ||
* @param taskSettingsId task settings identifier | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.settings-templates.get | ||
*/ | ||
getTaskSettingsTemplate(projectId: number, taskSettingsId: number): Promise<ResponseObject<TasksModel.TaskSettingsTemplate>>; | ||
/** | ||
* @param projectId project identifier | ||
* @param taskSettingsId task settings identifier | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.settings-templates.delete | ||
*/ | ||
deleteTaskSettingsTemplate(projectId: number, taskSettingsId: number): Promise<void>; | ||
/** | ||
* @param projectId project identifier | ||
* @param taskSettingsId task settings identifier | ||
* @param request request body | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.settings-templates.patch | ||
*/ | ||
editTaskSettingsTemplate(projectId: number, taskSettingsId: number, request: PatchRequest[]): Promise<ResponseObject<TasksModel.TaskSettingsTemplate>>; | ||
} | ||
@@ -235,2 +266,20 @@ export declare namespace TasksModel { | ||
} | ||
interface TaskSettingsTemplate { | ||
id: number; | ||
name: string; | ||
config: TaskSettingsTemplateConfig; | ||
createdAt: string; | ||
updatedAt: string; | ||
} | ||
interface AddTaskSettingsTemplate { | ||
name: string; | ||
config: TaskSettingsTemplateConfig; | ||
} | ||
interface TaskSettingsTemplateConfig { | ||
languages: { | ||
languageId: string; | ||
userIds: number[]; | ||
teamIds?: number[]; | ||
}[]; | ||
} | ||
} |
@@ -24,3 +24,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.tasks.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.post | ||
*/ | ||
@@ -34,3 +34,3 @@ addTask(projectId, request) { | ||
* @param taskId task identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.tasks.exports.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.exports.post | ||
*/ | ||
@@ -44,3 +44,3 @@ exportTaskStrings(projectId, taskId) { | ||
* @param taskId task identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.tasks.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.get | ||
*/ | ||
@@ -54,3 +54,3 @@ getTask(projectId, taskId) { | ||
* @param taskId task identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.tasks.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.delete | ||
*/ | ||
@@ -65,3 +65,3 @@ deleteTask(projectId, taskId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.tasks.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.patch | ||
*/ | ||
@@ -90,3 +90,3 @@ editTask(projectId, taskId, request) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.user.tasks.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.user.tasks.patch | ||
*/ | ||
@@ -98,2 +98,48 @@ editTaskArchivedStatus(projectId, taskId, request) { | ||
} | ||
/** | ||
* @param projectId project identifier | ||
* @param options optional parameters for the request | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.settings-templates.getMany | ||
*/ | ||
listTaskSettingsTemplates(projectId, options) { | ||
const url = `${this.url}/projects/${projectId}/tasks/settings-templates`; | ||
return this.getList(url, options === null || options === void 0 ? void 0 : options.limit, options === null || options === void 0 ? void 0 : options.offset); | ||
} | ||
/** | ||
* @param projectId project identifier | ||
* @param request request body | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.settings-templates.post | ||
*/ | ||
addTaskSettingsTemplate(projectId, request) { | ||
const url = `${this.url}/projects/${projectId}/tasks/settings-templates`; | ||
return this.post(url, request, this.defaultConfig()); | ||
} | ||
/** | ||
* @param projectId project identifier | ||
* @param taskSettingsId task settings identifier | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.settings-templates.get | ||
*/ | ||
getTaskSettingsTemplate(projectId, taskSettingsId) { | ||
const url = `${this.url}/projects/${projectId}/tasks/settings-templates/${taskSettingsId}`; | ||
return this.get(url, this.defaultConfig()); | ||
} | ||
/** | ||
* @param projectId project identifier | ||
* @param taskSettingsId task settings identifier | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.settings-templates.delete | ||
*/ | ||
deleteTaskSettingsTemplate(projectId, taskSettingsId) { | ||
const url = `${this.url}/projects/${projectId}/tasks/settings-templates/${taskSettingsId}`; | ||
return this.delete(url, this.defaultConfig()); | ||
} | ||
/** | ||
* @param projectId project identifier | ||
* @param taskSettingsId task settings identifier | ||
* @param request request body | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.tasks.settings-templates.patch | ||
*/ | ||
editTaskSettingsTemplate(projectId, taskSettingsId, request) { | ||
const url = `${this.url}/projects/${projectId}/tasks/settings-templates/${taskSettingsId}`; | ||
return this.patch(url, request, this.defaultConfig()); | ||
} | ||
} | ||
@@ -100,0 +146,0 @@ exports.Tasks = Tasks; |
@@ -1,2 +0,2 @@ | ||
import { CrowdinApi, Pagination, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core'; | ||
import { CrowdinApi, Pagination, PaginationOptions, PatchRequest, ProjectRole, ResponseList, ResponseObject } from '../core'; | ||
export declare class Teams extends CrowdinApi { | ||
@@ -77,5 +77,12 @@ /** | ||
teamId: number; | ||
/** | ||
* @deprecated | ||
*/ | ||
accessToAllWorkflowSteps?: boolean; | ||
managerAccess?: boolean; | ||
permissions?: any; | ||
/** | ||
* @deprecated | ||
*/ | ||
permissions?: Permissions; | ||
roles?: ProjectRole[]; | ||
} | ||
@@ -89,5 +96,17 @@ interface ProjectTeamResources { | ||
hasManagerAccess: boolean; | ||
/** | ||
* @deprecated | ||
*/ | ||
hasAccessToAllWorkflowSteps: boolean; | ||
permissions: any; | ||
/** | ||
* @deprecated | ||
*/ | ||
permissions: Permissions; | ||
roles: ProjectRole[]; | ||
} | ||
interface Permissions { | ||
[lang: string]: { | ||
workflowStepIds: number[] | 'all'; | ||
}; | ||
} | ||
interface Team { | ||
@@ -94,0 +113,0 @@ id: number; |
@@ -13,3 +13,3 @@ import { CrowdinApi, DownloadLink, PaginationOptions, PatchRequest, ResponseList, ResponseObject, Status } from '../core'; | ||
* @param options optional paramerers for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.getMany | ||
*/ | ||
@@ -22,3 +22,3 @@ listTm(options?: TranslationMemoryModel.ListTMsOptions): Promise<ResponseList<TranslationMemoryModel.TranslationMemory>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.getMany | ||
*/ | ||
@@ -28,3 +28,3 @@ listTm(groupId?: number, limit?: number, offset?: number): Promise<ResponseList<TranslationMemoryModel.TranslationMemory>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.post | ||
*/ | ||
@@ -34,3 +34,3 @@ addTm(request: TranslationMemoryModel.AddTranslationMemoryRequest): Promise<ResponseObject<TranslationMemoryModel.TranslationMemory>>; | ||
* @param tmId tm identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.get | ||
*/ | ||
@@ -40,3 +40,3 @@ getTm(tmId: number): Promise<ResponseObject<TranslationMemoryModel.TranslationMemory>>; | ||
* @param tmId tm identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.delete | ||
*/ | ||
@@ -47,3 +47,3 @@ deleteTm(tmId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.patch | ||
*/ | ||
@@ -53,3 +53,3 @@ editTm(tmId: number, request: PatchRequest[]): Promise<ResponseObject<TranslationMemoryModel.TranslationMemory>>; | ||
* @param tmId tm identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.segments.clear | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.segments.clear | ||
*/ | ||
@@ -60,3 +60,3 @@ clearTm(tmId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.exports.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.exports.post | ||
*/ | ||
@@ -67,3 +67,3 @@ exportTm(tmId: number, request?: TranslationMemoryModel.ExportTranslationMemoryRequest): Promise<ResponseObject<Status<TranslationMemoryModel.ExportTranslationMemoryAttribute>>>; | ||
* @param exportId export identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.exports.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.exports.get | ||
*/ | ||
@@ -74,3 +74,3 @@ checkExportStatus(tmId: number, exportId: string): Promise<ResponseObject<Status<TranslationMemoryModel.ExportTranslationMemoryAttribute>>>; | ||
* @param exportId export identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.exports.download.download | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.exports.download.download | ||
*/ | ||
@@ -81,3 +81,3 @@ downloadTm(tmId: number, exportId: string): Promise<ResponseObject<DownloadLink>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.imports.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.imports.post | ||
*/ | ||
@@ -88,3 +88,3 @@ importTm(tmId: number, request: TranslationMemoryModel.ImportTranslationMemoryRequest): Promise<ResponseObject<Status<TranslationMemoryModel.ImportTranslationMemoryAttribute>>>; | ||
* @param importId import identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.imports.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.imports.get | ||
*/ | ||
@@ -91,0 +91,0 @@ checkImportStatus(tmId: number, importId: string): Promise<ResponseObject<Status<TranslationMemoryModel.ImportTranslationMemoryAttribute>>>; |
@@ -24,3 +24,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.post | ||
*/ | ||
@@ -33,3 +33,3 @@ addTm(request) { | ||
* @param tmId tm identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.get | ||
*/ | ||
@@ -42,3 +42,3 @@ getTm(tmId) { | ||
* @param tmId tm identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.delete | ||
*/ | ||
@@ -52,3 +52,3 @@ deleteTm(tmId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.patch | ||
*/ | ||
@@ -61,3 +61,3 @@ editTm(tmId, request) { | ||
* @param tmId tm identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.segments.clear | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.segments.clear | ||
*/ | ||
@@ -71,3 +71,3 @@ clearTm(tmId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.exports.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.exports.post | ||
*/ | ||
@@ -81,3 +81,3 @@ exportTm(tmId, request = {}) { | ||
* @param exportId export identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.exports.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.exports.get | ||
*/ | ||
@@ -91,3 +91,3 @@ checkExportStatus(tmId, exportId) { | ||
* @param exportId export identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.exports.download.download | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.exports.download.download | ||
*/ | ||
@@ -101,3 +101,3 @@ downloadTm(tmId, exportId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.imports.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.imports.post | ||
*/ | ||
@@ -111,3 +111,3 @@ importTm(tmId, request) { | ||
* @param importId import identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.tms.imports.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.tms.imports.get | ||
*/ | ||
@@ -114,0 +114,0 @@ checkImportStatus(tmId, importId) { |
@@ -12,3 +12,3 @@ import { CrowdinApi, DownloadLink, PaginationOptions, ResponseList, ResponseObject, Status } from '../core'; | ||
* @param preTranslationId pre translation identifier | ||
* @see https://support.crowdin.com/api/v2/#tag/Translations/paths/~1projects~1{projectId}~1pre-translations~1{preTranslationId}/get | ||
* @see https://developer.crowdin.com/api/v2/#tag/Translations/paths/~1projects~1{projectId}~1pre-translations~1{preTranslationId}/get | ||
*/ | ||
@@ -19,3 +19,3 @@ preTranslationStatus(projectId: number, preTranslationId: string): Promise<ResponseObject<Status<TranslationsModel.PreTranslationStatusAttributes>>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.pre-translations.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.pre-translations.post | ||
*/ | ||
@@ -27,3 +27,3 @@ applyPreTranslation(projectId: number, request: TranslationsModel.PreTranslateRequest): Promise<ResponseObject<Status<TranslationsModel.PreTranslationStatusAttributes>>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.builds.directories.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.directories.post | ||
*/ | ||
@@ -36,3 +36,3 @@ buildProjectDirectoryTranslation(projectId: number, directoryId: number, request?: TranslationsModel.BuildProjectDirectoryTranslationRequest): Promise<ResponseObject<TranslationsModel.BuildProjectDirectoryTranslationResponse>>; | ||
* @param eTag 'If-None-Match' header | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.builds.files.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.files.post | ||
*/ | ||
@@ -43,3 +43,3 @@ buildProjectFileTranslation(projectId: number, fileId: number, request: TranslationsModel.BuildProjectFileTranslationRequest, eTag?: string): Promise<ResponseObject<TranslationsModel.BuildProjectFileTranslationResponse>>; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.builds.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.getMany | ||
*/ | ||
@@ -53,3 +53,3 @@ listProjectBuilds(projectId: number, options?: TranslationsModel.ListProjectBuildsOptions): Promise<ResponseList<TranslationsModel.Build>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.builds.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.getMany | ||
*/ | ||
@@ -60,3 +60,3 @@ listProjectBuilds(projectId: number, branchId?: number, limit?: number, offset?: number): Promise<ResponseList<TranslationsModel.Build>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.builds.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.post | ||
*/ | ||
@@ -68,3 +68,3 @@ buildProject(projectId: number, request?: TranslationsModel.BuildRequest | TranslationsModel.PseudoBuildRequest): Promise<ResponseObject<TranslationsModel.Build>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.postOnLanguage | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.postOnLanguage | ||
*/ | ||
@@ -75,3 +75,3 @@ uploadTranslation(projectId: number, languageId: string, request: TranslationsModel.UploadTranslationRequest): Promise<ResponseObject<TranslationsModel.UploadTranslationResponse>>; | ||
* @param buildId build identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.builds.download.download | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.download.download | ||
*/ | ||
@@ -82,3 +82,3 @@ downloadTranslations(projectId: number, buildId: number): Promise<ResponseObject<DownloadLink>>; | ||
* @param buildId build identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.builds.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.get | ||
*/ | ||
@@ -89,3 +89,3 @@ checkBuildStatus(projectId: number, buildId: number): Promise<ResponseObject<TranslationsModel.Build>>; | ||
* @param buildId build identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.builds.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.delete | ||
*/ | ||
@@ -96,3 +96,3 @@ cancelBuild(projectId: number, buildId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.exports.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.exports.post | ||
*/ | ||
@@ -99,0 +99,0 @@ exportProjectTranslation(projectId: number, request: TranslationsModel.ExportProjectTranslationRequest): Promise<ResponseObject<DownloadLink>>; |
@@ -15,3 +15,3 @@ "use strict"; | ||
* @param preTranslationId pre translation identifier | ||
* @see https://support.crowdin.com/api/v2/#tag/Translations/paths/~1projects~1{projectId}~1pre-translations~1{preTranslationId}/get | ||
* @see https://developer.crowdin.com/api/v2/#tag/Translations/paths/~1projects~1{projectId}~1pre-translations~1{preTranslationId}/get | ||
*/ | ||
@@ -25,3 +25,3 @@ preTranslationStatus(projectId, preTranslationId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.pre-translations.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.pre-translations.post | ||
*/ | ||
@@ -36,3 +36,3 @@ applyPreTranslation(projectId, request) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.builds.directories.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.directories.post | ||
*/ | ||
@@ -49,3 +49,3 @@ buildProjectDirectoryTranslation(projectId, directoryId, request = {}) { | ||
* @param eTag 'If-None-Match' header | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.builds.files.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.files.post | ||
*/ | ||
@@ -71,3 +71,3 @@ buildProjectFileTranslation(projectId, fileId, request, eTag) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.builds.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.post | ||
*/ | ||
@@ -82,3 +82,3 @@ buildProject(projectId, request = {}) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.postOnLanguage | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.postOnLanguage | ||
*/ | ||
@@ -92,3 +92,3 @@ uploadTranslation(projectId, languageId, request) { | ||
* @param buildId build identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.builds.download.download | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.download.download | ||
*/ | ||
@@ -102,3 +102,3 @@ downloadTranslations(projectId, buildId) { | ||
* @param buildId build identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.builds.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.get | ||
*/ | ||
@@ -112,3 +112,3 @@ checkBuildStatus(projectId, buildId) { | ||
* @param buildId build identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.builds.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.delete | ||
*/ | ||
@@ -122,3 +122,3 @@ cancelBuild(projectId, buildId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.translations.exports.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.translations.exports.post | ||
*/ | ||
@@ -125,0 +125,0 @@ exportProjectTranslation(projectId, request) { |
@@ -12,3 +12,3 @@ import { CrowdinApi, PaginationOptions, ResponseList } from '../core'; | ||
* @param options optional pagination parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.branches.languages.progress.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.languages.progress.getMany | ||
*/ | ||
@@ -22,3 +22,3 @@ getBranchProgress(projectId: number, branchId: number, options?: PaginationOptions): Promise<ResponseList<TranslationStatusModel.LanguageProgress>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.branches.languages.progress.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.branches.languages.progress.getMany | ||
*/ | ||
@@ -30,3 +30,3 @@ getBranchProgress(projectId: number, branchId: number, limit?: number, offset?: number): Promise<ResponseList<TranslationStatusModel.LanguageProgress>>; | ||
* @param options optional pagination parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.directories.languages.progress.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.languages.progress.getMany | ||
*/ | ||
@@ -40,3 +40,3 @@ getDirectoryProgress(projectId: number, directoryId: number, options?: PaginationOptions): Promise<ResponseList<TranslationStatusModel.LanguageProgress>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.directories.languages.progress.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.directories.languages.progress.getMany | ||
*/ | ||
@@ -48,3 +48,3 @@ getDirectoryProgress(projectId: number, directoryId: number, limit?: number, offset?: number): Promise<ResponseList<TranslationStatusModel.LanguageProgress>>; | ||
* @param options optional pagination parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.languages.progress.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.languages.progress.getMany | ||
*/ | ||
@@ -58,3 +58,3 @@ getFileProgress(projectId: number, fileId: number, options?: PaginationOptions): Promise<ResponseList<TranslationStatusModel.LanguageProgress>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.files.languages.progress.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.files.languages.progress.getMany | ||
*/ | ||
@@ -66,3 +66,3 @@ getFileProgress(projectId: number, fileId: number, limit?: number, offset?: number): Promise<ResponseList<TranslationStatusModel.LanguageProgress>>; | ||
* @param options optional pagination parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.languages.files.progress.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.languages.files.progress.getMany | ||
*/ | ||
@@ -76,3 +76,3 @@ getLanguageProgress(projectId: number, languageId: string, options?: PaginationOptions): Promise<ResponseList<TranslationStatusModel.FileProgress>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.languages.files.progress.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.languages.files.progress.getMany | ||
*/ | ||
@@ -83,3 +83,3 @@ getLanguageProgress(projectId: number, languageId: string, limit?: number, offset?: number): Promise<ResponseList<TranslationStatusModel.FileProgress>>; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.languages.progress.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.languages.progress.getMany | ||
*/ | ||
@@ -93,3 +93,3 @@ getProjectProgress(projectId: number, options?: PaginationOptions): Promise<ResponseList<TranslationStatusModel.LanguageProgress>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.languages.progress.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.languages.progress.getMany | ||
*/ | ||
@@ -100,3 +100,3 @@ getProjectProgress(projectId: number, limit?: number, offset?: number, languageIds?: string): Promise<ResponseList<TranslationStatusModel.LanguageProgress>>; | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.qa-checks.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.qa-checks.getMany | ||
*/ | ||
@@ -112,3 +112,3 @@ listQaCheckIssues(projectId: number, options?: TranslationStatusModel.ListQaCheckIssuesOptions): Promise<ResponseList<TranslationStatusModel.QaCheck>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.qa-checks.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.qa-checks.getMany | ||
*/ | ||
@@ -115,0 +115,0 @@ listQaCheckIssues(projectId: number, limit?: number, offset?: number, category?: TranslationStatusModel.Category, validation?: TranslationStatusModel.Validation, languageIds?: string): Promise<ResponseList<TranslationStatusModel.QaCheck>>; |
@@ -13,3 +13,3 @@ import { CrowdinApi, PaginationOptions, ResponseList, ResponseObject } from '../core'; | ||
* @param options optional pagination parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.storages.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.storages.getMany | ||
*/ | ||
@@ -21,3 +21,3 @@ listStorages(options?: PaginationOptions): Promise<ResponseList<UploadStorageModel.Storage>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.storages.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.storages.getMany | ||
*/ | ||
@@ -29,3 +29,3 @@ listStorages(limit?: number, offset?: number): Promise<ResponseList<UploadStorageModel.Storage>>; | ||
* @param contentType content type header | ||
* @see https://support.crowdin.com/api/v2/#operation/api.storages.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.storages.post | ||
*/ | ||
@@ -35,3 +35,3 @@ addStorage(fileName: string, request: any, contentType?: string): Promise<ResponseObject<UploadStorageModel.Storage>>; | ||
* @param storageId storage identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.storages.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.storages.get | ||
*/ | ||
@@ -41,3 +41,3 @@ getStorage(storageId: number): Promise<ResponseObject<UploadStorageModel.Storage>>; | ||
* @param storageId storage identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.storages.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.storages.delete | ||
*/ | ||
@@ -44,0 +44,0 @@ deleteStorage(storageId: number): Promise<void>; |
@@ -934,3 +934,3 @@ "use strict"; | ||
* @param contentType content type header | ||
* @see https://support.crowdin.com/api/v2/#operation/api.storages.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.storages.post | ||
*/ | ||
@@ -957,3 +957,3 @@ addStorage(fileName, request, contentType) { | ||
* @param storageId storage identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.storages.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.storages.get | ||
*/ | ||
@@ -966,3 +966,3 @@ getStorage(storageId) { | ||
* @param storageId storage identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.storages.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.storages.delete | ||
*/ | ||
@@ -969,0 +969,0 @@ deleteStorage(storageId) { |
@@ -1,2 +0,2 @@ | ||
import { CrowdinApi, Pagination, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core'; | ||
import { CrowdinApi, Pagination, PaginationOptions, PatchRequest, ProjectRole, ResponseList, ResponseObject } from '../core'; | ||
/** | ||
@@ -12,3 +12,3 @@ * Users API gives you the possibility to get profile information about the currently authenticated user. | ||
* @param options optional parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.members.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.members.getMany | ||
*/ | ||
@@ -24,3 +24,3 @@ listProjectMembers(projectId: number, options?: UsersModel.ListProjectMembersOptions): Promise<ResponseList<UsersModel.ProjectMember | UsersModel.EnterpriseProjectMember>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.members.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.members.getMany | ||
*/ | ||
@@ -37,5 +37,5 @@ listProjectMembers(projectId: number, search?: string, role?: UsersModel.Role, languageId?: string, limit?: number, offset?: number): Promise<ResponseList<UsersModel.ProjectMember | UsersModel.EnterpriseProjectMember>>; | ||
* @param memberId member identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.members.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.members.get | ||
*/ | ||
getProjectMemberPermissions(projectId: number, memberId: number): Promise<ResponseObject<UsersModel.ProjectMember>>; | ||
getProjectMemberPermissions(projectId: number, memberId: number): Promise<ResponseObject<UsersModel.ProjectMember | UsersModel.EnterpriseProjectMember>>; | ||
/** | ||
@@ -46,3 +46,3 @@ * @param projectId project identifier | ||
*/ | ||
replaceProjectMemberPermissions(projectId: number, memberId: number, request?: UsersModel.ReplaceProjectMemberRequest): Promise<ResponseObject<UsersModel.ProjectMember>>; | ||
replaceProjectMemberPermissions(projectId: number, memberId: number, request?: UsersModel.ReplaceProjectMemberRequest): Promise<ResponseObject<UsersModel.ProjectMember | UsersModel.EnterpriseProjectMember>>; | ||
/** | ||
@@ -91,3 +91,3 @@ * @param projectId project identifier | ||
/** | ||
* @see https://support.crowdin.com/api/v2/#operation/api.user.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.user.get | ||
*/ | ||
@@ -134,8 +134,10 @@ getAuthenticatedUser(): Promise<ResponseObject<UsersModel.User>>; | ||
role: Role; | ||
permissions: { | ||
[lang: string]: LanguageRole | string; | ||
}; | ||
/** | ||
* @deprecated | ||
*/ | ||
permissions: Permissions; | ||
avatarUrl: string; | ||
joinedAt: string; | ||
timezone: string; | ||
roles: ProjectRole[]; | ||
} | ||
@@ -149,9 +151,12 @@ interface EnterpriseProjectMember { | ||
managerOfGroup: Group; | ||
/** | ||
* @deprecated | ||
*/ | ||
accessToAllWorkflowSteps: boolean; | ||
permissions: { | ||
[lang: string]: { | ||
workflowStepIds: number[]; | ||
}; | ||
}; | ||
/** | ||
* @deprecated | ||
*/ | ||
permissions: Permissions; | ||
givenAccessAt: string; | ||
roles: ProjectRole[]; | ||
} | ||
@@ -166,5 +171,12 @@ interface Group { | ||
userIds: number[]; | ||
/** | ||
* @deprecated | ||
*/ | ||
accessToAllWorkflowSteps?: boolean; | ||
managerAccess?: boolean; | ||
permissions?: any; | ||
/** | ||
* @deprecated | ||
*/ | ||
permissions?: Permissions; | ||
roles?: ProjectRole[]; | ||
} | ||
@@ -177,6 +189,18 @@ interface AddProjectMemberResponse { | ||
interface ReplaceProjectMemberRequest { | ||
/** | ||
* @deprecated | ||
*/ | ||
accessToAllWorkflowSteps?: boolean; | ||
managerAccess?: boolean; | ||
permissions?: any; | ||
/** | ||
* @deprecated | ||
*/ | ||
permissions?: Permissions; | ||
roles?: ProjectRole[]; | ||
} | ||
interface Permissions { | ||
[lang: string]: string | { | ||
workflowStepIds: number[] | 'all'; | ||
}; | ||
} | ||
} |
@@ -40,3 +40,3 @@ "use strict"; | ||
* @param memberId member identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.members.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.members.get | ||
*/ | ||
@@ -115,3 +115,3 @@ getProjectMemberPermissions(projectId, memberId) { | ||
/** | ||
* @see https://support.crowdin.com/api/v2/#operation/api.user.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.user.get | ||
*/ | ||
@@ -118,0 +118,0 @@ getAuthenticatedUser() { |
@@ -11,3 +11,3 @@ import { CrowdinApi, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core'; | ||
* @param options optional pagination parameters for the request | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.webhooks.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.getMany | ||
*/ | ||
@@ -20,3 +20,3 @@ listWebhooks(projectId: number, options?: PaginationOptions): Promise<ResponseList<WebhooksModel.Webhook>>; | ||
* @deprecated optional parameters should be passed through an object | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.webhooks.getMany | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.getMany | ||
*/ | ||
@@ -27,3 +27,3 @@ listWebhooks(projectId: number, limit?: number, offset?: number): Promise<ResponseList<WebhooksModel.Webhook>>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.webhooks.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.post | ||
*/ | ||
@@ -34,3 +34,3 @@ addWebhook(projectId: number, request: WebhooksModel.AddWebhookRequest): Promise<ResponseObject<WebhooksModel.Webhook>>; | ||
* @param webhookId webhook identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.webhooks.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.get | ||
*/ | ||
@@ -41,3 +41,3 @@ getWebhook(projectId: number, webhookId: number): Promise<ResponseObject<WebhooksModel.Webhook>>; | ||
* @param webhookId webhook identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.webhooks.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.delete | ||
*/ | ||
@@ -49,3 +49,3 @@ deleteWebhook(projectId: number, webhookId: number): Promise<void>; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.webhooks.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.patch | ||
*/ | ||
@@ -52,0 +52,0 @@ editWebhook(projectId: number, webhookId: number, request: PatchRequest[]): Promise<ResponseObject<WebhooksModel.Webhook>>; |
@@ -21,3 +21,3 @@ "use strict"; | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.webhooks.post | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.post | ||
*/ | ||
@@ -31,3 +31,3 @@ addWebhook(projectId, request) { | ||
* @param webhookId webhook identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.webhooks.get | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.get | ||
*/ | ||
@@ -41,3 +41,3 @@ getWebhook(projectId, webhookId) { | ||
* @param webhookId webhook identifier | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.webhooks.delete | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.delete | ||
*/ | ||
@@ -52,3 +52,3 @@ deleteWebhook(projectId, webhookId) { | ||
* @param request request body | ||
* @see https://support.crowdin.com/api/v2/#operation/api.projects.webhooks.patch | ||
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.webhooks.patch | ||
*/ | ||
@@ -55,0 +55,0 @@ editWebhook(projectId, webhookId, request) { |
{ | ||
"name": "@crowdin/crowdin-api-client", | ||
"version": "1.19.2", | ||
"version": "1.20.0", | ||
"description": "JavaScript library for Crowdin API v2.", | ||
@@ -45,3 +45,3 @@ "main": "out/index.js", | ||
"ts-jest": "^27.0.0", | ||
"typedoc": "^0.22.15", | ||
"typedoc": "^0.23.19", | ||
"typescript": "^4.1.2" | ||
@@ -48,0 +48,0 @@ }, |
@@ -11,2 +11,3 @@ [<p align='center'><img src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' data-canonical-src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' width='200' height='200' align='center'/></p>](https://crowdin.com) | ||
[**`Live Demo`**](https://runkit.com/andrii-bodnar/crowdin-js-api-client-live-demo) | | ||
[**`API Client Docs`**](https://crowdin.github.io/crowdin-api-client-js/modules.html) | | ||
@@ -13,0 +14,0 @@ [**`Crowdin API`**](https://developer.crowdin.com/api/v2/) | |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
341786
7770
443