@matech/thebigpos-sdk 3.26.0-dev-8236 → 3.26.0-dev-8279

package/dist/index.d.ts

@@ -115,6 +115,7 @@ export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "
 export type AiUrlSourceApprovalStatus = "Pending" | "Approved" | "Rejected";
 export type AiUrlDomainStatus = "Approved" | "Rejected";
 export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages" | "PendingLoanUpdate";
+export type AiReadAloudVoice = "Automatic" | "UsFemale" | "UsMale" | "UkFemale" | "UkMale";
 export type AiPromptScope = "General" | "LoanSpecific";
 export type AiPromptCategory = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
 export type AiPendingLoanUpdateOutcome = "Applied" | "Refused";
@@ -343,14 +344,24 @@ export interface AffordabilityCalculatorRequest {
     /** @format double */
     annualInsurance: number;
 }
+export interface AiAccess {
+    isEnabled: boolean;
+    assistantName: string;
+    readAloudVoice: AiAccessReadAloudVoiceEnum;
+}
 export interface AiAccountSettings {
     bedrockModelId: string;
     isUsingAppDefault: boolean;
     enabledTriggers: string[];
+    assistantName: string;
+    isUsingDefaultAssistantName: boolean;
+    readAloudVoice: AiAccountSettingsReadAloudVoiceEnum;
 }
 export interface AiAccountSettingsRequest {
     bedrockModelId?: string | null;
     enabledTriggers?: string[] | null;
+    assistantName?: string | null;
+    readAloudVoice?: AiReadAloudVoice | null;
 }
 export interface AiAccountUsageOverview {
     /** @format uuid */
@@ -5050,6 +5061,8 @@ export interface MyPartner {
     email: string;
     phone?: string | null;
     tier: MyPartnerTierEnum;
+    isOnLoanOfficerList: boolean;
+    isFromPartnerSite: boolean;
     /** @format date-time */
     createdAt: string;
 }
@@ -7336,6 +7349,8 @@ type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
 } & Type;
 export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
 export type AdminAccessUserMfaFactorEnum = "None" | "Sms" | "Email";
+export type AiAccessReadAloudVoiceEnum = "Automatic" | "UsFemale" | "UsMale" | "UkFemale" | "UkMale";
+export type AiAccountSettingsReadAloudVoiceEnum = "Automatic" | "UsFemale" | "UsMale" | "UkFemale" | "UkMale";
 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" | "PromptTriggerCoalesced" | "RecommendationRunCompleted" | "BoundPromptForced";
 export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages" | "PendingLoanUpdate";
 export type AiCitedDocumentSourceTypeEnum = "File" | "FreeText";
@@ -7720,12 +7735,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          *
          * @tags AiAccess
          * @name GetAiAccess
-         * @summary Get whether AI is enabled for the current user and site
+         * @summary Get whether AI is enabled for the current user and site, with the account's assistant name and voice
          * @request GET:/api/ai/access
          * @secure
-         * @response `200` `AiEnabled` OK
+         * @response `200` `AiAccess` OK
          */
-        getAiAccess: (params?: RequestParams) => Promise<AxiosResponse<AiEnabled, any, {}, any>>;
+        getAiAccess: (params?: RequestParams) => Promise<AxiosResponse<AiAccess, any, {}, any>>;
         /**
          * No description
          *
@@ -14581,7 +14596,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         deleteRelationshipProspect: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
         /**
-         * @description The partners on the loan officer's list and the loan officer's portal relations, plus the open partner invites the loan officer sent
+         * @description The partner profiles on the loan officer's list, pending partners who have not signed up yet included, and the loan officer's portal relations
          *
          * @tags UsersMe
          * @name GetMyPartners
@@ -14593,31 +14608,31 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getMyPartners: (params?: RequestParams) => Promise<AxiosResponse<MyPartner[], any, {}, any>>;
         /**
-         * No description
+         * @description Adds a partner, by partner profile ID, to the loan officer's list; a pending partner can be added too
          *
          * @tags UsersMe
          * @name AddMyPartner
          * @summary Add My Partner
-         * @request POST:/api/users/me/partners/{partnerId}
+         * @request POST:/api/users/me/partners/{partnerProfileId}
          * @secure
          * @response `204` `void` No Content
          * @response `403` `ProblemDetails` Forbidden
          * @response `404` `ProblemDetails` Not Found
          */
-        addMyPartner: (partnerId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
+        addMyPartner: (partnerProfileId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
         /**
-         * No description
+         * @description Takes a partner, by partner profile ID, off the loan officer's own list
          *
          * @tags UsersMe
          * @name RemoveMyPartner
          * @summary Remove My Partner
-         * @request DELETE:/api/users/me/partners/{partnerId}
+         * @request DELETE:/api/users/me/partners/{partnerProfileId}
          * @secure
          * @response `204` `void` No Content
          * @response `403` `ProblemDetails` Forbidden
          * @response `404` `ProblemDetails` Not Found
          */
-        removeMyPartner: (partnerId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
+        removeMyPartner: (partnerProfileId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
         /**
          * @description The links that attribute an application to the partner, on the site of each loan officer the partner works with
          *

package/dist/index.js

@@ -256,10 +256,10 @@ export class Api extends HttpClient {
              *
              * @tags AiAccess
              * @name GetAiAccess
-             * @summary Get whether AI is enabled for the current user and site
+             * @summary Get whether AI is enabled for the current user and site, with the account's assistant name and voice
              * @request GET:/api/ai/access
              * @secure
-             * @response `200` `AiEnabled` OK
+             * @response `200` `AiAccess` OK
              */
             getAiAccess: (params = {}) => this.request(Object.assign({ path: `/api/ai/access`, method: "GET", secure: true, format: "json" }, params)),
             /**
@@ -6433,7 +6433,7 @@ export class Api extends HttpClient {
              */
             deleteRelationshipProspect: (id, params = {}) => this.request(Object.assign({ path: `/api/users/me/relationships/prospects/${id}`, method: "DELETE", secure: true }, params)),
             /**
-             * @description The partners on the loan officer's list and the loan officer's portal relations, plus the open partner invites the loan officer sent
+             * @description The partner profiles on the loan officer's list, pending partners who have not signed up yet included, and the loan officer's portal relations
              *
              * @tags UsersMe
              * @name GetMyPartners
@@ -6445,31 +6445,31 @@ export class Api extends HttpClient {
              */
             getMyPartners: (params = {}) => this.request(Object.assign({ path: `/api/users/me/partners`, method: "GET", secure: true, format: "json" }, params)),
             /**
-             * No description
+             * @description Adds a partner, by partner profile ID, to the loan officer's list; a pending partner can be added too
              *
              * @tags UsersMe
              * @name AddMyPartner
              * @summary Add My Partner
-             * @request POST:/api/users/me/partners/{partnerId}
+             * @request POST:/api/users/me/partners/{partnerProfileId}
              * @secure
              * @response `204` `void` No Content
              * @response `403` `ProblemDetails` Forbidden
              * @response `404` `ProblemDetails` Not Found
              */
-            addMyPartner: (partnerId, params = {}) => this.request(Object.assign({ path: `/api/users/me/partners/${partnerId}`, method: "POST", secure: true }, params)),
+            addMyPartner: (partnerProfileId, params = {}) => this.request(Object.assign({ path: `/api/users/me/partners/${partnerProfileId}`, method: "POST", secure: true }, params)),
             /**
-             * No description
+             * @description Takes a partner, by partner profile ID, off the loan officer's own list
              *
              * @tags UsersMe
              * @name RemoveMyPartner
              * @summary Remove My Partner
-             * @request DELETE:/api/users/me/partners/{partnerId}
+             * @request DELETE:/api/users/me/partners/{partnerProfileId}
              * @secure
              * @response `204` `void` No Content
              * @response `403` `ProblemDetails` Forbidden
              * @response `404` `ProblemDetails` Not Found
              */
-            removeMyPartner: (partnerId, params = {}) => this.request(Object.assign({ path: `/api/users/me/partners/${partnerId}`, method: "DELETE", secure: true }, params)),
+            removeMyPartner: (partnerProfileId, params = {}) => this.request(Object.assign({ path: `/api/users/me/partners/${partnerProfileId}`, method: "DELETE", secure: true }, params)),
             /**
              * @description The links that attribute an application to the partner, on the site of each loan officer the partner works with
              *