@model-match/api 3.11.0 → 3.12.0

package/dist/slim/index.mjs

@@ -1,4 +1,4 @@
-import { S as client, n as createClient } from "../src-CSLArzGF.mjs";
+import { S as client, n as createClient } from "../src-B_YslAkc.mjs";
 //#region src/slim/sdk.gen.ts
 /**
 * Search agents with filters
@@ -5163,7 +5163,7 @@ const marketCommunityLending = (options) => {
 };
 /**
 * Monthly NMLS activity: newly licensed, active, leaving
-* Monthly series of newly licensed loan officers, loan officers with an open employment at month end, and loan officers who left the industry (no open employment; last one ended that month). `becameInactive` (license authorization lapses) is not available and is always null. `all_time` charts the last 60 months. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+* Monthly series of newly licensed loan officers, loan officers with an open employment at month end, and loan officers who left the industry (no open employment; last one ended that month). `becameInactive` (license authorization lapses) is not available and is always null. `all_time` charts the last 60 months. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 */
 const marketMovementActivity = (options) => {
 	return (options?.client ?? client).get({
@@ -5180,7 +5180,7 @@ const marketMovementActivity = (options) => {
 };
 /**
 * Loan officer movement by state and city
-* Loan officers who changed companies in the window, grouped by state (all states) and city (top `limit`), each with the company that gained the most of them. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+* Loan officers who changed companies in the window, grouped by state (all states) and city (top `limit`), each with the company that gained the most of them. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 */
 const marketMovementByState = (options) => {
 	return (options?.client ?? client).get({
@@ -5197,7 +5197,7 @@ const marketMovementByState = (options) => {
 };
 /**
 * Did the move pay off? Production before vs after moving
-* For loan officers who moved in the window (default last 24 months), annualized production at the previous employer vs the new one, bucketed by pre-move tier (Low <25, Mid 25–99, High 100+ units/yr). Each side is annualized over the months actually spent there inside a trailing 24-month production window; movers with fewer than `windowMonths` months on either side are excluded. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+* For loan officers who moved in the window (default last 24 months), annualized production at the previous employer vs the new one, bucketed by pre-move tier (Low <25, Mid 25–99, High 100+ units/yr). Each side is annualized over the months actually spent there inside a trailing 24-month production window; movers with fewer than `windowMonths` months on either side are excluded. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 */
 const marketMovementCohortPayoff = (options) => {
 	return (options?.client ?? client).get({
@@ -5214,7 +5214,7 @@ const marketMovementCohortPayoff = (options) => {
 };
 /**
 * Companies that gained the most loan officers
-* Companies ranked by loan officers gained in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+* Companies ranked by loan officers gained in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 */
 const marketMovementMostGained = (options) => {
 	return (options?.client ?? client).get({
@@ -5231,7 +5231,7 @@ const marketMovementMostGained = (options) => {
 };
 /**
 * Companies that lost the most loan officers
-* Companies ranked by loan officers lost in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+* Companies ranked by loan officers lost in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 */
 const marketMovementMostLost = (options) => {
 	return (options?.client ?? client).get({
@@ -5248,7 +5248,7 @@ const marketMovementMostLost = (options) => {
 };
 /**
 * Loan officers who changed companies
-* The loan officers who moved to a new company in the window, with previous and new employer, move date, current location and production. `sort=volume` returns the highest producers who moved (notable moves); `sort=date` pages every move newest first. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+* The loan officers who moved to a new company in the window, with previous and new employer, move date, current location and production. `sort=volume` returns the highest producers who moved (notable moves); `sort=date` pages every move newest first. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 */
 const marketMovementMovers = (options) => {
 	return (options?.client ?? client).get({
@@ -5265,7 +5265,7 @@ const marketMovementMovers = (options) => {
 };
 /**
 * Top-100 loan officer rankings for a year
-* The top 100 loan officers for a calendar year by total volume, units, or FHA / VA / purchase / refinance volume, with current employer and retail / banker / broker type. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+* The top 100 loan officers for a calendar year by total volume, units, or FHA / VA / purchase / refinance volume, with current employer and retail / banker / broker type. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 */
 const marketMovementRankings = (options) => {
 	return (options?.client ?? client).get({
@@ -5282,7 +5282,7 @@ const marketMovementRankings = (options) => {
 };
 /**
 * Loan officer movement totals for a period
-* Period totals of loan-officer movement: company joins, company-to-company transitions, complete company departures, industry exits, newly licensed loan officers, the working head-count at both ends of the window and its net change, plus the trailing-14-month production of the loan officers who moved. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+* Period totals of loan-officer movement: company joins, company-to-company transitions, complete company departures, industry exits, newly licensed loan officers, the working head-count at both ends of the window and its net change, plus the trailing-14-month production of the loan officers who moved. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 */
 const marketMovementStats = (options) => {
 	return (options?.client ?? client).get({
@@ -5299,7 +5299,7 @@ const marketMovementStats = (options) => {
 };
 /**
 * Company-to-company loan officer flows
-* The largest company-to-company flows in the window: how many loan officers moved from each previous employer to each new one. Filter to one company (either side) with `companyNmlsId`. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+* The largest company-to-company flows in the window: how many loan officers moved from each previous employer to each new one. Filter to one company (either side) with `companyNmlsId`. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 */
 const marketMovementTransitions = (options) => {
 	return (options?.client ?? client).get({

package/dist/{src-CSLArzGF.mjs → src-B_YslAkc.mjs}

@@ -5711,7 +5711,7 @@ var Market = class {
 	}
 	/**
 	* Monthly NMLS activity: newly licensed, active, leaving
-	* Monthly series of newly licensed loan officers, loan officers with an open employment at month end, and loan officers who left the industry (no open employment; last one ended that month). `becameInactive` (license authorization lapses) is not available and is always null. `all_time` charts the last 60 months. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+	* Monthly series of newly licensed loan officers, loan officers with an open employment at month end, and loan officers who left the industry (no open employment; last one ended that month). `becameInactive` (license authorization lapses) is not available and is always null. `all_time` charts the last 60 months. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 	*/
 	static movementActivity(options) {
 		return (options?.client ?? client).get({
@@ -5728,7 +5728,7 @@ var Market = class {
 	}
 	/**
 	* Loan officer movement by state and city
-	* Loan officers who changed companies in the window, grouped by state (all states) and city (top `limit`), each with the company that gained the most of them. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+	* Loan officers who changed companies in the window, grouped by state (all states) and city (top `limit`), each with the company that gained the most of them. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 	*/
 	static movementByState(options) {
 		return (options?.client ?? client).get({
@@ -5745,7 +5745,7 @@ var Market = class {
 	}
 	/**
 	* Did the move pay off? Production before vs after moving
-	* For loan officers who moved in the window (default last 24 months), annualized production at the previous employer vs the new one, bucketed by pre-move tier (Low <25, Mid 25–99, High 100+ units/yr). Each side is annualized over the months actually spent there inside a trailing 24-month production window; movers with fewer than `windowMonths` months on either side are excluded. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+	* For loan officers who moved in the window (default last 24 months), annualized production at the previous employer vs the new one, bucketed by pre-move tier (Low <25, Mid 25–99, High 100+ units/yr). Each side is annualized over the months actually spent there inside a trailing 24-month production window; movers with fewer than `windowMonths` months on either side are excluded. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 	*/
 	static movementCohortPayoff(options) {
 		return (options?.client ?? client).get({
@@ -5762,7 +5762,7 @@ var Market = class {
 	}
 	/**
 	* Companies that gained the most loan officers
-	* Companies ranked by loan officers gained in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+	* Companies ranked by loan officers gained in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 	*/
 	static movementMostGained(options) {
 		return (options?.client ?? client).get({
@@ -5779,7 +5779,7 @@ var Market = class {
 	}
 	/**
 	* Companies that lost the most loan officers
-	* Companies ranked by loan officers lost in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+	* Companies ranked by loan officers lost in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 	*/
 	static movementMostLost(options) {
 		return (options?.client ?? client).get({
@@ -5796,7 +5796,7 @@ var Market = class {
 	}
 	/**
 	* Loan officers who changed companies
-	* The loan officers who moved to a new company in the window, with previous and new employer, move date, current location and production. `sort=volume` returns the highest producers who moved (notable moves); `sort=date` pages every move newest first. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+	* The loan officers who moved to a new company in the window, with previous and new employer, move date, current location and production. `sort=volume` returns the highest producers who moved (notable moves); `sort=date` pages every move newest first. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 	*/
 	static movementMovers(options) {
 		return (options?.client ?? client).get({
@@ -5813,7 +5813,7 @@ var Market = class {
 	}
 	/**
 	* Top-100 loan officer rankings for a year
-	* The top 100 loan officers for a calendar year by total volume, units, or FHA / VA / purchase / refinance volume, with current employer and retail / banker / broker type. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+	* The top 100 loan officers for a calendar year by total volume, units, or FHA / VA / purchase / refinance volume, with current employer and retail / banker / broker type. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 	*/
 	static movementRankings(options) {
 		return (options?.client ?? client).get({
@@ -5830,7 +5830,7 @@ var Market = class {
 	}
 	/**
 	* Loan officer movement totals for a period
-	* Period totals of loan-officer movement: company joins, company-to-company transitions, complete company departures, industry exits, newly licensed loan officers, the working head-count at both ends of the window and its net change, plus the trailing-14-month production of the loan officers who moved. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+	* Period totals of loan-officer movement: company joins, company-to-company transitions, complete company departures, industry exits, newly licensed loan officers, the working head-count at both ends of the window and its net change, plus the trailing-14-month production of the loan officers who moved. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 	*/
 	static movementStats(options) {
 		return (options?.client ?? client).get({
@@ -5847,7 +5847,7 @@ var Market = class {
 	}
 	/**
 	* Company-to-company loan officer flows
-	* The largest company-to-company flows in the window: how many loan officers moved from each previous employer to each new one. Filter to one company (either side) with `companyNmlsId`. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.
+	* The largest company-to-company flows in the window: how many loan officers moved from each previous employer to each new one. Filter to one company (either side) with `companyNmlsId`. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.
 	*/
 	static movementTransitions(options) {
 		return (options?.client ?? client).get({

package/openapi.json

@@ -21720,7 +21720,7 @@
                 "type": "number"
               },
               "truncated": {
-                "description": "True when more movers matched than the analysis scans; the tiers describe a subset.",
+                "description": "Always false: every mover in the window is analyzed. Kept for compatibility.",
                 "type": "boolean"
               }
             },
@@ -21892,7 +21892,7 @@
             "type": "number"
           },
           "volumeTruncated": {
-            "description": "True when the ranked side exceeded the per-company roster cap and `volume`/`units` cover a subset.",
+            "description": "Always false: `volume`/`units` cover every loan officer on the ranked side. Kept for compatibility.",
             "type": "boolean"
           }
         },
@@ -21909,6 +21909,27 @@
         ],
         "type": "object"
       },
+      "MovementComputing": {
+        "description": "The result is not ready within the response budget (25 s). The computation continues and is cached when done — repeat the identical request after `retryAfterMs` until it answers 200. Identical concurrent requests share one computation.",
+        "properties": {
+          "retryAfterMs": {
+            "description": "Suggested wait before repeating the SAME request (also sent as `Retry-After`, in seconds).",
+            "example": 5000,
+            "type": "integer"
+          },
+          "status": {
+            "enum": [
+              "computing"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "status",
+          "retryAfterMs"
+        ],
+        "type": "object"
+      },
       "MovementMover": {
         "properties": {
           "city": {
@@ -21996,6 +22017,7 @@
             "type": "number"
           },
           "total": {
+            "description": "Rows matching the request (moves for `sort=date`, loan officers for `sort=volume`).",
             "nullable": true,
             "type": "number"
           },
@@ -22207,10 +22229,11 @@
             "type": "number"
           },
           "moversScanned": {
-            "description": "How many moving loan officers the volume figures cover. Below `transitions` only when `moversTruncated` is true.",
+            "description": "How many moving loan officers the volume figures cover (each counted once, at their latest move in the window).",
             "type": "number"
           },
           "moversTruncated": {
+            "description": "Always false: every mover in the window is covered. Kept for compatibility.",
             "type": "boolean"
           },
           "net": {
@@ -22229,7 +22252,7 @@
             "type": "number"
           },
           "volumeTransferred": {
-            "description": "Trailing 14-month origination volume of the loan officers counted in `transitions` (see `moversScanned`).",
+            "description": "Trailing 14-month origination volume of the loan officers counted in `transitions` (see `moversScanned`), as of the last weekly refresh.",
             "type": "number"
           },
           "window": {
@@ -24551,7 +24574,7 @@
                 ]
               },
               "timeAtCompanyMonths": {
-                "description": "Whole months at the CURRENT employer (`tenureMonths` on each row), from the NMLS registration record as of the last weekly refresh. `{gte:24}` = at their company two years or more; `{lte:6}` = recent movers. Only originators currently working at a company have a value. Resolved against the registration record before the list query runs, so it must narrow to at most 10,000 originators on ONE side — either the tenure range itself (optionally with `companyNmlsId`), or the rest of your filters (e.g. a state or city). A request where both sides are wider answers 400 naming this limit. Flat filters only, and not inside `mode: \"or\"`. Not sortable — sort by `yearsInIndustry` or production instead.",
+                "description": "Whole months at the CURRENT employer (`tenureMonths` on each row), from the NMLS registration record as of the last weekly refresh. `{gte:24}` = at their company two years or more; `{lte:6}` = recent movers. Only originators currently working at a company have a value. Sortable as `tenureMonths`. Filters natively at any result size. Only in the rare window after a production-data rebuild and before the next weekly registration refresh is it resolved against the registration record first; then it must narrow to at most 10,000 originators on ONE side — the tenure range itself (optionally with `companyNmlsId`), or the rest of your filters — and a request where both sides are wider answers 400 naming this limit. Flat filters only, and not inside `mode: \"or\"`.",
                 "nullable": true,
                 "properties": {
                   "gt": {
@@ -24711,7 +24734,8 @@
                     "city",
                     "countyFips",
                     "producersOnly",
-                    "yearsInIndustry"
+                    "yearsInIndustry",
+                    "tenureMonths"
                   ],
                   "type": "string"
                 },
@@ -31247,7 +31271,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.55.0"
+    "version": "3.56.0"
   },
   "openapi": "3.1.0",
   "paths": {
@@ -56597,7 +56621,7 @@
     },
     "/v1/market/movement/activity": {
       "get": {
-        "description": "Monthly series of newly licensed loan officers, loan officers with an open employment at month end, and loan officers who left the industry (no open employment; last one ended that month). `becameInactive` (license authorization lapses) is not available and is always null. `all_time` charts the last 60 months. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "Monthly series of newly licensed loan officers, loan officers with an open employment at month end, and loan officers who left the industry (no open employment; last one ended that month). `becameInactive` (license authorization lapses) is not available and is always null. `all_time` charts the last 60 months. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementActivity",
         "parameters": [
           {
@@ -56660,6 +56684,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -56719,7 +56764,7 @@
     },
     "/v1/market/movement/by-state": {
       "get": {
-        "description": "Loan officers who changed companies in the window, grouped by state (all states) and city (top `limit`), each with the company that gained the most of them. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "Loan officers who changed companies in the window, grouped by state (all states) and city (top `limit`), each with the company that gained the most of them. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementByState",
         "parameters": [
           {
@@ -56806,6 +56851,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -56865,7 +56931,7 @@
     },
     "/v1/market/movement/cohort-payoff": {
       "get": {
-        "description": "For loan officers who moved in the window (default last 24 months), annualized production at the previous employer vs the new one, bucketed by pre-move tier (Low <25, Mid 25–99, High 100+ units/yr). Each side is annualized over the months actually spent there inside a trailing 24-month production window; movers with fewer than `windowMonths` months on either side are excluded. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "For loan officers who moved in the window (default last 24 months), annualized production at the previous employer vs the new one, bucketed by pre-move tier (Low <25, Mid 25–99, High 100+ units/yr). Each side is annualized over the months actually spent there inside a trailing 24-month production window; movers with fewer than `windowMonths` months on either side are excluded. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementCohortPayoff",
         "parameters": [
           {
@@ -56955,6 +57021,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -57014,7 +57101,7 @@
     },
     "/v1/market/movement/most-gained": {
       "get": {
-        "description": "Companies ranked by loan officers gained in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "Companies ranked by loan officers gained in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementMostGained",
         "parameters": [
           {
@@ -57115,6 +57202,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -57174,7 +57282,7 @@
     },
     "/v1/market/movement/most-lost": {
       "get": {
-        "description": "Companies ranked by loan officers lost in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "Companies ranked by loan officers lost in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementMostLost",
         "parameters": [
           {
@@ -57275,6 +57383,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -57334,7 +57463,7 @@
     },
     "/v1/market/movement/movers": {
       "get": {
-        "description": "The loan officers who moved to a new company in the window, with previous and new employer, move date, current location and production. `sort=volume` returns the highest producers who moved (notable moves); `sort=date` pages every move newest first. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "The loan officers who moved to a new company in the window, with previous and new employer, move date, current location and production. `sort=volume` returns the highest producers who moved (notable moves); `sort=date` pages every move newest first. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementMovers",
         "parameters": [
           {
@@ -57465,6 +57594,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -57524,7 +57674,7 @@
     },
     "/v1/market/movement/rankings": {
       "get": {
-        "description": "The top 100 loan officers for a calendar year by total volume, units, or FHA / VA / purchase / refinance volume, with current employer and retail / banker / broker type. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "The top 100 loan officers for a calendar year by total volume, units, or FHA / VA / purchase / refinance volume, with current employer and retail / banker / broker type. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementRankings",
         "parameters": [
           {
@@ -57590,6 +57740,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -57649,7 +57820,7 @@
     },
     "/v1/market/movement/stats": {
       "get": {
-        "description": "Period totals of loan-officer movement: company joins, company-to-company transitions, complete company departures, industry exits, newly licensed loan officers, the working head-count at both ends of the window and its net change, plus the trailing-14-month production of the loan officers who moved. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "Period totals of loan-officer movement: company joins, company-to-company transitions, complete company departures, industry exits, newly licensed loan officers, the working head-count at both ends of the window and its net change, plus the trailing-14-month production of the loan officers who moved. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementStats",
         "parameters": [
           {
@@ -57724,6 +57895,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -57783,7 +57975,7 @@
     },
     "/v1/market/movement/transitions": {
       "get": {
-        "description": "The largest company-to-company flows in the window: how many loan officers moved from each previous employer to each new one. Filter to one company (either side) with `companyNmlsId`. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "The largest company-to-company flows in the window: how many loan officers moved from each previous employer to each new one. Filter to one company (either side) with `companyNmlsId`. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementTransitions",
         "parameters": [
           {
@@ -57880,6 +58072,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@model-match/api",
-	"version": "3.11.0",
+	"version": "3.12.0",
 	"description": "TypeScript client for the ModelMatch API",
 	"license": "MIT",
 	"files": [
@@ -41,7 +41,7 @@
 	},
 	"devDependencies": {
 		"@hey-api/openapi-ts": "^0.67.6",
-		"@model-match-inc/api": "3.53.3",
+		"@model-match-inc/api": "3.55.0",
 		"tsdown": "^0.21.10",
 		"typescript": "6.0.2",
 		"vitest": "4.1.2"