@matech/thebigpos-sdk 2.40.0-rc.0 → 2.40.0-rc.1
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 +3 -1
- package/dist/index.d.ts +184 -15
- package/dist/index.js +120 -3
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +304 -15
package/dist/index.d.ts
CHANGED
|
@@ -4,13 +4,14 @@ export type TaskStatus = "Outstanding" | "Pending" | "Completed" | "Rejected" |
|
|
|
4
4
|
export type SiteConfigurationType = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
5
5
|
export type SigningMethod = "ConsumerConnect" | "POSF";
|
|
6
6
|
export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
7
|
+
export type LosSyncStepSeverity = "Success" | "Info" | "Warning" | "Error";
|
|
7
8
|
export type LosOperationStatus = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
|
|
8
9
|
export type LogLevel = "None" | "Info" | "Warning" | "Error";
|
|
9
10
|
export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
|
|
10
11
|
export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
|
|
11
12
|
export type LoanTitleHeld = "Sole" | "JointWithSpouse" | "JointWithOtherThanSpouse";
|
|
12
13
|
export type LoanTaskActivityFilter = "Active" | "Inactive" | "All";
|
|
13
|
-
export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
14
|
+
export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
14
15
|
export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell";
|
|
15
16
|
export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
|
|
16
17
|
export type LoanQueueReason = "Unknown" | "Locked" | "LOSError" | "Exception";
|
|
@@ -46,6 +47,7 @@ export type LoanAsianRace = "AsianIndian" | "Chinese" | "Filipino" | "Japanese"
|
|
|
46
47
|
export type LoanAccountAssetType = "Checking" | "Savings" | "MoneyMarket" | "CertificateOfDeposit" | "MutualFund" | "Stocks" | "Bonds" | "Retirement" | "BridgeLoanProceeds" | "IndividualDevelopmentAccount" | "TrustAccount" | "CashValueOfLifeInsurance" | "Other";
|
|
47
48
|
export type LoanAccessScopeType = "User" | "Branch";
|
|
48
49
|
export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Failed" | "FailedPermanently" | "Uploaded" | "PendingSync";
|
|
50
|
+
export type FolderPermissionLevel = "None" | "Read" | "Write" | "Manage";
|
|
49
51
|
export type FilterType = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
50
52
|
export type Environment = "Development" | "Staging" | "UAT" | "Production";
|
|
51
53
|
export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
|
|
@@ -797,7 +799,7 @@ export interface CreateDocumentTemplateRequest {
|
|
|
797
799
|
export interface CreateGroupMemberRequest {
|
|
798
800
|
/** @format uuid */
|
|
799
801
|
userId: string;
|
|
800
|
-
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
802
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
801
803
|
}
|
|
802
804
|
export interface CreateInviteRequest {
|
|
803
805
|
/** @minLength 1 */
|
|
@@ -817,6 +819,14 @@ export interface CreateInviteRequest {
|
|
|
817
819
|
userRole?: UserRole | null;
|
|
818
820
|
loanRole?: LoanRole | null;
|
|
819
821
|
}
|
|
822
|
+
export interface CreateLoanDocumentFolderRequest {
|
|
823
|
+
/**
|
|
824
|
+
* @minLength 1
|
|
825
|
+
* @maxLength 250
|
|
826
|
+
*/
|
|
827
|
+
name: string;
|
|
828
|
+
permissions: LoanDocumentFolderPermissionRequest[];
|
|
829
|
+
}
|
|
820
830
|
export interface CreateLoanImportRequest {
|
|
821
831
|
/** @format uuid */
|
|
822
832
|
accountID: string;
|
|
@@ -848,7 +858,7 @@ export interface CreateUserDeviceRequest {
|
|
|
848
858
|
token: string;
|
|
849
859
|
}
|
|
850
860
|
export interface CreateUserDraft {
|
|
851
|
-
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
861
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
852
862
|
}
|
|
853
863
|
export interface CreateUserGroupRequest {
|
|
854
864
|
/**
|
|
@@ -1278,7 +1288,6 @@ export interface EnabledServices {
|
|
|
1278
1288
|
fullApp?: boolean | null;
|
|
1279
1289
|
mobileApp?: boolean | null;
|
|
1280
1290
|
ringCentral?: boolean | null;
|
|
1281
|
-
rates?: boolean | null;
|
|
1282
1291
|
socialSurvey?: boolean | null;
|
|
1283
1292
|
borrowerTasks?: boolean | null;
|
|
1284
1293
|
docusign?: boolean | null;
|
|
@@ -2930,7 +2939,7 @@ export interface LoanContact {
|
|
|
2930
2939
|
email?: string | null;
|
|
2931
2940
|
phone?: string | null;
|
|
2932
2941
|
companyName?: string | null;
|
|
2933
|
-
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
2942
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
2934
2943
|
}
|
|
2935
2944
|
export interface LoanContactList {
|
|
2936
2945
|
email: string;
|
|
@@ -2958,6 +2967,39 @@ export interface LoanDocument {
|
|
|
2958
2967
|
/** @format date-time */
|
|
2959
2968
|
sensitiveDataPurgedOn?: string | null;
|
|
2960
2969
|
}
|
|
2970
|
+
export interface LoanDocumentFolder {
|
|
2971
|
+
/** @format uuid */
|
|
2972
|
+
id: string;
|
|
2973
|
+
/** @format uuid */
|
|
2974
|
+
accountID: string;
|
|
2975
|
+
name: string;
|
|
2976
|
+
isSystemDefault: boolean;
|
|
2977
|
+
isActive: boolean;
|
|
2978
|
+
/** @format date-time */
|
|
2979
|
+
createdAt: string;
|
|
2980
|
+
/** @format date-time */
|
|
2981
|
+
updatedAt?: string | null;
|
|
2982
|
+
/** @format date-time */
|
|
2983
|
+
deletedAt?: string | null;
|
|
2984
|
+
permissions: LoanDocumentFolderPermission[];
|
|
2985
|
+
}
|
|
2986
|
+
export interface LoanDocumentFolderPermission {
|
|
2987
|
+
/** @format uuid */
|
|
2988
|
+
id: string;
|
|
2989
|
+
/** @format uuid */
|
|
2990
|
+
loanDocumentFolderID: string;
|
|
2991
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
2992
|
+
level: "None" | "Read" | "Write" | "Manage";
|
|
2993
|
+
}
|
|
2994
|
+
export interface LoanDocumentFolderPermissionRequest {
|
|
2995
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
2996
|
+
level: "None" | "Read" | "Write" | "Manage";
|
|
2997
|
+
}
|
|
2998
|
+
export interface LoanDocumentFolderUsage {
|
|
2999
|
+
/** @format uuid */
|
|
3000
|
+
folderID: string;
|
|
3001
|
+
hasEverBeenReferenced: boolean;
|
|
3002
|
+
}
|
|
2961
3003
|
export interface LoanDocumentPreviewsRequest {
|
|
2962
3004
|
documentIds: string[];
|
|
2963
3005
|
}
|
|
@@ -3408,7 +3450,7 @@ export interface LoanUser {
|
|
|
3408
3450
|
email: string;
|
|
3409
3451
|
phone?: string | null;
|
|
3410
3452
|
role: string;
|
|
3411
|
-
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
3453
|
+
loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
3412
3454
|
isUser: boolean;
|
|
3413
3455
|
/** @format date-time */
|
|
3414
3456
|
createdAt: string;
|
|
@@ -3468,6 +3510,7 @@ export interface LosSync {
|
|
|
3468
3510
|
/** @format uuid */
|
|
3469
3511
|
loanId?: string | null;
|
|
3470
3512
|
direction: string;
|
|
3513
|
+
eventType?: string | null;
|
|
3471
3514
|
currentState: string;
|
|
3472
3515
|
encompassLoanId?: string | null;
|
|
3473
3516
|
encompassLoanNumber?: string | null;
|
|
@@ -3498,12 +3541,13 @@ export interface LosSyncSearchCriteria {
|
|
|
3498
3541
|
dateTo?: string | null;
|
|
3499
3542
|
}
|
|
3500
3543
|
export interface LosSyncStep {
|
|
3501
|
-
name: string;
|
|
3502
|
-
completed: boolean;
|
|
3503
|
-
/** @format date-time */
|
|
3504
|
-
completedAtUtc?: string | null;
|
|
3505
3544
|
/** @format int32 */
|
|
3506
3545
|
order: number;
|
|
3546
|
+
name: string;
|
|
3547
|
+
severity: "Success" | "Info" | "Warning" | "Error";
|
|
3548
|
+
message: string;
|
|
3549
|
+
/** @format date-time */
|
|
3550
|
+
atUtc: string;
|
|
3507
3551
|
}
|
|
3508
3552
|
export interface LosWebhook {
|
|
3509
3553
|
/** @format uuid */
|
|
@@ -5118,6 +5162,14 @@ export interface UpdateListingPhotoRequest {
|
|
|
5118
5162
|
/** @format int32 */
|
|
5119
5163
|
weight: number;
|
|
5120
5164
|
}
|
|
5165
|
+
export interface UpdateLoanDocumentFolderRequest {
|
|
5166
|
+
/**
|
|
5167
|
+
* @minLength 1
|
|
5168
|
+
* @maxLength 250
|
|
5169
|
+
*/
|
|
5170
|
+
name: string;
|
|
5171
|
+
permissions: LoanDocumentFolderPermissionRequest[];
|
|
5172
|
+
}
|
|
5121
5173
|
export interface UpdateLoanQueueRequest {
|
|
5122
5174
|
data: any;
|
|
5123
5175
|
}
|
|
@@ -5380,7 +5432,7 @@ export interface UserDevice {
|
|
|
5380
5432
|
export interface UserDraft {
|
|
5381
5433
|
/** @format uuid */
|
|
5382
5434
|
draftID: string;
|
|
5383
|
-
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5435
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5384
5436
|
user: User;
|
|
5385
5437
|
}
|
|
5386
5438
|
export interface UserDraftPaginated {
|
|
@@ -5437,7 +5489,7 @@ export interface UserLoan {
|
|
|
5437
5489
|
deletedAt?: string | null;
|
|
5438
5490
|
loanID: string;
|
|
5439
5491
|
user: User;
|
|
5440
|
-
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
|
|
5492
|
+
role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
5441
5493
|
/** @format int32 */
|
|
5442
5494
|
borrowerPair?: number | null;
|
|
5443
5495
|
/** @format int32 */
|
|
@@ -5667,7 +5719,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
5667
5719
|
}
|
|
5668
5720
|
/**
|
|
5669
5721
|
* @title The Big POS API
|
|
5670
|
-
* @version v2.39.
|
|
5722
|
+
* @version v2.39.2
|
|
5671
5723
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
5672
5724
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
5673
5725
|
*/
|
|
@@ -7564,6 +7616,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7564
7616
|
* @response `422` `UnprocessableEntity` Client Error
|
|
7565
7617
|
*/
|
|
7566
7618
|
createLoanComparisonPdf: (loanId: string, data: PostLoanComparisonPdfRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
7619
|
+
/**
|
|
7620
|
+
* No description
|
|
7621
|
+
*
|
|
7622
|
+
* @tags LoanConsents
|
|
7623
|
+
* @name ResyncLoanConsents
|
|
7624
|
+
* @summary Resync loan consents to LOS
|
|
7625
|
+
* @request POST:/api/loans/{loanId}/consents/resync
|
|
7626
|
+
* @secure
|
|
7627
|
+
* @response `204` `void` No Content
|
|
7628
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7629
|
+
* @response `422` `ProblemDetails` Client Error
|
|
7630
|
+
*/
|
|
7631
|
+
resyncLoanConsents: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
7567
7632
|
/**
|
|
7568
7633
|
* No description
|
|
7569
7634
|
*
|
|
@@ -7636,6 +7701,108 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7636
7701
|
* @response `201` `(string)[]` Created
|
|
7637
7702
|
*/
|
|
7638
7703
|
createLoanDocumentBuckets: (loanId: string, data: string[], params?: RequestParams) => Promise<AxiosResponse<string[], any>>;
|
|
7704
|
+
/**
|
|
7705
|
+
* No description
|
|
7706
|
+
*
|
|
7707
|
+
* @tags LoanDocumentFolders
|
|
7708
|
+
* @name GetLoanDocumentFolders
|
|
7709
|
+
* @summary Get all loan document folders for the current account
|
|
7710
|
+
* @request GET:/api/loan-document-folders
|
|
7711
|
+
* @secure
|
|
7712
|
+
* @response `200` `(LoanDocumentFolder)[]` Success
|
|
7713
|
+
*/
|
|
7714
|
+
getLoanDocumentFolders: (params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolder[], any>>;
|
|
7715
|
+
/**
|
|
7716
|
+
* No description
|
|
7717
|
+
*
|
|
7718
|
+
* @tags LoanDocumentFolders
|
|
7719
|
+
* @name CreateLoanDocumentFolder
|
|
7720
|
+
* @summary Create a loan document folder
|
|
7721
|
+
* @request POST:/api/loan-document-folders
|
|
7722
|
+
* @secure
|
|
7723
|
+
* @response `201` `LoanDocumentFolder` Created
|
|
7724
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7725
|
+
* @response `422` `ProblemDetails` Client Error
|
|
7726
|
+
*/
|
|
7727
|
+
createLoanDocumentFolder: (data: CreateLoanDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolder, any>>;
|
|
7728
|
+
/**
|
|
7729
|
+
* No description
|
|
7730
|
+
*
|
|
7731
|
+
* @tags LoanDocumentFolders
|
|
7732
|
+
* @name GetLoanDocumentFolderById
|
|
7733
|
+
* @summary Get a loan document folder by ID
|
|
7734
|
+
* @request GET:/api/loan-document-folders/{id}
|
|
7735
|
+
* @secure
|
|
7736
|
+
* @response `200` `LoanDocumentFolder` Success
|
|
7737
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7738
|
+
*/
|
|
7739
|
+
getLoanDocumentFolderById: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolder, any>>;
|
|
7740
|
+
/**
|
|
7741
|
+
* No description
|
|
7742
|
+
*
|
|
7743
|
+
* @tags LoanDocumentFolders
|
|
7744
|
+
* @name UpdateLoanDocumentFolder
|
|
7745
|
+
* @summary Update a loan document folder. Blocked when folder has ever been referenced, except for permission edits on the system-default Unassigned folder.
|
|
7746
|
+
* @request PUT:/api/loan-document-folders/{id}
|
|
7747
|
+
* @secure
|
|
7748
|
+
* @response `200` `LoanDocumentFolder` Success
|
|
7749
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7750
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7751
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7752
|
+
* @response `422` `ProblemDetails` Client Error
|
|
7753
|
+
*/
|
|
7754
|
+
updateLoanDocumentFolder: (id: string, data: UpdateLoanDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolder, any>>;
|
|
7755
|
+
/**
|
|
7756
|
+
* No description
|
|
7757
|
+
*
|
|
7758
|
+
* @tags LoanDocumentFolders
|
|
7759
|
+
* @name DeleteLoanDocumentFolder
|
|
7760
|
+
* @summary Delete a loan document folder. Allowed only when the folder has never been referenced and is not the system-default Unassigned folder.
|
|
7761
|
+
* @request DELETE:/api/loan-document-folders/{id}
|
|
7762
|
+
* @secure
|
|
7763
|
+
* @response `204` `void` No Content
|
|
7764
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7765
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7766
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7767
|
+
*/
|
|
7768
|
+
deleteLoanDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
7769
|
+
/**
|
|
7770
|
+
* No description
|
|
7771
|
+
*
|
|
7772
|
+
* @tags LoanDocumentFolders
|
|
7773
|
+
* @name DeactivateLoanDocumentFolder
|
|
7774
|
+
* @summary Deactivate a loan document folder. Rejected for the system-default Unassigned folder.
|
|
7775
|
+
* @request POST:/api/loan-document-folders/{id}/deactivate
|
|
7776
|
+
* @secure
|
|
7777
|
+
* @response `204` `void` No Content
|
|
7778
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7779
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7780
|
+
*/
|
|
7781
|
+
deactivateLoanDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
7782
|
+
/**
|
|
7783
|
+
* No description
|
|
7784
|
+
*
|
|
7785
|
+
* @tags LoanDocumentFolders
|
|
7786
|
+
* @name ReactivateLoanDocumentFolder
|
|
7787
|
+
* @summary Reactivate a loan document folder.
|
|
7788
|
+
* @request POST:/api/loan-document-folders/{id}/reactivate
|
|
7789
|
+
* @secure
|
|
7790
|
+
* @response `204` `void` No Content
|
|
7791
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7792
|
+
*/
|
|
7793
|
+
reactivateLoanDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
7794
|
+
/**
|
|
7795
|
+
* No description
|
|
7796
|
+
*
|
|
7797
|
+
* @tags LoanDocumentFolders
|
|
7798
|
+
* @name GetLoanDocumentFolderUsage
|
|
7799
|
+
* @summary Get folder usage. Returns HasEverBeenReferenced including soft-deleted documents and tasks.
|
|
7800
|
+
* @request GET:/api/loan-document-folders/{id}/usage
|
|
7801
|
+
* @secure
|
|
7802
|
+
* @response `200` `LoanDocumentFolderUsage` Success
|
|
7803
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7804
|
+
*/
|
|
7805
|
+
getLoanDocumentFolderUsage: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolderUsage, any>>;
|
|
7639
7806
|
/**
|
|
7640
7807
|
* No description
|
|
7641
7808
|
*
|
|
@@ -7685,13 +7852,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7685
7852
|
* @description Returns all documents grouped by folder for sidebar display. Use folderNamesOnly=true to get simplified response with folder names and counts for mobile (Files array will be empty).
|
|
7686
7853
|
*
|
|
7687
7854
|
* @tags LoanDocuments
|
|
7688
|
-
* @name
|
|
7855
|
+
* @name GetLoanDocumentFolders2
|
|
7689
7856
|
* @summary Get document folder hierarchy
|
|
7690
7857
|
* @request POST:/api/loans/{loanId}/documents/folders
|
|
7858
|
+
* @originalName getLoanDocumentFolders
|
|
7859
|
+
* @duplicate
|
|
7691
7860
|
* @secure
|
|
7692
7861
|
* @response `200` `(DocumentFolder)[]` Success
|
|
7693
7862
|
*/
|
|
7694
|
-
|
|
7863
|
+
getLoanDocumentFolders2: (loanId: string, data: DocumentFoldersRequest, query?: {
|
|
7695
7864
|
/** @default false */
|
|
7696
7865
|
folderNamesOnly?: boolean;
|
|
7697
7866
|
}, params?: RequestParams) => Promise<AxiosResponse<DocumentFolder[], any>>;
|
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.39.
|
|
107
|
+
* @version v2.39.2
|
|
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
|
*/
|
|
@@ -1833,6 +1833,19 @@ export class Api extends HttpClient {
|
|
|
1833
1833
|
* @response `422` `UnprocessableEntity` Client Error
|
|
1834
1834
|
*/
|
|
1835
1835
|
createLoanComparisonPdf: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/loan-comparison/pdf`, method: "POST", body: data, secure: true, type: ContentType.Json }, params)),
|
|
1836
|
+
/**
|
|
1837
|
+
* No description
|
|
1838
|
+
*
|
|
1839
|
+
* @tags LoanConsents
|
|
1840
|
+
* @name ResyncLoanConsents
|
|
1841
|
+
* @summary Resync loan consents to LOS
|
|
1842
|
+
* @request POST:/api/loans/{loanId}/consents/resync
|
|
1843
|
+
* @secure
|
|
1844
|
+
* @response `204` `void` No Content
|
|
1845
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1846
|
+
* @response `422` `ProblemDetails` Client Error
|
|
1847
|
+
*/
|
|
1848
|
+
resyncLoanConsents: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/consents/resync`, method: "POST", secure: true }, params)),
|
|
1836
1849
|
/**
|
|
1837
1850
|
* No description
|
|
1838
1851
|
*
|
|
@@ -1905,6 +1918,108 @@ export class Api extends HttpClient {
|
|
|
1905
1918
|
* @response `201` `(string)[]` Created
|
|
1906
1919
|
*/
|
|
1907
1920
|
createLoanDocumentBuckets: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/buckets`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1921
|
+
/**
|
|
1922
|
+
* No description
|
|
1923
|
+
*
|
|
1924
|
+
* @tags LoanDocumentFolders
|
|
1925
|
+
* @name GetLoanDocumentFolders
|
|
1926
|
+
* @summary Get all loan document folders for the current account
|
|
1927
|
+
* @request GET:/api/loan-document-folders
|
|
1928
|
+
* @secure
|
|
1929
|
+
* @response `200` `(LoanDocumentFolder)[]` Success
|
|
1930
|
+
*/
|
|
1931
|
+
getLoanDocumentFolders: (params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders`, method: "GET", secure: true, format: "json" }, params)),
|
|
1932
|
+
/**
|
|
1933
|
+
* No description
|
|
1934
|
+
*
|
|
1935
|
+
* @tags LoanDocumentFolders
|
|
1936
|
+
* @name CreateLoanDocumentFolder
|
|
1937
|
+
* @summary Create a loan document folder
|
|
1938
|
+
* @request POST:/api/loan-document-folders
|
|
1939
|
+
* @secure
|
|
1940
|
+
* @response `201` `LoanDocumentFolder` Created
|
|
1941
|
+
* @response `409` `ProblemDetails` Conflict
|
|
1942
|
+
* @response `422` `ProblemDetails` Client Error
|
|
1943
|
+
*/
|
|
1944
|
+
createLoanDocumentFolder: (data, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1945
|
+
/**
|
|
1946
|
+
* No description
|
|
1947
|
+
*
|
|
1948
|
+
* @tags LoanDocumentFolders
|
|
1949
|
+
* @name GetLoanDocumentFolderById
|
|
1950
|
+
* @summary Get a loan document folder by ID
|
|
1951
|
+
* @request GET:/api/loan-document-folders/{id}
|
|
1952
|
+
* @secure
|
|
1953
|
+
* @response `200` `LoanDocumentFolder` Success
|
|
1954
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1955
|
+
*/
|
|
1956
|
+
getLoanDocumentFolderById: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
1957
|
+
/**
|
|
1958
|
+
* No description
|
|
1959
|
+
*
|
|
1960
|
+
* @tags LoanDocumentFolders
|
|
1961
|
+
* @name UpdateLoanDocumentFolder
|
|
1962
|
+
* @summary Update a loan document folder. Blocked when folder has ever been referenced, except for permission edits on the system-default Unassigned folder.
|
|
1963
|
+
* @request PUT:/api/loan-document-folders/{id}
|
|
1964
|
+
* @secure
|
|
1965
|
+
* @response `200` `LoanDocumentFolder` Success
|
|
1966
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
1967
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1968
|
+
* @response `409` `ProblemDetails` Conflict
|
|
1969
|
+
* @response `422` `ProblemDetails` Client Error
|
|
1970
|
+
*/
|
|
1971
|
+
updateLoanDocumentFolder: (id, data, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1972
|
+
/**
|
|
1973
|
+
* No description
|
|
1974
|
+
*
|
|
1975
|
+
* @tags LoanDocumentFolders
|
|
1976
|
+
* @name DeleteLoanDocumentFolder
|
|
1977
|
+
* @summary Delete a loan document folder. Allowed only when the folder has never been referenced and is not the system-default Unassigned folder.
|
|
1978
|
+
* @request DELETE:/api/loan-document-folders/{id}
|
|
1979
|
+
* @secure
|
|
1980
|
+
* @response `204` `void` No Content
|
|
1981
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
1982
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1983
|
+
* @response `409` `ProblemDetails` Conflict
|
|
1984
|
+
*/
|
|
1985
|
+
deleteLoanDocumentFolder: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}`, method: "DELETE", secure: true }, params)),
|
|
1986
|
+
/**
|
|
1987
|
+
* No description
|
|
1988
|
+
*
|
|
1989
|
+
* @tags LoanDocumentFolders
|
|
1990
|
+
* @name DeactivateLoanDocumentFolder
|
|
1991
|
+
* @summary Deactivate a loan document folder. Rejected for the system-default Unassigned folder.
|
|
1992
|
+
* @request POST:/api/loan-document-folders/{id}/deactivate
|
|
1993
|
+
* @secure
|
|
1994
|
+
* @response `204` `void` No Content
|
|
1995
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
1996
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1997
|
+
*/
|
|
1998
|
+
deactivateLoanDocumentFolder: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}/deactivate`, method: "POST", secure: true }, params)),
|
|
1999
|
+
/**
|
|
2000
|
+
* No description
|
|
2001
|
+
*
|
|
2002
|
+
* @tags LoanDocumentFolders
|
|
2003
|
+
* @name ReactivateLoanDocumentFolder
|
|
2004
|
+
* @summary Reactivate a loan document folder.
|
|
2005
|
+
* @request POST:/api/loan-document-folders/{id}/reactivate
|
|
2006
|
+
* @secure
|
|
2007
|
+
* @response `204` `void` No Content
|
|
2008
|
+
* @response `404` `ProblemDetails` Not Found
|
|
2009
|
+
*/
|
|
2010
|
+
reactivateLoanDocumentFolder: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}/reactivate`, method: "POST", secure: true }, params)),
|
|
2011
|
+
/**
|
|
2012
|
+
* No description
|
|
2013
|
+
*
|
|
2014
|
+
* @tags LoanDocumentFolders
|
|
2015
|
+
* @name GetLoanDocumentFolderUsage
|
|
2016
|
+
* @summary Get folder usage. Returns HasEverBeenReferenced including soft-deleted documents and tasks.
|
|
2017
|
+
* @request GET:/api/loan-document-folders/{id}/usage
|
|
2018
|
+
* @secure
|
|
2019
|
+
* @response `200` `LoanDocumentFolderUsage` Success
|
|
2020
|
+
* @response `404` `ProblemDetails` Not Found
|
|
2021
|
+
*/
|
|
2022
|
+
getLoanDocumentFolderUsage: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}/usage`, method: "GET", secure: true, format: "json" }, params)),
|
|
1908
2023
|
/**
|
|
1909
2024
|
* No description
|
|
1910
2025
|
*
|
|
@@ -1944,13 +2059,15 @@ export class Api extends HttpClient {
|
|
|
1944
2059
|
* @description Returns all documents grouped by folder for sidebar display. Use folderNamesOnly=true to get simplified response with folder names and counts for mobile (Files array will be empty).
|
|
1945
2060
|
*
|
|
1946
2061
|
* @tags LoanDocuments
|
|
1947
|
-
* @name
|
|
2062
|
+
* @name GetLoanDocumentFolders2
|
|
1948
2063
|
* @summary Get document folder hierarchy
|
|
1949
2064
|
* @request POST:/api/loans/{loanId}/documents/folders
|
|
2065
|
+
* @originalName getLoanDocumentFolders
|
|
2066
|
+
* @duplicate
|
|
1950
2067
|
* @secure
|
|
1951
2068
|
* @response `200` `(DocumentFolder)[]` Success
|
|
1952
2069
|
*/
|
|
1953
|
-
|
|
2070
|
+
getLoanDocumentFolders2: (loanId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/folders`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1954
2071
|
/**
|
|
1955
2072
|
* No description
|
|
1956
2073
|
*
|