@model-match/api 3.14.0 → 3.15.0

package/dist/slim/index.mjs

@@ -1,4 +1,4 @@
-import { C as client, n as createClient } from "../src-Bm5e4LYA.mjs";
+import { C as client, n as createClient } from "../src-DA2DVf_U.mjs";
 //#region src/slim/sdk.gen.ts
 /**
 * Search agents with filters
@@ -4906,6 +4906,7 @@ const listLoans = (options) => {
 };
 /**
 * Configurable chart data (measure × slice)
+* Buckets the filtered loans by `slice` and ranks them by `measure`, descending. Party slices (`originator`, `broker`, `loanCompany`) are pageable: send `size` (1–1000) and follow `nextCursor` via `after` to walk the whole ranking, with `total` giving the (approximate) number of distinct parties. Other slices return their fixed top-N. `period` accepts rolling windows (`last30Days`, `last60Days`, `last90Days`, `previousMonth`, `currentMonth`) resolved in UTC; `/loans/analytics/summary` with the same filters and period returns the matching population totals.
 */
 const loansAnalyticsChart = (options) => {
 	return (options?.client ?? client).post({

package/dist/{src-Bm5e4LYA.mjs → src-DA2DVf_U.mjs}

@@ -5469,6 +5469,7 @@ var Loans = class {
 	}
 	/**
 	* Configurable chart data (measure × slice)
+	* Buckets the filtered loans by `slice` and ranks them by `measure`, descending. Party slices (`originator`, `broker`, `loanCompany`) are pageable: send `size` (1–1000) and follow `nextCursor` via `after` to walk the whole ranking, with `total` giving the (approximate) number of distinct parties. Other slices return their fixed top-N. `period` accepts rolling windows (`last30Days`, `last60Days`, `last90Days`, `previousMonth`, `currentMonth`) resolved in UTC; `/loans/analytics/summary` with the same filters and period returns the matching population totals.
 	*/
 	static analyticsChart(options) {
 		return (options?.client ?? client).post({

package/openapi.json

@@ -5269,7 +5269,7 @@
             "$ref": "#/components/schemas/Pagination"
           },
           "period": {
-            "$ref": "#/components/schemas/Period"
+            "$ref": "#/components/schemas/DatedPeriod"
           },
           "sort": {
             "$ref": "#/components/schemas/BreakdownSort"
@@ -5644,6 +5644,10 @@
           "measure": {
             "type": "string"
           },
+          "nextCursor": {
+            "description": "Paged party slices only (a chart request that passed `size` or `after` with `slice` `originator` / `broker` / `loanCompany`). Opaque cursor for the next page of the ranking — send it back as `after` with the same body. Absent on the last page.",
+            "type": "string"
+          },
           "omittedCount": {
             "description": "How many documents fell outside the bars — the size of the dropped tail, not its value. A chart groups by a capped number of distinct values, so a slice with more of them than the cap returns its largest groups and drops the rest; `zip`, `city`, `lender` and `originator` are the ones that reach it. It is the documents in the groups past the size cap, and only those: documents excluded from the slice by its empty-value filter, or carrying no value for it at all, are never grouped and are not counted here either. Where the response carries an `unattributed` row that row collects them; elsewhere a small residual against `/analytics/summary` can remain on `city`, `lender`, `originator` and similar, so bars plus this count reconcile with the summary's population exactly only on a slice with no such documents. `0` means the bars ARE the complete set, and the field is absent only where the grouping cannot truncate at all — so `0` and missing are different claims. Unlike a breakdown there is no next page to fetch: narrow the filters or pick a coarser slice. It is a DOCUMENT count and never a dollar or an average — the aggregation reports how many rows it left out, not what they were worth, so a truncated volume chart cannot be completed from this figure. One exception it does not cover: the average measures drop buckets thinner than a minimum sample size, and those are not counted here — compare against the summary when a mean matters.",
             "type": "number"
@@ -5654,6 +5658,14 @@
           },
           "slice": {
             "type": "string"
+          },
+          "total": {
+            "description": "Paged party slices only. Distinct bucket keys (e.g. originators) in the filtered population — what a consumer paginates against. A cardinality ESTIMATE (see `totalApproximate`): near-exact below 40,000, approximate above. On an average measure it can exceed the ranked buckets, which drop keys under the 5-document floor. Use `nextCursor`, not `total`, to decide whether another page exists.",
+            "type": "integer"
+          },
+          "totalApproximate": {
+            "description": "Present (always `true`) alongside `total`: the total is a cardinality estimate, not an exact count.",
+            "type": "boolean"
           }
         },
         "required": [
@@ -16075,6 +16087,36 @@
           }
         ]
       },
+      "DatedPeriod": {
+        "description": "Date window for loans / sales / market endpoints. Accepts every `Period` value plus rolling windows: `last30Days` / `last60Days` / `last90Days` (today minus 30 / 60 / 90 days through today), `previousMonth` (the last complete calendar month) and `currentMonth` (the 1st of this month through today). All windows are resolved in UTC with inclusive calendar-date bounds. Rolling windows are only accepted by the loans, sales and market endpoints (list, count, breakdowns, analytics summary / time-series / chart); originators / companies / branches / agents / offices endpoints return 400 for them.",
+        "enum": [
+          "2017",
+          "2018",
+          "2019",
+          "2020",
+          "2021",
+          "2022",
+          "2023",
+          "2024",
+          "2025",
+          "2026",
+          "last3Months",
+          "last6Months",
+          "last12Months",
+          "last14Months",
+          "last16Months",
+          "last18Months",
+          "last24Months",
+          "yearToDate",
+          "allTime",
+          "last30Days",
+          "last60Days",
+          "last90Days",
+          "previousMonth",
+          "currentMonth"
+        ],
+        "type": "string"
+      },
       "EarlyExitCounterparty": {
         "properties": {
           "name": {
@@ -18377,6 +18419,11 @@
           "advancedFilters": {
             "$ref": "#/components/schemas/FilterNode"
           },
+          "after": {
+            "description": "PARTY slices only. Opaque cursor from a previous page's `nextCursor`; send the same body otherwise. A cursor is bound to the `slice` and `measure` it was issued for (400 if they change). It is an offset into the ranking, so a rolling `period` re-resolved on a later UTC day ranks a shifted window.",
+            "minLength": 1,
+            "type": "string"
+          },
           "filters": {
             "$ref": "#/components/schemas/FilterNode"
           },
@@ -18670,7 +18717,13 @@
             "$ref": "#/components/schemas/ChartMeasure"
           },
           "period": {
-            "$ref": "#/components/schemas/Period"
+            "$ref": "#/components/schemas/DatedPeriod"
+          },
+          "size": {
+            "description": "PARTY slices only (`originator`, `broker`, `loanCompany`; 400 on any other slice). Page size for the ranking, 1–1000. Passing `size` (or `after`) turns on paging: the response gains `total` / `totalApproximate` and, when more buckets remain, `nextCursor`, and drops `omittedCount`. Buckets stay ranked by `measure` descending (ties broken by key), and bucket labels stay NMLS ids. Default when only `after` is sent: 200, the fixed chart's bucket count. Paging reaches the top 10,000 ranked buckets.",
+            "maximum": 1000,
+            "minimum": 1,
+            "type": "integer"
           },
           "slice": {
             "$ref": "#/components/schemas/LoanSlice"
@@ -19068,7 +19121,7 @@
             "$ref": "#/components/schemas/Pagination"
           },
           "period": {
-            "$ref": "#/components/schemas/Period"
+            "$ref": "#/components/schemas/DatedPeriod"
           },
           "sort": {
             "items": {
@@ -19611,7 +19664,7 @@
             "type": "object"
           },
           "period": {
-            "$ref": "#/components/schemas/Period"
+            "$ref": "#/components/schemas/DatedPeriod"
           }
         },
         "type": "object"
@@ -19918,7 +19971,7 @@
             "$ref": "#/components/schemas/Measure"
           },
           "period": {
-            "$ref": "#/components/schemas/Period"
+            "$ref": "#/components/schemas/DatedPeriod"
           },
           "segment": {
             "$ref": "#/components/schemas/LoanSlice"
@@ -20221,7 +20274,7 @@
             "$ref": "#/components/schemas/MarketChartMeasure"
           },
           "period": {
-            "$ref": "#/components/schemas/Period"
+            "$ref": "#/components/schemas/DatedPeriod"
           },
           "slice": {
             "$ref": "#/components/schemas/MarketSliceDimension"
@@ -20413,7 +20466,7 @@
             "type": "integer"
           },
           "period": {
-            "$ref": "#/components/schemas/Period"
+            "$ref": "#/components/schemas/DatedPeriod"
           },
           "slice": {
             "description": "Break the mix down by a market dimension — `metro` for the metro (CBSA) grain, `state` / `county` / `zip` for geography, or any product dimension. Each bucket reports its OWN denominators, so bucket shares are comparable to each other and to the overall mix. Omit for the overall mix only.",
@@ -20839,7 +20892,7 @@
             "$ref": "#/components/schemas/Pagination"
           },
           "period": {
-            "$ref": "#/components/schemas/Period"
+            "$ref": "#/components/schemas/DatedPeriod"
           },
           "sort": {
             "items": {
@@ -21198,7 +21251,7 @@
             "$ref": "#/components/schemas/MarketFlatFilters"
           },
           "period": {
-            "$ref": "#/components/schemas/Period"
+            "$ref": "#/components/schemas/DatedPeriod"
           }
         },
         "type": "object"
@@ -21291,7 +21344,7 @@
             "$ref": "#/components/schemas/MarketMeasure"
           },
           "period": {
-            "$ref": "#/components/schemas/Period"
+            "$ref": "#/components/schemas/DatedPeriod"
           },
           "segment": {
             "$ref": "#/components/schemas/MarketSliceDimension"
@@ -26867,6 +26920,7 @@
         "type": "object"
       },
       "Period": {
+        "description": "Pre-aggregated period block. Rolling windows (last30Days, last60Days, last90Days, previousMonth, currentMonth) are NOT accepted here and return 400; they are supported on the loans, sales and market endpoints (list, count, breakdowns, analytics summary / time-series / chart) (see `DatedPeriod`).",
         "enum": [
           "2017",
           "2018",
@@ -29986,7 +30040,7 @@
             "$ref": "#/components/schemas/ChartMeasure"
           },
           "period": {
-            "$ref": "#/components/schemas/Period"
+            "$ref": "#/components/schemas/DatedPeriod"
           },
           "slice": {
             "$ref": "#/components/schemas/SaleChartSlice"
@@ -30186,7 +30240,7 @@
             "$ref": "#/components/schemas/Pagination"
           },
           "period": {
-            "$ref": "#/components/schemas/Period"
+            "$ref": "#/components/schemas/DatedPeriod"
           },
           "sort": {
             "items": {
@@ -30440,7 +30494,7 @@
             "$ref": "#/components/schemas/SaleFlatFilters"
           },
           "period": {
-            "$ref": "#/components/schemas/Period"
+            "$ref": "#/components/schemas/DatedPeriod"
           }
         },
         "type": "object"
@@ -30464,7 +30518,7 @@
             "$ref": "#/components/schemas/Measure"
           },
           "period": {
-            "$ref": "#/components/schemas/Period"
+            "$ref": "#/components/schemas/DatedPeriod"
           },
           "segment": {
             "$ref": "#/components/schemas/SegmentDimension"
@@ -31692,7 +31746,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 1,000 rows per delivery: no entitlement required.** Available to\n  every authenticated caller.\n- **Above 1,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.",
     "title": "ModelMatch API",
-    "version": "3.58.0"
+    "version": "3.59.0"
   },
   "openapi": "3.1.0",
   "paths": {
@@ -55909,6 +55963,7 @@
     },
     "/v1/loans/analytics/chart": {
       "post": {
+        "description": "Buckets the filtered loans by `slice` and ranks them by `measure`, descending. Party slices (`originator`, `broker`, `loanCompany`) are pageable: send `size` (1–1000) and follow `nextCursor` via `after` to walk the whole ranking, with `total` giving the (approximate) number of distinct parties. Other slices return their fixed top-N. `period` accepts rolling windows (`last30Days`, `last60Days`, `last90Days`, `previousMonth`, `currentMonth`) resolved in UTC; `/loans/analytics/summary` with the same filters and period returns the matching population totals.",
         "operationId": "loansAnalyticsChart",
         "requestBody": {
           "content": {

package/package.json

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