@model-match/api 3.30.1 → 3.31.0

package/openapi.json

@@ -35693,6 +35693,9 @@
               "type": "object"
             },
             "type": "array"
+          },
+          "transactionMix": {
+            "$ref": "#/components/schemas/OriginatorTransactionMixFilter"
           }
         },
         "type": "object"
@@ -36384,7 +36387,7 @@
         "additionalProperties": false,
         "properties": {
           "basis": {
-            "description": "`volume` (default — what the row's `fhaPct` / `vaPct` / `conventionalPct` report) or `units` (loan count).",
+            "description": "`volume` (default) or `units` (loan count).",
             "enum": [
               "volume",
               "units"
@@ -36392,14 +36395,14 @@
             "type": "string"
           },
           "maxShare": {
-            "description": "Upper bound, 0–100 percent. An originator who wrote none of the product has a 0% share and passes.",
+            "description": "Upper bound, 0–100. No bucket = 0% (passes).",
             "example": 60,
             "maximum": 100,
             "minimum": 0,
             "type": "number"
           },
           "minShare": {
-            "description": "Lower bound on the product's share of the period book, 0–100 percent.",
+            "description": "Lower bound, 0–100 percent of the period book.",
             "example": 25,
             "maximum": 100,
             "minimum": 0,
@@ -36434,15 +36437,63 @@
             ],
             "example": "fha",
             "type": "string"
+          },
+          "products": {
+            "description": "Any-of instead of `product`: `[\"fha\",\"va\",\"usda\"]` = one of them on its own meets the bounds (shares never summed).",
+            "items": {
+              "description": "Loan product (case-insensitive).",
+              "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"
+              ],
+              "example": "fha",
+              "type": "string"
+            },
+            "maxItems": 10,
+            "minItems": 1,
+            "type": "array"
+          },
+          "volume": {
+            "additionalProperties": false,
+            "description": "Dollar volume of this type in the period, `{gte, lte}`. Needs the bucket (no loans of the type fails).",
+            "properties": {
+              "gte": {
+                "minimum": 0,
+                "type": "number"
+              },
+              "lte": {
+                "minimum": 0,
+                "type": "number"
+              }
+            },
+            "type": "object"
           }
         },
-        "required": [
-          "product"
-        ],
         "type": "object"
       },
       "OriginatorProductMixFilter": {
-        "description": "Whole-book product-share bands for the selected period, ANDed: `[{product: \"fha\", minShare: 30}, {product: \"va\", maxShare: 10}]` = FHA is at least 30% of their period volume AND VA at most 10%. Shares are 0–100 percents of TOTAL period production across all markets (not scoped by any geography filter), the same per-product figures the row reports as `fhaPct` / `vaPct` / `conventionalPct`. No bucket for a product = 0% (fails any `minShare` > 0, passes any `maxShare`). Pair with `units: {gte: N}` so a 100% share off two loans does not read as a specialty.",
+        "description": "Whole-book product-share / volume bands for the selected period, ANDed: `[{product: \"fha\", minShare: 30}, {product: \"va\", maxShare: 10}]` = FHA ≥ 30% of period volume AND VA ≤ 10%; `{product:\"fha\", volume:{gte:10000000}}` = ≥ $10M of FHA. Shares are 0–100 percents of TOTAL period production across all markets (not geography-scoped), as the row's `fhaPct` / `vaPct` / `conventionalPct`. No bucket = 0% (fails `minShare` > 0, passes `maxShare`). Pair with `units: {gte: N}` so a 100% share off two loans is not a specialty.",
         "items": {
           "$ref": "#/components/schemas/OriginatorProductMixEntry"
         },
@@ -37611,6 +37662,68 @@
         },
         "type": "object"
       },
+      "OriginatorTransactionMixFilter": {
+        "description": "Transaction-type bands, same rules as `productMix`: `[{transactionType:\"purchase\", minShare:60}]` = purchases ≥ 60% of period volume.",
+        "items": {
+          "additionalProperties": false,
+          "properties": {
+            "basis": {
+              "description": "`volume` (default) or `units` (loan count).",
+              "enum": [
+                "volume",
+                "units"
+              ],
+              "type": "string"
+            },
+            "maxShare": {
+              "description": "Upper bound, 0–100. No bucket = 0% (passes).",
+              "example": 60,
+              "maximum": 100,
+              "minimum": 0,
+              "type": "number"
+            },
+            "minShare": {
+              "description": "Lower bound, 0–100 percent of the period book.",
+              "example": 25,
+              "maximum": 100,
+              "minimum": 0,
+              "type": "number"
+            },
+            "transactionType": {
+              "enum": [
+                "purchase",
+                "refinance",
+                "construction",
+                "equity",
+                "UNKNOWN"
+              ],
+              "type": "string"
+            },
+            "volume": {
+              "additionalProperties": false,
+              "description": "Dollar volume of this type in the period, `{gte, lte}`. Needs the bucket (no loans of the type fails).",
+              "properties": {
+                "gte": {
+                  "minimum": 0,
+                  "type": "number"
+                },
+                "lte": {
+                  "minimum": 0,
+                  "type": "number"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "required": [
+            "transactionType"
+          ],
+          "type": "object"
+        },
+        "maxItems": 10,
+        "minItems": 1,
+        "type": "array"
+      },
       "OriginatorTransactionTypeFilterValue": {
         "anyOf": [
           {
@@ -42860,7 +42973,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.82.1"
+    "version": "3.83.0"
   },
   "openapi": "3.1.0",
   "paths": {

package/package.json

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