@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 PagedDtoUserDto } from "../models/common";
3
3
  import { type ApprovalDecisionRequestDto, type ApprovalDto, type AttachmentCreateDto, type AttachmentCreateResultDto, type CommentCreateDto, type CommentDto, type CsatFeedbackFullDto, type CustomerRequestDto, type CustomerTransitionExecutionDto, type PagedDtoApprovalDto, type PagedDtoAttachmentDto, type PagedDtoCommentDto, type PagedDtoCustomerRequestDto, type PagedDtoCustomerRequestStatusDto, type PagedDtoCustomerTransitionDto, type PagedDtoSlaInformationDto, type RequestCreateDto, type RequestNotificationSubscriptionDto, type RequestParticipantUpdateDto, type SlaInformationDto } from "../models/request";
4
4
  /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request */
@@ -15,7 +15,9 @@ export declare class RequestService extends CommonHttpService {
15
15
  *
16
16
  * @returns Returns the participants added to the customer request.
17
17
  *
18
- * example: {
18
+ * example:
19
+ * ```
20
+ * {
19
21
  * "_expands": [],
20
22
  * "size": 1,
21
23
  * "start": 1,
@@ -24,15 +26,12 @@ export declare class RequestService extends CommonHttpService {
24
26
  * "_links": {
25
27
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
26
28
  * "context": "context",
27
- * "next":
28
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
29
- * "prev":
30
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
29
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
30
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
31
31
  * },
32
32
  * "values": [
33
33
  * {
34
- * "accountId":
35
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
34
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
36
35
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
37
36
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
38
37
  * "emailAddress": "fred@example.com",
@@ -40,35 +39,31 @@ export declare class RequestService extends CommonHttpService {
40
39
  * "active": true,
41
40
  * "timeZone": "Australia/Sydney",
42
41
  * "_links": {
43
- * "jiraRest":
44
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
42
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
45
43
  * "avatarUrls": {
46
- * "16x16":
47
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
48
- * "24x24":
49
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
50
- * "32x32":
51
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
52
- * "48x48":
53
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
44
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
45
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
46
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
47
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
54
48
  * },
55
- * "self":
56
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
49
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
57
50
  * }
58
51
  * }
59
52
  * ]
60
53
  * }
61
- * @path {POST} /rest/servicedeskapi/request/{issueIdOrKey}/participant
54
+ * ```
55
+ * @path POST `/rest/servicedeskapi/request/{issueIdOrKey}/participant`
62
56
  * @scopes-current write:servicedesk-request
63
- * @scopes-beta read:request.participant:jira-service-management,
64
- * write:request.participant:jira-service-management, read:user:jira
57
+ * @scopes-beta read:request.participant:jira-service-management, write:request.participant:jira-service-management, read:user:jira
65
58
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-participant-post
59
+ * @param params
66
60
  */
67
61
  addRequestParticipants: ({ issueIdOrKey, requestParticipantUpdateDto, }: {
68
62
  /** The ID or key of the customer request to have participants added. */
69
63
  issueIdOrKey: string;
70
64
  /**
71
- * @example {
65
+ * @example
66
+ * {
72
67
  * "accountIds": [],
73
68
  * "usernames": [
74
69
  * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
@@ -89,7 +84,9 @@ export declare class RequestService extends CommonHttpService {
89
84
  *
90
85
  * @returns Returns the updated approval.
91
86
  *
92
- * example: {
87
+ * example:
88
+ * ```
89
+ * {
93
90
  * "id": "1",
94
91
  * "name": "Please approve this request",
95
92
  * "finalDecision": "approved",
@@ -97,31 +94,22 @@ export declare class RequestService extends CommonHttpService {
97
94
  * "approvers": [
98
95
  * {
99
96
  * "approver": {
100
- * "accountId":
101
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
102
- * "name":
103
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
104
- * "key":
105
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
97
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
98
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
99
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
106
100
  * "emailAddress": "fred@example.com",
107
101
  * "displayName": "Fred F. User",
108
102
  * "active": true,
109
103
  * "timeZone": "Australia/Sydney",
110
104
  * "_links": {
111
- * "jiraRest":
112
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
105
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
113
106
  * "avatarUrls": {
114
- * "16x16":
115
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
116
- * "24x24":
117
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
118
- * "32x32":
119
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
120
- * "48x48":
121
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
107
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
108
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
109
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
110
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
122
111
  * },
123
- * "self":
124
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
112
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
125
113
  * }
126
114
  * },
127
115
  * "approverDecision": "approved"
@@ -140,15 +128,15 @@ export declare class RequestService extends CommonHttpService {
140
128
  * "jira": "2016-09-29T14:30:00.000+0700"
141
129
  * },
142
130
  * "_links": {
143
- * "self":
144
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1"
131
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1"
145
132
  * }
146
133
  * }
147
- * @path {POST} /rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}
134
+ * ```
135
+ * @path POST `/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}`
148
136
  * @scopes-current write:servicedesk-request
149
- * @scopes-beta read:request.approval:jira-service-management,
150
- * write:request.approval:jira-service-management, read:user:jira
137
+ * @scopes-beta read:request.approval:jira-service-management, write:request.approval:jira-service-management, read:user:jira
151
138
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-approval-approvalid-post
139
+ * @param params
152
140
  */
153
141
  answerApproval: ({ issueIdOrKey, approvalId, approvalDecisionRequestDto, }: {
154
142
  /** The ID or key of the customer request to be updated. */
@@ -156,7 +144,8 @@ export declare class RequestService extends CommonHttpService {
156
144
  /** The ID of the approval to be updated. */
157
145
  approvalId: number;
158
146
  /**
159
- * @example {
147
+ * @example
148
+ * {
160
149
  * "decision": "approve"
161
150
  * }
162
151
  */
@@ -179,19 +168,19 @@ export declare class RequestService extends CommonHttpService {
179
168
  *
180
169
  * @returns Returns the attachments and comment.
181
170
  *
182
- * example: {
171
+ * example:
172
+ * ```
173
+ * {
183
174
  * "comment": {
184
175
  * "_expands": [
185
176
  * "attachment",
186
177
  * "renderedBody"
187
178
  * ],
188
179
  * "id": "1000",
189
- * "body": "Please find the screenshot and the log file attached.
190
- * !screenshot.png|thumbnail! [^log.txt] _(32 kB)_",
180
+ * "body": "Please find the screenshot and the log file attached. !screenshot.png|thumbnail! [^log.txt] _(32 kB)_",
191
181
  * "public": true,
192
182
  * "author": {
193
- * "accountId":
194
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
183
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
195
184
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
196
185
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
197
186
  * "emailAddress": "fred@example.com",
@@ -199,20 +188,14 @@ export declare class RequestService extends CommonHttpService {
199
188
  * "active": true,
200
189
  * "timeZone": "Australia/Sydney",
201
190
  * "_links": {
202
- * "jiraRest":
203
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
191
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
204
192
  * "avatarUrls": {
205
- * "16x16":
206
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
207
- * "24x24":
208
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
209
- * "32x32":
210
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
211
- * "48x48":
212
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
193
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
194
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
195
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
196
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
213
197
  * },
214
- * "self":
215
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
198
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
216
199
  * }
217
200
  * },
218
201
  * "created": {
@@ -222,8 +205,7 @@ export declare class RequestService extends CommonHttpService {
222
205
  * "jira": "2015-10-09T10:22:00.000+0700"
223
206
  * },
224
207
  * "_links": {
225
- * "self":
226
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
208
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
227
209
  * }
228
210
  * },
229
211
  * "attachments": {
@@ -235,40 +217,29 @@ export declare class RequestService extends CommonHttpService {
235
217
  * "_links": {
236
218
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
237
219
  * "context": "context",
238
- * "next":
239
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2",
240
- * "prev":
241
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2"
220
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2",
221
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2"
242
222
  * },
243
223
  * "values": [
244
224
  * {
245
225
  * "filename": "screenshot.png",
246
226
  * "author": {
247
- * "accountId":
248
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
249
- * "name":
250
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
251
- * "key":
252
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
227
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
228
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
229
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
253
230
  * "emailAddress": "fred@example.com",
254
231
  * "displayName": "Fred F. User",
255
232
  * "active": true,
256
233
  * "timeZone": "Australia/Sydney",
257
234
  * "_links": {
258
- * "jiraRest":
259
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
235
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
260
236
  * "avatarUrls": {
261
- * "16x16":
262
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
263
- * "24x24":
264
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
265
- * "32x32":
266
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
267
- * "48x48":
268
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
237
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
238
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
239
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
240
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
269
241
  * },
270
- * "self":
271
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
242
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
272
243
  * }
273
244
  * },
274
245
  * "created": {
@@ -280,42 +251,30 @@ export declare class RequestService extends CommonHttpService {
280
251
  * "size": 23123,
281
252
  * "mimeType": "image/png",
282
253
  * "_links": {
283
- * "jiraRest":
284
- * "https://your-domain.atlassian.net/rest/api/2/attachment/10000",
285
- * "content":
286
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png",
287
- * "thumbnail":
288
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png"
254
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10000",
255
+ * "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png",
256
+ * "thumbnail": "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png"
289
257
  * }
290
258
  * },
291
259
  * {
292
260
  * "filename": "log.txt",
293
261
  * "author": {
294
- * "accountId":
295
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
296
- * "name":
297
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
298
- * "key":
299
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
262
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
263
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
264
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
300
265
  * "emailAddress": "fred@example.com",
301
266
  * "displayName": "Fred F. User",
302
267
  * "active": true,
303
268
  * "timeZone": "Australia/Sydney",
304
269
  * "_links": {
305
- * "jiraRest":
306
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
270
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
307
271
  * "avatarUrls": {
308
- * "16x16":
309
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
310
- * "24x24":
311
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
312
- * "32x32":
313
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
314
- * "48x48":
315
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
272
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
273
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
274
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
275
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
316
276
  * },
317
- * "self":
318
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
277
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
319
278
  * }
320
279
  * },
321
280
  * "created": {
@@ -327,26 +286,26 @@ export declare class RequestService extends CommonHttpService {
327
286
  * "size": 32132,
328
287
  * "mimeType": "text/plain",
329
288
  * "_links": {
330
- * "jiraRest":
331
- * "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
332
- * "content":
333
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt"
289
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
290
+ * "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt"
334
291
  * }
335
292
  * }
336
293
  * ]
337
294
  * }
338
295
  * }
339
- * @path {POST} /rest/servicedeskapi/request/{issueIdOrKey}/attachment
296
+ * ```
297
+ * @path POST `/rest/servicedeskapi/request/{issueIdOrKey}/attachment`
340
298
  * @scopes-current write:servicedesk-request
341
- * @scopes-beta read:request.attachment:jira-service-management,
342
- * write:request.attachment:jira-service-management, read:user:jira
299
+ * @scopes-beta read:request.attachment:jira-service-management, write:request.attachment:jira-service-management, read:user:jira
343
300
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-post
301
+ * @param params
344
302
  */
345
303
  createCommentWithAttachment: ({ issueIdOrKey, attachmentCreateDto, }: {
346
304
  /** The ID or key of the customer request to which the attachment will be added. */
347
305
  issueIdOrKey: string;
348
306
  /**
349
- * @example {
307
+ * @example
308
+ * {
350
309
  * "additionalComment": {
351
310
  * "body": "Please find the screenshot and the log file attached."
352
311
  * },
@@ -384,7 +343,9 @@ export declare class RequestService extends CommonHttpService {
384
343
  *
385
344
  * @returns Returned if the customer request was created.
386
345
  *
387
- * example: {
346
+ * example:
347
+ * ```
348
+ * {
388
349
  * "_expands": [
389
350
  * "participant",
390
351
  * "status",
@@ -406,8 +367,7 @@ export declare class RequestService extends CommonHttpService {
406
367
  * "jira": "2015-10-08T14:42:00.000+0700"
407
368
  * },
408
369
  * "reporter": {
409
- * "accountId":
410
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
370
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
411
371
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
412
372
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
413
373
  * "emailAddress": "fred@example.com",
@@ -415,20 +375,14 @@ export declare class RequestService extends CommonHttpService {
415
375
  * "active": true,
416
376
  * "timeZone": "Australia/Sydney",
417
377
  * "_links": {
418
- * "jiraRest":
419
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
378
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
420
379
  * "avatarUrls": {
421
- * "16x16":
422
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
423
- * "24x24":
424
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
425
- * "32x32":
426
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
427
- * "48x48":
428
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
380
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
381
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
382
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
383
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
429
384
  * },
430
- * "self":
431
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
385
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
432
386
  * }
433
387
  * },
434
388
  * "requestFieldValues": [
@@ -458,22 +412,22 @@ export declare class RequestService extends CommonHttpService {
458
412
  * },
459
413
  * "_links": {
460
414
  * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107001",
461
- * "web":
462
- * "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1",
463
- * "self":
464
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001",
415
+ * "web": "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1",
416
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001",
465
417
  * "agent": "https://your-domain.atlassian.net/browse/HELPDESK-1"
466
418
  * }
467
419
  * }
468
- * @path {POST} /rest/servicedeskapi/request
420
+ * ```
421
+ * @path POST `/rest/servicedeskapi/request`
469
422
  * @scopes-current write:servicedesk-request
470
- * @scopes-beta read:request:jira-service-management, write:request:jira-service-management,
471
- * read:user:jira
423
+ * @scopes-beta read:request:jira-service-management, write:request:jira-service-management, read:user:jira
472
424
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-post
425
+ * @param params
473
426
  */
474
427
  createCustomerRequest: ({ requestCreateDto, }: {
475
428
  /**
476
- * @example {
429
+ * @example
430
+ * {
477
431
  * "form": {
478
432
  * "answers": {
479
433
  * "1": {
@@ -522,7 +476,9 @@ export declare class RequestService extends CommonHttpService {
522
476
  *
523
477
  * @returns Returns the comment.
524
478
  *
525
- * example: {
479
+ * example:
480
+ * ```
481
+ * {
526
482
  * "_expands": [
527
483
  * "attachment",
528
484
  * "renderedBody"
@@ -531,8 +487,7 @@ export declare class RequestService extends CommonHttpService {
531
487
  * "body": "Hello there",
532
488
  * "public": true,
533
489
  * "author": {
534
- * "accountId":
535
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
490
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
536
491
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
537
492
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
538
493
  * "emailAddress": "fred@example.com",
@@ -540,20 +495,14 @@ export declare class RequestService extends CommonHttpService {
540
495
  * "active": true,
541
496
  * "timeZone": "Australia/Sydney",
542
497
  * "_links": {
543
- * "jiraRest":
544
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
498
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
545
499
  * "avatarUrls": {
546
- * "16x16":
547
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
548
- * "24x24":
549
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
550
- * "32x32":
551
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
552
- * "48x48":
553
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
500
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
501
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
502
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
503
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
554
504
  * },
555
- * "self":
556
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
505
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
557
506
  * }
558
507
  * },
559
508
  * "created": {
@@ -563,21 +512,22 @@ export declare class RequestService extends CommonHttpService {
563
512
  * "jira": "2015-10-09T10:22:00.000+0700"
564
513
  * },
565
514
  * "_links": {
566
- * "self":
567
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
515
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
568
516
  * }
569
517
  * }
570
- * @path {POST} /rest/servicedeskapi/request/{issueIdOrKey}/comment
518
+ * ```
519
+ * @path POST `/rest/servicedeskapi/request/{issueIdOrKey}/comment`
571
520
  * @scopes-current write:servicedesk-request
572
- * @scopes-beta read:request.comment:jira-service-management,
573
- * write:request.comment:jira-service-management, read:user:jira
521
+ * @scopes-beta read:request.comment:jira-service-management, write:request.comment:jira-service-management, read:user:jira
574
522
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-post
523
+ * @param params
575
524
  */
576
525
  createRequestComment: ({ issueIdOrKey, commentCreateDto, }: {
577
526
  /** The ID or key of the customer request to which the comment will be added. */
578
527
  issueIdOrKey: string;
579
528
  /**
580
- * @example {
529
+ * @example
530
+ * {
581
531
  * "body": "Hello there",
582
532
  * "public": true
583
533
  * }
@@ -592,11 +542,11 @@ export declare class RequestService extends CommonHttpService {
592
542
  * Atlassian Connect app.
593
543
  *
594
544
  * @returns No content.
595
- * @path {DELETE} /rest/servicedeskapi/request/{requestIdOrKey}/feedback
545
+ * @path DELETE `/rest/servicedeskapi/request/{requestIdOrKey}/feedback`
596
546
  * @scopes-current write:servicedesk-request
597
- * @scopes-beta read:request.feedback:jira-service-management,
598
- * delete:request.feedback:jira-service-management, read:user:jira
547
+ * @scopes-beta read:request.feedback:jira-service-management, delete:request.feedback:jira-service-management, read:user:jira
599
548
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-requestidorkey-feedback-delete
549
+ * @param params
600
550
  */
601
551
  deleteFeedback: ({ requestIdOrKey, }: {
602
552
  /** The id or the key of the request to post the feedback on */
@@ -611,7 +561,9 @@ export declare class RequestService extends CommonHttpService {
611
561
  *
612
562
  * @returns Returns the requested approval.
613
563
  *
614
- * example: {
564
+ * example:
565
+ * ```
566
+ * {
615
567
  * "id": "1",
616
568
  * "name": "Please approve this request",
617
569
  * "finalDecision": "approved",
@@ -619,31 +571,22 @@ export declare class RequestService extends CommonHttpService {
619
571
  * "approvers": [
620
572
  * {
621
573
  * "approver": {
622
- * "accountId":
623
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
624
- * "name":
625
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
626
- * "key":
627
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
574
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
575
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
576
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
628
577
  * "emailAddress": "fred@example.com",
629
578
  * "displayName": "Fred F. User",
630
579
  * "active": true,
631
580
  * "timeZone": "Australia/Sydney",
632
581
  * "_links": {
633
- * "jiraRest":
634
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
582
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
635
583
  * "avatarUrls": {
636
- * "16x16":
637
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
638
- * "24x24":
639
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
640
- * "32x32":
641
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
642
- * "48x48":
643
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
584
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
585
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
586
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
587
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
644
588
  * },
645
- * "self":
646
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
589
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
647
590
  * }
648
591
  * },
649
592
  * "approverDecision": "approved"
@@ -662,14 +605,15 @@ export declare class RequestService extends CommonHttpService {
662
605
  * "jira": "2016-09-29T14:30:00.000+0700"
663
606
  * },
664
607
  * "_links": {
665
- * "self":
666
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1"
608
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1"
667
609
  * }
668
610
  * }
669
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}
611
+ * ```
612
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}`
670
613
  * @scopes-current read:servicedesk-request
671
614
  * @scopes-beta read:request.approval:jira-service-management, read:user:jira
672
615
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-approval-approvalid-get
616
+ * @param params
673
617
  */
674
618
  getApprovalById: ({ issueIdOrKey, approvalId, }: {
675
619
  /** The ID or key of the customer request the approval is on. */
@@ -685,7 +629,9 @@ export declare class RequestService extends CommonHttpService {
685
629
  *
686
630
  * @returns Returns the customer request's approvals.
687
631
  *
688
- * example: {
632
+ * example:
633
+ * ```
634
+ * {
689
635
  * "_expands": [],
690
636
  * "size": 3,
691
637
  * "start": 3,
@@ -694,10 +640,8 @@ export declare class RequestService extends CommonHttpService {
694
640
  * "_links": {
695
641
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
696
642
  * "context": "context",
697
- * "next":
698
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval?start=6&limit=3",
699
- * "prev":
700
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval?start=0&limit=3"
643
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval?start=6&limit=3",
644
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval?start=0&limit=3"
701
645
  * },
702
646
  * "values": [
703
647
  * {
@@ -708,31 +652,22 @@ export declare class RequestService extends CommonHttpService {
708
652
  * "approvers": [
709
653
  * {
710
654
  * "approver": {
711
- * "accountId":
712
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
713
- * "name":
714
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
715
- * "key":
716
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
655
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
656
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
657
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
717
658
  * "emailAddress": "fred@example.com",
718
659
  * "displayName": "Fred F. User",
719
660
  * "active": true,
720
661
  * "timeZone": "Australia/Sydney",
721
662
  * "_links": {
722
- * "jiraRest":
723
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
663
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
724
664
  * "avatarUrls": {
725
- * "16x16":
726
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
727
- * "24x24":
728
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
729
- * "32x32":
730
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
731
- * "48x48":
732
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
665
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
666
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
667
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
668
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
733
669
  * },
734
- * "self":
735
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
670
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
736
671
  * }
737
672
  * },
738
673
  * "approverDecision": "approved"
@@ -751,8 +686,7 @@ export declare class RequestService extends CommonHttpService {
751
686
  * "jira": "2016-09-29T14:30:00.000+0700"
752
687
  * },
753
688
  * "_links": {
754
- * "self":
755
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1"
689
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1"
756
690
  * }
757
691
  * },
758
692
  * {
@@ -763,31 +697,22 @@ export declare class RequestService extends CommonHttpService {
763
697
  * "approvers": [
764
698
  * {
765
699
  * "approver": {
766
- * "accountId":
767
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
768
- * "name":
769
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
770
- * "key":
771
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
700
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
701
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
702
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
772
703
  * "emailAddress": "fred@example.com",
773
704
  * "displayName": "Fred F. User",
774
705
  * "active": true,
775
706
  * "timeZone": "Australia/Sydney",
776
707
  * "_links": {
777
- * "jiraRest":
778
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
708
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
779
709
  * "avatarUrls": {
780
- * "16x16":
781
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
782
- * "24x24":
783
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
784
- * "32x32":
785
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
786
- * "48x48":
787
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
710
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
711
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
712
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
713
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
788
714
  * },
789
- * "self":
790
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
715
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
791
716
  * }
792
717
  * },
793
718
  * "approverDecision": "approved"
@@ -806,16 +731,17 @@ export declare class RequestService extends CommonHttpService {
806
731
  * "jira": "2016-10-06T14:30:00.000+0700"
807
732
  * },
808
733
  * "_links": {
809
- * "self":
810
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/2"
734
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/2"
811
735
  * }
812
736
  * }
813
737
  * ]
814
738
  * }
815
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/approval
739
+ * ```
740
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/approval`
816
741
  * @scopes-current read:servicedesk-request
817
742
  * @scopes-beta read:request.approval:jira-service-management, read:user:jira
818
743
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-approval-get
744
+ * @param params
819
745
  */
820
746
  getApprovals: ({ issueIdOrKey, start, limit, }: {
821
747
  /** The ID or key of the customer request to be queried for its approvals. */
@@ -847,10 +773,11 @@ export declare class RequestService extends CommonHttpService {
847
773
  * configured, issue-level security permission to view the issue.
848
774
  *
849
775
  * @returns 200 response
850
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}
776
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}`
851
777
  * @scopes-current read:servicedesk-request
852
778
  * @scopes-beta read:request.attachment:jira-service-management, read:user:jira
853
779
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-get
780
+ * @param params
854
781
  */
855
782
  getAttachmentContent: ({ issueIdOrKey, attachmentId, }: {
856
783
  /** The ID or key for the customer request the attachment is associated with */
@@ -868,7 +795,9 @@ export declare class RequestService extends CommonHttpService {
868
795
  *
869
796
  * @returns Returns the visible attachments from the customer request.
870
797
  *
871
- * example: {
798
+ * example:
799
+ * ```
800
+ * {
872
801
  * "_expands": [],
873
802
  * "size": 2,
874
803
  * "start": 2,
@@ -877,40 +806,29 @@ export declare class RequestService extends CommonHttpService {
877
806
  * "_links": {
878
807
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
879
808
  * "context": "context",
880
- * "next":
881
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2",
882
- * "prev":
883
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2"
809
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2",
810
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2"
884
811
  * },
885
812
  * "values": [
886
813
  * {
887
814
  * "filename": "screenshot.png",
888
815
  * "author": {
889
- * "accountId":
890
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
891
- * "name":
892
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
893
- * "key":
894
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
816
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
817
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
818
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
895
819
  * "emailAddress": "fred@example.com",
896
820
  * "displayName": "Fred F. User",
897
821
  * "active": true,
898
822
  * "timeZone": "Australia/Sydney",
899
823
  * "_links": {
900
- * "jiraRest":
901
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
824
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
902
825
  * "avatarUrls": {
903
- * "16x16":
904
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
905
- * "24x24":
906
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
907
- * "32x32":
908
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
909
- * "48x48":
910
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
826
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
827
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
828
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
829
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
911
830
  * },
912
- * "self":
913
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
831
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
914
832
  * }
915
833
  * },
916
834
  * "created": {
@@ -922,42 +840,30 @@ export declare class RequestService extends CommonHttpService {
922
840
  * "size": 23123,
923
841
  * "mimeType": "image/png",
924
842
  * "_links": {
925
- * "jiraRest":
926
- * "https://your-domain.atlassian.net/rest/api/2/attachment/10000",
927
- * "content":
928
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png",
929
- * "thumbnail":
930
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png"
843
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10000",
844
+ * "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png",
845
+ * "thumbnail": "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png"
931
846
  * }
932
847
  * },
933
848
  * {
934
849
  * "filename": "log.txt",
935
850
  * "author": {
936
- * "accountId":
937
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
938
- * "name":
939
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
940
- * "key":
941
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
851
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
852
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
853
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
942
854
  * "emailAddress": "fred@example.com",
943
855
  * "displayName": "Fred F. User",
944
856
  * "active": true,
945
857
  * "timeZone": "Australia/Sydney",
946
858
  * "_links": {
947
- * "jiraRest":
948
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
859
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
949
860
  * "avatarUrls": {
950
- * "16x16":
951
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
952
- * "24x24":
953
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
954
- * "32x32":
955
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
956
- * "48x48":
957
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
861
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
862
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
863
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
864
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
958
865
  * },
959
- * "self":
960
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
866
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
961
867
  * }
962
868
  * },
963
869
  * "created": {
@@ -969,18 +875,18 @@ export declare class RequestService extends CommonHttpService {
969
875
  * "size": 32132,
970
876
  * "mimeType": "text/plain",
971
877
  * "_links": {
972
- * "jiraRest":
973
- * "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
974
- * "content":
975
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt"
878
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
879
+ * "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt"
976
880
  * }
977
881
  * }
978
882
  * ]
979
883
  * }
980
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/attachment
884
+ * ```
885
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/attachment`
981
886
  * @scopes-current read:servicedesk-request
982
887
  * @scopes-beta read:request.attachment:jira-service-management, read:user:jira
983
888
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-get
889
+ * @param params
984
890
  */
985
891
  getAttachmentsForRequest: ({ issueIdOrKey, start, limit, }: {
986
892
  /** The ID or key of the customer request from which the attachments will be listed. */
@@ -1012,11 +918,11 @@ export declare class RequestService extends CommonHttpService {
1012
918
  * configured, issue-level security permission to view the issue.
1013
919
  *
1014
920
  * @returns 200 response
1015
- * @path {GET}
1016
- * /rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}/thumbnail
921
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}/thumbnail`
1017
922
  * @scopes-current read:servicedesk-request
1018
923
  * @scopes-beta read:request.attachment:jira-service-management, read:user:jira
1019
924
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-thumbnail-get
925
+ * @param params
1020
926
  */
1021
927
  getAttachmentThumbnail: ({ issueIdOrKey, attachmentId, }: {
1022
928
  /** The ID or key for the customer request the attachment is associated with */
@@ -1036,7 +942,9 @@ export declare class RequestService extends CommonHttpService {
1036
942
  *
1037
943
  * @returns Returns the attachments, on the specified page of the results.
1038
944
  *
1039
- * example: {
945
+ * example:
946
+ * ```
947
+ * {
1040
948
  * "_expands": [],
1041
949
  * "size": 2,
1042
950
  * "start": 2,
@@ -1045,40 +953,29 @@ export declare class RequestService extends CommonHttpService {
1045
953
  * "_links": {
1046
954
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
1047
955
  * "context": "context",
1048
- * "next":
1049
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2",
1050
- * "prev":
1051
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2"
956
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2",
957
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2"
1052
958
  * },
1053
959
  * "values": [
1054
960
  * {
1055
961
  * "filename": "screenshot.png",
1056
962
  * "author": {
1057
- * "accountId":
1058
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1059
- * "name":
1060
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1061
- * "key":
1062
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
963
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
964
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
965
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1063
966
  * "emailAddress": "fred@example.com",
1064
967
  * "displayName": "Fred F. User",
1065
968
  * "active": true,
1066
969
  * "timeZone": "Australia/Sydney",
1067
970
  * "_links": {
1068
- * "jiraRest":
1069
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
971
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1070
972
  * "avatarUrls": {
1071
- * "16x16":
1072
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1073
- * "24x24":
1074
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1075
- * "32x32":
1076
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1077
- * "48x48":
1078
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
973
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
974
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
975
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
976
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1079
977
  * },
1080
- * "self":
1081
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
978
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1082
979
  * }
1083
980
  * },
1084
981
  * "created": {
@@ -1090,42 +987,30 @@ export declare class RequestService extends CommonHttpService {
1090
987
  * "size": 23123,
1091
988
  * "mimeType": "image/png",
1092
989
  * "_links": {
1093
- * "jiraRest":
1094
- * "https://your-domain.atlassian.net/rest/api/2/attachment/10000",
1095
- * "content":
1096
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png",
1097
- * "thumbnail":
1098
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png"
990
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10000",
991
+ * "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png",
992
+ * "thumbnail": "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png"
1099
993
  * }
1100
994
  * },
1101
995
  * {
1102
996
  * "filename": "log.txt",
1103
997
  * "author": {
1104
- * "accountId":
1105
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1106
- * "name":
1107
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1108
- * "key":
1109
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
998
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
999
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1000
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1110
1001
  * "emailAddress": "fred@example.com",
1111
1002
  * "displayName": "Fred F. User",
1112
1003
  * "active": true,
1113
1004
  * "timeZone": "Australia/Sydney",
1114
1005
  * "_links": {
1115
- * "jiraRest":
1116
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1006
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1117
1007
  * "avatarUrls": {
1118
- * "16x16":
1119
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1120
- * "24x24":
1121
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1122
- * "32x32":
1123
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1124
- * "48x48":
1125
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1008
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1009
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1010
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1011
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1126
1012
  * },
1127
- * "self":
1128
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1013
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1129
1014
  * }
1130
1015
  * },
1131
1016
  * "created": {
@@ -1137,16 +1022,16 @@ export declare class RequestService extends CommonHttpService {
1137
1022
  * "size": 32132,
1138
1023
  * "mimeType": "text/plain",
1139
1024
  * "_links": {
1140
- * "jiraRest":
1141
- * "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
1142
- * "content":
1143
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt"
1025
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
1026
+ * "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt"
1144
1027
  * }
1145
1028
  * }
1146
1029
  * ]
1147
1030
  * }
1148
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment
1031
+ * ```
1032
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment`
1149
1033
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-commentid-attachment-get
1034
+ * @param params
1150
1035
  */
1151
1036
  getCommentAttachments: ({ issueIdOrKey, commentId, start, limit, }: {
1152
1037
  /** The ID or key of the customer request that contains the comment. */
@@ -1179,7 +1064,9 @@ export declare class RequestService extends CommonHttpService {
1179
1064
  *
1180
1065
  * @returns Returns the customer request.
1181
1066
  *
1182
- * example: {
1067
+ * example:
1068
+ * ```
1069
+ * {
1183
1070
  * "_expands": [
1184
1071
  * "participant",
1185
1072
  * "status",
@@ -1201,8 +1088,7 @@ export declare class RequestService extends CommonHttpService {
1201
1088
  * "jira": "2015-10-08T14:42:00.000+0700"
1202
1089
  * },
1203
1090
  * "reporter": {
1204
- * "accountId":
1205
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1091
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1206
1092
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1207
1093
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1208
1094
  * "emailAddress": "fred@example.com",
@@ -1210,20 +1096,14 @@ export declare class RequestService extends CommonHttpService {
1210
1096
  * "active": true,
1211
1097
  * "timeZone": "Australia/Sydney",
1212
1098
  * "_links": {
1213
- * "jiraRest":
1214
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1099
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1215
1100
  * "avatarUrls": {
1216
- * "16x16":
1217
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1218
- * "24x24":
1219
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1220
- * "32x32":
1221
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1222
- * "48x48":
1223
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1101
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1102
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1103
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1104
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1224
1105
  * },
1225
- * "self":
1226
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1106
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1227
1107
  * }
1228
1108
  * },
1229
1109
  * "requestFieldValues": [
@@ -1253,17 +1133,17 @@ export declare class RequestService extends CommonHttpService {
1253
1133
  * },
1254
1134
  * "_links": {
1255
1135
  * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107001",
1256
- * "web":
1257
- * "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1",
1258
- * "self":
1259
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001",
1136
+ * "web": "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1",
1137
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001",
1260
1138
  * "agent": "https://your-domain.atlassian.net/browse/HELPDESK-1"
1261
1139
  * }
1262
1140
  * }
1263
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}
1141
+ * ```
1142
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}`
1264
1143
  * @scopes-current read:servicedesk-request
1265
1144
  * @scopes-beta read:request:jira-service-management, read:user:jira
1266
1145
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-get
1146
+ * @param params
1267
1147
  */
1268
1148
  getCustomerRequestByIdOrKey: ({ issueIdOrKey, expand, }: {
1269
1149
  /** The ID or Key of the customer request to be returned */
@@ -1300,7 +1180,9 @@ export declare class RequestService extends CommonHttpService {
1300
1180
  *
1301
1181
  * @returns Returns the customer requests, on the specified page of the results.
1302
1182
  *
1303
- * example: {
1183
+ * example:
1184
+ * ```
1185
+ * {
1304
1186
  * "_expands": [
1305
1187
  * "participant",
1306
1188
  * "status",
@@ -1318,10 +1200,8 @@ export declare class RequestService extends CommonHttpService {
1318
1200
  * "_links": {
1319
1201
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
1320
1202
  * "context": "context",
1321
- * "next":
1322
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request?start=6&limit=3",
1323
- * "prev":
1324
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request?start=0&limit=3"
1203
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request?start=6&limit=3",
1204
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request?start=0&limit=3"
1325
1205
  * },
1326
1206
  * "values": [
1327
1207
  * {
@@ -1346,31 +1226,22 @@ export declare class RequestService extends CommonHttpService {
1346
1226
  * "jira": "2015-10-08T14:42:00.000+0700"
1347
1227
  * },
1348
1228
  * "reporter": {
1349
- * "accountId":
1350
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1351
- * "name":
1352
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1353
- * "key":
1354
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1229
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1230
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1231
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1355
1232
  * "emailAddress": "fred@example.com",
1356
1233
  * "displayName": "Fred F. User",
1357
1234
  * "active": true,
1358
1235
  * "timeZone": "Australia/Sydney",
1359
1236
  * "_links": {
1360
- * "jiraRest":
1361
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1237
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1362
1238
  * "avatarUrls": {
1363
- * "16x16":
1364
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1365
- * "24x24":
1366
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1367
- * "32x32":
1368
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1369
- * "48x48":
1370
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1239
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1240
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1241
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1242
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1371
1243
  * },
1372
- * "self":
1373
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1244
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1374
1245
  * }
1375
1246
  * },
1376
1247
  * "requestFieldValues": [
@@ -1400,10 +1271,8 @@ export declare class RequestService extends CommonHttpService {
1400
1271
  * },
1401
1272
  * "_links": {
1402
1273
  * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107001",
1403
- * "web":
1404
- * "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1",
1405
- * "self":
1406
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001",
1274
+ * "web": "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1",
1275
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001",
1407
1276
  * "agent": "https://your-domain.atlassian.net/browse/HELPDESK-1"
1408
1277
  * }
1409
1278
  * },
@@ -1429,31 +1298,22 @@ export declare class RequestService extends CommonHttpService {
1429
1298
  * "jira": "2015-10-08T14:30:00.000+0700"
1430
1299
  * },
1431
1300
  * "reporter": {
1432
- * "accountId":
1433
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1434
- * "name":
1435
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1436
- * "key":
1437
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1301
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1302
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1303
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1438
1304
  * "emailAddress": "fred@example.com",
1439
1305
  * "displayName": "Fred F. User",
1440
1306
  * "active": true,
1441
1307
  * "timeZone": "Australia/Sydney",
1442
1308
  * "_links": {
1443
- * "jiraRest":
1444
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1309
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1445
1310
  * "avatarUrls": {
1446
- * "16x16":
1447
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1448
- * "24x24":
1449
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1450
- * "32x32":
1451
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1452
- * "48x48":
1453
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1311
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1312
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1313
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1314
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1454
1315
  * },
1455
- * "self":
1456
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1316
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1457
1317
  * }
1458
1318
  * },
1459
1319
  * "requestFieldValues": [
@@ -1480,10 +1340,8 @@ export declare class RequestService extends CommonHttpService {
1480
1340
  * },
1481
1341
  * "_links": {
1482
1342
  * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107002",
1483
- * "web":
1484
- * "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-2",
1485
- * "self":
1486
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/107002",
1343
+ * "web": "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-2",
1344
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107002",
1487
1345
  * "agent": "https://your-domain.atlassian.net/browse/HELPDESK-2"
1488
1346
  * }
1489
1347
  * },
@@ -1509,31 +1367,22 @@ export declare class RequestService extends CommonHttpService {
1509
1367
  * "jira": "2015-10-05T14:30:00.000+0700"
1510
1368
  * },
1511
1369
  * "reporter": {
1512
- * "accountId":
1513
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1514
- * "name":
1515
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1516
- * "key":
1517
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1370
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1371
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1372
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1518
1373
  * "emailAddress": "fred@example.com",
1519
1374
  * "displayName": "Fred F. User",
1520
1375
  * "active": true,
1521
1376
  * "timeZone": "Australia/Sydney",
1522
1377
  * "_links": {
1523
- * "jiraRest":
1524
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1378
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1525
1379
  * "avatarUrls": {
1526
- * "16x16":
1527
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1528
- * "24x24":
1529
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1530
- * "32x32":
1531
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1532
- * "48x48":
1533
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1380
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1381
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1382
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1383
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1534
1384
  * },
1535
- * "self":
1536
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1385
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1537
1386
  * }
1538
1387
  * },
1539
1388
  * "requestFieldValues": [
@@ -1559,19 +1408,19 @@ export declare class RequestService extends CommonHttpService {
1559
1408
  * },
1560
1409
  * "_links": {
1561
1410
  * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/109006",
1562
- * "web":
1563
- * "https://your-domain.atlassian.net/servicedesk/customer/portal/12/SIMPLEDESK-6",
1564
- * "self":
1565
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/109006",
1411
+ * "web": "https://your-domain.atlassian.net/servicedesk/customer/portal/12/SIMPLEDESK-6",
1412
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/109006",
1566
1413
  * "agent": "https://your-domain.atlassian.net/browse/SIMPLEDESK-6"
1567
1414
  * }
1568
1415
  * }
1569
1416
  * ]
1570
1417
  * }
1571
- * @path {GET} /rest/servicedeskapi/request
1418
+ * ```
1419
+ * @path GET `/rest/servicedeskapi/request`
1572
1420
  * @scopes-current read:servicedesk-request
1573
1421
  * @scopes-beta read:request:jira-service-management, read:user:jira
1574
1422
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-get
1423
+ * @param params
1575
1424
  */
1576
1425
  getCustomerRequests: ({ searchTerm, requestOwnership, requestStatus, approvalStatus, organizationId, serviceDeskId, requestTypeId, expand, start, limit, }?: {
1577
1426
  /**
@@ -1677,10 +1526,11 @@ export declare class RequestService extends CommonHttpService {
1677
1526
  * **[Permissions](#permissions) required**: Permission to view the customer
1678
1527
  * request.
1679
1528
  *
1680
- * @returns Returns the customer request's status history, on the specified page of the
1681
- * results.
1529
+ * @returns Returns the customer request's status history, on the specified page of the results.
1682
1530
  *
1683
- * example: {
1531
+ * example:
1532
+ * ```
1533
+ * {
1684
1534
  * "_expands": [],
1685
1535
  * "size": 3,
1686
1536
  * "start": 3,
@@ -1689,10 +1539,8 @@ export declare class RequestService extends CommonHttpService {
1689
1539
  * "_links": {
1690
1540
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
1691
1541
  * "context": "context",
1692
- * "next":
1693
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/status?start=6&limit=3",
1694
- * "prev":
1695
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/status?start=0&limit=3"
1542
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/status?start=6&limit=3",
1543
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/status?start=0&limit=3"
1696
1544
  * },
1697
1545
  * "values": [
1698
1546
  * {
@@ -1724,10 +1572,12 @@ export declare class RequestService extends CommonHttpService {
1724
1572
  * }
1725
1573
  * ]
1726
1574
  * }
1727
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/status
1575
+ * ```
1576
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/status`
1728
1577
  * @scopes-current read:servicedesk-request
1729
1578
  * @scopes-beta read:request.status:jira-service-management, read:user:jira
1730
1579
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-status-get
1580
+ * @param params
1731
1581
  */
1732
1582
  getCustomerRequestStatus: ({ issueIdOrKey, start, limit, }: {
1733
1583
  /** The ID or key of the customer request to be retrieved. */
@@ -1754,7 +1604,9 @@ export declare class RequestService extends CommonHttpService {
1754
1604
  *
1755
1605
  * @returns Returns the transitions available to the user on the customer request.
1756
1606
  *
1757
- * example: {
1607
+ * example:
1608
+ * ```
1609
+ * {
1758
1610
  * "_expands": [],
1759
1611
  * "size": 2,
1760
1612
  * "start": 2,
@@ -1763,10 +1615,8 @@ export declare class RequestService extends CommonHttpService {
1763
1615
  * "_links": {
1764
1616
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
1765
1617
  * "context": "context",
1766
- * "next":
1767
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/transition?start=4&limit=2",
1768
- * "prev":
1769
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/transition?start=0&limit=2"
1618
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/transition?start=4&limit=2",
1619
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/transition?start=0&limit=2"
1770
1620
  * },
1771
1621
  * "values": [
1772
1622
  * {
@@ -1779,10 +1629,12 @@ export declare class RequestService extends CommonHttpService {
1779
1629
  * }
1780
1630
  * ]
1781
1631
  * }
1782
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/transition
1632
+ * ```
1633
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/transition`
1783
1634
  * @scopes-current read:servicedesk-request
1784
1635
  * @scopes-beta read:request.status:jira-service-management, read:user:jira
1785
1636
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-transition-get
1637
+ * @param params
1786
1638
  */
1787
1639
  getCustomerTransitions: ({ issueIdOrKey, start, limit, }: {
1788
1640
  /** The ID or key of the customer request whose transitions will be retrieved. */
@@ -1806,17 +1658,21 @@ export declare class RequestService extends CommonHttpService {
1806
1658
  *
1807
1659
  * @returns Returns the comment.
1808
1660
  *
1809
- * example: {
1661
+ * example:
1662
+ * ```
1663
+ * {
1810
1664
  * "type": "csat",
1811
1665
  * "rating": 4,
1812
1666
  * "comment": {
1813
1667
  * "body": "Great work!"
1814
1668
  * }
1815
1669
  * }
1816
- * @path {GET} /rest/servicedeskapi/request/{requestIdOrKey}/feedback
1670
+ * ```
1671
+ * @path GET `/rest/servicedeskapi/request/{requestIdOrKey}/feedback`
1817
1672
  * @scopes-current read:servicedesk-request
1818
1673
  * @scopes-beta read:request.feedback:jira-service-management, read:user:jira
1819
1674
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-requestidorkey-feedback-get
1675
+ * @param params
1820
1676
  */
1821
1677
  getFeedback: ({ requestIdOrKey, }: {
1822
1678
  /** The id or the key of the request to post the feedback on */
@@ -1834,7 +1690,9 @@ export declare class RequestService extends CommonHttpService {
1834
1690
  *
1835
1691
  * @returns Returns the comment.
1836
1692
  *
1837
- * example: {
1693
+ * example:
1694
+ * ```
1695
+ * {
1838
1696
  * "_expands": [
1839
1697
  * "attachment",
1840
1698
  * "renderedBody"
@@ -1843,8 +1701,7 @@ export declare class RequestService extends CommonHttpService {
1843
1701
  * "body": "Hello there",
1844
1702
  * "public": true,
1845
1703
  * "author": {
1846
- * "accountId":
1847
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1704
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1848
1705
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1849
1706
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1850
1707
  * "emailAddress": "fred@example.com",
@@ -1852,20 +1709,14 @@ export declare class RequestService extends CommonHttpService {
1852
1709
  * "active": true,
1853
1710
  * "timeZone": "Australia/Sydney",
1854
1711
  * "_links": {
1855
- * "jiraRest":
1856
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1712
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1857
1713
  * "avatarUrls": {
1858
- * "16x16":
1859
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1860
- * "24x24":
1861
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1862
- * "32x32":
1863
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1864
- * "48x48":
1865
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1714
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1715
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1716
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1717
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1866
1718
  * },
1867
- * "self":
1868
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1719
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1869
1720
  * }
1870
1721
  * },
1871
1722
  * "created": {
@@ -1875,14 +1726,15 @@ export declare class RequestService extends CommonHttpService {
1875
1726
  * "jira": "2015-10-09T10:22:00.000+0700"
1876
1727
  * },
1877
1728
  * "_links": {
1878
- * "self":
1879
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
1729
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
1880
1730
  * }
1881
1731
  * }
1882
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}
1732
+ * ```
1733
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}`
1883
1734
  * @scopes-current read:servicedesk-request
1884
1735
  * @scopes-beta read:request.comment:jira-service-management, read:user:jira
1885
1736
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-commentid-get
1737
+ * @param params
1886
1738
  */
1887
1739
  getRequestCommentById: ({ issueIdOrKey, commentId, expand, }: {
1888
1740
  /** The ID or key of the customer request that contains the comment. */
@@ -1912,7 +1764,9 @@ export declare class RequestService extends CommonHttpService {
1912
1764
  *
1913
1765
  * @returns Returns the comments, on the specified page of the results.
1914
1766
  *
1915
- * example: {
1767
+ * example:
1768
+ * ```
1769
+ * {
1916
1770
  * "_expands": [],
1917
1771
  * "size": 1,
1918
1772
  * "start": 1,
@@ -1921,10 +1775,8 @@ export declare class RequestService extends CommonHttpService {
1921
1775
  * "_links": {
1922
1776
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
1923
1777
  * "context": "context",
1924
- * "next":
1925
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment?start=2&limit=1",
1926
- * "prev":
1927
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment?start=0&limit=1"
1778
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment?start=2&limit=1",
1779
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment?start=0&limit=1"
1928
1780
  * },
1929
1781
  * "values": [
1930
1782
  * {
@@ -1936,31 +1788,22 @@ export declare class RequestService extends CommonHttpService {
1936
1788
  * "body": "Hello there",
1937
1789
  * "public": true,
1938
1790
  * "author": {
1939
- * "accountId":
1940
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1941
- * "name":
1942
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1943
- * "key":
1944
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1791
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1792
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1793
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1945
1794
  * "emailAddress": "fred@example.com",
1946
1795
  * "displayName": "Fred F. User",
1947
1796
  * "active": true,
1948
1797
  * "timeZone": "Australia/Sydney",
1949
1798
  * "_links": {
1950
- * "jiraRest":
1951
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1799
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1952
1800
  * "avatarUrls": {
1953
- * "16x16":
1954
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1955
- * "24x24":
1956
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1957
- * "32x32":
1958
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1959
- * "48x48":
1960
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1801
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1802
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1803
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1804
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1961
1805
  * },
1962
- * "self":
1963
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1806
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1964
1807
  * }
1965
1808
  * },
1966
1809
  * "created": {
@@ -1970,16 +1813,17 @@ export declare class RequestService extends CommonHttpService {
1970
1813
  * "jira": "2015-10-09T10:22:00.000+0700"
1971
1814
  * },
1972
1815
  * "_links": {
1973
- * "self":
1974
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
1816
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
1975
1817
  * }
1976
1818
  * }
1977
1819
  * ]
1978
1820
  * }
1979
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/comment
1821
+ * ```
1822
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/comment`
1980
1823
  * @scopes-current read:servicedesk-request
1981
1824
  * @scopes-beta read:request.comment:jira-service-management, read:user:jira
1982
1825
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-get
1826
+ * @param params
1983
1827
  */
1984
1828
  getRequestComments: ({ issueIdOrKey, public: publicQuery, internal, expand, start, limit, }: {
1985
1829
  /** The ID or key of the customer request whose comments will be retrieved. */
@@ -2015,10 +1859,11 @@ export declare class RequestService extends CommonHttpService {
2015
1859
  * **[Permissions](#permissions) required**: Permission to view the customer
2016
1860
  * request.
2017
1861
  *
2018
- * @returns Returns the customer request's participants, on the specified page of the
2019
- * results.
1862
+ * @returns Returns the customer request's participants, on the specified page of the results.
2020
1863
  *
2021
- * example: {
1864
+ * example:
1865
+ * ```
1866
+ * {
2022
1867
  * "_expands": [],
2023
1868
  * "size": 1,
2024
1869
  * "start": 1,
@@ -2027,15 +1872,12 @@ export declare class RequestService extends CommonHttpService {
2027
1872
  * "_links": {
2028
1873
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
2029
1874
  * "context": "context",
2030
- * "next":
2031
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
2032
- * "prev":
2033
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
1875
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
1876
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
2034
1877
  * },
2035
1878
  * "values": [
2036
1879
  * {
2037
- * "accountId":
2038
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1880
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2039
1881
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2040
1882
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2041
1883
  * "emailAddress": "fred@example.com",
@@ -2043,28 +1885,24 @@ export declare class RequestService extends CommonHttpService {
2043
1885
  * "active": true,
2044
1886
  * "timeZone": "Australia/Sydney",
2045
1887
  * "_links": {
2046
- * "jiraRest":
2047
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1888
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2048
1889
  * "avatarUrls": {
2049
- * "16x16":
2050
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
2051
- * "24x24":
2052
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
2053
- * "32x32":
2054
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
2055
- * "48x48":
2056
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1890
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1891
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1892
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1893
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
2057
1894
  * },
2058
- * "self":
2059
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1895
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
2060
1896
  * }
2061
1897
  * }
2062
1898
  * ]
2063
1899
  * }
2064
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/participant
1900
+ * ```
1901
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/participant`
2065
1902
  * @scopes-current read:servicedesk-request
2066
1903
  * @scopes-beta read:request.participant:jira-service-management, read:user:jira
2067
1904
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-participant-get
1905
+ * @param params
2068
1906
  */
2069
1907
  getRequestParticipants: ({ issueIdOrKey, start, limit, }: {
2070
1908
  /** The ID or key of the customer request to be queried for its participants. */
@@ -2090,10 +1928,11 @@ export declare class RequestService extends CommonHttpService {
2090
1928
  * **[Permissions](#permissions) required**: Agent for the Service Desk containing
2091
1929
  * the queried customer request.
2092
1930
  *
2093
- * @returns Returns the SLA records on the customer request, on the specified page of the
2094
- * results.
1931
+ * @returns Returns the SLA records on the customer request, on the specified page of the results.
2095
1932
  *
2096
- * example: {
1933
+ * example:
1934
+ * ```
1935
+ * {
2097
1936
  * "_expands": [],
2098
1937
  * "size": 3,
2099
1938
  * "start": 3,
@@ -2102,17 +1941,14 @@ export declare class RequestService extends CommonHttpService {
2102
1941
  * "_links": {
2103
1942
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
2104
1943
  * "context": "context",
2105
- * "next":
2106
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla?start=6&limit=3",
2107
- * "prev":
2108
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla?start=0&limit=3"
1944
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla?start=6&limit=3",
1945
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla?start=0&limit=3"
2109
1946
  * },
2110
1947
  * "values": [
2111
1948
  * {
2112
1949
  * "name": "Time To First Response",
2113
1950
  * "_links": {
2114
- * "self":
2115
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10030"
1951
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10030"
2116
1952
  * },
2117
1953
  * "completedCycles": [
2118
1954
  * {
@@ -2209,8 +2045,7 @@ export declare class RequestService extends CommonHttpService {
2209
2045
  * {
2210
2046
  * "name": "Time To Resolution",
2211
2047
  * "_links": {
2212
- * "self":
2213
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10040"
2048
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10040"
2214
2049
  * },
2215
2050
  * "completedCycles": [
2216
2051
  * {
@@ -2307,8 +2142,7 @@ export declare class RequestService extends CommonHttpService {
2307
2142
  * {
2308
2143
  * "name": "Time To Retrospective",
2309
2144
  * "_links": {
2310
- * "self":
2311
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10050"
2145
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10050"
2312
2146
  * },
2313
2147
  * "completedCycles": [
2314
2148
  * {
@@ -2404,10 +2238,12 @@ export declare class RequestService extends CommonHttpService {
2404
2238
  * }
2405
2239
  * ]
2406
2240
  * }
2407
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/sla
2241
+ * ```
2242
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/sla`
2408
2243
  * @scopes-current read:jira-work
2409
2244
  * @scopes-beta read:request.sla:jira-service-management
2410
2245
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-sla-get
2246
+ * @param params
2411
2247
  */
2412
2248
  getSlaInformation: ({ issueIdOrKey, start, limit, }: {
2413
2249
  /** The ID or key of the customer request whose SLAs will be retrieved. */
@@ -2431,11 +2267,12 @@ export declare class RequestService extends CommonHttpService {
2431
2267
  *
2432
2268
  * @returns Returns the SLA record, on the specified page of the results.
2433
2269
  *
2434
- * example: {
2270
+ * example:
2271
+ * ```
2272
+ * {
2435
2273
  * "name": "Time To First Response",
2436
2274
  * "_links": {
2437
- * "self":
2438
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10030"
2275
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10030"
2439
2276
  * },
2440
2277
  * "completedCycles": [
2441
2278
  * {
@@ -2529,10 +2366,12 @@ export declare class RequestService extends CommonHttpService {
2529
2366
  * }
2530
2367
  * }
2531
2368
  * }
2532
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/sla/{slaMetricId}
2369
+ * ```
2370
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/sla/{slaMetricId}`
2533
2371
  * @scopes-current read:jira-work
2534
2372
  * @scopes-beta read:request.sla:jira-service-management
2535
2373
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-sla-slametricid-get
2374
+ * @param params
2536
2375
  */
2537
2376
  getSlaInformationById: ({ issueIdOrKey, slaMetricId, }: {
2538
2377
  /** The ID or key of the customer request whose SLAs will be retrieved. */
@@ -2550,13 +2389,17 @@ export declare class RequestService extends CommonHttpService {
2550
2389
  *
2551
2390
  * @returns Returns the status of the notification subscription.
2552
2391
  *
2553
- * example: {
2392
+ * example:
2393
+ * ```
2394
+ * {
2554
2395
  * "subscribed": true
2555
2396
  * }
2556
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/notification
2397
+ * ```
2398
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/notification`
2557
2399
  * @scopes-current read:servicedesk-request
2558
2400
  * @scopes-beta read:request.notification:jira-service-management, read:user:jira
2559
2401
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-notification-get
2402
+ * @param params
2560
2403
  */
2561
2404
  getSubscriptionStatus: ({ issueIdOrKey, }: {
2562
2405
  /** The ID or key of the customer request to be queried for subscription status. */
@@ -2570,17 +2413,18 @@ export declare class RequestService extends CommonHttpService {
2570
2413
  * request and have the Transition Issues permission. If a comment is passed the
2571
2414
  * user must have the Add Comments permission.
2572
2415
  *
2573
- * @path {POST} /rest/servicedeskapi/request/{issueIdOrKey}/transition
2416
+ * @path POST `/rest/servicedeskapi/request/{issueIdOrKey}/transition`
2574
2417
  * @scopes-current write:servicedesk-request
2575
- * @scopes-beta read:request.status:jira-service-management,
2576
- * write:request.status:jira-service-management, read:user:jira
2418
+ * @scopes-beta read:request.status:jira-service-management, write:request.status:jira-service-management, read:user:jira
2577
2419
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-transition-post
2420
+ * @param params
2578
2421
  */
2579
2422
  performCustomerTransition: ({ issueIdOrKey, customerTransitionExecutionDto, }: {
2580
2423
  /** ID or key of the issue to transition */
2581
2424
  issueIdOrKey: string;
2582
2425
  /**
2583
- * @example {
2426
+ * @example
2427
+ * {
2584
2428
  * "additionalComment": {
2585
2429
  * "body": "I have fixed the problem."
2586
2430
  * },
@@ -2597,18 +2441,21 @@ export declare class RequestService extends CommonHttpService {
2597
2441
  *
2598
2442
  * @returns Returns the comment.
2599
2443
  *
2600
- * example: {
2444
+ * example:
2445
+ * ```
2446
+ * {
2601
2447
  * "type": "csat",
2602
2448
  * "rating": 4,
2603
2449
  * "comment": {
2604
2450
  * "body": "Great work!"
2605
2451
  * }
2606
2452
  * }
2607
- * @path {POST} /rest/servicedeskapi/request/{requestIdOrKey}/feedback
2453
+ * ```
2454
+ * @path POST `/rest/servicedeskapi/request/{requestIdOrKey}/feedback`
2608
2455
  * @scopes-current write:servicedesk-request
2609
- * @scopes-beta read:request.feedback:jira-service-management,
2610
- * write:request.feedback:jira-service-management, read:user:jira
2456
+ * @scopes-beta read:request.feedback:jira-service-management, write:request.feedback:jira-service-management, read:user:jira
2611
2457
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-requestidorkey-feedback-post
2458
+ * @param params
2612
2459
  */
2613
2460
  postFeedback: ({ requestIdOrKey, csatFeedbackFullDto, }: {
2614
2461
  /** The id or the key of the request to post the feedback on */
@@ -2616,7 +2463,8 @@ export declare class RequestService extends CommonHttpService {
2616
2463
  /**
2617
2464
  * The feedback to be added on the request
2618
2465
  *
2619
- * @example {
2466
+ * @example
2467
+ * {
2620
2468
  * "comment": {
2621
2469
  * "body": "Great work!"
2622
2470
  * },
@@ -2632,10 +2480,11 @@ export declare class RequestService extends CommonHttpService {
2632
2480
  * **[Permissions](#permissions) required**: Permission to manage participants on
2633
2481
  * the customer request.
2634
2482
  *
2635
- * @returns Returns the first page of the customer request's participants (after removal of
2636
- * the users).
2483
+ * @returns Returns the first page of the customer request's participants (after removal of the users).
2637
2484
  *
2638
- * example: {
2485
+ * example:
2486
+ * ```
2487
+ * {
2639
2488
  * "_expands": [],
2640
2489
  * "size": 1,
2641
2490
  * "start": 1,
@@ -2644,15 +2493,12 @@ export declare class RequestService extends CommonHttpService {
2644
2493
  * "_links": {
2645
2494
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
2646
2495
  * "context": "context",
2647
- * "next":
2648
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
2649
- * "prev":
2650
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
2496
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
2497
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
2651
2498
  * },
2652
2499
  * "values": [
2653
2500
  * {
2654
- * "accountId":
2655
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2501
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2656
2502
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2657
2503
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2658
2504
  * "emailAddress": "fred@example.com",
@@ -2660,35 +2506,31 @@ export declare class RequestService extends CommonHttpService {
2660
2506
  * "active": true,
2661
2507
  * "timeZone": "Australia/Sydney",
2662
2508
  * "_links": {
2663
- * "jiraRest":
2664
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2509
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2665
2510
  * "avatarUrls": {
2666
- * "16x16":
2667
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
2668
- * "24x24":
2669
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
2670
- * "32x32":
2671
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
2672
- * "48x48":
2673
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
2511
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
2512
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
2513
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
2514
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
2674
2515
  * },
2675
- * "self":
2676
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
2516
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
2677
2517
  * }
2678
2518
  * }
2679
2519
  * ]
2680
2520
  * }
2681
- * @path {DELETE} /rest/servicedeskapi/request/{issueIdOrKey}/participant
2521
+ * ```
2522
+ * @path DELETE `/rest/servicedeskapi/request/{issueIdOrKey}/participant`
2682
2523
  * @scopes-current write:servicedesk-request
2683
- * @scopes-beta read:request.participant:jira-service-management,
2684
- * delete:request.participant:jira-service-management, read:user:jira
2524
+ * @scopes-beta read:request.participant:jira-service-management, delete:request.participant:jira-service-management, read:user:jira
2685
2525
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-participant-delete
2526
+ * @param params
2686
2527
  */
2687
2528
  removeRequestParticipants: ({ issueIdOrKey, requestParticipantUpdateDto, }: {
2688
2529
  /** The ID or key of the customer request to have participants removed. */
2689
2530
  issueIdOrKey: string;
2690
2531
  /**
2691
- * @example {
2532
+ * @example
2533
+ * {
2692
2534
  * "accountIds": [],
2693
2535
  * "usernames": [
2694
2536
  * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
@@ -2706,11 +2548,11 @@ export declare class RequestService extends CommonHttpService {
2706
2548
  * **[Permissions](#permissions) required**: Permission to view the customer
2707
2549
  * request.
2708
2550
  *
2709
- * @path {PUT} /rest/servicedeskapi/request/{issueIdOrKey}/notification
2551
+ * @path PUT `/rest/servicedeskapi/request/{issueIdOrKey}/notification`
2710
2552
  * @scopes-current write:servicedesk-request
2711
- * @scopes-beta read:request.notification:jira-service-management,
2712
- * write:request.notification:jira-service-management, read:user:jira
2553
+ * @scopes-beta read:request.notification:jira-service-management, write:request.notification:jira-service-management, read:user:jira
2713
2554
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-notification-put
2555
+ * @param params
2714
2556
  */
2715
2557
  subscribe: ({ issueIdOrKey, }: {
2716
2558
  /** The ID or key of the customer request to be subscribed to. */
@@ -2722,11 +2564,11 @@ export declare class RequestService extends CommonHttpService {
2722
2564
  * **[Permissions](#permissions) required**: Permission to view the customer
2723
2565
  * request.
2724
2566
  *
2725
- * @path {DELETE} /rest/servicedeskapi/request/{issueIdOrKey}/notification
2567
+ * @path DELETE `/rest/servicedeskapi/request/{issueIdOrKey}/notification`
2726
2568
  * @scopes-current write:servicedesk-request
2727
- * @scopes-beta read:request.notification:jira-service-management,
2728
- * delete:request.notification:jira-service-management, read:user:jira
2569
+ * @scopes-beta read:request.notification:jira-service-management, delete:request.notification:jira-service-management, read:user:jira
2729
2570
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-notification-delete
2571
+ * @param params
2730
2572
  */
2731
2573
  unsubscribe: ({ issueIdOrKey, }: {
2732
2574
  /** The ID or key of the customer request to be unsubscribed from. */