@matech/thebigpos-sdk 2.27.10 → 2.27.11-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/.husky/pre-commit +2 -2
- package/LICENSE +21 -21
- package/README.md +44 -44
- package/dist/index.d.ts +57 -64
- package/dist/index.js +20 -7
- 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 +204 -274
- 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
|
@@ -14,6 +14,7 @@ export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Fai
|
|
|
14
14
|
export type FilterType = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
15
15
|
export type Environment = "Development" | "Staging" | "UAT" | "Production";
|
|
16
16
|
export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
|
|
17
|
+
export type DraftType = "NewLoan" | "EditLoan";
|
|
17
18
|
export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
18
19
|
export type BranchType = "Mortgage" | "RealEstate";
|
|
19
20
|
export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
|
|
@@ -62,6 +63,7 @@ export interface Account {
|
|
|
62
63
|
}
|
|
63
64
|
export interface AccountSettings {
|
|
64
65
|
isSmsEnabled: boolean;
|
|
66
|
+
isLoanEditEnabled: boolean;
|
|
65
67
|
smsNumber?: string | null;
|
|
66
68
|
}
|
|
67
69
|
export interface AccountSettingsRequest {
|
|
@@ -528,7 +530,7 @@ export interface CorporateSearchCriteria {
|
|
|
528
530
|
isActive?: boolean | null;
|
|
529
531
|
}
|
|
530
532
|
export interface CreateAccessScopeRequest {
|
|
531
|
-
scopeType:
|
|
533
|
+
scopeType: "User" | "Branch";
|
|
532
534
|
/** @format uuid */
|
|
533
535
|
userId?: string | null;
|
|
534
536
|
/** @format uuid */
|
|
@@ -551,7 +553,7 @@ export interface CreateAccountRequest {
|
|
|
551
553
|
*/
|
|
552
554
|
nlmsid: number;
|
|
553
555
|
settings: AccountSettingsRequest;
|
|
554
|
-
environment:
|
|
556
|
+
environment: "Development" | "Staging" | "UAT" | "Production";
|
|
555
557
|
losIntegration: LOSIntegration;
|
|
556
558
|
}
|
|
557
559
|
export interface CreateBranchRequest {
|
|
@@ -580,7 +582,7 @@ export interface CreateDocumentTemplateRequest {
|
|
|
580
582
|
export interface CreateGroupMemberRequest {
|
|
581
583
|
/** @format uuid */
|
|
582
584
|
userId: string;
|
|
583
|
-
loanRole:
|
|
585
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
584
586
|
}
|
|
585
587
|
export interface CreateInviteRequest {
|
|
586
588
|
/** @minLength 1 */
|
|
@@ -591,7 +593,7 @@ export interface CreateInviteRequest {
|
|
|
591
593
|
emailAddress: string;
|
|
592
594
|
phoneNumber?: string | null;
|
|
593
595
|
/** @deprecated */
|
|
594
|
-
relationship:
|
|
596
|
+
relationship: "NotApplicable" | "Spouse" | "NonSpouse";
|
|
595
597
|
loanID: string;
|
|
596
598
|
route?: string | null;
|
|
597
599
|
/** @format uuid */
|
|
@@ -613,13 +615,13 @@ export interface CreateLoanImportRequest {
|
|
|
613
615
|
* @minLength 1
|
|
614
616
|
*/
|
|
615
617
|
startDate: string;
|
|
616
|
-
importMode:
|
|
618
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
617
619
|
}
|
|
618
620
|
export interface CreateUserDeviceRequest {
|
|
619
621
|
token: string;
|
|
620
622
|
}
|
|
621
623
|
export interface CreateUserDraft {
|
|
622
|
-
loanRole:
|
|
624
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
623
625
|
}
|
|
624
626
|
export interface CreateUserGroupRequest {
|
|
625
627
|
/**
|
|
@@ -886,6 +888,8 @@ export interface Draft {
|
|
|
886
888
|
siteConfiguration: SiteConfigurationReduced;
|
|
887
889
|
/** @format uuid */
|
|
888
890
|
loanID?: string | null;
|
|
891
|
+
type: "NewLoan" | "EditLoan";
|
|
892
|
+
isCoBorrower: boolean;
|
|
889
893
|
}
|
|
890
894
|
export interface DraftContent {
|
|
891
895
|
/** @format date-time */
|
|
@@ -902,6 +906,8 @@ export interface DraftContent {
|
|
|
902
906
|
siteConfiguration: SiteConfigurationReduced;
|
|
903
907
|
/** @format uuid */
|
|
904
908
|
loanID?: string | null;
|
|
909
|
+
type: "NewLoan" | "EditLoan";
|
|
910
|
+
isCoBorrower: boolean;
|
|
905
911
|
applicationPayload: any;
|
|
906
912
|
}
|
|
907
913
|
export interface DraftContentPaginated {
|
|
@@ -1174,7 +1180,7 @@ export interface FusionFieldDisplay {
|
|
|
1174
1180
|
fieldValue: string;
|
|
1175
1181
|
}
|
|
1176
1182
|
export interface FusionReportFilter {
|
|
1177
|
-
filterType:
|
|
1183
|
+
filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
1178
1184
|
targetField: string;
|
|
1179
1185
|
targetValue: string;
|
|
1180
1186
|
}
|
|
@@ -1635,7 +1641,7 @@ export interface LoanContact {
|
|
|
1635
1641
|
email?: string | null;
|
|
1636
1642
|
phone?: string | null;
|
|
1637
1643
|
companyName?: string | null;
|
|
1638
|
-
role:
|
|
1644
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
1639
1645
|
}
|
|
1640
1646
|
export interface LoanContactList {
|
|
1641
1647
|
email: string;
|
|
@@ -1708,6 +1714,7 @@ export interface LoanDraftSearchCriteria {
|
|
|
1708
1714
|
isUnassigned?: boolean | null;
|
|
1709
1715
|
includeDeleted?: boolean | null;
|
|
1710
1716
|
excludeLinkedToLoan?: boolean | null;
|
|
1717
|
+
draftTypes?: DraftType[] | null;
|
|
1711
1718
|
}
|
|
1712
1719
|
export interface LoanIdentifier {
|
|
1713
1720
|
/** @format uuid */
|
|
@@ -1727,13 +1734,13 @@ export interface LoanImport {
|
|
|
1727
1734
|
/** @format int32 */
|
|
1728
1735
|
importedCount: number;
|
|
1729
1736
|
statusMessage?: string | null;
|
|
1730
|
-
status:
|
|
1731
|
-
importMode:
|
|
1737
|
+
status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
1738
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
1732
1739
|
/** @format date-time */
|
|
1733
1740
|
createdAt?: string | null;
|
|
1734
1741
|
}
|
|
1735
1742
|
export interface LoanImportLog {
|
|
1736
|
-
level:
|
|
1743
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
1737
1744
|
message: string;
|
|
1738
1745
|
/** @format date-time */
|
|
1739
1746
|
createdAt: string;
|
|
@@ -1777,8 +1784,8 @@ export interface LoanListPaginated {
|
|
|
1777
1784
|
export interface LoanLog {
|
|
1778
1785
|
/** @format uuid */
|
|
1779
1786
|
id: string;
|
|
1780
|
-
level:
|
|
1781
|
-
type:
|
|
1787
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
1788
|
+
type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded";
|
|
1782
1789
|
message: string;
|
|
1783
1790
|
/** @format date-time */
|
|
1784
1791
|
createdAt: string;
|
|
@@ -1900,7 +1907,7 @@ export interface LoanUpdateRequestJsonPatchDocument {
|
|
|
1900
1907
|
contractResolver?: IContractResolver | null;
|
|
1901
1908
|
}
|
|
1902
1909
|
export interface LoanUpdateRequestOperation {
|
|
1903
|
-
operationType:
|
|
1910
|
+
operationType: "Add" | "Remove" | "Replace" | "Move" | "Copy" | "Test" | "Invalid";
|
|
1904
1911
|
path?: string | null;
|
|
1905
1912
|
op?: string | null;
|
|
1906
1913
|
from?: string | null;
|
|
@@ -1914,7 +1921,7 @@ export interface LoanUser {
|
|
|
1914
1921
|
email: string;
|
|
1915
1922
|
phone?: string | null;
|
|
1916
1923
|
role: string;
|
|
1917
|
-
loanRole:
|
|
1924
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
1918
1925
|
isUser: boolean;
|
|
1919
1926
|
/** @format date-time */
|
|
1920
1927
|
createdAt: string;
|
|
@@ -2181,7 +2188,7 @@ export interface NotificationTemplateVersionUpdateRequest {
|
|
|
2181
2188
|
}
|
|
2182
2189
|
export interface Operation {
|
|
2183
2190
|
op?: string;
|
|
2184
|
-
value?:
|
|
2191
|
+
value?: string | number | boolean | null | object;
|
|
2185
2192
|
path?: string;
|
|
2186
2193
|
}
|
|
2187
2194
|
export interface OverridePasswordRequest {
|
|
@@ -2509,7 +2516,7 @@ export interface SSOTokenRequest {
|
|
|
2509
2516
|
redirectUri: string;
|
|
2510
2517
|
}
|
|
2511
2518
|
export interface SamlMetadataRequest {
|
|
2512
|
-
ssoIntegration:
|
|
2519
|
+
ssoIntegration: "ConsumerConnect" | "TheBigPOS";
|
|
2513
2520
|
}
|
|
2514
2521
|
export interface SendForgotPasswordRequest {
|
|
2515
2522
|
/**
|
|
@@ -2544,7 +2551,7 @@ export interface SiteConfiguration {
|
|
|
2544
2551
|
deletedAt?: string | null;
|
|
2545
2552
|
/** @format uuid */
|
|
2546
2553
|
id: string;
|
|
2547
|
-
type:
|
|
2554
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
2548
2555
|
/** @format uuid */
|
|
2549
2556
|
entityID: string;
|
|
2550
2557
|
/** @format int32 */
|
|
@@ -2738,7 +2745,7 @@ export interface SiteConfigurationByUrl {
|
|
|
2738
2745
|
deletedAt?: string | null;
|
|
2739
2746
|
/** @format uuid */
|
|
2740
2747
|
id: string;
|
|
2741
|
-
type:
|
|
2748
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
2742
2749
|
/** @format uuid */
|
|
2743
2750
|
entityID: string;
|
|
2744
2751
|
/** @format int32 */
|
|
@@ -2949,7 +2956,7 @@ export interface SiteConfigurationForm {
|
|
|
2949
2956
|
export interface SiteConfigurationReduced {
|
|
2950
2957
|
/** @format uuid */
|
|
2951
2958
|
id: string;
|
|
2952
|
-
type:
|
|
2959
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
2953
2960
|
url?: string | null;
|
|
2954
2961
|
name: string;
|
|
2955
2962
|
/** @format int64 */
|
|
@@ -2966,7 +2973,7 @@ export interface SiteConfigurationRequest {
|
|
|
2966
2973
|
entityID: string;
|
|
2967
2974
|
/** @format int32 */
|
|
2968
2975
|
entityType: number;
|
|
2969
|
-
type:
|
|
2976
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
2970
2977
|
url: string;
|
|
2971
2978
|
name: string;
|
|
2972
2979
|
introduction?: string | null;
|
|
@@ -3141,7 +3148,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
3141
3148
|
export interface SiteConfigurationSummary {
|
|
3142
3149
|
/** @format uuid */
|
|
3143
3150
|
id: string;
|
|
3144
|
-
type:
|
|
3151
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3145
3152
|
url?: string | null;
|
|
3146
3153
|
name: string;
|
|
3147
3154
|
/** @format int64 */
|
|
@@ -3543,7 +3550,7 @@ export interface UserDevice {
|
|
|
3543
3550
|
export interface UserDraft {
|
|
3544
3551
|
/** @format uuid */
|
|
3545
3552
|
draftID: string;
|
|
3546
|
-
role:
|
|
3553
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3547
3554
|
user: User;
|
|
3548
3555
|
}
|
|
3549
3556
|
export interface UserDraftPaginated {
|
|
@@ -3567,7 +3574,7 @@ export interface UserGroupAccessScope {
|
|
|
3567
3574
|
id: string;
|
|
3568
3575
|
/** @format uuid */
|
|
3569
3576
|
groupId: string;
|
|
3570
|
-
scopeType:
|
|
3577
|
+
scopeType: "User" | "Branch";
|
|
3571
3578
|
/** @format uuid */
|
|
3572
3579
|
userId?: string | null;
|
|
3573
3580
|
/** @format uuid */
|
|
@@ -3600,7 +3607,7 @@ export interface UserLoan {
|
|
|
3600
3607
|
deletedAt?: string | null;
|
|
3601
3608
|
loanID: string;
|
|
3602
3609
|
user: User;
|
|
3603
|
-
role:
|
|
3610
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3604
3611
|
/** @format int32 */
|
|
3605
3612
|
borrowerPair?: number | null;
|
|
3606
3613
|
/** @format int32 */
|
|
@@ -3612,7 +3619,7 @@ export interface UserLoanConsent {
|
|
|
3612
3619
|
id: string;
|
|
3613
3620
|
/** @format uuid */
|
|
3614
3621
|
userLoanID: string;
|
|
3615
|
-
type:
|
|
3622
|
+
type: "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
3616
3623
|
providedConsent: boolean;
|
|
3617
3624
|
ipAddress?: string | null;
|
|
3618
3625
|
/** @format date-time */
|
|
@@ -3746,7 +3753,7 @@ export interface UserSummary {
|
|
|
3746
3753
|
id: string;
|
|
3747
3754
|
name?: string | null;
|
|
3748
3755
|
email?: string | null;
|
|
3749
|
-
role:
|
|
3756
|
+
role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
3750
3757
|
}
|
|
3751
3758
|
export interface VerifyPasswordRequest {
|
|
3752
3759
|
/**
|
|
@@ -3779,39 +3786,6 @@ export interface Workflow {
|
|
|
3779
3786
|
tileSubtitle: string;
|
|
3780
3787
|
icon: string;
|
|
3781
3788
|
}
|
|
3782
|
-
export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
|
|
3783
|
-
export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
|
|
3784
|
-
export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3785
|
-
/** @deprecated */
|
|
3786
|
-
export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
3787
|
-
export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
3788
|
-
export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3789
|
-
export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
3790
|
-
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3791
|
-
export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
3792
|
-
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
3793
|
-
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
3794
|
-
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
3795
|
-
export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded";
|
|
3796
|
-
export type LoanUpdateRequestOperationOperationTypeEnum = "Add" | "Remove" | "Replace" | "Move" | "Copy" | "Test" | "Invalid";
|
|
3797
|
-
export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3798
|
-
export type SamlMetadataRequestSsoIntegrationEnum = "ConsumerConnect" | "TheBigPOS";
|
|
3799
|
-
export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3800
|
-
export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3801
|
-
export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3802
|
-
export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3803
|
-
export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3804
|
-
export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3805
|
-
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
3806
|
-
export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3807
|
-
export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
3808
|
-
export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
3809
|
-
/** @default "Realtor" */
|
|
3810
|
-
export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
3811
|
-
export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS";
|
|
3812
|
-
export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS";
|
|
3813
|
-
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS";
|
|
3814
|
-
export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS";
|
|
3815
3789
|
import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
|
|
3816
3790
|
export type QueryParamsType = Record<string | number, any>;
|
|
3817
3791
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
|
|
@@ -3835,6 +3809,7 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
|
|
|
3835
3809
|
format?: ResponseType;
|
|
3836
3810
|
}
|
|
3837
3811
|
export declare enum ContentType {
|
|
3812
|
+
JsonPatch = "application/json-patch+json",
|
|
3838
3813
|
Json = "application/json",
|
|
3839
3814
|
JsonApi = "application/vnd.api+json",
|
|
3840
3815
|
FormData = "multipart/form-data",
|
|
@@ -5056,7 +5031,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5056
5031
|
* @response `422` `UnprocessableEntity` Client Error
|
|
5057
5032
|
* @response `423` `UnprocessableEntity` Client Error
|
|
5058
5033
|
*/
|
|
5059
|
-
createLoan: (data: any,
|
|
5034
|
+
createLoan: (data: any, query?: {
|
|
5035
|
+
/** @default false */
|
|
5036
|
+
isPatch?: boolean;
|
|
5037
|
+
}, params?: RequestParams) => Promise<AxiosResponse<string, any>>;
|
|
5060
5038
|
/**
|
|
5061
5039
|
* No description
|
|
5062
5040
|
*
|
|
@@ -5175,6 +5153,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5175
5153
|
* @response `200` `DocumentDataRequest` Success
|
|
5176
5154
|
*/
|
|
5177
5155
|
createLegacyLoanDocument: (data: GenerateDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<DocumentDataRequest, any>>;
|
|
5156
|
+
/**
|
|
5157
|
+
* No description
|
|
5158
|
+
*
|
|
5159
|
+
* @tags LegacyLoan
|
|
5160
|
+
* @name CreateEditDraftForLoan
|
|
5161
|
+
* @summary Create Edit Draft for Loan
|
|
5162
|
+
* @request PUT:/api/los/loan/{loanID}/edit
|
|
5163
|
+
* @secure
|
|
5164
|
+
* @response `200` `Draft` Success
|
|
5165
|
+
* @response `422` `UnprocessableEntity` Client Error
|
|
5166
|
+
*/
|
|
5167
|
+
createEditDraftForLoan: (loanId: string, query?: {
|
|
5168
|
+
/** @default false */
|
|
5169
|
+
isCoBorrower?: boolean;
|
|
5170
|
+
}, params?: RequestParams) => Promise<AxiosResponse<Draft, any>>;
|
|
5178
5171
|
/**
|
|
5179
5172
|
* No description
|
|
5180
5173
|
*
|
|
@@ -6545,7 +6538,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6545
6538
|
getPartners: (query?: {
|
|
6546
6539
|
showAll?: boolean;
|
|
6547
6540
|
/** @default "Realtor" */
|
|
6548
|
-
role?:
|
|
6541
|
+
role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
6549
6542
|
/** @format int32 */
|
|
6550
6543
|
pageSize?: number;
|
|
6551
6544
|
/** @format int32 */
|
|
@@ -6723,7 +6716,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6723
6716
|
* @response `200` `File` Success
|
|
6724
6717
|
* @response `404` `ProblemDetails` Not Found
|
|
6725
6718
|
*/
|
|
6726
|
-
getSamlMetadata: (sSoIntegration:
|
|
6719
|
+
getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
|
|
6727
6720
|
/**
|
|
6728
6721
|
* No description
|
|
6729
6722
|
*
|
|
@@ -6734,7 +6727,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6734
6727
|
* @secure
|
|
6735
6728
|
* @response `200` `File` Success
|
|
6736
6729
|
*/
|
|
6737
|
-
createOrReplaceSamlMetadata: (sSoIntegration:
|
|
6730
|
+
createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
|
|
6738
6731
|
/**
|
|
6739
6732
|
* No description
|
|
6740
6733
|
*
|
package/dist/index.js
CHANGED
|
@@ -32,6 +32,7 @@ var __rest = (this && this.__rest) || function (s, e) {
|
|
|
32
32
|
import axios from "axios";
|
|
33
33
|
export var ContentType;
|
|
34
34
|
(function (ContentType) {
|
|
35
|
+
ContentType["JsonPatch"] = "application/json-patch+json";
|
|
35
36
|
ContentType["Json"] = "application/json";
|
|
36
37
|
ContentType["JsonApi"] = "application/vnd.api+json";
|
|
37
38
|
ContentType["FormData"] = "multipart/form-data";
|
|
@@ -1175,7 +1176,7 @@ export class Api extends HttpClient {
|
|
|
1175
1176
|
* @response `200` `string` Success
|
|
1176
1177
|
* @response `422` `UnprocessableEntity` Client Error
|
|
1177
1178
|
*/
|
|
1178
|
-
updateLoanConsentAndCustomFieldsObsolete: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
1179
|
+
updateLoanConsentAndCustomFieldsObsolete: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
|
|
1179
1180
|
/**
|
|
1180
1181
|
* No description
|
|
1181
1182
|
*
|
|
@@ -1200,7 +1201,7 @@ export class Api extends HttpClient {
|
|
|
1200
1201
|
* @response `422` `UnprocessableEntity` Client Error
|
|
1201
1202
|
* @response `423` `UnprocessableEntity` Client Error
|
|
1202
1203
|
*/
|
|
1203
|
-
createLoan: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1204
|
+
createLoan: (data, query, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1204
1205
|
/**
|
|
1205
1206
|
* No description
|
|
1206
1207
|
*
|
|
@@ -1225,7 +1226,7 @@ export class Api extends HttpClient {
|
|
|
1225
1226
|
* @response `200` `string` Success
|
|
1226
1227
|
* @response `422` `UnprocessableEntity` Client Error
|
|
1227
1228
|
*/
|
|
1228
|
-
updateLoanCustomFields: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/custom-fields`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
1229
|
+
updateLoanCustomFields: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/custom-fields`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
|
|
1229
1230
|
/**
|
|
1230
1231
|
* No description
|
|
1231
1232
|
*
|
|
@@ -1237,7 +1238,7 @@ export class Api extends HttpClient {
|
|
|
1237
1238
|
* @response `200` `string` Success
|
|
1238
1239
|
* @response `422` `UnprocessableEntity` Client Error
|
|
1239
1240
|
*/
|
|
1240
|
-
updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/consent`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
1241
|
+
updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/consent`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
|
|
1241
1242
|
/**
|
|
1242
1243
|
* No description
|
|
1243
1244
|
*
|
|
@@ -1316,6 +1317,18 @@ export class Api extends HttpClient {
|
|
|
1316
1317
|
* @response `200` `DocumentDataRequest` Success
|
|
1317
1318
|
*/
|
|
1318
1319
|
createLegacyLoanDocument: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/generatedocument`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1320
|
+
/**
|
|
1321
|
+
* No description
|
|
1322
|
+
*
|
|
1323
|
+
* @tags LegacyLoan
|
|
1324
|
+
* @name CreateEditDraftForLoan
|
|
1325
|
+
* @summary Create Edit Draft for Loan
|
|
1326
|
+
* @request PUT:/api/los/loan/{loanID}/edit
|
|
1327
|
+
* @secure
|
|
1328
|
+
* @response `200` `Draft` Success
|
|
1329
|
+
* @response `422` `UnprocessableEntity` Client Error
|
|
1330
|
+
*/
|
|
1331
|
+
createEditDraftForLoan: (loanId, query, params = {}) => this.request(Object.assign({ path: `/api/los/loan/${loanId}/edit`, method: "PUT", query: query, secure: true, format: "json" }, params)),
|
|
1319
1332
|
/**
|
|
1320
1333
|
* No description
|
|
1321
1334
|
*
|
|
@@ -1337,7 +1350,7 @@ export class Api extends HttpClient {
|
|
|
1337
1350
|
* @secure
|
|
1338
1351
|
* @response `200` `ListingFile` Success
|
|
1339
1352
|
*/
|
|
1340
|
-
updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
1353
|
+
updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
|
|
1341
1354
|
/**
|
|
1342
1355
|
* No description
|
|
1343
1356
|
*
|
|
@@ -1370,7 +1383,7 @@ export class Api extends HttpClient {
|
|
|
1370
1383
|
* @secure
|
|
1371
1384
|
* @response `200` `(ListingPhoto)[]` Success
|
|
1372
1385
|
*/
|
|
1373
|
-
updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
1386
|
+
updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
|
|
1374
1387
|
/**
|
|
1375
1388
|
* No description
|
|
1376
1389
|
*
|
|
@@ -2042,7 +2055,7 @@ export class Api extends HttpClient {
|
|
|
2042
2055
|
* @secure
|
|
2043
2056
|
* @response `200` `Loan` Success
|
|
2044
2057
|
*/
|
|
2045
|
-
updateLoan: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
2058
|
+
updateLoan: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
|
|
2046
2059
|
/**
|
|
2047
2060
|
* No description
|
|
2048
2061
|
*
|