@matech/thebigpos-sdk 3.16.0 → 3.17.0-dev-6319

package/src/index.ts

@@ -543,6 +543,26 @@ export type DraftType = "NewLoan" | "EditLoan";
 
 export type DocumentVisibilityScope = "Own" | "All";
 
+export type DocumentType =
+  | "PrequalLetter"
+  | "PreapprovalLetter"
+  | "EConsent"
+  | "CreditAuthorization"
+  | "TextOptIn"
+  | "OpenHouseFlyer"
+  | "LoanComparison"
+  | "BuyerAgencyAgreements"
+  | "ListingAgreements"
+  | "Addendums"
+  | "RentalAgreements"
+  | "SalesContracts"
+  | "RealEstateMarketFlyer"
+  | "MortgageMarketingFlyer"
+  | "FeeItemization"
+  | "RefinanceDocument"
+  | "CertifiedCommitments"
+  | "CoBrandedMarketingFlyer";
+
 export type CustomFieldEntityType = "Loan";
 
 export type CustomFieldDataType =
@@ -635,6 +655,15 @@ export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
 
 export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
 
+export type BorrowerApplicationWarningCode =
+  | "UnknownKey"
+  | "NotWritable"
+  | "CustomFieldUnresolved"
+  | "CustomFieldInactive"
+  | "CustomFieldReadOnly"
+  | "CustomFieldDuplicateDefinition"
+  | "LoanOfficerUnresolved";
+
 export type BorrowerApplicationStatus = "Draft" | "Complete";
 
 export type BillingType = "ClosedLoan" | "LoanOfficer";
@@ -881,6 +910,7 @@ export interface AccountFailureCount {
 export interface AccountSettings {
   isSmsEnabled: boolean;
   isLoanEditEnabled: boolean;
+  isApplicationEditEnabled?: boolean | null;
   smsNumber?: string | null;
   ssoHostOverride?: string | null;
   isEarlyAdopter: boolean;
@@ -890,6 +920,7 @@ export interface AccountSettingsRequest {
   isSmsEnabled: boolean;
   smsNumber?: string | null;
   isEarlyAdopter: boolean;
+  isApplicationEditEnabled?: boolean | null;
 }
 
 export interface Address {
@@ -1170,8 +1201,6 @@ export interface AiCanonicalField {
   isDefault: boolean;
   category?: string | null;
   jsonPropertyName?: string | null;
-  textractKey?: string | null;
-  textractKeyAliases: string[];
   hasAccountOverride: boolean;
   writable: boolean;
   patchPath?: string | null;
@@ -1777,6 +1806,36 @@ export interface AutomatedService {
   rateLimited: string[];
 }
 
+export interface BorrowerApplication {
+  /** @format uuid */
+  loanId: string;
+  /** @format uuid */
+  borrowerId: string;
+  /** @format uuid */
+  coBorrowerId?: string | null;
+  applicationStatus: BorrowerApplicationApplicationStatusEnum;
+  answers: Record<string, any>;
+  additionalFields: Record<string, string>;
+  cursor?: LoanApplicationSession | null;
+}
+
+export interface BorrowerApplicationUpdate {
+  warnings: BorrowerApplicationWarning[];
+  application: BorrowerApplication;
+}
+
+export interface BorrowerApplicationUpdateRequest {
+  answers: Record<string, any>;
+  additionalFields?: Record<string, any> | null;
+  cursor?: LoanApplicationSessionRequest | null;
+}
+
+export interface BorrowerApplicationWarning {
+  key: string;
+  code: BorrowerApplicationWarningCodeEnum;
+  message: string;
+}
+
 export interface BorrowerCount {
   /** @format uuid */
   userId: string;
@@ -2409,7 +2468,6 @@ export interface CreateAiCanonicalFieldRequest {
   description: string;
   allowedRoles: string[];
   isPii: boolean;
-  dataSource: string;
   category?: string | null;
 }
 
@@ -3687,7 +3745,7 @@ export interface Invite {
   phoneNumber: string;
   relationship: string;
   /** @deprecated */
-  loanID: string;
+  loanID?: string | null;
   route?: string | null;
   /** @format uuid */
   siteConfigurationID: string;
@@ -3703,7 +3761,7 @@ export interface Invite {
   /** @format date-time */
   expiresAt?: string | null;
   status: string;
-  loan: LoanIdentifier;
+  loan?: LoanIdentifier | null;
   url: string;
   linksBorrowerApplication?: boolean | null;
 }
@@ -6312,6 +6370,10 @@ export interface NotificationTemplateVersionUpdateRequest {
   pushNotificationBody?: string | null;
 }
 
+export interface OpenBorrowerApplicationEditRequest {
+  isCoBorrower: boolean;
+}
+
 export type OpenTasksWidgetConfig = UtilRequiredKeys<
   BaseCanvasWidgetConfig,
   "type"
@@ -8620,6 +8682,17 @@ export type AuditLogEntryChangeTypeEnum =
   | "Reactivated"
   | "Accessed";
 
+export type BorrowerApplicationApplicationStatusEnum = "Draft" | "Complete";
+
+export type BorrowerApplicationWarningCodeEnum =
+  | "UnknownKey"
+  | "NotWritable"
+  | "CustomFieldUnresolved"
+  | "CustomFieldInactive"
+  | "CustomFieldReadOnly"
+  | "CustomFieldDuplicateDefinition"
+  | "LoanOfficerUnresolved";
+
 export type BorrowerCountRoleEnum =
   | "Borrower"
   | "CoBorrower"
@@ -9753,7 +9826,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),
@@ -9815,7 +9896,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v3.16.0
+ * @version v3.17.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -12097,6 +12178,65 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags BorrowerApplication
+     * @name GetBorrowerApplication
+     * @summary Get a borrower's application as flat answers
+     * @request GET:/api/loans/{loanId}/borrowers/{borrowerId}/application
+     * @secure
+     * @response `200` `BorrowerApplication` OK
+     * @response `400` `any` Bad Request
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     */
+    getBorrowerApplication: (
+      loanId: string,
+      borrowerId: string,
+      params: RequestParams = {},
+    ) =>
+      this.request<BorrowerApplication, ProblemDetails>({
+        path: `/api/loans/${loanId}/borrowers/${borrowerId}/application`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags BorrowerApplication
+     * @name UpdateBorrowerApplication
+     * @summary Save a step of a borrower's application from flat answers
+     * @request PATCH:/api/loans/{loanId}/borrowers/{borrowerId}/application
+     * @secure
+     * @response `200` `BorrowerApplicationUpdate` OK
+     * @response `400` `any` Bad Request
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `422` `UnprocessableEntity` Unprocessable Content
+     */
+    updateBorrowerApplication: (
+      loanId: string,
+      borrowerId: string,
+      data: JsonPatchDocument,
+      params: RequestParams = {},
+    ) =>
+      this.request<
+        BorrowerApplicationUpdate,
+        ProblemDetails | UnprocessableEntity
+      >({
+        path: `/api/loans/${loanId}/borrowers/${borrowerId}/application`,
+        method: "PATCH",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -15822,6 +15962,36 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags LoanApplicationEdit
+     * @name OpenBorrowerApplicationEdit
+     * @summary Open a borrower's submitted application for editing
+     * @request POST:/api/loans/{loanId}/application/edit
+     * @secure
+     * @response `200` `BorrowerApplication` OK
+     * @response `400` `any` Bad Request
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     * @response `423` `any` Locked
+     */
+    openBorrowerApplicationEdit: (
+      loanId: string,
+      data: OpenBorrowerApplicationEditRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<BorrowerApplication, ProblemDetails>({
+        path: `/api/loans/${loanId}/application/edit`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -17841,6 +18011,7 @@ export class Api<
      * @response `404` `ProblemDetails` Not Found
      * @response `409` `ProblemDetails` Conflict
      * @response `422` `UnprocessableEntity` Unprocessable Content
+     * @response `423` `ProblemDetails` Locked
      */
     completeBorrowerApplication: (
       loanId: string,
@@ -20565,12 +20736,20 @@ export class Api<
      * @request GET:/api/template-tokens
      * @secure
      * @response `200` `(TemplateTokenRoot)[]` OK
+     * @response `400` `ProblemDetails` Bad Request
      * @response `403` `ProblemDetails` Forbidden
      */
-    getTemplateTokens: (params: RequestParams = {}) =>
+    getTemplateTokens: (
+      query?: {
+        notificationKey?: string;
+        documentType?: DocumentType;
+      },
+      params: RequestParams = {},
+    ) =>
       this.request<TemplateTokenRoot[], ProblemDetails>({
         path: `/api/template-tokens`,
         method: "GET",
+        query: query,
         secure: true,
         format: "json",
         ...params,