@model-match/api 3.16.0 → 3.18.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/dist/{index-DN9Yrnc2.d.mts → index-CGoyq3QT.d.mts} +645 -100
- package/dist/index.d.mts +2 -2
- package/dist/index.mjs +1 -1
- package/dist/slim/index.d.mts +54 -10
- package/dist/slim/index.mjs +150 -10
- package/dist/{src-DmJ3haPq.mjs → src-cKUuYWMX.mjs} +148 -8
- package/openapi.json +1522 -156
- package/package.json +2 -2
package/dist/slim/index.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { n as createClient, w as client } from "../src-
|
|
1
|
+
import { n as createClient, w as client } from "../src-cKUuYWMX.mjs";
|
|
2
2
|
//#region src/slim/sdk.gen.ts
|
|
3
3
|
/**
|
|
4
4
|
* Search agents with filters
|
|
@@ -85,9 +85,11 @@ const agentAnalyticsTimeSeries = (options) => {
|
|
|
85
85
|
* Submit a bulk-delivery job for agents
|
|
86
86
|
* Queues an ECS task that dumps every matching agents document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/agents/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
87
87
|
*
|
|
88
|
-
* **Row limit.** Deliveries of up to
|
|
88
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.agents` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
89
89
|
*
|
|
90
90
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
91
|
+
*
|
|
92
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
91
93
|
*/
|
|
92
94
|
const submitAgentsBulkDelivery = (options) => {
|
|
93
95
|
return (options?.client ?? client).post({
|
|
@@ -486,9 +488,11 @@ const originatorAnalyticsTimeSeries = (options) => {
|
|
|
486
488
|
* Submit a bulk-delivery job for originators
|
|
487
489
|
* Queues an ECS task that dumps every matching originators document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/originators/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
488
490
|
*
|
|
489
|
-
* **Row limit.** Deliveries of up to
|
|
491
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.originators` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
490
492
|
*
|
|
491
493
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
494
|
+
*
|
|
495
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
492
496
|
*/
|
|
493
497
|
const submitOriginatorsBulkDelivery = (options) => {
|
|
494
498
|
return (options?.client ?? client).post({
|
|
@@ -763,6 +767,27 @@ const originatorStatesBreakdown = (options) => {
|
|
|
763
767
|
});
|
|
764
768
|
};
|
|
765
769
|
/**
|
|
770
|
+
* Title companies on this LO's loans (spellings merged)
|
|
771
|
+
* Ranks the title companies on this entity's loans (recorded deeds, `recording_date` window — the same population and period axis as every other loans breakdown). Spellings of one company are MERGED: `label` is its most-used spelling, `id` the normalized name every spelling was grouped under (legal-form and filler words such as `inc`, `llc`, `co`, `company`, `title`, `escrow` removed; `natl` → `national`). Placeholder entries meaning "no title company recorded" (`none available` and its misspellings, `unknown`, `n/a`, …) and names shorter than 3 characters are excluded rather than ranked. `attorney` and `accommodation` are kept: they say who closed. `pctUnits` / `pctVolume` are shares of the entity's WHOLE loan population in the window, including loans with no title company, so they do not sum to 100 across the page. Pages of up to 100 via `pagination`.
|
|
772
|
+
*/
|
|
773
|
+
const originatorTitleCompanies = (options) => {
|
|
774
|
+
return (options.client ?? client).post({
|
|
775
|
+
security: [{
|
|
776
|
+
name: "x-api-key",
|
|
777
|
+
type: "apiKey"
|
|
778
|
+
}, {
|
|
779
|
+
scheme: "bearer",
|
|
780
|
+
type: "http"
|
|
781
|
+
}],
|
|
782
|
+
url: "/originators/{nmlsId}/breakdowns/title-companies",
|
|
783
|
+
...options,
|
|
784
|
+
headers: {
|
|
785
|
+
"Content-Type": "application/json",
|
|
786
|
+
...options?.headers
|
|
787
|
+
}
|
|
788
|
+
});
|
|
789
|
+
};
|
|
790
|
+
/**
|
|
766
791
|
* Zip-code volume breakdown
|
|
767
792
|
*/
|
|
768
793
|
const originatorZipCodes = (options) => {
|
|
@@ -1001,9 +1026,11 @@ const agentAnalyticsTimeSeries2 = (options) => {
|
|
|
1001
1026
|
* Submit a bulk-delivery job for agents
|
|
1002
1027
|
* Queues an ECS task that dumps every matching agents document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/agents/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
1003
1028
|
*
|
|
1004
|
-
* **Row limit.** Deliveries of up to
|
|
1029
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.agents` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
1005
1030
|
*
|
|
1006
1031
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
1032
|
+
*
|
|
1033
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
1007
1034
|
*/
|
|
1008
1035
|
const submitAgentsBulkDelivery2 = (options) => {
|
|
1009
1036
|
return (options?.client ?? client).post({
|
|
@@ -1731,9 +1758,11 @@ const branchAnalyticsTimeSeries = (options) => {
|
|
|
1731
1758
|
* Submit a bulk-delivery job for branches
|
|
1732
1759
|
* Queues an ECS task that dumps every matching branches document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/branches/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
1733
1760
|
*
|
|
1734
|
-
* **Row limit.** Deliveries of up to
|
|
1761
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.branches` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
1735
1762
|
*
|
|
1736
1763
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
1764
|
+
*
|
|
1765
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
1737
1766
|
*/
|
|
1738
1767
|
const submitBranchesBulkDelivery = (options) => {
|
|
1739
1768
|
return (options?.client ?? client).post({
|
|
@@ -1933,6 +1962,27 @@ const branchStates = (options) => {
|
|
|
1933
1962
|
});
|
|
1934
1963
|
};
|
|
1935
1964
|
/**
|
|
1965
|
+
* Title companies on this branch's loans (spellings merged)
|
|
1966
|
+
* Ranks the title companies on this entity's loans (recorded deeds, `recording_date` window — the same population and period axis as every other loans breakdown). Spellings of one company are MERGED: `label` is its most-used spelling, `id` the normalized name every spelling was grouped under (legal-form and filler words such as `inc`, `llc`, `co`, `company`, `title`, `escrow` removed; `natl` → `national`). Placeholder entries meaning "no title company recorded" (`none available` and its misspellings, `unknown`, `n/a`, …) and names shorter than 3 characters are excluded rather than ranked. `attorney` and `accommodation` are kept: they say who closed. `pctUnits` / `pctVolume` are shares of the entity's WHOLE loan population in the window, including loans with no title company, so they do not sum to 100 across the page. Pages of up to 100 via `pagination`.
|
|
1967
|
+
*/
|
|
1968
|
+
const branchTitleCompanies = (options) => {
|
|
1969
|
+
return (options.client ?? client).post({
|
|
1970
|
+
security: [{
|
|
1971
|
+
name: "x-api-key",
|
|
1972
|
+
type: "apiKey"
|
|
1973
|
+
}, {
|
|
1974
|
+
scheme: "bearer",
|
|
1975
|
+
type: "http"
|
|
1976
|
+
}],
|
|
1977
|
+
url: "/v1/branches/{nmlsId}/breakdowns/title-companies",
|
|
1978
|
+
...options,
|
|
1979
|
+
headers: {
|
|
1980
|
+
"Content-Type": "application/json",
|
|
1981
|
+
...options?.headers
|
|
1982
|
+
}
|
|
1983
|
+
});
|
|
1984
|
+
};
|
|
1985
|
+
/**
|
|
1936
1986
|
* Loans written by this branch
|
|
1937
1987
|
* 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}`.
|
|
1938
1988
|
*/
|
|
@@ -2059,9 +2109,11 @@ const companyAnalyticsTimeSeries = (options) => {
|
|
|
2059
2109
|
* Submit a bulk-delivery job for companies
|
|
2060
2110
|
* Queues an ECS task that dumps every matching companies document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/companies/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
2061
2111
|
*
|
|
2062
|
-
* **Row limit.** Deliveries of up to
|
|
2112
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.companies` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
2063
2113
|
*
|
|
2064
2114
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
2115
|
+
*
|
|
2116
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
2065
2117
|
*/
|
|
2066
2118
|
const submitCompaniesBulkDelivery = (options) => {
|
|
2067
2119
|
return (options?.client ?? client).post({
|
|
@@ -2374,6 +2426,27 @@ const companyStates = (options) => {
|
|
|
2374
2426
|
});
|
|
2375
2427
|
};
|
|
2376
2428
|
/**
|
|
2429
|
+
* Title companies on this company's loans (spellings merged)
|
|
2430
|
+
* Ranks the title companies on this entity's loans (recorded deeds, `recording_date` window — the same population and period axis as every other loans breakdown). Spellings of one company are MERGED: `label` is its most-used spelling, `id` the normalized name every spelling was grouped under (legal-form and filler words such as `inc`, `llc`, `co`, `company`, `title`, `escrow` removed; `natl` → `national`). Placeholder entries meaning "no title company recorded" (`none available` and its misspellings, `unknown`, `n/a`, …) and names shorter than 3 characters are excluded rather than ranked. `attorney` and `accommodation` are kept: they say who closed. `pctUnits` / `pctVolume` are shares of the entity's WHOLE loan population in the window, including loans with no title company, so they do not sum to 100 across the page. Pages of up to 100 via `pagination`.
|
|
2431
|
+
*/
|
|
2432
|
+
const companyTitleCompanies = (options) => {
|
|
2433
|
+
return (options.client ?? client).post({
|
|
2434
|
+
security: [{
|
|
2435
|
+
name: "x-api-key",
|
|
2436
|
+
type: "apiKey"
|
|
2437
|
+
}, {
|
|
2438
|
+
scheme: "bearer",
|
|
2439
|
+
type: "http"
|
|
2440
|
+
}],
|
|
2441
|
+
url: "/v1/companies/{nmlsId}/breakdowns/title-companies",
|
|
2442
|
+
...options,
|
|
2443
|
+
headers: {
|
|
2444
|
+
"Content-Type": "application/json",
|
|
2445
|
+
...options?.headers
|
|
2446
|
+
}
|
|
2447
|
+
});
|
|
2448
|
+
};
|
|
2449
|
+
/**
|
|
2377
2450
|
* Zip-code volume breakdown across this company's loans
|
|
2378
2451
|
*/
|
|
2379
2452
|
const companyZipCodes = (options) => {
|
|
@@ -2612,6 +2685,46 @@ const addCrmNote = (options) => {
|
|
|
2612
2685
|
});
|
|
2613
2686
|
};
|
|
2614
2687
|
/**
|
|
2688
|
+
* Edit a logged activity entry
|
|
2689
|
+
*/
|
|
2690
|
+
const editCrmLoggedActivity = (options) => {
|
|
2691
|
+
return (options?.client ?? client).patch({
|
|
2692
|
+
security: [{
|
|
2693
|
+
name: "x-api-key",
|
|
2694
|
+
type: "apiKey"
|
|
2695
|
+
}, {
|
|
2696
|
+
scheme: "bearer",
|
|
2697
|
+
type: "http"
|
|
2698
|
+
}],
|
|
2699
|
+
url: "/v1/crm/activity/log",
|
|
2700
|
+
...options,
|
|
2701
|
+
headers: {
|
|
2702
|
+
"Content-Type": "application/json",
|
|
2703
|
+
...options?.headers
|
|
2704
|
+
}
|
|
2705
|
+
});
|
|
2706
|
+
};
|
|
2707
|
+
/**
|
|
2708
|
+
* Log a Call/Meeting/Email/Task that happened outside Model Match
|
|
2709
|
+
*/
|
|
2710
|
+
const logCrmActivity = (options) => {
|
|
2711
|
+
return (options?.client ?? client).post({
|
|
2712
|
+
security: [{
|
|
2713
|
+
name: "x-api-key",
|
|
2714
|
+
type: "apiKey"
|
|
2715
|
+
}, {
|
|
2716
|
+
scheme: "bearer",
|
|
2717
|
+
type: "http"
|
|
2718
|
+
}],
|
|
2719
|
+
url: "/v1/crm/activity/log",
|
|
2720
|
+
...options,
|
|
2721
|
+
headers: {
|
|
2722
|
+
"Content-Type": "application/json",
|
|
2723
|
+
...options?.headers
|
|
2724
|
+
}
|
|
2725
|
+
});
|
|
2726
|
+
};
|
|
2727
|
+
/**
|
|
2615
2728
|
* List notes from other records that reference this one (trickled up)
|
|
2616
2729
|
*/
|
|
2617
2730
|
const listCrmReferencedActivity = (options) => {
|
|
@@ -4969,9 +5082,11 @@ const loansAnalyticsTimeSeries = (options) => {
|
|
|
4969
5082
|
* Submit a bulk-delivery job for loans
|
|
4970
5083
|
* Queues an ECS task that dumps every matching loans document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/loans/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
4971
5084
|
*
|
|
4972
|
-
* **Row limit.** Deliveries of up to
|
|
5085
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.loans` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
4973
5086
|
*
|
|
4974
5087
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
5088
|
+
*
|
|
5089
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
4975
5090
|
*/
|
|
4976
5091
|
const submitLoansBulkDelivery = (options) => {
|
|
4977
5092
|
return (options?.client ?? client).post({
|
|
@@ -5613,9 +5728,11 @@ const originatorAnalyticsTimeSeries2 = (options) => {
|
|
|
5613
5728
|
* Submit a bulk-delivery job for originators
|
|
5614
5729
|
* Queues an ECS task that dumps every matching originators document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/originators/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
5615
5730
|
*
|
|
5616
|
-
* **Row limit.** Deliveries of up to
|
|
5731
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.originators` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
5617
5732
|
*
|
|
5618
5733
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
5734
|
+
*
|
|
5735
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
5619
5736
|
*/
|
|
5620
5737
|
const submitOriginatorsBulkDelivery2 = (options) => {
|
|
5621
5738
|
return (options?.client ?? client).post({
|
|
@@ -5907,6 +6024,27 @@ const originatorStatesBreakdown2 = (options) => {
|
|
|
5907
6024
|
});
|
|
5908
6025
|
};
|
|
5909
6026
|
/**
|
|
6027
|
+
* Title companies on this LO's loans (spellings merged)
|
|
6028
|
+
* Ranks the title companies on this entity's loans (recorded deeds, `recording_date` window — the same population and period axis as every other loans breakdown). Spellings of one company are MERGED: `label` is its most-used spelling, `id` the normalized name every spelling was grouped under (legal-form and filler words such as `inc`, `llc`, `co`, `company`, `title`, `escrow` removed; `natl` → `national`). Placeholder entries meaning "no title company recorded" (`none available` and its misspellings, `unknown`, `n/a`, …) and names shorter than 3 characters are excluded rather than ranked. `attorney` and `accommodation` are kept: they say who closed. `pctUnits` / `pctVolume` are shares of the entity's WHOLE loan population in the window, including loans with no title company, so they do not sum to 100 across the page. Pages of up to 100 via `pagination`.
|
|
6029
|
+
*/
|
|
6030
|
+
const originatorTitleCompanies2 = (options) => {
|
|
6031
|
+
return (options.client ?? client).post({
|
|
6032
|
+
security: [{
|
|
6033
|
+
name: "x-api-key",
|
|
6034
|
+
type: "apiKey"
|
|
6035
|
+
}, {
|
|
6036
|
+
scheme: "bearer",
|
|
6037
|
+
type: "http"
|
|
6038
|
+
}],
|
|
6039
|
+
url: "/v1/originators/{nmlsId}/breakdowns/title-companies",
|
|
6040
|
+
...options,
|
|
6041
|
+
headers: {
|
|
6042
|
+
"Content-Type": "application/json",
|
|
6043
|
+
...options?.headers
|
|
6044
|
+
}
|
|
6045
|
+
});
|
|
6046
|
+
};
|
|
6047
|
+
/**
|
|
5910
6048
|
* Zip-code volume breakdown
|
|
5911
6049
|
*/
|
|
5912
6050
|
const originatorZipCodes2 = (options) => {
|
|
@@ -6053,9 +6191,11 @@ const propertiesAnalyticsSummary = (options) => {
|
|
|
6053
6191
|
* Submit a bulk-delivery job for properties
|
|
6054
6192
|
* Queues an ECS task that dumps every matching properties document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/properties/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
6055
6193
|
*
|
|
6056
|
-
* **Row limit.** Deliveries of up to
|
|
6194
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.properties` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
6057
6195
|
*
|
|
6058
6196
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
6197
|
+
*
|
|
6198
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
6059
6199
|
*/
|
|
6060
6200
|
const submitPropertiesBulkDelivery = (options) => {
|
|
6061
6201
|
return (options?.client ?? client).post({
|
|
@@ -6560,4 +6700,4 @@ const getSearchToken = (options) => {
|
|
|
6560
6700
|
});
|
|
6561
6701
|
};
|
|
6562
6702
|
//#endregion
|
|
6563
|
-
export { client as _heyApiClient, actionCrmCallerId, addCrmContactMethod, addCrmListMember, addCrmListMembersBulk, addCrmNote, addCrmRecord, addCrmRecordsBulk, addWatchedAgent, addWatchedArea, addWatchedDocument, adminGetBulkJob, adminGetCadLinks, adminGetCadLoadTask, adminLaunchCadLoad, agentAnalyticsChart, agentAnalyticsChart2, agentAnalyticsSummary, agentAnalyticsSummary2, agentAnalyticsTimeSeries, agentAnalyticsTimeSeries2, agentCities, agentCities2, agentCompanies, agentCompanies2, agentCounties, agentCounties2, agentLenders, agentLenders2, agentMarkets, agentMarkets2, agentOffices, agentOffices2, agentOriginators, agentOriginators2, agentProperties, agentProperties2, agentRelated, agentSales, agentSales2, agentStates, agentStates2, agentZipCodes, agentZipCodes2, analyzeCrmCall, applyCrmEnrichment, applyCrmListTemplate, applyCrmMiUpdates, branchAnalyticsChart, branchAnalyticsSummary, branchAnalyticsTimeSeries, branchCities, branchCounties, branchLenders, branchLoans, branchOriginators, branchRoster, branchStates, cancelAgentsBulkDeliveryJob, cancelAgentsBulkDeliveryJob2, cancelBranchesBulkDeliveryJob, cancelCompaniesBulkDeliveryJob, cancelEnrichBulkJob, cancelLoansBulkDeliveryJob, cancelOriginatorsBulkDeliveryJob, cancelOriginatorsBulkDeliveryJob2, cancelPropertiesBulkDeliveryJob, companyAgents, companyAnalyticsChart, companyAnalyticsSummary, companyAnalyticsTimeSeries, companyBranches, companyBrokers, companyCities, companyCounties, companyEarlyExits, companyEmployeeStats, companyEmployment, companyHeadcount, companyLenders, companyMarkets, companyOffices, companyOriginators, companyRelated, companySponsoredIndividuals, companySponsorshipMovement, companyStates, companyTalentFlow, companyZipCodes, countAgents, countAgents2, countBranches, countCompanies, countLenders, countLoans, countOffices, countOriginators, countOriginators2, 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, editCrmNote, enrichPropertiesBatch, enrichPropertiesBulk, enrichProperty, filterCrmListMembers, findCrmRecordByNmls, generateCrmRecordDescription, getAgent, getAgent2, getAgentsBulkDeliveryJob, getAgentsBulkDeliveryJob2, 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, getOriginator2, getOriginatorsBulkDeliveryJob, getOriginatorsBulkDeliveryJob2, getPropertiesBulkDeliveryJob, getProperty, getRealtimeConfig, getSale, getSavedFilter, getSearchToken, grantCrmListAccess, grantCrmRecordAccess, grantCrmRecordAccessRequest, hangupCrmCall, importCrmRecords, instantSearch, lenderCities, lenderCompanies, lenderCounties, lenderOriginators, lenderStates, linkCrmRecord, listAgents, listAgents2, 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, listOriginators2, listProperties, listSales, listSavedFilters, listWatchedAgents, listWatchedAreas, listWatchedDocuments, loanRelated, loansAnalyticsChart, loansAnalyticsSummary, loansAnalyticsTimeSeries, lookupCompanies, markAlertDigestRead, markAlertRead, markAllAlertsRead, marketAnalyticsChart, marketAnalyticsSummary, marketAnalyticsTimeSeries, marketCommunityLending, marketMovementActivity, marketMovementByState, marketMovementCohortPayoff, marketMovementMostGained, marketMovementMostLost, marketMovementMovers, marketMovementRankings, marketMovementStats, marketMovementTransitions, officeAgents, originatorAgents, originatorAgents2, originatorAnalyticsChart, originatorAnalyticsChart2, originatorAnalyticsSummary, originatorAnalyticsSummary2, originatorAnalyticsTimeSeries, originatorAnalyticsTimeSeries2, originatorBranches, originatorBranches2, originatorBrokers, originatorBrokers2, originatorCitiesBreakdown, originatorCitiesBreakdown2, originatorCompanies, originatorCompanies2, originatorCountiesBreakdown, originatorCountiesBreakdown2, originatorLenders, originatorLenders2, originatorLoans, originatorLoans2, originatorMarkets, originatorMarkets2, originatorOffices, originatorOffices2, originatorProperties, originatorProperties2, originatorRelated, originatorStatesBreakdown, originatorStatesBreakdown2, originatorZipCodes, originatorZipCodes2, 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, submitAgentsBulkDelivery2, submitBranchesBulkDelivery, submitCompaniesBulkDelivery, submitLoansBulkDelivery, submitOriginatorsBulkDelivery, submitOriginatorsBulkDelivery2, submitPropertiesBulkDelivery, suggestLocations, transcribeCrmCall, transferCrmListOwnership, unshareCrmTemplate, updateAlertConditions, updateCrmContactMethod, updateCrmList, updateCrmListField, updateCrmMeeting, updateCrmObjectField, updateCrmTask, updateCrmTemplate, updateMe, updateSavedFilter };
|
|
6703
|
+
export { client as _heyApiClient, actionCrmCallerId, addCrmContactMethod, addCrmListMember, addCrmListMembersBulk, addCrmNote, addCrmRecord, addCrmRecordsBulk, addWatchedAgent, addWatchedArea, addWatchedDocument, adminGetBulkJob, adminGetCadLinks, adminGetCadLoadTask, adminLaunchCadLoad, agentAnalyticsChart, agentAnalyticsChart2, agentAnalyticsSummary, agentAnalyticsSummary2, agentAnalyticsTimeSeries, agentAnalyticsTimeSeries2, agentCities, agentCities2, agentCompanies, agentCompanies2, agentCounties, agentCounties2, agentLenders, agentLenders2, agentMarkets, agentMarkets2, agentOffices, agentOffices2, agentOriginators, agentOriginators2, agentProperties, agentProperties2, agentRelated, agentSales, agentSales2, agentStates, agentStates2, agentZipCodes, agentZipCodes2, analyzeCrmCall, applyCrmEnrichment, applyCrmListTemplate, applyCrmMiUpdates, branchAnalyticsChart, branchAnalyticsSummary, branchAnalyticsTimeSeries, branchCities, branchCounties, branchLenders, branchLoans, branchOriginators, branchRoster, branchStates, branchTitleCompanies, cancelAgentsBulkDeliveryJob, cancelAgentsBulkDeliveryJob2, cancelBranchesBulkDeliveryJob, cancelCompaniesBulkDeliveryJob, cancelEnrichBulkJob, cancelLoansBulkDeliveryJob, cancelOriginatorsBulkDeliveryJob, cancelOriginatorsBulkDeliveryJob2, 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, countAgents2, countBranches, countCompanies, countLenders, countLoans, countOffices, countOriginators, countOriginators2, 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, getAgent2, getAgentsBulkDeliveryJob, getAgentsBulkDeliveryJob2, 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, getOriginator2, getOriginatorsBulkDeliveryJob, getOriginatorsBulkDeliveryJob2, getPropertiesBulkDeliveryJob, getProperty, getRealtimeConfig, getSale, getSavedFilter, getSearchToken, grantCrmListAccess, grantCrmRecordAccess, grantCrmRecordAccessRequest, hangupCrmCall, importCrmRecords, instantSearch, lenderCities, lenderCompanies, lenderCounties, lenderOriginators, lenderStates, linkCrmRecord, listAgents, listAgents2, 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, listOriginators2, 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, originatorAgents2, originatorAnalyticsChart, originatorAnalyticsChart2, originatorAnalyticsSummary, originatorAnalyticsSummary2, originatorAnalyticsTimeSeries, originatorAnalyticsTimeSeries2, originatorBranches, originatorBranches2, originatorBrokers, originatorBrokers2, originatorCitiesBreakdown, originatorCitiesBreakdown2, originatorCompanies, originatorCompanies2, originatorCountiesBreakdown, originatorCountiesBreakdown2, originatorLenders, originatorLenders2, originatorLoans, originatorLoans2, originatorMarkets, originatorMarkets2, originatorOffices, originatorOffices2, originatorProperties, originatorProperties2, originatorRelated, originatorStatesBreakdown, originatorStatesBreakdown2, originatorTitleCompanies, originatorTitleCompanies2, originatorZipCodes, originatorZipCodes2, 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, submitAgentsBulkDelivery2, submitBranchesBulkDelivery, submitCompaniesBulkDelivery, submitLoansBulkDelivery, submitOriginatorsBulkDelivery, submitOriginatorsBulkDelivery2, submitPropertiesBulkDelivery, suggestLocations, transcribeCrmCall, transferCrmListOwnership, unshareCrmTemplate, updateAlertConditions, updateCrmContactMethod, updateCrmList, updateCrmListField, updateCrmMeeting, updateCrmObjectField, updateCrmTask, updateCrmTemplate, updateMe, updateSavedFilter };
|
|
@@ -96,9 +96,11 @@ var Agents = class {
|
|
|
96
96
|
* Submit a bulk-delivery job for agents
|
|
97
97
|
* Queues an ECS task that dumps every matching agents document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/agents/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
98
98
|
*
|
|
99
|
-
* **Row limit.** Deliveries of up to
|
|
99
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.agents` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
100
100
|
*
|
|
101
101
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
102
|
+
*
|
|
103
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
102
104
|
*/
|
|
103
105
|
static submitAgentsBulkDelivery(options) {
|
|
104
106
|
return (options?.client ?? client).post({
|
|
@@ -497,9 +499,11 @@ var Agents = class {
|
|
|
497
499
|
* Submit a bulk-delivery job for agents
|
|
498
500
|
* Queues an ECS task that dumps every matching agents document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/agents/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
499
501
|
*
|
|
500
|
-
* **Row limit.** Deliveries of up to
|
|
502
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.agents` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
501
503
|
*
|
|
502
504
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
505
|
+
*
|
|
506
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
503
507
|
*/
|
|
504
508
|
static submitAgentsBulkDelivery2(options) {
|
|
505
509
|
return (options?.client ?? client).post({
|
|
@@ -900,9 +904,11 @@ var Originators = class {
|
|
|
900
904
|
* Submit a bulk-delivery job for originators
|
|
901
905
|
* Queues an ECS task that dumps every matching originators document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/originators/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
902
906
|
*
|
|
903
|
-
* **Row limit.** Deliveries of up to
|
|
907
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.originators` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
904
908
|
*
|
|
905
909
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
910
|
+
*
|
|
911
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
906
912
|
*/
|
|
907
913
|
static submitOriginatorsBulkDelivery(options) {
|
|
908
914
|
return (options?.client ?? client).post({
|
|
@@ -1177,6 +1183,27 @@ var Originators = class {
|
|
|
1177
1183
|
});
|
|
1178
1184
|
}
|
|
1179
1185
|
/**
|
|
1186
|
+
* Title companies on this LO's loans (spellings merged)
|
|
1187
|
+
* Ranks the title companies on this entity's loans (recorded deeds, `recording_date` window — the same population and period axis as every other loans breakdown). Spellings of one company are MERGED: `label` is its most-used spelling, `id` the normalized name every spelling was grouped under (legal-form and filler words such as `inc`, `llc`, `co`, `company`, `title`, `escrow` removed; `natl` → `national`). Placeholder entries meaning "no title company recorded" (`none available` and its misspellings, `unknown`, `n/a`, …) and names shorter than 3 characters are excluded rather than ranked. `attorney` and `accommodation` are kept: they say who closed. `pctUnits` / `pctVolume` are shares of the entity's WHOLE loan population in the window, including loans with no title company, so they do not sum to 100 across the page. Pages of up to 100 via `pagination`.
|
|
1188
|
+
*/
|
|
1189
|
+
static titleCompanies(options) {
|
|
1190
|
+
return (options.client ?? client).post({
|
|
1191
|
+
security: [{
|
|
1192
|
+
name: "x-api-key",
|
|
1193
|
+
type: "apiKey"
|
|
1194
|
+
}, {
|
|
1195
|
+
scheme: "bearer",
|
|
1196
|
+
type: "http"
|
|
1197
|
+
}],
|
|
1198
|
+
url: "/originators/{nmlsId}/breakdowns/title-companies",
|
|
1199
|
+
...options,
|
|
1200
|
+
headers: {
|
|
1201
|
+
"Content-Type": "application/json",
|
|
1202
|
+
...options?.headers
|
|
1203
|
+
}
|
|
1204
|
+
});
|
|
1205
|
+
}
|
|
1206
|
+
/**
|
|
1180
1207
|
* Zip-code volume breakdown
|
|
1181
1208
|
*/
|
|
1182
1209
|
static zipCodes(options) {
|
|
@@ -1343,9 +1370,11 @@ var Originators = class {
|
|
|
1343
1370
|
* Submit a bulk-delivery job for originators
|
|
1344
1371
|
* Queues an ECS task that dumps every matching originators document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/originators/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
1345
1372
|
*
|
|
1346
|
-
* **Row limit.** Deliveries of up to
|
|
1373
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.originators` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
1347
1374
|
*
|
|
1348
1375
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
1376
|
+
*
|
|
1377
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
1349
1378
|
*/
|
|
1350
1379
|
static submitOriginatorsBulkDelivery2(options) {
|
|
1351
1380
|
return (options?.client ?? client).post({
|
|
@@ -1620,6 +1649,27 @@ var Originators = class {
|
|
|
1620
1649
|
});
|
|
1621
1650
|
}
|
|
1622
1651
|
/**
|
|
1652
|
+
* Title companies on this LO's loans (spellings merged)
|
|
1653
|
+
* Ranks the title companies on this entity's loans (recorded deeds, `recording_date` window — the same population and period axis as every other loans breakdown). Spellings of one company are MERGED: `label` is its most-used spelling, `id` the normalized name every spelling was grouped under (legal-form and filler words such as `inc`, `llc`, `co`, `company`, `title`, `escrow` removed; `natl` → `national`). Placeholder entries meaning "no title company recorded" (`none available` and its misspellings, `unknown`, `n/a`, …) and names shorter than 3 characters are excluded rather than ranked. `attorney` and `accommodation` are kept: they say who closed. `pctUnits` / `pctVolume` are shares of the entity's WHOLE loan population in the window, including loans with no title company, so they do not sum to 100 across the page. Pages of up to 100 via `pagination`.
|
|
1654
|
+
*/
|
|
1655
|
+
static titleCompanies2(options) {
|
|
1656
|
+
return (options.client ?? client).post({
|
|
1657
|
+
security: [{
|
|
1658
|
+
name: "x-api-key",
|
|
1659
|
+
type: "apiKey"
|
|
1660
|
+
}, {
|
|
1661
|
+
scheme: "bearer",
|
|
1662
|
+
type: "http"
|
|
1663
|
+
}],
|
|
1664
|
+
url: "/v1/originators/{nmlsId}/breakdowns/title-companies",
|
|
1665
|
+
...options,
|
|
1666
|
+
headers: {
|
|
1667
|
+
"Content-Type": "application/json",
|
|
1668
|
+
...options?.headers
|
|
1669
|
+
}
|
|
1670
|
+
});
|
|
1671
|
+
}
|
|
1672
|
+
/**
|
|
1623
1673
|
* Zip-code volume breakdown
|
|
1624
1674
|
*/
|
|
1625
1675
|
static zipCodes2(options) {
|
|
@@ -2282,9 +2332,11 @@ var Branches = class {
|
|
|
2282
2332
|
* Submit a bulk-delivery job for branches
|
|
2283
2333
|
* Queues an ECS task that dumps every matching branches document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/branches/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
2284
2334
|
*
|
|
2285
|
-
* **Row limit.** Deliveries of up to
|
|
2335
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.branches` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
2286
2336
|
*
|
|
2287
2337
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
2338
|
+
*
|
|
2339
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
2288
2340
|
*/
|
|
2289
2341
|
static submitBranchesBulkDelivery(options) {
|
|
2290
2342
|
return (options?.client ?? client).post({
|
|
@@ -2484,6 +2536,27 @@ var Branches = class {
|
|
|
2484
2536
|
});
|
|
2485
2537
|
}
|
|
2486
2538
|
/**
|
|
2539
|
+
* Title companies on this branch's loans (spellings merged)
|
|
2540
|
+
* Ranks the title companies on this entity's loans (recorded deeds, `recording_date` window — the same population and period axis as every other loans breakdown). Spellings of one company are MERGED: `label` is its most-used spelling, `id` the normalized name every spelling was grouped under (legal-form and filler words such as `inc`, `llc`, `co`, `company`, `title`, `escrow` removed; `natl` → `national`). Placeholder entries meaning "no title company recorded" (`none available` and its misspellings, `unknown`, `n/a`, …) and names shorter than 3 characters are excluded rather than ranked. `attorney` and `accommodation` are kept: they say who closed. `pctUnits` / `pctVolume` are shares of the entity's WHOLE loan population in the window, including loans with no title company, so they do not sum to 100 across the page. Pages of up to 100 via `pagination`.
|
|
2541
|
+
*/
|
|
2542
|
+
static titleCompanies(options) {
|
|
2543
|
+
return (options.client ?? client).post({
|
|
2544
|
+
security: [{
|
|
2545
|
+
name: "x-api-key",
|
|
2546
|
+
type: "apiKey"
|
|
2547
|
+
}, {
|
|
2548
|
+
scheme: "bearer",
|
|
2549
|
+
type: "http"
|
|
2550
|
+
}],
|
|
2551
|
+
url: "/v1/branches/{nmlsId}/breakdowns/title-companies",
|
|
2552
|
+
...options,
|
|
2553
|
+
headers: {
|
|
2554
|
+
"Content-Type": "application/json",
|
|
2555
|
+
...options?.headers
|
|
2556
|
+
}
|
|
2557
|
+
});
|
|
2558
|
+
}
|
|
2559
|
+
/**
|
|
2487
2560
|
* Loans written by this branch
|
|
2488
2561
|
* 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}`.
|
|
2489
2562
|
*/
|
|
@@ -2612,9 +2685,11 @@ var Companies = class {
|
|
|
2612
2685
|
* Submit a bulk-delivery job for companies
|
|
2613
2686
|
* Queues an ECS task that dumps every matching companies document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/companies/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
2614
2687
|
*
|
|
2615
|
-
* **Row limit.** Deliveries of up to
|
|
2688
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.companies` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
2616
2689
|
*
|
|
2617
2690
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
2691
|
+
*
|
|
2692
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
2618
2693
|
*/
|
|
2619
2694
|
static submitCompaniesBulkDelivery(options) {
|
|
2620
2695
|
return (options?.client ?? client).post({
|
|
@@ -2910,6 +2985,27 @@ var Companies = class {
|
|
|
2910
2985
|
});
|
|
2911
2986
|
}
|
|
2912
2987
|
/**
|
|
2988
|
+
* Title companies on this company's loans (spellings merged)
|
|
2989
|
+
* Ranks the title companies on this entity's loans (recorded deeds, `recording_date` window — the same population and period axis as every other loans breakdown). Spellings of one company are MERGED: `label` is its most-used spelling, `id` the normalized name every spelling was grouped under (legal-form and filler words such as `inc`, `llc`, `co`, `company`, `title`, `escrow` removed; `natl` → `national`). Placeholder entries meaning "no title company recorded" (`none available` and its misspellings, `unknown`, `n/a`, …) and names shorter than 3 characters are excluded rather than ranked. `attorney` and `accommodation` are kept: they say who closed. `pctUnits` / `pctVolume` are shares of the entity's WHOLE loan population in the window, including loans with no title company, so they do not sum to 100 across the page. Pages of up to 100 via `pagination`.
|
|
2990
|
+
*/
|
|
2991
|
+
static titleCompanies(options) {
|
|
2992
|
+
return (options.client ?? client).post({
|
|
2993
|
+
security: [{
|
|
2994
|
+
name: "x-api-key",
|
|
2995
|
+
type: "apiKey"
|
|
2996
|
+
}, {
|
|
2997
|
+
scheme: "bearer",
|
|
2998
|
+
type: "http"
|
|
2999
|
+
}],
|
|
3000
|
+
url: "/v1/companies/{nmlsId}/breakdowns/title-companies",
|
|
3001
|
+
...options,
|
|
3002
|
+
headers: {
|
|
3003
|
+
"Content-Type": "application/json",
|
|
3004
|
+
...options?.headers
|
|
3005
|
+
}
|
|
3006
|
+
});
|
|
3007
|
+
}
|
|
3008
|
+
/**
|
|
2913
3009
|
* Zip-code volume breakdown across this company's loans
|
|
2914
3010
|
*/
|
|
2915
3011
|
static zipCodes(options) {
|
|
@@ -3150,6 +3246,46 @@ var Crm = class {
|
|
|
3150
3246
|
});
|
|
3151
3247
|
}
|
|
3152
3248
|
/**
|
|
3249
|
+
* Edit a logged activity entry
|
|
3250
|
+
*/
|
|
3251
|
+
static editCrmLoggedActivity(options) {
|
|
3252
|
+
return (options?.client ?? client).patch({
|
|
3253
|
+
security: [{
|
|
3254
|
+
name: "x-api-key",
|
|
3255
|
+
type: "apiKey"
|
|
3256
|
+
}, {
|
|
3257
|
+
scheme: "bearer",
|
|
3258
|
+
type: "http"
|
|
3259
|
+
}],
|
|
3260
|
+
url: "/v1/crm/activity/log",
|
|
3261
|
+
...options,
|
|
3262
|
+
headers: {
|
|
3263
|
+
"Content-Type": "application/json",
|
|
3264
|
+
...options?.headers
|
|
3265
|
+
}
|
|
3266
|
+
});
|
|
3267
|
+
}
|
|
3268
|
+
/**
|
|
3269
|
+
* Log a Call/Meeting/Email/Task that happened outside Model Match
|
|
3270
|
+
*/
|
|
3271
|
+
static logCrmActivity(options) {
|
|
3272
|
+
return (options?.client ?? client).post({
|
|
3273
|
+
security: [{
|
|
3274
|
+
name: "x-api-key",
|
|
3275
|
+
type: "apiKey"
|
|
3276
|
+
}, {
|
|
3277
|
+
scheme: "bearer",
|
|
3278
|
+
type: "http"
|
|
3279
|
+
}],
|
|
3280
|
+
url: "/v1/crm/activity/log",
|
|
3281
|
+
...options,
|
|
3282
|
+
headers: {
|
|
3283
|
+
"Content-Type": "application/json",
|
|
3284
|
+
...options?.headers
|
|
3285
|
+
}
|
|
3286
|
+
});
|
|
3287
|
+
}
|
|
3288
|
+
/**
|
|
3153
3289
|
* List notes from other records that reference this one (trickled up)
|
|
3154
3290
|
*/
|
|
3155
3291
|
static listCrmReferencedActivity(options) {
|
|
@@ -5532,9 +5668,11 @@ var Loans = class {
|
|
|
5532
5668
|
* Submit a bulk-delivery job for loans
|
|
5533
5669
|
* Queues an ECS task that dumps every matching loans document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/loans/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
5534
5670
|
*
|
|
5535
|
-
* **Row limit.** Deliveries of up to
|
|
5671
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.loans` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
5536
5672
|
*
|
|
5537
5673
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
5674
|
+
*
|
|
5675
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
5538
5676
|
*/
|
|
5539
5677
|
static submitLoansBulkDelivery(options) {
|
|
5540
5678
|
return (options?.client ?? client).post({
|
|
@@ -6149,9 +6287,11 @@ var Properties = class {
|
|
|
6149
6287
|
* Submit a bulk-delivery job for properties
|
|
6150
6288
|
* Queues an ECS task that dumps every matching properties document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/properties/bulk-delivery/{jobId}` for status + the signed download URL.
|
|
6151
6289
|
*
|
|
6152
|
-
* **Row limit.** Deliveries of up to
|
|
6290
|
+
* **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.properties` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase.
|
|
6153
6291
|
*
|
|
6154
6292
|
* Delivery is billed at 1 credit per row regardless of entitlement.
|
|
6293
|
+
*
|
|
6294
|
+
* **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery, except that push-target deliveries from the ModelMatch web app are not billed.
|
|
6155
6295
|
*/
|
|
6156
6296
|
static submitPropertiesBulkDelivery(options) {
|
|
6157
6297
|
return (options?.client ?? client).post({
|