@signaliz/sdk 1.0.61 → 1.0.63
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 +53 -17
- package/dist/{chunk-ENA7AVFB.mjs → chunk-VWO2GEYQ.mjs} +821 -101
- package/dist/index.d.mts +88 -7
- package/dist/index.d.ts +88 -7
- package/dist/index.js +821 -101
- package/dist/index.mjs +1 -1
- package/dist/mcp-config.js +821 -101
- package/dist/mcp-config.mjs +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -15,6 +15,34 @@ interface BatchOptions {
|
|
|
15
15
|
compactDuplicates?: boolean;
|
|
16
16
|
/** Return one no-spend plan for the full batch without provider calls or jobs. */
|
|
17
17
|
dryRun?: boolean;
|
|
18
|
+
/** Return a durable Company Signals or Signal to Copy job handle immediately. */
|
|
19
|
+
waitForResult?: boolean;
|
|
20
|
+
/** Maximum time to poll a durable job. Email jobs default to 20 minutes; Company/Copy jobs wait without a fixed deadline when omitted. */
|
|
21
|
+
maxWaitMs?: number;
|
|
22
|
+
/** Override the server-provided polling delay for a durable job. */
|
|
23
|
+
pollIntervalMs?: number;
|
|
24
|
+
}
|
|
25
|
+
interface CoreBatchResumeOptions {
|
|
26
|
+
/** Requested result page size. The server caps email/Company pages at 25 and Copy pages at 100. */
|
|
27
|
+
pageSize?: number;
|
|
28
|
+
/** Maximum time to wait for the existing job. Company/Copy jobs wait without a fixed deadline when omitted. */
|
|
29
|
+
maxWaitMs?: number;
|
|
30
|
+
/** Override the server-provided polling delay while the existing job is active. */
|
|
31
|
+
pollIntervalMs?: number;
|
|
32
|
+
/** Return duplicate successes as duplicateOf references. Defaults to false. */
|
|
33
|
+
compactDuplicates?: boolean;
|
|
34
|
+
/** Original submission key, retained in any timeout recovery metadata. */
|
|
35
|
+
idempotencyKey?: string;
|
|
36
|
+
}
|
|
37
|
+
type CoreEmailBatchResumeOptions = CoreBatchResumeOptions;
|
|
38
|
+
interface RecoverableBatchJob {
|
|
39
|
+
success: true;
|
|
40
|
+
status: 'queued' | 'processing' | 'completed' | 'partial' | 'failed';
|
|
41
|
+
capability: 'company_signals' | 'signal_to_copy';
|
|
42
|
+
jobId: string;
|
|
43
|
+
idempotencyKey: string;
|
|
44
|
+
total: number;
|
|
45
|
+
nextPollAfterSeconds?: number;
|
|
18
46
|
}
|
|
19
47
|
interface BatchItemResult<T> {
|
|
20
48
|
index: number;
|
|
@@ -41,6 +69,8 @@ interface BatchItemResult<T> {
|
|
|
41
69
|
jobId?: string;
|
|
42
70
|
/** Machine-readable recovery action returned by Signaliz. */
|
|
43
71
|
suggestedAction?: string;
|
|
72
|
+
cachePublicationStatus?: 'completed' | 'pending' | 'pending_safe_retry' | 'superseded_by_newer_verdict';
|
|
73
|
+
cachePublicationRetryEligible?: boolean;
|
|
44
74
|
/** Zero-based input index containing the full result for this exact duplicate. */
|
|
45
75
|
duplicateOf?: number;
|
|
46
76
|
}
|
|
@@ -110,17 +140,26 @@ interface FindEmailResult {
|
|
|
110
140
|
lastName?: string;
|
|
111
141
|
confidence: number;
|
|
112
142
|
verificationStatus: string;
|
|
143
|
+
deliverabilityStatus: string;
|
|
144
|
+
verificationVerdict: string;
|
|
113
145
|
isVerified: boolean;
|
|
114
146
|
isVerifiedForSending: boolean;
|
|
147
|
+
isDeliverable: boolean;
|
|
115
148
|
isCatchAll: boolean;
|
|
116
149
|
verificationFreshness: 'fresh' | 'stale' | 'unknown';
|
|
117
150
|
verificationAgeDays: number | null;
|
|
118
151
|
verifiedAt: string | null;
|
|
119
152
|
needsReverification: boolean;
|
|
120
153
|
providerUsed: string;
|
|
154
|
+
verificationSource: string;
|
|
155
|
+
/** ISO timestamp when the provider observed the winning verdict. */
|
|
156
|
+
verificationObservedAt?: string;
|
|
157
|
+
failureReason: string;
|
|
121
158
|
creditsUsed?: number;
|
|
122
159
|
estimatedExternalCostUsd?: number;
|
|
123
160
|
billingMetadata?: Record<string, unknown>;
|
|
161
|
+
/** Original provider-work billing receipt when this request only recovered a completed run. */
|
|
162
|
+
historicalBillingMetadata?: Record<string, unknown>;
|
|
124
163
|
resultReturnedFrom?: string;
|
|
125
164
|
cacheHit?: boolean;
|
|
126
165
|
/** True when a definitive no-email result came from the short-lived negative cache. */
|
|
@@ -140,6 +179,8 @@ interface FindEmailResult {
|
|
|
140
179
|
runId?: string;
|
|
141
180
|
nextPollAfterSeconds?: number;
|
|
142
181
|
suggestedAction?: string;
|
|
182
|
+
cachePublicationStatus?: 'completed' | 'pending' | 'pending_safe_retry' | 'superseded_by_newer_verdict';
|
|
183
|
+
cachePublicationRetryEligible?: boolean;
|
|
143
184
|
raw: Record<string, unknown>;
|
|
144
185
|
}
|
|
145
186
|
interface VerifyEmailResult {
|
|
@@ -160,13 +201,25 @@ interface VerifyEmailResult {
|
|
|
160
201
|
isCatchAll: boolean;
|
|
161
202
|
/** Explicit send-safety verdict. Missing or false never becomes true by inference. */
|
|
162
203
|
verifiedForSending: boolean;
|
|
204
|
+
verificationStatus?: string;
|
|
205
|
+
deliverabilityStatus?: string;
|
|
163
206
|
verificationVerdict: string;
|
|
207
|
+
isRoleAccount?: boolean;
|
|
208
|
+
quality?: string | null;
|
|
209
|
+
recommendation?: string;
|
|
210
|
+
smtpStatus?: string;
|
|
211
|
+
providerStatus?: string;
|
|
212
|
+
failureReason?: string;
|
|
164
213
|
confidenceScore: number;
|
|
165
214
|
provider?: string;
|
|
166
215
|
verificationSource?: string;
|
|
216
|
+
/** ISO timestamp when the provider observed the winning verdict. */
|
|
217
|
+
verificationObservedAt?: string;
|
|
167
218
|
billingReplayed?: boolean;
|
|
168
219
|
creditsUsed?: number;
|
|
169
220
|
billingMetadata?: Record<string, unknown>;
|
|
221
|
+
/** Original provider-work billing receipt when this request only recovered a completed run. */
|
|
222
|
+
historicalBillingMetadata?: Record<string, unknown>;
|
|
170
223
|
resultReturnedFrom?: string;
|
|
171
224
|
cacheHit?: boolean;
|
|
172
225
|
/** True when a conclusive send-blocking verdict came from the short-lived rejection cache. */
|
|
@@ -178,6 +231,13 @@ interface VerifyEmailResult {
|
|
|
178
231
|
liveProviderCalled?: boolean;
|
|
179
232
|
openrouterCalled?: boolean;
|
|
180
233
|
byoOpenrouterUsed?: boolean;
|
|
234
|
+
estimatedExternalCostUsd?: number;
|
|
235
|
+
/** Canonical run ID alias returned alongside verificationRunId when available. */
|
|
236
|
+
runId?: string;
|
|
237
|
+
/** Whether the billed terminal verdict was durably published for Find Email reuse. */
|
|
238
|
+
cachePublicationStatus?: 'completed' | 'pending' | 'pending_safe_retry' | 'superseded_by_newer_verdict';
|
|
239
|
+
cachePublicationRetryEligible?: boolean;
|
|
240
|
+
suggestedAction?: string;
|
|
181
241
|
raw: Record<string, unknown>;
|
|
182
242
|
}
|
|
183
243
|
interface VerifyEmailOptions {
|
|
@@ -198,6 +258,13 @@ interface VerifyEmailOptions {
|
|
|
198
258
|
}
|
|
199
259
|
interface VerifyEmailBatchOptions extends BatchOptions, VerifyEmailOptions {
|
|
200
260
|
}
|
|
261
|
+
interface VerifyEmailBatchInput {
|
|
262
|
+
email: string;
|
|
263
|
+
/** Override the batch-level cache policy for this address. */
|
|
264
|
+
skipCache?: boolean;
|
|
265
|
+
/** Stable retry key scoped to this address. */
|
|
266
|
+
idempotencyKey?: string;
|
|
267
|
+
}
|
|
201
268
|
interface CompanySignalEnrichmentParams {
|
|
202
269
|
/** Resume an existing enrichment without creating another provider run. */
|
|
203
270
|
signalRunId?: string;
|
|
@@ -217,11 +284,11 @@ interface CompanySignalEnrichmentParams {
|
|
|
217
284
|
skipCache?: boolean;
|
|
218
285
|
/** Include all evaluated evidence candidates, including rejected diagnostics. Defaults to selected-signal evidence only. */
|
|
219
286
|
includeCandidateEvidence?: boolean;
|
|
220
|
-
/** @deprecated Company
|
|
287
|
+
/** @deprecated Single Company Signal calls are synchronous; batch recovery is managed automatically. */
|
|
221
288
|
waitForResult?: boolean;
|
|
222
289
|
/** Maximum server-side synchronous execution window. */
|
|
223
290
|
maxWaitMs?: number;
|
|
224
|
-
/** @deprecated Company
|
|
291
|
+
/** @deprecated Company Signal batch polling is managed automatically. */
|
|
225
292
|
pollIntervalMs?: number;
|
|
226
293
|
/** Return a no-spend plan without provider calls or jobs. */
|
|
227
294
|
dryRun?: boolean;
|
|
@@ -383,10 +450,10 @@ interface SignalToCopyParams {
|
|
|
383
450
|
skipCache?: boolean;
|
|
384
451
|
/** Use the full deep-research provider portfolio. The default uses bounded credit-free first-party and Bing grounding. */
|
|
385
452
|
enableDeepSearch?: boolean;
|
|
386
|
-
/** @deprecated Signal to Copy
|
|
453
|
+
/** @deprecated Single Signal to Copy calls are synchronous; batch recovery is managed automatically. */
|
|
387
454
|
waitForResult?: boolean;
|
|
388
455
|
maxWaitMs?: number;
|
|
389
|
-
/** @deprecated Signal
|
|
456
|
+
/** @deprecated Signal Copy batch polling is managed automatically. */
|
|
390
457
|
pollIntervalMs?: number;
|
|
391
458
|
/** Return a no-spend plan without provider calls or jobs. */
|
|
392
459
|
dryRun?: boolean;
|
|
@@ -427,6 +494,8 @@ interface SignalToCopyResult {
|
|
|
427
494
|
liveProviderCalled?: boolean;
|
|
428
495
|
aiProviderCalled?: boolean;
|
|
429
496
|
byoAiUsed?: boolean;
|
|
497
|
+
unlimitedSignalToCopy?: boolean;
|
|
498
|
+
signalToCopyEntitlement?: 'unlimited' | 'standard';
|
|
430
499
|
variations: SignalToCopyVariation[];
|
|
431
500
|
raw: Record<string, unknown>;
|
|
432
501
|
}
|
|
@@ -462,14 +531,16 @@ declare class Signaliz {
|
|
|
462
531
|
dryRun: true;
|
|
463
532
|
}): Promise<CoreProductDryRunResult>;
|
|
464
533
|
findEmails(params: FindEmailParams[], options?: BatchOptions): Promise<BatchResult<FindEmailResult>>;
|
|
534
|
+
resumeFindEmailBatch(jobId: string, options?: CoreEmailBatchResumeOptions): Promise<BatchResult<FindEmailResult>>;
|
|
465
535
|
verifyEmail(email: string | undefined, options: VerifyEmailOptions & {
|
|
466
536
|
dryRun: true;
|
|
467
537
|
}): Promise<CoreProductDryRunResult>;
|
|
468
538
|
verifyEmail(email: string | undefined, options?: VerifyEmailOptions): Promise<VerifyEmailResult>;
|
|
469
|
-
verifyEmails(emails: string
|
|
539
|
+
verifyEmails(emails: Array<string | VerifyEmailBatchInput>, options: VerifyEmailBatchOptions & {
|
|
470
540
|
dryRun: true;
|
|
471
541
|
}): Promise<CoreProductDryRunResult>;
|
|
472
|
-
verifyEmails(emails: string
|
|
542
|
+
verifyEmails(emails: Array<string | VerifyEmailBatchInput>, options?: VerifyEmailBatchOptions): Promise<BatchResult<VerifyEmailResult>>;
|
|
543
|
+
resumeVerifyEmailBatch(jobId: string, options?: CoreEmailBatchResumeOptions): Promise<BatchResult<VerifyEmailResult>>;
|
|
473
544
|
enrichCompanySignals(params: CompanySignalEnrichmentParams & {
|
|
474
545
|
dryRun: true;
|
|
475
546
|
}): Promise<CoreProductDryRunResult>;
|
|
@@ -478,7 +549,11 @@ declare class Signaliz {
|
|
|
478
549
|
enrichCompanies(companies: CompanySignalEnrichmentParams[], options: BatchOptions & {
|
|
479
550
|
dryRun: true;
|
|
480
551
|
}): Promise<CoreProductDryRunResult>;
|
|
552
|
+
enrichCompanies(companies: CompanySignalEnrichmentParams[], options: BatchOptions & {
|
|
553
|
+
waitForResult: false;
|
|
554
|
+
}): Promise<RecoverableBatchJob>;
|
|
481
555
|
enrichCompanies(companies: CompanySignalEnrichmentParams[], options?: BatchOptions): Promise<BatchResult<CompanySignalEnrichmentResult>>;
|
|
556
|
+
resumeCompanySignalBatch(jobId: string, options?: CoreBatchResumeOptions): Promise<BatchResult<CompanySignalEnrichmentResult>>;
|
|
482
557
|
signalToCopy(params: SignalToCopyParams & {
|
|
483
558
|
dryRun: true;
|
|
484
559
|
}): Promise<CoreProductDryRunResult>;
|
|
@@ -486,14 +561,20 @@ declare class Signaliz {
|
|
|
486
561
|
createSignalCopyBatch(requests: SignalToCopyParams[], options: BatchOptions & {
|
|
487
562
|
dryRun: true;
|
|
488
563
|
}): Promise<CoreProductDryRunResult>;
|
|
564
|
+
createSignalCopyBatch(requests: SignalToCopyParams[], options: BatchOptions & {
|
|
565
|
+
waitForResult: false;
|
|
566
|
+
}): Promise<RecoverableBatchJob>;
|
|
489
567
|
createSignalCopyBatch(requests: SignalToCopyParams[], options?: BatchOptions): Promise<BatchResult<SignalToCopyResult>>;
|
|
568
|
+
resumeSignalCopyBatch(jobId: string, options?: CoreBatchResumeOptions): Promise<BatchResult<SignalToCopyResult>>;
|
|
490
569
|
private runCoreProductDryRun;
|
|
491
570
|
private runSignalCopyBatchChunks;
|
|
492
571
|
private runRecoverableCoreBatchJob;
|
|
572
|
+
private submitRecoverableCoreBatchJob;
|
|
573
|
+
private readRecoverableCoreBatchJob;
|
|
493
574
|
private runSignalCopyBatchChunk;
|
|
494
575
|
private runCoreBatchRound;
|
|
495
576
|
listTools(): Promise<MCPToolInfo[]>;
|
|
496
577
|
health(): Promise<PlatformHealth>;
|
|
497
578
|
}
|
|
498
579
|
|
|
499
|
-
export { type BatchItemResult, type BatchOptions, type BatchResult, type CompanySignal, type CompanySignalEnrichmentParams, type CompanySignalEnrichmentResult, type ErrorType, type FindEmailParams, type FindEmailResult, type MCPToolInfo, type PlatformHealth, type SignalDiscoveryParams, type SignalDiscoveryResult, type SignalDiscoverySignal, type SignalDiscoverySource, type SignalDiscoveryStatus, type SignalToCopyParams, type SignalToCopyResult, type SignalToCopyVariation, Signaliz, type SignalizConfig, SignalizError, type SignalizErrorData, type VerifyEmailBatchOptions, type VerifyEmailOptions, type VerifyEmailResult };
|
|
580
|
+
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 };
|
package/dist/index.d.ts
CHANGED
|
@@ -15,6 +15,34 @@ interface BatchOptions {
|
|
|
15
15
|
compactDuplicates?: boolean;
|
|
16
16
|
/** Return one no-spend plan for the full batch without provider calls or jobs. */
|
|
17
17
|
dryRun?: boolean;
|
|
18
|
+
/** Return a durable Company Signals or Signal to Copy job handle immediately. */
|
|
19
|
+
waitForResult?: boolean;
|
|
20
|
+
/** Maximum time to poll a durable job. Email jobs default to 20 minutes; Company/Copy jobs wait without a fixed deadline when omitted. */
|
|
21
|
+
maxWaitMs?: number;
|
|
22
|
+
/** Override the server-provided polling delay for a durable job. */
|
|
23
|
+
pollIntervalMs?: number;
|
|
24
|
+
}
|
|
25
|
+
interface CoreBatchResumeOptions {
|
|
26
|
+
/** Requested result page size. The server caps email/Company pages at 25 and Copy pages at 100. */
|
|
27
|
+
pageSize?: number;
|
|
28
|
+
/** Maximum time to wait for the existing job. Company/Copy jobs wait without a fixed deadline when omitted. */
|
|
29
|
+
maxWaitMs?: number;
|
|
30
|
+
/** Override the server-provided polling delay while the existing job is active. */
|
|
31
|
+
pollIntervalMs?: number;
|
|
32
|
+
/** Return duplicate successes as duplicateOf references. Defaults to false. */
|
|
33
|
+
compactDuplicates?: boolean;
|
|
34
|
+
/** Original submission key, retained in any timeout recovery metadata. */
|
|
35
|
+
idempotencyKey?: string;
|
|
36
|
+
}
|
|
37
|
+
type CoreEmailBatchResumeOptions = CoreBatchResumeOptions;
|
|
38
|
+
interface RecoverableBatchJob {
|
|
39
|
+
success: true;
|
|
40
|
+
status: 'queued' | 'processing' | 'completed' | 'partial' | 'failed';
|
|
41
|
+
capability: 'company_signals' | 'signal_to_copy';
|
|
42
|
+
jobId: string;
|
|
43
|
+
idempotencyKey: string;
|
|
44
|
+
total: number;
|
|
45
|
+
nextPollAfterSeconds?: number;
|
|
18
46
|
}
|
|
19
47
|
interface BatchItemResult<T> {
|
|
20
48
|
index: number;
|
|
@@ -41,6 +69,8 @@ interface BatchItemResult<T> {
|
|
|
41
69
|
jobId?: string;
|
|
42
70
|
/** Machine-readable recovery action returned by Signaliz. */
|
|
43
71
|
suggestedAction?: string;
|
|
72
|
+
cachePublicationStatus?: 'completed' | 'pending' | 'pending_safe_retry' | 'superseded_by_newer_verdict';
|
|
73
|
+
cachePublicationRetryEligible?: boolean;
|
|
44
74
|
/** Zero-based input index containing the full result for this exact duplicate. */
|
|
45
75
|
duplicateOf?: number;
|
|
46
76
|
}
|
|
@@ -110,17 +140,26 @@ interface FindEmailResult {
|
|
|
110
140
|
lastName?: string;
|
|
111
141
|
confidence: number;
|
|
112
142
|
verificationStatus: string;
|
|
143
|
+
deliverabilityStatus: string;
|
|
144
|
+
verificationVerdict: string;
|
|
113
145
|
isVerified: boolean;
|
|
114
146
|
isVerifiedForSending: boolean;
|
|
147
|
+
isDeliverable: boolean;
|
|
115
148
|
isCatchAll: boolean;
|
|
116
149
|
verificationFreshness: 'fresh' | 'stale' | 'unknown';
|
|
117
150
|
verificationAgeDays: number | null;
|
|
118
151
|
verifiedAt: string | null;
|
|
119
152
|
needsReverification: boolean;
|
|
120
153
|
providerUsed: string;
|
|
154
|
+
verificationSource: string;
|
|
155
|
+
/** ISO timestamp when the provider observed the winning verdict. */
|
|
156
|
+
verificationObservedAt?: string;
|
|
157
|
+
failureReason: string;
|
|
121
158
|
creditsUsed?: number;
|
|
122
159
|
estimatedExternalCostUsd?: number;
|
|
123
160
|
billingMetadata?: Record<string, unknown>;
|
|
161
|
+
/** Original provider-work billing receipt when this request only recovered a completed run. */
|
|
162
|
+
historicalBillingMetadata?: Record<string, unknown>;
|
|
124
163
|
resultReturnedFrom?: string;
|
|
125
164
|
cacheHit?: boolean;
|
|
126
165
|
/** True when a definitive no-email result came from the short-lived negative cache. */
|
|
@@ -140,6 +179,8 @@ interface FindEmailResult {
|
|
|
140
179
|
runId?: string;
|
|
141
180
|
nextPollAfterSeconds?: number;
|
|
142
181
|
suggestedAction?: string;
|
|
182
|
+
cachePublicationStatus?: 'completed' | 'pending' | 'pending_safe_retry' | 'superseded_by_newer_verdict';
|
|
183
|
+
cachePublicationRetryEligible?: boolean;
|
|
143
184
|
raw: Record<string, unknown>;
|
|
144
185
|
}
|
|
145
186
|
interface VerifyEmailResult {
|
|
@@ -160,13 +201,25 @@ interface VerifyEmailResult {
|
|
|
160
201
|
isCatchAll: boolean;
|
|
161
202
|
/** Explicit send-safety verdict. Missing or false never becomes true by inference. */
|
|
162
203
|
verifiedForSending: boolean;
|
|
204
|
+
verificationStatus?: string;
|
|
205
|
+
deliverabilityStatus?: string;
|
|
163
206
|
verificationVerdict: string;
|
|
207
|
+
isRoleAccount?: boolean;
|
|
208
|
+
quality?: string | null;
|
|
209
|
+
recommendation?: string;
|
|
210
|
+
smtpStatus?: string;
|
|
211
|
+
providerStatus?: string;
|
|
212
|
+
failureReason?: string;
|
|
164
213
|
confidenceScore: number;
|
|
165
214
|
provider?: string;
|
|
166
215
|
verificationSource?: string;
|
|
216
|
+
/** ISO timestamp when the provider observed the winning verdict. */
|
|
217
|
+
verificationObservedAt?: string;
|
|
167
218
|
billingReplayed?: boolean;
|
|
168
219
|
creditsUsed?: number;
|
|
169
220
|
billingMetadata?: Record<string, unknown>;
|
|
221
|
+
/** Original provider-work billing receipt when this request only recovered a completed run. */
|
|
222
|
+
historicalBillingMetadata?: Record<string, unknown>;
|
|
170
223
|
resultReturnedFrom?: string;
|
|
171
224
|
cacheHit?: boolean;
|
|
172
225
|
/** True when a conclusive send-blocking verdict came from the short-lived rejection cache. */
|
|
@@ -178,6 +231,13 @@ interface VerifyEmailResult {
|
|
|
178
231
|
liveProviderCalled?: boolean;
|
|
179
232
|
openrouterCalled?: boolean;
|
|
180
233
|
byoOpenrouterUsed?: boolean;
|
|
234
|
+
estimatedExternalCostUsd?: number;
|
|
235
|
+
/** Canonical run ID alias returned alongside verificationRunId when available. */
|
|
236
|
+
runId?: string;
|
|
237
|
+
/** Whether the billed terminal verdict was durably published for Find Email reuse. */
|
|
238
|
+
cachePublicationStatus?: 'completed' | 'pending' | 'pending_safe_retry' | 'superseded_by_newer_verdict';
|
|
239
|
+
cachePublicationRetryEligible?: boolean;
|
|
240
|
+
suggestedAction?: string;
|
|
181
241
|
raw: Record<string, unknown>;
|
|
182
242
|
}
|
|
183
243
|
interface VerifyEmailOptions {
|
|
@@ -198,6 +258,13 @@ interface VerifyEmailOptions {
|
|
|
198
258
|
}
|
|
199
259
|
interface VerifyEmailBatchOptions extends BatchOptions, VerifyEmailOptions {
|
|
200
260
|
}
|
|
261
|
+
interface VerifyEmailBatchInput {
|
|
262
|
+
email: string;
|
|
263
|
+
/** Override the batch-level cache policy for this address. */
|
|
264
|
+
skipCache?: boolean;
|
|
265
|
+
/** Stable retry key scoped to this address. */
|
|
266
|
+
idempotencyKey?: string;
|
|
267
|
+
}
|
|
201
268
|
interface CompanySignalEnrichmentParams {
|
|
202
269
|
/** Resume an existing enrichment without creating another provider run. */
|
|
203
270
|
signalRunId?: string;
|
|
@@ -217,11 +284,11 @@ interface CompanySignalEnrichmentParams {
|
|
|
217
284
|
skipCache?: boolean;
|
|
218
285
|
/** Include all evaluated evidence candidates, including rejected diagnostics. Defaults to selected-signal evidence only. */
|
|
219
286
|
includeCandidateEvidence?: boolean;
|
|
220
|
-
/** @deprecated Company
|
|
287
|
+
/** @deprecated Single Company Signal calls are synchronous; batch recovery is managed automatically. */
|
|
221
288
|
waitForResult?: boolean;
|
|
222
289
|
/** Maximum server-side synchronous execution window. */
|
|
223
290
|
maxWaitMs?: number;
|
|
224
|
-
/** @deprecated Company
|
|
291
|
+
/** @deprecated Company Signal batch polling is managed automatically. */
|
|
225
292
|
pollIntervalMs?: number;
|
|
226
293
|
/** Return a no-spend plan without provider calls or jobs. */
|
|
227
294
|
dryRun?: boolean;
|
|
@@ -383,10 +450,10 @@ interface SignalToCopyParams {
|
|
|
383
450
|
skipCache?: boolean;
|
|
384
451
|
/** Use the full deep-research provider portfolio. The default uses bounded credit-free first-party and Bing grounding. */
|
|
385
452
|
enableDeepSearch?: boolean;
|
|
386
|
-
/** @deprecated Signal to Copy
|
|
453
|
+
/** @deprecated Single Signal to Copy calls are synchronous; batch recovery is managed automatically. */
|
|
387
454
|
waitForResult?: boolean;
|
|
388
455
|
maxWaitMs?: number;
|
|
389
|
-
/** @deprecated Signal
|
|
456
|
+
/** @deprecated Signal Copy batch polling is managed automatically. */
|
|
390
457
|
pollIntervalMs?: number;
|
|
391
458
|
/** Return a no-spend plan without provider calls or jobs. */
|
|
392
459
|
dryRun?: boolean;
|
|
@@ -427,6 +494,8 @@ interface SignalToCopyResult {
|
|
|
427
494
|
liveProviderCalled?: boolean;
|
|
428
495
|
aiProviderCalled?: boolean;
|
|
429
496
|
byoAiUsed?: boolean;
|
|
497
|
+
unlimitedSignalToCopy?: boolean;
|
|
498
|
+
signalToCopyEntitlement?: 'unlimited' | 'standard';
|
|
430
499
|
variations: SignalToCopyVariation[];
|
|
431
500
|
raw: Record<string, unknown>;
|
|
432
501
|
}
|
|
@@ -462,14 +531,16 @@ declare class Signaliz {
|
|
|
462
531
|
dryRun: true;
|
|
463
532
|
}): Promise<CoreProductDryRunResult>;
|
|
464
533
|
findEmails(params: FindEmailParams[], options?: BatchOptions): Promise<BatchResult<FindEmailResult>>;
|
|
534
|
+
resumeFindEmailBatch(jobId: string, options?: CoreEmailBatchResumeOptions): Promise<BatchResult<FindEmailResult>>;
|
|
465
535
|
verifyEmail(email: string | undefined, options: VerifyEmailOptions & {
|
|
466
536
|
dryRun: true;
|
|
467
537
|
}): Promise<CoreProductDryRunResult>;
|
|
468
538
|
verifyEmail(email: string | undefined, options?: VerifyEmailOptions): Promise<VerifyEmailResult>;
|
|
469
|
-
verifyEmails(emails: string
|
|
539
|
+
verifyEmails(emails: Array<string | VerifyEmailBatchInput>, options: VerifyEmailBatchOptions & {
|
|
470
540
|
dryRun: true;
|
|
471
541
|
}): Promise<CoreProductDryRunResult>;
|
|
472
|
-
verifyEmails(emails: string
|
|
542
|
+
verifyEmails(emails: Array<string | VerifyEmailBatchInput>, options?: VerifyEmailBatchOptions): Promise<BatchResult<VerifyEmailResult>>;
|
|
543
|
+
resumeVerifyEmailBatch(jobId: string, options?: CoreEmailBatchResumeOptions): Promise<BatchResult<VerifyEmailResult>>;
|
|
473
544
|
enrichCompanySignals(params: CompanySignalEnrichmentParams & {
|
|
474
545
|
dryRun: true;
|
|
475
546
|
}): Promise<CoreProductDryRunResult>;
|
|
@@ -478,7 +549,11 @@ declare class Signaliz {
|
|
|
478
549
|
enrichCompanies(companies: CompanySignalEnrichmentParams[], options: BatchOptions & {
|
|
479
550
|
dryRun: true;
|
|
480
551
|
}): Promise<CoreProductDryRunResult>;
|
|
552
|
+
enrichCompanies(companies: CompanySignalEnrichmentParams[], options: BatchOptions & {
|
|
553
|
+
waitForResult: false;
|
|
554
|
+
}): Promise<RecoverableBatchJob>;
|
|
481
555
|
enrichCompanies(companies: CompanySignalEnrichmentParams[], options?: BatchOptions): Promise<BatchResult<CompanySignalEnrichmentResult>>;
|
|
556
|
+
resumeCompanySignalBatch(jobId: string, options?: CoreBatchResumeOptions): Promise<BatchResult<CompanySignalEnrichmentResult>>;
|
|
482
557
|
signalToCopy(params: SignalToCopyParams & {
|
|
483
558
|
dryRun: true;
|
|
484
559
|
}): Promise<CoreProductDryRunResult>;
|
|
@@ -486,14 +561,20 @@ declare class Signaliz {
|
|
|
486
561
|
createSignalCopyBatch(requests: SignalToCopyParams[], options: BatchOptions & {
|
|
487
562
|
dryRun: true;
|
|
488
563
|
}): Promise<CoreProductDryRunResult>;
|
|
564
|
+
createSignalCopyBatch(requests: SignalToCopyParams[], options: BatchOptions & {
|
|
565
|
+
waitForResult: false;
|
|
566
|
+
}): Promise<RecoverableBatchJob>;
|
|
489
567
|
createSignalCopyBatch(requests: SignalToCopyParams[], options?: BatchOptions): Promise<BatchResult<SignalToCopyResult>>;
|
|
568
|
+
resumeSignalCopyBatch(jobId: string, options?: CoreBatchResumeOptions): Promise<BatchResult<SignalToCopyResult>>;
|
|
490
569
|
private runCoreProductDryRun;
|
|
491
570
|
private runSignalCopyBatchChunks;
|
|
492
571
|
private runRecoverableCoreBatchJob;
|
|
572
|
+
private submitRecoverableCoreBatchJob;
|
|
573
|
+
private readRecoverableCoreBatchJob;
|
|
493
574
|
private runSignalCopyBatchChunk;
|
|
494
575
|
private runCoreBatchRound;
|
|
495
576
|
listTools(): Promise<MCPToolInfo[]>;
|
|
496
577
|
health(): Promise<PlatformHealth>;
|
|
497
578
|
}
|
|
498
579
|
|
|
499
|
-
export { type BatchItemResult, type BatchOptions, type BatchResult, type CompanySignal, type CompanySignalEnrichmentParams, type CompanySignalEnrichmentResult, type ErrorType, type FindEmailParams, type FindEmailResult, type MCPToolInfo, type PlatformHealth, type SignalDiscoveryParams, type SignalDiscoveryResult, type SignalDiscoverySignal, type SignalDiscoverySource, type SignalDiscoveryStatus, type SignalToCopyParams, type SignalToCopyResult, type SignalToCopyVariation, Signaliz, type SignalizConfig, SignalizError, type SignalizErrorData, type VerifyEmailBatchOptions, type VerifyEmailOptions, type VerifyEmailResult };
|
|
580
|
+
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 };
|