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
29 changes: 29 additions & 0 deletions src/main/java/com/crowdin/client/workflows/WorkflowsApi.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,19 @@
import com.crowdin.client.core.http.exceptions.HttpException;
import com.crowdin.client.core.model.ClientConfig;
import com.crowdin.client.core.model.Credentials;
import com.crowdin.client.core.model.OrderByField;
import com.crowdin.client.core.model.ResponseList;
import com.crowdin.client.core.model.ResponseObject;
import com.crowdin.client.sourcestrings.model.SourceString;
import com.crowdin.client.sourcestrings.model.SourceStringResponseList;
import com.crowdin.client.workflows.model.WorkflowStep;
import com.crowdin.client.workflows.model.WorkflowStepResponseList;
import com.crowdin.client.workflows.model.WorkflowStepResponseObject;
import com.crowdin.client.workflows.model.WorkflowTemplate;
import com.crowdin.client.workflows.model.WorkflowTemplateResponseList;
import com.crowdin.client.workflows.model.WorkflowTemplateResponseObject;

import java.util.List;
import java.util.Map;
import java.util.Optional;

Expand Down Expand Up @@ -52,6 +56,31 @@ public ResponseObject<WorkflowStep> getWorkflowStep(Long projectId, Long stepId)
return ResponseObject.of(workflowStepResponseObject.getData());
}

/**
* @param projectId project identifier
* @param stepId workflow step identifier
* @param languageIds filter progress by language identifiers
* @param orderBy ["id", "text", "identifier", "context", "createdAt", "updatedAt"]. List of OrderByField (default "id asc")
* @param status ["todo", "done", "pending", "incomplete", "need_review"]. String status on the workflow step
* @param limit maximum number of items to retrieve (default 25)
* @param offset starting offset in the collection (default 0)
* @return list of project strings
* @see <ul>
* <li><a href="https://support.crowdin.com/developer/enterprise/api/v2/#tag/Workflows/operation/api.projects.workflow-steps.strings.getMany" target="_blank"><b>Enterprise API Documentation</b></a></li>
* </ul>
*/
public ResponseList<SourceString> listWorkflowStepStrings(Long projectId, Long stepId, String languageIds, List<OrderByField> orderBy, String status, Integer limit, Integer offset) throws HttpException, HttpBadRequestException {
Map<String, Optional<Object>> queryParams = HttpRequestConfig.buildUrlParams(
"languageIds", Optional.ofNullable(languageIds),
"orderBy", Optional.ofNullable(OrderByField.generateSortParam(orderBy)),
"status", Optional.ofNullable(status),
"limit", Optional.ofNullable(limit),
"offset", Optional.ofNullable(offset)
);
SourceStringResponseList workflowStepStringsList = this.httpClient.get(this.url + "/projects/" + projectId + "/workflow-steps/" + stepId + "/strings", new HttpRequestConfig(queryParams), SourceStringResponseList.class);
return SourceStringResponseList.to(workflowStepStringsList);
}

/**
* @param groupId group identifier
* @param limit maximum number of items to retrieve (default 25)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import com.crowdin.client.core.model.ResponseObject;
import com.crowdin.client.framework.RequestMock;
import com.crowdin.client.framework.TestClient;
import com.crowdin.client.sourcestrings.model.SourceString;
import com.crowdin.client.workflows.model.WorkflowStep;
import com.crowdin.client.workflows.model.WorkflowTemplate;
import org.apache.http.client.methods.HttpGet;
Expand All @@ -27,6 +28,7 @@ public List<RequestMock> getMocks() {
return Arrays.asList(
RequestMock.build(this.url + "/projects/" + projectId + "/workflow-steps", HttpGet.METHOD_NAME, "api/workflows/listWorkflows.json"),
RequestMock.build(this.url + "/projects/" + projectId + "/workflow-steps/" + workflowId, HttpGet.METHOD_NAME, "api/workflows/workflow.json"),
RequestMock.build(this.url + "/projects/" + projectId + "/workflow-steps/" + workflowId + "/strings", HttpGet.METHOD_NAME, "api/workflows/workflowStrings.json"),
RequestMock.build(this.url + "/workflow-templates", HttpGet.METHOD_NAME, "api/workflows/listWorkflowTemplates.json"),
RequestMock.build(this.url + "/workflow-templates/" + workflowTemplateId, HttpGet.METHOD_NAME, "api/workflows/workflowTemplate.json")
);
Expand All @@ -45,6 +47,13 @@ public void getWorkflowStepTest() {
assertEquals(workflowStep.getData().getTitle(), workflowTitle);
}

@Test
public void listWorkflowStepStringsTest() {
ResponseList<SourceString> workflowStepStrings = this.getWorkflowsApi().listWorkflowStepStrings(projectId, workflowId, null, null, null, null, null);
assertEquals(1, workflowStepStrings.getData().size());
assertEquals(projectId, workflowStepStrings.getData().get(0).getData().getProjectId());
}

@Test
public void listWorkflowTemplatesTest() {
ResponseList<WorkflowTemplate> workflowTemplateResponseList = this.getWorkflowsApi().listWorkflowTemplates(null, null, null);
Expand Down
43 changes: 43 additions & 0 deletions src/test/resources/api/workflows/workflowStrings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"data": [
{
"data": {
"id": 2814,
"projectId": 1,
"branchId": 12,
"identifier": "name",
"text": "Not all videos are shown to users. See more",
"type": "text",
"context": "shown on main page",
"maxLength": 35,
"isHidden": false,
"isDuplicate": true,
"masterStringId": 1,
"hasPlurals": false,
"isIcu": false,
"labelIds": [
3
],
"webUrl": "https://example.crowdin.com/editor/1/all/en-pl?filter=basic&value=0&view=comfortable#2",
"createdAt": "2019-09-20T12:43:57+00:00",
"updatedAt": "2019-09-20T13:24:01+00:00",
"fields": {
"some-field-1": "some value 1",
"some-field-2": 12,
"some-field-3": true,
"some-field-4": [
"en",
"ja"
]
},
"fileId": 48,
"directoryId": 13,
"revision": 1
}
}
],
"pagination": {
"offset": 0,
"limit": 25
}
}