@matech/thebigpos-sdk 2.38.1 → 2.38.2
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/.claude/settings.local.json +13 -0
- package/dist/index.d.ts +223 -17
- package/dist/index.js +113 -8
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +366 -17
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"permissions": {
|
|
3
|
+
"allow": [
|
|
4
|
+
"Bash(npx swagger-typescript-api:*)",
|
|
5
|
+
"Bash(node scripts/apply-json-patch-content-type.js)",
|
|
6
|
+
"Bash(npm version:*)",
|
|
7
|
+
"Bash(npm run:*)",
|
|
8
|
+
"Bash(git commit:*)",
|
|
9
|
+
"Bash(git push:*)",
|
|
10
|
+
"Bash(npm publish:*)"
|
|
11
|
+
]
|
|
12
|
+
}
|
|
13
|
+
}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,12 +1,14 @@
|
|
|
1
1
|
export type VersionStatusType = "Draft" | "Published";
|
|
2
2
|
export type UserRole = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
3
|
+
export type TaskStatus = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
|
|
3
4
|
export type SiteConfigurationType = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
4
|
-
export type SigningMethod = "
|
|
5
|
+
export type SigningMethod = "ConsumerConnect" | "POSF";
|
|
5
6
|
export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
6
7
|
export type LogLevel = "None" | "Info" | "Warning" | "Error";
|
|
7
8
|
export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
|
|
8
9
|
export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
|
|
9
10
|
export type LoanTitleHeld = "Sole" | "JointWithSpouse" | "JointWithOtherThanSpouse";
|
|
11
|
+
export type LoanTaskActivityFilter = "Active" | "Inactive" | "All";
|
|
10
12
|
export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
11
13
|
export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell";
|
|
12
14
|
export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
|
|
@@ -24,7 +26,7 @@ export type LoanNameSuffix = "Jr" | "Sr" | "II" | "III" | "IV" | "V" | "VI" | "V
|
|
|
24
26
|
export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
|
|
25
27
|
export type LoanMilitaryServiceType = "Current" | "RetiredDischargedSeparated" | "NonActivatedNationalGuard" | "SurvivingSpouse";
|
|
26
28
|
export type LoanMaritalStatus = "Married" | "Separated" | "Unmarried";
|
|
27
|
-
export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated";
|
|
29
|
+
export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation";
|
|
28
30
|
export type LoanLienPosition = "First" | "Subordinate";
|
|
29
31
|
export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
|
|
30
32
|
export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other";
|
|
@@ -49,6 +51,7 @@ export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "R
|
|
|
49
51
|
export type EncompassLogOutcome = "Success" | "Failure" | "PartialSuccess";
|
|
50
52
|
export type EncompassLogOperationType = "FieldUpdate" | "EConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
|
|
51
53
|
export type DraftType = "NewLoan" | "EditLoan";
|
|
54
|
+
export type ConsumerConnectAssociationStatus = "Legacy" | "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure";
|
|
52
55
|
export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
53
56
|
export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
|
|
54
57
|
export type BranchType = "Mortgage" | "RealEstate";
|
|
@@ -419,6 +422,10 @@ export interface Attachment {
|
|
|
419
422
|
fileName: string;
|
|
420
423
|
base64Data: string;
|
|
421
424
|
}
|
|
425
|
+
export interface AuditEntityType {
|
|
426
|
+
entityType: string;
|
|
427
|
+
rootEntityType?: string | null;
|
|
428
|
+
}
|
|
422
429
|
export interface AuditLogEntry {
|
|
423
430
|
/** @format uuid */
|
|
424
431
|
id: string;
|
|
@@ -451,9 +458,6 @@ export interface AuditLogSearchCriteria {
|
|
|
451
458
|
startDate?: string | null;
|
|
452
459
|
/** @format date-time */
|
|
453
460
|
endDate?: string | null;
|
|
454
|
-
rootEntityType?: string | null;
|
|
455
|
-
/** @format uuid */
|
|
456
|
-
rootEntityId?: string | null;
|
|
457
461
|
}
|
|
458
462
|
export interface AuditLogUser {
|
|
459
463
|
/** @format uuid */
|
|
@@ -639,6 +643,28 @@ export interface ConditionComment {
|
|
|
639
643
|
createdBy: string;
|
|
640
644
|
createdByName: string;
|
|
641
645
|
}
|
|
646
|
+
export interface ConsumerConnectRetry {
|
|
647
|
+
/** @format uuid */
|
|
648
|
+
userLoanId: string;
|
|
649
|
+
email: string;
|
|
650
|
+
status?: ConsumerConnectAssociationStatus | null;
|
|
651
|
+
success: boolean;
|
|
652
|
+
}
|
|
653
|
+
export interface ConsumerConnectStatus {
|
|
654
|
+
/** @format uuid */
|
|
655
|
+
userLoanId: string;
|
|
656
|
+
/** @format uuid */
|
|
657
|
+
userId: string;
|
|
658
|
+
email: string;
|
|
659
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
660
|
+
status?: ConsumerConnectAssociationStatus | null;
|
|
661
|
+
/** @format int32 */
|
|
662
|
+
attemptCount: number;
|
|
663
|
+
/** @format date-time */
|
|
664
|
+
lastAttemptAt?: string | null;
|
|
665
|
+
/** @format date-time */
|
|
666
|
+
nextRetryAt?: string | null;
|
|
667
|
+
}
|
|
642
668
|
export interface ContactInfo {
|
|
643
669
|
phone: string;
|
|
644
670
|
tollFreePhone?: string | null;
|
|
@@ -843,6 +869,9 @@ export interface CreateUserRequest {
|
|
|
843
869
|
userRole: string;
|
|
844
870
|
isInternal?: boolean | null;
|
|
845
871
|
}
|
|
872
|
+
export interface CreateWebhookRequest {
|
|
873
|
+
webhookPath: string;
|
|
874
|
+
}
|
|
846
875
|
export interface CustomLoanData {
|
|
847
876
|
eConsentInformation?: EConsentInformation | null;
|
|
848
877
|
}
|
|
@@ -1183,6 +1212,40 @@ export interface EncompassContact {
|
|
|
1183
1212
|
phone?: string | null;
|
|
1184
1213
|
company?: string | null;
|
|
1185
1214
|
}
|
|
1215
|
+
export interface EncompassCredentialsDetail {
|
|
1216
|
+
/** @format uuid */
|
|
1217
|
+
id: string;
|
|
1218
|
+
/** @format uuid */
|
|
1219
|
+
accountID: string;
|
|
1220
|
+
instanceID: string;
|
|
1221
|
+
loanAssignmentRole?: string | null;
|
|
1222
|
+
loanTemplate?: string | null;
|
|
1223
|
+
defaultLoanOfficerUserName?: string | null;
|
|
1224
|
+
clearStateIfUnlicensed: boolean;
|
|
1225
|
+
baseUrl?: string | null;
|
|
1226
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1227
|
+
subscriptionId?: string | null;
|
|
1228
|
+
environment?: string | null;
|
|
1229
|
+
}
|
|
1230
|
+
export interface EncompassCredentialsRequest {
|
|
1231
|
+
/** @format uuid */
|
|
1232
|
+
id: string;
|
|
1233
|
+
/** @format uuid */
|
|
1234
|
+
accountID: string;
|
|
1235
|
+
instanceID: string;
|
|
1236
|
+
loanAssignmentRole?: string | null;
|
|
1237
|
+
loanTemplate?: string | null;
|
|
1238
|
+
defaultLoanOfficerUserName?: string | null;
|
|
1239
|
+
clearStateIfUnlicensed: boolean;
|
|
1240
|
+
baseUrl?: string | null;
|
|
1241
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1242
|
+
subscriptionId?: string | null;
|
|
1243
|
+
environment?: string | null;
|
|
1244
|
+
clientID?: string | null;
|
|
1245
|
+
clientSecret?: string | null;
|
|
1246
|
+
signingKeyId?: string | null;
|
|
1247
|
+
signingKey?: string | null;
|
|
1248
|
+
}
|
|
1186
1249
|
export interface EncompassError {
|
|
1187
1250
|
errorCode: string;
|
|
1188
1251
|
message: string;
|
|
@@ -1818,7 +1881,7 @@ export interface Loan {
|
|
|
1818
1881
|
nonOwningBorrowers: LoanNonOwningBorrower[];
|
|
1819
1882
|
userLoans: UserLoan[];
|
|
1820
1883
|
contacts: LoanContact[];
|
|
1821
|
-
signingMethod: "
|
|
1884
|
+
signingMethod: "ConsumerConnect" | "POSF";
|
|
1822
1885
|
}
|
|
1823
1886
|
export interface LoanApplication {
|
|
1824
1887
|
/** @format uuid */
|
|
@@ -2841,6 +2904,7 @@ export interface LoanIdentifier {
|
|
|
2841
2904
|
/** @format uuid */
|
|
2842
2905
|
id: string;
|
|
2843
2906
|
losLoanID: string;
|
|
2907
|
+
number?: string | null;
|
|
2844
2908
|
}
|
|
2845
2909
|
export interface LoanImport {
|
|
2846
2910
|
/** @format uuid */
|
|
@@ -2917,7 +2981,7 @@ export interface LoanLog {
|
|
|
2917
2981
|
/** @format uuid */
|
|
2918
2982
|
id: string;
|
|
2919
2983
|
level: "None" | "Info" | "Warning" | "Error";
|
|
2920
|
-
type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated";
|
|
2984
|
+
type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation";
|
|
2921
2985
|
message: string;
|
|
2922
2986
|
/** @format date-time */
|
|
2923
2987
|
createdAt: string;
|
|
@@ -2926,7 +2990,7 @@ export interface LoanLogDetail {
|
|
|
2926
2990
|
/** @format uuid */
|
|
2927
2991
|
id: string;
|
|
2928
2992
|
level: "None" | "Info" | "Warning" | "Error";
|
|
2929
|
-
type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated";
|
|
2993
|
+
type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation";
|
|
2930
2994
|
message: string;
|
|
2931
2995
|
/** @format date-time */
|
|
2932
2996
|
createdAt: string;
|
|
@@ -3181,6 +3245,16 @@ export interface LoanSearchCriteria {
|
|
|
3181
3245
|
export interface LoanSettings {
|
|
3182
3246
|
excludeFromAutoTaskReminders: boolean;
|
|
3183
3247
|
}
|
|
3248
|
+
export interface LoanTaskSearchRequest {
|
|
3249
|
+
searchText?: string | null;
|
|
3250
|
+
statuses?: TaskStatus[] | null;
|
|
3251
|
+
loanNumber?: string | null;
|
|
3252
|
+
/** @format uuid */
|
|
3253
|
+
borrowerId?: string | null;
|
|
3254
|
+
/** @format uuid */
|
|
3255
|
+
loanId?: string | null;
|
|
3256
|
+
loanStatus?: LoanTaskActivityFilter | null;
|
|
3257
|
+
}
|
|
3184
3258
|
export interface LoanUser {
|
|
3185
3259
|
/** @format uuid */
|
|
3186
3260
|
id: string;
|
|
@@ -3194,6 +3268,13 @@ export interface LoanUser {
|
|
|
3194
3268
|
/** @format date-time */
|
|
3195
3269
|
createdAt: string;
|
|
3196
3270
|
}
|
|
3271
|
+
export interface LosCredentials {
|
|
3272
|
+
/** @format uuid */
|
|
3273
|
+
id: string;
|
|
3274
|
+
/** @format uuid */
|
|
3275
|
+
accountID: string;
|
|
3276
|
+
instanceID: string;
|
|
3277
|
+
}
|
|
3197
3278
|
export interface LosLoanCreationRequest {
|
|
3198
3279
|
loanOfficerUserName?: string | null;
|
|
3199
3280
|
loanTemplate?: string | null;
|
|
@@ -3205,6 +3286,14 @@ export interface LosLoanCreationRequest {
|
|
|
3205
3286
|
siteID?: string | null;
|
|
3206
3287
|
existingLoanID?: string | null;
|
|
3207
3288
|
}
|
|
3289
|
+
export interface LosWebhook {
|
|
3290
|
+
/** @format uuid */
|
|
3291
|
+
id: string;
|
|
3292
|
+
endpoint: string;
|
|
3293
|
+
resource: string;
|
|
3294
|
+
events: string[];
|
|
3295
|
+
enableSubscription: boolean;
|
|
3296
|
+
}
|
|
3208
3297
|
export interface MdmUser {
|
|
3209
3298
|
user_email?: string | null;
|
|
3210
3299
|
user_id?: string | null;
|
|
@@ -5110,7 +5199,6 @@ export interface UserLoanTask {
|
|
|
5110
5199
|
value?: string | null;
|
|
5111
5200
|
documents: LoanDocument[];
|
|
5112
5201
|
loan: LoanIdentifier;
|
|
5113
|
-
/** @deprecated */
|
|
5114
5202
|
loanID: string;
|
|
5115
5203
|
/** @format date-time */
|
|
5116
5204
|
completedDate?: string | null;
|
|
@@ -5122,6 +5210,12 @@ export interface UserLoanTask {
|
|
|
5122
5210
|
/** @format int32 */
|
|
5123
5211
|
commentsCount: number;
|
|
5124
5212
|
}
|
|
5213
|
+
export interface UserLoanTaskPaginated {
|
|
5214
|
+
rows: UserLoanTask[];
|
|
5215
|
+
pagination: Pagination;
|
|
5216
|
+
/** @format int64 */
|
|
5217
|
+
count: number;
|
|
5218
|
+
}
|
|
5125
5219
|
export interface UserLoanTaskRequest {
|
|
5126
5220
|
value?: string | null;
|
|
5127
5221
|
/**
|
|
@@ -5305,7 +5399,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
5305
5399
|
}
|
|
5306
5400
|
/**
|
|
5307
5401
|
* @title The Big POS API
|
|
5308
|
-
* @version v2.38.
|
|
5402
|
+
* @version v2.38.1
|
|
5309
5403
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
5310
5404
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
5311
5405
|
*/
|
|
@@ -5461,6 +5555,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5461
5555
|
sortBy?: string;
|
|
5462
5556
|
sortDirection?: string;
|
|
5463
5557
|
}, params?: RequestParams) => Promise<AxiosResponse<AuditLogEntryPaginated, any>>;
|
|
5558
|
+
/**
|
|
5559
|
+
* No description
|
|
5560
|
+
*
|
|
5561
|
+
* @tags AuditLog
|
|
5562
|
+
* @name GetAuditLogEntityTypes
|
|
5563
|
+
* @summary Get entity types
|
|
5564
|
+
* @request GET:/api/audit-logs/entity-types
|
|
5565
|
+
* @secure
|
|
5566
|
+
* @response `200` `(AuditEntityType)[]` Success
|
|
5567
|
+
*/
|
|
5568
|
+
getAuditLogEntityTypes: (params?: RequestParams) => Promise<AxiosResponse<AuditEntityType[], any>>;
|
|
5464
5569
|
/**
|
|
5465
5570
|
* No description
|
|
5466
5571
|
*
|
|
@@ -5770,6 +5875,28 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5770
5875
|
* @response `200` `ClosedLoansReport` Success
|
|
5771
5876
|
*/
|
|
5772
5877
|
getClosedLoansReport: (data: ClosedLoansReportRequest, params?: RequestParams) => Promise<AxiosResponse<ClosedLoansReport, any>>;
|
|
5878
|
+
/**
|
|
5879
|
+
* No description
|
|
5880
|
+
*
|
|
5881
|
+
* @tags ConsumerConnect
|
|
5882
|
+
* @name GetConsumerConnectStatus
|
|
5883
|
+
* @summary Get Consumer Connect association status for all borrowers on a loan
|
|
5884
|
+
* @request GET:/api/loans/{loanId}/consumer-connect/status
|
|
5885
|
+
* @secure
|
|
5886
|
+
* @response `200` `(ConsumerConnectStatus)[]` Success
|
|
5887
|
+
*/
|
|
5888
|
+
getConsumerConnectStatus: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<ConsumerConnectStatus[], any>>;
|
|
5889
|
+
/**
|
|
5890
|
+
* No description
|
|
5891
|
+
*
|
|
5892
|
+
* @tags ConsumerConnect
|
|
5893
|
+
* @name RetryConsumerConnectAssociation
|
|
5894
|
+
* @summary Manually retry Consumer Connect association for failed borrowers on a loan. Returns per-borrower results; check individual Success fields for partial failures.
|
|
5895
|
+
* @request POST:/api/loans/{loanId}/consumer-connect/retry
|
|
5896
|
+
* @secure
|
|
5897
|
+
* @response `200` `(ConsumerConnectRetry)[]` Success
|
|
5898
|
+
*/
|
|
5899
|
+
retryConsumerConnectAssociation: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<ConsumerConnectRetry[], any>>;
|
|
5773
5900
|
/**
|
|
5774
5901
|
* No description
|
|
5775
5902
|
*
|
|
@@ -7747,9 +7874,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7747
7874
|
*/
|
|
7748
7875
|
sendOutstandingLoanTaskNotification: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
7749
7876
|
/**
|
|
7750
|
-
*
|
|
7877
|
+
* @description Search tasks across all loans
|
|
7751
7878
|
*
|
|
7752
7879
|
* @tags LoanTasks
|
|
7880
|
+
* @name SearchLoanTasks
|
|
7881
|
+
* @summary Search
|
|
7882
|
+
* @request POST:/api/loans/tasks/search
|
|
7883
|
+
* @secure
|
|
7884
|
+
* @response `200` `UserLoanTaskPaginated` Success
|
|
7885
|
+
*/
|
|
7886
|
+
searchLoanTasks: (data: LoanTaskSearchRequest, query?: {
|
|
7887
|
+
/** @format int32 */
|
|
7888
|
+
pageSize?: number;
|
|
7889
|
+
/** @format int32 */
|
|
7890
|
+
pageNumber?: number;
|
|
7891
|
+
sortBy?: string;
|
|
7892
|
+
sortDirection?: string;
|
|
7893
|
+
}, params?: RequestParams) => Promise<AxiosResponse<UserLoanTaskPaginated, any>>;
|
|
7894
|
+
/**
|
|
7895
|
+
* No description
|
|
7896
|
+
*
|
|
7897
|
+
* @tags LoanTasksForSingleLoan
|
|
7753
7898
|
* @name GetLoanTasks
|
|
7754
7899
|
* @summary Get All
|
|
7755
7900
|
* @request GET:/api/loans/{loanID}/tasks
|
|
@@ -7761,7 +7906,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7761
7906
|
/**
|
|
7762
7907
|
* No description
|
|
7763
7908
|
*
|
|
7764
|
-
* @tags
|
|
7909
|
+
* @tags LoanTasksForSingleLoan
|
|
7765
7910
|
* @name GetLoanTask
|
|
7766
7911
|
* @summary Get by ID
|
|
7767
7912
|
* @request GET:/api/loans/{loanID}/tasks/{id}
|
|
@@ -7773,7 +7918,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7773
7918
|
/**
|
|
7774
7919
|
* @description Get the difference between the current loan tasks and the tasks generated by business rules
|
|
7775
7920
|
*
|
|
7776
|
-
* @tags
|
|
7921
|
+
* @tags LoanTasksForSingleLoan
|
|
7777
7922
|
* @name GetLoanTaskDifference
|
|
7778
7923
|
* @summary Get Difference
|
|
7779
7924
|
* @request GET:/api/loans/{loanID}/tasks/diff
|
|
@@ -7785,7 +7930,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7785
7930
|
/**
|
|
7786
7931
|
* No description
|
|
7787
7932
|
*
|
|
7788
|
-
* @tags
|
|
7933
|
+
* @tags LoanTasksForSingleLoan
|
|
7789
7934
|
* @name CreateLoanTask
|
|
7790
7935
|
* @summary Create
|
|
7791
7936
|
* @request POST:/api/loans/{loanID}/tasks/{taskID}
|
|
@@ -7797,7 +7942,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7797
7942
|
/**
|
|
7798
7943
|
* No description
|
|
7799
7944
|
*
|
|
7800
|
-
* @tags
|
|
7945
|
+
* @tags LoanTasksForSingleLoan
|
|
7801
7946
|
* @name ImportLoanTask
|
|
7802
7947
|
* @summary Import
|
|
7803
7948
|
* @request POST:/api/loans/{loanID}/tasks/import
|
|
@@ -7809,7 +7954,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7809
7954
|
/**
|
|
7810
7955
|
* No description
|
|
7811
7956
|
*
|
|
7812
|
-
* @tags
|
|
7957
|
+
* @tags LoanTasksForSingleLoan
|
|
7813
7958
|
* @name ReplaceLoanTask
|
|
7814
7959
|
* @summary Replace
|
|
7815
7960
|
* @request PUT:/api/loans/{loanID}/tasks/{userLoanTaskID}
|
|
@@ -7821,7 +7966,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7821
7966
|
/**
|
|
7822
7967
|
* No description
|
|
7823
7968
|
*
|
|
7824
|
-
* @tags
|
|
7969
|
+
* @tags LoanTasksForSingleLoan
|
|
7825
7970
|
* @name DeleteLoanTask
|
|
7826
7971
|
* @summary Delete
|
|
7827
7972
|
* @request DELETE:/api/loans/{loanID}/tasks/{userLoanTaskID}
|
|
@@ -8571,6 +8716,67 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8571
8716
|
sortBy?: string;
|
|
8572
8717
|
sortDirection?: string;
|
|
8573
8718
|
}, data: EncompassLogSearchCriteria, params?: RequestParams) => Promise<AxiosResponse<EncompassRequestLogPaginated, any>>;
|
|
8719
|
+
/**
|
|
8720
|
+
* No description
|
|
8721
|
+
*
|
|
8722
|
+
* @tags TheBigPOS
|
|
8723
|
+
* @name GetEncompassCredentials
|
|
8724
|
+
* @request GET:/api/los/encompass/credentials
|
|
8725
|
+
* @secure
|
|
8726
|
+
* @response `200` `EncompassCredentialsDetail` Success
|
|
8727
|
+
* @response `204` `void` No Content
|
|
8728
|
+
*/
|
|
8729
|
+
getEncompassCredentials: (params?: RequestParams) => Promise<AxiosResponse<EncompassCredentialsDetail, any>>;
|
|
8730
|
+
/**
|
|
8731
|
+
* No description
|
|
8732
|
+
*
|
|
8733
|
+
* @tags TheBigPOS
|
|
8734
|
+
* @name CreateEncompassCredentials
|
|
8735
|
+
* @request POST:/api/los/encompass/credentials
|
|
8736
|
+
* @secure
|
|
8737
|
+
* @response `201` `LosCredentials` Created
|
|
8738
|
+
*/
|
|
8739
|
+
createEncompassCredentials: (data: EncompassCredentialsRequest, params?: RequestParams) => Promise<AxiosResponse<LosCredentials, any>>;
|
|
8740
|
+
/**
|
|
8741
|
+
* No description
|
|
8742
|
+
*
|
|
8743
|
+
* @tags TheBigPOS
|
|
8744
|
+
* @name UpdateEncompassCredentials
|
|
8745
|
+
* @request PUT:/api/los/encompass/credentials
|
|
8746
|
+
* @secure
|
|
8747
|
+
* @response `200` `EncompassCredentialsDetail` Success
|
|
8748
|
+
*/
|
|
8749
|
+
updateEncompassCredentials: (data: EncompassCredentialsRequest, params?: RequestParams) => Promise<AxiosResponse<EncompassCredentialsDetail, any>>;
|
|
8750
|
+
/**
|
|
8751
|
+
* No description
|
|
8752
|
+
*
|
|
8753
|
+
* @tags TheBigPOS
|
|
8754
|
+
* @name GetEncompassWebhooks
|
|
8755
|
+
* @request GET:/api/los/encompass/webhooks
|
|
8756
|
+
* @secure
|
|
8757
|
+
* @response `200` `(LosWebhook)[]` Success
|
|
8758
|
+
*/
|
|
8759
|
+
getEncompassWebhooks: (params?: RequestParams) => Promise<AxiosResponse<LosWebhook[], any>>;
|
|
8760
|
+
/**
|
|
8761
|
+
* No description
|
|
8762
|
+
*
|
|
8763
|
+
* @tags TheBigPOS
|
|
8764
|
+
* @name CreateEncompassWebhook
|
|
8765
|
+
* @request POST:/api/los/encompass/webhooks
|
|
8766
|
+
* @secure
|
|
8767
|
+
* @response `201` `LosWebhook` Created
|
|
8768
|
+
*/
|
|
8769
|
+
createEncompassWebhook: (data: CreateWebhookRequest, params?: RequestParams) => Promise<AxiosResponse<LosWebhook, any>>;
|
|
8770
|
+
/**
|
|
8771
|
+
* No description
|
|
8772
|
+
*
|
|
8773
|
+
* @tags TheBigPOS
|
|
8774
|
+
* @name DeleteEncompassWebhook
|
|
8775
|
+
* @request DELETE:/api/los/encompass/webhooks/{webhookId}
|
|
8776
|
+
* @secure
|
|
8777
|
+
* @response `204` `void` No Content
|
|
8778
|
+
*/
|
|
8779
|
+
deleteEncompassWebhook: (webhookId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
8574
8780
|
/**
|
|
8575
8781
|
* No description
|
|
8576
8782
|
*
|
package/dist/index.js
CHANGED
|
@@ -104,7 +104,7 @@ export class HttpClient {
|
|
|
104
104
|
}
|
|
105
105
|
/**
|
|
106
106
|
* @title The Big POS API
|
|
107
|
-
* @version v2.38.
|
|
107
|
+
* @version v2.38.1
|
|
108
108
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
109
109
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
110
110
|
*/
|
|
@@ -252,6 +252,17 @@ export class Api extends HttpClient {
|
|
|
252
252
|
* @response `200` `AuditLogEntryPaginated` Success
|
|
253
253
|
*/
|
|
254
254
|
searchAuditLogs: (data, query, params = {}) => this.request(Object.assign({ path: `/api/audit-logs/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
255
|
+
/**
|
|
256
|
+
* No description
|
|
257
|
+
*
|
|
258
|
+
* @tags AuditLog
|
|
259
|
+
* @name GetAuditLogEntityTypes
|
|
260
|
+
* @summary Get entity types
|
|
261
|
+
* @request GET:/api/audit-logs/entity-types
|
|
262
|
+
* @secure
|
|
263
|
+
* @response `200` `(AuditEntityType)[]` Success
|
|
264
|
+
*/
|
|
265
|
+
getAuditLogEntityTypes: (params = {}) => this.request(Object.assign({ path: `/api/audit-logs/entity-types`, method: "GET", secure: true, format: "json" }, params)),
|
|
255
266
|
/**
|
|
256
267
|
* No description
|
|
257
268
|
*
|
|
@@ -542,6 +553,28 @@ export class Api extends HttpClient {
|
|
|
542
553
|
* @response `200` `ClosedLoansReport` Success
|
|
543
554
|
*/
|
|
544
555
|
getClosedLoansReport: (data, params = {}) => this.request(Object.assign({ path: `/api/loans/reports/closed-loans`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
556
|
+
/**
|
|
557
|
+
* No description
|
|
558
|
+
*
|
|
559
|
+
* @tags ConsumerConnect
|
|
560
|
+
* @name GetConsumerConnectStatus
|
|
561
|
+
* @summary Get Consumer Connect association status for all borrowers on a loan
|
|
562
|
+
* @request GET:/api/loans/{loanId}/consumer-connect/status
|
|
563
|
+
* @secure
|
|
564
|
+
* @response `200` `(ConsumerConnectStatus)[]` Success
|
|
565
|
+
*/
|
|
566
|
+
getConsumerConnectStatus: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/consumer-connect/status`, method: "GET", secure: true, format: "json" }, params)),
|
|
567
|
+
/**
|
|
568
|
+
* No description
|
|
569
|
+
*
|
|
570
|
+
* @tags ConsumerConnect
|
|
571
|
+
* @name RetryConsumerConnectAssociation
|
|
572
|
+
* @summary Manually retry Consumer Connect association for failed borrowers on a loan. Returns per-borrower results; check individual Success fields for partial failures.
|
|
573
|
+
* @request POST:/api/loans/{loanId}/consumer-connect/retry
|
|
574
|
+
* @secure
|
|
575
|
+
* @response `200` `(ConsumerConnectRetry)[]` Success
|
|
576
|
+
*/
|
|
577
|
+
retryConsumerConnectAssociation: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/consumer-connect/retry`, method: "POST", secure: true, format: "json" }, params)),
|
|
545
578
|
/**
|
|
546
579
|
* No description
|
|
547
580
|
*
|
|
@@ -2289,9 +2322,20 @@ export class Api extends HttpClient {
|
|
|
2289
2322
|
*/
|
|
2290
2323
|
sendOutstandingLoanTaskNotification: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/reminders/outstanding`, method: "POST", secure: true }, params)),
|
|
2291
2324
|
/**
|
|
2292
|
-
*
|
|
2325
|
+
* @description Search tasks across all loans
|
|
2293
2326
|
*
|
|
2294
2327
|
* @tags LoanTasks
|
|
2328
|
+
* @name SearchLoanTasks
|
|
2329
|
+
* @summary Search
|
|
2330
|
+
* @request POST:/api/loans/tasks/search
|
|
2331
|
+
* @secure
|
|
2332
|
+
* @response `200` `UserLoanTaskPaginated` Success
|
|
2333
|
+
*/
|
|
2334
|
+
searchLoanTasks: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/tasks/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
2335
|
+
/**
|
|
2336
|
+
* No description
|
|
2337
|
+
*
|
|
2338
|
+
* @tags LoanTasksForSingleLoan
|
|
2295
2339
|
* @name GetLoanTasks
|
|
2296
2340
|
* @summary Get All
|
|
2297
2341
|
* @request GET:/api/loans/{loanID}/tasks
|
|
@@ -2303,7 +2347,7 @@ export class Api extends HttpClient {
|
|
|
2303
2347
|
/**
|
|
2304
2348
|
* No description
|
|
2305
2349
|
*
|
|
2306
|
-
* @tags
|
|
2350
|
+
* @tags LoanTasksForSingleLoan
|
|
2307
2351
|
* @name GetLoanTask
|
|
2308
2352
|
* @summary Get by ID
|
|
2309
2353
|
* @request GET:/api/loans/{loanID}/tasks/{id}
|
|
@@ -2315,7 +2359,7 @@ export class Api extends HttpClient {
|
|
|
2315
2359
|
/**
|
|
2316
2360
|
* @description Get the difference between the current loan tasks and the tasks generated by business rules
|
|
2317
2361
|
*
|
|
2318
|
-
* @tags
|
|
2362
|
+
* @tags LoanTasksForSingleLoan
|
|
2319
2363
|
* @name GetLoanTaskDifference
|
|
2320
2364
|
* @summary Get Difference
|
|
2321
2365
|
* @request GET:/api/loans/{loanID}/tasks/diff
|
|
@@ -2327,7 +2371,7 @@ export class Api extends HttpClient {
|
|
|
2327
2371
|
/**
|
|
2328
2372
|
* No description
|
|
2329
2373
|
*
|
|
2330
|
-
* @tags
|
|
2374
|
+
* @tags LoanTasksForSingleLoan
|
|
2331
2375
|
* @name CreateLoanTask
|
|
2332
2376
|
* @summary Create
|
|
2333
2377
|
* @request POST:/api/loans/{loanID}/tasks/{taskID}
|
|
@@ -2339,7 +2383,7 @@ export class Api extends HttpClient {
|
|
|
2339
2383
|
/**
|
|
2340
2384
|
* No description
|
|
2341
2385
|
*
|
|
2342
|
-
* @tags
|
|
2386
|
+
* @tags LoanTasksForSingleLoan
|
|
2343
2387
|
* @name ImportLoanTask
|
|
2344
2388
|
* @summary Import
|
|
2345
2389
|
* @request POST:/api/loans/{loanID}/tasks/import
|
|
@@ -2351,7 +2395,7 @@ export class Api extends HttpClient {
|
|
|
2351
2395
|
/**
|
|
2352
2396
|
* No description
|
|
2353
2397
|
*
|
|
2354
|
-
* @tags
|
|
2398
|
+
* @tags LoanTasksForSingleLoan
|
|
2355
2399
|
* @name ReplaceLoanTask
|
|
2356
2400
|
* @summary Replace
|
|
2357
2401
|
* @request PUT:/api/loans/{loanID}/tasks/{userLoanTaskID}
|
|
@@ -2363,7 +2407,7 @@ export class Api extends HttpClient {
|
|
|
2363
2407
|
/**
|
|
2364
2408
|
* No description
|
|
2365
2409
|
*
|
|
2366
|
-
* @tags
|
|
2410
|
+
* @tags LoanTasksForSingleLoan
|
|
2367
2411
|
* @name DeleteLoanTask
|
|
2368
2412
|
* @summary Delete
|
|
2369
2413
|
* @request DELETE:/api/loans/{loanID}/tasks/{userLoanTaskID}
|
|
@@ -3052,6 +3096,67 @@ export class Api extends HttpClient {
|
|
|
3052
3096
|
* @response `200` `EncompassRequestLogPaginated` Success
|
|
3053
3097
|
*/
|
|
3054
3098
|
searchEncompassLogs: (losId, query, data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/logs/${losId}/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
3099
|
+
/**
|
|
3100
|
+
* No description
|
|
3101
|
+
*
|
|
3102
|
+
* @tags TheBigPOS
|
|
3103
|
+
* @name GetEncompassCredentials
|
|
3104
|
+
* @request GET:/api/los/encompass/credentials
|
|
3105
|
+
* @secure
|
|
3106
|
+
* @response `200` `EncompassCredentialsDetail` Success
|
|
3107
|
+
* @response `204` `void` No Content
|
|
3108
|
+
*/
|
|
3109
|
+
getEncompassCredentials: (params = {}) => this.request(Object.assign({ path: `/api/los/encompass/credentials`, method: "GET", secure: true, format: "json" }, params)),
|
|
3110
|
+
/**
|
|
3111
|
+
* No description
|
|
3112
|
+
*
|
|
3113
|
+
* @tags TheBigPOS
|
|
3114
|
+
* @name CreateEncompassCredentials
|
|
3115
|
+
* @request POST:/api/los/encompass/credentials
|
|
3116
|
+
* @secure
|
|
3117
|
+
* @response `201` `LosCredentials` Created
|
|
3118
|
+
*/
|
|
3119
|
+
createEncompassCredentials: (data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/credentials`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
3120
|
+
/**
|
|
3121
|
+
* No description
|
|
3122
|
+
*
|
|
3123
|
+
* @tags TheBigPOS
|
|
3124
|
+
* @name UpdateEncompassCredentials
|
|
3125
|
+
* @request PUT:/api/los/encompass/credentials
|
|
3126
|
+
* @secure
|
|
3127
|
+
* @response `200` `EncompassCredentialsDetail` Success
|
|
3128
|
+
*/
|
|
3129
|
+
updateEncompassCredentials: (data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/credentials`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
3130
|
+
/**
|
|
3131
|
+
* No description
|
|
3132
|
+
*
|
|
3133
|
+
* @tags TheBigPOS
|
|
3134
|
+
* @name GetEncompassWebhooks
|
|
3135
|
+
* @request GET:/api/los/encompass/webhooks
|
|
3136
|
+
* @secure
|
|
3137
|
+
* @response `200` `(LosWebhook)[]` Success
|
|
3138
|
+
*/
|
|
3139
|
+
getEncompassWebhooks: (params = {}) => this.request(Object.assign({ path: `/api/los/encompass/webhooks`, method: "GET", secure: true, format: "json" }, params)),
|
|
3140
|
+
/**
|
|
3141
|
+
* No description
|
|
3142
|
+
*
|
|
3143
|
+
* @tags TheBigPOS
|
|
3144
|
+
* @name CreateEncompassWebhook
|
|
3145
|
+
* @request POST:/api/los/encompass/webhooks
|
|
3146
|
+
* @secure
|
|
3147
|
+
* @response `201` `LosWebhook` Created
|
|
3148
|
+
*/
|
|
3149
|
+
createEncompassWebhook: (data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/webhooks`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
3150
|
+
/**
|
|
3151
|
+
* No description
|
|
3152
|
+
*
|
|
3153
|
+
* @tags TheBigPOS
|
|
3154
|
+
* @name DeleteEncompassWebhook
|
|
3155
|
+
* @request DELETE:/api/los/encompass/webhooks/{webhookId}
|
|
3156
|
+
* @secure
|
|
3157
|
+
* @response `204` `void` No Content
|
|
3158
|
+
*/
|
|
3159
|
+
deleteEncompassWebhook: (webhookId, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/webhooks/${webhookId}`, method: "DELETE", secure: true }, params)),
|
|
3055
3160
|
/**
|
|
3056
3161
|
* No description
|
|
3057
3162
|
*
|