@matech/thebigpos-sdk 3.28.0 → 3.29.0-dev-8593

package/package.json

@@ -1,12 +1,19 @@
 {
   "name": "@matech/thebigpos-sdk",
-  "version": "3.28.0",
+  "version": "3.29.0-dev-8593",
   "description": "The Big POS Typescript SDK",
-  "main": "dist/index.js",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "react-native": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "index.js"
+  ],
   "scripts": {
-    "build": "rimraf dist && tsc",
-    "test": "mocha -r ts-node/register 'src/api_test.spec.ts' --exit",
+    "build": "rimraf dist && tsc && esbuild dist/index.js --format=cjs --platform=node --packages=external --sourcemap --outfile=dist/index.cjs",
+    "postbuild": "node -e \"if (typeof require('./').Api !== 'function') { console.error('Smoke check failed: the CommonJS entry does not export Api'); process.exit(1) }\"",
     "browserify": "tsc && esbuild dist/index.js --bundle --minify --sourcemap --global-name=thebigpos --outfile=dist/thebigpos.min.js",
     "prepare": "husky"
   },
@@ -26,15 +33,22 @@
     "url": "https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript/issues"
   },
   "homepage": "https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript#readme",
-  "dependencies": {
-    "axios": "^1.7.7"
+  "engines": {
+    "node": ">=18"
+  },
+  "peerDependencies": {
+    "axios": "^1"
   },
   "devDependencies": {
-    "esbuild": "^0.27.0",
+    "axios": "^1.20.0",
+    "esbuild": "^0.28.1",
     "husky": "^9.1.5",
-    "rimraf": "6.1.1",
-    "ts-node": "^10.9.2",
+    "rimraf": "6.1.4",
     "typescript": "^5.5.4"
   },
-  "swaggerSha256": "8361d7b583d417c35a6cfe67414057bd29adf98e11084504c6616b1981e9096c"
+  "resolutions": {
+    "brace-expansion": "^5.0.12",
+    "follow-redirects": "^1.16.1"
+  },
+  "swaggerSha256": "abd810870c9944c879fd04fcf3a53c70bd11aef85ad115d97b24f35f769b88e4"
 }

package/src/index.ts

@@ -110,7 +110,13 @@ export type LosCredentialHealthStatus =
 
 export type LogLevel = "None" | "Info" | "Warning" | "Error";
 
-export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
+export type LoanType =
+  | "Fha"
+  | "Conventional"
+  | "UsdaRd"
+  | "Va"
+  | "Other"
+  | "Heloc";
 
 export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
 
@@ -461,11 +467,7 @@ export type LoanDocumentType =
 
 export type LoanDocumentFolderScope = "Any" | "Assigned" | "Unassigned";
 
-export type LoanDocumentFolderPermissionLevel =
-  | "None"
-  | "Read"
-  | "Write"
-  | "Manage";
+export type LoanDocumentFolderPermissionLevel = "None" | "Read" | "Write";
 
 export type LoanCitizenship =
   | "USCitizen"
@@ -825,6 +827,8 @@ export type AddressFamily =
   | "ControllerAreaNetwork"
   | "Unknown";
 
+export type AccountPartnerStatus = "Active" | "Invited";
+
 export type CanvasWidgetConfig = BaseCanvasWidgetConfig &
   (
     | BaseCanvasWidgetConfigTypeMapping<"Information", InformationWidgetConfig>
@@ -937,6 +941,32 @@ export interface AccountFailureCount {
   count: number;
 }
 
+export interface AccountPartner {
+  /** @format uuid */
+  partnerProfileID?: string | null;
+  /** @format uuid */
+  partnerID?: string | null;
+  firstName: string;
+  lastName: string;
+  email: string;
+  phone?: string | null;
+  status: AccountPartnerStatusEnum;
+  tier: AccountPartnerTierEnum;
+  /** @format date-time */
+  createdAt: string;
+}
+
+export interface AccountPartnerPaginated {
+  rows: AccountPartner[];
+  pagination: Pagination;
+  /** @format int64 */
+  count: number;
+}
+
+export interface AccountPartnerSearchCriteria {
+  searchText?: string | null;
+}
+
 export interface AccountSettings {
   isSmsEnabled: boolean;
   smsNumber?: string | null;
@@ -4038,8 +4068,11 @@ export interface LoanApplicationRequest {
   userID: string;
   /** @format uuid */
   siteConfigurationID: string;
+  /** @format uuid */
+  submissionKey?: string | null;
   loanOfficerEmail?: string | null;
   purpose?: LoanPurpose | null;
+  type?: LoanType | null;
   referrer?: string | null;
   companyName?: string | null;
   relationship?: BorrowerRelationship | null;
@@ -6324,6 +6357,17 @@ export interface MyPartner {
   createdAt: string;
 }
 
+export interface MyPartnerPaginated {
+  rows: MyPartner[];
+  pagination: Pagination;
+  /** @format int64 */
+  count: number;
+}
+
+export interface MyPartnerSearchCriteria {
+  searchText?: string | null;
+}
+
 export type MyTasksWidgetConfig = UtilRequiredKeys<
   BaseCanvasWidgetConfig,
   "type"
@@ -8223,6 +8267,13 @@ export interface UpdatePartnerPortalRequest {
   isEnabled?: boolean | null;
 }
 
+export interface UpdatePartnerRequest {
+  firstName: string;
+  lastName: string;
+  email: string;
+  phone?: string | null;
+}
+
 export interface UpdateUserGroupRequest {
   name: string;
   description?: string | null;
@@ -8826,6 +8877,10 @@ type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
 
 export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
 
+export type AccountPartnerStatusEnum = "Active" | "Invited";
+
+export type AccountPartnerTierEnum = "Lite" | "LitePlusPortal" | "Pending";
+
 export type AdminAccessUserMfaFactorEnum = "None" | "Sms" | "Email";
 
 export type AiAccessReadAloudVoiceEnum =
@@ -9402,11 +9457,7 @@ export type LoanDocumentFolderPermissionRoleEnum =
   | "SettlementAgent"
   | "Admin";
 
-export type LoanDocumentFolderPermissionLevelEnum =
-  | "None"
-  | "Read"
-  | "Write"
-  | "Manage";
+export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write";
 
 export type LoanDocumentFolderPermissionReadScopeEnum = "Own" | "All";
 
@@ -9428,8 +9479,7 @@ export type LoanDocumentFolderPermissionFilterRoleEnum =
 export type LoanDocumentFolderPermissionFilterMinimumPermissionLevelEnum =
   | "None"
   | "Read"
-  | "Write"
-  | "Manage";
+  | "Write";
 
 export type LoanDocumentFolderPermissionRequestRoleEnum =
   | "Borrower"
@@ -9449,16 +9499,14 @@ export type LoanDocumentFolderPermissionRequestRoleEnum =
 export type LoanDocumentFolderPermissionRequestLevelEnum =
   | "None"
   | "Read"
-  | "Write"
-  | "Manage";
+  | "Write";
 
 export type LoanDocumentFolderPermissionRequestReadScopeEnum = "Own" | "All";
 
 export type LoanDocumentFolderWithCountAccessLevelEnum =
   | "None"
   | "Read"
-  | "Write"
-  | "Manage";
+  | "Write";
 
 export type LoanFieldAccessRoleEnum =
   | "Borrower"
@@ -10152,7 +10200,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),
@@ -10214,7 +10270,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v3.28.0
+ * @version v3.29.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -10346,6 +10402,141 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * @description Every partner of the caller's account: Realtors with an account and pending partners who have not signed up yet
+     *
+     * @tags AccountPartners
+     * @name SearchAccountPartners
+     * @summary Search Account Partners
+     * @request POST:/api/account/partners/search
+     * @secure
+     * @response `200` `AccountPartnerPaginated` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `422` `ProblemDetails` Unprocessable Content
+     */
+    searchAccountPartners: (
+      data: AccountPartnerSearchCriteria,
+      query?: {
+        /** @format int32 */
+        pageSize?: number;
+        /** @format int32 */
+        pageNumber?: number;
+        sortBy?: string;
+        sortDirection?: string;
+      },
+      params: RequestParams = {},
+    ) =>
+      this.request<AccountPartnerPaginated, ProblemDetails>({
+        path: `/api/account/partners/search`,
+        method: "POST",
+        query: query,
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * @description Makes a settlement agent, by user ID or by an open invite's ID, a partner with no loan officer
+     *
+     * @tags AccountPartners
+     * @name PromotePartner
+     * @summary Promote To Partner
+     * @request POST:/api/account/partners/promotions
+     * @secure
+     * @response `200` `PromotePartner` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     * @response `422` `ProblemDetails` Unprocessable Content
+     */
+    promotePartner: (data: PromotePartnerRequest, params: RequestParams = {}) =>
+      this.request<PromotePartner, ProblemDetails>({
+        path: `/api/account/partners/promotions`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * @description Changes a registered partner's name, sign-in email and phone
+     *
+     * @tags AccountPartners
+     * @name ReplacePartner
+     * @summary Replace Partner
+     * @request PUT:/api/account/partners/{partnerProfileId}
+     * @secure
+     * @response `204` `void` No Content
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     * @response `422` `ProblemDetails` Unprocessable Content
+     */
+    replacePartner: (
+      partnerProfileId: string,
+      data: UpdatePartnerRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/account/partners/${partnerProfileId}`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: "application/json",
+        ...params,
+      }),
+
+    /**
+     * @description Makes a registered partner a settlement agent again and retires their partner profile; their account and loans stay
+     *
+     * @tags AccountPartners
+     * @name DemotePartner
+     * @summary Demote Partner
+     * @request POST:/api/account/partners/{partnerProfileId}/demote
+     * @secure
+     * @response `204` `void` No Content
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     */
+    demotePartner: (partnerProfileId: string, params: RequestParams = {}) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/account/partners/${partnerProfileId}/demote`,
+        method: "POST",
+        secure: true,
+        ...params,
+      }),
+
+    /**
+     * @description Cancels a pending partner's invites and retires their partner profile; inviting the email again restores it
+     *
+     * @tags AccountPartners
+     * @name CancelPartnerInvite
+     * @summary Cancel Partner Invite
+     * @request POST:/api/account/partners/{partnerProfileId}/cancel
+     * @secure
+     * @response `204` `void` No Content
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     */
+    cancelPartnerInvite: (
+      partnerProfileId: string,
+      params: RequestParams = {},
+    ) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/account/partners/${partnerProfileId}/cancel`,
+        method: "POST",
+        secure: true,
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -15634,6 +15825,7 @@ export class Api<
      * @request POST:/api/los/loan/application/internal
      * @secure
      * @response `200` `string` OK
+     * @response `409` `ProblemDetails` Conflict
      * @response `422` `UnprocessableEntity` Unprocessable Content
      * @response `423` `UnprocessableEntity` Locked
      */
@@ -15645,7 +15837,7 @@ export class Api<
       },
       params: RequestParams = {},
     ) =>
-      this.request<string, UnprocessableEntity>({
+      this.request<string, ProblemDetails | UnprocessableEntity>({
         path: `/api/los/loan/application/internal`,
         method: "POST",
         query: query,
@@ -18390,6 +18582,7 @@ export class Api<
      * @response `401` `ProblemDetails` Unauthorized
      * @response `403` `ProblemDetails` Forbidden
      * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
      */
     createLoanv3: (
       data: LoanApplicationRequest,
@@ -23123,6 +23316,41 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * @description Searches the rows getMyPartners returns by first name, last name, full name or email, and pages them. Sorts by firstName, lastName, email, tier or createdAt when both sortBy and sortDirection are given, else newest first
+     *
+     * @tags UsersMe
+     * @name SearchMyPartners
+     * @summary Search My Partners
+     * @request POST:/api/users/me/partners/search
+     * @secure
+     * @response `200` `MyPartnerPaginated` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `403` `ProblemDetails` Forbidden
+     */
+    searchMyPartners: (
+      data: MyPartnerSearchCriteria,
+      query?: {
+        /** @format int32 */
+        pageSize?: number;
+        /** @format int32 */
+        pageNumber?: number;
+        sortBy?: string;
+        sortDirection?: string;
+      },
+      params: RequestParams = {},
+    ) =>
+      this.request<MyPartnerPaginated, ProblemDetails>({
+        path: `/api/users/me/partners/search`,
+        method: "POST",
+        query: query,
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
     /**
      * @description Adds a partner, by partner profile ID, to the loan officer's list; a pending partner can be added too
      *

package/.husky/pre-commit

@@ -1,3 +0,0 @@
-[ -f ./src/index.ts ] && node scripts/apply-json-patch-content-type.js
-yarn build
-git add .

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

@@ -1,56 +0,0 @@
-/* 
-  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/tsconfig.json

@@ -1,27 +0,0 @@
-{
-  "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"]
-}