email_security

type ASN = shared.ASN

type ASNParam = shared.ASNParam

type AuditLog = shared.AuditLog

type AuditLogAction = shared.AuditLogAction

type AuditLogActor = shared.AuditLogActor

type AuditLogActorType = shared.AuditLogActorType

type AuditLogOwner = shared.AuditLogOwner

type AuditLogResource = shared.AuditLogResource

type CertificateCA = shared.CertificateCA

type CertificateRequestType = shared.CertificateRequestType

type CloudflareTunnel = shared.CloudflareTunnel

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

type EmailSecurityService struct {
	Options     []option.RequestOption
	Investigate *InvestigateService
	Phishguard  *PhishguardService
	Settings    *SettingService
	Submissions *SubmissionService
}

type Error = apierror.Error

type ErrorData = shared.ErrorData

type ErrorDataSource = shared.ErrorDataSource

type InvestigateDetectionGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type InvestigateDetectionGetResponse struct {
	Action           string                                          `json:"action" api:"required"`
	Attachments      []InvestigateDetectionGetResponseAttachment     `json:"attachments" api:"required"`
	Findings         []InvestigateDetectionGetResponseFinding        `json:"findings" api:"required,nullable"`
	Headers          []InvestigateDetectionGetResponseHeader         `json:"headers" api:"required"`
	Links            []InvestigateDetectionGetResponseLink           `json:"links" api:"required"`
	SenderInfo       InvestigateDetectionGetResponseSenderInfo       `json:"sender_info" api:"required"`
	ThreatCategories []InvestigateDetectionGetResponseThreatCategory `json:"threat_categories" api:"required"`
	Validation       InvestigateDetectionGetResponseValidation       `json:"validation" api:"required"`
	FinalDisposition InvestigateDetectionGetResponseFinalDisposition `json:"final_disposition"`
	JSON             investigateDetectionGetResponseJSON             `json:"-"`
}

type InvestigateDetectionGetResponseAttachment struct {
	// Size of the attachment in bytes
	Size int64 `json:"size" api:"required"`
	// MIME type of the attachment
	ContentType string `json:"content_type" api:"nullable"`
	// Detection result for this attachment
	Detection InvestigateDetectionGetResponseAttachmentsDetection `json:"detection" api:"nullable"`
	// Whether the attachment is encrypted
	Encrypted bool `json:"encrypted" api:"nullable"`
	// Name of the attached file
	Filename string `json:"filename" api:"nullable"`
	// MD5 hash of the attachment
	Md5 string `json:"md5" api:"nullable"`
	// Attachment name (alternative to filename)
	Name string `json:"name" api:"nullable"`
	// SHA1 hash of the attachment
	Sha1 string `json:"sha1" api:"nullable"`
	// SHA256 hash of the attachment
	Sha256 string                                        `json:"sha256" api:"nullable"`
	JSON   investigateDetectionGetResponseAttachmentJSON `json:"-"`
}

type InvestigateDetectionGetResponseAttachmentsDetection string

type InvestigateDetectionGetResponseEnvelope struct {
	Errors   []InvestigateDetectionGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []InvestigateDetectionGetResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   InvestigateDetectionGetResponse                   `json:"result" api:"required"`
	// Whether the API call was successful.
	Success InvestigateDetectionGetResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    investigateDetectionGetResponseEnvelopeJSON    `json:"-"`
}

type InvestigateDetectionGetResponseEnvelopeErrors struct {
	Code             int64                                               `json:"code" api:"required"`
	Message          string                                              `json:"message" api:"required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           InvestigateDetectionGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             investigateDetectionGetResponseEnvelopeErrorsJSON   `json:"-"`
}

type InvestigateDetectionGetResponseEnvelopeErrorsSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    investigateDetectionGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

type InvestigateDetectionGetResponseEnvelopeMessages struct {
	Code             int64                                                 `json:"code" api:"required"`
	Message          string                                                `json:"message" api:"required"`
	DocumentationURL string                                                `json:"documentation_url"`
	Source           InvestigateDetectionGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             investigateDetectionGetResponseEnvelopeMessagesJSON   `json:"-"`
}

type InvestigateDetectionGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                    `json:"pointer"`
	JSON    investigateDetectionGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

type InvestigateDetectionGetResponseEnvelopeSuccess bool

type InvestigateDetectionGetResponseFinalDisposition string

type InvestigateDetectionGetResponseFinding struct {
	Attachment string                                           `json:"attachment" api:"nullable"`
	Detail     string                                           `json:"detail" api:"nullable"`
	Detection  InvestigateDetectionGetResponseFindingsDetection `json:"detection"`
	Field      string                                           `json:"field" api:"nullable"`
	Name       string                                           `json:"name" api:"nullable"`
	Portion    string                                           `json:"portion" api:"nullable"`
	Reason     string                                           `json:"reason" api:"nullable"`
	Score      float64                                          `json:"score" api:"nullable"`
	Value      string                                           `json:"value" api:"nullable"`
	JSON       investigateDetectionGetResponseFindingJSON       `json:"-"`
}

type InvestigateDetectionGetResponseFindingsDetection string

type InvestigateDetectionGetResponseHeader struct {
	Name  string                                    `json:"name" api:"required"`
	Value string                                    `json:"value" api:"required"`
	JSON  investigateDetectionGetResponseHeaderJSON `json:"-"`
}

type InvestigateDetectionGetResponseLink struct {
	Href string                                  `json:"href" api:"required"`
	Text string                                  `json:"text" api:"nullable"`
	JSON investigateDetectionGetResponseLinkJSON `json:"-"`
}

type InvestigateDetectionGetResponseSenderInfo struct {
	// The name of the autonomous system.
	AsName string `json:"as_name" api:"nullable"`
	// The number of the autonomous system.
	AsNumber int64                                         `json:"as_number" api:"nullable"`
	Geo      string                                        `json:"geo" api:"nullable"`
	IP       string                                        `json:"ip" api:"nullable"`
	Pld      string                                        `json:"pld" api:"nullable"`
	JSON     investigateDetectionGetResponseSenderInfoJSON `json:"-"`
}

type InvestigateDetectionGetResponseThreatCategory struct {
	ID          int64                                             `json:"id"`
	Description string                                            `json:"description" api:"nullable"`
	Name        string                                            `json:"name" api:"nullable"`
	JSON        investigateDetectionGetResponseThreatCategoryJSON `json:"-"`
}

type InvestigateDetectionGetResponseValidation struct {
	Comment string                                         `json:"comment" api:"nullable"`
	DKIM    InvestigateDetectionGetResponseValidationDKIM  `json:"dkim"`
	DMARC   InvestigateDetectionGetResponseValidationDMARC `json:"dmarc"`
	SPF     InvestigateDetectionGetResponseValidationSPF   `json:"spf"`
	JSON    investigateDetectionGetResponseValidationJSON  `json:"-"`
}

type InvestigateDetectionGetResponseValidationDKIM string

type InvestigateDetectionGetResponseValidationDMARC string

type InvestigateDetectionGetResponseValidationSPF string

type InvestigateDetectionService struct {
	Options []option.RequestOption
}

type InvestigateGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// When true, search the submissions datastore only. When false or omitted, search
	// the regular datastore only.
	Submission param.Field[bool] `query:"submission"`
}

type InvestigateGetResponse struct {
	// Unique identifier for a message retrieved from investigation
	ID string `json:"id" api:"required"`
	// Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of
	// life: November 1, 2026.
	//
	// Deprecated: deprecated
	ActionLog         []InvestigateGetResponseActionLog `json:"action_log" api:"required"`
	ClientRecipients  []string                          `json:"client_recipients" api:"required"`
	DetectionReasons  []string                          `json:"detection_reasons" api:"required"`
	IsPhishSubmission bool                              `json:"is_phish_submission" api:"required"`
	IsQuarantined     bool                              `json:"is_quarantined" api:"required"`
	// The identifier of the message
	PostfixID string `json:"postfix_id" api:"required"`
	// Message processing properties
	Properties InvestigateGetResponseProperties `json:"properties" api:"required"`
	// Deprecated, use `scanned_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: deprecated
	Ts               string                                 `json:"ts" api:"required"`
	AlertID          string                                 `json:"alert_id" api:"nullable"`
	DeliveryMode     InvestigateGetResponseDeliveryMode     `json:"delivery_mode"`
	DeliveryStatus   []InvestigateGetResponseDeliveryStatus `json:"delivery_status" api:"nullable"`
	EdfHash          string                                 `json:"edf_hash" api:"nullable"`
	EnvelopeFrom     string                                 `json:"envelope_from" api:"nullable"`
	EnvelopeTo       []string                               `json:"envelope_to" api:"nullable"`
	FinalDisposition InvestigateGetResponseFinalDisposition `json:"final_disposition"`
	// Deprecated, use the `findings` field from
	// `GET /investigate/{investigate_id}/detections` instead. End of life: November
	// 1, 2026. Detection findings for this message.
	//
	// Deprecated: deprecated
	Findings              []InvestigateGetResponseFinding `json:"findings" api:"nullable"`
	From                  string                          `json:"from" api:"nullable"`
	FromName              string                          `json:"from_name" api:"nullable"`
	HtmltextStructureHash string                          `json:"htmltext_structure_hash" api:"nullable"`
	MessageID             string                          `json:"message_id" api:"nullable"`
	// Post-delivery operations performed on this message
	PostDeliveryOperations []InvestigateGetResponsePostDeliveryOperation `json:"post_delivery_operations" api:"nullable"`
	PostfixIDOutbound      string                                        `json:"postfix_id_outbound" api:"nullable"`
	Replyto                string                                        `json:"replyto" api:"nullable"`
	// When the message was scanned (UTC)
	ScannedAt time.Time `json:"scanned_at" api:"nullable" format:"date-time"`
	// When the message was sent (UTC)
	SentAt            time.Time                        `json:"sent_at" api:"nullable" format:"date-time"`
	SentDate          string                           `json:"sent_date" api:"nullable"`
	SmtpHeloServerIP  string                           `json:"smtp_helo_server_ip" api:"nullable"`
	SmtpPreviousHopIP string                           `json:"smtp_previous_hop_ip" api:"nullable"`
	Subject           string                           `json:"subject" api:"nullable"`
	ThreatCategories  []string                         `json:"threat_categories" api:"nullable"`
	To                []string                         `json:"to" api:"nullable"`
	ToName            []string                         `json:"to_name" api:"nullable"`
	Validation        InvestigateGetResponseValidation `json:"validation"`
	XOriginatingIP    string                           `json:"x_originating_ip" api:"nullable"`
	JSON              investigateGetResponseJSON       `json:"-"`
}

type InvestigateGetResponseActionLog struct {
	// Timestamp when action completed
	CompletedAt time.Time `json:"completed_at" api:"required" format:"date-time"`
	// Type of action performed
	Operation InvestigateGetResponseActionLogOperation `json:"operation" api:"required"`
	// Deprecated, use `completed_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: deprecated
	CompletedTimestamp string `json:"completed_timestamp"`
	// Additional properties for the action
	Properties InvestigateGetResponseActionLogProperties `json:"properties"`
	// Status of the action
	Status string                              `json:"status" api:"nullable"`
	JSON   investigateGetResponseActionLogJSON `json:"-"`
}

type InvestigateGetResponseActionLogOperation string

type InvestigateGetResponseActionLogProperties struct {
	// Target folder for move operations
	Folder string `json:"folder"`
	// User who requested the action
	RequestedBy string                                        `json:"requested_by"`
	JSON        investigateGetResponseActionLogPropertiesJSON `json:"-"`
}

type InvestigateGetResponseDeliveryMode string

type InvestigateGetResponseDeliveryStatus string

type InvestigateGetResponseEnvelope struct {
	Errors   []InvestigateGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []InvestigateGetResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   InvestigateGetResponse                   `json:"result" api:"required"`
	// Whether the API call was successful.
	Success InvestigateGetResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    investigateGetResponseEnvelopeJSON    `json:"-"`
}

type InvestigateGetResponseEnvelopeErrors struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           InvestigateGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             investigateGetResponseEnvelopeErrorsJSON   `json:"-"`
}

type InvestigateGetResponseEnvelopeErrorsSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    investigateGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

type InvestigateGetResponseEnvelopeMessages struct {
	Code             int64                                        `json:"code" api:"required"`
	Message          string                                       `json:"message" api:"required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           InvestigateGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             investigateGetResponseEnvelopeMessagesJSON   `json:"-"`
}

type InvestigateGetResponseEnvelopeMessagesSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    investigateGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

type InvestigateGetResponseEnvelopeSuccess bool

type InvestigateGetResponseFinalDisposition string

type InvestigateGetResponseFinding struct {
	Attachment string                                  `json:"attachment" api:"nullable"`
	Detail     string                                  `json:"detail" api:"nullable"`
	Detection  InvestigateGetResponseFindingsDetection `json:"detection"`
	Field      string                                  `json:"field" api:"nullable"`
	Name       string                                  `json:"name" api:"nullable"`
	Portion    string                                  `json:"portion" api:"nullable"`
	Reason     string                                  `json:"reason" api:"nullable"`
	Score      float64                                 `json:"score" api:"nullable"`
	Value      string                                  `json:"value" api:"nullable"`
	JSON       investigateGetResponseFindingJSON       `json:"-"`
}

type InvestigateGetResponseFindingsDetection string

type InvestigateGetResponsePostDeliveryOperation string

type InvestigateGetResponseProperties struct {
	// Pattern that allowlisted this message
	AllowlistedPattern string `json:"allowlisted_pattern" api:"nullable"`
	// Type of allowlist pattern
	AllowlistedPatternType InvestigateGetResponsePropertiesAllowlistedPatternType `json:"allowlisted_pattern_type" api:"nullable"`
	// Whether message was blocklisted
	BlocklistedMessage bool `json:"blocklisted_message" api:"nullable"`
	// Pattern that blocklisted this message
	BlocklistedPattern string `json:"blocklisted_pattern" api:"nullable"`
	// Legacy field for allowlist pattern type
	WhitelistedPatternType InvestigateGetResponsePropertiesWhitelistedPatternType `json:"whitelisted_pattern_type" api:"nullable"`
	JSON                   investigateGetResponsePropertiesJSON                   `json:"-"`
}

type InvestigateGetResponsePropertiesAllowlistedPatternType string

type InvestigateGetResponsePropertiesWhitelistedPatternType string

type InvestigateGetResponseValidation struct {
	Comment string                                `json:"comment" api:"nullable"`
	DKIM    InvestigateGetResponseValidationDKIM  `json:"dkim"`
	DMARC   InvestigateGetResponseValidationDMARC `json:"dmarc"`
	SPF     InvestigateGetResponseValidationSPF   `json:"spf"`
	JSON    investigateGetResponseValidationJSON  `json:"-"`
}

type InvestigateGetResponseValidationDKIM string

type InvestigateGetResponseValidationDMARC string

type InvestigateGetResponseValidationSPF string

type InvestigateListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Whether to include the message action log in the response.
	ActionLog param.Field[bool]   `query:"action_log"`
	AlertID   param.Field[string] `query:"alert_id"`
	Cursor    param.Field[string] `query:"cursor"`
	// Delivery status to filter by.
	DeliveryStatus param.Field[InvestigateListParamsDeliveryStatus] `query:"delivery_status"`
	// Whether to include only detections in search results.
	DetectionsOnly param.Field[bool] `query:"detections_only"`
	// Sender domains to filter by.
	Domain param.Field[string] `query:"domain"`
	// The end of the search date range. Defaults to `now`.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// Dispositions to filter by.
	FinalDisposition param.Field[InvestigateListParamsFinalDisposition] `query:"final_disposition"`
	// Message actions to filter by.
	MessageAction param.Field[InvestigateListParamsMessageAction] `query:"message_action"`
	MessageID     param.Field[string]                             `query:"message_id"`
	Metric        param.Field[string]                             `query:"metric"`
	// Deprecated: Use cursor pagination instead. End of life: November 1, 2026.
	Page param.Field[int64] `query:"page"`
	// The number of results per page. Maximum value is 1000.
	PerPage param.Field[int64] `query:"per_page"`
	// Space-delimited search term. Case-insensitive.
	Query     param.Field[string] `query:"query"`
	Recipient param.Field[string] `query:"recipient"`
	Sender    param.Field[string] `query:"sender"`
	// The beginning of the search date range. Defaults to `now - 30 days`.
	Start   param.Field[time.Time] `query:"start" format:"date-time"`
	Subject param.Field[string]    `query:"subject"`
}

type InvestigateListParamsDeliveryStatus string

type InvestigateListParamsFinalDisposition string

type InvestigateListParamsMessageAction string

type InvestigateListResponse struct {
	// Unique identifier for a message retrieved from investigation
	ID string `json:"id" api:"required"`
	// Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of
	// life: November 1, 2026.
	//
	// Deprecated: deprecated
	ActionLog         []InvestigateListResponseActionLog `json:"action_log" api:"required"`
	ClientRecipients  []string                           `json:"client_recipients" api:"required"`
	DetectionReasons  []string                           `json:"detection_reasons" api:"required"`
	IsPhishSubmission bool                               `json:"is_phish_submission" api:"required"`
	IsQuarantined     bool                               `json:"is_quarantined" api:"required"`
	// The identifier of the message
	PostfixID string `json:"postfix_id" api:"required"`
	// Message processing properties
	Properties InvestigateListResponseProperties `json:"properties" api:"required"`
	// Deprecated, use `scanned_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: deprecated
	Ts               string                                  `json:"ts" api:"required"`
	AlertID          string                                  `json:"alert_id" api:"nullable"`
	DeliveryMode     InvestigateListResponseDeliveryMode     `json:"delivery_mode"`
	DeliveryStatus   []InvestigateListResponseDeliveryStatus `json:"delivery_status" api:"nullable"`
	EdfHash          string                                  `json:"edf_hash" api:"nullable"`
	EnvelopeFrom     string                                  `json:"envelope_from" api:"nullable"`
	EnvelopeTo       []string                                `json:"envelope_to" api:"nullable"`
	FinalDisposition InvestigateListResponseFinalDisposition `json:"final_disposition"`
	// Deprecated, use the `findings` field from
	// `GET /investigate/{investigate_id}/detections` instead. End of life: November
	// 1, 2026. Detection findings for this message.
	//
	// Deprecated: deprecated
	Findings              []InvestigateListResponseFinding `json:"findings" api:"nullable"`
	From                  string                           `json:"from" api:"nullable"`
	FromName              string                           `json:"from_name" api:"nullable"`
	HtmltextStructureHash string                           `json:"htmltext_structure_hash" api:"nullable"`
	MessageID             string                           `json:"message_id" api:"nullable"`
	// Post-delivery operations performed on this message
	PostDeliveryOperations []InvestigateListResponsePostDeliveryOperation `json:"post_delivery_operations" api:"nullable"`
	PostfixIDOutbound      string                                         `json:"postfix_id_outbound" api:"nullable"`
	Replyto                string                                         `json:"replyto" api:"nullable"`
	// When the message was scanned (UTC)
	ScannedAt time.Time `json:"scanned_at" api:"nullable" format:"date-time"`
	// When the message was sent (UTC)
	SentAt            time.Time                         `json:"sent_at" api:"nullable" format:"date-time"`
	SentDate          string                            `json:"sent_date" api:"nullable"`
	SmtpHeloServerIP  string                            `json:"smtp_helo_server_ip" api:"nullable"`
	SmtpPreviousHopIP string                            `json:"smtp_previous_hop_ip" api:"nullable"`
	Subject           string                            `json:"subject" api:"nullable"`
	ThreatCategories  []string                          `json:"threat_categories" api:"nullable"`
	To                []string                          `json:"to" api:"nullable"`
	ToName            []string                          `json:"to_name" api:"nullable"`
	Validation        InvestigateListResponseValidation `json:"validation"`
	XOriginatingIP    string                            `json:"x_originating_ip" api:"nullable"`
	JSON              investigateListResponseJSON       `json:"-"`
}

type InvestigateListResponseActionLog struct {
	// Timestamp when action completed
	CompletedAt time.Time `json:"completed_at" api:"required" format:"date-time"`
	// Type of action performed
	Operation InvestigateListResponseActionLogOperation `json:"operation" api:"required"`
	// Deprecated, use `completed_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: deprecated
	CompletedTimestamp string `json:"completed_timestamp"`
	// Additional properties for the action
	Properties InvestigateListResponseActionLogProperties `json:"properties"`
	// Status of the action
	Status string                               `json:"status" api:"nullable"`
	JSON   investigateListResponseActionLogJSON `json:"-"`
}

type InvestigateListResponseActionLogOperation string

type InvestigateListResponseActionLogProperties struct {
	// Target folder for move operations
	Folder string `json:"folder"`
	// User who requested the action
	RequestedBy string                                         `json:"requested_by"`
	JSON        investigateListResponseActionLogPropertiesJSON `json:"-"`
}

type InvestigateListResponseDeliveryMode string

type InvestigateListResponseDeliveryStatus string

type InvestigateListResponseFinalDisposition string

type InvestigateListResponseFinding struct {
	Attachment string                                   `json:"attachment" api:"nullable"`
	Detail     string                                   `json:"detail" api:"nullable"`
	Detection  InvestigateListResponseFindingsDetection `json:"detection"`
	Field      string                                   `json:"field" api:"nullable"`
	Name       string                                   `json:"name" api:"nullable"`
	Portion    string                                   `json:"portion" api:"nullable"`
	Reason     string                                   `json:"reason" api:"nullable"`
	Score      float64                                  `json:"score" api:"nullable"`
	Value      string                                   `json:"value" api:"nullable"`
	JSON       investigateListResponseFindingJSON       `json:"-"`
}

type InvestigateListResponseFindingsDetection string

type InvestigateListResponsePostDeliveryOperation string

type InvestigateListResponseProperties struct {
	// Pattern that allowlisted this message
	AllowlistedPattern string `json:"allowlisted_pattern" api:"nullable"`
	// Type of allowlist pattern
	AllowlistedPatternType InvestigateListResponsePropertiesAllowlistedPatternType `json:"allowlisted_pattern_type" api:"nullable"`
	// Whether message was blocklisted
	BlocklistedMessage bool `json:"blocklisted_message" api:"nullable"`
	// Pattern that blocklisted this message
	BlocklistedPattern string `json:"blocklisted_pattern" api:"nullable"`
	// Legacy field for allowlist pattern type
	WhitelistedPatternType InvestigateListResponsePropertiesWhitelistedPatternType `json:"whitelisted_pattern_type" api:"nullable"`
	JSON                   investigateListResponsePropertiesJSON                   `json:"-"`
}

type InvestigateListResponsePropertiesAllowlistedPatternType string

type InvestigateListResponsePropertiesWhitelistedPatternType string

type InvestigateListResponseValidation struct {
	Comment string                                 `json:"comment" api:"nullable"`
	DKIM    InvestigateListResponseValidationDKIM  `json:"dkim"`
	DMARC   InvestigateListResponseValidationDMARC `json:"dmarc"`
	SPF     InvestigateListResponseValidationSPF   `json:"spf"`
	JSON    investigateListResponseValidationJSON  `json:"-"`
}

type InvestigateListResponseValidationDKIM string

type InvestigateListResponseValidationDMARC string

type InvestigateListResponseValidationSPF string

type InvestigateMoveBulkParams struct {
	// Identifier.
	AccountID   param.Field[string]                               `path:"account_id" api:"required"`
	Destination param.Field[InvestigateMoveBulkParamsDestination] `json:"destination" api:"required"`
	// List of message IDs to move
	IDs param.Field[[]string] `json:"ids"`
	// Deprecated, use `ids` instead. End of life: November 1, 2026. List of message
	// IDs to move.
	PostfixIDs param.Field[[]string] `json:"postfix_ids"`
}

type InvestigateMoveBulkParamsDestination string

type InvestigateMoveBulkResponse struct {
	// Whether the operation succeeded
	Success bool `json:"success" api:"required"`
	// When the move operation completed (UTC)
	CompletedAt time.Time `json:"completed_at" api:"nullable" format:"date-time"`
	// Deprecated, use `completed_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: deprecated
	CompletedTimestamp time.Time `json:"completed_timestamp" format:"date-time"`
	// Destination folder for the message
	Destination string `json:"destination" api:"nullable"`
	// Number of items moved. End of life: November 1, 2026.
	//
	// Deprecated: deprecated
	ItemCount int64 `json:"item_count"`
	// Message identifier
	MessageID string `json:"message_id" api:"nullable"`
	// Type of operation performed
	Operation string `json:"operation" api:"nullable"`
	// Recipient email address
	Recipient string `json:"recipient" api:"nullable"`
	// Operation status
	Status string                          `json:"status" api:"nullable"`
	JSON   investigateMoveBulkResponseJSON `json:"-"`
}

type InvestigateMoveNewParams struct {
	// Identifier.
	AccountID   param.Field[string]                              `path:"account_id" api:"required"`
	Destination param.Field[InvestigateMoveNewParamsDestination] `json:"destination" api:"required"`
}

type InvestigateMoveNewParamsDestination string

type InvestigateMoveNewResponse struct {
	// Whether the operation succeeded
	Success bool `json:"success" api:"required"`
	// When the move operation completed (UTC)
	CompletedAt time.Time `json:"completed_at" api:"nullable" format:"date-time"`
	// Deprecated, use `completed_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: deprecated
	CompletedTimestamp time.Time `json:"completed_timestamp" format:"date-time"`
	// Destination folder for the message
	Destination string `json:"destination" api:"nullable"`
	// Number of items moved. End of life: November 1, 2026.
	//
	// Deprecated: deprecated
	ItemCount int64 `json:"item_count"`
	// Message identifier
	MessageID string `json:"message_id" api:"nullable"`
	// Type of operation performed
	Operation string `json:"operation" api:"nullable"`
	// Recipient email address
	Recipient string `json:"recipient" api:"nullable"`
	// Operation status
	Status string                         `json:"status" api:"nullable"`
	JSON   investigateMoveNewResponseJSON `json:"-"`
}

type InvestigateMoveService struct {
	Options []option.RequestOption
}

type InvestigatePreviewGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type InvestigatePreviewGetResponse struct {
	// A base64 encoded PNG image of the email.
	Screenshot string                            `json:"screenshot" api:"required"`
	JSON       investigatePreviewGetResponseJSON `json:"-"`
}

type InvestigatePreviewGetResponseEnvelope struct {
	Errors   []InvestigatePreviewGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []InvestigatePreviewGetResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   InvestigatePreviewGetResponse                   `json:"result" api:"required"`
	// Whether the API call was successful.
	Success InvestigatePreviewGetResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    investigatePreviewGetResponseEnvelopeJSON    `json:"-"`
}

type InvestigatePreviewGetResponseEnvelopeErrors struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           InvestigatePreviewGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             investigatePreviewGetResponseEnvelopeErrorsJSON   `json:"-"`
}

type InvestigatePreviewGetResponseEnvelopeErrorsSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    investigatePreviewGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

type InvestigatePreviewGetResponseEnvelopeMessages struct {
	Code             int64                                               `json:"code" api:"required"`
	Message          string                                              `json:"message" api:"required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           InvestigatePreviewGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             investigatePreviewGetResponseEnvelopeMessagesJSON   `json:"-"`
}

type InvestigatePreviewGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    investigatePreviewGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

type InvestigatePreviewGetResponseEnvelopeSuccess bool

type InvestigatePreviewNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The identifier of the message
	PostfixID param.Field[string] `json:"postfix_id" api:"required"`
}

type InvestigatePreviewNewResponse struct {
	// A base64 encoded PNG image of the email.
	Screenshot string                            `json:"screenshot" api:"required"`
	JSON       investigatePreviewNewResponseJSON `json:"-"`
}

type InvestigatePreviewNewResponseEnvelope struct {
	Errors   []InvestigatePreviewNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []InvestigatePreviewNewResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   InvestigatePreviewNewResponse                   `json:"result" api:"required"`
	// Whether the API call was successful.
	Success InvestigatePreviewNewResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    investigatePreviewNewResponseEnvelopeJSON    `json:"-"`
}

type InvestigatePreviewNewResponseEnvelopeErrors struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           InvestigatePreviewNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             investigatePreviewNewResponseEnvelopeErrorsJSON   `json:"-"`
}

type InvestigatePreviewNewResponseEnvelopeErrorsSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    investigatePreviewNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

type InvestigatePreviewNewResponseEnvelopeMessages struct {
	Code             int64                                               `json:"code" api:"required"`
	Message          string                                              `json:"message" api:"required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           InvestigatePreviewNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             investigatePreviewNewResponseEnvelopeMessagesJSON   `json:"-"`
}

type InvestigatePreviewNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    investigatePreviewNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

type InvestigatePreviewNewResponseEnvelopeSuccess bool

type InvestigatePreviewService struct {
	Options []option.RequestOption
}

type InvestigateRawGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type InvestigateRawGetResponse struct {
	// A UTF-8 encoded eml file of the email.
	Raw  string                        `json:"raw" api:"required"`
	JSON investigateRawGetResponseJSON `json:"-"`
}

type InvestigateRawGetResponseEnvelope struct {
	Errors   []InvestigateRawGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []InvestigateRawGetResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   InvestigateRawGetResponse                   `json:"result" api:"required"`
	// Whether the API call was successful.
	Success InvestigateRawGetResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    investigateRawGetResponseEnvelopeJSON    `json:"-"`
}

type InvestigateRawGetResponseEnvelopeErrors struct {
	Code             int64                                         `json:"code" api:"required"`
	Message          string                                        `json:"message" api:"required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           InvestigateRawGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             investigateRawGetResponseEnvelopeErrorsJSON   `json:"-"`
}

type InvestigateRawGetResponseEnvelopeErrorsSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    investigateRawGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

type InvestigateRawGetResponseEnvelopeMessages struct {
	Code             int64                                           `json:"code" api:"required"`
	Message          string                                          `json:"message" api:"required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           InvestigateRawGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             investigateRawGetResponseEnvelopeMessagesJSON   `json:"-"`
}

type InvestigateRawGetResponseEnvelopeMessagesSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    investigateRawGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

type InvestigateRawGetResponseEnvelopeSuccess bool

type InvestigateRawService struct {
	Options []option.RequestOption
}

type InvestigateReclassifyNewParams struct {
	// Identifier.
	AccountID           param.Field[string]                                            `path:"account_id" api:"required"`
	ExpectedDisposition param.Field[InvestigateReclassifyNewParamsExpectedDisposition] `json:"expected_disposition" api:"required"`
	// Base64 encoded content of the EML file.
	EmlContent            param.Field[string] `json:"eml_content"`
	EscalatedSubmissionID param.Field[string] `json:"escalated_submission_id"`
}

type InvestigateReclassifyNewParamsExpectedDisposition string

type InvestigateReclassifyNewResponse = interface{}

type InvestigateReclassifyNewResponseEnvelope struct {
	Errors   []InvestigateReclassifyNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []InvestigateReclassifyNewResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   InvestigateReclassifyNewResponse                   `json:"result" api:"required"`
	// Whether the API call was successful.
	Success InvestigateReclassifyNewResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    investigateReclassifyNewResponseEnvelopeJSON    `json:"-"`
}

type InvestigateReclassifyNewResponseEnvelopeErrors struct {
	Code             int64                                                `json:"code" api:"required"`
	Message          string                                               `json:"message" api:"required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           InvestigateReclassifyNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             investigateReclassifyNewResponseEnvelopeErrorsJSON   `json:"-"`
}

type InvestigateReclassifyNewResponseEnvelopeErrorsSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    investigateReclassifyNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

type InvestigateReclassifyNewResponseEnvelopeMessages struct {
	Code             int64                                                  `json:"code" api:"required"`
	Message          string                                                 `json:"message" api:"required"`
	DocumentationURL string                                                 `json:"documentation_url"`
	Source           InvestigateReclassifyNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             investigateReclassifyNewResponseEnvelopeMessagesJSON   `json:"-"`
}

type InvestigateReclassifyNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                     `json:"pointer"`
	JSON    investigateReclassifyNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

type InvestigateReclassifyNewResponseEnvelopeSuccess bool

type InvestigateReclassifyService struct {
	Options []option.RequestOption
}

type InvestigateReleaseBulkParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Body      []string            `json:"body" api:"required"`
}

type InvestigateReleaseBulkResponse struct {
	// Unique identifier for a message retrieved from investigation
	ID        string   `json:"id" api:"required"`
	Delivered []string `json:"delivered" api:"nullable"`
	Failed    []string `json:"failed" api:"nullable"`
	// Deprecated, use `id` instead. End of life: November 1, 2026.
	//
	// Deprecated: deprecated
	PostfixID   string                             `json:"postfix_id"`
	Undelivered []string                           `json:"undelivered" api:"nullable"`
	JSON        investigateReleaseBulkResponseJSON `json:"-"`
}

type InvestigateReleaseService struct {
	Options []option.RequestOption
}

type InvestigateService struct {
	Options    []option.RequestOption
	Detections *InvestigateDetectionService
	Preview    *InvestigatePreviewService
	Raw        *InvestigateRawService
	Trace      *InvestigateTraceService
	Move       *InvestigateMoveService
	Reclassify *InvestigateReclassifyService
	Release    *InvestigateReleaseService
}

type InvestigateTraceGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type InvestigateTraceGetResponse struct {
	Inbound  InvestigateTraceGetResponseInbound  `json:"inbound" api:"required"`
	Outbound InvestigateTraceGetResponseOutbound `json:"outbound" api:"required"`
	JSON     investigateTraceGetResponseJSON     `json:"-"`
}

type InvestigateTraceGetResponseEnvelope struct {
	Errors   []InvestigateTraceGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []InvestigateTraceGetResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   InvestigateTraceGetResponse                   `json:"result" api:"required"`
	// Whether the API call was successful.
	Success InvestigateTraceGetResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    investigateTraceGetResponseEnvelopeJSON    `json:"-"`
}

type InvestigateTraceGetResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code" api:"required"`
	Message          string                                          `json:"message" api:"required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           InvestigateTraceGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             investigateTraceGetResponseEnvelopeErrorsJSON   `json:"-"`
}

type InvestigateTraceGetResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    investigateTraceGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

type InvestigateTraceGetResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           InvestigateTraceGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             investigateTraceGetResponseEnvelopeMessagesJSON   `json:"-"`
}

type InvestigateTraceGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    investigateTraceGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

type InvestigateTraceGetResponseEnvelopeSuccess bool

type InvestigateTraceGetResponseInbound struct {
	Lines   []InvestigateTraceGetResponseInboundLine `json:"lines" api:"nullable"`
	Pending bool                                     `json:"pending" api:"nullable"`
	JSON    investigateTraceGetResponseInboundJSON   `json:"-"`
}

type InvestigateTraceGetResponseInboundLine struct {
	// Line number in the trace log
	Lineno   int64     `json:"lineno"`
	LoggedAt time.Time `json:"logged_at" api:"nullable" format:"date-time"`
	Message  string    `json:"message"`
	// Deprecated, use `logged_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: deprecated
	Ts   string                                     `json:"ts"`
	JSON investigateTraceGetResponseInboundLineJSON `json:"-"`
}

type InvestigateTraceGetResponseOutbound struct {
	Lines   []InvestigateTraceGetResponseOutboundLine `json:"lines" api:"nullable"`
	Pending bool                                      `json:"pending" api:"nullable"`
	JSON    investigateTraceGetResponseOutboundJSON   `json:"-"`
}

type InvestigateTraceGetResponseOutboundLine struct {
	// Line number in the trace log
	Lineno   int64     `json:"lineno"`
	LoggedAt time.Time `json:"logged_at" api:"nullable" format:"date-time"`
	Message  string    `json:"message"`
	// Deprecated, use `logged_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: deprecated
	Ts   string                                      `json:"ts"`
	JSON investigateTraceGetResponseOutboundLineJSON `json:"-"`
}

type InvestigateTraceService struct {
	Options []option.RequestOption
}

type Member = shared.Member

type MemberPoliciesAccess = shared.MemberPoliciesAccess

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

type MemberPolicy = shared.MemberPolicy

type MemberStatus = shared.MemberStatus

type MemberUser = shared.MemberUser

type Permission = shared.Permission

type PermissionGrant = shared.PermissionGrant

type PermissionGrantParam = shared.PermissionGrantParam

type PhishguardReportListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// End of the time range (RFC3339). Takes precedence over to_date.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// Deprecated, use `start` instead. Start date in YYYY-MM-DD format.
	FromDate param.Field[time.Time] `query:"from_date" format:"date"`
	// Start of the time range (RFC3339). Takes precedence over from_date.
	Start param.Field[time.Time] `query:"start" format:"date-time"`
	// Deprecated, use `end` instead. End date in YYYY-MM-DD format.
	ToDate param.Field[time.Time] `query:"to_date" format:"date"`
}

type PhishguardReportListResponse struct {
	ID          int64                                   `json:"id" api:"required"`
	Content     string                                  `json:"content" api:"required"`
	Disposition PhishguardReportListResponseDisposition `json:"disposition" api:"required"`
	Fields      PhishguardReportListResponseFields      `json:"fields" api:"required"`
	Priority    string                                  `json:"priority" api:"required"`
	Title       string                                  `json:"title" api:"required"`
	CreatedAt   time.Time                               `json:"created_at" api:"nullable" format:"date-time"`
	Tags        []PhishguardReportListResponseTag       `json:"tags" api:"nullable"`
	// Deprecated, use `created_at` instead
	//
	// Deprecated: deprecated
	Ts        time.Time                        `json:"ts" format:"date-time"`
	UpdatedAt time.Time                        `json:"updated_at" api:"nullable" format:"date-time"`
	JSON      phishguardReportListResponseJSON `json:"-"`
}

type PhishguardReportListResponseDisposition string

type PhishguardReportListResponseFields struct {
	To         []string  `json:"to" api:"required"`
	From       string    `json:"from" api:"nullable"`
	OccurredAt time.Time `json:"occurred_at" format:"date-time"`
	PostfixID  string    `json:"postfix_id" api:"nullable"`
	// Deprecated, use `occurred_at` instead
	//
	// Deprecated: deprecated
	Ts   time.Time                              `json:"ts" format:"date-time"`
	JSON phishguardReportListResponseFieldsJSON `json:"-"`
}

type PhishguardReportListResponseTag struct {
	Category string                              `json:"category" api:"required"`
	Value    string                              `json:"value" api:"required"`
	JSON     phishguardReportListResponseTagJSON `json:"-"`
}

type PhishguardReportService struct {
	Options []option.RequestOption
}