@matech/thebigpos-sdk 3.3.1 → 3.4.0-stag-1921

package/README.md

@@ -40,44 +40,5 @@ apiClient.api.getSiteConfiguration().then((response) => {
 });
 ```
 
-## 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 --enum-style union
-```
-
-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 --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.
-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

@@ -20,6 +20,7 @@ export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
 export type LoanTitleHeld = "Sole" | "JointWithSpouse" | "JointWithOtherThanSpouse";
 export type LoanTaskActivityFilter = "Active" | "Inactive" | "All";
 export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
+export type LoanRefinancePurpose = "CashOutDebtConsolidation" | "CashOutHomeImprovement" | "CashOutOther" | "NoCashOut" | "LimitedCashOut";
 export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell" | "PendingSale";
 export type LoanRealEstateOccupancyType = "PrimaryHome" | "SecondHome" | "InvestmentProperty" | "FHASecondaryResidence";
 export type LoanRealEstateIntendedUsageType = "PrimaryResidence" | "SecondHome" | "Investment" | "Other";
@@ -79,7 +80,7 @@ export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
 export type CompanyDocumentSourceType = "File" | "FreeText";
 export type CompanyDocumentIndexStatus = "Uploaded" | "Indexing" | "Indexed" | "Failed";
 export type ClassificationSource = "Textract" | "Llm" | "Manual";
-export type BulkLoanTaskOperationType = "SetStatus";
+export type BulkLoanTaskOperationType = "SetStatus" | "Delete";
 export type BranchType = "Mortgage" | "RealEstate";
 export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
 export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
@@ -397,6 +398,9 @@ export interface AiAuditLog {
     /** @format uuid */
     messageId?: string | null;
     eventType: AiAuditLogEventTypeEnum;
+    trigger?: string | null;
+    subjectTaskName?: string | null;
+    subjectLoanNumber?: string | null;
     modelId?: string | null;
     /** @format int32 */
     inputTokens?: number | null;
@@ -1026,20 +1030,6 @@ export interface BranchUserPaginated {
     /** @format int64 */
     count: number;
 }
-export interface BulkCompleteLoanTaskFailure {
-    /** @format uuid */
-    userLoanTaskID: string;
-    taskName: string;
-    errorMessage: string;
-}
-export interface BulkCompleteLoanTasks {
-    completed: string[];
-    skipped: string[];
-    failed: BulkCompleteLoanTaskFailure[];
-}
-export interface BulkCompleteLoanTasksRequest {
-    userLoanTaskIDs: string[];
-}
 export interface BulkLoanTaskFailure {
     /** @format uuid */
     userLoanTaskID: string;
@@ -2603,6 +2593,7 @@ export interface Loan {
     propertyAddress?: Address | null;
     property?: LoanProperty | null;
     financial?: LoanFinancial | null;
+    refinance?: LoanRefinance | null;
     financialTerms?: LoanFinancialTerms | null;
     monthlyPayment?: LoanMonthlyPayment | null;
     costDetails?: LoanCostDetails | null;
@@ -2629,6 +2620,7 @@ export interface LoanApplication {
     startDate?: string | null;
     property?: LoanProperty | null;
     financial?: LoanFinancial | null;
+    refinance?: LoanRefinance | null;
     borrowers: LoanBorrower[];
     nonOwningBorrowers: LoanNonOwningBorrower[];
 }
@@ -2645,6 +2637,7 @@ export interface LoanApplicationRequest {
     companyName?: string | null;
     property?: LoanPropertyRequest | null;
     financial?: LoanFinancialRequest | null;
+    refinance?: LoanRefinanceRequest | null;
     financialTerms?: LoanFinancialTermsRequest | null;
     monthlyPayment?: LoanMonthlyPaymentRequest | null;
     borrowers: LoanBorrowerRequest[];
@@ -2709,6 +2702,7 @@ export interface LoanBorrowerAccountAsset {
 }
 export interface LoanBorrowerAccountAssetRequest {
     name?: string | null;
+    accountNumber?: string | null;
     financialInstitution?: string | null;
     /** @format double */
     value?: number | null;
@@ -4030,8 +4024,51 @@ export interface LoanRecord {
     loanGuid: string;
     loanFields: Record<string, string>;
 }
+export interface LoanRefinance {
+    /** @format uuid */
+    id?: string | null;
+    /** @format int32 */
+    yearAcquired?: number | null;
+    /** @format double */
+    valueOfLot?: number | null;
+    /** @format double */
+    originalCost?: number | null;
+    /** @format double */
+    existingLiens?: number | null;
+    /** @format double */
+    costOfImprovements?: number | null;
+    purpose?: LoanRefinancePurpose | null;
+    currentLoan?: LoanRefinanceCurrentLoan | null;
+}
+export interface LoanRefinanceCurrentLoan {
+    /** @format uuid */
+    id?: string | null;
+    lender?: string | null;
+    /** @format double */
+    interestRate?: number | null;
+    /** @format double */
+    monthlyPayment?: number | null;
+    /** @format double */
+    remainingBalance?: number | null;
+    loanType?: LoanType | null;
+}
+export interface LoanRefinanceCurrentLoanRequest {
+    lender?: string | null;
+    /** @format double */
+    interestRate?: number | null;
+    loanType?: LoanType | null;
+}
+export interface LoanRefinanceRequest {
+    /** @format double */
+    originalCost?: number | null;
+    /** @format double */
+    existingLiens?: number | null;
+    purpose?: LoanRefinancePurpose | null;
+    currentLoan?: LoanRefinanceCurrentLoanRequest | null;
+}
 export interface LoanSearchCriteria {
     searchText?: string | null;
+    searchTerms?: string[] | null;
     /** @format uuid */
     loanOfficerId?: string | null;
     loanNumber?: string | null;
@@ -6451,12 +6488,16 @@ export interface UserTableSettings {
     columnOrder: string[];
     sortColumnId?: string | null;
     sortDirection?: SortDirection | null;
+    searchTerms: string[];
+    pinnedColumnIds: string[];
 }
 export interface UserTableSettingsRequest {
     hiddenColumnIds: string[];
     columnOrder: string[];
     sortColumnId?: string | null;
     sortDirection?: SortDirection | null;
+    searchTerms: string[];
+    pinnedColumnIds: string[];
 }
 export interface VerifyEmailRequest {
     token: string;
@@ -6634,7 +6675,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v3.3.1
+ * @version v3.4.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -6972,7 +7013,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         updateAiAdminSettings: (data: AiAdminSettingsRequest, params?: RequestParams) => Promise<AxiosResponse<AiAdminSettings, any, {}>>;
         /**
-         * No description
+         * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
          *
          * @tags AiAudit
          * @name GetAiAuditLogs
@@ -7002,6 +7043,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             pageNumber?: number;
             sortBy?: string;
             sortDirection?: string;
+            eventTypes?: AiAuditEventType[];
+            trigger?: string;
         }, params?: RequestParams) => Promise<AxiosResponse<AiAuditLogPaginated, any, {}>>;
         /**
          * No description
@@ -7018,7 +7061,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             accountId?: string;
         }, params?: RequestParams) => Promise<AxiosResponse<AiAuditLog[], any, {}>>;
         /**
-         * No description
+         * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
          *
          * @tags AiAudit
          * @name GetAiAuditConversations
@@ -7043,7 +7086,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             sortDirection?: string;
         }, params?: RequestParams) => Promise<AxiosResponse<AiConversationAuditSummaryPaginated, any, {}>>;
         /**
-         * No description
+         * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
          *
          * @tags AiAudit
          * @name GetAiStats
@@ -7061,7 +7104,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             endDate?: string;
         }, params?: RequestParams) => Promise<AxiosResponse<AiAdminStats, any, {}>>;
         /**
-         * No description
+         * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
          *
          * @tags AiAudit
          * @name GetAiConfigChanges
@@ -7698,7 +7741,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             sortDirection?: string;
         }, params?: RequestParams) => Promise<AxiosResponse<AiTokenUsageWindowPaginated, any, {}>>;
         /**
-         * No description
+         * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
          *
          * @tags AuditLog
          * @name SearchAuditLogs
@@ -9800,6 +9843,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/api/listings
          * @secure
          * @response `201` `Listing` Created
+         * @response `403` `ProblemDetails` Forbidden
          */
         createListing: (data: ListingRequest, params?: RequestParams) => Promise<AxiosResponse<Listing, any, {}>>;
         /**
@@ -9833,6 +9877,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/api/listings/{id}
          * @secure
          * @response `200` `Listing` OK
+         * @response `403` `ProblemDetails` Forbidden
          */
         replaceListing: (id: string, data: ListingRequest, params?: RequestParams) => Promise<AxiosResponse<Listing, any, {}>>;
         /**
@@ -10878,20 +10923,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `404` `ProblemDetails` Not Found
          */
         triggerAso: (loanId: string, data: TriggerAsoRequest, params?: RequestParams) => Promise<AxiosResponse<AutomatedService, any, {}>>;
-        /**
-         * @description Deprecated - use POST api/loans/tasks/bulk, which reaches every status and accepts tasks from more than one loan.
-         *
-         * @tags LoanTaskBulkCompletions
-         * @name BulkCompleteLoanTasks
-         * @summary [Deprecated] Bulk complete loan tasks
-         * @request POST:/api/loans/{loanID}/tasks/bulk-complete
-         * @deprecated
-         * @secure
-         * @response `200` `BulkCompleteLoanTasks` OK
-         * @response `404` `ProblemDetails` Not Found
-         * @response `422` `UnprocessableEntity` Unprocessable Content
-         */
-        bulkCompleteLoanTasks: (loanId: string, data: BulkCompleteLoanTasksRequest, params?: RequestParams) => Promise<AxiosResponse<BulkCompleteLoanTasks, any, {}>>;
         /**
          * No description
          *

package/dist/index.js

@@ -95,7 +95,7 @@ export class HttpClient {
 }
 /**
  * @title The Big POS API
- * @version v3.3.1
+ * @version v3.4.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -432,7 +432,7 @@ export class Api extends HttpClient {
              */
             updateAiAdminSettings: (data, params = {}) => this.request(Object.assign({ path: `/api/ai/settings`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
-             * No description
+             * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
              *
              * @tags AiAudit
              * @name GetAiAuditLogs
@@ -454,7 +454,7 @@ export class Api extends HttpClient {
              */
             getAiRequestLifecycle: (requestId, query, params = {}) => this.request(Object.assign({ path: `/api/ai/audit-logs/request/${requestId}`, method: "GET", query: query, secure: true, format: "json" }, params)),
             /**
-             * No description
+             * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
              *
              * @tags AiAudit
              * @name GetAiAuditConversations
@@ -465,7 +465,7 @@ export class Api extends HttpClient {
              */
             getAiAuditConversations: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/audit-conversations`, method: "GET", query: query, secure: true, format: "json" }, params)),
             /**
-             * No description
+             * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
              *
              * @tags AiAudit
              * @name GetAiStats
@@ -476,7 +476,7 @@ export class Api extends HttpClient {
              */
             getAiStats: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/stats`, method: "GET", query: query, secure: true, format: "json" }, params)),
             /**
-             * No description
+             * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
              *
              * @tags AiAudit
              * @name GetAiConfigChanges
@@ -1034,7 +1034,7 @@ export class Api extends HttpClient {
              */
             getAiUsageHistory: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/usage/history`, method: "GET", query: query, secure: true, format: "json" }, params)),
             /**
-             * No description
+             * @description startDate and endDate accept any ISO-8601 value. A value with no timezone designator (2026-09-01 or 2026-09-01T00:00:00) is read as UTC; a value with Z or an offset is used as the instant it names. A date-only value names the start of that day, so endDate=2026-09-01 returns nothing recorded on the 1st; to include that day send endDate=2026-09-02, or an explicit time such as 2026-09-01T23:59:59.
              *
              * @tags AuditLog
              * @name SearchAuditLogs
@@ -2921,6 +2921,7 @@ export class Api extends HttpClient {
              * @request POST:/api/listings
              * @secure
              * @response `201` `Listing` Created
+             * @response `403` `ProblemDetails` Forbidden
              */
             createListing: (data, params = {}) => this.request(Object.assign({ path: `/api/listings`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
@@ -2954,6 +2955,7 @@ export class Api extends HttpClient {
              * @request PUT:/api/listings/{id}
              * @secure
              * @response `200` `Listing` OK
+             * @response `403` `ProblemDetails` Forbidden
              */
             replaceListing: (id, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
@@ -3900,20 +3902,6 @@ export class Api extends HttpClient {
              * @response `404` `ProblemDetails` Not Found
              */
             triggerAso: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/aso`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
-            /**
-             * @description Deprecated - use POST api/loans/tasks/bulk, which reaches every status and accepts tasks from more than one loan.
-             *
-             * @tags LoanTaskBulkCompletions
-             * @name BulkCompleteLoanTasks
-             * @summary [Deprecated] Bulk complete loan tasks
-             * @request POST:/api/loans/{loanID}/tasks/bulk-complete
-             * @deprecated
-             * @secure
-             * @response `200` `BulkCompleteLoanTasks` OK
-             * @response `404` `ProblemDetails` Not Found
-             * @response `422` `UnprocessableEntity` Unprocessable Content
-             */
-            bulkCompleteLoanTasks: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/bulk-complete`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *