@matech/thebigpos-sdk 3.11.1 → 3.11.2-stag-5036
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 +0 -39
- package/dist/index.d.ts +59 -39
- package/dist/index.js +16 -19
- package/dist/index.js.map +1 -1
- package/package.json +5 -15
- package/scripts/apply-json-patch-content-type.js +36 -189
- package/src/index.ts +74 -91
- package/docs/sdk_generation.md +0 -149
package/README.md
CHANGED
|
@@ -40,44 +40,5 @@ 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
|
-
|
|
82
43
|
____
|
|
83
44
|
© 2024 Mortgage Automation Technologies. All rights reserved
|
package/dist/index.d.ts
CHANGED
|
@@ -67,7 +67,6 @@ 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 FilterType = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
71
70
|
export type Environment = "Development" | "Staging" | "UAT" | "Production";
|
|
72
71
|
export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
|
|
73
72
|
export type EncompassWebhookType = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
|
|
@@ -697,6 +696,36 @@ export interface AiPromptRunResult {
|
|
|
697
696
|
/** @format double */
|
|
698
697
|
confidence?: number | null;
|
|
699
698
|
}
|
|
699
|
+
export interface AiPromptRunRetry {
|
|
700
|
+
dryRun: boolean;
|
|
701
|
+
/** @format int32 */
|
|
702
|
+
failedRuns: number;
|
|
703
|
+
/** @format int32 */
|
|
704
|
+
tasks: number;
|
|
705
|
+
/** @format int32 */
|
|
706
|
+
republished: number;
|
|
707
|
+
/** @format int32 */
|
|
708
|
+
skipped: number;
|
|
709
|
+
/** @format int32 */
|
|
710
|
+
remainingTasks: number;
|
|
711
|
+
/** @format int32 */
|
|
712
|
+
scheduledOverSeconds: number;
|
|
713
|
+
items: AiPromptRunRetryItem[];
|
|
714
|
+
}
|
|
715
|
+
export interface AiPromptRunRetryItem {
|
|
716
|
+
/** @format uuid */
|
|
717
|
+
accountId: string;
|
|
718
|
+
/** @format uuid */
|
|
719
|
+
subjectEntityId: string;
|
|
720
|
+
/** @format uuid */
|
|
721
|
+
loanId?: string | null;
|
|
722
|
+
runIds: string[];
|
|
723
|
+
/** @format date-time */
|
|
724
|
+
lastFailedAt: string;
|
|
725
|
+
/** @format int32 */
|
|
726
|
+
delaySeconds: number;
|
|
727
|
+
outcome: string;
|
|
728
|
+
}
|
|
700
729
|
export interface AiPromptRunVerdictBackfill {
|
|
701
730
|
/** @format int32 */
|
|
702
731
|
updated: number;
|
|
@@ -2283,14 +2312,6 @@ export interface FormVersionUpdateRequest {
|
|
|
2283
2312
|
/** @format uuid */
|
|
2284
2313
|
id: string;
|
|
2285
2314
|
}
|
|
2286
|
-
export interface FusionFieldDisplay {
|
|
2287
|
-
fieldValue: string;
|
|
2288
|
-
}
|
|
2289
|
-
export interface FusionReportFilter {
|
|
2290
|
-
filterType: FusionReportFilterFilterTypeEnum;
|
|
2291
|
-
targetField: string;
|
|
2292
|
-
targetValue: string;
|
|
2293
|
-
}
|
|
2294
2315
|
export interface GenerateDocumentRequest {
|
|
2295
2316
|
/** @format uuid */
|
|
2296
2317
|
templateID: string;
|
|
@@ -2353,19 +2374,6 @@ export interface GetForm {
|
|
|
2353
2374
|
/** @format uuid */
|
|
2354
2375
|
id: string;
|
|
2355
2376
|
}
|
|
2356
|
-
export interface GetReport {
|
|
2357
|
-
loanRecords: LoanRecord[];
|
|
2358
|
-
invalidFieldIDs: string[];
|
|
2359
|
-
}
|
|
2360
|
-
export interface GetReportRequest {
|
|
2361
|
-
fields: FusionFieldDisplay[];
|
|
2362
|
-
filters?: FusionReportFilter[] | null;
|
|
2363
|
-
loanIDs?: string[] | null;
|
|
2364
|
-
/** @format int32 */
|
|
2365
|
-
startIndex?: number | null;
|
|
2366
|
-
/** @format int32 */
|
|
2367
|
-
limit?: number | null;
|
|
2368
|
-
}
|
|
2369
2377
|
export interface GetSiteConfigurationByLOUserIDRequest {
|
|
2370
2378
|
loUserID: string;
|
|
2371
2379
|
}
|
|
@@ -4123,10 +4131,6 @@ export interface LoanRecommendation {
|
|
|
4123
4131
|
/** @format date-time */
|
|
4124
4132
|
detectedAt: string;
|
|
4125
4133
|
}
|
|
4126
|
-
export interface LoanRecord {
|
|
4127
|
-
loanGuid: string;
|
|
4128
|
-
loanFields: Record<string, string>;
|
|
4129
|
-
}
|
|
4130
4134
|
export interface LoanRefinance {
|
|
4131
4135
|
/** @format uuid */
|
|
4132
4136
|
id?: string | null;
|
|
@@ -6847,7 +6851,6 @@ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "
|
|
|
6847
6851
|
export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
|
|
6848
6852
|
export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
|
|
6849
6853
|
export type EncompassWebhookSubscriptionWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
|
|
6850
|
-
export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
6851
6854
|
export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
6852
6855
|
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";
|
|
6853
6856
|
export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
@@ -6958,7 +6961,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
6958
6961
|
}
|
|
6959
6962
|
/**
|
|
6960
6963
|
* @title The Big POS API
|
|
6961
|
-
* @version v3.11.
|
|
6964
|
+
* @version v3.11.2
|
|
6962
6965
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
6963
6966
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
6964
6967
|
*/
|
|
@@ -7807,6 +7810,34 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7807
7810
|
backfillAiPromptRunVerdicts: (query?: {
|
|
7808
7811
|
dryRun?: boolean;
|
|
7809
7812
|
}, params?: RequestParams) => Promise<AxiosResponse<AiPromptRunVerdictBackfill, any, {}>>;
|
|
7813
|
+
/**
|
|
7814
|
+
* No description
|
|
7815
|
+
*
|
|
7816
|
+
* @tags AiPromptRunAdmin
|
|
7817
|
+
* @name RetryFailedAiPromptRuns
|
|
7818
|
+
* @summary Republish the trigger for failed prompt runs so they run again, staggered by spacingSeconds (SuperAdmin)
|
|
7819
|
+
* @request POST:/api/ai/prompt-runs/retry-failed
|
|
7820
|
+
* @secure
|
|
7821
|
+
* @response `200` `AiPromptRunRetry` OK
|
|
7822
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7823
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
7824
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
7825
|
+
*/
|
|
7826
|
+
retryFailedAiPromptRuns: (query?: {
|
|
7827
|
+
/** @format uuid */
|
|
7828
|
+
accountId?: string;
|
|
7829
|
+
/** @format date-time */
|
|
7830
|
+
from?: string;
|
|
7831
|
+
/** @format date-time */
|
|
7832
|
+
to?: string;
|
|
7833
|
+
errorType?: string;
|
|
7834
|
+
dryRun?: boolean;
|
|
7835
|
+
/** @format int32 */
|
|
7836
|
+
spacingSeconds?: number;
|
|
7837
|
+
/** @format int32 */
|
|
7838
|
+
limit?: number;
|
|
7839
|
+
includeAlreadyRetried?: boolean;
|
|
7840
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AiPromptRunRetry, any, {}>>;
|
|
7810
7841
|
/**
|
|
7811
7842
|
* No description
|
|
7812
7843
|
*
|
|
@@ -9900,17 +9931,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9900
9931
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
9901
9932
|
*/
|
|
9902
9933
|
updateLoanConsentAndCustomFieldsObsolete: (loanId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
|
|
9903
|
-
/**
|
|
9904
|
-
* No description
|
|
9905
|
-
*
|
|
9906
|
-
* @tags LegacyLoan
|
|
9907
|
-
* @name GetLoansReport
|
|
9908
|
-
* @summary Get Report
|
|
9909
|
-
* @request POST:/api/los/loan/reports
|
|
9910
|
-
* @secure
|
|
9911
|
-
* @response `200` `GetReport` OK
|
|
9912
|
-
*/
|
|
9913
|
-
getLoansReport: (data: GetReportRequest, params?: RequestParams) => Promise<AxiosResponse<GetReport, any, {}>>;
|
|
9914
9934
|
/**
|
|
9915
9935
|
* No description
|
|
9916
9936
|
*
|
package/dist/index.js
CHANGED
|
@@ -86,13 +86,7 @@ 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
|
-
|
|
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;
|
|
89
|
+
const isFileType = formItem instanceof Blob || formItem instanceof File;
|
|
96
90
|
formData.append(key, isFileType ? formItem : this.stringifyFormItem(formItem));
|
|
97
91
|
}
|
|
98
92
|
return formData;
|
|
@@ -101,7 +95,7 @@ export class HttpClient {
|
|
|
101
95
|
}
|
|
102
96
|
/**
|
|
103
97
|
* @title The Big POS API
|
|
104
|
-
* @version v3.11.
|
|
98
|
+
* @version v3.11.2
|
|
105
99
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
106
100
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
107
101
|
*/
|
|
@@ -838,6 +832,20 @@ export class Api extends HttpClient {
|
|
|
838
832
|
* @response `403` `ProblemDetails` Forbidden
|
|
839
833
|
*/
|
|
840
834
|
backfillAiPromptRunVerdicts: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/prompt-runs/backfill-verdicts`, method: "POST", query: query, secure: true, format: "json" }, params)),
|
|
835
|
+
/**
|
|
836
|
+
* No description
|
|
837
|
+
*
|
|
838
|
+
* @tags AiPromptRunAdmin
|
|
839
|
+
* @name RetryFailedAiPromptRuns
|
|
840
|
+
* @summary Republish the trigger for failed prompt runs so they run again, staggered by spacingSeconds (SuperAdmin)
|
|
841
|
+
* @request POST:/api/ai/prompt-runs/retry-failed
|
|
842
|
+
* @secure
|
|
843
|
+
* @response `200` `AiPromptRunRetry` OK
|
|
844
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
845
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
846
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
847
|
+
*/
|
|
848
|
+
retryFailedAiPromptRuns: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/prompt-runs/retry-failed`, method: "POST", query: query, secure: true, format: "json" }, params)),
|
|
841
849
|
/**
|
|
842
850
|
* No description
|
|
843
851
|
*
|
|
@@ -2723,17 +2731,6 @@ export class Api extends HttpClient {
|
|
|
2723
2731
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
2724
2732
|
*/
|
|
2725
2733
|
updateLoanConsentAndCustomFieldsObsolete: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2726
|
-
/**
|
|
2727
|
-
* No description
|
|
2728
|
-
*
|
|
2729
|
-
* @tags LegacyLoan
|
|
2730
|
-
* @name GetLoansReport
|
|
2731
|
-
* @summary Get Report
|
|
2732
|
-
* @request POST:/api/los/loan/reports
|
|
2733
|
-
* @secure
|
|
2734
|
-
* @response `200` `GetReport` OK
|
|
2735
|
-
*/
|
|
2736
|
-
getLoansReport: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/reports`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2737
2734
|
/**
|
|
2738
2735
|
* No description
|
|
2739
2736
|
*
|