@matech/thebigpos-sdk 2.35.1-rc1 → 2.36.4
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/dist/index.d.ts +139 -34
- package/dist/index.js +29 -7
- package/dist/index.js.map +1 -1
- package/docs/sdk_generation.md +149 -0
- package/package.json +1 -1
- package/src/index.ts +441 -195
package/dist/index.d.ts
CHANGED
|
@@ -22,7 +22,7 @@ export type LoanNameSuffix = "Jr" | "Sr" | "II" | "III" | "IV" | "V" | "VI" | "V
|
|
|
22
22
|
export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
|
|
23
23
|
export type LoanMilitaryServiceType = "Current" | "RetiredDischargedSeparated" | "NonActivatedNationalGuard" | "SurvivingSpouse";
|
|
24
24
|
export type LoanMaritalStatus = "Married" | "Separated" | "Unmarried";
|
|
25
|
-
export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent";
|
|
25
|
+
export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge";
|
|
26
26
|
export type LoanLienPosition = "First" | "Subordinate";
|
|
27
27
|
export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
|
|
28
28
|
export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other";
|
|
@@ -44,6 +44,8 @@ export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Fai
|
|
|
44
44
|
export type FilterType = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
45
45
|
export type Environment = "Development" | "Staging" | "UAT" | "Production";
|
|
46
46
|
export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
|
|
47
|
+
export type EncompassLogOutcome = "Success" | "Failure" | "PartialSuccess";
|
|
48
|
+
export type EncompassLogOperationType = "FieldUpdate" | "EConsentUpdate" | "DocumentSync" | "ApiError" | "LoanCreation" | "SlotCreation" | "MilestoneUpdate";
|
|
47
49
|
export type DraftType = "NewLoan" | "EditLoan";
|
|
48
50
|
export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
49
51
|
export type BranchType = "Mortgage" | "RealEstate";
|
|
@@ -100,7 +102,7 @@ export interface AccountBilling {
|
|
|
100
102
|
contractedRate: number;
|
|
101
103
|
}
|
|
102
104
|
export interface AccountBillingRequest {
|
|
103
|
-
billingType:
|
|
105
|
+
billingType: AccountBillingRequestBillingTypeEnum;
|
|
104
106
|
/**
|
|
105
107
|
* @format double
|
|
106
108
|
* @min 0
|
|
@@ -635,7 +637,7 @@ export interface CorporateSearchCriteria {
|
|
|
635
637
|
isActive?: boolean | null;
|
|
636
638
|
}
|
|
637
639
|
export interface CreateAccessScopeRequest {
|
|
638
|
-
scopeType:
|
|
640
|
+
scopeType: CreateAccessScopeRequestScopeTypeEnum;
|
|
639
641
|
/** @format uuid */
|
|
640
642
|
userId?: string | null;
|
|
641
643
|
/** @format uuid */
|
|
@@ -658,7 +660,7 @@ export interface CreateAccountRequest {
|
|
|
658
660
|
*/
|
|
659
661
|
nlmsid: number;
|
|
660
662
|
settings: AccountSettingsRequest;
|
|
661
|
-
environment:
|
|
663
|
+
environment: CreateAccountRequestEnvironmentEnum;
|
|
662
664
|
losIntegration: LOSIntegration;
|
|
663
665
|
billingSettings: AccountBillingRequest;
|
|
664
666
|
}
|
|
@@ -688,7 +690,7 @@ export interface CreateDocumentTemplateRequest {
|
|
|
688
690
|
export interface CreateGroupMemberRequest {
|
|
689
691
|
/** @format uuid */
|
|
690
692
|
userId: string;
|
|
691
|
-
loanRole:
|
|
693
|
+
loanRole: CreateGroupMemberRequestLoanRoleEnum;
|
|
692
694
|
}
|
|
693
695
|
export interface CreateInviteRequest {
|
|
694
696
|
/** @minLength 1 */
|
|
@@ -699,7 +701,7 @@ export interface CreateInviteRequest {
|
|
|
699
701
|
emailAddress: string;
|
|
700
702
|
phoneNumber?: string | null;
|
|
701
703
|
/** @deprecated */
|
|
702
|
-
relationship:
|
|
704
|
+
relationship: CreateInviteRequestRelationshipEnum;
|
|
703
705
|
loanID: string;
|
|
704
706
|
route?: string | null;
|
|
705
707
|
/** @format uuid */
|
|
@@ -721,7 +723,7 @@ export interface CreateLoanImportRequest {
|
|
|
721
723
|
* @minLength 1
|
|
722
724
|
*/
|
|
723
725
|
startDate: string;
|
|
724
|
-
importMode:
|
|
726
|
+
importMode: CreateLoanImportRequestImportModeEnum;
|
|
725
727
|
}
|
|
726
728
|
export interface CreateSession {
|
|
727
729
|
sessionId: string;
|
|
@@ -739,7 +741,7 @@ export interface CreateUserDeviceRequest {
|
|
|
739
741
|
token: string;
|
|
740
742
|
}
|
|
741
743
|
export interface CreateUserDraft {
|
|
742
|
-
loanRole:
|
|
744
|
+
loanRole: CreateUserDraftLoanRoleEnum;
|
|
743
745
|
}
|
|
744
746
|
export interface CreateUserGroupRequest {
|
|
745
747
|
/**
|
|
@@ -1031,7 +1033,7 @@ export interface Draft {
|
|
|
1031
1033
|
siteConfiguration: SiteConfigurationReduced;
|
|
1032
1034
|
/** @format uuid */
|
|
1033
1035
|
loanID?: string | null;
|
|
1034
|
-
type:
|
|
1036
|
+
type: DraftTypeEnum;
|
|
1035
1037
|
isCoBorrower: boolean;
|
|
1036
1038
|
}
|
|
1037
1039
|
export interface DraftContent {
|
|
@@ -1049,7 +1051,7 @@ export interface DraftContent {
|
|
|
1049
1051
|
siteConfiguration: SiteConfigurationReduced;
|
|
1050
1052
|
/** @format uuid */
|
|
1051
1053
|
loanID?: string | null;
|
|
1052
|
-
type:
|
|
1054
|
+
type: DraftContentTypeEnum;
|
|
1053
1055
|
isCoBorrower: boolean;
|
|
1054
1056
|
applicationPayload: any;
|
|
1055
1057
|
}
|
|
@@ -1133,6 +1135,17 @@ export interface EncompassError {
|
|
|
1133
1135
|
message: string;
|
|
1134
1136
|
details?: string[] | null;
|
|
1135
1137
|
}
|
|
1138
|
+
export interface EncompassLogSearchCriteria {
|
|
1139
|
+
searchText?: string | null;
|
|
1140
|
+
operationTypes?: EncompassLogOperationType[] | null;
|
|
1141
|
+
outcomes?: EncompassLogOutcome[] | null;
|
|
1142
|
+
/** @format date-time */
|
|
1143
|
+
createdFrom?: string | null;
|
|
1144
|
+
/** @format date-time */
|
|
1145
|
+
createdTo?: string | null;
|
|
1146
|
+
/** @format int32 */
|
|
1147
|
+
httpStatusCode?: number | null;
|
|
1148
|
+
}
|
|
1136
1149
|
export interface EncompassPackageItem {
|
|
1137
1150
|
packageId: string;
|
|
1138
1151
|
status: string;
|
|
@@ -1151,6 +1164,31 @@ export interface EncompassPackageList {
|
|
|
1151
1164
|
/** @format int32 */
|
|
1152
1165
|
totalPages: number;
|
|
1153
1166
|
}
|
|
1167
|
+
export interface EncompassRequestLog {
|
|
1168
|
+
/** @format uuid */
|
|
1169
|
+
id: string;
|
|
1170
|
+
losId?: string | null;
|
|
1171
|
+
/** @format uuid */
|
|
1172
|
+
accountId: string;
|
|
1173
|
+
operationType: EncompassRequestLogOperationTypeEnum;
|
|
1174
|
+
outcome: EncompassRequestLogOutcomeEnum;
|
|
1175
|
+
message: string;
|
|
1176
|
+
endpoint?: string | null;
|
|
1177
|
+
httpMethod?: string | null;
|
|
1178
|
+
/** @format int32 */
|
|
1179
|
+
httpStatusCode?: number | null;
|
|
1180
|
+
/** @format int64 */
|
|
1181
|
+
durationMs?: number | null;
|
|
1182
|
+
context?: any;
|
|
1183
|
+
/** @format date-time */
|
|
1184
|
+
createdAt: string;
|
|
1185
|
+
}
|
|
1186
|
+
export interface EncompassRequestLogPaginated {
|
|
1187
|
+
rows: EncompassRequestLog[];
|
|
1188
|
+
pagination: Pagination;
|
|
1189
|
+
/** @format int64 */
|
|
1190
|
+
count: number;
|
|
1191
|
+
}
|
|
1154
1192
|
export interface Error {
|
|
1155
1193
|
message: string;
|
|
1156
1194
|
}
|
|
@@ -1346,7 +1384,7 @@ export interface FusionFieldDisplay {
|
|
|
1346
1384
|
fieldValue: string;
|
|
1347
1385
|
}
|
|
1348
1386
|
export interface FusionReportFilter {
|
|
1349
|
-
filterType:
|
|
1387
|
+
filterType: FusionReportFilterFilterTypeEnum;
|
|
1350
1388
|
targetField: string;
|
|
1351
1389
|
targetValue: string;
|
|
1352
1390
|
}
|
|
@@ -1460,7 +1498,7 @@ export interface GuidPatchOperation {
|
|
|
1460
1498
|
from?: string | null;
|
|
1461
1499
|
}
|
|
1462
1500
|
export interface IPAddress {
|
|
1463
|
-
addressFamily:
|
|
1501
|
+
addressFamily: IpAddressAddressFamilyEnum;
|
|
1464
1502
|
/** @format int64 */
|
|
1465
1503
|
scopeId: number;
|
|
1466
1504
|
isIPv6Multicast: boolean;
|
|
@@ -2620,7 +2658,7 @@ export interface LoanContact {
|
|
|
2620
2658
|
email?: string | null;
|
|
2621
2659
|
phone?: string | null;
|
|
2622
2660
|
companyName?: string | null;
|
|
2623
|
-
role:
|
|
2661
|
+
role: LoanContactRoleEnum;
|
|
2624
2662
|
}
|
|
2625
2663
|
export interface LoanContactList {
|
|
2626
2664
|
email: string;
|
|
@@ -2741,13 +2779,13 @@ export interface LoanImport {
|
|
|
2741
2779
|
/** @format int32 */
|
|
2742
2780
|
importedCount: number;
|
|
2743
2781
|
statusMessage?: string | null;
|
|
2744
|
-
status:
|
|
2745
|
-
importMode:
|
|
2782
|
+
status: LoanImportStatusEnum;
|
|
2783
|
+
importMode: LoanImportImportModeEnum;
|
|
2746
2784
|
/** @format date-time */
|
|
2747
2785
|
createdAt?: string | null;
|
|
2748
2786
|
}
|
|
2749
2787
|
export interface LoanImportLog {
|
|
2750
|
-
level:
|
|
2788
|
+
level: LoanImportLogLevelEnum;
|
|
2751
2789
|
message: string;
|
|
2752
2790
|
/** @format date-time */
|
|
2753
2791
|
createdAt: string;
|
|
@@ -2802,8 +2840,8 @@ export interface LoanListPaginated {
|
|
|
2802
2840
|
export interface LoanLog {
|
|
2803
2841
|
/** @format uuid */
|
|
2804
2842
|
id: string;
|
|
2805
|
-
level:
|
|
2806
|
-
type:
|
|
2843
|
+
level: LoanLogLevelEnum;
|
|
2844
|
+
type: LoanLogTypeEnum;
|
|
2807
2845
|
message: string;
|
|
2808
2846
|
/** @format date-time */
|
|
2809
2847
|
createdAt: string;
|
|
@@ -3066,7 +3104,7 @@ export interface LoanUser {
|
|
|
3066
3104
|
email: string;
|
|
3067
3105
|
phone?: string | null;
|
|
3068
3106
|
role: string;
|
|
3069
|
-
loanRole:
|
|
3107
|
+
loanRole: LoanUserLoanRoleEnum;
|
|
3070
3108
|
isUser: boolean;
|
|
3071
3109
|
/** @format date-time */
|
|
3072
3110
|
createdAt: string;
|
|
@@ -3673,7 +3711,7 @@ export interface SSOTokenRequest {
|
|
|
3673
3711
|
redirectUri: string;
|
|
3674
3712
|
}
|
|
3675
3713
|
export interface SamlMetadataRequest {
|
|
3676
|
-
ssoIntegration:
|
|
3714
|
+
ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
|
|
3677
3715
|
}
|
|
3678
3716
|
export interface SendForgotPasswordRequest {
|
|
3679
3717
|
/**
|
|
@@ -3708,7 +3746,7 @@ export interface SiteConfiguration {
|
|
|
3708
3746
|
deletedAt?: string | null;
|
|
3709
3747
|
/** @format uuid */
|
|
3710
3748
|
id: string;
|
|
3711
|
-
type:
|
|
3749
|
+
type: SiteConfigurationTypeEnum;
|
|
3712
3750
|
/** @format uuid */
|
|
3713
3751
|
entityID: string;
|
|
3714
3752
|
/** @format int32 */
|
|
@@ -3902,7 +3940,7 @@ export interface SiteConfigurationByUrl {
|
|
|
3902
3940
|
deletedAt?: string | null;
|
|
3903
3941
|
/** @format uuid */
|
|
3904
3942
|
id: string;
|
|
3905
|
-
type:
|
|
3943
|
+
type: SiteConfigurationByUrlTypeEnum;
|
|
3906
3944
|
/** @format uuid */
|
|
3907
3945
|
entityID: string;
|
|
3908
3946
|
/** @format int32 */
|
|
@@ -4113,7 +4151,7 @@ export interface SiteConfigurationForm {
|
|
|
4113
4151
|
export interface SiteConfigurationReduced {
|
|
4114
4152
|
/** @format uuid */
|
|
4115
4153
|
id: string;
|
|
4116
|
-
type:
|
|
4154
|
+
type: SiteConfigurationReducedTypeEnum;
|
|
4117
4155
|
url?: string | null;
|
|
4118
4156
|
name: string;
|
|
4119
4157
|
/** @format int64 */
|
|
@@ -4130,7 +4168,7 @@ export interface SiteConfigurationRequest {
|
|
|
4130
4168
|
entityID: string;
|
|
4131
4169
|
/** @format int32 */
|
|
4132
4170
|
entityType: number;
|
|
4133
|
-
type:
|
|
4171
|
+
type: SiteConfigurationRequestTypeEnum;
|
|
4134
4172
|
url: string;
|
|
4135
4173
|
name: string;
|
|
4136
4174
|
introduction?: string | null;
|
|
@@ -4305,7 +4343,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
4305
4343
|
export interface SiteConfigurationSummary {
|
|
4306
4344
|
/** @format uuid */
|
|
4307
4345
|
id: string;
|
|
4308
|
-
type:
|
|
4346
|
+
type: SiteConfigurationSummaryTypeEnum;
|
|
4309
4347
|
url?: string | null;
|
|
4310
4348
|
name: string;
|
|
4311
4349
|
/** @format int64 */
|
|
@@ -4882,7 +4920,7 @@ export interface UserDevice {
|
|
|
4882
4920
|
export interface UserDraft {
|
|
4883
4921
|
/** @format uuid */
|
|
4884
4922
|
draftID: string;
|
|
4885
|
-
role:
|
|
4923
|
+
role: UserDraftRoleEnum;
|
|
4886
4924
|
user: User;
|
|
4887
4925
|
}
|
|
4888
4926
|
export interface UserDraftPaginated {
|
|
@@ -4906,7 +4944,7 @@ export interface UserGroupAccessScope {
|
|
|
4906
4944
|
id: string;
|
|
4907
4945
|
/** @format uuid */
|
|
4908
4946
|
groupId: string;
|
|
4909
|
-
scopeType:
|
|
4947
|
+
scopeType: UserGroupAccessScopeScopeTypeEnum;
|
|
4910
4948
|
/** @format uuid */
|
|
4911
4949
|
userId?: string | null;
|
|
4912
4950
|
/** @format uuid */
|
|
@@ -4939,7 +4977,7 @@ export interface UserLoan {
|
|
|
4939
4977
|
deletedAt?: string | null;
|
|
4940
4978
|
loanID: string;
|
|
4941
4979
|
user: User;
|
|
4942
|
-
role:
|
|
4980
|
+
role: UserLoanRoleEnum;
|
|
4943
4981
|
/** @format int32 */
|
|
4944
4982
|
borrowerPair?: number | null;
|
|
4945
4983
|
/** @format int32 */
|
|
@@ -4951,7 +4989,7 @@ export interface UserLoanConsent {
|
|
|
4951
4989
|
id: string;
|
|
4952
4990
|
/** @format uuid */
|
|
4953
4991
|
userLoanID: string;
|
|
4954
|
-
type:
|
|
4992
|
+
type: UserLoanConsentTypeEnum;
|
|
4955
4993
|
providedConsent: boolean;
|
|
4956
4994
|
ipAddress?: string | null;
|
|
4957
4995
|
/** @format date-time */
|
|
@@ -5085,7 +5123,7 @@ export interface UserSummary {
|
|
|
5085
5123
|
id: string;
|
|
5086
5124
|
name?: string | null;
|
|
5087
5125
|
email?: string | null;
|
|
5088
|
-
role:
|
|
5126
|
+
role: UserSummaryRoleEnum;
|
|
5089
5127
|
}
|
|
5090
5128
|
export interface VerifyPasswordRequest {
|
|
5091
5129
|
/**
|
|
@@ -5118,6 +5156,44 @@ export interface Workflow {
|
|
|
5118
5156
|
tileSubtitle: string;
|
|
5119
5157
|
icon: string;
|
|
5120
5158
|
}
|
|
5159
|
+
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
5160
|
+
export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
|
|
5161
|
+
export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
|
|
5162
|
+
export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5163
|
+
/** @deprecated */
|
|
5164
|
+
export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
5165
|
+
export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
5166
|
+
export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5167
|
+
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
5168
|
+
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
5169
|
+
export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "EConsentUpdate" | "DocumentSync" | "ApiError" | "LoanCreation" | "SlotCreation" | "MilestoneUpdate";
|
|
5170
|
+
export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
|
|
5171
|
+
export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
5172
|
+
export type IpAddressAddressFamilyEnum = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
|
|
5173
|
+
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5174
|
+
export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
5175
|
+
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
5176
|
+
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5177
|
+
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5178
|
+
export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge";
|
|
5179
|
+
export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5180
|
+
export type SamlMetadataRequestSsoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5181
|
+
export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5182
|
+
export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5183
|
+
export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5184
|
+
export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5185
|
+
export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5186
|
+
export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5187
|
+
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
5188
|
+
export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5189
|
+
export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
5190
|
+
export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
5191
|
+
/** @default "Realtor" */
|
|
5192
|
+
export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
5193
|
+
export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5194
|
+
export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5195
|
+
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5196
|
+
export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5121
5197
|
import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
|
|
5122
5198
|
export type QueryParamsType = Record<string | number, any>;
|
|
5123
5199
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
|
|
@@ -5163,7 +5239,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
5163
5239
|
}
|
|
5164
5240
|
/**
|
|
5165
5241
|
* @title The Big POS API
|
|
5166
|
-
* @version v2.
|
|
5242
|
+
* @version v2.36.4
|
|
5167
5243
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
5168
5244
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
5169
5245
|
*/
|
|
@@ -7427,6 +7503,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7427
7503
|
* @response `200` `Loan` Success
|
|
7428
7504
|
*/
|
|
7429
7505
|
importLoanFromLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<Loan, any, {}>>;
|
|
7506
|
+
/**
|
|
7507
|
+
* No description
|
|
7508
|
+
*
|
|
7509
|
+
* @tags LoanSensitiveDataPurge
|
|
7510
|
+
* @name PurgeSensitiveLoanData
|
|
7511
|
+
* @summary Manually trigger sensitive data purge for a specific loan
|
|
7512
|
+
* @request POST:/api/loans/sensitive-data-purge/{loanId}
|
|
7513
|
+
* @secure
|
|
7514
|
+
* @response `204` `void` No Content
|
|
7515
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7516
|
+
*/
|
|
7517
|
+
purgeSensitiveLoanData: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
7430
7518
|
/**
|
|
7431
7519
|
* No description
|
|
7432
7520
|
*
|
|
@@ -7958,7 +8046,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7958
8046
|
getPartners: (query?: {
|
|
7959
8047
|
showAll?: boolean;
|
|
7960
8048
|
/** @default "Realtor" */
|
|
7961
|
-
role?:
|
|
8049
|
+
role?: GetPartnersParamsRoleEnum;
|
|
7962
8050
|
/** @format int32 */
|
|
7963
8051
|
pageSize?: number;
|
|
7964
8052
|
/** @format int32 */
|
|
@@ -8136,7 +8224,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8136
8224
|
* @response `200` `File` Success
|
|
8137
8225
|
* @response `404` `ProblemDetails` Not Found
|
|
8138
8226
|
*/
|
|
8139
|
-
getSamlMetadata: (sSoIntegration:
|
|
8227
|
+
getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
8140
8228
|
/**
|
|
8141
8229
|
* No description
|
|
8142
8230
|
*
|
|
@@ -8147,7 +8235,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8147
8235
|
* @secure
|
|
8148
8236
|
* @response `200` `File` Success
|
|
8149
8237
|
*/
|
|
8150
|
-
createOrReplaceSamlMetadata: (sSoIntegration:
|
|
8238
|
+
createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
8151
8239
|
/**
|
|
8152
8240
|
* No description
|
|
8153
8241
|
*
|
|
@@ -8326,6 +8414,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8326
8414
|
* @response `200` `void` Success
|
|
8327
8415
|
*/
|
|
8328
8416
|
integrationsLosLoansCreate: (data: LosLoanCreationRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
8417
|
+
/**
|
|
8418
|
+
* No description
|
|
8419
|
+
*
|
|
8420
|
+
* @tags TheBigPOS
|
|
8421
|
+
* @name SearchEncompassLogs
|
|
8422
|
+
* @request POST:/api/los/encompass/logs/{losId}/search
|
|
8423
|
+
* @secure
|
|
8424
|
+
* @response `200` `EncompassRequestLogPaginated` Success
|
|
8425
|
+
*/
|
|
8426
|
+
searchEncompassLogs: (losId: string, query: {
|
|
8427
|
+
/** @format int32 */
|
|
8428
|
+
pageSize: number;
|
|
8429
|
+
/** @format int32 */
|
|
8430
|
+
pageNumber: number;
|
|
8431
|
+
sortBy?: string;
|
|
8432
|
+
sortDirection?: string;
|
|
8433
|
+
}, data: EncompassLogSearchCriteria, params?: RequestParams) => Promise<AxiosResponse<EncompassRequestLogPaginated, any, {}>>;
|
|
8329
8434
|
/**
|
|
8330
8435
|
* No description
|
|
8331
8436
|
*
|
package/dist/index.js
CHANGED
|
@@ -104,7 +104,7 @@ export class HttpClient {
|
|
|
104
104
|
}
|
|
105
105
|
/**
|
|
106
106
|
* @title The Big POS API
|
|
107
|
-
* @version v2.
|
|
107
|
+
* @version v2.36.4
|
|
108
108
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
109
109
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
110
110
|
*/
|
|
@@ -1204,7 +1204,7 @@ export class Api extends HttpClient {
|
|
|
1204
1204
|
* @response `200` `string` Success
|
|
1205
1205
|
* @response `422` `UnprocessableEntity` Client Error
|
|
1206
1206
|
*/
|
|
1207
|
-
updateLoanConsentAndCustomFieldsObsolete: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
1207
|
+
updateLoanConsentAndCustomFieldsObsolete: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatchPatch, format: "json" }, params)),
|
|
1208
1208
|
/**
|
|
1209
1209
|
* No description
|
|
1210
1210
|
*
|
|
@@ -1254,7 +1254,7 @@ export class Api extends HttpClient {
|
|
|
1254
1254
|
* @response `200` `string` Success
|
|
1255
1255
|
* @response `422` `UnprocessableEntity` Client Error
|
|
1256
1256
|
*/
|
|
1257
|
-
updateLoanCustomFields: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/custom-fields`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
1257
|
+
updateLoanCustomFields: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/custom-fields`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatchPatch, format: "json" }, params)),
|
|
1258
1258
|
/**
|
|
1259
1259
|
* No description
|
|
1260
1260
|
*
|
|
@@ -1267,7 +1267,7 @@ export class Api extends HttpClient {
|
|
|
1267
1267
|
* @response `202` `string` Accepted
|
|
1268
1268
|
* @response `422` `UnprocessableEntity` Client Error
|
|
1269
1269
|
*/
|
|
1270
|
-
updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/consent`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
1270
|
+
updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/consent`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatchPatch, format: "json" }, params)),
|
|
1271
1271
|
/**
|
|
1272
1272
|
* No description
|
|
1273
1273
|
*
|
|
@@ -1381,7 +1381,7 @@ export class Api extends HttpClient {
|
|
|
1381
1381
|
* @secure
|
|
1382
1382
|
* @response `200` `ListingFile` Success
|
|
1383
1383
|
*/
|
|
1384
|
-
updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
1384
|
+
updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatchPatch, format: "json" }, params)),
|
|
1385
1385
|
/**
|
|
1386
1386
|
* No description
|
|
1387
1387
|
*
|
|
@@ -1414,7 +1414,7 @@ export class Api extends HttpClient {
|
|
|
1414
1414
|
* @secure
|
|
1415
1415
|
* @response `200` `(ListingPhoto)[]` Success
|
|
1416
1416
|
*/
|
|
1417
|
-
updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
1417
|
+
updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatchPatch, format: "json" }, params)),
|
|
1418
1418
|
/**
|
|
1419
1419
|
* No description
|
|
1420
1420
|
*
|
|
@@ -2132,6 +2132,18 @@ export class Api extends HttpClient {
|
|
|
2132
2132
|
* @response `200` `Loan` Success
|
|
2133
2133
|
*/
|
|
2134
2134
|
importLoanFromLos: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/import-from-los/${loanId}`, method: "POST", secure: true, format: "json" }, params)),
|
|
2135
|
+
/**
|
|
2136
|
+
* No description
|
|
2137
|
+
*
|
|
2138
|
+
* @tags LoanSensitiveDataPurge
|
|
2139
|
+
* @name PurgeSensitiveLoanData
|
|
2140
|
+
* @summary Manually trigger sensitive data purge for a specific loan
|
|
2141
|
+
* @request POST:/api/loans/sensitive-data-purge/{loanId}
|
|
2142
|
+
* @secure
|
|
2143
|
+
* @response `204` `void` No Content
|
|
2144
|
+
* @response `404` `ProblemDetails` Not Found
|
|
2145
|
+
*/
|
|
2146
|
+
purgeSensitiveLoanData: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/sensitive-data-purge/${loanId}`, method: "POST", secure: true }, params)),
|
|
2135
2147
|
/**
|
|
2136
2148
|
* No description
|
|
2137
2149
|
*
|
|
@@ -2143,7 +2155,7 @@ export class Api extends HttpClient {
|
|
|
2143
2155
|
* @response `200` `TaskCommentPaginated` Success
|
|
2144
2156
|
* @response `404` `ProblemDetails` Not Found
|
|
2145
2157
|
*/
|
|
2146
|
-
searchLoanTaskComments: (loanId, userLoanTaskId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.
|
|
2158
|
+
searchLoanTaskComments: (loanId, userLoanTaskId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.JsonPatchPatch, format: "json" }, params)),
|
|
2147
2159
|
/**
|
|
2148
2160
|
* No description
|
|
2149
2161
|
*
|
|
@@ -2972,6 +2984,16 @@ export class Api extends HttpClient {
|
|
|
2972
2984
|
* @response `200` `void` Success
|
|
2973
2985
|
*/
|
|
2974
2986
|
integrationsLosLoansCreate: (data, params = {}) => this.request(Object.assign({ path: `/api/integrations/los/loans`, method: "POST", body: data, secure: true, type: ContentType.Json }, params)),
|
|
2987
|
+
/**
|
|
2988
|
+
* No description
|
|
2989
|
+
*
|
|
2990
|
+
* @tags TheBigPOS
|
|
2991
|
+
* @name SearchEncompassLogs
|
|
2992
|
+
* @request POST:/api/los/encompass/logs/{losId}/search
|
|
2993
|
+
* @secure
|
|
2994
|
+
* @response `200` `EncompassRequestLogPaginated` Success
|
|
2995
|
+
*/
|
|
2996
|
+
searchEncompassLogs: (losId, query, data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/logs/${losId}/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
2975
2997
|
/**
|
|
2976
2998
|
* No description
|
|
2977
2999
|
*
|