-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathissues-api.ts
777 lines (678 loc) · 34.5 KB
/
issues-api.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
/* tslint:disable */
/* eslint-disable */
/**
* CVAT REST API
* REST API for Computer Vision Annotation Tool (CVAT)
*
* The version of the OpenAPI document: 2.31.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
// URLSearchParams not necessarily used
// @ts-ignore
import { URL, URLSearchParams } from 'url';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
// @ts-ignore
import type { IssueRead } from '../models';
// @ts-ignore
import type { IssueWriteRequest } from '../models';
// @ts-ignore
import type { PaginatedIssueReadList } from '../models';
// @ts-ignore
import type { PatchedIssueWriteRequest } from '../models';
/**
* IssuesApi - axios parameter creator
* @export
*/
export const IssuesApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* @summary Create an issue
* @param {IssueWriteRequest} issueWriteRequest
* @param {string} [xOrganization] Organization unique slug
* @param {string} [org] Organization unique slug
* @param {number} [orgId] Organization identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
issuesCreate: async (issueWriteRequest: IssueWriteRequest, xOrganization?: string, org?: string, orgId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'issueWriteRequest' is not null or undefined
assertParamExists('issuesCreate', 'issueWriteRequest', issueWriteRequest)
const localVarPath = `/api/issues`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication signatureAuth required
await setApiKeyToObject(localVarQueryParameter, "sign", configuration)
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tokenAuth required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
// authentication csrfAuth required
// authentication sessionAuth required
if (org !== undefined) {
localVarQueryParameter['org'] = org;
}
if (orgId !== undefined) {
localVarQueryParameter['org_id'] = orgId;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
if (xOrganization != null) {
localVarHeaderParameter['X-Organization'] = String(xOrganization);
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(issueWriteRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Delete an issue
* @param {number} id A unique integer value identifying this issue.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
issuesDestroy: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('issuesDestroy', 'id', id)
const localVarPath = `/api/issues/{id}`
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication signatureAuth required
await setApiKeyToObject(localVarQueryParameter, "sign", configuration)
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tokenAuth required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
// authentication csrfAuth required
// authentication sessionAuth required
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary List issues
* @param {string} [xOrganization] Organization unique slug
* @param {string} [assignee] A simple equality filter for the assignee field
* @param {string} [filter] JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [\'owner\', \'assignee\', \'id\', \'job_id\', \'task_id\', \'resolved\', \'frame_id\'].
* @param {number} [frameId] A simple equality filter for the frame_id field
* @param {number} [jobId] A simple equality filter for the job_id field
* @param {string} [org] Organization unique slug
* @param {number} [orgId] Organization identifier
* @param {string} [owner] A simple equality filter for the owner field
* @param {number} [page] A page number within the paginated result set.
* @param {number} [pageSize] Number of results to return per page.
* @param {boolean} [resolved] A simple equality filter for the resolved field
* @param {string} [search] A search term. Available search_fields: (\'owner\', \'assignee\')
* @param {string} [sort] Which field to use when ordering the results. Available ordering_fields: [\'owner\', \'assignee\', \'id\', \'job_id\', \'task_id\', \'resolved\', \'frame_id\']
* @param {number} [taskId] A simple equality filter for the task_id field
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
issuesList: async (xOrganization?: string, assignee?: string, filter?: string, frameId?: number, jobId?: number, org?: string, orgId?: number, owner?: string, page?: number, pageSize?: number, resolved?: boolean, search?: string, sort?: string, taskId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/api/issues`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication signatureAuth required
await setApiKeyToObject(localVarQueryParameter, "sign", configuration)
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tokenAuth required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
// authentication csrfAuth required
// authentication sessionAuth required
if (assignee !== undefined) {
localVarQueryParameter['assignee'] = assignee;
}
if (filter !== undefined) {
localVarQueryParameter['filter'] = filter;
}
if (frameId !== undefined) {
localVarQueryParameter['frame_id'] = frameId;
}
if (jobId !== undefined) {
localVarQueryParameter['job_id'] = jobId;
}
if (org !== undefined) {
localVarQueryParameter['org'] = org;
}
if (orgId !== undefined) {
localVarQueryParameter['org_id'] = orgId;
}
if (owner !== undefined) {
localVarQueryParameter['owner'] = owner;
}
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}
if (pageSize !== undefined) {
localVarQueryParameter['page_size'] = pageSize;
}
if (resolved !== undefined) {
localVarQueryParameter['resolved'] = resolved;
}
if (search !== undefined) {
localVarQueryParameter['search'] = search;
}
if (sort !== undefined) {
localVarQueryParameter['sort'] = sort;
}
if (taskId !== undefined) {
localVarQueryParameter['task_id'] = taskId;
}
if (xOrganization != null) {
localVarHeaderParameter['X-Organization'] = String(xOrganization);
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Update an issue
* @param {number} id A unique integer value identifying this issue.
* @param {PatchedIssueWriteRequest} [patchedIssueWriteRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
issuesPartialUpdate: async (id: number, patchedIssueWriteRequest?: PatchedIssueWriteRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('issuesPartialUpdate', 'id', id)
const localVarPath = `/api/issues/{id}`
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication signatureAuth required
await setApiKeyToObject(localVarQueryParameter, "sign", configuration)
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tokenAuth required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
// authentication csrfAuth required
// authentication sessionAuth required
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(patchedIssueWriteRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Get issue details
* @param {number} id A unique integer value identifying this issue.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
issuesRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('issuesRetrieve', 'id', id)
const localVarPath = `/api/issues/{id}`
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication signatureAuth required
await setApiKeyToObject(localVarQueryParameter, "sign", configuration)
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tokenAuth required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
// authentication csrfAuth required
// authentication sessionAuth required
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* IssuesApi - functional programming interface
* @export
*/
export const IssuesApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = IssuesApiAxiosParamCreator(configuration)
return {
/**
*
* @summary Create an issue
* @param {IssueWriteRequest} issueWriteRequest
* @param {string} [xOrganization] Organization unique slug
* @param {string} [org] Organization unique slug
* @param {number} [orgId] Organization identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async issuesCreate(issueWriteRequest: IssueWriteRequest, xOrganization?: string, org?: string, orgId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IssueRead>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.issuesCreate(issueWriteRequest, xOrganization, org, orgId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['IssuesApi.issuesCreate']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Delete an issue
* @param {number} id A unique integer value identifying this issue.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async issuesDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.issuesDestroy(id, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['IssuesApi.issuesDestroy']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary List issues
* @param {string} [xOrganization] Organization unique slug
* @param {string} [assignee] A simple equality filter for the assignee field
* @param {string} [filter] JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [\'owner\', \'assignee\', \'id\', \'job_id\', \'task_id\', \'resolved\', \'frame_id\'].
* @param {number} [frameId] A simple equality filter for the frame_id field
* @param {number} [jobId] A simple equality filter for the job_id field
* @param {string} [org] Organization unique slug
* @param {number} [orgId] Organization identifier
* @param {string} [owner] A simple equality filter for the owner field
* @param {number} [page] A page number within the paginated result set.
* @param {number} [pageSize] Number of results to return per page.
* @param {boolean} [resolved] A simple equality filter for the resolved field
* @param {string} [search] A search term. Available search_fields: (\'owner\', \'assignee\')
* @param {string} [sort] Which field to use when ordering the results. Available ordering_fields: [\'owner\', \'assignee\', \'id\', \'job_id\', \'task_id\', \'resolved\', \'frame_id\']
* @param {number} [taskId] A simple equality filter for the task_id field
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async issuesList(xOrganization?: string, assignee?: string, filter?: string, frameId?: number, jobId?: number, org?: string, orgId?: number, owner?: string, page?: number, pageSize?: number, resolved?: boolean, search?: string, sort?: string, taskId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedIssueReadList>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.issuesList(xOrganization, assignee, filter, frameId, jobId, org, orgId, owner, page, pageSize, resolved, search, sort, taskId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['IssuesApi.issuesList']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Update an issue
* @param {number} id A unique integer value identifying this issue.
* @param {PatchedIssueWriteRequest} [patchedIssueWriteRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async issuesPartialUpdate(id: number, patchedIssueWriteRequest?: PatchedIssueWriteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IssueRead>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.issuesPartialUpdate(id, patchedIssueWriteRequest, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['IssuesApi.issuesPartialUpdate']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Get issue details
* @param {number} id A unique integer value identifying this issue.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async issuesRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IssueRead>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.issuesRetrieve(id, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['IssuesApi.issuesRetrieve']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
}
};
/**
* IssuesApi - factory interface
* @export
*/
export const IssuesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = IssuesApiFp(configuration)
return {
/**
*
* @summary Create an issue
* @param {IssuesApiIssuesCreateRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
issuesCreate(requestParameters: IssuesApiIssuesCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<IssueRead> {
return localVarFp.issuesCreate(requestParameters.issueWriteRequest, requestParameters.xOrganization, requestParameters.org, requestParameters.orgId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Delete an issue
* @param {IssuesApiIssuesDestroyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
issuesDestroy(requestParameters: IssuesApiIssuesDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
return localVarFp.issuesDestroy(requestParameters.id, options).then((request) => request(axios, basePath));
},
/**
*
* @summary List issues
* @param {IssuesApiIssuesListRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
issuesList(requestParameters: IssuesApiIssuesListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedIssueReadList> {
return localVarFp.issuesList(requestParameters.xOrganization, requestParameters.assignee, requestParameters.filter, requestParameters.frameId, requestParameters.jobId, requestParameters.org, requestParameters.orgId, requestParameters.owner, requestParameters.page, requestParameters.pageSize, requestParameters.resolved, requestParameters.search, requestParameters.sort, requestParameters.taskId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Update an issue
* @param {IssuesApiIssuesPartialUpdateRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
issuesPartialUpdate(requestParameters: IssuesApiIssuesPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<IssueRead> {
return localVarFp.issuesPartialUpdate(requestParameters.id, requestParameters.patchedIssueWriteRequest, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Get issue details
* @param {IssuesApiIssuesRetrieveRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
issuesRetrieve(requestParameters: IssuesApiIssuesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise<IssueRead> {
return localVarFp.issuesRetrieve(requestParameters.id, options).then((request) => request(axios, basePath));
},
};
};
/**
* Request parameters for issuesCreate operation in IssuesApi.
* @export
* @interface IssuesApiIssuesCreateRequest
*/
export interface IssuesApiIssuesCreateRequest {
/**
*
* @type {IssueWriteRequest}
* @memberof IssuesApiIssuesCreate
*/
readonly issueWriteRequest: IssueWriteRequest
/**
* Organization unique slug
* @type {string}
* @memberof IssuesApiIssuesCreate
*/
readonly xOrganization?: string
/**
* Organization unique slug
* @type {string}
* @memberof IssuesApiIssuesCreate
*/
readonly org?: string
/**
* Organization identifier
* @type {number}
* @memberof IssuesApiIssuesCreate
*/
readonly orgId?: number
}
/**
* Request parameters for issuesDestroy operation in IssuesApi.
* @export
* @interface IssuesApiIssuesDestroyRequest
*/
export interface IssuesApiIssuesDestroyRequest {
/**
* A unique integer value identifying this issue.
* @type {number}
* @memberof IssuesApiIssuesDestroy
*/
readonly id: number
}
/**
* Request parameters for issuesList operation in IssuesApi.
* @export
* @interface IssuesApiIssuesListRequest
*/
export interface IssuesApiIssuesListRequest {
/**
* Organization unique slug
* @type {string}
* @memberof IssuesApiIssuesList
*/
readonly xOrganization?: string
/**
* A simple equality filter for the assignee field
* @type {string}
* @memberof IssuesApiIssuesList
*/
readonly assignee?: string
/**
* JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [\'owner\', \'assignee\', \'id\', \'job_id\', \'task_id\', \'resolved\', \'frame_id\'].
* @type {string}
* @memberof IssuesApiIssuesList
*/
readonly filter?: string
/**
* A simple equality filter for the frame_id field
* @type {number}
* @memberof IssuesApiIssuesList
*/
readonly frameId?: number
/**
* A simple equality filter for the job_id field
* @type {number}
* @memberof IssuesApiIssuesList
*/
readonly jobId?: number
/**
* Organization unique slug
* @type {string}
* @memberof IssuesApiIssuesList
*/
readonly org?: string
/**
* Organization identifier
* @type {number}
* @memberof IssuesApiIssuesList
*/
readonly orgId?: number
/**
* A simple equality filter for the owner field
* @type {string}
* @memberof IssuesApiIssuesList
*/
readonly owner?: string
/**
* A page number within the paginated result set.
* @type {number}
* @memberof IssuesApiIssuesList
*/
readonly page?: number
/**
* Number of results to return per page.
* @type {number}
* @memberof IssuesApiIssuesList
*/
readonly pageSize?: number
/**
* A simple equality filter for the resolved field
* @type {boolean}
* @memberof IssuesApiIssuesList
*/
readonly resolved?: boolean
/**
* A search term. Available search_fields: (\'owner\', \'assignee\')
* @type {string}
* @memberof IssuesApiIssuesList
*/
readonly search?: string
/**
* Which field to use when ordering the results. Available ordering_fields: [\'owner\', \'assignee\', \'id\', \'job_id\', \'task_id\', \'resolved\', \'frame_id\']
* @type {string}
* @memberof IssuesApiIssuesList
*/
readonly sort?: string
/**
* A simple equality filter for the task_id field
* @type {number}
* @memberof IssuesApiIssuesList
*/
readonly taskId?: number
}
/**
* Request parameters for issuesPartialUpdate operation in IssuesApi.
* @export
* @interface IssuesApiIssuesPartialUpdateRequest
*/
export interface IssuesApiIssuesPartialUpdateRequest {
/**
* A unique integer value identifying this issue.
* @type {number}
* @memberof IssuesApiIssuesPartialUpdate
*/
readonly id: number
/**
*
* @type {PatchedIssueWriteRequest}
* @memberof IssuesApiIssuesPartialUpdate
*/
readonly patchedIssueWriteRequest?: PatchedIssueWriteRequest
}
/**
* Request parameters for issuesRetrieve operation in IssuesApi.
* @export
* @interface IssuesApiIssuesRetrieveRequest
*/
export interface IssuesApiIssuesRetrieveRequest {
/**
* A unique integer value identifying this issue.
* @type {number}
* @memberof IssuesApiIssuesRetrieve
*/
readonly id: number
}
/**
* IssuesApi - object-oriented interface
* @export
* @class IssuesApi
* @extends {BaseAPI}
*/
export class IssuesApi extends BaseAPI {
/**
*
* @summary Create an issue
* @param {IssuesApiIssuesCreateRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IssuesApi
*/
public issuesCreate(requestParameters: IssuesApiIssuesCreateRequest, options?: RawAxiosRequestConfig) {
return IssuesApiFp(this.configuration).issuesCreate(requestParameters.issueWriteRequest, requestParameters.xOrganization, requestParameters.org, requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Delete an issue
* @param {IssuesApiIssuesDestroyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IssuesApi
*/
public issuesDestroy(requestParameters: IssuesApiIssuesDestroyRequest, options?: RawAxiosRequestConfig) {
return IssuesApiFp(this.configuration).issuesDestroy(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary List issues
* @param {IssuesApiIssuesListRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IssuesApi
*/
public issuesList(requestParameters: IssuesApiIssuesListRequest = {}, options?: RawAxiosRequestConfig) {
return IssuesApiFp(this.configuration).issuesList(requestParameters.xOrganization, requestParameters.assignee, requestParameters.filter, requestParameters.frameId, requestParameters.jobId, requestParameters.org, requestParameters.orgId, requestParameters.owner, requestParameters.page, requestParameters.pageSize, requestParameters.resolved, requestParameters.search, requestParameters.sort, requestParameters.taskId, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Update an issue
* @param {IssuesApiIssuesPartialUpdateRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IssuesApi
*/
public issuesPartialUpdate(requestParameters: IssuesApiIssuesPartialUpdateRequest, options?: RawAxiosRequestConfig) {
return IssuesApiFp(this.configuration).issuesPartialUpdate(requestParameters.id, requestParameters.patchedIssueWriteRequest, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Get issue details
* @param {IssuesApiIssuesRetrieveRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IssuesApi
*/
public issuesRetrieve(requestParameters: IssuesApiIssuesRetrieveRequest, options?: RawAxiosRequestConfig) {
return IssuesApiFp(this.configuration).issuesRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
}
}