跳至主要内容

TraduoraApi

@0xlimao/traduora-cli

@0xlimao/traduora-cli / TraduoraApi

Class: TraduoraApi

Defined in: api.ts:35

Constructors​

Constructor​

new TraduoraApi(client): TraduoraApi

Defined in: api.ts:38

Parameters​

client​

TraduoraClient

Returns​

TraduoraApi

Methods​

listProjects()​

listProjects(): Promise<ProjectDTO[]>

Defined in: api.ts:42

Returns​

Promise<ProjectDTO[]>

getProject()​

getProject(projectId): Promise<ProjectDTO>

Defined in: api.ts:47

Parameters​

projectId​

string

Returns​

Promise<ProjectDTO>

createProject()​

createProject(input): Promise<ProjectDTO>

Defined in: api.ts:55

Parameters​

input​
name​

string

description?​

string

Returns​

Promise<ProjectDTO>

updateProject()​

updateProject(projectId, input): Promise<ProjectDTO>

Defined in: api.ts:62

Parameters​

projectId​

string

input​
name?​

string

description?​

string

Returns​

Promise<ProjectDTO>

deleteProject()​

deleteProject(projectId): Promise<void>

Defined in: api.ts:76

Parameters​

projectId​

string

Returns​

Promise<void>

getProjectStatus()​

getProjectStatus(projectId): Promise<ProjectStatusDTO>

Defined in: api.ts:80

Parameters​

projectId​

string

Returns​

Promise<ProjectStatusDTO>

listTerms()​

listTerms(projectId): Promise<ProjectTermDTO[]>

Defined in: api.ts:88

Parameters​

projectId​

string

Returns​

Promise<ProjectTermDTO[]>

addTerm()​

addTerm(projectId, value): Promise<ProjectTermDTO>

Defined in: api.ts:96

Parameters​

projectId​

string

value​

string

Returns​

Promise<ProjectTermDTO>

updateTerm()​

updateTerm(projectId, termId, value): Promise<ProjectTermDTO>

Defined in: api.ts:107

Parameters​

projectId​

string

termId​

string

value​

string

Returns​

Promise<ProjectTermDTO>

deleteTerm()​

deleteTerm(projectId, termId): Promise<void>

Defined in: api.ts:118

Parameters​

projectId​

string

termId​

string

Returns​

Promise<void>

listProjectLocales()​

listProjectLocales(projectId): Promise<ProjectLocaleDTO[]>

Defined in: api.ts:122

Parameters​

projectId​

string

Returns​

Promise<ProjectLocaleDTO[]>

addProjectLocale()​

addProjectLocale(projectId, localeCode): Promise<ProjectLocaleDTO>

Defined in: api.ts:130

Parameters​

projectId​

string

localeCode​

string

Returns​

Promise<ProjectLocaleDTO>

listTranslations()​

listTranslations(projectId, localeCode): Promise<TermTranslationDTO[]>

Defined in: api.ts:141

Parameters​

projectId​

string

localeCode​

string

Returns​

Promise<TermTranslationDTO[]>

updateTranslation()​

updateTranslation(projectId, localeCode, termId, value): Promise<TermTranslationDTO>

Defined in: api.ts:149

Parameters​

projectId​

string

localeCode​

string

termId​

string

value​

string

Returns​

Promise<TermTranslationDTO>

deleteLocale()​

deleteLocale(projectId, localeCode): Promise<void>

Defined in: api.ts:165

Parameters​

projectId​

string

localeCode​

string

Returns​

Promise<void>

listLabels()​

listLabels(projectId): Promise<ProjectLabelDTO[]>

Defined in: api.ts:169

Parameters​

projectId​

string

Returns​

Promise<ProjectLabelDTO[]>

createLabel()​

createLabel(projectId, value, color?): Promise<ProjectLabelDTO>

Defined in: api.ts:177

Parameters​

projectId​

string

value​

string

color?​

string

Returns​

Promise<ProjectLabelDTO>

ensureLabels()​

ensureLabels(projectId, values): Promise<ProjectLabelDTO[]>

Defined in: api.ts:191

Parameters​

projectId​

string

values​

string[]

Returns​

Promise<ProjectLabelDTO[]>

setTermLabels()​

setTermLabels(projectId, termId, currentLabelValues, targetLabelValues): Promise<void>

Defined in: api.ts:219

Parameters​

projectId​

string

termId​

string

currentLabelValues​

string[]

targetLabelValues​

string[]

Returns​

Promise<void>

setTranslationLabels()​

setTranslationLabels(projectId, localeCode, termId, currentLabelValues, targetLabelValues): Promise<void>

Defined in: api.ts:257

Parameters​

projectId​

string

localeCode​

string

termId​

string

currentLabelValues​

string[]

targetLabelValues​

string[]

Returns​

Promise<void>

listLocales()​

listLocales(): Promise<LocaleDTO[]>

Defined in: api.ts:296

Returns​

Promise<LocaleDTO[]>

createProjectClient()​

createProjectClient(projectId, input): Promise<ProjectClientWithSecretDTO>

Defined in: api.ts:301

Parameters​

projectId​

string

input​
name​

string

role​

ProjectRole

Returns​

Promise<ProjectClientWithSecretDTO>

exportProject()​

exportProject(projectId, localeCode, format): Promise<Buffer<ArrayBufferLike>>

Defined in: api.ts:315

Parameters​

projectId​

string

localeCode​

string

format​

ExportFormat

Returns​

Promise<Buffer<ArrayBufferLike>>