@devrev/typescript-sdk 1.0.2 → 1.1.3
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 +21 -0
- package/README.md +31 -48
- package/package.json +17 -10
- package/.eslintignore +0 -2
- package/.github/workflows/npm-publish.yml +0 -27
- package/.prettierignore +0 -4
- package/.prettierrc +0 -15
- package/.vscode/extensions.json +0 -8
- package/.vscode/launch.json +0 -17
- package/.vscode/settings.json +0 -31
- package/USER_README.md +0 -16
- package/nodemon.json +0 -5
- package/src/auto-generated/beta/beta-devrev-sdk.ts +0 -1826
- package/src/auto-generated/internal/private-internal-devrev-sdk.ts +0 -54739
- package/src/auto-generated/public-devrev-sdk.ts +0 -4009
- package/src/beta-data-contracts.json +0 -3271
- package/src/client_setup.ts +0 -64
- package/src/private-internal-data-contracts.json +0 -98025
- package/src/public-data-contracts.json +0 -6922
- package/src/workflow/workflow.test.ts +0 -26
- package/src/workflow/workflow.ts +0 -54
- package/templates/README.md +0 -17
- package/templates/base/README.md +0 -8
- package/templates/base/data-contract-jsdoc.ejs +0 -37
- package/templates/base/data-contracts.ejs +0 -28
- package/templates/base/enum-data-contract.ejs +0 -12
- package/templates/base/http-client.ejs +0 -3
- package/templates/base/http-clients/axios-http-client.ejs +0 -138
- package/templates/base/http-clients/fetch-http-client.ejs +0 -224
- package/templates/base/interface-data-contract.ejs +0 -10
- package/templates/base/object-field-jsdoc.ejs +0 -28
- package/templates/base/route-docs.ejs +0 -30
- package/templates/base/route-name.ejs +0 -43
- package/templates/base/route-type.ejs +0 -22
- package/templates/base/type-data-contract.ejs +0 -15
- package/templates/default/README.md +0 -7
- package/templates/default/api.ejs +0 -64
- package/templates/default/procedure-call.ejs +0 -100
- package/templates/default/route-types.ejs +0 -26
- package/templates/modular/README.md +0 -7
- package/templates/modular/api.ejs +0 -28
- package/templates/modular/procedure-call.ejs +0 -100
- package/templates/modular/route-types.ejs +0 -18
- package/tsconfig.eslint.json +0 -4
- package/tsconfig.json +0 -25
|
@@ -1,3271 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"components": {
|
|
3
|
-
"responses": {
|
|
4
|
-
"bad-request": {
|
|
5
|
-
"content": {
|
|
6
|
-
"application/json": {
|
|
7
|
-
"schema": {
|
|
8
|
-
"$ref": "#/components/schemas/error-bad-request"
|
|
9
|
-
}
|
|
10
|
-
}
|
|
11
|
-
},
|
|
12
|
-
"description": "400 Bad Request."
|
|
13
|
-
},
|
|
14
|
-
"forbidden": {
|
|
15
|
-
"content": {
|
|
16
|
-
"application/json": {
|
|
17
|
-
"schema": {
|
|
18
|
-
"$ref": "#/components/schemas/error-forbidden"
|
|
19
|
-
}
|
|
20
|
-
}
|
|
21
|
-
},
|
|
22
|
-
"description": "403 Forbidden."
|
|
23
|
-
},
|
|
24
|
-
"internal-server-error": {
|
|
25
|
-
"content": {
|
|
26
|
-
"application/json": {
|
|
27
|
-
"schema": {
|
|
28
|
-
"$ref": "#/components/schemas/error-internal-server-error"
|
|
29
|
-
}
|
|
30
|
-
}
|
|
31
|
-
},
|
|
32
|
-
"description": "500 Internal Server Error."
|
|
33
|
-
},
|
|
34
|
-
"not-found": {
|
|
35
|
-
"content": {
|
|
36
|
-
"application/json": {
|
|
37
|
-
"schema": {
|
|
38
|
-
"$ref": "#/components/schemas/error-not-found"
|
|
39
|
-
}
|
|
40
|
-
}
|
|
41
|
-
},
|
|
42
|
-
"description": "404 Not Found."
|
|
43
|
-
},
|
|
44
|
-
"service-unavailable": {
|
|
45
|
-
"content": {
|
|
46
|
-
"application/json": {
|
|
47
|
-
"schema": {
|
|
48
|
-
"$ref": "#/components/schemas/error-service-unavailable"
|
|
49
|
-
}
|
|
50
|
-
}
|
|
51
|
-
},
|
|
52
|
-
"description": "503 Service Unavailable."
|
|
53
|
-
},
|
|
54
|
-
"too-many-requests": {
|
|
55
|
-
"content": {
|
|
56
|
-
"application/json": {
|
|
57
|
-
"schema": {
|
|
58
|
-
"$ref": "#/components/schemas/error-too-many-requests"
|
|
59
|
-
}
|
|
60
|
-
}
|
|
61
|
-
},
|
|
62
|
-
"description": "429 Too Many Requests.",
|
|
63
|
-
"headers": {
|
|
64
|
-
"Retry-After": {
|
|
65
|
-
"schema": {
|
|
66
|
-
"description": "Number of seconds to wait before retrying.",
|
|
67
|
-
"type": "number"
|
|
68
|
-
}
|
|
69
|
-
}
|
|
70
|
-
}
|
|
71
|
-
},
|
|
72
|
-
"unauthorized": {
|
|
73
|
-
"content": {
|
|
74
|
-
"application/json": {
|
|
75
|
-
"schema": {
|
|
76
|
-
"$ref": "#/components/schemas/error-unauthorized"
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
},
|
|
80
|
-
"description": "401 Unauthorized."
|
|
81
|
-
}
|
|
82
|
-
},
|
|
83
|
-
"schemas": {
|
|
84
|
-
"artifact-summary": {
|
|
85
|
-
"allOf": [
|
|
86
|
-
{
|
|
87
|
-
"$ref": "#/components/schemas/atom-base-summary"
|
|
88
|
-
}
|
|
89
|
-
],
|
|
90
|
-
"title": "artifact-summary"
|
|
91
|
-
},
|
|
92
|
-
"atom-base": {
|
|
93
|
-
"properties": {
|
|
94
|
-
"created_by": {
|
|
95
|
-
"$ref": "#/components/schemas/user-summary"
|
|
96
|
-
},
|
|
97
|
-
"created_date": {
|
|
98
|
-
"description": "Timestamp when the object was created.",
|
|
99
|
-
"format": "date-time",
|
|
100
|
-
"type": "string"
|
|
101
|
-
},
|
|
102
|
-
"display_id": {
|
|
103
|
-
"description": "Human-readable object ID unique to the Dev organization.",
|
|
104
|
-
"type": "string"
|
|
105
|
-
},
|
|
106
|
-
"id": {
|
|
107
|
-
"description": "Globally unique object ID.",
|
|
108
|
-
"type": "string"
|
|
109
|
-
},
|
|
110
|
-
"modified_by": {
|
|
111
|
-
"$ref": "#/components/schemas/user-summary"
|
|
112
|
-
},
|
|
113
|
-
"modified_date": {
|
|
114
|
-
"description": "Timestamp when the object was last modified.",
|
|
115
|
-
"format": "date-time",
|
|
116
|
-
"type": "string"
|
|
117
|
-
}
|
|
118
|
-
},
|
|
119
|
-
"required": [
|
|
120
|
-
"id"
|
|
121
|
-
],
|
|
122
|
-
"title": "atom-base",
|
|
123
|
-
"type": "object"
|
|
124
|
-
},
|
|
125
|
-
"atom-base-summary": {
|
|
126
|
-
"properties": {
|
|
127
|
-
"display_id": {
|
|
128
|
-
"description": "Human-readable object ID unique to the Dev organization.",
|
|
129
|
-
"type": "string"
|
|
130
|
-
},
|
|
131
|
-
"id": {
|
|
132
|
-
"description": "Globally unique object ID.",
|
|
133
|
-
"type": "string"
|
|
134
|
-
}
|
|
135
|
-
},
|
|
136
|
-
"required": [
|
|
137
|
-
"id"
|
|
138
|
-
],
|
|
139
|
-
"title": "atom-base-summary",
|
|
140
|
-
"type": "object"
|
|
141
|
-
},
|
|
142
|
-
"capability-summary": {
|
|
143
|
-
"allOf": [
|
|
144
|
-
{
|
|
145
|
-
"$ref": "#/components/schemas/part-base-summary"
|
|
146
|
-
}
|
|
147
|
-
],
|
|
148
|
-
"title": "capability-summary"
|
|
149
|
-
},
|
|
150
|
-
"conversation": {
|
|
151
|
-
"allOf": [
|
|
152
|
-
{
|
|
153
|
-
"$ref": "#/components/schemas/atom-base"
|
|
154
|
-
},
|
|
155
|
-
{
|
|
156
|
-
"properties": {
|
|
157
|
-
"description": {
|
|
158
|
-
"description": "Description of the conversation object.",
|
|
159
|
-
"type": "string"
|
|
160
|
-
},
|
|
161
|
-
"group": {
|
|
162
|
-
"$ref": "#/components/schemas/group-summary"
|
|
163
|
-
},
|
|
164
|
-
"messages": {
|
|
165
|
-
"description": "The latest messages on the conversation.",
|
|
166
|
-
"items": {
|
|
167
|
-
"$ref": "#/components/schemas/timeline-entry"
|
|
168
|
-
},
|
|
169
|
-
"type": "array"
|
|
170
|
-
},
|
|
171
|
-
"owned_by": {
|
|
172
|
-
"description": "Owner IDs for the conversation.",
|
|
173
|
-
"items": {
|
|
174
|
-
"$ref": "#/components/schemas/user-summary"
|
|
175
|
-
},
|
|
176
|
-
"type": "array"
|
|
177
|
-
},
|
|
178
|
-
"stage": {
|
|
179
|
-
"$ref": "#/components/schemas/stage"
|
|
180
|
-
},
|
|
181
|
-
"title": {
|
|
182
|
-
"description": "Title of the conversation object.",
|
|
183
|
-
"type": "string"
|
|
184
|
-
}
|
|
185
|
-
},
|
|
186
|
-
"type": "object"
|
|
187
|
-
}
|
|
188
|
-
],
|
|
189
|
-
"title": "conversation"
|
|
190
|
-
},
|
|
191
|
-
"conversation-summary": {
|
|
192
|
-
"allOf": [
|
|
193
|
-
{
|
|
194
|
-
"$ref": "#/components/schemas/atom-base-summary"
|
|
195
|
-
},
|
|
196
|
-
{
|
|
197
|
-
"properties": {
|
|
198
|
-
"title": {
|
|
199
|
-
"description": "Title of the conversation object.",
|
|
200
|
-
"type": "string"
|
|
201
|
-
}
|
|
202
|
-
},
|
|
203
|
-
"type": "object"
|
|
204
|
-
}
|
|
205
|
-
],
|
|
206
|
-
"title": "conversation-summary"
|
|
207
|
-
},
|
|
208
|
-
"conversations-create-request": {
|
|
209
|
-
"description": "The request to create a new conversation.",
|
|
210
|
-
"properties": {
|
|
211
|
-
"description": {
|
|
212
|
-
"description": "Description for the conversation.",
|
|
213
|
-
"type": "string"
|
|
214
|
-
},
|
|
215
|
-
"group": {
|
|
216
|
-
"description": "The group that the conversation is associated with.",
|
|
217
|
-
"type": "string"
|
|
218
|
-
},
|
|
219
|
-
"members": {
|
|
220
|
-
"description": "The users in the conversation.",
|
|
221
|
-
"example": [
|
|
222
|
-
"don:<partition>:identity:devo/<dev-org-id>:devu/<dev-user-id>"
|
|
223
|
-
],
|
|
224
|
-
"items": {
|
|
225
|
-
"type": "string"
|
|
226
|
-
},
|
|
227
|
-
"type": "array"
|
|
228
|
-
},
|
|
229
|
-
"messages": {
|
|
230
|
-
"description": "Initial messages on the conversation.",
|
|
231
|
-
"items": {
|
|
232
|
-
"$ref": "#/components/schemas/conversations-create-request-message"
|
|
233
|
-
},
|
|
234
|
-
"type": "array"
|
|
235
|
-
},
|
|
236
|
-
"stage": {
|
|
237
|
-
"$ref": "#/components/schemas/stage-init"
|
|
238
|
-
},
|
|
239
|
-
"tags": {
|
|
240
|
-
"description": "Tags associated with the conversation.",
|
|
241
|
-
"items": {
|
|
242
|
-
"$ref": "#/components/schemas/set-tag-with-value"
|
|
243
|
-
},
|
|
244
|
-
"type": "array"
|
|
245
|
-
},
|
|
246
|
-
"title": {
|
|
247
|
-
"description": "The title for the conversation.",
|
|
248
|
-
"type": "string"
|
|
249
|
-
},
|
|
250
|
-
"type": {
|
|
251
|
-
"$ref": "#/components/schemas/conversations-create-request-type-value"
|
|
252
|
-
}
|
|
253
|
-
},
|
|
254
|
-
"required": [
|
|
255
|
-
"type"
|
|
256
|
-
],
|
|
257
|
-
"title": "conversations-create-request",
|
|
258
|
-
"type": "object"
|
|
259
|
-
},
|
|
260
|
-
"conversations-create-request-message": {
|
|
261
|
-
"properties": {
|
|
262
|
-
"artifacts": {
|
|
263
|
-
"description": "The IDs of the artifacts to the message.",
|
|
264
|
-
"example": [
|
|
265
|
-
"don:<partition>:core:devo/<dev-org-id>:artifact/<artifact-id>"
|
|
266
|
-
],
|
|
267
|
-
"items": {
|
|
268
|
-
"type": "string"
|
|
269
|
-
},
|
|
270
|
-
"type": "array"
|
|
271
|
-
},
|
|
272
|
-
"body": {
|
|
273
|
-
"description": "The message's body.",
|
|
274
|
-
"type": "string"
|
|
275
|
-
}
|
|
276
|
-
},
|
|
277
|
-
"title": "conversations-create-request-message",
|
|
278
|
-
"type": "object"
|
|
279
|
-
},
|
|
280
|
-
"conversations-create-request-type-value": {
|
|
281
|
-
"enum": [
|
|
282
|
-
"support"
|
|
283
|
-
],
|
|
284
|
-
"type": "string"
|
|
285
|
-
},
|
|
286
|
-
"conversations-create-response": {
|
|
287
|
-
"description": "The response to creating a new conversation.",
|
|
288
|
-
"properties": {
|
|
289
|
-
"conversation": {
|
|
290
|
-
"$ref": "#/components/schemas/conversation"
|
|
291
|
-
}
|
|
292
|
-
},
|
|
293
|
-
"required": [
|
|
294
|
-
"conversation"
|
|
295
|
-
],
|
|
296
|
-
"title": "conversations-create-response",
|
|
297
|
-
"type": "object",
|
|
298
|
-
"x-go-name": "ConversationsCreateResponseBody"
|
|
299
|
-
},
|
|
300
|
-
"conversations-delete-request": {
|
|
301
|
-
"description": "The request to delete a conversation.",
|
|
302
|
-
"properties": {
|
|
303
|
-
"id": {
|
|
304
|
-
"description": "The ID of the conversation to delete.",
|
|
305
|
-
"type": "string"
|
|
306
|
-
}
|
|
307
|
-
},
|
|
308
|
-
"required": [
|
|
309
|
-
"id"
|
|
310
|
-
],
|
|
311
|
-
"title": "conversations-delete-request",
|
|
312
|
-
"type": "object"
|
|
313
|
-
},
|
|
314
|
-
"conversations-delete-response": {
|
|
315
|
-
"description": "The response for deleting a conversation.",
|
|
316
|
-
"title": "conversations-delete-response",
|
|
317
|
-
"type": "object",
|
|
318
|
-
"x-go-name": "ConversationsDeleteResponseBody"
|
|
319
|
-
},
|
|
320
|
-
"conversations-export-response": {
|
|
321
|
-
"properties": {
|
|
322
|
-
"conversations": {
|
|
323
|
-
"description": "The resulting collection of conversation items.",
|
|
324
|
-
"items": {
|
|
325
|
-
"$ref": "#/components/schemas/conversation"
|
|
326
|
-
},
|
|
327
|
-
"type": "array"
|
|
328
|
-
}
|
|
329
|
-
},
|
|
330
|
-
"required": [
|
|
331
|
-
"conversations"
|
|
332
|
-
],
|
|
333
|
-
"title": "conversations-export-response",
|
|
334
|
-
"type": "object",
|
|
335
|
-
"x-go-name": "ConversationsExportResponseBody"
|
|
336
|
-
},
|
|
337
|
-
"conversations-get-response": {
|
|
338
|
-
"description": "The response to getting a conversation's information.",
|
|
339
|
-
"properties": {
|
|
340
|
-
"conversation": {
|
|
341
|
-
"$ref": "#/components/schemas/conversation"
|
|
342
|
-
}
|
|
343
|
-
},
|
|
344
|
-
"required": [
|
|
345
|
-
"conversation"
|
|
346
|
-
],
|
|
347
|
-
"title": "conversations-get-response",
|
|
348
|
-
"type": "object",
|
|
349
|
-
"x-go-name": "ConversationsGetResponseBody"
|
|
350
|
-
},
|
|
351
|
-
"conversations-list-response": {
|
|
352
|
-
"description": "The response to listing the conversations.",
|
|
353
|
-
"properties": {
|
|
354
|
-
"conversations": {
|
|
355
|
-
"description": "The list of conversations.",
|
|
356
|
-
"items": {
|
|
357
|
-
"$ref": "#/components/schemas/conversation"
|
|
358
|
-
},
|
|
359
|
-
"type": "array"
|
|
360
|
-
},
|
|
361
|
-
"next_cursor": {
|
|
362
|
-
"description": "The cursor used to iterate subsequent results in accordance to the\nsort order. If not set, then no later elements exist.\n",
|
|
363
|
-
"type": "string"
|
|
364
|
-
},
|
|
365
|
-
"prev_cursor": {
|
|
366
|
-
"description": "The cursor used to iterate preceding results in accordance to the\nsort order. If not set, then no prior elements exist.\n",
|
|
367
|
-
"type": "string"
|
|
368
|
-
}
|
|
369
|
-
},
|
|
370
|
-
"required": [
|
|
371
|
-
"conversations"
|
|
372
|
-
],
|
|
373
|
-
"title": "conversations-list-response",
|
|
374
|
-
"type": "object",
|
|
375
|
-
"x-go-name": "ConversationsListResponseBody"
|
|
376
|
-
},
|
|
377
|
-
"conversations-update-request": {
|
|
378
|
-
"description": "The request to update a conversation.",
|
|
379
|
-
"properties": {
|
|
380
|
-
"applies_to_parts": {
|
|
381
|
-
"$ref": "#/components/schemas/conversations-update-request-applies-to-parts"
|
|
382
|
-
},
|
|
383
|
-
"description": {
|
|
384
|
-
"description": "The updated description for the conversation.",
|
|
385
|
-
"type": "string"
|
|
386
|
-
},
|
|
387
|
-
"group": {
|
|
388
|
-
"description": "The group that the conversation is associated with.",
|
|
389
|
-
"type": "string"
|
|
390
|
-
},
|
|
391
|
-
"id": {
|
|
392
|
-
"description": "The ID of the conversation to update.",
|
|
393
|
-
"type": "string"
|
|
394
|
-
},
|
|
395
|
-
"stage": {
|
|
396
|
-
"$ref": "#/components/schemas/stage-update"
|
|
397
|
-
},
|
|
398
|
-
"status": {
|
|
399
|
-
"description": "The updated status of the conversation.",
|
|
400
|
-
"type": "string"
|
|
401
|
-
},
|
|
402
|
-
"title": {
|
|
403
|
-
"description": "The updated title of the conversation.",
|
|
404
|
-
"type": "string"
|
|
405
|
-
}
|
|
406
|
-
},
|
|
407
|
-
"required": [
|
|
408
|
-
"id"
|
|
409
|
-
],
|
|
410
|
-
"title": "conversations-update-request",
|
|
411
|
-
"type": "object"
|
|
412
|
-
},
|
|
413
|
-
"conversations-update-request-applies-to-parts": {
|
|
414
|
-
"properties": {
|
|
415
|
-
"set": {
|
|
416
|
-
"description": "Updates the parts that the conversation applies to.",
|
|
417
|
-
"example": [
|
|
418
|
-
"don:<partition>:core:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
419
|
-
],
|
|
420
|
-
"items": {
|
|
421
|
-
"type": "string"
|
|
422
|
-
},
|
|
423
|
-
"type": "array"
|
|
424
|
-
}
|
|
425
|
-
},
|
|
426
|
-
"title": "conversations-update-request-applies-to-parts",
|
|
427
|
-
"type": "object"
|
|
428
|
-
},
|
|
429
|
-
"conversations-update-response": {
|
|
430
|
-
"description": "The response for updating a conversation.",
|
|
431
|
-
"properties": {
|
|
432
|
-
"conversation": {
|
|
433
|
-
"$ref": "#/components/schemas/conversation"
|
|
434
|
-
}
|
|
435
|
-
},
|
|
436
|
-
"required": [
|
|
437
|
-
"conversation"
|
|
438
|
-
],
|
|
439
|
-
"title": "conversations-update-response",
|
|
440
|
-
"type": "object",
|
|
441
|
-
"x-go-name": "ConversationsUpdateResponseBody"
|
|
442
|
-
},
|
|
443
|
-
"dev-user-summary": {
|
|
444
|
-
"allOf": [
|
|
445
|
-
{
|
|
446
|
-
"$ref": "#/components/schemas/user-base-summary"
|
|
447
|
-
}
|
|
448
|
-
],
|
|
449
|
-
"title": "dev-user-summary"
|
|
450
|
-
},
|
|
451
|
-
"enhancement-summary": {
|
|
452
|
-
"allOf": [
|
|
453
|
-
{
|
|
454
|
-
"$ref": "#/components/schemas/part-base-summary"
|
|
455
|
-
}
|
|
456
|
-
],
|
|
457
|
-
"title": "enhancement-summary"
|
|
458
|
-
},
|
|
459
|
-
"error-bad-request": {
|
|
460
|
-
"allOf": [
|
|
461
|
-
{
|
|
462
|
-
"$ref": "#/components/schemas/error-base"
|
|
463
|
-
},
|
|
464
|
-
{
|
|
465
|
-
"discriminator": {
|
|
466
|
-
"mapping": {
|
|
467
|
-
"bad_request": "#/components/schemas/error-bad-request-bad-request",
|
|
468
|
-
"invalid_enum_value": "#/components/schemas/error-bad-request-invalid-enum-value",
|
|
469
|
-
"missing_required_field": "#/components/schemas/error-bad-request-missing-required-field",
|
|
470
|
-
"parse_error": "#/components/schemas/error-bad-request-parse-error",
|
|
471
|
-
"value_not_permitted": "#/components/schemas/error-bad-request-value-not-permitted"
|
|
472
|
-
},
|
|
473
|
-
"propertyName": "type"
|
|
474
|
-
},
|
|
475
|
-
"oneOf": [
|
|
476
|
-
{
|
|
477
|
-
"$ref": "#/components/schemas/error-bad-request-bad-request"
|
|
478
|
-
},
|
|
479
|
-
{
|
|
480
|
-
"$ref": "#/components/schemas/error-bad-request-invalid-enum-value"
|
|
481
|
-
},
|
|
482
|
-
{
|
|
483
|
-
"$ref": "#/components/schemas/error-bad-request-missing-required-field"
|
|
484
|
-
},
|
|
485
|
-
{
|
|
486
|
-
"$ref": "#/components/schemas/error-bad-request-parse-error"
|
|
487
|
-
},
|
|
488
|
-
{
|
|
489
|
-
"$ref": "#/components/schemas/error-bad-request-value-not-permitted"
|
|
490
|
-
}
|
|
491
|
-
],
|
|
492
|
-
"properties": {
|
|
493
|
-
"type": {
|
|
494
|
-
"$ref": "#/components/schemas/error-bad-request-type"
|
|
495
|
-
}
|
|
496
|
-
},
|
|
497
|
-
"required": [
|
|
498
|
-
"type"
|
|
499
|
-
],
|
|
500
|
-
"type": "object"
|
|
501
|
-
}
|
|
502
|
-
],
|
|
503
|
-
"title": "error-bad-request"
|
|
504
|
-
},
|
|
505
|
-
"error-bad-request-bad-request": {
|
|
506
|
-
"title": "error-bad-request-bad-request",
|
|
507
|
-
"type": "object"
|
|
508
|
-
},
|
|
509
|
-
"error-bad-request-invalid-enum-value": {
|
|
510
|
-
"properties": {
|
|
511
|
-
"allowed_values": {
|
|
512
|
-
"description": "The allowed values for the field.",
|
|
513
|
-
"items": {
|
|
514
|
-
"type": "string"
|
|
515
|
-
},
|
|
516
|
-
"type": "array"
|
|
517
|
-
},
|
|
518
|
-
"field_name": {
|
|
519
|
-
"description": "The field whose enum value is invalid.",
|
|
520
|
-
"type": "string"
|
|
521
|
-
},
|
|
522
|
-
"value": {
|
|
523
|
-
"description": "The value that was received.",
|
|
524
|
-
"type": "string"
|
|
525
|
-
}
|
|
526
|
-
},
|
|
527
|
-
"required": [
|
|
528
|
-
"allowed_values",
|
|
529
|
-
"field_name",
|
|
530
|
-
"value"
|
|
531
|
-
],
|
|
532
|
-
"title": "error-bad-request-invalid-enum-value",
|
|
533
|
-
"type": "object"
|
|
534
|
-
},
|
|
535
|
-
"error-bad-request-missing-required-field": {
|
|
536
|
-
"properties": {
|
|
537
|
-
"field_name": {
|
|
538
|
-
"description": "The missing field's name.",
|
|
539
|
-
"type": "string"
|
|
540
|
-
}
|
|
541
|
-
},
|
|
542
|
-
"required": [
|
|
543
|
-
"field_name"
|
|
544
|
-
],
|
|
545
|
-
"title": "error-bad-request-missing-required-field",
|
|
546
|
-
"type": "object"
|
|
547
|
-
},
|
|
548
|
-
"error-bad-request-parse-error": {
|
|
549
|
-
"title": "error-bad-request-parse-error",
|
|
550
|
-
"type": "object"
|
|
551
|
-
},
|
|
552
|
-
"error-bad-request-type": {
|
|
553
|
-
"enum": [
|
|
554
|
-
"bad_request",
|
|
555
|
-
"invalid_enum_value",
|
|
556
|
-
"missing_required_field",
|
|
557
|
-
"parse_error",
|
|
558
|
-
"value_not_permitted"
|
|
559
|
-
],
|
|
560
|
-
"type": "string"
|
|
561
|
-
},
|
|
562
|
-
"error-bad-request-value-not-permitted": {
|
|
563
|
-
"properties": {
|
|
564
|
-
"field_name": {
|
|
565
|
-
"description": "The field whose value is not permitted.",
|
|
566
|
-
"type": "string"
|
|
567
|
-
},
|
|
568
|
-
"reason": {
|
|
569
|
-
"description": "The reason the value isn't permitted.",
|
|
570
|
-
"type": "string"
|
|
571
|
-
}
|
|
572
|
-
},
|
|
573
|
-
"required": [
|
|
574
|
-
"field_name"
|
|
575
|
-
],
|
|
576
|
-
"title": "error-bad-request-value-not-permitted",
|
|
577
|
-
"type": "object"
|
|
578
|
-
},
|
|
579
|
-
"error-base": {
|
|
580
|
-
"properties": {
|
|
581
|
-
"message": {
|
|
582
|
-
"description": "The message associated with the error.",
|
|
583
|
-
"type": "string"
|
|
584
|
-
}
|
|
585
|
-
},
|
|
586
|
-
"title": "error-base",
|
|
587
|
-
"type": "object"
|
|
588
|
-
},
|
|
589
|
-
"error-forbidden": {
|
|
590
|
-
"allOf": [
|
|
591
|
-
{
|
|
592
|
-
"$ref": "#/components/schemas/error-base"
|
|
593
|
-
},
|
|
594
|
-
{
|
|
595
|
-
"discriminator": {
|
|
596
|
-
"mapping": {
|
|
597
|
-
"forbidden": "#/components/schemas/error-forbidden-forbidden"
|
|
598
|
-
},
|
|
599
|
-
"propertyName": "type"
|
|
600
|
-
},
|
|
601
|
-
"oneOf": [
|
|
602
|
-
{
|
|
603
|
-
"$ref": "#/components/schemas/error-forbidden-forbidden"
|
|
604
|
-
}
|
|
605
|
-
],
|
|
606
|
-
"properties": {
|
|
607
|
-
"type": {
|
|
608
|
-
"$ref": "#/components/schemas/error-forbidden-type"
|
|
609
|
-
}
|
|
610
|
-
},
|
|
611
|
-
"required": [
|
|
612
|
-
"type"
|
|
613
|
-
],
|
|
614
|
-
"type": "object"
|
|
615
|
-
}
|
|
616
|
-
],
|
|
617
|
-
"title": "error-forbidden"
|
|
618
|
-
},
|
|
619
|
-
"error-forbidden-forbidden": {
|
|
620
|
-
"title": "error-forbidden-forbidden",
|
|
621
|
-
"type": "object"
|
|
622
|
-
},
|
|
623
|
-
"error-forbidden-type": {
|
|
624
|
-
"enum": [
|
|
625
|
-
"forbidden"
|
|
626
|
-
],
|
|
627
|
-
"type": "string"
|
|
628
|
-
},
|
|
629
|
-
"error-internal-server-error": {
|
|
630
|
-
"allOf": [
|
|
631
|
-
{
|
|
632
|
-
"$ref": "#/components/schemas/error-base"
|
|
633
|
-
},
|
|
634
|
-
{
|
|
635
|
-
"discriminator": {
|
|
636
|
-
"mapping": {
|
|
637
|
-
"internal_error": "#/components/schemas/error-internal-server-error-internal-error"
|
|
638
|
-
},
|
|
639
|
-
"propertyName": "type"
|
|
640
|
-
},
|
|
641
|
-
"oneOf": [
|
|
642
|
-
{
|
|
643
|
-
"$ref": "#/components/schemas/error-internal-server-error-internal-error"
|
|
644
|
-
}
|
|
645
|
-
],
|
|
646
|
-
"properties": {
|
|
647
|
-
"reference_id": {
|
|
648
|
-
"description": "A unique ID that's generated for the error that can be used for\ninquiry.\n",
|
|
649
|
-
"type": "string"
|
|
650
|
-
},
|
|
651
|
-
"type": {
|
|
652
|
-
"$ref": "#/components/schemas/error-internal-server-error-type"
|
|
653
|
-
}
|
|
654
|
-
},
|
|
655
|
-
"required": [
|
|
656
|
-
"type"
|
|
657
|
-
],
|
|
658
|
-
"type": "object"
|
|
659
|
-
}
|
|
660
|
-
],
|
|
661
|
-
"title": "error-internal-server-error"
|
|
662
|
-
},
|
|
663
|
-
"error-internal-server-error-internal-error": {
|
|
664
|
-
"title": "error-internal-server-error-internal-error",
|
|
665
|
-
"type": "object"
|
|
666
|
-
},
|
|
667
|
-
"error-internal-server-error-type": {
|
|
668
|
-
"enum": [
|
|
669
|
-
"internal_error"
|
|
670
|
-
],
|
|
671
|
-
"type": "string"
|
|
672
|
-
},
|
|
673
|
-
"error-not-found": {
|
|
674
|
-
"allOf": [
|
|
675
|
-
{
|
|
676
|
-
"$ref": "#/components/schemas/error-base"
|
|
677
|
-
},
|
|
678
|
-
{
|
|
679
|
-
"discriminator": {
|
|
680
|
-
"mapping": {
|
|
681
|
-
"not_found": "#/components/schemas/error-not-found-not-found"
|
|
682
|
-
},
|
|
683
|
-
"propertyName": "type"
|
|
684
|
-
},
|
|
685
|
-
"oneOf": [
|
|
686
|
-
{
|
|
687
|
-
"$ref": "#/components/schemas/error-not-found-not-found"
|
|
688
|
-
}
|
|
689
|
-
],
|
|
690
|
-
"properties": {
|
|
691
|
-
"type": {
|
|
692
|
-
"$ref": "#/components/schemas/error-not-found-type"
|
|
693
|
-
}
|
|
694
|
-
},
|
|
695
|
-
"required": [
|
|
696
|
-
"type"
|
|
697
|
-
],
|
|
698
|
-
"type": "object"
|
|
699
|
-
}
|
|
700
|
-
],
|
|
701
|
-
"title": "error-not-found"
|
|
702
|
-
},
|
|
703
|
-
"error-not-found-not-found": {
|
|
704
|
-
"title": "error-not-found-not-found",
|
|
705
|
-
"type": "object"
|
|
706
|
-
},
|
|
707
|
-
"error-not-found-type": {
|
|
708
|
-
"enum": [
|
|
709
|
-
"not_found"
|
|
710
|
-
],
|
|
711
|
-
"type": "string"
|
|
712
|
-
},
|
|
713
|
-
"error-service-unavailable": {
|
|
714
|
-
"allOf": [
|
|
715
|
-
{
|
|
716
|
-
"$ref": "#/components/schemas/error-base"
|
|
717
|
-
},
|
|
718
|
-
{
|
|
719
|
-
"discriminator": {
|
|
720
|
-
"mapping": {
|
|
721
|
-
"service_unavailable": "#/components/schemas/error-service-unavailable-service-unavailable"
|
|
722
|
-
},
|
|
723
|
-
"propertyName": "type"
|
|
724
|
-
},
|
|
725
|
-
"oneOf": [
|
|
726
|
-
{
|
|
727
|
-
"$ref": "#/components/schemas/error-service-unavailable-service-unavailable"
|
|
728
|
-
}
|
|
729
|
-
],
|
|
730
|
-
"properties": {
|
|
731
|
-
"type": {
|
|
732
|
-
"$ref": "#/components/schemas/error-service-unavailable-type"
|
|
733
|
-
}
|
|
734
|
-
},
|
|
735
|
-
"required": [
|
|
736
|
-
"type"
|
|
737
|
-
],
|
|
738
|
-
"type": "object"
|
|
739
|
-
}
|
|
740
|
-
],
|
|
741
|
-
"title": "error-service-unavailable"
|
|
742
|
-
},
|
|
743
|
-
"error-service-unavailable-service-unavailable": {
|
|
744
|
-
"title": "error-service-unavailable-service-unavailable",
|
|
745
|
-
"type": "object"
|
|
746
|
-
},
|
|
747
|
-
"error-service-unavailable-type": {
|
|
748
|
-
"enum": [
|
|
749
|
-
"service_unavailable"
|
|
750
|
-
],
|
|
751
|
-
"type": "string"
|
|
752
|
-
},
|
|
753
|
-
"error-too-many-requests": {
|
|
754
|
-
"allOf": [
|
|
755
|
-
{
|
|
756
|
-
"$ref": "#/components/schemas/error-base"
|
|
757
|
-
},
|
|
758
|
-
{
|
|
759
|
-
"discriminator": {
|
|
760
|
-
"mapping": {
|
|
761
|
-
"too_many_requests": "#/components/schemas/error-too-many-requests-too-many-requests"
|
|
762
|
-
},
|
|
763
|
-
"propertyName": "type"
|
|
764
|
-
},
|
|
765
|
-
"oneOf": [
|
|
766
|
-
{
|
|
767
|
-
"$ref": "#/components/schemas/error-too-many-requests-too-many-requests"
|
|
768
|
-
}
|
|
769
|
-
],
|
|
770
|
-
"properties": {
|
|
771
|
-
"retry_after": {
|
|
772
|
-
"description": "The number of seconds after which the client should retry.\n",
|
|
773
|
-
"format": "int64",
|
|
774
|
-
"type": "integer"
|
|
775
|
-
},
|
|
776
|
-
"type": {
|
|
777
|
-
"$ref": "#/components/schemas/error-too-many-requests-type"
|
|
778
|
-
}
|
|
779
|
-
},
|
|
780
|
-
"required": [
|
|
781
|
-
"type"
|
|
782
|
-
],
|
|
783
|
-
"type": "object"
|
|
784
|
-
}
|
|
785
|
-
],
|
|
786
|
-
"title": "error-too-many-requests"
|
|
787
|
-
},
|
|
788
|
-
"error-too-many-requests-too-many-requests": {
|
|
789
|
-
"title": "error-too-many-requests-too-many-requests",
|
|
790
|
-
"type": "object"
|
|
791
|
-
},
|
|
792
|
-
"error-too-many-requests-type": {
|
|
793
|
-
"enum": [
|
|
794
|
-
"too_many_requests"
|
|
795
|
-
],
|
|
796
|
-
"type": "string"
|
|
797
|
-
},
|
|
798
|
-
"error-unauthorized": {
|
|
799
|
-
"allOf": [
|
|
800
|
-
{
|
|
801
|
-
"$ref": "#/components/schemas/error-base"
|
|
802
|
-
},
|
|
803
|
-
{
|
|
804
|
-
"discriminator": {
|
|
805
|
-
"mapping": {
|
|
806
|
-
"unauthenticated": "#/components/schemas/error-unauthorized-unauthenticated"
|
|
807
|
-
},
|
|
808
|
-
"propertyName": "type"
|
|
809
|
-
},
|
|
810
|
-
"oneOf": [
|
|
811
|
-
{
|
|
812
|
-
"$ref": "#/components/schemas/error-unauthorized-unauthenticated"
|
|
813
|
-
}
|
|
814
|
-
],
|
|
815
|
-
"properties": {
|
|
816
|
-
"type": {
|
|
817
|
-
"$ref": "#/components/schemas/error-unauthorized-type"
|
|
818
|
-
}
|
|
819
|
-
},
|
|
820
|
-
"required": [
|
|
821
|
-
"type"
|
|
822
|
-
],
|
|
823
|
-
"type": "object"
|
|
824
|
-
}
|
|
825
|
-
],
|
|
826
|
-
"title": "error-unauthorized"
|
|
827
|
-
},
|
|
828
|
-
"error-unauthorized-type": {
|
|
829
|
-
"enum": [
|
|
830
|
-
"unauthenticated"
|
|
831
|
-
],
|
|
832
|
-
"type": "string"
|
|
833
|
-
},
|
|
834
|
-
"error-unauthorized-unauthenticated": {
|
|
835
|
-
"title": "error-unauthorized-unauthenticated",
|
|
836
|
-
"type": "object"
|
|
837
|
-
},
|
|
838
|
-
"feature-summary": {
|
|
839
|
-
"allOf": [
|
|
840
|
-
{
|
|
841
|
-
"$ref": "#/components/schemas/part-base-summary"
|
|
842
|
-
}
|
|
843
|
-
],
|
|
844
|
-
"title": "feature-summary"
|
|
845
|
-
},
|
|
846
|
-
"group-summary": {
|
|
847
|
-
"allOf": [
|
|
848
|
-
{
|
|
849
|
-
"$ref": "#/components/schemas/atom-base-summary"
|
|
850
|
-
}
|
|
851
|
-
],
|
|
852
|
-
"title": "group-summary"
|
|
853
|
-
},
|
|
854
|
-
"issue-priority": {
|
|
855
|
-
"description": "Priority of the work based upon impact and criticality.",
|
|
856
|
-
"enum": [
|
|
857
|
-
"p0",
|
|
858
|
-
"p1",
|
|
859
|
-
"p2",
|
|
860
|
-
"p3"
|
|
861
|
-
],
|
|
862
|
-
"type": "string"
|
|
863
|
-
},
|
|
864
|
-
"issue-summary": {
|
|
865
|
-
"allOf": [
|
|
866
|
-
{
|
|
867
|
-
"$ref": "#/components/schemas/work-base-summary"
|
|
868
|
-
},
|
|
869
|
-
{
|
|
870
|
-
"properties": {
|
|
871
|
-
"priority": {
|
|
872
|
-
"$ref": "#/components/schemas/issue-priority"
|
|
873
|
-
}
|
|
874
|
-
},
|
|
875
|
-
"type": "object"
|
|
876
|
-
}
|
|
877
|
-
],
|
|
878
|
-
"title": "issue-summary"
|
|
879
|
-
},
|
|
880
|
-
"link": {
|
|
881
|
-
"allOf": [
|
|
882
|
-
{
|
|
883
|
-
"$ref": "#/components/schemas/atom-base"
|
|
884
|
-
},
|
|
885
|
-
{
|
|
886
|
-
"properties": {
|
|
887
|
-
"link_type": {
|
|
888
|
-
"$ref": "#/components/schemas/link-type"
|
|
889
|
-
},
|
|
890
|
-
"source": {
|
|
891
|
-
"$ref": "#/components/schemas/link-endpoint-summary"
|
|
892
|
-
},
|
|
893
|
-
"target": {
|
|
894
|
-
"$ref": "#/components/schemas/link-endpoint-summary"
|
|
895
|
-
}
|
|
896
|
-
},
|
|
897
|
-
"required": [
|
|
898
|
-
"link_type",
|
|
899
|
-
"source",
|
|
900
|
-
"target"
|
|
901
|
-
],
|
|
902
|
-
"type": "object"
|
|
903
|
-
}
|
|
904
|
-
],
|
|
905
|
-
"title": "link"
|
|
906
|
-
},
|
|
907
|
-
"link-endpoint-summary": {
|
|
908
|
-
"discriminator": {
|
|
909
|
-
"mapping": {
|
|
910
|
-
"capability": "#/components/schemas/capability-summary",
|
|
911
|
-
"conversation": "#/components/schemas/conversation-summary",
|
|
912
|
-
"enhancement": "#/components/schemas/enhancement-summary",
|
|
913
|
-
"feature": "#/components/schemas/feature-summary",
|
|
914
|
-
"issue": "#/components/schemas/issue-summary",
|
|
915
|
-
"product": "#/components/schemas/product-summary",
|
|
916
|
-
"ticket": "#/components/schemas/ticket-summary"
|
|
917
|
-
},
|
|
918
|
-
"propertyName": "type"
|
|
919
|
-
},
|
|
920
|
-
"oneOf": [
|
|
921
|
-
{
|
|
922
|
-
"$ref": "#/components/schemas/capability-summary"
|
|
923
|
-
},
|
|
924
|
-
{
|
|
925
|
-
"$ref": "#/components/schemas/conversation-summary"
|
|
926
|
-
},
|
|
927
|
-
{
|
|
928
|
-
"$ref": "#/components/schemas/enhancement-summary"
|
|
929
|
-
},
|
|
930
|
-
{
|
|
931
|
-
"$ref": "#/components/schemas/feature-summary"
|
|
932
|
-
},
|
|
933
|
-
{
|
|
934
|
-
"$ref": "#/components/schemas/issue-summary"
|
|
935
|
-
},
|
|
936
|
-
{
|
|
937
|
-
"$ref": "#/components/schemas/product-summary"
|
|
938
|
-
},
|
|
939
|
-
{
|
|
940
|
-
"$ref": "#/components/schemas/ticket-summary"
|
|
941
|
-
}
|
|
942
|
-
],
|
|
943
|
-
"properties": {
|
|
944
|
-
"type": {
|
|
945
|
-
"$ref": "#/components/schemas/link-endpoint-type"
|
|
946
|
-
}
|
|
947
|
-
},
|
|
948
|
-
"required": [
|
|
949
|
-
"type"
|
|
950
|
-
],
|
|
951
|
-
"title": "link-endpoint-summary",
|
|
952
|
-
"type": "object"
|
|
953
|
-
},
|
|
954
|
-
"link-endpoint-type": {
|
|
955
|
-
"enum": [
|
|
956
|
-
"capability",
|
|
957
|
-
"conversation",
|
|
958
|
-
"enhancement",
|
|
959
|
-
"feature",
|
|
960
|
-
"issue",
|
|
961
|
-
"product",
|
|
962
|
-
"ticket"
|
|
963
|
-
],
|
|
964
|
-
"type": "string"
|
|
965
|
-
},
|
|
966
|
-
"link-rev-user-to-rev-org-request": {
|
|
967
|
-
"description": "A request to link a rev user to a rev org.",
|
|
968
|
-
"properties": {
|
|
969
|
-
"rev_org_don": {
|
|
970
|
-
"description": "The don of the rev org to link the rev user to.",
|
|
971
|
-
"example": "don:<partition>:identity:devo/<dev-org-id>:revo/<rev-org-id>",
|
|
972
|
-
"type": "string"
|
|
973
|
-
},
|
|
974
|
-
"user_don": {
|
|
975
|
-
"description": "The don of the rev user to link.",
|
|
976
|
-
"type": "string"
|
|
977
|
-
}
|
|
978
|
-
},
|
|
979
|
-
"required": [
|
|
980
|
-
"rev_org_don",
|
|
981
|
-
"user_don"
|
|
982
|
-
],
|
|
983
|
-
"title": "link-rev-user-to-rev-org-request",
|
|
984
|
-
"type": "object"
|
|
985
|
-
},
|
|
986
|
-
"link-rev-user-to-rev-org-response": {
|
|
987
|
-
"description": "The response to link a rev user to a rev org.",
|
|
988
|
-
"properties": {
|
|
989
|
-
"rev_user": {
|
|
990
|
-
"$ref": "#/components/schemas/rev-user"
|
|
991
|
-
}
|
|
992
|
-
},
|
|
993
|
-
"required": [
|
|
994
|
-
"rev_user"
|
|
995
|
-
],
|
|
996
|
-
"title": "link-rev-user-to-rev-org-response",
|
|
997
|
-
"type": "object",
|
|
998
|
-
"x-go-name": "LinkRevUserToRevOrgResponseBody"
|
|
999
|
-
},
|
|
1000
|
-
"link-type": {
|
|
1001
|
-
"description": "Type of link used to define the relationship.",
|
|
1002
|
-
"enum": [
|
|
1003
|
-
"developed_with",
|
|
1004
|
-
"imports",
|
|
1005
|
-
"is_dependent_on",
|
|
1006
|
-
"is_duplicate_of",
|
|
1007
|
-
"is_parent_of",
|
|
1008
|
-
"is_part_of",
|
|
1009
|
-
"is_related_to",
|
|
1010
|
-
"serves"
|
|
1011
|
-
],
|
|
1012
|
-
"type": "string"
|
|
1013
|
-
},
|
|
1014
|
-
"links-create-request": {
|
|
1015
|
-
"description": "The request to create a new link.",
|
|
1016
|
-
"properties": {
|
|
1017
|
-
"link_type": {
|
|
1018
|
-
"$ref": "#/components/schemas/link-type"
|
|
1019
|
-
},
|
|
1020
|
-
"source": {
|
|
1021
|
-
"description": "The ID of the source object.",
|
|
1022
|
-
"type": "string"
|
|
1023
|
-
},
|
|
1024
|
-
"target": {
|
|
1025
|
-
"description": "The ID of the target object.",
|
|
1026
|
-
"type": "string"
|
|
1027
|
-
}
|
|
1028
|
-
},
|
|
1029
|
-
"required": [
|
|
1030
|
-
"link_type",
|
|
1031
|
-
"source",
|
|
1032
|
-
"target"
|
|
1033
|
-
],
|
|
1034
|
-
"title": "links-create-request",
|
|
1035
|
-
"type": "object"
|
|
1036
|
-
},
|
|
1037
|
-
"links-create-response": {
|
|
1038
|
-
"description": "The response to creating a new link.",
|
|
1039
|
-
"properties": {
|
|
1040
|
-
"link": {
|
|
1041
|
-
"$ref": "#/components/schemas/link"
|
|
1042
|
-
}
|
|
1043
|
-
},
|
|
1044
|
-
"required": [
|
|
1045
|
-
"link"
|
|
1046
|
-
],
|
|
1047
|
-
"title": "links-create-response",
|
|
1048
|
-
"type": "object",
|
|
1049
|
-
"x-go-name": "LinksCreateResponseBody"
|
|
1050
|
-
},
|
|
1051
|
-
"links-delete-request": {
|
|
1052
|
-
"description": "The request to delete a link.",
|
|
1053
|
-
"properties": {
|
|
1054
|
-
"id": {
|
|
1055
|
-
"description": "The ID of the link to delete.",
|
|
1056
|
-
"type": "string"
|
|
1057
|
-
}
|
|
1058
|
-
},
|
|
1059
|
-
"required": [
|
|
1060
|
-
"id"
|
|
1061
|
-
],
|
|
1062
|
-
"title": "links-delete-request",
|
|
1063
|
-
"type": "object"
|
|
1064
|
-
},
|
|
1065
|
-
"links-delete-response": {
|
|
1066
|
-
"description": "The response for deleting a link.",
|
|
1067
|
-
"title": "links-delete-response",
|
|
1068
|
-
"type": "object",
|
|
1069
|
-
"x-go-name": "LinksDeleteResponseBody"
|
|
1070
|
-
},
|
|
1071
|
-
"links-direction": {
|
|
1072
|
-
"description": "The direction of link, which can either be outbound such that the\nobject is the source of the link, otherwise inbound where the object is\nthe target of the link.\n",
|
|
1073
|
-
"enum": [
|
|
1074
|
-
"is_source",
|
|
1075
|
-
"is_target"
|
|
1076
|
-
],
|
|
1077
|
-
"type": "string"
|
|
1078
|
-
},
|
|
1079
|
-
"links-get-response": {
|
|
1080
|
-
"description": "The response to getting a link's information.",
|
|
1081
|
-
"properties": {
|
|
1082
|
-
"link": {
|
|
1083
|
-
"$ref": "#/components/schemas/link"
|
|
1084
|
-
}
|
|
1085
|
-
},
|
|
1086
|
-
"required": [
|
|
1087
|
-
"link"
|
|
1088
|
-
],
|
|
1089
|
-
"title": "links-get-response",
|
|
1090
|
-
"type": "object",
|
|
1091
|
-
"x-go-name": "LinksGetResponseBody"
|
|
1092
|
-
},
|
|
1093
|
-
"links-list-response": {
|
|
1094
|
-
"description": "The response to listing the links.",
|
|
1095
|
-
"properties": {
|
|
1096
|
-
"links": {
|
|
1097
|
-
"description": "The list of links.",
|
|
1098
|
-
"items": {
|
|
1099
|
-
"$ref": "#/components/schemas/link"
|
|
1100
|
-
},
|
|
1101
|
-
"type": "array"
|
|
1102
|
-
},
|
|
1103
|
-
"next_cursor": {
|
|
1104
|
-
"description": "The cursor used to iterate subsequent results in accordance to the\nsort order. If not set, then no later elements exist.\n",
|
|
1105
|
-
"type": "string"
|
|
1106
|
-
},
|
|
1107
|
-
"prev_cursor": {
|
|
1108
|
-
"description": "The cursor used to iterate preceding results in accordance to the\nsort order. If not set, then no prior elements exist.\n",
|
|
1109
|
-
"type": "string"
|
|
1110
|
-
}
|
|
1111
|
-
},
|
|
1112
|
-
"required": [
|
|
1113
|
-
"links"
|
|
1114
|
-
],
|
|
1115
|
-
"title": "links-list-response",
|
|
1116
|
-
"type": "object",
|
|
1117
|
-
"x-go-name": "LinksListResponseBody"
|
|
1118
|
-
},
|
|
1119
|
-
"list-mode": {
|
|
1120
|
-
"description": "The iteration mode to use. If \"after\", then entries after the provided\ncursor will be returned, or if no cursor is provided, then from the\nbeginning. If \"before\", then entries before the provided cursor will be\nreturned, or if no cursor is provided, then from the end. Entries will\nalways be returned in the specified sort-by order.\n",
|
|
1121
|
-
"enum": [
|
|
1122
|
-
"after",
|
|
1123
|
-
"before"
|
|
1124
|
-
],
|
|
1125
|
-
"type": "string"
|
|
1126
|
-
},
|
|
1127
|
-
"org-base-summary": {
|
|
1128
|
-
"allOf": [
|
|
1129
|
-
{
|
|
1130
|
-
"$ref": "#/components/schemas/atom-base-summary"
|
|
1131
|
-
},
|
|
1132
|
-
{
|
|
1133
|
-
"properties": {
|
|
1134
|
-
"display_name": {
|
|
1135
|
-
"description": "Name of the Organization.",
|
|
1136
|
-
"type": "string"
|
|
1137
|
-
}
|
|
1138
|
-
},
|
|
1139
|
-
"type": "object"
|
|
1140
|
-
}
|
|
1141
|
-
],
|
|
1142
|
-
"title": "org-base-summary"
|
|
1143
|
-
},
|
|
1144
|
-
"org-summary": {
|
|
1145
|
-
"discriminator": {
|
|
1146
|
-
"mapping": {
|
|
1147
|
-
"rev_org": "#/components/schemas/rev-org-summary"
|
|
1148
|
-
},
|
|
1149
|
-
"propertyName": "type"
|
|
1150
|
-
},
|
|
1151
|
-
"oneOf": [
|
|
1152
|
-
{
|
|
1153
|
-
"$ref": "#/components/schemas/rev-org-summary"
|
|
1154
|
-
}
|
|
1155
|
-
],
|
|
1156
|
-
"properties": {
|
|
1157
|
-
"type": {
|
|
1158
|
-
"$ref": "#/components/schemas/org-type"
|
|
1159
|
-
}
|
|
1160
|
-
},
|
|
1161
|
-
"required": [
|
|
1162
|
-
"type"
|
|
1163
|
-
],
|
|
1164
|
-
"title": "org-summary",
|
|
1165
|
-
"type": "object"
|
|
1166
|
-
},
|
|
1167
|
-
"org-type": {
|
|
1168
|
-
"enum": [
|
|
1169
|
-
"rev_org"
|
|
1170
|
-
],
|
|
1171
|
-
"type": "string"
|
|
1172
|
-
},
|
|
1173
|
-
"part-base-summary": {
|
|
1174
|
-
"allOf": [
|
|
1175
|
-
{
|
|
1176
|
-
"$ref": "#/components/schemas/atom-base-summary"
|
|
1177
|
-
},
|
|
1178
|
-
{
|
|
1179
|
-
"properties": {
|
|
1180
|
-
"name": {
|
|
1181
|
-
"description": "Name of the part.",
|
|
1182
|
-
"type": "string"
|
|
1183
|
-
}
|
|
1184
|
-
},
|
|
1185
|
-
"required": [
|
|
1186
|
-
"name"
|
|
1187
|
-
],
|
|
1188
|
-
"type": "object"
|
|
1189
|
-
}
|
|
1190
|
-
],
|
|
1191
|
-
"title": "part-base-summary"
|
|
1192
|
-
},
|
|
1193
|
-
"product-summary": {
|
|
1194
|
-
"allOf": [
|
|
1195
|
-
{
|
|
1196
|
-
"$ref": "#/components/schemas/part-base-summary"
|
|
1197
|
-
}
|
|
1198
|
-
],
|
|
1199
|
-
"title": "product-summary"
|
|
1200
|
-
},
|
|
1201
|
-
"rev-org-summary": {
|
|
1202
|
-
"allOf": [
|
|
1203
|
-
{
|
|
1204
|
-
"$ref": "#/components/schemas/org-base-summary"
|
|
1205
|
-
}
|
|
1206
|
-
],
|
|
1207
|
-
"title": "rev-org-summary"
|
|
1208
|
-
},
|
|
1209
|
-
"rev-user": {
|
|
1210
|
-
"allOf": [
|
|
1211
|
-
{
|
|
1212
|
-
"$ref": "#/components/schemas/user-base"
|
|
1213
|
-
},
|
|
1214
|
-
{
|
|
1215
|
-
"properties": {
|
|
1216
|
-
"description": {
|
|
1217
|
-
"description": "Description of the Rev user.",
|
|
1218
|
-
"type": "string"
|
|
1219
|
-
},
|
|
1220
|
-
"external_ref": {
|
|
1221
|
-
"description": "External ref is a mutable unique identifier for a user within the\nRev organization from your primary customer record. If none is\navailable, a good alternative is the email address/phone number\nwhich could uniquely identify the user. If none is specified, a\nsystem-generated identifier will be assigned to the user.\n",
|
|
1222
|
-
"type": "string"
|
|
1223
|
-
},
|
|
1224
|
-
"rev_org": {
|
|
1225
|
-
"$ref": "#/components/schemas/org-summary"
|
|
1226
|
-
}
|
|
1227
|
-
},
|
|
1228
|
-
"type": "object"
|
|
1229
|
-
}
|
|
1230
|
-
],
|
|
1231
|
-
"title": "rev-user"
|
|
1232
|
-
},
|
|
1233
|
-
"rev-user-summary": {
|
|
1234
|
-
"allOf": [
|
|
1235
|
-
{
|
|
1236
|
-
"$ref": "#/components/schemas/user-base-summary"
|
|
1237
|
-
},
|
|
1238
|
-
{
|
|
1239
|
-
"properties": {
|
|
1240
|
-
"external_ref": {
|
|
1241
|
-
"description": "External ref is a mutable unique identifier for a user within the\nRev organization from your primary customer record. If none is\navailable, a good alternative is the email address/phone number\nwhich could uniquely identify the user. If none is specified, a\nsystem-generated identifier will be assigned to the user.\n",
|
|
1242
|
-
"type": "string"
|
|
1243
|
-
},
|
|
1244
|
-
"rev_org": {
|
|
1245
|
-
"$ref": "#/components/schemas/org-summary"
|
|
1246
|
-
}
|
|
1247
|
-
},
|
|
1248
|
-
"type": "object"
|
|
1249
|
-
}
|
|
1250
|
-
],
|
|
1251
|
-
"title": "rev-user-summary"
|
|
1252
|
-
},
|
|
1253
|
-
"rev-users-create-request": {
|
|
1254
|
-
"description": "Request object to create a new Rev user for a Rev organization.\n",
|
|
1255
|
-
"properties": {
|
|
1256
|
-
"description": {
|
|
1257
|
-
"description": "Description of the Rev user.",
|
|
1258
|
-
"type": "string"
|
|
1259
|
-
},
|
|
1260
|
-
"display_name": {
|
|
1261
|
-
"description": "The user's display name. The name is non-unique and mutable.\n",
|
|
1262
|
-
"type": "string"
|
|
1263
|
-
},
|
|
1264
|
-
"email": {
|
|
1265
|
-
"description": "Email address of the Rev user.",
|
|
1266
|
-
"type": "string"
|
|
1267
|
-
},
|
|
1268
|
-
"external_ref": {
|
|
1269
|
-
"description": "External ref is a mutable unique identifier for a user within the\nDev organization from your primary customer record. If none is\navailable, a good alternative is the email address/phone number\nwhich could uniquely identify the user. If none is specified, a\nsystem-generated identifier will be assigned to the user.\n",
|
|
1270
|
-
"type": "string"
|
|
1271
|
-
},
|
|
1272
|
-
"phone_numbers": {
|
|
1273
|
-
"description": "Phone numbers of the Rev user.",
|
|
1274
|
-
"items": {
|
|
1275
|
-
"type": "string"
|
|
1276
|
-
},
|
|
1277
|
-
"type": "array"
|
|
1278
|
-
},
|
|
1279
|
-
"rev_org": {
|
|
1280
|
-
"description": "The ID of Rev organization for which a Rev user is to be created.\n",
|
|
1281
|
-
"example": "don:<partition>:identity:devo/<dev-org-id>:revo/<rev-org-id>",
|
|
1282
|
-
"type": "string"
|
|
1283
|
-
}
|
|
1284
|
-
},
|
|
1285
|
-
"required": [
|
|
1286
|
-
"rev_org"
|
|
1287
|
-
],
|
|
1288
|
-
"title": "rev-users-create-request",
|
|
1289
|
-
"type": "object"
|
|
1290
|
-
},
|
|
1291
|
-
"rev-users-create-response": {
|
|
1292
|
-
"description": "Response object for creating a new Rev user for Rev organization.\n",
|
|
1293
|
-
"properties": {
|
|
1294
|
-
"rev_user": {
|
|
1295
|
-
"$ref": "#/components/schemas/rev-user"
|
|
1296
|
-
}
|
|
1297
|
-
},
|
|
1298
|
-
"required": [
|
|
1299
|
-
"rev_user"
|
|
1300
|
-
],
|
|
1301
|
-
"title": "rev-users-create-response",
|
|
1302
|
-
"type": "object",
|
|
1303
|
-
"x-go-name": "RevUsersCreateResponseBody"
|
|
1304
|
-
},
|
|
1305
|
-
"rev-users-delete-request": {
|
|
1306
|
-
"description": "Request object to delete a Rev user.",
|
|
1307
|
-
"properties": {
|
|
1308
|
-
"id": {
|
|
1309
|
-
"description": "The ID of Rev user to delete.",
|
|
1310
|
-
"type": "string"
|
|
1311
|
-
}
|
|
1312
|
-
},
|
|
1313
|
-
"required": [
|
|
1314
|
-
"id"
|
|
1315
|
-
],
|
|
1316
|
-
"title": "rev-users-delete-request",
|
|
1317
|
-
"type": "object"
|
|
1318
|
-
},
|
|
1319
|
-
"rev-users-delete-response": {
|
|
1320
|
-
"description": "The response to deleting a Rev user of a Rev organization.",
|
|
1321
|
-
"title": "rev-users-delete-response",
|
|
1322
|
-
"type": "object",
|
|
1323
|
-
"x-go-name": "RevUsersDeleteResponseBody"
|
|
1324
|
-
},
|
|
1325
|
-
"rev-users-get-response": {
|
|
1326
|
-
"description": "The returned Rev user.",
|
|
1327
|
-
"properties": {
|
|
1328
|
-
"rev_user": {
|
|
1329
|
-
"$ref": "#/components/schemas/rev-user"
|
|
1330
|
-
}
|
|
1331
|
-
},
|
|
1332
|
-
"required": [
|
|
1333
|
-
"rev_user"
|
|
1334
|
-
],
|
|
1335
|
-
"title": "rev-users-get-response",
|
|
1336
|
-
"type": "object",
|
|
1337
|
-
"x-go-name": "RevUsersGetResponseBody"
|
|
1338
|
-
},
|
|
1339
|
-
"rev-users-list-response": {
|
|
1340
|
-
"description": "The response to listing all Rev users matching the filter criteria.\n",
|
|
1341
|
-
"properties": {
|
|
1342
|
-
"next_cursor": {
|
|
1343
|
-
"description": "The cursor used to iterate subsequent results in accordance to the\nsort order. If not set, then no later elements exist.\n",
|
|
1344
|
-
"type": "string"
|
|
1345
|
-
},
|
|
1346
|
-
"prev_cursor": {
|
|
1347
|
-
"description": "The cursor used to iterate preceding results in accordance to the\nsort order. If not set, then no prior elements exist.\n",
|
|
1348
|
-
"type": "string"
|
|
1349
|
-
},
|
|
1350
|
-
"rev_users": {
|
|
1351
|
-
"description": "List containing all the Rev users.",
|
|
1352
|
-
"items": {
|
|
1353
|
-
"$ref": "#/components/schemas/rev-user"
|
|
1354
|
-
},
|
|
1355
|
-
"type": "array"
|
|
1356
|
-
}
|
|
1357
|
-
},
|
|
1358
|
-
"required": [
|
|
1359
|
-
"rev_users"
|
|
1360
|
-
],
|
|
1361
|
-
"title": "rev-users-list-response",
|
|
1362
|
-
"type": "object",
|
|
1363
|
-
"x-go-name": "RevUsersListResponseBody"
|
|
1364
|
-
},
|
|
1365
|
-
"rev-users-update-request": {
|
|
1366
|
-
"description": "Request to update details of a Rev user.",
|
|
1367
|
-
"properties": {
|
|
1368
|
-
"description": {
|
|
1369
|
-
"description": "Updated description of the Rev user.",
|
|
1370
|
-
"type": "string"
|
|
1371
|
-
},
|
|
1372
|
-
"display_name": {
|
|
1373
|
-
"description": "Updated display name of the Rev user.",
|
|
1374
|
-
"type": "string"
|
|
1375
|
-
},
|
|
1376
|
-
"email": {
|
|
1377
|
-
"description": "Updated email address of the Rev user.",
|
|
1378
|
-
"type": "string"
|
|
1379
|
-
},
|
|
1380
|
-
"external_ref": {
|
|
1381
|
-
"description": "Updated external ref value of the Rev user.",
|
|
1382
|
-
"type": "string"
|
|
1383
|
-
},
|
|
1384
|
-
"id": {
|
|
1385
|
-
"description": "The ID of Rev user to update.",
|
|
1386
|
-
"type": "string"
|
|
1387
|
-
}
|
|
1388
|
-
},
|
|
1389
|
-
"required": [
|
|
1390
|
-
"id"
|
|
1391
|
-
],
|
|
1392
|
-
"title": "rev-users-update-request",
|
|
1393
|
-
"type": "object"
|
|
1394
|
-
},
|
|
1395
|
-
"rev-users-update-response": {
|
|
1396
|
-
"description": "Updated Rev user object.",
|
|
1397
|
-
"properties": {
|
|
1398
|
-
"rev_user": {
|
|
1399
|
-
"$ref": "#/components/schemas/rev-user"
|
|
1400
|
-
}
|
|
1401
|
-
},
|
|
1402
|
-
"required": [
|
|
1403
|
-
"rev_user"
|
|
1404
|
-
],
|
|
1405
|
-
"title": "rev-users-update-response",
|
|
1406
|
-
"type": "object",
|
|
1407
|
-
"x-go-name": "RevUsersUpdateResponseBody"
|
|
1408
|
-
},
|
|
1409
|
-
"set-tag-with-value": {
|
|
1410
|
-
"properties": {
|
|
1411
|
-
"id": {
|
|
1412
|
-
"description": "The ID of the tag.",
|
|
1413
|
-
"example": "don:<partition>:core:devo/<dev-org-id>:tag/<tag-id>",
|
|
1414
|
-
"type": "string"
|
|
1415
|
-
},
|
|
1416
|
-
"value": {
|
|
1417
|
-
"description": "The value for the object's association with the tag. If specified,\nthe value must be one that's specified in the tag's allowed values.\n",
|
|
1418
|
-
"type": "string"
|
|
1419
|
-
}
|
|
1420
|
-
},
|
|
1421
|
-
"required": [
|
|
1422
|
-
"id"
|
|
1423
|
-
],
|
|
1424
|
-
"title": "set-tag-with-value",
|
|
1425
|
-
"type": "object"
|
|
1426
|
-
},
|
|
1427
|
-
"stage": {
|
|
1428
|
-
"description": "Describes the current stage of a work item.",
|
|
1429
|
-
"properties": {
|
|
1430
|
-
"name": {
|
|
1431
|
-
"description": "Current stage name of the work item.",
|
|
1432
|
-
"type": "string"
|
|
1433
|
-
}
|
|
1434
|
-
},
|
|
1435
|
-
"required": [
|
|
1436
|
-
"name"
|
|
1437
|
-
],
|
|
1438
|
-
"title": "stage",
|
|
1439
|
-
"type": "object"
|
|
1440
|
-
},
|
|
1441
|
-
"stage-init": {
|
|
1442
|
-
"description": "Sets an object's initial stage.",
|
|
1443
|
-
"properties": {
|
|
1444
|
-
"name": {
|
|
1445
|
-
"description": "The name of the stage.",
|
|
1446
|
-
"type": "string"
|
|
1447
|
-
}
|
|
1448
|
-
},
|
|
1449
|
-
"title": "stage-init",
|
|
1450
|
-
"type": "object"
|
|
1451
|
-
},
|
|
1452
|
-
"stage-update": {
|
|
1453
|
-
"description": "Updates an object's stage.",
|
|
1454
|
-
"properties": {
|
|
1455
|
-
"name": {
|
|
1456
|
-
"description": "The updated name of the stage, otherwise unchanged if not set.\n",
|
|
1457
|
-
"type": "string"
|
|
1458
|
-
}
|
|
1459
|
-
},
|
|
1460
|
-
"title": "stage-update",
|
|
1461
|
-
"type": "object"
|
|
1462
|
-
},
|
|
1463
|
-
"sys-user": {
|
|
1464
|
-
"allOf": [
|
|
1465
|
-
{
|
|
1466
|
-
"$ref": "#/components/schemas/user-base"
|
|
1467
|
-
}
|
|
1468
|
-
],
|
|
1469
|
-
"title": "sys-user"
|
|
1470
|
-
},
|
|
1471
|
-
"sys-user-summary": {
|
|
1472
|
-
"allOf": [
|
|
1473
|
-
{
|
|
1474
|
-
"$ref": "#/components/schemas/user-base-summary"
|
|
1475
|
-
}
|
|
1476
|
-
],
|
|
1477
|
-
"title": "sys-user-summary"
|
|
1478
|
-
},
|
|
1479
|
-
"sys-users-list-response": {
|
|
1480
|
-
"description": "The response to listing the system users.",
|
|
1481
|
-
"properties": {
|
|
1482
|
-
"next_cursor": {
|
|
1483
|
-
"description": "The cursor used to iterate subsequent results in accordance to the\nsort order. If not set, then no later elements exist.\n",
|
|
1484
|
-
"type": "string"
|
|
1485
|
-
},
|
|
1486
|
-
"prev_cursor": {
|
|
1487
|
-
"description": "The cursor used to iterate preceding results in accordance to the\nsort order. If not set, then no prior elements exist.\n",
|
|
1488
|
-
"type": "string"
|
|
1489
|
-
},
|
|
1490
|
-
"sys_users": {
|
|
1491
|
-
"description": "The list of system users.",
|
|
1492
|
-
"items": {
|
|
1493
|
-
"$ref": "#/components/schemas/sys-user"
|
|
1494
|
-
},
|
|
1495
|
-
"type": "array"
|
|
1496
|
-
}
|
|
1497
|
-
},
|
|
1498
|
-
"required": [
|
|
1499
|
-
"sys_users"
|
|
1500
|
-
],
|
|
1501
|
-
"title": "sys-users-list-response",
|
|
1502
|
-
"type": "object",
|
|
1503
|
-
"x-go-name": "SysUsersListResponseBody"
|
|
1504
|
-
},
|
|
1505
|
-
"sys-users-update-request": {
|
|
1506
|
-
"description": "Request to update information of the system user.",
|
|
1507
|
-
"properties": {
|
|
1508
|
-
"display_name": {
|
|
1509
|
-
"description": "Updated display name for the system user.",
|
|
1510
|
-
"type": "string"
|
|
1511
|
-
},
|
|
1512
|
-
"display_picture": {
|
|
1513
|
-
"description": "Artifact ID of the system user's new display picture.",
|
|
1514
|
-
"example": "don:<partition>:core:devo/<dev-org-id>:artifact/<artifact-id>",
|
|
1515
|
-
"nullable": true,
|
|
1516
|
-
"type": "string"
|
|
1517
|
-
},
|
|
1518
|
-
"full_name": {
|
|
1519
|
-
"description": "Updated full name for the system user.",
|
|
1520
|
-
"type": "string"
|
|
1521
|
-
},
|
|
1522
|
-
"id": {
|
|
1523
|
-
"description": "The ID of system user to update.",
|
|
1524
|
-
"type": "string"
|
|
1525
|
-
}
|
|
1526
|
-
},
|
|
1527
|
-
"required": [
|
|
1528
|
-
"id"
|
|
1529
|
-
],
|
|
1530
|
-
"title": "sys-users-update-request",
|
|
1531
|
-
"type": "object"
|
|
1532
|
-
},
|
|
1533
|
-
"sys-users-update-response": {
|
|
1534
|
-
"description": "Updated Sys user object.",
|
|
1535
|
-
"properties": {
|
|
1536
|
-
"sys_user": {
|
|
1537
|
-
"$ref": "#/components/schemas/sys-user"
|
|
1538
|
-
}
|
|
1539
|
-
},
|
|
1540
|
-
"required": [
|
|
1541
|
-
"sys_user"
|
|
1542
|
-
],
|
|
1543
|
-
"title": "sys-users-update-response",
|
|
1544
|
-
"type": "object",
|
|
1545
|
-
"x-go-name": "SysUsersUpdateResponseBody"
|
|
1546
|
-
},
|
|
1547
|
-
"ticket-severity": {
|
|
1548
|
-
"description": "Severity of the ticket.",
|
|
1549
|
-
"enum": [
|
|
1550
|
-
"blocker",
|
|
1551
|
-
"high",
|
|
1552
|
-
"low",
|
|
1553
|
-
"medium"
|
|
1554
|
-
],
|
|
1555
|
-
"type": "string"
|
|
1556
|
-
},
|
|
1557
|
-
"ticket-summary": {
|
|
1558
|
-
"allOf": [
|
|
1559
|
-
{
|
|
1560
|
-
"$ref": "#/components/schemas/work-base-summary"
|
|
1561
|
-
},
|
|
1562
|
-
{
|
|
1563
|
-
"properties": {
|
|
1564
|
-
"rev_org": {
|
|
1565
|
-
"$ref": "#/components/schemas/org-summary"
|
|
1566
|
-
},
|
|
1567
|
-
"severity": {
|
|
1568
|
-
"$ref": "#/components/schemas/ticket-severity"
|
|
1569
|
-
}
|
|
1570
|
-
},
|
|
1571
|
-
"type": "object"
|
|
1572
|
-
}
|
|
1573
|
-
],
|
|
1574
|
-
"title": "ticket-summary"
|
|
1575
|
-
},
|
|
1576
|
-
"timeline-comment": {
|
|
1577
|
-
"allOf": [
|
|
1578
|
-
{
|
|
1579
|
-
"$ref": "#/components/schemas/timeline-entry-base"
|
|
1580
|
-
},
|
|
1581
|
-
{
|
|
1582
|
-
"properties": {
|
|
1583
|
-
"artifacts": {
|
|
1584
|
-
"description": "The artifacts for the comment.",
|
|
1585
|
-
"items": {
|
|
1586
|
-
"$ref": "#/components/schemas/artifact-summary"
|
|
1587
|
-
},
|
|
1588
|
-
"type": "array"
|
|
1589
|
-
},
|
|
1590
|
-
"body": {
|
|
1591
|
-
"description": "The comment's body. If the comment has been deleted, then no body\nwill appear in the response.\n",
|
|
1592
|
-
"type": "string"
|
|
1593
|
-
},
|
|
1594
|
-
"body_type": {
|
|
1595
|
-
"$ref": "#/components/schemas/timeline-comment-body-type"
|
|
1596
|
-
},
|
|
1597
|
-
"snap_kit_body": {
|
|
1598
|
-
"description": "The SnapKit Body of the comment.",
|
|
1599
|
-
"type": "object"
|
|
1600
|
-
}
|
|
1601
|
-
},
|
|
1602
|
-
"type": "object"
|
|
1603
|
-
}
|
|
1604
|
-
],
|
|
1605
|
-
"title": "timeline-comment"
|
|
1606
|
-
},
|
|
1607
|
-
"timeline-comment-body-type": {
|
|
1608
|
-
"description": "The type of the body to use for the comment.",
|
|
1609
|
-
"enum": [
|
|
1610
|
-
"snap_kit",
|
|
1611
|
-
"text"
|
|
1612
|
-
],
|
|
1613
|
-
"type": "string"
|
|
1614
|
-
},
|
|
1615
|
-
"timeline-entry": {
|
|
1616
|
-
"discriminator": {
|
|
1617
|
-
"mapping": {
|
|
1618
|
-
"timeline_comment": "#/components/schemas/timeline-comment"
|
|
1619
|
-
},
|
|
1620
|
-
"propertyName": "type"
|
|
1621
|
-
},
|
|
1622
|
-
"oneOf": [
|
|
1623
|
-
{
|
|
1624
|
-
"$ref": "#/components/schemas/timeline-comment"
|
|
1625
|
-
}
|
|
1626
|
-
],
|
|
1627
|
-
"properties": {
|
|
1628
|
-
"type": {
|
|
1629
|
-
"$ref": "#/components/schemas/timeline-entry-type"
|
|
1630
|
-
}
|
|
1631
|
-
},
|
|
1632
|
-
"required": [
|
|
1633
|
-
"type"
|
|
1634
|
-
],
|
|
1635
|
-
"title": "timeline-entry",
|
|
1636
|
-
"type": "object"
|
|
1637
|
-
},
|
|
1638
|
-
"timeline-entry-base": {
|
|
1639
|
-
"allOf": [
|
|
1640
|
-
{
|
|
1641
|
-
"$ref": "#/components/schemas/atom-base"
|
|
1642
|
-
}
|
|
1643
|
-
],
|
|
1644
|
-
"title": "timeline-entry-base"
|
|
1645
|
-
},
|
|
1646
|
-
"timeline-entry-type": {
|
|
1647
|
-
"enum": [
|
|
1648
|
-
"timeline_comment"
|
|
1649
|
-
],
|
|
1650
|
-
"type": "string"
|
|
1651
|
-
},
|
|
1652
|
-
"unlink-rev-user-from-rev-org-request": {
|
|
1653
|
-
"description": "A request to unlink a rev user from a rev org.",
|
|
1654
|
-
"properties": {
|
|
1655
|
-
"rev_org_don": {
|
|
1656
|
-
"description": "The don of the rev org to unlink the rev user from.",
|
|
1657
|
-
"example": "don:<partition>:identity:devo/<dev-org-id>:revo/<rev-org-id>",
|
|
1658
|
-
"type": "string"
|
|
1659
|
-
},
|
|
1660
|
-
"user_don": {
|
|
1661
|
-
"description": "The don of the rev user to unlink.",
|
|
1662
|
-
"type": "string"
|
|
1663
|
-
}
|
|
1664
|
-
},
|
|
1665
|
-
"required": [
|
|
1666
|
-
"rev_org_don",
|
|
1667
|
-
"user_don"
|
|
1668
|
-
],
|
|
1669
|
-
"title": "unlink-rev-user-from-rev-org-request",
|
|
1670
|
-
"type": "object"
|
|
1671
|
-
},
|
|
1672
|
-
"unlink-rev-user-from-rev-org-response": {
|
|
1673
|
-
"description": "The response to unlink a rev user from a rev org.",
|
|
1674
|
-
"properties": {
|
|
1675
|
-
"rev_user": {
|
|
1676
|
-
"$ref": "#/components/schemas/rev-user"
|
|
1677
|
-
}
|
|
1678
|
-
},
|
|
1679
|
-
"required": [
|
|
1680
|
-
"rev_user"
|
|
1681
|
-
],
|
|
1682
|
-
"title": "unlink-rev-user-from-rev-org-response",
|
|
1683
|
-
"type": "object",
|
|
1684
|
-
"x-go-name": "UnlinkRevUserFromRevOrgResponseBody"
|
|
1685
|
-
},
|
|
1686
|
-
"user-base": {
|
|
1687
|
-
"allOf": [
|
|
1688
|
-
{
|
|
1689
|
-
"$ref": "#/components/schemas/atom-base"
|
|
1690
|
-
},
|
|
1691
|
-
{
|
|
1692
|
-
"properties": {
|
|
1693
|
-
"display_name": {
|
|
1694
|
-
"description": "The user's display name. The name is non-unique and mutable.\n",
|
|
1695
|
-
"type": "string"
|
|
1696
|
-
},
|
|
1697
|
-
"display_picture": {
|
|
1698
|
-
"$ref": "#/components/schemas/artifact-summary"
|
|
1699
|
-
},
|
|
1700
|
-
"email": {
|
|
1701
|
-
"description": "Email address of the user.",
|
|
1702
|
-
"type": "string"
|
|
1703
|
-
},
|
|
1704
|
-
"full_name": {
|
|
1705
|
-
"description": "Full name of the user.",
|
|
1706
|
-
"type": "string"
|
|
1707
|
-
},
|
|
1708
|
-
"phone_numbers": {
|
|
1709
|
-
"description": "Phone numbers of the user.",
|
|
1710
|
-
"items": {
|
|
1711
|
-
"type": "string"
|
|
1712
|
-
},
|
|
1713
|
-
"type": "array"
|
|
1714
|
-
},
|
|
1715
|
-
"state": {
|
|
1716
|
-
"$ref": "#/components/schemas/user-state"
|
|
1717
|
-
}
|
|
1718
|
-
},
|
|
1719
|
-
"type": "object"
|
|
1720
|
-
}
|
|
1721
|
-
],
|
|
1722
|
-
"title": "user-base"
|
|
1723
|
-
},
|
|
1724
|
-
"user-base-summary": {
|
|
1725
|
-
"allOf": [
|
|
1726
|
-
{
|
|
1727
|
-
"$ref": "#/components/schemas/atom-base-summary"
|
|
1728
|
-
},
|
|
1729
|
-
{
|
|
1730
|
-
"properties": {
|
|
1731
|
-
"display_name": {
|
|
1732
|
-
"description": "The user's display name. The name is non-unique and mutable.\n",
|
|
1733
|
-
"type": "string"
|
|
1734
|
-
},
|
|
1735
|
-
"display_picture": {
|
|
1736
|
-
"$ref": "#/components/schemas/artifact-summary"
|
|
1737
|
-
},
|
|
1738
|
-
"email": {
|
|
1739
|
-
"description": "Email address of the user.",
|
|
1740
|
-
"type": "string"
|
|
1741
|
-
},
|
|
1742
|
-
"full_name": {
|
|
1743
|
-
"description": "Full name of the user.",
|
|
1744
|
-
"type": "string"
|
|
1745
|
-
},
|
|
1746
|
-
"state": {
|
|
1747
|
-
"$ref": "#/components/schemas/user-state"
|
|
1748
|
-
}
|
|
1749
|
-
},
|
|
1750
|
-
"type": "object"
|
|
1751
|
-
}
|
|
1752
|
-
],
|
|
1753
|
-
"title": "user-base-summary"
|
|
1754
|
-
},
|
|
1755
|
-
"user-state": {
|
|
1756
|
-
"description": "State of the user.",
|
|
1757
|
-
"enum": [
|
|
1758
|
-
"active",
|
|
1759
|
-
"deactivated",
|
|
1760
|
-
"locked",
|
|
1761
|
-
"shadow",
|
|
1762
|
-
"unassigned"
|
|
1763
|
-
],
|
|
1764
|
-
"type": "string"
|
|
1765
|
-
},
|
|
1766
|
-
"user-summary": {
|
|
1767
|
-
"discriminator": {
|
|
1768
|
-
"mapping": {
|
|
1769
|
-
"dev_user": "#/components/schemas/dev-user-summary",
|
|
1770
|
-
"rev_user": "#/components/schemas/rev-user-summary",
|
|
1771
|
-
"sys_user": "#/components/schemas/sys-user-summary"
|
|
1772
|
-
},
|
|
1773
|
-
"propertyName": "type"
|
|
1774
|
-
},
|
|
1775
|
-
"oneOf": [
|
|
1776
|
-
{
|
|
1777
|
-
"$ref": "#/components/schemas/dev-user-summary"
|
|
1778
|
-
},
|
|
1779
|
-
{
|
|
1780
|
-
"$ref": "#/components/schemas/rev-user-summary"
|
|
1781
|
-
},
|
|
1782
|
-
{
|
|
1783
|
-
"$ref": "#/components/schemas/sys-user-summary"
|
|
1784
|
-
}
|
|
1785
|
-
],
|
|
1786
|
-
"properties": {
|
|
1787
|
-
"type": {
|
|
1788
|
-
"$ref": "#/components/schemas/user-type"
|
|
1789
|
-
}
|
|
1790
|
-
},
|
|
1791
|
-
"required": [
|
|
1792
|
-
"type"
|
|
1793
|
-
],
|
|
1794
|
-
"title": "user-summary",
|
|
1795
|
-
"type": "object"
|
|
1796
|
-
},
|
|
1797
|
-
"user-type": {
|
|
1798
|
-
"enum": [
|
|
1799
|
-
"dev_user",
|
|
1800
|
-
"rev_user",
|
|
1801
|
-
"sys_user"
|
|
1802
|
-
],
|
|
1803
|
-
"type": "string"
|
|
1804
|
-
},
|
|
1805
|
-
"work-base-summary": {
|
|
1806
|
-
"allOf": [
|
|
1807
|
-
{
|
|
1808
|
-
"$ref": "#/components/schemas/atom-base-summary"
|
|
1809
|
-
},
|
|
1810
|
-
{
|
|
1811
|
-
"properties": {
|
|
1812
|
-
"title": {
|
|
1813
|
-
"description": "Title of the work object.",
|
|
1814
|
-
"type": "string"
|
|
1815
|
-
}
|
|
1816
|
-
},
|
|
1817
|
-
"required": [
|
|
1818
|
-
"title"
|
|
1819
|
-
],
|
|
1820
|
-
"type": "object"
|
|
1821
|
-
}
|
|
1822
|
-
],
|
|
1823
|
-
"title": "work-base-summary"
|
|
1824
|
-
}
|
|
1825
|
-
},
|
|
1826
|
-
"securitySchemes": {
|
|
1827
|
-
"auth-token": {
|
|
1828
|
-
"description": "All the DevRev APIs require a token to authenticate the user. Provide `Authorization: <token>` as a header to every API request.\n [How do I find my token?](https://devrev.ai/docs/apis/auth)",
|
|
1829
|
-
"in": "header",
|
|
1830
|
-
"name": "Authorization",
|
|
1831
|
-
"type": "apiKey"
|
|
1832
|
-
}
|
|
1833
|
-
}
|
|
1834
|
-
},
|
|
1835
|
-
"info": {
|
|
1836
|
-
"description": "DevRev's BETA REST API Specification.",
|
|
1837
|
-
"title": "DevRev Beta REST API",
|
|
1838
|
-
"version": "BETA"
|
|
1839
|
-
},
|
|
1840
|
-
"openapi": "3.0.3",
|
|
1841
|
-
"paths": {
|
|
1842
|
-
"/conversations.create": {
|
|
1843
|
-
"post": {
|
|
1844
|
-
"description": "Creates a conversation.",
|
|
1845
|
-
"operationId": "conversations-create",
|
|
1846
|
-
"requestBody": {
|
|
1847
|
-
"content": {
|
|
1848
|
-
"application/json": {
|
|
1849
|
-
"schema": {
|
|
1850
|
-
"$ref": "#/components/schemas/conversations-create-request"
|
|
1851
|
-
}
|
|
1852
|
-
}
|
|
1853
|
-
}
|
|
1854
|
-
},
|
|
1855
|
-
"responses": {
|
|
1856
|
-
"201": {
|
|
1857
|
-
"content": {
|
|
1858
|
-
"application/json": {
|
|
1859
|
-
"schema": {
|
|
1860
|
-
"$ref": "#/components/schemas/conversations-create-response"
|
|
1861
|
-
}
|
|
1862
|
-
}
|
|
1863
|
-
},
|
|
1864
|
-
"description": "Success."
|
|
1865
|
-
},
|
|
1866
|
-
"400": {
|
|
1867
|
-
"$ref": "#/components/responses/bad-request"
|
|
1868
|
-
},
|
|
1869
|
-
"401": {
|
|
1870
|
-
"$ref": "#/components/responses/unauthorized"
|
|
1871
|
-
},
|
|
1872
|
-
"403": {
|
|
1873
|
-
"$ref": "#/components/responses/forbidden"
|
|
1874
|
-
},
|
|
1875
|
-
"429": {
|
|
1876
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
1877
|
-
},
|
|
1878
|
-
"500": {
|
|
1879
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
1880
|
-
},
|
|
1881
|
-
"503": {
|
|
1882
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
1883
|
-
}
|
|
1884
|
-
},
|
|
1885
|
-
"tags": [
|
|
1886
|
-
"conversations"
|
|
1887
|
-
]
|
|
1888
|
-
}
|
|
1889
|
-
},
|
|
1890
|
-
"/conversations.delete": {
|
|
1891
|
-
"post": {
|
|
1892
|
-
"description": "Deletes the requested conversation.",
|
|
1893
|
-
"operationId": "conversations-delete",
|
|
1894
|
-
"requestBody": {
|
|
1895
|
-
"content": {
|
|
1896
|
-
"application/json": {
|
|
1897
|
-
"schema": {
|
|
1898
|
-
"$ref": "#/components/schemas/conversations-delete-request"
|
|
1899
|
-
}
|
|
1900
|
-
}
|
|
1901
|
-
}
|
|
1902
|
-
},
|
|
1903
|
-
"responses": {
|
|
1904
|
-
"200": {
|
|
1905
|
-
"content": {
|
|
1906
|
-
"application/json": {
|
|
1907
|
-
"schema": {
|
|
1908
|
-
"$ref": "#/components/schemas/conversations-delete-response"
|
|
1909
|
-
}
|
|
1910
|
-
}
|
|
1911
|
-
},
|
|
1912
|
-
"description": "Success."
|
|
1913
|
-
},
|
|
1914
|
-
"400": {
|
|
1915
|
-
"$ref": "#/components/responses/bad-request"
|
|
1916
|
-
},
|
|
1917
|
-
"401": {
|
|
1918
|
-
"$ref": "#/components/responses/unauthorized"
|
|
1919
|
-
},
|
|
1920
|
-
"403": {
|
|
1921
|
-
"$ref": "#/components/responses/forbidden"
|
|
1922
|
-
},
|
|
1923
|
-
"404": {
|
|
1924
|
-
"$ref": "#/components/responses/not-found"
|
|
1925
|
-
},
|
|
1926
|
-
"429": {
|
|
1927
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
1928
|
-
},
|
|
1929
|
-
"500": {
|
|
1930
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
1931
|
-
},
|
|
1932
|
-
"503": {
|
|
1933
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
1934
|
-
}
|
|
1935
|
-
},
|
|
1936
|
-
"tags": [
|
|
1937
|
-
"conversations"
|
|
1938
|
-
]
|
|
1939
|
-
}
|
|
1940
|
-
},
|
|
1941
|
-
"/conversations.export": {
|
|
1942
|
-
"get": {
|
|
1943
|
-
"description": "Exports a collection of conversation items.",
|
|
1944
|
-
"operationId": "conversations-export",
|
|
1945
|
-
"parameters": [
|
|
1946
|
-
{
|
|
1947
|
-
"description": "Filters for conversations belonging to any of the provided parts.\n",
|
|
1948
|
-
"explode": false,
|
|
1949
|
-
"in": "query",
|
|
1950
|
-
"name": "applies_to_parts",
|
|
1951
|
-
"schema": {
|
|
1952
|
-
"example": [
|
|
1953
|
-
"don:<partition>:core:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
1954
|
-
],
|
|
1955
|
-
"items": {
|
|
1956
|
-
"type": "string"
|
|
1957
|
-
},
|
|
1958
|
-
"type": "array"
|
|
1959
|
-
}
|
|
1960
|
-
},
|
|
1961
|
-
{
|
|
1962
|
-
"description": "The number of conversation items to return. The default is '50', the\nmaximum is '5000'.\n",
|
|
1963
|
-
"explode": false,
|
|
1964
|
-
"in": "query",
|
|
1965
|
-
"name": "first",
|
|
1966
|
-
"schema": {
|
|
1967
|
-
"format": "int32",
|
|
1968
|
-
"type": "integer"
|
|
1969
|
-
}
|
|
1970
|
-
},
|
|
1971
|
-
{
|
|
1972
|
-
"description": "Filters for conversations where these users are participants.\n",
|
|
1973
|
-
"explode": false,
|
|
1974
|
-
"in": "query",
|
|
1975
|
-
"name": "members",
|
|
1976
|
-
"schema": {
|
|
1977
|
-
"example": [
|
|
1978
|
-
"don:<partition>:identity:devo/<dev-org-id>:devu/<dev-user-id>"
|
|
1979
|
-
],
|
|
1980
|
-
"items": {
|
|
1981
|
-
"type": "string"
|
|
1982
|
-
},
|
|
1983
|
-
"type": "array"
|
|
1984
|
-
}
|
|
1985
|
-
},
|
|
1986
|
-
{
|
|
1987
|
-
"description": "Filters for conversations owned by any of these users.",
|
|
1988
|
-
"explode": false,
|
|
1989
|
-
"in": "query",
|
|
1990
|
-
"name": "owned_by",
|
|
1991
|
-
"schema": {
|
|
1992
|
-
"example": [
|
|
1993
|
-
"don:<partition>:identity:devo/<dev-org-id>:devu/<dev-user-id>"
|
|
1994
|
-
],
|
|
1995
|
-
"items": {
|
|
1996
|
-
"type": "string"
|
|
1997
|
-
},
|
|
1998
|
-
"type": "array"
|
|
1999
|
-
}
|
|
2000
|
-
},
|
|
2001
|
-
{
|
|
2002
|
-
"description": "Filters for conversations that are associated with any of the\nprovided Rev organizations.\n",
|
|
2003
|
-
"explode": false,
|
|
2004
|
-
"in": "query",
|
|
2005
|
-
"name": "rev_org",
|
|
2006
|
-
"schema": {
|
|
2007
|
-
"example": [
|
|
2008
|
-
"don:<partition>:identity:devo/<dev-org-id>:revo/<rev-org-id>"
|
|
2009
|
-
],
|
|
2010
|
-
"items": {
|
|
2011
|
-
"type": "string"
|
|
2012
|
-
},
|
|
2013
|
-
"type": "array"
|
|
2014
|
-
}
|
|
2015
|
-
},
|
|
2016
|
-
{
|
|
2017
|
-
"description": "Filters for conversations with any of the provided source channels.\n",
|
|
2018
|
-
"explode": false,
|
|
2019
|
-
"in": "query",
|
|
2020
|
-
"name": "source_channels",
|
|
2021
|
-
"schema": {
|
|
2022
|
-
"items": {
|
|
2023
|
-
"type": "string"
|
|
2024
|
-
},
|
|
2025
|
-
"type": "array"
|
|
2026
|
-
}
|
|
2027
|
-
},
|
|
2028
|
-
{
|
|
2029
|
-
"description": "Filters for records in the provided stage(s).",
|
|
2030
|
-
"explode": false,
|
|
2031
|
-
"in": "query",
|
|
2032
|
-
"name": "stage.name",
|
|
2033
|
-
"schema": {
|
|
2034
|
-
"items": {
|
|
2035
|
-
"type": "string"
|
|
2036
|
-
},
|
|
2037
|
-
"type": "array"
|
|
2038
|
-
}
|
|
2039
|
-
},
|
|
2040
|
-
{
|
|
2041
|
-
"description": "Filters for conversations with any of the provided tags.",
|
|
2042
|
-
"explode": false,
|
|
2043
|
-
"in": "query",
|
|
2044
|
-
"name": "tags",
|
|
2045
|
-
"schema": {
|
|
2046
|
-
"example": [
|
|
2047
|
-
"don:<partition>:core:devo/<dev-org-id>:tag/<tag-id>"
|
|
2048
|
-
],
|
|
2049
|
-
"items": {
|
|
2050
|
-
"type": "string"
|
|
2051
|
-
},
|
|
2052
|
-
"type": "array"
|
|
2053
|
-
}
|
|
2054
|
-
}
|
|
2055
|
-
],
|
|
2056
|
-
"responses": {
|
|
2057
|
-
"200": {
|
|
2058
|
-
"content": {
|
|
2059
|
-
"application/json": {
|
|
2060
|
-
"schema": {
|
|
2061
|
-
"$ref": "#/components/schemas/conversations-export-response"
|
|
2062
|
-
}
|
|
2063
|
-
}
|
|
2064
|
-
},
|
|
2065
|
-
"description": "Success."
|
|
2066
|
-
},
|
|
2067
|
-
"400": {
|
|
2068
|
-
"$ref": "#/components/responses/bad-request"
|
|
2069
|
-
},
|
|
2070
|
-
"401": {
|
|
2071
|
-
"$ref": "#/components/responses/unauthorized"
|
|
2072
|
-
},
|
|
2073
|
-
"403": {
|
|
2074
|
-
"$ref": "#/components/responses/forbidden"
|
|
2075
|
-
},
|
|
2076
|
-
"429": {
|
|
2077
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
2078
|
-
},
|
|
2079
|
-
"500": {
|
|
2080
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
2081
|
-
},
|
|
2082
|
-
"503": {
|
|
2083
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
2084
|
-
}
|
|
2085
|
-
},
|
|
2086
|
-
"tags": [
|
|
2087
|
-
"conversations"
|
|
2088
|
-
]
|
|
2089
|
-
}
|
|
2090
|
-
},
|
|
2091
|
-
"/conversations.get": {
|
|
2092
|
-
"get": {
|
|
2093
|
-
"description": "Gets the requested conversation's information.",
|
|
2094
|
-
"operationId": "conversations-get",
|
|
2095
|
-
"parameters": [
|
|
2096
|
-
{
|
|
2097
|
-
"description": "The requested conversation's ID.",
|
|
2098
|
-
"explode": false,
|
|
2099
|
-
"in": "query",
|
|
2100
|
-
"name": "id",
|
|
2101
|
-
"required": true,
|
|
2102
|
-
"schema": {
|
|
2103
|
-
"type": "string"
|
|
2104
|
-
}
|
|
2105
|
-
}
|
|
2106
|
-
],
|
|
2107
|
-
"responses": {
|
|
2108
|
-
"200": {
|
|
2109
|
-
"content": {
|
|
2110
|
-
"application/json": {
|
|
2111
|
-
"schema": {
|
|
2112
|
-
"$ref": "#/components/schemas/conversations-get-response"
|
|
2113
|
-
}
|
|
2114
|
-
}
|
|
2115
|
-
},
|
|
2116
|
-
"description": "Success."
|
|
2117
|
-
},
|
|
2118
|
-
"400": {
|
|
2119
|
-
"$ref": "#/components/responses/bad-request"
|
|
2120
|
-
},
|
|
2121
|
-
"401": {
|
|
2122
|
-
"$ref": "#/components/responses/unauthorized"
|
|
2123
|
-
},
|
|
2124
|
-
"403": {
|
|
2125
|
-
"$ref": "#/components/responses/forbidden"
|
|
2126
|
-
},
|
|
2127
|
-
"404": {
|
|
2128
|
-
"$ref": "#/components/responses/not-found"
|
|
2129
|
-
},
|
|
2130
|
-
"429": {
|
|
2131
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
2132
|
-
},
|
|
2133
|
-
"500": {
|
|
2134
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
2135
|
-
},
|
|
2136
|
-
"503": {
|
|
2137
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
2138
|
-
}
|
|
2139
|
-
},
|
|
2140
|
-
"tags": [
|
|
2141
|
-
"conversations"
|
|
2142
|
-
]
|
|
2143
|
-
}
|
|
2144
|
-
},
|
|
2145
|
-
"/conversations.list": {
|
|
2146
|
-
"get": {
|
|
2147
|
-
"description": "Lists the available conversations.",
|
|
2148
|
-
"operationId": "conversations-list",
|
|
2149
|
-
"parameters": [
|
|
2150
|
-
{
|
|
2151
|
-
"description": "Filters for conversations belonging to any of the provided parts.\n",
|
|
2152
|
-
"explode": false,
|
|
2153
|
-
"in": "query",
|
|
2154
|
-
"name": "applies_to_parts",
|
|
2155
|
-
"schema": {
|
|
2156
|
-
"example": [
|
|
2157
|
-
"don:<partition>:core:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
2158
|
-
],
|
|
2159
|
-
"items": {
|
|
2160
|
-
"type": "string"
|
|
2161
|
-
},
|
|
2162
|
-
"type": "array"
|
|
2163
|
-
}
|
|
2164
|
-
},
|
|
2165
|
-
{
|
|
2166
|
-
"description": "The cursor to resume iteration from. If not provided, then iteration\nstarts from the beginning.\n",
|
|
2167
|
-
"explode": false,
|
|
2168
|
-
"in": "query",
|
|
2169
|
-
"name": "cursor",
|
|
2170
|
-
"schema": {
|
|
2171
|
-
"type": "string"
|
|
2172
|
-
}
|
|
2173
|
-
},
|
|
2174
|
-
{
|
|
2175
|
-
"description": "The maximum number of conversations to return. The default is '50'.\n",
|
|
2176
|
-
"explode": false,
|
|
2177
|
-
"in": "query",
|
|
2178
|
-
"name": "limit",
|
|
2179
|
-
"schema": {
|
|
2180
|
-
"format": "int32",
|
|
2181
|
-
"type": "integer"
|
|
2182
|
-
}
|
|
2183
|
-
},
|
|
2184
|
-
{
|
|
2185
|
-
"description": "Filters for conversations where these users are participants.\n",
|
|
2186
|
-
"explode": false,
|
|
2187
|
-
"in": "query",
|
|
2188
|
-
"name": "members",
|
|
2189
|
-
"schema": {
|
|
2190
|
-
"example": [
|
|
2191
|
-
"don:<partition>:identity:devo/<dev-org-id>:devu/<dev-user-id>"
|
|
2192
|
-
],
|
|
2193
|
-
"items": {
|
|
2194
|
-
"type": "string"
|
|
2195
|
-
},
|
|
2196
|
-
"type": "array"
|
|
2197
|
-
}
|
|
2198
|
-
},
|
|
2199
|
-
{
|
|
2200
|
-
"description": "The iteration mode to use, otherwise if not set, then \"after\" is\nused.\n",
|
|
2201
|
-
"explode": false,
|
|
2202
|
-
"in": "query",
|
|
2203
|
-
"name": "mode",
|
|
2204
|
-
"schema": {
|
|
2205
|
-
"$ref": "#/components/schemas/list-mode"
|
|
2206
|
-
}
|
|
2207
|
-
},
|
|
2208
|
-
{
|
|
2209
|
-
"description": "Filters for conversations owned by any of these users.",
|
|
2210
|
-
"explode": false,
|
|
2211
|
-
"in": "query",
|
|
2212
|
-
"name": "owned_by",
|
|
2213
|
-
"schema": {
|
|
2214
|
-
"example": [
|
|
2215
|
-
"don:<partition>:identity:devo/<dev-org-id>:devu/<dev-user-id>"
|
|
2216
|
-
],
|
|
2217
|
-
"items": {
|
|
2218
|
-
"type": "string"
|
|
2219
|
-
},
|
|
2220
|
-
"type": "array"
|
|
2221
|
-
}
|
|
2222
|
-
},
|
|
2223
|
-
{
|
|
2224
|
-
"description": "Filters for conversations that are associated with any of the\nprovided Rev organizations.\n",
|
|
2225
|
-
"explode": false,
|
|
2226
|
-
"in": "query",
|
|
2227
|
-
"name": "rev_org",
|
|
2228
|
-
"schema": {
|
|
2229
|
-
"example": [
|
|
2230
|
-
"don:<partition>:identity:devo/<dev-org-id>:revo/<rev-org-id>"
|
|
2231
|
-
],
|
|
2232
|
-
"items": {
|
|
2233
|
-
"type": "string"
|
|
2234
|
-
},
|
|
2235
|
-
"type": "array"
|
|
2236
|
-
}
|
|
2237
|
-
},
|
|
2238
|
-
{
|
|
2239
|
-
"description": "Filters for conversations with any of the provided source channels.\n",
|
|
2240
|
-
"explode": false,
|
|
2241
|
-
"in": "query",
|
|
2242
|
-
"name": "source_channels",
|
|
2243
|
-
"schema": {
|
|
2244
|
-
"items": {
|
|
2245
|
-
"type": "string"
|
|
2246
|
-
},
|
|
2247
|
-
"type": "array"
|
|
2248
|
-
}
|
|
2249
|
-
},
|
|
2250
|
-
{
|
|
2251
|
-
"description": "Filters for records in the provided stage(s).",
|
|
2252
|
-
"explode": false,
|
|
2253
|
-
"in": "query",
|
|
2254
|
-
"name": "stage.name",
|
|
2255
|
-
"schema": {
|
|
2256
|
-
"items": {
|
|
2257
|
-
"type": "string"
|
|
2258
|
-
},
|
|
2259
|
-
"type": "array"
|
|
2260
|
-
}
|
|
2261
|
-
},
|
|
2262
|
-
{
|
|
2263
|
-
"description": "Filters for conversations with any of the provided tags.",
|
|
2264
|
-
"explode": false,
|
|
2265
|
-
"in": "query",
|
|
2266
|
-
"name": "tags",
|
|
2267
|
-
"schema": {
|
|
2268
|
-
"example": [
|
|
2269
|
-
"don:<partition>:core:devo/<dev-org-id>:tag/<tag-id>"
|
|
2270
|
-
],
|
|
2271
|
-
"items": {
|
|
2272
|
-
"type": "string"
|
|
2273
|
-
},
|
|
2274
|
-
"type": "array"
|
|
2275
|
-
}
|
|
2276
|
-
}
|
|
2277
|
-
],
|
|
2278
|
-
"responses": {
|
|
2279
|
-
"200": {
|
|
2280
|
-
"content": {
|
|
2281
|
-
"application/json": {
|
|
2282
|
-
"schema": {
|
|
2283
|
-
"$ref": "#/components/schemas/conversations-list-response"
|
|
2284
|
-
}
|
|
2285
|
-
}
|
|
2286
|
-
},
|
|
2287
|
-
"description": "Success."
|
|
2288
|
-
},
|
|
2289
|
-
"400": {
|
|
2290
|
-
"$ref": "#/components/responses/bad-request"
|
|
2291
|
-
},
|
|
2292
|
-
"401": {
|
|
2293
|
-
"$ref": "#/components/responses/unauthorized"
|
|
2294
|
-
},
|
|
2295
|
-
"403": {
|
|
2296
|
-
"$ref": "#/components/responses/forbidden"
|
|
2297
|
-
},
|
|
2298
|
-
"429": {
|
|
2299
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
2300
|
-
},
|
|
2301
|
-
"500": {
|
|
2302
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
2303
|
-
},
|
|
2304
|
-
"503": {
|
|
2305
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
2306
|
-
}
|
|
2307
|
-
},
|
|
2308
|
-
"tags": [
|
|
2309
|
-
"conversations"
|
|
2310
|
-
]
|
|
2311
|
-
}
|
|
2312
|
-
},
|
|
2313
|
-
"/conversations.update": {
|
|
2314
|
-
"post": {
|
|
2315
|
-
"description": "Updates the requested conversation.",
|
|
2316
|
-
"operationId": "conversations-update",
|
|
2317
|
-
"requestBody": {
|
|
2318
|
-
"content": {
|
|
2319
|
-
"application/json": {
|
|
2320
|
-
"schema": {
|
|
2321
|
-
"$ref": "#/components/schemas/conversations-update-request"
|
|
2322
|
-
}
|
|
2323
|
-
}
|
|
2324
|
-
}
|
|
2325
|
-
},
|
|
2326
|
-
"responses": {
|
|
2327
|
-
"200": {
|
|
2328
|
-
"content": {
|
|
2329
|
-
"application/json": {
|
|
2330
|
-
"schema": {
|
|
2331
|
-
"$ref": "#/components/schemas/conversations-update-response"
|
|
2332
|
-
}
|
|
2333
|
-
}
|
|
2334
|
-
},
|
|
2335
|
-
"description": "Success."
|
|
2336
|
-
},
|
|
2337
|
-
"400": {
|
|
2338
|
-
"$ref": "#/components/responses/bad-request"
|
|
2339
|
-
},
|
|
2340
|
-
"401": {
|
|
2341
|
-
"$ref": "#/components/responses/unauthorized"
|
|
2342
|
-
},
|
|
2343
|
-
"403": {
|
|
2344
|
-
"$ref": "#/components/responses/forbidden"
|
|
2345
|
-
},
|
|
2346
|
-
"404": {
|
|
2347
|
-
"$ref": "#/components/responses/not-found"
|
|
2348
|
-
},
|
|
2349
|
-
"429": {
|
|
2350
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
2351
|
-
},
|
|
2352
|
-
"500": {
|
|
2353
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
2354
|
-
},
|
|
2355
|
-
"503": {
|
|
2356
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
2357
|
-
}
|
|
2358
|
-
},
|
|
2359
|
-
"tags": [
|
|
2360
|
-
"conversations"
|
|
2361
|
-
]
|
|
2362
|
-
}
|
|
2363
|
-
},
|
|
2364
|
-
"/links.create": {
|
|
2365
|
-
"post": {
|
|
2366
|
-
"description": "Creates a link between two objects to indicate a relationship.\n",
|
|
2367
|
-
"operationId": "links-create",
|
|
2368
|
-
"requestBody": {
|
|
2369
|
-
"content": {
|
|
2370
|
-
"application/json": {
|
|
2371
|
-
"schema": {
|
|
2372
|
-
"$ref": "#/components/schemas/links-create-request"
|
|
2373
|
-
}
|
|
2374
|
-
}
|
|
2375
|
-
}
|
|
2376
|
-
},
|
|
2377
|
-
"responses": {
|
|
2378
|
-
"201": {
|
|
2379
|
-
"content": {
|
|
2380
|
-
"application/json": {
|
|
2381
|
-
"schema": {
|
|
2382
|
-
"$ref": "#/components/schemas/links-create-response"
|
|
2383
|
-
}
|
|
2384
|
-
}
|
|
2385
|
-
},
|
|
2386
|
-
"description": "Success."
|
|
2387
|
-
},
|
|
2388
|
-
"400": {
|
|
2389
|
-
"$ref": "#/components/responses/bad-request"
|
|
2390
|
-
},
|
|
2391
|
-
"401": {
|
|
2392
|
-
"$ref": "#/components/responses/unauthorized"
|
|
2393
|
-
},
|
|
2394
|
-
"403": {
|
|
2395
|
-
"$ref": "#/components/responses/forbidden"
|
|
2396
|
-
},
|
|
2397
|
-
"429": {
|
|
2398
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
2399
|
-
},
|
|
2400
|
-
"500": {
|
|
2401
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
2402
|
-
},
|
|
2403
|
-
"503": {
|
|
2404
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
2405
|
-
}
|
|
2406
|
-
},
|
|
2407
|
-
"tags": [
|
|
2408
|
-
"links"
|
|
2409
|
-
]
|
|
2410
|
-
}
|
|
2411
|
-
},
|
|
2412
|
-
"/links.delete": {
|
|
2413
|
-
"post": {
|
|
2414
|
-
"description": "Deletes a link.",
|
|
2415
|
-
"operationId": "links-delete",
|
|
2416
|
-
"requestBody": {
|
|
2417
|
-
"content": {
|
|
2418
|
-
"application/json": {
|
|
2419
|
-
"schema": {
|
|
2420
|
-
"$ref": "#/components/schemas/links-delete-request"
|
|
2421
|
-
}
|
|
2422
|
-
}
|
|
2423
|
-
}
|
|
2424
|
-
},
|
|
2425
|
-
"responses": {
|
|
2426
|
-
"200": {
|
|
2427
|
-
"content": {
|
|
2428
|
-
"application/json": {
|
|
2429
|
-
"schema": {
|
|
2430
|
-
"$ref": "#/components/schemas/links-delete-response"
|
|
2431
|
-
}
|
|
2432
|
-
}
|
|
2433
|
-
},
|
|
2434
|
-
"description": "Success."
|
|
2435
|
-
},
|
|
2436
|
-
"400": {
|
|
2437
|
-
"$ref": "#/components/responses/bad-request"
|
|
2438
|
-
},
|
|
2439
|
-
"401": {
|
|
2440
|
-
"$ref": "#/components/responses/unauthorized"
|
|
2441
|
-
},
|
|
2442
|
-
"403": {
|
|
2443
|
-
"$ref": "#/components/responses/forbidden"
|
|
2444
|
-
},
|
|
2445
|
-
"404": {
|
|
2446
|
-
"$ref": "#/components/responses/not-found"
|
|
2447
|
-
},
|
|
2448
|
-
"429": {
|
|
2449
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
2450
|
-
},
|
|
2451
|
-
"500": {
|
|
2452
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
2453
|
-
},
|
|
2454
|
-
"503": {
|
|
2455
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
2456
|
-
}
|
|
2457
|
-
},
|
|
2458
|
-
"tags": [
|
|
2459
|
-
"links"
|
|
2460
|
-
]
|
|
2461
|
-
}
|
|
2462
|
-
},
|
|
2463
|
-
"/links.get": {
|
|
2464
|
-
"get": {
|
|
2465
|
-
"description": "Gets the requested link's information.",
|
|
2466
|
-
"operationId": "links-get",
|
|
2467
|
-
"parameters": [
|
|
2468
|
-
{
|
|
2469
|
-
"description": "The requested link's ID.",
|
|
2470
|
-
"explode": false,
|
|
2471
|
-
"in": "query",
|
|
2472
|
-
"name": "id",
|
|
2473
|
-
"required": true,
|
|
2474
|
-
"schema": {
|
|
2475
|
-
"type": "string"
|
|
2476
|
-
}
|
|
2477
|
-
}
|
|
2478
|
-
],
|
|
2479
|
-
"responses": {
|
|
2480
|
-
"200": {
|
|
2481
|
-
"content": {
|
|
2482
|
-
"application/json": {
|
|
2483
|
-
"schema": {
|
|
2484
|
-
"$ref": "#/components/schemas/links-get-response"
|
|
2485
|
-
}
|
|
2486
|
-
}
|
|
2487
|
-
},
|
|
2488
|
-
"description": "Success."
|
|
2489
|
-
},
|
|
2490
|
-
"400": {
|
|
2491
|
-
"$ref": "#/components/responses/bad-request"
|
|
2492
|
-
},
|
|
2493
|
-
"401": {
|
|
2494
|
-
"$ref": "#/components/responses/unauthorized"
|
|
2495
|
-
},
|
|
2496
|
-
"403": {
|
|
2497
|
-
"$ref": "#/components/responses/forbidden"
|
|
2498
|
-
},
|
|
2499
|
-
"404": {
|
|
2500
|
-
"$ref": "#/components/responses/not-found"
|
|
2501
|
-
},
|
|
2502
|
-
"429": {
|
|
2503
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
2504
|
-
},
|
|
2505
|
-
"500": {
|
|
2506
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
2507
|
-
},
|
|
2508
|
-
"503": {
|
|
2509
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
2510
|
-
}
|
|
2511
|
-
},
|
|
2512
|
-
"tags": [
|
|
2513
|
-
"links"
|
|
2514
|
-
]
|
|
2515
|
-
}
|
|
2516
|
-
},
|
|
2517
|
-
"/links.list": {
|
|
2518
|
-
"get": {
|
|
2519
|
-
"description": "Lists the available links.",
|
|
2520
|
-
"operationId": "links-list",
|
|
2521
|
-
"parameters": [
|
|
2522
|
-
{
|
|
2523
|
-
"description": "The ID of the object to list the links for.",
|
|
2524
|
-
"explode": false,
|
|
2525
|
-
"in": "query",
|
|
2526
|
-
"name": "object",
|
|
2527
|
-
"required": true,
|
|
2528
|
-
"schema": {
|
|
2529
|
-
"type": "string"
|
|
2530
|
-
}
|
|
2531
|
-
},
|
|
2532
|
-
{
|
|
2533
|
-
"description": "The cursor to resume iteration from. If not provided, then iteration\nstarts from the beginning.\n",
|
|
2534
|
-
"explode": false,
|
|
2535
|
-
"in": "query",
|
|
2536
|
-
"name": "cursor",
|
|
2537
|
-
"schema": {
|
|
2538
|
-
"type": "string"
|
|
2539
|
-
}
|
|
2540
|
-
},
|
|
2541
|
-
{
|
|
2542
|
-
"description": "The direction of the links to list, otherwise if not present, then\nlinks in both directions (source and target) are included.\n",
|
|
2543
|
-
"explode": false,
|
|
2544
|
-
"in": "query",
|
|
2545
|
-
"name": "direction",
|
|
2546
|
-
"schema": {
|
|
2547
|
-
"$ref": "#/components/schemas/links-direction"
|
|
2548
|
-
}
|
|
2549
|
-
},
|
|
2550
|
-
{
|
|
2551
|
-
"description": "The maximum number of links to return. If not set, then the default\nis '50'.\n",
|
|
2552
|
-
"explode": false,
|
|
2553
|
-
"in": "query",
|
|
2554
|
-
"name": "limit",
|
|
2555
|
-
"schema": {
|
|
2556
|
-
"format": "int32",
|
|
2557
|
-
"type": "integer"
|
|
2558
|
-
}
|
|
2559
|
-
},
|
|
2560
|
-
{
|
|
2561
|
-
"description": "The link type(s) to filter for, otherwise if not present, all link\ntypes are included.\n",
|
|
2562
|
-
"explode": false,
|
|
2563
|
-
"in": "query",
|
|
2564
|
-
"name": "link_type",
|
|
2565
|
-
"schema": {
|
|
2566
|
-
"items": {
|
|
2567
|
-
"$ref": "#/components/schemas/link-type"
|
|
2568
|
-
},
|
|
2569
|
-
"type": "array"
|
|
2570
|
-
}
|
|
2571
|
-
},
|
|
2572
|
-
{
|
|
2573
|
-
"description": "The iteration mode to use, otherwise if not set, then \"after\" is\nused.\n",
|
|
2574
|
-
"explode": false,
|
|
2575
|
-
"in": "query",
|
|
2576
|
-
"name": "mode",
|
|
2577
|
-
"schema": {
|
|
2578
|
-
"$ref": "#/components/schemas/list-mode"
|
|
2579
|
-
}
|
|
2580
|
-
},
|
|
2581
|
-
{
|
|
2582
|
-
"description": "The link types to filter for, otherwise if not present, all link\ntypes are included.\n",
|
|
2583
|
-
"explode": false,
|
|
2584
|
-
"in": "query",
|
|
2585
|
-
"name": "types",
|
|
2586
|
-
"schema": {
|
|
2587
|
-
"deprecated": true,
|
|
2588
|
-
"items": {
|
|
2589
|
-
"$ref": "#/components/schemas/link-type"
|
|
2590
|
-
},
|
|
2591
|
-
"type": "array"
|
|
2592
|
-
}
|
|
2593
|
-
}
|
|
2594
|
-
],
|
|
2595
|
-
"responses": {
|
|
2596
|
-
"200": {
|
|
2597
|
-
"content": {
|
|
2598
|
-
"application/json": {
|
|
2599
|
-
"schema": {
|
|
2600
|
-
"$ref": "#/components/schemas/links-list-response"
|
|
2601
|
-
}
|
|
2602
|
-
}
|
|
2603
|
-
},
|
|
2604
|
-
"description": "Success."
|
|
2605
|
-
},
|
|
2606
|
-
"400": {
|
|
2607
|
-
"$ref": "#/components/responses/bad-request"
|
|
2608
|
-
},
|
|
2609
|
-
"401": {
|
|
2610
|
-
"$ref": "#/components/responses/unauthorized"
|
|
2611
|
-
},
|
|
2612
|
-
"403": {
|
|
2613
|
-
"$ref": "#/components/responses/forbidden"
|
|
2614
|
-
},
|
|
2615
|
-
"429": {
|
|
2616
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
2617
|
-
},
|
|
2618
|
-
"500": {
|
|
2619
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
2620
|
-
},
|
|
2621
|
-
"503": {
|
|
2622
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
2623
|
-
}
|
|
2624
|
-
},
|
|
2625
|
-
"tags": [
|
|
2626
|
-
"links"
|
|
2627
|
-
]
|
|
2628
|
-
}
|
|
2629
|
-
},
|
|
2630
|
-
"/rev-users.create": {
|
|
2631
|
-
"post": {
|
|
2632
|
-
"description": "Creates a Rev user for a Rev organization. Rev user can be a customer\nor a lead of an organization.\n",
|
|
2633
|
-
"operationId": "rev-users-create",
|
|
2634
|
-
"requestBody": {
|
|
2635
|
-
"content": {
|
|
2636
|
-
"application/json": {
|
|
2637
|
-
"schema": {
|
|
2638
|
-
"$ref": "#/components/schemas/rev-users-create-request"
|
|
2639
|
-
}
|
|
2640
|
-
}
|
|
2641
|
-
}
|
|
2642
|
-
},
|
|
2643
|
-
"responses": {
|
|
2644
|
-
"201": {
|
|
2645
|
-
"content": {
|
|
2646
|
-
"application/json": {
|
|
2647
|
-
"schema": {
|
|
2648
|
-
"$ref": "#/components/schemas/rev-users-create-response"
|
|
2649
|
-
}
|
|
2650
|
-
}
|
|
2651
|
-
},
|
|
2652
|
-
"description": "Success."
|
|
2653
|
-
},
|
|
2654
|
-
"400": {
|
|
2655
|
-
"$ref": "#/components/responses/bad-request"
|
|
2656
|
-
},
|
|
2657
|
-
"401": {
|
|
2658
|
-
"$ref": "#/components/responses/unauthorized"
|
|
2659
|
-
},
|
|
2660
|
-
"403": {
|
|
2661
|
-
"$ref": "#/components/responses/forbidden"
|
|
2662
|
-
},
|
|
2663
|
-
"429": {
|
|
2664
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
2665
|
-
},
|
|
2666
|
-
"500": {
|
|
2667
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
2668
|
-
},
|
|
2669
|
-
"503": {
|
|
2670
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
2671
|
-
}
|
|
2672
|
-
},
|
|
2673
|
-
"tags": [
|
|
2674
|
-
"rev-users"
|
|
2675
|
-
]
|
|
2676
|
-
}
|
|
2677
|
-
},
|
|
2678
|
-
"/rev-users.delete": {
|
|
2679
|
-
"post": {
|
|
2680
|
-
"description": "Deletes a Rev user.",
|
|
2681
|
-
"operationId": "rev-users-delete",
|
|
2682
|
-
"requestBody": {
|
|
2683
|
-
"content": {
|
|
2684
|
-
"application/json": {
|
|
2685
|
-
"schema": {
|
|
2686
|
-
"$ref": "#/components/schemas/rev-users-delete-request"
|
|
2687
|
-
}
|
|
2688
|
-
}
|
|
2689
|
-
}
|
|
2690
|
-
},
|
|
2691
|
-
"responses": {
|
|
2692
|
-
"200": {
|
|
2693
|
-
"content": {
|
|
2694
|
-
"application/json": {
|
|
2695
|
-
"schema": {
|
|
2696
|
-
"$ref": "#/components/schemas/rev-users-delete-response"
|
|
2697
|
-
}
|
|
2698
|
-
}
|
|
2699
|
-
},
|
|
2700
|
-
"description": "Success."
|
|
2701
|
-
},
|
|
2702
|
-
"400": {
|
|
2703
|
-
"$ref": "#/components/responses/bad-request"
|
|
2704
|
-
},
|
|
2705
|
-
"401": {
|
|
2706
|
-
"$ref": "#/components/responses/unauthorized"
|
|
2707
|
-
},
|
|
2708
|
-
"403": {
|
|
2709
|
-
"$ref": "#/components/responses/forbidden"
|
|
2710
|
-
},
|
|
2711
|
-
"404": {
|
|
2712
|
-
"$ref": "#/components/responses/not-found"
|
|
2713
|
-
},
|
|
2714
|
-
"429": {
|
|
2715
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
2716
|
-
},
|
|
2717
|
-
"500": {
|
|
2718
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
2719
|
-
},
|
|
2720
|
-
"503": {
|
|
2721
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
2722
|
-
}
|
|
2723
|
-
},
|
|
2724
|
-
"tags": [
|
|
2725
|
-
"rev-users"
|
|
2726
|
-
]
|
|
2727
|
-
}
|
|
2728
|
-
},
|
|
2729
|
-
"/rev-users.get": {
|
|
2730
|
-
"get": {
|
|
2731
|
-
"description": "Returns the Rev user of a Rev organization by its ID.",
|
|
2732
|
-
"operationId": "rev-users-get",
|
|
2733
|
-
"parameters": [
|
|
2734
|
-
{
|
|
2735
|
-
"description": "The ID of Rev user to be retrieved.",
|
|
2736
|
-
"explode": false,
|
|
2737
|
-
"in": "query",
|
|
2738
|
-
"name": "id",
|
|
2739
|
-
"required": true,
|
|
2740
|
-
"schema": {
|
|
2741
|
-
"type": "string"
|
|
2742
|
-
}
|
|
2743
|
-
}
|
|
2744
|
-
],
|
|
2745
|
-
"responses": {
|
|
2746
|
-
"200": {
|
|
2747
|
-
"content": {
|
|
2748
|
-
"application/json": {
|
|
2749
|
-
"schema": {
|
|
2750
|
-
"$ref": "#/components/schemas/rev-users-get-response"
|
|
2751
|
-
}
|
|
2752
|
-
}
|
|
2753
|
-
},
|
|
2754
|
-
"description": "Success."
|
|
2755
|
-
},
|
|
2756
|
-
"400": {
|
|
2757
|
-
"$ref": "#/components/responses/bad-request"
|
|
2758
|
-
},
|
|
2759
|
-
"401": {
|
|
2760
|
-
"$ref": "#/components/responses/unauthorized"
|
|
2761
|
-
},
|
|
2762
|
-
"403": {
|
|
2763
|
-
"$ref": "#/components/responses/forbidden"
|
|
2764
|
-
},
|
|
2765
|
-
"404": {
|
|
2766
|
-
"$ref": "#/components/responses/not-found"
|
|
2767
|
-
},
|
|
2768
|
-
"429": {
|
|
2769
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
2770
|
-
},
|
|
2771
|
-
"500": {
|
|
2772
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
2773
|
-
},
|
|
2774
|
-
"503": {
|
|
2775
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
2776
|
-
}
|
|
2777
|
-
},
|
|
2778
|
-
"tags": [
|
|
2779
|
-
"rev-users"
|
|
2780
|
-
]
|
|
2781
|
-
}
|
|
2782
|
-
},
|
|
2783
|
-
"/rev-users.link": {
|
|
2784
|
-
"post": {
|
|
2785
|
-
"description": "Links a rev user to a rev org.",
|
|
2786
|
-
"operationId": "link-rev-user-to-rev-org",
|
|
2787
|
-
"requestBody": {
|
|
2788
|
-
"content": {
|
|
2789
|
-
"application/json": {
|
|
2790
|
-
"schema": {
|
|
2791
|
-
"$ref": "#/components/schemas/link-rev-user-to-rev-org-request"
|
|
2792
|
-
}
|
|
2793
|
-
}
|
|
2794
|
-
}
|
|
2795
|
-
},
|
|
2796
|
-
"responses": {
|
|
2797
|
-
"200": {
|
|
2798
|
-
"content": {
|
|
2799
|
-
"application/json": {
|
|
2800
|
-
"schema": {
|
|
2801
|
-
"$ref": "#/components/schemas/link-rev-user-to-rev-org-response"
|
|
2802
|
-
}
|
|
2803
|
-
}
|
|
2804
|
-
},
|
|
2805
|
-
"description": "Success."
|
|
2806
|
-
},
|
|
2807
|
-
"400": {
|
|
2808
|
-
"$ref": "#/components/responses/bad-request"
|
|
2809
|
-
},
|
|
2810
|
-
"401": {
|
|
2811
|
-
"$ref": "#/components/responses/unauthorized"
|
|
2812
|
-
},
|
|
2813
|
-
"403": {
|
|
2814
|
-
"$ref": "#/components/responses/forbidden"
|
|
2815
|
-
},
|
|
2816
|
-
"404": {
|
|
2817
|
-
"$ref": "#/components/responses/not-found"
|
|
2818
|
-
},
|
|
2819
|
-
"429": {
|
|
2820
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
2821
|
-
},
|
|
2822
|
-
"500": {
|
|
2823
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
2824
|
-
},
|
|
2825
|
-
"503": {
|
|
2826
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
2827
|
-
}
|
|
2828
|
-
},
|
|
2829
|
-
"tags": [
|
|
2830
|
-
"rev-users"
|
|
2831
|
-
]
|
|
2832
|
-
}
|
|
2833
|
-
},
|
|
2834
|
-
"/rev-users.list": {
|
|
2835
|
-
"get": {
|
|
2836
|
-
"description": "Returns a list of all Rev Users belonging to the authenticated user's\nDev Organization.\n",
|
|
2837
|
-
"operationId": "rev-users-list",
|
|
2838
|
-
"parameters": [
|
|
2839
|
-
{
|
|
2840
|
-
"description": "Filters for Rev users that were created by the specified user(s).\n",
|
|
2841
|
-
"explode": false,
|
|
2842
|
-
"in": "query",
|
|
2843
|
-
"name": "created_by",
|
|
2844
|
-
"schema": {
|
|
2845
|
-
"items": {
|
|
2846
|
-
"type": "string"
|
|
2847
|
-
},
|
|
2848
|
-
"type": "array"
|
|
2849
|
-
}
|
|
2850
|
-
},
|
|
2851
|
-
{
|
|
2852
|
-
"description": "Filters for objects created after the provided timestamp (inclusive).\n",
|
|
2853
|
-
"explode": false,
|
|
2854
|
-
"in": "query",
|
|
2855
|
-
"name": "created_date.after",
|
|
2856
|
-
"schema": {
|
|
2857
|
-
"format": "date-time",
|
|
2858
|
-
"type": "string"
|
|
2859
|
-
}
|
|
2860
|
-
},
|
|
2861
|
-
{
|
|
2862
|
-
"description": "Filters for objects created before the provided timestamp\n(inclusive).\n",
|
|
2863
|
-
"explode": false,
|
|
2864
|
-
"in": "query",
|
|
2865
|
-
"name": "created_date.before",
|
|
2866
|
-
"schema": {
|
|
2867
|
-
"format": "date-time",
|
|
2868
|
-
"type": "string"
|
|
2869
|
-
}
|
|
2870
|
-
},
|
|
2871
|
-
{
|
|
2872
|
-
"description": "The cursor to resume iteration from. If not provided, then iteration\nstarts from the beginning.\n",
|
|
2873
|
-
"explode": false,
|
|
2874
|
-
"in": "query",
|
|
2875
|
-
"name": "cursor",
|
|
2876
|
-
"schema": {
|
|
2877
|
-
"type": "string"
|
|
2878
|
-
}
|
|
2879
|
-
},
|
|
2880
|
-
{
|
|
2881
|
-
"description": "List of emails of Rev users to be filtered.",
|
|
2882
|
-
"explode": false,
|
|
2883
|
-
"in": "query",
|
|
2884
|
-
"name": "email",
|
|
2885
|
-
"schema": {
|
|
2886
|
-
"items": {
|
|
2887
|
-
"type": "string"
|
|
2888
|
-
},
|
|
2889
|
-
"type": "array"
|
|
2890
|
-
}
|
|
2891
|
-
},
|
|
2892
|
-
{
|
|
2893
|
-
"description": "The maximum number of Rev users to return. The default is '50'.\n",
|
|
2894
|
-
"explode": false,
|
|
2895
|
-
"in": "query",
|
|
2896
|
-
"name": "limit",
|
|
2897
|
-
"schema": {
|
|
2898
|
-
"format": "int32",
|
|
2899
|
-
"type": "integer"
|
|
2900
|
-
}
|
|
2901
|
-
},
|
|
2902
|
-
{
|
|
2903
|
-
"description": "The iteration mode to use, otherwise if not set, then \"after\" is\nused.\n",
|
|
2904
|
-
"explode": false,
|
|
2905
|
-
"in": "query",
|
|
2906
|
-
"name": "mode",
|
|
2907
|
-
"schema": {
|
|
2908
|
-
"$ref": "#/components/schemas/list-mode"
|
|
2909
|
-
}
|
|
2910
|
-
},
|
|
2911
|
-
{
|
|
2912
|
-
"description": "Filters for objects created after the provided timestamp (inclusive).\n",
|
|
2913
|
-
"explode": false,
|
|
2914
|
-
"in": "query",
|
|
2915
|
-
"name": "modified_date.after",
|
|
2916
|
-
"schema": {
|
|
2917
|
-
"format": "date-time",
|
|
2918
|
-
"type": "string"
|
|
2919
|
-
}
|
|
2920
|
-
},
|
|
2921
|
-
{
|
|
2922
|
-
"description": "Filters for objects created before the provided timestamp\n(inclusive).\n",
|
|
2923
|
-
"explode": false,
|
|
2924
|
-
"in": "query",
|
|
2925
|
-
"name": "modified_date.before",
|
|
2926
|
-
"schema": {
|
|
2927
|
-
"format": "date-time",
|
|
2928
|
-
"type": "string"
|
|
2929
|
-
}
|
|
2930
|
-
},
|
|
2931
|
-
{
|
|
2932
|
-
"description": "List of IDs of Rev organizations to be filtered.",
|
|
2933
|
-
"explode": false,
|
|
2934
|
-
"in": "query",
|
|
2935
|
-
"name": "rev_org",
|
|
2936
|
-
"schema": {
|
|
2937
|
-
"example": [
|
|
2938
|
-
"don:<partition>:identity:devo/<dev-org-id>:revo/<rev-org-id>"
|
|
2939
|
-
],
|
|
2940
|
-
"items": {
|
|
2941
|
-
"type": "string"
|
|
2942
|
-
},
|
|
2943
|
-
"type": "array"
|
|
2944
|
-
}
|
|
2945
|
-
},
|
|
2946
|
-
{
|
|
2947
|
-
"description": "Fields to sort the Rev users by and the direction to sort them.\n",
|
|
2948
|
-
"explode": false,
|
|
2949
|
-
"in": "query",
|
|
2950
|
-
"name": "sort_by",
|
|
2951
|
-
"schema": {
|
|
2952
|
-
"items": {
|
|
2953
|
-
"type": "string"
|
|
2954
|
-
},
|
|
2955
|
-
"type": "array"
|
|
2956
|
-
}
|
|
2957
|
-
}
|
|
2958
|
-
],
|
|
2959
|
-
"responses": {
|
|
2960
|
-
"200": {
|
|
2961
|
-
"content": {
|
|
2962
|
-
"application/json": {
|
|
2963
|
-
"schema": {
|
|
2964
|
-
"$ref": "#/components/schemas/rev-users-list-response"
|
|
2965
|
-
}
|
|
2966
|
-
}
|
|
2967
|
-
},
|
|
2968
|
-
"description": "Success."
|
|
2969
|
-
},
|
|
2970
|
-
"400": {
|
|
2971
|
-
"$ref": "#/components/responses/bad-request"
|
|
2972
|
-
},
|
|
2973
|
-
"401": {
|
|
2974
|
-
"$ref": "#/components/responses/unauthorized"
|
|
2975
|
-
},
|
|
2976
|
-
"403": {
|
|
2977
|
-
"$ref": "#/components/responses/forbidden"
|
|
2978
|
-
},
|
|
2979
|
-
"404": {
|
|
2980
|
-
"$ref": "#/components/responses/not-found"
|
|
2981
|
-
},
|
|
2982
|
-
"429": {
|
|
2983
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
2984
|
-
},
|
|
2985
|
-
"500": {
|
|
2986
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
2987
|
-
},
|
|
2988
|
-
"503": {
|
|
2989
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
2990
|
-
}
|
|
2991
|
-
},
|
|
2992
|
-
"tags": [
|
|
2993
|
-
"rev-users"
|
|
2994
|
-
]
|
|
2995
|
-
}
|
|
2996
|
-
},
|
|
2997
|
-
"/rev-users.unlink": {
|
|
2998
|
-
"post": {
|
|
2999
|
-
"description": "Unlinks a rev user from a rev org.",
|
|
3000
|
-
"operationId": "unlink-rev-user-from-rev-org",
|
|
3001
|
-
"requestBody": {
|
|
3002
|
-
"content": {
|
|
3003
|
-
"application/json": {
|
|
3004
|
-
"schema": {
|
|
3005
|
-
"$ref": "#/components/schemas/unlink-rev-user-from-rev-org-request"
|
|
3006
|
-
}
|
|
3007
|
-
}
|
|
3008
|
-
}
|
|
3009
|
-
},
|
|
3010
|
-
"responses": {
|
|
3011
|
-
"200": {
|
|
3012
|
-
"content": {
|
|
3013
|
-
"application/json": {
|
|
3014
|
-
"schema": {
|
|
3015
|
-
"$ref": "#/components/schemas/unlink-rev-user-from-rev-org-response"
|
|
3016
|
-
}
|
|
3017
|
-
}
|
|
3018
|
-
},
|
|
3019
|
-
"description": "Success."
|
|
3020
|
-
},
|
|
3021
|
-
"400": {
|
|
3022
|
-
"$ref": "#/components/responses/bad-request"
|
|
3023
|
-
},
|
|
3024
|
-
"401": {
|
|
3025
|
-
"$ref": "#/components/responses/unauthorized"
|
|
3026
|
-
},
|
|
3027
|
-
"403": {
|
|
3028
|
-
"$ref": "#/components/responses/forbidden"
|
|
3029
|
-
},
|
|
3030
|
-
"404": {
|
|
3031
|
-
"$ref": "#/components/responses/not-found"
|
|
3032
|
-
},
|
|
3033
|
-
"429": {
|
|
3034
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
3035
|
-
},
|
|
3036
|
-
"500": {
|
|
3037
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
3038
|
-
},
|
|
3039
|
-
"503": {
|
|
3040
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
3041
|
-
}
|
|
3042
|
-
},
|
|
3043
|
-
"tags": [
|
|
3044
|
-
"rev-users"
|
|
3045
|
-
]
|
|
3046
|
-
}
|
|
3047
|
-
},
|
|
3048
|
-
"/rev-users.update": {
|
|
3049
|
-
"post": {
|
|
3050
|
-
"description": "Updates a Rev user.",
|
|
3051
|
-
"operationId": "rev-users-update",
|
|
3052
|
-
"requestBody": {
|
|
3053
|
-
"content": {
|
|
3054
|
-
"application/json": {
|
|
3055
|
-
"schema": {
|
|
3056
|
-
"$ref": "#/components/schemas/rev-users-update-request"
|
|
3057
|
-
}
|
|
3058
|
-
}
|
|
3059
|
-
}
|
|
3060
|
-
},
|
|
3061
|
-
"responses": {
|
|
3062
|
-
"200": {
|
|
3063
|
-
"content": {
|
|
3064
|
-
"application/json": {
|
|
3065
|
-
"schema": {
|
|
3066
|
-
"$ref": "#/components/schemas/rev-users-update-response"
|
|
3067
|
-
}
|
|
3068
|
-
}
|
|
3069
|
-
},
|
|
3070
|
-
"description": "Success."
|
|
3071
|
-
},
|
|
3072
|
-
"400": {
|
|
3073
|
-
"$ref": "#/components/responses/bad-request"
|
|
3074
|
-
},
|
|
3075
|
-
"401": {
|
|
3076
|
-
"$ref": "#/components/responses/unauthorized"
|
|
3077
|
-
},
|
|
3078
|
-
"403": {
|
|
3079
|
-
"$ref": "#/components/responses/forbidden"
|
|
3080
|
-
},
|
|
3081
|
-
"404": {
|
|
3082
|
-
"$ref": "#/components/responses/not-found"
|
|
3083
|
-
},
|
|
3084
|
-
"429": {
|
|
3085
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
3086
|
-
},
|
|
3087
|
-
"500": {
|
|
3088
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
3089
|
-
},
|
|
3090
|
-
"503": {
|
|
3091
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
3092
|
-
}
|
|
3093
|
-
},
|
|
3094
|
-
"tags": [
|
|
3095
|
-
"rev-users"
|
|
3096
|
-
]
|
|
3097
|
-
}
|
|
3098
|
-
},
|
|
3099
|
-
"/sys-users.list": {
|
|
3100
|
-
"get": {
|
|
3101
|
-
"description": "Lists system users within your organization.",
|
|
3102
|
-
"operationId": "sys-users-list",
|
|
3103
|
-
"parameters": [
|
|
3104
|
-
{
|
|
3105
|
-
"description": "The cursor to resume iteration from. If not provided, then iteration\nstarts from the beginning.\n",
|
|
3106
|
-
"explode": false,
|
|
3107
|
-
"in": "query",
|
|
3108
|
-
"name": "cursor",
|
|
3109
|
-
"schema": {
|
|
3110
|
-
"type": "string"
|
|
3111
|
-
}
|
|
3112
|
-
},
|
|
3113
|
-
{
|
|
3114
|
-
"description": "The maximum number of system users to return. Value can range from\n'1' to '100', with a default of '50'.\n",
|
|
3115
|
-
"explode": false,
|
|
3116
|
-
"in": "query",
|
|
3117
|
-
"name": "limit",
|
|
3118
|
-
"schema": {
|
|
3119
|
-
"format": "int32",
|
|
3120
|
-
"type": "integer"
|
|
3121
|
-
}
|
|
3122
|
-
},
|
|
3123
|
-
{
|
|
3124
|
-
"description": "The iteration mode to use, otherwise if not set, then \"after\" is\nused.\n",
|
|
3125
|
-
"explode": false,
|
|
3126
|
-
"in": "query",
|
|
3127
|
-
"name": "mode",
|
|
3128
|
-
"schema": {
|
|
3129
|
-
"$ref": "#/components/schemas/list-mode"
|
|
3130
|
-
}
|
|
3131
|
-
},
|
|
3132
|
-
{
|
|
3133
|
-
"description": "Fields to sort the system users by and the direction to sort them.\n",
|
|
3134
|
-
"explode": false,
|
|
3135
|
-
"in": "query",
|
|
3136
|
-
"name": "sort_by",
|
|
3137
|
-
"schema": {
|
|
3138
|
-
"items": {
|
|
3139
|
-
"type": "string"
|
|
3140
|
-
},
|
|
3141
|
-
"type": "array"
|
|
3142
|
-
}
|
|
3143
|
-
}
|
|
3144
|
-
],
|
|
3145
|
-
"responses": {
|
|
3146
|
-
"200": {
|
|
3147
|
-
"content": {
|
|
3148
|
-
"application/json": {
|
|
3149
|
-
"schema": {
|
|
3150
|
-
"$ref": "#/components/schemas/sys-users-list-response"
|
|
3151
|
-
}
|
|
3152
|
-
}
|
|
3153
|
-
},
|
|
3154
|
-
"description": "Success."
|
|
3155
|
-
},
|
|
3156
|
-
"400": {
|
|
3157
|
-
"$ref": "#/components/responses/bad-request"
|
|
3158
|
-
},
|
|
3159
|
-
"401": {
|
|
3160
|
-
"$ref": "#/components/responses/unauthorized"
|
|
3161
|
-
},
|
|
3162
|
-
"403": {
|
|
3163
|
-
"$ref": "#/components/responses/forbidden"
|
|
3164
|
-
},
|
|
3165
|
-
"429": {
|
|
3166
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
3167
|
-
},
|
|
3168
|
-
"500": {
|
|
3169
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
3170
|
-
},
|
|
3171
|
-
"503": {
|
|
3172
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
3173
|
-
}
|
|
3174
|
-
},
|
|
3175
|
-
"tags": [
|
|
3176
|
-
"sys-users"
|
|
3177
|
-
]
|
|
3178
|
-
}
|
|
3179
|
-
},
|
|
3180
|
-
"/sys-users.update": {
|
|
3181
|
-
"post": {
|
|
3182
|
-
"description": "Updates the system user.",
|
|
3183
|
-
"operationId": "sys-users-update",
|
|
3184
|
-
"requestBody": {
|
|
3185
|
-
"content": {
|
|
3186
|
-
"application/json": {
|
|
3187
|
-
"schema": {
|
|
3188
|
-
"$ref": "#/components/schemas/sys-users-update-request"
|
|
3189
|
-
}
|
|
3190
|
-
}
|
|
3191
|
-
}
|
|
3192
|
-
},
|
|
3193
|
-
"responses": {
|
|
3194
|
-
"200": {
|
|
3195
|
-
"content": {
|
|
3196
|
-
"application/json": {
|
|
3197
|
-
"schema": {
|
|
3198
|
-
"$ref": "#/components/schemas/sys-users-update-response"
|
|
3199
|
-
}
|
|
3200
|
-
}
|
|
3201
|
-
},
|
|
3202
|
-
"description": "Success."
|
|
3203
|
-
},
|
|
3204
|
-
"400": {
|
|
3205
|
-
"$ref": "#/components/responses/bad-request"
|
|
3206
|
-
},
|
|
3207
|
-
"401": {
|
|
3208
|
-
"$ref": "#/components/responses/unauthorized"
|
|
3209
|
-
},
|
|
3210
|
-
"403": {
|
|
3211
|
-
"$ref": "#/components/responses/forbidden"
|
|
3212
|
-
},
|
|
3213
|
-
"404": {
|
|
3214
|
-
"$ref": "#/components/responses/not-found"
|
|
3215
|
-
},
|
|
3216
|
-
"429": {
|
|
3217
|
-
"$ref": "#/components/responses/too-many-requests"
|
|
3218
|
-
},
|
|
3219
|
-
"500": {
|
|
3220
|
-
"$ref": "#/components/responses/internal-server-error"
|
|
3221
|
-
},
|
|
3222
|
-
"503": {
|
|
3223
|
-
"$ref": "#/components/responses/service-unavailable"
|
|
3224
|
-
}
|
|
3225
|
-
},
|
|
3226
|
-
"tags": [
|
|
3227
|
-
"sys-users"
|
|
3228
|
-
]
|
|
3229
|
-
}
|
|
3230
|
-
}
|
|
3231
|
-
},
|
|
3232
|
-
"security": [
|
|
3233
|
-
{
|
|
3234
|
-
"auth-token": []
|
|
3235
|
-
}
|
|
3236
|
-
],
|
|
3237
|
-
"servers": [
|
|
3238
|
-
{
|
|
3239
|
-
"description": "DevRev API endpoint.",
|
|
3240
|
-
"url": "{protocol}://{hostname}",
|
|
3241
|
-
"variables": {
|
|
3242
|
-
"hostname": {
|
|
3243
|
-
"default": "api.devrev.ai",
|
|
3244
|
-
"description": "API hostname."
|
|
3245
|
-
},
|
|
3246
|
-
"protocol": {
|
|
3247
|
-
"default": "https",
|
|
3248
|
-
"description": "API protocol."
|
|
3249
|
-
}
|
|
3250
|
-
}
|
|
3251
|
-
}
|
|
3252
|
-
],
|
|
3253
|
-
"tags": [
|
|
3254
|
-
{
|
|
3255
|
-
"description": "DevRev conversation interaction.",
|
|
3256
|
-
"name": "conversations"
|
|
3257
|
-
},
|
|
3258
|
-
{
|
|
3259
|
-
"description": "DevRev link interactions.",
|
|
3260
|
-
"name": "links"
|
|
3261
|
-
},
|
|
3262
|
-
{
|
|
3263
|
-
"description": "Rev user interactions.",
|
|
3264
|
-
"name": "rev-users"
|
|
3265
|
-
},
|
|
3266
|
-
{
|
|
3267
|
-
"description": "System user interactions",
|
|
3268
|
-
"name": "sys-users"
|
|
3269
|
-
}
|
|
3270
|
-
]
|
|
3271
|
-
}
|