@matech/thebigpos-sdk 2.25.3 → 2.26.1-rc0
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/.husky/pre-commit +2 -2
- package/LICENSE +21 -21
- package/README.md +44 -44
- package/dist/index.d.ts +46 -63
- package/dist/index.js +12 -1
- package/dist/index.js.map +1 -1
- package/package.json +40 -40
- package/scripts/apply-json-patch-content-type.js +56 -56
- package/src/index.ts +171 -262
- package/tsconfig.json +27 -27
package/.husky/pre-commit
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
[ -f ./src/index.ts ] && node scripts/apply-json-patch-content-type.js
|
|
2
|
-
yarn build
|
|
1
|
+
[ -f ./src/index.ts ] && node scripts/apply-json-patch-content-type.js
|
|
2
|
+
yarn build
|
|
3
3
|
git add .
|
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2024 Mortgage Automation Technologies
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Mortgage Automation Technologies
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,44 +1,44 @@
|
|
|
1
|
-
# The BIG POS Typescript SDK
|
|
2
|
-
|
|
3
|
-
## Installation
|
|
4
|
-
Using npm:
|
|
5
|
-
|
|
6
|
-
```bash
|
|
7
|
-
$ npm install @matech/thebigpos-sdk
|
|
8
|
-
```
|
|
9
|
-
|
|
10
|
-
Using yarn:
|
|
11
|
-
|
|
12
|
-
```bash
|
|
13
|
-
$ yarn add @matech/thebigpos-sdk
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## Quick Start
|
|
17
|
-
```js
|
|
18
|
-
import { Api } from "@matech/thebigpos-sdk";
|
|
19
|
-
|
|
20
|
-
const securityWorker = (data: any) => {
|
|
21
|
-
return { headers: data }
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
const setBearerSecurityWorker = (accessToken:string) => {
|
|
25
|
-
const data = {
|
|
26
|
-
Authorization: `Bearer ${accessToken}`
|
|
27
|
-
};
|
|
28
|
-
|
|
29
|
-
apiClient.setSecurityData(data);
|
|
30
|
-
};
|
|
31
|
-
|
|
32
|
-
const apiClient = new Api({
|
|
33
|
-
baseURL:
|
|
34
|
-
process.env.REACT_APP_POS_API_HOST || 'https://api.thebigpos.com',
|
|
35
|
-
securityWorker,
|
|
36
|
-
})
|
|
37
|
-
|
|
38
|
-
apiClient.api.getSiteConfiguration().then((response) => {
|
|
39
|
-
console.log(response.data);
|
|
40
|
-
});
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
____
|
|
44
|
-
© 2024 Mortgage Automation Technologies. All rights reserved
|
|
1
|
+
# The BIG POS Typescript SDK
|
|
2
|
+
|
|
3
|
+
## Installation
|
|
4
|
+
Using npm:
|
|
5
|
+
|
|
6
|
+
```bash
|
|
7
|
+
$ npm install @matech/thebigpos-sdk
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
Using yarn:
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
$ yarn add @matech/thebigpos-sdk
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
```js
|
|
18
|
+
import { Api } from "@matech/thebigpos-sdk";
|
|
19
|
+
|
|
20
|
+
const securityWorker = (data: any) => {
|
|
21
|
+
return { headers: data }
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
const setBearerSecurityWorker = (accessToken:string) => {
|
|
25
|
+
const data = {
|
|
26
|
+
Authorization: `Bearer ${accessToken}`
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
apiClient.setSecurityData(data);
|
|
30
|
+
};
|
|
31
|
+
|
|
32
|
+
const apiClient = new Api({
|
|
33
|
+
baseURL:
|
|
34
|
+
process.env.REACT_APP_POS_API_HOST || 'https://api.thebigpos.com',
|
|
35
|
+
securityWorker,
|
|
36
|
+
})
|
|
37
|
+
|
|
38
|
+
apiClient.api.getSiteConfiguration().then((response) => {
|
|
39
|
+
console.log(response.data);
|
|
40
|
+
});
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
____
|
|
44
|
+
© 2024 Mortgage Automation Technologies. All rights reserved
|
package/dist/index.d.ts
CHANGED
|
@@ -525,7 +525,7 @@ export interface CorporateSearchCriteria {
|
|
|
525
525
|
isActive?: boolean | null;
|
|
526
526
|
}
|
|
527
527
|
export interface CreateAccessScopeRequest {
|
|
528
|
-
scopeType:
|
|
528
|
+
scopeType: "User" | "Branch";
|
|
529
529
|
/** @format uuid */
|
|
530
530
|
userId?: string | null;
|
|
531
531
|
/** @format uuid */
|
|
@@ -548,7 +548,7 @@ export interface CreateAccountRequest {
|
|
|
548
548
|
*/
|
|
549
549
|
nlmsid: number;
|
|
550
550
|
settings: AccountSettingsRequest;
|
|
551
|
-
environment:
|
|
551
|
+
environment: "Development" | "Staging" | "UAT" | "Production";
|
|
552
552
|
losIntegration: LOSIntegration;
|
|
553
553
|
}
|
|
554
554
|
export interface CreateBranchRequest {
|
|
@@ -577,7 +577,7 @@ export interface CreateDocumentTemplateRequest {
|
|
|
577
577
|
export interface CreateGroupMemberRequest {
|
|
578
578
|
/** @format uuid */
|
|
579
579
|
userId: string;
|
|
580
|
-
loanRole:
|
|
580
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
581
581
|
}
|
|
582
582
|
export interface CreateInviteRequest {
|
|
583
583
|
/** @minLength 1 */
|
|
@@ -588,7 +588,7 @@ export interface CreateInviteRequest {
|
|
|
588
588
|
emailAddress: string;
|
|
589
589
|
phoneNumber?: string | null;
|
|
590
590
|
/** @deprecated */
|
|
591
|
-
relationship:
|
|
591
|
+
relationship: "NotApplicable" | "Spouse" | "NonSpouse";
|
|
592
592
|
loanID: string;
|
|
593
593
|
route?: string | null;
|
|
594
594
|
/** @format uuid */
|
|
@@ -610,13 +610,13 @@ export interface CreateLoanImportRequest {
|
|
|
610
610
|
* @minLength 1
|
|
611
611
|
*/
|
|
612
612
|
startDate: string;
|
|
613
|
-
importMode:
|
|
613
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
614
614
|
}
|
|
615
615
|
export interface CreateUserDeviceRequest {
|
|
616
616
|
token: string;
|
|
617
617
|
}
|
|
618
618
|
export interface CreateUserDraft {
|
|
619
|
-
loanRole:
|
|
619
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
620
620
|
}
|
|
621
621
|
export interface CreateUserGroupRequest {
|
|
622
622
|
/**
|
|
@@ -881,6 +881,8 @@ export interface Draft {
|
|
|
881
881
|
user: UserBase;
|
|
882
882
|
loanOfficer: UserBase;
|
|
883
883
|
siteConfiguration: SiteConfigurationReduced;
|
|
884
|
+
/** @format uuid */
|
|
885
|
+
loanID?: string | null;
|
|
884
886
|
}
|
|
885
887
|
export interface DraftContent {
|
|
886
888
|
/** @format date-time */
|
|
@@ -895,6 +897,8 @@ export interface DraftContent {
|
|
|
895
897
|
user: UserBase;
|
|
896
898
|
loanOfficer: UserBase;
|
|
897
899
|
siteConfiguration: SiteConfigurationReduced;
|
|
900
|
+
/** @format uuid */
|
|
901
|
+
loanID?: string | null;
|
|
898
902
|
applicationPayload: any;
|
|
899
903
|
}
|
|
900
904
|
export interface DraftContentPaginated {
|
|
@@ -1167,7 +1171,7 @@ export interface FusionFieldDisplay {
|
|
|
1167
1171
|
fieldValue: string;
|
|
1168
1172
|
}
|
|
1169
1173
|
export interface FusionReportFilter {
|
|
1170
|
-
filterType:
|
|
1174
|
+
filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
1171
1175
|
targetField: string;
|
|
1172
1176
|
targetValue: string;
|
|
1173
1177
|
}
|
|
@@ -1626,7 +1630,7 @@ export interface LoanContact {
|
|
|
1626
1630
|
email?: string | null;
|
|
1627
1631
|
phone?: string | null;
|
|
1628
1632
|
companyName?: string | null;
|
|
1629
|
-
role:
|
|
1633
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
1630
1634
|
}
|
|
1631
1635
|
export interface LoanContactList {
|
|
1632
1636
|
email: string;
|
|
@@ -1697,12 +1701,12 @@ export interface LoanDraftSearchCriteria {
|
|
|
1697
1701
|
/** @format uuid */
|
|
1698
1702
|
siteConfigurationId?: string | null;
|
|
1699
1703
|
isUnassigned?: boolean | null;
|
|
1704
|
+
includeDeleted?: boolean | null;
|
|
1700
1705
|
}
|
|
1701
1706
|
export interface LoanImport {
|
|
1702
1707
|
/** @format uuid */
|
|
1703
1708
|
id: string;
|
|
1704
|
-
|
|
1705
|
-
accountID: string;
|
|
1709
|
+
account: Account;
|
|
1706
1710
|
/** @format date-time */
|
|
1707
1711
|
endDate: string;
|
|
1708
1712
|
/** @format date-time */
|
|
@@ -1712,13 +1716,13 @@ export interface LoanImport {
|
|
|
1712
1716
|
/** @format int32 */
|
|
1713
1717
|
importedCount: number;
|
|
1714
1718
|
statusMessage?: string | null;
|
|
1715
|
-
status:
|
|
1716
|
-
importMode:
|
|
1719
|
+
status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
1720
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
1717
1721
|
/** @format date-time */
|
|
1718
1722
|
createdAt?: string | null;
|
|
1719
1723
|
}
|
|
1720
1724
|
export interface LoanImportLog {
|
|
1721
|
-
level:
|
|
1725
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
1722
1726
|
message: string;
|
|
1723
1727
|
/** @format date-time */
|
|
1724
1728
|
createdAt: string;
|
|
@@ -1762,8 +1766,8 @@ export interface LoanListPaginated {
|
|
|
1762
1766
|
export interface LoanLog {
|
|
1763
1767
|
/** @format uuid */
|
|
1764
1768
|
id: string;
|
|
1765
|
-
level:
|
|
1766
|
-
type:
|
|
1769
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
1770
|
+
type: "Loan" | "Queue" | "POSFlagChanged" | "Verification";
|
|
1767
1771
|
message: string;
|
|
1768
1772
|
/** @format date-time */
|
|
1769
1773
|
createdAt: string;
|
|
@@ -1885,7 +1889,7 @@ export interface LoanUpdateRequestJsonPatchDocument {
|
|
|
1885
1889
|
contractResolver?: IContractResolver | null;
|
|
1886
1890
|
}
|
|
1887
1891
|
export interface LoanUpdateRequestOperation {
|
|
1888
|
-
operationType:
|
|
1892
|
+
operationType: "Add" | "Remove" | "Replace" | "Move" | "Copy" | "Test" | "Invalid";
|
|
1889
1893
|
path?: string | null;
|
|
1890
1894
|
op?: string | null;
|
|
1891
1895
|
from?: string | null;
|
|
@@ -1899,7 +1903,7 @@ export interface LoanUser {
|
|
|
1899
1903
|
email: string;
|
|
1900
1904
|
phone?: string | null;
|
|
1901
1905
|
role: string;
|
|
1902
|
-
loanRole:
|
|
1906
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
1903
1907
|
isUser: boolean;
|
|
1904
1908
|
/** @format date-time */
|
|
1905
1909
|
createdAt: string;
|
|
@@ -2494,7 +2498,7 @@ export interface SSOTokenRequest {
|
|
|
2494
2498
|
redirectUri: string;
|
|
2495
2499
|
}
|
|
2496
2500
|
export interface SamlMetadataRequest {
|
|
2497
|
-
ssoIntegration:
|
|
2501
|
+
ssoIntegration: "ConsumerConnect" | "TheBigPOS";
|
|
2498
2502
|
}
|
|
2499
2503
|
export interface SendForgotPasswordRequest {
|
|
2500
2504
|
/**
|
|
@@ -2529,7 +2533,7 @@ export interface SiteConfiguration {
|
|
|
2529
2533
|
deletedAt?: string | null;
|
|
2530
2534
|
/** @format uuid */
|
|
2531
2535
|
id: string;
|
|
2532
|
-
type:
|
|
2536
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
2533
2537
|
/** @format uuid */
|
|
2534
2538
|
entityID: string;
|
|
2535
2539
|
/** @format int32 */
|
|
@@ -2723,7 +2727,7 @@ export interface SiteConfigurationByUrl {
|
|
|
2723
2727
|
deletedAt?: string | null;
|
|
2724
2728
|
/** @format uuid */
|
|
2725
2729
|
id: string;
|
|
2726
|
-
type:
|
|
2730
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
2727
2731
|
/** @format uuid */
|
|
2728
2732
|
entityID: string;
|
|
2729
2733
|
/** @format int32 */
|
|
@@ -2934,7 +2938,7 @@ export interface SiteConfigurationForm {
|
|
|
2934
2938
|
export interface SiteConfigurationReduced {
|
|
2935
2939
|
/** @format uuid */
|
|
2936
2940
|
id: string;
|
|
2937
|
-
type:
|
|
2941
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
2938
2942
|
url?: string | null;
|
|
2939
2943
|
name: string;
|
|
2940
2944
|
/** @format int64 */
|
|
@@ -2951,7 +2955,7 @@ export interface SiteConfigurationRequest {
|
|
|
2951
2955
|
entityID: string;
|
|
2952
2956
|
/** @format int32 */
|
|
2953
2957
|
entityType: number;
|
|
2954
|
-
type:
|
|
2958
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
2955
2959
|
url: string;
|
|
2956
2960
|
name: string;
|
|
2957
2961
|
introduction?: string | null;
|
|
@@ -3126,7 +3130,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
3126
3130
|
export interface SiteConfigurationSummary {
|
|
3127
3131
|
/** @format uuid */
|
|
3128
3132
|
id: string;
|
|
3129
|
-
type:
|
|
3133
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3130
3134
|
url?: string | null;
|
|
3131
3135
|
name: string;
|
|
3132
3136
|
/** @format int64 */
|
|
@@ -3528,7 +3532,7 @@ export interface UserDevice {
|
|
|
3528
3532
|
export interface UserDraft {
|
|
3529
3533
|
/** @format uuid */
|
|
3530
3534
|
draftID: string;
|
|
3531
|
-
role:
|
|
3535
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3532
3536
|
user: User;
|
|
3533
3537
|
}
|
|
3534
3538
|
export interface UserDraftPaginated {
|
|
@@ -3552,7 +3556,7 @@ export interface UserGroupAccessScope {
|
|
|
3552
3556
|
id: string;
|
|
3553
3557
|
/** @format uuid */
|
|
3554
3558
|
groupId: string;
|
|
3555
|
-
scopeType:
|
|
3559
|
+
scopeType: "User" | "Branch";
|
|
3556
3560
|
/** @format uuid */
|
|
3557
3561
|
userId?: string | null;
|
|
3558
3562
|
/** @format uuid */
|
|
@@ -3585,7 +3589,7 @@ export interface UserLoan {
|
|
|
3585
3589
|
deletedAt?: string | null;
|
|
3586
3590
|
loanID: string;
|
|
3587
3591
|
user: User;
|
|
3588
|
-
role:
|
|
3592
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3589
3593
|
/** @format int32 */
|
|
3590
3594
|
borrowerPair?: number | null;
|
|
3591
3595
|
/** @format int32 */
|
|
@@ -3718,7 +3722,7 @@ export interface UserSummary {
|
|
|
3718
3722
|
id: string;
|
|
3719
3723
|
name?: string | null;
|
|
3720
3724
|
email?: string | null;
|
|
3721
|
-
role:
|
|
3725
|
+
role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
3722
3726
|
}
|
|
3723
3727
|
export interface VerifyPasswordRequest {
|
|
3724
3728
|
/**
|
|
@@ -3751,38 +3755,6 @@ export interface Workflow {
|
|
|
3751
3755
|
tileSubtitle: string;
|
|
3752
3756
|
icon: string;
|
|
3753
3757
|
}
|
|
3754
|
-
export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
|
|
3755
|
-
export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
|
|
3756
|
-
export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3757
|
-
/** @deprecated */
|
|
3758
|
-
export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
3759
|
-
export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
3760
|
-
export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3761
|
-
export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
3762
|
-
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3763
|
-
export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
3764
|
-
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
3765
|
-
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
3766
|
-
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
3767
|
-
export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification";
|
|
3768
|
-
export type LoanUpdateRequestOperationOperationTypeEnum = "Add" | "Remove" | "Replace" | "Move" | "Copy" | "Test" | "Invalid";
|
|
3769
|
-
export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3770
|
-
export type SamlMetadataRequestSsoIntegrationEnum = "ConsumerConnect" | "TheBigPOS";
|
|
3771
|
-
export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3772
|
-
export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3773
|
-
export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3774
|
-
export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3775
|
-
export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3776
|
-
export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3777
|
-
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
3778
|
-
export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3779
|
-
export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
3780
|
-
/** @default "Realtor" */
|
|
3781
|
-
export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
3782
|
-
export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS";
|
|
3783
|
-
export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS";
|
|
3784
|
-
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS";
|
|
3785
|
-
export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS";
|
|
3786
3758
|
import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
|
|
3787
3759
|
export type QueryParamsType = Record<string | number, any>;
|
|
3788
3760
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
|
|
@@ -3828,7 +3800,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
3828
3800
|
}
|
|
3829
3801
|
/**
|
|
3830
3802
|
* @title The Big POS API
|
|
3831
|
-
* @version v2.
|
|
3803
|
+
* @version v2.26.1
|
|
3832
3804
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
3833
3805
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
3834
3806
|
*/
|
|
@@ -5603,6 +5575,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5603
5575
|
* @response `200` `Draft` Success
|
|
5604
5576
|
*/
|
|
5605
5577
|
reassignLoanOfficer: (draftId: string, data: DraftLoanOfficerReassignRequest, params?: RequestParams) => Promise<AxiosResponse<Draft, any>>;
|
|
5578
|
+
/**
|
|
5579
|
+
* No description
|
|
5580
|
+
*
|
|
5581
|
+
* @tags LoanDrafts
|
|
5582
|
+
* @name RestoreLoanDraft
|
|
5583
|
+
* @summary Restore deleted draft
|
|
5584
|
+
* @request POST:/api/loans/drafts/{draftId}/restore
|
|
5585
|
+
* @secure
|
|
5586
|
+
* @response `200` `Draft` Success
|
|
5587
|
+
*/
|
|
5588
|
+
restoreLoanDraft: (draftId: string, params?: RequestParams) => Promise<AxiosResponse<Draft, any>>;
|
|
5606
5589
|
/**
|
|
5607
5590
|
* No description
|
|
5608
5591
|
*
|
|
@@ -6469,7 +6452,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6469
6452
|
getPartners: (query?: {
|
|
6470
6453
|
showAll?: boolean;
|
|
6471
6454
|
/** @default "Realtor" */
|
|
6472
|
-
role?:
|
|
6455
|
+
role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
6473
6456
|
/** @format int32 */
|
|
6474
6457
|
pageSize?: number;
|
|
6475
6458
|
/** @format int32 */
|
|
@@ -6647,7 +6630,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6647
6630
|
* @response `200` `File` Success
|
|
6648
6631
|
* @response `404` `ProblemDetails` Not Found
|
|
6649
6632
|
*/
|
|
6650
|
-
getSamlMetadata: (sSoIntegration:
|
|
6633
|
+
getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
|
|
6651
6634
|
/**
|
|
6652
6635
|
* No description
|
|
6653
6636
|
*
|
|
@@ -6658,7 +6641,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6658
6641
|
* @secure
|
|
6659
6642
|
* @response `200` `File` Success
|
|
6660
6643
|
*/
|
|
6661
|
-
createOrReplaceSamlMetadata: (sSoIntegration:
|
|
6644
|
+
createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
|
|
6662
6645
|
/**
|
|
6663
6646
|
* No description
|
|
6664
6647
|
*
|
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.26.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
|
*/
|
|
@@ -1722,6 +1722,17 @@ export class Api extends HttpClient {
|
|
|
1722
1722
|
* @response `200` `Draft` Success
|
|
1723
1723
|
*/
|
|
1724
1724
|
reassignLoanOfficer: (draftId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}/reassign`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1725
|
+
/**
|
|
1726
|
+
* No description
|
|
1727
|
+
*
|
|
1728
|
+
* @tags LoanDrafts
|
|
1729
|
+
* @name RestoreLoanDraft
|
|
1730
|
+
* @summary Restore deleted draft
|
|
1731
|
+
* @request POST:/api/loans/drafts/{draftId}/restore
|
|
1732
|
+
* @secure
|
|
1733
|
+
* @response `200` `Draft` Success
|
|
1734
|
+
*/
|
|
1735
|
+
restoreLoanDraft: (draftId, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}/restore`, method: "POST", secure: true, format: "json" }, params)),
|
|
1725
1736
|
/**
|
|
1726
1737
|
* No description
|
|
1727
1738
|
*
|