@matech/thebigpos-sdk 2.48.0-rc1 → 2.48.0-rc3

package/src/index.ts

@@ -450,6 +450,14 @@ export type ConsentSource = "TheBigPOS" | "ConsumerConnect";
 
 export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
 
+export type CompanyDocumentSourceType = "File" | "FreeText";
+
+export type CompanyDocumentIndexStatus =
+  | "Uploaded"
+  | "Indexing"
+  | "Indexed"
+  | "Failed";
+
 export type ClassificationSource = "Textract" | "Llm" | "Manual";
 
 export type BranchType = "Mortgage" | "RealEstate";
@@ -483,7 +491,8 @@ export type AiStructuredDataType =
   | "Table"
   | "DocumentAnalysis"
   | "DocumentList"
-  | "GeneratedDocument";
+  | "GeneratedDocument"
+  | "CitedPassages";
 
 export type AiQueryTemplateName =
   | "PipelineSummary"
@@ -590,7 +599,8 @@ export type AiAuditEventType =
   | "AgentToolCallCompleted"
   | "AgentToolCallFailed"
   | "AgentLoopLimitReached"
-  | "RequestCancelled";
+  | "RequestCancelled"
+  | "KnowledgeBaseRetrieved";
 
 export type AddressFamily =
   | "Unspecified"
@@ -1002,7 +1012,8 @@ export interface AiAuditLog {
     | "AgentToolCallCompleted"
     | "AgentToolCallFailed"
     | "AgentLoopLimitReached"
-    | "RequestCancelled";
+    | "RequestCancelled"
+    | "KnowledgeBaseRetrieved";
   modelId?: string | null;
   /** @format int32 */
   inputTokens?: number | null;
@@ -1123,7 +1134,12 @@ export interface AiChatRequest {
 }
 
 export interface AiChatStructuredData {
-  type: "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument";
+  type:
+    | "Table"
+    | "DocumentAnalysis"
+    | "DocumentList"
+    | "GeneratedDocument"
+    | "CitedPassages";
   displayHint?: AiDisplayHint | null;
   detectedDocumentType?: string | null;
   columns: string[];
@@ -1131,6 +1147,15 @@ export interface AiChatStructuredData {
   /** @format uuid */
   generatedDocumentId?: string | null;
   generatedFileName?: string | null;
+  passages?: AiCitedPassage[] | null;
+}
+
+export interface AiCitedPassage {
+  folderName: string;
+  documentName: string;
+  excerpt: string;
+  /** @format double */
+  score?: number | null;
 }
 
 export interface AiConversationAuditSummary {
@@ -1229,6 +1254,7 @@ export interface AiPrompt {
   description: string;
   documentTypes: string[];
   applicableUrlSourceIds: string[];
+  knowledgeBaseFolderIds: string[];
   allowedRoles: string[];
   systemPrompt: string;
   /** @format int32 */
@@ -1733,6 +1759,59 @@ export interface CompanyAddress {
   zip: string;
 }
 
+export interface CompanyDocument {
+  /** @format uuid */
+  id: string;
+  /** @format uuid */
+  folderId: string;
+  folderName: string;
+  name: string;
+  sourceType: "File" | "FreeText";
+  contentType?: string | null;
+  /** @format int64 */
+  fileSizeBytes: number;
+  inlineContent?: string | null;
+  indexStatus: "Uploaded" | "Indexing" | "Indexed" | "Failed";
+  indexError?: string | null;
+  /** @format date-time */
+  indexedAt?: string | null;
+  /** @format uuid */
+  uploadedByUserId?: string | null;
+  /** @format date-time */
+  createdAt: string;
+  /** @format date-time */
+  updatedAt?: string | null;
+}
+
+export interface CompanyDocumentFolder {
+  /** @format uuid */
+  id: string;
+  name: string;
+  description?: string | null;
+  isSystemDefault: boolean;
+  /** @format int32 */
+  documentCount: number;
+  /** @format date-time */
+  createdAt: string;
+  /** @format date-time */
+  updatedAt?: string | null;
+}
+
+export interface CompanyDocumentPaginated {
+  rows: CompanyDocument[];
+  pagination: Pagination;
+  /** @format int64 */
+  count: number;
+}
+
+export interface CompanyDocumentSearchCriteria {
+  searchText?: string | null;
+  /** @format uuid */
+  folderID?: string | null;
+  indexStatuses?: CompanyDocumentIndexStatus[] | null;
+  sourceType?: CompanyDocumentSourceType | null;
+}
+
 export interface ConditionComment {
   commentId: string;
   comments: string;
@@ -1863,6 +1942,7 @@ export interface CreateAiPromptRequest {
   description: string;
   documentTypes: string[];
   applicableUrlSourceIds: string[];
+  knowledgeBaseFolderIds: string[];
   allowedRoles: string[];
   systemPrompt: string;
   /** @format int32 */
@@ -1894,6 +1974,18 @@ export interface CreateBranchRequest {
   type: string;
 }
 
+export interface CreateCompanyDocumentFolderRequest {
+  name: string;
+  description?: string | null;
+}
+
+export interface CreateCompanyTextDocumentRequest {
+  name: string;
+  /** @format uuid */
+  folderID: string;
+  content: string;
+}
+
 export interface CreateCustomFieldDefinitionRequest {
   isRequired: boolean;
   /** @format int32 */
@@ -6797,6 +6889,7 @@ export interface UpdateAiPromptRequest {
   description: string;
   documentTypes: string[];
   applicableUrlSourceIds: string[];
+  knowledgeBaseFolderIds: string[];
   allowedRoles: string[];
   systemPrompt: string;
   /** @format int32 */
@@ -6826,6 +6919,18 @@ export interface UpdateAiUrlSourceRequest {
   scope: "FullDomain" | "SpecificPath";
 }
 
+export interface UpdateCompanyDocumentFolderRequest {
+  name: string;
+  description?: string | null;
+}
+
+export interface UpdateCompanyDocumentRequest {
+  name?: string | null;
+  /** @format uuid */
+  folderID?: string | null;
+  content?: string | null;
+}
+
 export interface UpdateCustomFieldDefinitionRequest {
   isRequired: boolean;
   /** @format int32 */
@@ -9941,6 +10046,321 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags CompanyDocumentFolders
+     * @name GetCompanyDocumentFolders
+     * @summary Get all company document folders
+     * @request GET:/api/company-document-folders
+     * @secure
+     * @response `200` `(CompanyDocumentFolder)[]` OK
+     */
+    getCompanyDocumentFolders: (params: RequestParams = {}) =>
+      this.request<CompanyDocumentFolder[], any>({
+        path: `/api/company-document-folders`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags CompanyDocumentFolders
+     * @name CreateCompanyDocumentFolder
+     * @summary Create company document folder
+     * @request POST:/api/company-document-folders
+     * @secure
+     * @response `201` `CompanyDocumentFolder` Created
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `409` `ProblemDetails` Conflict
+     */
+    createCompanyDocumentFolder: (
+      data: CreateCompanyDocumentFolderRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<CompanyDocumentFolder, ProblemDetails>({
+        path: `/api/company-document-folders`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags CompanyDocumentFolders
+     * @name GetCompanyDocumentFolder
+     * @summary Get company document folder by ID
+     * @request GET:/api/company-document-folders/{id}
+     * @secure
+     * @response `200` `CompanyDocumentFolder` OK
+     * @response `404` `ProblemDetails` Not Found
+     */
+    getCompanyDocumentFolder: (id: string, params: RequestParams = {}) =>
+      this.request<CompanyDocumentFolder, ProblemDetails>({
+        path: `/api/company-document-folders/${id}`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags CompanyDocumentFolders
+     * @name UpdateCompanyDocumentFolder
+     * @summary Update company document folder
+     * @request PUT:/api/company-document-folders/{id}
+     * @secure
+     * @response `200` `CompanyDocumentFolder` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     */
+    updateCompanyDocumentFolder: (
+      id: string,
+      data: UpdateCompanyDocumentFolderRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<CompanyDocumentFolder, ProblemDetails>({
+        path: `/api/company-document-folders/${id}`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags CompanyDocumentFolders
+     * @name DeleteCompanyDocumentFolder
+     * @summary Delete company document folder
+     * @request DELETE:/api/company-document-folders/{id}
+     * @secure
+     * @response `204` `void` No Content
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     */
+    deleteCompanyDocumentFolder: (id: string, params: RequestParams = {}) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/company-document-folders/${id}`,
+        method: "DELETE",
+        secure: true,
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags CompanyDocuments
+     * @name SearchCompanyDocuments
+     * @summary Search company documents
+     * @request POST:/api/company-documents/search
+     * @secure
+     * @response `200` `CompanyDocumentPaginated` OK
+     * @response `400` `ProblemDetails` Bad Request
+     */
+    searchCompanyDocuments: (
+      data: CompanyDocumentSearchCriteria,
+      query?: {
+        /** @format int32 */
+        pageSize?: number;
+        /** @format int32 */
+        pageNumber?: number;
+        sortBy?: string;
+        sortDirection?: string;
+      },
+      params: RequestParams = {},
+    ) =>
+      this.request<CompanyDocumentPaginated, ProblemDetails>({
+        path: `/api/company-documents/search`,
+        method: "POST",
+        query: query,
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags CompanyDocuments
+     * @name GetCompanyDocument
+     * @summary Get company document by ID
+     * @request GET:/api/company-documents/{id}
+     * @secure
+     * @response `200` `CompanyDocument` OK
+     * @response `404` `ProblemDetails` Not Found
+     */
+    getCompanyDocument: (id: string, params: RequestParams = {}) =>
+      this.request<CompanyDocument, ProblemDetails>({
+        path: `/api/company-documents/${id}`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags CompanyDocuments
+     * @name UpdateCompanyDocument
+     * @summary Update company document
+     * @request PUT:/api/company-documents/{id}
+     * @secure
+     * @response `200` `CompanyDocument` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     */
+    updateCompanyDocument: (
+      id: string,
+      data: UpdateCompanyDocumentRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<CompanyDocument, ProblemDetails>({
+        path: `/api/company-documents/${id}`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags CompanyDocuments
+     * @name DeleteCompanyDocument
+     * @summary Delete company document
+     * @request DELETE:/api/company-documents/{id}
+     * @secure
+     * @response `204` `void` No Content
+     * @response `404` `ProblemDetails` Not Found
+     */
+    deleteCompanyDocument: (id: string, params: RequestParams = {}) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/company-documents/${id}`,
+        method: "DELETE",
+        secure: true,
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags CompanyDocuments
+     * @name DownloadCompanyDocument
+     * @summary Download company document
+     * @request GET:/api/company-documents/{id}/download
+     * @secure
+     * @response `200` `void` OK
+     * @response `404` `ProblemDetails` Not Found
+     */
+    downloadCompanyDocument: (id: string, params: RequestParams = {}) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/company-documents/${id}/download`,
+        method: "GET",
+        secure: true,
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags CompanyDocuments
+     * @name CreateCompanyDocument
+     * @summary Upload company document
+     * @request POST:/api/company-documents
+     * @secure
+     * @response `201` `CompanyDocument` Created
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     */
+    createCompanyDocument: (
+      data: {
+        /** @format binary */
+        file?: File;
+        /** @format uuid */
+        folderID?: string;
+        name?: string;
+      },
+      params: RequestParams = {},
+    ) =>
+      this.request<CompanyDocument, ProblemDetails>({
+        path: `/api/company-documents`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: ContentType.FormData,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags CompanyDocuments
+     * @name CreateCompanyTextDocument
+     * @summary Create free-form text company document
+     * @request POST:/api/company-documents/text
+     * @secure
+     * @response `201` `CompanyDocument` Created
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     */
+    createCompanyTextDocument: (
+      data: CreateCompanyTextDocumentRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<CompanyDocument, ProblemDetails>({
+        path: `/api/company-documents/text`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags CompanyDocuments
+     * @name ReindexCompanyDocument
+     * @summary Re-index a failed company document
+     * @request POST:/api/company-documents/{id}/reindex
+     * @secure
+     * @response `200` `CompanyDocument` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `404` `ProblemDetails` Not Found
+     */
+    reindexCompanyDocument: (id: string, params: RequestParams = {}) =>
+      this.request<CompanyDocument, ProblemDetails>({
+        path: `/api/company-documents/${id}/reindex`,
+        method: "POST",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *