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

package/dist/index.d.ts

@@ -12,6 +12,7 @@ export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
 export type PendingInviteStatus = "InvitePending" | "InviteExpired" | "NotInvited";
 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 = "Unknown" | "Healthy" | "Disabled" | "Missing";
 export type LosWebhookEntryStatus = "Registered" | "Disabled" | "Missing" | "Extra";
@@ -272,6 +273,7 @@ export interface AdminAccessUser {
     title?: string | null;
     forcePasswordReset: boolean;
     mfaEnabled: boolean;
+    mfaFactor: AdminAccessUserMfaFactorEnum;
     phoneVerified: boolean;
     /** @format int32 */
     loginsWithoutMFACount: number;
@@ -1081,6 +1083,7 @@ export interface BranchUser {
     title?: string | null;
     forcePasswordReset: boolean;
     mfaEnabled: boolean;
+    mfaFactor: BranchUserMfaFactorEnum;
     phoneVerified: boolean;
     /** @format int32 */
     loginsWithoutMFACount: number;
@@ -1763,6 +1766,7 @@ export interface CustomFieldDefinition {
     regexPattern?: string | null;
     dataType: CustomFieldDefinitionDataTypeEnum;
     entityType: CustomFieldDefinitionEntityTypeEnum;
+    isAiEnabled: boolean;
     options: CustomFieldOption[];
     permissions: CustomFieldPermission[];
     encompassMapping?: EncompassMapping | null;
@@ -1832,6 +1836,7 @@ export interface DetailedUser {
     title?: string | null;
     forcePasswordReset: boolean;
     mfaEnabled: boolean;
+    mfaFactor: DetailedUserMfaFactorEnum;
     phoneVerified: boolean;
     /** @format int32 */
     loginsWithoutMFACount: number;
@@ -2595,6 +2600,7 @@ export interface ImpersonatedDetailedUser {
     title?: string | null;
     forcePasswordReset: boolean;
     mfaEnabled: boolean;
+    mfaFactor: ImpersonatedDetailedUserMfaFactorEnum;
     phoneVerified: boolean;
     /** @format int32 */
     loginsWithoutMFACount: number;
@@ -2960,6 +2966,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;
@@ -4877,6 +4885,13 @@ export interface MaterializeLoanRoleTasks {
     /** @format int32 */
     rowsAdded: number;
 }
+export interface MfaMethod {
+    factor: MfaMethodFactorEnum;
+    available: boolean;
+    current: boolean;
+    destination?: string | null;
+    requiresConfirmation: boolean;
+}
 export interface MilestoneConfiguration {
     /** @format date-time */
     createdAt: string;
@@ -5243,6 +5258,21 @@ export interface PendingTasksSummary {
 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;
@@ -6712,6 +6742,10 @@ export interface UpdateMeRequest {
     /** @format uuid */
     preferredLoanOfficerId?: string | null;
 }
+export interface UpdateMfaFactorRequest {
+    factor?: MfaFactor | null;
+    passwordConfirmation?: string | null;
+}
 export interface UpdateMobilePhoneRequest {
     phone: string;
 }
@@ -6909,6 +6943,7 @@ export interface User {
     title?: string | null;
     forcePasswordReset: boolean;
     mfaEnabled: boolean;
+    mfaFactor: UserMfaFactorEnum;
     phoneVerified: boolean;
     /** @format int32 */
     loginsWithoutMFACount: number;
@@ -7079,6 +7114,12 @@ export interface UserLoanTaskUpdateRequest {
     /** @format uuid */
     loanDocumentFolderId?: string | null;
 }
+export interface UserMfaState {
+    enabled: boolean;
+    factor: UserMfaStateFactorEnum;
+    required: boolean;
+    methods: MfaMethod[];
+}
 export interface UserMobilePhoneVerificationRequest {
     code: string;
 }
@@ -7261,6 +7302,7 @@ type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
     type: Key;
 } & Type;
 export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
+export type AdminAccessUserMfaFactorEnum = "None" | "Sms" | "Email";
 export type AiAuditLogEventTypeEnum = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved" | "PromptResolutionFailed" | "PromptTriggerPublished" | "PromptTriggerSkipped" | "PromptRunCompleted" | "LoanUpdateProposed" | "LoanUpdateApplied" | "LoanUpdateRefused" | "PromptTriggerCoalesced" | "RecommendationRunCompleted" | "BoundPromptForced";
 export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages" | "PendingLoanUpdate";
 export type AiCitedDocumentSourceTypeEnum = "File" | "FreeText";
@@ -7274,6 +7316,7 @@ export type BorrowerApplicationApplicationStatusEnum = "Draft" | "Complete";
 export type BorrowerApplicationWarningCodeEnum = "UnknownKey" | "NotWritable" | "CustomFieldUnresolved" | "CustomFieldInactive" | "CustomFieldReadOnly" | "CustomFieldDuplicateDefinition" | "LoanOfficerUnresolved";
 export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
+export type BranchUserMfaFactorEnum = "None" | "Sms" | "Email";
 export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
 export type CanvasFieldDescriptorDataTypeEnum = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
 export type CanvasFieldDescriptorFormatEnum = "Text" | "Number" | "Currency" | "Percent" | "DateShort" | "DateLong" | "YesNo";
@@ -7316,6 +7359,7 @@ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "Re
 export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
 export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
 export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
+export type DetailedUserMfaFactorEnum = "None" | "Sms" | "Email";
 export type DocumentsWidgetConfigTypeEnum = "Documents";
 export type DraftTypeEnum = "NewLoan" | "EditLoan";
 export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
@@ -7329,6 +7373,7 @@ export type EncompassWebhookSubscriptionWebhookTypeEnum = "Legacy" | "LoanV3" |
 export type EsignStatusWidgetConfigTypeEnum = "EsignStatus";
 export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
 export type IpAddressAddressFamilyEnum = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
+export type ImpersonatedDetailedUserMfaFactorEnum = "None" | "Sms" | "Email";
 export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
 export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
 export type InformationWidgetConfigLabelPositionEnum = "Left" | "Above";
@@ -7376,6 +7421,7 @@ export type LosWebhookEntryStatusEnum = "Registered" | "Disabled" | "Missing" |
 export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disabled" | "Missing";
 export type LosWebhookSigningKeySyncResultStatusEnum = "Unknown" | "Synced";
 export type ManualDocumentClassificationRequestDocumentTypeEnum = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
+export type MfaMethodFactorEnum = "None" | "Sms" | "Email";
 export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
 export type MyPartnerTierEnum = "Lite" | "LitePlusPortal" | "Pending";
 export type MyTasksWidgetConfigTypeEnum = "MyTasks";
@@ -7401,12 +7447,14 @@ export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorro
 export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
 export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
 export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
+export type UserMfaFactorEnum = "None" | "Sms" | "Email";
 export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
 export type UserGroupMemberUserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
 export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
 export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
+export type UserMfaStateFactorEnum = "None" | "Sms" | "Email";
 export type UserTableSettingsTableKeyEnum = "Pipeline";
 export type UserTableViewTableKeyEnum = "Pipeline";
 export type GetCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
@@ -7481,7 +7529,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v3.24.1
+ * @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/)
  */
@@ -11953,6 +12001,26 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             sortBy?: string;
             sortDirection?: string;
         }, params?: RequestParams) => Promise<AxiosResponse<LoanListPaginated, any, {}, any>>;
+        /**
+         * 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) => Promise<AxiosResponse<PipelineLoanOfficerPaginated, any, {}, any>>;
         /**
          * No description
          *
@@ -14237,6 +14305,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `422` `UnprocessableEntity` Unprocessable Content
          */
         verifyUserMobilePhone: (data: UserMobilePhoneVerificationRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
+        /**
+         * 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) => Promise<AxiosResponse<UserMfaState, any, {}, any>>;
         /**
          * No description
          *
@@ -14473,6 +14556,33 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `204` `void` No Content
          */
         deleteMe: (data: UserAccountDeletionRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
+        /**
+         * 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) => Promise<AxiosResponse<UserMfaState, any, {}, any>>;
+        /**
+         * 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) => Promise<AxiosResponse<UserMfaState, any, {}, any>>;
         /**
          * No description
          *

package/dist/index.js

@@ -101,7 +101,7 @@ export class HttpClient {
 }
 /**
  * @title The Big POS API
- * @version v3.24.1
+ * @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/)
  */
@@ -4100,6 +4100,19 @@ export class Api extends HttpClient {
              * @response `200` `LoanListPaginated` OK
              */
             searchLoans: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, 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, query, params = {}) => this.request(Object.assign({ path: `/api/loans/loan-officers/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -6182,6 +6195,21 @@ export class Api extends HttpClient {
              * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             verifyUserMobilePhone: (data, params = {}) => this.request(Object.assign({ path: `/api/users/mobile-phone/verify-code`, method: "PUT", body: data, secure: true, type: "application/json" }, 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, data, params = {}) => this.request(Object.assign({ path: `/api/users/${id}/mfa`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -6418,6 +6446,33 @@ export class Api extends HttpClient {
              * @response `204` `void` No Content
              */
             deleteMe: (data, params = {}) => this.request(Object.assign({ path: `/api/users/me/delete`, method: "POST", body: data, secure: true, type: "application/json" }, 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 = {}) => this.request(Object.assign({ 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, params = {}) => this.request(Object.assign({ path: `/api/users/me/mfa`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *