@matech/thebigpos-sdk 3.9.0-stag-3774 → 3.9.0

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

@@ -8,6 +8,7 @@ export type SiteTileLocation = "HomePage" | "Dashboard";
 export type SiteConfigurationType = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
 export type SigningMethod = "ConsumerConnect" | "POSF";
 export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
+export type PendingInviteStatus = "InvitePending" | "InviteExpired" | "NotInvited";
 export type OutboundFailureSeverity = "All" | "Failed" | "CompletedWithErrors";
 export type LosWebhookSigningKeySyncStatus = "Unknown" | "Synced";
 export type LosWebhookInventoryStatus = "Unknown" | "Healthy" | "Disabled" | "Missing";
@@ -451,6 +452,7 @@ export interface AiCanonicalField {
     createdAt: string;
     /** @format date-time */
     updatedAt?: string | null;
+    updatedBy?: AiUpdatedBy | null;
 }
 export interface AiChat {
     /** @format uuid */
@@ -628,6 +630,7 @@ export interface AiGuardrail {
     createdAt: string;
     /** @format date-time */
     updatedAt?: string | null;
+    updatedBy?: AiUpdatedBy | null;
 }
 export interface AiPrompt {
     /** @format uuid */
@@ -660,6 +663,7 @@ export interface AiPrompt {
     createdAt: string;
     /** @format date-time */
     updatedAt?: string | null;
+    updatedBy?: AiUpdatedBy | null;
 }
 export interface AiPromptRun {
     /** @format uuid */
@@ -693,6 +697,12 @@ export interface AiPromptRunResult {
     /** @format double */
     confidence?: number | null;
 }
+export interface AiPromptRunVerdictBackfill {
+    /** @format int32 */
+    updated: number;
+    /** @format int32 */
+    remaining: number;
+}
 export interface AiPromptSummary {
     /** @format uuid */
     id: string;
@@ -764,6 +774,13 @@ export interface AiToolCatalogItem {
     description: string;
     isWriteTool: boolean;
 }
+export interface AiUpdatedBy {
+    /** @format uuid */
+    id: string;
+    firstName: string;
+    lastName: string;
+    email: string;
+}
 export interface AiUrlDomain {
     host: string;
     status?: AiUrlDomainStatus | null;
@@ -797,6 +814,7 @@ export interface AiUrlSource {
     createdAt: string;
     /** @format date-time */
     updatedAt?: string | null;
+    updatedBy?: AiUpdatedBy | null;
     indexStatus?: CompanyDocumentIndexStatus | null;
     indexError?: string | null;
     /** @format date-time */
@@ -1431,6 +1449,8 @@ export interface CreateLoanRoleTaskRequest {
     borrowerPair: number;
     /** @format int32 */
     borrowerPosition: number;
+    /** @format date */
+    dueDate?: string | null;
 }
 export interface CreateSession {
     sessionId: string;
@@ -4819,15 +4839,18 @@ export interface PartnerSearchCriteria {
     roles?: UserRole[] | null;
 }
 export interface PendingInvite {
+    status: PendingInviteStatusEnum;
+    /** @format uuid */
+    inviteId?: string | null;
     /** @format uuid */
-    inviteId: string;
+    contactId?: string | null;
     firstName: string;
     lastName: string;
     email: string;
     phoneNumber?: string | null;
-    role?: LoanRole | null;
+    role: PendingInviteRoleEnum;
     /** @format date-time */
-    createdAt: string;
+    createdAt?: string | null;
     url: string;
 }
 export interface PendingInvitesSummary {
@@ -5004,6 +5027,12 @@ export interface RejectAiUrlDomainRequest {
 export interface RenameAiConversationRequest {
     name: string;
 }
+export interface ReorderLoanRoleTasksRequest {
+    loanRoleTaskIds: string[];
+}
+export interface ReorderLoanTasksRequest {
+    userLoanTaskIDs: string[];
+}
 export interface RequestImpersonationRequest {
     email: string;
 }
@@ -6227,7 +6256,6 @@ export interface UpdateMeRequest {
     lastName: string;
     email: string;
     title?: string | null;
-    forcePasswordReset: boolean;
     mfaEnabled?: boolean | null;
     notificationSettings: UserNotificationSettingsUpdateRequest;
     /** @format uuid */
@@ -6827,6 +6855,8 @@ export type LosWebhookEntryStatusEnum = "Registered" | "Disabled" | "Missing" |
 export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disabled" | "Missing";
 export type LosWebhookSigningKeySyncResultStatusEnum = "Unknown" | "Synced";
 export type ManualDocumentClassificationRequestDocumentTypeEnum = "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" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
+export type PendingInviteStatusEnum = "InvitePending" | "InviteExpired" | "NotInvited";
+export type PendingInviteRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
 export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
 export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
@@ -7236,7 +7266,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         updateAiAdminSettings: (data: AiAdminSettingsRequest, params?: RequestParams) => Promise<AxiosResponse<AiAdminSettings, any, {}>>;
         /**
-         * @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.
+         * @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. searchText (case-insensitive substring of the loan number, or of the loan task name for runs against a loan task), taskId (task-upload runs only: a task definition, including the loan tasks cloned from it) and severity (exactly info, warning or critical, the run's most severe finding; any other value is a 400) match through the automated prompt run behind each row. When any of them is set, only rows that belong to such a run are returned, so trigger publications, coalesced triggers and skips that happened before a run was recorded never match.
          *
          * @tags AiAudit
          * @name GetAiAuditLogs
@@ -7244,6 +7274,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/api/ai/audit-logs
          * @secure
          * @response `200` `AiAuditLogPaginated` OK
+         * @response `400` `ProblemDetails` Bad Request
          */
         getAiAuditLogs: (query?: {
             /** @format uuid */
@@ -7268,6 +7299,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             sortDirection?: string;
             eventTypes?: AiAuditEventType[];
             trigger?: string;
+            searchText?: string;
+            /** @format uuid */
+            taskId?: string;
+            severity?: string;
         }, params?: RequestParams) => Promise<AxiosResponse<AiAuditLogPaginated, any, {}>>;
         /**
          * No description
@@ -7727,6 +7762,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             /** @format uuid */
             subjectEntityId?: string;
         }, params?: RequestParams) => Promise<AxiosResponse<AiPromptRun[], any, {}>>;
+        /**
+         * No description
+         *
+         * @tags AiPromptRunAdmin
+         * @name BackfillAiPromptRunVerdicts
+         * @summary Stamp Verdict and HighestSeverity on existing Succeeded prompt runs (SuperAdmin)
+         * @request POST:/api/ai/prompt-runs/backfill-verdicts
+         * @secure
+         * @response `200` `AiPromptRunVerdictBackfill` OK
+         * @response `401` `ProblemDetails` Unauthorized
+         * @response `403` `ProblemDetails` Forbidden
+         */
+        backfillAiPromptRunVerdicts: (query?: {
+            dryRun?: boolean;
+        }, params?: RequestParams) => Promise<AxiosResponse<AiPromptRunVerdictBackfill, any, {}>>;
         /**
          * No description
          *
@@ -11060,7 +11110,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getLoanRoleTasks: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<LoanRoleSlotTasks[], any, {}>>;
         /**
-         * @description Queues an account template against a borrower slot that has no registered user yet. The row owns a per-loan copy of the template, so editing it never changes the account's catalogue.
+         * @description Queues an account template against a borrower slot that has no registered user yet. The row owns a per-loan copy of the template, so editing it never changes the account's catalogue. An optional due date is stored on the row; without one the row has none.
          *
          * @tags LoanRoleTasks
          * @name CreateLoanRoleTask
@@ -11114,6 +11164,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `409` `ProblemDetails` Conflict
          */
         deleteLoanRoleTask: (loanId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
+        /**
+         * @description Sets the order the loan's queued tasks show in within each borrower slot. The list names every queued row that has not been attached yet, first to last, and may span several slots; a list that no longer matches the loan, or that names an attached row, is refused with 409. Two reorders sent at once do not mix: the last to save wins as a whole.
+         *
+         * @tags LoanRoleTasks
+         * @name ReorderLoanRoleTasks
+         * @summary Reorder the queued tasks
+         * @request PUT:/api/loans/{loanId}/role-tasks/order
+         * @secure
+         * @response `204` `void` No Content
+         * @response `404` `ProblemDetails` Not Found
+         * @response `409` `ProblemDetails` Conflict
+         * @response `422` `ProblemDetails` Unprocessable Content
+         */
+        reorderLoanRoleTasks: (loanId: string, data: ReorderLoanRoleTasksRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
         /**
          * @description Runs the account's business rules against the loan and queues what is missing. Templates already queued, and ones removed by staff, are left alone.
          *
@@ -11515,6 +11579,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `404` `ProblemDetails` Not Found
          */
         deleteLoanTask: (loanId: string, userLoanTaskId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
+        /**
+         * @description Sets the order the loan's tasks show in. The list names every task on the loan once, first to last; a list that no longer matches the loan is refused with 409 so a stale screen cannot move a task unseen. The order is written to the loan's own copies of the tasks, so the account's catalogue is untouched. Two reorders sent at once do not mix: the last to save wins as a whole.
+         *
+         * @tags LoanTasksForSingleLoan
+         * @name ReorderLoanTasks
+         * @summary Reorder
+         * @request PUT:/api/loans/{loanID}/tasks/order
+         * @secure
+         * @response `204` `void` No Content
+         * @response `400` `ProblemDetails` Bad Request
+         * @response `404` `ProblemDetails` Not Found
+         * @response `409` `ProblemDetails` Conflict
+         * @response `422` `ProblemDetails` Unprocessable Content
+         */
+        reorderLoanTasks: (loanId: string, data: ReorderLoanTasksRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
         /**
          * No description
          *
@@ -12481,6 +12560,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/api/template-tokens
          * @secure
          * @response `200` `(TemplateTokenRoot)[]` OK
+         * @response `403` `ProblemDetails` Forbidden
          */
         getTemplateTokens: (params?: RequestParams) => Promise<AxiosResponse<TemplateTokenRoot[], 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;
@@ -432,7 +438,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)),
             /**
-             * @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.
+             * @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. searchText (case-insensitive substring of the loan number, or of the loan task name for runs against a loan task), taskId (task-upload runs only: a task definition, including the loan tasks cloned from it) and severity (exactly info, warning or critical, the run's most severe finding; any other value is a 400) match through the automated prompt run behind each row. When any of them is set, only rows that belong to such a run are returned, so trigger publications, coalesced triggers and skips that happened before a run was recorded never match.
              *
              * @tags AiAudit
              * @name GetAiAuditLogs
@@ -440,6 +446,7 @@ export class Api extends HttpClient {
              * @request GET:/api/ai/audit-logs
              * @secure
              * @response `200` `AiAuditLogPaginated` OK
+             * @response `400` `ProblemDetails` Bad Request
              */
             getAiAuditLogs: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/audit-logs`, method: "GET", query: query, secure: true, format: "json" }, params)),
             /**
@@ -818,6 +825,19 @@ export class Api extends HttpClient {
              * @response `400` `ProblemDetails` Bad Request
              */
             getAiPromptRuns: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/prompt-runs`, method: "GET", query: query, secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags AiPromptRunAdmin
+             * @name BackfillAiPromptRunVerdicts
+             * @summary Stamp Verdict and HighestSeverity on existing Succeeded prompt runs (SuperAdmin)
+             * @request POST:/api/ai/prompt-runs/backfill-verdicts
+             * @secure
+             * @response `200` `AiPromptRunVerdictBackfill` OK
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             */
+            backfillAiPromptRunVerdicts: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/prompt-runs/backfill-verdicts`, method: "POST", query: query, secure: true, format: "json" }, params)),
             /**
              * No description
              *
@@ -3820,7 +3840,7 @@ export class Api extends HttpClient {
              */
             getLoanRoleTasks: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/role-tasks`, method: "GET", secure: true, format: "json" }, params)),
             /**
-             * @description Queues an account template against a borrower slot that has no registered user yet. The row owns a per-loan copy of the template, so editing it never changes the account's catalogue.
+             * @description Queues an account template against a borrower slot that has no registered user yet. The row owns a per-loan copy of the template, so editing it never changes the account's catalogue. An optional due date is stored on the row; without one the row has none.
              *
              * @tags LoanRoleTasks
              * @name CreateLoanRoleTask
@@ -3874,6 +3894,20 @@ export class Api extends HttpClient {
              * @response `409` `ProblemDetails` Conflict
              */
             deleteLoanRoleTask: (loanId, id, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/role-tasks/${id}`, method: "DELETE", secure: true }, params)),
+            /**
+             * @description Sets the order the loan's queued tasks show in within each borrower slot. The list names every queued row that has not been attached yet, first to last, and may span several slots; a list that no longer matches the loan, or that names an attached row, is refused with 409. Two reorders sent at once do not mix: the last to save wins as a whole.
+             *
+             * @tags LoanRoleTasks
+             * @name ReorderLoanRoleTasks
+             * @summary Reorder the queued tasks
+             * @request PUT:/api/loans/{loanId}/role-tasks/order
+             * @secure
+             * @response `204` `void` No Content
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             * @response `422` `ProblemDetails` Unprocessable Content
+             */
+            reorderLoanRoleTasks: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/role-tasks/order`, method: "PUT", body: data, secure: true, type: "application/json" }, params)),
             /**
              * @description Runs the account's business rules against the loan and queues what is missing. Templates already queued, and ones removed by staff, are left alone.
              *
@@ -4246,6 +4280,21 @@ export class Api extends HttpClient {
              * @response `404` `ProblemDetails` Not Found
              */
             deleteLoanTask: (loanId, userLoanTaskId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}`, method: "DELETE", secure: true }, params)),
+            /**
+             * @description Sets the order the loan's tasks show in. The list names every task on the loan once, first to last; a list that no longer matches the loan is refused with 409 so a stale screen cannot move a task unseen. The order is written to the loan's own copies of the tasks, so the account's catalogue is untouched. Two reorders sent at once do not mix: the last to save wins as a whole.
+             *
+             * @tags LoanTasksForSingleLoan
+             * @name ReorderLoanTasks
+             * @summary Reorder
+             * @request PUT:/api/loans/{loanID}/tasks/order
+             * @secure
+             * @response `204` `void` No Content
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             * @response `422` `ProblemDetails` Unprocessable Content
+             */
+            reorderLoanTasks: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/order`, method: "PUT", body: data, secure: true, type: "application/json" }, params)),
             /**
              * No description
              *
@@ -5105,6 +5154,7 @@ export class Api extends HttpClient {
              * @request GET:/api/template-tokens
              * @secure
              * @response `200` `(TemplateTokenRoot)[]` OK
+             * @response `403` `ProblemDetails` Forbidden
              */
             getTemplateTokens: (params = {}) => this.request(Object.assign({ path: `/api/template-tokens`, method: "GET", secure: true, format: "json" }, params)),
             /**