@model-match/api 3.54.0 → 3.55.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/openapi.json CHANGED
@@ -29787,6 +29787,9 @@
29787
29787
  "appraisedValue": {
29788
29788
  "$ref": "#/components/schemas/NumericFilterValue"
29789
29789
  },
29790
+ "borrowerGeneration": {
29791
+ "$ref": "#/components/schemas/TextFilterValue"
29792
+ },
29790
29793
  "channel": {
29791
29794
  "$ref": "#/components/schemas/TextFilterValue"
29792
29795
  },
@@ -29825,12 +29828,18 @@
29825
29828
  "creditScore": {
29826
29829
  "$ref": "#/components/schemas/NumericFilterValue"
29827
29830
  },
29831
+ "currentHomeOwner": {
29832
+ "$ref": "#/components/schemas/BooleanFilterValue"
29833
+ },
29828
29834
  "dti": {
29829
29835
  "$ref": "#/components/schemas/NumericFilterValue"
29830
29836
  },
29831
29837
  "dtifront": {
29832
29838
  "$ref": "#/components/schemas/NumericFilterValue"
29833
29839
  },
29840
+ "firstTimeHomebuyer": {
29841
+ "$ref": "#/components/schemas/BooleanFilterValue"
29842
+ },
29834
29843
  "hmdaActionTaken": {
29835
29844
  "$ref": "#/components/schemas/TextFilterValue"
29836
29845
  },
@@ -29846,6 +29855,9 @@
29846
29855
  "loanPurpose": {
29847
29856
  "$ref": "#/components/schemas/TextFilterValue"
29848
29857
  },
29858
+ "loanStatus": {
29859
+ "$ref": "#/components/schemas/MarketLoanStatus"
29860
+ },
29849
29861
  "loanTerm": {
29850
29862
  "$ref": "#/components/schemas/NumericFilterValue"
29851
29863
  },
@@ -29924,6 +29936,9 @@
29924
29936
  "purchasePrice": {
29925
29937
  "$ref": "#/components/schemas/NumericFilterValue"
29926
29938
  },
29939
+ "selfEmployed": {
29940
+ "$ref": "#/components/schemas/BooleanFilterValue"
29941
+ },
29927
29942
  "state": {
29928
29943
  "$ref": "#/components/schemas/TextFilterValue"
29929
29944
  },
@@ -29937,6 +29952,9 @@
29937
29952
  }
29938
29953
  ]
29939
29954
  },
29955
+ "veteranIndicator": {
29956
+ "$ref": "#/components/schemas/BooleanFilterValue"
29957
+ },
29940
29958
  "zip": {
29941
29959
  "$ref": "#/components/schemas/TextFilterValue"
29942
29960
  }
@@ -30009,6 +30027,50 @@
30009
30027
  ],
30010
30028
  "type": "object"
30011
30029
  },
30030
+ "MarketLoanStatus": {
30031
+ "anyOf": [
30032
+ {
30033
+ "description": "One of (case-insensitive): funded, purchased, not_funded, pending",
30034
+ "enum": [
30035
+ "funded",
30036
+ "purchased",
30037
+ "not_funded",
30038
+ "pending"
30039
+ ],
30040
+ "type": "string"
30041
+ },
30042
+ {
30043
+ "description": "Match any of these values",
30044
+ "items": {
30045
+ "description": "One of (case-insensitive): funded, purchased, not_funded, pending",
30046
+ "enum": [
30047
+ "funded",
30048
+ "purchased",
30049
+ "not_funded",
30050
+ "pending"
30051
+ ],
30052
+ "type": "string"
30053
+ },
30054
+ "type": "array"
30055
+ },
30056
+ {
30057
+ "description": "Fuzzy text match",
30058
+ "properties": {
30059
+ "match": {
30060
+ "type": "string"
30061
+ }
30062
+ },
30063
+ "required": [
30064
+ "match"
30065
+ ],
30066
+ "type": "object"
30067
+ },
30068
+ {
30069
+ "nullable": true
30070
+ }
30071
+ ],
30072
+ "description": "HMDA action, else funding/denial/lock date evidence."
30073
+ },
30012
30074
  "MarketMeasure": {
30013
30075
  "description": "Which metric to compute. Every field-backed measure is sentinel-guarded: the source encodes unknown values as an out-of-range fill, so values outside the measure's plausible range are dropped before it is aggregated. Ranges: `volume` 0–100,000,000; `avgRate` 0–25; `avgLoanAmount` 0–100,000,000; `avgCreditScore` 300–850; `avgLTV` 0–999; `avgDTI` 0–999; `avgIncome` 0–100,000,000; `avgAppraisedValue` 0–100,000,000; `avgPurchasePrice` 0–100,000,000; `avgDtiFront` 0–999; `avgCombinedLtv` 0–999; `avgLoanTerm` 0–1,200; `originatedVolume` 0–100,000,000; `originatedAvgDti` 0–100. `units` and `originatedUnits` are document counts and are not guarded. Each response reports how many documents its guard excluded, so a mean taken over 98% of the data can be told apart from one taken over 60%. NOTE on population: `units` and `volume` cover loan APPLICATIONS of every outcome — denials, withdrawals and secondary-market purchases included — and so does `avgDTI`, while `originatedUnits`, `originatedVolume` and `originatedAvgDti` cover originations only.",
30014
30076
  "enum": [
@@ -44471,7 +44533,7 @@
44471
44533
  "info": {
44472
44534
  "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.",
44473
44535
  "title": "ModelMatch API",
44474
- "version": "3.120.0"
44536
+ "version": "3.121.0"
44475
44537
  },
44476
44538
  "openapi": "3.1.0",
44477
44539
  "paths": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@model-match/api",
3
- "version": "3.54.0",
3
+ "version": "3.55.0",
4
4
  "description": "TypeScript client for the ModelMatch API",
5
5
  "license": "MIT",
6
6
  "files": [