@matech/thebigpos-sdk 2.43.0-aibi-3 → 2.43.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.
package/dist/index.d.ts CHANGED
@@ -67,16 +67,6 @@ export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
67
67
  export type BorrowerApplicationStatus = "Draft" | "Complete";
68
68
  export type BillingType = "ClosedLoan" | "LoanOfficer";
69
69
  export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
70
- export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
71
- export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
72
- export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
73
- export type AiQueryTemplateName = "PipelineSummary" | "LoanDetail" | "LoansClosing" | "StaleLoans" | "LoansByType" | "LoansByOfficer" | "AverageLoanAmount" | "LockedVsUnlocked" | "LoansByPurpose" | "LoansByPropertyState" | "LoansByRate" | "DtiLtvRisk" | "DisclosureTracking" | "NewLoans" | "ExpiringLocks" | "ClosedLoans";
74
- export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
75
- export type AiOutputType = "Text" | "Document";
76
- export type AiIntent = "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta";
77
- export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
78
- export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
79
- export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded";
80
70
  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";
81
71
  export interface ASOSettings {
82
72
  enabled: boolean;
@@ -156,13 +146,11 @@ export interface AccountSettings {
156
146
  smsNumber?: string | null;
157
147
  ssoHostOverride?: string | null;
158
148
  isEarlyAdopter: boolean;
159
- isAIEnabled: boolean;
160
149
  }
161
150
  export interface AccountSettingsRequest {
162
151
  isSmsEnabled: boolean;
163
152
  smsNumber?: string | null;
164
153
  isEarlyAdopter: boolean;
165
- isAIEnabled: boolean;
166
154
  }
167
155
  export interface Action {
168
156
  /** @format uuid */
@@ -306,244 +294,6 @@ export interface AffordabilityCalculatorRequest {
306
294
  /** @format double */
307
295
  annualInsurance: number;
308
296
  }
309
- export interface AiAdminSettings {
310
- bedrockModelId: string;
311
- /** @format int32 */
312
- maxTokens: number;
313
- /** @format double */
314
- temperature: number;
315
- /** @format int32 */
316
- conversationContextTurns: number;
317
- /** @format int32 */
318
- requestTimeoutSeconds: number;
319
- bedrockRegion: string;
320
- }
321
- export interface AiAdminSettingsRequest {
322
- bedrockModelId?: string | null;
323
- /** @format int32 */
324
- maxTokens?: number | null;
325
- /** @format double */
326
- temperature?: number | null;
327
- /** @format int32 */
328
- conversationContextTurns?: number | null;
329
- /** @format int32 */
330
- requestTimeoutSeconds?: number | null;
331
- }
332
- export interface AiAdminStats {
333
- /** @format int32 */
334
- totalRequests: number;
335
- /** @format int32 */
336
- blockedRequests: number;
337
- /** @format double */
338
- averageResponseTimeMs: number;
339
- intentDistribution: Record<string, number>;
340
- topQueryTemplates: Record<string, number>;
341
- period: string;
342
- }
343
- export interface AiAuditLog {
344
- /** @format uuid */
345
- id: string;
346
- /** @format uuid */
347
- requestId: string;
348
- /** @format uuid */
349
- userId: string;
350
- eventType: "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded";
351
- details?: any;
352
- /** @format date-time */
353
- createdAt: string;
354
- }
355
- export interface AiAuditLogPaginated {
356
- rows: AiAuditLog[];
357
- pagination: Pagination;
358
- /** @format int64 */
359
- count: number;
360
- }
361
- export interface AiCanonicalField {
362
- /** @format uuid */
363
- id: string;
364
- canonicalName: string;
365
- displayName: string;
366
- description: string;
367
- allowedRoles: string[];
368
- efPath?: string | null;
369
- isPii: boolean;
370
- isActive: boolean;
371
- dataSource: string;
372
- isDefault: boolean;
373
- category?: string | null;
374
- jsonPropertyName?: string | null;
375
- textractKey?: string | null;
376
- textractKeyAliases?: string | null;
377
- hasAccountOverride: boolean;
378
- /** @format date-time */
379
- createdAt: string;
380
- /** @format date-time */
381
- updatedAt?: string | null;
382
- }
383
- export interface AiChat {
384
- /** @format uuid */
385
- conversationId: string;
386
- /** @format uuid */
387
- messageId: string;
388
- response: AiChatBody;
389
- metadata: AiChatMetadata;
390
- }
391
- export interface AiChatBody {
392
- text: string;
393
- data?: AiChatStructuredData | null;
394
- }
395
- export interface AiChatMessage {
396
- /** @format uuid */
397
- id: string;
398
- userMessage: string;
399
- assistantResponse: string;
400
- intent?: AiIntent | null;
401
- fieldsAccessed?: string[] | null;
402
- data?: AiChatStructuredData | null;
403
- /** @format date-time */
404
- createdAt: string;
405
- }
406
- export interface AiChatMessagePaginated {
407
- rows: AiChatMessage[];
408
- pagination: Pagination;
409
- /** @format int64 */
410
- count: number;
411
- }
412
- export interface AiChatMetadata {
413
- intent: "Greeting" | "Invalid" | "Relevant" | "LoanSpecific" | "DocumentList" | "GeneralKnowledge" | "Blocked" | "Action" | "ConversationMeta";
414
- fieldsAccessed: string[];
415
- /** @format int64 */
416
- queryTimeMs: number;
417
- /** @format int64 */
418
- llmTimeMs: number;
419
- wasBlocked: boolean;
420
- blockedReason?: string | null;
421
- }
422
- export interface AiChatRequest {
423
- message: string;
424
- /** @format uuid */
425
- conversationId?: string | null;
426
- /** @format uuid */
427
- loanId?: string | null;
428
- documentIds?: string[] | null;
429
- /** @format uuid */
430
- promptId?: string | null;
431
- }
432
- export interface AiChatStructuredData {
433
- type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
434
- displayHint?: AiDisplayHint | null;
435
- detectedDocumentType?: string | null;
436
- columns: string[];
437
- rows: string[][];
438
- /** @format uuid */
439
- generatedDocumentId?: string | null;
440
- generatedFileName?: string | null;
441
- }
442
- export interface AiConversationDetail {
443
- /** @format uuid */
444
- id: string;
445
- /** @format date-time */
446
- createdAt: string;
447
- /** @format date-time */
448
- updatedAt?: string | null;
449
- /** @format int32 */
450
- messageCount: number;
451
- }
452
- export interface AiConversationListItem {
453
- /** @format uuid */
454
- id: string;
455
- preview: string;
456
- /** @format int32 */
457
- messageCount: number;
458
- /** @format date-time */
459
- createdAt: string;
460
- /** @format date-time */
461
- updatedAt?: string | null;
462
- }
463
- export interface AiConversationListItemPaginated {
464
- rows: AiConversationListItem[];
465
- pagination: Pagination;
466
- /** @format int64 */
467
- count: number;
468
- }
469
- export interface AiGuardrail {
470
- /** @format uuid */
471
- id: string;
472
- name: string;
473
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
474
- description?: string | null;
475
- keywords: string[];
476
- responseTemplate: string;
477
- isDefault: boolean;
478
- isEnabled: boolean;
479
- hasAccountOverride: boolean;
480
- /** @format date-time */
481
- createdAt: string;
482
- /** @format date-time */
483
- updatedAt?: string | null;
484
- }
485
- export interface AiPrompt {
486
- /** @format uuid */
487
- id: string;
488
- title: string;
489
- slug?: string | null;
490
- description: string;
491
- documentTypes: string[];
492
- applicableUrlSourceIds: string[];
493
- allowedRoles: string[];
494
- systemPrompt: string;
495
- /** @format int32 */
496
- sortOrder: number;
497
- isDefault: boolean;
498
- /** @format uuid */
499
- accountId?: string | null;
500
- isActive: boolean;
501
- category?: AiPromptCategory | null;
502
- queryTemplateName?: AiQueryTemplateName | null;
503
- displayHint?: AiDisplayHint | null;
504
- bedrockModelId?: string | null;
505
- requiredDataSources?: string[] | null;
506
- outputType?: AiOutputType | null;
507
- hasAccountOverride: boolean;
508
- /** @format date-time */
509
- createdAt: string;
510
- /** @format date-time */
511
- updatedAt?: string | null;
512
- }
513
- export interface AiPromptSummary {
514
- /** @format uuid */
515
- id: string;
516
- title: string;
517
- slug?: string | null;
518
- description: string;
519
- documentTypes: string[];
520
- applicableUrlSourceIds: string[];
521
- /** @format int32 */
522
- sortOrder: number;
523
- category?: AiPromptCategory | null;
524
- queryTemplateName?: AiQueryTemplateName | null;
525
- displayHint?: AiDisplayHint | null;
526
- bedrockModelId?: string | null;
527
- requiredDataSources?: string[] | null;
528
- outputType?: AiOutputType | null;
529
- }
530
- export interface AiUrlSource {
531
- /** @format uuid */
532
- id: string;
533
- slug?: string | null;
534
- name: string;
535
- url: string;
536
- description?: string | null;
537
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
538
- scope: "FullDomain" | "SpecificPath";
539
- isActive: boolean;
540
- isDefault: boolean;
541
- hasAccountOverride: boolean;
542
- /** @format date-time */
543
- createdAt: string;
544
- /** @format date-time */
545
- updatedAt?: string | null;
546
- }
547
297
  export interface AllowImpersonationRequest {
548
298
  email: string;
549
299
  }
@@ -697,6 +447,19 @@ export interface BorrowerCount {
697
447
  /** @format int32 */
698
448
  count: number;
699
449
  }
450
+ export interface BorrowerIdentity {
451
+ /** @format uuid */
452
+ userId: string;
453
+ firstName: string;
454
+ lastName: string;
455
+ email: string;
456
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
457
+ }
458
+ export interface BorrowersNotUsingPosSummary {
459
+ /** @format int32 */
460
+ total: number;
461
+ borrowers: UnregisteredBorrower[];
462
+ }
700
463
  export interface BranchBase {
701
464
  /** @format date-time */
702
465
  createdAt: string;
@@ -946,45 +709,6 @@ export interface CreateAccountRequest {
946
709
  losIntegration: LOSIntegration;
947
710
  billingSettings: AccountBillingRequest;
948
711
  }
949
- export interface CreateAiCanonicalFieldRequest {
950
- displayName: string;
951
- description: string;
952
- allowedRoles: string[];
953
- isPii: boolean;
954
- dataSource: string;
955
- category?: string | null;
956
- }
957
- export interface CreateAiGuardrailRequest {
958
- name: string;
959
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
960
- description?: string | null;
961
- keywords: string[];
962
- responseTemplate: string;
963
- }
964
- export interface CreateAiPromptRequest {
965
- title: string;
966
- slug?: string | null;
967
- description: string;
968
- documentTypes: string[];
969
- applicableUrlSourceIds: string[];
970
- allowedRoles: string[];
971
- systemPrompt: string;
972
- /** @format int32 */
973
- sortOrder: number;
974
- category?: AiPromptCategory | null;
975
- queryTemplateName?: AiQueryTemplateName | null;
976
- displayHint?: AiDisplayHint | null;
977
- bedrockModelId?: string | null;
978
- requiredDataSources?: string[] | null;
979
- outputType?: AiOutputType | null;
980
- }
981
- export interface CreateAiUrlSourceRequest {
982
- name: string;
983
- url: string;
984
- description?: string | null;
985
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
986
- scope: "FullDomain" | "SpecificPath";
987
- }
988
712
  export interface CreateBranchRequest {
989
713
  name: string;
990
714
  /** @format uuid */
@@ -1098,6 +822,11 @@ export interface CreateUserRequest {
1098
822
  export interface CreateWebhookRequest {
1099
823
  webhookPath: string;
1100
824
  }
825
+ export interface CreditAuthPendingSummary {
826
+ /** @format int32 */
827
+ total: number;
828
+ borrowers: BorrowerIdentity[];
829
+ }
1101
830
  export interface CustomFieldDefinition {
1102
831
  /** @format date-time */
1103
832
  createdAt: string;
@@ -1447,6 +1176,11 @@ export interface DraftRequest {
1447
1176
  customData?: any;
1448
1177
  isCoBorrower: boolean;
1449
1178
  }
1179
+ export interface EconsentPendingSummary {
1180
+ /** @format int32 */
1181
+ total: number;
1182
+ borrowers: BorrowerIdentity[];
1183
+ }
1450
1184
  export interface EnabledServices {
1451
1185
  /** @format date-time */
1452
1186
  createdAt: string;
@@ -1867,13 +1601,6 @@ export interface GenerateDocumentRequest {
1867
1601
  preview: boolean;
1868
1602
  recipients: string[];
1869
1603
  }
1870
- export interface GenerateSystemPrompt {
1871
- systemPrompt: string;
1872
- }
1873
- export interface GenerateSystemPromptRequest {
1874
- description: string;
1875
- category: "DocumentAnalysis" | "DataQuery" | "General" | "Action";
1876
- }
1877
1604
  export interface GetApplications {
1878
1605
  applications: ApplicationRowData[];
1879
1606
  }
@@ -3275,6 +3002,10 @@ export interface LoanOutstandingItems {
3275
3002
  pendingSignaturePackages: number;
3276
3003
  pendingTasks: PendingTasksSummary;
3277
3004
  pendingSignatures: PendingSignaturesSummary;
3005
+ pendingInvites: PendingInvitesSummary;
3006
+ creditAuthPending: CreditAuthPendingSummary;
3007
+ econsentPending: EconsentPendingSummary;
3008
+ borrowersNotUsingPos: BorrowersNotUsingPosSummary;
3278
3009
  }
3279
3010
  export interface LoanPatchRequestGuidPatchDocument {
3280
3011
  operations: GuidPatchOperation[];
@@ -3825,6 +3556,23 @@ export interface PartnerSearchCriteria {
3825
3556
  brands?: string[] | null;
3826
3557
  roles?: UserRole[] | null;
3827
3558
  }
3559
+ export interface PendingInvite {
3560
+ /** @format uuid */
3561
+ inviteId: string;
3562
+ firstName: string;
3563
+ lastName: string;
3564
+ email: string;
3565
+ phoneNumber?: string | null;
3566
+ role?: LoanRole | null;
3567
+ /** @format date-time */
3568
+ createdAt: string;
3569
+ url: string;
3570
+ }
3571
+ export interface PendingInvitesSummary {
3572
+ /** @format int32 */
3573
+ total: number;
3574
+ invites: PendingInvite[];
3575
+ }
3828
3576
  export interface PendingSignaturesSummary {
3829
3577
  /** @format int32 */
3830
3578
  total: number;
@@ -4742,13 +4490,6 @@ export interface SocialSurveyRecord {
4742
4490
  /** @format date-time */
4743
4491
  reviewCompletedTimeStamp?: string | null;
4744
4492
  }
4745
- export interface SupportedModel {
4746
- modelId: string;
4747
- displayName: string;
4748
- provider: string;
4749
- description?: string | null;
4750
- isDefault: boolean;
4751
- }
4752
4493
  export interface SurveyEmailRequest {
4753
4494
  loanOfficerEmailAddress: string;
4754
4495
  }
@@ -4954,6 +4695,15 @@ export interface UnprocessableEntityError {
4954
4695
  error: string;
4955
4696
  property: string;
4956
4697
  }
4698
+ export interface UnregisteredBorrower {
4699
+ /** @format uuid */
4700
+ contactId: string;
4701
+ firstName?: string | null;
4702
+ lastName?: string | null;
4703
+ fullName?: string | null;
4704
+ email?: string | null;
4705
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
4706
+ }
4957
4707
  export interface UpdateAccountRequest {
4958
4708
  name: string;
4959
4709
  mfaPreference: string;
@@ -4963,42 +4713,6 @@ export interface UpdateAccountRequest {
4963
4713
  asoSettings?: ASOSettings | null;
4964
4714
  settings: AccountSettingsRequest;
4965
4715
  }
4966
- export interface UpdateAiCanonicalFieldRequest {
4967
- displayName: string;
4968
- description: string;
4969
- allowedRoles: string[];
4970
- isPii: boolean;
4971
- }
4972
- export interface UpdateAiGuardrailRequest {
4973
- name: string;
4974
- category: "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
4975
- description?: string | null;
4976
- keywords: string[];
4977
- responseTemplate: string;
4978
- }
4979
- export interface UpdateAiPromptRequest {
4980
- title: string;
4981
- description: string;
4982
- documentTypes: string[];
4983
- applicableUrlSourceIds: string[];
4984
- allowedRoles: string[];
4985
- systemPrompt: string;
4986
- /** @format int32 */
4987
- sortOrder: number;
4988
- category?: AiPromptCategory | null;
4989
- queryTemplateName?: AiQueryTemplateName | null;
4990
- displayHint?: AiDisplayHint | null;
4991
- bedrockModelId?: string | null;
4992
- requiredDataSources?: string[] | null;
4993
- outputType?: AiOutputType | null;
4994
- }
4995
- export interface UpdateAiUrlSourceRequest {
4996
- name: string;
4997
- url: string;
4998
- description?: string | null;
4999
- category: "Regulatory" | "Guidelines" | "MarketData" | "Custom";
5000
- scope: "FullDomain" | "SpecificPath";
5001
- }
5002
4716
  export interface UpdateCustomFieldDefinitionRequest {
5003
4717
  isRequired: boolean;
5004
4718
  /** @format int32 */
@@ -5559,7 +5273,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
5559
5273
  }
5560
5274
  /**
5561
5275
  * @title The Big POS API
5562
- * @version v2.43.0
5276
+ * @version v2.43.8
5563
5277
  * @termsOfService https://www.thebigpos.com/terms-of-use/
5564
5278
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
5565
5279
  */
@@ -5720,473 +5434,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5720
5434
  * @response `422` `ProblemDetails` Unprocessable Content
5721
5435
  */
5722
5436
  updateAccountBilling: (id: string, data: AccountBillingRequest, params?: RequestParams) => Promise<AxiosResponse<AccountBilling, any, {}>>;
5723
- /**
5724
- * No description
5725
- *
5726
- * @tags AiAdmin
5727
- * @name GetAiAuditLogs
5728
- * @summary Get paginated audit logs
5729
- * @request GET:/api/ai/admin/audit-logs
5730
- * @secure
5731
- * @response `200` `AiAuditLogPaginated` OK
5732
- */
5733
- getAiAuditLogs: (query?: {
5734
- eventType?: AiAuditEventType;
5735
- /** @format date-time */
5736
- startDate?: string;
5737
- /** @format date-time */
5738
- endDate?: string;
5739
- /** @format int32 */
5740
- pageSize?: number;
5741
- /** @format int32 */
5742
- pageNumber?: number;
5743
- sortBy?: string;
5744
- sortDirection?: string;
5745
- }, params?: RequestParams) => Promise<AxiosResponse<AiAuditLogPaginated, any, {}>>;
5746
- /**
5747
- * No description
5748
- *
5749
- * @tags AiAdmin
5750
- * @name GetAiAdminStats
5751
- * @summary Get AI admin dashboard stats
5752
- * @request GET:/api/ai/admin/stats
5753
- * @secure
5754
- * @response `200` `AiAdminStats` OK
5755
- */
5756
- getAiAdminStats: (query?: {
5757
- /** @format date-time */
5758
- startDate?: string;
5759
- /** @format date-time */
5760
- endDate?: string;
5761
- }, params?: RequestParams) => Promise<AxiosResponse<AiAdminStats, any, {}>>;
5762
- /**
5763
- * No description
5764
- *
5765
- * @tags AiAdminPrompt
5766
- * @name GetAiPrompts
5767
- * @summary Get all prompts
5768
- * @request GET:/api/ai/admin/prompts
5769
- * @secure
5770
- * @response `200` `(AiPrompt)[]` OK
5771
- */
5772
- getAiPrompts: (params?: RequestParams) => Promise<AxiosResponse<AiPrompt[], any, {}>>;
5773
- /**
5774
- * No description
5775
- *
5776
- * @tags AiAdminPrompt
5777
- * @name CreateAiPrompt
5778
- * @summary Create custom prompt
5779
- * @request POST:/api/ai/admin/prompts
5780
- * @secure
5781
- * @response `201` `AiPrompt` Created
5782
- * @response `400` `ProblemDetails` Bad Request
5783
- */
5784
- createAiPrompt: (data: CreateAiPromptRequest, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5785
- /**
5786
- * No description
5787
- *
5788
- * @tags AiAdminPrompt
5789
- * @name GetAiPrompt
5790
- * @summary Get prompt by ID
5791
- * @request GET:/api/ai/admin/prompts/{id}
5792
- * @secure
5793
- * @response `200` `AiPrompt` OK
5794
- * @response `404` `ProblemDetails` Not Found
5795
- */
5796
- getAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5797
- /**
5798
- * No description
5799
- *
5800
- * @tags AiAdminPrompt
5801
- * @name UpdateAiPrompt
5802
- * @summary Update prompt
5803
- * @request PUT:/api/ai/admin/prompts/{id}
5804
- * @secure
5805
- * @response `200` `AiPrompt` OK
5806
- * @response `400` `ProblemDetails` Bad Request
5807
- * @response `404` `ProblemDetails` Not Found
5808
- */
5809
- updateAiPrompt: (id: string, data: UpdateAiPromptRequest, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5810
- /**
5811
- * No description
5812
- *
5813
- * @tags AiAdminPrompt
5814
- * @name DeleteAiPrompt
5815
- * @summary Delete prompt
5816
- * @request DELETE:/api/ai/admin/prompts/{id}
5817
- * @secure
5818
- * @response `204` `void` No Content
5819
- * @response `400` `ProblemDetails` Bad Request
5820
- * @response `404` `ProblemDetails` Not Found
5821
- */
5822
- deleteAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
5823
- /**
5824
- * No description
5825
- *
5826
- * @tags AiAdminPrompt
5827
- * @name ToggleAiPrompt
5828
- * @summary Toggle prompt active/inactive
5829
- * @request PATCH:/api/ai/admin/prompts/{id}/toggle
5830
- * @secure
5831
- * @response `200` `AiPrompt` OK
5832
- * @response `404` `ProblemDetails` Not Found
5833
- */
5834
- toggleAiPrompt: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiPrompt, any, {}>>;
5835
- /**
5836
- * No description
5837
- *
5838
- * @tags AiAdminPrompt
5839
- * @name GenerateAiSystemPrompt
5840
- * @summary Generate a system prompt from description
5841
- * @request POST:/api/ai/admin/prompts/generate
5842
- * @secure
5843
- * @response `200` `GenerateSystemPrompt` OK
5844
- * @response `400` `ProblemDetails` Bad Request
5845
- */
5846
- generateAiSystemPrompt: (data: GenerateSystemPromptRequest, params?: RequestParams) => Promise<AxiosResponse<GenerateSystemPrompt, any, {}>>;
5847
- /**
5848
- * No description
5849
- *
5850
- * @tags AiAdminPrompt
5851
- * @name GetSupportedModels
5852
- * @summary Get supported LLM models
5853
- * @request GET:/api/ai/admin/prompts/supported-models
5854
- * @secure
5855
- * @response `200` `(SupportedModel)[]` OK
5856
- */
5857
- getSupportedModels: (params?: RequestParams) => Promise<AxiosResponse<SupportedModel[], any, {}>>;
5858
- /**
5859
- * No description
5860
- *
5861
- * @tags AiAdminSettings
5862
- * @name GetAiAdminSettings
5863
- * @summary Get global AI settings
5864
- * @request GET:/api/ai/admin/settings
5865
- * @secure
5866
- * @response `200` `AiAdminSettings` OK
5867
- */
5868
- getAiAdminSettings: (params?: RequestParams) => Promise<AxiosResponse<AiAdminSettings, any, {}>>;
5869
- /**
5870
- * No description
5871
- *
5872
- * @tags AiAdminSettings
5873
- * @name UpdateAiAdminSettings
5874
- * @summary Update global AI settings
5875
- * @request PUT:/api/ai/admin/settings
5876
- * @secure
5877
- * @response `200` `AiAdminSettings` OK
5878
- * @response `400` `ProblemDetails` Bad Request
5879
- */
5880
- updateAiAdminSettings: (data: AiAdminSettingsRequest, params?: RequestParams) => Promise<AxiosResponse<AiAdminSettings, any, {}>>;
5881
- /**
5882
- * No description
5883
- *
5884
- * @tags AiCanonicalField
5885
- * @name GetAiCanonicalFields
5886
- * @summary Get all canonical fields
5887
- * @request GET:/api/ai/admin/fields
5888
- * @secure
5889
- * @response `200` `(AiCanonicalField)[]` OK
5890
- */
5891
- getAiCanonicalFields: (params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField[], any, {}>>;
5892
- /**
5893
- * No description
5894
- *
5895
- * @tags AiCanonicalField
5896
- * @name CreateAiCanonicalField
5897
- * @summary Create canonical field
5898
- * @request POST:/api/ai/admin/fields
5899
- * @secure
5900
- * @response `201` `AiCanonicalField` Created
5901
- * @response `400` `ProblemDetails` Bad Request
5902
- */
5903
- createAiCanonicalField: (data: CreateAiCanonicalFieldRequest, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5904
- /**
5905
- * No description
5906
- *
5907
- * @tags AiCanonicalField
5908
- * @name GetAiCanonicalField
5909
- * @summary Get canonical field by ID
5910
- * @request GET:/api/ai/admin/fields/{id}
5911
- * @secure
5912
- * @response `200` `AiCanonicalField` OK
5913
- * @response `404` `ProblemDetails` Not Found
5914
- */
5915
- getAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5916
- /**
5917
- * No description
5918
- *
5919
- * @tags AiCanonicalField
5920
- * @name UpdateAiCanonicalField
5921
- * @summary Update canonical field
5922
- * @request PUT:/api/ai/admin/fields/{id}
5923
- * @secure
5924
- * @response `200` `AiCanonicalField` OK
5925
- * @response `400` `ProblemDetails` Bad Request
5926
- * @response `404` `ProblemDetails` Not Found
5927
- */
5928
- updateAiCanonicalField: (id: string, data: UpdateAiCanonicalFieldRequest, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5929
- /**
5930
- * No description
5931
- *
5932
- * @tags AiCanonicalField
5933
- * @name DeleteAiCanonicalField
5934
- * @summary Delete canonical field
5935
- * @request DELETE:/api/ai/admin/fields/{id}
5936
- * @secure
5937
- * @response `204` `void` No Content
5938
- * @response `404` `ProblemDetails` Not Found
5939
- */
5940
- deleteAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
5941
- /**
5942
- * No description
5943
- *
5944
- * @tags AiCanonicalField
5945
- * @name ToggleAiCanonicalField
5946
- * @summary Toggle canonical field active/inactive
5947
- * @request PATCH:/api/ai/admin/fields/{id}/toggle
5948
- * @secure
5949
- * @response `200` `AiCanonicalField` OK
5950
- * @response `404` `ProblemDetails` Not Found
5951
- */
5952
- toggleAiCanonicalField: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiCanonicalField, any, {}>>;
5953
- /**
5954
- * No description
5955
- *
5956
- * @tags AiChat
5957
- * @name AiChat
5958
- * @summary Send AI chat message
5959
- * @request POST:/api/ai/chat
5960
- * @secure
5961
- * @response `200` `AiChat` OK
5962
- * @response `400` `ProblemDetails` Bad Request
5963
- * @response `401` `ProblemDetails` Unauthorized
5964
- */
5965
- aiChat: (data: AiChatRequest, params?: RequestParams) => Promise<AxiosResponse<AiChat, any, {}>>;
5966
- /**
5967
- * No description
5968
- *
5969
- * @tags AiConversation
5970
- * @name GetAiConversations
5971
- * @summary Get user conversations
5972
- * @request GET:/api/ai/conversations
5973
- * @secure
5974
- * @response `200` `AiConversationListItemPaginated` OK
5975
- */
5976
- getAiConversations: (query?: {
5977
- /** @format int32 */
5978
- pageSize?: number;
5979
- /** @format int32 */
5980
- pageNumber?: number;
5981
- sortBy?: string;
5982
- sortDirection?: string;
5983
- }, params?: RequestParams) => Promise<AxiosResponse<AiConversationListItemPaginated, any, {}>>;
5984
- /**
5985
- * No description
5986
- *
5987
- * @tags AiConversation
5988
- * @name GetAiConversation
5989
- * @summary Get conversation metadata
5990
- * @request GET:/api/ai/conversations/{id}
5991
- * @secure
5992
- * @response `200` `AiConversationDetail` OK
5993
- * @response `403` `ProblemDetails` Forbidden
5994
- * @response `404` `ProblemDetails` Not Found
5995
- */
5996
- getAiConversation: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiConversationDetail, any, {}>>;
5997
- /**
5998
- * No description
5999
- *
6000
- * @tags AiConversation
6001
- * @name DeleteAiConversation
6002
- * @summary Delete conversation
6003
- * @request DELETE:/api/ai/conversations/{id}
6004
- * @secure
6005
- * @response `204` `void` No Content
6006
- * @response `403` `ProblemDetails` Forbidden
6007
- * @response `404` `ProblemDetails` Not Found
6008
- */
6009
- deleteAiConversation: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6010
- /**
6011
- * No description
6012
- *
6013
- * @tags AiConversation
6014
- * @name GetAiConversationMessages
6015
- * @summary Get conversation messages
6016
- * @request GET:/api/ai/conversations/{id}/messages
6017
- * @secure
6018
- * @response `200` `AiChatMessagePaginated` OK
6019
- * @response `403` `ProblemDetails` Forbidden
6020
- * @response `404` `ProblemDetails` Not Found
6021
- */
6022
- getAiConversationMessages: (id: string, query?: {
6023
- /** @format int32 */
6024
- pageSize?: number;
6025
- /** @format int32 */
6026
- pageNumber?: number;
6027
- sortBy?: string;
6028
- sortDirection?: string;
6029
- }, params?: RequestParams) => Promise<AxiosResponse<AiChatMessagePaginated, any, {}>>;
6030
- /**
6031
- * No description
6032
- *
6033
- * @tags AiGuardrail
6034
- * @name GetAiGuardrails
6035
- * @summary Get all guardrails
6036
- * @request GET:/api/ai/admin/guardrails
6037
- * @secure
6038
- * @response `200` `(AiGuardrail)[]` OK
6039
- */
6040
- getAiGuardrails: (params?: RequestParams) => Promise<AxiosResponse<AiGuardrail[], any, {}>>;
6041
- /**
6042
- * No description
6043
- *
6044
- * @tags AiGuardrail
6045
- * @name CreateAiGuardrail
6046
- * @summary Create custom guardrail
6047
- * @request POST:/api/ai/admin/guardrails
6048
- * @secure
6049
- * @response `201` `AiGuardrail` Created
6050
- * @response `400` `ProblemDetails` Bad Request
6051
- */
6052
- createAiGuardrail: (data: CreateAiGuardrailRequest, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6053
- /**
6054
- * No description
6055
- *
6056
- * @tags AiGuardrail
6057
- * @name GetAiGuardrail
6058
- * @summary Get guardrail by ID
6059
- * @request GET:/api/ai/admin/guardrails/{id}
6060
- * @secure
6061
- * @response `200` `AiGuardrail` OK
6062
- * @response `404` `ProblemDetails` Not Found
6063
- */
6064
- getAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6065
- /**
6066
- * No description
6067
- *
6068
- * @tags AiGuardrail
6069
- * @name UpdateAiGuardrail
6070
- * @summary Update guardrail
6071
- * @request PUT:/api/ai/admin/guardrails/{id}
6072
- * @secure
6073
- * @response `200` `AiGuardrail` OK
6074
- * @response `400` `ProblemDetails` Bad Request
6075
- * @response `404` `ProblemDetails` Not Found
6076
- */
6077
- updateAiGuardrail: (id: string, data: UpdateAiGuardrailRequest, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6078
- /**
6079
- * No description
6080
- *
6081
- * @tags AiGuardrail
6082
- * @name DeleteAiGuardrail
6083
- * @summary Delete guardrail
6084
- * @request DELETE:/api/ai/admin/guardrails/{id}
6085
- * @secure
6086
- * @response `204` `void` No Content
6087
- * @response `400` `ProblemDetails` Bad Request
6088
- * @response `404` `ProblemDetails` Not Found
6089
- */
6090
- deleteAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6091
- /**
6092
- * No description
6093
- *
6094
- * @tags AiGuardrail
6095
- * @name ToggleAiGuardrail
6096
- * @summary Toggle guardrail enabled/disabled
6097
- * @request PATCH:/api/ai/admin/guardrails/{id}/toggle
6098
- * @secure
6099
- * @response `200` `AiGuardrail` OK
6100
- * @response `404` `ProblemDetails` Not Found
6101
- */
6102
- toggleAiGuardrail: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiGuardrail, any, {}>>;
6103
- /**
6104
- * No description
6105
- *
6106
- * @tags AiPrompt
6107
- * @name GetAvailablePrompts
6108
- * @summary Get available prompts for current user
6109
- * @request GET:/api/ai/prompts
6110
- * @secure
6111
- * @response `200` `(AiPromptSummary)[]` OK
6112
- */
6113
- getAvailablePrompts: (query?: {
6114
- documentType?: string;
6115
- }, params?: RequestParams) => Promise<AxiosResponse<AiPromptSummary[], any, {}>>;
6116
- /**
6117
- * No description
6118
- *
6119
- * @tags AiUrlSource
6120
- * @name GetAiUrlSources
6121
- * @summary Get all URL sources
6122
- * @request GET:/api/ai/admin/url-sources
6123
- * @secure
6124
- * @response `200` `(AiUrlSource)[]` OK
6125
- */
6126
- getAiUrlSources: (params?: RequestParams) => Promise<AxiosResponse<AiUrlSource[], any, {}>>;
6127
- /**
6128
- * No description
6129
- *
6130
- * @tags AiUrlSource
6131
- * @name CreateAiUrlSource
6132
- * @summary Create URL source
6133
- * @request POST:/api/ai/admin/url-sources
6134
- * @secure
6135
- * @response `201` `AiUrlSource` Created
6136
- * @response `400` `ProblemDetails` Bad Request
6137
- * @response `409` `ProblemDetails` Conflict
6138
- */
6139
- createAiUrlSource: (data: CreateAiUrlSourceRequest, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
6140
- /**
6141
- * No description
6142
- *
6143
- * @tags AiUrlSource
6144
- * @name GetAiUrlSource
6145
- * @summary Get URL source by ID
6146
- * @request GET:/api/ai/admin/url-sources/{id}
6147
- * @secure
6148
- * @response `200` `AiUrlSource` OK
6149
- * @response `404` `ProblemDetails` Not Found
6150
- */
6151
- getAiUrlSource: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
6152
- /**
6153
- * No description
6154
- *
6155
- * @tags AiUrlSource
6156
- * @name UpdateAiUrlSource
6157
- * @summary Update URL source
6158
- * @request PUT:/api/ai/admin/url-sources/{id}
6159
- * @secure
6160
- * @response `200` `AiUrlSource` OK
6161
- * @response `400` `ProblemDetails` Bad Request
6162
- * @response `404` `ProblemDetails` Not Found
6163
- * @response `409` `ProblemDetails` Conflict
6164
- */
6165
- updateAiUrlSource: (id: string, data: UpdateAiUrlSourceRequest, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
6166
- /**
6167
- * No description
6168
- *
6169
- * @tags AiUrlSource
6170
- * @name DeleteAiUrlSource
6171
- * @summary Delete URL source
6172
- * @request DELETE:/api/ai/admin/url-sources/{id}
6173
- * @secure
6174
- * @response `204` `void` No Content
6175
- * @response `404` `ProblemDetails` Not Found
6176
- */
6177
- deleteAiUrlSource: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6178
- /**
6179
- * No description
6180
- *
6181
- * @tags AiUrlSource
6182
- * @name ToggleAiUrlSource
6183
- * @summary Toggle URL source active/inactive
6184
- * @request PATCH:/api/ai/admin/url-sources/{id}/toggle
6185
- * @secure
6186
- * @response `200` `AiUrlSource` OK
6187
- * @response `404` `ProblemDetails` Not Found
6188
- */
6189
- toggleAiUrlSource: (id: string, params?: RequestParams) => Promise<AxiosResponse<AiUrlSource, any, {}>>;
6190
5437
  /**
6191
5438
  * No description
6192
5439
  *