@matech/thebigpos-sdk 2.38.1 → 2.38.2

package/src/index.ts

@@ -23,6 +23,13 @@ export type UserRole =
   | "LoanOfficerAssistant"
   | "SystemAdmin";
 
+export type TaskStatus =
+  | "Outstanding"
+  | "Pending"
+  | "Completed"
+  | "Rejected"
+  | "Unknown";
+
 export type SiteConfigurationType =
   | "None"
   | "Account"
@@ -31,7 +38,7 @@ export type SiteConfigurationType =
   | "LoanOfficer"
   | "Partner";
 
-export type SigningMethod = "CustomerConnect" | "POSF";
+export type SigningMethod = "ConsumerConnect" | "POSF";
 
 export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
 
@@ -46,6 +53,8 @@ export type LoanTitleHeld =
   | "JointWithSpouse"
   | "JointWithOtherThanSpouse";
 
+export type LoanTaskActivityFilter = "Active" | "Inactive" | "All";
+
 export type LoanRole =
   | "Borrower"
   | "CoBorrower"
@@ -189,7 +198,8 @@ export type LoanLogType =
   | "LoanStatusChanged"
   | "EConsent"
   | "SensitiveDataPurge"
-  | "ClosingDateUpdated";
+  | "ClosingDateUpdated"
+  | "ConsumerConnectAssociation";
 
 export type LoanLienPosition = "First" | "Subordinate";
 
@@ -330,6 +340,14 @@ export type EncompassLogOperationType =
 
 export type DraftType = "NewLoan" | "EditLoan";
 
+export type ConsumerConnectAssociationStatus =
+  | "Legacy"
+  | "Pending"
+  | "Success"
+  | "Failed"
+  | "ConfigurationError"
+  | "PermanentFailure";
+
 export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
 
 export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
@@ -767,6 +785,11 @@ export interface Attachment {
   base64Data: string;
 }
 
+export interface AuditEntityType {
+  entityType: string;
+  rootEntityType?: string | null;
+}
+
 export interface AuditLogEntry {
   /** @format uuid */
   id: string;
@@ -806,9 +829,6 @@ export interface AuditLogSearchCriteria {
   startDate?: string | null;
   /** @format date-time */
   endDate?: string | null;
-  rootEntityType?: string | null;
-  /** @format uuid */
-  rootEntityId?: string | null;
 }
 
 export interface AuditLogUser {
@@ -1013,6 +1033,42 @@ export interface ConditionComment {
   createdByName: string;
 }
 
+export interface ConsumerConnectRetry {
+  /** @format uuid */
+  userLoanId: string;
+  email: string;
+  status?: ConsumerConnectAssociationStatus | null;
+  success: boolean;
+}
+
+export interface ConsumerConnectStatus {
+  /** @format uuid */
+  userLoanId: string;
+  /** @format uuid */
+  userId: string;
+  email: string;
+  role:
+    | "Borrower"
+    | "CoBorrower"
+    | "NonBorrower"
+    | "LoanOfficer"
+    | "LoanProcessor"
+    | "LoanOfficerAssistant"
+    | "SupportingLoanOfficer"
+    | "BuyerAgent"
+    | "SellerAgent"
+    | "TitleInsuranceAgent"
+    | "EscrowAgent"
+    | "SettlementAgent";
+  status?: ConsumerConnectAssociationStatus | null;
+  /** @format int32 */
+  attemptCount: number;
+  /** @format date-time */
+  lastAttemptAt?: string | null;
+  /** @format date-time */
+  nextRetryAt?: string | null;
+}
+
 export interface ContactInfo {
   phone: string;
   tollFreePhone?: string | null;
@@ -1262,6 +1318,10 @@ export interface CreateUserRequest {
   isInternal?: boolean | null;
 }
 
+export interface CreateWebhookRequest {
+  webhookPath: string;
+}
+
 export interface CustomLoanData {
   eConsentInformation?: EConsentInformation | null;
 }
@@ -1629,6 +1689,42 @@ export interface EncompassContact {
   company?: string | null;
 }
 
+export interface EncompassCredentialsDetail {
+  /** @format uuid */
+  id: string;
+  /** @format uuid */
+  accountID: string;
+  instanceID: string;
+  loanAssignmentRole?: string | null;
+  loanTemplate?: string | null;
+  defaultLoanOfficerUserName?: string | null;
+  clearStateIfUnlicensed: boolean;
+  baseUrl?: string | null;
+  signingMethod: "ConsumerConnect" | "POSF";
+  subscriptionId?: string | null;
+  environment?: string | null;
+}
+
+export interface EncompassCredentialsRequest {
+  /** @format uuid */
+  id: string;
+  /** @format uuid */
+  accountID: string;
+  instanceID: string;
+  loanAssignmentRole?: string | null;
+  loanTemplate?: string | null;
+  defaultLoanOfficerUserName?: string | null;
+  clearStateIfUnlicensed: boolean;
+  baseUrl?: string | null;
+  signingMethod: "ConsumerConnect" | "POSF";
+  subscriptionId?: string | null;
+  environment?: string | null;
+  clientID?: string | null;
+  clientSecret?: string | null;
+  signingKeyId?: string | null;
+  signingKey?: string | null;
+}
+
 export interface EncompassError {
   errorCode: string;
   message: string;
@@ -2370,7 +2466,7 @@ export interface Loan {
   nonOwningBorrowers: LoanNonOwningBorrower[];
   userLoans: UserLoan[];
   contacts: LoanContact[];
-  signingMethod: "CustomerConnect" | "POSF";
+  signingMethod: "ConsumerConnect" | "POSF";
 }
 
 export interface LoanApplication {
@@ -3486,6 +3582,7 @@ export interface LoanIdentifier {
   /** @format uuid */
   id: string;
   losLoanID: string;
+  number?: string | null;
 }
 
 export interface LoanImport {
@@ -3589,7 +3686,8 @@ export interface LoanLog {
     | "LoanStatusChanged"
     | "EConsent"
     | "SensitiveDataPurge"
-    | "ClosingDateUpdated";
+    | "ClosingDateUpdated"
+    | "ConsumerConnectAssociation";
   message: string;
   /** @format date-time */
   createdAt: string;
@@ -3613,7 +3711,8 @@ export interface LoanLogDetail {
     | "LoanStatusChanged"
     | "EConsent"
     | "SensitiveDataPurge"
-    | "ClosingDateUpdated";
+    | "ClosingDateUpdated"
+    | "ConsumerConnectAssociation";
   message: string;
   /** @format date-time */
   createdAt: string;
@@ -3889,6 +3988,17 @@ export interface LoanSettings {
   excludeFromAutoTaskReminders: boolean;
 }
 
+export interface LoanTaskSearchRequest {
+  searchText?: string | null;
+  statuses?: TaskStatus[] | null;
+  loanNumber?: string | null;
+  /** @format uuid */
+  borrowerId?: string | null;
+  /** @format uuid */
+  loanId?: string | null;
+  loanStatus?: LoanTaskActivityFilter | null;
+}
+
 export interface LoanUser {
   /** @format uuid */
   id: string;
@@ -3915,6 +4025,14 @@ export interface LoanUser {
   createdAt: string;
 }
 
+export interface LosCredentials {
+  /** @format uuid */
+  id: string;
+  /** @format uuid */
+  accountID: string;
+  instanceID: string;
+}
+
 export interface LosLoanCreationRequest {
   loanOfficerUserName?: string | null;
   loanTemplate?: string | null;
@@ -3927,6 +4045,15 @@ export interface LosLoanCreationRequest {
   existingLoanID?: string | null;
 }
 
+export interface LosWebhook {
+  /** @format uuid */
+  id: string;
+  endpoint: string;
+  resource: string;
+  events: string[];
+  enableSubscription: boolean;
+}
+
 export interface MdmUser {
   user_email?: string | null;
   user_id?: string | null;
@@ -5961,7 +6088,6 @@ export interface UserLoanTask {
   value?: string | null;
   documents: LoanDocument[];
   loan: LoanIdentifier;
-  /** @deprecated */
   loanID: string;
   /** @format date-time */
   completedDate?: string | null;
@@ -5974,6 +6100,13 @@ export interface UserLoanTask {
   commentsCount: number;
 }
 
+export interface UserLoanTaskPaginated {
+  rows: UserLoanTask[];
+  pagination: Pagination;
+  /** @format int64 */
+  count: number;
+}
+
 export interface UserLoanTaskRequest {
   value?: string | null;
   /**
@@ -6313,7 +6446,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v2.38.0
+ * @version v2.38.1
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -6595,6 +6728,25 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags AuditLog
+     * @name GetAuditLogEntityTypes
+     * @summary Get entity types
+     * @request GET:/api/audit-logs/entity-types
+     * @secure
+     * @response `200` `(AuditEntityType)[]` Success
+     */
+    getAuditLogEntityTypes: (params: RequestParams = {}) =>
+      this.request<AuditEntityType[], any>({
+        path: `/api/audit-logs/entity-types`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -7175,6 +7327,47 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags ConsumerConnect
+     * @name GetConsumerConnectStatus
+     * @summary Get Consumer Connect association status for all borrowers on a loan
+     * @request GET:/api/loans/{loanId}/consumer-connect/status
+     * @secure
+     * @response `200` `(ConsumerConnectStatus)[]` Success
+     */
+    getConsumerConnectStatus: (loanId: string, params: RequestParams = {}) =>
+      this.request<ConsumerConnectStatus[], any>({
+        path: `/api/loans/${loanId}/consumer-connect/status`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags ConsumerConnect
+     * @name RetryConsumerConnectAssociation
+     * @summary Manually retry Consumer Connect association for failed borrowers on a loan. Returns per-borrower results; check individual Success fields for partial failures.
+     * @request POST:/api/loans/{loanId}/consumer-connect/retry
+     * @secure
+     * @response `200` `(ConsumerConnectRetry)[]` Success
+     */
+    retryConsumerConnectAssociation: (
+      loanId: string,
+      params: RequestParams = {},
+    ) =>
+      this.request<ConsumerConnectRetry[], any>({
+        path: `/api/loans/${loanId}/consumer-connect/retry`,
+        method: "POST",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -10886,9 +11079,42 @@ export class Api<
       }),
 
     /**
-     * No description
+     * @description Search tasks across all loans
      *
      * @tags LoanTasks
+     * @name SearchLoanTasks
+     * @summary Search
+     * @request POST:/api/loans/tasks/search
+     * @secure
+     * @response `200` `UserLoanTaskPaginated` Success
+     */
+    searchLoanTasks: (
+      data: LoanTaskSearchRequest,
+      query?: {
+        /** @format int32 */
+        pageSize?: number;
+        /** @format int32 */
+        pageNumber?: number;
+        sortBy?: string;
+        sortDirection?: string;
+      },
+      params: RequestParams = {},
+    ) =>
+      this.request<UserLoanTaskPaginated, any>({
+        path: `/api/loans/tasks/search`,
+        method: "POST",
+        query: query,
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags LoanTasksForSingleLoan
      * @name GetLoanTasks
      * @summary Get All
      * @request GET:/api/loans/{loanID}/tasks
@@ -10908,7 +11134,7 @@ export class Api<
     /**
      * No description
      *
-     * @tags LoanTasks
+     * @tags LoanTasksForSingleLoan
      * @name GetLoanTask
      * @summary Get by ID
      * @request GET:/api/loans/{loanID}/tasks/{id}
@@ -10928,7 +11154,7 @@ export class Api<
     /**
      * @description Get the difference between the current loan tasks and the tasks generated by business rules
      *
-     * @tags LoanTasks
+     * @tags LoanTasksForSingleLoan
      * @name GetLoanTaskDifference
      * @summary Get Difference
      * @request GET:/api/loans/{loanID}/tasks/diff
@@ -10948,7 +11174,7 @@ export class Api<
     /**
      * No description
      *
-     * @tags LoanTasks
+     * @tags LoanTasksForSingleLoan
      * @name CreateLoanTask
      * @summary Create
      * @request POST:/api/loans/{loanID}/tasks/{taskID}
@@ -10975,7 +11201,7 @@ export class Api<
     /**
      * No description
      *
-     * @tags LoanTasks
+     * @tags LoanTasksForSingleLoan
      * @name ImportLoanTask
      * @summary Import
      * @request POST:/api/loans/{loanID}/tasks/import
@@ -11001,7 +11227,7 @@ export class Api<
     /**
      * No description
      *
-     * @tags LoanTasks
+     * @tags LoanTasksForSingleLoan
      * @name ReplaceLoanTask
      * @summary Replace
      * @request PUT:/api/loans/{loanID}/tasks/{userLoanTaskID}
@@ -11028,7 +11254,7 @@ export class Api<
     /**
      * No description
      *
-     * @tags LoanTasks
+     * @tags LoanTasksForSingleLoan
      * @name DeleteLoanTask
      * @summary Delete
      * @request DELETE:/api/loans/{loanID}/tasks/{userLoanTaskID}
@@ -12487,6 +12713,129 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags TheBigPOS
+     * @name GetEncompassCredentials
+     * @request GET:/api/los/encompass/credentials
+     * @secure
+     * @response `200` `EncompassCredentialsDetail` Success
+     * @response `204` `void` No Content
+     */
+    getEncompassCredentials: (params: RequestParams = {}) =>
+      this.request<EncompassCredentialsDetail, any>({
+        path: `/api/los/encompass/credentials`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags TheBigPOS
+     * @name CreateEncompassCredentials
+     * @request POST:/api/los/encompass/credentials
+     * @secure
+     * @response `201` `LosCredentials` Created
+     */
+    createEncompassCredentials: (
+      data: EncompassCredentialsRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<LosCredentials, any>({
+        path: `/api/los/encompass/credentials`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags TheBigPOS
+     * @name UpdateEncompassCredentials
+     * @request PUT:/api/los/encompass/credentials
+     * @secure
+     * @response `200` `EncompassCredentialsDetail` Success
+     */
+    updateEncompassCredentials: (
+      data: EncompassCredentialsRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<EncompassCredentialsDetail, any>({
+        path: `/api/los/encompass/credentials`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags TheBigPOS
+     * @name GetEncompassWebhooks
+     * @request GET:/api/los/encompass/webhooks
+     * @secure
+     * @response `200` `(LosWebhook)[]` Success
+     */
+    getEncompassWebhooks: (params: RequestParams = {}) =>
+      this.request<LosWebhook[], any>({
+        path: `/api/los/encompass/webhooks`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags TheBigPOS
+     * @name CreateEncompassWebhook
+     * @request POST:/api/los/encompass/webhooks
+     * @secure
+     * @response `201` `LosWebhook` Created
+     */
+    createEncompassWebhook: (
+      data: CreateWebhookRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<LosWebhook, any>({
+        path: `/api/los/encompass/webhooks`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags TheBigPOS
+     * @name DeleteEncompassWebhook
+     * @request DELETE:/api/los/encompass/webhooks/{webhookId}
+     * @secure
+     * @response `204` `void` No Content
+     */
+    deleteEncompassWebhook: (webhookId: string, params: RequestParams = {}) =>
+      this.request<void, any>({
+        path: `/api/los/encompass/webhooks/${webhookId}`,
+        method: "DELETE",
+        secure: true,
+        ...params,
+      }),
+
     /**
      * No description
      *