@matech/thebigpos-sdk 2.14.0-rc.4 → 2.14.0-rc.7

package/src/index.ts

@@ -50,6 +50,17 @@ export interface Account {
   allowedLoginsWithoutMFA: number;
   losSettings: LOSSettings;
   asoSettings?: ASOSettings | null;
+  settings: AccountSettings;
+}
+
+export interface AccountSettings {
+  isSmsEnabled: boolean;
+  smsNumber?: string | null;
+}
+
+export interface AccountSettingsRequest {
+  isSmsEnabled: boolean;
+  smsNumber?: string | null;
 }
 
 export interface Action {
@@ -254,6 +265,19 @@ export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
 
 export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
 
+export interface BranchBase {
+  /** @format date-time */
+  createdAt: string;
+  /** @format date-time */
+  updatedAt?: string | null;
+  /** @format date-time */
+  deletedAt?: string | null;
+  /** @format uuid */
+  id: string;
+  name: string;
+  type: string;
+}
+
 export interface BranchReduced {
   /** @format uuid */
   id: string;
@@ -434,6 +458,18 @@ export interface Corporate {
   siteConfigurations: SiteConfigurationReduced[];
 }
 
+export interface CorporateBase {
+  /** @format date-time */
+  createdAt: string;
+  /** @format date-time */
+  updatedAt?: string | null;
+  /** @format date-time */
+  deletedAt?: string | null;
+  /** @format uuid */
+  id: string;
+  name: string;
+}
+
 export interface CorporatePaginated {
   rows: Corporate[];
   pagination: Pagination;
@@ -470,6 +506,7 @@ export interface CreateAccountRequest {
    * @min 0
    */
   nlmsid: number;
+  settings: AccountSettingsRequest;
 }
 
 export interface CreateBranchRequest {
@@ -808,11 +845,14 @@ export interface DraftContentPaginated {
   count: number;
 }
 
+export interface DraftLoanOfficerReassignRequest {
+  /** @format uuid */
+  loanOfficerID: string;
+}
+
 export interface DraftRequest {
   applicationPayload: any;
   customData?: any;
-  /** @format uuid */
-  loanOfficerID?: string | null;
 }
 
 export interface EConsentInformation {
@@ -842,7 +882,6 @@ export interface EnabledServices {
   borrowerTasks?: boolean | null;
   docusign?: boolean | null;
   emailNotifications?: boolean | null;
-  textNotifications?: boolean | null;
   voc?: boolean | null;
   spanishPrequal?: boolean | null;
   spanishFullApp?: boolean | null;
@@ -876,6 +915,8 @@ export interface Error {
 }
 
 export interface ExtendedLoan {
+  /** @format uuid */
+  id: string;
   loanID: string;
   loanNumber?: string | null;
   /** @format date-time */
@@ -1435,6 +1476,8 @@ export interface ListingSearchCriteria {
 }
 
 export interface Loan {
+  /** @format uuid */
+  id: string;
   loanID: string;
   loanNumber?: string | null;
   /** @format date-time */
@@ -1599,11 +1642,12 @@ export interface LoanQueue {
   deletedAt?: string | null;
   /** @format uuid */
   id: string;
-  loanID?: string | null;
+  loan?: Loan | null;
   type: string;
   reason: string;
   status: string;
   details?: string | null;
+  jobID?: string | null;
   user: UserPublic;
   loanOfficer: LoanOfficerPublic;
   siteConfiguration: SiteConfigurationReduced;
@@ -1637,15 +1681,16 @@ export interface LoanQueueWithData {
   deletedAt?: string | null;
   /** @format uuid */
   id: string;
-  loanID?: string | null;
+  loan?: Loan | null;
   type: string;
   reason: string;
   status: string;
   details?: string | null;
+  jobID?: string | null;
   user: UserPublic;
   loanOfficer: LoanOfficerPublic;
   siteConfiguration: SiteConfigurationReduced;
-  data: any;
+  data?: any;
 }
 
 export interface LoanRecord {
@@ -2060,6 +2105,7 @@ export interface RunLOCalculation {
   canGeneratePreQual: boolean;
   canGeneratePreApproval: boolean;
   preApprovalNotes?: string | null;
+  additionalPreApprovalNotes?: string | null;
   downPaymentAmount?: string | null;
   downPaymentPercent?: string | null;
   lienType?: string | null;
@@ -2096,6 +2142,7 @@ export interface RunLOCalculationRequest {
   /** @minLength 1 */
   lienType: string;
   preApprovalNotes?: string | null;
+  additionalPreApprovalNotes?: string | null;
 }
 
 export interface SSOToken {
@@ -2328,6 +2375,7 @@ export interface SiteConfiguration {
   modules: Module[];
   user?: UserPublic | null;
   asoSettings?: ASOSettings | null;
+  accountSettings: AccountSettings;
 }
 
 export interface SiteConfigurationByUrl {
@@ -2521,6 +2569,7 @@ export interface SiteConfigurationByUrl {
   modules: Module[];
   user?: UserPublic | null;
   asoSettings?: ASOSettings | null;
+  accountSettings: AccountSettings;
   workflows: Workflow[];
 }
 
@@ -2546,13 +2595,6 @@ export interface SiteConfigurationForm {
   entityTypes: string[];
 }
 
-export interface SiteConfigurationPaginated {
-  rows: SiteConfiguration[];
-  pagination: Pagination;
-  /** @format int64 */
-  count: number;
-}
-
 export interface SiteConfigurationReduced {
   /** @format uuid */
   id: string;
@@ -2735,6 +2777,39 @@ export interface SiteConfigurationSearchCriteria {
   searchText?: string | null;
   isActive?: boolean | null;
   entityType?: string | null;
+  /** @format uuid */
+  branch?: string | null;
+  /** @format uuid */
+  brand?: string | null;
+  role?: UserRole | null;
+  branchType?: string | null;
+}
+
+export interface SiteConfigurationWithBranchBrandLOInformation {
+  /** @format uuid */
+  id: string;
+  url?: string | null;
+  name: string;
+  /** @format int64 */
+  nmlsid: number;
+  email?: string | null;
+  companyName?: string | null;
+  /** @format date-time */
+  createdAt?: string | null;
+  /** @format date-time */
+  deletedAt?: string | null;
+  branch?: BranchBase | null;
+  corporate?: CorporateBase | null;
+  loanOfficer?: User | null;
+  realtor?: User | null;
+  branchName?: string | null;
+}
+
+export interface SiteConfigurationWithBranchBrandLOInformationPaginated {
+  rows: SiteConfigurationWithBranchBrandLOInformation[];
+  pagination: Pagination;
+  /** @format int64 */
+  count: number;
 }
 
 export interface SiteConfigurationWithInherited {
@@ -2794,8 +2869,6 @@ export interface Task {
   usedInBusinessRule: boolean;
   willAutocompleteAfterResponse: boolean;
   hasAutoPropagationOnAdd: boolean;
-  /** @format int32 */
-  commentsCount: number;
 }
 
 export interface TaskComment {
@@ -2982,6 +3055,7 @@ export interface UpdateAccountRequest {
   allowedLoginsWithoutMFA: number;
   losSettings: LOSSettingsUpdateRequest;
   asoSettings?: ASOSettings | null;
+  settings: AccountSettingsRequest;
 }
 
 export interface UpdateDocumentTemplateRequest {
@@ -3152,12 +3226,14 @@ export interface UserMobilePhoneVerificationRequest {
 
 export interface UserNotificationSettings {
   emailEnabled: boolean;
-  textEnabled?: boolean | null;
+  textEnabled: boolean;
+  textOptIn?: boolean | null;
 }
 
 export interface UserNotificationSettingsUpdateRequest {
   emailEnabled: boolean;
-  textEnabled?: boolean | null;
+  textEnabled: boolean;
+  textOptIn?: boolean | null;
 }
 
 export interface UserPaginated {
@@ -3250,27 +3326,6 @@ export interface UserSearchCriteria {
   roles?: string[] | null;
 }
 
-export interface Verification {
-  requestId: string;
-  message?: string | null;
-  status?: string | null;
-  ssoUrls?: Record<string, string>;
-}
-
-export interface VerificationRequest {
-  requestID?: string | null;
-  loanID?: string | null;
-  /** @minItems 1 */
-  operations: string[];
-  /** @format int32 */
-  _VerificationOperations?: number | null;
-  /** @format int32 */
-  verificationOperations: number;
-  newRequest?: boolean | null;
-  /** @format uuid */
-  loanTaskID?: string | null;
-}
-
 export interface VerifyPasswordRequest {
   /**
    * @format email
@@ -3440,7 +3495,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v2.13.0
+ * @version v2.14.1
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -6344,6 +6399,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags LoanDrafts
+     * @name ReassignLoanOfficer
+     * @summary Reassign Loan officer
+     * @request PUT:/api/loans/drafts/{draftId}/reassign
+     * @secure
+     */
+    reassignLoanOfficer: (draftId: string, data: DraftLoanOfficerReassignRequest, params: RequestParams = {}) =>
+      this.request<Draft, any>({
+        path: `/api/loans/drafts/${draftId}/reassign`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -6555,7 +6630,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @secure
      */
     getLoanQueue: (loanQueueId: string, params: RequestParams = {}) =>
-      this.request<any, any>({
+      this.request<any, ProblemDetails>({
         path: `/api/loans/queue/${loanQueueId}`,
         method: "GET",
         secure: true,
@@ -6573,7 +6648,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @secure
      */
     replaceLoanQueue: (loanQueueId: string, data: UpdateLoanQueueRequest, params: RequestParams = {}) =>
-      this.request<LoanQueueWithData, any>({
+      this.request<LoanQueueWithData, ProblemDetails>({
         path: `/api/loans/queue/${loanQueueId}`,
         method: "PUT",
         body: data,
@@ -6583,6 +6658,23 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags LoanQueue
+     * @name DeleteLoanQueue
+     * @summary Delete Loan Queue Item
+     * @request DELETE:/api/loans/queue/{loanQueueId}
+     * @secure
+     */
+    deleteLoanQueue: (loanQueueId: string, params: RequestParams = {}) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/loans/queue/${loanQueueId}`,
+        method: "DELETE",
+        secure: true,
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -6593,7 +6685,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @secure
      */
     retryLoanQueue: (loanQueueId: string, params: RequestParams = {}) =>
-      this.request<void, any>({
+      this.request<void, ProblemDetails>({
         path: `/api/loans/queue/${loanQueueId}/retry`,
         method: "POST",
         secure: true,
@@ -6724,12 +6816,12 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @tags LoanTaskComments
      * @name SearchLoanTaskComments
      * @summary Search
-     * @request POST:/api/loans/{loanId}/tasks/{taskId}/comments/search
+     * @request POST:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments/search
      * @secure
      */
     searchLoanTaskComments: (
       loanId: string,
-      taskId: string,
+      userLoanTaskId: string,
       data: TaskCommentSearchCriteria,
       query?: {
         /** @format int32 */
@@ -6742,7 +6834,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       params: RequestParams = {},
     ) =>
       this.request<TaskCommentPaginated, ProblemDetails>({
-        path: `/api/loans/${loanId}/tasks/${taskId}/comments/search`,
+        path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/search`,
         method: "POST",
         query: query,
         body: data,
@@ -6758,12 +6850,12 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @tags LoanTaskComments
      * @name GetLoanTaskComment
      * @summary Get by ID
-     * @request GET:/api/loans/{loanId}/tasks/{taskId}/comments/{id}
+     * @request GET:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments/{id}
      * @secure
      */
-    getLoanTaskComment: (id: string, loanId: string, taskId: string, params: RequestParams = {}) =>
+    getLoanTaskComment: (id: string, loanId: string, userLoanTaskId: string, params: RequestParams = {}) =>
       this.request<TaskComment, ProblemDetails>({
-        path: `/api/loans/${loanId}/tasks/${taskId}/comments/${id}`,
+        path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/${id}`,
         method: "GET",
         secure: true,
         format: "json",
@@ -6776,12 +6868,17 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @tags LoanTaskComments
      * @name CreateLoanTaskComment
      * @summary Create
-     * @request POST:/api/loans/{loanId}/tasks/{taskId}/comments
+     * @request POST:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments
      * @secure
      */
-    createLoanTaskComment: (loanId: string, taskId: string, data: TaskCommentRequest, params: RequestParams = {}) =>
+    createLoanTaskComment: (
+      loanId: string,
+      userLoanTaskId: string,
+      data: TaskCommentRequest,
+      params: RequestParams = {},
+    ) =>
       this.request<TaskComment, ProblemDetails>({
-        path: `/api/loans/${loanId}/tasks/${taskId}/comments`,
+        path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments`,
         method: "POST",
         body: data,
         secure: true,
@@ -6796,18 +6893,18 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @tags LoanTaskComments
      * @name ReplaceLoanTaskComment
      * @summary Replace
-     * @request PUT:/api/loans/{loanId}/tasks/{taskId}/comments/{commentId}
+     * @request PUT:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments/{commentId}
      * @secure
      */
     replaceLoanTaskComment: (
       loanId: string,
-      taskId: string,
+      userLoanTaskId: string,
       commentId: string,
       data: TaskCommentRequest,
       params: RequestParams = {},
     ) =>
       this.request<TaskComment, ProblemDetails>({
-        path: `/api/loans/${loanId}/tasks/${taskId}/comments/${commentId}`,
+        path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/${commentId}`,
         method: "PUT",
         body: data,
         secure: true,
@@ -6822,12 +6919,12 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @tags LoanTaskComments
      * @name DeleteLoanTaskComment
      * @summary Delete
-     * @request DELETE:/api/loans/{loanId}/tasks/{taskId}/comments/{commentId}
+     * @request DELETE:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments/{commentId}
      * @secure
      */
-    deleteLoanTaskComment: (loanId: string, taskId: string, commentId: string, params: RequestParams = {}) =>
+    deleteLoanTaskComment: (loanId: string, userLoanTaskId: string, commentId: string, params: RequestParams = {}) =>
       this.request<void, ProblemDetails>({
-        path: `/api/loans/${loanId}/tasks/${taskId}/comments/${commentId}`,
+        path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/${commentId}`,
         method: "DELETE",
         secure: true,
         ...params,
@@ -7034,6 +7131,24 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags LoanTaskVerifications
+     * @name CreateLoanTaskVerification
+     * @summary Create
+     * @request POST:/api/loans/{loanID}/tasks/{loanTaskId}/verifications
+     * @secure
+     */
+    createLoanTaskVerification: (loanId: string, loanTaskId: string, params: RequestParams = {}) =>
+      this.request<UserLoanTask, ProblemDetails | UnprocessableEntity>({
+        path: `/api/loans/${loanId}/tasks/${loanTaskId}/verifications`,
+        method: "POST",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -7807,7 +7922,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       },
       params: RequestParams = {},
     ) =>
-      this.request<SiteConfigurationPaginated, UnprocessableEntity>({
+      this.request<SiteConfigurationWithBranchBrandLOInformationPaginated, UnprocessableEntity>({
         path: `/api/site-configurations/search`,
         method: "POST",
         query: query,
@@ -8730,64 +8845,6 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params,
       }),
 
-    /**
-     * No description
-     *
-     * @tags Verifications
-     * @name Verify
-     * @summary Verify
-     * @request POST:/api/verifications/verify
-     * @secure
-     */
-    verify: (data: VerificationRequest, params: RequestParams = {}) =>
-      this.request<Verification, UnprocessableEntity>({
-        path: `/api/verifications/verify`,
-        method: "POST",
-        body: data,
-        secure: true,
-        type: ContentType.Json,
-        format: "json",
-        ...params,
-      }),
-
-    /**
-     * No description
-     *
-     * @tags Verifications
-     * @name GetVerificationStatus
-     * @summary Get Status
-     * @request POST:/api/verifications/status
-     * @secure
-     */
-    getVerificationStatus: (data: VerificationRequest, params: RequestParams = {}) =>
-      this.request<Verification, UnprocessableEntity>({
-        path: `/api/verifications/status`,
-        method: "POST",
-        body: data,
-        secure: true,
-        type: ContentType.Json,
-        format: "json",
-        ...params,
-      }),
-
-    /**
-     * No description
-     *
-     * @tags Verifications
-     * @name GetVerificationFrontEndMaterials
-     * @summary Get Front End Materials
-     * @request GET:/api/verifications/frontend-materials/{requestId}
-     * @secure
-     */
-    getVerificationFrontEndMaterials: (requestId: string, params: RequestParams = {}) =>
-      this.request<Verification, UnprocessableEntity>({
-        path: `/api/verifications/frontend-materials/${requestId}`,
-        method: "GET",
-        secure: true,
-        format: "json",
-        ...params,
-      }),
-
     /**
      * No description
      *