@model-match/api 3.58.0 → 3.59.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.
- package/RELEASE_NOTES.md +5 -0
- package/dist/{index-Bx3EsqLX.d.mts → index-D0bHfN1q.d.mts} +145 -1
- package/dist/index.d.mts +2 -2
- package/dist/index.mjs +1 -1
- package/dist/slim/index.d.mts +8 -2
- package/dist/slim/index.mjs +18 -2
- package/dist/{src-CpcpbzcO.mjs → src-DDDDlSvL.mjs} +18 -0
- package/openapi.json +288 -1
- package/package.json +1 -1
package/dist/slim/index.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { S as client, n as createClient } from "../src-
|
|
1
|
+
import { S as client, n as createClient } from "../src-DDDDlSvL.mjs";
|
|
2
2
|
//#region src/slim/sdk.gen.ts
|
|
3
3
|
/**
|
|
4
4
|
* Search agents with filters
|
|
@@ -2001,6 +2001,22 @@ const companyRetention = (options) => (options.client ?? client).get({
|
|
|
2001
2001
|
...options
|
|
2002
2002
|
});
|
|
2003
2003
|
/**
|
|
2004
|
+
* Retained borrowers listed for sale now (weekly)
|
|
2005
|
+
*
|
|
2006
|
+
* The company's retained borrowers (their latest loan is still the company's) whose home is listed for sale right now, each with the company loan officer who wrote that loan — only LOs the company employed on the loan, not brokers' LOs on loans it only funded. Newest listing first; filter to one LO with `originator`. "Listed now" is the LO Borrower Retention tab's rule: an active MLS listing event in the last 90 days, list price at least $20k, not under contract. Checked weekly with the retention snapshot — `computedAt` says when. 404 means not computed for this company yet.
|
|
2007
|
+
*/
|
|
2008
|
+
const companyRetentionActiveListings = (options) => (options.client ?? client).get({
|
|
2009
|
+
security: [{
|
|
2010
|
+
name: "x-api-key",
|
|
2011
|
+
type: "apiKey"
|
|
2012
|
+
}, {
|
|
2013
|
+
scheme: "bearer",
|
|
2014
|
+
type: "http"
|
|
2015
|
+
}],
|
|
2016
|
+
url: "/v1/companies/{nmlsId}/retention/active-listings",
|
|
2017
|
+
...options
|
|
2018
|
+
});
|
|
2019
|
+
/**
|
|
2004
2020
|
* Loan originators sponsored by this company
|
|
2005
2021
|
*/
|
|
2006
2022
|
const companySponsoredIndividuals = (options) => (options.client ?? client).post({
|
|
@@ -6213,4 +6229,4 @@ const getSearchToken = (options) => (options?.client ?? client).get({
|
|
|
6213
6229
|
...options
|
|
6214
6230
|
});
|
|
6215
6231
|
//#endregion
|
|
6216
|
-
export { client as _heyApiClient, actionCrmCallerId, addCrmContactMethod, addCrmListMember, addCrmListMembersBulk, addCrmNote, addCrmRecord, addCrmRecordsBulk, addWatchedAgent, addWatchedArea, addWatchedDocument, 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, branchCommunityLendingMap, branchCounties, branchLenders, branchLoans, branchOriginators, branchRoster, branchStates, branchStats, branchTitleCompanies, cancelAgentsBulkDeliveryJob, cancelBranchesBulkDeliveryJob, cancelCompaniesBulkDeliveryJob, cancelEnrichBulkJob, cancelLoansBulkDeliveryJob, cancelOriginatorsBulkDeliveryJob, cancelPropertiesBulkDeliveryJob, checkCrmImport, companyAgents, companyAnalyticsChart, companyAnalyticsSummary, companyAnalyticsTimeSeries, companyBranches, companyBrokers, companyCities, companyCommunityLendingBenchmark, companyCommunityLendingMap, companyCounties, companyDepartureStatus, companyEarlyExits, companyEmployeeStats, companyEmployment, companyHeadcount, companyLenders, companyMarkets, companyMoverProduction, companyOffices, companyOriginators, companyRelated, companyRetention, 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, getCrmImport, 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, getSavedFilterShares, getSearchToken, grantCrmListAccess, grantCrmRecordAccess, grantCrmRecordAccessRequest, grantSavedFilterAccess, hangupCrmCall, importCrmRecords, instantSearch, lenderCities, lenderCompanies, lenderCounties, lenderOriginators, lenderStates, linkCrmRecord, listAgentOfficeGroups, listAgents, listAlertDigests, listAlertLog, listAlertRecipes, listAlertSubscriptions, listBranches, listCompanies, listCrmActivity, listCrmCallerIds, listCrmCustomFields, listCrmImportRows, listCrmImports, listCrmListAssignees, listCrmListFields, listCrmListMemberships, listCrmListShareableMembers, listCrmLists, listCrmMeetings, listCrmMembers, listCrmOrgMembers, listCrmRecordShareableMembers, listCrmRecordShares, listCrmReferencedActivity, listCrmTasks, listCrmTemplates, listCrmWorkspaceMeetings, listCrmWorkspaceTasks, listEnrichments, listLenders, listLoans, listMarket, listMyAlertRecipes, listOffices, listOriginators, listProperties, listSales, listSavedFilterShareableMembers, 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, marketSignals, officeAgents, officeBuilders, officeLenders, officeLoanTypes, officeOriginators, originatorAgents, originatorAnalyticsChart, originatorAnalyticsSummary, originatorAnalyticsTimeSeries, originatorBranches, originatorBrokers, originatorBuilders, originatorCitiesBreakdown, originatorCommunityLendingBenchmark, originatorCommunityLendingMap, originatorCompanies, originatorCountiesBreakdown, originatorLenders, originatorLoans, originatorMarkets, originatorOffices, originatorProperties, originatorRelated, originatorRetention, 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, revokeSavedFilterAccess, 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, undoCrmImport, unshareCrmTemplate, unsubscribeAlertRecipe, updateAlertConditions, updateCrmContactMethod, updateCrmList, updateCrmListField, updateCrmMeeting, updateCrmObjectField, updateCrmTask, updateCrmTemplate, updateMe, updateMyAlertRecipe, updateSavedFilter };
|
|
6232
|
+
export { client as _heyApiClient, actionCrmCallerId, addCrmContactMethod, addCrmListMember, addCrmListMembersBulk, addCrmNote, addCrmRecord, addCrmRecordsBulk, addWatchedAgent, addWatchedArea, addWatchedDocument, 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, branchCommunityLendingMap, branchCounties, branchLenders, branchLoans, branchOriginators, branchRoster, branchStates, branchStats, branchTitleCompanies, cancelAgentsBulkDeliveryJob, cancelBranchesBulkDeliveryJob, cancelCompaniesBulkDeliveryJob, cancelEnrichBulkJob, cancelLoansBulkDeliveryJob, cancelOriginatorsBulkDeliveryJob, cancelPropertiesBulkDeliveryJob, checkCrmImport, companyAgents, companyAnalyticsChart, companyAnalyticsSummary, companyAnalyticsTimeSeries, companyBranches, companyBrokers, companyCities, companyCommunityLendingBenchmark, companyCommunityLendingMap, companyCounties, companyDepartureStatus, companyEarlyExits, companyEmployeeStats, companyEmployment, companyHeadcount, companyLenders, companyMarkets, companyMoverProduction, companyOffices, companyOriginators, companyRelated, companyRetention, companyRetentionActiveListings, 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, getCrmImport, 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, getSavedFilterShares, getSearchToken, grantCrmListAccess, grantCrmRecordAccess, grantCrmRecordAccessRequest, grantSavedFilterAccess, hangupCrmCall, importCrmRecords, instantSearch, lenderCities, lenderCompanies, lenderCounties, lenderOriginators, lenderStates, linkCrmRecord, listAgentOfficeGroups, listAgents, listAlertDigests, listAlertLog, listAlertRecipes, listAlertSubscriptions, listBranches, listCompanies, listCrmActivity, listCrmCallerIds, listCrmCustomFields, listCrmImportRows, listCrmImports, listCrmListAssignees, listCrmListFields, listCrmListMemberships, listCrmListShareableMembers, listCrmLists, listCrmMeetings, listCrmMembers, listCrmOrgMembers, listCrmRecordShareableMembers, listCrmRecordShares, listCrmReferencedActivity, listCrmTasks, listCrmTemplates, listCrmWorkspaceMeetings, listCrmWorkspaceTasks, listEnrichments, listLenders, listLoans, listMarket, listMyAlertRecipes, listOffices, listOriginators, listProperties, listSales, listSavedFilterShareableMembers, 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, marketSignals, officeAgents, officeBuilders, officeLenders, officeLoanTypes, officeOriginators, originatorAgents, originatorAnalyticsChart, originatorAnalyticsSummary, originatorAnalyticsTimeSeries, originatorBranches, originatorBrokers, originatorBuilders, originatorCitiesBreakdown, originatorCommunityLendingBenchmark, originatorCommunityLendingMap, originatorCompanies, originatorCountiesBreakdown, originatorLenders, originatorLoans, originatorMarkets, originatorOffices, originatorProperties, originatorRelated, originatorRetention, 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, revokeSavedFilterAccess, 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, undoCrmImport, unshareCrmTemplate, unsubscribeAlertRecipe, updateAlertConditions, updateCrmContactMethod, updateCrmList, updateCrmListField, updateCrmMeeting, updateCrmObjectField, updateCrmTask, updateCrmTemplate, updateMe, updateMyAlertRecipe, updateSavedFilter };
|
|
@@ -2922,6 +2922,24 @@ var Companies = class {
|
|
|
2922
2922
|
});
|
|
2923
2923
|
}
|
|
2924
2924
|
/**
|
|
2925
|
+
* Retained borrowers listed for sale now (weekly)
|
|
2926
|
+
*
|
|
2927
|
+
* The company's retained borrowers (their latest loan is still the company's) whose home is listed for sale right now, each with the company loan officer who wrote that loan — only LOs the company employed on the loan, not brokers' LOs on loans it only funded. Newest listing first; filter to one LO with `originator`. "Listed now" is the LO Borrower Retention tab's rule: an active MLS listing event in the last 90 days, list price at least $20k, not under contract. Checked weekly with the retention snapshot — `computedAt` says when. 404 means not computed for this company yet.
|
|
2928
|
+
*/
|
|
2929
|
+
static retentionActiveListings(options) {
|
|
2930
|
+
return (options.client ?? client).get({
|
|
2931
|
+
security: [{
|
|
2932
|
+
name: "x-api-key",
|
|
2933
|
+
type: "apiKey"
|
|
2934
|
+
}, {
|
|
2935
|
+
scheme: "bearer",
|
|
2936
|
+
type: "http"
|
|
2937
|
+
}],
|
|
2938
|
+
url: "/v1/companies/{nmlsId}/retention/active-listings",
|
|
2939
|
+
...options
|
|
2940
|
+
});
|
|
2941
|
+
}
|
|
2942
|
+
/**
|
|
2925
2943
|
* Loan originators sponsored by this company
|
|
2926
2944
|
*/
|
|
2927
2945
|
static sponsoredIndividuals(options) {
|
package/openapi.json
CHANGED
|
@@ -11871,6 +11871,161 @@
|
|
|
11871
11871
|
],
|
|
11872
11872
|
"type": "object"
|
|
11873
11873
|
},
|
|
11874
|
+
"CompanyActiveListing": {
|
|
11875
|
+
"properties": {
|
|
11876
|
+
"address": {
|
|
11877
|
+
"description": "From the company's loan record on the parcel.",
|
|
11878
|
+
"type": "string"
|
|
11879
|
+
},
|
|
11880
|
+
"lender": {
|
|
11881
|
+
"description": "Lender on that loan — still the borrower's latest loan (retained), so the current lender of record.",
|
|
11882
|
+
"nullable": true,
|
|
11883
|
+
"type": "string"
|
|
11884
|
+
},
|
|
11885
|
+
"listPrice": {
|
|
11886
|
+
"nullable": true,
|
|
11887
|
+
"type": "number"
|
|
11888
|
+
},
|
|
11889
|
+
"listedDate": {
|
|
11890
|
+
"description": "Date of the newest listing event (UTC).",
|
|
11891
|
+
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
|
|
11892
|
+
"type": "string"
|
|
11893
|
+
},
|
|
11894
|
+
"listingStatus": {
|
|
11895
|
+
"description": "The MLS status of the newest listing event (active).",
|
|
11896
|
+
"type": "string"
|
|
11897
|
+
},
|
|
11898
|
+
"loanAmount": {
|
|
11899
|
+
"type": "number"
|
|
11900
|
+
},
|
|
11901
|
+
"loanDate": {
|
|
11902
|
+
"description": "Date of the company's latest loan on the parcel.",
|
|
11903
|
+
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
|
|
11904
|
+
"type": "string"
|
|
11905
|
+
},
|
|
11906
|
+
"originatorName": {
|
|
11907
|
+
"type": "string"
|
|
11908
|
+
},
|
|
11909
|
+
"originatorNmlsId": {
|
|
11910
|
+
"description": "The LO who wrote the company's latest loan on the parcel — employed by the company on that loan.",
|
|
11911
|
+
"type": "string"
|
|
11912
|
+
},
|
|
11913
|
+
"propertyId": {
|
|
11914
|
+
"type": "string"
|
|
11915
|
+
}
|
|
11916
|
+
},
|
|
11917
|
+
"required": [
|
|
11918
|
+
"propertyId",
|
|
11919
|
+
"address",
|
|
11920
|
+
"listingStatus",
|
|
11921
|
+
"listPrice",
|
|
11922
|
+
"listedDate",
|
|
11923
|
+
"originatorNmlsId",
|
|
11924
|
+
"originatorName",
|
|
11925
|
+
"loanDate",
|
|
11926
|
+
"loanAmount",
|
|
11927
|
+
"lender"
|
|
11928
|
+
],
|
|
11929
|
+
"type": "object"
|
|
11930
|
+
},
|
|
11931
|
+
"CompanyActiveListingsResponse": {
|
|
11932
|
+
"properties": {
|
|
11933
|
+
"companyNmlsId": {
|
|
11934
|
+
"type": "string"
|
|
11935
|
+
},
|
|
11936
|
+
"computedAt": {
|
|
11937
|
+
"description": "When the weekly batch checked these listings (ISO-8601). Rows are as of this time, not live.",
|
|
11938
|
+
"type": "string"
|
|
11939
|
+
},
|
|
11940
|
+
"cursor": {
|
|
11941
|
+
"description": "Cursor for the next page; absent on the last page.",
|
|
11942
|
+
"type": "string"
|
|
11943
|
+
},
|
|
11944
|
+
"data": {
|
|
11945
|
+
"items": {
|
|
11946
|
+
"$ref": "#/components/schemas/CompanyActiveListing"
|
|
11947
|
+
},
|
|
11948
|
+
"type": "array"
|
|
11949
|
+
},
|
|
11950
|
+
"status": {
|
|
11951
|
+
"description": "`timeout`: the listing check did not finish in this run, so the previous run's rows and counts are kept (or none, on a first run).",
|
|
11952
|
+
"enum": [
|
|
11953
|
+
"ok",
|
|
11954
|
+
"timeout"
|
|
11955
|
+
],
|
|
11956
|
+
"type": "string"
|
|
11957
|
+
},
|
|
11958
|
+
"total": {
|
|
11959
|
+
"description": "Rows matching the filter, across all pages.",
|
|
11960
|
+
"type": "integer"
|
|
11961
|
+
}
|
|
11962
|
+
},
|
|
11963
|
+
"required": [
|
|
11964
|
+
"companyNmlsId",
|
|
11965
|
+
"computedAt",
|
|
11966
|
+
"status",
|
|
11967
|
+
"data",
|
|
11968
|
+
"total"
|
|
11969
|
+
],
|
|
11970
|
+
"type": "object"
|
|
11971
|
+
},
|
|
11972
|
+
"CompanyActiveListingsSummary": {
|
|
11973
|
+
"description": "Retained borrowers listed for sale now, on loans by the company's own LOs: the count and top LOs (rows: `GET /companies/{nmlsId}/retention/active-listings`). Same for every window. Null until the weekly batch has checked listings for this company.",
|
|
11974
|
+
"nullable": true,
|
|
11975
|
+
"properties": {
|
|
11976
|
+
"computedAt": {
|
|
11977
|
+
"description": "When the listings were checked (ISO-8601) — the run that wrote the rows. Listings are as of this time, not live.",
|
|
11978
|
+
"type": "string"
|
|
11979
|
+
},
|
|
11980
|
+
"parcelsChecked": {
|
|
11981
|
+
"description": "Retained parcels whose latest company loan was written by an LO the company employed on it — the population checked for listings.",
|
|
11982
|
+
"type": "integer"
|
|
11983
|
+
},
|
|
11984
|
+
"status": {
|
|
11985
|
+
"description": "`timeout`: the listing check did not finish in this run, so the previous run's rows and counts are kept (or none, on a first run).",
|
|
11986
|
+
"enum": [
|
|
11987
|
+
"ok",
|
|
11988
|
+
"timeout"
|
|
11989
|
+
],
|
|
11990
|
+
"type": "string"
|
|
11991
|
+
},
|
|
11992
|
+
"topOriginators": {
|
|
11993
|
+
"description": "Top 10 LOs by active listings.",
|
|
11994
|
+
"items": {
|
|
11995
|
+
"properties": {
|
|
11996
|
+
"count": {
|
|
11997
|
+
"type": "integer"
|
|
11998
|
+
},
|
|
11999
|
+
"name": {
|
|
12000
|
+
"type": "string"
|
|
12001
|
+
},
|
|
12002
|
+
"nmlsId": {
|
|
12003
|
+
"type": "string"
|
|
12004
|
+
}
|
|
12005
|
+
},
|
|
12006
|
+
"required": [
|
|
12007
|
+
"nmlsId",
|
|
12008
|
+
"name",
|
|
12009
|
+
"count"
|
|
12010
|
+
],
|
|
12011
|
+
"type": "object"
|
|
12012
|
+
},
|
|
12013
|
+
"type": "array"
|
|
12014
|
+
},
|
|
12015
|
+
"total": {
|
|
12016
|
+
"description": "Retained borrowers whose home is listed for sale right now, on loans written by the company's own LOs.",
|
|
12017
|
+
"type": "integer"
|
|
12018
|
+
}
|
|
12019
|
+
},
|
|
12020
|
+
"required": [
|
|
12021
|
+
"computedAt",
|
|
12022
|
+
"status",
|
|
12023
|
+
"total",
|
|
12024
|
+
"parcelsChecked",
|
|
12025
|
+
"topOriginators"
|
|
12026
|
+
],
|
|
12027
|
+
"type": "object"
|
|
12028
|
+
},
|
|
11874
12029
|
"CompanyBranch": {
|
|
11875
12030
|
"properties": {
|
|
11876
12031
|
"branchNmlsId": {
|
|
@@ -15691,6 +15846,9 @@
|
|
|
15691
15846
|
},
|
|
15692
15847
|
"CompanyRetentionSnapshot": {
|
|
15693
15848
|
"properties": {
|
|
15849
|
+
"activeListings": {
|
|
15850
|
+
"$ref": "#/components/schemas/CompanyActiveListingsSummary"
|
|
15851
|
+
},
|
|
15694
15852
|
"book": {
|
|
15695
15853
|
"description": "Rows the computation read (sizing / provenance).",
|
|
15696
15854
|
"properties": {
|
|
@@ -16347,6 +16505,7 @@
|
|
|
16347
16505
|
"capturingTotals",
|
|
16348
16506
|
"originatorRetention",
|
|
16349
16507
|
"previous",
|
|
16508
|
+
"activeListings",
|
|
16350
16509
|
"book"
|
|
16351
16510
|
],
|
|
16352
16511
|
"type": "object"
|
|
@@ -45461,7 +45620,7 @@
|
|
|
45461
45620
|
"info": {
|
|
45462
45621
|
"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.",
|
|
45463
45622
|
"title": "ModelMatch API",
|
|
45464
|
-
"version": "3.
|
|
45623
|
+
"version": "3.125.0"
|
|
45465
45624
|
},
|
|
45466
45625
|
"openapi": "3.1.0",
|
|
45467
45626
|
"paths": {
|
|
@@ -56648,6 +56807,134 @@
|
|
|
56648
56807
|
]
|
|
56649
56808
|
}
|
|
56650
56809
|
},
|
|
56810
|
+
"/v1/companies/{nmlsId}/retention/active-listings": {
|
|
56811
|
+
"get": {
|
|
56812
|
+
"description": "The company's retained borrowers (their latest loan is still the company's) whose home is listed for sale right now, each with the company loan officer who wrote that loan — only LOs the company employed on the loan, not brokers' LOs on loans it only funded. Newest listing first; filter to one LO with `originator`. \"Listed now\" is the LO Borrower Retention tab's rule: an active MLS listing event in the last 90 days, list price at least $20k, not under contract. Checked weekly with the retention snapshot — `computedAt` says when. 404 means not computed for this company yet.",
|
|
56813
|
+
"operationId": "companyRetentionActiveListings",
|
|
56814
|
+
"parameters": [
|
|
56815
|
+
{
|
|
56816
|
+
"description": "Company NMLS ID",
|
|
56817
|
+
"in": "path",
|
|
56818
|
+
"name": "nmlsId",
|
|
56819
|
+
"required": true,
|
|
56820
|
+
"schema": {
|
|
56821
|
+
"description": "Company NMLS ID",
|
|
56822
|
+
"type": "string"
|
|
56823
|
+
}
|
|
56824
|
+
},
|
|
56825
|
+
{
|
|
56826
|
+
"description": "Only rows whose loan was written by this LO (NMLS id) — e.g. one of `activeListings.topOriginators`.",
|
|
56827
|
+
"in": "query",
|
|
56828
|
+
"name": "originator",
|
|
56829
|
+
"required": false,
|
|
56830
|
+
"schema": {
|
|
56831
|
+
"description": "Only rows whose loan was written by this LO (NMLS id) — e.g. one of `activeListings.topOriginators`.",
|
|
56832
|
+
"pattern": "^\\d+$",
|
|
56833
|
+
"type": "string"
|
|
56834
|
+
}
|
|
56835
|
+
},
|
|
56836
|
+
{
|
|
56837
|
+
"description": "Page size (1-100, default 25).",
|
|
56838
|
+
"in": "query",
|
|
56839
|
+
"name": "size",
|
|
56840
|
+
"required": false,
|
|
56841
|
+
"schema": {
|
|
56842
|
+
"description": "Page size (1-100, default 25).",
|
|
56843
|
+
"example": 25,
|
|
56844
|
+
"maximum": 100,
|
|
56845
|
+
"minimum": 1,
|
|
56846
|
+
"type": "integer"
|
|
56847
|
+
}
|
|
56848
|
+
},
|
|
56849
|
+
{
|
|
56850
|
+
"description": "Opaque cursor from the previous page's `cursor`.",
|
|
56851
|
+
"in": "query",
|
|
56852
|
+
"name": "cursor",
|
|
56853
|
+
"required": false,
|
|
56854
|
+
"schema": {
|
|
56855
|
+
"description": "Opaque cursor from the previous page's `cursor`.",
|
|
56856
|
+
"type": "string"
|
|
56857
|
+
}
|
|
56858
|
+
}
|
|
56859
|
+
],
|
|
56860
|
+
"responses": {
|
|
56861
|
+
"200": {
|
|
56862
|
+
"content": {
|
|
56863
|
+
"application/json": {
|
|
56864
|
+
"schema": {
|
|
56865
|
+
"$ref": "#/components/schemas/CompanyActiveListingsResponse"
|
|
56866
|
+
}
|
|
56867
|
+
}
|
|
56868
|
+
},
|
|
56869
|
+
"description": "One page of listing rows"
|
|
56870
|
+
},
|
|
56871
|
+
"400": {
|
|
56872
|
+
"content": {
|
|
56873
|
+
"application/json": {
|
|
56874
|
+
"schema": {
|
|
56875
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
56876
|
+
}
|
|
56877
|
+
}
|
|
56878
|
+
},
|
|
56879
|
+
"description": "Validation error"
|
|
56880
|
+
},
|
|
56881
|
+
"401": {
|
|
56882
|
+
"content": {
|
|
56883
|
+
"application/json": {
|
|
56884
|
+
"schema": {
|
|
56885
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
56886
|
+
}
|
|
56887
|
+
}
|
|
56888
|
+
},
|
|
56889
|
+
"description": "Unauthorized"
|
|
56890
|
+
},
|
|
56891
|
+
"403": {
|
|
56892
|
+
"content": {
|
|
56893
|
+
"application/json": {
|
|
56894
|
+
"schema": {
|
|
56895
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
56896
|
+
}
|
|
56897
|
+
}
|
|
56898
|
+
},
|
|
56899
|
+
"description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
|
|
56900
|
+
},
|
|
56901
|
+
"404": {
|
|
56902
|
+
"content": {
|
|
56903
|
+
"application/json": {
|
|
56904
|
+
"schema": {
|
|
56905
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
56906
|
+
}
|
|
56907
|
+
}
|
|
56908
|
+
},
|
|
56909
|
+
"description": "Not found"
|
|
56910
|
+
},
|
|
56911
|
+
"413": {
|
|
56912
|
+
"content": {
|
|
56913
|
+
"application/json": {
|
|
56914
|
+
"schema": {
|
|
56915
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
56916
|
+
}
|
|
56917
|
+
}
|
|
56918
|
+
},
|
|
56919
|
+
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
56920
|
+
},
|
|
56921
|
+
"503": {
|
|
56922
|
+
"content": {
|
|
56923
|
+
"application/json": {
|
|
56924
|
+
"schema": {
|
|
56925
|
+
"$ref": "#/components/schemas/SearchUnavailable"
|
|
56926
|
+
}
|
|
56927
|
+
}
|
|
56928
|
+
},
|
|
56929
|
+
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
56930
|
+
}
|
|
56931
|
+
},
|
|
56932
|
+
"summary": "Retained borrowers listed for sale now (weekly)",
|
|
56933
|
+
"tags": [
|
|
56934
|
+
"Companies"
|
|
56935
|
+
]
|
|
56936
|
+
}
|
|
56937
|
+
},
|
|
56651
56938
|
"/v1/companies/{nmlsId}/sponsored-individuals": {
|
|
56652
56939
|
"post": {
|
|
56653
56940
|
"operationId": "companySponsoredIndividuals",
|