@matech/thebigpos-sdk 2.36.0 → 2.36.4

package/package.json

@@ -1,39 +1,39 @@
-{
-  "name": "@matech/thebigpos-sdk",
-  "version": "2.36.0",
-  "description": "The Big POS Typescript SDK",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "rimraf dist && tsc",
-    "test": "mocha -r ts-node/register 'src/api_test.spec.ts' --exit",
-    "browserify": "tsc && esbuild dist/index.js --bundle --minify --sourcemap --global-name=thebigpos --outfile=dist/thebigpos.min.js",
-    "prepare": "husky"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript.git"
-  },
-  "keywords": [
-    "pos",
-    "loans",
-    "mortgage",
-    "automation"
-  ],
-  "author": "Mortgage Automation Technologies",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript/issues"
-  },
-  "homepage": "https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript#readme",
-  "dependencies": {
-    "axios": "^1.13.5"
-  },
-  "devDependencies": {
-    "esbuild": "^0.27.0",
-    "husky": "^9.1.5",
-    "rimraf": "6.1.1",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.5.4"
-  }
-}
+{
+  "name": "@matech/thebigpos-sdk",
+  "version": "2.36.4",
+  "description": "The Big POS Typescript SDK",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "test": "mocha -r ts-node/register 'src/api_test.spec.ts' --exit",
+    "browserify": "tsc && esbuild dist/index.js --bundle --minify --sourcemap --global-name=thebigpos --outfile=dist/thebigpos.min.js",
+    "prepare": "husky"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript.git"
+  },
+  "keywords": [
+    "pos",
+    "loans",
+    "mortgage",
+    "automation"
+  ],
+  "author": "Mortgage Automation Technologies",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript/issues"
+  },
+  "homepage": "https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript#readme",
+  "dependencies": {
+    "axios": "^1.13.5"
+  },
+  "devDependencies": {
+    "esbuild": "^0.27.0",
+    "husky": "^9.1.5",
+    "rimraf": "6.1.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.4"
+  }
+}

package/scripts/apply-json-patch-content-type.js

@@ -1,56 +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 = 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.')
+/* 
+  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

@@ -184,7 +184,8 @@ export type LoanLogType =
   | "CoBorrowerAdded"
   | "TaskCompleted"
   | "LoanStatusChanged"
-  | "EConsent";
+  | "EConsent"
+  | "SensitiveDataPurge";
 
 export type LoanLienPosition = "First" | "Subordinate";
 
@@ -312,6 +313,17 @@ export type EntityType =
   | "LoanOfficer"
   | "Realtor";
 
+export type EncompassLogOutcome = "Success" | "Failure" | "PartialSuccess";
+
+export type EncompassLogOperationType =
+  | "FieldUpdate"
+  | "EConsentUpdate"
+  | "DocumentSync"
+  | "ApiError"
+  | "LoanCreation"
+  | "SlotCreation"
+  | "MilestoneUpdate";
+
 export type DraftType = "NewLoan" | "EditLoan";
 
 export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
@@ -1527,6 +1539,18 @@ export interface EncompassError {
   details?: string[] | null;
 }
 
+export interface EncompassLogSearchCriteria {
+  searchText?: string | null;
+  operationTypes?: EncompassLogOperationType[] | null;
+  outcomes?: EncompassLogOutcome[] | null;
+  /** @format date-time */
+  createdFrom?: string | null;
+  /** @format date-time */
+  createdTo?: string | null;
+  /** @format int32 */
+  httpStatusCode?: number | null;
+}
+
 export interface EncompassPackageItem {
   packageId: string;
   status: string;
@@ -1547,6 +1571,33 @@ export interface EncompassPackageList {
   totalPages: number;
 }
 
+export interface EncompassRequestLog {
+  /** @format uuid */
+  id: string;
+  losId?: string | null;
+  /** @format uuid */
+  accountId: string;
+  operationType: EncompassRequestLogOperationTypeEnum;
+  outcome: EncompassRequestLogOutcomeEnum;
+  message: string;
+  endpoint?: string | null;
+  httpMethod?: string | null;
+  /** @format int32 */
+  httpStatusCode?: number | null;
+  /** @format int64 */
+  durationMs?: number | null;
+  context?: any;
+  /** @format date-time */
+  createdAt: string;
+}
+
+export interface EncompassRequestLogPaginated {
+  rows: EncompassRequestLog[];
+  pagination: Pagination;
+  /** @format int64 */
+  count: number;
+}
+
 export interface Error {
   message: string;
 }
@@ -3906,7 +3957,7 @@ export interface NotificationTemplateVersionUpdateRequest {
 
 export interface Operation {
   op?: string;
-  value?: object | null;
+  value?: string | number | boolean | null | object;
   path?: string;
 }
 
@@ -5842,6 +5893,20 @@ export type DraftTypeEnum = "NewLoan" | "EditLoan";
 
 export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
 
+export type EncompassRequestLogOperationTypeEnum =
+  | "FieldUpdate"
+  | "EConsentUpdate"
+  | "DocumentSync"
+  | "ApiError"
+  | "LoanCreation"
+  | "SlotCreation"
+  | "MilestoneUpdate";
+
+export type EncompassRequestLogOutcomeEnum =
+  | "Success"
+  | "Failure"
+  | "PartialSuccess";
+
 export type FusionReportFilterFilterTypeEnum =
   | "DateGreaterThanOrEqualTo"
   | "DateGreaterThan"
@@ -5931,7 +5996,8 @@ export type LoanLogTypeEnum =
   | "CoBorrowerAdded"
   | "TaskCompleted"
   | "LoanStatusChanged"
-  | "EConsent";
+  | "EConsent"
+  | "SensitiveDataPurge";
 
 export type LoanUserLoanRoleEnum =
   | "Borrower"
@@ -6114,6 +6180,7 @@ export interface ApiConfig<SecurityDataType = unknown>
 }
 
 export enum ContentType {
+  JsonPatch = "application/json-patch+json",
   Json = "application/json",
   JsonApi = "application/vnd.api+json",
   FormData = "multipart/form-data",
@@ -6249,7 +6316,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v2.36.0
+ * @version v2.36.4
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -8505,7 +8572,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.Json,
+        type: ContentType.JsonPatchPatch,
         format: "json",
         ...params,
       }),
@@ -8615,7 +8682,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.Json,
+        type: ContentType.JsonPatchPatch,
         format: "json",
         ...params,
       }),
@@ -8642,7 +8709,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.Json,
+        type: ContentType.JsonPatchPatch,
         format: "json",
         ...params,
       }),
@@ -8884,7 +8951,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.Json,
+        type: ContentType.JsonPatchPatch,
         format: "json",
         ...params,
       }),
@@ -8964,7 +9031,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.Json,
+        type: ContentType.JsonPatchPatch,
         format: "json",
         ...params,
       }),
@@ -10484,6 +10551,25 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags LoanSensitiveDataPurge
+     * @name PurgeSensitiveLoanData
+     * @summary Manually trigger sensitive data purge for a specific loan
+     * @request POST:/api/loans/sensitive-data-purge/{loanId}
+     * @secure
+     * @response `204` `void` No Content
+     * @response `404` `ProblemDetails` Not Found
+     */
+    purgeSensitiveLoanData: (loanId: string, params: RequestParams = {}) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/loans/sensitive-data-purge/${loanId}`,
+        method: "POST",
+        secure: true,
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -10515,7 +10601,7 @@ export class Api<
         query: query,
         body: data,
         secure: true,
-        type: ContentType.Json,
+        type: ContentType.JsonPatchPatch,
         format: "json",
         ...params,
       }),
@@ -12230,6 +12316,39 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags TheBigPOS
+     * @name SearchEncompassLogs
+     * @request POST:/api/los/encompass/logs/{losId}/search
+     * @secure
+     * @response `200` `EncompassRequestLogPaginated` Success
+     */
+    searchEncompassLogs: (
+      losId: string,
+      query: {
+        /** @format int32 */
+        pageSize: number;
+        /** @format int32 */
+        pageNumber: number;
+        sortBy?: string;
+        sortDirection?: string;
+      },
+      data: EncompassLogSearchCriteria,
+      params: RequestParams = {},
+    ) =>
+      this.request<EncompassRequestLogPaginated, any>({
+        path: `/api/los/encompass/logs/${losId}/search`,
+        method: "POST",
+        query: query,
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...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"]
+}