@resolution/jira-api-client 0.4.4 → 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.
Files changed (336) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/README.md +60 -0
  3. package/lib/openapi/platform/BaseJiraPlatformApiClient.d.ts +118 -95
  4. package/lib/openapi/platform/BaseJiraPlatformApiClient.js +1073 -869
  5. package/lib/openapi/platform/BaseJiraPlatformApiClient.js.map +1 -1
  6. package/lib/openapi/platform/core/CommonHttpService.d.ts +2 -0
  7. package/lib/openapi/platform/core/CommonHttpService.js +9 -0
  8. package/lib/openapi/platform/core/CommonHttpService.js.map +1 -1
  9. package/lib/openapi/platform/models/common.d.ts +6 -0
  10. package/lib/openapi/platform/models/common.js +12 -1
  11. package/lib/openapi/platform/models/common.js.map +1 -1
  12. package/lib/openapi/platform/models/dynamicModules.d.ts +0 -9
  13. package/lib/openapi/platform/models/dynamicModules.js +0 -6
  14. package/lib/openapi/platform/models/dynamicModules.js.map +1 -1
  15. package/lib/openapi/platform/models/issueBulkOperations.d.ts +547 -0
  16. package/lib/openapi/platform/models/issueBulkOperations.js +437 -0
  17. package/lib/openapi/platform/models/issueBulkOperations.js.map +1 -0
  18. package/lib/openapi/platform/services/AnnouncementBannerService.d.ts +3 -3
  19. package/lib/openapi/platform/services/AnnouncementBannerService.js +65 -62
  20. package/lib/openapi/platform/services/AnnouncementBannerService.js.map +1 -1
  21. package/lib/openapi/platform/services/AppDataPoliciesService.d.ts +4 -4
  22. package/lib/openapi/platform/services/AppDataPoliciesService.js +70 -67
  23. package/lib/openapi/platform/services/AppDataPoliciesService.js.map +1 -1
  24. package/lib/openapi/platform/services/AppMigrationService.d.ts +6 -6
  25. package/lib/openapi/platform/services/AppMigrationService.js +139 -136
  26. package/lib/openapi/platform/services/AppMigrationService.js.map +1 -1
  27. package/lib/openapi/platform/services/AppPropertiesService.d.ts +12 -12
  28. package/lib/openapi/platform/services/AppPropertiesService.js +254 -251
  29. package/lib/openapi/platform/services/AppPropertiesService.js.map +1 -1
  30. package/lib/openapi/platform/services/ApplicationRolesService.d.ts +3 -3
  31. package/lib/openapi/platform/services/ApplicationRolesService.js +177 -174
  32. package/lib/openapi/platform/services/ApplicationRolesService.js.map +1 -1
  33. package/lib/openapi/platform/services/AuditRecordsService.d.ts +7 -7
  34. package/lib/openapi/platform/services/AuditRecordsService.js +97 -94
  35. package/lib/openapi/platform/services/AuditRecordsService.js.map +1 -1
  36. package/lib/openapi/platform/services/AvatarsService.d.ts +25 -31
  37. package/lib/openapi/platform/services/AvatarsService.js +412 -415
  38. package/lib/openapi/platform/services/AvatarsService.js.map +1 -1
  39. package/lib/openapi/platform/services/ClassificationLevelsService.d.ts +4 -4
  40. package/lib/openapi/platform/services/ClassificationLevelsService.js +79 -76
  41. package/lib/openapi/platform/services/ClassificationLevelsService.js.map +1 -1
  42. package/lib/openapi/platform/services/DashboardsService.d.ts +62 -50
  43. package/lib/openapi/platform/services/DashboardsService.js +983 -974
  44. package/lib/openapi/platform/services/DashboardsService.js.map +1 -1
  45. package/lib/openapi/platform/services/DynamicModulesService.d.ts +6 -6
  46. package/lib/openapi/platform/services/DynamicModulesService.js +68 -65
  47. package/lib/openapi/platform/services/DynamicModulesService.js.map +1 -1
  48. package/lib/openapi/platform/services/FilterSharingService.d.ts +11 -11
  49. package/lib/openapi/platform/services/FilterSharingService.js +512 -509
  50. package/lib/openapi/platform/services/FilterSharingService.js.map +1 -1
  51. package/lib/openapi/platform/services/FiltersService.d.ts +50 -50
  52. package/lib/openapi/platform/services/FiltersService.js +1262 -1259
  53. package/lib/openapi/platform/services/FiltersService.js.map +1 -1
  54. package/lib/openapi/platform/services/GroupAndUserPickerService.d.ts +10 -10
  55. package/lib/openapi/platform/services/GroupAndUserPickerService.js +112 -109
  56. package/lib/openapi/platform/services/GroupAndUserPickerService.js.map +1 -1
  57. package/lib/openapi/platform/services/GroupsService.d.ts +46 -46
  58. package/lib/openapi/platform/services/GroupsService.js +385 -382
  59. package/lib/openapi/platform/services/GroupsService.js.map +1 -1
  60. package/lib/openapi/platform/services/IssueAttachmentsService.d.ts +20 -20
  61. package/lib/openapi/platform/services/IssueAttachmentsService.js +644 -641
  62. package/lib/openapi/platform/services/IssueAttachmentsService.js.map +1 -1
  63. package/lib/openapi/platform/services/IssueBulkOperationsService.d.ts +325 -0
  64. package/lib/openapi/platform/services/IssueBulkOperationsService.js +353 -0
  65. package/lib/openapi/platform/services/IssueBulkOperationsService.js.map +1 -0
  66. package/lib/openapi/platform/services/IssueCommentPropertiesService.d.ts +8 -8
  67. package/lib/openapi/platform/services/IssueCommentPropertiesService.js +187 -184
  68. package/lib/openapi/platform/services/IssueCommentPropertiesService.js.map +1 -1
  69. package/lib/openapi/platform/services/IssueCommentsService.d.ts +22 -22
  70. package/lib/openapi/platform/services/IssueCommentsService.js +507 -504
  71. package/lib/openapi/platform/services/IssueCommentsService.js.map +1 -1
  72. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.d.ts +11 -11
  73. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js +126 -123
  74. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js.map +1 -1
  75. package/lib/openapi/platform/services/IssueCustomFieldContextsService.d.ts +42 -42
  76. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js +748 -745
  77. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js.map +1 -1
  78. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.d.ts +28 -28
  79. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js +535 -532
  80. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js.map +1 -1
  81. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.d.ts +20 -20
  82. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js +358 -355
  83. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js.map +1 -1
  84. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.d.ts +6 -6
  85. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js +86 -83
  86. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js.map +1 -1
  87. package/lib/openapi/platform/services/IssueFieldConfigurationsService.d.ts +45 -45
  88. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js +689 -686
  89. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js.map +1 -1
  90. package/lib/openapi/platform/services/IssueFieldsService.d.ts +32 -32
  91. package/lib/openapi/platform/services/IssueFieldsService.js +484 -481
  92. package/lib/openapi/platform/services/IssueFieldsService.js.map +1 -1
  93. package/lib/openapi/platform/services/IssueLinkTypesService.d.ts +9 -9
  94. package/lib/openapi/platform/services/IssueLinkTypesService.js +212 -209
  95. package/lib/openapi/platform/services/IssueLinkTypesService.js.map +1 -1
  96. package/lib/openapi/platform/services/IssueLinksService.d.ts +6 -6
  97. package/lib/openapi/platform/services/IssueLinksService.js +230 -227
  98. package/lib/openapi/platform/services/IssueLinksService.js.map +1 -1
  99. package/lib/openapi/platform/services/IssueNavigatorSettingsService.d.ts +3 -3
  100. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js +72 -69
  101. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js.map +1 -1
  102. package/lib/openapi/platform/services/IssueNotificationSchemesService.d.ts +27 -27
  103. package/lib/openapi/platform/services/IssueNotificationSchemesService.js +816 -813
  104. package/lib/openapi/platform/services/IssueNotificationSchemesService.js.map +1 -1
  105. package/lib/openapi/platform/services/IssuePrioritiesService.d.ts +22 -22
  106. package/lib/openapi/platform/services/IssuePrioritiesService.js +307 -304
  107. package/lib/openapi/platform/services/IssuePrioritiesService.js.map +1 -1
  108. package/lib/openapi/platform/services/IssuePropertiesService.d.ts +16 -16
  109. package/lib/openapi/platform/services/IssuePropertiesService.js +390 -387
  110. package/lib/openapi/platform/services/IssuePropertiesService.js.map +1 -1
  111. package/lib/openapi/platform/services/IssueRemoteLinksService.d.ts +13 -13
  112. package/lib/openapi/platform/services/IssueRemoteLinksService.js +368 -365
  113. package/lib/openapi/platform/services/IssueRemoteLinksService.js.map +1 -1
  114. package/lib/openapi/platform/services/IssueResolutionsService.d.ts +19 -19
  115. package/lib/openapi/platform/services/IssueResolutionsService.js +283 -280
  116. package/lib/openapi/platform/services/IssueResolutionsService.js.map +1 -1
  117. package/lib/openapi/platform/services/IssueSearchService.d.ts +24 -24
  118. package/lib/openapi/platform/services/IssueSearchService.js +826 -823
  119. package/lib/openapi/platform/services/IssueSearchService.js.map +1 -1
  120. package/lib/openapi/platform/services/IssueSecurityLevelService.d.ts +8 -8
  121. package/lib/openapi/platform/services/IssueSecurityLevelService.js +137 -134
  122. package/lib/openapi/platform/services/IssueSecurityLevelService.js.map +1 -1
  123. package/lib/openapi/platform/services/IssueSecuritySchemesService.d.ts +51 -51
  124. package/lib/openapi/platform/services/IssueSecuritySchemesService.js +610 -607
  125. package/lib/openapi/platform/services/IssueSecuritySchemesService.js.map +1 -1
  126. package/lib/openapi/platform/services/IssueTypePropertiesService.d.ts +8 -8
  127. package/lib/openapi/platform/services/IssueTypePropertiesService.js +175 -172
  128. package/lib/openapi/platform/services/IssueTypePropertiesService.js.map +1 -1
  129. package/lib/openapi/platform/services/IssueTypeSchemesService.d.ts +31 -31
  130. package/lib/openapi/platform/services/IssueTypeSchemesService.js +527 -524
  131. package/lib/openapi/platform/services/IssueTypeSchemesService.js.map +1 -1
  132. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.d.ts +36 -36
  133. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js +508 -505
  134. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js.map +1 -1
  135. package/lib/openapi/platform/services/IssueTypesService.d.ts +22 -28
  136. package/lib/openapi/platform/services/IssueTypesService.js +424 -427
  137. package/lib/openapi/platform/services/IssueTypesService.js.map +1 -1
  138. package/lib/openapi/platform/services/IssueVotesService.d.ts +6 -6
  139. package/lib/openapi/platform/services/IssueVotesService.js +148 -145
  140. package/lib/openapi/platform/services/IssueVotesService.js.map +1 -1
  141. package/lib/openapi/platform/services/IssueWatchersService.d.ts +10 -10
  142. package/lib/openapi/platform/services/IssueWatchersService.js +197 -194
  143. package/lib/openapi/platform/services/IssueWatchersService.js.map +1 -1
  144. package/lib/openapi/platform/services/IssueWorklogPropertiesService.d.ts +8 -8
  145. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js +199 -196
  146. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js.map +1 -1
  147. package/lib/openapi/platform/services/IssueWorklogsService.d.ts +44 -44
  148. package/lib/openapi/platform/services/IssueWorklogsService.js +636 -633
  149. package/lib/openapi/platform/services/IssueWorklogsService.js.map +1 -1
  150. package/lib/openapi/platform/services/IssuesService.d.ts +71 -71
  151. package/lib/openapi/platform/services/IssuesService.js +1856 -1853
  152. package/lib/openapi/platform/services/IssuesService.js.map +1 -1
  153. package/lib/openapi/platform/services/JiraExpressionsService.d.ts +6 -6
  154. package/lib/openapi/platform/services/JiraExpressionsService.js +238 -235
  155. package/lib/openapi/platform/services/JiraExpressionsService.js.map +1 -1
  156. package/lib/openapi/platform/services/JiraSettingsService.d.ts +9 -9
  157. package/lib/openapi/platform/services/JiraSettingsService.js +279 -276
  158. package/lib/openapi/platform/services/JiraSettingsService.js.map +1 -1
  159. package/lib/openapi/platform/services/JqlFunctionsAppsService.d.ts +8 -8
  160. package/lib/openapi/platform/services/JqlFunctionsAppsService.js +107 -104
  161. package/lib/openapi/platform/services/JqlFunctionsAppsService.js.map +1 -1
  162. package/lib/openapi/platform/services/JqlService.d.ts +15 -15
  163. package/lib/openapi/platform/services/JqlService.js +635 -632
  164. package/lib/openapi/platform/services/JqlService.js.map +1 -1
  165. package/lib/openapi/platform/services/LabelsService.d.ts +4 -4
  166. package/lib/openapi/platform/services/LabelsService.js +41 -38
  167. package/lib/openapi/platform/services/LabelsService.js.map +1 -1
  168. package/lib/openapi/platform/services/LicenseMetricsService.d.ts +4 -4
  169. package/lib/openapi/platform/services/LicenseMetricsService.js +120 -117
  170. package/lib/openapi/platform/services/LicenseMetricsService.js.map +1 -1
  171. package/lib/openapi/platform/services/MyselfService.d.ts +14 -14
  172. package/lib/openapi/platform/services/MyselfService.js +321 -318
  173. package/lib/openapi/platform/services/MyselfService.js.map +1 -1
  174. package/lib/openapi/platform/services/PermissionSchemesService.d.ts +25 -25
  175. package/lib/openapi/platform/services/PermissionSchemesService.js +548 -545
  176. package/lib/openapi/platform/services/PermissionSchemesService.js.map +1 -1
  177. package/lib/openapi/platform/services/PermissionsService.d.ts +15 -15
  178. package/lib/openapi/platform/services/PermissionsService.js +235 -232
  179. package/lib/openapi/platform/services/PermissionsService.js.map +1 -1
  180. package/lib/openapi/platform/services/PrioritySchemesService.d.ts +34 -34
  181. package/lib/openapi/platform/services/PrioritySchemesService.js +571 -568
  182. package/lib/openapi/platform/services/PrioritySchemesService.js.map +1 -1
  183. package/lib/openapi/platform/services/ProjectAvatarsService.d.ts +11 -11
  184. package/lib/openapi/platform/services/ProjectAvatarsService.js +213 -210
  185. package/lib/openapi/platform/services/ProjectAvatarsService.js.map +1 -1
  186. package/lib/openapi/platform/services/ProjectCategoriesService.d.ts +9 -9
  187. package/lib/openapi/platform/services/ProjectCategoriesService.js +180 -177
  188. package/lib/openapi/platform/services/ProjectCategoriesService.js.map +1 -1
  189. package/lib/openapi/platform/services/ProjectClassificationLevelsService.d.ts +6 -6
  190. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js +125 -122
  191. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js.map +1 -1
  192. package/lib/openapi/platform/services/ProjectComponentsService.d.ts +28 -28
  193. package/lib/openapi/platform/services/ProjectComponentsService.js +1009 -1006
  194. package/lib/openapi/platform/services/ProjectComponentsService.js.map +1 -1
  195. package/lib/openapi/platform/services/ProjectEmailService.d.ts +4 -4
  196. package/lib/openapi/platform/services/ProjectEmailService.js +78 -75
  197. package/lib/openapi/platform/services/ProjectEmailService.js.map +1 -1
  198. package/lib/openapi/platform/services/ProjectFeaturesService.d.ts +4 -4
  199. package/lib/openapi/platform/services/ProjectFeaturesService.js +119 -116
  200. package/lib/openapi/platform/services/ProjectFeaturesService.js.map +1 -1
  201. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.d.ts +8 -8
  202. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js +100 -97
  203. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js.map +1 -1
  204. package/lib/openapi/platform/services/ProjectPermissionSchemesService.d.ts +10 -10
  205. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js +199 -196
  206. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js.map +1 -1
  207. package/lib/openapi/platform/services/ProjectPropertiesService.d.ts +8 -8
  208. package/lib/openapi/platform/services/ProjectPropertiesService.js +172 -169
  209. package/lib/openapi/platform/services/ProjectPropertiesService.js.map +1 -1
  210. package/lib/openapi/platform/services/ProjectRoleActorsService.d.ts +18 -18
  211. package/lib/openapi/platform/services/ProjectRoleActorsService.js +362 -359
  212. package/lib/openapi/platform/services/ProjectRoleActorsService.js.map +1 -1
  213. package/lib/openapi/platform/services/ProjectRolesService.d.ts +21 -21
  214. package/lib/openapi/platform/services/ProjectRolesService.js +576 -573
  215. package/lib/openapi/platform/services/ProjectRolesService.js.map +1 -1
  216. package/lib/openapi/platform/services/ProjectTypesService.d.ts +6 -6
  217. package/lib/openapi/platform/services/ProjectTypesService.js +173 -170
  218. package/lib/openapi/platform/services/ProjectTypesService.js.map +1 -1
  219. package/lib/openapi/platform/services/ProjectVersionsService.d.ts +40 -40
  220. package/lib/openapi/platform/services/ProjectVersionsService.js +751 -748
  221. package/lib/openapi/platform/services/ProjectVersionsService.js.map +1 -1
  222. package/lib/openapi/platform/services/ProjectsService.d.ts +49 -49
  223. package/lib/openapi/platform/services/ProjectsService.js +1597 -1594
  224. package/lib/openapi/platform/services/ProjectsService.js.map +1 -1
  225. package/lib/openapi/platform/services/ScreenSchemesService.d.ts +14 -14
  226. package/lib/openapi/platform/services/ScreenSchemesService.js +177 -174
  227. package/lib/openapi/platform/services/ScreenSchemesService.js.map +1 -1
  228. package/lib/openapi/platform/services/ScreenTabFieldsService.d.ts +9 -9
  229. package/lib/openapi/platform/services/ScreenTabFieldsService.js +144 -141
  230. package/lib/openapi/platform/services/ScreenTabFieldsService.js.map +1 -1
  231. package/lib/openapi/platform/services/ScreenTabsService.d.ts +17 -17
  232. package/lib/openapi/platform/services/ScreenTabsService.js +229 -226
  233. package/lib/openapi/platform/services/ScreenTabsService.js.map +1 -1
  234. package/lib/openapi/platform/services/ScreensService.d.ts +23 -23
  235. package/lib/openapi/platform/services/ScreensService.js +281 -278
  236. package/lib/openapi/platform/services/ScreensService.js.map +1 -1
  237. package/lib/openapi/platform/services/ServerInfoService.d.ts +1 -1
  238. package/lib/openapi/platform/services/ServerInfoService.js +51 -48
  239. package/lib/openapi/platform/services/ServerInfoService.js.map +1 -1
  240. package/lib/openapi/platform/services/ServiceRegistryService.d.ts +2 -2
  241. package/lib/openapi/platform/services/ServiceRegistryService.js +30 -27
  242. package/lib/openapi/platform/services/ServiceRegistryService.js.map +1 -1
  243. package/lib/openapi/platform/services/StatusService.d.ts +17 -17
  244. package/lib/openapi/platform/services/StatusService.js +271 -268
  245. package/lib/openapi/platform/services/StatusService.js.map +1 -1
  246. package/lib/openapi/platform/services/TasksService.d.ts +4 -4
  247. package/lib/openapi/platform/services/TasksService.js +93 -90
  248. package/lib/openapi/platform/services/TasksService.js.map +1 -1
  249. package/lib/openapi/platform/services/TimeTrackingService.d.ts +7 -7
  250. package/lib/openapi/platform/services/TimeTrackingService.js +190 -187
  251. package/lib/openapi/platform/services/TimeTrackingService.js.map +1 -1
  252. package/lib/openapi/platform/services/UiModificationsAppsService.d.ts +11 -11
  253. package/lib/openapi/platform/services/UiModificationsAppsService.js +214 -211
  254. package/lib/openapi/platform/services/UiModificationsAppsService.js.map +1 -1
  255. package/lib/openapi/platform/services/UserPropertiesService.d.ts +20 -20
  256. package/lib/openapi/platform/services/UserPropertiesService.js +196 -193
  257. package/lib/openapi/platform/services/UserPropertiesService.js.map +1 -1
  258. package/lib/openapi/platform/services/UserSearchService.d.ts +61 -61
  259. package/lib/openapi/platform/services/UserSearchService.js +709 -706
  260. package/lib/openapi/platform/services/UserSearchService.js.map +1 -1
  261. package/lib/openapi/platform/services/UsersService.d.ts +51 -51
  262. package/lib/openapi/platform/services/UsersService.js +637 -634
  263. package/lib/openapi/platform/services/UsersService.js.map +1 -1
  264. package/lib/openapi/platform/services/WebhooksService.d.ts +14 -14
  265. package/lib/openapi/platform/services/WebhooksService.js +262 -259
  266. package/lib/openapi/platform/services/WebhooksService.js.map +1 -1
  267. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.d.ts +30 -30
  268. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js +861 -858
  269. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js.map +1 -1
  270. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.d.ts +4 -4
  271. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js +98 -95
  272. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js.map +1 -1
  273. package/lib/openapi/platform/services/WorkflowSchemesService.d.ts +45 -45
  274. package/lib/openapi/platform/services/WorkflowSchemesService.js +899 -896
  275. package/lib/openapi/platform/services/WorkflowSchemesService.js.map +1 -1
  276. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.d.ts +3 -3
  277. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js +82 -79
  278. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js.map +1 -1
  279. package/lib/openapi/platform/services/WorkflowStatusesService.d.ts +3 -3
  280. package/lib/openapi/platform/services/WorkflowStatusesService.js +110 -107
  281. package/lib/openapi/platform/services/WorkflowStatusesService.js.map +1 -1
  282. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.d.ts +14 -14
  283. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js +182 -179
  284. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js.map +1 -1
  285. package/lib/openapi/platform/services/WorkflowTransitionRulesService.d.ts +13 -13
  286. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js +283 -280
  287. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js.map +1 -1
  288. package/lib/openapi/platform/services/WorkflowsService.d.ts +33 -33
  289. package/lib/openapi/platform/services/WorkflowsService.js +2451 -2448
  290. package/lib/openapi/platform/services/WorkflowsService.js.map +1 -1
  291. package/lib/openapi/software/BaseJiraSoftwareApiClient.d.ts +13 -14
  292. package/lib/openapi/software/BaseJiraSoftwareApiClient.js +454 -429
  293. package/lib/openapi/software/BaseJiraSoftwareApiClient.js.map +1 -1
  294. package/lib/openapi/software/core/CommonHttpService.d.ts +2 -0
  295. package/lib/openapi/software/core/CommonHttpService.js +9 -0
  296. package/lib/openapi/software/core/CommonHttpService.js.map +1 -1
  297. package/lib/openapi/software/services/BacklogService.d.ts +4 -4
  298. package/lib/openapi/software/services/BacklogService.js +81 -78
  299. package/lib/openapi/software/services/BacklogService.js.map +1 -1
  300. package/lib/openapi/software/services/BoardService.d.ts +124 -124
  301. package/lib/openapi/software/services/BoardService.js +2048 -2045
  302. package/lib/openapi/software/services/BoardService.js.map +1 -1
  303. package/lib/openapi/software/services/BuildsService.d.ts +10 -10
  304. package/lib/openapi/software/services/BuildsService.js +164 -161
  305. package/lib/openapi/software/services/BuildsService.js.map +1 -1
  306. package/lib/openapi/software/services/DeploymentsService.d.ts +12 -12
  307. package/lib/openapi/software/services/DeploymentsService.js +192 -189
  308. package/lib/openapi/software/services/DeploymentsService.js.map +1 -1
  309. package/lib/openapi/software/services/DevOpsComponentsService.d.ts +8 -8
  310. package/lib/openapi/software/services/DevOpsComponentsService.js +145 -142
  311. package/lib/openapi/software/services/DevOpsComponentsService.js.map +1 -1
  312. package/lib/openapi/software/services/DevelopmentInformationService.d.ts +16 -16
  313. package/lib/openapi/software/services/DevelopmentInformationService.js +178 -175
  314. package/lib/openapi/software/services/DevelopmentInformationService.js.map +1 -1
  315. package/lib/openapi/software/services/EpicService.d.ts +26 -26
  316. package/lib/openapi/software/services/EpicService.js +597 -594
  317. package/lib/openapi/software/services/EpicService.js.map +1 -1
  318. package/lib/openapi/software/services/FeatureFlagsService.d.ts +10 -10
  319. package/lib/openapi/software/services/FeatureFlagsService.js +151 -148
  320. package/lib/openapi/software/services/FeatureFlagsService.js.map +1 -1
  321. package/lib/openapi/software/services/IssueService.d.ts +13 -13
  322. package/lib/openapi/software/services/IssueService.js +359 -356
  323. package/lib/openapi/software/services/IssueService.js.map +1 -1
  324. package/lib/openapi/software/services/OperationsService.d.ts +24 -24
  325. package/lib/openapi/software/services/OperationsService.js +301 -298
  326. package/lib/openapi/software/services/OperationsService.js.map +1 -1
  327. package/lib/openapi/software/services/RemoteLinksService.d.ts +15 -15
  328. package/lib/openapi/software/services/RemoteLinksService.js +160 -157
  329. package/lib/openapi/software/services/RemoteLinksService.js.map +1 -1
  330. package/lib/openapi/software/services/SecurityInformationService.d.ts +16 -16
  331. package/lib/openapi/software/services/SecurityInformationService.js +262 -259
  332. package/lib/openapi/software/services/SecurityInformationService.js.map +1 -1
  333. package/lib/openapi/software/services/SprintService.d.ts +33 -33
  334. package/lib/openapi/software/services/SprintService.js +594 -591
  335. package/lib/openapi/software/services/SprintService.js.map +1 -1
  336. package/package.json +4 -3
@@ -23,538 +23,541 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
23
23
  * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-
24
24
  */
25
25
  class IssueCustomFieldOptionsAppsService extends CommonHttpService_1.CommonHttpService {
26
- /**
27
- * Creates an option for a select list issue field.
28
- *
29
- * Note that this operation **only works for issue field select list options added
30
- * by Connect apps**, it cannot be used with issue field select list options
31
- * created in Jira or using operations from the [Issue custom field
32
- * options](#api-group-Issue-custom-field-options) resource.
33
- *
34
- * Each field can have a maximum of 10000 options, and each option can have a
35
- * maximum of 10000 scopes.
36
- *
37
- * **[Permissions](#permissions) required:** *Administer Jira* [global
38
- * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
39
- * not required for the app providing the field.
40
- *
41
- * @returns Returned if the request is successful.
42
- *
43
- * example: {
44
- * "id": 1,
45
- * "value": "Team 1",
46
- * "properties": {
47
- * "leader": {
48
- * "name": "Leader Name",
49
- * "email": "lname@example.com"
50
- * },
51
- * "members": 42,
52
- * "description": "The team's description",
53
- * "founded": "2016-06-06"
54
- * },
55
- * "config": {
56
- * "scope": {
57
- * "projects": [],
58
- * "projects2": [
59
- * {
60
- * "id": 1001,
61
- * "attributes": [
62
- * "notSelectable"
63
- * ]
64
- * },
65
- * {
66
- * "id": 1002,
67
- * "attributes": [
68
- * "notSelectable"
69
- * ]
70
- * }
71
- * ],
72
- * "global": {}
73
- * },
74
- * "attributes": []
75
- * }
76
- * }
77
- * @path {POST} /rest/api/3/field/{fieldKey}/option
78
- * @scopes-current manage:jira-configuration
79
- * @scopes-beta write:field.option:jira
80
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-post
81
- */
82
- createIssueFieldOption({ fieldKey, issueFieldOptionCreateBean, }) {
83
- return this.getClientInstance()
84
- .request({
85
- path: "/rest/api/3/field/{fieldKey}/option",
86
- method: "POST",
87
- pathParams: {
88
- fieldKey,
89
- },
90
- headers: {
91
- "Content-Type": "application/json",
92
- },
93
- body: issueFieldOptionCreateBean,
94
- })
95
- .then(this.getClientInstance().responseHandler({
96
- 200: {
97
- "application/json": "json",
98
- },
99
- }))
100
- .then(commonHttpClient.castResponse())
101
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldOptionsAppsService.createIssueFieldOption.response"))
102
- .then(commonHttpClient.getBody);
103
- }
104
- /**
105
- * Deletes an option from a select list issue field.
106
- *
107
- * Note that this operation **only works for issue field select list options added
108
- * by Connect apps**, it cannot be used with issue field select list options
109
- * created in Jira or using operations from the [Issue custom field
110
- * options](#api-group-Issue-custom-field-options) resource.
111
- *
112
- * **[Permissions](#permissions) required:** *Administer Jira* [global
113
- * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
114
- * not required for the app providing the field.
115
- *
116
- * @returns Returned if the field option is deleted.
117
- * @path {DELETE} /rest/api/3/field/{fieldKey}/option/{optionId}
118
- * @scopes-current manage:jira-configuration
119
- * @scopes-beta delete:field.option:jira
120
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-optionid-delete
121
- */
122
- deleteIssueFieldOption({ fieldKey, optionId, }) {
123
- return this.getClientInstance()
124
- .request({
125
- path: "/rest/api/3/field/{fieldKey}/option/{optionId}",
126
- method: "DELETE",
127
- pathParams: {
128
- fieldKey,
129
- optionId,
130
- },
131
- })
132
- .then(this.getClientInstance().responseHandler({
133
- 204: {
134
- "application/json": "json",
135
- },
136
- }))
137
- .then(commonHttpClient.castResponse())
138
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldOptionsAppsService.deleteIssueFieldOption.response"))
139
- .then(commonHttpClient.getBody);
140
- }
141
- /**
142
- * Returns a [paginated](#pagination) list of all the options of a select list
143
- * issue field. A select list issue field is a type of [issue
144
- * field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/)
145
- * that enables a user to select a value from a list of options.
146
- *
147
- * Note that this operation **only works for issue field select list options added
148
- * by Connect apps**, it cannot be used with issue field select list options
149
- * created in Jira or using operations from the [Issue custom field
150
- * options](#api-group-Issue-custom-field-options) resource.
151
- *
152
- * **[Permissions](#permissions) required:** *Administer Jira* [global
153
- * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
154
- * not required for the app providing the field.
155
- *
156
- * @returns Returned if the request is successful.
157
- *
158
- * example: {
159
- * "isLast": false,
160
- * "maxResults": 1,
161
- * "nextPage":
162
- * "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option?startAt=1&maxResults=1",
163
- * "self":
164
- * "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option?startAt=0&maxResults=1",
165
- * "startAt": 0,
166
- * "total": 10,
167
- * "values": [
168
- * {
169
- * "id": 1,
170
- * "value": "Team 1",
171
- * "properties": {
172
- * "leader": {
173
- * "name": "Leader Name",
174
- * "email": "lname@example.com"
175
- * },
176
- * "members": 42,
177
- * "description": "The team's description",
178
- * "founded": "2016-06-06"
179
- * },
180
- * "config": {
181
- * "scope": {
182
- * "projects": [],
183
- * "projects2": [
184
- * {
185
- * "id": 1001,
186
- * "attributes": [
187
- * "notSelectable"
188
- * ]
189
- * },
190
- * {
191
- * "id": 1002,
192
- * "attributes": [
193
- * "notSelectable"
194
- * ]
195
- * }
196
- * ],
197
- * "global": {}
198
- * },
199
- * "attributes": []
200
- * }
201
- * }
202
- * ]
203
- * }
204
- * @path {GET} /rest/api/3/field/{fieldKey}/option
205
- * @scopes-current manage:jira-configuration
206
- * @scopes-beta read:field.option:jira
207
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-get
208
- */
209
- getAllIssueFieldOptions({ fieldKey, startAt, maxResults, }) {
210
- return this.getClientInstance()
211
- .request({
212
- path: "/rest/api/3/field/{fieldKey}/option",
213
- method: "GET",
214
- pathParams: {
215
- fieldKey,
216
- },
217
- query: {
218
- startAt,
219
- maxResults,
220
- },
221
- })
222
- .then(this.getClientInstance().responseHandler({
223
- 200: {
224
- "application/json": "json",
225
- },
226
- }))
227
- .then(commonHttpClient.castResponse())
228
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldOptionsAppsService.getAllIssueFieldOptions.response"))
229
- .then(commonHttpClient.getBody);
230
- }
231
- /**
232
- * Returns an option from a select list issue field.
233
- *
234
- * Note that this operation **only works for issue field select list options added
235
- * by Connect apps**, it cannot be used with issue field select list options
236
- * created in Jira or using operations from the [Issue custom field
237
- * options](#api-group-Issue-custom-field-options) resource.
238
- *
239
- * **[Permissions](#permissions) required:** *Administer Jira* [global
240
- * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
241
- * not required for the app providing the field.
242
- *
243
- * @returns Returned if the requested option is returned.
244
- *
245
- * example: {
246
- * "id": 1,
247
- * "value": "Team 1",
248
- * "properties": {
249
- * "leader": {
250
- * "name": "Leader Name",
251
- * "email": "lname@example.com"
252
- * },
253
- * "members": 42,
254
- * "description": "The team's description",
255
- * "founded": "2016-06-06"
256
- * },
257
- * "config": {
258
- * "scope": {
259
- * "projects": [],
260
- * "projects2": [
261
- * {
262
- * "id": 1001,
263
- * "attributes": [
264
- * "notSelectable"
265
- * ]
266
- * },
267
- * {
268
- * "id": 1002,
269
- * "attributes": [
270
- * "notSelectable"
271
- * ]
272
- * }
273
- * ],
274
- * "global": {}
275
- * },
276
- * "attributes": []
277
- * }
278
- * }
279
- * @path {GET} /rest/api/3/field/{fieldKey}/option/{optionId}
280
- * @scopes-current manage:jira-configuration
281
- * @scopes-beta read:field.option:jira
282
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-optionid-get
283
- */
284
- getIssueFieldOption({ fieldKey, optionId, }) {
285
- return this.getClientInstance()
286
- .request({
287
- path: "/rest/api/3/field/{fieldKey}/option/{optionId}",
288
- method: "GET",
289
- pathParams: {
290
- fieldKey,
291
- optionId,
292
- },
293
- })
294
- .then(this.getClientInstance().responseHandler({
295
- 200: {
296
- "application/json": "json",
297
- },
298
- }))
299
- .then(commonHttpClient.castResponse())
300
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldOptionsAppsService.getIssueFieldOption.response"))
301
- .then(commonHttpClient.getBody);
302
- }
303
- /**
304
- * Returns a [paginated](#pagination) list of options for a select list issue
305
- * field that can be viewed and selected by the user.
306
- *
307
- * Note that this operation **only works for issue field select list options added
308
- * by Connect apps**, it cannot be used with issue field select list options
309
- * created in Jira or using operations from the [Issue custom field
310
- * options](#api-group-Issue-custom-field-options) resource.
311
- *
312
- * **[Permissions](#permissions) required:** Permission to access Jira.
313
- *
314
- * @returns Returned if the request is successful.
315
- *
316
- * example: {
317
- * "isLast": false,
318
- * "maxResults": 1,
319
- * "nextPage":
320
- * "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=1&maxResults=1",
321
- * "self":
322
- * "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=0&maxResults=1",
323
- * "startAt": 0,
324
- * "total": 10,
325
- * "values": [
326
- * {
327
- * "id": 1,
328
- * "value": "Team 1",
329
- * "properties": {
330
- * "leader": {
331
- * "name": "Leader Name",
332
- * "email": "lname@example.com"
333
- * },
334
- * "members": 42,
335
- * "description": "The team's description",
336
- * "founded": "2016-06-06"
337
- * }
338
- * }
339
- * ]
340
- * }
341
- * @path {GET} /rest/api/3/field/{fieldKey}/option/suggestions/edit
342
- * @scopes-current read:jira-work
343
- * @scopes-beta read:field.option:jira
344
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-suggestions-edit-get
345
- */
346
- getSelectableIssueFieldOptions({ fieldKey, startAt, maxResults, projectId, }) {
347
- return this.getClientInstance()
348
- .request({
349
- path: "/rest/api/3/field/{fieldKey}/option/suggestions/edit",
350
- method: "GET",
351
- pathParams: {
352
- fieldKey,
353
- },
354
- query: {
355
- startAt,
356
- maxResults,
357
- projectId,
358
- },
359
- })
360
- .then(this.getClientInstance().responseHandler({
361
- 200: {
362
- "application/json": "json",
363
- },
364
- }))
365
- .then(commonHttpClient.castResponse())
366
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldOptionsAppsService.getSelectableIssueFieldOptions.response"))
367
- .then(commonHttpClient.getBody);
368
- }
369
- /**
370
- * Returns a [paginated](#pagination) list of options for a select list issue
371
- * field that can be viewed by the user.
372
- *
373
- * Note that this operation **only works for issue field select list options added
374
- * by Connect apps**, it cannot be used with issue field select list options
375
- * created in Jira or using operations from the [Issue custom field
376
- * options](#api-group-Issue-custom-field-options) resource.
377
- *
378
- * **[Permissions](#permissions) required:** Permission to access Jira.
379
- *
380
- * @returns Returned if the request is successful.
381
- *
382
- * example: {
383
- * "isLast": false,
384
- * "maxResults": 1,
385
- * "nextPage":
386
- * "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=1&maxResults=1",
387
- * "self":
388
- * "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=0&maxResults=1",
389
- * "startAt": 0,
390
- * "total": 10,
391
- * "values": [
392
- * {
393
- * "id": 1,
394
- * "value": "Team 1",
395
- * "properties": {
396
- * "leader": {
397
- * "name": "Leader Name",
398
- * "email": "lname@example.com"
399
- * },
400
- * "members": 42,
401
- * "description": "The team's description",
402
- * "founded": "2016-06-06"
403
- * }
404
- * }
405
- * ]
406
- * }
407
- * @path {GET} /rest/api/3/field/{fieldKey}/option/suggestions/search
408
- * @scopes-current read:jira-work
409
- * @scopes-beta read:field.option:jira
410
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-suggestions-search-get
411
- */
412
- getVisibleIssueFieldOptions({ fieldKey, startAt, maxResults, projectId, }) {
413
- return this.getClientInstance()
414
- .request({
415
- path: "/rest/api/3/field/{fieldKey}/option/suggestions/search",
416
- method: "GET",
417
- pathParams: {
418
- fieldKey,
419
- },
420
- query: {
421
- startAt,
422
- maxResults,
423
- projectId,
424
- },
425
- })
426
- .then(this.getClientInstance().responseHandler({
427
- 200: {
428
- "application/json": "json",
429
- },
430
- }))
431
- .then(commonHttpClient.castResponse())
432
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldOptionsAppsService.getVisibleIssueFieldOptions.response"))
433
- .then(commonHttpClient.getBody);
434
- }
435
- /**
436
- * Deselects an issue-field select-list option from all issues where it is
437
- * selected. A different option can be selected to replace the deselected option.
438
- * The update can also be limited to a smaller set of issues by using a JQL query.
439
- *
440
- * Connect and Forge app users with *Administer Jira* [global
441
- * permission](https://confluence.atlassian.com/x/x4dKLg) can override the screen
442
- * security configuration using `overrideScreenSecurity` and
443
- * `overrideEditableFlag`.
444
- *
445
- * This is an [asynchronous operation](#async). The response object contains a
446
- * link to the long-running task.
447
- *
448
- * Note that this operation **only works for issue field select list options added
449
- * by Connect apps**, it cannot be used with issue field select list options
450
- * created in Jira or using operations from the [Issue custom field
451
- * options](#api-group-Issue-custom-field-options) resource.
452
- *
453
- * **[Permissions](#permissions) required:** *Administer Jira* [global
454
- * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
455
- * not required for the app providing the field.
456
- *
457
- * @path {DELETE} /rest/api/3/field/{fieldKey}/option/{optionId}/issue
458
- * @scopes-current manage:jira-configuration
459
- * @scopes-beta write:field.option:jira, delete:field.option:jira
460
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-optionid-issue-delete
461
- */
462
- replaceIssueFieldOption({ fieldKey, optionId, replaceWith, jql, overrideScreenSecurity, overrideEditableFlag, }) {
463
- return this.getClientInstance()
464
- .request({
465
- path: "/rest/api/3/field/{fieldKey}/option/{optionId}/issue",
466
- method: "DELETE",
467
- pathParams: {
468
- fieldKey,
469
- optionId,
470
- },
471
- query: {
472
- replaceWith,
473
- jql,
474
- overrideScreenSecurity,
475
- overrideEditableFlag,
476
- },
477
- })
478
- .then(commonHttpClient.discardResult);
479
- }
480
- /**
481
- * Updates or creates an option for a select list issue field. This operation
482
- * requires that the option ID is provided when creating an option, therefore, the
483
- * option ID needs to be specified as a path and body parameter. The option ID
484
- * provided in the path and body must be identical.
485
- *
486
- * Note that this operation **only works for issue field select list options added
487
- * by Connect apps**, it cannot be used with issue field select list options
488
- * created in Jira or using operations from the [Issue custom field
489
- * options](#api-group-Issue-custom-field-options) resource.
490
- *
491
- * **[Permissions](#permissions) required:** *Administer Jira* [global
492
- * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
493
- * not required for the app providing the field.
494
- *
495
- * @returns Returned if the option is updated or created.
496
- *
497
- * example: {
498
- * "id": 1,
499
- * "value": "Team 1",
500
- * "properties": {
501
- * "leader": {
502
- * "name": "Leader Name",
503
- * "email": "lname@example.com"
504
- * },
505
- * "members": 42,
506
- * "description": "The team's description",
507
- * "founded": "2016-06-06"
508
- * },
509
- * "config": {
510
- * "scope": {
511
- * "projects": [],
512
- * "projects2": [
513
- * {
514
- * "id": 1001,
515
- * "attributes": [
516
- * "notSelectable"
517
- * ]
518
- * },
519
- * {
520
- * "id": 1002,
521
- * "attributes": [
522
- * "notSelectable"
523
- * ]
524
- * }
525
- * ],
526
- * "global": {}
527
- * },
528
- * "attributes": []
529
- * }
530
- * }
531
- * @path {PUT} /rest/api/3/field/{fieldKey}/option/{optionId}
532
- * @scopes-current manage:jira-configuration
533
- * @scopes-beta write:field.option:jira
534
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-optionid-put
535
- */
536
- updateIssueFieldOption({ fieldKey, optionId, issueFieldOption, }) {
537
- return this.getClientInstance()
538
- .request({
539
- path: "/rest/api/3/field/{fieldKey}/option/{optionId}",
540
- method: "PUT",
541
- pathParams: {
542
- fieldKey,
543
- optionId,
544
- },
545
- headers: {
546
- "Content-Type": "application/json",
547
- },
548
- body: issueFieldOption,
549
- })
550
- .then(this.getClientInstance().responseHandler({
551
- 200: {
552
- "application/json": "json",
553
- },
554
- }))
555
- .then(commonHttpClient.castResponse())
556
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldOptionsAppsService.updateIssueFieldOption.response"))
557
- .then(commonHttpClient.getBody);
26
+ constructor() {
27
+ super(...arguments);
28
+ /**
29
+ * Creates an option for a select list issue field.
30
+ *
31
+ * Note that this operation **only works for issue field select list options added
32
+ * by Connect apps**, it cannot be used with issue field select list options
33
+ * created in Jira or using operations from the [Issue custom field
34
+ * options](#api-group-Issue-custom-field-options) resource.
35
+ *
36
+ * Each field can have a maximum of 10000 options, and each option can have a
37
+ * maximum of 10000 scopes.
38
+ *
39
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
40
+ * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
41
+ * not required for the app providing the field.
42
+ *
43
+ * @returns Returned if the request is successful.
44
+ *
45
+ * example: {
46
+ * "id": 1,
47
+ * "value": "Team 1",
48
+ * "properties": {
49
+ * "leader": {
50
+ * "name": "Leader Name",
51
+ * "email": "lname@example.com"
52
+ * },
53
+ * "members": 42,
54
+ * "description": "The team's description",
55
+ * "founded": "2016-06-06"
56
+ * },
57
+ * "config": {
58
+ * "scope": {
59
+ * "projects": [],
60
+ * "projects2": [
61
+ * {
62
+ * "id": 1001,
63
+ * "attributes": [
64
+ * "notSelectable"
65
+ * ]
66
+ * },
67
+ * {
68
+ * "id": 1002,
69
+ * "attributes": [
70
+ * "notSelectable"
71
+ * ]
72
+ * }
73
+ * ],
74
+ * "global": {}
75
+ * },
76
+ * "attributes": []
77
+ * }
78
+ * }
79
+ * @path {POST} /rest/api/3/field/{fieldKey}/option
80
+ * @scopes-current manage:jira-configuration
81
+ * @scopes-beta write:field.option:jira
82
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-post
83
+ */
84
+ this.createIssueFieldOption = ({ fieldKey, issueFieldOptionCreateBean, }) => {
85
+ return this.getClientInstance()
86
+ .request({
87
+ path: "/rest/api/3/field/{fieldKey}/option",
88
+ method: "POST",
89
+ pathParams: {
90
+ fieldKey,
91
+ },
92
+ headers: {
93
+ "Content-Type": "application/json",
94
+ },
95
+ body: issueFieldOptionCreateBean,
96
+ })
97
+ .then(this.getClientInstance().responseHandler({
98
+ 200: {
99
+ "application/json": "json",
100
+ },
101
+ }))
102
+ .then(commonHttpClient.castResponse())
103
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldOptionsAppsService.createIssueFieldOption.response"))
104
+ .then(commonHttpClient.getBody);
105
+ };
106
+ /**
107
+ * Deletes an option from a select list issue field.
108
+ *
109
+ * Note that this operation **only works for issue field select list options added
110
+ * by Connect apps**, it cannot be used with issue field select list options
111
+ * created in Jira or using operations from the [Issue custom field
112
+ * options](#api-group-Issue-custom-field-options) resource.
113
+ *
114
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
115
+ * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
116
+ * not required for the app providing the field.
117
+ *
118
+ * @returns Returned if the field option is deleted.
119
+ * @path {DELETE} /rest/api/3/field/{fieldKey}/option/{optionId}
120
+ * @scopes-current manage:jira-configuration
121
+ * @scopes-beta delete:field.option:jira
122
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-optionid-delete
123
+ */
124
+ this.deleteIssueFieldOption = ({ fieldKey, optionId, }) => {
125
+ return this.getClientInstance()
126
+ .request({
127
+ path: "/rest/api/3/field/{fieldKey}/option/{optionId}",
128
+ method: "DELETE",
129
+ pathParams: {
130
+ fieldKey,
131
+ optionId,
132
+ },
133
+ })
134
+ .then(this.getClientInstance().responseHandler({
135
+ 204: {
136
+ "application/json": "json",
137
+ },
138
+ }))
139
+ .then(commonHttpClient.castResponse())
140
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldOptionsAppsService.deleteIssueFieldOption.response"))
141
+ .then(commonHttpClient.getBody);
142
+ };
143
+ /**
144
+ * Returns a [paginated](#pagination) list of all the options of a select list
145
+ * issue field. A select list issue field is a type of [issue
146
+ * field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/)
147
+ * that enables a user to select a value from a list of options.
148
+ *
149
+ * Note that this operation **only works for issue field select list options added
150
+ * by Connect apps**, it cannot be used with issue field select list options
151
+ * created in Jira or using operations from the [Issue custom field
152
+ * options](#api-group-Issue-custom-field-options) resource.
153
+ *
154
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
155
+ * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
156
+ * not required for the app providing the field.
157
+ *
158
+ * @returns Returned if the request is successful.
159
+ *
160
+ * example: {
161
+ * "isLast": false,
162
+ * "maxResults": 1,
163
+ * "nextPage":
164
+ * "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option?startAt=1&maxResults=1",
165
+ * "self":
166
+ * "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option?startAt=0&maxResults=1",
167
+ * "startAt": 0,
168
+ * "total": 10,
169
+ * "values": [
170
+ * {
171
+ * "id": 1,
172
+ * "value": "Team 1",
173
+ * "properties": {
174
+ * "leader": {
175
+ * "name": "Leader Name",
176
+ * "email": "lname@example.com"
177
+ * },
178
+ * "members": 42,
179
+ * "description": "The team's description",
180
+ * "founded": "2016-06-06"
181
+ * },
182
+ * "config": {
183
+ * "scope": {
184
+ * "projects": [],
185
+ * "projects2": [
186
+ * {
187
+ * "id": 1001,
188
+ * "attributes": [
189
+ * "notSelectable"
190
+ * ]
191
+ * },
192
+ * {
193
+ * "id": 1002,
194
+ * "attributes": [
195
+ * "notSelectable"
196
+ * ]
197
+ * }
198
+ * ],
199
+ * "global": {}
200
+ * },
201
+ * "attributes": []
202
+ * }
203
+ * }
204
+ * ]
205
+ * }
206
+ * @path {GET} /rest/api/3/field/{fieldKey}/option
207
+ * @scopes-current manage:jira-configuration
208
+ * @scopes-beta read:field.option:jira
209
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-get
210
+ */
211
+ this.getAllIssueFieldOptions = ({ fieldKey, startAt, maxResults, }) => {
212
+ return this.getClientInstance()
213
+ .request({
214
+ path: "/rest/api/3/field/{fieldKey}/option",
215
+ method: "GET",
216
+ pathParams: {
217
+ fieldKey,
218
+ },
219
+ query: {
220
+ startAt,
221
+ maxResults,
222
+ },
223
+ })
224
+ .then(this.getClientInstance().responseHandler({
225
+ 200: {
226
+ "application/json": "json",
227
+ },
228
+ }))
229
+ .then(commonHttpClient.castResponse())
230
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldOptionsAppsService.getAllIssueFieldOptions.response"))
231
+ .then(commonHttpClient.getBody);
232
+ };
233
+ /**
234
+ * Returns an option from a select list issue field.
235
+ *
236
+ * Note that this operation **only works for issue field select list options added
237
+ * by Connect apps**, it cannot be used with issue field select list options
238
+ * created in Jira or using operations from the [Issue custom field
239
+ * options](#api-group-Issue-custom-field-options) resource.
240
+ *
241
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
242
+ * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
243
+ * not required for the app providing the field.
244
+ *
245
+ * @returns Returned if the requested option is returned.
246
+ *
247
+ * example: {
248
+ * "id": 1,
249
+ * "value": "Team 1",
250
+ * "properties": {
251
+ * "leader": {
252
+ * "name": "Leader Name",
253
+ * "email": "lname@example.com"
254
+ * },
255
+ * "members": 42,
256
+ * "description": "The team's description",
257
+ * "founded": "2016-06-06"
258
+ * },
259
+ * "config": {
260
+ * "scope": {
261
+ * "projects": [],
262
+ * "projects2": [
263
+ * {
264
+ * "id": 1001,
265
+ * "attributes": [
266
+ * "notSelectable"
267
+ * ]
268
+ * },
269
+ * {
270
+ * "id": 1002,
271
+ * "attributes": [
272
+ * "notSelectable"
273
+ * ]
274
+ * }
275
+ * ],
276
+ * "global": {}
277
+ * },
278
+ * "attributes": []
279
+ * }
280
+ * }
281
+ * @path {GET} /rest/api/3/field/{fieldKey}/option/{optionId}
282
+ * @scopes-current manage:jira-configuration
283
+ * @scopes-beta read:field.option:jira
284
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-optionid-get
285
+ */
286
+ this.getIssueFieldOption = ({ fieldKey, optionId, }) => {
287
+ return this.getClientInstance()
288
+ .request({
289
+ path: "/rest/api/3/field/{fieldKey}/option/{optionId}",
290
+ method: "GET",
291
+ pathParams: {
292
+ fieldKey,
293
+ optionId,
294
+ },
295
+ })
296
+ .then(this.getClientInstance().responseHandler({
297
+ 200: {
298
+ "application/json": "json",
299
+ },
300
+ }))
301
+ .then(commonHttpClient.castResponse())
302
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldOptionsAppsService.getIssueFieldOption.response"))
303
+ .then(commonHttpClient.getBody);
304
+ };
305
+ /**
306
+ * Returns a [paginated](#pagination) list of options for a select list issue
307
+ * field that can be viewed and selected by the user.
308
+ *
309
+ * Note that this operation **only works for issue field select list options added
310
+ * by Connect apps**, it cannot be used with issue field select list options
311
+ * created in Jira or using operations from the [Issue custom field
312
+ * options](#api-group-Issue-custom-field-options) resource.
313
+ *
314
+ * **[Permissions](#permissions) required:** Permission to access Jira.
315
+ *
316
+ * @returns Returned if the request is successful.
317
+ *
318
+ * example: {
319
+ * "isLast": false,
320
+ * "maxResults": 1,
321
+ * "nextPage":
322
+ * "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=1&maxResults=1",
323
+ * "self":
324
+ * "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=0&maxResults=1",
325
+ * "startAt": 0,
326
+ * "total": 10,
327
+ * "values": [
328
+ * {
329
+ * "id": 1,
330
+ * "value": "Team 1",
331
+ * "properties": {
332
+ * "leader": {
333
+ * "name": "Leader Name",
334
+ * "email": "lname@example.com"
335
+ * },
336
+ * "members": 42,
337
+ * "description": "The team's description",
338
+ * "founded": "2016-06-06"
339
+ * }
340
+ * }
341
+ * ]
342
+ * }
343
+ * @path {GET} /rest/api/3/field/{fieldKey}/option/suggestions/edit
344
+ * @scopes-current read:jira-work
345
+ * @scopes-beta read:field.option:jira
346
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-suggestions-edit-get
347
+ */
348
+ this.getSelectableIssueFieldOptions = ({ fieldKey, startAt, maxResults, projectId, }) => {
349
+ return this.getClientInstance()
350
+ .request({
351
+ path: "/rest/api/3/field/{fieldKey}/option/suggestions/edit",
352
+ method: "GET",
353
+ pathParams: {
354
+ fieldKey,
355
+ },
356
+ query: {
357
+ startAt,
358
+ maxResults,
359
+ projectId,
360
+ },
361
+ })
362
+ .then(this.getClientInstance().responseHandler({
363
+ 200: {
364
+ "application/json": "json",
365
+ },
366
+ }))
367
+ .then(commonHttpClient.castResponse())
368
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldOptionsAppsService.getSelectableIssueFieldOptions.response"))
369
+ .then(commonHttpClient.getBody);
370
+ };
371
+ /**
372
+ * Returns a [paginated](#pagination) list of options for a select list issue
373
+ * field that can be viewed by the user.
374
+ *
375
+ * Note that this operation **only works for issue field select list options added
376
+ * by Connect apps**, it cannot be used with issue field select list options
377
+ * created in Jira or using operations from the [Issue custom field
378
+ * options](#api-group-Issue-custom-field-options) resource.
379
+ *
380
+ * **[Permissions](#permissions) required:** Permission to access Jira.
381
+ *
382
+ * @returns Returned if the request is successful.
383
+ *
384
+ * example: {
385
+ * "isLast": false,
386
+ * "maxResults": 1,
387
+ * "nextPage":
388
+ * "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=1&maxResults=1",
389
+ * "self":
390
+ * "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=0&maxResults=1",
391
+ * "startAt": 0,
392
+ * "total": 10,
393
+ * "values": [
394
+ * {
395
+ * "id": 1,
396
+ * "value": "Team 1",
397
+ * "properties": {
398
+ * "leader": {
399
+ * "name": "Leader Name",
400
+ * "email": "lname@example.com"
401
+ * },
402
+ * "members": 42,
403
+ * "description": "The team's description",
404
+ * "founded": "2016-06-06"
405
+ * }
406
+ * }
407
+ * ]
408
+ * }
409
+ * @path {GET} /rest/api/3/field/{fieldKey}/option/suggestions/search
410
+ * @scopes-current read:jira-work
411
+ * @scopes-beta read:field.option:jira
412
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-suggestions-search-get
413
+ */
414
+ this.getVisibleIssueFieldOptions = ({ fieldKey, startAt, maxResults, projectId, }) => {
415
+ return this.getClientInstance()
416
+ .request({
417
+ path: "/rest/api/3/field/{fieldKey}/option/suggestions/search",
418
+ method: "GET",
419
+ pathParams: {
420
+ fieldKey,
421
+ },
422
+ query: {
423
+ startAt,
424
+ maxResults,
425
+ projectId,
426
+ },
427
+ })
428
+ .then(this.getClientInstance().responseHandler({
429
+ 200: {
430
+ "application/json": "json",
431
+ },
432
+ }))
433
+ .then(commonHttpClient.castResponse())
434
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldOptionsAppsService.getVisibleIssueFieldOptions.response"))
435
+ .then(commonHttpClient.getBody);
436
+ };
437
+ /**
438
+ * Deselects an issue-field select-list option from all issues where it is
439
+ * selected. A different option can be selected to replace the deselected option.
440
+ * The update can also be limited to a smaller set of issues by using a JQL query.
441
+ *
442
+ * Connect and Forge app users with *Administer Jira* [global
443
+ * permission](https://confluence.atlassian.com/x/x4dKLg) can override the screen
444
+ * security configuration using `overrideScreenSecurity` and
445
+ * `overrideEditableFlag`.
446
+ *
447
+ * This is an [asynchronous operation](#async). The response object contains a
448
+ * link to the long-running task.
449
+ *
450
+ * Note that this operation **only works for issue field select list options added
451
+ * by Connect apps**, it cannot be used with issue field select list options
452
+ * created in Jira or using operations from the [Issue custom field
453
+ * options](#api-group-Issue-custom-field-options) resource.
454
+ *
455
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
456
+ * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
457
+ * not required for the app providing the field.
458
+ *
459
+ * @path {DELETE} /rest/api/3/field/{fieldKey}/option/{optionId}/issue
460
+ * @scopes-current manage:jira-configuration
461
+ * @scopes-beta write:field.option:jira, delete:field.option:jira
462
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-optionid-issue-delete
463
+ */
464
+ this.replaceIssueFieldOption = ({ fieldKey, optionId, replaceWith, jql, overrideScreenSecurity, overrideEditableFlag, }) => {
465
+ return this.getClientInstance()
466
+ .request({
467
+ path: "/rest/api/3/field/{fieldKey}/option/{optionId}/issue",
468
+ method: "DELETE",
469
+ pathParams: {
470
+ fieldKey,
471
+ optionId,
472
+ },
473
+ query: {
474
+ replaceWith,
475
+ jql,
476
+ overrideScreenSecurity,
477
+ overrideEditableFlag,
478
+ },
479
+ })
480
+ .then(commonHttpClient.discardResult);
481
+ };
482
+ /**
483
+ * Updates or creates an option for a select list issue field. This operation
484
+ * requires that the option ID is provided when creating an option, therefore, the
485
+ * option ID needs to be specified as a path and body parameter. The option ID
486
+ * provided in the path and body must be identical.
487
+ *
488
+ * Note that this operation **only works for issue field select list options added
489
+ * by Connect apps**, it cannot be used with issue field select list options
490
+ * created in Jira or using operations from the [Issue custom field
491
+ * options](#api-group-Issue-custom-field-options) resource.
492
+ *
493
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
494
+ * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are
495
+ * not required for the app providing the field.
496
+ *
497
+ * @returns Returned if the option is updated or created.
498
+ *
499
+ * example: {
500
+ * "id": 1,
501
+ * "value": "Team 1",
502
+ * "properties": {
503
+ * "leader": {
504
+ * "name": "Leader Name",
505
+ * "email": "lname@example.com"
506
+ * },
507
+ * "members": 42,
508
+ * "description": "The team's description",
509
+ * "founded": "2016-06-06"
510
+ * },
511
+ * "config": {
512
+ * "scope": {
513
+ * "projects": [],
514
+ * "projects2": [
515
+ * {
516
+ * "id": 1001,
517
+ * "attributes": [
518
+ * "notSelectable"
519
+ * ]
520
+ * },
521
+ * {
522
+ * "id": 1002,
523
+ * "attributes": [
524
+ * "notSelectable"
525
+ * ]
526
+ * }
527
+ * ],
528
+ * "global": {}
529
+ * },
530
+ * "attributes": []
531
+ * }
532
+ * }
533
+ * @path {PUT} /rest/api/3/field/{fieldKey}/option/{optionId}
534
+ * @scopes-current manage:jira-configuration
535
+ * @scopes-beta write:field.option:jira
536
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-#api-rest-api-3-field-fieldkey-option-optionid-put
537
+ */
538
+ this.updateIssueFieldOption = ({ fieldKey, optionId, issueFieldOption, }) => {
539
+ return this.getClientInstance()
540
+ .request({
541
+ path: "/rest/api/3/field/{fieldKey}/option/{optionId}",
542
+ method: "PUT",
543
+ pathParams: {
544
+ fieldKey,
545
+ optionId,
546
+ },
547
+ headers: {
548
+ "Content-Type": "application/json",
549
+ },
550
+ body: issueFieldOption,
551
+ })
552
+ .then(this.getClientInstance().responseHandler({
553
+ 200: {
554
+ "application/json": "json",
555
+ },
556
+ }))
557
+ .then(commonHttpClient.castResponse())
558
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldOptionsAppsService.updateIssueFieldOption.response"))
559
+ .then(commonHttpClient.getBody);
560
+ };
558
561
  }
559
562
  static initialize() {
560
563
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("IssueCustomFieldOptionsAppsService.getAllIssueFieldOptions.response", zod_1.z