@matech/thebigpos-sdk 2.37.9-rc1 → 2.38.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/index.ts CHANGED
@@ -10,6 +10,8 @@
10
10
  * ---------------------------------------------------------------
11
11
  */
12
12
 
13
+ export type VersionStatusType = "Draft" | "Published";
14
+
13
15
  export type UserRole =
14
16
  | "Borrower"
15
17
  | "LoanOfficer"
@@ -29,6 +31,8 @@ export type SiteConfigurationType =
29
31
  | "LoanOfficer"
30
32
  | "Partner";
31
33
 
34
+ export type SigningMethod = "CustomerConnect" | "POSF";
35
+
32
36
  export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
33
37
 
34
38
  export type LogLevel = "None" | "Info" | "Warning" | "Error";
@@ -434,7 +438,7 @@ export interface AccountBilling {
434
438
  }
435
439
 
436
440
  export interface AccountBillingRequest {
437
- billingType: AccountBillingRequestBillingTypeEnum;
441
+ billingType: "ClosedLoan" | "LoanOfficer";
438
442
  /**
439
443
  * @format double
440
444
  * @min 0
@@ -767,7 +771,12 @@ export interface AuditLogEntry {
767
771
  /** @format uuid */
768
772
  id: string;
769
773
  entityType: string;
770
- changeType: AuditLogEntryChangeTypeEnum;
774
+ changeType:
775
+ | "Created"
776
+ | "Modified"
777
+ | "SoftDeleted"
778
+ | "HardDeleted"
779
+ | "Restored";
771
780
  /** @format uuid */
772
781
  entityId: string;
773
782
  performedBy?: AuditLogUser | null;
@@ -1058,7 +1067,7 @@ export interface CorporateSearchCriteria {
1058
1067
  }
1059
1068
 
1060
1069
  export interface CreateAccessScopeRequest {
1061
- scopeType: CreateAccessScopeRequestScopeTypeEnum;
1070
+ scopeType: "User" | "Branch";
1062
1071
  /** @format uuid */
1063
1072
  userId?: string | null;
1064
1073
  /** @format uuid */
@@ -1082,7 +1091,7 @@ export interface CreateAccountRequest {
1082
1091
  */
1083
1092
  nlmsid: number;
1084
1093
  settings: AccountSettingsRequest;
1085
- environment: CreateAccountRequestEnvironmentEnum;
1094
+ environment: "Development" | "Staging" | "UAT" | "Production";
1086
1095
  losIntegration: LOSIntegration;
1087
1096
  billingSettings: AccountBillingRequest;
1088
1097
  }
@@ -1115,7 +1124,19 @@ export interface CreateDocumentTemplateRequest {
1115
1124
  export interface CreateGroupMemberRequest {
1116
1125
  /** @format uuid */
1117
1126
  userId: string;
1118
- loanRole: CreateGroupMemberRequestLoanRoleEnum;
1127
+ loanRole:
1128
+ | "Borrower"
1129
+ | "CoBorrower"
1130
+ | "NonBorrower"
1131
+ | "LoanOfficer"
1132
+ | "LoanProcessor"
1133
+ | "LoanOfficerAssistant"
1134
+ | "SupportingLoanOfficer"
1135
+ | "BuyerAgent"
1136
+ | "SellerAgent"
1137
+ | "TitleInsuranceAgent"
1138
+ | "EscrowAgent"
1139
+ | "SettlementAgent";
1119
1140
  }
1120
1141
 
1121
1142
  export interface CreateInviteRequest {
@@ -1127,7 +1148,7 @@ export interface CreateInviteRequest {
1127
1148
  emailAddress: string;
1128
1149
  phoneNumber?: string | null;
1129
1150
  /** @deprecated */
1130
- relationship: CreateInviteRequestRelationshipEnum;
1151
+ relationship: "NotApplicable" | "Spouse" | "NonSpouse";
1131
1152
  loanID: string;
1132
1153
  route?: string | null;
1133
1154
  /** @format uuid */
@@ -1150,7 +1171,7 @@ export interface CreateLoanImportRequest {
1150
1171
  * @minLength 1
1151
1172
  */
1152
1173
  startDate: string;
1153
- importMode: CreateLoanImportRequestImportModeEnum;
1174
+ importMode: "All" | "NewOnly" | "UpdateOnly";
1154
1175
  }
1155
1176
 
1156
1177
  export interface CreateSession {
@@ -1172,7 +1193,19 @@ export interface CreateUserDeviceRequest {
1172
1193
  }
1173
1194
 
1174
1195
  export interface CreateUserDraft {
1175
- loanRole: CreateUserDraftLoanRoleEnum;
1196
+ loanRole:
1197
+ | "Borrower"
1198
+ | "CoBorrower"
1199
+ | "NonBorrower"
1200
+ | "LoanOfficer"
1201
+ | "LoanProcessor"
1202
+ | "LoanOfficerAssistant"
1203
+ | "SupportingLoanOfficer"
1204
+ | "BuyerAgent"
1205
+ | "SellerAgent"
1206
+ | "TitleInsuranceAgent"
1207
+ | "EscrowAgent"
1208
+ | "SettlementAgent";
1176
1209
  }
1177
1210
 
1178
1211
  export interface CreateUserGroupRequest {
@@ -1490,7 +1523,7 @@ export interface Draft {
1490
1523
  siteConfiguration: SiteConfigurationReduced;
1491
1524
  /** @format uuid */
1492
1525
  loanID?: string | null;
1493
- type: DraftTypeEnum;
1526
+ type: "NewLoan" | "EditLoan";
1494
1527
  isCoBorrower: boolean;
1495
1528
  }
1496
1529
 
@@ -1509,7 +1542,7 @@ export interface DraftContent {
1509
1542
  siteConfiguration: SiteConfigurationReduced;
1510
1543
  /** @format uuid */
1511
1544
  loanID?: string | null;
1512
- type: DraftContentTypeEnum;
1545
+ type: "NewLoan" | "EditLoan";
1513
1546
  isCoBorrower: boolean;
1514
1547
  applicationPayload: any;
1515
1548
  }
@@ -1651,8 +1684,15 @@ export interface EncompassRequestLog {
1651
1684
  losId?: string | null;
1652
1685
  /** @format uuid */
1653
1686
  accountId: string;
1654
- operationType: EncompassRequestLogOperationTypeEnum;
1655
- outcome: EncompassRequestLogOutcomeEnum;
1687
+ operationType:
1688
+ | "FieldUpdate"
1689
+ | "EConsentUpdate"
1690
+ | "DocumentSync"
1691
+ | "MilestoneUpdate"
1692
+ | "DocumentAttachment"
1693
+ | "General"
1694
+ | "FieldReader";
1695
+ outcome: "Success" | "Failure" | "PartialSuccess";
1656
1696
  message: string;
1657
1697
  endpoint?: string | null;
1658
1698
  httpMethod?: string | null;
@@ -1889,7 +1929,20 @@ export interface FusionFieldDisplay {
1889
1929
  }
1890
1930
 
1891
1931
  export interface FusionReportFilter {
1892
- filterType: FusionReportFilterFilterTypeEnum;
1932
+ filterType:
1933
+ | "DateGreaterThanOrEqualTo"
1934
+ | "DateGreaterThan"
1935
+ | "DateLessThan"
1936
+ | "DateLessThanOrEqualTo"
1937
+ | "DateEquals"
1938
+ | "DateDoesntEqual"
1939
+ | "DateNonEmpty"
1940
+ | "DateEmpty"
1941
+ | "StringContains"
1942
+ | "StringEquals"
1943
+ | "StringNotEmpty"
1944
+ | "StringNotEquals"
1945
+ | "StringNotContains";
1893
1946
  targetField: string;
1894
1947
  targetValue: string;
1895
1948
  }
@@ -2017,7 +2070,40 @@ export interface GuidPatchOperation {
2017
2070
  }
2018
2071
 
2019
2072
  export interface IPAddress {
2020
- addressFamily: IpAddressAddressFamilyEnum;
2073
+ addressFamily:
2074
+ | "Unspecified"
2075
+ | "Unix"
2076
+ | "InterNetwork"
2077
+ | "ImpLink"
2078
+ | "Pup"
2079
+ | "Chaos"
2080
+ | "NS"
2081
+ | "Ipx"
2082
+ | "Iso"
2083
+ | "Osi"
2084
+ | "Ecma"
2085
+ | "DataKit"
2086
+ | "Ccitt"
2087
+ | "Sna"
2088
+ | "DecNet"
2089
+ | "DataLink"
2090
+ | "Lat"
2091
+ | "HyperChannel"
2092
+ | "AppleTalk"
2093
+ | "NetBios"
2094
+ | "VoiceView"
2095
+ | "FireFox"
2096
+ | "Banyan"
2097
+ | "Atm"
2098
+ | "InterNetworkV6"
2099
+ | "Cluster"
2100
+ | "Ieee12844"
2101
+ | "Irda"
2102
+ | "NetworkDesigners"
2103
+ | "Max"
2104
+ | "Packet"
2105
+ | "ControllerAreaNetwork"
2106
+ | "Unknown";
2021
2107
  /** @format int64 */
2022
2108
  scopeId: number;
2023
2109
  isIPv6Multicast: boolean;
@@ -2284,6 +2370,7 @@ export interface Loan {
2284
2370
  nonOwningBorrowers: LoanNonOwningBorrower[];
2285
2371
  userLoans: UserLoan[];
2286
2372
  contacts: LoanContact[];
2373
+ signingMethod: "CustomerConnect" | "POSF";
2287
2374
  }
2288
2375
 
2289
2376
  export interface LoanApplication {
@@ -2341,7 +2428,7 @@ export interface LoanBorrower {
2341
2428
  citizenship?: LoanCitizenship | null;
2342
2429
  maritalStatus?: LoanMaritalStatus | null;
2343
2430
  languagePreference?: LoanLanguagePreference | null;
2344
- applicationStatus: LoanBorrowerApplicationStatusEnum;
2431
+ applicationStatus: "Draft" | "Complete";
2345
2432
  /** @format int32 */
2346
2433
  numberOfDependents?: number | null;
2347
2434
  isPrimaryBorrower: boolean;
@@ -3266,7 +3353,19 @@ export interface LoanContact {
3266
3353
  email?: string | null;
3267
3354
  phone?: string | null;
3268
3355
  companyName?: string | null;
3269
- role: LoanContactRoleEnum;
3356
+ role:
3357
+ | "Borrower"
3358
+ | "CoBorrower"
3359
+ | "NonBorrower"
3360
+ | "LoanOfficer"
3361
+ | "LoanProcessor"
3362
+ | "LoanOfficerAssistant"
3363
+ | "SupportingLoanOfficer"
3364
+ | "BuyerAgent"
3365
+ | "SellerAgent"
3366
+ | "TitleInsuranceAgent"
3367
+ | "EscrowAgent"
3368
+ | "SettlementAgent";
3270
3369
  }
3271
3370
 
3272
3371
  export interface LoanContactList {
@@ -3402,14 +3501,19 @@ export interface LoanImport {
3402
3501
  /** @format int32 */
3403
3502
  importedCount: number;
3404
3503
  statusMessage?: string | null;
3405
- status: LoanImportStatusEnum;
3406
- importMode: LoanImportImportModeEnum;
3504
+ status:
3505
+ | "WaitingProcess"
3506
+ | "InProgress"
3507
+ | "Completed"
3508
+ | "Failed"
3509
+ | "Cancelled";
3510
+ importMode: "All" | "NewOnly" | "UpdateOnly";
3407
3511
  /** @format date-time */
3408
3512
  createdAt?: string | null;
3409
3513
  }
3410
3514
 
3411
3515
  export interface LoanImportLog {
3412
- level: LoanImportLogLevelEnum;
3516
+ level: "None" | "Info" | "Warning" | "Error";
3413
3517
  message: string;
3414
3518
  /** @format date-time */
3415
3519
  createdAt: string;
@@ -3470,8 +3574,22 @@ export interface LoanListPaginated {
3470
3574
  export interface LoanLog {
3471
3575
  /** @format uuid */
3472
3576
  id: string;
3473
- level: LoanLogLevelEnum;
3474
- type: LoanLogTypeEnum;
3577
+ level: "None" | "Info" | "Warning" | "Error";
3578
+ type:
3579
+ | "Loan"
3580
+ | "Queue"
3581
+ | "POSFlagChanged"
3582
+ | "Verification"
3583
+ | "DocumentUploaded"
3584
+ | "LoanCreated"
3585
+ | "WorkflowSubmitted"
3586
+ | "UserInvitationSent"
3587
+ | "CoBorrowerAdded"
3588
+ | "TaskCompleted"
3589
+ | "LoanStatusChanged"
3590
+ | "EConsent"
3591
+ | "SensitiveDataPurge"
3592
+ | "ClosingDateUpdated";
3475
3593
  message: string;
3476
3594
  /** @format date-time */
3477
3595
  createdAt: string;
@@ -3480,8 +3598,22 @@ export interface LoanLog {
3480
3598
  export interface LoanLogDetail {
3481
3599
  /** @format uuid */
3482
3600
  id: string;
3483
- level: LoanLogDetailLevelEnum;
3484
- type: LoanLogDetailTypeEnum;
3601
+ level: "None" | "Info" | "Warning" | "Error";
3602
+ type:
3603
+ | "Loan"
3604
+ | "Queue"
3605
+ | "POSFlagChanged"
3606
+ | "Verification"
3607
+ | "DocumentUploaded"
3608
+ | "LoanCreated"
3609
+ | "WorkflowSubmitted"
3610
+ | "UserInvitationSent"
3611
+ | "CoBorrowerAdded"
3612
+ | "TaskCompleted"
3613
+ | "LoanStatusChanged"
3614
+ | "EConsent"
3615
+ | "SensitiveDataPurge"
3616
+ | "ClosingDateUpdated";
3485
3617
  message: string;
3486
3618
  /** @format date-time */
3487
3619
  createdAt: string;
@@ -3765,7 +3897,19 @@ export interface LoanUser {
3765
3897
  email: string;
3766
3898
  phone?: string | null;
3767
3899
  role: string;
3768
- loanRole: LoanUserLoanRoleEnum;
3900
+ loanRole:
3901
+ | "Borrower"
3902
+ | "CoBorrower"
3903
+ | "NonBorrower"
3904
+ | "LoanOfficer"
3905
+ | "LoanProcessor"
3906
+ | "LoanOfficerAssistant"
3907
+ | "SupportingLoanOfficer"
3908
+ | "BuyerAgent"
3909
+ | "SellerAgent"
3910
+ | "TitleInsuranceAgent"
3911
+ | "EscrowAgent"
3912
+ | "SettlementAgent";
3769
3913
  isUser: boolean;
3770
3914
  /** @format date-time */
3771
3915
  createdAt: string;
@@ -3931,6 +4075,7 @@ export interface NotificationTemplate {
3931
4075
  /** @format uuid */
3932
4076
  id: string;
3933
4077
  htmlBody: string;
4078
+ key: string;
3934
4079
  name: string;
3935
4080
  plainBody: string;
3936
4081
  description?: string | null;
@@ -3956,6 +4101,7 @@ export interface NotificationTemplateBase {
3956
4101
  /** @format uuid */
3957
4102
  id: string;
3958
4103
  htmlBody: string;
4104
+ key: string;
3959
4105
  name: string;
3960
4106
  plainBody: string;
3961
4107
  description?: string | null;
@@ -3970,10 +4116,19 @@ export interface NotificationTemplateBase {
3970
4116
  useDefaultHeaderAndFooter: boolean;
3971
4117
  }
3972
4118
 
4119
+ export interface NotificationTemplateBasePaginated {
4120
+ rows: NotificationTemplateBase[];
4121
+ pagination: Pagination;
4122
+ /** @format int64 */
4123
+ count: number;
4124
+ }
4125
+
3973
4126
  export interface NotificationTemplateRequest {
3974
4127
  /** @minLength 1 */
3975
4128
  htmlBody: string;
3976
4129
  /** @minLength 1 */
4130
+ key: string;
4131
+ /** @minLength 1 */
3977
4132
  name: string;
3978
4133
  plainBody: string;
3979
4134
  description?: string | null;
@@ -3988,6 +4143,13 @@ export interface NotificationTemplateRequest {
3988
4143
  useDefaultHeaderAndFooter: boolean;
3989
4144
  }
3990
4145
 
4146
+ export interface NotificationTemplateSearchCriteria {
4147
+ searchText?: string | null;
4148
+ key?: string | null;
4149
+ status?: VersionStatusType | null;
4150
+ includeDefaults: boolean;
4151
+ }
4152
+
3991
4153
  export interface NotificationTemplateVersion {
3992
4154
  /** @format date-time */
3993
4155
  createdAt: string;
@@ -4054,7 +4216,7 @@ export interface NotificationTemplateVersionUpdateRequest {
4054
4216
 
4055
4217
  export interface Operation {
4056
4218
  op?: string;
4057
- value?: object | null;
4219
+ value?: string | number | boolean | null | object;
4058
4220
  path?: string;
4059
4221
  }
4060
4222
 
@@ -4410,7 +4572,7 @@ export interface SSOTokenRequest {
4410
4572
  }
4411
4573
 
4412
4574
  export interface SamlMetadataRequest {
4413
- ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
4575
+ ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
4414
4576
  }
4415
4577
 
4416
4578
  export interface SendForgotPasswordRequest {
@@ -4430,7 +4592,7 @@ export interface SendLoanDocumentsRequest {
4430
4592
  export interface SendNotificationForLoanRequest {
4431
4593
  /** @minLength 1 */
4432
4594
  loanID: string;
4433
- templateName: string;
4595
+ templateKey: string;
4434
4596
  loanOfficerEmail?: string | null;
4435
4597
  /** @format uuid */
4436
4598
  siteConfigurationId?: string | null;
@@ -4449,7 +4611,7 @@ export interface SiteConfiguration {
4449
4611
  deletedAt?: string | null;
4450
4612
  /** @format uuid */
4451
4613
  id: string;
4452
- type: SiteConfigurationTypeEnum;
4614
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4453
4615
  /** @format uuid */
4454
4616
  entityID: string;
4455
4617
  /** @format int32 */
@@ -4644,7 +4806,7 @@ export interface SiteConfigurationByUrl {
4644
4806
  deletedAt?: string | null;
4645
4807
  /** @format uuid */
4646
4808
  id: string;
4647
- type: SiteConfigurationByUrlTypeEnum;
4809
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4648
4810
  /** @format uuid */
4649
4811
  entityID: string;
4650
4812
  /** @format int32 */
@@ -4857,7 +5019,7 @@ export interface SiteConfigurationForm {
4857
5019
  export interface SiteConfigurationReduced {
4858
5020
  /** @format uuid */
4859
5021
  id: string;
4860
- type: SiteConfigurationReducedTypeEnum;
5022
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4861
5023
  url?: string | null;
4862
5024
  name: string;
4863
5025
  /** @format int64 */
@@ -4875,7 +5037,7 @@ export interface SiteConfigurationRequest {
4875
5037
  entityID: string;
4876
5038
  /** @format int32 */
4877
5039
  entityType: number;
4878
- type: SiteConfigurationRequestTypeEnum;
5040
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4879
5041
  url: string;
4880
5042
  name: string;
4881
5043
  introduction?: string | null;
@@ -5052,7 +5214,7 @@ export interface SiteConfigurationSearchCriteria {
5052
5214
  export interface SiteConfigurationSummary {
5053
5215
  /** @format uuid */
5054
5216
  id: string;
5055
- type: SiteConfigurationSummaryTypeEnum;
5217
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5056
5218
  url?: string | null;
5057
5219
  name: string;
5058
5220
  /** @format int64 */
@@ -5237,7 +5399,7 @@ export interface TestSendNotificationForLoanRequest {
5237
5399
  siteConfigurationId: string;
5238
5400
  toAddress?: string | null;
5239
5401
  toPhoneNumber?: string | null;
5240
- templateName?: string | null;
5402
+ templateKey?: string | null;
5241
5403
  attachments: Attachment[];
5242
5404
  }
5243
5405
 
@@ -5680,7 +5842,19 @@ export interface UserDevice {
5680
5842
  export interface UserDraft {
5681
5843
  /** @format uuid */
5682
5844
  draftID: string;
5683
- role: UserDraftRoleEnum;
5845
+ role:
5846
+ | "Borrower"
5847
+ | "CoBorrower"
5848
+ | "NonBorrower"
5849
+ | "LoanOfficer"
5850
+ | "LoanProcessor"
5851
+ | "LoanOfficerAssistant"
5852
+ | "SupportingLoanOfficer"
5853
+ | "BuyerAgent"
5854
+ | "SellerAgent"
5855
+ | "TitleInsuranceAgent"
5856
+ | "EscrowAgent"
5857
+ | "SettlementAgent";
5684
5858
  user: User;
5685
5859
  }
5686
5860
 
@@ -5707,7 +5881,7 @@ export interface UserGroupAccessScope {
5707
5881
  id: string;
5708
5882
  /** @format uuid */
5709
5883
  groupId: string;
5710
- scopeType: UserGroupAccessScopeScopeTypeEnum;
5884
+ scopeType: "User" | "Branch";
5711
5885
  /** @format uuid */
5712
5886
  userId?: string | null;
5713
5887
  /** @format uuid */
@@ -5743,7 +5917,19 @@ export interface UserLoan {
5743
5917
  deletedAt?: string | null;
5744
5918
  loanID: string;
5745
5919
  user: User;
5746
- role: UserLoanRoleEnum;
5920
+ role:
5921
+ | "Borrower"
5922
+ | "CoBorrower"
5923
+ | "NonBorrower"
5924
+ | "LoanOfficer"
5925
+ | "LoanProcessor"
5926
+ | "LoanOfficerAssistant"
5927
+ | "SupportingLoanOfficer"
5928
+ | "BuyerAgent"
5929
+ | "SellerAgent"
5930
+ | "TitleInsuranceAgent"
5931
+ | "EscrowAgent"
5932
+ | "SettlementAgent";
5747
5933
  /** @format int32 */
5748
5934
  borrowerPair?: number | null;
5749
5935
  /** @format int32 */
@@ -5756,10 +5942,10 @@ export interface UserLoanConsent {
5756
5942
  id: string;
5757
5943
  /** @format uuid */
5758
5944
  userLoanID: string;
5759
- type: UserLoanConsentTypeEnum;
5945
+ type: "Econsent" | "CreditAuthorization" | "Tcpa";
5760
5946
  providedConsent: boolean;
5761
5947
  ipAddress?: string | null;
5762
- losSyncStatus: UserLoanConsentLosSyncStatusEnum;
5948
+ losSyncStatus: "NotStarted" | "Failed" | "Success";
5763
5949
  /** @format date-time */
5764
5950
  createdAt: string;
5765
5951
  }
@@ -5904,7 +6090,16 @@ export interface UserSummary {
5904
6090
  id: string;
5905
6091
  name?: string | null;
5906
6092
  email?: string | null;
5907
- role: UserSummaryRoleEnum;
6093
+ role:
6094
+ | "Borrower"
6095
+ | "LoanOfficer"
6096
+ | "Admin"
6097
+ | "SuperAdmin"
6098
+ | "Realtor"
6099
+ | "SettlementAgent"
6100
+ | "LoanProcessor"
6101
+ | "LoanOfficerAssistant"
6102
+ | "SystemAdmin";
5908
6103
  }
5909
6104
 
5910
6105
  export interface VerifyPasswordRequest {
@@ -5940,335 +6135,6 @@ export interface Workflow {
5940
6135
  icon: string;
5941
6136
  }
5942
6137
 
5943
- export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
5944
-
5945
- export type AuditLogEntryChangeTypeEnum =
5946
- | "Created"
5947
- | "Modified"
5948
- | "SoftDeleted"
5949
- | "HardDeleted"
5950
- | "Restored";
5951
-
5952
- export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
5953
-
5954
- export type CreateAccountRequestEnvironmentEnum =
5955
- | "Development"
5956
- | "Staging"
5957
- | "UAT"
5958
- | "Production";
5959
-
5960
- export type CreateGroupMemberRequestLoanRoleEnum =
5961
- | "Borrower"
5962
- | "CoBorrower"
5963
- | "NonBorrower"
5964
- | "LoanOfficer"
5965
- | "LoanProcessor"
5966
- | "LoanOfficerAssistant"
5967
- | "SupportingLoanOfficer"
5968
- | "BuyerAgent"
5969
- | "SellerAgent"
5970
- | "TitleInsuranceAgent"
5971
- | "EscrowAgent"
5972
- | "SettlementAgent";
5973
-
5974
- /** @deprecated */
5975
- export type CreateInviteRequestRelationshipEnum =
5976
- | "NotApplicable"
5977
- | "Spouse"
5978
- | "NonSpouse";
5979
-
5980
- export type CreateLoanImportRequestImportModeEnum =
5981
- | "All"
5982
- | "NewOnly"
5983
- | "UpdateOnly";
5984
-
5985
- export type CreateUserDraftLoanRoleEnum =
5986
- | "Borrower"
5987
- | "CoBorrower"
5988
- | "NonBorrower"
5989
- | "LoanOfficer"
5990
- | "LoanProcessor"
5991
- | "LoanOfficerAssistant"
5992
- | "SupportingLoanOfficer"
5993
- | "BuyerAgent"
5994
- | "SellerAgent"
5995
- | "TitleInsuranceAgent"
5996
- | "EscrowAgent"
5997
- | "SettlementAgent";
5998
-
5999
- export type DraftTypeEnum = "NewLoan" | "EditLoan";
6000
-
6001
- export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
6002
-
6003
- export type EncompassRequestLogOperationTypeEnum =
6004
- | "FieldUpdate"
6005
- | "EConsentUpdate"
6006
- | "DocumentSync"
6007
- | "MilestoneUpdate"
6008
- | "DocumentAttachment"
6009
- | "General"
6010
- | "FieldReader";
6011
-
6012
- export type EncompassRequestLogOutcomeEnum =
6013
- | "Success"
6014
- | "Failure"
6015
- | "PartialSuccess";
6016
-
6017
- export type FusionReportFilterFilterTypeEnum =
6018
- | "DateGreaterThanOrEqualTo"
6019
- | "DateGreaterThan"
6020
- | "DateLessThan"
6021
- | "DateLessThanOrEqualTo"
6022
- | "DateEquals"
6023
- | "DateDoesntEqual"
6024
- | "DateNonEmpty"
6025
- | "DateEmpty"
6026
- | "StringContains"
6027
- | "StringEquals"
6028
- | "StringNotEmpty"
6029
- | "StringNotEquals"
6030
- | "StringNotContains";
6031
-
6032
- export type IpAddressAddressFamilyEnum =
6033
- | "Unspecified"
6034
- | "Unix"
6035
- | "InterNetwork"
6036
- | "ImpLink"
6037
- | "Pup"
6038
- | "Chaos"
6039
- | "NS"
6040
- | "Ipx"
6041
- | "Iso"
6042
- | "Osi"
6043
- | "Ecma"
6044
- | "DataKit"
6045
- | "Ccitt"
6046
- | "Sna"
6047
- | "DecNet"
6048
- | "DataLink"
6049
- | "Lat"
6050
- | "HyperChannel"
6051
- | "AppleTalk"
6052
- | "NetBios"
6053
- | "VoiceView"
6054
- | "FireFox"
6055
- | "Banyan"
6056
- | "Atm"
6057
- | "InterNetworkV6"
6058
- | "Cluster"
6059
- | "Ieee12844"
6060
- | "Irda"
6061
- | "NetworkDesigners"
6062
- | "Max"
6063
- | "Packet"
6064
- | "ControllerAreaNetwork"
6065
- | "Unknown";
6066
-
6067
- export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
6068
-
6069
- export type LoanContactRoleEnum =
6070
- | "Borrower"
6071
- | "CoBorrower"
6072
- | "NonBorrower"
6073
- | "LoanOfficer"
6074
- | "LoanProcessor"
6075
- | "LoanOfficerAssistant"
6076
- | "SupportingLoanOfficer"
6077
- | "BuyerAgent"
6078
- | "SellerAgent"
6079
- | "TitleInsuranceAgent"
6080
- | "EscrowAgent"
6081
- | "SettlementAgent";
6082
-
6083
- export type LoanImportStatusEnum =
6084
- | "WaitingProcess"
6085
- | "InProgress"
6086
- | "Completed"
6087
- | "Failed"
6088
- | "Cancelled";
6089
-
6090
- export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6091
-
6092
- export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6093
-
6094
- export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6095
-
6096
- export type LoanLogTypeEnum =
6097
- | "Loan"
6098
- | "Queue"
6099
- | "POSFlagChanged"
6100
- | "Verification"
6101
- | "DocumentUploaded"
6102
- | "LoanCreated"
6103
- | "WorkflowSubmitted"
6104
- | "UserInvitationSent"
6105
- | "CoBorrowerAdded"
6106
- | "TaskCompleted"
6107
- | "LoanStatusChanged"
6108
- | "EConsent"
6109
- | "SensitiveDataPurge"
6110
- | "ClosingDateUpdated";
6111
-
6112
- export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
6113
-
6114
- export type LoanLogDetailTypeEnum =
6115
- | "Loan"
6116
- | "Queue"
6117
- | "POSFlagChanged"
6118
- | "Verification"
6119
- | "DocumentUploaded"
6120
- | "LoanCreated"
6121
- | "WorkflowSubmitted"
6122
- | "UserInvitationSent"
6123
- | "CoBorrowerAdded"
6124
- | "TaskCompleted"
6125
- | "LoanStatusChanged"
6126
- | "EConsent"
6127
- | "SensitiveDataPurge"
6128
- | "ClosingDateUpdated";
6129
-
6130
- export type LoanUserLoanRoleEnum =
6131
- | "Borrower"
6132
- | "CoBorrower"
6133
- | "NonBorrower"
6134
- | "LoanOfficer"
6135
- | "LoanProcessor"
6136
- | "LoanOfficerAssistant"
6137
- | "SupportingLoanOfficer"
6138
- | "BuyerAgent"
6139
- | "SellerAgent"
6140
- | "TitleInsuranceAgent"
6141
- | "EscrowAgent"
6142
- | "SettlementAgent";
6143
-
6144
- export type SamlMetadataRequestSsoIntegrationEnum =
6145
- | "ConsumerConnect"
6146
- | "TheBigPOS"
6147
- | "POSF";
6148
-
6149
- export type SiteConfigurationTypeEnum =
6150
- | "None"
6151
- | "Account"
6152
- | "Corporate"
6153
- | "Branch"
6154
- | "LoanOfficer"
6155
- | "Partner";
6156
-
6157
- export type SiteConfigurationByUrlTypeEnum =
6158
- | "None"
6159
- | "Account"
6160
- | "Corporate"
6161
- | "Branch"
6162
- | "LoanOfficer"
6163
- | "Partner";
6164
-
6165
- export type SiteConfigurationReducedTypeEnum =
6166
- | "None"
6167
- | "Account"
6168
- | "Corporate"
6169
- | "Branch"
6170
- | "LoanOfficer"
6171
- | "Partner";
6172
-
6173
- export type SiteConfigurationRequestTypeEnum =
6174
- | "None"
6175
- | "Account"
6176
- | "Corporate"
6177
- | "Branch"
6178
- | "LoanOfficer"
6179
- | "Partner";
6180
-
6181
- export type SiteConfigurationSummaryTypeEnum =
6182
- | "None"
6183
- | "Account"
6184
- | "Corporate"
6185
- | "Branch"
6186
- | "LoanOfficer"
6187
- | "Partner";
6188
-
6189
- export type UserDraftRoleEnum =
6190
- | "Borrower"
6191
- | "CoBorrower"
6192
- | "NonBorrower"
6193
- | "LoanOfficer"
6194
- | "LoanProcessor"
6195
- | "LoanOfficerAssistant"
6196
- | "SupportingLoanOfficer"
6197
- | "BuyerAgent"
6198
- | "SellerAgent"
6199
- | "TitleInsuranceAgent"
6200
- | "EscrowAgent"
6201
- | "SettlementAgent";
6202
-
6203
- export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
6204
-
6205
- export type UserLoanRoleEnum =
6206
- | "Borrower"
6207
- | "CoBorrower"
6208
- | "NonBorrower"
6209
- | "LoanOfficer"
6210
- | "LoanProcessor"
6211
- | "LoanOfficerAssistant"
6212
- | "SupportingLoanOfficer"
6213
- | "BuyerAgent"
6214
- | "SellerAgent"
6215
- | "TitleInsuranceAgent"
6216
- | "EscrowAgent"
6217
- | "SettlementAgent";
6218
-
6219
- export type UserLoanConsentTypeEnum =
6220
- | "Econsent"
6221
- | "CreditAuthorization"
6222
- | "Tcpa";
6223
-
6224
- export type UserLoanConsentLosSyncStatusEnum =
6225
- | "NotStarted"
6226
- | "Failed"
6227
- | "Success";
6228
-
6229
- export type UserSummaryRoleEnum =
6230
- | "Borrower"
6231
- | "LoanOfficer"
6232
- | "Admin"
6233
- | "SuperAdmin"
6234
- | "Realtor"
6235
- | "SettlementAgent"
6236
- | "LoanProcessor"
6237
- | "LoanOfficerAssistant"
6238
- | "SystemAdmin";
6239
-
6240
- /** @default "Realtor" */
6241
- export type GetPartnersParamsRoleEnum =
6242
- | "Borrower"
6243
- | "LoanOfficer"
6244
- | "Admin"
6245
- | "SuperAdmin"
6246
- | "Realtor"
6247
- | "SettlementAgent"
6248
- | "LoanProcessor"
6249
- | "LoanOfficerAssistant"
6250
- | "SystemAdmin";
6251
-
6252
- export type GetSamlMetadataParamsSSoIntegrationEnum =
6253
- | "ConsumerConnect"
6254
- | "TheBigPOS"
6255
- | "POSF";
6256
-
6257
- export type GetSamlMetadataParamsEnum =
6258
- | "ConsumerConnect"
6259
- | "TheBigPOS"
6260
- | "POSF";
6261
-
6262
- export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum =
6263
- | "ConsumerConnect"
6264
- | "TheBigPOS"
6265
- | "POSF";
6266
-
6267
- export type CreateOrReplaceSamlMetadataParamsEnum =
6268
- | "ConsumerConnect"
6269
- | "TheBigPOS"
6270
- | "POSF";
6271
-
6272
6138
  import type {
6273
6139
  AxiosInstance,
6274
6140
  AxiosRequestConfig,
@@ -6311,6 +6177,7 @@ export interface ApiConfig<SecurityDataType = unknown>
6311
6177
  }
6312
6178
 
6313
6179
  export enum ContentType {
6180
+ JsonPatch = "application/json-patch+json",
6314
6181
  Json = "application/json",
6315
6182
  JsonApi = "application/vnd.api+json",
6316
6183
  FormData = "multipart/form-data",
@@ -6446,7 +6313,7 @@ export class HttpClient<SecurityDataType = unknown> {
6446
6313
 
6447
6314
  /**
6448
6315
  * @title The Big POS API
6449
- * @version v2.37.8
6316
+ * @version v2.38.0
6450
6317
  * @termsOfService https://www.thebigpos.com/terms-of-use/
6451
6318
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
6452
6319
  */
@@ -8050,6 +7917,8 @@ export class Api<
8050
7917
  * @default 20
8051
7918
  */
8052
7919
  pageSize?: number;
7920
+ /** @format uuid */
7921
+ loanId?: string;
8053
7922
  },
8054
7923
  params: RequestParams = {},
8055
7924
  ) =>
@@ -8775,7 +8644,7 @@ export class Api<
8775
8644
  method: "PATCH",
8776
8645
  body: data,
8777
8646
  secure: true,
8778
- type: ContentType.Json,
8647
+ type: ContentType.JsonPatch,
8779
8648
  format: "json",
8780
8649
  ...params,
8781
8650
  }),
@@ -8796,7 +8665,7 @@ export class Api<
8796
8665
  method: "POST",
8797
8666
  body: data,
8798
8667
  secure: true,
8799
- type: ContentType.Json,
8668
+ type: ContentType.JsonPatch,
8800
8669
  format: "json",
8801
8670
  ...params,
8802
8671
  }),
@@ -8885,7 +8754,7 @@ export class Api<
8885
8754
  method: "PATCH",
8886
8755
  body: data,
8887
8756
  secure: true,
8888
- type: ContentType.Json,
8757
+ type: ContentType.JsonPatch,
8889
8758
  format: "json",
8890
8759
  ...params,
8891
8760
  }),
@@ -8912,7 +8781,7 @@ export class Api<
8912
8781
  method: "PATCH",
8913
8782
  body: data,
8914
8783
  secure: true,
8915
- type: ContentType.Json,
8784
+ type: ContentType.JsonPatch,
8916
8785
  format: "json",
8917
8786
  ...params,
8918
8787
  }),
@@ -9069,7 +8938,7 @@ export class Api<
9069
8938
  method: "POST",
9070
8939
  body: data,
9071
8940
  secure: true,
9072
- type: ContentType.Json,
8941
+ type: ContentType.JsonPatch,
9073
8942
  format: "json",
9074
8943
  ...params,
9075
8944
  }),
@@ -9154,7 +9023,7 @@ export class Api<
9154
9023
  method: "PATCH",
9155
9024
  body: data,
9156
9025
  secure: true,
9157
- type: ContentType.Json,
9026
+ type: ContentType.JsonPatch,
9158
9027
  format: "json",
9159
9028
  ...params,
9160
9029
  }),
@@ -9234,7 +9103,7 @@ export class Api<
9234
9103
  method: "PATCH",
9235
9104
  body: data,
9236
9105
  secure: true,
9237
- type: ContentType.Json,
9106
+ type: ContentType.JsonPatch,
9238
9107
  format: "json",
9239
9108
  ...params,
9240
9109
  }),
@@ -9308,7 +9177,7 @@ export class Api<
9308
9177
  method: "POST",
9309
9178
  body: data,
9310
9179
  secure: true,
9311
- type: ContentType.Json,
9180
+ type: ContentType.JsonPatch,
9312
9181
  format: "json",
9313
9182
  ...params,
9314
9183
  }),
@@ -10828,7 +10697,7 @@ export class Api<
10828
10697
  query: query,
10829
10698
  body: data,
10830
10699
  secure: true,
10831
- type: ContentType.Json,
10700
+ type: ContentType.JsonPatch,
10832
10701
  format: "json",
10833
10702
  ...params,
10834
10703
  }),
@@ -10880,7 +10749,7 @@ export class Api<
10880
10749
  method: "POST",
10881
10750
  body: data,
10882
10751
  secure: true,
10883
- type: ContentType.Json,
10752
+ type: ContentType.JsonPatch,
10884
10753
  format: "json",
10885
10754
  ...params,
10886
10755
  }),
@@ -10994,6 +10863,28 @@ export class Api<
10994
10863
  ...params,
10995
10864
  }),
10996
10865
 
10866
+ /**
10867
+ * No description
10868
+ *
10869
+ * @tags LoanTaskNotifications
10870
+ * @name SendOutstandingLoanTaskNotification
10871
+ * @summary Send Outstanding Task Notification
10872
+ * @request POST:/api/loans/{loanID}/tasks/reminders/outstanding
10873
+ * @secure
10874
+ * @response `204` `void` No Content
10875
+ * @response `404` `ProblemDetails` Not Found
10876
+ */
10877
+ sendOutstandingLoanTaskNotification: (
10878
+ loanId: string,
10879
+ params: RequestParams = {},
10880
+ ) =>
10881
+ this.request<void, ProblemDetails>({
10882
+ path: `/api/loans/${loanId}/tasks/reminders/outstanding`,
10883
+ method: "POST",
10884
+ secure: true,
10885
+ ...params,
10886
+ }),
10887
+
10997
10888
  /**
10998
10889
  * No description
10999
10890
  *
@@ -11157,28 +11048,6 @@ export class Api<
11157
11048
  ...params,
11158
11049
  }),
11159
11050
 
11160
- /**
11161
- * No description
11162
- *
11163
- * @tags LoanTasks
11164
- * @name SendOutstandingLoanTaskNotification
11165
- * @summary Send Outstanding Task Notification
11166
- * @request POST:/api/loans/{loanID}/tasks/reminders/outstanding
11167
- * @secure
11168
- * @response `204` `void` No Content
11169
- * @response `404` `ProblemDetails` Not Found
11170
- */
11171
- sendOutstandingLoanTaskNotification: (
11172
- loanId: string,
11173
- params: RequestParams = {},
11174
- ) =>
11175
- this.request<void, ProblemDetails>({
11176
- path: `/api/loans/${loanId}/tasks/reminders/outstanding`,
11177
- method: "POST",
11178
- secure: true,
11179
- ...params,
11180
- }),
11181
-
11182
11051
  /**
11183
11052
  * No description
11184
11053
  *
@@ -11625,6 +11494,39 @@ export class Api<
11625
11494
  ...params,
11626
11495
  }),
11627
11496
 
11497
+ /**
11498
+ * No description
11499
+ *
11500
+ * @tags NotificationTemplates
11501
+ * @name SearchNotificationTemplates
11502
+ * @summary Search
11503
+ * @request POST:/api/notification-templates/search
11504
+ * @secure
11505
+ * @response `200` `NotificationTemplateBasePaginated` Success
11506
+ */
11507
+ searchNotificationTemplates: (
11508
+ data: NotificationTemplateSearchCriteria,
11509
+ query?: {
11510
+ /** @format int32 */
11511
+ pageSize?: number;
11512
+ /** @format int32 */
11513
+ pageNumber?: number;
11514
+ sortBy?: string;
11515
+ sortDirection?: string;
11516
+ },
11517
+ params: RequestParams = {},
11518
+ ) =>
11519
+ this.request<NotificationTemplateBasePaginated, any>({
11520
+ path: `/api/notification-templates/search`,
11521
+ method: "POST",
11522
+ query: query,
11523
+ body: data,
11524
+ secure: true,
11525
+ type: ContentType.Json,
11526
+ format: "json",
11527
+ ...params,
11528
+ }),
11529
+
11628
11530
  /**
11629
11531
  * No description
11630
11532
  *
@@ -11840,7 +11742,16 @@ export class Api<
11840
11742
  query?: {
11841
11743
  showAll?: boolean;
11842
11744
  /** @default "Realtor" */
11843
- role?: GetPartnersParamsRoleEnum;
11745
+ role?:
11746
+ | "Borrower"
11747
+ | "LoanOfficer"
11748
+ | "Admin"
11749
+ | "SuperAdmin"
11750
+ | "Realtor"
11751
+ | "SettlementAgent"
11752
+ | "LoanProcessor"
11753
+ | "LoanOfficerAssistant"
11754
+ | "SystemAdmin";
11844
11755
  /** @format int32 */
11845
11756
  pageSize?: number;
11846
11757
  /** @format int32 */
@@ -12176,7 +12087,7 @@ export class Api<
12176
12087
  * @response `404` `ProblemDetails` Not Found
12177
12088
  */
12178
12089
  getSamlMetadata: (
12179
- sSoIntegration: GetSamlMetadataParamsEnum,
12090
+ sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
12180
12091
  ssoIntegration: string,
12181
12092
  params: RequestParams = {},
12182
12093
  ) =>
@@ -12198,7 +12109,7 @@ export class Api<
12198
12109
  * @response `200` `File` Success
12199
12110
  */
12200
12111
  createOrReplaceSamlMetadata: (
12201
- sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum,
12112
+ sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
12202
12113
  ssoIntegration: string,
12203
12114
  params: RequestParams = {},
12204
12115
  ) =>