@model-match/api 3.28.0 → 3.29.0

package/openapi.json

@@ -4112,7 +4112,7 @@
             "nullable": true
           }
         ],
-        "description": "Production county, keyed by 5-digit county FIPS code (e.g. `06037` = Los Angeles, CA; `04013` = Maricopa, AZ). Matches agents who closed transactions in this county — NOT their office or listed address, which carry no county data at all. A county NAME is REJECTED with a 400 naming the expected format; resolve the name to its FIPS code first (via instantSearch), or use `city`/`state`, which do accept names. Location dimensions AND with each other, so `county` + `state` returns only agents matching both; what sets `county` apart from `city`/`state`/`zip` is its source — those are satisfied by an office address OR a production market, `county` by production alone."
+        "description": "County, keyed by 5-digit county FIPS code (e.g. `06037` = Los Angeles, CA; `04013` = Maricopa, AZ). By default matches agents who closed transactions in this county (production alone — unlike `city`/`state`/`zip`, which an office address also satisfies); with `locationSource: \"office\"` it matches agents whose CURRENT office lies inside the county boundary. A county NAME is REJECTED with a 400 naming the expected format; resolve the name to its FIPS code first (via instantSearch), or use `city`/`state`, which do accept names. Location dimensions AND with each other, so `county` + `state` returns only agents matching both."
       },
       "AgentCrmListFilter": {
         "additionalProperties": false,
@@ -4408,7 +4408,7 @@
                     "$ref": "#/components/schemas/TextFilterValue"
                   },
                   {
-                    "description": "City — matches across ALL of an agent's location signals (listed city, office address, AND transaction/production markets), OR'd together. An agent can match this city while their row's displayed `city`/`state` (their primary market) is elsewhere."
+                    "description": "City — matches across ALL of an agent's location signals (listed city, office address, AND transaction/production markets), OR'd together. An agent can match this city while their row's displayed `city`/`state` (their primary market) is elsewhere. Cities in several states: write each as `\"City, ST\"` (`[\"Springfield, IL\", \"Austin, TX\"]`) — each binds to its own state; a bare name plus a `state` list cross-pairs."
                   }
                 ]
               },
@@ -4425,6 +4425,23 @@
                   }
                 ]
               },
+              "currentOfficeKey": {
+                "anyOf": [
+                  {
+                    "minLength": 1,
+                    "type": "string"
+                  },
+                  {
+                    "items": {
+                      "minLength": 1,
+                      "type": "string"
+                    },
+                    "minItems": 1,
+                    "type": "array"
+                  }
+                ],
+                "description": "Office roster: agents whose CURRENT office is this office id (the `id` from `listOffices` / `instantSearch`, raw or encoded). Several ids OR."
+              },
               "dualUnits": {
                 "$ref": "#/components/schemas/NumericFilterValue"
               },
@@ -4815,6 +4832,9 @@
           "losOnMyTeam": {
             "$ref": "#/components/schemas/AgentLosOnMyTeamFilter"
           },
+          "near": {
+            "$ref": "#/components/schemas/AgentNearFilter"
+          },
           "pagination": {
             "$ref": "#/components/schemas/Pagination"
           },
@@ -5562,7 +5582,7 @@
         "type": "object"
       },
       "AgentLocationSource": {
-        "description": "Which location signal `city`/`state`/`zip`/`county` match. `any` (default) = an office OR a market they transacted in; `office` = their CURRENT office (a bare `state` also matches the state on their member record; a `county` filter is a 400 — offices carry no county); `production` = transaction markets only.",
+        "description": "Which location signal `city`/`state`/`zip`/`county`, `geoPoint` and `near` match. `any` (default) = an office OR a market they transacted in (`geoPoint`: any office on record); `office` = their CURRENT office (a bare `state` also matches the state on their member record; `county` = the office inside the county boundary); `production` = transaction markets only.",
         "enum": [
           "any",
           "office",
@@ -6301,6 +6321,49 @@
         },
         "type": "object"
       },
+      "AgentNearEntry": {
+        "additionalProperties": false,
+        "properties": {
+          "city": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "lat": {
+            "maximum": 90,
+            "minimum": -90,
+            "type": "number"
+          },
+          "lon": {
+            "maximum": 180,
+            "minimum": -180,
+            "type": "number"
+          },
+          "radius": {
+            "example": "25mi",
+            "minLength": 1,
+            "type": "string"
+          },
+          "state": {
+            "minLength": 1,
+            "type": "string"
+          }
+        },
+        "required": [
+          "lat",
+          "lon",
+          "radius"
+        ],
+        "type": "object"
+      },
+      "AgentNearFilter": {
+        "description": "Radius search, entries OR'd, on the `locationSource` points (current office / transactions / either). With `city`+`state` an entry also matches addresses in that city beyond the radius.",
+        "items": {
+          "$ref": "#/components/schemas/AgentNearEntry"
+        },
+        "maxItems": 50,
+        "minItems": 1,
+        "type": "array"
+      },
       "AgentProductMixEntry": {
         "additionalProperties": false,
         "properties": {
@@ -27311,7 +27374,7 @@
         "type": "object"
       },
       "GeoFilterValue": {
-        "description": "Radius search around an agent's office — `{ lat, lon, radius }` (e.g. radius \"15mi\" or \"24km\").",
+        "description": "Radius search — `{ lat, lon, radius }` (e.g. radius \"15mi\" or \"24km\") — around any office on the agent's record; with `locationSource` `office` the CURRENT office, `production` their transactions.",
         "nullable": true,
         "properties": {
           "lat": {
@@ -42464,7 +42527,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.80.0"
+    "version": "3.81.0"
   },
   "openapi": "3.1.0",
   "paths": {

package/package.json

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