@matech/thebigpos-sdk 3.14.0 → 3.15.0-pr-5382-5985
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 +163 -13
- package/dist/index.js +69 -2
- 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 +237 -15
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 */
|
|
@@ -2675,7 +2749,7 @@ export interface LoanApplicationSessionRequest {
|
|
|
2675
2749
|
export interface LoanBorrower {
|
|
2676
2750
|
/** @format uuid */
|
|
2677
2751
|
id: string;
|
|
2678
|
-
|
|
2752
|
+
ssnLast4?: string | null;
|
|
2679
2753
|
email?: string | null;
|
|
2680
2754
|
lastName?: string | null;
|
|
2681
2755
|
firstName?: string | null;
|
|
@@ -2718,6 +2792,8 @@ export interface LoanBorrowerAccountAsset {
|
|
|
2718
2792
|
/** @format uuid */
|
|
2719
2793
|
id?: string | null;
|
|
2720
2794
|
name?: string | null;
|
|
2795
|
+
accountNumberLast4?: string | null;
|
|
2796
|
+
/** @deprecated */
|
|
2721
2797
|
accountNumber?: string | null;
|
|
2722
2798
|
financialInstitution?: string | null;
|
|
2723
2799
|
/** @format double */
|
|
@@ -3120,7 +3196,7 @@ export interface LoanBorrowerLiability {
|
|
|
3120
3196
|
id?: string | null;
|
|
3121
3197
|
type?: LoanLiabilityType | null;
|
|
3122
3198
|
name?: string | null;
|
|
3123
|
-
|
|
3199
|
+
accountNumberLast4?: string | null;
|
|
3124
3200
|
financialInstitution?: string | null;
|
|
3125
3201
|
/** @format double */
|
|
3126
3202
|
balance?: number | null;
|
|
@@ -3274,6 +3350,8 @@ export interface LoanBorrowerRealEstateAssetMortgage {
|
|
|
3274
3350
|
/** @format uuid */
|
|
3275
3351
|
id?: string | null;
|
|
3276
3352
|
creditor?: string | null;
|
|
3353
|
+
accountNumberLast4?: string | null;
|
|
3354
|
+
/** @deprecated */
|
|
3277
3355
|
accountNumber?: string | null;
|
|
3278
3356
|
/** @format double */
|
|
3279
3357
|
balance?: number | null;
|
|
@@ -4065,7 +4143,7 @@ export interface LoanQueueWithData {
|
|
|
4065
4143
|
user: UserPublic;
|
|
4066
4144
|
loanOfficer: LoanOfficerPublic;
|
|
4067
4145
|
siteConfiguration: SiteConfigurationReduced;
|
|
4068
|
-
data
|
|
4146
|
+
data: any;
|
|
4069
4147
|
}
|
|
4070
4148
|
export interface LoanRecommendation {
|
|
4071
4149
|
/** @format uuid */
|
|
@@ -4074,7 +4152,7 @@ export interface LoanRecommendation {
|
|
|
4074
4152
|
displayName: string;
|
|
4075
4153
|
extractedValue: string;
|
|
4076
4154
|
mintable: boolean;
|
|
4077
|
-
currentLoanValue
|
|
4155
|
+
currentLoanValue: any;
|
|
4078
4156
|
/** @format uuid */
|
|
4079
4157
|
sourceDocumentId: string;
|
|
4080
4158
|
sourceDocumentName?: string | null;
|
|
@@ -4603,7 +4681,7 @@ export interface ModuleParameterValue {
|
|
|
4603
4681
|
parameterID: string;
|
|
4604
4682
|
parameterName: string;
|
|
4605
4683
|
parameterType: string;
|
|
4606
|
-
value
|
|
4684
|
+
value: any;
|
|
4607
4685
|
isInherited: boolean;
|
|
4608
4686
|
}
|
|
4609
4687
|
export interface MonthlyPaymentCalculator {
|
|
@@ -4789,6 +4867,7 @@ export interface OutboundFailureBucket {
|
|
|
4789
4867
|
}
|
|
4790
4868
|
export interface OverridePasswordRequest {
|
|
4791
4869
|
password: string;
|
|
4870
|
+
passwordConfirmation?: string | null;
|
|
4792
4871
|
}
|
|
4793
4872
|
export interface Pagination {
|
|
4794
4873
|
/** @format int32 */
|
|
@@ -6788,6 +6867,7 @@ export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "
|
|
|
6788
6867
|
export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
6789
6868
|
export type CreateLoanRoleTaskRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6790
6869
|
export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6870
|
+
export type CustomFieldAnswerWarningReasonEnum = "Unresolved" | "Inactive" | "ReadOnly" | "DuplicateDefinition";
|
|
6791
6871
|
export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
6792
6872
|
export type CustomFieldDefinitionEntityTypeEnum = "Loan";
|
|
6793
6873
|
export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
@@ -6807,6 +6887,8 @@ export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuc
|
|
|
6807
6887
|
export type EncompassWebhookSubscriptionWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
|
|
6808
6888
|
export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
6809
6889
|
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";
|
|
6890
|
+
export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
|
|
6891
|
+
export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
6810
6892
|
export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
6811
6893
|
export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
6812
6894
|
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
@@ -6915,7 +6997,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
6915
6997
|
}
|
|
6916
6998
|
/**
|
|
6917
6999
|
* @title The Big POS API
|
|
6918
|
-
* @version v3.
|
|
7000
|
+
* @version v3.15.0
|
|
6919
7001
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
6920
7002
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
6921
7003
|
*/
|
|
@@ -9794,6 +9876,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9794
9876
|
* @response `200` `FormVersion` OK
|
|
9795
9877
|
*/
|
|
9796
9878
|
deleteFormVersion: (formId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<FormVersion, any, {}>>;
|
|
9879
|
+
/**
|
|
9880
|
+
* No description
|
|
9881
|
+
*
|
|
9882
|
+
* @tags IncompleteLoans
|
|
9883
|
+
* @name SearchIncompleteLoans
|
|
9884
|
+
* @summary Search incomplete loans
|
|
9885
|
+
* @request POST:/api/loans/incomplete/search
|
|
9886
|
+
* @secure
|
|
9887
|
+
* @response `200` `IncompleteLoanPaginated` OK
|
|
9888
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
9889
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
9890
|
+
* @response `404` `ProblemDetails` Not Found
|
|
9891
|
+
*/
|
|
9892
|
+
searchIncompleteLoans: (data: IncompleteLoanSearchCriteria, query?: {
|
|
9893
|
+
/** @format int32 */
|
|
9894
|
+
pageSize?: number;
|
|
9895
|
+
/** @format int32 */
|
|
9896
|
+
pageNumber?: number;
|
|
9897
|
+
sortBy?: string;
|
|
9898
|
+
sortDirection?: string;
|
|
9899
|
+
}, params?: RequestParams) => Promise<AxiosResponse<IncompleteLoanPaginated, any, {}>>;
|
|
9797
9900
|
/**
|
|
9798
9901
|
* No description
|
|
9799
9902
|
*
|
|
@@ -10171,6 +10274,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10171
10274
|
* @response `200` `File` OK
|
|
10172
10275
|
*/
|
|
10173
10276
|
getListingOpenHouseFlyer: (id: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
|
|
10277
|
+
/**
|
|
10278
|
+
* No description
|
|
10279
|
+
*
|
|
10280
|
+
* @tags LoanApplicationRemoval
|
|
10281
|
+
* @name RemoveLoanApplication
|
|
10282
|
+
* @summary Remove a loan application nobody has submitted
|
|
10283
|
+
* @request POST:/api/loans/{loanId}/application/remove
|
|
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
|
+
removeLoanApplication: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
10292
|
+
/**
|
|
10293
|
+
* No description
|
|
10294
|
+
*
|
|
10295
|
+
* @tags LoanApplicationRemoval
|
|
10296
|
+
* @name RestoreLoanApplication
|
|
10297
|
+
* @summary Restore a removed loan application
|
|
10298
|
+
* @request POST:/api/loans/{loanId}/application/restore
|
|
10299
|
+
* @secure
|
|
10300
|
+
* @response `204` `void` No Content
|
|
10301
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
10302
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
10303
|
+
* @response `404` `ProblemDetails` Not Found
|
|
10304
|
+
* @response `409` `ProblemDetails` Conflict
|
|
10305
|
+
*/
|
|
10306
|
+
restoreLoanApplication: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
10174
10307
|
/**
|
|
10175
10308
|
* No description
|
|
10176
10309
|
*
|
|
@@ -11211,6 +11344,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11211
11344
|
* @response `404` `ProblemDetails` Not Found
|
|
11212
11345
|
* @response `409` `any` Conflict
|
|
11213
11346
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
11347
|
+
* @response `423` `ProblemDetails` Locked
|
|
11214
11348
|
*/
|
|
11215
11349
|
updateLoan: (loanId: string, data: LoanPatchRequestGuidPatchDocument, params?: RequestParams) => Promise<AxiosResponse<Loan, any, {}>>;
|
|
11216
11350
|
/**
|
|
@@ -11293,6 +11427,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11293
11427
|
* @secure
|
|
11294
11428
|
* @response `202` `void` Accepted
|
|
11295
11429
|
* @response `404` `ProblemDetails` Not Found
|
|
11430
|
+
* @response `409` `ProblemDetails` Conflict
|
|
11296
11431
|
*/
|
|
11297
11432
|
syncLoanToLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
11298
11433
|
/**
|
|
@@ -13005,6 +13140,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13005
13140
|
* @response `204` `void` No Content
|
|
13006
13141
|
* @response `404` `Error` Not Found
|
|
13007
13142
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
13143
|
+
* @response `429` `ProblemDetails` Too Many Requests
|
|
13008
13144
|
*/
|
|
13009
13145
|
allowImpersonationWithGuid: (allowToken: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
13010
13146
|
/**
|
|
@@ -13056,6 +13192,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13056
13192
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
13057
13193
|
*/
|
|
13058
13194
|
extendImpersonation: (params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
13195
|
+
/**
|
|
13196
|
+
* No description
|
|
13197
|
+
*
|
|
13198
|
+
* @tags UserInviteAcceptance
|
|
13199
|
+
* @name AcceptBorrowerInvite
|
|
13200
|
+
* @summary Accept a borrower invite with the signed-in account
|
|
13201
|
+
* @request POST:/api/users/invites/accept
|
|
13202
|
+
* @secure
|
|
13203
|
+
* @response `200` `AcceptedBorrowerInvite` OK
|
|
13204
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
13205
|
+
* @response `404` `ProblemDetails` Not Found
|
|
13206
|
+
* @response `409` `ProblemDetails` Conflict
|
|
13207
|
+
*/
|
|
13208
|
+
acceptBorrowerInvite: (data: AcceptBorrowerInviteRequest, params?: RequestParams) => Promise<AxiosResponse<AcceptedBorrowerInvite, any, {}>>;
|
|
13059
13209
|
/**
|
|
13060
13210
|
* No description
|
|
13061
13211
|
*
|
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
|
*
|
|
@@ -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
|
*
|
|
@@ -3928,6 +3978,7 @@ export class Api extends HttpClient {
|
|
|
3928
3978
|
* @response `404` `ProblemDetails` Not Found
|
|
3929
3979
|
* @response `409` `any` Conflict
|
|
3930
3980
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
3981
|
+
* @response `423` `ProblemDetails` Locked
|
|
3931
3982
|
*/
|
|
3932
3983
|
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
3984
|
/**
|
|
@@ -4010,6 +4061,7 @@ export class Api extends HttpClient {
|
|
|
4010
4061
|
* @secure
|
|
4011
4062
|
* @response `202` `void` Accepted
|
|
4012
4063
|
* @response `404` `ProblemDetails` Not Found
|
|
4064
|
+
* @response `409` `ProblemDetails` Conflict
|
|
4013
4065
|
*/
|
|
4014
4066
|
syncLoanToLos: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/sync-to-los`, method: "POST", secure: true }, params)),
|
|
4015
4067
|
/**
|
|
@@ -5546,6 +5598,7 @@ export class Api extends HttpClient {
|
|
|
5546
5598
|
* @response `204` `void` No Content
|
|
5547
5599
|
* @response `404` `Error` Not Found
|
|
5548
5600
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
5601
|
+
* @response `429` `ProblemDetails` Too Many Requests
|
|
5549
5602
|
*/
|
|
5550
5603
|
allowImpersonationWithGuid: (allowToken, params = {}) => this.request(Object.assign({ path: `/api/users/impersonation/allow/${allowToken}`, method: "POST", secure: true }, params)),
|
|
5551
5604
|
/**
|
|
@@ -5597,6 +5650,20 @@ export class Api extends HttpClient {
|
|
|
5597
5650
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
5598
5651
|
*/
|
|
5599
5652
|
extendImpersonation: (params = {}) => this.request(Object.assign({ path: `/api/users/impersonation/extend`, method: "POST", secure: true }, params)),
|
|
5653
|
+
/**
|
|
5654
|
+
* No description
|
|
5655
|
+
*
|
|
5656
|
+
* @tags UserInviteAcceptance
|
|
5657
|
+
* @name AcceptBorrowerInvite
|
|
5658
|
+
* @summary Accept a borrower invite with the signed-in account
|
|
5659
|
+
* @request POST:/api/users/invites/accept
|
|
5660
|
+
* @secure
|
|
5661
|
+
* @response `200` `AcceptedBorrowerInvite` OK
|
|
5662
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
5663
|
+
* @response `404` `ProblemDetails` Not Found
|
|
5664
|
+
* @response `409` `ProblemDetails` Conflict
|
|
5665
|
+
*/
|
|
5666
|
+
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
5667
|
/**
|
|
5601
5668
|
* No description
|
|
5602
5669
|
*
|