@ai-matrx/api 0.0.0-stage → 0.1.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.
Files changed (146) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/LICENSE +21 -0
  3. package/README.md +18 -2
  4. package/dist/account.cjs +670 -0
  5. package/dist/account.d.cts +3246 -0
  6. package/dist/account.d.ts +3246 -0
  7. package/dist/account.js +558 -0
  8. package/dist/agents.cjs +598 -0
  9. package/dist/agents.d.cts +3417 -0
  10. package/dist/agents.d.ts +3417 -0
  11. package/dist/agents.js +497 -0
  12. package/dist/ai.cjs +109 -0
  13. package/dist/ai.d.cts +493 -0
  14. package/dist/ai.d.ts +493 -0
  15. package/dist/ai.js +91 -0
  16. package/dist/apps.cjs +394 -0
  17. package/dist/apps.d.cts +1094 -0
  18. package/dist/apps.d.ts +1094 -0
  19. package/dist/apps.js +328 -0
  20. package/dist/architecture.cjs +1223 -0
  21. package/dist/architecture.d.cts +4701 -0
  22. package/dist/architecture.d.ts +4701 -0
  23. package/dist/architecture.js +1016 -0
  24. package/dist/audio.cjs +226 -0
  25. package/dist/audio.d.cts +723 -0
  26. package/dist/audio.d.ts +723 -0
  27. package/dist/audio.js +188 -0
  28. package/dist/chat.cjs +538 -0
  29. package/dist/chat.d.cts +2251 -0
  30. package/dist/chat.d.ts +2251 -0
  31. package/dist/chat.js +447 -0
  32. package/dist/chunk-2SXAAKGV.cjs +279 -0
  33. package/dist/chunk-AY5N6EA4.js +43 -0
  34. package/dist/chunk-BMQI7UET.cjs +48 -0
  35. package/dist/chunk-FNIYADWI.cjs +59 -0
  36. package/dist/chunk-KIEAFMKB.js +264 -0
  37. package/dist/chunk-UONBYRE4.js +1012 -0
  38. package/dist/chunk-YTEOFGFC.js +57 -0
  39. package/dist/chunk-YUDQWDCM.cjs +1047 -0
  40. package/dist/code.cjs +561 -0
  41. package/dist/code.d.cts +1976 -0
  42. package/dist/code.d.ts +1976 -0
  43. package/dist/code.js +467 -0
  44. package/dist/commerce.cjs +22 -0
  45. package/dist/commerce.d.cts +45 -0
  46. package/dist/commerce.d.ts +45 -0
  47. package/dist/commerce.js +18 -0
  48. package/dist/communications.cjs +215 -0
  49. package/dist/communications.d.cts +948 -0
  50. package/dist/communications.d.ts +948 -0
  51. package/dist/communications.js +179 -0
  52. package/dist/computer.cjs +330 -0
  53. package/dist/computer.d.cts +733 -0
  54. package/dist/computer.d.ts +733 -0
  55. package/dist/computer.js +275 -0
  56. package/dist/content.cjs +425 -0
  57. package/dist/content.d.cts +1796 -0
  58. package/dist/content.d.ts +1796 -0
  59. package/dist/content.js +354 -0
  60. package/dist/credentials.cjs +22 -0
  61. package/dist/credentials.d.cts +82 -0
  62. package/dist/credentials.d.ts +82 -0
  63. package/dist/credentials.js +1 -0
  64. package/dist/crm.cjs +271 -0
  65. package/dist/crm.d.cts +1731 -0
  66. package/dist/crm.d.ts +1731 -0
  67. package/dist/crm.js +226 -0
  68. package/dist/data.cjs +382 -0
  69. package/dist/data.d.cts +1860 -0
  70. package/dist/data.d.ts +1860 -0
  71. package/dist/data.js +318 -0
  72. package/dist/education.cjs +28 -0
  73. package/dist/education.d.cts +73 -0
  74. package/dist/education.d.ts +73 -0
  75. package/dist/education.js +23 -0
  76. package/dist/files.cjs +1330 -0
  77. package/dist/files.d.cts +4956 -0
  78. package/dist/files.d.ts +4956 -0
  79. package/dist/files.js +1104 -0
  80. package/dist/human-resources.cjs +178 -0
  81. package/dist/human-resources.d.cts +1208 -0
  82. package/dist/human-resources.d.ts +1208 -0
  83. package/dist/human-resources.js +148 -0
  84. package/dist/index-C2E-Cp19.d.ts +385 -0
  85. package/dist/index-wC2vtb70.d.cts +385 -0
  86. package/dist/index.cjs +1934 -0
  87. package/dist/index.d.cts +2006 -0
  88. package/dist/index.d.ts +2006 -0
  89. package/dist/index.js +1668 -0
  90. package/dist/integrations.cjs +5116 -0
  91. package/dist/integrations.d.cts +19213 -0
  92. package/dist/integrations.d.ts +19213 -0
  93. package/dist/integrations.js +4263 -0
  94. package/dist/intelligence.cjs +1305 -0
  95. package/dist/intelligence.d.cts +4658 -0
  96. package/dist/intelligence.d.ts +4658 -0
  97. package/dist/intelligence.js +1196 -0
  98. package/dist/knowledge.cjs +1113 -0
  99. package/dist/knowledge.d.cts +5427 -0
  100. package/dist/knowledge.d.ts +5427 -0
  101. package/dist/knowledge.js +921 -0
  102. package/dist/legal.cjs +225 -0
  103. package/dist/legal.d.cts +1038 -0
  104. package/dist/legal.d.ts +1038 -0
  105. package/dist/legal.js +187 -0
  106. package/dist/marketing.cjs +1155 -0
  107. package/dist/marketing.d.cts +7741 -0
  108. package/dist/marketing.d.ts +7741 -0
  109. package/dist/marketing.js +951 -0
  110. package/dist/masterwork.cjs +283 -0
  111. package/dist/masterwork.d.cts +1938 -0
  112. package/dist/masterwork.d.ts +1938 -0
  113. package/dist/masterwork.js +231 -0
  114. package/dist/media.cjs +610 -0
  115. package/dist/media.d.cts +2270 -0
  116. package/dist/media.d.ts +2270 -0
  117. package/dist/media.js +507 -0
  118. package/dist/net.cjs +67 -0
  119. package/dist/net.d.cts +204 -0
  120. package/dist/net.d.ts +204 -0
  121. package/dist/net.js +2 -0
  122. package/dist/platform.cjs +150 -0
  123. package/dist/platform.d.cts +572 -0
  124. package/dist/platform.d.ts +572 -0
  125. package/dist/platform.js +125 -0
  126. package/dist/publish.cjs +248 -0
  127. package/dist/publish.d.cts +1431 -0
  128. package/dist/publish.d.ts +1431 -0
  129. package/dist/publish.js +206 -0
  130. package/dist/schemas.cjs +2 -0
  131. package/dist/schemas.d.cts +1353 -0
  132. package/dist/schemas.d.ts +1353 -0
  133. package/dist/schemas.js +1 -0
  134. package/dist/stream.cjs +44 -0
  135. package/dist/stream.d.cts +2 -0
  136. package/dist/stream.d.ts +2 -0
  137. package/dist/stream.js +3 -0
  138. package/dist/web.cjs +1045 -0
  139. package/dist/web.d.cts +4186 -0
  140. package/dist/web.d.ts +4186 -0
  141. package/dist/web.js +867 -0
  142. package/dist/workflows.cjs +825 -0
  143. package/dist/workflows.d.cts +4699 -0
  144. package/dist/workflows.d.ts +4699 -0
  145. package/dist/workflows.js +686 -0
  146. package/package.json +418 -4
package/dist/crm.d.cts ADDED
@@ -0,0 +1,1731 @@
1
+ import { A as Api, C as CallOptions, a as ApiStream, N as NdjsonEvent } from './index-wC2vtb70.cjs';
2
+ import { JsonValue } from './schemas.cjs';
3
+ import './credentials.cjs';
4
+
5
+ /**
6
+ * GENERATED by @ai-matrx/api scripts/generate.mjs from aidream/api-contract — never edit by hand.
7
+ * CONTRACT_SHA256 50a790edb39e682b46e0fa9e674faf5ce2a0ba7de2cd01930a497fca4c47844a
8
+ */
9
+
10
+ /** ActivityEvidence */
11
+ type ActivityEvidence = {
12
+ url: string;
13
+ title?: string | null;
14
+ published_at?: string | null;
15
+ outlet_domain?: string | null;
16
+ via?: "crawl" | "search";
17
+ };
18
+ /** ActivityVerdict */
19
+ type ActivityVerdict = {
20
+ party_id: string;
21
+ person_name: string;
22
+ outlet_party_id?: string | null;
23
+ outlet_name?: string | null;
24
+ outlet_domain?: string | null;
25
+ status?: "active" | "stale" | "moved" | "unknown";
26
+ window_days?: number | null;
27
+ last_seen_at?: string | null;
28
+ checked_at?: string | null;
29
+ evidence?: ActivityEvidence[];
30
+ moved_to_domain?: string | null;
31
+ summary?: string;
32
+ searched?: boolean;
33
+ search_failed?: boolean;
34
+ };
35
+ /** AdvisoryOffer */
36
+ type AdvisoryOffer = {
37
+ label: string;
38
+ action: "mandate" | "limit_to" | "schedule_at" | "hold_until" | "label_cold" | "rewrite_line" | "strip_tracking" | "flatten_attachments" | "split_angles";
39
+ mandate_key?: string | null;
40
+ detail?: {
41
+ [key: string]: JsonValue;
42
+ };
43
+ };
44
+ /** What this journalist covers. Every field is evidence-backed or NULL. */
45
+ type BeatProfile = {
46
+ party_id: string;
47
+ person_name: string;
48
+ outlet_party_id?: string | null;
49
+ outlet_name?: string | null;
50
+ outlet_domain?: string | null;
51
+ beats?: string[];
52
+ beat_summary?: string;
53
+ topics?: string[];
54
+ typical_angle?: string;
55
+ campaign_fit?: ("strong" | "moderate" | "weak" | "none") | null;
56
+ campaign_fit_reason?: string | null;
57
+ pitch?: string | null;
58
+ journalist_fit?: {
59
+ [key: string]: JsonValue;
60
+ } | null;
61
+ insufficient_evidence?: boolean;
62
+ pages_analyzed?: number;
63
+ evidence_urls?: string[];
64
+ derived_at?: string | null;
65
+ summary?: string;
66
+ };
67
+ /** Server-side half of the production bring-up checklist. Booleans only. */
68
+ type BringUpReadiness = {
69
+ organization_id: string;
70
+ pubsub_topic_configured: boolean;
71
+ push_auth_configured: boolean;
72
+ push_token_configured: boolean;
73
+ hunter_key_present: boolean;
74
+ prospeo_key_present: boolean;
75
+ millionverifier_key_present: boolean;
76
+ gmail_readonly_granted: boolean;
77
+ connected_mailboxes: number;
78
+ connected_audit_mailboxes?: number;
79
+ };
80
+ /** BulkEnrichmentRequest */
81
+ type BulkEnrichmentRequest = {
82
+ /** Organization context for the request; omitted to use the authenticated context. */
83
+ organization_id?: string | null;
84
+ /** Optional associated project selected by the caller. */
85
+ project_id?: string | null;
86
+ /** Optional associated task selected by the caller. */
87
+ task_id?: string | null;
88
+ /** Stable application slug that initiated the request. */
89
+ source_app?: string | null;
90
+ /** Stable feature slug within the source application. */
91
+ source_feature?: string | null;
92
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
93
+ initiation?: ("user" | "auto") | null;
94
+ rows?: BulkRow[];
95
+ use_paid_providers?: boolean;
96
+ };
97
+ /** What a run WOULD do. Spends nothing, creates nothing. */
98
+ type BulkPreview = {
99
+ rows_supplied?: number;
100
+ would_enrich?: number;
101
+ blocked?: number;
102
+ duplicates?: number;
103
+ unusable?: number;
104
+ entries?: BulkRowResult[];
105
+ summary?: string;
106
+ };
107
+ /** BulkReport */
108
+ type BulkReport = {
109
+ rows_supplied?: number;
110
+ rows_attempted?: number;
111
+ parties_created?: number;
112
+ candidates_found?: number;
113
+ personal_found?: number;
114
+ blocked?: number;
115
+ duplicates?: number;
116
+ unusable?: number;
117
+ failed?: number;
118
+ not_attempted?: number;
119
+ budget_exhausted?: boolean;
120
+ results?: BulkRowResult[];
121
+ summary?: string;
122
+ };
123
+ /** One line of the user's sheet, as supplied. */
124
+ type BulkRow = {
125
+ domain: string;
126
+ person_name?: string | null;
127
+ company_name?: string | null;
128
+ };
129
+ /** BulkRowResult */
130
+ type BulkRowResult = {
131
+ domain: string;
132
+ normalized_domain?: string;
133
+ person_name?: string | null;
134
+ company_name?: string | null;
135
+ verdict: "enriched" | "no_candidates" | "blocklisted" | "duplicate_in_sheet" | "unusable" | "budget_exhausted" | "failed";
136
+ why?: string;
137
+ party_id?: string | null;
138
+ party_created?: boolean;
139
+ candidates_found?: number;
140
+ personal_found?: number;
141
+ candidates?: ContactCandidateView[];
142
+ };
143
+ /** CheckRecord */
144
+ type CheckRecord = {
145
+ id: string;
146
+ check_kind: string;
147
+ passed: boolean;
148
+ message?: string | null;
149
+ checked_at: string;
150
+ observed?: {
151
+ [key: string]: JsonValue;
152
+ };
153
+ };
154
+ /** The result of running the checks, as the surface renders it. */
155
+ type CheckReport = {
156
+ identity: SendingIdentityDetail;
157
+ checks: CheckRecord[];
158
+ changed_status_to?: ("draft" | "verifying" | "warming" | "ready" | "paused" | "disabled") | null;
159
+ };
160
+ /** ConfirmCandidateRequest */
161
+ type ConfirmCandidateRequest = {
162
+ /** Organization context for the request; omitted to use the authenticated context. */
163
+ organization_id?: string | null;
164
+ /** Optional associated project selected by the caller. */
165
+ project_id?: string | null;
166
+ /** Optional associated task selected by the caller. */
167
+ task_id?: string | null;
168
+ /** Stable application slug that initiated the request. */
169
+ source_app?: string | null;
170
+ /** Stable feature slug within the source application. */
171
+ source_feature?: string | null;
172
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
173
+ initiation?: ("user" | "auto") | null;
174
+ accept_role_address?: boolean;
175
+ accept_unverified?: boolean;
176
+ };
177
+ /** ConfirmOutletContactRequest */
178
+ type ConfirmOutletContactRequest = {
179
+ /** Organization context for the request; omitted to use the authenticated context. */
180
+ organization_id?: string | null;
181
+ /** Optional associated project selected by the caller. */
182
+ project_id?: string | null;
183
+ /** Optional associated task selected by the caller. */
184
+ task_id?: string | null;
185
+ /** Stable application slug that initiated the request. */
186
+ source_app?: string | null;
187
+ /** Stable feature slug within the source application. */
188
+ source_feature?: string | null;
189
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
190
+ initiation?: ("user" | "auto") | null;
191
+ candidate_key: string;
192
+ email_keys?: string[];
193
+ accept_low_confidence?: boolean;
194
+ accept_role_address?: boolean;
195
+ };
196
+ /** ConfirmedOutletContact */
197
+ type ConfirmedOutletContact = {
198
+ key: string;
199
+ display_name: string;
200
+ party_id: string;
201
+ created: boolean;
202
+ matched_by: string;
203
+ affiliation_id: string;
204
+ affiliation_created: boolean;
205
+ email_keys?: string[];
206
+ contact_points_added?: number;
207
+ };
208
+ /** A mailbox the signed-in user could turn into a sending identity. */
209
+ type ConnectableMailbox = {
210
+ connection_id: string;
211
+ provider: "google_workspace" | "microsoft_365" | "smtp";
212
+ account_email: string;
213
+ account_name?: string | null;
214
+ can_send: boolean;
215
+ blocked_reason?: string | null;
216
+ already_used?: boolean;
217
+ recorded_for_audit?: boolean;
218
+ promotion_note?: string | null;
219
+ };
220
+ /** ConnectorContactView */
221
+ type ConnectorContactView = {
222
+ external_id: string;
223
+ display_name?: string;
224
+ first_name?: string;
225
+ last_name?: string;
226
+ job_title?: string;
227
+ company?: string;
228
+ emails?: string[];
229
+ phones?: string[];
230
+ urls?: string[];
231
+ source_updated_at?: string | null;
232
+ };
233
+ /** ConnectorCursorRequest */
234
+ type ConnectorCursorRequest = {
235
+ organization_id?: string | null;
236
+ /** Optional associated project selected by the caller. */
237
+ project_id?: string | null;
238
+ /** Optional associated task selected by the caller. */
239
+ task_id?: string | null;
240
+ /** Stable application slug that initiated the request. */
241
+ source_app?: string | null;
242
+ /** Stable feature slug within the source application. */
243
+ source_feature?: string | null;
244
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
245
+ initiation?: ("user" | "auto") | null;
246
+ connection_id: string;
247
+ sync_token: string;
248
+ counts?: {
249
+ [key: string]: number;
250
+ };
251
+ };
252
+ /** ConnectorCursorResponse */
253
+ type ConnectorCursorResponse = {
254
+ ok: boolean;
255
+ };
256
+ /** ConnectorFetchRequest */
257
+ type ConnectorFetchRequest = {
258
+ organization_id?: string | null;
259
+ /** Optional associated project selected by the caller. */
260
+ project_id?: string | null;
261
+ /** Optional associated task selected by the caller. */
262
+ task_id?: string | null;
263
+ /** Stable application slug that initiated the request. */
264
+ source_app?: string | null;
265
+ /** Stable feature slug within the source application. */
266
+ source_feature?: string | null;
267
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
268
+ initiation?: ("user" | "auto") | null;
269
+ connection_id: string;
270
+ mode?: "auto" | "full";
271
+ max_records?: number;
272
+ };
273
+ /** ConnectorFetchResponse */
274
+ type ConnectorFetchResponse = {
275
+ provider_key: string;
276
+ platform_slug: string;
277
+ source_label: string;
278
+ account_email?: string | null;
279
+ records?: ConnectorContactView[];
280
+ deleted_external_ids?: string[];
281
+ sync_token?: string | null;
282
+ incremental?: boolean;
283
+ truncated?: boolean;
284
+ warnings?: string[];
285
+ };
286
+ /** A persisted candidate as a surface sees it. Every field is a door or a why. */
287
+ type ContactCandidateView = {
288
+ id: string;
289
+ party_id: string;
290
+ person_name?: string | null;
291
+ person_party_id?: string | null;
292
+ role_title?: string | null;
293
+ channel?: string;
294
+ address: string;
295
+ is_role_address?: boolean;
296
+ source: string;
297
+ source_detail?: string | null;
298
+ source_url?: string | null;
299
+ confidence?: number;
300
+ provider_confidence?: number | null;
301
+ verification_status?: "unverified" | "verified" | "invalid" | "risky";
302
+ mx_valid?: boolean | null;
303
+ verified_at?: string | null;
304
+ verification_reason?: string;
305
+ engagement_score?: number | null;
306
+ engagement_reasons?: string[];
307
+ status?: "candidate" | "confirmed" | "rejected" | "stale";
308
+ confirmed_contact_point_id?: string | null;
309
+ why?: string[];
310
+ first_seen_at?: string | null;
311
+ last_seen_at?: string | null;
312
+ };
313
+ /** ContactEvidence */
314
+ type ContactEvidence = {
315
+ source_id: string;
316
+ url: string;
317
+ title?: string | null;
318
+ kind: "byline" | "editor" | "author_profile" | "credentialed_author" | "quote" | "mention";
319
+ detail: string;
320
+ };
321
+ /** CreateSendingIdentityRequest */
322
+ type CreateSendingIdentityRequest = {
323
+ /** Organization context for the request; omitted to use the authenticated context. */
324
+ organization_id?: string | null;
325
+ /** Optional associated project selected by the caller. */
326
+ project_id?: string | null;
327
+ /** Optional associated task selected by the caller. */
328
+ task_id?: string | null;
329
+ /** Stable application slug that initiated the request. */
330
+ source_app?: string | null;
331
+ /** Stable feature slug within the source application. */
332
+ source_feature?: string | null;
333
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
334
+ initiation?: ("user" | "auto") | null;
335
+ provider?: "google_workspace" | "microsoft_365" | "smtp";
336
+ connection_id?: string | null;
337
+ from_address: string;
338
+ from_name?: string | null;
339
+ reply_to?: string | null;
340
+ display_name?: string | null;
341
+ };
342
+ /** CritiqueResult */
343
+ type CritiqueResult = {
344
+ status: PartStatus;
345
+ critique?: {
346
+ [key: string]: JsonValue;
347
+ } | null;
348
+ corrections?: string[];
349
+ text?: string | null;
350
+ };
351
+ /** Exactly what to paste into a DNS provider. Never prose. */
352
+ type DnsRecordSpec = {
353
+ type: string;
354
+ host: string;
355
+ name: string;
356
+ value: string;
357
+ ttl: string;
358
+ };
359
+ /** FactCheckResult */
360
+ type FactCheckResult = {
361
+ status: PartStatus;
362
+ by_knob?: boolean;
363
+ verdict?: string | null;
364
+ markdown?: string | null;
365
+ };
366
+ /** FinalMileResult */
367
+ type FinalMileResult = {
368
+ medium_id: string;
369
+ address: string;
370
+ status: "unverified" | "verified" | "invalid" | "risky";
371
+ mx_valid?: boolean | null;
372
+ free_tier_status?: string;
373
+ provider_used?: string | null;
374
+ provider_result?: string | null;
375
+ provider_skipped_reason?: string | null;
376
+ reason?: string;
377
+ changed?: boolean;
378
+ };
379
+ /** FindContactsRequest */
380
+ type FindContactsRequest = {
381
+ /** Organization context for the request; omitted to use the authenticated context. */
382
+ organization_id?: string | null;
383
+ /** Optional associated project selected by the caller. */
384
+ project_id?: string | null;
385
+ /** Optional associated task selected by the caller. */
386
+ task_id?: string | null;
387
+ /** Stable application slug that initiated the request. */
388
+ source_app?: string | null;
389
+ /** Stable feature slug within the source application. */
390
+ source_feature?: string | null;
391
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
392
+ initiation?: ("user" | "auto") | null;
393
+ person_name?: string | null;
394
+ use_paid_providers?: boolean;
395
+ };
396
+ /** The rolling picture. Rates are fractions (0.03 == 3%), never percentages — */
397
+ type IdentityHealth = {
398
+ window_days?: number;
399
+ sent?: number;
400
+ delivered?: number;
401
+ hard_bounced?: number;
402
+ soft_bounced?: number;
403
+ complained?: number;
404
+ replied?: number;
405
+ unsubscribed?: number;
406
+ failed?: number;
407
+ failure_streak?: number;
408
+ hard_bounce_rate?: number;
409
+ complaint_rate?: number;
410
+ reply_rate?: number;
411
+ computed_at?: string;
412
+ breaches?: string[];
413
+ };
414
+ /** ImportConnectorConnectionView */
415
+ type ImportConnectorConnectionView = {
416
+ connection_id: string;
417
+ account_email?: string | null;
418
+ account_name?: string | null;
419
+ status?: string;
420
+ scope_granted?: boolean;
421
+ has_sync_cursor?: boolean;
422
+ last_synced_at?: string | null;
423
+ last_sync_counts?: {
424
+ [key: string]: JsonValue;
425
+ };
426
+ };
427
+ /** ImportConnectorView */
428
+ type ImportConnectorView = {
429
+ provider_key: string;
430
+ display_name: string;
431
+ provider: string;
432
+ platform_slug: string;
433
+ required_scopes?: string[];
434
+ connections?: ImportConnectorConnectionView[];
435
+ };
436
+ /** JournalistActivityRequest */
437
+ type JournalistActivityRequest = {
438
+ /** Organization context for the request; omitted to use the authenticated context. */
439
+ organization_id?: string | null;
440
+ /** Optional associated project selected by the caller. */
441
+ project_id?: string | null;
442
+ /** Optional associated task selected by the caller. */
443
+ task_id?: string | null;
444
+ /** Stable application slug that initiated the request. */
445
+ source_app?: string | null;
446
+ /** Stable feature slug within the source application. */
447
+ source_feature?: string | null;
448
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
449
+ initiation?: ("user" | "auto") | null;
450
+ window_days?: number | null;
451
+ use_search?: boolean;
452
+ };
453
+ /** JournalistBeatRequest */
454
+ type JournalistBeatRequest = {
455
+ /** Organization context for the request; omitted to use the authenticated context. */
456
+ organization_id?: string | null;
457
+ /** Optional associated project selected by the caller. */
458
+ project_id?: string | null;
459
+ /** Optional associated task selected by the caller. */
460
+ task_id?: string | null;
461
+ /** Stable application slug that initiated the request. */
462
+ source_app?: string | null;
463
+ /** Stable feature slug within the source application. */
464
+ source_feature?: string | null;
465
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
466
+ initiation?: ("user" | "auto") | null;
467
+ pitch?: string | null;
468
+ client_or_subject?: string | null;
469
+ decay_stage?: string | null;
470
+ };
471
+ /** KindSubmitSummary */
472
+ type KindSubmitSummary = {
473
+ pending?: number;
474
+ enqueued?: number;
475
+ skipped_in_flight?: number;
476
+ skipped_no_owner?: number;
477
+ errors?: string[];
478
+ };
479
+ /** One journalist a news search surfaced. A proposal, never a member. */
480
+ type MediaListProspect = {
481
+ party_id: string;
482
+ person_name: string;
483
+ outlet_domain: string;
484
+ story_url: string;
485
+ story_title?: string | null;
486
+ published_at?: string | null;
487
+ already_on_list?: boolean;
488
+ };
489
+ /** MediaListRefreshRequest */
490
+ type MediaListRefreshRequest = {
491
+ /** Organization context for the request; omitted to use the authenticated context. */
492
+ organization_id?: string | null;
493
+ /** Optional associated project selected by the caller. */
494
+ project_id?: string | null;
495
+ /** Optional associated task selected by the caller. */
496
+ task_id?: string | null;
497
+ /** Stable application slug that initiated the request. */
498
+ source_app?: string | null;
499
+ /** Stable feature slug within the source application. */
500
+ source_feature?: string | null;
501
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
502
+ initiation?: ("user" | "auto") | null;
503
+ force?: boolean;
504
+ };
505
+ /** MediaListRefreshResult */
506
+ type MediaListRefreshResult = {
507
+ list_id: string;
508
+ list_name?: string;
509
+ members_total?: number;
510
+ members_checked?: number;
511
+ members_due_not_reached?: number;
512
+ role_changes?: number;
513
+ beats_derived?: number;
514
+ assists_created?: number;
515
+ errors?: string[];
516
+ members?: MemberRefresh[];
517
+ ran_at?: string | null;
518
+ };
519
+ /** MediaListSearchRequest */
520
+ type MediaListSearchRequest = {
521
+ /** Organization context for the request; omitted to use the authenticated context. */
522
+ organization_id?: string | null;
523
+ /** Optional associated project selected by the caller. */
524
+ project_id?: string | null;
525
+ /** Optional associated task selected by the caller. */
526
+ task_id?: string | null;
527
+ /** Stable application slug that initiated the request. */
528
+ source_app?: string | null;
529
+ /** Stable feature slug within the source application. */
530
+ source_feature?: string | null;
531
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
532
+ initiation?: ("user" | "auto") | null;
533
+ query: string;
534
+ max_results?: number;
535
+ };
536
+ /** MediaListSearchResult */
537
+ type MediaListSearchResult = {
538
+ query: string;
539
+ articles_seen?: number;
540
+ bylines_found?: number;
541
+ prospects?: MediaListProspect[];
542
+ search_failed?: boolean;
543
+ summary?: string;
544
+ };
545
+ /** `outreach_list.definition.media_refresh`. Every knob has a safe default. */
546
+ type MediaRefreshPolicy = {
547
+ enabled?: boolean;
548
+ cadence_days?: number;
549
+ window_days?: number | null;
550
+ use_search?: boolean;
551
+ derive_beats?: boolean;
552
+ campaign_context?: string | null;
553
+ };
554
+ /** MediaResearchCost */
555
+ type MediaResearchCost = {
556
+ searches: number;
557
+ article_reads: number;
558
+ candidates: number;
559
+ contact_lookups: number;
560
+ fit_checks: number;
561
+ max_cost_usd: number;
562
+ lines?: string[];
563
+ };
564
+ /** Everything the person sees before anything is spent. */
565
+ type MediaResearchPreview = {
566
+ list_id: string;
567
+ angle: string;
568
+ wanted_good_fits: number;
569
+ multiplier: number;
570
+ multiplier_reason: string;
571
+ computed_target: number;
572
+ research_target: number;
573
+ cap: number;
574
+ over_cap: boolean;
575
+ advisories?: PitchAdvisory[];
576
+ brief: string;
577
+ brief_chars: number;
578
+ brief_max_chars: number;
579
+ queries: string[];
580
+ first_wave_size: number;
581
+ cost: MediaResearchCost;
582
+ run_key: string;
583
+ prior_run?: MediaResearchPriorRun | null;
584
+ says: string;
585
+ };
586
+ /** MediaResearchPreviewRequest */
587
+ type MediaResearchPreviewRequest = {
588
+ /** Organization context for the request; omitted to use the authenticated context. */
589
+ organization_id?: string | null;
590
+ /** Optional associated project selected by the caller. */
591
+ project_id?: string | null;
592
+ /** Optional associated task selected by the caller. */
593
+ task_id?: string | null;
594
+ /** Stable application slug that initiated the request. */
595
+ source_app?: string | null;
596
+ /** Stable feature slug within the source application. */
597
+ source_feature?: string | null;
598
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
599
+ initiation?: ("user" | "auto") | null;
600
+ request: MediaResearchRequest;
601
+ };
602
+ /** MediaResearchPriorRun */
603
+ type MediaResearchPriorRun = {
604
+ status: string;
605
+ started_at?: string | null;
606
+ finished_at?: string | null;
607
+ says?: string;
608
+ };
609
+ /** What the person building the list asks for. Every text field is theirs. */
610
+ type MediaResearchRequest = {
611
+ angle: string;
612
+ wanted_good_fits: number;
613
+ narrow_beat?: boolean;
614
+ narrow_reason?: string | null;
615
+ standing?: string | null;
616
+ proof_hook?: string | null;
617
+ reporter_shape?: string | null;
618
+ sub_angles?: string[];
619
+ competitors?: string[];
620
+ regions?: string[];
621
+ exclusions?: string | null;
622
+ research_target_override?: number | null;
623
+ };
624
+ /** MediaResearchRunBody */
625
+ type MediaResearchRunBody = {
626
+ /** Organization context for the request; omitted to use the authenticated context. */
627
+ organization_id?: string | null;
628
+ /** Optional associated project selected by the caller. */
629
+ project_id?: string | null;
630
+ /** Optional associated task selected by the caller. */
631
+ task_id?: string | null;
632
+ /** Stable application slug that initiated the request. */
633
+ source_app?: string | null;
634
+ /** Stable feature slug within the source application. */
635
+ source_feature?: string | null;
636
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
637
+ initiation?: ("user" | "auto") | null;
638
+ run: MediaResearchRunRequest;
639
+ };
640
+ /** MediaResearchRunRequest */
641
+ type MediaResearchRunRequest = {
642
+ request: MediaResearchRequest;
643
+ run_key: string;
644
+ approved_max_cost_usd: number;
645
+ confirmed_over_cap?: boolean;
646
+ };
647
+ /** MemberRefresh */
648
+ type MemberRefresh = {
649
+ member_id: string;
650
+ party_id: string;
651
+ person_name: string;
652
+ checked?: boolean;
653
+ skipped_reason?: string | null;
654
+ previous_status?: string | null;
655
+ status?: string | null;
656
+ role_changed?: boolean;
657
+ beat_derived?: boolean;
658
+ error?: string | null;
659
+ };
660
+ /** ObservedEmailCandidate */
661
+ type ObservedEmailCandidate = {
662
+ key: string;
663
+ address: string;
664
+ confidence: number;
665
+ tier: "observed_personal" | "observed_role";
666
+ is_role_address: boolean;
667
+ why: string;
668
+ source_id: string;
669
+ source_url: string;
670
+ source_title?: string | null;
671
+ };
672
+ /** OutletContactCandidate */
673
+ type OutletContactCandidate = {
674
+ key: string;
675
+ display_name: string;
676
+ role: string;
677
+ confidence: number;
678
+ tier: "strong" | "probable" | "weak";
679
+ why?: string[];
680
+ evidence?: ContactEvidence[];
681
+ observed_emails?: ObservedEmailCandidate[];
682
+ existing_party_id?: string | null;
683
+ existing_affiliation_id?: string | null;
684
+ existing_email_keys?: string[];
685
+ };
686
+ /** OutletContactExtraction */
687
+ type OutletContactExtraction = {
688
+ outlet_party_id: string;
689
+ outlet_name: string;
690
+ outlet_domain: string;
691
+ organization_id: string;
692
+ sources_analyzed: number;
693
+ candidates?: OutletContactCandidate[];
694
+ rejected?: {
695
+ [key: string]: string;
696
+ }[];
697
+ };
698
+ /** OutletGroup */
699
+ type OutletGroup = {
700
+ outlet_party_id: string | null;
701
+ outlet_name: string | null;
702
+ recipient_party_ids: string[];
703
+ pitch_first_party_id: string;
704
+ held_party_ids?: string[];
705
+ hold_until?: string | null;
706
+ why: string;
707
+ };
708
+ /** PartStatus */
709
+ type PartStatus = {
710
+ state: "ran" | "skipped" | "failed";
711
+ reason?: string | null;
712
+ };
713
+ /** ``organization_id`` is the caller's injected app context, never the target; */
714
+ type PartyKindBatchRequest = {
715
+ /** Organization context for the request; omitted to use the authenticated context. */
716
+ organization_id?: string | null;
717
+ /** Optional associated project selected by the caller. */
718
+ project_id?: string | null;
719
+ /** Optional associated task selected by the caller. */
720
+ task_id?: string | null;
721
+ /** Stable application slug that initiated the request. */
722
+ source_app?: string | null;
723
+ /** Stable feature slug within the source application. */
724
+ source_feature?: string | null;
725
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
726
+ initiation?: ("user" | "auto") | null;
727
+ /** Only this organization's queue; omit for every organization. */
728
+ queue_organization_id?: string | null;
729
+ limit?: number;
730
+ };
731
+ /** PauseRequest */
732
+ type PauseRequest = {
733
+ /** Organization context for the request; omitted to use the authenticated context. */
734
+ organization_id?: string | null;
735
+ /** Optional associated project selected by the caller. */
736
+ project_id?: string | null;
737
+ /** Optional associated task selected by the caller. */
738
+ task_id?: string | null;
739
+ /** Stable application slug that initiated the request. */
740
+ source_app?: string | null;
741
+ /** Stable feature slug within the source application. */
742
+ source_feature?: string | null;
743
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
744
+ initiation?: ("user" | "auto") | null;
745
+ reason: string;
746
+ };
747
+ /** PitchAdvisory */
748
+ type PitchAdvisory = {
749
+ rule: "E1" | "E2" | "E3" | "E4" | "E5" | "E6" | "E7" | "E8" | "E9" | "E10" | "E11" | "E12" | "E13" | "E14" | "E15" | "E16" | "E17";
750
+ code: string;
751
+ severity: "info" | "warn" | "strong";
752
+ message: string;
753
+ offer?: AdvisoryOffer | null;
754
+ other_offers?: AdvisoryOffer[];
755
+ knob?: string | null;
756
+ evidence?: {
757
+ [key: string]: JsonValue;
758
+ };
759
+ };
760
+ /** PitchAdvisoryReport */
761
+ type PitchAdvisoryReport = {
762
+ surface: "single_send" | "list_send" | "list_save" | "chasebox_review" | "followup_runner" | "source_request" | "crisis_publish";
763
+ advisories?: PitchAdvisory[];
764
+ action_may_proceed?: true;
765
+ wants_person?: boolean;
766
+ };
767
+ /** `PitchContext` minus the principal, which comes from the request context. */
768
+ type PitchAdvisoryRequest = {
769
+ /** Organization context for the request; omitted to use the authenticated context. */
770
+ organization_id?: string | null;
771
+ /** Optional associated project selected by the caller. */
772
+ project_id?: string | null;
773
+ /** Optional associated task selected by the caller. */
774
+ task_id?: string | null;
775
+ /** Stable application slug that initiated the request. */
776
+ source_app?: string | null;
777
+ /** Stable feature slug within the source application. */
778
+ source_feature?: string | null;
779
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
780
+ initiation?: ("user" | "auto") | null;
781
+ surface: "single_send" | "list_send" | "list_save" | "chasebox_review" | "followup_runner" | "source_request" | "crisis_publish";
782
+ draft_id?: string | null;
783
+ outreach_list_id?: string | null;
784
+ source_request_id?: string | null;
785
+ reputation_case_id?: string | null;
786
+ recipient_party_ids?: string[];
787
+ subject?: string | null;
788
+ body?: string | null;
789
+ recipient_count?: number | null;
790
+ adding_recipients?: number | null;
791
+ attachment_count?: number;
792
+ is_exclusive?: boolean;
793
+ exclusive_expires_at?: string | null;
794
+ embargo_until?: string | null;
795
+ has_new_information?: boolean | null;
796
+ has_direct_standing?: boolean | null;
797
+ };
798
+ /** `PreSendCheckRequest` minus the principal, which comes from the request context. */
799
+ type PreSendCheckDoorRequest = {
800
+ /** Organization context for the request; omitted to use the authenticated context. */
801
+ organization_id?: string | null;
802
+ /** Optional associated project selected by the caller. */
803
+ project_id?: string | null;
804
+ /** Optional associated task selected by the caller. */
805
+ task_id?: string | null;
806
+ /** Stable application slug that initiated the request. */
807
+ source_app?: string | null;
808
+ /** Stable feature slug within the source application. */
809
+ source_feature?: string | null;
810
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
811
+ initiation?: ("user" | "auto") | null;
812
+ surface?: "single_send" | "list_send" | "list_save" | "chasebox_review" | "followup_runner" | "source_request" | "crisis_publish";
813
+ draft_id?: string | null;
814
+ outreach_list_id?: string | null;
815
+ recipient_party_ids?: string[];
816
+ subject?: string | null;
817
+ body?: string | null;
818
+ run_critique?: boolean;
819
+ run_fact_check?: boolean | null;
820
+ fresh_fit?: boolean;
821
+ };
822
+ /** PreSendCheckReport */
823
+ type PreSendCheckReport = {
824
+ surface: "single_send" | "list_send" | "list_save" | "chasebox_review" | "followup_runner" | "source_request" | "crisis_publish";
825
+ subject?: string | null;
826
+ advisories?: PitchAdvisoryReport | null;
827
+ advisories_status: PartStatus;
828
+ critique: CritiqueResult;
829
+ fact_check: FactCheckResult;
830
+ fit_status: PartStatus;
831
+ recipients?: RecipientFit[];
832
+ outlets?: OutletGroup[];
833
+ action_may_proceed?: true;
834
+ };
835
+ /** RecipientFit */
836
+ type RecipientFit = {
837
+ party_id: string;
838
+ name?: string | null;
839
+ member_id?: string | null;
840
+ outlet_party_id?: string | null;
841
+ outlet_name?: string | null;
842
+ verdict?: string | null;
843
+ note?: string | null;
844
+ checked_at?: string | null;
845
+ basis?: "current" | "other_pitch" | "fresh" | "none" | "failed";
846
+ };
847
+ /** RejectCandidateRequest */
848
+ type RejectCandidateRequest = {
849
+ /** Organization context for the request; omitted to use the authenticated context. */
850
+ organization_id?: string | null;
851
+ /** Optional associated project selected by the caller. */
852
+ project_id?: string | null;
853
+ /** Optional associated task selected by the caller. */
854
+ task_id?: string | null;
855
+ /** Stable application slug that initiated the request. */
856
+ source_app?: string | null;
857
+ /** Stable feature slug within the source application. */
858
+ source_feature?: string | null;
859
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
860
+ initiation?: ("user" | "auto") | null;
861
+ reason?: string | null;
862
+ };
863
+ /** ResolvePartyBatchRequest */
864
+ type ResolvePartyBatchRequest = {
865
+ /** Organization context for the request; omitted to use the authenticated context. */
866
+ organization_id?: string | null;
867
+ /** Optional associated project selected by the caller. */
868
+ project_id?: string | null;
869
+ /** Optional associated task selected by the caller. */
870
+ task_id?: string | null;
871
+ /** Stable application slug that initiated the request. */
872
+ source_app?: string | null;
873
+ /** Stable feature slug within the source application. */
874
+ source_feature?: string | null;
875
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
876
+ initiation?: ("user" | "auto") | null;
877
+ parties: ResolvePartyRequest[];
878
+ };
879
+ /** ResolvePartyExternalRef */
880
+ type ResolvePartyExternalRef = {
881
+ /** Organization context for the request; omitted to use the authenticated context. */
882
+ organization_id?: string | null;
883
+ /** Optional associated project selected by the caller. */
884
+ project_id?: string | null;
885
+ /** Optional associated task selected by the caller. */
886
+ task_id?: string | null;
887
+ /** Stable application slug that initiated the request. */
888
+ source_app?: string | null;
889
+ /** Stable feature slug within the source application. */
890
+ source_feature?: string | null;
891
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
892
+ initiation?: ("user" | "auto") | null;
893
+ platform: string;
894
+ value: string;
895
+ handle?: string | null;
896
+ profile_url?: string | null;
897
+ };
898
+ /** ResolvePartyRequest */
899
+ type ResolvePartyRequest = {
900
+ organization_id?: string | null;
901
+ /** Optional associated project selected by the caller. */
902
+ project_id?: string | null;
903
+ /** Optional associated task selected by the caller. */
904
+ task_id?: string | null;
905
+ /** Stable application slug that initiated the request. */
906
+ source_app?: string | null;
907
+ /** Stable feature slug within the source application. */
908
+ source_feature?: string | null;
909
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
910
+ initiation?: ("user" | "auto") | null;
911
+ kind?: "person" | "organization";
912
+ display_name: string;
913
+ source: string;
914
+ source_detail?: string | null;
915
+ first_name?: string | null;
916
+ last_name?: string | null;
917
+ job_title?: string | null;
918
+ headline?: string | null;
919
+ legal_name?: string | null;
920
+ primary_domain?: string | null;
921
+ emails?: string[];
922
+ phones?: string[];
923
+ external_ids?: ResolvePartyExternalRef[];
924
+ attributes?: {
925
+ [key: string]: JsonValue;
926
+ };
927
+ allow_name_match?: boolean;
928
+ };
929
+ /** ResolvedPartyBatchItem */
930
+ type ResolvedPartyBatchItem = {
931
+ index: number;
932
+ resolved?: ResolvedPartyView | null;
933
+ error?: string | null;
934
+ };
935
+ /** ResolvedPartyView */
936
+ type ResolvedPartyView = {
937
+ party_id: string;
938
+ display_name: string;
939
+ party_kind: string;
940
+ created: boolean;
941
+ matched_by: string;
942
+ canonical_followed?: boolean;
943
+ contact_points_added?: number;
944
+ fields_filled?: string[];
945
+ };
946
+ /** One line of the audit trail: who sent what to whom, and what happened. */
947
+ type SendingEventRecord = {
948
+ id: string;
949
+ event_kind: string;
950
+ to_address_key: string;
951
+ subject?: string | null;
952
+ party_id?: string | null;
953
+ outreach_list_id?: string | null;
954
+ provider_message_id?: string | null;
955
+ bounce_type?: string | null;
956
+ error_message?: string | null;
957
+ actor_kind: string;
958
+ actor_user_id?: string | null;
959
+ occurred_at: string;
960
+ };
961
+ /** SendingIdentityDetail */
962
+ type SendingIdentityDetail = {
963
+ id: string;
964
+ display_name: string;
965
+ provider: "google_workspace" | "microsoft_365" | "smtp";
966
+ from_address: string;
967
+ from_name?: string | null;
968
+ sending_domain: string;
969
+ status: "draft" | "verifying" | "warming" | "ready" | "paused" | "disabled";
970
+ purpose: "outreach" | "correspondence";
971
+ purpose_note: string;
972
+ domain_verified: boolean;
973
+ spf_pass?: boolean | null;
974
+ dkim_pass?: boolean | null;
975
+ dmarc_pass?: boolean | null;
976
+ warmup?: WarmupProgress | null;
977
+ health?: IdentityHealth | null;
978
+ paused_by_kind?: ("system" | "human") | null;
979
+ pause_reason?: string | null;
980
+ last_send_at?: string | null;
981
+ can_run_campaign?: boolean;
982
+ issues?: SendingRefusal[];
983
+ organization_id: string;
984
+ created_at: string;
985
+ updated_at: string;
986
+ connection_id?: string | null;
987
+ provider_account?: string | null;
988
+ reply_to?: string | null;
989
+ dns_record: DnsRecordSpec;
990
+ daily_cap: number;
991
+ hourly_cap: number;
992
+ min_interval_seconds: number;
993
+ max_interval_seconds: number;
994
+ quiet_hours_start: number;
995
+ quiet_hours_end: number;
996
+ send_weekends: boolean;
997
+ default_recipient_timezone: string;
998
+ effective_daily_cap: number;
999
+ sends_today: number;
1000
+ remaining_today: number;
1001
+ domain_checked_at?: string | null;
1002
+ auth_checked_at?: string | null;
1003
+ recent_checks?: CheckRecord[];
1004
+ };
1005
+ /** The list row — enough to see at a glance which mailbox needs attention. */
1006
+ type SendingIdentityView = {
1007
+ id: string;
1008
+ display_name: string;
1009
+ provider: "google_workspace" | "microsoft_365" | "smtp";
1010
+ from_address: string;
1011
+ from_name?: string | null;
1012
+ sending_domain: string;
1013
+ status: "draft" | "verifying" | "warming" | "ready" | "paused" | "disabled";
1014
+ purpose: "outreach" | "correspondence";
1015
+ purpose_note: string;
1016
+ domain_verified: boolean;
1017
+ spf_pass?: boolean | null;
1018
+ dkim_pass?: boolean | null;
1019
+ dmarc_pass?: boolean | null;
1020
+ warmup?: WarmupProgress | null;
1021
+ health?: IdentityHealth | null;
1022
+ paused_by_kind?: ("system" | "human") | null;
1023
+ pause_reason?: string | null;
1024
+ last_send_at?: string | null;
1025
+ can_run_campaign?: boolean;
1026
+ issues?: SendingRefusal[];
1027
+ organization_id: string;
1028
+ created_at: string;
1029
+ updated_at: string;
1030
+ };
1031
+ /** SendingPolicyView */
1032
+ type SendingPolicyView = {
1033
+ organization_id: string;
1034
+ outreach_enabled: boolean;
1035
+ disabled_at?: string | null;
1036
+ disabled_reason?: string | null;
1037
+ disabled_by_kind?: ("system" | "human") | null;
1038
+ notes?: string | null;
1039
+ identity_count?: number;
1040
+ ready_identity_count?: number;
1041
+ correspondence_identity_count?: number;
1042
+ };
1043
+ /** One machine-readable reason a send was refused, with its fix. */
1044
+ type SendingRefusal = {
1045
+ code: string;
1046
+ message: string;
1047
+ fix_action: "upgrade_plan" | "connect_mailbox" | "publish_dns_record" | "check_domain" | "check_authentication" | "start_warmup" | "wait_for_warmup" | "wait_for_pacing" | "wait_for_quiet_hours" | "review_and_resume" | "enable_org_outreach" | "verify_recipient_address" | "choose_another_identity" | "reconnect_mailbox" | "none";
1048
+ fix_detail?: {
1049
+ [key: string]: JsonValue;
1050
+ };
1051
+ transient?: boolean;
1052
+ };
1053
+ /** SetPolicyRequest */
1054
+ type SetPolicyRequest = {
1055
+ /** Organization context for the request; omitted to use the authenticated context. */
1056
+ organization_id?: string | null;
1057
+ /** Optional associated project selected by the caller. */
1058
+ project_id?: string | null;
1059
+ /** Optional associated task selected by the caller. */
1060
+ task_id?: string | null;
1061
+ /** Stable application slug that initiated the request. */
1062
+ source_app?: string | null;
1063
+ /** Stable feature slug within the source application. */
1064
+ source_feature?: string | null;
1065
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
1066
+ initiation?: ("user" | "auto") | null;
1067
+ outreach_enabled: boolean;
1068
+ reason?: string | null;
1069
+ };
1070
+ /** Pacing and presentation only. */
1071
+ type UpdateSendingIdentityRequest = {
1072
+ /** Organization context for the request; omitted to use the authenticated context. */
1073
+ organization_id?: string | null;
1074
+ /** Optional associated project selected by the caller. */
1075
+ project_id?: string | null;
1076
+ /** Optional associated task selected by the caller. */
1077
+ task_id?: string | null;
1078
+ /** Stable application slug that initiated the request. */
1079
+ source_app?: string | null;
1080
+ /** Stable feature slug within the source application. */
1081
+ source_feature?: string | null;
1082
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
1083
+ initiation?: ("user" | "auto") | null;
1084
+ display_name?: string | null;
1085
+ from_name?: string | null;
1086
+ reply_to?: string | null;
1087
+ daily_cap?: number | null;
1088
+ hourly_cap?: number | null;
1089
+ min_interval_seconds?: number | null;
1090
+ max_interval_seconds?: number | null;
1091
+ quiet_hours_start?: number | null;
1092
+ quiet_hours_end?: number | null;
1093
+ send_weekends?: boolean | null;
1094
+ default_recipient_timezone?: string | null;
1095
+ dkim_selector?: string | null;
1096
+ };
1097
+ /** VerifyAddressRequest */
1098
+ type VerifyAddressRequest = {
1099
+ /** Organization context for the request; omitted to use the authenticated context. */
1100
+ organization_id?: string | null;
1101
+ /** Optional associated project selected by the caller. */
1102
+ project_id?: string | null;
1103
+ /** Optional associated task selected by the caller. */
1104
+ task_id?: string | null;
1105
+ /** Stable application slug that initiated the request. */
1106
+ source_app?: string | null;
1107
+ /** Stable feature slug within the source application. */
1108
+ source_feature?: string | null;
1109
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
1110
+ initiation?: ("user" | "auto") | null;
1111
+ medium_id: string;
1112
+ force?: boolean;
1113
+ };
1114
+ /** WarmupProgress */
1115
+ type WarmupProgress = {
1116
+ day: number;
1117
+ total_days: number;
1118
+ daily_allowance: number;
1119
+ percent_complete: number;
1120
+ started_at?: string | null;
1121
+ completed_at?: string | null;
1122
+ };
1123
+ /** WaterfallResult */
1124
+ type WaterfallResult = {
1125
+ party_id: string;
1126
+ domain: string;
1127
+ steps?: WaterfallStep[];
1128
+ candidates?: ContactCandidateView[];
1129
+ personal_found?: number;
1130
+ stopped_because?: string;
1131
+ };
1132
+ /** One rung, recorded whether it ran, was skipped, or failed. Never silent. */
1133
+ type WaterfallStep = {
1134
+ provider: string;
1135
+ ran: boolean;
1136
+ from_cache?: boolean;
1137
+ found?: number;
1138
+ skipped_reason?: string | null;
1139
+ error?: string | null;
1140
+ };
1141
+ /** Answer to "may a campaign use this mailbox right now?" — the campaign-side */
1142
+ type aidream__services__sending_identity__models__ReadinessResponse = {
1143
+ identity_id: string;
1144
+ ready: boolean;
1145
+ refusal?: SendingRefusal | null;
1146
+ remaining_today?: number;
1147
+ remaining_this_hour?: number;
1148
+ };
1149
+ /** No fields. Resuming is a human act with no parameters — in particular */
1150
+ type aidream__services__sending_identity__models__ResumeRequest = {
1151
+ /** Organization context for the request; omitted to use the authenticated context. */
1152
+ organization_id?: string | null;
1153
+ /** Optional associated project selected by the caller. */
1154
+ project_id?: string | null;
1155
+ /** Optional associated task selected by the caller. */
1156
+ task_id?: string | null;
1157
+ /** Stable application slug that initiated the request. */
1158
+ source_app?: string | null;
1159
+ /** Stable feature slug within the source application. */
1160
+ source_feature?: string | null;
1161
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
1162
+ initiation?: ("user" | "auto") | null;
1163
+ };
1164
+ type ListSendingIdentitiesArgs = {
1165
+ query?: {
1166
+ organization_id?: string | null;
1167
+ purpose?: "outreach" | "correspondence" | "all";
1168
+ };
1169
+ };
1170
+ type ListSendingIdentitiesResult = SendingIdentityView[];
1171
+ /** List Sending Identities */
1172
+ /** `GET /sending-identities` · aidream · auth user · org optional */
1173
+ declare function listSendingIdentities(api: Api, args?: ListSendingIdentitiesArgs, options?: CallOptions): Promise<ListSendingIdentitiesResult>;
1174
+ type CreateSendingIdentityArgs = {
1175
+ body: CreateSendingIdentityRequest;
1176
+ };
1177
+ type CreateSendingIdentityResult = SendingIdentityDetail;
1178
+ /** Create Sending Identity */
1179
+ /** `POST /sending-identities` · aidream · auth user · org required */
1180
+ declare function createSendingIdentity(api: Api, args: CreateSendingIdentityArgs, options?: CallOptions): Promise<CreateSendingIdentityResult>;
1181
+ type ListConnectableArgs = {
1182
+ query?: {
1183
+ organization_id?: string | null;
1184
+ };
1185
+ };
1186
+ type ListConnectableResult = ConnectableMailbox[];
1187
+ /** List Connectable */
1188
+ /** `GET /sending-identities/connectable` · aidream · auth user · org required */
1189
+ declare function listConnectable(api: Api, args?: ListConnectableArgs, options?: CallOptions): Promise<ListConnectableResult>;
1190
+ type GetSendingPolicyArgs = {
1191
+ query?: {
1192
+ organization_id?: string | null;
1193
+ };
1194
+ };
1195
+ type GetSendingPolicyResult = SendingPolicyView;
1196
+ /** Get Sending Policy */
1197
+ /** `GET /sending-identities/policy` · aidream · auth user · org required */
1198
+ declare function getSendingPolicy(api: Api, args?: GetSendingPolicyArgs, options?: CallOptions): Promise<GetSendingPolicyResult>;
1199
+ type SetSendingPolicyArgs = {
1200
+ body: SetPolicyRequest;
1201
+ };
1202
+ type SetSendingPolicyResult = SendingPolicyView;
1203
+ /** Set Sending Policy */
1204
+ /** `POST /sending-identities/policy` · aidream · auth user · org required */
1205
+ declare function setSendingPolicy(api: Api, args: SetSendingPolicyArgs, options?: CallOptions): Promise<SetSendingPolicyResult>;
1206
+ type GetBringUpReadinessArgs = {
1207
+ query?: {
1208
+ organization_id?: string | null;
1209
+ };
1210
+ };
1211
+ type GetBringUpReadinessResult = BringUpReadiness;
1212
+ /** Get Bring Up Readiness */
1213
+ /** `GET /sending-identities/bring-up-readiness` · aidream · auth user · org required */
1214
+ declare function getBringUpReadiness(api: Api, args?: GetBringUpReadinessArgs, options?: CallOptions): Promise<GetBringUpReadinessResult>;
1215
+ type GetSendingIdentityArgs = {
1216
+ path: {
1217
+ identity_id: string;
1218
+ };
1219
+ };
1220
+ type GetSendingIdentityResult = SendingIdentityDetail;
1221
+ /** Get Sending Identity */
1222
+ /** `GET /sending-identities/{identity_id}` · aidream · auth user · org optional */
1223
+ declare function getSendingIdentity(api: Api, args: GetSendingIdentityArgs, options?: CallOptions): Promise<GetSendingIdentityResult>;
1224
+ type UpdateSendingIdentityArgs = {
1225
+ path: {
1226
+ identity_id: string;
1227
+ };
1228
+ body: UpdateSendingIdentityRequest;
1229
+ };
1230
+ type UpdateSendingIdentityResult = SendingIdentityDetail;
1231
+ /** Update Sending Identity */
1232
+ /** `PATCH /sending-identities/{identity_id}` · aidream · auth user · org required */
1233
+ declare function updateSendingIdentity(api: Api, args: UpdateSendingIdentityArgs, options?: CallOptions): Promise<UpdateSendingIdentityResult>;
1234
+ type DisableSendingIdentityArgs = {
1235
+ path: {
1236
+ identity_id: string;
1237
+ };
1238
+ };
1239
+ type DisableSendingIdentityResult = void;
1240
+ /** Disable Sending Identity */
1241
+ /** `DELETE /sending-identities/{identity_id}` · aidream · auth user · org required */
1242
+ declare function disableSendingIdentity(api: Api, args: DisableSendingIdentityArgs, options?: CallOptions): Promise<DisableSendingIdentityResult>;
1243
+ type CheckDomainArgs = {
1244
+ path: {
1245
+ identity_id: string;
1246
+ };
1247
+ };
1248
+ type CheckDomainResult = CheckReport;
1249
+ /** Check Domain */
1250
+ /** `POST /sending-identities/{identity_id}/check-domain` · aidream · auth user · org required */
1251
+ declare function checkDomain(api: Api, args: CheckDomainArgs, options?: CallOptions): Promise<CheckDomainResult>;
1252
+ type CheckAuthenticationArgs = {
1253
+ path: {
1254
+ identity_id: string;
1255
+ };
1256
+ };
1257
+ type CheckAuthenticationResult = CheckReport;
1258
+ /** Check Authentication */
1259
+ /** `POST /sending-identities/{identity_id}/check-authentication` · aidream · auth user · org required */
1260
+ declare function checkAuthentication(api: Api, args: CheckAuthenticationArgs, options?: CallOptions): Promise<CheckAuthenticationResult>;
1261
+ type StartIdentityWarmupArgs = {
1262
+ path: {
1263
+ identity_id: string;
1264
+ };
1265
+ };
1266
+ type StartIdentityWarmupResult = SendingIdentityDetail;
1267
+ /** Start Identity Warmup */
1268
+ /** `POST /sending-identities/{identity_id}/start-warmup` · aidream · auth user · org required */
1269
+ declare function startIdentityWarmup(api: Api, args: StartIdentityWarmupArgs, options?: CallOptions): Promise<StartIdentityWarmupResult>;
1270
+ type PauseSendingIdentityArgs = {
1271
+ path: {
1272
+ identity_id: string;
1273
+ };
1274
+ body: PauseRequest;
1275
+ };
1276
+ type PauseSendingIdentityResult = SendingIdentityDetail;
1277
+ /** Pause Sending Identity */
1278
+ /** `POST /sending-identities/{identity_id}/pause` · aidream · auth user · org required */
1279
+ declare function pauseSendingIdentity(api: Api, args: PauseSendingIdentityArgs, options?: CallOptions): Promise<PauseSendingIdentityResult>;
1280
+ type ResumeSendingIdentityArgs = {
1281
+ path: {
1282
+ identity_id: string;
1283
+ };
1284
+ body: aidream__services__sending_identity__models__ResumeRequest;
1285
+ };
1286
+ type ResumeSendingIdentityResult = SendingIdentityDetail;
1287
+ /** Resume Sending Identity */
1288
+ /** `POST /sending-identities/{identity_id}/resume` · aidream · auth user · org required */
1289
+ declare function resumeSendingIdentity(api: Api, args: ResumeSendingIdentityArgs, options?: CallOptions): Promise<ResumeSendingIdentityResult>;
1290
+ type GetReadinessArgs = {
1291
+ path: {
1292
+ identity_id: string;
1293
+ };
1294
+ };
1295
+ type GetReadinessResult = aidream__services__sending_identity__models__ReadinessResponse;
1296
+ /** Get Readiness */
1297
+ /** `GET /sending-identities/{identity_id}/readiness` · aidream · auth user · org optional */
1298
+ declare function getReadiness(api: Api, args: GetReadinessArgs, options?: CallOptions): Promise<GetReadinessResult>;
1299
+ type ListSendingEventsArgs = {
1300
+ path: {
1301
+ identity_id: string;
1302
+ };
1303
+ query?: {
1304
+ limit?: number;
1305
+ };
1306
+ };
1307
+ type ListSendingEventsResult = SendingEventRecord[];
1308
+ /** List Sending Events */
1309
+ /** `GET /sending-identities/{identity_id}/events` · aidream · auth user · org optional */
1310
+ declare function listSendingEvents(api: Api, args: ListSendingEventsArgs, options?: CallOptions): Promise<ListSendingEventsResult>;
1311
+ type RefreshIdentityHealthArgs = {
1312
+ path: {
1313
+ identity_id: string;
1314
+ };
1315
+ };
1316
+ type RefreshIdentityHealthResult = SendingIdentityDetail;
1317
+ /** Refresh Identity Health */
1318
+ /** `POST /sending-identities/{identity_id}/refresh-health` · aidream · auth user · org required */
1319
+ declare function refreshIdentityHealth(api: Api, args: RefreshIdentityHealthArgs, options?: CallOptions): Promise<RefreshIdentityHealthResult>;
1320
+ type ListOutletContactCandidatesArgs = {
1321
+ path: {
1322
+ outlet_party_id: string;
1323
+ };
1324
+ };
1325
+ type ListOutletContactCandidatesResult = OutletContactExtraction;
1326
+ /** List Outlet Contact Candidates */
1327
+ /** `GET /crm/parties/{outlet_party_id}/contact-candidates` · aidream · auth guest · org optional */
1328
+ declare function listOutletContactCandidates(api: Api, args: ListOutletContactCandidatesArgs, options?: CallOptions): Promise<ListOutletContactCandidatesResult>;
1329
+ type ConfirmOutletContactCandidateArgs = {
1330
+ path: {
1331
+ outlet_party_id: string;
1332
+ };
1333
+ body: ConfirmOutletContactRequest;
1334
+ };
1335
+ type ConfirmOutletContactCandidateResult = ConfirmedOutletContact;
1336
+ /** Confirm Outlet Contact Candidate */
1337
+ /** `POST /crm/parties/{outlet_party_id}/contact-candidates/confirm` · aidream · auth guest · org required */
1338
+ declare function confirmOutletContactCandidate(api: Api, args: ConfirmOutletContactCandidateArgs, options?: CallOptions): Promise<ConfirmOutletContactCandidateResult>;
1339
+ type ListPartyContactCandidatesArgs = {
1340
+ path: {
1341
+ party_id: string;
1342
+ };
1343
+ query?: {
1344
+ include_resolved?: boolean;
1345
+ };
1346
+ };
1347
+ type ListPartyContactCandidatesResult = ContactCandidateView[];
1348
+ /** List Party Contact Candidates */
1349
+ /** `GET /crm/parties/{party_id}/contacts` · aidream · auth guest · org optional */
1350
+ declare function listPartyContactCandidates(api: Api, args: ListPartyContactCandidatesArgs, options?: CallOptions): Promise<ListPartyContactCandidatesResult>;
1351
+ type FindPartyContactsArgs = {
1352
+ path: {
1353
+ party_id: string;
1354
+ };
1355
+ body: FindContactsRequest;
1356
+ };
1357
+ type FindPartyContactsResult = WaterfallResult;
1358
+ /** Find Party Contacts */
1359
+ /** `POST /crm/parties/{party_id}/contacts/find` · aidream · auth guest · org required */
1360
+ declare function findPartyContacts(api: Api, args: FindPartyContactsArgs, options?: CallOptions): Promise<FindPartyContactsResult>;
1361
+ type ConfirmPartyContactCandidateArgs = {
1362
+ path: {
1363
+ party_id: string;
1364
+ candidate_id: string;
1365
+ };
1366
+ body: ConfirmCandidateRequest;
1367
+ };
1368
+ type ConfirmPartyContactCandidateResult = ContactCandidateView;
1369
+ /** Confirm Party Contact Candidate */
1370
+ /** `POST /crm/parties/{party_id}/contacts/{candidate_id}/confirm` · aidream · auth guest · org required */
1371
+ declare function confirmPartyContactCandidate(api: Api, args: ConfirmPartyContactCandidateArgs, options?: CallOptions): Promise<ConfirmPartyContactCandidateResult>;
1372
+ type RejectPartyContactCandidateArgs = {
1373
+ path: {
1374
+ party_id: string;
1375
+ candidate_id: string;
1376
+ };
1377
+ body: RejectCandidateRequest;
1378
+ };
1379
+ type RejectPartyContactCandidateResult = ContactCandidateView;
1380
+ /** Reject Party Contact Candidate */
1381
+ /** `POST /crm/parties/{party_id}/contacts/{candidate_id}/reject` · aidream · auth guest · org required */
1382
+ declare function rejectPartyContactCandidate(api: Api, args: RejectPartyContactCandidateArgs, options?: CallOptions): Promise<RejectPartyContactCandidateResult>;
1383
+ type VerifyPartyContactAddressArgs = {
1384
+ path: {
1385
+ party_id: string;
1386
+ };
1387
+ body: VerifyAddressRequest;
1388
+ };
1389
+ type VerifyPartyContactAddressResult = FinalMileResult;
1390
+ /** Verify Party Contact Address */
1391
+ /** `POST /crm/parties/{party_id}/contacts/verify` · aidream · auth guest · org required */
1392
+ declare function verifyPartyContactAddress(api: Api, args: VerifyPartyContactAddressArgs, options?: CallOptions): Promise<VerifyPartyContactAddressResult>;
1393
+ type CheckPartyJournalistActivityArgs = {
1394
+ path: {
1395
+ party_id: string;
1396
+ };
1397
+ body: JournalistActivityRequest;
1398
+ };
1399
+ type CheckPartyJournalistActivityResult = ActivityVerdict;
1400
+ /** Check Party Journalist Activity */
1401
+ /** `POST /crm/parties/{party_id}/journalist-activity` · aidream · auth guest · org required */
1402
+ declare function checkPartyJournalistActivity(api: Api, args: CheckPartyJournalistActivityArgs, options?: CallOptions): Promise<CheckPartyJournalistActivityResult>;
1403
+ type ReadPartyJournalistBeatArgs = {
1404
+ path: {
1405
+ party_id: string;
1406
+ };
1407
+ };
1408
+ type ReadPartyJournalistBeatResult = BeatProfile | null;
1409
+ /** Read Party Journalist Beat */
1410
+ /** `GET /crm/parties/{party_id}/journalist-beat` · aidream · auth guest · org optional */
1411
+ declare function readPartyJournalistBeat(api: Api, args: ReadPartyJournalistBeatArgs, options?: CallOptions): Promise<ReadPartyJournalistBeatResult>;
1412
+ type DerivePartyJournalistBeatArgs = {
1413
+ path: {
1414
+ party_id: string;
1415
+ };
1416
+ body: JournalistBeatRequest;
1417
+ };
1418
+ type DerivePartyJournalistBeatResult = BeatProfile;
1419
+ /** Derive Party Journalist Beat */
1420
+ /** `POST /crm/parties/{party_id}/journalist-beat` · aidream · auth guest · org required */
1421
+ declare function derivePartyJournalistBeat(api: Api, args: DerivePartyJournalistBeatArgs, options?: CallOptions): Promise<DerivePartyJournalistBeatResult>;
1422
+ type RefreshMediaListDoorArgs = {
1423
+ path: {
1424
+ list_id: string;
1425
+ };
1426
+ body: MediaListRefreshRequest;
1427
+ };
1428
+ type RefreshMediaListDoorResult = MediaListRefreshResult;
1429
+ /** Refresh Media List Door */
1430
+ /** `POST /crm/outreach-lists/{list_id}/media-refresh` · aidream · auth guest · org required */
1431
+ declare function refreshMediaListDoor(api: Api, args: RefreshMediaListDoorArgs, options?: CallOptions): Promise<RefreshMediaListDoorResult>;
1432
+ type SetMediaRefreshPolicyDoorArgs = {
1433
+ path: {
1434
+ list_id: string;
1435
+ };
1436
+ body: MediaRefreshPolicy;
1437
+ };
1438
+ type SetMediaRefreshPolicyDoorResult = MediaRefreshPolicy;
1439
+ /** Set Media Refresh Policy Door */
1440
+ /** `PUT /crm/outreach-lists/{list_id}/media-refresh-policy` · aidream · auth guest · org required */
1441
+ declare function setMediaRefreshPolicyDoor(api: Api, args: SetMediaRefreshPolicyDoorArgs, options?: CallOptions): Promise<SetMediaRefreshPolicyDoorResult>;
1442
+ type MediaListSearchDoorArgs = {
1443
+ path: {
1444
+ list_id: string;
1445
+ };
1446
+ body: MediaListSearchRequest;
1447
+ };
1448
+ type MediaListSearchDoorResult = MediaListSearchResult;
1449
+ /** Media List Search Door */
1450
+ /** `POST /crm/outreach-lists/{list_id}/media-search` · aidream · auth guest · org required */
1451
+ declare function mediaListSearchDoor(api: Api, args: MediaListSearchDoorArgs, options?: CallOptions): Promise<MediaListSearchDoorResult>;
1452
+ type MediaResearchPreviewDoorArgs = {
1453
+ path: {
1454
+ list_id: string;
1455
+ };
1456
+ body: MediaResearchPreviewRequest;
1457
+ };
1458
+ type MediaResearchPreviewDoorResult = MediaResearchPreview;
1459
+ /** Media Research Preview Door */
1460
+ /** `POST /crm/outreach-lists/{list_id}/media-research/preview` · aidream · auth guest · org required */
1461
+ declare function mediaResearchPreviewDoor(api: Api, args: MediaResearchPreviewDoorArgs, options?: CallOptions): Promise<MediaResearchPreviewDoorResult>;
1462
+ type MediaResearchRunDoorArgs = {
1463
+ path: {
1464
+ list_id: string;
1465
+ };
1466
+ body: MediaResearchRunBody;
1467
+ };
1468
+ type MediaResearchRunDoorResult = unknown;
1469
+ /** Media Research Run Door */
1470
+ /** `POST /crm/outreach-lists/{list_id}/media-research/run` · aidream · auth guest · org required · ndjson */
1471
+ declare function mediaResearchRunDoor(api: Api, args: MediaResearchRunDoorArgs, options?: CallOptions): Promise<ApiStream<NdjsonEvent>>;
1472
+ type PreviewBulkEnrichmentArgs = {
1473
+ body: BulkEnrichmentRequest;
1474
+ };
1475
+ type PreviewBulkEnrichmentResult = BulkPreview;
1476
+ /** Preview Bulk Enrichment */
1477
+ /** `POST /crm/enrichment/bulk/preview` · aidream · auth guest · org required */
1478
+ declare function previewBulkEnrichment(api: Api, args: PreviewBulkEnrichmentArgs, options?: CallOptions): Promise<PreviewBulkEnrichmentResult>;
1479
+ type RunBulkEnrichmentDoorArgs = {
1480
+ body: BulkEnrichmentRequest;
1481
+ };
1482
+ type RunBulkEnrichmentDoorResult = BulkReport;
1483
+ /** Run Bulk Enrichment Door */
1484
+ /** `POST /crm/enrichment/bulk/run` · aidream · auth guest · org required */
1485
+ declare function runBulkEnrichmentDoor(api: Api, args: RunBulkEnrichmentDoorArgs, options?: CallOptions): Promise<RunBulkEnrichmentDoorResult>;
1486
+ type ResolvePartyDoorArgs = {
1487
+ body: ResolvePartyRequest;
1488
+ };
1489
+ type ResolvePartyDoorResult = ResolvedPartyView;
1490
+ /** Resolve Party Door */
1491
+ /** `POST /crm/parties/resolve` · aidream · auth guest · org required */
1492
+ declare function resolvePartyDoor(api: Api, args: ResolvePartyDoorArgs, options?: CallOptions): Promise<ResolvePartyDoorResult>;
1493
+ type ResolvePartiesBatchDoorArgs = {
1494
+ body: ResolvePartyBatchRequest;
1495
+ };
1496
+ type ResolvePartiesBatchDoorResult = ResolvedPartyBatchItem[];
1497
+ /** Resolve Parties Batch Door */
1498
+ /** `POST /crm/parties/resolve-batch` · aidream · auth guest · org required */
1499
+ declare function resolvePartiesBatchDoor(api: Api, args: ResolvePartiesBatchDoorArgs, options?: CallOptions): Promise<ResolvePartiesBatchDoorResult>;
1500
+ type ListImportConnectorsArgs = {
1501
+ query?: {
1502
+ organization_id?: string | null;
1503
+ };
1504
+ };
1505
+ type ListImportConnectorsResult = ImportConnectorView[];
1506
+ /** List Import Connectors */
1507
+ /** `GET /crm/import/connectors` · aidream · auth guest · org required */
1508
+ declare function listImportConnectors(api: Api, args?: ListImportConnectorsArgs, options?: CallOptions): Promise<ListImportConnectorsResult>;
1509
+ type FetchConnectorContactsArgs = {
1510
+ path: {
1511
+ provider_key: string;
1512
+ };
1513
+ body: ConnectorFetchRequest;
1514
+ };
1515
+ type FetchConnectorContactsResult = ConnectorFetchResponse;
1516
+ /** Fetch Connector Contacts */
1517
+ /** `POST /crm/import/connectors/{provider_key}/fetch` · aidream · auth guest · org required */
1518
+ declare function fetchConnectorContacts(api: Api, args: FetchConnectorContactsArgs, options?: CallOptions): Promise<FetchConnectorContactsResult>;
1519
+ type PersistConnectorCursorArgs = {
1520
+ path: {
1521
+ provider_key: string;
1522
+ };
1523
+ body: ConnectorCursorRequest;
1524
+ };
1525
+ type PersistConnectorCursorResult = ConnectorCursorResponse;
1526
+ /** Persist Connector Cursor */
1527
+ /** `POST /crm/import/connectors/{provider_key}/cursor` · aidream · auth guest · org required */
1528
+ declare function persistConnectorCursor(api: Api, args: PersistConnectorCursorArgs, options?: CallOptions): Promise<PersistConnectorCursorResult>;
1529
+ type QueuePartyKindResolutionArgs = {
1530
+ body: PartyKindBatchRequest;
1531
+ };
1532
+ type QueuePartyKindResolutionResult = KindSubmitSummary;
1533
+ /** Queue Party Kind Resolution */
1534
+ /** `POST /crm/parties/kind-resolution/batch` · aidream · auth guest · org required */
1535
+ declare function queuePartyKindResolution(api: Api, args: QueuePartyKindResolutionArgs, options?: CallOptions): Promise<QueuePartyKindResolutionResult>;
1536
+ type CheckPitchAdvisoriesDoorArgs = {
1537
+ body: PitchAdvisoryRequest;
1538
+ };
1539
+ type CheckPitchAdvisoriesDoorResult = PitchAdvisoryReport;
1540
+ /** Check Pitch Advisories Door */
1541
+ /** `POST /crm/pitch-advisories` · aidream · auth guest · org required */
1542
+ declare function checkPitchAdvisoriesDoor(api: Api, args: CheckPitchAdvisoriesDoorArgs, options?: CallOptions): Promise<CheckPitchAdvisoriesDoorResult>;
1543
+ type OnePerOutletDoorArgs = {
1544
+ body: PitchAdvisoryRequest;
1545
+ };
1546
+ type OnePerOutletDoorResult = PitchAdvisory[];
1547
+ /** One Per Outlet Door */
1548
+ /** `POST /crm/pitch-advisories/one-per-outlet` · aidream · auth guest · org required */
1549
+ declare function onePerOutletDoor(api: Api, args: OnePerOutletDoorArgs, options?: CallOptions): Promise<OnePerOutletDoorResult>;
1550
+ type PreSendCheckDoorArgs = {
1551
+ body: PreSendCheckDoorRequest;
1552
+ };
1553
+ type PreSendCheckDoorResult = PreSendCheckReport;
1554
+ /** Pre Send Check Door */
1555
+ /** `POST /crm/pre-send-check` · aidream · auth guest · org required */
1556
+ declare function preSendCheckDoor(api: Api, args: PreSendCheckDoorArgs, options?: CallOptions): Promise<PreSendCheckDoorResult>;
1557
+ /** Every JSON operation of this domain by `METHOD path` — for path-keyed calls. */
1558
+ interface Operations {
1559
+ "GET /sending-identities": {
1560
+ args: ListSendingIdentitiesArgs;
1561
+ result: ListSendingIdentitiesResult;
1562
+ };
1563
+ "POST /sending-identities": {
1564
+ args: CreateSendingIdentityArgs;
1565
+ result: CreateSendingIdentityResult;
1566
+ };
1567
+ "GET /sending-identities/connectable": {
1568
+ args: ListConnectableArgs;
1569
+ result: ListConnectableResult;
1570
+ };
1571
+ "GET /sending-identities/policy": {
1572
+ args: GetSendingPolicyArgs;
1573
+ result: GetSendingPolicyResult;
1574
+ };
1575
+ "POST /sending-identities/policy": {
1576
+ args: SetSendingPolicyArgs;
1577
+ result: SetSendingPolicyResult;
1578
+ };
1579
+ "GET /sending-identities/bring-up-readiness": {
1580
+ args: GetBringUpReadinessArgs;
1581
+ result: GetBringUpReadinessResult;
1582
+ };
1583
+ "GET /sending-identities/{identity_id}": {
1584
+ args: GetSendingIdentityArgs;
1585
+ result: GetSendingIdentityResult;
1586
+ };
1587
+ "PATCH /sending-identities/{identity_id}": {
1588
+ args: UpdateSendingIdentityArgs;
1589
+ result: UpdateSendingIdentityResult;
1590
+ };
1591
+ "DELETE /sending-identities/{identity_id}": {
1592
+ args: DisableSendingIdentityArgs;
1593
+ result: DisableSendingIdentityResult;
1594
+ };
1595
+ "POST /sending-identities/{identity_id}/check-domain": {
1596
+ args: CheckDomainArgs;
1597
+ result: CheckDomainResult;
1598
+ };
1599
+ "POST /sending-identities/{identity_id}/check-authentication": {
1600
+ args: CheckAuthenticationArgs;
1601
+ result: CheckAuthenticationResult;
1602
+ };
1603
+ "POST /sending-identities/{identity_id}/start-warmup": {
1604
+ args: StartIdentityWarmupArgs;
1605
+ result: StartIdentityWarmupResult;
1606
+ };
1607
+ "POST /sending-identities/{identity_id}/pause": {
1608
+ args: PauseSendingIdentityArgs;
1609
+ result: PauseSendingIdentityResult;
1610
+ };
1611
+ "POST /sending-identities/{identity_id}/resume": {
1612
+ args: ResumeSendingIdentityArgs;
1613
+ result: ResumeSendingIdentityResult;
1614
+ };
1615
+ "GET /sending-identities/{identity_id}/readiness": {
1616
+ args: GetReadinessArgs;
1617
+ result: GetReadinessResult;
1618
+ };
1619
+ "GET /sending-identities/{identity_id}/events": {
1620
+ args: ListSendingEventsArgs;
1621
+ result: ListSendingEventsResult;
1622
+ };
1623
+ "POST /sending-identities/{identity_id}/refresh-health": {
1624
+ args: RefreshIdentityHealthArgs;
1625
+ result: RefreshIdentityHealthResult;
1626
+ };
1627
+ "GET /crm/parties/{outlet_party_id}/contact-candidates": {
1628
+ args: ListOutletContactCandidatesArgs;
1629
+ result: ListOutletContactCandidatesResult;
1630
+ };
1631
+ "POST /crm/parties/{outlet_party_id}/contact-candidates/confirm": {
1632
+ args: ConfirmOutletContactCandidateArgs;
1633
+ result: ConfirmOutletContactCandidateResult;
1634
+ };
1635
+ "GET /crm/parties/{party_id}/contacts": {
1636
+ args: ListPartyContactCandidatesArgs;
1637
+ result: ListPartyContactCandidatesResult;
1638
+ };
1639
+ "POST /crm/parties/{party_id}/contacts/find": {
1640
+ args: FindPartyContactsArgs;
1641
+ result: FindPartyContactsResult;
1642
+ };
1643
+ "POST /crm/parties/{party_id}/contacts/{candidate_id}/confirm": {
1644
+ args: ConfirmPartyContactCandidateArgs;
1645
+ result: ConfirmPartyContactCandidateResult;
1646
+ };
1647
+ "POST /crm/parties/{party_id}/contacts/{candidate_id}/reject": {
1648
+ args: RejectPartyContactCandidateArgs;
1649
+ result: RejectPartyContactCandidateResult;
1650
+ };
1651
+ "POST /crm/parties/{party_id}/contacts/verify": {
1652
+ args: VerifyPartyContactAddressArgs;
1653
+ result: VerifyPartyContactAddressResult;
1654
+ };
1655
+ "POST /crm/parties/{party_id}/journalist-activity": {
1656
+ args: CheckPartyJournalistActivityArgs;
1657
+ result: CheckPartyJournalistActivityResult;
1658
+ };
1659
+ "GET /crm/parties/{party_id}/journalist-beat": {
1660
+ args: ReadPartyJournalistBeatArgs;
1661
+ result: ReadPartyJournalistBeatResult;
1662
+ };
1663
+ "POST /crm/parties/{party_id}/journalist-beat": {
1664
+ args: DerivePartyJournalistBeatArgs;
1665
+ result: DerivePartyJournalistBeatResult;
1666
+ };
1667
+ "POST /crm/outreach-lists/{list_id}/media-refresh": {
1668
+ args: RefreshMediaListDoorArgs;
1669
+ result: RefreshMediaListDoorResult;
1670
+ };
1671
+ "PUT /crm/outreach-lists/{list_id}/media-refresh-policy": {
1672
+ args: SetMediaRefreshPolicyDoorArgs;
1673
+ result: SetMediaRefreshPolicyDoorResult;
1674
+ };
1675
+ "POST /crm/outreach-lists/{list_id}/media-search": {
1676
+ args: MediaListSearchDoorArgs;
1677
+ result: MediaListSearchDoorResult;
1678
+ };
1679
+ "POST /crm/outreach-lists/{list_id}/media-research/preview": {
1680
+ args: MediaResearchPreviewDoorArgs;
1681
+ result: MediaResearchPreviewDoorResult;
1682
+ };
1683
+ "POST /crm/enrichment/bulk/preview": {
1684
+ args: PreviewBulkEnrichmentArgs;
1685
+ result: PreviewBulkEnrichmentResult;
1686
+ };
1687
+ "POST /crm/enrichment/bulk/run": {
1688
+ args: RunBulkEnrichmentDoorArgs;
1689
+ result: RunBulkEnrichmentDoorResult;
1690
+ };
1691
+ "POST /crm/parties/resolve": {
1692
+ args: ResolvePartyDoorArgs;
1693
+ result: ResolvePartyDoorResult;
1694
+ };
1695
+ "POST /crm/parties/resolve-batch": {
1696
+ args: ResolvePartiesBatchDoorArgs;
1697
+ result: ResolvePartiesBatchDoorResult;
1698
+ };
1699
+ "GET /crm/import/connectors": {
1700
+ args: ListImportConnectorsArgs;
1701
+ result: ListImportConnectorsResult;
1702
+ };
1703
+ "POST /crm/import/connectors/{provider_key}/fetch": {
1704
+ args: FetchConnectorContactsArgs;
1705
+ result: FetchConnectorContactsResult;
1706
+ };
1707
+ "POST /crm/import/connectors/{provider_key}/cursor": {
1708
+ args: PersistConnectorCursorArgs;
1709
+ result: PersistConnectorCursorResult;
1710
+ };
1711
+ "POST /crm/parties/kind-resolution/batch": {
1712
+ args: QueuePartyKindResolutionArgs;
1713
+ result: QueuePartyKindResolutionResult;
1714
+ };
1715
+ "POST /crm/pitch-advisories": {
1716
+ args: CheckPitchAdvisoriesDoorArgs;
1717
+ result: CheckPitchAdvisoriesDoorResult;
1718
+ };
1719
+ "POST /crm/pitch-advisories/one-per-outlet": {
1720
+ args: OnePerOutletDoorArgs;
1721
+ result: OnePerOutletDoorResult;
1722
+ };
1723
+ "POST /crm/pre-send-check": {
1724
+ args: PreSendCheckDoorArgs;
1725
+ result: PreSendCheckDoorResult;
1726
+ };
1727
+ }
1728
+ /** Path-keyed call, scoped to this domain only (never a global path map). */
1729
+ declare function call<K extends keyof Operations>(api: Api, key: K, args?: Operations[K]["args"], options?: CallOptions): Promise<Operations[K]["result"]>;
1730
+
1731
+ export { type ActivityEvidence, type ActivityVerdict, type AdvisoryOffer, type BeatProfile, type BringUpReadiness, type BulkEnrichmentRequest, type BulkPreview, type BulkReport, type BulkRow, type BulkRowResult, type CheckAuthenticationArgs, type CheckAuthenticationResult, type CheckDomainArgs, type CheckDomainResult, type CheckPartyJournalistActivityArgs, type CheckPartyJournalistActivityResult, type CheckPitchAdvisoriesDoorArgs, type CheckPitchAdvisoriesDoorResult, type CheckRecord, type CheckReport, type ConfirmCandidateRequest, type ConfirmOutletContactCandidateArgs, type ConfirmOutletContactCandidateResult, type ConfirmOutletContactRequest, type ConfirmPartyContactCandidateArgs, type ConfirmPartyContactCandidateResult, type ConfirmedOutletContact, type ConnectableMailbox, type ConnectorContactView, type ConnectorCursorRequest, type ConnectorCursorResponse, type ConnectorFetchRequest, type ConnectorFetchResponse, type ContactCandidateView, type ContactEvidence, type CreateSendingIdentityArgs, type CreateSendingIdentityRequest, type CreateSendingIdentityResult, type CritiqueResult, type DerivePartyJournalistBeatArgs, type DerivePartyJournalistBeatResult, type DisableSendingIdentityArgs, type DisableSendingIdentityResult, type DnsRecordSpec, type FactCheckResult, type FetchConnectorContactsArgs, type FetchConnectorContactsResult, type FinalMileResult, type FindContactsRequest, type FindPartyContactsArgs, type FindPartyContactsResult, type GetBringUpReadinessArgs, type GetBringUpReadinessResult, type GetReadinessArgs, type GetReadinessResult, type GetSendingIdentityArgs, type GetSendingIdentityResult, type GetSendingPolicyArgs, type GetSendingPolicyResult, type IdentityHealth, type ImportConnectorConnectionView, type ImportConnectorView, type JournalistActivityRequest, type JournalistBeatRequest, type KindSubmitSummary, type ListConnectableArgs, type ListConnectableResult, type ListImportConnectorsArgs, type ListImportConnectorsResult, type ListOutletContactCandidatesArgs, type ListOutletContactCandidatesResult, type ListPartyContactCandidatesArgs, type ListPartyContactCandidatesResult, type ListSendingEventsArgs, type ListSendingEventsResult, type ListSendingIdentitiesArgs, type ListSendingIdentitiesResult, type MediaListProspect, type MediaListRefreshRequest, type MediaListRefreshResult, type MediaListSearchDoorArgs, type MediaListSearchDoorResult, type MediaListSearchRequest, type MediaListSearchResult, type MediaRefreshPolicy, type MediaResearchCost, type MediaResearchPreview, type MediaResearchPreviewDoorArgs, type MediaResearchPreviewDoorResult, type MediaResearchPreviewRequest, type MediaResearchPriorRun, type MediaResearchRequest, type MediaResearchRunBody, type MediaResearchRunDoorArgs, type MediaResearchRunDoorResult, type MediaResearchRunRequest, type MemberRefresh, type ObservedEmailCandidate, type OnePerOutletDoorArgs, type OnePerOutletDoorResult, type Operations, type OutletContactCandidate, type OutletContactExtraction, type OutletGroup, type PartStatus, type PartyKindBatchRequest, type PauseRequest, type PauseSendingIdentityArgs, type PauseSendingIdentityResult, type PersistConnectorCursorArgs, type PersistConnectorCursorResult, type PitchAdvisory, type PitchAdvisoryReport, type PitchAdvisoryRequest, type PreSendCheckDoorArgs, type PreSendCheckDoorRequest, type PreSendCheckDoorResult, type PreSendCheckReport, type PreviewBulkEnrichmentArgs, type PreviewBulkEnrichmentResult, type QueuePartyKindResolutionArgs, type QueuePartyKindResolutionResult, type ReadPartyJournalistBeatArgs, type ReadPartyJournalistBeatResult, type RecipientFit, type RefreshIdentityHealthArgs, type RefreshIdentityHealthResult, type RefreshMediaListDoorArgs, type RefreshMediaListDoorResult, type RejectCandidateRequest, type RejectPartyContactCandidateArgs, type RejectPartyContactCandidateResult, type ResolvePartiesBatchDoorArgs, type ResolvePartiesBatchDoorResult, type ResolvePartyBatchRequest, type ResolvePartyDoorArgs, type ResolvePartyDoorResult, type ResolvePartyExternalRef, type ResolvePartyRequest, type ResolvedPartyBatchItem, type ResolvedPartyView, type ResumeSendingIdentityArgs, type ResumeSendingIdentityResult, type RunBulkEnrichmentDoorArgs, type RunBulkEnrichmentDoorResult, type SendingEventRecord, type SendingIdentityDetail, type SendingIdentityView, type SendingPolicyView, type SendingRefusal, type SetMediaRefreshPolicyDoorArgs, type SetMediaRefreshPolicyDoorResult, type SetPolicyRequest, type SetSendingPolicyArgs, type SetSendingPolicyResult, type StartIdentityWarmupArgs, type StartIdentityWarmupResult, type UpdateSendingIdentityArgs, type UpdateSendingIdentityRequest, type UpdateSendingIdentityResult, type VerifyAddressRequest, type VerifyPartyContactAddressArgs, type VerifyPartyContactAddressResult, type WarmupProgress, type WaterfallResult, type WaterfallStep, type aidream__services__sending_identity__models__ReadinessResponse, type aidream__services__sending_identity__models__ResumeRequest, call, checkAuthentication, checkDomain, checkPartyJournalistActivity, checkPitchAdvisoriesDoor, confirmOutletContactCandidate, confirmPartyContactCandidate, createSendingIdentity, derivePartyJournalistBeat, disableSendingIdentity, fetchConnectorContacts, findPartyContacts, getBringUpReadiness, getReadiness, getSendingIdentity, getSendingPolicy, listConnectable, listImportConnectors, listOutletContactCandidates, listPartyContactCandidates, listSendingEvents, listSendingIdentities, mediaListSearchDoor, mediaResearchPreviewDoor, mediaResearchRunDoor, onePerOutletDoor, pauseSendingIdentity, persistConnectorCursor, preSendCheckDoor, previewBulkEnrichment, queuePartyKindResolution, readPartyJournalistBeat, refreshIdentityHealth, refreshMediaListDoor, rejectPartyContactCandidate, resolvePartiesBatchDoor, resolvePartyDoor, resumeSendingIdentity, runBulkEnrichmentDoor, setMediaRefreshPolicyDoor, setSendingPolicy, startIdentityWarmup, updateSendingIdentity, verifyPartyContactAddress };