@matech/thebigpos-sdk 3.13.0 → 3.14.0-dev-5757
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 +165 -4
- package/dist/index.js +87 -4
- 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 +245 -6
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
|
@@ -249,8 +249,10 @@ export interface AdminAccessUser {
|
|
|
249
249
|
preferredLoanOfficer?: PreferredLoanOfficer | null;
|
|
250
250
|
loanIDs: string[];
|
|
251
251
|
drafts: Draft[];
|
|
252
|
+
inProgressLoans?: InProgressLoan[] | null;
|
|
252
253
|
notificationSettings?: UserNotificationSettings | null;
|
|
253
254
|
hasExtendedLoanVisibility: boolean;
|
|
255
|
+
applicationV3Enabled?: boolean | null;
|
|
254
256
|
/** @format uuid */
|
|
255
257
|
accountID?: string | null;
|
|
256
258
|
loans: UserLoan[];
|
|
@@ -670,6 +672,7 @@ export interface AiPromptRun {
|
|
|
670
672
|
errorType?: string | null;
|
|
671
673
|
errorMessage?: string | null;
|
|
672
674
|
result?: AiPromptRunResult | null;
|
|
675
|
+
detailsWithheld: boolean;
|
|
673
676
|
/** @format date-time */
|
|
674
677
|
createdAt: string;
|
|
675
678
|
/** @format date-time */
|
|
@@ -1064,8 +1067,10 @@ export interface BranchUser {
|
|
|
1064
1067
|
preferredLoanOfficer?: PreferredLoanOfficer | null;
|
|
1065
1068
|
loanIDs: string[];
|
|
1066
1069
|
drafts: Draft[];
|
|
1070
|
+
inProgressLoans?: InProgressLoan[] | null;
|
|
1067
1071
|
notificationSettings?: UserNotificationSettings | null;
|
|
1068
1072
|
hasExtendedLoanVisibility: boolean;
|
|
1073
|
+
applicationV3Enabled?: boolean | null;
|
|
1069
1074
|
/** @format uuid */
|
|
1070
1075
|
branchID: string;
|
|
1071
1076
|
branchName: string;
|
|
@@ -1623,8 +1628,10 @@ export interface DetailedUser {
|
|
|
1623
1628
|
preferredLoanOfficer?: PreferredLoanOfficer | null;
|
|
1624
1629
|
loanIDs: string[];
|
|
1625
1630
|
drafts: Draft[];
|
|
1631
|
+
inProgressLoans?: InProgressLoan[] | null;
|
|
1626
1632
|
notificationSettings?: UserNotificationSettings | null;
|
|
1627
1633
|
hasExtendedLoanVisibility: boolean;
|
|
1634
|
+
applicationV3Enabled?: boolean | null;
|
|
1628
1635
|
}
|
|
1629
1636
|
export interface DocumentDataRequest {
|
|
1630
1637
|
documentID?: string | null;
|
|
@@ -1819,7 +1826,6 @@ export interface EnabledServices {
|
|
|
1819
1826
|
socialSurvey?: boolean | null;
|
|
1820
1827
|
borrowerTasks?: boolean | null;
|
|
1821
1828
|
preBorrowerTasks?: boolean | null;
|
|
1822
|
-
docusign?: boolean | null;
|
|
1823
1829
|
emailNotifications?: boolean | null;
|
|
1824
1830
|
autoTaskReminders?: boolean | null;
|
|
1825
1831
|
voc?: boolean | null;
|
|
@@ -2374,8 +2380,10 @@ export interface ImpersonatedDetailedUser {
|
|
|
2374
2380
|
preferredLoanOfficer?: PreferredLoanOfficer | null;
|
|
2375
2381
|
loanIDs: string[];
|
|
2376
2382
|
drafts: Draft[];
|
|
2383
|
+
inProgressLoans?: InProgressLoan[] | null;
|
|
2377
2384
|
notificationSettings?: UserNotificationSettings | null;
|
|
2378
2385
|
hasExtendedLoanVisibility: boolean;
|
|
2386
|
+
applicationV3Enabled?: boolean | null;
|
|
2379
2387
|
/** @deprecated */
|
|
2380
2388
|
impersonatedBy?: string | null;
|
|
2381
2389
|
impersonatingUser?: User | null;
|
|
@@ -2386,11 +2394,65 @@ export interface ImportUserLoanTaskRequest {
|
|
|
2386
2394
|
/** @format uuid */
|
|
2387
2395
|
userID: string;
|
|
2388
2396
|
}
|
|
2397
|
+
export interface InProgressLoan {
|
|
2398
|
+
/** @format uuid */
|
|
2399
|
+
id: string;
|
|
2400
|
+
/** @format uuid */
|
|
2401
|
+
borrowerId: string;
|
|
2402
|
+
/** @format uuid */
|
|
2403
|
+
siteConfigurationId?: string | null;
|
|
2404
|
+
/** @format date-time */
|
|
2405
|
+
updatedAt?: string | null;
|
|
2406
|
+
}
|
|
2389
2407
|
export interface IncompleteApplicationSummary {
|
|
2390
2408
|
/** @format int32 */
|
|
2391
2409
|
total: number;
|
|
2392
2410
|
borrowers: BorrowerIdentity[];
|
|
2393
2411
|
}
|
|
2412
|
+
export interface IncompleteLoan {
|
|
2413
|
+
/** @format uuid */
|
|
2414
|
+
loanId: string;
|
|
2415
|
+
/** @format uuid */
|
|
2416
|
+
borrowerId?: string | null;
|
|
2417
|
+
/** @format date-time */
|
|
2418
|
+
createdAt: string;
|
|
2419
|
+
/** @format date-time */
|
|
2420
|
+
updatedAt?: string | null;
|
|
2421
|
+
loanOfficer?: UserSummary | null;
|
|
2422
|
+
siteConfiguration?: IncompleteLoanSiteConfiguration | null;
|
|
2423
|
+
borrowers: IncompleteLoanBorrower[];
|
|
2424
|
+
}
|
|
2425
|
+
export interface IncompleteLoanBorrower {
|
|
2426
|
+
/** @format uuid */
|
|
2427
|
+
id: string;
|
|
2428
|
+
firstName?: string | null;
|
|
2429
|
+
lastName?: string | null;
|
|
2430
|
+
email?: string | null;
|
|
2431
|
+
isPrimaryBorrower: boolean;
|
|
2432
|
+
applicationStatus: IncompleteLoanBorrowerApplicationStatusEnum;
|
|
2433
|
+
/** @format date-time */
|
|
2434
|
+
deletedAt?: string | null;
|
|
2435
|
+
}
|
|
2436
|
+
export interface IncompleteLoanPaginated {
|
|
2437
|
+
rows: IncompleteLoan[];
|
|
2438
|
+
pagination: Pagination;
|
|
2439
|
+
/** @format int64 */
|
|
2440
|
+
count: number;
|
|
2441
|
+
}
|
|
2442
|
+
export interface IncompleteLoanSearchCriteria {
|
|
2443
|
+
searchText?: string | null;
|
|
2444
|
+
/** @format uuid */
|
|
2445
|
+
loanOfficerId?: string | null;
|
|
2446
|
+
/** @format uuid */
|
|
2447
|
+
siteConfigurationId?: string | null;
|
|
2448
|
+
isUnassigned?: boolean | null;
|
|
2449
|
+
includeRemovedApplications?: boolean | null;
|
|
2450
|
+
}
|
|
2451
|
+
export interface IncompleteLoanSiteConfiguration {
|
|
2452
|
+
/** @format uuid */
|
|
2453
|
+
id: string;
|
|
2454
|
+
name: string;
|
|
2455
|
+
}
|
|
2394
2456
|
export interface IntegrationSettings {
|
|
2395
2457
|
encompass?: EncompassIntegrationSettings | null;
|
|
2396
2458
|
}
|
|
@@ -2642,6 +2704,18 @@ export interface LoanApplicationRequest {
|
|
|
2642
2704
|
/** @format uuid */
|
|
2643
2705
|
existingLoanId?: string | null;
|
|
2644
2706
|
}
|
|
2707
|
+
export interface LoanApplicationSession {
|
|
2708
|
+
routeName: string;
|
|
2709
|
+
currentQuestionId?: string | null;
|
|
2710
|
+
questionHistory: string[];
|
|
2711
|
+
/** @format date-time */
|
|
2712
|
+
completedAt?: string | null;
|
|
2713
|
+
}
|
|
2714
|
+
export interface LoanApplicationSessionRequest {
|
|
2715
|
+
routeName: string;
|
|
2716
|
+
currentQuestionId?: string | null;
|
|
2717
|
+
questionHistory: string[];
|
|
2718
|
+
}
|
|
2645
2719
|
export interface LoanBorrower {
|
|
2646
2720
|
/** @format uuid */
|
|
2647
2721
|
id: string;
|
|
@@ -6777,6 +6851,7 @@ export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuc
|
|
|
6777
6851
|
export type EncompassWebhookSubscriptionWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
|
|
6778
6852
|
export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
6779
6853
|
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";
|
|
6854
|
+
export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
6780
6855
|
export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
6781
6856
|
export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
6782
6857
|
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
@@ -6885,7 +6960,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
6885
6960
|
}
|
|
6886
6961
|
/**
|
|
6887
6962
|
* @title The Big POS API
|
|
6888
|
-
* @version v3.
|
|
6963
|
+
* @version v3.14.0
|
|
6889
6964
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
6890
6965
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
6891
6966
|
*/
|
|
@@ -9764,6 +9839,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9764
9839
|
* @response `200` `FormVersion` OK
|
|
9765
9840
|
*/
|
|
9766
9841
|
deleteFormVersion: (formId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<FormVersion, any, {}>>;
|
|
9842
|
+
/**
|
|
9843
|
+
* No description
|
|
9844
|
+
*
|
|
9845
|
+
* @tags IncompleteLoans
|
|
9846
|
+
* @name SearchIncompleteLoans
|
|
9847
|
+
* @summary Search incomplete loans
|
|
9848
|
+
* @request POST:/api/loans/incomplete/search
|
|
9849
|
+
* @secure
|
|
9850
|
+
* @response `200` `IncompleteLoanPaginated` OK
|
|
9851
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
9852
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
9853
|
+
* @response `404` `ProblemDetails` Not Found
|
|
9854
|
+
*/
|
|
9855
|
+
searchIncompleteLoans: (data: IncompleteLoanSearchCriteria, query?: {
|
|
9856
|
+
/** @format int32 */
|
|
9857
|
+
pageSize?: number;
|
|
9858
|
+
/** @format int32 */
|
|
9859
|
+
pageNumber?: number;
|
|
9860
|
+
sortBy?: string;
|
|
9861
|
+
sortDirection?: string;
|
|
9862
|
+
}, params?: RequestParams) => Promise<AxiosResponse<IncompleteLoanPaginated, any, {}>>;
|
|
9767
9863
|
/**
|
|
9768
9864
|
* No description
|
|
9769
9865
|
*
|
|
@@ -10141,6 +10237,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10141
10237
|
* @response `200` `File` OK
|
|
10142
10238
|
*/
|
|
10143
10239
|
getListingOpenHouseFlyer: (id: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
10240
|
+
/**
|
|
10241
|
+
* No description
|
|
10242
|
+
*
|
|
10243
|
+
* @tags LoanApplicationRemoval
|
|
10244
|
+
* @name RemoveLoanApplication
|
|
10245
|
+
* @summary Remove a loan application nobody has submitted
|
|
10246
|
+
* @request POST:/api/loans/{loanId}/application/remove
|
|
10247
|
+
* @secure
|
|
10248
|
+
* @response `204` `void` No Content
|
|
10249
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
10250
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
10251
|
+
* @response `404` `ProblemDetails` Not Found
|
|
10252
|
+
* @response `409` `ProblemDetails` Conflict
|
|
10253
|
+
*/
|
|
10254
|
+
removeLoanApplication: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
10255
|
+
/**
|
|
10256
|
+
* No description
|
|
10257
|
+
*
|
|
10258
|
+
* @tags LoanApplicationRemoval
|
|
10259
|
+
* @name RestoreLoanApplication
|
|
10260
|
+
* @summary Restore a removed loan application
|
|
10261
|
+
* @request POST:/api/loans/{loanId}/application/restore
|
|
10262
|
+
* @secure
|
|
10263
|
+
* @response `204` `void` No Content
|
|
10264
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
10265
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
10266
|
+
* @response `404` `ProblemDetails` Not Found
|
|
10267
|
+
* @response `409` `ProblemDetails` Conflict
|
|
10268
|
+
*/
|
|
10269
|
+
restoreLoanApplication: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
10144
10270
|
/**
|
|
10145
10271
|
* No description
|
|
10146
10272
|
*
|
|
@@ -10397,7 +10523,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10397
10523
|
*/
|
|
10398
10524
|
getLoanDocumentFolderUsage: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolderUsage, any, {}>>;
|
|
10399
10525
|
/**
|
|
10400
|
-
* @description Returns the folders the caller can access that are relevant to this loan —
|
|
10526
|
+
* @description Returns the folders the caller can access that are relevant to this loan — every active system-default folder, plus any folder holding a document the caller can read or bound to one of the loan's tasks, even when empty — with the caller's effective accessLevel and the count of documents they can read in each. Upload destinations are the active entries with accessLevel at least Write. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID, isUnassigned = true); filter to its documents with searchLoanDocuments folderScope 'Unassigned' rather than by echoing that ID.
|
|
10401
10527
|
*
|
|
10402
10528
|
* @tags LoanDocumentFoldersForSingleLoan
|
|
10403
10529
|
* @name ListLoanDocumentFolders
|
|
@@ -11143,8 +11269,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11143
11269
|
* @response `400` `any` Bad Request
|
|
11144
11270
|
* @response `401` `ProblemDetails` Unauthorized
|
|
11145
11271
|
* @response `403` `ProblemDetails` Forbidden
|
|
11272
|
+
* @response `404` `ProblemDetails` Not Found
|
|
11146
11273
|
*/
|
|
11147
|
-
createLoanv3: (data: LoanApplicationRequest,
|
|
11274
|
+
createLoanv3: (data: LoanApplicationRequest, query?: {
|
|
11275
|
+
application?: string;
|
|
11276
|
+
}, params?: RequestParams) => Promise<AxiosResponse<LoanApplication, any, {}>>;
|
|
11148
11277
|
/**
|
|
11149
11278
|
* No description
|
|
11150
11279
|
*
|
|
@@ -11192,6 +11321,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11192
11321
|
* @response `400` `ProblemDetails` Bad Request
|
|
11193
11322
|
* @response `404` `ProblemDetails` Not Found
|
|
11194
11323
|
* @response `409` `ProblemDetails` Conflict
|
|
11324
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
11195
11325
|
*/
|
|
11196
11326
|
completeBorrowerApplication: (loanId: string, borrowerId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
11197
11327
|
/**
|
|
@@ -11208,6 +11338,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11208
11338
|
* @response `429` `ProblemDetails` Too Many Requests
|
|
11209
11339
|
*/
|
|
11210
11340
|
getLoanBorrowerSsn: (loanId: string, borrowerId: string, params?: RequestParams) => Promise<AxiosResponse<LoanBorrowerSsn, any, {}>>;
|
|
11341
|
+
/**
|
|
11342
|
+
* No description
|
|
11343
|
+
*
|
|
11344
|
+
* @tags Loans
|
|
11345
|
+
* @name GetBorrowerApplicationSession
|
|
11346
|
+
* @summary Get borrower application session
|
|
11347
|
+
* @request GET:/api/loans/{loanId}/borrowers/{borrowerId}/application-session
|
|
11348
|
+
* @secure
|
|
11349
|
+
* @response `200` `LoanApplicationSession` OK
|
|
11350
|
+
* @response `400` `any` Bad Request
|
|
11351
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
11352
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
11353
|
+
* @response `404` `ProblemDetails` Not Found
|
|
11354
|
+
*/
|
|
11355
|
+
getBorrowerApplicationSession: (loanId: string, borrowerId: string, params?: RequestParams) => Promise<AxiosResponse<LoanApplicationSession, any, {}>>;
|
|
11356
|
+
/**
|
|
11357
|
+
* No description
|
|
11358
|
+
*
|
|
11359
|
+
* @tags Loans
|
|
11360
|
+
* @name UpdateBorrowerApplicationSession
|
|
11361
|
+
* @summary Update borrower application session
|
|
11362
|
+
* @request PUT:/api/loans/{loanId}/borrowers/{borrowerId}/application-session
|
|
11363
|
+
* @secure
|
|
11364
|
+
* @response `200` `LoanApplicationSession` OK
|
|
11365
|
+
* @response `400` `any` Bad Request
|
|
11366
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
11367
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
11368
|
+
* @response `404` `ProblemDetails` Not Found
|
|
11369
|
+
*/
|
|
11370
|
+
updateBorrowerApplicationSession: (loanId: string, borrowerId: string, data: LoanApplicationSessionRequest, params?: RequestParams) => Promise<AxiosResponse<LoanApplicationSession, any, {}>>;
|
|
11211
11371
|
/**
|
|
11212
11372
|
* No description
|
|
11213
11373
|
*
|
|
@@ -11229,6 +11389,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11229
11389
|
* @secure
|
|
11230
11390
|
* @response `202` `void` Accepted
|
|
11231
11391
|
* @response `404` `ProblemDetails` Not Found
|
|
11392
|
+
* @response `409` `ProblemDetails` Conflict
|
|
11232
11393
|
*/
|
|
11233
11394
|
syncLoanToLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
11234
11395
|
/**
|
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.14.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
|
*
|
|
@@ -2979,6 +2999,36 @@ export class Api extends HttpClient {
|
|
|
2979
2999
|
* @response `200` `File` OK
|
|
2980
3000
|
*/
|
|
2981
3001
|
getListingOpenHouseFlyer: (id, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}/open-house-flyer`, method: "GET", secure: true, format: "json" }, params)),
|
|
3002
|
+
/**
|
|
3003
|
+
* No description
|
|
3004
|
+
*
|
|
3005
|
+
* @tags LoanApplicationRemoval
|
|
3006
|
+
* @name RemoveLoanApplication
|
|
3007
|
+
* @summary Remove a loan application nobody has submitted
|
|
3008
|
+
* @request POST:/api/loans/{loanId}/application/remove
|
|
3009
|
+
* @secure
|
|
3010
|
+
* @response `204` `void` No Content
|
|
3011
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
3012
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
3013
|
+
* @response `404` `ProblemDetails` Not Found
|
|
3014
|
+
* @response `409` `ProblemDetails` Conflict
|
|
3015
|
+
*/
|
|
3016
|
+
removeLoanApplication: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/application/remove`, method: "POST", secure: true }, params)),
|
|
3017
|
+
/**
|
|
3018
|
+
* No description
|
|
3019
|
+
*
|
|
3020
|
+
* @tags LoanApplicationRemoval
|
|
3021
|
+
* @name RestoreLoanApplication
|
|
3022
|
+
* @summary Restore a removed loan application
|
|
3023
|
+
* @request POST:/api/loans/{loanId}/application/restore
|
|
3024
|
+
* @secure
|
|
3025
|
+
* @response `204` `void` No Content
|
|
3026
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
3027
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
3028
|
+
* @response `404` `ProblemDetails` Not Found
|
|
3029
|
+
* @response `409` `ProblemDetails` Conflict
|
|
3030
|
+
*/
|
|
3031
|
+
restoreLoanApplication: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/application/restore`, method: "POST", secure: true }, params)),
|
|
2982
3032
|
/**
|
|
2983
3033
|
* No description
|
|
2984
3034
|
*
|
|
@@ -3228,7 +3278,7 @@ export class Api extends HttpClient {
|
|
|
3228
3278
|
*/
|
|
3229
3279
|
getLoanDocumentFolderUsage: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}/usage`, method: "GET", secure: true, format: "json" }, params)),
|
|
3230
3280
|
/**
|
|
3231
|
-
* @description Returns the folders the caller can access that are relevant to this loan —
|
|
3281
|
+
* @description Returns the folders the caller can access that are relevant to this loan — every active system-default folder, plus any folder holding a document the caller can read or bound to one of the loan's tasks, even when empty — with the caller's effective accessLevel and the count of documents they can read in each. Upload destinations are the active entries with accessLevel at least Write. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID, isUnassigned = true); filter to its documents with searchLoanDocuments folderScope 'Unassigned' rather than by echoing that ID.
|
|
3232
3282
|
*
|
|
3233
3283
|
* @tags LoanDocumentFoldersForSingleLoan
|
|
3234
3284
|
* @name ListLoanDocumentFolders
|
|
@@ -3899,8 +3949,9 @@ export class Api extends HttpClient {
|
|
|
3899
3949
|
* @response `400` `any` Bad Request
|
|
3900
3950
|
* @response `401` `ProblemDetails` Unauthorized
|
|
3901
3951
|
* @response `403` `ProblemDetails` Forbidden
|
|
3952
|
+
* @response `404` `ProblemDetails` Not Found
|
|
3902
3953
|
*/
|
|
3903
|
-
createLoanv3: (data, params = {}) => this.request(Object.assign({ path: `/api/loans`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3954
|
+
createLoanv3: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3904
3955
|
/**
|
|
3905
3956
|
* No description
|
|
3906
3957
|
*
|
|
@@ -3941,6 +3992,7 @@ export class Api extends HttpClient {
|
|
|
3941
3992
|
* @response `400` `ProblemDetails` Bad Request
|
|
3942
3993
|
* @response `404` `ProblemDetails` Not Found
|
|
3943
3994
|
* @response `409` `ProblemDetails` Conflict
|
|
3995
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3944
3996
|
*/
|
|
3945
3997
|
completeBorrowerApplication: (loanId, borrowerId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/borrowers/${borrowerId}/complete`, method: "POST", secure: true }, params)),
|
|
3946
3998
|
/**
|
|
@@ -3957,6 +4009,36 @@ export class Api extends HttpClient {
|
|
|
3957
4009
|
* @response `429` `ProblemDetails` Too Many Requests
|
|
3958
4010
|
*/
|
|
3959
4011
|
getLoanBorrowerSsn: (loanId, borrowerId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/borrowers/${borrowerId}/ssn`, method: "GET", secure: true, format: "json" }, params)),
|
|
4012
|
+
/**
|
|
4013
|
+
* No description
|
|
4014
|
+
*
|
|
4015
|
+
* @tags Loans
|
|
4016
|
+
* @name GetBorrowerApplicationSession
|
|
4017
|
+
* @summary Get borrower application session
|
|
4018
|
+
* @request GET:/api/loans/{loanId}/borrowers/{borrowerId}/application-session
|
|
4019
|
+
* @secure
|
|
4020
|
+
* @response `200` `LoanApplicationSession` OK
|
|
4021
|
+
* @response `400` `any` Bad Request
|
|
4022
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
4023
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
4024
|
+
* @response `404` `ProblemDetails` Not Found
|
|
4025
|
+
*/
|
|
4026
|
+
getBorrowerApplicationSession: (loanId, borrowerId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/borrowers/${borrowerId}/application-session`, method: "GET", secure: true, format: "json" }, params)),
|
|
4027
|
+
/**
|
|
4028
|
+
* No description
|
|
4029
|
+
*
|
|
4030
|
+
* @tags Loans
|
|
4031
|
+
* @name UpdateBorrowerApplicationSession
|
|
4032
|
+
* @summary Update borrower application session
|
|
4033
|
+
* @request PUT:/api/loans/{loanId}/borrowers/{borrowerId}/application-session
|
|
4034
|
+
* @secure
|
|
4035
|
+
* @response `200` `LoanApplicationSession` OK
|
|
4036
|
+
* @response `400` `any` Bad Request
|
|
4037
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
4038
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
4039
|
+
* @response `404` `ProblemDetails` Not Found
|
|
4040
|
+
*/
|
|
4041
|
+
updateBorrowerApplicationSession: (loanId, borrowerId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/borrowers/${borrowerId}/application-session`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
3960
4042
|
/**
|
|
3961
4043
|
* No description
|
|
3962
4044
|
*
|
|
@@ -3978,6 +4060,7 @@ export class Api extends HttpClient {
|
|
|
3978
4060
|
* @secure
|
|
3979
4061
|
* @response `202` `void` Accepted
|
|
3980
4062
|
* @response `404` `ProblemDetails` Not Found
|
|
4063
|
+
* @response `409` `ProblemDetails` Conflict
|
|
3981
4064
|
*/
|
|
3982
4065
|
syncLoanToLos: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/sync-to-los`, method: "POST", secure: true }, params)),
|
|
3983
4066
|
/**
|