@matech/thebigpos-sdk 3.7.0-dev-3432 → 3.7.0-dev-3489

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export type VersionStatusType = "Draft" | "Published";
 export type UserRole = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
+export type TaskType = "Document" | "Field" | "Signature" | "EDisclosure" | "EConsent" | "VerificationOfAssets" | "VerificationOfIncome" | "VerificationOfEmployment" | "VerificationOfCredit" | "Payment" | "VerificationOfIncomeAndEmployment" | "VerificationOfTaxes";
 export type TaskStatus = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
 export type TableKey = "Pipeline";
 export type SortDirection = "Asc" | "Desc";
@@ -19,6 +20,7 @@ export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
 export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
 export type LoanTitleHeld = "Sole" | "JointWithSpouse" | "JointWithOtherThanSpouse";
 export type LoanTaskActivityFilter = "Active" | "Inactive" | "All";
+export type LoanRoleTaskSource = "Rule" | "Manual";
 export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type LoanRefinancePurpose = "CashOutDebtConsolidation" | "CashOutHomeImprovement" | "CashOutOther" | "NoCashOut" | "LimitedCashOut";
 export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell" | "PendingSale";
@@ -39,7 +41,7 @@ export type LoanNameSuffix = "Jr" | "Sr" | "II" | "III" | "IV" | "V" | "VI" | "V
 export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
 export type LoanMilitaryServiceType = "Current" | "RetiredDischargedSeparated" | "NonActivatedNationalGuard" | "SurvivingSpouse";
 export type LoanMaritalStatus = "Married" | "Separated" | "Single";
-export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded";
+export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited";
 export type LoanLienPosition = "First" | "Subordinate";
 export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
 export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other" | "DoNotWishToRespond";
@@ -1421,6 +1423,15 @@ export interface CreateLoanImportRequest {
     startDate: string;
     importMode: CreateLoanImportRequestImportModeEnum;
 }
+export interface CreateLoanRoleTaskRequest {
+    /** @format uuid */
+    taskId: string;
+    role: CreateLoanRoleTaskRequestRoleEnum;
+    /** @format int32 */
+    borrowerPair: number;
+    /** @format int32 */
+    borrowerPosition: number;
+}
 export interface CreateSession {
     sessionId: string;
     sessionUrl: string;
@@ -1834,6 +1845,7 @@ export interface EnabledServices {
     ringCentral?: boolean | null;
     socialSurvey?: boolean | null;
     borrowerTasks?: boolean | null;
+    preBorrowerTasks?: boolean | null;
     docusign?: boolean | null;
     emailNotifications?: boolean | null;
     autoTaskReminders?: boolean | null;
@@ -4114,6 +4126,52 @@ export interface LoanRefinanceRequest {
     purpose?: LoanRefinancePurpose | null;
     currentLoan?: LoanRefinanceCurrentLoanRequest | null;
 }
+export interface LoanRoleSlotTasks {
+    role: LoanRoleSlotTasksRoleEnum;
+    /** @format int32 */
+    borrowerPair: number;
+    /** @format int32 */
+    borrowerPosition: number;
+    tasks: LoanRoleTask[];
+}
+export interface LoanRoleTask {
+    /** @format uuid */
+    id: string;
+    /** @format uuid */
+    loanId: string;
+    role: LoanRoleTaskRoleEnum;
+    /** @format int32 */
+    borrowerPair: number;
+    /** @format int32 */
+    borrowerPosition: number;
+    /** @format uuid */
+    definitionTaskId: string;
+    /** @format uuid */
+    taskId: string;
+    name: string;
+    description?: string | null;
+    type: LoanRoleTaskTypeEnum;
+    losTarget?: string | null;
+    /** @format int32 */
+    daysDueFromApplication?: number | null;
+    /** @format int32 */
+    weight: number;
+    willAutocompleteAfterResponse: boolean;
+    /** @format uuid */
+    loanDocumentFolderId?: string | null;
+    /** @format date */
+    dueDate?: string | null;
+    source: LoanRoleTaskSourceEnum;
+    isAttached: boolean;
+    /** @format uuid */
+    attachedUserLoanTaskId?: string | null;
+    /** @format date-time */
+    attachedAt?: string | null;
+    /** @format uuid */
+    createdById?: string | null;
+    /** @format date-time */
+    createdAt: string;
+}
 export interface LoanSearchCriteria {
     searchText?: string | null;
     searchTerms?: string[] | null;
@@ -4142,6 +4200,7 @@ export interface LoanSearchCriteria {
     closingFrom?: string | null;
     /** @format date */
     closingTo?: string | null;
+    milestoneConfigurationIds?: string[] | null;
 }
 export interface LoanSettings {
     excludeFromAutoTaskReminders: boolean;
@@ -4446,6 +4505,10 @@ export interface LosWebhookSigningKeySyncResult {
 export interface ManualDocumentClassificationRequest {
     documentType: ManualDocumentClassificationRequestDocumentTypeEnum;
 }
+export interface MaterializeLoanRoleTasks {
+    /** @format int32 */
+    rowsAdded: number;
+}
 export interface MdmUser {
     user_email?: string | null;
     user_id?: string | null;
@@ -5798,6 +5861,8 @@ export interface Task {
     isGlobal: boolean;
     /** @format uuid */
     id: string;
+    /** @format uuid */
+    sourceTaskID?: string | null;
     user?: User | null;
     isFromLegacySource: boolean;
     usedInBusinessRule: boolean;
@@ -6117,6 +6182,16 @@ export interface UpdateLoanDocumentFolderRequest {
 export interface UpdateLoanQueueRequest {
     data: any;
 }
+export interface UpdateLoanRoleTaskRequest {
+    name?: string | null;
+    description?: string | null;
+    /** @format int32 */
+    weight?: number | null;
+    /** @format uuid */
+    loanDocumentFolderId?: string | null;
+    /** @format date */
+    dueDate?: string | null;
+}
 export interface UpdateMeRequest {
     phone?: string | null;
     firstName: string;
@@ -6487,6 +6562,12 @@ export interface UserLoanTaskUpdateRequest {
     value?: string | null;
     /** @format date */
     dueDate?: string | null;
+    name?: string | null;
+    description?: string | null;
+    /** @format int32 */
+    weight?: number | null;
+    /** @format uuid */
+    loanDocumentFolderId?: string | null;
 }
 export interface UserMobilePhoneVerificationRequest {
     code: string;
@@ -6660,6 +6741,7 @@ export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "
 /** @deprecated */
 export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
 export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
+export type CreateLoanRoleTaskRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
 export type CustomFieldDefinitionEntityTypeEnum = "Loan";
@@ -6695,9 +6777,13 @@ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed"
 export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
 export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
 export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
-export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded";
+export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited";
 export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
-export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded";
+export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited";
+export type LoanRoleSlotTasksRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
+export type LoanRoleTaskRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
+export type LoanRoleTaskTypeEnum = "Document" | "Field" | "Signature" | "EDisclosure" | "EConsent" | "VerificationOfAssets" | "VerificationOfIncome" | "VerificationOfEmployment" | "VerificationOfCredit" | "Payment" | "VerificationOfIncomeAndEmployment" | "VerificationOfTaxes";
+export type LoanRoleTaskSourceEnum = "Rule" | "Manual";
 export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
 export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type LosCredentialHealthStatusEnum = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
@@ -10889,6 +10975,85 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `404` `ProblemDetails` Not Found
          */
         retryLoanQueue: (loanQueueId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags LoanRoleTasks
+         * @name GetLoanRoleTasks
+         * @summary Get queued tasks grouped by borrower slot
+         * @request GET:/api/loans/{loanId}/role-tasks
+         * @secure
+         * @response `200` `(LoanRoleSlotTasks)[]` OK
+         * @response `404` `ProblemDetails` Not Found
+         */
+        getLoanRoleTasks: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<LoanRoleSlotTasks[], any, {}>>;
+        /**
+         * @description Queues an account template against a borrower slot that has no registered user yet. The row owns a per-loan copy of the template, so editing it never changes the account's catalogue.
+         *
+         * @tags LoanRoleTasks
+         * @name CreateLoanRoleTask
+         * @summary Queue a task for a borrower slot
+         * @request POST:/api/loans/{loanId}/role-tasks
+         * @secure
+         * @response `201` `LoanRoleTask` Created
+         * @response `400` `ProblemDetails` Bad Request
+         * @response `404` `ProblemDetails` Not Found
+         * @response `409` `ProblemDetails` Conflict
+         * @response `422` `ProblemDetails` Unprocessable Content
+         */
+        createLoanRoleTask: (loanId: string, data: CreateLoanRoleTaskRequest, params?: RequestParams) => Promise<AxiosResponse<LoanRoleTask, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags LoanRoleTasks
+         * @name GetLoanRoleTask
+         * @summary Get a queued task
+         * @request GET:/api/loans/{loanId}/role-tasks/{id}
+         * @secure
+         * @response `200` `LoanRoleTask` OK
+         * @response `404` `ProblemDetails` Not Found
+         */
+        getLoanRoleTask: (loanId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<LoanRoleTask, any, {}>>;
+        /**
+         * @description Edits the loan's own copy of the template. The account's catalogue entry is untouched, so the change applies to this borrower only. Omitted fields are left as they are.
+         *
+         * @tags LoanRoleTasks
+         * @name UpdateLoanRoleTask
+         * @summary Edit a queued task
+         * @request PUT:/api/loans/{loanId}/role-tasks/{id}
+         * @secure
+         * @response `200` `LoanRoleTask` OK
+         * @response `400` `ProblemDetails` Bad Request
+         * @response `404` `ProblemDetails` Not Found
+         * @response `409` `ProblemDetails` Conflict
+         * @response `422` `ProblemDetails` Unprocessable Content
+         */
+        updateLoanRoleTask: (loanId: string, id: string, data: UpdateLoanRoleTaskRequest, params?: RequestParams) => Promise<AxiosResponse<LoanRoleTask, any, {}>>;
+        /**
+         * @description Removes a queued task from a borrower slot. The removal is remembered, so a later run of the rules does not queue the same template again.
+         *
+         * @tags LoanRoleTasks
+         * @name DeleteLoanRoleTask
+         * @summary Remove a queued task
+         * @request DELETE:/api/loans/{loanId}/role-tasks/{id}
+         * @secure
+         * @response `204` `void` No Content
+         * @response `404` `ProblemDetails` Not Found
+         * @response `409` `ProblemDetails` Conflict
+         */
+        deleteLoanRoleTask: (loanId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
+        /**
+         * @description Runs the account's business rules against the loan and queues what is missing. Templates already queued, and ones removed by staff, are left alone.
+         *
+         * @tags LoanRoleTasks
+         * @name MaterializeLoanRoleTasks
+         * @summary Queue the business rule defaults
+         * @request POST:/api/loans/{loanId}/role-tasks/materialize
+         * @secure
+         * @response `200` `MaterializeLoanRoleTasks` OK
+         * @response `404` `ProblemDetails` Not Found
+         */
+        materializeLoanRoleTasks: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<MaterializeLoanRoleTasks, any, {}>>;
         /**
          * No description
          *
@@ -11323,6 +11488,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/api/loans/{loanId}/users/{userId}
          * @secure
          * @response `201` `LoanUser` Created
+         * @response `404` `ProblemDetails` Not Found
          */
         addLoanUser: (loanId: string, userId: string, data: CreateUserLoan, params?: RequestParams) => Promise<AxiosResponse<LoanUser, any, {}>>;
         /**

package/dist/index.js

@@ -3773,6 +3773,85 @@ export class Api extends HttpClient {
              * @response `404` `ProblemDetails` Not Found
              */
             retryLoanQueue: (loanQueueId, params = {}) => this.request(Object.assign({ path: `/api/loans/queue/${loanQueueId}/retry`, method: "POST", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanRoleTasks
+             * @name GetLoanRoleTasks
+             * @summary Get queued tasks grouped by borrower slot
+             * @request GET:/api/loans/{loanId}/role-tasks
+             * @secure
+             * @response `200` `(LoanRoleSlotTasks)[]` OK
+             * @response `404` `ProblemDetails` Not Found
+             */
+            getLoanRoleTasks: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/role-tasks`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * @description Queues an account template against a borrower slot that has no registered user yet. The row owns a per-loan copy of the template, so editing it never changes the account's catalogue.
+             *
+             * @tags LoanRoleTasks
+             * @name CreateLoanRoleTask
+             * @summary Queue a task for a borrower slot
+             * @request POST:/api/loans/{loanId}/role-tasks
+             * @secure
+             * @response `201` `LoanRoleTask` Created
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             * @response `422` `ProblemDetails` Unprocessable Content
+             */
+            createLoanRoleTask: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/role-tasks`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanRoleTasks
+             * @name GetLoanRoleTask
+             * @summary Get a queued task
+             * @request GET:/api/loans/{loanId}/role-tasks/{id}
+             * @secure
+             * @response `200` `LoanRoleTask` OK
+             * @response `404` `ProblemDetails` Not Found
+             */
+            getLoanRoleTask: (loanId, id, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/role-tasks/${id}`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * @description Edits the loan's own copy of the template. The account's catalogue entry is untouched, so the change applies to this borrower only. Omitted fields are left as they are.
+             *
+             * @tags LoanRoleTasks
+             * @name UpdateLoanRoleTask
+             * @summary Edit a queued task
+             * @request PUT:/api/loans/{loanId}/role-tasks/{id}
+             * @secure
+             * @response `200` `LoanRoleTask` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             * @response `422` `ProblemDetails` Unprocessable Content
+             */
+            updateLoanRoleTask: (loanId, id, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/role-tasks/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * @description Removes a queued task from a borrower slot. The removal is remembered, so a later run of the rules does not queue the same template again.
+             *
+             * @tags LoanRoleTasks
+             * @name DeleteLoanRoleTask
+             * @summary Remove a queued task
+             * @request DELETE:/api/loans/{loanId}/role-tasks/{id}
+             * @secure
+             * @response `204` `void` No Content
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             */
+            deleteLoanRoleTask: (loanId, id, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/role-tasks/${id}`, method: "DELETE", secure: true }, params)),
+            /**
+             * @description Runs the account's business rules against the loan and queues what is missing. Templates already queued, and ones removed by staff, are left alone.
+             *
+             * @tags LoanRoleTasks
+             * @name MaterializeLoanRoleTasks
+             * @summary Queue the business rule defaults
+             * @request POST:/api/loans/{loanId}/role-tasks/materialize
+             * @secure
+             * @response `200` `MaterializeLoanRoleTasks` OK
+             * @response `404` `ProblemDetails` Not Found
+             */
+            materializeLoanRoleTasks: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/role-tasks/materialize`, method: "POST", secure: true, format: "json" }, params)),
             /**
              * No description
              *
@@ -4178,6 +4257,7 @@ export class Api extends HttpClient {
              * @request POST:/api/loans/{loanId}/users/{userId}
              * @secure
              * @response `201` `LoanUser` Created
+             * @response `404` `ProblemDetails` Not Found
              */
             addLoanUser: (loanId, userId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/users/${userId}`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**