@model-match/api 3.19.0 → 3.20.0

package/dist/slim/index.mjs

@@ -1,4 +1,4 @@
-import { n as createClient, w as client } from "../src-CjmGJZ9U.mjs";
+import { n as createClient, w as client } from "../src-CkGOuklD.mjs";
 //#region src/slim/sdk.gen.ts
 /**
 * An LO's sponsorship / registration links (admin)
@@ -510,6 +510,7 @@ const getAlertConditions = (options) => {
 };
 /**
 * Update your alert settings
+* Saves your NMLS id, contact identity and tunables. The per-trigger `enabled` flags are deprecated: subscribe to alert recipes or manage subscriptions instead. While still accepted, `enabled[type]: true` turns the trigger on for every watched subject that supports it, and `false` turns it off everywhere.
 */
 const updateAlertConditions = (options) => {
 	return (options?.client ?? client).put({
@@ -630,6 +631,137 @@ const previewAlerts = (options) => {
 	});
 };
 /**
+* List alert recipes
+* The alert recipes — named bundles of alert triggers — with the inputs each needs and whether you are subscribed.
+*/
+const listAlertRecipes = (options) => {
+	return (options?.client ?? client).get({
+		security: [{
+			name: "x-api-key",
+			type: "apiKey"
+		}, {
+			scheme: "bearer",
+			type: "http"
+		}],
+		url: "/v1/alerts/recipes",
+		...options
+	});
+};
+/**
+* Unsubscribe from an alert recipe
+* Turns the recipe's alert triggers off. Saved agents, areas and records stay; remove them with the watch-list endpoints.
+*/
+const unsubscribeAlertRecipe = (options) => {
+	return (options.client ?? client).delete({
+		security: [{
+			name: "x-api-key",
+			type: "apiKey"
+		}, {
+			scheme: "bearer",
+			type: "http"
+		}],
+		url: "/v1/alerts/recipes/{id}",
+		...options
+	});
+};
+/**
+* Subscribe to an alert recipe
+* Turns on the recipe's alert triggers, saves its inputs (NMLS id, agents, areas or a record), and backfills recent matches. For watch-record, empty rules apply the default for the record type: property — foreclosure status changes, or sale propensity reaches 50; sale — listing status changes; loan — interest rate moves by 0.125 points or more.
+*/
+const subscribeAlertRecipe = (options) => {
+	return (options.client ?? client).post({
+		security: [{
+			name: "x-api-key",
+			type: "apiKey"
+		}, {
+			scheme: "bearer",
+			type: "http"
+		}],
+		url: "/v1/alerts/recipes/{id}",
+		...options,
+		headers: {
+			"Content-Type": "application/json",
+			...options?.headers
+		}
+	});
+};
+/**
+* Preview an alert recipe
+* Dry-run the recipe over the last 30 days for you, with the given inputs applied on top of your saved ones. Writes nothing.
+*/
+const previewAlertRecipe = (options) => {
+	return (options.client ?? client).post({
+		security: [{
+			name: "x-api-key",
+			type: "apiKey"
+		}, {
+			scheme: "bearer",
+			type: "http"
+		}],
+		url: "/v1/alerts/recipes/{id}/preview",
+		...options,
+		headers: {
+			"Content-Type": "application/json",
+			...options?.headers
+		}
+	});
+};
+/**
+* List your alert subscriptions
+* Every subject you watch — agents, areas, your NMLS id, records — with the alert kinds that fire on it and the recipes that turned them on.
+*/
+const listAlertSubscriptions = (options) => {
+	return (options?.client ?? client).get({
+		security: [{
+			name: "x-api-key",
+			type: "apiKey"
+		}, {
+			scheme: "bearer",
+			type: "http"
+		}],
+		url: "/v1/alerts/subscriptions",
+		...options
+	});
+};
+/**
+* Subscribe to alerts on a subject
+* Watch a subject (an agent, an area, your NMLS id, or a sale / property / loan with rules) for the given alert kinds. Re-posting the same subject replaces the kinds you set directly; kinds a recipe turned on stay. Recent matches are backfilled when kinds are added.
+*/
+const createAlertSubscription = (options) => {
+	return (options?.client ?? client).post({
+		security: [{
+			name: "x-api-key",
+			type: "apiKey"
+		}, {
+			scheme: "bearer",
+			type: "http"
+		}],
+		url: "/v1/alerts/subscriptions",
+		...options,
+		headers: {
+			"Content-Type": "application/json",
+			...options?.headers
+		}
+	});
+};
+/**
+* Remove an alert subscription
+* Stops watching the subject (idempotent). For a record watch this also forgets its baseline, so watching it again starts fresh.
+*/
+const deleteAlertSubscription = (options) => {
+	return (options.client ?? client).delete({
+		security: [{
+			name: "x-api-key",
+			type: "apiKey"
+		}, {
+			scheme: "bearer",
+			type: "http"
+		}],
+		url: "/v1/alerts/subscriptions/{id}",
+		...options
+	});
+};
+/**
 * Get your unread alert count
 */
 const getAlertUnreadCount = (options) => {
@@ -5831,4 +5963,4 @@ const getSearchToken = (options) => {
 	});
 };
 //#endregion
-export { client as _heyApiClient, actionCrmCallerId, addCrmContactMethod, addCrmListMember, addCrmListMembersBulk, addCrmNote, addCrmRecord, addCrmRecordsBulk, addWatchedAgent, addWatchedArea, addWatchedDocument, adminGetBulkJob, adminGetCadLinks, adminGetCadLoadTask, adminLaunchCadLoad, agentAnalyticsChart, agentAnalyticsSummary, agentAnalyticsTimeSeries, agentCities, agentCompanies, agentCounties, agentLenders, agentMarkets, agentOffices, agentOriginators, agentProperties, agentRelated, agentSales, agentStates, agentZipCodes, analyzeCrmCall, applyCrmEnrichment, applyCrmListTemplate, applyCrmMiUpdates, branchAnalyticsChart, branchAnalyticsSummary, branchAnalyticsTimeSeries, branchCities, branchCounties, branchLenders, branchLoans, branchOriginators, branchRoster, branchStates, branchTitleCompanies, cancelAgentsBulkDeliveryJob, cancelBranchesBulkDeliveryJob, cancelCompaniesBulkDeliveryJob, cancelEnrichBulkJob, cancelLoansBulkDeliveryJob, cancelOriginatorsBulkDeliveryJob, cancelPropertiesBulkDeliveryJob, companyAgents, companyAnalyticsChart, companyAnalyticsSummary, companyAnalyticsTimeSeries, companyBranches, companyBrokers, companyCities, companyCounties, companyEarlyExits, companyEmployeeStats, companyEmployment, companyHeadcount, companyLenders, companyMarkets, companyOffices, companyOriginators, companyRelated, companySponsoredIndividuals, companySponsorshipMovement, companyStates, companyTalentFlow, companyTitleCompanies, companyZipCodes, countAgents, countBranches, countCompanies, countLenders, countLoans, countOffices, countOriginators, countProperties, countSales, createClient, createCrmList, createCrmListField, createCrmManualRecord, createCrmMeeting, createCrmObjectField, createCrmRecord, createCrmTask, createCrmTemplate, createSavedFilter, crmLenderChannels, crmLoLoanMix, crmLoMomentum, crmLoSponsorLocation, crmSimilarOriginators, declineCrmMiUpdate, deleteCrmCallerId, deleteCrmList, deleteCrmListField, deleteCrmMeeting, deleteCrmNote, deleteCrmObjectField, deleteCrmRecord, deleteCrmRecords, deleteCrmTask, deleteCrmTemplate, deleteSavedFilter, describeCrmRecordsOnAdd, dismissCrmMiUpdates, editCrmLoggedActivity, editCrmNote, enrichPropertiesBatch, enrichPropertiesBulk, enrichProperty, filterCrmListMembers, findCrmRecordByNmls, generateCrmRecordDescription, getAgent, getAgentsBulkDeliveryJob, getAlertConditions, getAlertUnreadCount, getBranch, getBranchesBulkDeliveryJob, getCompaniesBulkDeliveryJob, getCompany, getCrmActiveCall, getCrmActivityReport, getCrmCall, getCrmCallTranscript, getCrmCustomValues, getCrmImportJob, getCrmList, getCrmListMemberIds, getCrmListShares, getCrmMiUpdates, getCrmOutcomesReport, getCrmOverrides, getCrmProductionEnrichJob, getCrmRecordAccess, getCrmRecordAccessRequest, getCrmRecordConnections, getCrmRecordMemberIds, getCrmRecordProfile, getCrmTemplate, getCrmTemplateShares, getEnrichBulkJob, getHubspotPushStatus, getLender, getLoan, getLoansBulkDeliveryJob, getMe, getMeCredits, getMePlan, getOffice, getOriginator, getOriginatorsBulkDeliveryJob, getPropertiesBulkDeliveryJob, getProperty, getRealtimeConfig, getSale, getSavedFilter, getSearchToken, grantCrmListAccess, grantCrmRecordAccess, grantCrmRecordAccessRequest, hangupCrmCall, importCrmRecords, instantSearch, lenderCities, lenderCompanies, lenderCounties, lenderOriginators, lenderStates, linkCrmRecord, listAgents, listAlertDigests, listAlertLog, listBranches, listCompanies, listCrmActivity, listCrmCallerIds, listCrmCustomFields, listCrmListAssignees, listCrmListFields, listCrmListMemberships, listCrmListShareableMembers, listCrmLists, listCrmMeetings, listCrmMembers, listCrmOrgMembers, listCrmRecordShareableMembers, listCrmRecordShares, listCrmReferencedActivity, listCrmTasks, listCrmTemplates, listCrmWorkspaceMeetings, listCrmWorkspaceTasks, listEnrichments, listLenders, listLoans, listMarket, listOffices, listOriginators, listProperties, listSales, listSavedFilters, listWatchedAgents, listWatchedAreas, listWatchedDocuments, loanRelated, loansAnalyticsChart, loansAnalyticsSummary, loansAnalyticsTimeSeries, logCrmActivity, lookupCompanies, markAlertDigestRead, markAlertRead, markAllAlertsRead, marketAnalyticsChart, marketAnalyticsSummary, marketAnalyticsTimeSeries, marketCommunityLending, marketMovementActivity, marketMovementByState, marketMovementCohortPayoff, marketMovementMostGained, marketMovementMostLost, marketMovementMovers, marketMovementRankings, marketMovementStats, marketMovementTransitions, officeAgents, originatorAgents, originatorAnalyticsChart, originatorAnalyticsSummary, originatorAnalyticsTimeSeries, originatorBranches, originatorBrokers, originatorCitiesBreakdown, originatorCompanies, originatorCountiesBreakdown, originatorLenders, originatorLoans, originatorMarkets, originatorOffices, originatorProperties, originatorRelated, originatorStatesBreakdown, originatorTitleCompanies, originatorZipCodes, placeCrmCall, previewAlerts, propertiesAnalyticsChart, propertiesAnalyticsSummary, propertyRelated, pushToHubspot, reconcileCrmMeetings, refreshCrmRecordMirror, removeCrmContactMethod, removeCrmListMember, removeWatchedAgent, removeWatchedArea, removeWatchedDocument, requestCrmAccess, requestCrmRecordAccess, retrieveLocation, revokeCrmListAccess, revokeCrmRecordAccess, saleRelated, salesAnalyticsChart, salesAnalyticsSummary, salesAnalyticsTimeSeries, searchCrmEmailRecipients, searchCrmMatchCandidates, searchCrmMentionRecords, searchCrmRecords, searchProperties, sendCrmEmail, setCrmCallAnalysis, setCrmCustomValue, setCrmOverride, setCrmRecordOwner, setDefaultCrmCallerId, shareCrmTemplate, submitAgentsBulkDelivery, submitBranchesBulkDelivery, submitCompaniesBulkDelivery, submitLoansBulkDelivery, submitOriginatorsBulkDelivery, submitPropertiesBulkDelivery, suggestLocations, transcribeCrmCall, transferCrmListOwnership, unshareCrmTemplate, updateAlertConditions, updateCrmContactMethod, updateCrmList, updateCrmListField, updateCrmMeeting, updateCrmObjectField, updateCrmTask, updateCrmTemplate, updateMe, updateSavedFilter };
+export { client as _heyApiClient, actionCrmCallerId, addCrmContactMethod, addCrmListMember, addCrmListMembersBulk, addCrmNote, addCrmRecord, addCrmRecordsBulk, addWatchedAgent, addWatchedArea, addWatchedDocument, adminGetBulkJob, adminGetCadLinks, adminGetCadLoadTask, adminLaunchCadLoad, agentAnalyticsChart, agentAnalyticsSummary, agentAnalyticsTimeSeries, agentCities, agentCompanies, agentCounties, agentLenders, agentMarkets, agentOffices, agentOriginators, agentProperties, agentRelated, agentSales, agentStates, agentZipCodes, analyzeCrmCall, applyCrmEnrichment, applyCrmListTemplate, applyCrmMiUpdates, branchAnalyticsChart, branchAnalyticsSummary, branchAnalyticsTimeSeries, branchCities, branchCounties, branchLenders, branchLoans, branchOriginators, branchRoster, branchStates, branchTitleCompanies, cancelAgentsBulkDeliveryJob, cancelBranchesBulkDeliveryJob, cancelCompaniesBulkDeliveryJob, cancelEnrichBulkJob, cancelLoansBulkDeliveryJob, cancelOriginatorsBulkDeliveryJob, cancelPropertiesBulkDeliveryJob, companyAgents, companyAnalyticsChart, companyAnalyticsSummary, companyAnalyticsTimeSeries, companyBranches, companyBrokers, companyCities, companyCounties, companyEarlyExits, companyEmployeeStats, companyEmployment, companyHeadcount, companyLenders, companyMarkets, companyOffices, companyOriginators, companyRelated, companySponsoredIndividuals, companySponsorshipMovement, companyStates, companyTalentFlow, companyTitleCompanies, companyZipCodes, countAgents, countBranches, countCompanies, countLenders, countLoans, countOffices, countOriginators, countProperties, countSales, createAlertSubscription, createClient, createCrmList, createCrmListField, createCrmManualRecord, createCrmMeeting, createCrmObjectField, createCrmRecord, createCrmTask, createCrmTemplate, createSavedFilter, crmLenderChannels, crmLoLoanMix, crmLoMomentum, crmLoSponsorLocation, crmSimilarOriginators, declineCrmMiUpdate, deleteAlertSubscription, deleteCrmCallerId, deleteCrmList, deleteCrmListField, deleteCrmMeeting, deleteCrmNote, deleteCrmObjectField, deleteCrmRecord, deleteCrmRecords, deleteCrmTask, deleteCrmTemplate, deleteSavedFilter, describeCrmRecordsOnAdd, dismissCrmMiUpdates, editCrmLoggedActivity, editCrmNote, enrichPropertiesBatch, enrichPropertiesBulk, enrichProperty, filterCrmListMembers, findCrmRecordByNmls, generateCrmRecordDescription, getAgent, getAgentsBulkDeliveryJob, getAlertConditions, getAlertUnreadCount, getBranch, getBranchesBulkDeliveryJob, getCompaniesBulkDeliveryJob, getCompany, getCrmActiveCall, getCrmActivityReport, getCrmCall, getCrmCallTranscript, getCrmCustomValues, getCrmImportJob, getCrmList, getCrmListMemberIds, getCrmListShares, getCrmMiUpdates, getCrmOutcomesReport, getCrmOverrides, getCrmProductionEnrichJob, getCrmRecordAccess, getCrmRecordAccessRequest, getCrmRecordConnections, getCrmRecordMemberIds, getCrmRecordProfile, getCrmTemplate, getCrmTemplateShares, getEnrichBulkJob, getHubspotPushStatus, getLender, getLoan, getLoansBulkDeliveryJob, getMe, getMeCredits, getMePlan, getOffice, getOriginator, getOriginatorsBulkDeliveryJob, getPropertiesBulkDeliveryJob, getProperty, getRealtimeConfig, getSale, getSavedFilter, getSearchToken, grantCrmListAccess, grantCrmRecordAccess, grantCrmRecordAccessRequest, hangupCrmCall, importCrmRecords, instantSearch, lenderCities, lenderCompanies, lenderCounties, lenderOriginators, lenderStates, linkCrmRecord, listAgents, listAlertDigests, listAlertLog, listAlertRecipes, listAlertSubscriptions, listBranches, listCompanies, listCrmActivity, listCrmCallerIds, listCrmCustomFields, listCrmListAssignees, listCrmListFields, listCrmListMemberships, listCrmListShareableMembers, listCrmLists, listCrmMeetings, listCrmMembers, listCrmOrgMembers, listCrmRecordShareableMembers, listCrmRecordShares, listCrmReferencedActivity, listCrmTasks, listCrmTemplates, listCrmWorkspaceMeetings, listCrmWorkspaceTasks, listEnrichments, listLenders, listLoans, listMarket, listOffices, listOriginators, listProperties, listSales, listSavedFilters, listWatchedAgents, listWatchedAreas, listWatchedDocuments, loanRelated, loansAnalyticsChart, loansAnalyticsSummary, loansAnalyticsTimeSeries, logCrmActivity, lookupCompanies, markAlertDigestRead, markAlertRead, markAllAlertsRead, marketAnalyticsChart, marketAnalyticsSummary, marketAnalyticsTimeSeries, marketCommunityLending, marketMovementActivity, marketMovementByState, marketMovementCohortPayoff, marketMovementMostGained, marketMovementMostLost, marketMovementMovers, marketMovementRankings, marketMovementStats, marketMovementTransitions, officeAgents, originatorAgents, originatorAnalyticsChart, originatorAnalyticsSummary, originatorAnalyticsTimeSeries, originatorBranches, originatorBrokers, originatorCitiesBreakdown, originatorCompanies, originatorCountiesBreakdown, originatorLenders, originatorLoans, originatorMarkets, originatorOffices, originatorProperties, originatorRelated, originatorStatesBreakdown, originatorTitleCompanies, originatorZipCodes, placeCrmCall, previewAlertRecipe, previewAlerts, propertiesAnalyticsChart, propertiesAnalyticsSummary, propertyRelated, pushToHubspot, reconcileCrmMeetings, refreshCrmRecordMirror, removeCrmContactMethod, removeCrmListMember, removeWatchedAgent, removeWatchedArea, removeWatchedDocument, requestCrmAccess, requestCrmRecordAccess, retrieveLocation, revokeCrmListAccess, revokeCrmRecordAccess, saleRelated, salesAnalyticsChart, salesAnalyticsSummary, salesAnalyticsTimeSeries, searchCrmEmailRecipients, searchCrmMatchCandidates, searchCrmMentionRecords, searchCrmRecords, searchProperties, sendCrmEmail, setCrmCallAnalysis, setCrmCustomValue, setCrmOverride, setCrmRecordOwner, setDefaultCrmCallerId, shareCrmTemplate, submitAgentsBulkDelivery, submitBranchesBulkDelivery, submitCompaniesBulkDelivery, submitLoansBulkDelivery, submitOriginatorsBulkDelivery, submitPropertiesBulkDelivery, subscribeAlertRecipe, suggestLocations, transcribeCrmCall, transferCrmListOwnership, unshareCrmTemplate, unsubscribeAlertRecipe, updateAlertConditions, updateCrmContactMethod, updateCrmList, updateCrmListField, updateCrmMeeting, updateCrmObjectField, updateCrmTask, updateCrmTemplate, updateMe, updateSavedFilter };

package/dist/{src-CjmGJZ9U.mjs → src-CkGOuklD.mjs}

@@ -614,6 +614,7 @@ var Alerts = class {
 	}
 	/**
 	* Update your alert settings
+	* Saves your NMLS id, contact identity and tunables. The per-trigger `enabled` flags are deprecated: subscribe to alert recipes or manage subscriptions instead. While still accepted, `enabled[type]: true` turns the trigger on for every watched subject that supports it, and `false` turns it off everywhere.
 	*/
 	static updateAlertConditions(options) {
 		return (options?.client ?? client).put({
@@ -734,6 +735,137 @@ var Alerts = class {
 		});
 	}
 	/**
+	* List alert recipes
+	* The alert recipes — named bundles of alert triggers — with the inputs each needs and whether you are subscribed.
+	*/
+	static listAlertRecipes(options) {
+		return (options?.client ?? client).get({
+			security: [{
+				name: "x-api-key",
+				type: "apiKey"
+			}, {
+				scheme: "bearer",
+				type: "http"
+			}],
+			url: "/v1/alerts/recipes",
+			...options
+		});
+	}
+	/**
+	* Unsubscribe from an alert recipe
+	* Turns the recipe's alert triggers off. Saved agents, areas and records stay; remove them with the watch-list endpoints.
+	*/
+	static unsubscribeAlertRecipe(options) {
+		return (options.client ?? client).delete({
+			security: [{
+				name: "x-api-key",
+				type: "apiKey"
+			}, {
+				scheme: "bearer",
+				type: "http"
+			}],
+			url: "/v1/alerts/recipes/{id}",
+			...options
+		});
+	}
+	/**
+	* Subscribe to an alert recipe
+	* Turns on the recipe's alert triggers, saves its inputs (NMLS id, agents, areas or a record), and backfills recent matches. For watch-record, empty rules apply the default for the record type: property — foreclosure status changes, or sale propensity reaches 50; sale — listing status changes; loan — interest rate moves by 0.125 points or more.
+	*/
+	static subscribeAlertRecipe(options) {
+		return (options.client ?? client).post({
+			security: [{
+				name: "x-api-key",
+				type: "apiKey"
+			}, {
+				scheme: "bearer",
+				type: "http"
+			}],
+			url: "/v1/alerts/recipes/{id}",
+			...options,
+			headers: {
+				"Content-Type": "application/json",
+				...options?.headers
+			}
+		});
+	}
+	/**
+	* Preview an alert recipe
+	* Dry-run the recipe over the last 30 days for you, with the given inputs applied on top of your saved ones. Writes nothing.
+	*/
+	static previewAlertRecipe(options) {
+		return (options.client ?? client).post({
+			security: [{
+				name: "x-api-key",
+				type: "apiKey"
+			}, {
+				scheme: "bearer",
+				type: "http"
+			}],
+			url: "/v1/alerts/recipes/{id}/preview",
+			...options,
+			headers: {
+				"Content-Type": "application/json",
+				...options?.headers
+			}
+		});
+	}
+	/**
+	* List your alert subscriptions
+	* Every subject you watch — agents, areas, your NMLS id, records — with the alert kinds that fire on it and the recipes that turned them on.
+	*/
+	static listAlertSubscriptions(options) {
+		return (options?.client ?? client).get({
+			security: [{
+				name: "x-api-key",
+				type: "apiKey"
+			}, {
+				scheme: "bearer",
+				type: "http"
+			}],
+			url: "/v1/alerts/subscriptions",
+			...options
+		});
+	}
+	/**
+	* Subscribe to alerts on a subject
+	* Watch a subject (an agent, an area, your NMLS id, or a sale / property / loan with rules) for the given alert kinds. Re-posting the same subject replaces the kinds you set directly; kinds a recipe turned on stay. Recent matches are backfilled when kinds are added.
+	*/
+	static createAlertSubscription(options) {
+		return (options?.client ?? client).post({
+			security: [{
+				name: "x-api-key",
+				type: "apiKey"
+			}, {
+				scheme: "bearer",
+				type: "http"
+			}],
+			url: "/v1/alerts/subscriptions",
+			...options,
+			headers: {
+				"Content-Type": "application/json",
+				...options?.headers
+			}
+		});
+	}
+	/**
+	* Remove an alert subscription
+	* Stops watching the subject (idempotent). For a record watch this also forgets its baseline, so watching it again starts fresh.
+	*/
+	static deleteAlertSubscription(options) {
+		return (options.client ?? client).delete({
+			security: [{
+				name: "x-api-key",
+				type: "apiKey"
+			}, {
+				scheme: "bearer",
+				type: "http"
+			}],
+			url: "/v1/alerts/subscriptions/{id}",
+			...options
+		});
+	}
+	/**
 	* Get your unread alert count
 	*/
 	static getAlertUnreadCount(options) {