@model-match/api 3.34.0 → 3.36.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.
@@ -1,4 +1,4 @@
1
- import { n as createClient, w as client } from "../src-BERwJQdR.mjs";
1
+ import { n as createClient, w as client } from "../src-CyZ7CTVN.mjs";
2
2
  //#region src/slim/sdk.gen.ts
3
3
  /**
4
4
  * An LO's sponsorship / registration links (admin)
@@ -18,44 +18,6 @@ const adminGetCadLinks = (options) => {
18
18
  });
19
19
  };
20
20
  /**
21
- * Launch the NMLS loader (admin)
22
- * Starts the `load-cad` ECS task and returns its id. Poll `GET /v1/admin/cad/load/{taskId}`. The load writes the licensing database only; run `index-cad` afterwards (or pass `reindex: true`) to publish it.
23
- */
24
- const adminLaunchCadLoad = (options) => {
25
- return (options.client ?? client).post({
26
- security: [{
27
- name: "x-api-key",
28
- type: "apiKey"
29
- }, {
30
- scheme: "bearer",
31
- type: "http"
32
- }],
33
- url: "/v1/admin/cad/load",
34
- ...options,
35
- headers: {
36
- "Content-Type": "application/json",
37
- ...options?.headers
38
- }
39
- });
40
- };
41
- /**
42
- * Status of a loader task (admin)
43
- * ECS lifecycle of a `load-cad` task. `succeeded` = exited 0 (load completed or paused); `failed` = any other stop. Per-file progress is in the task logs and the load bookkeeping tables.
44
- */
45
- const adminGetCadLoadTask = (options) => {
46
- return (options.client ?? client).get({
47
- security: [{
48
- name: "x-api-key",
49
- type: "apiKey"
50
- }, {
51
- scheme: "bearer",
52
- type: "http"
53
- }],
54
- url: "/v1/admin/cad/load/{taskId}",
55
- ...options
56
- });
57
- };
58
- /**
59
21
  * Get a bulk job and a signed download URL (admin)
60
22
  * Returns any org's bulk job (delivery or enrichment) with a freshly signed download URL for its result file. Cross-org: signs against the job's own stored org. `resultsUrl` is null until the job is completed.
61
23
  */
@@ -6210,4 +6172,4 @@ const getSearchToken = (options) => {
6210
6172
  });
6211
6173
  };
6212
6174
  //#endregion
6213
- export { client as _heyApiClient, actionCrmCallerId, addCrmContactMethod, addCrmListMember, addCrmListMembersBulk, addCrmNote, addCrmRecord, addCrmRecordsBulk, addWatchedAgent, addWatchedArea, addWatchedDocument, adminGetBulkJob, adminGetCadLinks, adminGetCadLoadTask, adminLaunchCadLoad, agentAnalyticsChart, agentAnalyticsSummary, agentAnalyticsTimeSeries, agentBuilders, agentCities, agentCompanies, agentCounties, agentLenders, agentLoanMix, agentMarkets, agentMortgagedTimeSeries, agentOffices, agentOriginators, agentProperties, agentRelated, agentSales, agentStates, agentTitleCompanies, agentTitleCompaniesTimeSeries, agentZipCodes, analyzeCrmCall, applyCrmEnrichment, applyCrmListTemplate, applyCrmMiUpdates, branchAnalyticsChart, branchAnalyticsSummary, branchAnalyticsTimeSeries, branchCities, branchCounties, branchLenders, branchLoans, branchOriginators, branchRoster, branchStates, branchTitleCompanies, cancelAgentsBulkDeliveryJob, cancelBranchesBulkDeliveryJob, cancelCompaniesBulkDeliveryJob, cancelEnrichBulkJob, cancelLoansBulkDeliveryJob, cancelOriginatorsBulkDeliveryJob, cancelPropertiesBulkDeliveryJob, companyAgents, companyAnalyticsChart, companyAnalyticsSummary, companyAnalyticsTimeSeries, companyBranches, companyBrokers, companyCities, companyCounties, companyEarlyExits, companyEmployeeStats, companyEmployment, companyHeadcount, companyLenders, companyMarkets, companyOffices, companyOriginators, companyRelated, companySponsoredIndividuals, companySponsorshipMovement, companyStates, companyTalentFlow, companyTitleCompanies, companyZipCodes, countAgents, countBranches, countCompanies, countLenders, countLoans, countOffices, countOriginators, countProperties, countSales, createAlertSubscription, createClient, createCrmList, createCrmListField, createCrmManualRecord, createCrmMeeting, createCrmObjectField, createCrmRecord, createCrmTask, createCrmTemplate, createMyAlertRecipe, createSavedFilter, crmLenderChannels, crmLoLoanMix, crmLoMomentum, crmLoSponsorLocation, crmSimilarOriginators, declineCrmMiUpdate, deleteAlertSubscription, deleteCrmCallerId, deleteCrmList, deleteCrmListField, deleteCrmMeeting, deleteCrmNote, deleteCrmObjectField, deleteCrmRecord, deleteCrmRecords, deleteCrmTask, deleteCrmTemplate, deleteMyAlertRecipe, deleteSavedFilter, describeCrmRecordsOnAdd, dismissCrmMiUpdates, editCrmLoggedActivity, editCrmNote, enrichPropertiesBatch, enrichPropertiesBulk, enrichProperty, filterCrmListMembers, findCrmRecordByNmls, generateCrmRecordDescription, getAgent, getAgentsBulkDeliveryJob, getAlertConditions, getAlertEmailTokens, getAlertUnreadCount, getBranch, getBranchesBulkDeliveryJob, getCompaniesBulkDeliveryJob, getCompany, getCrmActiveCall, getCrmActivityReport, getCrmCall, getCrmCallTranscript, getCrmCustomValues, getCrmImportJob, getCrmList, getCrmListMemberIds, getCrmListShares, getCrmMiUpdates, getCrmOutcomesReport, getCrmOverrides, getCrmProductionEnrichJob, getCrmRecordAccess, getCrmRecordAccessRequest, getCrmRecordConnections, getCrmRecordMemberIds, getCrmRecordProfile, getCrmTemplate, getCrmTemplateShares, getEnrichBulkJob, getHubspotPushStatus, getLender, getLoan, getLoansBulkDeliveryJob, getMe, getMeCredits, getMePlan, getOffice, getOriginator, getOriginatorsBulkDeliveryJob, getPropertiesBulkDeliveryJob, getProperty, getRealtimeConfig, getSale, getSavedFilter, getSearchToken, grantCrmListAccess, grantCrmRecordAccess, grantCrmRecordAccessRequest, hangupCrmCall, importCrmRecords, instantSearch, lenderCities, lenderCompanies, lenderCounties, lenderOriginators, lenderStates, linkCrmRecord, listAgents, listAlertDigests, listAlertLog, listAlertRecipes, listAlertSubscriptions, listBranches, listCompanies, listCrmActivity, listCrmCallerIds, listCrmCustomFields, listCrmListAssignees, listCrmListFields, listCrmListMemberships, listCrmListShareableMembers, listCrmLists, listCrmMeetings, listCrmMembers, listCrmOrgMembers, listCrmRecordShareableMembers, listCrmRecordShares, listCrmReferencedActivity, listCrmTasks, listCrmTemplates, listCrmWorkspaceMeetings, listCrmWorkspaceTasks, listEnrichments, listLenders, listLoans, listMarket, listMyAlertRecipes, listOffices, listOriginators, listProperties, listSales, listSavedFilters, listWatchedAgents, listWatchedAreas, listWatchedDocuments, loanRelated, loansAnalyticsChart, loansAnalyticsSummary, loansAnalyticsTimeSeries, logCrmActivity, lookupCompanies, markAlertDigestRead, markAlertRead, markAllAlertsRead, marketAnalyticsChart, marketAnalyticsSummary, marketAnalyticsTimeSeries, marketCommunityLending, marketMovementActivity, marketMovementByState, marketMovementCohortPayoff, marketMovementMostGained, marketMovementMostLost, marketMovementMovers, marketMovementRankings, marketMovementStats, marketMovementTransitions, officeAgents, originatorAgents, originatorAnalyticsChart, originatorAnalyticsSummary, originatorAnalyticsTimeSeries, originatorBranches, originatorBrokers, originatorCitiesBreakdown, originatorCompanies, originatorCountiesBreakdown, originatorLenders, originatorLoans, originatorMarkets, originatorOffices, originatorProperties, originatorRelated, originatorStatesBreakdown, originatorTitleCompanies, originatorZipCodes, placeCrmCall, previewAlertEmailTemplate, previewAlertRecipe, previewAlerts, previewMyAlertRecipe, propertiesAnalyticsChart, propertiesAnalyticsSummary, propertyRelated, pushToHubspot, reconcileCrmMeetings, refreshCrmRecordMirror, removeCrmContactMethod, removeCrmListMember, removeWatchedAgent, removeWatchedArea, removeWatchedDocument, requestCrmAccess, requestCrmRecordAccess, retrieveLocation, revokeCrmListAccess, revokeCrmRecordAccess, saleRelated, salesAnalyticsChart, salesAnalyticsSummary, salesAnalyticsTimeSeries, searchCrmEmailRecipients, searchCrmMatchCandidates, searchCrmMentionRecords, searchCrmRecords, searchProperties, sendCrmEmail, setCrmCallAnalysis, setCrmCustomValue, setCrmOverride, setCrmRecordOwner, setDefaultCrmCallerId, shareCrmTemplate, submitAgentsBulkDelivery, submitBranchesBulkDelivery, submitCompaniesBulkDelivery, submitLoansBulkDelivery, submitOriginatorsBulkDelivery, submitPropertiesBulkDelivery, subscribeAlertRecipe, suggestLocations, transcribeCrmCall, transferCrmListOwnership, unshareCrmTemplate, unsubscribeAlertRecipe, updateAlertConditions, updateCrmContactMethod, updateCrmList, updateCrmListField, updateCrmMeeting, updateCrmObjectField, updateCrmTask, updateCrmTemplate, updateMe, updateMyAlertRecipe, updateSavedFilter };
6175
+ export { client as _heyApiClient, actionCrmCallerId, addCrmContactMethod, addCrmListMember, addCrmListMembersBulk, addCrmNote, addCrmRecord, addCrmRecordsBulk, addWatchedAgent, addWatchedArea, addWatchedDocument, adminGetBulkJob, adminGetCadLinks, agentAnalyticsChart, agentAnalyticsSummary, agentAnalyticsTimeSeries, agentBuilders, agentCities, agentCompanies, agentCounties, agentLenders, agentLoanMix, agentMarkets, agentMortgagedTimeSeries, agentOffices, agentOriginators, agentProperties, agentRelated, agentSales, agentStates, agentTitleCompanies, agentTitleCompaniesTimeSeries, agentZipCodes, analyzeCrmCall, applyCrmEnrichment, applyCrmListTemplate, applyCrmMiUpdates, branchAnalyticsChart, branchAnalyticsSummary, branchAnalyticsTimeSeries, branchCities, branchCounties, branchLenders, branchLoans, branchOriginators, branchRoster, branchStates, branchTitleCompanies, cancelAgentsBulkDeliveryJob, cancelBranchesBulkDeliveryJob, cancelCompaniesBulkDeliveryJob, cancelEnrichBulkJob, cancelLoansBulkDeliveryJob, cancelOriginatorsBulkDeliveryJob, cancelPropertiesBulkDeliveryJob, companyAgents, companyAnalyticsChart, companyAnalyticsSummary, companyAnalyticsTimeSeries, companyBranches, companyBrokers, companyCities, companyCounties, companyEarlyExits, companyEmployeeStats, companyEmployment, companyHeadcount, companyLenders, companyMarkets, companyOffices, companyOriginators, companyRelated, companySponsoredIndividuals, companySponsorshipMovement, companyStates, companyTalentFlow, companyTitleCompanies, companyZipCodes, countAgents, countBranches, countCompanies, countLenders, countLoans, countOffices, countOriginators, countProperties, countSales, createAlertSubscription, createClient, createCrmList, createCrmListField, createCrmManualRecord, createCrmMeeting, createCrmObjectField, createCrmRecord, createCrmTask, createCrmTemplate, createMyAlertRecipe, createSavedFilter, crmLenderChannels, crmLoLoanMix, crmLoMomentum, crmLoSponsorLocation, crmSimilarOriginators, declineCrmMiUpdate, deleteAlertSubscription, deleteCrmCallerId, deleteCrmList, deleteCrmListField, deleteCrmMeeting, deleteCrmNote, deleteCrmObjectField, deleteCrmRecord, deleteCrmRecords, deleteCrmTask, deleteCrmTemplate, deleteMyAlertRecipe, deleteSavedFilter, describeCrmRecordsOnAdd, dismissCrmMiUpdates, editCrmLoggedActivity, editCrmNote, enrichPropertiesBatch, enrichPropertiesBulk, enrichProperty, filterCrmListMembers, findCrmRecordByNmls, generateCrmRecordDescription, getAgent, getAgentsBulkDeliveryJob, getAlertConditions, getAlertEmailTokens, getAlertUnreadCount, getBranch, getBranchesBulkDeliveryJob, getCompaniesBulkDeliveryJob, getCompany, getCrmActiveCall, getCrmActivityReport, getCrmCall, getCrmCallTranscript, getCrmCustomValues, getCrmImportJob, getCrmList, getCrmListMemberIds, getCrmListShares, getCrmMiUpdates, getCrmOutcomesReport, getCrmOverrides, getCrmProductionEnrichJob, getCrmRecordAccess, getCrmRecordAccessRequest, getCrmRecordConnections, getCrmRecordMemberIds, getCrmRecordProfile, getCrmTemplate, getCrmTemplateShares, getEnrichBulkJob, getHubspotPushStatus, getLender, getLoan, getLoansBulkDeliveryJob, getMe, getMeCredits, getMePlan, getOffice, getOriginator, getOriginatorsBulkDeliveryJob, getPropertiesBulkDeliveryJob, getProperty, getRealtimeConfig, getSale, getSavedFilter, getSearchToken, grantCrmListAccess, grantCrmRecordAccess, grantCrmRecordAccessRequest, hangupCrmCall, importCrmRecords, instantSearch, lenderCities, lenderCompanies, lenderCounties, lenderOriginators, lenderStates, linkCrmRecord, listAgents, listAlertDigests, listAlertLog, listAlertRecipes, listAlertSubscriptions, listBranches, listCompanies, listCrmActivity, listCrmCallerIds, listCrmCustomFields, listCrmListAssignees, listCrmListFields, listCrmListMemberships, listCrmListShareableMembers, listCrmLists, listCrmMeetings, listCrmMembers, listCrmOrgMembers, listCrmRecordShareableMembers, listCrmRecordShares, listCrmReferencedActivity, listCrmTasks, listCrmTemplates, listCrmWorkspaceMeetings, listCrmWorkspaceTasks, listEnrichments, listLenders, listLoans, listMarket, listMyAlertRecipes, listOffices, listOriginators, listProperties, listSales, listSavedFilters, listWatchedAgents, listWatchedAreas, listWatchedDocuments, loanRelated, loansAnalyticsChart, loansAnalyticsSummary, loansAnalyticsTimeSeries, logCrmActivity, lookupCompanies, markAlertDigestRead, markAlertRead, markAllAlertsRead, marketAnalyticsChart, marketAnalyticsSummary, marketAnalyticsTimeSeries, marketCommunityLending, marketMovementActivity, marketMovementByState, marketMovementCohortPayoff, marketMovementMostGained, marketMovementMostLost, marketMovementMovers, marketMovementRankings, marketMovementStats, marketMovementTransitions, officeAgents, originatorAgents, originatorAnalyticsChart, originatorAnalyticsSummary, originatorAnalyticsTimeSeries, originatorBranches, originatorBrokers, originatorCitiesBreakdown, originatorCompanies, originatorCountiesBreakdown, originatorLenders, originatorLoans, originatorMarkets, originatorOffices, originatorProperties, originatorRelated, originatorStatesBreakdown, originatorTitleCompanies, originatorZipCodes, placeCrmCall, previewAlertEmailTemplate, previewAlertRecipe, previewAlerts, previewMyAlertRecipe, propertiesAnalyticsChart, propertiesAnalyticsSummary, propertyRelated, pushToHubspot, reconcileCrmMeetings, refreshCrmRecordMirror, removeCrmContactMethod, removeCrmListMember, removeWatchedAgent, removeWatchedArea, removeWatchedDocument, requestCrmAccess, requestCrmRecordAccess, retrieveLocation, revokeCrmListAccess, revokeCrmRecordAccess, saleRelated, salesAnalyticsChart, salesAnalyticsSummary, salesAnalyticsTimeSeries, searchCrmEmailRecipients, searchCrmMatchCandidates, searchCrmMentionRecords, searchCrmRecords, searchProperties, sendCrmEmail, setCrmCallAnalysis, setCrmCustomValue, setCrmOverride, setCrmRecordOwner, setDefaultCrmCallerId, shareCrmTemplate, submitAgentsBulkDelivery, submitBranchesBulkDelivery, submitCompaniesBulkDelivery, submitLoansBulkDelivery, submitOriginatorsBulkDelivery, submitPropertiesBulkDelivery, subscribeAlertRecipe, suggestLocations, transcribeCrmCall, transferCrmListOwnership, unshareCrmTemplate, unsubscribeAlertRecipe, updateAlertConditions, updateCrmContactMethod, updateCrmList, updateCrmListField, updateCrmMeeting, updateCrmObjectField, updateCrmTask, updateCrmTemplate, updateMe, updateMyAlertRecipe, updateSavedFilter };
@@ -28,44 +28,6 @@ var AdminNmls = class {
28
28
  ...options
29
29
  });
30
30
  }
31
- /**
32
- * Launch the NMLS loader (admin)
33
- * Starts the `load-cad` ECS task and returns its id. Poll `GET /v1/admin/cad/load/{taskId}`. The load writes the licensing database only; run `index-cad` afterwards (or pass `reindex: true`) to publish it.
34
- */
35
- static adminLaunchCadLoad(options) {
36
- return (options.client ?? client).post({
37
- security: [{
38
- name: "x-api-key",
39
- type: "apiKey"
40
- }, {
41
- scheme: "bearer",
42
- type: "http"
43
- }],
44
- url: "/v1/admin/cad/load",
45
- ...options,
46
- headers: {
47
- "Content-Type": "application/json",
48
- ...options?.headers
49
- }
50
- });
51
- }
52
- /**
53
- * Status of a loader task (admin)
54
- * ECS lifecycle of a `load-cad` task. `succeeded` = exited 0 (load completed or paused); `failed` = any other stop. Per-file progress is in the task logs and the load bookkeeping tables.
55
- */
56
- static adminGetCadLoadTask(options) {
57
- return (options.client ?? client).get({
58
- security: [{
59
- name: "x-api-key",
60
- type: "apiKey"
61
- }, {
62
- scheme: "bearer",
63
- type: "http"
64
- }],
65
- url: "/v1/admin/cad/load/{taskId}",
66
- ...options
67
- });
68
- }
69
31
  };
70
32
  var AdminJobs = class {
71
33
  /**
package/openapi.json CHANGED
@@ -2366,125 +2366,6 @@
2366
2366
  ],
2367
2367
  "type": "object"
2368
2368
  },
2369
- "AdminCadLoadLaunch": {
2370
- "properties": {
2371
- "payload": {
2372
- "additionalProperties": {
2373
- "nullable": true
2374
- },
2375
- "type": "object"
2376
- },
2377
- "taskArn": {
2378
- "type": "string"
2379
- },
2380
- "taskId": {
2381
- "type": "string"
2382
- }
2383
- },
2384
- "required": [
2385
- "taskId",
2386
- "taskArn",
2387
- "payload"
2388
- ],
2389
- "type": "object"
2390
- },
2391
- "AdminCadLoadRequest": {
2392
- "properties": {
2393
- "bucket": {
2394
- "description": "Source bucket (default `nmls-raw-data`).",
2395
- "minLength": 1,
2396
- "type": "string"
2397
- },
2398
- "loadType": {
2399
- "description": "`sample` loads only the first file. Default `full`.",
2400
- "enum": [
2401
- "full",
2402
- "sample"
2403
- ],
2404
- "type": "string"
2405
- },
2406
- "prefix": {
2407
- "description": "S3 prefix of one month's NMLS file set. Required unless resuming.",
2408
- "example": "consumer-access/2026/ConsumerAccess_nmlsb2bfiles_Sep2026/",
2409
- "minLength": 1,
2410
- "type": "string"
2411
- },
2412
- "reindex": {
2413
- "description": "Launch a full `index-cad` run when the load completes.",
2414
- "type": "boolean"
2415
- },
2416
- "restartFromFile": {
2417
- "description": "With `resumeLoadId`: reset this file (e.g. `Branch.csv`) and every later one first.",
2418
- "minLength": 1,
2419
- "type": "string"
2420
- },
2421
- "resumeLoadId": {
2422
- "description": "Resume an existing load by its id (resets stuck/failed files).",
2423
- "minLength": 1,
2424
- "type": "string"
2425
- }
2426
- },
2427
- "type": "object"
2428
- },
2429
- "AdminCadLoadTaskStatus": {
2430
- "properties": {
2431
- "createdAt": {
2432
- "nullable": true,
2433
- "type": "string"
2434
- },
2435
- "desiredStatus": {
2436
- "nullable": true,
2437
- "type": "string"
2438
- },
2439
- "exitCode": {
2440
- "nullable": true,
2441
- "type": "number"
2442
- },
2443
- "lastStatus": {
2444
- "type": "string"
2445
- },
2446
- "startedAt": {
2447
- "nullable": true,
2448
- "type": "string"
2449
- },
2450
- "state": {
2451
- "enum": [
2452
- "pending",
2453
- "running",
2454
- "succeeded",
2455
- "failed"
2456
- ],
2457
- "type": "string"
2458
- },
2459
- "stoppedAt": {
2460
- "nullable": true,
2461
- "type": "string"
2462
- },
2463
- "stoppedReason": {
2464
- "nullable": true,
2465
- "type": "string"
2466
- },
2467
- "taskArn": {
2468
- "type": "string"
2469
- },
2470
- "taskId": {
2471
- "type": "string"
2472
- }
2473
- },
2474
- "required": [
2475
- "taskId",
2476
- "taskArn",
2477
- "state",
2478
- "lastStatus",
2479
- "desiredStatus",
2480
- "exitCode",
2481
- "stoppedReason",
2482
- "createdAt",
2483
- "startedAt",
2484
- "stoppedAt"
2485
- ],
2486
- "type": "object"
2487
- },
2488
2369
  "AdminCreateAlertRecipeRequest": {
2489
2370
  "description": "A recipe definition. Created as a draft; publish it to show it to users.",
2490
2371
  "properties": {
@@ -4170,7 +4051,7 @@
4170
4051
  "type": "boolean"
4171
4052
  },
4172
4053
  "hasBuilder": {
4173
- "description": "`true`: new-construction sales with a builder named.",
4054
+ "description": "`true`: new construction — the sale or its purchase loan names a builder (or a builder seller).",
4174
4055
  "type": "boolean"
4175
4056
  },
4176
4057
  "loan": {
@@ -18385,7 +18266,7 @@
18385
18266
  "nullable": true
18386
18267
  }
18387
18268
  ],
18388
- "description": "Registered business address METRO AREA (MSA / CBSA) — companies headquartered in ANY county of the metro (the address point inside the boundary of a member county, as for `county`); under `locationBasis: \"production\"`, companies that produced loans in it. 5-digit CBSA code (`12420`) or metro name (`Austin Metro`); an array matches any. Top-50 metros use the Model Match app's county lists, the rest OMB 2023. Unknown/ambiguous names are a 400 naming candidates."
18269
+ "description": "Registered business address METRO AREA (MSA / CBSA) — companies headquartered in ANY county of the metro (the address point inside the boundary of a member county, as for `county`); under `locationBasis: \"production\"`, companies that produced loans in it. 5-digit CBSA code (`12420`) or metro name (`Austin Metro`); an array matches any. Member counties per the OMB July-2023 delineation (Connecticut's pre-2022 counties included; `41860` San Francisco Bay Area is the nine-county Bay Area). Unknown/ambiguous names are a 400 naming candidates."
18389
18270
  },
18390
18271
  "CompanyProductMixFilter": {
18391
18272
  "description": "Loan-product share / volume bands for the selected period, ANDed: `[{product:\"fha\", minShare:30}]` = FHA is at least 30% of the company's period volume; `[{product:\"va\", volume:{gte:5000000}}]` = at least $5M of VA. `products` lets ANY of several types satisfy one entry. Whole-book figures across all markets.",
@@ -29158,10 +29039,6 @@
29158
29039
  "listAgent": {
29159
29040
  "nullable": true
29160
29041
  },
29161
- "loanTermMonths": {
29162
- "nullable": true,
29163
- "type": "number"
29164
- },
29165
29042
  "ltv": {
29166
29043
  "nullable": true,
29167
29044
  "type": "number"
@@ -29219,6 +29096,22 @@
29219
29096
  "flatFilters": {
29220
29097
  "additionalProperties": false,
29221
29098
  "properties": {
29099
+ "agentId": {
29100
+ "description": "Loans crediting this agent (`GET /v1/agents/{id}`) — the rows' `*AgentId`; see `agentRole`. ≤ 10,000 candidate loans in scope (else 400).",
29101
+ "minLength": 1,
29102
+ "type": "string"
29103
+ },
29104
+ "agentRole": {
29105
+ "description": "`agentId`'s role: `sold`, `list`, `coList`, `listing` (list or co-list), `any` (default).",
29106
+ "enum": [
29107
+ "any",
29108
+ "sold",
29109
+ "list",
29110
+ "coList",
29111
+ "listing"
29112
+ ],
29113
+ "type": "string"
29114
+ },
29222
29115
  "borrowerStatus": {
29223
29116
  "$ref": "#/components/schemas/LoanBorrowerStatusFilterValue"
29224
29117
  },
@@ -29238,6 +29131,12 @@
29238
29131
  "city": {
29239
29132
  "$ref": "#/components/schemas/TextFilterValue"
29240
29133
  },
29134
+ "coListAgentName": {
29135
+ "description": "Co-listing agent name.",
29136
+ "maxLength": 100,
29137
+ "minLength": 1,
29138
+ "type": "string"
29139
+ },
29241
29140
  "conforming": {
29242
29141
  "$ref": "#/components/schemas/BooleanFilterValue"
29243
29142
  },
@@ -29364,8 +29263,22 @@
29364
29263
  "geoPoint": {
29365
29264
  "$ref": "#/components/schemas/GeoFilterValue"
29366
29265
  },
29266
+ "hasAgent": {
29267
+ "description": "Roles that must have an agent: `sold` (buyer's), `list`, `coList`; `any` = at least one.",
29268
+ "items": {
29269
+ "enum": [
29270
+ "any",
29271
+ "sold",
29272
+ "list",
29273
+ "coList"
29274
+ ],
29275
+ "type": "string"
29276
+ },
29277
+ "minItems": 1,
29278
+ "type": "array"
29279
+ },
29367
29280
  "hasBuilder": {
29368
- "description": "`true`: loans on a new-construction property — one with a sale that names a builder. `false`: the rest. Needs a scope of ≤ 50,000 loans (else 400).",
29281
+ "description": "`true`: new construction — a sale of the property names a builder, or the loan names a builder or a builder seller of record. `false`: the rest. Needs a scope of ≤ 50,000 loans (else 400).",
29369
29282
  "type": "boolean"
29370
29283
  },
29371
29284
  "homeValue": {
@@ -29411,6 +29324,12 @@
29411
29324
  }
29412
29325
  ]
29413
29326
  },
29327
+ "listAgentName": {
29328
+ "description": "Listing agent name.",
29329
+ "maxLength": 100,
29330
+ "minLength": 1,
29331
+ "type": "string"
29332
+ },
29414
29333
  "loanCompany": {
29415
29334
  "allOf": [
29416
29335
  {
@@ -29484,6 +29403,18 @@
29484
29403
  "salePrice": {
29485
29404
  "$ref": "#/components/schemas/NumericFilterValue"
29486
29405
  },
29406
+ "search": {
29407
+ "description": "Every word starts a word of the address (street, city, state, ZIP), the lender name or an agent name (\"12 oak\", \"jane sm\").",
29408
+ "maxLength": 100,
29409
+ "minLength": 1,
29410
+ "type": "string"
29411
+ },
29412
+ "soldAgentName": {
29413
+ "description": "Buyer's agent: every word starts a word of the MLS name or the linked agent's name. Likewise `listAgentName`, `coListAgentName`.",
29414
+ "maxLength": 100,
29415
+ "minLength": 1,
29416
+ "type": "string"
29417
+ },
29487
29418
  "state": {
29488
29419
  "$ref": "#/components/schemas/TextFilterValue"
29489
29420
  },
@@ -29538,7 +29469,14 @@
29538
29469
  "equity",
29539
29470
  "homeValue",
29540
29471
  "ltvAtOrigination",
29541
- "currentBalance"
29472
+ "currentBalance",
29473
+ "streetAddress",
29474
+ "listPrice",
29475
+ "employerName",
29476
+ "brokerName",
29477
+ "soldAgentName",
29478
+ "listAgentName",
29479
+ "coListAgentName"
29542
29480
  ],
29543
29481
  "type": "string"
29544
29482
  },
@@ -29583,6 +29521,10 @@
29583
29521
  },
29584
29522
  "total": {
29585
29523
  "type": "number"
29524
+ },
29525
+ "truncated": {
29526
+ "description": "Row sorts only: more than 10,000 loans matched; the newest 10,000 were sorted and `total` counts them.",
29527
+ "type": "boolean"
29586
29528
  }
29587
29529
  },
29588
29530
  "required": [
@@ -29669,6 +29611,11 @@
29669
29611
  "nullable": true,
29670
29612
  "type": "string"
29671
29613
  },
29614
+ "builderName": {
29615
+ "description": "Builder named on a sale of this property (new construction); the `hasBuilder` predicate.",
29616
+ "nullable": true,
29617
+ "type": "string"
29618
+ },
29672
29619
  "buyer1FirstMiddle": {
29673
29620
  "description": "First buyer's first + middle name (an entity's whole name, with no last).",
29674
29621
  "nullable": true,
@@ -29693,6 +29640,11 @@
29693
29640
  "nullable": true,
29694
29641
  "type": "string"
29695
29642
  },
29643
+ "coListAgentId": {
29644
+ "description": "Co-listing agent id, same rule.",
29645
+ "nullable": true,
29646
+ "type": "string"
29647
+ },
29696
29648
  "coListAgentName": {
29697
29649
  "description": "Co-listing agent: the agent record's name when the MLS keys resolve to one agent, else as the MLS recorded it.",
29698
29650
  "nullable": true,
@@ -29747,10 +29699,20 @@
29747
29699
  "nullable": true,
29748
29700
  "type": "number"
29749
29701
  },
29702
+ "lenderId": {
29703
+ "description": "Normalized lender id — the value the `lender` filter takes.",
29704
+ "nullable": true,
29705
+ "type": "string"
29706
+ },
29750
29707
  "lenderName": {
29751
29708
  "nullable": true,
29752
29709
  "type": "string"
29753
29710
  },
29711
+ "listAgentId": {
29712
+ "description": "Listing agent id, same rule.",
29713
+ "nullable": true,
29714
+ "type": "string"
29715
+ },
29754
29716
  "listAgentName": {
29755
29717
  "description": "Listing agent: the agent record's name when the MLS keys resolve to one agent, else as the MLS recorded it.",
29756
29718
  "nullable": true,
@@ -29760,6 +29722,10 @@
29760
29722
  "nullable": true,
29761
29723
  "type": "number"
29762
29724
  },
29725
+ "loanTermMonths": {
29726
+ "nullable": true,
29727
+ "type": "number"
29728
+ },
29763
29729
  "loanType": {
29764
29730
  "nullable": true,
29765
29731
  "type": "string"
@@ -29818,6 +29784,11 @@
29818
29784
  "nullable": true,
29819
29785
  "type": "string"
29820
29786
  },
29787
+ "soldAgentId": {
29788
+ "description": "Buyer's agent id (`GET /v1/agents/{id}`) when the MLS keys resolve to one agent.",
29789
+ "nullable": true,
29790
+ "type": "string"
29791
+ },
29821
29792
  "soldAgentName": {
29822
29793
  "description": "Buyer's agent: the agent record's name when the loan's MLS agent keys resolve to one agent, else as the MLS recorded it; lowercase.",
29823
29794
  "nullable": true,
@@ -36805,7 +36776,7 @@
36805
36776
  "nullable": true
36806
36777
  }
36807
36778
  ],
36808
- "description": "Production METRO AREA (MSA / CBSA): originators who originated loans in ANY county of the metro during the selected period (not office). 5-digit CBSA code (`12420`) or metro name (`Austin Metro`); an array matches any. Top-50 metros use the Model Match app's county lists, the rest OMB 2023. Unknown/ambiguous names are a 400 naming candidates."
36779
+ "description": "Production METRO AREA (MSA / CBSA): originators who originated loans in ANY county of the metro during the selected period (not office). 5-digit CBSA code (`12420`) or metro name (`Austin Metro`); an array matches any. Member counties per the OMB July-2023 delineation (Connecticut's pre-2022 counties included; `41860` San Francisco Bay Area is the nine-county Bay Area). Unknown/ambiguous names are a 400 naming candidates."
36809
36780
  },
36810
36781
  "OriginatorOfficeGeoPoint": {
36811
36782
  "additionalProperties": false,
@@ -43435,7 +43406,7 @@
43435
43406
  "info": {
43436
43407
  "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.",
43437
43408
  "title": "ModelMatch API",
43438
- "version": "3.86.0"
43409
+ "version": "3.88.0"
43439
43410
  },
43440
43411
  "openapi": "3.1.0",
43441
43412
  "paths": {
@@ -43505,144 +43476,6 @@
43505
43476
  ]
43506
43477
  }
43507
43478
  },
43508
- "/v1/admin/cad/load": {
43509
- "post": {
43510
- "description": "Starts the `load-cad` ECS task and returns its id. Poll `GET /v1/admin/cad/load/{taskId}`. The load writes the licensing database only; run `index-cad` afterwards (or pass `reindex: true`) to publish it.",
43511
- "operationId": "adminLaunchCadLoad",
43512
- "requestBody": {
43513
- "content": {
43514
- "application/json": {
43515
- "schema": {
43516
- "$ref": "#/components/schemas/AdminCadLoadRequest"
43517
- }
43518
- }
43519
- },
43520
- "required": true
43521
- },
43522
- "responses": {
43523
- "202": {
43524
- "content": {
43525
- "application/json": {
43526
- "schema": {
43527
- "$ref": "#/components/schemas/AdminCadLoadLaunch"
43528
- }
43529
- }
43530
- },
43531
- "description": "Task launched"
43532
- },
43533
- "400": {
43534
- "content": {
43535
- "application/json": {
43536
- "schema": {
43537
- "$ref": "#/components/schemas/ErrorResponse"
43538
- }
43539
- }
43540
- },
43541
- "description": "Invalid body"
43542
- },
43543
- "401": {
43544
- "content": {
43545
- "application/json": {
43546
- "schema": {
43547
- "$ref": "#/components/schemas/ErrorResponse"
43548
- }
43549
- }
43550
- },
43551
- "description": "Not authenticated"
43552
- },
43553
- "403": {
43554
- "content": {
43555
- "application/json": {
43556
- "schema": {
43557
- "$ref": "#/components/schemas/ErrorResponse"
43558
- }
43559
- }
43560
- },
43561
- "description": "Admin role required"
43562
- },
43563
- "503": {
43564
- "content": {
43565
- "application/json": {
43566
- "schema": {
43567
- "$ref": "#/components/schemas/ErrorResponse"
43568
- }
43569
- }
43570
- },
43571
- "description": "ECS not configured (local dev)"
43572
- }
43573
- },
43574
- "summary": "Launch the NMLS loader (admin)",
43575
- "tags": [
43576
- "Admin: NMLS"
43577
- ]
43578
- }
43579
- },
43580
- "/v1/admin/cad/load/{taskId}": {
43581
- "get": {
43582
- "description": "ECS lifecycle of a `load-cad` task. `succeeded` = exited 0 (load completed or paused); `failed` = any other stop. Per-file progress is in the task logs and the load bookkeeping tables.",
43583
- "operationId": "adminGetCadLoadTask",
43584
- "parameters": [
43585
- {
43586
- "description": "ECS task id returned by the launch route.",
43587
- "in": "path",
43588
- "name": "taskId",
43589
- "required": true,
43590
- "schema": {
43591
- "description": "ECS task id returned by the launch route.",
43592
- "example": "0123456789abcdef0123456789abcdef",
43593
- "pattern": "^[a-f0-9]{32}$",
43594
- "type": "string"
43595
- }
43596
- }
43597
- ],
43598
- "responses": {
43599
- "200": {
43600
- "content": {
43601
- "application/json": {
43602
- "schema": {
43603
- "$ref": "#/components/schemas/AdminCadLoadTaskStatus"
43604
- }
43605
- }
43606
- },
43607
- "description": "Task status"
43608
- },
43609
- "401": {
43610
- "content": {
43611
- "application/json": {
43612
- "schema": {
43613
- "$ref": "#/components/schemas/ErrorResponse"
43614
- }
43615
- }
43616
- },
43617
- "description": "Not authenticated"
43618
- },
43619
- "403": {
43620
- "content": {
43621
- "application/json": {
43622
- "schema": {
43623
- "$ref": "#/components/schemas/ErrorResponse"
43624
- }
43625
- }
43626
- },
43627
- "description": "Admin role required"
43628
- },
43629
- "404": {
43630
- "content": {
43631
- "application/json": {
43632
- "schema": {
43633
- "$ref": "#/components/schemas/ErrorResponse"
43634
- }
43635
- }
43636
- },
43637
- "description": "No load-cad task with that id (or ECS expired it)"
43638
- }
43639
- },
43640
- "summary": "Status of a loader task (admin)",
43641
- "tags": [
43642
- "Admin: NMLS"
43643
- ]
43644
- }
43645
- },
43646
43479
  "/v1/admin/jobs/{jobId}": {
43647
43480
  "get": {
43648
43481
  "description": "Returns any org's bulk job (delivery or enrichment) with a freshly signed download URL for its result file. Cross-org: signs against the job's own stored org. `resultsUrl` is null until the job is completed.",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@model-match/api",
3
- "version": "3.34.0",
3
+ "version": "3.36.0",
4
4
  "description": "TypeScript client for the ModelMatch API",
5
5
  "license": "MIT",
6
6
  "files": [
@@ -41,7 +41,7 @@
41
41
  },
42
42
  "devDependencies": {
43
43
  "@hey-api/openapi-ts": "^0.67.6",
44
- "@model-match-inc/api": "3.75.0",
44
+ "@model-match-inc/api": "3.87.2",
45
45
  "tsdown": "^0.21.10",
46
46
  "typescript": "6.0.2",
47
47
  "vitest": "4.1.2"