@model-match/api 3.50.0 → 3.52.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 +13 -0
- package/dist/{index-CDZ5kWDW.d.mts → index-BmT-evv2.d.mts} +477 -14
- package/dist/index.d.mts +2 -2
- package/dist/index.mjs +1 -1
- package/dist/slim/index.d.mts +39 -3
- package/dist/slim/index.mjs +103 -3
- package/dist/{src-Djq2yv-x.mjs → src-mqocessM.mjs} +113 -1
- package/openapi.json +1008 -85
- 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-mqocessM.mjs";
|
|
2
2
|
//#region src/slim/sdk.gen.ts
|
|
3
3
|
/**
|
|
4
4
|
* Search agents with filters
|
|
@@ -1223,6 +1223,26 @@ const countBranches = (options) => (options?.client ?? client).post({
|
|
|
1223
1223
|
}
|
|
1224
1224
|
});
|
|
1225
1225
|
/**
|
|
1226
|
+
* Roll-up KPIs over the branches matching filters
|
|
1227
|
+
*
|
|
1228
|
+
* Accepts the same request body as `listBranches` (pagination and sort are ignored) and returns aggregate KPIs over every matching branch: count, producing count, average roster size, total units and the top 3 branches' units. Use it for a company's branch network summary (`flatFilters.company`).
|
|
1229
|
+
*/
|
|
1230
|
+
const branchStats = (options) => (options?.client ?? client).post({
|
|
1231
|
+
security: [{
|
|
1232
|
+
name: "x-api-key",
|
|
1233
|
+
type: "apiKey"
|
|
1234
|
+
}, {
|
|
1235
|
+
scheme: "bearer",
|
|
1236
|
+
type: "http"
|
|
1237
|
+
}],
|
|
1238
|
+
url: "/v1/branches/stats",
|
|
1239
|
+
...options,
|
|
1240
|
+
headers: {
|
|
1241
|
+
"Content-Type": "application/json",
|
|
1242
|
+
...options?.headers
|
|
1243
|
+
}
|
|
1244
|
+
});
|
|
1245
|
+
/**
|
|
1226
1246
|
* Get branch by NMLS ID
|
|
1227
1247
|
*
|
|
1228
1248
|
* Retrieve full details for a single NMLS mortgage branch including name, address, parent company, managers, trade names, licensing, and branch-level production for the selected period.
|
|
@@ -1359,6 +1379,22 @@ const branchTitleCompanies = (options) => (options.client ?? client).post({
|
|
|
1359
1379
|
}
|
|
1360
1380
|
});
|
|
1361
1381
|
/**
|
|
1382
|
+
* Community Lending map: geocoded loans + per-tract counts
|
|
1383
|
+
*
|
|
1384
|
+
* Map points for loans written by this branch's current roster in the period that resolved to a Census tract, newest first (up to 4,000), plus a per-tract loan count keyed by 11-digit tract GEOID for a choropleth.
|
|
1385
|
+
*/
|
|
1386
|
+
const branchCommunityLendingMap = (options) => (options.client ?? client).get({
|
|
1387
|
+
security: [{
|
|
1388
|
+
name: "x-api-key",
|
|
1389
|
+
type: "apiKey"
|
|
1390
|
+
}, {
|
|
1391
|
+
scheme: "bearer",
|
|
1392
|
+
type: "http"
|
|
1393
|
+
}],
|
|
1394
|
+
url: "/v1/branches/{nmlsId}/community-lending/map",
|
|
1395
|
+
...options
|
|
1396
|
+
});
|
|
1397
|
+
/**
|
|
1362
1398
|
* Loans written by this branch
|
|
1363
1399
|
*
|
|
1364
1400
|
* Returns the individual loans attributed to this branch office — the branch's own book, not its parent company's. Accepts the same filters, sorts and pagination as the main loan search. Attribution comes from public record, so this is the branch's recorded footprint and can be smaller than the production totals on `GET /v1/branches/{nmlsId}`.
|
|
@@ -1807,6 +1843,38 @@ const companyZipCodes = (options) => (options.client ?? client).post({
|
|
|
1807
1843
|
}
|
|
1808
1844
|
});
|
|
1809
1845
|
/**
|
|
1846
|
+
* Community Lending peer benchmark (LMI / majority-minority)
|
|
1847
|
+
*
|
|
1848
|
+
* Percentile rank and peer average of this entity's low- or moderate-income and majority-minority neighborhood shares, against peers producing in its top 12 states by units. `data` is null when the entity has no neighborhood-resolved loans in the period.
|
|
1849
|
+
*/
|
|
1850
|
+
const companyCommunityLendingBenchmark = (options) => (options.client ?? client).get({
|
|
1851
|
+
security: [{
|
|
1852
|
+
name: "x-api-key",
|
|
1853
|
+
type: "apiKey"
|
|
1854
|
+
}, {
|
|
1855
|
+
scheme: "bearer",
|
|
1856
|
+
type: "http"
|
|
1857
|
+
}],
|
|
1858
|
+
url: "/v1/companies/{nmlsId}/community-lending/benchmark",
|
|
1859
|
+
...options
|
|
1860
|
+
});
|
|
1861
|
+
/**
|
|
1862
|
+
* Community Lending map: geocoded loans + per-tract counts
|
|
1863
|
+
*
|
|
1864
|
+
* Map points for loans naming this company on the loan document in the period that resolved to a Census tract, newest first (up to 4,000), plus a per-tract loan count keyed by 11-digit tract GEOID for a choropleth.
|
|
1865
|
+
*/
|
|
1866
|
+
const companyCommunityLendingMap = (options) => (options.client ?? client).get({
|
|
1867
|
+
security: [{
|
|
1868
|
+
name: "x-api-key",
|
|
1869
|
+
type: "apiKey"
|
|
1870
|
+
}, {
|
|
1871
|
+
scheme: "bearer",
|
|
1872
|
+
type: "http"
|
|
1873
|
+
}],
|
|
1874
|
+
url: "/v1/companies/{nmlsId}/community-lending/map",
|
|
1875
|
+
...options
|
|
1876
|
+
});
|
|
1877
|
+
/**
|
|
1810
1878
|
* How many of a company's exits work elsewhere today
|
|
1811
1879
|
*
|
|
1812
1880
|
* The window's complete departures, split by whether each loan officer's current employer on file is another company. One aggregate — no rows.
|
|
@@ -2685,7 +2753,7 @@ const getCrmList = (options) => (options.client ?? client).get({
|
|
|
2685
2753
|
...options
|
|
2686
2754
|
});
|
|
2687
2755
|
/**
|
|
2688
|
-
* Update a list's name, visibility,
|
|
2756
|
+
* Update a list's name, visibility, whole-org role, or default view
|
|
2689
2757
|
*/
|
|
2690
2758
|
const updateCrmList = (options) => (options.client ?? client).patch({
|
|
2691
2759
|
security: [{
|
|
@@ -5391,6 +5459,38 @@ const originatorZipCodes = (options) => (options.client ?? client).post({
|
|
|
5391
5459
|
}
|
|
5392
5460
|
});
|
|
5393
5461
|
/**
|
|
5462
|
+
* Community Lending peer benchmark (LMI / majority-minority)
|
|
5463
|
+
*
|
|
5464
|
+
* Percentile rank and peer average of this entity's low- or moderate-income and majority-minority neighborhood shares, against peers producing in its top 12 states by units. `data` is null when the entity has no neighborhood-resolved loans in the period.
|
|
5465
|
+
*/
|
|
5466
|
+
const originatorCommunityLendingBenchmark = (options) => (options.client ?? client).get({
|
|
5467
|
+
security: [{
|
|
5468
|
+
name: "x-api-key",
|
|
5469
|
+
type: "apiKey"
|
|
5470
|
+
}, {
|
|
5471
|
+
scheme: "bearer",
|
|
5472
|
+
type: "http"
|
|
5473
|
+
}],
|
|
5474
|
+
url: "/v1/originators/{nmlsId}/community-lending/benchmark",
|
|
5475
|
+
...options
|
|
5476
|
+
});
|
|
5477
|
+
/**
|
|
5478
|
+
* Community Lending map: geocoded loans + per-tract counts
|
|
5479
|
+
*
|
|
5480
|
+
* Map points for this loan officer's loans in the period that resolved to a Census tract, newest first (up to 4,000), plus a per-tract loan count keyed by 11-digit tract GEOID for a choropleth.
|
|
5481
|
+
*/
|
|
5482
|
+
const originatorCommunityLendingMap = (options) => (options.client ?? client).get({
|
|
5483
|
+
security: [{
|
|
5484
|
+
name: "x-api-key",
|
|
5485
|
+
type: "apiKey"
|
|
5486
|
+
}, {
|
|
5487
|
+
scheme: "bearer",
|
|
5488
|
+
type: "http"
|
|
5489
|
+
}],
|
|
5490
|
+
url: "/v1/originators/{nmlsId}/community-lending/map",
|
|
5491
|
+
...options
|
|
5492
|
+
});
|
|
5493
|
+
/**
|
|
5394
5494
|
* Loans originated by this LO
|
|
5395
5495
|
*/
|
|
5396
5496
|
const originatorLoans = (options) => (options.client ?? client).post({
|
|
@@ -6095,4 +6195,4 @@ const getSearchToken = (options) => (options?.client ?? client).get({
|
|
|
6095
6195
|
...options
|
|
6096
6196
|
});
|
|
6097
6197
|
//#endregion
|
|
6098
|
-
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, branchCounties, branchLenders, branchLoans, branchOriginators, branchRoster, branchStates, branchTitleCompanies, cancelAgentsBulkDeliveryJob, cancelBranchesBulkDeliveryJob, cancelCompaniesBulkDeliveryJob, cancelEnrichBulkJob, cancelLoansBulkDeliveryJob, cancelOriginatorsBulkDeliveryJob, cancelPropertiesBulkDeliveryJob, checkCrmImport, companyAgents, companyAnalyticsChart, companyAnalyticsSummary, companyAnalyticsTimeSeries, companyBranches, companyBrokers, companyCities, 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, officeAgents, officeBuilders, officeLenders, officeLoanTypes, officeOriginators, originatorAgents, originatorAnalyticsChart, originatorAnalyticsSummary, originatorAnalyticsTimeSeries, originatorBranches, originatorBrokers, originatorBuilders, originatorCitiesBreakdown, 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 };
|
|
6198
|
+
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, 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 };
|
|
@@ -2074,6 +2074,28 @@ var Branches = class {
|
|
|
2074
2074
|
});
|
|
2075
2075
|
}
|
|
2076
2076
|
/**
|
|
2077
|
+
* Roll-up KPIs over the branches matching filters
|
|
2078
|
+
*
|
|
2079
|
+
* Accepts the same request body as `listBranches` (pagination and sort are ignored) and returns aggregate KPIs over every matching branch: count, producing count, average roster size, total units and the top 3 branches' units. Use it for a company's branch network summary (`flatFilters.company`).
|
|
2080
|
+
*/
|
|
2081
|
+
static stats(options) {
|
|
2082
|
+
return (options?.client ?? client).post({
|
|
2083
|
+
security: [{
|
|
2084
|
+
name: "x-api-key",
|
|
2085
|
+
type: "apiKey"
|
|
2086
|
+
}, {
|
|
2087
|
+
scheme: "bearer",
|
|
2088
|
+
type: "http"
|
|
2089
|
+
}],
|
|
2090
|
+
url: "/v1/branches/stats",
|
|
2091
|
+
...options,
|
|
2092
|
+
headers: {
|
|
2093
|
+
"Content-Type": "application/json",
|
|
2094
|
+
...options?.headers
|
|
2095
|
+
}
|
|
2096
|
+
});
|
|
2097
|
+
}
|
|
2098
|
+
/**
|
|
2077
2099
|
* Get branch by NMLS ID
|
|
2078
2100
|
*
|
|
2079
2101
|
* Retrieve full details for a single NMLS mortgage branch including name, address, parent company, managers, trade names, licensing, and branch-level production for the selected period.
|
|
@@ -2224,6 +2246,24 @@ var Branches = class {
|
|
|
2224
2246
|
});
|
|
2225
2247
|
}
|
|
2226
2248
|
/**
|
|
2249
|
+
* Community Lending map: geocoded loans + per-tract counts
|
|
2250
|
+
*
|
|
2251
|
+
* Map points for loans written by this branch's current roster in the period that resolved to a Census tract, newest first (up to 4,000), plus a per-tract loan count keyed by 11-digit tract GEOID for a choropleth.
|
|
2252
|
+
*/
|
|
2253
|
+
static communityLendingMap(options) {
|
|
2254
|
+
return (options.client ?? client).get({
|
|
2255
|
+
security: [{
|
|
2256
|
+
name: "x-api-key",
|
|
2257
|
+
type: "apiKey"
|
|
2258
|
+
}, {
|
|
2259
|
+
scheme: "bearer",
|
|
2260
|
+
type: "http"
|
|
2261
|
+
}],
|
|
2262
|
+
url: "/v1/branches/{nmlsId}/community-lending/map",
|
|
2263
|
+
...options
|
|
2264
|
+
});
|
|
2265
|
+
}
|
|
2266
|
+
/**
|
|
2227
2267
|
* Loans written by this branch
|
|
2228
2268
|
*
|
|
2229
2269
|
* Returns the individual loans attributed to this branch office — the branch's own book, not its parent company's. Accepts the same filters, sorts and pagination as the main loan search. Attribution comes from public record, so this is the branch's recorded footprint and can be smaller than the production totals on `GET /v1/branches/{nmlsId}`.
|
|
@@ -2704,6 +2744,42 @@ var Companies = class {
|
|
|
2704
2744
|
});
|
|
2705
2745
|
}
|
|
2706
2746
|
/**
|
|
2747
|
+
* Community Lending peer benchmark (LMI / majority-minority)
|
|
2748
|
+
*
|
|
2749
|
+
* Percentile rank and peer average of this entity's low- or moderate-income and majority-minority neighborhood shares, against peers producing in its top 12 states by units. `data` is null when the entity has no neighborhood-resolved loans in the period.
|
|
2750
|
+
*/
|
|
2751
|
+
static communityLendingBenchmark(options) {
|
|
2752
|
+
return (options.client ?? client).get({
|
|
2753
|
+
security: [{
|
|
2754
|
+
name: "x-api-key",
|
|
2755
|
+
type: "apiKey"
|
|
2756
|
+
}, {
|
|
2757
|
+
scheme: "bearer",
|
|
2758
|
+
type: "http"
|
|
2759
|
+
}],
|
|
2760
|
+
url: "/v1/companies/{nmlsId}/community-lending/benchmark",
|
|
2761
|
+
...options
|
|
2762
|
+
});
|
|
2763
|
+
}
|
|
2764
|
+
/**
|
|
2765
|
+
* Community Lending map: geocoded loans + per-tract counts
|
|
2766
|
+
*
|
|
2767
|
+
* Map points for loans naming this company on the loan document in the period that resolved to a Census tract, newest first (up to 4,000), plus a per-tract loan count keyed by 11-digit tract GEOID for a choropleth.
|
|
2768
|
+
*/
|
|
2769
|
+
static communityLendingMap(options) {
|
|
2770
|
+
return (options.client ?? client).get({
|
|
2771
|
+
security: [{
|
|
2772
|
+
name: "x-api-key",
|
|
2773
|
+
type: "apiKey"
|
|
2774
|
+
}, {
|
|
2775
|
+
scheme: "bearer",
|
|
2776
|
+
type: "http"
|
|
2777
|
+
}],
|
|
2778
|
+
url: "/v1/companies/{nmlsId}/community-lending/map",
|
|
2779
|
+
...options
|
|
2780
|
+
});
|
|
2781
|
+
}
|
|
2782
|
+
/**
|
|
2707
2783
|
* How many of a company's exits work elsewhere today
|
|
2708
2784
|
*
|
|
2709
2785
|
* The window's complete departures, split by whether each loan officer's current employer on file is another company. One aggregate — no rows.
|
|
@@ -3692,7 +3768,7 @@ var Crm = class {
|
|
|
3692
3768
|
});
|
|
3693
3769
|
}
|
|
3694
3770
|
/**
|
|
3695
|
-
* Update a list's name, visibility,
|
|
3771
|
+
* Update a list's name, visibility, whole-org role, or default view
|
|
3696
3772
|
*/
|
|
3697
3773
|
static updateCrmList(options) {
|
|
3698
3774
|
return (options.client ?? client).patch({
|
|
@@ -6708,6 +6784,42 @@ var Originators = class {
|
|
|
6708
6784
|
});
|
|
6709
6785
|
}
|
|
6710
6786
|
/**
|
|
6787
|
+
* Community Lending peer benchmark (LMI / majority-minority)
|
|
6788
|
+
*
|
|
6789
|
+
* Percentile rank and peer average of this entity's low- or moderate-income and majority-minority neighborhood shares, against peers producing in its top 12 states by units. `data` is null when the entity has no neighborhood-resolved loans in the period.
|
|
6790
|
+
*/
|
|
6791
|
+
static communityLendingBenchmark(options) {
|
|
6792
|
+
return (options.client ?? client).get({
|
|
6793
|
+
security: [{
|
|
6794
|
+
name: "x-api-key",
|
|
6795
|
+
type: "apiKey"
|
|
6796
|
+
}, {
|
|
6797
|
+
scheme: "bearer",
|
|
6798
|
+
type: "http"
|
|
6799
|
+
}],
|
|
6800
|
+
url: "/v1/originators/{nmlsId}/community-lending/benchmark",
|
|
6801
|
+
...options
|
|
6802
|
+
});
|
|
6803
|
+
}
|
|
6804
|
+
/**
|
|
6805
|
+
* Community Lending map: geocoded loans + per-tract counts
|
|
6806
|
+
*
|
|
6807
|
+
* Map points for this loan officer's loans in the period that resolved to a Census tract, newest first (up to 4,000), plus a per-tract loan count keyed by 11-digit tract GEOID for a choropleth.
|
|
6808
|
+
*/
|
|
6809
|
+
static communityLendingMap(options) {
|
|
6810
|
+
return (options.client ?? client).get({
|
|
6811
|
+
security: [{
|
|
6812
|
+
name: "x-api-key",
|
|
6813
|
+
type: "apiKey"
|
|
6814
|
+
}, {
|
|
6815
|
+
scheme: "bearer",
|
|
6816
|
+
type: "http"
|
|
6817
|
+
}],
|
|
6818
|
+
url: "/v1/originators/{nmlsId}/community-lending/map",
|
|
6819
|
+
...options
|
|
6820
|
+
});
|
|
6821
|
+
}
|
|
6822
|
+
/**
|
|
6711
6823
|
* Loans originated by this LO
|
|
6712
6824
|
*/
|
|
6713
6825
|
static loans(options) {
|