@model-match/api 3.40.0 → 3.42.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 { E as client, n as createClient } from "../src-CoGt92lf.mjs";
1
+ import { E as client, n as createClient } from "../src-CCTsE9Lr.mjs";
2
2
  //#region src/slim/sdk.gen.ts
3
3
  /**
4
4
  * An LO's sponsorship / registration links (admin)
@@ -5347,6 +5347,27 @@ const countOffices = (options) => {
5347
5347
  });
5348
5348
  };
5349
5349
  /**
5350
+ * Office-name typeahead (distinct names with agent totals)
5351
+ * Distinct real-estate office names starting with `query`, each with the agents and offices behind that name across all its offices — the picker for filters that match by office name (`listOffices` `company`, `listAgents` `currentOffice`). To find one office, use `instantSearch` or `listOffices` instead.
5352
+ */
5353
+ const suggestOfficeNames = (options) => {
5354
+ return (options?.client ?? client).post({
5355
+ security: [{
5356
+ name: "x-api-key",
5357
+ type: "apiKey"
5358
+ }, {
5359
+ scheme: "bearer",
5360
+ type: "http"
5361
+ }],
5362
+ url: "/v1/offices/names",
5363
+ ...options,
5364
+ headers: {
5365
+ "Content-Type": "application/json",
5366
+ ...options?.headers
5367
+ }
5368
+ });
5369
+ };
5370
+ /**
5350
5371
  * Get office by key with office-level production
5351
5372
  */
5352
5373
  const getOffice = (options) => {
@@ -5363,6 +5384,90 @@ const getOffice = (options) => {
5363
5384
  });
5364
5385
  };
5365
5386
  /**
5387
+ * Home builders on the office's deals (pre-aggregated)
5388
+ * New-construction builders named on the office's deals in the period, ranked by units. Deal COUNT only: every row's `volume` / `pctVolume` is 0 and `pctUnits` is a share of ALL the office's deals. No buyer/listing split: `side` must be `any` (or omitted).
5389
+ */
5390
+ const officeBuilders = (options) => {
5391
+ return (options.client ?? client).post({
5392
+ security: [{
5393
+ name: "x-api-key",
5394
+ type: "apiKey"
5395
+ }, {
5396
+ scheme: "bearer",
5397
+ type: "http"
5398
+ }],
5399
+ url: "/v1/offices/{id}/breakdowns/builders",
5400
+ ...options,
5401
+ headers: {
5402
+ "Content-Type": "application/json",
5403
+ ...options?.headers
5404
+ }
5405
+ });
5406
+ };
5407
+ /**
5408
+ * Lenders on the office's deals (pre-aggregated)
5409
+ * Lenders that financed the office's deals in the period. `id` is the lender id (pass it back as the `lender` filter on the loans routes), `label` its display name. The row for deals with no lender attributed carries no `id`.
5410
+ */
5411
+ const officeLenders = (options) => {
5412
+ return (options.client ?? client).post({
5413
+ security: [{
5414
+ name: "x-api-key",
5415
+ type: "apiKey"
5416
+ }, {
5417
+ scheme: "bearer",
5418
+ type: "http"
5419
+ }],
5420
+ url: "/v1/offices/{id}/breakdowns/lenders",
5421
+ ...options,
5422
+ headers: {
5423
+ "Content-Type": "application/json",
5424
+ ...options?.headers
5425
+ }
5426
+ });
5427
+ };
5428
+ /**
5429
+ * Loan products on the office's financed deals (pre-aggregated)
5430
+ * The office's financed deals in the period by loan product (`label` = product key, e.g. `conventional`, `fha`, `va`), summed across its lenders. Shares are of the financed deals on the requested side, so rows sum to 1; cash deals are not counted.
5431
+ */
5432
+ const officeLoanTypes = (options) => {
5433
+ return (options.client ?? client).post({
5434
+ security: [{
5435
+ name: "x-api-key",
5436
+ type: "apiKey"
5437
+ }, {
5438
+ scheme: "bearer",
5439
+ type: "http"
5440
+ }],
5441
+ url: "/v1/offices/{id}/breakdowns/loanTypes",
5442
+ ...options,
5443
+ headers: {
5444
+ "Content-Type": "application/json",
5445
+ ...options?.headers
5446
+ }
5447
+ });
5448
+ };
5449
+ /**
5450
+ * Loan officers the office's agents worked with (pre-aggregated)
5451
+ * Loan officers on the office's deals in the period. `id` is the LO's NMLS id; `label` their registered name and `company` their current employer (both from the LO's own profile, not the deal records). `side: buyer` = deals where this office represented the buyer.
5452
+ */
5453
+ const officeOriginators = (options) => {
5454
+ return (options.client ?? client).post({
5455
+ security: [{
5456
+ name: "x-api-key",
5457
+ type: "apiKey"
5458
+ }, {
5459
+ scheme: "bearer",
5460
+ type: "http"
5461
+ }],
5462
+ url: "/v1/offices/{id}/breakdowns/originators",
5463
+ ...options,
5464
+ headers: {
5465
+ "Content-Type": "application/json",
5466
+ ...options?.headers
5467
+ }
5468
+ });
5469
+ };
5470
+ /**
5366
5471
  * Search originators with filters
5367
5472
  * Search and list individual loan originators (LOs — NMLS-registered mortgage loan officers) with filters — one row per originator. Filter by name, NMLS ID, location (state, city), employer/company, and production metrics (loan volume, units, product mix), with sorting and cursor pagination. LOCATION SEMANTICS: the state/city filters match an originator's PRODUCTION GEOGRAPHY — the markets where they actually originated loans in the selected period — not where their office or employer sits. An LO who lends across several markets matches a filter for ANY of those markets, while the `state`/`city` returned on each row reflect only their PRIMARY (highest-volume) market. So a search for city "Long Beach" can return an LO whose displayed location is a different city/state (e.g. their top market is in Arizona) — they still originated loans in Long Beach, it just isn't their #1 market. To rank originators by their volume within a specific market, sort by volume after filtering, or use the per-originator city/county/state breakdown endpoints. NEWLY LICENSED / NO PRODUCTION: an originator who is in the NMLS registry but has no production record is returned only by an identity search — `nmlsId`, `name` or `namePrefix` as the ONLY filter — sent with `producersOnly: false`. Those rows come after the rows that have production, carry `hasScoredData: false`, and have `null` production fields. Under any other filter, or without `producersOnly: false`, they are not returned (use `getOriginator` for one by NMLS id). This is the per-originator record search: use it to find specific loan officers or build a filtered LO list. (For a single originator by NMLS ID use the originator detail endpoint.) If you only need how many originators match and not the records themselves, send the same request body to `countOriginators`.
5368
5473
  */
@@ -5644,6 +5749,27 @@ const originatorBrokers = (options) => {
5644
5749
  });
5645
5750
  };
5646
5751
  /**
5752
+ * Home builders on this LO's new-construction loans
5753
+ * 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.
5754
+ */
5755
+ const originatorBuilders = (options) => {
5756
+ return (options.client ?? client).post({
5757
+ security: [{
5758
+ name: "x-api-key",
5759
+ type: "apiKey"
5760
+ }, {
5761
+ scheme: "bearer",
5762
+ type: "http"
5763
+ }],
5764
+ url: "/v1/originators/{nmlsId}/breakdowns/builders",
5765
+ ...options,
5766
+ headers: {
5767
+ "Content-Type": "application/json",
5768
+ ...options?.headers
5769
+ }
5770
+ });
5771
+ };
5772
+ /**
5647
5773
  * City volume breakdown across this LO's loans
5648
5774
  */
5649
5775
  const originatorCitiesBreakdown = (options) => {
@@ -6461,4 +6587,4 @@ const getSearchToken = (options) => {
6461
6587
  });
6462
6588
  };
6463
6589
  //#endregion
6464
- export { client as _heyApiClient, actionCrmCallerId, addCrmContactMethod, addCrmListMember, addCrmListMembersBulk, addCrmNote, addCrmRecord, addCrmRecordsBulk, addWatchedAgent, addWatchedArea, addWatchedDocument, adminGetBulkJob, adminGetCadLinks, adminGetContactSubmission, adminGetLoEnrichmentBalance, adminLaunchLoEnrichmentRun, adminListApprovedContacts, adminListContactSubmissions, adminReviewContactSubmission, adminRevokeApprovedContact, agentAnalyticsChart, agentAnalyticsSummary, agentAnalyticsTimeSeries, agentBuilders, agentCities, agentCompanies, agentCounties, agentLenders, agentLoanMix, agentMarkets, agentMortgagedTimeSeries, agentOffices, agentOriginators, agentProperties, agentRelated, agentSales, agentStates, agentTitleCompanies, agentTitleCompaniesTimeSeries, agentZipCodes, analyzeCrmCall, applyCrmEnrichment, applyCrmListMiUpdates, 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, companyDepartureStatus, companyEarlyExits, companyEmployeeStats, companyEmployment, companyHeadcount, companyLenders, companyMarkets, companyMoverProduction, companyOffices, companyOriginators, companyRelated, companySponsoredIndividuals, companySponsorshipMovement, companyStates, companyTalentFlow, companyTitleCompanies, companyZipCodes, countAgents, countBranches, countCompanies, countLenders, countLoans, countOffices, countOriginators, countProperties, countSales, createAgentContactSubmission, createAlertSubscription, createClient, createCrmList, createCrmListField, createCrmManualRecord, createCrmMeeting, createCrmObjectField, createCrmRecord, createCrmTask, createCrmTemplate, createMyAlertRecipe, createOriginatorContactSubmission, createSavedFilter, crmLenderChannels, crmLoLoanMix, crmLoMomentum, crmLoSponsorLocation, crmSimilarOriginators, declineCrmMiUpdate, deleteAlertSubscription, deleteCrmCallerId, deleteCrmList, deleteCrmListField, deleteCrmMeeting, deleteCrmNote, deleteCrmObjectField, deleteCrmRecord, deleteCrmRecords, deleteCrmTask, deleteCrmTemplate, deleteMyAlertRecipe, deleteSavedFilter, describeCrmRecordsOnAdd, dismissCrmListMiUpdates, 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, getCrmListMiUpdates, 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, resolveProperties, 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 };
6590
+ export { client as _heyApiClient, actionCrmCallerId, addCrmContactMethod, addCrmListMember, addCrmListMembersBulk, addCrmNote, addCrmRecord, addCrmRecordsBulk, addWatchedAgent, addWatchedArea, addWatchedDocument, adminGetBulkJob, adminGetCadLinks, adminGetContactSubmission, adminGetLoEnrichmentBalance, adminLaunchLoEnrichmentRun, adminListApprovedContacts, adminListContactSubmissions, adminReviewContactSubmission, adminRevokeApprovedContact, agentAnalyticsChart, agentAnalyticsSummary, agentAnalyticsTimeSeries, agentBuilders, agentCities, agentCompanies, agentCounties, agentLenders, agentLoanMix, agentMarkets, agentMortgagedTimeSeries, agentOffices, agentOriginators, agentProperties, agentRelated, agentSales, agentStates, agentTitleCompanies, agentTitleCompaniesTimeSeries, agentZipCodes, analyzeCrmCall, applyCrmEnrichment, applyCrmListMiUpdates, 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, companyDepartureStatus, companyEarlyExits, companyEmployeeStats, companyEmployment, companyHeadcount, companyLenders, companyMarkets, companyMoverProduction, companyOffices, companyOriginators, companyRelated, companySponsoredIndividuals, companySponsorshipMovement, companyStates, companyTalentFlow, companyTitleCompanies, companyZipCodes, countAgents, countBranches, countCompanies, countLenders, countLoans, countOffices, countOriginators, countProperties, countSales, createAgentContactSubmission, createAlertSubscription, createClient, createCrmList, createCrmListField, createCrmManualRecord, createCrmMeeting, createCrmObjectField, createCrmRecord, createCrmTask, createCrmTemplate, createMyAlertRecipe, createOriginatorContactSubmission, createSavedFilter, crmLenderChannels, crmLoLoanMix, crmLoMomentum, crmLoSponsorLocation, crmSimilarOriginators, declineCrmMiUpdate, deleteAlertSubscription, deleteCrmCallerId, deleteCrmList, deleteCrmListField, deleteCrmMeeting, deleteCrmNote, deleteCrmObjectField, deleteCrmRecord, deleteCrmRecords, deleteCrmTask, deleteCrmTemplate, deleteMyAlertRecipe, deleteSavedFilter, describeCrmRecordsOnAdd, dismissCrmListMiUpdates, 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, getCrmListMiUpdates, 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, officeBuilders, officeLenders, officeLoanTypes, officeOriginators, originatorAgents, originatorAnalyticsChart, originatorAnalyticsSummary, originatorAnalyticsTimeSeries, originatorBranches, originatorBrokers, originatorBuilders, 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, resolveProperties, 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, suggestOfficeNames, transcribeCrmCall, transferCrmListOwnership, unshareCrmTemplate, unsubscribeAlertRecipe, updateAlertConditions, updateCrmContactMethod, updateCrmList, updateCrmListField, updateCrmMeeting, updateCrmObjectField, updateCrmTask, updateCrmTemplate, updateMe, updateMyAlertRecipe, updateSavedFilter };
@@ -5460,6 +5460,27 @@ var Offices = class {
5460
5460
  });
5461
5461
  }
5462
5462
  /**
5463
+ * Office-name typeahead (distinct names with agent totals)
5464
+ * Distinct real-estate office names starting with `query`, each with the agents and offices behind that name across all its offices — the picker for filters that match by office name (`listOffices` `company`, `listAgents` `currentOffice`). To find one office, use `instantSearch` or `listOffices` instead.
5465
+ */
5466
+ static suggestOfficeNames(options) {
5467
+ return (options?.client ?? client).post({
5468
+ security: [{
5469
+ name: "x-api-key",
5470
+ type: "apiKey"
5471
+ }, {
5472
+ scheme: "bearer",
5473
+ type: "http"
5474
+ }],
5475
+ url: "/v1/offices/names",
5476
+ ...options,
5477
+ headers: {
5478
+ "Content-Type": "application/json",
5479
+ ...options?.headers
5480
+ }
5481
+ });
5482
+ }
5483
+ /**
5463
5484
  * Get office by key with office-level production
5464
5485
  */
5465
5486
  static get(options) {
@@ -5475,6 +5496,90 @@ var Offices = class {
5475
5496
  ...options
5476
5497
  });
5477
5498
  }
5499
+ /**
5500
+ * Home builders on the office's deals (pre-aggregated)
5501
+ * New-construction builders named on the office's deals in the period, ranked by units. Deal COUNT only: every row's `volume` / `pctVolume` is 0 and `pctUnits` is a share of ALL the office's deals. No buyer/listing split: `side` must be `any` (or omitted).
5502
+ */
5503
+ static builders(options) {
5504
+ return (options.client ?? client).post({
5505
+ security: [{
5506
+ name: "x-api-key",
5507
+ type: "apiKey"
5508
+ }, {
5509
+ scheme: "bearer",
5510
+ type: "http"
5511
+ }],
5512
+ url: "/v1/offices/{id}/breakdowns/builders",
5513
+ ...options,
5514
+ headers: {
5515
+ "Content-Type": "application/json",
5516
+ ...options?.headers
5517
+ }
5518
+ });
5519
+ }
5520
+ /**
5521
+ * Lenders on the office's deals (pre-aggregated)
5522
+ * Lenders that financed the office's deals in the period. `id` is the lender id (pass it back as the `lender` filter on the loans routes), `label` its display name. The row for deals with no lender attributed carries no `id`.
5523
+ */
5524
+ static lenders(options) {
5525
+ return (options.client ?? client).post({
5526
+ security: [{
5527
+ name: "x-api-key",
5528
+ type: "apiKey"
5529
+ }, {
5530
+ scheme: "bearer",
5531
+ type: "http"
5532
+ }],
5533
+ url: "/v1/offices/{id}/breakdowns/lenders",
5534
+ ...options,
5535
+ headers: {
5536
+ "Content-Type": "application/json",
5537
+ ...options?.headers
5538
+ }
5539
+ });
5540
+ }
5541
+ /**
5542
+ * Loan products on the office's financed deals (pre-aggregated)
5543
+ * The office's financed deals in the period by loan product (`label` = product key, e.g. `conventional`, `fha`, `va`), summed across its lenders. Shares are of the financed deals on the requested side, so rows sum to 1; cash deals are not counted.
5544
+ */
5545
+ static loanTypes(options) {
5546
+ return (options.client ?? client).post({
5547
+ security: [{
5548
+ name: "x-api-key",
5549
+ type: "apiKey"
5550
+ }, {
5551
+ scheme: "bearer",
5552
+ type: "http"
5553
+ }],
5554
+ url: "/v1/offices/{id}/breakdowns/loanTypes",
5555
+ ...options,
5556
+ headers: {
5557
+ "Content-Type": "application/json",
5558
+ ...options?.headers
5559
+ }
5560
+ });
5561
+ }
5562
+ /**
5563
+ * Loan officers the office's agents worked with (pre-aggregated)
5564
+ * Loan officers on the office's deals in the period. `id` is the LO's NMLS id; `label` their registered name and `company` their current employer (both from the LO's own profile, not the deal records). `side: buyer` = deals where this office represented the buyer.
5565
+ */
5566
+ static originators(options) {
5567
+ return (options.client ?? client).post({
5568
+ security: [{
5569
+ name: "x-api-key",
5570
+ type: "apiKey"
5571
+ }, {
5572
+ scheme: "bearer",
5573
+ type: "http"
5574
+ }],
5575
+ url: "/v1/offices/{id}/breakdowns/originators",
5576
+ ...options,
5577
+ headers: {
5578
+ "Content-Type": "application/json",
5579
+ ...options?.headers
5580
+ }
5581
+ });
5582
+ }
5478
5583
  };
5479
5584
  var Originators = class {
5480
5585
  /**
@@ -5742,6 +5847,27 @@ var Originators = class {
5742
5847
  });
5743
5848
  }
5744
5849
  /**
5850
+ * Home builders on this LO's new-construction loans
5851
+ * 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.
5852
+ */
5853
+ static builders(options) {
5854
+ return (options.client ?? client).post({
5855
+ security: [{
5856
+ name: "x-api-key",
5857
+ type: "apiKey"
5858
+ }, {
5859
+ scheme: "bearer",
5860
+ type: "http"
5861
+ }],
5862
+ url: "/v1/originators/{nmlsId}/breakdowns/builders",
5863
+ ...options,
5864
+ headers: {
5865
+ "Content-Type": "application/json",
5866
+ ...options?.headers
5867
+ }
5868
+ });
5869
+ }
5870
+ /**
5745
5871
  * City volume breakdown across this LO's loans
5746
5872
  */
5747
5873
  static citiesBreakdown(options) {