@resolution/jira-api-client 0.4.6 → 0.5.0
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.
- package/CHANGELOG.md +11 -0
- package/README.md +27 -4
- package/lib/index.d.ts +13 -0
- package/lib/index.js +17 -1
- package/lib/index.js.map +1 -1
- package/lib/openapi/platform/BaseJiraPlatformApiClient.d.ts +1 -1
- package/lib/openapi/platform/BaseJiraPlatformApiClient.js +1 -1
- package/lib/openapi/platform/services/DashboardsService.d.ts +7 -1
- package/lib/openapi/platform/services/DashboardsService.js +4 -1
- package/lib/openapi/platform/services/DashboardsService.js.map +1 -1
- package/lib/openapi/platform/services/IssueSearchService.d.ts +8 -1
- package/lib/openapi/platform/services/IssueSearchService.js +2 -1
- package/lib/openapi/platform/services/IssueSearchService.js.map +1 -1
- package/lib/openapi/platform/services/IssuesService.d.ts +8 -1
- package/lib/openapi/platform/services/IssuesService.js +2 -1
- package/lib/openapi/platform/services/IssuesService.js.map +1 -1
- package/lib/openapi/platform/services/PermissionsService.d.ts +7 -0
- package/lib/openapi/platform/services/PermissionsService.js +7 -0
- package/lib/openapi/platform/services/PermissionsService.js.map +1 -1
- package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.d.ts +46 -0
- package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.js +78 -0
- package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.js.map +1 -0
- package/lib/openapi/serviceManagement/core/CommonHttpClient.d.ts +196 -0
- package/lib/openapi/serviceManagement/core/CommonHttpClient.js +390 -0
- package/lib/openapi/serviceManagement/core/CommonHttpClient.js.map +1 -0
- package/lib/openapi/serviceManagement/core/CommonHttpService.d.ts +9 -0
- package/lib/openapi/serviceManagement/core/CommonHttpService.js +29 -0
- package/lib/openapi/serviceManagement/core/CommonHttpService.js.map +1 -0
- package/lib/openapi/serviceManagement/core/CommonValidationSchemaStorage.d.ts +35 -0
- package/lib/openapi/serviceManagement/core/CommonValidationSchemaStorage.js +65 -0
- package/lib/openapi/serviceManagement/core/CommonValidationSchemaStorage.js.map +1 -0
- package/lib/openapi/serviceManagement/models/assets.d.ts +54 -0
- package/lib/openapi/serviceManagement/models/assets.js +60 -0
- package/lib/openapi/serviceManagement/models/assets.js.map +1 -0
- package/lib/openapi/serviceManagement/models/common.d.ts +228 -0
- package/lib/openapi/serviceManagement/models/common.js +172 -0
- package/lib/openapi/serviceManagement/models/common.js.map +1 -0
- package/lib/openapi/serviceManagement/models/customer.d.ts +30 -0
- package/lib/openapi/serviceManagement/models/customer.js +27 -0
- package/lib/openapi/serviceManagement/models/customer.js.map +1 -0
- package/lib/openapi/serviceManagement/models/info.d.ts +18 -0
- package/lib/openapi/serviceManagement/models/info.js +24 -0
- package/lib/openapi/serviceManagement/models/info.js.map +1 -0
- package/lib/openapi/serviceManagement/models/knowledgebase.d.ts +24 -0
- package/lib/openapi/serviceManagement/models/knowledgebase.js +32 -0
- package/lib/openapi/serviceManagement/models/knowledgebase.js.map +1 -0
- package/lib/openapi/serviceManagement/models/organization.d.ts +76 -0
- package/lib/openapi/serviceManagement/models/organization.js +65 -0
- package/lib/openapi/serviceManagement/models/organization.js.map +1 -0
- package/lib/openapi/serviceManagement/models/request.d.ts +594 -0
- package/lib/openapi/serviceManagement/models/request.js +516 -0
- package/lib/openapi/serviceManagement/models/request.js.map +1 -0
- package/lib/openapi/serviceManagement/models/servicedesk.d.ts +525 -0
- package/lib/openapi/serviceManagement/models/servicedesk.js +442 -0
- package/lib/openapi/serviceManagement/models/servicedesk.js.map +1 -0
- package/lib/openapi/serviceManagement/services/AssetsService.d.ts +61 -0
- package/lib/openapi/serviceManagement/services/AssetsService.js +113 -0
- package/lib/openapi/serviceManagement/services/AssetsService.js.map +1 -0
- package/lib/openapi/serviceManagement/services/CustomerService.d.ts +63 -0
- package/lib/openapi/serviceManagement/services/CustomerService.js +93 -0
- package/lib/openapi/serviceManagement/services/CustomerService.js.map +1 -0
- package/lib/openapi/serviceManagement/services/InfoService.d.ts +34 -0
- package/lib/openapi/serviceManagement/services/InfoService.js +71 -0
- package/lib/openapi/serviceManagement/services/InfoService.js.map +1 -0
- package/lib/openapi/serviceManagement/services/KnowledgebaseService.d.ts +81 -0
- package/lib/openapi/serviceManagement/services/KnowledgebaseService.js +106 -0
- package/lib/openapi/serviceManagement/services/KnowledgebaseService.js.map +1 -0
- package/lib/openapi/serviceManagement/services/OrganizationService.d.ts +589 -0
- package/lib/openapi/serviceManagement/services/OrganizationService.js +762 -0
- package/lib/openapi/serviceManagement/services/OrganizationService.js.map +1 -0
- package/lib/openapi/serviceManagement/services/RequestService.d.ts +2736 -0
- package/lib/openapi/serviceManagement/services/RequestService.js +3056 -0
- package/lib/openapi/serviceManagement/services/RequestService.js.map +1 -0
- package/lib/openapi/serviceManagement/services/RequesttypeService.d.ts +166 -0
- package/lib/openapi/serviceManagement/services/RequesttypeService.js +190 -0
- package/lib/openapi/serviceManagement/services/RequesttypeService.js.map +1 -0
- package/lib/openapi/serviceManagement/services/ServicedeskService.d.ts +1268 -0
- package/lib/openapi/serviceManagement/services/ServicedeskService.js +1510 -0
- package/lib/openapi/serviceManagement/services/ServicedeskService.js.map +1 -0
- package/lib/openapi/serviceManagement/validationSchemaStorage.d.ts +3 -0
- package/lib/openapi/serviceManagement/validationSchemaStorage.js +144 -0
- package/lib/openapi/serviceManagement/validationSchemaStorage.js.map +1 -0
- package/package.json +3 -3
|
@@ -0,0 +1,2736 @@
|
|
|
1
|
+
import { CommonHttpService } from "../core/CommonHttpService";
|
|
2
|
+
import { type PagedDtoUserDto } from "../models/common";
|
|
3
|
+
import { type ApprovalDecisionRequestDto, type ApprovalDto, type AttachmentCreateDto, type AttachmentCreateResultDto, type CommentCreateDto, type CommentDto, type CsatFeedbackFullDto, type CustomerRequestDto, type CustomerTransitionExecutionDto, type PagedDtoApprovalDto, type PagedDtoAttachmentDto, type PagedDtoCommentDto, type PagedDtoCustomerRequestDto, type PagedDtoCustomerRequestStatusDto, type PagedDtoCustomerTransitionDto, type PagedDtoSlaInformationDto, type RequestCreateDto, type RequestNotificationSubscriptionDto, type RequestParticipantUpdateDto, type SlaInformationDto } from "../models/request";
|
|
4
|
+
/** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request */
|
|
5
|
+
export declare class RequestService extends CommonHttpService {
|
|
6
|
+
/**
|
|
7
|
+
* This method adds participants to a customer request.
|
|
8
|
+
*
|
|
9
|
+
* **[Permissions](#permissions) required**: Permission to manage participants on
|
|
10
|
+
* the customer request.
|
|
11
|
+
*
|
|
12
|
+
* Note, participants can be added when creating a customer request using the
|
|
13
|
+
* [request](#api-request-post) resource, by defining the participants in the
|
|
14
|
+
* `requestParticipants` field.
|
|
15
|
+
*
|
|
16
|
+
* @returns Returns the participants added to the customer request.
|
|
17
|
+
*
|
|
18
|
+
* example: {
|
|
19
|
+
* "_expands": [],
|
|
20
|
+
* "size": 1,
|
|
21
|
+
* "start": 1,
|
|
22
|
+
* "limit": 1,
|
|
23
|
+
* "isLastPage": false,
|
|
24
|
+
* "_links": {
|
|
25
|
+
* "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
|
|
26
|
+
* "context": "context",
|
|
27
|
+
* "next":
|
|
28
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
|
|
29
|
+
* "prev":
|
|
30
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
|
|
31
|
+
* },
|
|
32
|
+
* "values": [
|
|
33
|
+
* {
|
|
34
|
+
* "accountId":
|
|
35
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
36
|
+
* "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
37
|
+
* "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
38
|
+
* "emailAddress": "fred@example.com",
|
|
39
|
+
* "displayName": "Fred F. User",
|
|
40
|
+
* "active": true,
|
|
41
|
+
* "timeZone": "Australia/Sydney",
|
|
42
|
+
* "_links": {
|
|
43
|
+
* "jiraRest":
|
|
44
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
45
|
+
* "avatarUrls": {
|
|
46
|
+
* "16x16":
|
|
47
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
48
|
+
* "24x24":
|
|
49
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
50
|
+
* "32x32":
|
|
51
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
52
|
+
* "48x48":
|
|
53
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
54
|
+
* },
|
|
55
|
+
* "self":
|
|
56
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
57
|
+
* }
|
|
58
|
+
* }
|
|
59
|
+
* ]
|
|
60
|
+
* }
|
|
61
|
+
* @path {POST} /rest/servicedeskapi/request/{issueIdOrKey}/participant
|
|
62
|
+
* @scopes-current write:servicedesk-request
|
|
63
|
+
* @scopes-beta read:request.participant:jira-service-management,
|
|
64
|
+
* write:request.participant:jira-service-management, read:user:jira
|
|
65
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-participant-post
|
|
66
|
+
*/
|
|
67
|
+
addRequestParticipants: ({ issueIdOrKey, requestParticipantUpdateDto, }: {
|
|
68
|
+
/** The ID or key of the customer request to have participants added. */
|
|
69
|
+
issueIdOrKey: string;
|
|
70
|
+
/**
|
|
71
|
+
* @example {
|
|
72
|
+
* "accountIds": [],
|
|
73
|
+
* "usernames": [
|
|
74
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
75
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd",
|
|
76
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae"
|
|
77
|
+
* ]
|
|
78
|
+
* }
|
|
79
|
+
*/
|
|
80
|
+
requestParticipantUpdateDto: RequestParticipantUpdateDto;
|
|
81
|
+
}) => Promise<PagedDtoUserDto>;
|
|
82
|
+
/**
|
|
83
|
+
* This method enables a user to **Approve** or **Decline** an approval on a
|
|
84
|
+
* customer request. The approval is assumed to be owned by the user making the
|
|
85
|
+
* call.
|
|
86
|
+
*
|
|
87
|
+
* **[Permissions](#permissions) required**: User is assigned to the approval
|
|
88
|
+
* request.
|
|
89
|
+
*
|
|
90
|
+
* @returns Returns the updated approval.
|
|
91
|
+
*
|
|
92
|
+
* example: {
|
|
93
|
+
* "id": "1",
|
|
94
|
+
* "name": "Please approve this request",
|
|
95
|
+
* "finalDecision": "approved",
|
|
96
|
+
* "canAnswerApproval": false,
|
|
97
|
+
* "approvers": [
|
|
98
|
+
* {
|
|
99
|
+
* "approver": {
|
|
100
|
+
* "accountId":
|
|
101
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
102
|
+
* "name":
|
|
103
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
104
|
+
* "key":
|
|
105
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
106
|
+
* "emailAddress": "fred@example.com",
|
|
107
|
+
* "displayName": "Fred F. User",
|
|
108
|
+
* "active": true,
|
|
109
|
+
* "timeZone": "Australia/Sydney",
|
|
110
|
+
* "_links": {
|
|
111
|
+
* "jiraRest":
|
|
112
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
113
|
+
* "avatarUrls": {
|
|
114
|
+
* "16x16":
|
|
115
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
116
|
+
* "24x24":
|
|
117
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
118
|
+
* "32x32":
|
|
119
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
120
|
+
* "48x48":
|
|
121
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
122
|
+
* },
|
|
123
|
+
* "self":
|
|
124
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
125
|
+
* }
|
|
126
|
+
* },
|
|
127
|
+
* "approverDecision": "approved"
|
|
128
|
+
* }
|
|
129
|
+
* ],
|
|
130
|
+
* "createdDate": {
|
|
131
|
+
* "epochMillis": 1475046060000,
|
|
132
|
+
* "friendly": "Monday 14:01 PM",
|
|
133
|
+
* "iso8601": "2016-09-28T14:01:00+0700",
|
|
134
|
+
* "jira": "2016-09-28T14:01:00.000+0700"
|
|
135
|
+
* },
|
|
136
|
+
* "completedDate": {
|
|
137
|
+
* "epochMillis": 1475134200000,
|
|
138
|
+
* "friendly": "Today 14:30 PM",
|
|
139
|
+
* "iso8601": "2016-09-29T14:30:00+0700",
|
|
140
|
+
* "jira": "2016-09-29T14:30:00.000+0700"
|
|
141
|
+
* },
|
|
142
|
+
* "_links": {
|
|
143
|
+
* "self":
|
|
144
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1"
|
|
145
|
+
* }
|
|
146
|
+
* }
|
|
147
|
+
* @path {POST} /rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}
|
|
148
|
+
* @scopes-current write:servicedesk-request
|
|
149
|
+
* @scopes-beta read:request.approval:jira-service-management,
|
|
150
|
+
* write:request.approval:jira-service-management, read:user:jira
|
|
151
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-approval-approvalid-post
|
|
152
|
+
*/
|
|
153
|
+
answerApproval: ({ issueIdOrKey, approvalId, approvalDecisionRequestDto, }: {
|
|
154
|
+
/** The ID or key of the customer request to be updated. */
|
|
155
|
+
issueIdOrKey: string;
|
|
156
|
+
/** The ID of the approval to be updated. */
|
|
157
|
+
approvalId: number;
|
|
158
|
+
/**
|
|
159
|
+
* @example {
|
|
160
|
+
* "decision": "approve"
|
|
161
|
+
* }
|
|
162
|
+
*/
|
|
163
|
+
approvalDecisionRequestDto: ApprovalDecisionRequestDto;
|
|
164
|
+
}) => Promise<ApprovalDto>;
|
|
165
|
+
/**
|
|
166
|
+
* This method creates a comment on a customer request using one or more
|
|
167
|
+
* attachment files (uploaded using
|
|
168
|
+
* [servicedeskapi/servicedesk/\{serviceDeskId\}/attachTemporaryFile](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk/#api-rest-servicedeskapi-servicedesk-servicedeskid-attachtemporaryfile-post)),
|
|
169
|
+
* with the visibility set by `public`. See
|
|
170
|
+
*
|
|
171
|
+
* * GET
|
|
172
|
+
* [servicedeskapi/request/\{issueIdOrKey\}/attachment](./#api-rest-servicedeskapi-request-issueidorkey-attachment-get)
|
|
173
|
+
* * GET
|
|
174
|
+
* [servicedeskapi/request/\{issueIdOrKey\}/comment/\{commentId\}/attachment](./#api-rest-servicedeskapi-request-issueidorkey-comment-commentid-attachment-get)
|
|
175
|
+
*
|
|
176
|
+
* **[Permissions](#permissions) required**: Permission to add an attachment.
|
|
177
|
+
*
|
|
178
|
+
* **Request limitations**: Customers can set public visibility only.
|
|
179
|
+
*
|
|
180
|
+
* @returns Returns the attachments and comment.
|
|
181
|
+
*
|
|
182
|
+
* example: {
|
|
183
|
+
* "comment": {
|
|
184
|
+
* "_expands": [
|
|
185
|
+
* "attachment",
|
|
186
|
+
* "renderedBody"
|
|
187
|
+
* ],
|
|
188
|
+
* "id": "1000",
|
|
189
|
+
* "body": "Please find the screenshot and the log file attached.
|
|
190
|
+
* !screenshot.png|thumbnail! [^log.txt] _(32 kB)_",
|
|
191
|
+
* "public": true,
|
|
192
|
+
* "author": {
|
|
193
|
+
* "accountId":
|
|
194
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
195
|
+
* "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
196
|
+
* "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
197
|
+
* "emailAddress": "fred@example.com",
|
|
198
|
+
* "displayName": "Fred F. User",
|
|
199
|
+
* "active": true,
|
|
200
|
+
* "timeZone": "Australia/Sydney",
|
|
201
|
+
* "_links": {
|
|
202
|
+
* "jiraRest":
|
|
203
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
204
|
+
* "avatarUrls": {
|
|
205
|
+
* "16x16":
|
|
206
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
207
|
+
* "24x24":
|
|
208
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
209
|
+
* "32x32":
|
|
210
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
211
|
+
* "48x48":
|
|
212
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
213
|
+
* },
|
|
214
|
+
* "self":
|
|
215
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
216
|
+
* }
|
|
217
|
+
* },
|
|
218
|
+
* "created": {
|
|
219
|
+
* "epochMillis": 1444360920000,
|
|
220
|
+
* "friendly": "Today 10:22 AM",
|
|
221
|
+
* "iso8601": "2015-10-09T10:22:00+0700",
|
|
222
|
+
* "jira": "2015-10-09T10:22:00.000+0700"
|
|
223
|
+
* },
|
|
224
|
+
* "_links": {
|
|
225
|
+
* "self":
|
|
226
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
|
|
227
|
+
* }
|
|
228
|
+
* },
|
|
229
|
+
* "attachments": {
|
|
230
|
+
* "_expands": [],
|
|
231
|
+
* "size": 2,
|
|
232
|
+
* "start": 2,
|
|
233
|
+
* "limit": 2,
|
|
234
|
+
* "isLastPage": false,
|
|
235
|
+
* "_links": {
|
|
236
|
+
* "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
|
|
237
|
+
* "context": "context",
|
|
238
|
+
* "next":
|
|
239
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2",
|
|
240
|
+
* "prev":
|
|
241
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2"
|
|
242
|
+
* },
|
|
243
|
+
* "values": [
|
|
244
|
+
* {
|
|
245
|
+
* "filename": "screenshot.png",
|
|
246
|
+
* "author": {
|
|
247
|
+
* "accountId":
|
|
248
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
249
|
+
* "name":
|
|
250
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
251
|
+
* "key":
|
|
252
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
253
|
+
* "emailAddress": "fred@example.com",
|
|
254
|
+
* "displayName": "Fred F. User",
|
|
255
|
+
* "active": true,
|
|
256
|
+
* "timeZone": "Australia/Sydney",
|
|
257
|
+
* "_links": {
|
|
258
|
+
* "jiraRest":
|
|
259
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
260
|
+
* "avatarUrls": {
|
|
261
|
+
* "16x16":
|
|
262
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
263
|
+
* "24x24":
|
|
264
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
265
|
+
* "32x32":
|
|
266
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
267
|
+
* "48x48":
|
|
268
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
269
|
+
* },
|
|
270
|
+
* "self":
|
|
271
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
272
|
+
* }
|
|
273
|
+
* },
|
|
274
|
+
* "created": {
|
|
275
|
+
* "epochMillis": 1444360920000,
|
|
276
|
+
* "friendly": "Today 10:22 AM",
|
|
277
|
+
* "iso8601": "2015-10-09T10:22:00+0700",
|
|
278
|
+
* "jira": "2015-10-09T10:22:00.000+0700"
|
|
279
|
+
* },
|
|
280
|
+
* "size": 23123,
|
|
281
|
+
* "mimeType": "image/png",
|
|
282
|
+
* "_links": {
|
|
283
|
+
* "jiraRest":
|
|
284
|
+
* "https://your-domain.atlassian.net/rest/api/2/attachment/10000",
|
|
285
|
+
* "content":
|
|
286
|
+
* "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png",
|
|
287
|
+
* "thumbnail":
|
|
288
|
+
* "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png"
|
|
289
|
+
* }
|
|
290
|
+
* },
|
|
291
|
+
* {
|
|
292
|
+
* "filename": "log.txt",
|
|
293
|
+
* "author": {
|
|
294
|
+
* "accountId":
|
|
295
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
296
|
+
* "name":
|
|
297
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
298
|
+
* "key":
|
|
299
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
300
|
+
* "emailAddress": "fred@example.com",
|
|
301
|
+
* "displayName": "Fred F. User",
|
|
302
|
+
* "active": true,
|
|
303
|
+
* "timeZone": "Australia/Sydney",
|
|
304
|
+
* "_links": {
|
|
305
|
+
* "jiraRest":
|
|
306
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
307
|
+
* "avatarUrls": {
|
|
308
|
+
* "16x16":
|
|
309
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
310
|
+
* "24x24":
|
|
311
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
312
|
+
* "32x32":
|
|
313
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
314
|
+
* "48x48":
|
|
315
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
316
|
+
* },
|
|
317
|
+
* "self":
|
|
318
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
319
|
+
* }
|
|
320
|
+
* },
|
|
321
|
+
* "created": {
|
|
322
|
+
* "epochMillis": 1444360920000,
|
|
323
|
+
* "friendly": "Today 10:22 AM",
|
|
324
|
+
* "iso8601": "2015-10-09T10:22:00+0700",
|
|
325
|
+
* "jira": "2015-10-09T10:22:00.000+0700"
|
|
326
|
+
* },
|
|
327
|
+
* "size": 32132,
|
|
328
|
+
* "mimeType": "text/plain",
|
|
329
|
+
* "_links": {
|
|
330
|
+
* "jiraRest":
|
|
331
|
+
* "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
|
|
332
|
+
* "content":
|
|
333
|
+
* "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt"
|
|
334
|
+
* }
|
|
335
|
+
* }
|
|
336
|
+
* ]
|
|
337
|
+
* }
|
|
338
|
+
* }
|
|
339
|
+
* @path {POST} /rest/servicedeskapi/request/{issueIdOrKey}/attachment
|
|
340
|
+
* @scopes-current write:servicedesk-request
|
|
341
|
+
* @scopes-beta read:request.attachment:jira-service-management,
|
|
342
|
+
* write:request.attachment:jira-service-management, read:user:jira
|
|
343
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-post
|
|
344
|
+
*/
|
|
345
|
+
createCommentWithAttachment: ({ issueIdOrKey, attachmentCreateDto, }: {
|
|
346
|
+
/** The ID or key of the customer request to which the attachment will be added. */
|
|
347
|
+
issueIdOrKey: string;
|
|
348
|
+
/**
|
|
349
|
+
* @example {
|
|
350
|
+
* "additionalComment": {
|
|
351
|
+
* "body": "Please find the screenshot and the log file attached."
|
|
352
|
+
* },
|
|
353
|
+
* "public": true,
|
|
354
|
+
* "temporaryAttachmentIds": [
|
|
355
|
+
* "temp910441317820424274",
|
|
356
|
+
* "temp3600755449679003114"
|
|
357
|
+
* ]
|
|
358
|
+
* }
|
|
359
|
+
*/
|
|
360
|
+
attachmentCreateDto: AttachmentCreateDto;
|
|
361
|
+
}) => Promise<AttachmentCreateResultDto>;
|
|
362
|
+
/**
|
|
363
|
+
* This method creates a customer request in a service desk.
|
|
364
|
+
*
|
|
365
|
+
* The JSON request must include the service desk and customer request type, as
|
|
366
|
+
* well as any fields that are required for the request type. A list of the fields
|
|
367
|
+
* required by a customer request type can be obtained using
|
|
368
|
+
* [servicedesk/\{serviceDeskId\}/requesttype/\{requestTypeId\}/field](#api-servicedesk-serviceDeskId-requesttype-requestTypeId-field-get).
|
|
369
|
+
*
|
|
370
|
+
* The fields required for a customer request type depend on the user's
|
|
371
|
+
* permissions:
|
|
372
|
+
*
|
|
373
|
+
* * `raiseOnBehalfOf` is not available to Users who have the customer
|
|
374
|
+
* permission only.
|
|
375
|
+
* * `requestParticipants` is not available to Users who have the customer
|
|
376
|
+
* permission only or if the feature is turned off for customers.
|
|
377
|
+
*
|
|
378
|
+
* `requestFieldValues` is a map of Jira field IDs and their values. See [Field
|
|
379
|
+
* input formats](#fieldformats), for details of each field's JSON semantics and
|
|
380
|
+
* the values they can take.
|
|
381
|
+
*
|
|
382
|
+
* **[Permissions](#permissions) required**: Permission to create requests in the
|
|
383
|
+
* specified service desk.
|
|
384
|
+
*
|
|
385
|
+
* @returns Returned if the customer request was created.
|
|
386
|
+
*
|
|
387
|
+
* example: {
|
|
388
|
+
* "_expands": [
|
|
389
|
+
* "participant",
|
|
390
|
+
* "status",
|
|
391
|
+
* "sla",
|
|
392
|
+
* "requestType",
|
|
393
|
+
* "serviceDesk",
|
|
394
|
+
* "attachment",
|
|
395
|
+
* "action",
|
|
396
|
+
* "comment"
|
|
397
|
+
* ],
|
|
398
|
+
* "issueId": "107001",
|
|
399
|
+
* "issueKey": "HELPDESK-1",
|
|
400
|
+
* "requestTypeId": "25",
|
|
401
|
+
* "serviceDeskId": "10",
|
|
402
|
+
* "createdDate": {
|
|
403
|
+
* "epochMillis": 1444290120000,
|
|
404
|
+
* "friendly": "Monday 14:42 PM",
|
|
405
|
+
* "iso8601": "2015-10-08T14:42:00+0700",
|
|
406
|
+
* "jira": "2015-10-08T14:42:00.000+0700"
|
|
407
|
+
* },
|
|
408
|
+
* "reporter": {
|
|
409
|
+
* "accountId":
|
|
410
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
411
|
+
* "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
412
|
+
* "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
413
|
+
* "emailAddress": "fred@example.com",
|
|
414
|
+
* "displayName": "Fred F. User",
|
|
415
|
+
* "active": true,
|
|
416
|
+
* "timeZone": "Australia/Sydney",
|
|
417
|
+
* "_links": {
|
|
418
|
+
* "jiraRest":
|
|
419
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
420
|
+
* "avatarUrls": {
|
|
421
|
+
* "16x16":
|
|
422
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
423
|
+
* "24x24":
|
|
424
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
425
|
+
* "32x32":
|
|
426
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
427
|
+
* "48x48":
|
|
428
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
429
|
+
* },
|
|
430
|
+
* "self":
|
|
431
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
432
|
+
* }
|
|
433
|
+
* },
|
|
434
|
+
* "requestFieldValues": [
|
|
435
|
+
* {
|
|
436
|
+
* "fieldId": "summary",
|
|
437
|
+
* "label": "What do you need?",
|
|
438
|
+
* "value": "Request JSD help via REST"
|
|
439
|
+
* },
|
|
440
|
+
* {
|
|
441
|
+
* "fieldId": "description",
|
|
442
|
+
* "label": "Why do you need this?",
|
|
443
|
+
* "renderedValue": {
|
|
444
|
+
* "html": "<p>I need a new <b>mouse</b> for my Mac</p>"
|
|
445
|
+
* },
|
|
446
|
+
* "value": "I need a new *mouse* for my Mac"
|
|
447
|
+
* }
|
|
448
|
+
* ],
|
|
449
|
+
* "currentStatus": {
|
|
450
|
+
* "status": "Waiting for Support",
|
|
451
|
+
* "statusCategory": "NEW",
|
|
452
|
+
* "statusDate": {
|
|
453
|
+
* "epochMillis": 1444287660000,
|
|
454
|
+
* "friendly": "Today 14:01 PM",
|
|
455
|
+
* "iso8601": "2015-10-08T14:01:00+0700",
|
|
456
|
+
* "jira": "2015-10-08T14:01:00.000+0700"
|
|
457
|
+
* }
|
|
458
|
+
* },
|
|
459
|
+
* "_links": {
|
|
460
|
+
* "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107001",
|
|
461
|
+
* "web":
|
|
462
|
+
* "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1",
|
|
463
|
+
* "self":
|
|
464
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001",
|
|
465
|
+
* "agent": "https://your-domain.atlassian.net/browse/HELPDESK-1"
|
|
466
|
+
* }
|
|
467
|
+
* }
|
|
468
|
+
* @path {POST} /rest/servicedeskapi/request
|
|
469
|
+
* @scopes-current write:servicedesk-request
|
|
470
|
+
* @scopes-beta read:request:jira-service-management, write:request:jira-service-management,
|
|
471
|
+
* read:user:jira
|
|
472
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-post
|
|
473
|
+
*/
|
|
474
|
+
createCustomerRequest: ({ requestCreateDto, }: {
|
|
475
|
+
/**
|
|
476
|
+
* @example {
|
|
477
|
+
* "form": {
|
|
478
|
+
* "answers": {
|
|
479
|
+
* "1": {
|
|
480
|
+
* "text": "Answer to a text form field"
|
|
481
|
+
* },
|
|
482
|
+
* "2": {
|
|
483
|
+
* "date": "2023-07-06"
|
|
484
|
+
* },
|
|
485
|
+
* "3": {
|
|
486
|
+
* "time": "14:35"
|
|
487
|
+
* },
|
|
488
|
+
* "4": {
|
|
489
|
+
* "choices": [
|
|
490
|
+
* "5"
|
|
491
|
+
* ]
|
|
492
|
+
* },
|
|
493
|
+
* "5": {
|
|
494
|
+
* "users": [
|
|
495
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae"
|
|
496
|
+
* ]
|
|
497
|
+
* }
|
|
498
|
+
* }
|
|
499
|
+
* },
|
|
500
|
+
* "isAdfRequest": false,
|
|
501
|
+
* "requestFieldValues": {
|
|
502
|
+
* "description": "I need a new *mouse* for my Mac",
|
|
503
|
+
* "summary": "Request JSD help via REST"
|
|
504
|
+
* },
|
|
505
|
+
* "requestParticipants": [
|
|
506
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae"
|
|
507
|
+
* ],
|
|
508
|
+
* "requestTypeId": "25",
|
|
509
|
+
* "serviceDeskId": "10"
|
|
510
|
+
* }
|
|
511
|
+
*/
|
|
512
|
+
requestCreateDto: RequestCreateDto;
|
|
513
|
+
}) => Promise<CustomerRequestDto>;
|
|
514
|
+
/**
|
|
515
|
+
* This method creates a public or private (internal) comment on a customer
|
|
516
|
+
* request, with the comment visibility set by `public`. The user recorded as the
|
|
517
|
+
* author of the comment.
|
|
518
|
+
*
|
|
519
|
+
* **[Permissions](#permissions) required**: User has Add Comments permission.
|
|
520
|
+
*
|
|
521
|
+
* **Request limitations**: Customers can set comments to public visibility only.
|
|
522
|
+
*
|
|
523
|
+
* @returns Returns the comment.
|
|
524
|
+
*
|
|
525
|
+
* example: {
|
|
526
|
+
* "_expands": [
|
|
527
|
+
* "attachment",
|
|
528
|
+
* "renderedBody"
|
|
529
|
+
* ],
|
|
530
|
+
* "id": "1000",
|
|
531
|
+
* "body": "Hello there",
|
|
532
|
+
* "public": true,
|
|
533
|
+
* "author": {
|
|
534
|
+
* "accountId":
|
|
535
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
536
|
+
* "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
537
|
+
* "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
538
|
+
* "emailAddress": "fred@example.com",
|
|
539
|
+
* "displayName": "Fred F. User",
|
|
540
|
+
* "active": true,
|
|
541
|
+
* "timeZone": "Australia/Sydney",
|
|
542
|
+
* "_links": {
|
|
543
|
+
* "jiraRest":
|
|
544
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
545
|
+
* "avatarUrls": {
|
|
546
|
+
* "16x16":
|
|
547
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
548
|
+
* "24x24":
|
|
549
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
550
|
+
* "32x32":
|
|
551
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
552
|
+
* "48x48":
|
|
553
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
554
|
+
* },
|
|
555
|
+
* "self":
|
|
556
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
557
|
+
* }
|
|
558
|
+
* },
|
|
559
|
+
* "created": {
|
|
560
|
+
* "epochMillis": 1444360920000,
|
|
561
|
+
* "friendly": "Today 10:22 AM",
|
|
562
|
+
* "iso8601": "2015-10-09T10:22:00+0700",
|
|
563
|
+
* "jira": "2015-10-09T10:22:00.000+0700"
|
|
564
|
+
* },
|
|
565
|
+
* "_links": {
|
|
566
|
+
* "self":
|
|
567
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
|
|
568
|
+
* }
|
|
569
|
+
* }
|
|
570
|
+
* @path {POST} /rest/servicedeskapi/request/{issueIdOrKey}/comment
|
|
571
|
+
* @scopes-current write:servicedesk-request
|
|
572
|
+
* @scopes-beta read:request.comment:jira-service-management,
|
|
573
|
+
* write:request.comment:jira-service-management, read:user:jira
|
|
574
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-post
|
|
575
|
+
*/
|
|
576
|
+
createRequestComment: ({ issueIdOrKey, commentCreateDto, }: {
|
|
577
|
+
/** The ID or key of the customer request to which the comment will be added. */
|
|
578
|
+
issueIdOrKey: string;
|
|
579
|
+
/**
|
|
580
|
+
* @example {
|
|
581
|
+
* "body": "Hello there",
|
|
582
|
+
* "public": true
|
|
583
|
+
* }
|
|
584
|
+
*/
|
|
585
|
+
commentCreateDto: CommentCreateDto;
|
|
586
|
+
}) => Promise<CommentDto>;
|
|
587
|
+
/**
|
|
588
|
+
* This method deletes the feedback of request using it's `requestKey` or
|
|
589
|
+
* `requestId`
|
|
590
|
+
*
|
|
591
|
+
* **[Permissions](#permissions) required**: User must be the reporter or an
|
|
592
|
+
* Atlassian Connect app.
|
|
593
|
+
*
|
|
594
|
+
* @returns No content.
|
|
595
|
+
* @path {DELETE} /rest/servicedeskapi/request/{requestIdOrKey}/feedback
|
|
596
|
+
* @scopes-current write:servicedesk-request
|
|
597
|
+
* @scopes-beta read:request.feedback:jira-service-management,
|
|
598
|
+
* delete:request.feedback:jira-service-management, read:user:jira
|
|
599
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-requestidorkey-feedback-delete
|
|
600
|
+
*/
|
|
601
|
+
deleteFeedback: ({ requestIdOrKey, }: {
|
|
602
|
+
/** The id or the key of the request to post the feedback on */
|
|
603
|
+
requestIdOrKey: string;
|
|
604
|
+
}) => Promise<void>;
|
|
605
|
+
/**
|
|
606
|
+
* This method returns an approval. Use this method to determine the status of an
|
|
607
|
+
* approval and the list of approvers.
|
|
608
|
+
*
|
|
609
|
+
* **[Permissions](#permissions) required**: Permission to view the customer
|
|
610
|
+
* request.
|
|
611
|
+
*
|
|
612
|
+
* @returns Returns the requested approval.
|
|
613
|
+
*
|
|
614
|
+
* example: {
|
|
615
|
+
* "id": "1",
|
|
616
|
+
* "name": "Please approve this request",
|
|
617
|
+
* "finalDecision": "approved",
|
|
618
|
+
* "canAnswerApproval": false,
|
|
619
|
+
* "approvers": [
|
|
620
|
+
* {
|
|
621
|
+
* "approver": {
|
|
622
|
+
* "accountId":
|
|
623
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
624
|
+
* "name":
|
|
625
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
626
|
+
* "key":
|
|
627
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
628
|
+
* "emailAddress": "fred@example.com",
|
|
629
|
+
* "displayName": "Fred F. User",
|
|
630
|
+
* "active": true,
|
|
631
|
+
* "timeZone": "Australia/Sydney",
|
|
632
|
+
* "_links": {
|
|
633
|
+
* "jiraRest":
|
|
634
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
635
|
+
* "avatarUrls": {
|
|
636
|
+
* "16x16":
|
|
637
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
638
|
+
* "24x24":
|
|
639
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
640
|
+
* "32x32":
|
|
641
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
642
|
+
* "48x48":
|
|
643
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
644
|
+
* },
|
|
645
|
+
* "self":
|
|
646
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
647
|
+
* }
|
|
648
|
+
* },
|
|
649
|
+
* "approverDecision": "approved"
|
|
650
|
+
* }
|
|
651
|
+
* ],
|
|
652
|
+
* "createdDate": {
|
|
653
|
+
* "epochMillis": 1475046060000,
|
|
654
|
+
* "friendly": "Monday 14:01 PM",
|
|
655
|
+
* "iso8601": "2016-09-28T14:01:00+0700",
|
|
656
|
+
* "jira": "2016-09-28T14:01:00.000+0700"
|
|
657
|
+
* },
|
|
658
|
+
* "completedDate": {
|
|
659
|
+
* "epochMillis": 1475134200000,
|
|
660
|
+
* "friendly": "Today 14:30 PM",
|
|
661
|
+
* "iso8601": "2016-09-29T14:30:00+0700",
|
|
662
|
+
* "jira": "2016-09-29T14:30:00.000+0700"
|
|
663
|
+
* },
|
|
664
|
+
* "_links": {
|
|
665
|
+
* "self":
|
|
666
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1"
|
|
667
|
+
* }
|
|
668
|
+
* }
|
|
669
|
+
* @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}
|
|
670
|
+
* @scopes-current read:servicedesk-request
|
|
671
|
+
* @scopes-beta read:request.approval:jira-service-management, read:user:jira
|
|
672
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-approval-approvalid-get
|
|
673
|
+
*/
|
|
674
|
+
getApprovalById: ({ issueIdOrKey, approvalId, }: {
|
|
675
|
+
/** The ID or key of the customer request the approval is on. */
|
|
676
|
+
issueIdOrKey: string;
|
|
677
|
+
/** The ID of the approval to be returned. */
|
|
678
|
+
approvalId: number;
|
|
679
|
+
}) => Promise<ApprovalDto>;
|
|
680
|
+
/**
|
|
681
|
+
* This method returns all approvals on a customer request.
|
|
682
|
+
*
|
|
683
|
+
* **[Permissions](#permissions) required**: Permission to view the customer
|
|
684
|
+
* request.
|
|
685
|
+
*
|
|
686
|
+
* @returns Returns the customer request's approvals.
|
|
687
|
+
*
|
|
688
|
+
* example: {
|
|
689
|
+
* "_expands": [],
|
|
690
|
+
* "size": 3,
|
|
691
|
+
* "start": 3,
|
|
692
|
+
* "limit": 3,
|
|
693
|
+
* "isLastPage": false,
|
|
694
|
+
* "_links": {
|
|
695
|
+
* "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
|
|
696
|
+
* "context": "context",
|
|
697
|
+
* "next":
|
|
698
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval?start=6&limit=3",
|
|
699
|
+
* "prev":
|
|
700
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval?start=0&limit=3"
|
|
701
|
+
* },
|
|
702
|
+
* "values": [
|
|
703
|
+
* {
|
|
704
|
+
* "id": "1",
|
|
705
|
+
* "name": "Please approve this request",
|
|
706
|
+
* "finalDecision": "approved",
|
|
707
|
+
* "canAnswerApproval": false,
|
|
708
|
+
* "approvers": [
|
|
709
|
+
* {
|
|
710
|
+
* "approver": {
|
|
711
|
+
* "accountId":
|
|
712
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
713
|
+
* "name":
|
|
714
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
715
|
+
* "key":
|
|
716
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
717
|
+
* "emailAddress": "fred@example.com",
|
|
718
|
+
* "displayName": "Fred F. User",
|
|
719
|
+
* "active": true,
|
|
720
|
+
* "timeZone": "Australia/Sydney",
|
|
721
|
+
* "_links": {
|
|
722
|
+
* "jiraRest":
|
|
723
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
724
|
+
* "avatarUrls": {
|
|
725
|
+
* "16x16":
|
|
726
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
727
|
+
* "24x24":
|
|
728
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
729
|
+
* "32x32":
|
|
730
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
731
|
+
* "48x48":
|
|
732
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
733
|
+
* },
|
|
734
|
+
* "self":
|
|
735
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
736
|
+
* }
|
|
737
|
+
* },
|
|
738
|
+
* "approverDecision": "approved"
|
|
739
|
+
* }
|
|
740
|
+
* ],
|
|
741
|
+
* "createdDate": {
|
|
742
|
+
* "epochMillis": 1475046060000,
|
|
743
|
+
* "friendly": "Monday 14:01 PM",
|
|
744
|
+
* "iso8601": "2016-09-28T14:01:00+0700",
|
|
745
|
+
* "jira": "2016-09-28T14:01:00.000+0700"
|
|
746
|
+
* },
|
|
747
|
+
* "completedDate": {
|
|
748
|
+
* "epochMillis": 1475134200000,
|
|
749
|
+
* "friendly": "Today 14:30 PM",
|
|
750
|
+
* "iso8601": "2016-09-29T14:30:00+0700",
|
|
751
|
+
* "jira": "2016-09-29T14:30:00.000+0700"
|
|
752
|
+
* },
|
|
753
|
+
* "_links": {
|
|
754
|
+
* "self":
|
|
755
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/1"
|
|
756
|
+
* }
|
|
757
|
+
* },
|
|
758
|
+
* {
|
|
759
|
+
* "id": "2",
|
|
760
|
+
* "name": "Waiting for approval",
|
|
761
|
+
* "finalDecision": "declined",
|
|
762
|
+
* "canAnswerApproval": false,
|
|
763
|
+
* "approvers": [
|
|
764
|
+
* {
|
|
765
|
+
* "approver": {
|
|
766
|
+
* "accountId":
|
|
767
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
768
|
+
* "name":
|
|
769
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
770
|
+
* "key":
|
|
771
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
772
|
+
* "emailAddress": "fred@example.com",
|
|
773
|
+
* "displayName": "Fred F. User",
|
|
774
|
+
* "active": true,
|
|
775
|
+
* "timeZone": "Australia/Sydney",
|
|
776
|
+
* "_links": {
|
|
777
|
+
* "jiraRest":
|
|
778
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
779
|
+
* "avatarUrls": {
|
|
780
|
+
* "16x16":
|
|
781
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
782
|
+
* "24x24":
|
|
783
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
784
|
+
* "32x32":
|
|
785
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
786
|
+
* "48x48":
|
|
787
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
788
|
+
* },
|
|
789
|
+
* "self":
|
|
790
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
791
|
+
* }
|
|
792
|
+
* },
|
|
793
|
+
* "approverDecision": "approved"
|
|
794
|
+
* }
|
|
795
|
+
* ],
|
|
796
|
+
* "createdDate": {
|
|
797
|
+
* "epochMillis": 1475650860000,
|
|
798
|
+
* "friendly": "Wednesday 14:01 PM",
|
|
799
|
+
* "iso8601": "2016-10-05T14:01:00+0700",
|
|
800
|
+
* "jira": "2016-10-05T14:01:00.000+0700"
|
|
801
|
+
* },
|
|
802
|
+
* "completedDate": {
|
|
803
|
+
* "epochMillis": 1475739000000,
|
|
804
|
+
* "friendly": "Thursday 14:30 PM",
|
|
805
|
+
* "iso8601": "2016-10-06T14:30:00+0700",
|
|
806
|
+
* "jira": "2016-10-06T14:30:00.000+0700"
|
|
807
|
+
* },
|
|
808
|
+
* "_links": {
|
|
809
|
+
* "self":
|
|
810
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/2/approval/2"
|
|
811
|
+
* }
|
|
812
|
+
* }
|
|
813
|
+
* ]
|
|
814
|
+
* }
|
|
815
|
+
* @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/approval
|
|
816
|
+
* @scopes-current read:servicedesk-request
|
|
817
|
+
* @scopes-beta read:request.approval:jira-service-management, read:user:jira
|
|
818
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-approval-get
|
|
819
|
+
*/
|
|
820
|
+
getApprovals: ({ issueIdOrKey, start, limit, }: {
|
|
821
|
+
/** The ID or key of the customer request to be queried for its approvals. */
|
|
822
|
+
issueIdOrKey: string;
|
|
823
|
+
/**
|
|
824
|
+
* The starting index of the returned objects. Base index: 0. See the
|
|
825
|
+
* [Pagination](#pagination) section for more details.
|
|
826
|
+
*/
|
|
827
|
+
start?: number | undefined;
|
|
828
|
+
/**
|
|
829
|
+
* The maximum number of approvals to return per page. Default: 50. See the
|
|
830
|
+
* [Pagination](#pagination) section for more details.
|
|
831
|
+
*/
|
|
832
|
+
limit?: number | undefined;
|
|
833
|
+
}) => Promise<PagedDtoApprovalDto>;
|
|
834
|
+
/**
|
|
835
|
+
* Returns the contents of an attachment.
|
|
836
|
+
*
|
|
837
|
+
* To return a thumbnail of the attachment, use
|
|
838
|
+
* [servicedeskapi/request/\{issueIdOrKey\}/attachment/\{attachmentId\}/thumbnail](./#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-thumbnail-get).
|
|
839
|
+
*
|
|
840
|
+
* **[Permissions](#permissions) required:** For the issue containing the
|
|
841
|
+
* attachment:
|
|
842
|
+
*
|
|
843
|
+
* * *Browse projects* [project
|
|
844
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
|
|
845
|
+
* issue is in.
|
|
846
|
+
* * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
|
|
847
|
+
* configured, issue-level security permission to view the issue.
|
|
848
|
+
*
|
|
849
|
+
* @returns 200 response
|
|
850
|
+
* @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}
|
|
851
|
+
* @scopes-current read:servicedesk-request
|
|
852
|
+
* @scopes-beta read:request.attachment:jira-service-management, read:user:jira
|
|
853
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-get
|
|
854
|
+
*/
|
|
855
|
+
getAttachmentContent: ({ issueIdOrKey, attachmentId, }: {
|
|
856
|
+
/** The ID or key for the customer request the attachment is associated with */
|
|
857
|
+
issueIdOrKey: string;
|
|
858
|
+
/** The ID for the attachment */
|
|
859
|
+
attachmentId: number;
|
|
860
|
+
}) => Promise<unknown>;
|
|
861
|
+
/**
|
|
862
|
+
* This method returns all the attachments for a customer requests.
|
|
863
|
+
*
|
|
864
|
+
* **[Permissions](#permissions) required**: Permission to view the customer
|
|
865
|
+
* request.
|
|
866
|
+
*
|
|
867
|
+
* **Response limitations**: Customers will only get a list of public attachments.
|
|
868
|
+
*
|
|
869
|
+
* @returns Returns the visible attachments from the customer request.
|
|
870
|
+
*
|
|
871
|
+
* example: {
|
|
872
|
+
* "_expands": [],
|
|
873
|
+
* "size": 2,
|
|
874
|
+
* "start": 2,
|
|
875
|
+
* "limit": 2,
|
|
876
|
+
* "isLastPage": false,
|
|
877
|
+
* "_links": {
|
|
878
|
+
* "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
|
|
879
|
+
* "context": "context",
|
|
880
|
+
* "next":
|
|
881
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2",
|
|
882
|
+
* "prev":
|
|
883
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2"
|
|
884
|
+
* },
|
|
885
|
+
* "values": [
|
|
886
|
+
* {
|
|
887
|
+
* "filename": "screenshot.png",
|
|
888
|
+
* "author": {
|
|
889
|
+
* "accountId":
|
|
890
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
891
|
+
* "name":
|
|
892
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
893
|
+
* "key":
|
|
894
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
895
|
+
* "emailAddress": "fred@example.com",
|
|
896
|
+
* "displayName": "Fred F. User",
|
|
897
|
+
* "active": true,
|
|
898
|
+
* "timeZone": "Australia/Sydney",
|
|
899
|
+
* "_links": {
|
|
900
|
+
* "jiraRest":
|
|
901
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
902
|
+
* "avatarUrls": {
|
|
903
|
+
* "16x16":
|
|
904
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
905
|
+
* "24x24":
|
|
906
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
907
|
+
* "32x32":
|
|
908
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
909
|
+
* "48x48":
|
|
910
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
911
|
+
* },
|
|
912
|
+
* "self":
|
|
913
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
914
|
+
* }
|
|
915
|
+
* },
|
|
916
|
+
* "created": {
|
|
917
|
+
* "epochMillis": 1444360920000,
|
|
918
|
+
* "friendly": "Today 10:22 AM",
|
|
919
|
+
* "iso8601": "2015-10-09T10:22:00+0700",
|
|
920
|
+
* "jira": "2015-10-09T10:22:00.000+0700"
|
|
921
|
+
* },
|
|
922
|
+
* "size": 23123,
|
|
923
|
+
* "mimeType": "image/png",
|
|
924
|
+
* "_links": {
|
|
925
|
+
* "jiraRest":
|
|
926
|
+
* "https://your-domain.atlassian.net/rest/api/2/attachment/10000",
|
|
927
|
+
* "content":
|
|
928
|
+
* "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png",
|
|
929
|
+
* "thumbnail":
|
|
930
|
+
* "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png"
|
|
931
|
+
* }
|
|
932
|
+
* },
|
|
933
|
+
* {
|
|
934
|
+
* "filename": "log.txt",
|
|
935
|
+
* "author": {
|
|
936
|
+
* "accountId":
|
|
937
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
938
|
+
* "name":
|
|
939
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
940
|
+
* "key":
|
|
941
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
942
|
+
* "emailAddress": "fred@example.com",
|
|
943
|
+
* "displayName": "Fred F. User",
|
|
944
|
+
* "active": true,
|
|
945
|
+
* "timeZone": "Australia/Sydney",
|
|
946
|
+
* "_links": {
|
|
947
|
+
* "jiraRest":
|
|
948
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
949
|
+
* "avatarUrls": {
|
|
950
|
+
* "16x16":
|
|
951
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
952
|
+
* "24x24":
|
|
953
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
954
|
+
* "32x32":
|
|
955
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
956
|
+
* "48x48":
|
|
957
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
958
|
+
* },
|
|
959
|
+
* "self":
|
|
960
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
961
|
+
* }
|
|
962
|
+
* },
|
|
963
|
+
* "created": {
|
|
964
|
+
* "epochMillis": 1444360920000,
|
|
965
|
+
* "friendly": "Today 10:22 AM",
|
|
966
|
+
* "iso8601": "2015-10-09T10:22:00+0700",
|
|
967
|
+
* "jira": "2015-10-09T10:22:00.000+0700"
|
|
968
|
+
* },
|
|
969
|
+
* "size": 32132,
|
|
970
|
+
* "mimeType": "text/plain",
|
|
971
|
+
* "_links": {
|
|
972
|
+
* "jiraRest":
|
|
973
|
+
* "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
|
|
974
|
+
* "content":
|
|
975
|
+
* "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt"
|
|
976
|
+
* }
|
|
977
|
+
* }
|
|
978
|
+
* ]
|
|
979
|
+
* }
|
|
980
|
+
* @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/attachment
|
|
981
|
+
* @scopes-current read:servicedesk-request
|
|
982
|
+
* @scopes-beta read:request.attachment:jira-service-management, read:user:jira
|
|
983
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-get
|
|
984
|
+
*/
|
|
985
|
+
getAttachmentsForRequest: ({ issueIdOrKey, start, limit, }: {
|
|
986
|
+
/** The ID or key of the customer request from which the attachments will be listed. */
|
|
987
|
+
issueIdOrKey: string;
|
|
988
|
+
/**
|
|
989
|
+
* The starting index of the returned attachment. Base index: 0. See the
|
|
990
|
+
* [Pagination](#pagination) section for more details.
|
|
991
|
+
*/
|
|
992
|
+
start: number;
|
|
993
|
+
/**
|
|
994
|
+
* The maximum number of comments to return per page. Default: 50. See the
|
|
995
|
+
* [Pagination](#pagination) section for more details.
|
|
996
|
+
*/
|
|
997
|
+
limit: number;
|
|
998
|
+
}) => Promise<PagedDtoAttachmentDto>;
|
|
999
|
+
/**
|
|
1000
|
+
* Returns the thumbnail of an attachment.
|
|
1001
|
+
*
|
|
1002
|
+
* To return the attachment contents, use
|
|
1003
|
+
* [servicedeskapi/request/\{issueIdOrKey\}/attachment/\{attachmentId\}](#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-get).
|
|
1004
|
+
*
|
|
1005
|
+
* **[Permissions](#permissions) required:** For the issue containing the
|
|
1006
|
+
* attachment:
|
|
1007
|
+
*
|
|
1008
|
+
* * *Browse projects* [project
|
|
1009
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
|
|
1010
|
+
* issue is in.
|
|
1011
|
+
* * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
|
|
1012
|
+
* configured, issue-level security permission to view the issue.
|
|
1013
|
+
*
|
|
1014
|
+
* @returns 200 response
|
|
1015
|
+
* @path {GET}
|
|
1016
|
+
* /rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}/thumbnail
|
|
1017
|
+
* @scopes-current read:servicedesk-request
|
|
1018
|
+
* @scopes-beta read:request.attachment:jira-service-management, read:user:jira
|
|
1019
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-thumbnail-get
|
|
1020
|
+
*/
|
|
1021
|
+
getAttachmentThumbnail: ({ issueIdOrKey, attachmentId, }: {
|
|
1022
|
+
/** The ID or key for the customer request the attachment is associated with */
|
|
1023
|
+
issueIdOrKey: string;
|
|
1024
|
+
/** The ID of the attachment. */
|
|
1025
|
+
attachmentId: number;
|
|
1026
|
+
}) => Promise<unknown>;
|
|
1027
|
+
/**
|
|
1028
|
+
* This method returns the attachments referenced in a comment.
|
|
1029
|
+
*
|
|
1030
|
+
* **[Permissions](#permissions) required**: Permission to view the customer
|
|
1031
|
+
* request.
|
|
1032
|
+
*
|
|
1033
|
+
* **Response limitations**: Customers can only view public comments, and retrieve
|
|
1034
|
+
* their attachments, on requests where they are the reporter or a participant
|
|
1035
|
+
* whereas agents can see both internal and public comments.
|
|
1036
|
+
*
|
|
1037
|
+
* @returns Returns the attachments, on the specified page of the results.
|
|
1038
|
+
*
|
|
1039
|
+
* example: {
|
|
1040
|
+
* "_expands": [],
|
|
1041
|
+
* "size": 2,
|
|
1042
|
+
* "start": 2,
|
|
1043
|
+
* "limit": 2,
|
|
1044
|
+
* "isLastPage": false,
|
|
1045
|
+
* "_links": {
|
|
1046
|
+
* "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
|
|
1047
|
+
* "context": "context",
|
|
1048
|
+
* "next":
|
|
1049
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=4&limit=2",
|
|
1050
|
+
* "prev":
|
|
1051
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/IT-15/comment/1001/attachment?start=0&limit=2"
|
|
1052
|
+
* },
|
|
1053
|
+
* "values": [
|
|
1054
|
+
* {
|
|
1055
|
+
* "filename": "screenshot.png",
|
|
1056
|
+
* "author": {
|
|
1057
|
+
* "accountId":
|
|
1058
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1059
|
+
* "name":
|
|
1060
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1061
|
+
* "key":
|
|
1062
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1063
|
+
* "emailAddress": "fred@example.com",
|
|
1064
|
+
* "displayName": "Fred F. User",
|
|
1065
|
+
* "active": true,
|
|
1066
|
+
* "timeZone": "Australia/Sydney",
|
|
1067
|
+
* "_links": {
|
|
1068
|
+
* "jiraRest":
|
|
1069
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1070
|
+
* "avatarUrls": {
|
|
1071
|
+
* "16x16":
|
|
1072
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
1073
|
+
* "24x24":
|
|
1074
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
1075
|
+
* "32x32":
|
|
1076
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
1077
|
+
* "48x48":
|
|
1078
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
1079
|
+
* },
|
|
1080
|
+
* "self":
|
|
1081
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
1082
|
+
* }
|
|
1083
|
+
* },
|
|
1084
|
+
* "created": {
|
|
1085
|
+
* "epochMillis": 1444360920000,
|
|
1086
|
+
* "friendly": "Today 10:22 AM",
|
|
1087
|
+
* "iso8601": "2015-10-09T10:22:00+0700",
|
|
1088
|
+
* "jira": "2015-10-09T10:22:00.000+0700"
|
|
1089
|
+
* },
|
|
1090
|
+
* "size": 23123,
|
|
1091
|
+
* "mimeType": "image/png",
|
|
1092
|
+
* "_links": {
|
|
1093
|
+
* "jiraRest":
|
|
1094
|
+
* "https://your-domain.atlassian.net/rest/api/2/attachment/10000",
|
|
1095
|
+
* "content":
|
|
1096
|
+
* "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10000/screenshot.png",
|
|
1097
|
+
* "thumbnail":
|
|
1098
|
+
* "https://your-domain.atlassian.net/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png"
|
|
1099
|
+
* }
|
|
1100
|
+
* },
|
|
1101
|
+
* {
|
|
1102
|
+
* "filename": "log.txt",
|
|
1103
|
+
* "author": {
|
|
1104
|
+
* "accountId":
|
|
1105
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1106
|
+
* "name":
|
|
1107
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1108
|
+
* "key":
|
|
1109
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1110
|
+
* "emailAddress": "fred@example.com",
|
|
1111
|
+
* "displayName": "Fred F. User",
|
|
1112
|
+
* "active": true,
|
|
1113
|
+
* "timeZone": "Australia/Sydney",
|
|
1114
|
+
* "_links": {
|
|
1115
|
+
* "jiraRest":
|
|
1116
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1117
|
+
* "avatarUrls": {
|
|
1118
|
+
* "16x16":
|
|
1119
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
1120
|
+
* "24x24":
|
|
1121
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
1122
|
+
* "32x32":
|
|
1123
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
1124
|
+
* "48x48":
|
|
1125
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
1126
|
+
* },
|
|
1127
|
+
* "self":
|
|
1128
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
1129
|
+
* }
|
|
1130
|
+
* },
|
|
1131
|
+
* "created": {
|
|
1132
|
+
* "epochMillis": 1444360920000,
|
|
1133
|
+
* "friendly": "Today 10:22 AM",
|
|
1134
|
+
* "iso8601": "2015-10-09T10:22:00+0700",
|
|
1135
|
+
* "jira": "2015-10-09T10:22:00.000+0700"
|
|
1136
|
+
* },
|
|
1137
|
+
* "size": 32132,
|
|
1138
|
+
* "mimeType": "text/plain",
|
|
1139
|
+
* "_links": {
|
|
1140
|
+
* "jiraRest":
|
|
1141
|
+
* "https://your-domain.atlassian.net/rest/api/2/attachment/10001",
|
|
1142
|
+
* "content":
|
|
1143
|
+
* "https://your-domain.atlassian.net/servicedesk/customershim/secure/attachment/10001/log.txt"
|
|
1144
|
+
* }
|
|
1145
|
+
* }
|
|
1146
|
+
* ]
|
|
1147
|
+
* }
|
|
1148
|
+
* @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment
|
|
1149
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-commentid-attachment-get
|
|
1150
|
+
*/
|
|
1151
|
+
getCommentAttachments: ({ issueIdOrKey, commentId, start, limit, }: {
|
|
1152
|
+
/** The ID or key of the customer request that contains the comment. */
|
|
1153
|
+
issueIdOrKey: string;
|
|
1154
|
+
/** The ID of the comment. */
|
|
1155
|
+
commentId: number;
|
|
1156
|
+
/**
|
|
1157
|
+
* The starting index of the returned comments. Base index: 0. See the
|
|
1158
|
+
* [Pagination](#pagination) section for more details.
|
|
1159
|
+
*/
|
|
1160
|
+
start?: number | undefined;
|
|
1161
|
+
/**
|
|
1162
|
+
* The maximum number of comments to return per page. Default: 50. See the
|
|
1163
|
+
* [Pagination](#pagination) section for more details.
|
|
1164
|
+
*/
|
|
1165
|
+
limit?: number | undefined;
|
|
1166
|
+
}) => Promise<PagedDtoAttachmentDto>;
|
|
1167
|
+
/**
|
|
1168
|
+
* This method returns a customer request.
|
|
1169
|
+
*
|
|
1170
|
+
* **[Permissions](#permissions) required**: Permission to access the specified
|
|
1171
|
+
* service desk.
|
|
1172
|
+
*
|
|
1173
|
+
* **Response limitations**: For customers, only a request they created, was
|
|
1174
|
+
* created on their behalf, or they are participating in will be returned.
|
|
1175
|
+
*
|
|
1176
|
+
* **Note:** `requestFieldValues` does not include hidden fields. To get a list of
|
|
1177
|
+
* request type fields that includes hidden fields, see
|
|
1178
|
+
* [/rest/servicedeskapi/servicedesk/\{serviceDeskId\}/requesttype/\{requestTypeId\}/field](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk/#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-field-get)
|
|
1179
|
+
*
|
|
1180
|
+
* @returns Returns the customer request.
|
|
1181
|
+
*
|
|
1182
|
+
* example: {
|
|
1183
|
+
* "_expands": [
|
|
1184
|
+
* "participant",
|
|
1185
|
+
* "status",
|
|
1186
|
+
* "sla",
|
|
1187
|
+
* "requestType",
|
|
1188
|
+
* "serviceDesk",
|
|
1189
|
+
* "attachment",
|
|
1190
|
+
* "action",
|
|
1191
|
+
* "comment"
|
|
1192
|
+
* ],
|
|
1193
|
+
* "issueId": "107001",
|
|
1194
|
+
* "issueKey": "HELPDESK-1",
|
|
1195
|
+
* "requestTypeId": "25",
|
|
1196
|
+
* "serviceDeskId": "10",
|
|
1197
|
+
* "createdDate": {
|
|
1198
|
+
* "epochMillis": 1444290120000,
|
|
1199
|
+
* "friendly": "Monday 14:42 PM",
|
|
1200
|
+
* "iso8601": "2015-10-08T14:42:00+0700",
|
|
1201
|
+
* "jira": "2015-10-08T14:42:00.000+0700"
|
|
1202
|
+
* },
|
|
1203
|
+
* "reporter": {
|
|
1204
|
+
* "accountId":
|
|
1205
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1206
|
+
* "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1207
|
+
* "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1208
|
+
* "emailAddress": "fred@example.com",
|
|
1209
|
+
* "displayName": "Fred F. User",
|
|
1210
|
+
* "active": true,
|
|
1211
|
+
* "timeZone": "Australia/Sydney",
|
|
1212
|
+
* "_links": {
|
|
1213
|
+
* "jiraRest":
|
|
1214
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1215
|
+
* "avatarUrls": {
|
|
1216
|
+
* "16x16":
|
|
1217
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
1218
|
+
* "24x24":
|
|
1219
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
1220
|
+
* "32x32":
|
|
1221
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
1222
|
+
* "48x48":
|
|
1223
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
1224
|
+
* },
|
|
1225
|
+
* "self":
|
|
1226
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
1227
|
+
* }
|
|
1228
|
+
* },
|
|
1229
|
+
* "requestFieldValues": [
|
|
1230
|
+
* {
|
|
1231
|
+
* "fieldId": "summary",
|
|
1232
|
+
* "label": "What do you need?",
|
|
1233
|
+
* "value": "Request JSD help via REST"
|
|
1234
|
+
* },
|
|
1235
|
+
* {
|
|
1236
|
+
* "fieldId": "description",
|
|
1237
|
+
* "label": "Why do you need this?",
|
|
1238
|
+
* "renderedValue": {
|
|
1239
|
+
* "html": "<p>I need a new <b>mouse</b> for my Mac</p>"
|
|
1240
|
+
* },
|
|
1241
|
+
* "value": "I need a new *mouse* for my Mac"
|
|
1242
|
+
* }
|
|
1243
|
+
* ],
|
|
1244
|
+
* "currentStatus": {
|
|
1245
|
+
* "status": "Waiting for Support",
|
|
1246
|
+
* "statusCategory": "NEW",
|
|
1247
|
+
* "statusDate": {
|
|
1248
|
+
* "epochMillis": 1444287660000,
|
|
1249
|
+
* "friendly": "Today 14:01 PM",
|
|
1250
|
+
* "iso8601": "2015-10-08T14:01:00+0700",
|
|
1251
|
+
* "jira": "2015-10-08T14:01:00.000+0700"
|
|
1252
|
+
* }
|
|
1253
|
+
* },
|
|
1254
|
+
* "_links": {
|
|
1255
|
+
* "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107001",
|
|
1256
|
+
* "web":
|
|
1257
|
+
* "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1",
|
|
1258
|
+
* "self":
|
|
1259
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001",
|
|
1260
|
+
* "agent": "https://your-domain.atlassian.net/browse/HELPDESK-1"
|
|
1261
|
+
* }
|
|
1262
|
+
* }
|
|
1263
|
+
* @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}
|
|
1264
|
+
* @scopes-current read:servicedesk-request
|
|
1265
|
+
* @scopes-beta read:request:jira-service-management, read:user:jira
|
|
1266
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-get
|
|
1267
|
+
*/
|
|
1268
|
+
getCustomerRequestByIdOrKey: ({ issueIdOrKey, expand, }: {
|
|
1269
|
+
/** The ID or Key of the customer request to be returned */
|
|
1270
|
+
issueIdOrKey: string;
|
|
1271
|
+
/**
|
|
1272
|
+
* A multi-value parameter indicating which properties of the customer request to
|
|
1273
|
+
* expand, where:
|
|
1274
|
+
*
|
|
1275
|
+
* * `serviceDesk` returns additional service desk details.
|
|
1276
|
+
* * `requestType` returns additional customer request type details.
|
|
1277
|
+
* * `participant` returns the participant details.
|
|
1278
|
+
* * `sla` returns the SLA information.
|
|
1279
|
+
* * `status` returns the status transitions, in chronological order.
|
|
1280
|
+
* * `attachment` returns the attachments.
|
|
1281
|
+
* * `action` returns the actions that the user can or cannot perform.
|
|
1282
|
+
* * `comment` returns the comments.
|
|
1283
|
+
* * `comment.attachment` returns the attachment details for each comment.
|
|
1284
|
+
* * `comment.renderedBody` (Experimental) return the rendered body in HTML
|
|
1285
|
+
* format (in addition to the raw body) for each comment.
|
|
1286
|
+
*/
|
|
1287
|
+
expand?: string[] | undefined;
|
|
1288
|
+
}) => Promise<CustomerRequestDto>;
|
|
1289
|
+
/**
|
|
1290
|
+
* This method returns all customer requests for the user executing the query.
|
|
1291
|
+
*
|
|
1292
|
+
* The returned customer requests are ordered chronologically by the latest
|
|
1293
|
+
* activity on each request. For example, the latest status transition or comment.
|
|
1294
|
+
*
|
|
1295
|
+
* **[Permissions](#permissions) required**: Permission to access the specified
|
|
1296
|
+
* service desk.
|
|
1297
|
+
*
|
|
1298
|
+
* **Response limitations**: For customers, the list returned will include request
|
|
1299
|
+
* they created (or were created on their behalf) or are participating in only.
|
|
1300
|
+
*
|
|
1301
|
+
* @returns Returns the customer requests, on the specified page of the results.
|
|
1302
|
+
*
|
|
1303
|
+
* example: {
|
|
1304
|
+
* "_expands": [
|
|
1305
|
+
* "participant",
|
|
1306
|
+
* "status",
|
|
1307
|
+
* "sla",
|
|
1308
|
+
* "requestType",
|
|
1309
|
+
* "serviceDesk",
|
|
1310
|
+
* "attachment",
|
|
1311
|
+
* "action",
|
|
1312
|
+
* "comment"
|
|
1313
|
+
* ],
|
|
1314
|
+
* "size": 3,
|
|
1315
|
+
* "start": 3,
|
|
1316
|
+
* "limit": 3,
|
|
1317
|
+
* "isLastPage": false,
|
|
1318
|
+
* "_links": {
|
|
1319
|
+
* "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
|
|
1320
|
+
* "context": "context",
|
|
1321
|
+
* "next":
|
|
1322
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request?start=6&limit=3",
|
|
1323
|
+
* "prev":
|
|
1324
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request?start=0&limit=3"
|
|
1325
|
+
* },
|
|
1326
|
+
* "values": [
|
|
1327
|
+
* {
|
|
1328
|
+
* "_expands": [
|
|
1329
|
+
* "participant",
|
|
1330
|
+
* "status",
|
|
1331
|
+
* "sla",
|
|
1332
|
+
* "requestType",
|
|
1333
|
+
* "serviceDesk",
|
|
1334
|
+
* "attachment",
|
|
1335
|
+
* "action",
|
|
1336
|
+
* "comment"
|
|
1337
|
+
* ],
|
|
1338
|
+
* "issueId": "107001",
|
|
1339
|
+
* "issueKey": "HELPDESK-1",
|
|
1340
|
+
* "requestTypeId": "25",
|
|
1341
|
+
* "serviceDeskId": "10",
|
|
1342
|
+
* "createdDate": {
|
|
1343
|
+
* "epochMillis": 1444290120000,
|
|
1344
|
+
* "friendly": "Monday 14:42 PM",
|
|
1345
|
+
* "iso8601": "2015-10-08T14:42:00+0700",
|
|
1346
|
+
* "jira": "2015-10-08T14:42:00.000+0700"
|
|
1347
|
+
* },
|
|
1348
|
+
* "reporter": {
|
|
1349
|
+
* "accountId":
|
|
1350
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1351
|
+
* "name":
|
|
1352
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1353
|
+
* "key":
|
|
1354
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1355
|
+
* "emailAddress": "fred@example.com",
|
|
1356
|
+
* "displayName": "Fred F. User",
|
|
1357
|
+
* "active": true,
|
|
1358
|
+
* "timeZone": "Australia/Sydney",
|
|
1359
|
+
* "_links": {
|
|
1360
|
+
* "jiraRest":
|
|
1361
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1362
|
+
* "avatarUrls": {
|
|
1363
|
+
* "16x16":
|
|
1364
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
1365
|
+
* "24x24":
|
|
1366
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
1367
|
+
* "32x32":
|
|
1368
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
1369
|
+
* "48x48":
|
|
1370
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
1371
|
+
* },
|
|
1372
|
+
* "self":
|
|
1373
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
1374
|
+
* }
|
|
1375
|
+
* },
|
|
1376
|
+
* "requestFieldValues": [
|
|
1377
|
+
* {
|
|
1378
|
+
* "fieldId": "summary",
|
|
1379
|
+
* "label": "What do you need?",
|
|
1380
|
+
* "value": "Request JSD help via REST"
|
|
1381
|
+
* },
|
|
1382
|
+
* {
|
|
1383
|
+
* "fieldId": "description",
|
|
1384
|
+
* "label": "Why do you need this?",
|
|
1385
|
+
* "renderedValue": {
|
|
1386
|
+
* "html": "<p>I need a new <b>mouse</b> for my Mac</p>"
|
|
1387
|
+
* },
|
|
1388
|
+
* "value": "I need a new *mouse* for my Mac"
|
|
1389
|
+
* }
|
|
1390
|
+
* ],
|
|
1391
|
+
* "currentStatus": {
|
|
1392
|
+
* "status": "Waiting for Support",
|
|
1393
|
+
* "statusCategory": "NEW",
|
|
1394
|
+
* "statusDate": {
|
|
1395
|
+
* "epochMillis": 1444287660000,
|
|
1396
|
+
* "friendly": "Today 14:01 PM",
|
|
1397
|
+
* "iso8601": "2015-10-08T14:01:00+0700",
|
|
1398
|
+
* "jira": "2015-10-08T14:01:00.000+0700"
|
|
1399
|
+
* }
|
|
1400
|
+
* },
|
|
1401
|
+
* "_links": {
|
|
1402
|
+
* "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107001",
|
|
1403
|
+
* "web":
|
|
1404
|
+
* "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1",
|
|
1405
|
+
* "self":
|
|
1406
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/107001",
|
|
1407
|
+
* "agent": "https://your-domain.atlassian.net/browse/HELPDESK-1"
|
|
1408
|
+
* }
|
|
1409
|
+
* },
|
|
1410
|
+
* {
|
|
1411
|
+
* "_expands": [
|
|
1412
|
+
* "participant",
|
|
1413
|
+
* "status",
|
|
1414
|
+
* "sla",
|
|
1415
|
+
* "requestType",
|
|
1416
|
+
* "serviceDesk",
|
|
1417
|
+
* "attachment",
|
|
1418
|
+
* "action",
|
|
1419
|
+
* "comment"
|
|
1420
|
+
* ],
|
|
1421
|
+
* "issueId": "107002",
|
|
1422
|
+
* "issueKey": "HELPDESK-2",
|
|
1423
|
+
* "requestTypeId": "25",
|
|
1424
|
+
* "serviceDeskId": "10",
|
|
1425
|
+
* "createdDate": {
|
|
1426
|
+
* "epochMillis": 1444289400000,
|
|
1427
|
+
* "friendly": "Monday 14:30 PM",
|
|
1428
|
+
* "iso8601": "2015-10-08T14:30:00+0700",
|
|
1429
|
+
* "jira": "2015-10-08T14:30:00.000+0700"
|
|
1430
|
+
* },
|
|
1431
|
+
* "reporter": {
|
|
1432
|
+
* "accountId":
|
|
1433
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1434
|
+
* "name":
|
|
1435
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1436
|
+
* "key":
|
|
1437
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1438
|
+
* "emailAddress": "fred@example.com",
|
|
1439
|
+
* "displayName": "Fred F. User",
|
|
1440
|
+
* "active": true,
|
|
1441
|
+
* "timeZone": "Australia/Sydney",
|
|
1442
|
+
* "_links": {
|
|
1443
|
+
* "jiraRest":
|
|
1444
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1445
|
+
* "avatarUrls": {
|
|
1446
|
+
* "16x16":
|
|
1447
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
1448
|
+
* "24x24":
|
|
1449
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
1450
|
+
* "32x32":
|
|
1451
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
1452
|
+
* "48x48":
|
|
1453
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
1454
|
+
* },
|
|
1455
|
+
* "self":
|
|
1456
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
1457
|
+
* }
|
|
1458
|
+
* },
|
|
1459
|
+
* "requestFieldValues": [
|
|
1460
|
+
* {
|
|
1461
|
+
* "fieldId": "summary",
|
|
1462
|
+
* "label": "What do you need?",
|
|
1463
|
+
* "value": "Request a new account"
|
|
1464
|
+
* },
|
|
1465
|
+
* {
|
|
1466
|
+
* "fieldId": "description",
|
|
1467
|
+
* "label": "Why do you need this?",
|
|
1468
|
+
* "value": "Create an account on Jira"
|
|
1469
|
+
* }
|
|
1470
|
+
* ],
|
|
1471
|
+
* "currentStatus": {
|
|
1472
|
+
* "status": "Waiting for Support",
|
|
1473
|
+
* "statusCategory": "NEW",
|
|
1474
|
+
* "statusDate": {
|
|
1475
|
+
* "epochMillis": 1444287660000,
|
|
1476
|
+
* "friendly": "Today 14:01 PM",
|
|
1477
|
+
* "iso8601": "2015-10-08T14:01:00+0700",
|
|
1478
|
+
* "jira": "2015-10-08T14:01:00.000+0700"
|
|
1479
|
+
* }
|
|
1480
|
+
* },
|
|
1481
|
+
* "_links": {
|
|
1482
|
+
* "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/107002",
|
|
1483
|
+
* "web":
|
|
1484
|
+
* "https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-2",
|
|
1485
|
+
* "self":
|
|
1486
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/107002",
|
|
1487
|
+
* "agent": "https://your-domain.atlassian.net/browse/HELPDESK-2"
|
|
1488
|
+
* }
|
|
1489
|
+
* },
|
|
1490
|
+
* {
|
|
1491
|
+
* "_expands": [
|
|
1492
|
+
* "participant",
|
|
1493
|
+
* "status",
|
|
1494
|
+
* "sla",
|
|
1495
|
+
* "requestType",
|
|
1496
|
+
* "serviceDesk",
|
|
1497
|
+
* "attachment",
|
|
1498
|
+
* "action",
|
|
1499
|
+
* "comment"
|
|
1500
|
+
* ],
|
|
1501
|
+
* "issueId": "109006",
|
|
1502
|
+
* "issueKey": "SIMPLEDESK-6",
|
|
1503
|
+
* "requestTypeId": "33",
|
|
1504
|
+
* "serviceDeskId": "12",
|
|
1505
|
+
* "createdDate": {
|
|
1506
|
+
* "epochMillis": 1444030200000,
|
|
1507
|
+
* "friendly": "Monday 14:30 PM",
|
|
1508
|
+
* "iso8601": "2015-10-05T14:30:00+0700",
|
|
1509
|
+
* "jira": "2015-10-05T14:30:00.000+0700"
|
|
1510
|
+
* },
|
|
1511
|
+
* "reporter": {
|
|
1512
|
+
* "accountId":
|
|
1513
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1514
|
+
* "name":
|
|
1515
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1516
|
+
* "key":
|
|
1517
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1518
|
+
* "emailAddress": "fred@example.com",
|
|
1519
|
+
* "displayName": "Fred F. User",
|
|
1520
|
+
* "active": true,
|
|
1521
|
+
* "timeZone": "Australia/Sydney",
|
|
1522
|
+
* "_links": {
|
|
1523
|
+
* "jiraRest":
|
|
1524
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1525
|
+
* "avatarUrls": {
|
|
1526
|
+
* "16x16":
|
|
1527
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
1528
|
+
* "24x24":
|
|
1529
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
1530
|
+
* "32x32":
|
|
1531
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
1532
|
+
* "48x48":
|
|
1533
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
1534
|
+
* },
|
|
1535
|
+
* "self":
|
|
1536
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
1537
|
+
* }
|
|
1538
|
+
* },
|
|
1539
|
+
* "requestFieldValues": [
|
|
1540
|
+
* {
|
|
1541
|
+
* "fieldId": "summary",
|
|
1542
|
+
* "label": "Summarize the problem",
|
|
1543
|
+
* "value": "Printer on level 3 did not work"
|
|
1544
|
+
* },
|
|
1545
|
+
* {
|
|
1546
|
+
* "fieldId": "description",
|
|
1547
|
+
* "value": "Ink cartridge is empty"
|
|
1548
|
+
* }
|
|
1549
|
+
* ],
|
|
1550
|
+
* "currentStatus": {
|
|
1551
|
+
* "status": "Waiting for Support",
|
|
1552
|
+
* "statusCategory": "NEW",
|
|
1553
|
+
* "statusDate": {
|
|
1554
|
+
* "epochMillis": 1444287600000,
|
|
1555
|
+
* "friendly": "Today 14:00 PM",
|
|
1556
|
+
* "iso8601": "2015-10-08T14:00:00+0700",
|
|
1557
|
+
* "jira": "2015-10-08T14:00:00.000+0700"
|
|
1558
|
+
* }
|
|
1559
|
+
* },
|
|
1560
|
+
* "_links": {
|
|
1561
|
+
* "jiraRest": "https://your-domain.atlassian.net/rest/api/2/issue/109006",
|
|
1562
|
+
* "web":
|
|
1563
|
+
* "https://your-domain.atlassian.net/servicedesk/customer/portal/12/SIMPLEDESK-6",
|
|
1564
|
+
* "self":
|
|
1565
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/109006",
|
|
1566
|
+
* "agent": "https://your-domain.atlassian.net/browse/SIMPLEDESK-6"
|
|
1567
|
+
* }
|
|
1568
|
+
* }
|
|
1569
|
+
* ]
|
|
1570
|
+
* }
|
|
1571
|
+
* @path {GET} /rest/servicedeskapi/request
|
|
1572
|
+
* @scopes-current read:servicedesk-request
|
|
1573
|
+
* @scopes-beta read:request:jira-service-management, read:user:jira
|
|
1574
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-get
|
|
1575
|
+
*/
|
|
1576
|
+
getCustomerRequests: ({ searchTerm, requestOwnership, requestStatus, approvalStatus, organizationId, serviceDeskId, requestTypeId, expand, start, limit, }?: {
|
|
1577
|
+
/**
|
|
1578
|
+
* Filters customer requests where the request summary matches the `searchTerm`.
|
|
1579
|
+
* [Wildcards](https://confluence.atlassian.com/display/JIRACORECLOUD/Search+syntax+for+text+fields)
|
|
1580
|
+
* can be used in the `searchTerm` parameter.
|
|
1581
|
+
*/
|
|
1582
|
+
searchTerm?: string | undefined;
|
|
1583
|
+
/**
|
|
1584
|
+
* Filters customer requests using the following values:
|
|
1585
|
+
*
|
|
1586
|
+
* * `OWNED_REQUESTS` returns customer requests where the user is the creator.
|
|
1587
|
+
* * `PARTICIPATED_REQUESTS` returns customer requests where the user is a
|
|
1588
|
+
* participant.
|
|
1589
|
+
* * `ORGANIZATION` returns customer requests for an organization of which the
|
|
1590
|
+
* user is a member when used in conjunction with `organizationId`.
|
|
1591
|
+
* * `ALL_ORGANIZATIONS` returns customer requests that belong to all
|
|
1592
|
+
* organizations of which the user is a member.
|
|
1593
|
+
* * `APPROVER` returns customer requests where the user is an approver. Can be
|
|
1594
|
+
* used in conjunction with `approvalStatus` to filter pending or complete
|
|
1595
|
+
* approvals.
|
|
1596
|
+
* * `ALL_REQUESTS` returns all customer requests. **Deprecated and will be
|
|
1597
|
+
* removed, as the returned requests may change if more values are added in the
|
|
1598
|
+
* future. Instead, explicitly list the desired filtering strategies.**
|
|
1599
|
+
*
|
|
1600
|
+
* Multiple values of the query parameter are supported. For example,
|
|
1601
|
+
* `requestOwnership=OWNED_REQUESTS&requestOwnership=PARTICIPATED_REQUESTS` will
|
|
1602
|
+
* only return customer requests where the user is the creator or a participant.
|
|
1603
|
+
* If not specified, filtering defaults to `OWNED_REQUESTS`,
|
|
1604
|
+
* `PARTICIPATED_REQUESTS`, and `ALL_ORGANIZATIONS`.
|
|
1605
|
+
*/
|
|
1606
|
+
requestOwnership?: string[] | undefined;
|
|
1607
|
+
/**
|
|
1608
|
+
* Filters customer requests where the request is closed, open, or either of the
|
|
1609
|
+
* two where:
|
|
1610
|
+
*
|
|
1611
|
+
* * `CLOSED_REQUESTS` returns customer requests that are closed.
|
|
1612
|
+
* * `OPEN_REQUESTS` returns customer requests that are open.
|
|
1613
|
+
* * `ALL_REQUESTS` returns all customer requests.
|
|
1614
|
+
*/
|
|
1615
|
+
requestStatus?: string | undefined;
|
|
1616
|
+
/**
|
|
1617
|
+
* Filters results to customer requests based on their approval status:
|
|
1618
|
+
*
|
|
1619
|
+
* * `MY_PENDING_APPROVAL` returns customer requests pending the user's approval.
|
|
1620
|
+
* * `MY_HISTORY_APPROVAL` returns customer requests where the user was an
|
|
1621
|
+
* approver.
|
|
1622
|
+
*
|
|
1623
|
+
* **Note**: Valid only when used with requestOwnership=APPROVER.
|
|
1624
|
+
*/
|
|
1625
|
+
approvalStatus?: string | undefined;
|
|
1626
|
+
/**
|
|
1627
|
+
* Filters customer requests that belong to a specific organization (note that the
|
|
1628
|
+
* user must be a member of that organization). **Note**: Valid only when used
|
|
1629
|
+
* with requestOwnership=ORGANIZATION.
|
|
1630
|
+
*/
|
|
1631
|
+
organizationId?: number | undefined;
|
|
1632
|
+
/** Filters customer requests by service desk. */
|
|
1633
|
+
serviceDeskId?: number | undefined;
|
|
1634
|
+
/**
|
|
1635
|
+
* Filters customer requests by request type. Note that the `serviceDeskId` must
|
|
1636
|
+
* be specified for the service desk in which the request type belongs.
|
|
1637
|
+
*/
|
|
1638
|
+
requestTypeId?: number | undefined;
|
|
1639
|
+
/**
|
|
1640
|
+
* A multi-value parameter indicating which properties of the customer request to
|
|
1641
|
+
* expand, where:
|
|
1642
|
+
*
|
|
1643
|
+
* * `serviceDesk` returns additional details for each service desk.
|
|
1644
|
+
* * `requestType` returns additional details for each request type.
|
|
1645
|
+
* * `participant` returns the participant details, if any, for each customer
|
|
1646
|
+
* request.
|
|
1647
|
+
* * `sla` returns the SLA information on each customer request.
|
|
1648
|
+
* * `status` returns the status transitions, in chronological order, for each
|
|
1649
|
+
* customer request.
|
|
1650
|
+
* * `attachment` returns the attachments for the customer request.
|
|
1651
|
+
* * `action` returns the actions that the user can or cannot perform on this
|
|
1652
|
+
* customer request.
|
|
1653
|
+
* * `comment` returns the comments, if any, for each customer request.
|
|
1654
|
+
* * `comment.attachment` returns the attachment details, if any, for each
|
|
1655
|
+
* comment.
|
|
1656
|
+
* * `comment.renderedBody` (Experimental) returns the rendered body in HTML
|
|
1657
|
+
* format (in addition to the raw body) for each comment.
|
|
1658
|
+
*/
|
|
1659
|
+
expand?: string[] | undefined;
|
|
1660
|
+
/**
|
|
1661
|
+
* The starting index of the returned objects. Base index: 0. See the
|
|
1662
|
+
* [Pagination](#pagination) section for more details.
|
|
1663
|
+
*/
|
|
1664
|
+
start?: number | undefined;
|
|
1665
|
+
/**
|
|
1666
|
+
* The maximum number of items to return per page. Default: 50. See the
|
|
1667
|
+
* [Pagination](#pagination) section for more details.
|
|
1668
|
+
*/
|
|
1669
|
+
limit?: number | undefined;
|
|
1670
|
+
}) => Promise<PagedDtoCustomerRequestDto>;
|
|
1671
|
+
/**
|
|
1672
|
+
* This method returns a list of all the statuses a customer Request has achieved.
|
|
1673
|
+
* A status represents the state of an issue in its workflow. An issue can have
|
|
1674
|
+
* one active status only. The list returns the status history in chronological
|
|
1675
|
+
* order, most recent (current) status first.
|
|
1676
|
+
*
|
|
1677
|
+
* **[Permissions](#permissions) required**: Permission to view the customer
|
|
1678
|
+
* request.
|
|
1679
|
+
*
|
|
1680
|
+
* @returns Returns the customer request's status history, on the specified page of the
|
|
1681
|
+
* results.
|
|
1682
|
+
*
|
|
1683
|
+
* example: {
|
|
1684
|
+
* "_expands": [],
|
|
1685
|
+
* "size": 3,
|
|
1686
|
+
* "start": 3,
|
|
1687
|
+
* "limit": 3,
|
|
1688
|
+
* "isLastPage": false,
|
|
1689
|
+
* "_links": {
|
|
1690
|
+
* "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
|
|
1691
|
+
* "context": "context",
|
|
1692
|
+
* "next":
|
|
1693
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/status?start=6&limit=3",
|
|
1694
|
+
* "prev":
|
|
1695
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/status?start=0&limit=3"
|
|
1696
|
+
* },
|
|
1697
|
+
* "values": [
|
|
1698
|
+
* {
|
|
1699
|
+
* "status": "Waiting for Customer",
|
|
1700
|
+
* "statusDate": {
|
|
1701
|
+
* "epochMillis": 1444287900000,
|
|
1702
|
+
* "friendly": "Today 14:05 PM",
|
|
1703
|
+
* "iso8601": "2015-10-08T14:05:00+0700",
|
|
1704
|
+
* "jira": "2015-10-08T14:05:00.000+0700"
|
|
1705
|
+
* }
|
|
1706
|
+
* },
|
|
1707
|
+
* {
|
|
1708
|
+
* "status": "Waiting for Support",
|
|
1709
|
+
* "statusDate": {
|
|
1710
|
+
* "epochMillis": 1444287660000,
|
|
1711
|
+
* "friendly": "Today 14:01 PM",
|
|
1712
|
+
* "iso8601": "2015-10-08T14:01:00+0700",
|
|
1713
|
+
* "jira": "2015-10-08T14:01:00.000+0700"
|
|
1714
|
+
* }
|
|
1715
|
+
* },
|
|
1716
|
+
* {
|
|
1717
|
+
* "status": "Waiting for Customer",
|
|
1718
|
+
* "statusDate": {
|
|
1719
|
+
* "epochMillis": 1444287600000,
|
|
1720
|
+
* "friendly": "Today 14:00 PM",
|
|
1721
|
+
* "iso8601": "2015-10-08T14:00:00+0700",
|
|
1722
|
+
* "jira": "2015-10-08T14:00:00.000+0700"
|
|
1723
|
+
* }
|
|
1724
|
+
* }
|
|
1725
|
+
* ]
|
|
1726
|
+
* }
|
|
1727
|
+
* @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/status
|
|
1728
|
+
* @scopes-current read:servicedesk-request
|
|
1729
|
+
* @scopes-beta read:request.status:jira-service-management, read:user:jira
|
|
1730
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-status-get
|
|
1731
|
+
*/
|
|
1732
|
+
getCustomerRequestStatus: ({ issueIdOrKey, start, limit, }: {
|
|
1733
|
+
/** The ID or key of the customer request to be retrieved. */
|
|
1734
|
+
issueIdOrKey: string;
|
|
1735
|
+
/**
|
|
1736
|
+
* The starting index of the returned objects. Base index: 0. See the
|
|
1737
|
+
* [Pagination](#pagination) section for more details.
|
|
1738
|
+
*/
|
|
1739
|
+
start?: number | undefined;
|
|
1740
|
+
/**
|
|
1741
|
+
* The maximum number of items to return per page. Default: 50. See the
|
|
1742
|
+
* [Pagination](#pagination) section for more details.
|
|
1743
|
+
*/
|
|
1744
|
+
limit?: number | undefined;
|
|
1745
|
+
}) => Promise<PagedDtoCustomerRequestStatusDto>;
|
|
1746
|
+
/**
|
|
1747
|
+
* This method returns a list of transitions, the workflow processes that moves a
|
|
1748
|
+
* customer request from one status to another, that the user can perform on a
|
|
1749
|
+
* request. Use this method to provide a user with a list if the actions they can
|
|
1750
|
+
* take on a customer request.
|
|
1751
|
+
*
|
|
1752
|
+
* **[Permissions](#permissions) required**: Permission to view the customer
|
|
1753
|
+
* request.
|
|
1754
|
+
*
|
|
1755
|
+
* @returns Returns the transitions available to the user on the customer request.
|
|
1756
|
+
*
|
|
1757
|
+
* example: {
|
|
1758
|
+
* "_expands": [],
|
|
1759
|
+
* "size": 2,
|
|
1760
|
+
* "start": 2,
|
|
1761
|
+
* "limit": 2,
|
|
1762
|
+
* "isLastPage": false,
|
|
1763
|
+
* "_links": {
|
|
1764
|
+
* "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
|
|
1765
|
+
* "context": "context",
|
|
1766
|
+
* "next":
|
|
1767
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/transition?start=4&limit=2",
|
|
1768
|
+
* "prev":
|
|
1769
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/1/transition?start=0&limit=2"
|
|
1770
|
+
* },
|
|
1771
|
+
* "values": [
|
|
1772
|
+
* {
|
|
1773
|
+
* "id": "1",
|
|
1774
|
+
* "name": "Close Request"
|
|
1775
|
+
* },
|
|
1776
|
+
* {
|
|
1777
|
+
* "id": "2",
|
|
1778
|
+
* "name": "Escalate Request"
|
|
1779
|
+
* }
|
|
1780
|
+
* ]
|
|
1781
|
+
* }
|
|
1782
|
+
* @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/transition
|
|
1783
|
+
* @scopes-current read:servicedesk-request
|
|
1784
|
+
* @scopes-beta read:request.status:jira-service-management, read:user:jira
|
|
1785
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-transition-get
|
|
1786
|
+
*/
|
|
1787
|
+
getCustomerTransitions: ({ issueIdOrKey, start, limit, }: {
|
|
1788
|
+
/** The ID or key of the customer request whose transitions will be retrieved. */
|
|
1789
|
+
issueIdOrKey: string;
|
|
1790
|
+
/**
|
|
1791
|
+
* The starting index of the returned objects. Base index: 0. See the
|
|
1792
|
+
* [Pagination](#pagination) section for more details.
|
|
1793
|
+
*/
|
|
1794
|
+
start?: number | undefined;
|
|
1795
|
+
/**
|
|
1796
|
+
* The maximum number of items to return per page. Default: 50. See the
|
|
1797
|
+
* [Pagination](#pagination) section for more details.
|
|
1798
|
+
*/
|
|
1799
|
+
limit?: number | undefined;
|
|
1800
|
+
}) => Promise<PagedDtoCustomerTransitionDto>;
|
|
1801
|
+
/**
|
|
1802
|
+
* This method retrieves a feedback of a request using it's `requestKey` or
|
|
1803
|
+
* `requestId`
|
|
1804
|
+
*
|
|
1805
|
+
* **[Permissions](#permissions) required**: User has view request permissions.
|
|
1806
|
+
*
|
|
1807
|
+
* @returns Returns the comment.
|
|
1808
|
+
*
|
|
1809
|
+
* example: {
|
|
1810
|
+
* "type": "csat",
|
|
1811
|
+
* "rating": 4,
|
|
1812
|
+
* "comment": {
|
|
1813
|
+
* "body": "Great work!"
|
|
1814
|
+
* }
|
|
1815
|
+
* }
|
|
1816
|
+
* @path {GET} /rest/servicedeskapi/request/{requestIdOrKey}/feedback
|
|
1817
|
+
* @scopes-current read:servicedesk-request
|
|
1818
|
+
* @scopes-beta read:request.feedback:jira-service-management, read:user:jira
|
|
1819
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-requestidorkey-feedback-get
|
|
1820
|
+
*/
|
|
1821
|
+
getFeedback: ({ requestIdOrKey, }: {
|
|
1822
|
+
/** The id or the key of the request to post the feedback on */
|
|
1823
|
+
requestIdOrKey: string;
|
|
1824
|
+
}) => Promise<CsatFeedbackFullDto>;
|
|
1825
|
+
/**
|
|
1826
|
+
* This method returns details of a customer request's comment.
|
|
1827
|
+
*
|
|
1828
|
+
* **[Permissions](#permissions) required**: Permission to view the customer
|
|
1829
|
+
* request.
|
|
1830
|
+
*
|
|
1831
|
+
* **Response limitations**: Customers can only view public comments on requests
|
|
1832
|
+
* where they are the reporter or a participant whereas agents can see both
|
|
1833
|
+
* internal and public comments.
|
|
1834
|
+
*
|
|
1835
|
+
* @returns Returns the comment.
|
|
1836
|
+
*
|
|
1837
|
+
* example: {
|
|
1838
|
+
* "_expands": [
|
|
1839
|
+
* "attachment",
|
|
1840
|
+
* "renderedBody"
|
|
1841
|
+
* ],
|
|
1842
|
+
* "id": "1000",
|
|
1843
|
+
* "body": "Hello there",
|
|
1844
|
+
* "public": true,
|
|
1845
|
+
* "author": {
|
|
1846
|
+
* "accountId":
|
|
1847
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1848
|
+
* "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1849
|
+
* "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1850
|
+
* "emailAddress": "fred@example.com",
|
|
1851
|
+
* "displayName": "Fred F. User",
|
|
1852
|
+
* "active": true,
|
|
1853
|
+
* "timeZone": "Australia/Sydney",
|
|
1854
|
+
* "_links": {
|
|
1855
|
+
* "jiraRest":
|
|
1856
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1857
|
+
* "avatarUrls": {
|
|
1858
|
+
* "16x16":
|
|
1859
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
1860
|
+
* "24x24":
|
|
1861
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
1862
|
+
* "32x32":
|
|
1863
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
1864
|
+
* "48x48":
|
|
1865
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
1866
|
+
* },
|
|
1867
|
+
* "self":
|
|
1868
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
1869
|
+
* }
|
|
1870
|
+
* },
|
|
1871
|
+
* "created": {
|
|
1872
|
+
* "epochMillis": 1444360920000,
|
|
1873
|
+
* "friendly": "Today 10:22 AM",
|
|
1874
|
+
* "iso8601": "2015-10-09T10:22:00+0700",
|
|
1875
|
+
* "jira": "2015-10-09T10:22:00.000+0700"
|
|
1876
|
+
* },
|
|
1877
|
+
* "_links": {
|
|
1878
|
+
* "self":
|
|
1879
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
|
|
1880
|
+
* }
|
|
1881
|
+
* }
|
|
1882
|
+
* @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}
|
|
1883
|
+
* @scopes-current read:servicedesk-request
|
|
1884
|
+
* @scopes-beta read:request.comment:jira-service-management, read:user:jira
|
|
1885
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-commentid-get
|
|
1886
|
+
*/
|
|
1887
|
+
getRequestCommentById: ({ issueIdOrKey, commentId, expand, }: {
|
|
1888
|
+
/** The ID or key of the customer request that contains the comment. */
|
|
1889
|
+
issueIdOrKey: string;
|
|
1890
|
+
/** The ID of the comment to retrieve. */
|
|
1891
|
+
commentId: number;
|
|
1892
|
+
/**
|
|
1893
|
+
* A multi-value parameter indicating which properties of the comment to expand:
|
|
1894
|
+
*
|
|
1895
|
+
* * `attachment` returns the attachment details, if any, for the comment. (If
|
|
1896
|
+
* you want to get all attachments for a request, use
|
|
1897
|
+
* [servicedeskapi/request/\{issueIdOrKey\}/attachment](#api-request-issueIdOrKey-attachment-get).)
|
|
1898
|
+
* * `renderedBody` (Experimental) returns the rendered body in HTML format (in
|
|
1899
|
+
* addition to the raw body) of the comment.
|
|
1900
|
+
*/
|
|
1901
|
+
expand?: string[] | undefined;
|
|
1902
|
+
}) => Promise<CommentDto>;
|
|
1903
|
+
/**
|
|
1904
|
+
* This method returns all comments on a customer request. No permissions error is
|
|
1905
|
+
* provided if, for example, the user doesn't have access to the service desk or
|
|
1906
|
+
* request, the method simply returns an empty response.
|
|
1907
|
+
*
|
|
1908
|
+
* **[Permissions](#permissions) required**: Permission to view the customer
|
|
1909
|
+
* request.
|
|
1910
|
+
*
|
|
1911
|
+
* **Response limitations**: Customers are returned public comments only.
|
|
1912
|
+
*
|
|
1913
|
+
* @returns Returns the comments, on the specified page of the results.
|
|
1914
|
+
*
|
|
1915
|
+
* example: {
|
|
1916
|
+
* "_expands": [],
|
|
1917
|
+
* "size": 1,
|
|
1918
|
+
* "start": 1,
|
|
1919
|
+
* "limit": 1,
|
|
1920
|
+
* "isLastPage": false,
|
|
1921
|
+
* "_links": {
|
|
1922
|
+
* "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
|
|
1923
|
+
* "context": "context",
|
|
1924
|
+
* "next":
|
|
1925
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment?start=2&limit=1",
|
|
1926
|
+
* "prev":
|
|
1927
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment?start=0&limit=1"
|
|
1928
|
+
* },
|
|
1929
|
+
* "values": [
|
|
1930
|
+
* {
|
|
1931
|
+
* "_expands": [
|
|
1932
|
+
* "attachment",
|
|
1933
|
+
* "renderedBody"
|
|
1934
|
+
* ],
|
|
1935
|
+
* "id": "1000",
|
|
1936
|
+
* "body": "Hello there",
|
|
1937
|
+
* "public": true,
|
|
1938
|
+
* "author": {
|
|
1939
|
+
* "accountId":
|
|
1940
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1941
|
+
* "name":
|
|
1942
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1943
|
+
* "key":
|
|
1944
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1945
|
+
* "emailAddress": "fred@example.com",
|
|
1946
|
+
* "displayName": "Fred F. User",
|
|
1947
|
+
* "active": true,
|
|
1948
|
+
* "timeZone": "Australia/Sydney",
|
|
1949
|
+
* "_links": {
|
|
1950
|
+
* "jiraRest":
|
|
1951
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
1952
|
+
* "avatarUrls": {
|
|
1953
|
+
* "16x16":
|
|
1954
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
1955
|
+
* "24x24":
|
|
1956
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
1957
|
+
* "32x32":
|
|
1958
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
1959
|
+
* "48x48":
|
|
1960
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
1961
|
+
* },
|
|
1962
|
+
* "self":
|
|
1963
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
1964
|
+
* }
|
|
1965
|
+
* },
|
|
1966
|
+
* "created": {
|
|
1967
|
+
* "epochMillis": 1444360920000,
|
|
1968
|
+
* "friendly": "Today 10:22 AM",
|
|
1969
|
+
* "iso8601": "2015-10-09T10:22:00+0700",
|
|
1970
|
+
* "jira": "2015-10-09T10:22:00.000+0700"
|
|
1971
|
+
* },
|
|
1972
|
+
* "_links": {
|
|
1973
|
+
* "self":
|
|
1974
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/2000/comment/1000"
|
|
1975
|
+
* }
|
|
1976
|
+
* }
|
|
1977
|
+
* ]
|
|
1978
|
+
* }
|
|
1979
|
+
* @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/comment
|
|
1980
|
+
* @scopes-current read:servicedesk-request
|
|
1981
|
+
* @scopes-beta read:request.comment:jira-service-management, read:user:jira
|
|
1982
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-comment-get
|
|
1983
|
+
*/
|
|
1984
|
+
getRequestComments: ({ issueIdOrKey, public: publicQuery, internal, expand, start, limit, }: {
|
|
1985
|
+
/** The ID or key of the customer request whose comments will be retrieved. */
|
|
1986
|
+
issueIdOrKey: string;
|
|
1987
|
+
/** Specifies whether to return public comments or not. Default: true. */
|
|
1988
|
+
public?: boolean | undefined;
|
|
1989
|
+
/** Specifies whether to return internal comments or not. Default: true. */
|
|
1990
|
+
internal?: boolean | undefined;
|
|
1991
|
+
/**
|
|
1992
|
+
* A multi-value parameter indicating which properties of the comment to expand:
|
|
1993
|
+
*
|
|
1994
|
+
* * `attachment` returns the attachment details, if any, for each comment. (If
|
|
1995
|
+
* you want to get all attachments for a request, use
|
|
1996
|
+
* [servicedeskapi/request/\{issueIdOrKey\}/attachment](#api-request-issueIdOrKey-attachment-get).)
|
|
1997
|
+
* * `renderedBody` (Experimental) returns the rendered body in HTML format (in
|
|
1998
|
+
* addition to the raw body) for each comment.
|
|
1999
|
+
*/
|
|
2000
|
+
expand?: string[] | undefined;
|
|
2001
|
+
/**
|
|
2002
|
+
* The starting index of the returned comments. Base index: 0. See the
|
|
2003
|
+
* [Pagination](#pagination) section for more details.
|
|
2004
|
+
*/
|
|
2005
|
+
start?: number | undefined;
|
|
2006
|
+
/**
|
|
2007
|
+
* The maximum number of comments to return per page. Default: 50. See the
|
|
2008
|
+
* [Pagination](#pagination) section for more details.
|
|
2009
|
+
*/
|
|
2010
|
+
limit?: number | undefined;
|
|
2011
|
+
}) => Promise<PagedDtoCommentDto>;
|
|
2012
|
+
/**
|
|
2013
|
+
* This method returns a list of all the participants on a customer request.
|
|
2014
|
+
*
|
|
2015
|
+
* **[Permissions](#permissions) required**: Permission to view the customer
|
|
2016
|
+
* request.
|
|
2017
|
+
*
|
|
2018
|
+
* @returns Returns the customer request's participants, on the specified page of the
|
|
2019
|
+
* results.
|
|
2020
|
+
*
|
|
2021
|
+
* example: {
|
|
2022
|
+
* "_expands": [],
|
|
2023
|
+
* "size": 1,
|
|
2024
|
+
* "start": 1,
|
|
2025
|
+
* "limit": 1,
|
|
2026
|
+
* "isLastPage": false,
|
|
2027
|
+
* "_links": {
|
|
2028
|
+
* "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
|
|
2029
|
+
* "context": "context",
|
|
2030
|
+
* "next":
|
|
2031
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
|
|
2032
|
+
* "prev":
|
|
2033
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
|
|
2034
|
+
* },
|
|
2035
|
+
* "values": [
|
|
2036
|
+
* {
|
|
2037
|
+
* "accountId":
|
|
2038
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
2039
|
+
* "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
2040
|
+
* "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
2041
|
+
* "emailAddress": "fred@example.com",
|
|
2042
|
+
* "displayName": "Fred F. User",
|
|
2043
|
+
* "active": true,
|
|
2044
|
+
* "timeZone": "Australia/Sydney",
|
|
2045
|
+
* "_links": {
|
|
2046
|
+
* "jiraRest":
|
|
2047
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
2048
|
+
* "avatarUrls": {
|
|
2049
|
+
* "16x16":
|
|
2050
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
2051
|
+
* "24x24":
|
|
2052
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
2053
|
+
* "32x32":
|
|
2054
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
2055
|
+
* "48x48":
|
|
2056
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
2057
|
+
* },
|
|
2058
|
+
* "self":
|
|
2059
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
2060
|
+
* }
|
|
2061
|
+
* }
|
|
2062
|
+
* ]
|
|
2063
|
+
* }
|
|
2064
|
+
* @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/participant
|
|
2065
|
+
* @scopes-current read:servicedesk-request
|
|
2066
|
+
* @scopes-beta read:request.participant:jira-service-management, read:user:jira
|
|
2067
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-participant-get
|
|
2068
|
+
*/
|
|
2069
|
+
getRequestParticipants: ({ issueIdOrKey, start, limit, }: {
|
|
2070
|
+
/** The ID or key of the customer request to be queried for its participants. */
|
|
2071
|
+
issueIdOrKey: string;
|
|
2072
|
+
/**
|
|
2073
|
+
* The starting index of the returned objects. Base index: 0. See the
|
|
2074
|
+
* [Pagination](#pagination) section for more details.
|
|
2075
|
+
*/
|
|
2076
|
+
start?: number | undefined;
|
|
2077
|
+
/**
|
|
2078
|
+
* The maximum number of request types to return per page. Default: 50. See the
|
|
2079
|
+
* [Pagination](#pagination) section for more details.
|
|
2080
|
+
*/
|
|
2081
|
+
limit?: number | undefined;
|
|
2082
|
+
}) => Promise<PagedDtoUserDto>;
|
|
2083
|
+
/**
|
|
2084
|
+
* This method returns all the SLA records on a customer request. A customer
|
|
2085
|
+
* request can have zero or more SLAs. Each SLA can have recordings for zero or
|
|
2086
|
+
* more "completed cycles" and zero or 1 "ongoing cycle". Each cycle includes
|
|
2087
|
+
* information on when it started and stopped, and whether it breached the SLA
|
|
2088
|
+
* goal.
|
|
2089
|
+
*
|
|
2090
|
+
* **[Permissions](#permissions) required**: Agent for the Service Desk containing
|
|
2091
|
+
* the queried customer request.
|
|
2092
|
+
*
|
|
2093
|
+
* @returns Returns the SLA records on the customer request, on the specified page of the
|
|
2094
|
+
* results.
|
|
2095
|
+
*
|
|
2096
|
+
* example: {
|
|
2097
|
+
* "_expands": [],
|
|
2098
|
+
* "size": 3,
|
|
2099
|
+
* "start": 3,
|
|
2100
|
+
* "limit": 3,
|
|
2101
|
+
* "isLastPage": false,
|
|
2102
|
+
* "_links": {
|
|
2103
|
+
* "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
|
|
2104
|
+
* "context": "context",
|
|
2105
|
+
* "next":
|
|
2106
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla?start=6&limit=3",
|
|
2107
|
+
* "prev":
|
|
2108
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla?start=0&limit=3"
|
|
2109
|
+
* },
|
|
2110
|
+
* "values": [
|
|
2111
|
+
* {
|
|
2112
|
+
* "name": "Time To First Response",
|
|
2113
|
+
* "_links": {
|
|
2114
|
+
* "self":
|
|
2115
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10030"
|
|
2116
|
+
* },
|
|
2117
|
+
* "completedCycles": [
|
|
2118
|
+
* {
|
|
2119
|
+
* "startTime": {
|
|
2120
|
+
* "epochMillis": 1444362323000,
|
|
2121
|
+
* "friendly": "Yesterday 10:45 AM",
|
|
2122
|
+
* "iso8601": "2015-10-09T10:45:23+0700",
|
|
2123
|
+
* "jira": "2015-10-09T10:45:23.000+0700"
|
|
2124
|
+
* },
|
|
2125
|
+
* "stopTime": {
|
|
2126
|
+
* "epochMillis": 1444362743000,
|
|
2127
|
+
* "friendly": "Yesterday 10:52 AM",
|
|
2128
|
+
* "iso8601": "2015-10-09T10:52:23+0700",
|
|
2129
|
+
* "jira": "2015-10-09T10:52:23.000+0700"
|
|
2130
|
+
* },
|
|
2131
|
+
* "breachTime": {
|
|
2132
|
+
* "epochMillis": 1444362623000,
|
|
2133
|
+
* "friendly": "Yesterday 10:50 AM",
|
|
2134
|
+
* "iso8601": "2015-10-09T10:50:23+0700",
|
|
2135
|
+
* "jira": "2015-10-09T10:50:23.000+0700"
|
|
2136
|
+
* },
|
|
2137
|
+
* "breached": false,
|
|
2138
|
+
* "goalDuration": {
|
|
2139
|
+
* "millis": 14400000,
|
|
2140
|
+
* "friendly": "4h 240m"
|
|
2141
|
+
* },
|
|
2142
|
+
* "elapsedTime": {
|
|
2143
|
+
* "millis": 420000,
|
|
2144
|
+
* "friendly": "0h 7m"
|
|
2145
|
+
* },
|
|
2146
|
+
* "remainingTime": {
|
|
2147
|
+
* "millis": 13980000,
|
|
2148
|
+
* "friendly": "3h 233m"
|
|
2149
|
+
* }
|
|
2150
|
+
* },
|
|
2151
|
+
* {
|
|
2152
|
+
* "startTime": {
|
|
2153
|
+
* "epochMillis": 1444449143000,
|
|
2154
|
+
* "friendly": "Today 10:52 AM",
|
|
2155
|
+
* "iso8601": "2015-10-10T10:52:23+0700",
|
|
2156
|
+
* "jira": "2015-10-10T10:52:23.000+0700"
|
|
2157
|
+
* },
|
|
2158
|
+
* "stopTime": {
|
|
2159
|
+
* "epochMillis": 1444468523000,
|
|
2160
|
+
* "friendly": "Today 16:15 PM",
|
|
2161
|
+
* "iso8601": "2015-10-10T16:15:23+0700",
|
|
2162
|
+
* "jira": "2015-10-10T16:15:23.000+0700"
|
|
2163
|
+
* },
|
|
2164
|
+
* "breachTime": {
|
|
2165
|
+
* "epochMillis": 1444464743000,
|
|
2166
|
+
* "friendly": "Today 15:12 PM",
|
|
2167
|
+
* "iso8601": "2015-10-10T15:12:23+0700",
|
|
2168
|
+
* "jira": "2015-10-10T15:12:23.000+0700"
|
|
2169
|
+
* },
|
|
2170
|
+
* "breached": true,
|
|
2171
|
+
* "goalDuration": {
|
|
2172
|
+
* "millis": 14400000,
|
|
2173
|
+
* "friendly": "4h 240m"
|
|
2174
|
+
* },
|
|
2175
|
+
* "elapsedTime": {
|
|
2176
|
+
* "millis": 19380000,
|
|
2177
|
+
* "friendly": "5h 323m"
|
|
2178
|
+
* },
|
|
2179
|
+
* "remainingTime": {
|
|
2180
|
+
* "millis": -4980000,
|
|
2181
|
+
* "friendly": "-1h -83m"
|
|
2182
|
+
* }
|
|
2183
|
+
* }
|
|
2184
|
+
* ],
|
|
2185
|
+
* "ongoingCycle": {
|
|
2186
|
+
* "startTime": {
|
|
2187
|
+
* "epochMillis": 1444479323000,
|
|
2188
|
+
* "friendly": "Today 19:15 PM",
|
|
2189
|
+
* "iso8601": "2015-10-10T19:15:23+0700",
|
|
2190
|
+
* "jira": "2015-10-10T19:15:23.000+0700"
|
|
2191
|
+
* },
|
|
2192
|
+
* "breached": false,
|
|
2193
|
+
* "paused": false,
|
|
2194
|
+
* "withinCalendarHours": false,
|
|
2195
|
+
* "goalDuration": {
|
|
2196
|
+
* "millis": 14400000,
|
|
2197
|
+
* "friendly": "4h 240m"
|
|
2198
|
+
* },
|
|
2199
|
+
* "elapsedTime": {
|
|
2200
|
+
* "millis": 5640000,
|
|
2201
|
+
* "friendly": "1h 94m"
|
|
2202
|
+
* },
|
|
2203
|
+
* "remainingTime": {
|
|
2204
|
+
* "millis": 8760000,
|
|
2205
|
+
* "friendly": "2h 146m"
|
|
2206
|
+
* }
|
|
2207
|
+
* }
|
|
2208
|
+
* },
|
|
2209
|
+
* {
|
|
2210
|
+
* "name": "Time To Resolution",
|
|
2211
|
+
* "_links": {
|
|
2212
|
+
* "self":
|
|
2213
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10040"
|
|
2214
|
+
* },
|
|
2215
|
+
* "completedCycles": [
|
|
2216
|
+
* {
|
|
2217
|
+
* "startTime": {
|
|
2218
|
+
* "epochMillis": 1444362323000,
|
|
2219
|
+
* "friendly": "Yesterday 10:45 AM",
|
|
2220
|
+
* "iso8601": "2015-10-09T10:45:23+0700",
|
|
2221
|
+
* "jira": "2015-10-09T10:45:23.000+0700"
|
|
2222
|
+
* },
|
|
2223
|
+
* "stopTime": {
|
|
2224
|
+
* "epochMillis": 1444398743000,
|
|
2225
|
+
* "friendly": "Yesterday 20:52 PM",
|
|
2226
|
+
* "iso8601": "2015-10-09T20:52:23+0700",
|
|
2227
|
+
* "jira": "2015-10-09T20:52:23.000+0700"
|
|
2228
|
+
* },
|
|
2229
|
+
* "breachTime": {
|
|
2230
|
+
* "epochMillis": 1444398623000,
|
|
2231
|
+
* "friendly": "Yesterday 20:50 PM",
|
|
2232
|
+
* "iso8601": "2015-10-09T20:50:23+0700",
|
|
2233
|
+
* "jira": "2015-10-09T20:50:23.000+0700"
|
|
2234
|
+
* },
|
|
2235
|
+
* "breached": false,
|
|
2236
|
+
* "goalDuration": {
|
|
2237
|
+
* "millis": 72000000,
|
|
2238
|
+
* "friendly": "20h 1200m"
|
|
2239
|
+
* },
|
|
2240
|
+
* "elapsedTime": {
|
|
2241
|
+
* "millis": 36420000,
|
|
2242
|
+
* "friendly": "10h 607m"
|
|
2243
|
+
* },
|
|
2244
|
+
* "remainingTime": {
|
|
2245
|
+
* "millis": 35580000,
|
|
2246
|
+
* "friendly": "9h 593m"
|
|
2247
|
+
* }
|
|
2248
|
+
* },
|
|
2249
|
+
* {
|
|
2250
|
+
* "startTime": {
|
|
2251
|
+
* "epochMillis": 1444485143000,
|
|
2252
|
+
* "friendly": "Today 20:52 PM",
|
|
2253
|
+
* "iso8601": "2015-10-10T20:52:23+0700",
|
|
2254
|
+
* "jira": "2015-10-10T20:52:23.000+0700"
|
|
2255
|
+
* },
|
|
2256
|
+
* "stopTime": {
|
|
2257
|
+
* "epochMillis": 1444504523000,
|
|
2258
|
+
* "friendly": "Today 02:15 AM",
|
|
2259
|
+
* "iso8601": "2015-10-11T02:15:23+0700",
|
|
2260
|
+
* "jira": "2015-10-11T02:15:23.000+0700"
|
|
2261
|
+
* },
|
|
2262
|
+
* "breachTime": {
|
|
2263
|
+
* "epochMillis": 1444500743000,
|
|
2264
|
+
* "friendly": "Today 01:12 AM",
|
|
2265
|
+
* "iso8601": "2015-10-11T01:12:23+0700",
|
|
2266
|
+
* "jira": "2015-10-11T01:12:23.000+0700"
|
|
2267
|
+
* },
|
|
2268
|
+
* "breached": true,
|
|
2269
|
+
* "goalDuration": {
|
|
2270
|
+
* "millis": 72000000,
|
|
2271
|
+
* "friendly": "20h 1200m"
|
|
2272
|
+
* },
|
|
2273
|
+
* "elapsedTime": {
|
|
2274
|
+
* "millis": 19380000,
|
|
2275
|
+
* "friendly": "5h 323m"
|
|
2276
|
+
* },
|
|
2277
|
+
* "remainingTime": {
|
|
2278
|
+
* "millis": 52620000,
|
|
2279
|
+
* "friendly": "14h 877m"
|
|
2280
|
+
* }
|
|
2281
|
+
* }
|
|
2282
|
+
* ],
|
|
2283
|
+
* "ongoingCycle": {
|
|
2284
|
+
* "startTime": {
|
|
2285
|
+
* "epochMillis": 1444515323000,
|
|
2286
|
+
* "friendly": "Today 05:15 AM",
|
|
2287
|
+
* "iso8601": "2015-10-11T05:15:23+0700",
|
|
2288
|
+
* "jira": "2015-10-11T05:15:23.000+0700"
|
|
2289
|
+
* },
|
|
2290
|
+
* "breached": false,
|
|
2291
|
+
* "paused": false,
|
|
2292
|
+
* "withinCalendarHours": false,
|
|
2293
|
+
* "goalDuration": {
|
|
2294
|
+
* "millis": 72000000,
|
|
2295
|
+
* "friendly": "20h 1200m"
|
|
2296
|
+
* },
|
|
2297
|
+
* "elapsedTime": {
|
|
2298
|
+
* "millis": 5640000,
|
|
2299
|
+
* "friendly": "1h 94m"
|
|
2300
|
+
* },
|
|
2301
|
+
* "remainingTime": {
|
|
2302
|
+
* "millis": 66360000,
|
|
2303
|
+
* "friendly": "18h 1106m"
|
|
2304
|
+
* }
|
|
2305
|
+
* }
|
|
2306
|
+
* },
|
|
2307
|
+
* {
|
|
2308
|
+
* "name": "Time To Retrospective",
|
|
2309
|
+
* "_links": {
|
|
2310
|
+
* "self":
|
|
2311
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10050"
|
|
2312
|
+
* },
|
|
2313
|
+
* "completedCycles": [
|
|
2314
|
+
* {
|
|
2315
|
+
* "startTime": {
|
|
2316
|
+
* "epochMillis": 1444362323000,
|
|
2317
|
+
* "friendly": "Yesterday 10:45 AM",
|
|
2318
|
+
* "iso8601": "2015-10-09T10:45:23+0700",
|
|
2319
|
+
* "jira": "2015-10-09T10:45:23.000+0700"
|
|
2320
|
+
* },
|
|
2321
|
+
* "stopTime": {
|
|
2322
|
+
* "epochMillis": 1444449143000,
|
|
2323
|
+
* "friendly": "Yesterday 10:52 AM",
|
|
2324
|
+
* "iso8601": "2015-10-10T10:52:23+0700",
|
|
2325
|
+
* "jira": "2015-10-10T10:52:23.000+0700"
|
|
2326
|
+
* },
|
|
2327
|
+
* "breachTime": {
|
|
2328
|
+
* "epochMillis": 1444449023000,
|
|
2329
|
+
* "friendly": "Yesterday 10:50 AM",
|
|
2330
|
+
* "iso8601": "2015-10-10T10:50:23+0700",
|
|
2331
|
+
* "jira": "2015-10-10T10:50:23.000+0700"
|
|
2332
|
+
* },
|
|
2333
|
+
* "breached": false,
|
|
2334
|
+
* "goalDuration": {
|
|
2335
|
+
* "millis": 144000000,
|
|
2336
|
+
* "friendly": "40h 2400m"
|
|
2337
|
+
* },
|
|
2338
|
+
* "elapsedTime": {
|
|
2339
|
+
* "millis": 86820000,
|
|
2340
|
+
* "friendly": "24h 1447m"
|
|
2341
|
+
* },
|
|
2342
|
+
* "remainingTime": {
|
|
2343
|
+
* "millis": 57180000,
|
|
2344
|
+
* "friendly": "15h 953m"
|
|
2345
|
+
* }
|
|
2346
|
+
* },
|
|
2347
|
+
* {
|
|
2348
|
+
* "startTime": {
|
|
2349
|
+
* "epochMillis": 1444535543000,
|
|
2350
|
+
* "friendly": "Today 10:52 AM",
|
|
2351
|
+
* "iso8601": "2015-10-11T10:52:23+0700",
|
|
2352
|
+
* "jira": "2015-10-11T10:52:23.000+0700"
|
|
2353
|
+
* },
|
|
2354
|
+
* "stopTime": {
|
|
2355
|
+
* "epochMillis": 1444554923000,
|
|
2356
|
+
* "friendly": "Today 16:15 PM",
|
|
2357
|
+
* "iso8601": "2015-10-11T16:15:23+0700",
|
|
2358
|
+
* "jira": "2015-10-11T16:15:23.000+0700"
|
|
2359
|
+
* },
|
|
2360
|
+
* "breachTime": {
|
|
2361
|
+
* "epochMillis": 1444551143000,
|
|
2362
|
+
* "friendly": "Today 15:12 PM",
|
|
2363
|
+
* "iso8601": "2015-10-11T15:12:23+0700",
|
|
2364
|
+
* "jira": "2015-10-11T15:12:23.000+0700"
|
|
2365
|
+
* },
|
|
2366
|
+
* "breached": true,
|
|
2367
|
+
* "goalDuration": {
|
|
2368
|
+
* "millis": 144000000,
|
|
2369
|
+
* "friendly": "40h 2400m"
|
|
2370
|
+
* },
|
|
2371
|
+
* "elapsedTime": {
|
|
2372
|
+
* "millis": 19380000,
|
|
2373
|
+
* "friendly": "5h 323m"
|
|
2374
|
+
* },
|
|
2375
|
+
* "remainingTime": {
|
|
2376
|
+
* "millis": 124620000,
|
|
2377
|
+
* "friendly": "34h 2077m"
|
|
2378
|
+
* }
|
|
2379
|
+
* }
|
|
2380
|
+
* ],
|
|
2381
|
+
* "ongoingCycle": {
|
|
2382
|
+
* "startTime": {
|
|
2383
|
+
* "epochMillis": 1444565723000,
|
|
2384
|
+
* "friendly": "Today 19:15 PM",
|
|
2385
|
+
* "iso8601": "2015-10-11T19:15:23+0700",
|
|
2386
|
+
* "jira": "2015-10-11T19:15:23.000+0700"
|
|
2387
|
+
* },
|
|
2388
|
+
* "breached": false,
|
|
2389
|
+
* "paused": false,
|
|
2390
|
+
* "withinCalendarHours": false,
|
|
2391
|
+
* "goalDuration": {
|
|
2392
|
+
* "millis": 144000000,
|
|
2393
|
+
* "friendly": "40h 2400m"
|
|
2394
|
+
* },
|
|
2395
|
+
* "elapsedTime": {
|
|
2396
|
+
* "millis": 5640000,
|
|
2397
|
+
* "friendly": "1h 94m"
|
|
2398
|
+
* },
|
|
2399
|
+
* "remainingTime": {
|
|
2400
|
+
* "millis": 138360000,
|
|
2401
|
+
* "friendly": "38h 2306m"
|
|
2402
|
+
* }
|
|
2403
|
+
* }
|
|
2404
|
+
* }
|
|
2405
|
+
* ]
|
|
2406
|
+
* }
|
|
2407
|
+
* @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/sla
|
|
2408
|
+
* @scopes-current read:jira-work
|
|
2409
|
+
* @scopes-beta read:request.sla:jira-service-management
|
|
2410
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-sla-get
|
|
2411
|
+
*/
|
|
2412
|
+
getSlaInformation: ({ issueIdOrKey, start, limit, }: {
|
|
2413
|
+
/** The ID or key of the customer request whose SLAs will be retrieved. */
|
|
2414
|
+
issueIdOrKey: string;
|
|
2415
|
+
/**
|
|
2416
|
+
* The starting index of the returned objects. Base index: 0. See the
|
|
2417
|
+
* [Pagination](#pagination) section for more details.
|
|
2418
|
+
*/
|
|
2419
|
+
start?: number | undefined;
|
|
2420
|
+
/**
|
|
2421
|
+
* The maximum number of request types to return per page. Default: 50. See the
|
|
2422
|
+
* [Pagination](#pagination) section for more details.
|
|
2423
|
+
*/
|
|
2424
|
+
limit?: number | undefined;
|
|
2425
|
+
}) => Promise<PagedDtoSlaInformationDto>;
|
|
2426
|
+
/**
|
|
2427
|
+
* This method returns the details for an SLA on a customer request.
|
|
2428
|
+
*
|
|
2429
|
+
* **[Permissions](#permissions) required**: Agent for the Service Desk containing
|
|
2430
|
+
* the queried customer request.
|
|
2431
|
+
*
|
|
2432
|
+
* @returns Returns the SLA record, on the specified page of the results.
|
|
2433
|
+
*
|
|
2434
|
+
* example: {
|
|
2435
|
+
* "name": "Time To First Response",
|
|
2436
|
+
* "_links": {
|
|
2437
|
+
* "self":
|
|
2438
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/101102/sla/10030"
|
|
2439
|
+
* },
|
|
2440
|
+
* "completedCycles": [
|
|
2441
|
+
* {
|
|
2442
|
+
* "startTime": {
|
|
2443
|
+
* "epochMillis": 1444362323000,
|
|
2444
|
+
* "friendly": "Yesterday 10:45 AM",
|
|
2445
|
+
* "iso8601": "2015-10-09T10:45:23+0700",
|
|
2446
|
+
* "jira": "2015-10-09T10:45:23.000+0700"
|
|
2447
|
+
* },
|
|
2448
|
+
* "stopTime": {
|
|
2449
|
+
* "epochMillis": 1444362743000,
|
|
2450
|
+
* "friendly": "Yesterday 10:52 AM",
|
|
2451
|
+
* "iso8601": "2015-10-09T10:52:23+0700",
|
|
2452
|
+
* "jira": "2015-10-09T10:52:23.000+0700"
|
|
2453
|
+
* },
|
|
2454
|
+
* "breachTime": {
|
|
2455
|
+
* "epochMillis": 1444362623000,
|
|
2456
|
+
* "friendly": "Yesterday 10:50 AM",
|
|
2457
|
+
* "iso8601": "2015-10-09T10:50:23+0700",
|
|
2458
|
+
* "jira": "2015-10-09T10:50:23.000+0700"
|
|
2459
|
+
* },
|
|
2460
|
+
* "breached": false,
|
|
2461
|
+
* "goalDuration": {
|
|
2462
|
+
* "millis": 14400000,
|
|
2463
|
+
* "friendly": "4h 240m"
|
|
2464
|
+
* },
|
|
2465
|
+
* "elapsedTime": {
|
|
2466
|
+
* "millis": 420000,
|
|
2467
|
+
* "friendly": "0h 7m"
|
|
2468
|
+
* },
|
|
2469
|
+
* "remainingTime": {
|
|
2470
|
+
* "millis": 13980000,
|
|
2471
|
+
* "friendly": "3h 233m"
|
|
2472
|
+
* }
|
|
2473
|
+
* },
|
|
2474
|
+
* {
|
|
2475
|
+
* "startTime": {
|
|
2476
|
+
* "epochMillis": 1444449143000,
|
|
2477
|
+
* "friendly": "Today 10:52 AM",
|
|
2478
|
+
* "iso8601": "2015-10-10T10:52:23+0700",
|
|
2479
|
+
* "jira": "2015-10-10T10:52:23.000+0700"
|
|
2480
|
+
* },
|
|
2481
|
+
* "stopTime": {
|
|
2482
|
+
* "epochMillis": 1444468523000,
|
|
2483
|
+
* "friendly": "Today 16:15 PM",
|
|
2484
|
+
* "iso8601": "2015-10-10T16:15:23+0700",
|
|
2485
|
+
* "jira": "2015-10-10T16:15:23.000+0700"
|
|
2486
|
+
* },
|
|
2487
|
+
* "breachTime": {
|
|
2488
|
+
* "epochMillis": 1444464743000,
|
|
2489
|
+
* "friendly": "Today 15:12 PM",
|
|
2490
|
+
* "iso8601": "2015-10-10T15:12:23+0700",
|
|
2491
|
+
* "jira": "2015-10-10T15:12:23.000+0700"
|
|
2492
|
+
* },
|
|
2493
|
+
* "breached": true,
|
|
2494
|
+
* "goalDuration": {
|
|
2495
|
+
* "millis": 14400000,
|
|
2496
|
+
* "friendly": "4h 240m"
|
|
2497
|
+
* },
|
|
2498
|
+
* "elapsedTime": {
|
|
2499
|
+
* "millis": 19380000,
|
|
2500
|
+
* "friendly": "5h 323m"
|
|
2501
|
+
* },
|
|
2502
|
+
* "remainingTime": {
|
|
2503
|
+
* "millis": -4980000,
|
|
2504
|
+
* "friendly": "-1h -83m"
|
|
2505
|
+
* }
|
|
2506
|
+
* }
|
|
2507
|
+
* ],
|
|
2508
|
+
* "ongoingCycle": {
|
|
2509
|
+
* "startTime": {
|
|
2510
|
+
* "epochMillis": 1444479323000,
|
|
2511
|
+
* "friendly": "Today 19:15 PM",
|
|
2512
|
+
* "iso8601": "2015-10-10T19:15:23+0700",
|
|
2513
|
+
* "jira": "2015-10-10T19:15:23.000+0700"
|
|
2514
|
+
* },
|
|
2515
|
+
* "breached": false,
|
|
2516
|
+
* "paused": false,
|
|
2517
|
+
* "withinCalendarHours": false,
|
|
2518
|
+
* "goalDuration": {
|
|
2519
|
+
* "millis": 14400000,
|
|
2520
|
+
* "friendly": "4h 240m"
|
|
2521
|
+
* },
|
|
2522
|
+
* "elapsedTime": {
|
|
2523
|
+
* "millis": 5640000,
|
|
2524
|
+
* "friendly": "1h 94m"
|
|
2525
|
+
* },
|
|
2526
|
+
* "remainingTime": {
|
|
2527
|
+
* "millis": 8760000,
|
|
2528
|
+
* "friendly": "2h 146m"
|
|
2529
|
+
* }
|
|
2530
|
+
* }
|
|
2531
|
+
* }
|
|
2532
|
+
* @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/sla/{slaMetricId}
|
|
2533
|
+
* @scopes-current read:jira-work
|
|
2534
|
+
* @scopes-beta read:request.sla:jira-service-management
|
|
2535
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-sla-slametricid-get
|
|
2536
|
+
*/
|
|
2537
|
+
getSlaInformationById: ({ issueIdOrKey, slaMetricId, }: {
|
|
2538
|
+
/** The ID or key of the customer request whose SLAs will be retrieved. */
|
|
2539
|
+
issueIdOrKey: string;
|
|
2540
|
+
/** The ID or key of the SLAs metric to be retrieved. */
|
|
2541
|
+
slaMetricId: number;
|
|
2542
|
+
}) => Promise<SlaInformationDto>;
|
|
2543
|
+
/**
|
|
2544
|
+
* This method returns the notification subscription status of the user making the
|
|
2545
|
+
* request. Use this method to determine if the user is subscribed to a customer
|
|
2546
|
+
* request's notifications.
|
|
2547
|
+
*
|
|
2548
|
+
* **[Permissions](#permissions) required**: Permission to view the customer
|
|
2549
|
+
* request.
|
|
2550
|
+
*
|
|
2551
|
+
* @returns Returns the status of the notification subscription.
|
|
2552
|
+
*
|
|
2553
|
+
* example: {
|
|
2554
|
+
* "subscribed": true
|
|
2555
|
+
* }
|
|
2556
|
+
* @path {GET} /rest/servicedeskapi/request/{issueIdOrKey}/notification
|
|
2557
|
+
* @scopes-current read:servicedesk-request
|
|
2558
|
+
* @scopes-beta read:request.notification:jira-service-management, read:user:jira
|
|
2559
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-notification-get
|
|
2560
|
+
*/
|
|
2561
|
+
getSubscriptionStatus: ({ issueIdOrKey, }: {
|
|
2562
|
+
/** The ID or key of the customer request to be queried for subscription status. */
|
|
2563
|
+
issueIdOrKey: string;
|
|
2564
|
+
}) => Promise<RequestNotificationSubscriptionDto>;
|
|
2565
|
+
/**
|
|
2566
|
+
* This method performs a customer transition for a given request and transition.
|
|
2567
|
+
* An optional comment can be included to provide a reason for the transition.
|
|
2568
|
+
*
|
|
2569
|
+
* **[Permissions](#permissions) required**: The user must be able to view the
|
|
2570
|
+
* request and have the Transition Issues permission. If a comment is passed the
|
|
2571
|
+
* user must have the Add Comments permission.
|
|
2572
|
+
*
|
|
2573
|
+
* @path {POST} /rest/servicedeskapi/request/{issueIdOrKey}/transition
|
|
2574
|
+
* @scopes-current write:servicedesk-request
|
|
2575
|
+
* @scopes-beta read:request.status:jira-service-management,
|
|
2576
|
+
* write:request.status:jira-service-management, read:user:jira
|
|
2577
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-transition-post
|
|
2578
|
+
*/
|
|
2579
|
+
performCustomerTransition: ({ issueIdOrKey, customerTransitionExecutionDto, }: {
|
|
2580
|
+
/** ID or key of the issue to transition */
|
|
2581
|
+
issueIdOrKey: string;
|
|
2582
|
+
/**
|
|
2583
|
+
* @example {
|
|
2584
|
+
* "additionalComment": {
|
|
2585
|
+
* "body": "I have fixed the problem."
|
|
2586
|
+
* },
|
|
2587
|
+
* "id": "1"
|
|
2588
|
+
* }
|
|
2589
|
+
*/
|
|
2590
|
+
customerTransitionExecutionDto: CustomerTransitionExecutionDto;
|
|
2591
|
+
}) => Promise<void>;
|
|
2592
|
+
/**
|
|
2593
|
+
* This method adds a feedback on an request using it's `requestKey` or `requestId`
|
|
2594
|
+
*
|
|
2595
|
+
* **[Permissions](#permissions) required**: User must be the reporter or an
|
|
2596
|
+
* Atlassian Connect app.
|
|
2597
|
+
*
|
|
2598
|
+
* @returns Returns the comment.
|
|
2599
|
+
*
|
|
2600
|
+
* example: {
|
|
2601
|
+
* "type": "csat",
|
|
2602
|
+
* "rating": 4,
|
|
2603
|
+
* "comment": {
|
|
2604
|
+
* "body": "Great work!"
|
|
2605
|
+
* }
|
|
2606
|
+
* }
|
|
2607
|
+
* @path {POST} /rest/servicedeskapi/request/{requestIdOrKey}/feedback
|
|
2608
|
+
* @scopes-current write:servicedesk-request
|
|
2609
|
+
* @scopes-beta read:request.feedback:jira-service-management,
|
|
2610
|
+
* write:request.feedback:jira-service-management, read:user:jira
|
|
2611
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-requestidorkey-feedback-post
|
|
2612
|
+
*/
|
|
2613
|
+
postFeedback: ({ requestIdOrKey, csatFeedbackFullDto, }: {
|
|
2614
|
+
/** The id or the key of the request to post the feedback on */
|
|
2615
|
+
requestIdOrKey: string;
|
|
2616
|
+
/**
|
|
2617
|
+
* The feedback to be added on the request
|
|
2618
|
+
*
|
|
2619
|
+
* @example {
|
|
2620
|
+
* "comment": {
|
|
2621
|
+
* "body": "Great work!"
|
|
2622
|
+
* },
|
|
2623
|
+
* "rating": 4,
|
|
2624
|
+
* "type": "csat"
|
|
2625
|
+
* }
|
|
2626
|
+
*/
|
|
2627
|
+
csatFeedbackFullDto: CsatFeedbackFullDto;
|
|
2628
|
+
}) => Promise<CsatFeedbackFullDto>;
|
|
2629
|
+
/**
|
|
2630
|
+
* This method removes participants from a customer request.
|
|
2631
|
+
*
|
|
2632
|
+
* **[Permissions](#permissions) required**: Permission to manage participants on
|
|
2633
|
+
* the customer request.
|
|
2634
|
+
*
|
|
2635
|
+
* @returns Returns the first page of the customer request's participants (after removal of
|
|
2636
|
+
* the users).
|
|
2637
|
+
*
|
|
2638
|
+
* example: {
|
|
2639
|
+
* "_expands": [],
|
|
2640
|
+
* "size": 1,
|
|
2641
|
+
* "start": 1,
|
|
2642
|
+
* "limit": 1,
|
|
2643
|
+
* "isLastPage": false,
|
|
2644
|
+
* "_links": {
|
|
2645
|
+
* "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
|
|
2646
|
+
* "context": "context",
|
|
2647
|
+
* "next":
|
|
2648
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=2&limit=1",
|
|
2649
|
+
* "prev":
|
|
2650
|
+
* "https://your-domain.atlassian.net/rest/servicedeskapi/request/1000/participant?start=0&limit=1"
|
|
2651
|
+
* },
|
|
2652
|
+
* "values": [
|
|
2653
|
+
* {
|
|
2654
|
+
* "accountId":
|
|
2655
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
2656
|
+
* "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
2657
|
+
* "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
2658
|
+
* "emailAddress": "fred@example.com",
|
|
2659
|
+
* "displayName": "Fred F. User",
|
|
2660
|
+
* "active": true,
|
|
2661
|
+
* "timeZone": "Australia/Sydney",
|
|
2662
|
+
* "_links": {
|
|
2663
|
+
* "jiraRest":
|
|
2664
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
2665
|
+
* "avatarUrls": {
|
|
2666
|
+
* "16x16":
|
|
2667
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
|
|
2668
|
+
* "24x24":
|
|
2669
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
|
|
2670
|
+
* "32x32":
|
|
2671
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
|
|
2672
|
+
* "48x48":
|
|
2673
|
+
* "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
|
|
2674
|
+
* },
|
|
2675
|
+
* "self":
|
|
2676
|
+
* "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
|
|
2677
|
+
* }
|
|
2678
|
+
* }
|
|
2679
|
+
* ]
|
|
2680
|
+
* }
|
|
2681
|
+
* @path {DELETE} /rest/servicedeskapi/request/{issueIdOrKey}/participant
|
|
2682
|
+
* @scopes-current write:servicedesk-request
|
|
2683
|
+
* @scopes-beta read:request.participant:jira-service-management,
|
|
2684
|
+
* delete:request.participant:jira-service-management, read:user:jira
|
|
2685
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-participant-delete
|
|
2686
|
+
*/
|
|
2687
|
+
removeRequestParticipants: ({ issueIdOrKey, requestParticipantUpdateDto, }: {
|
|
2688
|
+
/** The ID or key of the customer request to have participants removed. */
|
|
2689
|
+
issueIdOrKey: string;
|
|
2690
|
+
/**
|
|
2691
|
+
* @example {
|
|
2692
|
+
* "accountIds": [],
|
|
2693
|
+
* "usernames": [
|
|
2694
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
|
|
2695
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd",
|
|
2696
|
+
* "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae"
|
|
2697
|
+
* ]
|
|
2698
|
+
* }
|
|
2699
|
+
*/
|
|
2700
|
+
requestParticipantUpdateDto: RequestParticipantUpdateDto;
|
|
2701
|
+
}) => Promise<PagedDtoUserDto>;
|
|
2702
|
+
/**
|
|
2703
|
+
* This method subscribes the user to receiving notifications from a customer
|
|
2704
|
+
* request.
|
|
2705
|
+
*
|
|
2706
|
+
* **[Permissions](#permissions) required**: Permission to view the customer
|
|
2707
|
+
* request.
|
|
2708
|
+
*
|
|
2709
|
+
* @path {PUT} /rest/servicedeskapi/request/{issueIdOrKey}/notification
|
|
2710
|
+
* @scopes-current write:servicedesk-request
|
|
2711
|
+
* @scopes-beta read:request.notification:jira-service-management,
|
|
2712
|
+
* write:request.notification:jira-service-management, read:user:jira
|
|
2713
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-notification-put
|
|
2714
|
+
*/
|
|
2715
|
+
subscribe: ({ issueIdOrKey, }: {
|
|
2716
|
+
/** The ID or key of the customer request to be subscribed to. */
|
|
2717
|
+
issueIdOrKey: string;
|
|
2718
|
+
}) => Promise<void>;
|
|
2719
|
+
/**
|
|
2720
|
+
* This method unsubscribes the user from notifications from a customer request.
|
|
2721
|
+
*
|
|
2722
|
+
* **[Permissions](#permissions) required**: Permission to view the customer
|
|
2723
|
+
* request.
|
|
2724
|
+
*
|
|
2725
|
+
* @path {DELETE} /rest/servicedeskapi/request/{issueIdOrKey}/notification
|
|
2726
|
+
* @scopes-current write:servicedesk-request
|
|
2727
|
+
* @scopes-beta read:request.notification:jira-service-management,
|
|
2728
|
+
* delete:request.notification:jira-service-management, read:user:jira
|
|
2729
|
+
* @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request#api-rest-servicedeskapi-request-issueidorkey-notification-delete
|
|
2730
|
+
*/
|
|
2731
|
+
unsubscribe: ({ issueIdOrKey, }: {
|
|
2732
|
+
/** The ID or key of the customer request to be unsubscribed from. */
|
|
2733
|
+
issueIdOrKey: string;
|
|
2734
|
+
}) => Promise<void>;
|
|
2735
|
+
static initialize(): void;
|
|
2736
|
+
}
|