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

package/src/index.ts

@@ -716,6 +716,13 @@ export type AiStructuredDataType =
   | "CitedPassages"
   | "PendingLoanUpdate";
 
+export type AiReadAloudVoice =
+  | "Automatic"
+  | "UsFemale"
+  | "UsMale"
+  | "UkFemale"
+  | "UkMale";
+
 export type AiPromptScope = "General" | "LoanSpecific";
 
 export type AiPromptCategory =
@@ -1089,15 +1096,26 @@ export interface AffordabilityCalculatorRequest {
   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 {
@@ -6300,6 +6318,8 @@ export interface MyPartner {
   email: string;
   phone?: string | null;
   tier: MyPartnerTierEnum;
+  isOnLoanOfficerList: boolean;
+  isFromPartnerSite: boolean;
   /** @format date-time */
   createdAt: string;
 }
@@ -8796,6 +8816,20 @@ 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"
@@ -10457,13 +10491,13 @@ export class Api<
      *
      * @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 = {}) =>
-      this.request<AiEnabled, any>({
+      this.request<AiAccess, any>({
         path: `/api/ai/access`,
         method: "GET",
         secure: true,
@@ -23046,7 +23080,7 @@ export class Api<
       }),
 
     /**
-     * @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
@@ -23066,40 +23100,40 @@ export class Api<
       }),
 
     /**
-     * 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 = {}) =>
+    addMyPartner: (partnerProfileId: string, params: RequestParams = {}) =>
       this.request<void, ProblemDetails>({
-        path: `/api/users/me/partners/${partnerId}`,
+        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: string, params: RequestParams = {}) =>
+    removeMyPartner: (partnerProfileId: string, params: RequestParams = {}) =>
       this.request<void, ProblemDetails>({
-        path: `/api/users/me/partners/${partnerId}`,
+        path: `/api/users/me/partners/${partnerProfileId}`,
         method: "DELETE",
         secure: true,
         ...params,