@crowdin/crowdin-api-client
Advanced tools
Comparing version 1.5.1 to 1.5.2
@@ -1,2 +0,2 @@ | ||
import { CrowdinApi, ResponseList, ResponseObject, PatchRequest } from '../core'; | ||
import { CrowdinApi, ResponseList, ResponseObject, PatchRequest, BooleanInt } from '../core'; | ||
export declare class Tasks extends CrowdinApi { | ||
@@ -7,4 +7,5 @@ /** | ||
* @param offset starting offset in the collection (default 0) | ||
* @param status list tasks with specified statuses. It can be one status or a list of comma-separated status values | ||
*/ | ||
listTasks(projectId: number, limit?: number, offset?: number): Promise<ResponseList<TasksModel.Task>>; | ||
listTasks(projectId: number, limit?: number, offset?: number, status?: TasksModel.Status): Promise<ResponseList<TasksModel.Task>>; | ||
/** | ||
@@ -31,2 +32,15 @@ * @param projectId project identifier | ||
editTask(projectId: number, taskId: number, request: PatchRequest[]): Promise<ResponseObject<TasksModel.Task>>; | ||
/** | ||
* @param limit maximum number of items to retrieve (default 25) | ||
* @param offset starting offset in the collection (default 0) | ||
* @param status list tasks with specified statuses. It can be one status or a list of comma-separated status values | ||
* @param isArchived list archived/not archived tasks for the authorized user. 1 - archived, 0 - not archived | ||
*/ | ||
listUserTasks(limit?: number, offset?: number, status?: TasksModel.Status, isArchived?: BooleanInt): Promise<ResponseList<TasksModel.UserTask>>; | ||
/** | ||
* @param projectId project identifier | ||
* @param taskId task identifier | ||
* @param request request body | ||
*/ | ||
editTaskArchivedStatus(projectId: number, taskId: number, request: PatchRequest[]): Promise<ResponseObject<TasksModel.UserTask>>; | ||
} | ||
@@ -58,2 +72,5 @@ export declare namespace TasksModel { | ||
} | ||
interface UserTask extends Task { | ||
isArchived: boolean; | ||
} | ||
interface CreateTaskRequest { | ||
@@ -75,3 +92,5 @@ workflowStepId: number; | ||
TODO = "todo", | ||
IN_PROGRESS = "in_progress" | ||
IN_PROGRESS = "in_progress", | ||
DONE = "done", | ||
CLOSED = "closed" | ||
} | ||
@@ -78,0 +97,0 @@ enum Type { |
@@ -9,7 +9,9 @@ "use strict"; | ||
* @param offset starting offset in the collection (default 0) | ||
* @param status list tasks with specified statuses. It can be one status or a list of comma-separated status values | ||
*/ | ||
listTasks(projectId, limit, offset) { | ||
listTasks(projectId, limit, offset, status) { | ||
let url = `${this.url}/projects/${projectId}/tasks`; | ||
url = this.addQueryParam(url, 'limit', limit); | ||
url = this.addQueryParam(url, 'offset', offset); | ||
url = this.addQueryParam(url, 'status', status); | ||
return this.get(url, this.defaultConfig()); | ||
@@ -50,2 +52,26 @@ } | ||
} | ||
/** | ||
* @param limit maximum number of items to retrieve (default 25) | ||
* @param offset starting offset in the collection (default 0) | ||
* @param status list tasks with specified statuses. It can be one status or a list of comma-separated status values | ||
* @param isArchived list archived/not archived tasks for the authorized user. 1 - archived, 0 - not archived | ||
*/ | ||
listUserTasks(limit, offset, status, isArchived) { | ||
let url = `${this.url}/user/tasks`; | ||
url = this.addQueryParam(url, 'limit', limit); | ||
url = this.addQueryParam(url, 'offset', offset); | ||
url = this.addQueryParam(url, 'status', status); | ||
url = this.addQueryParam(url, 'isArchived', isArchived); | ||
return this.get(url, this.defaultConfig()); | ||
} | ||
/** | ||
* @param projectId project identifier | ||
* @param taskId task identifier | ||
* @param request request body | ||
*/ | ||
editTaskArchivedStatus(projectId, taskId, request) { | ||
let url = `${this.url}/user/tasks/${taskId}`; | ||
url = this.addQueryParam(url, 'projectId', projectId); | ||
return this.patch(url, request, this.defaultConfig()); | ||
} | ||
} | ||
@@ -59,2 +85,4 @@ exports.Tasks = Tasks; | ||
Status["IN_PROGRESS"] = "in_progress"; | ||
Status["DONE"] = "done"; | ||
Status["CLOSED"] = "closed"; | ||
})(Status = TasksModel.Status || (TasksModel.Status = {})); | ||
@@ -61,0 +89,0 @@ let Type; |
@@ -66,8 +66,12 @@ import { CrowdinApi, ResponseList } from '../core'; | ||
languageId: string; | ||
phrasesCount: number; | ||
phrasesTranslatedCount: number; | ||
phrasesApprovedCount: number; | ||
phrasesTranslatedProgress: number; | ||
phrasesApprovedProgress: number; | ||
words: Words; | ||
phrases: Words; | ||
translationProgress: number; | ||
approvalProgress: number; | ||
} | ||
interface Words { | ||
total: number; | ||
translated: number; | ||
approved: number; | ||
} | ||
enum Category { | ||
@@ -74,0 +78,0 @@ EMPTY = "empty", |
{ | ||
"name": "@crowdin/crowdin-api-client", | ||
"version": "1.5.1", | ||
"version": "1.5.2", | ||
"description": "JavaScript library for Crowdin API v2.", | ||
@@ -5,0 +5,0 @@ "main": "out/index.js", |
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
160205
3965