@matech/thebigpos-sdk 2.35.0 → 2.36.0

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

@@ -921,9 +921,17 @@ export interface DocumentFolder {
     count: number;
     files: DocumentFile[];
 }
+export interface DocumentFoldersRequest {
+    searchText?: string | null;
+    losStatuses?: LOSStatus[] | null;
+    sortBy?: string | null;
+    sortDirection?: string | null;
+}
 export interface DocumentSync {
     /** @format int32 */
     syncedCount: number;
+    /** @format date-time */
+    lastLosDocumentsSyncDate?: string | null;
 }
 export interface DocumentTemplate {
     /** @format date-time */
@@ -1687,6 +1695,8 @@ export interface Loan {
     isInSync: boolean;
     /** @format date-time */
     syncDate?: string | null;
+    /** @format date-time */
+    lastLosDocumentsSyncDate?: string | null;
     isLocked: boolean;
     isLockedFromEditing: boolean;
     excludeFromAutoTaskReminders?: boolean | null;
@@ -1735,6 +1745,8 @@ export interface LoanApplicationRequest {
     borrowers: LoanBorrowerRequest[];
     nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
     /** @format uuid */
+    draftId?: string | null;
+    /** @format uuid */
     existingLoanId?: string | null;
 }
 export interface LoanBorrower {
@@ -3325,7 +3337,7 @@ export interface NotificationTemplateVersionUpdateRequest {
 }
 export interface Operation {
     op?: string;
-    value?: string | number | boolean | null | object;
+    value?: object | null;
     path?: string;
 }
 export interface OverridePasswordRequest {
@@ -5165,7 +5177,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",
@@ -5187,7 +5198,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v2.35.0
+ * @version v2.36.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -6903,16 +6914,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             sortDirection?: string;
         }, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentSearchPaginated, any, {}>>;
         /**
-         * @description Returns all documents grouped by folder for sidebar display
+         * @description Returns all documents grouped by folder for sidebar display. Use folderNamesOnly=true to get simplified response with folder names and counts for mobile (Files array will be empty).
          *
          * @tags LoanDocuments
          * @name GetLoanDocumentFolders
          * @summary Get document folder hierarchy
-         * @request GET:/api/loans/{loanId}/documents/folders
+         * @request POST:/api/loans/{loanId}/documents/folders
          * @secure
          * @response `200` `(DocumentFolder)[]` Success
          */
-        getLoanDocumentFolders: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<DocumentFolder[], any, {}>>;
+        getLoanDocumentFolders: (loanId: string, data: DocumentFoldersRequest, query?: {
+            /** @default false */
+            folderNamesOnly?: boolean;
+        }, params?: RequestParams) => Promise<AxiosResponse<DocumentFolder[], any, {}>>;
         /**
          * No description
          *
@@ -6984,27 +6998,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @description Fetches all documents from Encompass that don't exist locally and stores them in S3
          *
          * @tags LoanDocuments
-         * @name SyncLoanDocumentsFromEncompass
-         * @summary Sync documents from Encompass
+         * @name SyncLoanDocumentsFromLos
+         * @summary Sync documents from LOS
          * @request POST:/api/loans/{loanId}/documents/sync
          * @secure
          * @response `200` `DocumentSync` Success
          * @response `404` `ProblemDetails` Not Found
          */
-        syncLoanDocumentsFromEncompass: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<DocumentSync, any, {}>>;
+        syncLoanDocumentsFromLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<DocumentSync, any, {}>>;
         /**
-         * @description Re-attempts to push a failed document to Encompass
+         * @description Re-attempts to push a failed document to LOS
          *
          * @tags LoanDocuments
-         * @name RetrySyncLoanDocumentToEncompass
-         * @summary Retry syncing a document to Encompass
+         * @name RetrySyncLoanDocumentToLos
+         * @summary Retry syncing a document to LOS
          * @request POST:/api/loans/{loanId}/documents/{documentId}/sync/retry
          * @secure
          * @response `200` `void` Success
          * @response `404` `ProblemDetails` Not Found
          * @response `423` `ProblemDetails` Client Error
          */
-        retrySyncLoanDocumentToEncompass: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
+        retrySyncLoanDocumentToLos: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
         /**
          * No description
          *
@@ -7372,7 +7386,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name GetLoans
          * @summary Get Loans
          * @request GET:/api/loans
-         * @deprecated
          * @secure
          * @response `200` `GetApplications` Success
          */

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";
@@ -104,7 +103,7 @@ export class HttpClient {
 }
 /**
  * @title The Big POS API
- * @version v2.35.0
+ * @version v2.36.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -1204,7 +1203,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
              *
@@ -1254,7 +1253,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
              *
@@ -1267,7 +1266,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
              *
@@ -1381,7 +1380,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
              *
@@ -1414,7 +1413,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
              *
@@ -1653,16 +1652,16 @@ export class Api extends HttpClient {
              */
             searchLoanDocuments: (loanId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
-             * @description Returns all documents grouped by folder for sidebar display
+             * @description Returns all documents grouped by folder for sidebar display. Use folderNamesOnly=true to get simplified response with folder names and counts for mobile (Files array will be empty).
              *
              * @tags LoanDocuments
              * @name GetLoanDocumentFolders
              * @summary Get document folder hierarchy
-             * @request GET:/api/loans/{loanId}/documents/folders
+             * @request POST:/api/loans/{loanId}/documents/folders
              * @secure
              * @response `200` `(DocumentFolder)[]` Success
              */
-            getLoanDocumentFolders: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/folders`, method: "GET", secure: true, format: "json" }, params)),
+            getLoanDocumentFolders: (loanId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/folders`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -1729,27 +1728,27 @@ export class Api extends HttpClient {
              * @description Fetches all documents from Encompass that don't exist locally and stores them in S3
              *
              * @tags LoanDocuments
-             * @name SyncLoanDocumentsFromEncompass
-             * @summary Sync documents from Encompass
+             * @name SyncLoanDocumentsFromLos
+             * @summary Sync documents from LOS
              * @request POST:/api/loans/{loanId}/documents/sync
              * @secure
              * @response `200` `DocumentSync` Success
              * @response `404` `ProblemDetails` Not Found
              */
-            syncLoanDocumentsFromEncompass: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/sync`, method: "POST", secure: true, format: "json" }, params)),
+            syncLoanDocumentsFromLos: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/sync`, method: "POST", secure: true, format: "json" }, params)),
             /**
-             * @description Re-attempts to push a failed document to Encompass
+             * @description Re-attempts to push a failed document to LOS
              *
              * @tags LoanDocuments
-             * @name RetrySyncLoanDocumentToEncompass
-             * @summary Retry syncing a document to Encompass
+             * @name RetrySyncLoanDocumentToLos
+             * @summary Retry syncing a document to LOS
              * @request POST:/api/loans/{loanId}/documents/{documentId}/sync/retry
              * @secure
              * @response `200` `void` Success
              * @response `404` `ProblemDetails` Not Found
              * @response `423` `ProblemDetails` Client Error
              */
-            retrySyncLoanDocumentToEncompass: (loanId, documentId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/${documentId}/sync/retry`, method: "POST", secure: true }, params)),
+            retrySyncLoanDocumentToLos: (loanId, documentId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/${documentId}/sync/retry`, method: "POST", secure: true }, params)),
             /**
              * No description
              *
@@ -2063,7 +2062,6 @@ export class Api extends HttpClient {
              * @name GetLoans
              * @summary Get Loans
              * @request GET:/api/loans
-             * @deprecated
              * @secure
              * @response `200` `GetApplications` Success
              */
@@ -2144,7 +2142,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
              *