@model-match/api 3.45.0 → 3.46.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 +7 -0
- package/dist/{index-DMqIgBZb.d.mts → index-D5lJRhPf.d.mts} +103 -2
- package/dist/index.d.mts +2 -2
- package/dist/index.mjs +1 -1
- package/dist/slim/index.d.mts +9 -3
- package/dist/slim/index.mjs +19 -3
- package/dist/{src-DCqOC4qE.mjs → src-B0B4SZ9p.mjs} +19 -1
- package/openapi.json +233 -2
- 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-B0B4SZ9p.mjs";
|
|
2
2
|
//#region src/slim/sdk.gen.ts
|
|
3
3
|
/**
|
|
4
4
|
* Search agents with filters
|
|
@@ -175,6 +175,22 @@ const countAgents = (options) => (options?.client ?? client).post({
|
|
|
175
175
|
}
|
|
176
176
|
});
|
|
177
177
|
/**
|
|
178
|
+
* List agent office groups
|
|
179
|
+
*
|
|
180
|
+
* The brokerage brand groups this workspace may pass as `officeGroups` / `excludeOfficeGroups` on `listAgents`. Entitlement-gated: a workspace without the entitlement gets an empty list.
|
|
181
|
+
*/
|
|
182
|
+
const listAgentOfficeGroups = (options) => (options?.client ?? client).get({
|
|
183
|
+
security: [{
|
|
184
|
+
name: "x-api-key",
|
|
185
|
+
type: "apiKey"
|
|
186
|
+
}, {
|
|
187
|
+
scheme: "bearer",
|
|
188
|
+
type: "http"
|
|
189
|
+
}],
|
|
190
|
+
url: "/v1/agents/office-groups",
|
|
191
|
+
...options
|
|
192
|
+
});
|
|
193
|
+
/**
|
|
178
194
|
* Get agent by ID
|
|
179
195
|
*/
|
|
180
196
|
const getAgent = (options) => (options.client ?? client).get({
|
|
@@ -5065,7 +5081,7 @@ const getOriginator = (options) => (options.client ?? client).get({
|
|
|
5065
5081
|
/**
|
|
5066
5082
|
* Real-estate agents this LO co-closed with
|
|
5067
5083
|
*
|
|
5068
|
-
* Ranks the real-estate agents on this LO's loans, by volume — the buyer's agent by default, the listing and co-listing agents with `side: "listing"`. Each loan is credited to the agent its MLS agent keys resolve to (a key naming several different people credits only the confirmed one), so `units` counts distinct loans per agent. `id` is that agent's id (pass it to `GET /v1/agents/{id}`); absent when the loan's key matches no agent profile, in which case `label` is the name the MLS recorded. Names that are an MLS placeholder for "no agent recorded" (`non member`, `non listed agent`, and ~140 board-specific spellings) are excluded — they are not people. Percentages are shares of the LO's whole loan population, so they do not sum to 100 across the page.
|
|
5084
|
+
* Ranks the real-estate agents on this LO's loans, by volume — the buyer's agent by default, the listing and co-listing agents with `side: "listing"`. Each loan is credited to the agent its MLS agent keys resolve to (a key naming several different people credits only the confirmed one), so `units` counts distinct loans per agent. `id` is that agent's id (pass it to `GET /v1/agents/{id}`) and `office` / `contact` its brokerage and email / direct phone; absent when the loan's key matches no agent profile, in which case `label` is the name the MLS recorded. Names that are an MLS placeholder for "no agent recorded" (`non member`, `non listed agent`, and ~140 board-specific spellings) are excluded — they are not people. Percentages are shares of the LO's whole loan population, so they do not sum to 100 across the page.
|
|
5069
5085
|
*/
|
|
5070
5086
|
const originatorAgents = (options) => (options.client ?? client).post({
|
|
5071
5087
|
security: [{
|
|
@@ -5915,4 +5931,4 @@ const getSearchToken = (options) => (options?.client ?? client).get({
|
|
|
5915
5931
|
...options
|
|
5916
5932
|
});
|
|
5917
5933
|
//#endregion
|
|
5918
|
-
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, 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, 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, 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 };
|
|
5934
|
+
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, 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, listAgentOfficeGroups, 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, 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, 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 };
|
|
@@ -812,6 +812,24 @@ var Agents = class {
|
|
|
812
812
|
});
|
|
813
813
|
}
|
|
814
814
|
/**
|
|
815
|
+
* List agent office groups
|
|
816
|
+
*
|
|
817
|
+
* The brokerage brand groups this workspace may pass as `officeGroups` / `excludeOfficeGroups` on `listAgents`. Entitlement-gated: a workspace without the entitlement gets an empty list.
|
|
818
|
+
*/
|
|
819
|
+
static listAgentOfficeGroups(options) {
|
|
820
|
+
return (options?.client ?? client).get({
|
|
821
|
+
security: [{
|
|
822
|
+
name: "x-api-key",
|
|
823
|
+
type: "apiKey"
|
|
824
|
+
}, {
|
|
825
|
+
scheme: "bearer",
|
|
826
|
+
type: "http"
|
|
827
|
+
}],
|
|
828
|
+
url: "/v1/agents/office-groups",
|
|
829
|
+
...options
|
|
830
|
+
});
|
|
831
|
+
}
|
|
832
|
+
/**
|
|
815
833
|
* Get agent by ID
|
|
816
834
|
*/
|
|
817
835
|
static get(options) {
|
|
@@ -6344,7 +6362,7 @@ var Originators = class {
|
|
|
6344
6362
|
/**
|
|
6345
6363
|
* Real-estate agents this LO co-closed with
|
|
6346
6364
|
*
|
|
6347
|
-
* Ranks the real-estate agents on this LO's loans, by volume — the buyer's agent by default, the listing and co-listing agents with `side: "listing"`. Each loan is credited to the agent its MLS agent keys resolve to (a key naming several different people credits only the confirmed one), so `units` counts distinct loans per agent. `id` is that agent's id (pass it to `GET /v1/agents/{id}`); absent when the loan's key matches no agent profile, in which case `label` is the name the MLS recorded. Names that are an MLS placeholder for "no agent recorded" (`non member`, `non listed agent`, and ~140 board-specific spellings) are excluded — they are not people. Percentages are shares of the LO's whole loan population, so they do not sum to 100 across the page.
|
|
6365
|
+
* Ranks the real-estate agents on this LO's loans, by volume — the buyer's agent by default, the listing and co-listing agents with `side: "listing"`. Each loan is credited to the agent its MLS agent keys resolve to (a key naming several different people credits only the confirmed one), so `units` counts distinct loans per agent. `id` is that agent's id (pass it to `GET /v1/agents/{id}`) and `office` / `contact` its brokerage and email / direct phone; absent when the loan's key matches no agent profile, in which case `label` is the name the MLS recorded. Names that are an MLS placeholder for "no agent recorded" (`non member`, `non listed agent`, and ~140 board-specific spellings) are excluded — they are not people. Percentages are shares of the LO's whole loan population, so they do not sum to 100 across the page.
|
|
6348
6366
|
*/
|
|
6349
6367
|
static agents(options) {
|
|
6350
6368
|
return (options.client ?? client).post({
|
package/openapi.json
CHANGED
|
@@ -585,6 +585,22 @@
|
|
|
585
585
|
"crmList": {
|
|
586
586
|
"$ref": "#/components/schemas/AgentCrmListFilter"
|
|
587
587
|
},
|
|
588
|
+
"excludeOfficeGroups": {
|
|
589
|
+
"description": "Drop these brand groups (same gate).",
|
|
590
|
+
"items": {
|
|
591
|
+
"enum": [
|
|
592
|
+
"compass_legacy",
|
|
593
|
+
"anywhere",
|
|
594
|
+
"franchise",
|
|
595
|
+
"others"
|
|
596
|
+
],
|
|
597
|
+
"type": "string"
|
|
598
|
+
},
|
|
599
|
+
"maxItems": 4,
|
|
600
|
+
"minItems": 1,
|
|
601
|
+
"type": "array",
|
|
602
|
+
"x-mm-entitlement": "rocket-filter"
|
|
603
|
+
},
|
|
588
604
|
"filters": {
|
|
589
605
|
"$ref": "#/components/schemas/FilterNode"
|
|
590
606
|
},
|
|
@@ -1053,6 +1069,22 @@
|
|
|
1053
1069
|
"near": {
|
|
1054
1070
|
"$ref": "#/components/schemas/AgentNearFilter"
|
|
1055
1071
|
},
|
|
1072
|
+
"officeGroups": {
|
|
1073
|
+
"description": "Current office in any of these brand groups. Needs the `rocket-filter` entitlement (else 403).",
|
|
1074
|
+
"items": {
|
|
1075
|
+
"enum": [
|
|
1076
|
+
"compass_legacy",
|
|
1077
|
+
"anywhere",
|
|
1078
|
+
"franchise",
|
|
1079
|
+
"others"
|
|
1080
|
+
],
|
|
1081
|
+
"type": "string"
|
|
1082
|
+
},
|
|
1083
|
+
"maxItems": 4,
|
|
1084
|
+
"minItems": 1,
|
|
1085
|
+
"type": "array",
|
|
1086
|
+
"x-mm-entitlement": "rocket-filter"
|
|
1087
|
+
},
|
|
1056
1088
|
"pagination": {
|
|
1057
1089
|
"$ref": "#/components/schemas/Pagination"
|
|
1058
1090
|
},
|
|
@@ -2633,6 +2665,52 @@
|
|
|
2633
2665
|
"minItems": 1,
|
|
2634
2666
|
"type": "array"
|
|
2635
2667
|
},
|
|
2668
|
+
"AgentOfficeGroup": {
|
|
2669
|
+
"properties": {
|
|
2670
|
+
"entries": {
|
|
2671
|
+
"items": {
|
|
2672
|
+
"$ref": "#/components/schemas/AgentOfficeGroupEntry"
|
|
2673
|
+
},
|
|
2674
|
+
"type": "array"
|
|
2675
|
+
},
|
|
2676
|
+
"key": {
|
|
2677
|
+
"type": "string"
|
|
2678
|
+
},
|
|
2679
|
+
"label": {
|
|
2680
|
+
"type": "string"
|
|
2681
|
+
}
|
|
2682
|
+
},
|
|
2683
|
+
"required": [
|
|
2684
|
+
"key",
|
|
2685
|
+
"label",
|
|
2686
|
+
"entries"
|
|
2687
|
+
],
|
|
2688
|
+
"type": "object"
|
|
2689
|
+
},
|
|
2690
|
+
"AgentOfficeGroupEntry": {
|
|
2691
|
+
"properties": {
|
|
2692
|
+
"displayName": {
|
|
2693
|
+
"type": "string"
|
|
2694
|
+
},
|
|
2695
|
+
"matchType": {
|
|
2696
|
+
"enum": [
|
|
2697
|
+
"contains",
|
|
2698
|
+
"prefix",
|
|
2699
|
+
"all_words"
|
|
2700
|
+
],
|
|
2701
|
+
"type": "string"
|
|
2702
|
+
},
|
|
2703
|
+
"name": {
|
|
2704
|
+
"type": "string"
|
|
2705
|
+
}
|
|
2706
|
+
},
|
|
2707
|
+
"required": [
|
|
2708
|
+
"name",
|
|
2709
|
+
"displayName",
|
|
2710
|
+
"matchType"
|
|
2711
|
+
],
|
|
2712
|
+
"type": "object"
|
|
2713
|
+
},
|
|
2636
2714
|
"AgentProductMixEntry": {
|
|
2637
2715
|
"additionalProperties": false,
|
|
2638
2716
|
"properties": {
|
|
@@ -10171,6 +10249,25 @@
|
|
|
10171
10249
|
],
|
|
10172
10250
|
"type": "object"
|
|
10173
10251
|
},
|
|
10252
|
+
"contact": {
|
|
10253
|
+
"description": "`originatorAgents` only: the agent's email and direct phone — the same `email` / `phone` `GET /v1/agents/{id}` and the agents list report. Each leaf is `null` when the agent's record has none; `null` when the agent `id` matches no record. Absent on rows without an agent `id` and on every other breakdown.",
|
|
10254
|
+
"nullable": true,
|
|
10255
|
+
"properties": {
|
|
10256
|
+
"email": {
|
|
10257
|
+
"nullable": true,
|
|
10258
|
+
"type": "string"
|
|
10259
|
+
},
|
|
10260
|
+
"phone": {
|
|
10261
|
+
"nullable": true,
|
|
10262
|
+
"type": "string"
|
|
10263
|
+
}
|
|
10264
|
+
},
|
|
10265
|
+
"required": [
|
|
10266
|
+
"email",
|
|
10267
|
+
"phone"
|
|
10268
|
+
],
|
|
10269
|
+
"type": "object"
|
|
10270
|
+
},
|
|
10174
10271
|
"excluded": {
|
|
10175
10272
|
"description": "How many of this bucket's documents the volume guard excluded — documents that carry the money field but whose value is an out-of-range fill. Compare against `units` to see what share of the bucket `volume` was actually computed over: a bucket can show many units and still sum a small fraction of them. Absent when the entity's money column is unguarded (the sales-backed agent breakdowns), where nothing can be excluded.",
|
|
10176
10273
|
"type": "number"
|
|
@@ -26247,6 +26344,11 @@
|
|
|
26247
26344
|
"nullable": true,
|
|
26248
26345
|
"type": "string"
|
|
26249
26346
|
},
|
|
26347
|
+
"coListAgentEmail": {
|
|
26348
|
+
"description": "Co-listing agent email, same rule.",
|
|
26349
|
+
"nullable": true,
|
|
26350
|
+
"type": "string"
|
|
26351
|
+
},
|
|
26250
26352
|
"coListAgentId": {
|
|
26251
26353
|
"description": "Co-listing agent id, same rule.",
|
|
26252
26354
|
"nullable": true,
|
|
@@ -26257,6 +26359,11 @@
|
|
|
26257
26359
|
"nullable": true,
|
|
26258
26360
|
"type": "string"
|
|
26259
26361
|
},
|
|
26362
|
+
"coListAgentPhone": {
|
|
26363
|
+
"description": "Co-listing agent direct phone, same rule.",
|
|
26364
|
+
"nullable": true,
|
|
26365
|
+
"type": "string"
|
|
26366
|
+
},
|
|
26260
26367
|
"companyName": {
|
|
26261
26368
|
"nullable": true,
|
|
26262
26369
|
"type": "string"
|
|
@@ -26315,6 +26422,11 @@
|
|
|
26315
26422
|
"nullable": true,
|
|
26316
26423
|
"type": "string"
|
|
26317
26424
|
},
|
|
26425
|
+
"listAgentEmail": {
|
|
26426
|
+
"description": "Listing agent email, same rule.",
|
|
26427
|
+
"nullable": true,
|
|
26428
|
+
"type": "string"
|
|
26429
|
+
},
|
|
26318
26430
|
"listAgentId": {
|
|
26319
26431
|
"description": "Listing agent id, same rule.",
|
|
26320
26432
|
"nullable": true,
|
|
@@ -26325,6 +26437,11 @@
|
|
|
26325
26437
|
"nullable": true,
|
|
26326
26438
|
"type": "string"
|
|
26327
26439
|
},
|
|
26440
|
+
"listAgentPhone": {
|
|
26441
|
+
"description": "Listing agent direct phone, same rule.",
|
|
26442
|
+
"nullable": true,
|
|
26443
|
+
"type": "string"
|
|
26444
|
+
},
|
|
26328
26445
|
"listPrice": {
|
|
26329
26446
|
"nullable": true,
|
|
26330
26447
|
"type": "number"
|
|
@@ -26391,6 +26508,11 @@
|
|
|
26391
26508
|
"nullable": true,
|
|
26392
26509
|
"type": "string"
|
|
26393
26510
|
},
|
|
26511
|
+
"soldAgentEmail": {
|
|
26512
|
+
"description": "Buyer's agent email — the agent record's `email` (`GET /v1/agents/{id}`); null when `soldAgentId` is.",
|
|
26513
|
+
"nullable": true,
|
|
26514
|
+
"type": "string"
|
|
26515
|
+
},
|
|
26394
26516
|
"soldAgentId": {
|
|
26395
26517
|
"description": "Buyer's agent id (`GET /v1/agents/{id}`) when the MLS keys resolve to one agent.",
|
|
26396
26518
|
"nullable": true,
|
|
@@ -26401,6 +26523,11 @@
|
|
|
26401
26523
|
"nullable": true,
|
|
26402
26524
|
"type": "string"
|
|
26403
26525
|
},
|
|
26526
|
+
"soldAgentPhone": {
|
|
26527
|
+
"description": "Buyer's agent direct phone — the agent record's `phone`; null when `soldAgentId` is.",
|
|
26528
|
+
"nullable": true,
|
|
26529
|
+
"type": "string"
|
|
26530
|
+
},
|
|
26404
26531
|
"state": {
|
|
26405
26532
|
"nullable": true,
|
|
26406
26533
|
"type": "string"
|
|
@@ -42197,7 +42324,7 @@
|
|
|
42197
42324
|
"info": {
|
|
42198
42325
|
"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.",
|
|
42199
42326
|
"title": "ModelMatch API",
|
|
42200
|
-
"version": "3.
|
|
42327
|
+
"version": "3.107.0"
|
|
42201
42328
|
},
|
|
42202
42329
|
"openapi": "3.1.0",
|
|
42203
42330
|
"paths": {
|
|
@@ -43071,6 +43198,110 @@
|
|
|
43071
43198
|
"x-mm-records-via": "listAgents"
|
|
43072
43199
|
}
|
|
43073
43200
|
},
|
|
43201
|
+
"/v1/agents/office-groups": {
|
|
43202
|
+
"get": {
|
|
43203
|
+
"description": "The brokerage brand groups this workspace may pass as `officeGroups` / `excludeOfficeGroups` on `listAgents`. Entitlement-gated: a workspace without the entitlement gets an empty list.",
|
|
43204
|
+
"operationId": "listAgentOfficeGroups",
|
|
43205
|
+
"responses": {
|
|
43206
|
+
"200": {
|
|
43207
|
+
"content": {
|
|
43208
|
+
"application/json": {
|
|
43209
|
+
"schema": {
|
|
43210
|
+
"properties": {
|
|
43211
|
+
"data": {
|
|
43212
|
+
"items": {
|
|
43213
|
+
"$ref": "#/components/schemas/AgentOfficeGroup"
|
|
43214
|
+
},
|
|
43215
|
+
"type": "array"
|
|
43216
|
+
}
|
|
43217
|
+
},
|
|
43218
|
+
"required": [
|
|
43219
|
+
"data"
|
|
43220
|
+
],
|
|
43221
|
+
"type": "object"
|
|
43222
|
+
}
|
|
43223
|
+
}
|
|
43224
|
+
},
|
|
43225
|
+
"description": "Office groups the workspace is entitled to"
|
|
43226
|
+
},
|
|
43227
|
+
"400": {
|
|
43228
|
+
"content": {
|
|
43229
|
+
"application/json": {
|
|
43230
|
+
"schema": {
|
|
43231
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
43232
|
+
}
|
|
43233
|
+
}
|
|
43234
|
+
},
|
|
43235
|
+
"description": "Validation error"
|
|
43236
|
+
},
|
|
43237
|
+
"401": {
|
|
43238
|
+
"content": {
|
|
43239
|
+
"application/json": {
|
|
43240
|
+
"schema": {
|
|
43241
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
43242
|
+
}
|
|
43243
|
+
}
|
|
43244
|
+
},
|
|
43245
|
+
"description": "Unauthorized"
|
|
43246
|
+
},
|
|
43247
|
+
"403": {
|
|
43248
|
+
"content": {
|
|
43249
|
+
"application/json": {
|
|
43250
|
+
"schema": {
|
|
43251
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
43252
|
+
}
|
|
43253
|
+
}
|
|
43254
|
+
},
|
|
43255
|
+
"description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
|
|
43256
|
+
},
|
|
43257
|
+
"404": {
|
|
43258
|
+
"content": {
|
|
43259
|
+
"application/json": {
|
|
43260
|
+
"schema": {
|
|
43261
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
43262
|
+
}
|
|
43263
|
+
}
|
|
43264
|
+
},
|
|
43265
|
+
"description": "Not found"
|
|
43266
|
+
},
|
|
43267
|
+
"413": {
|
|
43268
|
+
"content": {
|
|
43269
|
+
"application/json": {
|
|
43270
|
+
"schema": {
|
|
43271
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
43272
|
+
}
|
|
43273
|
+
}
|
|
43274
|
+
},
|
|
43275
|
+
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
43276
|
+
},
|
|
43277
|
+
"502": {
|
|
43278
|
+
"content": {
|
|
43279
|
+
"application/json": {
|
|
43280
|
+
"schema": {
|
|
43281
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
43282
|
+
}
|
|
43283
|
+
}
|
|
43284
|
+
},
|
|
43285
|
+
"description": "Entitlements could not be resolved"
|
|
43286
|
+
},
|
|
43287
|
+
"503": {
|
|
43288
|
+
"content": {
|
|
43289
|
+
"application/json": {
|
|
43290
|
+
"schema": {
|
|
43291
|
+
"$ref": "#/components/schemas/SearchUnavailable"
|
|
43292
|
+
}
|
|
43293
|
+
}
|
|
43294
|
+
},
|
|
43295
|
+
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
43296
|
+
}
|
|
43297
|
+
},
|
|
43298
|
+
"summary": "List agent office groups",
|
|
43299
|
+
"tags": [
|
|
43300
|
+
"Agents"
|
|
43301
|
+
],
|
|
43302
|
+
"x-mm-entitlement": "rocket-filter"
|
|
43303
|
+
}
|
|
43304
|
+
},
|
|
43074
43305
|
"/v1/agents/{id}": {
|
|
43075
43306
|
"get": {
|
|
43076
43307
|
"operationId": "getAgent",
|
|
@@ -73237,7 +73468,7 @@
|
|
|
73237
73468
|
},
|
|
73238
73469
|
"/v1/originators/{nmlsId}/breakdowns/agents": {
|
|
73239
73470
|
"post": {
|
|
73240
|
-
"description": "Ranks the real-estate agents on this LO's loans, by volume — the buyer's agent by default, the listing and co-listing agents with `side: \"listing\"`. Each loan is credited to the agent its MLS agent keys resolve to (a key naming several different people credits only the confirmed one), so `units` counts distinct loans per agent. `id` is that agent's id (pass it to `GET /v1/agents/{id}`); absent when the loan's key matches no agent profile, in which case `label` is the name the MLS recorded. Names that are an MLS placeholder for \"no agent recorded\" (`non member`, `non listed agent`, and ~140 board-specific spellings) are excluded — they are not people. Percentages are shares of the LO's whole loan population, so they do not sum to 100 across the page.",
|
|
73471
|
+
"description": "Ranks the real-estate agents on this LO's loans, by volume — the buyer's agent by default, the listing and co-listing agents with `side: \"listing\"`. Each loan is credited to the agent its MLS agent keys resolve to (a key naming several different people credits only the confirmed one), so `units` counts distinct loans per agent. `id` is that agent's id (pass it to `GET /v1/agents/{id}`) and `office` / `contact` its brokerage and email / direct phone; absent when the loan's key matches no agent profile, in which case `label` is the name the MLS recorded. Names that are an MLS placeholder for \"no agent recorded\" (`non member`, `non listed agent`, and ~140 board-specific spellings) are excluded — they are not people. Percentages are shares of the LO's whole loan population, so they do not sum to 100 across the page.",
|
|
73241
73472
|
"operationId": "originatorAgents",
|
|
73242
73473
|
"parameters": [
|
|
73243
73474
|
{
|