Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@crowdin/crowdin-api-client",
"version": "1.12.2",
"version": "1.12.3",
"description": "JavaScript library for Crowdin API v2.",
"main": "out/index.js",
"types": "out/index.d.ts",
Expand Down
35 changes: 30 additions & 5 deletions src/sourceFiles/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,29 @@ export class SourceFiles extends CrowdinApi {
offset?: number,
filter?: string,
recursion?: string,
): Promise<ResponseList<SourceFilesModel.Directory>>;

listProjectDirectories(
projectId: number,
branchIdOrRequest?: number | SourceFilesModel.ListProjectDirectoriesRequest,
directoryId?: number,
limit?: number,
offset?: number,
filter?: string,
recursion?: string,
): Promise<ResponseList<SourceFilesModel.Directory>> {
let url = `${this.url}/projects/${projectId}/directories`;
url = this.addQueryParam(url, 'branchId', branchId);
url = this.addQueryParam(url, 'directoryId', directoryId);
url = this.addQueryParam(url, 'filter', filter);
url = this.addQueryParam(url, 'recursion', recursion);
return this.getList(url, limit, offset);
let request: SourceFilesModel.ListProjectDirectoriesRequest;
if (branchIdOrRequest && typeof branchIdOrRequest === 'object') {
request = branchIdOrRequest;
} else {
request = { branchId: branchIdOrRequest, directoryId, limit, offset, recursion, filter };
}
url = this.addQueryParam(url, 'branchId', request.branchId);
url = this.addQueryParam(url, 'directoryId', request.directoryId);
url = this.addQueryParam(url, 'filter', request.filter);
url = this.addQueryParam(url, 'recursion', request.recursion);
return this.getList(url, request.limit, request.offset);
}

/**
Expand Down Expand Up @@ -353,6 +369,15 @@ export namespace SourceFilesModel {
HIGH = 'high',
}

export interface ListProjectDirectoriesRequest {
branchId?: number;
directoryId?: number;
limit?: number;
offset?: number;
filter?: string;
recursion?: string;
}

export interface Directory {
id: number;
projectId: number;
Expand Down
120 changes: 105 additions & 15 deletions src/stringTranslations/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,29 @@ export class StringTranslations extends CrowdinApi {
limit?: number,
offset?: number,
fileId?: number,
): Promise<ResponseList<StringTranslationsModel.Approval>>;

listTranslationApprovals(
projectId: number,
stringIdOrRequest?: number | StringTranslationsModel.ListTranslationApprovalsRequest,
languageId?: string,
translationId?: number,
limit?: number,
offset?: number,
fileId?: number,
): Promise<ResponseList<StringTranslationsModel.Approval>> {
let url = `${this.url}/projects/${projectId}/approvals`;
url = this.addQueryParam(url, 'stringId', stringId);
url = this.addQueryParam(url, 'languageId', languageId);
url = this.addQueryParam(url, 'translationId', translationId);
url = this.addQueryParam(url, 'fileId', fileId);
return this.getList(url, limit, offset);
let request: StringTranslationsModel.ListTranslationApprovalsRequest;
if (stringIdOrRequest && typeof stringIdOrRequest === 'object') {
request = stringIdOrRequest;
} else {
request = { stringId: stringIdOrRequest, languageId, translationId, limit, offset, fileId };
}
url = this.addQueryParam(url, 'stringId', request.stringId);
url = this.addQueryParam(url, 'languageId', request.languageId);
url = this.addQueryParam(url, 'translationId', request.translationId);
url = this.addQueryParam(url, 'fileId', request.fileId);
return this.getList(url, request.limit, request.offset);
}

/**
Expand Down Expand Up @@ -84,14 +100,46 @@ export class StringTranslations extends CrowdinApi {
| StringTranslationsModel.PluralLanguageTranslation
| StringTranslationsModel.IcuLanguageTranslation
>
>;

listLanguageTranslations(
projectId: number,
languageId: string,
stringIdsOrRequest?: string | StringTranslationsModel.ListLanguageTranslationsRequest,
fileId?: number,
limit?: number,
offset?: number,
labelIds?: string,
denormalizePlaceholders?: BooleanInt,
croql?: string,
): Promise<
ResponseList<
| StringTranslationsModel.PlainLanguageTranslation
| StringTranslationsModel.PluralLanguageTranslation
| StringTranslationsModel.IcuLanguageTranslation
>
> {
let url = `${this.url}/projects/${projectId}/languages/${languageId}/translations`;
url = this.addQueryParam(url, 'stringIds', stringIds);
url = this.addQueryParam(url, 'fileId', fileId);
url = this.addQueryParam(url, 'labelIds', labelIds);
url = this.addQueryParam(url, 'denormalizePlaceholders', denormalizePlaceholders);
url = this.addQueryParam(url, 'croql', croql);
return this.getList(url, limit, offset);
let request: StringTranslationsModel.ListLanguageTranslationsRequest;
if (stringIdsOrRequest && typeof stringIdsOrRequest === 'object') {
request = stringIdsOrRequest;
} else {
request = {
stringIds: stringIdsOrRequest,
fileId,
limit,
offset,
labelIds,
denormalizePlaceholders,
croql,
};
}
url = this.addQueryParam(url, 'stringIds', request.stringIds);
url = this.addQueryParam(url, 'fileId', request.fileId);
url = this.addQueryParam(url, 'labelIds', request.labelIds);
url = this.addQueryParam(url, 'denormalizePlaceholders', request.denormalizePlaceholders);
url = this.addQueryParam(url, 'croql', request.croql);
return this.getList(url, request.limit, request.offset);
}

/**
Expand Down Expand Up @@ -189,12 +237,27 @@ export class StringTranslations extends CrowdinApi {
translationId?: number,
limit?: number,
offset?: number,
): Promise<ResponseList<StringTranslationsModel.Vote>>;

listTranslationVotes(
projectId: number,
stringIdOrRequest?: number | StringTranslationsModel.ListTranslationVotesRequest,
languageId?: string,
translationId?: number,
limit?: number,
offset?: number,
): Promise<ResponseList<StringTranslationsModel.Vote>> {
let url = `${this.url}/projects/${projectId}/votes`;
url = this.addQueryParam(url, 'stringId', stringId);
url = this.addQueryParam(url, 'languageId', languageId);
url = this.addQueryParam(url, 'translationId', translationId);
return this.getList(url, limit, offset);
let request: StringTranslationsModel.ListTranslationVotesRequest;
if (stringIdOrRequest && typeof stringIdOrRequest === 'object') {
request = stringIdOrRequest;
} else {
request = { stringId: stringIdOrRequest, languageId, translationId, limit, offset };
}
url = this.addQueryParam(url, 'stringId', request.stringId);
url = this.addQueryParam(url, 'languageId', request.languageId);
url = this.addQueryParam(url, 'translationId', request.translationId);
return this.getList(url, request.limit, request.offset);
}

/**
Expand Down Expand Up @@ -229,6 +292,15 @@ export class StringTranslations extends CrowdinApi {
}

export namespace StringTranslationsModel {
export interface ListTranslationApprovalsRequest {
stringId?: number;
languageId?: string;
translationId?: number;
limit?: number;
offset?: number;
fileId?: number;
}

export interface Approval {
id: number;
user: User;
Expand All @@ -252,6 +324,16 @@ export namespace StringTranslationsModel {
createdAt: string;
}

export interface ListLanguageTranslationsRequest {
stringIds?: string;
fileId?: number;
limit?: number;
offset?: number;
labelIds?: string;
denormalizePlaceholders?: BooleanInt;
croql?: string;
}

export interface PlainLanguageTranslation {
stringId: number;
contentType: string;
Expand Down Expand Up @@ -291,6 +373,14 @@ export namespace StringTranslationsModel {
pluralCategoryName?: string;
}

export interface ListTranslationVotesRequest {
stringId?: number;
languageId?: string;
translationId?: number;
limit?: number;
offset?: number;
}

export interface Vote {
id: number;
user: User;
Expand Down
26 changes: 23 additions & 3 deletions src/tasks/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,24 @@ export class Tasks extends CrowdinApi {
offset?: number,
status?: TasksModel.Status,
isArchived?: BooleanInt,
): Promise<ResponseList<TasksModel.UserTask>>;

listUserTasks(
limitOrRequest?: number | TasksModel.ListUserTasksRequest,
offset?: number,
status?: TasksModel.Status,
isArchived?: BooleanInt,
): Promise<ResponseList<TasksModel.UserTask>> {
let url = `${this.url}/user/tasks`;
url = this.addQueryParam(url, 'status', status);
url = this.addQueryParam(url, 'isArchived', isArchived);
return this.getList(url, limit, offset);
let request: TasksModel.ListUserTasksRequest;
if (limitOrRequest && typeof limitOrRequest === 'object') {
request = limitOrRequest;
} else {
request = { limit: limitOrRequest, offset, status, isArchived };
}
url = this.addQueryParam(url, 'status', request.status);
url = this.addQueryParam(url, 'isArchived', request.isArchived);
return this.getList(url, request.limit, request.offset);
}

/**
Expand Down Expand Up @@ -132,6 +145,13 @@ export namespace TasksModel {
updatedAt: string;
}

export interface ListUserTasksRequest {
limit?: number;
offset?: number;
status?: Status;
isArchived?: BooleanInt;
}

export interface UserTask extends Task {
isArchived: boolean;
}
Expand Down
31 changes: 27 additions & 4 deletions src/translationStatus/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,12 +97,27 @@ export class TranslationStatus extends CrowdinApi {
category?: TranslationStatusModel.Category,
validation?: TranslationStatusModel.Validation,
languageIds?: string,
): Promise<ResponseList<TranslationStatusModel.QaCheck>>;

listQaCheckIssues(
projectId: number,
limitOrRequest?: number | TranslationStatusModel.ListQaCheckIssuesRequest,
offset?: number,
category?: TranslationStatusModel.Category,
validation?: TranslationStatusModel.Validation,
languageIds?: string,
): Promise<ResponseList<TranslationStatusModel.QaCheck>> {
let url = `${this.url}/projects/${projectId}/qa-checks`;
url = this.addQueryParam(url, 'category', category);
url = this.addQueryParam(url, 'validation', validation);
url = this.addQueryParam(url, 'languageIds', languageIds);
return this.getList(url, limit, offset);
let request: TranslationStatusModel.ListQaCheckIssuesRequest;
if (limitOrRequest && typeof limitOrRequest === 'object') {
request = limitOrRequest;
} else {
request = { limit: limitOrRequest, offset, category, validation, languageIds };
}
url = this.addQueryParam(url, 'category', request.category);
url = this.addQueryParam(url, 'validation', request.validation);
url = this.addQueryParam(url, 'languageIds', request.languageIds);
return this.getList(url, request.limit, request.offset);
}
}

Expand Down Expand Up @@ -185,6 +200,14 @@ export namespace TranslationStatusModel {
ICU_CHECK = 'icu_check',
}

export interface ListQaCheckIssuesRequest {
limit?: number;
offset?: number;
category?: Category;
validation?: Validation;
languageIds?: string;
}

export interface QaCheck {
stringId: number;
languageId: string;
Expand Down
Loading