@matech/thebigpos-sdk 3.13.1 → 3.14.0-dev-5804

package/dist/index.d.ts

@@ -249,8 +249,10 @@ export interface AdminAccessUser {
     preferredLoanOfficer?: PreferredLoanOfficer | null;
     loanIDs: string[];
     drafts: Draft[];
+    inProgressLoans?: InProgressLoan[] | null;
     notificationSettings?: UserNotificationSettings | null;
     hasExtendedLoanVisibility: boolean;
+    applicationV3Enabled?: boolean | null;
     /** @format uuid */
     accountID?: string | null;
     loans: UserLoan[];
@@ -670,6 +672,7 @@ export interface AiPromptRun {
     errorType?: string | null;
     errorMessage?: string | null;
     result?: AiPromptRunResult | null;
+    detailsWithheld: boolean;
     /** @format date-time */
     createdAt: string;
     /** @format date-time */
@@ -1064,8 +1067,10 @@ export interface BranchUser {
     preferredLoanOfficer?: PreferredLoanOfficer | null;
     loanIDs: string[];
     drafts: Draft[];
+    inProgressLoans?: InProgressLoan[] | null;
     notificationSettings?: UserNotificationSettings | null;
     hasExtendedLoanVisibility: boolean;
+    applicationV3Enabled?: boolean | null;
     /** @format uuid */
     branchID: string;
     branchName: string;
@@ -1623,8 +1628,10 @@ export interface DetailedUser {
     preferredLoanOfficer?: PreferredLoanOfficer | null;
     loanIDs: string[];
     drafts: Draft[];
+    inProgressLoans?: InProgressLoan[] | null;
     notificationSettings?: UserNotificationSettings | null;
     hasExtendedLoanVisibility: boolean;
+    applicationV3Enabled?: boolean | null;
 }
 export interface DocumentDataRequest {
     documentID?: string | null;
@@ -1819,7 +1826,6 @@ export interface EnabledServices {
     socialSurvey?: boolean | null;
     borrowerTasks?: boolean | null;
     preBorrowerTasks?: boolean | null;
-    docusign?: boolean | null;
     emailNotifications?: boolean | null;
     autoTaskReminders?: boolean | null;
     voc?: boolean | null;
@@ -2374,8 +2380,10 @@ export interface ImpersonatedDetailedUser {
     preferredLoanOfficer?: PreferredLoanOfficer | null;
     loanIDs: string[];
     drafts: Draft[];
+    inProgressLoans?: InProgressLoan[] | null;
     notificationSettings?: UserNotificationSettings | null;
     hasExtendedLoanVisibility: boolean;
+    applicationV3Enabled?: boolean | null;
     /** @deprecated */
     impersonatedBy?: string | null;
     impersonatingUser?: User | null;
@@ -2386,11 +2394,65 @@ export interface ImportUserLoanTaskRequest {
     /** @format uuid */
     userID: string;
 }
+export interface InProgressLoan {
+    /** @format uuid */
+    id: string;
+    /** @format uuid */
+    borrowerId: string;
+    /** @format uuid */
+    siteConfigurationId?: string | null;
+    /** @format date-time */
+    updatedAt?: string | null;
+}
 export interface IncompleteApplicationSummary {
     /** @format int32 */
     total: number;
     borrowers: BorrowerIdentity[];
 }
+export interface IncompleteLoan {
+    /** @format uuid */
+    loanId: string;
+    /** @format uuid */
+    borrowerId?: string | null;
+    /** @format date-time */
+    createdAt: string;
+    /** @format date-time */
+    updatedAt?: string | null;
+    loanOfficer?: UserSummary | null;
+    siteConfiguration?: IncompleteLoanSiteConfiguration | null;
+    borrowers: IncompleteLoanBorrower[];
+}
+export interface IncompleteLoanBorrower {
+    /** @format uuid */
+    id: string;
+    firstName?: string | null;
+    lastName?: string | null;
+    email?: string | null;
+    isPrimaryBorrower: boolean;
+    applicationStatus: IncompleteLoanBorrowerApplicationStatusEnum;
+    /** @format date-time */
+    deletedAt?: string | null;
+}
+export interface IncompleteLoanPaginated {
+    rows: IncompleteLoan[];
+    pagination: Pagination;
+    /** @format int64 */
+    count: number;
+}
+export interface IncompleteLoanSearchCriteria {
+    searchText?: string | null;
+    /** @format uuid */
+    loanOfficerId?: string | null;
+    /** @format uuid */
+    siteConfigurationId?: string | null;
+    isUnassigned?: boolean | null;
+    includeRemovedApplications?: boolean | null;
+}
+export interface IncompleteLoanSiteConfiguration {
+    /** @format uuid */
+    id: string;
+    name: string;
+}
 export interface IntegrationSettings {
     encompass?: EncompassIntegrationSettings | null;
 }
@@ -2642,6 +2704,18 @@ export interface LoanApplicationRequest {
     /** @format uuid */
     existingLoanId?: string | null;
 }
+export interface LoanApplicationSession {
+    routeName: string;
+    currentQuestionId?: string | null;
+    questionHistory: string[];
+    /** @format date-time */
+    completedAt?: string | null;
+}
+export interface LoanApplicationSessionRequest {
+    routeName: string;
+    currentQuestionId?: string | null;
+    questionHistory: string[];
+}
 export interface LoanBorrower {
     /** @format uuid */
     id: string;
@@ -6777,6 +6851,7 @@ export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuc
 export type EncompassWebhookSubscriptionWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
 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 IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
 export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
 export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
 export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
@@ -6885,7 +6960,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v3.13.1
+ * @version v3.14.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -9764,6 +9839,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `200` `FormVersion` OK
          */
         deleteFormVersion: (formId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<FormVersion, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags IncompleteLoans
+         * @name SearchIncompleteLoans
+         * @summary Search incomplete loans
+         * @request POST:/api/loans/incomplete/search
+         * @secure
+         * @response `200` `IncompleteLoanPaginated` OK
+         * @response `400` `ProblemDetails` Bad Request
+         * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
+         */
+        searchIncompleteLoans: (data: IncompleteLoanSearchCriteria, query?: {
+            /** @format int32 */
+            pageSize?: number;
+            /** @format int32 */
+            pageNumber?: number;
+            sortBy?: string;
+            sortDirection?: string;
+        }, params?: RequestParams) => Promise<AxiosResponse<IncompleteLoanPaginated, any, {}>>;
         /**
          * No description
          *
@@ -10141,6 +10237,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `200` `File` OK
          */
         getListingOpenHouseFlyer: (id: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags LoanApplicationRemoval
+         * @name RemoveLoanApplication
+         * @summary Remove a loan application nobody has submitted
+         * @request POST:/api/loans/{loanId}/application/remove
+         * @secure
+         * @response `204` `void` No Content
+         * @response `400` `ProblemDetails` Bad Request
+         * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
+         * @response `409` `ProblemDetails` Conflict
+         */
+        removeLoanApplication: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags LoanApplicationRemoval
+         * @name RestoreLoanApplication
+         * @summary Restore a removed loan application
+         * @request POST:/api/loans/{loanId}/application/restore
+         * @secure
+         * @response `204` `void` No Content
+         * @response `400` `ProblemDetails` Bad Request
+         * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
+         * @response `409` `ProblemDetails` Conflict
+         */
+        restoreLoanApplication: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
         /**
          * No description
          *
@@ -10397,7 +10523,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getLoanDocumentFolderUsage: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolderUsage, any, {}>>;
         /**
-         * @description Returns the folders the caller can access that are relevant to this loan — those holding a document the caller can read, plus those bound to one of the loan's tasks, even when empty — with the caller's effective accessLevel and the count of documents they can read in each. Upload destinations are the active entries with accessLevel at least Write. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID, isUnassigned = true); filter to its documents with searchLoanDocuments folderScope 'Unassigned' rather than by echoing that ID.
+         * @description Returns the folders the caller can access that are relevant to this loan — every active system-default folder, plus any folder holding a document the caller can read or bound to one of the loan's tasks, even when empty — with the caller's effective accessLevel and the count of documents they can read in each. Upload destinations are the active entries with accessLevel at least Write. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID, isUnassigned = true); filter to its documents with searchLoanDocuments folderScope 'Unassigned' rather than by echoing that ID.
          *
          * @tags LoanDocumentFoldersForSingleLoan
          * @name ListLoanDocumentFolders
@@ -11143,8 +11269,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `400` `any` Bad Request
          * @response `401` `ProblemDetails` Unauthorized
          * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
          */
-        createLoanv3: (data: LoanApplicationRequest, params?: RequestParams) => Promise<AxiosResponse<LoanApplication, any, {}>>;
+        createLoanv3: (data: LoanApplicationRequest, query?: {
+            application?: string;
+        }, params?: RequestParams) => Promise<AxiosResponse<LoanApplication, any, {}>>;
         /**
          * No description
          *
@@ -11178,6 +11307,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `404` `ProblemDetails` Not Found
          * @response `409` `any` Conflict
          * @response `422` `UnprocessableEntity` Unprocessable Content
+         * @response `423` `ProblemDetails` Locked
          */
         updateLoan: (loanId: string, data: LoanPatchRequestGuidPatchDocument, params?: RequestParams) => Promise<AxiosResponse<Loan, any, {}>>;
         /**
@@ -11192,6 +11322,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `400` `ProblemDetails` Bad Request
          * @response `404` `ProblemDetails` Not Found
          * @response `409` `ProblemDetails` Conflict
+         * @response `422` `UnprocessableEntity` Unprocessable Content
          */
         completeBorrowerApplication: (loanId: string, borrowerId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
         /**
@@ -11208,6 +11339,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `429` `ProblemDetails` Too Many Requests
          */
         getLoanBorrowerSsn: (loanId: string, borrowerId: string, params?: RequestParams) => Promise<AxiosResponse<LoanBorrowerSsn, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags Loans
+         * @name GetBorrowerApplicationSession
+         * @summary Get borrower application session
+         * @request GET:/api/loans/{loanId}/borrowers/{borrowerId}/application-session
+         * @secure
+         * @response `200` `LoanApplicationSession` OK
+         * @response `400` `any` Bad Request
+         * @response `401` `ProblemDetails` Unauthorized
+         * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
+         */
+        getBorrowerApplicationSession: (loanId: string, borrowerId: string, params?: RequestParams) => Promise<AxiosResponse<LoanApplicationSession, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags Loans
+         * @name UpdateBorrowerApplicationSession
+         * @summary Update borrower application session
+         * @request PUT:/api/loans/{loanId}/borrowers/{borrowerId}/application-session
+         * @secure
+         * @response `200` `LoanApplicationSession` OK
+         * @response `400` `any` Bad Request
+         * @response `401` `ProblemDetails` Unauthorized
+         * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
+         */
+        updateBorrowerApplicationSession: (loanId: string, borrowerId: string, data: LoanApplicationSessionRequest, params?: RequestParams) => Promise<AxiosResponse<LoanApplicationSession, any, {}>>;
         /**
          * No description
          *
@@ -11229,6 +11390,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          * @response `202` `void` Accepted
          * @response `404` `ProblemDetails` Not Found
+         * @response `409` `ProblemDetails` Conflict
          */
         syncLoanToLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
         /**

package/dist/index.js

@@ -101,7 +101,7 @@ export class HttpClient {
 }
 /**
  * @title The Big POS API
- * @version v3.13.1
+ * @version v3.14.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -2649,6 +2649,20 @@ export class Api extends HttpClient {
              * @response `200` `FormVersion` OK
              */
             deleteFormVersion: (formId, id, params = {}) => this.request(Object.assign({ path: `/api/forms/${formId}/versions/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags IncompleteLoans
+             * @name SearchIncompleteLoans
+             * @summary Search incomplete loans
+             * @request POST:/api/loans/incomplete/search
+             * @secure
+             * @response `200` `IncompleteLoanPaginated` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            searchIncompleteLoans: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/incomplete/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -2985,6 +2999,36 @@ export class Api extends HttpClient {
              * @response `200` `File` OK
              */
             getListingOpenHouseFlyer: (id, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}/open-house-flyer`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanApplicationRemoval
+             * @name RemoveLoanApplication
+             * @summary Remove a loan application nobody has submitted
+             * @request POST:/api/loans/{loanId}/application/remove
+             * @secure
+             * @response `204` `void` No Content
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             */
+            removeLoanApplication: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/application/remove`, method: "POST", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanApplicationRemoval
+             * @name RestoreLoanApplication
+             * @summary Restore a removed loan application
+             * @request POST:/api/loans/{loanId}/application/restore
+             * @secure
+             * @response `204` `void` No Content
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             */
+            restoreLoanApplication: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/application/restore`, method: "POST", secure: true }, params)),
             /**
              * No description
              *
@@ -3234,7 +3278,7 @@ export class Api extends HttpClient {
              */
             getLoanDocumentFolderUsage: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}/usage`, method: "GET", secure: true, format: "json" }, params)),
             /**
-             * @description Returns the folders the caller can access that are relevant to this loan — those holding a document the caller can read, plus those bound to one of the loan's tasks, even when empty — with the caller's effective accessLevel and the count of documents they can read in each. Upload destinations are the active entries with accessLevel at least Write. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID, isUnassigned = true); filter to its documents with searchLoanDocuments folderScope 'Unassigned' rather than by echoing that ID.
+             * @description Returns the folders the caller can access that are relevant to this loan — every active system-default folder, plus any folder holding a document the caller can read or bound to one of the loan's tasks, even when empty — with the caller's effective accessLevel and the count of documents they can read in each. Upload destinations are the active entries with accessLevel at least Write. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID, isUnassigned = true); filter to its documents with searchLoanDocuments folderScope 'Unassigned' rather than by echoing that ID.
              *
              * @tags LoanDocumentFoldersForSingleLoan
              * @name ListLoanDocumentFolders
@@ -3905,8 +3949,9 @@ export class Api extends HttpClient {
              * @response `400` `any` Bad Request
              * @response `401` `ProblemDetails` Unauthorized
              * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
              */
-            createLoanv3: (data, params = {}) => this.request(Object.assign({ path: `/api/loans`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            createLoanv3: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -3933,6 +3978,7 @@ export class Api extends HttpClient {
              * @response `404` `ProblemDetails` Not Found
              * @response `409` `any` Conflict
              * @response `422` `UnprocessableEntity` Unprocessable Content
+             * @response `423` `ProblemDetails` Locked
              */
             updateLoan: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
@@ -3947,6 +3993,7 @@ export class Api extends HttpClient {
              * @response `400` `ProblemDetails` Bad Request
              * @response `404` `ProblemDetails` Not Found
              * @response `409` `ProblemDetails` Conflict
+             * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             completeBorrowerApplication: (loanId, borrowerId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/borrowers/${borrowerId}/complete`, method: "POST", secure: true }, params)),
             /**
@@ -3963,6 +4010,36 @@ export class Api extends HttpClient {
              * @response `429` `ProblemDetails` Too Many Requests
              */
             getLoanBorrowerSsn: (loanId, borrowerId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/borrowers/${borrowerId}/ssn`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags Loans
+             * @name GetBorrowerApplicationSession
+             * @summary Get borrower application session
+             * @request GET:/api/loans/{loanId}/borrowers/{borrowerId}/application-session
+             * @secure
+             * @response `200` `LoanApplicationSession` OK
+             * @response `400` `any` Bad Request
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            getBorrowerApplicationSession: (loanId, borrowerId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/borrowers/${borrowerId}/application-session`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags Loans
+             * @name UpdateBorrowerApplicationSession
+             * @summary Update borrower application session
+             * @request PUT:/api/loans/{loanId}/borrowers/{borrowerId}/application-session
+             * @secure
+             * @response `200` `LoanApplicationSession` OK
+             * @response `400` `any` Bad Request
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            updateBorrowerApplicationSession: (loanId, borrowerId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/borrowers/${borrowerId}/application-session`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -3984,6 +4061,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `202` `void` Accepted
              * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
              */
             syncLoanToLos: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/sync-to-los`, method: "POST", secure: true }, params)),
             /**