@model-match/api 3.39.0 → 3.41.0

package/openapi.json

@@ -17196,6 +17196,37 @@
         ],
         "type": "object"
       },
+      "CompanyDepartureStatusResponse": {
+        "properties": {
+          "notWorking": {
+            "description": "Exits with no current employer on file today — not re-employed yet, or left the industry. `workingElsewhere` + `notWorking` = `total`.",
+            "type": "number"
+          },
+          "total": {
+            "description": "Exits in the window. An exit is a loan officer whose latest record at this company ended inside the window and who holds NO open record there — a complete departure.",
+            "type": "number"
+          },
+          "truncated": {
+            "description": "`true` when the company has more than 100,000 loan officers in scope and only the first 100,000 (by NMLS ID) were counted. `false` means every figure covers the full population.",
+            "type": "boolean"
+          },
+          "window": {
+            "$ref": "#/components/schemas/EmploymentWindow"
+          },
+          "workingElsewhere": {
+            "description": "Exits whose current employer on file today is another company.",
+            "type": "number"
+          }
+        },
+        "required": [
+          "window",
+          "total",
+          "workingElsewhere",
+          "notWorking",
+          "truncated"
+        ],
+        "type": "object"
+      },
       "CompanyDetail": {
         "allOf": [
           {
@@ -19484,6 +19515,74 @@
         ],
         "type": "object"
       },
+      "CompanyMoverProductionResponse": {
+        "properties": {
+          "arrivals": {
+            "description": "Hires in the window. A hire is a loan officer whose earliest employment record at this company still relevant to the window (open, or ended on/after the window start) starts inside it — so someone who fully left and came back inside the window counts, and an existing employee who adds a state license does not.",
+            "properties": {
+              "count": {
+                "description": "Loan officers on this side.",
+                "type": "number"
+              },
+              "units": {
+                "description": "Loans behind `volume`.",
+                "type": "number"
+              },
+              "volume": {
+                "description": "Their combined production across ALL employers, recorded inside the production window.",
+                "type": "number"
+              }
+            },
+            "required": [
+              "count",
+              "volume",
+              "units"
+            ],
+            "type": "object"
+          },
+          "departures": {
+            "description": "Exits in the window. An exit is a loan officer whose latest record at this company ended inside the window and who holds NO open record there — a complete departure.",
+            "properties": {
+              "count": {
+                "description": "Loan officers on this side.",
+                "type": "number"
+              },
+              "units": {
+                "description": "Loans behind `volume`.",
+                "type": "number"
+              },
+              "volume": {
+                "description": "Their combined production across ALL employers, recorded inside the production window.",
+                "type": "number"
+              }
+            },
+            "required": [
+              "count",
+              "volume",
+              "units"
+            ],
+            "type": "object"
+          },
+          "productionWindow": {
+            "$ref": "#/components/schemas/EmploymentWindow"
+          },
+          "truncated": {
+            "description": "`true` when the company has more than 100,000 loan officers in scope and only the first 100,000 (by NMLS ID) were counted. `false` means every figure covers the full population.",
+            "type": "boolean"
+          },
+          "window": {
+            "$ref": "#/components/schemas/EmploymentWindow"
+          }
+        },
+        "required": [
+          "window",
+          "productionWindow",
+          "arrivals",
+          "departures",
+          "truncated"
+        ],
+        "type": "object"
+      },
       "CompanyMsaFilterValue": {
         "anyOf": [
           {
@@ -46149,7 +46248,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.99.0"
+    "version": "3.101.0"
   },
   "openapi": "3.1.0",
   "paths": {
@@ -56382,6 +56481,138 @@
         ]
       }
     },
+    "/v1/companies/{nmlsId}/departure-status": {
+      "get": {
+        "description": "The window's complete departures, split by whether each loan officer's current employer on file is another company. One aggregate — no rows.",
+        "operationId": "companyDepartureStatus",
+        "parameters": [
+          {
+            "description": "Company NMLS ID",
+            "in": "path",
+            "name": "nmlsId",
+            "required": true,
+            "schema": {
+              "description": "Company NMLS ID",
+              "type": "string"
+            }
+          },
+          {
+            "description": "Preset window when `from`/`to` are not given (default `last12Months`). Rolling periods start on the FIRST day of the month N months back and end today; a year is Jan 1 – Dec 31; `allTime` starts 2017-01-01, the earliest reliable registration data. Also selects the production period for volume/units.",
+            "in": "query",
+            "name": "period",
+            "required": false,
+            "schema": {
+              "allOf": [
+                {
+                  "$ref": "#/components/schemas/Period"
+                },
+                {
+                  "description": "Preset window when `from`/`to` are not given (default `last12Months`). Rolling periods start on the FIRST day of the month N months back and end today; a year is Jan 1 – Dec 31; `allTime` starts 2017-01-01, the earliest reliable registration data. Also selects the production period for volume/units."
+                }
+              ]
+            }
+          },
+          {
+            "description": "Window start, inclusive (YYYY-MM-DD). Overrides `period`.",
+            "in": "query",
+            "name": "from",
+            "required": false,
+            "schema": {
+              "description": "Window start, inclusive (YYYY-MM-DD). Overrides `period`.",
+              "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+              "type": "string"
+            }
+          },
+          {
+            "description": "Window end, inclusive (YYYY-MM-DD). Overrides `period`.",
+            "in": "query",
+            "name": "to",
+            "required": false,
+            "schema": {
+              "description": "Window end, inclusive (YYYY-MM-DD). Overrides `period`.",
+              "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CompanyDepartureStatusResponse"
+                }
+              }
+            },
+            "description": "Exits working elsewhere vs not working"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Validation error"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Unauthorized"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Not found"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PayloadTooLarge"
+                }
+              }
+            },
+            "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailable"
+                }
+              }
+            },
+            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+          }
+        },
+        "summary": "How many of a company's exits work elsewhere today",
+        "tags": [
+          "Companies"
+        ]
+      }
+    },
     "/v1/companies/{nmlsId}/early-exits": {
       "get": {
         "operationId": "companyEarlyExits",
@@ -57141,6 +57372,160 @@
         ]
       }
     },
+    "/v1/companies/{nmlsId}/mover-production": {
+      "get": {
+        "description": "The window's hires and complete departures, each side's combined production across ALL employers recorded inside the production window (default: the same window). Pass a prior window's movers with the current production window to see how past hires and exits perform now.",
+        "operationId": "companyMoverProduction",
+        "parameters": [
+          {
+            "description": "Company NMLS ID",
+            "in": "path",
+            "name": "nmlsId",
+            "required": true,
+            "schema": {
+              "description": "Company NMLS ID",
+              "type": "string"
+            }
+          },
+          {
+            "description": "Preset window when `from`/`to` are not given (default `last12Months`). Rolling periods start on the FIRST day of the month N months back and end today; a year is Jan 1 – Dec 31; `allTime` starts 2017-01-01, the earliest reliable registration data. Also selects the production period for volume/units.",
+            "in": "query",
+            "name": "period",
+            "required": false,
+            "schema": {
+              "allOf": [
+                {
+                  "$ref": "#/components/schemas/Period"
+                },
+                {
+                  "description": "Preset window when `from`/`to` are not given (default `last12Months`). Rolling periods start on the FIRST day of the month N months back and end today; a year is Jan 1 – Dec 31; `allTime` starts 2017-01-01, the earliest reliable registration data. Also selects the production period for volume/units."
+                }
+              ]
+            }
+          },
+          {
+            "description": "Window start, inclusive (YYYY-MM-DD). Overrides `period`.",
+            "in": "query",
+            "name": "from",
+            "required": false,
+            "schema": {
+              "description": "Window start, inclusive (YYYY-MM-DD). Overrides `period`.",
+              "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+              "type": "string"
+            }
+          },
+          {
+            "description": "Window end, inclusive (YYYY-MM-DD). Overrides `period`.",
+            "in": "query",
+            "name": "to",
+            "required": false,
+            "schema": {
+              "description": "Window end, inclusive (YYYY-MM-DD). Overrides `period`.",
+              "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+              "type": "string"
+            }
+          },
+          {
+            "description": "Production window start, inclusive (YYYY-MM-DD). Defaults to the mover window's start.",
+            "in": "query",
+            "name": "productionFrom",
+            "required": false,
+            "schema": {
+              "description": "Production window start, inclusive (YYYY-MM-DD). Defaults to the mover window's start.",
+              "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+              "type": "string"
+            }
+          },
+          {
+            "description": "Production window end, inclusive (YYYY-MM-DD). Defaults to the mover window's end.",
+            "in": "query",
+            "name": "productionTo",
+            "required": false,
+            "schema": {
+              "description": "Production window end, inclusive (YYYY-MM-DD). Defaults to the mover window's end.",
+              "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CompanyMoverProductionResponse"
+                }
+              }
+            },
+            "description": "Hires' and exits' production"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Validation error"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Unauthorized"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Not found"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PayloadTooLarge"
+                }
+              }
+            },
+            "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailable"
+                }
+              }
+            },
+            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+          }
+        },
+        "summary": "Combined production of a company's hires and exits",
+        "tags": [
+          "Companies"
+        ]
+      }
+    },
     "/v1/companies/{nmlsId}/sponsored-individuals": {
       "post": {
         "operationId": "companySponsoredIndividuals",
@@ -77430,6 +77815,109 @@
         ]
       }
     },
+    "/v1/originators/{nmlsId}/breakdowns/builders": {
+      "post": {
+        "description": "Ranks the home builders behind this LO's new-construction loans, by volume. A loan counts when `originatorLoans` with `flatFilters.hasBuilder: true` keeps it, and is credited to the `builderName` that list shows on its row (the parcel's newest builder-named sale, else the builder named on the loan or its builder seller of record) — so a row's `units` equals that list filtered to the builder. Spellings that differ only in case, spacing or punctuation are one row; `id` is that normalized key and `label` the most common spelling. Percentages are shares of the LO's whole loan population in scope, so rows do not sum to 100. More than 50,000 loans in scope is a 400 (narrow the period); `truncated` is set when the builder loans exceed that cap.",
+        "operationId": "originatorBuilders",
+        "parameters": [
+          {
+            "description": "Originator NMLS ID",
+            "in": "path",
+            "name": "nmlsId",
+            "required": true,
+            "schema": {
+              "description": "Originator NMLS ID",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/BreakdownRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BreakdownResponse"
+                }
+              }
+            },
+            "description": "Breakdown of the LO's builder loans by home builder"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Validation error"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Unauthorized"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Not found"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PayloadTooLarge"
+                }
+              }
+            },
+            "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailable"
+                }
+              }
+            },
+            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+          }
+        },
+        "summary": "Home builders on this LO's new-construction loans",
+        "tags": [
+          "Originators"
+        ]
+      }
+    },
     "/v1/originators/{nmlsId}/breakdowns/cities": {
       "post": {
         "operationId": "originatorCitiesBreakdown",

package/package.json

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