@matech/thebigpos-sdk 2.40.0-rc.2 → 2.40.0

package/.claude/settings.local.json

@@ -1,17 +1,50 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(npx swagger-typescript-api:*)",
-      "Bash(node:*)",
-      "Bash(npm version:*)",
-      "Bash(git commit:*)",
-      "Bash(npm run:*)",
-      "Bash(git push:*)",
-      "Bash(npm config:*)",
-      "Bash(npm publish:*)",
-      "Bash(npm whoami *)",
-      "Bash(npm view *)",
-      "Bash(git tag *)"
-    ]
-  }
-}
+{
+  "permissions": {
+    "allow": [
+      "Bash(yarn list:*)",
+      "Bash(npm ls:*)",
+      "Bash(npm view:*)",
+      "Bash(yarn audit:*)",
+      "Bash(yarn upgrade:*)",
+      "WebFetch(domain:github.com)",
+      "Bash(git push:*)",
+      "Bash(gh pr create:*)",
+      "Bash(git checkout:*)",
+      "Bash(git commit:*)",
+      "Bash(git reset:*)",
+      "Bash(git add:*)",
+      "Bash(git branch:*)",
+      "Bash(yarn install:*)",
+      "Bash(yarn build:*)",
+      "Bash(git rm:*)",
+      "Bash(node scripts/apply-json-patch-content-type.js)",
+      "Bash(git worktree:*)",
+      "Bash(gh pr:*)",
+      "Bash(cp /tmp/index_main.ts src/index.ts)",
+      "Bash(cp /tmp/dist_main.js dist/index.js)",
+      "Bash(cp /tmp/dist_main.js.map dist/index.js.map)",
+      "Bash(yarn why:*)",
+      "Bash(python3:*)",
+      "Bash(git restore:*)",
+      "Bash(curl -s -o /tmp/swagger-check.txt -w \"HTTP: %{http_code}\\\\nSize: %{size_download} bytes\\\\nContent-Type: %{content_type}\\\\nRedirect: %{redirect_url}\\\\n\" \"https://api.thebigpos.dev/swagger/v2.38.1/swagger.json\")",
+      "Read(//tmp/**)",
+      "Bash(curl -s -w \"\\\\nHTTP: %{http_code}\\\\n\" \"https://api.thebigpos.dev/swagger/index.html\")",
+      "Bash(curl -s -w \"\\\\nHTTP: %{http_code}\\\\n\" \"https://api.thebigpos.dev/swagger/v1/swagger.json\")",
+      "Bash(curl -s \"https://api.thebigpos.dev/swagger/index.html\")",
+      "Bash(curl -s -w \"\\\\nHTTP:%{http_code}\\\\n\" \"https://api.thebigpos.dev/swagger/v1/swagger/swagger-ui-config.json\")",
+      "Bash(curl -s -o /dev/null -w '%{http_code}' https://api.thebigpos.dev/swagger/__TRACKED_VAR__/swagger.json)",
+      "Bash(sed 's/authToken=.*/authToken=REDACTED/; s/_auth=.*/_auth=REDACTED/')",
+      "Bash(curl -s -o /dev/null -w \"npm registry @matech/thebigpos-sdk: HTTP %{http_code}\\\\n\" \"https://registry.npmjs.org/@matech%2Fthebigpos-sdk\")",
+      "Bash(curl -s -o /dev/null -w \"yarn registry @matech/thebigpos-sdk: HTTP %{http_code}\\\\n\" \"https://registry.yarnpkg.com/@matech%2Fthebigpos-sdk\")",
+      "Bash(npm config:*)",
+      "Bash(curl -s \"https://registry.npmjs.org/@matech%2Fthebigpos-sdk\")",
+      "Bash(npm whoami:*)",
+      "Bash(awk -F= '/authToken/{t=$NF; print \"token length:\", length\\(t\\); print \"token prefix:\", substr\\(t,1,4\\)\"…\"}' '~/.npmrc')",
+      "Bash(awk -F= '/authToken/{print $NF}' '~/.npmrc')",
+      "Bash(curl -s -o /dev/null -w 'whoami via token: HTTP %{http_code}\\\\n' -H 'Authorization: Bearer __TRACKED_VAR__' https://registry.npmjs.org/-/whoami)",
+      "Bash(curl -s -H 'Authorization: Bearer __TRACKED_VAR__' https://registry.npmjs.org/-/whoami)",
+      "Skill(dev:open-pr)",
+      "Bash(git pull:*)"
+    ]
+  }
+}

package/.husky/pre-commit

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

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Mortgage Automation Technologies
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Mortgage Automation Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,73 +1,73 @@
-# The BIG POS Typescript SDK
-
-## Installation
-Using npm:
-
-```bash
-$ npm install @matech/thebigpos-sdk
-```
-
-Using yarn:
-
-```bash
-$ yarn add @matech/thebigpos-sdk
-```
-
-## Quick Start
-```js
-import { Api } from "@matech/thebigpos-sdk";
-
-const securityWorker = (data: any) => {
-    return { headers: data }
-}
-
-const setBearerSecurityWorker = (accessToken:string) => {
-    const data = {
-        Authorization: `Bearer ${accessToken}`
-    };
-
-    apiClient.setSecurityData(data);
-};
-
-const apiClient = new Api({
-    baseURL:
-        process.env.REACT_APP_POS_API_HOST || 'https://api.thebigpos.com',
-    securityWorker,
-})
-
-apiClient.api.getSiteConfiguration().then((response) => {
-    console.log(response.data);
-});
-```
-
-## Generate SDK from Swagger
-
-To regenerate the SDK from a specific API version, run:
-
-```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
-```
-
-Replace `{version}` with the target API version (e.g. `v2.34.0`):
-
-```bash
-npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/v2.34.0/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --generate-union-enums
-```
-
-## Publishing
-
-1. Update the `version` field in `package.json` before publishing.
-2. Build the project:
-
-```bash
-yarn build
-```
-
-3. Publish to npm:
-
-```bash
-yarn publish
-```
-
-____
-© 2024 Mortgage Automation Technologies. All rights reserved
+# The BIG POS Typescript SDK
+
+## Installation
+Using npm:
+
+```bash
+$ npm install @matech/thebigpos-sdk
+```
+
+Using yarn:
+
+```bash
+$ yarn add @matech/thebigpos-sdk
+```
+
+## Quick Start
+```js
+import { Api } from "@matech/thebigpos-sdk";
+
+const securityWorker = (data: any) => {
+    return { headers: data }
+}
+
+const setBearerSecurityWorker = (accessToken:string) => {
+    const data = {
+        Authorization: `Bearer ${accessToken}`
+    };
+
+    apiClient.setSecurityData(data);
+};
+
+const apiClient = new Api({
+    baseURL:
+        process.env.REACT_APP_POS_API_HOST || 'https://api.thebigpos.com',
+    securityWorker,
+})
+
+apiClient.api.getSiteConfiguration().then((response) => {
+    console.log(response.data);
+});
+```
+
+## Generate SDK from Swagger
+
+To regenerate the SDK from a specific API version, run:
+
+```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
+```
+
+Replace `{version}` with the target API version (e.g. `v2.34.0`):
+
+```bash
+npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/v2.34.0/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --generate-union-enums
+```
+
+## Publishing
+
+1. Update the `version` field in `package.json` before publishing.
+2. Build the project:
+
+```bash
+yarn build
+```
+
+3. Publish to npm:
+
+```bash
+yarn publish
+```
+
+____
+© 2024 Mortgage Automation Technologies. All rights reserved

package/dist/index.d.ts

@@ -142,7 +142,7 @@ export interface Action {
     comments?: string | null;
     /** @format uuid */
     siteConfigurationID: string;
-    applicationSettings?: any;
+    applicationSettings?: any | null;
     surveysToken?: string | null;
 }
 export interface Address {
@@ -442,7 +442,7 @@ export interface AuditLogEntry {
     rootEntityType?: string | null;
     /** @format uuid */
     rootEntityId?: string | null;
-    changes?: any;
+    changes?: any | null;
     /** @format date-time */
     createdAt: string;
 }
@@ -1265,7 +1265,7 @@ export interface DraftLoanOfficerReassignRequest {
 }
 export interface DraftRequest {
     applicationPayload: any;
-    customData?: any;
+    customData?: any | null;
     isCoBorrower: boolean;
 }
 export interface EConsentInformation {
@@ -1449,7 +1449,7 @@ export interface EncompassRequestLog {
     httpStatusCode?: number | null;
     /** @format int64 */
     durationMs?: number | null;
-    context?: any;
+    context?: any | null;
     /** @format date-time */
     createdAt: string;
 }
@@ -1492,7 +1492,7 @@ export interface FileSearchCriteria {
 export interface FileWithBytes {
     name: string;
     /** @format byte */
-    data: string;
+    data: Blob;
     fileName: string;
     mimeType?: string | null;
     extension?: string | null;
@@ -1572,7 +1572,7 @@ export interface FormSubmission {
     subjectPropertyAddressCounty?: string | null;
     subjectPropertyAddressState?: string | null;
     subjectPropertyAddressZip?: string | null;
-    data?: any;
+    data?: any | null;
     /** @format uuid */
     listingID?: string | null;
     listing?: Listing | null;
@@ -1607,7 +1607,7 @@ export interface FormSubmissionRequest {
     subjectPropertyAddressCounty?: string | null;
     subjectPropertyAddressState?: string | null;
     subjectPropertyAddressZip?: string | null;
-    data?: any;
+    data?: any | null;
     /** @format uuid */
     listingID?: string | null;
 }
@@ -1768,7 +1768,7 @@ export interface GetWorkflowRequest {
 export interface GuidPatchOperation {
     op: string;
     path: string;
-    value?: any;
+    value?: any | null;
     from?: string | null;
 }
 export interface IPAddress {
@@ -2063,7 +2063,7 @@ export interface LoanApplicationRequest {
     nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
     /** @format uuid */
     draftId?: string | null;
-    additionalFields?: Record<string, any>;
+    additionalFields?: Record<string, any> | null;
     /** @format uuid */
     existingLoanId?: string | null;
 }
@@ -2921,7 +2921,7 @@ export interface LoanConsentRequest {
     borrowerEConsent?: boolean | null;
     borrowerCreditAuth?: boolean | null;
     borrowerTCPAOptIn?: boolean | null;
-    additionalFields?: Record<string, string>;
+    additionalFields?: Record<string, string> | null;
 }
 export interface LoanContact {
     /** @format date-time */
@@ -2945,7 +2945,7 @@ export interface LoanContactList {
     email: string;
 }
 export interface LoanCustomFieldsRequest {
-    additionalFields?: Record<string, string>;
+    additionalFields?: Record<string, string> | null;
 }
 export interface LoanDocument {
     /** @format date-time */
@@ -3407,7 +3407,7 @@ export interface LoanQueueWithData {
     user: UserPublic;
     loanOfficer: LoanOfficerPublic;
     siteConfiguration: SiteConfigurationReduced;
-    data?: any;
+    data?: any | null;
 }
 export interface LoanRecord {
     loanGuid: string;
@@ -3621,7 +3621,7 @@ export interface ModuleParameterValue {
     parameterID: string;
     parameterName: string;
     parameterType: string;
-    value?: any;
+    value?: any | null;
     isInherited: boolean;
 }
 export interface MonthlyPaymentCalculator {
@@ -3832,7 +3832,7 @@ export interface NotificationTemplateVersionUpdateRequest {
 }
 export interface Operation {
     op?: string;
-    value?: string | number | boolean | null | object;
+    value?: object | null;
     path?: string;
 }
 export interface OverridePasswordRequest {
@@ -5766,7 +5766,6 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
     format?: ResponseType;
 }
 export declare enum ContentType {
-    JsonPatch = "application/json-patch+json",
     Json = "application/json",
     JsonApi = "application/vnd.api+json",
     FormData = "multipart/form-data",
@@ -7939,10 +7938,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @summary Download By ID
          * @request GET:/api/loans/{loanId}/documents/{documentId}/download
          * @secure
-         * @response `200` `string` Success
+         * @response `200` `Blob` Success
          * @response `404` `ProblemDetails` Not Found
          */
-        downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
+        downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
         /**
          * No description
          *

package/dist/index.js

@@ -32,7 +32,6 @@ var __rest = (this && this.__rest) || function (s, e) {
 import axios from "axios";
 export var ContentType;
 (function (ContentType) {
-    ContentType["JsonPatch"] = "application/json-patch+json";
     ContentType["Json"] = "application/json";
     ContentType["JsonApi"] = "application/vnd.api+json";
     ContentType["FormData"] = "multipart/form-data";
@@ -1430,7 +1429,7 @@ export class Api extends HttpClient {
              * @response `200` `string` Success
              * @response `422` `UnprocessableEntity` Client Error
              */
-            updateLoanConsentAndCustomFieldsObsolete: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
+            updateLoanConsentAndCustomFieldsObsolete: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -1441,7 +1440,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `200` `GetReport` Success
              */
-            getLoansReport: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/reports`, method: "POST", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
+            getLoansReport: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/reports`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -1480,7 +1479,7 @@ export class Api extends HttpClient {
              * @response `200` `string` Success
              * @response `422` `UnprocessableEntity` Client Error
              */
-            updateLoanCustomFields: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/custom-fields`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
+            updateLoanCustomFields: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/custom-fields`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -1493,7 +1492,7 @@ export class Api extends HttpClient {
              * @response `202` `string` Accepted
              * @response `422` `UnprocessableEntity` Client Error
              */
-            updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/consent`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
+            updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/consent`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -1571,7 +1570,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `200` `DocumentDataRequest` Success
              */
-            createLegacyLoanDocument: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/generatedocument`, method: "POST", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
+            createLegacyLoanDocument: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/generatedocument`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -1607,7 +1606,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `200` `ListingFile` Success
              */
-            updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
+            updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -1640,7 +1639,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `200` `(ListingPhoto)[]` Success
              */
-            updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
+            updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -1673,7 +1672,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `201` `Listing` Created
              */
-            createListing: (data, params = {}) => this.request(Object.assign({ path: `/api/listings`, method: "POST", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
+            createListing: (data, params = {}) => this.request(Object.assign({ path: `/api/listings`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -2074,7 +2073,7 @@ export class Api extends HttpClient {
              * @summary Download By ID
              * @request GET:/api/loans/{loanId}/documents/{documentId}/download
              * @secure
-             * @response `200` `string` Success
+             * @response `200` `Blob` Success
              * @response `404` `ProblemDetails` Not Found
              */
             downloadLoanDocument: (loanId, documentId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/${documentId}/download`, method: "GET", secure: true, format: "json" }, params)),
@@ -2571,7 +2570,7 @@ export class Api extends HttpClient {
              * @response `400` `ProblemDetails` Bad Request
              * @response `404` `ProblemDetails` Not Found
              */
-            triggerAso: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/aso`, method: "POST", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
+            triggerAso: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/aso`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -2583,7 +2582,7 @@ export class Api extends HttpClient {
              * @response `200` `TaskCommentPaginated` Success
              * @response `404` `ProblemDetails` Not Found
              */
-            searchLoanTaskComments: (loanId, userLoanTaskId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
+            searchLoanTaskComments: (loanId, userLoanTaskId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *