@matech/thebigpos-sdk 2.43.0-aibi-1 → 2.43.1-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -67,16 +67,6 @@ export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
67
67
  export type BorrowerApplicationStatus = "Draft" | "Complete";
68
68
  export type BillingType = "ClosedLoan" | "LoanOfficer";
69
69
  export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
70
- export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
71
- export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
72
- export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
73
- export type AiQueryTemplateName = "PipelineSummary" | "LoanDetail" | "LoansClosing" | "StaleLoans" | "LoansByType" | "LoansByOfficer" | "AverageLoanAmount" | "LockedVsUnlocked" | "LoansByPurpose" | "LoansByPropertyState" | "LoansByRate" | "DtiLtvRisk" | "DisclosureTracking" | "NewLoans" | "ExpiringLocks" | "ClosedLoans";
74
- export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
75
- export type AiOutputType = "Text" | "Document";
76
- export type AiIntent = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action";
77
- export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
78
- export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
79
- export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched";
80
70
  export type AddressFamily = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
81
71
  export interface ASOSettings {
82
72
  enabled: boolean;
@@ -127,7 +117,7 @@ export interface AccountBilling {
127
117
  contractedRate: number;
128
118
  }
129
119
  export interface AccountBillingRequest {
130
- billingType: "ClosedLoan" | "LoanOfficer";
120
+ billingType: AccountBillingRequestBillingTypeEnum;
131
121
  /** @format double */
132
122
  contractedRate: number;
133
123
  }
@@ -156,13 +146,11 @@ export interface AccountSettings {
156
146
  smsNumber?: string | null;
157
147
  ssoHostOverride?: string | null;
158
148
  isEarlyAdopter: boolean;
159
- isAIEnabled: boolean;
160
149
  }
161
150
  export interface AccountSettingsRequest {
162
151
  isSmsEnabled: boolean;
163
152
  smsNumber?: string | null;
164
153
  isEarlyAdopter: boolean;
165
- isAIEnabled: boolean;
166
154
  }
167
155
  export interface Action {
168
156
  /** @format uuid */
@@ -171,7 +159,7 @@ export interface Action {
171
159
  comments?: string | null;
172
160
  /** @format uuid */
173
161
  siteConfigurationID: string;
174
- applicationSettings?: any;
162
+ applicationSettings?: any | null;
175
163
  surveysToken?: string | null;
176
164
  }
177
165
  export interface Address {
@@ -306,236 +294,6 @@ export interface AffordabilityCalculatorRequest {
306
294
  /** @format double */
307
295
  annualInsurance: number;
308
296
  }
309
- export interface AiAdminSettings {
310
- bedrockModelId: string;
311
- /** @format int32 */
312
- maxTokens: number;
313
- /** @format double */
314
- temperature: number;
315
- /** @format int32 */
316
- conversationContextTurns: number;
317
- /** @format int32 */
318
- requestTimeoutSeconds: number;
319
- bedrockRegion: string;
320
- }
321
- export interface AiAdminSettingsRequest {
322
- bedrockModelId?: string | null;
323
- /** @format int32 */
324
- maxTokens?: number | null;
325
- /** @format double */
326
- temperature?: number | null;
327
- /** @format int32 */
328
- conversationContextTurns?: number | null;
329
- /** @format int32 */
330
- requestTimeoutSeconds?: number | null;
331
- }
332
- export interface AiAdminStats {
333
- /** @format int32 */
334
- totalRequests: number;
335
- /** @format int32 */
336
- blockedRequests: number;
337
- /** @format double */
338
- averageResponseTimeMs: number;
339
- intentDistribution: Record<string, number>;
340
- topQueryTemplates: Record<string, number>;
341
- period: string;
342
- }
343
- export interface AiAuditLog {
344
- /** @format uuid */
345
- id: string;
346
- /** @format uuid */
347
- requestId: string;
348
- /** @format uuid */
349
- userId: string;
350
- eventType: "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched";
351
- details?: any;
352
- /** @format date-time */
353
- createdAt: string;
354
- }
355
- export interface AiAuditLogPaginated {
356
- rows: AiAuditLog[];
357
- pagination: Pagination;
358
- /** @format int64 */
359
- count: number;
360
- }
361
- export interface AiCanonicalField {
362
- /** @format uuid */
363
- id: string;
364
- canonicalName: string;
365
- displayName: string;
366
- description: string;
367
- allowedRoles: string[];
368
- efPath?: string | null;
369
- isPii: boolean;
370
- isActive: boolean;
371
- dataSource: string;
372
- isDefault: boolean;
373
- category?: string | null;
374
- jsonPropertyName?: string | null;
375
- textractKey?: string | null;
376
- textractKeyAliases?: string | null;
377
- hasAccountOverride: boolean;
378
- /** @format date-time */
379
- createdAt: string;
380
- /** @format date-time */
381
- updatedAt?: string | null;
382
- }
383
- export interface AiChat {
384
- /** @format uuid */
385
- conversationId: string;
386
- /** @format uuid */
387
- messageId: string;
388
- response: AiChatBody;
389
- metadata: AiChatMetadata;
390
- }
391
- export interface AiChatBody {
392
- text: string;
393
- data?: AiChatStructuredData | null;
394
- }
395
- export interface AiChatMessage {
396
- /** @format uuid */
397
- id: string;
398
- userMessage: string;
399
- assistantResponse: string;
400
- intent?: AiIntent | null;
401
- fieldsAccessed?: string[] | null;
402
- /** @format date-time */
403
- createdAt: string;
404
- }
405
- export interface AiChatMetadata {
406
- intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action";
407
- fieldsAccessed: string[];
408
- /** @format int64 */
409
- queryTimeMs: number;
410
- /** @format int64 */
411
- llmTimeMs: number;
412
- wasBlocked: boolean;
413
- blockedReason?: string | null;
414
- }
415
- export interface AiChatRequest {
416
- message: string;
417
- /** @format uuid */
418
- conversationId?: string | null;
419
- /** @format uuid */
420
- loanId?: string | null;
421
- documentIds?: string[] | null;
422
- /** @format uuid */
423
- promptId?: string | null;
424
- }
425
- export interface AiChatStructuredData {
426
- type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
427
- displayHint?: AiDisplayHint | null;
428
- detectedDocumentType?: string | null;
429
- columns: string[];
430
- rows: string[][];
431
- /** @format uuid */
432
- generatedDocumentId?: string | null;
433
- generatedFileName?: string | null;
434
- }
435
- export interface AiConversationDetail {
436
- /** @format uuid */
437
- id: string;
438
- /** @format date-time */
439
- createdAt: string;
440
- /** @format date-time */
441
- updatedAt?: string | null;
442
- messages: AiChatMessage[];
443
- }
444
- export interface AiConversationListItem {
445
- /** @format uuid */
446
- id: string;
447
- preview: string;
448
- /** @format int32 */
449
- messageCount: number;
450
- /** @format date-time */
451
- createdAt: string;
452
- /** @format date-time */
453
- updatedAt?: string | null;
454
- }
455
- export interface AiConversationListItemPaginated {
456
- rows: AiConversationListItem[];
457
- pagination: Pagination;
458
- /** @format int64 */
459
- count: number;
460
- }
461
- export interface AiGuardrail {
462
- /** @format uuid */
463
- id: string;
464
- name: string;
465
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
466
- description?: string | null;
467
- keywords: string[];
468
- responseTemplate: string;
469
- isDefault: boolean;
470
- isEnabled: boolean;
471
- hasAccountOverride: boolean;
472
- /** @format date-time */
473
- createdAt: string;
474
- /** @format date-time */
475
- updatedAt?: string | null;
476
- }
477
- export interface AiPrompt {
478
- /** @format uuid */
479
- id: string;
480
- title: string;
481
- slug: string;
482
- description: string;
483
- documentTypes: string[];
484
- applicableUrlSourceIds: string[];
485
- allowedRoles: string[];
486
- systemPrompt: string;
487
- /** @format int32 */
488
- sortOrder: number;
489
- isDefault: boolean;
490
- /** @format uuid */
491
- accountId?: string | null;
492
- isActive: boolean;
493
- category?: AiPromptCategory | null;
494
- queryTemplateName?: AiQueryTemplateName | null;
495
- displayHint?: AiDisplayHint | null;
496
- bedrockModelId?: string | null;
497
- requiredDataSources?: string[] | null;
498
- outputType?: AiOutputType | null;
499
- hasAccountOverride: boolean;
500
- /** @format date-time */
501
- createdAt: string;
502
- /** @format date-time */
503
- updatedAt?: string | null;
504
- }
505
- export interface AiPromptSummary {
506
- /** @format uuid */
507
- id: string;
508
- title: string;
509
- slug: string;
510
- description: string;
511
- documentTypes: string[];
512
- applicableUrlSourceIds: string[];
513
- /** @format int32 */
514
- sortOrder: number;
515
- category?: AiPromptCategory | null;
516
- queryTemplateName?: AiQueryTemplateName | null;
517
- displayHint?: AiDisplayHint | null;
518
- bedrockModelId?: string | null;
519
- requiredDataSources?: string[] | null;
520
- outputType?: AiOutputType | null;
521
- }
522
- export interface AiUrlSource {
523
- /** @format uuid */
524
- id: string;
525
- slug?: string | null;
526
- name: string;
527
- url: string;
528
- description?: string | null;
529
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
530
- scope: "FullDomain" | "SpecificPath";
531
- isActive: boolean;
532
- isDefault: boolean;
533
- hasAccountOverride: boolean;
534
- /** @format date-time */
535
- createdAt: string;
536
- /** @format date-time */
537
- updatedAt?: string | null;
538
- }
539
297
  export interface AllowImpersonationRequest {
540
298
  email: string;
541
299
  }
@@ -638,14 +396,14 @@ export interface AuditLogEntry {
638
396
  /** @format uuid */
639
397
  id: string;
640
398
  entityType: string;
641
- changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
399
+ changeType: AuditLogEntryChangeTypeEnum;
642
400
  /** @format uuid */
643
401
  entityId: string;
644
402
  performedBy?: AuditLogUser | null;
645
403
  rootEntityType?: string | null;
646
404
  /** @format uuid */
647
405
  rootEntityId?: string | null;
648
- changes?: any;
406
+ changes?: any | null;
649
407
  /** @format date-time */
650
408
  createdAt: string;
651
409
  }
@@ -685,10 +443,23 @@ export interface BorrowerCount {
685
443
  firstName: string;
686
444
  lastName: string;
687
445
  email: string;
688
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
446
+ role: BorrowerCountRoleEnum;
689
447
  /** @format int32 */
690
448
  count: number;
691
449
  }
450
+ export interface BorrowerIdentity {
451
+ /** @format uuid */
452
+ userId: string;
453
+ firstName: string;
454
+ lastName: string;
455
+ email: string;
456
+ role: BorrowerIdentityRoleEnum;
457
+ }
458
+ export interface BorrowersNotUsingPosSummary {
459
+ /** @format int32 */
460
+ total: number;
461
+ borrowers: UnregisteredBorrower[];
462
+ }
692
463
  export interface BranchBase {
693
464
  /** @format date-time */
694
465
  createdAt: string;
@@ -916,7 +687,7 @@ export interface CorporateSearchCriteria {
916
687
  isActive?: boolean | null;
917
688
  }
918
689
  export interface CreateAccessScopeRequest {
919
- scopeType: "User" | "Branch";
690
+ scopeType: CreateAccessScopeRequestScopeTypeEnum;
920
691
  /** @format uuid */
921
692
  userId?: string | null;
922
693
  /** @format uuid */
@@ -934,49 +705,10 @@ export interface CreateAccountRequest {
934
705
  /** @format int64 */
935
706
  nlmsid: number;
936
707
  settings: AccountSettingsRequest;
937
- environment: "Development" | "Staging" | "UAT" | "Production";
708
+ environment: CreateAccountRequestEnvironmentEnum;
938
709
  losIntegration: LOSIntegration;
939
710
  billingSettings: AccountBillingRequest;
940
711
  }
941
- export interface CreateAiCanonicalFieldRequest {
942
- displayName: string;
943
- description: string;
944
- allowedRoles: string[];
945
- isPii: boolean;
946
- dataSource: string;
947
- category?: string | null;
948
- }
949
- export interface CreateAiGuardrailRequest {
950
- name: string;
951
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
952
- description?: string | null;
953
- keywords: string[];
954
- responseTemplate: string;
955
- }
956
- export interface CreateAiPromptRequest {
957
- title: string;
958
- slug: string;
959
- description: string;
960
- documentTypes: string[];
961
- applicableUrlSourceIds: string[];
962
- allowedRoles: string[];
963
- systemPrompt: string;
964
- /** @format int32 */
965
- sortOrder: number;
966
- category?: AiPromptCategory | null;
967
- queryTemplateName?: AiQueryTemplateName | null;
968
- displayHint?: AiDisplayHint | null;
969
- bedrockModelId?: string | null;
970
- requiredDataSources?: string[] | null;
971
- outputType?: AiOutputType | null;
972
- }
973
- export interface CreateAiUrlSourceRequest {
974
- name: string;
975
- url: string;
976
- description?: string | null;
977
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
978
- scope: "FullDomain" | "SpecificPath";
979
- }
980
712
  export interface CreateBranchRequest {
981
713
  name: string;
982
714
  /** @format uuid */
@@ -998,8 +730,8 @@ export interface CreateCustomFieldDefinitionRequest {
998
730
  name: string;
999
731
  defaultValue?: string | null;
1000
732
  regexPattern?: string | null;
1001
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1002
- entityType: "Loan";
733
+ dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
734
+ entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
1003
735
  options?: CustomFieldOptionRequest[] | null;
1004
736
  permissions?: CustomFieldPermissionRequest[] | null;
1005
737
  }
@@ -1014,7 +746,7 @@ export interface CreateDocumentTemplateRequest {
1014
746
  export interface CreateGroupMemberRequest {
1015
747
  /** @format uuid */
1016
748
  userId: string;
1017
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
749
+ loanRole: CreateGroupMemberRequestLoanRoleEnum;
1018
750
  }
1019
751
  export interface CreateInviteRequest {
1020
752
  firstName: string;
@@ -1022,7 +754,7 @@ export interface CreateInviteRequest {
1022
754
  emailAddress: string;
1023
755
  phoneNumber?: string | null;
1024
756
  /** @deprecated */
1025
- relationship: "NotApplicable" | "Spouse" | "NonSpouse";
757
+ relationship: CreateInviteRequestRelationshipEnum;
1026
758
  loanID: string;
1027
759
  route?: string | null;
1028
760
  /** @format uuid */
@@ -1042,7 +774,7 @@ export interface CreateLoanImportRequest {
1042
774
  endDate: string;
1043
775
  /** @format date-time */
1044
776
  startDate: string;
1045
- importMode: "All" | "NewOnly" | "UpdateOnly";
777
+ importMode: CreateLoanImportRequestImportModeEnum;
1046
778
  }
1047
779
  export interface CreateSession {
1048
780
  sessionId: string;
@@ -1060,7 +792,7 @@ export interface CreateUserDeviceRequest {
1060
792
  token: string;
1061
793
  }
1062
794
  export interface CreateUserDraft {
1063
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
795
+ loanRole: CreateUserDraftLoanRoleEnum;
1064
796
  }
1065
797
  export interface CreateUserGroupRequest {
1066
798
  name: string;
@@ -1090,6 +822,11 @@ export interface CreateUserRequest {
1090
822
  export interface CreateWebhookRequest {
1091
823
  webhookPath: string;
1092
824
  }
825
+ export interface CreditAuthPendingSummary {
826
+ /** @format int32 */
827
+ total: number;
828
+ borrowers: BorrowerIdentity[];
829
+ }
1093
830
  export interface CustomFieldDefinition {
1094
831
  /** @format date-time */
1095
832
  createdAt: string;
@@ -1116,8 +853,8 @@ export interface CustomFieldDefinition {
1116
853
  name: string;
1117
854
  defaultValue?: string | null;
1118
855
  regexPattern?: string | null;
1119
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1120
- entityType: "Loan";
856
+ dataType: CustomFieldDefinitionDataTypeEnum;
857
+ entityType: CustomFieldDefinitionEntityTypeEnum;
1121
858
  options: CustomFieldOption[];
1122
859
  permissions: CustomFieldPermission[];
1123
860
  encompassMapping?: EncompassMapping | null;
@@ -1131,7 +868,7 @@ export interface CustomFieldEntry {
1131
868
  displayOrder: number;
1132
869
  name: string;
1133
870
  value: string;
1134
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
871
+ dataType: CustomFieldEntryDataTypeEnum;
1135
872
  }
1136
873
  export interface CustomFieldOption {
1137
874
  /** @format uuid */
@@ -1148,12 +885,12 @@ export interface CustomFieldOptionRequest {
1148
885
  export interface CustomFieldPermission {
1149
886
  /** @format uuid */
1150
887
  id: string;
1151
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1152
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
888
+ role: CustomFieldPermissionRoleEnum;
889
+ accessLevel: CustomFieldPermissionAccessLevelEnum;
1153
890
  }
1154
891
  export interface CustomFieldPermissionRequest {
1155
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1156
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
892
+ role: CustomFieldPermissionRequestRoleEnum;
893
+ accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
1157
894
  }
1158
895
  export interface CustomFieldValue {
1159
896
  /** @format uuid */
@@ -1164,7 +901,7 @@ export interface CustomFieldValue {
1164
901
  customFieldDefinitionID: string;
1165
902
  value: string;
1166
903
  definitionName: string;
1167
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
904
+ dataType: CustomFieldValueDataTypeEnum;
1168
905
  }
1169
906
  export interface DetailedUser {
1170
907
  /** @format date-time */
@@ -1402,7 +1139,7 @@ export interface Draft {
1402
1139
  siteConfiguration: SiteConfigurationReduced;
1403
1140
  /** @format uuid */
1404
1141
  loanID?: string | null;
1405
- type: "NewLoan" | "EditLoan";
1142
+ type: DraftTypeEnum;
1406
1143
  isCoBorrower: boolean;
1407
1144
  }
1408
1145
  export interface DraftContent {
@@ -1420,7 +1157,7 @@ export interface DraftContent {
1420
1157
  siteConfiguration: SiteConfigurationReduced;
1421
1158
  /** @format uuid */
1422
1159
  loanID?: string | null;
1423
- type: "NewLoan" | "EditLoan";
1160
+ type: DraftContentTypeEnum;
1424
1161
  isCoBorrower: boolean;
1425
1162
  applicationPayload: any;
1426
1163
  }
@@ -1436,9 +1173,14 @@ export interface DraftLoanOfficerReassignRequest {
1436
1173
  }
1437
1174
  export interface DraftRequest {
1438
1175
  applicationPayload: any;
1439
- customData?: any;
1176
+ customData?: any | null;
1440
1177
  isCoBorrower: boolean;
1441
1178
  }
1179
+ export interface EconsentPendingSummary {
1180
+ /** @format int32 */
1181
+ total: number;
1182
+ borrowers: BorrowerIdentity[];
1183
+ }
1442
1184
  export interface EnabledServices {
1443
1185
  /** @format date-time */
1444
1186
  createdAt: string;
@@ -1505,9 +1247,9 @@ export interface EncompassCredentialsDetail {
1505
1247
  clearStateIfUnlicensed: boolean;
1506
1248
  /** @deprecated */
1507
1249
  baseUrl?: string | null;
1508
- encompassEnvironment: "Production" | "UAT";
1250
+ encompassEnvironment: EncompassCredentialsDetailEncompassEnvironmentEnum;
1509
1251
  consumerConnectWidgetHost?: string | null;
1510
- signingMethod: "ConsumerConnect" | "POSF";
1252
+ signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1511
1253
  subscriptionId?: string | null;
1512
1254
  environment?: string | null;
1513
1255
  }
@@ -1523,9 +1265,9 @@ export interface EncompassCredentialsRequest {
1523
1265
  clearStateIfUnlicensed: boolean;
1524
1266
  /** @deprecated */
1525
1267
  baseUrl?: string | null;
1526
- encompassEnvironment: "Production" | "UAT";
1268
+ encompassEnvironment: EncompassCredentialsRequestEncompassEnvironmentEnum;
1527
1269
  consumerConnectWidgetHost?: string | null;
1528
- signingMethod: "ConsumerConnect" | "POSF";
1270
+ signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1529
1271
  subscriptionId?: string | null;
1530
1272
  environment?: string | null;
1531
1273
  clientID?: string | null;
@@ -1634,8 +1376,8 @@ export interface EncompassRequestLog {
1634
1376
  losId?: string | null;
1635
1377
  /** @format uuid */
1636
1378
  accountId: string;
1637
- operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
1638
- outcome: "Success" | "Failure" | "PartialSuccess";
1379
+ operationType: EncompassRequestLogOperationTypeEnum;
1380
+ outcome: EncompassRequestLogOutcomeEnum;
1639
1381
  message: string;
1640
1382
  endpoint?: string | null;
1641
1383
  httpMethod?: string | null;
@@ -1643,7 +1385,7 @@ export interface EncompassRequestLog {
1643
1385
  httpStatusCode?: number | null;
1644
1386
  /** @format int64 */
1645
1387
  durationMs?: number | null;
1646
- context?: any;
1388
+ context?: any | null;
1647
1389
  /** @format date-time */
1648
1390
  createdAt: string;
1649
1391
  }
@@ -1682,7 +1424,7 @@ export interface FileSearchCriteria {
1682
1424
  export interface FileWithBytes {
1683
1425
  name: string;
1684
1426
  /** @format byte */
1685
- data: string;
1427
+ data: Blob;
1686
1428
  fileName: string;
1687
1429
  mimeType?: string | null;
1688
1430
  extension?: string | null;
@@ -1758,7 +1500,7 @@ export interface FormSubmission {
1758
1500
  subjectPropertyAddressCounty?: string | null;
1759
1501
  subjectPropertyAddressState?: string | null;
1760
1502
  subjectPropertyAddressZip?: string | null;
1761
- data?: any;
1503
+ data?: any | null;
1762
1504
  /** @format uuid */
1763
1505
  listingID?: string | null;
1764
1506
  listing?: Listing | null;
@@ -1793,7 +1535,7 @@ export interface FormSubmissionRequest {
1793
1535
  subjectPropertyAddressCounty?: string | null;
1794
1536
  subjectPropertyAddressState?: string | null;
1795
1537
  subjectPropertyAddressZip?: string | null;
1796
- data?: any;
1538
+ data?: any | null;
1797
1539
  /** @format uuid */
1798
1540
  listingID?: string | null;
1799
1541
  }
@@ -1842,7 +1584,7 @@ export interface FusionFieldDisplay {
1842
1584
  fieldValue: string;
1843
1585
  }
1844
1586
  export interface FusionReportFilter {
1845
- filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
1587
+ filterType: FusionReportFilterFilterTypeEnum;
1846
1588
  targetField: string;
1847
1589
  targetValue: string;
1848
1590
  }
@@ -1859,13 +1601,6 @@ export interface GenerateDocumentRequest {
1859
1601
  preview: boolean;
1860
1602
  recipients: string[];
1861
1603
  }
1862
- export interface GenerateSystemPrompt {
1863
- systemPrompt: string;
1864
- }
1865
- export interface GenerateSystemPromptRequest {
1866
- description: string;
1867
- category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
1868
- }
1869
1604
  export interface GetApplications {
1870
1605
  applications: ApplicationRowData[];
1871
1606
  }
@@ -1948,11 +1683,11 @@ export interface GetWorkflowRequest {
1948
1683
  export interface GuidPatchOperation {
1949
1684
  op: string;
1950
1685
  path: string;
1951
- value?: any;
1686
+ value?: any | null;
1952
1687
  from?: string | null;
1953
1688
  }
1954
1689
  export interface IPAddress {
1955
- addressFamily: "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
1690
+ addressFamily: IpAddressAddressFamilyEnum;
1956
1691
  /** @format int64 */
1957
1692
  scopeId: number;
1958
1693
  isIPv6Multicast: boolean;
@@ -2196,7 +1931,7 @@ export interface Loan {
2196
1931
  userLoans: UserLoan[];
2197
1932
  contacts: LoanContact[];
2198
1933
  customFields: CustomFieldEntry[];
2199
- signingMethod: "ConsumerConnect" | "POSF";
1934
+ signingMethod: LoanSigningMethodEnum;
2200
1935
  }
2201
1936
  export interface LoanApplication {
2202
1937
  /** @format uuid */
@@ -2232,7 +1967,7 @@ export interface LoanApplicationRequest {
2232
1967
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2233
1968
  /** @format uuid */
2234
1969
  draftId?: string | null;
2235
- additionalFields?: Record<string, any>;
1970
+ additionalFields?: Record<string, any> | null;
2236
1971
  /** @format uuid */
2237
1972
  existingLoanId?: string | null;
2238
1973
  }
@@ -2251,7 +1986,7 @@ export interface LoanBorrower {
2251
1986
  citizenship?: LoanCitizenship | null;
2252
1987
  maritalStatus?: LoanMaritalStatus | null;
2253
1988
  languagePreference?: LoanLanguagePreference | null;
2254
- applicationStatus: "Draft" | "Complete";
1989
+ applicationStatus: LoanBorrowerApplicationStatusEnum;
2255
1990
  /** @format int32 */
2256
1991
  numberOfDependents?: number | null;
2257
1992
  isPrimaryBorrower: boolean;
@@ -2953,7 +2688,7 @@ export interface LoanConsentRequest {
2953
2688
  borrowerEConsent?: boolean | null;
2954
2689
  borrowerCreditAuth?: boolean | null;
2955
2690
  borrowerTCPAOptIn?: boolean | null;
2956
- additionalFields?: Record<string, string>;
2691
+ additionalFields?: Record<string, string> | null;
2957
2692
  }
2958
2693
  export interface LoanContact {
2959
2694
  /** @format date-time */
@@ -2971,13 +2706,13 @@ export interface LoanContact {
2971
2706
  email?: string | null;
2972
2707
  phone?: string | null;
2973
2708
  companyName?: string | null;
2974
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
2709
+ role: LoanContactRoleEnum;
2975
2710
  }
2976
2711
  export interface LoanContactList {
2977
2712
  email: string;
2978
2713
  }
2979
2714
  export interface LoanCustomFieldsRequest {
2980
- additionalFields?: Record<string, string>;
2715
+ additionalFields?: Record<string, string> | null;
2981
2716
  }
2982
2717
  export interface LoanDocument {
2983
2718
  /** @format date-time */
@@ -3020,12 +2755,12 @@ export interface LoanDocumentFolderPermission {
3020
2755
  id: string;
3021
2756
  /** @format uuid */
3022
2757
  loanDocumentFolderID: string;
3023
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3024
- level: "None" | "Read" | "Write" | "Manage";
2758
+ role: LoanDocumentFolderPermissionRoleEnum;
2759
+ level: LoanDocumentFolderPermissionLevelEnum;
3025
2760
  }
3026
2761
  export interface LoanDocumentFolderPermissionRequest {
3027
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3028
- level: "None" | "Read" | "Write" | "Manage";
2762
+ role: LoanDocumentFolderPermissionRequestRoleEnum;
2763
+ level: LoanDocumentFolderPermissionRequestLevelEnum;
3029
2764
  }
3030
2765
  export interface LoanDocumentFolderUsage {
3031
2766
  /** @format uuid */
@@ -3124,13 +2859,13 @@ export interface LoanImport {
3124
2859
  /** @format int32 */
3125
2860
  importedCount: number;
3126
2861
  statusMessage?: string | null;
3127
- status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3128
- importMode: "All" | "NewOnly" | "UpdateOnly";
2862
+ status: LoanImportStatusEnum;
2863
+ importMode: LoanImportImportModeEnum;
3129
2864
  /** @format date-time */
3130
2865
  createdAt?: string | null;
3131
2866
  }
3132
2867
  export interface LoanImportLog {
3133
- level: "None" | "Info" | "Warning" | "Error";
2868
+ level: LoanImportLogLevelEnum;
3134
2869
  message: string;
3135
2870
  /** @format date-time */
3136
2871
  createdAt: string;
@@ -3185,8 +2920,8 @@ export interface LoanListPaginated {
3185
2920
  export interface LoanLog {
3186
2921
  /** @format uuid */
3187
2922
  id: string;
3188
- level: "None" | "Info" | "Warning" | "Error";
3189
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
2923
+ level: LoanLogLevelEnum;
2924
+ type: LoanLogTypeEnum;
3190
2925
  message: string;
3191
2926
  /** @format date-time */
3192
2927
  createdAt: string;
@@ -3194,8 +2929,8 @@ export interface LoanLog {
3194
2929
  export interface LoanLogDetail {
3195
2930
  /** @format uuid */
3196
2931
  id: string;
3197
- level: "None" | "Info" | "Warning" | "Error";
3198
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
2932
+ level: LoanLogDetailLevelEnum;
2933
+ type: LoanLogDetailTypeEnum;
3199
2934
  message: string;
3200
2935
  /** @format date-time */
3201
2936
  createdAt: string;
@@ -3267,6 +3002,10 @@ export interface LoanOutstandingItems {
3267
3002
  pendingSignaturePackages: number;
3268
3003
  pendingTasks: PendingTasksSummary;
3269
3004
  pendingSignatures: PendingSignaturesSummary;
3005
+ pendingInvites: PendingInvitesSummary;
3006
+ creditAuthPending: CreditAuthPendingSummary;
3007
+ econsentPending: EconsentPendingSummary;
3008
+ borrowersNotUsingPos: BorrowersNotUsingPosSummary;
3270
3009
  }
3271
3010
  export interface LoanPatchRequestGuidPatchDocument {
3272
3011
  operations: GuidPatchOperation[];
@@ -3399,7 +3138,7 @@ export interface LoanQueueWithData {
3399
3138
  user: UserPublic;
3400
3139
  loanOfficer: LoanOfficerPublic;
3401
3140
  siteConfiguration: SiteConfigurationReduced;
3402
- data?: any;
3141
+ data?: any | null;
3403
3142
  }
3404
3143
  export interface LoanRecord {
3405
3144
  loanGuid: string;
@@ -3430,7 +3169,7 @@ export interface LoanTaskSearchRequest {
3430
3169
  loanStatus?: LoanTaskActivityFilter | null;
3431
3170
  }
3432
3171
  export interface LoanTaskStatusSummary {
3433
- status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3172
+ status: LoanTaskStatusSummaryStatusEnum;
3434
3173
  /** @format int32 */
3435
3174
  count: number;
3436
3175
  }
@@ -3442,7 +3181,7 @@ export interface LoanUser {
3442
3181
  email: string;
3443
3182
  phone?: string | null;
3444
3183
  role: string;
3445
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3184
+ loanRole: LoanUserLoanRoleEnum;
3446
3185
  isUser: boolean;
3447
3186
  /** @format date-time */
3448
3187
  createdAt: string;
@@ -3475,7 +3214,7 @@ export interface LosOperationTracking {
3475
3214
  operationType: string;
3476
3215
  correlationKey: string;
3477
3216
  lastTriggerSource?: string | null;
3478
- status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
3217
+ status: LosOperationTrackingStatusEnum;
3479
3218
  /** @format date-time */
3480
3219
  createdAt: string;
3481
3220
  /** @format date-time */
@@ -3536,7 +3275,7 @@ export interface LosSyncStep {
3536
3275
  /** @format int32 */
3537
3276
  order: number;
3538
3277
  name: string;
3539
- severity: "Success" | "Info" | "Warning" | "Error";
3278
+ severity: LosSyncStepSeverityEnum;
3540
3279
  message: string;
3541
3280
  /** @format date-time */
3542
3281
  atUtc: string;
@@ -3626,7 +3365,7 @@ export interface ModuleParameterValue {
3626
3365
  parameterID: string;
3627
3366
  parameterName: string;
3628
3367
  parameterType: string;
3629
- value?: any;
3368
+ value?: any | null;
3630
3369
  isInherited: boolean;
3631
3370
  }
3632
3371
  export interface MonthlyPaymentCalculator {
@@ -3799,7 +3538,7 @@ export interface NotificationTemplateVersionUpdateRequest {
3799
3538
  }
3800
3539
  export interface Operation {
3801
3540
  op?: string;
3802
- value?: string | number | boolean | null | object;
3541
+ value?: object | null;
3803
3542
  path?: string;
3804
3543
  }
3805
3544
  export interface OverridePasswordRequest {
@@ -3817,6 +3556,23 @@ export interface PartnerSearchCriteria {
3817
3556
  brands?: string[] | null;
3818
3557
  roles?: UserRole[] | null;
3819
3558
  }
3559
+ export interface PendingInvite {
3560
+ /** @format uuid */
3561
+ inviteId: string;
3562
+ firstName: string;
3563
+ lastName: string;
3564
+ email: string;
3565
+ phoneNumber?: string | null;
3566
+ role?: LoanRole | null;
3567
+ /** @format date-time */
3568
+ createdAt: string;
3569
+ url: string;
3570
+ }
3571
+ export interface PendingInvitesSummary {
3572
+ /** @format int32 */
3573
+ total: number;
3574
+ invites: PendingInvite[];
3575
+ }
3820
3576
  export interface PendingSignaturesSummary {
3821
3577
  /** @format int32 */
3822
3578
  total: number;
@@ -4095,7 +3851,7 @@ export interface SiteConfiguration {
4095
3851
  deletedAt?: string | null;
4096
3852
  /** @format uuid */
4097
3853
  id: string;
4098
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3854
+ type: SiteConfigurationTypeEnum;
4099
3855
  /** @format uuid */
4100
3856
  entityID: string;
4101
3857
  /** @format int32 */
@@ -4288,7 +4044,7 @@ export interface SiteConfigurationByUrl {
4288
4044
  deletedAt?: string | null;
4289
4045
  /** @format uuid */
4290
4046
  id: string;
4291
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4047
+ type: SiteConfigurationByUrlTypeEnum;
4292
4048
  /** @format uuid */
4293
4049
  entityID: string;
4294
4050
  /** @format int32 */
@@ -4498,7 +4254,7 @@ export interface SiteConfigurationForm {
4498
4254
  export interface SiteConfigurationReduced {
4499
4255
  /** @format uuid */
4500
4256
  id: string;
4501
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4257
+ type: SiteConfigurationReducedTypeEnum;
4502
4258
  url?: string | null;
4503
4259
  name: string;
4504
4260
  /** @format int64 */
@@ -4515,7 +4271,7 @@ export interface SiteConfigurationRequest {
4515
4271
  entityID: string;
4516
4272
  /** @format int32 */
4517
4273
  entityType: number;
4518
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4274
+ type: SiteConfigurationRequestTypeEnum;
4519
4275
  url: string;
4520
4276
  name: string;
4521
4277
  introduction?: string | null;
@@ -4690,7 +4446,7 @@ export interface SiteConfigurationSearchCriteria {
4690
4446
  export interface SiteConfigurationSummary {
4691
4447
  /** @format uuid */
4692
4448
  id: string;
4693
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4449
+ type: SiteConfigurationSummaryTypeEnum;
4694
4450
  url?: string | null;
4695
4451
  name: string;
4696
4452
  /** @format int64 */
@@ -4734,13 +4490,6 @@ export interface SocialSurveyRecord {
4734
4490
  /** @format date-time */
4735
4491
  reviewCompletedTimeStamp?: string | null;
4736
4492
  }
4737
- export interface SupportedModel {
4738
- modelId: string;
4739
- displayName: string;
4740
- provider: string;
4741
- description?: string | null;
4742
- isDefault: boolean;
4743
- }
4744
4493
  export interface SurveyEmailRequest {
4745
4494
  loanOfficerEmailAddress: string;
4746
4495
  }
@@ -4946,6 +4695,15 @@ export interface UnprocessableEntityError {
4946
4695
  error: string;
4947
4696
  property: string;
4948
4697
  }
4698
+ export interface UnregisteredBorrower {
4699
+ /** @format uuid */
4700
+ contactId: string;
4701
+ firstName?: string | null;
4702
+ lastName?: string | null;
4703
+ fullName?: string | null;
4704
+ email?: string | null;
4705
+ role: UnregisteredBorrowerRoleEnum;
4706
+ }
4949
4707
  export interface UpdateAccountRequest {
4950
4708
  name: string;
4951
4709
  mfaPreference: string;
@@ -4955,42 +4713,6 @@ export interface UpdateAccountRequest {
4955
4713
  asoSettings?: ASOSettings | null;
4956
4714
  settings: AccountSettingsRequest;
4957
4715
  }
4958
- export interface UpdateAiCanonicalFieldRequest {
4959
- displayName: string;
4960
- description: string;
4961
- allowedRoles: string[];
4962
- isPii: boolean;
4963
- }
4964
- export interface UpdateAiGuardrailRequest {
4965
- name: string;
4966
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
4967
- description?: string | null;
4968
- keywords: string[];
4969
- responseTemplate: string;
4970
- }
4971
- export interface UpdateAiPromptRequest {
4972
- title: string;
4973
- description: string;
4974
- documentTypes: string[];
4975
- applicableUrlSourceIds: string[];
4976
- allowedRoles: string[];
4977
- systemPrompt: string;
4978
- /** @format int32 */
4979
- sortOrder: number;
4980
- category?: AiPromptCategory | null;
4981
- queryTemplateName?: AiQueryTemplateName | null;
4982
- displayHint?: AiDisplayHint | null;
4983
- bedrockModelId?: string | null;
4984
- requiredDataSources?: string[] | null;
4985
- outputType?: AiOutputType | null;
4986
- }
4987
- export interface UpdateAiUrlSourceRequest {
4988
- name: string;
4989
- url: string;
4990
- description?: string | null;
4991
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
4992
- scope: "FullDomain" | "SpecificPath";
4993
- }
4994
4716
  export interface UpdateCustomFieldDefinitionRequest {
4995
4717
  isRequired: boolean;
4996
4718
  /** @format int32 */
@@ -5276,7 +4998,7 @@ export interface UserDevice {
5276
4998
  export interface UserDraft {
5277
4999
  /** @format uuid */
5278
5000
  draftID: string;
5279
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5001
+ role: UserDraftRoleEnum;
5280
5002
  user: User;
5281
5003
  }
5282
5004
  export interface UserDraftPaginated {
@@ -5300,7 +5022,7 @@ export interface UserGroupAccessScope {
5300
5022
  id: string;
5301
5023
  /** @format uuid */
5302
5024
  groupId: string;
5303
- scopeType: "User" | "Branch";
5025
+ scopeType: UserGroupAccessScopeScopeTypeEnum;
5304
5026
  /** @format uuid */
5305
5027
  userId?: string | null;
5306
5028
  /** @format uuid */
@@ -5333,7 +5055,7 @@ export interface UserLoan {
5333
5055
  deletedAt?: string | null;
5334
5056
  loanID: string;
5335
5057
  user: User;
5336
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5058
+ role: UserLoanRoleEnum;
5337
5059
  /** @format int32 */
5338
5060
  borrowerPair?: number | null;
5339
5061
  /** @format int32 */
@@ -5345,11 +5067,11 @@ export interface UserLoanConsent {
5345
5067
  id: string;
5346
5068
  /** @format uuid */
5347
5069
  userLoanID: string;
5348
- type: "Econsent" | "CreditAuthorization" | "Tcpa";
5070
+ type: UserLoanConsentTypeEnum;
5349
5071
  providedConsent: boolean;
5350
5072
  source?: ConsentSource | null;
5351
5073
  ipAddress?: string | null;
5352
- losSyncStatus: "NotStarted" | "Failed" | "Success";
5074
+ losSyncStatus: UserLoanConsentLosSyncStatusEnum;
5353
5075
  /** @format date-time */
5354
5076
  createdAt: string;
5355
5077
  /** @format date-time */
@@ -5479,7 +5201,7 @@ export interface UserSummary {
5479
5201
  id: string;
5480
5202
  name?: string | null;
5481
5203
  email?: string | null;
5482
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5204
+ role: UserSummaryRoleEnum;
5483
5205
  }
5484
5206
  export interface VerifyPasswordRequest {
5485
5207
  email: string;
@@ -5506,6 +5228,74 @@ export interface Workflow {
5506
5228
  tileSubtitle: string;
5507
5229
  icon: string;
5508
5230
  }
5231
+ export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
5232
+ export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
5233
+ export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5234
+ export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5235
+ export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
5236
+ export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
5237
+ export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5238
+ export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
5239
+ export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5240
+ /** @deprecated */
5241
+ export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
5242
+ export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5243
+ export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5244
+ export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5245
+ export type CustomFieldDefinitionEntityTypeEnum = "Loan";
5246
+ export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5247
+ export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5248
+ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5249
+ export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5250
+ export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5251
+ export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5252
+ export type DraftTypeEnum = "NewLoan" | "EditLoan";
5253
+ export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
5254
+ export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
5255
+ export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
5256
+ export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
5257
+ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
5258
+ export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
5259
+ export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
5260
+ export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
5261
+ export type IpAddressAddressFamilyEnum = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
5262
+ export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
5263
+ export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
5264
+ export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5265
+ export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5266
+ export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
5267
+ export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5268
+ export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
5269
+ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
5270
+ export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5271
+ export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5272
+ export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5273
+ export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
5274
+ export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
5275
+ export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
5276
+ export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
5277
+ export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5278
+ export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
5279
+ export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
5280
+ export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5281
+ export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5282
+ export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5283
+ export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5284
+ export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5285
+ export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5286
+ export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5287
+ export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
5288
+ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5289
+ export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
5290
+ export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
5291
+ export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5292
+ export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
5293
+ /** @default "Realtor" */
5294
+ export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5295
+ export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5296
+ export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5297
+ export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5298
+ export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5509
5299
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
5510
5300
  export type QueryParamsType = Record<string | number, any>;
5511
5301
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -5528,14 +5318,7 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
5528
5318
  secure?: boolean;
5529
5319
  format?: ResponseType;
5530
5320
  }
5531
- export declare enum ContentType {
5532
- JsonPatch = "application/json-patch+json",
5533
- Json = "application/json",
5534
- JsonApi = "application/vnd.api+json",
5535
- FormData = "multipart/form-data",
5536
- UrlEncoded = "application/x-www-form-urlencoded",
5537
- Text = "text/plain"
5538
- }
5321
+ export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
5539
5322
  export declare class HttpClient<SecurityDataType = unknown> {
5540
5323
  instance: AxiosInstance;
5541
5324
  private securityData;
@@ -5712,453 +5495,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5712
5495
  * @response `422` `ProblemDetails` Unprocessable Content
5713
5496
  */
5714
5497
  updateAccountBilling: (id: string, data: AccountBillingRequest, params?: RequestParams) => Promise<AxiosResponse<AccountBilling, any, {}>>;
5715
- /**
5716
- * No description
5717
- *
5718
- * @tags AiAdmin
5719
- * @name GetAiAuditLogs
5720
- * @summary Get paginated audit logs
5721
- * @request GET:/api/ai/admin/audit-logs
5722
- * @secure
5723
- * @response `200` `AiAuditLogPaginated` OK
5724
- */
5725
- getAiAuditLogs: (query?: {
5726
- eventType?: AiAuditEventType;
5727
- /** @format date-time */
5728
- startDate?: string;
5729
- /** @format date-time */
5730
- endDate?: string;
5731
- /** @format int32 */
5732
- pageSize?: number;
5733
- /** @format int32 */
5734
- pageNumber?: number;
5735
- sortBy?: string;
5736
- sortDirection?: string;
5737
- }, params?: RequestParams) => Promise<AxiosResponse<AiAuditLogPaginated, any, {}>>;
5738
- /**
5739
- * No description
5740
- *
5741
- * @tags AiAdmin
5742
- * @name GetAiAdminStats
5743
- * @summary Get AI admin dashboard stats
5744
- * @request GET:/api/ai/admin/stats
5745
- * @secure
5746
- * @response `200` `AiAdminStats` OK
5747
- */
5748
- getAiAdminStats: (query?: {
5749
- /** @format date-time */
5750
- startDate?: string;
5751
- /** @format date-time */
5752
- endDate?: string;
5753
- }, params?: RequestParams) => Promise<AxiosResponse<AiAdminStats, any, {}>>;
5754
- /**
5755
- * No description
5756
- *
5757
- * @tags AiAdminPrompt
5758
- * @name GetAiPrompts
5759
- * @summary Get all prompts
5760
- * @request GET:/api/ai/admin/prompts
5761
- * @secure
5762
- * @response `200` `(AiPrompt)[]` OK
5763
- */
5764
- getAiPrompts: (params?: RequestParams) => Promise<AxiosResponse<AiPrompt[], any, {}>>;
5765
- /**
5766
- * No description
5767
- *
5768
- * @tags AiAdminPrompt
5769
- * @name CreateAiPrompt
5770
- * @summary Create custom prompt
5771
- * @request POST:/api/ai/admin/prompts
5772
- * @secure
5773
- * @response `201` `AiPrompt` Created
5774
- * @response `400` `ProblemDetails` Bad Request
5775
- */
5776
- createAiPrompt: (data: CreateAiPromptRequest, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5777
- /**
5778
- * No description
5779
- *
5780
- * @tags AiAdminPrompt
5781
- * @name GetAiPrompt
5782
- * @summary Get prompt by ID
5783
- * @request GET:/api/ai/admin/prompts/{id}
5784
- * @secure
5785
- * @response `200` `AiPrompt` OK
5786
- * @response `404` `ProblemDetails` Not Found
5787
- */
5788
- getAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5789
- /**
5790
- * No description
5791
- *
5792
- * @tags AiAdminPrompt
5793
- * @name UpdateAiPrompt
5794
- * @summary Update prompt
5795
- * @request PUT:/api/ai/admin/prompts/{id}
5796
- * @secure
5797
- * @response `200` `AiPrompt` OK
5798
- * @response `400` `ProblemDetails` Bad Request
5799
- * @response `404` `ProblemDetails` Not Found
5800
- */
5801
- updateAiPrompt: (id: string, data: UpdateAiPromptRequest, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5802
- /**
5803
- * No description
5804
- *
5805
- * @tags AiAdminPrompt
5806
- * @name DeleteAiPrompt
5807
- * @summary Delete prompt
5808
- * @request DELETE:/api/ai/admin/prompts/{id}
5809
- * @secure
5810
- * @response `204` `void` No Content
5811
- * @response `400` `ProblemDetails` Bad Request
5812
- * @response `404` `ProblemDetails` Not Found
5813
- */
5814
- deleteAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
5815
- /**
5816
- * No description
5817
- *
5818
- * @tags AiAdminPrompt
5819
- * @name ToggleAiPrompt
5820
- * @summary Toggle prompt active/inactive
5821
- * @request PATCH:/api/ai/admin/prompts/{id}/toggle
5822
- * @secure
5823
- * @response `200` `AiPrompt` OK
5824
- * @response `404` `ProblemDetails` Not Found
5825
- */
5826
- toggleAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5827
- /**
5828
- * No description
5829
- *
5830
- * @tags AiAdminPrompt
5831
- * @name GenerateAiSystemPrompt
5832
- * @summary Generate a system prompt from description
5833
- * @request POST:/api/ai/admin/prompts/generate
5834
- * @secure
5835
- * @response `200` `GenerateSystemPrompt` OK
5836
- * @response `400` `ProblemDetails` Bad Request
5837
- */
5838
- generateAiSystemPrompt: (data: GenerateSystemPromptRequest, params?: RequestParams) => Promise<AxiosResponse<GenerateSystemPrompt, any, {}>>;
5839
- /**
5840
- * No description
5841
- *
5842
- * @tags AiAdminPrompt
5843
- * @name GetSupportedModels
5844
- * @summary Get supported LLM models
5845
- * @request GET:/api/ai/admin/prompts/supported-models
5846
- * @secure
5847
- * @response `200` `(SupportedModel)[]` OK
5848
- */
5849
- getSupportedModels: (params?: RequestParams) => Promise<AxiosResponse<SupportedModel[], any, {}>>;
5850
- /**
5851
- * No description
5852
- *
5853
- * @tags AiAdminSettings
5854
- * @name GetAiAdminSettings
5855
- * @summary Get global AI settings
5856
- * @request GET:/api/ai/admin/settings
5857
- * @secure
5858
- * @response `200` `AiAdminSettings` OK
5859
- */
5860
- getAiAdminSettings: (params?: RequestParams) => Promise<AxiosResponse<AiAdminSettings, any, {}>>;
5861
- /**
5862
- * No description
5863
- *
5864
- * @tags AiAdminSettings
5865
- * @name UpdateAiAdminSettings
5866
- * @summary Update global AI settings
5867
- * @request PUT:/api/ai/admin/settings
5868
- * @secure
5869
- * @response `200` `AiAdminSettings` OK
5870
- * @response `400` `ProblemDetails` Bad Request
5871
- */
5872
- updateAiAdminSettings: (data: AiAdminSettingsRequest, params?: RequestParams) => Promise<AxiosResponse<AiAdminSettings, any, {}>>;
5873
- /**
5874
- * No description
5875
- *
5876
- * @tags AiCanonicalField
5877
- * @name GetAiCanonicalFields
5878
- * @summary Get all canonical fields
5879
- * @request GET:/api/ai/admin/fields
5880
- * @secure
5881
- * @response `200` `(AiCanonicalField)[]` OK
5882
- */
5883
- getAiCanonicalFields: (params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField[], any, {}>>;
5884
- /**
5885
- * No description
5886
- *
5887
- * @tags AiCanonicalField
5888
- * @name CreateAiCanonicalField
5889
- * @summary Create canonical field
5890
- * @request POST:/api/ai/admin/fields
5891
- * @secure
5892
- * @response `201` `AiCanonicalField` Created
5893
- * @response `400` `ProblemDetails` Bad Request
5894
- */
5895
- createAiCanonicalField: (data: CreateAiCanonicalFieldRequest, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5896
- /**
5897
- * No description
5898
- *
5899
- * @tags AiCanonicalField
5900
- * @name GetAiCanonicalField
5901
- * @summary Get canonical field by ID
5902
- * @request GET:/api/ai/admin/fields/{id}
5903
- * @secure
5904
- * @response `200` `AiCanonicalField` OK
5905
- * @response `404` `ProblemDetails` Not Found
5906
- */
5907
- getAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5908
- /**
5909
- * No description
5910
- *
5911
- * @tags AiCanonicalField
5912
- * @name UpdateAiCanonicalField
5913
- * @summary Update canonical field
5914
- * @request PUT:/api/ai/admin/fields/{id}
5915
- * @secure
5916
- * @response `200` `AiCanonicalField` OK
5917
- * @response `400` `ProblemDetails` Bad Request
5918
- * @response `404` `ProblemDetails` Not Found
5919
- */
5920
- updateAiCanonicalField: (id: string, data: UpdateAiCanonicalFieldRequest, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5921
- /**
5922
- * No description
5923
- *
5924
- * @tags AiCanonicalField
5925
- * @name DeleteAiCanonicalField
5926
- * @summary Delete canonical field
5927
- * @request DELETE:/api/ai/admin/fields/{id}
5928
- * @secure
5929
- * @response `204` `void` No Content
5930
- * @response `404` `ProblemDetails` Not Found
5931
- */
5932
- deleteAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
5933
- /**
5934
- * No description
5935
- *
5936
- * @tags AiCanonicalField
5937
- * @name ToggleAiCanonicalField
5938
- * @summary Toggle canonical field active/inactive
5939
- * @request PATCH:/api/ai/admin/fields/{id}/toggle
5940
- * @secure
5941
- * @response `200` `AiCanonicalField` OK
5942
- * @response `404` `ProblemDetails` Not Found
5943
- */
5944
- toggleAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5945
- /**
5946
- * No description
5947
- *
5948
- * @tags AiChat
5949
- * @name AiChat
5950
- * @summary Send AI chat message
5951
- * @request POST:/api/ai/chat
5952
- * @secure
5953
- * @response `200` `AiChat` OK
5954
- * @response `400` `ProblemDetails` Bad Request
5955
- * @response `401` `ProblemDetails` Unauthorized
5956
- */
5957
- aiChat: (data: AiChatRequest, params?: RequestParams) => Promise<AxiosResponse<AiChat, any, {}>>;
5958
- /**
5959
- * No description
5960
- *
5961
- * @tags AiConversation
5962
- * @name GetAiConversations
5963
- * @summary Get user conversations
5964
- * @request GET:/api/ai/conversations
5965
- * @secure
5966
- * @response `200` `AiConversationListItemPaginated` OK
5967
- */
5968
- getAiConversations: (query?: {
5969
- /** @format int32 */
5970
- pageSize?: number;
5971
- /** @format int32 */
5972
- pageNumber?: number;
5973
- sortBy?: string;
5974
- sortDirection?: string;
5975
- }, params?: RequestParams) => Promise<AxiosResponse<AiConversationListItemPaginated, any, {}>>;
5976
- /**
5977
- * No description
5978
- *
5979
- * @tags AiConversation
5980
- * @name GetAiConversation
5981
- * @summary Get conversation with messages
5982
- * @request GET:/api/ai/conversations/{id}
5983
- * @secure
5984
- * @response `200` `AiConversationDetail` OK
5985
- * @response `403` `ProblemDetails` Forbidden
5986
- * @response `404` `ProblemDetails` Not Found
5987
- */
5988
- getAiConversation: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiConversationDetail, any, {}>>;
5989
- /**
5990
- * No description
5991
- *
5992
- * @tags AiConversation
5993
- * @name DeleteAiConversation
5994
- * @summary Delete conversation
5995
- * @request DELETE:/api/ai/conversations/{id}
5996
- * @secure
5997
- * @response `204` `void` No Content
5998
- * @response `403` `ProblemDetails` Forbidden
5999
- * @response `404` `ProblemDetails` Not Found
6000
- */
6001
- deleteAiConversation: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6002
- /**
6003
- * No description
6004
- *
6005
- * @tags AiGuardrail
6006
- * @name GetAiGuardrails
6007
- * @summary Get all guardrails
6008
- * @request GET:/api/ai/admin/guardrails
6009
- * @secure
6010
- * @response `200` `(AiGuardrail)[]` OK
6011
- */
6012
- getAiGuardrails: (params?: RequestParams) => Promise<AxiosResponse<AiGuardrail[], any, {}>>;
6013
- /**
6014
- * No description
6015
- *
6016
- * @tags AiGuardrail
6017
- * @name CreateAiGuardrail
6018
- * @summary Create custom guardrail
6019
- * @request POST:/api/ai/admin/guardrails
6020
- * @secure
6021
- * @response `201` `AiGuardrail` Created
6022
- * @response `400` `ProblemDetails` Bad Request
6023
- */
6024
- createAiGuardrail: (data: CreateAiGuardrailRequest, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6025
- /**
6026
- * No description
6027
- *
6028
- * @tags AiGuardrail
6029
- * @name GetAiGuardrail
6030
- * @summary Get guardrail by ID
6031
- * @request GET:/api/ai/admin/guardrails/{id}
6032
- * @secure
6033
- * @response `200` `AiGuardrail` OK
6034
- * @response `404` `ProblemDetails` Not Found
6035
- */
6036
- getAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6037
- /**
6038
- * No description
6039
- *
6040
- * @tags AiGuardrail
6041
- * @name UpdateAiGuardrail
6042
- * @summary Update guardrail
6043
- * @request PUT:/api/ai/admin/guardrails/{id}
6044
- * @secure
6045
- * @response `200` `AiGuardrail` OK
6046
- * @response `400` `ProblemDetails` Bad Request
6047
- * @response `404` `ProblemDetails` Not Found
6048
- */
6049
- updateAiGuardrail: (id: string, data: UpdateAiGuardrailRequest, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6050
- /**
6051
- * No description
6052
- *
6053
- * @tags AiGuardrail
6054
- * @name DeleteAiGuardrail
6055
- * @summary Delete guardrail
6056
- * @request DELETE:/api/ai/admin/guardrails/{id}
6057
- * @secure
6058
- * @response `204` `void` No Content
6059
- * @response `400` `ProblemDetails` Bad Request
6060
- * @response `404` `ProblemDetails` Not Found
6061
- */
6062
- deleteAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6063
- /**
6064
- * No description
6065
- *
6066
- * @tags AiGuardrail
6067
- * @name ToggleAiGuardrail
6068
- * @summary Toggle guardrail enabled/disabled
6069
- * @request PATCH:/api/ai/admin/guardrails/{id}/toggle
6070
- * @secure
6071
- * @response `200` `AiGuardrail` OK
6072
- * @response `404` `ProblemDetails` Not Found
6073
- */
6074
- toggleAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6075
- /**
6076
- * No description
6077
- *
6078
- * @tags AiPrompt
6079
- * @name GetAvailablePrompts
6080
- * @summary Get available prompts for current user
6081
- * @request GET:/api/ai/prompts
6082
- * @secure
6083
- * @response `200` `(AiPromptSummary)[]` OK
6084
- */
6085
- getAvailablePrompts: (query?: {
6086
- documentType?: string;
6087
- }, params?: RequestParams) => Promise<AxiosResponse<AiPromptSummary[], any, {}>>;
6088
- /**
6089
- * No description
6090
- *
6091
- * @tags AiUrlSource
6092
- * @name GetAiUrlSources
6093
- * @summary Get all URL sources
6094
- * @request GET:/api/ai/admin/url-sources
6095
- * @secure
6096
- * @response `200` `(AiUrlSource)[]` OK
6097
- */
6098
- getAiUrlSources: (params?: RequestParams) => Promise<AxiosResponse<AiUrlSource[], any, {}>>;
6099
- /**
6100
- * No description
6101
- *
6102
- * @tags AiUrlSource
6103
- * @name CreateAiUrlSource
6104
- * @summary Create URL source
6105
- * @request POST:/api/ai/admin/url-sources
6106
- * @secure
6107
- * @response `201` `AiUrlSource` Created
6108
- * @response `400` `ProblemDetails` Bad Request
6109
- * @response `409` `ProblemDetails` Conflict
6110
- */
6111
- createAiUrlSource: (data: CreateAiUrlSourceRequest, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
6112
- /**
6113
- * No description
6114
- *
6115
- * @tags AiUrlSource
6116
- * @name GetAiUrlSource
6117
- * @summary Get URL source by ID
6118
- * @request GET:/api/ai/admin/url-sources/{id}
6119
- * @secure
6120
- * @response `200` `AiUrlSource` OK
6121
- * @response `404` `ProblemDetails` Not Found
6122
- */
6123
- getAiUrlSource: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
6124
- /**
6125
- * No description
6126
- *
6127
- * @tags AiUrlSource
6128
- * @name UpdateAiUrlSource
6129
- * @summary Update URL source
6130
- * @request PUT:/api/ai/admin/url-sources/{id}
6131
- * @secure
6132
- * @response `200` `AiUrlSource` OK
6133
- * @response `400` `ProblemDetails` Bad Request
6134
- * @response `404` `ProblemDetails` Not Found
6135
- * @response `409` `ProblemDetails` Conflict
6136
- */
6137
- updateAiUrlSource: (id: string, data: UpdateAiUrlSourceRequest, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
6138
- /**
6139
- * No description
6140
- *
6141
- * @tags AiUrlSource
6142
- * @name DeleteAiUrlSource
6143
- * @summary Delete URL source
6144
- * @request DELETE:/api/ai/admin/url-sources/{id}
6145
- * @secure
6146
- * @response `204` `void` No Content
6147
- * @response `404` `ProblemDetails` Not Found
6148
- */
6149
- deleteAiUrlSource: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6150
- /**
6151
- * No description
6152
- *
6153
- * @tags AiUrlSource
6154
- * @name ToggleAiUrlSource
6155
- * @summary Toggle URL source active/inactive
6156
- * @request PATCH:/api/ai/admin/url-sources/{id}/toggle
6157
- * @secure
6158
- * @response `200` `AiUrlSource` OK
6159
- * @response `404` `ProblemDetails` Not Found
6160
- */
6161
- toggleAiUrlSource: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
6162
5498
  /**
6163
5499
  * No description
6164
5500
  *
@@ -6683,7 +6019,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6683
6019
  * @response `200` `(CustomFieldDefinition)[]` OK
6684
6020
  */
6685
6021
  getCustomFieldDefinitions: (query?: {
6686
- entityType?: "Loan";
6022
+ entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
6687
6023
  }, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
6688
6024
  /**
6689
6025
  * No description
@@ -8190,10 +7526,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8190
7526
  * @summary Download By ID
8191
7527
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
8192
7528
  * @secure
8193
- * @response `200` `string` OK
7529
+ * @response `200` `Blob` OK
8194
7530
  * @response `404` `ProblemDetails` Not Found
8195
7531
  */
8196
- downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
7532
+ downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
8197
7533
  /**
8198
7534
  * No description
8199
7535
  *
@@ -9396,7 +8732,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9396
8732
  getPartners: (query?: {
9397
8733
  showAll?: boolean;
9398
8734
  /** @default "Realtor" */
9399
- role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
8735
+ role?: GetPartnersParamsRoleEnum;
9400
8736
  /** @format int32 */
9401
8737
  pageSize?: number;
9402
8738
  /** @format int32 */
@@ -9574,7 +8910,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9574
8910
  * @response `200` `File` OK
9575
8911
  * @response `404` `ProblemDetails` Not Found
9576
8912
  */
9577
- getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
8913
+ getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
9578
8914
  /**
9579
8915
  * No description
9580
8916
  *
@@ -9585,7 +8921,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9585
8921
  * @secure
9586
8922
  * @response `200` `File` OK
9587
8923
  */
9588
- createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
8924
+ createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
9589
8925
  /**
9590
8926
  * No description
9591
8927
  *