@matech/thebigpos-sdk 2.38.2-rc1 → 2.38.2
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/.claude/settings.local.json +13 -0
- package/.husky/pre-commit +2 -2
- package/LICENSE +21 -21
- package/README.md +73 -73
- package/dist/index.d.ts +46 -93
- package/dist/index.js +5 -5
- package/dist/index.js.map +1 -1
- package/docs/sdk_generation.md +149 -149
- package/package.json +43 -39
- package/scripts/apply-json-patch-content-type.js +56 -56
- package/src/index.ts +245 -405
- package/tsconfig.json +27 -27
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"permissions": {
|
|
3
|
+
"allow": [
|
|
4
|
+
"Bash(npx swagger-typescript-api:*)",
|
|
5
|
+
"Bash(node scripts/apply-json-patch-content-type.js)",
|
|
6
|
+
"Bash(npm version:*)",
|
|
7
|
+
"Bash(npm run:*)",
|
|
8
|
+
"Bash(git commit:*)",
|
|
9
|
+
"Bash(git push:*)",
|
|
10
|
+
"Bash(npm publish:*)"
|
|
11
|
+
]
|
|
12
|
+
}
|
|
13
|
+
}
|
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,73 +1,73 @@
|
|
|
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
|
-
## Generate SDK from Swagger
|
|
44
|
-
|
|
45
|
-
To regenerate the SDK from a specific API version, run:
|
|
46
|
-
|
|
47
|
-
```bash
|
|
48
|
-
npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/{version}/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --generate-union-enums
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
Replace `{version}` with the target API version (e.g. `v2.34.0`):
|
|
52
|
-
|
|
53
|
-
```bash
|
|
54
|
-
npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/v2.34.0/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --generate-union-enums
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
## Publishing
|
|
58
|
-
|
|
59
|
-
1. Update the `version` field in `package.json` before publishing.
|
|
60
|
-
2. Build the project:
|
|
61
|
-
|
|
62
|
-
```bash
|
|
63
|
-
yarn build
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
3. Publish to npm:
|
|
67
|
-
|
|
68
|
-
```bash
|
|
69
|
-
yarn publish
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
____
|
|
73
|
-
© 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
|
+
## Generate SDK from Swagger
|
|
44
|
+
|
|
45
|
+
To regenerate the SDK from a specific API version, run:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/{version}/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --generate-union-enums
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Replace `{version}` with the target API version (e.g. `v2.34.0`):
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/v2.34.0/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --generate-union-enums
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Publishing
|
|
58
|
+
|
|
59
|
+
1. Update the `version` field in `package.json` before publishing.
|
|
60
|
+
2. Build the project:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
yarn build
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
3. Publish to npm:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
yarn publish
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
____
|
|
73
|
+
© 2024 Mortgage Automation Technologies. All rights reserved
|
package/dist/index.d.ts
CHANGED
|
@@ -110,7 +110,7 @@ export interface AccountBilling {
|
|
|
110
110
|
contractedRate: number;
|
|
111
111
|
}
|
|
112
112
|
export interface AccountBillingRequest {
|
|
113
|
-
billingType:
|
|
113
|
+
billingType: "ClosedLoan" | "LoanOfficer";
|
|
114
114
|
/**
|
|
115
115
|
* @format double
|
|
116
116
|
* @min 0
|
|
@@ -430,7 +430,7 @@ export interface AuditLogEntry {
|
|
|
430
430
|
/** @format uuid */
|
|
431
431
|
id: string;
|
|
432
432
|
entityType: string;
|
|
433
|
-
changeType:
|
|
433
|
+
changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored";
|
|
434
434
|
/** @format uuid */
|
|
435
435
|
entityId: string;
|
|
436
436
|
performedBy?: AuditLogUser | null;
|
|
@@ -656,7 +656,7 @@ export interface ConsumerConnectStatus {
|
|
|
656
656
|
/** @format uuid */
|
|
657
657
|
userId: string;
|
|
658
658
|
email: string;
|
|
659
|
-
role:
|
|
659
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
660
660
|
status?: ConsumerConnectAssociationStatus | null;
|
|
661
661
|
/** @format int32 */
|
|
662
662
|
attemptCount: number;
|
|
@@ -713,7 +713,7 @@ export interface CorporateSearchCriteria {
|
|
|
713
713
|
isActive?: boolean | null;
|
|
714
714
|
}
|
|
715
715
|
export interface CreateAccessScopeRequest {
|
|
716
|
-
scopeType:
|
|
716
|
+
scopeType: "User" | "Branch";
|
|
717
717
|
/** @format uuid */
|
|
718
718
|
userId?: string | null;
|
|
719
719
|
/** @format uuid */
|
|
@@ -736,7 +736,7 @@ export interface CreateAccountRequest {
|
|
|
736
736
|
*/
|
|
737
737
|
nlmsid: number;
|
|
738
738
|
settings: AccountSettingsRequest;
|
|
739
|
-
environment:
|
|
739
|
+
environment: "Development" | "Staging" | "UAT" | "Production";
|
|
740
740
|
losIntegration: LOSIntegration;
|
|
741
741
|
billingSettings: AccountBillingRequest;
|
|
742
742
|
}
|
|
@@ -766,7 +766,7 @@ export interface CreateDocumentTemplateRequest {
|
|
|
766
766
|
export interface CreateGroupMemberRequest {
|
|
767
767
|
/** @format uuid */
|
|
768
768
|
userId: string;
|
|
769
|
-
loanRole:
|
|
769
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
770
770
|
}
|
|
771
771
|
export interface CreateInviteRequest {
|
|
772
772
|
/** @minLength 1 */
|
|
@@ -777,7 +777,7 @@ export interface CreateInviteRequest {
|
|
|
777
777
|
emailAddress: string;
|
|
778
778
|
phoneNumber?: string | null;
|
|
779
779
|
/** @deprecated */
|
|
780
|
-
relationship:
|
|
780
|
+
relationship: "NotApplicable" | "Spouse" | "NonSpouse";
|
|
781
781
|
loanID: string;
|
|
782
782
|
route?: string | null;
|
|
783
783
|
/** @format uuid */
|
|
@@ -799,7 +799,7 @@ export interface CreateLoanImportRequest {
|
|
|
799
799
|
* @minLength 1
|
|
800
800
|
*/
|
|
801
801
|
startDate: string;
|
|
802
|
-
importMode:
|
|
802
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
803
803
|
}
|
|
804
804
|
export interface CreateSession {
|
|
805
805
|
sessionId: string;
|
|
@@ -817,7 +817,7 @@ export interface CreateUserDeviceRequest {
|
|
|
817
817
|
token: string;
|
|
818
818
|
}
|
|
819
819
|
export interface CreateUserDraft {
|
|
820
|
-
loanRole:
|
|
820
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
821
821
|
}
|
|
822
822
|
export interface CreateUserGroupRequest {
|
|
823
823
|
/**
|
|
@@ -1114,7 +1114,7 @@ export interface Draft {
|
|
|
1114
1114
|
siteConfiguration: SiteConfigurationReduced;
|
|
1115
1115
|
/** @format uuid */
|
|
1116
1116
|
loanID?: string | null;
|
|
1117
|
-
type:
|
|
1117
|
+
type: "NewLoan" | "EditLoan";
|
|
1118
1118
|
isCoBorrower: boolean;
|
|
1119
1119
|
}
|
|
1120
1120
|
export interface DraftContent {
|
|
@@ -1132,7 +1132,7 @@ export interface DraftContent {
|
|
|
1132
1132
|
siteConfiguration: SiteConfigurationReduced;
|
|
1133
1133
|
/** @format uuid */
|
|
1134
1134
|
loanID?: string | null;
|
|
1135
|
-
type:
|
|
1135
|
+
type: "NewLoan" | "EditLoan";
|
|
1136
1136
|
isCoBorrower: boolean;
|
|
1137
1137
|
applicationPayload: any;
|
|
1138
1138
|
}
|
|
@@ -1223,7 +1223,7 @@ export interface EncompassCredentialsDetail {
|
|
|
1223
1223
|
defaultLoanOfficerUserName?: string | null;
|
|
1224
1224
|
clearStateIfUnlicensed: boolean;
|
|
1225
1225
|
baseUrl?: string | null;
|
|
1226
|
-
signingMethod:
|
|
1226
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1227
1227
|
subscriptionId?: string | null;
|
|
1228
1228
|
environment?: string | null;
|
|
1229
1229
|
}
|
|
@@ -1238,7 +1238,7 @@ export interface EncompassCredentialsRequest {
|
|
|
1238
1238
|
defaultLoanOfficerUserName?: string | null;
|
|
1239
1239
|
clearStateIfUnlicensed: boolean;
|
|
1240
1240
|
baseUrl?: string | null;
|
|
1241
|
-
signingMethod:
|
|
1241
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1242
1242
|
subscriptionId?: string | null;
|
|
1243
1243
|
environment?: string | null;
|
|
1244
1244
|
clientID?: string | null;
|
|
@@ -1296,8 +1296,8 @@ export interface EncompassRequestLog {
|
|
|
1296
1296
|
losId?: string | null;
|
|
1297
1297
|
/** @format uuid */
|
|
1298
1298
|
accountId: string;
|
|
1299
|
-
operationType:
|
|
1300
|
-
outcome:
|
|
1299
|
+
operationType: "FieldUpdate" | "EConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
|
|
1300
|
+
outcome: "Success" | "Failure" | "PartialSuccess";
|
|
1301
1301
|
message: string;
|
|
1302
1302
|
endpoint?: string | null;
|
|
1303
1303
|
httpMethod?: string | null;
|
|
@@ -1348,7 +1348,7 @@ export interface FileSearchCriteria {
|
|
|
1348
1348
|
export interface FileWithBytes {
|
|
1349
1349
|
name: string;
|
|
1350
1350
|
/** @format byte */
|
|
1351
|
-
data:
|
|
1351
|
+
data: string;
|
|
1352
1352
|
fileName: string;
|
|
1353
1353
|
mimeType?: string | null;
|
|
1354
1354
|
extension?: string | null;
|
|
@@ -1514,7 +1514,7 @@ export interface FusionFieldDisplay {
|
|
|
1514
1514
|
fieldValue: string;
|
|
1515
1515
|
}
|
|
1516
1516
|
export interface FusionReportFilter {
|
|
1517
|
-
filterType:
|
|
1517
|
+
filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
1518
1518
|
targetField: string;
|
|
1519
1519
|
targetValue: string;
|
|
1520
1520
|
}
|
|
@@ -1628,7 +1628,7 @@ export interface GuidPatchOperation {
|
|
|
1628
1628
|
from?: string | null;
|
|
1629
1629
|
}
|
|
1630
1630
|
export interface IPAddress {
|
|
1631
|
-
addressFamily:
|
|
1631
|
+
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";
|
|
1632
1632
|
/** @format int64 */
|
|
1633
1633
|
scopeId: number;
|
|
1634
1634
|
isIPv6Multicast: boolean;
|
|
@@ -1881,7 +1881,7 @@ export interface Loan {
|
|
|
1881
1881
|
nonOwningBorrowers: LoanNonOwningBorrower[];
|
|
1882
1882
|
userLoans: UserLoan[];
|
|
1883
1883
|
contacts: LoanContact[];
|
|
1884
|
-
signingMethod:
|
|
1884
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1885
1885
|
}
|
|
1886
1886
|
export interface LoanApplication {
|
|
1887
1887
|
/** @format uuid */
|
|
@@ -1936,7 +1936,7 @@ export interface LoanBorrower {
|
|
|
1936
1936
|
citizenship?: LoanCitizenship | null;
|
|
1937
1937
|
maritalStatus?: LoanMaritalStatus | null;
|
|
1938
1938
|
languagePreference?: LoanLanguagePreference | null;
|
|
1939
|
-
applicationStatus:
|
|
1939
|
+
applicationStatus: "Draft" | "Complete";
|
|
1940
1940
|
/** @format int32 */
|
|
1941
1941
|
numberOfDependents?: number | null;
|
|
1942
1942
|
isPrimaryBorrower: boolean;
|
|
@@ -2793,7 +2793,7 @@ export interface LoanContact {
|
|
|
2793
2793
|
email?: string | null;
|
|
2794
2794
|
phone?: string | null;
|
|
2795
2795
|
companyName?: string | null;
|
|
2796
|
-
role:
|
|
2796
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
2797
2797
|
}
|
|
2798
2798
|
export interface LoanContactList {
|
|
2799
2799
|
email: string;
|
|
@@ -2919,13 +2919,13 @@ export interface LoanImport {
|
|
|
2919
2919
|
/** @format int32 */
|
|
2920
2920
|
importedCount: number;
|
|
2921
2921
|
statusMessage?: string | null;
|
|
2922
|
-
status:
|
|
2923
|
-
importMode:
|
|
2922
|
+
status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
2923
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
2924
2924
|
/** @format date-time */
|
|
2925
2925
|
createdAt?: string | null;
|
|
2926
2926
|
}
|
|
2927
2927
|
export interface LoanImportLog {
|
|
2928
|
-
level:
|
|
2928
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
2929
2929
|
message: string;
|
|
2930
2930
|
/** @format date-time */
|
|
2931
2931
|
createdAt: string;
|
|
@@ -2980,8 +2980,8 @@ export interface LoanListPaginated {
|
|
|
2980
2980
|
export interface LoanLog {
|
|
2981
2981
|
/** @format uuid */
|
|
2982
2982
|
id: string;
|
|
2983
|
-
level:
|
|
2984
|
-
type:
|
|
2983
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
2984
|
+
type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation";
|
|
2985
2985
|
message: string;
|
|
2986
2986
|
/** @format date-time */
|
|
2987
2987
|
createdAt: string;
|
|
@@ -2989,8 +2989,8 @@ export interface LoanLog {
|
|
|
2989
2989
|
export interface LoanLogDetail {
|
|
2990
2990
|
/** @format uuid */
|
|
2991
2991
|
id: string;
|
|
2992
|
-
level:
|
|
2993
|
-
type:
|
|
2992
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
2993
|
+
type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation";
|
|
2994
2994
|
message: string;
|
|
2995
2995
|
/** @format date-time */
|
|
2996
2996
|
createdAt: string;
|
|
@@ -3263,7 +3263,7 @@ export interface LoanUser {
|
|
|
3263
3263
|
email: string;
|
|
3264
3264
|
phone?: string | null;
|
|
3265
3265
|
role: string;
|
|
3266
|
-
loanRole:
|
|
3266
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3267
3267
|
isUser: boolean;
|
|
3268
3268
|
/** @format date-time */
|
|
3269
3269
|
createdAt: string;
|
|
@@ -3901,7 +3901,7 @@ export interface SSOTokenRequest {
|
|
|
3901
3901
|
redirectUri: string;
|
|
3902
3902
|
}
|
|
3903
3903
|
export interface SamlMetadataRequest {
|
|
3904
|
-
ssoIntegration:
|
|
3904
|
+
ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
3905
3905
|
}
|
|
3906
3906
|
export interface SendForgotPasswordRequest {
|
|
3907
3907
|
/**
|
|
@@ -3936,7 +3936,7 @@ export interface SiteConfiguration {
|
|
|
3936
3936
|
deletedAt?: string | null;
|
|
3937
3937
|
/** @format uuid */
|
|
3938
3938
|
id: string;
|
|
3939
|
-
type:
|
|
3939
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3940
3940
|
/** @format uuid */
|
|
3941
3941
|
entityID: string;
|
|
3942
3942
|
/** @format int32 */
|
|
@@ -4130,7 +4130,7 @@ export interface SiteConfigurationByUrl {
|
|
|
4130
4130
|
deletedAt?: string | null;
|
|
4131
4131
|
/** @format uuid */
|
|
4132
4132
|
id: string;
|
|
4133
|
-
type:
|
|
4133
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4134
4134
|
/** @format uuid */
|
|
4135
4135
|
entityID: string;
|
|
4136
4136
|
/** @format int32 */
|
|
@@ -4341,7 +4341,7 @@ export interface SiteConfigurationForm {
|
|
|
4341
4341
|
export interface SiteConfigurationReduced {
|
|
4342
4342
|
/** @format uuid */
|
|
4343
4343
|
id: string;
|
|
4344
|
-
type:
|
|
4344
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4345
4345
|
url?: string | null;
|
|
4346
4346
|
name: string;
|
|
4347
4347
|
/** @format int64 */
|
|
@@ -4358,7 +4358,7 @@ export interface SiteConfigurationRequest {
|
|
|
4358
4358
|
entityID: string;
|
|
4359
4359
|
/** @format int32 */
|
|
4360
4360
|
entityType: number;
|
|
4361
|
-
type:
|
|
4361
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4362
4362
|
url: string;
|
|
4363
4363
|
name: string;
|
|
4364
4364
|
introduction?: string | null;
|
|
@@ -4533,7 +4533,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
4533
4533
|
export interface SiteConfigurationSummary {
|
|
4534
4534
|
/** @format uuid */
|
|
4535
4535
|
id: string;
|
|
4536
|
-
type:
|
|
4536
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4537
4537
|
url?: string | null;
|
|
4538
4538
|
name: string;
|
|
4539
4539
|
/** @format int64 */
|
|
@@ -5112,7 +5112,7 @@ export interface UserDevice {
|
|
|
5112
5112
|
export interface UserDraft {
|
|
5113
5113
|
/** @format uuid */
|
|
5114
5114
|
draftID: string;
|
|
5115
|
-
role:
|
|
5115
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5116
5116
|
user: User;
|
|
5117
5117
|
}
|
|
5118
5118
|
export interface UserDraftPaginated {
|
|
@@ -5136,7 +5136,7 @@ export interface UserGroupAccessScope {
|
|
|
5136
5136
|
id: string;
|
|
5137
5137
|
/** @format uuid */
|
|
5138
5138
|
groupId: string;
|
|
5139
|
-
scopeType:
|
|
5139
|
+
scopeType: "User" | "Branch";
|
|
5140
5140
|
/** @format uuid */
|
|
5141
5141
|
userId?: string | null;
|
|
5142
5142
|
/** @format uuid */
|
|
@@ -5169,7 +5169,7 @@ export interface UserLoan {
|
|
|
5169
5169
|
deletedAt?: string | null;
|
|
5170
5170
|
loanID: string;
|
|
5171
5171
|
user: User;
|
|
5172
|
-
role:
|
|
5172
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5173
5173
|
/** @format int32 */
|
|
5174
5174
|
borrowerPair?: number | null;
|
|
5175
5175
|
/** @format int32 */
|
|
@@ -5181,10 +5181,10 @@ export interface UserLoanConsent {
|
|
|
5181
5181
|
id: string;
|
|
5182
5182
|
/** @format uuid */
|
|
5183
5183
|
userLoanID: string;
|
|
5184
|
-
type:
|
|
5184
|
+
type: "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
5185
5185
|
providedConsent: boolean;
|
|
5186
5186
|
ipAddress?: string | null;
|
|
5187
|
-
losSyncStatus:
|
|
5187
|
+
losSyncStatus: "NotStarted" | "Failed" | "Success";
|
|
5188
5188
|
/** @format date-time */
|
|
5189
5189
|
createdAt: string;
|
|
5190
5190
|
}
|
|
@@ -5321,7 +5321,7 @@ export interface UserSummary {
|
|
|
5321
5321
|
id: string;
|
|
5322
5322
|
name?: string | null;
|
|
5323
5323
|
email?: string | null;
|
|
5324
|
-
role:
|
|
5324
|
+
role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5325
5325
|
}
|
|
5326
5326
|
export interface VerifyPasswordRequest {
|
|
5327
5327
|
/**
|
|
@@ -5354,53 +5354,6 @@ export interface Workflow {
|
|
|
5354
5354
|
tileSubtitle: string;
|
|
5355
5355
|
icon: string;
|
|
5356
5356
|
}
|
|
5357
|
-
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
5358
|
-
export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored";
|
|
5359
|
-
export type ConsumerConnectStatusRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5360
|
-
export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
|
|
5361
|
-
export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
|
|
5362
|
-
export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5363
|
-
/** @deprecated */
|
|
5364
|
-
export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
5365
|
-
export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
5366
|
-
export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5367
|
-
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
5368
|
-
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
5369
|
-
export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
5370
|
-
export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
5371
|
-
export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "EConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
|
|
5372
|
-
export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
|
|
5373
|
-
export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
5374
|
-
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";
|
|
5375
|
-
export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
5376
|
-
export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
5377
|
-
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5378
|
-
export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
5379
|
-
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
5380
|
-
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5381
|
-
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5382
|
-
export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation";
|
|
5383
|
-
export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5384
|
-
export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation";
|
|
5385
|
-
export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5386
|
-
export type SamlMetadataRequestSsoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5387
|
-
export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5388
|
-
export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5389
|
-
export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5390
|
-
export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5391
|
-
export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5392
|
-
export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5393
|
-
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
5394
|
-
export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5395
|
-
export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
5396
|
-
export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
|
|
5397
|
-
export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5398
|
-
/** @default "Realtor" */
|
|
5399
|
-
export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
5400
|
-
export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5401
|
-
export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5402
|
-
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5403
|
-
export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5404
5357
|
import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
|
|
5405
5358
|
export type QueryParamsType = Record<string | number, any>;
|
|
5406
5359
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
|
|
@@ -7260,10 +7213,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7260
7213
|
* @summary Download By ID
|
|
7261
7214
|
* @request GET:/api/loans/{loanId}/documents/{documentId}/download
|
|
7262
7215
|
* @secure
|
|
7263
|
-
* @response `200` `
|
|
7216
|
+
* @response `200` `string` Success
|
|
7264
7217
|
* @response `404` `ProblemDetails` Not Found
|
|
7265
7218
|
*/
|
|
7266
|
-
downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<
|
|
7219
|
+
downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any>>;
|
|
7267
7220
|
/**
|
|
7268
7221
|
* No description
|
|
7269
7222
|
*
|
|
@@ -8378,7 +8331,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8378
8331
|
getPartners: (query?: {
|
|
8379
8332
|
showAll?: boolean;
|
|
8380
8333
|
/** @default "Realtor" */
|
|
8381
|
-
role?:
|
|
8334
|
+
role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
8382
8335
|
/** @format int32 */
|
|
8383
8336
|
pageSize?: number;
|
|
8384
8337
|
/** @format int32 */
|
|
@@ -8556,7 +8509,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8556
8509
|
* @response `200` `File` Success
|
|
8557
8510
|
* @response `404` `ProblemDetails` Not Found
|
|
8558
8511
|
*/
|
|
8559
|
-
getSamlMetadata: (sSoIntegration:
|
|
8512
|
+
getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
|
|
8560
8513
|
/**
|
|
8561
8514
|
* No description
|
|
8562
8515
|
*
|
|
@@ -8567,7 +8520,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8567
8520
|
* @secure
|
|
8568
8521
|
* @response `200` `File` Success
|
|
8569
8522
|
*/
|
|
8570
|
-
createOrReplaceSamlMetadata: (sSoIntegration:
|
|
8523
|
+
createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
|
|
8571
8524
|
/**
|
|
8572
8525
|
* No description
|
|
8573
8526
|
*
|