zod-codegen 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/.github/ISSUE_TEMPLATE/bug_report.yml +93 -0
  2. package/.github/ISSUE_TEMPLATE/feature_request.yml +70 -0
  3. package/.github/PULL_REQUEST_TEMPLATE.md +87 -0
  4. package/.github/dependabot.yml +76 -0
  5. package/.github/workflows/ci.yml +143 -0
  6. package/.github/workflows/release.yml +65 -0
  7. package/.husky/commit-msg +2 -0
  8. package/.husky/pre-commit +5 -0
  9. package/.lintstagedrc.json +4 -0
  10. package/.nvmrc +1 -0
  11. package/.prettierrc.json +7 -0
  12. package/.releaserc.json +159 -0
  13. package/CHANGELOG.md +24 -0
  14. package/CONTRIBUTING.md +274 -0
  15. package/LICENCE +201 -0
  16. package/README.md +263 -0
  17. package/SECURITY.md +108 -0
  18. package/codecov.yml +29 -0
  19. package/commitlint.config.mjs +28 -0
  20. package/dist/scripts/update-manifest.js +31 -0
  21. package/dist/src/assets/manifest.json +5 -0
  22. package/dist/src/cli.js +60 -0
  23. package/dist/src/generator.js +55 -0
  24. package/dist/src/http/fetch-client.js +141 -0
  25. package/dist/src/interfaces/code-generator.js +1 -0
  26. package/dist/src/interfaces/file-reader.js +1 -0
  27. package/dist/src/polyfills/fetch.js +18 -0
  28. package/dist/src/services/code-generator.service.js +419 -0
  29. package/dist/src/services/file-reader.service.js +25 -0
  30. package/dist/src/services/file-writer.service.js +32 -0
  31. package/dist/src/services/import-builder.service.js +45 -0
  32. package/dist/src/services/type-builder.service.js +42 -0
  33. package/dist/src/types/http.js +10 -0
  34. package/dist/src/types/openapi.js +173 -0
  35. package/dist/src/utils/error-handler.js +11 -0
  36. package/dist/src/utils/execution-time.js +3 -0
  37. package/dist/src/utils/manifest.js +9 -0
  38. package/dist/src/utils/reporter.js +15 -0
  39. package/dist/src/utils/signal-handler.js +12 -0
  40. package/dist/src/utils/tty.js +3 -0
  41. package/dist/tests/integration/cli.test.js +25 -0
  42. package/dist/tests/unit/generator.test.js +29 -0
  43. package/dist/vitest.config.js +38 -0
  44. package/eslint.config.mjs +33 -0
  45. package/package.json +102 -0
  46. package/samples/openapi.json +1 -0
  47. package/samples/saris-openapi.json +7122 -0
  48. package/samples/swagger-petstore.yaml +802 -0
  49. package/samples/swagger-saris.yaml +3585 -0
  50. package/samples/test-logical.yaml +50 -0
  51. package/scripts/update-manifest.js +31 -0
  52. package/scripts/update-manifest.ts +47 -0
  53. package/src/assets/manifest.json +5 -0
  54. package/src/cli.ts +68 -0
  55. package/src/generator.ts +61 -0
  56. package/src/http/fetch-client.ts +181 -0
  57. package/src/interfaces/code-generator.ts +25 -0
  58. package/src/interfaces/file-reader.ts +15 -0
  59. package/src/polyfills/fetch.ts +26 -0
  60. package/src/services/code-generator.service.ts +775 -0
  61. package/src/services/file-reader.service.ts +29 -0
  62. package/src/services/file-writer.service.ts +36 -0
  63. package/src/services/import-builder.service.ts +64 -0
  64. package/src/services/type-builder.service.ts +77 -0
  65. package/src/types/http.ts +35 -0
  66. package/src/types/openapi.ts +202 -0
  67. package/src/utils/error-handler.ts +13 -0
  68. package/src/utils/execution-time.ts +3 -0
  69. package/src/utils/manifest.ts +17 -0
  70. package/src/utils/reporter.ts +16 -0
  71. package/src/utils/signal-handler.ts +14 -0
  72. package/src/utils/tty.ts +3 -0
  73. package/tests/integration/cli.test.ts +29 -0
  74. package/tests/unit/generator.test.ts +36 -0
  75. package/tsconfig.json +44 -0
  76. package/vitest.config.ts +39 -0
@@ -0,0 +1,3585 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: FastAPI
4
+ version: '1.0'
5
+ paths:
6
+ /api/v1/conversations/:
7
+ get:
8
+ tags:
9
+ - conversations
10
+ summary: Get Conversations
11
+ operationId: get_conversations_api_v1_conversations__get
12
+ parameters:
13
+ - required: false
14
+ schema:
15
+ type: integer
16
+ title: Conversation Id
17
+ name: conversation_id
18
+ in: query
19
+ - required: false
20
+ schema:
21
+ type: integer
22
+ title: Df Account Id
23
+ name: df_account_id
24
+ in: query
25
+ - required: false
26
+ schema:
27
+ type: integer
28
+ title: User Id
29
+ name: user_id
30
+ in: query
31
+ - required: false
32
+ schema:
33
+ $ref: '#/components/schemas/ChannelType'
34
+ name: channel_type
35
+ in: query
36
+ - required: false
37
+ schema:
38
+ type: string
39
+ title: External Id
40
+ name: external_id
41
+ in: query
42
+ responses:
43
+ '200':
44
+ description: Successful Response
45
+ content:
46
+ application/json:
47
+ schema:
48
+ anyOf:
49
+ - $ref: '#/components/schemas/ConversationResponse'
50
+ - items:
51
+ $ref: '#/components/schemas/ConversationResponse'
52
+ type: array
53
+ title: Response Get Conversations Api V1 Conversations Get
54
+ '404':
55
+ description: Conversation route not found
56
+ '422':
57
+ description: Validation Error
58
+ content:
59
+ application/json:
60
+ schema:
61
+ $ref: '#/components/schemas/HTTPValidationError'
62
+ security:
63
+ - OAuth2PasswordBearer: []
64
+ post:
65
+ tags:
66
+ - conversations
67
+ summary: Create Conversation
68
+ operationId: create_conversation_api_v1_conversations__post
69
+ requestBody:
70
+ content:
71
+ application/json:
72
+ schema:
73
+ $ref: '#/components/schemas/ConversationCreate'
74
+ required: true
75
+ responses:
76
+ '201':
77
+ description: Successful Response
78
+ content:
79
+ application/json:
80
+ schema:
81
+ $ref: '#/components/schemas/ConversationResponse'
82
+ '404':
83
+ description: Conversation route not found
84
+ '422':
85
+ description: Validation Error
86
+ content:
87
+ application/json:
88
+ schema:
89
+ $ref: '#/components/schemas/HTTPValidationError'
90
+ security:
91
+ - OAuth2PasswordBearer: []
92
+ /api/v1/conversations/{conversation_id}:
93
+ put:
94
+ tags:
95
+ - conversations
96
+ summary: Update Conversation Route
97
+ operationId: update_conversation_route_api_v1_conversations__conversation_id__put
98
+ parameters:
99
+ - required: true
100
+ schema:
101
+ type: integer
102
+ title: Conversation Id
103
+ name: conversation_id
104
+ in: path
105
+ requestBody:
106
+ content:
107
+ application/json:
108
+ schema:
109
+ $ref: '#/components/schemas/ConversationUpdate'
110
+ required: true
111
+ responses:
112
+ '201':
113
+ description: Successful Response
114
+ content:
115
+ application/json:
116
+ schema:
117
+ $ref: '#/components/schemas/ConversationResponse'
118
+ '404':
119
+ description: Conversation route not found
120
+ '422':
121
+ description: Validation Error
122
+ content:
123
+ application/json:
124
+ schema:
125
+ $ref: '#/components/schemas/HTTPValidationError'
126
+ security:
127
+ - OAuth2PasswordBearer: []
128
+ delete:
129
+ tags:
130
+ - conversations
131
+ summary: Delete Conversation
132
+ operationId: delete_conversation_api_v1_conversations__conversation_id__delete
133
+ parameters:
134
+ - required: true
135
+ schema:
136
+ type: integer
137
+ title: Conversation Id
138
+ name: conversation_id
139
+ in: path
140
+ responses:
141
+ '204':
142
+ description: Successful Response
143
+ '404':
144
+ description: Conversation route not found
145
+ '422':
146
+ description: Validation Error
147
+ content:
148
+ application/json:
149
+ schema:
150
+ $ref: '#/components/schemas/HTTPValidationError'
151
+ security:
152
+ - OAuth2PasswordBearer: []
153
+ /api/v1/df_accounts/:
154
+ get:
155
+ tags:
156
+ - df_accounts
157
+ summary: Get Df Account
158
+ operationId: get_df_account_api_v1_df_accounts__get
159
+ parameters:
160
+ - required: false
161
+ schema:
162
+ type: integer
163
+ title: Df Account Id
164
+ name: df_account_id
165
+ in: query
166
+ - required: false
167
+ schema:
168
+ type: string
169
+ title: Phone Number
170
+ name: phone_number
171
+ in: query
172
+ - required: false
173
+ schema:
174
+ type: string
175
+ title: Df Case Number
176
+ name: df_case_number
177
+ in: query
178
+ - required: false
179
+ schema:
180
+ type: string
181
+ title: Email
182
+ name: email
183
+ in: query
184
+ - required: false
185
+ schema:
186
+ type: string
187
+ title: Emails
188
+ name: emails
189
+ in: query
190
+ responses:
191
+ '200':
192
+ description: Successful Response
193
+ content:
194
+ application/json:
195
+ schema:
196
+ anyOf:
197
+ - items:
198
+ $ref: '#/components/schemas/DFAccountResponse'
199
+ type: array
200
+ - $ref: '#/components/schemas/DFAccountResponse'
201
+ title: Response Get Df Account Api V1 Df Accounts Get
202
+ '404':
203
+ description: DF Account route not found
204
+ '422':
205
+ description: Validation Error
206
+ content:
207
+ application/json:
208
+ schema:
209
+ $ref: '#/components/schemas/HTTPValidationError'
210
+ security:
211
+ - OAuth2PasswordBearer: []
212
+ /api/v1/generated_messages/:
213
+ get:
214
+ tags:
215
+ - generated_messages
216
+ summary: Get Generated Message
217
+ operationId: get_generated_message_api_v1_generated_messages__get
218
+ parameters:
219
+ - required: false
220
+ schema:
221
+ type: integer
222
+ title: Generated Message Id
223
+ name: generated_message_id
224
+ in: query
225
+ - required: false
226
+ schema:
227
+ type: integer
228
+ title: Conversation Id
229
+ name: conversation_id
230
+ in: query
231
+ - required: false
232
+ schema:
233
+ type: integer
234
+ title: Df Account Id
235
+ name: df_account_id
236
+ in: query
237
+ - required: false
238
+ schema:
239
+ allOf:
240
+ - $ref: '#/components/schemas/GeneratedMessageType'
241
+ default: 1
242
+ name: type
243
+ in: query
244
+ - required: false
245
+ schema:
246
+ type: boolean
247
+ title: With Feedback
248
+ default: true
249
+ name: with_feedback
250
+ in: query
251
+ responses:
252
+ '200':
253
+ description: Successful Response
254
+ content:
255
+ application/json:
256
+ schema:
257
+ anyOf:
258
+ - $ref: '#/components/schemas/GeneratedMessageResponse'
259
+ - items:
260
+ $ref: '#/components/schemas/GeneratedMessageResponse'
261
+ type: array
262
+ title: Response Get Generated Message Api V1 Generated Messages Get
263
+ '404':
264
+ description: generated_message route not found
265
+ '422':
266
+ description: Validation Error
267
+ content:
268
+ application/json:
269
+ schema:
270
+ $ref: '#/components/schemas/HTTPValidationError'
271
+ security:
272
+ - OAuth2PasswordBearer: []
273
+ put:
274
+ tags:
275
+ - generated_messages
276
+ summary: Update Generated Message
277
+ operationId: update_generated_message_api_v1_generated_messages__put
278
+ requestBody:
279
+ content:
280
+ application/json:
281
+ schema:
282
+ $ref: '#/components/schemas/GeneratedMessageUpdate'
283
+ required: true
284
+ responses:
285
+ '200':
286
+ description: Successful Response
287
+ content:
288
+ application/json:
289
+ schema:
290
+ $ref: '#/components/schemas/GeneratedMessageResponse'
291
+ '404':
292
+ description: generated_message route not found
293
+ '422':
294
+ description: Validation Error
295
+ content:
296
+ application/json:
297
+ schema:
298
+ $ref: '#/components/schemas/HTTPValidationError'
299
+ security:
300
+ - OAuth2PasswordBearer: []
301
+ post:
302
+ tags:
303
+ - generated_messages
304
+ summary: Create Generated Message
305
+ operationId: create_generated_message_api_v1_generated_messages__post
306
+ requestBody:
307
+ content:
308
+ application/json:
309
+ schema:
310
+ $ref: '#/components/schemas/GeneratedMessageCreate'
311
+ required: true
312
+ responses:
313
+ '201':
314
+ description: Successful Response
315
+ content:
316
+ application/json:
317
+ schema:
318
+ anyOf:
319
+ - $ref: '#/components/schemas/GeneratedMessageResponse'
320
+ - $ref: '#/components/schemas/TestGeneratedMessageResponse'
321
+ title: Response Create Generated Message Api V1 Generated Messages Post
322
+ '404':
323
+ description: generated_message route not found
324
+ '422':
325
+ description: Validation Error
326
+ content:
327
+ application/json:
328
+ schema:
329
+ $ref: '#/components/schemas/HTTPValidationError'
330
+ security:
331
+ - OAuth2PasswordBearer: []
332
+ delete:
333
+ tags:
334
+ - generated_messages
335
+ summary: Delete Generated Message
336
+ operationId: delete_generated_message_api_v1_generated_messages__delete
337
+ parameters:
338
+ - required: true
339
+ schema:
340
+ type: integer
341
+ title: Generated Message Id
342
+ name: generated_message_id
343
+ in: query
344
+ responses:
345
+ '204':
346
+ description: Successful Response
347
+ '404':
348
+ description: generated_message route not found
349
+ '422':
350
+ description: Validation Error
351
+ content:
352
+ application/json:
353
+ schema:
354
+ $ref: '#/components/schemas/HTTPValidationError'
355
+ security:
356
+ - OAuth2PasswordBearer: []
357
+ /api/v1/messages/:
358
+ get:
359
+ tags:
360
+ - messages
361
+ summary: Get Messages
362
+ operationId: get_messages_api_v1_messages__get
363
+ parameters:
364
+ - required: false
365
+ schema:
366
+ type: integer
367
+ title: Message Id
368
+ name: message_id
369
+ in: query
370
+ - required: false
371
+ schema:
372
+ type: integer
373
+ title: Conversation Id
374
+ name: conversation_id
375
+ in: query
376
+ - required: false
377
+ schema:
378
+ type: boolean
379
+ title: With Feedback
380
+ default: true
381
+ name: with_feedback
382
+ in: query
383
+ responses:
384
+ '200':
385
+ description: Successful Response
386
+ content:
387
+ application/json:
388
+ schema:
389
+ anyOf:
390
+ - $ref: '#/components/schemas/MessageResponse'
391
+ - items:
392
+ $ref: '#/components/schemas/MessageResponse'
393
+ type: array
394
+ title: Response Get Messages Api V1 Messages Get
395
+ '404':
396
+ description: message route not found
397
+ '422':
398
+ description: Validation Error
399
+ content:
400
+ application/json:
401
+ schema:
402
+ $ref: '#/components/schemas/HTTPValidationError'
403
+ security:
404
+ - OAuth2PasswordBearer: []
405
+ put:
406
+ tags:
407
+ - messages
408
+ summary: Update Messages
409
+ operationId: update_messages_api_v1_messages__put
410
+ parameters:
411
+ - required: true
412
+ schema:
413
+ type: integer
414
+ title: Message Id
415
+ name: message_id
416
+ in: query
417
+ requestBody:
418
+ content:
419
+ application/json:
420
+ schema:
421
+ $ref: '#/components/schemas/MessageUpdate'
422
+ required: true
423
+ responses:
424
+ '200':
425
+ description: Successful Response
426
+ content:
427
+ application/json:
428
+ schema:
429
+ $ref: '#/components/schemas/MessageResponse'
430
+ '404':
431
+ description: message route not found
432
+ '422':
433
+ description: Validation Error
434
+ content:
435
+ application/json:
436
+ schema:
437
+ $ref: '#/components/schemas/HTTPValidationError'
438
+ security:
439
+ - OAuth2PasswordBearer: []
440
+ post:
441
+ tags:
442
+ - messages
443
+ summary: Create Messages
444
+ operationId: create_messages_api_v1_messages__post
445
+ requestBody:
446
+ content:
447
+ application/json:
448
+ schema:
449
+ items:
450
+ $ref: '#/components/schemas/MessageCreate'
451
+ type: array
452
+ title: Messages In
453
+ required: true
454
+ responses:
455
+ '201':
456
+ description: Successful Response
457
+ content:
458
+ application/json:
459
+ schema:
460
+ anyOf:
461
+ - $ref: '#/components/schemas/MessageResponse'
462
+ - items:
463
+ $ref: '#/components/schemas/MessageResponse'
464
+ type: array
465
+ title: Response Create Messages Api V1 Messages Post
466
+ '404':
467
+ description: message route not found
468
+ '422':
469
+ description: Validation Error
470
+ content:
471
+ application/json:
472
+ schema:
473
+ $ref: '#/components/schemas/HTTPValidationError'
474
+ security:
475
+ - OAuth2PasswordBearer: []
476
+ /api/v1/messages/{message_id}:
477
+ delete:
478
+ tags:
479
+ - messages
480
+ summary: Delete Messages
481
+ operationId: delete_messages_api_v1_messages__message_id__delete
482
+ parameters:
483
+ - required: true
484
+ schema:
485
+ type: integer
486
+ title: Message Id
487
+ name: message_id
488
+ in: path
489
+ responses:
490
+ '204':
491
+ description: Successful Response
492
+ '404':
493
+ description: message route not found
494
+ '422':
495
+ description: Validation Error
496
+ content:
497
+ application/json:
498
+ schema:
499
+ $ref: '#/components/schemas/HTTPValidationError'
500
+ security:
501
+ - OAuth2PasswordBearer: []
502
+ /api/v1/users/:
503
+ get:
504
+ tags:
505
+ - users
506
+ summary: Read User
507
+ description: Fetch the current logged in user.
508
+ operationId: read_user_api_v1_users__get
509
+ parameters:
510
+ - required: false
511
+ schema:
512
+ type: boolean
513
+ title: List All
514
+ default: false
515
+ name: list_all
516
+ in: query
517
+ responses:
518
+ '200':
519
+ description: Successful Response
520
+ content:
521
+ application/json:
522
+ schema:
523
+ anyOf:
524
+ - $ref: '#/components/schemas/User'
525
+ - items:
526
+ $ref: '#/components/schemas/User'
527
+ type: array
528
+ title: Response Read User Api V1 Users Get
529
+ '404':
530
+ description: users route not found
531
+ '422':
532
+ description: Validation Error
533
+ content:
534
+ application/json:
535
+ schema:
536
+ $ref: '#/components/schemas/HTTPValidationError'
537
+ security:
538
+ - OAuth2PasswordBearer: []
539
+ put:
540
+ tags:
541
+ - users
542
+ summary: Update User
543
+ description: Update User account information for logged in users.
544
+ operationId: update_user_api_v1_users__put
545
+ requestBody:
546
+ content:
547
+ application/json:
548
+ schema:
549
+ $ref: '#/components/schemas/UserUpdate'
550
+ required: true
551
+ responses:
552
+ '200':
553
+ description: Successful Response
554
+ content:
555
+ application/json:
556
+ schema:
557
+ $ref: '#/components/schemas/User'
558
+ '404':
559
+ description: users route not found
560
+ '422':
561
+ description: Validation Error
562
+ content:
563
+ application/json:
564
+ schema:
565
+ $ref: '#/components/schemas/HTTPValidationError'
566
+ security:
567
+ - OAuth2PasswordBearer: []
568
+ post:
569
+ tags:
570
+ - users
571
+ summary: Create User
572
+ description: Create new user without the need to be logged in.
573
+ operationId: create_user_api_v1_users__post
574
+ requestBody:
575
+ content:
576
+ application/json:
577
+ schema:
578
+ $ref: '#/components/schemas/UserCreate'
579
+ required: true
580
+ responses:
581
+ '201':
582
+ description: Successful Response
583
+ content:
584
+ application/json:
585
+ schema:
586
+ $ref: '#/components/schemas/User'
587
+ '404':
588
+ description: users route not found
589
+ '422':
590
+ description: Validation Error
591
+ content:
592
+ application/json:
593
+ schema:
594
+ $ref: '#/components/schemas/HTTPValidationError'
595
+ /api/v1/users/verify:
596
+ post:
597
+ tags:
598
+ - users
599
+ summary: Verify User
600
+ operationId: verify_user_api_v1_users_verify_post
601
+ parameters:
602
+ - required: true
603
+ schema:
604
+ type: string
605
+ title: Token
606
+ name: token
607
+ in: query
608
+ responses:
609
+ '204':
610
+ description: Successful Response
611
+ '404':
612
+ description: users route not found
613
+ '422':
614
+ description: Validation Error
615
+ content:
616
+ application/json:
617
+ schema:
618
+ $ref: '#/components/schemas/HTTPValidationError'
619
+ /api/v1/users/reset:
620
+ post:
621
+ tags:
622
+ - users
623
+ summary: Reset Password
624
+ description: Trigger a password reset request for the User. No data will be returned.
625
+ operationId: reset_password_api_v1_users_reset_post
626
+ parameters:
627
+ - required: true
628
+ schema:
629
+ type: string
630
+ title: Email
631
+ name: email
632
+ in: query
633
+ responses:
634
+ '200':
635
+ description: Successful Response
636
+ content:
637
+ application/json:
638
+ schema:
639
+ title: Response Reset Password Api V1 Users Reset Post
640
+ '404':
641
+ description: users route not found
642
+ '422':
643
+ description: Validation Error
644
+ content:
645
+ application/json:
646
+ schema:
647
+ $ref: '#/components/schemas/HTTPValidationError'
648
+ /api/v1/users/set_password:
649
+ put:
650
+ tags:
651
+ - users
652
+ summary: Set User Password
653
+ description: Setting the User's new password with a password reset token
654
+ operationId: set_user_password_api_v1_users_set_password_put
655
+ requestBody:
656
+ content:
657
+ application/json:
658
+ schema:
659
+ $ref: '#/components/schemas/UserSetPasswordWithToken'
660
+ required: true
661
+ responses:
662
+ '200':
663
+ description: Successful Response
664
+ content:
665
+ application/json:
666
+ schema:
667
+ title: Response Set User Password Api V1 Users Set Password Put
668
+ '404':
669
+ description: users route not found
670
+ '422':
671
+ description: Validation Error
672
+ content:
673
+ application/json:
674
+ schema:
675
+ $ref: '#/components/schemas/HTTPValidationError'
676
+ /api/v1/conversation_states/:
677
+ get:
678
+ tags:
679
+ - conversation_states
680
+ summary: Get Conversation State Logs
681
+ operationId: get_conversation_state_logs_api_v1_conversation_states__get
682
+ parameters:
683
+ - required: false
684
+ schema:
685
+ type: integer
686
+ title: Conversation Id
687
+ name: conversation_id
688
+ in: query
689
+ responses:
690
+ '200':
691
+ description: Successful Response
692
+ content:
693
+ application/json:
694
+ schema:
695
+ items:
696
+ $ref: '#/components/schemas/ConversationStateLogResponse'
697
+ type: array
698
+ title: Response Get Conversation State Logs Api V1 Conversation States Get
699
+ '404':
700
+ description: generated_message route not found
701
+ '422':
702
+ description: Validation Error
703
+ content:
704
+ application/json:
705
+ schema:
706
+ $ref: '#/components/schemas/HTTPValidationError'
707
+ security:
708
+ - OAuth2PasswordBearer: []
709
+ post:
710
+ tags:
711
+ - conversation_states
712
+ summary: Create Conversation State Log Route
713
+ operationId: create_conversation_state_log_route_api_v1_conversation_states__post
714
+ requestBody:
715
+ content:
716
+ application/json:
717
+ schema:
718
+ $ref: '#/components/schemas/ConversationStateLogCreate'
719
+ required: true
720
+ responses:
721
+ '201':
722
+ description: Successful Response
723
+ content:
724
+ application/json:
725
+ schema:
726
+ $ref: '#/components/schemas/ConversationStateLogResponse'
727
+ '404':
728
+ description: generated_message route not found
729
+ '422':
730
+ description: Validation Error
731
+ content:
732
+ application/json:
733
+ schema:
734
+ $ref: '#/components/schemas/HTTPValidationError'
735
+ security:
736
+ - OAuth2PasswordBearer: []
737
+ /api/v1/models/:
738
+ get:
739
+ tags:
740
+ - models
741
+ summary: Get Models
742
+ operationId: get_models_api_v1_models__get
743
+ parameters:
744
+ - required: false
745
+ schema:
746
+ type: integer
747
+ title: Default Only
748
+ default: 0
749
+ name: default_only
750
+ in: query
751
+ responses:
752
+ '200':
753
+ description: Successful Response
754
+ content:
755
+ application/json:
756
+ schema:
757
+ items:
758
+ $ref: '#/components/schemas/ModelSelectorResponse'
759
+ type: array
760
+ title: Response Get Models Api V1 Models Get
761
+ '404':
762
+ description: models route not found
763
+ '422':
764
+ description: Validation Error
765
+ content:
766
+ application/json:
767
+ schema:
768
+ $ref: '#/components/schemas/HTTPValidationError'
769
+ security:
770
+ - OAuth2PasswordBearer: []
771
+ /api/v1/email_messages/:
772
+ get:
773
+ tags:
774
+ - email_messages
775
+ summary: Get Email Messages
776
+ operationId: get_email_messages_api_v1_email_messages__get
777
+ parameters:
778
+ - required: false
779
+ schema:
780
+ type: integer
781
+ title: Message Id
782
+ name: message_id
783
+ in: query
784
+ - required: false
785
+ schema:
786
+ type: integer
787
+ title: Conversation Id
788
+ name: conversation_id
789
+ in: query
790
+ - required: false
791
+ schema:
792
+ type: boolean
793
+ title: With Feedback
794
+ default: true
795
+ name: with_feedback
796
+ in: query
797
+ responses:
798
+ '200':
799
+ description: Successful Response
800
+ content:
801
+ application/json:
802
+ schema:
803
+ anyOf:
804
+ - $ref: '#/components/schemas/EmailMessageResponse'
805
+ - items:
806
+ $ref: '#/components/schemas/EmailMessageResponse'
807
+ type: array
808
+ title: Response Get Email Messages Api V1 Email Messages Get
809
+ '404':
810
+ description: email message route not found
811
+ '422':
812
+ description: Validation Error
813
+ content:
814
+ application/json:
815
+ schema:
816
+ $ref: '#/components/schemas/HTTPValidationError'
817
+ security:
818
+ - OAuth2PasswordBearer: []
819
+ put:
820
+ tags:
821
+ - email_messages
822
+ summary: Update Messages
823
+ operationId: update_messages_api_v1_email_messages__put
824
+ parameters:
825
+ - required: true
826
+ schema:
827
+ type: integer
828
+ title: Message Id
829
+ name: message_id
830
+ in: query
831
+ requestBody:
832
+ content:
833
+ application/json:
834
+ schema:
835
+ $ref: '#/components/schemas/EmailMessageUpdate'
836
+ required: true
837
+ responses:
838
+ '200':
839
+ description: Successful Response
840
+ content:
841
+ application/json:
842
+ schema:
843
+ $ref: '#/components/schemas/EmailMessageResponse'
844
+ '404':
845
+ description: email message route not found
846
+ '422':
847
+ description: Validation Error
848
+ content:
849
+ application/json:
850
+ schema:
851
+ $ref: '#/components/schemas/HTTPValidationError'
852
+ security:
853
+ - OAuth2PasswordBearer: []
854
+ post:
855
+ tags:
856
+ - email_messages
857
+ summary: Create Email Messages
858
+ operationId: create_email_messages_api_v1_email_messages__post
859
+ requestBody:
860
+ content:
861
+ application/json:
862
+ schema:
863
+ items:
864
+ $ref: '#/components/schemas/EmailMessageCreate'
865
+ type: array
866
+ title: Messages In
867
+ required: true
868
+ responses:
869
+ '201':
870
+ description: Successful Response
871
+ content:
872
+ application/json:
873
+ schema:
874
+ anyOf:
875
+ - $ref: '#/components/schemas/EmailMessageResponse'
876
+ - items:
877
+ $ref: '#/components/schemas/EmailMessageResponse'
878
+ type: array
879
+ title: Response Create Email Messages Api V1 Email Messages Post
880
+ '404':
881
+ description: email message route not found
882
+ '422':
883
+ description: Validation Error
884
+ content:
885
+ application/json:
886
+ schema:
887
+ $ref: '#/components/schemas/HTTPValidationError'
888
+ security:
889
+ - OAuth2PasswordBearer: []
890
+ /api/v1/email_messages/{message_id}:
891
+ delete:
892
+ tags:
893
+ - email_messages
894
+ summary: Delete Messages
895
+ operationId: delete_messages_api_v1_email_messages__message_id__delete
896
+ parameters:
897
+ - required: true
898
+ schema:
899
+ type: integer
900
+ title: Message Id
901
+ name: message_id
902
+ in: path
903
+ responses:
904
+ '204':
905
+ description: Successful Response
906
+ '404':
907
+ description: email message route not found
908
+ '422':
909
+ description: Validation Error
910
+ content:
911
+ application/json:
912
+ schema:
913
+ $ref: '#/components/schemas/HTTPValidationError'
914
+ security:
915
+ - OAuth2PasswordBearer: []
916
+ /api/v1/customers/:
917
+ get:
918
+ tags:
919
+ - customers
920
+ summary: Read Customer
921
+ description: Fetch the current logged in user's Customer data.
922
+ operationId: read_customer_api_v1_customers__get
923
+ parameters:
924
+ - required: false
925
+ schema:
926
+ type: boolean
927
+ title: List All
928
+ default: false
929
+ name: list_all
930
+ in: query
931
+ responses:
932
+ '200':
933
+ description: Successful Response
934
+ content:
935
+ application/json:
936
+ schema:
937
+ anyOf:
938
+ - $ref: '#/components/schemas/CustomerResponse'
939
+ - items:
940
+ $ref: '#/components/schemas/CustomerResponse'
941
+ type: array
942
+ title: Response Read Customer Api V1 Customers Get
943
+ '404':
944
+ description: customers route not found
945
+ '422':
946
+ description: Validation Error
947
+ content:
948
+ application/json:
949
+ schema:
950
+ $ref: '#/components/schemas/HTTPValidationError'
951
+ security:
952
+ - OAuth2PasswordBearer: []
953
+ /api/v2/agent_flows/:
954
+ get:
955
+ tags:
956
+ - agent_flows
957
+ summary: Get Agent Flow
958
+ operationId: get_agent_flow_api_v2_agent_flows__get
959
+ parameters:
960
+ - required: false
961
+ schema:
962
+ type: integer
963
+ title: Flow Id
964
+ name: flow_id
965
+ in: query
966
+ - required: false
967
+ schema:
968
+ type: string
969
+ title: Name
970
+ name: name
971
+ in: query
972
+ - required: false
973
+ schema:
974
+ type: integer
975
+ title: Ver
976
+ name: ver
977
+ in: query
978
+ - required: false
979
+ schema:
980
+ type: integer
981
+ title: Default Only
982
+ default: 0
983
+ name: default_only
984
+ in: query
985
+ - required: false
986
+ schema:
987
+ type: integer
988
+ title: Flow Type
989
+ default: 1
990
+ name: flow_type
991
+ in: query
992
+ responses:
993
+ '200':
994
+ description: Successful Response
995
+ content:
996
+ application/json:
997
+ schema:
998
+ anyOf:
999
+ - $ref: '#/components/schemas/AgentFlowV2Response'
1000
+ - items:
1001
+ $ref: '#/components/schemas/AgentFlowV2Response'
1002
+ type: array
1003
+ title: Response Get Agent Flow Api V2 Agent Flows Get
1004
+ '404':
1005
+ description: Agent flow route not found
1006
+ '422':
1007
+ description: Validation Error
1008
+ content:
1009
+ application/json:
1010
+ schema:
1011
+ $ref: '#/components/schemas/HTTPValidationError'
1012
+ security:
1013
+ - OAuth2PasswordBearer: []
1014
+ post:
1015
+ tags:
1016
+ - agent_flows
1017
+ summary: Create Agent Flows
1018
+ operationId: create_agent_flows_api_v2_agent_flows__post
1019
+ requestBody:
1020
+ content:
1021
+ application/json:
1022
+ schema:
1023
+ $ref: '#/components/schemas/AgentFlowV2Create'
1024
+ required: true
1025
+ responses:
1026
+ '201':
1027
+ description: Successful Response
1028
+ content:
1029
+ application/json:
1030
+ schema:
1031
+ $ref: '#/components/schemas/AgentFlowV2Response'
1032
+ '404':
1033
+ description: Agent flow route not found
1034
+ '422':
1035
+ description: Validation Error
1036
+ content:
1037
+ application/json:
1038
+ schema:
1039
+ $ref: '#/components/schemas/HTTPValidationError'
1040
+ security:
1041
+ - OAuth2PasswordBearer: []
1042
+ delete:
1043
+ tags:
1044
+ - agent_flows
1045
+ summary: Delete Agent Flow
1046
+ operationId: delete_agent_flow_api_v2_agent_flows__delete
1047
+ parameters:
1048
+ - required: true
1049
+ schema:
1050
+ type: integer
1051
+ title: Flow Id
1052
+ name: flow_id
1053
+ in: query
1054
+ responses:
1055
+ '204':
1056
+ description: Successful Response
1057
+ '404':
1058
+ description: Agent flow route not found
1059
+ '422':
1060
+ description: Validation Error
1061
+ content:
1062
+ application/json:
1063
+ schema:
1064
+ $ref: '#/components/schemas/HTTPValidationError'
1065
+ security:
1066
+ - OAuth2PasswordBearer: []
1067
+ /api/v2/prompts/:
1068
+ get:
1069
+ tags:
1070
+ - prompts
1071
+ summary: Get Prompt
1072
+ operationId: get_prompt_api_v2_prompts__get
1073
+ parameters:
1074
+ - required: false
1075
+ schema:
1076
+ type: integer
1077
+ title: Id
1078
+ name: id
1079
+ in: query
1080
+ - required: false
1081
+ schema:
1082
+ type: string
1083
+ title: Name
1084
+ name: name
1085
+ in: query
1086
+ - required: false
1087
+ schema:
1088
+ type: integer
1089
+ title: Ver
1090
+ name: ver
1091
+ in: query
1092
+ - required: false
1093
+ schema:
1094
+ type: integer
1095
+ title: Df Account Id
1096
+ name: df_account_id
1097
+ in: query
1098
+ - required: false
1099
+ schema:
1100
+ type: integer
1101
+ title: Flow Id
1102
+ name: flow_id
1103
+ in: query
1104
+ responses:
1105
+ '200':
1106
+ description: Successful Response
1107
+ content:
1108
+ application/json:
1109
+ schema:
1110
+ anyOf:
1111
+ - $ref: '#/components/schemas/PromptResponse'
1112
+ - items:
1113
+ $ref: '#/components/schemas/NonStagePromptResponse'
1114
+ type: array
1115
+ title: Response Get Prompt Api V2 Prompts Get
1116
+ '404':
1117
+ description: Prompts route not found
1118
+ '422':
1119
+ description: Validation Error
1120
+ content:
1121
+ application/json:
1122
+ schema:
1123
+ $ref: '#/components/schemas/HTTPValidationError'
1124
+ security:
1125
+ - OAuth2PasswordBearer: []
1126
+ post:
1127
+ tags:
1128
+ - prompts
1129
+ summary: Create Prompt
1130
+ operationId: create_prompt_api_v2_prompts__post
1131
+ requestBody:
1132
+ content:
1133
+ application/json:
1134
+ schema:
1135
+ $ref: '#/components/schemas/PromptCreate'
1136
+ required: true
1137
+ responses:
1138
+ '201':
1139
+ description: Successful Response
1140
+ content:
1141
+ application/json:
1142
+ schema:
1143
+ $ref: '#/components/schemas/PromptResponse'
1144
+ '404':
1145
+ description: Prompts route not found
1146
+ '422':
1147
+ description: Validation Error
1148
+ content:
1149
+ application/json:
1150
+ schema:
1151
+ $ref: '#/components/schemas/HTTPValidationError'
1152
+ security:
1153
+ - OAuth2PasswordBearer: []
1154
+ delete:
1155
+ tags:
1156
+ - prompts
1157
+ summary: Delete Prompt
1158
+ operationId: delete_prompt_api_v2_prompts__delete
1159
+ parameters:
1160
+ - required: true
1161
+ schema:
1162
+ type: integer
1163
+ title: Id
1164
+ name: id
1165
+ in: query
1166
+ responses:
1167
+ '204':
1168
+ description: Successful Response
1169
+ '404':
1170
+ description: Prompts route not found
1171
+ '422':
1172
+ description: Validation Error
1173
+ content:
1174
+ application/json:
1175
+ schema:
1176
+ $ref: '#/components/schemas/HTTPValidationError'
1177
+ security:
1178
+ - OAuth2PasswordBearer: []
1179
+ /api/v2/custom_workflow_buttons/:
1180
+ get:
1181
+ tags:
1182
+ - custom_workflow_buttons
1183
+ summary: Get Custom Workflow Buttons
1184
+ operationId: get_custom_workflow_buttons_api_v2_custom_workflow_buttons__get
1185
+ parameters:
1186
+ - required: true
1187
+ schema:
1188
+ type: integer
1189
+ title: Flow Id
1190
+ name: flow_id
1191
+ in: query
1192
+ - required: false
1193
+ schema:
1194
+ type: integer
1195
+ title: Stage Id
1196
+ name: stage_id
1197
+ in: query
1198
+ - required: false
1199
+ schema:
1200
+ type: string
1201
+ title: Stage Name
1202
+ name: stage_name
1203
+ in: query
1204
+ responses:
1205
+ '200':
1206
+ description: Successful Response
1207
+ content:
1208
+ application/json:
1209
+ schema:
1210
+ items:
1211
+ $ref: '#/components/schemas/CustomWorkflowButtonResponse'
1212
+ type: array
1213
+ title: Response Get Custom Workflow Buttons Api V2 Custom Workflow Buttons Get
1214
+ '404':
1215
+ description: Custom workflow buttons route not found
1216
+ '422':
1217
+ description: Validation Error
1218
+ content:
1219
+ application/json:
1220
+ schema:
1221
+ $ref: '#/components/schemas/HTTPValidationError'
1222
+ security:
1223
+ - OAuth2PasswordBearer: []
1224
+ /api/v2/stages/:
1225
+ get:
1226
+ tags:
1227
+ - stages
1228
+ summary: Get Stages
1229
+ operationId: get_stages_api_v2_stages__get
1230
+ parameters:
1231
+ - required: false
1232
+ schema:
1233
+ type: integer
1234
+ title: Stage Id
1235
+ name: stage_id
1236
+ in: query
1237
+ - required: false
1238
+ schema:
1239
+ type: integer
1240
+ title: Flow Id
1241
+ name: flow_id
1242
+ in: query
1243
+ - required: false
1244
+ schema:
1245
+ type: boolean
1246
+ title: Is Label
1247
+ default: false
1248
+ name: is_label
1249
+ in: query
1250
+ - required: false
1251
+ schema:
1252
+ type: boolean
1253
+ title: Is Selectable
1254
+ default: false
1255
+ name: is_selectable
1256
+ in: query
1257
+ responses:
1258
+ '200':
1259
+ description: Successful Response
1260
+ content:
1261
+ application/json:
1262
+ schema:
1263
+ anyOf:
1264
+ - $ref: '#/components/schemas/StageResponse'
1265
+ - $ref: '#/components/schemas/StageLabelResponse'
1266
+ - items:
1267
+ $ref: '#/components/schemas/StageResponse'
1268
+ type: array
1269
+ - items:
1270
+ $ref: '#/components/schemas/StageLabelResponse'
1271
+ type: array
1272
+ title: Response Get Stages Api V2 Stages Get
1273
+ '404':
1274
+ description: stages route not found
1275
+ '422':
1276
+ description: Validation Error
1277
+ content:
1278
+ application/json:
1279
+ schema:
1280
+ $ref: '#/components/schemas/HTTPValidationError'
1281
+ security:
1282
+ - OAuth2PasswordBearer: []
1283
+ put:
1284
+ tags:
1285
+ - stages
1286
+ summary: Update Stages
1287
+ operationId: update_stages_api_v2_stages__put
1288
+ parameters:
1289
+ - required: true
1290
+ schema:
1291
+ type: integer
1292
+ title: Stage Id
1293
+ name: stage_id
1294
+ in: query
1295
+ requestBody:
1296
+ content:
1297
+ application/json:
1298
+ schema:
1299
+ $ref: '#/components/schemas/StageUpdate'
1300
+ required: true
1301
+ responses:
1302
+ '200':
1303
+ description: Successful Response
1304
+ content:
1305
+ application/json:
1306
+ schema:
1307
+ $ref: '#/components/schemas/StageResponse'
1308
+ '404':
1309
+ description: stages route not found
1310
+ '422':
1311
+ description: Validation Error
1312
+ content:
1313
+ application/json:
1314
+ schema:
1315
+ $ref: '#/components/schemas/HTTPValidationError'
1316
+ security:
1317
+ - OAuth2PasswordBearer: []
1318
+ post:
1319
+ tags:
1320
+ - stages
1321
+ summary: Create Stages
1322
+ operationId: create_stages_api_v2_stages__post
1323
+ requestBody:
1324
+ content:
1325
+ application/json:
1326
+ schema:
1327
+ $ref: '#/components/schemas/StageCreate'
1328
+ required: true
1329
+ responses:
1330
+ '200':
1331
+ description: Successful Response
1332
+ content:
1333
+ application/json:
1334
+ schema:
1335
+ $ref: '#/components/schemas/StageResponse'
1336
+ '404':
1337
+ description: stages route not found
1338
+ '422':
1339
+ description: Validation Error
1340
+ content:
1341
+ application/json:
1342
+ schema:
1343
+ $ref: '#/components/schemas/HTTPValidationError'
1344
+ security:
1345
+ - OAuth2PasswordBearer: []
1346
+ delete:
1347
+ tags:
1348
+ - stages
1349
+ summary: Delete Stage
1350
+ operationId: delete_stage_api_v2_stages__delete
1351
+ parameters:
1352
+ - required: true
1353
+ schema:
1354
+ type: integer
1355
+ title: Stage Id
1356
+ name: stage_id
1357
+ in: query
1358
+ responses:
1359
+ '204':
1360
+ description: Successful Response
1361
+ '404':
1362
+ description: stages route not found
1363
+ '422':
1364
+ description: Validation Error
1365
+ content:
1366
+ application/json:
1367
+ schema:
1368
+ $ref: '#/components/schemas/HTTPValidationError'
1369
+ security:
1370
+ - OAuth2PasswordBearer: []
1371
+ /api/v2/ucc_flow/providers:
1372
+ post:
1373
+ tags:
1374
+ - ucc_flow
1375
+ summary: Providers
1376
+ operationId: providers_api_v2_ucc_flow_providers_post
1377
+ requestBody:
1378
+ content:
1379
+ multipart/form-data:
1380
+ schema:
1381
+ $ref: '#/components/schemas/Body_providers_api_v2_ucc_flow_providers_post'
1382
+ required: true
1383
+ responses:
1384
+ '200':
1385
+ description: Successful Response
1386
+ content:
1387
+ application/json:
1388
+ schema:
1389
+ $ref: '#/components/schemas/UCCProviderResponse'
1390
+ '404':
1391
+ description: UCC flow route not found
1392
+ '422':
1393
+ description: Validation Error
1394
+ content:
1395
+ application/json:
1396
+ schema:
1397
+ $ref: '#/components/schemas/HTTPValidationError'
1398
+ /api/v2/ucc_flow/:
1399
+ get:
1400
+ tags:
1401
+ - ucc_flow
1402
+ summary: Ucc Parser
1403
+ operationId: ucc_parser_api_v2_ucc_flow__get
1404
+ responses:
1405
+ '200':
1406
+ description: Successful Response
1407
+ content:
1408
+ application/json:
1409
+ schema: {}
1410
+ '404':
1411
+ description: UCC flow route not found
1412
+ post:
1413
+ tags:
1414
+ - ucc_flow
1415
+ summary: Process
1416
+ description: Processes an uploaded file, performs OCR, extracts sensitive data, detect the document type and data-mask the source if needed in order to complete a UCC file.
1417
+ operationId: process_api_v2_ucc_flow__post
1418
+ parameters:
1419
+ - required: false
1420
+ schema:
1421
+ type: boolean
1422
+ title: Use Crc32
1423
+ default: false
1424
+ name: use_crc32
1425
+ in: query
1426
+ requestBody:
1427
+ content:
1428
+ multipart/form-data:
1429
+ schema:
1430
+ $ref: '#/components/schemas/Body_process_api_v2_ucc_flow__post'
1431
+ required: true
1432
+ responses:
1433
+ '200':
1434
+ description: Successful Response
1435
+ content:
1436
+ application/json:
1437
+ schema:
1438
+ $ref: '#/components/schemas/UCCResponse'
1439
+ '404':
1440
+ description: UCC flow route not found
1441
+ '422':
1442
+ description: Validation Error
1443
+ content:
1444
+ application/json:
1445
+ schema:
1446
+ $ref: '#/components/schemas/HTTPValidationError'
1447
+ /api/v2/documents/sign-urls:
1448
+ post:
1449
+ tags:
1450
+ - documents
1451
+ summary: Create Get Urls
1452
+ description: |-
1453
+ Create pre-signed URLs for the given list of files.
1454
+
1455
+ This endpoint generates pre-signed URLs for retrieving files from a S3 bucket. Each file
1456
+ in the request will have its own unique URL and required fields.
1457
+ operationId: create_get_urls_api_v2_documents_sign_urls_post
1458
+ requestBody:
1459
+ content:
1460
+ application/json:
1461
+ schema:
1462
+ $ref: '#/components/schemas/GenerateSignedUrlRequest'
1463
+ required: true
1464
+ responses:
1465
+ '201':
1466
+ description: Successful Response
1467
+ content:
1468
+ application/json:
1469
+ schema:
1470
+ $ref: '#/components/schemas/GenerateSignedUrlResponse'
1471
+ '422':
1472
+ description: Validation Error
1473
+ content:
1474
+ application/json:
1475
+ schema:
1476
+ $ref: '#/components/schemas/HTTPValidationError'
1477
+ /api/v2/documents/upload-urls:
1478
+ post:
1479
+ tags:
1480
+ - documents
1481
+ summary: Create Upload Urls
1482
+ description: |-
1483
+ Create pre-signed upload URLs for the given list of files.
1484
+
1485
+ This endpoint generates pre-signed URLs for uploading files to an S3 bucket. Each file
1486
+ in the request will have its own unique URL and required fields for uploading.
1487
+ operationId: create_upload_urls_api_v2_documents_upload_urls_post
1488
+ requestBody:
1489
+ content:
1490
+ application/json:
1491
+ schema:
1492
+ $ref: '#/components/schemas/GenerateUploadUrlRequest'
1493
+ required: true
1494
+ responses:
1495
+ '201':
1496
+ description: Successful Response
1497
+ content:
1498
+ application/json:
1499
+ schema:
1500
+ $ref: '#/components/schemas/GenerateUploadUrlResponse'
1501
+ '422':
1502
+ description: Validation Error
1503
+ content:
1504
+ application/json:
1505
+ schema:
1506
+ $ref: '#/components/schemas/HTTPValidationError'
1507
+ /api/v2/documents/lambda-ocr:
1508
+ post:
1509
+ tags:
1510
+ - documents
1511
+ summary: Lambda Ocr
1512
+ description: |-
1513
+ Perform Optical Character Recognition (OCR) on a PDF file.
1514
+
1515
+ This endpoint processes a PDF file specified by the S3 URI in the request. It performs
1516
+ OCR on each page of the PDF, extracting text content. The function handles caching of
1517
+ both the original file and the OCR results to improve performance on subsequent requests
1518
+ for the same document.
1519
+ operationId: lambda_ocr_api_v2_documents_lambda_ocr_post
1520
+ requestBody:
1521
+ content:
1522
+ application/json:
1523
+ schema:
1524
+ $ref: '#/components/schemas/LambdaOcrDocumentRequest'
1525
+ required: true
1526
+ responses:
1527
+ '200':
1528
+ description: Successful Response
1529
+ content:
1530
+ application/json:
1531
+ schema:
1532
+ $ref: '#/components/schemas/LambdaOcrDocumentResponse'
1533
+ '422':
1534
+ description: Validation Error
1535
+ content:
1536
+ application/json:
1537
+ schema:
1538
+ $ref: '#/components/schemas/HTTPValidationError'
1539
+ /api/v2/documents/ucc:
1540
+ post:
1541
+ tags:
1542
+ - documents
1543
+ summary: Ucc
1544
+ operationId: ucc_api_v2_documents_ucc_post
1545
+ requestBody:
1546
+ content:
1547
+ application/json:
1548
+ schema:
1549
+ $ref: '#/components/schemas/UccDocumentRequest'
1550
+ required: true
1551
+ responses:
1552
+ '200':
1553
+ description: Successful Response
1554
+ content:
1555
+ application/json:
1556
+ schema:
1557
+ $ref: '#/components/schemas/UccDocumentResponse'
1558
+ '422':
1559
+ description: Validation Error
1560
+ content:
1561
+ application/json:
1562
+ schema:
1563
+ $ref: '#/components/schemas/HTTPValidationError'
1564
+ /api/v2/documents/providers:
1565
+ post:
1566
+ tags:
1567
+ - documents
1568
+ summary: Providers
1569
+ operationId: providers_api_v2_documents_providers_post
1570
+ requestBody:
1571
+ content:
1572
+ application/json:
1573
+ schema:
1574
+ $ref: '#/components/schemas/ProvidersDocumentRequest'
1575
+ required: true
1576
+ responses:
1577
+ '200':
1578
+ description: Successful Response
1579
+ content:
1580
+ application/json:
1581
+ schema:
1582
+ $ref: '#/components/schemas/ProvidersDocumentResponse'
1583
+ '422':
1584
+ description: Validation Error
1585
+ content:
1586
+ application/json:
1587
+ schema:
1588
+ $ref: '#/components/schemas/HTTPValidationError'
1589
+ /api/v2/documents/ocr:
1590
+ post:
1591
+ tags:
1592
+ - documents
1593
+ summary: Ocr
1594
+ operationId: ocr_api_v2_documents_ocr_post
1595
+ parameters:
1596
+ - required: false
1597
+ schema:
1598
+ allOf:
1599
+ - $ref: '#/components/schemas/OcrDocumentMode'
1600
+ default: saris
1601
+ name: mode
1602
+ in: query
1603
+ requestBody:
1604
+ content:
1605
+ multipart/form-data:
1606
+ schema:
1607
+ $ref: '#/components/schemas/Body_ocr_api_v2_documents_ocr_post'
1608
+ required: true
1609
+ responses:
1610
+ '200':
1611
+ description: Successful Response
1612
+ content:
1613
+ application/json:
1614
+ schema:
1615
+ $ref: '#/components/schemas/OcrDocumentResponse'
1616
+ '422':
1617
+ description: Validation Error
1618
+ content:
1619
+ application/json:
1620
+ schema:
1621
+ $ref: '#/components/schemas/HTTPValidationError'
1622
+ /api/v3/tasks/:
1623
+ get:
1624
+ tags:
1625
+ - tasks
1626
+ summary: Get Tasks
1627
+ operationId: get_tasks_api_v3_tasks__get
1628
+ parameters:
1629
+ - required: false
1630
+ schema:
1631
+ type: integer
1632
+ title: Task Id
1633
+ name: task_id
1634
+ in: query
1635
+ - required: false
1636
+ schema:
1637
+ type: integer
1638
+ title: User Id
1639
+ name: user_id
1640
+ in: query
1641
+ responses:
1642
+ '200':
1643
+ description: Successful Response
1644
+ content:
1645
+ application/json:
1646
+ schema:
1647
+ anyOf:
1648
+ - $ref: '#/components/schemas/TaskResponse'
1649
+ - items:
1650
+ $ref: '#/components/schemas/TaskResponse'
1651
+ type: array
1652
+ title: Response Get Tasks Api V3 Tasks Get
1653
+ '404':
1654
+ description: Task route not found
1655
+ '422':
1656
+ description: Validation Error
1657
+ content:
1658
+ application/json:
1659
+ schema:
1660
+ $ref: '#/components/schemas/HTTPValidationError'
1661
+ security:
1662
+ - OAuth2PasswordBearer: []
1663
+ post:
1664
+ tags:
1665
+ - tasks
1666
+ summary: Create Task
1667
+ operationId: create_task_api_v3_tasks__post
1668
+ requestBody:
1669
+ content:
1670
+ application/json:
1671
+ schema:
1672
+ $ref: '#/components/schemas/TaskCreate'
1673
+ required: true
1674
+ responses:
1675
+ '201':
1676
+ description: Successful Response
1677
+ content:
1678
+ application/json:
1679
+ schema:
1680
+ $ref: '#/components/schemas/TaskResponse'
1681
+ '404':
1682
+ description: Task route not found
1683
+ '422':
1684
+ description: Validation Error
1685
+ content:
1686
+ application/json:
1687
+ schema:
1688
+ $ref: '#/components/schemas/HTTPValidationError'
1689
+ security:
1690
+ - OAuth2PasswordBearer: []
1691
+ /api/auth/login:
1692
+ post:
1693
+ tags:
1694
+ - auth
1695
+ summary: Login
1696
+ description: Get the JWT for a user with data from OAuth2 request form body.
1697
+ operationId: login_api_auth_login_post
1698
+ requestBody:
1699
+ content:
1700
+ application/x-www-form-urlencoded:
1701
+ schema:
1702
+ $ref: '#/components/schemas/Body_login_api_auth_login_post'
1703
+ required: true
1704
+ responses:
1705
+ '200':
1706
+ description: Successful Response
1707
+ content:
1708
+ application/json:
1709
+ schema:
1710
+ title: Response Login Api Auth Login Post
1711
+ '404':
1712
+ description: Authentication route not found
1713
+ '422':
1714
+ description: Validation Error
1715
+ content:
1716
+ application/json:
1717
+ schema:
1718
+ $ref: '#/components/schemas/HTTPValidationError'
1719
+ delete:
1720
+ tags:
1721
+ - auth
1722
+ summary: Logout
1723
+ description: Logs out a user by invalidating his session.
1724
+ operationId: logout_api_auth_login_delete
1725
+ responses:
1726
+ '200':
1727
+ description: Successful Response
1728
+ content:
1729
+ application/json:
1730
+ schema: {}
1731
+ '404':
1732
+ description: Authentication route not found
1733
+ security:
1734
+ - OAuth2PasswordBearer: []
1735
+ /api/health:
1736
+ get:
1737
+ tags:
1738
+ - health
1739
+ summary: Health Check
1740
+ description: Get the current API health.
1741
+ operationId: health_check_api_health_get
1742
+ responses:
1743
+ '200':
1744
+ description: Successful Response
1745
+ content:
1746
+ application/json:
1747
+ schema:
1748
+ $ref: '#/components/schemas/HealthCheckResponse'
1749
+ components:
1750
+ schemas:
1751
+ AccessLevel:
1752
+ type: integer
1753
+ enum:
1754
+ - -1
1755
+ - 0
1756
+ - 1
1757
+ - 2
1758
+ title: AccessLevel
1759
+ description: An enumeration.
1760
+ AgentFlowV2Create:
1761
+ properties:
1762
+ name:
1763
+ type: string
1764
+ title: Name
1765
+ data:
1766
+ additionalProperties:
1767
+ $ref: '#/components/schemas/StageData'
1768
+ type: object
1769
+ title: Data
1770
+ status:
1771
+ type: integer
1772
+ title: Status
1773
+ ver:
1774
+ type: integer
1775
+ title: Ver
1776
+ customer_id:
1777
+ type: integer
1778
+ title: Customer Id
1779
+ flow_type:
1780
+ $ref: '#/components/schemas/FlowType'
1781
+ exec_mode:
1782
+ $ref: '#/components/schemas/ExecMode'
1783
+ type: object
1784
+ required:
1785
+ - name
1786
+ - data
1787
+ - status
1788
+ title: AgentFlowV2Create
1789
+ AgentFlowV2Response:
1790
+ properties:
1791
+ id:
1792
+ type: integer
1793
+ title: Id
1794
+ name:
1795
+ type: string
1796
+ title: Name
1797
+ ver:
1798
+ type: integer
1799
+ title: Ver
1800
+ data:
1801
+ additionalProperties:
1802
+ $ref: '#/components/schemas/StageData'
1803
+ type: object
1804
+ title: Data
1805
+ status:
1806
+ type: integer
1807
+ title: Status
1808
+ customer_id:
1809
+ type: integer
1810
+ title: Customer Id
1811
+ flow_type:
1812
+ $ref: '#/components/schemas/FlowType'
1813
+ exec_mode:
1814
+ $ref: '#/components/schemas/ExecMode'
1815
+ time_created:
1816
+ type: integer
1817
+ title: Time Created
1818
+ type: object
1819
+ required:
1820
+ - id
1821
+ - name
1822
+ - ver
1823
+ - data
1824
+ - status
1825
+ - customer_id
1826
+ - flow_type
1827
+ - exec_mode
1828
+ title: AgentFlowV2Response
1829
+ Body_login_api_auth_login_post:
1830
+ properties:
1831
+ grant_type:
1832
+ type: string
1833
+ pattern: password
1834
+ title: Grant Type
1835
+ username:
1836
+ type: string
1837
+ title: Username
1838
+ password:
1839
+ type: string
1840
+ title: Password
1841
+ scope:
1842
+ type: string
1843
+ title: Scope
1844
+ default: ''
1845
+ client_id:
1846
+ type: string
1847
+ title: Client Id
1848
+ client_secret:
1849
+ type: string
1850
+ title: Client Secret
1851
+ type: object
1852
+ required:
1853
+ - username
1854
+ - password
1855
+ title: Body_login_api_auth_login_post
1856
+ Body_ocr_api_v2_documents_ocr_post:
1857
+ properties:
1858
+ file:
1859
+ type: string
1860
+ format: binary
1861
+ title: File
1862
+ type: object
1863
+ required:
1864
+ - file
1865
+ title: Body_ocr_api_v2_documents_ocr_post
1866
+ Body_process_api_v2_ucc_flow__post:
1867
+ properties:
1868
+ file:
1869
+ type: string
1870
+ format: binary
1871
+ title: File
1872
+ type: object
1873
+ required:
1874
+ - file
1875
+ title: Body_process_api_v2_ucc_flow__post
1876
+ Body_providers_api_v2_ucc_flow_providers_post:
1877
+ properties:
1878
+ files:
1879
+ items:
1880
+ type: string
1881
+ format: binary
1882
+ type: array
1883
+ title: Files
1884
+ merchant_name:
1885
+ type: string
1886
+ title: Merchant Name
1887
+ value:
1888
+ type: string
1889
+ title: Value
1890
+ client_name:
1891
+ type: string
1892
+ title: Client Name
1893
+ df_case_number:
1894
+ type: string
1895
+ title: Df Case Number
1896
+ merchant_address:
1897
+ type: string
1898
+ title: Merchant Address
1899
+ type: object
1900
+ required:
1901
+ - files
1902
+ - merchant_name
1903
+ - value
1904
+ - client_name
1905
+ - df_case_number
1906
+ - merchant_address
1907
+ title: Body_providers_api_v2_ucc_flow_providers_post
1908
+ ChannelType:
1909
+ type: integer
1910
+ enum:
1911
+ - 0
1912
+ - 1
1913
+ title: ChannelType
1914
+ description: An enumeration.
1915
+ ConversationCreate:
1916
+ properties:
1917
+ df_account_id:
1918
+ type: integer
1919
+ title: Df Account Id
1920
+ ml_model:
1921
+ type: integer
1922
+ title: Ml Model
1923
+ flow_id:
1924
+ type: integer
1925
+ title: Flow Id
1926
+ duplicate:
1927
+ type: integer
1928
+ title: Duplicate
1929
+ default: 0
1930
+ channel_type:
1931
+ allOf:
1932
+ - $ref: '#/components/schemas/ChannelType'
1933
+ default: 0
1934
+ external_id:
1935
+ type: string
1936
+ title: External Id
1937
+ type: object
1938
+ required:
1939
+ - df_account_id
1940
+ title: ConversationCreate
1941
+ ConversationResponse:
1942
+ properties:
1943
+ id:
1944
+ type: integer
1945
+ title: Id
1946
+ user_id:
1947
+ type: integer
1948
+ title: User Id
1949
+ df_account_id:
1950
+ type: integer
1951
+ title: Df Account Id
1952
+ flow_id:
1953
+ type: integer
1954
+ title: Flow Id
1955
+ ml_model:
1956
+ type: integer
1957
+ title: Ml Model
1958
+ current_stage_info:
1959
+ $ref: '#/components/schemas/CurrentStageInfo'
1960
+ num_input_tokens_used:
1961
+ type: integer
1962
+ title: Num Input Tokens Used
1963
+ num_output_tokens_used:
1964
+ type: integer
1965
+ title: Num Output Tokens Used
1966
+ num_messages:
1967
+ type: integer
1968
+ title: Num Messages
1969
+ duplicate:
1970
+ type: integer
1971
+ title: Duplicate
1972
+ channel_type:
1973
+ $ref: '#/components/schemas/ChannelType'
1974
+ external_id:
1975
+ type: string
1976
+ title: External Id
1977
+ last_message_time:
1978
+ type: integer
1979
+ title: Last Message Time
1980
+ time_created:
1981
+ type: integer
1982
+ title: Time Created
1983
+ type: object
1984
+ required:
1985
+ - id
1986
+ - user_id
1987
+ - df_account_id
1988
+ - flow_id
1989
+ - current_stage_info
1990
+ - num_messages
1991
+ - channel_type
1992
+ title: ConversationResponse
1993
+ ConversationStateLogCreate:
1994
+ properties:
1995
+ conversation_id:
1996
+ type: integer
1997
+ title: Conversation Id
1998
+ stage_info:
1999
+ $ref: '#/components/schemas/CurrentStageInfo'
2000
+ message_id:
2001
+ type: integer
2002
+ title: Message Id
2003
+ default: 0
2004
+ transition_reason:
2005
+ $ref: '#/components/schemas/TransitionReason'
2006
+ type: object
2007
+ required:
2008
+ - conversation_id
2009
+ - stage_info
2010
+ - transition_reason
2011
+ title: ConversationStateLogCreate
2012
+ ConversationStateLogResponse:
2013
+ properties:
2014
+ id:
2015
+ type: integer
2016
+ title: Id
2017
+ conversation_id:
2018
+ type: integer
2019
+ title: Conversation Id
2020
+ stage_info:
2021
+ $ref: '#/components/schemas/CurrentStageInfo'
2022
+ message_id:
2023
+ type: integer
2024
+ title: Message Id
2025
+ default: 0
2026
+ transition_reason:
2027
+ $ref: '#/components/schemas/TransitionReason'
2028
+ time_created:
2029
+ type: integer
2030
+ title: Time Created
2031
+ type: object
2032
+ required:
2033
+ - id
2034
+ - conversation_id
2035
+ - stage_info
2036
+ - transition_reason
2037
+ title: ConversationStateLogResponse
2038
+ ConversationUpdate:
2039
+ properties:
2040
+ ml_model:
2041
+ type: integer
2042
+ title: Ml Model
2043
+ flow_id:
2044
+ type: integer
2045
+ title: Flow Id
2046
+ external_id:
2047
+ type: string
2048
+ title: External Id
2049
+ current_stage_info:
2050
+ $ref: '#/components/schemas/CurrentStageInfo'
2051
+ num_input_tokens_used:
2052
+ type: integer
2053
+ title: Num Input Tokens Used
2054
+ num_output_tokens_used:
2055
+ type: integer
2056
+ title: Num Output Tokens Used
2057
+ last_message_time:
2058
+ type: integer
2059
+ title: Last Message Time
2060
+ transition_reason:
2061
+ allOf:
2062
+ - $ref: '#/components/schemas/TransitionReason'
2063
+ default: manual_transition
2064
+ type: object
2065
+ title: ConversationUpdate
2066
+ CreatePresignedPostFieldsResponse:
2067
+ properties:
2068
+ key:
2069
+ type: string
2070
+ title: Key
2071
+ AWSAccessKeyId:
2072
+ type: string
2073
+ title: Awsaccesskeyid
2074
+ policy:
2075
+ type: string
2076
+ title: Policy
2077
+ signature:
2078
+ type: string
2079
+ title: Signature
2080
+ type: object
2081
+ required:
2082
+ - key
2083
+ - AWSAccessKeyId
2084
+ - policy
2085
+ - signature
2086
+ title: CreatePresignedPostFieldsResponse
2087
+ CurrentStageInfo:
2088
+ properties:
2089
+ name:
2090
+ type: string
2091
+ title: Name
2092
+ id:
2093
+ type: integer
2094
+ title: Id
2095
+ count:
2096
+ type: integer
2097
+ title: Count
2098
+ default: 0
2099
+ type: object
2100
+ title: CurrentStageInfo
2101
+ CustomWorkflowButtonResponse:
2102
+ properties:
2103
+ name:
2104
+ type: string
2105
+ title: Name
2106
+ type: object
2107
+ required:
2108
+ - name
2109
+ title: CustomWorkflowButtonResponse
2110
+ CustomerID:
2111
+ type: integer
2112
+ enum:
2113
+ - 1
2114
+ - 3
2115
+ title: CustomerID
2116
+ description: An enumeration.
2117
+ CustomerResponse:
2118
+ properties:
2119
+ id:
2120
+ $ref: '#/components/schemas/CustomerID'
2121
+ name:
2122
+ type: string
2123
+ title: Name
2124
+ email_domain:
2125
+ type: string
2126
+ title: Email Domain
2127
+ type: object
2128
+ required:
2129
+ - id
2130
+ - name
2131
+ - email_domain
2132
+ title: CustomerResponse
2133
+ DFAccountResponse:
2134
+ properties:
2135
+ id:
2136
+ type: integer
2137
+ title: Id
2138
+ df_internal_id:
2139
+ type: string
2140
+ title: Df Internal Id
2141
+ df_case_number:
2142
+ type: string
2143
+ title: Df Case Number
2144
+ name:
2145
+ type: string
2146
+ title: Name
2147
+ client_name:
2148
+ type: string
2149
+ title: Client Name
2150
+ debtor_company_name:
2151
+ type: string
2152
+ title: Debtor Company Name
2153
+ debtor_contact_name:
2154
+ type: string
2155
+ title: Debtor Contact Name
2156
+ collector_user_name:
2157
+ type: string
2158
+ title: Collector User Name
2159
+ original_claim_amount_cent:
2160
+ type: integer
2161
+ title: Original Claim Amount Cent
2162
+ total_paid_amount_cent:
2163
+ type: integer
2164
+ title: Total Paid Amount Cent
2165
+ current_balance_due_cent:
2166
+ type: integer
2167
+ title: Current Balance Due Cent
2168
+ dcri_score:
2169
+ type: integer
2170
+ title: Dcri Score
2171
+ sif_threshold_pct:
2172
+ type: integer
2173
+ title: Sif Threshold Pct
2174
+ sif_timeframe_days:
2175
+ type: integer
2176
+ title: Sif Timeframe Days
2177
+ sif_additional_params:
2178
+ type: string
2179
+ title: Sif Additional Params
2180
+ last_work_date:
2181
+ type: string
2182
+ format: date-time
2183
+ title: Last Work Date
2184
+ next_scheduled_payment_amount_cent:
2185
+ type: integer
2186
+ title: Next Scheduled Payment Amount Cent
2187
+ next_scheduled_payment_date:
2188
+ type: string
2189
+ format: date-time
2190
+ title: Next Scheduled Payment Date
2191
+ current_status:
2192
+ type: string
2193
+ title: Current Status
2194
+ is_real:
2195
+ type: boolean
2196
+ title: Is Real
2197
+ phone_numbers:
2198
+ items: {}
2199
+ type: array
2200
+ title: Phone Numbers
2201
+ default: []
2202
+ time_received:
2203
+ type: integer
2204
+ title: Time Received
2205
+ time_created:
2206
+ type: integer
2207
+ title: Time Created
2208
+ type: object
2209
+ required:
2210
+ - id
2211
+ - df_internal_id
2212
+ - df_case_number
2213
+ - name
2214
+ - client_name
2215
+ - debtor_company_name
2216
+ - debtor_contact_name
2217
+ - collector_user_name
2218
+ - original_claim_amount_cent
2219
+ - total_paid_amount_cent
2220
+ - current_balance_due_cent
2221
+ - dcri_score
2222
+ - sif_threshold_pct
2223
+ - sif_timeframe_days
2224
+ - sif_additional_params
2225
+ - last_work_date
2226
+ - next_scheduled_payment_amount_cent
2227
+ - next_scheduled_payment_date
2228
+ - current_status
2229
+ - is_real
2230
+ title: DFAccountResponse
2231
+ DevMetadata:
2232
+ properties:
2233
+ input_schema:
2234
+ type: object
2235
+ title: Input Schema
2236
+ default: {}
2237
+ output_schema:
2238
+ type: object
2239
+ title: Output Schema
2240
+ default: {}
2241
+ type: object
2242
+ title: DevMetadata
2243
+ EmailAddress:
2244
+ properties:
2245
+ name:
2246
+ type: string
2247
+ title: Name
2248
+ address:
2249
+ type: string
2250
+ format: email
2251
+ title: Address
2252
+ type: object
2253
+ required:
2254
+ - name
2255
+ - address
2256
+ title: EmailAddress
2257
+ EmailMessageCreate:
2258
+ properties:
2259
+ conversation_id:
2260
+ type: integer
2261
+ title: Conversation Id
2262
+ inbox_address:
2263
+ $ref: '#/components/schemas/EmailAddress'
2264
+ from_address:
2265
+ $ref: '#/components/schemas/EmailAddress'
2266
+ to_addresses:
2267
+ items:
2268
+ $ref: '#/components/schemas/EmailAddress'
2269
+ type: array
2270
+ title: To Addresses
2271
+ default: []
2272
+ cc_addresses:
2273
+ items:
2274
+ $ref: '#/components/schemas/EmailAddress'
2275
+ type: array
2276
+ title: Cc Addresses
2277
+ default: []
2278
+ subject:
2279
+ type: string
2280
+ title: Subject
2281
+ body:
2282
+ type: string
2283
+ title: Body
2284
+ is_edited:
2285
+ type: boolean
2286
+ title: Is Edited
2287
+ default: false
2288
+ role:
2289
+ $ref: '#/components/schemas/Role'
2290
+ raw_gen_message_id:
2291
+ type: integer
2292
+ title: Raw Gen Message Id
2293
+ default: 0
2294
+ current_stage_id:
2295
+ type: integer
2296
+ title: Current Stage Id
2297
+ tone:
2298
+ type: string
2299
+ title: Tone
2300
+ parent_email_msg_id:
2301
+ type: integer
2302
+ title: Parent Email Msg Id
2303
+ num_attachments:
2304
+ type: integer
2305
+ title: Num Attachments
2306
+ time_sent:
2307
+ type: integer
2308
+ title: Time Sent
2309
+ external_id:
2310
+ type: string
2311
+ title: External Id
2312
+ body_html:
2313
+ type: string
2314
+ title: Body Html
2315
+ feedback:
2316
+ $ref: '#/components/schemas/MessageEditFeedbackModel'
2317
+ type: object
2318
+ required:
2319
+ - conversation_id
2320
+ - role
2321
+ title: EmailMessageCreate
2322
+ EmailMessageResponse:
2323
+ properties:
2324
+ id:
2325
+ type: integer
2326
+ title: Id
2327
+ conversation_id:
2328
+ type: integer
2329
+ title: Conversation Id
2330
+ inbox_address:
2331
+ $ref: '#/components/schemas/EmailAddress'
2332
+ from_address:
2333
+ $ref: '#/components/schemas/EmailAddress'
2334
+ to_addresses:
2335
+ items:
2336
+ $ref: '#/components/schemas/EmailAddress'
2337
+ type: array
2338
+ title: To Addresses
2339
+ cc_addresses:
2340
+ items:
2341
+ $ref: '#/components/schemas/EmailAddress'
2342
+ type: array
2343
+ title: Cc Addresses
2344
+ subject:
2345
+ type: string
2346
+ title: Subject
2347
+ body:
2348
+ type: string
2349
+ title: Body
2350
+ is_edited:
2351
+ type: boolean
2352
+ title: Is Edited
2353
+ default: false
2354
+ role:
2355
+ $ref: '#/components/schemas/Role'
2356
+ raw_gen_message_id:
2357
+ type: integer
2358
+ title: Raw Gen Message Id
2359
+ default: 0
2360
+ current_stage_id:
2361
+ type: integer
2362
+ title: Current Stage Id
2363
+ tone:
2364
+ type: string
2365
+ title: Tone
2366
+ default: ''
2367
+ parent_email_msg_id:
2368
+ type: integer
2369
+ title: Parent Email Msg Id
2370
+ default: 0
2371
+ num_attachments:
2372
+ type: integer
2373
+ title: Num Attachments
2374
+ default: 0
2375
+ external_id:
2376
+ type: string
2377
+ title: External Id
2378
+ default: ''
2379
+ time_sent:
2380
+ type: integer
2381
+ title: Time Sent
2382
+ time_created:
2383
+ type: integer
2384
+ title: Time Created
2385
+ feedback:
2386
+ $ref: '#/components/schemas/MessageEditFeedbackModel'
2387
+ type: object
2388
+ required:
2389
+ - id
2390
+ - conversation_id
2391
+ - subject
2392
+ - body
2393
+ - role
2394
+ title: EmailMessageResponse
2395
+ EmailMessageUpdate:
2396
+ properties:
2397
+ inbox_address:
2398
+ $ref: '#/components/schemas/EmailAddress'
2399
+ from_address:
2400
+ $ref: '#/components/schemas/EmailAddress'
2401
+ to_addresses:
2402
+ items: {}
2403
+ type: array
2404
+ title: To Addresses
2405
+ cc_addresses:
2406
+ items: {}
2407
+ type: array
2408
+ title: Cc Addresses
2409
+ subject:
2410
+ type: string
2411
+ title: Subject
2412
+ body:
2413
+ type: string
2414
+ title: Body
2415
+ is_edited:
2416
+ type: boolean
2417
+ title: Is Edited
2418
+ default: false
2419
+ role:
2420
+ $ref: '#/components/schemas/Role'
2421
+ raw_gen_message_id:
2422
+ type: integer
2423
+ title: Raw Gen Message Id
2424
+ current_stage_id:
2425
+ type: integer
2426
+ title: Current Stage Id
2427
+ tone:
2428
+ type: string
2429
+ title: Tone
2430
+ parent_email_msg_id:
2431
+ type: integer
2432
+ title: Parent Email Msg Id
2433
+ num_attachments:
2434
+ type: integer
2435
+ title: Num Attachments
2436
+ external_id:
2437
+ type: string
2438
+ title: External Id
2439
+ time_sent:
2440
+ type: integer
2441
+ title: Time Sent
2442
+ feedback:
2443
+ $ref: '#/components/schemas/MessageEditFeedbackModel'
2444
+ type: object
2445
+ title: EmailMessageUpdate
2446
+ ExecMode:
2447
+ type: integer
2448
+ enum:
2449
+ - 1
2450
+ - 2
2451
+ title: ExecMode
2452
+ description: An enumeration.
2453
+ FlowType:
2454
+ type: integer
2455
+ enum:
2456
+ - 1
2457
+ - 2
2458
+ title: FlowType
2459
+ description: An enumeration.
2460
+ GenerateSignedUrl:
2461
+ properties:
2462
+ uri:
2463
+ type: string
2464
+ title: Uri
2465
+ signed_url:
2466
+ type: string
2467
+ title: Signed Url
2468
+ type: object
2469
+ required:
2470
+ - uri
2471
+ - signed_url
2472
+ title: GenerateSignedUrl
2473
+ description: Model for representing an signed URL and its associated fields.
2474
+ GenerateSignedUrlRequest:
2475
+ properties:
2476
+ uris:
2477
+ items:
2478
+ type: string
2479
+ type: array
2480
+ title: Uris
2481
+ default: []
2482
+ type: object
2483
+ title: GenerateSignedUrlRequest
2484
+ description: Request model for generating signed URLs.
2485
+ GenerateSignedUrlResponse:
2486
+ properties:
2487
+ signed_urls:
2488
+ items:
2489
+ $ref: '#/components/schemas/GenerateSignedUrl'
2490
+ type: array
2491
+ title: Signed Urls
2492
+ default: []
2493
+ type: object
2494
+ title: GenerateSignedUrlResponse
2495
+ description: Response model for returning signed Signed URLs.
2496
+ GenerateUploadUrl:
2497
+ properties:
2498
+ source_name:
2499
+ type: string
2500
+ title: Source Name
2501
+ s3_object:
2502
+ $ref: '#/components/schemas/TargetS3Object'
2503
+ upload_request:
2504
+ $ref: '#/components/schemas/UploadToS3Request'
2505
+ type: object
2506
+ required:
2507
+ - source_name
2508
+ - s3_object
2509
+ - upload_request
2510
+ title: GenerateUploadUrl
2511
+ description: Model for representing an upload URL and its associated fields.
2512
+ GenerateUploadUrlRequest:
2513
+ properties:
2514
+ files:
2515
+ items:
2516
+ type: string
2517
+ type: array
2518
+ title: Files
2519
+ default: []
2520
+ type: object
2521
+ title: GenerateUploadUrlRequest
2522
+ description: Request model for generating upload URLs.
2523
+ GenerateUploadUrlResponse:
2524
+ properties:
2525
+ upload_urls:
2526
+ items:
2527
+ $ref: '#/components/schemas/GenerateUploadUrl'
2528
+ type: array
2529
+ title: Upload Urls
2530
+ default: []
2531
+ type: object
2532
+ title: GenerateUploadUrlResponse
2533
+ description: Response model for returning generated upload URLs.
2534
+ GeneratedMessageCreate:
2535
+ properties:
2536
+ conversation_id:
2537
+ type: integer
2538
+ title: Conversation Id
2539
+ default: 0
2540
+ type:
2541
+ allOf:
2542
+ - $ref: '#/components/schemas/GeneratedMessageType'
2543
+ default: 1
2544
+ body:
2545
+ type: string
2546
+ title: Body
2547
+ tone:
2548
+ type: string
2549
+ title: Tone
2550
+ do_regenerate:
2551
+ type: boolean
2552
+ title: Do Regenerate
2553
+ default: false
2554
+ custom_workflow:
2555
+ type: string
2556
+ title: Custom Workflow
2557
+ partial_span:
2558
+ $ref: '#/components/schemas/PartialMessageSpan'
2559
+ partial_ref_message_id:
2560
+ type: integer
2561
+ title: Partial Ref Message Id
2562
+ test_only:
2563
+ type: boolean
2564
+ title: Test Only
2565
+ default: false
2566
+ trigger_src:
2567
+ allOf:
2568
+ - $ref: '#/components/schemas/GeneratedMessageTriggerSource'
2569
+ default: 0
2570
+ feedback:
2571
+ $ref: '#/components/schemas/MessageEditFeedbackModel'
2572
+ type: object
2573
+ title: GeneratedMessageCreate
2574
+ GeneratedMessageResponse:
2575
+ properties:
2576
+ id:
2577
+ type: integer
2578
+ title: Id
2579
+ conversation_id:
2580
+ type: integer
2581
+ title: Conversation Id
2582
+ user_id:
2583
+ type: integer
2584
+ title: User Id
2585
+ body:
2586
+ type: string
2587
+ title: Body
2588
+ current_stage_id:
2589
+ type: integer
2590
+ title: Current Stage Id
2591
+ prompt_content:
2592
+ type: string
2593
+ title: Prompt Content
2594
+ dev_info:
2595
+ type: object
2596
+ title: Dev Info
2597
+ tone:
2598
+ type: string
2599
+ title: Tone
2600
+ type:
2601
+ $ref: '#/components/schemas/GeneratedMessageType'
2602
+ trigger_src:
2603
+ $ref: '#/components/schemas/GeneratedMessageTriggerSource'
2604
+ channel_type:
2605
+ $ref: '#/components/schemas/ChannelType'
2606
+ time_created:
2607
+ type: integer
2608
+ title: Time Created
2609
+ feedback:
2610
+ $ref: '#/components/schemas/MessageEditFeedbackModel'
2611
+ type: object
2612
+ required:
2613
+ - id
2614
+ - conversation_id
2615
+ - user_id
2616
+ - body
2617
+ - current_stage_id
2618
+ - dev_info
2619
+ - tone
2620
+ - type
2621
+ - trigger_src
2622
+ - channel_type
2623
+ title: GeneratedMessageResponse
2624
+ GeneratedMessageTriggerSource:
2625
+ type: integer
2626
+ enum:
2627
+ - 0
2628
+ - 1
2629
+ - 2
2630
+ - 3
2631
+ title: GeneratedMessageTriggerSource
2632
+ description: An enumeration.
2633
+ GeneratedMessageType:
2634
+ type: integer
2635
+ enum:
2636
+ - 1
2637
+ - 2
2638
+ - 3
2639
+ - 4
2640
+ title: GeneratedMessageType
2641
+ description: An enumeration.
2642
+ GeneratedMessageUpdate:
2643
+ properties:
2644
+ message_id:
2645
+ type: integer
2646
+ title: Message Id
2647
+ type:
2648
+ allOf:
2649
+ - $ref: '#/components/schemas/GeneratedMessageType'
2650
+ default: 1
2651
+ body:
2652
+ type: string
2653
+ title: Body
2654
+ tone:
2655
+ type: string
2656
+ title: Tone
2657
+ feedback:
2658
+ $ref: '#/components/schemas/MessageEditFeedbackModel'
2659
+ type: object
2660
+ required:
2661
+ - message_id
2662
+ title: GeneratedMessageUpdate
2663
+ HTTPValidationError:
2664
+ properties:
2665
+ detail:
2666
+ items:
2667
+ $ref: '#/components/schemas/ValidationError'
2668
+ type: array
2669
+ title: Detail
2670
+ type: object
2671
+ title: HTTPValidationError
2672
+ HealthCheckResponse:
2673
+ properties:
2674
+ status:
2675
+ type: string
2676
+ title: Status
2677
+ default: OK
2678
+ type: object
2679
+ title: HealthCheckResponse
2680
+ description: Response model to validate and return when performing a health check.
2681
+ LambdaOcrDocumentRequest:
2682
+ properties:
2683
+ uri:
2684
+ type: string
2685
+ title: Uri
2686
+ cache:
2687
+ type: boolean
2688
+ title: Cache
2689
+ default: false
2690
+ type: object
2691
+ required:
2692
+ - uri
2693
+ title: LambdaOcrDocumentRequest
2694
+ LambdaOcrDocumentResponse:
2695
+ properties:
2696
+ pages:
2697
+ items:
2698
+ type: string
2699
+ type: array
2700
+ title: Pages
2701
+ default: []
2702
+ type: object
2703
+ title: LambdaOcrDocumentResponse
2704
+ MessageCreate:
2705
+ properties:
2706
+ conversation_id:
2707
+ type: integer
2708
+ title: Conversation Id
2709
+ body:
2710
+ type: string
2711
+ title: Body
2712
+ is_edited:
2713
+ type: boolean
2714
+ title: Is Edited
2715
+ default: false
2716
+ role:
2717
+ $ref: '#/components/schemas/Role'
2718
+ raw_gen_message_id:
2719
+ type: integer
2720
+ title: Raw Gen Message Id
2721
+ default: 0
2722
+ time_sent:
2723
+ type: integer
2724
+ title: Time Sent
2725
+ external_id:
2726
+ type: string
2727
+ title: External Id
2728
+ default: ''
2729
+ feedback:
2730
+ $ref: '#/components/schemas/MessageEditFeedbackModel'
2731
+ type: object
2732
+ required:
2733
+ - conversation_id
2734
+ - role
2735
+ title: MessageCreate
2736
+ MessageEditFeedbackModel:
2737
+ properties:
2738
+ feedback:
2739
+ type: string
2740
+ title: Feedback
2741
+ type: object
2742
+ title: MessageEditFeedbackModel
2743
+ MessageResponse:
2744
+ properties:
2745
+ id:
2746
+ type: integer
2747
+ title: Id
2748
+ conversation_id:
2749
+ type: integer
2750
+ title: Conversation Id
2751
+ body:
2752
+ type: string
2753
+ title: Body
2754
+ current_stage_id:
2755
+ type: integer
2756
+ title: Current Stage Id
2757
+ role:
2758
+ $ref: '#/components/schemas/Role'
2759
+ is_edited:
2760
+ type: boolean
2761
+ title: Is Edited
2762
+ default: false
2763
+ raw_gen_message_id:
2764
+ type: integer
2765
+ title: Raw Gen Message Id
2766
+ default: 0
2767
+ external_id:
2768
+ type: string
2769
+ title: External Id
2770
+ default: ''
2771
+ time_sent:
2772
+ type: integer
2773
+ title: Time Sent
2774
+ time_created:
2775
+ type: integer
2776
+ title: Time Created
2777
+ feedback:
2778
+ $ref: '#/components/schemas/MessageEditFeedbackModel'
2779
+ type: object
2780
+ required:
2781
+ - id
2782
+ - conversation_id
2783
+ - body
2784
+ - current_stage_id
2785
+ - role
2786
+ title: MessageResponse
2787
+ MessageUpdate:
2788
+ properties:
2789
+ body:
2790
+ type: string
2791
+ title: Body
2792
+ is_edited:
2793
+ type: boolean
2794
+ title: Is Edited
2795
+ default: false
2796
+ time_sent:
2797
+ type: integer
2798
+ title: Time Sent
2799
+ external_id:
2800
+ type: string
2801
+ title: External Id
2802
+ feedback:
2803
+ $ref: '#/components/schemas/MessageEditFeedbackModel'
2804
+ type: object
2805
+ title: MessageUpdate
2806
+ ModelSelectorResponse:
2807
+ properties:
2808
+ model_name:
2809
+ type: string
2810
+ title: Model Name
2811
+ id:
2812
+ type: integer
2813
+ title: Id
2814
+ type: object
2815
+ required:
2816
+ - model_name
2817
+ - id
2818
+ title: ModelSelectorResponse
2819
+ NonStagePromptResponse:
2820
+ properties:
2821
+ id:
2822
+ type: integer
2823
+ title: Id
2824
+ name:
2825
+ type: string
2826
+ title: Name
2827
+ ver:
2828
+ type: integer
2829
+ title: Ver
2830
+ type:
2831
+ $ref: '#/components/schemas/PromptType'
2832
+ time_created:
2833
+ type: integer
2834
+ title: Time Created
2835
+ type: object
2836
+ required:
2837
+ - id
2838
+ - name
2839
+ - ver
2840
+ - type
2841
+ title: NonStagePromptResponse
2842
+ OcrDocumentMode:
2843
+ type: string
2844
+ enum:
2845
+ - regular
2846
+ - saris
2847
+ title: OcrDocumentMode
2848
+ description: An enumeration.
2849
+ OcrDocumentResponse:
2850
+ properties:
2851
+ mode:
2852
+ $ref: '#/components/schemas/OcrDocumentMode'
2853
+ file_size:
2854
+ type: integer
2855
+ title: File Size
2856
+ filename:
2857
+ type: string
2858
+ title: Filename
2859
+ extension:
2860
+ type: string
2861
+ title: Extension
2862
+ execution_time:
2863
+ type: number
2864
+ title: Execution Time
2865
+ should_convert_for_ocr:
2866
+ type: boolean
2867
+ title: Should Convert For Ocr
2868
+ pages:
2869
+ items:
2870
+ type: object
2871
+ type: array
2872
+ title: Pages
2873
+ type: object
2874
+ required:
2875
+ - mode
2876
+ - file_size
2877
+ - filename
2878
+ - extension
2879
+ - execution_time
2880
+ - should_convert_for_ocr
2881
+ - pages
2882
+ title: OcrDocumentResponse
2883
+ PartialMessageSpan:
2884
+ properties:
2885
+ start:
2886
+ type: integer
2887
+ title: Start
2888
+ end:
2889
+ type: integer
2890
+ title: End
2891
+ type: object
2892
+ required:
2893
+ - start
2894
+ - end
2895
+ title: PartialMessageSpan
2896
+ PromptBlock:
2897
+ properties:
2898
+ id:
2899
+ type: integer
2900
+ title: Id
2901
+ name:
2902
+ type: string
2903
+ title: Name
2904
+ ver:
2905
+ type: integer
2906
+ title: Ver
2907
+ rank:
2908
+ type: integer
2909
+ title: Rank
2910
+ is_conditional:
2911
+ type: boolean
2912
+ title: Is Conditional
2913
+ default: false
2914
+ type: object
2915
+ required:
2916
+ - id
2917
+ - name
2918
+ - ver
2919
+ - rank
2920
+ title: PromptBlock
2921
+ PromptCreate:
2922
+ properties:
2923
+ name:
2924
+ type: string
2925
+ title: Name
2926
+ body:
2927
+ type: string
2928
+ title: Body
2929
+ data:
2930
+ type: object
2931
+ title: Data
2932
+ ver:
2933
+ type: integer
2934
+ title: Ver
2935
+ type:
2936
+ allOf:
2937
+ - $ref: '#/components/schemas/PromptType'
2938
+ default: 0
2939
+ type: object
2940
+ required:
2941
+ - name
2942
+ - body
2943
+ title: PromptCreate
2944
+ PromptResponse:
2945
+ properties:
2946
+ id:
2947
+ type: integer
2948
+ title: Id
2949
+ name:
2950
+ type: string
2951
+ title: Name
2952
+ ver:
2953
+ type: integer
2954
+ title: Ver
2955
+ body:
2956
+ type: string
2957
+ title: Body
2958
+ data:
2959
+ type: object
2960
+ title: Data
2961
+ dynamic_slot_data:
2962
+ type: object
2963
+ title: Dynamic Slot Data
2964
+ type:
2965
+ $ref: '#/components/schemas/PromptType'
2966
+ time_created:
2967
+ type: integer
2968
+ title: Time Created
2969
+ type: object
2970
+ required:
2971
+ - id
2972
+ - name
2973
+ - ver
2974
+ - body
2975
+ - data
2976
+ - type
2977
+ title: PromptResponse
2978
+ PromptType:
2979
+ type: integer
2980
+ enum:
2981
+ - 0
2982
+ - 1
2983
+ title: PromptType
2984
+ description: An enumeration.
2985
+ ProvidersDocumentRequest:
2986
+ properties:
2987
+ uris:
2988
+ items:
2989
+ type: string
2990
+ type: array
2991
+ title: Uris
2992
+ merchant_name:
2993
+ type: string
2994
+ title: Merchant Name
2995
+ value:
2996
+ type: string
2997
+ title: Value
2998
+ client_name:
2999
+ type: string
3000
+ title: Client Name
3001
+ df_case_number:
3002
+ type: string
3003
+ title: Df Case Number
3004
+ merchant_address:
3005
+ type: string
3006
+ title: Merchant Address
3007
+ cache:
3008
+ type: boolean
3009
+ title: Cache
3010
+ default: false
3011
+ type: object
3012
+ required:
3013
+ - uris
3014
+ - merchant_name
3015
+ - value
3016
+ - client_name
3017
+ - df_case_number
3018
+ - merchant_address
3019
+ title: ProvidersDocumentRequest
3020
+ ProvidersDocumentResponse:
3021
+ properties:
3022
+ providers:
3023
+ title: Providers
3024
+ provider_file:
3025
+ $ref: '#/components/schemas/TargetS3Object'
3026
+ cover_letters:
3027
+ items:
3028
+ $ref: '#/components/schemas/TargetS3Object'
3029
+ type: array
3030
+ title: Cover Letters
3031
+ certificate_of_authority:
3032
+ $ref: '#/components/schemas/TargetS3Object'
3033
+ type: object
3034
+ required:
3035
+ - provider_file
3036
+ - cover_letters
3037
+ - certificate_of_authority
3038
+ title: ProvidersDocumentResponse
3039
+ Role:
3040
+ enum:
3041
+ - user
3042
+ - bot
3043
+ title: Role
3044
+ description: An enumeration.
3045
+ StageCreate:
3046
+ properties:
3047
+ name:
3048
+ type: string
3049
+ title: Name
3050
+ label:
3051
+ type: string
3052
+ title: Label
3053
+ is_selectable:
3054
+ type: boolean
3055
+ title: Is Selectable
3056
+ ver:
3057
+ type: integer
3058
+ title: Ver
3059
+ return_schema:
3060
+ type: object
3061
+ title: Return Schema
3062
+ next_steps:
3063
+ items:
3064
+ type: integer
3065
+ type: array
3066
+ title: Next Steps
3067
+ type:
3068
+ $ref: '#/components/schemas/Type'
3069
+ dev_metadata:
3070
+ $ref: '#/components/schemas/DevMetadata'
3071
+ time_created:
3072
+ type: integer
3073
+ title: Time Created
3074
+ type: object
3075
+ required:
3076
+ - name
3077
+ - label
3078
+ - is_selectable
3079
+ - ver
3080
+ - return_schema
3081
+ - next_steps
3082
+ - type
3083
+ - dev_metadata
3084
+ title: StageCreate
3085
+ StageData:
3086
+ properties:
3087
+ prompt:
3088
+ items:
3089
+ $ref: '#/components/schemas/PromptBlock'
3090
+ type: array
3091
+ title: Prompt
3092
+ next_step:
3093
+ items:
3094
+ type: integer
3095
+ type: array
3096
+ title: Next Step
3097
+ button:
3098
+ items:
3099
+ $ref: '#/components/schemas/PromptBlock'
3100
+ type: array
3101
+ title: Button
3102
+ type: object
3103
+ required:
3104
+ - next_step
3105
+ title: StageData
3106
+ StageLabelResponse:
3107
+ properties:
3108
+ id:
3109
+ type: integer
3110
+ title: Id
3111
+ label:
3112
+ type: string
3113
+ title: Label
3114
+ type: object
3115
+ required:
3116
+ - id
3117
+ - label
3118
+ title: StageLabelResponse
3119
+ StageResponse:
3120
+ properties:
3121
+ id:
3122
+ type: integer
3123
+ title: Id
3124
+ name:
3125
+ type: string
3126
+ title: Name
3127
+ label:
3128
+ type: string
3129
+ title: Label
3130
+ is_selectable:
3131
+ type: boolean
3132
+ title: Is Selectable
3133
+ ver:
3134
+ type: integer
3135
+ title: Ver
3136
+ return_schema:
3137
+ type: object
3138
+ title: Return Schema
3139
+ next_steps:
3140
+ items:
3141
+ type: integer
3142
+ type: array
3143
+ title: Next Steps
3144
+ type:
3145
+ allOf:
3146
+ - $ref: '#/components/schemas/Type'
3147
+ default: 0
3148
+ dev_metadata:
3149
+ $ref: '#/components/schemas/DevMetadata'
3150
+ time_created:
3151
+ type: integer
3152
+ title: Time Created
3153
+ type: object
3154
+ required:
3155
+ - id
3156
+ - name
3157
+ - label
3158
+ - is_selectable
3159
+ - ver
3160
+ - return_schema
3161
+ - next_steps
3162
+ title: StageResponse
3163
+ StageUpdate:
3164
+ properties:
3165
+ label:
3166
+ type: string
3167
+ title: Label
3168
+ is_selectable:
3169
+ type: boolean
3170
+ title: Is Selectable
3171
+ ver:
3172
+ type: integer
3173
+ title: Ver
3174
+ return_schema:
3175
+ type: object
3176
+ title: Return Schema
3177
+ next_steps:
3178
+ items:
3179
+ type: integer
3180
+ type: array
3181
+ title: Next Steps
3182
+ type:
3183
+ $ref: '#/components/schemas/Type'
3184
+ dev_metadata:
3185
+ $ref: '#/components/schemas/DevMetadata'
3186
+ type: object
3187
+ title: StageUpdate
3188
+ Status:
3189
+ type: integer
3190
+ enum:
3191
+ - -1
3192
+ - 0
3193
+ - 1
3194
+ - 2
3195
+ title: Status
3196
+ description: An enumeration.
3197
+ TargetS3Object:
3198
+ properties:
3199
+ uri:
3200
+ type: string
3201
+ title: Uri
3202
+ bucket_name:
3203
+ type: string
3204
+ title: Bucket Name
3205
+ object_key:
3206
+ type: string
3207
+ title: Object Key
3208
+ type: object
3209
+ required:
3210
+ - uri
3211
+ - bucket_name
3212
+ - object_key
3213
+ title: TargetS3Object
3214
+ TaskCreate:
3215
+ properties:
3216
+ flow_id:
3217
+ type: integer
3218
+ title: Flow Id
3219
+ input_metadata:
3220
+ type: object
3221
+ title: Input Metadata
3222
+ default: {}
3223
+ type: object
3224
+ required:
3225
+ - flow_id
3226
+ title: TaskCreate
3227
+ TaskCurrentStageInfo:
3228
+ properties:
3229
+ id:
3230
+ type: integer
3231
+ title: Id
3232
+ name:
3233
+ type: string
3234
+ title: Name
3235
+ type: object
3236
+ required:
3237
+ - id
3238
+ - name
3239
+ title: TaskCurrentStageInfo
3240
+ TaskDevMetadata:
3241
+ properties:
3242
+ num_input_tokens_used:
3243
+ type: integer
3244
+ title: Num Input Tokens Used
3245
+ num_output_tokens_used:
3246
+ type: integer
3247
+ title: Num Output Tokens Used
3248
+ type: object
3249
+ title: TaskDevMetadata
3250
+ TaskExecutionLogResponse:
3251
+ properties:
3252
+ id:
3253
+ type: integer
3254
+ title: Id
3255
+ task_id:
3256
+ type: integer
3257
+ title: Task Id
3258
+ stage_info:
3259
+ $ref: '#/components/schemas/TaskCurrentStageInfo'
3260
+ status:
3261
+ $ref: '#/components/schemas/Status'
3262
+ output_metadata:
3263
+ type: object
3264
+ title: Output Metadata
3265
+ default: {}
3266
+ processing_time_start:
3267
+ type: string
3268
+ format: date-time
3269
+ title: Processing Time Start
3270
+ processing_time_end:
3271
+ type: string
3272
+ format: date-time
3273
+ title: Processing Time End
3274
+ type: object
3275
+ required:
3276
+ - id
3277
+ - task_id
3278
+ - stage_info
3279
+ - status
3280
+ - processing_time_start
3281
+ - processing_time_end
3282
+ title: TaskExecutionLogResponse
3283
+ TaskResponse:
3284
+ properties:
3285
+ id:
3286
+ type: integer
3287
+ title: Id
3288
+ user_id:
3289
+ type: integer
3290
+ title: User Id
3291
+ flow_id:
3292
+ type: integer
3293
+ title: Flow Id
3294
+ current_stage_info:
3295
+ $ref: '#/components/schemas/TaskCurrentStageInfo'
3296
+ current_status:
3297
+ $ref: '#/components/schemas/Status'
3298
+ input_metadata:
3299
+ type: object
3300
+ title: Input Metadata
3301
+ default: {}
3302
+ output_metadata:
3303
+ type: object
3304
+ title: Output Metadata
3305
+ default: {}
3306
+ dev_metadata:
3307
+ $ref: '#/components/schemas/TaskDevMetadata'
3308
+ last_stage_response:
3309
+ $ref: '#/components/schemas/TaskExecutionLogResponse'
3310
+ time_created:
3311
+ type: integer
3312
+ title: Time Created
3313
+ time_last_updated:
3314
+ type: integer
3315
+ title: Time Last Updated
3316
+ type: object
3317
+ required:
3318
+ - id
3319
+ - user_id
3320
+ - flow_id
3321
+ - current_stage_info
3322
+ - current_status
3323
+ title: TaskResponse
3324
+ TestGeneratedMessageResponse:
3325
+ properties:
3326
+ prompt_content:
3327
+ type: string
3328
+ title: Prompt Content
3329
+ current_stage_id:
3330
+ type: integer
3331
+ title: Current Stage Id
3332
+ type: object
3333
+ required:
3334
+ - prompt_content
3335
+ - current_stage_id
3336
+ title: TestGeneratedMessageResponse
3337
+ TransitionReason:
3338
+ type: string
3339
+ enum:
3340
+ - bot_transition
3341
+ - manual_transition
3342
+ - init_transition
3343
+ - status_integration_transition
3344
+ title: TransitionReason
3345
+ description: An enumeration.
3346
+ Type:
3347
+ type: integer
3348
+ enum:
3349
+ - 0
3350
+ - 1
3351
+ - 2
3352
+ - 3
3353
+ - 4
3354
+ - 5
3355
+ - 6
3356
+ - 7
3357
+ title: Type
3358
+ description: An enumeration.
3359
+ UCCDocumentType:
3360
+ type: integer
3361
+ enum:
3362
+ - 1
3363
+ - 2
3364
+ - 3
3365
+ - 4
3366
+ - 5
3367
+ - 6
3368
+ - 7
3369
+ title: UCCDocumentType
3370
+ description: An enumeration.
3371
+ UCCProviderResponse:
3372
+ properties:
3373
+ providers:
3374
+ items: {}
3375
+ type: array
3376
+ title: Providers
3377
+ file:
3378
+ title: File
3379
+ cover_letters:
3380
+ items: {}
3381
+ type: array
3382
+ title: Cover Letters
3383
+ certificate_of_authority_uri:
3384
+ type: string
3385
+ title: Certificate Of Authority Uri
3386
+ type: object
3387
+ required:
3388
+ - providers
3389
+ - cover_letters
3390
+ - certificate_of_authority_uri
3391
+ title: UCCProviderResponse
3392
+ UCCResponse:
3393
+ properties:
3394
+ type:
3395
+ allOf:
3396
+ - $ref: '#/components/schemas/UCCDocumentType'
3397
+ default: 1
3398
+ metadata:
3399
+ title: Metadata
3400
+ sensitive_data:
3401
+ title: Sensitive Data
3402
+ filename:
3403
+ type: string
3404
+ title: Filename
3405
+ file:
3406
+ type: string
3407
+ title: File
3408
+ status:
3409
+ type: string
3410
+ title: Status
3411
+ default: success
3412
+ df_account_id:
3413
+ type: integer
3414
+ title: Df Account Id
3415
+ type: object
3416
+ title: UCCResponse
3417
+ UccDocumentRequest:
3418
+ properties:
3419
+ uri:
3420
+ type: string
3421
+ title: Uri
3422
+ cache:
3423
+ type: boolean
3424
+ title: Cache
3425
+ default: false
3426
+ convert:
3427
+ type: boolean
3428
+ title: Convert
3429
+ type: object
3430
+ required:
3431
+ - uri
3432
+ title: UccDocumentRequest
3433
+ UccDocumentResponse:
3434
+ properties:
3435
+ type:
3436
+ allOf:
3437
+ - $ref: '#/components/schemas/UCCDocumentType'
3438
+ default: 1
3439
+ metadata:
3440
+ title: Metadata
3441
+ sensitive_data:
3442
+ title: Sensitive Data
3443
+ uri:
3444
+ type: string
3445
+ title: Uri
3446
+ status:
3447
+ type: string
3448
+ enum:
3449
+ - success
3450
+ title: Status
3451
+ default: success
3452
+ df_account_id:
3453
+ type: integer
3454
+ title: Df Account Id
3455
+ ocr:
3456
+ title: Ocr
3457
+ structured_pages:
3458
+ title: Structured Pages
3459
+ type: object
3460
+ title: UccDocumentResponse
3461
+ UploadToS3Request:
3462
+ properties:
3463
+ url:
3464
+ type: string
3465
+ title: Url
3466
+ fields:
3467
+ $ref: '#/components/schemas/CreatePresignedPostFieldsResponse'
3468
+ type: object
3469
+ required:
3470
+ - url
3471
+ - fields
3472
+ title: UploadToS3Request
3473
+ User:
3474
+ properties:
3475
+ email:
3476
+ type: string
3477
+ format: email
3478
+ title: Email
3479
+ access_level:
3480
+ allOf:
3481
+ - $ref: '#/components/schemas/AccessLevel'
3482
+ default: 0
3483
+ id:
3484
+ type: integer
3485
+ title: Id
3486
+ name:
3487
+ type: string
3488
+ title: Name
3489
+ phone_number:
3490
+ type: string
3491
+ title: Phone Number
3492
+ customer_id:
3493
+ type: integer
3494
+ title: Customer Id
3495
+ type: object
3496
+ required:
3497
+ - email
3498
+ - id
3499
+ - name
3500
+ - phone_number
3501
+ - customer_id
3502
+ title: User
3503
+ UserCreate:
3504
+ properties:
3505
+ email:
3506
+ type: string
3507
+ format: email
3508
+ title: Email
3509
+ access_level:
3510
+ allOf:
3511
+ - $ref: '#/components/schemas/AccessLevel'
3512
+ default: 0
3513
+ name:
3514
+ type: string
3515
+ title: Name
3516
+ phone_number:
3517
+ type: string
3518
+ title: Phone Number
3519
+ password:
3520
+ type: string
3521
+ title: Password
3522
+ type: object
3523
+ required:
3524
+ - email
3525
+ - name
3526
+ - phone_number
3527
+ - password
3528
+ title: UserCreate
3529
+ UserSetPasswordWithToken:
3530
+ properties:
3531
+ token:
3532
+ type: string
3533
+ title: Token
3534
+ new_password:
3535
+ type: string
3536
+ title: New Password
3537
+ type: object
3538
+ required:
3539
+ - token
3540
+ - new_password
3541
+ title: UserSetPasswordWithToken
3542
+ UserUpdate:
3543
+ properties:
3544
+ name:
3545
+ type: string
3546
+ title: Name
3547
+ phone_number:
3548
+ type: string
3549
+ title: Phone Number
3550
+ current_password:
3551
+ type: string
3552
+ title: Current Password
3553
+ new_password:
3554
+ type: string
3555
+ title: New Password
3556
+ type: object
3557
+ title: UserUpdate
3558
+ ValidationError:
3559
+ properties:
3560
+ loc:
3561
+ items:
3562
+ anyOf:
3563
+ - type: string
3564
+ - type: integer
3565
+ type: array
3566
+ title: Location
3567
+ msg:
3568
+ type: string
3569
+ title: Message
3570
+ type:
3571
+ type: string
3572
+ title: Error Type
3573
+ type: object
3574
+ required:
3575
+ - loc
3576
+ - msg
3577
+ - type
3578
+ title: ValidationError
3579
+ securitySchemes:
3580
+ OAuth2PasswordBearer:
3581
+ type: oauth2
3582
+ flows:
3583
+ password:
3584
+ scopes: {}
3585
+ tokenUrl: /api/auth/login