@model-match/api 3.56.0 → 3.57.1

package/openapi.json

@@ -216,6 +216,27 @@
         ],
         "type": "object"
       },
+      "AgentAka": {
+        "properties": {
+          "lastTransactionDate": {
+            "nullable": true,
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "transactions": {
+            "nullable": true,
+            "type": "number"
+          }
+        },
+        "required": [
+          "name",
+          "transactions",
+          "lastTransactionDate"
+        ],
+        "type": "object"
+      },
       "AgentChartMeasure": {
         "default": "units",
         "description": "Which metric each bar reports, AND what the bars are ranked by — the list is ordered by the measure you ask for, descending. Defaults to `units`, so an unqualified \"top originators\" means the busiest; pass `volume` for the biggest by dollars, or an average to rank by that average. Two things to know about the averages specifically. Buckets built from fewer than 5 documents are dropped from an average chart entirely, because a mean says nothing about how many transactions produced it and a single-transaction bucket would otherwise outrank real ones; no floor is applied to `units` or `volume`, where a lone large transaction is a legitimate top bar. And ranking a bucket list by a sub-aggregated average is approximate in the search engine — each shard contributes its own local top-N before they are merged — so treat the ordering of an average chart as indicative near the boundary rather than exact. Every bucket publishes its own `count`, so the sample size behind a value is never implicit.",
@@ -262,6 +283,37 @@
         ],
         "type": "string"
       },
+      "AgentContactEntry": {
+        "properties": {
+          "lastTransactionDate": {
+            "nullable": true,
+            "type": "string"
+          },
+          "transactions": {
+            "nullable": true,
+            "type": "number"
+          },
+          "type": {
+            "enum": [
+              "email",
+              "mobile",
+              "direct",
+              "office"
+            ],
+            "type": "string"
+          },
+          "value": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "value",
+          "type",
+          "transactions",
+          "lastTransactionDate"
+        ],
+        "type": "object"
+      },
       "AgentContacts": {
         "properties": {
           "emails": {
@@ -420,6 +472,20 @@
           },
           {
             "properties": {
+              "akas": {
+                "description": "Name variations recorded on past transactions.",
+                "items": {
+                  "$ref": "#/components/schemas/AgentAka"
+                },
+                "type": "array"
+              },
+              "contactHistory": {
+                "description": "Every email and phone on the record with how often and how recently it was seen (`contacts` without the counters).",
+                "items": {
+                  "$ref": "#/components/schemas/AgentContactEntry"
+                },
+                "type": "array"
+              },
               "contacts": {
                 "$ref": "#/components/schemas/AgentContacts"
               },
@@ -25415,7 +25481,7 @@
       "EnrichBulkJobResponse": {
         "properties": {
           "billingStatus": {
-            "description": "Outcome of the job's single finalize debit: `charged`, `capped` (member balance/daily cap hit — customer constraint), `billing_error` (5xx/auth — recoverable revenue to reconcile), or `none` (nothing matched). Absent on older rows.",
+            "description": "Outcome of the job's single finalize debit, taken before the results are released: `charged`, `capped` (member balance / spend cap / daily cap declined it — the job fails `insufficient_credits`), `billing_error` (the debit could not be made — the job fails `billing_unavailable`), or `none` (nothing matched). Absent until billing has run, and on older rows.",
             "enum": [
               "charged",
               "capped",
@@ -25440,6 +25506,7 @@
             "type": "string"
           },
           "error": {
+            "description": "Why the job failed. `insufficient_credits` = the charge was declined (balance, spend cap or daily cap), no results released. `billing_unavailable` = the charge could not be made, no results released — retry.",
             "type": "string"
           },
           "failed": {
@@ -44736,7 +44803,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.122.0"
+    "version": "3.123.1"
   },
   "openapi": "3.1.0",
   "paths": {

package/package.json

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