forked from MrRefactoring/jira.js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathissueFieldConfigurations.ts
644 lines (613 loc) · 26.2 KB
/
issueFieldConfigurations.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
import * as Models from './models';
import * as Parameters from './parameters';
import { Callback } from '../callback';
import { Client } from '../clients';
import { RequestConfig } from '../requestConfig';
export class IssueFieldConfigurations {
constructor(private client: Client) {}
/**
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of field
* configurations. The list can be for all field configurations or a subset determined by any combination of these
* criteria:
*
* - A list of field configuration item IDs.
* - Whether the field configuration is a default.
* - Whether the field configuration name or description contains a query string.
*
* Only field configurations used in company-managed (classic) projects are returned.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async getAllFieldConfigurations<T = Models.PageBeanFieldConfigurationDetails>(
parameters: Parameters.GetAllFieldConfigurations | undefined,
callback: Callback<T>,
): Promise<void>;
/**
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of field
* configurations. The list can be for all field configurations or a subset determined by any combination of these
* criteria:
*
* - A list of field configuration item IDs.
* - Whether the field configuration is a default.
* - Whether the field configuration name or description contains a query string.
*
* Only field configurations used in company-managed (classic) projects are returned.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async getAllFieldConfigurations<T = Models.PageBeanFieldConfigurationDetails>(
parameters?: Parameters.GetAllFieldConfigurations,
callback?: never,
): Promise<T>;
async getAllFieldConfigurations<T = Models.PageBeanFieldConfigurationDetails>(
parameters?: Parameters.GetAllFieldConfigurations,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: '/rest/api/3/fieldconfiguration',
method: 'GET',
params: {
startAt: parameters?.startAt,
maxResults: parameters?.maxResults,
id: parameters?.id,
isDefault: parameters?.isDefault,
query: parameters?.query,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Creates a field configuration. The field configuration is created with the same field properties as the default
* configuration, with all the fields being optional.
*
* This operation can only create configurations for use in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async createFieldConfiguration<T = Models.FieldConfiguration>(
parameters: Parameters.CreateFieldConfiguration | undefined,
callback: Callback<T>,
): Promise<void>;
/**
* Creates a field configuration. The field configuration is created with the same field properties as the default
* configuration, with all the fields being optional.
*
* This operation can only create configurations for use in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async createFieldConfiguration<T = Models.FieldConfiguration>(
parameters?: Parameters.CreateFieldConfiguration,
callback?: never,
): Promise<T>;
async createFieldConfiguration<T = Models.FieldConfiguration>(
parameters?: Parameters.CreateFieldConfiguration,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: '/rest/api/3/fieldconfiguration',
method: 'POST',
data: {
name: parameters?.name,
description: parameters?.description,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Updates a field configuration. The name and the description provided in the request override the existing values.
*
* This operation can only update configurations used in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async updateFieldConfiguration<T = void>(
parameters: Parameters.UpdateFieldConfiguration,
callback: Callback<T>,
): Promise<void>;
/**
* Updates a field configuration. The name and the description provided in the request override the existing values.
*
* This operation can only update configurations used in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async updateFieldConfiguration<T = void>(
parameters: Parameters.UpdateFieldConfiguration,
callback?: never,
): Promise<T>;
async updateFieldConfiguration<T = void>(
parameters: Parameters.UpdateFieldConfiguration,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/fieldconfiguration/${parameters.id}`,
method: 'PUT',
data: {
name: parameters.name,
description: parameters.description,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Deletes a field configuration.
*
* This operation can only delete configurations used in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async deleteFieldConfiguration<T = void>(
parameters: Parameters.DeleteFieldConfiguration,
callback: Callback<T>,
): Promise<void>;
/**
* Deletes a field configuration.
*
* This operation can only delete configurations used in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async deleteFieldConfiguration<T = void>(
parameters: Parameters.DeleteFieldConfiguration,
callback?: never,
): Promise<T>;
async deleteFieldConfiguration<T = void>(
parameters: Parameters.DeleteFieldConfiguration,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/fieldconfiguration/${parameters.id}`,
method: 'DELETE',
};
return this.client.sendRequest(config, callback);
}
/**
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of all
* fields for a configuration.
*
* Only the fields from configurations used in company-managed (classic) projects are returned.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async getFieldConfigurationItems<T = Models.PageFieldConfigurationItem>(
parameters: Parameters.GetFieldConfigurationItems,
callback: Callback<T>,
): Promise<void>;
/**
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of all
* fields for a configuration.
*
* Only the fields from configurations used in company-managed (classic) projects are returned.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async getFieldConfigurationItems<T = Models.PageFieldConfigurationItem>(
parameters: Parameters.GetFieldConfigurationItems,
callback?: never,
): Promise<T>;
async getFieldConfigurationItems<T = Models.PageFieldConfigurationItem>(
parameters: Parameters.GetFieldConfigurationItems,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/fieldconfiguration/${parameters.id}/fields`,
method: 'GET',
params: {
startAt: parameters.startAt,
maxResults: parameters.maxResults,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Updates fields in a field configuration. The properties of the field configuration fields provided override the
* existing values.
*
* This operation can only update field configurations used in company-managed (classic) projects.
*
* The operation can set the renderer for text fields to the default text renderer (`text-renderer`) or wiki style
* renderer (`wiki-renderer`). However, the renderer cannot be updated for fields using the autocomplete renderer
* (`autocomplete-renderer`).
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async updateFieldConfigurationItems<T = void>(
parameters: Parameters.UpdateFieldConfigurationItems,
callback: Callback<T>,
): Promise<void>;
/**
* Updates fields in a field configuration. The properties of the field configuration fields provided override the
* existing values.
*
* This operation can only update field configurations used in company-managed (classic) projects.
*
* The operation can set the renderer for text fields to the default text renderer (`text-renderer`) or wiki style
* renderer (`wiki-renderer`). However, the renderer cannot be updated for fields using the autocomplete renderer
* (`autocomplete-renderer`).
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async updateFieldConfigurationItems<T = void>(
parameters: Parameters.UpdateFieldConfigurationItems,
callback?: never,
): Promise<T>;
async updateFieldConfigurationItems<T = void>(
parameters: Parameters.UpdateFieldConfigurationItems,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/fieldconfiguration/${parameters.id}/fields`,
method: 'PUT',
data: {
fieldConfigurationItems: parameters.fieldConfigurationItems,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of field
* configuration schemes.
*
* Only field configuration schemes used in classic projects are returned.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async getAllFieldConfigurationSchemes<T = Models.PageFieldConfigurationScheme>(
parameters: Parameters.GetAllFieldConfigurationSchemes | undefined,
callback: Callback<T>,
): Promise<void>;
/**
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of field
* configuration schemes.
*
* Only field configuration schemes used in classic projects are returned.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async getAllFieldConfigurationSchemes<T = Models.PageFieldConfigurationScheme>(
parameters?: Parameters.GetAllFieldConfigurationSchemes,
callback?: never,
): Promise<T>;
async getAllFieldConfigurationSchemes<T = Models.PageFieldConfigurationScheme>(
parameters?: Parameters.GetAllFieldConfigurationSchemes,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: '/rest/api/3/fieldconfigurationscheme',
method: 'GET',
params: {
startAt: parameters?.startAt,
maxResults: parameters?.maxResults,
id: parameters?.id,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Creates a field configuration scheme.
*
* This operation can only create field configuration schemes used in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async createFieldConfigurationScheme<T = Models.FieldConfigurationScheme>(
parameters: Parameters.CreateFieldConfigurationScheme | undefined,
callback: Callback<T>,
): Promise<void>;
/**
* Creates a field configuration scheme.
*
* This operation can only create field configuration schemes used in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async createFieldConfigurationScheme<T = Models.FieldConfigurationScheme>(
parameters?: Parameters.CreateFieldConfigurationScheme,
callback?: never,
): Promise<T>;
async createFieldConfigurationScheme<T = Models.FieldConfigurationScheme>(
parameters?: Parameters.CreateFieldConfigurationScheme,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: '/rest/api/3/fieldconfigurationscheme',
method: 'POST',
data: {
name: parameters?.name,
description: parameters?.description,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of field
* configuration issue type items.
*
* Only items used in classic projects are returned.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async getFieldConfigurationSchemeMappings<T = Models.PageFieldConfigurationIssueTypeItem>(
parameters: Parameters.GetFieldConfigurationSchemeMappings | undefined,
callback: Callback<T>,
): Promise<void>;
/**
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of field
* configuration issue type items.
*
* Only items used in classic projects are returned.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async getFieldConfigurationSchemeMappings<T = Models.PageFieldConfigurationIssueTypeItem>(
parameters?: Parameters.GetFieldConfigurationSchemeMappings,
callback?: never,
): Promise<T>;
async getFieldConfigurationSchemeMappings<T = Models.PageFieldConfigurationIssueTypeItem>(
parameters?: Parameters.GetFieldConfigurationSchemeMappings,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: '/rest/api/3/fieldconfigurationscheme/mapping',
method: 'GET',
params: {
startAt: parameters?.startAt,
maxResults: parameters?.maxResults,
fieldConfigurationSchemeId: parameters?.fieldConfigurationSchemeId,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of field
* configuration schemes and, for each scheme, a list of the projects that use it.
*
* The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to
* the default field configuration scheme.
*
* Only field configuration schemes used in classic projects are returned.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async getFieldConfigurationSchemeProjectMapping<T = Models.PageFieldConfigurationSchemeProjects>(
parameters: Parameters.GetFieldConfigurationSchemeProjectMapping,
callback: Callback<T>,
): Promise<void>;
/**
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of field
* configuration schemes and, for each scheme, a list of the projects that use it.
*
* The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to
* the default field configuration scheme.
*
* Only field configuration schemes used in classic projects are returned.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async getFieldConfigurationSchemeProjectMapping<T = Models.PageFieldConfigurationSchemeProjects>(
parameters: Parameters.GetFieldConfigurationSchemeProjectMapping,
callback?: never,
): Promise<T>;
async getFieldConfigurationSchemeProjectMapping<T = Models.PageFieldConfigurationSchemeProjects>(
parameters: Parameters.GetFieldConfigurationSchemeProjectMapping,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: '/rest/api/3/fieldconfigurationscheme/project',
method: 'GET',
params: {
startAt: parameters.startAt,
maxResults: parameters.maxResults,
projectId: parameters.projectId,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Assigns a field configuration scheme to a project. If the field configuration scheme ID is `null`, the operation
* assigns the default field configuration scheme.
*
* Field configuration schemes can only be assigned to classic projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async assignFieldConfigurationSchemeToProject<T = void>(
parameters: Parameters.AssignFieldConfigurationSchemeToProject | undefined,
callback: Callback<T>,
): Promise<void>;
/**
* Assigns a field configuration scheme to a project. If the field configuration scheme ID is `null`, the operation
* assigns the default field configuration scheme.
*
* Field configuration schemes can only be assigned to classic projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async assignFieldConfigurationSchemeToProject<T = void>(
parameters?: Parameters.AssignFieldConfigurationSchemeToProject,
callback?: never,
): Promise<T>;
async assignFieldConfigurationSchemeToProject<T = void>(
parameters?: Parameters.AssignFieldConfigurationSchemeToProject,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: '/rest/api/3/fieldconfigurationscheme/project',
method: 'PUT',
data: {
fieldConfigurationSchemeId: parameters?.fieldConfigurationSchemeId,
projectId: parameters?.projectId,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Updates a field configuration scheme.
*
* This operation can only update field configuration schemes used in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async updateFieldConfigurationScheme<T = void>(
parameters: Parameters.UpdateFieldConfigurationScheme,
callback: Callback<T>,
): Promise<void>;
/**
* Updates a field configuration scheme.
*
* This operation can only update field configuration schemes used in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async updateFieldConfigurationScheme<T = void>(
parameters: Parameters.UpdateFieldConfigurationScheme,
callback?: never,
): Promise<T>;
async updateFieldConfigurationScheme<T = void>(
parameters: Parameters.UpdateFieldConfigurationScheme,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/fieldconfigurationscheme/${parameters.id}`,
method: 'PUT',
data: {
name: parameters.name,
description: parameters.description,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Deletes a field configuration scheme.
*
* This operation can only delete field configuration schemes used in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async deleteFieldConfigurationScheme<T = void>(
parameters: Parameters.DeleteFieldConfigurationScheme,
callback: Callback<T>,
): Promise<void>;
/**
* Deletes a field configuration scheme.
*
* This operation can only delete field configuration schemes used in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async deleteFieldConfigurationScheme<T = void>(
parameters: Parameters.DeleteFieldConfigurationScheme,
callback?: never,
): Promise<T>;
async deleteFieldConfigurationScheme<T = void>(
parameters: Parameters.DeleteFieldConfigurationScheme,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/fieldconfigurationscheme/${parameters.id}`,
method: 'DELETE',
};
return this.client.sendRequest(config, callback);
}
/**
* Assigns issue types to field configurations on field configuration scheme.
*
* This operation can only modify field configuration schemes used in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async setFieldConfigurationSchemeMapping<T = void>(
parameters: Parameters.SetFieldConfigurationSchemeMapping,
callback: Callback<T>,
): Promise<void>;
/**
* Assigns issue types to field configurations on field configuration scheme.
*
* This operation can only modify field configuration schemes used in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async setFieldConfigurationSchemeMapping<T = void>(
parameters: Parameters.SetFieldConfigurationSchemeMapping,
callback?: never,
): Promise<T>;
async setFieldConfigurationSchemeMapping<T = void>(
parameters: Parameters.SetFieldConfigurationSchemeMapping,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/fieldconfigurationscheme/${parameters.id}/mapping`,
method: 'PUT',
data: {
mappings: parameters.mappings,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Removes issue types from the field configuration scheme.
*
* This operation can only modify field configuration schemes used in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async removeIssueTypesFromGlobalFieldConfigurationScheme<T = void>(
parameters: Parameters.RemoveIssueTypesFromGlobalFieldConfigurationScheme,
callback: Callback<T>,
): Promise<void>;
/**
* Removes issue types from the field configuration scheme.
*
* This operation can only modify field configuration schemes used in company-managed (classic) projects.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async removeIssueTypesFromGlobalFieldConfigurationScheme<T = void>(
parameters: Parameters.RemoveIssueTypesFromGlobalFieldConfigurationScheme,
callback?: never,
): Promise<T>;
async removeIssueTypesFromGlobalFieldConfigurationScheme<T = void>(
parameters: Parameters.RemoveIssueTypesFromGlobalFieldConfigurationScheme,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/fieldconfigurationscheme/${parameters.id}/mapping/delete`,
method: 'POST',
data: {
issueTypeIds: parameters.issueTypeIds,
},
};
return this.client.sendRequest(config, callback);
}
}