@matech/thebigpos-sdk 2.37.6-aibi-12 → 2.37.8

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.
Files changed (11) hide show
  1. package/.husky/pre-commit +2 -2
  2. package/LICENSE +21 -21
  3. package/README.md +73 -73
  4. package/dist/index.d.ts +424 -1165
  5. package/dist/index.js +15 -401
  6. package/dist/index.js.map +1 -1
  7. package/docs/sdk_generation.md +149 -0
  8. package/package.json +39 -39
  9. package/scripts/apply-json-patch-content-type.js +56 -56
  10. package/src/index.ts +533 -1610
  11. package/tsconfig.json +27 -27
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.37.6
107
+ * @version v2.37.8
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
  */
@@ -241,404 +241,6 @@ export class Api extends HttpClient {
241
241
  * @response `422` `ProblemDetails` Client Error
242
242
  */
243
243
  updateAccountBilling: (id, data, params = {}) => this.request(Object.assign({ path: `/api/accounts/${id}/billing`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
244
- /**
245
- * No description
246
- *
247
- * @tags AiAdmin
248
- * @name GetAiAuditLogs
249
- * @summary Get paginated audit logs
250
- * @request GET:/api/ai/admin/audit-logs
251
- * @secure
252
- * @response `200` `AiAuditLogPaginated` Success
253
- */
254
- getAiAuditLogs: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/audit-logs`, method: "GET", query: query, secure: true, format: "json" }, params)),
255
- /**
256
- * No description
257
- *
258
- * @tags AiAdmin
259
- * @name GetAiAdminStats
260
- * @summary Get AI admin dashboard stats
261
- * @request GET:/api/ai/admin/stats
262
- * @secure
263
- * @response `200` `AiAdminStats` Success
264
- */
265
- getAiAdminStats: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/stats`, method: "GET", query: query, secure: true, format: "json" }, params)),
266
- /**
267
- * No description
268
- *
269
- * @tags AiAdminPrompt
270
- * @name GetAiPrompts
271
- * @summary Get all prompts
272
- * @request GET:/api/ai/admin/prompts
273
- * @secure
274
- * @response `200` `(AiPrompt)[]` Success
275
- */
276
- getAiPrompts: (params = {}) => this.request(Object.assign({ path: `/api/ai/admin/prompts`, method: "GET", secure: true, format: "json" }, params)),
277
- /**
278
- * No description
279
- *
280
- * @tags AiAdminPrompt
281
- * @name CreateAiPrompt
282
- * @summary Create custom prompt
283
- * @request POST:/api/ai/admin/prompts
284
- * @secure
285
- * @response `201` `AiPrompt` Created
286
- * @response `400` `ProblemDetails` Bad Request
287
- */
288
- createAiPrompt: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/prompts`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
289
- /**
290
- * No description
291
- *
292
- * @tags AiAdminPrompt
293
- * @name GetAiPrompt
294
- * @summary Get prompt by ID
295
- * @request GET:/api/ai/admin/prompts/{id}
296
- * @secure
297
- * @response `200` `AiPrompt` Success
298
- * @response `404` `ProblemDetails` Not Found
299
- */
300
- getAiPrompt: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/prompts/${id}`, method: "GET", secure: true, format: "json" }, params)),
301
- /**
302
- * No description
303
- *
304
- * @tags AiAdminPrompt
305
- * @name UpdateAiPrompt
306
- * @summary Update prompt
307
- * @request PUT:/api/ai/admin/prompts/{id}
308
- * @secure
309
- * @response `200` `AiPrompt` Success
310
- * @response `400` `ProblemDetails` Bad Request
311
- * @response `404` `ProblemDetails` Not Found
312
- */
313
- updateAiPrompt: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/prompts/${id}`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
314
- /**
315
- * No description
316
- *
317
- * @tags AiAdminPrompt
318
- * @name DeleteAiPrompt
319
- * @summary Delete prompt
320
- * @request DELETE:/api/ai/admin/prompts/{id}
321
- * @secure
322
- * @response `204` `void` No Content
323
- * @response `400` `ProblemDetails` Bad Request
324
- * @response `404` `ProblemDetails` Not Found
325
- */
326
- deleteAiPrompt: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/prompts/${id}`, method: "DELETE", secure: true }, params)),
327
- /**
328
- * No description
329
- *
330
- * @tags AiAdminPrompt
331
- * @name ToggleAiPrompt
332
- * @summary Toggle prompt active/inactive
333
- * @request PATCH:/api/ai/admin/prompts/{id}/toggle
334
- * @secure
335
- * @response `200` `AiPrompt` Success
336
- * @response `404` `ProblemDetails` Not Found
337
- */
338
- toggleAiPrompt: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/prompts/${id}/toggle`, method: "PATCH", secure: true, format: "json" }, params)),
339
- /**
340
- * No description
341
- *
342
- * @tags AiAdminPrompt
343
- * @name GenerateAiSystemPrompt
344
- * @summary Generate a system prompt from description
345
- * @request POST:/api/ai/admin/prompts/generate
346
- * @secure
347
- * @response `200` `GenerateSystemPrompt` Success
348
- * @response `400` `ProblemDetails` Bad Request
349
- */
350
- generateAiSystemPrompt: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/prompts/generate`, method: "POST", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
351
- /**
352
- * No description
353
- *
354
- * @tags AiAdminPrompt
355
- * @name GetSupportedModels
356
- * @summary Get supported LLM models
357
- * @request GET:/api/ai/admin/prompts/supported-models
358
- * @secure
359
- * @response `200` `(SupportedModel)[]` Success
360
- */
361
- getSupportedModels: (params = {}) => this.request(Object.assign({ path: `/api/ai/admin/prompts/supported-models`, method: "GET", secure: true, format: "json" }, params)),
362
- /**
363
- * No description
364
- *
365
- * @tags AiCanonicalField
366
- * @name GetAiCanonicalFields
367
- * @summary Get all canonical fields
368
- * @request GET:/api/ai/admin/fields
369
- * @secure
370
- * @response `200` `(AiCanonicalField)[]` Success
371
- */
372
- getAiCanonicalFields: (params = {}) => this.request(Object.assign({ path: `/api/ai/admin/fields`, method: "GET", secure: true, format: "json" }, params)),
373
- /**
374
- * No description
375
- *
376
- * @tags AiCanonicalField
377
- * @name CreateAiCanonicalField
378
- * @summary Create canonical field
379
- * @request POST:/api/ai/admin/fields
380
- * @secure
381
- * @response `201` `AiCanonicalField` Created
382
- * @response `400` `ProblemDetails` Bad Request
383
- */
384
- createAiCanonicalField: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/fields`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
385
- /**
386
- * No description
387
- *
388
- * @tags AiCanonicalField
389
- * @name GetAiCanonicalField
390
- * @summary Get canonical field by ID
391
- * @request GET:/api/ai/admin/fields/{id}
392
- * @secure
393
- * @response `200` `AiCanonicalField` Success
394
- * @response `404` `ProblemDetails` Not Found
395
- */
396
- getAiCanonicalField: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/fields/${id}`, method: "GET", secure: true, format: "json" }, params)),
397
- /**
398
- * No description
399
- *
400
- * @tags AiCanonicalField
401
- * @name UpdateAiCanonicalField
402
- * @summary Update canonical field
403
- * @request PUT:/api/ai/admin/fields/{id}
404
- * @secure
405
- * @response `200` `AiCanonicalField` Success
406
- * @response `400` `ProblemDetails` Bad Request
407
- * @response `404` `ProblemDetails` Not Found
408
- */
409
- updateAiCanonicalField: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/fields/${id}`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
410
- /**
411
- * No description
412
- *
413
- * @tags AiCanonicalField
414
- * @name DeleteAiCanonicalField
415
- * @summary Delete canonical field
416
- * @request DELETE:/api/ai/admin/fields/{id}
417
- * @secure
418
- * @response `204` `void` No Content
419
- * @response `404` `ProblemDetails` Not Found
420
- */
421
- deleteAiCanonicalField: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/fields/${id}`, method: "DELETE", secure: true }, params)),
422
- /**
423
- * No description
424
- *
425
- * @tags AiCanonicalField
426
- * @name ToggleAiCanonicalField
427
- * @summary Toggle canonical field active/inactive
428
- * @request PATCH:/api/ai/admin/fields/{id}/toggle
429
- * @secure
430
- * @response `200` `AiCanonicalField` Success
431
- * @response `404` `ProblemDetails` Not Found
432
- */
433
- toggleAiCanonicalField: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/fields/${id}/toggle`, method: "PATCH", secure: true, format: "json" }, params)),
434
- /**
435
- * No description
436
- *
437
- * @tags AiChat
438
- * @name AiChat
439
- * @summary Send AI chat message
440
- * @request POST:/api/ai/chat
441
- * @secure
442
- * @response `200` `AiChat` Success
443
- * @response `400` `ProblemDetails` Bad Request
444
- * @response `401` `ProblemDetails` Unauthorized
445
- */
446
- aiChat: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/chat`, method: "POST", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
447
- /**
448
- * No description
449
- *
450
- * @tags AiConversation
451
- * @name GetAiConversations
452
- * @summary Get user conversations
453
- * @request GET:/api/ai/conversations
454
- * @secure
455
- * @response `200` `AiConversationListItemPaginated` Success
456
- */
457
- getAiConversations: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations`, method: "GET", query: query, secure: true, format: "json" }, params)),
458
- /**
459
- * No description
460
- *
461
- * @tags AiConversation
462
- * @name GetAiConversation
463
- * @summary Get conversation with messages
464
- * @request GET:/api/ai/conversations/{id}
465
- * @secure
466
- * @response `200` `AiConversationDetail` Success
467
- * @response `403` `ProblemDetails` Forbidden
468
- * @response `404` `ProblemDetails` Not Found
469
- */
470
- getAiConversation: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/${id}`, method: "GET", secure: true, format: "json" }, params)),
471
- /**
472
- * No description
473
- *
474
- * @tags AiConversation
475
- * @name DeleteAiConversation
476
- * @summary Delete conversation
477
- * @request DELETE:/api/ai/conversations/{id}
478
- * @secure
479
- * @response `204` `void` No Content
480
- * @response `403` `ProblemDetails` Forbidden
481
- * @response `404` `ProblemDetails` Not Found
482
- */
483
- deleteAiConversation: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/conversations/${id}`, method: "DELETE", secure: true }, params)),
484
- /**
485
- * No description
486
- *
487
- * @tags AiGuardrail
488
- * @name GetAiGuardrails
489
- * @summary Get all guardrails
490
- * @request GET:/api/ai/admin/guardrails
491
- * @secure
492
- * @response `200` `(AiGuardrail)[]` Success
493
- */
494
- getAiGuardrails: (params = {}) => this.request(Object.assign({ path: `/api/ai/admin/guardrails`, method: "GET", secure: true, format: "json" }, params)),
495
- /**
496
- * No description
497
- *
498
- * @tags AiGuardrail
499
- * @name CreateAiGuardrail
500
- * @summary Create custom guardrail
501
- * @request POST:/api/ai/admin/guardrails
502
- * @secure
503
- * @response `201` `AiGuardrail` Created
504
- * @response `400` `ProblemDetails` Bad Request
505
- */
506
- createAiGuardrail: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/guardrails`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
507
- /**
508
- * No description
509
- *
510
- * @tags AiGuardrail
511
- * @name GetAiGuardrail
512
- * @summary Get guardrail by ID
513
- * @request GET:/api/ai/admin/guardrails/{id}
514
- * @secure
515
- * @response `200` `AiGuardrail` Success
516
- * @response `404` `ProblemDetails` Not Found
517
- */
518
- getAiGuardrail: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/guardrails/${id}`, method: "GET", secure: true, format: "json" }, params)),
519
- /**
520
- * No description
521
- *
522
- * @tags AiGuardrail
523
- * @name UpdateAiGuardrail
524
- * @summary Update guardrail
525
- * @request PUT:/api/ai/admin/guardrails/{id}
526
- * @secure
527
- * @response `200` `AiGuardrail` Success
528
- * @response `400` `ProblemDetails` Bad Request
529
- * @response `404` `ProblemDetails` Not Found
530
- */
531
- updateAiGuardrail: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/guardrails/${id}`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
532
- /**
533
- * No description
534
- *
535
- * @tags AiGuardrail
536
- * @name DeleteAiGuardrail
537
- * @summary Delete guardrail
538
- * @request DELETE:/api/ai/admin/guardrails/{id}
539
- * @secure
540
- * @response `204` `void` No Content
541
- * @response `400` `ProblemDetails` Bad Request
542
- * @response `404` `ProblemDetails` Not Found
543
- */
544
- deleteAiGuardrail: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/guardrails/${id}`, method: "DELETE", secure: true }, params)),
545
- /**
546
- * No description
547
- *
548
- * @tags AiGuardrail
549
- * @name ToggleAiGuardrail
550
- * @summary Toggle guardrail enabled/disabled
551
- * @request PATCH:/api/ai/admin/guardrails/{id}/toggle
552
- * @secure
553
- * @response `200` `AiGuardrail` Success
554
- * @response `404` `ProblemDetails` Not Found
555
- */
556
- toggleAiGuardrail: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/guardrails/${id}/toggle`, method: "PATCH", secure: true, format: "json" }, params)),
557
- /**
558
- * No description
559
- *
560
- * @tags AiPrompt
561
- * @name GetAvailablePrompts
562
- * @summary Get available prompts for current user
563
- * @request GET:/api/ai/prompts
564
- * @secure
565
- * @response `200` `(AiPromptSummary)[]` Success
566
- */
567
- getAvailablePrompts: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts`, method: "GET", query: query, secure: true, format: "json" }, params)),
568
- /**
569
- * No description
570
- *
571
- * @tags AiUrlSource
572
- * @name GetAiUrlSources
573
- * @summary Get all URL sources
574
- * @request GET:/api/ai/admin/url-sources
575
- * @secure
576
- * @response `200` `(AiUrlSource)[]` Success
577
- */
578
- getAiUrlSources: (params = {}) => this.request(Object.assign({ path: `/api/ai/admin/url-sources`, method: "GET", secure: true, format: "json" }, params)),
579
- /**
580
- * No description
581
- *
582
- * @tags AiUrlSource
583
- * @name CreateAiUrlSource
584
- * @summary Create URL source
585
- * @request POST:/api/ai/admin/url-sources
586
- * @secure
587
- * @response `201` `AiUrlSource` Created
588
- * @response `400` `ProblemDetails` Bad Request
589
- * @response `409` `ProblemDetails` Conflict
590
- */
591
- createAiUrlSource: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/url-sources`, method: "POST", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
592
- /**
593
- * No description
594
- *
595
- * @tags AiUrlSource
596
- * @name GetAiUrlSource
597
- * @summary Get URL source by ID
598
- * @request GET:/api/ai/admin/url-sources/{id}
599
- * @secure
600
- * @response `200` `AiUrlSource` Success
601
- * @response `404` `ProblemDetails` Not Found
602
- */
603
- getAiUrlSource: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/url-sources/${id}`, method: "GET", secure: true, format: "json" }, params)),
604
- /**
605
- * No description
606
- *
607
- * @tags AiUrlSource
608
- * @name UpdateAiUrlSource
609
- * @summary Update URL source
610
- * @request PUT:/api/ai/admin/url-sources/{id}
611
- * @secure
612
- * @response `200` `AiUrlSource` Success
613
- * @response `400` `ProblemDetails` Bad Request
614
- * @response `404` `ProblemDetails` Not Found
615
- * @response `409` `ProblemDetails` Conflict
616
- */
617
- updateAiUrlSource: (id, data, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/url-sources/${id}`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
618
- /**
619
- * No description
620
- *
621
- * @tags AiUrlSource
622
- * @name DeleteAiUrlSource
623
- * @summary Delete URL source
624
- * @request DELETE:/api/ai/admin/url-sources/{id}
625
- * @secure
626
- * @response `204` `void` No Content
627
- * @response `404` `ProblemDetails` Not Found
628
- */
629
- deleteAiUrlSource: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/url-sources/${id}`, method: "DELETE", secure: true }, params)),
630
- /**
631
- * No description
632
- *
633
- * @tags AiUrlSource
634
- * @name ToggleAiUrlSource
635
- * @summary Toggle URL source active/inactive
636
- * @request PATCH:/api/ai/admin/url-sources/{id}/toggle
637
- * @secure
638
- * @response `200` `AiUrlSource` Success
639
- * @response `404` `ProblemDetails` Not Found
640
- */
641
- toggleAiUrlSource: (id, params = {}) => this.request(Object.assign({ path: `/api/ai/admin/url-sources/${id}/toggle`, method: "PATCH", secure: true, format: "json" }, params)),
642
244
  /**
643
245
  * No description
644
246
  *
@@ -649,7 +251,7 @@ export class Api extends HttpClient {
649
251
  * @secure
650
252
  * @response `200` `AuditLogEntryPaginated` Success
651
253
  */
652
- searchAuditLogs: (data, query, params = {}) => this.request(Object.assign({ path: `/api/audit-logs/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
254
+ searchAuditLogs: (data, query, params = {}) => this.request(Object.assign({ path: `/api/audit-logs/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
653
255
  /**
654
256
  * No description
655
257
  *
@@ -1297,6 +899,18 @@ export class Api extends HttpClient {
1297
899
  * @response `500` `EncompassError` Server Error
1298
900
  */
1299
901
  getUserPackages: (query, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/eclose/packages`, method: "GET", query: query, secure: true, format: "json" }, params)),
902
+ /**
903
+ * No description
904
+ *
905
+ * @tags Encompass Recipients
906
+ * @name GetUserRecipients
907
+ * @request GET:/api/los/encompass/eclose/recipients
908
+ * @secure
909
+ * @response `200` `(EncompassRecipientItem)[]` Success
910
+ * @response `401` `EncompassError` Unauthorized
911
+ * @response `500` `EncompassError` Server Error
912
+ */
913
+ getUserRecipients: (params = {}) => this.request(Object.assign({ path: `/api/los/encompass/eclose/recipients`, method: "GET", secure: true, format: "json" }, params)),
1300
914
  /**
1301
915
  * No description
1302
916
  *
@@ -2092,7 +1706,7 @@ export class Api extends HttpClient {
2092
1706
  * @summary Download By ID
2093
1707
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
2094
1708
  * @secure
2095
- * @response `200` `string` Success
1709
+ * @response `200` `Blob` Success
2096
1710
  * @response `404` `ProblemDetails` Not Found
2097
1711
  */
2098
1712
  downloadLoanDocument: (loanId, documentId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/${documentId}/download`, method: "GET", secure: true, format: "json" }, params)),