@matech/thebigpos-sdk 3.4.0-stag-1921 → 3.5.0-dev-2243

package/README.md

@@ -40,5 +40,44 @@ 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

@@ -91,12 +91,12 @@ export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
 export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
 export type AiUrlSourceApprovalStatus = "Pending" | "Approved" | "Rejected";
 export type AiUrlDomainStatus = "Approved" | "Rejected";
-export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
+export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages" | "PendingLoanUpdate";
 export type AiPromptScope = "General" | "LoanSpecific";
 export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
 export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
 export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
-export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved" | "PromptResolutionFailed" | "PromptTriggerPublished" | "PromptTriggerSkipped" | "PromptRunCompleted";
+export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved" | "PromptResolutionFailed" | "PromptTriggerPublished" | "PromptTriggerSkipped" | "PromptRunCompleted" | "LoanUpdateProposed" | "LoanUpdateApplied" | "LoanUpdateRefused";
 export type AddressFamily = "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 interface ASOSettings {
     enabled: boolean;
@@ -495,6 +495,8 @@ export interface AiChatRequest {
     documentIds?: string[] | null;
     /** @format uuid */
     promptId?: string | null;
+    /** @format uuid */
+    pendingLoanUpdateId?: string | null;
 }
 export interface AiChatStructuredData {
     type: AiChatStructuredDataTypeEnum;
@@ -506,6 +508,8 @@ export interface AiChatStructuredData {
     generatedDocumentId?: string | null;
     generatedFileName?: string | null;
     passages?: AiCitedPassage[] | null;
+    /** @format uuid */
+    pendingLoanUpdateId?: string | null;
 }
 export interface AiCitedDocument {
     /** @format uuid */
@@ -751,6 +755,7 @@ export interface AiToolCatalogItem {
     toolName: string;
     displayName: string;
     description: string;
+    isWriteTool: boolean;
 }
 export interface AiUrlDomain {
     host: string;
@@ -3477,6 +3482,8 @@ export interface LoanDocument {
     losStatus: string;
     contents?: string | null;
     failoverDocumentPath?: string | null;
+    /** @format int64 */
+    fileSizeBytes?: number | null;
     /** @format date-time */
     sensitiveDataPurgedOn?: string | null;
     observedDocumentType?: LoanDocumentType | null;
@@ -4063,6 +4070,8 @@ export interface LoanRefinanceRequest {
     originalCost?: number | null;
     /** @format double */
     existingLiens?: number | null;
+    /** @format int32 */
+    yearAcquired?: number | null;
     purpose?: LoanRefinancePurpose | null;
     currentLoan?: LoanRefinanceCurrentLoanRequest | null;
 }
@@ -6360,6 +6369,8 @@ export interface UserLoanTask {
     completedDate?: string | null;
     /** @format date-time */
     createdAt: string;
+    /** @format date */
+    dueDate?: string | null;
     createdBy: User;
     submittedBy?: User | null;
     completedBy?: User | null;
@@ -6380,6 +6391,8 @@ export interface UserLoanTaskRequest {
 export interface UserLoanTaskUpdateRequest {
     status?: string | null;
     value?: string | null;
+    /** @format date */
+    dueDate?: string | null;
 }
 export interface UserMobilePhoneVerificationRequest {
     code: string;
@@ -6528,8 +6541,8 @@ export interface Workflow {
     icon: string;
 }
 export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
-export type AiAuditLogEventTypeEnum = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved" | "PromptResolutionFailed" | "PromptTriggerPublished" | "PromptTriggerSkipped" | "PromptRunCompleted";
-export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
+export type AiAuditLogEventTypeEnum = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved" | "PromptResolutionFailed" | "PromptTriggerPublished" | "PromptTriggerSkipped" | "PromptRunCompleted" | "LoanUpdateProposed" | "LoanUpdateApplied" | "LoanUpdateRefused";
+export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages" | "PendingLoanUpdate";
 export type AiCitedDocumentSourceTypeEnum = "File" | "FreeText";
 export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
 export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
@@ -6675,7 +6688,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v3.4.0
+ * @version v3.5.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -10964,6 +10977,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          * @response `201` `TaskComment` Created
          * @response `404` `ProblemDetails` Not Found
+         * @response `422` `UnprocessableEntity` Unprocessable Content
          */
         createLoanTaskComment: (loanId: string, userLoanTaskId: string, data: TaskCommentRequest, params?: RequestParams) => Promise<AxiosResponse<TaskComment, any, {}>>;
         /**
@@ -10976,6 +10990,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          * @response `200` `TaskComment` OK
          * @response `404` `ProblemDetails` Not Found
+         * @response `422` `UnprocessableEntity` Unprocessable Content
          */
         replaceLoanTaskComment: (loanId: string, userLoanTaskId: string, commentId: string, data: TaskCommentRequest, params?: RequestParams) => Promise<AxiosResponse<TaskComment, any, {}>>;
         /**

package/dist/index.js

@@ -86,7 +86,13 @@ export class HttpClient {
             const property = input[key];
             const propertyContent = property instanceof Array ? property : [property];
             for (const formItem of propertyContent) {
-                const isFileType = formItem instanceof Blob || formItem instanceof File;
+                // React Native files are plain { uri, name, type } objects, not Blob/File.
+                const isReactNativeFile = !!formItem &&
+                    typeof formItem === "object" &&
+                    "uri" in formItem &&
+                    "name" in formItem &&
+                    "type" in formItem;
+                const isFileType = isReactNativeFile || formItem instanceof Blob || formItem instanceof File;
                 formData.append(key, isFileType ? formItem : this.stringifyFormItem(formItem));
             }
             return formData;
@@ -95,7 +101,7 @@ export class HttpClient {
 }
 /**
  * @title The Big POS API
- * @version v3.4.0
+ * @version v3.5.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -3936,6 +3942,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `201` `TaskComment` Created
              * @response `404` `ProblemDetails` Not Found
+             * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             createLoanTaskComment: (loanId, userLoanTaskId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
@@ -3948,6 +3955,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `200` `TaskComment` OK
              * @response `404` `ProblemDetails` Not Found
+             * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             replaceLoanTaskComment: (loanId, userLoanTaskId, commentId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/${commentId}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**