@matech/thebigpos-sdk 3.28.0-dev-8410 → 3.28.0-dev-8425

package/dist/index.d.ts

@@ -124,6 +124,7 @@ export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Compariso
 export type AiChatInputSource = "Keyboard" | "Prompt" | "Action" | "Voice";
 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" | "PromptTriggerCoalesced" | "RecommendationRunCompleted" | "BoundPromptForced";
 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 type AccountPartnerStatus = "Active" | "Invited";
 export type CanvasWidgetConfig = BaseCanvasWidgetConfig & (BaseCanvasWidgetConfigTypeMapping<"Information", InformationWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"Kpi", KpiWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"KeyDates", KeyDatesWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"LoanProgress", LoanProgressWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"MonthlyPayment", MonthlyPaymentWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"Amortization", AmortizationWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"PrimaryBorrower", PrimaryBorrowerWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"OpenTasks", OpenTasksWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"Documents", DocumentsWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"EsignStatus", EsignStatusWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"LoanTeam", LoanTeamWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"TextBlock", TextBlockWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"SectionDivider", SectionDividerWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"MyTasks", MyTasksWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"RecentLoans", RecentLoansWidgetConfig> | BaseCanvasWidgetConfigTypeMapping<"ClosingSoon", ClosingSoonWidgetConfig>);
 export interface ASOSettings {
     enabled: boolean;
@@ -195,6 +196,29 @@ export interface AccountFailureCount {
     /** @format int32 */
     count: number;
 }
+export interface AccountPartner {
+    /** @format uuid */
+    partnerProfileID?: string | null;
+    /** @format uuid */
+    partnerID?: string | null;
+    firstName: string;
+    lastName: string;
+    email: string;
+    phone?: string | null;
+    status: AccountPartnerStatusEnum;
+    tier: AccountPartnerTierEnum;
+    /** @format date-time */
+    createdAt: string;
+}
+export interface AccountPartnerPaginated {
+    rows: AccountPartner[];
+    pagination: Pagination;
+    /** @format int64 */
+    count: number;
+}
+export interface AccountPartnerSearchCriteria {
+    searchText?: string | null;
+}
 export interface AccountSettings {
     isSmsEnabled: boolean;
     smsNumber?: string | null;
@@ -6817,6 +6841,12 @@ export interface UpdateMobilePhoneRequest {
 export interface UpdatePartnerPortalRequest {
     isEnabled?: boolean | null;
 }
+export interface UpdatePartnerRequest {
+    firstName: string;
+    lastName: string;
+    email: string;
+    phone?: string | null;
+}
 export interface UpdateUserGroupRequest {
     name: string;
     description?: string | null;
@@ -7367,6 +7397,8 @@ type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
     type: Key;
 } & Type;
 export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
+export type AccountPartnerStatusEnum = "Active" | "Invited";
+export type AccountPartnerTierEnum = "Lite" | "LitePlusPortal" | "Pending";
 export type AdminAccessUserMfaFactorEnum = "None" | "Sms" | "Email";
 export type AiAccessReadAloudVoiceEnum = "Automatic" | "UsFemale" | "UsMale" | "UkFemale" | "UkMale";
 export type AiAccountSettingsReadAloudVoiceEnum = "Automatic" | "UsFemale" | "UsMale" | "UkFemale" | "UkMale";
@@ -7672,6 +7704,86 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `422` `UnprocessableEntity` Unprocessable Content
          */
         updateSiteConfigurationForAccount: (data: SiteConfiguration, params?: RequestParams) => Promise<AxiosResponse<SiteConfiguration, any, {}, any>>;
+        /**
+         * @description Every partner of the caller's account: Realtors with an account and pending partners who have not signed up yet
+         *
+         * @tags AccountPartners
+         * @name SearchAccountPartners
+         * @summary Search Account Partners
+         * @request POST:/api/account/partners/search
+         * @secure
+         * @response `200` `AccountPartnerPaginated` OK
+         * @response `400` `ProblemDetails` Bad Request
+         * @response `403` `ProblemDetails` Forbidden
+         * @response `422` `ProblemDetails` Unprocessable Content
+         */
+        searchAccountPartners: (data: AccountPartnerSearchCriteria, query?: {
+            /** @format int32 */
+            pageSize?: number;
+            /** @format int32 */
+            pageNumber?: number;
+            sortBy?: string;
+            sortDirection?: string;
+        }, params?: RequestParams) => Promise<AxiosResponse<AccountPartnerPaginated, any, {}, any>>;
+        /**
+         * @description Makes a settlement agent, by user ID or by an open invite's ID, a partner with no loan officer
+         *
+         * @tags AccountPartners
+         * @name PromotePartner
+         * @summary Promote To Partner
+         * @request POST:/api/account/partners/promotions
+         * @secure
+         * @response `200` `PromotePartner` OK
+         * @response `400` `ProblemDetails` Bad Request
+         * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
+         * @response `409` `ProblemDetails` Conflict
+         * @response `422` `ProblemDetails` Unprocessable Content
+         */
+        promotePartner: (data: PromotePartnerRequest, params?: RequestParams) => Promise<AxiosResponse<PromotePartner, any, {}, any>>;
+        /**
+         * @description Changes a registered partner's name, sign-in email and phone
+         *
+         * @tags AccountPartners
+         * @name ReplacePartner
+         * @summary Replace Partner
+         * @request PUT:/api/account/partners/{partnerProfileId}
+         * @secure
+         * @response `204` `void` No Content
+         * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
+         * @response `409` `ProblemDetails` Conflict
+         * @response `422` `ProblemDetails` Unprocessable Content
+         */
+        replacePartner: (partnerProfileId: string, data: UpdatePartnerRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
+        /**
+         * @description Makes a registered partner a settlement agent again and retires their partner profile; their account and loans stay
+         *
+         * @tags AccountPartners
+         * @name DemotePartner
+         * @summary Demote Partner
+         * @request POST:/api/account/partners/{partnerProfileId}/demote
+         * @secure
+         * @response `204` `void` No Content
+         * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
+         * @response `409` `ProblemDetails` Conflict
+         */
+        demotePartner: (partnerProfileId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
+        /**
+         * @description Cancels a pending partner's invites and retires their partner profile; inviting the email again restores it
+         *
+         * @tags AccountPartners
+         * @name CancelPartnerInvite
+         * @summary Cancel Partner Invite
+         * @request POST:/api/account/partners/{partnerProfileId}/cancel
+         * @secure
+         * @response `204` `void` No Content
+         * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
+         * @response `409` `ProblemDetails` Conflict
+         */
+        cancelPartnerInvite: (partnerProfileId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
         /**
          * No description
          *

package/dist/index.js

@@ -177,6 +177,79 @@ export class Api extends HttpClient {
              * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             updateSiteConfigurationForAccount: (data, params = {}) => this.request(Object.assign({ path: `/api/account/site-configurations`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * @description Every partner of the caller's account: Realtors with an account and pending partners who have not signed up yet
+             *
+             * @tags AccountPartners
+             * @name SearchAccountPartners
+             * @summary Search Account Partners
+             * @request POST:/api/account/partners/search
+             * @secure
+             * @response `200` `AccountPartnerPaginated` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `422` `ProblemDetails` Unprocessable Content
+             */
+            searchAccountPartners: (data, query, params = {}) => this.request(Object.assign({ path: `/api/account/partners/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * @description Makes a settlement agent, by user ID or by an open invite's ID, a partner with no loan officer
+             *
+             * @tags AccountPartners
+             * @name PromotePartner
+             * @summary Promote To Partner
+             * @request POST:/api/account/partners/promotions
+             * @secure
+             * @response `200` `PromotePartner` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             * @response `422` `ProblemDetails` Unprocessable Content
+             */
+            promotePartner: (data, params = {}) => this.request(Object.assign({ path: `/api/account/partners/promotions`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * @description Changes a registered partner's name, sign-in email and phone
+             *
+             * @tags AccountPartners
+             * @name ReplacePartner
+             * @summary Replace Partner
+             * @request PUT:/api/account/partners/{partnerProfileId}
+             * @secure
+             * @response `204` `void` No Content
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             * @response `422` `ProblemDetails` Unprocessable Content
+             */
+            replacePartner: (partnerProfileId, data, params = {}) => this.request(Object.assign({ path: `/api/account/partners/${partnerProfileId}`, method: "PUT", body: data, secure: true, type: "application/json" }, params)),
+            /**
+             * @description Makes a registered partner a settlement agent again and retires their partner profile; their account and loans stay
+             *
+             * @tags AccountPartners
+             * @name DemotePartner
+             * @summary Demote Partner
+             * @request POST:/api/account/partners/{partnerProfileId}/demote
+             * @secure
+             * @response `204` `void` No Content
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             */
+            demotePartner: (partnerProfileId, params = {}) => this.request(Object.assign({ path: `/api/account/partners/${partnerProfileId}/demote`, method: "POST", secure: true }, params)),
+            /**
+             * @description Cancels a pending partner's invites and retires their partner profile; inviting the email again restores it
+             *
+             * @tags AccountPartners
+             * @name CancelPartnerInvite
+             * @summary Cancel Partner Invite
+             * @request POST:/api/account/partners/{partnerProfileId}/cancel
+             * @secure
+             * @response `204` `void` No Content
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             */
+            cancelPartnerInvite: (partnerProfileId, params = {}) => this.request(Object.assign({ path: `/api/account/partners/${partnerProfileId}/cancel`, method: "POST", secure: true }, params)),
             /**
              * No description
              *