@matech/thebigpos-sdk 2.47.1-rc1 → 2.48.0-rc2
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 +305 -3
- package/dist/index.js +182 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +474 -3
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";
|
|
@@ -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";
|
|
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";
|
|
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;
|
|
@@ -141,6 +143,12 @@ export interface AccountDeactivated {
|
|
|
141
143
|
accountDeactivated: boolean;
|
|
142
144
|
email: string;
|
|
143
145
|
}
|
|
146
|
+
export interface AccountFailureCount {
|
|
147
|
+
/** @format uuid */
|
|
148
|
+
accountId: string;
|
|
149
|
+
/** @format int32 */
|
|
150
|
+
count: number;
|
|
151
|
+
}
|
|
144
152
|
export interface AccountReactivationCompleteRequest {
|
|
145
153
|
/** @format uuid */
|
|
146
154
|
token: string;
|
|
@@ -398,7 +406,7 @@ export interface AiAuditLog {
|
|
|
398
406
|
conversationId?: string | null;
|
|
399
407
|
/** @format uuid */
|
|
400
408
|
messageId?: string | null;
|
|
401
|
-
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";
|
|
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";
|
|
402
410
|
modelId?: string | null;
|
|
403
411
|
/** @format int32 */
|
|
404
412
|
inputTokens?: number | null;
|
|
@@ -613,6 +621,8 @@ export interface AiPrompt {
|
|
|
613
621
|
outputType?: AiOutputType | null;
|
|
614
622
|
scope?: AiPromptScope | null;
|
|
615
623
|
inputHint?: string | null;
|
|
624
|
+
isFeatured: boolean;
|
|
625
|
+
icon?: string | null;
|
|
616
626
|
agentSystemPrompt?: string | null;
|
|
617
627
|
tools?: AiPromptTool[] | null;
|
|
618
628
|
hasAccountOverride: boolean;
|
|
@@ -639,6 +649,8 @@ export interface AiPromptSummary {
|
|
|
639
649
|
outputType?: AiOutputType | null;
|
|
640
650
|
scope?: AiPromptScope | null;
|
|
641
651
|
inputHint?: string | null;
|
|
652
|
+
isFeatured: boolean;
|
|
653
|
+
icon?: string | null;
|
|
642
654
|
}
|
|
643
655
|
export interface AiPromptTool {
|
|
644
656
|
toolName: string;
|
|
@@ -1026,6 +1038,55 @@ export interface CompanyAddress {
|
|
|
1026
1038
|
state: string;
|
|
1027
1039
|
zip: string;
|
|
1028
1040
|
}
|
|
1041
|
+
export interface CompanyDocument {
|
|
1042
|
+
/** @format uuid */
|
|
1043
|
+
id: string;
|
|
1044
|
+
/** @format uuid */
|
|
1045
|
+
folderId: string;
|
|
1046
|
+
folderName: string;
|
|
1047
|
+
name: string;
|
|
1048
|
+
sourceType: "File" | "FreeText";
|
|
1049
|
+
contentType?: string | null;
|
|
1050
|
+
/** @format int64 */
|
|
1051
|
+
fileSizeBytes: number;
|
|
1052
|
+
inlineContent?: string | null;
|
|
1053
|
+
indexStatus: "Uploaded" | "Indexing" | "Indexed" | "Failed";
|
|
1054
|
+
indexError?: string | null;
|
|
1055
|
+
/** @format date-time */
|
|
1056
|
+
indexedAt?: string | null;
|
|
1057
|
+
/** @format uuid */
|
|
1058
|
+
uploadedByUserId?: string | null;
|
|
1059
|
+
/** @format date-time */
|
|
1060
|
+
createdAt: string;
|
|
1061
|
+
/** @format date-time */
|
|
1062
|
+
updatedAt?: string | null;
|
|
1063
|
+
}
|
|
1064
|
+
export interface CompanyDocumentFolder {
|
|
1065
|
+
/** @format uuid */
|
|
1066
|
+
id: string;
|
|
1067
|
+
name: string;
|
|
1068
|
+
description?: string | null;
|
|
1069
|
+
isSystemDefault: boolean;
|
|
1070
|
+
/** @format int32 */
|
|
1071
|
+
documentCount: number;
|
|
1072
|
+
/** @format date-time */
|
|
1073
|
+
createdAt: string;
|
|
1074
|
+
/** @format date-time */
|
|
1075
|
+
updatedAt?: string | null;
|
|
1076
|
+
}
|
|
1077
|
+
export interface CompanyDocumentPaginated {
|
|
1078
|
+
rows: CompanyDocument[];
|
|
1079
|
+
pagination: Pagination;
|
|
1080
|
+
/** @format int64 */
|
|
1081
|
+
count: number;
|
|
1082
|
+
}
|
|
1083
|
+
export interface CompanyDocumentSearchCriteria {
|
|
1084
|
+
searchText?: string | null;
|
|
1085
|
+
/** @format uuid */
|
|
1086
|
+
folderID?: string | null;
|
|
1087
|
+
indexStatuses?: CompanyDocumentIndexStatus[] | null;
|
|
1088
|
+
sourceType?: CompanyDocumentSourceType | null;
|
|
1089
|
+
}
|
|
1029
1090
|
export interface ConditionComment {
|
|
1030
1091
|
commentId: string;
|
|
1031
1092
|
comments: string;
|
|
@@ -1155,6 +1216,8 @@ export interface CreateAiPromptRequest {
|
|
|
1155
1216
|
outputType?: AiOutputType | null;
|
|
1156
1217
|
scope?: AiPromptScope | null;
|
|
1157
1218
|
inputHint?: string | null;
|
|
1219
|
+
isFeatured: boolean;
|
|
1220
|
+
icon?: string | null;
|
|
1158
1221
|
}
|
|
1159
1222
|
export interface CreateAiUrlSourceRequest {
|
|
1160
1223
|
name: string;
|
|
@@ -1169,6 +1232,16 @@ export interface CreateBranchRequest {
|
|
|
1169
1232
|
corporateID: string;
|
|
1170
1233
|
type: string;
|
|
1171
1234
|
}
|
|
1235
|
+
export interface CreateCompanyDocumentFolderRequest {
|
|
1236
|
+
name: string;
|
|
1237
|
+
description?: string | null;
|
|
1238
|
+
}
|
|
1239
|
+
export interface CreateCompanyTextDocumentRequest {
|
|
1240
|
+
name: string;
|
|
1241
|
+
/** @format uuid */
|
|
1242
|
+
folderID: string;
|
|
1243
|
+
content: string;
|
|
1244
|
+
}
|
|
1172
1245
|
export interface CreateCustomFieldDefinitionRequest {
|
|
1173
1246
|
isRequired: boolean;
|
|
1174
1247
|
/** @format int32 */
|
|
@@ -1837,6 +1910,12 @@ export interface EncompassRequestLogPaginated {
|
|
|
1837
1910
|
export interface Error {
|
|
1838
1911
|
message: string;
|
|
1839
1912
|
}
|
|
1913
|
+
export interface FailureBucket {
|
|
1914
|
+
/** @format date-time */
|
|
1915
|
+
startUtc: string;
|
|
1916
|
+
/** @format int32 */
|
|
1917
|
+
count: number;
|
|
1918
|
+
}
|
|
1840
1919
|
export interface File {
|
|
1841
1920
|
/** @format uuid */
|
|
1842
1921
|
id: string;
|
|
@@ -3848,6 +3927,20 @@ export interface LosSync {
|
|
|
3848
3927
|
}
|
|
3849
3928
|
export interface LosSyncFailuresSearchCriteria {
|
|
3850
3929
|
searchText?: string | null;
|
|
3930
|
+
/** @format date-time */
|
|
3931
|
+
failedFromUtc?: string | null;
|
|
3932
|
+
/** @format date-time */
|
|
3933
|
+
failedToUtc?: string | null;
|
|
3934
|
+
}
|
|
3935
|
+
export interface LosSyncFailuresSummary {
|
|
3936
|
+
/** @format int32 */
|
|
3937
|
+
totalFailures: number;
|
|
3938
|
+
/** @format int32 */
|
|
3939
|
+
accountsAffected: number;
|
|
3940
|
+
topAccounts: AccountFailureCount[];
|
|
3941
|
+
buckets: FailureBucket[];
|
|
3942
|
+
/** @format int32 */
|
|
3943
|
+
previousTotalFailures: number;
|
|
3851
3944
|
}
|
|
3852
3945
|
export interface LosSyncPaginated {
|
|
3853
3946
|
rows: LosSync[];
|
|
@@ -5418,6 +5511,8 @@ export interface UpdateAiPromptRequest {
|
|
|
5418
5511
|
outputType?: AiOutputType | null;
|
|
5419
5512
|
scope?: AiPromptScope | null;
|
|
5420
5513
|
inputHint?: string | null;
|
|
5514
|
+
isFeatured?: boolean | null;
|
|
5515
|
+
icon?: string | null;
|
|
5421
5516
|
}
|
|
5422
5517
|
export interface UpdateAiPromptToolsRequest {
|
|
5423
5518
|
tools: AiPromptToolInput[];
|
|
@@ -5430,6 +5525,16 @@ export interface UpdateAiUrlSourceRequest {
|
|
|
5430
5525
|
category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
5431
5526
|
scope: "FullDomain" | "SpecificPath";
|
|
5432
5527
|
}
|
|
5528
|
+
export interface UpdateCompanyDocumentFolderRequest {
|
|
5529
|
+
name: string;
|
|
5530
|
+
description?: string | null;
|
|
5531
|
+
}
|
|
5532
|
+
export interface UpdateCompanyDocumentRequest {
|
|
5533
|
+
name?: string | null;
|
|
5534
|
+
/** @format uuid */
|
|
5535
|
+
folderID?: string | null;
|
|
5536
|
+
content?: string | null;
|
|
5537
|
+
}
|
|
5433
5538
|
export interface UpdateCustomFieldDefinitionRequest {
|
|
5434
5539
|
isRequired: boolean;
|
|
5435
5540
|
/** @format int32 */
|
|
@@ -5990,7 +6095,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
5990
6095
|
}
|
|
5991
6096
|
/**
|
|
5992
6097
|
* @title The Big POS API
|
|
5993
|
-
* @version v2.
|
|
6098
|
+
* @version v2.48.0
|
|
5994
6099
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
5995
6100
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
5996
6101
|
*/
|
|
@@ -6550,6 +6655,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6550
6655
|
* @response `200` `AiChat` OK
|
|
6551
6656
|
* @response `400` `ProblemDetails` Bad Request
|
|
6552
6657
|
* @response `401` `ProblemDetails` Unauthorized
|
|
6658
|
+
* @response `429` `ProblemDetails` Too Many Requests
|
|
6553
6659
|
*/
|
|
6554
6660
|
aiChat: (data: AiChatRequest, params?: RequestParams) => Promise<AxiosResponse<AiChat, any, {}>>;
|
|
6555
6661
|
/**
|
|
@@ -7295,6 +7401,186 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7295
7401
|
* @response `200` `ClosedLoansReport` OK
|
|
7296
7402
|
*/
|
|
7297
7403
|
getClosedLoansReport: (data: ClosedLoansReportRequest, params?: RequestParams) => Promise<AxiosResponse<ClosedLoansReport, any, {}>>;
|
|
7404
|
+
/**
|
|
7405
|
+
* No description
|
|
7406
|
+
*
|
|
7407
|
+
* @tags CompanyDocumentFolders
|
|
7408
|
+
* @name GetCompanyDocumentFolders
|
|
7409
|
+
* @summary Get all company document folders
|
|
7410
|
+
* @request GET:/api/company-document-folders
|
|
7411
|
+
* @secure
|
|
7412
|
+
* @response `200` `(CompanyDocumentFolder)[]` OK
|
|
7413
|
+
*/
|
|
7414
|
+
getCompanyDocumentFolders: (params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder[], any, {}>>;
|
|
7415
|
+
/**
|
|
7416
|
+
* No description
|
|
7417
|
+
*
|
|
7418
|
+
* @tags CompanyDocumentFolders
|
|
7419
|
+
* @name CreateCompanyDocumentFolder
|
|
7420
|
+
* @summary Create company document folder
|
|
7421
|
+
* @request POST:/api/company-document-folders
|
|
7422
|
+
* @secure
|
|
7423
|
+
* @response `201` `CompanyDocumentFolder` Created
|
|
7424
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7425
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7426
|
+
*/
|
|
7427
|
+
createCompanyDocumentFolder: (data: CreateCompanyDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
|
|
7428
|
+
/**
|
|
7429
|
+
* No description
|
|
7430
|
+
*
|
|
7431
|
+
* @tags CompanyDocumentFolders
|
|
7432
|
+
* @name GetCompanyDocumentFolder
|
|
7433
|
+
* @summary Get company document folder by ID
|
|
7434
|
+
* @request GET:/api/company-document-folders/{id}
|
|
7435
|
+
* @secure
|
|
7436
|
+
* @response `200` `CompanyDocumentFolder` OK
|
|
7437
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7438
|
+
*/
|
|
7439
|
+
getCompanyDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
|
|
7440
|
+
/**
|
|
7441
|
+
* No description
|
|
7442
|
+
*
|
|
7443
|
+
* @tags CompanyDocumentFolders
|
|
7444
|
+
* @name UpdateCompanyDocumentFolder
|
|
7445
|
+
* @summary Update company document folder
|
|
7446
|
+
* @request PUT:/api/company-document-folders/{id}
|
|
7447
|
+
* @secure
|
|
7448
|
+
* @response `200` `CompanyDocumentFolder` OK
|
|
7449
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7450
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7451
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7452
|
+
*/
|
|
7453
|
+
updateCompanyDocumentFolder: (id: string, data: UpdateCompanyDocumentFolderRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentFolder, any, {}>>;
|
|
7454
|
+
/**
|
|
7455
|
+
* No description
|
|
7456
|
+
*
|
|
7457
|
+
* @tags CompanyDocumentFolders
|
|
7458
|
+
* @name DeleteCompanyDocumentFolder
|
|
7459
|
+
* @summary Delete company document folder
|
|
7460
|
+
* @request DELETE:/api/company-document-folders/{id}
|
|
7461
|
+
* @secure
|
|
7462
|
+
* @response `204` `void` No Content
|
|
7463
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7464
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7465
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7466
|
+
*/
|
|
7467
|
+
deleteCompanyDocumentFolder: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
7468
|
+
/**
|
|
7469
|
+
* No description
|
|
7470
|
+
*
|
|
7471
|
+
* @tags CompanyDocuments
|
|
7472
|
+
* @name SearchCompanyDocuments
|
|
7473
|
+
* @summary Search company documents
|
|
7474
|
+
* @request POST:/api/company-documents/search
|
|
7475
|
+
* @secure
|
|
7476
|
+
* @response `200` `CompanyDocumentPaginated` OK
|
|
7477
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7478
|
+
*/
|
|
7479
|
+
searchCompanyDocuments: (data: CompanyDocumentSearchCriteria, query?: {
|
|
7480
|
+
/** @format int32 */
|
|
7481
|
+
pageSize?: number;
|
|
7482
|
+
/** @format int32 */
|
|
7483
|
+
pageNumber?: number;
|
|
7484
|
+
sortBy?: string;
|
|
7485
|
+
sortDirection?: string;
|
|
7486
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CompanyDocumentPaginated, any, {}>>;
|
|
7487
|
+
/**
|
|
7488
|
+
* No description
|
|
7489
|
+
*
|
|
7490
|
+
* @tags CompanyDocuments
|
|
7491
|
+
* @name GetCompanyDocument
|
|
7492
|
+
* @summary Get company document by ID
|
|
7493
|
+
* @request GET:/api/company-documents/{id}
|
|
7494
|
+
* @secure
|
|
7495
|
+
* @response `200` `CompanyDocument` OK
|
|
7496
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7497
|
+
*/
|
|
7498
|
+
getCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7499
|
+
/**
|
|
7500
|
+
* No description
|
|
7501
|
+
*
|
|
7502
|
+
* @tags CompanyDocuments
|
|
7503
|
+
* @name UpdateCompanyDocument
|
|
7504
|
+
* @summary Update company document
|
|
7505
|
+
* @request PUT:/api/company-documents/{id}
|
|
7506
|
+
* @secure
|
|
7507
|
+
* @response `200` `CompanyDocument` OK
|
|
7508
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7509
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7510
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7511
|
+
*/
|
|
7512
|
+
updateCompanyDocument: (id: string, data: UpdateCompanyDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7513
|
+
/**
|
|
7514
|
+
* No description
|
|
7515
|
+
*
|
|
7516
|
+
* @tags CompanyDocuments
|
|
7517
|
+
* @name DeleteCompanyDocument
|
|
7518
|
+
* @summary Delete company document
|
|
7519
|
+
* @request DELETE:/api/company-documents/{id}
|
|
7520
|
+
* @secure
|
|
7521
|
+
* @response `204` `void` No Content
|
|
7522
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7523
|
+
*/
|
|
7524
|
+
deleteCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
7525
|
+
/**
|
|
7526
|
+
* No description
|
|
7527
|
+
*
|
|
7528
|
+
* @tags CompanyDocuments
|
|
7529
|
+
* @name DownloadCompanyDocument
|
|
7530
|
+
* @summary Download company document
|
|
7531
|
+
* @request GET:/api/company-documents/{id}/download
|
|
7532
|
+
* @secure
|
|
7533
|
+
* @response `200` `void` OK
|
|
7534
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7535
|
+
*/
|
|
7536
|
+
downloadCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
7537
|
+
/**
|
|
7538
|
+
* No description
|
|
7539
|
+
*
|
|
7540
|
+
* @tags CompanyDocuments
|
|
7541
|
+
* @name CreateCompanyDocument
|
|
7542
|
+
* @summary Upload company document
|
|
7543
|
+
* @request POST:/api/company-documents
|
|
7544
|
+
* @secure
|
|
7545
|
+
* @response `201` `CompanyDocument` Created
|
|
7546
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7547
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7548
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7549
|
+
*/
|
|
7550
|
+
createCompanyDocument: (data: {
|
|
7551
|
+
/** @format binary */
|
|
7552
|
+
file?: File;
|
|
7553
|
+
/** @format uuid */
|
|
7554
|
+
folderID?: string;
|
|
7555
|
+
name?: string;
|
|
7556
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7557
|
+
/**
|
|
7558
|
+
* No description
|
|
7559
|
+
*
|
|
7560
|
+
* @tags CompanyDocuments
|
|
7561
|
+
* @name CreateCompanyTextDocument
|
|
7562
|
+
* @summary Create free-form text company document
|
|
7563
|
+
* @request POST:/api/company-documents/text
|
|
7564
|
+
* @secure
|
|
7565
|
+
* @response `201` `CompanyDocument` Created
|
|
7566
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7567
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7568
|
+
* @response `409` `ProblemDetails` Conflict
|
|
7569
|
+
*/
|
|
7570
|
+
createCompanyTextDocument: (data: CreateCompanyTextDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7571
|
+
/**
|
|
7572
|
+
* No description
|
|
7573
|
+
*
|
|
7574
|
+
* @tags CompanyDocuments
|
|
7575
|
+
* @name ReindexCompanyDocument
|
|
7576
|
+
* @summary Re-index a failed company document
|
|
7577
|
+
* @request POST:/api/company-documents/{id}/reindex
|
|
7578
|
+
* @secure
|
|
7579
|
+
* @response `200` `CompanyDocument` OK
|
|
7580
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
7581
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7582
|
+
*/
|
|
7583
|
+
reindexCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
|
|
7298
7584
|
/**
|
|
7299
7585
|
* No description
|
|
7300
7586
|
*
|
|
@@ -9951,6 +10237,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9951
10237
|
/** @format uuid */
|
|
9952
10238
|
accountId?: string;
|
|
9953
10239
|
}, params?: RequestParams) => Promise<AxiosResponse<LosSyncPaginated, any, {}>>;
|
|
10240
|
+
/**
|
|
10241
|
+
* No description
|
|
10242
|
+
*
|
|
10243
|
+
* @tags LosSyncFailures
|
|
10244
|
+
* @name GetInboundSyncFailuresSummary
|
|
10245
|
+
* @summary Summarize cross-account failed inbound Encompass syncs (SuperAdmin)
|
|
10246
|
+
* @request POST:/api/monitoring/inbound-sync-failures/summary
|
|
10247
|
+
* @secure
|
|
10248
|
+
* @response `200` `LosSyncFailuresSummary` OK
|
|
10249
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
10250
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
10251
|
+
*/
|
|
10252
|
+
getInboundSyncFailuresSummary: (data: LosSyncFailuresSearchCriteria, query?: {
|
|
10253
|
+
/** @format uuid */
|
|
10254
|
+
accountId?: string;
|
|
10255
|
+
}, params?: RequestParams) => Promise<AxiosResponse<LosSyncFailuresSummary, any, {}>>;
|
|
9954
10256
|
/**
|
|
9955
10257
|
* No description
|
|
9956
10258
|
*
|
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.
|
|
107
|
+
* @version v2.48.0
|
|
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
|
*/
|
|
@@ -601,6 +601,7 @@ export class Api extends HttpClient {
|
|
|
601
601
|
* @response `200` `AiChat` OK
|
|
602
602
|
* @response `400` `ProblemDetails` Bad Request
|
|
603
603
|
* @response `401` `ProblemDetails` Unauthorized
|
|
604
|
+
* @response `429` `ProblemDetails` Too Many Requests
|
|
604
605
|
*/
|
|
605
606
|
aiChat: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/chats`, method: "POST", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
|
|
606
607
|
/**
|
|
@@ -1265,6 +1266,173 @@ export class Api extends HttpClient {
|
|
|
1265
1266
|
* @response `200` `ClosedLoansReport` OK
|
|
1266
1267
|
*/
|
|
1267
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)),
|
|
1268
1436
|
/**
|
|
1269
1437
|
* No description
|
|
1270
1438
|
*
|
|
@@ -3644,6 +3812,19 @@ export class Api extends HttpClient {
|
|
|
3644
3812
|
* @response `403` `ProblemDetails` Forbidden
|
|
3645
3813
|
*/
|
|
3646
3814
|
searchInboundSyncFailures: (data, query, params = {}) => this.request(Object.assign({ path: `/api/monitoring/inbound-sync-failures/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
3815
|
+
/**
|
|
3816
|
+
* No description
|
|
3817
|
+
*
|
|
3818
|
+
* @tags LosSyncFailures
|
|
3819
|
+
* @name GetInboundSyncFailuresSummary
|
|
3820
|
+
* @summary Summarize cross-account failed inbound Encompass syncs (SuperAdmin)
|
|
3821
|
+
* @request POST:/api/monitoring/inbound-sync-failures/summary
|
|
3822
|
+
* @secure
|
|
3823
|
+
* @response `200` `LosSyncFailuresSummary` OK
|
|
3824
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
3825
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
3826
|
+
*/
|
|
3827
|
+
getInboundSyncFailuresSummary: (data, query, params = {}) => this.request(Object.assign({ path: `/api/monitoring/inbound-sync-failures/summary`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
|
|
3647
3828
|
/**
|
|
3648
3829
|
* No description
|
|
3649
3830
|
*
|