import { APIResource } from "../../../../core/resource.js"; import { APIPromise } from "../../../../core/api-promise.js"; import { RequestOptions } from "../../../../internal/request-options.js"; export declare class BaseCancel extends APIResource { static readonly _key: readonly ['emailSecurity', 'investigate', 'bulk', 'cancel']; /** * Marks the job as cancelled and stops any pending message processing. The job * record remains visible in list and detail endpoints. * * @example * ```ts * const cancel = * await client.emailSecurity.investigate.bulk.cancel.create( * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', * { account_id: '023e105f4ecef8ad9ca31a8372d0c353' }, * ); * ``` */ create(jobID: string, params: CancelCreateParams, options?: RequestOptions): APIPromise; } export declare class Cancel extends BaseCancel { } export interface CancelCreateResponse { action_params: CancelCreateResponse.Move | CancelCreateResponse.Release; action_type: 'MOVE' | 'RELEASE'; created_at: string; job_id: string; messages_failed: number; messages_pending: number; messages_successful: number; search_params: CancelCreateResponse.SearchParams; status: 'PENDING' | 'DISCOVERING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'SKIPPED'; total_messages_discovered: number; comment?: string | null; completed_at?: string | null; started_at?: string | null; status_message?: string | null; } export declare namespace CancelCreateResponse { interface Move { destination: 'Inbox' | 'JunkEmail' | 'DeletedItems' | 'RecoverableItemsDeletions' | 'RecoverableItemsPurges'; type: 'MOVE'; expected_disposition?: 'MALICIOUS' | 'MALICIOUS-BEC' | 'SUSPICIOUS' | 'SPOOF' | 'SPAM' | 'BULK' | 'ENCRYPTED' | 'EXTERNAL' | 'UNKNOWN' | 'NONE'; } interface Release { type: 'RELEASE'; } interface SearchParams { /** * @deprecated Deprecated, use `GET /investigate/{investigate_id}/action_log` * instead. End of life: November 1, 2026. */ action_log?: boolean; alert_id?: string | null; /** * Delivery status of the message. */ delivery_status?: 'delivered' | 'moved' | 'quarantined' | 'rejected' | 'deferred' | 'bounced' | 'queued'; detections_only?: boolean; domain?: string | null; /** * End of search date range */ end?: string; exact_subject?: string | null; final_disposition?: 'MALICIOUS' | 'MALICIOUS-BEC' | 'SUSPICIOUS' | 'SPOOF' | 'SPAM' | 'BULK' | 'ENCRYPTED' | 'EXTERNAL' | 'UNKNOWN' | 'NONE'; message_action?: 'PREVIEW' | 'QUARANTINE_RELEASED' | 'MOVED' | null; message_id?: string | null; metric?: string | null; query?: string | null; recipient?: string | null; sender?: string | null; /** * Beginning of search date range */ start?: string; subject?: string | null; submissions?: boolean; } } export interface CancelCreateParams { /** * Identifier. */ account_id: string; } export declare namespace Cancel { export { type CancelCreateResponse as CancelCreateResponse, type CancelCreateParams as CancelCreateParams }; } //# sourceMappingURL=cancel.d.ts.map