@resolution/jira-api-client 0.5.2 → 0.5.4

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 (515) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/README.md +51 -19
  3. package/lib/openapi/{platform/core → core}/CommonHttpClient.d.ts +54 -3
  4. package/lib/openapi/{serviceManagement/core → core}/CommonHttpClient.js +14 -0
  5. package/lib/openapi/core/CommonHttpClient.js.map +1 -0
  6. package/lib/openapi/{software/core → core}/CommonHttpService.d.ts +17 -0
  7. package/lib/openapi/{platform/core → core}/CommonHttpService.js +11 -0
  8. package/lib/openapi/core/CommonHttpService.js.map +1 -0
  9. package/lib/openapi/core/CommonValidationSchemaStorage.js.map +1 -0
  10. package/lib/openapi/platform/BaseJiraPlatformApiClient.d.ts +5 -5
  11. package/lib/openapi/platform/BaseJiraPlatformApiClient.js +3 -3
  12. package/lib/openapi/platform/BaseJiraPlatformApiClient.js.map +1 -1
  13. package/lib/openapi/platform/models/announcementBanner.d.ts +1 -1
  14. package/lib/openapi/platform/models/appDataPolicies.d.ts +1 -1
  15. package/lib/openapi/platform/models/appMigration.d.ts +13 -7
  16. package/lib/openapi/platform/models/appMigration.js.map +1 -1
  17. package/lib/openapi/platform/models/appProperties.d.ts +3 -2
  18. package/lib/openapi/platform/models/appProperties.js.map +1 -1
  19. package/lib/openapi/platform/models/auditRecords.d.ts +1 -1
  20. package/lib/openapi/platform/models/avatars.d.ts +1 -1
  21. package/lib/openapi/platform/models/classificationLevels.d.ts +1 -1
  22. package/lib/openapi/platform/models/common.d.ts +3 -5
  23. package/lib/openapi/platform/models/common.js.map +1 -1
  24. package/lib/openapi/platform/models/dashboards.d.ts +2 -3
  25. package/lib/openapi/platform/models/dashboards.js.map +1 -1
  26. package/lib/openapi/platform/models/dynamicModules.d.ts +5 -3
  27. package/lib/openapi/platform/models/dynamicModules.js.map +1 -1
  28. package/lib/openapi/platform/models/filterSharing.d.ts +1 -1
  29. package/lib/openapi/platform/models/filters.d.ts +1 -1
  30. package/lib/openapi/platform/models/groupAndUserPicker.d.ts +1 -1
  31. package/lib/openapi/platform/models/groups.d.ts +1 -1
  32. package/lib/openapi/platform/models/issueAttachments.d.ts +1 -1
  33. package/lib/openapi/platform/models/issueBulkOperations.d.ts +2 -3
  34. package/lib/openapi/platform/models/issueBulkOperations.js.map +1 -1
  35. package/lib/openapi/platform/models/issueCommentProperties.d.ts +1 -1
  36. package/lib/openapi/platform/models/issueComments.d.ts +1 -1
  37. package/lib/openapi/platform/models/issueCustomFieldConfigurationApps.d.ts +1 -1
  38. package/lib/openapi/platform/models/issueCustomFieldContexts.d.ts +1 -1
  39. package/lib/openapi/platform/models/issueCustomFieldOptions.d.ts +1 -1
  40. package/lib/openapi/platform/models/issueCustomFieldOptionsApps.d.ts +1 -1
  41. package/lib/openapi/platform/models/issueCustomFieldValuesApps.d.ts +1 -1
  42. package/lib/openapi/platform/models/issueFieldConfigurations.d.ts +1 -1
  43. package/lib/openapi/platform/models/issueFields.d.ts +1 -1
  44. package/lib/openapi/platform/models/issueLinkTypes.d.ts +1 -1
  45. package/lib/openapi/platform/models/issueLinks.d.ts +1 -1
  46. package/lib/openapi/platform/models/issueNotificationSchemes.d.ts +1 -1
  47. package/lib/openapi/platform/models/issuePriorities.d.ts +1 -1
  48. package/lib/openapi/platform/models/issueProperties.d.ts +1 -1
  49. package/lib/openapi/platform/models/issueRemoteLinks.d.ts +1 -1
  50. package/lib/openapi/platform/models/issueResolutions.d.ts +1 -1
  51. package/lib/openapi/platform/models/issueSearch.d.ts +2 -3
  52. package/lib/openapi/platform/models/issueSearch.js.map +1 -1
  53. package/lib/openapi/platform/models/issueSecurityLevel.d.ts +1 -1
  54. package/lib/openapi/platform/models/issueSecuritySchemes.d.ts +1 -1
  55. package/lib/openapi/platform/models/issueTypeSchemes.d.ts +1 -1
  56. package/lib/openapi/platform/models/issueTypeScreenSchemes.d.ts +1 -1
  57. package/lib/openapi/platform/models/issueTypes.d.ts +1 -1
  58. package/lib/openapi/platform/models/issueVotes.d.ts +1 -1
  59. package/lib/openapi/platform/models/issueWatchers.d.ts +1 -1
  60. package/lib/openapi/platform/models/issueWorklogs.d.ts +1 -1
  61. package/lib/openapi/platform/models/issues.d.ts +16 -14
  62. package/lib/openapi/platform/models/issues.js.map +1 -1
  63. package/lib/openapi/platform/models/jiraExpressions.d.ts +8 -6
  64. package/lib/openapi/platform/models/jiraExpressions.js.map +1 -1
  65. package/lib/openapi/platform/models/jiraSettings.d.ts +1 -1
  66. package/lib/openapi/platform/models/jql.d.ts +9 -5
  67. package/lib/openapi/platform/models/jql.js.map +1 -1
  68. package/lib/openapi/platform/models/jqlFunctionsApps.d.ts +1 -1
  69. package/lib/openapi/platform/models/labels.d.ts +1 -1
  70. package/lib/openapi/platform/models/licenseMetrics.d.ts +1 -1
  71. package/lib/openapi/platform/models/myself.d.ts +1 -1
  72. package/lib/openapi/platform/models/permissionSchemes.d.ts +1 -1
  73. package/lib/openapi/platform/models/permissions.d.ts +2 -3
  74. package/lib/openapi/platform/models/permissions.js.map +1 -1
  75. package/lib/openapi/platform/models/prioritySchemes.d.ts +1 -1
  76. package/lib/openapi/platform/models/projectAvatars.d.ts +1 -1
  77. package/lib/openapi/platform/models/projectClassificationLevels.d.ts +1 -1
  78. package/lib/openapi/platform/models/projectComponents.d.ts +1 -1
  79. package/lib/openapi/platform/models/projectEmail.d.ts +1 -1
  80. package/lib/openapi/platform/models/projectFeatures.d.ts +1 -1
  81. package/lib/openapi/platform/models/projectPermissionSchemes.d.ts +1 -1
  82. package/lib/openapi/platform/models/projectRoleActors.d.ts +1 -1
  83. package/lib/openapi/platform/models/projectRoles.d.ts +1 -1
  84. package/lib/openapi/platform/models/projectTypes.d.ts +1 -1
  85. package/lib/openapi/platform/models/projectVersions.d.ts +1 -1
  86. package/lib/openapi/platform/models/projects.d.ts +1 -1
  87. package/lib/openapi/platform/models/screenSchemes.d.ts +2 -2
  88. package/lib/openapi/platform/models/screenSchemes.js +1 -1
  89. package/lib/openapi/platform/models/screenSchemes.js.map +1 -1
  90. package/lib/openapi/platform/models/screenTabFields.d.ts +1 -1
  91. package/lib/openapi/platform/models/screens.d.ts +1 -1
  92. package/lib/openapi/platform/models/serverInfo.d.ts +1 -1
  93. package/lib/openapi/platform/models/serviceRegistry.d.ts +3 -2
  94. package/lib/openapi/platform/models/serviceRegistry.js.map +1 -1
  95. package/lib/openapi/platform/models/status.d.ts +1 -1
  96. package/lib/openapi/platform/models/timeTracking.d.ts +1 -1
  97. package/lib/openapi/platform/models/uiModificationsApps.d.ts +1 -1
  98. package/lib/openapi/platform/models/userSearch.d.ts +1 -1
  99. package/lib/openapi/platform/models/users.d.ts +1 -1
  100. package/lib/openapi/platform/models/webhooks.d.ts +1 -1
  101. package/lib/openapi/platform/models/workflowSchemeDrafts.d.ts +1 -1
  102. package/lib/openapi/platform/models/workflowSchemeProjectAssociations.d.ts +1 -1
  103. package/lib/openapi/platform/models/workflowSchemes.d.ts +1 -1
  104. package/lib/openapi/platform/models/workflowTransitionProperties.d.ts +1 -1
  105. package/lib/openapi/platform/models/workflowTransitionRules.d.ts +1 -1
  106. package/lib/openapi/platform/models/workflows.d.ts +104 -70
  107. package/lib/openapi/platform/models/workflows.js +12 -0
  108. package/lib/openapi/platform/models/workflows.js.map +1 -1
  109. package/lib/openapi/platform/services/AnnouncementBannerService.d.ts +12 -9
  110. package/lib/openapi/platform/services/AnnouncementBannerService.js +10 -7
  111. package/lib/openapi/platform/services/AnnouncementBannerService.js.map +1 -1
  112. package/lib/openapi/platform/services/AppDataPoliciesService.d.ts +12 -5
  113. package/lib/openapi/platform/services/AppDataPoliciesService.js +13 -6
  114. package/lib/openapi/platform/services/AppDataPoliciesService.js.map +1 -1
  115. package/lib/openapi/platform/services/AppMigrationService.d.ts +13 -6
  116. package/lib/openapi/platform/services/AppMigrationService.js +12 -6
  117. package/lib/openapi/platform/services/AppMigrationService.js.map +1 -1
  118. package/lib/openapi/platform/services/AppPropertiesService.d.ts +43 -19
  119. package/lib/openapi/platform/services/AppPropertiesService.js +44 -20
  120. package/lib/openapi/platform/services/AppPropertiesService.js.map +1 -1
  121. package/lib/openapi/platform/services/ApplicationRolesService.d.ts +20 -21
  122. package/lib/openapi/platform/services/ApplicationRolesService.js +21 -22
  123. package/lib/openapi/platform/services/ApplicationRolesService.js.map +1 -1
  124. package/lib/openapi/platform/services/AuditRecordsService.d.ts +7 -3
  125. package/lib/openapi/platform/services/AuditRecordsService.js +8 -4
  126. package/lib/openapi/platform/services/AuditRecordsService.js.map +1 -1
  127. package/lib/openapi/platform/services/AvatarsService.d.ts +45 -38
  128. package/lib/openapi/platform/services/AvatarsService.js +45 -38
  129. package/lib/openapi/platform/services/AvatarsService.js.map +1 -1
  130. package/lib/openapi/platform/services/ClassificationLevelsService.d.ts +16 -22
  131. package/lib/openapi/platform/services/ClassificationLevelsService.js +17 -23
  132. package/lib/openapi/platform/services/ClassificationLevelsService.js.map +1 -1
  133. package/lib/openapi/platform/services/DashboardsService.d.ts +140 -146
  134. package/lib/openapi/platform/services/DashboardsService.js +122 -130
  135. package/lib/openapi/platform/services/DashboardsService.js.map +1 -1
  136. package/lib/openapi/platform/services/DynamicModulesService.d.ts +6 -4
  137. package/lib/openapi/platform/services/DynamicModulesService.js +7 -5
  138. package/lib/openapi/platform/services/DynamicModulesService.js.map +1 -1
  139. package/lib/openapi/platform/services/FilterSharingService.d.ts +73 -96
  140. package/lib/openapi/platform/services/FilterSharingService.js +70 -95
  141. package/lib/openapi/platform/services/FilterSharingService.js.map +1 -1
  142. package/lib/openapi/platform/services/FiltersService.d.ts +179 -258
  143. package/lib/openapi/platform/services/FiltersService.js +174 -256
  144. package/lib/openapi/platform/services/FiltersService.js.map +1 -1
  145. package/lib/openapi/platform/services/GroupAndUserPickerService.d.ts +9 -7
  146. package/lib/openapi/platform/services/GroupAndUserPickerService.js +10 -8
  147. package/lib/openapi/platform/services/GroupAndUserPickerService.js.map +1 -1
  148. package/lib/openapi/platform/services/GroupsService.d.ts +43 -27
  149. package/lib/openapi/platform/services/GroupsService.js +40 -26
  150. package/lib/openapi/platform/services/GroupsService.js.map +1 -1
  151. package/lib/openapi/platform/services/IssueAttachmentsService.d.ts +174 -170
  152. package/lib/openapi/platform/services/IssueAttachmentsService.js +175 -171
  153. package/lib/openapi/platform/services/IssueAttachmentsService.js.map +1 -1
  154. package/lib/openapi/platform/services/IssueBulkOperationsService.d.ts +36 -20
  155. package/lib/openapi/platform/services/IssueBulkOperationsService.js +35 -20
  156. package/lib/openapi/platform/services/IssueBulkOperationsService.js.map +1 -1
  157. package/lib/openapi/platform/services/IssueCommentPropertiesService.d.ts +20 -10
  158. package/lib/openapi/platform/services/IssueCommentPropertiesService.js +21 -11
  159. package/lib/openapi/platform/services/IssueCommentPropertiesService.js.map +1 -1
  160. package/lib/openapi/platform/services/IssueCommentsService.d.ts +66 -81
  161. package/lib/openapi/platform/services/IssueCommentsService.js +59 -71
  162. package/lib/openapi/platform/services/IssueCommentsService.js.map +1 -1
  163. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.d.ts +11 -5
  164. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js +10 -5
  165. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js.map +1 -1
  166. package/lib/openapi/platform/services/IssueCustomFieldContextsService.d.ts +72 -38
  167. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js +55 -27
  168. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js.map +1 -1
  169. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.d.ts +51 -29
  170. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js +48 -28
  171. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js.map +1 -1
  172. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.d.ts +38 -17
  173. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js +33 -15
  174. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js.map +1 -1
  175. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.d.ts +9 -5
  176. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js +6 -4
  177. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js.map +1 -1
  178. package/lib/openapi/platform/services/IssueFieldConfigurationsService.d.ts +78 -35
  179. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js +63 -28
  180. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js.map +1 -1
  181. package/lib/openapi/platform/services/IssueFieldsService.d.ts +57 -47
  182. package/lib/openapi/platform/services/IssueFieldsService.js +52 -42
  183. package/lib/openapi/platform/services/IssueFieldsService.js.map +1 -1
  184. package/lib/openapi/platform/services/IssueLinkTypesService.d.ts +30 -12
  185. package/lib/openapi/platform/services/IssueLinkTypesService.js +27 -11
  186. package/lib/openapi/platform/services/IssueLinkTypesService.js.map +1 -1
  187. package/lib/openapi/platform/services/IssueLinksService.d.ts +21 -24
  188. package/lib/openapi/platform/services/IssueLinksService.js +20 -24
  189. package/lib/openapi/platform/services/IssueLinksService.js.map +1 -1
  190. package/lib/openapi/platform/services/IssueNavigatorSettingsService.d.ts +8 -4
  191. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js +9 -5
  192. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js.map +1 -1
  193. package/lib/openapi/platform/services/IssueNotificationSchemesService.d.ts +64 -70
  194. package/lib/openapi/platform/services/IssueNotificationSchemesService.js +59 -68
  195. package/lib/openapi/platform/services/IssueNotificationSchemesService.js.map +1 -1
  196. package/lib/openapi/platform/services/IssuePrioritiesService.d.ts +45 -27
  197. package/lib/openapi/platform/services/IssuePrioritiesService.js +38 -24
  198. package/lib/openapi/platform/services/IssuePrioritiesService.js.map +1 -1
  199. package/lib/openapi/platform/services/IssuePropertiesService.d.ts +34 -17
  200. package/lib/openapi/platform/services/IssuePropertiesService.js +29 -15
  201. package/lib/openapi/platform/services/IssuePropertiesService.js.map +1 -1
  202. package/lib/openapi/platform/services/IssueRemoteLinksService.d.ts +42 -28
  203. package/lib/openapi/platform/services/IssueRemoteLinksService.js +39 -27
  204. package/lib/openapi/platform/services/IssueRemoteLinksService.js.map +1 -1
  205. package/lib/openapi/platform/services/IssueResolutionsService.d.ts +40 -17
  206. package/lib/openapi/platform/services/IssueResolutionsService.js +33 -14
  207. package/lib/openapi/platform/services/IssueResolutionsService.js.map +1 -1
  208. package/lib/openapi/platform/services/IssueSearchService.d.ts +86 -139
  209. package/lib/openapi/platform/services/IssueSearchService.js +81 -137
  210. package/lib/openapi/platform/services/IssueSearchService.js.map +1 -1
  211. package/lib/openapi/platform/services/IssueSecurityLevelService.d.ts +20 -19
  212. package/lib/openapi/platform/services/IssueSecurityLevelService.js +21 -20
  213. package/lib/openapi/platform/services/IssueSecurityLevelService.js.map +1 -1
  214. package/lib/openapi/platform/services/IssueSecuritySchemesService.d.ts +78 -40
  215. package/lib/openapi/platform/services/IssueSecuritySchemesService.js +65 -34
  216. package/lib/openapi/platform/services/IssueSecuritySchemesService.js.map +1 -1
  217. package/lib/openapi/platform/services/IssueTypePropertiesService.d.ts +22 -11
  218. package/lib/openapi/platform/services/IssueTypePropertiesService.js +21 -11
  219. package/lib/openapi/platform/services/IssueTypePropertiesService.js.map +1 -1
  220. package/lib/openapi/platform/services/IssueTypeSchemesService.d.ts +53 -34
  221. package/lib/openapi/platform/services/IssueTypeSchemesService.js +42 -26
  222. package/lib/openapi/platform/services/IssueTypeSchemesService.js.map +1 -1
  223. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.d.ts +56 -27
  224. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js +45 -22
  225. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js.map +1 -1
  226. package/lib/openapi/platform/services/IssueTypesService.d.ts +53 -42
  227. package/lib/openapi/platform/services/IssueTypesService.js +50 -41
  228. package/lib/openapi/platform/services/IssueTypesService.js.map +1 -1
  229. package/lib/openapi/platform/services/IssueVotesService.d.ts +17 -17
  230. package/lib/openapi/platform/services/IssueVotesService.js +18 -18
  231. package/lib/openapi/platform/services/IssueVotesService.js.map +1 -1
  232. package/lib/openapi/platform/services/IssueWatchersService.d.ts +20 -10
  233. package/lib/openapi/platform/services/IssueWatchersService.js +19 -10
  234. package/lib/openapi/platform/services/IssueWatchersService.js.map +1 -1
  235. package/lib/openapi/platform/services/IssueWorklogPropertiesService.d.ts +20 -13
  236. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js +21 -14
  237. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js.map +1 -1
  238. package/lib/openapi/platform/services/IssueWorklogsService.d.ts +69 -67
  239. package/lib/openapi/platform/services/IssueWorklogsService.js +64 -65
  240. package/lib/openapi/platform/services/IssueWorklogsService.js.map +1 -1
  241. package/lib/openapi/platform/services/IssuesService.d.ts +226 -228
  242. package/lib/openapi/platform/services/IssuesService.js +197 -209
  243. package/lib/openapi/platform/services/IssuesService.js.map +1 -1
  244. package/lib/openapi/platform/services/JiraExpressionsService.d.ts +25 -24
  245. package/lib/openapi/platform/services/JiraExpressionsService.js +21 -20
  246. package/lib/openapi/platform/services/JiraExpressionsService.js.map +1 -1
  247. package/lib/openapi/platform/services/JiraSettingsService.d.ts +21 -9
  248. package/lib/openapi/platform/services/JiraSettingsService.js +20 -9
  249. package/lib/openapi/platform/services/JiraSettingsService.js.map +1 -1
  250. package/lib/openapi/platform/services/JqlFunctionsAppsService.d.ts +13 -9
  251. package/lib/openapi/platform/services/JqlFunctionsAppsService.js +12 -9
  252. package/lib/openapi/platform/services/JqlFunctionsAppsService.js.map +1 -1
  253. package/lib/openapi/platform/services/JqlService.d.ts +55 -43
  254. package/lib/openapi/platform/services/JqlService.js +45 -33
  255. package/lib/openapi/platform/services/JqlService.js.map +1 -1
  256. package/lib/openapi/platform/services/LabelsService.d.ts +7 -3
  257. package/lib/openapi/platform/services/LabelsService.js +8 -4
  258. package/lib/openapi/platform/services/LabelsService.js.map +1 -1
  259. package/lib/openapi/platform/services/LicenseMetricsService.d.ts +17 -7
  260. package/lib/openapi/platform/services/LicenseMetricsService.js +18 -8
  261. package/lib/openapi/platform/services/LicenseMetricsService.js.map +1 -1
  262. package/lib/openapi/platform/services/MyselfService.d.ts +28 -21
  263. package/lib/openapi/platform/services/MyselfService.js +27 -21
  264. package/lib/openapi/platform/services/MyselfService.js.map +1 -1
  265. package/lib/openapi/platform/services/PermissionSchemesService.d.ts +67 -55
  266. package/lib/openapi/platform/services/PermissionSchemesService.js +62 -53
  267. package/lib/openapi/platform/services/PermissionSchemesService.js.map +1 -1
  268. package/lib/openapi/platform/services/PermissionsService.d.ts +23 -11
  269. package/lib/openapi/platform/services/PermissionsService.js +22 -11
  270. package/lib/openapi/platform/services/PermissionsService.js.map +1 -1
  271. package/lib/openapi/platform/services/PrioritySchemesService.d.ts +60 -26
  272. package/lib/openapi/platform/services/PrioritySchemesService.js +54 -23
  273. package/lib/openapi/platform/services/PrioritySchemesService.js.map +1 -1
  274. package/lib/openapi/platform/services/ProjectAvatarsService.d.ts +27 -24
  275. package/lib/openapi/platform/services/ProjectAvatarsService.js +26 -24
  276. package/lib/openapi/platform/services/ProjectAvatarsService.js.map +1 -1
  277. package/lib/openapi/platform/services/ProjectCategoriesService.d.ts +30 -12
  278. package/lib/openapi/platform/services/ProjectCategoriesService.js +27 -11
  279. package/lib/openapi/platform/services/ProjectCategoriesService.js.map +1 -1
  280. package/lib/openapi/platform/services/ProjectClassificationLevelsService.d.ts +17 -14
  281. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js +15 -12
  282. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js.map +1 -1
  283. package/lib/openapi/platform/services/ProjectComponentsService.d.ts +198 -321
  284. package/lib/openapi/platform/services/ProjectComponentsService.js +195 -320
  285. package/lib/openapi/platform/services/ProjectComponentsService.js.map +1 -1
  286. package/lib/openapi/platform/services/ProjectEmailService.d.ts +11 -5
  287. package/lib/openapi/platform/services/ProjectEmailService.js +10 -5
  288. package/lib/openapi/platform/services/ProjectEmailService.js.map +1 -1
  289. package/lib/openapi/platform/services/ProjectFeaturesService.d.ts +23 -22
  290. package/lib/openapi/platform/services/ProjectFeaturesService.js +22 -22
  291. package/lib/openapi/platform/services/ProjectFeaturesService.js.map +1 -1
  292. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.d.ts +19 -7
  293. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js +20 -8
  294. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js.map +1 -1
  295. package/lib/openapi/platform/services/ProjectPermissionSchemesService.d.ts +32 -23
  296. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js +31 -23
  297. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js.map +1 -1
  298. package/lib/openapi/platform/services/ProjectPropertiesService.d.ts +22 -11
  299. package/lib/openapi/platform/services/ProjectPropertiesService.js +21 -11
  300. package/lib/openapi/platform/services/ProjectPropertiesService.js.map +1 -1
  301. package/lib/openapi/platform/services/ProjectRoleActorsService.d.ts +47 -33
  302. package/lib/openapi/platform/services/ProjectRoleActorsService.js +42 -31
  303. package/lib/openapi/platform/services/ProjectRoleActorsService.js.map +1 -1
  304. package/lib/openapi/platform/services/ProjectRolesService.d.ts +67 -43
  305. package/lib/openapi/platform/services/ProjectRolesService.js +62 -41
  306. package/lib/openapi/platform/services/ProjectRolesService.js.map +1 -1
  307. package/lib/openapi/platform/services/ProjectTypesService.d.ts +29 -21
  308. package/lib/openapi/platform/services/ProjectTypesService.js +30 -22
  309. package/lib/openapi/platform/services/ProjectTypesService.js.map +1 -1
  310. package/lib/openapi/platform/services/ProjectVersionsService.d.ts +87 -36
  311. package/lib/openapi/platform/services/ProjectVersionsService.js +78 -32
  312. package/lib/openapi/platform/services/ProjectVersionsService.js.map +1 -1
  313. package/lib/openapi/platform/services/ProjectsService.d.ts +207 -313
  314. package/lib/openapi/platform/services/ProjectsService.js +203 -310
  315. package/lib/openapi/platform/services/ProjectsService.js.map +1 -1
  316. package/lib/openapi/platform/services/ScreenSchemesService.d.ts +22 -11
  317. package/lib/openapi/platform/services/ScreenSchemesService.js +19 -10
  318. package/lib/openapi/platform/services/ScreenSchemesService.js.map +1 -1
  319. package/lib/openapi/platform/services/ScreenTabFieldsService.d.ts +15 -7
  320. package/lib/openapi/platform/services/ScreenTabFieldsService.js +14 -7
  321. package/lib/openapi/platform/services/ScreenTabFieldsService.js.map +1 -1
  322. package/lib/openapi/platform/services/ScreenTabsService.d.ts +27 -11
  323. package/lib/openapi/platform/services/ScreenTabsService.js +26 -11
  324. package/lib/openapi/platform/services/ScreenTabsService.js.map +1 -1
  325. package/lib/openapi/platform/services/ScreensService.d.ts +42 -28
  326. package/lib/openapi/platform/services/ScreensService.js +38 -25
  327. package/lib/openapi/platform/services/ScreensService.js.map +1 -1
  328. package/lib/openapi/platform/services/ServerInfoService.d.ts +6 -3
  329. package/lib/openapi/platform/services/ServerInfoService.js +7 -4
  330. package/lib/openapi/platform/services/ServerInfoService.js.map +1 -1
  331. package/lib/openapi/platform/services/ServiceRegistryService.d.ts +5 -3
  332. package/lib/openapi/platform/services/ServiceRegistryService.js +4 -3
  333. package/lib/openapi/platform/services/ServiceRegistryService.js.map +1 -1
  334. package/lib/openapi/platform/services/StatusService.d.ts +29 -15
  335. package/lib/openapi/platform/services/StatusService.js +26 -14
  336. package/lib/openapi/platform/services/StatusService.js.map +1 -1
  337. package/lib/openapi/platform/services/TasksService.d.ts +9 -4
  338. package/lib/openapi/platform/services/TasksService.js +10 -5
  339. package/lib/openapi/platform/services/TasksService.js.map +1 -1
  340. package/lib/openapi/platform/services/TimeTrackingService.d.ts +31 -14
  341. package/lib/openapi/platform/services/TimeTrackingService.js +27 -12
  342. package/lib/openapi/platform/services/TimeTrackingService.js.map +1 -1
  343. package/lib/openapi/platform/services/UiModificationsAppsService.d.ts +26 -19
  344. package/lib/openapi/platform/services/UiModificationsAppsService.js +23 -18
  345. package/lib/openapi/platform/services/UiModificationsAppsService.js.map +1 -1
  346. package/lib/openapi/platform/services/UserPropertiesService.d.ts +20 -10
  347. package/lib/openapi/platform/services/UserPropertiesService.js +21 -11
  348. package/lib/openapi/platform/services/UserPropertiesService.js.map +1 -1
  349. package/lib/openapi/platform/services/UserSearchService.d.ts +95 -126
  350. package/lib/openapi/platform/services/UserSearchService.js +96 -127
  351. package/lib/openapi/platform/services/UserSearchService.js.map +1 -1
  352. package/lib/openapi/platform/services/UsersService.d.ts +97 -95
  353. package/lib/openapi/platform/services/UsersService.js +96 -95
  354. package/lib/openapi/platform/services/UsersService.js.map +1 -1
  355. package/lib/openapi/platform/services/WebhooksService.d.ts +35 -18
  356. package/lib/openapi/platform/services/WebhooksService.js +30 -16
  357. package/lib/openapi/platform/services/WebhooksService.js.map +1 -1
  358. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.d.ts +133 -147
  359. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js +124 -143
  360. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js.map +1 -1
  361. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.d.ts +13 -10
  362. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js +12 -10
  363. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js.map +1 -1
  364. package/lib/openapi/platform/services/WorkflowSchemesService.d.ts +121 -82
  365. package/lib/openapi/platform/services/WorkflowSchemesService.js +106 -75
  366. package/lib/openapi/platform/services/WorkflowSchemesService.js.map +1 -1
  367. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.d.ts +12 -5
  368. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js +13 -6
  369. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js.map +1 -1
  370. package/lib/openapi/platform/services/WorkflowStatusesService.d.ts +12 -5
  371. package/lib/openapi/platform/services/WorkflowStatusesService.js +13 -6
  372. package/lib/openapi/platform/services/WorkflowStatusesService.js.map +1 -1
  373. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.d.ts +25 -10
  374. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js +22 -9
  375. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js.map +1 -1
  376. package/lib/openapi/platform/services/WorkflowTransitionRulesService.d.ts +25 -13
  377. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js +22 -12
  378. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js.map +1 -1
  379. package/lib/openapi/platform/services/WorkflowsService.d.ts +791 -693
  380. package/lib/openapi/platform/services/WorkflowsService.js +754 -644
  381. package/lib/openapi/platform/services/WorkflowsService.js.map +1 -1
  382. package/lib/openapi/platform/validationSchemaStorage.d.ts +1 -1
  383. package/lib/openapi/platform/validationSchemaStorage.js +1 -1
  384. package/lib/openapi/platform/validationSchemaStorage.js.map +1 -1
  385. package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.d.ts +3 -3
  386. package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.js +3 -3
  387. package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.js.map +1 -1
  388. package/lib/openapi/serviceManagement/models/assets.d.ts +1 -1
  389. package/lib/openapi/serviceManagement/models/common.d.ts +1 -1
  390. package/lib/openapi/serviceManagement/models/customer.d.ts +1 -1
  391. package/lib/openapi/serviceManagement/models/info.d.ts +1 -1
  392. package/lib/openapi/serviceManagement/models/knowledgebase.d.ts +1 -1
  393. package/lib/openapi/serviceManagement/models/organization.d.ts +1 -1
  394. package/lib/openapi/serviceManagement/models/request.d.ts +1 -1
  395. package/lib/openapi/serviceManagement/models/servicedesk.d.ts +4 -7
  396. package/lib/openapi/serviceManagement/models/servicedesk.js.map +1 -1
  397. package/lib/openapi/serviceManagement/services/AssetsService.d.ts +11 -8
  398. package/lib/openapi/serviceManagement/services/AssetsService.js +12 -9
  399. package/lib/openapi/serviceManagement/services/AssetsService.js.map +1 -1
  400. package/lib/openapi/serviceManagement/services/CustomerService.d.ts +17 -20
  401. package/lib/openapi/serviceManagement/services/CustomerService.js +16 -20
  402. package/lib/openapi/serviceManagement/services/CustomerService.js.map +1 -1
  403. package/lib/openapi/serviceManagement/services/InfoService.d.ts +6 -3
  404. package/lib/openapi/serviceManagement/services/InfoService.js +7 -4
  405. package/lib/openapi/serviceManagement/services/InfoService.js.map +1 -1
  406. package/lib/openapi/serviceManagement/services/KnowledgebaseService.d.ts +11 -11
  407. package/lib/openapi/serviceManagement/services/KnowledgebaseService.js +12 -12
  408. package/lib/openapi/serviceManagement/services/KnowledgebaseService.js.map +1 -1
  409. package/lib/openapi/serviceManagement/services/OrganizationService.d.ts +108 -104
  410. package/lib/openapi/serviceManagement/services/OrganizationService.js +97 -99
  411. package/lib/openapi/serviceManagement/services/OrganizationService.js.map +1 -1
  412. package/lib/openapi/serviceManagement/services/RequestService.d.ts +420 -578
  413. package/lib/openapi/serviceManagement/services/RequestService.js +405 -571
  414. package/lib/openapi/serviceManagement/services/RequestService.js.map +1 -1
  415. package/lib/openapi/serviceManagement/services/RequesttypeService.d.ts +25 -39
  416. package/lib/openapi/serviceManagement/services/RequesttypeService.js +26 -40
  417. package/lib/openapi/serviceManagement/services/RequesttypeService.js.map +1 -1
  418. package/lib/openapi/serviceManagement/services/ServicedeskService.d.ts +195 -215
  419. package/lib/openapi/serviceManagement/services/ServicedeskService.js +190 -213
  420. package/lib/openapi/serviceManagement/services/ServicedeskService.js.map +1 -1
  421. package/lib/openapi/serviceManagement/validationSchemaStorage.d.ts +1 -1
  422. package/lib/openapi/serviceManagement/validationSchemaStorage.js +1 -1
  423. package/lib/openapi/serviceManagement/validationSchemaStorage.js.map +1 -1
  424. package/lib/openapi/software/BaseJiraSoftwareApiClient.d.ts +2 -2
  425. package/lib/openapi/software/BaseJiraSoftwareApiClient.js +2 -2
  426. package/lib/openapi/software/BaseJiraSoftwareApiClient.js.map +1 -1
  427. package/lib/openapi/software/models/board.d.ts +4 -7
  428. package/lib/openapi/software/models/board.js.map +1 -1
  429. package/lib/openapi/software/models/builds.d.ts +39 -20
  430. package/lib/openapi/software/models/builds.js.map +1 -1
  431. package/lib/openapi/software/models/common.d.ts +8 -6
  432. package/lib/openapi/software/models/common.js.map +1 -1
  433. package/lib/openapi/software/models/deployments.d.ts +37 -18
  434. package/lib/openapi/software/models/deployments.js.map +1 -1
  435. package/lib/openapi/software/models/devOpsComponents.d.ts +7 -4
  436. package/lib/openapi/software/models/devOpsComponents.js.map +1 -1
  437. package/lib/openapi/software/models/developmentInformation.d.ts +107 -55
  438. package/lib/openapi/software/models/developmentInformation.js.map +1 -1
  439. package/lib/openapi/software/models/epic.d.ts +1 -1
  440. package/lib/openapi/software/models/featureFlags.d.ts +17 -9
  441. package/lib/openapi/software/models/featureFlags.js.map +1 -1
  442. package/lib/openapi/software/models/issue.d.ts +1 -1
  443. package/lib/openapi/software/models/operations.d.ts +61 -31
  444. package/lib/openapi/software/models/operations.js.map +1 -1
  445. package/lib/openapi/software/models/remoteLinks.d.ts +37 -19
  446. package/lib/openapi/software/models/remoteLinks.js.map +1 -1
  447. package/lib/openapi/software/models/securityInformation.d.ts +53 -27
  448. package/lib/openapi/software/models/securityInformation.js.map +1 -1
  449. package/lib/openapi/software/models/sprint.d.ts +1 -1
  450. package/lib/openapi/software/services/BacklogService.d.ts +14 -8
  451. package/lib/openapi/software/services/BacklogService.js +11 -7
  452. package/lib/openapi/software/services/BacklogService.js.map +1 -1
  453. package/lib/openapi/software/services/BoardService.d.ts +200 -204
  454. package/lib/openapi/software/services/BoardService.js +197 -203
  455. package/lib/openapi/software/services/BoardService.js.map +1 -1
  456. package/lib/openapi/software/services/BuildsService.d.ts +11 -9
  457. package/lib/openapi/software/services/BuildsService.js +12 -10
  458. package/lib/openapi/software/services/BuildsService.js.map +1 -1
  459. package/lib/openapi/software/services/DeploymentsService.d.ts +13 -13
  460. package/lib/openapi/software/services/DeploymentsService.js +14 -14
  461. package/lib/openapi/software/services/DeploymentsService.js.map +1 -1
  462. package/lib/openapi/software/services/DevOpsComponentsService.d.ts +33 -20
  463. package/lib/openapi/software/services/DevOpsComponentsService.js +12 -10
  464. package/lib/openapi/software/services/DevOpsComponentsService.js.map +1 -1
  465. package/lib/openapi/software/services/DevelopmentInformationService.d.ts +14 -9
  466. package/lib/openapi/software/services/DevelopmentInformationService.js +15 -10
  467. package/lib/openapi/software/services/DevelopmentInformationService.js.map +1 -1
  468. package/lib/openapi/software/services/EpicService.d.ts +67 -76
  469. package/lib/openapi/software/services/EpicService.js +60 -73
  470. package/lib/openapi/software/services/EpicService.js.map +1 -1
  471. package/lib/openapi/software/services/FeatureFlagsService.d.ts +11 -9
  472. package/lib/openapi/software/services/FeatureFlagsService.js +12 -10
  473. package/lib/openapi/software/services/FeatureFlagsService.js.map +1 -1
  474. package/lib/openapi/software/services/IssueService.d.ts +45 -44
  475. package/lib/openapi/software/services/IssueService.js +42 -43
  476. package/lib/openapi/software/services/IssueService.js.map +1 -1
  477. package/lib/openapi/software/services/OperationsService.d.ts +66 -38
  478. package/lib/openapi/software/services/OperationsService.js +23 -17
  479. package/lib/openapi/software/services/OperationsService.js.map +1 -1
  480. package/lib/openapi/software/services/RemoteLinksService.d.ts +18 -13
  481. package/lib/openapi/software/services/RemoteLinksService.js +12 -10
  482. package/lib/openapi/software/services/RemoteLinksService.js.map +1 -1
  483. package/lib/openapi/software/services/SecurityInformationService.d.ts +19 -13
  484. package/lib/openapi/software/services/SecurityInformationService.js +20 -14
  485. package/lib/openapi/software/services/SecurityInformationService.js.map +1 -1
  486. package/lib/openapi/software/services/SprintService.d.ts +79 -55
  487. package/lib/openapi/software/services/SprintService.js +70 -51
  488. package/lib/openapi/software/services/SprintService.js.map +1 -1
  489. package/lib/openapi/software/validationSchemaStorage.d.ts +1 -1
  490. package/lib/openapi/software/validationSchemaStorage.js +1 -1
  491. package/lib/openapi/software/validationSchemaStorage.js.map +1 -1
  492. package/package.json +3 -3
  493. package/lib/openapi/platform/core/CommonHttpClient.js +0 -390
  494. package/lib/openapi/platform/core/CommonHttpClient.js.map +0 -1
  495. package/lib/openapi/platform/core/CommonHttpService.d.ts +0 -9
  496. package/lib/openapi/platform/core/CommonHttpService.js.map +0 -1
  497. package/lib/openapi/platform/core/CommonValidationSchemaStorage.js.map +0 -1
  498. package/lib/openapi/serviceManagement/core/CommonHttpClient.d.ts +0 -196
  499. package/lib/openapi/serviceManagement/core/CommonHttpClient.js.map +0 -1
  500. package/lib/openapi/serviceManagement/core/CommonHttpService.d.ts +0 -9
  501. package/lib/openapi/serviceManagement/core/CommonHttpService.js +0 -29
  502. package/lib/openapi/serviceManagement/core/CommonHttpService.js.map +0 -1
  503. package/lib/openapi/serviceManagement/core/CommonValidationSchemaStorage.d.ts +0 -35
  504. package/lib/openapi/serviceManagement/core/CommonValidationSchemaStorage.js +0 -65
  505. package/lib/openapi/serviceManagement/core/CommonValidationSchemaStorage.js.map +0 -1
  506. package/lib/openapi/software/core/CommonHttpClient.d.ts +0 -196
  507. package/lib/openapi/software/core/CommonHttpClient.js +0 -390
  508. package/lib/openapi/software/core/CommonHttpClient.js.map +0 -1
  509. package/lib/openapi/software/core/CommonHttpService.js +0 -29
  510. package/lib/openapi/software/core/CommonHttpService.js.map +0 -1
  511. package/lib/openapi/software/core/CommonValidationSchemaStorage.d.ts +0 -35
  512. package/lib/openapi/software/core/CommonValidationSchemaStorage.js +0 -65
  513. package/lib/openapi/software/core/CommonValidationSchemaStorage.js.map +0 -1
  514. /package/lib/openapi/{platform/core → core}/CommonValidationSchemaStorage.d.ts +0 -0
  515. /package/lib/openapi/{platform/core → core}/CommonValidationSchemaStorage.js +0 -0
@@ -1,4 +1,4 @@
1
- import { CommonHttpService } from "../core/CommonHttpService";
1
+ import { CommonHttpService } from "../../core/CommonHttpService";
2
2
  import { type CustomerRequestCreateMetaDto, type EntityProperty, type PagedDtoArticleDto, type PagedDtoRequestTypeDto, type PagedDtoUserDto, type PropertyKeys, type RequestTypeDto, type ServiceDeskDto } from "../models/common";
3
3
  import { type MultipartFile, type PagedDtoIssueBean, type PagedDtoQueueDto, type PagedDtoRequestTypeGroupDto, type PagedDtoServiceDeskDto, type QueueDto, type RequestTypeCreateDto, type ServiceDeskCustomerDto } from "../models/servicedesk";
4
4
  /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk */
@@ -10,11 +10,11 @@ export declare class ServicedeskService extends CommonHttpService {
10
10
  *
11
11
  * **[Permissions](#permissions) required**: Service desk administrator
12
12
  *
13
- * @path {POST} /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
13
+ * @path POST `/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer`
14
14
  * @scopes-current manage:servicedesk-customer
15
- * @scopes-beta read:servicedesk.customer:jira-service-management,
16
- * write:servicedesk.customer:jira-service-management
15
+ * @scopes-beta read:servicedesk.customer:jira-service-management, write:servicedesk.customer:jira-service-management
17
16
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-customer-post
17
+ * @param params
18
18
  */
19
19
  addCustomers: ({ serviceDeskId, serviceDeskCustomerDto, }: {
20
20
  /**
@@ -23,7 +23,8 @@ export declare class ServicedeskService extends CommonHttpService {
23
23
  */
24
24
  serviceDeskId: string;
25
25
  /**
26
- * @example {
26
+ * @example
27
+ * {
27
28
  * "accountIds": [
28
29
  * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
29
30
  * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd",
@@ -61,17 +62,20 @@ export declare class ServicedeskService extends CommonHttpService {
61
62
  *
62
63
  * For example, to upload a file called `myfile.txt` in the Service Desk with ID
63
64
  * 10001 use
64
- *
65
- * curl -D- -u customer:customer -X POST -H "X-ExperimentalApi: opt-in" -H
65
+ * ```
66
+ * curl -D- -u customer:customer -X POST -H "X-ExperimentalApi: opt-in" -H
66
67
  * "X-Atlassian-Token: no-check" -F "file=@myfile.txt"
67
68
  * https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10001/attachTemporaryFile
69
+ * ```
68
70
  *
69
71
  * **[Permissions](#permissions) required**: Permission to add attachments in this
70
72
  * Service Desk.
71
73
  *
72
74
  * @returns Returns if the file(s) were attached.
73
75
  *
74
- * example: {
76
+ * example:
77
+ * ```
78
+ * {
75
79
  * "temporaryAttachments": [
76
80
  * {
77
81
  * "temporaryAttachmentId": "temp8186986881700442965",
@@ -83,11 +87,12 @@ export declare class ServicedeskService extends CommonHttpService {
83
87
  * }
84
88
  * ]
85
89
  * }
86
- * @path {POST} /rest/servicedeskapi/servicedesk/{serviceDeskId}/attachTemporaryFile
90
+ * ```
91
+ * @path POST `/rest/servicedeskapi/servicedesk/{serviceDeskId}/attachTemporaryFile`
87
92
  * @scopes-current write:servicedesk-request
88
- * @scopes-beta read:request.attachment:jira-service-management,
89
- * write:request.attachment:jira-service-management
93
+ * @scopes-beta read:request.attachment:jira-service-management, write:request.attachment:jira-service-management
90
94
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-attachtemporaryfile-post
95
+ * @param params
91
96
  */
92
97
  attachTemporaryFile: ({ serviceDeskId, multipartFiles, }: {
93
98
  /**
@@ -123,12 +128,13 @@ export declare class ServicedeskService extends CommonHttpService {
123
128
  *
124
129
  * @returns Returns the customer request type created.
125
130
  *
126
- * example: {
131
+ * example:
132
+ * ```
133
+ * {
127
134
  * "_expands": [],
128
135
  * "id": "11001",
129
136
  * "_links": {
130
- * "self":
131
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11001"
137
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11001"
132
138
  * },
133
139
  * "name": "Get IT Help",
134
140
  * "description": "Get IT Help",
@@ -143,20 +149,18 @@ export declare class ServicedeskService extends CommonHttpService {
143
149
  * "id": "12345",
144
150
  * "_links": {
145
151
  * "iconUrls": {
146
- * "48x48":
147
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=large",
148
- * "24x24":
149
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=small",
150
- * "16x16":
151
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=xsmall",
152
- * "32x32":
153
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=medium"
152
+ * "48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=large",
153
+ * "24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=small",
154
+ * "16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=xsmall",
155
+ * "32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=medium"
154
156
  * }
155
157
  * }
156
158
  * }
157
159
  * }
158
- * @path {POST} /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype
160
+ * ```
161
+ * @path POST `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype`
159
162
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-post
163
+ * @param params
160
164
  */
161
165
  createRequestType: ({ serviceDeskId, requestTypeCreateDto, }: {
162
166
  /**
@@ -165,7 +169,8 @@ export declare class ServicedeskService extends CommonHttpService {
165
169
  */
166
170
  serviceDeskId: string;
167
171
  /**
168
- * @example {
172
+ * @example
173
+ * {
169
174
  * "description": "Get IT Help",
170
175
  * "helpText": "Please tell us clearly the problem you have within 100 words.",
171
176
  * "issueTypeId": "12345",
@@ -186,12 +191,11 @@ export declare class ServicedeskService extends CommonHttpService {
186
191
  * **[Permissions](#permissions) required**: Jira project administrator with a
187
192
  * Jira Service Management agent license.
188
193
  *
189
- * @path {DELETE}
190
- * /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}
194
+ * @path DELETE `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}`
191
195
  * @scopes-current manage:jira-project
192
- * @scopes-beta read:requesttype.property:jira-service-management,
193
- * delete:requesttype.property:jira-service-management
196
+ * @scopes-beta read:requesttype.property:jira-service-management, delete:requesttype.property:jira-service-management
194
197
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-property-propertykey-delete
198
+ * @param params
195
199
  */
196
200
  deleteProperty: ({ serviceDeskId, requestTypeId, propertyKey, }: {
197
201
  /**
@@ -211,9 +215,9 @@ export declare class ServicedeskService extends CommonHttpService {
211
215
  *
212
216
  * **[Permissions](#permissions) required**: Service desk administrator.
213
217
  *
214
- * @path {DELETE}
215
- * /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}
218
+ * @path DELETE `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}`
216
219
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-delete
220
+ * @param params
217
221
  */
218
222
  deleteRequestType: ({ serviceDeskId, requestTypeId, }: {
219
223
  /** The ID or [project identifier](#project-identifiers) of the service desk. */
@@ -229,7 +233,9 @@ export declare class ServicedeskService extends CommonHttpService {
229
233
  *
230
234
  * @returns Returns the articles, on the specified page of the results.
231
235
  *
232
- * example: {
236
+ * example:
237
+ * ```
238
+ * {
233
239
  * "_expands": [],
234
240
  * "size": 2,
235
241
  * "start": 2,
@@ -238,10 +244,8 @@ export declare class ServicedeskService extends CommonHttpService {
238
244
  * "_links": {
239
245
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
240
246
  * "context": "context",
241
- * "next":
242
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/knowledgebase/article?start=4&limit=2",
243
- * "prev":
244
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/knowledgebase/article?start=0&limit=2"
247
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/knowledgebase/article?start=4&limit=2",
248
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/knowledgebase/article?start=0&limit=2"
245
249
  * },
246
250
  * "values": [
247
251
  * {
@@ -253,8 +257,7 @@ export declare class ServicedeskService extends CommonHttpService {
253
257
  * "spaceKey": "IT"
254
258
  * },
255
259
  * "content": {
256
- * "iframeSrc":
257
- * "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8786177"
260
+ * "iframeSrc": "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8786177"
258
261
  * }
259
262
  * },
260
263
  * {
@@ -266,14 +269,15 @@ export declare class ServicedeskService extends CommonHttpService {
266
269
  * "spaceKey": "IT"
267
270
  * },
268
271
  * "content": {
269
- * "iframeSrc":
270
- * "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8785228"
272
+ * "iframeSrc": "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8785228"
271
273
  * }
272
274
  * }
273
275
  * ]
274
276
  * }
275
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}/knowledgebase/article
277
+ * ```
278
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/knowledgebase/article`
276
279
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-knowledgebase-article-get
280
+ * @param params
277
281
  */
278
282
  getArticles: ({ serviceDeskId, query, highlight, start, limit, }: {
279
283
  serviceDeskId: string;
@@ -308,7 +312,9 @@ export declare class ServicedeskService extends CommonHttpService {
308
312
  *
309
313
  * @returns Returns the service desk's customer list.
310
314
  *
311
- * example: {
315
+ * example:
316
+ * ```
317
+ * {
312
318
  * "_expands": [],
313
319
  * "size": 1,
314
320
  * "start": 1,
@@ -317,15 +323,12 @@ export declare class ServicedeskService extends CommonHttpService {
317
323
  * "_links": {
318
324
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
319
325
  * "context": "context",
320
- * "next":
321
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/customer?start=2&limit=1",
322
- * "prev":
323
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/customer?start=0&limit=1"
326
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/customer?start=2&limit=1",
327
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/customer?start=0&limit=1"
324
328
  * },
325
329
  * "values": [
326
330
  * {
327
- * "accountId":
328
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
331
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
329
332
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
330
333
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
331
334
  * "emailAddress": "fred@example.com",
@@ -333,28 +336,24 @@ export declare class ServicedeskService extends CommonHttpService {
333
336
  * "active": true,
334
337
  * "timeZone": "Australia/Sydney",
335
338
  * "_links": {
336
- * "jiraRest":
337
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
339
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
338
340
  * "avatarUrls": {
339
- * "16x16":
340
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
341
- * "24x24":
342
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
343
- * "32x32":
344
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
345
- * "48x48":
346
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
341
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
342
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
343
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
344
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
347
345
  * },
348
- * "self":
349
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
346
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
350
347
  * }
351
348
  * }
352
349
  * ]
353
350
  * }
354
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
351
+ * ```
352
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer`
355
353
  * @scopes-current manage:servicedesk-customer
356
354
  * @scopes-beta read:servicedesk.customer:jira-service-management, read:user:jira
357
355
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-customer-get
356
+ * @param params
358
357
  */
359
358
  getCustomers: ({ serviceDeskId, query, start, limit, }: {
360
359
  /**
@@ -383,10 +382,11 @@ export declare class ServicedeskService extends CommonHttpService {
383
382
  *
384
383
  * **[Permissions](#permissions) required**: Service desk's agent.
385
384
  *
386
- * @returns Returns the customer requests belonging to the queue, on the specified page of
387
- * the results.
385
+ * @returns Returns the customer requests belonging to the queue, on the specified page of the results.
388
386
  *
389
- * example: {
387
+ * example:
388
+ * ```
389
+ * {
390
390
  * "_expands": [],
391
391
  * "size": 1,
392
392
  * "start": 1,
@@ -395,10 +395,8 @@ export declare class ServicedeskService extends CommonHttpService {
395
395
  * "_links": {
396
396
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
397
397
  * "context": "context",
398
- * "next":
399
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/10/issue?start=2&limit=1",
400
- * "prev":
401
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/10/issue?start=0&limit=1"
398
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/10/issue?start=2&limit=1",
399
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/10/issue?start=0&limit=1"
402
400
  * },
403
401
  * "values": [
404
402
  * {
@@ -406,10 +404,8 @@ export declare class ServicedeskService extends CommonHttpService {
406
404
  * "summary": "My keyboard is broken",
407
405
  * "issuetype": {
408
406
  * "avatarId": 10002,
409
- * "description": "For general IT problems and questions. Created by
410
- * Jira Service Management.",
411
- * "iconUrl":
412
- * "https://your-domain.atlassian.net/servicedesk/issue-type-icons?icon=it-help",
407
+ * "description": "For general IT problems and questions. Created by Jira Service Management.",
408
+ * "iconUrl": "https://your-domain.atlassian.net/servicedesk/issue-type-icons?icon=it-help",
413
409
  * "id": "13",
414
410
  * "name": "IT Help",
415
411
  * "self": "https://your-domain.atlassian.net/rest/api/2/issuetype/13",
@@ -418,45 +414,37 @@ export declare class ServicedeskService extends CommonHttpService {
418
414
  * "duedate": "2015-11-11T14:17:13.000+0700",
419
415
  * "created": "2015-11-09T14:17:13.000+0700",
420
416
  * "reporter": {
421
- * "accountId":
422
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
423
- * "name":
424
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
425
- * "key":
426
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
417
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
418
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
419
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
427
420
  * "emailAddress": "fred@example.com",
428
421
  * "displayName": "Fred F. User",
429
422
  * "active": true,
430
423
  * "timeZone": "Australia/Sydney",
431
424
  * "_links": {
432
- * "jiraRest":
433
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
425
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
434
426
  * "avatarUrls": {
435
- * "16x16":
436
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
437
- * "24x24":
438
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
439
- * "32x32":
440
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
441
- * "48x48":
442
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
427
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
428
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
429
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
430
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
443
431
  * },
444
- * "self":
445
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
432
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
446
433
  * }
447
434
  * }
448
435
  * },
449
436
  * "id": "10001",
450
437
  * "key": "SD-1",
451
- * "self":
452
- * "https://your-domain.atlassian.net/rest/servicedeskapi/rest/api/2/issue/10001"
438
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/rest/api/2/issue/10001"
453
439
  * }
454
440
  * ]
455
441
  * }
456
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}/issue
442
+ * ```
443
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}/issue`
457
444
  * @scopes-current read:jira-work
458
445
  * @scopes-beta read:queue:jira-service-management, read:user:jira, read:issue:jira
459
446
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-queue-queueid-issue-get
447
+ * @param params
460
448
  */
461
449
  getIssuesInQueue: ({ serviceDeskId, queueId, start, limit, }: {
462
450
  /**
@@ -491,20 +479,22 @@ export declare class ServicedeskService extends CommonHttpService {
491
479
  *
492
480
  * @returns Returned if the request type was found.
493
481
  *
494
- * example: {
482
+ * example:
483
+ * ```
484
+ * {
495
485
  * "entityPropertyKeyBeans": [
496
486
  * {
497
487
  * "key": "requestType.attributes",
498
- * "self":
499
- * "/rest/servicedeskapi/servicedesk/1/requestType/2/property/propertyKey"
488
+ * "self": "/rest/servicedeskapi/servicedesk/1/requestType/2/property/propertyKey"
500
489
  * }
501
490
  * ]
502
491
  * }
503
- * @path {GET}
504
- * /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property
492
+ * ```
493
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property`
505
494
  * @scopes-current read:servicedesk-request
506
495
  * @scopes-beta read:requesttype.property:jira-service-management
507
496
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-property-get
497
+ * @param params
508
498
  */
509
499
  getPropertiesKeys: ({ requestTypeId, serviceDeskId, }: {
510
500
  /** The ID of the request type for which keys will be retrieved. */
@@ -528,18 +518,21 @@ export declare class ServicedeskService extends CommonHttpService {
528
518
  *
529
519
  * @returns Returned if the request type property was returned.
530
520
  *
531
- * example: {
521
+ * example:
522
+ * ```
523
+ * {
532
524
  * "key": "organization.attributes",
533
525
  * "value": {
534
526
  * "color": "green",
535
527
  * "priority": "high"
536
528
  * }
537
529
  * }
538
- * @path {GET}
539
- * /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}
530
+ * ```
531
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}`
540
532
  * @scopes-current read:servicedesk-request
541
533
  * @scopes-beta read:requesttype.property:jira-service-management
542
534
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-property-propertykey-get
535
+ * @param params
543
536
  */
544
537
  getProperty: ({ serviceDeskId, requestTypeId, propertyKey, }: {
545
538
  /**
@@ -561,11 +554,12 @@ export declare class ServicedeskService extends CommonHttpService {
561
554
  *
562
555
  * @returns Returns the specific queue of the service desk.
563
556
  *
564
- * example: {
557
+ * example:
558
+ * ```
559
+ * {
565
560
  * "id": "20",
566
561
  * "name": "Assigned to me",
567
- * "jql": "project = SD AND assignee = currentUser() AND resolution = Unresolved
568
- * ORDER BY \"Time to resolution\" ASC",
562
+ * "jql": "project = SD AND assignee = currentUser() AND resolution = Unresolved ORDER BY \"Time to resolution\" ASC",
569
563
  * "fields": [
570
564
  * "issuetype",
571
565
  * "issuekey",
@@ -576,14 +570,15 @@ export declare class ServicedeskService extends CommonHttpService {
576
570
  * ],
577
571
  * "issueCount": 10,
578
572
  * "_links": {
579
- * "self":
580
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/20"
573
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/20"
581
574
  * }
582
575
  * }
583
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}
576
+ * ```
577
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}`
584
578
  * @scopes-current read:jira-work
585
579
  * @scopes-beta read:queue:jira-service-management, read:user:jira, read:jql:jira
586
580
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-queue-queueid-get
581
+ * @param params
587
582
  */
588
583
  getQueue: ({ serviceDeskId, queueId, includeCount, }: {
589
584
  /**
@@ -608,7 +603,9 @@ export declare class ServicedeskService extends CommonHttpService {
608
603
  *
609
604
  * @returns Returns the queues of the service desk, on the specified page of the results.
610
605
  *
611
- * example: {
606
+ * example:
607
+ * ```
608
+ * {
612
609
  * "_expands": [],
613
610
  * "size": 2,
614
611
  * "start": 2,
@@ -617,17 +614,14 @@ export declare class ServicedeskService extends CommonHttpService {
617
614
  * "_links": {
618
615
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
619
616
  * "context": "context",
620
- * "next":
621
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue?start=4&limit=2",
622
- * "prev":
623
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue?start=0&limit=2"
617
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue?start=4&limit=2",
618
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue?start=0&limit=2"
624
619
  * },
625
620
  * "values": [
626
621
  * {
627
622
  * "id": "10",
628
623
  * "name": "Unassigned issues",
629
- * "jql": "project = SD AND assignee is EMPTY AND resolution = Unresolved
630
- * ORDER BY \"Time to resolution\" ASC",
624
+ * "jql": "project = SD AND assignee is EMPTY AND resolution = Unresolved ORDER BY \"Time to resolution\" ASC",
631
625
  * "fields": [
632
626
  * "issuetype",
633
627
  * "issuekey",
@@ -638,15 +632,13 @@ export declare class ServicedeskService extends CommonHttpService {
638
632
  * ],
639
633
  * "issueCount": 10,
640
634
  * "_links": {
641
- * "self":
642
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/10"
635
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/10"
643
636
  * }
644
637
  * },
645
638
  * {
646
639
  * "id": "20",
647
640
  * "name": "Assigned to me",
648
- * "jql": "project = SD AND assignee = currentUser() AND resolution =
649
- * Unresolved ORDER BY \"Time to resolution\" ASC",
641
+ * "jql": "project = SD AND assignee = currentUser() AND resolution = Unresolved ORDER BY \"Time to resolution\" ASC",
650
642
  * "fields": [
651
643
  * "issuetype",
652
644
  * "issuekey",
@@ -657,16 +649,17 @@ export declare class ServicedeskService extends CommonHttpService {
657
649
  * ],
658
650
  * "issueCount": 10,
659
651
  * "_links": {
660
- * "self":
661
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/20"
652
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/20"
662
653
  * }
663
654
  * }
664
655
  * ]
665
656
  * }
666
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}/queue
657
+ * ```
658
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue`
667
659
  * @scopes-current read:jira-work
668
660
  * @scopes-beta read:queue:jira-service-management, read:user:jira, read:jql:jira
669
661
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-queue-get
662
+ * @param params
670
663
  */
671
664
  getQueues: ({ serviceDeskId, includeCount, start, limit, }: {
672
665
  /**
@@ -699,12 +692,13 @@ export declare class ServicedeskService extends CommonHttpService {
699
692
  *
700
693
  * @returns Returns the customer request type item.
701
694
  *
702
- * example: {
695
+ * example:
696
+ * ```
697
+ * {
703
698
  * "_expands": [],
704
699
  * "id": "11001",
705
700
  * "_links": {
706
- * "self":
707
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11001"
701
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11001"
708
702
  * },
709
703
  * "name": "Get IT Help",
710
704
  * "description": "Get IT Help",
@@ -719,23 +713,20 @@ export declare class ServicedeskService extends CommonHttpService {
719
713
  * "id": "12345",
720
714
  * "_links": {
721
715
  * "iconUrls": {
722
- * "48x48":
723
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=large",
724
- * "24x24":
725
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=small",
726
- * "16x16":
727
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=xsmall",
728
- * "32x32":
729
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=medium"
716
+ * "48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=large",
717
+ * "24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=small",
718
+ * "16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=xsmall",
719
+ * "32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=medium"
730
720
  * }
731
721
  * }
732
722
  * }
733
723
  * }
734
- * @path {GET}
735
- * /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}
724
+ * ```
725
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}`
736
726
  * @scopes-current read:servicedesk-request
737
727
  * @scopes-beta read:requesttype:jira-service-management
738
728
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-get
729
+ * @param params
739
730
  */
740
731
  getRequestTypeById: ({ serviceDeskId, requestTypeId, expand, }: {
741
732
  /**
@@ -761,10 +752,11 @@ export declare class ServicedeskService extends CommonHttpService {
761
752
  * **[Permissions](#permissions) required**: Permission to view the Service Desk.
762
753
  * However, hidden fields would be visible to only Service desk's Administrator.
763
754
  *
764
- * @returns Returns the request type's fields and user permission details, on the specified
765
- * page of the results.
755
+ * @returns Returns the request type's fields and user permission details, on the specified page of the results.
766
756
  *
767
- * example: {
757
+ * example:
758
+ * ```
759
+ * {
768
760
  * "canAddRequestParticipants": true,
769
761
  * "canRaiseOnBehalfOf": true,
770
762
  * "requestTypeFields": [
@@ -782,8 +774,7 @@ export declare class ServicedeskService extends CommonHttpService {
782
774
  * {
783
775
  * "fieldId": "customfield_10000",
784
776
  * "jiraSchema": {
785
- * "custom":
786
- * "com.atlassian.jira.plugin.system.customfieldtypes:userpicker",
777
+ * "custom": "com.atlassian.jira.plugin.system.customfieldtypes:userpicker",
787
778
  * "customId": 10000,
788
779
  * "type": "user"
789
780
  * },
@@ -795,8 +786,7 @@ export declare class ServicedeskService extends CommonHttpService {
795
786
  * {
796
787
  * "fieldId": "customfield_10001",
797
788
  * "jiraSchema": {
798
- * "custom":
799
- * "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons",
789
+ * "custom": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons",
800
790
  * "customId": 10001,
801
791
  * "type": "string"
802
792
  * },
@@ -823,11 +813,12 @@ export declare class ServicedeskService extends CommonHttpService {
823
813
  * }
824
814
  * ]
825
815
  * }
826
- * @path {GET}
827
- * /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field
816
+ * ```
817
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field`
828
818
  * @scopes-current read:servicedesk-request
829
819
  * @scopes-beta read:requesttype:jira-service-management
830
820
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-field-get
821
+ * @param params
831
822
  */
832
823
  getRequestTypeFields: ({ serviceDeskId, requestTypeId, expand, }: {
833
824
  /**
@@ -853,10 +844,11 @@ export declare class ServicedeskService extends CommonHttpService {
853
844
  *
854
845
  * **[Permissions](#permissions) required**: Permission to view the service desk.
855
846
  *
856
- * @returns Returns the service desk's customer request type groups, on the specified page
857
- * of the results.
847
+ * @returns Returns the service desk's customer request type groups, on the specified page of the results.
858
848
  *
859
- * example: {
849
+ * example:
850
+ * ```
851
+ * {
860
852
  * "_expands": [],
861
853
  * "size": 3,
862
854
  * "start": 3,
@@ -865,10 +857,8 @@ export declare class ServicedeskService extends CommonHttpService {
865
857
  * "_links": {
866
858
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
867
859
  * "context": "context",
868
- * "next":
869
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/requesttypegroup?start=6&limit=3",
870
- * "prev":
871
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/requesttypegroup?start=0&limit=3"
860
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/requesttypegroup?start=6&limit=3",
861
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/requesttypegroup?start=0&limit=3"
872
862
  * },
873
863
  * "values": [
874
864
  * {
@@ -885,10 +875,12 @@ export declare class ServicedeskService extends CommonHttpService {
885
875
  * }
886
876
  * ]
887
877
  * }
888
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttypegroup
878
+ * ```
879
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttypegroup`
889
880
  * @scopes-current read:servicedesk-request
890
881
  * @scopes-beta read:requesttype:jira-service-management
891
882
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttypegroup-get
883
+ * @param params
892
884
  */
893
885
  getRequestTypeGroups: ({ serviceDeskId, start, limit, }: {
894
886
  /**
@@ -925,10 +917,11 @@ export declare class ServicedeskService extends CommonHttpService {
925
917
  *
926
918
  * **[Permissions](#permissions) required**: Permission to access the service desk.
927
919
  *
928
- * @returns Returns the requested customer request types, on the specified page of the
929
- * results.
920
+ * @returns Returns the requested customer request types, on the specified page of the results.
930
921
  *
931
- * example: {
922
+ * example:
923
+ * ```
924
+ * {
932
925
  * "_expands": [],
933
926
  * "size": 3,
934
927
  * "start": 3,
@@ -937,23 +930,19 @@ export declare class ServicedeskService extends CommonHttpService {
937
930
  * "_links": {
938
931
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
939
932
  * "context": "context",
940
- * "next":
941
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype?start=6&limit=3",
942
- * "prev":
943
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype?start=0&limit=3"
933
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype?start=6&limit=3",
934
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype?start=0&limit=3"
944
935
  * },
945
936
  * "values": [
946
937
  * {
947
938
  * "_expands": [],
948
939
  * "id": "11001",
949
940
  * "_links": {
950
- * "self":
951
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11001"
941
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11001"
952
942
  * },
953
943
  * "name": "Get IT Help",
954
944
  * "description": "Get IT Help",
955
- * "helpText": "Please tell us clearly the problem you have within 100
956
- * words.",
945
+ * "helpText": "Please tell us clearly the problem you have within 100 words.",
957
946
  * "issueTypeId": "12345",
958
947
  * "serviceDeskId": "28",
959
948
  * "portalId": "2",
@@ -964,14 +953,10 @@ export declare class ServicedeskService extends CommonHttpService {
964
953
  * "id": "12345",
965
954
  * "_links": {
966
955
  * "iconUrls": {
967
- * "48x48":
968
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=large",
969
- * "24x24":
970
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=small",
971
- * "16x16":
972
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=xsmall",
973
- * "32x32":
974
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=medium"
956
+ * "48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=large",
957
+ * "24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=small",
958
+ * "16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=xsmall",
959
+ * "32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=medium"
975
960
  * }
976
961
  * }
977
962
  * }
@@ -980,8 +965,7 @@ export declare class ServicedeskService extends CommonHttpService {
980
965
  * "_expands": [],
981
966
  * "id": "11002",
982
967
  * "_links": {
983
- * "self":
984
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11002"
968
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11002"
985
969
  * },
986
970
  * "name": "Request a new account",
987
971
  * "description": "Request a new account",
@@ -996,14 +980,10 @@ export declare class ServicedeskService extends CommonHttpService {
996
980
  * "id": "12346",
997
981
  * "_links": {
998
982
  * "iconUrls": {
999
- * "48x48":
1000
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=large",
1001
- * "24x24":
1002
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=small",
1003
- * "16x16":
1004
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=xsmall",
1005
- * "32x32":
1006
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=medium"
983
+ * "48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=large",
984
+ * "24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=small",
985
+ * "16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=xsmall",
986
+ * "32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=medium"
1007
987
  * }
1008
988
  * }
1009
989
  * }
@@ -1012,8 +992,7 @@ export declare class ServicedeskService extends CommonHttpService {
1012
992
  * "_expands": [],
1013
993
  * "id": "11003",
1014
994
  * "_links": {
1015
- * "self":
1016
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11003"
995
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11003"
1017
996
  * },
1018
997
  * "name": "Hardware request",
1019
998
  * "description": "Request a hardware support",
@@ -1027,24 +1006,22 @@ export declare class ServicedeskService extends CommonHttpService {
1027
1006
  * "id": "12347",
1028
1007
  * "_links": {
1029
1008
  * "iconUrls": {
1030
- * "48x48":
1031
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=large",
1032
- * "24x24":
1033
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=small",
1034
- * "16x16":
1035
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=xsmall",
1036
- * "32x32":
1037
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=medium"
1009
+ * "48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=large",
1010
+ * "24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=small",
1011
+ * "16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=xsmall",
1012
+ * "32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=medium"
1038
1013
  * }
1039
1014
  * }
1040
1015
  * }
1041
1016
  * }
1042
1017
  * ]
1043
1018
  * }
1044
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype
1019
+ * ```
1020
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype`
1045
1021
  * @scopes-current read:servicedesk-request
1046
1022
  * @scopes-beta read:requesttype:jira-service-management
1047
1023
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-get
1024
+ * @param params
1048
1025
  */
1049
1026
  getRequestTypes: ({ serviceDeskId, groupId, expand, searchQuery, start, limit, includeHiddenRequestTypesInSearch, }: {
1050
1027
  /**
@@ -1084,20 +1061,23 @@ export declare class ServicedeskService extends CommonHttpService {
1084
1061
  *
1085
1062
  * @returns Returns the requested service desk.
1086
1063
  *
1087
- * example: {
1064
+ * example:
1065
+ * ```
1066
+ * {
1088
1067
  * "id": "10001",
1089
1068
  * "projectId": "11001",
1090
1069
  * "projectName": "IT Help Desk",
1091
1070
  * "projectKey": "ITH",
1092
1071
  * "_links": {
1093
- * "self":
1094
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10001"
1072
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10001"
1095
1073
  * }
1096
1074
  * }
1097
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}
1075
+ * ```
1076
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}`
1098
1077
  * @scopes-current read:servicedesk-request
1099
1078
  * @scopes-beta read:servicedesk:jira-service-management
1100
1079
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-get
1080
+ * @param params
1101
1081
  */
1102
1082
  getServiceDeskById: ({ serviceDeskId, }: {
1103
1083
  /**
@@ -1120,7 +1100,9 @@ export declare class ServicedeskService extends CommonHttpService {
1120
1100
  *
1121
1101
  * @returns Returns the service desks, on the specified page of the results.
1122
1102
  *
1123
- * example: {
1103
+ * example:
1104
+ * ```
1105
+ * {
1124
1106
  * "_expands": [],
1125
1107
  * "size": 3,
1126
1108
  * "start": 3,
@@ -1129,10 +1111,8 @@ export declare class ServicedeskService extends CommonHttpService {
1129
1111
  * "_links": {
1130
1112
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
1131
1113
  * "context": "context",
1132
- * "next":
1133
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk?start=6&limit=3",
1134
- * "prev":
1135
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk?start=0&limit=3"
1114
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk?start=6&limit=3",
1115
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk?start=0&limit=3"
1136
1116
  * },
1137
1117
  * "values": [
1138
1118
  * {
@@ -1141,8 +1121,7 @@ export declare class ServicedeskService extends CommonHttpService {
1141
1121
  * "projectName": "IT Help Desk",
1142
1122
  * "projectKey": "ITH",
1143
1123
  * "_links": {
1144
- * "self":
1145
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10001"
1124
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10001"
1146
1125
  * }
1147
1126
  * },
1148
1127
  * {
@@ -1151,8 +1130,7 @@ export declare class ServicedeskService extends CommonHttpService {
1151
1130
  * "projectName": "HR Self Serve Desk",
1152
1131
  * "projectKey": "HR",
1153
1132
  * "_links": {
1154
- * "self":
1155
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10002"
1133
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10002"
1156
1134
  * }
1157
1135
  * },
1158
1136
  * {
@@ -1161,16 +1139,17 @@ export declare class ServicedeskService extends CommonHttpService {
1161
1139
  * "projectName": "Foundation Leave",
1162
1140
  * "projectKey": "FL",
1163
1141
  * "_links": {
1164
- * "self":
1165
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10003"
1142
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10003"
1166
1143
  * }
1167
1144
  * }
1168
1145
  * ]
1169
1146
  * }
1170
- * @path {GET} /rest/servicedeskapi/servicedesk
1147
+ * ```
1148
+ * @path GET `/rest/servicedeskapi/servicedesk`
1171
1149
  * @scopes-current read:servicedesk-request
1172
1150
  * @scopes-beta read:servicedesk:jira-service-management
1173
1151
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-get
1152
+ * @param params
1174
1153
  */
1175
1154
  getServiceDesks: ({ start, limit, }?: {
1176
1155
  /**
@@ -1192,11 +1171,11 @@ export declare class ServicedeskService extends CommonHttpService {
1192
1171
  *
1193
1172
  * **[Permissions](#permissions) required**: Services desk administrator
1194
1173
  *
1195
- * @path {DELETE} /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
1174
+ * @path DELETE `/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer`
1196
1175
  * @scopes-current manage:servicedesk-customer
1197
- * @scopes-beta read:servicedesk.customer:jira-service-management,
1198
- * delete:servicedesk.customer:jira-service-management
1176
+ * @scopes-beta read:servicedesk.customer:jira-service-management, delete:servicedesk.customer:jira-service-management
1199
1177
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-customer-delete
1178
+ * @param params
1200
1179
  */
1201
1180
  removeCustomers: ({ serviceDeskId, serviceDeskCustomerDto, }: {
1202
1181
  /**
@@ -1205,7 +1184,8 @@ export declare class ServicedeskService extends CommonHttpService {
1205
1184
  */
1206
1185
  serviceDeskId: string;
1207
1186
  /**
1208
- * @example {
1187
+ * @example
1188
+ * {
1209
1189
  * "accountIds": [
1210
1190
  * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1211
1191
  * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd",
@@ -1233,19 +1213,19 @@ export declare class ServicedeskService extends CommonHttpService {
1233
1213
  * **[Permissions](#permissions) required**: Jira project administrator with a
1234
1214
  * Jira Service Management agent license.
1235
1215
  *
1236
- * @returns * status: 200, mediaType: application/json
1216
+ * @returns
1217
+ * * status: 200, mediaType: application/json
1237
1218
  *
1238
1219
  * Returned if the request type property is updated.
1239
1220
  *
1240
1221
  * * status: 201, mediaType: application/json
1241
1222
  *
1242
1223
  * Returned if the request type property is created.
1243
- * @path {PUT}
1244
- * /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}
1224
+ * @path PUT `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}`
1245
1225
  * @scopes-current manage:jira-project
1246
- * @scopes-beta read:requesttype.property:jira-service-management,
1247
- * write:requesttype.property:jira-service-management
1226
+ * @scopes-beta read:requesttype.property:jira-service-management, write:requesttype.property:jira-service-management
1248
1227
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-property-propertykey-put
1228
+ * @param params
1249
1229
  */
1250
1230
  setProperty: ({ serviceDeskId, requestTypeId, propertyKey, }: {
1251
1231
  /**