Skip to content

Commit 8c5ebb0

Browse files
zeplin-devzeplin-dev
committed
v1.11.0
1 parent 7548558 commit 8c5ebb0

File tree

1 file changed

+168
-0
lines changed

1 file changed

+168
-0
lines changed

‎src/apis/screens-api.ts‎

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -380,6 +380,110 @@ export const ScreensApiAxiosParamCreator = function (configuration?: Configurati
380380
options: localVarRequestOptions,
381381
};
382382
},
383+
/**
384+
* Delete a comment on the screen note
385+
* @summary Delete comment
386+
* @param {string} projectId Project id
387+
* @param {string} screenId Screen id
388+
* @param {string} noteId Screen note id
389+
* @param {string} commentId Screen comment id
390+
* @param {*} [options] Override http request option.
391+
* @throws {RequiredError}
392+
*/
393+
deleteScreenComment: async (projectId: string, screenId: string, noteId: string, commentId: string, options: any = {}): Promise<RequestArgs> => {
394+
// verify required parameter 'projectId' is not null or undefined
395+
assertParamExists('deleteScreenComment', 'projectId', projectId)
396+
// verify required parameter 'screenId' is not null or undefined
397+
assertParamExists('deleteScreenComment', 'screenId', screenId)
398+
// verify required parameter 'noteId' is not null or undefined
399+
assertParamExists('deleteScreenComment', 'noteId', noteId)
400+
// verify required parameter 'commentId' is not null or undefined
401+
assertParamExists('deleteScreenComment', 'commentId', commentId)
402+
const localVarPath = `/v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}/comments/{comment_id}`
403+
.replace(`{${"project_id"}}`, encodeURIComponent(String(projectId)))
404+
.replace(`{${"screen_id"}}`, encodeURIComponent(String(screenId)))
405+
.replace(`{${"note_id"}}`, encodeURIComponent(String(noteId)))
406+
.replace(`{${"comment_id"}}`, encodeURIComponent(String(commentId)));
407+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
408+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
409+
let baseOptions;
410+
if (configuration) {
411+
baseOptions = configuration.baseOptions;
412+
}
413+
414+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
415+
const localVarHeaderParameter = {} as any;
416+
const localVarQueryParameter = {} as any;
417+
418+
// authentication OAuth2 required
419+
// oauth required
420+
await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
421+
422+
// authentication PersonalAccessToken required
423+
// http bearer authentication required
424+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
425+
426+
427+
428+
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
429+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
430+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
431+
432+
return {
433+
url: toPathString(localVarUrlObj),
434+
options: localVarRequestOptions,
435+
};
436+
},
437+
/**
438+
* Delete a note on the screen
439+
* @summary Delete a note
440+
* @param {string} projectId Project id
441+
* @param {string} screenId Screen id
442+
* @param {string} noteId Screen note id
443+
* @param {*} [options] Override http request option.
444+
* @throws {RequiredError}
445+
*/
446+
deleteScreenNote: async (projectId: string, screenId: string, noteId: string, options: any = {}): Promise<RequestArgs> => {
447+
// verify required parameter 'projectId' is not null or undefined
448+
assertParamExists('deleteScreenNote', 'projectId', projectId)
449+
// verify required parameter 'screenId' is not null or undefined
450+
assertParamExists('deleteScreenNote', 'screenId', screenId)
451+
// verify required parameter 'noteId' is not null or undefined
452+
assertParamExists('deleteScreenNote', 'noteId', noteId)
453+
const localVarPath = `/v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}`
454+
.replace(`{${"project_id"}}`, encodeURIComponent(String(projectId)))
455+
.replace(`{${"screen_id"}}`, encodeURIComponent(String(screenId)))
456+
.replace(`{${"note_id"}}`, encodeURIComponent(String(noteId)));
457+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
458+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
459+
let baseOptions;
460+
if (configuration) {
461+
baseOptions = configuration.baseOptions;
462+
}
463+
464+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
465+
const localVarHeaderParameter = {} as any;
466+
const localVarQueryParameter = {} as any;
467+
468+
// authentication OAuth2 required
469+
// oauth required
470+
await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
471+
472+
// authentication PersonalAccessToken required
473+
// http bearer authentication required
474+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
475+
476+
477+
478+
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
479+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
480+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
481+
482+
return {
483+
url: toPathString(localVarUrlObj),
484+
options: localVarRequestOptions,
485+
};
486+
},
383487
/**
384488
* Get details of the latest version
385489
* @summary Get the latest screen version
@@ -1246,6 +1350,33 @@ export const ScreensApiFp = function(configuration?: Configuration) {
12461350
const localVarAxiosArgs = await localVarAxiosParamCreator.createScreenVersion(projectId, screenId, image, commitMessage, commitColor, options);
12471351
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
12481352
},
1353+
/**
1354+
* Delete a comment on the screen note
1355+
* @summary Delete comment
1356+
* @param {string} projectId Project id
1357+
* @param {string} screenId Screen id
1358+
* @param {string} noteId Screen note id
1359+
* @param {string} commentId Screen comment id
1360+
* @param {*} [options] Override http request option.
1361+
* @throws {RequiredError}
1362+
*/
1363+
async deleteScreenComment(projectId: string, screenId: string, noteId: string, commentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
1364+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteScreenComment(projectId, screenId, noteId, commentId, options);
1365+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1366+
},
1367+
/**
1368+
* Delete a note on the screen
1369+
* @summary Delete a note
1370+
* @param {string} projectId Project id
1371+
* @param {string} screenId Screen id
1372+
* @param {string} noteId Screen note id
1373+
* @param {*} [options] Override http request option.
1374+
* @throws {RequiredError}
1375+
*/
1376+
async deleteScreenNote(projectId: string, screenId: string, noteId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
1377+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteScreenNote(projectId, screenId, noteId, options);
1378+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1379+
},
12491380
/**
12501381
* Get details of the latest version
12511382
* @summary Get the latest screen version
@@ -1544,6 +1675,8 @@ export interface ScreensApiCreateScreenVersionBody {
15441675
}
15451676

15461677

1678+
1679+
15471680
/**
15481681
* Search parameters for getProjectScreens operation in ScreensApi.
15491682
* @export
@@ -1802,6 +1935,41 @@ export class ScreensApi extends BaseAPI {
18021935
};
18031936
}
18041937

1938+
/**
1939+
* Delete a comment on the screen note
1940+
* @summary Delete comment
1941+
* @param {string} projectId Project id
1942+
* @param {string} screenId Screen id
1943+
* @param {string} noteId Screen note id
1944+
* @param {string} commentId Screen comment id
1945+
* @param {*} [options] Override http request option.
1946+
* @throws {RequiredError}
1947+
* @memberof ScreensApi
1948+
*/
1949+
public async deleteScreenComment(projectId: string, screenId: string, noteId: string, commentId: string, options?: any) : Promise<AxiosResponse<void>> {
1950+
const screensApiFp = ScreensApiFp(this.configuration);
1951+
const request = await screensApiFp.deleteScreenComment(projectId, screenId, noteId, commentId, options);
1952+
const response = await request(this.axios, this.basePath);
1953+
return response;
1954+
}
1955+
1956+
/**
1957+
* Delete a note on the screen
1958+
* @summary Delete a note
1959+
* @param {string} projectId Project id
1960+
* @param {string} screenId Screen id
1961+
* @param {string} noteId Screen note id
1962+
* @param {*} [options] Override http request option.
1963+
* @throws {RequiredError}
1964+
* @memberof ScreensApi
1965+
*/
1966+
public async deleteScreenNote(projectId: string, screenId: string, noteId: string, options?: any) : Promise<AxiosResponse<void>> {
1967+
const screensApiFp = ScreensApiFp(this.configuration);
1968+
const request = await screensApiFp.deleteScreenNote(projectId, screenId, noteId, options);
1969+
const response = await request(this.axios, this.basePath);
1970+
return response;
1971+
}
1972+
18051973
/**
18061974
* Get details of the latest version
18071975
* @summary Get the latest screen version

0 commit comments

Comments
 (0)