@matech/thebigpos-sdk 2.49.3-rc0 → 2.49.3-rc1

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
@@ -141,7 +141,7 @@ export interface AccountBilling {
141
141
  contractedRate: number;
142
142
  }
143
143
  export interface AccountBillingRequest {
144
- billingType: "ClosedLoan" | "LoanOfficer";
144
+ billingType: AccountBillingRequestBillingTypeEnum;
145
145
  /** @format double */
146
146
  contractedRate: number;
147
147
  }
@@ -170,7 +170,7 @@ export interface Action {
170
170
  comments?: string | null;
171
171
  /** @format uuid */
172
172
  siteConfigurationID: string;
173
- applicationSettings?: any;
173
+ applicationSettings?: any | null;
174
174
  surveysToken?: string | null;
175
175
  }
176
176
  export interface Address {
@@ -393,7 +393,7 @@ export interface AiAuditLog {
393
393
  conversationId?: string | null;
394
394
  /** @format uuid */
395
395
  messageId?: string | null;
396
- eventType: "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved";
396
+ eventType: AiAuditLogEventTypeEnum;
397
397
  modelId?: string | null;
398
398
  /** @format int32 */
399
399
  inputTokens?: number | null;
@@ -406,7 +406,7 @@ export interface AiAuditLog {
406
406
  guardrailCategory?: string | null;
407
407
  rawRequest?: string | null;
408
408
  rawResponse?: string | null;
409
- details?: any;
409
+ details?: any | null;
410
410
  /** @format date-time */
411
411
  createdAt: string;
412
412
  }
@@ -468,7 +468,7 @@ export interface AiChatMessagePaginated {
468
468
  count: number;
469
469
  }
470
470
  export interface AiChatMetadata {
471
- intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
471
+ intent: AiChatMetadataIntentEnum;
472
472
  fieldsAccessed: string[];
473
473
  /** @format int64 */
474
474
  queryTimeMs: number;
@@ -494,7 +494,7 @@ export interface AiChatRequest {
494
494
  promptId?: string | null;
495
495
  }
496
496
  export interface AiChatStructuredData {
497
- type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
497
+ type: AiChatStructuredDataTypeEnum;
498
498
  displayHint?: AiDisplayHint | null;
499
499
  detectedDocumentType?: string | null;
500
500
  columns: string[];
@@ -580,7 +580,7 @@ export interface AiGuardrail {
580
580
  /** @format uuid */
581
581
  id: string;
582
582
  name: string;
583
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
583
+ category: AiGuardrailCategoryEnum;
584
584
  description?: string | null;
585
585
  keywords: string[];
586
586
  responseTemplate: string;
@@ -708,8 +708,8 @@ export interface AiUrlSource {
708
708
  name: string;
709
709
  url: string;
710
710
  description?: string | null;
711
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
712
- scope: "FullDomain" | "SpecificPath";
711
+ category: AiUrlSourceCategoryEnum;
712
+ scope: AiUrlSourceScopeEnum;
713
713
  isActive: boolean;
714
714
  isDefault: boolean;
715
715
  hasAccountOverride: boolean;
@@ -816,14 +816,14 @@ export interface AuditLogEntry {
816
816
  /** @format uuid */
817
817
  id: string;
818
818
  entityType: string;
819
- changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
819
+ changeType: AuditLogEntryChangeTypeEnum;
820
820
  /** @format uuid */
821
821
  entityId: string;
822
822
  performedBy?: AuditLogUser | null;
823
823
  rootEntityType?: string | null;
824
824
  /** @format uuid */
825
825
  rootEntityId?: string | null;
826
- changes?: any;
826
+ changes?: any | null;
827
827
  /** @format date-time */
828
828
  createdAt: string;
829
829
  }
@@ -863,7 +863,7 @@ export interface BorrowerCount {
863
863
  firstName: string;
864
864
  lastName: string;
865
865
  email: string;
866
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
866
+ role: BorrowerCountRoleEnum;
867
867
  /** @format int32 */
868
868
  count: number;
869
869
  }
@@ -873,7 +873,7 @@ export interface BorrowerIdentity {
873
873
  firstName: string;
874
874
  lastName: string;
875
875
  email: string;
876
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
876
+ role: BorrowerIdentityRoleEnum;
877
877
  }
878
878
  export interface BorrowersNotUsingPosSummary {
879
879
  /** @format int32 */
@@ -1041,13 +1041,13 @@ export interface CompanyDocument {
1041
1041
  folderId: string;
1042
1042
  folderName: string;
1043
1043
  name: string;
1044
- sourceType: "File" | "FreeText";
1044
+ sourceType: CompanyDocumentSourceTypeEnum;
1045
1045
  contentType?: string | null;
1046
1046
  /** @format int64 */
1047
1047
  fileSizeBytes: number;
1048
1048
  inlineContent?: string | null;
1049
1049
  previewImage?: string | null;
1050
- indexStatus: "Uploaded" | "Indexing" | "Indexed" | "Failed";
1050
+ indexStatus: CompanyDocumentIndexStatusEnum;
1051
1051
  indexError?: string | null;
1052
1052
  /** @format date-time */
1053
1053
  indexedAt?: string | null;
@@ -1161,7 +1161,7 @@ export interface CorporateSearchCriteria {
1161
1161
  isActive?: boolean | null;
1162
1162
  }
1163
1163
  export interface CreateAccessScopeRequest {
1164
- scopeType: "User" | "Branch";
1164
+ scopeType: CreateAccessScopeRequestScopeTypeEnum;
1165
1165
  /** @format uuid */
1166
1166
  userId?: string | null;
1167
1167
  /** @format uuid */
@@ -1179,7 +1179,7 @@ export interface CreateAccountRequest {
1179
1179
  /** @format int64 */
1180
1180
  nlmsid: number;
1181
1181
  settings: AccountSettingsRequest;
1182
- environment: "Development" | "Staging" | "UAT" | "Production";
1182
+ environment: CreateAccountRequestEnvironmentEnum;
1183
1183
  losIntegration: LOSIntegration;
1184
1184
  billingSettings: AccountBillingRequest;
1185
1185
  }
@@ -1193,7 +1193,7 @@ export interface CreateAiCanonicalFieldRequest {
1193
1193
  }
1194
1194
  export interface CreateAiGuardrailRequest {
1195
1195
  name: string;
1196
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
1196
+ category: CreateAiGuardrailRequestCategoryEnum;
1197
1197
  description?: string | null;
1198
1198
  keywords: string[];
1199
1199
  responseTemplate: string;
@@ -1224,8 +1224,8 @@ export interface CreateAiUrlSourceRequest {
1224
1224
  name: string;
1225
1225
  url: string;
1226
1226
  description?: string | null;
1227
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
1228
- scope: "FullDomain" | "SpecificPath";
1227
+ category: CreateAiUrlSourceRequestCategoryEnum;
1228
+ scope: CreateAiUrlSourceRequestScopeEnum;
1229
1229
  }
1230
1230
  export interface CreateBranchRequest {
1231
1231
  name: string;
@@ -1258,8 +1258,8 @@ export interface CreateCustomFieldDefinitionRequest {
1258
1258
  name: string;
1259
1259
  defaultValue?: string | null;
1260
1260
  regexPattern?: string | null;
1261
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1262
- entityType: "Loan";
1261
+ dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
1262
+ entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
1263
1263
  options?: CustomFieldOptionRequest[] | null;
1264
1264
  permissions?: CustomFieldPermissionRequest[] | null;
1265
1265
  }
@@ -1277,7 +1277,7 @@ export interface CreateDocumentTemplateRequest {
1277
1277
  export interface CreateGroupMemberRequest {
1278
1278
  /** @format uuid */
1279
1279
  userId: string;
1280
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1280
+ loanRole: CreateGroupMemberRequestLoanRoleEnum;
1281
1281
  }
1282
1282
  export interface CreateInviteRequest {
1283
1283
  firstName: string;
@@ -1285,7 +1285,7 @@ export interface CreateInviteRequest {
1285
1285
  emailAddress: string;
1286
1286
  phoneNumber?: string | null;
1287
1287
  /** @deprecated */
1288
- relationship: "NotApplicable" | "Spouse" | "NonSpouse";
1288
+ relationship: CreateInviteRequestRelationshipEnum;
1289
1289
  loanID: string;
1290
1290
  route?: string | null;
1291
1291
  /** @format uuid */
@@ -1305,7 +1305,7 @@ export interface CreateLoanImportRequest {
1305
1305
  endDate: string;
1306
1306
  /** @format date-time */
1307
1307
  startDate: string;
1308
- importMode: "All" | "NewOnly" | "UpdateOnly";
1308
+ importMode: CreateLoanImportRequestImportModeEnum;
1309
1309
  }
1310
1310
  export interface CreateSession {
1311
1311
  sessionId: string;
@@ -1323,7 +1323,7 @@ export interface CreateUserDeviceRequest {
1323
1323
  token: string;
1324
1324
  }
1325
1325
  export interface CreateUserDraft {
1326
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1326
+ loanRole: CreateUserDraftLoanRoleEnum;
1327
1327
  }
1328
1328
  export interface CreateUserGroupRequest {
1329
1329
  name: string;
@@ -1384,8 +1384,8 @@ export interface CustomFieldDefinition {
1384
1384
  name: string;
1385
1385
  defaultValue?: string | null;
1386
1386
  regexPattern?: string | null;
1387
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1388
- entityType: "Loan";
1387
+ dataType: CustomFieldDefinitionDataTypeEnum;
1388
+ entityType: CustomFieldDefinitionEntityTypeEnum;
1389
1389
  options: CustomFieldOption[];
1390
1390
  permissions: CustomFieldPermission[];
1391
1391
  encompassMapping?: EncompassMapping | null;
@@ -1399,7 +1399,7 @@ export interface CustomFieldEntry {
1399
1399
  displayOrder: number;
1400
1400
  name: string;
1401
1401
  value: string;
1402
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1402
+ dataType: CustomFieldEntryDataTypeEnum;
1403
1403
  }
1404
1404
  export interface CustomFieldOption {
1405
1405
  /** @format uuid */
@@ -1416,12 +1416,12 @@ export interface CustomFieldOptionRequest {
1416
1416
  export interface CustomFieldPermission {
1417
1417
  /** @format uuid */
1418
1418
  id: string;
1419
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1420
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1419
+ role: CustomFieldPermissionRoleEnum;
1420
+ accessLevel: CustomFieldPermissionAccessLevelEnum;
1421
1421
  }
1422
1422
  export interface CustomFieldPermissionRequest {
1423
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1424
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1423
+ role: CustomFieldPermissionRequestRoleEnum;
1424
+ accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
1425
1425
  }
1426
1426
  export interface CustomFieldValue {
1427
1427
  /** @format uuid */
@@ -1432,7 +1432,7 @@ export interface CustomFieldValue {
1432
1432
  customFieldDefinitionID: string;
1433
1433
  value: string;
1434
1434
  definitionName: string;
1435
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1435
+ dataType: CustomFieldValueDataTypeEnum;
1436
1436
  }
1437
1437
  export interface DetailedUser {
1438
1438
  /** @format date-time */
@@ -1662,7 +1662,7 @@ export interface Draft {
1662
1662
  siteConfiguration: SiteConfigurationReduced;
1663
1663
  /** @format uuid */
1664
1664
  loanID?: string | null;
1665
- type: "NewLoan" | "EditLoan";
1665
+ type: DraftTypeEnum;
1666
1666
  isCoBorrower: boolean;
1667
1667
  }
1668
1668
  export interface DraftContent {
@@ -1680,7 +1680,7 @@ export interface DraftContent {
1680
1680
  siteConfiguration: SiteConfigurationReduced;
1681
1681
  /** @format uuid */
1682
1682
  loanID?: string | null;
1683
- type: "NewLoan" | "EditLoan";
1683
+ type: DraftContentTypeEnum;
1684
1684
  isCoBorrower: boolean;
1685
1685
  applicationPayload: any;
1686
1686
  }
@@ -1696,7 +1696,7 @@ export interface DraftLoanOfficerReassignRequest {
1696
1696
  }
1697
1697
  export interface DraftRequest {
1698
1698
  applicationPayload: any;
1699
- customData?: any;
1699
+ customData?: any | null;
1700
1700
  isCoBorrower: boolean;
1701
1701
  }
1702
1702
  export interface EconsentPendingSummary {
@@ -1766,9 +1766,9 @@ export interface EncompassCredentialsDetail {
1766
1766
  clearStateIfUnlicensed: boolean;
1767
1767
  /** @deprecated */
1768
1768
  baseUrl?: string | null;
1769
- encompassEnvironment: "Production" | "UAT";
1769
+ encompassEnvironment: EncompassCredentialsDetailEncompassEnvironmentEnum;
1770
1770
  consumerConnectWidgetHost?: string | null;
1771
- signingMethod: "ConsumerConnect" | "POSF";
1771
+ signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1772
1772
  subscriptionId?: string | null;
1773
1773
  environment?: string | null;
1774
1774
  /** @format uuid */
@@ -1784,9 +1784,9 @@ export interface EncompassCredentialsRequest {
1784
1784
  clearStateIfUnlicensed: boolean;
1785
1785
  /** @deprecated */
1786
1786
  baseUrl?: string | null;
1787
- encompassEnvironment: "Production" | "UAT";
1787
+ encompassEnvironment: EncompassCredentialsRequestEncompassEnvironmentEnum;
1788
1788
  consumerConnectWidgetHost?: string | null;
1789
- signingMethod: "ConsumerConnect" | "POSF";
1789
+ signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1790
1790
  subscriptionId?: string | null;
1791
1791
  environment?: string | null;
1792
1792
  clientID?: string | null;
@@ -1896,8 +1896,8 @@ export interface EncompassRequestLog {
1896
1896
  losId?: string | null;
1897
1897
  /** @format uuid */
1898
1898
  accountId: string;
1899
- operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
1900
- outcome: "Success" | "Failure" | "PartialSuccess";
1899
+ operationType: EncompassRequestLogOperationTypeEnum;
1900
+ outcome: EncompassRequestLogOutcomeEnum;
1901
1901
  message: string;
1902
1902
  endpoint?: string | null;
1903
1903
  httpMethod?: string | null;
@@ -1905,7 +1905,7 @@ export interface EncompassRequestLog {
1905
1905
  httpStatusCode?: number | null;
1906
1906
  /** @format int64 */
1907
1907
  durationMs?: number | null;
1908
- context?: any;
1908
+ context?: any | null;
1909
1909
  /** @format date-time */
1910
1910
  createdAt: string;
1911
1911
  }
@@ -1950,7 +1950,7 @@ export interface FileSearchCriteria {
1950
1950
  export interface FileWithBytes {
1951
1951
  name: string;
1952
1952
  /** @format byte */
1953
- data: string;
1953
+ data: Blob;
1954
1954
  fileName: string;
1955
1955
  mimeType?: string | null;
1956
1956
  extension?: string | null;
@@ -2026,7 +2026,7 @@ export interface FormSubmission {
2026
2026
  subjectPropertyAddressCounty?: string | null;
2027
2027
  subjectPropertyAddressState?: string | null;
2028
2028
  subjectPropertyAddressZip?: string | null;
2029
- data?: any;
2029
+ data?: any | null;
2030
2030
  /** @format uuid */
2031
2031
  listingID?: string | null;
2032
2032
  listing?: Listing | null;
@@ -2061,7 +2061,7 @@ export interface FormSubmissionRequest {
2061
2061
  subjectPropertyAddressCounty?: string | null;
2062
2062
  subjectPropertyAddressState?: string | null;
2063
2063
  subjectPropertyAddressZip?: string | null;
2064
- data?: any;
2064
+ data?: any | null;
2065
2065
  /** @format uuid */
2066
2066
  listingID?: string | null;
2067
2067
  }
@@ -2110,7 +2110,7 @@ export interface FusionFieldDisplay {
2110
2110
  fieldValue: string;
2111
2111
  }
2112
2112
  export interface FusionReportFilter {
2113
- filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
2113
+ filterType: FusionReportFilterFilterTypeEnum;
2114
2114
  targetField: string;
2115
2115
  targetValue: string;
2116
2116
  }
@@ -2130,7 +2130,7 @@ export interface GenerateSystemPrompt {
2130
2130
  }
2131
2131
  export interface GenerateSystemPromptRequest {
2132
2132
  description: string;
2133
- category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
2133
+ category: GenerateSystemPromptRequestCategoryEnum;
2134
2134
  }
2135
2135
  export interface GetApplications {
2136
2136
  applications: ApplicationRowData[];
@@ -2214,11 +2214,11 @@ export interface GetWorkflowRequest {
2214
2214
  export interface GuidPatchOperation {
2215
2215
  op: string;
2216
2216
  path: string;
2217
- value?: any;
2217
+ value?: any | null;
2218
2218
  from?: string | null;
2219
2219
  }
2220
2220
  export interface IPAddress {
2221
- 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";
2221
+ addressFamily: IpAddressAddressFamilyEnum;
2222
2222
  /** @format int64 */
2223
2223
  scopeId: number;
2224
2224
  isIPv6Multicast: boolean;
@@ -2294,6 +2294,9 @@ export interface Invite {
2294
2294
  oneTimeToken: string;
2295
2295
  /** @format date-time */
2296
2296
  createdAt: string;
2297
+ /** @format date-time */
2298
+ expiresAt?: string | null;
2299
+ status: string;
2297
2300
  invitedBy?: User | null;
2298
2301
  loan: LoanIdentifier;
2299
2302
  url: string;
@@ -2467,7 +2470,7 @@ export interface Loan {
2467
2470
  contacts: LoanContact[];
2468
2471
  customFields: CustomFieldEntry[];
2469
2472
  milestones: LoanMilestone[];
2470
- signingMethod: "ConsumerConnect" | "POSF";
2473
+ signingMethod: LoanSigningMethodEnum;
2471
2474
  }
2472
2475
  export interface LoanApplication {
2473
2476
  /** @format uuid */
@@ -2505,7 +2508,7 @@ export interface LoanApplicationRequest {
2505
2508
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2506
2509
  /** @format uuid */
2507
2510
  draftId?: string | null;
2508
- additionalFields?: Record<string, any>;
2511
+ additionalFields?: Record<string, any> | null;
2509
2512
  /** @format uuid */
2510
2513
  existingLoanId?: string | null;
2511
2514
  }
@@ -2524,7 +2527,7 @@ export interface LoanBorrower {
2524
2527
  citizenship?: LoanCitizenship | null;
2525
2528
  maritalStatus?: LoanMaritalStatus | null;
2526
2529
  languagePreference?: LoanLanguagePreference | null;
2527
- applicationStatus: "Draft" | "Complete";
2530
+ applicationStatus: LoanBorrowerApplicationStatusEnum;
2528
2531
  /** @format int32 */
2529
2532
  numberOfDependents?: number | null;
2530
2533
  /** @format int32 */
@@ -3263,7 +3266,7 @@ export interface LoanConsentRequest {
3263
3266
  borrowerEConsent?: boolean | null;
3264
3267
  borrowerCreditAuth?: boolean | null;
3265
3268
  borrowerTCPAOptIn?: boolean | null;
3266
- additionalFields?: Record<string, string>;
3269
+ additionalFields?: Record<string, string> | null;
3267
3270
  }
3268
3271
  export interface LoanContact {
3269
3272
  /** @format date-time */
@@ -3281,7 +3284,7 @@ export interface LoanContact {
3281
3284
  email?: string | null;
3282
3285
  phone?: string | null;
3283
3286
  companyName?: string | null;
3284
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3287
+ role: LoanContactRoleEnum;
3285
3288
  }
3286
3289
  export interface LoanContactList {
3287
3290
  email: string;
@@ -3303,7 +3306,7 @@ export interface LoanCostDetails {
3303
3306
  totalFinancing?: number | null;
3304
3307
  }
3305
3308
  export interface LoanCustomFieldsRequest {
3306
- additionalFields?: Record<string, string>;
3309
+ additionalFields?: Record<string, string> | null;
3307
3310
  }
3308
3311
  export interface LoanDocument {
3309
3312
  /** @format date-time */
@@ -3360,14 +3363,14 @@ export interface LoanDocumentFolderPermission {
3360
3363
  id: string;
3361
3364
  /** @format uuid */
3362
3365
  loanDocumentFolderID: string;
3363
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3364
- level: "None" | "Read" | "Write" | "Manage";
3365
- readScope: "Own" | "All";
3366
+ role: LoanDocumentFolderPermissionRoleEnum;
3367
+ level: LoanDocumentFolderPermissionLevelEnum;
3368
+ readScope: LoanDocumentFolderPermissionReadScopeEnum;
3366
3369
  }
3367
3370
  export interface LoanDocumentFolderPermissionRequest {
3368
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3369
- level: "None" | "Read" | "Write" | "Manage";
3370
- readScope: "Own" | "All";
3371
+ role: LoanDocumentFolderPermissionRequestRoleEnum;
3372
+ level: LoanDocumentFolderPermissionRequestLevelEnum;
3373
+ readScope: LoanDocumentFolderPermissionRequestReadScopeEnum;
3371
3374
  }
3372
3375
  export interface LoanDocumentFolderSearchCriteria {
3373
3376
  searchText?: string | null;
@@ -3527,13 +3530,13 @@ export interface LoanImport {
3527
3530
  /** @format int32 */
3528
3531
  importedCount: number;
3529
3532
  statusMessage?: string | null;
3530
- status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3531
- importMode: "All" | "NewOnly" | "UpdateOnly";
3533
+ status: LoanImportStatusEnum;
3534
+ importMode: LoanImportImportModeEnum;
3532
3535
  /** @format date-time */
3533
3536
  createdAt?: string | null;
3534
3537
  }
3535
3538
  export interface LoanImportLog {
3536
- level: "None" | "Info" | "Warning" | "Error";
3539
+ level: LoanImportLogLevelEnum;
3537
3540
  message: string;
3538
3541
  /** @format date-time */
3539
3542
  createdAt: string;
@@ -3588,8 +3591,8 @@ export interface LoanListPaginated {
3588
3591
  export interface LoanLog {
3589
3592
  /** @format uuid */
3590
3593
  id: string;
3591
- level: "None" | "Info" | "Warning" | "Error";
3592
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
3594
+ level: LoanLogLevelEnum;
3595
+ type: LoanLogTypeEnum;
3593
3596
  message: string;
3594
3597
  /** @format date-time */
3595
3598
  createdAt: string;
@@ -3597,8 +3600,8 @@ export interface LoanLog {
3597
3600
  export interface LoanLogDetail {
3598
3601
  /** @format uuid */
3599
3602
  id: string;
3600
- level: "None" | "Info" | "Warning" | "Error";
3601
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
3603
+ level: LoanLogDetailLevelEnum;
3604
+ type: LoanLogDetailTypeEnum;
3602
3605
  message: string;
3603
3606
  /** @format date-time */
3604
3607
  createdAt: string;
@@ -3860,7 +3863,7 @@ export interface LoanQueueWithData {
3860
3863
  user: UserPublic;
3861
3864
  loanOfficer: LoanOfficerPublic;
3862
3865
  siteConfiguration: SiteConfigurationReduced;
3863
- data?: any;
3866
+ data?: any | null;
3864
3867
  }
3865
3868
  export interface LoanRecord {
3866
3869
  loanGuid: string;
@@ -3891,7 +3894,7 @@ export interface LoanTaskSearchRequest {
3891
3894
  loanStatus?: LoanTaskActivityFilter | null;
3892
3895
  }
3893
3896
  export interface LoanTaskStatusSummary {
3894
- status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3897
+ status: LoanTaskStatusSummaryStatusEnum;
3895
3898
  /** @format int32 */
3896
3899
  count: number;
3897
3900
  }
@@ -3903,7 +3906,7 @@ export interface LoanUser {
3903
3906
  email: string;
3904
3907
  phone?: string | null;
3905
3908
  role: string;
3906
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3909
+ loanRole: LoanUserLoanRoleEnum;
3907
3910
  isUser: boolean;
3908
3911
  /** @format date-time */
3909
3912
  createdAt: string;
@@ -3911,7 +3914,7 @@ export interface LoanUser {
3911
3914
  export interface LosCredentialHealth {
3912
3915
  /** @format uuid */
3913
3916
  accountId: string;
3914
- status: "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
3917
+ status: LosCredentialHealthStatusEnum;
3915
3918
  /** @format date-time */
3916
3919
  checkedAtUtc: string;
3917
3920
  message: string;
@@ -3928,8 +3931,8 @@ export interface LosIntegration {
3928
3931
  accountId: string;
3929
3932
  accountName?: string | null;
3930
3933
  instanceID: string;
3931
- encompassEnvironment: "Production" | "UAT";
3932
- signingMethod: "ConsumerConnect" | "POSF";
3934
+ encompassEnvironment: LosIntegrationEncompassEnvironmentEnum;
3935
+ signingMethod: LosIntegrationSigningMethodEnum;
3933
3936
  consumerConnectWidgetHost?: string | null;
3934
3937
  defaultLoanOfficerUserName?: string | null;
3935
3938
  loanTemplate?: string | null;
@@ -3947,8 +3950,8 @@ export interface LosIntegrationCredentials {
3947
3950
  /** @format uuid */
3948
3951
  accountID: string;
3949
3952
  instanceID: string;
3950
- encompassEnvironment: "Production" | "UAT";
3951
- signingMethod: "ConsumerConnect" | "POSF";
3953
+ encompassEnvironment: LosIntegrationCredentialsEncompassEnvironmentEnum;
3954
+ signingMethod: LosIntegrationCredentialsSigningMethodEnum;
3952
3955
  consumerConnectWidgetHost?: string | null;
3953
3956
  defaultLoanOfficerUserName?: string | null;
3954
3957
  loanTemplate?: string | null;
@@ -4010,7 +4013,7 @@ export interface LosOperationTracking {
4010
4013
  operationType: string;
4011
4014
  correlationKey: string;
4012
4015
  lastTriggerSource?: string | null;
4013
- status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
4016
+ status: LosOperationTrackingStatusEnum;
4014
4017
  /** @format date-time */
4015
4018
  createdAt: string;
4016
4019
  /** @format date-time */
@@ -4096,7 +4099,7 @@ export interface LosSyncStep {
4096
4099
  /** @format int32 */
4097
4100
  order: number;
4098
4101
  name: string;
4099
- severity: "Success" | "Info" | "Warning" | "Error";
4102
+ severity: LosSyncStepSeverityEnum;
4100
4103
  message: string;
4101
4104
  /** @format date-time */
4102
4105
  atUtc: string;
@@ -4117,12 +4120,12 @@ export interface LosWebhookEntry {
4117
4120
  /** @format uuid */
4118
4121
  subscriptionId?: string | null;
4119
4122
  enableSubscription?: boolean | null;
4120
- status: "Registered" | "Disabled" | "Missing" | "Extra";
4123
+ status: LosWebhookEntryStatusEnum;
4121
4124
  }
4122
4125
  export interface LosWebhookInventory {
4123
4126
  /** @format uuid */
4124
4127
  accountId: string;
4125
- overallStatus: "Unknown" | "Healthy" | "Disabled" | "Missing";
4128
+ overallStatus: LosWebhookInventoryOverallStatusEnum;
4126
4129
  entries: LosWebhookEntry[];
4127
4130
  /** @format int32 */
4128
4131
  missingCount: number;
@@ -4131,7 +4134,7 @@ export interface LosWebhookInventory {
4131
4134
  message: string;
4132
4135
  }
4133
4136
  export interface ManualDocumentClassificationRequest {
4134
- documentType: "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
4137
+ documentType: ManualDocumentClassificationRequestDocumentTypeEnum;
4135
4138
  }
4136
4139
  export interface MdmUser {
4137
4140
  user_email?: string | null;
@@ -4214,7 +4217,7 @@ export interface ModuleParameterValue {
4214
4217
  parameterID: string;
4215
4218
  parameterName: string;
4216
4219
  parameterType: string;
4217
- value?: any;
4220
+ value?: any | null;
4218
4221
  isInherited: boolean;
4219
4222
  }
4220
4223
  export interface MonthlyPaymentCalculator {
@@ -4387,7 +4390,7 @@ export interface NotificationTemplateVersionUpdateRequest {
4387
4390
  }
4388
4391
  export interface Operation {
4389
4392
  op?: string;
4390
- value?: string | number | boolean | null | object;
4393
+ value?: object | null;
4391
4394
  path?: string;
4392
4395
  }
4393
4396
  export interface OverridePasswordRequest {
@@ -4721,7 +4724,7 @@ export interface SiteConfiguration {
4721
4724
  deletedAt?: string | null;
4722
4725
  /** @format uuid */
4723
4726
  id: string;
4724
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4727
+ type: SiteConfigurationTypeEnum;
4725
4728
  /** @format uuid */
4726
4729
  entityID: string;
4727
4730
  /** @format int32 */
@@ -4915,7 +4918,7 @@ export interface SiteConfigurationByUrl {
4915
4918
  deletedAt?: string | null;
4916
4919
  /** @format uuid */
4917
4920
  id: string;
4918
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4921
+ type: SiteConfigurationByUrlTypeEnum;
4919
4922
  /** @format uuid */
4920
4923
  entityID: string;
4921
4924
  /** @format int32 */
@@ -5126,7 +5129,7 @@ export interface SiteConfigurationForm {
5126
5129
  export interface SiteConfigurationReduced {
5127
5130
  /** @format uuid */
5128
5131
  id: string;
5129
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5132
+ type: SiteConfigurationReducedTypeEnum;
5130
5133
  url?: string | null;
5131
5134
  name: string;
5132
5135
  /** @format int64 */
@@ -5143,7 +5146,7 @@ export interface SiteConfigurationRequest {
5143
5146
  entityID: string;
5144
5147
  /** @format int32 */
5145
5148
  entityType: number;
5146
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5149
+ type: SiteConfigurationRequestTypeEnum;
5147
5150
  url: string;
5148
5151
  name: string;
5149
5152
  introduction?: string | null;
@@ -5319,7 +5322,7 @@ export interface SiteConfigurationSearchCriteria {
5319
5322
  export interface SiteConfigurationSummary {
5320
5323
  /** @format uuid */
5321
5324
  id: string;
5322
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5325
+ type: SiteConfigurationSummaryTypeEnum;
5323
5326
  url?: string | null;
5324
5327
  name: string;
5325
5328
  /** @format int64 */
@@ -5355,7 +5358,7 @@ export interface SiteTile {
5355
5358
  title: string;
5356
5359
  description: string;
5357
5360
  linkUrl: string;
5358
- linkTarget: "Self" | "Blank";
5361
+ linkTarget: SiteTileLinkTargetEnum;
5359
5362
  siteTypes: SiteConfigurationType[];
5360
5363
  locationAudiences: SiteTileLocationAudience[];
5361
5364
  /** @format int32 */
@@ -5367,11 +5370,11 @@ export interface SiteTile {
5367
5370
  updatedAt?: string | null;
5368
5371
  }
5369
5372
  export interface SiteTileLocationAudience {
5370
- location: "HomePage" | "Dashboard";
5373
+ location: SiteTileLocationAudienceLocationEnum;
5371
5374
  audience: UserRole[];
5372
5375
  }
5373
5376
  export interface SiteTileLocationAudienceRequest {
5374
- location: "HomePage" | "Dashboard";
5377
+ location: SiteTileLocationAudienceRequestLocationEnum;
5375
5378
  audience: UserRole[];
5376
5379
  }
5377
5380
  export interface SiteTilePaginated {
@@ -5387,7 +5390,7 @@ export interface SiteTileRequest {
5387
5390
  title: string;
5388
5391
  description: string;
5389
5392
  linkUrl: string;
5390
- linkTarget: "Self" | "Blank";
5393
+ linkTarget: SiteTileRequestLinkTargetEnum;
5391
5394
  siteTypes: SiteConfigurationType[];
5392
5395
  locationAudiences: SiteTileLocationAudienceRequest[];
5393
5396
  /** @format int32 */
@@ -5408,7 +5411,7 @@ export interface SiteTileView {
5408
5411
  title: string;
5409
5412
  description: string;
5410
5413
  linkUrl: string;
5411
- linkTarget: "Self" | "Blank";
5414
+ linkTarget: SiteTileViewLinkTargetEnum;
5412
5415
  /** @format int32 */
5413
5416
  weight: number;
5414
5417
  }
@@ -5639,7 +5642,7 @@ export interface UnregisteredBorrower {
5639
5642
  lastName?: string | null;
5640
5643
  fullName?: string | null;
5641
5644
  email?: string | null;
5642
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5645
+ role: UnregisteredBorrowerRoleEnum;
5643
5646
  }
5644
5647
  export interface UpdateAccountRequest {
5645
5648
  name: string;
@@ -5663,7 +5666,7 @@ export interface UpdateAiCanonicalFieldRequest {
5663
5666
  }
5664
5667
  export interface UpdateAiGuardrailRequest {
5665
5668
  name: string;
5666
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5669
+ category: UpdateAiGuardrailRequestCategoryEnum;
5667
5670
  description?: string | null;
5668
5671
  keywords: string[];
5669
5672
  responseTemplate: string;
@@ -5697,8 +5700,8 @@ export interface UpdateAiUrlSourceRequest {
5697
5700
  name: string;
5698
5701
  url: string;
5699
5702
  description?: string | null;
5700
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5701
- scope: "FullDomain" | "SpecificPath";
5703
+ category: UpdateAiUrlSourceRequestCategoryEnum;
5704
+ scope: UpdateAiUrlSourceRequestScopeEnum;
5702
5705
  }
5703
5706
  export interface UpdateCompanyDocumentFolderRequest {
5704
5707
  name: string;
@@ -6002,7 +6005,7 @@ export interface UserDevice {
6002
6005
  export interface UserDraft {
6003
6006
  /** @format uuid */
6004
6007
  draftID: string;
6005
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6008
+ role: UserDraftRoleEnum;
6006
6009
  user: User;
6007
6010
  }
6008
6011
  export interface UserDraftPaginated {
@@ -6026,7 +6029,7 @@ export interface UserGroupAccessScope {
6026
6029
  id: string;
6027
6030
  /** @format uuid */
6028
6031
  groupId: string;
6029
- scopeType: "User" | "Branch";
6032
+ scopeType: UserGroupAccessScopeScopeTypeEnum;
6030
6033
  /** @format uuid */
6031
6034
  userId?: string | null;
6032
6035
  /** @format uuid */
@@ -6049,7 +6052,7 @@ export interface UserGroupMemberUserSummary {
6049
6052
  id: string;
6050
6053
  name?: string | null;
6051
6054
  email?: string | null;
6052
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6055
+ role: UserGroupMemberUserSummaryRoleEnum;
6053
6056
  }
6054
6057
  export interface UserGroupPaginated {
6055
6058
  rows: UserGroup[];
@@ -6066,7 +6069,7 @@ export interface UserLoan {
6066
6069
  deletedAt?: string | null;
6067
6070
  loanID: string;
6068
6071
  user: User;
6069
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6072
+ role: UserLoanRoleEnum;
6070
6073
  /** @format int32 */
6071
6074
  borrowerPair?: number | null;
6072
6075
  /** @format int32 */
@@ -6078,11 +6081,11 @@ export interface UserLoanConsent {
6078
6081
  id: string;
6079
6082
  /** @format uuid */
6080
6083
  userLoanID: string;
6081
- type: "Econsent" | "CreditAuthorization" | "Tcpa";
6084
+ type: UserLoanConsentTypeEnum;
6082
6085
  providedConsent: boolean;
6083
6086
  source?: ConsentSource | null;
6084
6087
  ipAddress?: string | null;
6085
- losSyncStatus: "NotStarted" | "Failed" | "Success";
6088
+ losSyncStatus: UserLoanConsentLosSyncStatusEnum;
6086
6089
  /** @format date-time */
6087
6090
  createdAt: string;
6088
6091
  /** @format date-time */
@@ -6256,6 +6259,105 @@ export interface Workflow {
6256
6259
  tileSubtitle: string;
6257
6260
  icon: string;
6258
6261
  }
6262
+ export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
6263
+ export type AiAuditLogEventTypeEnum = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved";
6264
+ export type AiChatMetadataIntentEnum = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
6265
+ export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
6266
+ export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6267
+ export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6268
+ export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
6269
+ export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
6270
+ export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6271
+ export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6272
+ export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
6273
+ export type CompanyDocumentIndexStatusEnum = "Uploaded" | "Indexing" | "Indexed" | "Failed";
6274
+ export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
6275
+ export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
6276
+ export type CreateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6277
+ export type CreateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6278
+ export type CreateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
6279
+ export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6280
+ export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
6281
+ export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6282
+ /** @deprecated */
6283
+ export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
6284
+ export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6285
+ export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6286
+ export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6287
+ export type CustomFieldDefinitionEntityTypeEnum = "Loan";
6288
+ export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6289
+ export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6290
+ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
6291
+ export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6292
+ export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
6293
+ export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
6294
+ export type DraftTypeEnum = "NewLoan" | "EditLoan";
6295
+ export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
6296
+ export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
6297
+ export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
6298
+ export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
6299
+ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
6300
+ export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
6301
+ export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
6302
+ export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
6303
+ export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
6304
+ 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";
6305
+ export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
6306
+ export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
6307
+ export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6308
+ export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6309
+ export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
6310
+ export type LoanDocumentFolderPermissionReadScopeEnum = "Own" | "All";
6311
+ export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6312
+ export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
6313
+ export type LoanDocumentFolderPermissionRequestReadScopeEnum = "Own" | "All";
6314
+ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
6315
+ export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6316
+ export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6317
+ export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6318
+ export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
6319
+ export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
6320
+ export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
6321
+ export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
6322
+ export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6323
+ export type LosCredentialHealthStatusEnum = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
6324
+ export type LosIntegrationEncompassEnvironmentEnum = "Production" | "UAT";
6325
+ export type LosIntegrationSigningMethodEnum = "ConsumerConnect" | "POSF";
6326
+ export type LosIntegrationCredentialsEncompassEnvironmentEnum = "Production" | "UAT";
6327
+ export type LosIntegrationCredentialsSigningMethodEnum = "ConsumerConnect" | "POSF";
6328
+ export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
6329
+ export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
6330
+ export type LosWebhookEntryStatusEnum = "Registered" | "Disabled" | "Missing" | "Extra";
6331
+ export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disabled" | "Missing";
6332
+ export type ManualDocumentClassificationRequestDocumentTypeEnum = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
6333
+ export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6334
+ export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6335
+ export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6336
+ export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6337
+ export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6338
+ export type SiteTileLinkTargetEnum = "Self" | "Blank";
6339
+ export type SiteTileLocationAudienceLocationEnum = "HomePage" | "Dashboard";
6340
+ export type SiteTileLocationAudienceRequestLocationEnum = "HomePage" | "Dashboard";
6341
+ export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
6342
+ export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
6343
+ export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6344
+ export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6345
+ export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6346
+ export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
6347
+ export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6348
+ export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
6349
+ export type UserGroupMemberUserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6350
+ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6351
+ export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
6352
+ export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
6353
+ export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
6354
+ /** @default "Realtor" */
6355
+ export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
6356
+ export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6357
+ export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6358
+ export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6359
+ export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
6360
+ export type GetSiteTilesBySiteConfigurationParamsLocationEnum = "HomePage" | "Dashboard";
6259
6361
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
6260
6362
  export type QueryParamsType = Record<string | number, any>;
6261
6363
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -6278,14 +6380,7 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
6278
6380
  secure?: boolean;
6279
6381
  format?: ResponseType;
6280
6382
  }
6281
- export declare enum ContentType {
6282
- JsonPatch = "application/json-patch+json",
6283
- Json = "application/json",
6284
- JsonApi = "application/vnd.api+json",
6285
- FormData = "multipart/form-data",
6286
- UrlEncoded = "application/x-www-form-urlencoded",
6287
- Text = "text/plain"
6288
- }
6383
+ export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
6289
6384
  export declare class HttpClient<SecurityDataType = unknown> {
6290
6385
  instance: AxiosInstance;
6291
6386
  private securityData;
@@ -8027,7 +8122,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8027
8122
  * @response `200` `(CustomFieldDefinition)[]` OK
8028
8123
  */
8029
8124
  getCustomFieldDefinitions: (query?: {
8030
- entityType?: "Loan";
8125
+ entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
8031
8126
  }, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
8032
8127
  /**
8033
8128
  * No description
@@ -9698,10 +9793,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9698
9793
  * @summary Download By ID
9699
9794
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
9700
9795
  * @secure
9701
- * @response `200` `string` OK
9796
+ * @response `200` `Blob` OK
9702
9797
  * @response `404` `ProblemDetails` Not Found
9703
9798
  */
9704
- downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
9799
+ downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
9705
9800
  /**
9706
9801
  * No description
9707
9802
  *
@@ -9977,6 +10072,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9977
10072
  * @response `404` `ProblemDetails` Not Found
9978
10073
  */
9979
10074
  inviteLoanContacts: (loanId: string, data: string[], params?: RequestParams) => Promise<AxiosResponse<Invite[], any, {}>>;
10075
+ /**
10076
+ * No description
10077
+ *
10078
+ * @tags LoanInvites
10079
+ * @name DeleteLoanInvite
10080
+ * @summary Delete Invite
10081
+ * @request DELETE:/api/loans/{loanId}/invites/{id}
10082
+ * @secure
10083
+ * @response `204` `void` No Content
10084
+ * @response `404` `ProblemDetails` Not Found
10085
+ */
10086
+ deleteLoanInvite: (loanId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
9980
10087
  /**
9981
10088
  * No description
9982
10089
  *
@@ -10966,7 +11073,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10966
11073
  getPartners: (query?: {
10967
11074
  showAll?: boolean;
10968
11075
  /** @default "Realtor" */
10969
- role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
11076
+ role?: GetPartnersParamsRoleEnum;
10970
11077
  /** @format int32 */
10971
11078
  pageSize?: number;
10972
11079
  /** @format int32 */
@@ -11144,7 +11251,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11144
11251
  * @response `200` `File` OK
11145
11252
  * @response `404` `ProblemDetails` Not Found
11146
11253
  */
11147
- getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11254
+ getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11148
11255
  /**
11149
11256
  * No description
11150
11257
  *
@@ -11155,7 +11262,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11155
11262
  * @secure
11156
11263
  * @response `200` `File` OK
11157
11264
  */
11158
- createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11265
+ createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
11159
11266
  /**
11160
11267
  * No description
11161
11268
  *
@@ -11248,7 +11355,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11248
11355
  getSiteTilesBySiteConfiguration: (query?: {
11249
11356
  /** @format uuid */
11250
11357
  siteConfigurationId?: string;
11251
- location?: "HomePage" | "Dashboard";
11358
+ location?: GetSiteTilesBySiteConfigurationParamsLocationEnum;
11252
11359
  }, params?: RequestParams) => Promise<AxiosResponse<SiteTileView[], any, {}>>;
11253
11360
  /**
11254
11361
  * No description
@@ -11930,6 +12037,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11930
12037
  * @request PUT:/api/users/invites/{id}/resend
11931
12038
  * @secure
11932
12039
  * @response `204` `void` No Content
12040
+ * @response `400` `ProblemDetails` Bad Request
11933
12041
  * @response `401` `UnprocessableEntity` Unauthorized
11934
12042
  * @response `404` `UnprocessableEntity` Not Found
11935
12043
  */
@@ -11943,6 +12051,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11943
12051
  * @request GET:/api/users/invites/{token}/verify
11944
12052
  * @secure
11945
12053
  * @response `200` `Invite` OK
12054
+ * @response `400` `ProblemDetails` Bad Request
11946
12055
  * @response `422` `UnprocessableEntity` Unprocessable Content
11947
12056
  */
11948
12057
  verifyUserInvite: (token: string, params?: RequestParams) => Promise<AxiosResponse<Invite, any, {}>>;