@matech/thebigpos-sdk 2.48.0-rc6 → 2.49.0-rc0
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 +52 -0
- package/dist/index.d.ts +403 -63
- package/dist/index.js +213 -41
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
- package/src/index.ts +632 -115
package/dist/index.d.ts
CHANGED
|
@@ -56,15 +56,18 @@ export type FilterType = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateL
|
|
|
56
56
|
export type Environment = "Development" | "Staging" | "UAT" | "Production";
|
|
57
57
|
export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
|
|
58
58
|
export type EncompassLogOutcome = "Success" | "Failure" | "PartialSuccess";
|
|
59
|
-
export type EncompassLogOperationType = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
|
|
59
|
+
export type EncompassLogOperationType = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
|
|
60
60
|
export type EncompassEnvironment = "Production" | "UAT";
|
|
61
61
|
export type DraftType = "NewLoan" | "EditLoan";
|
|
62
|
+
export type DocumentVisibilityScope = "Own" | "All";
|
|
62
63
|
export type CustomFieldEntityType = "Loan";
|
|
63
64
|
export type CustomFieldDataType = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
64
65
|
export type CustomFieldAccessLevel = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
65
66
|
export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
66
67
|
export type ConsentSource = "TheBigPOS" | "ConsumerConnect";
|
|
67
68
|
export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
|
|
69
|
+
export type CompanyDocumentSourceType = "File" | "FreeText";
|
|
70
|
+
export type CompanyDocumentIndexStatus = "Uploaded" | "Indexing" | "Indexed" | "Failed";
|
|
68
71
|
export type ClassificationSource = "Textract" | "Llm" | "Manual";
|
|
69
72
|
export type BranchType = "Mortgage" | "RealEstate";
|
|
70
73
|
export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
|
|
@@ -74,7 +77,7 @@ export type BillingType = "ClosedLoan" | "LoanOfficer";
|
|
|
74
77
|
export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
|
|
75
78
|
export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
|
|
76
79
|
export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
77
|
-
export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
|
|
80
|
+
export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
|
|
78
81
|
export type AiQueryTemplateName = "PipelineSummary" | "LoanDetail" | "LoansClosing" | "StaleLoans" | "LoansByType" | "LoansByOfficer" | "AverageLoanAmount" | "LockedVsUnlocked" | "LoansByPurpose" | "LoansByPropertyState" | "LoansByRate" | "DtiLtvRisk" | "DisclosureTracking" | "NewLoans" | "ExpiringLocks" | "ClosedLoans" | "VerificationGaps" | "CreditScoreDistribution" | "OccupancyMix" | "PropertyTypeMix" | "FirstTimeHomebuyer" | "SelfEmployed" | "ReferralSourcePerformance" | "AmortizationMix" | "TimeToClose" | "ConversionFunnel" | "MonthlyProduction" | "PaymentAffordability" | "DownPaymentCashToClose" | "ApprovalExpirations" | "ApplicationCompleteness" | "LosSyncHealth" | "DeclarationsRisk" | "MilitaryEligibility" | "OutstandingTasks" | "ConsentTracking" | "TaskStatusBreakdown" | "ConsentSyncHealth";
|
|
79
82
|
export type AiPromptScope = "General" | "LoanSpecific";
|
|
80
83
|
export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
@@ -82,7 +85,7 @@ export type AiOutputType = "Text" | "Document";
|
|
|
82
85
|
export type AiIntent = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
|
|
83
86
|
export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
84
87
|
export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
|
|
85
|
-
export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled";
|
|
88
|
+
export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved";
|
|
86
89
|
export type AddressFamily = "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";
|
|
87
90
|
export interface ASOSettings {
|
|
88
91
|
enabled: boolean;
|
|
@@ -513,6 +516,14 @@ export interface AiChatStructuredData {
|
|
|
513
516
|
/** @format uuid */
|
|
514
517
|
generatedDocumentId?: string | null;
|
|
515
518
|
generatedFileName?: string | null;
|
|
519
|
+
passages?: AiCitedPassage[] | null;
|
|
520
|
+
}
|
|
521
|
+
export interface AiCitedPassage {
|
|
522
|
+
folderName: string;
|
|
523
|
+
documentName: string;
|
|
524
|
+
excerpt: string;
|
|
525
|
+
/** @format double */
|
|
526
|
+
score?: number | null;
|
|
516
527
|
}
|
|
517
528
|
export interface AiConversationAuditSummary {
|
|
518
529
|
/** @format uuid */
|
|
@@ -603,6 +614,7 @@ export interface AiPrompt {
|
|
|
603
614
|
description: string;
|
|
604
615
|
documentTypes: string[];
|
|
605
616
|
applicableUrlSourceIds: string[];
|
|
617
|
+
knowledgeBaseFolderIds: string[];
|
|
606
618
|
allowedRoles: string[];
|
|
607
619
|
systemPrompt: string;
|
|
608
620
|
/** @format int32 */
|
|
@@ -1036,6 +1048,55 @@ export interface CompanyAddress {
|
|
|
1036
1048
|
state: string;
|
|
1037
1049
|
zip: string;
|
|
1038
1050
|
}
|
|
1051
|
+
export interface CompanyDocument {
|
|
1052
|
+
/** @format uuid */
|
|
1053
|
+
id: string;
|
|
1054
|
+
/** @format uuid */
|
|
1055
|
+
folderId: string;
|
|
1056
|
+
folderName: string;
|
|
1057
|
+
name: string;
|
|
1058
|
+
sourceType: CompanyDocumentSourceTypeEnum;
|
|
1059
|
+
contentType?: string | null;
|
|
1060
|
+
/** @format int64 */
|
|
1061
|
+
fileSizeBytes: number;
|
|
1062
|
+
inlineContent?: string | null;
|
|
1063
|
+
indexStatus: CompanyDocumentIndexStatusEnum;
|
|
1064
|
+
indexError?: string | null;
|
|
1065
|
+
/** @format date-time */
|
|
1066
|
+
indexedAt?: string | null;
|
|
1067
|
+
/** @format uuid */
|
|
1068
|
+
uploadedByUserId?: string | null;
|
|
1069
|
+
/** @format date-time */
|
|
1070
|
+
createdAt: string;
|
|
1071
|
+
/** @format date-time */
|
|
1072
|
+
updatedAt?: string | null;
|
|
1073
|
+
}
|
|
1074
|
+
export interface CompanyDocumentFolder {
|
|
1075
|
+
/** @format uuid */
|
|
1076
|
+
id: string;
|
|
1077
|
+
name: string;
|
|
1078
|
+
description?: string | null;
|
|
1079
|
+
isSystemDefault: boolean;
|
|
1080
|
+
/** @format int32 */
|
|
1081
|
+
documentCount: number;
|
|
1082
|
+
/** @format date-time */
|
|
1083
|
+
createdAt: string;
|
|
1084
|
+
/** @format date-time */
|
|
1085
|
+
updatedAt?: string | null;
|
|
1086
|
+
}
|
|
1087
|
+
export interface CompanyDocumentPaginated {
|
|
1088
|
+
rows: CompanyDocument[];
|
|
1089
|
+
pagination: Pagination;
|
|
1090
|
+
/** @format int64 */
|
|
1091
|
+
count: number;
|
|
1092
|
+
}
|
|
1093
|
+
export interface CompanyDocumentSearchCriteria {
|
|
1094
|
+
searchText?: string | null;
|
|
1095
|
+
/** @format uuid */
|
|
1096
|
+
folderID?: string | null;
|
|
1097
|
+
indexStatuses?: CompanyDocumentIndexStatus[] | null;
|
|
1098
|
+
sourceType?: CompanyDocumentSourceType | null;
|
|
1099
|
+
}
|
|
1039
1100
|
export interface ConditionComment {
|
|
1040
1101
|
commentId: string;
|
|
1041
1102
|
comments: string;
|
|
@@ -1153,6 +1214,7 @@ export interface CreateAiPromptRequest {
|
|
|
1153
1214
|
description: string;
|
|
1154
1215
|
documentTypes: string[];
|
|
1155
1216
|
applicableUrlSourceIds: string[];
|
|
1217
|
+
knowledgeBaseFolderIds: string[];
|
|
1156
1218
|
allowedRoles: string[];
|
|
1157
1219
|
systemPrompt: string;
|
|
1158
1220
|
/** @format int32 */
|
|
@@ -1181,6 +1243,16 @@ export interface CreateBranchRequest {
|
|
|
1181
1243
|
corporateID: string;
|
|
1182
1244
|
type: string;
|
|
1183
1245
|
}
|
|
1246
|
+
export interface CreateCompanyDocumentFolderRequest {
|
|
1247
|
+
name: string;
|
|
1248
|
+
description?: string | null;
|
|
1249
|
+
}
|
|
1250
|
+
export interface CreateCompanyTextDocumentRequest {
|
|
1251
|
+
name: string;
|
|
1252
|
+
/** @format uuid */
|
|
1253
|
+
folderID: string;
|
|
1254
|
+
content: string;
|
|
1255
|
+
}
|
|
1184
1256
|
export interface CreateCustomFieldDefinitionRequest {
|
|
1185
1257
|
isRequired: boolean;
|
|
1186
1258
|
/** @format int32 */
|
|
@@ -1206,7 +1278,10 @@ export interface CreateDocumentTemplateRequest {
|
|
|
1206
1278
|
name: string;
|
|
1207
1279
|
type: string;
|
|
1208
1280
|
description?: string | null;
|
|
1281
|
+
/** @deprecated */
|
|
1209
1282
|
destinationBucket?: string | null;
|
|
1283
|
+
/** @format uuid */
|
|
1284
|
+
loanDocumentFolderID?: string | null;
|
|
1210
1285
|
status: string;
|
|
1211
1286
|
}
|
|
1212
1287
|
export interface CreateGroupMemberRequest {
|
|
@@ -1513,7 +1588,9 @@ export interface DocumentTemplate {
|
|
|
1513
1588
|
isDefault: boolean;
|
|
1514
1589
|
type: string;
|
|
1515
1590
|
description?: string | null;
|
|
1591
|
+
/** @deprecated */
|
|
1516
1592
|
destinationBucket?: string | null;
|
|
1593
|
+
loanDocumentFolder?: LoanDocumentFolderSummary | null;
|
|
1517
1594
|
isDestinationBucketConfigurable: boolean;
|
|
1518
1595
|
status: string;
|
|
1519
1596
|
versions: DocumentTemplateVersionBase[];
|
|
@@ -1533,7 +1610,9 @@ export interface DocumentTemplateBase {
|
|
|
1533
1610
|
isDefault: boolean;
|
|
1534
1611
|
type: string;
|
|
1535
1612
|
description?: string | null;
|
|
1613
|
+
/** @deprecated */
|
|
1536
1614
|
destinationBucket?: string | null;
|
|
1615
|
+
loanDocumentFolder?: LoanDocumentFolderSummary | null;
|
|
1537
1616
|
isDestinationBucketConfigurable: boolean;
|
|
1538
1617
|
status: string;
|
|
1539
1618
|
}
|
|
@@ -3234,8 +3313,11 @@ export interface LoanDocument {
|
|
|
3234
3313
|
id: string;
|
|
3235
3314
|
name: string;
|
|
3236
3315
|
loan: Loan;
|
|
3237
|
-
user?:
|
|
3316
|
+
user?: UserSummary | null;
|
|
3317
|
+
/** @deprecated */
|
|
3238
3318
|
initialBucket?: string | null;
|
|
3319
|
+
/** @format uuid */
|
|
3320
|
+
folderID?: string | null;
|
|
3239
3321
|
losDocumentID?: string | null;
|
|
3240
3322
|
losStatus: string;
|
|
3241
3323
|
contents?: string | null;
|
|
@@ -3262,10 +3344,14 @@ export interface LoanDocumentFolder {
|
|
|
3262
3344
|
createdAt: string;
|
|
3263
3345
|
/** @format date-time */
|
|
3264
3346
|
updatedAt?: string | null;
|
|
3265
|
-
/** @format date-time */
|
|
3266
|
-
deletedAt?: string | null;
|
|
3267
3347
|
permissions: LoanDocumentFolderPermission[];
|
|
3268
3348
|
}
|
|
3349
|
+
export interface LoanDocumentFolderPaginated {
|
|
3350
|
+
rows: LoanDocumentFolder[];
|
|
3351
|
+
pagination: Pagination;
|
|
3352
|
+
/** @format int64 */
|
|
3353
|
+
count: number;
|
|
3354
|
+
}
|
|
3269
3355
|
export interface LoanDocumentFolderPermission {
|
|
3270
3356
|
/** @format uuid */
|
|
3271
3357
|
id: string;
|
|
@@ -3273,16 +3359,38 @@ export interface LoanDocumentFolderPermission {
|
|
|
3273
3359
|
loanDocumentFolderID: string;
|
|
3274
3360
|
role: LoanDocumentFolderPermissionRoleEnum;
|
|
3275
3361
|
level: LoanDocumentFolderPermissionLevelEnum;
|
|
3362
|
+
readScope: LoanDocumentFolderPermissionReadScopeEnum;
|
|
3276
3363
|
}
|
|
3277
3364
|
export interface LoanDocumentFolderPermissionRequest {
|
|
3278
3365
|
role: LoanDocumentFolderPermissionRequestRoleEnum;
|
|
3279
3366
|
level: LoanDocumentFolderPermissionRequestLevelEnum;
|
|
3367
|
+
readScope: LoanDocumentFolderPermissionRequestReadScopeEnum;
|
|
3368
|
+
}
|
|
3369
|
+
export interface LoanDocumentFolderSearchCriteria {
|
|
3370
|
+
searchText?: string | null;
|
|
3371
|
+
isActive?: boolean | null;
|
|
3372
|
+
}
|
|
3373
|
+
export interface LoanDocumentFolderSummary {
|
|
3374
|
+
/** @format uuid */
|
|
3375
|
+
id: string;
|
|
3376
|
+
name: string;
|
|
3377
|
+
key?: string | null;
|
|
3378
|
+
isActive: boolean;
|
|
3280
3379
|
}
|
|
3281
3380
|
export interface LoanDocumentFolderUsage {
|
|
3282
3381
|
/** @format uuid */
|
|
3283
3382
|
folderID: string;
|
|
3284
3383
|
hasEverBeenReferenced: boolean;
|
|
3285
3384
|
}
|
|
3385
|
+
export interface LoanDocumentFolderWithCount {
|
|
3386
|
+
/** @format uuid */
|
|
3387
|
+
id: string;
|
|
3388
|
+
name: string;
|
|
3389
|
+
key?: string | null;
|
|
3390
|
+
isActive: boolean;
|
|
3391
|
+
/** @format int32 */
|
|
3392
|
+
documentCount: number;
|
|
3393
|
+
}
|
|
3286
3394
|
export interface LoanDocumentPreviewsRequest {
|
|
3287
3395
|
documentIds: string[];
|
|
3288
3396
|
}
|
|
@@ -3298,7 +3406,10 @@ export interface LoanDocumentSearch {
|
|
|
3298
3406
|
name: string;
|
|
3299
3407
|
loanID?: string | null;
|
|
3300
3408
|
userID?: string | null;
|
|
3409
|
+
user?: UserSummary | null;
|
|
3410
|
+
/** @deprecated */
|
|
3301
3411
|
initialBucket?: string | null;
|
|
3412
|
+
folder?: LoanDocumentFolderSummary | null;
|
|
3302
3413
|
losDocumentID?: string | null;
|
|
3303
3414
|
losStatus: string;
|
|
3304
3415
|
contents?: string | null;
|
|
@@ -3308,8 +3419,11 @@ export interface LoanDocumentSearch {
|
|
|
3308
3419
|
}
|
|
3309
3420
|
export interface LoanDocumentSearchCriteria {
|
|
3310
3421
|
searchText?: string | null;
|
|
3422
|
+
/** @deprecated */
|
|
3311
3423
|
bucket?: string | null;
|
|
3312
3424
|
/** @format uuid */
|
|
3425
|
+
folderID?: string | null;
|
|
3426
|
+
/** @format uuid */
|
|
3313
3427
|
userID?: string | null;
|
|
3314
3428
|
documentIDs?: string[] | null;
|
|
3315
3429
|
losStatuses?: LOSStatus[] | null;
|
|
@@ -5146,8 +5260,7 @@ export interface SiteTile {
|
|
|
5146
5260
|
linkUrl: string;
|
|
5147
5261
|
linkTarget: SiteTileLinkTargetEnum;
|
|
5148
5262
|
siteTypes: SiteConfigurationType[];
|
|
5149
|
-
|
|
5150
|
-
audience: UserRole[];
|
|
5263
|
+
locationAudiences: SiteTileLocationAudience[];
|
|
5151
5264
|
/** @format int32 */
|
|
5152
5265
|
weight: number;
|
|
5153
5266
|
excludedSiteConfigurationIDs: string[];
|
|
@@ -5156,6 +5269,14 @@ export interface SiteTile {
|
|
|
5156
5269
|
/** @format date-time */
|
|
5157
5270
|
updatedAt?: string | null;
|
|
5158
5271
|
}
|
|
5272
|
+
export interface SiteTileLocationAudience {
|
|
5273
|
+
location: SiteTileLocationAudienceLocationEnum;
|
|
5274
|
+
audience: UserRole[];
|
|
5275
|
+
}
|
|
5276
|
+
export interface SiteTileLocationAudienceRequest {
|
|
5277
|
+
location: SiteTileLocationAudienceRequestLocationEnum;
|
|
5278
|
+
audience: UserRole[];
|
|
5279
|
+
}
|
|
5159
5280
|
export interface SiteTilePaginated {
|
|
5160
5281
|
rows: SiteTile[];
|
|
5161
5282
|
pagination: Pagination;
|
|
@@ -5171,8 +5292,7 @@ export interface SiteTileRequest {
|
|
|
5171
5292
|
linkUrl: string;
|
|
5172
5293
|
linkTarget: SiteTileRequestLinkTargetEnum;
|
|
5173
5294
|
siteTypes: SiteConfigurationType[];
|
|
5174
|
-
|
|
5175
|
-
audience: UserRole[];
|
|
5295
|
+
locationAudiences: SiteTileLocationAudienceRequest[];
|
|
5176
5296
|
/** @format int32 */
|
|
5177
5297
|
weight: number;
|
|
5178
5298
|
excludedSiteConfigurationIDs: string[];
|
|
@@ -5456,6 +5576,7 @@ export interface UpdateAiPromptRequest {
|
|
|
5456
5576
|
description: string;
|
|
5457
5577
|
documentTypes: string[];
|
|
5458
5578
|
applicableUrlSourceIds: string[];
|
|
5579
|
+
knowledgeBaseFolderIds: string[];
|
|
5459
5580
|
allowedRoles: string[];
|
|
5460
5581
|
systemPrompt: string;
|
|
5461
5582
|
/** @format int32 */
|
|
@@ -5482,6 +5603,16 @@ export interface UpdateAiUrlSourceRequest {
|
|
|
5482
5603
|
category: UpdateAiUrlSourceRequestCategoryEnum;
|
|
5483
5604
|
scope: UpdateAiUrlSourceRequestScopeEnum;
|
|
5484
5605
|
}
|
|
5606
|
+
export interface UpdateCompanyDocumentFolderRequest {
|
|
5607
|
+
name: string;
|
|
5608
|
+
description?: string | null;
|
|
5609
|
+
}
|
|
5610
|
+
export interface UpdateCompanyDocumentRequest {
|
|
5611
|
+
name?: string | null;
|
|
5612
|
+
/** @format uuid */
|
|
5613
|
+
folderID?: string | null;
|
|
5614
|
+
content?: string | null;
|
|
5615
|
+
}
|
|
5485
5616
|
export interface UpdateCustomFieldDefinitionRequest {
|
|
5486
5617
|
isRequired: boolean;
|
|
5487
5618
|
/** @format int32 */
|
|
@@ -5504,7 +5635,10 @@ export interface UpdateDocumentTemplateRequest {
|
|
|
5504
5635
|
htmlBody: string;
|
|
5505
5636
|
name: string;
|
|
5506
5637
|
description?: string | null;
|
|
5638
|
+
/** @deprecated */
|
|
5507
5639
|
destinationBucket?: string | null;
|
|
5640
|
+
/** @format uuid */
|
|
5641
|
+
loanDocumentFolderID?: string | null;
|
|
5508
5642
|
status: string;
|
|
5509
5643
|
}
|
|
5510
5644
|
export interface UpdateListingFileRequest {
|
|
@@ -5796,7 +5930,7 @@ export interface UserGroupAccessScope {
|
|
|
5796
5930
|
userId?: string | null;
|
|
5797
5931
|
/** @format uuid */
|
|
5798
5932
|
branchId?: string | null;
|
|
5799
|
-
user?:
|
|
5933
|
+
user?: UserGroupMemberUserSummary | null;
|
|
5800
5934
|
branch?: BranchSummary | null;
|
|
5801
5935
|
}
|
|
5802
5936
|
export interface UserGroupMember {
|
|
@@ -5807,7 +5941,14 @@ export interface UserGroupMember {
|
|
|
5807
5941
|
/** @format uuid */
|
|
5808
5942
|
userId: string;
|
|
5809
5943
|
loanRole: string;
|
|
5810
|
-
user:
|
|
5944
|
+
user: UserGroupMemberUserSummary;
|
|
5945
|
+
}
|
|
5946
|
+
export interface UserGroupMemberUserSummary {
|
|
5947
|
+
/** @format uuid */
|
|
5948
|
+
id: string;
|
|
5949
|
+
name?: string | null;
|
|
5950
|
+
email?: string | null;
|
|
5951
|
+
role: UserGroupMemberUserSummaryRoleEnum;
|
|
5811
5952
|
}
|
|
5812
5953
|
export interface UserGroupPaginated {
|
|
5813
5954
|
rows: UserGroup[];
|
|
@@ -5968,9 +6109,8 @@ export interface UserSearchCriteria {
|
|
|
5968
6109
|
export interface UserSummary {
|
|
5969
6110
|
/** @format uuid */
|
|
5970
6111
|
id: string;
|
|
5971
|
-
|
|
5972
|
-
|
|
5973
|
-
role: UserSummaryRoleEnum;
|
|
6112
|
+
firstName: string;
|
|
6113
|
+
lastName: string;
|
|
5974
6114
|
}
|
|
5975
6115
|
export interface VerifyEmailRequest {
|
|
5976
6116
|
token: string;
|
|
@@ -6001,15 +6141,17 @@ export interface Workflow {
|
|
|
6001
6141
|
icon: string;
|
|
6002
6142
|
}
|
|
6003
6143
|
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
6004
|
-
export type AiAuditLogEventTypeEnum = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled";
|
|
6144
|
+
export type AiAuditLogEventTypeEnum = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved";
|
|
6005
6145
|
export type AiChatMetadataIntentEnum = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
|
|
6006
|
-
export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
|
|
6146
|
+
export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
|
|
6007
6147
|
export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
6008
6148
|
export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
6009
6149
|
export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
|
|
6010
6150
|
export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
|
|
6011
6151
|
export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6012
6152
|
export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6153
|
+
export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
|
|
6154
|
+
export type CompanyDocumentIndexStatusEnum = "Uploaded" | "Indexing" | "Indexed" | "Failed";
|
|
6013
6155
|
export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
|
|
6014
6156
|
export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
|
|
6015
6157
|
export type CreateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
@@ -6036,7 +6178,7 @@ export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" |
|
|
|
6036
6178
|
export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
6037
6179
|
export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
|
|
6038
6180
|
export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
6039
|
-
export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
|
|
6181
|
+
export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
|
|
6040
6182
|
export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
|
|
6041
6183
|
export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
|
|
6042
6184
|
export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
@@ -6046,8 +6188,10 @@ export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
|
6046
6188
|
export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6047
6189
|
export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6048
6190
|
export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
|
|
6191
|
+
export type LoanDocumentFolderPermissionReadScopeEnum = "Own" | "All";
|
|
6049
6192
|
export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6050
6193
|
export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
|
|
6194
|
+
export type LoanDocumentFolderPermissionRequestReadScopeEnum = "Own" | "All";
|
|
6051
6195
|
export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
|
|
6052
6196
|
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
6053
6197
|
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
@@ -6066,6 +6210,8 @@ export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate"
|
|
|
6066
6210
|
export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
6067
6211
|
export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
6068
6212
|
export type SiteTileLinkTargetEnum = "Self" | "Blank";
|
|
6213
|
+
export type SiteTileLocationAudienceLocationEnum = "HomePage" | "Dashboard";
|
|
6214
|
+
export type SiteTileLocationAudienceRequestLocationEnum = "HomePage" | "Dashboard";
|
|
6069
6215
|
export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
|
|
6070
6216
|
export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
|
|
6071
6217
|
export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
@@ -6074,10 +6220,10 @@ export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" |
|
|
|
6074
6220
|
export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
|
|
6075
6221
|
export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6076
6222
|
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
6223
|
+
export type UserGroupMemberUserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
6077
6224
|
export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
6078
6225
|
export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
6079
6226
|
export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
|
|
6080
|
-
export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
6081
6227
|
export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
|
|
6082
6228
|
/** @default "Realtor" */
|
|
6083
6229
|
export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
@@ -6124,7 +6270,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
6124
6270
|
}
|
|
6125
6271
|
/**
|
|
6126
6272
|
* @title The Big POS API
|
|
6127
|
-
* @version v2.
|
|
6273
|
+
* @version v2.49.0
|
|
6128
6274
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
6129
6275
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
6130
6276
|
*/
|
|
@@ -7489,6 +7635,186 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7489
7635
|
* @response `200` `ClosedLoansReport` OK
|
|
7490
7636
|
*/
|
|
7491
7637
|
getClosedLoansReport: (data: ClosedLoansReportRequest, params?: RequestParams) => Promise<AxiosResponse<ClosedLoansReport, any, {}>>;
|
|
7638
|
+
/**
|
|
7639
|
+
* No description
|
|
7640
|
+
*
|
|
7641
|
+
* @tags CompanyDocumentFolders
|
|
7642
|
+
* @name GetCompanyDocumentFolders
|
|
7643
|
+
* @summary Get all company document folders
|
|
7644
|
+
* @request GET:/api/company-document-folders
|
|
7645
|
+
* @secure
|
|
7646
|
+
* @response `200` `(CompanyDocumentFolder)[]` OK
|
|
7647
|
+
*/
|
|
7648
|
+
getCompanyDocumentFolders: (params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder[], any, {}>>;
|
|
7649
|
+
/**
|
|
7650
|
+
* No description
|
|
7651
|
+
*
|
|
7652
|
+
* @tags CompanyDocumentFolders
|
|
7653
|
+
* @name CreateCompanyDocumentFolder
|
|
7654
|
+
* @summary Create company document folder
|
|
7655
|
+
* @request POST:/api/company-document-folders
|
|
7656
|
+
* @secure
|
|
7657
|
+
* @response `201` `CompanyDocumentFolder` Created
|
|
7658
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7659
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7660
|
+
*/
|
|
7661
|
+
createCompanyDocumentFolder: (data: CreateCompanyDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
|
|
7662
|
+
/**
|
|
7663
|
+
* No description
|
|
7664
|
+
*
|
|
7665
|
+
* @tags CompanyDocumentFolders
|
|
7666
|
+
* @name GetCompanyDocumentFolder
|
|
7667
|
+
* @summary Get company document folder by ID
|
|
7668
|
+
* @request GET:/api/company-document-folders/{id}
|
|
7669
|
+
* @secure
|
|
7670
|
+
* @response `200` `CompanyDocumentFolder` OK
|
|
7671
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7672
|
+
*/
|
|
7673
|
+
getCompanyDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
|
|
7674
|
+
/**
|
|
7675
|
+
* No description
|
|
7676
|
+
*
|
|
7677
|
+
* @tags CompanyDocumentFolders
|
|
7678
|
+
* @name UpdateCompanyDocumentFolder
|
|
7679
|
+
* @summary Update company document folder
|
|
7680
|
+
* @request PUT:/api/company-document-folders/{id}
|
|
7681
|
+
* @secure
|
|
7682
|
+
* @response `200` `CompanyDocumentFolder` OK
|
|
7683
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7684
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7685
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7686
|
+
*/
|
|
7687
|
+
updateCompanyDocumentFolder: (id: string, data: UpdateCompanyDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
|
|
7688
|
+
/**
|
|
7689
|
+
* No description
|
|
7690
|
+
*
|
|
7691
|
+
* @tags CompanyDocumentFolders
|
|
7692
|
+
* @name DeleteCompanyDocumentFolder
|
|
7693
|
+
* @summary Delete company document folder
|
|
7694
|
+
* @request DELETE:/api/company-document-folders/{id}
|
|
7695
|
+
* @secure
|
|
7696
|
+
* @response `204` `void` No Content
|
|
7697
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7698
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7699
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7700
|
+
*/
|
|
7701
|
+
deleteCompanyDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
7702
|
+
/**
|
|
7703
|
+
* No description
|
|
7704
|
+
*
|
|
7705
|
+
* @tags CompanyDocuments
|
|
7706
|
+
* @name SearchCompanyDocuments
|
|
7707
|
+
* @summary Search company documents
|
|
7708
|
+
* @request POST:/api/company-documents/search
|
|
7709
|
+
* @secure
|
|
7710
|
+
* @response `200` `CompanyDocumentPaginated` OK
|
|
7711
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7712
|
+
*/
|
|
7713
|
+
searchCompanyDocuments: (data: CompanyDocumentSearchCriteria, query?: {
|
|
7714
|
+
/** @format int32 */
|
|
7715
|
+
pageSize?: number;
|
|
7716
|
+
/** @format int32 */
|
|
7717
|
+
pageNumber?: number;
|
|
7718
|
+
sortBy?: string;
|
|
7719
|
+
sortDirection?: string;
|
|
7720
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentPaginated, any, {}>>;
|
|
7721
|
+
/**
|
|
7722
|
+
* No description
|
|
7723
|
+
*
|
|
7724
|
+
* @tags CompanyDocuments
|
|
7725
|
+
* @name GetCompanyDocument
|
|
7726
|
+
* @summary Get company document by ID
|
|
7727
|
+
* @request GET:/api/company-documents/{id}
|
|
7728
|
+
* @secure
|
|
7729
|
+
* @response `200` `CompanyDocument` OK
|
|
7730
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7731
|
+
*/
|
|
7732
|
+
getCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7733
|
+
/**
|
|
7734
|
+
* No description
|
|
7735
|
+
*
|
|
7736
|
+
* @tags CompanyDocuments
|
|
7737
|
+
* @name UpdateCompanyDocument
|
|
7738
|
+
* @summary Update company document
|
|
7739
|
+
* @request PUT:/api/company-documents/{id}
|
|
7740
|
+
* @secure
|
|
7741
|
+
* @response `200` `CompanyDocument` OK
|
|
7742
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7743
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7744
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7745
|
+
*/
|
|
7746
|
+
updateCompanyDocument: (id: string, data: UpdateCompanyDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7747
|
+
/**
|
|
7748
|
+
* No description
|
|
7749
|
+
*
|
|
7750
|
+
* @tags CompanyDocuments
|
|
7751
|
+
* @name DeleteCompanyDocument
|
|
7752
|
+
* @summary Delete company document
|
|
7753
|
+
* @request DELETE:/api/company-documents/{id}
|
|
7754
|
+
* @secure
|
|
7755
|
+
* @response `204` `void` No Content
|
|
7756
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7757
|
+
*/
|
|
7758
|
+
deleteCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
7759
|
+
/**
|
|
7760
|
+
* No description
|
|
7761
|
+
*
|
|
7762
|
+
* @tags CompanyDocuments
|
|
7763
|
+
* @name DownloadCompanyDocument
|
|
7764
|
+
* @summary Download company document
|
|
7765
|
+
* @request GET:/api/company-documents/{id}/download
|
|
7766
|
+
* @secure
|
|
7767
|
+
* @response `200` `void` OK
|
|
7768
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7769
|
+
*/
|
|
7770
|
+
downloadCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
7771
|
+
/**
|
|
7772
|
+
* No description
|
|
7773
|
+
*
|
|
7774
|
+
* @tags CompanyDocuments
|
|
7775
|
+
* @name CreateCompanyDocument
|
|
7776
|
+
* @summary Upload company document
|
|
7777
|
+
* @request POST:/api/company-documents
|
|
7778
|
+
* @secure
|
|
7779
|
+
* @response `201` `CompanyDocument` Created
|
|
7780
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7781
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7782
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7783
|
+
*/
|
|
7784
|
+
createCompanyDocument: (data: {
|
|
7785
|
+
/** @format binary */
|
|
7786
|
+
file?: File;
|
|
7787
|
+
/** @format uuid */
|
|
7788
|
+
folderID?: string;
|
|
7789
|
+
name?: string;
|
|
7790
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7791
|
+
/**
|
|
7792
|
+
* No description
|
|
7793
|
+
*
|
|
7794
|
+
* @tags CompanyDocuments
|
|
7795
|
+
* @name CreateCompanyTextDocument
|
|
7796
|
+
* @summary Create free-form text company document
|
|
7797
|
+
* @request POST:/api/company-documents/text
|
|
7798
|
+
* @secure
|
|
7799
|
+
* @response `201` `CompanyDocument` Created
|
|
7800
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7801
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7802
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7803
|
+
*/
|
|
7804
|
+
createCompanyTextDocument: (data: CreateCompanyTextDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7805
|
+
/**
|
|
7806
|
+
* No description
|
|
7807
|
+
*
|
|
7808
|
+
* @tags CompanyDocuments
|
|
7809
|
+
* @name ReindexCompanyDocument
|
|
7810
|
+
* @summary Re-index a failed company document
|
|
7811
|
+
* @request POST:/api/company-documents/{id}/reindex
|
|
7812
|
+
* @secure
|
|
7813
|
+
* @response `200` `CompanyDocument` OK
|
|
7814
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7815
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7816
|
+
*/
|
|
7817
|
+
reindexCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7492
7818
|
/**
|
|
7493
7819
|
* No description
|
|
7494
7820
|
*
|
|
@@ -7828,6 +8154,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7828
8154
|
* @name GetDocumentBuckets
|
|
7829
8155
|
* @summary Get All
|
|
7830
8156
|
* @request GET:/api/document-buckets
|
|
8157
|
+
* @deprecated
|
|
7831
8158
|
* @secure
|
|
7832
8159
|
* @response `200` `(string)[]` OK
|
|
7833
8160
|
*/
|
|
@@ -9006,45 +9333,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9006
9333
|
* @name GetLoanDocumentBuckets
|
|
9007
9334
|
* @summary Get All
|
|
9008
9335
|
* @request GET:/api/loans/{loanId}/documents/buckets
|
|
9336
|
+
* @deprecated
|
|
9009
9337
|
* @secure
|
|
9010
9338
|
* @response `200` `(string)[]` OK
|
|
9011
9339
|
*/
|
|
9012
9340
|
getLoanDocumentBuckets: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<string[], any, {}>>;
|
|
9013
|
-
/**
|
|
9014
|
-
* No description
|
|
9015
|
-
*
|
|
9016
|
-
* @tags LoanDocumentBuckets
|
|
9017
|
-
* @name CreateLoanDocumentBuckets
|
|
9018
|
-
* @summary Create
|
|
9019
|
-
* @request POST:/api/loans/{loanId}/documents/buckets
|
|
9020
|
-
* @secure
|
|
9021
|
-
* @response `201` `(string)[]` Created
|
|
9022
|
-
*/
|
|
9023
|
-
createLoanDocumentBuckets: (loanId: string, data: string[], params?: RequestParams) => Promise<AxiosResponse<string[], any, {}>>;
|
|
9024
9341
|
/**
|
|
9025
9342
|
* No description
|
|
9026
9343
|
*
|
|
9027
9344
|
* @tags LoanDocumentFolders
|
|
9028
|
-
* @name
|
|
9029
|
-
* @summary
|
|
9030
|
-
* @request
|
|
9345
|
+
* @name SearchLoanDocumentFolders
|
|
9346
|
+
* @summary Search loan document folders for the current account
|
|
9347
|
+
* @request POST:/api/loan-document-folders/search
|
|
9031
9348
|
* @secure
|
|
9032
|
-
* @response `200` `
|
|
9033
|
-
*/
|
|
9034
|
-
getAllLoanDocumentFolders: (params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolder[], any, {}>>;
|
|
9035
|
-
/**
|
|
9036
|
-
* No description
|
|
9037
|
-
*
|
|
9038
|
-
* @tags LoanDocumentFolders
|
|
9039
|
-
* @name CreateLoanDocumentFolder
|
|
9040
|
-
* @summary Create a loan document folder
|
|
9041
|
-
* @request POST:/api/loan-document-folders
|
|
9042
|
-
* @secure
|
|
9043
|
-
* @response `201` `LoanDocumentFolder` Created
|
|
9044
|
-
* @response `409` `ProblemDetails` Conflict
|
|
9045
|
-
* @response `422` `ProblemDetails` Unprocessable Content
|
|
9349
|
+
* @response `200` `LoanDocumentFolderPaginated` OK
|
|
9046
9350
|
*/
|
|
9047
|
-
|
|
9351
|
+
searchLoanDocumentFolders: (data: LoanDocumentFolderSearchCriteria, query?: {
|
|
9352
|
+
/** @format int32 */
|
|
9353
|
+
pageSize?: number;
|
|
9354
|
+
/** @format int32 */
|
|
9355
|
+
pageNumber?: number;
|
|
9356
|
+
sortBy?: string;
|
|
9357
|
+
sortDirection?: string;
|
|
9358
|
+
}, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolderPaginated, any, {}>>;
|
|
9048
9359
|
/**
|
|
9049
9360
|
* No description
|
|
9050
9361
|
*
|
|
@@ -9086,6 +9397,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9086
9397
|
* @response `409` `ProblemDetails` Conflict
|
|
9087
9398
|
*/
|
|
9088
9399
|
deleteLoanDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
9400
|
+
/**
|
|
9401
|
+
* No description
|
|
9402
|
+
*
|
|
9403
|
+
* @tags LoanDocumentFolders
|
|
9404
|
+
* @name CreateLoanDocumentFolder
|
|
9405
|
+
* @summary Create a loan document folder
|
|
9406
|
+
* @request POST:/api/loan-document-folders
|
|
9407
|
+
* @secure
|
|
9408
|
+
* @response `201` `LoanDocumentFolder` Created
|
|
9409
|
+
* @response `409` `ProblemDetails` Conflict
|
|
9410
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
9411
|
+
*/
|
|
9412
|
+
createLoanDocumentFolder: (data: CreateLoanDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolder, any, {}>>;
|
|
9089
9413
|
/**
|
|
9090
9414
|
* No description
|
|
9091
9415
|
*
|
|
@@ -9123,6 +9447,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9123
9447
|
* @response `404` `ProblemDetails` Not Found
|
|
9124
9448
|
*/
|
|
9125
9449
|
getLoanDocumentFolderUsage: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolderUsage, any, {}>>;
|
|
9450
|
+
/**
|
|
9451
|
+
* @description Returns each folder that holds at least one document the caller can read, with the document count per folder. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID).
|
|
9452
|
+
*
|
|
9453
|
+
* @tags LoanDocumentFoldersForSingleLoan
|
|
9454
|
+
* @name ListLoanDocumentFolders
|
|
9455
|
+
* @summary Get the loan's document folders
|
|
9456
|
+
* @request GET:/api/loans/{loanId}/document-folders
|
|
9457
|
+
* @secure
|
|
9458
|
+
* @response `200` `(LoanDocumentFolderWithCount)[]` OK
|
|
9459
|
+
*/
|
|
9460
|
+
listLoanDocumentFolders: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolderWithCount[], any, {}>>;
|
|
9461
|
+
/**
|
|
9462
|
+
* @description Deprecated — use GET documents/folders. Returns all documents grouped by folder for sidebar display. Use folderNamesOnly=true to get a simplified response with folder names and counts for mobile (Files array will be empty).
|
|
9463
|
+
*
|
|
9464
|
+
* @tags LoanDocumentFoldersForSingleLoan
|
|
9465
|
+
* @name GetLoanDocumentFolders
|
|
9466
|
+
* @summary [Deprecated] Get document folder hierarchy
|
|
9467
|
+
* @request POST:/api/loans/{loanId}/documents/folders
|
|
9468
|
+
* @deprecated
|
|
9469
|
+
* @secure
|
|
9470
|
+
* @response `200` `(DocumentFolder)[]` OK
|
|
9471
|
+
*/
|
|
9472
|
+
getLoanDocumentFolders: (loanId: string, data: DocumentFoldersRequest, query?: {
|
|
9473
|
+
/** @default false */
|
|
9474
|
+
folderNamesOnly?: boolean;
|
|
9475
|
+
}, params?: RequestParams) => Promise<AxiosResponse<DocumentFolder[], any, {}>>;
|
|
9126
9476
|
/**
|
|
9127
9477
|
* No description
|
|
9128
9478
|
*
|
|
@@ -9168,20 +9518,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9168
9518
|
sortBy?: string;
|
|
9169
9519
|
sortDirection?: string;
|
|
9170
9520
|
}, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentSearchPaginated, any, {}>>;
|
|
9171
|
-
/**
|
|
9172
|
-
* @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).
|
|
9173
|
-
*
|
|
9174
|
-
* @tags LoanDocuments
|
|
9175
|
-
* @name GetLoanDocumentFolders
|
|
9176
|
-
* @summary Get document folder hierarchy
|
|
9177
|
-
* @request POST:/api/loans/{loanId}/documents/folders
|
|
9178
|
-
* @secure
|
|
9179
|
-
* @response `200` `(DocumentFolder)[]` OK
|
|
9180
|
-
*/
|
|
9181
|
-
getLoanDocumentFolders: (loanId: string, data: DocumentFoldersRequest, query?: {
|
|
9182
|
-
/** @default false */
|
|
9183
|
-
folderNamesOnly?: boolean;
|
|
9184
|
-
}, params?: RequestParams) => Promise<AxiosResponse<DocumentFolder[], any, {}>>;
|
|
9185
9521
|
/**
|
|
9186
9522
|
* No description
|
|
9187
9523
|
*
|
|
@@ -9210,6 +9546,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9210
9546
|
name?: string;
|
|
9211
9547
|
/** @format binary */
|
|
9212
9548
|
file?: File;
|
|
9549
|
+
/** @deprecated */
|
|
9213
9550
|
bucket?: string;
|
|
9214
9551
|
/** @format uuid */
|
|
9215
9552
|
folderID?: string;
|
|
@@ -9891,6 +10228,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9891
10228
|
name?: string;
|
|
9892
10229
|
/** @format binary */
|
|
9893
10230
|
file?: File;
|
|
10231
|
+
/** @deprecated */
|
|
9894
10232
|
bucket?: string;
|
|
9895
10233
|
/** @format uuid */
|
|
9896
10234
|
folderID?: string;
|
|
@@ -11164,6 +11502,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11164
11502
|
* @request POST:/api/loans/drafts/{draftId}/users/{userId}
|
|
11165
11503
|
* @secure
|
|
11166
11504
|
* @response `200` `UserDraft` OK
|
|
11505
|
+
* @response `404` `ProblemDetails` Not Found
|
|
11506
|
+
* @response `409` `ProblemDetails` Conflict
|
|
11167
11507
|
*/
|
|
11168
11508
|
addDraftUsers: (draftId: string, userId: string, data: CreateUserDraft, params?: RequestParams) => Promise<AxiosResponse<UserDraft, any, {}>>;
|
|
11169
11509
|
/**
|