@utdk/zendesk 2.0.0-20260530.2-dev.646adf4
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/LICENSE +373 -0
- package/README.md +3 -0
- package/index.ts +22 -0
- package/metadata.ts +3 -0
- package/openapi.json +984 -0
- package/overlay.yaml +23 -0
- package/package.json +34 -0
- package/provenance.json +24 -0
- package/research.json +110 -0
- package/types.ts +3 -0
package/openapi.json
ADDED
|
@@ -0,0 +1,984 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi": "3.0.3",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "Zendesk Support API",
|
|
5
|
+
"version": "2.0.0",
|
|
6
|
+
"description": "The Zendesk Support API lets you access, create, update, and delete help desk tickets (called 'tickets'), users, organizations, and groups. Build integrations that automate support workflows, sync customer data, and extend the Zendesk platform.",
|
|
7
|
+
"contact": {
|
|
8
|
+
"name": "Zendesk Developer Support",
|
|
9
|
+
"url": "https://developer.zendesk.com"
|
|
10
|
+
},
|
|
11
|
+
"license": {
|
|
12
|
+
"name": "Apache 2.0",
|
|
13
|
+
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
|
|
14
|
+
},
|
|
15
|
+
"x-logo": {
|
|
16
|
+
"url": "https://d1eipm3vz40hy0.cloudfront.net/images/logos/zendesk-logo.svg"
|
|
17
|
+
}
|
|
18
|
+
},
|
|
19
|
+
"externalDocs": {
|
|
20
|
+
"description": "Zendesk API Reference",
|
|
21
|
+
"url": "https://developer.zendesk.com/api-reference"
|
|
22
|
+
},
|
|
23
|
+
"servers": [
|
|
24
|
+
{
|
|
25
|
+
"url": "https://{subdomain}.zendesk.com/api/v2",
|
|
26
|
+
"variables": {
|
|
27
|
+
"subdomain": {
|
|
28
|
+
"default": "example",
|
|
29
|
+
"description": "Your Zendesk subdomain"
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
],
|
|
34
|
+
"security": [
|
|
35
|
+
{
|
|
36
|
+
"BearerAuth": []
|
|
37
|
+
}
|
|
38
|
+
],
|
|
39
|
+
"paths": {
|
|
40
|
+
"/tickets": {
|
|
41
|
+
"get": {
|
|
42
|
+
"operationId": "listTickets",
|
|
43
|
+
"summary": "List tickets",
|
|
44
|
+
"description": "Returns a list of all tickets in the Zendesk account. Tickets are sorted by creation date in descending order by default. Use pagination parameters to retrieve large result sets.",
|
|
45
|
+
"tags": [
|
|
46
|
+
"Tickets"
|
|
47
|
+
],
|
|
48
|
+
"parameters": [
|
|
49
|
+
{
|
|
50
|
+
"name": "page",
|
|
51
|
+
"in": "query",
|
|
52
|
+
"description": "Page number for pagination",
|
|
53
|
+
"schema": {
|
|
54
|
+
"type": "integer",
|
|
55
|
+
"minimum": 1
|
|
56
|
+
}
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "per_page",
|
|
60
|
+
"in": "query",
|
|
61
|
+
"description": "Number of tickets per page (max 100)",
|
|
62
|
+
"schema": {
|
|
63
|
+
"type": "integer",
|
|
64
|
+
"minimum": 1,
|
|
65
|
+
"maximum": 100,
|
|
66
|
+
"default": 25
|
|
67
|
+
}
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"name": "sort_by",
|
|
71
|
+
"in": "query",
|
|
72
|
+
"description": "Field to sort results by",
|
|
73
|
+
"schema": {
|
|
74
|
+
"type": "string",
|
|
75
|
+
"enum": [
|
|
76
|
+
"created_at",
|
|
77
|
+
"updated_at",
|
|
78
|
+
"priority",
|
|
79
|
+
"status",
|
|
80
|
+
"ticket_type"
|
|
81
|
+
]
|
|
82
|
+
}
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"name": "sort_order",
|
|
86
|
+
"in": "query",
|
|
87
|
+
"description": "Sort direction",
|
|
88
|
+
"schema": {
|
|
89
|
+
"type": "string",
|
|
90
|
+
"enum": [
|
|
91
|
+
"asc",
|
|
92
|
+
"desc"
|
|
93
|
+
]
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
],
|
|
97
|
+
"responses": {
|
|
98
|
+
"200": {
|
|
99
|
+
"description": "List of tickets",
|
|
100
|
+
"content": {
|
|
101
|
+
"application/json": {
|
|
102
|
+
"schema": {
|
|
103
|
+
"$ref": "#/components/schemas/TicketList"
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
},
|
|
108
|
+
"401": {
|
|
109
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
},
|
|
113
|
+
"post": {
|
|
114
|
+
"operationId": "createTicket",
|
|
115
|
+
"summary": "Create a ticket",
|
|
116
|
+
"description": "Create a new support ticket. You can set the subject, description, priority, type, requester, assignee, tags, and custom fields. A ticket must have at minimum a subject or description.",
|
|
117
|
+
"tags": [
|
|
118
|
+
"Tickets"
|
|
119
|
+
],
|
|
120
|
+
"requestBody": {
|
|
121
|
+
"required": true,
|
|
122
|
+
"content": {
|
|
123
|
+
"application/json": {
|
|
124
|
+
"schema": {
|
|
125
|
+
"$ref": "#/components/schemas/CreateTicketRequest"
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
},
|
|
130
|
+
"responses": {
|
|
131
|
+
"201": {
|
|
132
|
+
"description": "Ticket created",
|
|
133
|
+
"content": {
|
|
134
|
+
"application/json": {
|
|
135
|
+
"schema": {
|
|
136
|
+
"$ref": "#/components/schemas/TicketResponse"
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
},
|
|
141
|
+
"400": {
|
|
142
|
+
"$ref": "#/components/responses/BadRequest"
|
|
143
|
+
},
|
|
144
|
+
"401": {
|
|
145
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
},
|
|
150
|
+
"/tickets/{ticketId}": {
|
|
151
|
+
"get": {
|
|
152
|
+
"operationId": "getTicket",
|
|
153
|
+
"summary": "Show a ticket",
|
|
154
|
+
"description": "Returns the details of a specific ticket by its ID, including subject, description, status, priority, requester, assignee, tags, and custom field values.",
|
|
155
|
+
"tags": [
|
|
156
|
+
"Tickets"
|
|
157
|
+
],
|
|
158
|
+
"parameters": [
|
|
159
|
+
{
|
|
160
|
+
"name": "ticketId",
|
|
161
|
+
"in": "path",
|
|
162
|
+
"required": true,
|
|
163
|
+
"description": "The ticket ID",
|
|
164
|
+
"schema": {
|
|
165
|
+
"type": "integer"
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
],
|
|
169
|
+
"responses": {
|
|
170
|
+
"200": {
|
|
171
|
+
"description": "Ticket details",
|
|
172
|
+
"content": {
|
|
173
|
+
"application/json": {
|
|
174
|
+
"schema": {
|
|
175
|
+
"$ref": "#/components/schemas/TicketResponse"
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
},
|
|
180
|
+
"404": {
|
|
181
|
+
"$ref": "#/components/responses/NotFound"
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
},
|
|
185
|
+
"put": {
|
|
186
|
+
"operationId": "updateTicket",
|
|
187
|
+
"summary": "Update a ticket",
|
|
188
|
+
"description": "Update one or more properties of a ticket. You can change the subject, status, priority, assignee, tags, and other fields. Only include the fields you want to change.",
|
|
189
|
+
"tags": [
|
|
190
|
+
"Tickets"
|
|
191
|
+
],
|
|
192
|
+
"parameters": [
|
|
193
|
+
{
|
|
194
|
+
"name": "ticketId",
|
|
195
|
+
"in": "path",
|
|
196
|
+
"required": true,
|
|
197
|
+
"description": "The ticket ID",
|
|
198
|
+
"schema": {
|
|
199
|
+
"type": "integer"
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
],
|
|
203
|
+
"requestBody": {
|
|
204
|
+
"required": true,
|
|
205
|
+
"content": {
|
|
206
|
+
"application/json": {
|
|
207
|
+
"schema": {
|
|
208
|
+
"$ref": "#/components/schemas/UpdateTicketRequest"
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
},
|
|
213
|
+
"responses": {
|
|
214
|
+
"200": {
|
|
215
|
+
"description": "Ticket updated",
|
|
216
|
+
"content": {
|
|
217
|
+
"application/json": {
|
|
218
|
+
"schema": {
|
|
219
|
+
"$ref": "#/components/schemas/TicketResponse"
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
},
|
|
224
|
+
"422": {
|
|
225
|
+
"$ref": "#/components/responses/UnprocessableEntity"
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
},
|
|
229
|
+
"delete": {
|
|
230
|
+
"operationId": "deleteTicket",
|
|
231
|
+
"summary": "Delete a ticket",
|
|
232
|
+
"description": "Permanently delete a ticket and all its associated comments. This action cannot be undone. Deleted tickets are moved to the account's deleted tickets list for 30 days before permanent deletion.",
|
|
233
|
+
"tags": [
|
|
234
|
+
"Tickets"
|
|
235
|
+
],
|
|
236
|
+
"parameters": [
|
|
237
|
+
{
|
|
238
|
+
"name": "ticketId",
|
|
239
|
+
"in": "path",
|
|
240
|
+
"required": true,
|
|
241
|
+
"description": "The ticket ID",
|
|
242
|
+
"schema": {
|
|
243
|
+
"type": "integer"
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
],
|
|
247
|
+
"responses": {
|
|
248
|
+
"204": {
|
|
249
|
+
"description": "Ticket deleted"
|
|
250
|
+
},
|
|
251
|
+
"404": {
|
|
252
|
+
"$ref": "#/components/responses/NotFound"
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
}
|
|
256
|
+
},
|
|
257
|
+
"/tickets/{ticketId}/comments": {
|
|
258
|
+
"get": {
|
|
259
|
+
"operationId": "listTicketComments",
|
|
260
|
+
"summary": "List ticket comments",
|
|
261
|
+
"description": "Returns all comments on a ticket, including public replies and internal notes. Comments are sorted by creation date in ascending order.",
|
|
262
|
+
"tags": [
|
|
263
|
+
"Tickets"
|
|
264
|
+
],
|
|
265
|
+
"parameters": [
|
|
266
|
+
{
|
|
267
|
+
"name": "ticketId",
|
|
268
|
+
"in": "path",
|
|
269
|
+
"required": true,
|
|
270
|
+
"description": "The ticket ID",
|
|
271
|
+
"schema": {
|
|
272
|
+
"type": "integer"
|
|
273
|
+
}
|
|
274
|
+
},
|
|
275
|
+
{
|
|
276
|
+
"name": "page",
|
|
277
|
+
"in": "query",
|
|
278
|
+
"description": "Page number",
|
|
279
|
+
"schema": {
|
|
280
|
+
"type": "integer"
|
|
281
|
+
}
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
"name": "per_page",
|
|
285
|
+
"in": "query",
|
|
286
|
+
"description": "Comments per page",
|
|
287
|
+
"schema": {
|
|
288
|
+
"type": "integer"
|
|
289
|
+
}
|
|
290
|
+
}
|
|
291
|
+
],
|
|
292
|
+
"responses": {
|
|
293
|
+
"200": {
|
|
294
|
+
"description": "List of comments",
|
|
295
|
+
"content": {
|
|
296
|
+
"application/json": {
|
|
297
|
+
"schema": {
|
|
298
|
+
"$ref": "#/components/schemas/CommentList"
|
|
299
|
+
}
|
|
300
|
+
}
|
|
301
|
+
}
|
|
302
|
+
}
|
|
303
|
+
}
|
|
304
|
+
}
|
|
305
|
+
},
|
|
306
|
+
"/users": {
|
|
307
|
+
"get": {
|
|
308
|
+
"operationId": "listUsers",
|
|
309
|
+
"summary": "List users",
|
|
310
|
+
"description": "Returns a list of users in the account. Includes end-users (customers), agents, and administrators. Use filters to narrow results by role or organization.",
|
|
311
|
+
"tags": [
|
|
312
|
+
"Users"
|
|
313
|
+
],
|
|
314
|
+
"parameters": [
|
|
315
|
+
{
|
|
316
|
+
"name": "role",
|
|
317
|
+
"in": "query",
|
|
318
|
+
"description": "Filter by user role",
|
|
319
|
+
"schema": {
|
|
320
|
+
"type": "string",
|
|
321
|
+
"enum": [
|
|
322
|
+
"end-user",
|
|
323
|
+
"agent",
|
|
324
|
+
"admin"
|
|
325
|
+
]
|
|
326
|
+
}
|
|
327
|
+
},
|
|
328
|
+
{
|
|
329
|
+
"name": "page",
|
|
330
|
+
"in": "query",
|
|
331
|
+
"schema": {
|
|
332
|
+
"type": "integer"
|
|
333
|
+
}
|
|
334
|
+
},
|
|
335
|
+
{
|
|
336
|
+
"name": "per_page",
|
|
337
|
+
"in": "query",
|
|
338
|
+
"schema": {
|
|
339
|
+
"type": "integer"
|
|
340
|
+
}
|
|
341
|
+
}
|
|
342
|
+
],
|
|
343
|
+
"responses": {
|
|
344
|
+
"200": {
|
|
345
|
+
"description": "List of users",
|
|
346
|
+
"content": {
|
|
347
|
+
"application/json": {
|
|
348
|
+
"schema": {
|
|
349
|
+
"$ref": "#/components/schemas/UserList"
|
|
350
|
+
}
|
|
351
|
+
}
|
|
352
|
+
}
|
|
353
|
+
}
|
|
354
|
+
}
|
|
355
|
+
}
|
|
356
|
+
},
|
|
357
|
+
"/users/{userId}": {
|
|
358
|
+
"get": {
|
|
359
|
+
"operationId": "getUser",
|
|
360
|
+
"summary": "Show a user",
|
|
361
|
+
"description": "Returns the profile of a specific user including their name, email, role, organization membership, and custom user fields.",
|
|
362
|
+
"tags": [
|
|
363
|
+
"Users"
|
|
364
|
+
],
|
|
365
|
+
"parameters": [
|
|
366
|
+
{
|
|
367
|
+
"name": "userId",
|
|
368
|
+
"in": "path",
|
|
369
|
+
"required": true,
|
|
370
|
+
"description": "The user ID",
|
|
371
|
+
"schema": {
|
|
372
|
+
"type": "integer"
|
|
373
|
+
}
|
|
374
|
+
}
|
|
375
|
+
],
|
|
376
|
+
"responses": {
|
|
377
|
+
"200": {
|
|
378
|
+
"description": "User details",
|
|
379
|
+
"content": {
|
|
380
|
+
"application/json": {
|
|
381
|
+
"schema": {
|
|
382
|
+
"$ref": "#/components/schemas/UserResponse"
|
|
383
|
+
}
|
|
384
|
+
}
|
|
385
|
+
}
|
|
386
|
+
},
|
|
387
|
+
"404": {
|
|
388
|
+
"$ref": "#/components/responses/NotFound"
|
|
389
|
+
}
|
|
390
|
+
}
|
|
391
|
+
}
|
|
392
|
+
},
|
|
393
|
+
"/organizations": {
|
|
394
|
+
"get": {
|
|
395
|
+
"operationId": "listOrganizations",
|
|
396
|
+
"summary": "List organizations",
|
|
397
|
+
"description": "Returns all organizations in the account. Organizations group users together and can be used to manage shared tickets and visibility rules.",
|
|
398
|
+
"tags": [
|
|
399
|
+
"Organizations"
|
|
400
|
+
],
|
|
401
|
+
"parameters": [
|
|
402
|
+
{
|
|
403
|
+
"name": "page",
|
|
404
|
+
"in": "query",
|
|
405
|
+
"schema": {
|
|
406
|
+
"type": "integer"
|
|
407
|
+
}
|
|
408
|
+
},
|
|
409
|
+
{
|
|
410
|
+
"name": "per_page",
|
|
411
|
+
"in": "query",
|
|
412
|
+
"schema": {
|
|
413
|
+
"type": "integer"
|
|
414
|
+
}
|
|
415
|
+
}
|
|
416
|
+
],
|
|
417
|
+
"responses": {
|
|
418
|
+
"200": {
|
|
419
|
+
"description": "List of organizations",
|
|
420
|
+
"content": {
|
|
421
|
+
"application/json": {
|
|
422
|
+
"schema": {
|
|
423
|
+
"$ref": "#/components/schemas/OrganizationList"
|
|
424
|
+
}
|
|
425
|
+
}
|
|
426
|
+
}
|
|
427
|
+
}
|
|
428
|
+
}
|
|
429
|
+
}
|
|
430
|
+
},
|
|
431
|
+
"/search": {
|
|
432
|
+
"get": {
|
|
433
|
+
"operationId": "search",
|
|
434
|
+
"summary": "Search Zendesk",
|
|
435
|
+
"description": "Search tickets, users, organizations, groups, and other Zendesk objects using Zendesk's search syntax. Supports filtering by field values, date ranges, and full-text search.",
|
|
436
|
+
"tags": [
|
|
437
|
+
"Search"
|
|
438
|
+
],
|
|
439
|
+
"parameters": [
|
|
440
|
+
{
|
|
441
|
+
"name": "query",
|
|
442
|
+
"in": "query",
|
|
443
|
+
"required": true,
|
|
444
|
+
"description": "Search query using Zendesk search syntax (e.g. 'type:ticket status:open priority:high')",
|
|
445
|
+
"schema": {
|
|
446
|
+
"type": "string"
|
|
447
|
+
}
|
|
448
|
+
},
|
|
449
|
+
{
|
|
450
|
+
"name": "sort_by",
|
|
451
|
+
"in": "query",
|
|
452
|
+
"description": "Field to sort results by",
|
|
453
|
+
"schema": {
|
|
454
|
+
"type": "string"
|
|
455
|
+
}
|
|
456
|
+
},
|
|
457
|
+
{
|
|
458
|
+
"name": "sort_order",
|
|
459
|
+
"in": "query",
|
|
460
|
+
"description": "Sort direction",
|
|
461
|
+
"schema": {
|
|
462
|
+
"type": "string",
|
|
463
|
+
"enum": [
|
|
464
|
+
"asc",
|
|
465
|
+
"desc"
|
|
466
|
+
]
|
|
467
|
+
}
|
|
468
|
+
},
|
|
469
|
+
{
|
|
470
|
+
"name": "page",
|
|
471
|
+
"in": "query",
|
|
472
|
+
"schema": {
|
|
473
|
+
"type": "integer"
|
|
474
|
+
}
|
|
475
|
+
},
|
|
476
|
+
{
|
|
477
|
+
"name": "per_page",
|
|
478
|
+
"in": "query",
|
|
479
|
+
"schema": {
|
|
480
|
+
"type": "integer"
|
|
481
|
+
}
|
|
482
|
+
}
|
|
483
|
+
],
|
|
484
|
+
"responses": {
|
|
485
|
+
"200": {
|
|
486
|
+
"description": "Search results",
|
|
487
|
+
"content": {
|
|
488
|
+
"application/json": {
|
|
489
|
+
"schema": {
|
|
490
|
+
"$ref": "#/components/schemas/SearchResults"
|
|
491
|
+
}
|
|
492
|
+
}
|
|
493
|
+
}
|
|
494
|
+
}
|
|
495
|
+
}
|
|
496
|
+
}
|
|
497
|
+
}
|
|
498
|
+
},
|
|
499
|
+
"components": {
|
|
500
|
+
"securitySchemes": {
|
|
501
|
+
"BearerAuth": {
|
|
502
|
+
"type": "http",
|
|
503
|
+
"scheme": "bearer",
|
|
504
|
+
"description": "Zendesk API token in format 'email@example.com/token:{api_token}' encoded as Bearer token, or OAuth 2.0 access token"
|
|
505
|
+
}
|
|
506
|
+
},
|
|
507
|
+
"responses": {
|
|
508
|
+
"Unauthorized": {
|
|
509
|
+
"description": "Authentication required",
|
|
510
|
+
"content": {
|
|
511
|
+
"application/json": {
|
|
512
|
+
"schema": {
|
|
513
|
+
"$ref": "#/components/schemas/Error"
|
|
514
|
+
}
|
|
515
|
+
}
|
|
516
|
+
}
|
|
517
|
+
},
|
|
518
|
+
"BadRequest": {
|
|
519
|
+
"description": "Invalid request",
|
|
520
|
+
"content": {
|
|
521
|
+
"application/json": {
|
|
522
|
+
"schema": {
|
|
523
|
+
"$ref": "#/components/schemas/Error"
|
|
524
|
+
}
|
|
525
|
+
}
|
|
526
|
+
}
|
|
527
|
+
},
|
|
528
|
+
"NotFound": {
|
|
529
|
+
"description": "Resource not found",
|
|
530
|
+
"content": {
|
|
531
|
+
"application/json": {
|
|
532
|
+
"schema": {
|
|
533
|
+
"$ref": "#/components/schemas/Error"
|
|
534
|
+
}
|
|
535
|
+
}
|
|
536
|
+
}
|
|
537
|
+
},
|
|
538
|
+
"UnprocessableEntity": {
|
|
539
|
+
"description": "Validation error",
|
|
540
|
+
"content": {
|
|
541
|
+
"application/json": {
|
|
542
|
+
"schema": {
|
|
543
|
+
"$ref": "#/components/schemas/Error"
|
|
544
|
+
}
|
|
545
|
+
}
|
|
546
|
+
}
|
|
547
|
+
}
|
|
548
|
+
},
|
|
549
|
+
"schemas": {
|
|
550
|
+
"Ticket": {
|
|
551
|
+
"type": "object",
|
|
552
|
+
"properties": {
|
|
553
|
+
"id": {
|
|
554
|
+
"type": "integer",
|
|
555
|
+
"description": "Ticket ID"
|
|
556
|
+
},
|
|
557
|
+
"url": {
|
|
558
|
+
"type": "string",
|
|
559
|
+
"format": "uri"
|
|
560
|
+
},
|
|
561
|
+
"external_id": {
|
|
562
|
+
"type": "string"
|
|
563
|
+
},
|
|
564
|
+
"type": {
|
|
565
|
+
"type": "string",
|
|
566
|
+
"enum": [
|
|
567
|
+
"problem",
|
|
568
|
+
"incident",
|
|
569
|
+
"question",
|
|
570
|
+
"task"
|
|
571
|
+
],
|
|
572
|
+
"description": "Ticket type"
|
|
573
|
+
},
|
|
574
|
+
"subject": {
|
|
575
|
+
"type": "string",
|
|
576
|
+
"description": "Ticket subject line"
|
|
577
|
+
},
|
|
578
|
+
"raw_subject": {
|
|
579
|
+
"type": "string"
|
|
580
|
+
},
|
|
581
|
+
"description": {
|
|
582
|
+
"type": "string",
|
|
583
|
+
"description": "First comment on the ticket"
|
|
584
|
+
},
|
|
585
|
+
"priority": {
|
|
586
|
+
"type": "string",
|
|
587
|
+
"enum": [
|
|
588
|
+
"urgent",
|
|
589
|
+
"high",
|
|
590
|
+
"normal",
|
|
591
|
+
"low"
|
|
592
|
+
],
|
|
593
|
+
"description": "Ticket priority"
|
|
594
|
+
},
|
|
595
|
+
"status": {
|
|
596
|
+
"type": "string",
|
|
597
|
+
"enum": [
|
|
598
|
+
"new",
|
|
599
|
+
"open",
|
|
600
|
+
"pending",
|
|
601
|
+
"hold",
|
|
602
|
+
"solved",
|
|
603
|
+
"closed"
|
|
604
|
+
],
|
|
605
|
+
"description": "Ticket status"
|
|
606
|
+
},
|
|
607
|
+
"requester_id": {
|
|
608
|
+
"type": "integer",
|
|
609
|
+
"description": "User ID of the ticket requester"
|
|
610
|
+
},
|
|
611
|
+
"submitter_id": {
|
|
612
|
+
"type": "integer"
|
|
613
|
+
},
|
|
614
|
+
"assignee_id": {
|
|
615
|
+
"type": "integer",
|
|
616
|
+
"description": "Agent ID assigned to the ticket"
|
|
617
|
+
},
|
|
618
|
+
"organization_id": {
|
|
619
|
+
"type": "integer"
|
|
620
|
+
},
|
|
621
|
+
"group_id": {
|
|
622
|
+
"type": "integer"
|
|
623
|
+
},
|
|
624
|
+
"tags": {
|
|
625
|
+
"type": "array",
|
|
626
|
+
"items": {
|
|
627
|
+
"type": "string"
|
|
628
|
+
}
|
|
629
|
+
},
|
|
630
|
+
"created_at": {
|
|
631
|
+
"type": "string",
|
|
632
|
+
"format": "date-time"
|
|
633
|
+
},
|
|
634
|
+
"updated_at": {
|
|
635
|
+
"type": "string",
|
|
636
|
+
"format": "date-time"
|
|
637
|
+
}
|
|
638
|
+
}
|
|
639
|
+
},
|
|
640
|
+
"TicketList": {
|
|
641
|
+
"type": "object",
|
|
642
|
+
"properties": {
|
|
643
|
+
"tickets": {
|
|
644
|
+
"type": "array",
|
|
645
|
+
"items": {
|
|
646
|
+
"$ref": "#/components/schemas/Ticket"
|
|
647
|
+
}
|
|
648
|
+
},
|
|
649
|
+
"next_page": {
|
|
650
|
+
"type": "string",
|
|
651
|
+
"format": "uri"
|
|
652
|
+
},
|
|
653
|
+
"previous_page": {
|
|
654
|
+
"type": "string",
|
|
655
|
+
"format": "uri"
|
|
656
|
+
},
|
|
657
|
+
"count": {
|
|
658
|
+
"type": "integer"
|
|
659
|
+
}
|
|
660
|
+
}
|
|
661
|
+
},
|
|
662
|
+
"TicketResponse": {
|
|
663
|
+
"type": "object",
|
|
664
|
+
"properties": {
|
|
665
|
+
"ticket": {
|
|
666
|
+
"$ref": "#/components/schemas/Ticket"
|
|
667
|
+
}
|
|
668
|
+
}
|
|
669
|
+
},
|
|
670
|
+
"CreateTicketRequest": {
|
|
671
|
+
"type": "object",
|
|
672
|
+
"required": [
|
|
673
|
+
"ticket"
|
|
674
|
+
],
|
|
675
|
+
"properties": {
|
|
676
|
+
"ticket": {
|
|
677
|
+
"type": "object",
|
|
678
|
+
"properties": {
|
|
679
|
+
"subject": {
|
|
680
|
+
"type": "string"
|
|
681
|
+
},
|
|
682
|
+
"comment": {
|
|
683
|
+
"type": "object",
|
|
684
|
+
"properties": {
|
|
685
|
+
"body": {
|
|
686
|
+
"type": "string"
|
|
687
|
+
},
|
|
688
|
+
"html_body": {
|
|
689
|
+
"type": "string"
|
|
690
|
+
}
|
|
691
|
+
}
|
|
692
|
+
},
|
|
693
|
+
"requester_id": {
|
|
694
|
+
"type": "integer"
|
|
695
|
+
},
|
|
696
|
+
"assignee_id": {
|
|
697
|
+
"type": "integer"
|
|
698
|
+
},
|
|
699
|
+
"group_id": {
|
|
700
|
+
"type": "integer"
|
|
701
|
+
},
|
|
702
|
+
"organization_id": {
|
|
703
|
+
"type": "integer"
|
|
704
|
+
},
|
|
705
|
+
"priority": {
|
|
706
|
+
"type": "string",
|
|
707
|
+
"enum": [
|
|
708
|
+
"urgent",
|
|
709
|
+
"high",
|
|
710
|
+
"normal",
|
|
711
|
+
"low"
|
|
712
|
+
]
|
|
713
|
+
},
|
|
714
|
+
"status": {
|
|
715
|
+
"type": "string",
|
|
716
|
+
"enum": [
|
|
717
|
+
"new",
|
|
718
|
+
"open",
|
|
719
|
+
"pending",
|
|
720
|
+
"hold",
|
|
721
|
+
"solved"
|
|
722
|
+
]
|
|
723
|
+
},
|
|
724
|
+
"type": {
|
|
725
|
+
"type": "string",
|
|
726
|
+
"enum": [
|
|
727
|
+
"problem",
|
|
728
|
+
"incident",
|
|
729
|
+
"question",
|
|
730
|
+
"task"
|
|
731
|
+
]
|
|
732
|
+
},
|
|
733
|
+
"tags": {
|
|
734
|
+
"type": "array",
|
|
735
|
+
"items": {
|
|
736
|
+
"type": "string"
|
|
737
|
+
}
|
|
738
|
+
}
|
|
739
|
+
}
|
|
740
|
+
}
|
|
741
|
+
}
|
|
742
|
+
},
|
|
743
|
+
"UpdateTicketRequest": {
|
|
744
|
+
"type": "object",
|
|
745
|
+
"required": [
|
|
746
|
+
"ticket"
|
|
747
|
+
],
|
|
748
|
+
"properties": {
|
|
749
|
+
"ticket": {
|
|
750
|
+
"type": "object",
|
|
751
|
+
"properties": {
|
|
752
|
+
"subject": {
|
|
753
|
+
"type": "string"
|
|
754
|
+
},
|
|
755
|
+
"status": {
|
|
756
|
+
"type": "string",
|
|
757
|
+
"enum": [
|
|
758
|
+
"new",
|
|
759
|
+
"open",
|
|
760
|
+
"pending",
|
|
761
|
+
"hold",
|
|
762
|
+
"solved",
|
|
763
|
+
"closed"
|
|
764
|
+
]
|
|
765
|
+
},
|
|
766
|
+
"priority": {
|
|
767
|
+
"type": "string",
|
|
768
|
+
"enum": [
|
|
769
|
+
"urgent",
|
|
770
|
+
"high",
|
|
771
|
+
"normal",
|
|
772
|
+
"low"
|
|
773
|
+
]
|
|
774
|
+
},
|
|
775
|
+
"assignee_id": {
|
|
776
|
+
"type": "integer"
|
|
777
|
+
},
|
|
778
|
+
"tags": {
|
|
779
|
+
"type": "array",
|
|
780
|
+
"items": {
|
|
781
|
+
"type": "string"
|
|
782
|
+
}
|
|
783
|
+
},
|
|
784
|
+
"comment": {
|
|
785
|
+
"type": "object",
|
|
786
|
+
"properties": {
|
|
787
|
+
"body": {
|
|
788
|
+
"type": "string"
|
|
789
|
+
},
|
|
790
|
+
"public": {
|
|
791
|
+
"type": "boolean"
|
|
792
|
+
}
|
|
793
|
+
}
|
|
794
|
+
}
|
|
795
|
+
}
|
|
796
|
+
}
|
|
797
|
+
}
|
|
798
|
+
},
|
|
799
|
+
"Comment": {
|
|
800
|
+
"type": "object",
|
|
801
|
+
"properties": {
|
|
802
|
+
"id": {
|
|
803
|
+
"type": "integer"
|
|
804
|
+
},
|
|
805
|
+
"type": {
|
|
806
|
+
"type": "string"
|
|
807
|
+
},
|
|
808
|
+
"author_id": {
|
|
809
|
+
"type": "integer"
|
|
810
|
+
},
|
|
811
|
+
"body": {
|
|
812
|
+
"type": "string"
|
|
813
|
+
},
|
|
814
|
+
"html_body": {
|
|
815
|
+
"type": "string"
|
|
816
|
+
},
|
|
817
|
+
"plain_body": {
|
|
818
|
+
"type": "string"
|
|
819
|
+
},
|
|
820
|
+
"public": {
|
|
821
|
+
"type": "boolean"
|
|
822
|
+
},
|
|
823
|
+
"created_at": {
|
|
824
|
+
"type": "string",
|
|
825
|
+
"format": "date-time"
|
|
826
|
+
}
|
|
827
|
+
}
|
|
828
|
+
},
|
|
829
|
+
"CommentList": {
|
|
830
|
+
"type": "object",
|
|
831
|
+
"properties": {
|
|
832
|
+
"comments": {
|
|
833
|
+
"type": "array",
|
|
834
|
+
"items": {
|
|
835
|
+
"$ref": "#/components/schemas/Comment"
|
|
836
|
+
}
|
|
837
|
+
},
|
|
838
|
+
"next_page": {
|
|
839
|
+
"type": "string"
|
|
840
|
+
},
|
|
841
|
+
"count": {
|
|
842
|
+
"type": "integer"
|
|
843
|
+
}
|
|
844
|
+
}
|
|
845
|
+
},
|
|
846
|
+
"User": {
|
|
847
|
+
"type": "object",
|
|
848
|
+
"properties": {
|
|
849
|
+
"id": {
|
|
850
|
+
"type": "integer"
|
|
851
|
+
},
|
|
852
|
+
"name": {
|
|
853
|
+
"type": "string"
|
|
854
|
+
},
|
|
855
|
+
"email": {
|
|
856
|
+
"type": "string",
|
|
857
|
+
"format": "email"
|
|
858
|
+
},
|
|
859
|
+
"role": {
|
|
860
|
+
"type": "string",
|
|
861
|
+
"enum": [
|
|
862
|
+
"end-user",
|
|
863
|
+
"agent",
|
|
864
|
+
"admin"
|
|
865
|
+
]
|
|
866
|
+
},
|
|
867
|
+
"organization_id": {
|
|
868
|
+
"type": "integer"
|
|
869
|
+
},
|
|
870
|
+
"verified": {
|
|
871
|
+
"type": "boolean"
|
|
872
|
+
},
|
|
873
|
+
"created_at": {
|
|
874
|
+
"type": "string",
|
|
875
|
+
"format": "date-time"
|
|
876
|
+
},
|
|
877
|
+
"updated_at": {
|
|
878
|
+
"type": "string",
|
|
879
|
+
"format": "date-time"
|
|
880
|
+
}
|
|
881
|
+
}
|
|
882
|
+
},
|
|
883
|
+
"UserList": {
|
|
884
|
+
"type": "object",
|
|
885
|
+
"properties": {
|
|
886
|
+
"users": {
|
|
887
|
+
"type": "array",
|
|
888
|
+
"items": {
|
|
889
|
+
"$ref": "#/components/schemas/User"
|
|
890
|
+
}
|
|
891
|
+
},
|
|
892
|
+
"next_page": {
|
|
893
|
+
"type": "string"
|
|
894
|
+
},
|
|
895
|
+
"count": {
|
|
896
|
+
"type": "integer"
|
|
897
|
+
}
|
|
898
|
+
}
|
|
899
|
+
},
|
|
900
|
+
"UserResponse": {
|
|
901
|
+
"type": "object",
|
|
902
|
+
"properties": {
|
|
903
|
+
"user": {
|
|
904
|
+
"$ref": "#/components/schemas/User"
|
|
905
|
+
}
|
|
906
|
+
}
|
|
907
|
+
},
|
|
908
|
+
"Organization": {
|
|
909
|
+
"type": "object",
|
|
910
|
+
"properties": {
|
|
911
|
+
"id": {
|
|
912
|
+
"type": "integer"
|
|
913
|
+
},
|
|
914
|
+
"name": {
|
|
915
|
+
"type": "string"
|
|
916
|
+
},
|
|
917
|
+
"notes": {
|
|
918
|
+
"type": "string"
|
|
919
|
+
},
|
|
920
|
+
"details": {
|
|
921
|
+
"type": "string"
|
|
922
|
+
},
|
|
923
|
+
"created_at": {
|
|
924
|
+
"type": "string",
|
|
925
|
+
"format": "date-time"
|
|
926
|
+
},
|
|
927
|
+
"updated_at": {
|
|
928
|
+
"type": "string",
|
|
929
|
+
"format": "date-time"
|
|
930
|
+
}
|
|
931
|
+
}
|
|
932
|
+
},
|
|
933
|
+
"OrganizationList": {
|
|
934
|
+
"type": "object",
|
|
935
|
+
"properties": {
|
|
936
|
+
"organizations": {
|
|
937
|
+
"type": "array",
|
|
938
|
+
"items": {
|
|
939
|
+
"$ref": "#/components/schemas/Organization"
|
|
940
|
+
}
|
|
941
|
+
},
|
|
942
|
+
"next_page": {
|
|
943
|
+
"type": "string"
|
|
944
|
+
},
|
|
945
|
+
"count": {
|
|
946
|
+
"type": "integer"
|
|
947
|
+
}
|
|
948
|
+
}
|
|
949
|
+
},
|
|
950
|
+
"SearchResults": {
|
|
951
|
+
"type": "object",
|
|
952
|
+
"properties": {
|
|
953
|
+
"results": {
|
|
954
|
+
"type": "array",
|
|
955
|
+
"items": {
|
|
956
|
+
"type": "object",
|
|
957
|
+
"additionalProperties": true
|
|
958
|
+
}
|
|
959
|
+
},
|
|
960
|
+
"next_page": {
|
|
961
|
+
"type": "string"
|
|
962
|
+
},
|
|
963
|
+
"previous_page": {
|
|
964
|
+
"type": "string"
|
|
965
|
+
},
|
|
966
|
+
"count": {
|
|
967
|
+
"type": "integer"
|
|
968
|
+
}
|
|
969
|
+
}
|
|
970
|
+
},
|
|
971
|
+
"Error": {
|
|
972
|
+
"type": "object",
|
|
973
|
+
"properties": {
|
|
974
|
+
"error": {
|
|
975
|
+
"type": "string"
|
|
976
|
+
},
|
|
977
|
+
"description": {
|
|
978
|
+
"type": "string"
|
|
979
|
+
}
|
|
980
|
+
}
|
|
981
|
+
}
|
|
982
|
+
}
|
|
983
|
+
}
|
|
984
|
+
}
|