@matech/thebigpos-sdk 2.18.4-rc.0 → 2.19.4-rc.0

package/{apply-json-patch-content-type.js → scripts/apply-json-patch-content-type.js}

@@ -1,45 +1,56 @@
-/* 
-  This script is meant to run after the SDK has been generated.
-
-  - It updates the generated code to ensure that all PATCH methods use ContentType.JsonPatch.
-  - It also ensures that the ContentType enum includes JsonPatch and modifies the Operation interface
-    to allow any value for the `value` property instead of just object or null.
-
-  This is necessary because the SDK generation does not currently handle these cases correctly.
-*/
-
-const fs = require('fs')
-
-const path = './src/index.ts'
-let content = fs.readFileSync(path, 'utf8')
-
-// Update PATCH methods to use ContentType.JsonPatch
-content = content.replace(
-	/(method:\s*"PATCH"[\s\S]+?)type:\s*ContentType\.Json/g,
-	(match) => match.replace('ContentType.Json', 'ContentType.JsonPatch')
-)
-
-// Ensure JsonPatch is included in the ContentType enum
-content = content.replace(
-	/export enum ContentType\s*{([\s\S]*?)}/,
-	(match, enumBody) => {
-		if (enumBody.includes('JsonPatch')) return match
-		const insertion = `  JsonPatch = "application/json-patch+json",\n  `
-		return `export enum ContentType {\n${insertion}${enumBody.trim()}\n}`
-	}
-)
-
-// Fix the Operation interface to allow any value
-content = content.replace(
-	/export interface Operation\s*{([\s\S]*?)}/,
-	(match, body) => {
-		const updated = body.replace(
-			/value\?:\s*object\s*\|?\s*null?;/,
-			'value?: any | null;'
-		)
-		return `export interface Operation {\n  ${updated.trim()}\n}`
-	}
-)
-
-fs.writeFileSync(path, content)
-console.log('SDK patch complete: All PATCH methods now use ContentType.JsonPatch.')
+/* 
+  This script is meant to run after the SDK has been generated.
+
+  - It updates the generated code to ensure that all PATCH methods use ContentType.JsonPatch.
+  - It also ensures that the ContentType enum includes JsonPatch and modifies the Operation interface
+    to allow any value for the `value` property instead of just object or null.
+
+  This is necessary because the SDK generation does not currently handle these cases correctly.
+*/
+
+const fs = require('fs')
+
+const path = require('path').resolve(__dirname, '../src/index.ts')
+
+if (!fs.existsSync(path)) {
+	console.error(`Error: File not found at path "${path}". Please ensure the SDK has been generated.`)
+	process.exit(1)
+}
+let content
+try {
+	content = fs.readFileSync(path, 'utf8')
+} catch (err) {
+	console.error(`Error: Unable to read file at path "${path}". Details: ${err.message}`)
+	process.exit(1)
+}
+
+// Update PATCH methods to use ContentType.JsonPatch
+content = content.replace(
+	/(method:\s*"PATCH"[\s\S]+?)type:\s*ContentType\.Json/g,
+	(match) => match.replace('ContentType.Json', 'ContentType.JsonPatch')
+)
+
+// Ensure JsonPatch is included in the ContentType enum
+content = content.replace(
+	/export enum ContentType\s*{([\s\S]*?)}/,
+	(match, enumBody) => {
+		if (enumBody.includes('JsonPatch')) return match
+		const insertion = `  JsonPatch = "application/json-patch+json",\n  `
+		return `export enum ContentType {\n${insertion}${enumBody.trim()}\n}`
+	}
+)
+
+// Fix the Operation interface to allow any value
+content = content.replace(
+	/export interface Operation\s*{([\s\S]*?)}/,
+	(match, body) => {
+		const updated = body.replace(
+			/value\?:\s*object\s*\|?\s*null?;/,
+			'value?: string | number | boolean | null | object;'
+		)
+		return `export interface Operation {\n  ${updated.trim()}\n}`
+	}
+)
+
+fs.writeFileSync(path, content)
+console.log('SDK patch complete: All PATCH methods now use ContentType.JsonPatch.')

package/src/index.ts

@@ -264,6 +264,11 @@ export interface AllowImpersonationRequest {
 }
 
 export interface ApplicationRowData {
+  buyerAgent?: EncompassContact | null;
+  sellerAgent?: EncompassContact | null;
+  settlementAgent?: EncompassContact | null;
+  escrowAgent?: EncompassContact | null;
+  titleInsuranceAgent?: EncompassContact | null;
   borrowerEmail?: string | null;
   borrowerFirstName?: string | null;
   borrowerLastName?: string | null;
@@ -309,11 +314,6 @@ export interface ApplicationRowData {
   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 {
@@ -471,15 +471,6 @@ export interface ConditionComment {
   createdByName: string;
 }
 
-export interface Contact {
-  /** @format uuid */
-  id: string;
-  firstName?: string | null;
-  lastName?: string | null;
-  name?: string | null;
-  email?: string | null;
-}
-
 export interface ContactInfo {
   phone: string;
   tollFreePhone?: string | null;
@@ -968,6 +959,7 @@ export interface EnabledServices {
   listingOfferForm?: boolean | null;
   listings?: boolean | null;
   addCoBorrower?: boolean | null;
+  autoNameTaskDocuments?: boolean | null;
 }
 
 export interface EncompassContact {
@@ -981,66 +973,6 @@ export interface Error {
   message: string;
 }
 
-export interface ExtendedLoan {
-  /** @format uuid */
-  id: string;
-  loanID: string;
-  loanNumber?: string | null;
-  /** @format date-time */
-  initialDisclosureProvidedDate?: string | null;
-  /** @format date-time */
-  closingDisclosureSentDate?: string | null;
-  /** @format date-time */
-  underwritingApprovalDate?: string | null;
-  /** @format date-time */
-  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;
-  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;
-  loanOfficer?: LoanOfficer | null;
-  propertyAddress?: Address | null;
-  loanSettings?: LoanSettings | null;
-  loanLogs: LoanLog[];
-  isLocked: boolean;
-  source?: string | null;
-  userLoans: UserLoan[];
-  contacts: LoanContact[];
-  buyerAgentContact?: Contact | null;
-  sellerAgentContact?: Contact | null;
-  escrowAgentContact?: Contact | null;
-  titleInsuranceAgentContact?: Contact | null;
-  settlementAgentContact?: Contact | null;
-  loanProcessorContact?: Contact | null;
-}
-
-export interface ExtendedLoanPaginated {
-  rows: ExtendedLoan[];
-  pagination: Pagination;
-  /** @format int64 */
-  count: number;
-}
-
 export interface File {
   /** @format uuid */
   id: string;
@@ -1583,6 +1515,7 @@ export interface Loan {
   loanSettings?: LoanSettings | null;
   loanLogs: LoanLog[];
   isLocked: boolean;
+  isLockedFromEditing: boolean;
   source?: string | null;
   userLoans: UserLoan[];
   contacts: LoanContact[];
@@ -1666,6 +1599,10 @@ export interface LoanContact {
     | "SettlementAgent";
 }
 
+export interface LoanContactList {
+  email: string;
+}
+
 export interface LoanDocument {
   /** @format date-time */
   createdAt: string;
@@ -1685,6 +1622,40 @@ export interface LoanDocument {
   failoverDocumentPath?: string | null;
 }
 
+export interface LoanDocumentSearch {
+  /** @format date-time */
+  createdAt?: string | null;
+  /** @format date-time */
+  updatedAt?: string | null;
+  /** @format date-time */
+  deletedAt?: string | null;
+  /** @format uuid */
+  id: string;
+  name: string;
+  loanID?: string | null;
+  userID?: string | null;
+  initialBucket?: string | null;
+  losDocumentID?: string | null;
+  losStatus: string;
+  contents?: string | null;
+  failoverDocumentPath?: string | null;
+}
+
+export interface LoanDocumentSearchCriteria {
+  searchText?: string | null;
+  bucket?: string | null;
+  /** @format uuid */
+  userID?: string | null;
+  documentIDs?: string[] | null;
+}
+
+export interface LoanDocumentSearchPaginated {
+  rows: LoanDocumentSearch[];
+  pagination: Pagination;
+  /** @format int64 */
+  count: number;
+}
+
 export interface LoanDraftSearchCriteria {
   searchText?: string | null;
   /** @format uuid */
@@ -1694,6 +1665,30 @@ export interface LoanDraftSearchCriteria {
   isUnassigned?: boolean | null;
 }
 
+export interface LoanList {
+  /** @format uuid */
+  id: string;
+  status?: string | null;
+  loanID?: string | null;
+  loanNumber?: string | null;
+  /** @format double */
+  totalLoanAmount?: number | null;
+  /** @format date-time */
+  startDate?: string | null;
+  propertyAddress?: Address | null;
+  loanOfficer?: LoanOfficerList | null;
+  buyerAgentContact?: LoanContactList | null;
+  sellerAgentContact?: LoanContactList | null;
+  userLoans: UserLoan[];
+}
+
+export interface LoanListPaginated {
+  rows: LoanList[];
+  pagination: Pagination;
+  /** @format int64 */
+  count: number;
+}
+
 export interface LoanLog {
   /** @format uuid */
   id: string;
@@ -1716,6 +1711,10 @@ export interface LoanOfficer {
   siteConfiguration: SiteConfiguration;
 }
 
+export interface LoanOfficerList {
+  name?: string | null;
+}
+
 export interface LoanOfficerPublic {
   firstName: string;
   lastName: string;
@@ -1888,6 +1887,13 @@ export interface MilestoneConfigurationRequest {
   notificationsEnabled: boolean;
 }
 
+export interface MobileSettings {
+  /** @format uuid */
+  id: string;
+  hasMobile: boolean;
+  downloadLink?: string | null;
+}
+
 export interface Module {
   /** @format uuid */
   id: string;
@@ -2036,7 +2042,7 @@ export interface NotificationTemplateVersionUpdateRequest {
 
 export interface Operation {
   op?: string;
-  value?: any | null;
+  value?: string | number | boolean | null | object;
   path?: string;
 }
 
@@ -2284,6 +2290,12 @@ export interface SendForgotPasswordRequest {
   email: string;
 }
 
+export interface SendLoanDocumentsRequest {
+  documentIDs: string[];
+  loanUserIDs: string[];
+  emailAddresses: string[];
+}
+
 export interface SendNotificationForLoanRequest {
   /** @minLength 1 */
   loanID: string;
@@ -2487,6 +2499,7 @@ export interface SiteConfiguration {
   asoSettings?: ASOSettings | null;
   accountSettings: AccountSettings;
   autoTaskReminderIntervalsInDays: number[];
+  mobileSettings: MobileSettings;
 }
 
 export interface SiteConfigurationByUrl {
@@ -2679,6 +2692,7 @@ export interface SiteConfigurationByUrl {
   asoSettings?: ASOSettings | null;
   accountSettings: AccountSettings;
   autoTaskReminderIntervalsInDays: number[];
+  mobileSettings: MobileSettings;
   workflows: Workflow[];
 }
 
@@ -3671,7 +3685,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v2.18.4
+ * @version v2.19.1
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -5823,6 +5837,7 @@ export class Api<
      * @secure
      * @response `200` `string` Success
      * @response `422` `UnprocessableEntity` Client Error
+     * @response `423` `UnprocessableEntity` Client Error
      */
     updateLoanConsent: (
       loanId: string,
@@ -5834,7 +5849,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: ContentType.JsonPatchPatch,
         format: "json",
         ...params,
       }),
@@ -5870,6 +5885,7 @@ export class Api<
      * @secure
      * @response `200` `string` Success
      * @response `422` `UnprocessableEntity` Client Error
+     * @response `423` `UnprocessableEntity` Client Error
      */
     createLoan: (data: any, params: RequestParams = {}) =>
       this.request<string, UnprocessableEntity>({
@@ -6051,12 +6067,13 @@ export class Api<
      * @deprecated
      * @secure
      * @response `200` `DocumentDataRequest` Success
+     * @response `423` `UnprocessableEntity` Client Error
      */
     createLegacyLoanDocument: (
       data: GenerateDocumentRequest,
       params: RequestParams = {},
     ) =>
-      this.request<DocumentDataRequest, any>({
+      this.request<DocumentDataRequest, UnprocessableEntity>({
         path: `/api/los/loan/generatedocument`,
         method: "POST",
         body: data,
@@ -6116,7 +6133,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: ContentType.JsonPatchPatch,
         format: "json",
         ...params,
       }),
@@ -6196,7 +6213,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: ContentType.JsonPatchPatch,
         format: "json",
         ...params,
       }),
@@ -6483,6 +6500,7 @@ export class Api<
      * @secure
      * @response `200` `RunLOCalculation` Success
      * @response `422` `UnprocessableEntity` Client Error
+     * @response `423` `UnprocessableEntity` Client Error
      */
     runLoanCalculator: (
       loanId: string,
@@ -6528,6 +6546,7 @@ export class Api<
      * @secure
      * @response `201` `LoanComparisonScenario` Created
      * @response `422` `UnprocessableEntity` Client Error
+     * @response `423` `UnprocessableEntity` Client Error
      */
     createLoanComparison: (
       loanId: string,
@@ -6665,6 +6684,40 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags LoanDocuments
+     * @name SearchLoanDocuments
+     * @summary Search loan documents
+     * @request POST:/api/loans/{loanId}/documents/search
+     * @secure
+     * @response `200` `LoanDocumentSearchPaginated` Success
+     */
+    searchLoanDocuments: (
+      loanId: string,
+      data: LoanDocumentSearchCriteria,
+      query?: {
+        /** @format int32 */
+        pageSize?: number;
+        /** @format int32 */
+        pageNumber?: number;
+        sortBy?: string;
+        sortDirection?: string;
+      },
+      params: RequestParams = {},
+    ) =>
+      this.request<LoanDocumentSearchPaginated, any>({
+        path: `/api/loans/${loanId}/documents/search`,
+        method: "POST",
+        query: query,
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -6700,6 +6753,7 @@ export class Api<
      * @response `201` `LoanDocument` Created
      * @response `404` `ProblemDetails` Not Found
      * @response `422` `UnprocessableEntity` Client Error
+     * @response `423` `UnprocessableEntity` Client Error
      */
     createLoanDocument: (
       loanId: string,
@@ -6732,6 +6786,7 @@ export class Api<
      * @response `200` `LoanDocument` Success
      * @response `404` `ProblemDetails` Not Found
      * @response `422` `UnprocessableEntity` Client Error
+     * @response `423` `UnprocessableEntity` Client Error
      */
     retryFailedLoanDocument: (
       loanId: string,
@@ -6771,6 +6826,32 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags LoanDocuments
+     * @name SendLoanDocuments
+     * @summary Send existing documents to loan users or external emails
+     * @request POST:/api/loans/{loanId}/documents/distribute
+     * @secure
+     * @response `200` `void` Success
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `404` `ProblemDetails` Not Found
+     */
+    sendLoanDocuments: (
+      loanId: string,
+      data: SendLoanDocumentsRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/loans/${loanId}/documents/distribute`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -7356,7 +7437,7 @@ export class Api<
      * @summary Search
      * @request POST:/api/loans/search
      * @secure
-     * @response `200` `ExtendedLoanPaginated` Success
+     * @response `200` `LoanListPaginated` Success
      */
     searchLoans: (
       data: LoanSearchCriteria,
@@ -7370,7 +7451,7 @@ export class Api<
       },
       params: RequestParams = {},
     ) =>
-      this.request<ExtendedLoanPaginated, any>({
+      this.request<LoanListPaginated, any>({
         path: `/api/loans/search`,
         method: "POST",
         query: query,
@@ -7420,7 +7501,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: ContentType.JsonPatchPatch,
         format: "json",
         ...params,
       }),
@@ -7692,6 +7773,7 @@ export class Api<
      * @secure
      * @response `201` `UserLoanTask` Created
      * @response `404` `ProblemDetails` Not Found
+     * @response `423` `UnprocessableEntity` Client Error
      */
     createLoanTask: (
       loanId: string,
@@ -7699,7 +7781,7 @@ export class Api<
       data: UserLoanTaskRequest,
       params: RequestParams = {},
     ) =>
-      this.request<UserLoanTask, ProblemDetails>({
+      this.request<UserLoanTask, ProblemDetails | UnprocessableEntity>({
         path: `/api/loans/${loanId}/tasks/${taskId}`,
         method: "POST",
         body: data,
@@ -7719,13 +7801,14 @@ export class Api<
      * @secure
      * @response `201` `(UserLoanTask)[]` Created
      * @response `404` `ProblemDetails` Not Found
+     * @response `423` `UnprocessableEntity` Client Error
      */
     importLoanTask: (
       loanId: string,
       data: ImportUserLoanTaskRequest[],
       params: RequestParams = {},
     ) =>
-      this.request<UserLoanTask[], ProblemDetails>({
+      this.request<UserLoanTask[], ProblemDetails | UnprocessableEntity>({
         path: `/api/loans/${loanId}/tasks/import`,
         method: "POST",
         body: data,
@@ -9092,6 +9175,26 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags TheBigPOS
+     * @name IntegrationsLosLoansBucketsList
+     * @request GET:/api/integrations/los/loans/{loanID}/buckets
+     * @secure
+     * @response `200` `void` Success
+     */
+    integrationsLosLoansBucketsList: (
+      loanId: string,
+      params: RequestParams = {},
+    ) =>
+      this.request<void, any>({
+        path: `/api/integrations/los/loans/${loanId}/buckets`,
+        method: "GET",
+        secure: true,
+        ...params,
+      }),
+
     /**
      * No description
      *

package/tsconfig.json

@@ -1,27 +1,27 @@
-{
-  "compilerOptions": {
-    "target": "es6",
-    "module": "esnext",
-    "allowJs": true,
-    "sourceMap": true,
-    "outDir": "./dist",
-    "strict": true,
-    "moduleResolution": "node",
-    "baseUrl": "./",
-    "declaration": true,
-    "paths": {
-      "*": [
-        "node_modules/*"
-      ]
-    },
-    "typeRoots": [
-      "./node_modules/@types"
-    ],
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true
-  },
-  "include": ["./src/**/*"],
-  "exclude": ["./dist"]
-}
+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "esnext",
+    "allowJs": true,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "strict": true,
+    "moduleResolution": "node",
+    "baseUrl": "./",
+    "declaration": true,
+    "paths": {
+      "*": [
+        "node_modules/*"
+      ]
+    },
+    "typeRoots": [
+      "./node_modules/@types"
+    ],
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true
+  },
+  "include": ["./src/**/*"],
+  "exclude": ["./dist"]
+}