Skip to content

Commit

Permalink
Screenshots API updates (#222)
Browse files Browse the repository at this point in the history
  • Loading branch information
yevheniyJ committed Jan 21, 2023
1 parent da661b9 commit efe986e
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 7 deletions.
4 changes: 2 additions & 2 deletions 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.21.0",
"version": "1.21.1",
"description": "JavaScript library for Crowdin API v2.",
"main": "out/index.js",
"types": "out/index.d.ts",
Expand Down
27 changes: 23 additions & 4 deletions src/screenshots/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ export class Screenshots extends CrowdinApi {
updateScreenshot(
projectId: number,
screenshotId: number,
request: ScreenshotsModel.CreateScreenshotRequest,
request: ScreenshotsModel.UpdateScreenshotRequest,
): Promise<ResponseObject<ScreenshotsModel.Screenshot>> {
const url = `${this.url}/projects/${projectId}/screenshots/${screenshotId}`;
return this.put(url, request, this.defaultConfig());
Expand Down Expand Up @@ -144,7 +144,11 @@ export class Screenshots extends CrowdinApi {
* @param request request body
* @see https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.putMany
*/
replaceTags(projectId: number, screenshotId: number, request: ScreenshotsModel.AddTagRequest[]): Promise<void> {
replaceTags(
projectId: number,
screenshotId: number,
request: ScreenshotsModel.ReplaceTagRequest[] | ScreenshotsModel.AutoTagRequest,
): Promise<void> {
const url = `${this.url}/projects/${projectId}/screenshots/${screenshotId}/tags`;
return this.put(url, request, this.defaultConfig());
}
Expand All @@ -158,7 +162,7 @@ export class Screenshots extends CrowdinApi {
addTag(
projectId: number,
screenshotId: number,
request: ScreenshotsModel.AddTagRequest[],
request: ScreenshotsModel.ReplaceTagRequest[],
): Promise<ResponseObject<ScreenshotsModel.Tag>> {
const url = `${this.url}/projects/${projectId}/screenshots/${screenshotId}/tags`;
return this.post(url, request, this.defaultConfig());
Expand Down Expand Up @@ -231,6 +235,14 @@ export namespace ScreenshotsModel {
storageId: number;
name: string;
autoTag?: boolean;
fileId?: number;
branchId?: number;
directoryId?: number;
}

export interface UpdateScreenshotRequest {
storageId: number;
name: string;
}

export interface Tag {
Expand All @@ -241,11 +253,18 @@ export namespace ScreenshotsModel {
createdAt: string;
}

export interface AddTagRequest {
export interface ReplaceTagRequest {
stringId: number;
position?: Position;
}

export interface AutoTagRequest {
autoTag: boolean;
fileId?: number;
branchId?: number;
directoryId?: number;
}

export interface Size {
width: number;
height: number;
Expand Down

0 comments on commit efe986e

Please sign in to comment.