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

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;
@@ -2362,6 +2366,10 @@ export interface ConditionComment {
   createdByName: string;
 }
 
+export interface ConfirmMfaEnrollmentRequest {
+  code: string;
+}
+
 export interface ConsumerConnectRetry {
   correlationKey: string;
   email: string;
@@ -2689,6 +2697,7 @@ export interface CustomFieldDefinition {
   regexPattern?: string | null;
   dataType: CustomFieldDefinitionDataTypeEnum;
   entityType: CustomFieldDefinitionEntityTypeEnum;
+  isAiEnabled: boolean;
   options: CustomFieldOption[];
   permissions: CustomFieldPermission[];
   encompassMapping?: EncompassMapping | null;
@@ -2766,6 +2775,7 @@ export interface DetailedUser {
   title?: string | null;
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
+  mfaFactor: DetailedUserMfaFactorEnum;
   phoneVerified: boolean;
   /** @format int32 */
   loginsWithoutMFACount: number;
@@ -3608,6 +3618,7 @@ export interface ImpersonatedDetailedUser {
   title?: string | null;
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
+  mfaFactor: ImpersonatedDetailedUserMfaFactorEnum;
   phoneVerified: boolean;
   /** @format int32 */
   loginsWithoutMFACount: number;
@@ -4009,6 +4020,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 +6119,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;
@@ -6519,6 +6549,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;
@@ -7682,6 +7729,10 @@ export interface StandardLoanField {
   isAiEnabled: boolean;
 }
 
+export interface StartMfaEnrollmentRequest {
+  factor?: MfaFactor | null;
+}
+
 export interface SupportedModel {
   modelId: string;
   displayName: string;
@@ -8104,6 +8155,11 @@ export interface UpdateMeRequest {
   preferredLoanOfficerId?: string | null;
 }
 
+export interface UpdateMfaFactorRequest {
+  factor?: MfaFactor | null;
+  passwordConfirmation?: string | null;
+}
+
 export interface UpdateMobilePhoneRequest {
   phone: string;
 }
@@ -8315,6 +8371,7 @@ export interface User {
   title?: string | null;
   forcePasswordReset: boolean;
   mfaEnabled: boolean;
+  mfaFactor: UserMfaFactorEnum;
   phoneVerified: boolean;
   /** @format int32 */
   loginsWithoutMFACount: number;
@@ -8503,6 +8560,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 +8771,8 @@ type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
 
 export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
 
+export type AdminAccessUserMfaFactorEnum = "None" | "Sms" | "Email";
+
 export type AiAuditLogEventTypeEnum =
   | "Error"
   | "GuardrailBlockedPre"
@@ -8828,6 +8894,8 @@ export type BorrowerIdentityRoleEnum =
   | "SettlementAgent"
   | "Admin";
 
+export type BranchUserMfaFactorEnum = "None" | "Sms" | "Email";
+
 export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
 
 export type CanvasFieldDescriptorDataTypeEnum =
@@ -9127,6 +9195,8 @@ export type CustomFieldValueDataTypeEnum =
   | "SingleSelect"
   | "MultiSelect";
 
+export type DetailedUserMfaFactorEnum = "None" | "Sms" | "Email";
+
 export type DocumentsWidgetConfigTypeEnum = "Documents";
 
 export type DraftTypeEnum = "NewLoan" | "EditLoan";
@@ -9213,6 +9283,8 @@ export type IpAddressAddressFamilyEnum =
   | "ControllerAreaNetwork"
   | "Unknown";
 
+export type ImpersonatedDetailedUserMfaFactorEnum = "None" | "Sms" | "Email";
+
 export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
 
 export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
@@ -9584,6 +9656,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";
@@ -9710,6 +9786,8 @@ export type UpdateAiUrlSourceRequestCategoryEnum =
 
 export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
 
+export type UserMfaFactorEnum = "None" | "Sms" | "Email";
+
 export type UserDraftRoleEnum =
   | "Borrower"
   | "CoBorrower"
@@ -9763,6 +9841,8 @@ export type UserLoanConsentLosSyncStatusEnum =
   | "Failed"
   | "Success";
 
+export type UserMfaStateFactorEnum = "None" | "Sms" | "Email";
+
 export type UserTableSettingsTableKeyEnum = "Pipeline";
 
 export type UserTableViewTableKeyEnum = "Pipeline";
@@ -10071,7 +10151,7 @@ export 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/)
  */
@@ -18192,6 +18272,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
      *
@@ -22464,6 +22579,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
      *
@@ -22890,6 +23034,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
      *