@matech/thebigpos-sdk 2.45.0-rc0 → 2.45.0-rc5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/.husky/pre-commit +2 -2
  2. package/LICENSE +21 -21
  3. package/dist/index.d.ts +194 -108
  4. package/dist/index.js +180 -189
  5. package/dist/index.js.map +1 -1
  6. package/package.json +8 -6
  7. package/src/index.ts +1159 -860
  8. package/tsconfig.json +27 -27
package/dist/index.d.ts CHANGED
@@ -73,7 +73,7 @@ export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDele
73
73
  export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
74
74
  export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
75
75
  export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
76
- export type AiQueryTemplateName = "PipelineSummary" | "LoanDetail" | "LoansClosing" | "StaleLoans" | "LoansByType" | "LoansByOfficer" | "AverageLoanAmount" | "LockedVsUnlocked" | "LoansByPurpose" | "LoansByPropertyState" | "LoansByRate" | "DtiLtvRisk" | "DisclosureTracking" | "NewLoans" | "ExpiringLocks" | "ClosedLoans" | "VerificationGaps" | "CreditScoreDistribution" | "OccupancyMix" | "PropertyTypeMix" | "FirstTimeHomebuyer" | "SelfEmployed" | "ReferralSourcePerformance" | "AmortizationMix" | "TimeToClose" | "ConversionFunnel" | "MonthlyProduction" | "PaymentAffordability" | "DownPaymentCashToClose" | "ApprovalExpirations" | "ApplicationCompleteness" | "LosSyncHealth" | "DeclarationsRisk" | "MilitaryEligibility";
76
+ export type AiQueryTemplateName = "PipelineSummary" | "LoanDetail" | "LoansClosing" | "StaleLoans" | "LoansByType" | "LoansByOfficer" | "AverageLoanAmount" | "LockedVsUnlocked" | "LoansByPurpose" | "LoansByPropertyState" | "LoansByRate" | "DtiLtvRisk" | "DisclosureTracking" | "NewLoans" | "ExpiringLocks" | "ClosedLoans" | "VerificationGaps" | "CreditScoreDistribution" | "OccupancyMix" | "PropertyTypeMix" | "FirstTimeHomebuyer" | "SelfEmployed" | "ReferralSourcePerformance" | "AmortizationMix" | "TimeToClose" | "ConversionFunnel" | "MonthlyProduction" | "PaymentAffordability" | "DownPaymentCashToClose" | "ApprovalExpirations" | "ApplicationCompleteness" | "LosSyncHealth" | "DeclarationsRisk" | "MilitaryEligibility" | "OutstandingTasks" | "ConsentTracking";
77
77
  export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
78
78
  export type AiOutputType = "Text" | "Document";
79
79
  export type AiIntent = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
@@ -132,7 +132,7 @@ export interface AccountBilling {
132
132
  contractedRate: number;
133
133
  }
134
134
  export interface AccountBillingRequest {
135
- billingType: "ClosedLoan" | "LoanOfficer";
135
+ billingType: AccountBillingRequestBillingTypeEnum;
136
136
  /** @format double */
137
137
  contractedRate: number;
138
138
  }
@@ -176,7 +176,7 @@ export interface Action {
176
176
  comments?: string | null;
177
177
  /** @format uuid */
178
178
  siteConfigurationID: string;
179
- applicationSettings?: any;
179
+ applicationSettings?: any | null;
180
180
  surveysToken?: string | null;
181
181
  }
182
182
  export interface Address {
@@ -397,7 +397,7 @@ export interface AiAuditLog {
397
397
  conversationId?: string | null;
398
398
  /** @format uuid */
399
399
  messageId?: string | null;
400
- eventType: "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected";
400
+ eventType: AiAuditLogEventTypeEnum;
401
401
  modelId?: string | null;
402
402
  /** @format int32 */
403
403
  inputTokens?: number | null;
@@ -410,7 +410,7 @@ export interface AiAuditLog {
410
410
  guardrailCategory?: string | null;
411
411
  rawRequest?: string | null;
412
412
  rawResponse?: string | null;
413
- details?: any;
413
+ details?: any | null;
414
414
  /** @format date-time */
415
415
  createdAt: string;
416
416
  }
@@ -472,7 +472,7 @@ export interface AiChatMessagePaginated {
472
472
  count: number;
473
473
  }
474
474
  export interface AiChatMetadata {
475
- intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
475
+ intent: AiChatMetadataIntentEnum;
476
476
  fieldsAccessed: string[];
477
477
  /** @format int64 */
478
478
  queryTimeMs: number;
@@ -498,7 +498,7 @@ export interface AiChatRequest {
498
498
  promptId?: string | null;
499
499
  }
500
500
  export interface AiChatStructuredData {
501
- type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
501
+ type: AiChatStructuredDataTypeEnum;
502
502
  displayHint?: AiDisplayHint | null;
503
503
  detectedDocumentType?: string | null;
504
504
  columns: string[];
@@ -514,12 +514,12 @@ export interface AiConfigChangeLog {
514
514
  accountId?: string | null;
515
515
  /** @format uuid */
516
516
  actorUserId: string;
517
- entityType: "Prompt" | "Guardrail" | "CanonicalField" | "UrlSource" | "AdminSettings" | "AccountTokenSettings" | "AccountSettings";
517
+ entityType: AiConfigChangeLogEntityTypeEnum;
518
518
  /** @format uuid */
519
519
  entityId?: string | null;
520
- action: "Created" | "Updated" | "Deleted" | "Toggled";
521
- before?: any;
522
- after?: any;
520
+ action: AiConfigChangeLogActionEnum;
521
+ before?: any | null;
522
+ after?: any | null;
523
523
  /** @format date-time */
524
524
  createdAt: string;
525
525
  }
@@ -593,7 +593,7 @@ export interface AiGuardrail {
593
593
  /** @format uuid */
594
594
  id: string;
595
595
  name: string;
596
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
596
+ category: AiGuardrailCategoryEnum;
597
597
  description?: string | null;
598
598
  keywords: string[];
599
599
  responseTemplate: string;
@@ -699,8 +699,8 @@ export interface AiUrlSource {
699
699
  name: string;
700
700
  url: string;
701
701
  description?: string | null;
702
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
703
- scope: "FullDomain" | "SpecificPath";
702
+ category: AiUrlSourceCategoryEnum;
703
+ scope: AiUrlSourceScopeEnum;
704
704
  isActive: boolean;
705
705
  isDefault: boolean;
706
706
  hasAccountOverride: boolean;
@@ -811,14 +811,14 @@ export interface AuditLogEntry {
811
811
  /** @format uuid */
812
812
  id: string;
813
813
  entityType: string;
814
- changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
814
+ changeType: AuditLogEntryChangeTypeEnum;
815
815
  /** @format uuid */
816
816
  entityId: string;
817
817
  performedBy?: AuditLogUser | null;
818
818
  rootEntityType?: string | null;
819
819
  /** @format uuid */
820
820
  rootEntityId?: string | null;
821
- changes?: any;
821
+ changes?: any | null;
822
822
  /** @format date-time */
823
823
  createdAt: string;
824
824
  }
@@ -858,7 +858,7 @@ export interface BorrowerCount {
858
858
  firstName: string;
859
859
  lastName: string;
860
860
  email: string;
861
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
861
+ role: BorrowerCountRoleEnum;
862
862
  /** @format int32 */
863
863
  count: number;
864
864
  }
@@ -868,7 +868,7 @@ export interface BorrowerIdentity {
868
868
  firstName: string;
869
869
  lastName: string;
870
870
  email: string;
871
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
871
+ role: BorrowerIdentityRoleEnum;
872
872
  }
873
873
  export interface BorrowersNotUsingPosSummary {
874
874
  /** @format int32 */
@@ -1102,7 +1102,7 @@ export interface CorporateSearchCriteria {
1102
1102
  isActive?: boolean | null;
1103
1103
  }
1104
1104
  export interface CreateAccessScopeRequest {
1105
- scopeType: "User" | "Branch";
1105
+ scopeType: CreateAccessScopeRequestScopeTypeEnum;
1106
1106
  /** @format uuid */
1107
1107
  userId?: string | null;
1108
1108
  /** @format uuid */
@@ -1120,7 +1120,7 @@ export interface CreateAccountRequest {
1120
1120
  /** @format int64 */
1121
1121
  nlmsid: number;
1122
1122
  settings: AccountSettingsRequest;
1123
- environment: "Development" | "Staging" | "UAT" | "Production";
1123
+ environment: CreateAccountRequestEnvironmentEnum;
1124
1124
  losIntegration: LOSIntegration;
1125
1125
  billingSettings: AccountBillingRequest;
1126
1126
  }
@@ -1134,7 +1134,7 @@ export interface CreateAiCanonicalFieldRequest {
1134
1134
  }
1135
1135
  export interface CreateAiGuardrailRequest {
1136
1136
  name: string;
1137
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
1137
+ category: CreateAiGuardrailRequestCategoryEnum;
1138
1138
  description?: string | null;
1139
1139
  keywords: string[];
1140
1140
  responseTemplate: string;
@@ -1160,8 +1160,8 @@ export interface CreateAiUrlSourceRequest {
1160
1160
  name: string;
1161
1161
  url: string;
1162
1162
  description?: string | null;
1163
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
1164
- scope: "FullDomain" | "SpecificPath";
1163
+ category: CreateAiUrlSourceRequestCategoryEnum;
1164
+ scope: CreateAiUrlSourceRequestScopeEnum;
1165
1165
  }
1166
1166
  export interface CreateBranchRequest {
1167
1167
  name: string;
@@ -1184,8 +1184,8 @@ export interface CreateCustomFieldDefinitionRequest {
1184
1184
  name: string;
1185
1185
  defaultValue?: string | null;
1186
1186
  regexPattern?: string | null;
1187
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1188
- entityType: "Loan";
1187
+ dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
1188
+ entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
1189
1189
  options?: CustomFieldOptionRequest[] | null;
1190
1190
  permissions?: CustomFieldPermissionRequest[] | null;
1191
1191
  }
@@ -1200,7 +1200,7 @@ export interface CreateDocumentTemplateRequest {
1200
1200
  export interface CreateGroupMemberRequest {
1201
1201
  /** @format uuid */
1202
1202
  userId: string;
1203
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1203
+ loanRole: CreateGroupMemberRequestLoanRoleEnum;
1204
1204
  }
1205
1205
  export interface CreateInviteRequest {
1206
1206
  firstName: string;
@@ -1208,7 +1208,7 @@ export interface CreateInviteRequest {
1208
1208
  emailAddress: string;
1209
1209
  phoneNumber?: string | null;
1210
1210
  /** @deprecated */
1211
- relationship: "NotApplicable" | "Spouse" | "NonSpouse";
1211
+ relationship: CreateInviteRequestRelationshipEnum;
1212
1212
  loanID: string;
1213
1213
  route?: string | null;
1214
1214
  /** @format uuid */
@@ -1228,7 +1228,7 @@ export interface CreateLoanImportRequest {
1228
1228
  endDate: string;
1229
1229
  /** @format date-time */
1230
1230
  startDate: string;
1231
- importMode: "All" | "NewOnly" | "UpdateOnly";
1231
+ importMode: CreateLoanImportRequestImportModeEnum;
1232
1232
  }
1233
1233
  export interface CreateSession {
1234
1234
  sessionId: string;
@@ -1246,7 +1246,7 @@ export interface CreateUserDeviceRequest {
1246
1246
  token: string;
1247
1247
  }
1248
1248
  export interface CreateUserDraft {
1249
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
1249
+ loanRole: CreateUserDraftLoanRoleEnum;
1250
1250
  }
1251
1251
  export interface CreateUserGroupRequest {
1252
1252
  name: string;
@@ -1307,8 +1307,8 @@ export interface CustomFieldDefinition {
1307
1307
  name: string;
1308
1308
  defaultValue?: string | null;
1309
1309
  regexPattern?: string | null;
1310
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1311
- entityType: "Loan";
1310
+ dataType: CustomFieldDefinitionDataTypeEnum;
1311
+ entityType: CustomFieldDefinitionEntityTypeEnum;
1312
1312
  options: CustomFieldOption[];
1313
1313
  permissions: CustomFieldPermission[];
1314
1314
  encompassMapping?: EncompassMapping | null;
@@ -1322,7 +1322,7 @@ export interface CustomFieldEntry {
1322
1322
  displayOrder: number;
1323
1323
  name: string;
1324
1324
  value: string;
1325
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1325
+ dataType: CustomFieldEntryDataTypeEnum;
1326
1326
  }
1327
1327
  export interface CustomFieldOption {
1328
1328
  /** @format uuid */
@@ -1339,12 +1339,12 @@ export interface CustomFieldOptionRequest {
1339
1339
  export interface CustomFieldPermission {
1340
1340
  /** @format uuid */
1341
1341
  id: string;
1342
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1343
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1342
+ role: CustomFieldPermissionRoleEnum;
1343
+ accessLevel: CustomFieldPermissionAccessLevelEnum;
1344
1344
  }
1345
1345
  export interface CustomFieldPermissionRequest {
1346
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1347
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1346
+ role: CustomFieldPermissionRequestRoleEnum;
1347
+ accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
1348
1348
  }
1349
1349
  export interface CustomFieldValue {
1350
1350
  /** @format uuid */
@@ -1355,7 +1355,7 @@ export interface CustomFieldValue {
1355
1355
  customFieldDefinitionID: string;
1356
1356
  value: string;
1357
1357
  definitionName: string;
1358
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1358
+ dataType: CustomFieldValueDataTypeEnum;
1359
1359
  }
1360
1360
  export interface DetailedUser {
1361
1361
  /** @format date-time */
@@ -1593,7 +1593,7 @@ export interface Draft {
1593
1593
  siteConfiguration: SiteConfigurationReduced;
1594
1594
  /** @format uuid */
1595
1595
  loanID?: string | null;
1596
- type: "NewLoan" | "EditLoan";
1596
+ type: DraftTypeEnum;
1597
1597
  isCoBorrower: boolean;
1598
1598
  }
1599
1599
  export interface DraftContent {
@@ -1611,7 +1611,7 @@ export interface DraftContent {
1611
1611
  siteConfiguration: SiteConfigurationReduced;
1612
1612
  /** @format uuid */
1613
1613
  loanID?: string | null;
1614
- type: "NewLoan" | "EditLoan";
1614
+ type: DraftContentTypeEnum;
1615
1615
  isCoBorrower: boolean;
1616
1616
  applicationPayload: any;
1617
1617
  }
@@ -1627,7 +1627,7 @@ export interface DraftLoanOfficerReassignRequest {
1627
1627
  }
1628
1628
  export interface DraftRequest {
1629
1629
  applicationPayload: any;
1630
- customData?: any;
1630
+ customData?: any | null;
1631
1631
  isCoBorrower: boolean;
1632
1632
  }
1633
1633
  export interface EconsentPendingSummary {
@@ -1701,9 +1701,9 @@ export interface EncompassCredentialsDetail {
1701
1701
  clearStateIfUnlicensed: boolean;
1702
1702
  /** @deprecated */
1703
1703
  baseUrl?: string | null;
1704
- encompassEnvironment: "Production" | "UAT";
1704
+ encompassEnvironment: EncompassCredentialsDetailEncompassEnvironmentEnum;
1705
1705
  consumerConnectWidgetHost?: string | null;
1706
- signingMethod: "ConsumerConnect" | "POSF";
1706
+ signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1707
1707
  subscriptionId?: string | null;
1708
1708
  environment?: string | null;
1709
1709
  }
@@ -1719,9 +1719,9 @@ export interface EncompassCredentialsRequest {
1719
1719
  clearStateIfUnlicensed: boolean;
1720
1720
  /** @deprecated */
1721
1721
  baseUrl?: string | null;
1722
- encompassEnvironment: "Production" | "UAT";
1722
+ encompassEnvironment: EncompassCredentialsRequestEncompassEnvironmentEnum;
1723
1723
  consumerConnectWidgetHost?: string | null;
1724
- signingMethod: "ConsumerConnect" | "POSF";
1724
+ signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1725
1725
  subscriptionId?: string | null;
1726
1726
  environment?: string | null;
1727
1727
  clientID?: string | null;
@@ -1830,8 +1830,8 @@ export interface EncompassRequestLog {
1830
1830
  losId?: string | null;
1831
1831
  /** @format uuid */
1832
1832
  accountId: string;
1833
- operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
1834
- outcome: "Success" | "Failure" | "PartialSuccess";
1833
+ operationType: EncompassRequestLogOperationTypeEnum;
1834
+ outcome: EncompassRequestLogOutcomeEnum;
1835
1835
  message: string;
1836
1836
  endpoint?: string | null;
1837
1837
  httpMethod?: string | null;
@@ -1839,7 +1839,7 @@ export interface EncompassRequestLog {
1839
1839
  httpStatusCode?: number | null;
1840
1840
  /** @format int64 */
1841
1841
  durationMs?: number | null;
1842
- context?: any;
1842
+ context?: any | null;
1843
1843
  /** @format date-time */
1844
1844
  createdAt: string;
1845
1845
  }
@@ -1878,7 +1878,7 @@ export interface FileSearchCriteria {
1878
1878
  export interface FileWithBytes {
1879
1879
  name: string;
1880
1880
  /** @format byte */
1881
- data: string;
1881
+ data: Blob;
1882
1882
  fileName: string;
1883
1883
  mimeType?: string | null;
1884
1884
  extension?: string | null;
@@ -1954,7 +1954,7 @@ export interface FormSubmission {
1954
1954
  subjectPropertyAddressCounty?: string | null;
1955
1955
  subjectPropertyAddressState?: string | null;
1956
1956
  subjectPropertyAddressZip?: string | null;
1957
- data?: any;
1957
+ data?: any | null;
1958
1958
  /** @format uuid */
1959
1959
  listingID?: string | null;
1960
1960
  listing?: Listing | null;
@@ -1989,7 +1989,7 @@ export interface FormSubmissionRequest {
1989
1989
  subjectPropertyAddressCounty?: string | null;
1990
1990
  subjectPropertyAddressState?: string | null;
1991
1991
  subjectPropertyAddressZip?: string | null;
1992
- data?: any;
1992
+ data?: any | null;
1993
1993
  /** @format uuid */
1994
1994
  listingID?: string | null;
1995
1995
  }
@@ -2038,7 +2038,7 @@ export interface FusionFieldDisplay {
2038
2038
  fieldValue: string;
2039
2039
  }
2040
2040
  export interface FusionReportFilter {
2041
- filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
2041
+ filterType: FusionReportFilterFilterTypeEnum;
2042
2042
  targetField: string;
2043
2043
  targetValue: string;
2044
2044
  }
@@ -2060,7 +2060,7 @@ export interface GenerateSystemPrompt {
2060
2060
  }
2061
2061
  export interface GenerateSystemPromptRequest {
2062
2062
  description: string;
2063
- category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
2063
+ category: GenerateSystemPromptRequestCategoryEnum;
2064
2064
  }
2065
2065
  export interface GetApplications {
2066
2066
  applications: ApplicationRowData[];
@@ -2144,11 +2144,11 @@ export interface GetWorkflowRequest {
2144
2144
  export interface GuidPatchOperation {
2145
2145
  op: string;
2146
2146
  path: string;
2147
- value?: any;
2147
+ value?: any | null;
2148
2148
  from?: string | null;
2149
2149
  }
2150
2150
  export interface IPAddress {
2151
- 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";
2151
+ addressFamily: IpAddressAddressFamilyEnum;
2152
2152
  /** @format int64 */
2153
2153
  scopeId: number;
2154
2154
  isIPv6Multicast: boolean;
@@ -2395,7 +2395,7 @@ export interface Loan {
2395
2395
  contacts: LoanContact[];
2396
2396
  customFields: CustomFieldEntry[];
2397
2397
  milestones: LoanMilestone[];
2398
- signingMethod: "ConsumerConnect" | "POSF";
2398
+ signingMethod: LoanSigningMethodEnum;
2399
2399
  }
2400
2400
  export interface LoanApplication {
2401
2401
  /** @format uuid */
@@ -2431,7 +2431,7 @@ export interface LoanApplicationRequest {
2431
2431
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2432
2432
  /** @format uuid */
2433
2433
  draftId?: string | null;
2434
- additionalFields?: Record<string, any>;
2434
+ additionalFields?: Record<string, any> | null;
2435
2435
  /** @format uuid */
2436
2436
  existingLoanId?: string | null;
2437
2437
  }
@@ -2450,7 +2450,7 @@ export interface LoanBorrower {
2450
2450
  citizenship?: LoanCitizenship | null;
2451
2451
  maritalStatus?: LoanMaritalStatus | null;
2452
2452
  languagePreference?: LoanLanguagePreference | null;
2453
- applicationStatus: "Draft" | "Complete";
2453
+ applicationStatus: LoanBorrowerApplicationStatusEnum;
2454
2454
  /** @format int32 */
2455
2455
  numberOfDependents?: number | null;
2456
2456
  isPrimaryBorrower: boolean;
@@ -2976,9 +2976,18 @@ export interface LoanBorrowerRealEstateAsset {
2976
2976
  /** @format double */
2977
2977
  marketValue?: number | null;
2978
2978
  /** @format double */
2979
+ purchasePrice?: number | null;
2980
+ /** @format int32 */
2981
+ yearBuilt?: number | null;
2982
+ /** @format int32 */
2983
+ numberOfUnits?: number | null;
2984
+ /** @format double */
2979
2985
  monthlyInsTaxDues?: number | null;
2980
2986
  /** @format double */
2981
2987
  monthlyRentalIncome?: number | null;
2988
+ /** @format double */
2989
+ maintenanceExpense?: number | null;
2990
+ dispositionStatus?: string | null;
2982
2991
  address?: AddressV3 | null;
2983
2992
  mortgages?: LoanBorrowerRealEstateAssetMortgage[] | null;
2984
2993
  }
@@ -3152,7 +3161,7 @@ export interface LoanConsentRequest {
3152
3161
  borrowerEConsent?: boolean | null;
3153
3162
  borrowerCreditAuth?: boolean | null;
3154
3163
  borrowerTCPAOptIn?: boolean | null;
3155
- additionalFields?: Record<string, string>;
3164
+ additionalFields?: Record<string, string> | null;
3156
3165
  }
3157
3166
  export interface LoanContact {
3158
3167
  /** @format date-time */
@@ -3170,13 +3179,13 @@ export interface LoanContact {
3170
3179
  email?: string | null;
3171
3180
  phone?: string | null;
3172
3181
  companyName?: string | null;
3173
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3182
+ role: LoanContactRoleEnum;
3174
3183
  }
3175
3184
  export interface LoanContactList {
3176
3185
  email: string;
3177
3186
  }
3178
3187
  export interface LoanCustomFieldsRequest {
3179
- additionalFields?: Record<string, string>;
3188
+ additionalFields?: Record<string, string> | null;
3180
3189
  }
3181
3190
  export interface LoanDocument {
3182
3191
  /** @format date-time */
@@ -3226,12 +3235,12 @@ export interface LoanDocumentFolderPermission {
3226
3235
  id: string;
3227
3236
  /** @format uuid */
3228
3237
  loanDocumentFolderID: string;
3229
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3230
- level: "None" | "Read" | "Write" | "Manage";
3238
+ role: LoanDocumentFolderPermissionRoleEnum;
3239
+ level: LoanDocumentFolderPermissionLevelEnum;
3231
3240
  }
3232
3241
  export interface LoanDocumentFolderPermissionRequest {
3233
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3234
- level: "None" | "Read" | "Write" | "Manage";
3242
+ role: LoanDocumentFolderPermissionRequestRoleEnum;
3243
+ level: LoanDocumentFolderPermissionRequestLevelEnum;
3235
3244
  }
3236
3245
  export interface LoanDocumentFolderUsage {
3237
3246
  /** @format uuid */
@@ -3347,13 +3356,13 @@ export interface LoanImport {
3347
3356
  /** @format int32 */
3348
3357
  importedCount: number;
3349
3358
  statusMessage?: string | null;
3350
- status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3351
- importMode: "All" | "NewOnly" | "UpdateOnly";
3359
+ status: LoanImportStatusEnum;
3360
+ importMode: LoanImportImportModeEnum;
3352
3361
  /** @format date-time */
3353
3362
  createdAt?: string | null;
3354
3363
  }
3355
3364
  export interface LoanImportLog {
3356
- level: "None" | "Info" | "Warning" | "Error";
3365
+ level: LoanImportLogLevelEnum;
3357
3366
  message: string;
3358
3367
  /** @format date-time */
3359
3368
  createdAt: string;
@@ -3408,8 +3417,8 @@ export interface LoanListPaginated {
3408
3417
  export interface LoanLog {
3409
3418
  /** @format uuid */
3410
3419
  id: string;
3411
- level: "None" | "Info" | "Warning" | "Error";
3412
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
3420
+ level: LoanLogLevelEnum;
3421
+ type: LoanLogTypeEnum;
3413
3422
  message: string;
3414
3423
  /** @format date-time */
3415
3424
  createdAt: string;
@@ -3417,8 +3426,8 @@ export interface LoanLog {
3417
3426
  export interface LoanLogDetail {
3418
3427
  /** @format uuid */
3419
3428
  id: string;
3420
- level: "None" | "Info" | "Warning" | "Error";
3421
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
3429
+ level: LoanLogDetailLevelEnum;
3430
+ type: LoanLogDetailTypeEnum;
3422
3431
  message: string;
3423
3432
  /** @format date-time */
3424
3433
  createdAt: string;
@@ -3652,7 +3661,7 @@ export interface LoanQueueWithData {
3652
3661
  user: UserPublic;
3653
3662
  loanOfficer: LoanOfficerPublic;
3654
3663
  siteConfiguration: SiteConfigurationReduced;
3655
- data?: any;
3664
+ data?: any | null;
3656
3665
  }
3657
3666
  export interface LoanRecord {
3658
3667
  loanGuid: string;
@@ -3683,7 +3692,7 @@ export interface LoanTaskSearchRequest {
3683
3692
  loanStatus?: LoanTaskActivityFilter | null;
3684
3693
  }
3685
3694
  export interface LoanTaskStatusSummary {
3686
- status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3695
+ status: LoanTaskStatusSummaryStatusEnum;
3687
3696
  /** @format int32 */
3688
3697
  count: number;
3689
3698
  }
@@ -3695,7 +3704,7 @@ export interface LoanUser {
3695
3704
  email: string;
3696
3705
  phone?: string | null;
3697
3706
  role: string;
3698
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3707
+ loanRole: LoanUserLoanRoleEnum;
3699
3708
  isUser: boolean;
3700
3709
  /** @format date-time */
3701
3710
  createdAt: string;
@@ -3728,7 +3737,7 @@ export interface LosOperationTracking {
3728
3737
  operationType: string;
3729
3738
  correlationKey: string;
3730
3739
  lastTriggerSource?: string | null;
3731
- status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
3740
+ status: LosOperationTrackingStatusEnum;
3732
3741
  /** @format date-time */
3733
3742
  createdAt: string;
3734
3743
  /** @format date-time */
@@ -3789,7 +3798,7 @@ export interface LosSyncStep {
3789
3798
  /** @format int32 */
3790
3799
  order: number;
3791
3800
  name: string;
3792
- severity: "Success" | "Info" | "Warning" | "Error";
3801
+ severity: LosSyncStepSeverityEnum;
3793
3802
  message: string;
3794
3803
  /** @format date-time */
3795
3804
  atUtc: string;
@@ -3803,7 +3812,7 @@ export interface LosWebhook {
3803
3812
  enableSubscription: boolean;
3804
3813
  }
3805
3814
  export interface ManualDocumentClassificationRequest {
3806
- 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";
3815
+ documentType: ManualDocumentClassificationRequestDocumentTypeEnum;
3807
3816
  }
3808
3817
  export interface MdmUser {
3809
3818
  user_email?: string | null;
@@ -3882,7 +3891,7 @@ export interface ModuleParameterValue {
3882
3891
  parameterID: string;
3883
3892
  parameterName: string;
3884
3893
  parameterType: string;
3885
- value?: any;
3894
+ value?: any | null;
3886
3895
  isInherited: boolean;
3887
3896
  }
3888
3897
  export interface MonthlyPaymentCalculator {
@@ -4055,7 +4064,7 @@ export interface NotificationTemplateVersionUpdateRequest {
4055
4064
  }
4056
4065
  export interface Operation {
4057
4066
  op?: string;
4058
- value?: string | number | boolean | null | object;
4067
+ value?: object | null;
4059
4068
  path?: string;
4060
4069
  }
4061
4070
  export interface OverridePasswordRequest {
@@ -4385,7 +4394,7 @@ export interface SiteConfiguration {
4385
4394
  deletedAt?: string | null;
4386
4395
  /** @format uuid */
4387
4396
  id: string;
4388
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4397
+ type: SiteConfigurationTypeEnum;
4389
4398
  /** @format uuid */
4390
4399
  entityID: string;
4391
4400
  /** @format int32 */
@@ -4578,7 +4587,7 @@ export interface SiteConfigurationByUrl {
4578
4587
  deletedAt?: string | null;
4579
4588
  /** @format uuid */
4580
4589
  id: string;
4581
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4590
+ type: SiteConfigurationByUrlTypeEnum;
4582
4591
  /** @format uuid */
4583
4592
  entityID: string;
4584
4593
  /** @format int32 */
@@ -4788,7 +4797,7 @@ export interface SiteConfigurationForm {
4788
4797
  export interface SiteConfigurationReduced {
4789
4798
  /** @format uuid */
4790
4799
  id: string;
4791
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4800
+ type: SiteConfigurationReducedTypeEnum;
4792
4801
  url?: string | null;
4793
4802
  name: string;
4794
4803
  /** @format int64 */
@@ -4805,7 +4814,7 @@ export interface SiteConfigurationRequest {
4805
4814
  entityID: string;
4806
4815
  /** @format int32 */
4807
4816
  entityType: number;
4808
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4817
+ type: SiteConfigurationRequestTypeEnum;
4809
4818
  url: string;
4810
4819
  name: string;
4811
4820
  introduction?: string | null;
@@ -4980,7 +4989,7 @@ export interface SiteConfigurationSearchCriteria {
4980
4989
  export interface SiteConfigurationSummary {
4981
4990
  /** @format uuid */
4982
4991
  id: string;
4983
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4992
+ type: SiteConfigurationSummaryTypeEnum;
4984
4993
  url?: string | null;
4985
4994
  name: string;
4986
4995
  /** @format int64 */
@@ -5243,7 +5252,7 @@ export interface UnregisteredBorrower {
5243
5252
  lastName?: string | null;
5244
5253
  fullName?: string | null;
5245
5254
  email?: string | null;
5246
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5255
+ role: UnregisteredBorrowerRoleEnum;
5247
5256
  }
5248
5257
  export interface UpdateAccountRequest {
5249
5258
  name: string;
@@ -5267,7 +5276,7 @@ export interface UpdateAiCanonicalFieldRequest {
5267
5276
  }
5268
5277
  export interface UpdateAiGuardrailRequest {
5269
5278
  name: string;
5270
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5279
+ category: UpdateAiGuardrailRequestCategoryEnum;
5271
5280
  description?: string | null;
5272
5281
  keywords: string[];
5273
5282
  responseTemplate: string;
@@ -5292,8 +5301,8 @@ export interface UpdateAiUrlSourceRequest {
5292
5301
  name: string;
5293
5302
  url: string;
5294
5303
  description?: string | null;
5295
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5296
- scope: "FullDomain" | "SpecificPath";
5304
+ category: UpdateAiUrlSourceRequestCategoryEnum;
5305
+ scope: UpdateAiUrlSourceRequestScopeEnum;
5297
5306
  }
5298
5307
  export interface UpdateCustomFieldDefinitionRequest {
5299
5308
  isRequired: boolean;
@@ -5580,7 +5589,7 @@ export interface UserDevice {
5580
5589
  export interface UserDraft {
5581
5590
  /** @format uuid */
5582
5591
  draftID: string;
5583
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5592
+ role: UserDraftRoleEnum;
5584
5593
  user: User;
5585
5594
  }
5586
5595
  export interface UserDraftPaginated {
@@ -5604,7 +5613,7 @@ export interface UserGroupAccessScope {
5604
5613
  id: string;
5605
5614
  /** @format uuid */
5606
5615
  groupId: string;
5607
- scopeType: "User" | "Branch";
5616
+ scopeType: UserGroupAccessScopeScopeTypeEnum;
5608
5617
  /** @format uuid */
5609
5618
  userId?: string | null;
5610
5619
  /** @format uuid */
@@ -5637,7 +5646,7 @@ export interface UserLoan {
5637
5646
  deletedAt?: string | null;
5638
5647
  loanID: string;
5639
5648
  user: User;
5640
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5649
+ role: UserLoanRoleEnum;
5641
5650
  /** @format int32 */
5642
5651
  borrowerPair?: number | null;
5643
5652
  /** @format int32 */
@@ -5649,11 +5658,11 @@ export interface UserLoanConsent {
5649
5658
  id: string;
5650
5659
  /** @format uuid */
5651
5660
  userLoanID: string;
5652
- type: "Econsent" | "CreditAuthorization" | "Tcpa";
5661
+ type: UserLoanConsentTypeEnum;
5653
5662
  providedConsent: boolean;
5654
5663
  source?: ConsentSource | null;
5655
5664
  ipAddress?: string | null;
5656
- losSyncStatus: "NotStarted" | "Failed" | "Success";
5665
+ losSyncStatus: UserLoanConsentLosSyncStatusEnum;
5657
5666
  /** @format date-time */
5658
5667
  createdAt: string;
5659
5668
  /** @format date-time */
@@ -5783,7 +5792,7 @@ export interface UserSummary {
5783
5792
  id: string;
5784
5793
  name?: string | null;
5785
5794
  email?: string | null;
5786
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5795
+ role: UserSummaryRoleEnum;
5787
5796
  }
5788
5797
  export interface VerifyPasswordRequest {
5789
5798
  email: string;
@@ -5810,6 +5819,90 @@ export interface Workflow {
5810
5819
  tileSubtitle: string;
5811
5820
  icon: string;
5812
5821
  }
5822
+ export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
5823
+ 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";
5824
+ export type AiChatMetadataIntentEnum = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
5825
+ export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
5826
+ export type AiConfigChangeLogEntityTypeEnum = "Prompt" | "Guardrail" | "CanonicalField" | "UrlSource" | "AdminSettings" | "AccountTokenSettings" | "AccountSettings";
5827
+ export type AiConfigChangeLogActionEnum = "Created" | "Updated" | "Deleted" | "Toggled";
5828
+ export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5829
+ export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5830
+ export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
5831
+ export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
5832
+ export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5833
+ export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5834
+ export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
5835
+ export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
5836
+ export type CreateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5837
+ export type CreateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5838
+ export type CreateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
5839
+ export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5840
+ export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
5841
+ export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5842
+ /** @deprecated */
5843
+ export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
5844
+ export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5845
+ export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5846
+ export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5847
+ export type CustomFieldDefinitionEntityTypeEnum = "Loan";
5848
+ export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5849
+ export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5850
+ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5851
+ export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5852
+ export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5853
+ export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5854
+ export type DraftTypeEnum = "NewLoan" | "EditLoan";
5855
+ export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
5856
+ export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
5857
+ export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
5858
+ export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
5859
+ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
5860
+ export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
5861
+ export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
5862
+ export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
5863
+ export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
5864
+ 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";
5865
+ export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
5866
+ export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
5867
+ export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5868
+ export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5869
+ export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
5870
+ export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5871
+ export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
5872
+ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
5873
+ export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5874
+ export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5875
+ export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5876
+ export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
5877
+ export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
5878
+ export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
5879
+ export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
5880
+ export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5881
+ export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
5882
+ export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
5883
+ 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";
5884
+ export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5885
+ export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5886
+ export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5887
+ export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5888
+ export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5889
+ export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5890
+ export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
5891
+ export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5892
+ export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
5893
+ export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5894
+ export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
5895
+ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5896
+ export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
5897
+ export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
5898
+ export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5899
+ export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
5900
+ /** @default "Realtor" */
5901
+ export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5902
+ export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5903
+ export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5904
+ export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5905
+ export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5813
5906
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
5814
5907
  export type QueryParamsType = Record<string | number, any>;
5815
5908
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -5832,14 +5925,7 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
5832
5925
  secure?: boolean;
5833
5926
  format?: ResponseType;
5834
5927
  }
5835
- export declare enum ContentType {
5836
- JsonPatch = "application/json-patch+json",
5837
- Json = "application/json",
5838
- JsonApi = "application/vnd.api+json",
5839
- FormData = "multipart/form-data",
5840
- UrlEncoded = "application/x-www-form-urlencoded",
5841
- Text = "text/plain"
5842
- }
5928
+ export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
5843
5929
  export declare class HttpClient<SecurityDataType = unknown> {
5844
5930
  instance: AxiosInstance;
5845
5931
  private securityData;
@@ -7372,7 +7458,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7372
7458
  * @response `200` `(CustomFieldDefinition)[]` OK
7373
7459
  */
7374
7460
  getCustomFieldDefinitions: (query?: {
7375
- entityType?: "Loan";
7461
+ entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
7376
7462
  }, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
7377
7463
  /**
7378
7464
  * No description
@@ -8879,10 +8965,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8879
8965
  * @summary Download By ID
8880
8966
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
8881
8967
  * @secure
8882
- * @response `200` `string` OK
8968
+ * @response `200` `Blob` OK
8883
8969
  * @response `404` `ProblemDetails` Not Found
8884
8970
  */
8885
- downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
8971
+ downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
8886
8972
  /**
8887
8973
  * No description
8888
8974
  *
@@ -10126,7 +10212,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10126
10212
  getPartners: (query?: {
10127
10213
  showAll?: boolean;
10128
10214
  /** @default "Realtor" */
10129
- role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
10215
+ role?: GetPartnersParamsRoleEnum;
10130
10216
  /** @format int32 */
10131
10217
  pageSize?: number;
10132
10218
  /** @format int32 */
@@ -10304,7 +10390,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10304
10390
  * @response `200` `File` OK
10305
10391
  * @response `404` `ProblemDetails` Not Found
10306
10392
  */
10307
- getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10393
+ getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10308
10394
  /**
10309
10395
  * No description
10310
10396
  *
@@ -10315,7 +10401,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10315
10401
  * @secure
10316
10402
  * @response `200` `File` OK
10317
10403
  */
10318
- createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10404
+ createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
10319
10405
  /**
10320
10406
  * No description
10321
10407
  *