@matech/thebigpos-sdk 2.48.0-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 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";
@@ -1036,6 +1038,55 @@ export interface CompanyAddress {
1036
1038
  state: string;
1037
1039
  zip: string;
1038
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
+ }
1039
1090
  export interface ConditionComment {
1040
1091
  commentId: string;
1041
1092
  comments: string;
@@ -1181,6 +1232,16 @@ export interface CreateBranchRequest {
1181
1232
  corporateID: string;
1182
1233
  type: string;
1183
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
+ }
1184
1245
  export interface CreateCustomFieldDefinitionRequest {
1185
1246
  isRequired: boolean;
1186
1247
  /** @format int32 */
@@ -5464,6 +5525,16 @@ export interface UpdateAiUrlSourceRequest {
5464
5525
  category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5465
5526
  scope: "FullDomain" | "SpecificPath";
5466
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
+ }
5467
5538
  export interface UpdateCustomFieldDefinitionRequest {
5468
5539
  isRequired: boolean;
5469
5540
  /** @format int32 */
@@ -7330,6 +7401,186 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7330
7401
  * @response `200` `ClosedLoansReport` OK
7331
7402
  */
7332
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, {}>>;
7333
7584
  /**
7334
7585
  * No description
7335
7586
  *
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
  *