@matech/thebigpos-sdk 2.36.0 → 2.36.5-rc0

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

@@ -22,7 +22,7 @@ export type LoanNameSuffix = "Jr" | "Sr" | "II" | "III" | "IV" | "V" | "VI" | "V
 export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
 export type LoanMilitaryServiceType = "Current" | "RetiredDischargedSeparated" | "NonActivatedNationalGuard" | "SurvivingSpouse";
 export type LoanMaritalStatus = "Married" | "Separated" | "Unmarried";
-export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent";
+export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge";
 export type LoanLienPosition = "First" | "Subordinate";
 export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
 export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other";
@@ -44,6 +44,8 @@ export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Fai
 export type FilterType = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
 export type Environment = "Development" | "Staging" | "UAT" | "Production";
 export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
+export type EncompassLogOutcome = "Success" | "Failure" | "PartialSuccess";
+export type EncompassLogOperationType = "FieldUpdate" | "EConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
 export type DraftType = "NewLoan" | "EditLoan";
 export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
 export type BranchType = "Mortgage" | "RealEstate";
@@ -1133,6 +1135,17 @@ export interface EncompassError {
     message: string;
     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;
@@ -1151,6 +1164,31 @@ export interface EncompassPackageList {
     /** @format int32 */
     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;
 }
@@ -1699,6 +1737,8 @@ export interface Loan {
     lastLosDocumentsSyncDate?: string | null;
     isLocked: boolean;
     isLockedFromEditing: boolean;
+    /** @format date-time */
+    sensitiveDataPurgedOn?: string | null;
     excludeFromAutoTaskReminders?: boolean | null;
     loanSettings?: LoanSettings | null;
     loanOfficer?: LoanOfficer | null;
@@ -2645,6 +2685,8 @@ export interface LoanDocument {
     losStatus: string;
     contents?: string | null;
     failoverDocumentPath?: string | null;
+    /** @format date-time */
+    sensitiveDataPurgedOn?: string | null;
 }
 export interface LoanDocumentSearch {
     /** @format date-time */
@@ -2663,6 +2705,8 @@ export interface LoanDocumentSearch {
     losStatus: string;
     contents?: string | null;
     failoverDocumentPath?: string | null;
+    /** @format date-time */
+    sensitiveDataPurgedOn?: string | null;
 }
 export interface LoanDocumentSearchCriteria {
     searchText?: string | null;
@@ -3337,7 +3381,7 @@ export interface NotificationTemplateVersionUpdateRequest {
 }
 export interface Operation {
     op?: string;
-    value?: object | null;
+    value?: string | number | boolean | null | object;
     path?: string;
 }
 export interface OverridePasswordRequest {
@@ -5128,6 +5172,8 @@ export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateO
 export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
 export type DraftTypeEnum = "NewLoan" | "EditLoan";
 export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
+export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "EConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
+export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
 export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
 export type IpAddressAddressFamilyEnum = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
 export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
@@ -5135,7 +5181,7 @@ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed"
 export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
 export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
 export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
-export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent";
+export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge";
 export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
 export type SamlMetadataRequestSsoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
 export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
@@ -5177,6 +5223,7 @@ 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",
@@ -5198,7 +5245,7 @@ export declare 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/)
  */
@@ -8361,6 +8408,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `200` `void` Success
          */
         integrationsLosLoansCreate: (data: LosLoanCreationRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
+        /**
+         * 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) => Promise<AxiosResponse<EncompassRequestLogPaginated, any, {}>>;
         /**
          * No description
          *

package/dist/index.js

@@ -32,6 +32,7 @@ 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";
@@ -103,7 +104,7 @@ export class HttpClient {
 }
 /**
  * @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/)
  */
@@ -1203,7 +1204,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.Json, 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.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -1253,7 +1254,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.Json, 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.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -1266,7 +1267,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.Json, 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.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -1380,7 +1381,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.Json, format: "json" }, params)),
+            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)),
             /**
              * No description
              *
@@ -1413,7 +1414,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.Json, format: "json" }, params)),
+            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)),
             /**
              * No description
              *
@@ -2142,7 +2143,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.Json, 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.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -2971,6 +2972,16 @@ export class Api extends HttpClient {
              * @response `200` `void` Success
              */
             integrationsLosLoansCreate: (data, params = {}) => this.request(Object.assign({ path: `/api/integrations/los/loans`, method: "POST", body: data, secure: true, type: ContentType.Json }, params)),
+            /**
+             * No description
+             *
+             * @tags TheBigPOS
+             * @name SearchEncompassLogs
+             * @request POST:/api/los/encompass/logs/{losId}/search
+             * @secure
+             * @response `200` `EncompassRequestLogPaginated` Success
+             */
+            searchEncompassLogs: (losId, query, data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/logs/${losId}/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *