@matech/thebigpos-sdk 2.18.3-rc.0 → 2.18.4-rc.0

package/.husky/pre-commit

@@ -1,2 +1,2 @@
-yarn build
+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,44 +1,44 @@
-# 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);
-});
-```
-
-____
-© 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);
+});
+```
+
+____
+© 2024 Mortgage Automation Technologies. All rights reserved

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

@@ -0,0 +1,45 @@
+/* 
+  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 = './src/index.ts'
+let content = fs.readFileSync(path, 'utf8')
+
+// 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?: any | null;'
+		)
+		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/dist/index.d.ts

@@ -1,125 +1,19 @@
-export declare enum UserRole {
-    Borrower = "Borrower",
-    LoanOfficer = "LoanOfficer",
-    Admin = "Admin",
-    SuperAdmin = "SuperAdmin",
-    Realtor = "Realtor",
-    SettlementAgent = "SettlementAgent",
-    LoanProcessor = "LoanProcessor",
-    LoanOfficerAssistant = "LoanOfficerAssistant",
-    BranchManager = "BranchManager",
-    SystemAdmin = "SystemAdmin"
-}
-export declare enum SiteConfigurationType {
-    None = "None",
-    Account = "Account",
-    Corporate = "Corporate",
-    Branch = "Branch",
-    LoanOfficer = "LoanOfficer",
-    Partner = "Partner"
-}
-export declare enum SSOIntegrationType {
-    ConsumerConnect = "ConsumerConnect",
-    TheBigPOS = "TheBigPOS"
-}
-export declare enum LogLevel {
-    None = "None",
-    Info = "Info",
-    Warning = "Warning",
-    Error = "Error"
-}
-export declare enum LoanRole {
-    Borrower = "Borrower",
-    CoBorrower = "CoBorrower",
-    NonBorrower = "NonBorrower",
-    LoanOfficer = "LoanOfficer",
-    LoanProcessor = "LoanProcessor",
-    LoanOfficerAssistant = "LoanOfficerAssistant",
-    SupportingLoanOfficer = "SupportingLoanOfficer",
-    BuyerAgent = "BuyerAgent",
-    SellerAgent = "SellerAgent",
-    TitleInsuranceAgent = "TitleInsuranceAgent",
-    EscrowAgent = "EscrowAgent",
-    SettlementAgent = "SettlementAgent"
-}
-export declare enum LoanQueueType {
-    Unknown = "Unknown",
-    New = "New",
-    Append = "Append",
-    Update = "Update",
-    FieldUpdates = "FieldUpdates",
-    Document = "Document",
-    Buckets = "Buckets"
-}
-export declare enum LoanQueueReason {
-    Unknown = "Unknown",
-    Locked = "Locked",
-    LOSError = "LOSError",
-    Exception = "Exception"
-}
-export declare enum LoanLogType {
-    Loan = "Loan",
-    Queue = "Queue",
-    POSFlagChanged = "POSFlagChanged",
-    Verification = "Verification"
-}
-export declare enum LoanImportStatus {
-    WaitingProcess = "WaitingProcess",
-    InProgress = "InProgress",
-    Completed = "Completed",
-    Failed = "Failed",
-    Cancelled = "Cancelled"
-}
-export declare enum LOSStatus {
-    Unknown = "Unknown",
-    Pending = "Pending",
-    Retrying = "Retrying",
-    Successful = "Successful",
-    Failed = "Failed",
-    FailedPermanently = "FailedPermanently"
-}
-export declare enum FilterType {
-    DateGreaterThanOrEqualTo = "DateGreaterThanOrEqualTo",
-    DateGreaterThan = "DateGreaterThan",
-    DateLessThan = "DateLessThan",
-    DateLessThanOrEqualTo = "DateLessThanOrEqualTo",
-    DateEquals = "DateEquals",
-    DateDoesntEqual = "DateDoesntEqual",
-    DateNonEmpty = "DateNonEmpty",
-    DateEmpty = "DateEmpty",
-    StringContains = "StringContains",
-    StringEquals = "StringEquals",
-    StringNotEmpty = "StringNotEmpty",
-    StringNotEquals = "StringNotEquals",
-    StringNotContains = "StringNotContains"
-}
-export declare enum Environment {
-    Development = "Development",
-    Staging = "Staging",
-    UAT = "UAT",
-    Production = "Production"
-}
-export declare enum EntityType {
-    Account = "Account",
-    Corporate = "Corporate",
-    Branch = "Branch",
-    LoanOfficer = "LoanOfficer",
-    Realtor = "Realtor"
-}
-export declare enum BranchType {
-    Mortgage = "Mortgage",
-    RealEstate = "RealEstate"
-}
-export declare enum BorrowerType {
-    Borrower = "Borrower",
-    CoBorrower = "CoBorrower",
-    Unknown = "Unknown"
-}
-export declare enum BorrowerRelationship {
-    NotApplicable = "NotApplicable",
-    Spouse = "Spouse",
-    NonSpouse = "NonSpouse"
-}
+export type UserRole = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
+export type SiteConfigurationType = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS";
+export type OperationType = "Add" | "Remove" | "Replace" | "Move" | "Copy" | "Test" | "Invalid";
+export type LogLevel = "None" | "Info" | "Warning" | "Error";
+export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
+export type LoanQueueReason = "Unknown" | "Locked" | "LOSError" | "Exception";
+export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification";
+export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Failed" | "FailedPermanently";
+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 BranchType = "Mortgage" | "RealEstate";
+export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
+export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
 export interface ASOSettings {
     enabled: boolean;
     softPull: boolean;
@@ -585,15 +479,6 @@ export interface CreateInviteRequest {
     userRole?: UserRole | null;
     loanRole?: LoanRole | null;
 }
-export interface CreateLoanImportRequest {
-    /** @format date-time */
-    endDate: string;
-    /**
-     * @format date-time
-     * @minLength 1
-     */
-    startDate: string;
-}
 export interface CreateUserRelationRequest {
     /**
      * @format uuid
@@ -900,6 +785,7 @@ export interface EnabledServices {
     borrowerTasks?: boolean | null;
     docusign?: boolean | null;
     emailNotifications?: boolean | null;
+    autoTaskReminders?: boolean | null;
     voc?: boolean | null;
     spanishPrequal?: boolean | null;
     spanishFullApp?: boolean | null;
@@ -965,6 +851,7 @@ export interface ExtendedLoan {
     isInSync: boolean;
     /** @format date-time */
     syncDate?: string | null;
+    excludeFromAutoTaskReminders?: boolean | null;
     fileStarter?: string | null;
     isPOSLoan?: boolean | null;
     referenceID: string;
@@ -975,6 +862,7 @@ export interface ExtendedLoan {
     status?: string | null;
     loanOfficer?: LoanOfficer | null;
     propertyAddress?: Address | null;
+    loanSettings?: LoanSettings | null;
     loanLogs: LoanLog[];
     isLocked: boolean;
     source?: string | null;
@@ -1293,6 +1181,7 @@ export interface GetWorkflowRequest {
     userRole?: string | null;
     language?: string | null;
 }
+export type IContractResolver = object;
 export interface ImportUserLoanTaskRequest {
     /**
      * @format uuid
@@ -1465,6 +1354,7 @@ export interface Loan {
     isInSync: boolean;
     /** @format date-time */
     syncDate?: string | null;
+    excludeFromAutoTaskReminders?: boolean | null;
     fileStarter?: string | null;
     isPOSLoan?: boolean | null;
     referenceID: string;
@@ -1475,6 +1365,7 @@ export interface Loan {
     status?: string | null;
     loanOfficer?: LoanOfficer | null;
     propertyAddress?: Address | null;
+    loanSettings?: LoanSettings | null;
     loanLogs: LoanLog[];
     isLocked: boolean;
     source?: string | null;
@@ -1517,6 +1408,14 @@ export interface LoanComparisonScenario {
     lenderCredit?: string | null;
     fundingFee?: string | null;
 }
+export interface LoanConsentRequest {
+    /** @format email */
+    borrowerEmail?: string | null;
+    borrowerEConsent?: boolean | null;
+    borrowerCreditAuth?: boolean | null;
+    borrowerTCPAOptIn?: boolean | null;
+    additionalFields?: Record<string, string>;
+}
 export interface LoanContact {
     /** @format date-time */
     createdAt: string;
@@ -1561,30 +1460,6 @@ export interface LoanDraftSearchCriteria {
     siteConfigurationId?: string | null;
     isUnassigned?: boolean | null;
 }
-export interface LoanImport {
-    /** @format uuid */
-    id: string;
-    /** @format uuid */
-    accountID: string;
-    /** @format date-time */
-    endDate: string;
-    /** @format date-time */
-    startDate: string;
-    /** @format int32 */
-    attemptCount: number;
-    /** @format int32 */
-    importedCount: number;
-    statusMessage?: string | null;
-    status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
-    /** @format date-time */
-    createdAt?: string | null;
-}
-export interface LoanImportPaginated {
-    rows: LoanImport[];
-    pagination: Pagination;
-    /** @format int64 */
-    count: number;
-}
 export interface LoanLog {
     /** @format uuid */
     id: string;
@@ -1689,13 +1564,19 @@ export interface LoanSearchCriteria {
     /** @format uuid */
     siteConfigurationId?: string | null;
 }
-export interface LoanUpdateRequest {
-    /** @format email */
-    borrowerEmail?: string | null;
-    borrowerEConsent?: boolean | null;
-    borrowerCreditAuth?: boolean | null;
-    borrowerTCPAOptIn?: boolean | null;
-    additionalFields?: Record<string, string>;
+export interface LoanSettings {
+    excludeFromAutoTaskReminders: boolean;
+}
+export interface LoanUpdateRequestJsonPatchDocument {
+    operations?: LoanUpdateRequestOperation[] | null;
+    contractResolver?: IContractResolver | null;
+}
+export interface LoanUpdateRequestOperation {
+    operationType: "Add" | "Remove" | "Replace" | "Move" | "Copy" | "Test" | "Invalid";
+    path?: string | null;
+    op?: string | null;
+    from?: string | null;
+    value?: any;
 }
 export interface LoanUser {
     /** @format uuid */
@@ -1888,7 +1769,7 @@ export interface NotificationTemplateVersionUpdateRequest {
 }
 export interface Operation {
     op?: string;
-    value?: object | null;
+    value?: any | null;
     path?: string;
 }
 export interface OverridePasswordRequest {
@@ -2320,6 +2201,7 @@ export interface SiteConfiguration {
     user?: UserPublic | null;
     asoSettings?: ASOSettings | null;
     accountSettings: AccountSettings;
+    autoTaskReminderIntervalsInDays: number[];
 }
 export interface SiteConfigurationByUrl {
     /** @format date-time */
@@ -2510,6 +2392,7 @@ export interface SiteConfigurationByUrl {
     user?: UserPublic | null;
     asoSettings?: ASOSettings | null;
     accountSettings: AccountSettings;
+    autoTaskReminderIntervalsInDays: number[];
     workflows: Workflow[];
 }
 export interface SiteConfigurationForm {
@@ -2711,6 +2594,7 @@ export interface SiteConfigurationRequest {
     modules?: Module[] | null;
     /** @format uuid */
     userID?: string | null;
+    autoTaskReminderIntervalsInDays: number[];
 }
 export interface SiteConfigurationSearchCriteria {
     searchText?: string | null;
@@ -3280,6 +3164,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",
@@ -3301,7 +3186,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v2.18.3
+ * @version v2.18.4
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -4456,14 +4341,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * No description
          *
          * @tags LegacyLoan
-         * @name UpdateLoan
-         * @summary Update Loan
+         * @name UpdateLoanConsent
+         * @summary Update Loan Consent
          * @request PATCH:/api/los/loan/application/{loanID}
          * @secure
          * @response `200` `string` Success
          * @response `422` `UnprocessableEntity` Client Error
          */
-        updateLoan: (loanId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<string, any>>;
+        updateLoanConsent: (loanId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<string, any>>;
         /**
          * No description
          *
@@ -5031,48 +4916,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `200` `Draft` Success
          */
         reassignLoanOfficer: (draftId: string, data: DraftLoanOfficerReassignRequest, params?: RequestParams) => Promise<AxiosResponse<Draft, any>>;
-        /**
-         * No description
-         *
-         * @tags LoanImport
-         * @name GetLoanImports
-         * @summary Get Loan Imports
-         * @request GET:/api/loan-imports
-         * @secure
-         * @response `200` `LoanImportPaginated` Success
-         */
-        getLoanImports: (query?: {
-            status?: LoanImportStatus;
-            searchText?: string;
-            /** @format int32 */
-            pageSize?: number;
-            /** @format int32 */
-            pageNumber?: number;
-            sortBy?: string;
-            sortDirection?: string;
-        }, params?: RequestParams) => Promise<AxiosResponse<LoanImportPaginated, any>>;
-        /**
-         * No description
-         *
-         * @tags LoanImport
-         * @name CreateLoanImport
-         * @summary Create Loan Import
-         * @request POST:/api/loan-imports
-         * @secure
-         * @response `201` `LoanImport` Created
-         */
-        createLoanImport: (data: CreateLoanImportRequest, params?: RequestParams) => Promise<AxiosResponse<LoanImport, any>>;
-        /**
-         * No description
-         *
-         * @tags LoanImport
-         * @name GetLoanImport
-         * @summary Get Loan Import
-         * @request GET:/api/loan-imports/{id}
-         * @secure
-         * @response `200` `LoanImport` Success
-         */
-        getLoanImport: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanImport, any>>;
         /**
          * No description
          *
@@ -5324,11 +5167,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @tags Loans
          * @name ImportLoanFromLos
          * @summary Import from LOS
-         * @request POST:/api/loans/{loanId}/import-from-los
+         * @request POST:/api/loans/import-from-los/{loanId}
          * @secure
          * @response `200` `Loan` Success
          */
         importLoanFromLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<Loan, any>>;
+        /**
+         * No description
+         *
+         * @tags Loans
+         * @name UpdateLoan
+         * @summary Update loan fields
+         * @request PATCH:/api/loans/{loanId}
+         * @secure
+         * @response `200` `Loan` Success
+         */
+        updateLoan: (loanId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<Loan, any>>;
         /**
          * No description
          *