@model-match/api 3.44.0 → 3.45.0

package/dist/slim/index.mjs

@@ -1,4 +1,4 @@
-import { S as client, n as createClient } from "../src-DX-mM6Og.mjs";
+import { S as client, n as createClient } from "../src-DCqOC4qE.mjs";
 //#region src/slim/sdk.gen.ts
 /**
 * Search agents with filters
@@ -5365,7 +5365,7 @@ const originatorRetention = (options) => (options.client ?? client).post({
 /**
 * Search properties with filters
 *
-* Search and list individual properties/parcels with filters — one row per parcel. Filter by location (state, county, city, zip, address), owner name, property characteristics (beds, baths, square footage, year built, property type), value, and ownership or transaction history, with sorting and cursor pagination. This is the discrete per-property record search: use it to find specific properties or build a filtered property list. (For a single property by its ID use the property detail endpoint.) If you only need how many properties match and not the records themselves, send the same request body to `countProperties`.
+* Search and list individual properties/parcels with filters — one row per parcel. Filter by location (state, county, city, zip, address), owner name, property characteristics (beds, baths, square footage, year built, property type), value, ownership or transaction history, and occupancy (`ownerOccupancy: not_flagged` plus `absenteeOwner: true` targets likely investor / non-owner-occupied parcels — pair `absenteeOwner` with a geography filter), with sorting and cursor pagination. This is the discrete per-property record search: use it to find specific properties or build a filtered property list. (For a single property by its ID use the property detail endpoint.) If you only need how many properties match and not the records themselves, send the same request body to `countProperties`.
 */
 const listProperties = (options) => (options?.client ?? client).post({
 	security: [{

package/dist/{src-DX-mM6Og.mjs → src-DCqOC4qE.mjs}

@@ -6678,7 +6678,7 @@ var Properties = class {
 	/**
 	* Search properties with filters
 	*
-	* Search and list individual properties/parcels with filters — one row per parcel. Filter by location (state, county, city, zip, address), owner name, property characteristics (beds, baths, square footage, year built, property type), value, and ownership or transaction history, with sorting and cursor pagination. This is the discrete per-property record search: use it to find specific properties or build a filtered property list. (For a single property by its ID use the property detail endpoint.) If you only need how many properties match and not the records themselves, send the same request body to `countProperties`.
+	* Search and list individual properties/parcels with filters — one row per parcel. Filter by location (state, county, city, zip, address), owner name, property characteristics (beds, baths, square footage, year built, property type), value, ownership or transaction history, and occupancy (`ownerOccupancy: not_flagged` plus `absenteeOwner: true` targets likely investor / non-owner-occupied parcels — pair `absenteeOwner` with a geography filter), with sorting and cursor pagination. This is the discrete per-property record search: use it to find specific properties or build a filtered property list. (For a single property by its ID use the property detail endpoint.) If you only need how many properties match and not the records themselves, send the same request body to `countProperties`.
 	*/
 	static list(options) {
 		return (options?.client ?? client).post({

package/openapi.json

@@ -36519,6 +36519,16 @@
       "PropertyAnalyticsFlatFilters": {
         "additionalProperties": false,
         "properties": {
+          "absenteeOwner": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/BooleanFilterValue"
+              },
+              {
+                "description": "Owner's mailing address (street + 5-digit zip, case/punctuation-insensitive) differs from the property's site address — an investor / non-owner-occupied signal. `true` = absentee, `false` = owner mails to the property; parcels with no mailing or site address match neither. Evaluated per candidate document (no stored flag yet), so always pair it with a geography filter (`state`, `county`, `zipCode`, `fips`, a radius) — an unscoped `absenteeOwner` over all parcels may time out."
+              }
+            ]
+          },
           "activeLoanCount": {
             "allOf": [
               {
@@ -36767,6 +36777,9 @@
           "ownerName": {
             "$ref": "#/components/schemas/TextFilterValue"
           },
+          "ownerOccupancy": {
+            "$ref": "#/components/schemas/PropertyOwnerOccupancyFilterValue"
+          },
           "preSaleLoanCount": {
             "allOf": [
               {
@@ -37523,34 +37536,6 @@
                 ],
                 "type": "object"
               },
-              "ownerMailingAddress": {
-                "nullable": true,
-                "properties": {
-                  "city": {
-                    "nullable": true,
-                    "type": "string"
-                  },
-                  "state": {
-                    "nullable": true,
-                    "type": "string"
-                  },
-                  "street": {
-                    "nullable": true,
-                    "type": "string"
-                  },
-                  "zip": {
-                    "nullable": true,
-                    "type": "string"
-                  }
-                },
-                "required": [
-                  "street",
-                  "city",
-                  "state",
-                  "zip"
-                ],
-                "type": "object"
-              },
               "owners": {
                 "description": "Every owner of record — `owners[0]` is the same person the flat `ownerName`/`ownerFirstName`/`ownerLastName` fields describe, and the rest are co-owners/co-borrowers. Additive: those three fields are unchanged. `null` (never `[]`) when the parcel has no readable owner.",
                 "items": {
@@ -37728,6 +37713,16 @@
       "PropertyFlatFilters": {
         "additionalProperties": false,
         "properties": {
+          "absenteeOwner": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/BooleanFilterValue"
+              },
+              {
+                "description": "Owner's mailing address (street + 5-digit zip, case/punctuation-insensitive) differs from the property's site address — an investor / non-owner-occupied signal. `true` = absentee, `false` = owner mails to the property; parcels with no mailing or site address match neither. Evaluated per candidate document (no stored flag yet), so always pair it with a geography filter (`state`, `county`, `zipCode`, `fips`, a radius) — an unscoped `absenteeOwner` over all parcels may time out."
+              }
+            ]
+          },
           "activeLoanCount": {
             "allOf": [
               {
@@ -38184,6 +38179,9 @@
           "ownerName": {
             "$ref": "#/components/schemas/TextFilterValue"
           },
+          "ownerOccupancy": {
+            "$ref": "#/components/schemas/PropertyOwnerOccupancyFilterValue"
+          },
           "ownerType": {
             "anyOf": [
               {
@@ -39014,6 +39012,48 @@
         ],
         "type": "object"
       },
+      "PropertyOwnerOccupancyFilterValue": {
+        "anyOf": [
+          {
+            "description": "One of (case-insensitive): owner_occupied, probable_owner_occupied, not_flagged",
+            "enum": [
+              "owner_occupied",
+              "probable_owner_occupied",
+              "not_flagged"
+            ],
+            "type": "string"
+          },
+          {
+            "description": "Match any of these values",
+            "items": {
+              "description": "One of (case-insensitive): owner_occupied, probable_owner_occupied, not_flagged",
+              "enum": [
+                "owner_occupied",
+                "probable_owner_occupied",
+                "not_flagged"
+              ],
+              "type": "string"
+            },
+            "type": "array"
+          },
+          {
+            "description": "Fuzzy text match",
+            "properties": {
+              "match": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "match"
+            ],
+            "type": "object"
+          },
+          {
+            "nullable": true
+          }
+        ],
+        "description": "Assessor owner-occupancy flag, bucketed: `\"owner_occupied\"`, `\"probable_owner_occupied\"`, or `\"not_flagged\"` (the assessor did not flag the parcel — where non-owner-occupied/investor parcels land). Accepts one value or an array (any-of). For investor targeting use `{ownerOccupancy: \"not_flagged\", absenteeOwner: true}`, optionally with `ownerType: \"entity\"`."
+      },
       "PropertyParties": {
         "description": "Mortgage parties attributed to the parcel, split by scope: `alltime` (everyone on record, a strict superset of the rest), `active` (parties on loans still outstanding), `matched` (the subset whose loan resolved to a known NMLS entity) and `last` (the most recent loan). Real estate agents are not part of this block — reach parcels from an agent through `POST /v1/agents/{id}/properties`.",
         "properties": {
@@ -39387,6 +39427,11 @@
       },
       "PropertySummary": {
         "properties": {
+          "absenteeOwner": {
+            "description": "`true` when the owner's mailing address (street + 5-digit zip, case/punctuation-insensitive) differs from the property's site address — a non-owner-occupied/investor signal; `false` when the owner mails to the property; `null` when either address is missing. Filterable.",
+            "nullable": true,
+            "type": "boolean"
+          },
           "activeLoanCount": {
             "description": "Mortgages believed to still be outstanding. IMPORTANT: `0` does not always mean the parcel is paid off — on a recently-sold parcel it usually means the buyer's new mortgage has not reached the public record yet, so the honest reading is UNKNOWN. Check `activeLoanCountKnown` before treating a `0` as fact, and do not infer 100% `equity` from it.",
             "nullable": true,
@@ -39516,6 +39561,35 @@
             "nullable": true,
             "type": "string"
           },
+          "ownerMailingAddress": {
+            "description": "Primary owner's mailing address, `null` when none is recorded.",
+            "nullable": true,
+            "properties": {
+              "city": {
+                "nullable": true,
+                "type": "string"
+              },
+              "state": {
+                "nullable": true,
+                "type": "string"
+              },
+              "street": {
+                "nullable": true,
+                "type": "string"
+              },
+              "zip": {
+                "nullable": true,
+                "type": "string"
+              }
+            },
+            "required": [
+              "street",
+              "city",
+              "state",
+              "zip"
+            ],
+            "type": "object"
+          },
           "ownerMiddleName": {
             "nullable": true,
             "type": "string"
@@ -39524,8 +39598,17 @@
             "nullable": true,
             "type": "string"
           },
+          "ownerOccupancy": {
+            "description": "Assessor owner-occupancy flag, bucketed: `owner_occupied` (owner-occupied, incl. the vendor's phased-out non-residential code), `probable_owner_occupied`, or `not_flagged` (the assessor did not flag the parcel — not proof of an investor, but where non-owner-occupied/investor parcels land; pair with `absenteeOwner`). Filterable.",
+            "enum": [
+              "owner_occupied",
+              "probable_owner_occupied",
+              "not_flagged"
+            ],
+            "type": "string"
+          },
           "ownerOccupied": {
-            "description": "`true` if recorded owner-occupied; `null` = unknown.",
+            "description": "`true` only on the assessor's confident owner-occupied code (`\"Y\"`); `null` = not flagged / unknown, never `false`. Kept for compatibility — prefer `ownerOccupancy`.",
             "nullable": true,
             "type": "boolean"
           },
@@ -42114,7 +42197,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.103.1"
+    "version": "3.106.0"
   },
   "openapi": "3.1.0",
   "paths": {
@@ -74792,7 +74875,7 @@
     },
     "/v1/properties": {
       "post": {
-        "description": "Search and list individual properties/parcels with filters — one row per parcel. Filter by location (state, county, city, zip, address), owner name, property characteristics (beds, baths, square footage, year built, property type), value, and ownership or transaction history, with sorting and cursor pagination. This is the discrete per-property record search: use it to find specific properties or build a filtered property list. (For a single property by its ID use the property detail endpoint.) If you only need how many properties match and not the records themselves, send the same request body to `countProperties`.",
+        "description": "Search and list individual properties/parcels with filters — one row per parcel. Filter by location (state, county, city, zip, address), owner name, property characteristics (beds, baths, square footage, year built, property type), value, ownership or transaction history, and occupancy (`ownerOccupancy: not_flagged` plus `absenteeOwner: true` targets likely investor / non-owner-occupied parcels — pair `absenteeOwner` with a geography filter), with sorting and cursor pagination. This is the discrete per-property record search: use it to find specific properties or build a filtered property list. (For a single property by its ID use the property detail endpoint.) If you only need how many properties match and not the records themselves, send the same request body to `countProperties`.",
         "operationId": "listProperties",
         "requestBody": {
           "content": {

package/package.json

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