@matech/thebigpos-sdk 2.34.1 → 2.35.0-rc1

package/src/index.ts

@@ -322,6 +322,8 @@ export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
 
 export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
 
+export type BillingType = "ClosedLoan" | "LoanOfficer";
+
 export type AddressFamily =
   | "Unspecified"
   | "Unix"
@@ -399,13 +401,23 @@ export interface Account {
   losSettings: LOSSettings;
   asoSettings?: ASOSettings | null;
   settings: AccountSettings;
+  billingSettings?: AccountBilling | null;
 }
 
-export interface AccountReportFailure {
-  /** @format uuid */
-  accountID: string;
-  accountName: string;
-  errorMessage: string;
+export interface AccountBilling {
+  billingType: string;
+  /** @format double */
+  contractedRate: number;
+}
+
+export interface AccountBillingRequest {
+  billingType: "ClosedLoan" | "LoanOfficer";
+  /**
+   * @format double
+   * @min 0
+   * @exclusiveMin true
+   */
+  contractedRate: number;
 }
 
 export interface AccountSettings {
@@ -522,6 +534,7 @@ export interface AdminAccessUser {
   /** @format int32 */
   loginsWithoutMFACount: number;
   canImpersonate: boolean;
+  preferredLoanOfficer?: PreferredLoanOfficer | null;
   loanIDs: string[];
   drafts: Draft[];
   notificationSettings?: UserNotificationSettings | null;
@@ -782,6 +795,7 @@ export interface BranchUser {
   /** @format int32 */
   loginsWithoutMFACount: number;
   canImpersonate: boolean;
+  preferredLoanOfficer?: PreferredLoanOfficer | null;
   loanIDs: string[];
   drafts: Draft[];
   notificationSettings?: UserNotificationSettings | null;
@@ -998,6 +1012,7 @@ export interface CreateAccountRequest {
   settings: AccountSettingsRequest;
   environment: "Development" | "Staging" | "UAT" | "Production";
   losIntegration: LOSIntegration;
+  billingSettings: AccountBillingRequest;
 }
 
 export interface CreateBranchRequest {
@@ -1190,6 +1205,7 @@ export interface DetailedUser {
   /** @format int32 */
   loginsWithoutMFACount: number;
   canImpersonate: boolean;
+  preferredLoanOfficer?: PreferredLoanOfficer | null;
   loanIDs: string[];
   drafts: Draft[];
   notificationSettings?: UserNotificationSettings | null;
@@ -1306,9 +1322,18 @@ export interface DocumentFolder {
   files: DocumentFile[];
 }
 
+export interface DocumentFoldersRequest {
+  searchText?: string | null;
+  losStatuses?: LOSStatus[] | null;
+  sortBy?: string | null;
+  sortDirection?: string | null;
+}
+
 export interface DocumentSync {
   /** @format int32 */
   syncedCount: number;
+  /** @format date-time */
+  lastLosDocumentsSyncDate?: string | null;
 }
 
 export interface DocumentTemplate {
@@ -1969,6 +1994,7 @@ export interface ImpersonatedDetailedUser {
   /** @format int32 */
   loginsWithoutMFACount: number;
   canImpersonate: boolean;
+  preferredLoanOfficer?: PreferredLoanOfficer | null;
   loanIDs: string[];
   drafts: Draft[];
   notificationSettings?: UserNotificationSettings | null;
@@ -2180,6 +2206,8 @@ export interface Loan {
   isInSync: boolean;
   /** @format date-time */
   syncDate?: string | null;
+  /** @format date-time */
+  lastLosDocumentsSyncDate?: string | null;
   isLocked: boolean;
   isLockedFromEditing: boolean;
   excludeFromAutoTaskReminders?: boolean | null;
@@ -2230,6 +2258,8 @@ export interface LoanApplicationRequest {
   borrowers: LoanBorrowerRequest[];
   nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
   /** @format uuid */
+  draftId?: string | null;
+  /** @format uuid */
   existingLoanId?: string | null;
 }
 
@@ -4018,6 +4048,15 @@ export interface PostLoanComparisonPdfRequest {
   siteConfigurationID: string;
 }
 
+export interface PreferredLoanOfficer {
+  /** @format uuid */
+  id: string;
+  firstName: string;
+  lastName: string;
+  email: string;
+  phone?: string | null;
+}
+
 export interface PreliminaryCondition {
   /** @format uuid */
   id: string;
@@ -5344,6 +5383,8 @@ export interface UpdateMeRequest {
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
   notificationSettings: UserNotificationSettingsUpdateRequest;
+  /** @format uuid */
+  preferredLoanOfficerId?: string | null;
 }
 
 export interface UpdateMobilePhoneRequest {
@@ -5378,6 +5419,8 @@ export interface UpdateUserRequest {
   branchId?: string | null;
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
+  /** @format uuid */
+  preferredLoanOfficerId?: string | null;
 }
 
 export interface UsageReport {
@@ -5408,15 +5451,142 @@ export interface UsageReport {
   createdAt: string;
 }
 
-export interface UsageReportGenerationResult {
-  fileKey: string;
-  fileUrl: string;
+export interface UsageReportAccountBrief {
+  /** @format uuid */
+  accountId: string;
+  accountName: string;
+  hasDiscrepancy: boolean;
+  errorMessage?: string | null;
+  currentStep?: string | null;
+}
+
+export interface UsageReportAccountExecution {
+  /** @format uuid */
+  accountId: string;
+  accountName: string;
+  status: string;
+  hasDiscrepancy: boolean;
+  excelFileUrl?: string | null;
+  errorMessage?: string | null;
+  /** @format date-time */
+  validationStartedAt?: string | null;
+  /** @format date-time */
+  validationCompletedAt?: string | null;
+  /** @format date-time */
+  processingStartedAt?: string | null;
+  /** @format date-time */
+  processingCompletedAt?: string | null;
+}
+
+export interface UsageReportAccountStatus {
+  status: string;
+  /** @format int32 */
+  count: number;
+  accounts: UsageReportAccountBrief[];
+}
+
+export interface UsageReportActiveExecution {
+  /** @format uuid */
+  correlationId: string;
+  currentState: string;
   /** @format int32 */
-  successCount: number;
+  month: number;
+  /** @format int32 */
+  year: number;
+  /** @format date-time */
+  startedAt?: string | null;
+  elapsedTime: string;
+  progress: UsageReportProgress;
+  accountsByStatus: UsageReportAccountStatus[];
+}
+
+export interface UsageReportDashboard {
+  activeExecution?: UsageReportActiveExecution | null;
+  recentExecutions: UsageReportExecutionSummary[];
+  statistics: UsageReportStatistics;
+}
+
+export interface UsageReportExecution {
+  /** @format uuid */
+  correlationId: string;
+  currentState: string;
+  /** @format int32 */
+  month: number;
+  /** @format int32 */
+  year: number;
+  /** @format int32 */
+  totalAccounts: number;
+  /** @format int32 */
+  validatedAccounts: number;
+  /** @format int32 */
+  processedAccounts: number;
+  /** @format int32 */
+  failedAccounts: number;
+  /** @format date-time */
+  startedAt?: string | null;
+  /** @format date-time */
+  completedAt?: string | null;
+  finalZipUrl?: string | null;
+  errorMessage?: string | null;
+  accounts: UsageReportAccountExecution[];
+}
+
+export interface UsageReportExecutionSummary {
+  /** @format uuid */
+  correlationId: string;
+  currentState: string;
+  /** @format int32 */
+  month: number;
+  /** @format int32 */
+  year: number;
+  period: string;
+  /** @format date-time */
+  startedAt?: string | null;
+  /** @format date-time */
+  completedAt?: string | null;
+  duration?: string | null;
+  /** @format int32 */
+  totalAccounts: number;
   /** @format int32 */
-  failureCount: number;
-  reports: UsageReport[];
-  failures: AccountReportFailure[];
+  processedAccounts: number;
+  /** @format int32 */
+  failedAccounts: number;
+  finalZipUrl?: string | null;
+  errorMessage?: string | null;
+}
+
+export interface UsageReportProgress {
+  /** @format int32 */
+  totalAccounts: number;
+  /** @format int32 */
+  validatedAccounts: number;
+  /** @format int32 */
+  processedAccounts: number;
+  /** @format int32 */
+  failedAccounts: number;
+  /** @format int32 */
+  pendingAccounts: number;
+  /** @format double */
+  validationPercentage: number;
+  /** @format double */
+  processingPercentage: number;
+  /** @format double */
+  overallPercentage: number;
+}
+
+export interface UsageReportStatistics {
+  /** @format int32 */
+  totalExecutionsThisYear: number;
+  /** @format int32 */
+  successfulExecutions: number;
+  /** @format int32 */
+  failedExecutions: number;
+  /** @format int32 */
+  partialExecutions: number;
+  /** @format date-time */
+  lastSuccessfulExecution?: string | null;
+  /** @format date-time */
+  lastFailedExecution?: string | null;
 }
 
 export interface User {
@@ -5440,6 +5610,7 @@ export interface User {
   /** @format int32 */
   loginsWithoutMFACount: number;
   canImpersonate: boolean;
+  preferredLoanOfficer?: PreferredLoanOfficer | null;
 }
 
 export interface UserAccountDeletionRequest {
@@ -5941,7 +6112,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v2.34.0
+ * @version v2.35.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -6163,6 +6334,33 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags Accounts
+     * @name UpdateAccountBilling
+     * @summary Update billing configuration
+     * @request PUT:/api/accounts/{id}/billing
+     * @secure
+     * @response `200` `AccountBilling` Success
+     * @response `404` `ProblemDetails` Not Found
+     * @response `422` `ProblemDetails` Client Error
+     */
+    updateAccountBilling: (
+      id: string,
+      data: AccountBillingRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<AccountBilling, ProblemDetails>({
+        path: `/api/accounts/${id}/billing`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -8170,7 +8368,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatchPatch,
+        type: ContentType.JsonPatch,
         format: "json",
         ...params,
       }),
@@ -8280,7 +8478,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatchPatch,
+        type: ContentType.JsonPatch,
         format: "json",
         ...params,
       }),
@@ -8307,7 +8505,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatchPatch,
+        type: ContentType.JsonPatch,
         format: "json",
         ...params,
       }),
@@ -8549,7 +8747,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatchPatch,
+        type: ContentType.JsonPatch,
         format: "json",
         ...params,
       }),
@@ -8629,7 +8827,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatchPatch,
+        type: ContentType.JsonPatch,
         format: "json",
         ...params,
       }),
@@ -9140,15 +9338,21 @@ export class Api<
      * @tags LoanDocuments
      * @name GetLoanDocumentFolders
      * @summary Get document folder hierarchy
-     * @request GET:/api/loans/{loanId}/documents/folders
+     * @request POST:/api/loans/{loanId}/documents/folders
      * @secure
      * @response `200` `(DocumentFolder)[]` Success
      */
-    getLoanDocumentFolders: (loanId: string, params: RequestParams = {}) =>
+    getLoanDocumentFolders: (
+      loanId: string,
+      data: DocumentFoldersRequest,
+      params: RequestParams = {},
+    ) =>
       this.request<DocumentFolder[], any>({
         path: `/api/loans/${loanId}/documents/folders`,
-        method: "GET",
+        method: "POST",
+        body: data,
         secure: true,
+        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -9289,17 +9493,14 @@ export class Api<
      * @description Fetches all documents from Encompass that don't exist locally and stores them in S3
      *
      * @tags LoanDocuments
-     * @name SyncLoanDocumentsFromEncompass
-     * @summary Sync documents from Encompass
+     * @name SyncLoanDocumentsFromLos
+     * @summary Sync documents from LOS
      * @request POST:/api/loans/{loanId}/documents/sync
      * @secure
      * @response `200` `DocumentSync` Success
      * @response `404` `ProblemDetails` Not Found
      */
-    syncLoanDocumentsFromEncompass: (
-      loanId: string,
-      params: RequestParams = {},
-    ) =>
+    syncLoanDocumentsFromLos: (loanId: string, params: RequestParams = {}) =>
       this.request<DocumentSync, ProblemDetails>({
         path: `/api/loans/${loanId}/documents/sync`,
         method: "POST",
@@ -9309,18 +9510,18 @@ export class Api<
       }),
 
     /**
-     * @description Re-attempts to push a failed document to Encompass
+     * @description Re-attempts to push a failed document to LOS
      *
      * @tags LoanDocuments
-     * @name RetrySyncLoanDocumentToEncompass
-     * @summary Retry syncing a document to Encompass
+     * @name RetrySyncLoanDocumentToLos
+     * @summary Retry syncing a document to LOS
      * @request POST:/api/loans/{loanId}/documents/{documentId}/sync/retry
      * @secure
      * @response `200` `void` Success
      * @response `404` `ProblemDetails` Not Found
      * @response `423` `ProblemDetails` Client Error
      */
-    retrySyncLoanDocumentToEncompass: (
+    retrySyncLoanDocumentToLos: (
       loanId: string,
       documentId: string,
       params: RequestParams = {},
@@ -10004,7 +10205,6 @@ export class Api<
      * @name GetLoans
      * @summary Get Loans
      * @request GET:/api/loans
-     * @deprecated
      * @secure
      * @response `200` `GetApplications` Success
      */
@@ -10173,7 +10373,7 @@ export class Api<
         query: query,
         body: data,
         secure: true,
-        type: ContentType.JsonPatchPatch,
+        type: ContentType.JsonPatch,
         format: "json",
         ...params,
       }),
@@ -11902,26 +12102,17 @@ export class Api<
      * No description
      *
      * @tags UsageReports
-     * @name GenerateUsageReports
-     * @summary Generate usage reports for all active production accounts
-     * @request POST:/api/usage-reports
+     * @name GetUsageReportById
+     * @summary Get usage report by ID
+     * @request GET:/api/usage-reports/{id}
      * @secure
-     * @response `200` `UsageReportGenerationResult` Success
-     * @response `400` `ProblemDetails` Bad Request
+     * @response `200` `UsageReport` Success
+     * @response `404` `ProblemDetails` Not Found
      */
-    generateUsageReports: (
-      query?: {
-        /** @format int32 */
-        month?: number;
-        /** @format int32 */
-        year?: number;
-      },
-      params: RequestParams = {},
-    ) =>
-      this.request<UsageReportGenerationResult, ProblemDetails>({
-        path: `/api/usage-reports`,
-        method: "POST",
-        query: query,
+    getUsageReportById: (id: string, params: RequestParams = {}) =>
+      this.request<UsageReport, ProblemDetails>({
+        path: `/api/usage-reports/${id}`,
+        method: "GET",
         secure: true,
         format: "json",
         ...params,
@@ -11960,14 +12151,14 @@ export class Api<
      * No description
      *
      * @tags UsageReports
-     * @name GenerateAndSendUsageReport
-     * @summary Generate and send monthly usage report email
-     * @request POST:/api/usage-reports/generate-and-send
+     * @name StartUsageReportExecution
+     * @summary Start a new usage report execution (async)
+     * @request POST:/api/usage-reports
      * @secure
-     * @response `204` `void` No Content
-     * @response `500` `void` Server Error
+     * @response `202` `any` Accepted
+     * @response `400` `ProblemDetails` Bad Request
      */
-    generateAndSendUsageReport: (
+    startUsageReportExecution: (
       query?: {
         /** @format int32 */
         month?: number;
@@ -11976,11 +12167,12 @@ export class Api<
       },
       params: RequestParams = {},
     ) =>
-      this.request<void, void>({
-        path: `/api/usage-reports/generate-and-send`,
+      this.request<any, ProblemDetails>({
+        path: `/api/usage-reports`,
         method: "POST",
         query: query,
         secure: true,
+        format: "json",
         ...params,
       }),
 
@@ -11988,17 +12180,68 @@ export class Api<
      * No description
      *
      * @tags UsageReports
-     * @name GetUsageReportById
-     * @summary Get usage report by ID
-     * @request GET:/api/usage-reports/{id}
+     * @name GetUsageReportDashboard
+     * @summary Get usage report execution dashboard with active execution, recent history, and statistics
+     * @request GET:/api/usage-reports/dashboard
      * @secure
-     * @response `200` `UsageReport` Success
+     * @response `200` `UsageReportDashboard` Success
+     */
+    getUsageReportDashboard: (params: RequestParams = {}) =>
+      this.request<UsageReportDashboard, any>({
+        path: `/api/usage-reports/dashboard`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags UsageReports
+     * @name GetUsageReportExecution
+     * @summary Get usage report execution status by correlation ID
+     * @request GET:/api/usage-reports/executions/{correlationId}
+     * @secure
+     * @response `200` `UsageReportExecution` Success
      * @response `404` `ProblemDetails` Not Found
      */
-    getUsageReportById: (id: string, params: RequestParams = {}) =>
-      this.request<UsageReport, ProblemDetails>({
-        path: `/api/usage-reports/${id}`,
+    getUsageReportExecution: (
+      correlationId: string,
+      params: RequestParams = {},
+    ) =>
+      this.request<UsageReportExecution, ProblemDetails>({
+        path: `/api/usage-reports/executions/${correlationId}`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags UsageReports
+     * @name GetUsageReportExecutionsByPeriod
+     * @summary Get usage report executions by month and year
+     * @request GET:/api/usage-reports/executions
+     * @secure
+     * @response `200` `(UsageReportExecution)[]` Success
+     * @response `400` `ProblemDetails` Bad Request
+     */
+    getUsageReportExecutionsByPeriod: (
+      query?: {
+        /** @format int32 */
+        month?: number;
+        /** @format int32 */
+        year?: number;
+      },
+      params: RequestParams = {},
+    ) =>
+      this.request<UsageReportExecution[], ProblemDetails>({
+        path: `/api/usage-reports/executions`,
         method: "GET",
+        query: query,
         secure: true,
         format: "json",
         ...params,