@matech/thebigpos-sdk 2.29.1 → 2.31.1

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/src/index.ts CHANGED
@@ -30,7 +30,7 @@ export type SiteConfigurationType =
30
30
  | "LoanOfficer"
31
31
  | "Partner";
32
32
 
33
- export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS";
33
+ export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
34
34
 
35
35
  export type OperationType =
36
36
  | "Add"
@@ -43,6 +43,15 @@ export type OperationType =
43
43
 
44
44
  export type LogLevel = "None" | "Info" | "Warning" | "Error";
45
45
 
46
+ export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
47
+
48
+ export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
49
+
50
+ export type LoanTitleHeld =
51
+ | "Sole"
52
+ | "JointWithSpouse"
53
+ | "JointWithOtherThanSpouse";
54
+
46
55
  export type LoanRole =
47
56
  | "Borrower"
48
57
  | "CoBorrower"
@@ -57,6 +66,8 @@ export type LoanRole =
57
66
  | "EscrowAgent"
58
67
  | "SettlementAgent";
59
68
 
69
+ export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell";
70
+
60
71
  export type LoanQueueType =
61
72
  | "Unknown"
62
73
  | "New"
@@ -68,6 +79,108 @@ export type LoanQueueType =
68
79
 
69
80
  export type LoanQueueReason = "Unknown" | "Locked" | "LOSError" | "Exception";
70
81
 
82
+ export type LoanPurpose = "Purchase" | "Refinance";
83
+
84
+ export type LoanPropertyType =
85
+ | "SingleFamily"
86
+ | "MultiFamily"
87
+ | "Condominium"
88
+ | "Townhouse"
89
+ | "ManufacturedHome"
90
+ | "PlannedUnitDevelopment"
91
+ | "ModularHome"
92
+ | "Other";
93
+
94
+ export type LoanPhoneNumberType = "Home" | "Cell" | "Work" | "Fax" | "Other";
95
+
96
+ export type LoanPacificIslanderRace =
97
+ | "NativeHawaiian"
98
+ | "GuamanianOrChamorro"
99
+ | "Samoan"
100
+ | "Other";
101
+
102
+ export type LoanOwnershipInterestPropertyType =
103
+ | "PrimaryResidence"
104
+ | "FHASecondaryResidence"
105
+ | "SecondaryResidence"
106
+ | "Investment";
107
+
108
+ export type LoanOtherLiabilityType =
109
+ | "Alimony"
110
+ | "ChildSupport"
111
+ | "SeparateMaintenance"
112
+ | "JobRelatedExpense"
113
+ | "Other";
114
+
115
+ export type LoanOtherIncomeType =
116
+ | "AccessoryUnitIncome"
117
+ | "Alimony"
118
+ | "AutomobileAllowance"
119
+ | "BoarderIncome"
120
+ | "CapitalGains"
121
+ | "ChildSupport"
122
+ | "DefinedContributionPlan"
123
+ | "Disability"
124
+ | "DividendsInterest"
125
+ | "EmploymentRelatedAccount"
126
+ | "FosterCare"
127
+ | "HousingAllowance"
128
+ | "HousingChoiceVoucherProgram"
129
+ | "MortgageCreditCertificate"
130
+ | "MortgageDifferential"
131
+ | "NonBorrowerHouseholdIncome"
132
+ | "NotesReceivableInstallment"
133
+ | "Pension"
134
+ | "PublicAssistance"
135
+ | "Royalties"
136
+ | "SeparateMaintenance"
137
+ | "SocialSecurity"
138
+ | "TemporaryLeave"
139
+ | "TipIncome"
140
+ | "Trust"
141
+ | "VABenefitsNonEducational"
142
+ | "Other";
143
+
144
+ export type LoanOtherAssetType =
145
+ | "ProceedsRealEstate"
146
+ | "ProceedsNonRealEstate"
147
+ | "SecuredBorrowerFunds"
148
+ | "UnsecuredBorrowerFunds"
149
+ | "EarnestMoney"
150
+ | "EmployerAssistance"
151
+ | "LotEquity"
152
+ | "ReAddressFunds"
153
+ | "RentCredit"
154
+ | "SweatEquity"
155
+ | "TradeEquity"
156
+ | "Other";
157
+
158
+ export type LoanOccupancyType =
159
+ | "PrimaryHome"
160
+ | "SecondHome"
161
+ | "InvestmentProperty"
162
+ | "Other";
163
+
164
+ export type LoanNameSuffix =
165
+ | "Jr"
166
+ | "Sr"
167
+ | "II"
168
+ | "III"
169
+ | "IV"
170
+ | "V"
171
+ | "VI"
172
+ | "VII";
173
+
174
+ export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
175
+
176
+ export type LoanMilitaryServiceType =
177
+ | "Current"
178
+ | "RetiredDischargedSeparated"
179
+ | "NonActivatedNationalGuard"
180
+ | "SurvivingSpouse";
181
+
182
+ export type LoanMaritalStatus = "Married" | "Separated" | "Unmarried";
183
+
71
184
  export type LoanLogType =
72
185
  | "Loan"
73
186
  | "Queue"
@@ -82,6 +195,24 @@ export type LoanLogType =
82
195
  | "LoanStatusChanged"
83
196
  | "EConsent";
84
197
 
198
+ export type LoanLienPosition = "First" | "Subordinate";
199
+
200
+ export type LoanLiabilityType =
201
+ | "Revolving"
202
+ | "Installment"
203
+ | "Open30Day"
204
+ | "Lease"
205
+ | "Other";
206
+
207
+ export type LoanLanguagePreference =
208
+ | "English"
209
+ | "Chinese"
210
+ | "Korean"
211
+ | "Spanish"
212
+ | "Tagalog"
213
+ | "Vietnamese"
214
+ | "Other";
215
+
85
216
  export type LoanImportStatus =
86
217
  | "WaitingProcess"
87
218
  | "InProgress"
@@ -91,6 +222,69 @@ export type LoanImportStatus =
91
222
 
92
223
  export type LoanImportMode = "All" | "NewOnly" | "UpdateOnly";
93
224
 
225
+ export type LoanHousingType = "NoExpense" | "Own" | "Rent";
226
+
227
+ export type LoanHomeOwnershipType = "Counseling" | "Education" | "Other";
228
+
229
+ export type LoanHomeOwnershipFormat = "InPerson" | "Online" | "Telephone";
230
+
231
+ export type LoanHispanicEthnicity =
232
+ | "Mexican"
233
+ | "PuertoRican"
234
+ | "Cuban"
235
+ | "Other";
236
+
237
+ export type LoanGiftSource =
238
+ | "CommunityNonProfit"
239
+ | "Employer"
240
+ | "FederalAgency"
241
+ | "LocalAgency"
242
+ | "Relative"
243
+ | "ReligiousNonProfit"
244
+ | "StateAgency"
245
+ | "UnmarriedPartner"
246
+ | "Lender"
247
+ | "Other";
248
+
249
+ export type LoanGiftAssetType = "Cash" | "Asset" | "Equity";
250
+
251
+ export type LoanGenderType = "Male" | "Female";
252
+
253
+ export type LoanCitizenship =
254
+ | "USCitizen"
255
+ | "PermanentResidentAlien"
256
+ | "NonPermanentResidentAlien";
257
+
258
+ export type LoanBankruptcyType =
259
+ | "Chapter7"
260
+ | "Chapter11"
261
+ | "Chapter12"
262
+ | "Chapter13";
263
+
264
+ export type LoanAsianRace =
265
+ | "AsianIndian"
266
+ | "Chinese"
267
+ | "Filipino"
268
+ | "Japanese"
269
+ | "Korean"
270
+ | "Vietnamese"
271
+ | "Other";
272
+
273
+ export type LoanAccountAssetType =
274
+ | "Checking"
275
+ | "Savings"
276
+ | "MoneyMarket"
277
+ | "CertificateOfDeposit"
278
+ | "MutualFund"
279
+ | "Stocks"
280
+ | "Bonds"
281
+ | "Retirement"
282
+ | "BridgeLoanProceeds"
283
+ | "IndividualDevelopmentAccount"
284
+ | "TrustAccount"
285
+ | "CashValueOfLifeInsurance"
286
+ | "Other";
287
+
94
288
  export type LoanAccessScopeType = "User" | "Branch";
95
289
 
96
290
  export type LOSStatus =
@@ -99,7 +293,9 @@ export type LOSStatus =
99
293
  | "Retrying"
100
294
  | "Successful"
101
295
  | "Failed"
102
- | "FailedPermanently";
296
+ | "FailedPermanently"
297
+ | "Uploaded"
298
+ | "PendingSync";
103
299
 
104
300
  export type FilterType =
105
301
  | "DateGreaterThanOrEqualTo"
@@ -135,6 +331,41 @@ export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
135
331
 
136
332
  export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
137
333
 
334
+ export type AddressFamily =
335
+ | "Unspecified"
336
+ | "Unix"
337
+ | "InterNetwork"
338
+ | "ImpLink"
339
+ | "Pup"
340
+ | "Chaos"
341
+ | "NS"
342
+ | "Ipx"
343
+ | "Iso"
344
+ | "Osi"
345
+ | "Ecma"
346
+ | "DataKit"
347
+ | "Ccitt"
348
+ | "Sna"
349
+ | "DecNet"
350
+ | "DataLink"
351
+ | "Lat"
352
+ | "HyperChannel"
353
+ | "AppleTalk"
354
+ | "NetBios"
355
+ | "VoiceView"
356
+ | "FireFox"
357
+ | "Banyan"
358
+ | "Atm"
359
+ | "InterNetworkV6"
360
+ | "Cluster"
361
+ | "Ieee12844"
362
+ | "Irda"
363
+ | "NetworkDesigners"
364
+ | "Max"
365
+ | "Packet"
366
+ | "ControllerAreaNetwork"
367
+ | "Unknown";
368
+
138
369
  export interface ASOSettings {
139
370
  enabled: boolean;
140
371
  softPull: boolean;
@@ -236,6 +467,18 @@ export interface AddressRequest {
236
467
  postalCode: string;
237
468
  }
238
469
 
470
+ export interface AddressV3 {
471
+ /** @format uuid */
472
+ id?: string | null;
473
+ street?: string | null;
474
+ unit?: string | null;
475
+ unitType?: string | null;
476
+ city?: string | null;
477
+ state?: string | null;
478
+ county?: string | null;
479
+ postalCode?: string | null;
480
+ }
481
+
239
482
  export interface AdminAccessGetForms {
240
483
  /** @format date-time */
241
484
  createdAt?: string | null;
@@ -600,6 +843,41 @@ export interface ChangePasswordRequest {
600
843
  newPassword: string;
601
844
  }
602
845
 
846
+ export interface ClosedLoansReport {
847
+ /** @format int32 */
848
+ totalClosedPosLoans: number;
849
+ /** @format int32 */
850
+ totalClosedNonPosLoans: number;
851
+ /** @format double */
852
+ totalUtilization: number;
853
+ accounts: ClosedLoansReportAccount[];
854
+ }
855
+
856
+ export interface ClosedLoansReportAccount {
857
+ /** @format uuid */
858
+ id: string;
859
+ name: string;
860
+ /** @format int32 */
861
+ closedPosLoans: number;
862
+ /** @format int32 */
863
+ closedNonPosLoans: number;
864
+ /** @format double */
865
+ utilization: number;
866
+ }
867
+
868
+ export interface ClosedLoansReportRequest {
869
+ /**
870
+ * @format date
871
+ * @minLength 1
872
+ */
873
+ startDate: string;
874
+ /**
875
+ * @format date
876
+ * @minLength 1
877
+ */
878
+ endDate: string;
879
+ }
880
+
603
881
  export interface CommentUserInformation {
604
882
  entityId: string;
605
883
  entityType: string;
@@ -694,7 +972,7 @@ export interface CorporateSearchCriteria {
694
972
  }
695
973
 
696
974
  export interface CreateAccessScopeRequest {
697
- scopeType: CreateAccessScopeRequestScopeTypeEnum;
975
+ scopeType: "User" | "Branch";
698
976
  /** @format uuid */
699
977
  userId?: string | null;
700
978
  /** @format uuid */
@@ -718,7 +996,7 @@ export interface CreateAccountRequest {
718
996
  */
719
997
  nlmsid: number;
720
998
  settings: AccountSettingsRequest;
721
- environment: CreateAccountRequestEnvironmentEnum;
999
+ environment: "Development" | "Staging" | "UAT" | "Production";
722
1000
  losIntegration: LOSIntegration;
723
1001
  }
724
1002
 
@@ -750,7 +1028,19 @@ export interface CreateDocumentTemplateRequest {
750
1028
  export interface CreateGroupMemberRequest {
751
1029
  /** @format uuid */
752
1030
  userId: string;
753
- loanRole: CreateGroupMemberRequestLoanRoleEnum;
1031
+ loanRole:
1032
+ | "Borrower"
1033
+ | "CoBorrower"
1034
+ | "NonBorrower"
1035
+ | "LoanOfficer"
1036
+ | "LoanProcessor"
1037
+ | "LoanOfficerAssistant"
1038
+ | "SupportingLoanOfficer"
1039
+ | "BuyerAgent"
1040
+ | "SellerAgent"
1041
+ | "TitleInsuranceAgent"
1042
+ | "EscrowAgent"
1043
+ | "SettlementAgent";
754
1044
  }
755
1045
 
756
1046
  export interface CreateInviteRequest {
@@ -762,7 +1052,7 @@ export interface CreateInviteRequest {
762
1052
  emailAddress: string;
763
1053
  phoneNumber?: string | null;
764
1054
  /** @deprecated */
765
- relationship: CreateInviteRequestRelationshipEnum;
1055
+ relationship: "NotApplicable" | "Spouse" | "NonSpouse";
766
1056
  loanID: string;
767
1057
  route?: string | null;
768
1058
  /** @format uuid */
@@ -790,7 +1080,21 @@ export interface CreateLoanImportRequest {
790
1080
  * @minLength 1
791
1081
  */
792
1082
  startDate: string;
793
- importMode: CreateLoanImportRequestImportModeEnum;
1083
+ importMode: "All" | "NewOnly" | "UpdateOnly";
1084
+ }
1085
+
1086
+ export interface CreateSession {
1087
+ sessionId: string;
1088
+ sessionUrl: string;
1089
+ /** @format date-time */
1090
+ createdAt: string;
1091
+ /** @format date-time */
1092
+ expiresAt?: string | null;
1093
+ }
1094
+
1095
+ export interface CreateSessionRequest {
1096
+ packageId: string;
1097
+ recipientId: string;
794
1098
  }
795
1099
 
796
1100
  export interface CreateUserDeviceRequest {
@@ -798,7 +1102,19 @@ export interface CreateUserDeviceRequest {
798
1102
  }
799
1103
 
800
1104
  export interface CreateUserDraft {
801
- loanRole: CreateUserDraftLoanRoleEnum;
1105
+ loanRole:
1106
+ | "Borrower"
1107
+ | "CoBorrower"
1108
+ | "NonBorrower"
1109
+ | "LoanOfficer"
1110
+ | "LoanProcessor"
1111
+ | "LoanOfficerAssistant"
1112
+ | "SupportingLoanOfficer"
1113
+ | "BuyerAgent"
1114
+ | "SellerAgent"
1115
+ | "TitleInsuranceAgent"
1116
+ | "EscrowAgent"
1117
+ | "SettlementAgent";
802
1118
  }
803
1119
 
804
1120
  export interface CreateUserGroupRequest {
@@ -981,6 +1297,11 @@ export interface DocumentDataRequest {
981
1297
  systemGenerated: boolean;
982
1298
  }
983
1299
 
1300
+ export interface DocumentSync {
1301
+ /** @format int32 */
1302
+ syncedCount: number;
1303
+ }
1304
+
984
1305
  export interface DocumentTemplate {
985
1306
  /** @format date-time */
986
1307
  createdAt?: string | null;
@@ -1085,7 +1406,7 @@ export interface Draft {
1085
1406
  siteConfiguration: SiteConfigurationReduced;
1086
1407
  /** @format uuid */
1087
1408
  loanID?: string | null;
1088
- type: DraftTypeEnum;
1409
+ type: "NewLoan" | "EditLoan";
1089
1410
  isCoBorrower: boolean;
1090
1411
  }
1091
1412
 
@@ -1104,7 +1425,7 @@ export interface DraftContent {
1104
1425
  siteConfiguration: SiteConfigurationReduced;
1105
1426
  /** @format uuid */
1106
1427
  loanID?: string | null;
1107
- type: DraftContentTypeEnum;
1428
+ type: "NewLoan" | "EditLoan";
1108
1429
  isCoBorrower: boolean;
1109
1430
  applicationPayload: any;
1110
1431
  }
@@ -1190,6 +1511,32 @@ export interface EncompassContact {
1190
1511
  company?: string | null;
1191
1512
  }
1192
1513
 
1514
+ export interface EncompassError {
1515
+ errorCode: string;
1516
+ message: string;
1517
+ details?: string[] | null;
1518
+ }
1519
+
1520
+ export interface EncompassPackageItem {
1521
+ packageId: string;
1522
+ status: string;
1523
+ /** @format date-time */
1524
+ createdAt: string;
1525
+ recipientId: string;
1526
+ }
1527
+
1528
+ export interface EncompassPackageList {
1529
+ packages: EncompassPackageItem[];
1530
+ /** @format int32 */
1531
+ totalCount: number;
1532
+ /** @format int32 */
1533
+ page: number;
1534
+ /** @format int32 */
1535
+ pageSize: number;
1536
+ /** @format int32 */
1537
+ totalPages: number;
1538
+ }
1539
+
1193
1540
  export interface Error {
1194
1541
  message: string;
1195
1542
  }
@@ -1402,7 +1749,20 @@ export interface FusionFieldDisplay {
1402
1749
  }
1403
1750
 
1404
1751
  export interface FusionReportFilter {
1405
- filterType: FusionReportFilterFilterTypeEnum;
1752
+ filterType:
1753
+ | "DateGreaterThanOrEqualTo"
1754
+ | "DateGreaterThan"
1755
+ | "DateLessThan"
1756
+ | "DateLessThanOrEqualTo"
1757
+ | "DateEquals"
1758
+ | "DateDoesntEqual"
1759
+ | "DateNonEmpty"
1760
+ | "DateEmpty"
1761
+ | "StringContains"
1762
+ | "StringEquals"
1763
+ | "StringNotEmpty"
1764
+ | "StringNotEquals"
1765
+ | "StringNotContains";
1406
1766
  targetField: string;
1407
1767
  targetValue: string;
1408
1768
  }
@@ -1522,8 +1882,65 @@ export interface GetWorkflowRequest {
1522
1882
  language?: string | null;
1523
1883
  }
1524
1884
 
1885
+ export interface GuidPatchOperation {
1886
+ op: string;
1887
+ path: string;
1888
+ value?: any;
1889
+ from?: string | null;
1890
+ }
1891
+
1525
1892
  export type IContractResolver = object;
1526
1893
 
1894
+ export interface IPAddress {
1895
+ addressFamily:
1896
+ | "Unspecified"
1897
+ | "Unix"
1898
+ | "InterNetwork"
1899
+ | "ImpLink"
1900
+ | "Pup"
1901
+ | "Chaos"
1902
+ | "NS"
1903
+ | "Ipx"
1904
+ | "Iso"
1905
+ | "Osi"
1906
+ | "Ecma"
1907
+ | "DataKit"
1908
+ | "Ccitt"
1909
+ | "Sna"
1910
+ | "DecNet"
1911
+ | "DataLink"
1912
+ | "Lat"
1913
+ | "HyperChannel"
1914
+ | "AppleTalk"
1915
+ | "NetBios"
1916
+ | "VoiceView"
1917
+ | "FireFox"
1918
+ | "Banyan"
1919
+ | "Atm"
1920
+ | "InterNetworkV6"
1921
+ | "Cluster"
1922
+ | "Ieee12844"
1923
+ | "Irda"
1924
+ | "NetworkDesigners"
1925
+ | "Max"
1926
+ | "Packet"
1927
+ | "ControllerAreaNetwork"
1928
+ | "Unknown";
1929
+ /** @format int64 */
1930
+ scopeId: number;
1931
+ isIPv6Multicast: boolean;
1932
+ isIPv6LinkLocal: boolean;
1933
+ isIPv6SiteLocal: boolean;
1934
+ isIPv6Teredo: boolean;
1935
+ isIPv6UniqueLocal: boolean;
1936
+ isIPv4MappedToIPv6: boolean;
1937
+ /**
1938
+ * @deprecated
1939
+ * @format int64
1940
+ */
1941
+ address: number;
1942
+ }
1943
+
1527
1944
  export interface ImpersonatedDetailedUser {
1528
1945
  /** @format date-time */
1529
1946
  createdAt?: string | null;
@@ -1762,73 +2179,913 @@ export interface Loan {
1762
2179
  contacts: LoanContact[];
1763
2180
  }
1764
2181
 
1765
- export interface LoanComparison {
1766
- loanID: string;
1767
- scenarios: LoanComparisonScenario[];
1768
- loanLocked: boolean;
2182
+ export interface LoanApplication {
2183
+ /** @format uuid */
2184
+ id?: string | null;
2185
+ loanOfficerEmail?: string | null;
2186
+ type?: LoanType | null;
2187
+ purpose?: LoanPurpose | null;
2188
+ lienPosition?: LoanLienPosition | null;
2189
+ number?: string | null;
2190
+ program?: string | null;
2191
+ channel?: string | null;
2192
+ /** @format date-time */
2193
+ startDate?: string | null;
2194
+ property?: LoanProperty | null;
2195
+ financial?: LoanFinancial | null;
2196
+ borrowers: LoanBorrower[];
2197
+ nonOwningBorrowers: LoanNonOwningBorrower[];
1769
2198
  }
1770
2199
 
1771
- export interface LoanComparisonCalculator {
2200
+ export interface LoanApplicationRequest {
2201
+ /** @format uuid */
2202
+ accountID: string;
2203
+ /** @format uuid */
2204
+ userID: string;
2205
+ /** @format uuid */
2206
+ siteConfigurationID: string;
2207
+ loanOfficerEmail?: string | null;
2208
+ purpose?: LoanPurpose | null;
2209
+ referrer?: string | null;
2210
+ companyName?: string | null;
2211
+ property?: LoanPropertyRequest | null;
2212
+ financial?: LoanFinancialRequest | null;
2213
+ /** @minItems 1 */
2214
+ borrowers: LoanBorrowerRequest[];
2215
+ nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2216
+ /** @format uuid */
2217
+ existingLoanId?: string | null;
2218
+ }
2219
+
2220
+ export interface LoanBorrower {
2221
+ /** @format uuid */
2222
+ id?: string | null;
2223
+ ssn?: string | null;
2224
+ email?: string | null;
2225
+ lastName?: string | null;
2226
+ firstName?: string | null;
2227
+ middleName?: string | null;
2228
+ prefix?: LoanNamePrefix | null;
2229
+ suffix?: LoanNameSuffix | null;
2230
+ /** @format date */
2231
+ birthDate?: string | null;
2232
+ citizenship?: LoanCitizenship | null;
2233
+ maritalStatus?: LoanMaritalStatus | null;
2234
+ languagePreference?: LoanLanguagePreference | null;
2235
+ /** @format int32 */
2236
+ numberOfDependents?: number | null;
2237
+ isPrimaryBorrower: boolean;
2238
+ isFirstTimeHomeBuyer?: boolean | null;
2239
+ hasJointAssetsAndLiabilities?: boolean | null;
2240
+ dependentAges?: number[] | null;
2241
+ demographics?: LoanBorrowerDemographics | null;
2242
+ declarations?: LoanBorrowerDeclarations | null;
2243
+ militaryService?: LoanBorrowerMilitaryService | null;
2244
+ gifts: LoanBorrowerGift[];
2245
+ addresses: LoanBorrowerAddress[];
2246
+ consents: LoanBorrowerConsent[];
2247
+ liabilities: LoanBorrowerLiability[];
2248
+ otherAssets: LoanBorrowerOtherAsset[];
2249
+ otherIncome: LoanBorrowerOtherIncome[];
2250
+ phoneNumbers: LoanBorrowerPhoneNumber[];
2251
+ accountAssets: LoanBorrowerAccountAsset[];
2252
+ homeOwnership: LoanBorrowerHomeOwnership[];
2253
+ alternateNames: LoanBorrowerAlternateName[];
2254
+ otherLiabilities: LoanBorrowerOtherLiability[];
2255
+ realEstateAssets: LoanBorrowerRealEstateAsset[];
2256
+ currentEmployment: LoanBorrowerEmploymentCurrent[];
2257
+ previousEmployment: LoanBorrowerEmploymentPrevious[];
2258
+ }
2259
+
2260
+ export interface LoanBorrowerAccountAsset {
2261
+ /** @format uuid */
2262
+ id?: string | null;
2263
+ name?: string | null;
2264
+ accountNumber?: string | null;
2265
+ financialInstitution?: string | null;
1772
2266
  /** @format double */
1773
- loanAmount: number;
1774
- loans: LoanComparisonCalculatorLoan[];
2267
+ value?: number | null;
2268
+ type?: LoanAccountAssetType | null;
1775
2269
  }
1776
2270
 
1777
- export interface LoanComparisonCalculatorLoan {
2271
+ export interface LoanBorrowerAccountAssetRequest {
2272
+ /** @maxLength 255 */
2273
+ financialInstitution?: string | null;
2274
+ /**
2275
+ * @format double
2276
+ * @min 0
2277
+ */
2278
+ value?: number | null;
2279
+ type?: LoanAccountAssetType | null;
2280
+ }
2281
+
2282
+ export interface LoanBorrowerAddress {
2283
+ /** @format uuid */
2284
+ id?: string | null;
2285
+ street?: string | null;
2286
+ unit?: string | null;
2287
+ unitType?: string | null;
2288
+ city?: string | null;
2289
+ state?: string | null;
2290
+ county?: string | null;
2291
+ postalCode?: string | null;
2292
+ housing?: LoanHousingType | null;
1778
2293
  /** @format double */
1779
- points: number;
2294
+ rentAmount?: number | null;
2295
+ isCurrent?: boolean | null;
2296
+ isMailingAddress?: boolean | null;
2297
+ timeAtAddress?: TimeAtAddress | null;
2298
+ }
2299
+
2300
+ export interface LoanBorrowerAddressRequest {
2301
+ /** @maxLength 255 */
2302
+ street?: string | null;
2303
+ /** @maxLength 50 */
2304
+ unit?: string | null;
2305
+ /** @maxLength 50 */
2306
+ unitType?: string | null;
2307
+ /** @maxLength 100 */
2308
+ city?: string | null;
2309
+ state?: string | null;
2310
+ /** @maxLength 100 */
2311
+ county?: string | null;
2312
+ postalCode?: string | null;
2313
+ housing?: LoanHousingType | null;
2314
+ /**
2315
+ * @format double
2316
+ * @min 0
2317
+ */
2318
+ rentAmount?: number | null;
2319
+ isCurrent?: boolean | null;
2320
+ isMailingAddress?: boolean | null;
2321
+ timeAtAddress?: TimeAtAddressRequest | null;
2322
+ }
2323
+
2324
+ export interface LoanBorrowerAlternateName {
2325
+ /** @format uuid */
2326
+ id?: string | null;
2327
+ suffix?: string | null;
2328
+ lastName?: string | null;
2329
+ firstName?: string | null;
2330
+ middleName?: string | null;
2331
+ }
2332
+
2333
+ export interface LoanBorrowerAlternateNameRequest {
2334
+ /** @maxLength 20 */
2335
+ suffix?: string | null;
2336
+ /** @maxLength 100 */
2337
+ lastName?: string | null;
2338
+ /** @maxLength 100 */
2339
+ firstName?: string | null;
2340
+ /** @maxLength 100 */
2341
+ middleName?: string | null;
2342
+ }
2343
+
2344
+ export interface LoanBorrowerBankruptcyChaptersRequest {
2345
+ chapter7?: boolean | null;
2346
+ chapter11?: boolean | null;
2347
+ chapter12?: boolean | null;
2348
+ chapter13?: boolean | null;
2349
+ }
2350
+
2351
+ export interface LoanBorrowerBankruptcyDeclaration {
2352
+ /** @format uuid */
2353
+ id?: string | null;
2354
+ isAffirmative?: boolean | null;
2355
+ description?: string | null;
2356
+ types?: LoanBankruptcyType[] | null;
2357
+ }
2358
+
2359
+ export interface LoanBorrowerBankruptcyDeclarationRequest {
2360
+ isAffirmative?: boolean | null;
2361
+ /** @maxLength 1000 */
2362
+ description?: string | null;
2363
+ chapters?: LoanBorrowerBankruptcyChaptersRequest | null;
2364
+ types?: LoanBankruptcyType[] | null;
2365
+ }
2366
+
2367
+ export interface LoanBorrowerConsent {
2368
+ /** @format uuid */
2369
+ id?: string | null;
2370
+ type?: ConsentType | null;
2371
+ providedConsent?: boolean | null;
2372
+ ipAddress?: string | null;
2373
+ }
2374
+
2375
+ export interface LoanBorrowerConsentRequest {
2376
+ type?: ConsentType | null;
2377
+ providedConsent?: boolean | null;
2378
+ ipAddress?: IPAddress | null;
2379
+ }
2380
+
2381
+ export interface LoanBorrowerDeclarations {
2382
+ /** @format uuid */
2383
+ id?: string | null;
2384
+ borrowingMoney?: LoanBorrowerMoneyDeclaration | null;
2385
+ bankruptcy?: LoanBorrowerBankruptcyDeclaration | null;
2386
+ primaryResidence?: LoanBorrowerPrimaryResidenceDeclaration | null;
2387
+ foreclosure?: LoanBorrowerSimpleDeclaration | null;
2388
+ coSignerOnDebt?: LoanBorrowerSimpleDeclaration | null;
2389
+ partyToLawsuit?: LoanBorrowerSimpleDeclaration | null;
2390
+ outstandingJudgments?: LoanBorrowerSimpleDeclaration | null;
2391
+ applyingForNewCredit?: LoanBorrowerSimpleDeclaration | null;
2392
+ subjectToLienPriority?: LoanBorrowerSimpleDeclaration | null;
2393
+ inDelinquencyOrDefault?: LoanBorrowerSimpleDeclaration | null;
2394
+ relationshipWithSeller?: LoanBorrowerSimpleDeclaration | null;
2395
+ preForeclosureOrShortSale?: LoanBorrowerSimpleDeclaration | null;
2396
+ applyingForAnotherMortgage?: LoanBorrowerSimpleDeclaration | null;
2397
+ conveyedTitleToPropertyForeclosure?: LoanBorrowerSimpleDeclaration | null;
2398
+ }
2399
+
2400
+ export interface LoanBorrowerDeclarationsRequest {
2401
+ borrowingMoney?: LoanBorrowerMoneyDeclarationRequest | null;
2402
+ bankruptcy?: LoanBorrowerBankruptcyDeclarationRequest | null;
2403
+ primaryResidence?: LoanBorrowerPrimaryResidenceDeclarationRequest | null;
2404
+ foreclosure?: LoanBorrowerSimpleDeclarationRequest | null;
2405
+ coSignerOnDebt?: LoanBorrowerSimpleDeclarationRequest | null;
2406
+ partyToLawsuit?: LoanBorrowerSimpleDeclarationRequest | null;
2407
+ outstandingJudgments?: LoanBorrowerSimpleDeclarationRequest | null;
2408
+ applyingForNewCredit?: LoanBorrowerSimpleDeclarationRequest | null;
2409
+ subjectToLienPriority?: LoanBorrowerSimpleDeclarationRequest | null;
2410
+ inDelinquencyOrDefault?: LoanBorrowerSimpleDeclarationRequest | null;
2411
+ relationshipWithSeller?: LoanBorrowerSimpleDeclarationRequest | null;
2412
+ preForeclosureOrShortSale?: LoanBorrowerSimpleDeclarationRequest | null;
2413
+ applyingForAnotherMortgage?: LoanBorrowerSimpleDeclarationRequest | null;
2414
+ conveyedTitleToPropertyForeclosure?: LoanBorrowerSimpleDeclarationRequest | null;
2415
+ }
2416
+
2417
+ export interface LoanBorrowerDemographics {
2418
+ /** @format uuid */
2419
+ id?: string | null;
2420
+ race?: LoanBorrowerDemographicsRace | null;
2421
+ gender?: LoanBorrowerDemographicsGender | null;
2422
+ ethnicity?: LoanBorrowerDemographicsEthnicity | null;
2423
+ }
2424
+
2425
+ export interface LoanBorrowerDemographicsEthnicity {
2426
+ /** @format uuid */
2427
+ id?: string | null;
2428
+ isDeclined?: boolean | null;
2429
+ isHispanicOrLatino?: boolean | null;
2430
+ otherHispanicOrLatino?: string | null;
2431
+ hispanicOrLatinoEthnicities?: LoanHispanicEthnicity[] | null;
2432
+ }
2433
+
2434
+ export interface LoanBorrowerDemographicsEthnicityRequest {
2435
+ OptOut?: boolean | null;
2436
+ Hispanic?: boolean | null;
2437
+ /** @maxLength 255 */
2438
+ OtherHispanic?: string | null;
2439
+ Mexican?: boolean | null;
2440
+ PuertoRican?: boolean | null;
2441
+ Cuban?: boolean | null;
2442
+ NotHispanic?: boolean | null;
2443
+ hispanicOrLatinoEthnicities?: LoanHispanicEthnicity[] | null;
2444
+ }
2445
+
2446
+ export interface LoanBorrowerDemographicsGender {
2447
+ /** @format uuid */
2448
+ id?: string | null;
2449
+ isDeclined?: boolean | null;
2450
+ gender?: LoanGenderType | null;
2451
+ }
2452
+
2453
+ export interface LoanBorrowerDemographicsGenderRequest {
2454
+ Male?: boolean | null;
2455
+ Female?: boolean | null;
2456
+ OptOut?: boolean | null;
2457
+ gender?: LoanGenderType | null;
2458
+ }
2459
+
2460
+ export interface LoanBorrowerDemographicsRace {
2461
+ /** @format uuid */
2462
+ id?: string | null;
2463
+ isAmericanIndianOrAlaskanNative?: boolean | null;
2464
+ otherAmericanIndianOrAlaskanNative?: string | null;
2465
+ isAsian?: boolean | null;
2466
+ asianRaces?: LoanAsianRace[] | null;
2467
+ otherAsianRace?: string | null;
2468
+ isBlackOrAfrican?: boolean | null;
2469
+ isPacificIslander?: boolean | null;
2470
+ pacificIslanderRace?: LoanPacificIslanderRace[] | null;
2471
+ otherPacificIslanderRace?: string | null;
2472
+ isWhite?: boolean | null;
2473
+ isDeclined?: boolean | null;
2474
+ }
2475
+
2476
+ export interface LoanBorrowerDemographicsRaceRequest {
2477
+ AmericanIndian?: boolean | null;
2478
+ /** @maxLength 255 */
2479
+ TribeName?: string | null;
2480
+ Asian?: boolean | null;
2481
+ AsianIndian?: boolean | null;
2482
+ Chinese?: boolean | null;
2483
+ Filipino?: boolean | null;
2484
+ Japanese?: boolean | null;
2485
+ Korean?: boolean | null;
2486
+ Vietnamese?: boolean | null;
2487
+ /** @maxLength 255 */
2488
+ OtherAsian?: string | null;
2489
+ Black?: boolean | null;
2490
+ NativeIslander?: boolean | null;
2491
+ NativeHawaiian?: boolean | null;
2492
+ Guamanian?: boolean | null;
2493
+ Samoan?: boolean | null;
2494
+ /** @maxLength 255 */
2495
+ OtherNativeIslander?: string | null;
2496
+ White?: boolean | null;
2497
+ OptOut?: boolean | null;
2498
+ asianRaces?: LoanAsianRace[] | null;
2499
+ pacificIslanderRace?: LoanPacificIslanderRace[] | null;
2500
+ }
2501
+
2502
+ export interface LoanBorrowerDemographicsRequest {
2503
+ race?: LoanBorrowerDemographicsRaceRequest | null;
2504
+ gender?: LoanBorrowerDemographicsGenderRequest | null;
2505
+ ethnicity?: LoanBorrowerDemographicsEthnicityRequest | null;
2506
+ }
2507
+
2508
+ export interface LoanBorrowerEmploymentCurrent {
2509
+ /** @format uuid */
2510
+ id?: string | null;
2511
+ name?: string | null;
2512
+ title?: string | null;
2513
+ phoneNumber?: string | null;
2514
+ /** @format date */
2515
+ startDate?: string | null;
2516
+ isSelfEmployed?: boolean | null;
2517
+ isEmployedByPartyInTransaction?: boolean | null;
2518
+ address?: AddressV3 | null;
2519
+ ownership?: LoanBorrowerEmploymentCurrentOwnership | null;
2520
+ grossIncome?: LoanBorrowerEmploymentCurrentGrossIncome | null;
2521
+ timeInLineOfWork?: LoanBorrowerEmploymentCurrentTimeInLineOfWork | null;
2522
+ }
2523
+
2524
+ export interface LoanBorrowerEmploymentCurrentGrossIncome {
2525
+ /** @format uuid */
2526
+ id?: string | null;
1780
2527
  /** @format double */
1781
- originationFees: number;
2528
+ base?: number | null;
1782
2529
  /** @format double */
1783
- closingCosts: number;
2530
+ other?: number | null;
1784
2531
  /** @format double */
1785
- totalClosingCosts: number;
2532
+ bonus?: number | null;
1786
2533
  /** @format double */
1787
- monthlyPrincipalAndInterest: number;
1788
- amortization: Amortization;
2534
+ overtime?: number | null;
2535
+ /** @format double */
2536
+ commission?: number | null;
2537
+ /** @format double */
2538
+ militaryEntitlements?: number | null;
1789
2539
  }
1790
2540
 
1791
- export interface LoanComparisonCalculatorLoanRequest {
2541
+ export interface LoanBorrowerEmploymentCurrentGrossIncomeRequest {
1792
2542
  /**
1793
2543
  * @format double
1794
- * @min 1
1795
- * @max 25
1796
- */
1797
- interestRate: number;
1798
- /**
1799
- * @format int32
1800
- * @min 1
1801
- * @max 40
2544
+ * @min 0
1802
2545
  */
1803
- term: number;
2546
+ base?: number | null;
2547
+ /** @format double */
2548
+ hourlyRate?: number | null;
2549
+ /** @format int32 */
2550
+ hoursPerWeek?: number | null;
2551
+ /** @format double */
2552
+ distributions?: number | null;
1804
2553
  /**
1805
2554
  * @format double
1806
2555
  * @min 0
1807
- * @max 3
1808
2556
  */
1809
- points: number;
2557
+ other?: number | null;
1810
2558
  /**
1811
2559
  * @format double
1812
2560
  * @min 0
1813
- * @max 5
1814
2561
  */
1815
- originationFees: number;
2562
+ bonus?: number | null;
1816
2563
  /**
1817
2564
  * @format double
1818
- * @min 500
1819
- * @max 100000
2565
+ * @min 0
1820
2566
  */
1821
- closingCosts: number;
2567
+ overtime?: number | null;
1822
2568
  /**
1823
2569
  * @format double
1824
- * @min 25000
1825
- * @max 10000000
2570
+ * @min 0
1826
2571
  */
1827
- homeValue: number;
2572
+ commission?: number | null;
1828
2573
  /**
1829
2574
  * @format double
1830
2575
  * @min 0
1831
- * @max 10
2576
+ */
2577
+ militaryEntitlements?: number | null;
2578
+ }
2579
+
2580
+ export interface LoanBorrowerEmploymentCurrentOwnership {
2581
+ /** @format uuid */
2582
+ id?: string | null;
2583
+ isOwner?: boolean | null;
2584
+ hasOwnershipOver25Percent?: boolean | null;
2585
+ /** @format double */
2586
+ monthlyIncome?: number | null;
2587
+ }
2588
+
2589
+ export interface LoanBorrowerEmploymentCurrentOwnershipRequest {
2590
+ isOwner?: boolean | null;
2591
+ hasOwnershipOver25Percent?: boolean | null;
2592
+ /**
2593
+ * @format double
2594
+ * @min 0
2595
+ */
2596
+ monthlyIncome?: number | null;
2597
+ }
2598
+
2599
+ export interface LoanBorrowerEmploymentCurrentRequest {
2600
+ /** @maxLength 255 */
2601
+ name?: string | null;
2602
+ /** @maxLength 100 */
2603
+ title?: string | null;
2604
+ phoneNumber?: string | null;
2605
+ /** @format date */
2606
+ startDate?: string | null;
2607
+ isSelfEmployed?: boolean | null;
2608
+ isEmployedByPartyInTransaction?: boolean | null;
2609
+ address?: AddressRequest | null;
2610
+ ownership?: LoanBorrowerEmploymentCurrentOwnershipRequest | null;
2611
+ grossIncome?: LoanBorrowerEmploymentCurrentGrossIncomeRequest | null;
2612
+ timeInLineOfWork?: LoanBorrowerEmploymentCurrentTimeInLineOfWorkRequest | null;
2613
+ }
2614
+
2615
+ export interface LoanBorrowerEmploymentCurrentTimeInLineOfWork {
2616
+ /** @format uuid */
2617
+ id?: string | null;
2618
+ /** @format int32 */
2619
+ years?: number | null;
2620
+ /** @format int32 */
2621
+ months?: number | null;
2622
+ }
2623
+
2624
+ export interface LoanBorrowerEmploymentCurrentTimeInLineOfWorkRequest {
2625
+ /** @format int32 */
2626
+ years?: number | null;
2627
+ /** @format int32 */
2628
+ months?: number | null;
2629
+ }
2630
+
2631
+ export interface LoanBorrowerEmploymentPrevious {
2632
+ /** @format uuid */
2633
+ id?: string | null;
2634
+ name?: string | null;
2635
+ title?: string | null;
2636
+ phoneNumber?: string | null;
2637
+ /** @format date */
2638
+ startDate?: string | null;
2639
+ /** @format date */
2640
+ endDate?: string | null;
2641
+ /** @format double */
2642
+ grossIncome?: number | null;
2643
+ isSelfEmployed?: boolean | null;
2644
+ address?: AddressV3 | null;
2645
+ }
2646
+
2647
+ export interface LoanBorrowerEmploymentPreviousRequest {
2648
+ /** @maxLength 255 */
2649
+ name?: string | null;
2650
+ /** @maxLength 100 */
2651
+ title?: string | null;
2652
+ phoneNumber?: string | null;
2653
+ /** @format date */
2654
+ startDate?: string | null;
2655
+ /** @format date */
2656
+ endDate?: string | null;
2657
+ /**
2658
+ * @format double
2659
+ * @min 0
2660
+ */
2661
+ grossIncome?: number | null;
2662
+ isSelfEmployed?: boolean | null;
2663
+ address?: AddressRequest | null;
2664
+ }
2665
+
2666
+ export interface LoanBorrowerGift {
2667
+ /** @format uuid */
2668
+ id?: string | null;
2669
+ /** @format double */
2670
+ value?: number | null;
2671
+ isDeposited?: boolean | null;
2672
+ source?: LoanGiftSource | null;
2673
+ assetType?: LoanGiftAssetType | null;
2674
+ }
2675
+
2676
+ export interface LoanBorrowerGiftRequest {
2677
+ /**
2678
+ * @format double
2679
+ * @min 0
2680
+ */
2681
+ value?: number | null;
2682
+ isDeposited?: boolean | null;
2683
+ source?: LoanGiftSource | null;
2684
+ assetType?: LoanGiftAssetType | null;
2685
+ }
2686
+
2687
+ export interface LoanBorrowerHomeOwnership {
2688
+ /** @format uuid */
2689
+ id?: string | null;
2690
+ /** @format date */
2691
+ dateCompleted?: string | null;
2692
+ type?: LoanHomeOwnershipType | null;
2693
+ format?: LoanHomeOwnershipFormat | null;
2694
+ provider?: LoanBorrowerHomeOwnershipProvider | null;
2695
+ }
2696
+
2697
+ export interface LoanBorrowerHomeOwnershipProvider {
2698
+ /** @format uuid */
2699
+ id?: string | null;
2700
+ name?: string | null;
2701
+ phoneNumber?: string | null;
2702
+ address?: AddressV3 | null;
2703
+ }
2704
+
2705
+ export interface LoanBorrowerHomeOwnershipProviderRequest {
2706
+ /** @maxLength 255 */
2707
+ name?: string | null;
2708
+ phoneNumber?: string | null;
2709
+ address?: AddressRequest | null;
2710
+ }
2711
+
2712
+ export interface LoanBorrowerHomeOwnershipRequest {
2713
+ /** @format date */
2714
+ dateCompleted?: string | null;
2715
+ type?: LoanHomeOwnershipType | null;
2716
+ format?: LoanHomeOwnershipFormat | null;
2717
+ provider?: LoanBorrowerHomeOwnershipProviderRequest | null;
2718
+ }
2719
+
2720
+ export interface LoanBorrowerLiability {
2721
+ /** @format uuid */
2722
+ id?: string | null;
2723
+ type?: LoanLiabilityType | null;
2724
+ name?: string | null;
2725
+ accountNumber?: string | null;
2726
+ financialInstitution?: string | null;
2727
+ /** @format double */
2728
+ balance?: number | null;
2729
+ /** @format double */
2730
+ monthlyPayment?: number | null;
2731
+ /** @format int32 */
2732
+ monthsLeftToPay?: number | null;
2733
+ isPaidOffBeforeClosing?: boolean | null;
2734
+ }
2735
+
2736
+ export interface LoanBorrowerLiabilityRequest {
2737
+ type?: LoanLiabilityType | null;
2738
+ /** @maxLength 255 */
2739
+ name?: string | null;
2740
+ /** @maxLength 50 */
2741
+ accountNumber?: string | null;
2742
+ /** @maxLength 255 */
2743
+ financialInstitution?: string | null;
2744
+ /**
2745
+ * @format double
2746
+ * @min 0
2747
+ */
2748
+ balance?: number | null;
2749
+ /**
2750
+ * @format double
2751
+ * @min 0
2752
+ */
2753
+ monthlyPayment?: number | null;
2754
+ /**
2755
+ * @format int32
2756
+ * @min 0
2757
+ */
2758
+ monthsLeftToPay?: number | null;
2759
+ isPaidOffBeforeClosing?: boolean | null;
2760
+ }
2761
+
2762
+ export interface LoanBorrowerMilitaryService {
2763
+ /** @format uuid */
2764
+ id?: string | null;
2765
+ hasServed?: boolean | null;
2766
+ /** @format date */
2767
+ endDate?: string | null;
2768
+ type?: LoanMilitaryServiceType | null;
2769
+ }
2770
+
2771
+ export interface LoanBorrowerMilitaryServiceRequest {
2772
+ hasServed?: boolean | null;
2773
+ /** @format date */
2774
+ endDate?: string | null;
2775
+ type?: LoanMilitaryServiceType | null;
2776
+ }
2777
+
2778
+ export interface LoanBorrowerMoneyDeclaration {
2779
+ /** @format uuid */
2780
+ id?: string | null;
2781
+ isAffirmative?: boolean | null;
2782
+ description?: string | null;
2783
+ /** @format double */
2784
+ amount?: number | null;
2785
+ }
2786
+
2787
+ export interface LoanBorrowerMoneyDeclarationRequest {
2788
+ isAffirmative?: boolean | null;
2789
+ /** @maxLength 1000 */
2790
+ description?: string | null;
2791
+ /**
2792
+ * @format double
2793
+ * @min 0
2794
+ */
2795
+ amount?: number | null;
2796
+ }
2797
+
2798
+ export interface LoanBorrowerOtherAsset {
2799
+ /** @format uuid */
2800
+ id?: string | null;
2801
+ type?: LoanOtherAssetType | null;
2802
+ other?: string | null;
2803
+ /** @format double */
2804
+ value?: number | null;
2805
+ }
2806
+
2807
+ export interface LoanBorrowerOtherAssetRequest {
2808
+ type?: LoanOtherAssetType | null;
2809
+ /** @maxLength 255 */
2810
+ other?: string | null;
2811
+ /**
2812
+ * @format double
2813
+ * @min 0
2814
+ */
2815
+ value?: number | null;
2816
+ }
2817
+
2818
+ export interface LoanBorrowerOtherIncome {
2819
+ /** @format uuid */
2820
+ id?: string | null;
2821
+ /** @format double */
2822
+ value?: number | null;
2823
+ type?: LoanOtherIncomeType | null;
2824
+ }
2825
+
2826
+ export interface LoanBorrowerOtherIncomeRequest {
2827
+ /**
2828
+ * @format double
2829
+ * @min 0
2830
+ */
2831
+ value?: number | null;
2832
+ type?: LoanOtherIncomeType | null;
2833
+ }
2834
+
2835
+ export interface LoanBorrowerOtherLiability {
2836
+ /** @format uuid */
2837
+ id?: string | null;
2838
+ /** @format double */
2839
+ monthlyPayment?: number | null;
2840
+ type?: LoanOtherLiabilityType | null;
2841
+ }
2842
+
2843
+ export interface LoanBorrowerOtherLiabilityRequest {
2844
+ /**
2845
+ * @format double
2846
+ * @min 0
2847
+ */
2848
+ monthlyPayment?: number | null;
2849
+ type?: LoanOtherLiabilityType | null;
2850
+ }
2851
+
2852
+ export interface LoanBorrowerPhoneNumber {
2853
+ /** @format uuid */
2854
+ id?: string | null;
2855
+ ext?: string | null;
2856
+ number?: string | null;
2857
+ type?: LoanPhoneNumberType | null;
2858
+ }
2859
+
2860
+ export interface LoanBorrowerPhoneNumberRequest {
2861
+ /** @maxLength 10 */
2862
+ ext?: string | null;
2863
+ number?: string | null;
2864
+ type?: LoanPhoneNumberType | null;
2865
+ }
2866
+
2867
+ export interface LoanBorrowerPrimaryResidenceDeclaration {
2868
+ /** @format uuid */
2869
+ id?: string | null;
2870
+ isAffirmative?: boolean | null;
2871
+ description?: string | null;
2872
+ hasInterestInLastThreeYears?: boolean | null;
2873
+ titleHeld?: LoanTitleHeld | null;
2874
+ propertyType?: LoanOccupancyType | null;
2875
+ }
2876
+
2877
+ export interface LoanBorrowerPrimaryResidenceDeclarationRequest {
2878
+ isAffirmative?: boolean | null;
2879
+ /** @maxLength 1000 */
2880
+ description?: string | null;
2881
+ hasInterestInLastThreeYears?: boolean | null;
2882
+ titleHeld?: LoanTitleHeld | null;
2883
+ propertyType?: LoanOwnershipInterestPropertyType | null;
2884
+ }
2885
+
2886
+ export interface LoanBorrowerRealEstateAsset {
2887
+ /** @format uuid */
2888
+ id?: string | null;
2889
+ status?: LoanRealEstateStatus | null;
2890
+ occupancy?: LoanOccupancyType | null;
2891
+ /** @format double */
2892
+ marketValue?: number | null;
2893
+ /** @format double */
2894
+ monthlyInsTaxDues?: number | null;
2895
+ /** @format double */
2896
+ monthlyRentalIncome?: number | null;
2897
+ address?: AddressV3 | null;
2898
+ mortgages?: LoanBorrowerRealEstateAssetMortgage[] | null;
2899
+ }
2900
+
2901
+ export interface LoanBorrowerRealEstateAssetMortgage {
2902
+ /** @format uuid */
2903
+ id?: string | null;
2904
+ creditor?: string | null;
2905
+ accountNumber?: string | null;
2906
+ /** @format double */
2907
+ balance?: number | null;
2908
+ /** @format double */
2909
+ creditLimit?: number | null;
2910
+ /** @format double */
2911
+ monthlyMortgagePayment?: number | null;
2912
+ isBalancePaidBeforeClosing?: boolean | null;
2913
+ loanType?: LoanType | null;
2914
+ }
2915
+
2916
+ export interface LoanBorrowerRealEstateAssetMortgageRequest {
2917
+ /** @maxLength 255 */
2918
+ creditor?: string | null;
2919
+ /** @maxLength 50 */
2920
+ accountNumber?: string | null;
2921
+ /**
2922
+ * @format double
2923
+ * @min 0
2924
+ */
2925
+ balance?: number | null;
2926
+ /**
2927
+ * @format double
2928
+ * @min 0
2929
+ */
2930
+ creditLimit?: number | null;
2931
+ /**
2932
+ * @format double
2933
+ * @min 0
2934
+ */
2935
+ monthlyMortgagePayment?: number | null;
2936
+ isBalancePaidBeforeClosing?: boolean | null;
2937
+ loanType?: LoanType | null;
2938
+ }
2939
+
2940
+ export interface LoanBorrowerRealEstateAssetRequest {
2941
+ status?: LoanRealEstateStatus | null;
2942
+ occupancy?: LoanOccupancyType | null;
2943
+ /**
2944
+ * @format double
2945
+ * @min 0
2946
+ */
2947
+ marketValue?: number | null;
2948
+ /** @format double */
2949
+ purchasePrice?: number | null;
2950
+ /** @format int32 */
2951
+ yearBuilt?: number | null;
2952
+ /** @format int32 */
2953
+ numberOfUnits?: number | null;
2954
+ /**
2955
+ * @format double
2956
+ * @min 0
2957
+ */
2958
+ monthlyRentalIncome?: number | null;
2959
+ /**
2960
+ * @format double
2961
+ * @min 0
2962
+ */
2963
+ maintenanceExpense?: number | null;
2964
+ address?: AddressRequest | null;
2965
+ mortgages?: LoanBorrowerRealEstateAssetMortgageRequest[] | null;
2966
+ }
2967
+
2968
+ export interface LoanBorrowerRequest {
2969
+ ssn?: string | null;
2970
+ email?: string | null;
2971
+ /** @maxLength 100 */
2972
+ lastName?: string | null;
2973
+ /** @maxLength 100 */
2974
+ firstName?: string | null;
2975
+ /** @maxLength 100 */
2976
+ middleName?: string | null;
2977
+ prefix?: LoanNamePrefix | null;
2978
+ suffix?: LoanNameSuffix | null;
2979
+ /** @format date */
2980
+ birthDate?: string | null;
2981
+ citizenship?: LoanCitizenship | null;
2982
+ maritalStatus?: LoanMaritalStatus | null;
2983
+ languagePreference?: LoanLanguagePreference | null;
2984
+ /** @format int32 */
2985
+ numberOfDependents?: number | null;
2986
+ isPrimaryBorrower: boolean;
2987
+ isFirstTimeHomeBuyer?: boolean | null;
2988
+ hasJointAssetsAndLiabilities?: boolean | null;
2989
+ dependentAges?: number[] | null;
2990
+ demographics?: LoanBorrowerDemographicsRequest | null;
2991
+ declarations?: LoanBorrowerDeclarationsRequest | null;
2992
+ militaryService?: LoanBorrowerMilitaryServiceRequest | null;
2993
+ gifts: LoanBorrowerGiftRequest[];
2994
+ addresses: LoanBorrowerAddressRequest[];
2995
+ consents: LoanBorrowerConsentRequest[];
2996
+ liabilities: LoanBorrowerLiabilityRequest[];
2997
+ otherAssets: LoanBorrowerOtherAssetRequest[];
2998
+ otherIncome: LoanBorrowerOtherIncomeRequest[];
2999
+ phoneNumbers: LoanBorrowerPhoneNumberRequest[];
3000
+ accountAssets: LoanBorrowerAccountAssetRequest[];
3001
+ homeOwnership: LoanBorrowerHomeOwnershipRequest[];
3002
+ alternateNames: LoanBorrowerAlternateNameRequest[];
3003
+ otherLiabilities: LoanBorrowerOtherLiabilityRequest[];
3004
+ realEstateAssets: LoanBorrowerRealEstateAssetRequest[];
3005
+ currentEmployment: LoanBorrowerEmploymentCurrentRequest[];
3006
+ previousEmployment: LoanBorrowerEmploymentPreviousRequest[];
3007
+ }
3008
+
3009
+ export interface LoanBorrowerSimpleDeclaration {
3010
+ /** @format uuid */
3011
+ id?: string | null;
3012
+ isAffirmative?: boolean | null;
3013
+ description?: string | null;
3014
+ }
3015
+
3016
+ export interface LoanBorrowerSimpleDeclarationRequest {
3017
+ isAffirmative?: boolean | null;
3018
+ /** @maxLength 1000 */
3019
+ description?: string | null;
3020
+ }
3021
+
3022
+ export interface LoanComparison {
3023
+ loanID: string;
3024
+ scenarios: LoanComparisonScenario[];
3025
+ loanLocked: boolean;
3026
+ }
3027
+
3028
+ export interface LoanComparisonCalculator {
3029
+ /** @format double */
3030
+ loanAmount: number;
3031
+ loans: LoanComparisonCalculatorLoan[];
3032
+ }
3033
+
3034
+ export interface LoanComparisonCalculatorLoan {
3035
+ /** @format double */
3036
+ points: number;
3037
+ /** @format double */
3038
+ originationFees: number;
3039
+ /** @format double */
3040
+ closingCosts: number;
3041
+ /** @format double */
3042
+ totalClosingCosts: number;
3043
+ /** @format double */
3044
+ monthlyPrincipalAndInterest: number;
3045
+ amortization: Amortization;
3046
+ }
3047
+
3048
+ export interface LoanComparisonCalculatorLoanRequest {
3049
+ /**
3050
+ * @format double
3051
+ * @min 1
3052
+ * @max 25
3053
+ */
3054
+ interestRate: number;
3055
+ /**
3056
+ * @format int32
3057
+ * @min 1
3058
+ * @max 40
3059
+ */
3060
+ term: number;
3061
+ /**
3062
+ * @format double
3063
+ * @min 0
3064
+ * @max 3
3065
+ */
3066
+ points: number;
3067
+ /**
3068
+ * @format double
3069
+ * @min 0
3070
+ * @max 5
3071
+ */
3072
+ originationFees: number;
3073
+ /**
3074
+ * @format double
3075
+ * @min 500
3076
+ * @max 100000
3077
+ */
3078
+ closingCosts: number;
3079
+ /**
3080
+ * @format double
3081
+ * @min 25000
3082
+ * @max 10000000
3083
+ */
3084
+ homeValue: number;
3085
+ /**
3086
+ * @format double
3087
+ * @min 0
3088
+ * @max 10
1832
3089
  */
1833
3090
  pmi: number;
1834
3091
  }
@@ -1899,7 +3156,19 @@ export interface LoanContact {
1899
3156
  email?: string | null;
1900
3157
  phone?: string | null;
1901
3158
  companyName?: string | null;
1902
- role: LoanContactRoleEnum;
3159
+ role:
3160
+ | "Borrower"
3161
+ | "CoBorrower"
3162
+ | "NonBorrower"
3163
+ | "LoanOfficer"
3164
+ | "LoanProcessor"
3165
+ | "LoanOfficerAssistant"
3166
+ | "SupportingLoanOfficer"
3167
+ | "BuyerAgent"
3168
+ | "SellerAgent"
3169
+ | "TitleInsuranceAgent"
3170
+ | "EscrowAgent"
3171
+ | "SettlementAgent";
1903
3172
  }
1904
3173
 
1905
3174
  export interface LoanContactList {
@@ -1975,6 +3244,42 @@ export interface LoanDraftSearchCriteria {
1975
3244
  draftTypes?: DraftType[] | null;
1976
3245
  }
1977
3246
 
3247
+ export interface LoanFinancial {
3248
+ /** @format uuid */
3249
+ id?: string | null;
3250
+ isDebtsAssetsReviewed?: boolean | null;
3251
+ /** @format double */
3252
+ cashToClose?: number | null;
3253
+ /** @format double */
3254
+ cashDownPayment?: number | null;
3255
+ /** @format double */
3256
+ maximumPurchasePrice?: number | null;
3257
+ }
3258
+
3259
+ export interface LoanFinancialRequest {
3260
+ isDebtsAssetsReviewed?: boolean | null;
3261
+ /**
3262
+ * @format double
3263
+ * @min 0
3264
+ */
3265
+ cashToClose?: number | null;
3266
+ /**
3267
+ * @format double
3268
+ * @min 0
3269
+ */
3270
+ cashDownPayment?: number | null;
3271
+ /**
3272
+ * @format double
3273
+ * @min 0
3274
+ */
3275
+ maximumPurchasePrice?: number | null;
3276
+ isDownPaymentGift?: boolean | null;
3277
+ /** @format double */
3278
+ downPaymentGiftAmount?: number | null;
3279
+ /** @format int32 */
3280
+ loanTermYears?: number | null;
3281
+ }
3282
+
1978
3283
  export interface LoanIdentifier {
1979
3284
  /** @format uuid */
1980
3285
  id: string;
@@ -1994,14 +3299,19 @@ export interface LoanImport {
1994
3299
  /** @format int32 */
1995
3300
  importedCount: number;
1996
3301
  statusMessage?: string | null;
1997
- status: LoanImportStatusEnum;
1998
- importMode: LoanImportImportModeEnum;
3302
+ status:
3303
+ | "WaitingProcess"
3304
+ | "InProgress"
3305
+ | "Completed"
3306
+ | "Failed"
3307
+ | "Cancelled";
3308
+ importMode: "All" | "NewOnly" | "UpdateOnly";
1999
3309
  /** @format date-time */
2000
3310
  createdAt?: string | null;
2001
3311
  }
2002
3312
 
2003
3313
  export interface LoanImportLog {
2004
- level: LoanImportLogLevelEnum;
3314
+ level: "None" | "Info" | "Warning" | "Error";
2005
3315
  message: string;
2006
3316
  /** @format date-time */
2007
3317
  createdAt: string;
@@ -2047,11 +3357,60 @@ export interface LoanListPaginated {
2047
3357
  count: number;
2048
3358
  }
2049
3359
 
3360
+ export interface LoanListV3 {
3361
+ /** @format uuid */
3362
+ id: string;
3363
+ status?: string | null;
3364
+ number?: string | null;
3365
+ type?: LoanType | null;
3366
+ purpose?: LoanPurpose | null;
3367
+ /** @format double */
3368
+ totalLoanAmount?: number | null;
3369
+ /** @format date-time */
3370
+ startDate?: string | null;
3371
+ isActive: boolean;
3372
+ propertyAddress?: Address | null;
3373
+ loanOfficer?: LoanListV3LoanOfficer | null;
3374
+ borrowers: LoanListV3Borrower[];
3375
+ }
3376
+
3377
+ export interface LoanListV3Borrower {
3378
+ /** @format uuid */
3379
+ id: string;
3380
+ firstName?: string | null;
3381
+ lastName?: string | null;
3382
+ email?: string | null;
3383
+ isPrimaryBorrower: boolean;
3384
+ }
3385
+
3386
+ export interface LoanListV3LoanOfficer {
3387
+ name?: string | null;
3388
+ }
3389
+
3390
+ export interface LoanListV3Paginated {
3391
+ rows: LoanListV3[];
3392
+ pagination: Pagination;
3393
+ /** @format int64 */
3394
+ count: number;
3395
+ }
3396
+
2050
3397
  export interface LoanLog {
2051
3398
  /** @format uuid */
2052
3399
  id: string;
2053
- level: LoanLogLevelEnum;
2054
- type: LoanLogTypeEnum;
3400
+ level: "None" | "Info" | "Warning" | "Error";
3401
+ type:
3402
+ | "Loan"
3403
+ | "Queue"
3404
+ | "POSFlagChanged"
3405
+ | "Verification"
3406
+ | "DocumentUploaded"
3407
+ | "LoanCreated"
3408
+ | "WorkflowSubmitted"
3409
+ | "UserInvitationSent"
3410
+ | "CoBorrowerAdded"
3411
+ | "TaskCompleted"
3412
+ | "LoanStatusChanged"
3413
+ | "EConsent";
2055
3414
  message: string;
2056
3415
  /** @format date-time */
2057
3416
  createdAt: string;
@@ -2070,6 +3429,31 @@ export interface LoanLogSearchCriteria {
2070
3429
  levels?: LogLevel[] | null;
2071
3430
  }
2072
3431
 
3432
+ export interface LoanNonOwningBorrower {
3433
+ /** @format uuid */
3434
+ id?: string | null;
3435
+ email?: string | null;
3436
+ lastName?: string | null;
3437
+ firstName?: string | null;
3438
+ middleName?: string | null;
3439
+ prefix?: LoanNamePrefix | null;
3440
+ suffix?: LoanNameSuffix | null;
3441
+ consents: LoanBorrowerConsent[];
3442
+ }
3443
+
3444
+ export interface LoanNonOwningBorrowerRequest {
3445
+ email?: string | null;
3446
+ /** @maxLength 100 */
3447
+ lastName?: string | null;
3448
+ /** @maxLength 100 */
3449
+ firstName?: string | null;
3450
+ /** @maxLength 100 */
3451
+ middleName?: string | null;
3452
+ prefix?: LoanNamePrefix | null;
3453
+ suffix?: LoanNameSuffix | null;
3454
+ consents: LoanBorrowerConsentRequest[];
3455
+ }
3456
+
2073
3457
  export interface LoanOfficer {
2074
3458
  /** @format uuid */
2075
3459
  id: string;
@@ -2105,6 +3489,126 @@ export interface LoanOfficerSearchCriteria {
2105
3489
  brand?: string | null;
2106
3490
  }
2107
3491
 
3492
+ export interface LoanPatchRequestGuidPatchDocument {
3493
+ operations: GuidPatchOperation[];
3494
+ }
3495
+
3496
+ export interface LoanProperty {
3497
+ /** @format uuid */
3498
+ id?: string | null;
3499
+ trustType?: LoanTrustType | null;
3500
+ occupancy?: LoanOccupancyType | null;
3501
+ propertyType?: LoanPropertyType | null;
3502
+ referenceId?: string | null;
3503
+ /** @format int32 */
3504
+ yearBuilt?: number | null;
3505
+ /** @format int32 */
3506
+ yearAcquired?: number | null;
3507
+ /** @format int32 */
3508
+ numberOfUnits?: number | null;
3509
+ /** @format double */
3510
+ salePrice?: number | null;
3511
+ /** @format double */
3512
+ propertyValue?: number | null;
3513
+ /** @format double */
3514
+ purchasePrice?: number | null;
3515
+ /** @format double */
3516
+ estimatedValue?: number | null;
3517
+ /** @format double */
3518
+ monthlyRentalIncome?: number | null;
3519
+ isMixedUseProperty?: boolean | null;
3520
+ isManufacturedHome?: boolean | null;
3521
+ isFhaSecondaryResidence?: boolean | null;
3522
+ address?: AddressV3 | null;
3523
+ mortgages: LoanPropertyMortgage[];
3524
+ }
3525
+
3526
+ export interface LoanPropertyMortgage {
3527
+ /** @format uuid */
3528
+ id?: string | null;
3529
+ creditor?: string | null;
3530
+ /** @format double */
3531
+ loanAmount?: number | null;
3532
+ /** @format double */
3533
+ creditLimit?: number | null;
3534
+ /** @format double */
3535
+ monthlyPayment?: number | null;
3536
+ lienType?: LoanLienPosition | null;
3537
+ }
3538
+
3539
+ export interface LoanPropertyMortgageRequest {
3540
+ /** @maxLength 255 */
3541
+ creditor?: string | null;
3542
+ /**
3543
+ * @format double
3544
+ * @min 0
3545
+ */
3546
+ loanAmount?: number | null;
3547
+ /**
3548
+ * @format double
3549
+ * @min 0
3550
+ */
3551
+ creditLimit?: number | null;
3552
+ /**
3553
+ * @format double
3554
+ * @min 0
3555
+ */
3556
+ monthlyPayment?: number | null;
3557
+ lienType?: LoanLienPosition | null;
3558
+ }
3559
+
3560
+ export interface LoanPropertyRequest {
3561
+ trustType?: LoanTrustType | null;
3562
+ occupancy?: LoanOccupancyType | null;
3563
+ propertyType?: LoanPropertyType | null;
3564
+ /** @maxLength 100 */
3565
+ referenceId?: string | null;
3566
+ /**
3567
+ * @format int32
3568
+ * @min 1800
3569
+ * @max 2036
3570
+ */
3571
+ yearBuilt?: number | null;
3572
+ /**
3573
+ * @format int32
3574
+ * @min 1900
3575
+ * @max 2036
3576
+ */
3577
+ yearAcquired?: number | null;
3578
+ /** @format int32 */
3579
+ numberOfUnits?: number | null;
3580
+ /**
3581
+ * @format double
3582
+ * @min 0
3583
+ */
3584
+ salePrice?: number | null;
3585
+ /**
3586
+ * @format double
3587
+ * @min 0
3588
+ */
3589
+ propertyValue?: number | null;
3590
+ /**
3591
+ * @format double
3592
+ * @min 0
3593
+ */
3594
+ purchasePrice?: number | null;
3595
+ /**
3596
+ * @format double
3597
+ * @min 0
3598
+ */
3599
+ estimatedValue?: number | null;
3600
+ /**
3601
+ * @format double
3602
+ * @min 0
3603
+ */
3604
+ monthlyRentalIncome?: number | null;
3605
+ isMixedUseProperty?: boolean | null;
3606
+ isManufacturedHome?: boolean | null;
3607
+ isFhaSecondaryResidence?: boolean | null;
3608
+ address?: AddressRequest | null;
3609
+ mortgages: LoanPropertyMortgageRequest[];
3610
+ }
3611
+
2108
3612
  export interface LoanQueue {
2109
3613
  /** @format date-time */
2110
3614
  createdAt: string;
@@ -2178,6 +3682,18 @@ export interface LoanSearchCriteria {
2178
3682
  siteConfigurationId?: string | null;
2179
3683
  }
2180
3684
 
3685
+ export interface LoanSearchV3Criteria {
3686
+ searchText?: string | null;
3687
+ /** @format uuid */
3688
+ loanOfficerId?: string | null;
3689
+ loanNumber?: string | null;
3690
+ isClosed?: boolean | null;
3691
+ purpose?: LoanPurpose | null;
3692
+ type?: LoanType | null;
3693
+ /** @format uuid */
3694
+ siteConfigurationId?: string | null;
3695
+ }
3696
+
2181
3697
  export interface LoanSettings {
2182
3698
  excludeFromAutoTaskReminders: boolean;
2183
3699
  }
@@ -2188,7 +3704,14 @@ export interface LoanUpdateRequestJsonPatchDocument {
2188
3704
  }
2189
3705
 
2190
3706
  export interface LoanUpdateRequestOperation {
2191
- operationType: LoanUpdateRequestOperationOperationTypeEnum;
3707
+ operationType:
3708
+ | "Add"
3709
+ | "Remove"
3710
+ | "Replace"
3711
+ | "Move"
3712
+ | "Copy"
3713
+ | "Test"
3714
+ | "Invalid";
2192
3715
  path?: string | null;
2193
3716
  op?: string | null;
2194
3717
  from?: string | null;
@@ -2203,7 +3726,19 @@ export interface LoanUser {
2203
3726
  email: string;
2204
3727
  phone?: string | null;
2205
3728
  role: string;
2206
- loanRole: LoanUserLoanRoleEnum;
3729
+ loanRole:
3730
+ | "Borrower"
3731
+ | "CoBorrower"
3732
+ | "NonBorrower"
3733
+ | "LoanOfficer"
3734
+ | "LoanProcessor"
3735
+ | "LoanOfficerAssistant"
3736
+ | "SupportingLoanOfficer"
3737
+ | "BuyerAgent"
3738
+ | "SellerAgent"
3739
+ | "TitleInsuranceAgent"
3740
+ | "EscrowAgent"
3741
+ | "SettlementAgent";
2207
3742
  isUser: boolean;
2208
3743
  /** @format date-time */
2209
3744
  createdAt: string;
@@ -2354,6 +3889,11 @@ export interface MonthlyPaymentCalculatorRequest {
2354
3889
  term: number;
2355
3890
  }
2356
3891
 
3892
+ export interface NoContentResult {
3893
+ /** @format int32 */
3894
+ statusCode: number;
3895
+ }
3896
+
2357
3897
  export interface NotificationTemplate {
2358
3898
  /** @format date-time */
2359
3899
  createdAt?: string | null;
@@ -2834,7 +4374,7 @@ export interface SSOTokenRequest {
2834
4374
  }
2835
4375
 
2836
4376
  export interface SamlMetadataRequest {
2837
- ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
4377
+ ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
2838
4378
  }
2839
4379
 
2840
4380
  export interface SendForgotPasswordRequest {
@@ -2873,7 +4413,7 @@ export interface SiteConfiguration {
2873
4413
  deletedAt?: string | null;
2874
4414
  /** @format uuid */
2875
4415
  id: string;
2876
- type: SiteConfigurationTypeEnum;
4416
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
2877
4417
  /** @format uuid */
2878
4418
  entityID: string;
2879
4419
  /** @format int32 */
@@ -3055,7 +4595,7 @@ export interface SiteConfiguration {
3055
4595
  asoSettings?: ASOSettings | null;
3056
4596
  accountSettings: AccountSettings;
3057
4597
  autoTaskReminderIntervalsInDays?: number[] | null;
3058
- mobileSettings: MobileSettings;
4598
+ mobileSettings?: MobileSettings | null;
3059
4599
  losSettings?: LOSSettings | null;
3060
4600
  }
3061
4601
 
@@ -3068,7 +4608,7 @@ export interface SiteConfigurationByUrl {
3068
4608
  deletedAt?: string | null;
3069
4609
  /** @format uuid */
3070
4610
  id: string;
3071
- type: SiteConfigurationByUrlTypeEnum;
4611
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3072
4612
  /** @format uuid */
3073
4613
  entityID: string;
3074
4614
  /** @format int32 */
@@ -3250,7 +4790,7 @@ export interface SiteConfigurationByUrl {
3250
4790
  asoSettings?: ASOSettings | null;
3251
4791
  accountSettings: AccountSettings;
3252
4792
  autoTaskReminderIntervalsInDays?: number[] | null;
3253
- mobileSettings: MobileSettings;
4793
+ mobileSettings?: MobileSettings | null;
3254
4794
  losSettings?: LOSSettings | null;
3255
4795
  workflows: Workflow[];
3256
4796
  }
@@ -3281,7 +4821,7 @@ export interface SiteConfigurationForm {
3281
4821
  export interface SiteConfigurationReduced {
3282
4822
  /** @format uuid */
3283
4823
  id: string;
3284
- type: SiteConfigurationReducedTypeEnum;
4824
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3285
4825
  url?: string | null;
3286
4826
  name: string;
3287
4827
  /** @format int64 */
@@ -3299,7 +4839,7 @@ export interface SiteConfigurationRequest {
3299
4839
  entityID: string;
3300
4840
  /** @format int32 */
3301
4841
  entityType: number;
3302
- type: SiteConfigurationRequestTypeEnum;
4842
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3303
4843
  url: string;
3304
4844
  name: string;
3305
4845
  introduction?: string | null;
@@ -3476,7 +5016,7 @@ export interface SiteConfigurationSearchCriteria {
3476
5016
  export interface SiteConfigurationSummary {
3477
5017
  /** @format uuid */
3478
5018
  id: string;
3479
- type: SiteConfigurationSummaryTypeEnum;
5019
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3480
5020
  url?: string | null;
3481
5021
  name: string;
3482
5022
  /** @format int64 */
@@ -3674,6 +5214,22 @@ export interface Theme {
3674
5214
  iconColor?: string | null;
3675
5215
  }
3676
5216
 
5217
+ export interface TimeAtAddress {
5218
+ /** @format uuid */
5219
+ id?: string | null;
5220
+ /** @format int32 */
5221
+ years?: number | null;
5222
+ /** @format int32 */
5223
+ months?: number | null;
5224
+ }
5225
+
5226
+ export interface TimeAtAddressRequest {
5227
+ /** @format int32 */
5228
+ years?: number | null;
5229
+ /** @format int32 */
5230
+ months?: number | null;
5231
+ }
5232
+
3677
5233
  export interface Token {
3678
5234
  token_type: string;
3679
5235
  /** @format int32 */
@@ -3915,7 +5471,19 @@ export interface UserDevice {
3915
5471
  export interface UserDraft {
3916
5472
  /** @format uuid */
3917
5473
  draftID: string;
3918
- role: UserDraftRoleEnum;
5474
+ role:
5475
+ | "Borrower"
5476
+ | "CoBorrower"
5477
+ | "NonBorrower"
5478
+ | "LoanOfficer"
5479
+ | "LoanProcessor"
5480
+ | "LoanOfficerAssistant"
5481
+ | "SupportingLoanOfficer"
5482
+ | "BuyerAgent"
5483
+ | "SellerAgent"
5484
+ | "TitleInsuranceAgent"
5485
+ | "EscrowAgent"
5486
+ | "SettlementAgent";
3919
5487
  user: User;
3920
5488
  }
3921
5489
 
@@ -3942,7 +5510,7 @@ export interface UserGroupAccessScope {
3942
5510
  id: string;
3943
5511
  /** @format uuid */
3944
5512
  groupId: string;
3945
- scopeType: UserGroupAccessScopeScopeTypeEnum;
5513
+ scopeType: "User" | "Branch";
3946
5514
  /** @format uuid */
3947
5515
  userId?: string | null;
3948
5516
  /** @format uuid */
@@ -3978,7 +5546,19 @@ export interface UserLoan {
3978
5546
  deletedAt?: string | null;
3979
5547
  loanID: string;
3980
5548
  user: User;
3981
- role: UserLoanRoleEnum;
5549
+ role:
5550
+ | "Borrower"
5551
+ | "CoBorrower"
5552
+ | "NonBorrower"
5553
+ | "LoanOfficer"
5554
+ | "LoanProcessor"
5555
+ | "LoanOfficerAssistant"
5556
+ | "SupportingLoanOfficer"
5557
+ | "BuyerAgent"
5558
+ | "SellerAgent"
5559
+ | "TitleInsuranceAgent"
5560
+ | "EscrowAgent"
5561
+ | "SettlementAgent";
3982
5562
  /** @format int32 */
3983
5563
  borrowerPair?: number | null;
3984
5564
  /** @format int32 */
@@ -3991,7 +5571,7 @@ export interface UserLoanConsent {
3991
5571
  id: string;
3992
5572
  /** @format uuid */
3993
5573
  userLoanID: string;
3994
- type: UserLoanConsentTypeEnum;
5574
+ type: "Econsent" | "CreditAuthorization" | "Tcpa";
3995
5575
  providedConsent: boolean;
3996
5576
  ipAddress?: string | null;
3997
5577
  /** @format date-time */
@@ -4138,289 +5718,51 @@ export interface UserSummary {
4138
5718
  id: string;
4139
5719
  name?: string | null;
4140
5720
  email?: string | null;
4141
- role: UserSummaryRoleEnum;
5721
+ role:
5722
+ | "Borrower"
5723
+ | "LoanOfficer"
5724
+ | "Admin"
5725
+ | "SuperAdmin"
5726
+ | "Realtor"
5727
+ | "SettlementAgent"
5728
+ | "LoanProcessor"
5729
+ | "LoanOfficerAssistant"
5730
+ | "BranchManager"
5731
+ | "SystemAdmin";
4142
5732
  }
4143
5733
 
4144
5734
  export interface VerifyPasswordRequest {
4145
5735
  /**
4146
- * @format email
4147
- * @minLength 1
4148
- */
4149
- email: string;
4150
- /** @minLength 1 */
4151
- code: string;
4152
- /** @minLength 8 */
4153
- password: string;
4154
- /** @format uuid */
4155
- siteConfigurationId?: string | null;
4156
- }
4157
-
4158
- export interface Workflow {
4159
- formType: string;
4160
- target: string;
4161
- authType: string;
4162
- name: string;
4163
- isDefault: boolean;
4164
- description: string;
4165
- slug: string;
4166
- status: string;
4167
- userRole: string;
4168
- borrowerType: string;
4169
- showProgressBar: boolean;
4170
- showTile: boolean;
4171
- tileLocation: string;
4172
- tileText: string;
4173
- tileSubtitle: string;
4174
- icon: string;
4175
- }
4176
-
4177
- export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
4178
-
4179
- export type CreateAccountRequestEnvironmentEnum =
4180
- | "Development"
4181
- | "Staging"
4182
- | "UAT"
4183
- | "Production";
4184
-
4185
- export type CreateGroupMemberRequestLoanRoleEnum =
4186
- | "Borrower"
4187
- | "CoBorrower"
4188
- | "NonBorrower"
4189
- | "LoanOfficer"
4190
- | "LoanProcessor"
4191
- | "LoanOfficerAssistant"
4192
- | "SupportingLoanOfficer"
4193
- | "BuyerAgent"
4194
- | "SellerAgent"
4195
- | "TitleInsuranceAgent"
4196
- | "EscrowAgent"
4197
- | "SettlementAgent";
4198
-
4199
- /** @deprecated */
4200
- export type CreateInviteRequestRelationshipEnum =
4201
- | "NotApplicable"
4202
- | "Spouse"
4203
- | "NonSpouse";
4204
-
4205
- export type CreateLoanImportRequestImportModeEnum =
4206
- | "All"
4207
- | "NewOnly"
4208
- | "UpdateOnly";
4209
-
4210
- export type CreateUserDraftLoanRoleEnum =
4211
- | "Borrower"
4212
- | "CoBorrower"
4213
- | "NonBorrower"
4214
- | "LoanOfficer"
4215
- | "LoanProcessor"
4216
- | "LoanOfficerAssistant"
4217
- | "SupportingLoanOfficer"
4218
- | "BuyerAgent"
4219
- | "SellerAgent"
4220
- | "TitleInsuranceAgent"
4221
- | "EscrowAgent"
4222
- | "SettlementAgent";
4223
-
4224
- export type DraftTypeEnum = "NewLoan" | "EditLoan";
4225
-
4226
- export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
4227
-
4228
- export type FusionReportFilterFilterTypeEnum =
4229
- | "DateGreaterThanOrEqualTo"
4230
- | "DateGreaterThan"
4231
- | "DateLessThan"
4232
- | "DateLessThanOrEqualTo"
4233
- | "DateEquals"
4234
- | "DateDoesntEqual"
4235
- | "DateNonEmpty"
4236
- | "DateEmpty"
4237
- | "StringContains"
4238
- | "StringEquals"
4239
- | "StringNotEmpty"
4240
- | "StringNotEquals"
4241
- | "StringNotContains";
4242
-
4243
- export type LoanContactRoleEnum =
4244
- | "Borrower"
4245
- | "CoBorrower"
4246
- | "NonBorrower"
4247
- | "LoanOfficer"
4248
- | "LoanProcessor"
4249
- | "LoanOfficerAssistant"
4250
- | "SupportingLoanOfficer"
4251
- | "BuyerAgent"
4252
- | "SellerAgent"
4253
- | "TitleInsuranceAgent"
4254
- | "EscrowAgent"
4255
- | "SettlementAgent";
4256
-
4257
- export type LoanImportStatusEnum =
4258
- | "WaitingProcess"
4259
- | "InProgress"
4260
- | "Completed"
4261
- | "Failed"
4262
- | "Cancelled";
4263
-
4264
- export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
4265
-
4266
- export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
4267
-
4268
- export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
4269
-
4270
- export type LoanLogTypeEnum =
4271
- | "Loan"
4272
- | "Queue"
4273
- | "POSFlagChanged"
4274
- | "Verification"
4275
- | "DocumentUploaded"
4276
- | "LoanCreated"
4277
- | "WorkflowSubmitted"
4278
- | "UserInvitationSent"
4279
- | "CoBorrowerAdded"
4280
- | "TaskCompleted"
4281
- | "LoanStatusChanged"
4282
- | "EConsent";
4283
-
4284
- export type LoanUpdateRequestOperationOperationTypeEnum =
4285
- | "Add"
4286
- | "Remove"
4287
- | "Replace"
4288
- | "Move"
4289
- | "Copy"
4290
- | "Test"
4291
- | "Invalid";
4292
-
4293
- export type LoanUserLoanRoleEnum =
4294
- | "Borrower"
4295
- | "CoBorrower"
4296
- | "NonBorrower"
4297
- | "LoanOfficer"
4298
- | "LoanProcessor"
4299
- | "LoanOfficerAssistant"
4300
- | "SupportingLoanOfficer"
4301
- | "BuyerAgent"
4302
- | "SellerAgent"
4303
- | "TitleInsuranceAgent"
4304
- | "EscrowAgent"
4305
- | "SettlementAgent";
4306
-
4307
- export type SamlMetadataRequestSsoIntegrationEnum =
4308
- | "ConsumerConnect"
4309
- | "TheBigPOS";
4310
-
4311
- export type SiteConfigurationTypeEnum =
4312
- | "None"
4313
- | "Account"
4314
- | "Corporate"
4315
- | "Branch"
4316
- | "LoanOfficer"
4317
- | "Partner";
4318
-
4319
- export type SiteConfigurationByUrlTypeEnum =
4320
- | "None"
4321
- | "Account"
4322
- | "Corporate"
4323
- | "Branch"
4324
- | "LoanOfficer"
4325
- | "Partner";
4326
-
4327
- export type SiteConfigurationReducedTypeEnum =
4328
- | "None"
4329
- | "Account"
4330
- | "Corporate"
4331
- | "Branch"
4332
- | "LoanOfficer"
4333
- | "Partner";
4334
-
4335
- export type SiteConfigurationRequestTypeEnum =
4336
- | "None"
4337
- | "Account"
4338
- | "Corporate"
4339
- | "Branch"
4340
- | "LoanOfficer"
4341
- | "Partner";
4342
-
4343
- export type SiteConfigurationSummaryTypeEnum =
4344
- | "None"
4345
- | "Account"
4346
- | "Corporate"
4347
- | "Branch"
4348
- | "LoanOfficer"
4349
- | "Partner";
4350
-
4351
- export type UserDraftRoleEnum =
4352
- | "Borrower"
4353
- | "CoBorrower"
4354
- | "NonBorrower"
4355
- | "LoanOfficer"
4356
- | "LoanProcessor"
4357
- | "LoanOfficerAssistant"
4358
- | "SupportingLoanOfficer"
4359
- | "BuyerAgent"
4360
- | "SellerAgent"
4361
- | "TitleInsuranceAgent"
4362
- | "EscrowAgent"
4363
- | "SettlementAgent";
4364
-
4365
- export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
4366
-
4367
- export type UserLoanRoleEnum =
4368
- | "Borrower"
4369
- | "CoBorrower"
4370
- | "NonBorrower"
4371
- | "LoanOfficer"
4372
- | "LoanProcessor"
4373
- | "LoanOfficerAssistant"
4374
- | "SupportingLoanOfficer"
4375
- | "BuyerAgent"
4376
- | "SellerAgent"
4377
- | "TitleInsuranceAgent"
4378
- | "EscrowAgent"
4379
- | "SettlementAgent";
4380
-
4381
- export type UserLoanConsentTypeEnum =
4382
- | "Econsent"
4383
- | "CreditAuthorization"
4384
- | "Tcpa";
4385
-
4386
- export type UserSummaryRoleEnum =
4387
- | "Borrower"
4388
- | "LoanOfficer"
4389
- | "Admin"
4390
- | "SuperAdmin"
4391
- | "Realtor"
4392
- | "SettlementAgent"
4393
- | "LoanProcessor"
4394
- | "LoanOfficerAssistant"
4395
- | "BranchManager"
4396
- | "SystemAdmin";
4397
-
4398
- /** @default "Realtor" */
4399
- export type GetPartnersParamsRoleEnum =
4400
- | "Borrower"
4401
- | "LoanOfficer"
4402
- | "Admin"
4403
- | "SuperAdmin"
4404
- | "Realtor"
4405
- | "SettlementAgent"
4406
- | "LoanProcessor"
4407
- | "LoanOfficerAssistant"
4408
- | "BranchManager"
4409
- | "SystemAdmin";
4410
-
4411
- export type GetSamlMetadataParamsSSoIntegrationEnum =
4412
- | "ConsumerConnect"
4413
- | "TheBigPOS";
4414
-
4415
- export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS";
4416
-
4417
- export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum =
4418
- | "ConsumerConnect"
4419
- | "TheBigPOS";
5736
+ * @format email
5737
+ * @minLength 1
5738
+ */
5739
+ email: string;
5740
+ /** @minLength 1 */
5741
+ code: string;
5742
+ /** @minLength 8 */
5743
+ password: string;
5744
+ /** @format uuid */
5745
+ siteConfigurationId?: string | null;
5746
+ }
4420
5747
 
4421
- export type CreateOrReplaceSamlMetadataParamsEnum =
4422
- | "ConsumerConnect"
4423
- | "TheBigPOS";
5748
+ export interface Workflow {
5749
+ formType: string;
5750
+ target: string;
5751
+ authType: string;
5752
+ name: string;
5753
+ isDefault: boolean;
5754
+ description: string;
5755
+ slug: string;
5756
+ status: string;
5757
+ userRole: string;
5758
+ borrowerType: string;
5759
+ showProgressBar: boolean;
5760
+ showTile: boolean;
5761
+ tileLocation: string;
5762
+ tileText: string;
5763
+ tileSubtitle: string;
5764
+ icon: string;
5765
+ }
4424
5766
 
4425
5767
  import type {
4426
5768
  AxiosInstance,
@@ -4600,7 +5942,7 @@ export class HttpClient<SecurityDataType = unknown> {
4600
5942
 
4601
5943
  /**
4602
5944
  * @title The Big POS API
4603
- * @version v2.29.1
5945
+ * @version v2.31.0
4604
5946
  * @termsOfService https://www.thebigpos.com/terms-of-use/
4605
5947
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
4606
5948
  */
@@ -4822,52 +6164,6 @@ export class Api<
4822
6164
  ...params,
4823
6165
  }),
4824
6166
 
4825
- /**
4826
- * No description
4827
- *
4828
- * @tags Accounts
4829
- * @name UpdateLoansByAccount
4830
- * @summary Update Loans
4831
- * @request PUT:/api/accounts/{id}/loan
4832
- * @secure
4833
- * @response `200` `void` Success
4834
- * @response `404` `ProblemDetails` Not Found
4835
- * @response `422` `UnprocessableEntity` Client Error
4836
- */
4837
- updateLoansByAccount: (
4838
- id: string,
4839
- data: Loan[],
4840
- params: RequestParams = {},
4841
- ) =>
4842
- this.request<void, ProblemDetails | UnprocessableEntity>({
4843
- path: `/api/accounts/${id}/loan`,
4844
- method: "PUT",
4845
- body: data,
4846
- secure: true,
4847
- type: ContentType.Json,
4848
- ...params,
4849
- }),
4850
-
4851
- /**
4852
- * No description
4853
- *
4854
- * @tags Accounts
4855
- * @name GetLoansByAccount
4856
- * @summary Get Loans
4857
- * @request GET:/api/accounts/{id}/loan
4858
- * @secure
4859
- * @response `200` `(Loan)[]` Success
4860
- * @response `404` `ProblemDetails` Not Found
4861
- */
4862
- getLoansByAccount: (id: string, params: RequestParams = {}) =>
4863
- this.request<Loan[], ProblemDetails>({
4864
- path: `/api/accounts/${id}/loan`,
4865
- method: "GET",
4866
- secure: true,
4867
- format: "json",
4868
- ...params,
4869
- }),
4870
-
4871
6167
  /**
4872
6168
  * No description
4873
6169
  *
@@ -4877,13 +6173,14 @@ export class Api<
4877
6173
  * @request POST:/api/refresh-token
4878
6174
  * @secure
4879
6175
  * @response `200` `Token` Success
6176
+ * @response `401` `ProblemDetails` Unauthorized
4880
6177
  * @response `422` `UnprocessableEntity` Client Error
4881
6178
  */
4882
6179
  getTokenFromRefreshToken: (
4883
6180
  data: RefreshTokenRequest,
4884
6181
  params: RequestParams = {},
4885
6182
  ) =>
4886
- this.request<Token, UnprocessableEntity>({
6183
+ this.request<Token, ProblemDetails | UnprocessableEntity>({
4887
6184
  path: `/api/refresh-token`,
4888
6185
  method: "POST",
4889
6186
  body: data,
@@ -4992,14 +6289,15 @@ export class Api<
4992
6289
  * @summary Sign out (clear auth cookies)
4993
6290
  * @request POST:/api/logout
4994
6291
  * @secure
4995
- * @response `204` `void` No Content
6292
+ * @response `204` `NoContentResult` No Content
4996
6293
  * @response `422` `UnprocessableEntity` Client Error
4997
6294
  */
4998
6295
  logOut: (params: RequestParams = {}) =>
4999
- this.request<void, UnprocessableEntity>({
6296
+ this.request<NoContentResult, UnprocessableEntity>({
5000
6297
  path: `/api/logout`,
5001
6298
  method: "POST",
5002
6299
  secure: true,
6300
+ format: "json",
5003
6301
  ...params,
5004
6302
  }),
5005
6303
 
@@ -5402,6 +6700,30 @@ export class Api<
5402
6700
  ...params,
5403
6701
  }),
5404
6702
 
6703
+ /**
6704
+ * @description Returns closed loan counts per account within the specified date range, including POS vs non-POS breakdown and utilization ratios.
6705
+ *
6706
+ * @tags ClosedLoanReports
6707
+ * @name GetClosedLoansReport
6708
+ * @summary Get Closed Loans Report
6709
+ * @request POST:/api/loans/reports/closed-loans
6710
+ * @secure
6711
+ * @response `200` `ClosedLoansReport` Success
6712
+ */
6713
+ getClosedLoansReport: (
6714
+ data: ClosedLoansReportRequest,
6715
+ params: RequestParams = {},
6716
+ ) =>
6717
+ this.request<ClosedLoansReport, any>({
6718
+ path: `/api/loans/reports/closed-loans`,
6719
+ method: "POST",
6720
+ body: data,
6721
+ secure: true,
6722
+ type: ContentType.Json,
6723
+ format: "json",
6724
+ ...params,
6725
+ }),
6726
+
5405
6727
  /**
5406
6728
  * No description
5407
6729
  *
@@ -6118,6 +7440,72 @@ export class Api<
6118
7440
  ...params,
6119
7441
  }),
6120
7442
 
7443
+ /**
7444
+ * No description
7445
+ *
7446
+ * @tags Encompass Packages
7447
+ * @name GetUserPackages
7448
+ * @request GET:/api/los/encompass/eclose/packages
7449
+ * @secure
7450
+ * @response `200` `EncompassPackageList` Success
7451
+ * @response `400` `EncompassError` Bad Request
7452
+ * @response `401` `EncompassError` Unauthorized
7453
+ * @response `500` `EncompassError` Server Error
7454
+ */
7455
+ getUserPackages: (
7456
+ query?: {
7457
+ /** @default "all" */
7458
+ status?: string;
7459
+ /**
7460
+ * @format int32
7461
+ * @default 1
7462
+ */
7463
+ page?: number;
7464
+ /**
7465
+ * @format int32
7466
+ * @default 20
7467
+ */
7468
+ pageSize?: number;
7469
+ },
7470
+ params: RequestParams = {},
7471
+ ) =>
7472
+ this.request<EncompassPackageList, EncompassError>({
7473
+ path: `/api/los/encompass/eclose/packages`,
7474
+ method: "GET",
7475
+ query: query,
7476
+ secure: true,
7477
+ format: "json",
7478
+ ...params,
7479
+ }),
7480
+
7481
+ /**
7482
+ * No description
7483
+ *
7484
+ * @tags Encompass Sessions
7485
+ * @name CreateEncompassSession
7486
+ * @request POST:/api/los/encompass/eclose/sessions
7487
+ * @secure
7488
+ * @response `200` `CreateSession` Success
7489
+ * @response `400` `EncompassError` Bad Request
7490
+ * @response `401` `EncompassError` Unauthorized
7491
+ * @response `403` `EncompassError` Forbidden
7492
+ * @response `404` `EncompassError` Not Found
7493
+ * @response `500` `EncompassError` Server Error
7494
+ */
7495
+ createEncompassSession: (
7496
+ data: CreateSessionRequest,
7497
+ params: RequestParams = {},
7498
+ ) =>
7499
+ this.request<CreateSession, EncompassError>({
7500
+ path: `/api/los/encompass/eclose/sessions`,
7501
+ method: "POST",
7502
+ body: data,
7503
+ secure: true,
7504
+ type: ContentType.Json,
7505
+ format: "json",
7506
+ ...params,
7507
+ }),
7508
+
6121
7509
  /**
6122
7510
  * No description
6123
7511
  *
@@ -6783,7 +8171,7 @@ export class Api<
6783
8171
  method: "PATCH",
6784
8172
  body: data,
6785
8173
  secure: true,
6786
- type: ContentType.JsonPatch,
8174
+ type: ContentType.JsonPatchPatch,
6787
8175
  format: "json",
6788
8176
  ...params,
6789
8177
  }),
@@ -6853,10 +8241,18 @@ export class Api<
6853
8241
  * @response `422` `UnprocessableEntity` Client Error
6854
8242
  * @response `423` `UnprocessableEntity` Client Error
6855
8243
  */
6856
- createLoanInternal: (data: any, params: RequestParams = {}) =>
8244
+ createLoanInternal: (
8245
+ data: any,
8246
+ query?: {
8247
+ /** @default false */
8248
+ isPatch?: boolean;
8249
+ },
8250
+ params: RequestParams = {},
8251
+ ) =>
6857
8252
  this.request<string, UnprocessableEntity>({
6858
8253
  path: `/api/los/loan/application/internal`,
6859
8254
  method: "POST",
8255
+ query: query,
6860
8256
  body: data,
6861
8257
  secure: true,
6862
8258
  type: ContentType.Json,
@@ -6885,7 +8281,7 @@ export class Api<
6885
8281
  method: "PATCH",
6886
8282
  body: data,
6887
8283
  secure: true,
6888
- type: ContentType.JsonPatch,
8284
+ type: ContentType.JsonPatchPatch,
6889
8285
  format: "json",
6890
8286
  ...params,
6891
8287
  }),
@@ -6899,6 +8295,7 @@ export class Api<
6899
8295
  * @request PATCH:/api/los/loan/application/{loanID}/consent
6900
8296
  * @secure
6901
8297
  * @response `200` `string` Success
8298
+ * @response `202` `string` Accepted
6902
8299
  * @response `422` `UnprocessableEntity` Client Error
6903
8300
  */
6904
8301
  updateLoanConsent: (
@@ -6911,7 +8308,7 @@ export class Api<
6911
8308
  method: "PATCH",
6912
8309
  body: data,
6913
8310
  secure: true,
6914
- type: ContentType.JsonPatch,
8311
+ type: ContentType.JsonPatchPatch,
6915
8312
  format: "json",
6916
8313
  ...params,
6917
8314
  }),
@@ -7152,7 +8549,7 @@ export class Api<
7152
8549
  method: "PATCH",
7153
8550
  body: data,
7154
8551
  secure: true,
7155
- type: ContentType.JsonPatch,
8552
+ type: ContentType.JsonPatchPatch,
7156
8553
  format: "json",
7157
8554
  ...params,
7158
8555
  }),
@@ -7232,7 +8629,7 @@ export class Api<
7232
8629
  method: "PATCH",
7233
8630
  body: data,
7234
8631
  secure: true,
7235
- type: ContentType.JsonPatch,
8632
+ type: ContentType.JsonPatchPatch,
7236
8633
  format: "json",
7237
8634
  ...params,
7238
8635
  }),
@@ -7869,6 +9266,53 @@ export class Api<
7869
9266
  ...params,
7870
9267
  }),
7871
9268
 
9269
+ /**
9270
+ * @description Fetches all documents from Encompass that don't exist locally and stores them in S3
9271
+ *
9272
+ * @tags LoanDocuments
9273
+ * @name SyncLoanDocumentsFromEncompass
9274
+ * @summary Sync documents from Encompass
9275
+ * @request POST:/api/loans/{loanId}/documents/sync
9276
+ * @secure
9277
+ * @response `200` `DocumentSync` Success
9278
+ * @response `404` `ProblemDetails` Not Found
9279
+ */
9280
+ syncLoanDocumentsFromEncompass: (
9281
+ loanId: string,
9282
+ params: RequestParams = {},
9283
+ ) =>
9284
+ this.request<DocumentSync, ProblemDetails>({
9285
+ path: `/api/loans/${loanId}/documents/sync`,
9286
+ method: "POST",
9287
+ secure: true,
9288
+ format: "json",
9289
+ ...params,
9290
+ }),
9291
+
9292
+ /**
9293
+ * @description Re-attempts to push a failed document to Encompass
9294
+ *
9295
+ * @tags LoanDocuments
9296
+ * @name RetrySyncLoanDocumentToEncompass
9297
+ * @summary Retry syncing a document to Encompass
9298
+ * @request POST:/api/loans/{loanId}/documents/{documentId}/sync/retry
9299
+ * @secure
9300
+ * @response `200` `void` Success
9301
+ * @response `404` `ProblemDetails` Not Found
9302
+ * @response `423` `ProblemDetails` Client Error
9303
+ */
9304
+ retrySyncLoanDocumentToEncompass: (
9305
+ loanId: string,
9306
+ documentId: string,
9307
+ params: RequestParams = {},
9308
+ ) =>
9309
+ this.request<void, ProblemDetails>({
9310
+ path: `/api/loans/${loanId}/documents/${documentId}/sync/retry`,
9311
+ method: "POST",
9312
+ secure: true,
9313
+ ...params,
9314
+ }),
9315
+
7872
9316
  /**
7873
9317
  * No description
7874
9318
  *
@@ -8558,39 +10002,6 @@ export class Api<
8558
10002
  ...params,
8559
10003
  }),
8560
10004
 
8561
- /**
8562
- * No description
8563
- *
8564
- * @tags Loans
8565
- * @name GetLoansByAccountSetting
8566
- * @summary Get Loans by Account Setting
8567
- * @request POST:/api/loans/temp-pipeline
8568
- * @secure
8569
- * @response `200` `any` Success
8570
- */
8571
- getLoansByAccountSetting: (
8572
- data: LoanSearchCriteria,
8573
- query?: {
8574
- /** @format int32 */
8575
- pageSize?: number;
8576
- /** @format int32 */
8577
- pageNumber?: number;
8578
- sortBy?: string;
8579
- sortDirection?: string;
8580
- },
8581
- params: RequestParams = {},
8582
- ) =>
8583
- this.request<any, any>({
8584
- path: `/api/loans/temp-pipeline`,
8585
- method: "POST",
8586
- query: query,
8587
- body: data,
8588
- secure: true,
8589
- type: ContentType.Json,
8590
- format: "json",
8591
- ...params,
8592
- }),
8593
-
8594
10005
  /**
8595
10006
  * No description
8596
10007
  *
@@ -8683,7 +10094,116 @@ export class Api<
8683
10094
  method: "PATCH",
8684
10095
  body: data,
8685
10096
  secure: true,
8686
- type: ContentType.JsonPatch,
10097
+ type: ContentType.JsonPatchPatch,
10098
+ format: "json",
10099
+ ...params,
10100
+ }),
10101
+
10102
+ /**
10103
+ * @description Retrieves a loan by its unique identifier
10104
+ *
10105
+ * @tags Loans V3
10106
+ * @name GetLoanById
10107
+ * @summary Get Loan by ID
10108
+ * @request GET:/api/v3/loans/{id}
10109
+ * @secure
10110
+ * @response `200` `LoanApplication` Success
10111
+ * @response `401` `ProblemDetails` Unauthorized
10112
+ * @response `403` `ProblemDetails` Forbidden
10113
+ * @response `404` `ProblemDetails` Not Found
10114
+ */
10115
+ getLoanById: (id: string, params: RequestParams = {}) =>
10116
+ this.request<LoanApplication, ProblemDetails>({
10117
+ path: `/api/v3/loans/${id}`,
10118
+ method: "GET",
10119
+ secure: true,
10120
+ format: "json",
10121
+ ...params,
10122
+ }),
10123
+
10124
+ /**
10125
+ * @description Partially update a loan using GUID-based patch operations. Supports GUID lookups in collections, eliminating index ordering issues.
10126
+ *
10127
+ * @tags Loans V3
10128
+ * @name PatchLoan
10129
+ * @summary Patch Loan (GUID-based)
10130
+ * @request PATCH:/api/v3/loans/{id}
10131
+ * @secure
10132
+ * @response `200` `LoanApplication` Success
10133
+ * @response `400` `any` Bad Request
10134
+ * @response `401` `ProblemDetails` Unauthorized
10135
+ * @response `403` `ProblemDetails` Forbidden
10136
+ * @response `404` `ProblemDetails` Not Found
10137
+ * @response `409` `any` Conflict
10138
+ */
10139
+ patchLoan: (id: string, data: any, params: RequestParams = {}) =>
10140
+ this.request<LoanApplication, ProblemDetails>({
10141
+ path: `/api/v3/loans/${id}`,
10142
+ method: "PATCH",
10143
+ body: data,
10144
+ secure: true,
10145
+ format: "json",
10146
+ ...params,
10147
+ }),
10148
+
10149
+ /**
10150
+ * @description Creates a new loan or adds borrowers to an existing loan based on the presence of LoanID
10151
+ *
10152
+ * @tags Loans V3
10153
+ * @name SubmitLoanApplication
10154
+ * @summary Submit Loan Application
10155
+ * @request POST:/api/v3/loans/applications
10156
+ * @secure
10157
+ * @response `201` `LoanApplication` Created
10158
+ * @response `400` `any` Bad Request
10159
+ * @response `401` `ProblemDetails` Unauthorized
10160
+ * @response `403` `ProblemDetails` Forbidden
10161
+ * @response `404` `ProblemDetails` Not Found
10162
+ */
10163
+ submitLoanApplication: (
10164
+ data: LoanApplicationRequest,
10165
+ params: RequestParams = {},
10166
+ ) =>
10167
+ this.request<LoanApplication, ProblemDetails>({
10168
+ path: `/api/v3/loans/applications`,
10169
+ method: "POST",
10170
+ body: data,
10171
+ secure: true,
10172
+ type: ContentType.JsonPatchPatch,
10173
+ format: "json",
10174
+ ...params,
10175
+ }),
10176
+
10177
+ /**
10178
+ * @description Returns a paginated list of loans based on search criteria
10179
+ *
10180
+ * @tags Loans V3
10181
+ * @name SearchLoansV3
10182
+ * @summary Search Loans
10183
+ * @request POST:/api/v3/loans/search
10184
+ * @secure
10185
+ * @response `200` `LoanListV3Paginated` Success
10186
+ * @response `401` `ProblemDetails` Unauthorized
10187
+ */
10188
+ searchLoansV3: (
10189
+ data: LoanSearchV3Criteria,
10190
+ query?: {
10191
+ /** @format int32 */
10192
+ pageSize?: number;
10193
+ /** @format int32 */
10194
+ pageNumber?: number;
10195
+ sortBy?: string;
10196
+ sortDirection?: string;
10197
+ },
10198
+ params: RequestParams = {},
10199
+ ) =>
10200
+ this.request<LoanListV3Paginated, ProblemDetails>({
10201
+ path: `/api/v3/loans/search`,
10202
+ method: "POST",
10203
+ query: query,
10204
+ body: data,
10205
+ secure: true,
10206
+ type: ContentType.Json,
8687
10207
  format: "json",
8688
10208
  ...params,
8689
10209
  }),
@@ -9731,7 +11251,17 @@ export class Api<
9731
11251
  query?: {
9732
11252
  showAll?: boolean;
9733
11253
  /** @default "Realtor" */
9734
- role?: GetPartnersParamsRoleEnum;
11254
+ role?:
11255
+ | "Borrower"
11256
+ | "LoanOfficer"
11257
+ | "Admin"
11258
+ | "SuperAdmin"
11259
+ | "Realtor"
11260
+ | "SettlementAgent"
11261
+ | "LoanProcessor"
11262
+ | "LoanOfficerAssistant"
11263
+ | "BranchManager"
11264
+ | "SystemAdmin";
9735
11265
  /** @format int32 */
9736
11266
  pageSize?: number;
9737
11267
  /** @format int32 */
@@ -10067,7 +11597,7 @@ export class Api<
10067
11597
  * @response `404` `ProblemDetails` Not Found
10068
11598
  */
10069
11599
  getSamlMetadata: (
10070
- sSoIntegration: GetSamlMetadataParamsEnum,
11600
+ sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
10071
11601
  ssoIntegration: string,
10072
11602
  params: RequestParams = {},
10073
11603
  ) =>
@@ -10089,7 +11619,7 @@ export class Api<
10089
11619
  * @response `200` `File` Success
10090
11620
  */
10091
11621
  createOrReplaceSamlMetadata: (
10092
- sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum,
11622
+ sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
10093
11623
  ssoIntegration: string,
10094
11624
  params: RequestParams = {},
10095
11625
  ) =>
@@ -11628,4 +13158,22 @@ export class Api<
11628
13158
  ...params,
11629
13159
  }),
11630
13160
  };
13161
+ sso = {
13162
+ /**
13163
+ * No description
13164
+ *
13165
+ * @tags Saml
13166
+ * @name LogoutList
13167
+ * @request GET:/sso/logout
13168
+ * @secure
13169
+ * @response `200` `void` Success
13170
+ */
13171
+ logoutList: (params: RequestParams = {}) =>
13172
+ this.request<void, any>({
13173
+ path: `/sso/logout`,
13174
+ method: "GET",
13175
+ secure: true,
13176
+ ...params,
13177
+ }),
13178
+ };
11631
13179
  }