@matech/thebigpos-sdk 2.37.9-rc0 → 2.38.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
@@ -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"
@@ -434,7 +436,7 @@ export interface AccountBilling {
434
436
  }
435
437
 
436
438
  export interface AccountBillingRequest {
437
- billingType: AccountBillingRequestBillingTypeEnum;
439
+ billingType: "ClosedLoan" | "LoanOfficer";
438
440
  /**
439
441
  * @format double
440
442
  * @min 0
@@ -767,7 +769,12 @@ export interface AuditLogEntry {
767
769
  /** @format uuid */
768
770
  id: string;
769
771
  entityType: string;
770
- changeType: AuditLogEntryChangeTypeEnum;
772
+ changeType:
773
+ | "Created"
774
+ | "Modified"
775
+ | "SoftDeleted"
776
+ | "HardDeleted"
777
+ | "Restored";
771
778
  /** @format uuid */
772
779
  entityId: string;
773
780
  performedBy?: AuditLogUser | null;
@@ -1058,7 +1065,7 @@ export interface CorporateSearchCriteria {
1058
1065
  }
1059
1066
 
1060
1067
  export interface CreateAccessScopeRequest {
1061
- scopeType: CreateAccessScopeRequestScopeTypeEnum;
1068
+ scopeType: "User" | "Branch";
1062
1069
  /** @format uuid */
1063
1070
  userId?: string | null;
1064
1071
  /** @format uuid */
@@ -1082,7 +1089,7 @@ export interface CreateAccountRequest {
1082
1089
  */
1083
1090
  nlmsid: number;
1084
1091
  settings: AccountSettingsRequest;
1085
- environment: CreateAccountRequestEnvironmentEnum;
1092
+ environment: "Development" | "Staging" | "UAT" | "Production";
1086
1093
  losIntegration: LOSIntegration;
1087
1094
  billingSettings: AccountBillingRequest;
1088
1095
  }
@@ -1115,7 +1122,19 @@ export interface CreateDocumentTemplateRequest {
1115
1122
  export interface CreateGroupMemberRequest {
1116
1123
  /** @format uuid */
1117
1124
  userId: string;
1118
- loanRole: CreateGroupMemberRequestLoanRoleEnum;
1125
+ loanRole:
1126
+ | "Borrower"
1127
+ | "CoBorrower"
1128
+ | "NonBorrower"
1129
+ | "LoanOfficer"
1130
+ | "LoanProcessor"
1131
+ | "LoanOfficerAssistant"
1132
+ | "SupportingLoanOfficer"
1133
+ | "BuyerAgent"
1134
+ | "SellerAgent"
1135
+ | "TitleInsuranceAgent"
1136
+ | "EscrowAgent"
1137
+ | "SettlementAgent";
1119
1138
  }
1120
1139
 
1121
1140
  export interface CreateInviteRequest {
@@ -1127,7 +1146,7 @@ export interface CreateInviteRequest {
1127
1146
  emailAddress: string;
1128
1147
  phoneNumber?: string | null;
1129
1148
  /** @deprecated */
1130
- relationship: CreateInviteRequestRelationshipEnum;
1149
+ relationship: "NotApplicable" | "Spouse" | "NonSpouse";
1131
1150
  loanID: string;
1132
1151
  route?: string | null;
1133
1152
  /** @format uuid */
@@ -1150,7 +1169,7 @@ export interface CreateLoanImportRequest {
1150
1169
  * @minLength 1
1151
1170
  */
1152
1171
  startDate: string;
1153
- importMode: CreateLoanImportRequestImportModeEnum;
1172
+ importMode: "All" | "NewOnly" | "UpdateOnly";
1154
1173
  }
1155
1174
 
1156
1175
  export interface CreateSession {
@@ -1172,7 +1191,19 @@ export interface CreateUserDeviceRequest {
1172
1191
  }
1173
1192
 
1174
1193
  export interface CreateUserDraft {
1175
- loanRole: CreateUserDraftLoanRoleEnum;
1194
+ loanRole:
1195
+ | "Borrower"
1196
+ | "CoBorrower"
1197
+ | "NonBorrower"
1198
+ | "LoanOfficer"
1199
+ | "LoanProcessor"
1200
+ | "LoanOfficerAssistant"
1201
+ | "SupportingLoanOfficer"
1202
+ | "BuyerAgent"
1203
+ | "SellerAgent"
1204
+ | "TitleInsuranceAgent"
1205
+ | "EscrowAgent"
1206
+ | "SettlementAgent";
1176
1207
  }
1177
1208
 
1178
1209
  export interface CreateUserGroupRequest {
@@ -1490,7 +1521,7 @@ export interface Draft {
1490
1521
  siteConfiguration: SiteConfigurationReduced;
1491
1522
  /** @format uuid */
1492
1523
  loanID?: string | null;
1493
- type: DraftTypeEnum;
1524
+ type: "NewLoan" | "EditLoan";
1494
1525
  isCoBorrower: boolean;
1495
1526
  }
1496
1527
 
@@ -1509,7 +1540,7 @@ export interface DraftContent {
1509
1540
  siteConfiguration: SiteConfigurationReduced;
1510
1541
  /** @format uuid */
1511
1542
  loanID?: string | null;
1512
- type: DraftContentTypeEnum;
1543
+ type: "NewLoan" | "EditLoan";
1513
1544
  isCoBorrower: boolean;
1514
1545
  applicationPayload: any;
1515
1546
  }
@@ -1651,8 +1682,15 @@ export interface EncompassRequestLog {
1651
1682
  losId?: string | null;
1652
1683
  /** @format uuid */
1653
1684
  accountId: string;
1654
- operationType: EncompassRequestLogOperationTypeEnum;
1655
- outcome: EncompassRequestLogOutcomeEnum;
1685
+ operationType:
1686
+ | "FieldUpdate"
1687
+ | "EConsentUpdate"
1688
+ | "DocumentSync"
1689
+ | "MilestoneUpdate"
1690
+ | "DocumentAttachment"
1691
+ | "General"
1692
+ | "FieldReader";
1693
+ outcome: "Success" | "Failure" | "PartialSuccess";
1656
1694
  message: string;
1657
1695
  endpoint?: string | null;
1658
1696
  httpMethod?: string | null;
@@ -1889,7 +1927,20 @@ export interface FusionFieldDisplay {
1889
1927
  }
1890
1928
 
1891
1929
  export interface FusionReportFilter {
1892
- filterType: FusionReportFilterFilterTypeEnum;
1930
+ filterType:
1931
+ | "DateGreaterThanOrEqualTo"
1932
+ | "DateGreaterThan"
1933
+ | "DateLessThan"
1934
+ | "DateLessThanOrEqualTo"
1935
+ | "DateEquals"
1936
+ | "DateDoesntEqual"
1937
+ | "DateNonEmpty"
1938
+ | "DateEmpty"
1939
+ | "StringContains"
1940
+ | "StringEquals"
1941
+ | "StringNotEmpty"
1942
+ | "StringNotEquals"
1943
+ | "StringNotContains";
1893
1944
  targetField: string;
1894
1945
  targetValue: string;
1895
1946
  }
@@ -2017,7 +2068,40 @@ export interface GuidPatchOperation {
2017
2068
  }
2018
2069
 
2019
2070
  export interface IPAddress {
2020
- addressFamily: IpAddressAddressFamilyEnum;
2071
+ addressFamily:
2072
+ | "Unspecified"
2073
+ | "Unix"
2074
+ | "InterNetwork"
2075
+ | "ImpLink"
2076
+ | "Pup"
2077
+ | "Chaos"
2078
+ | "NS"
2079
+ | "Ipx"
2080
+ | "Iso"
2081
+ | "Osi"
2082
+ | "Ecma"
2083
+ | "DataKit"
2084
+ | "Ccitt"
2085
+ | "Sna"
2086
+ | "DecNet"
2087
+ | "DataLink"
2088
+ | "Lat"
2089
+ | "HyperChannel"
2090
+ | "AppleTalk"
2091
+ | "NetBios"
2092
+ | "VoiceView"
2093
+ | "FireFox"
2094
+ | "Banyan"
2095
+ | "Atm"
2096
+ | "InterNetworkV6"
2097
+ | "Cluster"
2098
+ | "Ieee12844"
2099
+ | "Irda"
2100
+ | "NetworkDesigners"
2101
+ | "Max"
2102
+ | "Packet"
2103
+ | "ControllerAreaNetwork"
2104
+ | "Unknown";
2021
2105
  /** @format int64 */
2022
2106
  scopeId: number;
2023
2107
  isIPv6Multicast: boolean;
@@ -2341,7 +2425,7 @@ export interface LoanBorrower {
2341
2425
  citizenship?: LoanCitizenship | null;
2342
2426
  maritalStatus?: LoanMaritalStatus | null;
2343
2427
  languagePreference?: LoanLanguagePreference | null;
2344
- applicationStatus: LoanBorrowerApplicationStatusEnum;
2428
+ applicationStatus: "Draft" | "Complete";
2345
2429
  /** @format int32 */
2346
2430
  numberOfDependents?: number | null;
2347
2431
  isPrimaryBorrower: boolean;
@@ -3266,7 +3350,19 @@ export interface LoanContact {
3266
3350
  email?: string | null;
3267
3351
  phone?: string | null;
3268
3352
  companyName?: string | null;
3269
- role: LoanContactRoleEnum;
3353
+ role:
3354
+ | "Borrower"
3355
+ | "CoBorrower"
3356
+ | "NonBorrower"
3357
+ | "LoanOfficer"
3358
+ | "LoanProcessor"
3359
+ | "LoanOfficerAssistant"
3360
+ | "SupportingLoanOfficer"
3361
+ | "BuyerAgent"
3362
+ | "SellerAgent"
3363
+ | "TitleInsuranceAgent"
3364
+ | "EscrowAgent"
3365
+ | "SettlementAgent";
3270
3366
  }
3271
3367
 
3272
3368
  export interface LoanContactList {
@@ -3402,14 +3498,19 @@ export interface LoanImport {
3402
3498
  /** @format int32 */
3403
3499
  importedCount: number;
3404
3500
  statusMessage?: string | null;
3405
- status: LoanImportStatusEnum;
3406
- importMode: LoanImportImportModeEnum;
3501
+ status:
3502
+ | "WaitingProcess"
3503
+ | "InProgress"
3504
+ | "Completed"
3505
+ | "Failed"
3506
+ | "Cancelled";
3507
+ importMode: "All" | "NewOnly" | "UpdateOnly";
3407
3508
  /** @format date-time */
3408
3509
  createdAt?: string | null;
3409
3510
  }
3410
3511
 
3411
3512
  export interface LoanImportLog {
3412
- level: LoanImportLogLevelEnum;
3513
+ level: "None" | "Info" | "Warning" | "Error";
3413
3514
  message: string;
3414
3515
  /** @format date-time */
3415
3516
  createdAt: string;
@@ -3470,8 +3571,22 @@ export interface LoanListPaginated {
3470
3571
  export interface LoanLog {
3471
3572
  /** @format uuid */
3472
3573
  id: string;
3473
- level: LoanLogLevelEnum;
3474
- type: LoanLogTypeEnum;
3574
+ level: "None" | "Info" | "Warning" | "Error";
3575
+ type:
3576
+ | "Loan"
3577
+ | "Queue"
3578
+ | "POSFlagChanged"
3579
+ | "Verification"
3580
+ | "DocumentUploaded"
3581
+ | "LoanCreated"
3582
+ | "WorkflowSubmitted"
3583
+ | "UserInvitationSent"
3584
+ | "CoBorrowerAdded"
3585
+ | "TaskCompleted"
3586
+ | "LoanStatusChanged"
3587
+ | "EConsent"
3588
+ | "SensitiveDataPurge"
3589
+ | "ClosingDateUpdated";
3475
3590
  message: string;
3476
3591
  /** @format date-time */
3477
3592
  createdAt: string;
@@ -3480,8 +3595,22 @@ export interface LoanLog {
3480
3595
  export interface LoanLogDetail {
3481
3596
  /** @format uuid */
3482
3597
  id: string;
3483
- level: LoanLogDetailLevelEnum;
3484
- type: LoanLogDetailTypeEnum;
3598
+ level: "None" | "Info" | "Warning" | "Error";
3599
+ type:
3600
+ | "Loan"
3601
+ | "Queue"
3602
+ | "POSFlagChanged"
3603
+ | "Verification"
3604
+ | "DocumentUploaded"
3605
+ | "LoanCreated"
3606
+ | "WorkflowSubmitted"
3607
+ | "UserInvitationSent"
3608
+ | "CoBorrowerAdded"
3609
+ | "TaskCompleted"
3610
+ | "LoanStatusChanged"
3611
+ | "EConsent"
3612
+ | "SensitiveDataPurge"
3613
+ | "ClosingDateUpdated";
3485
3614
  message: string;
3486
3615
  /** @format date-time */
3487
3616
  createdAt: string;
@@ -3765,7 +3894,19 @@ export interface LoanUser {
3765
3894
  email: string;
3766
3895
  phone?: string | null;
3767
3896
  role: string;
3768
- loanRole: LoanUserLoanRoleEnum;
3897
+ loanRole:
3898
+ | "Borrower"
3899
+ | "CoBorrower"
3900
+ | "NonBorrower"
3901
+ | "LoanOfficer"
3902
+ | "LoanProcessor"
3903
+ | "LoanOfficerAssistant"
3904
+ | "SupportingLoanOfficer"
3905
+ | "BuyerAgent"
3906
+ | "SellerAgent"
3907
+ | "TitleInsuranceAgent"
3908
+ | "EscrowAgent"
3909
+ | "SettlementAgent";
3769
3910
  isUser: boolean;
3770
3911
  /** @format date-time */
3771
3912
  createdAt: string;
@@ -3931,6 +4072,7 @@ export interface NotificationTemplate {
3931
4072
  /** @format uuid */
3932
4073
  id: string;
3933
4074
  htmlBody: string;
4075
+ key: string;
3934
4076
  name: string;
3935
4077
  plainBody: string;
3936
4078
  description?: string | null;
@@ -3956,6 +4098,7 @@ export interface NotificationTemplateBase {
3956
4098
  /** @format uuid */
3957
4099
  id: string;
3958
4100
  htmlBody: string;
4101
+ key: string;
3959
4102
  name: string;
3960
4103
  plainBody: string;
3961
4104
  description?: string | null;
@@ -3970,10 +4113,19 @@ export interface NotificationTemplateBase {
3970
4113
  useDefaultHeaderAndFooter: boolean;
3971
4114
  }
3972
4115
 
4116
+ export interface NotificationTemplateBasePaginated {
4117
+ rows: NotificationTemplateBase[];
4118
+ pagination: Pagination;
4119
+ /** @format int64 */
4120
+ count: number;
4121
+ }
4122
+
3973
4123
  export interface NotificationTemplateRequest {
3974
4124
  /** @minLength 1 */
3975
4125
  htmlBody: string;
3976
4126
  /** @minLength 1 */
4127
+ key: string;
4128
+ /** @minLength 1 */
3977
4129
  name: string;
3978
4130
  plainBody: string;
3979
4131
  description?: string | null;
@@ -3988,6 +4140,13 @@ export interface NotificationTemplateRequest {
3988
4140
  useDefaultHeaderAndFooter: boolean;
3989
4141
  }
3990
4142
 
4143
+ export interface NotificationTemplateSearchCriteria {
4144
+ searchText?: string | null;
4145
+ key?: string | null;
4146
+ status?: VersionStatusType | null;
4147
+ includeDefaults: boolean;
4148
+ }
4149
+
3991
4150
  export interface NotificationTemplateVersion {
3992
4151
  /** @format date-time */
3993
4152
  createdAt: string;
@@ -4054,7 +4213,7 @@ export interface NotificationTemplateVersionUpdateRequest {
4054
4213
 
4055
4214
  export interface Operation {
4056
4215
  op?: string;
4057
- value?: object | null;
4216
+ value?: string | number | boolean | null | object;
4058
4217
  path?: string;
4059
4218
  }
4060
4219
 
@@ -4410,7 +4569,7 @@ export interface SSOTokenRequest {
4410
4569
  }
4411
4570
 
4412
4571
  export interface SamlMetadataRequest {
4413
- ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
4572
+ ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
4414
4573
  }
4415
4574
 
4416
4575
  export interface SendForgotPasswordRequest {
@@ -4430,7 +4589,7 @@ export interface SendLoanDocumentsRequest {
4430
4589
  export interface SendNotificationForLoanRequest {
4431
4590
  /** @minLength 1 */
4432
4591
  loanID: string;
4433
- templateName: string;
4592
+ templateKey: string;
4434
4593
  loanOfficerEmail?: string | null;
4435
4594
  /** @format uuid */
4436
4595
  siteConfigurationId?: string | null;
@@ -4449,7 +4608,7 @@ export interface SiteConfiguration {
4449
4608
  deletedAt?: string | null;
4450
4609
  /** @format uuid */
4451
4610
  id: string;
4452
- type: SiteConfigurationTypeEnum;
4611
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4453
4612
  /** @format uuid */
4454
4613
  entityID: string;
4455
4614
  /** @format int32 */
@@ -4644,7 +4803,7 @@ export interface SiteConfigurationByUrl {
4644
4803
  deletedAt?: string | null;
4645
4804
  /** @format uuid */
4646
4805
  id: string;
4647
- type: SiteConfigurationByUrlTypeEnum;
4806
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4648
4807
  /** @format uuid */
4649
4808
  entityID: string;
4650
4809
  /** @format int32 */
@@ -4857,7 +5016,7 @@ export interface SiteConfigurationForm {
4857
5016
  export interface SiteConfigurationReduced {
4858
5017
  /** @format uuid */
4859
5018
  id: string;
4860
- type: SiteConfigurationReducedTypeEnum;
5019
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4861
5020
  url?: string | null;
4862
5021
  name: string;
4863
5022
  /** @format int64 */
@@ -4875,7 +5034,7 @@ export interface SiteConfigurationRequest {
4875
5034
  entityID: string;
4876
5035
  /** @format int32 */
4877
5036
  entityType: number;
4878
- type: SiteConfigurationRequestTypeEnum;
5037
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4879
5038
  url: string;
4880
5039
  name: string;
4881
5040
  introduction?: string | null;
@@ -5052,7 +5211,7 @@ export interface SiteConfigurationSearchCriteria {
5052
5211
  export interface SiteConfigurationSummary {
5053
5212
  /** @format uuid */
5054
5213
  id: string;
5055
- type: SiteConfigurationSummaryTypeEnum;
5214
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5056
5215
  url?: string | null;
5057
5216
  name: string;
5058
5217
  /** @format int64 */
@@ -5237,7 +5396,7 @@ export interface TestSendNotificationForLoanRequest {
5237
5396
  siteConfigurationId: string;
5238
5397
  toAddress?: string | null;
5239
5398
  toPhoneNumber?: string | null;
5240
- templateName?: string | null;
5399
+ templateKey?: string | null;
5241
5400
  attachments: Attachment[];
5242
5401
  }
5243
5402
 
@@ -5458,6 +5617,7 @@ export interface UpdateUserRequest {
5458
5617
  mfaEnabled?: boolean | null;
5459
5618
  /** @format uuid */
5460
5619
  preferredLoanOfficerId?: string | null;
5620
+ isInternal?: boolean | null;
5461
5621
  }
5462
5622
 
5463
5623
  export interface UsageReport {
@@ -5679,7 +5839,19 @@ export interface UserDevice {
5679
5839
  export interface UserDraft {
5680
5840
  /** @format uuid */
5681
5841
  draftID: string;
5682
- role: UserDraftRoleEnum;
5842
+ role:
5843
+ | "Borrower"
5844
+ | "CoBorrower"
5845
+ | "NonBorrower"
5846
+ | "LoanOfficer"
5847
+ | "LoanProcessor"
5848
+ | "LoanOfficerAssistant"
5849
+ | "SupportingLoanOfficer"
5850
+ | "BuyerAgent"
5851
+ | "SellerAgent"
5852
+ | "TitleInsuranceAgent"
5853
+ | "EscrowAgent"
5854
+ | "SettlementAgent";
5683
5855
  user: User;
5684
5856
  }
5685
5857
 
@@ -5706,7 +5878,7 @@ export interface UserGroupAccessScope {
5706
5878
  id: string;
5707
5879
  /** @format uuid */
5708
5880
  groupId: string;
5709
- scopeType: UserGroupAccessScopeScopeTypeEnum;
5881
+ scopeType: "User" | "Branch";
5710
5882
  /** @format uuid */
5711
5883
  userId?: string | null;
5712
5884
  /** @format uuid */
@@ -5742,7 +5914,19 @@ export interface UserLoan {
5742
5914
  deletedAt?: string | null;
5743
5915
  loanID: string;
5744
5916
  user: User;
5745
- role: UserLoanRoleEnum;
5917
+ role:
5918
+ | "Borrower"
5919
+ | "CoBorrower"
5920
+ | "NonBorrower"
5921
+ | "LoanOfficer"
5922
+ | "LoanProcessor"
5923
+ | "LoanOfficerAssistant"
5924
+ | "SupportingLoanOfficer"
5925
+ | "BuyerAgent"
5926
+ | "SellerAgent"
5927
+ | "TitleInsuranceAgent"
5928
+ | "EscrowAgent"
5929
+ | "SettlementAgent";
5746
5930
  /** @format int32 */
5747
5931
  borrowerPair?: number | null;
5748
5932
  /** @format int32 */
@@ -5755,10 +5939,10 @@ export interface UserLoanConsent {
5755
5939
  id: string;
5756
5940
  /** @format uuid */
5757
5941
  userLoanID: string;
5758
- type: UserLoanConsentTypeEnum;
5942
+ type: "Econsent" | "CreditAuthorization" | "Tcpa";
5759
5943
  providedConsent: boolean;
5760
5944
  ipAddress?: string | null;
5761
- losSyncStatus: UserLoanConsentLosSyncStatusEnum;
5945
+ losSyncStatus: "NotStarted" | "Failed" | "Success";
5762
5946
  /** @format date-time */
5763
5947
  createdAt: string;
5764
5948
  }
@@ -5903,7 +6087,16 @@ export interface UserSummary {
5903
6087
  id: string;
5904
6088
  name?: string | null;
5905
6089
  email?: string | null;
5906
- role: UserSummaryRoleEnum;
6090
+ role:
6091
+ | "Borrower"
6092
+ | "LoanOfficer"
6093
+ | "Admin"
6094
+ | "SuperAdmin"
6095
+ | "Realtor"
6096
+ | "SettlementAgent"
6097
+ | "LoanProcessor"
6098
+ | "LoanOfficerAssistant"
6099
+ | "SystemAdmin";
5907
6100
  }
5908
6101
 
5909
6102
  export interface VerifyPasswordRequest {
@@ -5939,335 +6132,6 @@ export interface Workflow {
5939
6132
  icon: string;
5940
6133
  }
5941
6134
 
5942
- export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
5943
-
5944
- export type AuditLogEntryChangeTypeEnum =
5945
- | "Created"
5946
- | "Modified"
5947
- | "SoftDeleted"
5948
- | "HardDeleted"
5949
- | "Restored";
5950
-
5951
- export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
5952
-
5953
- export type CreateAccountRequestEnvironmentEnum =
5954
- | "Development"
5955
- | "Staging"
5956
- | "UAT"
5957
- | "Production";
5958
-
5959
- export type CreateGroupMemberRequestLoanRoleEnum =
5960
- | "Borrower"
5961
- | "CoBorrower"
5962
- | "NonBorrower"
5963
- | "LoanOfficer"
5964
- | "LoanProcessor"
5965
- | "LoanOfficerAssistant"
5966
- | "SupportingLoanOfficer"
5967
- | "BuyerAgent"
5968
- | "SellerAgent"
5969
- | "TitleInsuranceAgent"
5970
- | "EscrowAgent"
5971
- | "SettlementAgent";
5972
-
5973
- /** @deprecated */
5974
- export type CreateInviteRequestRelationshipEnum =
5975
- | "NotApplicable"
5976
- | "Spouse"
5977
- | "NonSpouse";
5978
-
5979
- export type CreateLoanImportRequestImportModeEnum =
5980
- | "All"
5981
- | "NewOnly"
5982
- | "UpdateOnly";
5983
-
5984
- export type CreateUserDraftLoanRoleEnum =
5985
- | "Borrower"
5986
- | "CoBorrower"
5987
- | "NonBorrower"
5988
- | "LoanOfficer"
5989
- | "LoanProcessor"
5990
- | "LoanOfficerAssistant"
5991
- | "SupportingLoanOfficer"
5992
- | "BuyerAgent"
5993
- | "SellerAgent"
5994
- | "TitleInsuranceAgent"
5995
- | "EscrowAgent"
5996
- | "SettlementAgent";
5997
-
5998
- export type DraftTypeEnum = "NewLoan" | "EditLoan";
5999
-
6000
- export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
6001
-
6002
- export type EncompassRequestLogOperationTypeEnum =
6003
- | "FieldUpdate"
6004
- | "EConsentUpdate"
6005
- | "DocumentSync"
6006
- | "MilestoneUpdate"
6007
- | "DocumentAttachment"
6008
- | "General"
6009
- | "FieldReader";
6010
-
6011
- export type EncompassRequestLogOutcomeEnum =
6012
- | "Success"
6013
- | "Failure"
6014
- | "PartialSuccess";
6015
-
6016
- export type FusionReportFilterFilterTypeEnum =
6017
- | "DateGreaterThanOrEqualTo"
6018
- | "DateGreaterThan"
6019
- | "DateLessThan"
6020
- | "DateLessThanOrEqualTo"
6021
- | "DateEquals"
6022
- | "DateDoesntEqual"
6023
- | "DateNonEmpty"
6024
- | "DateEmpty"
6025
- | "StringContains"
6026
- | "StringEquals"
6027
- | "StringNotEmpty"
6028
- | "StringNotEquals"
6029
- | "StringNotContains";
6030
-
6031
- export type IpAddressAddressFamilyEnum =
6032
- | "Unspecified"
6033
- | "Unix"
6034
- | "InterNetwork"
6035
- | "ImpLink"
6036
- | "Pup"
6037
- | "Chaos"
6038
- | "NS"
6039
- | "Ipx"
6040
- | "Iso"
6041
- | "Osi"
6042
- | "Ecma"
6043
- | "DataKit"
6044
- | "Ccitt"
6045
- | "Sna"
6046
- | "DecNet"
6047
- | "DataLink"
6048
- | "Lat"
6049
- | "HyperChannel"
6050
- | "AppleTalk"
6051
- | "NetBios"
6052
- | "VoiceView"
6053
- | "FireFox"
6054
- | "Banyan"
6055
- | "Atm"
6056
- | "InterNetworkV6"
6057
- | "Cluster"
6058
- | "Ieee12844"
6059
- | "Irda"
6060
- | "NetworkDesigners"
6061
- | "Max"
6062
- | "Packet"
6063
- | "ControllerAreaNetwork"
6064
- | "Unknown";
6065
-
6066
- export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
6067
-
6068
- export type LoanContactRoleEnum =
6069
- | "Borrower"
6070
- | "CoBorrower"
6071
- | "NonBorrower"
6072
- | "LoanOfficer"
6073
- | "LoanProcessor"
6074
- | "LoanOfficerAssistant"
6075
- | "SupportingLoanOfficer"
6076
- | "BuyerAgent"
6077
- | "SellerAgent"
6078
- | "TitleInsuranceAgent"
6079
- | "EscrowAgent"
6080
- | "SettlementAgent";
6081
-
6082
- export type LoanImportStatusEnum =
6083
- | "WaitingProcess"
6084
- | "InProgress"
6085
- | "Completed"
6086
- | "Failed"
6087
- | "Cancelled";
6088
-
6089
- export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
6090
-
6091
- export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6092
-
6093
- export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
6094
-
6095
- export type LoanLogTypeEnum =
6096
- | "Loan"
6097
- | "Queue"
6098
- | "POSFlagChanged"
6099
- | "Verification"
6100
- | "DocumentUploaded"
6101
- | "LoanCreated"
6102
- | "WorkflowSubmitted"
6103
- | "UserInvitationSent"
6104
- | "CoBorrowerAdded"
6105
- | "TaskCompleted"
6106
- | "LoanStatusChanged"
6107
- | "EConsent"
6108
- | "SensitiveDataPurge"
6109
- | "ClosingDateUpdated";
6110
-
6111
- export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
6112
-
6113
- export type LoanLogDetailTypeEnum =
6114
- | "Loan"
6115
- | "Queue"
6116
- | "POSFlagChanged"
6117
- | "Verification"
6118
- | "DocumentUploaded"
6119
- | "LoanCreated"
6120
- | "WorkflowSubmitted"
6121
- | "UserInvitationSent"
6122
- | "CoBorrowerAdded"
6123
- | "TaskCompleted"
6124
- | "LoanStatusChanged"
6125
- | "EConsent"
6126
- | "SensitiveDataPurge"
6127
- | "ClosingDateUpdated";
6128
-
6129
- export type LoanUserLoanRoleEnum =
6130
- | "Borrower"
6131
- | "CoBorrower"
6132
- | "NonBorrower"
6133
- | "LoanOfficer"
6134
- | "LoanProcessor"
6135
- | "LoanOfficerAssistant"
6136
- | "SupportingLoanOfficer"
6137
- | "BuyerAgent"
6138
- | "SellerAgent"
6139
- | "TitleInsuranceAgent"
6140
- | "EscrowAgent"
6141
- | "SettlementAgent";
6142
-
6143
- export type SamlMetadataRequestSsoIntegrationEnum =
6144
- | "ConsumerConnect"
6145
- | "TheBigPOS"
6146
- | "POSF";
6147
-
6148
- export type SiteConfigurationTypeEnum =
6149
- | "None"
6150
- | "Account"
6151
- | "Corporate"
6152
- | "Branch"
6153
- | "LoanOfficer"
6154
- | "Partner";
6155
-
6156
- export type SiteConfigurationByUrlTypeEnum =
6157
- | "None"
6158
- | "Account"
6159
- | "Corporate"
6160
- | "Branch"
6161
- | "LoanOfficer"
6162
- | "Partner";
6163
-
6164
- export type SiteConfigurationReducedTypeEnum =
6165
- | "None"
6166
- | "Account"
6167
- | "Corporate"
6168
- | "Branch"
6169
- | "LoanOfficer"
6170
- | "Partner";
6171
-
6172
- export type SiteConfigurationRequestTypeEnum =
6173
- | "None"
6174
- | "Account"
6175
- | "Corporate"
6176
- | "Branch"
6177
- | "LoanOfficer"
6178
- | "Partner";
6179
-
6180
- export type SiteConfigurationSummaryTypeEnum =
6181
- | "None"
6182
- | "Account"
6183
- | "Corporate"
6184
- | "Branch"
6185
- | "LoanOfficer"
6186
- | "Partner";
6187
-
6188
- export type UserDraftRoleEnum =
6189
- | "Borrower"
6190
- | "CoBorrower"
6191
- | "NonBorrower"
6192
- | "LoanOfficer"
6193
- | "LoanProcessor"
6194
- | "LoanOfficerAssistant"
6195
- | "SupportingLoanOfficer"
6196
- | "BuyerAgent"
6197
- | "SellerAgent"
6198
- | "TitleInsuranceAgent"
6199
- | "EscrowAgent"
6200
- | "SettlementAgent";
6201
-
6202
- export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
6203
-
6204
- export type UserLoanRoleEnum =
6205
- | "Borrower"
6206
- | "CoBorrower"
6207
- | "NonBorrower"
6208
- | "LoanOfficer"
6209
- | "LoanProcessor"
6210
- | "LoanOfficerAssistant"
6211
- | "SupportingLoanOfficer"
6212
- | "BuyerAgent"
6213
- | "SellerAgent"
6214
- | "TitleInsuranceAgent"
6215
- | "EscrowAgent"
6216
- | "SettlementAgent";
6217
-
6218
- export type UserLoanConsentTypeEnum =
6219
- | "Econsent"
6220
- | "CreditAuthorization"
6221
- | "Tcpa";
6222
-
6223
- export type UserLoanConsentLosSyncStatusEnum =
6224
- | "NotStarted"
6225
- | "Failed"
6226
- | "Success";
6227
-
6228
- export type UserSummaryRoleEnum =
6229
- | "Borrower"
6230
- | "LoanOfficer"
6231
- | "Admin"
6232
- | "SuperAdmin"
6233
- | "Realtor"
6234
- | "SettlementAgent"
6235
- | "LoanProcessor"
6236
- | "LoanOfficerAssistant"
6237
- | "SystemAdmin";
6238
-
6239
- /** @default "Realtor" */
6240
- export type GetPartnersParamsRoleEnum =
6241
- | "Borrower"
6242
- | "LoanOfficer"
6243
- | "Admin"
6244
- | "SuperAdmin"
6245
- | "Realtor"
6246
- | "SettlementAgent"
6247
- | "LoanProcessor"
6248
- | "LoanOfficerAssistant"
6249
- | "SystemAdmin";
6250
-
6251
- export type GetSamlMetadataParamsSSoIntegrationEnum =
6252
- | "ConsumerConnect"
6253
- | "TheBigPOS"
6254
- | "POSF";
6255
-
6256
- export type GetSamlMetadataParamsEnum =
6257
- | "ConsumerConnect"
6258
- | "TheBigPOS"
6259
- | "POSF";
6260
-
6261
- export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum =
6262
- | "ConsumerConnect"
6263
- | "TheBigPOS"
6264
- | "POSF";
6265
-
6266
- export type CreateOrReplaceSamlMetadataParamsEnum =
6267
- | "ConsumerConnect"
6268
- | "TheBigPOS"
6269
- | "POSF";
6270
-
6271
6135
  import type {
6272
6136
  AxiosInstance,
6273
6137
  AxiosRequestConfig,
@@ -6310,6 +6174,7 @@ export interface ApiConfig<SecurityDataType = unknown>
6310
6174
  }
6311
6175
 
6312
6176
  export enum ContentType {
6177
+ JsonPatch = "application/json-patch+json",
6313
6178
  Json = "application/json",
6314
6179
  JsonApi = "application/vnd.api+json",
6315
6180
  FormData = "multipart/form-data",
@@ -6445,7 +6310,7 @@ export class HttpClient<SecurityDataType = unknown> {
6445
6310
 
6446
6311
  /**
6447
6312
  * @title The Big POS API
6448
- * @version v2.37.8
6313
+ * @version v2.38.0
6449
6314
  * @termsOfService https://www.thebigpos.com/terms-of-use/
6450
6315
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
6451
6316
  */
@@ -8049,6 +7914,8 @@ export class Api<
8049
7914
  * @default 20
8050
7915
  */
8051
7916
  pageSize?: number;
7917
+ /** @format uuid */
7918
+ loanId?: string;
8052
7919
  },
8053
7920
  params: RequestParams = {},
8054
7921
  ) =>
@@ -8774,7 +8641,7 @@ export class Api<
8774
8641
  method: "PATCH",
8775
8642
  body: data,
8776
8643
  secure: true,
8777
- type: ContentType.Json,
8644
+ type: ContentType.JsonPatch,
8778
8645
  format: "json",
8779
8646
  ...params,
8780
8647
  }),
@@ -8795,7 +8662,7 @@ export class Api<
8795
8662
  method: "POST",
8796
8663
  body: data,
8797
8664
  secure: true,
8798
- type: ContentType.Json,
8665
+ type: ContentType.JsonPatch,
8799
8666
  format: "json",
8800
8667
  ...params,
8801
8668
  }),
@@ -8884,7 +8751,7 @@ export class Api<
8884
8751
  method: "PATCH",
8885
8752
  body: data,
8886
8753
  secure: true,
8887
- type: ContentType.Json,
8754
+ type: ContentType.JsonPatch,
8888
8755
  format: "json",
8889
8756
  ...params,
8890
8757
  }),
@@ -8911,7 +8778,7 @@ export class Api<
8911
8778
  method: "PATCH",
8912
8779
  body: data,
8913
8780
  secure: true,
8914
- type: ContentType.Json,
8781
+ type: ContentType.JsonPatch,
8915
8782
  format: "json",
8916
8783
  ...params,
8917
8784
  }),
@@ -9068,7 +8935,7 @@ export class Api<
9068
8935
  method: "POST",
9069
8936
  body: data,
9070
8937
  secure: true,
9071
- type: ContentType.Json,
8938
+ type: ContentType.JsonPatch,
9072
8939
  format: "json",
9073
8940
  ...params,
9074
8941
  }),
@@ -9153,7 +9020,7 @@ export class Api<
9153
9020
  method: "PATCH",
9154
9021
  body: data,
9155
9022
  secure: true,
9156
- type: ContentType.Json,
9023
+ type: ContentType.JsonPatch,
9157
9024
  format: "json",
9158
9025
  ...params,
9159
9026
  }),
@@ -9233,7 +9100,7 @@ export class Api<
9233
9100
  method: "PATCH",
9234
9101
  body: data,
9235
9102
  secure: true,
9236
- type: ContentType.Json,
9103
+ type: ContentType.JsonPatch,
9237
9104
  format: "json",
9238
9105
  ...params,
9239
9106
  }),
@@ -9307,7 +9174,7 @@ export class Api<
9307
9174
  method: "POST",
9308
9175
  body: data,
9309
9176
  secure: true,
9310
- type: ContentType.Json,
9177
+ type: ContentType.JsonPatch,
9311
9178
  format: "json",
9312
9179
  ...params,
9313
9180
  }),
@@ -10827,7 +10694,7 @@ export class Api<
10827
10694
  query: query,
10828
10695
  body: data,
10829
10696
  secure: true,
10830
- type: ContentType.Json,
10697
+ type: ContentType.JsonPatch,
10831
10698
  format: "json",
10832
10699
  ...params,
10833
10700
  }),
@@ -10879,7 +10746,7 @@ export class Api<
10879
10746
  method: "POST",
10880
10747
  body: data,
10881
10748
  secure: true,
10882
- type: ContentType.Json,
10749
+ type: ContentType.JsonPatch,
10883
10750
  format: "json",
10884
10751
  ...params,
10885
10752
  }),
@@ -10993,6 +10860,28 @@ export class Api<
10993
10860
  ...params,
10994
10861
  }),
10995
10862
 
10863
+ /**
10864
+ * No description
10865
+ *
10866
+ * @tags LoanTaskNotifications
10867
+ * @name SendOutstandingLoanTaskNotification
10868
+ * @summary Send Outstanding Task Notification
10869
+ * @request POST:/api/loans/{loanID}/tasks/reminders/outstanding
10870
+ * @secure
10871
+ * @response `204` `void` No Content
10872
+ * @response `404` `ProblemDetails` Not Found
10873
+ */
10874
+ sendOutstandingLoanTaskNotification: (
10875
+ loanId: string,
10876
+ params: RequestParams = {},
10877
+ ) =>
10878
+ this.request<void, ProblemDetails>({
10879
+ path: `/api/loans/${loanId}/tasks/reminders/outstanding`,
10880
+ method: "POST",
10881
+ secure: true,
10882
+ ...params,
10883
+ }),
10884
+
10996
10885
  /**
10997
10886
  * No description
10998
10887
  *
@@ -11156,28 +11045,6 @@ export class Api<
11156
11045
  ...params,
11157
11046
  }),
11158
11047
 
11159
- /**
11160
- * No description
11161
- *
11162
- * @tags LoanTasks
11163
- * @name SendOutstandingLoanTaskNotification
11164
- * @summary Send Outstanding Task Notification
11165
- * @request POST:/api/loans/{loanID}/tasks/reminders/outstanding
11166
- * @secure
11167
- * @response `204` `void` No Content
11168
- * @response `404` `ProblemDetails` Not Found
11169
- */
11170
- sendOutstandingLoanTaskNotification: (
11171
- loanId: string,
11172
- params: RequestParams = {},
11173
- ) =>
11174
- this.request<void, ProblemDetails>({
11175
- path: `/api/loans/${loanId}/tasks/reminders/outstanding`,
11176
- method: "POST",
11177
- secure: true,
11178
- ...params,
11179
- }),
11180
-
11181
11048
  /**
11182
11049
  * No description
11183
11050
  *
@@ -11624,6 +11491,39 @@ export class Api<
11624
11491
  ...params,
11625
11492
  }),
11626
11493
 
11494
+ /**
11495
+ * No description
11496
+ *
11497
+ * @tags NotificationTemplates
11498
+ * @name SearchNotificationTemplates
11499
+ * @summary Search
11500
+ * @request POST:/api/notification-templates/search
11501
+ * @secure
11502
+ * @response `200` `NotificationTemplateBasePaginated` Success
11503
+ */
11504
+ searchNotificationTemplates: (
11505
+ data: NotificationTemplateSearchCriteria,
11506
+ query?: {
11507
+ /** @format int32 */
11508
+ pageSize?: number;
11509
+ /** @format int32 */
11510
+ pageNumber?: number;
11511
+ sortBy?: string;
11512
+ sortDirection?: string;
11513
+ },
11514
+ params: RequestParams = {},
11515
+ ) =>
11516
+ this.request<NotificationTemplateBasePaginated, any>({
11517
+ path: `/api/notification-templates/search`,
11518
+ method: "POST",
11519
+ query: query,
11520
+ body: data,
11521
+ secure: true,
11522
+ type: ContentType.Json,
11523
+ format: "json",
11524
+ ...params,
11525
+ }),
11526
+
11627
11527
  /**
11628
11528
  * No description
11629
11529
  *
@@ -11839,7 +11739,16 @@ export class Api<
11839
11739
  query?: {
11840
11740
  showAll?: boolean;
11841
11741
  /** @default "Realtor" */
11842
- role?: GetPartnersParamsRoleEnum;
11742
+ role?:
11743
+ | "Borrower"
11744
+ | "LoanOfficer"
11745
+ | "Admin"
11746
+ | "SuperAdmin"
11747
+ | "Realtor"
11748
+ | "SettlementAgent"
11749
+ | "LoanProcessor"
11750
+ | "LoanOfficerAssistant"
11751
+ | "SystemAdmin";
11843
11752
  /** @format int32 */
11844
11753
  pageSize?: number;
11845
11754
  /** @format int32 */
@@ -12175,7 +12084,7 @@ export class Api<
12175
12084
  * @response `404` `ProblemDetails` Not Found
12176
12085
  */
12177
12086
  getSamlMetadata: (
12178
- sSoIntegration: GetSamlMetadataParamsEnum,
12087
+ sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
12179
12088
  ssoIntegration: string,
12180
12089
  params: RequestParams = {},
12181
12090
  ) =>
@@ -12197,7 +12106,7 @@ export class Api<
12197
12106
  * @response `200` `File` Success
12198
12107
  */
12199
12108
  createOrReplaceSamlMetadata: (
12200
- sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum,
12109
+ sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF",
12201
12110
  ssoIntegration: string,
12202
12111
  params: RequestParams = {},
12203
12112
  ) =>