@matech/thebigpos-sdk 2.40.0-rc.0 → 2.40.0-rc.2

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
@@ -42,6 +42,8 @@ export type SigningMethod = "ConsumerConnect" | "POSF";
42
42
 
43
43
  export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
44
44
 
45
+ export type LosSyncStepSeverity = "Success" | "Info" | "Warning" | "Error";
46
+
45
47
  export type LosOperationStatus =
46
48
  | "Pending"
47
49
  | "Success"
@@ -75,7 +77,8 @@ export type LoanRole =
75
77
  | "SellerAgent"
76
78
  | "TitleInsuranceAgent"
77
79
  | "EscrowAgent"
78
- | "SettlementAgent";
80
+ | "SettlementAgent"
81
+ | "Admin";
79
82
 
80
83
  export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell";
81
84
 
@@ -265,6 +268,12 @@ export type LoanGiftAssetType = "Cash" | "Asset" | "Equity";
265
268
 
266
269
  export type LoanGenderType = "Male" | "Female";
267
270
 
271
+ export type LoanDocumentFolderPermissionLevel =
272
+ | "None"
273
+ | "Read"
274
+ | "Write"
275
+ | "Manage";
276
+
268
277
  export type LoanCitizenship =
269
278
  | "USCitizen"
270
279
  | "PermanentResidentAlien"
@@ -470,7 +479,7 @@ export interface AccountBilling {
470
479
  }
471
480
 
472
481
  export interface AccountBillingRequest {
473
- billingType: "ClosedLoan" | "LoanOfficer";
482
+ billingType: AccountBillingRequestBillingTypeEnum;
474
483
  /**
475
484
  * @format double
476
485
  * @min 0
@@ -808,12 +817,7 @@ export interface AuditLogEntry {
808
817
  /** @format uuid */
809
818
  id: string;
810
819
  entityType: string;
811
- changeType:
812
- | "Created"
813
- | "Modified"
814
- | "SoftDeleted"
815
- | "HardDeleted"
816
- | "Restored";
820
+ changeType: AuditLogEntryChangeTypeEnum;
817
821
  /** @format uuid */
818
822
  entityId: string;
819
823
  performedBy?: AuditLogUser | null;
@@ -1127,7 +1131,7 @@ export interface CorporateSearchCriteria {
1127
1131
  }
1128
1132
 
1129
1133
  export interface CreateAccessScopeRequest {
1130
- scopeType: "User" | "Branch";
1134
+ scopeType: CreateAccessScopeRequestScopeTypeEnum;
1131
1135
  /** @format uuid */
1132
1136
  userId?: string | null;
1133
1137
  /** @format uuid */
@@ -1151,7 +1155,7 @@ export interface CreateAccountRequest {
1151
1155
  */
1152
1156
  nlmsid: number;
1153
1157
  settings: AccountSettingsRequest;
1154
- environment: "Development" | "Staging" | "UAT" | "Production";
1158
+ environment: CreateAccountRequestEnvironmentEnum;
1155
1159
  losIntegration: LOSIntegration;
1156
1160
  billingSettings: AccountBillingRequest;
1157
1161
  }
@@ -1189,15 +1193,8 @@ export interface CreateCustomFieldDefinitionRequest {
1189
1193
  name: string;
1190
1194
  defaultValue?: string | null;
1191
1195
  regexPattern?: string | null;
1192
- dataType:
1193
- | "String"
1194
- | "Number"
1195
- | "Decimal"
1196
- | "Boolean"
1197
- | "Date"
1198
- | "SingleSelect"
1199
- | "MultiSelect";
1200
- entityType: "Loan";
1196
+ dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
1197
+ entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
1201
1198
  options?: CustomFieldOptionRequest[] | null;
1202
1199
  permissions?: CustomFieldPermissionRequest[] | null;
1203
1200
  }
@@ -1219,19 +1216,7 @@ export interface CreateDocumentTemplateRequest {
1219
1216
  export interface CreateGroupMemberRequest {
1220
1217
  /** @format uuid */
1221
1218
  userId: string;
1222
- loanRole:
1223
- | "Borrower"
1224
- | "CoBorrower"
1225
- | "NonBorrower"
1226
- | "LoanOfficer"
1227
- | "LoanProcessor"
1228
- | "LoanOfficerAssistant"
1229
- | "SupportingLoanOfficer"
1230
- | "BuyerAgent"
1231
- | "SellerAgent"
1232
- | "TitleInsuranceAgent"
1233
- | "EscrowAgent"
1234
- | "SettlementAgent";
1219
+ loanRole: CreateGroupMemberRequestLoanRoleEnum;
1235
1220
  }
1236
1221
 
1237
1222
  export interface CreateInviteRequest {
@@ -1243,7 +1228,7 @@ export interface CreateInviteRequest {
1243
1228
  emailAddress: string;
1244
1229
  phoneNumber?: string | null;
1245
1230
  /** @deprecated */
1246
- relationship: "NotApplicable" | "Spouse" | "NonSpouse";
1231
+ relationship: CreateInviteRequestRelationshipEnum;
1247
1232
  loanID: string;
1248
1233
  route?: string | null;
1249
1234
  /** @format uuid */
@@ -1253,6 +1238,15 @@ export interface CreateInviteRequest {
1253
1238
  loanRole?: LoanRole | null;
1254
1239
  }
1255
1240
 
1241
+ export interface CreateLoanDocumentFolderRequest {
1242
+ /**
1243
+ * @minLength 1
1244
+ * @maxLength 250
1245
+ */
1246
+ name: string;
1247
+ permissions: LoanDocumentFolderPermissionRequest[];
1248
+ }
1249
+
1256
1250
  export interface CreateLoanImportRequest {
1257
1251
  /** @format uuid */
1258
1252
  accountID: string;
@@ -1266,7 +1260,7 @@ export interface CreateLoanImportRequest {
1266
1260
  * @minLength 1
1267
1261
  */
1268
1262
  startDate: string;
1269
- importMode: "All" | "NewOnly" | "UpdateOnly";
1263
+ importMode: CreateLoanImportRequestImportModeEnum;
1270
1264
  }
1271
1265
 
1272
1266
  export interface CreateSession {
@@ -1288,19 +1282,7 @@ export interface CreateUserDeviceRequest {
1288
1282
  }
1289
1283
 
1290
1284
  export interface CreateUserDraft {
1291
- loanRole:
1292
- | "Borrower"
1293
- | "CoBorrower"
1294
- | "NonBorrower"
1295
- | "LoanOfficer"
1296
- | "LoanProcessor"
1297
- | "LoanOfficerAssistant"
1298
- | "SupportingLoanOfficer"
1299
- | "BuyerAgent"
1300
- | "SellerAgent"
1301
- | "TitleInsuranceAgent"
1302
- | "EscrowAgent"
1303
- | "SettlementAgent";
1285
+ loanRole: CreateUserDraftLoanRoleEnum;
1304
1286
  }
1305
1287
 
1306
1288
  export interface CreateUserGroupRequest {
@@ -1387,15 +1369,8 @@ export interface CustomFieldDefinition {
1387
1369
  name: string;
1388
1370
  defaultValue?: string | null;
1389
1371
  regexPattern?: string | null;
1390
- dataType:
1391
- | "String"
1392
- | "Number"
1393
- | "Decimal"
1394
- | "Boolean"
1395
- | "Date"
1396
- | "SingleSelect"
1397
- | "MultiSelect";
1398
- entityType: "Loan";
1372
+ dataType: CustomFieldDefinitionDataTypeEnum;
1373
+ entityType: CustomFieldDefinitionEntityTypeEnum;
1399
1374
  options: CustomFieldOption[];
1400
1375
  permissions: CustomFieldPermission[];
1401
1376
  encompassMapping?: EncompassMapping | null;
@@ -1410,14 +1385,7 @@ export interface CustomFieldEntry {
1410
1385
  displayOrder: number;
1411
1386
  name: string;
1412
1387
  value: string;
1413
- dataType:
1414
- | "String"
1415
- | "Number"
1416
- | "Decimal"
1417
- | "Boolean"
1418
- | "Date"
1419
- | "SingleSelect"
1420
- | "MultiSelect";
1388
+ dataType: CustomFieldEntryDataTypeEnum;
1421
1389
  }
1422
1390
 
1423
1391
  export interface CustomFieldOption {
@@ -1437,31 +1405,13 @@ export interface CustomFieldOptionRequest {
1437
1405
  export interface CustomFieldPermission {
1438
1406
  /** @format uuid */
1439
1407
  id: string;
1440
- role:
1441
- | "Borrower"
1442
- | "LoanOfficer"
1443
- | "Admin"
1444
- | "SuperAdmin"
1445
- | "Realtor"
1446
- | "SettlementAgent"
1447
- | "LoanProcessor"
1448
- | "LoanOfficerAssistant"
1449
- | "SystemAdmin";
1450
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1408
+ role: CustomFieldPermissionRoleEnum;
1409
+ accessLevel: CustomFieldPermissionAccessLevelEnum;
1451
1410
  }
1452
1411
 
1453
1412
  export interface CustomFieldPermissionRequest {
1454
- role:
1455
- | "Borrower"
1456
- | "LoanOfficer"
1457
- | "Admin"
1458
- | "SuperAdmin"
1459
- | "Realtor"
1460
- | "SettlementAgent"
1461
- | "LoanProcessor"
1462
- | "LoanOfficerAssistant"
1463
- | "SystemAdmin";
1464
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1413
+ role: CustomFieldPermissionRequestRoleEnum;
1414
+ accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
1465
1415
  }
1466
1416
 
1467
1417
  export interface CustomFieldValue {
@@ -1473,14 +1423,7 @@ export interface CustomFieldValue {
1473
1423
  customFieldDefinitionID: string;
1474
1424
  value: string;
1475
1425
  definitionName: string;
1476
- dataType:
1477
- | "String"
1478
- | "Number"
1479
- | "Decimal"
1480
- | "Boolean"
1481
- | "Date"
1482
- | "SingleSelect"
1483
- | "MultiSelect";
1426
+ dataType: CustomFieldValueDataTypeEnum;
1484
1427
  }
1485
1428
 
1486
1429
  export interface CustomLoanData {
@@ -1744,7 +1687,7 @@ export interface Draft {
1744
1687
  siteConfiguration: SiteConfigurationReduced;
1745
1688
  /** @format uuid */
1746
1689
  loanID?: string | null;
1747
- type: "NewLoan" | "EditLoan";
1690
+ type: DraftTypeEnum;
1748
1691
  isCoBorrower: boolean;
1749
1692
  }
1750
1693
 
@@ -1763,7 +1706,7 @@ export interface DraftContent {
1763
1706
  siteConfiguration: SiteConfigurationReduced;
1764
1707
  /** @format uuid */
1765
1708
  loanID?: string | null;
1766
- type: "NewLoan" | "EditLoan";
1709
+ type: DraftContentTypeEnum;
1767
1710
  isCoBorrower: boolean;
1768
1711
  applicationPayload: any;
1769
1712
  }
@@ -1807,7 +1750,6 @@ export interface EnabledServices {
1807
1750
  fullApp?: boolean | null;
1808
1751
  mobileApp?: boolean | null;
1809
1752
  ringCentral?: boolean | null;
1810
- rates?: boolean | null;
1811
1753
  socialSurvey?: boolean | null;
1812
1754
  borrowerTasks?: boolean | null;
1813
1755
  docusign?: boolean | null;
@@ -1862,7 +1804,7 @@ export interface EncompassCredentialsDetail {
1862
1804
  defaultLoanOfficerUserName?: string | null;
1863
1805
  clearStateIfUnlicensed: boolean;
1864
1806
  baseUrl?: string | null;
1865
- signingMethod: "ConsumerConnect" | "POSF";
1807
+ signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1866
1808
  subscriptionId?: string | null;
1867
1809
  environment?: string | null;
1868
1810
  }
@@ -1878,7 +1820,7 @@ export interface EncompassCredentialsRequest {
1878
1820
  defaultLoanOfficerUserName?: string | null;
1879
1821
  clearStateIfUnlicensed: boolean;
1880
1822
  baseUrl?: string | null;
1881
- signingMethod: "ConsumerConnect" | "POSF";
1823
+ signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1882
1824
  subscriptionId?: string | null;
1883
1825
  environment?: string | null;
1884
1826
  clientID?: string | null;
@@ -1973,15 +1915,8 @@ export interface EncompassRequestLog {
1973
1915
  losId?: string | null;
1974
1916
  /** @format uuid */
1975
1917
  accountId: string;
1976
- operationType:
1977
- | "FieldUpdate"
1978
- | "ConsentUpdate"
1979
- | "DocumentSync"
1980
- | "MilestoneUpdate"
1981
- | "DocumentAttachment"
1982
- | "General"
1983
- | "FieldReader";
1984
- outcome: "Success" | "Failure" | "PartialSuccess";
1918
+ operationType: EncompassRequestLogOperationTypeEnum;
1919
+ outcome: EncompassRequestLogOutcomeEnum;
1985
1920
  message: string;
1986
1921
  endpoint?: string | null;
1987
1922
  httpMethod?: string | null;
@@ -2218,20 +2153,7 @@ export interface FusionFieldDisplay {
2218
2153
  }
2219
2154
 
2220
2155
  export interface FusionReportFilter {
2221
- filterType:
2222
- | "DateGreaterThanOrEqualTo"
2223
- | "DateGreaterThan"
2224
- | "DateLessThan"
2225
- | "DateLessThanOrEqualTo"
2226
- | "DateEquals"
2227
- | "DateDoesntEqual"
2228
- | "DateNonEmpty"
2229
- | "DateEmpty"
2230
- | "StringContains"
2231
- | "StringEquals"
2232
- | "StringNotEmpty"
2233
- | "StringNotEquals"
2234
- | "StringNotContains";
2156
+ filterType: FusionReportFilterFilterTypeEnum;
2235
2157
  targetField: string;
2236
2158
  targetValue: string;
2237
2159
  }
@@ -2359,40 +2281,7 @@ export interface GuidPatchOperation {
2359
2281
  }
2360
2282
 
2361
2283
  export interface IPAddress {
2362
- addressFamily:
2363
- | "Unspecified"
2364
- | "Unix"
2365
- | "InterNetwork"
2366
- | "ImpLink"
2367
- | "Pup"
2368
- | "Chaos"
2369
- | "NS"
2370
- | "Ipx"
2371
- | "Iso"
2372
- | "Osi"
2373
- | "Ecma"
2374
- | "DataKit"
2375
- | "Ccitt"
2376
- | "Sna"
2377
- | "DecNet"
2378
- | "DataLink"
2379
- | "Lat"
2380
- | "HyperChannel"
2381
- | "AppleTalk"
2382
- | "NetBios"
2383
- | "VoiceView"
2384
- | "FireFox"
2385
- | "Banyan"
2386
- | "Atm"
2387
- | "InterNetworkV6"
2388
- | "Cluster"
2389
- | "Ieee12844"
2390
- | "Irda"
2391
- | "NetworkDesigners"
2392
- | "Max"
2393
- | "Packet"
2394
- | "ControllerAreaNetwork"
2395
- | "Unknown";
2284
+ addressFamily: IpAddressAddressFamilyEnum;
2396
2285
  /** @format int64 */
2397
2286
  scopeId: number;
2398
2287
  isIPv6Multicast: boolean;
@@ -2660,7 +2549,7 @@ export interface Loan {
2660
2549
  userLoans: UserLoan[];
2661
2550
  contacts: LoanContact[];
2662
2551
  customFields: CustomFieldEntry[];
2663
- signingMethod: "ConsumerConnect" | "POSF";
2552
+ signingMethod: LoanSigningMethodEnum;
2664
2553
  }
2665
2554
 
2666
2555
  export interface LoanApplication {
@@ -2719,7 +2608,7 @@ export interface LoanBorrower {
2719
2608
  citizenship?: LoanCitizenship | null;
2720
2609
  maritalStatus?: LoanMaritalStatus | null;
2721
2610
  languagePreference?: LoanLanguagePreference | null;
2722
- applicationStatus: "Draft" | "Complete";
2611
+ applicationStatus: LoanBorrowerApplicationStatusEnum;
2723
2612
  /** @format int32 */
2724
2613
  numberOfDependents?: number | null;
2725
2614
  isPrimaryBorrower: boolean;
@@ -3644,19 +3533,7 @@ export interface LoanContact {
3644
3533
  email?: string | null;
3645
3534
  phone?: string | null;
3646
3535
  companyName?: string | null;
3647
- role:
3648
- | "Borrower"
3649
- | "CoBorrower"
3650
- | "NonBorrower"
3651
- | "LoanOfficer"
3652
- | "LoanProcessor"
3653
- | "LoanOfficerAssistant"
3654
- | "SupportingLoanOfficer"
3655
- | "BuyerAgent"
3656
- | "SellerAgent"
3657
- | "TitleInsuranceAgent"
3658
- | "EscrowAgent"
3659
- | "SettlementAgent";
3536
+ role: LoanContactRoleEnum;
3660
3537
  }
3661
3538
 
3662
3539
  export interface LoanContactList {
@@ -3688,6 +3565,43 @@ export interface LoanDocument {
3688
3565
  sensitiveDataPurgedOn?: string | null;
3689
3566
  }
3690
3567
 
3568
+ export interface LoanDocumentFolder {
3569
+ /** @format uuid */
3570
+ id: string;
3571
+ /** @format uuid */
3572
+ accountID: string;
3573
+ name: string;
3574
+ isSystemDefault: boolean;
3575
+ isActive: boolean;
3576
+ /** @format date-time */
3577
+ createdAt: string;
3578
+ /** @format date-time */
3579
+ updatedAt?: string | null;
3580
+ /** @format date-time */
3581
+ deletedAt?: string | null;
3582
+ permissions: LoanDocumentFolderPermission[];
3583
+ }
3584
+
3585
+ export interface LoanDocumentFolderPermission {
3586
+ /** @format uuid */
3587
+ id: string;
3588
+ /** @format uuid */
3589
+ loanDocumentFolderID: string;
3590
+ role: LoanDocumentFolderPermissionRoleEnum;
3591
+ level: LoanDocumentFolderPermissionLevelEnum;
3592
+ }
3593
+
3594
+ export interface LoanDocumentFolderPermissionRequest {
3595
+ role: LoanDocumentFolderPermissionRequestRoleEnum;
3596
+ level: LoanDocumentFolderPermissionRequestLevelEnum;
3597
+ }
3598
+
3599
+ export interface LoanDocumentFolderUsage {
3600
+ /** @format uuid */
3601
+ folderID: string;
3602
+ hasEverBeenReferenced: boolean;
3603
+ }
3604
+
3691
3605
  export interface LoanDocumentPreviewsRequest {
3692
3606
  documentIds: string[];
3693
3607
  }
@@ -3797,19 +3711,14 @@ export interface LoanImport {
3797
3711
  /** @format int32 */
3798
3712
  importedCount: number;
3799
3713
  statusMessage?: string | null;
3800
- status:
3801
- | "WaitingProcess"
3802
- | "InProgress"
3803
- | "Completed"
3804
- | "Failed"
3805
- | "Cancelled";
3806
- importMode: "All" | "NewOnly" | "UpdateOnly";
3714
+ status: LoanImportStatusEnum;
3715
+ importMode: LoanImportImportModeEnum;
3807
3716
  /** @format date-time */
3808
3717
  createdAt?: string | null;
3809
3718
  }
3810
3719
 
3811
3720
  export interface LoanImportLog {
3812
- level: "None" | "Info" | "Warning" | "Error";
3721
+ level: LoanImportLogLevelEnum;
3813
3722
  message: string;
3814
3723
  /** @format date-time */
3815
3724
  createdAt: string;
@@ -3870,24 +3779,8 @@ export interface LoanListPaginated {
3870
3779
  export interface LoanLog {
3871
3780
  /** @format uuid */
3872
3781
  id: string;
3873
- level: "None" | "Info" | "Warning" | "Error";
3874
- type:
3875
- | "Loan"
3876
- | "Queue"
3877
- | "POSFlagChanged"
3878
- | "Verification"
3879
- | "DocumentUploaded"
3880
- | "LoanCreated"
3881
- | "WorkflowSubmitted"
3882
- | "UserInvitationSent"
3883
- | "CoBorrowerAdded"
3884
- | "TaskCompleted"
3885
- | "LoanStatusChanged"
3886
- | "Consent"
3887
- | "SensitiveDataPurge"
3888
- | "ClosingDateUpdated"
3889
- | "ConsumerConnectAssociation"
3890
- | "TaskReminderSent";
3782
+ level: LoanLogLevelEnum;
3783
+ type: LoanLogTypeEnum;
3891
3784
  message: string;
3892
3785
  /** @format date-time */
3893
3786
  createdAt: string;
@@ -3896,24 +3789,8 @@ export interface LoanLog {
3896
3789
  export interface LoanLogDetail {
3897
3790
  /** @format uuid */
3898
3791
  id: string;
3899
- level: "None" | "Info" | "Warning" | "Error";
3900
- type:
3901
- | "Loan"
3902
- | "Queue"
3903
- | "POSFlagChanged"
3904
- | "Verification"
3905
- | "DocumentUploaded"
3906
- | "LoanCreated"
3907
- | "WorkflowSubmitted"
3908
- | "UserInvitationSent"
3909
- | "CoBorrowerAdded"
3910
- | "TaskCompleted"
3911
- | "LoanStatusChanged"
3912
- | "Consent"
3913
- | "SensitiveDataPurge"
3914
- | "ClosingDateUpdated"
3915
- | "ConsumerConnectAssociation"
3916
- | "TaskReminderSent";
3792
+ level: LoanLogDetailLevelEnum;
3793
+ type: LoanLogDetailTypeEnum;
3917
3794
  message: string;
3918
3795
  /** @format date-time */
3919
3796
  createdAt: string;
@@ -4201,7 +4078,7 @@ export interface LoanTaskSearchRequest {
4201
4078
  }
4202
4079
 
4203
4080
  export interface LoanTaskStatusSummary {
4204
- status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
4081
+ status: LoanTaskStatusSummaryStatusEnum;
4205
4082
  /** @format int32 */
4206
4083
  count: number;
4207
4084
  }
@@ -4214,19 +4091,7 @@ export interface LoanUser {
4214
4091
  email: string;
4215
4092
  phone?: string | null;
4216
4093
  role: string;
4217
- loanRole:
4218
- | "Borrower"
4219
- | "CoBorrower"
4220
- | "NonBorrower"
4221
- | "LoanOfficer"
4222
- | "LoanProcessor"
4223
- | "LoanOfficerAssistant"
4224
- | "SupportingLoanOfficer"
4225
- | "BuyerAgent"
4226
- | "SellerAgent"
4227
- | "TitleInsuranceAgent"
4228
- | "EscrowAgent"
4229
- | "SettlementAgent";
4094
+ loanRole: LoanUserLoanRoleEnum;
4230
4095
  isUser: boolean;
4231
4096
  /** @format date-time */
4232
4097
  createdAt: string;
@@ -4262,13 +4127,7 @@ export interface LosOperationTracking {
4262
4127
  operationType: string;
4263
4128
  correlationKey: string;
4264
4129
  lastTriggerSource?: string | null;
4265
- status:
4266
- | "Pending"
4267
- | "Success"
4268
- | "Failed"
4269
- | "ConfigurationError"
4270
- | "PermanentFailure"
4271
- | "Locked";
4130
+ status: LosOperationTrackingStatusEnum;
4272
4131
  /** @format date-time */
4273
4132
  createdAt: string;
4274
4133
  /** @format date-time */
@@ -4298,6 +4157,7 @@ export interface LosSync {
4298
4157
  /** @format uuid */
4299
4158
  loanId?: string | null;
4300
4159
  direction: string;
4160
+ eventType?: string | null;
4301
4161
  currentState: string;
4302
4162
  encompassLoanId?: string | null;
4303
4163
  encompassLoanNumber?: string | null;
@@ -4331,12 +4191,13 @@ export interface LosSyncSearchCriteria {
4331
4191
  }
4332
4192
 
4333
4193
  export interface LosSyncStep {
4334
- name: string;
4335
- completed: boolean;
4336
- /** @format date-time */
4337
- completedAtUtc?: string | null;
4338
4194
  /** @format int32 */
4339
4195
  order: number;
4196
+ name: string;
4197
+ severity: LosSyncStepSeverityEnum;
4198
+ message: string;
4199
+ /** @format date-time */
4200
+ atUtc: string;
4340
4201
  }
4341
4202
 
4342
4203
  export interface LosWebhook {
@@ -4997,7 +4858,7 @@ export interface SSOTokenRequest {
4997
4858
  }
4998
4859
 
4999
4860
  export interface SamlMetadataRequest {
5000
- ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
4861
+ ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
5001
4862
  }
5002
4863
 
5003
4864
  export interface SendForgotPasswordRequest {
@@ -5055,7 +4916,7 @@ export interface SiteConfiguration {
5055
4916
  deletedAt?: string | null;
5056
4917
  /** @format uuid */
5057
4918
  id: string;
5058
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4919
+ type: SiteConfigurationTypeEnum;
5059
4920
  /** @format uuid */
5060
4921
  entityID: string;
5061
4922
  /** @format int32 */
@@ -5250,7 +5111,7 @@ export interface SiteConfigurationByUrl {
5250
5111
  deletedAt?: string | null;
5251
5112
  /** @format uuid */
5252
5113
  id: string;
5253
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5114
+ type: SiteConfigurationByUrlTypeEnum;
5254
5115
  /** @format uuid */
5255
5116
  entityID: string;
5256
5117
  /** @format int32 */
@@ -5463,7 +5324,7 @@ export interface SiteConfigurationForm {
5463
5324
  export interface SiteConfigurationReduced {
5464
5325
  /** @format uuid */
5465
5326
  id: string;
5466
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5327
+ type: SiteConfigurationReducedTypeEnum;
5467
5328
  url?: string | null;
5468
5329
  name: string;
5469
5330
  /** @format int64 */
@@ -5481,7 +5342,7 @@ export interface SiteConfigurationRequest {
5481
5342
  entityID: string;
5482
5343
  /** @format int32 */
5483
5344
  entityType: number;
5484
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5345
+ type: SiteConfigurationRequestTypeEnum;
5485
5346
  url: string;
5486
5347
  name: string;
5487
5348
  introduction?: string | null;
@@ -5658,7 +5519,7 @@ export interface SiteConfigurationSearchCriteria {
5658
5519
  export interface SiteConfigurationSummary {
5659
5520
  /** @format uuid */
5660
5521
  id: string;
5661
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5522
+ type: SiteConfigurationSummaryTypeEnum;
5662
5523
  url?: string | null;
5663
5524
  name: string;
5664
5525
  /** @format int64 */
@@ -6036,6 +5897,15 @@ export interface UpdateListingPhotoRequest {
6036
5897
  weight: number;
6037
5898
  }
6038
5899
 
5900
+ export interface UpdateLoanDocumentFolderRequest {
5901
+ /**
5902
+ * @minLength 1
5903
+ * @maxLength 250
5904
+ */
5905
+ name: string;
5906
+ permissions: LoanDocumentFolderPermissionRequest[];
5907
+ }
5908
+
6039
5909
  export interface UpdateLoanQueueRequest {
6040
5910
  data: any;
6041
5911
  }
@@ -6317,19 +6187,7 @@ export interface UserDevice {
6317
6187
  export interface UserDraft {
6318
6188
  /** @format uuid */
6319
6189
  draftID: string;
6320
- role:
6321
- | "Borrower"
6322
- | "CoBorrower"
6323
- | "NonBorrower"
6324
- | "LoanOfficer"
6325
- | "LoanProcessor"
6326
- | "LoanOfficerAssistant"
6327
- | "SupportingLoanOfficer"
6328
- | "BuyerAgent"
6329
- | "SellerAgent"
6330
- | "TitleInsuranceAgent"
6331
- | "EscrowAgent"
6332
- | "SettlementAgent";
6190
+ role: UserDraftRoleEnum;
6333
6191
  user: User;
6334
6192
  }
6335
6193
 
@@ -6356,7 +6214,7 @@ export interface UserGroupAccessScope {
6356
6214
  id: string;
6357
6215
  /** @format uuid */
6358
6216
  groupId: string;
6359
- scopeType: "User" | "Branch";
6217
+ scopeType: UserGroupAccessScopeScopeTypeEnum;
6360
6218
  /** @format uuid */
6361
6219
  userId?: string | null;
6362
6220
  /** @format uuid */
@@ -6392,24 +6250,13 @@ export interface UserLoan {
6392
6250
  deletedAt?: string | null;
6393
6251
  loanID: string;
6394
6252
  user: User;
6395
- role:
6396
- | "Borrower"
6397
- | "CoBorrower"
6398
- | "NonBorrower"
6399
- | "LoanOfficer"
6400
- | "LoanProcessor"
6401
- | "LoanOfficerAssistant"
6402
- | "SupportingLoanOfficer"
6403
- | "BuyerAgent"
6404
- | "SellerAgent"
6405
- | "TitleInsuranceAgent"
6406
- | "EscrowAgent"
6407
- | "SettlementAgent";
6253
+ role: UserLoanRoleEnum;
6408
6254
  /** @format int32 */
6409
6255
  borrowerPair?: number | null;
6410
6256
  /** @format int32 */
6411
6257
  borrowerPosition?: number | null;
6412
6258
  customLoanData?: CustomLoanData | null;
6259
+ consents: UserLoanConsent[];
6413
6260
  }
6414
6261
 
6415
6262
  export interface UserLoanConsent {
@@ -6417,12 +6264,16 @@ export interface UserLoanConsent {
6417
6264
  id: string;
6418
6265
  /** @format uuid */
6419
6266
  userLoanID: string;
6420
- type: "Econsent" | "CreditAuthorization" | "Tcpa";
6267
+ type: UserLoanConsentTypeEnum;
6421
6268
  providedConsent: boolean;
6422
6269
  ipAddress?: string | null;
6423
- losSyncStatus: "NotStarted" | "Failed" | "Success";
6270
+ losSyncStatus: UserLoanConsentLosSyncStatusEnum;
6424
6271
  /** @format date-time */
6425
6272
  createdAt: string;
6273
+ /** @format date-time */
6274
+ updatedAt?: string | null;
6275
+ /** @format date-time */
6276
+ deletedAt?: string | null;
6426
6277
  }
6427
6278
 
6428
6279
  export interface UserLoanTask {
@@ -6571,16 +6422,7 @@ export interface UserSummary {
6571
6422
  id: string;
6572
6423
  name?: string | null;
6573
6424
  email?: string | null;
6574
- role:
6575
- | "Borrower"
6576
- | "LoanOfficer"
6577
- | "Admin"
6578
- | "SuperAdmin"
6579
- | "Realtor"
6580
- | "SettlementAgent"
6581
- | "LoanProcessor"
6582
- | "LoanOfficerAssistant"
6583
- | "SystemAdmin";
6425
+ role: UserSummaryRoleEnum;
6584
6426
  }
6585
6427
 
6586
6428
  export interface VerifyPasswordRequest {
@@ -6616,158 +6458,640 @@ export interface Workflow {
6616
6458
  icon: string;
6617
6459
  }
6618
6460
 
6619
- import type {
6620
- AxiosInstance,
6621
- AxiosRequestConfig,
6622
- AxiosResponse,
6623
- HeadersDefaults,
6624
- ResponseType,
6625
- } from "axios";
6626
- import axios from "axios";
6461
+ export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
6627
6462
 
6628
- export type QueryParamsType = Record<string | number, any>;
6463
+ export type AuditLogEntryChangeTypeEnum =
6464
+ | "Created"
6465
+ | "Modified"
6466
+ | "SoftDeleted"
6467
+ | "HardDeleted"
6468
+ | "Restored";
6629
6469
 
6630
- export interface FullRequestParams
6631
- extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
6632
- /** set parameter to `true` for call `securityWorker` for this request */
6633
- secure?: boolean;
6634
- /** request path */
6635
- path: string;
6636
- /** content type of request body */
6637
- type?: ContentType;
6638
- /** query params */
6639
- query?: QueryParamsType;
6640
- /** format of response (i.e. response.json() -> format: "json") */
6641
- format?: ResponseType;
6642
- /** request body */
6643
- body?: unknown;
6644
- }
6470
+ export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
6645
6471
 
6646
- export type RequestParams = Omit<
6647
- FullRequestParams,
6648
- "body" | "method" | "query" | "path"
6649
- >;
6472
+ export type CreateAccountRequestEnvironmentEnum =
6473
+ | "Development"
6474
+ | "Staging"
6475
+ | "UAT"
6476
+ | "Production";
6650
6477
 
6651
- export interface ApiConfig<SecurityDataType = unknown>
6652
- extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
6653
- securityWorker?: (
6654
- securityData: SecurityDataType | null,
6655
- ) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
6656
- secure?: boolean;
6657
- format?: ResponseType;
6658
- }
6478
+ export type CreateCustomFieldDefinitionRequestDataTypeEnum =
6479
+ | "String"
6480
+ | "Number"
6481
+ | "Decimal"
6482
+ | "Boolean"
6483
+ | "Date"
6484
+ | "SingleSelect"
6485
+ | "MultiSelect";
6659
6486
 
6660
- export enum ContentType {
6661
- JsonPatch = "application/json-patch+json",
6662
- Json = "application/json",
6663
- JsonApi = "application/vnd.api+json",
6664
- FormData = "multipart/form-data",
6665
- UrlEncoded = "application/x-www-form-urlencoded",
6666
- Text = "text/plain",
6667
- }
6487
+ export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
6668
6488
 
6669
- export class HttpClient<SecurityDataType = unknown> {
6670
- public instance: AxiosInstance;
6671
- private securityData: SecurityDataType | null = null;
6672
- private securityWorker?: ApiConfig<SecurityDataType>["securityWorker"];
6673
- private secure?: boolean;
6674
- private format?: ResponseType;
6489
+ export type CreateGroupMemberRequestLoanRoleEnum =
6490
+ | "Borrower"
6491
+ | "CoBorrower"
6492
+ | "NonBorrower"
6493
+ | "LoanOfficer"
6494
+ | "LoanProcessor"
6495
+ | "LoanOfficerAssistant"
6496
+ | "SupportingLoanOfficer"
6497
+ | "BuyerAgent"
6498
+ | "SellerAgent"
6499
+ | "TitleInsuranceAgent"
6500
+ | "EscrowAgent"
6501
+ | "SettlementAgent"
6502
+ | "Admin";
6675
6503
 
6676
- constructor({
6677
- securityWorker,
6678
- secure,
6679
- format,
6680
- ...axiosConfig
6681
- }: ApiConfig<SecurityDataType> = {}) {
6682
- this.instance = axios.create({
6683
- ...axiosConfig,
6684
- baseURL: axiosConfig.baseURL || "",
6685
- });
6686
- this.secure = secure;
6687
- this.format = format;
6688
- this.securityWorker = securityWorker;
6689
- }
6504
+ /** @deprecated */
6505
+ export type CreateInviteRequestRelationshipEnum =
6506
+ | "NotApplicable"
6507
+ | "Spouse"
6508
+ | "NonSpouse";
6690
6509
 
6691
- public setSecurityData = (data: SecurityDataType | null) => {
6692
- this.securityData = data;
6693
- };
6510
+ export type CreateLoanImportRequestImportModeEnum =
6511
+ | "All"
6512
+ | "NewOnly"
6513
+ | "UpdateOnly";
6694
6514
 
6695
- protected mergeRequestParams(
6696
- params1: AxiosRequestConfig,
6697
- params2?: AxiosRequestConfig,
6698
- ): AxiosRequestConfig {
6699
- const method = params1.method || (params2 && params2.method);
6515
+ export type CreateUserDraftLoanRoleEnum =
6516
+ | "Borrower"
6517
+ | "CoBorrower"
6518
+ | "NonBorrower"
6519
+ | "LoanOfficer"
6520
+ | "LoanProcessor"
6521
+ | "LoanOfficerAssistant"
6522
+ | "SupportingLoanOfficer"
6523
+ | "BuyerAgent"
6524
+ | "SellerAgent"
6525
+ | "TitleInsuranceAgent"
6526
+ | "EscrowAgent"
6527
+ | "SettlementAgent"
6528
+ | "Admin";
6700
6529
 
6701
- return {
6702
- ...this.instance.defaults,
6703
- ...params1,
6704
- ...(params2 || {}),
6705
- headers: {
6706
- ...((method &&
6707
- this.instance.defaults.headers[
6708
- method.toLowerCase() as keyof HeadersDefaults
6709
- ]) ||
6710
- {}),
6711
- ...(params1.headers || {}),
6712
- ...((params2 && params2.headers) || {}),
6713
- },
6714
- };
6715
- }
6530
+ export type CustomFieldDefinitionDataTypeEnum =
6531
+ | "String"
6532
+ | "Number"
6533
+ | "Decimal"
6534
+ | "Boolean"
6535
+ | "Date"
6536
+ | "SingleSelect"
6537
+ | "MultiSelect";
6716
6538
 
6717
- protected stringifyFormItem(formItem: unknown) {
6718
- if (typeof formItem === "object" && formItem !== null) {
6719
- return JSON.stringify(formItem);
6720
- } else {
6721
- return `${formItem}`;
6722
- }
6723
- }
6539
+ export type CustomFieldDefinitionEntityTypeEnum = "Loan";
6724
6540
 
6725
- protected createFormData(input: Record<string, unknown>): FormData {
6726
- if (input instanceof FormData) {
6727
- return input;
6728
- }
6729
- return Object.keys(input || {}).reduce((formData, key) => {
6730
- const property = input[key];
6731
- const propertyContent: any[] =
6732
- property instanceof Array ? property : [property];
6541
+ export type CustomFieldEntryDataTypeEnum =
6542
+ | "String"
6543
+ | "Number"
6544
+ | "Decimal"
6545
+ | "Boolean"
6546
+ | "Date"
6547
+ | "SingleSelect"
6548
+ | "MultiSelect";
6733
6549
 
6734
- for (const formItem of propertyContent) {
6735
- const isFileType = formItem instanceof Blob || formItem instanceof File;
6736
- formData.append(
6737
- key,
6738
- isFileType ? formItem : this.stringifyFormItem(formItem),
6739
- );
6740
- }
6550
+ export type CustomFieldPermissionRoleEnum =
6551
+ | "Borrower"
6552
+ | "LoanOfficer"
6553
+ | "Admin"
6554
+ | "SuperAdmin"
6555
+ | "Realtor"
6556
+ | "SettlementAgent"
6557
+ | "LoanProcessor"
6558
+ | "LoanOfficerAssistant"
6559
+ | "SystemAdmin";
6741
6560
 
6742
- return formData;
6743
- }, new FormData());
6744
- }
6561
+ export type CustomFieldPermissionAccessLevelEnum =
6562
+ | "NoAccess"
6563
+ | "ReadOnly"
6564
+ | "ReadWrite";
6745
6565
 
6746
- public request = async <T = any, _E = any>({
6747
- secure,
6748
- path,
6749
- type,
6750
- query,
6751
- format,
6752
- body,
6753
- ...params
6754
- }: FullRequestParams): Promise<AxiosResponse<T>> => {
6755
- const secureParams =
6756
- ((typeof secure === "boolean" ? secure : this.secure) &&
6757
- this.securityWorker &&
6758
- (await this.securityWorker(this.securityData))) ||
6759
- {};
6760
- const requestParams = this.mergeRequestParams(params, secureParams);
6761
- const responseFormat = format || this.format || undefined;
6566
+ export type CustomFieldPermissionRequestRoleEnum =
6567
+ | "Borrower"
6568
+ | "LoanOfficer"
6569
+ | "Admin"
6570
+ | "SuperAdmin"
6571
+ | "Realtor"
6572
+ | "SettlementAgent"
6573
+ | "LoanProcessor"
6574
+ | "LoanOfficerAssistant"
6575
+ | "SystemAdmin";
6762
6576
 
6763
- if (
6764
- type === ContentType.FormData &&
6765
- body &&
6766
- body !== null &&
6767
- typeof body === "object"
6768
- ) {
6769
- body = this.createFormData(body as Record<string, unknown>);
6770
- }
6577
+ export type CustomFieldPermissionRequestAccessLevelEnum =
6578
+ | "NoAccess"
6579
+ | "ReadOnly"
6580
+ | "ReadWrite";
6581
+
6582
+ export type CustomFieldValueDataTypeEnum =
6583
+ | "String"
6584
+ | "Number"
6585
+ | "Decimal"
6586
+ | "Boolean"
6587
+ | "Date"
6588
+ | "SingleSelect"
6589
+ | "MultiSelect";
6590
+
6591
+ export type DraftTypeEnum = "NewLoan" | "EditLoan";
6592
+
6593
+ export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
6594
+
6595
+ export type EncompassCredentialsDetailSigningMethodEnum =
6596
+ | "ConsumerConnect"
6597
+ | "POSF";
6598
+
6599
+ export type EncompassCredentialsRequestSigningMethodEnum =
6600
+ | "ConsumerConnect"
6601
+ | "POSF";
6602
+
6603
+ export type EncompassRequestLogOperationTypeEnum =
6604
+ | "FieldUpdate"
6605
+ | "ConsentUpdate"
6606
+ | "DocumentSync"
6607
+ | "MilestoneUpdate"
6608
+ | "DocumentAttachment"
6609
+ | "General"
6610
+ | "FieldReader";
6611
+
6612
+ export type EncompassRequestLogOutcomeEnum =
6613
+ | "Success"
6614
+ | "Failure"
6615
+ | "PartialSuccess";
6616
+
6617
+ export type FusionReportFilterFilterTypeEnum =
6618
+ | "DateGreaterThanOrEqualTo"
6619
+ | "DateGreaterThan"
6620
+ | "DateLessThan"
6621
+ | "DateLessThanOrEqualTo"
6622
+ | "DateEquals"
6623
+ | "DateDoesntEqual"
6624
+ | "DateNonEmpty"
6625
+ | "DateEmpty"
6626
+ | "StringContains"
6627
+ | "StringEquals"
6628
+ | "StringNotEmpty"
6629
+ | "StringNotEquals"
6630
+ | "StringNotContains";
6631
+
6632
+ export type IpAddressAddressFamilyEnum =
6633
+ | "Unspecified"
6634
+ | "Unix"
6635
+ | "InterNetwork"
6636
+ | "ImpLink"
6637
+ | "Pup"
6638
+ | "Chaos"
6639
+ | "NS"
6640
+ | "Ipx"
6641
+ | "Iso"
6642
+ | "Osi"
6643
+ | "Ecma"
6644
+ | "DataKit"
6645
+ | "Ccitt"
6646
+ | "Sna"
6647
+ | "DecNet"
6648
+ | "DataLink"
6649
+ | "Lat"
6650
+ | "HyperChannel"
6651
+ | "AppleTalk"
6652
+ | "NetBios"
6653
+ | "VoiceView"
6654
+ | "FireFox"
6655
+ | "Banyan"
6656
+ | "Atm"
6657
+ | "InterNetworkV6"
6658
+ | "Cluster"
6659
+ | "Ieee12844"
6660
+ | "Irda"
6661
+ | "NetworkDesigners"
6662
+ | "Max"
6663
+ | "Packet"
6664
+ | "ControllerAreaNetwork"
6665
+ | "Unknown";
6666
+
6667
+ export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
6668
+
6669
+ export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
6670
+
6671
+ export type LoanContactRoleEnum =
6672
+ | "Borrower"
6673
+ | "CoBorrower"
6674
+ | "NonBorrower"
6675
+ | "LoanOfficer"
6676
+ | "LoanProcessor"
6677
+ | "LoanOfficerAssistant"
6678
+ | "SupportingLoanOfficer"
6679
+ | "BuyerAgent"
6680
+ | "SellerAgent"
6681
+ | "TitleInsuranceAgent"
6682
+ | "EscrowAgent"
6683
+ | "SettlementAgent"
6684
+ | "Admin";
6685
+
6686
+ export type LoanDocumentFolderPermissionRoleEnum =
6687
+ | "Borrower"
6688
+ | "CoBorrower"
6689
+ | "NonBorrower"
6690
+ | "LoanOfficer"
6691
+ | "LoanProcessor"
6692
+ | "LoanOfficerAssistant"
6693
+ | "SupportingLoanOfficer"
6694
+ | "BuyerAgent"
6695
+ | "SellerAgent"
6696
+ | "TitleInsuranceAgent"
6697
+ | "EscrowAgent"
6698
+ | "SettlementAgent"
6699
+ | "Admin";
6700
+
6701
+ export type LoanDocumentFolderPermissionLevelEnum =
6702
+ | "None"
6703
+ | "Read"
6704
+ | "Write"
6705
+ | "Manage";
6706
+
6707
+ export type LoanDocumentFolderPermissionRequestRoleEnum =
6708
+ | "Borrower"
6709
+ | "CoBorrower"
6710
+ | "NonBorrower"
6711
+ | "LoanOfficer"
6712
+ | "LoanProcessor"
6713
+ | "LoanOfficerAssistant"
6714
+ | "SupportingLoanOfficer"
6715
+ | "BuyerAgent"
6716
+ | "SellerAgent"
6717
+ | "TitleInsuranceAgent"
6718
+ | "EscrowAgent"
6719
+ | "SettlementAgent"
6720
+ | "Admin";
6721
+
6722
+ export type LoanDocumentFolderPermissionRequestLevelEnum =
6723
+ | "None"
6724
+ | "Read"
6725
+ | "Write"
6726
+ | "Manage";
6727
+
6728
+ export type LoanImportStatusEnum =
6729
+ | "WaitingProcess"
6730
+ | "InProgress"
6731
+ | "Completed"
6732
+ | "Failed"
6733
+ | "Cancelled";
6734
+
6735
+ export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6736
+
6737
+ export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6738
+
6739
+ export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6740
+
6741
+ export type LoanLogTypeEnum =
6742
+ | "Loan"
6743
+ | "Queue"
6744
+ | "POSFlagChanged"
6745
+ | "Verification"
6746
+ | "DocumentUploaded"
6747
+ | "LoanCreated"
6748
+ | "WorkflowSubmitted"
6749
+ | "UserInvitationSent"
6750
+ | "CoBorrowerAdded"
6751
+ | "TaskCompleted"
6752
+ | "LoanStatusChanged"
6753
+ | "Consent"
6754
+ | "SensitiveDataPurge"
6755
+ | "ClosingDateUpdated"
6756
+ | "ConsumerConnectAssociation"
6757
+ | "TaskReminderSent";
6758
+
6759
+ export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
6760
+
6761
+ export type LoanLogDetailTypeEnum =
6762
+ | "Loan"
6763
+ | "Queue"
6764
+ | "POSFlagChanged"
6765
+ | "Verification"
6766
+ | "DocumentUploaded"
6767
+ | "LoanCreated"
6768
+ | "WorkflowSubmitted"
6769
+ | "UserInvitationSent"
6770
+ | "CoBorrowerAdded"
6771
+ | "TaskCompleted"
6772
+ | "LoanStatusChanged"
6773
+ | "Consent"
6774
+ | "SensitiveDataPurge"
6775
+ | "ClosingDateUpdated"
6776
+ | "ConsumerConnectAssociation"
6777
+ | "TaskReminderSent";
6778
+
6779
+ export type LoanTaskStatusSummaryStatusEnum =
6780
+ | "Outstanding"
6781
+ | "Pending"
6782
+ | "Completed"
6783
+ | "Rejected"
6784
+ | "Unknown";
6785
+
6786
+ export type LoanUserLoanRoleEnum =
6787
+ | "Borrower"
6788
+ | "CoBorrower"
6789
+ | "NonBorrower"
6790
+ | "LoanOfficer"
6791
+ | "LoanProcessor"
6792
+ | "LoanOfficerAssistant"
6793
+ | "SupportingLoanOfficer"
6794
+ | "BuyerAgent"
6795
+ | "SellerAgent"
6796
+ | "TitleInsuranceAgent"
6797
+ | "EscrowAgent"
6798
+ | "SettlementAgent"
6799
+ | "Admin";
6800
+
6801
+ export type LosOperationTrackingStatusEnum =
6802
+ | "Pending"
6803
+ | "Success"
6804
+ | "Failed"
6805
+ | "ConfigurationError"
6806
+ | "PermanentFailure"
6807
+ | "Locked";
6808
+
6809
+ export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
6810
+
6811
+ export type SamlMetadataRequestSsoIntegrationEnum =
6812
+ | "ConsumerConnect"
6813
+ | "TheBigPOS"
6814
+ | "POSF";
6815
+
6816
+ export type SiteConfigurationTypeEnum =
6817
+ | "None"
6818
+ | "Account"
6819
+ | "Corporate"
6820
+ | "Branch"
6821
+ | "LoanOfficer"
6822
+ | "Partner";
6823
+
6824
+ export type SiteConfigurationByUrlTypeEnum =
6825
+ | "None"
6826
+ | "Account"
6827
+ | "Corporate"
6828
+ | "Branch"
6829
+ | "LoanOfficer"
6830
+ | "Partner";
6831
+
6832
+ export type SiteConfigurationReducedTypeEnum =
6833
+ | "None"
6834
+ | "Account"
6835
+ | "Corporate"
6836
+ | "Branch"
6837
+ | "LoanOfficer"
6838
+ | "Partner";
6839
+
6840
+ export type SiteConfigurationRequestTypeEnum =
6841
+ | "None"
6842
+ | "Account"
6843
+ | "Corporate"
6844
+ | "Branch"
6845
+ | "LoanOfficer"
6846
+ | "Partner";
6847
+
6848
+ export type SiteConfigurationSummaryTypeEnum =
6849
+ | "None"
6850
+ | "Account"
6851
+ | "Corporate"
6852
+ | "Branch"
6853
+ | "LoanOfficer"
6854
+ | "Partner";
6855
+
6856
+ export type UserDraftRoleEnum =
6857
+ | "Borrower"
6858
+ | "CoBorrower"
6859
+ | "NonBorrower"
6860
+ | "LoanOfficer"
6861
+ | "LoanProcessor"
6862
+ | "LoanOfficerAssistant"
6863
+ | "SupportingLoanOfficer"
6864
+ | "BuyerAgent"
6865
+ | "SellerAgent"
6866
+ | "TitleInsuranceAgent"
6867
+ | "EscrowAgent"
6868
+ | "SettlementAgent"
6869
+ | "Admin";
6870
+
6871
+ export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
6872
+
6873
+ export type UserLoanRoleEnum =
6874
+ | "Borrower"
6875
+ | "CoBorrower"
6876
+ | "NonBorrower"
6877
+ | "LoanOfficer"
6878
+ | "LoanProcessor"
6879
+ | "LoanOfficerAssistant"
6880
+ | "SupportingLoanOfficer"
6881
+ | "BuyerAgent"
6882
+ | "SellerAgent"
6883
+ | "TitleInsuranceAgent"
6884
+ | "EscrowAgent"
6885
+ | "SettlementAgent"
6886
+ | "Admin";
6887
+
6888
+ export type UserLoanConsentTypeEnum =
6889
+ | "Econsent"
6890
+ | "CreditAuthorization"
6891
+ | "Tcpa";
6892
+
6893
+ export type UserLoanConsentLosSyncStatusEnum =
6894
+ | "NotStarted"
6895
+ | "Failed"
6896
+ | "Success";
6897
+
6898
+ export type UserSummaryRoleEnum =
6899
+ | "Borrower"
6900
+ | "LoanOfficer"
6901
+ | "Admin"
6902
+ | "SuperAdmin"
6903
+ | "Realtor"
6904
+ | "SettlementAgent"
6905
+ | "LoanProcessor"
6906
+ | "LoanOfficerAssistant"
6907
+ | "SystemAdmin";
6908
+
6909
+ export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
6910
+
6911
+ /** @default "Realtor" */
6912
+ export type GetPartnersParamsRoleEnum =
6913
+ | "Borrower"
6914
+ | "LoanOfficer"
6915
+ | "Admin"
6916
+ | "SuperAdmin"
6917
+ | "Realtor"
6918
+ | "SettlementAgent"
6919
+ | "LoanProcessor"
6920
+ | "LoanOfficerAssistant"
6921
+ | "SystemAdmin";
6922
+
6923
+ export type GetSamlMetadataParamsSSoIntegrationEnum =
6924
+ | "ConsumerConnect"
6925
+ | "TheBigPOS"
6926
+ | "POSF";
6927
+
6928
+ export type GetSamlMetadataParamsEnum =
6929
+ | "ConsumerConnect"
6930
+ | "TheBigPOS"
6931
+ | "POSF";
6932
+
6933
+ export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum =
6934
+ | "ConsumerConnect"
6935
+ | "TheBigPOS"
6936
+ | "POSF";
6937
+
6938
+ export type CreateOrReplaceSamlMetadataParamsEnum =
6939
+ | "ConsumerConnect"
6940
+ | "TheBigPOS"
6941
+ | "POSF";
6942
+
6943
+ import type {
6944
+ AxiosInstance,
6945
+ AxiosRequestConfig,
6946
+ AxiosResponse,
6947
+ HeadersDefaults,
6948
+ ResponseType,
6949
+ } from "axios";
6950
+ import axios from "axios";
6951
+
6952
+ export type QueryParamsType = Record<string | number, any>;
6953
+
6954
+ export interface FullRequestParams
6955
+ extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
6956
+ /** set parameter to `true` for call `securityWorker` for this request */
6957
+ secure?: boolean;
6958
+ /** request path */
6959
+ path: string;
6960
+ /** content type of request body */
6961
+ type?: ContentType;
6962
+ /** query params */
6963
+ query?: QueryParamsType;
6964
+ /** format of response (i.e. response.json() -> format: "json") */
6965
+ format?: ResponseType;
6966
+ /** request body */
6967
+ body?: unknown;
6968
+ }
6969
+
6970
+ export type RequestParams = Omit<
6971
+ FullRequestParams,
6972
+ "body" | "method" | "query" | "path"
6973
+ >;
6974
+
6975
+ export interface ApiConfig<SecurityDataType = unknown>
6976
+ extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
6977
+ securityWorker?: (
6978
+ securityData: SecurityDataType | null,
6979
+ ) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
6980
+ secure?: boolean;
6981
+ format?: ResponseType;
6982
+ }
6983
+
6984
+ export enum ContentType {
6985
+ JsonPatch = "application/json-patch+json",
6986
+ Json = "application/json",
6987
+ JsonApi = "application/vnd.api+json",
6988
+ FormData = "multipart/form-data",
6989
+ UrlEncoded = "application/x-www-form-urlencoded",
6990
+ Text = "text/plain",
6991
+ }
6992
+
6993
+ export class HttpClient<SecurityDataType = unknown> {
6994
+ public instance: AxiosInstance;
6995
+ private securityData: SecurityDataType | null = null;
6996
+ private securityWorker?: ApiConfig<SecurityDataType>["securityWorker"];
6997
+ private secure?: boolean;
6998
+ private format?: ResponseType;
6999
+
7000
+ constructor({
7001
+ securityWorker,
7002
+ secure,
7003
+ format,
7004
+ ...axiosConfig
7005
+ }: ApiConfig<SecurityDataType> = {}) {
7006
+ this.instance = axios.create({
7007
+ ...axiosConfig,
7008
+ baseURL: axiosConfig.baseURL || "",
7009
+ });
7010
+ this.secure = secure;
7011
+ this.format = format;
7012
+ this.securityWorker = securityWorker;
7013
+ }
7014
+
7015
+ public setSecurityData = (data: SecurityDataType | null) => {
7016
+ this.securityData = data;
7017
+ };
7018
+
7019
+ protected mergeRequestParams(
7020
+ params1: AxiosRequestConfig,
7021
+ params2?: AxiosRequestConfig,
7022
+ ): AxiosRequestConfig {
7023
+ const method = params1.method || (params2 && params2.method);
7024
+
7025
+ return {
7026
+ ...this.instance.defaults,
7027
+ ...params1,
7028
+ ...(params2 || {}),
7029
+ headers: {
7030
+ ...((method &&
7031
+ this.instance.defaults.headers[
7032
+ method.toLowerCase() as keyof HeadersDefaults
7033
+ ]) ||
7034
+ {}),
7035
+ ...(params1.headers || {}),
7036
+ ...((params2 && params2.headers) || {}),
7037
+ },
7038
+ };
7039
+ }
7040
+
7041
+ protected stringifyFormItem(formItem: unknown) {
7042
+ if (typeof formItem === "object" && formItem !== null) {
7043
+ return JSON.stringify(formItem);
7044
+ } else {
7045
+ return `${formItem}`;
7046
+ }
7047
+ }
7048
+
7049
+ protected createFormData(input: Record<string, unknown>): FormData {
7050
+ if (input instanceof FormData) {
7051
+ return input;
7052
+ }
7053
+ return Object.keys(input || {}).reduce((formData, key) => {
7054
+ const property = input[key];
7055
+ const propertyContent: any[] =
7056
+ property instanceof Array ? property : [property];
7057
+
7058
+ for (const formItem of propertyContent) {
7059
+ const isFileType = formItem instanceof Blob || formItem instanceof File;
7060
+ formData.append(
7061
+ key,
7062
+ isFileType ? formItem : this.stringifyFormItem(formItem),
7063
+ );
7064
+ }
7065
+
7066
+ return formData;
7067
+ }, new FormData());
7068
+ }
7069
+
7070
+ public request = async <T = any, _E = any>({
7071
+ secure,
7072
+ path,
7073
+ type,
7074
+ query,
7075
+ format,
7076
+ body,
7077
+ ...params
7078
+ }: FullRequestParams): Promise<AxiosResponse<T>> => {
7079
+ const secureParams =
7080
+ ((typeof secure === "boolean" ? secure : this.secure) &&
7081
+ this.securityWorker &&
7082
+ (await this.securityWorker(this.securityData))) ||
7083
+ {};
7084
+ const requestParams = this.mergeRequestParams(params, secureParams);
7085
+ const responseFormat = format || this.format || undefined;
7086
+
7087
+ if (
7088
+ type === ContentType.FormData &&
7089
+ body &&
7090
+ body !== null &&
7091
+ typeof body === "object"
7092
+ ) {
7093
+ body = this.createFormData(body as Record<string, unknown>);
7094
+ }
6771
7095
 
6772
7096
  if (
6773
7097
  type === ContentType.Text &&
@@ -6794,7 +7118,7 @@ export class HttpClient<SecurityDataType = unknown> {
6794
7118
 
6795
7119
  /**
6796
7120
  * @title The Big POS API
6797
- * @version v2.39.0
7121
+ * @version v2.40.0
6798
7122
  * @termsOfService https://www.thebigpos.com/terms-of-use/
6799
7123
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
6800
7124
  */
@@ -8013,7 +8337,7 @@ export class Api<
8013
8337
  */
8014
8338
  getCustomFieldDefinitions: (
8015
8339
  query?: {
8016
- entityType?: "Loan";
8340
+ entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
8017
8341
  },
8018
8342
  params: RequestParams = {},
8019
8343
  ) =>
@@ -10333,6 +10657,26 @@ export class Api<
10333
10657
  ...params,
10334
10658
  }),
10335
10659
 
10660
+ /**
10661
+ * No description
10662
+ *
10663
+ * @tags LoanConsents
10664
+ * @name ResyncLoanConsents
10665
+ * @summary Resync loan consents to LOS
10666
+ * @request POST:/api/loans/{loanId}/consents/resync
10667
+ * @secure
10668
+ * @response `204` `void` No Content
10669
+ * @response `404` `ProblemDetails` Not Found
10670
+ * @response `422` `ProblemDetails` Client Error
10671
+ */
10672
+ resyncLoanConsents: (loanId: string, params: RequestParams = {}) =>
10673
+ this.request<void, ProblemDetails>({
10674
+ path: `/api/loans/${loanId}/consents/resync`,
10675
+ method: "POST",
10676
+ secure: true,
10677
+ ...params,
10678
+ }),
10679
+
10336
10680
  /**
10337
10681
  * No description
10338
10682
  *
@@ -10473,6 +10817,180 @@ export class Api<
10473
10817
  ...params,
10474
10818
  }),
10475
10819
 
10820
+ /**
10821
+ * No description
10822
+ *
10823
+ * @tags LoanDocumentFolders
10824
+ * @name GetAllLoanDocumentFolders
10825
+ * @summary Get all loan document folders for the current account
10826
+ * @request GET:/api/loan-document-folders
10827
+ * @secure
10828
+ * @response `200` `(LoanDocumentFolder)[]` Success
10829
+ */
10830
+ getAllLoanDocumentFolders: (params: RequestParams = {}) =>
10831
+ this.request<LoanDocumentFolder[], any>({
10832
+ path: `/api/loan-document-folders`,
10833
+ method: "GET",
10834
+ secure: true,
10835
+ format: "json",
10836
+ ...params,
10837
+ }),
10838
+
10839
+ /**
10840
+ * No description
10841
+ *
10842
+ * @tags LoanDocumentFolders
10843
+ * @name CreateLoanDocumentFolder
10844
+ * @summary Create a loan document folder
10845
+ * @request POST:/api/loan-document-folders
10846
+ * @secure
10847
+ * @response `201` `LoanDocumentFolder` Created
10848
+ * @response `409` `ProblemDetails` Conflict
10849
+ * @response `422` `ProblemDetails` Client Error
10850
+ */
10851
+ createLoanDocumentFolder: (
10852
+ data: CreateLoanDocumentFolderRequest,
10853
+ params: RequestParams = {},
10854
+ ) =>
10855
+ this.request<LoanDocumentFolder, ProblemDetails>({
10856
+ path: `/api/loan-document-folders`,
10857
+ method: "POST",
10858
+ body: data,
10859
+ secure: true,
10860
+ type: ContentType.Json,
10861
+ format: "json",
10862
+ ...params,
10863
+ }),
10864
+
10865
+ /**
10866
+ * No description
10867
+ *
10868
+ * @tags LoanDocumentFolders
10869
+ * @name GetLoanDocumentFolderById
10870
+ * @summary Get a loan document folder by ID
10871
+ * @request GET:/api/loan-document-folders/{id}
10872
+ * @secure
10873
+ * @response `200` `LoanDocumentFolder` Success
10874
+ * @response `404` `ProblemDetails` Not Found
10875
+ */
10876
+ getLoanDocumentFolderById: (id: string, params: RequestParams = {}) =>
10877
+ this.request<LoanDocumentFolder, ProblemDetails>({
10878
+ path: `/api/loan-document-folders/${id}`,
10879
+ method: "GET",
10880
+ secure: true,
10881
+ format: "json",
10882
+ ...params,
10883
+ }),
10884
+
10885
+ /**
10886
+ * No description
10887
+ *
10888
+ * @tags LoanDocumentFolders
10889
+ * @name UpdateLoanDocumentFolder
10890
+ * @summary Update a loan document folder. Blocked when folder has ever been referenced, except for permission edits on the system-default Unassigned folder.
10891
+ * @request PUT:/api/loan-document-folders/{id}
10892
+ * @secure
10893
+ * @response `200` `LoanDocumentFolder` Success
10894
+ * @response `400` `ProblemDetails` Bad Request
10895
+ * @response `404` `ProblemDetails` Not Found
10896
+ * @response `409` `ProblemDetails` Conflict
10897
+ * @response `422` `ProblemDetails` Client Error
10898
+ */
10899
+ updateLoanDocumentFolder: (
10900
+ id: string,
10901
+ data: UpdateLoanDocumentFolderRequest,
10902
+ params: RequestParams = {},
10903
+ ) =>
10904
+ this.request<LoanDocumentFolder, ProblemDetails>({
10905
+ path: `/api/loan-document-folders/${id}`,
10906
+ method: "PUT",
10907
+ body: data,
10908
+ secure: true,
10909
+ type: ContentType.Json,
10910
+ format: "json",
10911
+ ...params,
10912
+ }),
10913
+
10914
+ /**
10915
+ * No description
10916
+ *
10917
+ * @tags LoanDocumentFolders
10918
+ * @name DeleteLoanDocumentFolder
10919
+ * @summary Delete a loan document folder. Allowed only when the folder has never been referenced and is not the system-default Unassigned folder.
10920
+ * @request DELETE:/api/loan-document-folders/{id}
10921
+ * @secure
10922
+ * @response `204` `void` No Content
10923
+ * @response `400` `ProblemDetails` Bad Request
10924
+ * @response `404` `ProblemDetails` Not Found
10925
+ * @response `409` `ProblemDetails` Conflict
10926
+ */
10927
+ deleteLoanDocumentFolder: (id: string, params: RequestParams = {}) =>
10928
+ this.request<void, ProblemDetails>({
10929
+ path: `/api/loan-document-folders/${id}`,
10930
+ method: "DELETE",
10931
+ secure: true,
10932
+ ...params,
10933
+ }),
10934
+
10935
+ /**
10936
+ * No description
10937
+ *
10938
+ * @tags LoanDocumentFolders
10939
+ * @name DeactivateLoanDocumentFolder
10940
+ * @summary Deactivate a loan document folder. Rejected for the system-default Unassigned folder.
10941
+ * @request POST:/api/loan-document-folders/{id}/deactivate
10942
+ * @secure
10943
+ * @response `204` `void` No Content
10944
+ * @response `400` `ProblemDetails` Bad Request
10945
+ * @response `404` `ProblemDetails` Not Found
10946
+ */
10947
+ deactivateLoanDocumentFolder: (id: string, params: RequestParams = {}) =>
10948
+ this.request<void, ProblemDetails>({
10949
+ path: `/api/loan-document-folders/${id}/deactivate`,
10950
+ method: "POST",
10951
+ secure: true,
10952
+ ...params,
10953
+ }),
10954
+
10955
+ /**
10956
+ * No description
10957
+ *
10958
+ * @tags LoanDocumentFolders
10959
+ * @name ReactivateLoanDocumentFolder
10960
+ * @summary Reactivate a loan document folder.
10961
+ * @request POST:/api/loan-document-folders/{id}/reactivate
10962
+ * @secure
10963
+ * @response `204` `void` No Content
10964
+ * @response `404` `ProblemDetails` Not Found
10965
+ */
10966
+ reactivateLoanDocumentFolder: (id: string, params: RequestParams = {}) =>
10967
+ this.request<void, ProblemDetails>({
10968
+ path: `/api/loan-document-folders/${id}/reactivate`,
10969
+ method: "POST",
10970
+ secure: true,
10971
+ ...params,
10972
+ }),
10973
+
10974
+ /**
10975
+ * No description
10976
+ *
10977
+ * @tags LoanDocumentFolders
10978
+ * @name GetLoanDocumentFolderUsage
10979
+ * @summary Get folder usage. Returns HasEverBeenReferenced including soft-deleted documents and tasks.
10980
+ * @request GET:/api/loan-document-folders/{id}/usage
10981
+ * @secure
10982
+ * @response `200` `LoanDocumentFolderUsage` Success
10983
+ * @response `404` `ProblemDetails` Not Found
10984
+ */
10985
+ getLoanDocumentFolderUsage: (id: string, params: RequestParams = {}) =>
10986
+ this.request<LoanDocumentFolderUsage, ProblemDetails>({
10987
+ path: `/api/loan-document-folders/${id}/usage`,
10988
+ method: "GET",
10989
+ secure: true,
10990
+ format: "json",
10991
+ ...params,
10992
+ }),
10993
+
10476
10994
  /**
10477
10995
  * No description
10478
10996
  *
@@ -10635,6 +11153,8 @@ export class Api<
10635
11153
  /** @format binary */
10636
11154
  file?: File;
10637
11155
  bucket?: string;
11156
+ /** @format uuid */
11157
+ folderID?: string;
10638
11158
  },
10639
11159
  params: RequestParams = {},
10640
11160
  ) =>
@@ -11807,6 +12327,8 @@ export class Api<
11807
12327
  /** @format binary */
11808
12328
  file?: File;
11809
12329
  bucket?: string;
12330
+ /** @format uuid */
12331
+ folderID?: string;
11810
12332
  },
11811
12333
  params: RequestParams = {},
11812
12334
  ) =>
@@ -12841,16 +13363,7 @@ export class Api<
12841
13363
  query?: {
12842
13364
  showAll?: boolean;
12843
13365
  /** @default "Realtor" */
12844
- role?:
12845
- | "Borrower"
12846
- | "LoanOfficer"
12847
- | "Admin"
12848
- | "SuperAdmin"
12849
- | "Realtor"
12850
- | "SettlementAgent"
12851
- | "LoanProcessor"
12852
- | "LoanOfficerAssistant"
12853
- | "SystemAdmin";
13366
+ role?: GetPartnersParamsRoleEnum;
12854
13367
  /** @format int32 */
12855
13368
  pageSize?: number;
12856
13369
  /** @format int32 */
@@ -13186,7 +13699,7 @@ export class Api<
13186
13699
  * @response `404` `ProblemDetails` Not Found
13187
13700
  */
13188
13701
  getSamlMetadata: (
13189
- sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
13702
+ sSoIntegration: GetSamlMetadataParamsEnum,
13190
13703
  ssoIntegration: string,
13191
13704
  params: RequestParams = {},
13192
13705
  ) =>
@@ -13208,7 +13721,7 @@ export class Api<
13208
13721
  * @response `200` `File` Success
13209
13722
  */
13210
13723
  createOrReplaceSamlMetadata: (
13211
- sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
13724
+ sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum,
13212
13725
  ssoIntegration: string,
13213
13726
  params: RequestParams = {},
13214
13727
  ) =>