@resolution/jira-api-client 0.4.5 → 0.4.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -113,6 +113,1077 @@ exports.BaseJiraPlatformApiClientError = BaseJiraPlatformApiClientError;
113
113
  * @version 1001.0.0-SNAPSHOT-a74c1872dbb34b9f62b4c6fa130a93e7a0779597
114
114
  */
115
115
  class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
116
+ /**
117
+ * This resource represents an announcement banner. Use it to retrieve and update
118
+ * banner configuration.
119
+ *
120
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-announcement-banner
121
+ */
122
+ get announcementBanner() {
123
+ return this.getServiceInstance(AnnouncementBannerService_1.AnnouncementBannerService);
124
+ }
125
+ /**
126
+ * This resource represents app access rule data policies.
127
+ *
128
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-data-policies
129
+ */
130
+ get appDataPolicies() {
131
+ return this.getServiceInstance(AppDataPoliciesService_1.AppDataPoliciesService);
132
+ }
133
+ /**
134
+ * This resource represents application roles. Use it to get details of an
135
+ * application role or all application roles.
136
+ *
137
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-application-roles
138
+ */
139
+ get applicationRoles() {
140
+ return this.getServiceInstance(ApplicationRolesService_1.ApplicationRolesService);
141
+ }
142
+ /**
143
+ * This resource supports [app
144
+ * migrations](https://developer.atlassian.com/platform/app-migration/). Use it to:
145
+ * - [to request migrated workflow rules
146
+ * details](https://developer.atlassian.com/platform/app-migration/tutorials/migration-app-workflow-rules/).
147
+ * - [perform bulk updates of entity
148
+ * properties](https://developer.atlassian.com/platform/app-migration/tutorials/entity-properties-bulk-api/).
149
+ * - [perform bulk updates of issue custom field
150
+ * values](https://developer.atlassian.com/platform/app-migration/tutorials/migrating-app-custom-fields/).
151
+ *
152
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-migration
153
+ */
154
+ get appMigration() {
155
+ return this.getServiceInstance(AppMigrationService_1.AppMigrationService);
156
+ }
157
+ /**
158
+ * This resource represents app properties. Use it to store arbitrary data for your
159
+ * [Connect
160
+ * app](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps).
161
+ *
162
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-properties
163
+ */
164
+ get appProperties() {
165
+ return this.getServiceInstance(AppPropertiesService_1.AppPropertiesService);
166
+ }
167
+ /**
168
+ * This resource represents audits that record activities undertaken in Jira. Use
169
+ * it to get a list of audit records.
170
+ *
171
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-audit-records
172
+ */
173
+ get auditRecords() {
174
+ return this.getServiceInstance(AuditRecordsService_1.AuditRecordsService);
175
+ }
176
+ /**
177
+ * This resource represents system and custom avatars. Use it to obtain the
178
+ * details of system or custom avatars, add and remove avatars from a project or
179
+ * issue type, and obtain avatar images.
180
+ *
181
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars
182
+ */
183
+ get avatars() {
184
+ return this.getServiceInstance(AvatarsService_1.AvatarsService);
185
+ }
186
+ /**
187
+ * This resource represents classification levels.
188
+ *
189
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-classification-levels
190
+ */
191
+ get classificationLevels() {
192
+ return this.getServiceInstance(ClassificationLevelsService_1.ClassificationLevelsService);
193
+ }
194
+ /**
195
+ * This resource represents dashboards. Use it to obtain the details of dashboards
196
+ * as well as get, create, update, or remove item properties and gadgets from
197
+ * dashboards.
198
+ *
199
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards
200
+ */
201
+ get dashboards() {
202
+ return this.getServiceInstance(DashboardsService_1.DashboardsService);
203
+ }
204
+ /**
205
+ * This resource represents [modules registered
206
+ * dynamically](https://developer.atlassian.com/cloud/jira/platform/dynamic-modules/)
207
+ * by [Connect
208
+ * apps](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps).
209
+ *
210
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dynamic-modules
211
+ */
212
+ get dynamicModules() {
213
+ return this.getServiceInstance(DynamicModulesService_1.DynamicModulesService);
214
+ }
215
+ /**
216
+ * This resource represents options for sharing [filters](#api-group-Filters). Use
217
+ * it to get share scopes as well as add and remove share scopes from filters.
218
+ *
219
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filter-sharing
220
+ */
221
+ get filterSharing() {
222
+ return this.getServiceInstance(FilterSharingService_1.FilterSharingService);
223
+ }
224
+ /**
225
+ * This resource represents [filters](https://confluence.atlassian.com/x/eQiiLQ).
226
+ * Use it to get, create, update, or delete filters. Also use it to configure the
227
+ * columns for a filter and set favorite filters.
228
+ *
229
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters
230
+ */
231
+ get filters() {
232
+ return this.getServiceInstance(FiltersService_1.FiltersService);
233
+ }
234
+ /**
235
+ * This resource represents a list of users and a list of groups. Use it to obtain
236
+ * the details to populate user and group picker suggestions list.
237
+ *
238
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-group-and-user-picker
239
+ */
240
+ get groupAndUserPicker() {
241
+ return this.getServiceInstance(GroupAndUserPickerService_1.GroupAndUserPickerService);
242
+ }
243
+ /**
244
+ * This resource represents groups of users. Use it to get, create, find, and
245
+ * delete groups as well as add and remove users from groups. (\[WARNING\] The
246
+ * standard Atlassian group names are default names only and can be edited or
247
+ * deleted. For example, an admin or Atlassian support could delete the default
248
+ * group jira-software-users or rename it to jsw-users at any point. See
249
+ * https://support.atlassian.com/user-management/docs/create-and-update-groups/
250
+ * for details.)
251
+ *
252
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups
253
+ */
254
+ get groups() {
255
+ return this.getServiceInstance(GroupsService_1.GroupsService);
256
+ }
257
+ /**
258
+ * This resource represents issue attachments and the attachment settings for
259
+ * Jira. Use it to get the metadata for an attachment, delete an attachment, and
260
+ * view the metadata for the contents of an attachment. Also, use it to get the
261
+ * attachment settings for Jira.
262
+ *
263
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments
264
+ */
265
+ get issueAttachments() {
266
+ return this.getServiceInstance(IssueAttachmentsService_1.IssueAttachmentsService);
267
+ }
268
+ /**
269
+ * This resource represents the Issue Bulk Operations. Use it to move multiple
270
+ * issues from one project to another project or edit fields of multiple issues in
271
+ * one go.
272
+ *
273
+ * ### Authentication ###
274
+ *
275
+ * Access to the Issue Bulk Operations requires authentication. For information on
276
+ * how to authenticate API requests, refer to the [Basic Auth for REST APIs
277
+ * documentation](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).
278
+ *
279
+ * ### Rate Limiting ###
280
+ *
281
+ * The Bulk Edit and Move APIs are subject to the usual rate limiting
282
+ * infrastructure in Jira. For more information, please refer to [Rate
283
+ * Limiting](https://developer.atlassian.com/cloud/jira/platform/rate-limiting/).
284
+ * Additionally, at any given time, only 5 concurrent requests can be sent across
285
+ * all users.
286
+ *
287
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-bulk-operations
288
+ */
289
+ get issueBulkOperations() {
290
+ return this.getServiceInstance(IssueBulkOperationsService_1.IssueBulkOperationsService);
291
+ }
292
+ /**
293
+ * This resource represents [issue comment](#api-group-Issue-comments) properties,
294
+ * which provides for storing custom data against an issue comment. Use is to get,
295
+ * set, and delete issue comment properties as well as obtain the keys of all
296
+ * properties on a comment. Comment properties are a type of [entity
297
+ * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
298
+ *
299
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comment-properties
300
+ */
301
+ get issueCommentProperties() {
302
+ return this.getServiceInstance(IssueCommentPropertiesService_1.IssueCommentPropertiesService);
303
+ }
304
+ /**
305
+ * This resource represents issue comments. Use it to:
306
+ *
307
+ * * get, create, update, and delete a comment from an issue.
308
+ * * get all comments from issue.
309
+ * * get a list of comments by comment ID.
310
+ *
311
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments
312
+ */
313
+ get issueComments() {
314
+ return this.getServiceInstance(IssueCommentsService_1.IssueCommentsService);
315
+ }
316
+ /**
317
+ * This resource represents configurations stored against a custom field context
318
+ * by a [Forge app](https://developer.atlassian.com/platform/forge/).
319
+ * Configurations are information used by the Forge app at runtime to determine
320
+ * how to handle or process the data in a custom field in a given context. Use
321
+ * this resource to set and read configurations.
322
+ *
323
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-configuration-apps-
324
+ */
325
+ get issueCustomFieldConfigurationApps() {
326
+ return this.getServiceInstance(IssueCustomFieldConfigurationAppsService_1.IssueCustomFieldConfigurationAppsService);
327
+ }
328
+ /**
329
+ * This resource represents issue custom field contexts. Use it to:
330
+ *
331
+ * * get, create, update, and delete custom field contexts.
332
+ * * get context to issue types and projects mappings.
333
+ * * get custom field contexts for projects and issue types.
334
+ * * assign custom field contexts to projects.
335
+ * * remove custom field contexts from projects.
336
+ * * add issue types to custom field contexts.
337
+ *
338
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts
339
+ */
340
+ get issueCustomFieldContexts() {
341
+ return this.getServiceInstance(IssueCustomFieldContextsService_1.IssueCustomFieldContextsService);
342
+ }
343
+ /**
344
+ * This resource represents custom issue field select list options created by a
345
+ * Connect app. See [Issue custom field
346
+ * options](#api-group-Issue-custom-field-options) to manipulate options created
347
+ * in Jira or using the REST API.
348
+ *
349
+ * A select list issue field is a type of [issue
350
+ * field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/)
351
+ * that enables a user to select an option from a list. Use it to add, remove, and
352
+ * update the options of a select list issue field.
353
+ *
354
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-
355
+ */
356
+ get issueCustomFieldOptionsApps() {
357
+ return this.getServiceInstance(IssueCustomFieldOptionsAppsService_1.IssueCustomFieldOptionsAppsService);
358
+ }
359
+ /**
360
+ * This resource represents custom issue field select list options created in Jira
361
+ * or using the REST API. This resource supports the following field types:
362
+ *
363
+ * * Checkboxes.
364
+ * * Radio Buttons.
365
+ * * Select List (single choice).
366
+ * * Select List (multiple choices).
367
+ * * Select List (cascading).
368
+ *
369
+ * See [Issue custom field options
370
+ * (apps)](#api-group-Issue-custom-field-options--apps-) to manipulate custom
371
+ * issue field select list options created by a Connect app.
372
+ *
373
+ * Use it to retrieve, create, update, order, and delete custom field options.
374
+ *
375
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options
376
+ */
377
+ get issueCustomFieldOptions() {
378
+ return this.getServiceInstance(IssueCustomFieldOptionsService_1.IssueCustomFieldOptionsService);
379
+ }
380
+ /**
381
+ * This resource represents the values of custom fields added by [Forge
382
+ * apps](https://developer.atlassian.com/platform/forge/). Use it to update the
383
+ * value of a custom field on issues.
384
+ *
385
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-values-apps-
386
+ */
387
+ get issueCustomFieldValuesApps() {
388
+ return this.getServiceInstance(IssueCustomFieldValuesAppsService_1.IssueCustomFieldValuesAppsService);
389
+ }
390
+ /**
391
+ * This resource represents issue field configurations. Use it to get, set, and
392
+ * delete field configurations and field configuration schemes.
393
+ *
394
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations
395
+ */
396
+ get issueFieldConfigurations() {
397
+ return this.getServiceInstance(IssueFieldConfigurationsService_1.IssueFieldConfigurationsService);
398
+ }
399
+ /**
400
+ * This resource represents issue fields, both system and custom fields. Use it to
401
+ * get fields, field configurations, and create custom fields.
402
+ *
403
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields
404
+ */
405
+ get issueFields() {
406
+ return this.getServiceInstance(IssueFieldsService_1.IssueFieldsService);
407
+ }
408
+ /**
409
+ * This resource represents links between issues. Use it to get, create, and
410
+ * delete links between issues.
411
+ *
412
+ * To use it, the site must have [issue
413
+ * linking](https://confluence.atlassian.com/x/yoXKM) enabled.
414
+ *
415
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-links
416
+ */
417
+ get issueLinks() {
418
+ return this.getServiceInstance(IssueLinksService_1.IssueLinksService);
419
+ }
420
+ /**
421
+ * This resource represents [issue link](#api-group-Issue-links) types. Use it to
422
+ * get, create, update, and delete link issue types as well as get lists of all
423
+ * link issue types.
424
+ *
425
+ * To use it, the site must have [issue
426
+ * linking](https://confluence.atlassian.com/x/yoXKM) enabled.
427
+ *
428
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-link-types
429
+ */
430
+ get issueLinkTypes() {
431
+ return this.getServiceInstance(IssueLinkTypesService_1.IssueLinkTypesService);
432
+ }
433
+ /**
434
+ * This resource represents issue navigator settings. Use it to get and set issue
435
+ * navigator default columns.
436
+ *
437
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-navigator-settings
438
+ */
439
+ get issueNavigatorSettings() {
440
+ return this.getServiceInstance(IssueNavigatorSettingsService_1.IssueNavigatorSettingsService);
441
+ }
442
+ /**
443
+ * This resource represents notification schemes, lists of events and the
444
+ * recipients who will receive notifications for those events. Use it to get
445
+ * details of a notification scheme and a list of notification schemes.
446
+ *
447
+ * ### About notification schemes ###
448
+ *
449
+ * A notification scheme is a list of events and recipients who will receive
450
+ * notifications for those events. The list is contained within the
451
+ * `notificationSchemeEvents` object and contains pairs of `events` and
452
+ * `notifications`:
453
+ *
454
+ * * `event` Identifies the type of event. The events can be [Jira system
455
+ * events](https://support.atlassian.com/jira-cloud-administration/docs/configure-notification-schemes/)
456
+ * (see the *Events* section) or [custom
457
+ * events](https://support.atlassian.com/jira-cloud-administration/docs/add-a-custom-event/).
458
+ * * `notifications` Identifies the
459
+ * [recipients](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-recipientsRecipients)
460
+ * of notifications for each event. Recipients can be any of the following types:
461
+ *
462
+ * * `CurrentAssignee`
463
+ * * `Reporter`
464
+ * * `CurrentUser`
465
+ * * `ProjectLead`
466
+ * * `ComponentLead`
467
+ * * `User` (the `parameter` is the user key)
468
+ * * `Group` (the `parameter` is the group name)
469
+ * * `ProjectRole` (the `parameter` is the project role ID)
470
+ * * `EmailAddress` *(deprecated)*
471
+ * * `AllWatchers`
472
+ * * `UserCustomField` (the `parameter` is the ID of the custom field)
473
+ * * `GroupCustomField`(the `parameter` is the ID of the custom field)
474
+ *
475
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes
476
+ */
477
+ get issueNotificationSchemes() {
478
+ return this.getServiceInstance(IssueNotificationSchemesService_1.IssueNotificationSchemesService);
479
+ }
480
+ /**
481
+ * This resource represents issue priorities. Use it to get, create and update
482
+ * issue priorities and details for individual issue priorities.
483
+ *
484
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-priorities
485
+ */
486
+ get issuePriorities() {
487
+ return this.getServiceInstance(IssuePrioritiesService_1.IssuePrioritiesService);
488
+ }
489
+ /**
490
+ * This resource represents [issue](#api-group-Issues) properties, which provides
491
+ * for storing custom data against an issue. Use it to get, set, and delete issue
492
+ * properties as well as obtain details of all properties on an issue. Operations
493
+ * to bulk update and delete issue properties are also provided. Issue properties
494
+ * are a type of [entity
495
+ * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
496
+ *
497
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-properties
498
+ */
499
+ get issueProperties() {
500
+ return this.getServiceInstance(IssuePropertiesService_1.IssuePropertiesService);
501
+ }
502
+ /**
503
+ * This resource represents remote issue links, a way of linking Jira to
504
+ * information in other systems. Use it to get, create, update, and delete remote
505
+ * issue links either by ID or global ID. The global ID provides a way of
506
+ * accessing remote issue links using information about the item's remote system
507
+ * host and remote system identifier.
508
+ *
509
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-remote-links
510
+ */
511
+ get issueRemoteLinks() {
512
+ return this.getServiceInstance(IssueRemoteLinksService_1.IssueRemoteLinksService);
513
+ }
514
+ /**
515
+ * This resource represents issue resolution values. Use it to obtain a list of
516
+ * all issue resolution values and the details of individual resolution values.
517
+ *
518
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-resolutions
519
+ */
520
+ get issueResolutions() {
521
+ return this.getServiceInstance(IssueResolutionsService_1.IssueResolutionsService);
522
+ }
523
+ /**
524
+ * This resource represents various ways to search for issues. Use it to search
525
+ * for issues with a JQL query and find issues to populate an issue picker.
526
+ *
527
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search
528
+ */
529
+ get issueSearch() {
530
+ return this.getServiceInstance(IssueSearchService_1.IssueSearchService);
531
+ }
532
+ /**
533
+ * This resource represents issue security levels. Use it to obtain the details of
534
+ * any issue security level. For more information about issue security levels, see
535
+ * [Configuring issue-level security](https://confluence.atlassian.com/x/J4lKLg).
536
+ *
537
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-level
538
+ */
539
+ get issueSecurityLevel() {
540
+ return this.getServiceInstance(IssueSecurityLevelService_1.IssueSecurityLevelService);
541
+ }
542
+ /**
543
+ * This resource represents issue security schemes. Use it to get an issue
544
+ * security scheme or a list of issue security schemes.
545
+ *
546
+ * Issue security schemes control which users or groups of users can view an
547
+ * issue. When an issue security scheme is associated with a project, its security
548
+ * levels can be applied to issues in that project. Sub-tasks also inherit the
549
+ * security level of their parent issue.
550
+ *
551
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes
552
+ */
553
+ get issueSecuritySchemes() {
554
+ return this.getServiceInstance(IssueSecuritySchemesService_1.IssueSecuritySchemesService);
555
+ }
556
+ /**
557
+ * This resource represents Jira issues. Use it to:
558
+ *
559
+ * * create or edit issues, individually or in bulk.
560
+ * * retrieve metadata about the options for creating or editing issues.
561
+ * * delete an issue.
562
+ * * assign a user to an issue.
563
+ * * get issue changelogs.
564
+ * * send notifications about an issue.
565
+ * * get details of the transitions available for an issue.
566
+ * * transition an issue.
567
+ * * Archive issues.
568
+ * * Unarchive issues.
569
+ * * Export archived issues.
570
+ *
571
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues
572
+ */
573
+ get issues() {
574
+ return this.getServiceInstance(IssuesService_1.IssuesService);
575
+ }
576
+ /**
577
+ * This resource represents [issue type](#api-group-Issue-types) properties, which
578
+ * provides for storing custom data against an issue type. Use it to get, create,
579
+ * and delete issue type properties as well as obtain the keys of all properties
580
+ * on a issues type. Issue type properties are a type of [entity
581
+ * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
582
+ *
583
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-properties
584
+ */
585
+ get issueTypeProperties() {
586
+ return this.getServiceInstance(IssueTypePropertiesService_1.IssueTypePropertiesService);
587
+ }
588
+ /**
589
+ * This resource represents issue type schemes in classic projects. Use it to:
590
+ *
591
+ * * get issue type schemes and a list of the projects that use them.
592
+ * * associate issue type schemes with projects.
593
+ * * add issue types to issue type schemes.
594
+ * * delete issue types from issue type schemes.
595
+ * * create, update, and delete issue type schemes.
596
+ * * change the order of issue types in issue type schemes.
597
+ *
598
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes
599
+ */
600
+ get issueTypeSchemes() {
601
+ return this.getServiceInstance(IssueTypeSchemesService_1.IssueTypeSchemesService);
602
+ }
603
+ /**
604
+ * This resource represents issue type screen schemes. Use it to:
605
+ *
606
+ * * get issue type screen schemes and a list of the projects that use them.
607
+ * * create issue type screen schemes.
608
+ * * update issue type screen schemes.
609
+ * * delete issue type screen schemes.
610
+ * * associate issue type screen schemes with projects.
611
+ * * append issue type to screen scheme mappings to issue type screen schemes.
612
+ * * remove issue type to screen scheme mappings from issue type screen schemes.
613
+ * * update default screen scheme of issue type screen scheme.
614
+ *
615
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes
616
+ */
617
+ get issueTypeScreenSchemes() {
618
+ return this.getServiceInstance(IssueTypeScreenSchemesService_1.IssueTypeScreenSchemesService);
619
+ }
620
+ /**
621
+ * This resource represents issues types. Use it to:
622
+ *
623
+ * * get, create, update, and delete issue types.
624
+ * * get all issue types for a user.
625
+ * * get alternative issue types.
626
+ * * set an avatar for an issue type.
627
+ *
628
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-types
629
+ */
630
+ get issueTypes() {
631
+ return this.getServiceInstance(IssueTypesService_1.IssueTypesService);
632
+ }
633
+ /**
634
+ * This resource represents votes cast by users on an issue. Use it to get details
635
+ * of votes on an issue as well as cast and withdrawal votes.
636
+ *
637
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-votes
638
+ */
639
+ get issueVotes() {
640
+ return this.getServiceInstance(IssueVotesService_1.IssueVotesService);
641
+ }
642
+ /**
643
+ * This resource represents users watching an issue. Use it to get details of
644
+ * users watching an issue as well as start and stop a user watching an issue.
645
+ *
646
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-watchers
647
+ */
648
+ get issueWatchers() {
649
+ return this.getServiceInstance(IssueWatchersService_1.IssueWatchersService);
650
+ }
651
+ /**
652
+ * This resource represents [issue worklog](#api-group-Issue-worklogs) properties,
653
+ * which provides for storing custom data against an issue worklog. Use it to get,
654
+ * create, and delete issue worklog properties as well as obtain the keys of all
655
+ * properties on a issue worklog. Issue worklog properties are a type of [entity
656
+ * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
657
+ *
658
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklog-properties
659
+ */
660
+ get issueWorklogProperties() {
661
+ return this.getServiceInstance(IssueWorklogPropertiesService_1.IssueWorklogPropertiesService);
662
+ }
663
+ /**
664
+ * This resource represents issue worklogs. Use it to:
665
+ *
666
+ * * get, create, update, and delete worklogs.
667
+ * * obtain lists of updated or deleted worklogs.
668
+ *
669
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs
670
+ */
671
+ get issueWorklogs() {
672
+ return this.getServiceInstance(IssueWorklogsService_1.IssueWorklogsService);
673
+ }
674
+ /**
675
+ * This resource is a collection of operations for [Jira
676
+ * expressions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/).
677
+ *
678
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-expressions
679
+ */
680
+ get jiraExpressions() {
681
+ return this.getServiceInstance(JiraExpressionsService_1.JiraExpressionsService);
682
+ }
683
+ /**
684
+ * This resource represents various settings in Jira. Use it to get and update
685
+ * Jira settings and properties.
686
+ *
687
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings
688
+ */
689
+ get jiraSettings() {
690
+ return this.getServiceInstance(JiraSettingsService_1.JiraSettingsService);
691
+ }
692
+ /**
693
+ * This resource represents JQL function's precomputations. Precomputation is a
694
+ * mapping between custom function call and JQL fragment returned by this
695
+ * function. Use it to get and update precomputations.
696
+ *
697
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql-functions-apps-
698
+ */
699
+ get jqlFunctionsApps() {
700
+ return this.getServiceInstance(JqlFunctionsAppsService_1.JqlFunctionsAppsService);
701
+ }
702
+ /**
703
+ * This resource represents JQL search auto-complete details. Use it to obtain JQL
704
+ * search auto-complete data and suggestions for use in programmatic construction
705
+ * of queries or custom query builders. It also provides operations to:
706
+ *
707
+ * * convert one or more JQL queries with user identifiers (username or user
708
+ * key) to equivalent JQL queries with account IDs.
709
+ * * convert readable details in one or more JQL queries to IDs where a user
710
+ * doesn't have permission to view the entity whose details are readable.
711
+ *
712
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql
713
+ */
714
+ get jql() {
715
+ return this.getServiceInstance(JqlService_1.JqlService);
716
+ }
717
+ /**
718
+ * This resource represents available labels. Use it to get available labels for
719
+ * the global label field.
720
+ *
721
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-labels
722
+ */
723
+ get labels() {
724
+ return this.getServiceInstance(LabelsService_1.LabelsService);
725
+ }
726
+ /**
727
+ * This resource represents license metrics. Use it to get available metrics for
728
+ * Jira licences.
729
+ *
730
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics
731
+ */
732
+ get licenseMetrics() {
733
+ return this.getServiceInstance(LicenseMetricsService_1.LicenseMetricsService);
734
+ }
735
+ /**
736
+ * This resource represents information about the current user, such as basic
737
+ * details, group membership, application roles, preferences, and locale. Use it
738
+ * to get, create, update, and delete (restore default) values of the user's
739
+ * preferences and locale.
740
+ *
741
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-myself
742
+ */
743
+ get myself() {
744
+ return this.getServiceInstance(MyselfService_1.MyselfService);
745
+ }
746
+ /**
747
+ * This resource represents permission schemes. Use it to get, create, update, and
748
+ * delete permission schemes as well as get, create, update, and delete details of
749
+ * the permissions granted in those schemes.
750
+ *
751
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes
752
+ */
753
+ get permissionSchemes() {
754
+ return this.getServiceInstance(PermissionSchemesService_1.PermissionSchemesService);
755
+ }
756
+ /**
757
+ * This resource represents permissions. Use it to obtain details of all
758
+ * permissions and determine whether the user has certain permissions.
759
+ *
760
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permissions
761
+ */
762
+ get permissions() {
763
+ return this.getServiceInstance(PermissionsService_1.PermissionsService);
764
+ }
765
+ /**
766
+ * This resource represents issue priority schemes. Use it to get priority schemes
767
+ * and related information, and to create, update and delete priority schemes.
768
+ *
769
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-priority-schemes
770
+ */
771
+ get prioritySchemes() {
772
+ return this.getServiceInstance(PrioritySchemesService_1.PrioritySchemesService);
773
+ }
774
+ /**
775
+ * This resource represents avatars associated with a project. Use it to get,
776
+ * load, set, and remove project avatars.
777
+ *
778
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-avatars
779
+ */
780
+ get projectAvatars() {
781
+ return this.getServiceInstance(ProjectAvatarsService_1.ProjectAvatarsService);
782
+ }
783
+ /**
784
+ * This resource represents project categories. Use it to create, update, and
785
+ * delete project categories as well as obtain a list of all project categories
786
+ * and details of individual categories. For more information on managing project
787
+ * categories, see [Adding, assigning, and deleting project
788
+ * categories](https://confluence.atlassian.com/x/-A5WMg).
789
+ *
790
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories
791
+ */
792
+ get projectCategories() {
793
+ return this.getServiceInstance(ProjectCategoriesService_1.ProjectCategoriesService);
794
+ }
795
+ /**
796
+ * This resource represents classification levels used in a project. Use it to
797
+ * view and manage classification levels in your projects.
798
+ *
799
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-classification-levels
800
+ */
801
+ get projectClassificationLevels() {
802
+ return this.getServiceInstance(ProjectClassificationLevelsService_1.ProjectClassificationLevelsService);
803
+ }
804
+ /**
805
+ * This resource represents project components. Use it to get, create, update, and
806
+ * delete project components. Also get components for project and get a count of
807
+ * issues by component.
808
+ *
809
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-components
810
+ */
811
+ get projectComponents() {
812
+ return this.getServiceInstance(ProjectComponentsService_1.ProjectComponentsService);
813
+ }
814
+ /**
815
+ * This resource represents the email address used to send a project's
816
+ * notifications. Use it to get and set the [project's sender email
817
+ * address](https://confluence.atlassian.com/x/dolKLg).
818
+ *
819
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-email
820
+ */
821
+ get projectEmail() {
822
+ return this.getServiceInstance(ProjectEmailService_1.ProjectEmailService);
823
+ }
824
+ /**
825
+ * This resource represents project features. Use it to get the list of features
826
+ * for a project and modify the state of a feature. The project feature endpoint
827
+ * is available only for Jira Software, both for team- and company-managed
828
+ * projects.
829
+ *
830
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-features
831
+ */
832
+ get projectFeatures() {
833
+ return this.getServiceInstance(ProjectFeaturesService_1.ProjectFeaturesService);
834
+ }
835
+ /**
836
+ * This resource provides validation for project keys and names.
837
+ *
838
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation
839
+ */
840
+ get projectKeyAndNameValidation() {
841
+ return this.getServiceInstance(ProjectKeyAndNameValidationService_1.ProjectKeyAndNameValidationService);
842
+ }
843
+ /**
844
+ * This resource represents permission schemes for a project. Use this resource to:
845
+ *
846
+ * * get details of a project's issue security levels available to the calling
847
+ * user.
848
+ * * get the permission scheme associated with the project or assign different
849
+ * permission scheme to the project.
850
+ * * get details of a project's issue security scheme.
851
+ *
852
+ * See [Managing project permissions](https://confluence.atlassian.com/x/yodKLg)
853
+ * for more information about permission schemes.
854
+ *
855
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes
856
+ */
857
+ get projectPermissionSchemes() {
858
+ return this.getServiceInstance(ProjectPermissionSchemesService_1.ProjectPermissionSchemesService);
859
+ }
860
+ /**
861
+ * This resource represents [project](#api-group-Projects) properties, which
862
+ * provides for storing custom data against a project. Use it to get, create, and
863
+ * delete project properties as well as get a list of property keys for a project.
864
+ * Project properties are a type of [entity
865
+ * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
866
+ *
867
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-properties
868
+ */
869
+ get projectProperties() {
870
+ return this.getServiceInstance(ProjectPropertiesService_1.ProjectPropertiesService);
871
+ }
872
+ /**
873
+ * This resource represents the users assigned to [project
874
+ * roles](#api-group-Issue-comments). Use it to get, add, and remove default users
875
+ * from project roles. Also use it to add and remove users from a project role
876
+ * associated with a project.
877
+ *
878
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-role-actors
879
+ */
880
+ get projectRoleActors() {
881
+ return this.getServiceInstance(ProjectRoleActorsService_1.ProjectRoleActorsService);
882
+ }
883
+ /**
884
+ * This resource represents the roles that users can play in projects. Use this
885
+ * resource to get, create, update, and delete project roles.
886
+ *
887
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles
888
+ */
889
+ get projectRoles() {
890
+ return this.getServiceInstance(ProjectRolesService_1.ProjectRolesService);
891
+ }
892
+ /**
893
+ * This resource represents projects. Use it to get, create, update, and delete
894
+ * projects. Also get statuses available to a project, a project's notification
895
+ * schemes, and update a project's type.
896
+ *
897
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects
898
+ */
899
+ get projects() {
900
+ return this.getServiceInstance(ProjectsService_1.ProjectsService);
901
+ }
902
+ /**
903
+ * This resource represents project types. Use it to obtain a list of all project
904
+ * types, a list of project types accessible to the calling user, and details of a
905
+ * project type.
906
+ *
907
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-types
908
+ */
909
+ get projectTypes() {
910
+ return this.getServiceInstance(ProjectTypesService_1.ProjectTypesService);
911
+ }
912
+ /**
913
+ * This resource represents project versions. Use it to get, get lists of, create,
914
+ * update, move, merge, and delete project versions. This resource also provides
915
+ * counts of issues by version.
916
+ *
917
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions
918
+ */
919
+ get projectVersions() {
920
+ return this.getServiceInstance(ProjectVersionsService_1.ProjectVersionsService);
921
+ }
922
+ /**
923
+ * This resource represents screen schemes in classic projects. Use it to get,
924
+ * create, update, and delete screen schemes.
925
+ *
926
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-schemes
927
+ */
928
+ get screenSchemes() {
929
+ return this.getServiceInstance(ScreenSchemesService_1.ScreenSchemesService);
930
+ }
931
+ /**
932
+ * This resource represents the screens used to record issue details. Use it to:
933
+ *
934
+ * * get details of all screens.
935
+ * * get details of all the fields available for use on screens.
936
+ * * create screens.
937
+ * * delete screens.
938
+ * * update screens.
939
+ * * add a field to the default screen.
940
+ *
941
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens
942
+ */
943
+ get screens() {
944
+ return this.getServiceInstance(ScreensService_1.ScreensService);
945
+ }
946
+ /**
947
+ * This resource represents the screen tab fields used to record issue details.
948
+ * Use it to get, add, move, and remove fields from screen tabs.
949
+ *
950
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields
951
+ */
952
+ get screenTabFields() {
953
+ return this.getServiceInstance(ScreenTabFieldsService_1.ScreenTabFieldsService);
954
+ }
955
+ /**
956
+ * This resource represents the screen tabs used to record issue details. Use it
957
+ * to get, create, update, move, and delete screen tabs.
958
+ *
959
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tabs
960
+ */
961
+ get screenTabs() {
962
+ return this.getServiceInstance(ScreenTabsService_1.ScreenTabsService);
963
+ }
964
+ /**
965
+ * This resource provides information about the Jira instance.
966
+ *
967
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-server-info
968
+ */
969
+ get serverInfo() {
970
+ return this.getServiceInstance(ServerInfoService_1.ServerInfoService);
971
+ }
972
+ /**
973
+ * This resource represents a service registry. Use it to retrieve attributes
974
+ * related to a [service
975
+ * registry](https://support.atlassian.com/jira-service-management-cloud/docs/what-is-services/)
976
+ * in JSM.
977
+ *
978
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-service-registry
979
+ */
980
+ get serviceRegistry() {
981
+ return this.getServiceInstance(ServiceRegistryService_1.ServiceRegistryService);
982
+ }
983
+ /**
984
+ * This resource represents statuses. Use it to search, get, create, delete, and
985
+ * change statuses.
986
+ *
987
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-status
988
+ */
989
+ get status() {
990
+ return this.getServiceInstance(StatusService_1.StatusService);
991
+ }
992
+ /**
993
+ * This resource represents a [long-running asynchronous
994
+ * tasks](#async-operations). Use it to obtain details about the progress of a
995
+ * long-running task or cancel a long-running task.
996
+ *
997
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks
998
+ */
999
+ get tasks() {
1000
+ return this.getServiceInstance(TasksService_1.TasksService);
1001
+ }
1002
+ /**
1003
+ * This resource represents time tracking and time tracking providers. Use it to
1004
+ * get and set the time tracking provider, get and set the time tracking options,
1005
+ * and disable time tracking.
1006
+ *
1007
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-time-tracking
1008
+ */
1009
+ get timeTracking() {
1010
+ return this.getServiceInstance(TimeTrackingService_1.TimeTrackingService);
1011
+ }
1012
+ /**
1013
+ * UI modifications is a feature available for **Forge apps only**. It enables
1014
+ * Forge apps to control how selected Jira fields behave on the following views:
1015
+ * global issue create, issue view. For example: hide specific fields, set them as
1016
+ * required, etc.
1017
+ *
1018
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-ui-modifications-apps-
1019
+ */
1020
+ get uiModificationsApps() {
1021
+ return this.getServiceInstance(UiModificationsAppsService_1.UiModificationsAppsService);
1022
+ }
1023
+ /**
1024
+ * This resource represents [user](#api-group-Users) properties and provides for
1025
+ * storing custom data against a user. Use it to get, create, and delete user
1026
+ * properties as well as get a list of property keys for a user. This resourse is
1027
+ * designed for integrations and apps to store per-user data and settings. This
1028
+ * enables data used to customized the user experience to be kept in the Jira
1029
+ * Cloud instance's database. User properties are a type of [entity
1030
+ * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
1031
+ *
1032
+ * This resource does not access the [user
1033
+ * properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in
1034
+ * Jira.
1035
+ *
1036
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-properties
1037
+ */
1038
+ get userProperties() {
1039
+ return this.getServiceInstance(UserPropertiesService_1.UserPropertiesService);
1040
+ }
1041
+ /**
1042
+ * This resource represents various ways to search for and find users. Use it to
1043
+ * obtain list of users including users assignable to projects and issues, users
1044
+ * with permissions, user lists for pickup fields, and user lists generated using
1045
+ * structured queries. Note that the operations in this resource only return users
1046
+ * found within the first 1000 users.
1047
+ *
1048
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search
1049
+ */
1050
+ get userSearch() {
1051
+ return this.getServiceInstance(UserSearchService_1.UserSearchService);
1052
+ }
1053
+ /**
1054
+ * This resource represent users. Use it to:
1055
+ *
1056
+ * * get, get a list of, create, and delete users.
1057
+ * * get, set, and reset a user's default issue table columns.
1058
+ * * get a list of the groups the user belongs to.
1059
+ * * get a list of user account IDs for a list of usernames or user keys.
1060
+ *
1061
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users
1062
+ */
1063
+ get users() {
1064
+ return this.getServiceInstance(UsersService_1.UsersService);
1065
+ }
1066
+ /**
1067
+ * This resource represents webhooks. Webhooks are calls sent to a URL when an
1068
+ * event occurs in Jira for issues specified by a JQL query. Only Connect and
1069
+ * OAuth 2.0 apps can register and manage webhooks. For more information, see
1070
+ * [Webhooks](https://developer.atlassian.com/cloud/jira/platform/webhooks/#registering-a-webhook-via-the-jira-rest-api-for-connect-apps).
1071
+ *
1072
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks
1073
+ */
1074
+ get webhooks() {
1075
+ return this.getServiceInstance(WebhooksService_1.WebhooksService);
1076
+ }
1077
+ /**
1078
+ * This resource represents draft workflow schemes. Use it to manage drafts of
1079
+ * workflow schemes.
1080
+ *
1081
+ * A workflow scheme maps issue types to workflows. A workflow scheme can be
1082
+ * associated with one or more projects, which enables the projects to use the
1083
+ * workflow-issue type mappings.
1084
+ *
1085
+ * Active workflow schemes (workflow schemes that are used by projects) cannot be
1086
+ * edited. Editing an active workflow scheme creates a draft copy of the scheme.
1087
+ * The draft workflow scheme can then be edited and published (replacing the
1088
+ * active scheme).
1089
+ *
1090
+ * See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg)
1091
+ * for more information.
1092
+ *
1093
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts
1094
+ */
1095
+ get workflowSchemeDrafts() {
1096
+ return this.getServiceInstance(WorkflowSchemeDraftsService_1.WorkflowSchemeDraftsService);
1097
+ }
1098
+ /**
1099
+ * This resource represents the associations between workflow schemes and projects.
1100
+ *
1101
+ * For more information, see [Managing your
1102
+ * workflows](https://confluence.atlassian.com/x/q4hKLg).
1103
+ *
1104
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-project-associations
1105
+ */
1106
+ get workflowSchemeProjectAssociations() {
1107
+ return this.getServiceInstance(WorkflowSchemeProjectAssociationsService_1.WorkflowSchemeProjectAssociationsService);
1108
+ }
1109
+ /**
1110
+ * This resource represents workflow schemes. Use it to manage workflow schemes
1111
+ * and the workflow scheme's workflows and issue types.
1112
+ *
1113
+ * A workflow scheme maps issue types to workflows. A workflow scheme can be
1114
+ * associated with one or more projects, which enables the projects to use the
1115
+ * workflow-issue type mappings.
1116
+ *
1117
+ * Active workflow schemes (workflow schemes that are used by projects) cannot be
1118
+ * edited. When an active workflow scheme is edited, a draft copy of the scheme is
1119
+ * created. The draft workflow scheme is then be edited and published (replacing
1120
+ * the active scheme).
1121
+ *
1122
+ * See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg)
1123
+ * for more information.
1124
+ *
1125
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes
1126
+ */
1127
+ get workflowSchemes() {
1128
+ return this.getServiceInstance(WorkflowSchemesService_1.WorkflowSchemesService);
1129
+ }
1130
+ /**
1131
+ * This resource represents workflows. Use it to:
1132
+ *
1133
+ * * Get workflows
1134
+ * * Create workflows
1135
+ * * Update workflows
1136
+ * * Delete inactive workflows
1137
+ * * Get workflow capabilities
1138
+ *
1139
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows
1140
+ */
1141
+ get workflows() {
1142
+ return this.getServiceInstance(WorkflowsService_1.WorkflowsService);
1143
+ }
1144
+ /**
1145
+ * This resource represents status categories. Use it to obtain a list of all
1146
+ * status categories and the details of a category. Status categories provided a
1147
+ * mechanism for categorizing [statuses](#api-group-Workflow-statuses).
1148
+ *
1149
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-status-categories
1150
+ */
1151
+ get workflowStatusCategories() {
1152
+ return this.getServiceInstance(WorkflowStatusCategoriesService_1.WorkflowStatusCategoriesService);
1153
+ }
1154
+ /**
1155
+ * This resource represents issue workflow statuses. Use it to obtain a list of
1156
+ * all statuses associated with workflows and the details of a status.
1157
+ *
1158
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-statuses
1159
+ */
1160
+ get workflowStatuses() {
1161
+ return this.getServiceInstance(WorkflowStatusesService_1.WorkflowStatusesService);
1162
+ }
1163
+ /**
1164
+ * This resource represents workflow transition properties, which provides for
1165
+ * storing custom data against a workflow transition. Use it to get, create, and
1166
+ * delete workflow transition properties as well as get a list of property keys
1167
+ * for a workflow transition. Workflow transition properties are a type of [entity
1168
+ * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
1169
+ *
1170
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-properties
1171
+ */
1172
+ get workflowTransitionProperties() {
1173
+ return this.getServiceInstance(WorkflowTransitionPropertiesService_1.WorkflowTransitionPropertiesService);
1174
+ }
1175
+ /**
1176
+ * This resource represents workflow transition rules. Workflow transition rules
1177
+ * define a Connect or a Forge app routine, such as a [workflow post
1178
+ * functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/)
1179
+ * that is executed in association with the workflow. Use it to read and modify
1180
+ * configuration of workflow transition rules.
1181
+ *
1182
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules
1183
+ */
1184
+ get workflowTransitionRules() {
1185
+ return this.getServiceInstance(WorkflowTransitionRulesService_1.WorkflowTransitionRulesService);
1186
+ }
116
1187
  constructor(options) {
117
1188
  super(() => this.client);
118
1189
  this.client = new commonHttpClient.CommonHttpClient({
@@ -121,899 +1192,9 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
121
1192
  errorClass: BaseJiraPlatformApiClientError,
122
1193
  });
123
1194
  this.getClient = () => this.client;
124
- /**
125
- * This resource represents an announcement banner. Use it to retrieve and update
126
- * banner configuration.
127
- *
128
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-announcement-banner
129
- */
130
- this.announcementBanner = new AnnouncementBannerService_1.AnnouncementBannerService(this.getClient);
131
- /**
132
- * This resource represents app access rule data policies.
133
- *
134
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-data-policies
135
- */
136
- this.appDataPolicies = new AppDataPoliciesService_1.AppDataPoliciesService(this.getClient);
137
- /**
138
- * This resource represents application roles. Use it to get details of an
139
- * application role or all application roles.
140
- *
141
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-application-roles
142
- */
143
- this.applicationRoles = new ApplicationRolesService_1.ApplicationRolesService(this.getClient);
144
- /**
145
- * This resource supports [app
146
- * migrations](https://developer.atlassian.com/platform/app-migration/). Use it to:
147
- * - [to request migrated workflow rules
148
- * details](https://developer.atlassian.com/platform/app-migration/tutorials/migration-app-workflow-rules/).
149
- * - [perform bulk updates of entity
150
- * properties](https://developer.atlassian.com/platform/app-migration/tutorials/entity-properties-bulk-api/).
151
- * - [perform bulk updates of issue custom field
152
- * values](https://developer.atlassian.com/platform/app-migration/tutorials/migrating-app-custom-fields/).
153
- *
154
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-migration
155
- */
156
- this.appMigration = new AppMigrationService_1.AppMigrationService(this.getClient);
157
- /**
158
- * This resource represents app properties. Use it to store arbitrary data for your
159
- * [Connect
160
- * app](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps).
161
- *
162
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-properties
163
- */
164
- this.appProperties = new AppPropertiesService_1.AppPropertiesService(this.getClient);
165
- /**
166
- * This resource represents audits that record activities undertaken in Jira. Use
167
- * it to get a list of audit records.
168
- *
169
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-audit-records
170
- */
171
- this.auditRecords = new AuditRecordsService_1.AuditRecordsService(this.getClient);
172
- /**
173
- * This resource represents system and custom avatars. Use it to obtain the
174
- * details of system or custom avatars, add and remove avatars from a project or
175
- * issue type, and obtain avatar images.
176
- *
177
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars
178
- */
179
- this.avatars = new AvatarsService_1.AvatarsService(this.getClient);
180
- /**
181
- * This resource represents classification levels.
182
- *
183
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-classification-levels
184
- */
185
- this.classificationLevels = new ClassificationLevelsService_1.ClassificationLevelsService(this.getClient);
186
- /**
187
- * This resource represents dashboards. Use it to obtain the details of dashboards
188
- * as well as get, create, update, or remove item properties and gadgets from
189
- * dashboards.
190
- *
191
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards
192
- */
193
- this.dashboards = new DashboardsService_1.DashboardsService(this.getClient);
194
- /**
195
- * This resource represents [modules registered
196
- * dynamically](https://developer.atlassian.com/cloud/jira/platform/dynamic-modules/)
197
- * by [Connect
198
- * apps](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps).
199
- *
200
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dynamic-modules
201
- */
202
- this.dynamicModules = new DynamicModulesService_1.DynamicModulesService(this.getClient);
203
- /**
204
- * This resource represents options for sharing [filters](#api-group-Filters). Use
205
- * it to get share scopes as well as add and remove share scopes from filters.
206
- *
207
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filter-sharing
208
- */
209
- this.filterSharing = new FilterSharingService_1.FilterSharingService(this.getClient);
210
- /**
211
- * This resource represents [filters](https://confluence.atlassian.com/x/eQiiLQ).
212
- * Use it to get, create, update, or delete filters. Also use it to configure the
213
- * columns for a filter and set favorite filters.
214
- *
215
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters
216
- */
217
- this.filters = new FiltersService_1.FiltersService(this.getClient);
218
- /**
219
- * This resource represents a list of users and a list of groups. Use it to obtain
220
- * the details to populate user and group picker suggestions list.
221
- *
222
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-group-and-user-picker
223
- */
224
- this.groupAndUserPicker = new GroupAndUserPickerService_1.GroupAndUserPickerService(this.getClient);
225
- /**
226
- * This resource represents groups of users. Use it to get, create, find, and
227
- * delete groups as well as add and remove users from groups. (\[WARNING\] The
228
- * standard Atlassian group names are default names only and can be edited or
229
- * deleted. For example, an admin or Atlassian support could delete the default
230
- * group jira-software-users or rename it to jsw-users at any point. See
231
- * https://support.atlassian.com/user-management/docs/create-and-update-groups/
232
- * for details.)
233
- *
234
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups
235
- */
236
- this.groups = new GroupsService_1.GroupsService(this.getClient);
237
- /**
238
- * This resource represents issue attachments and the attachment settings for
239
- * Jira. Use it to get the metadata for an attachment, delete an attachment, and
240
- * view the metadata for the contents of an attachment. Also, use it to get the
241
- * attachment settings for Jira.
242
- *
243
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments
244
- */
245
- this.issueAttachments = new IssueAttachmentsService_1.IssueAttachmentsService(this.getClient);
246
- /**
247
- * This resource represents the Issue Bulk Operations. Use it to move multiple
248
- * issues from one project to another project or edit fields of multiple issues in
249
- * one go.
250
- *
251
- * ### Authentication ###
252
- *
253
- * Access to the Issue Bulk Operations requires authentication. For information on
254
- * how to authenticate API requests, refer to the [Basic Auth for REST APIs
255
- * documentation](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).
256
- *
257
- * ### Rate Limiting ###
258
- *
259
- * The Bulk Edit and Move APIs are subject to the usual rate limiting
260
- * infrastructure in Jira. For more information, please refer to [Rate
261
- * Limiting](https://developer.atlassian.com/cloud/jira/platform/rate-limiting/).
262
- * Additionally, at any given time, only 5 concurrent requests can be sent across
263
- * all users.
264
- *
265
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-bulk-operations
266
- */
267
- this.issueBulkOperations = new IssueBulkOperationsService_1.IssueBulkOperationsService(this.getClient);
268
- /**
269
- * This resource represents [issue comment](#api-group-Issue-comments) properties,
270
- * which provides for storing custom data against an issue comment. Use is to get,
271
- * set, and delete issue comment properties as well as obtain the keys of all
272
- * properties on a comment. Comment properties are a type of [entity
273
- * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
274
- *
275
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comment-properties
276
- */
277
- this.issueCommentProperties = new IssueCommentPropertiesService_1.IssueCommentPropertiesService(this.getClient);
278
- /**
279
- * This resource represents issue comments. Use it to:
280
- *
281
- * * get, create, update, and delete a comment from an issue.
282
- * * get all comments from issue.
283
- * * get a list of comments by comment ID.
284
- *
285
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments
286
- */
287
- this.issueComments = new IssueCommentsService_1.IssueCommentsService(this.getClient);
288
- /**
289
- * This resource represents configurations stored against a custom field context
290
- * by a [Forge app](https://developer.atlassian.com/platform/forge/).
291
- * Configurations are information used by the Forge app at runtime to determine
292
- * how to handle or process the data in a custom field in a given context. Use
293
- * this resource to set and read configurations.
294
- *
295
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-configuration-apps-
296
- */
297
- this.issueCustomFieldConfigurationApps = new IssueCustomFieldConfigurationAppsService_1.IssueCustomFieldConfigurationAppsService(this.getClient);
298
- /**
299
- * This resource represents issue custom field contexts. Use it to:
300
- *
301
- * * get, create, update, and delete custom field contexts.
302
- * * get context to issue types and projects mappings.
303
- * * get custom field contexts for projects and issue types.
304
- * * assign custom field contexts to projects.
305
- * * remove custom field contexts from projects.
306
- * * add issue types to custom field contexts.
307
- *
308
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts
309
- */
310
- this.issueCustomFieldContexts = new IssueCustomFieldContextsService_1.IssueCustomFieldContextsService(this.getClient);
311
- /**
312
- * This resource represents custom issue field select list options created by a
313
- * Connect app. See [Issue custom field
314
- * options](#api-group-Issue-custom-field-options) to manipulate options created
315
- * in Jira or using the REST API.
316
- *
317
- * A select list issue field is a type of [issue
318
- * field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/)
319
- * that enables a user to select an option from a list. Use it to add, remove, and
320
- * update the options of a select list issue field.
321
- *
322
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-
323
- */
324
- this.issueCustomFieldOptionsApps = new IssueCustomFieldOptionsAppsService_1.IssueCustomFieldOptionsAppsService(this.getClient);
325
- /**
326
- * This resource represents custom issue field select list options created in Jira
327
- * or using the REST API. This resource supports the following field types:
328
- *
329
- * * Checkboxes.
330
- * * Radio Buttons.
331
- * * Select List (single choice).
332
- * * Select List (multiple choices).
333
- * * Select List (cascading).
334
- *
335
- * See [Issue custom field options
336
- * (apps)](#api-group-Issue-custom-field-options--apps-) to manipulate custom
337
- * issue field select list options created by a Connect app.
338
- *
339
- * Use it to retrieve, create, update, order, and delete custom field options.
340
- *
341
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options
342
- */
343
- this.issueCustomFieldOptions = new IssueCustomFieldOptionsService_1.IssueCustomFieldOptionsService(this.getClient);
344
- /**
345
- * This resource represents the values of custom fields added by [Forge
346
- * apps](https://developer.atlassian.com/platform/forge/). Use it to update the
347
- * value of a custom field on issues.
348
- *
349
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-values-apps-
350
- */
351
- this.issueCustomFieldValuesApps = new IssueCustomFieldValuesAppsService_1.IssueCustomFieldValuesAppsService(this.getClient);
352
- /**
353
- * This resource represents issue field configurations. Use it to get, set, and
354
- * delete field configurations and field configuration schemes.
355
- *
356
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations
357
- */
358
- this.issueFieldConfigurations = new IssueFieldConfigurationsService_1.IssueFieldConfigurationsService(this.getClient);
359
- /**
360
- * This resource represents issue fields, both system and custom fields. Use it to
361
- * get fields, field configurations, and create custom fields.
362
- *
363
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields
364
- */
365
- this.issueFields = new IssueFieldsService_1.IssueFieldsService(this.getClient);
366
- /**
367
- * This resource represents links between issues. Use it to get, create, and
368
- * delete links between issues.
369
- *
370
- * To use it, the site must have [issue
371
- * linking](https://confluence.atlassian.com/x/yoXKM) enabled.
372
- *
373
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-links
374
- */
375
- this.issueLinks = new IssueLinksService_1.IssueLinksService(this.getClient);
376
- /**
377
- * This resource represents [issue link](#api-group-Issue-links) types. Use it to
378
- * get, create, update, and delete link issue types as well as get lists of all
379
- * link issue types.
380
- *
381
- * To use it, the site must have [issue
382
- * linking](https://confluence.atlassian.com/x/yoXKM) enabled.
383
- *
384
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-link-types
385
- */
386
- this.issueLinkTypes = new IssueLinkTypesService_1.IssueLinkTypesService(this.getClient);
387
- /**
388
- * This resource represents issue navigator settings. Use it to get and set issue
389
- * navigator default columns.
390
- *
391
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-navigator-settings
392
- */
393
- this.issueNavigatorSettings = new IssueNavigatorSettingsService_1.IssueNavigatorSettingsService(this.getClient);
394
- /**
395
- * This resource represents notification schemes, lists of events and the
396
- * recipients who will receive notifications for those events. Use it to get
397
- * details of a notification scheme and a list of notification schemes.
398
- *
399
- * ### About notification schemes ###
400
- *
401
- * A notification scheme is a list of events and recipients who will receive
402
- * notifications for those events. The list is contained within the
403
- * `notificationSchemeEvents` object and contains pairs of `events` and
404
- * `notifications`:
405
- *
406
- * * `event` Identifies the type of event. The events can be [Jira system
407
- * events](https://support.atlassian.com/jira-cloud-administration/docs/configure-notification-schemes/)
408
- * (see the *Events* section) or [custom
409
- * events](https://support.atlassian.com/jira-cloud-administration/docs/add-a-custom-event/).
410
- * * `notifications` Identifies the
411
- * [recipients](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-recipientsRecipients)
412
- * of notifications for each event. Recipients can be any of the following types:
413
- *
414
- * * `CurrentAssignee`
415
- * * `Reporter`
416
- * * `CurrentUser`
417
- * * `ProjectLead`
418
- * * `ComponentLead`
419
- * * `User` (the `parameter` is the user key)
420
- * * `Group` (the `parameter` is the group name)
421
- * * `ProjectRole` (the `parameter` is the project role ID)
422
- * * `EmailAddress` *(deprecated)*
423
- * * `AllWatchers`
424
- * * `UserCustomField` (the `parameter` is the ID of the custom field)
425
- * * `GroupCustomField`(the `parameter` is the ID of the custom field)
426
- *
427
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes
428
- */
429
- this.issueNotificationSchemes = new IssueNotificationSchemesService_1.IssueNotificationSchemesService(this.getClient);
430
- /**
431
- * This resource represents issue priorities. Use it to get, create and update
432
- * issue priorities and details for individual issue priorities.
433
- *
434
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-priorities
435
- */
436
- this.issuePriorities = new IssuePrioritiesService_1.IssuePrioritiesService(this.getClient);
437
- /**
438
- * This resource represents [issue](#api-group-Issues) properties, which provides
439
- * for storing custom data against an issue. Use it to get, set, and delete issue
440
- * properties as well as obtain details of all properties on an issue. Operations
441
- * to bulk update and delete issue properties are also provided. Issue properties
442
- * are a type of [entity
443
- * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
444
- *
445
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-properties
446
- */
447
- this.issueProperties = new IssuePropertiesService_1.IssuePropertiesService(this.getClient);
448
- /**
449
- * This resource represents remote issue links, a way of linking Jira to
450
- * information in other systems. Use it to get, create, update, and delete remote
451
- * issue links either by ID or global ID. The global ID provides a way of
452
- * accessing remote issue links using information about the item's remote system
453
- * host and remote system identifier.
454
- *
455
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-remote-links
456
- */
457
- this.issueRemoteLinks = new IssueRemoteLinksService_1.IssueRemoteLinksService(this.getClient);
458
- /**
459
- * This resource represents issue resolution values. Use it to obtain a list of
460
- * all issue resolution values and the details of individual resolution values.
461
- *
462
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-resolutions
463
- */
464
- this.issueResolutions = new IssueResolutionsService_1.IssueResolutionsService(this.getClient);
465
- /**
466
- * This resource represents various ways to search for issues. Use it to search
467
- * for issues with a JQL query and find issues to populate an issue picker.
468
- *
469
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search
470
- */
471
- this.issueSearch = new IssueSearchService_1.IssueSearchService(this.getClient);
472
- /**
473
- * This resource represents issue security levels. Use it to obtain the details of
474
- * any issue security level. For more information about issue security levels, see
475
- * [Configuring issue-level security](https://confluence.atlassian.com/x/J4lKLg).
476
- *
477
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-level
478
- */
479
- this.issueSecurityLevel = new IssueSecurityLevelService_1.IssueSecurityLevelService(this.getClient);
480
- /**
481
- * This resource represents issue security schemes. Use it to get an issue
482
- * security scheme or a list of issue security schemes.
483
- *
484
- * Issue security schemes control which users or groups of users can view an
485
- * issue. When an issue security scheme is associated with a project, its security
486
- * levels can be applied to issues in that project. Sub-tasks also inherit the
487
- * security level of their parent issue.
488
- *
489
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes
490
- */
491
- this.issueSecuritySchemes = new IssueSecuritySchemesService_1.IssueSecuritySchemesService(this.getClient);
492
- /**
493
- * This resource represents Jira issues. Use it to:
494
- *
495
- * * create or edit issues, individually or in bulk.
496
- * * retrieve metadata about the options for creating or editing issues.
497
- * * delete an issue.
498
- * * assign a user to an issue.
499
- * * get issue changelogs.
500
- * * send notifications about an issue.
501
- * * get details of the transitions available for an issue.
502
- * * transition an issue.
503
- * * Archive issues.
504
- * * Unarchive issues.
505
- * * Export archived issues.
506
- *
507
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues
508
- */
509
- this.issues = new IssuesService_1.IssuesService(this.getClient);
510
- /**
511
- * This resource represents [issue type](#api-group-Issue-types) properties, which
512
- * provides for storing custom data against an issue type. Use it to get, create,
513
- * and delete issue type properties as well as obtain the keys of all properties
514
- * on a issues type. Issue type properties are a type of [entity
515
- * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
516
- *
517
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-properties
518
- */
519
- this.issueTypeProperties = new IssueTypePropertiesService_1.IssueTypePropertiesService(this.getClient);
520
- /**
521
- * This resource represents issue type schemes in classic projects. Use it to:
522
- *
523
- * * get issue type schemes and a list of the projects that use them.
524
- * * associate issue type schemes with projects.
525
- * * add issue types to issue type schemes.
526
- * * delete issue types from issue type schemes.
527
- * * create, update, and delete issue type schemes.
528
- * * change the order of issue types in issue type schemes.
529
- *
530
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes
531
- */
532
- this.issueTypeSchemes = new IssueTypeSchemesService_1.IssueTypeSchemesService(this.getClient);
533
- /**
534
- * This resource represents issue type screen schemes. Use it to:
535
- *
536
- * * get issue type screen schemes and a list of the projects that use them.
537
- * * create issue type screen schemes.
538
- * * update issue type screen schemes.
539
- * * delete issue type screen schemes.
540
- * * associate issue type screen schemes with projects.
541
- * * append issue type to screen scheme mappings to issue type screen schemes.
542
- * * remove issue type to screen scheme mappings from issue type screen schemes.
543
- * * update default screen scheme of issue type screen scheme.
544
- *
545
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes
546
- */
547
- this.issueTypeScreenSchemes = new IssueTypeScreenSchemesService_1.IssueTypeScreenSchemesService(this.getClient);
548
- /**
549
- * This resource represents issues types. Use it to:
550
- *
551
- * * get, create, update, and delete issue types.
552
- * * get all issue types for a user.
553
- * * get alternative issue types.
554
- * * set an avatar for an issue type.
555
- *
556
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-types
557
- */
558
- this.issueTypes = new IssueTypesService_1.IssueTypesService(this.getClient);
559
- /**
560
- * This resource represents votes cast by users on an issue. Use it to get details
561
- * of votes on an issue as well as cast and withdrawal votes.
562
- *
563
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-votes
564
- */
565
- this.issueVotes = new IssueVotesService_1.IssueVotesService(this.getClient);
566
- /**
567
- * This resource represents users watching an issue. Use it to get details of
568
- * users watching an issue as well as start and stop a user watching an issue.
569
- *
570
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-watchers
571
- */
572
- this.issueWatchers = new IssueWatchersService_1.IssueWatchersService(this.getClient);
573
- /**
574
- * This resource represents [issue worklog](#api-group-Issue-worklogs) properties,
575
- * which provides for storing custom data against an issue worklog. Use it to get,
576
- * create, and delete issue worklog properties as well as obtain the keys of all
577
- * properties on a issue worklog. Issue worklog properties are a type of [entity
578
- * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
579
- *
580
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklog-properties
581
- */
582
- this.issueWorklogProperties = new IssueWorklogPropertiesService_1.IssueWorklogPropertiesService(this.getClient);
583
- /**
584
- * This resource represents issue worklogs. Use it to:
585
- *
586
- * * get, create, update, and delete worklogs.
587
- * * obtain lists of updated or deleted worklogs.
588
- *
589
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs
590
- */
591
- this.issueWorklogs = new IssueWorklogsService_1.IssueWorklogsService(this.getClient);
592
- /**
593
- * This resource is a collection of operations for [Jira
594
- * expressions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/).
595
- *
596
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-expressions
597
- */
598
- this.jiraExpressions = new JiraExpressionsService_1.JiraExpressionsService(this.getClient);
599
- /**
600
- * This resource represents various settings in Jira. Use it to get and update
601
- * Jira settings and properties.
602
- *
603
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings
604
- */
605
- this.jiraSettings = new JiraSettingsService_1.JiraSettingsService(this.getClient);
606
- /**
607
- * This resource represents JQL function's precomputations. Precomputation is a
608
- * mapping between custom function call and JQL fragment returned by this
609
- * function. Use it to get and update precomputations.
610
- *
611
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql-functions-apps-
612
- */
613
- this.jqlFunctionsApps = new JqlFunctionsAppsService_1.JqlFunctionsAppsService(this.getClient);
614
- /**
615
- * This resource represents JQL search auto-complete details. Use it to obtain JQL
616
- * search auto-complete data and suggestions for use in programmatic construction
617
- * of queries or custom query builders. It also provides operations to:
618
- *
619
- * * convert one or more JQL queries with user identifiers (username or user
620
- * key) to equivalent JQL queries with account IDs.
621
- * * convert readable details in one or more JQL queries to IDs where a user
622
- * doesn't have permission to view the entity whose details are readable.
623
- *
624
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql
625
- */
626
- this.jql = new JqlService_1.JqlService(this.getClient);
627
- /**
628
- * This resource represents available labels. Use it to get available labels for
629
- * the global label field.
630
- *
631
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-labels
632
- */
633
- this.labels = new LabelsService_1.LabelsService(this.getClient);
634
- /**
635
- * This resource represents license metrics. Use it to get available metrics for
636
- * Jira licences.
637
- *
638
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics
639
- */
640
- this.licenseMetrics = new LicenseMetricsService_1.LicenseMetricsService(this.getClient);
641
- /**
642
- * This resource represents information about the current user, such as basic
643
- * details, group membership, application roles, preferences, and locale. Use it
644
- * to get, create, update, and delete (restore default) values of the user's
645
- * preferences and locale.
646
- *
647
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-myself
648
- */
649
- this.myself = new MyselfService_1.MyselfService(this.getClient);
650
- /**
651
- * This resource represents permission schemes. Use it to get, create, update, and
652
- * delete permission schemes as well as get, create, update, and delete details of
653
- * the permissions granted in those schemes.
654
- *
655
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes
656
- */
657
- this.permissionSchemes = new PermissionSchemesService_1.PermissionSchemesService(this.getClient);
658
- /**
659
- * This resource represents permissions. Use it to obtain details of all
660
- * permissions and determine whether the user has certain permissions.
661
- *
662
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permissions
663
- */
664
- this.permissions = new PermissionsService_1.PermissionsService(this.getClient);
665
- /**
666
- * This resource represents issue priority schemes. Use it to get priority schemes
667
- * and related information, and to create, update and delete priority schemes.
668
- *
669
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-priority-schemes
670
- */
671
- this.prioritySchemes = new PrioritySchemesService_1.PrioritySchemesService(this.getClient);
672
- /**
673
- * This resource represents avatars associated with a project. Use it to get,
674
- * load, set, and remove project avatars.
675
- *
676
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-avatars
677
- */
678
- this.projectAvatars = new ProjectAvatarsService_1.ProjectAvatarsService(this.getClient);
679
- /**
680
- * This resource represents project categories. Use it to create, update, and
681
- * delete project categories as well as obtain a list of all project categories
682
- * and details of individual categories. For more information on managing project
683
- * categories, see [Adding, assigning, and deleting project
684
- * categories](https://confluence.atlassian.com/x/-A5WMg).
685
- *
686
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories
687
- */
688
- this.projectCategories = new ProjectCategoriesService_1.ProjectCategoriesService(this.getClient);
689
- /**
690
- * This resource represents classification levels used in a project. Use it to
691
- * view and manage classification levels in your projects.
692
- *
693
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-classification-levels
694
- */
695
- this.projectClassificationLevels = new ProjectClassificationLevelsService_1.ProjectClassificationLevelsService(this.getClient);
696
- /**
697
- * This resource represents project components. Use it to get, create, update, and
698
- * delete project components. Also get components for project and get a count of
699
- * issues by component.
700
- *
701
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-components
702
- */
703
- this.projectComponents = new ProjectComponentsService_1.ProjectComponentsService(this.getClient);
704
- /**
705
- * This resource represents the email address used to send a project's
706
- * notifications. Use it to get and set the [project's sender email
707
- * address](https://confluence.atlassian.com/x/dolKLg).
708
- *
709
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-email
710
- */
711
- this.projectEmail = new ProjectEmailService_1.ProjectEmailService(this.getClient);
712
- /**
713
- * This resource represents project features. Use it to get the list of features
714
- * for a project and modify the state of a feature. The project feature endpoint
715
- * is available only for Jira Software, both for team- and company-managed
716
- * projects.
717
- *
718
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-features
719
- */
720
- this.projectFeatures = new ProjectFeaturesService_1.ProjectFeaturesService(this.getClient);
721
- /**
722
- * This resource provides validation for project keys and names.
723
- *
724
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation
725
- */
726
- this.projectKeyAndNameValidation = new ProjectKeyAndNameValidationService_1.ProjectKeyAndNameValidationService(this.getClient);
727
- /**
728
- * This resource represents permission schemes for a project. Use this resource to:
729
- *
730
- * * get details of a project's issue security levels available to the calling
731
- * user.
732
- * * get the permission scheme associated with the project or assign different
733
- * permission scheme to the project.
734
- * * get details of a project's issue security scheme.
735
- *
736
- * See [Managing project permissions](https://confluence.atlassian.com/x/yodKLg)
737
- * for more information about permission schemes.
738
- *
739
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes
740
- */
741
- this.projectPermissionSchemes = new ProjectPermissionSchemesService_1.ProjectPermissionSchemesService(this.getClient);
742
- /**
743
- * This resource represents [project](#api-group-Projects) properties, which
744
- * provides for storing custom data against a project. Use it to get, create, and
745
- * delete project properties as well as get a list of property keys for a project.
746
- * Project properties are a type of [entity
747
- * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
748
- *
749
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-properties
750
- */
751
- this.projectProperties = new ProjectPropertiesService_1.ProjectPropertiesService(this.getClient);
752
- /**
753
- * This resource represents the users assigned to [project
754
- * roles](#api-group-Issue-comments). Use it to get, add, and remove default users
755
- * from project roles. Also use it to add and remove users from a project role
756
- * associated with a project.
757
- *
758
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-role-actors
759
- */
760
- this.projectRoleActors = new ProjectRoleActorsService_1.ProjectRoleActorsService(this.getClient);
761
- /**
762
- * This resource represents the roles that users can play in projects. Use this
763
- * resource to get, create, update, and delete project roles.
764
- *
765
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles
766
- */
767
- this.projectRoles = new ProjectRolesService_1.ProjectRolesService(this.getClient);
768
- /**
769
- * This resource represents projects. Use it to get, create, update, and delete
770
- * projects. Also get statuses available to a project, a project's notification
771
- * schemes, and update a project's type.
772
- *
773
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects
774
- */
775
- this.projects = new ProjectsService_1.ProjectsService(this.getClient);
776
- /**
777
- * This resource represents project types. Use it to obtain a list of all project
778
- * types, a list of project types accessible to the calling user, and details of a
779
- * project type.
780
- *
781
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-types
782
- */
783
- this.projectTypes = new ProjectTypesService_1.ProjectTypesService(this.getClient);
784
- /**
785
- * This resource represents project versions. Use it to get, get lists of, create,
786
- * update, move, merge, and delete project versions. This resource also provides
787
- * counts of issues by version.
788
- *
789
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions
790
- */
791
- this.projectVersions = new ProjectVersionsService_1.ProjectVersionsService(this.getClient);
792
- /**
793
- * This resource represents screen schemes in classic projects. Use it to get,
794
- * create, update, and delete screen schemes.
795
- *
796
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-schemes
797
- */
798
- this.screenSchemes = new ScreenSchemesService_1.ScreenSchemesService(this.getClient);
799
- /**
800
- * This resource represents the screens used to record issue details. Use it to:
801
- *
802
- * * get details of all screens.
803
- * * get details of all the fields available for use on screens.
804
- * * create screens.
805
- * * delete screens.
806
- * * update screens.
807
- * * add a field to the default screen.
808
- *
809
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens
810
- */
811
- this.screens = new ScreensService_1.ScreensService(this.getClient);
812
- /**
813
- * This resource represents the screen tab fields used to record issue details.
814
- * Use it to get, add, move, and remove fields from screen tabs.
815
- *
816
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields
817
- */
818
- this.screenTabFields = new ScreenTabFieldsService_1.ScreenTabFieldsService(this.getClient);
819
- /**
820
- * This resource represents the screen tabs used to record issue details. Use it
821
- * to get, create, update, move, and delete screen tabs.
822
- *
823
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tabs
824
- */
825
- this.screenTabs = new ScreenTabsService_1.ScreenTabsService(this.getClient);
826
- /**
827
- * This resource provides information about the Jira instance.
828
- *
829
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-server-info
830
- */
831
- this.serverInfo = new ServerInfoService_1.ServerInfoService(this.getClient);
832
- /**
833
- * This resource represents a service registry. Use it to retrieve attributes
834
- * related to a [service
835
- * registry](https://support.atlassian.com/jira-service-management-cloud/docs/what-is-services/)
836
- * in JSM.
837
- *
838
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-service-registry
839
- */
840
- this.serviceRegistry = new ServiceRegistryService_1.ServiceRegistryService(this.getClient);
841
- /**
842
- * This resource represents statuses. Use it to search, get, create, delete, and
843
- * change statuses.
844
- *
845
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-status
846
- */
847
- this.status = new StatusService_1.StatusService(this.getClient);
848
- /**
849
- * This resource represents a [long-running asynchronous
850
- * tasks](#async-operations). Use it to obtain details about the progress of a
851
- * long-running task or cancel a long-running task.
852
- *
853
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks
854
- */
855
- this.tasks = new TasksService_1.TasksService(this.getClient);
856
- /**
857
- * This resource represents time tracking and time tracking providers. Use it to
858
- * get and set the time tracking provider, get and set the time tracking options,
859
- * and disable time tracking.
860
- *
861
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-time-tracking
862
- */
863
- this.timeTracking = new TimeTrackingService_1.TimeTrackingService(this.getClient);
864
- /**
865
- * UI modifications is a feature available for **Forge apps only**. It enables
866
- * Forge apps to control how selected Jira fields behave on the following views:
867
- * global issue create, issue view. For example: hide specific fields, set them as
868
- * required, etc.
869
- *
870
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-ui-modifications-apps-
871
- */
872
- this.uiModificationsApps = new UiModificationsAppsService_1.UiModificationsAppsService(this.getClient);
873
- /**
874
- * This resource represents [user](#api-group-Users) properties and provides for
875
- * storing custom data against a user. Use it to get, create, and delete user
876
- * properties as well as get a list of property keys for a user. This resourse is
877
- * designed for integrations and apps to store per-user data and settings. This
878
- * enables data used to customized the user experience to be kept in the Jira
879
- * Cloud instance's database. User properties are a type of [entity
880
- * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
881
- *
882
- * This resource does not access the [user
883
- * properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in
884
- * Jira.
885
- *
886
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-properties
887
- */
888
- this.userProperties = new UserPropertiesService_1.UserPropertiesService(this.getClient);
889
- /**
890
- * This resource represents various ways to search for and find users. Use it to
891
- * obtain list of users including users assignable to projects and issues, users
892
- * with permissions, user lists for pickup fields, and user lists generated using
893
- * structured queries. Note that the operations in this resource only return users
894
- * found within the first 1000 users.
895
- *
896
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search
897
- */
898
- this.userSearch = new UserSearchService_1.UserSearchService(this.getClient);
899
- /**
900
- * This resource represent users. Use it to:
901
- *
902
- * * get, get a list of, create, and delete users.
903
- * * get, set, and reset a user's default issue table columns.
904
- * * get a list of the groups the user belongs to.
905
- * * get a list of user account IDs for a list of usernames or user keys.
906
- *
907
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users
908
- */
909
- this.users = new UsersService_1.UsersService(this.getClient);
910
- /**
911
- * This resource represents webhooks. Webhooks are calls sent to a URL when an
912
- * event occurs in Jira for issues specified by a JQL query. Only Connect and
913
- * OAuth 2.0 apps can register and manage webhooks. For more information, see
914
- * [Webhooks](https://developer.atlassian.com/cloud/jira/platform/webhooks/#registering-a-webhook-via-the-jira-rest-api-for-connect-apps).
915
- *
916
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks
917
- */
918
- this.webhooks = new WebhooksService_1.WebhooksService(this.getClient);
919
- /**
920
- * This resource represents draft workflow schemes. Use it to manage drafts of
921
- * workflow schemes.
922
- *
923
- * A workflow scheme maps issue types to workflows. A workflow scheme can be
924
- * associated with one or more projects, which enables the projects to use the
925
- * workflow-issue type mappings.
926
- *
927
- * Active workflow schemes (workflow schemes that are used by projects) cannot be
928
- * edited. Editing an active workflow scheme creates a draft copy of the scheme.
929
- * The draft workflow scheme can then be edited and published (replacing the
930
- * active scheme).
931
- *
932
- * See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg)
933
- * for more information.
934
- *
935
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts
936
- */
937
- this.workflowSchemeDrafts = new WorkflowSchemeDraftsService_1.WorkflowSchemeDraftsService(this.getClient);
938
- /**
939
- * This resource represents the associations between workflow schemes and projects.
940
- *
941
- * For more information, see [Managing your
942
- * workflows](https://confluence.atlassian.com/x/q4hKLg).
943
- *
944
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-project-associations
945
- */
946
- this.workflowSchemeProjectAssociations = new WorkflowSchemeProjectAssociationsService_1.WorkflowSchemeProjectAssociationsService(this.getClient);
947
- /**
948
- * This resource represents workflow schemes. Use it to manage workflow schemes
949
- * and the workflow scheme's workflows and issue types.
950
- *
951
- * A workflow scheme maps issue types to workflows. A workflow scheme can be
952
- * associated with one or more projects, which enables the projects to use the
953
- * workflow-issue type mappings.
954
- *
955
- * Active workflow schemes (workflow schemes that are used by projects) cannot be
956
- * edited. When an active workflow scheme is edited, a draft copy of the scheme is
957
- * created. The draft workflow scheme is then be edited and published (replacing
958
- * the active scheme).
959
- *
960
- * See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg)
961
- * for more information.
962
- *
963
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes
964
- */
965
- this.workflowSchemes = new WorkflowSchemesService_1.WorkflowSchemesService(this.getClient);
966
- /**
967
- * This resource represents workflows. Use it to:
968
- *
969
- * * Get workflows
970
- * * Create workflows
971
- * * Update workflows
972
- * * Delete inactive workflows
973
- * * Get workflow capabilities
974
- *
975
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows
976
- */
977
- this.workflows = new WorkflowsService_1.WorkflowsService(this.getClient);
978
- /**
979
- * This resource represents status categories. Use it to obtain a list of all
980
- * status categories and the details of a category. Status categories provided a
981
- * mechanism for categorizing [statuses](#api-group-Workflow-statuses).
982
- *
983
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-status-categories
984
- */
985
- this.workflowStatusCategories = new WorkflowStatusCategoriesService_1.WorkflowStatusCategoriesService(this.getClient);
986
- /**
987
- * This resource represents issue workflow statuses. Use it to obtain a list of
988
- * all statuses associated with workflows and the details of a status.
989
- *
990
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-statuses
991
- */
992
- this.workflowStatuses = new WorkflowStatusesService_1.WorkflowStatusesService(this.getClient);
993
- /**
994
- * This resource represents workflow transition properties, which provides for
995
- * storing custom data against a workflow transition. Use it to get, create, and
996
- * delete workflow transition properties as well as get a list of property keys
997
- * for a workflow transition. Workflow transition properties are a type of [entity
998
- * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
999
- *
1000
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-properties
1001
- */
1002
- this.workflowTransitionProperties = new WorkflowTransitionPropertiesService_1.WorkflowTransitionPropertiesService(this.getClient);
1003
- /**
1004
- * This resource represents workflow transition rules. Workflow transition rules
1005
- * define a Connect or a Forge app routine, such as a [workflow post
1006
- * functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/)
1007
- * that is executed in association with the workflow. Use it to read and modify
1008
- * configuration of workflow transition rules.
1009
- *
1010
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules
1011
- */
1012
- this.workflowTransitionRules = new WorkflowTransitionRulesService_1.WorkflowTransitionRulesService(this.getClient);
1013
1195
  this.client.setOptions(Object.assign(Object.assign({}, this.client.getOptions()), options));
1014
1196
  }
1015
1197
  }
1016
1198
  exports.BaseJiraPlatformApiClient = BaseJiraPlatformApiClient;
1017
- BaseJiraPlatformApiClient.createClientWithServices = commonHttpClient.createClientWithServices;
1018
1199
  validationSchemaStorage_1.validationSchemaStorage.setErrorClass(BaseJiraPlatformApiClientError);
1019
1200
  //# sourceMappingURL=BaseJiraPlatformApiClient.js.map