@matech/thebigpos-sdk 2.31.2 → 2.33.3-rc1

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 export type UserRole = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
 export type SiteConfigurationType = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
 export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
-export type OperationType = "Add" | "Remove" | "Replace" | "Move" | "Copy" | "Test" | "Invalid";
 export type LogLevel = "None" | "Info" | "Warning" | "Error";
 export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
 export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
@@ -93,6 +92,12 @@ export interface Account {
     asoSettings?: ASOSettings | null;
     settings: AccountSettings;
 }
+export interface AccountReportFailure {
+    /** @format uuid */
+    accountID: string;
+    accountName: string;
+    errorMessage: string;
+}
 export interface AccountSettings {
     isSmsEnabled: boolean;
     isLoanEditEnabled: boolean;
@@ -335,60 +340,6 @@ export interface AmortizationSchedule {
     /** @format double */
     pmi: number;
 }
-export interface ApplicationRowData {
-    borrowerEmail?: string | null;
-    borrowerFirstName?: string | null;
-    borrowerLastName?: string | null;
-    /** @deprecated */
-    firstName?: string | null;
-    /** @deprecated */
-    lastName?: string | null;
-    coBorrowerEmail?: string | null;
-    coBorrowerFirstName?: string | null;
-    coBorrowerLastName?: string | null;
-    loanOfficer?: string | null;
-    loanOfficerEmail?: string | null;
-    /** @format uuid */
-    id: string;
-    loanID: string;
-    /** @format date-time */
-    applicationDate?: string | null;
-    loanReferenceID: string;
-    /** @format float */
-    loanAmount?: number | null;
-    loanNumber?: string | null;
-    /** @deprecated */
-    role?: string | null;
-    /** @format date-time */
-    initialDisclosureDate?: string | null;
-    /** @format date-time */
-    closingDisclosureDate?: string | null;
-    /** @format date-time */
-    underwritingApprovalDate?: string | null;
-    /** @format date-time */
-    closedDate?: string | null;
-    /** @format date-time */
-    fundingDate?: string | null;
-    /** @format date-time */
-    currentStatusDate?: string | null;
-    channel?: string | null;
-    currentMilestone?: string | null;
-    lastMilestone?: string | null;
-    loanStatus?: string | null;
-    loanTerm?: string | null;
-    subjectPropertyStreet?: string | null;
-    subjectPropertyUnitType?: string | null;
-    subjectPropertyUnitNumber?: string | null;
-    subjectPropertyCity?: string | null;
-    subjectPropertyState?: string | null;
-    subjectPropertyZip?: string | null;
-    loanPurpose?: string | null;
-    buyerAgent?: EncompassContact | null;
-    sellerAgent?: EncompassContact | null;
-    settlementAgent?: EncompassContact | null;
-    escrowAgent?: EncompassContact | null;
-    titleInsuranceAgent?: EncompassContact | null;
-}
 export interface Attachment {
     fileName: string;
     base64Data: string;
@@ -688,10 +639,6 @@ export interface CreateInviteRequest {
     userRole?: UserRole | null;
     loanRole?: LoanRole | null;
 }
-export interface CreateLoanByDraftRequest {
-    /** @format uuid */
-    draftId: string;
-}
 export interface CreateLoanImportRequest {
     /** @format uuid */
     accountID: string;
@@ -892,6 +839,18 @@ export interface DocumentDataRequest {
     password?: string | null;
     systemGenerated: boolean;
 }
+export interface DocumentFile {
+    /** @format uuid */
+    id: string;
+    name: string;
+    losStatus: string;
+}
+export interface DocumentFolder {
+    folderName: string;
+    /** @format int32 */
+    count: number;
+    files: DocumentFile[];
+}
 export interface DocumentSync {
     /** @format int32 */
     syncedCount: number;
@@ -1085,12 +1044,6 @@ export interface EnabledServices {
     addCoBorrower?: boolean | null;
     autoNameTaskDocuments?: boolean | null;
 }
-export interface EncompassContact {
-    name?: string | null;
-    email?: string | null;
-    phone?: string | null;
-    company?: string | null;
-}
 export interface EncompassError {
     errorCode: string;
     message: string;
@@ -1329,9 +1282,6 @@ export interface GenerateDocumentRequest {
     preview: boolean;
     recipients: string[];
 }
-export interface GetApplications {
-    applications: ApplicationRowData[];
-}
 export interface GetBranch {
     /** @format date-time */
     createdAt?: string | null;
@@ -1422,7 +1372,6 @@ export interface GuidPatchOperation {
     value?: any;
     from?: string | null;
 }
-export type IContractResolver = object;
 export interface IPAddress {
     addressFamily: "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";
     /** @format int64 */
@@ -1620,6 +1569,29 @@ export interface Loan {
     id: string;
     loanID: string;
     loanNumber?: string | null;
+    referenceID: string;
+    type?: LoanType | null;
+    purpose?: LoanPurpose | null;
+    lienPosition?: LoanLienPosition | null;
+    status?: string | null;
+    currentLoanStatus?: string | null;
+    currentMilestone?: string | null;
+    lastCompletedMilestone?: string | null;
+    /** @format date-time */
+    currentStatusDate?: string | null;
+    isActive: boolean;
+    loanChannel?: string | null;
+    loanProgram?: string | null;
+    loanType?: string | null;
+    /** @format int32 */
+    term?: number | null;
+    /** @format double */
+    totalLoanAmount?: number | null;
+    fileStarter?: string | null;
+    source?: string | null;
+    isPOSLoan?: boolean | null;
+    /** @format date-time */
+    startDate?: string | null;
     /** @format date-time */
     initialDisclosureProvidedDate?: string | null;
     /** @format date-time */
@@ -1630,36 +1602,20 @@ export interface Loan {
     closingDate?: string | null;
     /** @format date-time */
     fundingOrderDate?: string | null;
-    /** @format date-time */
-    currentStatusDate?: string | null;
-    loanChannel?: string | null;
-    /** @format double */
-    totalLoanAmount?: number | null;
-    currentLoanStatus?: string | null;
-    currentMilestone?: string | null;
-    lastCompletedMilestone?: string | null;
-    /** @format date-time */
-    startDate?: string | null;
     isInSync: boolean;
     /** @format date-time */
     syncDate?: string | null;
+    isLocked: boolean;
+    isLockedFromEditing: boolean;
     excludeFromAutoTaskReminders?: boolean | null;
-    fileStarter?: string | null;
-    isPOSLoan?: boolean | null;
-    referenceID: string;
-    /** @format int32 */
-    term?: number | null;
-    loanProgram?: string | null;
-    loanType?: string | null;
-    status?: string | null;
-    isActive: boolean;
+    loanSettings?: LoanSettings | null;
     loanOfficer?: LoanOfficer | null;
     propertyAddress?: Address | null;
-    loanSettings?: LoanSettings | null;
+    property?: LoanProperty | null;
+    financial?: LoanFinancial | null;
+    borrowers: LoanBorrower[];
+    nonOwningBorrowers: LoanNonOwningBorrower[];
     loanLogs: LoanLog[];
-    isLocked: boolean;
-    isLockedFromEditing: boolean;
-    source?: string | null;
     userLoans: UserLoan[];
     contacts: LoanContact[];
 }
@@ -2620,6 +2576,7 @@ export interface LoanDocumentSearchCriteria {
     /** @format uuid */
     userID?: string | null;
     documentIDs?: string[] | null;
+    losStatuses?: LOSStatus[] | null;
 }
 export interface LoanDocumentSearchPaginated {
     rows: LoanDocumentSearch[];
@@ -2719,6 +2676,8 @@ export interface LoanList {
     status?: string | null;
     loanID?: string | null;
     loanNumber?: string | null;
+    type?: LoanType | null;
+    purpose?: LoanPurpose | null;
     /** @format double */
     totalLoanAmount?: number | null;
     /** @format date-time */
@@ -2730,30 +2689,9 @@ export interface LoanList {
     sellerAgentContact?: LoanContactList | null;
     userLoans: UserLoan[];
     contacts: LoanContact[];
+    borrowers: LoanListBorrower[];
 }
-export interface LoanListPaginated {
-    rows: LoanList[];
-    pagination: Pagination;
-    /** @format int64 */
-    count: number;
-}
-export interface LoanListV3 {
-    /** @format uuid */
-    id: string;
-    status?: string | null;
-    number?: string | null;
-    type?: LoanType | null;
-    purpose?: LoanPurpose | null;
-    /** @format double */
-    totalLoanAmount?: number | null;
-    /** @format date-time */
-    startDate?: string | null;
-    isActive: boolean;
-    propertyAddress?: Address | null;
-    loanOfficer?: LoanListV3LoanOfficer | null;
-    borrowers: LoanListV3Borrower[];
-}
-export interface LoanListV3Borrower {
+export interface LoanListBorrower {
     /** @format uuid */
     id: string;
     firstName?: string | null;
@@ -2761,11 +2699,8 @@ export interface LoanListV3Borrower {
     email?: string | null;
     isPrimaryBorrower: boolean;
 }
-export interface LoanListV3LoanOfficer {
-    name?: string | null;
-}
-export interface LoanListV3Paginated {
-    rows: LoanListV3[];
+export interface LoanListPaginated {
+    rows: LoanList[];
     pagination: Pagination;
     /** @format int64 */
     count: number;
@@ -3026,31 +2961,9 @@ export interface LoanSearchCriteria {
     /** @format uuid */
     siteConfigurationId?: string | null;
 }
-export interface LoanSearchV3Criteria {
-    searchText?: string | null;
-    /** @format uuid */
-    loanOfficerId?: string | null;
-    loanNumber?: string | null;
-    isClosed?: boolean | null;
-    purpose?: LoanPurpose | null;
-    type?: LoanType | null;
-    /** @format uuid */
-    siteConfigurationId?: string | null;
-}
 export interface LoanSettings {
     excludeFromAutoTaskReminders: boolean;
 }
-export interface LoanUpdateRequestJsonPatchDocument {
-    operations?: LoanUpdateRequestOperation[] | null;
-    contractResolver?: IContractResolver | null;
-}
-export interface LoanUpdateRequestOperation {
-    operationType: "Add" | "Remove" | "Replace" | "Move" | "Copy" | "Test" | "Invalid";
-    path?: string | null;
-    op?: string | null;
-    from?: string | null;
-    value?: any;
-}
 export interface LoanUser {
     /** @format uuid */
     id: string;
@@ -4659,6 +4572,43 @@ export interface UpdateUserRequest {
     forcePasswordReset: boolean;
     mfaEnabled: boolean;
 }
+export interface UsageReport {
+    /** @format uuid */
+    id: string;
+    /** @format uuid */
+    accountID: string;
+    accountName: string;
+    /** @format int32 */
+    month: number;
+    /** @format int32 */
+    year: number;
+    /** @format int32 */
+    posClosedLoansCount: number;
+    /** @format int32 */
+    nonPOSClosedLoansCount: number;
+    /** @format int32 */
+    reconciledLoansCount: number;
+    /** @format int32 */
+    loanOfficersCount: number;
+    /** @format int32 */
+    leadsCount: number;
+    hasMobileApp: boolean;
+    hasSms: boolean;
+    fileKey: string;
+    fileUrl: string;
+    /** @format date-time */
+    createdAt: string;
+}
+export interface UsageReportGenerationResult {
+    fileKey: string;
+    fileUrl: string;
+    /** @format int32 */
+    successCount: number;
+    /** @format int32 */
+    failureCount: number;
+    reports: UsageReport[];
+    failures: AccountReportFailure[];
+}
 export interface User {
     /** @format date-time */
     createdAt?: string | null;
@@ -4987,7 +4937,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v2.31.0
+ * @version v2.33.3
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -6688,6 +6638,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             sortBy?: string;
             sortDirection?: string;
         }, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentSearchPaginated, any>>;
+        /**
+         * @description Returns all documents grouped by folder for sidebar display
+         *
+         * @tags LoanDocuments
+         * @name GetLoanDocumentFolders
+         * @summary Get document folder hierarchy
+         * @request GET:/api/loans/{loanId}/documents/folders
+         * @secure
+         * @response `200` `(DocumentFolder)[]` Success
+         */
+        getLoanDocumentFolders: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<DocumentFolder[], any>>;
         /**
          * No description
          *
@@ -7128,29 +7089,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `404` `ProblemDetails` Not Found
          */
         retryLoanQueue: (loanQueueId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
-        /**
-         * No description
-         *
-         * @tags Loans
-         * @name CreateLoanByDraftId
-         * @summary Create Loan by DraftId
-         * @request POST:/api/loans
-         * @secure
-         * @response `200` `string` Success
-         * @response `422` `UnprocessableEntity` Client Error
-         */
-        createLoanByDraftId: (data: CreateLoanByDraftRequest, params?: RequestParams) => Promise<AxiosResponse<string, any>>;
-        /**
-         * No description
-         *
-         * @tags Loans
-         * @name GetLoans
-         * @summary Get Loans
-         * @request GET:/api/loans
-         * @secure
-         * @response `200` `GetApplications` Success
-         */
-        getLoans: (params?: RequestParams) => Promise<AxiosResponse<GetApplications, any>>;
         /**
          * No description
          *
@@ -7185,13 +7123,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * No description
          *
          * @tags Loans
-         * @name ImportLoanFromLos
-         * @summary Import from LOS
-         * @request POST:/api/loans/import-from-los/{loanId}
+         * @name CreateLoan2
+         * @summary Submit Loan Application
+         * @request POST:/api/loans
+         * @originalName createLoan
+         * @duplicate
          * @secure
-         * @response `200` `Loan` Success
+         * @response `201` `LoanApplication` Created
+         * @response `400` `any` Bad Request
+         * @response `401` `ProblemDetails` Unauthorized
+         * @response `403` `ProblemDetails` Forbidden
          */
-        importLoanFromLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<Loan, any>>;
+        createLoan2: (data: LoanApplicationRequest, params?: RequestParams) => Promise<AxiosResponse<LoanApplication, any>>;
         /**
          * No description
          *
@@ -7201,72 +7144,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PATCH:/api/loans/{loanId}
          * @secure
          * @response `200` `Loan` Success
-         */
-        updateLoan: (loanId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<Loan, any>>;
-        /**
-         * @description Retrieves a loan by its unique identifier
-         *
-         * @tags Loans V3
-         * @name GetLoanById
-         * @summary Get Loan by ID
-         * @request GET:/api/v3/loans/{id}
-         * @secure
-         * @response `200` `LoanApplication` Success
-         * @response `401` `ProblemDetails` Unauthorized
-         * @response `403` `ProblemDetails` Forbidden
-         * @response `404` `ProblemDetails` Not Found
-         */
-        getLoanById: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanApplication, any>>;
-        /**
-         * @description Partially update a loan using GUID-based patch operations. Supports GUID lookups in collections, eliminating index ordering issues.
-         *
-         * @tags Loans V3
-         * @name PatchLoan
-         * @summary Patch Loan (GUID-based)
-         * @request PATCH:/api/v3/loans/{id}
-         * @secure
-         * @response `200` `LoanApplication` Success
          * @response `400` `any` Bad Request
          * @response `401` `ProblemDetails` Unauthorized
          * @response `403` `ProblemDetails` Forbidden
          * @response `404` `ProblemDetails` Not Found
          * @response `409` `any` Conflict
          */
-        patchLoan: (id: string, data: any, params?: RequestParams) => Promise<AxiosResponse<LoanApplication, any>>;
+        updateLoan: (loanId: string, data: any, params?: RequestParams) => Promise<AxiosResponse<Loan, any>>;
         /**
-         * @description Creates a new loan or adds borrowers to an existing loan based on the presence of LoanID
-         *
-         * @tags Loans V3
-         * @name SubmitLoanApplication
-         * @summary Submit Loan Application
-         * @request POST:/api/v3/loans/applications
-         * @secure
-         * @response `201` `LoanApplication` Created
-         * @response `400` `any` Bad Request
-         * @response `401` `ProblemDetails` Unauthorized
-         * @response `403` `ProblemDetails` Forbidden
-         * @response `404` `ProblemDetails` Not Found
-         */
-        submitLoanApplication: (data: LoanApplicationRequest, params?: RequestParams) => Promise<AxiosResponse<LoanApplication, any>>;
-        /**
-         * @description Returns a paginated list of loans based on search criteria
+         * No description
          *
-         * @tags Loans V3
-         * @name SearchLoansV3
-         * @summary Search Loans
-         * @request POST:/api/v3/loans/search
+         * @tags Loans
+         * @name ImportLoanFromLos
+         * @summary Import from LOS
+         * @request POST:/api/loans/import-from-los/{loanId}
          * @secure
-         * @response `200` `LoanListV3Paginated` Success
-         * @response `401` `ProblemDetails` Unauthorized
+         * @response `200` `Loan` Success
          */
-        searchLoansV3: (data: LoanSearchV3Criteria, query?: {
-            /** @format int32 */
-            pageSize?: number;
-            /** @format int32 */
-            pageNumber?: number;
-            sortBy?: string;
-            sortDirection?: string;
-        }, params?: RequestParams) => Promise<AxiosResponse<LoanListV3Paginated, any>>;
+        importLoanFromLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<Loan, any>>;
         /**
          * No description
          *
@@ -8166,6 +8061,69 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `200` `void` Success
          */
         integrationsLosLoansCreate: (data: LosLoanCreationRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
+        /**
+         * No description
+         *
+         * @tags UsageReports
+         * @name GenerateUsageReports
+         * @summary Generate usage reports for all active production accounts
+         * @request POST:/api/usage-reports
+         * @secure
+         * @response `200` `UsageReportGenerationResult` Success
+         * @response `400` `ProblemDetails` Bad Request
+         */
+        generateUsageReports: (query?: {
+            /** @format int32 */
+            month?: number;
+            /** @format int32 */
+            year?: number;
+        }, params?: RequestParams) => Promise<AxiosResponse<UsageReportGenerationResult, any>>;
+        /**
+         * No description
+         *
+         * @tags UsageReports
+         * @name GetUsageReportsByPeriod
+         * @summary Get usage reports by month and year
+         * @request GET:/api/usage-reports
+         * @secure
+         * @response `200` `(UsageReport)[]` Success
+         * @response `400` `ProblemDetails` Bad Request
+         */
+        getUsageReportsByPeriod: (query?: {
+            /** @format int32 */
+            month?: number;
+            /** @format int32 */
+            year?: number;
+        }, params?: RequestParams) => Promise<AxiosResponse<UsageReport[], any>>;
+        /**
+         * No description
+         *
+         * @tags UsageReports
+         * @name GenerateAndSendUsageReport
+         * @summary Generate and send monthly usage report email
+         * @request POST:/api/usage-reports/generate-and-send
+         * @secure
+         * @response `204` `void` No Content
+         * @response `500` `void` Server Error
+         */
+        generateAndSendUsageReport: (query?: {
+            /** @format int32 */
+            month?: number;
+            /** @format int32 */
+            year?: number;
+        }, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
+        /**
+         * No description
+         *
+         * @tags UsageReports
+         * @name GetUsageReportById
+         * @summary Get usage report by ID
+         * @request GET:/api/usage-reports/{id}
+         * @secure
+         * @response `200` `UsageReport` Success
+         * @response `404` `ProblemDetails` Not Found
+         */
+        getUsageReportById: (id: string, params?: RequestParams) => Promise<AxiosResponse<UsageReport, any>>;
         /**
          * No description
          *