@signaliz/sdk 1.0.61 → 1.0.62

package/dist/index.d.mts

@@ -15,6 +15,34 @@ interface BatchOptions {
     compactDuplicates?: boolean;
     /** Return one no-spend plan for the full batch without provider calls or jobs. */
     dryRun?: boolean;
+    /** Return a durable Company Signals or Signal to Copy job handle immediately. */
+    waitForResult?: boolean;
+    /** Maximum time to poll a durable job. Company/Copy jobs wait without a fixed deadline when omitted. */
+    maxWaitMs?: number;
+    /** Override the server-provided polling delay for a durable job. */
+    pollIntervalMs?: number;
+}
+interface CoreBatchResumeOptions {
+    /** Requested result page size. The server caps email/Company pages at 25 and Copy pages at 100. */
+    pageSize?: number;
+    /** Maximum time to wait for the existing job. Company/Copy jobs wait without a fixed deadline when omitted. */
+    maxWaitMs?: number;
+    /** Override the server-provided polling delay while the existing job is active. */
+    pollIntervalMs?: number;
+    /** Return duplicate successes as duplicateOf references. Defaults to false. */
+    compactDuplicates?: boolean;
+    /** Original submission key, retained in any timeout recovery metadata. */
+    idempotencyKey?: string;
+}
+type CoreEmailBatchResumeOptions = CoreBatchResumeOptions;
+interface RecoverableBatchJob {
+    success: true;
+    status: 'queued' | 'processing' | 'completed' | 'partial' | 'failed';
+    capability: 'company_signals' | 'signal_to_copy';
+    jobId: string;
+    idempotencyKey: string;
+    total: number;
+    nextPollAfterSeconds?: number;
 }
 interface BatchItemResult<T> {
     index: number;
@@ -41,6 +69,8 @@ interface BatchItemResult<T> {
     jobId?: string;
     /** Machine-readable recovery action returned by Signaliz. */
     suggestedAction?: string;
+    cachePublicationStatus?: 'completed' | 'pending' | 'pending_safe_retry' | 'superseded_by_newer_verdict';
+    cachePublicationRetryEligible?: boolean;
     /** Zero-based input index containing the full result for this exact duplicate. */
     duplicateOf?: number;
 }
@@ -110,17 +140,26 @@ interface FindEmailResult {
     lastName?: string;
     confidence: number;
     verificationStatus: string;
+    deliverabilityStatus: string;
+    verificationVerdict: string;
     isVerified: boolean;
     isVerifiedForSending: boolean;
+    isDeliverable: boolean;
     isCatchAll: boolean;
     verificationFreshness: 'fresh' | 'stale' | 'unknown';
     verificationAgeDays: number | null;
     verifiedAt: string | null;
     needsReverification: boolean;
     providerUsed: string;
+    verificationSource: string;
+    /** ISO timestamp when the provider observed the winning verdict. */
+    verificationObservedAt?: string;
+    failureReason: string;
     creditsUsed?: number;
     estimatedExternalCostUsd?: number;
     billingMetadata?: Record<string, unknown>;
+    /** Original provider-work billing receipt when this request only recovered a completed run. */
+    historicalBillingMetadata?: Record<string, unknown>;
     resultReturnedFrom?: string;
     cacheHit?: boolean;
     /** True when a definitive no-email result came from the short-lived negative cache. */
@@ -140,6 +179,8 @@ interface FindEmailResult {
     runId?: string;
     nextPollAfterSeconds?: number;
     suggestedAction?: string;
+    cachePublicationStatus?: 'completed' | 'pending' | 'pending_safe_retry' | 'superseded_by_newer_verdict';
+    cachePublicationRetryEligible?: boolean;
     raw: Record<string, unknown>;
 }
 interface VerifyEmailResult {
@@ -160,13 +201,25 @@ interface VerifyEmailResult {
     isCatchAll: boolean;
     /** Explicit send-safety verdict. Missing or false never becomes true by inference. */
     verifiedForSending: boolean;
+    verificationStatus?: string;
+    deliverabilityStatus?: string;
     verificationVerdict: string;
+    isRoleAccount?: boolean;
+    quality?: string | null;
+    recommendation?: string;
+    smtpStatus?: string;
+    providerStatus?: string;
+    failureReason?: string;
     confidenceScore: number;
     provider?: string;
     verificationSource?: string;
+    /** ISO timestamp when the provider observed the winning verdict. */
+    verificationObservedAt?: string;
     billingReplayed?: boolean;
     creditsUsed?: number;
     billingMetadata?: Record<string, unknown>;
+    /** Original provider-work billing receipt when this request only recovered a completed run. */
+    historicalBillingMetadata?: Record<string, unknown>;
     resultReturnedFrom?: string;
     cacheHit?: boolean;
     /** True when a conclusive send-blocking verdict came from the short-lived rejection cache. */
@@ -178,6 +231,13 @@ interface VerifyEmailResult {
     liveProviderCalled?: boolean;
     openrouterCalled?: boolean;
     byoOpenrouterUsed?: boolean;
+    estimatedExternalCostUsd?: number;
+    /** Canonical run ID alias returned alongside verificationRunId when available. */
+    runId?: string;
+    /** Whether the billed terminal verdict was durably published for Find Email reuse. */
+    cachePublicationStatus?: 'completed' | 'pending' | 'pending_safe_retry' | 'superseded_by_newer_verdict';
+    cachePublicationRetryEligible?: boolean;
+    suggestedAction?: string;
     raw: Record<string, unknown>;
 }
 interface VerifyEmailOptions {
@@ -198,6 +258,13 @@ interface VerifyEmailOptions {
 }
 interface VerifyEmailBatchOptions extends BatchOptions, VerifyEmailOptions {
 }
+interface VerifyEmailBatchInput {
+    email: string;
+    /** Override the batch-level cache policy for this address. */
+    skipCache?: boolean;
+    /** Stable retry key scoped to this address. */
+    idempotencyKey?: string;
+}
 interface CompanySignalEnrichmentParams {
     /** Resume an existing enrichment without creating another provider run. */
     signalRunId?: string;
@@ -217,11 +284,11 @@ interface CompanySignalEnrichmentParams {
     skipCache?: boolean;
     /** Include all evaluated evidence candidates, including rejected diagnostics. Defaults to selected-signal evidence only. */
     includeCandidateEvidence?: boolean;
-    /** @deprecated Company Signals is always synchronous; this option is ignored. */
+    /** @deprecated Single Company Signal calls are synchronous; batch recovery is managed automatically. */
     waitForResult?: boolean;
     /** Maximum server-side synchronous execution window. */
     maxWaitMs?: number;
-    /** @deprecated Company Signals never returns a polling contract. */
+    /** @deprecated Company Signal batch polling is managed automatically. */
     pollIntervalMs?: number;
     /** Return a no-spend plan without provider calls or jobs. */
     dryRun?: boolean;
@@ -383,10 +450,10 @@ interface SignalToCopyParams {
     skipCache?: boolean;
     /** Use the full deep-research provider portfolio. The default uses bounded credit-free first-party and Bing grounding. */
     enableDeepSearch?: boolean;
-    /** @deprecated Signal to Copy is always synchronous; this option is ignored. */
+    /** @deprecated Single Signal to Copy calls are synchronous; batch recovery is managed automatically. */
     waitForResult?: boolean;
     maxWaitMs?: number;
-    /** @deprecated Signal to Copy never returns a polling contract. */
+    /** @deprecated Signal Copy batch polling is managed automatically. */
     pollIntervalMs?: number;
     /** Return a no-spend plan without provider calls or jobs. */
     dryRun?: boolean;
@@ -462,14 +529,16 @@ declare class Signaliz {
         dryRun: true;
     }): Promise<CoreProductDryRunResult>;
     findEmails(params: FindEmailParams[], options?: BatchOptions): Promise<BatchResult<FindEmailResult>>;
+    resumeFindEmailBatch(jobId: string, options?: CoreEmailBatchResumeOptions): 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 & {
+    verifyEmails(emails: Array<string | VerifyEmailBatchInput>, options: VerifyEmailBatchOptions & {
         dryRun: true;
     }): Promise<CoreProductDryRunResult>;
-    verifyEmails(emails: string[], options?: VerifyEmailBatchOptions): Promise<BatchResult<VerifyEmailResult>>;
+    verifyEmails(emails: Array<string | VerifyEmailBatchInput>, options?: VerifyEmailBatchOptions): Promise<BatchResult<VerifyEmailResult>>;
+    resumeVerifyEmailBatch(jobId: string, options?: CoreEmailBatchResumeOptions): Promise<BatchResult<VerifyEmailResult>>;
     enrichCompanySignals(params: CompanySignalEnrichmentParams & {
         dryRun: true;
     }): Promise<CoreProductDryRunResult>;
@@ -478,7 +547,11 @@ declare class Signaliz {
     enrichCompanies(companies: CompanySignalEnrichmentParams[], options: BatchOptions & {
         dryRun: true;
     }): Promise<CoreProductDryRunResult>;
+    enrichCompanies(companies: CompanySignalEnrichmentParams[], options: BatchOptions & {
+        waitForResult: false;
+    }): Promise<RecoverableBatchJob>;
     enrichCompanies(companies: CompanySignalEnrichmentParams[], options?: BatchOptions): Promise<BatchResult<CompanySignalEnrichmentResult>>;
+    resumeCompanySignalBatch(jobId: string, options?: CoreBatchResumeOptions): Promise<BatchResult<CompanySignalEnrichmentResult>>;
     signalToCopy(params: SignalToCopyParams & {
         dryRun: true;
     }): Promise<CoreProductDryRunResult>;
@@ -486,14 +559,20 @@ declare class Signaliz {
     createSignalCopyBatch(requests: SignalToCopyParams[], options: BatchOptions & {
         dryRun: true;
     }): Promise<CoreProductDryRunResult>;
+    createSignalCopyBatch(requests: SignalToCopyParams[], options: BatchOptions & {
+        waitForResult: false;
+    }): Promise<RecoverableBatchJob>;
     createSignalCopyBatch(requests: SignalToCopyParams[], options?: BatchOptions): Promise<BatchResult<SignalToCopyResult>>;
+    resumeSignalCopyBatch(jobId: string, options?: CoreBatchResumeOptions): Promise<BatchResult<SignalToCopyResult>>;
     private runCoreProductDryRun;
     private runSignalCopyBatchChunks;
     private runRecoverableCoreBatchJob;
+    private submitRecoverableCoreBatchJob;
+    private readRecoverableCoreBatchJob;
     private runSignalCopyBatchChunk;
     private runCoreBatchRound;
     listTools(): Promise<MCPToolInfo[]>;
     health(): Promise<PlatformHealth>;
 }
 
-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 };
+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

@@ -15,6 +15,34 @@ interface BatchOptions {
     compactDuplicates?: boolean;
     /** Return one no-spend plan for the full batch without provider calls or jobs. */
     dryRun?: boolean;
+    /** Return a durable Company Signals or Signal to Copy job handle immediately. */
+    waitForResult?: boolean;
+    /** Maximum time to poll a durable job. Company/Copy jobs wait without a fixed deadline when omitted. */
+    maxWaitMs?: number;
+    /** Override the server-provided polling delay for a durable job. */
+    pollIntervalMs?: number;
+}
+interface CoreBatchResumeOptions {
+    /** Requested result page size. The server caps email/Company pages at 25 and Copy pages at 100. */
+    pageSize?: number;
+    /** Maximum time to wait for the existing job. Company/Copy jobs wait without a fixed deadline when omitted. */
+    maxWaitMs?: number;
+    /** Override the server-provided polling delay while the existing job is active. */
+    pollIntervalMs?: number;
+    /** Return duplicate successes as duplicateOf references. Defaults to false. */
+    compactDuplicates?: boolean;
+    /** Original submission key, retained in any timeout recovery metadata. */
+    idempotencyKey?: string;
+}
+type CoreEmailBatchResumeOptions = CoreBatchResumeOptions;
+interface RecoverableBatchJob {
+    success: true;
+    status: 'queued' | 'processing' | 'completed' | 'partial' | 'failed';
+    capability: 'company_signals' | 'signal_to_copy';
+    jobId: string;
+    idempotencyKey: string;
+    total: number;
+    nextPollAfterSeconds?: number;
 }
 interface BatchItemResult<T> {
     index: number;
@@ -41,6 +69,8 @@ interface BatchItemResult<T> {
     jobId?: string;
     /** Machine-readable recovery action returned by Signaliz. */
     suggestedAction?: string;
+    cachePublicationStatus?: 'completed' | 'pending' | 'pending_safe_retry' | 'superseded_by_newer_verdict';
+    cachePublicationRetryEligible?: boolean;
     /** Zero-based input index containing the full result for this exact duplicate. */
     duplicateOf?: number;
 }
@@ -110,17 +140,26 @@ interface FindEmailResult {
     lastName?: string;
     confidence: number;
     verificationStatus: string;
+    deliverabilityStatus: string;
+    verificationVerdict: string;
     isVerified: boolean;
     isVerifiedForSending: boolean;
+    isDeliverable: boolean;
     isCatchAll: boolean;
     verificationFreshness: 'fresh' | 'stale' | 'unknown';
     verificationAgeDays: number | null;
     verifiedAt: string | null;
     needsReverification: boolean;
     providerUsed: string;
+    verificationSource: string;
+    /** ISO timestamp when the provider observed the winning verdict. */
+    verificationObservedAt?: string;
+    failureReason: string;
     creditsUsed?: number;
     estimatedExternalCostUsd?: number;
     billingMetadata?: Record<string, unknown>;
+    /** Original provider-work billing receipt when this request only recovered a completed run. */
+    historicalBillingMetadata?: Record<string, unknown>;
     resultReturnedFrom?: string;
     cacheHit?: boolean;
     /** True when a definitive no-email result came from the short-lived negative cache. */
@@ -140,6 +179,8 @@ interface FindEmailResult {
     runId?: string;
     nextPollAfterSeconds?: number;
     suggestedAction?: string;
+    cachePublicationStatus?: 'completed' | 'pending' | 'pending_safe_retry' | 'superseded_by_newer_verdict';
+    cachePublicationRetryEligible?: boolean;
     raw: Record<string, unknown>;
 }
 interface VerifyEmailResult {
@@ -160,13 +201,25 @@ interface VerifyEmailResult {
     isCatchAll: boolean;
     /** Explicit send-safety verdict. Missing or false never becomes true by inference. */
     verifiedForSending: boolean;
+    verificationStatus?: string;
+    deliverabilityStatus?: string;
     verificationVerdict: string;
+    isRoleAccount?: boolean;
+    quality?: string | null;
+    recommendation?: string;
+    smtpStatus?: string;
+    providerStatus?: string;
+    failureReason?: string;
     confidenceScore: number;
     provider?: string;
     verificationSource?: string;
+    /** ISO timestamp when the provider observed the winning verdict. */
+    verificationObservedAt?: string;
     billingReplayed?: boolean;
     creditsUsed?: number;
     billingMetadata?: Record<string, unknown>;
+    /** Original provider-work billing receipt when this request only recovered a completed run. */
+    historicalBillingMetadata?: Record<string, unknown>;
     resultReturnedFrom?: string;
     cacheHit?: boolean;
     /** True when a conclusive send-blocking verdict came from the short-lived rejection cache. */
@@ -178,6 +231,13 @@ interface VerifyEmailResult {
     liveProviderCalled?: boolean;
     openrouterCalled?: boolean;
     byoOpenrouterUsed?: boolean;
+    estimatedExternalCostUsd?: number;
+    /** Canonical run ID alias returned alongside verificationRunId when available. */
+    runId?: string;
+    /** Whether the billed terminal verdict was durably published for Find Email reuse. */
+    cachePublicationStatus?: 'completed' | 'pending' | 'pending_safe_retry' | 'superseded_by_newer_verdict';
+    cachePublicationRetryEligible?: boolean;
+    suggestedAction?: string;
     raw: Record<string, unknown>;
 }
 interface VerifyEmailOptions {
@@ -198,6 +258,13 @@ interface VerifyEmailOptions {
 }
 interface VerifyEmailBatchOptions extends BatchOptions, VerifyEmailOptions {
 }
+interface VerifyEmailBatchInput {
+    email: string;
+    /** Override the batch-level cache policy for this address. */
+    skipCache?: boolean;
+    /** Stable retry key scoped to this address. */
+    idempotencyKey?: string;
+}
 interface CompanySignalEnrichmentParams {
     /** Resume an existing enrichment without creating another provider run. */
     signalRunId?: string;
@@ -217,11 +284,11 @@ interface CompanySignalEnrichmentParams {
     skipCache?: boolean;
     /** Include all evaluated evidence candidates, including rejected diagnostics. Defaults to selected-signal evidence only. */
     includeCandidateEvidence?: boolean;
-    /** @deprecated Company Signals is always synchronous; this option is ignored. */
+    /** @deprecated Single Company Signal calls are synchronous; batch recovery is managed automatically. */
     waitForResult?: boolean;
     /** Maximum server-side synchronous execution window. */
     maxWaitMs?: number;
-    /** @deprecated Company Signals never returns a polling contract. */
+    /** @deprecated Company Signal batch polling is managed automatically. */
     pollIntervalMs?: number;
     /** Return a no-spend plan without provider calls or jobs. */
     dryRun?: boolean;
@@ -383,10 +450,10 @@ interface SignalToCopyParams {
     skipCache?: boolean;
     /** Use the full deep-research provider portfolio. The default uses bounded credit-free first-party and Bing grounding. */
     enableDeepSearch?: boolean;
-    /** @deprecated Signal to Copy is always synchronous; this option is ignored. */
+    /** @deprecated Single Signal to Copy calls are synchronous; batch recovery is managed automatically. */
     waitForResult?: boolean;
     maxWaitMs?: number;
-    /** @deprecated Signal to Copy never returns a polling contract. */
+    /** @deprecated Signal Copy batch polling is managed automatically. */
     pollIntervalMs?: number;
     /** Return a no-spend plan without provider calls or jobs. */
     dryRun?: boolean;
@@ -462,14 +529,16 @@ declare class Signaliz {
         dryRun: true;
     }): Promise<CoreProductDryRunResult>;
     findEmails(params: FindEmailParams[], options?: BatchOptions): Promise<BatchResult<FindEmailResult>>;
+    resumeFindEmailBatch(jobId: string, options?: CoreEmailBatchResumeOptions): 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 & {
+    verifyEmails(emails: Array<string | VerifyEmailBatchInput>, options: VerifyEmailBatchOptions & {
         dryRun: true;
     }): Promise<CoreProductDryRunResult>;
-    verifyEmails(emails: string[], options?: VerifyEmailBatchOptions): Promise<BatchResult<VerifyEmailResult>>;
+    verifyEmails(emails: Array<string | VerifyEmailBatchInput>, options?: VerifyEmailBatchOptions): Promise<BatchResult<VerifyEmailResult>>;
+    resumeVerifyEmailBatch(jobId: string, options?: CoreEmailBatchResumeOptions): Promise<BatchResult<VerifyEmailResult>>;
     enrichCompanySignals(params: CompanySignalEnrichmentParams & {
         dryRun: true;
     }): Promise<CoreProductDryRunResult>;
@@ -478,7 +547,11 @@ declare class Signaliz {
     enrichCompanies(companies: CompanySignalEnrichmentParams[], options: BatchOptions & {
         dryRun: true;
     }): Promise<CoreProductDryRunResult>;
+    enrichCompanies(companies: CompanySignalEnrichmentParams[], options: BatchOptions & {
+        waitForResult: false;
+    }): Promise<RecoverableBatchJob>;
     enrichCompanies(companies: CompanySignalEnrichmentParams[], options?: BatchOptions): Promise<BatchResult<CompanySignalEnrichmentResult>>;
+    resumeCompanySignalBatch(jobId: string, options?: CoreBatchResumeOptions): Promise<BatchResult<CompanySignalEnrichmentResult>>;
     signalToCopy(params: SignalToCopyParams & {
         dryRun: true;
     }): Promise<CoreProductDryRunResult>;
@@ -486,14 +559,20 @@ declare class Signaliz {
     createSignalCopyBatch(requests: SignalToCopyParams[], options: BatchOptions & {
         dryRun: true;
     }): Promise<CoreProductDryRunResult>;
+    createSignalCopyBatch(requests: SignalToCopyParams[], options: BatchOptions & {
+        waitForResult: false;
+    }): Promise<RecoverableBatchJob>;
     createSignalCopyBatch(requests: SignalToCopyParams[], options?: BatchOptions): Promise<BatchResult<SignalToCopyResult>>;
+    resumeSignalCopyBatch(jobId: string, options?: CoreBatchResumeOptions): Promise<BatchResult<SignalToCopyResult>>;
     private runCoreProductDryRun;
     private runSignalCopyBatchChunks;
     private runRecoverableCoreBatchJob;
+    private submitRecoverableCoreBatchJob;
+    private readRecoverableCoreBatchJob;
     private runSignalCopyBatchChunk;
     private runCoreBatchRound;
     listTools(): Promise<MCPToolInfo[]>;
     health(): Promise<PlatformHealth>;
 }
 
-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 };
+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 };