@matech/thebigpos-sdk 2.44.4-rc0 → 2.45.0-rc10

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/dist/index.js CHANGED
@@ -95,7 +95,7 @@ export class HttpClient {
95
95
  }
96
96
  /**
97
97
  * @title The Big POS API
98
- * @version v2.44.2
98
+ * @version v2.45.0
99
99
  * @termsOfService https://www.thebigpos.com/terms-of-use/
100
100
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
101
101
  */
@@ -255,6 +255,671 @@ export class Api extends HttpClient {
255
255
  * @response `422` `ProblemDetails` Unprocessable Content
256
256
  */
257
257
  updateAccountBilling: (id, data, params = {}) => this.request(Object.assign({ path: `/api/accounts/${id}/billing`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
258
+ /**
259
+ * No description
260
+ *
261
+ * @tags AiAccess
262
+ * @name GetAiAccess
263
+ * @summary Get whether AI is enabled for the current user's account
264
+ * @request GET:/api/ai/access
265
+ * @secure
266
+ * @response `200` `AiEnabled` OK
267
+ */
268
+ getAiAccess: (params = {}) => this.request(Object.assign({ path: `/api/ai/access`, method: "GET", secure: true, format: "json" }, params)),
269
+ /**
270
+ * No description
271
+ *
272
+ * @tags AiAccount
273
+ * @name GetAccountAiEnabled
274
+ * @summary Get whether AI is enabled for an account (SuperAdmin only)
275
+ * @request GET:/api/ai/accounts/{accountId}/ai-enabled
276
+ * @secure
277
+ * @response `200` `AiEnabled` OK
278
+ */
279
+ getAccountAiEnabled: (accountId, params = {}) => this.request(Object.assign({ path: `/api/ai/accounts/${accountId}/ai-enabled`, method: "GET", secure: true, format: "json" }, params)),
280
+ /**
281
+ * No description
282
+ *
283
+ * @tags AiAccount
284
+ * @name SetAccountAiEnabled
285
+ * @summary Enable or disable AI for an account (SuperAdmin only)
286
+ * @request PUT:/api/ai/accounts/{accountId}/ai-enabled
287
+ * @secure
288
+ * @response `204` `void` No Content
289
+ */
290
+ setAccountAiEnabled: (accountId, data, params = {}) => this.request(Object.assign({ path: `/api/ai/accounts/${accountId}/ai-enabled`, method: "PUT", body: data, secure: true, type: "application/json" }, params)),
291
+ /**
292
+ * No description
293
+ *
294
+ * @tags AiAccountSettings
295
+ * @name GetAiAccountSettings
296
+ * @summary Get account AI settings
297
+ * @request GET:/api/ai/account-settings
298
+ * @secure
299
+ * @response `200` `AiAccountSettings` OK
300
+ */
301
+ getAiAccountSettings: (params = {}) => this.request(Object.assign({ path: `/api/ai/account-settings`, method: "GET", secure: true, format: "json" }, params)),
302
+ /**
303
+ * No description
304
+ *
305
+ * @tags AiAccountSettings
306
+ * @name UpdateAiAccountSettings
307
+ * @summary Update account AI settings
308
+ * @request PUT:/api/ai/account-settings
309
+ * @secure
310
+ * @response `200` `AiAccountSettings` OK
311
+ * @response `400` `ProblemDetails` Bad Request
312
+ */
313
+ updateAiAccountSettings: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/account-settings`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
314
+ /**
315
+ * No description
316
+ *
317
+ * @tags AiAdminPrompt
318
+ * @name GetAiPrompts
319
+ * @summary Get all prompts
320
+ * @request GET:/api/ai/prompts
321
+ * @secure
322
+ * @response `200` `(AiPrompt)[]` OK
323
+ */
324
+ getAiPrompts: (params = {}) => this.request(Object.assign({ path: `/api/ai/prompts`, method: "GET", secure: true, format: "json" }, params)),
325
+ /**
326
+ * No description
327
+ *
328
+ * @tags AiAdminPrompt
329
+ * @name CreateAiPrompt
330
+ * @summary Create custom prompt
331
+ * @request POST:/api/ai/prompts
332
+ * @secure
333
+ * @response `201` `AiPrompt` Created
334
+ * @response `400` `ProblemDetails` Bad Request
335
+ */
336
+ createAiPrompt: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
337
+ /**
338
+ * No description
339
+ *
340
+ * @tags AiAdminPrompt
341
+ * @name GetAiPrompt
342
+ * @summary Get prompt by ID
343
+ * @request GET:/api/ai/prompts/{id}
344
+ * @secure
345
+ * @response `200` `AiPrompt` OK
346
+ * @response `404` `ProblemDetails` Not Found
347
+ */
348
+ getAiPrompt: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/${id}`, method: "GET", secure: true, format: "json" }, params)),
349
+ /**
350
+ * No description
351
+ *
352
+ * @tags AiAdminPrompt
353
+ * @name UpdateAiPrompt
354
+ * @summary Update prompt
355
+ * @request PUT:/api/ai/prompts/{id}
356
+ * @secure
357
+ * @response `200` `AiPrompt` OK
358
+ * @response `400` `ProblemDetails` Bad Request
359
+ * @response `404` `ProblemDetails` Not Found
360
+ */
361
+ updateAiPrompt: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
362
+ /**
363
+ * No description
364
+ *
365
+ * @tags AiAdminPrompt
366
+ * @name DeleteAiPrompt
367
+ * @summary Delete prompt
368
+ * @request DELETE:/api/ai/prompts/{id}
369
+ * @secure
370
+ * @response `204` `void` No Content
371
+ * @response `400` `ProblemDetails` Bad Request
372
+ * @response `404` `ProblemDetails` Not Found
373
+ */
374
+ deleteAiPrompt: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/${id}`, method: "DELETE", secure: true }, params)),
375
+ /**
376
+ * No description
377
+ *
378
+ * @tags AiAdminPrompt
379
+ * @name ToggleAiPrompt
380
+ * @summary Toggle prompt active/inactive
381
+ * @request PATCH:/api/ai/prompts/{id}/toggle
382
+ * @secure
383
+ * @response `200` `AiPrompt` OK
384
+ * @response `404` `ProblemDetails` Not Found
385
+ */
386
+ toggleAiPrompt: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/${id}/toggle`, method: "PATCH", secure: true, format: "json" }, params)),
387
+ /**
388
+ * No description
389
+ *
390
+ * @tags AiAdminPrompt
391
+ * @name GenerateAiSystemPrompt
392
+ * @summary Generate a system prompt from description
393
+ * @request POST:/api/ai/prompts/generate
394
+ * @secure
395
+ * @response `200` `GenerateSystemPrompt` OK
396
+ * @response `400` `ProblemDetails` Bad Request
397
+ */
398
+ generateAiSystemPrompt: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/generate`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
399
+ /**
400
+ * No description
401
+ *
402
+ * @tags AiAdminPrompt
403
+ * @name GetAiSupportedModels
404
+ * @summary Get supported LLM models
405
+ * @request GET:/api/ai/prompts/supported-models
406
+ * @secure
407
+ * @response `200` `(SupportedModel)[]` OK
408
+ */
409
+ getAiSupportedModels: (params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/supported-models`, method: "GET", secure: true, format: "json" }, params)),
410
+ /**
411
+ * No description
412
+ *
413
+ * @tags AiAdminSettings
414
+ * @name GetAiAdminSettings
415
+ * @summary Get global AI settings
416
+ * @request GET:/api/ai/settings
417
+ * @secure
418
+ * @response `200` `AiAdminSettings` OK
419
+ */
420
+ getAiAdminSettings: (params = {}) => this.request(Object.assign({ path: `/api/ai/settings`, method: "GET", secure: true, format: "json" }, params)),
421
+ /**
422
+ * No description
423
+ *
424
+ * @tags AiAdminSettings
425
+ * @name UpdateAiAdminSettings
426
+ * @summary Update global AI settings
427
+ * @request PUT:/api/ai/settings
428
+ * @secure
429
+ * @response `200` `AiAdminSettings` OK
430
+ * @response `400` `ProblemDetails` Bad Request
431
+ */
432
+ updateAiAdminSettings: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/settings`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
433
+ /**
434
+ * No description
435
+ *
436
+ * @tags AiAudit
437
+ * @name GetAiAuditLogs
438
+ * @summary Get paginated AI audit logs (own account, or any/all accounts for SuperAdmin)
439
+ * @request GET:/api/ai/audit-logs
440
+ * @secure
441
+ * @response `200` `AiAuditLogPaginated` OK
442
+ */
443
+ getAiAuditLogs: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/audit-logs`, method: "GET", query: query, secure: true, format: "json" }, params)),
444
+ /**
445
+ * No description
446
+ *
447
+ * @tags AiAudit
448
+ * @name GetAiRequestLifecycle
449
+ * @summary Get the full event lifecycle of a single AI request
450
+ * @request GET:/api/ai/audit-logs/request/{requestId}
451
+ * @secure
452
+ * @response `200` `(AiAuditLog)[]` OK
453
+ */
454
+ getAiRequestLifecycle: (requestId, query, params = {}) => this.request(Object.assign({ path: `/api/ai/audit-logs/request/${requestId}`, method: "GET", query: query, secure: true, format: "json" }, params)),
455
+ /**
456
+ * No description
457
+ *
458
+ * @tags AiAudit
459
+ * @name GetAiAuditConversations
460
+ * @summary List conversations with their audit roll-up — origin user, turns, status, tokens
461
+ * @request GET:/api/ai/audit-conversations
462
+ * @secure
463
+ * @response `200` `AiConversationAuditSummaryPaginated` OK
464
+ */
465
+ getAiAuditConversations: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/audit-conversations`, method: "GET", query: query, secure: true, format: "json" }, params)),
466
+ /**
467
+ * No description
468
+ *
469
+ * @tags AiAudit
470
+ * @name GetAiStats
471
+ * @summary Get AI dashboard stats (own account, or any/all accounts for SuperAdmin)
472
+ * @request GET:/api/ai/stats
473
+ * @secure
474
+ * @response `200` `AiAdminStats` OK
475
+ */
476
+ getAiStats: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/stats`, method: "GET", query: query, secure: true, format: "json" }, params)),
477
+ /**
478
+ * No description
479
+ *
480
+ * @tags AiAudit
481
+ * @name GetAiConfigChanges
482
+ * @summary Get the AI configuration change history (who changed prompts, guardrails, fields, sources)
483
+ * @request GET:/api/ai/config-changes
484
+ * @secure
485
+ * @response `200` `AuditLogEntryPaginated` OK
486
+ */
487
+ getAiConfigChanges: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/config-changes`, method: "GET", query: query, secure: true, format: "json" }, params)),
488
+ /**
489
+ * No description
490
+ *
491
+ * @tags AiCanonicalField
492
+ * @name GetAiCanonicalFields
493
+ * @summary Get all canonical fields
494
+ * @request GET:/api/ai/canonical-fields
495
+ * @secure
496
+ * @response `200` `(AiCanonicalField)[]` OK
497
+ */
498
+ getAiCanonicalFields: (params = {}) => this.request(Object.assign({ path: `/api/ai/canonical-fields`, method: "GET", secure: true, format: "json" }, params)),
499
+ /**
500
+ * No description
501
+ *
502
+ * @tags AiCanonicalField
503
+ * @name CreateAiCanonicalField
504
+ * @summary Create canonical field
505
+ * @request POST:/api/ai/canonical-fields
506
+ * @secure
507
+ * @response `201` `AiCanonicalField` Created
508
+ * @response `400` `ProblemDetails` Bad Request
509
+ */
510
+ createAiCanonicalField: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/canonical-fields`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
511
+ /**
512
+ * No description
513
+ *
514
+ * @tags AiCanonicalField
515
+ * @name GetAiCanonicalField
516
+ * @summary Get canonical field by ID
517
+ * @request GET:/api/ai/canonical-fields/{id}
518
+ * @secure
519
+ * @response `200` `AiCanonicalField` OK
520
+ * @response `404` `ProblemDetails` Not Found
521
+ */
522
+ getAiCanonicalField: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/canonical-fields/${id}`, method: "GET", secure: true, format: "json" }, params)),
523
+ /**
524
+ * No description
525
+ *
526
+ * @tags AiCanonicalField
527
+ * @name UpdateAiCanonicalField
528
+ * @summary Update canonical field
529
+ * @request PUT:/api/ai/canonical-fields/{id}
530
+ * @secure
531
+ * @response `200` `AiCanonicalField` OK
532
+ * @response `400` `ProblemDetails` Bad Request
533
+ * @response `404` `ProblemDetails` Not Found
534
+ */
535
+ updateAiCanonicalField: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/canonical-fields/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
536
+ /**
537
+ * No description
538
+ *
539
+ * @tags AiCanonicalField
540
+ * @name DeleteAiCanonicalField
541
+ * @summary Delete canonical field
542
+ * @request DELETE:/api/ai/canonical-fields/{id}
543
+ * @secure
544
+ * @response `204` `void` No Content
545
+ * @response `404` `ProblemDetails` Not Found
546
+ */
547
+ deleteAiCanonicalField: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/canonical-fields/${id}`, method: "DELETE", secure: true }, params)),
548
+ /**
549
+ * No description
550
+ *
551
+ * @tags AiCanonicalField
552
+ * @name ToggleAiCanonicalField
553
+ * @summary Toggle canonical field active/inactive
554
+ * @request PATCH:/api/ai/canonical-fields/{id}/toggle
555
+ * @secure
556
+ * @response `200` `AiCanonicalField` OK
557
+ * @response `404` `ProblemDetails` Not Found
558
+ */
559
+ toggleAiCanonicalField: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/canonical-fields/${id}/toggle`, method: "PATCH", secure: true, format: "json" }, params)),
560
+ /**
561
+ * No description
562
+ *
563
+ * @tags AiChat
564
+ * @name AiChat
565
+ * @summary Send AI chat message
566
+ * @request POST:/api/ai/chats
567
+ * @secure
568
+ * @response `200` `AiChat` OK
569
+ * @response `400` `ProblemDetails` Bad Request
570
+ * @response `401` `ProblemDetails` Unauthorized
571
+ */
572
+ aiChat: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/chats`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
573
+ /**
574
+ * No description
575
+ *
576
+ * @tags AiConversation
577
+ * @name GetAiConversations
578
+ * @summary Get user conversations
579
+ * @request GET:/api/ai/conversations
580
+ * @secure
581
+ * @response `200` `AiConversationListItemPaginated` OK
582
+ */
583
+ getAiConversations: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations`, method: "GET", query: query, secure: true, format: "json" }, params)),
584
+ /**
585
+ * No description
586
+ *
587
+ * @tags AiConversation
588
+ * @name GetAiConversation
589
+ * @summary Get conversation metadata
590
+ * @request GET:/api/ai/conversations/{id}
591
+ * @secure
592
+ * @response `200` `AiConversationDetail` OK
593
+ * @response `403` `ProblemDetails` Forbidden
594
+ * @response `404` `ProblemDetails` Not Found
595
+ */
596
+ getAiConversation: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/${id}`, method: "GET", secure: true, format: "json" }, params)),
597
+ /**
598
+ * No description
599
+ *
600
+ * @tags AiConversation
601
+ * @name RenameAiConversation
602
+ * @summary Rename conversation
603
+ * @request PATCH:/api/ai/conversations/{id}
604
+ * @secure
605
+ * @response `200` `AiConversationDetail` OK
606
+ * @response `400` `ProblemDetails` Bad Request
607
+ * @response `403` `ProblemDetails` Forbidden
608
+ * @response `404` `ProblemDetails` Not Found
609
+ */
610
+ renameAiConversation: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/${id}`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
611
+ /**
612
+ * No description
613
+ *
614
+ * @tags AiConversation
615
+ * @name DeleteAiConversation
616
+ * @summary Delete conversation
617
+ * @request DELETE:/api/ai/conversations/{id}
618
+ * @secure
619
+ * @response `204` `void` No Content
620
+ * @response `403` `ProblemDetails` Forbidden
621
+ * @response `404` `ProblemDetails` Not Found
622
+ */
623
+ deleteAiConversation: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/${id}`, method: "DELETE", secure: true }, params)),
624
+ /**
625
+ * No description
626
+ *
627
+ * @tags AiConversation
628
+ * @name GetAiConversationMessages
629
+ * @summary Get conversation messages
630
+ * @request GET:/api/ai/conversations/{id}/messages
631
+ * @secure
632
+ * @response `200` `AiChatMessagePaginated` OK
633
+ * @response `403` `ProblemDetails` Forbidden
634
+ * @response `404` `ProblemDetails` Not Found
635
+ */
636
+ getAiConversationMessages: (id, query, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/${id}/messages`, method: "GET", query: query, secure: true, format: "json" }, params)),
637
+ /**
638
+ * No description
639
+ *
640
+ * @tags AiConversation
641
+ * @name ClearAiConversationHistory
642
+ * @summary Clear conversation history
643
+ * @request DELETE:/api/ai/conversations/{id}/messages
644
+ * @secure
645
+ * @response `204` `void` No Content
646
+ * @response `403` `ProblemDetails` Forbidden
647
+ * @response `404` `ProblemDetails` Not Found
648
+ */
649
+ clearAiConversationHistory: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/${id}/messages`, method: "DELETE", secure: true }, params)),
650
+ /**
651
+ * No description
652
+ *
653
+ * @tags AiConversation
654
+ * @name PinAiConversation
655
+ * @summary Pin or unpin conversation
656
+ * @request PUT:/api/ai/conversations/{id}/pin
657
+ * @secure
658
+ * @response `200` `AiConversationDetail` OK
659
+ * @response `403` `ProblemDetails` Forbidden
660
+ * @response `404` `ProblemDetails` Not Found
661
+ */
662
+ pinAiConversation: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/${id}/pin`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
663
+ /**
664
+ * No description
665
+ *
666
+ * @tags AiConversationAdmin
667
+ * @name GetAiAccountConversations
668
+ * @summary List AI conversations across the account, optionally filtered by user (admin supervision)
669
+ * @request GET:/api/ai/conversations/all
670
+ * @secure
671
+ * @response `200` `AiConversationListItemPaginated` OK
672
+ */
673
+ getAiAccountConversations: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/all`, method: "GET", query: query, secure: true, format: "json" }, params)),
674
+ /**
675
+ * No description
676
+ *
677
+ * @tags AiConversationAdmin
678
+ * @name GetAiAccountConversation
679
+ * @summary Get an account conversation's detail (admin supervision)
680
+ * @request GET:/api/ai/conversations/all/{id}
681
+ * @secure
682
+ * @response `200` `AiConversationDetail` OK
683
+ * @response `404` `ProblemDetails` Not Found
684
+ */
685
+ getAiAccountConversation: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/all/${id}`, method: "GET", secure: true, format: "json" }, params)),
686
+ /**
687
+ * No description
688
+ *
689
+ * @tags AiConversationAdmin
690
+ * @name GetAiAccountConversationMessages
691
+ * @summary Get an account conversation's messages (admin supervision)
692
+ * @request GET:/api/ai/conversations/all/{id}/messages
693
+ * @secure
694
+ * @response `200` `AiChatMessagePaginated` OK
695
+ * @response `404` `ProblemDetails` Not Found
696
+ */
697
+ getAiAccountConversationMessages: (id, query, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/all/${id}/messages`, method: "GET", query: query, secure: true, format: "json" }, params)),
698
+ /**
699
+ * No description
700
+ *
701
+ * @tags AiGuardrail
702
+ * @name GetAiGuardrails
703
+ * @summary Get all guardrails
704
+ * @request GET:/api/ai/guardrails
705
+ * @secure
706
+ * @response `200` `(AiGuardrail)[]` OK
707
+ */
708
+ getAiGuardrails: (params = {}) => this.request(Object.assign({ path: `/api/ai/guardrails`, method: "GET", secure: true, format: "json" }, params)),
709
+ /**
710
+ * No description
711
+ *
712
+ * @tags AiGuardrail
713
+ * @name CreateAiGuardrail
714
+ * @summary Create custom guardrail
715
+ * @request POST:/api/ai/guardrails
716
+ * @secure
717
+ * @response `201` `AiGuardrail` Created
718
+ * @response `400` `ProblemDetails` Bad Request
719
+ */
720
+ createAiGuardrail: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/guardrails`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
721
+ /**
722
+ * No description
723
+ *
724
+ * @tags AiGuardrail
725
+ * @name GetAiGuardrail
726
+ * @summary Get guardrail by ID
727
+ * @request GET:/api/ai/guardrails/{id}
728
+ * @secure
729
+ * @response `200` `AiGuardrail` OK
730
+ * @response `404` `ProblemDetails` Not Found
731
+ */
732
+ getAiGuardrail: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/guardrails/${id}`, method: "GET", secure: true, format: "json" }, params)),
733
+ /**
734
+ * No description
735
+ *
736
+ * @tags AiGuardrail
737
+ * @name UpdateAiGuardrail
738
+ * @summary Update guardrail
739
+ * @request PUT:/api/ai/guardrails/{id}
740
+ * @secure
741
+ * @response `200` `AiGuardrail` OK
742
+ * @response `400` `ProblemDetails` Bad Request
743
+ * @response `404` `ProblemDetails` Not Found
744
+ */
745
+ updateAiGuardrail: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/guardrails/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
746
+ /**
747
+ * No description
748
+ *
749
+ * @tags AiGuardrail
750
+ * @name DeleteAiGuardrail
751
+ * @summary Delete guardrail
752
+ * @request DELETE:/api/ai/guardrails/{id}
753
+ * @secure
754
+ * @response `204` `void` No Content
755
+ * @response `400` `ProblemDetails` Bad Request
756
+ * @response `404` `ProblemDetails` Not Found
757
+ */
758
+ deleteAiGuardrail: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/guardrails/${id}`, method: "DELETE", secure: true }, params)),
759
+ /**
760
+ * No description
761
+ *
762
+ * @tags AiGuardrail
763
+ * @name ToggleAiGuardrail
764
+ * @summary Toggle guardrail enabled/disabled
765
+ * @request PATCH:/api/ai/guardrails/{id}/toggle
766
+ * @secure
767
+ * @response `200` `AiGuardrail` OK
768
+ * @response `404` `ProblemDetails` Not Found
769
+ */
770
+ toggleAiGuardrail: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/guardrails/${id}/toggle`, method: "PATCH", secure: true, format: "json" }, params)),
771
+ /**
772
+ * No description
773
+ *
774
+ * @tags AiPrompt
775
+ * @name GetAiAvailablePrompts
776
+ * @summary Get available prompts for current user
777
+ * @request GET:/api/ai/prompts/available
778
+ * @secure
779
+ * @response `200` `(AiPromptSummary)[]` OK
780
+ */
781
+ getAiAvailablePrompts: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/available`, method: "GET", query: query, secure: true, format: "json" }, params)),
782
+ /**
783
+ * No description
784
+ *
785
+ * @tags AiTokenUsageAdmin
786
+ * @name SearchAiAccountTokenUsage
787
+ * @summary Search accounts by current-month AI token usage and classification
788
+ * @request POST:/api/ai/token-usage/search
789
+ * @secure
790
+ * @response `200` `AiAccountUsageOverviewPaginated` OK
791
+ */
792
+ searchAiAccountTokenUsage: (data, query, params = {}) => this.request(Object.assign({ path: `/api/ai/token-usage/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
793
+ /**
794
+ * No description
795
+ *
796
+ * @tags AiTokenUsageAdmin
797
+ * @name GetAiAccountTokenUsage
798
+ * @summary Get an account's current-month AI token usage
799
+ * @request GET:/api/ai/token-usage/{accountId}
800
+ * @secure
801
+ * @response `200` `AiTokenBudgetStatus` OK
802
+ */
803
+ getAiAccountTokenUsage: (accountId, params = {}) => this.request(Object.assign({ path: `/api/ai/token-usage/${accountId}`, method: "GET", secure: true, format: "json" }, params)),
804
+ /**
805
+ * No description
806
+ *
807
+ * @tags AiTokenUsageAdmin
808
+ * @name GetAiAccountTokenUsageHistory
809
+ * @summary Get an account's monthly AI token usage history
810
+ * @request GET:/api/ai/token-usage/{accountId}/history
811
+ * @secure
812
+ * @response `200` `AiTokenUsageWindowPaginated` OK
813
+ */
814
+ getAiAccountTokenUsageHistory: (accountId, query, params = {}) => this.request(Object.assign({ path: `/api/ai/token-usage/${accountId}/history`, method: "GET", query: query, secure: true, format: "json" }, params)),
815
+ /**
816
+ * No description
817
+ *
818
+ * @tags AiTokenUsageAdmin
819
+ * @name SetAiAccountTokenLimit
820
+ * @summary Set or raise an account's monthly AI token limit
821
+ * @request PUT:/api/ai/token-usage/{accountId}/limit
822
+ * @secure
823
+ * @response `200` `AiTokenBudgetStatus` OK
824
+ * @response `400` `ProblemDetails` Bad Request
825
+ */
826
+ setAiAccountTokenLimit: (accountId, data, params = {}) => this.request(Object.assign({ path: `/api/ai/token-usage/${accountId}/limit`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
827
+ /**
828
+ * No description
829
+ *
830
+ * @tags AiUrlSource
831
+ * @name GetAiUrlSources
832
+ * @summary Get all URL sources
833
+ * @request GET:/api/ai/url-sources
834
+ * @secure
835
+ * @response `200` `(AiUrlSource)[]` OK
836
+ */
837
+ getAiUrlSources: (params = {}) => this.request(Object.assign({ path: `/api/ai/url-sources`, method: "GET", secure: true, format: "json" }, params)),
838
+ /**
839
+ * No description
840
+ *
841
+ * @tags AiUrlSource
842
+ * @name CreateAiUrlSource
843
+ * @summary Create URL source
844
+ * @request POST:/api/ai/url-sources
845
+ * @secure
846
+ * @response `201` `AiUrlSource` Created
847
+ * @response `400` `ProblemDetails` Bad Request
848
+ * @response `409` `ProblemDetails` Conflict
849
+ */
850
+ createAiUrlSource: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/url-sources`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
851
+ /**
852
+ * No description
853
+ *
854
+ * @tags AiUrlSource
855
+ * @name GetAiUrlSource
856
+ * @summary Get URL source by ID
857
+ * @request GET:/api/ai/url-sources/{id}
858
+ * @secure
859
+ * @response `200` `AiUrlSource` OK
860
+ * @response `404` `ProblemDetails` Not Found
861
+ */
862
+ getAiUrlSource: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/url-sources/${id}`, method: "GET", secure: true, format: "json" }, params)),
863
+ /**
864
+ * No description
865
+ *
866
+ * @tags AiUrlSource
867
+ * @name UpdateAiUrlSource
868
+ * @summary Update URL source
869
+ * @request PUT:/api/ai/url-sources/{id}
870
+ * @secure
871
+ * @response `200` `AiUrlSource` OK
872
+ * @response `400` `ProblemDetails` Bad Request
873
+ * @response `404` `ProblemDetails` Not Found
874
+ * @response `409` `ProblemDetails` Conflict
875
+ */
876
+ updateAiUrlSource: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/url-sources/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
877
+ /**
878
+ * No description
879
+ *
880
+ * @tags AiUrlSource
881
+ * @name DeleteAiUrlSource
882
+ * @summary Delete URL source
883
+ * @request DELETE:/api/ai/url-sources/{id}
884
+ * @secure
885
+ * @response `204` `void` No Content
886
+ * @response `404` `ProblemDetails` Not Found
887
+ */
888
+ deleteAiUrlSource: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/url-sources/${id}`, method: "DELETE", secure: true }, params)),
889
+ /**
890
+ * No description
891
+ *
892
+ * @tags AiUrlSource
893
+ * @name ToggleAiUrlSource
894
+ * @summary Toggle URL source active/inactive
895
+ * @request PATCH:/api/ai/url-sources/{id}/toggle
896
+ * @secure
897
+ * @response `200` `AiUrlSource` OK
898
+ * @response `404` `ProblemDetails` Not Found
899
+ */
900
+ toggleAiUrlSource: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/url-sources/${id}/toggle`, method: "PATCH", secure: true, format: "json" }, params)),
901
+ /**
902
+ * No description
903
+ *
904
+ * @tags AiUsage
905
+ * @name GetAiUsage
906
+ * @summary Get the current account's AI token usage for the active monthly window
907
+ * @request GET:/api/ai/usage
908
+ * @secure
909
+ * @response `200` `AiTokenBudgetStatus` OK
910
+ */
911
+ getAiUsage: (params = {}) => this.request(Object.assign({ path: `/api/ai/usage`, method: "GET", secure: true, format: "json" }, params)),
912
+ /**
913
+ * No description
914
+ *
915
+ * @tags AiUsage
916
+ * @name GetAiUsageHistory
917
+ * @summary Get the current account's monthly AI token usage history
918
+ * @request GET:/api/ai/usage/history
919
+ * @secure
920
+ * @response `200` `AiTokenUsageWindowPaginated` OK
921
+ */
922
+ getAiUsageHistory: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/usage/history`, method: "GET", query: query, secure: true, format: "json" }, params)),
258
923
  /**
259
924
  * No description
260
925
  *
@@ -1110,6 +1775,20 @@ export class Api extends HttpClient {
1110
1775
  * @response `500` `EncompassError` Internal Server Error
1111
1776
  */
1112
1777
  getUserPackages: (query, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/eclose/packages`, method: "GET", query: query, secure: true, format: "json" }, params)),
1778
+ /**
1779
+ * No description
1780
+ *
1781
+ * @tags Encompass Packages
1782
+ * @name GetLoanPackages
1783
+ * @request GET:/api/los/encompass/eclose/loans/{loanId}/packages
1784
+ * @secure
1785
+ * @response `200` `EncompassPackageList` OK
1786
+ * @response `400` `EncompassError` Bad Request
1787
+ * @response `401` `EncompassError` Unauthorized
1788
+ * @response `403` `EncompassError` Forbidden
1789
+ * @response `500` `EncompassError` Internal Server Error
1790
+ */
1791
+ getLoanPackages: (loanId, query, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/eclose/loans/${loanId}/packages`, method: "GET", query: query, secure: true, format: "json" }, params)),
1113
1792
  /**
1114
1793
  * No description
1115
1794
  *
@@ -1591,18 +2270,6 @@ export class Api extends HttpClient {
1591
2270
  * @response `200` `string` OK
1592
2271
  */
1593
2272
  getLoanEmbeddedSigningLink: (envelopeId, userName, email, params = {}) => this.request(Object.assign({ path: `/api/los/loan/embeddedsigning/${envelopeId}/${userName}/${email}`, method: "POST", secure: true, format: "json" }, params)),
1594
- /**
1595
- * No description
1596
- *
1597
- * @tags LegacyLoan
1598
- * @name CreateLegacyLoanDocument
1599
- * @summary Create Document
1600
- * @request POST:/api/los/loan/generatedocument
1601
- * @deprecated
1602
- * @secure
1603
- * @response `200` `DocumentDataRequest` OK
1604
- */
1605
- createLegacyLoanDocument: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/generatedocument`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
1606
2273
  /**
1607
2274
  * No description
1608
2275
  *
@@ -2171,6 +2838,19 @@ export class Api extends HttpClient {
2171
2838
  * @response `404` `ProblemDetails` Not Found
2172
2839
  */
2173
2840
  syncLoanDocumentsFromLos: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/sync`, method: "POST", secure: true, format: "json" }, params)),
2841
+ /**
2842
+ * No description
2843
+ *
2844
+ * @tags LoanDocuments
2845
+ * @name ClassifyLoanDocumentManually
2846
+ * @summary Manually classify a loan document
2847
+ * @request POST:/api/loans/{loanId}/documents/{documentId}/classify-manual
2848
+ * @secure
2849
+ * @response `200` `LoanDocument` OK
2850
+ * @response `404` `ProblemDetails` Not Found
2851
+ * @response `422` `UnprocessableEntity` Unprocessable Content
2852
+ */
2853
+ classifyLoanDocumentManually: (loanId, documentId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/${documentId}/classify-manual`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
2174
2854
  /**
2175
2855
  * @description Re-attempts to push a failed document to LOS
2176
2856
  *
@@ -2376,6 +3056,19 @@ export class Api extends HttpClient {
2376
3056
  * @response `404` `ProblemDetails` Not Found
2377
3057
  */
2378
3058
  sendLoanOptInReminder: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/notifications/opt-in-reminders`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
3059
+ /**
3060
+ * No description
3061
+ *
3062
+ * @tags LoanNotification
3063
+ * @name SendESignatureReminder
3064
+ * @summary Send eSignature Reminder
3065
+ * @request POST:/api/loans/{loanID}/notifications/esignature-reminders
3066
+ * @secure
3067
+ * @response `204` `void` No Content
3068
+ * @response `400` `ProblemDetails` Bad Request
3069
+ * @response `404` `ProblemDetails` Not Found
3070
+ */
3071
+ sendESignatureReminder: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/notifications/esignature-reminders`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
2379
3072
  /**
2380
3073
  * No description
2381
3074
  *
@@ -2702,18 +3395,6 @@ export class Api extends HttpClient {
2702
3395
  * @response `422` `UnprocessableEntity` Unprocessable Content
2703
3396
  */
2704
3397
  createLoanTaskDocument: (loanId, loanTaskId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${loanTaskId}/documents`, method: "POST", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
2705
- /**
2706
- * No description
2707
- *
2708
- * @tags LoanTaskDocuments
2709
- * @name CreateLoanTaskDocumentBucket
2710
- * @summary Create Bucket
2711
- * @request POST:/api/loans/{loanID}/tasks/{loanTaskId}/documents/bucket
2712
- * @secure
2713
- * @response `204` `UserLoanTask` No Content
2714
- * @response `422` `UnprocessableEntity` Unprocessable Content
2715
- */
2716
- createLoanTaskDocumentBucket: (loanId, loanTaskId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${loanTaskId}/documents/bucket`, method: "POST", secure: true, format: "json" }, params)),
2717
3398
  /**
2718
3399
  * No description
2719
3400
  *
@@ -2723,9 +3404,11 @@ export class Api extends HttpClient {
2723
3404
  * @request POST:/api/loans/{loanID}/tasks/reminders/outstanding
2724
3405
  * @secure
2725
3406
  * @response `204` `void` No Content
3407
+ * @response `400` `ProblemDetails` Bad Request
2726
3408
  * @response `404` `ProblemDetails` Not Found
3409
+ * @response `422` `ProblemDetails` Unprocessable Content
2727
3410
  */
2728
- sendOutstandingLoanTaskNotification: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/reminders/outstanding`, method: "POST", secure: true }, params)),
3411
+ sendOutstandingLoanTaskNotification: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/reminders/outstanding`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
2729
3412
  /**
2730
3413
  * No description
2731
3414
  *
@@ -3048,32 +3731,6 @@ export class Api extends HttpClient {
3048
3731
  * @response `422` `ProblemDetails` Unprocessable Content
3049
3732
  */
3050
3733
  calculateMortgageRefinance: (data, params = {}) => this.request(Object.assign({ path: `/api/mortgage-calculators/refinance`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
3051
- /**
3052
- * No description
3053
- *
3054
- * @tags Notifications
3055
- * @name SendNotificationForLoan
3056
- * @summary Send Notification for Loan
3057
- * @request POST:/api/notifications
3058
- * @deprecated
3059
- * @secure
3060
- * @response `200` `void` OK
3061
- * @response `422` `UnprocessableEntity` Unprocessable Content
3062
- */
3063
- sendNotificationForLoan: (data, params = {}) => this.request(Object.assign({ path: `/api/notifications`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
3064
- /**
3065
- * No description
3066
- *
3067
- * @tags Notifications
3068
- * @name SendTestNotificationForLoan
3069
- * @summary Send Test Notification for Loan
3070
- * @request POST:/api/notifications/test
3071
- * @deprecated
3072
- * @secure
3073
- * @response `200` `void` OK
3074
- * @response `422` `UnprocessableEntity` Unprocessable Content
3075
- */
3076
- sendTestNotificationForLoan: (data, params = {}) => this.request(Object.assign({ path: `/api/notifications/test`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
3077
3734
  /**
3078
3735
  * No description
3079
3736
  *