@matech/thebigpos-sdk 2.45.1-rc0 → 2.45.1-rc10

package/README.md

@@ -54,6 +54,16 @@ Replace `{version}` with the target API version (e.g. `v2.34.0`):
 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 --enum-style union
 ```
 
+Then apply the PATCH content-type fixup, passing the **same** spec that was given
+to the generator. The generator does not propagate `application/json-patch+json`,
+so this step sets each PATCH method's content type from the spec (no hard-coded
+endpoint list):
+
+```bash
+node scripts/apply-json-patch-content-type.js https://api.thebigpos.dev/swagger/v2.34.0/swagger.json
+yarn build
+```
+
 ## Publishing
 
 1. Update the `version` field in `package.json` before publishing.

package/dist/index.d.ts

@@ -31,14 +31,14 @@ export type LoanMaritalStatus = "Married" | "Separated" | "Unmarried";
 export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified";
 export type LoanLienPosition = "First" | "Subordinate";
 export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
-export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other";
+export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other" | "DoNotWishToRespond";
 export type LoanImportStatus = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
 export type LoanImportMode = "All" | "NewOnly" | "UpdateOnly";
 export type LoanHousingType = "NoExpense" | "Own" | "Rent";
 export type LoanHomeOwnershipType = "Counseling" | "Education" | "Other";
 export type LoanHomeOwnershipFormat = "InPerson" | "Online" | "Telephone";
 export type LoanHispanicEthnicity = "Mexican" | "PuertoRican" | "Cuban" | "Other";
-export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other";
+export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other" | "Institutional" | "Borrower";
 export type LoanGiftAssetType = "Cash" | "Asset" | "Equity";
 export type LoanGenderType = "Male" | "Female";
 export type LoanDocumentType = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy";
@@ -167,7 +167,6 @@ export interface AccountSettingsRequest {
     isSmsEnabled: boolean;
     smsNumber?: string | null;
     isEarlyAdopter: boolean;
-    isAIEnabled: boolean;
 }
 export interface Action {
     /** @format uuid */
@@ -799,10 +798,6 @@ export interface ApplicationRowData {
     escrowAgent?: EncompassContact | null;
     titleInsuranceAgent?: EncompassContact | null;
 }
-export interface Attachment {
-    fileName: string;
-    base64Data: string;
-}
 export interface AuditEntityType {
     entityType: string;
     rootEntityType?: string | null;
@@ -1792,6 +1787,7 @@ export interface EncompassPackageItem {
     /** @format date-time */
     createdAt: string;
     recipientId: string;
+    borrowerName?: string | null;
     title?: string | null;
     /** @format date-time */
     issuedAt?: string | null;
@@ -2043,8 +2039,6 @@ export interface FusionReportFilter {
     targetValue: string;
 }
 export interface GenerateDocumentRequest {
-    /** @deprecated */
-    loanID?: string | null;
     /** @format uuid */
     templateID: string;
     /**
@@ -2389,6 +2383,8 @@ export interface Loan {
     financial?: LoanFinancial | null;
     financialTerms?: LoanFinancialTerms | null;
     monthlyPayment?: LoanMonthlyPayment | null;
+    costDetails?: LoanCostDetails | null;
+    metrics?: LoanMetrics | null;
     borrowers: LoanBorrower[];
     nonOwningBorrowers: LoanNonOwningBorrower[];
     userLoans: UserLoan[];
@@ -2427,6 +2423,8 @@ export interface LoanApplicationRequest {
     companyName?: string | null;
     property?: LoanPropertyRequest | null;
     financial?: LoanFinancialRequest | null;
+    financialTerms?: LoanFinancialTermsRequest | null;
+    monthlyPayment?: LoanMonthlyPaymentRequest | null;
     borrowers: LoanBorrowerRequest[];
     nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
     /** @format uuid */
@@ -2453,6 +2451,8 @@ export interface LoanBorrower {
     applicationStatus: LoanBorrowerApplicationStatusEnum;
     /** @format int32 */
     numberOfDependents?: number | null;
+    /** @format int32 */
+    creditDecisionScore?: number | null;
     isPrimaryBorrower: boolean;
     isFirstTimeHomeBuyer?: boolean | null;
     hasJointAssetsAndLiabilities?: boolean | null;
@@ -2810,6 +2810,11 @@ export interface LoanBorrowerGift {
     isDeposited?: boolean | null;
     source?: LoanGiftSource | null;
     assetType?: LoanGiftAssetType | null;
+    grantorDonorName?: string | null;
+    /** @format double */
+    amountAppliedToDownPayment?: number | null;
+    /** @format double */
+    amountAppliedToClosingCosts?: number | null;
 }
 export interface LoanBorrowerGiftRequest {
     /** @format double */
@@ -2976,9 +2981,26 @@ export interface LoanBorrowerRealEstateAsset {
     /** @format double */
     marketValue?: number | null;
     /** @format double */
+    purchasePrice?: number | null;
+    /** @format int32 */
+    yearBuilt?: number | null;
+    /** @format int32 */
+    numberOfUnits?: number | null;
+    /** @format double */
     monthlyInsTaxDues?: number | null;
     /** @format double */
     monthlyRentalIncome?: number | null;
+    /** @format double */
+    rentalIncomeNetAmount?: number | null;
+    /** @format double */
+    maintenanceExpense?: number | null;
+    /** @format double */
+    percentageOfRental?: number | null;
+    /** @format double */
+    participationPercentage?: number | null;
+    /** @format date */
+    acquiredDate?: string | null;
+    dispositionStatus?: string | null;
     address?: AddressV3 | null;
     mortgages?: LoanBorrowerRealEstateAssetMortgage[] | null;
 }
@@ -3175,6 +3197,22 @@ export interface LoanContact {
 export interface LoanContactList {
     email: string;
 }
+export interface LoanCostDetails {
+    /** @format uuid */
+    id?: string | null;
+    /** @format double */
+    closingCosts?: number | null;
+    /** @format double */
+    prepaidCharges?: number | null;
+    /** @format double */
+    discount?: number | null;
+    /** @format double */
+    lenderCredit?: number | null;
+    /** @format double */
+    totalCost?: number | null;
+    /** @format double */
+    totalFinancing?: number | null;
+}
 export interface LoanCustomFieldsRequest {
     additionalFields?: Record<string, string> | null;
 }
@@ -3327,6 +3365,24 @@ export interface LoanFinancialTerms {
     baseLoanAmount?: number | null;
     /** @format double */
     totalLoanAmount?: number | null;
+    /** @format double */
+    mortgageInsuranceFactor?: number | null;
+    isEscrowWaived?: boolean | null;
+}
+export interface LoanFinancialTermsRequest {
+    /** @format int32 */
+    loanTermMonths?: number | null;
+    amortizationType?: LoanAmortizationType | null;
+    /** @format double */
+    apr?: number | null;
+    /** @format double */
+    interestRate?: number | null;
+    /** @format double */
+    downPayment?: number | null;
+    /** @format double */
+    baseLoanAmount?: number | null;
+    /** @format double */
+    totalLoanAmount?: number | null;
 }
 export interface LoanIdentifier {
     /** @format uuid */
@@ -3435,6 +3491,18 @@ export interface LoanLogSearchCriteria {
     types?: LoanLogType[] | null;
     levels?: LogLevel[] | null;
 }
+export interface LoanMetrics {
+    /** @format uuid */
+    id?: string | null;
+    /** @format double */
+    ltv?: number | null;
+    /** @format double */
+    cltv?: number | null;
+    /** @format double */
+    frontDti?: number | null;
+    /** @format double */
+    backDti?: number | null;
+}
 export interface LoanMilestone {
     /** @format uuid */
     id: string;
@@ -3461,6 +3529,22 @@ export interface LoanMonthlyPayment {
     /** @format double */
     other?: number | null;
 }
+export interface LoanMonthlyPaymentRequest {
+    /** @format double */
+    principalAndInterest?: number | null;
+    /** @format double */
+    taxes?: number | null;
+    /** @format double */
+    insurance?: number | null;
+    /** @format double */
+    mortgageInsurance?: number | null;
+    /** @format double */
+    floodInsurance?: number | null;
+    /** @format double */
+    hoa?: number | null;
+    /** @format double */
+    other?: number | null;
+}
 export interface LoanNonOwningBorrower {
     /** @format uuid */
     id?: string | null;
@@ -4358,15 +4442,11 @@ export interface SendLoanTaskReminderRequest {
     templateId: string;
     userIds?: string[] | null;
 }
-export interface SendNotificationForLoanRequest {
-    loanID: string;
-    templateKey: string;
-    loanOfficerEmail?: string | null;
-    /** @format uuid */
-    siteConfigurationId?: string | null;
-    email?: string | null;
-    phone?: string | null;
-    attachments: Attachment[];
+export interface SendOutstandingTaskReminderRequest {
+    userIds?: string[] | null;
+}
+export interface SetAiEnabledRequest {
+    isEnabled: boolean;
 }
 export interface SetCustomFieldValueRequest {
     /** @format uuid */
@@ -5131,15 +5211,6 @@ export interface TaxRatesRequest {
     /** @format double */
     marginalIncomeTaxRate: number;
 }
-export interface TestSendNotificationForLoanRequest {
-    loanData: Record<string, string>;
-    /** @format uuid */
-    siteConfigurationId: string;
-    toAddress?: string | null;
-    toPhoneNumber?: string | null;
-    templateKey?: string | null;
-    attachments: Attachment[];
-}
 export interface Theme {
     logoURL: string;
     primaryColor: string;
@@ -6763,6 +6834,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             sortBy?: string;
             sortDirection?: string;
         }, params?: RequestParams) => Promise<AxiosResponse<AiConfigChangeLogPaginated, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags AiSuperAdmin
+         * @name SetAccountAiEnabled
+         * @summary Enable or disable AI for an account (SuperAdmin only)
+         * @request PUT:/api/ai/superadmin/accounts/{accountId}/ai-enabled
+         * @secure
+         * @response `204` `void` No Content
+         * @response `404` `ProblemDetails` Not Found
+         */
+        setAccountAiEnabled: (accountId: string, data: SetAiEnabledRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
         /**
          * No description
          *
@@ -7860,6 +7943,34 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             sortBy?: string;
             sortDirection?: string;
         }, params?: RequestParams) => Promise<AxiosResponse<EncompassPackageList, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags Encompass Packages
+         * @name GetLoanPackages
+         * @request GET:/api/los/encompass/eclose/loans/{loanId}/packages
+         * @secure
+         * @response `200` `EncompassPackageList` OK
+         * @response `400` `EncompassError` Bad Request
+         * @response `401` `EncompassError` Unauthorized
+         * @response `403` `EncompassError` Forbidden
+         * @response `500` `EncompassError` Internal Server Error
+         */
+        getLoanPackages: (loanId: string, query?: {
+            status?: string;
+            /**
+             * @format int32
+             * @default 1
+             */
+            page?: number;
+            /**
+             * @format int32
+             * @default 20
+             */
+            pageSize?: number;
+            sortBy?: string;
+            sortDirection?: string;
+        }, params?: RequestParams) => Promise<AxiosResponse<EncompassPackageList, any, {}>>;
         /**
          * No description
          *
@@ -8397,18 +8508,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `200` `string` OK
          */
         getLoanEmbeddedSigningLink: (envelopeId: string, userName: string, email: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
-        /**
-         * No description
-         *
-         * @tags LegacyLoan
-         * @name CreateLegacyLoanDocument
-         * @summary Create Document
-         * @request POST:/api/los/loan/generatedocument
-         * @deprecated
-         * @secure
-         * @response `200` `DocumentDataRequest` OK
-         */
-        createLegacyLoanDocument: (data: GenerateDocumentRequest, params?: RequestParams) => Promise<AxiosResponse<DocumentDataRequest, any, {}>>;
         /**
          * No description
          *
@@ -9661,18 +9760,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             /** @format uuid */
             folderID?: string;
         }, params?: RequestParams) => Promise<AxiosResponse<UserLoanTask, any, {}>>;
-        /**
-         * No description
-         *
-         * @tags LoanTaskDocuments
-         * @name CreateLoanTaskDocumentBucket
-         * @summary Create Bucket
-         * @request POST:/api/loans/{loanID}/tasks/{loanTaskId}/documents/bucket
-         * @secure
-         * @response `204` `UserLoanTask` No Content
-         * @response `422` `UnprocessableEntity` Unprocessable Content
-         */
-        createLoanTaskDocumentBucket: (loanId: string, loanTaskId: string, params?: RequestParams) => Promise<AxiosResponse<UserLoanTask, any, {}>>;
         /**
          * No description
          *
@@ -9682,9 +9769,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/api/loans/{loanID}/tasks/reminders/outstanding
          * @secure
          * @response `204` `void` No Content
+         * @response `400` `ProblemDetails` Bad Request
          * @response `404` `ProblemDetails` Not Found
+         * @response `422` `ProblemDetails` Unprocessable Content
          */
-        sendOutstandingLoanTaskNotification: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
+        sendOutstandingLoanTaskNotification: (loanId: string, data: SendOutstandingTaskReminderRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
         /**
          * No description
          *
@@ -10021,32 +10110,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `422` `ProblemDetails` Unprocessable Content
          */
         calculateMortgageRefinance: (data: RefinanceCalculatorRequest, params?: RequestParams) => Promise<AxiosResponse<RefinanceCalculator, any, {}>>;
-        /**
-         * No description
-         *
-         * @tags Notifications
-         * @name SendNotificationForLoan
-         * @summary Send Notification for Loan
-         * @request POST:/api/notifications
-         * @deprecated
-         * @secure
-         * @response `200` `void` OK
-         * @response `422` `UnprocessableEntity` Unprocessable Content
-         */
-        sendNotificationForLoan: (data: SendNotificationForLoanRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
-        /**
-         * No description
-         *
-         * @tags Notifications
-         * @name SendTestNotificationForLoan
-         * @summary Send Test Notification for Loan
-         * @request POST:/api/notifications/test
-         * @deprecated
-         * @secure
-         * @response `200` `void` OK
-         * @response `422` `UnprocessableEntity` Unprocessable Content
-         */
-        sendTestNotificationForLoan: (data: TestSendNotificationForLoanRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
         /**
          * No description
          *

package/dist/index.js

@@ -790,6 +790,18 @@ export class Api extends HttpClient {
              * @response `200` `AiConfigChangeLogPaginated` OK
              */
             getAiConfigChangesCrossAccount: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/superadmin/config-changes`, method: "GET", query: query, secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags AiSuperAdmin
+             * @name SetAccountAiEnabled
+             * @summary Enable or disable AI for an account (SuperAdmin only)
+             * @request PUT:/api/ai/superadmin/accounts/{accountId}/ai-enabled
+             * @secure
+             * @response `204` `void` No Content
+             * @response `404` `ProblemDetails` Not Found
+             */
+            setAccountAiEnabled: (accountId, data, params = {}) => this.request(Object.assign({ path: `/api/ai/superadmin/accounts/${accountId}/ai-enabled`, method: "PUT", body: data, secure: true, type: "application/json" }, params)),
             /**
              * No description
              *
@@ -1786,6 +1798,20 @@ export class Api extends HttpClient {
              * @response `500` `EncompassError` Internal Server Error
              */
             getUserPackages: (query, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/eclose/packages`, method: "GET", query: query, secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags Encompass Packages
+             * @name GetLoanPackages
+             * @request GET:/api/los/encompass/eclose/loans/{loanId}/packages
+             * @secure
+             * @response `200` `EncompassPackageList` OK
+             * @response `400` `EncompassError` Bad Request
+             * @response `401` `EncompassError` Unauthorized
+             * @response `403` `EncompassError` Forbidden
+             * @response `500` `EncompassError` Internal Server Error
+             */
+            getLoanPackages: (loanId, query, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/eclose/loans/${loanId}/packages`, method: "GET", query: query, secure: true, format: "json" }, params)),
             /**
              * No description
              *
@@ -2267,18 +2293,6 @@ export class Api extends HttpClient {
              * @response `200` `string` OK
              */
             getLoanEmbeddedSigningLink: (envelopeId, userName, email, params = {}) => this.request(Object.assign({ path: `/api/los/loan/embeddedsigning/${envelopeId}/${userName}/${email}`, method: "POST", secure: true, format: "json" }, params)),
-            /**
-             * No description
-             *
-             * @tags LegacyLoan
-             * @name CreateLegacyLoanDocument
-             * @summary Create Document
-             * @request POST:/api/los/loan/generatedocument
-             * @deprecated
-             * @secure
-             * @response `200` `DocumentDataRequest` OK
-             */
-            createLegacyLoanDocument: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/generatedocument`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -3404,18 +3418,6 @@ export class Api extends HttpClient {
              * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             createLoanTaskDocument: (loanId, loanTaskId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${loanTaskId}/documents`, method: "POST", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
-            /**
-             * No description
-             *
-             * @tags LoanTaskDocuments
-             * @name CreateLoanTaskDocumentBucket
-             * @summary Create Bucket
-             * @request POST:/api/loans/{loanID}/tasks/{loanTaskId}/documents/bucket
-             * @secure
-             * @response `204` `UserLoanTask` No Content
-             * @response `422` `UnprocessableEntity` Unprocessable Content
-             */
-            createLoanTaskDocumentBucket: (loanId, loanTaskId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${loanTaskId}/documents/bucket`, method: "POST", secure: true, format: "json" }, params)),
             /**
              * No description
              *
@@ -3425,9 +3427,11 @@ export class Api extends HttpClient {
              * @request POST:/api/loans/{loanID}/tasks/reminders/outstanding
              * @secure
              * @response `204` `void` No Content
+             * @response `400` `ProblemDetails` Bad Request
              * @response `404` `ProblemDetails` Not Found
+             * @response `422` `ProblemDetails` Unprocessable Content
              */
-            sendOutstandingLoanTaskNotification: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/reminders/outstanding`, method: "POST", secure: true }, params)),
+            sendOutstandingLoanTaskNotification: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/reminders/outstanding`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
             /**
              * No description
              *
@@ -3750,32 +3754,6 @@ export class Api extends HttpClient {
              * @response `422` `ProblemDetails` Unprocessable Content
              */
             calculateMortgageRefinance: (data, params = {}) => this.request(Object.assign({ path: `/api/mortgage-calculators/refinance`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
-            /**
-             * No description
-             *
-             * @tags Notifications
-             * @name SendNotificationForLoan
-             * @summary Send Notification for Loan
-             * @request POST:/api/notifications
-             * @deprecated
-             * @secure
-             * @response `200` `void` OK
-             * @response `422` `UnprocessableEntity` Unprocessable Content
-             */
-            sendNotificationForLoan: (data, params = {}) => this.request(Object.assign({ path: `/api/notifications`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
-            /**
-             * No description
-             *
-             * @tags Notifications
-             * @name SendTestNotificationForLoan
-             * @summary Send Test Notification for Loan
-             * @request POST:/api/notifications/test
-             * @deprecated
-             * @secure
-             * @response `200` `void` OK
-             * @response `422` `UnprocessableEntity` Unprocessable Content
-             */
-            sendTestNotificationForLoan: (data, params = {}) => this.request(Object.assign({ path: `/api/notifications/test`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
             /**
              * No description
              *