@matech/thebigpos-sdk 2.35.1-rc1 → 2.36.0
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 +73 -73
- package/dist/index.d.ts +70 -35
- package/dist/index.js +7 -8
- package/dist/index.js.map +1 -1
- package/docs/sdk_generation.md +149 -0
- package/package.json +39 -39
- package/scripts/apply-json-patch-content-type.js +56 -56
- package/src/index.ts +323 -196
- 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,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
|
@@ -100,7 +100,7 @@ export interface AccountBilling {
|
|
|
100
100
|
contractedRate: number;
|
|
101
101
|
}
|
|
102
102
|
export interface AccountBillingRequest {
|
|
103
|
-
billingType:
|
|
103
|
+
billingType: AccountBillingRequestBillingTypeEnum;
|
|
104
104
|
/**
|
|
105
105
|
* @format double
|
|
106
106
|
* @min 0
|
|
@@ -635,7 +635,7 @@ export interface CorporateSearchCriteria {
|
|
|
635
635
|
isActive?: boolean | null;
|
|
636
636
|
}
|
|
637
637
|
export interface CreateAccessScopeRequest {
|
|
638
|
-
scopeType:
|
|
638
|
+
scopeType: CreateAccessScopeRequestScopeTypeEnum;
|
|
639
639
|
/** @format uuid */
|
|
640
640
|
userId?: string | null;
|
|
641
641
|
/** @format uuid */
|
|
@@ -658,7 +658,7 @@ export interface CreateAccountRequest {
|
|
|
658
658
|
*/
|
|
659
659
|
nlmsid: number;
|
|
660
660
|
settings: AccountSettingsRequest;
|
|
661
|
-
environment:
|
|
661
|
+
environment: CreateAccountRequestEnvironmentEnum;
|
|
662
662
|
losIntegration: LOSIntegration;
|
|
663
663
|
billingSettings: AccountBillingRequest;
|
|
664
664
|
}
|
|
@@ -688,7 +688,7 @@ export interface CreateDocumentTemplateRequest {
|
|
|
688
688
|
export interface CreateGroupMemberRequest {
|
|
689
689
|
/** @format uuid */
|
|
690
690
|
userId: string;
|
|
691
|
-
loanRole:
|
|
691
|
+
loanRole: CreateGroupMemberRequestLoanRoleEnum;
|
|
692
692
|
}
|
|
693
693
|
export interface CreateInviteRequest {
|
|
694
694
|
/** @minLength 1 */
|
|
@@ -699,7 +699,7 @@ export interface CreateInviteRequest {
|
|
|
699
699
|
emailAddress: string;
|
|
700
700
|
phoneNumber?: string | null;
|
|
701
701
|
/** @deprecated */
|
|
702
|
-
relationship:
|
|
702
|
+
relationship: CreateInviteRequestRelationshipEnum;
|
|
703
703
|
loanID: string;
|
|
704
704
|
route?: string | null;
|
|
705
705
|
/** @format uuid */
|
|
@@ -721,7 +721,7 @@ export interface CreateLoanImportRequest {
|
|
|
721
721
|
* @minLength 1
|
|
722
722
|
*/
|
|
723
723
|
startDate: string;
|
|
724
|
-
importMode:
|
|
724
|
+
importMode: CreateLoanImportRequestImportModeEnum;
|
|
725
725
|
}
|
|
726
726
|
export interface CreateSession {
|
|
727
727
|
sessionId: string;
|
|
@@ -739,7 +739,7 @@ export interface CreateUserDeviceRequest {
|
|
|
739
739
|
token: string;
|
|
740
740
|
}
|
|
741
741
|
export interface CreateUserDraft {
|
|
742
|
-
loanRole:
|
|
742
|
+
loanRole: CreateUserDraftLoanRoleEnum;
|
|
743
743
|
}
|
|
744
744
|
export interface CreateUserGroupRequest {
|
|
745
745
|
/**
|
|
@@ -1031,7 +1031,7 @@ export interface Draft {
|
|
|
1031
1031
|
siteConfiguration: SiteConfigurationReduced;
|
|
1032
1032
|
/** @format uuid */
|
|
1033
1033
|
loanID?: string | null;
|
|
1034
|
-
type:
|
|
1034
|
+
type: DraftTypeEnum;
|
|
1035
1035
|
isCoBorrower: boolean;
|
|
1036
1036
|
}
|
|
1037
1037
|
export interface DraftContent {
|
|
@@ -1049,7 +1049,7 @@ export interface DraftContent {
|
|
|
1049
1049
|
siteConfiguration: SiteConfigurationReduced;
|
|
1050
1050
|
/** @format uuid */
|
|
1051
1051
|
loanID?: string | null;
|
|
1052
|
-
type:
|
|
1052
|
+
type: DraftContentTypeEnum;
|
|
1053
1053
|
isCoBorrower: boolean;
|
|
1054
1054
|
applicationPayload: any;
|
|
1055
1055
|
}
|
|
@@ -1346,7 +1346,7 @@ export interface FusionFieldDisplay {
|
|
|
1346
1346
|
fieldValue: string;
|
|
1347
1347
|
}
|
|
1348
1348
|
export interface FusionReportFilter {
|
|
1349
|
-
filterType:
|
|
1349
|
+
filterType: FusionReportFilterFilterTypeEnum;
|
|
1350
1350
|
targetField: string;
|
|
1351
1351
|
targetValue: string;
|
|
1352
1352
|
}
|
|
@@ -1460,7 +1460,7 @@ export interface GuidPatchOperation {
|
|
|
1460
1460
|
from?: string | null;
|
|
1461
1461
|
}
|
|
1462
1462
|
export interface IPAddress {
|
|
1463
|
-
addressFamily:
|
|
1463
|
+
addressFamily: IpAddressAddressFamilyEnum;
|
|
1464
1464
|
/** @format int64 */
|
|
1465
1465
|
scopeId: number;
|
|
1466
1466
|
isIPv6Multicast: boolean;
|
|
@@ -2620,7 +2620,7 @@ export interface LoanContact {
|
|
|
2620
2620
|
email?: string | null;
|
|
2621
2621
|
phone?: string | null;
|
|
2622
2622
|
companyName?: string | null;
|
|
2623
|
-
role:
|
|
2623
|
+
role: LoanContactRoleEnum;
|
|
2624
2624
|
}
|
|
2625
2625
|
export interface LoanContactList {
|
|
2626
2626
|
email: string;
|
|
@@ -2741,13 +2741,13 @@ export interface LoanImport {
|
|
|
2741
2741
|
/** @format int32 */
|
|
2742
2742
|
importedCount: number;
|
|
2743
2743
|
statusMessage?: string | null;
|
|
2744
|
-
status:
|
|
2745
|
-
importMode:
|
|
2744
|
+
status: LoanImportStatusEnum;
|
|
2745
|
+
importMode: LoanImportImportModeEnum;
|
|
2746
2746
|
/** @format date-time */
|
|
2747
2747
|
createdAt?: string | null;
|
|
2748
2748
|
}
|
|
2749
2749
|
export interface LoanImportLog {
|
|
2750
|
-
level:
|
|
2750
|
+
level: LoanImportLogLevelEnum;
|
|
2751
2751
|
message: string;
|
|
2752
2752
|
/** @format date-time */
|
|
2753
2753
|
createdAt: string;
|
|
@@ -2802,8 +2802,8 @@ export interface LoanListPaginated {
|
|
|
2802
2802
|
export interface LoanLog {
|
|
2803
2803
|
/** @format uuid */
|
|
2804
2804
|
id: string;
|
|
2805
|
-
level:
|
|
2806
|
-
type:
|
|
2805
|
+
level: LoanLogLevelEnum;
|
|
2806
|
+
type: LoanLogTypeEnum;
|
|
2807
2807
|
message: string;
|
|
2808
2808
|
/** @format date-time */
|
|
2809
2809
|
createdAt: string;
|
|
@@ -3066,7 +3066,7 @@ export interface LoanUser {
|
|
|
3066
3066
|
email: string;
|
|
3067
3067
|
phone?: string | null;
|
|
3068
3068
|
role: string;
|
|
3069
|
-
loanRole:
|
|
3069
|
+
loanRole: LoanUserLoanRoleEnum;
|
|
3070
3070
|
isUser: boolean;
|
|
3071
3071
|
/** @format date-time */
|
|
3072
3072
|
createdAt: string;
|
|
@@ -3337,7 +3337,7 @@ export interface NotificationTemplateVersionUpdateRequest {
|
|
|
3337
3337
|
}
|
|
3338
3338
|
export interface Operation {
|
|
3339
3339
|
op?: string;
|
|
3340
|
-
value?:
|
|
3340
|
+
value?: object | null;
|
|
3341
3341
|
path?: string;
|
|
3342
3342
|
}
|
|
3343
3343
|
export interface OverridePasswordRequest {
|
|
@@ -3673,7 +3673,7 @@ export interface SSOTokenRequest {
|
|
|
3673
3673
|
redirectUri: string;
|
|
3674
3674
|
}
|
|
3675
3675
|
export interface SamlMetadataRequest {
|
|
3676
|
-
ssoIntegration:
|
|
3676
|
+
ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
|
|
3677
3677
|
}
|
|
3678
3678
|
export interface SendForgotPasswordRequest {
|
|
3679
3679
|
/**
|
|
@@ -3708,7 +3708,7 @@ export interface SiteConfiguration {
|
|
|
3708
3708
|
deletedAt?: string | null;
|
|
3709
3709
|
/** @format uuid */
|
|
3710
3710
|
id: string;
|
|
3711
|
-
type:
|
|
3711
|
+
type: SiteConfigurationTypeEnum;
|
|
3712
3712
|
/** @format uuid */
|
|
3713
3713
|
entityID: string;
|
|
3714
3714
|
/** @format int32 */
|
|
@@ -3902,7 +3902,7 @@ export interface SiteConfigurationByUrl {
|
|
|
3902
3902
|
deletedAt?: string | null;
|
|
3903
3903
|
/** @format uuid */
|
|
3904
3904
|
id: string;
|
|
3905
|
-
type:
|
|
3905
|
+
type: SiteConfigurationByUrlTypeEnum;
|
|
3906
3906
|
/** @format uuid */
|
|
3907
3907
|
entityID: string;
|
|
3908
3908
|
/** @format int32 */
|
|
@@ -4113,7 +4113,7 @@ export interface SiteConfigurationForm {
|
|
|
4113
4113
|
export interface SiteConfigurationReduced {
|
|
4114
4114
|
/** @format uuid */
|
|
4115
4115
|
id: string;
|
|
4116
|
-
type:
|
|
4116
|
+
type: SiteConfigurationReducedTypeEnum;
|
|
4117
4117
|
url?: string | null;
|
|
4118
4118
|
name: string;
|
|
4119
4119
|
/** @format int64 */
|
|
@@ -4130,7 +4130,7 @@ export interface SiteConfigurationRequest {
|
|
|
4130
4130
|
entityID: string;
|
|
4131
4131
|
/** @format int32 */
|
|
4132
4132
|
entityType: number;
|
|
4133
|
-
type:
|
|
4133
|
+
type: SiteConfigurationRequestTypeEnum;
|
|
4134
4134
|
url: string;
|
|
4135
4135
|
name: string;
|
|
4136
4136
|
introduction?: string | null;
|
|
@@ -4305,7 +4305,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
4305
4305
|
export interface SiteConfigurationSummary {
|
|
4306
4306
|
/** @format uuid */
|
|
4307
4307
|
id: string;
|
|
4308
|
-
type:
|
|
4308
|
+
type: SiteConfigurationSummaryTypeEnum;
|
|
4309
4309
|
url?: string | null;
|
|
4310
4310
|
name: string;
|
|
4311
4311
|
/** @format int64 */
|
|
@@ -4882,7 +4882,7 @@ export interface UserDevice {
|
|
|
4882
4882
|
export interface UserDraft {
|
|
4883
4883
|
/** @format uuid */
|
|
4884
4884
|
draftID: string;
|
|
4885
|
-
role:
|
|
4885
|
+
role: UserDraftRoleEnum;
|
|
4886
4886
|
user: User;
|
|
4887
4887
|
}
|
|
4888
4888
|
export interface UserDraftPaginated {
|
|
@@ -4906,7 +4906,7 @@ export interface UserGroupAccessScope {
|
|
|
4906
4906
|
id: string;
|
|
4907
4907
|
/** @format uuid */
|
|
4908
4908
|
groupId: string;
|
|
4909
|
-
scopeType:
|
|
4909
|
+
scopeType: UserGroupAccessScopeScopeTypeEnum;
|
|
4910
4910
|
/** @format uuid */
|
|
4911
4911
|
userId?: string | null;
|
|
4912
4912
|
/** @format uuid */
|
|
@@ -4939,7 +4939,7 @@ export interface UserLoan {
|
|
|
4939
4939
|
deletedAt?: string | null;
|
|
4940
4940
|
loanID: string;
|
|
4941
4941
|
user: User;
|
|
4942
|
-
role:
|
|
4942
|
+
role: UserLoanRoleEnum;
|
|
4943
4943
|
/** @format int32 */
|
|
4944
4944
|
borrowerPair?: number | null;
|
|
4945
4945
|
/** @format int32 */
|
|
@@ -4951,7 +4951,7 @@ export interface UserLoanConsent {
|
|
|
4951
4951
|
id: string;
|
|
4952
4952
|
/** @format uuid */
|
|
4953
4953
|
userLoanID: string;
|
|
4954
|
-
type:
|
|
4954
|
+
type: UserLoanConsentTypeEnum;
|
|
4955
4955
|
providedConsent: boolean;
|
|
4956
4956
|
ipAddress?: string | null;
|
|
4957
4957
|
/** @format date-time */
|
|
@@ -5085,7 +5085,7 @@ export interface UserSummary {
|
|
|
5085
5085
|
id: string;
|
|
5086
5086
|
name?: string | null;
|
|
5087
5087
|
email?: string | null;
|
|
5088
|
-
role:
|
|
5088
|
+
role: UserSummaryRoleEnum;
|
|
5089
5089
|
}
|
|
5090
5090
|
export interface VerifyPasswordRequest {
|
|
5091
5091
|
/**
|
|
@@ -5118,6 +5118,42 @@ export interface Workflow {
|
|
|
5118
5118
|
tileSubtitle: string;
|
|
5119
5119
|
icon: string;
|
|
5120
5120
|
}
|
|
5121
|
+
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
5122
|
+
export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
|
|
5123
|
+
export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
|
|
5124
|
+
export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5125
|
+
/** @deprecated */
|
|
5126
|
+
export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
5127
|
+
export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
5128
|
+
export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5129
|
+
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
5130
|
+
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
5131
|
+
export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
5132
|
+
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";
|
|
5133
|
+
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5134
|
+
export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
5135
|
+
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
5136
|
+
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5137
|
+
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
5138
|
+
export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent";
|
|
5139
|
+
export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5140
|
+
export type SamlMetadataRequestSsoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5141
|
+
export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5142
|
+
export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5143
|
+
export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5144
|
+
export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5145
|
+
export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5146
|
+
export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5147
|
+
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
5148
|
+
export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5149
|
+
export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
5150
|
+
export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
5151
|
+
/** @default "Realtor" */
|
|
5152
|
+
export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
|
|
5153
|
+
export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5154
|
+
export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5155
|
+
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5156
|
+
export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
5121
5157
|
import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
|
|
5122
5158
|
export type QueryParamsType = Record<string | number, any>;
|
|
5123
5159
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
|
|
@@ -5141,7 +5177,6 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
|
|
|
5141
5177
|
format?: ResponseType;
|
|
5142
5178
|
}
|
|
5143
5179
|
export declare enum ContentType {
|
|
5144
|
-
JsonPatch = "application/json-patch+json",
|
|
5145
5180
|
Json = "application/json",
|
|
5146
5181
|
JsonApi = "application/vnd.api+json",
|
|
5147
5182
|
FormData = "multipart/form-data",
|
|
@@ -5163,7 +5198,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
5163
5198
|
}
|
|
5164
5199
|
/**
|
|
5165
5200
|
* @title The Big POS API
|
|
5166
|
-
* @version v2.
|
|
5201
|
+
* @version v2.36.0
|
|
5167
5202
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
5168
5203
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
5169
5204
|
*/
|
|
@@ -7958,7 +7993,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7958
7993
|
getPartners: (query?: {
|
|
7959
7994
|
showAll?: boolean;
|
|
7960
7995
|
/** @default "Realtor" */
|
|
7961
|
-
role?:
|
|
7996
|
+
role?: GetPartnersParamsRoleEnum;
|
|
7962
7997
|
/** @format int32 */
|
|
7963
7998
|
pageSize?: number;
|
|
7964
7999
|
/** @format int32 */
|
|
@@ -8136,7 +8171,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8136
8171
|
* @response `200` `File` Success
|
|
8137
8172
|
* @response `404` `ProblemDetails` Not Found
|
|
8138
8173
|
*/
|
|
8139
|
-
getSamlMetadata: (sSoIntegration:
|
|
8174
|
+
getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
8140
8175
|
/**
|
|
8141
8176
|
* No description
|
|
8142
8177
|
*
|
|
@@ -8147,7 +8182,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8147
8182
|
* @secure
|
|
8148
8183
|
* @response `200` `File` Success
|
|
8149
8184
|
*/
|
|
8150
|
-
createOrReplaceSamlMetadata: (sSoIntegration:
|
|
8185
|
+
createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
8151
8186
|
/**
|
|
8152
8187
|
* No description
|
|
8153
8188
|
*
|
package/dist/index.js
CHANGED
|
@@ -32,7 +32,6 @@ 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";
|
|
36
35
|
ContentType["Json"] = "application/json";
|
|
37
36
|
ContentType["JsonApi"] = "application/vnd.api+json";
|
|
38
37
|
ContentType["FormData"] = "multipart/form-data";
|
|
@@ -104,7 +103,7 @@ export class HttpClient {
|
|
|
104
103
|
}
|
|
105
104
|
/**
|
|
106
105
|
* @title The Big POS API
|
|
107
|
-
* @version v2.
|
|
106
|
+
* @version v2.36.0
|
|
108
107
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
109
108
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
110
109
|
*/
|
|
@@ -1204,7 +1203,7 @@ export class Api extends HttpClient {
|
|
|
1204
1203
|
* @response `200` `string` Success
|
|
1205
1204
|
* @response `422` `UnprocessableEntity` Client Error
|
|
1206
1205
|
*/
|
|
1207
|
-
updateLoanConsentAndCustomFieldsObsolete: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
1206
|
+
updateLoanConsentAndCustomFieldsObsolete: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1208
1207
|
/**
|
|
1209
1208
|
* No description
|
|
1210
1209
|
*
|
|
@@ -1254,7 +1253,7 @@ export class Api extends HttpClient {
|
|
|
1254
1253
|
* @response `200` `string` Success
|
|
1255
1254
|
* @response `422` `UnprocessableEntity` Client Error
|
|
1256
1255
|
*/
|
|
1257
|
-
updateLoanCustomFields: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/custom-fields`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
1256
|
+
updateLoanCustomFields: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/custom-fields`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1258
1257
|
/**
|
|
1259
1258
|
* No description
|
|
1260
1259
|
*
|
|
@@ -1267,7 +1266,7 @@ export class Api extends HttpClient {
|
|
|
1267
1266
|
* @response `202` `string` Accepted
|
|
1268
1267
|
* @response `422` `UnprocessableEntity` Client Error
|
|
1269
1268
|
*/
|
|
1270
|
-
updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/consent`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
1269
|
+
updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/consent`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1271
1270
|
/**
|
|
1272
1271
|
* No description
|
|
1273
1272
|
*
|
|
@@ -1381,7 +1380,7 @@ export class Api extends HttpClient {
|
|
|
1381
1380
|
* @secure
|
|
1382
1381
|
* @response `200` `ListingFile` Success
|
|
1383
1382
|
*/
|
|
1384
|
-
updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
1383
|
+
updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1385
1384
|
/**
|
|
1386
1385
|
* No description
|
|
1387
1386
|
*
|
|
@@ -1414,7 +1413,7 @@ export class Api extends HttpClient {
|
|
|
1414
1413
|
* @secure
|
|
1415
1414
|
* @response `200` `(ListingPhoto)[]` Success
|
|
1416
1415
|
*/
|
|
1417
|
-
updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: ContentType.
|
|
1416
|
+
updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1418
1417
|
/**
|
|
1419
1418
|
* No description
|
|
1420
1419
|
*
|
|
@@ -2143,7 +2142,7 @@ export class Api extends HttpClient {
|
|
|
2143
2142
|
* @response `200` `TaskCommentPaginated` Success
|
|
2144
2143
|
* @response `404` `ProblemDetails` Not Found
|
|
2145
2144
|
*/
|
|
2146
|
-
searchLoanTaskComments: (loanId, userLoanTaskId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.
|
|
2145
|
+
searchLoanTaskComments: (loanId, userLoanTaskId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
2147
2146
|
/**
|
|
2148
2147
|
* No description
|
|
2149
2148
|
*
|