@resolution/jira-api-client 0.16.8 → 0.16.9

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.
Files changed (84) hide show
  1. package/lib/openapi/platform/BaseJiraPlatformApiClient.d.ts +5 -5
  2. package/lib/openapi/platform/BaseJiraPlatformApiClient.js +1 -3
  3. package/lib/openapi/platform/BaseJiraPlatformApiClient.js.map +1 -1
  4. package/lib/openapi/platform/models/fieldSchemes.d.ts +7 -0
  5. package/lib/openapi/platform/models/fieldSchemes.js +5 -0
  6. package/lib/openapi/platform/models/fieldSchemes.js.map +1 -1
  7. package/lib/openapi/platform/models/issueCustomFieldContexts.d.ts +22 -0
  8. package/lib/openapi/platform/models/issueCustomFieldContexts.js +11 -0
  9. package/lib/openapi/platform/models/issueCustomFieldContexts.js.map +1 -1
  10. package/lib/openapi/platform/models/issueSearch.d.ts +27 -0
  11. package/lib/openapi/platform/models/issueSearch.js +12 -1
  12. package/lib/openapi/platform/models/issueSearch.js.map +1 -1
  13. package/lib/openapi/platform/models/projectTemplates.d.ts +23 -1
  14. package/lib/openapi/platform/models/projectTemplates.js +4 -0
  15. package/lib/openapi/platform/models/projectTemplates.js.map +1 -1
  16. package/lib/openapi/platform/models/projects.d.ts +1 -1
  17. package/lib/openapi/platform/models/projects.js +1 -1
  18. package/lib/openapi/platform/models/projects.js.map +1 -1
  19. package/lib/openapi/platform/models/workflowTransitionRules.d.ts +6 -2
  20. package/lib/openapi/platform/models/workflowTransitionRules.js +1 -1
  21. package/lib/openapi/platform/models/workflowTransitionRules.js.map +1 -1
  22. package/lib/openapi/platform/models/workflows.d.ts +3 -231
  23. package/lib/openapi/platform/models/workflows.js +1 -60
  24. package/lib/openapi/platform/models/workflows.js.map +1 -1
  25. package/lib/openapi/platform/services/FieldSchemesService.d.ts +2 -0
  26. package/lib/openapi/platform/services/FieldSchemesService.js +2 -0
  27. package/lib/openapi/platform/services/FieldSchemesService.js.map +1 -1
  28. package/lib/openapi/platform/services/IssueCustomFieldContextsService.d.ts +12 -0
  29. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js +12 -0
  30. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js.map +1 -1
  31. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.d.ts +24 -2
  32. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js +6 -4
  33. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js.map +1 -1
  34. package/lib/openapi/platform/services/IssueFieldsService.d.ts +2 -0
  35. package/lib/openapi/platform/services/IssueFieldsService.js +2 -0
  36. package/lib/openapi/platform/services/IssueFieldsService.js.map +1 -1
  37. package/lib/openapi/platform/services/IssuesService.d.ts +5 -0
  38. package/lib/openapi/platform/services/IssuesService.js +5 -0
  39. package/lib/openapi/platform/services/IssuesService.js.map +1 -1
  40. package/lib/openapi/platform/services/PrioritySchemesService.d.ts +10 -5
  41. package/lib/openapi/platform/services/PrioritySchemesService.js +10 -5
  42. package/lib/openapi/platform/services/PrioritySchemesService.js.map +1 -1
  43. package/lib/openapi/platform/services/ProjectTemplatesService.d.ts +3 -0
  44. package/lib/openapi/platform/services/ProjectTemplatesService.js +3 -0
  45. package/lib/openapi/platform/services/ProjectTemplatesService.js.map +1 -1
  46. package/lib/openapi/platform/services/ScreenTabFieldsService.d.ts +2 -1
  47. package/lib/openapi/platform/services/ScreenTabFieldsService.js +4 -1
  48. package/lib/openapi/platform/services/ScreenTabFieldsService.js.map +1 -1
  49. package/lib/openapi/platform/services/WorkflowTransitionRulesService.d.ts +12 -2
  50. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js +8 -0
  51. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js.map +1 -1
  52. package/lib/openapi/platform/services/WorkflowsService.d.ts +26 -1028
  53. package/lib/openapi/platform/services/WorkflowsService.js +25 -953
  54. package/lib/openapi/platform/services/WorkflowsService.js.map +1 -1
  55. package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.d.ts +3 -3
  56. package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.js +1 -1
  57. package/lib/openapi/serviceManagement/models/servicedesk.d.ts +7 -0
  58. package/lib/openapi/serviceManagement/models/servicedesk.js +4 -0
  59. package/lib/openapi/serviceManagement/models/servicedesk.js.map +1 -1
  60. package/lib/openapi/serviceManagement/services/RequestService.d.ts +12 -4
  61. package/lib/openapi/serviceManagement/services/RequestService.js +12 -4
  62. package/lib/openapi/serviceManagement/services/RequestService.js.map +1 -1
  63. package/lib/openapi/serviceManagement/services/ServicedeskService.d.ts +59 -1
  64. package/lib/openapi/serviceManagement/services/ServicedeskService.js +64 -0
  65. package/lib/openapi/serviceManagement/services/ServicedeskService.js.map +1 -1
  66. package/lib/openapi/software/BaseJiraSoftwareApiClient.d.ts +3 -3
  67. package/lib/openapi/software/BaseJiraSoftwareApiClient.js +11 -1
  68. package/lib/openapi/software/BaseJiraSoftwareApiClient.js.map +1 -1
  69. package/lib/openapi/software/models/board.d.ts +5 -0
  70. package/lib/openapi/software/models/board.js +3 -0
  71. package/lib/openapi/software/models/board.js.map +1 -1
  72. package/lib/openapi/software/models/common.d.ts +28 -0
  73. package/lib/openapi/software/models/common.js +9 -0
  74. package/lib/openapi/software/models/common.js.map +1 -1
  75. package/lib/openapi/software/services/BoardService.d.ts +1596 -240
  76. package/lib/openapi/software/services/BoardService.js +1526 -220
  77. package/lib/openapi/software/services/BoardService.js.map +1 -1
  78. package/lib/openapi/software/services/EpicService.d.ts +524 -1
  79. package/lib/openapi/software/services/EpicService.js +496 -0
  80. package/lib/openapi/software/services/EpicService.js.map +1 -1
  81. package/lib/openapi/software/services/SprintService.d.ts +257 -1
  82. package/lib/openapi/software/services/SprintService.js +242 -0
  83. package/lib/openapi/software/services/SprintService.js.map +1 -1
  84. package/package.json +3 -3
@@ -1,5 +1,5 @@
1
1
  import { CommonHttpService } from "../../core/CommonHttpService";
2
- import { type DeprecatedWorkflow, type CreateWorkflowDetails, type WorkflowIds, type WorkflowProjectIssueTypeUsageDto, type WorkflowProjectUsageDto, type WorkflowSchemeUsageDto, type WorkflowHistoryReadRequest, type WorkflowHistoryReadResponseDto, type WorkflowHistoryListRequest, type WorkflowHistoryListResponseDto, type PageBeanWorkflow, type WorkflowReadRequest, type WorkflowReadResponse, type WorkflowCapabilities, type WorkflowCreateRequest, type WorkflowCreateResponse, type WorkflowCreateValidateRequest, type WorkflowValidationErrorList, type DefaultWorkflowEditorResponse, type WorkflowPreviewRequest, type WorkflowPreviewResponse, type WorkflowSearchResponse, type WorkflowUpdateRequest, type WorkflowUpdateResponse, type WorkflowUpdateValidateRequestBean } from "../models/workflows";
2
+ import { type WorkflowProjectIssueTypeUsageDto, type WorkflowProjectUsageDto, type WorkflowSchemeUsageDto, type WorkflowHistoryReadRequest, type WorkflowHistoryReadResponseDto, type WorkflowHistoryListRequest, type WorkflowHistoryListResponseDto, type PageBeanWorkflow, type WorkflowReadRequest, type WorkflowReadResponse, type WorkflowCapabilities, type WorkflowCreateRequest, type WorkflowCreateResponse, type WorkflowCreateValidateRequest, type WorkflowValidationErrorList, type DefaultWorkflowEditorResponse, type WorkflowPreviewRequest, type WorkflowPreviewResponse, type WorkflowSearchResponse, type WorkflowUpdateRequest, type WorkflowUpdateResponse, type WorkflowUpdateValidateRequestBean } from "../models/workflows";
3
3
  /**
4
4
  * This resource represents workflows. Use it to:
5
5
  *
@@ -13,991 +13,6 @@ import { type DeprecatedWorkflow, type CreateWorkflowDetails, type WorkflowIds,
13
13
  * @category Services
14
14
  */
15
15
  export declare class WorkflowsService extends CommonHttpService {
16
- /**
17
- * This will be removed on [February 1,
18
- * 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-2568);
19
- * use [Bulk create workflows](#api-rest-api-3-workflows-create-post) to create
20
- * both team and company-managed scoped workflows.
21
- *
22
- * Creates a workflow. You can define transition rules using the shapes detailed
23
- * in the following sections. If no transitional rules are specified the default
24
- * system transition rules are used. Note: This only applies to company-managed
25
- * scoped workflows.
26
- *
27
- * #### Conditions ####
28
- *
29
- * Conditions enable workflow rules that govern whether a transition can execute.
30
- *
31
- * ##### Always false condition #####
32
- *
33
- * A condition that always fails.
34
- * ```
35
- * {
36
- * "type": "AlwaysFalseCondition"
37
- * }
38
- * ```
39
- *
40
- * ##### Block transition until approval #####
41
- *
42
- * A condition that blocks issue transition if there is a pending approval.
43
- * ```
44
- * {
45
- * "type": "BlockInProgressApprovalCondition"
46
- * }
47
- * ```
48
- *
49
- * ##### Compare number custom field condition #####
50
- *
51
- * A condition that allows transition if a comparison between a number custom
52
- * field and a value is true.
53
- * ```
54
- * {
55
- * "type": "CompareNumberCFCondition",
56
- * "configuration": {
57
- * "comparator": "=",
58
- * "fieldId": "customfield_10029",
59
- * "fieldValue": 2
60
- * }
61
- * }
62
- * ```
63
- *
64
- * * `comparator` One of the supported comparator: `=`, `>`, and `<`.
65
- * * `fieldId` The custom numeric field ID. Allowed field types:
66
- *
67
- * * `com.atlassian.jira.plugin.system.customfieldtypes:float`
68
- * * `com.pyxis.greenhopper.jira:jsw-story-points`
69
- * * `fieldValue` The value for comparison.
70
- *
71
- * ##### Hide from user condition #####
72
- *
73
- * A condition that hides a transition from users. The transition can only be
74
- * triggered from a workflow function or REST API operation.
75
- * ```
76
- * {
77
- * "type": "RemoteOnlyCondition"
78
- * }
79
- * ```
80
- *
81
- * ##### Only assignee condition #####
82
- *
83
- * A condition that allows only the assignee to execute a transition.
84
- * ```
85
- * {
86
- * "type": "AllowOnlyAssignee"
87
- * }
88
- * ```
89
- *
90
- * ##### Only Bamboo notifications workflow condition (deprecated) #####
91
- *
92
- * A condition that makes the transition available only to Bamboo build
93
- * notifications.
94
- * ```
95
- * {
96
- * "type": "OnlyBambooNotificationsCondition"
97
- * }
98
- * ```
99
- *
100
- * ##### Only reporter condition #####
101
- *
102
- * A condition that allows only the reporter to execute a transition.
103
- * ```
104
- * {
105
- * "type": "AllowOnlyReporter"
106
- * }
107
- * ```
108
- *
109
- * ##### Permission condition #####
110
- *
111
- * A condition that allows only users with a permission to execute a transition.
112
- * ```
113
- * {
114
- * "type": "PermissionCondition",
115
- * "configuration": {
116
- * "permissionKey": "BROWSE_PROJECTS"
117
- * }
118
- * }
119
- * ```
120
- *
121
- * * `permissionKey` The permission required to perform the transition. Allowed
122
- * values:
123
- * [built-in](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions)
124
- * or app defined permissions.
125
- *
126
- * ##### Previous status condition #####
127
- *
128
- * A condition that allows a transition based on whether an issue has or has not
129
- * transitioned through a status.
130
- * ```
131
- * {
132
- * "type": "PreviousStatusCondition",
133
- * "configuration": {
134
- * "ignoreLoopTransitions": true,
135
- * "includeCurrentStatus": true,
136
- * "mostRecentStatusOnly": true,
137
- * "reverseCondition": true,
138
- * "previousStatus": {
139
- * "id": "5"
140
- * }
141
- * }
142
- * }
143
- * ```
144
- *
145
- * By default this condition allows the transition if the status, as defined by
146
- * its ID in the `previousStatus` object, matches any previous issue status,
147
- * unless:
148
- *
149
- * * `ignoreLoopTransitions` is `true`, then loop transitions (from and to the
150
- * same status) are ignored.
151
- * * `includeCurrentStatus` is `true`, then the current issue status is also
152
- * checked.
153
- * * `mostRecentStatusOnly` is `true`, then only the issue's preceding status
154
- * (the one immediately before the current status) is checked.
155
- * * `reverseCondition` is `true`, then the status must not be present.
156
- *
157
- * ##### Separation of duties condition #####
158
- *
159
- * A condition that prevents a user to perform the transition, if the user has
160
- * already performed a transition on the issue.
161
- * ```
162
- * {
163
- * "type": "SeparationOfDutiesCondition",
164
- * "configuration": {
165
- * "fromStatus": {
166
- * "id": "5"
167
- * },
168
- * "toStatus": {
169
- * "id": "6"
170
- * }
171
- * }
172
- * }
173
- * ```
174
- *
175
- * * `fromStatus` OPTIONAL. An object containing the ID of the source status of
176
- * the transition that is blocked. If omitted any transition to `toStatus` is
177
- * blocked.
178
- * * `toStatus` An object containing the ID of the target status of the
179
- * transition that is blocked.
180
- *
181
- * ##### Subtask blocking condition #####
182
- *
183
- * A condition that blocks transition on a parent issue if any of its subtasks are
184
- * in any of one or more statuses.
185
- * ```
186
- * {
187
- * "type": "SubTaskBlockingCondition",
188
- * "configuration": {
189
- * "statuses": [
190
- * {
191
- * "id": "1"
192
- * },
193
- * {
194
- * "id": "3"
195
- * }
196
- * ]
197
- * }
198
- * }
199
- * ```
200
- *
201
- * * `statuses` A list of objects containing status IDs.
202
- *
203
- * ##### User is in any group condition #####
204
- *
205
- * A condition that allows users belonging to any group from a list of groups to
206
- * execute a transition.
207
- * ```
208
- * {
209
- * "type": "UserInAnyGroupCondition",
210
- * "configuration": {
211
- * "groups": [
212
- * "administrators",
213
- * "atlassian-addons-admin"
214
- * ]
215
- * }
216
- * }
217
- * ```
218
- *
219
- * * `groups` A list of group names.
220
- *
221
- * ##### User is in any project role condition #####
222
- *
223
- * A condition that allows only users with at least one project roles from a list
224
- * of project roles to execute a transition.
225
- * ```
226
- * {
227
- * "type": "InAnyProjectRoleCondition",
228
- * "configuration": {
229
- * "projectRoles": [
230
- * {
231
- * "id": "10002"
232
- * },
233
- * {
234
- * "id": "10003"
235
- * },
236
- * {
237
- * "id": "10012"
238
- * },
239
- * {
240
- * "id": "10013"
241
- * }
242
- * ]
243
- * }
244
- * }
245
- * ```
246
- *
247
- * * `projectRoles` A list of objects containing project role IDs.
248
- *
249
- * ##### User is in custom field condition #####
250
- *
251
- * A condition that allows only users listed in a given custom field to execute
252
- * the transition.
253
- * ```
254
- * {
255
- * "type": "UserIsInCustomFieldCondition",
256
- * "configuration": {
257
- * "allowUserInField": false,
258
- * "fieldId": "customfield_10010"
259
- * }
260
- * }
261
- * ```
262
- *
263
- * * `allowUserInField` If `true` only a user who is listed in `fieldId` can
264
- * perform the transition, otherwise, only a user who is not listed in `fieldId`
265
- * can perform the transition.
266
- * * `fieldId` The ID of the field containing the list of users.
267
- *
268
- * ##### User is in group condition #####
269
- *
270
- * A condition that allows users belonging to a group to execute a transition.
271
- * ```
272
- * {
273
- * "type": "UserInGroupCondition",
274
- * "configuration": {
275
- * "group": "administrators"
276
- * }
277
- * }
278
- * ```
279
- *
280
- * * `group` The name of the group.
281
- *
282
- * ##### User is in group custom field condition #####
283
- *
284
- * A condition that allows users belonging to a group specified in a custom field
285
- * to execute a transition.
286
- * ```
287
- * {
288
- * "type": "InGroupCFCondition",
289
- * "configuration": {
290
- * "fieldId": "customfield_10012"
291
- * }
292
- * }
293
- * ```
294
- *
295
- * * `fieldId` The ID of the field. Allowed field types:
296
- *
297
- * * `com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker`
298
- * * `com.atlassian.jira.plugin.system.customfieldtypes:grouppicker`
299
- * * `com.atlassian.jira.plugin.system.customfieldtypes:select`
300
- * * `com.atlassian.jira.plugin.system.customfieldtypes:multiselect`
301
- * * `com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons`
302
- * * `com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes`
303
- * * `com.pyxis.greenhopper.jira:gh-epic-status`
304
- *
305
- * ##### User is in project role condition #####
306
- *
307
- * A condition that allows users with a project role to execute a transition.
308
- * ```
309
- * {
310
- * "type": "InProjectRoleCondition",
311
- * "configuration": {
312
- * "projectRole": {
313
- * "id": "10002"
314
- * }
315
- * }
316
- * }
317
- * ```
318
- *
319
- * * `projectRole` An object containing the ID of a project role.
320
- *
321
- * ##### Value field condition #####
322
- *
323
- * A conditions that allows a transition to execute if the value of a field is
324
- * equal to a constant value or simply set.
325
- * ```
326
- * {
327
- * "type": "ValueFieldCondition",
328
- * "configuration": {
329
- * "fieldId": "assignee",
330
- * "fieldValue":
331
- * "qm:6e1ecee6-8e64-4db6-8c85-916bb3275f51:54b56885-2bd2-4381-8239-78263442520f",
332
- * "comparisonType": "NUMBER",
333
- * "comparator": "="
334
- * }
335
- * }
336
- * ```
337
- *
338
- * * `fieldId` The ID of a field used in the comparison.
339
- * * `fieldValue` The expected value of the field.
340
- * * `comparisonType` The type of the comparison. Allowed values: `STRING`,
341
- * `NUMBER`, `DATE`, `DATE_WITHOUT_TIME`, or `OPTIONID`.
342
- * * `comparator` One of the supported comparator: `>`, `>=`, `=`, `<=`, `<`,
343
- * `!=`.
344
- *
345
- * **Notes:**
346
- *
347
- * * If you choose the comparison type `STRING`, only `=` and `!=` are valid
348
- * options.
349
- * * You may leave `fieldValue` empty when comparison type is `!=` to indicate
350
- * that a value is required in the field.
351
- * * For date fields without time format values as `yyyy-MM-dd`, and for those
352
- * with time as `yyyy-MM-dd HH:mm`. For example, for July 16 2021 use
353
- * `2021-07-16`, for 8:05 AM use `2021-07-16 08:05`, and for 4 PM: `2021-07-16
354
- * 16:00`.
355
- *
356
- * #### Validators ####
357
- *
358
- * Validators check that any input made to the transition is valid before the
359
- * transition is performed.
360
- *
361
- * ##### Date field validator #####
362
- *
363
- * A validator that compares two dates.
364
- * ```
365
- * {
366
- * "type": "DateFieldValidator",
367
- * "configuration": {
368
- * "comparator": ">",
369
- * "date1": "updated",
370
- * "date2": "created",
371
- * "expression": "1d",
372
- * "includeTime": true
373
- * }
374
- * }
375
- * ```
376
- *
377
- * * `comparator` One of the supported comparator: `>`, `>=`, `=`, `<=`, `<`, or
378
- * `!=`.
379
- * * `date1` The date field to validate. Allowed field types:
380
- *
381
- * * `com.atlassian.jira.plugin.system.customfieldtypes:datepicker`
382
- * * `com.atlassian.jira.plugin.system.customfieldtypes:datetime`
383
- * * `com.atlassian.jpo:jpo-custom-field-baseline-end`
384
- * * `com.atlassian.jpo:jpo-custom-field-baseline-start`
385
- * * `duedate`
386
- * * `created`
387
- * * `updated`
388
- * * `resolutiondate`
389
- * * `date2` The second date field. Required, if `expression` is not passed.
390
- * Allowed field types:
391
- *
392
- * * `com.atlassian.jira.plugin.system.customfieldtypes:datepicker`
393
- * * `com.atlassian.jira.plugin.system.customfieldtypes:datetime`
394
- * * `com.atlassian.jpo:jpo-custom-field-baseline-end`
395
- * * `com.atlassian.jpo:jpo-custom-field-baseline-start`
396
- * * `duedate`
397
- * * `created`
398
- * * `updated`
399
- * * `resolutiondate`
400
- * * `expression` An expression specifying an offset. Required, if `date2` is
401
- * not passed. Offsets are built with a number, with `-` as prefix for the past,
402
- * and one of these time units: `d` for day, `w` for week, `m` for month, or `y`
403
- * for year. For example, -2d means two days into the past and 1w means one week
404
- * into the future. The `now` keyword enables a comparison with the current date.
405
- * * `includeTime` If `true`, then the time part of the data is included for the
406
- * comparison. If the field doesn't have a time part, 00:00:00 is used.
407
- *
408
- * ##### Windows date validator #####
409
- *
410
- * A validator that checks that a date falls on or after a reference date and
411
- * before or on the reference date plus a number of days.
412
- * ```
413
- * {
414
- * "type": "WindowsDateValidator",
415
- * "configuration": {
416
- * "date1": "customfield_10009",
417
- * "date2": "created",
418
- * "windowsDays": 5
419
- * }
420
- * }
421
- * ```
422
- *
423
- * * `date1` The date field to validate. Allowed field types:
424
- *
425
- * * `com.atlassian.jira.plugin.system.customfieldtypes:datepicker`
426
- * * `com.atlassian.jira.plugin.system.customfieldtypes:datetime`
427
- * * `com.atlassian.jpo:jpo-custom-field-baseline-end`
428
- * * `com.atlassian.jpo:jpo-custom-field-baseline-start`
429
- * * `duedate`
430
- * * `created`
431
- * * `updated`
432
- * * `resolutiondate`
433
- * * `date2` The reference date. Allowed field types:
434
- *
435
- * * `com.atlassian.jira.plugin.system.customfieldtypes:datepicker`
436
- * * `com.atlassian.jira.plugin.system.customfieldtypes:datetime`
437
- * * `com.atlassian.jpo:jpo-custom-field-baseline-end`
438
- * * `com.atlassian.jpo:jpo-custom-field-baseline-start`
439
- * * `duedate`
440
- * * `created`
441
- * * `updated`
442
- * * `resolutiondate`
443
- * * `windowsDays` A positive integer indicating a number of days.
444
- *
445
- * ##### Field required validator #####
446
- *
447
- * A validator that checks fields are not empty. By default, if a field is not
448
- * included in the current context it's ignored and not validated.
449
- * ```
450
- * {
451
- * "type": "FieldRequiredValidator",
452
- * "configuration": {
453
- * "ignoreContext": true,
454
- * "errorMessage": "Hey",
455
- * "fieldIds": [
456
- * "versions",
457
- * "customfield_10037",
458
- * "customfield_10003"
459
- * ]
460
- * }
461
- * }
462
- * ```
463
- *
464
- * * `ignoreContext` If `true`, then the context is ignored and all the fields
465
- * are validated.
466
- * * `errorMessage` OPTIONAL. The error message displayed when one or more
467
- * fields are empty. A default error message is shown if an error message is not
468
- * provided.
469
- * * `fieldIds` The list of fields to validate.
470
- *
471
- * ##### Field changed validator #####
472
- *
473
- * A validator that checks that a field value is changed. However, this validation
474
- * can be ignored for users from a list of groups.
475
- * ```
476
- * {
477
- * "type": "FieldChangedValidator",
478
- * "configuration": {
479
- * "fieldId": "comment",
480
- * "errorMessage": "Hey",
481
- * "exemptedGroups": [
482
- * "administrators",
483
- * "atlassian-addons-admin"
484
- * ]
485
- * }
486
- * }
487
- * ```
488
- *
489
- * * `fieldId` The ID of a field.
490
- * * `errorMessage` OPTIONAL. The error message displayed if the field is not
491
- * changed. A default error message is shown if the error message is not provided.
492
- * * `exemptedGroups` OPTIONAL. The list of groups.
493
- *
494
- * ##### Field has single value validator #####
495
- *
496
- * A validator that checks that a multi-select field has only one value.
497
- * Optionally, the validation can ignore values copied from subtasks.
498
- * ```
499
- * {
500
- * "type": "FieldHasSingleValueValidator",
501
- * "configuration": {
502
- * "fieldId": "attachment,
503
- * "excludeSubtasks": true
504
- * }
505
- * }
506
- * ```
507
- *
508
- * * `fieldId` The ID of a field.
509
- * * `excludeSubtasks` If `true`, then values copied from subtasks are ignored.
510
- *
511
- * ##### Parent status validator #####
512
- *
513
- * A validator that checks the status of the parent issue of a subtask. Ìf the
514
- * issue is not a subtask, no validation is performed.
515
- * ```
516
- * {
517
- * "type": "ParentStatusValidator",
518
- * "configuration": {
519
- * "parentStatuses": [
520
- * {
521
- * "id":"1"
522
- * },
523
- * {
524
- * "id":"2"
525
- * }
526
- * ]
527
- * }
528
- * }
529
- * ```
530
- *
531
- * * `parentStatus` The list of required parent issue statuses.
532
- *
533
- * ##### Permission validator #####
534
- *
535
- * A validator that checks the user has a permission.
536
- * ```
537
- * {
538
- * "type": "PermissionValidator",
539
- * "configuration": {
540
- * "permissionKey": "ADMINISTER_PROJECTS"
541
- * }
542
- * }
543
- * ```
544
- *
545
- * * `permissionKey` The permission required to perform the transition. Allowed
546
- * values:
547
- * [built-in](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions)
548
- * or app defined permissions.
549
- *
550
- * ##### Previous status validator #####
551
- *
552
- * A validator that checks if the issue has held a status.
553
- * ```
554
- * {
555
- * "type": "PreviousStatusValidator",
556
- * "configuration": {
557
- * "mostRecentStatusOnly": false,
558
- * "previousStatus": {
559
- * "id": "15"
560
- * }
561
- * }
562
- * }
563
- * ```
564
- *
565
- * * `mostRecentStatusOnly` If `true`, then only the issue's preceding status
566
- * (the one immediately before the current status) is checked.
567
- * * `previousStatus` An object containing the ID of an issue status.
568
- *
569
- * ##### Regular expression validator #####
570
- *
571
- * A validator that checks the content of a field against a regular expression.
572
- * ```
573
- * {
574
- * "type": "RegexpFieldValidator",
575
- * "configuration": {
576
- * "regExp": "[0-9]",
577
- * "fieldId": "customfield_10029"
578
- * }
579
- * }
580
- * ```
581
- *
582
- * * `regExp`A regular expression.
583
- * * `fieldId` The ID of a field. Allowed field types:
584
- *
585
- * * `com.atlassian.jira.plugin.system.customfieldtypes:select`
586
- * * `com.atlassian.jira.plugin.system.customfieldtypes:multiselect`
587
- * * `com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons`
588
- * * `com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes`
589
- * * `com.atlassian.jira.plugin.system.customfieldtypes:textarea`
590
- * * `com.atlassian.jira.plugin.system.customfieldtypes:textfield`
591
- * * `com.atlassian.jira.plugin.system.customfieldtypes:url`
592
- * * `com.atlassian.jira.plugin.system.customfieldtypes:float`
593
- * * `com.pyxis.greenhopper.jira:jsw-story-points`
594
- * * `com.pyxis.greenhopper.jira:gh-epic-status`
595
- * * `description`
596
- * * `summary`
597
- *
598
- * ##### User permission validator #####
599
- *
600
- * A validator that checks if a user has a permission. Obsolete. You may encounter
601
- * this validator when getting transition rules and can pass it when updating or
602
- * creating rules, for example, when you want to duplicate the rules from a
603
- * workflow on a new workflow.
604
- * ```
605
- * {
606
- * "type": "UserPermissionValidator",
607
- * "configuration": {
608
- * "permissionKey": "BROWSE_PROJECTS",
609
- * "nullAllowed": false,
610
- * "username": "TestUser"
611
- * }
612
- * }
613
- * ```
614
- *
615
- * * `permissionKey` The permission to be validated. Allowed values:
616
- * [built-in](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions)
617
- * or app defined permissions.
618
- * * `nullAllowed` If `true`, allows the transition when `username` is empty.
619
- * * `username` The username to validate against the `permissionKey`.
620
- *
621
- * #### Post functions ####
622
- *
623
- * Post functions carry out any additional processing required after a Jira
624
- * workflow transition is executed.
625
- *
626
- * ##### Fire issue event function #####
627
- *
628
- * A post function that fires an event that is processed by the listeners.
629
- * ```
630
- * {
631
- * "type": "FireIssueEventFunction",
632
- * "configuration": {
633
- * "event": {
634
- * "id":"1"
635
- * }
636
- * }
637
- * }
638
- * ```
639
- *
640
- * **Note:** If provided, this post function overrides the default
641
- * `FireIssueEventFunction`. Can be included once in a transition.
642
- *
643
- * * `event` An object containing the ID of the issue event.
644
- *
645
- * ##### Update issue status #####
646
- *
647
- * A post function that sets issue status to the linked status of the destination
648
- * workflow status.
649
- * ```
650
- * {
651
- * "type": "UpdateIssueStatusFunction"
652
- * }
653
- * ```
654
- *
655
- * **Note:** This post function is a default function in global and directed
656
- * transitions. It can only be added to the initial transition and can only be
657
- * added once.
658
- *
659
- * ##### Create comment #####
660
- *
661
- * A post function that adds a comment entered during the transition to an issue.
662
- * ```
663
- * {
664
- * "type": "CreateCommentFunction"
665
- * }
666
- * ```
667
- *
668
- * **Note:** This post function is a default function in global and directed
669
- * transitions. It can only be added to the initial transition and can only be
670
- * added once.
671
- *
672
- * ##### Store issue #####
673
- *
674
- * A post function that stores updates to an issue.
675
- * ```
676
- * {
677
- * "type": "IssueStoreFunction"
678
- * }
679
- * ```
680
- *
681
- * **Note:** This post function can only be added to the initial transition and
682
- * can only be added once.
683
- *
684
- * ##### Assign to current user function #####
685
- *
686
- * A post function that assigns the issue to the current user if the current user
687
- * has the `ASSIGNABLE_USER` permission.
688
- * ```
689
- * {
690
- * "type": "AssignToCurrentUserFunction"
691
- * }
692
- * ```
693
- *
694
- * **Note:** This post function can be included once in a transition.
695
- *
696
- * ##### Assign to lead function #####
697
- *
698
- * A post function that assigns the issue to the project or component lead
699
- * developer.
700
- * ```
701
- * {
702
- * "type": "AssignToLeadFunction"
703
- * }
704
- * ```
705
- *
706
- * **Note:** This post function can be included once in a transition.
707
- *
708
- * ##### Assign to reporter function #####
709
- *
710
- * A post function that assigns the issue to the reporter.
711
- * ```
712
- * {
713
- * "type": "AssignToReporterFunction"
714
- * }
715
- * ```
716
- *
717
- * **Note:** This post function can be included once in a transition.
718
- *
719
- * ##### Clear field value function #####
720
- *
721
- * A post function that clears the value from a field.
722
- * ```
723
- * {
724
- * "type": "ClearFieldValuePostFunction",
725
- * "configuration": {
726
- * "fieldId": "assignee"
727
- * }
728
- * }
729
- * ```
730
- *
731
- * * `fieldId` The ID of the field.
732
- *
733
- * ##### Copy value from other field function #####
734
- *
735
- * A post function that copies the value of one field to another, either within an
736
- * issue or from parent to subtask.
737
- * ```
738
- * {
739
- * "type": "CopyValueFromOtherFieldPostFunction",
740
- * "configuration": {
741
- * "sourceFieldId": "assignee",
742
- * "destinationFieldId": "creator",
743
- * "copyType": "same"
744
- * }
745
- * }
746
- * ```
747
- *
748
- * * `sourceFieldId` The ID of the source field.
749
- * * `destinationFieldId` The ID of the destination field.
750
- * * `copyType` Use `same` to copy the value from a field inside the issue, or
751
- * `parent` to copy the value from the parent issue.
752
- *
753
- * ##### Create Crucible review workflow function (deprecated) #####
754
- *
755
- * A post function that creates a Crucible review for all unreviewed code for the
756
- * issue.
757
- * ```
758
- * {
759
- * "type": "CreateCrucibleReviewWorkflowFunction"
760
- * }
761
- * ```
762
- *
763
- * **Note:** This post function can be included once in a transition.
764
- *
765
- * ##### Set issue security level based on user's project role function #####
766
- *
767
- * A post function that sets the issue's security level if the current user has a
768
- * project role.
769
- * ```
770
- * {
771
- * "type": "SetIssueSecurityFromRoleFunction",
772
- * "configuration": {
773
- * "projectRole": {
774
- * "id":"10002"
775
- * },
776
- * "issueSecurityLevel": {
777
- * "id":"10000"
778
- * }
779
- * }
780
- * }
781
- * ```
782
- *
783
- * * `projectRole` An object containing the ID of the project role.
784
- * * `issueSecurityLevel` OPTIONAL. The object containing the ID of the security
785
- * level. If not passed, then the security level is set to `none`.
786
- *
787
- * ##### Trigger a webhook function #####
788
- *
789
- * A post function that triggers a webhook.
790
- * ```
791
- * {
792
- * "type": "TriggerWebhookFunction",
793
- * "configuration": {
794
- * "webhook": {
795
- * "id": "1"
796
- * }
797
- * }
798
- * }
799
- * ```
800
- *
801
- * * `webhook` An object containing the ID of the webhook listener to trigger.
802
- *
803
- * ##### Update issue custom field function #####
804
- *
805
- * A post function that updates the content of an issue custom field.
806
- * ```
807
- * {
808
- * "type": "UpdateIssueCustomFieldPostFunction",
809
- * "configuration": {
810
- * "mode": "append",
811
- * "fieldId": "customfield_10003",
812
- * "fieldValue": "yikes"
813
- * }
814
- * }
815
- * ```
816
- *
817
- * * `mode` Use `replace` to override the field content with `fieldValue` or
818
- * `append` to add `fieldValue` to the end of the field content.
819
- * * `fieldId` The ID of the field.
820
- * * `fieldValue` The update content.
821
- *
822
- * ##### Update issue field function #####
823
- *
824
- * A post function that updates a simple issue field.
825
- * ```
826
- * {
827
- * "type": "UpdateIssueFieldFunction",
828
- * "configuration": {
829
- * "fieldId": "assignee",
830
- * "fieldValue": "5f0c277e70b8a90025a00776"
831
- * }
832
- * }
833
- * ```
834
- *
835
- * * `fieldId` The ID of the field. Allowed field types:
836
- *
837
- * * `assignee`
838
- * * `description`
839
- * * `environment`
840
- * * `priority`
841
- * * `resolution`
842
- * * `summary`
843
- * * `timeoriginalestimate`
844
- * * `timeestimate`
845
- * * `timespent`
846
- * * `fieldValue` The update value.
847
- * * If the `fieldId` is `assignee`, the `fieldValue` should be one of these
848
- * values:
849
- *
850
- * * an account ID.
851
- * * `automatic`.
852
- * * a blank string, which sets the value to `unassigned`.
853
- *
854
- * #### Connect rules ####
855
- *
856
- * Connect rules are conditions, validators, and post functions of a transition
857
- * that are registered by Connect apps. To create a rule registered by the app,
858
- * the app must be enabled and the rule's module must exist.
859
- * ```
860
- * {
861
- * "type": "appKey__moduleKey",
862
- * "configuration": {
863
- * "value":"{\"isValid\":\"true\"}"
864
- * }
865
- * }
866
- * ```
867
- *
868
- * * `type` A Connect rule key in a form of `appKey__moduleKey`.
869
- * * `value` The stringified JSON configuration of a Connect rule.
870
- *
871
- * #### Forge rules ####
872
- *
873
- * Forge transition rules are not yet supported.
874
- *
875
- * **[Permissions](#permissions) required:** *Administer Jira* [global
876
- * permission](https://confluence.atlassian.com/x/x4dKLg).
877
- *
878
- * @deprecated
879
- * @returns Returned if the workflow is created.
880
- *
881
- * example:
882
- * ```
883
- * {
884
- * "entityId": "d7178e8d-bf6c-4c0c-9e90-758a0b965b67",
885
- * "name": "Workflow 1"
886
- * }
887
- * ```
888
- * @path POST `/rest/api/3/workflow`
889
- * @scopes-current manage:jira-configuration
890
- * @scopes-beta write:workflow:jira, read:workflow:jira
891
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows#api-rest-api-3-workflow-post
892
- * @param params
893
- */
894
- createWorkflow: ({ createWorkflowDetails }: {
895
- /**
896
- * The workflow details.
897
- *
898
- * @example
899
- * ```
900
- * {
901
- * "description": "This is a workflow used for Stories and Tasks",
902
- * "name": "Workflow 1",
903
- * "statuses": [
904
- * {
905
- * "id": "1",
906
- * "properties": {
907
- * "jira.issue.editable": "false"
908
- * }
909
- * },
910
- * {
911
- * "id": "2"
912
- * },
913
- * {
914
- * "id": "3"
915
- * }
916
- * ],
917
- * "transitions": [
918
- * {
919
- * "from": [],
920
- * "name": "Created",
921
- * "to": "1",
922
- * "type": "initial"
923
- * },
924
- * {
925
- * "from": [
926
- * "1"
927
- * ],
928
- * "name": "In progress",
929
- * "properties": {
930
- * "custom-property": "custom-value"
931
- * },
932
- * "rules": {
933
- * "conditions": {
934
- * "conditions": [
935
- * {
936
- * "type": "RemoteOnlyCondition"
937
- * },
938
- * {
939
- * "configuration": {
940
- * "groups": [
941
- * "developers",
942
- * "qa-testers"
943
- * ]
944
- * },
945
- * "type": "UserInAnyGroupCondition"
946
- * }
947
- * ],
948
- * "operator": "AND"
949
- * },
950
- * "postFunctions": [
951
- * {
952
- * "type": "AssignToCurrentUserFunction"
953
- * }
954
- * ]
955
- * },
956
- * "screen": {
957
- * "id": "10001"
958
- * },
959
- * "to": "2",
960
- * "type": "directed"
961
- * },
962
- * {
963
- * "name": "Completed",
964
- * "rules": {
965
- * "postFunctions": [
966
- * {
967
- * "configuration": {
968
- * "fieldId": "assignee"
969
- * },
970
- * "type": "ClearFieldValuePostFunction"
971
- * }
972
- * ],
973
- * "validators": [
974
- * {
975
- * "configuration": {
976
- * "parentStatuses": [
977
- * {
978
- * "id": "3"
979
- * }
980
- * ]
981
- * },
982
- * "type": "ParentStatusValidator"
983
- * },
984
- * {
985
- * "configuration": {
986
- * "permissionKey": "ADMINISTER_PROJECTS"
987
- * },
988
- * "type": "PermissionValidator"
989
- * }
990
- * ]
991
- * },
992
- * "to": "3",
993
- * "type": "global"
994
- * }
995
- * ]
996
- * }
997
- * ```
998
- */
999
- createWorkflowDetails: CreateWorkflowDetails;
1000
- }) => Promise<WorkflowIds>;
1001
16
  /**
1002
17
  * Create workflows and related statuses.
1003
18
  *
@@ -1304,48 +319,6 @@ export declare class WorkflowsService extends CommonHttpService {
1304
319
  /** The entity ID of the workflow. */
1305
320
  entityId: string;
1306
321
  }) => Promise<void>;
1307
- /**
1308
- * This will be removed on [February 1,
1309
- * 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-2567);
1310
- * use [Search workflows](#api-rest-api-3-workflows-search-get) instead.
1311
- *
1312
- * Returns all workflows in Jira or a workflow.
1313
- *
1314
- * If the `workflowName` parameter is specified, the workflow is returned as an
1315
- * object (not in an array). Otherwise, an array of workflow objects is returned.
1316
- *
1317
- * **[Permissions](#permissions) required:** *Administer Jira* [global
1318
- * permission](https://confluence.atlassian.com/x/x4dKLg).
1319
- *
1320
- * @deprecated
1321
- * @returns Returned if the request is successful.
1322
- *
1323
- * example:
1324
- *
1325
- * ```
1326
- * [
1327
- * {
1328
- * "default": true,
1329
- * "description": "A classic Jira workflow",
1330
- * "lastModifiedDate": "01-01-2011",
1331
- * "lastModifiedUser": "admin",
1332
- * "lastModifiedUserAccountId": "5b10a2844c20165700ede21g",
1333
- * "name": "classic workflow",
1334
- * "steps": 5
1335
- * }
1336
- * ]
1337
- * ```
1338
- *
1339
- * @path GET `/rest/api/3/workflow`
1340
- * @scopes-current manage:jira-configuration
1341
- * @scopes-beta read:workflow:jira, read:project:jira, read:project-category:jira, read:avatar:jira
1342
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows#api-rest-api-3-workflow-get
1343
- * @param params
1344
- */
1345
- getAllWorkflows: ({ workflowName }?: {
1346
- /** The name of the workflow to be returned. Only one workflow can be specified. */
1347
- workflowName?: string | undefined;
1348
- }) => Promise<DeprecatedWorkflow[]>;
1349
322
  /**
1350
323
  * Get the user's default workflow editor. This can be either the new editor or
1351
324
  * the legacy editor.
@@ -2703,6 +1676,7 @@ export declare class WorkflowsService extends CommonHttpService {
2703
1676
  * {
2704
1677
  * "errors": [
2705
1678
  * {
1679
+ * "additionalDetails": "Additional details about the error message.",
2706
1680
  * "code": "NON_UNIQUE_STATUS_NAME",
2707
1681
  * "elementReference": {
2708
1682
  * "statusReference": "1f0443ff-47e4-4306-9c26-0af696059a43"
@@ -2869,6 +1843,7 @@ export declare class WorkflowsService extends CommonHttpService {
2869
1843
  * {
2870
1844
  * "errors": [
2871
1845
  * {
1846
+ * "additionalDetails": "Additional details about the error message.",
2872
1847
  * "code": "NON_UNIQUE_STATUS_NAME",
2873
1848
  * "elementReference": {
2874
1849
  * "statusReference": "1f0443ff-47e4-4306-9c26-0af696059a43"
@@ -3597,6 +2572,29 @@ export declare class WorkflowsService extends CommonHttpService {
3597
2572
  *
3598
2573
  * * `webhookId` the ID of the webhook.
3599
2574
  *
2575
+ * ##### Trigger agent #####
2576
+ *
2577
+ * A post function that triggers a Jira AI agent for the issue after the
2578
+ * transition runs, using the configured agent and an optional prompt. The agent
2579
+ * run is asynchronous: it is scheduled after the transition finishes and does not
2580
+ * block the transition.
2581
+ * ```
2582
+ * {
2583
+ * "ruleKey": "system:trigger-agent",
2584
+ * "parameters": {
2585
+ * "agentId": "712020:3c6d3f05-331a-4488-932e-37c34b704720",
2586
+ * "promptValue": ""
2587
+ * }
2588
+ * }
2589
+ * ```
2590
+ *
2591
+ * Parameters:
2592
+ *
2593
+ * * `agentId` the identifier of the agent to trigger (the Atlassian account ID
2594
+ * of the agent).
2595
+ * * `promptValue` optional text passed to the agent as a user prompt after the
2596
+ * transition runs; use an empty string if no extra prompt is needed.
2597
+ *
3600
2598
  * #### Screen ####
3601
2599
  *
3602
2600
  * ##### Remind people to update fields #####