@matech/thebigpos-sdk 3.6.0 → 3.7.0-pr-4910

package/src/index.ts

@@ -23,6 +23,20 @@ export type UserRole =
   | "LoanOfficerAssistant"
   | "SystemAdmin";
 
+export type TaskType =
+  | "Document"
+  | "Field"
+  | "Signature"
+  | "EDisclosure"
+  | "EConsent"
+  | "VerificationOfAssets"
+  | "VerificationOfIncome"
+  | "VerificationOfEmployment"
+  | "VerificationOfCredit"
+  | "Payment"
+  | "VerificationOfIncomeAndEmployment"
+  | "VerificationOfTaxes";
+
 export type TaskStatus =
   | "Outstanding"
   | "Pending"
@@ -96,6 +110,8 @@ export type LoanTitleHeld =
 
 export type LoanTaskActivityFilter = "Active" | "Inactive" | "All";
 
+export type LoanRoleTaskSource = "Rule" | "Manual";
+
 export type LoanRole =
   | "Borrower"
   | "CoBorrower"
@@ -265,7 +281,8 @@ export type LoanLogType =
   | "DocumentClassified"
   | "CoBorrowerEmailAutoFixed"
   | "LosFieldWriteBack"
-  | "ReferrerChangeDiscarded";
+  | "ReferrerChangeDiscarded"
+  | "TaskEdited";
 
 export type LoanLienPosition = "First" | "Subordinate";
 
@@ -1043,6 +1060,8 @@ export interface AiCanonicalField {
   textractKey?: string | null;
   textractKeyAliases: string[];
   hasAccountOverride: boolean;
+  writable: boolean;
+  patchPath?: string | null;
   /** @format date-time */
   createdAt: string;
   /** @format date-time */
@@ -2112,6 +2131,16 @@ export interface CreateLoanImportRequest {
   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;
@@ -2564,6 +2593,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;
@@ -3457,6 +3487,7 @@ export interface LoanApplicationRequest {
   purpose?: LoanPurpose | null;
   referrer?: string | null;
   companyName?: string | null;
+  relationship?: BorrowerRelationship | null;
   property?: LoanPropertyRequest | null;
   financial?: LoanFinancialRequest | null;
   refinance?: LoanRefinanceRequest | null;
@@ -4452,6 +4483,7 @@ export interface LoanDocumentFolderWithCount {
   isActive: boolean;
   /** @format int32 */
   documentCount: number;
+  accessLevel: LoanDocumentFolderWithCountAccessLevelEnum;
   isUnassigned: boolean;
 }
 
@@ -4652,6 +4684,7 @@ export interface LoanList {
   userLoans: UserLoan[];
   contacts: LoanContact[];
   borrowers: LoanListBorrower[];
+  taskCounts: LoanTaskCounts;
 }
 
 export interface LoanListBorrower {
@@ -5024,6 +5057,54 @@ export interface LoanRefinanceRequest {
   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;
@@ -5042,6 +5123,17 @@ export interface LoanSettings {
   excludeFromAutoTaskReminders: boolean;
 }
 
+export interface LoanTaskCounts {
+  /** @format int32 */
+  outstanding: number;
+  /** @format int32 */
+  pending: number;
+  /** @format int32 */
+  completed: number;
+  /** @format int32 */
+  rejected: number;
+}
+
 export interface LoanTaskSearchRequest {
   searchText?: string | null;
   statuses?: TaskStatus[] | null;
@@ -5360,6 +5452,11 @@ export interface ManualDocumentClassificationRequest {
   documentType: ManualDocumentClassificationRequestDocumentTypeEnum;
 }
 
+export interface MaterializeLoanRoleTasks {
+  /** @format int32 */
+  rowsAdded: number;
+}
+
 export interface MdmUser {
   user_email?: string | null;
   user_id?: string | null;
@@ -6782,6 +6879,8 @@ export interface Task {
   isGlobal: boolean;
   /** @format uuid */
   id: string;
+  /** @format uuid */
+  sourceTaskID?: string | null;
   user?: User | null;
   isFromLegacySource: boolean;
   usedInBusinessRule: boolean;
@@ -7123,6 +7222,17 @@ 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;
@@ -7524,6 +7634,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 {
@@ -7871,6 +7987,21 @@ export type CreateLoanImportRequestImportModeEnum =
   | "NewOnly"
   | "UpdateOnly";
 
+export type CreateLoanRoleTaskRequestRoleEnum =
+  | "Borrower"
+  | "CoBorrower"
+  | "NonBorrower"
+  | "LoanOfficer"
+  | "LoanProcessor"
+  | "LoanOfficerAssistant"
+  | "SupportingLoanOfficer"
+  | "BuyerAgent"
+  | "SellerAgent"
+  | "TitleInsuranceAgent"
+  | "EscrowAgent"
+  | "SettlementAgent"
+  | "Admin";
+
 export type CreateUserDraftLoanRoleEnum =
   | "Borrower"
   | "CoBorrower"
@@ -8109,6 +8240,12 @@ export type LoanDocumentFolderPermissionRequestLevelEnum =
 
 export type LoanDocumentFolderPermissionRequestReadScopeEnum = "Own" | "All";
 
+export type LoanDocumentFolderWithCountAccessLevelEnum =
+  | "None"
+  | "Read"
+  | "Write"
+  | "Manage";
+
 export type LoanImportStatusEnum =
   | "WaitingProcess"
   | "InProgress"
@@ -8142,7 +8279,8 @@ export type LoanLogTypeEnum =
   | "DocumentClassified"
   | "CoBorrowerEmailAutoFixed"
   | "LosFieldWriteBack"
-  | "ReferrerChangeDiscarded";
+  | "ReferrerChangeDiscarded"
+  | "TaskEdited";
 
 export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
 
@@ -8166,7 +8304,54 @@ export type LoanLogDetailTypeEnum =
   | "DocumentClassified"
   | "CoBorrowerEmailAutoFixed"
   | "LosFieldWriteBack"
-  | "ReferrerChangeDiscarded";
+  | "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"
@@ -8672,7 +8857,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v3.6.0
+ * @version v3.7.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -9197,6 +9382,7 @@ export class Api<
         path: `/api/ai/prompts/${id}/toggle`,
         method: "PATCH",
         secure: true,
+        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -9595,6 +9781,7 @@ export class Api<
         path: `/api/ai/canonical-fields/${id}/toggle`,
         method: "PATCH",
         secure: true,
+        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -9746,7 +9933,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: "application/json",
+        type: ContentType.JsonPatch,
         format: "json",
         ...params,
       }),
@@ -10062,6 +10249,7 @@ export class Api<
         path: `/api/ai/guardrails/${id}/toggle`,
         method: "PATCH",
         secure: true,
+        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -10445,6 +10633,7 @@ export class Api<
         path: `/api/ai/url-sources/${id}/toggle`,
         method: "PATCH",
         secure: true,
+        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -13936,7 +14125,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: "application/json",
+        type: ContentType.JsonPatch,
         format: "json",
         ...params,
       }),
@@ -14046,7 +14235,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: "application/json",
+        type: ContentType.JsonPatch,
         format: "json",
         ...params,
       }),
@@ -14073,7 +14262,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: "application/json",
+        type: ContentType.JsonPatch,
         format: "json",
         ...params,
       }),
@@ -14271,7 +14460,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: "application/json",
+        type: ContentType.JsonPatch,
         format: "json",
         ...params,
       }),
@@ -14351,7 +14540,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: "application/json",
+        type: ContentType.JsonPatch,
         format: "json",
         ...params,
       }),
@@ -15078,7 +15267,7 @@ export class Api<
       }),
 
     /**
-     * @description Returns each folder that holds at least one document the caller can read, with the document count per folder. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID, isUnassigned = true); filter to its documents with searchLoanDocuments folderScope 'Unassigned' rather than by echoing that ID.
+     * @description Returns every folder the caller can access on this loan — including folders holding no documents — with the caller's effective accessLevel and the count of documents they can read in each. Upload destinations are the active entries with accessLevel at least Write. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID, isUnassigned = true); filter to its documents with searchLoanDocuments folderScope 'Unassigned' rather than by echoing that ID.
      *
      * @tags LoanDocumentFoldersForSingleLoan
      * @name ListLoanDocumentFolders
@@ -15183,7 +15372,7 @@ export class Api<
       }),
 
     /**
-     * @description Filters the loan's readable documents. Pass folderID to filter to one folder, or folderScope 'Unassigned' for the documents that have no folder (the synthetic folder listLoanDocumentFolders reports with isUnassigned true); the two cannot be combined.
+     * @description Filters the loan's readable documents. Pass folderID to filter to one folder, or folderScope 'Unassigned' for the documents that have no folder; folderID with the empty GUID listLoanDocumentFolders reports for that synthetic folder selects the same set. folderScope 'Unassigned' cannot be combined with a real folderID. Documents with no folder come back naming the synthetic 'Unassigned' folder.
      *
      * @tags LoanDocuments
      * @name SearchLoanDocuments
@@ -15250,6 +15439,7 @@ export class Api<
      * @request POST:/api/loans/{loanId}/documents
      * @secure
      * @response `201` `LoanDocument` Created
+     * @response `400` `ProblemDetails` Bad Request
      * @response `404` `ProblemDetails` Not Found
      * @response `422` `UnprocessableEntity` Unprocessable Content
      */
@@ -16168,6 +16358,149 @@ export class Api<
         ...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: string, params: RequestParams = {}) =>
+      this.request<LoanRoleSlotTasks[], ProblemDetails>({
+        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: string,
+      data: CreateLoanRoleTaskRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<LoanRoleTask, ProblemDetails>({
+        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: string, id: string, params: RequestParams = {}) =>
+      this.request<LoanRoleTask, ProblemDetails>({
+        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: string,
+      id: string,
+      data: UpdateLoanRoleTaskRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<LoanRoleTask, ProblemDetails>({
+        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: string,
+      id: string,
+      params: RequestParams = {},
+    ) =>
+      this.request<void, ProblemDetails>({
+        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: string, params: RequestParams = {}) =>
+      this.request<MaterializeLoanRoleTasks, ProblemDetails>({
+        path: `/api/loans/${loanId}/role-tasks/materialize`,
+        method: "POST",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -16290,7 +16623,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: "application/json",
+        type: ContentType.Json,
         format: "json",
         ...params,
       }),