@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
package/lib/openapi/serviceManagement/services/RequestService.js CHANGED
@@ -5,8 +5,8 @@ exports.RequestService = void 0;
5
5
  // This file is generated by "api-typescript-generator".
6
6
  // To update this file run "yarn build:openapi".
7
7
  const zod_1 = require("zod");
8
- const commonHttpClient = require("../core/CommonHttpClient");
9
- const CommonHttpService_1 = require("../core/CommonHttpService");
8
+ const commonHttpClient = require("../../core/CommonHttpClient");
9
+ const CommonHttpService_1 = require("../../core/CommonHttpService");
10
10
  const common_1 = require("../models/common");
11
11
  const request_1 = require("../models/request");
12
12
  const validationSchemaStorage_1 = require("../validationSchemaStorage");
@@ -26,7 +26,9 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
26
26
  *
27
27
  * @returns Returns the participants added to the customer request.
28
28
  *
29
- * example: {
29
+ * example:
30
+ * ```
31
+ * {
30
32
  * "_expands": [],
31
33
  * "size": 1,
32
34
  * "start": 1,
@@ -35,15 +37,12 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
35
37
  * "_links": {
36
38
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
37
39
  * "context": "context",
38
- * "next":
39
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
40
- * "prev":
41
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
40
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
41
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
42
42
  * },
43
43
  * "values": [
44
44
  * {
45
- * "accountId":
46
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
45
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
47
46
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
48
47
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
49
48
  * "emailAddress": "fred@example.com",
@@ -51,29 +50,24 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
51
50
  * "active": true,
52
51
  * "timeZone": "Australia/Sydney",
53
52
  * "_links": {
54
- * "jiraRest":
55
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
53
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
56
54
  * "avatarUrls": {
57
- * "16x16":
58
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
59
- * "24x24":
60
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
61
- * "32x32":
62
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
63
- * "48x48":
64
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
55
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
56
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
57
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
58
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
65
59
  * },
66
- * "self":
67
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
60
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
68
61
  * }
69
62
  * }
70
63
  * ]
71
64
  * }
72
- * @path {POST} /rest/servicedeskapi/request/{issueIdOrKey}/participant
65
+ * ```
66
+ * @path POST `/rest/servicedeskapi/request/{issueIdOrKey}/participant`
73
67
  * @scopes-current write:servicedesk-request
74
- * @scopes-beta read:request.participant:jira-service-management,
75
- * write:request.participant:jira-service-management, read:user:jira
68
+ * @scopes-beta read:request.participant:jira-service-management, write:request.participant:jira-service-management, read:user:jira
76
69
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-participant-post
70
+ * @param params
77
71
  */
78
72
  this.addRequestParticipants = ({ issueIdOrKey, requestParticipantUpdateDto, }) => {
79
73
  return this.getClientInstance()
@@ -107,7 +101,9 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
107
101
  *
108
102
  * @returns Returns the updated approval.
109
103
  *
110
- * example: {
104
+ * example:
105
+ * ```
106
+ * {
111
107
  * "id": "1",
112
108
  * "name": "Please approve this request",
113
109
  * "finalDecision": "approved",
@@ -115,31 +111,22 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
115
111
  * "approvers": [
116
112
  * {
117
113
  * "approver": {
118
- * "accountId":
119
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
120
- * "name":
121
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
122
- * "key":
123
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
114
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
115
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
116
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
124
117
  * "emailAddress": "fred@example.com",
125
118
  * "displayName": "Fred F. User",
126
119
  * "active": true,
127
120
  * "timeZone": "Australia/Sydney",
128
121
  * "_links": {
129
- * "jiraRest":
130
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
122
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
131
123
  * "avatarUrls": {
132
- * "16x16":
133
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
134
- * "24x24":
135
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
136
- * "32x32":
137
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
138
- * "48x48":
139
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
124
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
125
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
126
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
127
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
140
128
  * },
141
- * "self":
142
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
129
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
143
130
  * }
144
131
  * },
145
132
  * "approverDecision": "approved"
@@ -158,15 +145,15 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
158
145
  * "jira": "2016-09-29T14:30:00.000+0700"
159
146
  * },
160
147
  * "_links": {
161
- * "self":
162
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1"
148
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1"
163
149
  * }
164
150
  * }
165
- * @path {POST} /rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}
151
+ * ```
152
+ * @path POST `/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}`
166
153
  * @scopes-current write:servicedesk-request
167
- * @scopes-beta read:request.approval:jira-service-management,
168
- * write:request.approval:jira-service-management, read:user:jira
154
+ * @scopes-beta read:request.approval:jira-service-management, write:request.approval:jira-service-management, read:user:jira
169
155
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-approval-approvalid-post
156
+ * @param params
170
157
  */
171
158
  this.answerApproval = ({ issueIdOrKey, approvalId, approvalDecisionRequestDto, }) => {
172
159
  return this.getClientInstance()
@@ -208,19 +195,19 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
208
195
  *
209
196
  * @returns Returns the attachments and comment.
210
197
  *
211
- * example: {
198
+ * example:
199
+ * ```
200
+ * {
212
201
  * "comment": {
213
202
  * "_expands": [
214
203
  * "attachment",
215
204
  * "renderedBody"
216
205
  * ],
217
206
  * "id": "1000",
218
- * "body": "Please find the screenshot and the log file attached.
219
- * !screenshot.png|thumbnail! [^log.txt] _(32 kB)_",
207
+ * "body": "Please find the screenshot and the log file attached. !screenshot.png|thumbnail! [^log.txt] _(32 kB)_",
220
208
  * "public": true,
221
209
  * "author": {
222
- * "accountId":
223
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
210
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
224
211
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
225
212
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
226
213
  * "emailAddress": "fred@example.com",
@@ -228,20 +215,14 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
228
215
  * "active": true,
229
216
  * "timeZone": "Australia/Sydney",
230
217
  * "_links": {
231
- * "jiraRest":
232
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
218
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
233
219
  * "avatarUrls": {
234
- * "16x16":
235
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
236
- * "24x24":
237
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
238
- * "32x32":
239
- * "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":
241
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
220
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
221
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
222
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
223
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
242
224
  * },
243
- * "self":
244
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
225
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
245
226
  * }
246
227
  * },
247
228
  * "created": {
@@ -251,8 +232,7 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
251
232
  * "jira": "2015-10-09T10:22:00.000+0700"
252
233
  * },
253
234
  * "_links": {
254
- * "self":
255
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
235
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
256
236
  * }
257
237
  * },
258
238
  * "attachments": {
@@ -264,40 +244,29 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
264
244
  * "_links": {
265
245
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
266
246
  * "context": "context",
267
- * "next":
268
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2",
269
- * "prev":
270
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2"
247
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2",
248
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2"
271
249
  * },
272
250
  * "values": [
273
251
  * {
274
252
  * "filename": "screenshot.png",
275
253
  * "author": {
276
- * "accountId":
277
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
278
- * "name":
279
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
280
- * "key":
281
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
254
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
255
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
256
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
282
257
  * "emailAddress": "fred@example.com",
283
258
  * "displayName": "Fred F. User",
284
259
  * "active": true,
285
260
  * "timeZone": "Australia/Sydney",
286
261
  * "_links": {
287
- * "jiraRest":
288
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
262
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
289
263
  * "avatarUrls": {
290
- * "16x16":
291
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
292
- * "24x24":
293
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
294
- * "32x32":
295
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
296
- * "48x48":
297
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
264
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
265
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
266
+ * "32x32": "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": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
298
268
  * },
299
- * "self":
300
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
269
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
301
270
  * }
302
271
  * },
303
272
  * "created": {
@@ -309,42 +278,30 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
309
278
  * "size": 23123,
310
279
  * "mimeType": "image/png",
311
280
  * "_links": {
312
- * "jiraRest":
313
- * "https://your-domain.atlassian.net/rest/api/2/attachment/10000",
314
- * "content":
315
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png",
316
- * "thumbnail":
317
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png"
281
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10000",
282
+ * "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png",
283
+ * "thumbnail": "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png"
318
284
  * }
319
285
  * },
320
286
  * {
321
287
  * "filename": "log.txt",
322
288
  * "author": {
323
- * "accountId":
324
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
325
- * "name":
326
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
327
- * "key":
328
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
289
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
290
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
291
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
329
292
  * "emailAddress": "fred@example.com",
330
293
  * "displayName": "Fred F. User",
331
294
  * "active": true,
332
295
  * "timeZone": "Australia/Sydney",
333
296
  * "_links": {
334
- * "jiraRest":
335
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
297
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
336
298
  * "avatarUrls": {
337
- * "16x16":
338
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
339
- * "24x24":
340
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
341
- * "32x32":
342
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
343
- * "48x48":
344
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
299
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
300
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
301
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
302
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
345
303
  * },
346
- * "self":
347
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
304
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
348
305
  * }
349
306
  * },
350
307
  * "created": {
@@ -356,20 +313,19 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
356
313
  * "size": 32132,
357
314
  * "mimeType": "text/plain",
358
315
  * "_links": {
359
- * "jiraRest":
360
- * "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
361
- * "content":
362
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt"
316
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
317
+ * "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt"
363
318
  * }
364
319
  * }
365
320
  * ]
366
321
  * }
367
322
  * }
368
- * @path {POST} /rest/servicedeskapi/request/{issueIdOrKey}/attachment
323
+ * ```
324
+ * @path POST `/rest/servicedeskapi/request/{issueIdOrKey}/attachment`
369
325
  * @scopes-current write:servicedesk-request
370
- * @scopes-beta read:request.attachment:jira-service-management,
371
- * write:request.attachment:jira-service-management, read:user:jira
326
+ * @scopes-beta read:request.attachment:jira-service-management, write:request.attachment:jira-service-management, read:user:jira
372
327
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-post
328
+ * @param params
373
329
  */
374
330
  this.createCommentWithAttachment = ({ issueIdOrKey, attachmentCreateDto, }) => {
375
331
  return this.getClientInstance()
@@ -418,7 +374,9 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
418
374
  *
419
375
  * @returns Returned if the customer request was created.
420
376
  *
421
- * example: {
377
+ * example:
378
+ * ```
379
+ * {
422
380
  * "_expands": [
423
381
  * "participant",
424
382
  * "status",
@@ -440,8 +398,7 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
440
398
  * "jira": "2015-10-08T14:42:00.000+0700"
441
399
  * },
442
400
  * "reporter": {
443
- * "accountId":
444
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
401
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
445
402
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
446
403
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
447
404
  * "emailAddress": "fred@example.com",
@@ -449,20 +406,14 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
449
406
  * "active": true,
450
407
  * "timeZone": "Australia/Sydney",
451
408
  * "_links": {
452
- * "jiraRest":
453
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
409
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
454
410
  * "avatarUrls": {
455
- * "16x16":
456
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
457
- * "24x24":
458
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
459
- * "32x32":
460
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
461
- * "48x48":
462
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
411
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
412
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
413
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
414
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
463
415
  * },
464
- * "self":
465
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
416
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
466
417
  * }
467
418
  * },
468
419
  * "requestFieldValues": [
@@ -492,18 +443,17 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
492
443
  * },
493
444
  * "_links": {
494
445
  * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107001",
495
- * "web":
496
- * "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1",
497
- * "self":
498
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001",
446
+ * "web": "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1",
447
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001",
499
448
  * "agent": "https://your-domain.atlassian.net/browse/HELPDESK-1"
500
449
  * }
501
450
  * }
502
- * @path {POST} /rest/servicedeskapi/request
451
+ * ```
452
+ * @path POST `/rest/servicedeskapi/request`
503
453
  * @scopes-current write:servicedesk-request
504
- * @scopes-beta read:request:jira-service-management, write:request:jira-service-management,
505
- * read:user:jira
454
+ * @scopes-beta read:request:jira-service-management, write:request:jira-service-management, read:user:jira
506
455
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-post
456
+ * @param params
507
457
  */
508
458
  this.createCustomerRequest = ({ requestCreateDto, }) => {
509
459
  return this.getClientInstance()
@@ -535,7 +485,9 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
535
485
  *
536
486
  * @returns Returns the comment.
537
487
  *
538
- * example: {
488
+ * example:
489
+ * ```
490
+ * {
539
491
  * "_expands": [
540
492
  * "attachment",
541
493
  * "renderedBody"
@@ -544,8 +496,7 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
544
496
  * "body": "Hello there",
545
497
  * "public": true,
546
498
  * "author": {
547
- * "accountId":
548
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
499
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
549
500
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
550
501
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
551
502
  * "emailAddress": "fred@example.com",
@@ -553,20 +504,14 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
553
504
  * "active": true,
554
505
  * "timeZone": "Australia/Sydney",
555
506
  * "_links": {
556
- * "jiraRest":
557
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
507
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
558
508
  * "avatarUrls": {
559
- * "16x16":
560
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
561
- * "24x24":
562
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
563
- * "32x32":
564
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
565
- * "48x48":
566
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
509
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
510
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
511
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
512
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
567
513
  * },
568
- * "self":
569
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
514
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
570
515
  * }
571
516
  * },
572
517
  * "created": {
@@ -576,15 +521,15 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
576
521
  * "jira": "2015-10-09T10:22:00.000+0700"
577
522
  * },
578
523
  * "_links": {
579
- * "self":
580
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
524
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
581
525
  * }
582
526
  * }
583
- * @path {POST} /rest/servicedeskapi/request/{issueIdOrKey}/comment
527
+ * ```
528
+ * @path POST `/rest/servicedeskapi/request/{issueIdOrKey}/comment`
584
529
  * @scopes-current write:servicedesk-request
585
- * @scopes-beta read:request.comment:jira-service-management,
586
- * write:request.comment:jira-service-management, read:user:jira
530
+ * @scopes-beta read:request.comment:jira-service-management, write:request.comment:jira-service-management, read:user:jira
587
531
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-post
532
+ * @param params
588
533
  */
589
534
  this.createRequestComment = ({ issueIdOrKey, commentCreateDto, }) => {
590
535
  return this.getClientInstance()
@@ -616,11 +561,11 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
616
561
  * Atlassian Connect app.
617
562
  *
618
563
  * @returns No content.
619
- * @path {DELETE} /rest/servicedeskapi/request/{requestIdOrKey}/feedback
564
+ * @path DELETE `/rest/servicedeskapi/request/{requestIdOrKey}/feedback`
620
565
  * @scopes-current write:servicedesk-request
621
- * @scopes-beta read:request.feedback:jira-service-management,
622
- * delete:request.feedback:jira-service-management, read:user:jira
566
+ * @scopes-beta read:request.feedback:jira-service-management, delete:request.feedback:jira-service-management, read:user:jira
623
567
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-requestidorkey-feedback-delete
568
+ * @param params
624
569
  */
625
570
  this.deleteFeedback = ({ requestIdOrKey, }) => {
626
571
  return this.getClientInstance()
@@ -649,7 +594,9 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
649
594
  *
650
595
  * @returns Returns the requested approval.
651
596
  *
652
- * example: {
597
+ * example:
598
+ * ```
599
+ * {
653
600
  * "id": "1",
654
601
  * "name": "Please approve this request",
655
602
  * "finalDecision": "approved",
@@ -657,31 +604,22 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
657
604
  * "approvers": [
658
605
  * {
659
606
  * "approver": {
660
- * "accountId":
661
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
662
- * "name":
663
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
664
- * "key":
665
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
607
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
608
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
609
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
666
610
  * "emailAddress": "fred@example.com",
667
611
  * "displayName": "Fred F. User",
668
612
  * "active": true,
669
613
  * "timeZone": "Australia/Sydney",
670
614
  * "_links": {
671
- * "jiraRest":
672
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
615
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
673
616
  * "avatarUrls": {
674
- * "16x16":
675
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
676
- * "24x24":
677
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
678
- * "32x32":
679
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
680
- * "48x48":
681
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
617
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
618
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
619
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
620
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
682
621
  * },
683
- * "self":
684
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
622
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
685
623
  * }
686
624
  * },
687
625
  * "approverDecision": "approved"
@@ -700,14 +638,15 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
700
638
  * "jira": "2016-09-29T14:30:00.000+0700"
701
639
  * },
702
640
  * "_links": {
703
- * "self":
704
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1"
641
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1"
705
642
  * }
706
643
  * }
707
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}
644
+ * ```
645
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}`
708
646
  * @scopes-current read:servicedesk-request
709
647
  * @scopes-beta read:request.approval:jira-service-management, read:user:jira
710
648
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-approval-approvalid-get
649
+ * @param params
711
650
  */
712
651
  this.getApprovalById = ({ issueIdOrKey, approvalId, }) => {
713
652
  return this.getClientInstance()
@@ -736,7 +675,9 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
736
675
  *
737
676
  * @returns Returns the customer request's approvals.
738
677
  *
739
- * example: {
678
+ * example:
679
+ * ```
680
+ * {
740
681
  * "_expands": [],
741
682
  * "size": 3,
742
683
  * "start": 3,
@@ -745,10 +686,8 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
745
686
  * "_links": {
746
687
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
747
688
  * "context": "context",
748
- * "next":
749
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval?start=6&limit=3",
750
- * "prev":
751
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval?start=0&limit=3"
689
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval?start=6&limit=3",
690
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval?start=0&limit=3"
752
691
  * },
753
692
  * "values": [
754
693
  * {
@@ -759,31 +698,22 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
759
698
  * "approvers": [
760
699
  * {
761
700
  * "approver": {
762
- * "accountId":
763
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
764
- * "name":
765
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
766
- * "key":
767
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
701
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
702
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
703
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
768
704
  * "emailAddress": "fred@example.com",
769
705
  * "displayName": "Fred F. User",
770
706
  * "active": true,
771
707
  * "timeZone": "Australia/Sydney",
772
708
  * "_links": {
773
- * "jiraRest":
774
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
709
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
775
710
  * "avatarUrls": {
776
- * "16x16":
777
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
778
- * "24x24":
779
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
780
- * "32x32":
781
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
782
- * "48x48":
783
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
711
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
712
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
713
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
714
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
784
715
  * },
785
- * "self":
786
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
716
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
787
717
  * }
788
718
  * },
789
719
  * "approverDecision": "approved"
@@ -802,8 +732,7 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
802
732
  * "jira": "2016-09-29T14:30:00.000+0700"
803
733
  * },
804
734
  * "_links": {
805
- * "self":
806
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1"
735
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1"
807
736
  * }
808
737
  * },
809
738
  * {
@@ -814,31 +743,22 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
814
743
  * "approvers": [
815
744
  * {
816
745
  * "approver": {
817
- * "accountId":
818
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
819
- * "name":
820
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
821
- * "key":
822
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
746
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
747
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
748
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
823
749
  * "emailAddress": "fred@example.com",
824
750
  * "displayName": "Fred F. User",
825
751
  * "active": true,
826
752
  * "timeZone": "Australia/Sydney",
827
753
  * "_links": {
828
- * "jiraRest":
829
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
754
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
830
755
  * "avatarUrls": {
831
- * "16x16":
832
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
833
- * "24x24":
834
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
835
- * "32x32":
836
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
837
- * "48x48":
838
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
756
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
757
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
758
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
759
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
839
760
  * },
840
- * "self":
841
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
761
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
842
762
  * }
843
763
  * },
844
764
  * "approverDecision": "approved"
@@ -857,16 +777,17 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
857
777
  * "jira": "2016-10-06T14:30:00.000+0700"
858
778
  * },
859
779
  * "_links": {
860
- * "self":
861
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/2"
780
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/2"
862
781
  * }
863
782
  * }
864
783
  * ]
865
784
  * }
866
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/approval
785
+ * ```
786
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/approval`
867
787
  * @scopes-current read:servicedesk-request
868
788
  * @scopes-beta read:request.approval:jira-service-management, read:user:jira
869
789
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-approval-get
790
+ * @param params
870
791
  */
871
792
  this.getApprovals = ({ issueIdOrKey, start, limit, }) => {
872
793
  return this.getClientInstance()
@@ -906,10 +827,11 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
906
827
  * configured, issue-level security permission to view the issue.
907
828
  *
908
829
  * @returns 200 response
909
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}
830
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}`
910
831
  * @scopes-current read:servicedesk-request
911
832
  * @scopes-beta read:request.attachment:jira-service-management, read:user:jira
912
833
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-get
834
+ * @param params
913
835
  */
914
836
  this.getAttachmentContent = ({ issueIdOrKey, attachmentId, }) => {
915
837
  return this.getClientInstance()
@@ -940,7 +862,9 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
940
862
  *
941
863
  * @returns Returns the visible attachments from the customer request.
942
864
  *
943
- * example: {
865
+ * example:
866
+ * ```
867
+ * {
944
868
  * "_expands": [],
945
869
  * "size": 2,
946
870
  * "start": 2,
@@ -949,40 +873,29 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
949
873
  * "_links": {
950
874
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
951
875
  * "context": "context",
952
- * "next":
953
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2",
954
- * "prev":
955
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2"
876
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2",
877
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2"
956
878
  * },
957
879
  * "values": [
958
880
  * {
959
881
  * "filename": "screenshot.png",
960
882
  * "author": {
961
- * "accountId":
962
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
963
- * "name":
964
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
965
- * "key":
966
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
883
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
884
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
885
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
967
886
  * "emailAddress": "fred@example.com",
968
887
  * "displayName": "Fred F. User",
969
888
  * "active": true,
970
889
  * "timeZone": "Australia/Sydney",
971
890
  * "_links": {
972
- * "jiraRest":
973
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
891
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
974
892
  * "avatarUrls": {
975
- * "16x16":
976
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
977
- * "24x24":
978
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
979
- * "32x32":
980
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
981
- * "48x48":
982
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
893
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
894
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
895
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
896
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
983
897
  * },
984
- * "self":
985
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
898
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
986
899
  * }
987
900
  * },
988
901
  * "created": {
@@ -994,42 +907,30 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
994
907
  * "size": 23123,
995
908
  * "mimeType": "image/png",
996
909
  * "_links": {
997
- * "jiraRest":
998
- * "https://your-domain.atlassian.net/rest/api/2/attachment/10000",
999
- * "content":
1000
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png",
1001
- * "thumbnail":
1002
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png"
910
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10000",
911
+ * "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png",
912
+ * "thumbnail": "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png"
1003
913
  * }
1004
914
  * },
1005
915
  * {
1006
916
  * "filename": "log.txt",
1007
917
  * "author": {
1008
- * "accountId":
1009
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1010
- * "name":
1011
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1012
- * "key":
1013
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
918
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
919
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
920
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1014
921
  * "emailAddress": "fred@example.com",
1015
922
  * "displayName": "Fred F. User",
1016
923
  * "active": true,
1017
924
  * "timeZone": "Australia/Sydney",
1018
925
  * "_links": {
1019
- * "jiraRest":
1020
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
926
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1021
927
  * "avatarUrls": {
1022
- * "16x16":
1023
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1024
- * "24x24":
1025
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1026
- * "32x32":
1027
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1028
- * "48x48":
1029
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
928
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
929
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
930
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
931
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1030
932
  * },
1031
- * "self":
1032
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
933
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1033
934
  * }
1034
935
  * },
1035
936
  * "created": {
@@ -1041,18 +942,18 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1041
942
  * "size": 32132,
1042
943
  * "mimeType": "text/plain",
1043
944
  * "_links": {
1044
- * "jiraRest":
1045
- * "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
1046
- * "content":
1047
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt"
945
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
946
+ * "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt"
1048
947
  * }
1049
948
  * }
1050
949
  * ]
1051
950
  * }
1052
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/attachment
951
+ * ```
952
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/attachment`
1053
953
  * @scopes-current read:servicedesk-request
1054
954
  * @scopes-beta read:request.attachment:jira-service-management, read:user:jira
1055
955
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-get
956
+ * @param params
1056
957
  */
1057
958
  this.getAttachmentsForRequest = ({ issueIdOrKey, start, limit, }) => {
1058
959
  return this.getClientInstance()
@@ -1092,11 +993,11 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1092
993
  * configured, issue-level security permission to view the issue.
1093
994
  *
1094
995
  * @returns 200 response
1095
- * @path {GET}
1096
- * /rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}/thumbnail
996
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}/thumbnail`
1097
997
  * @scopes-current read:servicedesk-request
1098
998
  * @scopes-beta read:request.attachment:jira-service-management, read:user:jira
1099
999
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-thumbnail-get
1000
+ * @param params
1100
1001
  */
1101
1002
  this.getAttachmentThumbnail = ({ issueIdOrKey, attachmentId, }) => {
1102
1003
  return this.getClientInstance()
@@ -1129,7 +1030,9 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1129
1030
  *
1130
1031
  * @returns Returns the attachments, on the specified page of the results.
1131
1032
  *
1132
- * example: {
1033
+ * example:
1034
+ * ```
1035
+ * {
1133
1036
  * "_expands": [],
1134
1037
  * "size": 2,
1135
1038
  * "start": 2,
@@ -1138,40 +1041,29 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1138
1041
  * "_links": {
1139
1042
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
1140
1043
  * "context": "context",
1141
- * "next":
1142
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2",
1143
- * "prev":
1144
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2"
1044
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2",
1045
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2"
1145
1046
  * },
1146
1047
  * "values": [
1147
1048
  * {
1148
1049
  * "filename": "screenshot.png",
1149
1050
  * "author": {
1150
- * "accountId":
1151
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1152
- * "name":
1153
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1154
- * "key":
1155
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1051
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1052
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1053
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1156
1054
  * "emailAddress": "fred@example.com",
1157
1055
  * "displayName": "Fred F. User",
1158
1056
  * "active": true,
1159
1057
  * "timeZone": "Australia/Sydney",
1160
1058
  * "_links": {
1161
- * "jiraRest":
1162
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1059
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1163
1060
  * "avatarUrls": {
1164
- * "16x16":
1165
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1166
- * "24x24":
1167
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1168
- * "32x32":
1169
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1170
- * "48x48":
1171
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1061
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1062
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1063
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1064
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1172
1065
  * },
1173
- * "self":
1174
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1066
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1175
1067
  * }
1176
1068
  * },
1177
1069
  * "created": {
@@ -1183,42 +1075,30 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1183
1075
  * "size": 23123,
1184
1076
  * "mimeType": "image/png",
1185
1077
  * "_links": {
1186
- * "jiraRest":
1187
- * "https://your-domain.atlassian.net/rest/api/2/attachment/10000",
1188
- * "content":
1189
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png",
1190
- * "thumbnail":
1191
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png"
1078
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10000",
1079
+ * "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png",
1080
+ * "thumbnail": "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png"
1192
1081
  * }
1193
1082
  * },
1194
1083
  * {
1195
1084
  * "filename": "log.txt",
1196
1085
  * "author": {
1197
- * "accountId":
1198
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1199
- * "name":
1200
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1201
- * "key":
1202
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1086
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1087
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1088
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1203
1089
  * "emailAddress": "fred@example.com",
1204
1090
  * "displayName": "Fred F. User",
1205
1091
  * "active": true,
1206
1092
  * "timeZone": "Australia/Sydney",
1207
1093
  * "_links": {
1208
- * "jiraRest":
1209
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1094
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1210
1095
  * "avatarUrls": {
1211
- * "16x16":
1212
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1213
- * "24x24":
1214
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1215
- * "32x32":
1216
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1217
- * "48x48":
1218
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1096
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1097
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1098
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1099
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1219
1100
  * },
1220
- * "self":
1221
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1101
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1222
1102
  * }
1223
1103
  * },
1224
1104
  * "created": {
@@ -1230,16 +1110,16 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1230
1110
  * "size": 32132,
1231
1111
  * "mimeType": "text/plain",
1232
1112
  * "_links": {
1233
- * "jiraRest":
1234
- * "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
1235
- * "content":
1236
- * "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt"
1113
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
1114
+ * "content": "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt"
1237
1115
  * }
1238
1116
  * }
1239
1117
  * ]
1240
1118
  * }
1241
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment
1119
+ * ```
1120
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment`
1242
1121
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-commentid-attachment-get
1122
+ * @param params
1243
1123
  */
1244
1124
  this.getCommentAttachments = ({ issueIdOrKey, commentId, start, limit, }) => {
1245
1125
  return this.getClientInstance()
@@ -1279,7 +1159,9 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1279
1159
  *
1280
1160
  * @returns Returns the customer request.
1281
1161
  *
1282
- * example: {
1162
+ * example:
1163
+ * ```
1164
+ * {
1283
1165
  * "_expands": [
1284
1166
  * "participant",
1285
1167
  * "status",
@@ -1301,8 +1183,7 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1301
1183
  * "jira": "2015-10-08T14:42:00.000+0700"
1302
1184
  * },
1303
1185
  * "reporter": {
1304
- * "accountId":
1305
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1186
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1306
1187
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1307
1188
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1308
1189
  * "emailAddress": "fred@example.com",
@@ -1310,20 +1191,14 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1310
1191
  * "active": true,
1311
1192
  * "timeZone": "Australia/Sydney",
1312
1193
  * "_links": {
1313
- * "jiraRest":
1314
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1194
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1315
1195
  * "avatarUrls": {
1316
- * "16x16":
1317
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1318
- * "24x24":
1319
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1320
- * "32x32":
1321
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1322
- * "48x48":
1323
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1196
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1197
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1198
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1199
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1324
1200
  * },
1325
- * "self":
1326
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1201
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1327
1202
  * }
1328
1203
  * },
1329
1204
  * "requestFieldValues": [
@@ -1353,17 +1228,17 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1353
1228
  * },
1354
1229
  * "_links": {
1355
1230
  * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107001",
1356
- * "web":
1357
- * "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1",
1358
- * "self":
1359
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001",
1231
+ * "web": "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1",
1232
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001",
1360
1233
  * "agent": "https://your-domain.atlassian.net/browse/HELPDESK-1"
1361
1234
  * }
1362
1235
  * }
1363
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}
1236
+ * ```
1237
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}`
1364
1238
  * @scopes-current read:servicedesk-request
1365
1239
  * @scopes-beta read:request:jira-service-management, read:user:jira
1366
1240
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-get
1241
+ * @param params
1367
1242
  */
1368
1243
  this.getCustomerRequestByIdOrKey = ({ issueIdOrKey, expand, }) => {
1369
1244
  return this.getClientInstance()
@@ -1400,7 +1275,9 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1400
1275
  *
1401
1276
  * @returns Returns the customer requests, on the specified page of the results.
1402
1277
  *
1403
- * example: {
1278
+ * example:
1279
+ * ```
1280
+ * {
1404
1281
  * "_expands": [
1405
1282
  * "participant",
1406
1283
  * "status",
@@ -1418,10 +1295,8 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1418
1295
  * "_links": {
1419
1296
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
1420
1297
  * "context": "context",
1421
- * "next":
1422
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request?start=6&limit=3",
1423
- * "prev":
1424
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request?start=0&limit=3"
1298
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request?start=6&limit=3",
1299
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request?start=0&limit=3"
1425
1300
  * },
1426
1301
  * "values": [
1427
1302
  * {
@@ -1446,31 +1321,22 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1446
1321
  * "jira": "2015-10-08T14:42:00.000+0700"
1447
1322
  * },
1448
1323
  * "reporter": {
1449
- * "accountId":
1450
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1451
- * "name":
1452
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1453
- * "key":
1454
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1324
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1325
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1326
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1455
1327
  * "emailAddress": "fred@example.com",
1456
1328
  * "displayName": "Fred F. User",
1457
1329
  * "active": true,
1458
1330
  * "timeZone": "Australia/Sydney",
1459
1331
  * "_links": {
1460
- * "jiraRest":
1461
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1332
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1462
1333
  * "avatarUrls": {
1463
- * "16x16":
1464
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1465
- * "24x24":
1466
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1467
- * "32x32":
1468
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1469
- * "48x48":
1470
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1334
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1335
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1336
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1337
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1471
1338
  * },
1472
- * "self":
1473
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1339
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1474
1340
  * }
1475
1341
  * },
1476
1342
  * "requestFieldValues": [
@@ -1500,10 +1366,8 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1500
1366
  * },
1501
1367
  * "_links": {
1502
1368
  * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107001",
1503
- * "web":
1504
- * "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1",
1505
- * "self":
1506
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001",
1369
+ * "web": "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1",
1370
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001",
1507
1371
  * "agent": "https://your-domain.atlassian.net/browse/HELPDESK-1"
1508
1372
  * }
1509
1373
  * },
@@ -1529,31 +1393,22 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1529
1393
  * "jira": "2015-10-08T14:30:00.000+0700"
1530
1394
  * },
1531
1395
  * "reporter": {
1532
- * "accountId":
1533
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1534
- * "name":
1535
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1536
- * "key":
1537
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1396
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1397
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1398
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1538
1399
  * "emailAddress": "fred@example.com",
1539
1400
  * "displayName": "Fred F. User",
1540
1401
  * "active": true,
1541
1402
  * "timeZone": "Australia/Sydney",
1542
1403
  * "_links": {
1543
- * "jiraRest":
1544
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1404
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1545
1405
  * "avatarUrls": {
1546
- * "16x16":
1547
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1548
- * "24x24":
1549
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1550
- * "32x32":
1551
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1552
- * "48x48":
1553
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1406
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1407
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1408
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1409
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1554
1410
  * },
1555
- * "self":
1556
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1411
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1557
1412
  * }
1558
1413
  * },
1559
1414
  * "requestFieldValues": [
@@ -1580,10 +1435,8 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1580
1435
  * },
1581
1436
  * "_links": {
1582
1437
  * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107002",
1583
- * "web":
1584
- * "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-2",
1585
- * "self":
1586
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/107002",
1438
+ * "web": "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-2",
1439
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/107002",
1587
1440
  * "agent": "https://your-domain.atlassian.net/browse/HELPDESK-2"
1588
1441
  * }
1589
1442
  * },
@@ -1609,31 +1462,22 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1609
1462
  * "jira": "2015-10-05T14:30:00.000+0700"
1610
1463
  * },
1611
1464
  * "reporter": {
1612
- * "accountId":
1613
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1614
- * "name":
1615
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1616
- * "key":
1617
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1465
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1466
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1467
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1618
1468
  * "emailAddress": "fred@example.com",
1619
1469
  * "displayName": "Fred F. User",
1620
1470
  * "active": true,
1621
1471
  * "timeZone": "Australia/Sydney",
1622
1472
  * "_links": {
1623
- * "jiraRest":
1624
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1473
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1625
1474
  * "avatarUrls": {
1626
- * "16x16":
1627
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1628
- * "24x24":
1629
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1630
- * "32x32":
1631
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1632
- * "48x48":
1633
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1475
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1476
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1477
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1478
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1634
1479
  * },
1635
- * "self":
1636
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1480
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1637
1481
  * }
1638
1482
  * },
1639
1483
  * "requestFieldValues": [
@@ -1659,19 +1503,19 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1659
1503
  * },
1660
1504
  * "_links": {
1661
1505
  * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/109006",
1662
- * "web":
1663
- * "https://your-domain.atlassian.net/servicedesk/customer/portal/12/SIMPLEDESK-6",
1664
- * "self":
1665
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/109006",
1506
+ * "web": "https://your-domain.atlassian.net/servicedesk/customer/portal/12/SIMPLEDESK-6",
1507
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/109006",
1666
1508
  * "agent": "https://your-domain.atlassian.net/browse/SIMPLEDESK-6"
1667
1509
  * }
1668
1510
  * }
1669
1511
  * ]
1670
1512
  * }
1671
- * @path {GET} /rest/servicedeskapi/request
1513
+ * ```
1514
+ * @path GET `/rest/servicedeskapi/request`
1672
1515
  * @scopes-current read:servicedesk-request
1673
1516
  * @scopes-beta read:request:jira-service-management, read:user:jira
1674
1517
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-get
1518
+ * @param params
1675
1519
  */
1676
1520
  this.getCustomerRequests = ({ searchTerm, requestOwnership, requestStatus, approvalStatus, organizationId, serviceDeskId, requestTypeId, expand, start, limit, } = {}) => {
1677
1521
  return this.getClientInstance()
@@ -1709,10 +1553,11 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1709
1553
  * **[Permissions](#permissions) required**: Permission to view the customer
1710
1554
  * request.
1711
1555
  *
1712
- * @returns Returns the customer request's status history, on the specified page of the
1713
- * results.
1556
+ * @returns Returns the customer request's status history, on the specified page of the results.
1714
1557
  *
1715
- * example: {
1558
+ * example:
1559
+ * ```
1560
+ * {
1716
1561
  * "_expands": [],
1717
1562
  * "size": 3,
1718
1563
  * "start": 3,
@@ -1721,10 +1566,8 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1721
1566
  * "_links": {
1722
1567
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
1723
1568
  * "context": "context",
1724
- * "next":
1725
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/status?start=6&limit=3",
1726
- * "prev":
1727
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/status?start=0&limit=3"
1569
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/status?start=6&limit=3",
1570
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/status?start=0&limit=3"
1728
1571
  * },
1729
1572
  * "values": [
1730
1573
  * {
@@ -1756,10 +1599,12 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1756
1599
  * }
1757
1600
  * ]
1758
1601
  * }
1759
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/status
1602
+ * ```
1603
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/status`
1760
1604
  * @scopes-current read:servicedesk-request
1761
1605
  * @scopes-beta read:request.status:jira-service-management, read:user:jira
1762
1606
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-status-get
1607
+ * @param params
1763
1608
  */
1764
1609
  this.getCustomerRequestStatus = ({ issueIdOrKey, start, limit, }) => {
1765
1610
  return this.getClientInstance()
@@ -1794,7 +1639,9 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1794
1639
  *
1795
1640
  * @returns Returns the transitions available to the user on the customer request.
1796
1641
  *
1797
- * example: {
1642
+ * example:
1643
+ * ```
1644
+ * {
1798
1645
  * "_expands": [],
1799
1646
  * "size": 2,
1800
1647
  * "start": 2,
@@ -1803,10 +1650,8 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1803
1650
  * "_links": {
1804
1651
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
1805
1652
  * "context": "context",
1806
- * "next":
1807
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/transition?start=4&limit=2",
1808
- * "prev":
1809
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/transition?start=0&limit=2"
1653
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/transition?start=4&limit=2",
1654
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/transition?start=0&limit=2"
1810
1655
  * },
1811
1656
  * "values": [
1812
1657
  * {
@@ -1819,10 +1664,12 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1819
1664
  * }
1820
1665
  * ]
1821
1666
  * }
1822
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/transition
1667
+ * ```
1668
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/transition`
1823
1669
  * @scopes-current read:servicedesk-request
1824
1670
  * @scopes-beta read:request.status:jira-service-management, read:user:jira
1825
1671
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-transition-get
1672
+ * @param params
1826
1673
  */
1827
1674
  this.getCustomerTransitions = ({ issueIdOrKey, start, limit, }) => {
1828
1675
  return this.getClientInstance()
@@ -1854,17 +1701,21 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1854
1701
  *
1855
1702
  * @returns Returns the comment.
1856
1703
  *
1857
- * example: {
1704
+ * example:
1705
+ * ```
1706
+ * {
1858
1707
  * "type": "csat",
1859
1708
  * "rating": 4,
1860
1709
  * "comment": {
1861
1710
  * "body": "Great work!"
1862
1711
  * }
1863
1712
  * }
1864
- * @path {GET} /rest/servicedeskapi/request/{requestIdOrKey}/feedback
1713
+ * ```
1714
+ * @path GET `/rest/servicedeskapi/request/{requestIdOrKey}/feedback`
1865
1715
  * @scopes-current read:servicedesk-request
1866
1716
  * @scopes-beta read:request.feedback:jira-service-management, read:user:jira
1867
1717
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-requestidorkey-feedback-get
1718
+ * @param params
1868
1719
  */
1869
1720
  this.getFeedback = ({ requestIdOrKey, }) => {
1870
1721
  return this.getClientInstance()
@@ -1896,7 +1747,9 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1896
1747
  *
1897
1748
  * @returns Returns the comment.
1898
1749
  *
1899
- * example: {
1750
+ * example:
1751
+ * ```
1752
+ * {
1900
1753
  * "_expands": [
1901
1754
  * "attachment",
1902
1755
  * "renderedBody"
@@ -1905,8 +1758,7 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1905
1758
  * "body": "Hello there",
1906
1759
  * "public": true,
1907
1760
  * "author": {
1908
- * "accountId":
1909
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1761
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1910
1762
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1911
1763
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1912
1764
  * "emailAddress": "fred@example.com",
@@ -1914,20 +1766,14 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1914
1766
  * "active": true,
1915
1767
  * "timeZone": "Australia/Sydney",
1916
1768
  * "_links": {
1917
- * "jiraRest":
1918
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1769
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1919
1770
  * "avatarUrls": {
1920
- * "16x16":
1921
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1922
- * "24x24":
1923
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1924
- * "32x32":
1925
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1926
- * "48x48":
1927
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1771
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1772
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1773
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1774
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1928
1775
  * },
1929
- * "self":
1930
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1776
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1931
1777
  * }
1932
1778
  * },
1933
1779
  * "created": {
@@ -1937,14 +1783,15 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1937
1783
  * "jira": "2015-10-09T10:22:00.000+0700"
1938
1784
  * },
1939
1785
  * "_links": {
1940
- * "self":
1941
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
1786
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
1942
1787
  * }
1943
1788
  * }
1944
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}
1789
+ * ```
1790
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}`
1945
1791
  * @scopes-current read:servicedesk-request
1946
1792
  * @scopes-beta read:request.comment:jira-service-management, read:user:jira
1947
1793
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-commentid-get
1794
+ * @param params
1948
1795
  */
1949
1796
  this.getRequestCommentById = ({ issueIdOrKey, commentId, expand, }) => {
1950
1797
  return this.getClientInstance()
@@ -1980,7 +1827,9 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1980
1827
  *
1981
1828
  * @returns Returns the comments, on the specified page of the results.
1982
1829
  *
1983
- * example: {
1830
+ * example:
1831
+ * ```
1832
+ * {
1984
1833
  * "_expands": [],
1985
1834
  * "size": 1,
1986
1835
  * "start": 1,
@@ -1989,10 +1838,8 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
1989
1838
  * "_links": {
1990
1839
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
1991
1840
  * "context": "context",
1992
- * "next":
1993
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment?start=2&limit=1",
1994
- * "prev":
1995
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment?start=0&limit=1"
1841
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment?start=2&limit=1",
1842
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment?start=0&limit=1"
1996
1843
  * },
1997
1844
  * "values": [
1998
1845
  * {
@@ -2004,31 +1851,22 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2004
1851
  * "body": "Hello there",
2005
1852
  * "public": true,
2006
1853
  * "author": {
2007
- * "accountId":
2008
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2009
- * "name":
2010
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2011
- * "key":
2012
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1854
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1855
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1856
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2013
1857
  * "emailAddress": "fred@example.com",
2014
1858
  * "displayName": "Fred F. User",
2015
1859
  * "active": true,
2016
1860
  * "timeZone": "Australia/Sydney",
2017
1861
  * "_links": {
2018
- * "jiraRest":
2019
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1862
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2020
1863
  * "avatarUrls": {
2021
- * "16x16":
2022
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
2023
- * "24x24":
2024
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
2025
- * "32x32":
2026
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
2027
- * "48x48":
2028
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1864
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1865
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1866
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1867
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
2029
1868
  * },
2030
- * "self":
2031
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1869
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
2032
1870
  * }
2033
1871
  * },
2034
1872
  * "created": {
@@ -2038,16 +1876,17 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2038
1876
  * "jira": "2015-10-09T10:22:00.000+0700"
2039
1877
  * },
2040
1878
  * "_links": {
2041
- * "self":
2042
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
1879
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
2043
1880
  * }
2044
1881
  * }
2045
1882
  * ]
2046
1883
  * }
2047
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/comment
1884
+ * ```
1885
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/comment`
2048
1886
  * @scopes-current read:servicedesk-request
2049
1887
  * @scopes-beta read:request.comment:jira-service-management, read:user:jira
2050
1888
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-get
1889
+ * @param params
2051
1890
  */
2052
1891
  this.getRequestComments = ({ issueIdOrKey, public: publicQuery, internal, expand, start, limit, }) => {
2053
1892
  return this.getClientInstance()
@@ -2080,10 +1919,11 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2080
1919
  * **[Permissions](#permissions) required**: Permission to view the customer
2081
1920
  * request.
2082
1921
  *
2083
- * @returns Returns the customer request's participants, on the specified page of the
2084
- * results.
1922
+ * @returns Returns the customer request's participants, on the specified page of the results.
2085
1923
  *
2086
- * example: {
1924
+ * example:
1925
+ * ```
1926
+ * {
2087
1927
  * "_expands": [],
2088
1928
  * "size": 1,
2089
1929
  * "start": 1,
@@ -2092,15 +1932,12 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2092
1932
  * "_links": {
2093
1933
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
2094
1934
  * "context": "context",
2095
- * "next":
2096
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
2097
- * "prev":
2098
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
1935
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
1936
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
2099
1937
  * },
2100
1938
  * "values": [
2101
1939
  * {
2102
- * "accountId":
2103
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1940
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2104
1941
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2105
1942
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2106
1943
  * "emailAddress": "fred@example.com",
@@ -2108,28 +1945,24 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2108
1945
  * "active": true,
2109
1946
  * "timeZone": "Australia/Sydney",
2110
1947
  * "_links": {
2111
- * "jiraRest":
2112
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
1948
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2113
1949
  * "avatarUrls": {
2114
- * "16x16":
2115
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
2116
- * "24x24":
2117
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
2118
- * "32x32":
2119
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
2120
- * "48x48":
2121
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
1950
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
1951
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
1952
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
1953
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
2122
1954
  * },
2123
- * "self":
2124
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
1955
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
2125
1956
  * }
2126
1957
  * }
2127
1958
  * ]
2128
1959
  * }
2129
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/participant
1960
+ * ```
1961
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/participant`
2130
1962
  * @scopes-current read:servicedesk-request
2131
1963
  * @scopes-beta read:request.participant:jira-service-management, read:user:jira
2132
1964
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-participant-get
1965
+ * @param params
2133
1966
  */
2134
1967
  this.getRequestParticipants = ({ issueIdOrKey, start, limit, }) => {
2135
1968
  return this.getClientInstance()
@@ -2163,10 +1996,11 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2163
1996
  * **[Permissions](#permissions) required**: Agent for the Service Desk containing
2164
1997
  * the queried customer request.
2165
1998
  *
2166
- * @returns Returns the SLA records on the customer request, on the specified page of the
2167
- * results.
1999
+ * @returns Returns the SLA records on the customer request, on the specified page of the results.
2168
2000
  *
2169
- * example: {
2001
+ * example:
2002
+ * ```
2003
+ * {
2170
2004
  * "_expands": [],
2171
2005
  * "size": 3,
2172
2006
  * "start": 3,
@@ -2175,17 +2009,14 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2175
2009
  * "_links": {
2176
2010
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
2177
2011
  * "context": "context",
2178
- * "next":
2179
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla?start=6&limit=3",
2180
- * "prev":
2181
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla?start=0&limit=3"
2012
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla?start=6&limit=3",
2013
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla?start=0&limit=3"
2182
2014
  * },
2183
2015
  * "values": [
2184
2016
  * {
2185
2017
  * "name": "Time To First Response",
2186
2018
  * "_links": {
2187
- * "self":
2188
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10030"
2019
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10030"
2189
2020
  * },
2190
2021
  * "completedCycles": [
2191
2022
  * {
@@ -2282,8 +2113,7 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2282
2113
  * {
2283
2114
  * "name": "Time To Resolution",
2284
2115
  * "_links": {
2285
- * "self":
2286
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10040"
2116
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10040"
2287
2117
  * },
2288
2118
  * "completedCycles": [
2289
2119
  * {
@@ -2380,8 +2210,7 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2380
2210
  * {
2381
2211
  * "name": "Time To Retrospective",
2382
2212
  * "_links": {
2383
- * "self":
2384
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10050"
2213
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10050"
2385
2214
  * },
2386
2215
  * "completedCycles": [
2387
2216
  * {
@@ -2477,10 +2306,12 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2477
2306
  * }
2478
2307
  * ]
2479
2308
  * }
2480
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/sla
2309
+ * ```
2310
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/sla`
2481
2311
  * @scopes-current read:jira-work
2482
2312
  * @scopes-beta read:request.sla:jira-service-management
2483
2313
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-sla-get
2314
+ * @param params
2484
2315
  */
2485
2316
  this.getSlaInformation = ({ issueIdOrKey, start, limit, }) => {
2486
2317
  return this.getClientInstance()
@@ -2512,11 +2343,12 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2512
2343
  *
2513
2344
  * @returns Returns the SLA record, on the specified page of the results.
2514
2345
  *
2515
- * example: {
2346
+ * example:
2347
+ * ```
2348
+ * {
2516
2349
  * "name": "Time To First Response",
2517
2350
  * "_links": {
2518
- * "self":
2519
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10030"
2351
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10030"
2520
2352
  * },
2521
2353
  * "completedCycles": [
2522
2354
  * {
@@ -2610,10 +2442,12 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2610
2442
  * }
2611
2443
  * }
2612
2444
  * }
2613
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/sla/{slaMetricId}
2445
+ * ```
2446
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/sla/{slaMetricId}`
2614
2447
  * @scopes-current read:jira-work
2615
2448
  * @scopes-beta read:request.sla:jira-service-management
2616
2449
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-sla-slametricid-get
2450
+ * @param params
2617
2451
  */
2618
2452
  this.getSlaInformationById = ({ issueIdOrKey, slaMetricId, }) => {
2619
2453
  return this.getClientInstance()
@@ -2644,13 +2478,17 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2644
2478
  *
2645
2479
  * @returns Returns the status of the notification subscription.
2646
2480
  *
2647
- * example: {
2481
+ * example:
2482
+ * ```
2483
+ * {
2648
2484
  * "subscribed": true
2649
2485
  * }
2650
- * @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/notification
2486
+ * ```
2487
+ * @path GET `/rest/servicedeskapi/request/{issueIdOrKey}/notification`
2651
2488
  * @scopes-current read:servicedesk-request
2652
2489
  * @scopes-beta read:request.notification:jira-service-management, read:user:jira
2653
2490
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-notification-get
2491
+ * @param params
2654
2492
  */
2655
2493
  this.getSubscriptionStatus = ({ issueIdOrKey, }) => {
2656
2494
  return this.getClientInstance()
@@ -2678,11 +2516,11 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2678
2516
  * request and have the Transition Issues permission. If a comment is passed the
2679
2517
  * user must have the Add Comments permission.
2680
2518
  *
2681
- * @path {POST} /rest/servicedeskapi/request/{issueIdOrKey}/transition
2519
+ * @path POST `/rest/servicedeskapi/request/{issueIdOrKey}/transition`
2682
2520
  * @scopes-current write:servicedesk-request
2683
- * @scopes-beta read:request.status:jira-service-management,
2684
- * write:request.status:jira-service-management, read:user:jira
2521
+ * @scopes-beta read:request.status:jira-service-management, write:request.status:jira-service-management, read:user:jira
2685
2522
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-transition-post
2523
+ * @param params
2686
2524
  */
2687
2525
  this.performCustomerTransition = ({ issueIdOrKey, customerTransitionExecutionDto, }) => {
2688
2526
  return this.getClientInstance()
@@ -2707,18 +2545,21 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2707
2545
  *
2708
2546
  * @returns Returns the comment.
2709
2547
  *
2710
- * example: {
2548
+ * example:
2549
+ * ```
2550
+ * {
2711
2551
  * "type": "csat",
2712
2552
  * "rating": 4,
2713
2553
  * "comment": {
2714
2554
  * "body": "Great work!"
2715
2555
  * }
2716
2556
  * }
2717
- * @path {POST} /rest/servicedeskapi/request/{requestIdOrKey}/feedback
2557
+ * ```
2558
+ * @path POST `/rest/servicedeskapi/request/{requestIdOrKey}/feedback`
2718
2559
  * @scopes-current write:servicedesk-request
2719
- * @scopes-beta read:request.feedback:jira-service-management,
2720
- * write:request.feedback:jira-service-management, read:user:jira
2560
+ * @scopes-beta read:request.feedback:jira-service-management, write:request.feedback:jira-service-management, read:user:jira
2721
2561
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-requestidorkey-feedback-post
2562
+ * @param params
2722
2563
  */
2723
2564
  this.postFeedback = ({ requestIdOrKey, csatFeedbackFullDto, }) => {
2724
2565
  return this.getClientInstance()
@@ -2748,10 +2589,11 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2748
2589
  * **[Permissions](#permissions) required**: Permission to manage participants on
2749
2590
  * the customer request.
2750
2591
  *
2751
- * @returns Returns the first page of the customer request's participants (after removal of
2752
- * the users).
2592
+ * @returns Returns the first page of the customer request's participants (after removal of the users).
2753
2593
  *
2754
- * example: {
2594
+ * example:
2595
+ * ```
2596
+ * {
2755
2597
  * "_expands": [],
2756
2598
  * "size": 1,
2757
2599
  * "start": 1,
@@ -2760,15 +2602,12 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2760
2602
  * "_links": {
2761
2603
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
2762
2604
  * "context": "context",
2763
- * "next":
2764
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
2765
- * "prev":
2766
- * "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
2605
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
2606
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
2767
2607
  * },
2768
2608
  * "values": [
2769
2609
  * {
2770
- * "accountId":
2771
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2610
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2772
2611
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2773
2612
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2774
2613
  * "emailAddress": "fred@example.com",
@@ -2776,29 +2615,24 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2776
2615
  * "active": true,
2777
2616
  * "timeZone": "Australia/Sydney",
2778
2617
  * "_links": {
2779
- * "jiraRest":
2780
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2618
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
2781
2619
  * "avatarUrls": {
2782
- * "16x16":
2783
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
2784
- * "24x24":
2785
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
2786
- * "32x32":
2787
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
2788
- * "48x48":
2789
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
2620
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
2621
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
2622
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
2623
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
2790
2624
  * },
2791
- * "self":
2792
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
2625
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
2793
2626
  * }
2794
2627
  * }
2795
2628
  * ]
2796
2629
  * }
2797
- * @path {DELETE} /rest/servicedeskapi/request/{issueIdOrKey}/participant
2630
+ * ```
2631
+ * @path DELETE `/rest/servicedeskapi/request/{issueIdOrKey}/participant`
2798
2632
  * @scopes-current write:servicedesk-request
2799
- * @scopes-beta read:request.participant:jira-service-management,
2800
- * delete:request.participant:jira-service-management, read:user:jira
2633
+ * @scopes-beta read:request.participant:jira-service-management, delete:request.participant:jira-service-management, read:user:jira
2801
2634
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-participant-delete
2635
+ * @param params
2802
2636
  */
2803
2637
  this.removeRequestParticipants = ({ issueIdOrKey, requestParticipantUpdateDto, }) => {
2804
2638
  return this.getClientInstance()
@@ -2829,11 +2663,11 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2829
2663
  * **[Permissions](#permissions) required**: Permission to view the customer
2830
2664
  * request.
2831
2665
  *
2832
- * @path {PUT} /rest/servicedeskapi/request/{issueIdOrKey}/notification
2666
+ * @path PUT `/rest/servicedeskapi/request/{issueIdOrKey}/notification`
2833
2667
  * @scopes-current write:servicedesk-request
2834
- * @scopes-beta read:request.notification:jira-service-management,
2835
- * write:request.notification:jira-service-management, read:user:jira
2668
+ * @scopes-beta read:request.notification:jira-service-management, write:request.notification:jira-service-management, read:user:jira
2836
2669
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-notification-put
2670
+ * @param params
2837
2671
  */
2838
2672
  this.subscribe = ({ issueIdOrKey, }) => {
2839
2673
  return this.getClientInstance()
@@ -2852,11 +2686,11 @@ class RequestService extends CommonHttpService_1.CommonHttpService {
2852
2686
  * **[Permissions](#permissions) required**: Permission to view the customer
2853
2687
  * request.
2854
2688
  *
2855
- * @path {DELETE} /rest/servicedeskapi/request/{issueIdOrKey}/notification
2689
+ * @path DELETE `/rest/servicedeskapi/request/{issueIdOrKey}/notification`
2856
2690
  * @scopes-current write:servicedesk-request
2857
- * @scopes-beta read:request.notification:jira-service-management,
2858
- * delete:request.notification:jira-service-management, read:user:jira
2691
+ * @scopes-beta read:request.notification:jira-service-management, delete:request.notification:jira-service-management, read:user:jira
2859
2692
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-notification-delete
2693
+ * @param params
2860
2694
  */
2861
2695
  this.unsubscribe = ({ issueIdOrKey, }) => {
2862
2696
  return this.getClientInstance()