@matech/thebigpos-sdk 3.28.0-main-8476 → 3.29.0-dev-8529

package/dist/index.d.ts

@@ -20,7 +20,7 @@ export type LosSyncStepSeverity = "Success" | "Info" | "Warning" | "Error";
 export type LosOperationStatus = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked" | "Skipped";
 export type LosCredentialHealthStatus = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
 export type LogLevel = "None" | "Info" | "Warning" | "Error";
-export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
+export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other" | "Heloc";
 export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
 export type LoanTitleHeld = "Sole" | "JointWithSpouse" | "JointWithOtherThanSpouse";
 export type LoanTaskActivityFilter = "Active" | "Inactive" | "All";
@@ -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;
@@ -2977,8 +3001,11 @@ export interface LoanApplicationRequest {
     userID: string;
     /** @format uuid */
     siteConfigurationID: string;
+    /** @format uuid */
+    submissionKey?: string | null;
     loanOfficerEmail?: string | null;
     purpose?: LoanPurpose | null;
+    type?: LoanType | null;
     referrer?: string | null;
     companyName?: string | null;
     relationship?: BorrowerRelationship | null;
@@ -5066,6 +5093,15 @@ export interface MyPartner {
     /** @format date-time */
     createdAt: string;
 }
+export interface MyPartnerPaginated {
+    rows: MyPartner[];
+    pagination: Pagination;
+    /** @format int64 */
+    count: number;
+}
+export interface MyPartnerSearchCriteria {
+    searchText?: string | null;
+}
 export type MyTasksWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
     /** @format int32 */
     dueWithinDays: number;
@@ -6808,6 +6844,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;
@@ -7358,6 +7400,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";
@@ -7589,7 +7633,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v3.28.0
+ * @version v3.29.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -7663,6 +7707,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
          *
@@ -10608,6 +10732,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/api/los/loan/application/internal
          * @secure
          * @response `200` `string` OK
+         * @response `409` `ProblemDetails` Conflict
          * @response `422` `UnprocessableEntity` Unprocessable Content
          * @response `423` `UnprocessableEntity` Locked
          */
@@ -12102,6 +12227,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `401` `ProblemDetails` Unauthorized
          * @response `403` `ProblemDetails` Forbidden
          * @response `404` `ProblemDetails` Not Found
+         * @response `409` `ProblemDetails` Conflict
          */
         createLoanv3: (data: LoanApplicationRequest, query?: {
             application?: string;
@@ -14629,6 +14755,26 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `403` `ProblemDetails` Forbidden
          */
         getMyPartners: (params?: RequestParams) => Promise<AxiosResponse<MyPartner[], any, {}, any>>;
+        /**
+         * @description Searches the rows getMyPartners returns by first name, last name, full name or email, and pages them. Sorts by firstName, lastName, email, tier or createdAt when both sortBy and sortDirection are given, else newest first
+         *
+         * @tags UsersMe
+         * @name SearchMyPartners
+         * @summary Search My Partners
+         * @request POST:/api/users/me/partners/search
+         * @secure
+         * @response `200` `MyPartnerPaginated` OK
+         * @response `400` `ProblemDetails` Bad Request
+         * @response `403` `ProblemDetails` Forbidden
+         */
+        searchMyPartners: (data: MyPartnerSearchCriteria, query?: {
+            /** @format int32 */
+            pageSize?: number;
+            /** @format int32 */
+            pageNumber?: number;
+            sortBy?: string;
+            sortDirection?: string;
+        }, params?: RequestParams) => Promise<AxiosResponse<MyPartnerPaginated, any, {}, any>>;
         /**
          * @description Adds a partner, by partner profile ID, to the loan officer's list; a pending partner can be added too
          *

package/dist/index.js

@@ -101,7 +101,7 @@ export class HttpClient {
 }
 /**
  * @title The Big POS API
- * @version v3.28.0
+ * @version v3.29.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -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
              *
@@ -2773,6 +2846,7 @@ export class Api extends HttpClient {
              * @request POST:/api/los/loan/application/internal
              * @secure
              * @response `200` `string` OK
+             * @response `409` `ProblemDetails` Conflict
              * @response `422` `UnprocessableEntity` Unprocessable Content
              * @response `423` `UnprocessableEntity` Locked
              */
@@ -4147,6 +4221,7 @@ export class Api extends HttpClient {
              * @response `401` `ProblemDetails` Unauthorized
              * @response `403` `ProblemDetails` Forbidden
              * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
              */
             createLoanv3: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
@@ -6456,6 +6531,19 @@ export class Api extends HttpClient {
              * @response `403` `ProblemDetails` Forbidden
              */
             getMyPartners: (params = {}) => this.request(Object.assign({ path: `/api/users/me/partners`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * @description Searches the rows getMyPartners returns by first name, last name, full name or email, and pages them. Sorts by firstName, lastName, email, tier or createdAt when both sortBy and sortDirection are given, else newest first
+             *
+             * @tags UsersMe
+             * @name SearchMyPartners
+             * @summary Search My Partners
+             * @request POST:/api/users/me/partners/search
+             * @secure
+             * @response `200` `MyPartnerPaginated` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             */
+            searchMyPartners: (data, query, params = {}) => this.request(Object.assign({ path: `/api/users/me/partners/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * @description Adds a partner, by partner profile ID, to the loan officer's list; a pending partner can be added too
              *