@signaliz/sdk 1.0.67 → 1.0.68
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/README.md +76 -49
- package/dist/{chunk-4BUM5AVV.mjs → chunk-T5GL6QM7.mjs} +674 -288
- package/dist/index.d.mts +199 -176
- package/dist/index.d.ts +199 -176
- package/dist/index.js +674 -288
- package/dist/index.mjs +1 -1
- package/dist/mcp-config.js +674 -288
- package/dist/mcp-config.mjs +1 -1
- package/package.json +6 -6
package/dist/index.d.mts
CHANGED
|
@@ -6,6 +6,76 @@ interface SignalizConfig {
|
|
|
6
6
|
timeout?: number;
|
|
7
7
|
maxRetries?: number;
|
|
8
8
|
}
|
|
9
|
+
type SignalAwarenessAction = 'create' | 'list' | 'update' | 'delete' | 'manual_run' | 'list_signals' | 'bulk_import' | 'get_settings' | 'set_global_webhook' | 'test_webhook' | 'export' | 'send_signal_export';
|
|
10
|
+
interface SignalMonitorInput {
|
|
11
|
+
companyName: string;
|
|
12
|
+
domain: string;
|
|
13
|
+
template?: 'full_intelligence' | 'basic';
|
|
14
|
+
signalConfig?: Record<string, unknown>;
|
|
15
|
+
scheduleCron?: string;
|
|
16
|
+
webhookUrl?: string | null;
|
|
17
|
+
}
|
|
18
|
+
interface SignalAwarenessRequest {
|
|
19
|
+
action: SignalAwarenessAction;
|
|
20
|
+
monitorId?: string;
|
|
21
|
+
monitor?: SignalMonitorInput;
|
|
22
|
+
monitors?: SignalMonitorInput[];
|
|
23
|
+
defaults?: Record<string, unknown>;
|
|
24
|
+
updates?: Record<string, unknown>;
|
|
25
|
+
limit?: number;
|
|
26
|
+
offset?: number;
|
|
27
|
+
idempotencyKey?: string;
|
|
28
|
+
dryRun?: boolean;
|
|
29
|
+
}
|
|
30
|
+
interface SignalAwarenessMonitor {
|
|
31
|
+
id?: string;
|
|
32
|
+
company_name?: string;
|
|
33
|
+
domain?: string;
|
|
34
|
+
status?: string;
|
|
35
|
+
schedule?: string;
|
|
36
|
+
last_run_at?: string;
|
|
37
|
+
next_run_at?: string;
|
|
38
|
+
created_at?: string;
|
|
39
|
+
updated_at?: string;
|
|
40
|
+
}
|
|
41
|
+
interface SignalAwarenessRun {
|
|
42
|
+
id?: string;
|
|
43
|
+
monitor_id?: string;
|
|
44
|
+
status?: string;
|
|
45
|
+
signals_found?: number;
|
|
46
|
+
started_at?: string;
|
|
47
|
+
completed_at?: string;
|
|
48
|
+
created_at?: string;
|
|
49
|
+
}
|
|
50
|
+
/** The stable public signal row returned by every Signaliz signal surface. */
|
|
51
|
+
interface PublicSignalRow {
|
|
52
|
+
signal_type: string;
|
|
53
|
+
signal_title: string;
|
|
54
|
+
signal_summary: string;
|
|
55
|
+
source: string;
|
|
56
|
+
date: string;
|
|
57
|
+
company_name: string;
|
|
58
|
+
domain: string;
|
|
59
|
+
}
|
|
60
|
+
type SignalAwarenessSignal = PublicSignalRow;
|
|
61
|
+
interface SignalAwarenessResponse {
|
|
62
|
+
success: boolean;
|
|
63
|
+
monitors?: SignalAwarenessMonitor[];
|
|
64
|
+
monitor?: SignalAwarenessMonitor;
|
|
65
|
+
signals?: SignalAwarenessSignal[];
|
|
66
|
+
signalCount?: number;
|
|
67
|
+
monitorId?: string;
|
|
68
|
+
runId?: string;
|
|
69
|
+
run?: SignalAwarenessRun;
|
|
70
|
+
creditsUsed?: number;
|
|
71
|
+
created?: number;
|
|
72
|
+
skipped?: number;
|
|
73
|
+
total?: number;
|
|
74
|
+
limit?: number;
|
|
75
|
+
offset?: number;
|
|
76
|
+
hasMore?: boolean;
|
|
77
|
+
idempotentReplay?: boolean;
|
|
78
|
+
}
|
|
9
79
|
interface BatchOptions {
|
|
10
80
|
/** Maximum simultaneous API requests. Defaults to 10; allowed range is 1-50. */
|
|
11
81
|
concurrency?: number;
|
|
@@ -61,10 +131,6 @@ interface BatchItemResult<T> {
|
|
|
61
131
|
creditsUsed?: 0;
|
|
62
132
|
/** Present only when the server proves the failed row charged zero Signaliz credits. */
|
|
63
133
|
creditsCharged?: 0;
|
|
64
|
-
/** Present only when the server proves no live provider was called for the failed row. */
|
|
65
|
-
liveProviderCalled?: false;
|
|
66
|
-
/** Present only when the server proves the failed row had no external provider cost. */
|
|
67
|
-
estimatedExternalCostUsd?: 0;
|
|
68
134
|
/** Existing provider run that can be resumed without dispatching new work. */
|
|
69
135
|
runId?: string;
|
|
70
136
|
/** Existing Verify Email run that can be resumed without dispatching new work. */
|
|
@@ -76,8 +142,6 @@ interface BatchItemResult<T> {
|
|
|
76
142
|
doNotAutoResubmit?: boolean;
|
|
77
143
|
recoveryMode?: 'same_run';
|
|
78
144
|
recoveryStatus?: 'pending' | 'completed';
|
|
79
|
-
cachePublicationStatus?: 'completed' | 'pending' | 'pending_safe_retry' | 'superseded_by_newer_verdict';
|
|
80
|
-
cachePublicationRetryEligible?: boolean;
|
|
81
145
|
/** Zero-based input index containing the full result for this exact duplicate. */
|
|
82
146
|
duplicateOf?: number;
|
|
83
147
|
}
|
|
@@ -119,8 +183,8 @@ interface CoreProductDryRunResult {
|
|
|
119
183
|
}
|
|
120
184
|
interface FindEmailCommonParams {
|
|
121
185
|
companyName?: string;
|
|
122
|
-
/**
|
|
123
|
-
|
|
186
|
+
/** Set false to receive a durable run ID immediately and resume it without duplicate work or spend. */
|
|
187
|
+
waitForResult?: boolean;
|
|
124
188
|
/** Return a no-spend plan without provider calls or jobs. */
|
|
125
189
|
dryRun?: boolean;
|
|
126
190
|
/** Stable retry key for recovering the same request after an ambiguous response. */
|
|
@@ -182,25 +246,10 @@ interface FindEmailResult {
|
|
|
182
246
|
failureReason: string;
|
|
183
247
|
creditsUsed?: number;
|
|
184
248
|
creditsCharged?: number;
|
|
185
|
-
estimatedExternalCostUsd?: number;
|
|
186
|
-
billingMetadata?: Record<string, unknown>;
|
|
187
249
|
/** True when this response reuses the first request's billing receipt without charging again. */
|
|
188
250
|
billingReplayed?: boolean;
|
|
189
251
|
/** True when the public result came from a completed response-idempotency reservation. */
|
|
190
252
|
idempotencyReplayed?: boolean;
|
|
191
|
-
/** Original provider-work receipt when this response recovered a completed run or idempotency reservation. */
|
|
192
|
-
historicalBillingMetadata?: Record<string, unknown>;
|
|
193
|
-
resultReturnedFrom?: string;
|
|
194
|
-
cacheHit?: boolean;
|
|
195
|
-
/** True when a definitive no-email result came from the short-lived negative cache. */
|
|
196
|
-
negativeCacheHit?: boolean;
|
|
197
|
-
/** Remaining lifetime of the negative cache entry. */
|
|
198
|
-
negativeCacheTtlSeconds?: number;
|
|
199
|
-
cacheTier?: string;
|
|
200
|
-
freshEnrichmentUsed?: boolean;
|
|
201
|
-
liveProviderCalled?: boolean;
|
|
202
|
-
openrouterCalled?: boolean;
|
|
203
|
-
byoOpenrouterUsed?: boolean;
|
|
204
253
|
error?: string;
|
|
205
254
|
errorCode?: string;
|
|
206
255
|
/** Processing while an existing provider run is still active; otherwise completed. */
|
|
@@ -215,10 +264,10 @@ interface FindEmailResult {
|
|
|
215
264
|
doNotAutoResubmit?: boolean;
|
|
216
265
|
recoveryMode?: 'same_run';
|
|
217
266
|
recoveryStatus?: 'pending' | 'completed';
|
|
218
|
-
cachePublicationStatus?: 'completed' | 'pending' | 'pending_safe_retry' | 'superseded_by_newer_verdict';
|
|
219
|
-
cachePublicationRetryEligible?: boolean;
|
|
220
267
|
raw: Record<string, unknown>;
|
|
221
268
|
}
|
|
269
|
+
type VerifyEmailStatus = 'valid' | 'invalid' | 'catch_all' | 'role' | 'disposable' | 'unknown' | 'verifier_error' | 'malformed' | 'error';
|
|
270
|
+
type VerifyEmailRecommendation = 'send' | 'do_not_send' | 'manual_review';
|
|
222
271
|
interface VerifyEmailResult {
|
|
223
272
|
success: boolean;
|
|
224
273
|
error?: string;
|
|
@@ -237,12 +286,12 @@ interface VerifyEmailResult {
|
|
|
237
286
|
isCatchAll: boolean;
|
|
238
287
|
/** Explicit send-safety verdict. Missing or false never becomes true by inference. */
|
|
239
288
|
verifiedForSending: boolean;
|
|
240
|
-
verificationStatus?:
|
|
241
|
-
deliverabilityStatus?:
|
|
242
|
-
verificationVerdict:
|
|
289
|
+
verificationStatus?: VerifyEmailStatus;
|
|
290
|
+
deliverabilityStatus?: VerifyEmailStatus;
|
|
291
|
+
verificationVerdict: VerifyEmailStatus;
|
|
243
292
|
isRoleAccount?: boolean;
|
|
244
293
|
quality?: string | null;
|
|
245
|
-
recommendation?:
|
|
294
|
+
recommendation?: VerifyEmailRecommendation;
|
|
246
295
|
smtpStatus?: string;
|
|
247
296
|
providerStatus?: string;
|
|
248
297
|
failureReason?: string;
|
|
@@ -255,32 +304,12 @@ interface VerifyEmailResult {
|
|
|
255
304
|
/** True when the public result came from a completed response-idempotency reservation. */
|
|
256
305
|
idempotencyReplayed?: boolean;
|
|
257
306
|
creditsUsed?: number;
|
|
258
|
-
billingMetadata?: Record<string, unknown>;
|
|
259
|
-
/** Original provider-work receipt when this response recovered a completed run or idempotency reservation. */
|
|
260
|
-
historicalBillingMetadata?: Record<string, unknown>;
|
|
261
|
-
resultReturnedFrom?: string;
|
|
262
|
-
cacheHit?: boolean;
|
|
263
|
-
/** True when a conclusive send-blocking verdict came from the short-lived rejection cache. */
|
|
264
|
-
negativeCacheHit?: boolean;
|
|
265
|
-
/** Remaining lifetime of the rejection cache entry. */
|
|
266
|
-
negativeCacheTtlSeconds?: number;
|
|
267
|
-
cacheTier?: string;
|
|
268
|
-
freshEnrichmentUsed?: boolean;
|
|
269
|
-
liveProviderCalled?: boolean;
|
|
270
|
-
openrouterCalled?: boolean;
|
|
271
|
-
byoOpenrouterUsed?: boolean;
|
|
272
|
-
estimatedExternalCostUsd?: number;
|
|
273
307
|
/** Canonical run ID alias returned alongside verificationRunId when available. */
|
|
274
308
|
runId?: string;
|
|
275
|
-
/** Whether the billed terminal verdict was durably published for Find Email reuse. */
|
|
276
|
-
cachePublicationStatus?: 'completed' | 'pending' | 'pending_safe_retry' | 'superseded_by_newer_verdict';
|
|
277
|
-
cachePublicationRetryEligible?: boolean;
|
|
278
309
|
suggestedAction?: string;
|
|
279
310
|
raw: Record<string, unknown>;
|
|
280
311
|
}
|
|
281
312
|
interface VerifyEmailOptions {
|
|
282
|
-
/** Bypass cached verification data for a fresh-provider quality check. */
|
|
283
|
-
skipCache?: boolean;
|
|
284
313
|
/** Resume an existing long verification without another provider call. */
|
|
285
314
|
verificationRunId?: string;
|
|
286
315
|
/** Wait for a processing verification to finish. Defaults to true. */
|
|
@@ -298,56 +327,34 @@ interface VerifyEmailBatchOptions extends BatchOptions, VerifyEmailOptions {
|
|
|
298
327
|
}
|
|
299
328
|
interface VerifyEmailBatchInput {
|
|
300
329
|
email: string;
|
|
301
|
-
/** Override the batch-level cache policy for this address. */
|
|
302
|
-
skipCache?: boolean;
|
|
303
330
|
/** Stable retry key scoped to this address. */
|
|
304
331
|
idempotencyKey?: string;
|
|
305
332
|
}
|
|
306
333
|
interface CompanySignalEnrichmentParams {
|
|
307
334
|
/** Resume an existing enrichment without creating another provider run. */
|
|
308
335
|
signalRunId?: string;
|
|
336
|
+
/** Company domain. This is the only new-enrichment input. */
|
|
337
|
+
domain?: string;
|
|
338
|
+
/** @deprecated Use domain. Accepted for source compatibility but not sent. */
|
|
309
339
|
companyDomain?: string;
|
|
340
|
+
/** @deprecated Company names are derived from the supplied domain. */
|
|
310
341
|
companyName?: string;
|
|
342
|
+
/** @deprecated Company Signal Enrichment is type-agnostic and ignores research prompts. */
|
|
311
343
|
researchPrompt?: string;
|
|
312
|
-
|
|
313
|
-
targetSignalCount?: number;
|
|
344
|
+
/** @deprecated Signaliz owns the fixed evidence window and ignores this value. */
|
|
314
345
|
lookbackDays?: number;
|
|
315
|
-
online?: boolean;
|
|
316
|
-
enableDeepSearch?: boolean;
|
|
317
|
-
/** Web coverage policy. Balanced targets an average all-in search budget below one cent. */
|
|
318
|
-
searchMode?: 'fast' | 'balanced' | 'coverage';
|
|
319
|
-
includeSummary?: boolean;
|
|
320
|
-
enableOutreachIntelligence?: boolean;
|
|
321
|
-
enablePredictiveIntelligence?: boolean;
|
|
322
|
-
skipCache?: boolean;
|
|
323
|
-
/** Include all evaluated evidence candidates, including rejected diagnostics. Defaults to selected-signal evidence only. */
|
|
324
|
-
includeCandidateEvidence?: boolean;
|
|
325
|
-
/** @deprecated Single Company Signal calls are synchronous; batch recovery is managed automatically. */
|
|
326
|
-
waitForResult?: boolean;
|
|
327
|
-
/** Maximum server-side synchronous execution window. */
|
|
328
|
-
maxWaitMs?: number;
|
|
329
|
-
/** @deprecated Company Signal batch polling is managed automatically. */
|
|
330
|
-
pollIntervalMs?: number;
|
|
331
346
|
/** Return a no-spend plan without provider calls or jobs. */
|
|
332
347
|
dryRun?: boolean;
|
|
333
348
|
/** Stable retry key for recovering the same request after an ambiguous response. */
|
|
334
349
|
idempotencyKey?: string;
|
|
335
350
|
}
|
|
351
|
+
/** One verified signal for the parent Company Signal result's company. */
|
|
336
352
|
interface CompanySignal {
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
detectedAt?: string | null;
|
|
343
|
-
datePrecision?: string;
|
|
344
|
-
sourceUrl?: string | null;
|
|
345
|
-
sourceType?: string;
|
|
346
|
-
confidence?: number | null;
|
|
347
|
-
signalFamily?: string;
|
|
348
|
-
eventType?: string;
|
|
349
|
-
eventLabel?: string;
|
|
350
|
-
classification?: Record<string, unknown> | string | null;
|
|
353
|
+
date: string;
|
|
354
|
+
signal_type: string;
|
|
355
|
+
signal_title: string;
|
|
356
|
+
signal_summary: string;
|
|
357
|
+
source: string;
|
|
351
358
|
}
|
|
352
359
|
interface CompanySignalEnrichmentResult {
|
|
353
360
|
success: boolean;
|
|
@@ -361,24 +368,7 @@ interface CompanySignalEnrichmentResult {
|
|
|
361
368
|
};
|
|
362
369
|
signals: CompanySignal[];
|
|
363
370
|
signalCount: number;
|
|
364
|
-
signalSummary: string | null;
|
|
365
|
-
intelligence?: Record<string, unknown> | null;
|
|
366
|
-
copyFuel?: Record<string, unknown> | null;
|
|
367
|
-
evidenceValidation?: Record<string, unknown>;
|
|
368
|
-
evidenceSources?: Record<string, unknown>[];
|
|
369
|
-
evidenceCount?: number;
|
|
370
|
-
evidenceCountTotal?: number;
|
|
371
|
-
evidenceSourcesOmitted?: number;
|
|
372
|
-
evidenceScope?: 'selected_signals' | 'all_candidates';
|
|
373
|
-
billingMetadata?: Record<string, unknown>;
|
|
374
|
-
resultReturnedFrom?: string;
|
|
375
|
-
cacheHit?: boolean;
|
|
376
|
-
freshEnrichmentUsed?: boolean;
|
|
377
371
|
creditsUsed?: number;
|
|
378
|
-
liveProviderCalled?: boolean;
|
|
379
|
-
aiProviderCalled?: boolean;
|
|
380
|
-
byoAiUsed?: boolean;
|
|
381
|
-
raw: Record<string, unknown>;
|
|
382
372
|
}
|
|
383
373
|
type SignalDiscoverySource = 'web' | 'news';
|
|
384
374
|
type SignalDiscoveryStatus = 'planned' | 'queued' | 'processing' | 'completed' | 'completed_with_warnings' | 'failed';
|
|
@@ -393,6 +383,10 @@ interface SignalDiscoveryParams {
|
|
|
393
383
|
sources?: SignalDiscoverySource[];
|
|
394
384
|
/** Maximum signal age in days. Allowed range is 1-365. */
|
|
395
385
|
lookbackDays?: number;
|
|
386
|
+
/** Inclusive event-date lower bound (YYYY-MM-DD). Mutually exclusive with lookbackDays. */
|
|
387
|
+
afterDate?: string;
|
|
388
|
+
/** Inclusive event-date upper bound (YYYY-MM-DD). Mutually exclusive with lookbackDays. */
|
|
389
|
+
beforeDate?: string;
|
|
396
390
|
/** Resume an existing asynchronous discovery run without starting another search. */
|
|
397
391
|
signalSearchRunId?: string;
|
|
398
392
|
/** Stable retry key for recovering the same search after an ambiguous response. */
|
|
@@ -400,80 +394,88 @@ interface SignalDiscoveryParams {
|
|
|
400
394
|
/** Return a no-dispatch plan without provider calls or jobs. */
|
|
401
395
|
dryRun?: boolean;
|
|
402
396
|
}
|
|
403
|
-
|
|
404
|
-
id?: string;
|
|
405
|
-
company: {
|
|
406
|
-
/** Every returned discovery signal is attributed to a distinct company. */
|
|
407
|
-
name: string;
|
|
408
|
-
domain: string;
|
|
409
|
-
linkedinUrl?: string | null;
|
|
410
|
-
};
|
|
411
|
-
title: string;
|
|
412
|
-
type: string;
|
|
413
|
-
summary: string;
|
|
414
|
-
eventDate: string;
|
|
415
|
-
evidence: Array<{
|
|
416
|
-
url: string;
|
|
417
|
-
publishedAt: string;
|
|
418
|
-
source: string;
|
|
419
|
-
}>;
|
|
420
|
-
/** Compatibility alias for summary. */
|
|
421
|
-
content: string;
|
|
422
|
-
/** Compatibility alias for eventDate. */
|
|
423
|
-
date?: string | null;
|
|
424
|
-
detectedAt?: string | null;
|
|
425
|
-
sourceUrl: string;
|
|
426
|
-
sourceType?: string | null;
|
|
427
|
-
confidence?: number | null;
|
|
428
|
-
classification?: Record<string, unknown> | string | null;
|
|
429
|
-
raw: Record<string, unknown>;
|
|
430
|
-
}
|
|
431
|
-
interface SignalDiscoveryCostGuardrail {
|
|
432
|
-
/** Strict ceiling: a qualified company signal must cost less than this amount to return. */
|
|
433
|
-
maxCostPerQualifiedSignalUsd: number;
|
|
434
|
-
projectedSourceCostUsd?: number | null;
|
|
435
|
-
maxSourceCostUsd?: number | null;
|
|
436
|
-
projectedCostPerRequestedCompanySignalUsd?: number | null;
|
|
437
|
-
sourceCostUsd?: number | null;
|
|
438
|
-
costSource?: 'observed' | 'catalog_preflight' | 'catalog_bounded' | 'mixed' | 'unavailable';
|
|
439
|
-
/** Separately reported company identity-resolution cost; null when receipts are incomplete. */
|
|
440
|
-
identityResolutionCostUsd?: number | null;
|
|
441
|
-
/** Evidence used to account for company identity-resolution cost. */
|
|
442
|
-
identityCostSource?: 'observed_zero_credit_receipts' | 'contractual_zero_cost' | 'not_used' | 'unavailable';
|
|
443
|
-
/** Zero-cost fallback identity-provider requests covered by identityResolutionCostUsd. */
|
|
444
|
-
identityProviderRequests?: number;
|
|
445
|
-
qualifiedCompanySignalCount?: number;
|
|
446
|
-
returnedCompanySignalCount?: number;
|
|
447
|
-
/** Qualified signals retained on the same search run for later expansion. */
|
|
448
|
-
availableCompanySignalCount?: number;
|
|
449
|
-
/** Raw source candidate ceiling per selected source lane used to form the cohort. */
|
|
450
|
-
acquisitionCandidateLimit?: number;
|
|
451
|
-
/** Minimum qualified companies needed for the source receipt to stay below one cent each. */
|
|
452
|
-
minimumQualifiedCompanySignals?: number;
|
|
453
|
-
costPerQualifiedSignalUsd?: number | null;
|
|
454
|
-
withinLimit: boolean;
|
|
455
|
-
}
|
|
397
|
+
type SignalDiscoverySignal = PublicSignalRow;
|
|
456
398
|
interface SignalDiscoveryResult {
|
|
457
399
|
success: boolean;
|
|
458
400
|
status: SignalDiscoveryStatus;
|
|
459
401
|
capability: 'signals_everything';
|
|
460
402
|
signalSearchRunId: string;
|
|
461
403
|
query: string;
|
|
462
|
-
requestedCount
|
|
404
|
+
requestedCount?: number;
|
|
463
405
|
nextPollAfterSeconds?: number;
|
|
464
406
|
signals: SignalDiscoverySignal[];
|
|
465
407
|
signalCount: number;
|
|
466
|
-
/**
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
408
|
+
/** Signals First is included on eligible plans; the server returns zero for every completed, failed, and recovered run. */
|
|
409
|
+
creditsUsed: number;
|
|
410
|
+
/** Customer charge receipt for this run. Expected to be zero while billingStatus is included. */
|
|
411
|
+
creditsCharged: number;
|
|
412
|
+
billingStatus?: 'included';
|
|
413
|
+
/** True when the server returned a retained terminal result instead of acquiring again. */
|
|
414
|
+
idempotencyReplayed?: boolean;
|
|
415
|
+
}
|
|
416
|
+
interface SignalizFlowParams {
|
|
417
|
+
signalQuery: string;
|
|
418
|
+
campaignOffer: string;
|
|
419
|
+
signalLimit?: number;
|
|
420
|
+
lookbackDays?: number;
|
|
421
|
+
icpContext?: string;
|
|
422
|
+
peopleTitles?: string[];
|
|
423
|
+
peoplePerCompany?: number;
|
|
424
|
+
copyResearchPrompt?: string;
|
|
425
|
+
approvalRequired?: boolean;
|
|
426
|
+
/** Stable Flow identifier; reuse it when recovering from an ambiguous start response. */
|
|
427
|
+
flowId?: string;
|
|
428
|
+
/** Stable retry key. Reusing it with the same request never starts duplicate Flow work. */
|
|
429
|
+
idempotencyKey?: string;
|
|
430
|
+
/** Return the Flow plan and safeguards without dispatching work or using credits. */
|
|
431
|
+
dryRun?: boolean;
|
|
432
|
+
}
|
|
433
|
+
interface SignalizFlowReceiptLine {
|
|
434
|
+
capability: 'company_signals' | 'find_email' | 'signal_to_copy';
|
|
435
|
+
successfulResults: number;
|
|
436
|
+
creditsCharged: number;
|
|
437
|
+
}
|
|
438
|
+
interface SignalizFlowBillingReceipt {
|
|
439
|
+
creditsCharged: number;
|
|
440
|
+
billingStatus: 'included_or_waived' | 'charged';
|
|
441
|
+
chargeBasis: string;
|
|
442
|
+
receipt: SignalizFlowReceiptLine[];
|
|
443
|
+
}
|
|
444
|
+
interface SignalizFlowPlan {
|
|
445
|
+
plannedCompanyCount: number;
|
|
446
|
+
plannedPeoplePerCompany: number;
|
|
447
|
+
maximumReviewCandidates: number;
|
|
448
|
+
safeguards: string[];
|
|
449
|
+
billing: {
|
|
450
|
+
additionalFlowFeeCredits: number;
|
|
451
|
+
chargeBasis: string;
|
|
452
|
+
};
|
|
453
|
+
}
|
|
454
|
+
interface SignalizFlowStartResult {
|
|
455
|
+
success: boolean;
|
|
456
|
+
dryRun?: false;
|
|
457
|
+
flowId: string;
|
|
458
|
+
runId: string;
|
|
459
|
+
status: 'TRIGGERED';
|
|
460
|
+
statusEndpoint: 'api/v1/flow';
|
|
461
|
+
message: string;
|
|
462
|
+
}
|
|
463
|
+
interface SignalizFlowPlanResult {
|
|
464
|
+
success: true;
|
|
465
|
+
dryRun: true;
|
|
466
|
+
status: 'PLANNED';
|
|
467
|
+
flowId: string;
|
|
468
|
+
plan: SignalizFlowPlan;
|
|
469
|
+
creditsCharged: 0;
|
|
470
|
+
}
|
|
471
|
+
interface SignalizFlowStatus {
|
|
472
|
+
success: boolean;
|
|
473
|
+
runId: string;
|
|
474
|
+
status: 'running' | 'completed' | 'failed';
|
|
475
|
+
result: Record<string, unknown>;
|
|
476
|
+
createdAt?: string;
|
|
477
|
+
updatedAt?: string;
|
|
478
|
+
completedAt?: string;
|
|
477
479
|
}
|
|
478
480
|
interface SignalToCopyParams {
|
|
479
481
|
companyDomain?: string;
|
|
@@ -481,11 +483,17 @@ interface SignalToCopyParams {
|
|
|
481
483
|
title?: string;
|
|
482
484
|
campaignOffer?: string;
|
|
483
485
|
researchPrompt?: string;
|
|
484
|
-
/**
|
|
486
|
+
/** Use current company signals, or draft from the offer and research prompt without signal claims. */
|
|
487
|
+
copyEvidenceMode?: 'signal_led' | 'firmographic';
|
|
488
|
+
/** Maximum signal age used for company-signal research. Defaults to 90 days. */
|
|
485
489
|
lookbackDays?: number;
|
|
486
490
|
signalRunId?: string;
|
|
487
|
-
/**
|
|
488
|
-
|
|
491
|
+
/** Reuse an immutable Signals First snapshot without company re-research. Supported in single calls and batches of 25 or fewer. */
|
|
492
|
+
signalSearchRunId?: string;
|
|
493
|
+
/** Reuse one canonical signal fact without rediscovery. Supported in single calls and batches of 25 or fewer. */
|
|
494
|
+
factId?: string;
|
|
495
|
+
/** Reuse one canonical signal event without rediscovery. Supported in single calls and batches of 25 or fewer. */
|
|
496
|
+
eventId?: string;
|
|
489
497
|
/** Use the full deep-research provider portfolio. The default uses bounded credit-free first-party and Bing grounding. */
|
|
490
498
|
enableDeepSearch?: boolean;
|
|
491
499
|
/** @deprecated Single Signal to Copy calls are synchronous; batch recovery is managed automatically. */
|
|
@@ -513,6 +521,11 @@ interface SignalToCopyResult {
|
|
|
513
521
|
status?: string;
|
|
514
522
|
runId?: string;
|
|
515
523
|
companySignalRunId?: string;
|
|
524
|
+
signalSearchRunId?: string;
|
|
525
|
+
factId?: string;
|
|
526
|
+
eventId?: string;
|
|
527
|
+
canonicalSourceUrl?: string;
|
|
528
|
+
evidenceReuse?: Record<string, unknown>;
|
|
516
529
|
resumeContextPersisted?: boolean;
|
|
517
530
|
strongestSignal: string;
|
|
518
531
|
whyNow: string;
|
|
@@ -521,17 +534,11 @@ interface SignalToCopyResult {
|
|
|
521
534
|
confidence: number;
|
|
522
535
|
evidenceUrl: string;
|
|
523
536
|
researchPrompt?: string;
|
|
537
|
+
copyEvidenceMode?: 'signal_led' | 'firmographic';
|
|
524
538
|
empty?: boolean;
|
|
525
539
|
emptyReason?: string;
|
|
526
540
|
researchMetadata?: Record<string, unknown>;
|
|
527
|
-
billingMetadata?: Record<string, unknown>;
|
|
528
|
-
resultReturnedFrom?: string;
|
|
529
|
-
cacheHit?: boolean;
|
|
530
|
-
freshEnrichmentUsed?: boolean;
|
|
531
541
|
creditsUsed?: number;
|
|
532
|
-
liveProviderCalled?: boolean;
|
|
533
|
-
aiProviderCalled?: boolean;
|
|
534
|
-
byoAiUsed?: boolean;
|
|
535
542
|
unlimitedSignalToCopy?: boolean;
|
|
536
543
|
signalToCopyEntitlement?: 'unlimited' | 'standard';
|
|
537
544
|
variations: SignalToCopyVariation[];
|
|
@@ -561,6 +568,15 @@ declare class SignalizError extends Error {
|
|
|
561
568
|
declare class Signaliz {
|
|
562
569
|
private readonly client;
|
|
563
570
|
constructor(config: SignalizConfig);
|
|
571
|
+
/**
|
|
572
|
+
* The canonical Signal Awareness control plane used by the CLI and MCP.
|
|
573
|
+
* Manual runs accept a stable retry key and return an explicit billing
|
|
574
|
+
* receipt, including zero-credit available-data reuse.
|
|
575
|
+
*/
|
|
576
|
+
signalAwareness(request: SignalAwarenessRequest): Promise<SignalAwarenessResponse>;
|
|
577
|
+
createSignalMonitor(monitor: SignalMonitorInput): Promise<SignalAwarenessResponse>;
|
|
578
|
+
listSignalMonitors(limit?: number, offset?: number): Promise<SignalAwarenessResponse>;
|
|
579
|
+
runSignalMonitor(monitorId: string, idempotencyKey?: string): Promise<SignalAwarenessResponse>;
|
|
564
580
|
findEmail(params: FindEmailParams & {
|
|
565
581
|
dryRun: true;
|
|
566
582
|
}): Promise<CoreProductDryRunResult>;
|
|
@@ -584,6 +600,13 @@ declare class Signaliz {
|
|
|
584
600
|
}): Promise<CoreProductDryRunResult>;
|
|
585
601
|
enrichCompanySignals(params: CompanySignalEnrichmentParams): Promise<CompanySignalEnrichmentResult>;
|
|
586
602
|
discoverSignals(params: SignalDiscoveryParams): Promise<SignalDiscoveryResult>;
|
|
603
|
+
/** Signals First is the customer-facing name for open-ended discovery. */
|
|
604
|
+
discoverSignalsFirst(params: SignalDiscoveryParams): Promise<SignalDiscoveryResult>;
|
|
605
|
+
startFlow(params: SignalizFlowParams & {
|
|
606
|
+
dryRun: true;
|
|
607
|
+
}): Promise<SignalizFlowPlanResult>;
|
|
608
|
+
startFlow(params: SignalizFlowParams): Promise<SignalizFlowStartResult>;
|
|
609
|
+
getFlow(runId: string): Promise<SignalizFlowStatus>;
|
|
587
610
|
enrichCompanies(companies: CompanySignalEnrichmentParams[], options: BatchOptions & {
|
|
588
611
|
dryRun: true;
|
|
589
612
|
}): Promise<CoreProductDryRunResult>;
|
|
@@ -615,4 +638,4 @@ declare class Signaliz {
|
|
|
615
638
|
health(): Promise<PlatformHealth>;
|
|
616
639
|
}
|
|
617
640
|
|
|
618
|
-
export { type BatchItemResult, type BatchOptions, type BatchResult, type CompanySignal, type CompanySignalEnrichmentParams, type CompanySignalEnrichmentResult, type CoreBatchResumeOptions, type CoreEmailBatchResumeOptions, type ErrorType, type FindEmailParams, type FindEmailResult, type MCPToolInfo, type PlatformHealth, type RecoverableBatchJob, type SignalDiscoveryParams, type SignalDiscoveryResult, type SignalDiscoverySignal, type SignalDiscoverySource, type SignalDiscoveryStatus, type SignalToCopyParams, type SignalToCopyResult, type SignalToCopyVariation, Signaliz, type SignalizConfig, SignalizError, type SignalizErrorData, type VerifyEmailBatchInput, type VerifyEmailBatchOptions, type VerifyEmailOptions, type VerifyEmailResult };
|
|
641
|
+
export { type BatchItemResult, type BatchOptions, type BatchResult, type CompanySignal, type CompanySignalEnrichmentParams, type CompanySignalEnrichmentResult, type CoreBatchResumeOptions, type CoreEmailBatchResumeOptions, type ErrorType, type FindEmailParams, type FindEmailResult, type MCPToolInfo, type PlatformHealth, type PublicSignalRow, type RecoverableBatchJob, type SignalAwarenessAction, type SignalAwarenessMonitor, type SignalAwarenessRequest, type SignalAwarenessResponse, type SignalAwarenessRun, type SignalAwarenessSignal, type SignalDiscoveryParams, type SignalDiscoveryResult, type SignalDiscoverySignal, type SignalDiscoverySource, type SignalDiscoveryStatus, type SignalMonitorInput, type SignalToCopyParams, type SignalToCopyResult, type SignalToCopyVariation, Signaliz, type SignalizConfig, SignalizError, type SignalizErrorData, type SignalizFlowBillingReceipt, type SignalizFlowParams, type SignalizFlowPlan, type SignalizFlowPlanResult, type SignalizFlowReceiptLine, type SignalizFlowStartResult, type SignalizFlowStatus, type VerifyEmailBatchInput, type VerifyEmailBatchOptions, type VerifyEmailOptions, type VerifyEmailRecommendation, type VerifyEmailResult, type VerifyEmailStatus };
|