@signaliz/sdk 1.0.46 → 1.0.48

package/dist/index.d.mts

@@ -13,6 +13,8 @@ interface BatchOptions {
     idempotencyKey?: string;
     /** Return exact repeated successes as duplicateOf references. Defaults to false. */
     compactDuplicates?: boolean;
+    /** Return one no-spend plan for the full batch without provider calls or jobs. */
+    dryRun?: boolean;
 }
 interface BatchItemResult<T> {
     index: number;
@@ -43,6 +45,23 @@ interface SignalizErrorData {
     retryAfter?: number;
     details?: Record<string, unknown>;
 }
+interface CoreProductDryRunResult {
+    success: true;
+    dryRun: true;
+    status: 'planned';
+    capability: string;
+    inputCount: number;
+    recoveryReadCount: number;
+    plan: Record<string, unknown>;
+    estimate: Record<string, unknown>;
+    estimatedCredits: {
+        min: number;
+        max: number;
+    };
+    creditsCharged: 0;
+    sideEffects: unknown[];
+    raw: Record<string, unknown>;
+}
 interface FindEmailParams {
     companyDomain: string;
     fullName?: string;
@@ -52,6 +71,10 @@ interface FindEmailParams {
     companyName?: string;
     /** Bypass cached email and verification data for a fresh-provider run. */
     skipCache?: boolean;
+    /** Return a no-spend plan without provider calls or jobs. */
+    dryRun?: boolean;
+    /** Stable retry key for recovering the same request after an ambiguous response. */
+    idempotencyKey?: string;
 }
 interface FindEmailResult {
     success: boolean;
@@ -100,6 +123,10 @@ interface VerifyEmailOptions {
     maxWaitMs?: number;
     /** Override the server-provided polling delay. */
     pollIntervalMs?: number;
+    /** Return a no-spend plan without provider calls or jobs. */
+    dryRun?: boolean;
+    /** Stable retry key for recovering the same request after an ambiguous response. */
+    idempotencyKey?: string;
 }
 interface VerifyEmailBatchOptions extends BatchOptions, VerifyEmailOptions {
 }
@@ -114,16 +141,22 @@ interface CompanySignalEnrichmentParams {
     lookbackDays?: number;
     online?: boolean;
     enableDeepSearch?: boolean;
+    /** Web coverage policy. Balanced targets an average all-in search budget below one cent. */
+    searchMode?: 'fast' | 'balanced' | 'coverage';
     includeSummary?: boolean;
     enableOutreachIntelligence?: boolean;
     enablePredictiveIntelligence?: boolean;
     skipCache?: boolean;
-    /** Wait for a queued Trigger.dev enrichment to finish. Defaults to true. */
+    /** @deprecated Company Signals is always synchronous; this option is ignored. */
     waitForResult?: boolean;
-    /** Maximum time to wait for a queued enrichment. Defaults to 20 minutes. */
+    /** Maximum server-side synchronous execution window. */
     maxWaitMs?: number;
-    /** Delay between queued-enrichment status checks. Defaults to 2 seconds. */
+    /** @deprecated Company Signals never returns a polling contract. */
     pollIntervalMs?: number;
+    /** Return a no-spend plan without provider calls or jobs. */
+    dryRun?: boolean;
+    /** Stable retry key for recovering the same request after an ambiguous response. */
+    idempotencyKey?: string;
 }
 interface CompanySignal {
     id?: string;
@@ -183,9 +216,15 @@ interface SignalToCopyParams {
     skipCache?: boolean;
     /** Opt into slower deep research. Defaults to false. */
     enableDeepSearch?: boolean;
+    /** @deprecated Signal to Copy is always synchronous; this option is ignored. */
     waitForResult?: boolean;
     maxWaitMs?: number;
+    /** @deprecated Signal to Copy never returns a polling contract. */
     pollIntervalMs?: number;
+    /** Return a no-spend plan without provider calls or jobs. */
+    dryRun?: boolean;
+    /** Stable retry key for recovering the same request after an ambiguous response. */
+    idempotencyKey?: string;
 }
 interface SignalToCopyVariation {
     style: 'signal_led' | 'business_case' | 'predictive';
@@ -237,16 +276,40 @@ declare class SignalizError extends Error {
 declare class Signaliz {
     private readonly client;
     constructor(config: SignalizConfig);
+    findEmail(params: FindEmailParams & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     findEmail(params: FindEmailParams): Promise<FindEmailResult>;
+    findEmails(params: FindEmailParams[], options: BatchOptions & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     findEmails(params: FindEmailParams[], options?: BatchOptions): Promise<BatchResult<FindEmailResult>>;
+    verifyEmail(email: string | undefined, options: VerifyEmailOptions & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     verifyEmail(email: string | undefined, options?: VerifyEmailOptions): Promise<VerifyEmailResult>;
+    verifyEmails(emails: string[], options: VerifyEmailBatchOptions & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     verifyEmails(emails: string[], options?: VerifyEmailBatchOptions): Promise<BatchResult<VerifyEmailResult>>;
+    enrichCompanySignals(params: CompanySignalEnrichmentParams & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     enrichCompanySignals(params: CompanySignalEnrichmentParams): Promise<CompanySignalEnrichmentResult>;
+    enrichCompanies(companies: CompanySignalEnrichmentParams[], options: BatchOptions & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     enrichCompanies(companies: CompanySignalEnrichmentParams[], options?: BatchOptions): Promise<BatchResult<CompanySignalEnrichmentResult>>;
+    signalToCopy(params: SignalToCopyParams & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     signalToCopy(params: SignalToCopyParams): Promise<SignalToCopyResult>;
+    createSignalCopyBatch(requests: SignalToCopyParams[], options: BatchOptions & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     createSignalCopyBatch(requests: SignalToCopyParams[], options?: BatchOptions): Promise<BatchResult<SignalToCopyResult>>;
+    private runCoreProductDryRun;
     private runSignalCopyBatchChunks;
-    private runAvailableSignalCopyBatchJob;
     private runRecoverableCoreBatchJob;
     private runSignalCopyBatchChunk;
     private runCoreBatchRound;

package/dist/index.d.ts

@@ -13,6 +13,8 @@ interface BatchOptions {
     idempotencyKey?: string;
     /** Return exact repeated successes as duplicateOf references. Defaults to false. */
     compactDuplicates?: boolean;
+    /** Return one no-spend plan for the full batch without provider calls or jobs. */
+    dryRun?: boolean;
 }
 interface BatchItemResult<T> {
     index: number;
@@ -43,6 +45,23 @@ interface SignalizErrorData {
     retryAfter?: number;
     details?: Record<string, unknown>;
 }
+interface CoreProductDryRunResult {
+    success: true;
+    dryRun: true;
+    status: 'planned';
+    capability: string;
+    inputCount: number;
+    recoveryReadCount: number;
+    plan: Record<string, unknown>;
+    estimate: Record<string, unknown>;
+    estimatedCredits: {
+        min: number;
+        max: number;
+    };
+    creditsCharged: 0;
+    sideEffects: unknown[];
+    raw: Record<string, unknown>;
+}
 interface FindEmailParams {
     companyDomain: string;
     fullName?: string;
@@ -52,6 +71,10 @@ interface FindEmailParams {
     companyName?: string;
     /** Bypass cached email and verification data for a fresh-provider run. */
     skipCache?: boolean;
+    /** Return a no-spend plan without provider calls or jobs. */
+    dryRun?: boolean;
+    /** Stable retry key for recovering the same request after an ambiguous response. */
+    idempotencyKey?: string;
 }
 interface FindEmailResult {
     success: boolean;
@@ -100,6 +123,10 @@ interface VerifyEmailOptions {
     maxWaitMs?: number;
     /** Override the server-provided polling delay. */
     pollIntervalMs?: number;
+    /** Return a no-spend plan without provider calls or jobs. */
+    dryRun?: boolean;
+    /** Stable retry key for recovering the same request after an ambiguous response. */
+    idempotencyKey?: string;
 }
 interface VerifyEmailBatchOptions extends BatchOptions, VerifyEmailOptions {
 }
@@ -114,16 +141,22 @@ interface CompanySignalEnrichmentParams {
     lookbackDays?: number;
     online?: boolean;
     enableDeepSearch?: boolean;
+    /** Web coverage policy. Balanced targets an average all-in search budget below one cent. */
+    searchMode?: 'fast' | 'balanced' | 'coverage';
     includeSummary?: boolean;
     enableOutreachIntelligence?: boolean;
     enablePredictiveIntelligence?: boolean;
     skipCache?: boolean;
-    /** Wait for a queued Trigger.dev enrichment to finish. Defaults to true. */
+    /** @deprecated Company Signals is always synchronous; this option is ignored. */
     waitForResult?: boolean;
-    /** Maximum time to wait for a queued enrichment. Defaults to 20 minutes. */
+    /** Maximum server-side synchronous execution window. */
     maxWaitMs?: number;
-    /** Delay between queued-enrichment status checks. Defaults to 2 seconds. */
+    /** @deprecated Company Signals never returns a polling contract. */
     pollIntervalMs?: number;
+    /** Return a no-spend plan without provider calls or jobs. */
+    dryRun?: boolean;
+    /** Stable retry key for recovering the same request after an ambiguous response. */
+    idempotencyKey?: string;
 }
 interface CompanySignal {
     id?: string;
@@ -183,9 +216,15 @@ interface SignalToCopyParams {
     skipCache?: boolean;
     /** Opt into slower deep research. Defaults to false. */
     enableDeepSearch?: boolean;
+    /** @deprecated Signal to Copy is always synchronous; this option is ignored. */
     waitForResult?: boolean;
     maxWaitMs?: number;
+    /** @deprecated Signal to Copy never returns a polling contract. */
     pollIntervalMs?: number;
+    /** Return a no-spend plan without provider calls or jobs. */
+    dryRun?: boolean;
+    /** Stable retry key for recovering the same request after an ambiguous response. */
+    idempotencyKey?: string;
 }
 interface SignalToCopyVariation {
     style: 'signal_led' | 'business_case' | 'predictive';
@@ -237,16 +276,40 @@ declare class SignalizError extends Error {
 declare class Signaliz {
     private readonly client;
     constructor(config: SignalizConfig);
+    findEmail(params: FindEmailParams & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     findEmail(params: FindEmailParams): Promise<FindEmailResult>;
+    findEmails(params: FindEmailParams[], options: BatchOptions & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     findEmails(params: FindEmailParams[], options?: BatchOptions): Promise<BatchResult<FindEmailResult>>;
+    verifyEmail(email: string | undefined, options: VerifyEmailOptions & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     verifyEmail(email: string | undefined, options?: VerifyEmailOptions): Promise<VerifyEmailResult>;
+    verifyEmails(emails: string[], options: VerifyEmailBatchOptions & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     verifyEmails(emails: string[], options?: VerifyEmailBatchOptions): Promise<BatchResult<VerifyEmailResult>>;
+    enrichCompanySignals(params: CompanySignalEnrichmentParams & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     enrichCompanySignals(params: CompanySignalEnrichmentParams): Promise<CompanySignalEnrichmentResult>;
+    enrichCompanies(companies: CompanySignalEnrichmentParams[], options: BatchOptions & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     enrichCompanies(companies: CompanySignalEnrichmentParams[], options?: BatchOptions): Promise<BatchResult<CompanySignalEnrichmentResult>>;
+    signalToCopy(params: SignalToCopyParams & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     signalToCopy(params: SignalToCopyParams): Promise<SignalToCopyResult>;
+    createSignalCopyBatch(requests: SignalToCopyParams[], options: BatchOptions & {
+        dryRun: true;
+    }): Promise<CoreProductDryRunResult>;
     createSignalCopyBatch(requests: SignalToCopyParams[], options?: BatchOptions): Promise<BatchResult<SignalToCopyResult>>;
+    private runCoreProductDryRun;
     private runSignalCopyBatchChunks;
-    private runAvailableSignalCopyBatchJob;
     private runRecoverableCoreBatchJob;
     private runSignalCopyBatchChunk;
     private runCoreBatchRound;