@matech/thebigpos-sdk 2.23.5-rc0 → 3.0.0-rc.0

package/.husky/pre-commit

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

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/dist/index.d.ts

@@ -1,22 +1,36 @@
 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 RefinanceExistingType = "Conventional" | "ARM" | "Jumbo" | "FHA" | "VA" | "USDA" | "NotSure";
+export type PropertyType = "SingleFamily" | "Condo" | "MultiFamily";
+export type PropertyOccupancyType = "PrimaryResidence" | "SecondaryResidence" | "Investment" | "FHASecondaryResidence";
+export type PropertyIntention = "Keep" | "Rent" | "Sell";
+export type PropertyHeldBy = "Sole" | "JointWithSpouse" | "JointWithOtherThanSpouse";
 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 LoanPurpose = "Purchase" | "Refinance";
 export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification";
 export type LoanImportStatus = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
 export type LoanImportMode = "All" | "NewOnly" | "UpdateOnly";
 export type LoanAccessScopeType = "User" | "Branch";
 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 ErrorType = "Failure" | "Validation" | "NotFound" | "Conflict" | "Unauthorized" | "Forbidden";
 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 type BorrowerMaritalStatus = "Single" | "Married" | "Separated";
+export type BorrowerLanguagePreference = "English" | "Chinese" | "Korean" | "Tagalog" | "Vietnamese" | "Other" | "LanguageRefusal";
+export type BorrowerJobPayType = "Salary" | "Hourly";
+export type BorrowerConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
+export type BorrowerCitizenshipStatus = "USCitizen" | "PermanentResidentAlien" | "NonPermanentResidentAlien";
+export type AssetAccountType = "Checking" | "Savings" | "MoneyMarket" | "CD" | "MutualFund" | "Stock" | "StockOptions" | "Bond" | "Retirement" | "BridgeLoan" | "IndividualDevelopment" | "LifeInsurance" | "Trust";
+export type AddressOwnershipType = "Own" | "Rent" | "LiveRentFree";
 export interface ASOSettings {
     enabled: boolean;
     softPull: boolean;
@@ -99,6 +113,20 @@ export interface AddressRequest {
     /** @minLength 1 */
     postalCode: string;
 }
+export interface AddressV3 {
+    /** @format uuid */
+    id: string;
+    unit?: string | null;
+    city?: string | null;
+    state?: string | null;
+    street?: string | null;
+    county?: string | null;
+    zipCode?: string | null;
+    unitType?: string | null;
+    /** @format date */
+    since?: string | null;
+    ownershipType?: AddressOwnershipType | null;
+}
 export interface AdminAccessGetForms {
     /** @format date-time */
     createdAt?: string | null;
@@ -1485,6 +1513,7 @@ export interface Loan {
     loanProgram?: string | null;
     loanType?: string | null;
     status?: string | null;
+    isActive: boolean;
     loanOfficer?: LoanOfficer | null;
     propertyAddress?: Address | null;
     loanSettings?: LoanSettings | null;
@@ -1495,6 +1524,147 @@ export interface Loan {
     userLoans: UserLoan[];
     contacts: LoanContact[];
 }
+export interface LoanBorrower {
+    /** @format uuid */
+    id: string;
+    /** @format uuid */
+    userId?: string | null;
+    ssn: string;
+    email: string;
+    lastName: string;
+    firstName: string;
+    /** @format date */
+    dateOfBirth?: string | null;
+    maritalStatus?: BorrowerMaritalStatus | null;
+    citizenshipType?: BorrowerCitizenshipStatus | null;
+    languagePreference?: BorrowerLanguagePreference | null;
+    sufixName?: string | null;
+    middleName?: string | null;
+    phoneNumber?: string | null;
+    hasDependents?: boolean | null;
+    dependentsAges?: string | null;
+    /** @format int32 */
+    quantityOfDependents?: number | null;
+    declarations?: LoanBorrowerDeclarations | null;
+    addresses: AddressV3[];
+    jobs: LoanBorrowerJob[];
+    assets: LoanBorrowerAsset[];
+    incomes: LoanBorrowerIncome[];
+    consents: LoanBorrowerConsent[];
+    realEstateProperties: LoanBorrowerRealEstateProperty[];
+}
+export interface LoanBorrowerAsset {
+    /** @format uuid */
+    id: string;
+    institution?: string | null;
+    /** @format double */
+    balance?: number | null;
+    accountType?: AssetAccountType | null;
+}
+export interface LoanBorrowerConsent {
+    /** @format uuid */
+    id: string;
+    ipAddress?: string | null;
+    providedConsent?: boolean | null;
+    /** @format date-time */
+    consentDate?: string | null;
+    type?: BorrowerConsentType | null;
+}
+export interface LoanBorrowerDeclarations {
+    /** @format uuid */
+    id: string;
+    isNewCredit?: boolean | null;
+    isGuarantor?: boolean | null;
+    isMortgageLoan?: boolean | null;
+    isPartyToLawsuit?: boolean | null;
+    isPrimaryResidence?: boolean | null;
+    isBorrowingMoney?: boolean | null;
+    /** @format double */
+    borrowingMoneyAmount?: number | null;
+    hasLien?: boolean | null;
+    hasShortSale?: boolean | null;
+    hasForeclosure?: boolean | null;
+    hasConveyedTitle?: boolean | null;
+    hasOwnershipInterest?: boolean | null;
+    hasFederalDelinquency?: boolean | null;
+    hasOutstandingJudgements?: boolean | null;
+    hasFamilyOrBusinessAffiliationWithSeller?: boolean | null;
+    hasBankruptcy?: boolean | null;
+    hasBankruptcyChapter7?: boolean | null;
+    hasBankruptcyChapter11?: boolean | null;
+    hasBankruptcyChapter12?: boolean | null;
+    hasBankruptcyChapter13?: boolean | null;
+    heldBy?: PropertyHeldBy | null;
+    occupancyType?: PropertyOccupancyType | null;
+}
+export interface LoanBorrowerIncome {
+    /** @format uuid */
+    id: string;
+    source?: string | null;
+    /** @format double */
+    amount?: number | null;
+}
+export interface LoanBorrowerJob {
+    /** @format uuid */
+    id: string;
+    employerName?: string | null;
+    employerPhoneNumber?: string | null;
+    position?: string | null;
+    /** @format int32 */
+    yearsInField?: number | null;
+    /** @format int32 */
+    monthsInField?: number | null;
+    isCurrent?: boolean | null;
+    isSelfEmployed?: boolean | null;
+    hasW2?: boolean | null;
+    /** @format double */
+    w2Wages?: number | null;
+    hasDistributions?: boolean | null;
+    /** @format double */
+    distributions?: number | null;
+    hasOtherIncome?: boolean | null;
+    /** @format double */
+    bonuses?: number | null;
+    /** @format double */
+    overtime?: number | null;
+    /** @format double */
+    comissions?: number | null;
+    /** @format double */
+    payValue?: number | null;
+    /** @format date */
+    startDate?: string | null;
+    payType?: BorrowerJobPayType | null;
+    employerAddress?: AddressV3 | null;
+}
+export interface LoanBorrowerPair {
+    /** @format uuid */
+    id: string;
+    /** @format int32 */
+    position: number;
+    borrower?: LoanBorrower | null;
+    coborrower?: LoanBorrower | null;
+}
+export interface LoanBorrowerRealEstateProperty {
+    /** @format uuid */
+    id: string;
+    /** @format int32 */
+    units?: number | null;
+    /** @format int32 */
+    yearBuilt?: number | null;
+    /** @format double */
+    value?: number | null;
+    /** @format double */
+    purchasePrice?: number | null;
+    /** @format double */
+    incomeAmount?: number | null;
+    /** @format double */
+    mortgageAmount?: number | null;
+    /** @format double */
+    expensesAmount?: number | null;
+    intention?: PropertyIntention | null;
+    occupancyType?: PropertyOccupancyType | null;
+    address?: AddressV3 | null;
+}
 export interface LoanComparison {
     loanID: string;
     scenarios: LoanComparisonScenario[];
@@ -1637,6 +1807,9 @@ export interface LoanCreateRequest {
      */
     draftId: string;
 }
+export interface LoanCustomFieldsRequest {
+    additionalFields?: Record<string, string>;
+}
 export interface LoanDocument {
     /** @format date-time */
     createdAt: string;
@@ -1741,6 +1914,7 @@ export interface LoanList {
     totalLoanAmount?: number | null;
     /** @format date-time */
     startDate?: string | null;
+    isActive: boolean;
     propertyAddress?: Address | null;
     loanOfficer?: LoanOfficerList | null;
     buyerAgentContact?: LoanContactList | null;
@@ -1773,6 +1947,14 @@ export interface LoanLogSearchCriteria {
     types?: LoanLogType[] | null;
     levels?: LogLevel[] | null;
 }
+export interface LoanMilestone {
+    /** @format uuid */
+    id: string;
+    name: string;
+    /** @format date-time */
+    completedAt?: string | null;
+    completed: boolean;
+}
 export interface LoanOfficer {
     /** @format uuid */
     id: string;
@@ -1874,6 +2056,17 @@ export interface LoanSearchCriteria {
 export interface LoanSettings {
     excludeFromAutoTaskReminders: boolean;
 }
+export interface LoanSubjectProperty {
+    /** @format int32 */
+    units?: number | null;
+    /** @format int32 */
+    yearBuilt?: number | null;
+    /** @format double */
+    purchasePrice?: number | null;
+    type?: PropertyType | null;
+    occupancyType?: PropertyOccupancyType | null;
+    address?: AddressV3 | null;
+}
 export interface LoanUpdateRequestJsonPatchDocument {
     operations?: LoanUpdateRequestOperation[] | null;
     contractResolver?: IContractResolver | null;
@@ -1898,6 +2091,33 @@ export interface LoanUser {
     /** @format date-time */
     createdAt: string;
 }
+export interface LoanV3 {
+    /** @format uuid */
+    id: string;
+    /** @format uuid */
+    loanOfficerId?: string | null;
+    isPosLoan?: boolean | null;
+    number?: string | null;
+    externalId?: string | null;
+    /** @format int32 */
+    loanTermInYears?: number | null;
+    isMilitaryService?: boolean | null;
+    isHomeOwnershipEducation?: boolean | null;
+    /** @format double */
+    amount?: number | null;
+    /** @format double */
+    downPaymentAmount?: number | null;
+    isDownPaymentGift?: boolean | null;
+    /** @format double */
+    downPaymentGiftAmount?: number | null;
+    purpose?: LoanPurpose | null;
+    refinanceExistingType?: RefinanceExistingType | null;
+    /** @format date-time */
+    closingDate?: string | null;
+    subjectProperty?: LoanSubjectProperty | null;
+    milestones: LoanMilestone[];
+    borrowerPairs: LoanBorrowerPair[];
+}
 export interface LosLoanCreationRequest {
     loanOfficerUserName?: string | null;
     loanTemplate?: string | null;
@@ -2160,7 +2380,7 @@ export interface NotificationTemplateVersionUpdateRequest {
 }
 export interface Operation {
     op?: string;
-    value?: string | number | boolean | null | object;
+    value?: object | null;
     path?: string;
 }
 export interface OverridePasswordRequest {
@@ -2398,20 +2618,6 @@ export interface RequestImpersonationRequest {
      */
     email: string;
 }
-export interface RequestQueue {
-    /** @format date-time */
-    createdAt?: string | null;
-    /** @format date-time */
-    updatedAt?: string | null;
-    /** @format date-time */
-    deletedAt?: string | null;
-    /** @format uuid */
-    id: string;
-    userEmail?: string | null;
-    endpoint?: string | null;
-    errorMessage?: string | null;
-    status?: string | null;
-}
 export interface RunLOCalculation {
     loanID: string;
     loanAmount?: string | null;
@@ -2528,6 +2734,11 @@ export interface SendNotificationForLoanRequest {
     phone?: string | null;
     attachments: Attachment[];
 }
+export interface ServiceError {
+    code: string;
+    message: string;
+    type: "Failure" | "Validation" | "NotFound" | "Conflict" | "Unauthorized" | "Forbidden";
+}
 export interface SiteConfiguration {
     /** @format date-time */
     createdAt?: string | null;
@@ -3782,7 +3993,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",
@@ -3804,7 +4014,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v2.23.4
+ * @version v2.24.4
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -4959,14 +5169,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * No description
          *
          * @tags LegacyLoan
-         * @name UpdateLoanConsent
-         * @summary Update Loan Consent
+         * @name UpdateLoanConsentAndCustomFieldsObsolete
+         * @summary Update Loan Consent and Custom Fields
          * @request PATCH:/api/los/loan/application/{loanID}
+         * @deprecated
          * @secure
          * @response `200` `string` Success
          * @response `422` `UnprocessableEntity` Client Error
          */
-        updateLoanConsent: (loanId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<string, any>>;
+        updateLoanConsentAndCustomFieldsObsolete: (loanId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<string, any>>;
         /**
          * No description
          *
@@ -4991,6 +5202,30 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `423` `UnprocessableEntity` Client Error
          */
         createLoan: (data: any, params?: RequestParams) => Promise<AxiosResponse<string, any>>;
+        /**
+         * No description
+         *
+         * @tags LegacyLoan
+         * @name UpdateLoanCustomFields
+         * @summary Update Loan Custom Fields
+         * @request PATCH:/api/los/loan/application/{loanID}/custom-fields
+         * @secure
+         * @response `200` `string` Success
+         * @response `422` `UnprocessableEntity` Client Error
+         */
+        updateLoanCustomFields: (loanId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<string, any>>;
+        /**
+         * No description
+         *
+         * @tags LegacyLoan
+         * @name UpdateLoanConsent
+         * @summary Update Loan Consent and Custom Fields
+         * @request PATCH:/api/los/loan/application/{loanID}/consent
+         * @secure
+         * @response `200` `string` Success
+         * @response `422` `UnprocessableEntity` Client Error
+         */
+        updateLoanConsent: (loanId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<string, any>>;
         /**
          * No description
          *
@@ -5900,6 +6135,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `200` `Loan` Success
          */
         updateLoan: (loanId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<Loan, any>>;
+        /**
+         * No description
+         *
+         * @tags Loans V3
+         * @name GetLoanByIdV3
+         * @request GET:/api/v3/loans/{id}
+         * @secure
+         * @response `200` `LoanV3` Success
+         * @response `404` `ServiceError` Not Found
+         */
+        getLoanByIdV3: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanV3, any>>;
         /**
          * No description
          *
@@ -6494,45 +6740,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         replacePartnerSiteConfiguration: (realtorId: string, siteConfigurationId: string, data: SiteConfigurationRequest, query?: {
             applyToChildren?: boolean;
         }, params?: RequestParams) => Promise<AxiosResponse<SiteConfiguration, any>>;
-        /**
-         * No description
-         *
-         * @tags RequestQueue
-         * @name GetRequestQueues
-         * @summary Get All
-         * @request GET:/api/request-queues
-         * @deprecated
-         * @secure
-         * @response `200` `(RequestQueue)[]` Success
-         */
-        getRequestQueues: (params?: RequestParams) => Promise<AxiosResponse<RequestQueue[], any>>;
-        /**
-         * No description
-         *
-         * @tags RequestQueue
-         * @name RunRequestQueue
-         * @summary Run
-         * @request POST:/api/request-queues/{id}/run
-         * @deprecated
-         * @secure
-         * @response `200` `void` Success
-         */
-        runRequestQueue: (id: string, query?: {
-            /** @default false */
-            force?: boolean;
-        }, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
-        /**
-         * No description
-         *
-         * @tags RequestQueue
-         * @name DeleteQueueRequest
-         * @summary Delete
-         * @request DELETE:/api/request-queues/{id}
-         * @deprecated
-         * @secure
-         * @response `204` `void` No Content
-         */
-        deleteQueueRequest: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
         /**
          * No description
          *