@matech/thebigpos-sdk 3.2.2 → 3.3.0-dev-1625

package/src/index.ts

@@ -30,6 +30,10 @@ export type TaskStatus =
   | "Rejected"
   | "Unknown";
 
+export type TableKey = "Pipeline";
+
+export type SortDirection = "Asc" | "Desc";
+
 export type SiteTileLocation = "HomePage" | "Dashboard";
 
 export type SiteConfigurationType =
@@ -68,7 +72,8 @@ export type LosOperationStatus =
   | "Failed"
   | "ConfigurationError"
   | "PermanentFailure"
-  | "Locked";
+  | "Locked"
+  | "Skipped";
 
 export type LosCredentialHealthStatus =
   | "Unknown"
@@ -106,6 +111,13 @@ export type LoanRole =
   | "SettlementAgent"
   | "Admin";
 
+export type LoanRefinancePurpose =
+  | "CashOutDebtConsolidation"
+  | "CashOutHomeImprovement"
+  | "CashOutOther"
+  | "NoCashOut"
+  | "LimitedCashOut";
+
 export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell" | "PendingSale";
 
 export type LoanRealEstateOccupancyType =
@@ -252,7 +264,8 @@ export type LoanLogType =
   | "TaskReminderSent"
   | "DocumentClassified"
   | "CoBorrowerEmailAutoFixed"
-  | "LosFieldWriteBack";
+  | "LosFieldWriteBack"
+  | "ReferrerChangeDiscarded";
 
 export type LoanLienPosition = "First" | "Subordinate";
 
@@ -524,6 +537,8 @@ export type CompanyDocumentIndexStatus =
 
 export type ClassificationSource = "Textract" | "Llm" | "Manual";
 
+export type BulkLoanTaskOperationType = "SetStatus";
+
 export type BranchType = "Mortgage" | "RealEstate";
 
 export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
@@ -615,7 +630,10 @@ export type AiAuditEventType =
   | "AgentLoopLimitReached"
   | "RequestCancelled"
   | "KnowledgeBaseRetrieved"
-  | "PromptResolutionFailed";
+  | "PromptResolutionFailed"
+  | "PromptTriggerPublished"
+  | "PromptTriggerSkipped"
+  | "PromptRunCompleted";
 
 export type AddressFamily =
   | "Unspecified"
@@ -884,10 +902,12 @@ export interface AffordabilityCalculatorRequest {
 export interface AiAccountSettings {
   bedrockModelId: string;
   isUsingAppDefault: boolean;
+  enabledTriggers: string[];
 }
 
 export interface AiAccountSettingsRequest {
   bedrockModelId?: string | null;
+  enabledTriggers?: string[] | null;
 }
 
 export interface AiAccountUsageOverview {
@@ -1219,6 +1239,7 @@ export interface AiPrompt {
   applicableUrlSourceIds: string[];
   knowledgeBaseFolderIds: string[];
   allowedRoles: string[];
+  supportedTriggers: string[];
   systemPrompt: string;
   /** @format int32 */
   sortOrder: number;
@@ -1241,6 +1262,41 @@ export interface AiPrompt {
   updatedAt?: string | null;
 }
 
+export interface AiPromptRun {
+  /** @format uuid */
+  id: string;
+  trigger: string;
+  /** @format uuid */
+  promptId: string;
+  promptTitle?: string | null;
+  /** @format uuid */
+  subjectEntityId?: string | null;
+  /** @format uuid */
+  loanId?: string | null;
+  documentIds: string[];
+  status: string;
+  errorType?: string | null;
+  errorMessage?: string | null;
+  result?: AiPromptRunResult | null;
+  /** @format date-time */
+  createdAt: string;
+  /** @format date-time */
+  updatedAt?: string | null;
+}
+
+export interface AiPromptRunFinding {
+  severity: string;
+  message: string;
+}
+
+export interface AiPromptRunResult {
+  verdict: string;
+  findings: AiPromptRunFinding[];
+  missingItems: string[];
+  /** @format double */
+  confidence?: number | null;
+}
+
 export interface AiPromptSummary {
   /** @format uuid */
   id: string;
@@ -1636,6 +1692,26 @@ export interface BulkCompleteLoanTasksRequest {
   userLoanTaskIDs: string[];
 }
 
+export interface BulkLoanTaskFailure {
+  /** @format uuid */
+  userLoanTaskID: string;
+  taskName: string;
+  errorMessage: string;
+}
+
+export interface BulkLoanTaskOperation {
+  updated: string[];
+  skipped: string[];
+  failed: BulkLoanTaskFailure[];
+}
+
+export interface BulkLoanTaskOperationRequest {
+  userLoanTaskIDs: string[];
+  operation?: BulkLoanTaskOperationType | null;
+  status?: TaskStatus | null;
+  comment?: string | null;
+}
+
 export interface BusinessRule {
   /** @format date-time */
   createdAt: string;
@@ -1928,6 +2004,7 @@ export interface CreateAiPromptRequest {
   applicableUrlSourceIds: string[];
   knowledgeBaseFolderIds: string[];
   allowedRoles: string[];
+  supportedTriggers?: string[] | null;
   systemPrompt: string;
   /** @format int32 */
   sortOrder: number;
@@ -2727,7 +2804,6 @@ export interface EncompassWebhookSubscription {
   subscriptionId?: string | null;
   endpoint?: string | null;
   hasSigningKey: boolean;
-  isSignatureValidationEnabled: boolean;
   /** @format date-time */
   updatedAt?: string | null;
 }
@@ -3299,6 +3375,7 @@ export interface Loan {
   totalLoanAmount?: number | null;
   fileStarter?: string | null;
   source?: string | null;
+  referrer?: string | null;
   isPOSLoan?: boolean | null;
   /** @format date-time */
   removedFromPosAt?: string | null;
@@ -3330,6 +3407,7 @@ export interface Loan {
   propertyAddress?: Address | null;
   property?: LoanProperty | null;
   financial?: LoanFinancial | null;
+  refinance?: LoanRefinance | null;
   financialTerms?: LoanFinancialTerms | null;
   monthlyPayment?: LoanMonthlyPayment | null;
   costDetails?: LoanCostDetails | null;
@@ -3357,6 +3435,7 @@ export interface LoanApplication {
   startDate?: string | null;
   property?: LoanProperty | null;
   financial?: LoanFinancial | null;
+  refinance?: LoanRefinance | null;
   borrowers: LoanBorrower[];
   nonOwningBorrowers: LoanNonOwningBorrower[];
 }
@@ -3374,6 +3453,7 @@ export interface LoanApplicationRequest {
   companyName?: string | null;
   property?: LoanPropertyRequest | null;
   financial?: LoanFinancialRequest | null;
+  refinance?: LoanRefinanceRequest | null;
   financialTerms?: LoanFinancialTermsRequest | null;
   monthlyPayment?: LoanMonthlyPaymentRequest | null;
   borrowers: LoanBorrowerRequest[];
@@ -3440,6 +3520,7 @@ export interface LoanBorrowerAccountAsset {
 }
 
 export interface LoanBorrowerAccountAssetRequest {
+  name?: string | null;
   financialInstitution?: string | null;
   /** @format double */
   value?: number | null;
@@ -3679,6 +3760,12 @@ export interface LoanBorrowerEmploymentCurrentGrossIncome {
   /** @format double */
   base?: number | null;
   /** @format double */
+  distributions?: number | null;
+  /** @format int32 */
+  hoursPerWeek?: number | null;
+  /** @format double */
+  hourlyRate?: number | null;
+  /** @format double */
   other?: number | null;
   /** @format double */
   bonus?: number | null;
@@ -4876,6 +4963,52 @@ export interface LoanRecord {
   loanFields: Record<string, string>;
 }
 
+export interface LoanRefinance {
+  /** @format uuid */
+  id?: string | null;
+  /** @format int32 */
+  yearAcquired?: number | null;
+  /** @format double */
+  valueOfLot?: number | null;
+  /** @format double */
+  originalCost?: number | null;
+  /** @format double */
+  existingLiens?: number | null;
+  /** @format double */
+  costOfImprovements?: number | null;
+  purpose?: LoanRefinancePurpose | null;
+  currentLoan?: LoanRefinanceCurrentLoan | null;
+}
+
+export interface LoanRefinanceCurrentLoan {
+  /** @format uuid */
+  id?: string | null;
+  lender?: string | null;
+  /** @format double */
+  interestRate?: number | null;
+  /** @format double */
+  monthlyPayment?: number | null;
+  /** @format double */
+  remainingBalance?: number | null;
+  loanType?: LoanType | null;
+}
+
+export interface LoanRefinanceCurrentLoanRequest {
+  lender?: string | null;
+  /** @format double */
+  interestRate?: number | null;
+  loanType?: LoanType | null;
+}
+
+export interface LoanRefinanceRequest {
+  /** @format double */
+  originalCost?: number | null;
+  /** @format double */
+  existingLiens?: number | null;
+  purpose?: LoanRefinancePurpose | null;
+  currentLoan?: LoanRefinanceCurrentLoanRequest | null;
+}
+
 export interface LoanSearchCriteria {
   searchText?: string | null;
   /** @format uuid */
@@ -5862,10 +5995,6 @@ export interface SetSingleCustomFieldValueRequest {
   value?: string | null;
 }
 
-export interface SetWebhookSignatureValidationRequest {
-  enabled: boolean;
-}
-
 export interface SiteConfiguration {
   /** @format date-time */
   createdAt: string;
@@ -6641,6 +6770,8 @@ export interface Task {
   usedInBusinessRule: boolean;
   willAutocompleteAfterResponse: boolean;
   hasAutoPropagationOnAdd: boolean;
+  /** @format uuid */
+  verificationPromptId?: string | null;
 }
 
 export interface TaskComment {
@@ -6687,6 +6818,8 @@ export interface TaskRequest {
   isGlobal: boolean;
   willAutocompleteAfterResponse: boolean;
   hasAutoPropagationOnAdd: boolean;
+  /** @format uuid */
+  verificationPromptId?: string | null;
 }
 
 export interface TaskSearchCriteria {
@@ -6710,6 +6843,8 @@ export interface TaskUpdateRequest {
   willAutocompleteAfterResponse: boolean;
   hasAutoPropagationOnAdd: boolean;
   /** @format uuid */
+  verificationPromptId?: string | null;
+  /** @format uuid */
   id: string;
 }
 
@@ -6874,6 +7009,7 @@ export interface UpdateAiPromptRequest {
   applicableUrlSourceIds: string[];
   knowledgeBaseFolderIds: string[];
   allowedRoles: string[];
+  supportedTriggers?: string[] | null;
   systemPrompt: string;
   /** @format int32 */
   sortOrder: number;
@@ -7478,6 +7614,21 @@ export interface UserSummary {
   lastName: string;
 }
 
+export interface UserTableSettings {
+  tableKey: UserTableSettingsTableKeyEnum;
+  hiddenColumnIds: string[];
+  columnOrder: string[];
+  sortColumnId?: string | null;
+  sortDirection?: SortDirection | null;
+}
+
+export interface UserTableSettingsRequest {
+  hiddenColumnIds: string[];
+  columnOrder: string[];
+  sortColumnId?: string | null;
+  sortDirection?: SortDirection | null;
+}
+
 export interface VerifyEmailRequest {
   token: string;
 }
@@ -7542,7 +7693,10 @@ export type AiAuditLogEventTypeEnum =
   | "AgentLoopLimitReached"
   | "RequestCancelled"
   | "KnowledgeBaseRetrieved"
-  | "PromptResolutionFailed";
+  | "PromptResolutionFailed"
+  | "PromptTriggerPublished"
+  | "PromptTriggerSkipped"
+  | "PromptRunCompleted";
 
 export type AiChatStructuredDataTypeEnum =
   | "Table"
@@ -7954,7 +8108,8 @@ export type LoanLogTypeEnum =
   | "TaskReminderSent"
   | "DocumentClassified"
   | "CoBorrowerEmailAutoFixed"
-  | "LosFieldWriteBack";
+  | "LosFieldWriteBack"
+  | "ReferrerChangeDiscarded";
 
 export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
 
@@ -7977,7 +8132,8 @@ export type LoanLogDetailTypeEnum =
   | "TaskReminderSent"
   | "DocumentClassified"
   | "CoBorrowerEmailAutoFixed"
-  | "LosFieldWriteBack";
+  | "LosFieldWriteBack"
+  | "ReferrerChangeDiscarded";
 
 export type LoanTaskStatusSummaryStatusEnum =
   | "Outstanding"
@@ -8027,7 +8183,8 @@ export type LosOperationTrackingStatusEnum =
   | "Failed"
   | "ConfigurationError"
   | "PermanentFailure"
-  | "Locked";
+  | "Locked"
+  | "Skipped";
 
 export type LosSyncOutboundFailuresSearchCriteriaSeverityEnum =
   | "All"
@@ -8250,19 +8407,9 @@ export type UserLoanConsentLosSyncStatusEnum =
   | "Failed"
   | "Success";
 
-export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
-
-export type SetEncompassIntegrationWebhookSignatureValidationParamsWebhookTypeEnum =
-  | "Legacy"
-  | "LoanV3"
-  | "WebDocuments"
-  | "PosfCreatePackage";
+export type UserTableSettingsTableKeyEnum = "Pipeline";
 
-export type SetEncompassIntegrationWebhookSignatureValidationParamsEnum =
-  | "Legacy"
-  | "LoanV3"
-  | "WebDocuments"
-  | "PosfCreatePackage";
+export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
 
 /** @default "Realtor" */
 export type GetPartnersParamsRoleEnum =
@@ -8300,6 +8447,14 @@ export type GetSiteTilesBySiteConfigurationParamsLocationEnum =
   | "HomePage"
   | "Dashboard";
 
+export type GetMyTableSettingsParamsTableKeyEnum = "Pipeline";
+
+export type GetMyTableSettingsParamsEnum = "Pipeline";
+
+export type UpdateMyTableSettingsParamsTableKeyEnum = "Pipeline";
+
+export type UpdateMyTableSettingsParamsEnum = "Pipeline";
+
 import type {
   AxiosInstance,
   AxiosRequestConfig,
@@ -8476,7 +8631,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v3.2.2
+ * @version v3.3.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -9873,18 +10028,20 @@ export class Api<
      *
      * @tags AiPrompt
      * @name GetAiAvailablePrompts
-     * @summary Get available prompts for current user
+     * @summary Get available prompts for current user, optionally for one trigger surface
      * @request GET:/api/ai/prompts/available
      * @secure
      * @response `200` `(AiPromptSummary)[]` OK
+     * @response `400` `ProblemDetails` Bad Request
      */
     getAiAvailablePrompts: (
       query?: {
         documentType?: string;
+        trigger?: string;
       },
       params: RequestParams = {},
     ) =>
-      this.request<AiPromptSummary[], any>({
+      this.request<AiPromptSummary[], ProblemDetails>({
         path: `/api/ai/prompts/available`,
         method: "GET",
         query: query,
@@ -9893,6 +10050,33 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags AiPromptRun
+     * @name GetAiPromptRuns
+     * @summary Get triggered prompt runs for a subject entity
+     * @request GET:/api/ai/prompt-runs
+     * @secure
+     * @response `200` `(AiPromptRun)[]` OK
+     * @response `400` `ProblemDetails` Bad Request
+     */
+    getAiPromptRuns: (
+      query?: {
+        /** @format uuid */
+        subjectEntityId?: string;
+      },
+      params: RequestParams = {},
+    ) =>
+      this.request<AiPromptRun[], ProblemDetails>({
+        path: `/api/ai/prompt-runs`,
+        method: "GET",
+        query: query,
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -12919,36 +13103,6 @@ export class Api<
         ...params,
       }),
 
-    /**
-     * No description
-     *
-     * @tags EncompassIntegrations
-     * @name SetEncompassIntegrationWebhookSignatureValidation
-     * @summary Turn inbound signature validation on or off for one Encompass webhook subscription (SuperAdmin)
-     * @request PUT:/api/monitoring/encompass-integrations/{accountId}/webhooks/{webhookType}/signature-validation
-     * @secure
-     * @response `200` `EncompassWebhookSubscription` OK
-     * @response `400` `ProblemDetails` Bad Request
-     * @response `401` `ProblemDetails` Unauthorized
-     * @response `403` `ProblemDetails` Forbidden
-     * @response `404` `ProblemDetails` Not Found
-     */
-    setEncompassIntegrationWebhookSignatureValidation: (
-      accountId: string,
-      webhookType: SetEncompassIntegrationWebhookSignatureValidationParamsEnum,
-      data: SetWebhookSignatureValidationRequest,
-      params: RequestParams = {},
-    ) =>
-      this.request<EncompassWebhookSubscription, ProblemDetails>({
-        path: `/api/monitoring/encompass-integrations/${accountId}/webhooks/${webhookType}/signature-validation`,
-        method: "PUT",
-        body: data,
-        secure: true,
-        type: "application/json",
-        format: "json",
-        ...params,
-      }),
-
     /**
      * No description
      *
@@ -14221,9 +14375,10 @@ export class Api<
      * @request POST:/api/listings
      * @secure
      * @response `201` `Listing` Created
+     * @response `403` `ProblemDetails` Forbidden
      */
     createListing: (data: ListingRequest, params: RequestParams = {}) =>
-      this.request<Listing, any>({
+      this.request<Listing, ProblemDetails>({
         path: `/api/listings`,
         method: "POST",
         body: data,
@@ -14280,13 +14435,14 @@ export class Api<
      * @request PUT:/api/listings/{id}
      * @secure
      * @response `200` `Listing` OK
+     * @response `403` `ProblemDetails` Forbidden
      */
     replaceListing: (
       id: string,
       data: ListingRequest,
       params: RequestParams = {},
     ) =>
-      this.request<Listing, any>({
+      this.request<Listing, ProblemDetails>({
         path: `/api/listings/${id}`,
         method: "PUT",
         body: data,
@@ -16076,13 +16232,14 @@ export class Api<
      * @response `403` `ProblemDetails` Forbidden
      * @response `404` `ProblemDetails` Not Found
      * @response `409` `any` Conflict
+     * @response `422` `UnprocessableEntity` Unprocessable Content
      */
     updateLoan: (
       loanId: string,
       data: LoanPatchRequestGuidPatchDocument,
       params: RequestParams = {},
     ) =>
-      this.request<Loan, ProblemDetails>({
+      this.request<Loan, ProblemDetails | UnprocessableEntity>({
         path: `/api/loans/${loanId}`,
         method: "PATCH",
         body: data,
@@ -16222,12 +16379,13 @@ export class Api<
       }),
 
     /**
-     * No description
+     * @description Deprecated - use POST api/loans/tasks/bulk, which reaches every status and accepts tasks from more than one loan.
      *
      * @tags LoanTaskBulkCompletions
      * @name BulkCompleteLoanTasks
-     * @summary Bulk complete loan tasks
+     * @summary [Deprecated] Bulk complete loan tasks
      * @request POST:/api/loans/{loanID}/tasks/bulk-complete
+     * @deprecated
      * @secure
      * @response `200` `BulkCompleteLoanTasks` OK
      * @response `404` `ProblemDetails` Not Found
@@ -16537,6 +16695,31 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * @description Applies one operation to tasks that may span several loans, grouping them by loan server-side and returning flat per-task buckets
+     *
+     * @tags LoanTasks
+     * @name BulkLoanTaskOperation
+     * @summary Bulk task operation
+     * @request POST:/api/loans/tasks/bulk
+     * @secure
+     * @response `200` `BulkLoanTaskOperation` OK
+     * @response `422` `UnprocessableEntity` Unprocessable Content
+     */
+    bulkLoanTaskOperation: (
+      data: BulkLoanTaskOperationRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<BulkLoanTaskOperation, UnprocessableEntity>({
+        path: `/api/loans/tasks/bulk`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -18530,7 +18713,7 @@ export class Api<
      *
      * @tags TheBigPOS
      * @name GetEncompassCredentials
-     * @summary Get Encompass Credentials for the current account
+     * @summary Get Encompass Credentials for the active site's account
      * @request GET:/api/los/encompass/credentials
      * @secure
      * @response `200` `EncompassCredentialsDetail` OK
@@ -18550,7 +18733,7 @@ export class Api<
      *
      * @tags TheBigPOS
      * @name CreateEncompassCredentials
-     * @summary Create Encompass Credentials for the current account
+     * @summary Create Encompass Credentials for the active site's account
      * @request POST:/api/los/encompass/credentials
      * @secure
      * @response `201` `LosCredentials` Created
@@ -18574,7 +18757,7 @@ export class Api<
      *
      * @tags TheBigPOS
      * @name UpdateEncompassCredentials
-     * @summary Update Encompass Credentials for the current account
+     * @summary Update Encompass Credentials for the active site's account
      * @request PUT:/api/los/encompass/credentials
      * @secure
      * @response `200` `EncompassCredentialsDetail` OK
@@ -19986,6 +20169,55 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags UsersMe
+     * @name GetMyTableSettings
+     * @summary Get Table Settings
+     * @request GET:/api/users/me/table-settings/{tableKey}
+     * @secure
+     * @response `200` `UserTableSettings` OK
+     * @response `401` `ProblemDetails` Unauthorized
+     */
+    getMyTableSettings: (
+      tableKey: GetMyTableSettingsParamsEnum,
+      params: RequestParams = {},
+    ) =>
+      this.request<UserTableSettings, ProblemDetails>({
+        path: `/api/users/me/table-settings/${tableKey}`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags UsersMe
+     * @name UpdateMyTableSettings
+     * @summary Update Table Settings
+     * @request PUT:/api/users/me/table-settings/{tableKey}
+     * @secure
+     * @response `200` `UserTableSettings` OK
+     * @response `401` `ProblemDetails` Unauthorized
+     */
+    updateMyTableSettings: (
+      tableKey: UpdateMyTableSettingsParamsEnum,
+      data: UserTableSettingsRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<UserTableSettings, ProblemDetails>({
+        path: `/api/users/me/table-settings/${tableKey}`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
     /**
      * @description Update the phone number If changed will send a verification code to the new number
      *