@matech/thebigpos-sdk 2.35.0 → 2.35.1-rc1
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 +58 -80
- package/dist/index.js +11 -12
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +223 -331
package/dist/index.d.ts
CHANGED
|
@@ -100,7 +100,7 @@ export interface AccountBilling {
|
|
|
100
100
|
contractedRate: number;
|
|
101
101
|
}
|
|
102
102
|
export interface AccountBillingRequest {
|
|
103
|
-
billingType:
|
|
103
|
+
billingType: "ClosedLoan" | "LoanOfficer";
|
|
104
104
|
/**
|
|
105
105
|
* @format double
|
|
106
106
|
* @min 0
|
|
@@ -635,7 +635,7 @@ export interface CorporateSearchCriteria {
|
|
|
635
635
|
isActive?: boolean | null;
|
|
636
636
|
}
|
|
637
637
|
export interface CreateAccessScopeRequest {
|
|
638
|
-
scopeType:
|
|
638
|
+
scopeType: "User" | "Branch";
|
|
639
639
|
/** @format uuid */
|
|
640
640
|
userId?: string | null;
|
|
641
641
|
/** @format uuid */
|
|
@@ -658,7 +658,7 @@ export interface CreateAccountRequest {
|
|
|
658
658
|
*/
|
|
659
659
|
nlmsid: number;
|
|
660
660
|
settings: AccountSettingsRequest;
|
|
661
|
-
environment:
|
|
661
|
+
environment: "Development" | "Staging" | "UAT" | "Production";
|
|
662
662
|
losIntegration: LOSIntegration;
|
|
663
663
|
billingSettings: AccountBillingRequest;
|
|
664
664
|
}
|
|
@@ -688,7 +688,7 @@ export interface CreateDocumentTemplateRequest {
|
|
|
688
688
|
export interface CreateGroupMemberRequest {
|
|
689
689
|
/** @format uuid */
|
|
690
690
|
userId: string;
|
|
691
|
-
loanRole:
|
|
691
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
692
692
|
}
|
|
693
693
|
export interface CreateInviteRequest {
|
|
694
694
|
/** @minLength 1 */
|
|
@@ -699,7 +699,7 @@ export interface CreateInviteRequest {
|
|
|
699
699
|
emailAddress: string;
|
|
700
700
|
phoneNumber?: string | null;
|
|
701
701
|
/** @deprecated */
|
|
702
|
-
relationship:
|
|
702
|
+
relationship: "NotApplicable" | "Spouse" | "NonSpouse";
|
|
703
703
|
loanID: string;
|
|
704
704
|
route?: string | null;
|
|
705
705
|
/** @format uuid */
|
|
@@ -721,7 +721,7 @@ export interface CreateLoanImportRequest {
|
|
|
721
721
|
* @minLength 1
|
|
722
722
|
*/
|
|
723
723
|
startDate: string;
|
|
724
|
-
importMode:
|
|
724
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
725
725
|
}
|
|
726
726
|
export interface CreateSession {
|
|
727
727
|
sessionId: string;
|
|
@@ -739,7 +739,7 @@ export interface CreateUserDeviceRequest {
|
|
|
739
739
|
token: string;
|
|
740
740
|
}
|
|
741
741
|
export interface CreateUserDraft {
|
|
742
|
-
loanRole:
|
|
742
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
743
743
|
}
|
|
744
744
|
export interface CreateUserGroupRequest {
|
|
745
745
|
/**
|
|
@@ -921,9 +921,17 @@ export interface DocumentFolder {
|
|
|
921
921
|
count: number;
|
|
922
922
|
files: DocumentFile[];
|
|
923
923
|
}
|
|
924
|
+
export interface DocumentFoldersRequest {
|
|
925
|
+
searchText?: string | null;
|
|
926
|
+
losStatuses?: LOSStatus[] | null;
|
|
927
|
+
sortBy?: string | null;
|
|
928
|
+
sortDirection?: string | null;
|
|
929
|
+
}
|
|
924
930
|
export interface DocumentSync {
|
|
925
931
|
/** @format int32 */
|
|
926
932
|
syncedCount: number;
|
|
933
|
+
/** @format date-time */
|
|
934
|
+
lastLosDocumentsSyncDate?: string | null;
|
|
927
935
|
}
|
|
928
936
|
export interface DocumentTemplate {
|
|
929
937
|
/** @format date-time */
|
|
@@ -1023,7 +1031,7 @@ export interface Draft {
|
|
|
1023
1031
|
siteConfiguration: SiteConfigurationReduced;
|
|
1024
1032
|
/** @format uuid */
|
|
1025
1033
|
loanID?: string | null;
|
|
1026
|
-
type:
|
|
1034
|
+
type: "NewLoan" | "EditLoan";
|
|
1027
1035
|
isCoBorrower: boolean;
|
|
1028
1036
|
}
|
|
1029
1037
|
export interface DraftContent {
|
|
@@ -1041,7 +1049,7 @@ export interface DraftContent {
|
|
|
1041
1049
|
siteConfiguration: SiteConfigurationReduced;
|
|
1042
1050
|
/** @format uuid */
|
|
1043
1051
|
loanID?: string | null;
|
|
1044
|
-
type:
|
|
1052
|
+
type: "NewLoan" | "EditLoan";
|
|
1045
1053
|
isCoBorrower: boolean;
|
|
1046
1054
|
applicationPayload: any;
|
|
1047
1055
|
}
|
|
@@ -1338,7 +1346,7 @@ export interface FusionFieldDisplay {
|
|
|
1338
1346
|
fieldValue: string;
|
|
1339
1347
|
}
|
|
1340
1348
|
export interface FusionReportFilter {
|
|
1341
|
-
filterType:
|
|
1349
|
+
filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
1342
1350
|
targetField: string;
|
|
1343
1351
|
targetValue: string;
|
|
1344
1352
|
}
|
|
@@ -1452,7 +1460,7 @@ export interface GuidPatchOperation {
|
|
|
1452
1460
|
from?: string | null;
|
|
1453
1461
|
}
|
|
1454
1462
|
export interface IPAddress {
|
|
1455
|
-
addressFamily:
|
|
1463
|
+
addressFamily: "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";
|
|
1456
1464
|
/** @format int64 */
|
|
1457
1465
|
scopeId: number;
|
|
1458
1466
|
isIPv6Multicast: boolean;
|
|
@@ -1687,6 +1695,8 @@ export interface Loan {
|
|
|
1687
1695
|
isInSync: boolean;
|
|
1688
1696
|
/** @format date-time */
|
|
1689
1697
|
syncDate?: string | null;
|
|
1698
|
+
/** @format date-time */
|
|
1699
|
+
lastLosDocumentsSyncDate?: string | null;
|
|
1690
1700
|
isLocked: boolean;
|
|
1691
1701
|
isLockedFromEditing: boolean;
|
|
1692
1702
|
excludeFromAutoTaskReminders?: boolean | null;
|
|
@@ -1735,6 +1745,8 @@ export interface LoanApplicationRequest {
|
|
|
1735
1745
|
borrowers: LoanBorrowerRequest[];
|
|
1736
1746
|
nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
|
|
1737
1747
|
/** @format uuid */
|
|
1748
|
+
draftId?: string | null;
|
|
1749
|
+
/** @format uuid */
|
|
1738
1750
|
existingLoanId?: string | null;
|
|
1739
1751
|
}
|
|
1740
1752
|
export interface LoanBorrower {
|
|
@@ -2608,7 +2620,7 @@ export interface LoanContact {
|
|
|
2608
2620
|
email?: string | null;
|
|
2609
2621
|
phone?: string | null;
|
|
2610
2622
|
companyName?: string | null;
|
|
2611
|
-
role:
|
|
2623
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
2612
2624
|
}
|
|
2613
2625
|
export interface LoanContactList {
|
|
2614
2626
|
email: string;
|
|
@@ -2729,13 +2741,13 @@ export interface LoanImport {
|
|
|
2729
2741
|
/** @format int32 */
|
|
2730
2742
|
importedCount: number;
|
|
2731
2743
|
statusMessage?: string | null;
|
|
2732
|
-
status:
|
|
2733
|
-
importMode:
|
|
2744
|
+
status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
2745
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
2734
2746
|
/** @format date-time */
|
|
2735
2747
|
createdAt?: string | null;
|
|
2736
2748
|
}
|
|
2737
2749
|
export interface LoanImportLog {
|
|
2738
|
-
level:
|
|
2750
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
2739
2751
|
message: string;
|
|
2740
2752
|
/** @format date-time */
|
|
2741
2753
|
createdAt: string;
|
|
@@ -2790,8 +2802,8 @@ export interface LoanListPaginated {
|
|
|
2790
2802
|
export interface LoanLog {
|
|
2791
2803
|
/** @format uuid */
|
|
2792
2804
|
id: string;
|
|
2793
|
-
level:
|
|
2794
|
-
type:
|
|
2805
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
2806
|
+
type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent";
|
|
2795
2807
|
message: string;
|
|
2796
2808
|
/** @format date-time */
|
|
2797
2809
|
createdAt: string;
|
|
@@ -3054,7 +3066,7 @@ export interface LoanUser {
|
|
|
3054
3066
|
email: string;
|
|
3055
3067
|
phone?: string | null;
|
|
3056
3068
|
role: string;
|
|
3057
|
-
loanRole:
|
|
3069
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3058
3070
|
isUser: boolean;
|
|
3059
3071
|
/** @format date-time */
|
|
3060
3072
|
createdAt: string;
|
|
@@ -3661,7 +3673,7 @@ export interface SSOTokenRequest {
|
|
|
3661
3673
|
redirectUri: string;
|
|
3662
3674
|
}
|
|
3663
3675
|
export interface SamlMetadataRequest {
|
|
3664
|
-
ssoIntegration:
|
|
3676
|
+
ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
3665
3677
|
}
|
|
3666
3678
|
export interface SendForgotPasswordRequest {
|
|
3667
3679
|
/**
|
|
@@ -3696,7 +3708,7 @@ export interface SiteConfiguration {
|
|
|
3696
3708
|
deletedAt?: string | null;
|
|
3697
3709
|
/** @format uuid */
|
|
3698
3710
|
id: string;
|
|
3699
|
-
type:
|
|
3711
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3700
3712
|
/** @format uuid */
|
|
3701
3713
|
entityID: string;
|
|
3702
3714
|
/** @format int32 */
|
|
@@ -3890,7 +3902,7 @@ export interface SiteConfigurationByUrl {
|
|
|
3890
3902
|
deletedAt?: string | null;
|
|
3891
3903
|
/** @format uuid */
|
|
3892
3904
|
id: string;
|
|
3893
|
-
type:
|
|
3905
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3894
3906
|
/** @format uuid */
|
|
3895
3907
|
entityID: string;
|
|
3896
3908
|
/** @format int32 */
|
|
@@ -4101,7 +4113,7 @@ export interface SiteConfigurationForm {
|
|
|
4101
4113
|
export interface SiteConfigurationReduced {
|
|
4102
4114
|
/** @format uuid */
|
|
4103
4115
|
id: string;
|
|
4104
|
-
type:
|
|
4116
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4105
4117
|
url?: string | null;
|
|
4106
4118
|
name: string;
|
|
4107
4119
|
/** @format int64 */
|
|
@@ -4118,7 +4130,7 @@ export interface SiteConfigurationRequest {
|
|
|
4118
4130
|
entityID: string;
|
|
4119
4131
|
/** @format int32 */
|
|
4120
4132
|
entityType: number;
|
|
4121
|
-
type:
|
|
4133
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4122
4134
|
url: string;
|
|
4123
4135
|
name: string;
|
|
4124
4136
|
introduction?: string | null;
|
|
@@ -4293,7 +4305,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
4293
4305
|
export interface SiteConfigurationSummary {
|
|
4294
4306
|
/** @format uuid */
|
|
4295
4307
|
id: string;
|
|
4296
|
-
type:
|
|
4308
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4297
4309
|
url?: string | null;
|
|
4298
4310
|
name: string;
|
|
4299
4311
|
/** @format int64 */
|
|
@@ -4870,7 +4882,7 @@ export interface UserDevice {
|
|
|
4870
4882
|
export interface UserDraft {
|
|
4871
4883
|
/** @format uuid */
|
|
4872
4884
|
draftID: string;
|
|
4873
|
-
role:
|
|
4885
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
4874
4886
|
user: User;
|
|
4875
4887
|
}
|
|
4876
4888
|
export interface UserDraftPaginated {
|
|
@@ -4894,7 +4906,7 @@ export interface UserGroupAccessScope {
|
|
|
4894
4906
|
id: string;
|
|
4895
4907
|
/** @format uuid */
|
|
4896
4908
|
groupId: string;
|
|
4897
|
-
scopeType:
|
|
4909
|
+
scopeType: "User" | "Branch";
|
|
4898
4910
|
/** @format uuid */
|
|
4899
4911
|
userId?: string | null;
|
|
4900
4912
|
/** @format uuid */
|
|
@@ -4927,7 +4939,7 @@ export interface UserLoan {
|
|
|
4927
4939
|
deletedAt?: string | null;
|
|
4928
4940
|
loanID: string;
|
|
4929
4941
|
user: User;
|
|
4930
|
-
role:
|
|
4942
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
4931
4943
|
/** @format int32 */
|
|
4932
4944
|
borrowerPair?: number | null;
|
|
4933
4945
|
/** @format int32 */
|
|
@@ -4939,7 +4951,7 @@ export interface UserLoanConsent {
|
|
|
4939
4951
|
id: string;
|
|
4940
4952
|
/** @format uuid */
|
|
4941
4953
|
userLoanID: string;
|
|
4942
|
-
type:
|
|
4954
|
+
type: "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
4943
4955
|
providedConsent: boolean;
|
|
4944
4956
|
ipAddress?: string | null;
|
|
4945
4957
|
/** @format date-time */
|
|
@@ -5073,7 +5085,7 @@ export interface UserSummary {
|
|
|
5073
5085
|
id: string;
|
|
5074
5086
|
name?: string | null;
|
|
5075
5087
|
email?: string | null;
|
|
5076
|
-
role:
|
|
5088
|
+
role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
5077
5089
|
}
|
|
5078
5090
|
export interface VerifyPasswordRequest {
|
|
5079
5091
|
/**
|
|
@@ -5106,42 +5118,6 @@ export interface Workflow {
|
|
|
5106
5118
|
tileSubtitle: string;
|
|
5107
5119
|
icon: string;
|
|
5108
5120
|
}
|
|
5109
|
-
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
5110
|
-
export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
|
|
5111
|
-
export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
|
|
5112
|
-
export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5113
|
-
/** @deprecated */
|
|
5114
|
-
export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
5115
|
-
export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
5116
|
-
export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5117
|
-
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
5118
|
-
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
5119
|
-
export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
5120
|
-
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";
|
|
5121
|
-
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5122
|
-
export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
5123
|
-
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
5124
|
-
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5125
|
-
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5126
|
-
export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent";
|
|
5127
|
-
export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5128
|
-
export type SamlMetadataRequestSsoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5129
|
-
export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5130
|
-
export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5131
|
-
export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5132
|
-
export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5133
|
-
export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5134
|
-
export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5135
|
-
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
5136
|
-
export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5137
|
-
export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
5138
|
-
export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
5139
|
-
/** @default "Realtor" */
|
|
5140
|
-
export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
5141
|
-
export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5142
|
-
export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5143
|
-
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5144
|
-
export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5145
5121
|
import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
|
|
5146
5122
|
export type QueryParamsType = Record<string | number, any>;
|
|
5147
5123
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
|
|
@@ -5187,7 +5163,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
5187
5163
|
}
|
|
5188
5164
|
/**
|
|
5189
5165
|
* @title The Big POS API
|
|
5190
|
-
* @version v2.35.
|
|
5166
|
+
* @version v2.35.1
|
|
5191
5167
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
5192
5168
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
5193
5169
|
*/
|
|
@@ -6903,16 +6879,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6903
6879
|
sortDirection?: string;
|
|
6904
6880
|
}, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentSearchPaginated, any, {}>>;
|
|
6905
6881
|
/**
|
|
6906
|
-
* @description Returns all documents grouped by folder for sidebar display
|
|
6882
|
+
* @description Returns all documents grouped by folder for sidebar display. Use folderNamesOnly=true to get simplified response with folder names and counts for mobile (Files array will be empty).
|
|
6907
6883
|
*
|
|
6908
6884
|
* @tags LoanDocuments
|
|
6909
6885
|
* @name GetLoanDocumentFolders
|
|
6910
6886
|
* @summary Get document folder hierarchy
|
|
6911
|
-
* @request
|
|
6887
|
+
* @request POST:/api/loans/{loanId}/documents/folders
|
|
6912
6888
|
* @secure
|
|
6913
6889
|
* @response `200` `(DocumentFolder)[]` Success
|
|
6914
6890
|
*/
|
|
6915
|
-
getLoanDocumentFolders: (loanId: string,
|
|
6891
|
+
getLoanDocumentFolders: (loanId: string, data: DocumentFoldersRequest, query?: {
|
|
6892
|
+
/** @default false */
|
|
6893
|
+
folderNamesOnly?: boolean;
|
|
6894
|
+
}, params?: RequestParams) => Promise<AxiosResponse<DocumentFolder[], any, {}>>;
|
|
6916
6895
|
/**
|
|
6917
6896
|
* No description
|
|
6918
6897
|
*
|
|
@@ -6984,27 +6963,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6984
6963
|
* @description Fetches all documents from Encompass that don't exist locally and stores them in S3
|
|
6985
6964
|
*
|
|
6986
6965
|
* @tags LoanDocuments
|
|
6987
|
-
* @name
|
|
6988
|
-
* @summary Sync documents from
|
|
6966
|
+
* @name SyncLoanDocumentsFromLos
|
|
6967
|
+
* @summary Sync documents from LOS
|
|
6989
6968
|
* @request POST:/api/loans/{loanId}/documents/sync
|
|
6990
6969
|
* @secure
|
|
6991
6970
|
* @response `200` `DocumentSync` Success
|
|
6992
6971
|
* @response `404` `ProblemDetails` Not Found
|
|
6993
6972
|
*/
|
|
6994
|
-
|
|
6973
|
+
syncLoanDocumentsFromLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<DocumentSync, any, {}>>;
|
|
6995
6974
|
/**
|
|
6996
|
-
* @description Re-attempts to push a failed document to
|
|
6975
|
+
* @description Re-attempts to push a failed document to LOS
|
|
6997
6976
|
*
|
|
6998
6977
|
* @tags LoanDocuments
|
|
6999
|
-
* @name
|
|
7000
|
-
* @summary Retry syncing a document to
|
|
6978
|
+
* @name RetrySyncLoanDocumentToLos
|
|
6979
|
+
* @summary Retry syncing a document to LOS
|
|
7001
6980
|
* @request POST:/api/loans/{loanId}/documents/{documentId}/sync/retry
|
|
7002
6981
|
* @secure
|
|
7003
6982
|
* @response `200` `void` Success
|
|
7004
6983
|
* @response `404` `ProblemDetails` Not Found
|
|
7005
6984
|
* @response `423` `ProblemDetails` Client Error
|
|
7006
6985
|
*/
|
|
7007
|
-
|
|
6986
|
+
retrySyncLoanDocumentToLos: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
7008
6987
|
/**
|
|
7009
6988
|
* No description
|
|
7010
6989
|
*
|
|
@@ -7372,7 +7351,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7372
7351
|
* @name GetLoans
|
|
7373
7352
|
* @summary Get Loans
|
|
7374
7353
|
* @request GET:/api/loans
|
|
7375
|
-
* @deprecated
|
|
7376
7354
|
* @secure
|
|
7377
7355
|
* @response `200` `GetApplications` Success
|
|
7378
7356
|
*/
|
|
@@ -7980,7 +7958,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7980
7958
|
getPartners: (query?: {
|
|
7981
7959
|
showAll?: boolean;
|
|
7982
7960
|
/** @default "Realtor" */
|
|
7983
|
-
role?:
|
|
7961
|
+
role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
7984
7962
|
/** @format int32 */
|
|
7985
7963
|
pageSize?: number;
|
|
7986
7964
|
/** @format int32 */
|
|
@@ -8158,7 +8136,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8158
8136
|
* @response `200` `File` Success
|
|
8159
8137
|
* @response `404` `ProblemDetails` Not Found
|
|
8160
8138
|
*/
|
|
8161
|
-
getSamlMetadata: (sSoIntegration:
|
|
8139
|
+
getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
8162
8140
|
/**
|
|
8163
8141
|
* No description
|
|
8164
8142
|
*
|
|
@@ -8169,7 +8147,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8169
8147
|
* @secure
|
|
8170
8148
|
* @response `200` `File` Success
|
|
8171
8149
|
*/
|
|
8172
|
-
createOrReplaceSamlMetadata: (sSoIntegration:
|
|
8150
|
+
createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
8173
8151
|
/**
|
|
8174
8152
|
* No description
|
|
8175
8153
|
*
|
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.35.
|
|
107
|
+
* @version v2.35.1
|
|
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
|
*/
|
|
@@ -1653,16 +1653,16 @@ export class Api extends HttpClient {
|
|
|
1653
1653
|
*/
|
|
1654
1654
|
searchLoanDocuments: (loanId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1655
1655
|
/**
|
|
1656
|
-
* @description Returns all documents grouped by folder for sidebar display
|
|
1656
|
+
* @description Returns all documents grouped by folder for sidebar display. Use folderNamesOnly=true to get simplified response with folder names and counts for mobile (Files array will be empty).
|
|
1657
1657
|
*
|
|
1658
1658
|
* @tags LoanDocuments
|
|
1659
1659
|
* @name GetLoanDocumentFolders
|
|
1660
1660
|
* @summary Get document folder hierarchy
|
|
1661
|
-
* @request
|
|
1661
|
+
* @request POST:/api/loans/{loanId}/documents/folders
|
|
1662
1662
|
* @secure
|
|
1663
1663
|
* @response `200` `(DocumentFolder)[]` Success
|
|
1664
1664
|
*/
|
|
1665
|
-
getLoanDocumentFolders: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/folders`, method: "
|
|
1665
|
+
getLoanDocumentFolders: (loanId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/folders`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1666
1666
|
/**
|
|
1667
1667
|
* No description
|
|
1668
1668
|
*
|
|
@@ -1729,27 +1729,27 @@ export class Api extends HttpClient {
|
|
|
1729
1729
|
* @description Fetches all documents from Encompass that don't exist locally and stores them in S3
|
|
1730
1730
|
*
|
|
1731
1731
|
* @tags LoanDocuments
|
|
1732
|
-
* @name
|
|
1733
|
-
* @summary Sync documents from
|
|
1732
|
+
* @name SyncLoanDocumentsFromLos
|
|
1733
|
+
* @summary Sync documents from LOS
|
|
1734
1734
|
* @request POST:/api/loans/{loanId}/documents/sync
|
|
1735
1735
|
* @secure
|
|
1736
1736
|
* @response `200` `DocumentSync` Success
|
|
1737
1737
|
* @response `404` `ProblemDetails` Not Found
|
|
1738
1738
|
*/
|
|
1739
|
-
|
|
1739
|
+
syncLoanDocumentsFromLos: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/sync`, method: "POST", secure: true, format: "json" }, params)),
|
|
1740
1740
|
/**
|
|
1741
|
-
* @description Re-attempts to push a failed document to
|
|
1741
|
+
* @description Re-attempts to push a failed document to LOS
|
|
1742
1742
|
*
|
|
1743
1743
|
* @tags LoanDocuments
|
|
1744
|
-
* @name
|
|
1745
|
-
* @summary Retry syncing a document to
|
|
1744
|
+
* @name RetrySyncLoanDocumentToLos
|
|
1745
|
+
* @summary Retry syncing a document to LOS
|
|
1746
1746
|
* @request POST:/api/loans/{loanId}/documents/{documentId}/sync/retry
|
|
1747
1747
|
* @secure
|
|
1748
1748
|
* @response `200` `void` Success
|
|
1749
1749
|
* @response `404` `ProblemDetails` Not Found
|
|
1750
1750
|
* @response `423` `ProblemDetails` Client Error
|
|
1751
1751
|
*/
|
|
1752
|
-
|
|
1752
|
+
retrySyncLoanDocumentToLos: (loanId, documentId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/${documentId}/sync/retry`, method: "POST", secure: true }, params)),
|
|
1753
1753
|
/**
|
|
1754
1754
|
* No description
|
|
1755
1755
|
*
|
|
@@ -2063,7 +2063,6 @@ export class Api extends HttpClient {
|
|
|
2063
2063
|
* @name GetLoans
|
|
2064
2064
|
* @summary Get Loans
|
|
2065
2065
|
* @request GET:/api/loans
|
|
2066
|
-
* @deprecated
|
|
2067
2066
|
* @secure
|
|
2068
2067
|
* @response `200` `GetApplications` Success
|
|
2069
2068
|
*/
|