@resolution/jira-api-client 0.4.2 → 0.4.5

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 (327) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/README.md +4 -0
  3. package/lib/openapi/platform/BaseJiraPlatformApiClient.d.ts +28 -4
  4. package/lib/openapi/platform/BaseJiraPlatformApiClient.js +24 -1
  5. package/lib/openapi/platform/BaseJiraPlatformApiClient.js.map +1 -1
  6. package/lib/openapi/platform/models/common.d.ts +6 -0
  7. package/lib/openapi/platform/models/common.js +12 -1
  8. package/lib/openapi/platform/models/common.js.map +1 -1
  9. package/lib/openapi/platform/models/dynamicModules.d.ts +0 -9
  10. package/lib/openapi/platform/models/dynamicModules.js +0 -6
  11. package/lib/openapi/platform/models/dynamicModules.js.map +1 -1
  12. package/lib/openapi/platform/models/issueBulkOperations.d.ts +547 -0
  13. package/lib/openapi/platform/models/issueBulkOperations.js +437 -0
  14. package/lib/openapi/platform/models/issueBulkOperations.js.map +1 -0
  15. package/lib/openapi/platform/services/AnnouncementBannerService.d.ts +3 -3
  16. package/lib/openapi/platform/services/AnnouncementBannerService.js +65 -62
  17. package/lib/openapi/platform/services/AnnouncementBannerService.js.map +1 -1
  18. package/lib/openapi/platform/services/AppDataPoliciesService.d.ts +4 -4
  19. package/lib/openapi/platform/services/AppDataPoliciesService.js +70 -67
  20. package/lib/openapi/platform/services/AppDataPoliciesService.js.map +1 -1
  21. package/lib/openapi/platform/services/AppMigrationService.d.ts +6 -6
  22. package/lib/openapi/platform/services/AppMigrationService.js +139 -136
  23. package/lib/openapi/platform/services/AppMigrationService.js.map +1 -1
  24. package/lib/openapi/platform/services/AppPropertiesService.d.ts +12 -12
  25. package/lib/openapi/platform/services/AppPropertiesService.js +254 -251
  26. package/lib/openapi/platform/services/AppPropertiesService.js.map +1 -1
  27. package/lib/openapi/platform/services/ApplicationRolesService.d.ts +3 -3
  28. package/lib/openapi/platform/services/ApplicationRolesService.js +177 -174
  29. package/lib/openapi/platform/services/ApplicationRolesService.js.map +1 -1
  30. package/lib/openapi/platform/services/AuditRecordsService.d.ts +7 -7
  31. package/lib/openapi/platform/services/AuditRecordsService.js +97 -94
  32. package/lib/openapi/platform/services/AuditRecordsService.js.map +1 -1
  33. package/lib/openapi/platform/services/AvatarsService.d.ts +25 -31
  34. package/lib/openapi/platform/services/AvatarsService.js +412 -415
  35. package/lib/openapi/platform/services/AvatarsService.js.map +1 -1
  36. package/lib/openapi/platform/services/ClassificationLevelsService.d.ts +4 -4
  37. package/lib/openapi/platform/services/ClassificationLevelsService.js +79 -76
  38. package/lib/openapi/platform/services/ClassificationLevelsService.js.map +1 -1
  39. package/lib/openapi/platform/services/DashboardsService.d.ts +62 -50
  40. package/lib/openapi/platform/services/DashboardsService.js +983 -974
  41. package/lib/openapi/platform/services/DashboardsService.js.map +1 -1
  42. package/lib/openapi/platform/services/DynamicModulesService.d.ts +6 -6
  43. package/lib/openapi/platform/services/DynamicModulesService.js +68 -65
  44. package/lib/openapi/platform/services/DynamicModulesService.js.map +1 -1
  45. package/lib/openapi/platform/services/FilterSharingService.d.ts +11 -11
  46. package/lib/openapi/platform/services/FilterSharingService.js +512 -509
  47. package/lib/openapi/platform/services/FilterSharingService.js.map +1 -1
  48. package/lib/openapi/platform/services/FiltersService.d.ts +50 -50
  49. package/lib/openapi/platform/services/FiltersService.js +1262 -1259
  50. package/lib/openapi/platform/services/FiltersService.js.map +1 -1
  51. package/lib/openapi/platform/services/GroupAndUserPickerService.d.ts +10 -10
  52. package/lib/openapi/platform/services/GroupAndUserPickerService.js +112 -109
  53. package/lib/openapi/platform/services/GroupAndUserPickerService.js.map +1 -1
  54. package/lib/openapi/platform/services/GroupsService.d.ts +46 -46
  55. package/lib/openapi/platform/services/GroupsService.js +385 -382
  56. package/lib/openapi/platform/services/GroupsService.js.map +1 -1
  57. package/lib/openapi/platform/services/IssueAttachmentsService.d.ts +20 -20
  58. package/lib/openapi/platform/services/IssueAttachmentsService.js +644 -641
  59. package/lib/openapi/platform/services/IssueAttachmentsService.js.map +1 -1
  60. package/lib/openapi/platform/services/IssueBulkOperationsService.d.ts +325 -0
  61. package/lib/openapi/platform/services/IssueBulkOperationsService.js +353 -0
  62. package/lib/openapi/platform/services/IssueBulkOperationsService.js.map +1 -0
  63. package/lib/openapi/platform/services/IssueCommentPropertiesService.d.ts +8 -8
  64. package/lib/openapi/platform/services/IssueCommentPropertiesService.js +187 -184
  65. package/lib/openapi/platform/services/IssueCommentPropertiesService.js.map +1 -1
  66. package/lib/openapi/platform/services/IssueCommentsService.d.ts +22 -22
  67. package/lib/openapi/platform/services/IssueCommentsService.js +507 -504
  68. package/lib/openapi/platform/services/IssueCommentsService.js.map +1 -1
  69. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.d.ts +11 -11
  70. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js +126 -123
  71. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js.map +1 -1
  72. package/lib/openapi/platform/services/IssueCustomFieldContextsService.d.ts +42 -42
  73. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js +748 -745
  74. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js.map +1 -1
  75. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.d.ts +28 -28
  76. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js +535 -532
  77. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js.map +1 -1
  78. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.d.ts +20 -20
  79. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js +358 -355
  80. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js.map +1 -1
  81. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.d.ts +6 -6
  82. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js +86 -83
  83. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js.map +1 -1
  84. package/lib/openapi/platform/services/IssueFieldConfigurationsService.d.ts +45 -45
  85. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js +689 -686
  86. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js.map +1 -1
  87. package/lib/openapi/platform/services/IssueFieldsService.d.ts +32 -32
  88. package/lib/openapi/platform/services/IssueFieldsService.js +484 -481
  89. package/lib/openapi/platform/services/IssueFieldsService.js.map +1 -1
  90. package/lib/openapi/platform/services/IssueLinkTypesService.d.ts +9 -9
  91. package/lib/openapi/platform/services/IssueLinkTypesService.js +212 -209
  92. package/lib/openapi/platform/services/IssueLinkTypesService.js.map +1 -1
  93. package/lib/openapi/platform/services/IssueLinksService.d.ts +6 -6
  94. package/lib/openapi/platform/services/IssueLinksService.js +230 -227
  95. package/lib/openapi/platform/services/IssueLinksService.js.map +1 -1
  96. package/lib/openapi/platform/services/IssueNavigatorSettingsService.d.ts +3 -3
  97. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js +72 -69
  98. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js.map +1 -1
  99. package/lib/openapi/platform/services/IssueNotificationSchemesService.d.ts +27 -27
  100. package/lib/openapi/platform/services/IssueNotificationSchemesService.js +816 -813
  101. package/lib/openapi/platform/services/IssueNotificationSchemesService.js.map +1 -1
  102. package/lib/openapi/platform/services/IssuePrioritiesService.d.ts +22 -22
  103. package/lib/openapi/platform/services/IssuePrioritiesService.js +307 -304
  104. package/lib/openapi/platform/services/IssuePrioritiesService.js.map +1 -1
  105. package/lib/openapi/platform/services/IssuePropertiesService.d.ts +16 -16
  106. package/lib/openapi/platform/services/IssuePropertiesService.js +390 -387
  107. package/lib/openapi/platform/services/IssuePropertiesService.js.map +1 -1
  108. package/lib/openapi/platform/services/IssueRemoteLinksService.d.ts +13 -13
  109. package/lib/openapi/platform/services/IssueRemoteLinksService.js +368 -365
  110. package/lib/openapi/platform/services/IssueRemoteLinksService.js.map +1 -1
  111. package/lib/openapi/platform/services/IssueResolutionsService.d.ts +19 -19
  112. package/lib/openapi/platform/services/IssueResolutionsService.js +283 -280
  113. package/lib/openapi/platform/services/IssueResolutionsService.js.map +1 -1
  114. package/lib/openapi/platform/services/IssueSearchService.d.ts +24 -24
  115. package/lib/openapi/platform/services/IssueSearchService.js +826 -823
  116. package/lib/openapi/platform/services/IssueSearchService.js.map +1 -1
  117. package/lib/openapi/platform/services/IssueSecurityLevelService.d.ts +8 -8
  118. package/lib/openapi/platform/services/IssueSecurityLevelService.js +137 -134
  119. package/lib/openapi/platform/services/IssueSecurityLevelService.js.map +1 -1
  120. package/lib/openapi/platform/services/IssueSecuritySchemesService.d.ts +51 -51
  121. package/lib/openapi/platform/services/IssueSecuritySchemesService.js +610 -607
  122. package/lib/openapi/platform/services/IssueSecuritySchemesService.js.map +1 -1
  123. package/lib/openapi/platform/services/IssueTypePropertiesService.d.ts +8 -8
  124. package/lib/openapi/platform/services/IssueTypePropertiesService.js +175 -172
  125. package/lib/openapi/platform/services/IssueTypePropertiesService.js.map +1 -1
  126. package/lib/openapi/platform/services/IssueTypeSchemesService.d.ts +31 -31
  127. package/lib/openapi/platform/services/IssueTypeSchemesService.js +527 -524
  128. package/lib/openapi/platform/services/IssueTypeSchemesService.js.map +1 -1
  129. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.d.ts +36 -36
  130. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js +508 -505
  131. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js.map +1 -1
  132. package/lib/openapi/platform/services/IssueTypesService.d.ts +22 -28
  133. package/lib/openapi/platform/services/IssueTypesService.js +424 -427
  134. package/lib/openapi/platform/services/IssueTypesService.js.map +1 -1
  135. package/lib/openapi/platform/services/IssueVotesService.d.ts +6 -6
  136. package/lib/openapi/platform/services/IssueVotesService.js +148 -145
  137. package/lib/openapi/platform/services/IssueVotesService.js.map +1 -1
  138. package/lib/openapi/platform/services/IssueWatchersService.d.ts +10 -10
  139. package/lib/openapi/platform/services/IssueWatchersService.js +197 -194
  140. package/lib/openapi/platform/services/IssueWatchersService.js.map +1 -1
  141. package/lib/openapi/platform/services/IssueWorklogPropertiesService.d.ts +8 -8
  142. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js +199 -196
  143. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js.map +1 -1
  144. package/lib/openapi/platform/services/IssueWorklogsService.d.ts +44 -44
  145. package/lib/openapi/platform/services/IssueWorklogsService.js +636 -633
  146. package/lib/openapi/platform/services/IssueWorklogsService.js.map +1 -1
  147. package/lib/openapi/platform/services/IssuesService.d.ts +71 -71
  148. package/lib/openapi/platform/services/IssuesService.js +1856 -1853
  149. package/lib/openapi/platform/services/IssuesService.js.map +1 -1
  150. package/lib/openapi/platform/services/JiraExpressionsService.d.ts +6 -6
  151. package/lib/openapi/platform/services/JiraExpressionsService.js +238 -235
  152. package/lib/openapi/platform/services/JiraExpressionsService.js.map +1 -1
  153. package/lib/openapi/platform/services/JiraSettingsService.d.ts +9 -9
  154. package/lib/openapi/platform/services/JiraSettingsService.js +279 -276
  155. package/lib/openapi/platform/services/JiraSettingsService.js.map +1 -1
  156. package/lib/openapi/platform/services/JqlFunctionsAppsService.d.ts +8 -8
  157. package/lib/openapi/platform/services/JqlFunctionsAppsService.js +107 -104
  158. package/lib/openapi/platform/services/JqlFunctionsAppsService.js.map +1 -1
  159. package/lib/openapi/platform/services/JqlService.d.ts +15 -15
  160. package/lib/openapi/platform/services/JqlService.js +635 -632
  161. package/lib/openapi/platform/services/JqlService.js.map +1 -1
  162. package/lib/openapi/platform/services/LabelsService.d.ts +4 -4
  163. package/lib/openapi/platform/services/LabelsService.js +41 -38
  164. package/lib/openapi/platform/services/LabelsService.js.map +1 -1
  165. package/lib/openapi/platform/services/LicenseMetricsService.d.ts +4 -4
  166. package/lib/openapi/platform/services/LicenseMetricsService.js +120 -117
  167. package/lib/openapi/platform/services/LicenseMetricsService.js.map +1 -1
  168. package/lib/openapi/platform/services/MyselfService.d.ts +14 -14
  169. package/lib/openapi/platform/services/MyselfService.js +321 -318
  170. package/lib/openapi/platform/services/MyselfService.js.map +1 -1
  171. package/lib/openapi/platform/services/PermissionSchemesService.d.ts +25 -25
  172. package/lib/openapi/platform/services/PermissionSchemesService.js +548 -545
  173. package/lib/openapi/platform/services/PermissionSchemesService.js.map +1 -1
  174. package/lib/openapi/platform/services/PermissionsService.d.ts +15 -15
  175. package/lib/openapi/platform/services/PermissionsService.js +235 -232
  176. package/lib/openapi/platform/services/PermissionsService.js.map +1 -1
  177. package/lib/openapi/platform/services/PrioritySchemesService.d.ts +34 -34
  178. package/lib/openapi/platform/services/PrioritySchemesService.js +571 -568
  179. package/lib/openapi/platform/services/PrioritySchemesService.js.map +1 -1
  180. package/lib/openapi/platform/services/ProjectAvatarsService.d.ts +11 -11
  181. package/lib/openapi/platform/services/ProjectAvatarsService.js +213 -210
  182. package/lib/openapi/platform/services/ProjectAvatarsService.js.map +1 -1
  183. package/lib/openapi/platform/services/ProjectCategoriesService.d.ts +9 -9
  184. package/lib/openapi/platform/services/ProjectCategoriesService.js +180 -177
  185. package/lib/openapi/platform/services/ProjectCategoriesService.js.map +1 -1
  186. package/lib/openapi/platform/services/ProjectClassificationLevelsService.d.ts +6 -6
  187. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js +125 -122
  188. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js.map +1 -1
  189. package/lib/openapi/platform/services/ProjectComponentsService.d.ts +28 -28
  190. package/lib/openapi/platform/services/ProjectComponentsService.js +1009 -1006
  191. package/lib/openapi/platform/services/ProjectComponentsService.js.map +1 -1
  192. package/lib/openapi/platform/services/ProjectEmailService.d.ts +4 -4
  193. package/lib/openapi/platform/services/ProjectEmailService.js +78 -75
  194. package/lib/openapi/platform/services/ProjectEmailService.js.map +1 -1
  195. package/lib/openapi/platform/services/ProjectFeaturesService.d.ts +4 -4
  196. package/lib/openapi/platform/services/ProjectFeaturesService.js +119 -116
  197. package/lib/openapi/platform/services/ProjectFeaturesService.js.map +1 -1
  198. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.d.ts +8 -8
  199. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js +100 -97
  200. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js.map +1 -1
  201. package/lib/openapi/platform/services/ProjectPermissionSchemesService.d.ts +10 -10
  202. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js +199 -196
  203. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js.map +1 -1
  204. package/lib/openapi/platform/services/ProjectPropertiesService.d.ts +8 -8
  205. package/lib/openapi/platform/services/ProjectPropertiesService.js +172 -169
  206. package/lib/openapi/platform/services/ProjectPropertiesService.js.map +1 -1
  207. package/lib/openapi/platform/services/ProjectRoleActorsService.d.ts +18 -18
  208. package/lib/openapi/platform/services/ProjectRoleActorsService.js +362 -359
  209. package/lib/openapi/platform/services/ProjectRoleActorsService.js.map +1 -1
  210. package/lib/openapi/platform/services/ProjectRolesService.d.ts +21 -21
  211. package/lib/openapi/platform/services/ProjectRolesService.js +576 -573
  212. package/lib/openapi/platform/services/ProjectRolesService.js.map +1 -1
  213. package/lib/openapi/platform/services/ProjectTypesService.d.ts +6 -6
  214. package/lib/openapi/platform/services/ProjectTypesService.js +173 -170
  215. package/lib/openapi/platform/services/ProjectTypesService.js.map +1 -1
  216. package/lib/openapi/platform/services/ProjectVersionsService.d.ts +40 -40
  217. package/lib/openapi/platform/services/ProjectVersionsService.js +751 -748
  218. package/lib/openapi/platform/services/ProjectVersionsService.js.map +1 -1
  219. package/lib/openapi/platform/services/ProjectsService.d.ts +49 -49
  220. package/lib/openapi/platform/services/ProjectsService.js +1597 -1594
  221. package/lib/openapi/platform/services/ProjectsService.js.map +1 -1
  222. package/lib/openapi/platform/services/ScreenSchemesService.d.ts +14 -14
  223. package/lib/openapi/platform/services/ScreenSchemesService.js +177 -174
  224. package/lib/openapi/platform/services/ScreenSchemesService.js.map +1 -1
  225. package/lib/openapi/platform/services/ScreenTabFieldsService.d.ts +9 -9
  226. package/lib/openapi/platform/services/ScreenTabFieldsService.js +144 -141
  227. package/lib/openapi/platform/services/ScreenTabFieldsService.js.map +1 -1
  228. package/lib/openapi/platform/services/ScreenTabsService.d.ts +17 -17
  229. package/lib/openapi/platform/services/ScreenTabsService.js +229 -226
  230. package/lib/openapi/platform/services/ScreenTabsService.js.map +1 -1
  231. package/lib/openapi/platform/services/ScreensService.d.ts +23 -23
  232. package/lib/openapi/platform/services/ScreensService.js +281 -278
  233. package/lib/openapi/platform/services/ScreensService.js.map +1 -1
  234. package/lib/openapi/platform/services/ServerInfoService.d.ts +1 -1
  235. package/lib/openapi/platform/services/ServerInfoService.js +51 -48
  236. package/lib/openapi/platform/services/ServerInfoService.js.map +1 -1
  237. package/lib/openapi/platform/services/ServiceRegistryService.d.ts +2 -2
  238. package/lib/openapi/platform/services/ServiceRegistryService.js +30 -27
  239. package/lib/openapi/platform/services/ServiceRegistryService.js.map +1 -1
  240. package/lib/openapi/platform/services/StatusService.d.ts +17 -17
  241. package/lib/openapi/platform/services/StatusService.js +271 -268
  242. package/lib/openapi/platform/services/StatusService.js.map +1 -1
  243. package/lib/openapi/platform/services/TasksService.d.ts +4 -4
  244. package/lib/openapi/platform/services/TasksService.js +93 -90
  245. package/lib/openapi/platform/services/TasksService.js.map +1 -1
  246. package/lib/openapi/platform/services/TimeTrackingService.d.ts +7 -7
  247. package/lib/openapi/platform/services/TimeTrackingService.js +190 -187
  248. package/lib/openapi/platform/services/TimeTrackingService.js.map +1 -1
  249. package/lib/openapi/platform/services/UiModificationsAppsService.d.ts +11 -11
  250. package/lib/openapi/platform/services/UiModificationsAppsService.js +214 -211
  251. package/lib/openapi/platform/services/UiModificationsAppsService.js.map +1 -1
  252. package/lib/openapi/platform/services/UserPropertiesService.d.ts +20 -20
  253. package/lib/openapi/platform/services/UserPropertiesService.js +196 -193
  254. package/lib/openapi/platform/services/UserPropertiesService.js.map +1 -1
  255. package/lib/openapi/platform/services/UserSearchService.d.ts +61 -61
  256. package/lib/openapi/platform/services/UserSearchService.js +709 -706
  257. package/lib/openapi/platform/services/UserSearchService.js.map +1 -1
  258. package/lib/openapi/platform/services/UsersService.d.ts +51 -51
  259. package/lib/openapi/platform/services/UsersService.js +637 -634
  260. package/lib/openapi/platform/services/UsersService.js.map +1 -1
  261. package/lib/openapi/platform/services/WebhooksService.d.ts +14 -14
  262. package/lib/openapi/platform/services/WebhooksService.js +262 -259
  263. package/lib/openapi/platform/services/WebhooksService.js.map +1 -1
  264. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.d.ts +30 -30
  265. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js +861 -858
  266. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js.map +1 -1
  267. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.d.ts +4 -4
  268. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js +98 -95
  269. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js.map +1 -1
  270. package/lib/openapi/platform/services/WorkflowSchemesService.d.ts +45 -45
  271. package/lib/openapi/platform/services/WorkflowSchemesService.js +899 -896
  272. package/lib/openapi/platform/services/WorkflowSchemesService.js.map +1 -1
  273. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.d.ts +3 -3
  274. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js +82 -79
  275. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js.map +1 -1
  276. package/lib/openapi/platform/services/WorkflowStatusesService.d.ts +3 -3
  277. package/lib/openapi/platform/services/WorkflowStatusesService.js +110 -107
  278. package/lib/openapi/platform/services/WorkflowStatusesService.js.map +1 -1
  279. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.d.ts +14 -14
  280. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js +182 -179
  281. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js.map +1 -1
  282. package/lib/openapi/platform/services/WorkflowTransitionRulesService.d.ts +13 -13
  283. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js +283 -280
  284. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js.map +1 -1
  285. package/lib/openapi/platform/services/WorkflowsService.d.ts +33 -33
  286. package/lib/openapi/platform/services/WorkflowsService.js +2451 -2448
  287. package/lib/openapi/platform/services/WorkflowsService.js.map +1 -1
  288. package/lib/openapi/software/services/BacklogService.d.ts +4 -4
  289. package/lib/openapi/software/services/BacklogService.js +81 -78
  290. package/lib/openapi/software/services/BacklogService.js.map +1 -1
  291. package/lib/openapi/software/services/BoardService.d.ts +124 -124
  292. package/lib/openapi/software/services/BoardService.js +2048 -2045
  293. package/lib/openapi/software/services/BoardService.js.map +1 -1
  294. package/lib/openapi/software/services/BuildsService.d.ts +10 -10
  295. package/lib/openapi/software/services/BuildsService.js +164 -161
  296. package/lib/openapi/software/services/BuildsService.js.map +1 -1
  297. package/lib/openapi/software/services/DeploymentsService.d.ts +12 -12
  298. package/lib/openapi/software/services/DeploymentsService.js +192 -189
  299. package/lib/openapi/software/services/DeploymentsService.js.map +1 -1
  300. package/lib/openapi/software/services/DevOpsComponentsService.d.ts +8 -8
  301. package/lib/openapi/software/services/DevOpsComponentsService.js +145 -142
  302. package/lib/openapi/software/services/DevOpsComponentsService.js.map +1 -1
  303. package/lib/openapi/software/services/DevelopmentInformationService.d.ts +16 -16
  304. package/lib/openapi/software/services/DevelopmentInformationService.js +178 -175
  305. package/lib/openapi/software/services/DevelopmentInformationService.js.map +1 -1
  306. package/lib/openapi/software/services/EpicService.d.ts +26 -26
  307. package/lib/openapi/software/services/EpicService.js +597 -594
  308. package/lib/openapi/software/services/EpicService.js.map +1 -1
  309. package/lib/openapi/software/services/FeatureFlagsService.d.ts +10 -10
  310. package/lib/openapi/software/services/FeatureFlagsService.js +151 -148
  311. package/lib/openapi/software/services/FeatureFlagsService.js.map +1 -1
  312. package/lib/openapi/software/services/IssueService.d.ts +13 -13
  313. package/lib/openapi/software/services/IssueService.js +359 -356
  314. package/lib/openapi/software/services/IssueService.js.map +1 -1
  315. package/lib/openapi/software/services/OperationsService.d.ts +24 -24
  316. package/lib/openapi/software/services/OperationsService.js +301 -298
  317. package/lib/openapi/software/services/OperationsService.js.map +1 -1
  318. package/lib/openapi/software/services/RemoteLinksService.d.ts +15 -15
  319. package/lib/openapi/software/services/RemoteLinksService.js +160 -157
  320. package/lib/openapi/software/services/RemoteLinksService.js.map +1 -1
  321. package/lib/openapi/software/services/SecurityInformationService.d.ts +16 -16
  322. package/lib/openapi/software/services/SecurityInformationService.js +262 -259
  323. package/lib/openapi/software/services/SecurityInformationService.js.map +1 -1
  324. package/lib/openapi/software/services/SprintService.d.ts +33 -33
  325. package/lib/openapi/software/services/SprintService.js +594 -591
  326. package/lib/openapi/software/services/SprintService.js.map +1 -1
  327. package/package.json +4 -3
@@ -22,751 +22,754 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
22
22
  * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts
23
23
  */
24
24
  class IssueCustomFieldContextsService extends CommonHttpService_1.CommonHttpService {
25
- /**
26
- * Adds issue types to a custom field context, appending the issue types to the
27
- * issue types list.
28
- *
29
- * A custom field context without any issue types applies to all issue types.
30
- * Adding issue types to such a custom field context would result in it applying
31
- * to only the listed issue types.
32
- *
33
- * If any of the issue types exists in the custom field context, the operation
34
- * fails and no issue types are added.
35
- *
36
- * **[Permissions](#permissions) required:** *Administer Jira* [global
37
- * permission](https://confluence.atlassian.com/x/x4dKLg).
38
- *
39
- * @returns Returned if operation is successful.
40
- * @path {PUT} /rest/api/3/field/{fieldId}/context/{contextId}/issuetype
41
- * @scopes-current manage:jira-configuration
42
- * @scopes-beta write:field:jira
43
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-contextid-issuetype-put
44
- */
45
- addIssueTypesToContext({ fieldId, contextId, issueTypeIds, }) {
46
- return this.getClientInstance()
47
- .request({
48
- path: "/rest/api/3/field/{fieldId}/context/{contextId}/issuetype",
49
- method: "PUT",
50
- pathParams: {
51
- fieldId,
52
- contextId,
53
- },
54
- headers: {
55
- "Content-Type": "application/json",
56
- },
57
- body: issueTypeIds,
58
- })
59
- .then(this.getClientInstance().responseHandler({
60
- 204: {
61
- "application/json": "json",
62
- },
63
- }))
64
- .then(commonHttpClient.castResponse())
65
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.addIssueTypesToContext.response"))
66
- .then(commonHttpClient.getBody);
67
- }
68
- /**
69
- * Assigns a custom field context to projects.
70
- *
71
- * If any project in the request is assigned to any context of the custom field,
72
- * the operation fails.
73
- *
74
- * **[Permissions](#permissions) required:** *Administer Jira* [global
75
- * permission](https://confluence.atlassian.com/x/x4dKLg).
76
- *
77
- * @returns Returned if operation is successful.
78
- * @path {PUT} /rest/api/3/field/{fieldId}/context/{contextId}/project
79
- * @scopes-current manage:jira-configuration
80
- * @scopes-beta write:field:jira
81
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-contextid-project-put
82
- */
83
- assignProjectsToCustomFieldContext({ fieldId, contextId, projectIds, }) {
84
- return this.getClientInstance()
85
- .request({
86
- path: "/rest/api/3/field/{fieldId}/context/{contextId}/project",
87
- method: "PUT",
88
- pathParams: {
89
- fieldId,
90
- contextId,
91
- },
92
- headers: {
93
- "Content-Type": "application/json",
94
- },
95
- body: projectIds,
96
- })
97
- .then(this.getClientInstance().responseHandler({
98
- 204: {
99
- "application/json": "json",
100
- },
101
- }))
102
- .then(commonHttpClient.castResponse())
103
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.assignProjectsToCustomFieldContext.response"))
104
- .then(commonHttpClient.getBody);
105
- }
106
- /**
107
- * Creates a custom field context.
108
- *
109
- * If `projectIds` is empty, a global context is created. A global context is one
110
- * that applies to all project. If `issueTypeIds` is empty, the context applies to
111
- * all issue types.
112
- *
113
- * **[Permissions](#permissions) required:** *Administer Jira* [global
114
- * permission](https://confluence.atlassian.com/x/x4dKLg).
115
- *
116
- * @returns Returned if the custom field context is created.
117
- *
118
- * example: {
119
- * "id": "10025",
120
- * "name": "Bug fields context",
121
- * "description": "A context used to define the custom field options for bugs.",
122
- * "projectIds": [],
123
- * "issueTypeIds": [
124
- * "10010"
125
- * ]
126
- * }
127
- * @path {POST} /rest/api/3/field/{fieldId}/context
128
- * @scopes-current manage:jira-configuration
129
- * @scopes-beta read:field:jira, write:field:jira,
130
- * read:custom-field-contextual-configuration:jira
131
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-post
132
- */
133
- createCustomFieldContext({ fieldId, createCustomFieldContext, }) {
134
- return this.getClientInstance()
135
- .request({
136
- path: "/rest/api/3/field/{fieldId}/context",
137
- method: "POST",
138
- pathParams: {
139
- fieldId,
140
- },
141
- headers: {
142
- "Content-Type": "application/json",
143
- },
144
- body: createCustomFieldContext,
145
- })
146
- .then(this.getClientInstance().responseHandler({
147
- 201: {
148
- "application/json": "json",
149
- },
150
- }))
151
- .then(commonHttpClient.castResponse())
152
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.createCustomFieldContext.response"))
153
- .then(commonHttpClient.getBody);
154
- }
155
- /**
156
- * Deletes a [ custom field
157
- * context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html).
158
- *
159
- * **[Permissions](#permissions) required:** *Administer Jira* [global
160
- * permission](https://confluence.atlassian.com/x/x4dKLg).
161
- *
162
- * @returns Returned if the context is deleted.
163
- * @path {DELETE} /rest/api/3/field/{fieldId}/context/{contextId}
164
- * @scopes-current manage:jira-configuration
165
- * @scopes-beta delete:field:jira
166
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-contextid-delete
167
- */
168
- deleteCustomFieldContext({ fieldId, contextId, }) {
169
- return this.getClientInstance()
170
- .request({
171
- path: "/rest/api/3/field/{fieldId}/context/{contextId}",
172
- method: "DELETE",
173
- pathParams: {
174
- fieldId,
175
- contextId,
176
- },
177
- })
178
- .then(this.getClientInstance().responseHandler({
179
- 204: {
180
- "application/json": "json",
181
- },
182
- }))
183
- .then(commonHttpClient.castResponse())
184
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.deleteCustomFieldContext.response"))
185
- .then(commonHttpClient.getBody);
186
- }
187
- /**
188
- * Returns a [paginated](#pagination) list of [
189
- * contexts](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html)
190
- * for a custom field. Contexts can be returned as follows:
191
- *
192
- * * With no other parameters set, all contexts.
193
- * * By defining `id` only, all contexts from the list of IDs.
194
- * * By defining `isAnyIssueType`, limit the list of contexts returned to either
195
- * those that apply to all issue types (true) or those that apply to only a subset
196
- * of issue types (false)
197
- * * By defining `isGlobalContext`, limit the list of contexts return to either
198
- * those that apply to all projects (global contexts) (true) or those that apply
199
- * to only a subset of projects (false).
200
- *
201
- * **[Permissions](#permissions) required:** *Administer Jira* [global
202
- * permission](https://confluence.atlassian.com/x/x4dKLg).
203
- *
204
- * @returns Returned if the request is successful.
205
- *
206
- * example: {
207
- * "isLast": true,
208
- * "maxResults": 100,
209
- * "startAt": 0,
210
- * "total": 2,
211
- * "values": [
212
- * {
213
- * "id": "10025",
214
- * "name": "Bug fields context",
215
- * "description": "A context used to define the custom field options for
216
- * bugs.",
217
- * "isGlobalContext": true,
218
- * "isAnyIssueType": false
219
- * },
220
- * {
221
- * "id": "10026",
222
- * "name": "Task fields context",
223
- * "description": "A context used to define the custom field options for
224
- * tasks.",
225
- * "isGlobalContext": false,
226
- * "isAnyIssueType": false
227
- * }
228
- * ]
229
- * }
230
- * @path {GET} /rest/api/3/field/{fieldId}/context
231
- * @scopes-current manage:jira-configuration
232
- * @scopes-beta read:field:jira, read:custom-field-contextual-configuration:jira
233
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-get
234
- */
235
- getContextsForField({ fieldId, isAnyIssueType, isGlobalContext, contextId, startAt, maxResults, }) {
236
- return this.getClientInstance()
237
- .request({
238
- path: "/rest/api/3/field/{fieldId}/context",
239
- method: "GET",
240
- pathParams: {
241
- fieldId,
242
- },
243
- query: {
244
- isAnyIssueType,
245
- isGlobalContext,
246
- contextId,
247
- startAt,
248
- maxResults,
249
- },
250
- })
251
- .then(this.getClientInstance().responseHandler({
252
- 200: {
253
- "application/json": "json",
254
- },
255
- }))
256
- .then(commonHttpClient.castResponse())
257
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.getContextsForField.response"))
258
- .then(commonHttpClient.getBody);
259
- }
260
- /**
261
- * Returns a [paginated](#pagination) list of project and issue type mappings and,
262
- * for each mapping, the ID of a [custom field
263
- * context](https://confluence.atlassian.com/x/k44fOw) that applies to the project
264
- * and issue type.
265
- *
266
- * If there is no custom field context assigned to the project then, if present,
267
- * the custom field context that applies to all projects is returned if it also
268
- * applies to the issue type or all issue types. If a custom field context is not
269
- * found, the returned custom field context ID is `null`.
270
- *
271
- * Duplicate project and issue type mappings cannot be provided in the request.
272
- *
273
- * The order of the returned values is the same as provided in the request.
274
- *
275
- * **[Permissions](#permissions) required:** *Administer Jira* [global
276
- * permission](https://confluence.atlassian.com/x/x4dKLg).
277
- *
278
- * @returns Returned if the request is successful.
279
- *
280
- * example: {
281
- * "isLast": true,
282
- * "maxResults": 50,
283
- * "startAt": 0,
284
- * "total": 3,
285
- * "values": [
286
- * {
287
- * "projectId": "10000",
288
- * "issueTypeId": "10000",
289
- * "contextId": "10000"
290
- * },
291
- * {
292
- * "projectId": "10000",
293
- * "issueTypeId": "10001",
294
- * "contextId": null
295
- * },
296
- * {
297
- * "projectId": "10001",
298
- * "issueTypeId": "10002",
299
- * "contextId": "10003"
300
- * }
301
- * ]
302
- * }
303
- * @path {POST} /rest/api/3/field/{fieldId}/context/mapping
304
- * @scopes-current manage:jira-configuration
305
- * @scopes-beta read:field:jira
306
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-mapping-post
307
- */
308
- getCustomFieldContextsForProjectsAndIssueTypes({ fieldId, startAt, maxResults, projectIssueTypeMappings, }) {
309
- return this.getClientInstance()
310
- .request({
311
- path: "/rest/api/3/field/{fieldId}/context/mapping",
312
- method: "POST",
313
- pathParams: {
314
- fieldId,
315
- },
316
- query: {
317
- startAt,
318
- maxResults,
319
- },
320
- headers: {
321
- "Content-Type": "application/json",
322
- },
323
- body: projectIssueTypeMappings,
324
- })
325
- .then(this.getClientInstance().responseHandler({
326
- 200: {
327
- "application/json": "json",
328
- },
329
- }))
330
- .then(commonHttpClient.castResponse())
331
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.getCustomFieldContextsForProjectsAndIssueTypes.response"))
332
- .then(commonHttpClient.getBody);
333
- }
334
- /**
335
- * Returns a [paginated](#pagination) list of defaults for a custom field. The
336
- * results can be filtered by `contextId`, otherwise all values are returned. If
337
- * no defaults are set for a context, nothing is returned.
338
- * The returned object depends on type of the custom field:
339
- *
340
- * * `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields.
341
- * * `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for
342
- * date-time fields.
343
- * * `CustomFieldContextDefaultValueSingleOption` (type `option.single`) for
344
- * single choice select lists and radio buttons.
345
- * * `CustomFieldContextDefaultValueMultipleOption` (type `option.multiple`) for
346
- * multiple choice select lists and checkboxes.
347
- * * `CustomFieldContextDefaultValueCascadingOption` (type `option.cascading`)
348
- * for cascading select lists.
349
- * * `CustomFieldContextSingleUserPickerDefaults` (type `single.user.select`)
350
- * for single users.
351
- * * `CustomFieldContextDefaultValueMultiUserPicker` (type `multi.user.select`)
352
- * for user lists.
353
- * * `CustomFieldContextDefaultValueSingleGroupPicker` (type
354
- * `grouppicker.single`) for single choice group pickers.
355
- * * `CustomFieldContextDefaultValueMultipleGroupPicker` (type
356
- * `grouppicker.multiple`) for multiple choice group pickers.
357
- * * `CustomFieldContextDefaultValueURL` (type `url`) for URLs.
358
- * * `CustomFieldContextDefaultValueProject` (type `project`) for project
359
- * pickers.
360
- * * `CustomFieldContextDefaultValueFloat` (type `float`) for floats
361
- * (floating-point numbers).
362
- * * `CustomFieldContextDefaultValueLabels` (type `labels`) for labels.
363
- * * `CustomFieldContextDefaultValueTextField` (type `textfield`) for text
364
- * fields.
365
- * * `CustomFieldContextDefaultValueTextArea` (type `textarea`) for text area
366
- * fields.
367
- * * `CustomFieldContextDefaultValueReadOnly` (type `readonly`) for read only
368
- * (text) fields.
369
- * * `CustomFieldContextDefaultValueMultipleVersion` (type `version.multiple`)
370
- * for single choice version pickers.
371
- * * `CustomFieldContextDefaultValueSingleVersion` (type `version.single`) for
372
- * multiple choice version pickers.
373
- *
374
- * Forge custom fields
375
- * [types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/#data-types)
376
- * are also supported, returning:
377
- *
378
- * * `CustomFieldContextDefaultValueForgeStringFieldBean` (type `forge.string`)
379
- * for Forge string fields.
380
- * * `CustomFieldContextDefaultValueForgeMultiStringFieldBean` (type
381
- * `forge.string.list`) for Forge string collection fields.
382
- * * `CustomFieldContextDefaultValueForgeObjectFieldBean` (type `forge.object`)
383
- * for Forge object fields.
384
- * * `CustomFieldContextDefaultValueForgeDateTimeFieldBean` (type
385
- * `forge.datetime`) for Forge date-time fields.
386
- * * `CustomFieldContextDefaultValueForgeGroupFieldBean` (type `forge.group`)
387
- * for Forge group fields.
388
- * * `CustomFieldContextDefaultValueForgeMultiGroupFieldBean` (type
389
- * `forge.group.list`) for Forge group collection fields.
390
- * * `CustomFieldContextDefaultValueForgeNumberFieldBean` (type `forge.number`)
391
- * for Forge number fields.
392
- * * `CustomFieldContextDefaultValueForgeUserFieldBean` (type `forge.user`) for
393
- * Forge user fields.
394
- * * `CustomFieldContextDefaultValueForgeMultiUserFieldBean` (type
395
- * `forge.user.list`) for Forge user collection fields.
396
- *
397
- * **[Permissions](#permissions) required:** *Administer Jira* [global
398
- * permission](https://confluence.atlassian.com/x/x4dKLg).
399
- *
400
- * @returns Returned if the request is successful.
401
- *
402
- * example: {
403
- * "isLast": true,
404
- * "maxResults": 50,
405
- * "startAt": 0,
406
- * "total": 3,
407
- * "values": [
408
- * {
409
- * "contextId": "10100",
410
- * "optionId": "10001"
411
- * },
412
- * {
413
- * "contextId": "10101",
414
- * "optionId": "10003"
415
- * },
416
- * {
417
- * "contextId": "10103"
418
- * }
419
- * ]
420
- * }
421
- * @path {GET} /rest/api/3/field/{fieldId}/context/defaultValue
422
- * @scopes-current manage:jira-configuration
423
- * @scopes-beta read:field.default-value:jira
424
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-defaultvalue-get
425
- */
426
- getDefaultValues({ fieldId, contextId, startAt, maxResults, }) {
427
- return this.getClientInstance()
428
- .request({
429
- path: "/rest/api/3/field/{fieldId}/context/defaultValue",
430
- method: "GET",
431
- pathParams: {
432
- fieldId,
433
- },
434
- query: {
435
- contextId,
436
- startAt,
437
- maxResults,
438
- },
439
- })
440
- .then(this.getClientInstance().responseHandler({
441
- 200: {
442
- "application/json": "json",
443
- },
444
- }))
445
- .then(commonHttpClient.castResponse())
446
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.getDefaultValues.response"))
447
- .then(commonHttpClient.getBody);
448
- }
449
- /**
450
- * Returns a [paginated](#pagination) list of context to issue type mappings for a
451
- * custom field. Mappings are returned for all contexts or a list of contexts.
452
- * Mappings are ordered first by context ID and then by issue type ID.
453
- *
454
- * **[Permissions](#permissions) required:** *Administer Jira* [global
455
- * permission](https://confluence.atlassian.com/x/x4dKLg).
456
- *
457
- * @returns Returned if operation is successful.
458
- *
459
- * example: {
460
- * "isLast": true,
461
- * "maxResults": 100,
462
- * "startAt": 0,
463
- * "total": 3,
464
- * "values": [
465
- * {
466
- * "contextId": "10001",
467
- * "issueTypeId": "10010"
468
- * },
469
- * {
470
- * "contextId": "10001",
471
- * "issueTypeId": "10011"
472
- * },
473
- * {
474
- * "contextId": "10002",
475
- * "isAnyIssueType": true
476
- * }
477
- * ]
478
- * }
479
- * @path {GET} /rest/api/3/field/{fieldId}/context/issuetypemapping
480
- * @scopes-current manage:jira-configuration
481
- * @scopes-beta read:field:jira
482
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-issuetypemapping-get
483
- */
484
- getIssueTypeMappingsForContexts({ fieldId, contextId, startAt, maxResults, }) {
485
- return this.getClientInstance()
486
- .request({
487
- path: "/rest/api/3/field/{fieldId}/context/issuetypemapping",
488
- method: "GET",
489
- pathParams: {
490
- fieldId,
491
- },
492
- query: {
493
- contextId,
494
- startAt,
495
- maxResults,
496
- },
497
- })
498
- .then(this.getClientInstance().responseHandler({
499
- 200: {
500
- "application/json": "json",
501
- },
502
- }))
503
- .then(commonHttpClient.castResponse())
504
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.getIssueTypeMappingsForContexts.response"))
505
- .then(commonHttpClient.getBody);
506
- }
507
- /**
508
- * Returns a [paginated](#pagination) list of context to project mappings for a
509
- * custom field. The result can be filtered by `contextId`. Otherwise, all
510
- * mappings are returned. Invalid IDs are ignored.
511
- *
512
- * **[Permissions](#permissions) required:** *Administer Jira* [global
513
- * permission](https://confluence.atlassian.com/x/x4dKLg).
514
- *
515
- * @returns Returned if the request is successful.
516
- *
517
- * example: {
518
- * "isLast": true,
519
- * "maxResults": 100,
520
- * "startAt": 0,
521
- * "total": 2,
522
- * "values": [
523
- * {
524
- * "contextId": "10025",
525
- * "projectId": "10001"
526
- * },
527
- * {
528
- * "contextId": "10026",
529
- * "isGlobalContext": true
530
- * }
531
- * ]
532
- * }
533
- * @path {GET} /rest/api/3/field/{fieldId}/context/projectmapping
534
- * @scopes-current manage:jira-configuration
535
- * @scopes-beta read:field:jira
536
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-projectmapping-get
537
- */
538
- getProjectContextMapping({ fieldId, contextId, startAt, maxResults, }) {
539
- return this.getClientInstance()
540
- .request({
541
- path: "/rest/api/3/field/{fieldId}/context/projectmapping",
542
- method: "GET",
543
- pathParams: {
544
- fieldId,
545
- },
546
- query: {
547
- contextId,
548
- startAt,
549
- maxResults,
550
- },
551
- })
552
- .then(this.getClientInstance().responseHandler({
553
- 200: {
554
- "application/json": "json",
555
- },
556
- }))
557
- .then(commonHttpClient.castResponse())
558
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.getProjectContextMapping.response"))
559
- .then(commonHttpClient.getBody);
560
- }
561
- /**
562
- * Removes a custom field context from projects.
563
- *
564
- * A custom field context without any projects applies to all projects. Removing
565
- * all projects from a custom field context would result in it applying to all
566
- * projects.
567
- *
568
- * If any project in the request is not assigned to the context, or the operation
569
- * would result in two global contexts for the field, the operation fails.
570
- *
571
- * **[Permissions](#permissions) required:** *Administer Jira* [global
572
- * permission](https://confluence.atlassian.com/x/x4dKLg).
573
- *
574
- * @returns Returned if the custom field context is removed from the projects.
575
- * @path {POST} /rest/api/3/field/{fieldId}/context/{contextId}/project/remove
576
- * @scopes-current manage:jira-configuration
577
- * @scopes-beta write:field:jira
578
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-contextid-project-remove-post
579
- */
580
- removeCustomFieldContextFromProjects({ fieldId, contextId, projectIds, }) {
581
- return this.getClientInstance()
582
- .request({
583
- path: "/rest/api/3/field/{fieldId}/context/{contextId}/project/remove",
584
- method: "POST",
585
- pathParams: {
586
- fieldId,
587
- contextId,
588
- },
589
- headers: {
590
- "Content-Type": "application/json",
591
- },
592
- body: projectIds,
593
- })
594
- .then(this.getClientInstance().responseHandler({
595
- 204: {
596
- "application/json": "json",
597
- },
598
- }))
599
- .then(commonHttpClient.castResponse())
600
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.removeCustomFieldContextFromProjects.response"))
601
- .then(commonHttpClient.getBody);
602
- }
603
- /**
604
- * Removes issue types from a custom field context.
605
- *
606
- * A custom field context without any issue types applies to all issue types.
607
- *
608
- * **[Permissions](#permissions) required:** *Administer Jira* [global
609
- * permission](https://confluence.atlassian.com/x/x4dKLg).
610
- *
611
- * @returns Returned if operation is successful.
612
- * @path {POST} /rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove
613
- * @scopes-current manage:jira-configuration
614
- * @scopes-beta write:field:jira
615
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-contextid-issuetype-remove-post
616
- */
617
- removeIssueTypesFromContext({ fieldId, contextId, issueTypeIds, }) {
618
- return this.getClientInstance()
619
- .request({
620
- path: "/rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove",
621
- method: "POST",
622
- pathParams: {
623
- fieldId,
624
- contextId,
625
- },
626
- headers: {
627
- "Content-Type": "application/json",
628
- },
629
- body: issueTypeIds,
630
- })
631
- .then(this.getClientInstance().responseHandler({
632
- 204: {
633
- "application/json": "json",
634
- },
635
- }))
636
- .then(commonHttpClient.castResponse())
637
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.removeIssueTypesFromContext.response"))
638
- .then(commonHttpClient.getBody);
639
- }
640
- /**
641
- * Sets default for contexts of a custom field. Default are defined using these
642
- * objects:
643
- *
644
- * * `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields.
645
- * * `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for
646
- * date-time fields.
647
- * * `CustomFieldContextDefaultValueSingleOption` (type `option.single`) for
648
- * single choice select lists and radio buttons.
649
- * * `CustomFieldContextDefaultValueMultipleOption` (type `option.multiple`) for
650
- * multiple choice select lists and checkboxes.
651
- * * `CustomFieldContextDefaultValueCascadingOption` (type `option.cascading`)
652
- * for cascading select lists.
653
- * * `CustomFieldContextSingleUserPickerDefaults` (type `single.user.select`)
654
- * for single users.
655
- * * `CustomFieldContextDefaultValueMultiUserPicker` (type `multi.user.select`)
656
- * for user lists.
657
- * * `CustomFieldContextDefaultValueSingleGroupPicker` (type
658
- * `grouppicker.single`) for single choice group pickers.
659
- * * `CustomFieldContextDefaultValueMultipleGroupPicker` (type
660
- * `grouppicker.multiple`) for multiple choice group pickers.
661
- * * `CustomFieldContextDefaultValueURL` (type `url`) for URLs.
662
- * * `CustomFieldContextDefaultValueProject` (type `project`) for project
663
- * pickers.
664
- * * `CustomFieldContextDefaultValueFloat` (type `float`) for floats
665
- * (floating-point numbers).
666
- * * `CustomFieldContextDefaultValueLabels` (type `labels`) for labels.
667
- * * `CustomFieldContextDefaultValueTextField` (type `textfield`) for text
668
- * fields.
669
- * * `CustomFieldContextDefaultValueTextArea` (type `textarea`) for text area
670
- * fields.
671
- * * `CustomFieldContextDefaultValueReadOnly` (type `readonly`) for read only
672
- * (text) fields.
673
- * * `CustomFieldContextDefaultValueMultipleVersion` (type `version.multiple`)
674
- * for single choice version pickers.
675
- * * `CustomFieldContextDefaultValueSingleVersion` (type `version.single`) for
676
- * multiple choice version pickers.
677
- *
678
- * Forge custom fields
679
- * [types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/#data-types)
680
- * are also supported, returning:
681
- *
682
- * * `CustomFieldContextDefaultValueForgeStringFieldBean` (type `forge.string`)
683
- * for Forge string fields.
684
- * * `CustomFieldContextDefaultValueForgeMultiStringFieldBean` (type
685
- * `forge.string.list`) for Forge string collection fields.
686
- * * `CustomFieldContextDefaultValueForgeObjectFieldBean` (type `forge.object`)
687
- * for Forge object fields.
688
- * * `CustomFieldContextDefaultValueForgeDateTimeFieldBean` (type
689
- * `forge.datetime`) for Forge date-time fields.
690
- * * `CustomFieldContextDefaultValueForgeGroupFieldBean` (type `forge.group`)
691
- * for Forge group fields.
692
- * * `CustomFieldContextDefaultValueForgeMultiGroupFieldBean` (type
693
- * `forge.group.list`) for Forge group collection fields.
694
- * * `CustomFieldContextDefaultValueForgeNumberFieldBean` (type `forge.number`)
695
- * for Forge number fields.
696
- * * `CustomFieldContextDefaultValueForgeUserFieldBean` (type `forge.user`) for
697
- * Forge user fields.
698
- * * `CustomFieldContextDefaultValueForgeMultiUserFieldBean` (type
699
- * `forge.user.list`) for Forge user collection fields.
700
- *
701
- * Only one type of default object can be included in a request. To remove a
702
- * default for a context, set the default parameter to `null`.
703
- *
704
- * **[Permissions](#permissions) required:** *Administer Jira* [global
705
- * permission](https://confluence.atlassian.com/x/x4dKLg).
706
- *
707
- * @returns Returned if operation is successful.
708
- * @path {PUT} /rest/api/3/field/{fieldId}/context/defaultValue
709
- * @scopes-current manage:jira-configuration
710
- * @scopes-beta write:field.default-value:jira
711
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-defaultvalue-put
712
- */
713
- setDefaultValues({ fieldId, customFieldContextDefaultValueUpdate, }) {
714
- return this.getClientInstance()
715
- .request({
716
- path: "/rest/api/3/field/{fieldId}/context/defaultValue",
717
- method: "PUT",
718
- pathParams: {
719
- fieldId,
720
- },
721
- headers: {
722
- "Content-Type": "application/json",
723
- },
724
- body: customFieldContextDefaultValueUpdate,
725
- })
726
- .then(this.getClientInstance().responseHandler({
727
- 204: {
728
- "application/json": "json",
729
- },
730
- }))
731
- .then(commonHttpClient.castResponse())
732
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.setDefaultValues.response"))
733
- .then(commonHttpClient.getBody);
734
- }
735
- /**
736
- * Updates a [ custom field
737
- * context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html).
738
- *
739
- * **[Permissions](#permissions) required:** *Administer Jira* [global
740
- * permission](https://confluence.atlassian.com/x/x4dKLg).
741
- *
742
- * @returns Returned if the context is updated.
743
- * @path {PUT} /rest/api/3/field/{fieldId}/context/{contextId}
744
- * @scopes-current manage:jira-configuration
745
- * @scopes-beta write:field:jira
746
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-contextid-put
747
- */
748
- updateCustomFieldContext({ fieldId, contextId, customFieldContextUpdateDetails, }) {
749
- return this.getClientInstance()
750
- .request({
751
- path: "/rest/api/3/field/{fieldId}/context/{contextId}",
752
- method: "PUT",
753
- pathParams: {
754
- fieldId,
755
- contextId,
756
- },
757
- headers: {
758
- "Content-Type": "application/json",
759
- },
760
- body: customFieldContextUpdateDetails,
761
- })
762
- .then(this.getClientInstance().responseHandler({
763
- 204: {
764
- "application/json": "json",
765
- },
766
- }))
767
- .then(commonHttpClient.castResponse())
768
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.updateCustomFieldContext.response"))
769
- .then(commonHttpClient.getBody);
25
+ constructor() {
26
+ super(...arguments);
27
+ /**
28
+ * Adds issue types to a custom field context, appending the issue types to the
29
+ * issue types list.
30
+ *
31
+ * A custom field context without any issue types applies to all issue types.
32
+ * Adding issue types to such a custom field context would result in it applying
33
+ * to only the listed issue types.
34
+ *
35
+ * If any of the issue types exists in the custom field context, the operation
36
+ * fails and no issue types are added.
37
+ *
38
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
39
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
40
+ *
41
+ * @returns Returned if operation is successful.
42
+ * @path {PUT} /rest/api/3/field/{fieldId}/context/{contextId}/issuetype
43
+ * @scopes-current manage:jira-configuration
44
+ * @scopes-beta write:field:jira
45
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-contextid-issuetype-put
46
+ */
47
+ this.addIssueTypesToContext = ({ fieldId, contextId, issueTypeIds, }) => {
48
+ return this.getClientInstance()
49
+ .request({
50
+ path: "/rest/api/3/field/{fieldId}/context/{contextId}/issuetype",
51
+ method: "PUT",
52
+ pathParams: {
53
+ fieldId,
54
+ contextId,
55
+ },
56
+ headers: {
57
+ "Content-Type": "application/json",
58
+ },
59
+ body: issueTypeIds,
60
+ })
61
+ .then(this.getClientInstance().responseHandler({
62
+ 204: {
63
+ "application/json": "json",
64
+ },
65
+ }))
66
+ .then(commonHttpClient.castResponse())
67
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.addIssueTypesToContext.response"))
68
+ .then(commonHttpClient.getBody);
69
+ };
70
+ /**
71
+ * Assigns a custom field context to projects.
72
+ *
73
+ * If any project in the request is assigned to any context of the custom field,
74
+ * the operation fails.
75
+ *
76
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
77
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
78
+ *
79
+ * @returns Returned if operation is successful.
80
+ * @path {PUT} /rest/api/3/field/{fieldId}/context/{contextId}/project
81
+ * @scopes-current manage:jira-configuration
82
+ * @scopes-beta write:field:jira
83
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-contextid-project-put
84
+ */
85
+ this.assignProjectsToCustomFieldContext = ({ fieldId, contextId, projectIds, }) => {
86
+ return this.getClientInstance()
87
+ .request({
88
+ path: "/rest/api/3/field/{fieldId}/context/{contextId}/project",
89
+ method: "PUT",
90
+ pathParams: {
91
+ fieldId,
92
+ contextId,
93
+ },
94
+ headers: {
95
+ "Content-Type": "application/json",
96
+ },
97
+ body: projectIds,
98
+ })
99
+ .then(this.getClientInstance().responseHandler({
100
+ 204: {
101
+ "application/json": "json",
102
+ },
103
+ }))
104
+ .then(commonHttpClient.castResponse())
105
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.assignProjectsToCustomFieldContext.response"))
106
+ .then(commonHttpClient.getBody);
107
+ };
108
+ /**
109
+ * Creates a custom field context.
110
+ *
111
+ * If `projectIds` is empty, a global context is created. A global context is one
112
+ * that applies to all project. If `issueTypeIds` is empty, the context applies to
113
+ * all issue types.
114
+ *
115
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
116
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
117
+ *
118
+ * @returns Returned if the custom field context is created.
119
+ *
120
+ * example: {
121
+ * "id": "10025",
122
+ * "name": "Bug fields context",
123
+ * "description": "A context used to define the custom field options for bugs.",
124
+ * "projectIds": [],
125
+ * "issueTypeIds": [
126
+ * "10010"
127
+ * ]
128
+ * }
129
+ * @path {POST} /rest/api/3/field/{fieldId}/context
130
+ * @scopes-current manage:jira-configuration
131
+ * @scopes-beta read:field:jira, write:field:jira,
132
+ * read:custom-field-contextual-configuration:jira
133
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-post
134
+ */
135
+ this.createCustomFieldContext = ({ fieldId, createCustomFieldContext, }) => {
136
+ return this.getClientInstance()
137
+ .request({
138
+ path: "/rest/api/3/field/{fieldId}/context",
139
+ method: "POST",
140
+ pathParams: {
141
+ fieldId,
142
+ },
143
+ headers: {
144
+ "Content-Type": "application/json",
145
+ },
146
+ body: createCustomFieldContext,
147
+ })
148
+ .then(this.getClientInstance().responseHandler({
149
+ 201: {
150
+ "application/json": "json",
151
+ },
152
+ }))
153
+ .then(commonHttpClient.castResponse())
154
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.createCustomFieldContext.response"))
155
+ .then(commonHttpClient.getBody);
156
+ };
157
+ /**
158
+ * Deletes a [ custom field
159
+ * context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html).
160
+ *
161
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
162
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
163
+ *
164
+ * @returns Returned if the context is deleted.
165
+ * @path {DELETE} /rest/api/3/field/{fieldId}/context/{contextId}
166
+ * @scopes-current manage:jira-configuration
167
+ * @scopes-beta delete:field:jira
168
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-contextid-delete
169
+ */
170
+ this.deleteCustomFieldContext = ({ fieldId, contextId, }) => {
171
+ return this.getClientInstance()
172
+ .request({
173
+ path: "/rest/api/3/field/{fieldId}/context/{contextId}",
174
+ method: "DELETE",
175
+ pathParams: {
176
+ fieldId,
177
+ contextId,
178
+ },
179
+ })
180
+ .then(this.getClientInstance().responseHandler({
181
+ 204: {
182
+ "application/json": "json",
183
+ },
184
+ }))
185
+ .then(commonHttpClient.castResponse())
186
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.deleteCustomFieldContext.response"))
187
+ .then(commonHttpClient.getBody);
188
+ };
189
+ /**
190
+ * Returns a [paginated](#pagination) list of [
191
+ * contexts](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html)
192
+ * for a custom field. Contexts can be returned as follows:
193
+ *
194
+ * * With no other parameters set, all contexts.
195
+ * * By defining `id` only, all contexts from the list of IDs.
196
+ * * By defining `isAnyIssueType`, limit the list of contexts returned to either
197
+ * those that apply to all issue types (true) or those that apply to only a subset
198
+ * of issue types (false)
199
+ * * By defining `isGlobalContext`, limit the list of contexts return to either
200
+ * those that apply to all projects (global contexts) (true) or those that apply
201
+ * to only a subset of projects (false).
202
+ *
203
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
204
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
205
+ *
206
+ * @returns Returned if the request is successful.
207
+ *
208
+ * example: {
209
+ * "isLast": true,
210
+ * "maxResults": 100,
211
+ * "startAt": 0,
212
+ * "total": 2,
213
+ * "values": [
214
+ * {
215
+ * "id": "10025",
216
+ * "name": "Bug fields context",
217
+ * "description": "A context used to define the custom field options for
218
+ * bugs.",
219
+ * "isGlobalContext": true,
220
+ * "isAnyIssueType": false
221
+ * },
222
+ * {
223
+ * "id": "10026",
224
+ * "name": "Task fields context",
225
+ * "description": "A context used to define the custom field options for
226
+ * tasks.",
227
+ * "isGlobalContext": false,
228
+ * "isAnyIssueType": false
229
+ * }
230
+ * ]
231
+ * }
232
+ * @path {GET} /rest/api/3/field/{fieldId}/context
233
+ * @scopes-current manage:jira-configuration
234
+ * @scopes-beta read:field:jira, read:custom-field-contextual-configuration:jira
235
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-get
236
+ */
237
+ this.getContextsForField = ({ fieldId, isAnyIssueType, isGlobalContext, contextId, startAt, maxResults, }) => {
238
+ return this.getClientInstance()
239
+ .request({
240
+ path: "/rest/api/3/field/{fieldId}/context",
241
+ method: "GET",
242
+ pathParams: {
243
+ fieldId,
244
+ },
245
+ query: {
246
+ isAnyIssueType,
247
+ isGlobalContext,
248
+ contextId,
249
+ startAt,
250
+ maxResults,
251
+ },
252
+ })
253
+ .then(this.getClientInstance().responseHandler({
254
+ 200: {
255
+ "application/json": "json",
256
+ },
257
+ }))
258
+ .then(commonHttpClient.castResponse())
259
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.getContextsForField.response"))
260
+ .then(commonHttpClient.getBody);
261
+ };
262
+ /**
263
+ * Returns a [paginated](#pagination) list of project and issue type mappings and,
264
+ * for each mapping, the ID of a [custom field
265
+ * context](https://confluence.atlassian.com/x/k44fOw) that applies to the project
266
+ * and issue type.
267
+ *
268
+ * If there is no custom field context assigned to the project then, if present,
269
+ * the custom field context that applies to all projects is returned if it also
270
+ * applies to the issue type or all issue types. If a custom field context is not
271
+ * found, the returned custom field context ID is `null`.
272
+ *
273
+ * Duplicate project and issue type mappings cannot be provided in the request.
274
+ *
275
+ * The order of the returned values is the same as provided in the request.
276
+ *
277
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
278
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
279
+ *
280
+ * @returns Returned if the request is successful.
281
+ *
282
+ * example: {
283
+ * "isLast": true,
284
+ * "maxResults": 50,
285
+ * "startAt": 0,
286
+ * "total": 3,
287
+ * "values": [
288
+ * {
289
+ * "projectId": "10000",
290
+ * "issueTypeId": "10000",
291
+ * "contextId": "10000"
292
+ * },
293
+ * {
294
+ * "projectId": "10000",
295
+ * "issueTypeId": "10001",
296
+ * "contextId": null
297
+ * },
298
+ * {
299
+ * "projectId": "10001",
300
+ * "issueTypeId": "10002",
301
+ * "contextId": "10003"
302
+ * }
303
+ * ]
304
+ * }
305
+ * @path {POST} /rest/api/3/field/{fieldId}/context/mapping
306
+ * @scopes-current manage:jira-configuration
307
+ * @scopes-beta read:field:jira
308
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-mapping-post
309
+ */
310
+ this.getCustomFieldContextsForProjectsAndIssueTypes = ({ fieldId, startAt, maxResults, projectIssueTypeMappings, }) => {
311
+ return this.getClientInstance()
312
+ .request({
313
+ path: "/rest/api/3/field/{fieldId}/context/mapping",
314
+ method: "POST",
315
+ pathParams: {
316
+ fieldId,
317
+ },
318
+ query: {
319
+ startAt,
320
+ maxResults,
321
+ },
322
+ headers: {
323
+ "Content-Type": "application/json",
324
+ },
325
+ body: projectIssueTypeMappings,
326
+ })
327
+ .then(this.getClientInstance().responseHandler({
328
+ 200: {
329
+ "application/json": "json",
330
+ },
331
+ }))
332
+ .then(commonHttpClient.castResponse())
333
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.getCustomFieldContextsForProjectsAndIssueTypes.response"))
334
+ .then(commonHttpClient.getBody);
335
+ };
336
+ /**
337
+ * Returns a [paginated](#pagination) list of defaults for a custom field. The
338
+ * results can be filtered by `contextId`, otherwise all values are returned. If
339
+ * no defaults are set for a context, nothing is returned.
340
+ * The returned object depends on type of the custom field:
341
+ *
342
+ * * `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields.
343
+ * * `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for
344
+ * date-time fields.
345
+ * * `CustomFieldContextDefaultValueSingleOption` (type `option.single`) for
346
+ * single choice select lists and radio buttons.
347
+ * * `CustomFieldContextDefaultValueMultipleOption` (type `option.multiple`) for
348
+ * multiple choice select lists and checkboxes.
349
+ * * `CustomFieldContextDefaultValueCascadingOption` (type `option.cascading`)
350
+ * for cascading select lists.
351
+ * * `CustomFieldContextSingleUserPickerDefaults` (type `single.user.select`)
352
+ * for single users.
353
+ * * `CustomFieldContextDefaultValueMultiUserPicker` (type `multi.user.select`)
354
+ * for user lists.
355
+ * * `CustomFieldContextDefaultValueSingleGroupPicker` (type
356
+ * `grouppicker.single`) for single choice group pickers.
357
+ * * `CustomFieldContextDefaultValueMultipleGroupPicker` (type
358
+ * `grouppicker.multiple`) for multiple choice group pickers.
359
+ * * `CustomFieldContextDefaultValueURL` (type `url`) for URLs.
360
+ * * `CustomFieldContextDefaultValueProject` (type `project`) for project
361
+ * pickers.
362
+ * * `CustomFieldContextDefaultValueFloat` (type `float`) for floats
363
+ * (floating-point numbers).
364
+ * * `CustomFieldContextDefaultValueLabels` (type `labels`) for labels.
365
+ * * `CustomFieldContextDefaultValueTextField` (type `textfield`) for text
366
+ * fields.
367
+ * * `CustomFieldContextDefaultValueTextArea` (type `textarea`) for text area
368
+ * fields.
369
+ * * `CustomFieldContextDefaultValueReadOnly` (type `readonly`) for read only
370
+ * (text) fields.
371
+ * * `CustomFieldContextDefaultValueMultipleVersion` (type `version.multiple`)
372
+ * for single choice version pickers.
373
+ * * `CustomFieldContextDefaultValueSingleVersion` (type `version.single`) for
374
+ * multiple choice version pickers.
375
+ *
376
+ * Forge custom fields
377
+ * [types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/#data-types)
378
+ * are also supported, returning:
379
+ *
380
+ * * `CustomFieldContextDefaultValueForgeStringFieldBean` (type `forge.string`)
381
+ * for Forge string fields.
382
+ * * `CustomFieldContextDefaultValueForgeMultiStringFieldBean` (type
383
+ * `forge.string.list`) for Forge string collection fields.
384
+ * * `CustomFieldContextDefaultValueForgeObjectFieldBean` (type `forge.object`)
385
+ * for Forge object fields.
386
+ * * `CustomFieldContextDefaultValueForgeDateTimeFieldBean` (type
387
+ * `forge.datetime`) for Forge date-time fields.
388
+ * * `CustomFieldContextDefaultValueForgeGroupFieldBean` (type `forge.group`)
389
+ * for Forge group fields.
390
+ * * `CustomFieldContextDefaultValueForgeMultiGroupFieldBean` (type
391
+ * `forge.group.list`) for Forge group collection fields.
392
+ * * `CustomFieldContextDefaultValueForgeNumberFieldBean` (type `forge.number`)
393
+ * for Forge number fields.
394
+ * * `CustomFieldContextDefaultValueForgeUserFieldBean` (type `forge.user`) for
395
+ * Forge user fields.
396
+ * * `CustomFieldContextDefaultValueForgeMultiUserFieldBean` (type
397
+ * `forge.user.list`) for Forge user collection fields.
398
+ *
399
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
400
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
401
+ *
402
+ * @returns Returned if the request is successful.
403
+ *
404
+ * example: {
405
+ * "isLast": true,
406
+ * "maxResults": 50,
407
+ * "startAt": 0,
408
+ * "total": 3,
409
+ * "values": [
410
+ * {
411
+ * "contextId": "10100",
412
+ * "optionId": "10001"
413
+ * },
414
+ * {
415
+ * "contextId": "10101",
416
+ * "optionId": "10003"
417
+ * },
418
+ * {
419
+ * "contextId": "10103"
420
+ * }
421
+ * ]
422
+ * }
423
+ * @path {GET} /rest/api/3/field/{fieldId}/context/defaultValue
424
+ * @scopes-current manage:jira-configuration
425
+ * @scopes-beta read:field.default-value:jira
426
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-defaultvalue-get
427
+ */
428
+ this.getDefaultValues = ({ fieldId, contextId, startAt, maxResults, }) => {
429
+ return this.getClientInstance()
430
+ .request({
431
+ path: "/rest/api/3/field/{fieldId}/context/defaultValue",
432
+ method: "GET",
433
+ pathParams: {
434
+ fieldId,
435
+ },
436
+ query: {
437
+ contextId,
438
+ startAt,
439
+ maxResults,
440
+ },
441
+ })
442
+ .then(this.getClientInstance().responseHandler({
443
+ 200: {
444
+ "application/json": "json",
445
+ },
446
+ }))
447
+ .then(commonHttpClient.castResponse())
448
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.getDefaultValues.response"))
449
+ .then(commonHttpClient.getBody);
450
+ };
451
+ /**
452
+ * Returns a [paginated](#pagination) list of context to issue type mappings for a
453
+ * custom field. Mappings are returned for all contexts or a list of contexts.
454
+ * Mappings are ordered first by context ID and then by issue type ID.
455
+ *
456
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
457
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
458
+ *
459
+ * @returns Returned if operation is successful.
460
+ *
461
+ * example: {
462
+ * "isLast": true,
463
+ * "maxResults": 100,
464
+ * "startAt": 0,
465
+ * "total": 3,
466
+ * "values": [
467
+ * {
468
+ * "contextId": "10001",
469
+ * "issueTypeId": "10010"
470
+ * },
471
+ * {
472
+ * "contextId": "10001",
473
+ * "issueTypeId": "10011"
474
+ * },
475
+ * {
476
+ * "contextId": "10002",
477
+ * "isAnyIssueType": true
478
+ * }
479
+ * ]
480
+ * }
481
+ * @path {GET} /rest/api/3/field/{fieldId}/context/issuetypemapping
482
+ * @scopes-current manage:jira-configuration
483
+ * @scopes-beta read:field:jira
484
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-issuetypemapping-get
485
+ */
486
+ this.getIssueTypeMappingsForContexts = ({ fieldId, contextId, startAt, maxResults, }) => {
487
+ return this.getClientInstance()
488
+ .request({
489
+ path: "/rest/api/3/field/{fieldId}/context/issuetypemapping",
490
+ method: "GET",
491
+ pathParams: {
492
+ fieldId,
493
+ },
494
+ query: {
495
+ contextId,
496
+ startAt,
497
+ maxResults,
498
+ },
499
+ })
500
+ .then(this.getClientInstance().responseHandler({
501
+ 200: {
502
+ "application/json": "json",
503
+ },
504
+ }))
505
+ .then(commonHttpClient.castResponse())
506
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.getIssueTypeMappingsForContexts.response"))
507
+ .then(commonHttpClient.getBody);
508
+ };
509
+ /**
510
+ * Returns a [paginated](#pagination) list of context to project mappings for a
511
+ * custom field. The result can be filtered by `contextId`. Otherwise, all
512
+ * mappings are returned. Invalid IDs are ignored.
513
+ *
514
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
515
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
516
+ *
517
+ * @returns Returned if the request is successful.
518
+ *
519
+ * example: {
520
+ * "isLast": true,
521
+ * "maxResults": 100,
522
+ * "startAt": 0,
523
+ * "total": 2,
524
+ * "values": [
525
+ * {
526
+ * "contextId": "10025",
527
+ * "projectId": "10001"
528
+ * },
529
+ * {
530
+ * "contextId": "10026",
531
+ * "isGlobalContext": true
532
+ * }
533
+ * ]
534
+ * }
535
+ * @path {GET} /rest/api/3/field/{fieldId}/context/projectmapping
536
+ * @scopes-current manage:jira-configuration
537
+ * @scopes-beta read:field:jira
538
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-projectmapping-get
539
+ */
540
+ this.getProjectContextMapping = ({ fieldId, contextId, startAt, maxResults, }) => {
541
+ return this.getClientInstance()
542
+ .request({
543
+ path: "/rest/api/3/field/{fieldId}/context/projectmapping",
544
+ method: "GET",
545
+ pathParams: {
546
+ fieldId,
547
+ },
548
+ query: {
549
+ contextId,
550
+ startAt,
551
+ maxResults,
552
+ },
553
+ })
554
+ .then(this.getClientInstance().responseHandler({
555
+ 200: {
556
+ "application/json": "json",
557
+ },
558
+ }))
559
+ .then(commonHttpClient.castResponse())
560
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.getProjectContextMapping.response"))
561
+ .then(commonHttpClient.getBody);
562
+ };
563
+ /**
564
+ * Removes a custom field context from projects.
565
+ *
566
+ * A custom field context without any projects applies to all projects. Removing
567
+ * all projects from a custom field context would result in it applying to all
568
+ * projects.
569
+ *
570
+ * If any project in the request is not assigned to the context, or the operation
571
+ * would result in two global contexts for the field, the operation fails.
572
+ *
573
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
574
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
575
+ *
576
+ * @returns Returned if the custom field context is removed from the projects.
577
+ * @path {POST} /rest/api/3/field/{fieldId}/context/{contextId}/project/remove
578
+ * @scopes-current manage:jira-configuration
579
+ * @scopes-beta write:field:jira
580
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-contextid-project-remove-post
581
+ */
582
+ this.removeCustomFieldContextFromProjects = ({ fieldId, contextId, projectIds, }) => {
583
+ return this.getClientInstance()
584
+ .request({
585
+ path: "/rest/api/3/field/{fieldId}/context/{contextId}/project/remove",
586
+ method: "POST",
587
+ pathParams: {
588
+ fieldId,
589
+ contextId,
590
+ },
591
+ headers: {
592
+ "Content-Type": "application/json",
593
+ },
594
+ body: projectIds,
595
+ })
596
+ .then(this.getClientInstance().responseHandler({
597
+ 204: {
598
+ "application/json": "json",
599
+ },
600
+ }))
601
+ .then(commonHttpClient.castResponse())
602
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.removeCustomFieldContextFromProjects.response"))
603
+ .then(commonHttpClient.getBody);
604
+ };
605
+ /**
606
+ * Removes issue types from a custom field context.
607
+ *
608
+ * A custom field context without any issue types applies to all issue types.
609
+ *
610
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
611
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
612
+ *
613
+ * @returns Returned if operation is successful.
614
+ * @path {POST} /rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove
615
+ * @scopes-current manage:jira-configuration
616
+ * @scopes-beta write:field:jira
617
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-contextid-issuetype-remove-post
618
+ */
619
+ this.removeIssueTypesFromContext = ({ fieldId, contextId, issueTypeIds, }) => {
620
+ return this.getClientInstance()
621
+ .request({
622
+ path: "/rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove",
623
+ method: "POST",
624
+ pathParams: {
625
+ fieldId,
626
+ contextId,
627
+ },
628
+ headers: {
629
+ "Content-Type": "application/json",
630
+ },
631
+ body: issueTypeIds,
632
+ })
633
+ .then(this.getClientInstance().responseHandler({
634
+ 204: {
635
+ "application/json": "json",
636
+ },
637
+ }))
638
+ .then(commonHttpClient.castResponse())
639
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.removeIssueTypesFromContext.response"))
640
+ .then(commonHttpClient.getBody);
641
+ };
642
+ /**
643
+ * Sets default for contexts of a custom field. Default are defined using these
644
+ * objects:
645
+ *
646
+ * * `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields.
647
+ * * `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for
648
+ * date-time fields.
649
+ * * `CustomFieldContextDefaultValueSingleOption` (type `option.single`) for
650
+ * single choice select lists and radio buttons.
651
+ * * `CustomFieldContextDefaultValueMultipleOption` (type `option.multiple`) for
652
+ * multiple choice select lists and checkboxes.
653
+ * * `CustomFieldContextDefaultValueCascadingOption` (type `option.cascading`)
654
+ * for cascading select lists.
655
+ * * `CustomFieldContextSingleUserPickerDefaults` (type `single.user.select`)
656
+ * for single users.
657
+ * * `CustomFieldContextDefaultValueMultiUserPicker` (type `multi.user.select`)
658
+ * for user lists.
659
+ * * `CustomFieldContextDefaultValueSingleGroupPicker` (type
660
+ * `grouppicker.single`) for single choice group pickers.
661
+ * * `CustomFieldContextDefaultValueMultipleGroupPicker` (type
662
+ * `grouppicker.multiple`) for multiple choice group pickers.
663
+ * * `CustomFieldContextDefaultValueURL` (type `url`) for URLs.
664
+ * * `CustomFieldContextDefaultValueProject` (type `project`) for project
665
+ * pickers.
666
+ * * `CustomFieldContextDefaultValueFloat` (type `float`) for floats
667
+ * (floating-point numbers).
668
+ * * `CustomFieldContextDefaultValueLabels` (type `labels`) for labels.
669
+ * * `CustomFieldContextDefaultValueTextField` (type `textfield`) for text
670
+ * fields.
671
+ * * `CustomFieldContextDefaultValueTextArea` (type `textarea`) for text area
672
+ * fields.
673
+ * * `CustomFieldContextDefaultValueReadOnly` (type `readonly`) for read only
674
+ * (text) fields.
675
+ * * `CustomFieldContextDefaultValueMultipleVersion` (type `version.multiple`)
676
+ * for single choice version pickers.
677
+ * * `CustomFieldContextDefaultValueSingleVersion` (type `version.single`) for
678
+ * multiple choice version pickers.
679
+ *
680
+ * Forge custom fields
681
+ * [types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/#data-types)
682
+ * are also supported, returning:
683
+ *
684
+ * * `CustomFieldContextDefaultValueForgeStringFieldBean` (type `forge.string`)
685
+ * for Forge string fields.
686
+ * * `CustomFieldContextDefaultValueForgeMultiStringFieldBean` (type
687
+ * `forge.string.list`) for Forge string collection fields.
688
+ * * `CustomFieldContextDefaultValueForgeObjectFieldBean` (type `forge.object`)
689
+ * for Forge object fields.
690
+ * * `CustomFieldContextDefaultValueForgeDateTimeFieldBean` (type
691
+ * `forge.datetime`) for Forge date-time fields.
692
+ * * `CustomFieldContextDefaultValueForgeGroupFieldBean` (type `forge.group`)
693
+ * for Forge group fields.
694
+ * * `CustomFieldContextDefaultValueForgeMultiGroupFieldBean` (type
695
+ * `forge.group.list`) for Forge group collection fields.
696
+ * * `CustomFieldContextDefaultValueForgeNumberFieldBean` (type `forge.number`)
697
+ * for Forge number fields.
698
+ * * `CustomFieldContextDefaultValueForgeUserFieldBean` (type `forge.user`) for
699
+ * Forge user fields.
700
+ * * `CustomFieldContextDefaultValueForgeMultiUserFieldBean` (type
701
+ * `forge.user.list`) for Forge user collection fields.
702
+ *
703
+ * Only one type of default object can be included in a request. To remove a
704
+ * default for a context, set the default parameter to `null`.
705
+ *
706
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
707
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
708
+ *
709
+ * @returns Returned if operation is successful.
710
+ * @path {PUT} /rest/api/3/field/{fieldId}/context/defaultValue
711
+ * @scopes-current manage:jira-configuration
712
+ * @scopes-beta write:field.default-value:jira
713
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-defaultvalue-put
714
+ */
715
+ this.setDefaultValues = ({ fieldId, customFieldContextDefaultValueUpdate, }) => {
716
+ return this.getClientInstance()
717
+ .request({
718
+ path: "/rest/api/3/field/{fieldId}/context/defaultValue",
719
+ method: "PUT",
720
+ pathParams: {
721
+ fieldId,
722
+ },
723
+ headers: {
724
+ "Content-Type": "application/json",
725
+ },
726
+ body: customFieldContextDefaultValueUpdate,
727
+ })
728
+ .then(this.getClientInstance().responseHandler({
729
+ 204: {
730
+ "application/json": "json",
731
+ },
732
+ }))
733
+ .then(commonHttpClient.castResponse())
734
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.setDefaultValues.response"))
735
+ .then(commonHttpClient.getBody);
736
+ };
737
+ /**
738
+ * Updates a [ custom field
739
+ * context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html).
740
+ *
741
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
742
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
743
+ *
744
+ * @returns Returned if the context is updated.
745
+ * @path {PUT} /rest/api/3/field/{fieldId}/context/{contextId}
746
+ * @scopes-current manage:jira-configuration
747
+ * @scopes-beta write:field:jira
748
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts#api-rest-api-3-field-fieldid-context-contextid-put
749
+ */
750
+ this.updateCustomFieldContext = ({ fieldId, contextId, customFieldContextUpdateDetails, }) => {
751
+ return this.getClientInstance()
752
+ .request({
753
+ path: "/rest/api/3/field/{fieldId}/context/{contextId}",
754
+ method: "PUT",
755
+ pathParams: {
756
+ fieldId,
757
+ contextId,
758
+ },
759
+ headers: {
760
+ "Content-Type": "application/json",
761
+ },
762
+ body: customFieldContextUpdateDetails,
763
+ })
764
+ .then(this.getClientInstance().responseHandler({
765
+ 204: {
766
+ "application/json": "json",
767
+ },
768
+ }))
769
+ .then(commonHttpClient.castResponse())
770
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueCustomFieldContextsService.updateCustomFieldContext.response"))
771
+ .then(commonHttpClient.getBody);
772
+ };
770
773
  }
771
774
  static initialize() {
772
775
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("IssueCustomFieldContextsService.getContextsForField.response", zod_1.z