@matech/thebigpos-sdk 3.25.0 → 3.26.0-dev-8210

package/package.json

@@ -1,12 +1,19 @@
 {
   "name": "@matech/thebigpos-sdk",
-  "version": "3.25.0",
+  "version": "3.26.0-dev-8210",
   "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": "8d46ae2f24b2203c1a1582793642cb7426e0d46a96c47900086703f539710607"
+  "resolutions": {
+    "brace-expansion": "^5.0.12",
+    "follow-redirects": "^1.16.1"
+  },
+  "swaggerSha256": "aa916a037dfde882eb528060fe1a4d9c81e9f2339cde16e1f35f50c39214bd46"
 }

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 =
@@ -722,6 +724,8 @@ export type AiPromptCategory =
   | "General"
   | "Action";
 
+export type AiPendingLoanUpdateOutcome = "Applied" | "Refused";
+
 export type AiGuardrailCategory =
   | "ContentSafety"
   | "PromptInjection"
@@ -735,6 +739,8 @@ export type AiDisplayHint =
   | "Comparison"
   | "ExecutiveBrief";
 
+export type AiChatInputSource = "Keyboard" | "Prompt" | "Action" | "Voice";
+
 export type AiAuditEventType =
   | "Error"
   | "GuardrailBlockedPre"
@@ -1011,6 +1017,7 @@ export interface AdminAccessUser {
   title?: string | null;
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
+  mfaFactor: AdminAccessUserMfaFactorEnum;
   phoneVerified: boolean;
   /** @format int32 */
   loginsWithoutMFACount: number;
@@ -1224,6 +1231,7 @@ export interface AiChatMessage {
   assistantResponse: string;
   fieldsAccessed?: string[] | null;
   data: AiChatStructuredData[];
+  source?: AiChatInputSource | null;
   /** @format date-time */
   createdAt: string;
 }
@@ -1247,6 +1255,7 @@ export interface AiChatMetadata {
   wasBlocked: boolean;
   blockedReason?: string | null;
   tokenBudget?: AiTokenBudgetStatus | null;
+  pendingLoanUpdateDecision?: AiPendingLoanUpdateDecision | null;
 }
 
 export interface AiChatRequest {
@@ -1260,6 +1269,7 @@ export interface AiChatRequest {
   promptId?: string | null;
   /** @format uuid */
   pendingLoanUpdateId?: string | null;
+  source?: AiChatInputSource | null;
 }
 
 export interface AiChatStructuredData {
@@ -1312,6 +1322,9 @@ export interface AiConversationAuditSummary {
   userName?: string | null;
   userRole?: string | null;
   name?: string | null;
+  /** @format uuid */
+  loanId?: string | null;
+  loanNumber?: string | null;
   /** @format int32 */
   turnCount: number;
   /** @format int32 */
@@ -1397,6 +1410,13 @@ export interface AiGuardrail {
   updatedBy?: AiUpdatedBy | null;
 }
 
+export interface AiPendingLoanUpdateDecision {
+  /** @format uuid */
+  pendingLoanUpdateId: string;
+  outcome: AiPendingLoanUpdateDecisionOutcomeEnum;
+  reason?: string | null;
+}
+
 export interface AiPrompt {
   /** @format uuid */
   id: string;
@@ -1890,6 +1910,7 @@ export interface BranchUser {
   title?: string | null;
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
+  mfaFactor: BranchUserMfaFactorEnum;
   phoneVerified: boolean;
   /** @format int32 */
   loginsWithoutMFACount: number;
@@ -2362,6 +2383,10 @@ export interface ConditionComment {
   createdByName: string;
 }
 
+export interface ConfirmMfaEnrollmentRequest {
+  code: string;
+}
+
 export interface ConsumerConnectRetry {
   correlationKey: string;
   email: string;
@@ -2767,6 +2792,7 @@ export interface DetailedUser {
   title?: string | null;
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
+  mfaFactor: DetailedUserMfaFactorEnum;
   phoneVerified: boolean;
   /** @format int32 */
   loginsWithoutMFACount: number;
@@ -3009,7 +3035,6 @@ export interface EnabledServices {
   spanishPrequal?: boolean | null;
   spanishFullApp?: boolean | null;
   prequalLetter?: boolean | null;
-  payments?: boolean | null;
   leadApp?: boolean | null;
   documents?: boolean | null;
   loanCalculator?: boolean | null;
@@ -3609,6 +3634,7 @@ export interface ImpersonatedDetailedUser {
   title?: string | null;
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
+  mfaFactor: ImpersonatedDetailedUserMfaFactorEnum;
   phoneVerified: boolean;
   /** @format int32 */
   loginsWithoutMFACount: number;
@@ -6109,6 +6135,23 @@ export interface MaterializeLoanRoleTasks {
   rowsAdded: number;
 }
 
+export interface MfaEnrollment {
+  enrollmentId: string;
+  factor: MfaEnrollmentFactorEnum;
+  destination?: string | null;
+  /** @format int32 */
+  expiresInSeconds: number;
+  canResend: boolean;
+}
+
+export interface MfaMethod {
+  factor: MfaMethodFactorEnum;
+  available: boolean;
+  current: boolean;
+  destination?: string | null;
+  requiresConfirmation: boolean;
+}
+
 export interface MilestoneConfiguration {
   /** @format date-time */
   createdAt: string;
@@ -6766,6 +6809,10 @@ export interface RequestImpersonationRequest {
   email: string;
 }
 
+export interface ResendChallengeCodeRequest {
+  sessionId: string;
+}
+
 export interface ResetPasswordRequest {
   token: string;
   password: string;
@@ -7702,6 +7749,10 @@ export interface StandardLoanField {
   isAiEnabled: boolean;
 }
 
+export interface StartMfaEnrollmentRequest {
+  factor?: MfaFactor | null;
+}
+
 export interface SupportedModel {
   modelId: string;
   displayName: string;
@@ -8124,6 +8175,11 @@ export interface UpdateMeRequest {
   preferredLoanOfficerId?: string | null;
 }
 
+export interface UpdateMfaFactorRequest {
+  factor?: MfaFactor | null;
+  passwordConfirmation?: string | null;
+}
+
 export interface UpdateMobilePhoneRequest {
   phone: string;
 }
@@ -8335,6 +8391,7 @@ export interface User {
   title?: string | null;
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
+  mfaFactor: UserMfaFactorEnum;
   phoneVerified: boolean;
   /** @format int32 */
   loginsWithoutMFACount: number;
@@ -8523,6 +8580,13 @@ export interface UserLoanTaskUpdateRequest {
   loanDocumentFolderId?: string | null;
 }
 
+export interface UserMfaState {
+  enabled: boolean;
+  factor: UserMfaStateFactorEnum;
+  required: boolean;
+  methods: MfaMethod[];
+}
+
 export interface UserMobilePhoneVerificationRequest {
   code: string;
 }
@@ -8727,6 +8791,8 @@ type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
 
 export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
 
+export type AdminAccessUserMfaFactorEnum = "None" | "Sms" | "Email";
+
 export type AiAuditLogEventTypeEnum =
   | "Error"
   | "GuardrailBlockedPre"
@@ -8785,6 +8851,8 @@ export type AiGuardrailCategoryEnum =
   | "Privacy"
   | "Legal";
 
+export type AiPendingLoanUpdateDecisionOutcomeEnum = "Applied" | "Refused";
+
 export type AiUrlSourceCategoryEnum =
   | "Regulatory"
   | "Guidelines"
@@ -8848,6 +8916,8 @@ export type BorrowerIdentityRoleEnum =
   | "SettlementAgent"
   | "Admin";
 
+export type BranchUserMfaFactorEnum = "None" | "Sms" | "Email";
+
 export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
 
 export type CanvasFieldDescriptorDataTypeEnum =
@@ -9147,6 +9217,8 @@ export type CustomFieldValueDataTypeEnum =
   | "SingleSelect"
   | "MultiSelect";
 
+export type DetailedUserMfaFactorEnum = "None" | "Sms" | "Email";
+
 export type DocumentsWidgetConfigTypeEnum = "Documents";
 
 export type DraftTypeEnum = "NewLoan" | "EditLoan";
@@ -9233,6 +9305,8 @@ export type IpAddressAddressFamilyEnum =
   | "ControllerAreaNetwork"
   | "Unknown";
 
+export type ImpersonatedDetailedUserMfaFactorEnum = "None" | "Sms" | "Email";
+
 export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
 
 export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
@@ -9604,6 +9678,10 @@ export type ManualDocumentClassificationRequestDocumentTypeEnum =
   | "AiGeneratedDocument"
   | "Unidentified";
 
+export type MfaEnrollmentFactorEnum = "None" | "Sms" | "Email";
+
+export type MfaMethodFactorEnum = "None" | "Sms" | "Email";
+
 export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
 
 export type MyPartnerTierEnum = "Lite" | "LitePlusPortal" | "Pending";
@@ -9730,6 +9808,8 @@ export type UpdateAiUrlSourceRequestCategoryEnum =
 
 export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
 
+export type UserMfaFactorEnum = "None" | "Sms" | "Email";
+
 export type UserDraftRoleEnum =
   | "Borrower"
   | "CoBorrower"
@@ -9783,6 +9863,8 @@ export type UserLoanConsentLosSyncStatusEnum =
   | "Failed"
   | "Success";
 
+export type UserMfaStateFactorEnum = "None" | "Sms" | "Email";
+
 export type UserTableSettingsTableKeyEnum = "Pipeline";
 
 export type UserTableViewTableKeyEnum = "Pipeline";
@@ -10021,7 +10103,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),
@@ -10083,7 +10173,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v3.25.0
+ * @version v3.26.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -10778,11 +10868,11 @@ export class Api<
       }),
 
     /**
-     * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
+     * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59. searchText matches a case-insensitive substring of the originating user's name or email, the conversation name or the loan number, or an exact conversation, request or user id.
      *
      * @tags AiAudit
      * @name GetAiAuditConversations
-     * @summary List conversations with their audit roll-up — origin user, turns, status, tokens
+     * @summary List conversations with their audit roll-up — origin user, loan, turns, status, tokens
      * @request GET:/api/ai/audit-conversations
      * @secure
      * @response `200` `AiConversationAuditSummaryPaginated` OK
@@ -10908,6 +10998,30 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags AiChat
+     * @name RejectAiPendingLoanUpdate
+     * @summary Reject a pending AI loan change so a new one can be proposed
+     * @request POST:/api/ai/chats/pending-loan-updates/{pendingLoanUpdateId}/reject
+     * @secure
+     * @response `204` `void` No Content
+     * @response `401` `ProblemDetails` Unauthorized
+     * @response `404` `ProblemDetails` Not Found
+     * @response `429` `ProblemDetails` Too Many Requests
+     */
+    rejectAiPendingLoanUpdate: (
+      pendingLoanUpdateId: string,
+      params: RequestParams = {},
+    ) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/ai/chats/pending-loan-updates/${pendingLoanUpdateId}/reject`,
+        method: "POST",
+        secure: true,
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -11405,6 +11519,36 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags AiPromptRun
+     * @name RerunAiPromptRun
+     * @summary Re-run the AI verification bound to a loan task
+     * @request POST:/api/ai/prompt-runs/rerun
+     * @secure
+     * @response `202` `void` Accepted
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     * @response `429` `ProblemDetails` Too Many Requests
+     * @response `503` `void` Service Unavailable
+     */
+    rerunAiPromptRun: (
+      query?: {
+        /** @format uuid */
+        subjectEntityId?: string;
+      },
+      params: RequestParams = {},
+    ) =>
+      this.request<void, ProblemDetails | void>({
+        path: `/api/ai/prompt-runs/rerun`,
+        method: "POST",
+        query: query,
+        secure: true,
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -12108,9 +12252,14 @@ export class Api<
      * @secure
      * @response `200` `UserDeactivated` OK
      * @response `422` `UnprocessableEntity` Unprocessable Content
+     * @response `429` `ProblemDetails` Too Many Requests
+     * @response `503` `void` Service Unavailable
      */
     getToken: (data: TokenRequest, params: RequestParams = {}) =>
-      this.request<UserDeactivated, UnprocessableEntity>({
+      this.request<
+        UserDeactivated,
+        UnprocessableEntity | ProblemDetails | void
+      >({
         path: `/api/token`,
         method: "POST",
         body: data,
@@ -12129,13 +12278,15 @@ export class Api<
      * @request POST:/api/token/code
      * @secure
      * @response `200` `UserDeactivated` OK
+     * @response `400` `ProblemDetails` Bad Request
      * @response `422` `UnprocessableEntity` Unprocessable Content
+     * @response `429` `ProblemDetails` Too Many Requests
      */
     getTokenFromChallengeCode: (
       data: TokenChallengeRequest,
       params: RequestParams = {},
     ) =>
-      this.request<UserDeactivated, UnprocessableEntity>({
+      this.request<UserDeactivated, ProblemDetails | UnprocessableEntity>({
         path: `/api/token/code`,
         method: "POST",
         body: data,
@@ -12145,6 +12296,32 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags Authentication
+     * @name ResendChallengeCode
+     * @summary Resend Challenge Code
+     * @request POST:/api/token/code/resend
+     * @secure
+     * @response `204` `void` No Content
+     * @response `422` `UnprocessableEntity` Unprocessable Content
+     * @response `429` `ProblemDetails` Too Many Requests
+     * @response `503` `void` Service Unavailable
+     */
+    resendChallengeCode: (
+      data: ResendChallengeCodeRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<void, UnprocessableEntity | ProblemDetails | void>({
+        path: `/api/token/code/resend`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: "application/json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -22511,6 +22688,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
      *
@@ -22937,6 +23143,136 @@ 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
+     *
+     * @tags UsersMeMfa
+     * @name StartMyMfaEnrollment
+     * @summary Start MFA Enrollment
+     * @request POST:/api/users/me/mfa/enrollments
+     * @secure
+     * @response `200` `MfaEnrollment` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `401` `ProblemDetails` Unauthorized
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `422` `UnprocessableEntity` Unprocessable Content
+     * @response `429` `ProblemDetails` Too Many Requests
+     * @response `503` `void` Service Unavailable
+     */
+    startMyMfaEnrollment: (
+      data: StartMfaEnrollmentRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<MfaEnrollment, ProblemDetails | UnprocessableEntity | void>({
+        path: `/api/users/me/mfa/enrollments`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags UsersMeMfa
+     * @name ConfirmMyMfaEnrollment
+     * @summary Confirm MFA Enrollment
+     * @request POST:/api/users/me/mfa/enrollments/{enrollmentId}/confirm
+     * @secure
+     * @response `200` `UserMfaState` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `401` `ProblemDetails` Unauthorized
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `422` `UnprocessableEntity` Unprocessable Content
+     * @response `429` `ProblemDetails` Too Many Requests
+     */
+    confirmMyMfaEnrollment: (
+      enrollmentId: string,
+      data: ConfirmMfaEnrollmentRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<UserMfaState, ProblemDetails | UnprocessableEntity>({
+        path: `/api/users/me/mfa/enrollments/${enrollmentId}/confirm`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags UsersMeMfa
+     * @name ResendMyMfaEnrollmentCode
+     * @summary Resend MFA Enrollment Code
+     * @request POST:/api/users/me/mfa/enrollments/{enrollmentId}/resend
+     * @secure
+     * @response `204` `void` No Content
+     * @response `401` `ProblemDetails` Unauthorized
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `429` `ProblemDetails` Too Many Requests
+     * @response `503` `void` Service Unavailable
+     */
+    resendMyMfaEnrollmentCode: (
+      enrollmentId: string,
+      params: RequestParams = {},
+    ) =>
+      this.request<void, ProblemDetails | void>({
+        path: `/api/users/me/mfa/enrollments/${enrollmentId}/resend`,
+        method: "POST",
+        secure: true,
+        ...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 .