@matech/thebigpos-sdk 3.3.0 → 3.3.1-dev-1839

package/src/index.ts

@@ -111,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 =
@@ -530,7 +537,7 @@ export type CompanyDocumentIndexStatus =
 
 export type ClassificationSource = "Textract" | "Llm" | "Manual";
 
-export type BulkLoanTaskOperationType = "SetStatus";
+export type BulkLoanTaskOperationType = "SetStatus" | "Delete";
 
 export type BranchType = "Mortgage" | "RealEstate";
 
@@ -986,6 +993,9 @@ export interface AiAuditLog {
   /** @format uuid */
   messageId?: string | null;
   eventType: AiAuditLogEventTypeEnum;
+  trigger?: string | null;
+  subjectTaskName?: string | null;
+  subjectLoanNumber?: string | null;
   modelId?: string | null;
   /** @format int32 */
   inputTokens?: number | null;
@@ -1668,23 +1678,6 @@ export interface BranchUserPaginated {
   count: number;
 }
 
-export interface BulkCompleteLoanTaskFailure {
-  /** @format uuid */
-  userLoanTaskID: string;
-  taskName: string;
-  errorMessage: string;
-}
-
-export interface BulkCompleteLoanTasks {
-  completed: string[];
-  skipped: string[];
-  failed: BulkCompleteLoanTaskFailure[];
-}
-
-export interface BulkCompleteLoanTasksRequest {
-  userLoanTaskIDs: string[];
-}
-
 export interface BulkLoanTaskFailure {
   /** @format uuid */
   userLoanTaskID: string;
@@ -3400,6 +3393,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;
@@ -3427,6 +3421,7 @@ export interface LoanApplication {
   startDate?: string | null;
   property?: LoanProperty | null;
   financial?: LoanFinancial | null;
+  refinance?: LoanRefinance | null;
   borrowers: LoanBorrower[];
   nonOwningBorrowers: LoanNonOwningBorrower[];
 }
@@ -3444,6 +3439,7 @@ export interface LoanApplicationRequest {
   companyName?: string | null;
   property?: LoanPropertyRequest | null;
   financial?: LoanFinancialRequest | null;
+  refinance?: LoanRefinanceRequest | null;
   financialTerms?: LoanFinancialTermsRequest | null;
   monthlyPayment?: LoanMonthlyPaymentRequest | null;
   borrowers: LoanBorrowerRequest[];
@@ -3511,6 +3507,7 @@ export interface LoanBorrowerAccountAsset {
 
 export interface LoanBorrowerAccountAssetRequest {
   name?: string | null;
+  accountNumber?: string | null;
   financialInstitution?: string | null;
   /** @format double */
   value?: number | null;
@@ -4953,8 +4950,55 @@ 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;
+  searchTerms?: string[] | null;
   /** @format uuid */
   loanOfficerId?: string | null;
   loanNumber?: string | null;
@@ -7564,6 +7608,8 @@ export interface UserTableSettings {
   columnOrder: string[];
   sortColumnId?: string | null;
   sortDirection?: SortDirection | null;
+  searchTerms: string[];
+  pinnedColumnIds: string[];
 }
 
 export interface UserTableSettingsRequest {
@@ -7571,6 +7617,8 @@ export interface UserTableSettingsRequest {
   columnOrder: string[];
   sortColumnId?: string | null;
   sortDirection?: SortDirection | null;
+  searchTerms: string[];
+  pinnedColumnIds: string[];
 }
 
 export interface VerifyEmailRequest {
@@ -8575,7 +8623,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v3.3.0
+ * @version v3.3.1
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -9100,7 +9148,6 @@ export class Api<
         path: `/api/ai/prompts/${id}/toggle`,
         method: "PATCH",
         secure: true,
-        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -9194,7 +9241,7 @@ export class Api<
       }),
 
     /**
-     * No description
+     * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
      *
      * @tags AiAudit
      * @name GetAiAuditLogs
@@ -9225,6 +9272,8 @@ export class Api<
         pageNumber?: number;
         sortBy?: string;
         sortDirection?: string;
+        eventTypes?: AiAuditEventType[];
+        trigger?: string;
       },
       params: RequestParams = {},
     ) =>
@@ -9265,7 +9314,7 @@ export class Api<
       }),
 
     /**
-     * No description
+     * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
      *
      * @tags AiAudit
      * @name GetAiAuditConversations
@@ -9302,7 +9351,7 @@ export class Api<
       }),
 
     /**
-     * No description
+     * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
      *
      * @tags AiAudit
      * @name GetAiStats
@@ -9332,7 +9381,7 @@ export class Api<
       }),
 
     /**
-     * No description
+     * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
      *
      * @tags AiAudit
      * @name GetAiConfigChanges
@@ -9497,7 +9546,6 @@ export class Api<
         path: `/api/ai/canonical-fields/${id}/toggle`,
         method: "PATCH",
         secure: true,
-        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -9649,7 +9697,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: "application/json",
         format: "json",
         ...params,
       }),
@@ -9965,7 +10013,6 @@ export class Api<
         path: `/api/ai/guardrails/${id}/toggle`,
         method: "PATCH",
         secure: true,
-        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -10349,7 +10396,6 @@ export class Api<
         path: `/api/ai/url-sources/${id}/toggle`,
         method: "PATCH",
         secure: true,
-        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -10446,7 +10492,7 @@ export class Api<
       }),
 
     /**
-     * No description
+     * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
      *
      * @tags AuditLog
      * @name SearchAuditLogs
@@ -13841,7 +13887,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: "application/json",
         format: "json",
         ...params,
       }),
@@ -13951,7 +13997,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: "application/json",
         format: "json",
         ...params,
       }),
@@ -13978,7 +14024,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: "application/json",
         format: "json",
         ...params,
       }),
@@ -14176,7 +14222,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: "application/json",
         format: "json",
         ...params,
       }),
@@ -14256,7 +14302,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: "application/json",
         format: "json",
         ...params,
       }),
@@ -14323,9 +14369,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,
@@ -14382,13 +14429,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,
@@ -16190,7 +16238,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.Json,
+        type: "application/json",
         format: "json",
         ...params,
       }),
@@ -16324,36 +16372,6 @@ export class Api<
         ...params,
       }),
 
-    /**
-     * @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 [Deprecated] Bulk complete loan tasks
-     * @request POST:/api/loans/{loanID}/tasks/bulk-complete
-     * @deprecated
-     * @secure
-     * @response `200` `BulkCompleteLoanTasks` OK
-     * @response `404` `ProblemDetails` Not Found
-     * @response `422` `UnprocessableEntity` Unprocessable Content
-     */
-    bulkCompleteLoanTasks: (
-      loanId: string,
-      data: BulkCompleteLoanTasksRequest,
-      params: RequestParams = {},
-    ) =>
-      this.request<BulkCompleteLoanTasks, ProblemDetails | UnprocessableEntity>(
-        {
-          path: `/api/loans/${loanId}/tasks/bulk-complete`,
-          method: "POST",
-          body: data,
-          secure: true,
-          type: "application/json",
-          format: "json",
-          ...params,
-        },
-      ),
-
     /**
      * No description
      *