@matech/thebigpos-sdk 3.24.0 → 3.25.0-dev-7801

package/package.json

@@ -1,12 +1,19 @@
 {
   "name": "@matech/thebigpos-sdk",
-  "version": "3.24.0",
+  "version": "3.25.0-dev-7801",
   "description": "The Big POS Typescript SDK",
-  "main": "dist/index.js",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "react-native": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "index.js"
+  ],
   "scripts": {
-    "build": "rimraf dist && tsc",
-    "test": "mocha -r ts-node/register 'src/api_test.spec.ts' --exit",
+    "build": "rimraf dist && tsc && esbuild dist/index.js --format=cjs --platform=node --packages=external --sourcemap --outfile=dist/index.cjs",
+    "postbuild": "node -e \"if (typeof require('./').Api !== 'function') { console.error('Smoke check failed: the CommonJS entry does not export Api'); process.exit(1) }\"",
     "browserify": "tsc && esbuild dist/index.js --bundle --minify --sourcemap --global-name=thebigpos --outfile=dist/thebigpos.min.js",
     "prepare": "husky"
   },
@@ -26,15 +33,22 @@
     "url": "https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript/issues"
   },
   "homepage": "https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript#readme",
-  "dependencies": {
-    "axios": "^1.7.7"
+  "engines": {
+    "node": ">=18"
+  },
+  "peerDependencies": {
+    "axios": "^1"
   },
   "devDependencies": {
-    "esbuild": "^0.27.0",
+    "axios": "^1.20.0",
+    "esbuild": "^0.28.1",
     "husky": "^9.1.5",
-    "rimraf": "6.1.1",
-    "ts-node": "^10.9.2",
+    "rimraf": "6.1.3",
     "typescript": "^5.5.4"
   },
-  "swaggerSha256": "224eeb9fbfe774cc390fb25a4a18112127be4908677d123b123c95ce85482730"
+  "resolutions": {
+    "brace-expansion": "^5.0.12",
+    "follow-redirects": "^1.16.1"
+  },
+  "swaggerSha256": "98bd7ebfc4467f265800d08927599de4c7e0e1dbdd51d0eb109c1e74843a2371"
 }

package/src/index.ts

@@ -73,6 +73,8 @@ export type PartnerTier = "Lite" | "LitePlusPortal" | "Pending";
 
 export type OutboundFailureSeverity = "All" | "Failed" | "CompletedWithErrors";
 
+export type MfaFactor = "None" | "Sms" | "Email";
+
 export type LosWebhookSigningKeySyncStatus = "Unknown" | "Synced";
 
 export type LosWebhookInventoryStatus =
@@ -1011,6 +1013,7 @@ export interface AdminAccessUser {
   title?: string | null;
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
+  mfaFactor: AdminAccessUserMfaFactorEnum;
   phoneVerified: boolean;
   /** @format int32 */
   loginsWithoutMFACount: number;
@@ -1890,6 +1893,7 @@ export interface BranchUser {
   title?: string | null;
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
+  mfaFactor: BranchUserMfaFactorEnum;
   phoneVerified: boolean;
   /** @format int32 */
   loginsWithoutMFACount: number;
@@ -2689,6 +2693,7 @@ export interface CustomFieldDefinition {
   regexPattern?: string | null;
   dataType: CustomFieldDefinitionDataTypeEnum;
   entityType: CustomFieldDefinitionEntityTypeEnum;
+  isAiEnabled: boolean;
   options: CustomFieldOption[];
   permissions: CustomFieldPermission[];
   encompassMapping?: EncompassMapping | null;
@@ -2766,6 +2771,7 @@ export interface DetailedUser {
   title?: string | null;
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
+  mfaFactor: DetailedUserMfaFactorEnum;
   phoneVerified: boolean;
   /** @format int32 */
   loginsWithoutMFACount: number;
@@ -3608,6 +3614,7 @@ export interface ImpersonatedDetailedUser {
   title?: string | null;
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
+  mfaFactor: ImpersonatedDetailedUserMfaFactorEnum;
   phoneVerified: boolean;
   /** @format int32 */
   loginsWithoutMFACount: number;
@@ -4009,6 +4016,8 @@ export interface LoanApplicationRequest {
   draftId?: string | null;
   /** @format uuid */
   partnerId?: string | null;
+  /** @format uuid */
+  formId?: string | null;
   additionalFields?: Record<string, any> | null;
   /** @format uuid */
   existingLoanId?: string | null;
@@ -6106,6 +6115,14 @@ export interface MaterializeLoanRoleTasks {
   rowsAdded: number;
 }
 
+export interface MfaMethod {
+  factor: MfaMethodFactorEnum;
+  available: boolean;
+  current: boolean;
+  destination?: string | null;
+  requiresConfirmation: boolean;
+}
+
 export interface MilestoneConfiguration {
   /** @format date-time */
   createdAt: string;
@@ -6519,6 +6536,23 @@ export interface PinAiConversationRequest {
   isPinned: boolean;
 }
 
+export interface PipelineLoanOfficer {
+  /** @format uuid */
+  id: string;
+  firstName: string;
+  lastName: string;
+  email: string;
+  branchName?: string | null;
+  isActive: boolean;
+}
+
+export interface PipelineLoanOfficerPaginated {
+  rows: PipelineLoanOfficer[];
+  pagination: Pagination;
+  /** @format int64 */
+  count: number;
+}
+
 export interface PipelineTableFilters {
   activityStatus?: LoanActivityStatus | null;
   loanPurpose?: LoanPurpose | null;
@@ -8104,6 +8138,11 @@ export interface UpdateMeRequest {
   preferredLoanOfficerId?: string | null;
 }
 
+export interface UpdateMfaFactorRequest {
+  factor?: MfaFactor | null;
+  passwordConfirmation?: string | null;
+}
+
 export interface UpdateMobilePhoneRequest {
   phone: string;
 }
@@ -8315,6 +8354,7 @@ export interface User {
   title?: string | null;
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
+  mfaFactor: UserMfaFactorEnum;
   phoneVerified: boolean;
   /** @format int32 */
   loginsWithoutMFACount: number;
@@ -8503,6 +8543,13 @@ export interface UserLoanTaskUpdateRequest {
   loanDocumentFolderId?: string | null;
 }
 
+export interface UserMfaState {
+  enabled: boolean;
+  factor: UserMfaStateFactorEnum;
+  required: boolean;
+  methods: MfaMethod[];
+}
+
 export interface UserMobilePhoneVerificationRequest {
   code: string;
 }
@@ -8707,6 +8754,8 @@ type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
 
 export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
 
+export type AdminAccessUserMfaFactorEnum = "None" | "Sms" | "Email";
+
 export type AiAuditLogEventTypeEnum =
   | "Error"
   | "GuardrailBlockedPre"
@@ -8828,6 +8877,8 @@ export type BorrowerIdentityRoleEnum =
   | "SettlementAgent"
   | "Admin";
 
+export type BranchUserMfaFactorEnum = "None" | "Sms" | "Email";
+
 export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
 
 export type CanvasFieldDescriptorDataTypeEnum =
@@ -9127,6 +9178,8 @@ export type CustomFieldValueDataTypeEnum =
   | "SingleSelect"
   | "MultiSelect";
 
+export type DetailedUserMfaFactorEnum = "None" | "Sms" | "Email";
+
 export type DocumentsWidgetConfigTypeEnum = "Documents";
 
 export type DraftTypeEnum = "NewLoan" | "EditLoan";
@@ -9213,6 +9266,8 @@ export type IpAddressAddressFamilyEnum =
   | "ControllerAreaNetwork"
   | "Unknown";
 
+export type ImpersonatedDetailedUserMfaFactorEnum = "None" | "Sms" | "Email";
+
 export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
 
 export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
@@ -9584,6 +9639,8 @@ export type ManualDocumentClassificationRequestDocumentTypeEnum =
   | "AiGeneratedDocument"
   | "Unidentified";
 
+export type MfaMethodFactorEnum = "None" | "Sms" | "Email";
+
 export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
 
 export type MyPartnerTierEnum = "Lite" | "LitePlusPortal" | "Pending";
@@ -9710,6 +9767,8 @@ export type UpdateAiUrlSourceRequestCategoryEnum =
 
 export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
 
+export type UserMfaFactorEnum = "None" | "Sms" | "Email";
+
 export type UserDraftRoleEnum =
   | "Borrower"
   | "CoBorrower"
@@ -9763,6 +9822,8 @@ export type UserLoanConsentLosSyncStatusEnum =
   | "Failed"
   | "Success";
 
+export type UserMfaStateFactorEnum = "None" | "Sms" | "Email";
+
 export type UserTableSettingsTableKeyEnum = "Pipeline";
 
 export type UserTableViewTableKeyEnum = "Pipeline";
@@ -10001,7 +10062,15 @@ export class HttpClient<SecurityDataType = unknown> {
         property instanceof Array ? property : [property];
 
       for (const formItem of propertyContent) {
-        const isFileType = formItem instanceof Blob || formItem instanceof File;
+        // 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;
         formData.append(
           key,
           isFileType ? formItem : this.stringifyFormItem(formItem),
@@ -10063,7 +10132,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v3.24.0
+ * @version v3.25.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -18184,6 +18253,41 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags Loans
+     * @name SearchPipelineLoanOfficers
+     * @summary Search the loan officers of the caller's pipeline
+     * @request POST:/api/loans/loan-officers/search
+     * @secure
+     * @response `200` `PipelineLoanOfficerPaginated` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `403` `ProblemDetails` Forbidden
+     */
+    searchPipelineLoanOfficers: (
+      data: SearchCriteria,
+      query?: {
+        /** @format int32 */
+        pageSize?: number;
+        /** @format int32 */
+        pageNumber?: number;
+        sortBy?: string;
+        sortDirection?: string;
+      },
+      params: RequestParams = {},
+    ) =>
+      this.request<PipelineLoanOfficerPaginated, ProblemDetails>({
+        path: `/api/loans/loan-officers/search`,
+        method: "POST",
+        query: query,
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -22456,6 +22560,35 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags Users
+     * @name ClearUserMfa
+     * @summary Clear MFA
+     * @request PUT:/api/users/{id}/mfa
+     * @secure
+     * @response `200` `UserMfaState` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `422` `UnprocessableEntity` Unprocessable Content
+     */
+    clearUserMfa: (
+      id: string,
+      data: UpdateMfaFactorRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<UserMfaState, ProblemDetails | UnprocessableEntity>({
+        path: `/api/users/${id}/mfa`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -22882,6 +23015,51 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags UsersMeMfa
+     * @name GetMyMfa
+     * @summary Get MFA
+     * @request GET:/api/users/me/mfa
+     * @secure
+     * @response `200` `UserMfaState` OK
+     * @response `401` `ProblemDetails` Unauthorized
+     */
+    getMyMfa: (params: RequestParams = {}) =>
+      this.request<UserMfaState, ProblemDetails>({
+        path: `/api/users/me/mfa`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags UsersMeMfa
+     * @name UpdateMyMfa
+     * @summary Update MFA
+     * @request PUT:/api/users/me/mfa
+     * @secure
+     * @response `200` `UserMfaState` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `401` `ProblemDetails` Unauthorized
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `422` `UnprocessableEntity` Unprocessable Content
+     */
+    updateMyMfa: (data: UpdateMfaFactorRequest, params: RequestParams = {}) =>
+      this.request<UserMfaState, ProblemDetails | UnprocessableEntity>({
+        path: `/api/users/me/mfa`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *

package/.husky/pre-commit

@@ -1,3 +0,0 @@
-[ -f ./src/index.ts ] && node scripts/apply-json-patch-content-type.js
-yarn build
-git add .

package/scripts/apply-json-patch-content-type.js

@@ -1,56 +0,0 @@
-/* 
-  This script is meant to run after the SDK has been generated.
-
-  - It updates the generated code to ensure that all PATCH methods use ContentType.JsonPatch.
-  - It also ensures that the ContentType enum includes JsonPatch and modifies the Operation interface
-    to allow any value for the `value` property instead of just object or null.
-
-  This is necessary because the SDK generation does not currently handle these cases correctly.
-*/
-
-const fs = require('fs')
-
-const path = require('path').resolve(__dirname, '../src/index.ts')
-
-if (!fs.existsSync(path)) {
-	console.error(`Error: File not found at path "${path}". Please ensure the SDK has been generated.`)
-	process.exit(1)
-}
-let content
-try {
-	content = fs.readFileSync(path, 'utf8')
-} catch (err) {
-	console.error(`Error: Unable to read file at path "${path}". Details: ${err.message}`)
-	process.exit(1)
-}
-
-// Update PATCH methods to use ContentType.JsonPatch
-content = content.replace(
-	/(method:\s*"PATCH"[\s\S]+?)type:\s*ContentType\.Json/g,
-	(match) => match.replace('ContentType.Json', 'ContentType.JsonPatch')
-)
-
-// Ensure JsonPatch is included in the ContentType enum
-content = content.replace(
-	/export enum ContentType\s*{([\s\S]*?)}/,
-	(match, enumBody) => {
-		if (enumBody.includes('JsonPatch')) return match
-		const insertion = `  JsonPatch = "application/json-patch+json",\n  `
-		return `export enum ContentType {\n${insertion}${enumBody.trim()}\n}`
-	}
-)
-
-// Fix the Operation interface to allow any value
-content = content.replace(
-	/export interface Operation\s*{([\s\S]*?)}/,
-	(match, body) => {
-		const updated = body.replace(
-			/value\?:\s*object\s*\|?\s*null?;/,
-			'value?: string | number | boolean | null | object;'
-		)
-		return `export interface Operation {\n  ${updated.trim()}\n}`
-	}
-)
-
-fs.writeFileSync(path, content)
-console.log('SDK patch complete: All PATCH methods now use ContentType.JsonPatch.')

package/tsconfig.json

@@ -1,27 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es6",
-    "module": "esnext",
-    "allowJs": true,
-    "sourceMap": true,
-    "outDir": "./dist",
-    "strict": true,
-    "moduleResolution": "node",
-    "baseUrl": "./",
-    "declaration": true,
-    "paths": {
-      "*": [
-        "node_modules/*"
-      ]
-    },
-    "typeRoots": [
-      "./node_modules/@types"
-    ],
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true
-  },
-  "include": ["./src/**/*"],
-  "exclude": ["./dist"]
-}