@matech/thebigpos-sdk 3.14.0 → 3.15.0-pr-5537-5972
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/README.md +39 -0
- package/dist/index.d.ts +157 -22
- package/dist/index.js +69 -13
- package/dist/index.js.map +1 -1
- package/docs/sdk_generation.md +149 -0
- package/package.json +16 -6
- package/scripts/apply-json-patch-content-type.js +189 -36
- package/src/index.ts +231 -37
package/README.md
CHANGED
|
@@ -40,5 +40,44 @@ apiClient.api.getSiteConfiguration().then((response) => {
|
|
|
40
40
|
});
|
|
41
41
|
```
|
|
42
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 --enum-style union
|
|
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 --enum-style union
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Then apply the PATCH content-type fixup, passing the **same** spec that was given
|
|
58
|
+
to the generator. The generator does not propagate `application/json-patch+json`,
|
|
59
|
+
so this step sets each PATCH method's content type from the spec (no hard-coded
|
|
60
|
+
endpoint list):
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
node scripts/apply-json-patch-content-type.js https://api.thebigpos.dev/swagger/v2.34.0/swagger.json
|
|
64
|
+
yarn build
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Publishing
|
|
68
|
+
|
|
69
|
+
1. Update the `version` field in `package.json` before publishing.
|
|
70
|
+
2. Build the project:
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
yarn build
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
3. Publish to npm:
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
yarn publish
|
|
80
|
+
```
|
|
81
|
+
|
|
43
82
|
____
|
|
44
83
|
© 2024 Mortgage Automation Technologies. All rights reserved
|
package/dist/index.d.ts
CHANGED
|
@@ -67,6 +67,7 @@ export type LoanAccountAssetType = "Checking" | "Savings" | "MoneyMarket" | "Cer
|
|
|
67
67
|
export type LoanAccessScopeType = "User" | "Branch";
|
|
68
68
|
export type LinkTarget = "Self" | "Blank";
|
|
69
69
|
export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Failed" | "FailedPermanently" | "Uploaded" | "PendingSync";
|
|
70
|
+
export type IncompleteLoanSource = "V3" | "LegacyDraft";
|
|
70
71
|
export type Environment = "Development" | "Staging" | "UAT" | "Production";
|
|
71
72
|
export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
|
|
72
73
|
export type EncompassWebhookType = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
|
|
@@ -77,6 +78,7 @@ export type DraftType = "NewLoan" | "EditLoan";
|
|
|
77
78
|
export type DocumentVisibilityScope = "Own" | "All";
|
|
78
79
|
export type CustomFieldEntityType = "Loan";
|
|
79
80
|
export type CustomFieldDataType = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
81
|
+
export type CustomFieldAnswerWarningReason = "Unresolved" | "Inactive" | "ReadOnly" | "DuplicateDefinition";
|
|
80
82
|
export type CustomFieldAccessLevel = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
81
83
|
export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
82
84
|
export type ConsentSource = "TheBigPOS" | "ConsumerConnect";
|
|
@@ -128,6 +130,16 @@ export interface ASOSettings {
|
|
|
128
130
|
mimgic: boolean;
|
|
129
131
|
miArch: boolean;
|
|
130
132
|
}
|
|
133
|
+
export interface AcceptBorrowerInviteRequest {
|
|
134
|
+
/** @format uuid */
|
|
135
|
+
inviteCode: string;
|
|
136
|
+
}
|
|
137
|
+
export interface AcceptedBorrowerInvite {
|
|
138
|
+
/** @format uuid */
|
|
139
|
+
loanId: string;
|
|
140
|
+
/** @format uuid */
|
|
141
|
+
borrowerId: string;
|
|
142
|
+
}
|
|
131
143
|
export interface Account {
|
|
132
144
|
/** @format uuid */
|
|
133
145
|
id: string;
|
|
@@ -410,7 +422,7 @@ export interface AiAuditLog {
|
|
|
410
422
|
guardrailCategory?: string | null;
|
|
411
423
|
rawRequest?: string | null;
|
|
412
424
|
rawResponse?: string | null;
|
|
413
|
-
details
|
|
425
|
+
details: any;
|
|
414
426
|
/** @format date-time */
|
|
415
427
|
createdAt: string;
|
|
416
428
|
}
|
|
@@ -954,7 +966,7 @@ export interface AuditLogEntry {
|
|
|
954
966
|
rootEntityType?: string | null;
|
|
955
967
|
/** @format uuid */
|
|
956
968
|
rootEntityId?: string | null;
|
|
957
|
-
changes
|
|
969
|
+
changes: any;
|
|
958
970
|
/** @format date-time */
|
|
959
971
|
createdAt: string;
|
|
960
972
|
}
|
|
@@ -1527,6 +1539,10 @@ export interface CreditAuthPendingSummary {
|
|
|
1527
1539
|
total: number;
|
|
1528
1540
|
borrowers: BorrowerIdentity[];
|
|
1529
1541
|
}
|
|
1542
|
+
export interface CustomFieldAnswerWarning {
|
|
1543
|
+
key: string;
|
|
1544
|
+
reason: CustomFieldAnswerWarningReasonEnum;
|
|
1545
|
+
}
|
|
1530
1546
|
export interface CustomFieldDefinition {
|
|
1531
1547
|
/** @format date-time */
|
|
1532
1548
|
createdAt: string;
|
|
@@ -1802,7 +1818,7 @@ export interface DraftLoanOfficerReassignRequest {
|
|
|
1802
1818
|
}
|
|
1803
1819
|
export interface DraftRequest {
|
|
1804
1820
|
applicationPayload: any;
|
|
1805
|
-
customData
|
|
1821
|
+
customData: any;
|
|
1806
1822
|
isCoBorrower: boolean;
|
|
1807
1823
|
}
|
|
1808
1824
|
export interface EconsentPendingSummary {
|
|
@@ -2027,7 +2043,7 @@ export interface EncompassRequestLog {
|
|
|
2027
2043
|
httpStatusCode?: number | null;
|
|
2028
2044
|
/** @format int64 */
|
|
2029
2045
|
durationMs?: number | null;
|
|
2030
|
-
context
|
|
2046
|
+
context: any;
|
|
2031
2047
|
/** @format date-time */
|
|
2032
2048
|
createdAt: string;
|
|
2033
2049
|
}
|
|
@@ -2156,7 +2172,7 @@ export interface FormSubmission {
|
|
|
2156
2172
|
subjectPropertyAddressCounty?: string | null;
|
|
2157
2173
|
subjectPropertyAddressState?: string | null;
|
|
2158
2174
|
subjectPropertyAddressZip?: string | null;
|
|
2159
|
-
data
|
|
2175
|
+
data: any;
|
|
2160
2176
|
/** @format uuid */
|
|
2161
2177
|
listingID?: string | null;
|
|
2162
2178
|
listing?: Listing | null;
|
|
@@ -2198,7 +2214,7 @@ export interface FormSubmissionRequest {
|
|
|
2198
2214
|
subjectPropertyAddressCounty?: string | null;
|
|
2199
2215
|
subjectPropertyAddressState?: string | null;
|
|
2200
2216
|
subjectPropertyAddressZip?: string | null;
|
|
2201
|
-
data
|
|
2217
|
+
data: any;
|
|
2202
2218
|
/** @format uuid */
|
|
2203
2219
|
listingID?: string | null;
|
|
2204
2220
|
}
|
|
@@ -2330,7 +2346,7 @@ export interface GetWorkflowRequest {
|
|
|
2330
2346
|
export interface GuidPatchOperation {
|
|
2331
2347
|
op: string;
|
|
2332
2348
|
path: string;
|
|
2333
|
-
value
|
|
2349
|
+
value: any;
|
|
2334
2350
|
from?: string | null;
|
|
2335
2351
|
}
|
|
2336
2352
|
export interface HttpError {
|
|
@@ -2409,6 +2425,62 @@ export interface IncompleteApplicationSummary {
|
|
|
2409
2425
|
total: number;
|
|
2410
2426
|
borrowers: BorrowerIdentity[];
|
|
2411
2427
|
}
|
|
2428
|
+
export interface IncompleteLoan {
|
|
2429
|
+
source: IncompleteLoanSourceEnum;
|
|
2430
|
+
/** @format uuid */
|
|
2431
|
+
loanId?: string | null;
|
|
2432
|
+
/** @format uuid */
|
|
2433
|
+
borrowerId?: string | null;
|
|
2434
|
+
/** @format uuid */
|
|
2435
|
+
draftId?: string | null;
|
|
2436
|
+
/** @format date-time */
|
|
2437
|
+
createdAt: string;
|
|
2438
|
+
/** @format date-time */
|
|
2439
|
+
updatedAt?: string | null;
|
|
2440
|
+
loanOfficer?: UserSummary | null;
|
|
2441
|
+
siteConfiguration?: IncompleteLoanSiteConfiguration | null;
|
|
2442
|
+
draft?: IncompleteLoanDraft | null;
|
|
2443
|
+
borrowers: IncompleteLoanBorrower[];
|
|
2444
|
+
}
|
|
2445
|
+
export interface IncompleteLoanBorrower {
|
|
2446
|
+
/** @format uuid */
|
|
2447
|
+
id: string;
|
|
2448
|
+
firstName?: string | null;
|
|
2449
|
+
lastName?: string | null;
|
|
2450
|
+
email?: string | null;
|
|
2451
|
+
isPrimaryBorrower: boolean;
|
|
2452
|
+
applicationStatus: IncompleteLoanBorrowerApplicationStatusEnum;
|
|
2453
|
+
/** @format date-time */
|
|
2454
|
+
deletedAt?: string | null;
|
|
2455
|
+
}
|
|
2456
|
+
export interface IncompleteLoanDraft {
|
|
2457
|
+
/** @format uuid */
|
|
2458
|
+
loanID?: string | null;
|
|
2459
|
+
/** @format date-time */
|
|
2460
|
+
deletedAt?: string | null;
|
|
2461
|
+
routeName?: string | null;
|
|
2462
|
+
user: UserBase;
|
|
2463
|
+
}
|
|
2464
|
+
export interface IncompleteLoanPaginated {
|
|
2465
|
+
rows: IncompleteLoan[];
|
|
2466
|
+
pagination: Pagination;
|
|
2467
|
+
/** @format int64 */
|
|
2468
|
+
count: number;
|
|
2469
|
+
}
|
|
2470
|
+
export interface IncompleteLoanSearchCriteria {
|
|
2471
|
+
searchText?: string | null;
|
|
2472
|
+
/** @format uuid */
|
|
2473
|
+
loanOfficerId?: string | null;
|
|
2474
|
+
/** @format uuid */
|
|
2475
|
+
siteConfigurationId?: string | null;
|
|
2476
|
+
isUnassigned?: boolean | null;
|
|
2477
|
+
includeRemovedApplications?: boolean | null;
|
|
2478
|
+
}
|
|
2479
|
+
export interface IncompleteLoanSiteConfiguration {
|
|
2480
|
+
/** @format uuid */
|
|
2481
|
+
id: string;
|
|
2482
|
+
name: string;
|
|
2483
|
+
}
|
|
2412
2484
|
export interface IntegrationSettings {
|
|
2413
2485
|
encompass?: EncompassIntegrationSettings | null;
|
|
2414
2486
|
}
|
|
@@ -2439,6 +2511,7 @@ export interface Invite {
|
|
|
2439
2511
|
status: string;
|
|
2440
2512
|
loan: LoanIdentifier;
|
|
2441
2513
|
url: string;
|
|
2514
|
+
linksBorrowerApplication?: boolean | null;
|
|
2442
2515
|
}
|
|
2443
2516
|
/** Array of operations to perform */
|
|
2444
2517
|
export type JsonPatchDocument = Operation[];
|
|
@@ -2634,6 +2707,7 @@ export interface LoanApplication {
|
|
|
2634
2707
|
refinance?: LoanRefinance | null;
|
|
2635
2708
|
borrowers: LoanBorrower[];
|
|
2636
2709
|
nonOwningBorrowers: LoanNonOwningBorrower[];
|
|
2710
|
+
customFieldWarnings?: CustomFieldAnswerWarning[] | null;
|
|
2637
2711
|
}
|
|
2638
2712
|
export interface LoanApplicationRequest {
|
|
2639
2713
|
/** @format uuid */
|
|
@@ -4065,7 +4139,7 @@ export interface LoanQueueWithData {
|
|
|
4065
4139
|
user: UserPublic;
|
|
4066
4140
|
loanOfficer: LoanOfficerPublic;
|
|
4067
4141
|
siteConfiguration: SiteConfigurationReduced;
|
|
4068
|
-
data
|
|
4142
|
+
data: any;
|
|
4069
4143
|
}
|
|
4070
4144
|
export interface LoanRecommendation {
|
|
4071
4145
|
/** @format uuid */
|
|
@@ -4074,7 +4148,7 @@ export interface LoanRecommendation {
|
|
|
4074
4148
|
displayName: string;
|
|
4075
4149
|
extractedValue: string;
|
|
4076
4150
|
mintable: boolean;
|
|
4077
|
-
currentLoanValue
|
|
4151
|
+
currentLoanValue: any;
|
|
4078
4152
|
/** @format uuid */
|
|
4079
4153
|
sourceDocumentId: string;
|
|
4080
4154
|
sourceDocumentName?: string | null;
|
|
@@ -4603,7 +4677,7 @@ export interface ModuleParameterValue {
|
|
|
4603
4677
|
parameterID: string;
|
|
4604
4678
|
parameterName: string;
|
|
4605
4679
|
parameterType: string;
|
|
4606
|
-
value
|
|
4680
|
+
value: any;
|
|
4607
4681
|
isInherited: boolean;
|
|
4608
4682
|
}
|
|
4609
4683
|
export interface MonthlyPaymentCalculator {
|
|
@@ -4789,6 +4863,7 @@ export interface OutboundFailureBucket {
|
|
|
4789
4863
|
}
|
|
4790
4864
|
export interface OverridePasswordRequest {
|
|
4791
4865
|
password: string;
|
|
4866
|
+
passwordConfirmation?: string | null;
|
|
4792
4867
|
}
|
|
4793
4868
|
export interface Pagination {
|
|
4794
4869
|
/** @format int32 */
|
|
@@ -6788,6 +6863,7 @@ export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "
|
|
|
6788
6863
|
export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
6789
6864
|
export type CreateLoanRoleTaskRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6790
6865
|
export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6866
|
+
export type CustomFieldAnswerWarningReasonEnum = "Unresolved" | "Inactive" | "ReadOnly" | "DuplicateDefinition";
|
|
6791
6867
|
export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
6792
6868
|
export type CustomFieldDefinitionEntityTypeEnum = "Loan";
|
|
6793
6869
|
export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
@@ -6807,6 +6883,8 @@ export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuc
|
|
|
6807
6883
|
export type EncompassWebhookSubscriptionWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
|
|
6808
6884
|
export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
6809
6885
|
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";
|
|
6886
|
+
export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
|
|
6887
|
+
export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
6810
6888
|
export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
6811
6889
|
export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
6812
6890
|
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
@@ -6915,7 +6993,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
6915
6993
|
}
|
|
6916
6994
|
/**
|
|
6917
6995
|
* @title The Big POS API
|
|
6918
|
-
* @version v3.
|
|
6996
|
+
* @version v3.15.0
|
|
6919
6997
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
6920
6998
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
6921
6999
|
*/
|
|
@@ -9794,6 +9872,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9794
9872
|
* @response `200` `FormVersion` OK
|
|
9795
9873
|
*/
|
|
9796
9874
|
deleteFormVersion: (formId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<FormVersion, any, {}>>;
|
|
9875
|
+
/**
|
|
9876
|
+
* No description
|
|
9877
|
+
*
|
|
9878
|
+
* @tags IncompleteLoans
|
|
9879
|
+
* @name SearchIncompleteLoans
|
|
9880
|
+
* @summary Search incomplete loans
|
|
9881
|
+
* @request POST:/api/loans/incomplete/search
|
|
9882
|
+
* @secure
|
|
9883
|
+
* @response `200` `IncompleteLoanPaginated` OK
|
|
9884
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
9885
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
9886
|
+
* @response `404` `ProblemDetails` Not Found
|
|
9887
|
+
*/
|
|
9888
|
+
searchIncompleteLoans: (data: IncompleteLoanSearchCriteria, query?: {
|
|
9889
|
+
/** @format int32 */
|
|
9890
|
+
pageSize?: number;
|
|
9891
|
+
/** @format int32 */
|
|
9892
|
+
pageNumber?: number;
|
|
9893
|
+
sortBy?: string;
|
|
9894
|
+
sortDirection?: string;
|
|
9895
|
+
}, params?: RequestParams) => Promise<AxiosResponse<IncompleteLoanPaginated, any, {}>>;
|
|
9797
9896
|
/**
|
|
9798
9897
|
* No description
|
|
9799
9898
|
*
|
|
@@ -9934,17 +10033,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9934
10033
|
* @response `200` `(UnderwritingCondition)[]` OK
|
|
9935
10034
|
*/
|
|
9936
10035
|
getUnderwritingConditionsForLoan: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<UnderwritingCondition[], any, {}>>;
|
|
9937
|
-
/**
|
|
9938
|
-
* No description
|
|
9939
|
-
*
|
|
9940
|
-
* @tags LegacyLoan
|
|
9941
|
-
* @name GetLoanEmbeddedSigningLink
|
|
9942
|
-
* @summary Get Embedded Signing Link
|
|
9943
|
-
* @request POST:/api/los/loan/embeddedsigning/{envelopeId}/{userName}/{email}
|
|
9944
|
-
* @secure
|
|
9945
|
-
* @response `200` `string` OK
|
|
9946
|
-
*/
|
|
9947
|
-
getLoanEmbeddedSigningLink: (envelopeId: string, userName: string, email: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
|
|
9948
10036
|
/**
|
|
9949
10037
|
* No description
|
|
9950
10038
|
*
|
|
@@ -10171,6 +10259,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10171
10259
|
* @response `200` `File` OK
|
|
10172
10260
|
*/
|
|
10173
10261
|
getListingOpenHouseFlyer: (id: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
10262
|
+
/**
|
|
10263
|
+
* No description
|
|
10264
|
+
*
|
|
10265
|
+
* @tags LoanApplicationRemoval
|
|
10266
|
+
* @name RemoveLoanApplication
|
|
10267
|
+
* @summary Remove a loan application nobody has submitted
|
|
10268
|
+
* @request POST:/api/loans/{loanId}/application/remove
|
|
10269
|
+
* @secure
|
|
10270
|
+
* @response `204` `void` No Content
|
|
10271
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
10272
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
10273
|
+
* @response `404` `ProblemDetails` Not Found
|
|
10274
|
+
* @response `409` `ProblemDetails` Conflict
|
|
10275
|
+
*/
|
|
10276
|
+
removeLoanApplication: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
10277
|
+
/**
|
|
10278
|
+
* No description
|
|
10279
|
+
*
|
|
10280
|
+
* @tags LoanApplicationRemoval
|
|
10281
|
+
* @name RestoreLoanApplication
|
|
10282
|
+
* @summary Restore a removed loan application
|
|
10283
|
+
* @request POST:/api/loans/{loanId}/application/restore
|
|
10284
|
+
* @secure
|
|
10285
|
+
* @response `204` `void` No Content
|
|
10286
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
10287
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
10288
|
+
* @response `404` `ProblemDetails` Not Found
|
|
10289
|
+
* @response `409` `ProblemDetails` Conflict
|
|
10290
|
+
*/
|
|
10291
|
+
restoreLoanApplication: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
10174
10292
|
/**
|
|
10175
10293
|
* No description
|
|
10176
10294
|
*
|
|
@@ -11211,6 +11329,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11211
11329
|
* @response `404` `ProblemDetails` Not Found
|
|
11212
11330
|
* @response `409` `any` Conflict
|
|
11213
11331
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
11332
|
+
* @response `423` `ProblemDetails` Locked
|
|
11214
11333
|
*/
|
|
11215
11334
|
updateLoan: (loanId: string, data: LoanPatchRequestGuidPatchDocument, params?: RequestParams) => Promise<AxiosResponse<Loan, any, {}>>;
|
|
11216
11335
|
/**
|
|
@@ -11293,6 +11412,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11293
11412
|
* @secure
|
|
11294
11413
|
* @response `202` `void` Accepted
|
|
11295
11414
|
* @response `404` `ProblemDetails` Not Found
|
|
11415
|
+
* @response `409` `ProblemDetails` Conflict
|
|
11296
11416
|
*/
|
|
11297
11417
|
syncLoanToLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
11298
11418
|
/**
|
|
@@ -13005,6 +13125,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13005
13125
|
* @response `204` `void` No Content
|
|
13006
13126
|
* @response `404` `Error` Not Found
|
|
13007
13127
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
13128
|
+
* @response `429` `ProblemDetails` Too Many Requests
|
|
13008
13129
|
*/
|
|
13009
13130
|
allowImpersonationWithGuid: (allowToken: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
13010
13131
|
/**
|
|
@@ -13056,6 +13177,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13056
13177
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
13057
13178
|
*/
|
|
13058
13179
|
extendImpersonation: (params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
13180
|
+
/**
|
|
13181
|
+
* No description
|
|
13182
|
+
*
|
|
13183
|
+
* @tags UserInviteAcceptance
|
|
13184
|
+
* @name AcceptBorrowerInvite
|
|
13185
|
+
* @summary Accept a borrower invite with the signed-in account
|
|
13186
|
+
* @request POST:/api/users/invites/accept
|
|
13187
|
+
* @secure
|
|
13188
|
+
* @response `200` `AcceptedBorrowerInvite` OK
|
|
13189
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
13190
|
+
* @response `404` `ProblemDetails` Not Found
|
|
13191
|
+
* @response `409` `ProblemDetails` Conflict
|
|
13192
|
+
*/
|
|
13193
|
+
acceptBorrowerInvite: (data: AcceptBorrowerInviteRequest, params?: RequestParams) => Promise<AxiosResponse<AcceptedBorrowerInvite, any, {}>>;
|
|
13059
13194
|
/**
|
|
13060
13195
|
* No description
|
|
13061
13196
|
*
|
package/dist/index.js
CHANGED
|
@@ -86,7 +86,13 @@ export class HttpClient {
|
|
|
86
86
|
const property = input[key];
|
|
87
87
|
const propertyContent = property instanceof Array ? property : [property];
|
|
88
88
|
for (const formItem of propertyContent) {
|
|
89
|
-
|
|
89
|
+
// React Native files are plain { uri, name, type } objects, not Blob/File.
|
|
90
|
+
const isReactNativeFile = !!formItem &&
|
|
91
|
+
typeof formItem === "object" &&
|
|
92
|
+
"uri" in formItem &&
|
|
93
|
+
"name" in formItem &&
|
|
94
|
+
"type" in formItem;
|
|
95
|
+
const isFileType = isReactNativeFile || formItem instanceof Blob || formItem instanceof File;
|
|
90
96
|
formData.append(key, isFileType ? formItem : this.stringifyFormItem(formItem));
|
|
91
97
|
}
|
|
92
98
|
return formData;
|
|
@@ -95,7 +101,7 @@ export class HttpClient {
|
|
|
95
101
|
}
|
|
96
102
|
/**
|
|
97
103
|
* @title The Big POS API
|
|
98
|
-
* @version v3.
|
|
104
|
+
* @version v3.15.0
|
|
99
105
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
100
106
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
101
107
|
*/
|
|
@@ -2643,6 +2649,20 @@ export class Api extends HttpClient {
|
|
|
2643
2649
|
* @response `200` `FormVersion` OK
|
|
2644
2650
|
*/
|
|
2645
2651
|
deleteFormVersion: (formId, id, params = {}) => this.request(Object.assign({ path: `/api/forms/${formId}/versions/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
|
|
2652
|
+
/**
|
|
2653
|
+
* No description
|
|
2654
|
+
*
|
|
2655
|
+
* @tags IncompleteLoans
|
|
2656
|
+
* @name SearchIncompleteLoans
|
|
2657
|
+
* @summary Search incomplete loans
|
|
2658
|
+
* @request POST:/api/loans/incomplete/search
|
|
2659
|
+
* @secure
|
|
2660
|
+
* @response `200` `IncompleteLoanPaginated` OK
|
|
2661
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
2662
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
2663
|
+
* @response `404` `ProblemDetails` Not Found
|
|
2664
|
+
*/
|
|
2665
|
+
searchIncompleteLoans: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/incomplete/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2646
2666
|
/**
|
|
2647
2667
|
* No description
|
|
2648
2668
|
*
|
|
@@ -2774,17 +2794,6 @@ export class Api extends HttpClient {
|
|
|
2774
2794
|
* @response `200` `(UnderwritingCondition)[]` OK
|
|
2775
2795
|
*/
|
|
2776
2796
|
getUnderwritingConditionsForLoan: (loanId, params = {}) => this.request(Object.assign({ path: `/api/los/loan/${loanId}/conditions/underwriting`, method: "GET", secure: true, format: "json" }, params)),
|
|
2777
|
-
/**
|
|
2778
|
-
* No description
|
|
2779
|
-
*
|
|
2780
|
-
* @tags LegacyLoan
|
|
2781
|
-
* @name GetLoanEmbeddedSigningLink
|
|
2782
|
-
* @summary Get Embedded Signing Link
|
|
2783
|
-
* @request POST:/api/los/loan/embeddedsigning/{envelopeId}/{userName}/{email}
|
|
2784
|
-
* @secure
|
|
2785
|
-
* @response `200` `string` OK
|
|
2786
|
-
*/
|
|
2787
|
-
getLoanEmbeddedSigningLink: (envelopeId, userName, email, params = {}) => this.request(Object.assign({ path: `/api/los/loan/embeddedsigning/${envelopeId}/${userName}/${email}`, method: "POST", secure: true, format: "json" }, params)),
|
|
2788
2797
|
/**
|
|
2789
2798
|
* No description
|
|
2790
2799
|
*
|
|
@@ -2979,6 +2988,36 @@ export class Api extends HttpClient {
|
|
|
2979
2988
|
* @response `200` `File` OK
|
|
2980
2989
|
*/
|
|
2981
2990
|
getListingOpenHouseFlyer: (id, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}/open-house-flyer`, method: "GET", secure: true, format: "json" }, params)),
|
|
2991
|
+
/**
|
|
2992
|
+
* No description
|
|
2993
|
+
*
|
|
2994
|
+
* @tags LoanApplicationRemoval
|
|
2995
|
+
* @name RemoveLoanApplication
|
|
2996
|
+
* @summary Remove a loan application nobody has submitted
|
|
2997
|
+
* @request POST:/api/loans/{loanId}/application/remove
|
|
2998
|
+
* @secure
|
|
2999
|
+
* @response `204` `void` No Content
|
|
3000
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
3001
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
3002
|
+
* @response `404` `ProblemDetails` Not Found
|
|
3003
|
+
* @response `409` `ProblemDetails` Conflict
|
|
3004
|
+
*/
|
|
3005
|
+
removeLoanApplication: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/application/remove`, method: "POST", secure: true }, params)),
|
|
3006
|
+
/**
|
|
3007
|
+
* No description
|
|
3008
|
+
*
|
|
3009
|
+
* @tags LoanApplicationRemoval
|
|
3010
|
+
* @name RestoreLoanApplication
|
|
3011
|
+
* @summary Restore a removed loan application
|
|
3012
|
+
* @request POST:/api/loans/{loanId}/application/restore
|
|
3013
|
+
* @secure
|
|
3014
|
+
* @response `204` `void` No Content
|
|
3015
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
3016
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
3017
|
+
* @response `404` `ProblemDetails` Not Found
|
|
3018
|
+
* @response `409` `ProblemDetails` Conflict
|
|
3019
|
+
*/
|
|
3020
|
+
restoreLoanApplication: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/application/restore`, method: "POST", secure: true }, params)),
|
|
2982
3021
|
/**
|
|
2983
3022
|
* No description
|
|
2984
3023
|
*
|
|
@@ -3928,6 +3967,7 @@ export class Api extends HttpClient {
|
|
|
3928
3967
|
* @response `404` `ProblemDetails` Not Found
|
|
3929
3968
|
* @response `409` `any` Conflict
|
|
3930
3969
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3970
|
+
* @response `423` `ProblemDetails` Locked
|
|
3931
3971
|
*/
|
|
3932
3972
|
updateLoan: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3933
3973
|
/**
|
|
@@ -4010,6 +4050,7 @@ export class Api extends HttpClient {
|
|
|
4010
4050
|
* @secure
|
|
4011
4051
|
* @response `202` `void` Accepted
|
|
4012
4052
|
* @response `404` `ProblemDetails` Not Found
|
|
4053
|
+
* @response `409` `ProblemDetails` Conflict
|
|
4013
4054
|
*/
|
|
4014
4055
|
syncLoanToLos: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/sync-to-los`, method: "POST", secure: true }, params)),
|
|
4015
4056
|
/**
|
|
@@ -5546,6 +5587,7 @@ export class Api extends HttpClient {
|
|
|
5546
5587
|
* @response `204` `void` No Content
|
|
5547
5588
|
* @response `404` `Error` Not Found
|
|
5548
5589
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
5590
|
+
* @response `429` `ProblemDetails` Too Many Requests
|
|
5549
5591
|
*/
|
|
5550
5592
|
allowImpersonationWithGuid: (allowToken, params = {}) => this.request(Object.assign({ path: `/api/users/impersonation/allow/${allowToken}`, method: "POST", secure: true }, params)),
|
|
5551
5593
|
/**
|
|
@@ -5597,6 +5639,20 @@ export class Api extends HttpClient {
|
|
|
5597
5639
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
5598
5640
|
*/
|
|
5599
5641
|
extendImpersonation: (params = {}) => this.request(Object.assign({ path: `/api/users/impersonation/extend`, method: "POST", secure: true }, params)),
|
|
5642
|
+
/**
|
|
5643
|
+
* No description
|
|
5644
|
+
*
|
|
5645
|
+
* @tags UserInviteAcceptance
|
|
5646
|
+
* @name AcceptBorrowerInvite
|
|
5647
|
+
* @summary Accept a borrower invite with the signed-in account
|
|
5648
|
+
* @request POST:/api/users/invites/accept
|
|
5649
|
+
* @secure
|
|
5650
|
+
* @response `200` `AcceptedBorrowerInvite` OK
|
|
5651
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
5652
|
+
* @response `404` `ProblemDetails` Not Found
|
|
5653
|
+
* @response `409` `ProblemDetails` Conflict
|
|
5654
|
+
*/
|
|
5655
|
+
acceptBorrowerInvite: (data, params = {}) => this.request(Object.assign({ path: `/api/users/invites/accept`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
5600
5656
|
/**
|
|
5601
5657
|
* No description
|
|
5602
5658
|
*
|