@matech/thebigpos-sdk 2.48.0-rc1 → 2.48.0-rc3
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/dist/index.d.ts +266 -4
- package/dist/index.js +167 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +424 -4
package/dist/index.d.ts
CHANGED
|
@@ -65,6 +65,8 @@ export type CustomFieldAccessLevel = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
|
65
65
|
export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
66
66
|
export type ConsentSource = "TheBigPOS" | "ConsumerConnect";
|
|
67
67
|
export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
|
|
68
|
+
export type CompanyDocumentSourceType = "File" | "FreeText";
|
|
69
|
+
export type CompanyDocumentIndexStatus = "Uploaded" | "Indexing" | "Indexed" | "Failed";
|
|
68
70
|
export type ClassificationSource = "Textract" | "Llm" | "Manual";
|
|
69
71
|
export type BranchType = "Mortgage" | "RealEstate";
|
|
70
72
|
export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
|
|
@@ -74,7 +76,7 @@ export type BillingType = "ClosedLoan" | "LoanOfficer";
|
|
|
74
76
|
export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
|
|
75
77
|
export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
|
|
76
78
|
export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
77
|
-
export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
|
|
79
|
+
export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
|
|
78
80
|
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
81
|
export type AiPromptScope = "General" | "LoanSpecific";
|
|
80
82
|
export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
@@ -82,7 +84,7 @@ export type AiOutputType = "Text" | "Document";
|
|
|
82
84
|
export type AiIntent = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta" | "Capabilities" | "UsageReport";
|
|
83
85
|
export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
84
86
|
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";
|
|
87
|
+
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
88
|
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
89
|
export interface ASOSettings {
|
|
88
90
|
enabled: boolean;
|
|
@@ -404,7 +406,7 @@ export interface AiAuditLog {
|
|
|
404
406
|
conversationId?: string | null;
|
|
405
407
|
/** @format uuid */
|
|
406
408
|
messageId?: string | null;
|
|
407
|
-
eventType: "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";
|
|
409
|
+
eventType: "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";
|
|
408
410
|
modelId?: string | null;
|
|
409
411
|
/** @format int32 */
|
|
410
412
|
inputTokens?: number | null;
|
|
@@ -505,7 +507,7 @@ export interface AiChatRequest {
|
|
|
505
507
|
promptId?: string | null;
|
|
506
508
|
}
|
|
507
509
|
export interface AiChatStructuredData {
|
|
508
|
-
type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
|
|
510
|
+
type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
|
|
509
511
|
displayHint?: AiDisplayHint | null;
|
|
510
512
|
detectedDocumentType?: string | null;
|
|
511
513
|
columns: string[];
|
|
@@ -513,6 +515,14 @@ export interface AiChatStructuredData {
|
|
|
513
515
|
/** @format uuid */
|
|
514
516
|
generatedDocumentId?: string | null;
|
|
515
517
|
generatedFileName?: string | null;
|
|
518
|
+
passages?: AiCitedPassage[] | null;
|
|
519
|
+
}
|
|
520
|
+
export interface AiCitedPassage {
|
|
521
|
+
folderName: string;
|
|
522
|
+
documentName: string;
|
|
523
|
+
excerpt: string;
|
|
524
|
+
/** @format double */
|
|
525
|
+
score?: number | null;
|
|
516
526
|
}
|
|
517
527
|
export interface AiConversationAuditSummary {
|
|
518
528
|
/** @format uuid */
|
|
@@ -603,6 +613,7 @@ export interface AiPrompt {
|
|
|
603
613
|
description: string;
|
|
604
614
|
documentTypes: string[];
|
|
605
615
|
applicableUrlSourceIds: string[];
|
|
616
|
+
knowledgeBaseFolderIds: string[];
|
|
606
617
|
allowedRoles: string[];
|
|
607
618
|
systemPrompt: string;
|
|
608
619
|
/** @format int32 */
|
|
@@ -1036,6 +1047,55 @@ export interface CompanyAddress {
|
|
|
1036
1047
|
state: string;
|
|
1037
1048
|
zip: string;
|
|
1038
1049
|
}
|
|
1050
|
+
export interface CompanyDocument {
|
|
1051
|
+
/** @format uuid */
|
|
1052
|
+
id: string;
|
|
1053
|
+
/** @format uuid */
|
|
1054
|
+
folderId: string;
|
|
1055
|
+
folderName: string;
|
|
1056
|
+
name: string;
|
|
1057
|
+
sourceType: "File" | "FreeText";
|
|
1058
|
+
contentType?: string | null;
|
|
1059
|
+
/** @format int64 */
|
|
1060
|
+
fileSizeBytes: number;
|
|
1061
|
+
inlineContent?: string | null;
|
|
1062
|
+
indexStatus: "Uploaded" | "Indexing" | "Indexed" | "Failed";
|
|
1063
|
+
indexError?: string | null;
|
|
1064
|
+
/** @format date-time */
|
|
1065
|
+
indexedAt?: string | null;
|
|
1066
|
+
/** @format uuid */
|
|
1067
|
+
uploadedByUserId?: string | null;
|
|
1068
|
+
/** @format date-time */
|
|
1069
|
+
createdAt: string;
|
|
1070
|
+
/** @format date-time */
|
|
1071
|
+
updatedAt?: string | null;
|
|
1072
|
+
}
|
|
1073
|
+
export interface CompanyDocumentFolder {
|
|
1074
|
+
/** @format uuid */
|
|
1075
|
+
id: string;
|
|
1076
|
+
name: string;
|
|
1077
|
+
description?: string | null;
|
|
1078
|
+
isSystemDefault: boolean;
|
|
1079
|
+
/** @format int32 */
|
|
1080
|
+
documentCount: number;
|
|
1081
|
+
/** @format date-time */
|
|
1082
|
+
createdAt: string;
|
|
1083
|
+
/** @format date-time */
|
|
1084
|
+
updatedAt?: string | null;
|
|
1085
|
+
}
|
|
1086
|
+
export interface CompanyDocumentPaginated {
|
|
1087
|
+
rows: CompanyDocument[];
|
|
1088
|
+
pagination: Pagination;
|
|
1089
|
+
/** @format int64 */
|
|
1090
|
+
count: number;
|
|
1091
|
+
}
|
|
1092
|
+
export interface CompanyDocumentSearchCriteria {
|
|
1093
|
+
searchText?: string | null;
|
|
1094
|
+
/** @format uuid */
|
|
1095
|
+
folderID?: string | null;
|
|
1096
|
+
indexStatuses?: CompanyDocumentIndexStatus[] | null;
|
|
1097
|
+
sourceType?: CompanyDocumentSourceType | null;
|
|
1098
|
+
}
|
|
1039
1099
|
export interface ConditionComment {
|
|
1040
1100
|
commentId: string;
|
|
1041
1101
|
comments: string;
|
|
@@ -1153,6 +1213,7 @@ export interface CreateAiPromptRequest {
|
|
|
1153
1213
|
description: string;
|
|
1154
1214
|
documentTypes: string[];
|
|
1155
1215
|
applicableUrlSourceIds: string[];
|
|
1216
|
+
knowledgeBaseFolderIds: string[];
|
|
1156
1217
|
allowedRoles: string[];
|
|
1157
1218
|
systemPrompt: string;
|
|
1158
1219
|
/** @format int32 */
|
|
@@ -1181,6 +1242,16 @@ export interface CreateBranchRequest {
|
|
|
1181
1242
|
corporateID: string;
|
|
1182
1243
|
type: string;
|
|
1183
1244
|
}
|
|
1245
|
+
export interface CreateCompanyDocumentFolderRequest {
|
|
1246
|
+
name: string;
|
|
1247
|
+
description?: string | null;
|
|
1248
|
+
}
|
|
1249
|
+
export interface CreateCompanyTextDocumentRequest {
|
|
1250
|
+
name: string;
|
|
1251
|
+
/** @format uuid */
|
|
1252
|
+
folderID: string;
|
|
1253
|
+
content: string;
|
|
1254
|
+
}
|
|
1184
1255
|
export interface CreateCustomFieldDefinitionRequest {
|
|
1185
1256
|
isRequired: boolean;
|
|
1186
1257
|
/** @format int32 */
|
|
@@ -5438,6 +5509,7 @@ export interface UpdateAiPromptRequest {
|
|
|
5438
5509
|
description: string;
|
|
5439
5510
|
documentTypes: string[];
|
|
5440
5511
|
applicableUrlSourceIds: string[];
|
|
5512
|
+
knowledgeBaseFolderIds: string[];
|
|
5441
5513
|
allowedRoles: string[];
|
|
5442
5514
|
systemPrompt: string;
|
|
5443
5515
|
/** @format int32 */
|
|
@@ -5464,6 +5536,16 @@ export interface UpdateAiUrlSourceRequest {
|
|
|
5464
5536
|
category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
5465
5537
|
scope: "FullDomain" | "SpecificPath";
|
|
5466
5538
|
}
|
|
5539
|
+
export interface UpdateCompanyDocumentFolderRequest {
|
|
5540
|
+
name: string;
|
|
5541
|
+
description?: string | null;
|
|
5542
|
+
}
|
|
5543
|
+
export interface UpdateCompanyDocumentRequest {
|
|
5544
|
+
name?: string | null;
|
|
5545
|
+
/** @format uuid */
|
|
5546
|
+
folderID?: string | null;
|
|
5547
|
+
content?: string | null;
|
|
5548
|
+
}
|
|
5467
5549
|
export interface UpdateCustomFieldDefinitionRequest {
|
|
5468
5550
|
isRequired: boolean;
|
|
5469
5551
|
/** @format int32 */
|
|
@@ -7330,6 +7412,186 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7330
7412
|
* @response `200` `ClosedLoansReport` OK
|
|
7331
7413
|
*/
|
|
7332
7414
|
getClosedLoansReport: (data: ClosedLoansReportRequest, params?: RequestParams) => Promise<AxiosResponse<ClosedLoansReport, any, {}>>;
|
|
7415
|
+
/**
|
|
7416
|
+
* No description
|
|
7417
|
+
*
|
|
7418
|
+
* @tags CompanyDocumentFolders
|
|
7419
|
+
* @name GetCompanyDocumentFolders
|
|
7420
|
+
* @summary Get all company document folders
|
|
7421
|
+
* @request GET:/api/company-document-folders
|
|
7422
|
+
* @secure
|
|
7423
|
+
* @response `200` `(CompanyDocumentFolder)[]` OK
|
|
7424
|
+
*/
|
|
7425
|
+
getCompanyDocumentFolders: (params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder[], any, {}>>;
|
|
7426
|
+
/**
|
|
7427
|
+
* No description
|
|
7428
|
+
*
|
|
7429
|
+
* @tags CompanyDocumentFolders
|
|
7430
|
+
* @name CreateCompanyDocumentFolder
|
|
7431
|
+
* @summary Create company document folder
|
|
7432
|
+
* @request POST:/api/company-document-folders
|
|
7433
|
+
* @secure
|
|
7434
|
+
* @response `201` `CompanyDocumentFolder` Created
|
|
7435
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7436
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7437
|
+
*/
|
|
7438
|
+
createCompanyDocumentFolder: (data: CreateCompanyDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
|
|
7439
|
+
/**
|
|
7440
|
+
* No description
|
|
7441
|
+
*
|
|
7442
|
+
* @tags CompanyDocumentFolders
|
|
7443
|
+
* @name GetCompanyDocumentFolder
|
|
7444
|
+
* @summary Get company document folder by ID
|
|
7445
|
+
* @request GET:/api/company-document-folders/{id}
|
|
7446
|
+
* @secure
|
|
7447
|
+
* @response `200` `CompanyDocumentFolder` OK
|
|
7448
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7449
|
+
*/
|
|
7450
|
+
getCompanyDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
|
|
7451
|
+
/**
|
|
7452
|
+
* No description
|
|
7453
|
+
*
|
|
7454
|
+
* @tags CompanyDocumentFolders
|
|
7455
|
+
* @name UpdateCompanyDocumentFolder
|
|
7456
|
+
* @summary Update company document folder
|
|
7457
|
+
* @request PUT:/api/company-document-folders/{id}
|
|
7458
|
+
* @secure
|
|
7459
|
+
* @response `200` `CompanyDocumentFolder` OK
|
|
7460
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7461
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7462
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7463
|
+
*/
|
|
7464
|
+
updateCompanyDocumentFolder: (id: string, data: UpdateCompanyDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
|
|
7465
|
+
/**
|
|
7466
|
+
* No description
|
|
7467
|
+
*
|
|
7468
|
+
* @tags CompanyDocumentFolders
|
|
7469
|
+
* @name DeleteCompanyDocumentFolder
|
|
7470
|
+
* @summary Delete company document folder
|
|
7471
|
+
* @request DELETE:/api/company-document-folders/{id}
|
|
7472
|
+
* @secure
|
|
7473
|
+
* @response `204` `void` No Content
|
|
7474
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7475
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7476
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7477
|
+
*/
|
|
7478
|
+
deleteCompanyDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
7479
|
+
/**
|
|
7480
|
+
* No description
|
|
7481
|
+
*
|
|
7482
|
+
* @tags CompanyDocuments
|
|
7483
|
+
* @name SearchCompanyDocuments
|
|
7484
|
+
* @summary Search company documents
|
|
7485
|
+
* @request POST:/api/company-documents/search
|
|
7486
|
+
* @secure
|
|
7487
|
+
* @response `200` `CompanyDocumentPaginated` OK
|
|
7488
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7489
|
+
*/
|
|
7490
|
+
searchCompanyDocuments: (data: CompanyDocumentSearchCriteria, query?: {
|
|
7491
|
+
/** @format int32 */
|
|
7492
|
+
pageSize?: number;
|
|
7493
|
+
/** @format int32 */
|
|
7494
|
+
pageNumber?: number;
|
|
7495
|
+
sortBy?: string;
|
|
7496
|
+
sortDirection?: string;
|
|
7497
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentPaginated, any, {}>>;
|
|
7498
|
+
/**
|
|
7499
|
+
* No description
|
|
7500
|
+
*
|
|
7501
|
+
* @tags CompanyDocuments
|
|
7502
|
+
* @name GetCompanyDocument
|
|
7503
|
+
* @summary Get company document by ID
|
|
7504
|
+
* @request GET:/api/company-documents/{id}
|
|
7505
|
+
* @secure
|
|
7506
|
+
* @response `200` `CompanyDocument` OK
|
|
7507
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7508
|
+
*/
|
|
7509
|
+
getCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7510
|
+
/**
|
|
7511
|
+
* No description
|
|
7512
|
+
*
|
|
7513
|
+
* @tags CompanyDocuments
|
|
7514
|
+
* @name UpdateCompanyDocument
|
|
7515
|
+
* @summary Update company document
|
|
7516
|
+
* @request PUT:/api/company-documents/{id}
|
|
7517
|
+
* @secure
|
|
7518
|
+
* @response `200` `CompanyDocument` OK
|
|
7519
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7520
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7521
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7522
|
+
*/
|
|
7523
|
+
updateCompanyDocument: (id: string, data: UpdateCompanyDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7524
|
+
/**
|
|
7525
|
+
* No description
|
|
7526
|
+
*
|
|
7527
|
+
* @tags CompanyDocuments
|
|
7528
|
+
* @name DeleteCompanyDocument
|
|
7529
|
+
* @summary Delete company document
|
|
7530
|
+
* @request DELETE:/api/company-documents/{id}
|
|
7531
|
+
* @secure
|
|
7532
|
+
* @response `204` `void` No Content
|
|
7533
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7534
|
+
*/
|
|
7535
|
+
deleteCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
7536
|
+
/**
|
|
7537
|
+
* No description
|
|
7538
|
+
*
|
|
7539
|
+
* @tags CompanyDocuments
|
|
7540
|
+
* @name DownloadCompanyDocument
|
|
7541
|
+
* @summary Download company document
|
|
7542
|
+
* @request GET:/api/company-documents/{id}/download
|
|
7543
|
+
* @secure
|
|
7544
|
+
* @response `200` `void` OK
|
|
7545
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7546
|
+
*/
|
|
7547
|
+
downloadCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
7548
|
+
/**
|
|
7549
|
+
* No description
|
|
7550
|
+
*
|
|
7551
|
+
* @tags CompanyDocuments
|
|
7552
|
+
* @name CreateCompanyDocument
|
|
7553
|
+
* @summary Upload company document
|
|
7554
|
+
* @request POST:/api/company-documents
|
|
7555
|
+
* @secure
|
|
7556
|
+
* @response `201` `CompanyDocument` Created
|
|
7557
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7558
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7559
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7560
|
+
*/
|
|
7561
|
+
createCompanyDocument: (data: {
|
|
7562
|
+
/** @format binary */
|
|
7563
|
+
file?: File;
|
|
7564
|
+
/** @format uuid */
|
|
7565
|
+
folderID?: string;
|
|
7566
|
+
name?: string;
|
|
7567
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7568
|
+
/**
|
|
7569
|
+
* No description
|
|
7570
|
+
*
|
|
7571
|
+
* @tags CompanyDocuments
|
|
7572
|
+
* @name CreateCompanyTextDocument
|
|
7573
|
+
* @summary Create free-form text company document
|
|
7574
|
+
* @request POST:/api/company-documents/text
|
|
7575
|
+
* @secure
|
|
7576
|
+
* @response `201` `CompanyDocument` Created
|
|
7577
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7578
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7579
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7580
|
+
*/
|
|
7581
|
+
createCompanyTextDocument: (data: CreateCompanyTextDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7582
|
+
/**
|
|
7583
|
+
* No description
|
|
7584
|
+
*
|
|
7585
|
+
* @tags CompanyDocuments
|
|
7586
|
+
* @name ReindexCompanyDocument
|
|
7587
|
+
* @summary Re-index a failed company document
|
|
7588
|
+
* @request POST:/api/company-documents/{id}/reindex
|
|
7589
|
+
* @secure
|
|
7590
|
+
* @response `200` `CompanyDocument` OK
|
|
7591
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7592
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7593
|
+
*/
|
|
7594
|
+
reindexCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7333
7595
|
/**
|
|
7334
7596
|
* No description
|
|
7335
7597
|
*
|
package/dist/index.js
CHANGED
|
@@ -1266,6 +1266,173 @@ export class Api extends HttpClient {
|
|
|
1266
1266
|
* @response `200` `ClosedLoansReport` OK
|
|
1267
1267
|
*/
|
|
1268
1268
|
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)),
|
|
1269
|
+
/**
|
|
1270
|
+
* No description
|
|
1271
|
+
*
|
|
1272
|
+
* @tags CompanyDocumentFolders
|
|
1273
|
+
* @name GetCompanyDocumentFolders
|
|
1274
|
+
* @summary Get all company document folders
|
|
1275
|
+
* @request GET:/api/company-document-folders
|
|
1276
|
+
* @secure
|
|
1277
|
+
* @response `200` `(CompanyDocumentFolder)[]` OK
|
|
1278
|
+
*/
|
|
1279
|
+
getCompanyDocumentFolders: (params = {}) => this.request(Object.assign({ path: `/api/company-document-folders`, method: "GET", secure: true, format: "json" }, params)),
|
|
1280
|
+
/**
|
|
1281
|
+
* No description
|
|
1282
|
+
*
|
|
1283
|
+
* @tags CompanyDocumentFolders
|
|
1284
|
+
* @name CreateCompanyDocumentFolder
|
|
1285
|
+
* @summary Create company document folder
|
|
1286
|
+
* @request POST:/api/company-document-folders
|
|
1287
|
+
* @secure
|
|
1288
|
+
* @response `201` `CompanyDocumentFolder` Created
|
|
1289
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
1290
|
+
* @response `409` `ProblemDetails` Conflict
|
|
1291
|
+
*/
|
|
1292
|
+
createCompanyDocumentFolder: (data, params = {}) => this.request(Object.assign({ path: `/api/company-document-folders`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1293
|
+
/**
|
|
1294
|
+
* No description
|
|
1295
|
+
*
|
|
1296
|
+
* @tags CompanyDocumentFolders
|
|
1297
|
+
* @name GetCompanyDocumentFolder
|
|
1298
|
+
* @summary Get company document folder by ID
|
|
1299
|
+
* @request GET:/api/company-document-folders/{id}
|
|
1300
|
+
* @secure
|
|
1301
|
+
* @response `200` `CompanyDocumentFolder` OK
|
|
1302
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1303
|
+
*/
|
|
1304
|
+
getCompanyDocumentFolder: (id, params = {}) => this.request(Object.assign({ path: `/api/company-document-folders/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
1305
|
+
/**
|
|
1306
|
+
* No description
|
|
1307
|
+
*
|
|
1308
|
+
* @tags CompanyDocumentFolders
|
|
1309
|
+
* @name UpdateCompanyDocumentFolder
|
|
1310
|
+
* @summary Update company document folder
|
|
1311
|
+
* @request PUT:/api/company-document-folders/{id}
|
|
1312
|
+
* @secure
|
|
1313
|
+
* @response `200` `CompanyDocumentFolder` OK
|
|
1314
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
1315
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1316
|
+
* @response `409` `ProblemDetails` Conflict
|
|
1317
|
+
*/
|
|
1318
|
+
updateCompanyDocumentFolder: (id, data, params = {}) => this.request(Object.assign({ path: `/api/company-document-folders/${id}`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1319
|
+
/**
|
|
1320
|
+
* No description
|
|
1321
|
+
*
|
|
1322
|
+
* @tags CompanyDocumentFolders
|
|
1323
|
+
* @name DeleteCompanyDocumentFolder
|
|
1324
|
+
* @summary Delete company document folder
|
|
1325
|
+
* @request DELETE:/api/company-document-folders/{id}
|
|
1326
|
+
* @secure
|
|
1327
|
+
* @response `204` `void` No Content
|
|
1328
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
1329
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1330
|
+
* @response `409` `ProblemDetails` Conflict
|
|
1331
|
+
*/
|
|
1332
|
+
deleteCompanyDocumentFolder: (id, params = {}) => this.request(Object.assign({ path: `/api/company-document-folders/${id}`, method: "DELETE", secure: true }, params)),
|
|
1333
|
+
/**
|
|
1334
|
+
* No description
|
|
1335
|
+
*
|
|
1336
|
+
* @tags CompanyDocuments
|
|
1337
|
+
* @name SearchCompanyDocuments
|
|
1338
|
+
* @summary Search company documents
|
|
1339
|
+
* @request POST:/api/company-documents/search
|
|
1340
|
+
* @secure
|
|
1341
|
+
* @response `200` `CompanyDocumentPaginated` OK
|
|
1342
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
1343
|
+
*/
|
|
1344
|
+
searchCompanyDocuments: (data, query, params = {}) => this.request(Object.assign({ path: `/api/company-documents/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1345
|
+
/**
|
|
1346
|
+
* No description
|
|
1347
|
+
*
|
|
1348
|
+
* @tags CompanyDocuments
|
|
1349
|
+
* @name GetCompanyDocument
|
|
1350
|
+
* @summary Get company document by ID
|
|
1351
|
+
* @request GET:/api/company-documents/{id}
|
|
1352
|
+
* @secure
|
|
1353
|
+
* @response `200` `CompanyDocument` OK
|
|
1354
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1355
|
+
*/
|
|
1356
|
+
getCompanyDocument: (id, params = {}) => this.request(Object.assign({ path: `/api/company-documents/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
1357
|
+
/**
|
|
1358
|
+
* No description
|
|
1359
|
+
*
|
|
1360
|
+
* @tags CompanyDocuments
|
|
1361
|
+
* @name UpdateCompanyDocument
|
|
1362
|
+
* @summary Update company document
|
|
1363
|
+
* @request PUT:/api/company-documents/{id}
|
|
1364
|
+
* @secure
|
|
1365
|
+
* @response `200` `CompanyDocument` OK
|
|
1366
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
1367
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1368
|
+
* @response `409` `ProblemDetails` Conflict
|
|
1369
|
+
*/
|
|
1370
|
+
updateCompanyDocument: (id, data, params = {}) => this.request(Object.assign({ path: `/api/company-documents/${id}`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1371
|
+
/**
|
|
1372
|
+
* No description
|
|
1373
|
+
*
|
|
1374
|
+
* @tags CompanyDocuments
|
|
1375
|
+
* @name DeleteCompanyDocument
|
|
1376
|
+
* @summary Delete company document
|
|
1377
|
+
* @request DELETE:/api/company-documents/{id}
|
|
1378
|
+
* @secure
|
|
1379
|
+
* @response `204` `void` No Content
|
|
1380
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1381
|
+
*/
|
|
1382
|
+
deleteCompanyDocument: (id, params = {}) => this.request(Object.assign({ path: `/api/company-documents/${id}`, method: "DELETE", secure: true }, params)),
|
|
1383
|
+
/**
|
|
1384
|
+
* No description
|
|
1385
|
+
*
|
|
1386
|
+
* @tags CompanyDocuments
|
|
1387
|
+
* @name DownloadCompanyDocument
|
|
1388
|
+
* @summary Download company document
|
|
1389
|
+
* @request GET:/api/company-documents/{id}/download
|
|
1390
|
+
* @secure
|
|
1391
|
+
* @response `200` `void` OK
|
|
1392
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1393
|
+
*/
|
|
1394
|
+
downloadCompanyDocument: (id, params = {}) => this.request(Object.assign({ path: `/api/company-documents/${id}/download`, method: "GET", secure: true }, params)),
|
|
1395
|
+
/**
|
|
1396
|
+
* No description
|
|
1397
|
+
*
|
|
1398
|
+
* @tags CompanyDocuments
|
|
1399
|
+
* @name CreateCompanyDocument
|
|
1400
|
+
* @summary Upload company document
|
|
1401
|
+
* @request POST:/api/company-documents
|
|
1402
|
+
* @secure
|
|
1403
|
+
* @response `201` `CompanyDocument` Created
|
|
1404
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
1405
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1406
|
+
* @response `409` `ProblemDetails` Conflict
|
|
1407
|
+
*/
|
|
1408
|
+
createCompanyDocument: (data, params = {}) => this.request(Object.assign({ path: `/api/company-documents`, method: "POST", body: data, secure: true, type: ContentType.FormData, format: "json" }, params)),
|
|
1409
|
+
/**
|
|
1410
|
+
* No description
|
|
1411
|
+
*
|
|
1412
|
+
* @tags CompanyDocuments
|
|
1413
|
+
* @name CreateCompanyTextDocument
|
|
1414
|
+
* @summary Create free-form text company document
|
|
1415
|
+
* @request POST:/api/company-documents/text
|
|
1416
|
+
* @secure
|
|
1417
|
+
* @response `201` `CompanyDocument` Created
|
|
1418
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
1419
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1420
|
+
* @response `409` `ProblemDetails` Conflict
|
|
1421
|
+
*/
|
|
1422
|
+
createCompanyTextDocument: (data, params = {}) => this.request(Object.assign({ path: `/api/company-documents/text`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
1423
|
+
/**
|
|
1424
|
+
* No description
|
|
1425
|
+
*
|
|
1426
|
+
* @tags CompanyDocuments
|
|
1427
|
+
* @name ReindexCompanyDocument
|
|
1428
|
+
* @summary Re-index a failed company document
|
|
1429
|
+
* @request POST:/api/company-documents/{id}/reindex
|
|
1430
|
+
* @secure
|
|
1431
|
+
* @response `200` `CompanyDocument` OK
|
|
1432
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
1433
|
+
* @response `404` `ProblemDetails` Not Found
|
|
1434
|
+
*/
|
|
1435
|
+
reindexCompanyDocument: (id, params = {}) => this.request(Object.assign({ path: `/api/company-documents/${id}/reindex`, method: "POST", secure: true, format: "json" }, params)),
|
|
1269
1436
|
/**
|
|
1270
1437
|
* No description
|
|
1271
1438
|
*
|