@matech/thebigpos-sdk 2.13.0-rc1 → 2.14.0-rc.0

package/src/index.ts

@@ -28,7 +28,7 @@ export interface ASOSettings {
   preApproval: boolean;
   preQualification: boolean;
   mi: boolean;
-  miRadiam: boolean;
+  miRadian: boolean;
   miEssent: boolean;
   miNational: boolean;
   miEnact: boolean;
@@ -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 {
@@ -101,6 +112,31 @@ export interface AddressRequest {
   postalCode: string;
 }
 
+export interface AdminAccessGetForm {
+  /** @format date-time */
+  createdAt?: string | null;
+  /** @format date-time */
+  updatedAt?: string | null;
+  /** @format date-time */
+  deletedAt?: string | null;
+  /** @format uuid */
+  id: string;
+  formJSON: any;
+  /** @format int32 */
+  type: number;
+  target: string;
+  authType: string;
+  name: string;
+  isDefault: boolean;
+  description?: string | null;
+  slug?: string | null;
+  status: string;
+  language?: string | null;
+  showProgressBar: boolean;
+  borrowerType?: BorrowerType | null;
+  versions: FormVersion[];
+}
+
 export interface AdminAccessGetForms {
   /** @format date-time */
   createdAt?: string | null;
@@ -146,6 +182,7 @@ export interface AdminAccessUser {
   canImpersonate: boolean;
   loanIDs: string[];
   drafts: Draft[];
+  notificationSettings?: UserNotificationSettings | null;
   /** @format uuid */
   accountID?: string | null;
   loans: UserLoan[];
@@ -266,6 +303,7 @@ export interface BranchUser {
   canImpersonate: boolean;
   loanIDs: string[];
   drafts: Draft[];
+  notificationSettings?: UserNotificationSettings | null;
   /** @format uuid */
   branchID: string;
   branchName: string;
@@ -443,6 +481,7 @@ export interface CreateAccountRequest {
    * @min 0
    */
   nlmsid: number;
+  settings: AccountSettingsRequest;
 }
 
 export interface CreateBranchRequest {
@@ -554,6 +593,7 @@ export interface DetailedUser {
   canImpersonate: boolean;
   loanIDs: string[];
   drafts: Draft[];
+  notificationSettings?: UserNotificationSettings | null;
 }
 
 export interface Device {
@@ -780,11 +820,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 {
@@ -814,7 +857,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;
@@ -1593,13 +1635,32 @@ export type LoanQueueReason = "Unknown" | "Locked" | "LOSError" | "Exception";
 export interface LoanQueueSearchCriteria {
   searchText?: string | null;
   loanID?: string | null;
-  isActive?: boolean | null;
   type?: LoanQueueType | null;
   status?: LOSStatus | null;
   reason?: LoanQueueReason | null;
 }
 
-export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "Document";
+export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
+
+export interface LoanQueueWithData {
+  /** @format date-time */
+  createdAt: string;
+  /** @format date-time */
+  updatedAt?: string | null;
+  /** @format date-time */
+  deletedAt?: string | null;
+  /** @format uuid */
+  id: string;
+  loanID?: string | null;
+  type: string;
+  reason: string;
+  status: string;
+  details?: string | null;
+  user: UserPublic;
+  loanOfficer: LoanOfficerPublic;
+  siteConfiguration: SiteConfigurationReduced;
+  data: any;
+}
 
 export interface LoanRecord {
   loanGuid: string;
@@ -1693,33 +1754,6 @@ export interface ModuleParameterValue {
   isInherited: boolean;
 }
 
-export interface NotificationLog {
-  /** @format uuid */
-  id: string;
-  type: "Email" | "Text" | "PushNotification";
-  to: string;
-  cc?: string | null;
-  subject?: string | null;
-  message: string;
-  notificationTemplate?: NotificationTemplate | null;
-  /** @format date-time */
-  createdAt: string;
-}
-
-export interface NotificationLogPaginated {
-  rows: NotificationLog[];
-  pagination: Pagination;
-  /** @format int64 */
-  count: number;
-}
-
-export interface NotificationLogSearchCriteria {
-  searchText?: string | null;
-  type?: NotificationType | null;
-  to?: string[] | null;
-  cc?: string[] | null;
-}
-
 export interface NotificationTemplate {
   /** @format date-time */
   createdAt?: string | null;
@@ -1802,6 +1836,7 @@ export interface NotificationTemplateVersion {
   isActive: boolean;
   htmlBody: string;
   plainBody: string;
+  textBody: string;
   notificationTemplate: NotificationTemplate;
 }
 
@@ -1820,6 +1855,7 @@ export interface NotificationTemplateVersionBase {
   isActive: boolean;
   htmlBody: string;
   plainBody: string;
+  textBody: string;
 }
 
 export interface NotificationTemplateVersionRequest {
@@ -1828,6 +1864,7 @@ export interface NotificationTemplateVersionRequest {
   isActive: boolean;
   htmlBody: string;
   plainBody: string;
+  textBody: string;
 }
 
 export interface NotificationTemplateVersionUpdateRequest {
@@ -1841,10 +1878,10 @@ export interface NotificationTemplateVersionUpdateRequest {
   htmlBody: string;
   /** @minLength 1 */
   plainBody: string;
+  /** @minLength 1 */
+  textBody: string;
 }
 
-export type NotificationType = "Email" | "Text" | "PushNotification";
-
 export interface Operation {
   op?: string;
   value?: object | null;
@@ -2037,6 +2074,7 @@ export interface RunLOCalculation {
   canGeneratePreQual: boolean;
   canGeneratePreApproval: boolean;
   preApprovalNotes?: string | null;
+  additionalPreApprovalNotes?: string | null;
   downPaymentAmount?: string | null;
   downPaymentPercent?: string | null;
   lienType?: string | null;
@@ -2073,6 +2111,7 @@ export interface RunLOCalculationRequest {
   /** @minLength 1 */
   lienType: string;
   preApprovalNotes?: string | null;
+  additionalPreApprovalNotes?: string | null;
 }
 
 export interface SSOToken {
@@ -2110,6 +2149,7 @@ export interface SendNotificationForLoanRequest {
   siteConfigurationId?: string | null;
   /** @minLength 1 */
   email: string;
+  phone?: string | null;
   attachments: Attachment[];
 }
 
@@ -2304,6 +2344,7 @@ export interface SiteConfiguration {
   modules: Module[];
   user?: UserPublic | null;
   asoSettings?: ASOSettings | null;
+  accountSettings: AccountSettings;
 }
 
 export interface SiteConfigurationByUrl {
@@ -2497,6 +2538,7 @@ export interface SiteConfigurationByUrl {
   modules: Module[];
   user?: UserPublic | null;
   asoSettings?: ASOSettings | null;
+  accountSettings: AccountSettings;
   workflows: Workflow[];
 }
 
@@ -2772,6 +2814,30 @@ export interface Task {
   hasAutoPropagationOnAdd: boolean;
 }
 
+export interface TaskComment {
+  /** @format uuid */
+  id: string;
+  comment: string;
+  createdBy: UserBase;
+  /** @format date-time */
+  createdAt: string;
+}
+
+export interface TaskCommentPaginated {
+  rows: TaskComment[];
+  pagination: Pagination;
+  /** @format int64 */
+  count: number;
+}
+
+export interface TaskCommentRequest {
+  comment: string;
+}
+
+export interface TaskCommentSearchCriteria {
+  searchText?: string | null;
+}
+
 export interface TaskPaginated {
   rows: Task[];
   pagination: Pagination;
@@ -2827,6 +2893,7 @@ export interface TestSendNotificationForLoanRequest {
   /** @format uuid */
   siteConfigurationId: string;
   toAddress?: string | null;
+  toPhoneNumber?: string | null;
   templateName?: string | null;
   attachments: Attachment[];
 }
@@ -2931,6 +2998,7 @@ export interface UpdateAccountRequest {
   allowedLoginsWithoutMFA: number;
   losSettings: LOSSettingsUpdateRequest;
   asoSettings?: ASOSettings | null;
+  settings: AccountSettingsRequest;
 }
 
 export interface UpdateDocumentTemplateRequest {
@@ -2972,6 +3040,10 @@ export interface UpdateListingPhotoRequest {
   weight: number;
 }
 
+export interface UpdateLoanQueueRequest {
+  data: any;
+}
+
 export interface UpdateMeRequest {
   phone?: string | null;
   /**
@@ -2987,6 +3059,7 @@ export interface UpdateMeRequest {
   title?: string | null;
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
+  notificationSettings: UserNotificationSettingsUpdateRequest;
 }
 
 export interface UpdateMobilePhoneRequest {
@@ -3071,6 +3144,8 @@ export interface UserLoanTask {
   createdBy: User;
   submittedBy?: User | null;
   completedBy?: User | null;
+  /** @format int32 */
+  commentsCount: number;
 }
 
 export interface UserLoanTaskRequest {
@@ -3092,6 +3167,18 @@ export interface UserMobilePhoneVerificationRequest {
   code: string;
 }
 
+export interface UserNotificationSettings {
+  emailEnabled: boolean;
+  textEnabled: boolean;
+  textOptIn?: boolean | null;
+}
+
+export interface UserNotificationSettingsUpdateRequest {
+  emailEnabled: boolean;
+  textEnabled: boolean;
+  textOptIn?: boolean | null;
+}
+
 export interface UserPaginated {
   rows: User[];
   pagination: Pagination;
@@ -4864,7 +4951,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @secure
      */
     createForm: (data: FormRequest, params: RequestParams = {}) =>
-      this.request<AdminAccessGetForms, UnprocessableEntity>({
+      this.request<AdminAccessGetForm, UnprocessableEntity>({
         path: `/api/forms`,
         method: "POST",
         body: data,
@@ -4884,7 +4971,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @secure
      */
     getForm: (id: string, params: RequestParams = {}) =>
-      this.request<AdminAccessGetForms, any>({
+      this.request<AdminAccessGetForm, any>({
         path: `/api/forms/${id}`,
         method: "GET",
         secure: true,
@@ -4902,7 +4989,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @secure
      */
     replaceForm: (id: string, data: FormRequest, params: RequestParams = {}) =>
-      this.request<AdminAccessGetForms, UnprocessableEntity>({
+      this.request<AdminAccessGetForm, UnprocessableEntity>({
         path: `/api/forms/${id}`,
         method: "PUT",
         body: data,
@@ -4939,7 +5026,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @secure
      */
     restoreForm: (id: string, params: RequestParams = {}) =>
-      this.request<AdminAccessGetForms, any>({
+      this.request<AdminAccessGetForm, any>({
         path: `/api/forms/${id}/restore`,
         method: "POST",
         secure: true,
@@ -6276,6 +6363,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
      *
@@ -6481,14 +6588,14 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * No description
      *
      * @tags LoanQueue
-     * @name GetLoanQueueData
-     * @summary Get Data
-     * @request GET:/api/loans/queue/{loanQueueId}/data
+     * @name GetLoanQueue
+     * @summary Get Loan Queue Record
+     * @request GET:/api/loans/queue/{loanQueueId}
      * @secure
      */
-    getLoanQueueData: (loanQueueId: string, params: RequestParams = {}) =>
+    getLoanQueue: (loanQueueId: string, params: RequestParams = {}) =>
       this.request<any, any>({
-        path: `/api/loans/queue/${loanQueueId}/data`,
+        path: `/api/loans/queue/${loanQueueId}`,
         method: "GET",
         secure: true,
         format: "json",
@@ -6499,18 +6606,19 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * No description
      *
      * @tags LoanQueue
-     * @name UpdateLoanQueueData
-     * @summary Update Data
-     * @request PUT:/api/loans/queue/{loanQueueId}/data
+     * @name ReplaceLoanQueue
+     * @summary Replace Loan Queue Record
+     * @request PUT:/api/loans/queue/{loanQueueId}
      * @secure
      */
-    updateLoanQueueData: (loanQueueId: string, data: any, params: RequestParams = {}) =>
-      this.request<void, any>({
-        path: `/api/loans/queue/${loanQueueId}/data`,
+    replaceLoanQueue: (loanQueueId: string, data: UpdateLoanQueueRequest, params: RequestParams = {}) =>
+      this.request<LoanQueueWithData, any>({
+        path: `/api/loans/queue/${loanQueueId}`,
         method: "PUT",
         body: data,
         secure: true,
         type: ContentType.Json,
+        format: "json",
         ...params,
       }),
 
@@ -6649,6 +6757,126 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags LoanTaskComments
+     * @name SearchLoanTaskComments
+     * @summary Search
+     * @request POST:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments/search
+     * @secure
+     */
+    searchLoanTaskComments: (
+      loanId: string,
+      userLoanTaskId: string,
+      data: TaskCommentSearchCriteria,
+      query?: {
+        /** @format int32 */
+        pageSize?: number;
+        /** @format int32 */
+        pageNumber?: number;
+        sortBy?: string;
+        sortDirection?: string;
+      },
+      params: RequestParams = {},
+    ) =>
+      this.request<TaskCommentPaginated, ProblemDetails>({
+        path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/search`,
+        method: "POST",
+        query: query,
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags LoanTaskComments
+     * @name GetLoanTaskComment
+     * @summary Get by ID
+     * @request GET:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments/{id}
+     * @secure
+     */
+    getLoanTaskComment: (id: string, loanId: string, userLoanTaskId: string, params: RequestParams = {}) =>
+      this.request<TaskComment, ProblemDetails>({
+        path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/${id}`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags LoanTaskComments
+     * @name CreateLoanTaskComment
+     * @summary Create
+     * @request POST:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments
+     * @secure
+     */
+    createLoanTaskComment: (
+      loanId: string,
+      userLoanTaskId: string,
+      data: TaskCommentRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<TaskComment, ProblemDetails>({
+        path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags LoanTaskComments
+     * @name ReplaceLoanTaskComment
+     * @summary Replace
+     * @request PUT:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments/{commentId}
+     * @secure
+     */
+    replaceLoanTaskComment: (
+      loanId: string,
+      userLoanTaskId: string,
+      commentId: string,
+      data: TaskCommentRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<TaskComment, ProblemDetails>({
+        path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/${commentId}`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags LoanTaskComments
+     * @name DeleteLoanTaskComment
+     * @summary Delete
+     * @request DELETE:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments/{commentId}
+     * @secure
+     */
+    deleteLoanTaskComment: (loanId: string, userLoanTaskId: string, commentId: string, params: RequestParams = {}) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/${commentId}`,
+        method: "DELETE",
+        secure: true,
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -6997,67 +7225,6 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params,
       }),
 
-    /**
-     * No description
-     *
-     * @tags NotificationLogs
-     * @name GetNotificationLogs
-     * @summary Get All
-     * @request GET:/api/notifications/logs
-     * @secure
-     */
-    getNotificationLogs: (
-      query?: {
-        /** @format int32 */
-        pageSize?: number;
-        /** @format int32 */
-        pageNumber?: number;
-        sortBy?: string;
-        sortDirection?: string;
-      },
-      params: RequestParams = {},
-    ) =>
-      this.request<NotificationLog[], any>({
-        path: `/api/notifications/logs`,
-        method: "GET",
-        query: query,
-        secure: true,
-        format: "json",
-        ...params,
-      }),
-
-    /**
-     * No description
-     *
-     * @tags NotificationLogs
-     * @name SearchNotificationLog
-     * @summary Search
-     * @request POST:/api/notifications/logs/search
-     * @secure
-     */
-    searchNotificationLog: (
-      data: NotificationLogSearchCriteria,
-      query?: {
-        /** @format int32 */
-        pageSize?: number;
-        /** @format int32 */
-        pageNumber?: number;
-        sortBy?: string;
-        sortDirection?: string;
-      },
-      params: RequestParams = {},
-    ) =>
-      this.request<NotificationLogPaginated, any>({
-        path: `/api/notifications/logs/search`,
-        method: "POST",
-        query: query,
-        body: data,
-        secure: true,
-        type: ContentType.Json,
-        format: "json",
-        ...params,
-      }),
-
     /**
      * No description
      *
@@ -7328,7 +7495,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
     getPartners: (
       query?: {
         showAll?: boolean;
-        /** @default 4 */
+        /** @default "Realtor" */
         role?:
           | "Borrower"
           | "LoanOfficer"
@@ -7558,25 +7725,6 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params,
       }),
 
-    /**
-     * No description
-     *
-     * @tags SelfProvisioning
-     * @name CreateSelfProvisioningItem
-     * @summary Create
-     * @request POST:/api/selfprovisioning/newcustomer
-     * @secure
-     */
-    createSelfProvisioningItem: (data: any, params: RequestParams = {}) =>
-      this.request<void, any>({
-        path: `/api/selfprovisioning/newcustomer`,
-        method: "POST",
-        body: data,
-        secure: true,
-        type: ContentType.Json,
-        ...params,
-      }),
-
     /**
      * No description
      *