@matech/thebigpos-sdk 2.38.3-rc1 → 2.39.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/index.ts CHANGED
@@ -349,6 +349,19 @@ export type EncompassLogOperationType =
349
349
 
350
350
  export type DraftType = "NewLoan" | "EditLoan";
351
351
 
352
+ export type CustomFieldEntityType = "Loan";
353
+
354
+ export type CustomFieldDataType =
355
+ | "String"
356
+ | "Number"
357
+ | "Decimal"
358
+ | "Boolean"
359
+ | "Date"
360
+ | "SingleSelect"
361
+ | "MultiSelect";
362
+
363
+ export type CustomFieldAccessLevel = "NoAccess" | "ReadOnly" | "ReadWrite";
364
+
352
365
  export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
353
366
 
354
367
  export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
@@ -457,7 +470,7 @@ export interface AccountBilling {
457
470
  }
458
471
 
459
472
  export interface AccountBillingRequest {
460
- billingType: AccountBillingRequestBillingTypeEnum;
473
+ billingType: "ClosedLoan" | "LoanOfficer";
461
474
  /**
462
475
  * @format double
463
476
  * @min 0
@@ -750,17 +763,17 @@ export interface ApplicationRowData {
750
763
  loanNumber?: string | null;
751
764
  /** @deprecated */
752
765
  role?: string | null;
753
- /** @format date-time */
766
+ /** @format date */
754
767
  initialDisclosureDate?: string | null;
755
- /** @format date-time */
768
+ /** @format date */
756
769
  closingDisclosureDate?: string | null;
757
- /** @format date-time */
770
+ /** @format date */
758
771
  underwritingApprovalDate?: string | null;
759
772
  /** @format date-time */
760
773
  closedDate?: string | null;
761
774
  /** @format date-time */
762
775
  fundingDate?: string | null;
763
- /** @format date-time */
776
+ /** @format date */
764
777
  currentStatusDate?: string | null;
765
778
  channel?: string | null;
766
779
  currentMilestone?: string | null;
@@ -795,7 +808,12 @@ export interface AuditLogEntry {
795
808
  /** @format uuid */
796
809
  id: string;
797
810
  entityType: string;
798
- changeType: AuditLogEntryChangeTypeEnum;
811
+ changeType:
812
+ | "Created"
813
+ | "Modified"
814
+ | "SoftDeleted"
815
+ | "HardDeleted"
816
+ | "Restored";
799
817
  /** @format uuid */
800
818
  entityId: string;
801
819
  performedBy?: AuditLogUser | null;
@@ -835,6 +853,12 @@ export interface AuditLogUser {
835
853
  email: string;
836
854
  }
837
855
 
856
+ export interface AutomatedService {
857
+ triggered: string[];
858
+ skipped: string[];
859
+ rateLimited: string[];
860
+ }
861
+
838
862
  export interface BranchBase {
839
863
  /** @format date-time */
840
864
  createdAt: string;
@@ -1103,7 +1127,7 @@ export interface CorporateSearchCriteria {
1103
1127
  }
1104
1128
 
1105
1129
  export interface CreateAccessScopeRequest {
1106
- scopeType: CreateAccessScopeRequestScopeTypeEnum;
1130
+ scopeType: "User" | "Branch";
1107
1131
  /** @format uuid */
1108
1132
  userId?: string | null;
1109
1133
  /** @format uuid */
@@ -1127,7 +1151,7 @@ export interface CreateAccountRequest {
1127
1151
  */
1128
1152
  nlmsid: number;
1129
1153
  settings: AccountSettingsRequest;
1130
- environment: CreateAccountRequestEnvironmentEnum;
1154
+ environment: "Development" | "Staging" | "UAT" | "Production";
1131
1155
  losIntegration: LOSIntegration;
1132
1156
  billingSettings: AccountBillingRequest;
1133
1157
  }
@@ -1143,6 +1167,41 @@ export interface CreateBranchRequest {
1143
1167
  type: string;
1144
1168
  }
1145
1169
 
1170
+ export interface CreateCustomFieldDefinitionRequest {
1171
+ isRequired: boolean;
1172
+ /**
1173
+ * @format int32
1174
+ * @min 0
1175
+ */
1176
+ displayOrder: number;
1177
+ /** @format int32 */
1178
+ minLength?: number | null;
1179
+ /** @format int32 */
1180
+ maxLength?: number | null;
1181
+ /** @format double */
1182
+ minValue?: number | null;
1183
+ /** @format double */
1184
+ maxValue?: number | null;
1185
+ /**
1186
+ * @minLength 1
1187
+ * @maxLength 250
1188
+ */
1189
+ name: string;
1190
+ defaultValue?: string | null;
1191
+ regexPattern?: string | null;
1192
+ dataType:
1193
+ | "String"
1194
+ | "Number"
1195
+ | "Decimal"
1196
+ | "Boolean"
1197
+ | "Date"
1198
+ | "SingleSelect"
1199
+ | "MultiSelect";
1200
+ entityType: "Loan";
1201
+ options?: CustomFieldOptionRequest[] | null;
1202
+ permissions?: CustomFieldPermissionRequest[] | null;
1203
+ }
1204
+
1146
1205
  export interface CreateDocumentTemplateRequest {
1147
1206
  /** @minLength 1 */
1148
1207
  htmlBody: string;
@@ -1160,7 +1219,19 @@ export interface CreateDocumentTemplateRequest {
1160
1219
  export interface CreateGroupMemberRequest {
1161
1220
  /** @format uuid */
1162
1221
  userId: string;
1163
- loanRole: CreateGroupMemberRequestLoanRoleEnum;
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";
1164
1235
  }
1165
1236
 
1166
1237
  export interface CreateInviteRequest {
@@ -1172,7 +1243,7 @@ export interface CreateInviteRequest {
1172
1243
  emailAddress: string;
1173
1244
  phoneNumber?: string | null;
1174
1245
  /** @deprecated */
1175
- relationship: CreateInviteRequestRelationshipEnum;
1246
+ relationship: "NotApplicable" | "Spouse" | "NonSpouse";
1176
1247
  loanID: string;
1177
1248
  route?: string | null;
1178
1249
  /** @format uuid */
@@ -1195,7 +1266,7 @@ export interface CreateLoanImportRequest {
1195
1266
  * @minLength 1
1196
1267
  */
1197
1268
  startDate: string;
1198
- importMode: CreateLoanImportRequestImportModeEnum;
1269
+ importMode: "All" | "NewOnly" | "UpdateOnly";
1199
1270
  }
1200
1271
 
1201
1272
  export interface CreateSession {
@@ -1217,7 +1288,19 @@ export interface CreateUserDeviceRequest {
1217
1288
  }
1218
1289
 
1219
1290
  export interface CreateUserDraft {
1220
- loanRole: CreateUserDraftLoanRoleEnum;
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";
1221
1304
  }
1222
1305
 
1223
1306
  export interface CreateUserGroupRequest {
@@ -1278,6 +1361,127 @@ export interface CreateWebhookRequest {
1278
1361
  webhookPath: string;
1279
1362
  }
1280
1363
 
1364
+ export interface CustomFieldDefinition {
1365
+ /** @format date-time */
1366
+ createdAt: string;
1367
+ /** @format date-time */
1368
+ updatedAt?: string | null;
1369
+ /** @format date-time */
1370
+ deletedAt?: string | null;
1371
+ /** @format uuid */
1372
+ id: string;
1373
+ /** @format uuid */
1374
+ accountID: string;
1375
+ isActive: boolean;
1376
+ isRequired: boolean;
1377
+ /** @format int32 */
1378
+ displayOrder: number;
1379
+ /** @format int32 */
1380
+ minLength?: number | null;
1381
+ /** @format int32 */
1382
+ maxLength?: number | null;
1383
+ /** @format double */
1384
+ minValue?: number | null;
1385
+ /** @format double */
1386
+ maxValue?: number | null;
1387
+ name: string;
1388
+ defaultValue?: string | null;
1389
+ regexPattern?: string | null;
1390
+ dataType:
1391
+ | "String"
1392
+ | "Number"
1393
+ | "Decimal"
1394
+ | "Boolean"
1395
+ | "Date"
1396
+ | "SingleSelect"
1397
+ | "MultiSelect";
1398
+ entityType: "Loan";
1399
+ options: CustomFieldOption[];
1400
+ permissions: CustomFieldPermission[];
1401
+ }
1402
+
1403
+ export interface CustomFieldEntry {
1404
+ /** @format uuid */
1405
+ definitionId: string;
1406
+ isActive: boolean;
1407
+ isReadOnly: boolean;
1408
+ /** @format int32 */
1409
+ displayOrder: number;
1410
+ name: string;
1411
+ value: string;
1412
+ dataType:
1413
+ | "String"
1414
+ | "Number"
1415
+ | "Decimal"
1416
+ | "Boolean"
1417
+ | "Date"
1418
+ | "SingleSelect"
1419
+ | "MultiSelect";
1420
+ }
1421
+
1422
+ export interface CustomFieldOption {
1423
+ /** @format uuid */
1424
+ id: string;
1425
+ /** @format int32 */
1426
+ displayOrder: number;
1427
+ value: string;
1428
+ }
1429
+
1430
+ export interface CustomFieldOptionRequest {
1431
+ /** @format int32 */
1432
+ displayOrder: number;
1433
+ value: string;
1434
+ }
1435
+
1436
+ export interface CustomFieldPermission {
1437
+ /** @format uuid */
1438
+ id: string;
1439
+ role:
1440
+ | "Borrower"
1441
+ | "LoanOfficer"
1442
+ | "Admin"
1443
+ | "SuperAdmin"
1444
+ | "Realtor"
1445
+ | "SettlementAgent"
1446
+ | "LoanProcessor"
1447
+ | "LoanOfficerAssistant"
1448
+ | "SystemAdmin";
1449
+ accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1450
+ }
1451
+
1452
+ export interface CustomFieldPermissionRequest {
1453
+ role:
1454
+ | "Borrower"
1455
+ | "LoanOfficer"
1456
+ | "Admin"
1457
+ | "SuperAdmin"
1458
+ | "Realtor"
1459
+ | "SettlementAgent"
1460
+ | "LoanProcessor"
1461
+ | "LoanOfficerAssistant"
1462
+ | "SystemAdmin";
1463
+ accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1464
+ }
1465
+
1466
+ export interface CustomFieldValue {
1467
+ /** @format uuid */
1468
+ id: string;
1469
+ /** @format uuid */
1470
+ entityID: string;
1471
+ /** @format uuid */
1472
+ customFieldDefinitionID: string;
1473
+ value: string;
1474
+ definitionName: string;
1475
+ dataType:
1476
+ | "String"
1477
+ | "Number"
1478
+ | "Decimal"
1479
+ | "Boolean"
1480
+ | "Date"
1481
+ | "SingleSelect"
1482
+ | "MultiSelect";
1483
+ }
1484
+
1281
1485
  export interface CustomLoanData {
1282
1486
  eConsentInformation?: EConsentInformation | null;
1283
1487
  }
@@ -1539,7 +1743,7 @@ export interface Draft {
1539
1743
  siteConfiguration: SiteConfigurationReduced;
1540
1744
  /** @format uuid */
1541
1745
  loanID?: string | null;
1542
- type: DraftTypeEnum;
1746
+ type: "NewLoan" | "EditLoan";
1543
1747
  isCoBorrower: boolean;
1544
1748
  }
1545
1749
 
@@ -1558,7 +1762,7 @@ export interface DraftContent {
1558
1762
  siteConfiguration: SiteConfigurationReduced;
1559
1763
  /** @format uuid */
1560
1764
  loanID?: string | null;
1561
- type: DraftContentTypeEnum;
1765
+ type: "NewLoan" | "EditLoan";
1562
1766
  isCoBorrower: boolean;
1563
1767
  applicationPayload: any;
1564
1768
  }
@@ -1636,6 +1840,7 @@ export interface EnabledServices {
1636
1840
  listings?: boolean | null;
1637
1841
  addCoBorrower?: boolean | null;
1638
1842
  autoNameTaskDocuments?: boolean | null;
1843
+ genericCalculatorsEnabled?: boolean | null;
1639
1844
  }
1640
1845
 
1641
1846
  export interface EncompassContact {
@@ -1656,7 +1861,7 @@ export interface EncompassCredentialsDetail {
1656
1861
  defaultLoanOfficerUserName?: string | null;
1657
1862
  clearStateIfUnlicensed: boolean;
1658
1863
  baseUrl?: string | null;
1659
- signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1864
+ signingMethod: "ConsumerConnect" | "POSF";
1660
1865
  subscriptionId?: string | null;
1661
1866
  environment?: string | null;
1662
1867
  }
@@ -1672,7 +1877,7 @@ export interface EncompassCredentialsRequest {
1672
1877
  defaultLoanOfficerUserName?: string | null;
1673
1878
  clearStateIfUnlicensed: boolean;
1674
1879
  baseUrl?: string | null;
1675
- signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1880
+ signingMethod: "ConsumerConnect" | "POSF";
1676
1881
  subscriptionId?: string | null;
1677
1882
  environment?: string | null;
1678
1883
  clientID?: string | null;
@@ -1736,8 +1941,15 @@ export interface EncompassRequestLog {
1736
1941
  losId?: string | null;
1737
1942
  /** @format uuid */
1738
1943
  accountId: string;
1739
- operationType: EncompassRequestLogOperationTypeEnum;
1740
- outcome: EncompassRequestLogOutcomeEnum;
1944
+ operationType:
1945
+ | "FieldUpdate"
1946
+ | "ConsentUpdate"
1947
+ | "DocumentSync"
1948
+ | "MilestoneUpdate"
1949
+ | "DocumentAttachment"
1950
+ | "General"
1951
+ | "FieldReader";
1952
+ outcome: "Success" | "Failure" | "PartialSuccess";
1741
1953
  message: string;
1742
1954
  endpoint?: string | null;
1743
1955
  httpMethod?: string | null;
@@ -1795,7 +2007,7 @@ export interface FileSearchCriteria {
1795
2007
  export interface FileWithBytes {
1796
2008
  name: string;
1797
2009
  /** @format byte */
1798
- data: Blob;
2010
+ data: string;
1799
2011
  fileName: string;
1800
2012
  mimeType?: string | null;
1801
2013
  extension?: string | null;
@@ -1974,7 +2186,20 @@ export interface FusionFieldDisplay {
1974
2186
  }
1975
2187
 
1976
2188
  export interface FusionReportFilter {
1977
- filterType: FusionReportFilterFilterTypeEnum;
2189
+ filterType:
2190
+ | "DateGreaterThanOrEqualTo"
2191
+ | "DateGreaterThan"
2192
+ | "DateLessThan"
2193
+ | "DateLessThanOrEqualTo"
2194
+ | "DateEquals"
2195
+ | "DateDoesntEqual"
2196
+ | "DateNonEmpty"
2197
+ | "DateEmpty"
2198
+ | "StringContains"
2199
+ | "StringEquals"
2200
+ | "StringNotEmpty"
2201
+ | "StringNotEquals"
2202
+ | "StringNotContains";
1978
2203
  targetField: string;
1979
2204
  targetValue: string;
1980
2205
  }
@@ -2102,7 +2327,40 @@ export interface GuidPatchOperation {
2102
2327
  }
2103
2328
 
2104
2329
  export interface IPAddress {
2105
- addressFamily: IpAddressAddressFamilyEnum;
2330
+ addressFamily:
2331
+ | "Unspecified"
2332
+ | "Unix"
2333
+ | "InterNetwork"
2334
+ | "ImpLink"
2335
+ | "Pup"
2336
+ | "Chaos"
2337
+ | "NS"
2338
+ | "Ipx"
2339
+ | "Iso"
2340
+ | "Osi"
2341
+ | "Ecma"
2342
+ | "DataKit"
2343
+ | "Ccitt"
2344
+ | "Sna"
2345
+ | "DecNet"
2346
+ | "DataLink"
2347
+ | "Lat"
2348
+ | "HyperChannel"
2349
+ | "AppleTalk"
2350
+ | "NetBios"
2351
+ | "VoiceView"
2352
+ | "FireFox"
2353
+ | "Banyan"
2354
+ | "Atm"
2355
+ | "InterNetworkV6"
2356
+ | "Cluster"
2357
+ | "Ieee12844"
2358
+ | "Irda"
2359
+ | "NetworkDesigners"
2360
+ | "Max"
2361
+ | "Packet"
2362
+ | "ControllerAreaNetwork"
2363
+ | "Unknown";
2106
2364
  /** @format int64 */
2107
2365
  scopeId: number;
2108
2366
  isIPv6Multicast: boolean;
@@ -2324,7 +2582,7 @@ export interface Loan {
2324
2582
  currentLoanStatus?: string | null;
2325
2583
  currentMilestone?: string | null;
2326
2584
  lastCompletedMilestone?: string | null;
2327
- /** @format date-time */
2585
+ /** @format date */
2328
2586
  currentStatusDate?: string | null;
2329
2587
  isActive: boolean;
2330
2588
  loanChannel?: string | null;
@@ -2338,17 +2596,17 @@ export interface Loan {
2338
2596
  source?: string | null;
2339
2597
  isPOSLoan?: boolean | null;
2340
2598
  version?: string | null;
2341
- /** @format date-time */
2599
+ /** @format date */
2342
2600
  startDate?: string | null;
2343
- /** @format date-time */
2601
+ /** @format date */
2344
2602
  initialDisclosureProvidedDate?: string | null;
2345
- /** @format date-time */
2603
+ /** @format date */
2346
2604
  closingDisclosureSentDate?: string | null;
2347
- /** @format date-time */
2605
+ /** @format date */
2348
2606
  underwritingApprovalDate?: string | null;
2349
2607
  /** @format date */
2350
2608
  closingDate?: string | null;
2351
- /** @format date-time */
2609
+ /** @format date */
2352
2610
  fundingOrderDate?: string | null;
2353
2611
  isInSync: boolean;
2354
2612
  /** @format date-time */
@@ -2369,7 +2627,8 @@ export interface Loan {
2369
2627
  nonOwningBorrowers: LoanNonOwningBorrower[];
2370
2628
  userLoans: UserLoan[];
2371
2629
  contacts: LoanContact[];
2372
- signingMethod: LoanSigningMethodEnum;
2630
+ customFields: CustomFieldEntry[];
2631
+ signingMethod: "ConsumerConnect" | "POSF";
2373
2632
  }
2374
2633
 
2375
2634
  export interface LoanApplication {
@@ -2382,7 +2641,7 @@ export interface LoanApplication {
2382
2641
  number?: string | null;
2383
2642
  program?: string | null;
2384
2643
  channel?: string | null;
2385
- /** @format date-time */
2644
+ /** @format date */
2386
2645
  startDate?: string | null;
2387
2646
  property?: LoanProperty | null;
2388
2647
  financial?: LoanFinancial | null;
@@ -2408,6 +2667,7 @@ export interface LoanApplicationRequest {
2408
2667
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2409
2668
  /** @format uuid */
2410
2669
  draftId?: string | null;
2670
+ additionalFields?: Record<string, any>;
2411
2671
  /** @format uuid */
2412
2672
  existingLoanId?: string | null;
2413
2673
  }
@@ -2427,7 +2687,7 @@ export interface LoanBorrower {
2427
2687
  citizenship?: LoanCitizenship | null;
2428
2688
  maritalStatus?: LoanMaritalStatus | null;
2429
2689
  languagePreference?: LoanLanguagePreference | null;
2430
- applicationStatus: LoanBorrowerApplicationStatusEnum;
2690
+ applicationStatus: "Draft" | "Complete";
2431
2691
  /** @format int32 */
2432
2692
  numberOfDependents?: number | null;
2433
2693
  isPrimaryBorrower: boolean;
@@ -3352,7 +3612,19 @@ export interface LoanContact {
3352
3612
  email?: string | null;
3353
3613
  phone?: string | null;
3354
3614
  companyName?: string | null;
3355
- role: LoanContactRoleEnum;
3615
+ role:
3616
+ | "Borrower"
3617
+ | "CoBorrower"
3618
+ | "NonBorrower"
3619
+ | "LoanOfficer"
3620
+ | "LoanProcessor"
3621
+ | "LoanOfficerAssistant"
3622
+ | "SupportingLoanOfficer"
3623
+ | "BuyerAgent"
3624
+ | "SellerAgent"
3625
+ | "TitleInsuranceAgent"
3626
+ | "EscrowAgent"
3627
+ | "SettlementAgent";
3356
3628
  }
3357
3629
 
3358
3630
  export interface LoanContactList {
@@ -3384,6 +3656,10 @@ export interface LoanDocument {
3384
3656
  sensitiveDataPurgedOn?: string | null;
3385
3657
  }
3386
3658
 
3659
+ export interface LoanDocumentPreviewsRequest {
3660
+ documentIds: string[];
3661
+ }
3662
+
3387
3663
  export interface LoanDocumentSearch {
3388
3664
  /** @format date-time */
3389
3665
  createdAt: string;
@@ -3489,14 +3765,19 @@ export interface LoanImport {
3489
3765
  /** @format int32 */
3490
3766
  importedCount: number;
3491
3767
  statusMessage?: string | null;
3492
- status: LoanImportStatusEnum;
3493
- importMode: LoanImportImportModeEnum;
3768
+ status:
3769
+ | "WaitingProcess"
3770
+ | "InProgress"
3771
+ | "Completed"
3772
+ | "Failed"
3773
+ | "Cancelled";
3774
+ importMode: "All" | "NewOnly" | "UpdateOnly";
3494
3775
  /** @format date-time */
3495
3776
  createdAt?: string | null;
3496
3777
  }
3497
3778
 
3498
3779
  export interface LoanImportLog {
3499
- level: LoanImportLogLevelEnum;
3780
+ level: "None" | "Info" | "Warning" | "Error";
3500
3781
  message: string;
3501
3782
  /** @format date-time */
3502
3783
  createdAt: string;
@@ -3526,7 +3807,7 @@ export interface LoanList {
3526
3807
  purpose?: LoanPurpose | null;
3527
3808
  /** @format double */
3528
3809
  totalLoanAmount?: number | null;
3529
- /** @format date-time */
3810
+ /** @format date */
3530
3811
  startDate?: string | null;
3531
3812
  isActive: boolean;
3532
3813
  propertyAddress?: Address | null;
@@ -3557,8 +3838,24 @@ export interface LoanListPaginated {
3557
3838
  export interface LoanLog {
3558
3839
  /** @format uuid */
3559
3840
  id: string;
3560
- level: LoanLogLevelEnum;
3561
- type: LoanLogTypeEnum;
3841
+ level: "None" | "Info" | "Warning" | "Error";
3842
+ type:
3843
+ | "Loan"
3844
+ | "Queue"
3845
+ | "POSFlagChanged"
3846
+ | "Verification"
3847
+ | "DocumentUploaded"
3848
+ | "LoanCreated"
3849
+ | "WorkflowSubmitted"
3850
+ | "UserInvitationSent"
3851
+ | "CoBorrowerAdded"
3852
+ | "TaskCompleted"
3853
+ | "LoanStatusChanged"
3854
+ | "Consent"
3855
+ | "SensitiveDataPurge"
3856
+ | "ClosingDateUpdated"
3857
+ | "ConsumerConnectAssociation"
3858
+ | "TaskReminderSent";
3562
3859
  message: string;
3563
3860
  /** @format date-time */
3564
3861
  createdAt: string;
@@ -3567,8 +3864,24 @@ export interface LoanLog {
3567
3864
  export interface LoanLogDetail {
3568
3865
  /** @format uuid */
3569
3866
  id: string;
3570
- level: LoanLogDetailLevelEnum;
3571
- type: LoanLogDetailTypeEnum;
3867
+ level: "None" | "Info" | "Warning" | "Error";
3868
+ type:
3869
+ | "Loan"
3870
+ | "Queue"
3871
+ | "POSFlagChanged"
3872
+ | "Verification"
3873
+ | "DocumentUploaded"
3874
+ | "LoanCreated"
3875
+ | "WorkflowSubmitted"
3876
+ | "UserInvitationSent"
3877
+ | "CoBorrowerAdded"
3878
+ | "TaskCompleted"
3879
+ | "LoanStatusChanged"
3880
+ | "Consent"
3881
+ | "SensitiveDataPurge"
3882
+ | "ClosingDateUpdated"
3883
+ | "ConsumerConnectAssociation"
3884
+ | "TaskReminderSent";
3572
3885
  message: string;
3573
3886
  /** @format date-time */
3574
3887
  createdAt: string;
@@ -3856,7 +4169,7 @@ export interface LoanTaskSearchRequest {
3856
4169
  }
3857
4170
 
3858
4171
  export interface LoanTaskStatusSummary {
3859
- status: LoanTaskStatusSummaryStatusEnum;
4172
+ status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3860
4173
  /** @format int32 */
3861
4174
  count: number;
3862
4175
  }
@@ -3869,7 +4182,19 @@ export interface LoanUser {
3869
4182
  email: string;
3870
4183
  phone?: string | null;
3871
4184
  role: string;
3872
- loanRole: LoanUserLoanRoleEnum;
4185
+ loanRole:
4186
+ | "Borrower"
4187
+ | "CoBorrower"
4188
+ | "NonBorrower"
4189
+ | "LoanOfficer"
4190
+ | "LoanProcessor"
4191
+ | "LoanOfficerAssistant"
4192
+ | "SupportingLoanOfficer"
4193
+ | "BuyerAgent"
4194
+ | "SellerAgent"
4195
+ | "TitleInsuranceAgent"
4196
+ | "EscrowAgent"
4197
+ | "SettlementAgent";
3873
4198
  isUser: boolean;
3874
4199
  /** @format date-time */
3875
4200
  createdAt: string;
@@ -3905,7 +4230,13 @@ export interface LosOperationTracking {
3905
4230
  operationType: string;
3906
4231
  correlationKey: string;
3907
4232
  lastTriggerSource?: string | null;
3908
- status: LosOperationTrackingStatusEnum;
4233
+ status:
4234
+ | "Pending"
4235
+ | "Success"
4236
+ | "Failed"
4237
+ | "ConfigurationError"
4238
+ | "PermanentFailure"
4239
+ | "Locked";
3909
4240
  /** @format date-time */
3910
4241
  createdAt: string;
3911
4242
  /** @format date-time */
@@ -3929,6 +4260,53 @@ export interface LosOperationTrackingSearchCriteria {
3929
4260
  status?: LosOperationStatus | null;
3930
4261
  }
3931
4262
 
4263
+ export interface LosSync {
4264
+ /** @format uuid */
4265
+ correlationId: string;
4266
+ /** @format uuid */
4267
+ loanId?: string | null;
4268
+ direction: string;
4269
+ currentState: string;
4270
+ encompassLoanId?: string | null;
4271
+ encompassLoanNumber?: string | null;
4272
+ /** @format int32 */
4273
+ retryCount: number;
4274
+ /** @format date-time */
4275
+ requestedAtUtc?: string | null;
4276
+ /** @format date-time */
4277
+ completedAtUtc?: string | null;
4278
+ /** @format date-time */
4279
+ failedAtUtc?: string | null;
4280
+ errors: string[];
4281
+ steps: LosSyncStep[];
4282
+ }
4283
+
4284
+ export interface LosSyncPaginated {
4285
+ rows: LosSync[];
4286
+ pagination: Pagination;
4287
+ /** @format int64 */
4288
+ count: number;
4289
+ }
4290
+
4291
+ export interface LosSyncSearchCriteria {
4292
+ searchText?: string | null;
4293
+ syncDirection?: string | null;
4294
+ status?: string | null;
4295
+ /** @format date-time */
4296
+ dateFrom?: string | null;
4297
+ /** @format date-time */
4298
+ dateTo?: string | null;
4299
+ }
4300
+
4301
+ export interface LosSyncStep {
4302
+ name: string;
4303
+ completed: boolean;
4304
+ /** @format date-time */
4305
+ completedAtUtc?: string | null;
4306
+ /** @format int32 */
4307
+ order: number;
4308
+ }
4309
+
3932
4310
  export interface LosWebhook {
3933
4311
  /** @format uuid */
3934
4312
  id: string;
@@ -4231,7 +4609,7 @@ export interface NotificationTemplateVersionUpdateRequest {
4231
4609
 
4232
4610
  export interface Operation {
4233
4611
  op?: string;
4234
- value?: object | null;
4612
+ value?: string | number | boolean | null | object;
4235
4613
  path?: string;
4236
4614
  }
4237
4615
 
@@ -4587,7 +4965,7 @@ export interface SSOTokenRequest {
4587
4965
  }
4588
4966
 
4589
4967
  export interface SamlMetadataRequest {
4590
- ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
4968
+ ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
4591
4969
  }
4592
4970
 
4593
4971
  export interface SendForgotPasswordRequest {
@@ -4626,6 +5004,16 @@ export interface SendNotificationForLoanRequest {
4626
5004
  attachments: Attachment[];
4627
5005
  }
4628
5006
 
5007
+ export interface SetCustomFieldValueRequest {
5008
+ /** @format uuid */
5009
+ definitionId: string;
5010
+ value?: string | null;
5011
+ }
5012
+
5013
+ export interface SetSingleCustomFieldValueRequest {
5014
+ value?: string | null;
5015
+ }
5016
+
4629
5017
  export interface SiteConfiguration {
4630
5018
  /** @format date-time */
4631
5019
  createdAt: string;
@@ -4635,7 +5023,7 @@ export interface SiteConfiguration {
4635
5023
  deletedAt?: string | null;
4636
5024
  /** @format uuid */
4637
5025
  id: string;
4638
- type: SiteConfigurationTypeEnum;
5026
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4639
5027
  /** @format uuid */
4640
5028
  entityID: string;
4641
5029
  /** @format int32 */
@@ -4830,7 +5218,7 @@ export interface SiteConfigurationByUrl {
4830
5218
  deletedAt?: string | null;
4831
5219
  /** @format uuid */
4832
5220
  id: string;
4833
- type: SiteConfigurationByUrlTypeEnum;
5221
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4834
5222
  /** @format uuid */
4835
5223
  entityID: string;
4836
5224
  /** @format int32 */
@@ -5043,7 +5431,7 @@ export interface SiteConfigurationForm {
5043
5431
  export interface SiteConfigurationReduced {
5044
5432
  /** @format uuid */
5045
5433
  id: string;
5046
- type: SiteConfigurationReducedTypeEnum;
5434
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5047
5435
  url?: string | null;
5048
5436
  name: string;
5049
5437
  /** @format int64 */
@@ -5061,7 +5449,7 @@ export interface SiteConfigurationRequest {
5061
5449
  entityID: string;
5062
5450
  /** @format int32 */
5063
5451
  entityType: number;
5064
- type: SiteConfigurationRequestTypeEnum;
5452
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5065
5453
  url: string;
5066
5454
  name: string;
5067
5455
  introduction?: string | null;
@@ -5238,7 +5626,7 @@ export interface SiteConfigurationSearchCriteria {
5238
5626
  export interface SiteConfigurationSummary {
5239
5627
  /** @format uuid */
5240
5628
  id: string;
5241
- type: SiteConfigurationSummaryTypeEnum;
5629
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5242
5630
  url?: string | null;
5243
5631
  name: string;
5244
5632
  /** @format int64 */
@@ -5486,6 +5874,11 @@ export interface TokenRequest {
5486
5874
  isSupport: boolean;
5487
5875
  }
5488
5876
 
5877
+ export interface TriggerAsoRequest {
5878
+ /** @maxItems 23 */
5879
+ serviceKeys: string[];
5880
+ }
5881
+
5489
5882
  export interface UnderwritingCondition {
5490
5883
  /** @format uuid */
5491
5884
  id: string;
@@ -5546,6 +5939,32 @@ export interface UpdateAccountRequest {
5546
5939
  settings: AccountSettingsRequest;
5547
5940
  }
5548
5941
 
5942
+ export interface UpdateCustomFieldDefinitionRequest {
5943
+ isRequired: boolean;
5944
+ /**
5945
+ * @format int32
5946
+ * @min 0
5947
+ */
5948
+ displayOrder: number;
5949
+ /** @format int32 */
5950
+ minLength?: number | null;
5951
+ /** @format int32 */
5952
+ maxLength?: number | null;
5953
+ /** @format double */
5954
+ minValue?: number | null;
5955
+ /** @format double */
5956
+ maxValue?: number | null;
5957
+ /**
5958
+ * @minLength 1
5959
+ * @maxLength 250
5960
+ */
5961
+ name: string;
5962
+ defaultValue?: string | null;
5963
+ regexPattern?: string | null;
5964
+ options?: CustomFieldOptionRequest[] | null;
5965
+ permissions?: CustomFieldPermissionRequest[] | null;
5966
+ }
5967
+
5549
5968
  export interface UpdateDocumentTemplateRequest {
5550
5969
  /** @minLength 1 */
5551
5970
  htmlBody: string;
@@ -5866,7 +6285,19 @@ export interface UserDevice {
5866
6285
  export interface UserDraft {
5867
6286
  /** @format uuid */
5868
6287
  draftID: string;
5869
- role: UserDraftRoleEnum;
6288
+ role:
6289
+ | "Borrower"
6290
+ | "CoBorrower"
6291
+ | "NonBorrower"
6292
+ | "LoanOfficer"
6293
+ | "LoanProcessor"
6294
+ | "LoanOfficerAssistant"
6295
+ | "SupportingLoanOfficer"
6296
+ | "BuyerAgent"
6297
+ | "SellerAgent"
6298
+ | "TitleInsuranceAgent"
6299
+ | "EscrowAgent"
6300
+ | "SettlementAgent";
5870
6301
  user: User;
5871
6302
  }
5872
6303
 
@@ -5893,7 +6324,7 @@ export interface UserGroupAccessScope {
5893
6324
  id: string;
5894
6325
  /** @format uuid */
5895
6326
  groupId: string;
5896
- scopeType: UserGroupAccessScopeScopeTypeEnum;
6327
+ scopeType: "User" | "Branch";
5897
6328
  /** @format uuid */
5898
6329
  userId?: string | null;
5899
6330
  /** @format uuid */
@@ -5929,7 +6360,19 @@ export interface UserLoan {
5929
6360
  deletedAt?: string | null;
5930
6361
  loanID: string;
5931
6362
  user: User;
5932
- role: UserLoanRoleEnum;
6363
+ role:
6364
+ | "Borrower"
6365
+ | "CoBorrower"
6366
+ | "NonBorrower"
6367
+ | "LoanOfficer"
6368
+ | "LoanProcessor"
6369
+ | "LoanOfficerAssistant"
6370
+ | "SupportingLoanOfficer"
6371
+ | "BuyerAgent"
6372
+ | "SellerAgent"
6373
+ | "TitleInsuranceAgent"
6374
+ | "EscrowAgent"
6375
+ | "SettlementAgent";
5933
6376
  /** @format int32 */
5934
6377
  borrowerPair?: number | null;
5935
6378
  /** @format int32 */
@@ -5942,10 +6385,10 @@ export interface UserLoanConsent {
5942
6385
  id: string;
5943
6386
  /** @format uuid */
5944
6387
  userLoanID: string;
5945
- type: UserLoanConsentTypeEnum;
6388
+ type: "Econsent" | "CreditAuthorization" | "Tcpa";
5946
6389
  providedConsent: boolean;
5947
6390
  ipAddress?: string | null;
5948
- losSyncStatus: UserLoanConsentLosSyncStatusEnum;
6391
+ losSyncStatus: "NotStarted" | "Failed" | "Success";
5949
6392
  /** @format date-time */
5950
6393
  createdAt: string;
5951
6394
  }
@@ -6096,7 +6539,16 @@ export interface UserSummary {
6096
6539
  id: string;
6097
6540
  name?: string | null;
6098
6541
  email?: string | null;
6099
- role: UserSummaryRoleEnum;
6542
+ role:
6543
+ | "Borrower"
6544
+ | "LoanOfficer"
6545
+ | "Admin"
6546
+ | "SuperAdmin"
6547
+ | "Realtor"
6548
+ | "SettlementAgent"
6549
+ | "LoanProcessor"
6550
+ | "LoanOfficerAssistant"
6551
+ | "SystemAdmin";
6100
6552
  }
6101
6553
 
6102
6554
  export interface VerifyPasswordRequest {
@@ -6124,371 +6576,13 @@ export interface Workflow {
6124
6576
  status: string;
6125
6577
  userRole: string;
6126
6578
  borrowerType: string;
6127
- showProgressBar: boolean;
6128
- showTile: boolean;
6129
- tileLocation: string;
6130
- tileText: string;
6131
- tileSubtitle: string;
6132
- icon: string;
6133
- }
6134
-
6135
- export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
6136
-
6137
- export type AuditLogEntryChangeTypeEnum =
6138
- | "Created"
6139
- | "Modified"
6140
- | "SoftDeleted"
6141
- | "HardDeleted"
6142
- | "Restored";
6143
-
6144
- export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
6145
-
6146
- export type CreateAccountRequestEnvironmentEnum =
6147
- | "Development"
6148
- | "Staging"
6149
- | "UAT"
6150
- | "Production";
6151
-
6152
- export type CreateGroupMemberRequestLoanRoleEnum =
6153
- | "Borrower"
6154
- | "CoBorrower"
6155
- | "NonBorrower"
6156
- | "LoanOfficer"
6157
- | "LoanProcessor"
6158
- | "LoanOfficerAssistant"
6159
- | "SupportingLoanOfficer"
6160
- | "BuyerAgent"
6161
- | "SellerAgent"
6162
- | "TitleInsuranceAgent"
6163
- | "EscrowAgent"
6164
- | "SettlementAgent";
6165
-
6166
- /** @deprecated */
6167
- export type CreateInviteRequestRelationshipEnum =
6168
- | "NotApplicable"
6169
- | "Spouse"
6170
- | "NonSpouse";
6171
-
6172
- export type CreateLoanImportRequestImportModeEnum =
6173
- | "All"
6174
- | "NewOnly"
6175
- | "UpdateOnly";
6176
-
6177
- export type CreateUserDraftLoanRoleEnum =
6178
- | "Borrower"
6179
- | "CoBorrower"
6180
- | "NonBorrower"
6181
- | "LoanOfficer"
6182
- | "LoanProcessor"
6183
- | "LoanOfficerAssistant"
6184
- | "SupportingLoanOfficer"
6185
- | "BuyerAgent"
6186
- | "SellerAgent"
6187
- | "TitleInsuranceAgent"
6188
- | "EscrowAgent"
6189
- | "SettlementAgent";
6190
-
6191
- export type DraftTypeEnum = "NewLoan" | "EditLoan";
6192
-
6193
- export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
6194
-
6195
- export type EncompassCredentialsDetailSigningMethodEnum =
6196
- | "ConsumerConnect"
6197
- | "POSF";
6198
-
6199
- export type EncompassCredentialsRequestSigningMethodEnum =
6200
- | "ConsumerConnect"
6201
- | "POSF";
6202
-
6203
- export type EncompassRequestLogOperationTypeEnum =
6204
- | "FieldUpdate"
6205
- | "ConsentUpdate"
6206
- | "DocumentSync"
6207
- | "MilestoneUpdate"
6208
- | "DocumentAttachment"
6209
- | "General"
6210
- | "FieldReader";
6211
-
6212
- export type EncompassRequestLogOutcomeEnum =
6213
- | "Success"
6214
- | "Failure"
6215
- | "PartialSuccess";
6216
-
6217
- export type FusionReportFilterFilterTypeEnum =
6218
- | "DateGreaterThanOrEqualTo"
6219
- | "DateGreaterThan"
6220
- | "DateLessThan"
6221
- | "DateLessThanOrEqualTo"
6222
- | "DateEquals"
6223
- | "DateDoesntEqual"
6224
- | "DateNonEmpty"
6225
- | "DateEmpty"
6226
- | "StringContains"
6227
- | "StringEquals"
6228
- | "StringNotEmpty"
6229
- | "StringNotEquals"
6230
- | "StringNotContains";
6231
-
6232
- export type IpAddressAddressFamilyEnum =
6233
- | "Unspecified"
6234
- | "Unix"
6235
- | "InterNetwork"
6236
- | "ImpLink"
6237
- | "Pup"
6238
- | "Chaos"
6239
- | "NS"
6240
- | "Ipx"
6241
- | "Iso"
6242
- | "Osi"
6243
- | "Ecma"
6244
- | "DataKit"
6245
- | "Ccitt"
6246
- | "Sna"
6247
- | "DecNet"
6248
- | "DataLink"
6249
- | "Lat"
6250
- | "HyperChannel"
6251
- | "AppleTalk"
6252
- | "NetBios"
6253
- | "VoiceView"
6254
- | "FireFox"
6255
- | "Banyan"
6256
- | "Atm"
6257
- | "InterNetworkV6"
6258
- | "Cluster"
6259
- | "Ieee12844"
6260
- | "Irda"
6261
- | "NetworkDesigners"
6262
- | "Max"
6263
- | "Packet"
6264
- | "ControllerAreaNetwork"
6265
- | "Unknown";
6266
-
6267
- export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
6268
-
6269
- export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
6270
-
6271
- export type LoanContactRoleEnum =
6272
- | "Borrower"
6273
- | "CoBorrower"
6274
- | "NonBorrower"
6275
- | "LoanOfficer"
6276
- | "LoanProcessor"
6277
- | "LoanOfficerAssistant"
6278
- | "SupportingLoanOfficer"
6279
- | "BuyerAgent"
6280
- | "SellerAgent"
6281
- | "TitleInsuranceAgent"
6282
- | "EscrowAgent"
6283
- | "SettlementAgent";
6284
-
6285
- export type LoanImportStatusEnum =
6286
- | "WaitingProcess"
6287
- | "InProgress"
6288
- | "Completed"
6289
- | "Failed"
6290
- | "Cancelled";
6291
-
6292
- export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6293
-
6294
- export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6295
-
6296
- export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6297
-
6298
- export type LoanLogTypeEnum =
6299
- | "Loan"
6300
- | "Queue"
6301
- | "POSFlagChanged"
6302
- | "Verification"
6303
- | "DocumentUploaded"
6304
- | "LoanCreated"
6305
- | "WorkflowSubmitted"
6306
- | "UserInvitationSent"
6307
- | "CoBorrowerAdded"
6308
- | "TaskCompleted"
6309
- | "LoanStatusChanged"
6310
- | "Consent"
6311
- | "SensitiveDataPurge"
6312
- | "ClosingDateUpdated"
6313
- | "ConsumerConnectAssociation"
6314
- | "TaskReminderSent";
6315
-
6316
- export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
6317
-
6318
- export type LoanLogDetailTypeEnum =
6319
- | "Loan"
6320
- | "Queue"
6321
- | "POSFlagChanged"
6322
- | "Verification"
6323
- | "DocumentUploaded"
6324
- | "LoanCreated"
6325
- | "WorkflowSubmitted"
6326
- | "UserInvitationSent"
6327
- | "CoBorrowerAdded"
6328
- | "TaskCompleted"
6329
- | "LoanStatusChanged"
6330
- | "Consent"
6331
- | "SensitiveDataPurge"
6332
- | "ClosingDateUpdated"
6333
- | "ConsumerConnectAssociation"
6334
- | "TaskReminderSent";
6335
-
6336
- export type LoanTaskStatusSummaryStatusEnum =
6337
- | "Outstanding"
6338
- | "Pending"
6339
- | "Completed"
6340
- | "Rejected"
6341
- | "Unknown";
6342
-
6343
- export type LoanUserLoanRoleEnum =
6344
- | "Borrower"
6345
- | "CoBorrower"
6346
- | "NonBorrower"
6347
- | "LoanOfficer"
6348
- | "LoanProcessor"
6349
- | "LoanOfficerAssistant"
6350
- | "SupportingLoanOfficer"
6351
- | "BuyerAgent"
6352
- | "SellerAgent"
6353
- | "TitleInsuranceAgent"
6354
- | "EscrowAgent"
6355
- | "SettlementAgent";
6356
-
6357
- export type LosOperationTrackingStatusEnum =
6358
- | "Pending"
6359
- | "Success"
6360
- | "Failed"
6361
- | "ConfigurationError"
6362
- | "PermanentFailure"
6363
- | "Locked";
6364
-
6365
- export type SamlMetadataRequestSsoIntegrationEnum =
6366
- | "ConsumerConnect"
6367
- | "TheBigPOS"
6368
- | "POSF";
6369
-
6370
- export type SiteConfigurationTypeEnum =
6371
- | "None"
6372
- | "Account"
6373
- | "Corporate"
6374
- | "Branch"
6375
- | "LoanOfficer"
6376
- | "Partner";
6377
-
6378
- export type SiteConfigurationByUrlTypeEnum =
6379
- | "None"
6380
- | "Account"
6381
- | "Corporate"
6382
- | "Branch"
6383
- | "LoanOfficer"
6384
- | "Partner";
6385
-
6386
- export type SiteConfigurationReducedTypeEnum =
6387
- | "None"
6388
- | "Account"
6389
- | "Corporate"
6390
- | "Branch"
6391
- | "LoanOfficer"
6392
- | "Partner";
6393
-
6394
- export type SiteConfigurationRequestTypeEnum =
6395
- | "None"
6396
- | "Account"
6397
- | "Corporate"
6398
- | "Branch"
6399
- | "LoanOfficer"
6400
- | "Partner";
6401
-
6402
- export type SiteConfigurationSummaryTypeEnum =
6403
- | "None"
6404
- | "Account"
6405
- | "Corporate"
6406
- | "Branch"
6407
- | "LoanOfficer"
6408
- | "Partner";
6409
-
6410
- export type UserDraftRoleEnum =
6411
- | "Borrower"
6412
- | "CoBorrower"
6413
- | "NonBorrower"
6414
- | "LoanOfficer"
6415
- | "LoanProcessor"
6416
- | "LoanOfficerAssistant"
6417
- | "SupportingLoanOfficer"
6418
- | "BuyerAgent"
6419
- | "SellerAgent"
6420
- | "TitleInsuranceAgent"
6421
- | "EscrowAgent"
6422
- | "SettlementAgent";
6423
-
6424
- export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
6425
-
6426
- export type UserLoanRoleEnum =
6427
- | "Borrower"
6428
- | "CoBorrower"
6429
- | "NonBorrower"
6430
- | "LoanOfficer"
6431
- | "LoanProcessor"
6432
- | "LoanOfficerAssistant"
6433
- | "SupportingLoanOfficer"
6434
- | "BuyerAgent"
6435
- | "SellerAgent"
6436
- | "TitleInsuranceAgent"
6437
- | "EscrowAgent"
6438
- | "SettlementAgent";
6439
-
6440
- export type UserLoanConsentTypeEnum =
6441
- | "Econsent"
6442
- | "CreditAuthorization"
6443
- | "Tcpa";
6444
-
6445
- export type UserLoanConsentLosSyncStatusEnum =
6446
- | "NotStarted"
6447
- | "Failed"
6448
- | "Success";
6449
-
6450
- export type UserSummaryRoleEnum =
6451
- | "Borrower"
6452
- | "LoanOfficer"
6453
- | "Admin"
6454
- | "SuperAdmin"
6455
- | "Realtor"
6456
- | "SettlementAgent"
6457
- | "LoanProcessor"
6458
- | "LoanOfficerAssistant"
6459
- | "SystemAdmin";
6460
-
6461
- /** @default "Realtor" */
6462
- export type GetPartnersParamsRoleEnum =
6463
- | "Borrower"
6464
- | "LoanOfficer"
6465
- | "Admin"
6466
- | "SuperAdmin"
6467
- | "Realtor"
6468
- | "SettlementAgent"
6469
- | "LoanProcessor"
6470
- | "LoanOfficerAssistant"
6471
- | "SystemAdmin";
6472
-
6473
- export type GetSamlMetadataParamsSSoIntegrationEnum =
6474
- | "ConsumerConnect"
6475
- | "TheBigPOS"
6476
- | "POSF";
6477
-
6478
- export type GetSamlMetadataParamsEnum =
6479
- | "ConsumerConnect"
6480
- | "TheBigPOS"
6481
- | "POSF";
6482
-
6483
- export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum =
6484
- | "ConsumerConnect"
6485
- | "TheBigPOS"
6486
- | "POSF";
6487
-
6488
- export type CreateOrReplaceSamlMetadataParamsEnum =
6489
- | "ConsumerConnect"
6490
- | "TheBigPOS"
6491
- | "POSF";
6579
+ showProgressBar: boolean;
6580
+ showTile: boolean;
6581
+ tileLocation: string;
6582
+ tileText: string;
6583
+ tileSubtitle: string;
6584
+ icon: string;
6585
+ }
6492
6586
 
6493
6587
  import type {
6494
6588
  AxiosInstance,
@@ -6532,6 +6626,7 @@ export interface ApiConfig<SecurityDataType = unknown>
6532
6626
  }
6533
6627
 
6534
6628
  export enum ContentType {
6629
+ JsonPatch = "application/json-patch+json",
6535
6630
  Json = "application/json",
6536
6631
  JsonApi = "application/vnd.api+json",
6537
6632
  FormData = "multipart/form-data",
@@ -6667,7 +6762,7 @@ export class HttpClient<SecurityDataType = unknown> {
6667
6762
 
6668
6763
  /**
6669
6764
  * @title The Big POS API
6670
- * @version v2.38.2
6765
+ * @version v2.39.0
6671
6766
  * @termsOfService https://www.thebigpos.com/terms-of-use/
6672
6767
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
6673
6768
  */
@@ -7874,6 +7969,164 @@ export class Api<
7874
7969
  ...params,
7875
7970
  }),
7876
7971
 
7972
+ /**
7973
+ * No description
7974
+ *
7975
+ * @tags CustomFieldDefinitions
7976
+ * @name GetCustomFieldDefinitions
7977
+ * @summary Get all custom field definitions by entity type
7978
+ * @request GET:/api/custom-field-definitions
7979
+ * @secure
7980
+ * @response `200` `(CustomFieldDefinition)[]` Success
7981
+ */
7982
+ getCustomFieldDefinitions: (
7983
+ query?: {
7984
+ entityType?: "Loan";
7985
+ },
7986
+ params: RequestParams = {},
7987
+ ) =>
7988
+ this.request<CustomFieldDefinition[], any>({
7989
+ path: `/api/custom-field-definitions`,
7990
+ method: "GET",
7991
+ query: query,
7992
+ secure: true,
7993
+ format: "json",
7994
+ ...params,
7995
+ }),
7996
+
7997
+ /**
7998
+ * No description
7999
+ *
8000
+ * @tags CustomFieldDefinitions
8001
+ * @name CreateCustomFieldDefinition
8002
+ * @summary Create a custom field definition
8003
+ * @request POST:/api/custom-field-definitions
8004
+ * @secure
8005
+ * @response `201` `CustomFieldDefinition` Created
8006
+ * @response `409` `ProblemDetails` Conflict
8007
+ * @response `422` `ProblemDetails` Client Error
8008
+ */
8009
+ createCustomFieldDefinition: (
8010
+ data: CreateCustomFieldDefinitionRequest,
8011
+ params: RequestParams = {},
8012
+ ) =>
8013
+ this.request<CustomFieldDefinition, ProblemDetails>({
8014
+ path: `/api/custom-field-definitions`,
8015
+ method: "POST",
8016
+ body: data,
8017
+ secure: true,
8018
+ type: ContentType.Json,
8019
+ format: "json",
8020
+ ...params,
8021
+ }),
8022
+
8023
+ /**
8024
+ * No description
8025
+ *
8026
+ * @tags CustomFieldDefinitions
8027
+ * @name GetCustomFieldDefinitionById
8028
+ * @summary Get a custom field definition by ID
8029
+ * @request GET:/api/custom-field-definitions/{id}
8030
+ * @secure
8031
+ * @response `200` `CustomFieldDefinition` Success
8032
+ * @response `404` `ProblemDetails` Not Found
8033
+ */
8034
+ getCustomFieldDefinitionById: (id: string, params: RequestParams = {}) =>
8035
+ this.request<CustomFieldDefinition, ProblemDetails>({
8036
+ path: `/api/custom-field-definitions/${id}`,
8037
+ method: "GET",
8038
+ secure: true,
8039
+ format: "json",
8040
+ ...params,
8041
+ }),
8042
+
8043
+ /**
8044
+ * No description
8045
+ *
8046
+ * @tags CustomFieldDefinitions
8047
+ * @name UpdateCustomFieldDefinition
8048
+ * @summary Update a custom field definition
8049
+ * @request PUT:/api/custom-field-definitions/{id}
8050
+ * @secure
8051
+ * @response `200` `CustomFieldDefinition` Success
8052
+ * @response `400` `ProblemDetails` Bad Request
8053
+ * @response `404` `ProblemDetails` Not Found
8054
+ * @response `409` `ProblemDetails` Conflict
8055
+ * @response `422` `ProblemDetails` Client Error
8056
+ */
8057
+ updateCustomFieldDefinition: (
8058
+ id: string,
8059
+ data: UpdateCustomFieldDefinitionRequest,
8060
+ params: RequestParams = {},
8061
+ ) =>
8062
+ this.request<CustomFieldDefinition, ProblemDetails>({
8063
+ path: `/api/custom-field-definitions/${id}`,
8064
+ method: "PUT",
8065
+ body: data,
8066
+ secure: true,
8067
+ type: ContentType.Json,
8068
+ format: "json",
8069
+ ...params,
8070
+ }),
8071
+
8072
+ /**
8073
+ * No description
8074
+ *
8075
+ * @tags CustomFieldDefinitions
8076
+ * @name DeleteCustomFieldDefinition
8077
+ * @summary Delete a custom field definition
8078
+ * @request DELETE:/api/custom-field-definitions/{id}
8079
+ * @secure
8080
+ * @response `204` `void` No Content
8081
+ * @response `404` `ProblemDetails` Not Found
8082
+ * @response `409` `ProblemDetails` Conflict
8083
+ */
8084
+ deleteCustomFieldDefinition: (id: string, params: RequestParams = {}) =>
8085
+ this.request<void, ProblemDetails>({
8086
+ path: `/api/custom-field-definitions/${id}`,
8087
+ method: "DELETE",
8088
+ secure: true,
8089
+ ...params,
8090
+ }),
8091
+
8092
+ /**
8093
+ * No description
8094
+ *
8095
+ * @tags CustomFieldDefinitions
8096
+ * @name DisableCustomFieldDefinition
8097
+ * @summary Disable a custom field definition
8098
+ * @request POST:/api/custom-field-definitions/{id}/disable
8099
+ * @secure
8100
+ * @response `204` `void` No Content
8101
+ * @response `404` `ProblemDetails` Not Found
8102
+ */
8103
+ disableCustomFieldDefinition: (id: string, params: RequestParams = {}) =>
8104
+ this.request<void, ProblemDetails>({
8105
+ path: `/api/custom-field-definitions/${id}/disable`,
8106
+ method: "POST",
8107
+ secure: true,
8108
+ ...params,
8109
+ }),
8110
+
8111
+ /**
8112
+ * No description
8113
+ *
8114
+ * @tags CustomFieldDefinitions
8115
+ * @name EnableCustomFieldDefinition
8116
+ * @summary Enable a custom field definition
8117
+ * @request POST:/api/custom-field-definitions/{id}/enable
8118
+ * @secure
8119
+ * @response `204` `void` No Content
8120
+ * @response `404` `ProblemDetails` Not Found
8121
+ */
8122
+ enableCustomFieldDefinition: (id: string, params: RequestParams = {}) =>
8123
+ this.request<void, ProblemDetails>({
8124
+ path: `/api/custom-field-definitions/${id}/enable`,
8125
+ method: "POST",
8126
+ secure: true,
8127
+ ...params,
8128
+ }),
8129
+
7877
8130
  /**
7878
8131
  * No description
7879
8132
  *
@@ -9058,7 +9311,7 @@ export class Api<
9058
9311
  method: "PATCH",
9059
9312
  body: data,
9060
9313
  secure: true,
9061
- type: ContentType.Json,
9314
+ type: ContentType.JsonPatch,
9062
9315
  format: "json",
9063
9316
  ...params,
9064
9317
  }),
@@ -9079,7 +9332,7 @@ export class Api<
9079
9332
  method: "POST",
9080
9333
  body: data,
9081
9334
  secure: true,
9082
- type: ContentType.Json,
9335
+ type: ContentType.JsonPatch,
9083
9336
  format: "json",
9084
9337
  ...params,
9085
9338
  }),
@@ -9111,7 +9364,7 @@ export class Api<
9111
9364
  query: query,
9112
9365
  body: data,
9113
9366
  secure: true,
9114
- type: ContentType.Json,
9367
+ type: ContentType.JsonPatch,
9115
9368
  format: "json",
9116
9369
  ...params,
9117
9370
  }),
@@ -9142,7 +9395,7 @@ export class Api<
9142
9395
  query: query,
9143
9396
  body: data,
9144
9397
  secure: true,
9145
- type: ContentType.Json,
9398
+ type: ContentType.JsonPatch,
9146
9399
  format: "json",
9147
9400
  ...params,
9148
9401
  }),
@@ -9168,7 +9421,7 @@ export class Api<
9168
9421
  method: "PATCH",
9169
9422
  body: data,
9170
9423
  secure: true,
9171
- type: ContentType.Json,
9424
+ type: ContentType.JsonPatch,
9172
9425
  format: "json",
9173
9426
  ...params,
9174
9427
  }),
@@ -9195,7 +9448,7 @@ export class Api<
9195
9448
  method: "PATCH",
9196
9449
  body: data,
9197
9450
  secure: true,
9198
- type: ContentType.Json,
9451
+ type: ContentType.JsonPatch,
9199
9452
  format: "json",
9200
9453
  ...params,
9201
9454
  }),
@@ -9352,7 +9605,7 @@ export class Api<
9352
9605
  method: "POST",
9353
9606
  body: data,
9354
9607
  secure: true,
9355
- type: ContentType.Json,
9608
+ type: ContentType.JsonPatch,
9356
9609
  format: "json",
9357
9610
  ...params,
9358
9611
  }),
@@ -9437,7 +9690,7 @@ export class Api<
9437
9690
  method: "PATCH",
9438
9691
  body: data,
9439
9692
  secure: true,
9440
- type: ContentType.Json,
9693
+ type: ContentType.JsonPatch,
9441
9694
  format: "json",
9442
9695
  ...params,
9443
9696
  }),
@@ -9517,7 +9770,7 @@ export class Api<
9517
9770
  method: "PATCH",
9518
9771
  body: data,
9519
9772
  secure: true,
9520
- type: ContentType.Json,
9773
+ type: ContentType.JsonPatch,
9521
9774
  format: "json",
9522
9775
  ...params,
9523
9776
  }),
@@ -9591,7 +9844,7 @@ export class Api<
9591
9844
  method: "POST",
9592
9845
  body: data,
9593
9846
  secure: true,
9594
- type: ContentType.Json,
9847
+ type: ContentType.JsonPatch,
9595
9848
  format: "json",
9596
9849
  ...params,
9597
9850
  }),
@@ -9654,7 +9907,7 @@ export class Api<
9654
9907
  method: "PUT",
9655
9908
  body: data,
9656
9909
  secure: true,
9657
- type: ContentType.Json,
9910
+ type: ContentType.JsonPatch,
9658
9911
  format: "json",
9659
9912
  ...params,
9660
9913
  }),
@@ -9705,7 +9958,7 @@ export class Api<
9705
9958
  query: query,
9706
9959
  body: data,
9707
9960
  secure: true,
9708
- type: ContentType.Json,
9961
+ type: ContentType.JsonPatch,
9709
9962
  format: "json",
9710
9963
  ...params,
9711
9964
  }),
@@ -9915,6 +10168,102 @@ export class Api<
9915
10168
  ...params,
9916
10169
  }),
9917
10170
 
10171
+ /**
10172
+ * No description
10173
+ *
10174
+ * @tags LoanCustomFieldValues
10175
+ * @name GetLoanCustomFieldValues
10176
+ * @summary Get all custom field values for a loan
10177
+ * @request GET:/api/loans/{loanId}/custom-fields
10178
+ * @secure
10179
+ * @response `200` `(CustomFieldValue)[]` Success
10180
+ */
10181
+ getLoanCustomFieldValues: (loanId: string, params: RequestParams = {}) =>
10182
+ this.request<CustomFieldValue[], any>({
10183
+ path: `/api/loans/${loanId}/custom-fields`,
10184
+ method: "GET",
10185
+ secure: true,
10186
+ format: "json",
10187
+ ...params,
10188
+ }),
10189
+
10190
+ /**
10191
+ * No description
10192
+ *
10193
+ * @tags LoanCustomFieldValues
10194
+ * @name BulkSetLoanCustomFieldValues
10195
+ * @summary Bulk set custom field values for a loan
10196
+ * @request PUT:/api/loans/{loanId}/custom-fields
10197
+ * @secure
10198
+ * @response `204` `void` No Content
10199
+ * @response `400` `ProblemDetails` Bad Request
10200
+ * @response `422` `ProblemDetails` Client Error
10201
+ */
10202
+ bulkSetLoanCustomFieldValues: (
10203
+ loanId: string,
10204
+ data: SetCustomFieldValueRequest[],
10205
+ params: RequestParams = {},
10206
+ ) =>
10207
+ this.request<void, ProblemDetails>({
10208
+ path: `/api/loans/${loanId}/custom-fields`,
10209
+ method: "PUT",
10210
+ body: data,
10211
+ secure: true,
10212
+ type: ContentType.Json,
10213
+ ...params,
10214
+ }),
10215
+
10216
+ /**
10217
+ * No description
10218
+ *
10219
+ * @tags LoanCustomFieldValues
10220
+ * @name SetLoanCustomFieldValue
10221
+ * @summary Set a single custom field value
10222
+ * @request PUT:/api/loans/{loanId}/custom-fields/{definitionId}
10223
+ * @secure
10224
+ * @response `204` `void` No Content
10225
+ * @response `400` `ProblemDetails` Bad Request
10226
+ * @response `404` `ProblemDetails` Not Found
10227
+ * @response `422` `ProblemDetails` Client Error
10228
+ */
10229
+ setLoanCustomFieldValue: (
10230
+ loanId: string,
10231
+ definitionId: string,
10232
+ data: SetSingleCustomFieldValueRequest,
10233
+ params: RequestParams = {},
10234
+ ) =>
10235
+ this.request<void, ProblemDetails>({
10236
+ path: `/api/loans/${loanId}/custom-fields/${definitionId}`,
10237
+ method: "PUT",
10238
+ body: data,
10239
+ secure: true,
10240
+ type: ContentType.Json,
10241
+ ...params,
10242
+ }),
10243
+
10244
+ /**
10245
+ * No description
10246
+ *
10247
+ * @tags LoanCustomFieldValues
10248
+ * @name DeleteLoanCustomFieldValue
10249
+ * @summary Remove a custom field value
10250
+ * @request DELETE:/api/loans/{loanId}/custom-fields/{definitionId}
10251
+ * @secure
10252
+ * @response `204` `void` No Content
10253
+ * @response `404` `ProblemDetails` Not Found
10254
+ */
10255
+ deleteLoanCustomFieldValue: (
10256
+ loanId: string,
10257
+ definitionId: string,
10258
+ params: RequestParams = {},
10259
+ ) =>
10260
+ this.request<void, ProblemDetails>({
10261
+ path: `/api/loans/${loanId}/custom-fields/${definitionId}`,
10262
+ method: "DELETE",
10263
+ secure: true,
10264
+ ...params,
10265
+ }),
10266
+
9918
10267
  /**
9919
10268
  * No description
9920
10269
  *
@@ -9988,6 +10337,32 @@ export class Api<
9988
10337
  ...params,
9989
10338
  }),
9990
10339
 
10340
+ /**
10341
+ * No description
10342
+ *
10343
+ * @tags LoanDocuments
10344
+ * @name GetLoanDocumentPreviews
10345
+ * @summary Get document previews in batch
10346
+ * @request POST:/api/loans/{loanId}/documents/previews
10347
+ * @secure
10348
+ * @response `200` `Record<string,string>` Success
10349
+ * @response `400` `ProblemDetails` Bad Request
10350
+ */
10351
+ getLoanDocumentPreviews: (
10352
+ loanId: string,
10353
+ data: LoanDocumentPreviewsRequest,
10354
+ params: RequestParams = {},
10355
+ ) =>
10356
+ this.request<Record<string, string>, ProblemDetails>({
10357
+ path: `/api/loans/${loanId}/documents/previews`,
10358
+ method: "POST",
10359
+ body: data,
10360
+ secure: true,
10361
+ type: ContentType.Json,
10362
+ format: "json",
10363
+ ...params,
10364
+ }),
10365
+
9991
10366
  /**
9992
10367
  * No description
9993
10368
  *
@@ -10060,7 +10435,7 @@ export class Api<
10060
10435
  * @summary Download By ID
10061
10436
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
10062
10437
  * @secure
10063
- * @response `200` `Blob` Success
10438
+ * @response `200` `string` Success
10064
10439
  * @response `404` `ProblemDetails` Not Found
10065
10440
  */
10066
10441
  downloadLoanDocument: (
@@ -10068,7 +10443,7 @@ export class Api<
10068
10443
  documentId: string,
10069
10444
  params: RequestParams = {},
10070
10445
  ) =>
10071
- this.request<Blob, ProblemDetails>({
10446
+ this.request<string, ProblemDetails>({
10072
10447
  path: `/api/loans/${loanId}/documents/${documentId}/download`,
10073
10448
  method: "GET",
10074
10449
  secure: true,
@@ -11080,6 +11455,33 @@ export class Api<
11080
11455
  ...params,
11081
11456
  }),
11082
11457
 
11458
+ /**
11459
+ * No description
11460
+ *
11461
+ * @tags Loans
11462
+ * @name TriggerAso
11463
+ * @summary Trigger ASO services
11464
+ * @request POST:/api/loans/{loanId}/aso
11465
+ * @secure
11466
+ * @response `200` `AutomatedService` Success
11467
+ * @response `400` `ProblemDetails` Bad Request
11468
+ * @response `404` `ProblemDetails` Not Found
11469
+ */
11470
+ triggerAso: (
11471
+ loanId: string,
11472
+ data: TriggerAsoRequest,
11473
+ params: RequestParams = {},
11474
+ ) =>
11475
+ this.request<AutomatedService, ProblemDetails>({
11476
+ path: `/api/loans/${loanId}/aso`,
11477
+ method: "POST",
11478
+ body: data,
11479
+ secure: true,
11480
+ type: ContentType.JsonPatch,
11481
+ format: "json",
11482
+ ...params,
11483
+ }),
11484
+
11083
11485
  /**
11084
11486
  * No description
11085
11487
  *
@@ -11111,7 +11513,7 @@ export class Api<
11111
11513
  query: query,
11112
11514
  body: data,
11113
11515
  secure: true,
11114
- type: ContentType.Json,
11516
+ type: ContentType.JsonPatch,
11115
11517
  format: "json",
11116
11518
  ...params,
11117
11519
  }),
@@ -11163,7 +11565,7 @@ export class Api<
11163
11565
  method: "POST",
11164
11566
  body: data,
11165
11567
  secure: true,
11166
- type: ContentType.Json,
11568
+ type: ContentType.JsonPatch,
11167
11569
  format: "json",
11168
11570
  ...params,
11169
11571
  }),
@@ -11191,7 +11593,7 @@ export class Api<
11191
11593
  method: "PUT",
11192
11594
  body: data,
11193
11595
  secure: true,
11194
- type: ContentType.Json,
11596
+ type: ContentType.JsonPatch,
11195
11597
  format: "json",
11196
11598
  ...params,
11197
11599
  }),
@@ -12274,7 +12676,16 @@ export class Api<
12274
12676
  query?: {
12275
12677
  showAll?: boolean;
12276
12678
  /** @default "Realtor" */
12277
- role?: GetPartnersParamsRoleEnum;
12679
+ role?:
12680
+ | "Borrower"
12681
+ | "LoanOfficer"
12682
+ | "Admin"
12683
+ | "SuperAdmin"
12684
+ | "Realtor"
12685
+ | "SettlementAgent"
12686
+ | "LoanProcessor"
12687
+ | "LoanOfficerAssistant"
12688
+ | "SystemAdmin";
12278
12689
  /** @format int32 */
12279
12690
  pageSize?: number;
12280
12691
  /** @format int32 */
@@ -12610,7 +13021,7 @@ export class Api<
12610
13021
  * @response `404` `ProblemDetails` Not Found
12611
13022
  */
12612
13023
  getSamlMetadata: (
12613
- sSoIntegration: GetSamlMetadataParamsEnum,
13024
+ sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
12614
13025
  ssoIntegration: string,
12615
13026
  params: RequestParams = {},
12616
13027
  ) =>
@@ -12632,7 +13043,7 @@ export class Api<
12632
13043
  * @response `200` `File` Success
12633
13044
  */
12634
13045
  createOrReplaceSamlMetadata: (
12635
- sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum,
13046
+ sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
12636
13047
  ssoIntegration: string,
12637
13048
  params: RequestParams = {},
12638
13049
  ) =>
@@ -13133,6 +13544,39 @@ export class Api<
13133
13544
  ...params,
13134
13545
  }),
13135
13546
 
13547
+ /**
13548
+ * No description
13549
+ *
13550
+ * @tags TheBigPOS
13551
+ * @name SearchLosSyncs
13552
+ * @request POST:/api/los/encompass/syncs/{loanId}/search
13553
+ * @secure
13554
+ * @response `200` `LosSyncPaginated` Success
13555
+ */
13556
+ searchLosSyncs: (
13557
+ loanId: string,
13558
+ query: {
13559
+ /** @format int32 */
13560
+ pageSize: number;
13561
+ /** @format int32 */
13562
+ pageNumber: number;
13563
+ sortBy?: string;
13564
+ sortDirection?: string;
13565
+ },
13566
+ data: LosSyncSearchCriteria,
13567
+ params: RequestParams = {},
13568
+ ) =>
13569
+ this.request<LosSyncPaginated, any>({
13570
+ path: `/api/los/encompass/syncs/${loanId}/search`,
13571
+ method: "POST",
13572
+ query: query,
13573
+ body: data,
13574
+ secure: true,
13575
+ type: ContentType.Json,
13576
+ format: "json",
13577
+ ...params,
13578
+ }),
13579
+
13136
13580
  /**
13137
13581
  * No description
13138
13582
  *