import * as S from "@distilled.cloud/core/schema"; import * as API from "@distilled.cloud/core/api"; import { type CloudflareOpError, type CloudflareOpContext } from "../protocol.ts"; import { ResultInfo } from "../pagination.ts"; export type { CloudflareOpError, CloudflareOpContext }; declare const AllowPolicyNotFound_base: S.Class, import("effect/Cause").YieldableError>; export declare class AllowPolicyNotFound extends /*@__PURE__*/ AllowPolicyNotFound_base { } declare const BlockSenderNotFound_base: S.Class, import("effect/Cause").YieldableError>; export declare class BlockSenderNotFound extends /*@__PURE__*/ BlockSenderNotFound_base { } declare const EmailSecurityDomainNotFound_base: S.Class, import("effect/Cause").YieldableError>; export declare class EmailSecurityDomainNotFound extends /*@__PURE__*/ EmailSecurityDomainNotFound_base { } declare const EmailSecurityNotEntitled_base: S.Class, import("effect/Cause").YieldableError>; export declare class EmailSecurityNotEntitled extends /*@__PURE__*/ EmailSecurityNotEntitled_base { } declare const Forbidden_base: S.Class, import("effect/Cause").YieldableError>; export declare class Forbidden extends /*@__PURE__*/ Forbidden_base { } declare const ImpersonationRegistryEntryNotFound_base: S.Class, import("effect/Cause").YieldableError>; export declare class ImpersonationRegistryEntryNotFound extends /*@__PURE__*/ ImpersonationRegistryEntryNotFound_base { } declare const TrustedDomainNotFound_base: S.Class, import("effect/Cause").YieldableError>; export declare class TrustedDomainNotFound extends /*@__PURE__*/ TrustedDomainNotFound_base { } export type InvestigateMoveBulkRequestDestination = "Inbox" | "JunkEmail" | "DeletedItems" | "RecoverableItemsDeletions" | "RecoverableItemsPurges"; export declare const InvestigateMoveBulkRequestDestination: any; export type InvestigateMoveBulkRequestExpectedDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateMoveBulkRequestExpectedDisposition: any; export type InvestigateMoveBulkRequestIdsList = Array; export declare const InvestigateMoveBulkRequestIdsList: S.Schema; export type InvestigateMoveBulkRequestPostfixIdsList = Array; export declare const InvestigateMoveBulkRequestPostfixIdsList: S.Schema; export interface BulkInvestigateMoveRequest { /** Identifier. */ accountId: string; destination: InvestigateMoveBulkRequestDestination | (string & {}); expectedDisposition?: InvestigateMoveBulkRequestExpectedDisposition | (string & {}); /** List of message IDs to move */ ids?: InvestigateMoveBulkRequestIdsList; /** Deprecated, use `ids` instead. End of life: November 1, 2026. List of message IDs to move. */ postfixIds?: InvestigateMoveBulkRequestPostfixIdsList; } export declare const BulkInvestigateMoveRequest: S.Schema; export interface InvestigateMoveBulkResultItem { /** Whether the operation succeeded */ success: boolean; /** When the move operation completed (UTC) */ completedAt?: string | null; /** Deprecated, use `completed_at` instead. End of life: November 1, 2026. */ completedTimestamp?: string | null; /** Destination folder for the message */ destination?: string | null; /** Number of items moved. End of life: November 1, 2026. */ itemCount?: number | null; /** Message identifier */ messageId?: string | null; /** Type of operation performed */ operation?: string | null; /** Recipient email address */ recipient?: string | null; /** Operation status */ status?: string | null; } export declare const InvestigateMoveBulkResultItem: S.Schema; export type InvestigateMoveBulkResultList = Array; export declare const InvestigateMoveBulkResultList: S.Schema; export interface BulkInvestigateMoveResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: InvestigateMoveBulkResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const BulkInvestigateMoveResponse: S.Schema; export type InvestigateReleaseBulkRequestBodyList = Array; export declare const InvestigateReleaseBulkRequestBodyList: S.Schema; export interface BulkInvestigateReleaseRequest { /** Identifier. */ accountId: string; body: InvestigateReleaseBulkRequestBodyList; } export declare const BulkInvestigateReleaseRequest: S.Schema; export type InvestigateReleaseBulkResultItemDeliveredList = Array; export declare const InvestigateReleaseBulkResultItemDeliveredList: S.Schema; export type InvestigateReleaseBulkResultItemFailedList = Array; export declare const InvestigateReleaseBulkResultItemFailedList: S.Schema; export type InvestigateReleaseBulkResultItemUndeliveredList = Array; export declare const InvestigateReleaseBulkResultItemUndeliveredList: S.Schema; export interface InvestigateReleaseBulkResultItem { /** Unique identifier for a message retrieved from investigation */ id: string; delivered?: InvestigateReleaseBulkResultItemDeliveredList | null; failed?: InvestigateReleaseBulkResultItemFailedList | null; /** Deprecated, use `id` instead. End of life: November 1, 2026. */ postfixId?: string | null; undelivered?: InvestigateReleaseBulkResultItemUndeliveredList | null; } export declare const InvestigateReleaseBulkResultItem: S.Schema; export type InvestigateReleaseBulkResultList = Array; export declare const InvestigateReleaseBulkResultList: S.Schema; export interface BulkInvestigateReleaseResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: InvestigateReleaseBulkResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const BulkInvestigateReleaseResponse: S.Schema; export type InvestigateBulkCreateRequestAction = "MOVE" | "RELEASE"; export declare const InvestigateBulkCreateRequestAction: any; export type InvestigateBulkCreateRequestSearchParamsDeliveryStatus = "delivered" | "moved" | "quarantined" | "rejected" | "deferred" | "bounced" | "queued"; export declare const InvestigateBulkCreateRequestSearchParamsDeliveryStatus: any; export type InvestigateBulkCreateRequestSearchParamsFinalDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateBulkCreateRequestSearchParamsFinalDisposition: any; export type InvestigateBulkCreateRequestSearchParamsMessageAction = "PREVIEW" | "QUARANTINE_RELEASED" | "MOVED"; export declare const InvestigateBulkCreateRequestSearchParamsMessageAction: any; export interface InvestigateBulkCreateRequestSearchParams { /** Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of life: November 1, 2026. */ actionLog?: boolean; alertId?: string; /** Delivery status of the message. */ deliveryStatus?: InvestigateBulkCreateRequestSearchParamsDeliveryStatus | (string & {}); detectionsOnly?: boolean; domain?: string; /** End of search date range */ end?: string; exactSubject?: string; finalDisposition?: InvestigateBulkCreateRequestSearchParamsFinalDisposition | (string & {}); messageAction?: InvestigateBulkCreateRequestSearchParamsMessageAction | (string & {}); messageId?: string; metric?: string; query?: string; recipient?: string; sender?: string; /** Beginning of search date range */ start?: string; subject?: string; submissions?: boolean; } export declare const InvestigateBulkCreateRequestSearchParams: S.Schema; export type InvestigateBulkCreateRequestDestination = "Inbox" | "JunkEmail" | "DeletedItems" | "RecoverableItemsDeletions" | "RecoverableItemsPurges"; export declare const InvestigateBulkCreateRequestDestination: any; export type InvestigateBulkCreateRequestExpectedDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateBulkCreateRequestExpectedDisposition: any; export interface CreateInvestigateBulkRequest { /** Identifier. */ accountId: string; action: InvestigateBulkCreateRequestAction | (string & {}); searchParams: InvestigateBulkCreateRequestSearchParams; comment?: string; destination?: InvestigateBulkCreateRequestDestination | (string & {}); expectedDisposition?: InvestigateBulkCreateRequestExpectedDisposition | (string & {}); } export declare const CreateInvestigateBulkRequest: S.Schema; export type InvestigateBulkCreateResponseActionParamsMoveDestination = "Inbox" | "JunkEmail" | "DeletedItems" | "RecoverableItemsDeletions" | "RecoverableItemsPurges"; export declare const InvestigateBulkCreateResponseActionParamsMoveDestination: any; export type InvestigateBulkCreateResponseActionParamsMoveType = "MOVE"; export declare const InvestigateBulkCreateResponseActionParamsMoveType: any; export type InvestigateBulkCreateResponseActionParamsMoveExpectedDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateBulkCreateResponseActionParamsMoveExpectedDisposition: any; export interface InvestigateBulkCreateResponseActionParamsMove { destination: InvestigateBulkCreateResponseActionParamsMoveDestination; type: InvestigateBulkCreateResponseActionParamsMoveType; expectedDisposition?: InvestigateBulkCreateResponseActionParamsMoveExpectedDisposition | null; } export declare const InvestigateBulkCreateResponseActionParamsMove: S.Schema; export type InvestigateBulkCreateResponseActionParamsReleaseType = "RELEASE"; export declare const InvestigateBulkCreateResponseActionParamsReleaseType: any; export interface InvestigateBulkCreateResponseActionParamsRelease { type: InvestigateBulkCreateResponseActionParamsReleaseType; } export declare const InvestigateBulkCreateResponseActionParamsRelease: S.Schema; export type InvestigateBulkCreateResponseActionParams = InvestigateBulkCreateResponseActionParamsMove | InvestigateBulkCreateResponseActionParamsRelease; export declare const InvestigateBulkCreateResponseActionParams: any; export type InvestigateBulkCreateResponseActionType = "MOVE" | "RELEASE"; export declare const InvestigateBulkCreateResponseActionType: any; export type InvestigateBulkCreateResponseSearchParamsDeliveryStatus = "delivered" | "moved" | "quarantined" | "rejected" | "deferred" | "bounced" | "queued"; export declare const InvestigateBulkCreateResponseSearchParamsDeliveryStatus: any; export type InvestigateBulkCreateResponseSearchParamsFinalDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateBulkCreateResponseSearchParamsFinalDisposition: any; export type InvestigateBulkCreateResponseSearchParamsMessageAction = "PREVIEW" | "QUARANTINE_RELEASED" | "MOVED"; export declare const InvestigateBulkCreateResponseSearchParamsMessageAction: any; export interface InvestigateBulkCreateResponseSearchParams { /** Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of life: November 1, 2026. */ actionLog?: boolean | null; alertId?: string | null; /** Delivery status of the message. */ deliveryStatus?: InvestigateBulkCreateResponseSearchParamsDeliveryStatus | null; detectionsOnly?: boolean | null; domain?: string | null; /** End of search date range */ end?: string | null; exactSubject?: string | null; finalDisposition?: InvestigateBulkCreateResponseSearchParamsFinalDisposition | null; messageAction?: InvestigateBulkCreateResponseSearchParamsMessageAction | null; messageId?: string | null; metric?: string | null; query?: string | null; recipient?: string | null; sender?: string | null; /** Beginning of search date range */ start?: string | null; subject?: string | null; submissions?: boolean | null; } export declare const InvestigateBulkCreateResponseSearchParams: S.Schema; export type InvestigateBulkCreateResponseStatus = "PENDING" | "DISCOVERING" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED" | "SKIPPED"; export declare const InvestigateBulkCreateResponseStatus: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface CreateInvestigateBulkResponse { actionParams: InvestigateBulkCreateResponseActionParams; actionType: InvestigateBulkCreateResponseActionType; createdAt: string; jobId: string; messagesFailed: number; messagesPending: number; messagesSuccessful: number; searchParams: InvestigateBulkCreateResponseSearchParams; status: InvestigateBulkCreateResponseStatus; totalMessagesDiscovered: number; comment?: string | null; completedAt?: string | null; startedAt?: string | null; statusMessage?: string | null; } export declare const CreateInvestigateBulkResponse: S.Schema; export interface CreateInvestigateBulkCancelRequest { /** Identifier. */ accountId: string; jobId: string; } export declare const CreateInvestigateBulkCancelRequest: S.Schema; export type InvestigateBulkCancelCreateResponseActionParamsMoveDestination = "Inbox" | "JunkEmail" | "DeletedItems" | "RecoverableItemsDeletions" | "RecoverableItemsPurges"; export declare const InvestigateBulkCancelCreateResponseActionParamsMoveDestination: any; export type InvestigateBulkCancelCreateResponseActionParamsMoveType = "MOVE"; export declare const InvestigateBulkCancelCreateResponseActionParamsMoveType: any; export type InvestigateBulkCancelCreateResponseActionParamsMoveExpectedDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateBulkCancelCreateResponseActionParamsMoveExpectedDisposition: any; export interface InvestigateBulkCancelCreateResponseActionParamsMove { destination: InvestigateBulkCancelCreateResponseActionParamsMoveDestination; type: InvestigateBulkCancelCreateResponseActionParamsMoveType; expectedDisposition?: InvestigateBulkCancelCreateResponseActionParamsMoveExpectedDisposition | null; } export declare const InvestigateBulkCancelCreateResponseActionParamsMove: S.Schema; export type InvestigateBulkCancelCreateResponseActionParamsReleaseType = "RELEASE"; export declare const InvestigateBulkCancelCreateResponseActionParamsReleaseType: any; export interface InvestigateBulkCancelCreateResponseActionParamsRelease { type: InvestigateBulkCancelCreateResponseActionParamsReleaseType; } export declare const InvestigateBulkCancelCreateResponseActionParamsRelease: S.Schema; export type InvestigateBulkCancelCreateResponseActionParams = InvestigateBulkCancelCreateResponseActionParamsMove | InvestigateBulkCancelCreateResponseActionParamsRelease; export declare const InvestigateBulkCancelCreateResponseActionParams: any; export type InvestigateBulkCancelCreateResponseActionType = "MOVE" | "RELEASE"; export declare const InvestigateBulkCancelCreateResponseActionType: any; export type InvestigateBulkCancelCreateResponseSearchParamsDeliveryStatus = "delivered" | "moved" | "quarantined" | "rejected" | "deferred" | "bounced" | "queued"; export declare const InvestigateBulkCancelCreateResponseSearchParamsDeliveryStatus: any; export type InvestigateBulkCancelCreateResponseSearchParamsFinalDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateBulkCancelCreateResponseSearchParamsFinalDisposition: any; export type InvestigateBulkCancelCreateResponseSearchParamsMessageAction = "PREVIEW" | "QUARANTINE_RELEASED" | "MOVED"; export declare const InvestigateBulkCancelCreateResponseSearchParamsMessageAction: any; export interface InvestigateBulkCancelCreateResponseSearchParams { /** Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of life: November 1, 2026. */ actionLog?: boolean | null; alertId?: string | null; /** Delivery status of the message. */ deliveryStatus?: InvestigateBulkCancelCreateResponseSearchParamsDeliveryStatus | null; detectionsOnly?: boolean | null; domain?: string | null; /** End of search date range */ end?: string | null; exactSubject?: string | null; finalDisposition?: InvestigateBulkCancelCreateResponseSearchParamsFinalDisposition | null; messageAction?: InvestigateBulkCancelCreateResponseSearchParamsMessageAction | null; messageId?: string | null; metric?: string | null; query?: string | null; recipient?: string | null; sender?: string | null; /** Beginning of search date range */ start?: string | null; subject?: string | null; submissions?: boolean | null; } export declare const InvestigateBulkCancelCreateResponseSearchParams: S.Schema; export type InvestigateBulkCancelCreateResponseStatus = "PENDING" | "DISCOVERING" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED" | "SKIPPED"; export declare const InvestigateBulkCancelCreateResponseStatus: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface CreateInvestigateBulkCancelResponse { actionParams: InvestigateBulkCancelCreateResponseActionParams; actionType: InvestigateBulkCancelCreateResponseActionType; createdAt: string; jobId: string; messagesFailed: number; messagesPending: number; messagesSuccessful: number; searchParams: InvestigateBulkCancelCreateResponseSearchParams; status: InvestigateBulkCancelCreateResponseStatus; totalMessagesDiscovered: number; comment?: string | null; completedAt?: string | null; startedAt?: string | null; statusMessage?: string | null; } export declare const CreateInvestigateBulkCancelResponse: S.Schema; export type InvestigateMoveCreateRequestDestination = "Inbox" | "JunkEmail" | "DeletedItems" | "RecoverableItemsDeletions" | "RecoverableItemsPurges"; export declare const InvestigateMoveCreateRequestDestination: any; export type InvestigateMoveCreateRequestExpectedDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateMoveCreateRequestExpectedDisposition: any; export interface CreateInvestigateMoveRequest { /** Identifier. */ accountId: string; /** Unique identifier for a message retrieved from investigation */ investigateId: string; destination: InvestigateMoveCreateRequestDestination | (string & {}); expectedDisposition?: InvestigateMoveCreateRequestExpectedDisposition | (string & {}); } export declare const CreateInvestigateMoveRequest: S.Schema; export type InvestigateMoveCreateResultItem = InvestigateMoveBulkResultItem; export declare const InvestigateMoveCreateResultItem: S.Schema; export type InvestigateMoveCreateResultList = Array; export declare const InvestigateMoveCreateResultList: S.Schema; export interface CreateInvestigateMoveResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: InvestigateMoveCreateResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const CreateInvestigateMoveResponse: S.Schema; export interface CreateInvestigatePreviewRequest { /** Identifier. */ accountId: string; /** The identifier of the message */ postfixId: string; } export declare const CreateInvestigatePreviewRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface CreateInvestigatePreviewResponse { /** A base64 encoded PNG image of the email. */ screenshot: string; } export declare const CreateInvestigatePreviewResponse: S.Schema; export type InvestigateReclassifyCreateRequestExpectedDisposition = "NONE" | "BULK" | "MALICIOUS" | "SPAM" | "SPOOF" | "SUSPICIOUS"; export declare const InvestigateReclassifyCreateRequestExpectedDisposition: any; export interface CreateInvestigateReclassifyRequest { /** Identifier. */ accountId: string; /** Unique identifier for a message retrieved from investigation */ investigateId: string; expectedDisposition: InvestigateReclassifyCreateRequestExpectedDisposition | (string & {}); /** Base64 encoded content of the EML file. */ emlContent?: string; escalatedSubmissionId?: string; } export declare const CreateInvestigateReclassifyRequest: S.Schema; export type CreateInvestigateReclassifyResponse = unknown; export declare const CreateInvestigateReclassifyResponse: S.Schema; export type SettingsAllowPoliciesCreateRequestPatternType = "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"; export declare const SettingsAllowPoliciesCreateRequestPatternType: any; export interface CreateSettingAllowPolicyRequest { /** Identifier. */ accountId: string; /** Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note - This will not exempt messages with Malicious or Suspicious dispositions. */ isAcceptableSender: boolean; /** Messages to this recipient will bypass all detections */ isExemptRecipient: boolean; isRegex: boolean; /** Messages from this sender will bypass all detections and link following */ isTrustedSender: boolean; pattern: string; /** Type of pattern matching. */ patternType: SettingsAllowPoliciesCreateRequestPatternType | (string & {}); /** Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication. */ verifySender: boolean; comments?: string; /** Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life: July 1, 2026. */ isRecipient?: boolean; /** Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life: July 1, 2026. */ isSender?: boolean; /** Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life: July 1, 2026. */ isSpoof?: boolean; } export declare const CreateSettingAllowPolicyRequest: S.Schema; export type SettingsAllowPoliciesCreateResponsePatternType = "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"; export declare const SettingsAllowPoliciesCreateResponsePatternType: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface CreateSettingAllowPolicyResponse { /** Allow policy identifier */ id: string; createdAt: string; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified: string; comments?: string | null; /** Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note - This will not exempt messages with Malicious or Suspicious dispositions. */ isAcceptableSender?: boolean | null; /** Messages to this recipient will bypass all detections */ isExemptRecipient?: boolean | null; /** Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life: July 1, 2026. */ isRecipient?: boolean | null; isRegex?: boolean | null; /** Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life: July 1, 2026. */ isSender?: boolean | null; /** Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life: July 1, 2026. */ isSpoof?: boolean | null; /** Messages from this sender will bypass all detections and link following */ isTrustedSender?: boolean | null; modifiedAt?: string | null; pattern?: string | null; /** Type of pattern matching. */ patternType?: SettingsAllowPoliciesCreateResponsePatternType | null; /** Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication. */ verifySender?: boolean | null; } export declare const CreateSettingAllowPolicyResponse: S.Schema; export type SettingsBlockSendersCreateRequestPatternType = "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"; export declare const SettingsBlockSendersCreateRequestPatternType: any; export interface CreateSettingBlockSenderRequest { /** Identifier. */ accountId: string; isRegex: boolean; pattern: string; /** Type of pattern matching. */ patternType: SettingsBlockSendersCreateRequestPatternType | (string & {}); comments?: string; } export declare const CreateSettingBlockSenderRequest: S.Schema; export type SettingsBlockSendersCreateResponsePatternType = "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"; export declare const SettingsBlockSendersCreateResponsePatternType: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface CreateSettingBlockSenderResponse { /** Blocked sender pattern identifier */ id?: string | null; comments?: string | null; createdAt?: string | null; isRegex?: boolean | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; pattern?: string | null; /** Type of pattern matching. */ patternType?: SettingsBlockSendersCreateResponsePatternType | null; } export declare const CreateSettingBlockSenderResponse: S.Schema; export type SettingsImpersonationRegistryCreateRequestProvenance = "A1S_INTERNAL" | "SNOOPY-CASB_OFFICE_365" | "SNOOPY-OFFICE_365" | "SNOOPY-GOOGLE_DIRECTORY"; export declare const SettingsImpersonationRegistryCreateRequestProvenance: any; export interface CreateSettingImpersonationRegistryRequest { /** Identifier. */ accountId: string; email: string; isEmailRegex: boolean; name: string; comments?: string; directoryId?: number; directoryNodeId?: number; externalDirectoryNodeId?: string; provenance?: SettingsImpersonationRegistryCreateRequestProvenance | (string & {}); } export declare const CreateSettingImpersonationRegistryRequest: S.Schema; export type SettingsImpersonationRegistryCreateResponseProvenance = "A1S_INTERNAL" | "SNOOPY-CASB_OFFICE_365" | "SNOOPY-OFFICE_365" | "SNOOPY-GOOGLE_DIRECTORY"; export declare const SettingsImpersonationRegistryCreateResponseProvenance: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface CreateSettingImpersonationRegistryResponse { /** Impersonation registry entry identifier */ id?: string | null; comments?: string | null; createdAt?: string | null; directoryId?: number | null; directoryNodeId?: number | null; email?: string | null; externalDirectoryNodeId?: string | null; isEmailRegex?: boolean | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; name?: string | null; provenance?: SettingsImpersonationRegistryCreateResponseProvenance | null; } export declare const CreateSettingImpersonationRegistryResponse: S.Schema; export type SettingsSendingDomainRestrictionsCreateRequestExcludeList = Array; export declare const SettingsSendingDomainRestrictionsCreateRequestExcludeList: S.Schema; export interface CreateSettingSendingDomainRestrictionRequest { /** Identifier. */ accountId: string; /** Domain that requires TLS enforcement. */ domain: string; /** Excluded subdomains that are exempt from TLS requirements. */ exclude: SettingsSendingDomainRestrictionsCreateRequestExcludeList; comments?: string; } export declare const CreateSettingSendingDomainRestrictionRequest: S.Schema; export type SettingsSendingDomainRestrictionsCreateResponseExcludeList = Array; export declare const SettingsSendingDomainRestrictionsCreateResponseExcludeList: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface CreateSettingSendingDomainRestrictionResponse { /** Sending domain restriction identifier. */ id?: string | null; comments?: string | null; createdAt?: string | null; /** Domain that requires TLS enforcement. */ domain?: string | null; /** Excluded subdomains that are exempt from TLS requirements. */ exclude?: SettingsSendingDomainRestrictionsCreateResponseExcludeList | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; } export declare const CreateSettingSendingDomainRestrictionResponse: S.Schema; export interface CreateSettingTrustedDomainRequest { /** Identifier. */ accountId: string; /** Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition. */ isRecent: boolean; isRegex: boolean; /** Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition. */ isSimilarity: boolean; pattern: string; comments?: string; } export declare const CreateSettingTrustedDomainRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface CreateSettingTrustedDomainResponse { /** Trusted domain identifier */ id?: string | null; comments?: string | null; createdAt?: string | null; /** Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition. */ isRecent?: boolean | null; isRegex?: boolean | null; /** Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition. */ isSimilarity?: boolean | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; pattern?: string | null; } export declare const CreateSettingTrustedDomainResponse: S.Schema; export interface CreateSettingUrlIgnorePatternRequest { /** Identifier. */ accountId: string; /** Regular expression matching URLs that should not be rewritten. */ pattern: string; /** Optional note describing the reason for the ignore pattern. */ comments?: string; } export declare const CreateSettingUrlIgnorePatternRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface CreateSettingUrlIgnorePatternResponse { /** URL ignore pattern identifier */ id: string; createdAt: string; /** Regular expression matching URLs that should not be rewritten. */ pattern: string; /** Optional note describing the reason for the ignore pattern. */ comments?: string | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; } export declare const CreateSettingUrlIgnorePatternResponse: S.Schema; export interface DeleteInvestigateBulkRequest { /** Identifier. */ accountId: string; jobId: string; } export declare const DeleteInvestigateBulkRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface DeleteInvestigateBulkResponse { id: string; } export declare const DeleteInvestigateBulkResponse: S.Schema; export interface DeleteSettingAllowPolicyRequest { /** Identifier. */ accountId: string; /** Allow policy identifier */ policyId: string; } export declare const DeleteSettingAllowPolicyRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface DeleteSettingAllowPolicyResponse { /** Allow policy identifier */ id: string; } export declare const DeleteSettingAllowPolicyResponse: S.Schema; export interface DeleteSettingBlockSenderRequest { /** Identifier. */ accountId: string; /** Blocked sender pattern identifier */ patternId: string; } export declare const DeleteSettingBlockSenderRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface DeleteSettingBlockSenderResponse { /** Blocked sender pattern identifier */ id: string; } export declare const DeleteSettingBlockSenderResponse: S.Schema; export interface DeleteSettingDomainRequest { /** Identifier. */ accountId: string; /** Domain identifier */ domainId: string; } export declare const DeleteSettingDomainRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface DeleteSettingDomainResponse { /** Domain identifier */ id: string; } export declare const DeleteSettingDomainResponse: S.Schema; export interface DeleteSettingImpersonationRegistryRequest { /** Identifier. */ accountId: string; /** Impersonation registry entry identifier */ impersonationRegistryId: string; } export declare const DeleteSettingImpersonationRegistryRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface DeleteSettingImpersonationRegistryResponse { /** Impersonation registry entry identifier */ id: string; } export declare const DeleteSettingImpersonationRegistryResponse: S.Schema; export interface DeleteSettingSendingDomainRestrictionRequest { /** Identifier. */ accountId: string; /** Sending domain restriction identifier. */ sendingDomainRestrictionId: string; } export declare const DeleteSettingSendingDomainRestrictionRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface DeleteSettingSendingDomainRestrictionResponse { /** Sending domain restriction identifier. */ id: string; } export declare const DeleteSettingSendingDomainRestrictionResponse: S.Schema; export interface DeleteSettingTrustedDomainRequest { /** Identifier. */ accountId: string; /** Trusted domain identifier */ trustedDomainId: string; } export declare const DeleteSettingTrustedDomainRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface DeleteSettingTrustedDomainResponse { /** Trusted domain identifier */ id: string; } export declare const DeleteSettingTrustedDomainResponse: S.Schema; export interface DeleteSettingUrlIgnorePatternRequest { /** Identifier. */ accountId: string; /** URL ignore pattern identifier */ patternId: string; } export declare const DeleteSettingUrlIgnorePatternRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface DeleteSettingUrlIgnorePatternResponse { /** URL ignore pattern identifier */ id: string; } export declare const DeleteSettingUrlIgnorePatternResponse: S.Schema; export interface GetInvestigateRequest { /** Identifier. */ accountId: string; /** Unique identifier for a message retrieved from investigation */ investigateId: string; /** When true, search the submissions datastore only. When false or omitted, search the */ submission?: boolean; } export declare const GetInvestigateRequest: S.Schema; export type InvestigateGetResponseActionLogItemOperation = "MOVE" | "RELEASE" | "RECLASSIFY" | "SUBMISSION" | "QUARANTINE_RELEASE" | "PREVIEW"; export declare const InvestigateGetResponseActionLogItemOperation: any; export interface InvestigateGetResponseActionLogItemProperties { /** Target folder for move operations */ folder?: string | null; /** User who requested the action */ requestedBy?: string | null; } export declare const InvestigateGetResponseActionLogItemProperties: S.Schema; export interface InvestigateGetResponseActionLogItem { /** Timestamp when action completed */ completedAt: string; /** Type of action performed */ operation: InvestigateGetResponseActionLogItemOperation; /** Deprecated, use `completed_at` instead. End of life: November 1, 2026. */ completedTimestamp?: string | null; /** Additional properties for the action */ properties?: InvestigateGetResponseActionLogItemProperties | null; /** Status of the action */ status?: string | null; } export declare const InvestigateGetResponseActionLogItem: S.Schema; export type InvestigateGetResponseActionLogList = Array; export declare const InvestigateGetResponseActionLogList: S.Schema; export type InvestigateGetResponseClientRecipientsList = Array; export declare const InvestigateGetResponseClientRecipientsList: S.Schema; export type InvestigateGetResponseDetectionReasonsList = Array; export declare const InvestigateGetResponseDetectionReasonsList: S.Schema; export type InvestigateGetResponsePropertiesAllowlistedPatternType = "quarantine_release" | "acceptable_sender" | "allowed_sender" | "allowed_recipient" | "domain_similarity" | "domain_recency" | "managed_acceptable_sender" | "outbound_ndr"; export declare const InvestigateGetResponsePropertiesAllowlistedPatternType: any; export type InvestigateGetResponsePropertiesWhitelistedPatternType = "quarantine_release" | "acceptable_sender" | "allowed_sender" | "allowed_recipient" | "domain_similarity" | "domain_recency" | "managed_acceptable_sender" | "outbound_ndr"; export declare const InvestigateGetResponsePropertiesWhitelistedPatternType: any; export interface InvestigateGetResponseProperties { /** Pattern that allowlisted this message */ allowlistedPattern?: string | null; /** Type of allowlist pattern */ allowlistedPatternType?: InvestigateGetResponsePropertiesAllowlistedPatternType | null; /** Whether message was blocklisted */ blocklistedMessage?: boolean | null; /** Pattern that blocklisted this message */ blocklistedPattern?: string | null; /** Legacy field for allowlist pattern type */ whitelistedPatternType?: InvestigateGetResponsePropertiesWhitelistedPatternType | null; } export declare const InvestigateGetResponseProperties: S.Schema; export type InvestigateGetResponseDeliveryMode = "DIRECT" | "BCC" | "JOURNAL" | "REVIEW_SUBMISSION" | "DMARC_UNVERIFIED" | "DMARC_FAILURE_REPORT" | "DMARC_AGGREGATE_REPORT" | "THREAT_INTEL_SUBMISSION" | "SIMULATION_SUBMISSION" | "API" | "RETRO_SCAN"; export declare const InvestigateGetResponseDeliveryMode: any; export type InvestigateGetResponseDeliveryStatusItem = "delivered" | "moved" | "quarantined" | "rejected" | "deferred" | "bounced" | "queued"; export declare const InvestigateGetResponseDeliveryStatusItem: any; export type InvestigateGetResponseDeliveryStatusList = Array; export declare const InvestigateGetResponseDeliveryStatusList: S.Schema; export type InvestigateGetResponseEnvelopeToList = Array; export declare const InvestigateGetResponseEnvelopeToList: S.Schema; export type InvestigateGetResponseFinalDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateGetResponseFinalDisposition: any; export type InvestigateGetResponseFindingsItemDetection = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateGetResponseFindingsItemDetection: any; export interface InvestigateGetResponseFindingsItem { attachment?: string | null; detail?: string | null; detection?: InvestigateGetResponseFindingsItemDetection | null; field?: string | null; name?: string | null; portion?: string | null; reason?: string | null; score?: number | null; value?: string | null; } export declare const InvestigateGetResponseFindingsItem: S.Schema; export type InvestigateGetResponseFindingsList = Array; export declare const InvestigateGetResponseFindingsList: S.Schema; export type InvestigateGetResponsePostDeliveryOperationsItem = "PREVIEW" | "QUARANTINE_RELEASE" | "SUBMISSION" | "MOVE"; export declare const InvestigateGetResponsePostDeliveryOperationsItem: any; export type InvestigateGetResponsePostDeliveryOperationsList = Array; export declare const InvestigateGetResponsePostDeliveryOperationsList: S.Schema; export type InvestigateGetResponseThreatCategoriesList = Array; export declare const InvestigateGetResponseThreatCategoriesList: S.Schema; export type InvestigateGetResponseToList = Array; export declare const InvestigateGetResponseToList: S.Schema; export type InvestigateGetResponseToNameList = Array; export declare const InvestigateGetResponseToNameList: S.Schema; export type InvestigateGetResponseValidationDkim = "pass" | "neutral" | "fail" | "error" | "none"; export declare const InvestigateGetResponseValidationDkim: any; export type InvestigateGetResponseValidationDmarc = "pass" | "neutral" | "fail" | "error" | "none"; export declare const InvestigateGetResponseValidationDmarc: any; export type InvestigateGetResponseValidationSpf = "pass" | "neutral" | "fail" | "error" | "none"; export declare const InvestigateGetResponseValidationSpf: any; export interface InvestigateGetResponseValidation { comment?: string | null; dkim?: InvestigateGetResponseValidationDkim | null; dmarc?: InvestigateGetResponseValidationDmarc | null; spf?: InvestigateGetResponseValidationSpf | null; } export declare const InvestigateGetResponseValidation: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetInvestigateResponse { /** Unique identifier for a message retrieved from investigation */ id: string; /** Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of life: November 1, 2026. */ actionLog: InvestigateGetResponseActionLogList; clientRecipients: InvestigateGetResponseClientRecipientsList; detectionReasons: InvestigateGetResponseDetectionReasonsList; isPhishSubmission: boolean; isQuarantined: boolean; /** The identifier of the message */ postfixId: string; /** Message processing properties */ properties: InvestigateGetResponseProperties; /** Deprecated, use `scanned_at` instead. End of life: November 1, 2026. */ ts: string; alertId?: string | null; deliveryMode?: InvestigateGetResponseDeliveryMode | null; deliveryStatus?: InvestigateGetResponseDeliveryStatusList | null; edfHash?: string | null; envelopeFrom?: string | null; envelopeTo?: InvestigateGetResponseEnvelopeToList | null; finalDisposition?: InvestigateGetResponseFinalDisposition | null; /** Deprecated, use the `findings` field from `GET /investigate/{investigate_id}/detections` instead. End of life: November 1, 2026. Detection findings for this message. */ findings?: InvestigateGetResponseFindingsList | null; from?: string | null; fromName?: string | null; htmltextStructureHash?: string | null; messageId?: string | null; /** Post-delivery operations performed on this message */ postDeliveryOperations?: InvestigateGetResponsePostDeliveryOperationsList | null; postfixIdOutbound?: string | null; replyto?: string | null; /** When the message was scanned (UTC) */ scannedAt?: string | null; /** When the message was sent (UTC) */ sentAt?: string | null; sentDate?: string | null; smtpHeloServerIp?: string | null; smtpPreviousHopIp?: string | null; subject?: string | null; threatCategories?: InvestigateGetResponseThreatCategoriesList | null; to?: InvestigateGetResponseToList | null; toName?: InvestigateGetResponseToNameList | null; validation?: InvestigateGetResponseValidation | null; xOriginatingIp?: string | null; } export declare const GetInvestigateResponse: S.Schema; export interface GetInvestigateBulkRequest { /** Identifier. */ accountId: string; jobId: string; } export declare const GetInvestigateBulkRequest: S.Schema; export type InvestigateBulkGetResponseActionParamsMoveDestination = "Inbox" | "JunkEmail" | "DeletedItems" | "RecoverableItemsDeletions" | "RecoverableItemsPurges"; export declare const InvestigateBulkGetResponseActionParamsMoveDestination: any; export type InvestigateBulkGetResponseActionParamsMoveType = "MOVE"; export declare const InvestigateBulkGetResponseActionParamsMoveType: any; export type InvestigateBulkGetResponseActionParamsMoveExpectedDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateBulkGetResponseActionParamsMoveExpectedDisposition: any; export interface InvestigateBulkGetResponseActionParamsMove { destination: InvestigateBulkGetResponseActionParamsMoveDestination; type: InvestigateBulkGetResponseActionParamsMoveType; expectedDisposition?: InvestigateBulkGetResponseActionParamsMoveExpectedDisposition | null; } export declare const InvestigateBulkGetResponseActionParamsMove: S.Schema; export type InvestigateBulkGetResponseActionParamsReleaseType = "RELEASE"; export declare const InvestigateBulkGetResponseActionParamsReleaseType: any; export interface InvestigateBulkGetResponseActionParamsRelease { type: InvestigateBulkGetResponseActionParamsReleaseType; } export declare const InvestigateBulkGetResponseActionParamsRelease: S.Schema; export type InvestigateBulkGetResponseActionParams = InvestigateBulkGetResponseActionParamsMove | InvestigateBulkGetResponseActionParamsRelease; export declare const InvestigateBulkGetResponseActionParams: any; export type InvestigateBulkGetResponseActionType = "MOVE" | "RELEASE"; export declare const InvestigateBulkGetResponseActionType: any; export type InvestigateBulkGetResponseSearchParamsDeliveryStatus = "delivered" | "moved" | "quarantined" | "rejected" | "deferred" | "bounced" | "queued"; export declare const InvestigateBulkGetResponseSearchParamsDeliveryStatus: any; export type InvestigateBulkGetResponseSearchParamsFinalDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateBulkGetResponseSearchParamsFinalDisposition: any; export type InvestigateBulkGetResponseSearchParamsMessageAction = "PREVIEW" | "QUARANTINE_RELEASED" | "MOVED"; export declare const InvestigateBulkGetResponseSearchParamsMessageAction: any; export interface InvestigateBulkGetResponseSearchParams { /** Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of life: November 1, 2026. */ actionLog?: boolean | null; alertId?: string | null; /** Delivery status of the message. */ deliveryStatus?: InvestigateBulkGetResponseSearchParamsDeliveryStatus | null; detectionsOnly?: boolean | null; domain?: string | null; /** End of search date range */ end?: string | null; exactSubject?: string | null; finalDisposition?: InvestigateBulkGetResponseSearchParamsFinalDisposition | null; messageAction?: InvestigateBulkGetResponseSearchParamsMessageAction | null; messageId?: string | null; metric?: string | null; query?: string | null; recipient?: string | null; sender?: string | null; /** Beginning of search date range */ start?: string | null; subject?: string | null; submissions?: boolean | null; } export declare const InvestigateBulkGetResponseSearchParams: S.Schema; export type InvestigateBulkGetResponseStatus = "PENDING" | "DISCOVERING" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED" | "SKIPPED"; export declare const InvestigateBulkGetResponseStatus: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetInvestigateBulkResponse { actionParams: InvestigateBulkGetResponseActionParams; actionType: InvestigateBulkGetResponseActionType; createdAt: string; jobId: string; messagesFailed: number; messagesPending: number; messagesSuccessful: number; searchParams: InvestigateBulkGetResponseSearchParams; status: InvestigateBulkGetResponseStatus; totalMessagesDiscovered: number; comment?: string | null; completedAt?: string | null; startedAt?: string | null; statusMessage?: string | null; } export declare const GetInvestigateBulkResponse: S.Schema; export interface GetInvestigateDetectionRequest { /** Identifier. */ accountId: string; /** Unique identifier for a message retrieved from investigation */ investigateId: string; } export declare const GetInvestigateDetectionRequest: S.Schema; export type InvestigateDetectionsGetResponseAttachmentsItemDetection = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateDetectionsGetResponseAttachmentsItemDetection: any; export interface InvestigateDetectionsGetResponseAttachmentsItem { /** Size of the attachment in bytes */ size: number; /** MIME type of the attachment */ contentType?: string | null; /** Detection result for this attachment */ detection?: InvestigateDetectionsGetResponseAttachmentsItemDetection | null; /** Whether the attachment is encrypted */ encrypted?: boolean | null; /** Name of the attached file */ filename?: string | null; /** MD5 hash of the attachment */ md5?: string | null; /** Attachment name (alternative to filename) */ name?: string | null; /** SHA1 hash of the attachment */ sha1?: string | null; /** SHA256 hash of the attachment */ sha256?: string | null; } export declare const InvestigateDetectionsGetResponseAttachmentsItem: S.Schema; export type InvestigateDetectionsGetResponseAttachmentsList = Array; export declare const InvestigateDetectionsGetResponseAttachmentsList: S.Schema; export type InvestigateDetectionsGetResponseFindingsItemDetection = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateDetectionsGetResponseFindingsItemDetection: any; export interface InvestigateDetectionsGetResponseFindingsItem { attachment?: string | null; detail?: string | null; detection?: InvestigateDetectionsGetResponseFindingsItemDetection | null; field?: string | null; name?: string | null; portion?: string | null; reason?: string | null; score?: number | null; value?: string | null; } export declare const InvestigateDetectionsGetResponseFindingsItem: S.Schema; export type InvestigateDetectionsGetResponseFindingsList = Array; export declare const InvestigateDetectionsGetResponseFindingsList: S.Schema; export interface InvestigateDetectionsGetResponseHeadersItem { name: string; value: string; } export declare const InvestigateDetectionsGetResponseHeadersItem: S.Schema; export type InvestigateDetectionsGetResponseHeadersList = Array; export declare const InvestigateDetectionsGetResponseHeadersList: S.Schema; export interface InvestigateDetectionsGetResponseLinksItem { href: string; text?: string | null; } export declare const InvestigateDetectionsGetResponseLinksItem: S.Schema; export type InvestigateDetectionsGetResponseLinksList = Array; export declare const InvestigateDetectionsGetResponseLinksList: S.Schema; export interface InvestigateDetectionsGetResponseSenderInfo { /** The name of the autonomous system. */ asName?: string | null; /** The number of the autonomous system. */ asNumber?: number | null; geo?: string | null; ip?: string | null; pld?: string | null; } export declare const InvestigateDetectionsGetResponseSenderInfo: S.Schema; export interface InvestigateDetectionsGetResponseThreatCategoriesItem { id?: number | null; description?: string | null; name?: string | null; } export declare const InvestigateDetectionsGetResponseThreatCategoriesItem: S.Schema; export type InvestigateDetectionsGetResponseThreatCategoriesList = Array; export declare const InvestigateDetectionsGetResponseThreatCategoriesList: S.Schema; export type InvestigateDetectionsGetResponseValidationDkim = "pass" | "neutral" | "fail" | "error" | "none"; export declare const InvestigateDetectionsGetResponseValidationDkim: any; export type InvestigateDetectionsGetResponseValidationDmarc = "pass" | "neutral" | "fail" | "error" | "none"; export declare const InvestigateDetectionsGetResponseValidationDmarc: any; export type InvestigateDetectionsGetResponseValidationSpf = "pass" | "neutral" | "fail" | "error" | "none"; export declare const InvestigateDetectionsGetResponseValidationSpf: any; export interface InvestigateDetectionsGetResponseValidation { comment?: string | null; dkim?: InvestigateDetectionsGetResponseValidationDkim | null; dmarc?: InvestigateDetectionsGetResponseValidationDmarc | null; spf?: InvestigateDetectionsGetResponseValidationSpf | null; } export declare const InvestigateDetectionsGetResponseValidation: S.Schema; export type InvestigateDetectionsGetResponseFinalDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateDetectionsGetResponseFinalDisposition: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetInvestigateDetectionResponse { action: string; attachments: InvestigateDetectionsGetResponseAttachmentsList; findings: InvestigateDetectionsGetResponseFindingsList; headers: InvestigateDetectionsGetResponseHeadersList; links: InvestigateDetectionsGetResponseLinksList; senderInfo: InvestigateDetectionsGetResponseSenderInfo; threatCategories: InvestigateDetectionsGetResponseThreatCategoriesList; validation: InvestigateDetectionsGetResponseValidation; finalDisposition?: InvestigateDetectionsGetResponseFinalDisposition | null; } export declare const GetInvestigateDetectionResponse: S.Schema; export interface GetInvestigatePreviewRequest { /** Identifier. */ accountId: string; /** Unique identifier for a message retrieved from investigation */ investigateId: string; } export declare const GetInvestigatePreviewRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetInvestigatePreviewResponse { /** A base64 encoded PNG image of the email. */ screenshot: string; } export declare const GetInvestigatePreviewResponse: S.Schema; export interface GetInvestigateRawRequest { /** Identifier. */ accountId: string; /** Unique identifier for a message retrieved from investigation */ investigateId: string; } export declare const GetInvestigateRawRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetInvestigateRawResponse { /** A UTF-8 encoded eml file of the email. */ raw: string; } export declare const GetInvestigateRawResponse: S.Schema; export interface GetInvestigateTraceRequest { /** Identifier. */ accountId: string; /** Unique identifier for a message retrieved from investigation */ investigateId: string; } export declare const GetInvestigateTraceRequest: S.Schema; export interface InvestigateTraceGetResponseInboundLinesItem { /** Line number in the trace log */ lineno?: number | null; loggedAt?: string | null; message?: string | null; /** Deprecated, use `logged_at` instead. End of life: November 1, 2026. */ ts?: string | null; } export declare const InvestigateTraceGetResponseInboundLinesItem: S.Schema; export type InvestigateTraceGetResponseInboundLinesList = Array; export declare const InvestigateTraceGetResponseInboundLinesList: S.Schema; export interface InvestigateTraceGetResponseInbound { lines?: InvestigateTraceGetResponseInboundLinesList | null; pending?: boolean | null; } export declare const InvestigateTraceGetResponseInbound: S.Schema; export type InvestigateTraceGetResponseOutboundLinesItem = InvestigateTraceGetResponseInboundLinesItem; export declare const InvestigateTraceGetResponseOutboundLinesItem: S.Schema; export type InvestigateTraceGetResponseOutboundLinesList = Array; export declare const InvestigateTraceGetResponseOutboundLinesList: S.Schema; export interface InvestigateTraceGetResponseOutbound { lines?: InvestigateTraceGetResponseOutboundLinesList | null; pending?: boolean | null; } export declare const InvestigateTraceGetResponseOutbound: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetInvestigateTraceResponse { inbound: InvestigateTraceGetResponseInbound; outbound: InvestigateTraceGetResponseOutbound; } export declare const GetInvestigateTraceResponse: S.Schema; export interface GetSettingAllowPolicyRequest { /** Identifier. */ accountId: string; /** Allow policy identifier */ policyId: string; } export declare const GetSettingAllowPolicyRequest: S.Schema; export type SettingsAllowPoliciesGetResponsePatternType = "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"; export declare const SettingsAllowPoliciesGetResponsePatternType: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetSettingAllowPolicyResponse { /** Allow policy identifier */ id: string; createdAt: string; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified: string; comments?: string | null; /** Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note - This will not exempt messages with Malicious or Suspicious dispositions. */ isAcceptableSender?: boolean | null; /** Messages to this recipient will bypass all detections */ isExemptRecipient?: boolean | null; /** Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life: July 1, 2026. */ isRecipient?: boolean | null; isRegex?: boolean | null; /** Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life: July 1, 2026. */ isSender?: boolean | null; /** Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life: July 1, 2026. */ isSpoof?: boolean | null; /** Messages from this sender will bypass all detections and link following */ isTrustedSender?: boolean | null; modifiedAt?: string | null; pattern?: string | null; /** Type of pattern matching. */ patternType?: SettingsAllowPoliciesGetResponsePatternType | null; /** Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication. */ verifySender?: boolean | null; } export declare const GetSettingAllowPolicyResponse: S.Schema; export interface GetSettingBlockSenderRequest { /** Identifier. */ accountId: string; /** Blocked sender pattern identifier */ patternId: string; } export declare const GetSettingBlockSenderRequest: S.Schema; export type SettingsBlockSendersGetResponsePatternType = "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"; export declare const SettingsBlockSendersGetResponsePatternType: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetSettingBlockSenderResponse { /** Blocked sender pattern identifier */ id?: string | null; comments?: string | null; createdAt?: string | null; isRegex?: boolean | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; pattern?: string | null; /** Type of pattern matching. */ patternType?: SettingsBlockSendersGetResponsePatternType | null; } export declare const GetSettingBlockSenderResponse: S.Schema; export interface GetSettingDomainRequest { /** Identifier. */ accountId: string; /** Domain identifier */ domainId: string; } export declare const GetSettingDomainRequest: S.Schema; export type SettingsDomainsGetResponseAllowedDeliveryModesItem = "DIRECT" | "BCC" | "JOURNAL" | "API" | "RETRO_SCAN"; export declare const SettingsDomainsGetResponseAllowedDeliveryModesItem: any; export type SettingsDomainsGetResponseAllowedDeliveryModesList = Array; export declare const SettingsDomainsGetResponseAllowedDeliveryModesList: S.Schema; export interface SettingsDomainsGetResponseAuthorization { authorized: boolean; timestamp: string; statusMessage?: string | null; } export declare const SettingsDomainsGetResponseAuthorization: S.Schema; export type SettingsDomainsGetResponseDmarcStatus = "none" | "good" | "invalid"; export declare const SettingsDomainsGetResponseDmarcStatus: any; export type SettingsDomainsGetResponseDropDispositionsItem = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const SettingsDomainsGetResponseDropDispositionsItem: any; export type SettingsDomainsGetResponseDropDispositionsList = Array; export declare const SettingsDomainsGetResponseDropDispositionsList: S.Schema; export interface SettingsDomainsGetResponseEmailsProcessed { timestamp: string; totalEmailsProcessed: number; totalEmailsProcessedPrevious: number; } export declare const SettingsDomainsGetResponseEmailsProcessed: S.Schema; export type SettingsDomainsGetResponseFolder = "AllItems" | "Inbox"; export declare const SettingsDomainsGetResponseFolder: any; export type SettingsDomainsGetResponseInboxProvider = "Microsoft" | "Google"; export declare const SettingsDomainsGetResponseInboxProvider: any; export type SettingsDomainsGetResponseIpRestrictionsList = Array; export declare const SettingsDomainsGetResponseIpRestrictionsList: S.Schema; export type SettingsDomainsGetResponseRegionsItem = "GLOBAL" | "AU" | "DE" | "IN" | "US"; export declare const SettingsDomainsGetResponseRegionsItem: any; export type SettingsDomainsGetResponseRegionsList = Array; export declare const SettingsDomainsGetResponseRegionsList: S.Schema; export type SettingsDomainsGetResponseSpfStatus = "none" | "good" | "neutral" | "open" | "invalid"; export declare const SettingsDomainsGetResponseSpfStatus: any; export type SettingsDomainsGetResponseStatus = "pending" | "active" | "failed" | "timeout"; export declare const SettingsDomainsGetResponseStatus: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetSettingDomainResponse { /** Domain identifier */ id?: string | null; allowedDeliveryModes?: SettingsDomainsGetResponseAllowedDeliveryModesList | null; authorization?: SettingsDomainsGetResponseAuthorization | null; createdAt?: string | null; dmarcStatus?: SettingsDomainsGetResponseDmarcStatus | null; domain?: string | null; dropDispositions?: SettingsDomainsGetResponseDropDispositionsList | null; emailsProcessed?: SettingsDomainsGetResponseEmailsProcessed | null; folder?: SettingsDomainsGetResponseFolder | null; inboxProvider?: SettingsDomainsGetResponseInboxProvider | null; integrationId?: string | null; ipRestrictions?: SettingsDomainsGetResponseIpRestrictionsList | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; lookbackHops?: number | null; modifiedAt?: string | null; o365TenantId?: string | null; regions?: SettingsDomainsGetResponseRegionsList | null; requireTlsInbound?: boolean | null; requireTlsOutbound?: boolean | null; spfStatus?: SettingsDomainsGetResponseSpfStatus | null; status?: SettingsDomainsGetResponseStatus | null; transport?: string | null; } export declare const GetSettingDomainResponse: S.Schema; export interface GetSettingImpersonationRegistryRequest { /** Identifier. */ accountId: string; /** Impersonation registry entry identifier */ impersonationRegistryId: string; } export declare const GetSettingImpersonationRegistryRequest: S.Schema; export type SettingsImpersonationRegistryGetResponseProvenance = "A1S_INTERNAL" | "SNOOPY-CASB_OFFICE_365" | "SNOOPY-OFFICE_365" | "SNOOPY-GOOGLE_DIRECTORY"; export declare const SettingsImpersonationRegistryGetResponseProvenance: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetSettingImpersonationRegistryResponse { /** Impersonation registry entry identifier */ id?: string | null; comments?: string | null; createdAt?: string | null; directoryId?: number | null; directoryNodeId?: number | null; email?: string | null; externalDirectoryNodeId?: string | null; isEmailRegex?: boolean | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; name?: string | null; provenance?: SettingsImpersonationRegistryGetResponseProvenance | null; } export declare const GetSettingImpersonationRegistryResponse: S.Schema; export interface GetSettingSendingDomainRestrictionRequest { /** Identifier. */ accountId: string; /** Sending domain restriction identifier. */ sendingDomainRestrictionId: string; } export declare const GetSettingSendingDomainRestrictionRequest: S.Schema; export type SettingsSendingDomainRestrictionsGetResponseExcludeList = Array; export declare const SettingsSendingDomainRestrictionsGetResponseExcludeList: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetSettingSendingDomainRestrictionResponse { /** Sending domain restriction identifier. */ id?: string | null; comments?: string | null; createdAt?: string | null; /** Domain that requires TLS enforcement. */ domain?: string | null; /** Excluded subdomains that are exempt from TLS requirements. */ exclude?: SettingsSendingDomainRestrictionsGetResponseExcludeList | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; } export declare const GetSettingSendingDomainRestrictionResponse: S.Schema; export interface GetSettingTrustedDomainRequest { /** Identifier. */ accountId: string; /** Trusted domain identifier */ trustedDomainId: string; } export declare const GetSettingTrustedDomainRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetSettingTrustedDomainResponse { /** Trusted domain identifier */ id?: string | null; comments?: string | null; createdAt?: string | null; /** Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition. */ isRecent?: boolean | null; isRegex?: boolean | null; /** Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition. */ isSimilarity?: boolean | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; pattern?: string | null; } export declare const GetSettingTrustedDomainResponse: S.Schema; export interface GetSettingUrlIgnorePatternRequest { /** Identifier. */ accountId: string; /** URL ignore pattern identifier */ patternId: string; } export declare const GetSettingUrlIgnorePatternRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetSettingUrlIgnorePatternResponse { /** URL ignore pattern identifier */ id: string; createdAt: string; /** Regular expression matching URLs that should not be rewritten. */ pattern: string; /** Optional note describing the reason for the ignore pattern. */ comments?: string | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; } export declare const GetSettingUrlIgnorePatternResponse: S.Schema; export type InvestigateBulkMessagesListRequestStatus = "PENDING" | "DISCOVERING" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED" | "SKIPPED"; export declare const InvestigateBulkMessagesListRequestStatus: any; export interface ListInvestigateBulkMessagesRequest { /** Identifier. */ accountId: string; jobId: string; /** Current page within paginated list of results. */ page?: number; /** The number of results per page. Maximum value is 1000. */ perPage?: number; status?: InvestigateBulkMessagesListRequestStatus | (string & {}); } export declare const ListInvestigateBulkMessagesRequest: S.Schema; export type InvestigateBulkMessagesListResultItemActionParamsMoveDestination = "Inbox" | "JunkEmail" | "DeletedItems" | "RecoverableItemsDeletions" | "RecoverableItemsPurges"; export declare const InvestigateBulkMessagesListResultItemActionParamsMoveDestination: any; export type InvestigateBulkMessagesListResultItemActionParamsMoveType = "MOVE"; export declare const InvestigateBulkMessagesListResultItemActionParamsMoveType: any; export type InvestigateBulkMessagesListResultItemActionParamsMoveExpectedDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateBulkMessagesListResultItemActionParamsMoveExpectedDisposition: any; export interface InvestigateBulkMessagesListResultItemActionParamsMove { clientRecipient: string; destination: InvestigateBulkMessagesListResultItemActionParamsMoveDestination; type: InvestigateBulkMessagesListResultItemActionParamsMoveType; expectedDisposition?: InvestigateBulkMessagesListResultItemActionParamsMoveExpectedDisposition | null; } export declare const InvestigateBulkMessagesListResultItemActionParamsMove: S.Schema; export type InvestigateBulkMessagesListResultItemActionParamsReleaseType = "RELEASE"; export declare const InvestigateBulkMessagesListResultItemActionParamsReleaseType: any; export interface InvestigateBulkMessagesListResultItemActionParamsRelease { clientRecipient: string; type: InvestigateBulkMessagesListResultItemActionParamsReleaseType; } export declare const InvestigateBulkMessagesListResultItemActionParamsRelease: S.Schema; export type InvestigateBulkMessagesListResultItemActionParams = InvestigateBulkMessagesListResultItemActionParamsMove | InvestigateBulkMessagesListResultItemActionParamsRelease; export declare const InvestigateBulkMessagesListResultItemActionParams: any; export type InvestigateBulkMessagesListResultItemActionType = "MOVE" | "RELEASE"; export declare const InvestigateBulkMessagesListResultItemActionType: any; export type InvestigateBulkMessagesListResultItemStatus = "PENDING" | "DISCOVERING" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED" | "SKIPPED"; export declare const InvestigateBulkMessagesListResultItemStatus: any; export interface InvestigateBulkMessagesListResultItem { actionParams: InvestigateBulkMessagesListResultItemActionParams; actionType: InvestigateBulkMessagesListResultItemActionType; createdAt: string; messageId: string; postfixId: string; retryCount: number; status: InvestigateBulkMessagesListResultItemStatus; alertId?: string | null; emailMessageId?: string | null; processedAt?: string | null; /** When to retry the action if it failed */ retryAfter?: string | null; statusMessage?: string | null; } export declare const InvestigateBulkMessagesListResultItem: S.Schema; export type InvestigateBulkMessagesListResultList = Array; export declare const InvestigateBulkMessagesListResultList: S.Schema; export interface ListInvestigateBulkMessagesResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: InvestigateBulkMessagesListResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const ListInvestigateBulkMessagesResponse: S.Schema; export type InvestigateBulkListRequestActionType = "MOVE" | "RELEASE"; export declare const InvestigateBulkListRequestActionType: any; export type InvestigateBulkListRequestStatus = "PENDING" | "DISCOVERING" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED" | "SKIPPED"; export declare const InvestigateBulkListRequestStatus: any; export interface ListInvestigateBulksRequest { /** Identifier. */ accountId: string; actionType?: InvestigateBulkListRequestActionType | (string & {}); /** Current page within paginated list of results. */ page?: number; /** The number of results per page. Maximum value is 1000. */ perPage?: number; status?: InvestigateBulkListRequestStatus | (string & {}); } export declare const ListInvestigateBulksRequest: S.Schema; export type InvestigateBulkListResultItemActionParamsMoveDestination = "Inbox" | "JunkEmail" | "DeletedItems" | "RecoverableItemsDeletions" | "RecoverableItemsPurges"; export declare const InvestigateBulkListResultItemActionParamsMoveDestination: any; export type InvestigateBulkListResultItemActionParamsMoveType = "MOVE"; export declare const InvestigateBulkListResultItemActionParamsMoveType: any; export type InvestigateBulkListResultItemActionParamsMoveExpectedDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateBulkListResultItemActionParamsMoveExpectedDisposition: any; export interface InvestigateBulkListResultItemActionParamsMove { destination: InvestigateBulkListResultItemActionParamsMoveDestination; type: InvestigateBulkListResultItemActionParamsMoveType; expectedDisposition?: InvestigateBulkListResultItemActionParamsMoveExpectedDisposition | null; } export declare const InvestigateBulkListResultItemActionParamsMove: S.Schema; export type InvestigateBulkListResultItemActionParamsReleaseType = "RELEASE"; export declare const InvestigateBulkListResultItemActionParamsReleaseType: any; export interface InvestigateBulkListResultItemActionParamsRelease { type: InvestigateBulkListResultItemActionParamsReleaseType; } export declare const InvestigateBulkListResultItemActionParamsRelease: S.Schema; export type InvestigateBulkListResultItemActionParams = InvestigateBulkListResultItemActionParamsMove | InvestigateBulkListResultItemActionParamsRelease; export declare const InvestigateBulkListResultItemActionParams: any; export type InvestigateBulkListResultItemActionType = "MOVE" | "RELEASE"; export declare const InvestigateBulkListResultItemActionType: any; export type InvestigateBulkListResultItemSearchParamsDeliveryStatus = "delivered" | "moved" | "quarantined" | "rejected" | "deferred" | "bounced" | "queued"; export declare const InvestigateBulkListResultItemSearchParamsDeliveryStatus: any; export type InvestigateBulkListResultItemSearchParamsFinalDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateBulkListResultItemSearchParamsFinalDisposition: any; export type InvestigateBulkListResultItemSearchParamsMessageAction = "PREVIEW" | "QUARANTINE_RELEASED" | "MOVED"; export declare const InvestigateBulkListResultItemSearchParamsMessageAction: any; export interface InvestigateBulkListResultItemSearchParams { /** Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of life: November 1, 2026. */ actionLog?: boolean | null; alertId?: string | null; /** Delivery status of the message. */ deliveryStatus?: InvestigateBulkListResultItemSearchParamsDeliveryStatus | null; detectionsOnly?: boolean | null; domain?: string | null; /** End of search date range */ end?: string | null; exactSubject?: string | null; finalDisposition?: InvestigateBulkListResultItemSearchParamsFinalDisposition | null; messageAction?: InvestigateBulkListResultItemSearchParamsMessageAction | null; messageId?: string | null; metric?: string | null; query?: string | null; recipient?: string | null; sender?: string | null; /** Beginning of search date range */ start?: string | null; subject?: string | null; submissions?: boolean | null; } export declare const InvestigateBulkListResultItemSearchParams: S.Schema; export type InvestigateBulkListResultItemStatus = "PENDING" | "DISCOVERING" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED" | "SKIPPED"; export declare const InvestigateBulkListResultItemStatus: any; export interface InvestigateBulkListResultItem { actionParams: InvestigateBulkListResultItemActionParams; actionType: InvestigateBulkListResultItemActionType; createdAt: string; jobId: string; messagesFailed: number; messagesPending: number; messagesSuccessful: number; searchParams: InvestigateBulkListResultItemSearchParams; status: InvestigateBulkListResultItemStatus; totalMessagesDiscovered: number; comment?: string | null; completedAt?: string | null; startedAt?: string | null; statusMessage?: string | null; } export declare const InvestigateBulkListResultItem: S.Schema; export type InvestigateBulkListResultList = Array; export declare const InvestigateBulkListResultList: S.Schema; export interface ListInvestigateBulksResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: InvestigateBulkListResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const ListInvestigateBulksResponse: S.Schema; export type InvestigateListRequestDeliveryStatus = "delivered" | "moved" | "quarantined" | "rejected" | "deferred" | "bounced" | "queued"; export declare const InvestigateListRequestDeliveryStatus: any; export type InvestigateListRequestFinalDisposition = "MALICIOUS" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "NONE"; export declare const InvestigateListRequestFinalDisposition: any; export type InvestigateListRequestMessageAction = "PREVIEW" | "QUARANTINE_RELEASED" | "MOVED"; export declare const InvestigateListRequestMessageAction: any; export interface ListInvestigatesRequest { /** Identifier. */ accountId: string; alertId?: string; cursor?: string; /** Delivery status to filter by. */ deliveryStatus?: InvestigateListRequestDeliveryStatus | (string & {}); /** Whether to include only detections in search results. */ detectionsOnly?: boolean; /** Sender domains to filter by. */ domain?: string; /** The end of the search date range. Defaults to `now`. */ end?: string; /** Dispositions to filter by. */ finalDisposition?: InvestigateListRequestFinalDisposition | (string & {}); /** Message actions to filter by. */ messageAction?: InvestigateListRequestMessageAction | (string & {}); messageId?: string; metric?: string; /** Deprecated: Use cursor pagination instead. End of life: November 1, 2026. */ page?: number; /** The number of results per page. Maximum value is 1000. */ perPage?: number; /** Space-delimited search term. Case-insensitive. */ query?: string; recipient?: string; sender?: string; /** The beginning of the search date range. Defaults to `now - 30 days`. */ start?: string; subject?: string; } export declare const ListInvestigatesRequest: S.Schema; export type InvestigateListResultItemActionLogItemOperation = "MOVE" | "RELEASE" | "RECLASSIFY" | "SUBMISSION" | "QUARANTINE_RELEASE" | "PREVIEW"; export declare const InvestigateListResultItemActionLogItemOperation: any; export type InvestigateListResultItemActionLogItemProperties = InvestigateGetResponseActionLogItemProperties; export declare const InvestigateListResultItemActionLogItemProperties: S.Schema; export interface InvestigateListResultItemActionLogItem { /** Timestamp when action completed */ completedAt: string; /** Type of action performed */ operation: InvestigateListResultItemActionLogItemOperation; /** Deprecated, use `completed_at` instead. End of life: November 1, 2026. */ completedTimestamp?: string | null; /** Additional properties for the action */ properties?: InvestigateGetResponseActionLogItemProperties | null; /** Status of the action */ status?: string | null; } export declare const InvestigateListResultItemActionLogItem: S.Schema; export type InvestigateListResultItemActionLogList = Array; export declare const InvestigateListResultItemActionLogList: S.Schema; export type InvestigateListResultItemClientRecipientsList = Array; export declare const InvestigateListResultItemClientRecipientsList: S.Schema; export type InvestigateListResultItemDetectionReasonsList = Array; export declare const InvestigateListResultItemDetectionReasonsList: S.Schema; export type InvestigateListResultItemPropertiesAllowlistedPatternType = "quarantine_release" | "acceptable_sender" | "allowed_sender" | "allowed_recipient" | "domain_similarity" | "domain_recency" | "managed_acceptable_sender" | "outbound_ndr"; export declare const InvestigateListResultItemPropertiesAllowlistedPatternType: any; export type InvestigateListResultItemPropertiesWhitelistedPatternType = "quarantine_release" | "acceptable_sender" | "allowed_sender" | "allowed_recipient" | "domain_similarity" | "domain_recency" | "managed_acceptable_sender" | "outbound_ndr"; export declare const InvestigateListResultItemPropertiesWhitelistedPatternType: any; export interface InvestigateListResultItemProperties { /** Pattern that allowlisted this message */ allowlistedPattern?: string | null; /** Type of allowlist pattern */ allowlistedPatternType?: InvestigateListResultItemPropertiesAllowlistedPatternType | null; /** Whether message was blocklisted */ blocklistedMessage?: boolean | null; /** Pattern that blocklisted this message */ blocklistedPattern?: string | null; /** Legacy field for allowlist pattern type */ whitelistedPatternType?: InvestigateListResultItemPropertiesWhitelistedPatternType | null; } export declare const InvestigateListResultItemProperties: S.Schema; export type InvestigateListResultItemDeliveryMode = "DIRECT" | "BCC" | "JOURNAL" | "REVIEW_SUBMISSION" | "DMARC_UNVERIFIED" | "DMARC_FAILURE_REPORT" | "DMARC_AGGREGATE_REPORT" | "THREAT_INTEL_SUBMISSION" | "SIMULATION_SUBMISSION" | "API" | "RETRO_SCAN"; export declare const InvestigateListResultItemDeliveryMode: any; export type InvestigateListResultItemDeliveryStatusItem = "delivered" | "moved" | "quarantined" | "rejected" | "deferred" | "bounced" | "queued"; export declare const InvestigateListResultItemDeliveryStatusItem: any; export type InvestigateListResultItemDeliveryStatusList = Array; export declare const InvestigateListResultItemDeliveryStatusList: S.Schema; export type InvestigateListResultItemEnvelopeToList = Array; export declare const InvestigateListResultItemEnvelopeToList: S.Schema; export type InvestigateListResultItemFinalDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateListResultItemFinalDisposition: any; export type InvestigateListResultItemFindingsItemDetection = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const InvestigateListResultItemFindingsItemDetection: any; export interface InvestigateListResultItemFindingsItem { attachment?: string | null; detail?: string | null; detection?: InvestigateListResultItemFindingsItemDetection | null; field?: string | null; name?: string | null; portion?: string | null; reason?: string | null; score?: number | null; value?: string | null; } export declare const InvestigateListResultItemFindingsItem: S.Schema; export type InvestigateListResultItemFindingsList = Array; export declare const InvestigateListResultItemFindingsList: S.Schema; export type InvestigateListResultItemPostDeliveryOperationsItem = "PREVIEW" | "QUARANTINE_RELEASE" | "SUBMISSION" | "MOVE"; export declare const InvestigateListResultItemPostDeliveryOperationsItem: any; export type InvestigateListResultItemPostDeliveryOperationsList = Array; export declare const InvestigateListResultItemPostDeliveryOperationsList: S.Schema; export type InvestigateListResultItemThreatCategoriesList = Array; export declare const InvestigateListResultItemThreatCategoriesList: S.Schema; export type InvestigateListResultItemToList = Array; export declare const InvestigateListResultItemToList: S.Schema; export type InvestigateListResultItemToNameList = Array; export declare const InvestigateListResultItemToNameList: S.Schema; export type InvestigateListResultItemValidationDkim = "pass" | "neutral" | "fail" | "error" | "none"; export declare const InvestigateListResultItemValidationDkim: any; export type InvestigateListResultItemValidationDmarc = "pass" | "neutral" | "fail" | "error" | "none"; export declare const InvestigateListResultItemValidationDmarc: any; export type InvestigateListResultItemValidationSpf = "pass" | "neutral" | "fail" | "error" | "none"; export declare const InvestigateListResultItemValidationSpf: any; export interface InvestigateListResultItemValidation { comment?: string | null; dkim?: InvestigateListResultItemValidationDkim | null; dmarc?: InvestigateListResultItemValidationDmarc | null; spf?: InvestigateListResultItemValidationSpf | null; } export declare const InvestigateListResultItemValidation: S.Schema; export interface InvestigateListResultItem { /** Unique identifier for a message retrieved from investigation */ id: string; /** Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of life: November 1, 2026. */ actionLog: InvestigateListResultItemActionLogList; clientRecipients: InvestigateListResultItemClientRecipientsList; detectionReasons: InvestigateListResultItemDetectionReasonsList; isPhishSubmission: boolean; isQuarantined: boolean; /** The identifier of the message */ postfixId: string; /** Message processing properties */ properties: InvestigateListResultItemProperties; /** Deprecated, use `scanned_at` instead. End of life: November 1, 2026. */ ts: string; alertId?: string | null; deliveryMode?: InvestigateListResultItemDeliveryMode | null; deliveryStatus?: InvestigateListResultItemDeliveryStatusList | null; edfHash?: string | null; envelopeFrom?: string | null; envelopeTo?: InvestigateListResultItemEnvelopeToList | null; finalDisposition?: InvestigateListResultItemFinalDisposition | null; /** Deprecated, use the `findings` field from `GET /investigate/{investigate_id}/detections` instead. End of life: November 1, 2026. Detection findings for this message. */ findings?: InvestigateListResultItemFindingsList | null; from?: string | null; fromName?: string | null; htmltextStructureHash?: string | null; messageId?: string | null; /** Post-delivery operations performed on this message */ postDeliveryOperations?: InvestigateListResultItemPostDeliveryOperationsList | null; postfixIdOutbound?: string | null; replyto?: string | null; /** When the message was scanned (UTC) */ scannedAt?: string | null; /** When the message was sent (UTC) */ sentAt?: string | null; sentDate?: string | null; smtpHeloServerIp?: string | null; smtpPreviousHopIp?: string | null; subject?: string | null; threatCategories?: InvestigateListResultItemThreatCategoriesList | null; to?: InvestigateListResultItemToList | null; toName?: InvestigateListResultItemToNameList | null; validation?: InvestigateListResultItemValidation | null; xOriginatingIp?: string | null; } export declare const InvestigateListResultItem: S.Schema; export type InvestigateListResultList = Array; export declare const InvestigateListResultList: S.Schema; export interface ListInvestigatesResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: InvestigateListResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const ListInvestigatesResponse: S.Schema; export interface ListPhishguardReportsRequest { /** Identifier. */ accountId: string; /** End of the time range (RFC3339). Takes precedence over to_date. */ end?: string; /** Deprecated, use `start` instead. Start date in YYYY-MM-DD format. */ fromDate?: string; /** Start of the time range (RFC3339). Takes precedence over from_date. */ start?: string; /** Deprecated, use `end` instead. End date in YYYY-MM-DD format. */ toDate?: string; } export declare const ListPhishguardReportsRequest: S.Schema; export type PhishguardReportsListResultItemDisposition = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const PhishguardReportsListResultItemDisposition: any; export type PhishguardReportsListResultItemFieldsToList = Array; export declare const PhishguardReportsListResultItemFieldsToList: S.Schema; export interface PhishguardReportsListResultItemFields { to: PhishguardReportsListResultItemFieldsToList; from?: string | null; occurredAt?: string | null; postfixId?: string | null; /** Deprecated, use `occurred_at` instead */ ts?: string | null; } export declare const PhishguardReportsListResultItemFields: S.Schema; export interface PhishguardReportsListResultItemTagsItem { category: string; value: string; } export declare const PhishguardReportsListResultItemTagsItem: S.Schema; export type PhishguardReportsListResultItemTagsList = Array; export declare const PhishguardReportsListResultItemTagsList: S.Schema; export interface PhishguardReportsListResultItem { id: number; content: string; disposition: PhishguardReportsListResultItemDisposition; fields: PhishguardReportsListResultItemFields; priority: string; title: string; createdAt?: string | null; tags?: PhishguardReportsListResultItemTagsList | null; /** Deprecated, use `created_at` instead */ ts?: string | null; updatedAt?: string | null; } export declare const PhishguardReportsListResultItem: S.Schema; export type PhishguardReportsListResultList = Array; export declare const PhishguardReportsListResultList: S.Schema; export interface ListPhishguardReportsResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: PhishguardReportsListResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const ListPhishguardReportsResponse: S.Schema; export type SettingsAllowPoliciesListRequestDirection = "asc" | "desc"; export declare const SettingsAllowPoliciesListRequestDirection: any; export type SettingsAllowPoliciesListRequestOrder = "pattern" | "created_at"; export declare const SettingsAllowPoliciesListRequestOrder: any; export type SettingsAllowPoliciesListRequestPatternType = "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"; export declare const SettingsAllowPoliciesListRequestPatternType: any; export interface ListSettingAllowPoliciesRequest { /** Identifier. */ accountId: string; /** The sorting direction. */ direction?: SettingsAllowPoliciesListRequestDirection | (string & {}); /** Filter to show only policies where messages from the sender are exempted from Spam, Spoof, and Bulk dispositions (not Malicious or Suspicious). */ isAcceptableSender?: boolean; /** Filter to show only policies where messages to the recipient bypass all detections. */ isExemptRecipient?: boolean; /** Filter to show only policies where messages from the sender bypass all detections and link following. */ isTrustedSender?: boolean; /** Field to sort by. */ order?: SettingsAllowPoliciesListRequestOrder | (string & {}); /** Current page within paginated list of results. */ page?: number; pattern?: string; /** Type of pattern matching. */ patternType?: SettingsAllowPoliciesListRequestPatternType | (string & {}); /** The number of results per page. Maximum value is 1000. */ perPage?: number; /** Search term for filtering records. Behavior may change. */ search?: string; /** Filter to show only policies that enforce DMARC, SPF, or DKIM authentication. */ verifySender?: boolean; } export declare const ListSettingAllowPoliciesRequest: S.Schema; export type SettingsAllowPoliciesListResultItemPatternType = "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"; export declare const SettingsAllowPoliciesListResultItemPatternType: any; export interface SettingsAllowPoliciesListResultItem { /** Allow policy identifier */ id: string; createdAt: string; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified: string; comments?: string | null; /** Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note - This will not exempt messages with Malicious or Suspicious dispositions. */ isAcceptableSender?: boolean | null; /** Messages to this recipient will bypass all detections */ isExemptRecipient?: boolean | null; /** Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life: July 1, 2026. */ isRecipient?: boolean | null; isRegex?: boolean | null; /** Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life: July 1, 2026. */ isSender?: boolean | null; /** Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life: July 1, 2026. */ isSpoof?: boolean | null; /** Messages from this sender will bypass all detections and link following */ isTrustedSender?: boolean | null; modifiedAt?: string | null; pattern?: string | null; /** Type of pattern matching. */ patternType?: SettingsAllowPoliciesListResultItemPatternType | null; /** Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication. */ verifySender?: boolean | null; } export declare const SettingsAllowPoliciesListResultItem: S.Schema; export type SettingsAllowPoliciesListResultList = Array; export declare const SettingsAllowPoliciesListResultList: S.Schema; export interface ListSettingAllowPoliciesResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: SettingsAllowPoliciesListResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const ListSettingAllowPoliciesResponse: S.Schema; export type SettingsBlockSendersListRequestDirection = "asc" | "desc"; export declare const SettingsBlockSendersListRequestDirection: any; export type SettingsBlockSendersListRequestOrder = "pattern" | "created_at"; export declare const SettingsBlockSendersListRequestOrder: any; export type SettingsBlockSendersListRequestPatternType = "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"; export declare const SettingsBlockSendersListRequestPatternType: any; export interface ListSettingBlockSendersRequest { /** Identifier. */ accountId: string; /** The sorting direction. */ direction?: SettingsBlockSendersListRequestDirection | (string & {}); /** Field to sort by. */ order?: SettingsBlockSendersListRequestOrder | (string & {}); /** Current page within paginated list of results. */ page?: number; /** Filter by pattern value. */ pattern?: string; /** Filter by pattern type. */ patternType?: SettingsBlockSendersListRequestPatternType | (string & {}); /** The number of results per page. Maximum value is 1000. */ perPage?: number; /** Search term for filtering records. Behavior may change. */ search?: string; } export declare const ListSettingBlockSendersRequest: S.Schema; export type SettingsBlockSendersListResultItemPatternType = "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"; export declare const SettingsBlockSendersListResultItemPatternType: any; export interface SettingsBlockSendersListResultItem { /** Blocked sender pattern identifier */ id?: string | null; comments?: string | null; createdAt?: string | null; isRegex?: boolean | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; pattern?: string | null; /** Type of pattern matching. */ patternType?: SettingsBlockSendersListResultItemPatternType | null; } export declare const SettingsBlockSendersListResultItem: S.Schema; export type SettingsBlockSendersListResultList = Array; export declare const SettingsBlockSendersListResultList: S.Schema; export interface ListSettingBlockSendersResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: SettingsBlockSendersListResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const ListSettingBlockSendersResponse: S.Schema; export type SettingsDomainsListRequestActiveDeliveryMode = "DIRECT" | "BCC" | "JOURNAL" | "API" | "RETRO_SCAN"; export declare const SettingsDomainsListRequestActiveDeliveryMode: any; export type SettingsDomainsListRequestAllowedDeliveryMode = "DIRECT" | "BCC" | "JOURNAL" | "API" | "RETRO_SCAN"; export declare const SettingsDomainsListRequestAllowedDeliveryMode: any; export type SettingsDomainsListRequestDirection = "asc" | "desc"; export declare const SettingsDomainsListRequestDirection: any; export type SettingsDomainsListRequestDomainList = Array; export declare const SettingsDomainsListRequestDomainList: S.Schema; export type SettingsDomainsListRequestOrder = "domain" | "created_at"; export declare const SettingsDomainsListRequestOrder: any; export type SettingsDomainsListRequestStatus = "pending" | "active" | "failed" | "timeout"; export declare const SettingsDomainsListRequestStatus: any; export interface ListSettingDomainsRequest { /** Identifier. */ accountId: string; /** Currently active delivery mode to filter by. */ activeDeliveryMode?: SettingsDomainsListRequestActiveDeliveryMode | (string & {}); /** Delivery mode to filter by. */ allowedDeliveryMode?: SettingsDomainsListRequestAllowedDeliveryMode | (string & {}); /** The sorting direction. */ direction?: SettingsDomainsListRequestDirection | (string & {}); /** Domain names to filter by. */ domain?: SettingsDomainsListRequestDomainList; /** Integration ID to filter by. */ integrationId?: string; /** Field to sort by. */ order?: SettingsDomainsListRequestOrder | (string & {}); /** Current page within paginated list of results. */ page?: number; /** The number of results per page. Maximum value is 1000. */ perPage?: number; /** Search term for filtering records. Behavior may change. */ search?: string; /** Filters response to domains with the provided status. */ status?: SettingsDomainsListRequestStatus | (string & {}); } export declare const ListSettingDomainsRequest: S.Schema; export type SettingsDomainsListResultItemAllowedDeliveryModesItem = "DIRECT" | "BCC" | "JOURNAL" | "API" | "RETRO_SCAN"; export declare const SettingsDomainsListResultItemAllowedDeliveryModesItem: any; export type SettingsDomainsListResultItemAllowedDeliveryModesList = Array; export declare const SettingsDomainsListResultItemAllowedDeliveryModesList: S.Schema; export type SettingsDomainsListResultItemAuthorization = SettingsDomainsGetResponseAuthorization; export declare const SettingsDomainsListResultItemAuthorization: S.Schema; export type SettingsDomainsListResultItemDmarcStatus = "none" | "good" | "invalid"; export declare const SettingsDomainsListResultItemDmarcStatus: any; export type SettingsDomainsListResultItemDropDispositionsItem = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const SettingsDomainsListResultItemDropDispositionsItem: any; export type SettingsDomainsListResultItemDropDispositionsList = Array; export declare const SettingsDomainsListResultItemDropDispositionsList: S.Schema; export type SettingsDomainsListResultItemEmailsProcessed = SettingsDomainsGetResponseEmailsProcessed; export declare const SettingsDomainsListResultItemEmailsProcessed: S.Schema; export type SettingsDomainsListResultItemFolder = "AllItems" | "Inbox"; export declare const SettingsDomainsListResultItemFolder: any; export type SettingsDomainsListResultItemInboxProvider = "Microsoft" | "Google"; export declare const SettingsDomainsListResultItemInboxProvider: any; export type SettingsDomainsListResultItemIpRestrictionsList = Array; export declare const SettingsDomainsListResultItemIpRestrictionsList: S.Schema; export type SettingsDomainsListResultItemRegionsItem = "GLOBAL" | "AU" | "DE" | "IN" | "US"; export declare const SettingsDomainsListResultItemRegionsItem: any; export type SettingsDomainsListResultItemRegionsList = Array; export declare const SettingsDomainsListResultItemRegionsList: S.Schema; export type SettingsDomainsListResultItemSpfStatus = "none" | "good" | "neutral" | "open" | "invalid"; export declare const SettingsDomainsListResultItemSpfStatus: any; export type SettingsDomainsListResultItemStatus = "pending" | "active" | "failed" | "timeout"; export declare const SettingsDomainsListResultItemStatus: any; export interface SettingsDomainsListResultItem { /** Domain identifier */ id?: string | null; allowedDeliveryModes?: SettingsDomainsListResultItemAllowedDeliveryModesList | null; authorization?: SettingsDomainsGetResponseAuthorization | null; createdAt?: string | null; dmarcStatus?: SettingsDomainsListResultItemDmarcStatus | null; domain?: string | null; dropDispositions?: SettingsDomainsListResultItemDropDispositionsList | null; emailsProcessed?: SettingsDomainsGetResponseEmailsProcessed | null; folder?: SettingsDomainsListResultItemFolder | null; inboxProvider?: SettingsDomainsListResultItemInboxProvider | null; integrationId?: string | null; ipRestrictions?: SettingsDomainsListResultItemIpRestrictionsList | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; lookbackHops?: number | null; modifiedAt?: string | null; o365TenantId?: string | null; regions?: SettingsDomainsListResultItemRegionsList | null; requireTlsInbound?: boolean | null; requireTlsOutbound?: boolean | null; spfStatus?: SettingsDomainsListResultItemSpfStatus | null; status?: SettingsDomainsListResultItemStatus | null; transport?: string | null; } export declare const SettingsDomainsListResultItem: S.Schema; export type SettingsDomainsListResultList = Array; export declare const SettingsDomainsListResultList: S.Schema; export interface ListSettingDomainsResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: SettingsDomainsListResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const ListSettingDomainsResponse: S.Schema; export type SettingsImpersonationRegistryListRequestDirection = "asc" | "desc"; export declare const SettingsImpersonationRegistryListRequestDirection: any; export type SettingsImpersonationRegistryListRequestOrder = "name" | "email" | "created_at"; export declare const SettingsImpersonationRegistryListRequestOrder: any; export type SettingsImpersonationRegistryListRequestProvenance = "A1S_INTERNAL" | "SNOOPY-CASB_OFFICE_365" | "SNOOPY-OFFICE_365" | "SNOOPY-GOOGLE_DIRECTORY"; export declare const SettingsImpersonationRegistryListRequestProvenance: any; export interface ListSettingImpersonationRegistriesRequest { /** Identifier. */ accountId: string; /** The sorting direction. */ direction?: SettingsImpersonationRegistryListRequestDirection | (string & {}); /** Field to sort by. */ order?: SettingsImpersonationRegistryListRequestOrder | (string & {}); /** Current page within paginated list of results. */ page?: number; /** The number of results per page. Maximum value is 1000. */ perPage?: number; provenance?: SettingsImpersonationRegistryListRequestProvenance | (string & {}); /** Search term for filtering records. Behavior may change. */ search?: string; } export declare const ListSettingImpersonationRegistriesRequest: S.Schema; export type SettingsImpersonationRegistryListResultItemProvenance = "A1S_INTERNAL" | "SNOOPY-CASB_OFFICE_365" | "SNOOPY-OFFICE_365" | "SNOOPY-GOOGLE_DIRECTORY"; export declare const SettingsImpersonationRegistryListResultItemProvenance: any; export interface SettingsImpersonationRegistryListResultItem { /** Impersonation registry entry identifier */ id?: string | null; comments?: string | null; createdAt?: string | null; directoryId?: number | null; directoryNodeId?: number | null; email?: string | null; externalDirectoryNodeId?: string | null; isEmailRegex?: boolean | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; name?: string | null; provenance?: SettingsImpersonationRegistryListResultItemProvenance | null; } export declare const SettingsImpersonationRegistryListResultItem: S.Schema; export type SettingsImpersonationRegistryListResultList = Array; export declare const SettingsImpersonationRegistryListResultList: S.Schema; export interface ListSettingImpersonationRegistriesResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: SettingsImpersonationRegistryListResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const ListSettingImpersonationRegistriesResponse: S.Schema; export type SettingsSendingDomainRestrictionsListRequestDirection = "asc" | "desc"; export declare const SettingsSendingDomainRestrictionsListRequestDirection: any; export type SettingsSendingDomainRestrictionsListRequestOrder = "domain" | "created_at"; export declare const SettingsSendingDomainRestrictionsListRequestOrder: any; export interface ListSettingSendingDomainRestrictionsRequest { /** Identifier. */ accountId: string; /** The sorting direction. */ direction?: SettingsSendingDomainRestrictionsListRequestDirection | (string & {}); /** Field to sort by. */ order?: SettingsSendingDomainRestrictionsListRequestOrder | (string & {}); /** Current page within paginated list of results. */ page?: number; /** The number of results per page. Maximum value is 1000. */ perPage?: number; /** Search term for filtering records. Behavior may change. */ search?: string; } export declare const ListSettingSendingDomainRestrictionsRequest: S.Schema; export type SettingsSendingDomainRestrictionsListResultItemExcludeList = Array; export declare const SettingsSendingDomainRestrictionsListResultItemExcludeList: S.Schema; export interface SettingsSendingDomainRestrictionsListResultItem { /** Sending domain restriction identifier. */ id?: string | null; comments?: string | null; createdAt?: string | null; /** Domain that requires TLS enforcement. */ domain?: string | null; /** Excluded subdomains that are exempt from TLS requirements. */ exclude?: SettingsSendingDomainRestrictionsListResultItemExcludeList | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; } export declare const SettingsSendingDomainRestrictionsListResultItem: S.Schema; export type SettingsSendingDomainRestrictionsListResultList = Array; export declare const SettingsSendingDomainRestrictionsListResultList: S.Schema; export interface ListSettingSendingDomainRestrictionsResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: SettingsSendingDomainRestrictionsListResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const ListSettingSendingDomainRestrictionsResponse: S.Schema; export type SettingsTrustedDomainsListRequestDirection = "asc" | "desc"; export declare const SettingsTrustedDomainsListRequestDirection: any; export type SettingsTrustedDomainsListRequestOrder = "pattern" | "created_at"; export declare const SettingsTrustedDomainsListRequestOrder: any; export interface ListSettingTrustedDomainsRequest { /** Identifier. */ accountId: string; /** The sorting direction. */ direction?: SettingsTrustedDomainsListRequestDirection | (string & {}); /** Filter to show only recently registered domains that are trusted to prevent triggering Suspicious or Malicious dispositions. */ isRecent?: boolean; /** Filter to show only proximity domains (partner or approved domains with similar spelling to connected domains) that prevent Spoof dispositions. */ isSimilarity?: boolean; /** Field to sort by. */ order?: SettingsTrustedDomainsListRequestOrder | (string & {}); /** Current page within paginated list of results. */ page?: number; pattern?: string; /** The number of results per page. Maximum value is 1000. */ perPage?: number; /** Search term for filtering records. Behavior may change. */ search?: string; } export declare const ListSettingTrustedDomainsRequest: S.Schema; export interface SettingsTrustedDomainsListResultItem { /** Trusted domain identifier */ id?: string | null; comments?: string | null; createdAt?: string | null; /** Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition. */ isRecent?: boolean | null; isRegex?: boolean | null; /** Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition. */ isSimilarity?: boolean | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; pattern?: string | null; } export declare const SettingsTrustedDomainsListResultItem: S.Schema; export type SettingsTrustedDomainsListResultList = Array; export declare const SettingsTrustedDomainsListResultList: S.Schema; export interface ListSettingTrustedDomainsResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: SettingsTrustedDomainsListResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const ListSettingTrustedDomainsResponse: S.Schema; export interface ListSettingUrlIgnorePatternsRequest { /** Identifier. */ accountId: string; /** Current page within paginated list of results. */ page?: number; /** The number of results per page. Maximum value is 1000. */ perPage?: number; } export declare const ListSettingUrlIgnorePatternsRequest: S.Schema; export interface SettingsUrlIgnorePatternsListResultItem { /** URL ignore pattern identifier */ id: string; createdAt: string; /** Regular expression matching URLs that should not be rewritten. */ pattern: string; /** Optional note describing the reason for the ignore pattern. */ comments?: string | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; } export declare const SettingsUrlIgnorePatternsListResultItem: S.Schema; export type SettingsUrlIgnorePatternsListResultList = Array; export declare const SettingsUrlIgnorePatternsListResultList: S.Schema; export interface ListSettingUrlIgnorePatternsResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: SettingsUrlIgnorePatternsListResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const ListSettingUrlIgnorePatternsResponse: S.Schema; export type SubmissionsListRequestOriginalDisposition = "MALICIOUS" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "NONE"; export declare const SubmissionsListRequestOriginalDisposition: any; export type SubmissionsListRequestOutcomeDisposition = "MALICIOUS" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "NONE"; export declare const SubmissionsListRequestOutcomeDisposition: any; export type SubmissionsListRequestRequestedDisposition = "MALICIOUS" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "NONE"; export declare const SubmissionsListRequestRequestedDisposition: any; export type SubmissionsListRequestType = "TEAM" | "USER"; export declare const SubmissionsListRequestType: any; export interface ListSubmissionsRequest { /** Identifier. */ accountId: string; /** The end of the search date range. Defaults to `now`. */ end?: string; /** When true, return only submissions that were escalated by an end user (vs. by the security team). When false, return only submissions that were not escalated by an end user. When omitted, no filter is applied. */ escalatedFromUser?: boolean; originalDisposition?: SubmissionsListRequestOriginalDisposition | (string & {}); outcomeDisposition?: SubmissionsListRequestOutcomeDisposition | (string & {}); /** Current page within paginated list of results. */ page?: number; /** The number of results per page. Maximum value is 1000. */ perPage?: number; query?: string; requestedDisposition?: SubmissionsListRequestRequestedDisposition | (string & {}); /** The beginning of the search date range. Defaults to `now - 30 days`. */ start?: string; status?: string; submissionId?: string; type?: SubmissionsListRequestType | (string & {}); } export declare const ListSubmissionsRequest: S.Schema; export type SubmissionsListResultItemCustomerStatus = "escalated" | "reviewed" | "unreviewed"; export declare const SubmissionsListResultItemCustomerStatus: any; export type SubmissionsListResultItemEscalatedAs = "MALICIOUS" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "NONE"; export declare const SubmissionsListResultItemEscalatedAs: any; export type SubmissionsListResultItemOriginalDisposition = "MALICIOUS" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "NONE"; export declare const SubmissionsListResultItemOriginalDisposition: any; export type SubmissionsListResultItemOutcomeDisposition = "MALICIOUS" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "NONE"; export declare const SubmissionsListResultItemOutcomeDisposition: any; export type SubmissionsListResultItemRequestedDisposition = "MALICIOUS" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "NONE"; export declare const SubmissionsListResultItemRequestedDisposition: any; export type SubmissionsListResultItemType = "Team" | "User"; export declare const SubmissionsListResultItemType: any; export interface SubmissionsListResultItem { /** When the submission was requested (UTC). */ requestedAt: string; submissionId: string; customerStatus?: SubmissionsListResultItemCustomerStatus | null; escalatedAs?: SubmissionsListResultItemEscalatedAs | null; escalatedAt?: string | null; escalatedBy?: string | null; escalatedSubmissionId?: string | null; originalDisposition?: SubmissionsListResultItemOriginalDisposition | null; originalEdfHash?: string | null; /** The postfix ID of the original message that was submitted */ originalPostfixId?: string | null; outcome?: string | null; outcomeDisposition?: SubmissionsListResultItemOutcomeDisposition | null; requestedBy?: string | null; requestedDisposition?: SubmissionsListResultItemRequestedDisposition | null; /** Deprecated, use `requested_at` instead */ requestedTs?: string | null; status?: string | null; subject?: string | null; /** Whether the submission was created by a team member or an end user. */ type?: SubmissionsListResultItemType | null; } export declare const SubmissionsListResultItem: S.Schema; export type SubmissionsListResultList = Array; export declare const SubmissionsListResultList: S.Schema; export interface ListSubmissionsResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: SubmissionsListResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const ListSubmissionsResponse: S.Schema; export type SettingsAllowPoliciesEditRequestPatternType = "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"; export declare const SettingsAllowPoliciesEditRequestPatternType: any; export interface PatchSettingAllowPolicyRequest { /** Identifier. */ accountId: string; /** Allow policy identifier */ policyId: string; comments?: string; /** Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note - This will not exempt messages with Malicious or Suspicious dispositions. */ isAcceptableSender?: boolean; /** Messages to this recipient will bypass all detections */ isExemptRecipient?: boolean; /** Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life: July 1, 2026. */ isRecipient?: boolean; isRegex?: boolean; /** Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life: July 1, 2026. */ isSender?: boolean; /** Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life: July 1, 2026. */ isSpoof?: boolean; /** Messages from this sender will bypass all detections and link following */ isTrustedSender?: boolean; pattern?: string; /** Type of pattern matching. */ patternType?: SettingsAllowPoliciesEditRequestPatternType | (string & {}); /** Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication. */ verifySender?: boolean; } export declare const PatchSettingAllowPolicyRequest: S.Schema; export type SettingsAllowPoliciesEditResponsePatternType = "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"; export declare const SettingsAllowPoliciesEditResponsePatternType: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface PatchSettingAllowPolicyResponse { /** Allow policy identifier */ id: string; createdAt: string; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified: string; comments?: string | null; /** Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note - This will not exempt messages with Malicious or Suspicious dispositions. */ isAcceptableSender?: boolean | null; /** Messages to this recipient will bypass all detections */ isExemptRecipient?: boolean | null; /** Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life: July 1, 2026. */ isRecipient?: boolean | null; isRegex?: boolean | null; /** Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life: July 1, 2026. */ isSender?: boolean | null; /** Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life: July 1, 2026. */ isSpoof?: boolean | null; /** Messages from this sender will bypass all detections and link following */ isTrustedSender?: boolean | null; modifiedAt?: string | null; pattern?: string | null; /** Type of pattern matching. */ patternType?: SettingsAllowPoliciesEditResponsePatternType | null; /** Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication. */ verifySender?: boolean | null; } export declare const PatchSettingAllowPolicyResponse: S.Schema; export type SettingsBlockSendersEditRequestPatternType = "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"; export declare const SettingsBlockSendersEditRequestPatternType: any; export interface PatchSettingBlockSenderRequest { /** Identifier. */ accountId: string; /** Blocked sender pattern identifier */ patternId: string; comments?: string; isRegex?: boolean; pattern?: string; /** Type of pattern matching. */ patternType?: SettingsBlockSendersEditRequestPatternType | (string & {}); } export declare const PatchSettingBlockSenderRequest: S.Schema; export type SettingsBlockSendersEditResponsePatternType = "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"; export declare const SettingsBlockSendersEditResponsePatternType: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface PatchSettingBlockSenderResponse { /** Blocked sender pattern identifier */ id?: string | null; comments?: string | null; createdAt?: string | null; isRegex?: boolean | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; pattern?: string | null; /** Type of pattern matching. */ patternType?: SettingsBlockSendersEditResponsePatternType | null; } export declare const PatchSettingBlockSenderResponse: S.Schema; export type SettingsDomainsEditRequestAllowedDeliveryModesItem = "DIRECT" | "BCC" | "JOURNAL" | "API" | "RETRO_SCAN"; export declare const SettingsDomainsEditRequestAllowedDeliveryModesItem: any; export type SettingsDomainsEditRequestAllowedDeliveryModesList = Array; export declare const SettingsDomainsEditRequestAllowedDeliveryModesList: S.Schema; export type SettingsDomainsEditRequestDropDispositionsItem = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const SettingsDomainsEditRequestDropDispositionsItem: any; export type SettingsDomainsEditRequestDropDispositionsList = Array; export declare const SettingsDomainsEditRequestDropDispositionsList: S.Schema; export type SettingsDomainsEditRequestFolder = "AllItems" | "Inbox"; export declare const SettingsDomainsEditRequestFolder: any; export type SettingsDomainsEditRequestIpRestrictionsList = Array; export declare const SettingsDomainsEditRequestIpRestrictionsList: S.Schema; export type SettingsDomainsEditRequestRegionsItem = "GLOBAL" | "AU" | "DE" | "IN" | "US"; export declare const SettingsDomainsEditRequestRegionsItem: any; export type SettingsDomainsEditRequestRegionsList = Array; export declare const SettingsDomainsEditRequestRegionsList: S.Schema; export interface PatchSettingDomainRequest { /** Identifier. */ accountId: string; /** Domain identifier */ domainId: string; allowedDeliveryModes?: SettingsDomainsEditRequestAllowedDeliveryModesList; domain?: string; dropDispositions?: SettingsDomainsEditRequestDropDispositionsList; folder?: SettingsDomainsEditRequestFolder | (string & {}); integrationId?: string; ipRestrictions?: SettingsDomainsEditRequestIpRestrictionsList; lookbackHops?: number; regions?: SettingsDomainsEditRequestRegionsList; requireTlsInbound?: boolean; requireTlsOutbound?: boolean; transport?: string; } export declare const PatchSettingDomainRequest: S.Schema; export type SettingsDomainsEditResponseAllowedDeliveryModesItem = "DIRECT" | "BCC" | "JOURNAL" | "API" | "RETRO_SCAN"; export declare const SettingsDomainsEditResponseAllowedDeliveryModesItem: any; export type SettingsDomainsEditResponseAllowedDeliveryModesList = Array; export declare const SettingsDomainsEditResponseAllowedDeliveryModesList: S.Schema; export type SettingsDomainsEditResponseAuthorization = SettingsDomainsGetResponseAuthorization; export declare const SettingsDomainsEditResponseAuthorization: S.Schema; export type SettingsDomainsEditResponseDmarcStatus = "none" | "good" | "invalid"; export declare const SettingsDomainsEditResponseDmarcStatus: any; export type SettingsDomainsEditResponseDropDispositionsItem = "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | "SPOOF" | "SPAM" | "BULK" | "ENCRYPTED" | "EXTERNAL" | "UNKNOWN" | "NONE"; export declare const SettingsDomainsEditResponseDropDispositionsItem: any; export type SettingsDomainsEditResponseDropDispositionsList = Array; export declare const SettingsDomainsEditResponseDropDispositionsList: S.Schema; export type SettingsDomainsEditResponseEmailsProcessed = SettingsDomainsGetResponseEmailsProcessed; export declare const SettingsDomainsEditResponseEmailsProcessed: S.Schema; export type SettingsDomainsEditResponseFolder = "AllItems" | "Inbox"; export declare const SettingsDomainsEditResponseFolder: any; export type SettingsDomainsEditResponseInboxProvider = "Microsoft" | "Google"; export declare const SettingsDomainsEditResponseInboxProvider: any; export type SettingsDomainsEditResponseIpRestrictionsList = Array; export declare const SettingsDomainsEditResponseIpRestrictionsList: S.Schema; export type SettingsDomainsEditResponseRegionsItem = "GLOBAL" | "AU" | "DE" | "IN" | "US"; export declare const SettingsDomainsEditResponseRegionsItem: any; export type SettingsDomainsEditResponseRegionsList = Array; export declare const SettingsDomainsEditResponseRegionsList: S.Schema; export type SettingsDomainsEditResponseSpfStatus = "none" | "good" | "neutral" | "open" | "invalid"; export declare const SettingsDomainsEditResponseSpfStatus: any; export type SettingsDomainsEditResponseStatus = "pending" | "active" | "failed" | "timeout"; export declare const SettingsDomainsEditResponseStatus: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface PatchSettingDomainResponse { /** Domain identifier */ id?: string | null; allowedDeliveryModes?: SettingsDomainsEditResponseAllowedDeliveryModesList | null; authorization?: SettingsDomainsGetResponseAuthorization | null; createdAt?: string | null; dmarcStatus?: SettingsDomainsEditResponseDmarcStatus | null; domain?: string | null; dropDispositions?: SettingsDomainsEditResponseDropDispositionsList | null; emailsProcessed?: SettingsDomainsGetResponseEmailsProcessed | null; folder?: SettingsDomainsEditResponseFolder | null; inboxProvider?: SettingsDomainsEditResponseInboxProvider | null; integrationId?: string | null; ipRestrictions?: SettingsDomainsEditResponseIpRestrictionsList | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; lookbackHops?: number | null; modifiedAt?: string | null; o365TenantId?: string | null; regions?: SettingsDomainsEditResponseRegionsList | null; requireTlsInbound?: boolean | null; requireTlsOutbound?: boolean | null; spfStatus?: SettingsDomainsEditResponseSpfStatus | null; status?: SettingsDomainsEditResponseStatus | null; transport?: string | null; } export declare const PatchSettingDomainResponse: S.Schema; export type SettingsImpersonationRegistryEditRequestProvenance = "A1S_INTERNAL" | "SNOOPY-CASB_OFFICE_365" | "SNOOPY-OFFICE_365" | "SNOOPY-GOOGLE_DIRECTORY"; export declare const SettingsImpersonationRegistryEditRequestProvenance: any; export interface PatchSettingImpersonationRegistryRequest { /** Identifier. */ accountId: string; /** Impersonation registry entry identifier */ impersonationRegistryId: string; comments?: string; directoryId?: number; directoryNodeId?: number; email?: string; externalDirectoryNodeId?: string; isEmailRegex?: boolean; name?: string; provenance?: SettingsImpersonationRegistryEditRequestProvenance | (string & {}); } export declare const PatchSettingImpersonationRegistryRequest: S.Schema; export type SettingsImpersonationRegistryEditResponseProvenance = "A1S_INTERNAL" | "SNOOPY-CASB_OFFICE_365" | "SNOOPY-OFFICE_365" | "SNOOPY-GOOGLE_DIRECTORY"; export declare const SettingsImpersonationRegistryEditResponseProvenance: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface PatchSettingImpersonationRegistryResponse { /** Impersonation registry entry identifier */ id?: string | null; comments?: string | null; createdAt?: string | null; directoryId?: number | null; directoryNodeId?: number | null; email?: string | null; externalDirectoryNodeId?: string | null; isEmailRegex?: boolean | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; name?: string | null; provenance?: SettingsImpersonationRegistryEditResponseProvenance | null; } export declare const PatchSettingImpersonationRegistryResponse: S.Schema; export type SettingsSendingDomainRestrictionsEditRequestExcludeList = Array; export declare const SettingsSendingDomainRestrictionsEditRequestExcludeList: S.Schema; export interface PatchSettingSendingDomainRestrictionRequest { /** Identifier. */ accountId: string; /** Sending domain restriction identifier. */ sendingDomainRestrictionId: string; comments?: string; /** Domain that requires TLS enforcement. */ domain?: string; /** Excluded subdomains that are exempt from TLS requirements. */ exclude?: SettingsSendingDomainRestrictionsEditRequestExcludeList; } export declare const PatchSettingSendingDomainRestrictionRequest: S.Schema; export type SettingsSendingDomainRestrictionsEditResponseExcludeList = Array; export declare const SettingsSendingDomainRestrictionsEditResponseExcludeList: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface PatchSettingSendingDomainRestrictionResponse { /** Sending domain restriction identifier. */ id?: string | null; comments?: string | null; createdAt?: string | null; /** Domain that requires TLS enforcement. */ domain?: string | null; /** Excluded subdomains that are exempt from TLS requirements. */ exclude?: SettingsSendingDomainRestrictionsEditResponseExcludeList | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; } export declare const PatchSettingSendingDomainRestrictionResponse: S.Schema; export interface PatchSettingTrustedDomainRequest { /** Identifier. */ accountId: string; /** Trusted domain identifier */ trustedDomainId: string; comments?: string; /** Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition. */ isRecent?: boolean; isRegex?: boolean; /** Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition. */ isSimilarity?: boolean; pattern?: string; } export declare const PatchSettingTrustedDomainRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface PatchSettingTrustedDomainResponse { /** Trusted domain identifier */ id?: string | null; comments?: string | null; createdAt?: string | null; /** Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition. */ isRecent?: boolean | null; isRegex?: boolean | null; /** Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition. */ isSimilarity?: boolean | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; pattern?: string | null; } export declare const PatchSettingTrustedDomainResponse: S.Schema; export interface PatchSettingUrlIgnorePatternRequest { /** Identifier. */ accountId: string; /** URL ignore pattern identifier */ patternId: string; /** Optional note describing the reason for the ignore pattern. */ comments?: string; /** Regular expression matching URLs that should not be rewritten. */ pattern?: string; } export declare const PatchSettingUrlIgnorePatternRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface PatchSettingUrlIgnorePatternResponse { /** URL ignore pattern identifier */ id: string; createdAt: string; /** Regular expression matching URLs that should not be rewritten. */ pattern: string; /** Optional note describing the reason for the ignore pattern. */ comments?: string | null; /** Deprecated, use `modified_at` instead. End of life: November 1, 2026. */ lastModified?: string | null; modifiedAt?: string | null; } export declare const PatchSettingUrlIgnorePatternResponse: S.Schema; export type BulkInvestigateMoveError = CloudflareOpError; /** Moves multiple messages to a specified mailbox folder (Inbox, JunkEmail, DeletedItems, RecoverableItemsDeletions, or RecoverableItemsPurges). Requires active integration. */ export declare const bulkInvestigateMove: API.PaginatedOperationMethod; export type BulkInvestigateReleaseError = CloudflareOpError; /** Releases one or more quarantined messages, delivering them to the intended recipients. Use when a message was incorrectly quarantined. Returns delivery status for each recipient. */ export declare const bulkInvestigateRelease: API.PaginatedOperationMethod; export type CreateInvestigateBulkError = CloudflareOpError; /** Create a bulk action job */ export declare const createInvestigateBulk: API.OperationMethod; export type CreateInvestigateBulkCancelError = CloudflareOpError; /** Marks the job as cancelled and stops any pending message processing. The job record remains visible in list and detail endpoints. */ export declare const createInvestigateBulkCancel: API.OperationMethod; export type CreateInvestigateMoveError = CloudflareOpError; /** Moves a single message to a specified mailbox folder (Inbox, JunkEmail, DeletedItems, RecoverableItemsDeletions, or RecoverableItemsPurges). Requires active integration. */ export declare const createInvestigateMove: API.PaginatedOperationMethod; export type CreateInvestigatePreviewError = CloudflareOpError; /** Generates a preview image for a message that was not flagged as a detection. Useful for investigating benign messages. Returns a base64-encoded PNG screenshot of the email body. */ export declare const createInvestigatePreview: API.OperationMethod; export type CreateInvestigateReclassifyError = CloudflareOpError; /** Submits a request to reclassify an email's disposition. Use for reporting false positives or false negatives. Optionally provide the raw EML content for reanalysis. The reclassification is processed asynchronously. */ export declare const createInvestigateReclassify: API.OperationMethod; export type CreateSettingAllowPolicyError = EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Creates a new allow policy that exempts matching emails from security detections. Use with caution as this bypasses email security scanning. Policies can match on sender patterns and apply to specific detections or all detections. */ export declare const createSettingAllowPolicy: API.OperationMethod; export type CreateSettingBlockSenderError = EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Creates a new blocked sender pattern. Emails matching this pattern will be blocked from delivery. Patterns can be email addresses, domains, or IP addresses, and support regular expressions. */ export declare const createSettingBlockSender: API.OperationMethod; export type CreateSettingImpersonationRegistryError = EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Creates a new entry in the impersonation registry to protect against impersonation. Emails attempting to impersonate this identity will be flagged. Supports regex patterns for flexible email matching. */ export declare const createSettingImpersonationRegistry: API.OperationMethod; export type CreateSettingSendingDomainRestrictionError = CloudflareOpError; /** Creates a new sending domain restriction to enforce TLS requirements for a domain. Emails without TLS from this domain will be dropped unless the subdomain is in the exclude list. */ export declare const createSettingSendingDomainRestriction: API.OperationMethod; export type CreateSettingTrustedDomainError = EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Creates a new trusted domain pattern. Use for partner domains or approved senders that should bypass recent domain registration and similarity checks. Configure whether it prevents recent domain or spoof dispositions. */ export declare const createSettingTrustedDomain: API.OperationMethod; export type CreateSettingUrlIgnorePatternError = CloudflareOpError; /** Creates a new URL rewrite ignore pattern. URLs matching this pattern will not be rewritten. */ export declare const createSettingUrlIgnorePattern: API.OperationMethod; export type DeleteInvestigateBulkError = CloudflareOpError; /** Deletes the job, removing it from all list and detail endpoints. Only jobs in a terminal state (`COMPLETED`, `CANCELLED`, `FAILED`, or `SKIPPED`) can be deleted. To stop an in-progress job without removing it, use the cancel endpoint instead. */ export declare const deleteInvestigateBulk: API.OperationMethod; export type DeleteSettingAllowPolicyError = AllowPolicyNotFound | EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Removes an allow policy. After deletion, emails matching this pattern will be subject to normal security scanning and disposition actions. */ export declare const deleteSettingAllowPolicy: API.OperationMethod; export type DeleteSettingBlockSenderError = BlockSenderNotFound | EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Removes a blocked sender pattern. After deletion, emails from this sender will no longer be automatically blocked based on this rule. */ export declare const deleteSettingBlockSender: API.OperationMethod; export type DeleteSettingDomainError = EmailSecurityDomainNotFound | EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Removes email security protection from a domain. After deletion, emails for this domain will no longer be processed by Email Security. This action cannot be undone. */ export declare const deleteSettingDomain: API.OperationMethod; export type DeleteSettingImpersonationRegistryError = ImpersonationRegistryEntryNotFound | EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Removes an entry from the impersonation registry. After deletion, this identity will no longer be protected from impersonation. */ export declare const deleteSettingImpersonationRegistry: API.OperationMethod; export type DeleteSettingSendingDomainRestrictionError = CloudflareOpError; /** Removes a sending domain restriction. After deletion, TLS will no longer be enforced for emails from this domain. */ export declare const deleteSettingSendingDomainRestriction: API.OperationMethod; export type DeleteSettingTrustedDomainError = TrustedDomainNotFound | EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Removes a trusted domain pattern. After deletion, emails from this domain will be subject to normal recent domain and similarity checks. */ export declare const deleteSettingTrustedDomain: API.OperationMethod; export type DeleteSettingUrlIgnorePatternError = CloudflareOpError; /** Removes a URL rewrite ignore pattern. After deletion, URLs matching this pattern will be rewritten again. */ export declare const deleteSettingUrlIgnorePattern: API.OperationMethod; export type GetInvestigateError = CloudflareOpError; /** Retrieves comprehensive details for a specific email message including headers, recipients, sender information, and current quarantine status. Use the investigate_id from search results to fetch detailed information. */ export declare const getInvestigate: API.OperationMethod; export type GetInvestigateBulkError = CloudflareOpError; /** Get bulk action job details */ export declare const getInvestigateBulk: API.OperationMethod; export type GetInvestigateDetectionError = CloudflareOpError; /** Returns detection details such as threat categories and sender information for non-benign messages. */ export declare const getInvestigateDetection: API.OperationMethod; export type GetInvestigatePreviewError = CloudflareOpError; /** Returns a preview of the message body as a base64 encoded PNG image for non-benign messages. */ export declare const getInvestigatePreview: API.OperationMethod; export type GetInvestigateRawError = CloudflareOpError; /** Returns the raw eml of any non-benign message. */ export declare const getInvestigateRaw: API.OperationMethod; export type GetInvestigateTraceError = CloudflareOpError; /** Retrieves delivery and processing trace information for an email message. Shows the delivery path, retraction history, and move operations performed on the message. Useful for debugging delivery issues. */ export declare const getInvestigateTrace: API.OperationMethod; export type GetSettingAllowPolicyError = AllowPolicyNotFound | EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Retrieves details for a specific allow policy including its pattern, dispositions that are exempted, and whether it applies to all detections. */ export declare const getSettingAllowPolicy: API.OperationMethod; export type GetSettingBlockSenderError = BlockSenderNotFound | EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Retrieves details for a specific blocked sender pattern including its pattern type, value, and metadata. */ export declare const getSettingBlockSender: API.OperationMethod; export type GetSettingDomainError = EmailSecurityDomainNotFound | EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Retrieves detailed information for a specific protected email domain including its delivery configuration, SPF/DMARC status, and authorization state. */ export declare const getSettingDomain: API.OperationMethod; export type GetSettingImpersonationRegistryError = ImpersonationRegistryEntryNotFound | EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Retrieves details for a specific impersonation registry entry including the protected identity, email pattern, and synchronization source if directory-synced. */ export declare const getSettingImpersonationRegistry: API.OperationMethod; export type GetSettingSendingDomainRestrictionError = CloudflareOpError; /** Retrieves details for a specific sending domain restriction including the domain requiring TLS and any excluded subdomains exempt from the TLS requirement. */ export declare const getSettingSendingDomainRestriction: API.OperationMethod; export type GetSettingTrustedDomainError = TrustedDomainNotFound | EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Retrieves details for a specific trusted domain pattern including its pattern value, whether it uses regex matching, and which detection types it affects. */ export declare const getSettingTrustedDomain: API.OperationMethod; export type GetSettingUrlIgnorePatternError = CloudflareOpError; /** Returns a single URL rewrite ignore pattern by its identifier. */ export declare const getSettingUrlIgnorePattern: API.OperationMethod; export type ListInvestigateBulkMessagesError = CloudflareOpError; /** List messages for a bulk action job */ export declare const listInvestigateBulkMessages: API.PaginatedOperationMethod; export type ListInvestigateBulksError = CloudflareOpError; /** List bulk action jobs */ export declare const listInvestigateBulks: API.PaginatedOperationMethod; export type ListInvestigatesError = CloudflareOpError; /** Returns information for each email that matches the search parameter(s). */ export declare const listInvestigates: API.PaginatedOperationMethod; export type ListPhishguardReportsError = CloudflareOpError; /** Retrieves PhishGuard security alert reports for a specified date range. Reports include detected threats, dispositions, and contextual information. Use for security monitoring and threat analysis. */ export declare const listPhishguardReports: API.PaginatedOperationMethod; export type ListSettingAllowPoliciesError = EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Returns a paginated list of email allow policies. These policies exempt matching emails from security detection, allowing them to bypass disposition actions. Supports filtering by pattern type and policy attributes. */ export declare const listSettingAllowPolicies: API.PaginatedOperationMethod; export type ListSettingBlockSendersError = EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Returns a paginated list of blocked email sender patterns. These patterns prevent emails from matching senders from being delivered. Supports filtering by pattern type and searching across patterns. */ export declare const listSettingBlockSenders: API.PaginatedOperationMethod; export type ListSettingDomainsError = EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Returns a paginated list of email domains protected by Email Security. Includes domain configuration, delivery modes, and authorization status. Supports filtering by delivery mode and integration ID. */ export declare const listSettingDomains: API.PaginatedOperationMethod; export type ListSettingImpersonationRegistriesError = EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Returns a paginated list of protected identities in the impersonation registry. These entries define identities and email addresses to protect from impersonation attacks. Can be manually added or automatically synced from directory integrations. */ export declare const listSettingImpersonationRegistries: API.PaginatedOperationMethod; export type ListSettingSendingDomainRestrictionsError = CloudflareOpError; /** Returns a paginated list of sending domain restrictions. These restrictions enforce TLS requirements for emails from specific domains. Mail without TLS from restricted domains will be dropped unless the subdomain is in the exclude list. Supports sorting and searching. */ export declare const listSettingSendingDomainRestrictions: API.PaginatedOperationMethod; export type ListSettingTrustedDomainsError = EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Returns a paginated list of trusted domain patterns. Trusted domains prevent false positives for recently registered domains and lookalike domain detections. Patterns can use regular expressions for flexible matching. */ export declare const listSettingTrustedDomains: API.PaginatedOperationMethod; export type ListSettingUrlIgnorePatternsError = CloudflareOpError; /** Returns a paginated list of URL rewrite ignore patterns for the account. URLs matching these patterns will not be rewritten. */ export declare const listSettingUrlIgnorePatterns: API.PaginatedOperationMethod; export type ListSubmissionsError = CloudflareOpError; /** Returns information for submissions made to reclassify emails. Shows the status, outcome, and disposition changes for reclassification requests made by users or the security team. Useful for tracking false positive/negative reports. */ export declare const listSubmissions: API.PaginatedOperationMethod; export type PatchSettingAllowPolicyError = AllowPolicyNotFound | EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Updates an existing allow policy. Only provided fields will be modified. Changes take effect for new emails matching the pattern. */ export declare const patchSettingAllowPolicy: API.OperationMethod; export type PatchSettingBlockSenderError = BlockSenderNotFound | EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Updates an existing blocked sender pattern. Only provided fields will be modified. The pattern will continue blocking emails until deleted. */ export declare const patchSettingBlockSender: API.OperationMethod; export type PatchSettingDomainError = EmailSecurityDomainNotFound | EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Updates configuration for a protected email domain. Only provided fields will be modified. Changes affect delivery mode, security settings, and regional processing. */ export declare const patchSettingDomain: API.OperationMethod; export type PatchSettingImpersonationRegistryError = ImpersonationRegistryEntryNotFound | EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Updates an existing impersonation registry entry. Only provided fields will be modified. Directory-synced entries can't be updated. */ export declare const patchSettingImpersonationRegistry: API.OperationMethod; export type PatchSettingSendingDomainRestrictionError = CloudflareOpError; /** Updates an existing sending domain restriction. Only provided fields will be modified. Changes affect which domains require TLS and which subdomains are excluded. */ export declare const patchSettingSendingDomainRestriction: API.OperationMethod; export type PatchSettingTrustedDomainError = TrustedDomainNotFound | EmailSecurityNotEntitled | Forbidden | CloudflareOpError; /** Updates an existing trusted domain pattern. Only provided fields will be modified. Changes take effect for new emails matching the pattern. */ export declare const patchSettingTrustedDomain: API.OperationMethod; export type PatchSettingUrlIgnorePatternError = CloudflareOpError; /** Updates an existing URL rewrite ignore pattern. Only provided fields will be modified. */ export declare const patchSettingUrlIgnorePattern: API.OperationMethod; //# sourceMappingURL=email_security.d.ts.map