@model-match/api 3.29.0 → 3.30.0

package/dist/slim/index.mjs

@@ -1,4 +1,4 @@
-import { n as createClient, w as client } from "../src-C2QtRet2.mjs";
+import { n as createClient, w as client } from "../src-Fb0Qg-UI.mjs";
 //#region src/slim/sdk.gen.ts
 /**
 * An LO's sponsorship / registration links (admin)
@@ -584,7 +584,7 @@ const agentRelated = (options) => {
 };
 /**
 * 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.
+* 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).
 */
 const agentSales = (options) => {
 	return (options.client ?? client).post({
@@ -1896,6 +1896,7 @@ const companyOffices = (options) => {
 };
 /**
 * Loan officers who originated through this company
+* Ranks the loan officers on this company's loans (scope with `roleScope` — `tpo` for its third-party originators). `label` is the LO's NMLS id; `name` and `company` (the LO's CURRENT employer per NMLS licensing, not necessarily the company on the loans) are resolved server-side, and are absent for an id with no originator profile. `sort: [{field: "name"}]` orders by that resolved name across the top 10,000 originators by volume (`truncated` says when there are more).
 */
 const companyOriginators = (options) => {
 	return (options.client ?? client).post({

package/dist/{src-C2QtRet2.mjs → src-Fb0Qg-UI.mjs}

@@ -582,7 +582,7 @@ var Agents = class {
 	}
 	/**
 	* 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.
+	* 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).
 	*/
 	static sales(options) {
 		return (options.client ?? client).post({
@@ -1987,6 +1987,7 @@ var Companies = class {
 	}
 	/**
 	* Loan officers who originated through this company
+	* Ranks the loan officers on this company's loans (scope with `roleScope` — `tpo` for its third-party originators). `label` is the LO's NMLS id; `name` and `company` (the LO's CURRENT employer per NMLS licensing, not necessarily the company on the loans) are resolved server-side, and are absent for an id with no originator profile. `sort: [{field: "name"}]` orders by that resolved name across the top 10,000 originators by volume (`truncated` says when there are more).
 	*/
 	static originators(options) {
 		return (options.client ?? client).post({

package/openapi.json

@@ -4121,7 +4121,7 @@
           "lists": {
             "anyOf": [
               {
-                "description": "Every People list in the caller's workspace that the caller can see (own, org-wide, or shared with them).",
+                "description": "Every list in the caller's workspace that the caller can see (own, org-wide, or shared with them) and that holds this kind of record — People lists for originators and agents, Company lists for companies.",
                 "enum": [
                   "any"
                 ],
@@ -4155,6 +4155,46 @@
         ],
         "type": "object"
       },
+      "AgentDealFilters": {
+        "additionalProperties": false,
+        "description": "Deal filters beyond the sale `flatFilters`. Loan-side keys (`financed`, `loan`) and the loan / party sorts consider the newest 10,000 matching sales; `truncated` says when more matched.",
+        "properties": {
+          "coListAgentName": {
+            "description": "Co-listing agent name: every word must start a word of the name the MLS recorded.",
+            "maxLength": 100,
+            "minLength": 1,
+            "type": "string"
+          },
+          "financed": {
+            "description": "`true`: deals with a purchase loan on file; `false`: none on file (cash, or not yet recorded).",
+            "type": "boolean"
+          },
+          "hasBuilder": {
+            "description": "`true`: new-construction sales with a builder named.",
+            "type": "boolean"
+          },
+          "loan": {
+            "$ref": "#/components/schemas/AgentSaleLoanFilters"
+          },
+          "search": {
+            "description": "Address search: every word must start a word of the street line, city or ZIP (\"12 oak\" → 1200 Oakmont Dr).",
+            "maxLength": 100,
+            "minLength": 1,
+            "type": "string"
+          },
+          "statusDate": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/DateFilterValue"
+              },
+              {
+                "description": "MLS status-change date range. With `mlsStatus: \"ACT\"`, `{gte}` keeps listings still active recently."
+              }
+            ]
+          }
+        },
+        "type": "object"
+      },
       "AgentDetail": {
         "allOf": [
           {
@@ -6416,6 +6456,10 @@
           },
           "total": {
             "type": "number"
+          },
+          "truncated": {
+            "description": "`true` when more than 10,000 sales matched and a loan-side filter or a loan / party sort considered only the newest 10,000",
+            "type": "boolean"
           }
         },
         "required": [
@@ -6473,6 +6517,9 @@
           "advancedFilters": {
             "$ref": "#/components/schemas/FilterNode"
           },
+          "dealFilters": {
+            "$ref": "#/components/schemas/AgentDealFilters"
+          },
           "filters": {
             "$ref": "#/components/schemas/FilterNode"
           },
@@ -6508,6 +6555,88 @@
         },
         "type": "object"
       },
+      "AgentSaleLoanFilters": {
+        "additionalProperties": false,
+        "description": "Filters on the sale's purchase loan (the row's `loan`), with the `/v1/loans` filter semantics. Any key here keeps only financed deals whose purchase loan matches.",
+        "properties": {
+          "broker": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              {
+                "description": "Broker shop NMLS id (digits only). A broker is a company — resolve a broker name to its NMLS id via instantSearch (or listCompanies)."
+              }
+            ]
+          },
+          "conforming": {
+            "$ref": "#/components/schemas/BooleanFilterValue"
+          },
+          "employer": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              {
+                "description": "Employer/company NMLS id (digits only). Resolve a company name to its NMLS id via instantSearch."
+              }
+            ]
+          },
+          "interestRate": {
+            "$ref": "#/components/schemas/NumericFilterValue"
+          },
+          "lender": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              {
+                "description": "Lender ID — the normalized lender-dictionary key, NOT a fuzzy name match. Resolve a lender via instantSearch (or listLenders) and pass the `id` it returns (e.g. \"mortgage_rocket\" or \"mortgage rocket\"). Underscores and letter case are normalized, so either id surface works. A stored normalized lender name (what the `slice: \"lender\"` chart buckets emit) is also accepted, so a chart bucket key filters directly. A value that is neither returns 400 rather than silently matching nothing — to search by lender NAME, use `lenderName`."
+              }
+            ]
+          },
+          "lenderName": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              {
+                "description": "Lender name as recorded on the loan document — fuzzy, all-terms match (e.g. \"Fifth Third\"). The name counterpart to the exact-id `lender` filter; use `lender` when you have a resolved id, and this when you only have a name."
+              }
+            ]
+          },
+          "loanCompany": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              {
+                "description": "Funding/loan company NMLS id (digits only). Resolve a company name to its NMLS id via instantSearch."
+              }
+            ]
+          },
+          "loanType": {
+            "$ref": "#/components/schemas/LoanTypeFilterValue"
+          },
+          "mortgageAmount": {
+            "$ref": "#/components/schemas/NumericFilterValue"
+          },
+          "originator": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              {
+                "description": "Loan originator NMLS id (digits only). To search by name use `originatorName`, or resolve a name to its id via instantSearch."
+              }
+            ]
+          },
+          "transactionType": {
+            "$ref": "#/components/schemas/LoanTransactionTypeFilterValue"
+          }
+        },
+        "type": "object"
+      },
       "AgentSaleSummary": {
         "properties": {
           "address": {
@@ -7026,6 +7155,10 @@
           },
           "total": {
             "type": "number"
+          },
+          "truncated": {
+            "description": "`true` when more than 10,000 sales matched and a loan-side filter or a loan / party sort considered only the newest 10,000",
+            "type": "boolean"
           }
         },
         "required": [
@@ -13379,7 +13512,7 @@
       "BreakdownItem": {
         "properties": {
           "company": {
-            "description": "Agent `originators` only: the LO's employer per NMLS licensing as of the agent profile's last refresh — not necessarily the company on the loans, and it can trail a very recent move (`GET /v1/originators/{nmlsId}` is always current). Absent on every other breakdown; `null` leaves when no sponsorship was on file.",
+            "description": "Agent and company `originators` only: the LO's employer per NMLS licensing (on agents, as of the agent profile's last refresh) — not necessarily the company on the loans, and it can trail a very recent move (`GET /v1/originators/{nmlsId}` is always current). Absent on every other breakdown; `null` leaves when no sponsorship was on file.",
             "properties": {
               "name": {
                 "nullable": true,
@@ -13800,13 +13933,14 @@
         "items": {
           "properties": {
             "field": {
-              "description": "One of (case-insensitive): volume, units, label, pctVolume, pctUnits",
+              "description": "One of (case-insensitive): volume, units, label, pctVolume, pctUnits, name",
               "enum": [
                 "volume",
                 "units",
                 "label",
                 "pctVolume",
-                "pctUnits"
+                "pctUnits",
+                "name"
               ],
               "type": "string"
             },
@@ -15525,6 +15659,47 @@
         ],
         "type": "object"
       },
+      "CompanyCrmListFilter": {
+        "additionalProperties": false,
+        "description": "Scope the result to the caller's CRM. Resolved against the caller's ACTIVE WORKSPACE at query time — list membership is read server-side, so the request never carries member ids. Only company members count; people, branches, offices and manual (unlinked) records on the same list are ignored. `mode: \"in\"` with no matching members returns an empty page (not an unfiltered one). Errors: 400 `crm_list_requires_workspace` when the caller has no active workspace (API-key / OAuth callers must select an organization), 403 / 404 when a named list is not visible to the caller or does not exist, and 400 `crm_list_too_large` when the selected lists hold more than 50,000 companies in total — narrow the selection rather than get a silently partial answer.",
+        "properties": {
+          "lists": {
+            "anyOf": [
+              {
+                "description": "Every list in the caller's workspace that the caller can see (own, org-wide, or shared with them) and that holds this kind of record — People lists for originators and agents, Company lists for companies.",
+                "enum": [
+                  "any"
+                ],
+                "type": "string"
+              },
+              {
+                "description": "Specific CRM list ids (1–50).",
+                "items": {
+                  "minLength": 1,
+                  "type": "string"
+                },
+                "maxItems": 50,
+                "minItems": 1,
+                "type": "array"
+              }
+            ],
+            "description": "Which lists: `\"any\"` for every Company list the caller can see, or an array of list ids. Membership is the UNION across the selected lists."
+          },
+          "mode": {
+            "description": "`in` — only companies who are a member of the selected list(s). `notIn` — exclude every companie who is a member of the selected list(s); everyone else passes, including companies on none of your lists.",
+            "enum": [
+              "in",
+              "notIn"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "mode",
+          "lists"
+        ],
+        "type": "object"
+      },
       "CompanyDetail": {
         "allOf": [
           {
@@ -16190,6 +16365,13 @@
           "advancedFilters": {
             "$ref": "#/components/schemas/FilterNode"
           },
+          "crmList": {
+            "$ref": "#/components/schemas/CompanyCrmListFilter"
+          },
+          "excludeBrokerPartners": {
+            "description": "`true`: hide the companies your workspace already partners with — a confidential partner roster your organization supplied to Model Match, attached to the workspace (today: Rocket Pro TPO partners). The roster is never returned; it is applied only as an exclusion. Errors: 400 `partner_set_requires_workspace` when the request has no active workspace, 403 `partner_set_unavailable` when the workspace has no partner roster. `false` or absent: no effect.",
+            "type": "boolean"
+          },
           "filters": {
             "$ref": "#/components/schemas/FilterNode"
           },
@@ -16452,6 +16634,16 @@
               "companyType": {
                 "$ref": "#/components/schemas/CompanyTypeFilterValue"
               },
+              "county": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Registered business address COUNTY — where the company is headquartered, NOT where it produced loans (same caveats as `state`; under `locationBasis: \"production\"` it selects companies that produced loans in the county instead). Accepts a county name (`Travis`, with a sibling `state` when the name exists in several states), a 5-digit FIPS code (`48453`) or a dictionary county id; an array matches any. The address carries no county of its own, so it matches when the geocoded point of the address lies inside the Census boundary of the county (a company with no geocoded address matches no county). An unrecognized county is a 400. For production INSIDE the geography this request names, read `scopedVolume`/`scopedUnits` on the same row, and sort by them to rank companies by it. There are two ways to get production for a geography: `POST /companies/{nmlsId}/markets` breaks ONE company's production out by market, and `POST /loans/analytics/chart` with `measure: \"volume\"`, `slice: \"loanCompany\"` and a geographic filter answers the reverse — the companies that actually produced in that geography, each with the volume they produced there."
+                  }
+                ]
+              },
               "difficultDevelopmentAreaCount": {
                 "allOf": [
                   {
@@ -16595,6 +16787,9 @@
                 ],
                 "type": "string"
               },
+              "msa": {
+                "$ref": "#/components/schemas/CompanyMsaFilterValue"
+              },
               "name": {
                 "allOf": [
                   {
@@ -16643,6 +16838,9 @@
               "producersOnly": {
                 "$ref": "#/components/schemas/BooleanFilterValue"
               },
+              "region": {
+                "$ref": "#/components/schemas/CompanyRegionFilterValue"
+              },
               "rosterJoined": {
                 "allOf": [
                   {
@@ -16796,7 +16994,7 @@
             "$ref": "#/components/schemas/LenderMatchMode"
           },
           "locationBasis": {
-            "description": "What the geographic filters (`city`/`state`/`zip`/`zipCode`/`geoPoint`) select. `registeredAddress` (the default) matches companies whose REGISTERED BUSINESS ADDRESS is in the place — a company registered elsewhere is excluded no matter how much it lends there. `production` matches companies that PRODUCED loans in the place, whatever address they are registered at, which is usually what a geographic search means. It changes only WHICH companies are returned: every non-geographic filter applies identically either way, `scopedVolume`/`scopedUnits` report in-geography production under both, and `countCompanies` honors this field, so a count and a list built from the same body always describe the same set. Measured on an 8-state Southeast search: under `registeredAddress` the largest actual producer in the region is absent at any depth, because it is registered in Michigan.",
+            "description": "What the geographic filters (`city`/`county`/`msa`/`region`/`state`/`zip`/`zipCode`/`geoPoint`) select. `registeredAddress` (the default) matches companies whose REGISTERED BUSINESS ADDRESS is in the place — a company registered elsewhere is excluded no matter how much it lends there. `production` matches companies that PRODUCED loans in the place, whatever address they are registered at, which is usually what a geographic search means. It changes only WHICH companies are returned: every non-geographic filter applies identically either way, `scopedVolume`/`scopedUnits` report in-geography production under both, and `countCompanies` honors this field, so a count and a list built from the same body always describe the same set. Measured on an 8-state Southeast search: under `registeredAddress` the largest actual producer in the region is absent at any depth, because it is registered in Michigan.",
             "enum": [
               "registeredAddress",
               "production"
@@ -17787,8 +17985,27 @@
         ],
         "type": "object"
       },
+      "CompanyMsaFilterValue": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "items": {
+              "type": "string"
+            },
+            "maxItems": 50,
+            "minItems": 1,
+            "type": "array"
+          },
+          {
+            "nullable": true
+          }
+        ],
+        "description": "Registered business address METRO AREA (MSA / CBSA) — companies headquartered in ANY county of the metro (the address point inside the boundary of a member county, as for `county`); under `locationBasis: \"production\"`, companies that produced loans in it. 5-digit CBSA code (`12420`) or metro name (`Austin Metro`); an array matches any. Top-50 metros use the Model Match app's county lists, the rest OMB 2023. Unknown/ambiguous names are a 400 naming candidates."
+      },
       "CompanyProductMixFilter": {
-        "description": "Loan-product share bands for the selected period, ANDed: `[{product:\"fha\", minShare:30}]` = FHA is at least 30% of the company's period volume. Whole-book shares across all markets.",
+        "description": "Loan-product share / volume bands for the selected period, ANDed: `[{product:\"fha\", minShare:30}]` = FHA is at least 30% of the company's period volume; `[{product:\"va\", volume:{gte:5000000}}]` = at least $5M of VA. `products` lets ANY of several types satisfy one entry. Whole-book figures across all markets.",
         "items": {
           "additionalProperties": false,
           "properties": {
@@ -17813,6 +18030,7 @@
               "type": "number"
             },
             "product": {
+              "description": "The loan product. Send this OR `products`, not both.",
               "enum": [
                 "conventional",
                 "fha",
@@ -17839,17 +18057,112 @@
                 "unknown"
               ],
               "type": "string"
+            },
+            "products": {
+              "description": "Several products, ANY of which may satisfy the bounds on its own (each type's share is read separately, never summed): `{products:[\"fha\",\"va\",\"usda\"], minShare:30}` = FHA, VA or USDA is on its own at least 30% of the book. Send this OR `product`.",
+              "items": {
+                "enum": [
+                  "conventional",
+                  "fha",
+                  "va",
+                  "he",
+                  "heloc",
+                  "building",
+                  "commercial",
+                  "stand_alone_refi",
+                  "closed_end",
+                  "reverse",
+                  "usda",
+                  "stand_alone_second",
+                  "aggregate",
+                  "seller_take_back",
+                  "sba_participation_trust_deed",
+                  "balloon",
+                  "opened_end",
+                  "assumption",
+                  "negative_amortization",
+                  "land_contract",
+                  "trade",
+                  "modification",
+                  "unknown"
+                ],
+                "type": "string"
+              },
+              "maxItems": 10,
+              "minItems": 1,
+              "type": "array"
+            },
+            "volume": {
+              "additionalProperties": false,
+              "description": "Dollar volume of THIS type in the period, `{gte, lte}` — e.g. `{gte: 5000000}` = at least $5M of FHA. Evaluated inside the same type bucket as the share bounds; a company with no loans of the type does not match.",
+              "properties": {
+                "gte": {
+                  "minimum": 0,
+                  "type": "number"
+                },
+                "lte": {
+                  "minimum": 0,
+                  "type": "number"
+                }
+              },
+              "type": "object"
             }
           },
-          "required": [
-            "product"
-          ],
           "type": "object"
         },
         "maxItems": 10,
         "minItems": 1,
         "type": "array"
       },
+      "CompanyRegionFilterValue": {
+        "anyOf": [
+          {
+            "enum": [
+              "northeast",
+              "northeast-division-1",
+              "northeast-division-2",
+              "midwest",
+              "midwest-division-3",
+              "midwest-division-4",
+              "south",
+              "south-division-5",
+              "south-division-6",
+              "south-division-7",
+              "west",
+              "west-division-8",
+              "west-division-9"
+            ],
+            "type": "string"
+          },
+          {
+            "items": {
+              "enum": [
+                "northeast",
+                "northeast-division-1",
+                "northeast-division-2",
+                "midwest",
+                "midwest-division-3",
+                "midwest-division-4",
+                "south",
+                "south-division-5",
+                "south-division-6",
+                "south-division-7",
+                "west",
+                "west-division-8",
+                "west-division-9"
+              ],
+              "type": "string"
+            },
+            "maxItems": 50,
+            "minItems": 1,
+            "type": "array"
+          },
+          {
+            "nullable": true
+          }
+        ],
+        "description": "Registered business address CENSUS REGION / DIVISION (`<region>-division-<n>`, Census numbering 1–9) — companies headquartered in ANY state of it; under `locationBasis: \"production\"`, companies that produced loans in it. An array matches any."
+      },
       "CompanyRegistration": {
         "nullable": true,
         "properties": {
@@ -19562,6 +19875,21 @@
                 "UNKNOWN"
               ],
               "type": "string"
+            },
+            "volume": {
+              "additionalProperties": false,
+              "description": "Dollar volume of THIS type in the period, `{gte, lte}` — e.g. `{gte: 5000000}` = at least $5M of FHA. Evaluated inside the same type bucket as the share bounds; a company with no loans of the type does not match.",
+              "properties": {
+                "gte": {
+                  "minimum": 0,
+                  "type": "number"
+                },
+                "lte": {
+                  "minimum": 0,
+                  "type": "number"
+                }
+              },
+              "type": "object"
             }
           },
           "required": [
@@ -33769,7 +34097,7 @@
           "lists": {
             "anyOf": [
               {
-                "description": "Every People list in the caller's workspace that the caller can see (own, org-wide, or shared with them).",
+                "description": "Every list in the caller's workspace that the caller can see (own, org-wide, or shared with them) and that holds this kind of record — People lists for originators and agents, Company lists for companies.",
                 "enum": [
                   "any"
                 ],
@@ -34603,6 +34931,11 @@
                   }
                 ]
               },
+              "companyNamePrefix": {
+                "description": "Current company name prefix search: each word starts a word of it (\"guild mort\"); not fuzzy. Digits = company NMLS id.",
+                "minLength": 1,
+                "type": "string"
+              },
               "companyNmlsId": {
                 "$ref": "#/components/schemas/TextFilterValue"
               },
@@ -42527,7 +42860,7 @@
   "info": {
     "description": "ModelMatch API — mortgage and real-estate market data.\n\n## Bulk delivery limits\n\nThe `POST /{entity}/bulk-delivery` endpoints export a full result set to\nS3 as NDJSON, JSON, CSV, or Parquet.\n\n- **Up to 5,000 rows per delivery: no entitlement required.** Available to\n  every authenticated caller.\n- **Above 5,000 rows: requires the entity's `bulk-delivery.{entity}`\n  entitlement** (e.g. `bulk-delivery.loans`). The grant's scope sets your\n  row ceiling and may also restrict which rows and fields you receive.\n\nA delivery that would exceed the limit available to you is rejected with\n`403 entitlement_missing`, reporting the matched row count and the ceiling\nthat applied. To stay under the limit, pass `limit` — the job then delivers\n(and bills for) only the first `limit` rows of a broader query.\n\n**Need a higher limit?** Email support@modelmatch.com to request the\nentitlement. Limits are raised per organization and per entity.\n\nBulk delivery is billed at 1 credit per delivered row whether or not\nan entitlement is held.\n\nInstead of a download, a delivery can be sent to a push target configured\non your workspace: pass `destination: { type: \"push-target\", targetId }`.\nThe same limits and billing apply.",
     "title": "ModelMatch API",
-    "version": "3.81.0"
+    "version": "3.82.0"
   },
   "openapi": "3.1.0",
   "paths": {
@@ -45101,7 +45434,7 @@
     },
     "/v1/agents/{id}/sales": {
       "post": {
-        "description": "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.",
+        "description": "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).",
         "operationId": "agentSales",
         "parameters": [
           {
@@ -50994,6 +51327,7 @@
     },
     "/v1/companies/{nmlsId}/breakdowns/originators": {
       "post": {
+        "description": "Ranks the loan officers on this company's loans (scope with `roleScope` — `tpo` for its third-party originators). `label` is the LO's NMLS id; `name` and `company` (the LO's CURRENT employer per NMLS licensing, not necessarily the company on the loans) are resolved server-side, and are absent for an id with no originator profile. `sort: [{field: \"name\"}]` orders by that resolved name across the top 10,000 originators by volume (`truncated` says when there are more).",
         "operationId": "companyOriginators",
         "parameters": [
           {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@model-match/api",
-	"version": "3.29.0",
+	"version": "3.30.0",
 	"description": "TypeScript client for the ModelMatch API",
 	"license": "MIT",
 	"files": [