@matech/thebigpos-sdk 3.7.0 → 3.8.0-stag-3544

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"
@@ -270,7 +286,8 @@ export type LoanLogType =
   | "DocumentClassified"
   | "CoBorrowerEmailAutoFixed"
   | "LosFieldWriteBack"
-  | "ReferrerChangeDiscarded";
+  | "ReferrerChangeDiscarded"
+  | "TaskEdited";
 
 export type LoanLienPosition = "First" | "Subordinate";
 
@@ -647,7 +664,8 @@ export type AiAuditEventType =
   | "LoanUpdateProposed"
   | "LoanUpdateApplied"
   | "LoanUpdateRefused"
-  | "PromptTriggerCoalesced";
+  | "PromptTriggerCoalesced"
+  | "RecommendationRunCompleted";
 
 export type AddressFamily =
   | "Unspecified"
@@ -2124,6 +2142,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;
@@ -2577,6 +2605,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;
@@ -5006,6 +5035,25 @@ export interface LoanQueueWithData {
   data?: any | null;
 }
 
+export interface LoanRecommendation {
+  /** @format uuid */
+  id: string;
+  canonicalName: string;
+  displayName: string;
+  extractedValue: string;
+  currentLoanValue?: any | null;
+  /** @format uuid */
+  sourceDocumentId: string;
+  sourceDocumentName?: string | null;
+  /** @format float */
+  confidence: number;
+  /** @format uuid */
+  borrowerId?: string | null;
+  borrowerName?: string | null;
+  /** @format date-time */
+  detectedAt: string;
+}
+
 export interface LoanRecord {
   loanGuid: string;
   loanFields: Record<string, string>;
@@ -5059,6 +5107,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;
@@ -5087,6 +5183,7 @@ export interface LoanSearchCriteria {
   closingFrom?: string | null;
   /** @format date */
   closingTo?: string | null;
+  milestoneConfigurationIds?: string[] | null;
 }
 
 export interface LoanSettings {
@@ -5422,6 +5519,11 @@ export interface ManualDocumentClassificationRequest {
   documentType: ManualDocumentClassificationRequestDocumentTypeEnum;
 }
 
+export interface MaterializeLoanRoleTasks {
+  /** @format int32 */
+  rowsAdded: number;
+}
+
 export interface MdmUser {
   user_email?: string | null;
   user_id?: string | null;
@@ -6855,6 +6957,8 @@ export interface Task {
   isGlobal: boolean;
   /** @format uuid */
   id: string;
+  /** @format uuid */
+  sourceTaskID?: string | null;
   user?: User | null;
   isFromLegacySource: boolean;
   usedInBusinessRule: boolean;
@@ -7212,6 +7316,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;
@@ -7613,6 +7728,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 {
@@ -7818,7 +7939,8 @@ export type AiAuditLogEventTypeEnum =
   | "LoanUpdateProposed"
   | "LoanUpdateApplied"
   | "LoanUpdateRefused"
-  | "PromptTriggerCoalesced";
+  | "PromptTriggerCoalesced"
+  | "RecommendationRunCompleted";
 
 export type AiChatStructuredDataTypeEnum =
   | "Table"
@@ -7961,6 +8083,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"
@@ -8238,7 +8375,8 @@ export type LoanLogTypeEnum =
   | "DocumentClassified"
   | "CoBorrowerEmailAutoFixed"
   | "LosFieldWriteBack"
-  | "ReferrerChangeDiscarded";
+  | "ReferrerChangeDiscarded"
+  | "TaskEdited";
 
 export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
 
@@ -8262,7 +8400,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"
@@ -8698,15 +8883,7 @@ export class HttpClient<SecurityDataType = unknown> {
         property instanceof Array ? property : [property];
 
       for (const formItem of propertyContent) {
-        // React Native files are plain { uri, name, type } objects, not Blob/File.
-        const isReactNativeFile =
-          !!formItem &&
-          typeof formItem === "object" &&
-          "uri" in formItem &&
-          "name" in formItem &&
-          "type" in formItem;
-        const isFileType =
-          isReactNativeFile || formItem instanceof Blob || formItem instanceof File;
+        const isFileType = formItem instanceof Blob || formItem instanceof File;
         formData.append(
           key,
           isFileType ? formItem : this.stringifyFormItem(formItem),
@@ -8768,7 +8945,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v3.7.0
+ * @version v3.8.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -16265,6 +16442,194 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags LoanRecommendations
+     * @name GetLoanRecommendations
+     * @summary Get a loan's open recommendations
+     * @request GET:/api/loans/{loanId}/recommendations
+     * @secure
+     * @response `200` `(LoanRecommendation)[]` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `404` `ProblemDetails` Not Found
+     */
+    getLoanRecommendations: (loanId: string, params: RequestParams = {}) =>
+      this.request<LoanRecommendation[], ProblemDetails>({
+        path: `/api/loans/${loanId}/recommendations`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags LoanRecommendations
+     * @name DismissLoanRecommendation
+     * @summary Dismiss a loan recommendation
+     * @request POST:/api/loans/{loanId}/recommendations/{id}/dismiss
+     * @secure
+     * @response `204` `void` No Content
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `404` `ProblemDetails` Not Found
+     */
+    dismissLoanRecommendation: (
+      loanId: string,
+      id: string,
+      params: RequestParams = {},
+    ) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/loans/${loanId}/recommendations/${id}/dismiss`,
+        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: 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
      *
@@ -17075,6 +17440,7 @@ export class Api<
      * @request POST:/api/loans/{loanId}/users/{userId}
      * @secure
      * @response `201` `LoanUser` Created
+     * @response `404` `ProblemDetails` Not Found
      */
     addLoanUser: (
       loanId: string,
@@ -17082,7 +17448,7 @@ export class Api<
       data: CreateUserLoan,
       params: RequestParams = {},
     ) =>
-      this.request<LoanUser, any>({
+      this.request<LoanUser, ProblemDetails>({
         path: `/api/loans/${loanId}/users/${userId}`,
         method: "POST",
         body: data,

package/docs/sdk_generation.md

@@ -1,149 +0,0 @@
-# Publishing the POS Typescript SDK
-
-## Prerequisites
-
-1. Clone the repository (if you haven't already):
-
-```bash
-git clone https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript
-cd thebigpos-sdk-typescript
-```
-
-2. Install swagger-typescript-api globally:
-
-```bash
-npm i -g swagger-typescript-api
-```
-
-3. Connect to the MAT VPN
-
-## Step 1: Create a release branch
-
-Create a new branch for the version you're releasing:
-
-```bash
-git checkout develop
-git pull origin develop
-git checkout -b release/X.Y.Z
-```
-
-## Step 2: Generate the SDK
-
-Replace `{version}` with the target API version (e.g., `v2.31.0`):
-
-```bash
-npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/{version}/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --generate-union-enums
-```
-
-> **Note:** If generating locally, use `http://localhost:5212/swagger/{version}/swagger.json` due to self-signed cert issues with https.
-
-## Step 3: Apply post-generation fixes
-
-Run the script to fix PATCH methods content type and Operation interface:
-
-```bash
-node scripts/apply-json-patch-content-type.js
-```
-
-This script:
-- Sets all PATCH methods to use `ContentType.JsonPatch`
-- Adds `JsonPatch` to the `ContentType` enum
-- Fixes the `Operation` interface to allow any value type
-
-## Step 4: Update the version
-
-Use npm's version command to update the version in `package.json`:
-
-```bash
-npm version X.Y.Z
-```
-
-**Version conventions:**
-
-- Match the SDK version to the API version being released
-- For release candidates (pre-release), use: `npm version X.Y.Z-rc.N --preid=rc`
-- For patch increments: `npm version patch`
-- For minor increments: `npm version minor`
-
-## Step 5: Build the SDK
-
-```bash
-npm run build
-```
-
-Ensure there are no TypeScript compilation errors.
-
-## Step 6: Merge develop (if needed)
-
-If there are changes in develop that need to be included:
-
-```bash
-git fetch origin develop
-git merge origin/develop
-```
-
-If there are conflicts in `src/index.ts` or `dist/*`, regenerate the SDK (Step 2), apply fixes (Step 3), and rebuild (Step 5) to resolve them.
-
-## Step 7: Commit and push
-
-```bash
-git add .
-git commit -m "X.Y.Z"
-git push -u origin release/X.Y.Z
-```
-
-## Step 8: Publish to NPM
-
-### Authentication
-
-NPM requires a granular access token with publish permissions and 2FA bypass enabled.
-
-1. Go to [npmjs.com](https://www.npmjs.com) > Access Tokens > Generate New Token
-2. Select "Granular Access Token"
-3. Enable "Bypass 2FA for automation"
-4. Set permissions to publish to `@matech/thebigpos-sdk`
-
-Configure the token:
-
-```bash
-npm config set //registry.npmjs.org/:_authToken YOUR_TOKEN
-```
-
-### Publish
-
-**To latest (stable release):**
-
-```bash
-npm publish --access public
-```
-
-**To next (pre-release):**
-
-```bash
-npm publish --tag next
-```
-
-**To a feature tag (for testing):**
-
-```bash
-npm publish --tag feature-name
-```
-
-### Installing the SDK
-
-```bash
-# Latest stable
-yarn add @matech/thebigpos-sdk
-
-# Next pre-release
-yarn add @matech/thebigpos-sdk@next
-
-# Specific version
-yarn add @matech/thebigpos-sdk@X.Y.Z
-```
-
-## Step 9: Clean up
-
-1. **Revoke the NPM token** after publishing for security
-2. **Create a Pull Request** from `release/X.Y.Z` to `develop` and `main`
-3. **Create a GitHub Release** with release notes