-
Notifications
You must be signed in to change notification settings - Fork 1
/
i-translations.ts
41 lines (38 loc) · 1.48 KB
/
i-translations.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
import {IPage} from '../params/i-page';
import {ITranslation} from '../model/i-translation';
export interface ITranslations {
/**
* @public
* @description Retrieves a list of project translation items, ungrouped.
* You may want to request Keys resource in order
* to get the structured key/translation pairs for all languages.
* @param {string} projectId
* @param {IPage} [query]
* @returns {Promise<{project_id: string, translations: ITranslation[]}>}
* @memberof ITranslations
*/
list(projectId: string, query?: IPage):
Promise<{project_id: string, translations: ITranslation[]}>;
/**
* @public
* @description Retrieves a Translation object.
* @param {string} projectId
* @param {number} translationId
* @returns {Promise<{project_id: string, translation: ITranslation}>}
* @memberof ITranslations
*/
get(projectId: string, translationId: number):
Promise<{project_id: string, translation: ITranslation}>;
/**
* @public
* @description Updates a translation.
* Alternatively, use Bulk key update endpoint to update translations.
* @param {string} projectId
* @param {number} translationId
* @param {object} body
* @returns {Promise<{project_id: string, translation: ITranslation}>}
* @memberof ITranslations
*/
update(projectId: string, translationId: number, body: object):
Promise<{project_id: string, translation: ITranslation}>;
}