@matech/thebigpos-sdk 3.3.1 → 3.4.0-stag-1921

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

@@ -1,149 +1,56 @@
-/*
-  Post-generation fixup for the generated TypeScript SDK.
+/* 
+  This script is meant to run after the SDK has been generated.
 
-  swagger-typescript-api does not propagate the `application/json-patch+json`
-  request content type into the generated code, so PATCH methods that use JSON
-  Patch would otherwise go out with the wrong Content-Type. This script restores
-  it by reading the OpenAPI spec the SDK was generated from and, for every
-  generated PATCH method, setting:
+  - 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.
 
-    - ContentType.JsonPatch  -> when the spec's requestBody for that path
-                                advertises application/json-patch+json
-    - ContentType.Json       -> for every other PATCH method
-                                (e.g. updateLoan, which the backend declares as
-                                [Consumes("application/json")])
-
-  The decision is taken entirely from the spec — there is no hard-coded list of
-  endpoints to keep in sync. It also ensures the ContentType enum includes
-  JsonPatch and relaxes the Operation interface `value` to accept any value.
-
-  Usage (pass the SAME spec given to `swagger-typescript-api -p`):
-    node scripts/apply-json-patch-content-type.js https://api.thebigpos.dev/swagger/<version>/swagger.json
-    node scripts/apply-json-patch-content-type.js ./swagger.json
-    SWAGGER_SPEC=<url-or-file> node scripts/apply-json-patch-content-type.js
-
-  Design notes:
-    - The rewrite is scoped to a single generated method block at a time
-      (anchored on that method's own `...params,`), so it can never bleed across
-      method boundaries.
-    - It sets each method's content type to its target value rather than doing a
-      conditional replace, so it is idempotent and self-healing (it also repairs
-      a previously-seen ContentType.JsonPatchPatch double-application).
-    - If no spec is provided (e.g. a plain commit-hook run), the content-type
-      rewrite is skipped instead of guessing, so it can never silently corrupt
-      the generated output.
+  This is necessary because the SDK generation does not currently handle these cases correctly.
 */
 
 const fs = require('fs')
-const nodePath = require('path')
 
-const SRC = nodePath.resolve(__dirname, '../src/index.ts')
+const path = require('path').resolve(__dirname, '../src/index.ts')
 
-async function loadSpec(source) {
-	if (!source) return null
-	if (/^https?:\/\//i.test(source)) {
-		const res = await fetch(source)
-		if (!res.ok) throw new Error(`Failed to fetch spec from "${source}": HTTP ${res.status}`)
-		return res.json()
-	}
-	return JSON.parse(fs.readFileSync(nodePath.resolve(source), 'utf8'))
-}
-
-// Collapse spec ("{id}") and generated ("${id}") path params to a common token
-// so generated paths can be matched against spec paths regardless of param names.
-function normalizePath(p) {
-	return p.replace(/\$\{[^}]+\}/g, '{}').replace(/\{[^}]+\}/g, '{}')
+if (!fs.existsSync(path)) {
+	console.error(`Error: File not found at path "${path}". Please ensure the SDK has been generated.`)
+	process.exit(1)
 }
-
-function jsonPatchPaths(spec) {
-	const set = new Set()
-	for (const [route, ops] of Object.entries(spec.paths || {})) {
-		const content = ops && ops.patch && ops.patch.requestBody && ops.patch.requestBody.content
-		if (content && Object.prototype.hasOwnProperty.call(content, 'application/json-patch+json')) {
-			set.add(normalizePath(route))
-		}
-	}
-	return set
+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)
 }
 
-function setContentType(block, member) {
-	const target = `type: ContentType.${member}`
-	if (/type:\s*ContentType\.\w+/.test(block)) return block.replace(/type:\s*ContentType\.\w+/, target)
-	if (/type:\s*"[^"]*"/.test(block)) return block.replace(/type:\s*"[^"]*"/, target)
-	if (/\n(\s*)format:/.test(block)) return block.replace(/\n(\s*)format:/, `\n$1${target},\n$1format:`)
-	return block.replace(/\n(\s*)\.\.\.params,/, `\n$1${target},\n$1...params,`)
-}
+// 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')
+)
 
-function ensureJsonPatchEnum(content) {
-	return content.replace(/export enum ContentType\s*{([\s\S]*?)}/, (match, enumBody) => {
+// 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
-		return `export enum ContentType {\n  JsonPatch = "application/json-patch+json",\n  ${enumBody.trim()}\n}`
-	})
-}
+		const insertion = `  JsonPatch = "application/json-patch+json",\n  `
+		return `export enum ContentType {\n${insertion}${enumBody.trim()}\n}`
+	}
+)
 
-function relaxOperationValue(content) {
-	return content.replace(/export interface Operation\s*{([\s\S]*?)}/, (match, body) => {
+// 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}`
-	})
-}
-
-function applyContentTypes(content, patchPaths) {
-	// Heal any earlier double-application (ContentType.JsonPatchPatch...).
-	content = content.replace(/ContentType\.JsonPatch(?:Patch)+\b/g, 'ContentType.JsonPatch')
-
-	const METHOD_BLOCK = /[a-zA-Z0-9_]+:\s*\([\s\S]*?\)\s*=>\s*this\.request<[^>]*>\(\{[\s\S]*?\.\.\.params,/g
-	return content.replace(METHOD_BLOCK, (block) => {
-		if (!/method:\s*"PATCH"/.test(block)) {
-			// Non-PATCH methods must never be JSON Patch.
-			return /type:\s*ContentType\.JsonPatch\b/.test(block)
-				? block.replace(/type:\s*ContentType\.JsonPatch\b/, 'type: ContentType.Json')
-				: block
-		}
-		const routeMatch = block.match(/path:\s*`([^`]*)`/)
-		const route = routeMatch ? normalizePath(routeMatch[1]) : ''
-		return setContentType(block, patchPaths.has(route) ? 'JsonPatch' : 'Json')
-	})
-}
-
-;(async () => {
-	if (!fs.existsSync(SRC)) {
-		console.error(`Error: File not found at "${SRC}". Generate the SDK first.`)
-		process.exit(1)
-	}
-
-	const source = process.argv[2] || process.env.SWAGGER_SPEC || process.env.SWAGGER_URL
-	let spec
-	try {
-		spec = await loadSpec(source)
-	} catch (err) {
-		console.error(`Error loading OpenAPI spec: ${err.message}`)
-		process.exit(1)
 	}
+)
 
-	let content = fs.readFileSync(SRC, 'utf8')
-	content = ensureJsonPatchEnum(content)
-	content = relaxOperationValue(content)
-
-	if (!spec) {
-		console.warn(
-			'No OpenAPI spec provided (argument / SWAGGER_SPEC / SWAGGER_URL) — skipping PATCH content-type rewrite.\n' +
-				'Re-run with the spec used for generation to apply it, e.g.:\n' +
-				'  node scripts/apply-json-patch-content-type.js https://api.thebigpos.dev/swagger/<version>/swagger.json'
-		)
-		fs.writeFileSync(SRC, content)
-		return
-	}
-
-	const patchPaths = jsonPatchPaths(spec)
-	content = applyContentTypes(content, patchPaths)
-
-	fs.writeFileSync(SRC, content)
-	console.log(`SDK patch complete: PATCH content types set from the OpenAPI spec (${patchPaths.size} json-patch endpoint(s)).`)
-})().catch((err) => {
-	console.error(err)
-	process.exit(1)
-})
+fs.writeFileSync(path, content)
+console.log('SDK patch complete: All PATCH methods now use ContentType.JsonPatch.')

package/src/index.ts

@@ -111,6 +111,13 @@ export type LoanRole =
   | "SettlementAgent"
   | "Admin";
 
+export type LoanRefinancePurpose =
+  | "CashOutDebtConsolidation"
+  | "CashOutHomeImprovement"
+  | "CashOutOther"
+  | "NoCashOut"
+  | "LimitedCashOut";
+
 export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell" | "PendingSale";
 
 export type LoanRealEstateOccupancyType =
@@ -530,7 +537,7 @@ export type CompanyDocumentIndexStatus =
 
 export type ClassificationSource = "Textract" | "Llm" | "Manual";
 
-export type BulkLoanTaskOperationType = "SetStatus";
+export type BulkLoanTaskOperationType = "SetStatus" | "Delete";
 
 export type BranchType = "Mortgage" | "RealEstate";
 
@@ -986,6 +993,9 @@ export interface AiAuditLog {
   /** @format uuid */
   messageId?: string | null;
   eventType: AiAuditLogEventTypeEnum;
+  trigger?: string | null;
+  subjectTaskName?: string | null;
+  subjectLoanNumber?: string | null;
   modelId?: string | null;
   /** @format int32 */
   inputTokens?: number | null;
@@ -1668,23 +1678,6 @@ export interface BranchUserPaginated {
   count: number;
 }
 
-export interface BulkCompleteLoanTaskFailure {
-  /** @format uuid */
-  userLoanTaskID: string;
-  taskName: string;
-  errorMessage: string;
-}
-
-export interface BulkCompleteLoanTasks {
-  completed: string[];
-  skipped: string[];
-  failed: BulkCompleteLoanTaskFailure[];
-}
-
-export interface BulkCompleteLoanTasksRequest {
-  userLoanTaskIDs: string[];
-}
-
 export interface BulkLoanTaskFailure {
   /** @format uuid */
   userLoanTaskID: string;
@@ -3400,6 +3393,7 @@ export interface Loan {
   propertyAddress?: Address | null;
   property?: LoanProperty | null;
   financial?: LoanFinancial | null;
+  refinance?: LoanRefinance | null;
   financialTerms?: LoanFinancialTerms | null;
   monthlyPayment?: LoanMonthlyPayment | null;
   costDetails?: LoanCostDetails | null;
@@ -3427,6 +3421,7 @@ export interface LoanApplication {
   startDate?: string | null;
   property?: LoanProperty | null;
   financial?: LoanFinancial | null;
+  refinance?: LoanRefinance | null;
   borrowers: LoanBorrower[];
   nonOwningBorrowers: LoanNonOwningBorrower[];
 }
@@ -3444,6 +3439,7 @@ export interface LoanApplicationRequest {
   companyName?: string | null;
   property?: LoanPropertyRequest | null;
   financial?: LoanFinancialRequest | null;
+  refinance?: LoanRefinanceRequest | null;
   financialTerms?: LoanFinancialTermsRequest | null;
   monthlyPayment?: LoanMonthlyPaymentRequest | null;
   borrowers: LoanBorrowerRequest[];
@@ -3511,6 +3507,7 @@ export interface LoanBorrowerAccountAsset {
 
 export interface LoanBorrowerAccountAssetRequest {
   name?: string | null;
+  accountNumber?: string | null;
   financialInstitution?: string | null;
   /** @format double */
   value?: number | null;
@@ -4953,8 +4950,55 @@ export interface LoanRecord {
   loanFields: Record<string, string>;
 }
 
+export interface LoanRefinance {
+  /** @format uuid */
+  id?: string | null;
+  /** @format int32 */
+  yearAcquired?: number | null;
+  /** @format double */
+  valueOfLot?: number | null;
+  /** @format double */
+  originalCost?: number | null;
+  /** @format double */
+  existingLiens?: number | null;
+  /** @format double */
+  costOfImprovements?: number | null;
+  purpose?: LoanRefinancePurpose | null;
+  currentLoan?: LoanRefinanceCurrentLoan | null;
+}
+
+export interface LoanRefinanceCurrentLoan {
+  /** @format uuid */
+  id?: string | null;
+  lender?: string | null;
+  /** @format double */
+  interestRate?: number | null;
+  /** @format double */
+  monthlyPayment?: number | null;
+  /** @format double */
+  remainingBalance?: number | null;
+  loanType?: LoanType | null;
+}
+
+export interface LoanRefinanceCurrentLoanRequest {
+  lender?: string | null;
+  /** @format double */
+  interestRate?: number | null;
+  loanType?: LoanType | null;
+}
+
+export interface LoanRefinanceRequest {
+  /** @format double */
+  originalCost?: number | null;
+  /** @format double */
+  existingLiens?: number | null;
+  purpose?: LoanRefinancePurpose | null;
+  currentLoan?: LoanRefinanceCurrentLoanRequest | null;
+}
+
 export interface LoanSearchCriteria {
   searchText?: string | null;
+  searchTerms?: string[] | null;
   /** @format uuid */
   loanOfficerId?: string | null;
   loanNumber?: string | null;
@@ -7564,6 +7608,8 @@ export interface UserTableSettings {
   columnOrder: string[];
   sortColumnId?: string | null;
   sortDirection?: SortDirection | null;
+  searchTerms: string[];
+  pinnedColumnIds: string[];
 }
 
 export interface UserTableSettingsRequest {
@@ -7571,6 +7617,8 @@ export interface UserTableSettingsRequest {
   columnOrder: string[];
   sortColumnId?: string | null;
   sortDirection?: SortDirection | null;
+  searchTerms: string[];
+  pinnedColumnIds: string[];
 }
 
 export interface VerifyEmailRequest {
@@ -8575,7 +8623,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v3.3.1
+ * @version v3.4.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -9193,7 +9241,7 @@ export class Api<
       }),
 
     /**
-     * No description
+     * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
      *
      * @tags AiAudit
      * @name GetAiAuditLogs
@@ -9224,6 +9272,8 @@ export class Api<
         pageNumber?: number;
         sortBy?: string;
         sortDirection?: string;
+        eventTypes?: AiAuditEventType[];
+        trigger?: string;
       },
       params: RequestParams = {},
     ) =>
@@ -9264,7 +9314,7 @@ export class Api<
       }),
 
     /**
-     * No description
+     * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
      *
      * @tags AiAudit
      * @name GetAiAuditConversations
@@ -9301,7 +9351,7 @@ export class Api<
       }),
 
     /**
-     * No description
+     * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
      *
      * @tags AiAudit
      * @name GetAiStats
@@ -9331,7 +9381,7 @@ export class Api<
       }),
 
     /**
-     * No description
+     * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
      *
      * @tags AiAudit
      * @name GetAiConfigChanges
@@ -10442,7 +10492,7 @@ export class Api<
       }),
 
     /**
-     * No description
+     * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
      *
      * @tags AuditLog
      * @name SearchAuditLogs
@@ -14319,9 +14369,10 @@ export class Api<
      * @request POST:/api/listings
      * @secure
      * @response `201` `Listing` Created
+     * @response `403` `ProblemDetails` Forbidden
      */
     createListing: (data: ListingRequest, params: RequestParams = {}) =>
-      this.request<Listing, any>({
+      this.request<Listing, ProblemDetails>({
         path: `/api/listings`,
         method: "POST",
         body: data,
@@ -14378,13 +14429,14 @@ export class Api<
      * @request PUT:/api/listings/{id}
      * @secure
      * @response `200` `Listing` OK
+     * @response `403` `ProblemDetails` Forbidden
      */
     replaceListing: (
       id: string,
       data: ListingRequest,
       params: RequestParams = {},
     ) =>
-      this.request<Listing, any>({
+      this.request<Listing, ProblemDetails>({
         path: `/api/listings/${id}`,
         method: "PUT",
         body: data,
@@ -16320,36 +16372,6 @@ export class Api<
         ...params,
       }),
 
-    /**
-     * @description Deprecated - use POST api/loans/tasks/bulk, which reaches every status and accepts tasks from more than one loan.
-     *
-     * @tags LoanTaskBulkCompletions
-     * @name BulkCompleteLoanTasks
-     * @summary [Deprecated] Bulk complete loan tasks
-     * @request POST:/api/loans/{loanID}/tasks/bulk-complete
-     * @deprecated
-     * @secure
-     * @response `200` `BulkCompleteLoanTasks` OK
-     * @response `404` `ProblemDetails` Not Found
-     * @response `422` `UnprocessableEntity` Unprocessable Content
-     */
-    bulkCompleteLoanTasks: (
-      loanId: string,
-      data: BulkCompleteLoanTasksRequest,
-      params: RequestParams = {},
-    ) =>
-      this.request<BulkCompleteLoanTasks, ProblemDetails | UnprocessableEntity>(
-        {
-          path: `/api/loans/${loanId}/tasks/bulk-complete`,
-          method: "POST",
-          body: data,
-          secure: true,
-          type: "application/json",
-          format: "json",
-          ...params,
-        },
-      ),
-
     /**
      * No description
      *

package/docs/sdk_generation.md

@@ -1,149 +0,0 @@
-# Publishing the POS Typescript SDK
-
-## Prerequisites
-
-1. Clone the repository (if you haven't already):
-
-```bash
-git clone https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript
-cd thebigpos-sdk-typescript
-```
-
-2. Install swagger-typescript-api globally:
-
-```bash
-npm i -g swagger-typescript-api
-```
-
-3. Connect to the MAT VPN
-
-## Step 1: Create a release branch
-
-Create a new branch for the version you're releasing:
-
-```bash
-git checkout develop
-git pull origin develop
-git checkout -b release/X.Y.Z
-```
-
-## Step 2: Generate the SDK
-
-Replace `{version}` with the target API version (e.g., `v2.31.0`):
-
-```bash
-npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/{version}/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --generate-union-enums
-```
-
-> **Note:** If generating locally, use `http://localhost:5212/swagger/{version}/swagger.json` due to self-signed cert issues with https.
-
-## Step 3: Apply post-generation fixes
-
-Run the script to fix PATCH methods content type and Operation interface:
-
-```bash
-node scripts/apply-json-patch-content-type.js
-```
-
-This script:
-- Sets all PATCH methods to use `ContentType.JsonPatch`
-- Adds `JsonPatch` to the `ContentType` enum
-- Fixes the `Operation` interface to allow any value type
-
-## Step 4: Update the version
-
-Use npm's version command to update the version in `package.json`:
-
-```bash
-npm version X.Y.Z
-```
-
-**Version conventions:**
-
-- Match the SDK version to the API version being released
-- For release candidates (pre-release), use: `npm version X.Y.Z-rc.N --preid=rc`
-- For patch increments: `npm version patch`
-- For minor increments: `npm version minor`
-
-## Step 5: Build the SDK
-
-```bash
-npm run build
-```
-
-Ensure there are no TypeScript compilation errors.
-
-## Step 6: Merge develop (if needed)
-
-If there are changes in develop that need to be included:
-
-```bash
-git fetch origin develop
-git merge origin/develop
-```
-
-If there are conflicts in `src/index.ts` or `dist/*`, regenerate the SDK (Step 2), apply fixes (Step 3), and rebuild (Step 5) to resolve them.
-
-## Step 7: Commit and push
-
-```bash
-git add .
-git commit -m "X.Y.Z"
-git push -u origin release/X.Y.Z
-```
-
-## Step 8: Publish to NPM
-
-### Authentication
-
-NPM requires a granular access token with publish permissions and 2FA bypass enabled.
-
-1. Go to [npmjs.com](https://www.npmjs.com) > Access Tokens > Generate New Token
-2. Select "Granular Access Token"
-3. Enable "Bypass 2FA for automation"
-4. Set permissions to publish to `@matech/thebigpos-sdk`
-
-Configure the token:
-
-```bash
-npm config set //registry.npmjs.org/:_authToken YOUR_TOKEN
-```
-
-### Publish
-
-**To latest (stable release):**
-
-```bash
-npm publish --access public
-```
-
-**To next (pre-release):**
-
-```bash
-npm publish --tag next
-```
-
-**To a feature tag (for testing):**
-
-```bash
-npm publish --tag feature-name
-```
-
-### Installing the SDK
-
-```bash
-# Latest stable
-yarn add @matech/thebigpos-sdk
-
-# Next pre-release
-yarn add @matech/thebigpos-sdk@next
-
-# Specific version
-yarn add @matech/thebigpos-sdk@X.Y.Z
-```
-
-## Step 9: Clean up
-
-1. **Revoke the NPM token** after publishing for security
-2. **Create a Pull Request** from `release/X.Y.Z` to `develop` and `main`
-3. **Create a GitHub Release** with release notes