@model-match/api 3.33.0 → 3.35.0

package/dist/{index-bVY1OL8E.d.mts → index--dHVpmdx.d.mts}

@@ -1660,7 +1660,7 @@ type AgentSaleSummary = {
    */
   coListAgentId?: string;
   /**
-   * Co-listing agent, as the MLS recorded the name
+   * Co-listing agent's name — the agent record's (lowercase) when `coListAgentId` resolved from the MLS keys, else as the MLS recorded it; lowercase
    */
   coListAgentName?: string;
   date?: string;
@@ -7671,7 +7671,6 @@ type LoanDetail = LoanSummary & {
   estimatedPayment?: number;
   homeValue?: number;
   listAgent?: unknown;
-  loanTermMonths?: number;
   ltv?: number;
   mmSaleId?: string;
   propertyUseCode?: string;
@@ -7687,10 +7686,22 @@ type LoanListRequest = {
   advancedFilters?: FilterNode;
   filters?: FilterNode;
   flatFilters?: {
+    /**
+     * Loans crediting this agent (`GET /v1/agents/{id}`) — the rows' `*AgentId`; see `agentRole`. ≤ 10,000 candidate loans in scope (else 400).
+     */
+    agentId?: string;
+    /**
+     * `agentId`'s role: `sold`, `list`, `coList`, `listing` (list or co-list), `any` (default).
+     */
+    agentRole?: 'any' | 'sold' | 'list' | 'coList' | 'listing';
     borrowerStatus?: LoanBorrowerStatusFilterValue;
     broker?: TextFilterValue & unknown;
     buyerEntityType?: BooleanFilterValue;
     city?: TextFilterValue;
+    /**
+     * Co-listing agent name.
+     */
+    coListAgentName?: string;
     conforming?: BooleanFilterValue;
     county?: TextFilterValue & unknown;
     currentBalance?: NumericFilterValue & unknown;
@@ -7705,11 +7716,23 @@ type LoanListRequest = {
     excludeZipCode?: TextFilterValue & unknown;
     fips?: TextFilterValue & unknown;
     geoPoint?: GeoFilterValue;
+    /**
+     * Roles that must have an agent: `sold` (buyer's), `list`, `coList`; `any` = at least one.
+     */
+    hasAgent?: Array<'any' | 'sold' | 'list' | 'coList'>;
+    /**
+     * `true`: loans on a new-construction property — one with a sale that names a builder. `false`: the rest. Needs a scope of ≤ 50,000 loans (else 400).
+     */
+    hasBuilder?: boolean;
     homeValue?: NumericFilterValue & unknown;
     includeUnknownOriginator?: BooleanFilterValue & unknown;
     interestRate?: NumericFilterValue;
     lender?: TextFilterValue & unknown;
     lenderName?: TextFilterValue & unknown;
+    /**
+     * Listing agent name.
+     */
+    listAgentName?: string;
     loanCompany?: TextFilterValue & unknown;
     loanType?: LoanTypeFilterValue;
     ltvAtOrigination?: NumericFilterValue & unknown;
@@ -7721,6 +7744,14 @@ type LoanListRequest = {
     propertyId?: TextFilterValue & unknown;
     saleDate?: DateFilterValue;
     salePrice?: NumericFilterValue;
+    /**
+     * Every word starts a word of the address (street, city, state, ZIP), the lender name or an agent name ("12 oak", "jane sm").
+     */
+    search?: string;
+    /**
+     * Buyer's agent: every word starts a word of the MLS name or the linked agent's name. Likewise `listAgentName`, `coListAgentName`.
+     */
+    soldAgentName?: string;
     state?: TextFilterValue;
     transactionType?: LoanTransactionTypeFilterValue;
     zip?: TextFilterValue & unknown;
@@ -7729,7 +7760,7 @@ type LoanListRequest = {
   pagination?: Pagination;
   period?: DatedPeriod;
   sort?: Array<{
-    field: 'city' | 'state' | 'zipCode' | 'county' | 'transactionType' | 'loanType' | 'conforming' | 'mortgageAmount' | 'mortgageDate' | 'broker' | 'loanCompany' | 'lender' | 'borrowerStatus' | 'salePrice' | 'saleDate' | 'originator' | 'originatorName' | 'interestRate' | 'equity' | 'homeValue' | 'ltvAtOrigination' | 'currentBalance';
+    field: 'city' | 'state' | 'zipCode' | 'county' | 'transactionType' | 'loanType' | 'conforming' | 'mortgageAmount' | 'mortgageDate' | 'broker' | 'loanCompany' | 'lender' | 'borrowerStatus' | 'salePrice' | 'saleDate' | 'originator' | 'originatorName' | 'interestRate' | 'equity' | 'homeValue' | 'ltvAtOrigination' | 'currentBalance' | 'streetAddress' | 'listPrice' | 'employerName' | 'brokerName' | 'soldAgentName' | 'listAgentName' | 'coListAgentName';
     order?: SortOrder;
   }>;
 };
@@ -7745,6 +7776,10 @@ type LoanListResponse = {
    */
   locationNormalizations?: Array<LocationNormalization>;
   total: number;
+  /**
+   * Row sorts only: more than 10,000 loans matched; the newest 10,000 were sorted and `total` counts them.
+   */
+  truncated?: boolean;
 };
 /**
  * Dimension to group by. Most are the loan's own field (`loanType`, `transactionType`, `state`, …). `lender` groups on the normalized lender (label = display name, `id` = filter key). `propertyType` is the recorder's land-use code of the collateral (`SFR` single-family, `PUD` planned unit development, `CND` condo, `RES` residential-other, `MFD` multi-family dwelling, `2ND` second home, `MFG` manufactured, `TWN` townhouse, `LAN` land, `COM` commercial, …); loans with no code are not grouped (≈20% of recent loans). `conforming` splits on the conforming-loan-limit flag: `conforming` vs `nonConforming` (above the county conforming limit — i.e. jumbo, not Non-QM), raw `true`/`false` on `id`. Time-series only: `titleCompany` groups on the title company named on the deed, with spellings of one company merged per bucket (`label` = most-used spelling across the response, `id` = normalized name — match on `id`) and "none available"-style placeholders excluded.
@@ -7763,6 +7798,10 @@ type LoanSummary = {
    */
   brokerName?: string;
   brokerNmlsId?: string;
+  /**
+   * Builder named on a sale of this property (new construction); the `hasBuilder` predicate.
+   */
+  builderName?: string;
   /**
    * First buyer's first + middle name (an entity's whole name, with no last).
    */
@@ -7781,7 +7820,11 @@ type LoanSummary = {
   buyer2Last?: string;
   city?: string;
   /**
-   * Co-listing agent, as the MLS recorded the name.
+   * Co-listing agent id, same rule.
+   */
+  coListAgentId?: string;
+  /**
+   * Co-listing agent: the agent record's name when the MLS keys resolve to one agent, else as the MLS recorded it.
    */
   coListAgentName?: string;
   companyName?: string;
@@ -7802,12 +7845,21 @@ type LoanSummary = {
   fips?: string;
   id: string;
   interestRate?: number;
+  /**
+   * Normalized lender id — the value the `lender` filter takes.
+   */
+  lenderId?: string;
   lenderName?: string;
   /**
-   * Listing agent, as the MLS recorded the name.
+   * Listing agent id, same rule.
+   */
+  listAgentId?: string;
+  /**
+   * Listing agent: the agent record's name when the MLS keys resolve to one agent, else as the MLS recorded it.
    */
   listAgentName?: string;
   listPrice?: number;
+  loanTermMonths?: number;
   loanType?: string;
   mmPropertyId?: string;
   mortgageAmount?: number;
@@ -7838,7 +7890,11 @@ type LoanSummary = {
   seller2Last?: string;
   sellerName?: string;
   /**
-   * Buyer's agent, as the MLS recorded the name.
+   * Buyer's agent id (`GET /v1/agents/{id}`) when the MLS keys resolve to one agent.
+   */
+  soldAgentId?: string;
+  /**
+   * Buyer's agent: the agent record's name when the loan's MLS agent keys resolve to one agent, else as the MLS recorded it; lowercase.
    */
   soldAgentName?: string;
   state?: string;
@@ -25520,7 +25576,7 @@ declare class Agents {
   static properties<ThrowOnError extends boolean = false>(options: Options$1<AgentPropertiesData, ThrowOnError>): _$_hey_api_client_fetch0.RequestResult<AgentPropertiesResponse, AgentPropertiesError, ThrowOnError>;
   /**
    * Sales transactions where this agent was listing or selling side
-   * The agent's deals, newest first: every sale on which the agent is the buyer's agent or the listing / co-listing agent. `side` narrows to one half (`buyer` includes deals where the agent was on both sides; `listing` excludes them). Each row says which `side` the agent was on and carries the sale's recorded purchase `loan` — lender, loan officer, loan type, amount, title company — or `null` for a cash deal or a loan not yet on file. Pass `flatFilters.mlsStatus: "SLD"` for closed deals only. `dealFilters` adds an address `search`, the co-listing agent, builder / status-date filters and loan-side filters (`financed`, `loan.*` on the purchase loan). Sorts: the `/v1/sales` names plus `listDate`, `builder`, `coListAgent`, and the loan / party columns `loanAmount`, `loanType`, `loanTransactionType`, `interestRate`, `lenderName`, `originatorName`, `companyName`, `brokerName`, `titleCompany`, `buyerName`, `sellerName`, `downPayment` (one at a time; blanks last).
+   * The agent's deals, newest first: every sale on which the agent is the buyer's agent or the listing / co-listing agent. `side` narrows to one half (`buyer` includes deals where the agent was on both sides; `listing` excludes them). Each row says which `side` the agent was on and carries the sale's recorded purchase `loan` — lender, loan officer, loan type, amount, title company — or `null` for a cash deal or a loan not yet on file. Pass `flatFilters.mlsStatus: "SLD"` for closed deals only. `dealFilters` adds an address `search`, the co-listing agent, builder / status-date filters and loan-side filters (`financed`, `loan.*` on the purchase loan). Sorts: the `/v1/sales` names plus `listDate`, `builder`, `coListAgent`, and the loan / party columns `loanAmount`, `loanType`, `loanTransactionType`, `interestRate`, `lenderName`, `originatorName`, `companyName`, `brokerName`, `titleCompany`, `buyerName`, `sellerName`, `downPayment` (one at a time; blanks last). `listingAgent` / `soldAgent` / `coListAgent` order by the name the row shows.
    */
   static sales<ThrowOnError extends boolean = false>(options: Options$1<AgentSalesData, ThrowOnError>): _$_hey_api_client_fetch0.RequestResult<AgentSalesResponse, AgentSalesError, ThrowOnError>;
 }