@matech/thebigpos-sdk 2.47.1-rc1 → 2.48.0-rc2

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";
@@ -589,7 +597,8 @@ export type AiAuditEventType =
   | "AgentToolCallRequested"
   | "AgentToolCallCompleted"
   | "AgentToolCallFailed"
-  | "AgentLoopLimitReached";
+  | "AgentLoopLimitReached"
+  | "RequestCancelled";
 
 export type AddressFamily =
   | "Unspecified"
@@ -688,6 +697,13 @@ export interface AccountDeactivated {
   email: string;
 }
 
+export interface AccountFailureCount {
+  /** @format uuid */
+  accountId: string;
+  /** @format int32 */
+  count: number;
+}
+
 export interface AccountReactivationCompleteRequest {
   /** @format uuid */
   token: string;
@@ -993,7 +1009,8 @@ export interface AiAuditLog {
     | "AgentToolCallRequested"
     | "AgentToolCallCompleted"
     | "AgentToolCallFailed"
-    | "AgentLoopLimitReached";
+    | "AgentLoopLimitReached"
+    | "RequestCancelled";
   modelId?: string | null;
   /** @format int32 */
   inputTokens?: number | null;
@@ -1236,6 +1253,8 @@ export interface AiPrompt {
   outputType?: AiOutputType | null;
   scope?: AiPromptScope | null;
   inputHint?: string | null;
+  isFeatured: boolean;
+  icon?: string | null;
   agentSystemPrompt?: string | null;
   tools?: AiPromptTool[] | null;
   hasAccountOverride: boolean;
@@ -1263,6 +1282,8 @@ export interface AiPromptSummary {
   outputType?: AiOutputType | null;
   scope?: AiPromptScope | null;
   inputHint?: string | null;
+  isFeatured: boolean;
+  icon?: string | null;
 }
 
 export interface AiPromptTool {
@@ -1720,6 +1741,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;
@@ -1862,6 +1936,8 @@ export interface CreateAiPromptRequest {
   outputType?: AiOutputType | null;
   scope?: AiPromptScope | null;
   inputHint?: string | null;
+  isFeatured: boolean;
+  icon?: string | null;
 }
 
 export interface CreateAiUrlSourceRequest {
@@ -1879,6 +1955,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 */
@@ -2690,6 +2778,13 @@ export interface Error {
   message: string;
 }
 
+export interface FailureBucket {
+  /** @format date-time */
+  startUtc: string;
+  /** @format int32 */
+  count: number;
+}
+
 export interface File {
   /** @format uuid */
   id: string;
@@ -5026,6 +5121,21 @@ export interface LosSync {
 
 export interface LosSyncFailuresSearchCriteria {
   searchText?: string | null;
+  /** @format date-time */
+  failedFromUtc?: string | null;
+  /** @format date-time */
+  failedToUtc?: string | null;
+}
+
+export interface LosSyncFailuresSummary {
+  /** @format int32 */
+  totalFailures: number;
+  /** @format int32 */
+  accountsAffected: number;
+  topAccounts: AccountFailureCount[];
+  buckets: FailureBucket[];
+  /** @format int32 */
+  previousTotalFailures: number;
 }
 
 export interface LosSyncPaginated {
@@ -6772,6 +6882,8 @@ export interface UpdateAiPromptRequest {
   outputType?: AiOutputType | null;
   scope?: AiPromptScope | null;
   inputHint?: string | null;
+  isFeatured?: boolean | null;
+  icon?: string | null;
 }
 
 export interface UpdateAiPromptToolsRequest {
@@ -6787,6 +6899,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 */
@@ -7563,7 +7687,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v2.47.0
+ * @version v2.48.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -8546,6 +8670,7 @@ export class Api<
      * @response `200` `AiChat` OK
      * @response `400` `ProblemDetails` Bad Request
      * @response `401` `ProblemDetails` Unauthorized
+     * @response `429` `ProblemDetails` Too Many Requests
      */
     aiChat: (data: AiChatRequest, params: RequestParams = {}) =>
       this.request<AiChat, ProblemDetails>({
@@ -9901,6 +10026,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
      *
@@ -14861,6 +15301,37 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags LosSyncFailures
+     * @name GetInboundSyncFailuresSummary
+     * @summary Summarize cross-account failed inbound Encompass syncs (SuperAdmin)
+     * @request POST:/api/monitoring/inbound-sync-failures/summary
+     * @secure
+     * @response `200` `LosSyncFailuresSummary` OK
+     * @response `401` `ProblemDetails` Unauthorized
+     * @response `403` `ProblemDetails` Forbidden
+     */
+    getInboundSyncFailuresSummary: (
+      data: LosSyncFailuresSearchCriteria,
+      query?: {
+        /** @format uuid */
+        accountId?: string;
+      },
+      params: RequestParams = {},
+    ) =>
+      this.request<LosSyncFailuresSummary, ProblemDetails>({
+        path: `/api/monitoring/inbound-sync-failures/summary`,
+        method: "POST",
+        query: query,
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *