@model-match/api 3.7.0 → 3.8.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-B_dYa7m6.d.mts → index-C2yk67yZ.d.mts} +7661 -2537
- package/dist/index.d.mts +2 -2
- package/dist/index.mjs +2 -2
- package/dist/slim/index.d.mts +418 -73
- package/dist/slim/index.mjs +1994 -321
- package/dist/{src-CwTkvxPw.mjs → src-D7ciHm-w.mjs} +1916 -243
- package/openapi.json +20530 -6860
- package/package.json +2 -2
|
@@ -29,195 +29,6 @@ var AdminJobs = class {
|
|
|
29
29
|
});
|
|
30
30
|
}
|
|
31
31
|
};
|
|
32
|
-
var AdminObservability = class {
|
|
33
|
-
/**
|
|
34
|
-
* List recent task runs (admin)
|
|
35
|
-
* Recent run traces across the background tasks, newest first, with status and duration. Filter by service, status, and time window.
|
|
36
|
-
*/
|
|
37
|
-
static adminListObservabilityRuns(options) {
|
|
38
|
-
return (options?.client ?? client).get({
|
|
39
|
-
security: [{
|
|
40
|
-
name: "x-api-key",
|
|
41
|
-
type: "apiKey"
|
|
42
|
-
}, {
|
|
43
|
-
scheme: "bearer",
|
|
44
|
-
type: "http"
|
|
45
|
-
}],
|
|
46
|
-
url: "/v1/admin/observability/runs",
|
|
47
|
-
...options
|
|
48
|
-
});
|
|
49
|
-
}
|
|
50
|
-
/**
|
|
51
|
-
* Get the span waterfall for one run (admin)
|
|
52
|
-
* All spans for a run, paired into start/end with durations and the parent links needed to render the waterfall.
|
|
53
|
-
*/
|
|
54
|
-
static adminGetObservabilityTrace(options) {
|
|
55
|
-
return (options.client ?? client).get({
|
|
56
|
-
security: [{
|
|
57
|
-
name: "x-api-key",
|
|
58
|
-
type: "apiKey"
|
|
59
|
-
}, {
|
|
60
|
-
scheme: "bearer",
|
|
61
|
-
type: "http"
|
|
62
|
-
}],
|
|
63
|
-
url: "/v1/admin/observability/runs/{runId}/trace",
|
|
64
|
-
...options
|
|
65
|
-
});
|
|
66
|
-
}
|
|
67
|
-
/**
|
|
68
|
-
* Get the full cross-platform trace for any anchor (admin)
|
|
69
|
-
* One stitched waterfall across MCP → API → job, entered from any id (an API request id, an MCP tool-call id, or a job/run id). The same view backs a run's, a request's, and an MCP call's Traces tab. 404 when the id matches nothing.
|
|
70
|
-
*/
|
|
71
|
-
static adminGetUnifiedTrace(options) {
|
|
72
|
-
return (options.client ?? client).get({
|
|
73
|
-
security: [{
|
|
74
|
-
name: "x-api-key",
|
|
75
|
-
type: "apiKey"
|
|
76
|
-
}, {
|
|
77
|
-
scheme: "bearer",
|
|
78
|
-
type: "http"
|
|
79
|
-
}],
|
|
80
|
-
url: "/v1/admin/observability/trace/{anchorId}",
|
|
81
|
-
...options
|
|
82
|
-
});
|
|
83
|
-
}
|
|
84
|
-
/**
|
|
85
|
-
* List recent API requests (admin)
|
|
86
|
-
* Recent per-request telemetry, newest first. Filter by route, method, status, actor kind, and time window.
|
|
87
|
-
*/
|
|
88
|
-
static adminListApiRequests(options) {
|
|
89
|
-
return (options?.client ?? client).get({
|
|
90
|
-
security: [{
|
|
91
|
-
name: "x-api-key",
|
|
92
|
-
type: "apiKey"
|
|
93
|
-
}, {
|
|
94
|
-
scheme: "bearer",
|
|
95
|
-
type: "http"
|
|
96
|
-
}],
|
|
97
|
-
url: "/v1/admin/observability/requests",
|
|
98
|
-
...options
|
|
99
|
-
});
|
|
100
|
-
}
|
|
101
|
-
/**
|
|
102
|
-
* API request trends and performance (admin)
|
|
103
|
-
* Volume, error rate, and latency percentiles over a time window — overall, per route, and bucketed over time.
|
|
104
|
-
*/
|
|
105
|
-
static adminGetApiRequestStats(options) {
|
|
106
|
-
return (options?.client ?? client).get({
|
|
107
|
-
security: [{
|
|
108
|
-
name: "x-api-key",
|
|
109
|
-
type: "apiKey"
|
|
110
|
-
}, {
|
|
111
|
-
scheme: "bearer",
|
|
112
|
-
type: "http"
|
|
113
|
-
}],
|
|
114
|
-
url: "/v1/admin/observability/requests/stats",
|
|
115
|
-
...options
|
|
116
|
-
});
|
|
117
|
-
}
|
|
118
|
-
/**
|
|
119
|
-
* Get one API request (admin)
|
|
120
|
-
* One request's full row, enriched with the MCP tool call that produced it when the request was MCP-originated.
|
|
121
|
-
*/
|
|
122
|
-
static adminGetApiRequest(options) {
|
|
123
|
-
return (options.client ?? client).get({
|
|
124
|
-
security: [{
|
|
125
|
-
name: "x-api-key",
|
|
126
|
-
type: "apiKey"
|
|
127
|
-
}, {
|
|
128
|
-
scheme: "bearer",
|
|
129
|
-
type: "http"
|
|
130
|
-
}],
|
|
131
|
-
url: "/v1/admin/observability/requests/{requestId}",
|
|
132
|
-
...options
|
|
133
|
-
});
|
|
134
|
-
}
|
|
135
|
-
/**
|
|
136
|
-
* Get the span waterfall for one request (admin)
|
|
137
|
-
* Spans a request emitted (e.g. a search: filters → build query → fetch → shape). 404 when the request emitted no spans.
|
|
138
|
-
*/
|
|
139
|
-
static adminGetApiRequestTrace(options) {
|
|
140
|
-
return (options.client ?? client).get({
|
|
141
|
-
security: [{
|
|
142
|
-
name: "x-api-key",
|
|
143
|
-
type: "apiKey"
|
|
144
|
-
}, {
|
|
145
|
-
scheme: "bearer",
|
|
146
|
-
type: "http"
|
|
147
|
-
}],
|
|
148
|
-
url: "/v1/admin/observability/requests/{requestId}/trace",
|
|
149
|
-
...options
|
|
150
|
-
});
|
|
151
|
-
}
|
|
152
|
-
/**
|
|
153
|
-
* MCP tool usage and performance (admin)
|
|
154
|
-
* Per-tool call counts, error rate, latency percentiles, and last-used time over a time window.
|
|
155
|
-
*/
|
|
156
|
-
static adminGetMcpToolStats(options) {
|
|
157
|
-
return (options?.client ?? client).get({
|
|
158
|
-
security: [{
|
|
159
|
-
name: "x-api-key",
|
|
160
|
-
type: "apiKey"
|
|
161
|
-
}, {
|
|
162
|
-
scheme: "bearer",
|
|
163
|
-
type: "http"
|
|
164
|
-
}],
|
|
165
|
-
url: "/v1/admin/observability/mcp/tools",
|
|
166
|
-
...options
|
|
167
|
-
});
|
|
168
|
-
}
|
|
169
|
-
/**
|
|
170
|
-
* List recent individual MCP tool calls (admin)
|
|
171
|
-
* Recent per-call MCP telemetry, newest first — the clickable feed behind the per-tool aggregates. Filter by tool, status, and time window.
|
|
172
|
-
*/
|
|
173
|
-
static adminListMcpCalls(options) {
|
|
174
|
-
return (options?.client ?? client).get({
|
|
175
|
-
security: [{
|
|
176
|
-
name: "x-api-key",
|
|
177
|
-
type: "apiKey"
|
|
178
|
-
}, {
|
|
179
|
-
scheme: "bearer",
|
|
180
|
-
type: "http"
|
|
181
|
-
}],
|
|
182
|
-
url: "/v1/admin/observability/mcp/calls",
|
|
183
|
-
...options
|
|
184
|
-
});
|
|
185
|
-
}
|
|
186
|
-
/**
|
|
187
|
-
* Alert decision counts by type and outcome (admin)
|
|
188
|
-
* Decision counts grouped by alert type and outcome (written / deduped / dry_run_match), over a window or scoped to one run via correlationId.
|
|
189
|
-
*/
|
|
190
|
-
static adminGetAlertDecisionStats(options) {
|
|
191
|
-
return (options?.client ?? client).get({
|
|
192
|
-
security: [{
|
|
193
|
-
name: "x-api-key",
|
|
194
|
-
type: "apiKey"
|
|
195
|
-
}, {
|
|
196
|
-
scheme: "bearer",
|
|
197
|
-
type: "http"
|
|
198
|
-
}],
|
|
199
|
-
url: "/v1/admin/observability/alerts/stats",
|
|
200
|
-
...options
|
|
201
|
-
});
|
|
202
|
-
}
|
|
203
|
-
/**
|
|
204
|
-
* List every evaluated alert decision (admin)
|
|
205
|
-
* The global alert feed across all users, newest first. Each row's outcome traces to its run via correlationId: a fire (written), a suppressed dupe (deduped), a dry-run preview (dry_run_match), or a configured user who got nothing — no_match (watched items scanned, none matched) / no_subjects (enabled but nothing to scan). Filter by type, outcome, user, workspace, run, or window.
|
|
206
|
-
*/
|
|
207
|
-
static adminListAlertDecisions(options) {
|
|
208
|
-
return (options?.client ?? client).get({
|
|
209
|
-
security: [{
|
|
210
|
-
name: "x-api-key",
|
|
211
|
-
type: "apiKey"
|
|
212
|
-
}, {
|
|
213
|
-
scheme: "bearer",
|
|
214
|
-
type: "http"
|
|
215
|
-
}],
|
|
216
|
-
url: "/v1/admin/observability/alerts",
|
|
217
|
-
...options
|
|
218
|
-
});
|
|
219
|
-
}
|
|
220
|
-
};
|
|
221
32
|
var Agents = class {
|
|
222
33
|
/**
|
|
223
34
|
* Search agents with filters
|
|
@@ -241,7 +52,7 @@ var Agents = class {
|
|
|
241
52
|
});
|
|
242
53
|
}
|
|
243
54
|
/**
|
|
244
|
-
* Get agent by ID
|
|
55
|
+
* Get agent by ID
|
|
245
56
|
*/
|
|
246
57
|
static get(options) {
|
|
247
58
|
return (options.client ?? client).get({
|
|
@@ -575,7 +386,7 @@ var Agents = class {
|
|
|
575
386
|
});
|
|
576
387
|
}
|
|
577
388
|
/**
|
|
578
|
-
* Get agent by ID
|
|
389
|
+
* Get agent by ID
|
|
579
390
|
*/
|
|
580
391
|
static getAgent2(options) {
|
|
581
392
|
return (options.client ?? client).get({
|
|
@@ -1030,6 +841,58 @@ var Alerts = class {
|
|
|
1030
841
|
});
|
|
1031
842
|
}
|
|
1032
843
|
/**
|
|
844
|
+
* List the documents you watch
|
|
845
|
+
*/
|
|
846
|
+
static listWatchedDocuments(options) {
|
|
847
|
+
return (options?.client ?? client).get({
|
|
848
|
+
security: [{
|
|
849
|
+
name: "x-api-key",
|
|
850
|
+
type: "apiKey"
|
|
851
|
+
}, {
|
|
852
|
+
scheme: "bearer",
|
|
853
|
+
type: "http"
|
|
854
|
+
}],
|
|
855
|
+
url: "/v1/alerts/watched-documents",
|
|
856
|
+
...options
|
|
857
|
+
});
|
|
858
|
+
}
|
|
859
|
+
/**
|
|
860
|
+
* Watch a document
|
|
861
|
+
*/
|
|
862
|
+
static addWatchedDocument(options) {
|
|
863
|
+
return (options?.client ?? client).post({
|
|
864
|
+
security: [{
|
|
865
|
+
name: "x-api-key",
|
|
866
|
+
type: "apiKey"
|
|
867
|
+
}, {
|
|
868
|
+
scheme: "bearer",
|
|
869
|
+
type: "http"
|
|
870
|
+
}],
|
|
871
|
+
url: "/v1/alerts/watched-documents",
|
|
872
|
+
...options,
|
|
873
|
+
headers: {
|
|
874
|
+
"Content-Type": "application/json",
|
|
875
|
+
...options?.headers
|
|
876
|
+
}
|
|
877
|
+
});
|
|
878
|
+
}
|
|
879
|
+
/**
|
|
880
|
+
* Stop watching a document
|
|
881
|
+
*/
|
|
882
|
+
static removeWatchedDocument(options) {
|
|
883
|
+
return (options.client ?? client).delete({
|
|
884
|
+
security: [{
|
|
885
|
+
name: "x-api-key",
|
|
886
|
+
type: "apiKey"
|
|
887
|
+
}, {
|
|
888
|
+
scheme: "bearer",
|
|
889
|
+
type: "http"
|
|
890
|
+
}],
|
|
891
|
+
url: "/v1/alerts/watched-documents/{documentType}/{documentId}",
|
|
892
|
+
...options
|
|
893
|
+
});
|
|
894
|
+
}
|
|
895
|
+
/**
|
|
1033
896
|
* List your alerts (newest first)
|
|
1034
897
|
*/
|
|
1035
898
|
static listAlertLog(options) {
|
|
@@ -1403,6 +1266,26 @@ var Companies = class {
|
|
|
1403
1266
|
});
|
|
1404
1267
|
}
|
|
1405
1268
|
/**
|
|
1269
|
+
* Broker shops that originated loans funding through this company. For a wholesale/TPO lender this is its top broker partners.
|
|
1270
|
+
*/
|
|
1271
|
+
static brokers(options) {
|
|
1272
|
+
return (options.client ?? client).post({
|
|
1273
|
+
security: [{
|
|
1274
|
+
name: "x-api-key",
|
|
1275
|
+
type: "apiKey"
|
|
1276
|
+
}, {
|
|
1277
|
+
scheme: "bearer",
|
|
1278
|
+
type: "http"
|
|
1279
|
+
}],
|
|
1280
|
+
url: "/v1/companies/{nmlsId}/breakdowns/brokers",
|
|
1281
|
+
...options,
|
|
1282
|
+
headers: {
|
|
1283
|
+
"Content-Type": "application/json",
|
|
1284
|
+
...options?.headers
|
|
1285
|
+
}
|
|
1286
|
+
});
|
|
1287
|
+
}
|
|
1288
|
+
/**
|
|
1406
1289
|
* Broker offices this company originated through
|
|
1407
1290
|
*/
|
|
1408
1291
|
static offices(options) {
|
|
@@ -1540,12 +1423,27 @@ var Companies = class {
|
|
|
1540
1423
|
});
|
|
1541
1424
|
}
|
|
1542
1425
|
};
|
|
1543
|
-
var
|
|
1426
|
+
var Crm = class {
|
|
1544
1427
|
/**
|
|
1545
|
-
*
|
|
1546
|
-
* Fast typeahead/autocomplete search across agents, originators, companies, and offices. Returns top matches per entity type. Use this for quick name lookups, not for filtered searches (use the entity-specific list endpoints for those).
|
|
1428
|
+
* Find an existing CRM record by NMLS id
|
|
1547
1429
|
*/
|
|
1548
|
-
static
|
|
1430
|
+
static findCrmRecordByNmls(options) {
|
|
1431
|
+
return (options.client ?? client).get({
|
|
1432
|
+
security: [{
|
|
1433
|
+
name: "x-api-key",
|
|
1434
|
+
type: "apiKey"
|
|
1435
|
+
}, {
|
|
1436
|
+
scheme: "bearer",
|
|
1437
|
+
type: "http"
|
|
1438
|
+
}],
|
|
1439
|
+
url: "/v1/crm/records/by-nmls",
|
|
1440
|
+
...options
|
|
1441
|
+
});
|
|
1442
|
+
}
|
|
1443
|
+
/**
|
|
1444
|
+
* Add a record to the CRM (and optionally a list)
|
|
1445
|
+
*/
|
|
1446
|
+
static addCrmRecord(options) {
|
|
1549
1447
|
return (options?.client ?? client).post({
|
|
1550
1448
|
security: [{
|
|
1551
1449
|
name: "x-api-key",
|
|
@@ -1554,7 +1452,7 @@ var Search = class {
|
|
|
1554
1452
|
scheme: "bearer",
|
|
1555
1453
|
type: "http"
|
|
1556
1454
|
}],
|
|
1557
|
-
url: "/v1/
|
|
1455
|
+
url: "/v1/crm/records/add",
|
|
1558
1456
|
...options,
|
|
1559
1457
|
headers: {
|
|
1560
1458
|
"Content-Type": "application/json",
|
|
@@ -1563,11 +1461,10 @@ var Search = class {
|
|
|
1563
1461
|
});
|
|
1564
1462
|
}
|
|
1565
1463
|
/**
|
|
1566
|
-
*
|
|
1567
|
-
* Returns a short-lived scoped search token plus the host to query, so a trusted client can search the entity indexes directly with per-query controls (e.g. attributesToSearchOn for name-only matching).
|
|
1464
|
+
* Remove one or more records from the CRM
|
|
1568
1465
|
*/
|
|
1569
|
-
static
|
|
1570
|
-
return (options?.client ?? client).
|
|
1466
|
+
static deleteCrmRecords(options) {
|
|
1467
|
+
return (options?.client ?? client).post({
|
|
1571
1468
|
security: [{
|
|
1572
1469
|
name: "x-api-key",
|
|
1573
1470
|
type: "apiKey"
|
|
@@ -1575,17 +1472,18 @@ var Search = class {
|
|
|
1575
1472
|
scheme: "bearer",
|
|
1576
1473
|
type: "http"
|
|
1577
1474
|
}],
|
|
1578
|
-
url: "/v1/
|
|
1579
|
-
...options
|
|
1475
|
+
url: "/v1/crm/records/delete",
|
|
1476
|
+
...options,
|
|
1477
|
+
headers: {
|
|
1478
|
+
"Content-Type": "application/json",
|
|
1479
|
+
...options?.headers
|
|
1480
|
+
}
|
|
1580
1481
|
});
|
|
1581
1482
|
}
|
|
1582
|
-
};
|
|
1583
|
-
var Lenders = class {
|
|
1584
1483
|
/**
|
|
1585
|
-
*
|
|
1586
|
-
* Search and list normalized lender names/identities with filters — resolves raw or variant lender names to canonical lender records. Use it to look up a lender by name or reconcile lender-name variants to a single canonical entity.
|
|
1484
|
+
* Create a manual (unmatched) CRM record
|
|
1587
1485
|
*/
|
|
1588
|
-
static
|
|
1486
|
+
static createCrmManualRecord(options) {
|
|
1589
1487
|
return (options?.client ?? client).post({
|
|
1590
1488
|
security: [{
|
|
1591
1489
|
name: "x-api-key",
|
|
@@ -1594,7 +1492,7 @@ var Lenders = class {
|
|
|
1594
1492
|
scheme: "bearer",
|
|
1595
1493
|
type: "http"
|
|
1596
1494
|
}],
|
|
1597
|
-
url: "/v1/
|
|
1495
|
+
url: "/v1/crm/records/create",
|
|
1598
1496
|
...options,
|
|
1599
1497
|
headers: {
|
|
1600
1498
|
"Content-Type": "application/json",
|
|
@@ -1603,10 +1501,10 @@ var Lenders = class {
|
|
|
1603
1501
|
});
|
|
1604
1502
|
}
|
|
1605
1503
|
/**
|
|
1606
|
-
*
|
|
1504
|
+
* Remove a record from the workspace CRM
|
|
1607
1505
|
*/
|
|
1608
|
-
static
|
|
1609
|
-
return (options.client ?? client).
|
|
1506
|
+
static deleteCrmRecord(options) {
|
|
1507
|
+
return (options.client ?? client).delete({
|
|
1610
1508
|
security: [{
|
|
1611
1509
|
name: "x-api-key",
|
|
1612
1510
|
type: "apiKey"
|
|
@@ -1614,18 +1512,15 @@ var Lenders = class {
|
|
|
1614
1512
|
scheme: "bearer",
|
|
1615
1513
|
type: "http"
|
|
1616
1514
|
}],
|
|
1617
|
-
url: "/v1/
|
|
1515
|
+
url: "/v1/crm/records",
|
|
1618
1516
|
...options
|
|
1619
1517
|
});
|
|
1620
1518
|
}
|
|
1621
|
-
};
|
|
1622
|
-
var Loans = class {
|
|
1623
1519
|
/**
|
|
1624
|
-
*
|
|
1625
|
-
* Search and list individual public-record mortgage and deed loan records — one row per loan (purchase, refinance, origination). Filter by geography (state, county, city, zip), lender, originator, loan amount, interest rate, loan type/purpose, and recording date, with sorting and cursor pagination. This is the discrete per-loan record search: use it to find specific loans or build a filtered loan list. (For aggregate market rates and volumes use the market search; for one loan by its ID use the loan detail endpoint.)
|
|
1520
|
+
* (Re)assign a record's working owner
|
|
1626
1521
|
*/
|
|
1627
|
-
static
|
|
1628
|
-
return (options?.client ?? client).
|
|
1522
|
+
static setCrmRecordOwner(options) {
|
|
1523
|
+
return (options?.client ?? client).patch({
|
|
1629
1524
|
security: [{
|
|
1630
1525
|
name: "x-api-key",
|
|
1631
1526
|
type: "apiKey"
|
|
@@ -1633,7 +1528,7 @@ var Loans = class {
|
|
|
1633
1528
|
scheme: "bearer",
|
|
1634
1529
|
type: "http"
|
|
1635
1530
|
}],
|
|
1636
|
-
url: "/v1/
|
|
1531
|
+
url: "/v1/crm/records",
|
|
1637
1532
|
...options,
|
|
1638
1533
|
headers: {
|
|
1639
1534
|
"Content-Type": "application/json",
|
|
@@ -1642,10 +1537,1748 @@ var Loans = class {
|
|
|
1642
1537
|
});
|
|
1643
1538
|
}
|
|
1644
1539
|
/**
|
|
1645
|
-
*
|
|
1540
|
+
* Create (or refresh) a canonical record from a match
|
|
1646
1541
|
*/
|
|
1647
|
-
static
|
|
1648
|
-
return (options
|
|
1542
|
+
static createCrmRecord(options) {
|
|
1543
|
+
return (options?.client ?? client).post({
|
|
1544
|
+
security: [{
|
|
1545
|
+
name: "x-api-key",
|
|
1546
|
+
type: "apiKey"
|
|
1547
|
+
}, {
|
|
1548
|
+
scheme: "bearer",
|
|
1549
|
+
type: "http"
|
|
1550
|
+
}],
|
|
1551
|
+
url: "/v1/crm/records",
|
|
1552
|
+
...options,
|
|
1553
|
+
headers: {
|
|
1554
|
+
"Content-Type": "application/json",
|
|
1555
|
+
...options?.headers
|
|
1556
|
+
}
|
|
1557
|
+
});
|
|
1558
|
+
}
|
|
1559
|
+
/**
|
|
1560
|
+
* Free-text search over CRM records
|
|
1561
|
+
*/
|
|
1562
|
+
static searchCrmRecords(options) {
|
|
1563
|
+
return (options?.client ?? client).post({
|
|
1564
|
+
security: [{
|
|
1565
|
+
name: "x-api-key",
|
|
1566
|
+
type: "apiKey"
|
|
1567
|
+
}, {
|
|
1568
|
+
scheme: "bearer",
|
|
1569
|
+
type: "http"
|
|
1570
|
+
}],
|
|
1571
|
+
url: "/v1/crm/records/search",
|
|
1572
|
+
...options,
|
|
1573
|
+
headers: {
|
|
1574
|
+
"Content-Type": "application/json",
|
|
1575
|
+
...options?.headers
|
|
1576
|
+
}
|
|
1577
|
+
});
|
|
1578
|
+
}
|
|
1579
|
+
/**
|
|
1580
|
+
* Bulk add records to the canonical CRM (listless)
|
|
1581
|
+
*/
|
|
1582
|
+
static addCrmRecordsBulk(options) {
|
|
1583
|
+
return (options?.client ?? client).post({
|
|
1584
|
+
security: [{
|
|
1585
|
+
name: "x-api-key",
|
|
1586
|
+
type: "apiKey"
|
|
1587
|
+
}, {
|
|
1588
|
+
scheme: "bearer",
|
|
1589
|
+
type: "http"
|
|
1590
|
+
}],
|
|
1591
|
+
url: "/v1/crm/records/add/bulk",
|
|
1592
|
+
...options,
|
|
1593
|
+
headers: {
|
|
1594
|
+
"Content-Type": "application/json",
|
|
1595
|
+
...options?.headers
|
|
1596
|
+
}
|
|
1597
|
+
});
|
|
1598
|
+
}
|
|
1599
|
+
/**
|
|
1600
|
+
* Get an add-time production-enrich job's status
|
|
1601
|
+
*/
|
|
1602
|
+
static getCrmProductionEnrichJob(options) {
|
|
1603
|
+
return (options.client ?? client).get({
|
|
1604
|
+
security: [{
|
|
1605
|
+
name: "x-api-key",
|
|
1606
|
+
type: "apiKey"
|
|
1607
|
+
}, {
|
|
1608
|
+
scheme: "bearer",
|
|
1609
|
+
type: "http"
|
|
1610
|
+
}],
|
|
1611
|
+
url: "/v1/crm/production-enrich/{jobId}",
|
|
1612
|
+
...options
|
|
1613
|
+
});
|
|
1614
|
+
}
|
|
1615
|
+
/**
|
|
1616
|
+
* Relationship cross-reference for a record (in-CRM partners + colleagues)
|
|
1617
|
+
*/
|
|
1618
|
+
static getCrmRecordConnections(options) {
|
|
1619
|
+
return (options?.client ?? client).post({
|
|
1620
|
+
security: [{
|
|
1621
|
+
name: "x-api-key",
|
|
1622
|
+
type: "apiKey"
|
|
1623
|
+
}, {
|
|
1624
|
+
scheme: "bearer",
|
|
1625
|
+
type: "http"
|
|
1626
|
+
}],
|
|
1627
|
+
url: "/v1/crm/records/connections",
|
|
1628
|
+
...options,
|
|
1629
|
+
headers: {
|
|
1630
|
+
"Content-Type": "application/json",
|
|
1631
|
+
...options?.headers
|
|
1632
|
+
}
|
|
1633
|
+
});
|
|
1634
|
+
}
|
|
1635
|
+
/**
|
|
1636
|
+
* Name-first search over visible CRM records for the mention picker
|
|
1637
|
+
*/
|
|
1638
|
+
static searchCrmMentionRecords(options) {
|
|
1639
|
+
return (options?.client ?? client).post({
|
|
1640
|
+
security: [{
|
|
1641
|
+
name: "x-api-key",
|
|
1642
|
+
type: "apiKey"
|
|
1643
|
+
}, {
|
|
1644
|
+
scheme: "bearer",
|
|
1645
|
+
type: "http"
|
|
1646
|
+
}],
|
|
1647
|
+
url: "/v1/crm/records/mention-search",
|
|
1648
|
+
...options,
|
|
1649
|
+
headers: {
|
|
1650
|
+
"Content-Type": "application/json",
|
|
1651
|
+
...options?.headers
|
|
1652
|
+
}
|
|
1653
|
+
});
|
|
1654
|
+
}
|
|
1655
|
+
/**
|
|
1656
|
+
* Aggregate profile read for a CRM record
|
|
1657
|
+
*/
|
|
1658
|
+
static getCrmRecordProfile(options) {
|
|
1659
|
+
return (options.client ?? client).get({
|
|
1660
|
+
security: [{
|
|
1661
|
+
name: "x-api-key",
|
|
1662
|
+
type: "apiKey"
|
|
1663
|
+
}, {
|
|
1664
|
+
scheme: "bearer",
|
|
1665
|
+
type: "http"
|
|
1666
|
+
}],
|
|
1667
|
+
url: "/v1/crm/profile",
|
|
1668
|
+
...options
|
|
1669
|
+
});
|
|
1670
|
+
}
|
|
1671
|
+
/**
|
|
1672
|
+
* List curated CRM records of an object type
|
|
1673
|
+
*/
|
|
1674
|
+
static listCrmMembers(options) {
|
|
1675
|
+
return (options.client ?? client).get({
|
|
1676
|
+
security: [{
|
|
1677
|
+
name: "x-api-key",
|
|
1678
|
+
type: "apiKey"
|
|
1679
|
+
}, {
|
|
1680
|
+
scheme: "bearer",
|
|
1681
|
+
type: "http"
|
|
1682
|
+
}],
|
|
1683
|
+
url: "/v1/crm/members",
|
|
1684
|
+
...options
|
|
1685
|
+
});
|
|
1686
|
+
}
|
|
1687
|
+
/**
|
|
1688
|
+
* Batch-read record overrides
|
|
1689
|
+
*/
|
|
1690
|
+
static getCrmOverrides(options) {
|
|
1691
|
+
return (options.client ?? client).get({
|
|
1692
|
+
security: [{
|
|
1693
|
+
name: "x-api-key",
|
|
1694
|
+
type: "apiKey"
|
|
1695
|
+
}, {
|
|
1696
|
+
scheme: "bearer",
|
|
1697
|
+
type: "http"
|
|
1698
|
+
}],
|
|
1699
|
+
url: "/v1/crm/overrides",
|
|
1700
|
+
...options
|
|
1701
|
+
});
|
|
1702
|
+
}
|
|
1703
|
+
/**
|
|
1704
|
+
* Set a single override field on a record
|
|
1705
|
+
*/
|
|
1706
|
+
static setCrmOverride(options) {
|
|
1707
|
+
return (options?.client ?? client).patch({
|
|
1708
|
+
security: [{
|
|
1709
|
+
name: "x-api-key",
|
|
1710
|
+
type: "apiKey"
|
|
1711
|
+
}, {
|
|
1712
|
+
scheme: "bearer",
|
|
1713
|
+
type: "http"
|
|
1714
|
+
}],
|
|
1715
|
+
url: "/v1/crm/overrides",
|
|
1716
|
+
...options,
|
|
1717
|
+
headers: {
|
|
1718
|
+
"Content-Type": "application/json",
|
|
1719
|
+
...options?.headers
|
|
1720
|
+
}
|
|
1721
|
+
});
|
|
1722
|
+
}
|
|
1723
|
+
/**
|
|
1724
|
+
* Auto-generate a record's description from the web
|
|
1725
|
+
*/
|
|
1726
|
+
static generateCrmRecordDescription(options) {
|
|
1727
|
+
return (options?.client ?? client).post({
|
|
1728
|
+
security: [{
|
|
1729
|
+
name: "x-api-key",
|
|
1730
|
+
type: "apiKey"
|
|
1731
|
+
}, {
|
|
1732
|
+
scheme: "bearer",
|
|
1733
|
+
type: "http"
|
|
1734
|
+
}],
|
|
1735
|
+
url: "/v1/crm/records/generate-description",
|
|
1736
|
+
...options,
|
|
1737
|
+
headers: {
|
|
1738
|
+
"Content-Type": "application/json",
|
|
1739
|
+
...options?.headers
|
|
1740
|
+
}
|
|
1741
|
+
});
|
|
1742
|
+
}
|
|
1743
|
+
/**
|
|
1744
|
+
* List the caller's lists (picker mode with ?entityId adds hasMember)
|
|
1745
|
+
*/
|
|
1746
|
+
static listCrmLists(options) {
|
|
1747
|
+
return (options?.client ?? client).get({
|
|
1748
|
+
security: [{
|
|
1749
|
+
name: "x-api-key",
|
|
1750
|
+
type: "apiKey"
|
|
1751
|
+
}, {
|
|
1752
|
+
scheme: "bearer",
|
|
1753
|
+
type: "http"
|
|
1754
|
+
}],
|
|
1755
|
+
url: "/v1/crm/lists",
|
|
1756
|
+
...options
|
|
1757
|
+
});
|
|
1758
|
+
}
|
|
1759
|
+
/**
|
|
1760
|
+
* Create a list
|
|
1761
|
+
*/
|
|
1762
|
+
static createCrmList(options) {
|
|
1763
|
+
return (options?.client ?? client).post({
|
|
1764
|
+
security: [{
|
|
1765
|
+
name: "x-api-key",
|
|
1766
|
+
type: "apiKey"
|
|
1767
|
+
}, {
|
|
1768
|
+
scheme: "bearer",
|
|
1769
|
+
type: "http"
|
|
1770
|
+
}],
|
|
1771
|
+
url: "/v1/crm/lists",
|
|
1772
|
+
...options,
|
|
1773
|
+
headers: {
|
|
1774
|
+
"Content-Type": "application/json",
|
|
1775
|
+
...options?.headers
|
|
1776
|
+
}
|
|
1777
|
+
});
|
|
1778
|
+
}
|
|
1779
|
+
/**
|
|
1780
|
+
* Delete a list
|
|
1781
|
+
*/
|
|
1782
|
+
static deleteCrmList(options) {
|
|
1783
|
+
return (options.client ?? client).delete({
|
|
1784
|
+
security: [{
|
|
1785
|
+
name: "x-api-key",
|
|
1786
|
+
type: "apiKey"
|
|
1787
|
+
}, {
|
|
1788
|
+
scheme: "bearer",
|
|
1789
|
+
type: "http"
|
|
1790
|
+
}],
|
|
1791
|
+
url: "/v1/crm/lists/{id}",
|
|
1792
|
+
...options
|
|
1793
|
+
});
|
|
1794
|
+
}
|
|
1795
|
+
/**
|
|
1796
|
+
* Get a list with its members
|
|
1797
|
+
*/
|
|
1798
|
+
static getCrmList(options) {
|
|
1799
|
+
return (options.client ?? client).get({
|
|
1800
|
+
security: [{
|
|
1801
|
+
name: "x-api-key",
|
|
1802
|
+
type: "apiKey"
|
|
1803
|
+
}, {
|
|
1804
|
+
scheme: "bearer",
|
|
1805
|
+
type: "http"
|
|
1806
|
+
}],
|
|
1807
|
+
url: "/v1/crm/lists/{id}",
|
|
1808
|
+
...options
|
|
1809
|
+
});
|
|
1810
|
+
}
|
|
1811
|
+
/**
|
|
1812
|
+
* Update a list's name, visibility, or whole-org role
|
|
1813
|
+
*/
|
|
1814
|
+
static updateCrmList(options) {
|
|
1815
|
+
return (options.client ?? client).patch({
|
|
1816
|
+
security: [{
|
|
1817
|
+
name: "x-api-key",
|
|
1818
|
+
type: "apiKey"
|
|
1819
|
+
}, {
|
|
1820
|
+
scheme: "bearer",
|
|
1821
|
+
type: "http"
|
|
1822
|
+
}],
|
|
1823
|
+
url: "/v1/crm/lists/{id}",
|
|
1824
|
+
...options,
|
|
1825
|
+
headers: {
|
|
1826
|
+
"Content-Type": "application/json",
|
|
1827
|
+
...options?.headers
|
|
1828
|
+
}
|
|
1829
|
+
});
|
|
1830
|
+
}
|
|
1831
|
+
/**
|
|
1832
|
+
* Remove a member from a list
|
|
1833
|
+
*/
|
|
1834
|
+
static removeCrmListMember(options) {
|
|
1835
|
+
return (options.client ?? client).delete({
|
|
1836
|
+
security: [{
|
|
1837
|
+
name: "x-api-key",
|
|
1838
|
+
type: "apiKey"
|
|
1839
|
+
}, {
|
|
1840
|
+
scheme: "bearer",
|
|
1841
|
+
type: "http"
|
|
1842
|
+
}],
|
|
1843
|
+
url: "/v1/crm/lists/{id}/members",
|
|
1844
|
+
...options,
|
|
1845
|
+
headers: {
|
|
1846
|
+
"Content-Type": "application/json",
|
|
1847
|
+
...options?.headers
|
|
1848
|
+
}
|
|
1849
|
+
});
|
|
1850
|
+
}
|
|
1851
|
+
/**
|
|
1852
|
+
* Add a member to a list
|
|
1853
|
+
*/
|
|
1854
|
+
static addCrmListMember(options) {
|
|
1855
|
+
return (options.client ?? client).post({
|
|
1856
|
+
security: [{
|
|
1857
|
+
name: "x-api-key",
|
|
1858
|
+
type: "apiKey"
|
|
1859
|
+
}, {
|
|
1860
|
+
scheme: "bearer",
|
|
1861
|
+
type: "http"
|
|
1862
|
+
}],
|
|
1863
|
+
url: "/v1/crm/lists/{id}/members",
|
|
1864
|
+
...options,
|
|
1865
|
+
headers: {
|
|
1866
|
+
"Content-Type": "application/json",
|
|
1867
|
+
...options?.headers
|
|
1868
|
+
}
|
|
1869
|
+
});
|
|
1870
|
+
}
|
|
1871
|
+
/**
|
|
1872
|
+
* Filter a list's members by entity attributes (read)
|
|
1873
|
+
*/
|
|
1874
|
+
static filterCrmListMembers(options) {
|
|
1875
|
+
return (options.client ?? client).post({
|
|
1876
|
+
security: [{
|
|
1877
|
+
name: "x-api-key",
|
|
1878
|
+
type: "apiKey"
|
|
1879
|
+
}, {
|
|
1880
|
+
scheme: "bearer",
|
|
1881
|
+
type: "http"
|
|
1882
|
+
}],
|
|
1883
|
+
url: "/v1/crm/lists/{id}/filter-members",
|
|
1884
|
+
...options,
|
|
1885
|
+
headers: {
|
|
1886
|
+
"Content-Type": "application/json",
|
|
1887
|
+
...options?.headers
|
|
1888
|
+
}
|
|
1889
|
+
});
|
|
1890
|
+
}
|
|
1891
|
+
/**
|
|
1892
|
+
* Add many members to a list
|
|
1893
|
+
*/
|
|
1894
|
+
static addCrmListMembersBulk(options) {
|
|
1895
|
+
return (options.client ?? client).post({
|
|
1896
|
+
security: [{
|
|
1897
|
+
name: "x-api-key",
|
|
1898
|
+
type: "apiKey"
|
|
1899
|
+
}, {
|
|
1900
|
+
scheme: "bearer",
|
|
1901
|
+
type: "http"
|
|
1902
|
+
}],
|
|
1903
|
+
url: "/v1/crm/lists/{id}/members/bulk",
|
|
1904
|
+
...options,
|
|
1905
|
+
headers: {
|
|
1906
|
+
"Content-Type": "application/json",
|
|
1907
|
+
...options?.headers
|
|
1908
|
+
}
|
|
1909
|
+
});
|
|
1910
|
+
}
|
|
1911
|
+
/**
|
|
1912
|
+
* Revoke a member's access to a list
|
|
1913
|
+
*/
|
|
1914
|
+
static revokeCrmListAccess(options) {
|
|
1915
|
+
return (options.client ?? client).delete({
|
|
1916
|
+
security: [{
|
|
1917
|
+
name: "x-api-key",
|
|
1918
|
+
type: "apiKey"
|
|
1919
|
+
}, {
|
|
1920
|
+
scheme: "bearer",
|
|
1921
|
+
type: "http"
|
|
1922
|
+
}],
|
|
1923
|
+
url: "/v1/crm/lists/{id}/shares",
|
|
1924
|
+
...options,
|
|
1925
|
+
headers: {
|
|
1926
|
+
"Content-Type": "application/json",
|
|
1927
|
+
...options?.headers
|
|
1928
|
+
}
|
|
1929
|
+
});
|
|
1930
|
+
}
|
|
1931
|
+
/**
|
|
1932
|
+
* Get a list's sharing state (+ owner display, canManageSharing)
|
|
1933
|
+
*/
|
|
1934
|
+
static getCrmListShares(options) {
|
|
1935
|
+
return (options.client ?? client).get({
|
|
1936
|
+
security: [{
|
|
1937
|
+
name: "x-api-key",
|
|
1938
|
+
type: "apiKey"
|
|
1939
|
+
}, {
|
|
1940
|
+
scheme: "bearer",
|
|
1941
|
+
type: "http"
|
|
1942
|
+
}],
|
|
1943
|
+
url: "/v1/crm/lists/{id}/shares",
|
|
1944
|
+
...options
|
|
1945
|
+
});
|
|
1946
|
+
}
|
|
1947
|
+
/**
|
|
1948
|
+
* Transfer a list's ownership to another member
|
|
1949
|
+
*/
|
|
1950
|
+
static transferCrmListOwnership(options) {
|
|
1951
|
+
return (options.client ?? client).patch({
|
|
1952
|
+
security: [{
|
|
1953
|
+
name: "x-api-key",
|
|
1954
|
+
type: "apiKey"
|
|
1955
|
+
}, {
|
|
1956
|
+
scheme: "bearer",
|
|
1957
|
+
type: "http"
|
|
1958
|
+
}],
|
|
1959
|
+
url: "/v1/crm/lists/{id}/shares",
|
|
1960
|
+
...options,
|
|
1961
|
+
headers: {
|
|
1962
|
+
"Content-Type": "application/json",
|
|
1963
|
+
...options?.headers
|
|
1964
|
+
}
|
|
1965
|
+
});
|
|
1966
|
+
}
|
|
1967
|
+
/**
|
|
1968
|
+
* Grant a member access to a list
|
|
1969
|
+
*/
|
|
1970
|
+
static grantCrmListAccess(options) {
|
|
1971
|
+
return (options.client ?? client).post({
|
|
1972
|
+
security: [{
|
|
1973
|
+
name: "x-api-key",
|
|
1974
|
+
type: "apiKey"
|
|
1975
|
+
}, {
|
|
1976
|
+
scheme: "bearer",
|
|
1977
|
+
type: "http"
|
|
1978
|
+
}],
|
|
1979
|
+
url: "/v1/crm/lists/{id}/shares",
|
|
1980
|
+
...options,
|
|
1981
|
+
headers: {
|
|
1982
|
+
"Content-Type": "application/json",
|
|
1983
|
+
...options?.headers
|
|
1984
|
+
}
|
|
1985
|
+
});
|
|
1986
|
+
}
|
|
1987
|
+
/**
|
|
1988
|
+
* Delete a custom field
|
|
1989
|
+
*/
|
|
1990
|
+
static deleteCrmListField(options) {
|
|
1991
|
+
return (options.client ?? client).delete({
|
|
1992
|
+
security: [{
|
|
1993
|
+
name: "x-api-key",
|
|
1994
|
+
type: "apiKey"
|
|
1995
|
+
}, {
|
|
1996
|
+
scheme: "bearer",
|
|
1997
|
+
type: "http"
|
|
1998
|
+
}],
|
|
1999
|
+
url: "/v1/crm/lists/{id}/fields",
|
|
2000
|
+
...options,
|
|
2001
|
+
headers: {
|
|
2002
|
+
"Content-Type": "application/json",
|
|
2003
|
+
...options?.headers
|
|
2004
|
+
}
|
|
2005
|
+
});
|
|
2006
|
+
}
|
|
2007
|
+
/**
|
|
2008
|
+
* List the custom fields applicable to a list
|
|
2009
|
+
*/
|
|
2010
|
+
static listCrmListFields(options) {
|
|
2011
|
+
return (options.client ?? client).get({
|
|
2012
|
+
security: [{
|
|
2013
|
+
name: "x-api-key",
|
|
2014
|
+
type: "apiKey"
|
|
2015
|
+
}, {
|
|
2016
|
+
scheme: "bearer",
|
|
2017
|
+
type: "http"
|
|
2018
|
+
}],
|
|
2019
|
+
url: "/v1/crm/lists/{id}/fields",
|
|
2020
|
+
...options
|
|
2021
|
+
});
|
|
2022
|
+
}
|
|
2023
|
+
/**
|
|
2024
|
+
* Update a custom field's mutable props
|
|
2025
|
+
*/
|
|
2026
|
+
static updateCrmListField(options) {
|
|
2027
|
+
return (options.client ?? client).patch({
|
|
2028
|
+
security: [{
|
|
2029
|
+
name: "x-api-key",
|
|
2030
|
+
type: "apiKey"
|
|
2031
|
+
}, {
|
|
2032
|
+
scheme: "bearer",
|
|
2033
|
+
type: "http"
|
|
2034
|
+
}],
|
|
2035
|
+
url: "/v1/crm/lists/{id}/fields",
|
|
2036
|
+
...options,
|
|
2037
|
+
headers: {
|
|
2038
|
+
"Content-Type": "application/json",
|
|
2039
|
+
...options?.headers
|
|
2040
|
+
}
|
|
2041
|
+
});
|
|
2042
|
+
}
|
|
2043
|
+
/**
|
|
2044
|
+
* Create a list-scoped custom field
|
|
2045
|
+
*/
|
|
2046
|
+
static createCrmListField(options) {
|
|
2047
|
+
return (options.client ?? client).post({
|
|
2048
|
+
security: [{
|
|
2049
|
+
name: "x-api-key",
|
|
2050
|
+
type: "apiKey"
|
|
2051
|
+
}, {
|
|
2052
|
+
scheme: "bearer",
|
|
2053
|
+
type: "http"
|
|
2054
|
+
}],
|
|
2055
|
+
url: "/v1/crm/lists/{id}/fields",
|
|
2056
|
+
...options,
|
|
2057
|
+
headers: {
|
|
2058
|
+
"Content-Type": "application/json",
|
|
2059
|
+
...options?.headers
|
|
2060
|
+
}
|
|
2061
|
+
});
|
|
2062
|
+
}
|
|
2063
|
+
/**
|
|
2064
|
+
* Replay a template's fields onto a list
|
|
2065
|
+
*/
|
|
2066
|
+
static applyCrmListTemplate(options) {
|
|
2067
|
+
return (options.client ?? client).post({
|
|
2068
|
+
security: [{
|
|
2069
|
+
name: "x-api-key",
|
|
2070
|
+
type: "apiKey"
|
|
2071
|
+
}, {
|
|
2072
|
+
scheme: "bearer",
|
|
2073
|
+
type: "http"
|
|
2074
|
+
}],
|
|
2075
|
+
url: "/v1/crm/lists/{id}/apply-template",
|
|
2076
|
+
...options,
|
|
2077
|
+
headers: {
|
|
2078
|
+
"Content-Type": "application/json",
|
|
2079
|
+
...options?.headers
|
|
2080
|
+
}
|
|
2081
|
+
});
|
|
2082
|
+
}
|
|
2083
|
+
/**
|
|
2084
|
+
* List the active org's members
|
|
2085
|
+
*/
|
|
2086
|
+
static listCrmOrgMembers(options) {
|
|
2087
|
+
return (options?.client ?? client).get({
|
|
2088
|
+
security: [{
|
|
2089
|
+
name: "x-api-key",
|
|
2090
|
+
type: "apiKey"
|
|
2091
|
+
}, {
|
|
2092
|
+
scheme: "bearer",
|
|
2093
|
+
type: "http"
|
|
2094
|
+
}],
|
|
2095
|
+
url: "/v1/crm/org-members",
|
|
2096
|
+
...options
|
|
2097
|
+
});
|
|
2098
|
+
}
|
|
2099
|
+
/**
|
|
2100
|
+
* List who can be assigned on a list (access-filtered by visibility)
|
|
2101
|
+
*/
|
|
2102
|
+
static listCrmListAssignees(options) {
|
|
2103
|
+
return (options.client ?? client).get({
|
|
2104
|
+
security: [{
|
|
2105
|
+
name: "x-api-key",
|
|
2106
|
+
type: "apiKey"
|
|
2107
|
+
}, {
|
|
2108
|
+
scheme: "bearer",
|
|
2109
|
+
type: "http"
|
|
2110
|
+
}],
|
|
2111
|
+
url: "/v1/crm/lists/{id}/assignees",
|
|
2112
|
+
...options
|
|
2113
|
+
});
|
|
2114
|
+
}
|
|
2115
|
+
/**
|
|
2116
|
+
* Soft-delete a note
|
|
2117
|
+
*/
|
|
2118
|
+
static deleteCrmNote(options) {
|
|
2119
|
+
return (options?.client ?? client).delete({
|
|
2120
|
+
security: [{
|
|
2121
|
+
name: "x-api-key",
|
|
2122
|
+
type: "apiKey"
|
|
2123
|
+
}, {
|
|
2124
|
+
scheme: "bearer",
|
|
2125
|
+
type: "http"
|
|
2126
|
+
}],
|
|
2127
|
+
url: "/v1/crm/activity",
|
|
2128
|
+
...options,
|
|
2129
|
+
headers: {
|
|
2130
|
+
"Content-Type": "application/json",
|
|
2131
|
+
...options?.headers
|
|
2132
|
+
}
|
|
2133
|
+
});
|
|
2134
|
+
}
|
|
2135
|
+
/**
|
|
2136
|
+
* List a record's activity timeline (newest first)
|
|
2137
|
+
*/
|
|
2138
|
+
static listCrmActivity(options) {
|
|
2139
|
+
return (options.client ?? client).get({
|
|
2140
|
+
security: [{
|
|
2141
|
+
name: "x-api-key",
|
|
2142
|
+
type: "apiKey"
|
|
2143
|
+
}, {
|
|
2144
|
+
scheme: "bearer",
|
|
2145
|
+
type: "http"
|
|
2146
|
+
}],
|
|
2147
|
+
url: "/v1/crm/activity",
|
|
2148
|
+
...options
|
|
2149
|
+
});
|
|
2150
|
+
}
|
|
2151
|
+
/**
|
|
2152
|
+
* Edit a note's body
|
|
2153
|
+
*/
|
|
2154
|
+
static editCrmNote(options) {
|
|
2155
|
+
return (options?.client ?? client).patch({
|
|
2156
|
+
security: [{
|
|
2157
|
+
name: "x-api-key",
|
|
2158
|
+
type: "apiKey"
|
|
2159
|
+
}, {
|
|
2160
|
+
scheme: "bearer",
|
|
2161
|
+
type: "http"
|
|
2162
|
+
}],
|
|
2163
|
+
url: "/v1/crm/activity",
|
|
2164
|
+
...options,
|
|
2165
|
+
headers: {
|
|
2166
|
+
"Content-Type": "application/json",
|
|
2167
|
+
...options?.headers
|
|
2168
|
+
}
|
|
2169
|
+
});
|
|
2170
|
+
}
|
|
2171
|
+
/**
|
|
2172
|
+
* Append a note to a record's timeline
|
|
2173
|
+
*/
|
|
2174
|
+
static addCrmNote(options) {
|
|
2175
|
+
return (options?.client ?? client).post({
|
|
2176
|
+
security: [{
|
|
2177
|
+
name: "x-api-key",
|
|
2178
|
+
type: "apiKey"
|
|
2179
|
+
}, {
|
|
2180
|
+
scheme: "bearer",
|
|
2181
|
+
type: "http"
|
|
2182
|
+
}],
|
|
2183
|
+
url: "/v1/crm/activity",
|
|
2184
|
+
...options,
|
|
2185
|
+
headers: {
|
|
2186
|
+
"Content-Type": "application/json",
|
|
2187
|
+
...options?.headers
|
|
2188
|
+
}
|
|
2189
|
+
});
|
|
2190
|
+
}
|
|
2191
|
+
/**
|
|
2192
|
+
* Delete a task
|
|
2193
|
+
*/
|
|
2194
|
+
static deleteCrmTask(options) {
|
|
2195
|
+
return (options?.client ?? client).delete({
|
|
2196
|
+
security: [{
|
|
2197
|
+
name: "x-api-key",
|
|
2198
|
+
type: "apiKey"
|
|
2199
|
+
}, {
|
|
2200
|
+
scheme: "bearer",
|
|
2201
|
+
type: "http"
|
|
2202
|
+
}],
|
|
2203
|
+
url: "/v1/crm/tasks",
|
|
2204
|
+
...options,
|
|
2205
|
+
headers: {
|
|
2206
|
+
"Content-Type": "application/json",
|
|
2207
|
+
...options?.headers
|
|
2208
|
+
}
|
|
2209
|
+
});
|
|
2210
|
+
}
|
|
2211
|
+
/**
|
|
2212
|
+
* List tasks for a record or for an assignee
|
|
2213
|
+
*/
|
|
2214
|
+
static listCrmTasks(options) {
|
|
2215
|
+
return (options?.client ?? client).get({
|
|
2216
|
+
security: [{
|
|
2217
|
+
name: "x-api-key",
|
|
2218
|
+
type: "apiKey"
|
|
2219
|
+
}, {
|
|
2220
|
+
scheme: "bearer",
|
|
2221
|
+
type: "http"
|
|
2222
|
+
}],
|
|
2223
|
+
url: "/v1/crm/tasks",
|
|
2224
|
+
...options
|
|
2225
|
+
});
|
|
2226
|
+
}
|
|
2227
|
+
/**
|
|
2228
|
+
* Edit a task, or transition it to completed/cancelled
|
|
2229
|
+
*/
|
|
2230
|
+
static updateCrmTask(options) {
|
|
2231
|
+
return (options?.client ?? client).patch({
|
|
2232
|
+
security: [{
|
|
2233
|
+
name: "x-api-key",
|
|
2234
|
+
type: "apiKey"
|
|
2235
|
+
}, {
|
|
2236
|
+
scheme: "bearer",
|
|
2237
|
+
type: "http"
|
|
2238
|
+
}],
|
|
2239
|
+
url: "/v1/crm/tasks",
|
|
2240
|
+
...options,
|
|
2241
|
+
headers: {
|
|
2242
|
+
"Content-Type": "application/json",
|
|
2243
|
+
...options?.headers
|
|
2244
|
+
}
|
|
2245
|
+
});
|
|
2246
|
+
}
|
|
2247
|
+
/**
|
|
2248
|
+
* Create a task on a record
|
|
2249
|
+
*/
|
|
2250
|
+
static createCrmTask(options) {
|
|
2251
|
+
return (options?.client ?? client).post({
|
|
2252
|
+
security: [{
|
|
2253
|
+
name: "x-api-key",
|
|
2254
|
+
type: "apiKey"
|
|
2255
|
+
}, {
|
|
2256
|
+
scheme: "bearer",
|
|
2257
|
+
type: "http"
|
|
2258
|
+
}],
|
|
2259
|
+
url: "/v1/crm/tasks",
|
|
2260
|
+
...options,
|
|
2261
|
+
headers: {
|
|
2262
|
+
"Content-Type": "application/json",
|
|
2263
|
+
...options?.headers
|
|
2264
|
+
}
|
|
2265
|
+
});
|
|
2266
|
+
}
|
|
2267
|
+
/**
|
|
2268
|
+
* Cross-record task inbox for the caller's visible records
|
|
2269
|
+
*/
|
|
2270
|
+
static listCrmWorkspaceTasks(options) {
|
|
2271
|
+
return (options?.client ?? client).get({
|
|
2272
|
+
security: [{
|
|
2273
|
+
name: "x-api-key",
|
|
2274
|
+
type: "apiKey"
|
|
2275
|
+
}, {
|
|
2276
|
+
scheme: "bearer",
|
|
2277
|
+
type: "http"
|
|
2278
|
+
}],
|
|
2279
|
+
url: "/v1/crm/tasks/workspace",
|
|
2280
|
+
...options
|
|
2281
|
+
});
|
|
2282
|
+
}
|
|
2283
|
+
/**
|
|
2284
|
+
* Pull calendar changes and apply them (one record, or user-wide)
|
|
2285
|
+
*/
|
|
2286
|
+
static reconcileCrmMeetings(options) {
|
|
2287
|
+
return (options?.client ?? client).post({
|
|
2288
|
+
security: [{
|
|
2289
|
+
name: "x-api-key",
|
|
2290
|
+
type: "apiKey"
|
|
2291
|
+
}, {
|
|
2292
|
+
scheme: "bearer",
|
|
2293
|
+
type: "http"
|
|
2294
|
+
}],
|
|
2295
|
+
url: "/v1/crm/meetings/reconcile",
|
|
2296
|
+
...options,
|
|
2297
|
+
headers: {
|
|
2298
|
+
"Content-Type": "application/json",
|
|
2299
|
+
...options?.headers
|
|
2300
|
+
}
|
|
2301
|
+
});
|
|
2302
|
+
}
|
|
2303
|
+
/**
|
|
2304
|
+
* Delete a meeting (and its provider event)
|
|
2305
|
+
*/
|
|
2306
|
+
static deleteCrmMeeting(options) {
|
|
2307
|
+
return (options.client ?? client).delete({
|
|
2308
|
+
security: [{
|
|
2309
|
+
name: "x-api-key",
|
|
2310
|
+
type: "apiKey"
|
|
2311
|
+
}, {
|
|
2312
|
+
scheme: "bearer",
|
|
2313
|
+
type: "http"
|
|
2314
|
+
}],
|
|
2315
|
+
url: "/v1/crm/meetings",
|
|
2316
|
+
...options
|
|
2317
|
+
});
|
|
2318
|
+
}
|
|
2319
|
+
/**
|
|
2320
|
+
* List meetings for a record
|
|
2321
|
+
*/
|
|
2322
|
+
static listCrmMeetings(options) {
|
|
2323
|
+
return (options.client ?? client).get({
|
|
2324
|
+
security: [{
|
|
2325
|
+
name: "x-api-key",
|
|
2326
|
+
type: "apiKey"
|
|
2327
|
+
}, {
|
|
2328
|
+
scheme: "bearer",
|
|
2329
|
+
type: "http"
|
|
2330
|
+
}],
|
|
2331
|
+
url: "/v1/crm/meetings",
|
|
2332
|
+
...options
|
|
2333
|
+
});
|
|
2334
|
+
}
|
|
2335
|
+
/**
|
|
2336
|
+
* Update, cancel, complete, or re-sync a meeting
|
|
2337
|
+
*/
|
|
2338
|
+
static updateCrmMeeting(options) {
|
|
2339
|
+
return (options?.client ?? client).patch({
|
|
2340
|
+
security: [{
|
|
2341
|
+
name: "x-api-key",
|
|
2342
|
+
type: "apiKey"
|
|
2343
|
+
}, {
|
|
2344
|
+
scheme: "bearer",
|
|
2345
|
+
type: "http"
|
|
2346
|
+
}],
|
|
2347
|
+
url: "/v1/crm/meetings",
|
|
2348
|
+
...options,
|
|
2349
|
+
headers: {
|
|
2350
|
+
"Content-Type": "application/json",
|
|
2351
|
+
...options?.headers
|
|
2352
|
+
}
|
|
2353
|
+
});
|
|
2354
|
+
}
|
|
2355
|
+
/**
|
|
2356
|
+
* Create a meeting (optionally syncing it to a calendar provider)
|
|
2357
|
+
*/
|
|
2358
|
+
static createCrmMeeting(options) {
|
|
2359
|
+
return (options?.client ?? client).post({
|
|
2360
|
+
security: [{
|
|
2361
|
+
name: "x-api-key",
|
|
2362
|
+
type: "apiKey"
|
|
2363
|
+
}, {
|
|
2364
|
+
scheme: "bearer",
|
|
2365
|
+
type: "http"
|
|
2366
|
+
}],
|
|
2367
|
+
url: "/v1/crm/meetings",
|
|
2368
|
+
...options,
|
|
2369
|
+
headers: {
|
|
2370
|
+
"Content-Type": "application/json",
|
|
2371
|
+
...options?.headers
|
|
2372
|
+
}
|
|
2373
|
+
});
|
|
2374
|
+
}
|
|
2375
|
+
/**
|
|
2376
|
+
* Apply the Market-Insights updates the user accepted
|
|
2377
|
+
*/
|
|
2378
|
+
static applyCrmMiUpdates(options) {
|
|
2379
|
+
return (options?.client ?? client).post({
|
|
2380
|
+
security: [{
|
|
2381
|
+
name: "x-api-key",
|
|
2382
|
+
type: "apiKey"
|
|
2383
|
+
}, {
|
|
2384
|
+
scheme: "bearer",
|
|
2385
|
+
type: "http"
|
|
2386
|
+
}],
|
|
2387
|
+
url: "/v1/crm/records/apply-mi-updates",
|
|
2388
|
+
...options,
|
|
2389
|
+
headers: {
|
|
2390
|
+
"Content-Type": "application/json",
|
|
2391
|
+
...options?.headers
|
|
2392
|
+
}
|
|
2393
|
+
});
|
|
2394
|
+
}
|
|
2395
|
+
/**
|
|
2396
|
+
* Dismiss surfaced MI updates (remember them in the seen-ledger)
|
|
2397
|
+
*/
|
|
2398
|
+
static dismissCrmMiUpdates(options) {
|
|
2399
|
+
return (options?.client ?? client).post({
|
|
2400
|
+
security: [{
|
|
2401
|
+
name: "x-api-key",
|
|
2402
|
+
type: "apiKey"
|
|
2403
|
+
}, {
|
|
2404
|
+
scheme: "bearer",
|
|
2405
|
+
type: "http"
|
|
2406
|
+
}],
|
|
2407
|
+
url: "/v1/crm/records/dismiss-mi-updates",
|
|
2408
|
+
...options,
|
|
2409
|
+
headers: {
|
|
2410
|
+
"Content-Type": "application/json",
|
|
2411
|
+
...options?.headers
|
|
2412
|
+
}
|
|
2413
|
+
});
|
|
2414
|
+
}
|
|
2415
|
+
/**
|
|
2416
|
+
* Compute which Market-Insights fields differ from a record snapshot
|
|
2417
|
+
*/
|
|
2418
|
+
static getCrmMiUpdates(options) {
|
|
2419
|
+
return (options?.client ?? client).post({
|
|
2420
|
+
security: [{
|
|
2421
|
+
name: "x-api-key",
|
|
2422
|
+
type: "apiKey"
|
|
2423
|
+
}, {
|
|
2424
|
+
scheme: "bearer",
|
|
2425
|
+
type: "http"
|
|
2426
|
+
}],
|
|
2427
|
+
url: "/v1/crm/records/mi-updates",
|
|
2428
|
+
...options,
|
|
2429
|
+
headers: {
|
|
2430
|
+
"Content-Type": "application/json",
|
|
2431
|
+
...options?.headers
|
|
2432
|
+
}
|
|
2433
|
+
});
|
|
2434
|
+
}
|
|
2435
|
+
/**
|
|
2436
|
+
* Ask the org owner(s) to enable the CRM (membership-gated)
|
|
2437
|
+
*/
|
|
2438
|
+
static requestCrmAccess(options) {
|
|
2439
|
+
return (options?.client ?? client).post({
|
|
2440
|
+
security: [{
|
|
2441
|
+
name: "x-api-key",
|
|
2442
|
+
type: "apiKey"
|
|
2443
|
+
}, {
|
|
2444
|
+
scheme: "bearer",
|
|
2445
|
+
type: "http"
|
|
2446
|
+
}],
|
|
2447
|
+
url: "/v1/crm/request-access",
|
|
2448
|
+
...options,
|
|
2449
|
+
headers: {
|
|
2450
|
+
"Content-Type": "application/json",
|
|
2451
|
+
...options?.headers
|
|
2452
|
+
}
|
|
2453
|
+
});
|
|
2454
|
+
}
|
|
2455
|
+
/**
|
|
2456
|
+
* Remove a user-added contact method
|
|
2457
|
+
*/
|
|
2458
|
+
static removeCrmContactMethod(options) {
|
|
2459
|
+
return (options?.client ?? client).delete({
|
|
2460
|
+
security: [{
|
|
2461
|
+
name: "x-api-key",
|
|
2462
|
+
type: "apiKey"
|
|
2463
|
+
}, {
|
|
2464
|
+
scheme: "bearer",
|
|
2465
|
+
type: "http"
|
|
2466
|
+
}],
|
|
2467
|
+
url: "/v1/crm/contacts",
|
|
2468
|
+
...options,
|
|
2469
|
+
headers: {
|
|
2470
|
+
"Content-Type": "application/json",
|
|
2471
|
+
...options?.headers
|
|
2472
|
+
}
|
|
2473
|
+
});
|
|
2474
|
+
}
|
|
2475
|
+
/**
|
|
2476
|
+
* Update or suppress a contact method
|
|
2477
|
+
*/
|
|
2478
|
+
static updateCrmContactMethod(options) {
|
|
2479
|
+
return (options?.client ?? client).patch({
|
|
2480
|
+
security: [{
|
|
2481
|
+
name: "x-api-key",
|
|
2482
|
+
type: "apiKey"
|
|
2483
|
+
}, {
|
|
2484
|
+
scheme: "bearer",
|
|
2485
|
+
type: "http"
|
|
2486
|
+
}],
|
|
2487
|
+
url: "/v1/crm/contacts",
|
|
2488
|
+
...options,
|
|
2489
|
+
headers: {
|
|
2490
|
+
"Content-Type": "application/json",
|
|
2491
|
+
...options?.headers
|
|
2492
|
+
}
|
|
2493
|
+
});
|
|
2494
|
+
}
|
|
2495
|
+
/**
|
|
2496
|
+
* Add a contact method to a record
|
|
2497
|
+
*/
|
|
2498
|
+
static addCrmContactMethod(options) {
|
|
2499
|
+
return (options?.client ?? client).post({
|
|
2500
|
+
security: [{
|
|
2501
|
+
name: "x-api-key",
|
|
2502
|
+
type: "apiKey"
|
|
2503
|
+
}, {
|
|
2504
|
+
scheme: "bearer",
|
|
2505
|
+
type: "http"
|
|
2506
|
+
}],
|
|
2507
|
+
url: "/v1/crm/contacts",
|
|
2508
|
+
...options,
|
|
2509
|
+
headers: {
|
|
2510
|
+
"Content-Type": "application/json",
|
|
2511
|
+
...options?.headers
|
|
2512
|
+
}
|
|
2513
|
+
});
|
|
2514
|
+
}
|
|
2515
|
+
/**
|
|
2516
|
+
* List custom fields applicable to a view
|
|
2517
|
+
*/
|
|
2518
|
+
static listCrmCustomFields(options) {
|
|
2519
|
+
return (options.client ?? client).get({
|
|
2520
|
+
security: [{
|
|
2521
|
+
name: "x-api-key",
|
|
2522
|
+
type: "apiKey"
|
|
2523
|
+
}, {
|
|
2524
|
+
scheme: "bearer",
|
|
2525
|
+
type: "http"
|
|
2526
|
+
}],
|
|
2527
|
+
url: "/v1/crm/fields",
|
|
2528
|
+
...options
|
|
2529
|
+
});
|
|
2530
|
+
}
|
|
2531
|
+
/**
|
|
2532
|
+
* Get custom-field values for one or many records
|
|
2533
|
+
*/
|
|
2534
|
+
static getCrmCustomValues(options) {
|
|
2535
|
+
return (options?.client ?? client).get({
|
|
2536
|
+
security: [{
|
|
2537
|
+
name: "x-api-key",
|
|
2538
|
+
type: "apiKey"
|
|
2539
|
+
}, {
|
|
2540
|
+
scheme: "bearer",
|
|
2541
|
+
type: "http"
|
|
2542
|
+
}],
|
|
2543
|
+
url: "/v1/crm/custom-values",
|
|
2544
|
+
...options
|
|
2545
|
+
});
|
|
2546
|
+
}
|
|
2547
|
+
/**
|
|
2548
|
+
* Set a record's value for one custom field
|
|
2549
|
+
*/
|
|
2550
|
+
static setCrmCustomValue(options) {
|
|
2551
|
+
return (options?.client ?? client).patch({
|
|
2552
|
+
security: [{
|
|
2553
|
+
name: "x-api-key",
|
|
2554
|
+
type: "apiKey"
|
|
2555
|
+
}, {
|
|
2556
|
+
scheme: "bearer",
|
|
2557
|
+
type: "http"
|
|
2558
|
+
}],
|
|
2559
|
+
url: "/v1/crm/custom-values",
|
|
2560
|
+
...options,
|
|
2561
|
+
headers: {
|
|
2562
|
+
"Content-Type": "application/json",
|
|
2563
|
+
...options?.headers
|
|
2564
|
+
}
|
|
2565
|
+
});
|
|
2566
|
+
}
|
|
2567
|
+
/**
|
|
2568
|
+
* Send an outbound email via the user's connected Gmail or Outlook
|
|
2569
|
+
*/
|
|
2570
|
+
static sendCrmEmail(options) {
|
|
2571
|
+
return (options?.client ?? client).post({
|
|
2572
|
+
security: [{
|
|
2573
|
+
name: "x-api-key",
|
|
2574
|
+
type: "apiKey"
|
|
2575
|
+
}, {
|
|
2576
|
+
scheme: "bearer",
|
|
2577
|
+
type: "http"
|
|
2578
|
+
}],
|
|
2579
|
+
url: "/v1/crm/email/send",
|
|
2580
|
+
...options,
|
|
2581
|
+
headers: {
|
|
2582
|
+
"Content-Type": "application/json",
|
|
2583
|
+
...options?.headers
|
|
2584
|
+
}
|
|
2585
|
+
});
|
|
2586
|
+
}
|
|
2587
|
+
/**
|
|
2588
|
+
* List attribute templates the caller can load
|
|
2589
|
+
*/
|
|
2590
|
+
static listCrmTemplates(options) {
|
|
2591
|
+
return (options?.client ?? client).get({
|
|
2592
|
+
security: [{
|
|
2593
|
+
name: "x-api-key",
|
|
2594
|
+
type: "apiKey"
|
|
2595
|
+
}, {
|
|
2596
|
+
scheme: "bearer",
|
|
2597
|
+
type: "http"
|
|
2598
|
+
}],
|
|
2599
|
+
url: "/v1/crm/templates",
|
|
2600
|
+
...options
|
|
2601
|
+
});
|
|
2602
|
+
}
|
|
2603
|
+
/**
|
|
2604
|
+
* Create a template (optionally captured from a list)
|
|
2605
|
+
*/
|
|
2606
|
+
static createCrmTemplate(options) {
|
|
2607
|
+
return (options?.client ?? client).post({
|
|
2608
|
+
security: [{
|
|
2609
|
+
name: "x-api-key",
|
|
2610
|
+
type: "apiKey"
|
|
2611
|
+
}, {
|
|
2612
|
+
scheme: "bearer",
|
|
2613
|
+
type: "http"
|
|
2614
|
+
}],
|
|
2615
|
+
url: "/v1/crm/templates",
|
|
2616
|
+
...options,
|
|
2617
|
+
headers: {
|
|
2618
|
+
"Content-Type": "application/json",
|
|
2619
|
+
...options?.headers
|
|
2620
|
+
}
|
|
2621
|
+
});
|
|
2622
|
+
}
|
|
2623
|
+
/**
|
|
2624
|
+
* Delete a template (its fields + shares cascade)
|
|
2625
|
+
*/
|
|
2626
|
+
static deleteCrmTemplate(options) {
|
|
2627
|
+
return (options.client ?? client).delete({
|
|
2628
|
+
security: [{
|
|
2629
|
+
name: "x-api-key",
|
|
2630
|
+
type: "apiKey"
|
|
2631
|
+
}, {
|
|
2632
|
+
scheme: "bearer",
|
|
2633
|
+
type: "http"
|
|
2634
|
+
}],
|
|
2635
|
+
url: "/v1/crm/templates/{id}",
|
|
2636
|
+
...options
|
|
2637
|
+
});
|
|
2638
|
+
}
|
|
2639
|
+
/**
|
|
2640
|
+
* Load one template with its fields
|
|
2641
|
+
*/
|
|
2642
|
+
static getCrmTemplate(options) {
|
|
2643
|
+
return (options.client ?? client).get({
|
|
2644
|
+
security: [{
|
|
2645
|
+
name: "x-api-key",
|
|
2646
|
+
type: "apiKey"
|
|
2647
|
+
}, {
|
|
2648
|
+
scheme: "bearer",
|
|
2649
|
+
type: "http"
|
|
2650
|
+
}],
|
|
2651
|
+
url: "/v1/crm/templates/{id}",
|
|
2652
|
+
...options
|
|
2653
|
+
});
|
|
2654
|
+
}
|
|
2655
|
+
/**
|
|
2656
|
+
* Rename a template
|
|
2657
|
+
*/
|
|
2658
|
+
static updateCrmTemplate(options) {
|
|
2659
|
+
return (options.client ?? client).patch({
|
|
2660
|
+
security: [{
|
|
2661
|
+
name: "x-api-key",
|
|
2662
|
+
type: "apiKey"
|
|
2663
|
+
}, {
|
|
2664
|
+
scheme: "bearer",
|
|
2665
|
+
type: "http"
|
|
2666
|
+
}],
|
|
2667
|
+
url: "/v1/crm/templates/{id}",
|
|
2668
|
+
...options,
|
|
2669
|
+
headers: {
|
|
2670
|
+
"Content-Type": "application/json",
|
|
2671
|
+
...options?.headers
|
|
2672
|
+
}
|
|
2673
|
+
});
|
|
2674
|
+
}
|
|
2675
|
+
/**
|
|
2676
|
+
* Revoke a teammate's template grant
|
|
2677
|
+
*/
|
|
2678
|
+
static unshareCrmTemplate(options) {
|
|
2679
|
+
return (options.client ?? client).delete({
|
|
2680
|
+
security: [{
|
|
2681
|
+
name: "x-api-key",
|
|
2682
|
+
type: "apiKey"
|
|
2683
|
+
}, {
|
|
2684
|
+
scheme: "bearer",
|
|
2685
|
+
type: "http"
|
|
2686
|
+
}],
|
|
2687
|
+
url: "/v1/crm/templates/{id}/shares",
|
|
2688
|
+
...options
|
|
2689
|
+
});
|
|
2690
|
+
}
|
|
2691
|
+
/**
|
|
2692
|
+
* A template's share panel (owner display, canManage, grantees)
|
|
2693
|
+
*/
|
|
2694
|
+
static getCrmTemplateShares(options) {
|
|
2695
|
+
return (options.client ?? client).get({
|
|
2696
|
+
security: [{
|
|
2697
|
+
name: "x-api-key",
|
|
2698
|
+
type: "apiKey"
|
|
2699
|
+
}, {
|
|
2700
|
+
scheme: "bearer",
|
|
2701
|
+
type: "http"
|
|
2702
|
+
}],
|
|
2703
|
+
url: "/v1/crm/templates/{id}/shares",
|
|
2704
|
+
...options
|
|
2705
|
+
});
|
|
2706
|
+
}
|
|
2707
|
+
/**
|
|
2708
|
+
* Grant a teammate load access to a template
|
|
2709
|
+
*/
|
|
2710
|
+
static shareCrmTemplate(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/templates/{id}/shares",
|
|
2720
|
+
...options,
|
|
2721
|
+
headers: {
|
|
2722
|
+
"Content-Type": "application/json",
|
|
2723
|
+
...options?.headers
|
|
2724
|
+
}
|
|
2725
|
+
});
|
|
2726
|
+
}
|
|
2727
|
+
/**
|
|
2728
|
+
* Revoke a user's access to a record
|
|
2729
|
+
*/
|
|
2730
|
+
static revokeCrmRecordAccess(options) {
|
|
2731
|
+
return (options?.client ?? client).delete({
|
|
2732
|
+
security: [{
|
|
2733
|
+
name: "x-api-key",
|
|
2734
|
+
type: "apiKey"
|
|
2735
|
+
}, {
|
|
2736
|
+
scheme: "bearer",
|
|
2737
|
+
type: "http"
|
|
2738
|
+
}],
|
|
2739
|
+
url: "/v1/crm/record-shares",
|
|
2740
|
+
...options,
|
|
2741
|
+
headers: {
|
|
2742
|
+
"Content-Type": "application/json",
|
|
2743
|
+
...options?.headers
|
|
2744
|
+
}
|
|
2745
|
+
});
|
|
2746
|
+
}
|
|
2747
|
+
/**
|
|
2748
|
+
* List the direct shares on a record (+ display, canManageShares)
|
|
2749
|
+
*/
|
|
2750
|
+
static listCrmRecordShares(options) {
|
|
2751
|
+
return (options.client ?? client).get({
|
|
2752
|
+
security: [{
|
|
2753
|
+
name: "x-api-key",
|
|
2754
|
+
type: "apiKey"
|
|
2755
|
+
}, {
|
|
2756
|
+
scheme: "bearer",
|
|
2757
|
+
type: "http"
|
|
2758
|
+
}],
|
|
2759
|
+
url: "/v1/crm/record-shares",
|
|
2760
|
+
...options
|
|
2761
|
+
});
|
|
2762
|
+
}
|
|
2763
|
+
/**
|
|
2764
|
+
* Grant a user access to a record
|
|
2765
|
+
*/
|
|
2766
|
+
static grantCrmRecordAccess(options) {
|
|
2767
|
+
return (options?.client ?? client).post({
|
|
2768
|
+
security: [{
|
|
2769
|
+
name: "x-api-key",
|
|
2770
|
+
type: "apiKey"
|
|
2771
|
+
}, {
|
|
2772
|
+
scheme: "bearer",
|
|
2773
|
+
type: "http"
|
|
2774
|
+
}],
|
|
2775
|
+
url: "/v1/crm/record-shares",
|
|
2776
|
+
...options,
|
|
2777
|
+
headers: {
|
|
2778
|
+
"Content-Type": "application/json",
|
|
2779
|
+
...options?.headers
|
|
2780
|
+
}
|
|
2781
|
+
});
|
|
2782
|
+
}
|
|
2783
|
+
/**
|
|
2784
|
+
* Who can access a record, and whether the caller may manage shares
|
|
2785
|
+
*/
|
|
2786
|
+
static getCrmRecordAccess(options) {
|
|
2787
|
+
return (options.client ?? client).get({
|
|
2788
|
+
security: [{
|
|
2789
|
+
name: "x-api-key",
|
|
2790
|
+
type: "apiKey"
|
|
2791
|
+
}, {
|
|
2792
|
+
scheme: "bearer",
|
|
2793
|
+
type: "http"
|
|
2794
|
+
}],
|
|
2795
|
+
url: "/v1/crm/record-access",
|
|
2796
|
+
...options
|
|
2797
|
+
});
|
|
2798
|
+
}
|
|
2799
|
+
/**
|
|
2800
|
+
* Typeahead search for email recipients the caller can see
|
|
2801
|
+
*/
|
|
2802
|
+
static searchCrmEmailRecipients(options) {
|
|
2803
|
+
return (options.client ?? client).get({
|
|
2804
|
+
security: [{
|
|
2805
|
+
name: "x-api-key",
|
|
2806
|
+
type: "apiKey"
|
|
2807
|
+
}, {
|
|
2808
|
+
scheme: "bearer",
|
|
2809
|
+
type: "http"
|
|
2810
|
+
}],
|
|
2811
|
+
url: "/v1/crm/recipients",
|
|
2812
|
+
...options
|
|
2813
|
+
});
|
|
2814
|
+
}
|
|
2815
|
+
/**
|
|
2816
|
+
* Bulk import records (create or update), optionally into a list
|
|
2817
|
+
*/
|
|
2818
|
+
static importCrmRecords(options) {
|
|
2819
|
+
return (options?.client ?? client).post({
|
|
2820
|
+
security: [{
|
|
2821
|
+
name: "x-api-key",
|
|
2822
|
+
type: "apiKey"
|
|
2823
|
+
}, {
|
|
2824
|
+
scheme: "bearer",
|
|
2825
|
+
type: "http"
|
|
2826
|
+
}],
|
|
2827
|
+
url: "/v1/crm/import",
|
|
2828
|
+
...options,
|
|
2829
|
+
headers: {
|
|
2830
|
+
"Content-Type": "application/json",
|
|
2831
|
+
...options?.headers
|
|
2832
|
+
}
|
|
2833
|
+
});
|
|
2834
|
+
}
|
|
2835
|
+
/**
|
|
2836
|
+
* Apply a match to an imported record (link + seed contacts)
|
|
2837
|
+
*/
|
|
2838
|
+
static applyCrmEnrichment(options) {
|
|
2839
|
+
return (options?.client ?? client).post({
|
|
2840
|
+
security: [{
|
|
2841
|
+
name: "x-api-key",
|
|
2842
|
+
type: "apiKey"
|
|
2843
|
+
}, {
|
|
2844
|
+
scheme: "bearer",
|
|
2845
|
+
type: "http"
|
|
2846
|
+
}],
|
|
2847
|
+
url: "/v1/crm/enrich/apply",
|
|
2848
|
+
...options,
|
|
2849
|
+
headers: {
|
|
2850
|
+
"Content-Type": "application/json",
|
|
2851
|
+
...options?.headers
|
|
2852
|
+
}
|
|
2853
|
+
});
|
|
2854
|
+
}
|
|
2855
|
+
/**
|
|
2856
|
+
* Link a record to a chosen candidate
|
|
2857
|
+
*/
|
|
2858
|
+
static linkCrmRecord(options) {
|
|
2859
|
+
return (options?.client ?? client).patch({
|
|
2860
|
+
security: [{
|
|
2861
|
+
name: "x-api-key",
|
|
2862
|
+
type: "apiKey"
|
|
2863
|
+
}, {
|
|
2864
|
+
scheme: "bearer",
|
|
2865
|
+
type: "http"
|
|
2866
|
+
}],
|
|
2867
|
+
url: "/v1/crm/match",
|
|
2868
|
+
...options,
|
|
2869
|
+
headers: {
|
|
2870
|
+
"Content-Type": "application/json",
|
|
2871
|
+
...options?.headers
|
|
2872
|
+
}
|
|
2873
|
+
});
|
|
2874
|
+
}
|
|
2875
|
+
/**
|
|
2876
|
+
* Find candidate entities to link an unmatched record to
|
|
2877
|
+
*/
|
|
2878
|
+
static searchCrmMatchCandidates(options) {
|
|
2879
|
+
return (options?.client ?? client).post({
|
|
2880
|
+
security: [{
|
|
2881
|
+
name: "x-api-key",
|
|
2882
|
+
type: "apiKey"
|
|
2883
|
+
}, {
|
|
2884
|
+
scheme: "bearer",
|
|
2885
|
+
type: "http"
|
|
2886
|
+
}],
|
|
2887
|
+
url: "/v1/crm/match",
|
|
2888
|
+
...options,
|
|
2889
|
+
headers: {
|
|
2890
|
+
"Content-Type": "application/json",
|
|
2891
|
+
...options?.headers
|
|
2892
|
+
}
|
|
2893
|
+
});
|
|
2894
|
+
}
|
|
2895
|
+
/**
|
|
2896
|
+
* Recent-vs-prior 3-month closed-loan units for a set of LOs (by NMLS)
|
|
2897
|
+
*/
|
|
2898
|
+
static crmLoMomentum(options) {
|
|
2899
|
+
return (options?.client ?? client).post({
|
|
2900
|
+
security: [{
|
|
2901
|
+
name: "x-api-key",
|
|
2902
|
+
type: "apiKey"
|
|
2903
|
+
}, {
|
|
2904
|
+
scheme: "bearer",
|
|
2905
|
+
type: "http"
|
|
2906
|
+
}],
|
|
2907
|
+
url: "/v1/crm/lo-momentum",
|
|
2908
|
+
...options,
|
|
2909
|
+
headers: {
|
|
2910
|
+
"Content-Type": "application/json",
|
|
2911
|
+
...options?.headers
|
|
2912
|
+
}
|
|
2913
|
+
});
|
|
2914
|
+
}
|
|
2915
|
+
/**
|
|
2916
|
+
* Loan-type mix (percentage + top type) for a single LO (by NMLS)
|
|
2917
|
+
*/
|
|
2918
|
+
static crmLoLoanMix(options) {
|
|
2919
|
+
return (options?.client ?? client).post({
|
|
2920
|
+
security: [{
|
|
2921
|
+
name: "x-api-key",
|
|
2922
|
+
type: "apiKey"
|
|
2923
|
+
}, {
|
|
2924
|
+
scheme: "bearer",
|
|
2925
|
+
type: "http"
|
|
2926
|
+
}],
|
|
2927
|
+
url: "/v1/crm/lo-loan-mix",
|
|
2928
|
+
...options,
|
|
2929
|
+
headers: {
|
|
2930
|
+
"Content-Type": "application/json",
|
|
2931
|
+
...options?.headers
|
|
2932
|
+
}
|
|
2933
|
+
});
|
|
2934
|
+
}
|
|
2935
|
+
/**
|
|
2936
|
+
* Rank an agent's LO partners by product-mix + size similarity to a viewing LO
|
|
2937
|
+
*/
|
|
2938
|
+
static crmSimilarOriginators(options) {
|
|
2939
|
+
return (options?.client ?? client).post({
|
|
2940
|
+
security: [{
|
|
2941
|
+
name: "x-api-key",
|
|
2942
|
+
type: "apiKey"
|
|
2943
|
+
}, {
|
|
2944
|
+
scheme: "bearer",
|
|
2945
|
+
type: "http"
|
|
2946
|
+
}],
|
|
2947
|
+
url: "/v1/crm/similar-originators",
|
|
2948
|
+
...options,
|
|
2949
|
+
headers: {
|
|
2950
|
+
"Content-Type": "application/json",
|
|
2951
|
+
...options?.headers
|
|
2952
|
+
}
|
|
2953
|
+
});
|
|
2954
|
+
}
|
|
2955
|
+
/**
|
|
2956
|
+
* Current-sponsor office location + sponsored flag for a set of LOs
|
|
2957
|
+
*/
|
|
2958
|
+
static crmLoSponsorLocation(options) {
|
|
2959
|
+
return (options?.client ?? client).post({
|
|
2960
|
+
security: [{
|
|
2961
|
+
name: "x-api-key",
|
|
2962
|
+
type: "apiKey"
|
|
2963
|
+
}, {
|
|
2964
|
+
scheme: "bearer",
|
|
2965
|
+
type: "http"
|
|
2966
|
+
}],
|
|
2967
|
+
url: "/v1/crm/lo-sponsor-location",
|
|
2968
|
+
...options,
|
|
2969
|
+
headers: {
|
|
2970
|
+
"Content-Type": "application/json",
|
|
2971
|
+
...options?.headers
|
|
2972
|
+
}
|
|
2973
|
+
});
|
|
2974
|
+
}
|
|
2975
|
+
/**
|
|
2976
|
+
* Bank / Credit Union / Broker / Retail channel per LO (by NMLS)
|
|
2977
|
+
*/
|
|
2978
|
+
static crmLenderChannels(options) {
|
|
2979
|
+
return (options?.client ?? client).post({
|
|
2980
|
+
security: [{
|
|
2981
|
+
name: "x-api-key",
|
|
2982
|
+
type: "apiKey"
|
|
2983
|
+
}, {
|
|
2984
|
+
scheme: "bearer",
|
|
2985
|
+
type: "http"
|
|
2986
|
+
}],
|
|
2987
|
+
url: "/v1/crm/lender-channels",
|
|
2988
|
+
...options,
|
|
2989
|
+
headers: {
|
|
2990
|
+
"Content-Type": "application/json",
|
|
2991
|
+
...options?.headers
|
|
2992
|
+
}
|
|
2993
|
+
});
|
|
2994
|
+
}
|
|
2995
|
+
/**
|
|
2996
|
+
* The current user's still-live call (for reload resume)
|
|
2997
|
+
*/
|
|
2998
|
+
static getCrmActiveCall(options) {
|
|
2999
|
+
return (options?.client ?? client).get({
|
|
3000
|
+
security: [{
|
|
3001
|
+
name: "x-api-key",
|
|
3002
|
+
type: "apiKey"
|
|
3003
|
+
}, {
|
|
3004
|
+
scheme: "bearer",
|
|
3005
|
+
type: "http"
|
|
3006
|
+
}],
|
|
3007
|
+
url: "/v1/crm/calls/active",
|
|
3008
|
+
...options
|
|
3009
|
+
});
|
|
3010
|
+
}
|
|
3011
|
+
/**
|
|
3012
|
+
* Persist an AI analysis of a recorded call
|
|
3013
|
+
*/
|
|
3014
|
+
static setCrmCallAnalysis(options) {
|
|
3015
|
+
return (options?.client ?? client).post({
|
|
3016
|
+
security: [{
|
|
3017
|
+
name: "x-api-key",
|
|
3018
|
+
type: "apiKey"
|
|
3019
|
+
}, {
|
|
3020
|
+
scheme: "bearer",
|
|
3021
|
+
type: "http"
|
|
3022
|
+
}],
|
|
3023
|
+
url: "/v1/crm/calls/analysis",
|
|
3024
|
+
...options,
|
|
3025
|
+
headers: {
|
|
3026
|
+
"Content-Type": "application/json",
|
|
3027
|
+
...options?.headers
|
|
3028
|
+
}
|
|
3029
|
+
});
|
|
3030
|
+
}
|
|
3031
|
+
/**
|
|
3032
|
+
* Poll a recorded call's transcript (advances the pipeline)
|
|
3033
|
+
*/
|
|
3034
|
+
static getCrmCallTranscript(options) {
|
|
3035
|
+
return (options.client ?? client).get({
|
|
3036
|
+
security: [{
|
|
3037
|
+
name: "x-api-key",
|
|
3038
|
+
type: "apiKey"
|
|
3039
|
+
}, {
|
|
3040
|
+
scheme: "bearer",
|
|
3041
|
+
type: "http"
|
|
3042
|
+
}],
|
|
3043
|
+
url: "/v1/crm/calls/transcript",
|
|
3044
|
+
...options
|
|
3045
|
+
});
|
|
3046
|
+
}
|
|
3047
|
+
/**
|
|
3048
|
+
* Remove a caller ID from the registry
|
|
3049
|
+
*/
|
|
3050
|
+
static deleteCrmCallerId(options) {
|
|
3051
|
+
return (options.client ?? client).delete({
|
|
3052
|
+
security: [{
|
|
3053
|
+
name: "x-api-key",
|
|
3054
|
+
type: "apiKey"
|
|
3055
|
+
}, {
|
|
3056
|
+
scheme: "bearer",
|
|
3057
|
+
type: "http"
|
|
3058
|
+
}],
|
|
3059
|
+
url: "/v1/crm/caller-ids",
|
|
3060
|
+
...options
|
|
3061
|
+
});
|
|
3062
|
+
}
|
|
3063
|
+
/**
|
|
3064
|
+
* List the current user's caller IDs
|
|
3065
|
+
*/
|
|
3066
|
+
static listCrmCallerIds(options) {
|
|
3067
|
+
return (options?.client ?? client).get({
|
|
3068
|
+
security: [{
|
|
3069
|
+
name: "x-api-key",
|
|
3070
|
+
type: "apiKey"
|
|
3071
|
+
}, {
|
|
3072
|
+
scheme: "bearer",
|
|
3073
|
+
type: "http"
|
|
3074
|
+
}],
|
|
3075
|
+
url: "/v1/crm/caller-ids",
|
|
3076
|
+
...options
|
|
3077
|
+
});
|
|
3078
|
+
}
|
|
3079
|
+
/**
|
|
3080
|
+
* Make a verified caller ID the default
|
|
3081
|
+
*/
|
|
3082
|
+
static setDefaultCrmCallerId(options) {
|
|
3083
|
+
return (options?.client ?? client).patch({
|
|
3084
|
+
security: [{
|
|
3085
|
+
name: "x-api-key",
|
|
3086
|
+
type: "apiKey"
|
|
3087
|
+
}, {
|
|
3088
|
+
scheme: "bearer",
|
|
3089
|
+
type: "http"
|
|
3090
|
+
}],
|
|
3091
|
+
url: "/v1/crm/caller-ids",
|
|
3092
|
+
...options,
|
|
3093
|
+
headers: {
|
|
3094
|
+
"Content-Type": "application/json",
|
|
3095
|
+
...options?.headers
|
|
3096
|
+
}
|
|
3097
|
+
});
|
|
3098
|
+
}
|
|
3099
|
+
/**
|
|
3100
|
+
* Start caller-ID verification or re-check its outcome
|
|
3101
|
+
*/
|
|
3102
|
+
static actionCrmCallerId(options) {
|
|
3103
|
+
return (options?.client ?? client).post({
|
|
3104
|
+
security: [{
|
|
3105
|
+
name: "x-api-key",
|
|
3106
|
+
type: "apiKey"
|
|
3107
|
+
}, {
|
|
3108
|
+
scheme: "bearer",
|
|
3109
|
+
type: "http"
|
|
3110
|
+
}],
|
|
3111
|
+
url: "/v1/crm/caller-ids",
|
|
3112
|
+
...options,
|
|
3113
|
+
headers: {
|
|
3114
|
+
"Content-Type": "application/json",
|
|
3115
|
+
...options?.headers
|
|
3116
|
+
}
|
|
3117
|
+
});
|
|
3118
|
+
}
|
|
3119
|
+
/**
|
|
3120
|
+
* Poll one call's status (syncs + finalizes on terminal)
|
|
3121
|
+
*/
|
|
3122
|
+
static getCrmCall(options) {
|
|
3123
|
+
return (options.client ?? client).get({
|
|
3124
|
+
security: [{
|
|
3125
|
+
name: "x-api-key",
|
|
3126
|
+
type: "apiKey"
|
|
3127
|
+
}, {
|
|
3128
|
+
scheme: "bearer",
|
|
3129
|
+
type: "http"
|
|
3130
|
+
}],
|
|
3131
|
+
url: "/v1/crm/calls",
|
|
3132
|
+
...options
|
|
3133
|
+
});
|
|
3134
|
+
}
|
|
3135
|
+
/**
|
|
3136
|
+
* Hang up an in-flight call
|
|
3137
|
+
*/
|
|
3138
|
+
static hangupCrmCall(options) {
|
|
3139
|
+
return (options?.client ?? client).patch({
|
|
3140
|
+
security: [{
|
|
3141
|
+
name: "x-api-key",
|
|
3142
|
+
type: "apiKey"
|
|
3143
|
+
}, {
|
|
3144
|
+
scheme: "bearer",
|
|
3145
|
+
type: "http"
|
|
3146
|
+
}],
|
|
3147
|
+
url: "/v1/crm/calls",
|
|
3148
|
+
...options,
|
|
3149
|
+
headers: {
|
|
3150
|
+
"Content-Type": "application/json",
|
|
3151
|
+
...options?.headers
|
|
3152
|
+
}
|
|
3153
|
+
});
|
|
3154
|
+
}
|
|
3155
|
+
/**
|
|
3156
|
+
* Place an outbound bridge call
|
|
3157
|
+
*/
|
|
3158
|
+
static placeCrmCall(options) {
|
|
3159
|
+
return (options?.client ?? client).post({
|
|
3160
|
+
security: [{
|
|
3161
|
+
name: "x-api-key",
|
|
3162
|
+
type: "apiKey"
|
|
3163
|
+
}, {
|
|
3164
|
+
scheme: "bearer",
|
|
3165
|
+
type: "http"
|
|
3166
|
+
}],
|
|
3167
|
+
url: "/v1/crm/calls",
|
|
3168
|
+
...options,
|
|
3169
|
+
headers: {
|
|
3170
|
+
"Content-Type": "application/json",
|
|
3171
|
+
...options?.headers
|
|
3172
|
+
}
|
|
3173
|
+
});
|
|
3174
|
+
}
|
|
3175
|
+
};
|
|
3176
|
+
var Search = class {
|
|
3177
|
+
/**
|
|
3178
|
+
* Instant multi-entity typeahead search
|
|
3179
|
+
* Fast typeahead/autocomplete search across agents, originators, companies, and offices. Returns top matches per entity type. Use this for quick name lookups, not for filtered searches (use the entity-specific list endpoints for those).
|
|
3180
|
+
*/
|
|
3181
|
+
static instant(options) {
|
|
3182
|
+
return (options?.client ?? client).post({
|
|
3183
|
+
security: [{
|
|
3184
|
+
name: "x-api-key",
|
|
3185
|
+
type: "apiKey"
|
|
3186
|
+
}, {
|
|
3187
|
+
scheme: "bearer",
|
|
3188
|
+
type: "http"
|
|
3189
|
+
}],
|
|
3190
|
+
url: "/v1/instant-search",
|
|
3191
|
+
...options,
|
|
3192
|
+
headers: {
|
|
3193
|
+
"Content-Type": "application/json",
|
|
3194
|
+
...options?.headers
|
|
3195
|
+
}
|
|
3196
|
+
});
|
|
3197
|
+
}
|
|
3198
|
+
/**
|
|
3199
|
+
* Mint a scoped search token
|
|
3200
|
+
* Returns a short-lived scoped search token plus the host to query, so a trusted client can search the entity indexes directly with per-query controls (e.g. attributesToSearchOn for name-only matching).
|
|
3201
|
+
*/
|
|
3202
|
+
static getSearchToken(options) {
|
|
3203
|
+
return (options?.client ?? client).get({
|
|
3204
|
+
security: [{
|
|
3205
|
+
name: "x-api-key",
|
|
3206
|
+
type: "apiKey"
|
|
3207
|
+
}, {
|
|
3208
|
+
scheme: "bearer",
|
|
3209
|
+
type: "http"
|
|
3210
|
+
}],
|
|
3211
|
+
url: "/v1/search-token",
|
|
3212
|
+
...options
|
|
3213
|
+
});
|
|
3214
|
+
}
|
|
3215
|
+
};
|
|
3216
|
+
var Lenders = class {
|
|
3217
|
+
/**
|
|
3218
|
+
* Search lenders with filters
|
|
3219
|
+
* Search and list normalized lender names/identities with filters — resolves raw or variant lender names to canonical lender records. Use it to look up a lender by name or reconcile lender-name variants to a single canonical entity.
|
|
3220
|
+
*/
|
|
3221
|
+
static list(options) {
|
|
3222
|
+
return (options?.client ?? client).post({
|
|
3223
|
+
security: [{
|
|
3224
|
+
name: "x-api-key",
|
|
3225
|
+
type: "apiKey"
|
|
3226
|
+
}, {
|
|
3227
|
+
scheme: "bearer",
|
|
3228
|
+
type: "http"
|
|
3229
|
+
}],
|
|
3230
|
+
url: "/v1/lenders",
|
|
3231
|
+
...options,
|
|
3232
|
+
headers: {
|
|
3233
|
+
"Content-Type": "application/json",
|
|
3234
|
+
...options?.headers
|
|
3235
|
+
}
|
|
3236
|
+
});
|
|
3237
|
+
}
|
|
3238
|
+
/**
|
|
3239
|
+
* Get lender by ID
|
|
3240
|
+
*/
|
|
3241
|
+
static get(options) {
|
|
3242
|
+
return (options.client ?? client).get({
|
|
3243
|
+
security: [{
|
|
3244
|
+
name: "x-api-key",
|
|
3245
|
+
type: "apiKey"
|
|
3246
|
+
}, {
|
|
3247
|
+
scheme: "bearer",
|
|
3248
|
+
type: "http"
|
|
3249
|
+
}],
|
|
3250
|
+
url: "/v1/lenders/{id}",
|
|
3251
|
+
...options
|
|
3252
|
+
});
|
|
3253
|
+
}
|
|
3254
|
+
};
|
|
3255
|
+
var Loans = class {
|
|
3256
|
+
/**
|
|
3257
|
+
* Search individual loan records with filters
|
|
3258
|
+
* Search and list individual public-record mortgage and deed loan records — one row per loan (purchase, refinance, origination). Filter by geography (state, county, city, zip), lender, originator, loan amount, interest rate, loan type/purpose, and recording date, with sorting and cursor pagination. This is the discrete per-loan record search: use it to find specific loans or build a filtered loan list. (For aggregate market rates and volumes use the market search; for one loan by its ID use the loan detail endpoint.)
|
|
3259
|
+
*/
|
|
3260
|
+
static list(options) {
|
|
3261
|
+
return (options?.client ?? client).post({
|
|
3262
|
+
security: [{
|
|
3263
|
+
name: "x-api-key",
|
|
3264
|
+
type: "apiKey"
|
|
3265
|
+
}, {
|
|
3266
|
+
scheme: "bearer",
|
|
3267
|
+
type: "http"
|
|
3268
|
+
}],
|
|
3269
|
+
url: "/v1/loans",
|
|
3270
|
+
...options,
|
|
3271
|
+
headers: {
|
|
3272
|
+
"Content-Type": "application/json",
|
|
3273
|
+
...options?.headers
|
|
3274
|
+
}
|
|
3275
|
+
});
|
|
3276
|
+
}
|
|
3277
|
+
/**
|
|
3278
|
+
* Get loan by ID
|
|
3279
|
+
*/
|
|
3280
|
+
static get(options) {
|
|
3281
|
+
return (options.client ?? client).get({
|
|
1649
3282
|
security: [{
|
|
1650
3283
|
name: "x-api-key",
|
|
1651
3284
|
type: "apiKey"
|
|
@@ -2132,6 +3765,26 @@ var Originators = class {
|
|
|
2132
3765
|
});
|
|
2133
3766
|
}
|
|
2134
3767
|
/**
|
|
3768
|
+
* Broker shops this LO originated loans through (name-resolved)
|
|
3769
|
+
*/
|
|
3770
|
+
static brokers(options) {
|
|
3771
|
+
return (options.client ?? client).post({
|
|
3772
|
+
security: [{
|
|
3773
|
+
name: "x-api-key",
|
|
3774
|
+
type: "apiKey"
|
|
3775
|
+
}, {
|
|
3776
|
+
scheme: "bearer",
|
|
3777
|
+
type: "http"
|
|
3778
|
+
}],
|
|
3779
|
+
url: "/v1/originators/{nmlsId}/breakdowns/brokers",
|
|
3780
|
+
...options,
|
|
3781
|
+
headers: {
|
|
3782
|
+
"Content-Type": "application/json",
|
|
3783
|
+
...options?.headers
|
|
3784
|
+
}
|
|
3785
|
+
});
|
|
3786
|
+
}
|
|
3787
|
+
/**
|
|
2135
3788
|
* Branch (broker) history for this LO
|
|
2136
3789
|
*/
|
|
2137
3790
|
static branches(options) {
|
|
@@ -2152,9 +3805,9 @@ var Originators = class {
|
|
|
2152
3805
|
});
|
|
2153
3806
|
}
|
|
2154
3807
|
/**
|
|
2155
|
-
*
|
|
3808
|
+
* City volume breakdown across this LO's loans
|
|
2156
3809
|
*/
|
|
2157
|
-
static
|
|
3810
|
+
static citiesBreakdown(options) {
|
|
2158
3811
|
return (options.client ?? client).post({
|
|
2159
3812
|
security: [{
|
|
2160
3813
|
name: "x-api-key",
|
|
@@ -2163,7 +3816,7 @@ var Originators = class {
|
|
|
2163
3816
|
scheme: "bearer",
|
|
2164
3817
|
type: "http"
|
|
2165
3818
|
}],
|
|
2166
|
-
url: "/v1/originators/{nmlsId}/breakdowns/
|
|
3819
|
+
url: "/v1/originators/{nmlsId}/breakdowns/cities",
|
|
2167
3820
|
...options,
|
|
2168
3821
|
headers: {
|
|
2169
3822
|
"Content-Type": "application/json",
|
|
@@ -2172,9 +3825,9 @@ var Originators = class {
|
|
|
2172
3825
|
});
|
|
2173
3826
|
}
|
|
2174
3827
|
/**
|
|
2175
|
-
*
|
|
3828
|
+
* State volume breakdown across this LO's loans
|
|
2176
3829
|
*/
|
|
2177
|
-
static
|
|
3830
|
+
static statesBreakdown(options) {
|
|
2178
3831
|
return (options.client ?? client).post({
|
|
2179
3832
|
security: [{
|
|
2180
3833
|
name: "x-api-key",
|
|
@@ -2183,7 +3836,7 @@ var Originators = class {
|
|
|
2183
3836
|
scheme: "bearer",
|
|
2184
3837
|
type: "http"
|
|
2185
3838
|
}],
|
|
2186
|
-
url: "/v1/originators/{nmlsId}/breakdowns/
|
|
3839
|
+
url: "/v1/originators/{nmlsId}/breakdowns/states",
|
|
2187
3840
|
...options,
|
|
2188
3841
|
headers: {
|
|
2189
3842
|
"Content-Type": "application/json",
|
|
@@ -2192,7 +3845,7 @@ var Originators = class {
|
|
|
2192
3845
|
});
|
|
2193
3846
|
}
|
|
2194
3847
|
/**
|
|
2195
|
-
*
|
|
3848
|
+
* County (FIPS) volume breakdown across this LO's loans
|
|
2196
3849
|
*/
|
|
2197
3850
|
static countiesBreakdown(options) {
|
|
2198
3851
|
return (options.client ?? client).post({
|
|
@@ -2212,9 +3865,9 @@ var Originators = class {
|
|
|
2212
3865
|
});
|
|
2213
3866
|
}
|
|
2214
3867
|
/**
|
|
2215
|
-
*
|
|
3868
|
+
* Real-estate offices this LO closed through (with sponsoring company)
|
|
2216
3869
|
*/
|
|
2217
|
-
static
|
|
3870
|
+
static offices(options) {
|
|
2218
3871
|
return (options.client ?? client).post({
|
|
2219
3872
|
security: [{
|
|
2220
3873
|
name: "x-api-key",
|
|
@@ -2223,7 +3876,7 @@ var Originators = class {
|
|
|
2223
3876
|
scheme: "bearer",
|
|
2224
3877
|
type: "http"
|
|
2225
3878
|
}],
|
|
2226
|
-
url: "/v1/originators/{nmlsId}/breakdowns/
|
|
3879
|
+
url: "/v1/originators/{nmlsId}/breakdowns/offices",
|
|
2227
3880
|
...options,
|
|
2228
3881
|
headers: {
|
|
2229
3882
|
"Content-Type": "application/json",
|
|
@@ -2466,6 +4119,26 @@ var Originators = class {
|
|
|
2466
4119
|
});
|
|
2467
4120
|
}
|
|
2468
4121
|
/**
|
|
4122
|
+
* Broker shops this LO originated loans through (name-resolved)
|
|
4123
|
+
*/
|
|
4124
|
+
static brokers2(options) {
|
|
4125
|
+
return (options.client ?? client).post({
|
|
4126
|
+
security: [{
|
|
4127
|
+
name: "x-api-key",
|
|
4128
|
+
type: "apiKey"
|
|
4129
|
+
}, {
|
|
4130
|
+
scheme: "bearer",
|
|
4131
|
+
type: "http"
|
|
4132
|
+
}],
|
|
4133
|
+
url: "/originators/{nmlsId}/breakdowns/brokers",
|
|
4134
|
+
...options,
|
|
4135
|
+
headers: {
|
|
4136
|
+
"Content-Type": "application/json",
|
|
4137
|
+
...options?.headers
|
|
4138
|
+
}
|
|
4139
|
+
});
|
|
4140
|
+
}
|
|
4141
|
+
/**
|
|
2469
4142
|
* Branch (broker) history for this LO
|
|
2470
4143
|
*/
|
|
2471
4144
|
static branches2(options) {
|
|
@@ -2486,9 +4159,9 @@ var Originators = class {
|
|
|
2486
4159
|
});
|
|
2487
4160
|
}
|
|
2488
4161
|
/**
|
|
2489
|
-
*
|
|
4162
|
+
* City volume breakdown across this LO's loans
|
|
2490
4163
|
*/
|
|
2491
|
-
static
|
|
4164
|
+
static citiesBreakdown2(options) {
|
|
2492
4165
|
return (options.client ?? client).post({
|
|
2493
4166
|
security: [{
|
|
2494
4167
|
name: "x-api-key",
|
|
@@ -2497,7 +4170,7 @@ var Originators = class {
|
|
|
2497
4170
|
scheme: "bearer",
|
|
2498
4171
|
type: "http"
|
|
2499
4172
|
}],
|
|
2500
|
-
url: "/originators/{nmlsId}/breakdowns/
|
|
4173
|
+
url: "/originators/{nmlsId}/breakdowns/cities",
|
|
2501
4174
|
...options,
|
|
2502
4175
|
headers: {
|
|
2503
4176
|
"Content-Type": "application/json",
|
|
@@ -2506,9 +4179,9 @@ var Originators = class {
|
|
|
2506
4179
|
});
|
|
2507
4180
|
}
|
|
2508
4181
|
/**
|
|
2509
|
-
*
|
|
4182
|
+
* State volume breakdown across this LO's loans
|
|
2510
4183
|
*/
|
|
2511
|
-
static
|
|
4184
|
+
static statesBreakdown2(options) {
|
|
2512
4185
|
return (options.client ?? client).post({
|
|
2513
4186
|
security: [{
|
|
2514
4187
|
name: "x-api-key",
|
|
@@ -2517,7 +4190,7 @@ var Originators = class {
|
|
|
2517
4190
|
scheme: "bearer",
|
|
2518
4191
|
type: "http"
|
|
2519
4192
|
}],
|
|
2520
|
-
url: "/originators/{nmlsId}/breakdowns/
|
|
4193
|
+
url: "/originators/{nmlsId}/breakdowns/states",
|
|
2521
4194
|
...options,
|
|
2522
4195
|
headers: {
|
|
2523
4196
|
"Content-Type": "application/json",
|
|
@@ -2526,7 +4199,7 @@ var Originators = class {
|
|
|
2526
4199
|
});
|
|
2527
4200
|
}
|
|
2528
4201
|
/**
|
|
2529
|
-
*
|
|
4202
|
+
* County (FIPS) volume breakdown across this LO's loans
|
|
2530
4203
|
*/
|
|
2531
4204
|
static countiesBreakdown2(options) {
|
|
2532
4205
|
return (options.client ?? client).post({
|
|
@@ -2546,9 +4219,9 @@ var Originators = class {
|
|
|
2546
4219
|
});
|
|
2547
4220
|
}
|
|
2548
4221
|
/**
|
|
2549
|
-
*
|
|
4222
|
+
* Real-estate offices this LO closed through (with sponsoring company)
|
|
2550
4223
|
*/
|
|
2551
|
-
static
|
|
4224
|
+
static offices2(options) {
|
|
2552
4225
|
return (options.client ?? client).post({
|
|
2553
4226
|
security: [{
|
|
2554
4227
|
name: "x-api-key",
|
|
@@ -2557,7 +4230,7 @@ var Originators = class {
|
|
|
2557
4230
|
scheme: "bearer",
|
|
2558
4231
|
type: "http"
|
|
2559
4232
|
}],
|
|
2560
|
-
url: "/originators/{nmlsId}/breakdowns/
|
|
4233
|
+
url: "/originators/{nmlsId}/breakdowns/offices",
|
|
2561
4234
|
...options,
|
|
2562
4235
|
headers: {
|
|
2563
4236
|
"Content-Type": "application/json",
|
|
@@ -2966,4 +4639,4 @@ function createClient$1(config = {}) {
|
|
|
2966
4639
|
};
|
|
2967
4640
|
}
|
|
2968
4641
|
//#endregion
|
|
2969
|
-
export { Sales as _,
|
|
4642
|
+
export { Sales as _, Alerts as a, Crm as c, Locations as d, Market as f, Realtime as g, Properties as h, Agents as i, Lenders as l, Originators as m, createClient$1 as n, Branches as o, Offices as p, AdminJobs as r, Companies as s, createApiClient as t, Loans as u, Search as v, client as y };
|