email_security

package
v7.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 9, 2026 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation ¶

Index ¶

Constants ¶

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source 
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source 
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source 
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source 
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source 
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source 
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source 
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source 
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source 
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source 
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source 
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source 
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source 
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source 
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source 
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ASN ¶ 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam ¶ 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog ¶ 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction ¶ 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor ¶ 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType ¶ 

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner ¶ 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource ¶ 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA ¶ 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate.

This is an alias to an internal type.

type CertificateRequestType ¶ 

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel ¶ 

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConfigSrc ¶ 

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

This is an alias to an internal type.

type CloudflareTunnelConnection ¶ 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus ¶ 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType ¶ 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type EmailSecurityService ¶ 

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

EmailSecurityService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEmailSecurityService method instead.

func NewEmailSecurityService ¶ 

func NewEmailSecurityService(opts ...option.RequestOption) (r *EmailSecurityService)

NewEmailSecurityService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type Error ¶ 

type Error = apierror.Error

type ErrorData ¶ 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource ¶ 

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type InvestigateBulkCancelNewParams ¶ added in v7.7.0 

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

type InvestigateBulkCancelNewResponse ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponse struct {
	ActionParams            InvestigateBulkCancelNewResponseActionParams `json:"action_params" api:"required"`
	ActionType              InvestigateBulkCancelNewResponseActionType   `json:"action_type" api:"required"`
	CreatedAt               time.Time                                    `json:"created_at" api:"required" format:"date-time"`
	JobID                   string                                       `json:"job_id" api:"required" format:"uuid"`
	MessagesFailed          int64                                        `json:"messages_failed" api:"required"`
	MessagesPending         int64                                        `json:"messages_pending" api:"required"`
	MessagesSuccessful      int64                                        `json:"messages_successful" api:"required"`
	SearchParams            InvestigateBulkCancelNewResponseSearchParams `json:"search_params" api:"required"`
	Status                  InvestigateBulkCancelNewResponseStatus       `json:"status" api:"required"`
	TotalMessagesDiscovered int64                                        `json:"total_messages_discovered" api:"required"`
	Comment                 string                                       `json:"comment" api:"nullable"`
	CompletedAt             time.Time                                    `json:"completed_at" api:"nullable" format:"date-time"`
	StartedAt               time.Time                                    `json:"started_at" api:"nullable" format:"date-time"`
	StatusMessage           string                                       `json:"status_message" api:"nullable"`
	JSON                    investigateBulkCancelNewResponseJSON         `json:"-"`
}

func (*InvestigateBulkCancelNewResponse) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkCancelNewResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkCancelNewResponseActionParams ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseActionParams struct {
	Type                InvestigateBulkCancelNewResponseActionParamsType                `json:"type" api:"required"`
	Destination         InvestigateBulkCancelNewResponseActionParamsDestination         `json:"destination"`
	ExpectedDisposition InvestigateBulkCancelNewResponseActionParamsExpectedDisposition `json:"expected_disposition"`
	JSON                investigateBulkCancelNewResponseActionParamsJSON                `json:"-"`
	// contains filtered or unexported fields
}

func (InvestigateBulkCancelNewResponseActionParams) AsUnion ¶ added in v7.7.0 

func (r InvestigateBulkCancelNewResponseActionParams) AsUnion() InvestigateBulkCancelNewResponseActionParamsUnion

AsUnion returns a InvestigateBulkCancelNewResponseActionParamsUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are InvestigateBulkCancelNewResponseActionParamsMove, InvestigateBulkCancelNewResponseActionParamsRelease.

func (*InvestigateBulkCancelNewResponseActionParams) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkCancelNewResponseActionParams) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkCancelNewResponseActionParamsDestination ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseActionParamsDestination string
const (
	InvestigateBulkCancelNewResponseActionParamsDestinationInbox                     InvestigateBulkCancelNewResponseActionParamsDestination = "Inbox"
	InvestigateBulkCancelNewResponseActionParamsDestinationJunkEmail                 InvestigateBulkCancelNewResponseActionParamsDestination = "JunkEmail"
	InvestigateBulkCancelNewResponseActionParamsDestinationDeletedItems              InvestigateBulkCancelNewResponseActionParamsDestination = "DeletedItems"
	InvestigateBulkCancelNewResponseActionParamsDestinationRecoverableItemsDeletions InvestigateBulkCancelNewResponseActionParamsDestination = "RecoverableItemsDeletions"
	InvestigateBulkCancelNewResponseActionParamsDestinationRecoverableItemsPurges    InvestigateBulkCancelNewResponseActionParamsDestination = "RecoverableItemsPurges"
)

func (InvestigateBulkCancelNewResponseActionParamsDestination) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkCancelNewResponseActionParamsDestination) IsKnown() bool

type InvestigateBulkCancelNewResponseActionParamsExpectedDisposition ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseActionParamsExpectedDisposition string
const (
	InvestigateBulkCancelNewResponseActionParamsExpectedDispositionMalicious    InvestigateBulkCancelNewResponseActionParamsExpectedDisposition = "MALICIOUS"
	InvestigateBulkCancelNewResponseActionParamsExpectedDispositionMaliciousBec InvestigateBulkCancelNewResponseActionParamsExpectedDisposition = "MALICIOUS-BEC"
	InvestigateBulkCancelNewResponseActionParamsExpectedDispositionSuspicious   InvestigateBulkCancelNewResponseActionParamsExpectedDisposition = "SUSPICIOUS"
	InvestigateBulkCancelNewResponseActionParamsExpectedDispositionSpoof        InvestigateBulkCancelNewResponseActionParamsExpectedDisposition = "SPOOF"
	InvestigateBulkCancelNewResponseActionParamsExpectedDispositionSpam         InvestigateBulkCancelNewResponseActionParamsExpectedDisposition = "SPAM"
	InvestigateBulkCancelNewResponseActionParamsExpectedDispositionBulk         InvestigateBulkCancelNewResponseActionParamsExpectedDisposition = "BULK"
	InvestigateBulkCancelNewResponseActionParamsExpectedDispositionEncrypted    InvestigateBulkCancelNewResponseActionParamsExpectedDisposition = "ENCRYPTED"
	InvestigateBulkCancelNewResponseActionParamsExpectedDispositionExternal     InvestigateBulkCancelNewResponseActionParamsExpectedDisposition = "EXTERNAL"
	InvestigateBulkCancelNewResponseActionParamsExpectedDispositionUnknown      InvestigateBulkCancelNewResponseActionParamsExpectedDisposition = "UNKNOWN"
	InvestigateBulkCancelNewResponseActionParamsExpectedDispositionNone         InvestigateBulkCancelNewResponseActionParamsExpectedDisposition = "NONE"
)

func (InvestigateBulkCancelNewResponseActionParamsExpectedDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkCancelNewResponseActionParamsExpectedDisposition) IsKnown() bool

type InvestigateBulkCancelNewResponseActionParamsMove ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseActionParamsMove struct {
	Destination         InvestigateBulkCancelNewResponseActionParamsMoveDestination         `json:"destination" api:"required"`
	Type                InvestigateBulkCancelNewResponseActionParamsMoveType                `json:"type" api:"required"`
	ExpectedDisposition InvestigateBulkCancelNewResponseActionParamsMoveExpectedDisposition `json:"expected_disposition"`
	JSON                investigateBulkCancelNewResponseActionParamsMoveJSON                `json:"-"`
}

func (*InvestigateBulkCancelNewResponseActionParamsMove) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkCancelNewResponseActionParamsMove) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkCancelNewResponseActionParamsMoveDestination ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseActionParamsMoveDestination string
const (
	InvestigateBulkCancelNewResponseActionParamsMoveDestinationInbox                     InvestigateBulkCancelNewResponseActionParamsMoveDestination = "Inbox"
	InvestigateBulkCancelNewResponseActionParamsMoveDestinationJunkEmail                 InvestigateBulkCancelNewResponseActionParamsMoveDestination = "JunkEmail"
	InvestigateBulkCancelNewResponseActionParamsMoveDestinationDeletedItems              InvestigateBulkCancelNewResponseActionParamsMoveDestination = "DeletedItems"
	InvestigateBulkCancelNewResponseActionParamsMoveDestinationRecoverableItemsDeletions InvestigateBulkCancelNewResponseActionParamsMoveDestination = "RecoverableItemsDeletions"
	InvestigateBulkCancelNewResponseActionParamsMoveDestinationRecoverableItemsPurges    InvestigateBulkCancelNewResponseActionParamsMoveDestination = "RecoverableItemsPurges"
)

func (InvestigateBulkCancelNewResponseActionParamsMoveDestination) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkCancelNewResponseActionParamsMoveDestination) IsKnown() bool

type InvestigateBulkCancelNewResponseActionParamsMoveExpectedDisposition ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseActionParamsMoveExpectedDisposition string
const (
	InvestigateBulkCancelNewResponseActionParamsMoveExpectedDispositionMalicious    InvestigateBulkCancelNewResponseActionParamsMoveExpectedDisposition = "MALICIOUS"
	InvestigateBulkCancelNewResponseActionParamsMoveExpectedDispositionMaliciousBec InvestigateBulkCancelNewResponseActionParamsMoveExpectedDisposition = "MALICIOUS-BEC"
	InvestigateBulkCancelNewResponseActionParamsMoveExpectedDispositionSuspicious   InvestigateBulkCancelNewResponseActionParamsMoveExpectedDisposition = "SUSPICIOUS"
	InvestigateBulkCancelNewResponseActionParamsMoveExpectedDispositionSpoof        InvestigateBulkCancelNewResponseActionParamsMoveExpectedDisposition = "SPOOF"
	InvestigateBulkCancelNewResponseActionParamsMoveExpectedDispositionSpam         InvestigateBulkCancelNewResponseActionParamsMoveExpectedDisposition = "SPAM"
	InvestigateBulkCancelNewResponseActionParamsMoveExpectedDispositionBulk         InvestigateBulkCancelNewResponseActionParamsMoveExpectedDisposition = "BULK"
	InvestigateBulkCancelNewResponseActionParamsMoveExpectedDispositionEncrypted    InvestigateBulkCancelNewResponseActionParamsMoveExpectedDisposition = "ENCRYPTED"
	InvestigateBulkCancelNewResponseActionParamsMoveExpectedDispositionExternal     InvestigateBulkCancelNewResponseActionParamsMoveExpectedDisposition = "EXTERNAL"
	InvestigateBulkCancelNewResponseActionParamsMoveExpectedDispositionUnknown      InvestigateBulkCancelNewResponseActionParamsMoveExpectedDisposition = "UNKNOWN"
	InvestigateBulkCancelNewResponseActionParamsMoveExpectedDispositionNone         InvestigateBulkCancelNewResponseActionParamsMoveExpectedDisposition = "NONE"
)

func (InvestigateBulkCancelNewResponseActionParamsMoveExpectedDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkCancelNewResponseActionParamsMoveExpectedDisposition) IsKnown() bool

type InvestigateBulkCancelNewResponseActionParamsMoveType ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseActionParamsMoveType string
const (
	InvestigateBulkCancelNewResponseActionParamsMoveTypeMove InvestigateBulkCancelNewResponseActionParamsMoveType = "MOVE"
)

func (InvestigateBulkCancelNewResponseActionParamsMoveType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkCancelNewResponseActionParamsMoveType) IsKnown() bool

type InvestigateBulkCancelNewResponseActionParamsRelease ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseActionParamsRelease struct {
	Type InvestigateBulkCancelNewResponseActionParamsReleaseType `json:"type" api:"required"`
	JSON investigateBulkCancelNewResponseActionParamsReleaseJSON `json:"-"`
}

func (*InvestigateBulkCancelNewResponseActionParamsRelease) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkCancelNewResponseActionParamsRelease) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkCancelNewResponseActionParamsReleaseType ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseActionParamsReleaseType string
const (
	InvestigateBulkCancelNewResponseActionParamsReleaseTypeRelease InvestigateBulkCancelNewResponseActionParamsReleaseType = "RELEASE"
)

func (InvestigateBulkCancelNewResponseActionParamsReleaseType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkCancelNewResponseActionParamsReleaseType) IsKnown() bool

type InvestigateBulkCancelNewResponseActionParamsType ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseActionParamsType string
const (
	InvestigateBulkCancelNewResponseActionParamsTypeMove    InvestigateBulkCancelNewResponseActionParamsType = "MOVE"
	InvestigateBulkCancelNewResponseActionParamsTypeRelease InvestigateBulkCancelNewResponseActionParamsType = "RELEASE"
)

func (InvestigateBulkCancelNewResponseActionParamsType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkCancelNewResponseActionParamsType) IsKnown() bool

type InvestigateBulkCancelNewResponseActionParamsUnion ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseActionParamsUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by InvestigateBulkCancelNewResponseActionParamsMove or InvestigateBulkCancelNewResponseActionParamsRelease.

type InvestigateBulkCancelNewResponseActionType ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseActionType string
const (
	InvestigateBulkCancelNewResponseActionTypeMove    InvestigateBulkCancelNewResponseActionType = "MOVE"
	InvestigateBulkCancelNewResponseActionTypeRelease InvestigateBulkCancelNewResponseActionType = "RELEASE"
)

func (InvestigateBulkCancelNewResponseActionType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkCancelNewResponseActionType) IsKnown() bool

type InvestigateBulkCancelNewResponseEnvelope ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseEnvelope struct {
	Errors   []InvestigateBulkCancelNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []InvestigateBulkCancelNewResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   InvestigateBulkCancelNewResponse                   `json:"result" api:"required"`
	// Whether the API call was successful.
	Success InvestigateBulkCancelNewResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    investigateBulkCancelNewResponseEnvelopeJSON    `json:"-"`
}

func (*InvestigateBulkCancelNewResponseEnvelope) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkCancelNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkCancelNewResponseEnvelopeErrors ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseEnvelopeErrors struct {
	Code             int64                                                `json:"code" api:"required"`
	Message          string                                               `json:"message" api:"required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           InvestigateBulkCancelNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             investigateBulkCancelNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*InvestigateBulkCancelNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkCancelNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkCancelNewResponseEnvelopeErrorsSource ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseEnvelopeErrorsSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    investigateBulkCancelNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*InvestigateBulkCancelNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkCancelNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkCancelNewResponseEnvelopeMessages ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseEnvelopeMessages struct {
	Code             int64                                                  `json:"code" api:"required"`
	Message          string                                                 `json:"message" api:"required"`
	DocumentationURL string                                                 `json:"documentation_url"`
	Source           InvestigateBulkCancelNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             investigateBulkCancelNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*InvestigateBulkCancelNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkCancelNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkCancelNewResponseEnvelopeMessagesSource ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                     `json:"pointer"`
	JSON    investigateBulkCancelNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*InvestigateBulkCancelNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkCancelNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkCancelNewResponseEnvelopeSuccess ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	InvestigateBulkCancelNewResponseEnvelopeSuccessTrue InvestigateBulkCancelNewResponseEnvelopeSuccess = true
)

func (InvestigateBulkCancelNewResponseEnvelopeSuccess) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkCancelNewResponseEnvelopeSuccess) IsKnown() bool

type InvestigateBulkCancelNewResponseSearchParams ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseSearchParams struct {
	// Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of
	// life: November 1, 2026.
	//
	// Deprecated: Use GET /investigate/{investigate_id}/action_log instead.
	ActionLog bool   `json:"action_log"`
	AlertID   string `json:"alert_id" api:"nullable"`
	// Delivery status of the message.
	DeliveryStatus InvestigateBulkCancelNewResponseSearchParamsDeliveryStatus `json:"delivery_status"`
	DetectionsOnly bool                                                       `json:"detections_only"`
	Domain         string                                                     `json:"domain" api:"nullable"`
	// End of search date range
	End              time.Time                                                    `json:"end" format:"date-time"`
	ExactSubject     string                                                       `json:"exact_subject" api:"nullable"`
	FinalDisposition InvestigateBulkCancelNewResponseSearchParamsFinalDisposition `json:"final_disposition"`
	MessageAction    InvestigateBulkCancelNewResponseSearchParamsMessageAction    `json:"message_action" api:"nullable"`
	MessageID        string                                                       `json:"message_id" api:"nullable"`
	Metric           string                                                       `json:"metric" api:"nullable"`
	Query            string                                                       `json:"query" api:"nullable"`
	Recipient        string                                                       `json:"recipient" api:"nullable"`
	Sender           string                                                       `json:"sender" api:"nullable"`
	// Beginning of search date range
	Start       time.Time                                        `json:"start" format:"date-time"`
	Subject     string                                           `json:"subject" api:"nullable"`
	Submissions bool                                             `json:"submissions"`
	JSON        investigateBulkCancelNewResponseSearchParamsJSON `json:"-"`
}

func (*InvestigateBulkCancelNewResponseSearchParams) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkCancelNewResponseSearchParams) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkCancelNewResponseSearchParamsDeliveryStatus ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseSearchParamsDeliveryStatus string

Delivery status of the message. 

const (
	InvestigateBulkCancelNewResponseSearchParamsDeliveryStatusDelivered   InvestigateBulkCancelNewResponseSearchParamsDeliveryStatus = "delivered"
	InvestigateBulkCancelNewResponseSearchParamsDeliveryStatusMoved       InvestigateBulkCancelNewResponseSearchParamsDeliveryStatus = "moved"
	InvestigateBulkCancelNewResponseSearchParamsDeliveryStatusQuarantined InvestigateBulkCancelNewResponseSearchParamsDeliveryStatus = "quarantined"
	InvestigateBulkCancelNewResponseSearchParamsDeliveryStatusRejected    InvestigateBulkCancelNewResponseSearchParamsDeliveryStatus = "rejected"
	InvestigateBulkCancelNewResponseSearchParamsDeliveryStatusDeferred    InvestigateBulkCancelNewResponseSearchParamsDeliveryStatus = "deferred"
	InvestigateBulkCancelNewResponseSearchParamsDeliveryStatusBounced     InvestigateBulkCancelNewResponseSearchParamsDeliveryStatus = "bounced"
	InvestigateBulkCancelNewResponseSearchParamsDeliveryStatusQueued      InvestigateBulkCancelNewResponseSearchParamsDeliveryStatus = "queued"
)

func (InvestigateBulkCancelNewResponseSearchParamsDeliveryStatus) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkCancelNewResponseSearchParamsDeliveryStatus) IsKnown() bool

type InvestigateBulkCancelNewResponseSearchParamsFinalDisposition ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseSearchParamsFinalDisposition string
const (
	InvestigateBulkCancelNewResponseSearchParamsFinalDispositionMalicious    InvestigateBulkCancelNewResponseSearchParamsFinalDisposition = "MALICIOUS"
	InvestigateBulkCancelNewResponseSearchParamsFinalDispositionMaliciousBec InvestigateBulkCancelNewResponseSearchParamsFinalDisposition = "MALICIOUS-BEC"
	InvestigateBulkCancelNewResponseSearchParamsFinalDispositionSuspicious   InvestigateBulkCancelNewResponseSearchParamsFinalDisposition = "SUSPICIOUS"
	InvestigateBulkCancelNewResponseSearchParamsFinalDispositionSpoof        InvestigateBulkCancelNewResponseSearchParamsFinalDisposition = "SPOOF"
	InvestigateBulkCancelNewResponseSearchParamsFinalDispositionSpam         InvestigateBulkCancelNewResponseSearchParamsFinalDisposition = "SPAM"
	InvestigateBulkCancelNewResponseSearchParamsFinalDispositionBulk         InvestigateBulkCancelNewResponseSearchParamsFinalDisposition = "BULK"
	InvestigateBulkCancelNewResponseSearchParamsFinalDispositionEncrypted    InvestigateBulkCancelNewResponseSearchParamsFinalDisposition = "ENCRYPTED"
	InvestigateBulkCancelNewResponseSearchParamsFinalDispositionExternal     InvestigateBulkCancelNewResponseSearchParamsFinalDisposition = "EXTERNAL"
	InvestigateBulkCancelNewResponseSearchParamsFinalDispositionUnknown      InvestigateBulkCancelNewResponseSearchParamsFinalDisposition = "UNKNOWN"
	InvestigateBulkCancelNewResponseSearchParamsFinalDispositionNone         InvestigateBulkCancelNewResponseSearchParamsFinalDisposition = "NONE"
)

func (InvestigateBulkCancelNewResponseSearchParamsFinalDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkCancelNewResponseSearchParamsFinalDisposition) IsKnown() bool

type InvestigateBulkCancelNewResponseSearchParamsMessageAction ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseSearchParamsMessageAction string
const (
	InvestigateBulkCancelNewResponseSearchParamsMessageActionPreview            InvestigateBulkCancelNewResponseSearchParamsMessageAction = "PREVIEW"
	InvestigateBulkCancelNewResponseSearchParamsMessageActionQuarantineReleased InvestigateBulkCancelNewResponseSearchParamsMessageAction = "QUARANTINE_RELEASED"
	InvestigateBulkCancelNewResponseSearchParamsMessageActionMoved              InvestigateBulkCancelNewResponseSearchParamsMessageAction = "MOVED"
)

func (InvestigateBulkCancelNewResponseSearchParamsMessageAction) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkCancelNewResponseSearchParamsMessageAction) IsKnown() bool

type InvestigateBulkCancelNewResponseStatus ¶ added in v7.7.0 

type InvestigateBulkCancelNewResponseStatus string
const (
	InvestigateBulkCancelNewResponseStatusPending     InvestigateBulkCancelNewResponseStatus = "PENDING"
	InvestigateBulkCancelNewResponseStatusDiscovering InvestigateBulkCancelNewResponseStatus = "DISCOVERING"
	InvestigateBulkCancelNewResponseStatusProcessing  InvestigateBulkCancelNewResponseStatus = "PROCESSING"
	InvestigateBulkCancelNewResponseStatusCompleted   InvestigateBulkCancelNewResponseStatus = "COMPLETED"
	InvestigateBulkCancelNewResponseStatusFailed      InvestigateBulkCancelNewResponseStatus = "FAILED"
	InvestigateBulkCancelNewResponseStatusCancelled   InvestigateBulkCancelNewResponseStatus = "CANCELLED"
	InvestigateBulkCancelNewResponseStatusSkipped     InvestigateBulkCancelNewResponseStatus = "SKIPPED"
)

func (InvestigateBulkCancelNewResponseStatus) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkCancelNewResponseStatus) IsKnown() bool

type InvestigateBulkCancelService ¶ added in v7.7.0 

type InvestigateBulkCancelService struct {
	Options []option.RequestOption
}

InvestigateBulkCancelService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateBulkCancelService method instead.

func NewInvestigateBulkCancelService ¶ added in v7.7.0 

func NewInvestigateBulkCancelService(opts ...option.RequestOption) (r *InvestigateBulkCancelService)

NewInvestigateBulkCancelService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateBulkCancelService) New ¶ added in v7.7.0 

func (r *InvestigateBulkCancelService) New(ctx context.Context, jobID string, body InvestigateBulkCancelNewParams, opts ...option.RequestOption) (res *InvestigateBulkCancelNewResponse, err error)

Marks the job as cancelled and stops any pending message processing. The job record remains visible in list and detail endpoints.

type InvestigateBulkDeleteParams ¶ added in v7.7.0 

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

type InvestigateBulkDeleteResponse ¶ added in v7.7.0 

type InvestigateBulkDeleteResponse struct {
	ID   string                            `json:"id" api:"required" format:"uuid"`
	JSON investigateBulkDeleteResponseJSON `json:"-"`
}

func (*InvestigateBulkDeleteResponse) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkDeleteResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkDeleteResponseEnvelope ¶ added in v7.7.0 

type InvestigateBulkDeleteResponseEnvelope struct {
	Errors   []InvestigateBulkDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []InvestigateBulkDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   InvestigateBulkDeleteResponse                   `json:"result" api:"required"`
	// Whether the API call was successful.
	Success InvestigateBulkDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    investigateBulkDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*InvestigateBulkDeleteResponseEnvelope) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkDeleteResponseEnvelopeErrors ¶ added in v7.7.0 

type InvestigateBulkDeleteResponseEnvelopeErrors struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           InvestigateBulkDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             investigateBulkDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*InvestigateBulkDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkDeleteResponseEnvelopeErrorsSource ¶ added in v7.7.0 

type InvestigateBulkDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    investigateBulkDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*InvestigateBulkDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkDeleteResponseEnvelopeMessages ¶ added in v7.7.0 

type InvestigateBulkDeleteResponseEnvelopeMessages struct {
	Code             int64                                               `json:"code" api:"required"`
	Message          string                                              `json:"message" api:"required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           InvestigateBulkDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             investigateBulkDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*InvestigateBulkDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkDeleteResponseEnvelopeMessagesSource ¶ added in v7.7.0 

type InvestigateBulkDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    investigateBulkDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*InvestigateBulkDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkDeleteResponseEnvelopeSuccess ¶ added in v7.7.0 

type InvestigateBulkDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	InvestigateBulkDeleteResponseEnvelopeSuccessTrue InvestigateBulkDeleteResponseEnvelopeSuccess = true
)

func (InvestigateBulkDeleteResponseEnvelopeSuccess) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkDeleteResponseEnvelopeSuccess) IsKnown() bool

type InvestigateBulkGetParams ¶ added in v7.7.0 

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

type InvestigateBulkGetResponse ¶ added in v7.7.0 

type InvestigateBulkGetResponse struct {
	ActionParams            InvestigateBulkGetResponseActionParams `json:"action_params" api:"required"`
	ActionType              InvestigateBulkGetResponseActionType   `json:"action_type" api:"required"`
	CreatedAt               time.Time                              `json:"created_at" api:"required" format:"date-time"`
	JobID                   string                                 `json:"job_id" api:"required" format:"uuid"`
	MessagesFailed          int64                                  `json:"messages_failed" api:"required"`
	MessagesPending         int64                                  `json:"messages_pending" api:"required"`
	MessagesSuccessful      int64                                  `json:"messages_successful" api:"required"`
	SearchParams            InvestigateBulkGetResponseSearchParams `json:"search_params" api:"required"`
	Status                  InvestigateBulkGetResponseStatus       `json:"status" api:"required"`
	TotalMessagesDiscovered int64                                  `json:"total_messages_discovered" api:"required"`
	Comment                 string                                 `json:"comment" api:"nullable"`
	CompletedAt             time.Time                              `json:"completed_at" api:"nullable" format:"date-time"`
	StartedAt               time.Time                              `json:"started_at" api:"nullable" format:"date-time"`
	StatusMessage           string                                 `json:"status_message" api:"nullable"`
	JSON                    investigateBulkGetResponseJSON         `json:"-"`
}

func (*InvestigateBulkGetResponse) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkGetResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkGetResponseActionParams ¶ added in v7.7.0 

type InvestigateBulkGetResponseActionParams struct {
	Type                InvestigateBulkGetResponseActionParamsType                `json:"type" api:"required"`
	Destination         InvestigateBulkGetResponseActionParamsDestination         `json:"destination"`
	ExpectedDisposition InvestigateBulkGetResponseActionParamsExpectedDisposition `json:"expected_disposition"`
	JSON                investigateBulkGetResponseActionParamsJSON                `json:"-"`
	// contains filtered or unexported fields
}

func (InvestigateBulkGetResponseActionParams) AsUnion ¶ added in v7.7.0 

func (r InvestigateBulkGetResponseActionParams) AsUnion() InvestigateBulkGetResponseActionParamsUnion

AsUnion returns a InvestigateBulkGetResponseActionParamsUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are InvestigateBulkGetResponseActionParamsMove, InvestigateBulkGetResponseActionParamsRelease.

func (*InvestigateBulkGetResponseActionParams) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkGetResponseActionParams) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkGetResponseActionParamsDestination ¶ added in v7.7.0 

type InvestigateBulkGetResponseActionParamsDestination string
const (
	InvestigateBulkGetResponseActionParamsDestinationInbox                     InvestigateBulkGetResponseActionParamsDestination = "Inbox"
	InvestigateBulkGetResponseActionParamsDestinationJunkEmail                 InvestigateBulkGetResponseActionParamsDestination = "JunkEmail"
	InvestigateBulkGetResponseActionParamsDestinationDeletedItems              InvestigateBulkGetResponseActionParamsDestination = "DeletedItems"
	InvestigateBulkGetResponseActionParamsDestinationRecoverableItemsDeletions InvestigateBulkGetResponseActionParamsDestination = "RecoverableItemsDeletions"
	InvestigateBulkGetResponseActionParamsDestinationRecoverableItemsPurges    InvestigateBulkGetResponseActionParamsDestination = "RecoverableItemsPurges"
)

func (InvestigateBulkGetResponseActionParamsDestination) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkGetResponseActionParamsDestination) IsKnown() bool

type InvestigateBulkGetResponseActionParamsExpectedDisposition ¶ added in v7.7.0 

type InvestigateBulkGetResponseActionParamsExpectedDisposition string
const (
	InvestigateBulkGetResponseActionParamsExpectedDispositionMalicious    InvestigateBulkGetResponseActionParamsExpectedDisposition = "MALICIOUS"
	InvestigateBulkGetResponseActionParamsExpectedDispositionMaliciousBec InvestigateBulkGetResponseActionParamsExpectedDisposition = "MALICIOUS-BEC"
	InvestigateBulkGetResponseActionParamsExpectedDispositionSuspicious   InvestigateBulkGetResponseActionParamsExpectedDisposition = "SUSPICIOUS"
	InvestigateBulkGetResponseActionParamsExpectedDispositionSpoof        InvestigateBulkGetResponseActionParamsExpectedDisposition = "SPOOF"
	InvestigateBulkGetResponseActionParamsExpectedDispositionSpam         InvestigateBulkGetResponseActionParamsExpectedDisposition = "SPAM"
	InvestigateBulkGetResponseActionParamsExpectedDispositionBulk         InvestigateBulkGetResponseActionParamsExpectedDisposition = "BULK"
	InvestigateBulkGetResponseActionParamsExpectedDispositionEncrypted    InvestigateBulkGetResponseActionParamsExpectedDisposition = "ENCRYPTED"
	InvestigateBulkGetResponseActionParamsExpectedDispositionExternal     InvestigateBulkGetResponseActionParamsExpectedDisposition = "EXTERNAL"
	InvestigateBulkGetResponseActionParamsExpectedDispositionUnknown      InvestigateBulkGetResponseActionParamsExpectedDisposition = "UNKNOWN"
	InvestigateBulkGetResponseActionParamsExpectedDispositionNone         InvestigateBulkGetResponseActionParamsExpectedDisposition = "NONE"
)

func (InvestigateBulkGetResponseActionParamsExpectedDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkGetResponseActionParamsExpectedDisposition) IsKnown() bool

type InvestigateBulkGetResponseActionParamsMove ¶ added in v7.7.0 

type InvestigateBulkGetResponseActionParamsMove struct {
	Destination         InvestigateBulkGetResponseActionParamsMoveDestination         `json:"destination" api:"required"`
	Type                InvestigateBulkGetResponseActionParamsMoveType                `json:"type" api:"required"`
	ExpectedDisposition InvestigateBulkGetResponseActionParamsMoveExpectedDisposition `json:"expected_disposition"`
	JSON                investigateBulkGetResponseActionParamsMoveJSON                `json:"-"`
}

func (*InvestigateBulkGetResponseActionParamsMove) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkGetResponseActionParamsMove) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkGetResponseActionParamsMoveDestination ¶ added in v7.7.0 

type InvestigateBulkGetResponseActionParamsMoveDestination string
const (
	InvestigateBulkGetResponseActionParamsMoveDestinationInbox                     InvestigateBulkGetResponseActionParamsMoveDestination = "Inbox"
	InvestigateBulkGetResponseActionParamsMoveDestinationJunkEmail                 InvestigateBulkGetResponseActionParamsMoveDestination = "JunkEmail"
	InvestigateBulkGetResponseActionParamsMoveDestinationDeletedItems              InvestigateBulkGetResponseActionParamsMoveDestination = "DeletedItems"
	InvestigateBulkGetResponseActionParamsMoveDestinationRecoverableItemsDeletions InvestigateBulkGetResponseActionParamsMoveDestination = "RecoverableItemsDeletions"
	InvestigateBulkGetResponseActionParamsMoveDestinationRecoverableItemsPurges    InvestigateBulkGetResponseActionParamsMoveDestination = "RecoverableItemsPurges"
)

func (InvestigateBulkGetResponseActionParamsMoveDestination) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkGetResponseActionParamsMoveDestination) IsKnown() bool

type InvestigateBulkGetResponseActionParamsMoveExpectedDisposition ¶ added in v7.7.0 

type InvestigateBulkGetResponseActionParamsMoveExpectedDisposition string
const (
	InvestigateBulkGetResponseActionParamsMoveExpectedDispositionMalicious    InvestigateBulkGetResponseActionParamsMoveExpectedDisposition = "MALICIOUS"
	InvestigateBulkGetResponseActionParamsMoveExpectedDispositionMaliciousBec InvestigateBulkGetResponseActionParamsMoveExpectedDisposition = "MALICIOUS-BEC"
	InvestigateBulkGetResponseActionParamsMoveExpectedDispositionSuspicious   InvestigateBulkGetResponseActionParamsMoveExpectedDisposition = "SUSPICIOUS"
	InvestigateBulkGetResponseActionParamsMoveExpectedDispositionSpoof        InvestigateBulkGetResponseActionParamsMoveExpectedDisposition = "SPOOF"
	InvestigateBulkGetResponseActionParamsMoveExpectedDispositionSpam         InvestigateBulkGetResponseActionParamsMoveExpectedDisposition = "SPAM"
	InvestigateBulkGetResponseActionParamsMoveExpectedDispositionBulk         InvestigateBulkGetResponseActionParamsMoveExpectedDisposition = "BULK"
	InvestigateBulkGetResponseActionParamsMoveExpectedDispositionEncrypted    InvestigateBulkGetResponseActionParamsMoveExpectedDisposition = "ENCRYPTED"
	InvestigateBulkGetResponseActionParamsMoveExpectedDispositionExternal     InvestigateBulkGetResponseActionParamsMoveExpectedDisposition = "EXTERNAL"
	InvestigateBulkGetResponseActionParamsMoveExpectedDispositionUnknown      InvestigateBulkGetResponseActionParamsMoveExpectedDisposition = "UNKNOWN"
	InvestigateBulkGetResponseActionParamsMoveExpectedDispositionNone         InvestigateBulkGetResponseActionParamsMoveExpectedDisposition = "NONE"
)

func (InvestigateBulkGetResponseActionParamsMoveExpectedDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkGetResponseActionParamsMoveExpectedDisposition) IsKnown() bool

type InvestigateBulkGetResponseActionParamsMoveType ¶ added in v7.7.0 

type InvestigateBulkGetResponseActionParamsMoveType string
const (
	InvestigateBulkGetResponseActionParamsMoveTypeMove InvestigateBulkGetResponseActionParamsMoveType = "MOVE"
)

func (InvestigateBulkGetResponseActionParamsMoveType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkGetResponseActionParamsMoveType) IsKnown() bool

type InvestigateBulkGetResponseActionParamsRelease ¶ added in v7.7.0 

type InvestigateBulkGetResponseActionParamsRelease struct {
	Type InvestigateBulkGetResponseActionParamsReleaseType `json:"type" api:"required"`
	JSON investigateBulkGetResponseActionParamsReleaseJSON `json:"-"`
}

func (*InvestigateBulkGetResponseActionParamsRelease) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkGetResponseActionParamsRelease) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkGetResponseActionParamsReleaseType ¶ added in v7.7.0 

type InvestigateBulkGetResponseActionParamsReleaseType string
const (
	InvestigateBulkGetResponseActionParamsReleaseTypeRelease InvestigateBulkGetResponseActionParamsReleaseType = "RELEASE"
)

func (InvestigateBulkGetResponseActionParamsReleaseType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkGetResponseActionParamsReleaseType) IsKnown() bool

type InvestigateBulkGetResponseActionParamsType ¶ added in v7.7.0 

type InvestigateBulkGetResponseActionParamsType string
const (
	InvestigateBulkGetResponseActionParamsTypeMove    InvestigateBulkGetResponseActionParamsType = "MOVE"
	InvestigateBulkGetResponseActionParamsTypeRelease InvestigateBulkGetResponseActionParamsType = "RELEASE"
)

func (InvestigateBulkGetResponseActionParamsType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkGetResponseActionParamsType) IsKnown() bool

type InvestigateBulkGetResponseActionParamsUnion ¶ added in v7.7.0 

type InvestigateBulkGetResponseActionParamsUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by InvestigateBulkGetResponseActionParamsMove or InvestigateBulkGetResponseActionParamsRelease.

type InvestigateBulkGetResponseActionType ¶ added in v7.7.0 

type InvestigateBulkGetResponseActionType string
const (
	InvestigateBulkGetResponseActionTypeMove    InvestigateBulkGetResponseActionType = "MOVE"
	InvestigateBulkGetResponseActionTypeRelease InvestigateBulkGetResponseActionType = "RELEASE"
)

func (InvestigateBulkGetResponseActionType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkGetResponseActionType) IsKnown() bool

type InvestigateBulkGetResponseEnvelope ¶ added in v7.7.0 

type InvestigateBulkGetResponseEnvelope struct {
	Errors   []InvestigateBulkGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []InvestigateBulkGetResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   InvestigateBulkGetResponse                   `json:"result" api:"required"`
	// Whether the API call was successful.
	Success InvestigateBulkGetResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    investigateBulkGetResponseEnvelopeJSON    `json:"-"`
}

func (*InvestigateBulkGetResponseEnvelope) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkGetResponseEnvelopeErrors ¶ added in v7.7.0 

type InvestigateBulkGetResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code" api:"required"`
	Message          string                                         `json:"message" api:"required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           InvestigateBulkGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             investigateBulkGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*InvestigateBulkGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkGetResponseEnvelopeErrorsSource ¶ added in v7.7.0 

type InvestigateBulkGetResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    investigateBulkGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*InvestigateBulkGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkGetResponseEnvelopeMessages ¶ added in v7.7.0 

type InvestigateBulkGetResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code" api:"required"`
	Message          string                                           `json:"message" api:"required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           InvestigateBulkGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             investigateBulkGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*InvestigateBulkGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkGetResponseEnvelopeMessagesSource ¶ added in v7.7.0 

type InvestigateBulkGetResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    investigateBulkGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*InvestigateBulkGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkGetResponseEnvelopeSuccess ¶ added in v7.7.0 

type InvestigateBulkGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	InvestigateBulkGetResponseEnvelopeSuccessTrue InvestigateBulkGetResponseEnvelopeSuccess = true
)

func (InvestigateBulkGetResponseEnvelopeSuccess) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkGetResponseEnvelopeSuccess) IsKnown() bool

type InvestigateBulkGetResponseSearchParams ¶ added in v7.7.0 

type InvestigateBulkGetResponseSearchParams struct {
	// Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of
	// life: November 1, 2026.
	//
	// Deprecated: Use GET /investigate/{investigate_id}/action_log instead.
	ActionLog bool   `json:"action_log"`
	AlertID   string `json:"alert_id" api:"nullable"`
	// Delivery status of the message.
	DeliveryStatus InvestigateBulkGetResponseSearchParamsDeliveryStatus `json:"delivery_status"`
	DetectionsOnly bool                                                 `json:"detections_only"`
	Domain         string                                               `json:"domain" api:"nullable"`
	// End of search date range
	End              time.Time                                              `json:"end" format:"date-time"`
	ExactSubject     string                                                 `json:"exact_subject" api:"nullable"`
	FinalDisposition InvestigateBulkGetResponseSearchParamsFinalDisposition `json:"final_disposition"`
	MessageAction    InvestigateBulkGetResponseSearchParamsMessageAction    `json:"message_action" api:"nullable"`
	MessageID        string                                                 `json:"message_id" api:"nullable"`
	Metric           string                                                 `json:"metric" api:"nullable"`
	Query            string                                                 `json:"query" api:"nullable"`
	Recipient        string                                                 `json:"recipient" api:"nullable"`
	Sender           string                                                 `json:"sender" api:"nullable"`
	// Beginning of search date range
	Start       time.Time                                  `json:"start" format:"date-time"`
	Subject     string                                     `json:"subject" api:"nullable"`
	Submissions bool                                       `json:"submissions"`
	JSON        investigateBulkGetResponseSearchParamsJSON `json:"-"`
}

func (*InvestigateBulkGetResponseSearchParams) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkGetResponseSearchParams) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkGetResponseSearchParamsDeliveryStatus ¶ added in v7.7.0 

type InvestigateBulkGetResponseSearchParamsDeliveryStatus string

Delivery status of the message. 

const (
	InvestigateBulkGetResponseSearchParamsDeliveryStatusDelivered   InvestigateBulkGetResponseSearchParamsDeliveryStatus = "delivered"
	InvestigateBulkGetResponseSearchParamsDeliveryStatusMoved       InvestigateBulkGetResponseSearchParamsDeliveryStatus = "moved"
	InvestigateBulkGetResponseSearchParamsDeliveryStatusQuarantined InvestigateBulkGetResponseSearchParamsDeliveryStatus = "quarantined"
	InvestigateBulkGetResponseSearchParamsDeliveryStatusRejected    InvestigateBulkGetResponseSearchParamsDeliveryStatus = "rejected"
	InvestigateBulkGetResponseSearchParamsDeliveryStatusDeferred    InvestigateBulkGetResponseSearchParamsDeliveryStatus = "deferred"
	InvestigateBulkGetResponseSearchParamsDeliveryStatusBounced     InvestigateBulkGetResponseSearchParamsDeliveryStatus = "bounced"
	InvestigateBulkGetResponseSearchParamsDeliveryStatusQueued      InvestigateBulkGetResponseSearchParamsDeliveryStatus = "queued"
)

func (InvestigateBulkGetResponseSearchParamsDeliveryStatus) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkGetResponseSearchParamsDeliveryStatus) IsKnown() bool

type InvestigateBulkGetResponseSearchParamsFinalDisposition ¶ added in v7.7.0 

type InvestigateBulkGetResponseSearchParamsFinalDisposition string
const (
	InvestigateBulkGetResponseSearchParamsFinalDispositionMalicious    InvestigateBulkGetResponseSearchParamsFinalDisposition = "MALICIOUS"
	InvestigateBulkGetResponseSearchParamsFinalDispositionMaliciousBec InvestigateBulkGetResponseSearchParamsFinalDisposition = "MALICIOUS-BEC"
	InvestigateBulkGetResponseSearchParamsFinalDispositionSuspicious   InvestigateBulkGetResponseSearchParamsFinalDisposition = "SUSPICIOUS"
	InvestigateBulkGetResponseSearchParamsFinalDispositionSpoof        InvestigateBulkGetResponseSearchParamsFinalDisposition = "SPOOF"
	InvestigateBulkGetResponseSearchParamsFinalDispositionSpam         InvestigateBulkGetResponseSearchParamsFinalDisposition = "SPAM"
	InvestigateBulkGetResponseSearchParamsFinalDispositionBulk         InvestigateBulkGetResponseSearchParamsFinalDisposition = "BULK"
	InvestigateBulkGetResponseSearchParamsFinalDispositionEncrypted    InvestigateBulkGetResponseSearchParamsFinalDisposition = "ENCRYPTED"
	InvestigateBulkGetResponseSearchParamsFinalDispositionExternal     InvestigateBulkGetResponseSearchParamsFinalDisposition = "EXTERNAL"
	InvestigateBulkGetResponseSearchParamsFinalDispositionUnknown      InvestigateBulkGetResponseSearchParamsFinalDisposition = "UNKNOWN"
	InvestigateBulkGetResponseSearchParamsFinalDispositionNone         InvestigateBulkGetResponseSearchParamsFinalDisposition = "NONE"
)

func (InvestigateBulkGetResponseSearchParamsFinalDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkGetResponseSearchParamsFinalDisposition) IsKnown() bool

type InvestigateBulkGetResponseSearchParamsMessageAction ¶ added in v7.7.0 

type InvestigateBulkGetResponseSearchParamsMessageAction string
const (
	InvestigateBulkGetResponseSearchParamsMessageActionPreview            InvestigateBulkGetResponseSearchParamsMessageAction = "PREVIEW"
	InvestigateBulkGetResponseSearchParamsMessageActionQuarantineReleased InvestigateBulkGetResponseSearchParamsMessageAction = "QUARANTINE_RELEASED"
	InvestigateBulkGetResponseSearchParamsMessageActionMoved              InvestigateBulkGetResponseSearchParamsMessageAction = "MOVED"
)

func (InvestigateBulkGetResponseSearchParamsMessageAction) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkGetResponseSearchParamsMessageAction) IsKnown() bool

type InvestigateBulkGetResponseStatus ¶ added in v7.7.0 

type InvestigateBulkGetResponseStatus string
const (
	InvestigateBulkGetResponseStatusPending     InvestigateBulkGetResponseStatus = "PENDING"
	InvestigateBulkGetResponseStatusDiscovering InvestigateBulkGetResponseStatus = "DISCOVERING"
	InvestigateBulkGetResponseStatusProcessing  InvestigateBulkGetResponseStatus = "PROCESSING"
	InvestigateBulkGetResponseStatusCompleted   InvestigateBulkGetResponseStatus = "COMPLETED"
	InvestigateBulkGetResponseStatusFailed      InvestigateBulkGetResponseStatus = "FAILED"
	InvestigateBulkGetResponseStatusCancelled   InvestigateBulkGetResponseStatus = "CANCELLED"
	InvestigateBulkGetResponseStatusSkipped     InvestigateBulkGetResponseStatus = "SKIPPED"
)

func (InvestigateBulkGetResponseStatus) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkGetResponseStatus) IsKnown() bool

type InvestigateBulkListParams ¶ added in v7.7.0 

type InvestigateBulkListParams struct {
	// Identifier.
	AccountID  param.Field[string]                              `path:"account_id" api:"required"`
	ActionType param.Field[InvestigateBulkListParamsActionType] `query:"action_type"`
	// Current page within paginated list of results.
	Page param.Field[int64] `query:"page"`
	// The number of results per page. Maximum value is 1000.
	PerPage param.Field[int64]                           `query:"per_page"`
	Status  param.Field[InvestigateBulkListParamsStatus] `query:"status"`
}

func (InvestigateBulkListParams) URLQuery ¶ added in v7.7.0 

func (r InvestigateBulkListParams) URLQuery() (v url.Values)

URLQuery serializes InvestigateBulkListParams's query parameters as `url.Values`.

type InvestigateBulkListParamsActionType ¶ added in v7.7.0 

type InvestigateBulkListParamsActionType string
const (
	InvestigateBulkListParamsActionTypeMove    InvestigateBulkListParamsActionType = "MOVE"
	InvestigateBulkListParamsActionTypeRelease InvestigateBulkListParamsActionType = "RELEASE"
)

func (InvestigateBulkListParamsActionType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkListParamsActionType) IsKnown() bool

type InvestigateBulkListParamsStatus ¶ added in v7.7.0 

type InvestigateBulkListParamsStatus string
const (
	InvestigateBulkListParamsStatusPending     InvestigateBulkListParamsStatus = "PENDING"
	InvestigateBulkListParamsStatusDiscovering InvestigateBulkListParamsStatus = "DISCOVERING"
	InvestigateBulkListParamsStatusProcessing  InvestigateBulkListParamsStatus = "PROCESSING"
	InvestigateBulkListParamsStatusCompleted   InvestigateBulkListParamsStatus = "COMPLETED"
	InvestigateBulkListParamsStatusFailed      InvestigateBulkListParamsStatus = "FAILED"
	InvestigateBulkListParamsStatusCancelled   InvestigateBulkListParamsStatus = "CANCELLED"
	InvestigateBulkListParamsStatusSkipped     InvestigateBulkListParamsStatus = "SKIPPED"
)

func (InvestigateBulkListParamsStatus) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkListParamsStatus) IsKnown() bool

type InvestigateBulkListResponse ¶ added in v7.7.0 

type InvestigateBulkListResponse struct {
	ActionParams            InvestigateBulkListResponseActionParams `json:"action_params" api:"required"`
	ActionType              InvestigateBulkListResponseActionType   `json:"action_type" api:"required"`
	CreatedAt               time.Time                               `json:"created_at" api:"required" format:"date-time"`
	JobID                   string                                  `json:"job_id" api:"required" format:"uuid"`
	MessagesFailed          int64                                   `json:"messages_failed" api:"required"`
	MessagesPending         int64                                   `json:"messages_pending" api:"required"`
	MessagesSuccessful      int64                                   `json:"messages_successful" api:"required"`
	SearchParams            InvestigateBulkListResponseSearchParams `json:"search_params" api:"required"`
	Status                  InvestigateBulkListResponseStatus       `json:"status" api:"required"`
	TotalMessagesDiscovered int64                                   `json:"total_messages_discovered" api:"required"`
	Comment                 string                                  `json:"comment" api:"nullable"`
	CompletedAt             time.Time                               `json:"completed_at" api:"nullable" format:"date-time"`
	StartedAt               time.Time                               `json:"started_at" api:"nullable" format:"date-time"`
	StatusMessage           string                                  `json:"status_message" api:"nullable"`
	JSON                    investigateBulkListResponseJSON         `json:"-"`
}

func (*InvestigateBulkListResponse) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkListResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkListResponseActionParams ¶ added in v7.7.0 

type InvestigateBulkListResponseActionParams struct {
	Type                InvestigateBulkListResponseActionParamsType                `json:"type" api:"required"`
	Destination         InvestigateBulkListResponseActionParamsDestination         `json:"destination"`
	ExpectedDisposition InvestigateBulkListResponseActionParamsExpectedDisposition `json:"expected_disposition"`
	JSON                investigateBulkListResponseActionParamsJSON                `json:"-"`
	// contains filtered or unexported fields
}

func (InvestigateBulkListResponseActionParams) AsUnion ¶ added in v7.7.0 

func (r InvestigateBulkListResponseActionParams) AsUnion() InvestigateBulkListResponseActionParamsUnion

AsUnion returns a InvestigateBulkListResponseActionParamsUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are InvestigateBulkListResponseActionParamsMove, InvestigateBulkListResponseActionParamsRelease.

func (*InvestigateBulkListResponseActionParams) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkListResponseActionParams) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkListResponseActionParamsDestination ¶ added in v7.7.0 

type InvestigateBulkListResponseActionParamsDestination string
const (
	InvestigateBulkListResponseActionParamsDestinationInbox                     InvestigateBulkListResponseActionParamsDestination = "Inbox"
	InvestigateBulkListResponseActionParamsDestinationJunkEmail                 InvestigateBulkListResponseActionParamsDestination = "JunkEmail"
	InvestigateBulkListResponseActionParamsDestinationDeletedItems              InvestigateBulkListResponseActionParamsDestination = "DeletedItems"
	InvestigateBulkListResponseActionParamsDestinationRecoverableItemsDeletions InvestigateBulkListResponseActionParamsDestination = "RecoverableItemsDeletions"
	InvestigateBulkListResponseActionParamsDestinationRecoverableItemsPurges    InvestigateBulkListResponseActionParamsDestination = "RecoverableItemsPurges"
)

func (InvestigateBulkListResponseActionParamsDestination) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkListResponseActionParamsDestination) IsKnown() bool

type InvestigateBulkListResponseActionParamsExpectedDisposition ¶ added in v7.7.0 

type InvestigateBulkListResponseActionParamsExpectedDisposition string
const (
	InvestigateBulkListResponseActionParamsExpectedDispositionMalicious    InvestigateBulkListResponseActionParamsExpectedDisposition = "MALICIOUS"
	InvestigateBulkListResponseActionParamsExpectedDispositionMaliciousBec InvestigateBulkListResponseActionParamsExpectedDisposition = "MALICIOUS-BEC"
	InvestigateBulkListResponseActionParamsExpectedDispositionSuspicious   InvestigateBulkListResponseActionParamsExpectedDisposition = "SUSPICIOUS"
	InvestigateBulkListResponseActionParamsExpectedDispositionSpoof        InvestigateBulkListResponseActionParamsExpectedDisposition = "SPOOF"
	InvestigateBulkListResponseActionParamsExpectedDispositionSpam         InvestigateBulkListResponseActionParamsExpectedDisposition = "SPAM"
	InvestigateBulkListResponseActionParamsExpectedDispositionBulk         InvestigateBulkListResponseActionParamsExpectedDisposition = "BULK"
	InvestigateBulkListResponseActionParamsExpectedDispositionEncrypted    InvestigateBulkListResponseActionParamsExpectedDisposition = "ENCRYPTED"
	InvestigateBulkListResponseActionParamsExpectedDispositionExternal     InvestigateBulkListResponseActionParamsExpectedDisposition = "EXTERNAL"
	InvestigateBulkListResponseActionParamsExpectedDispositionUnknown      InvestigateBulkListResponseActionParamsExpectedDisposition = "UNKNOWN"
	InvestigateBulkListResponseActionParamsExpectedDispositionNone         InvestigateBulkListResponseActionParamsExpectedDisposition = "NONE"
)

func (InvestigateBulkListResponseActionParamsExpectedDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkListResponseActionParamsExpectedDisposition) IsKnown() bool

type InvestigateBulkListResponseActionParamsMove ¶ added in v7.7.0 

type InvestigateBulkListResponseActionParamsMove struct {
	Destination         InvestigateBulkListResponseActionParamsMoveDestination         `json:"destination" api:"required"`
	Type                InvestigateBulkListResponseActionParamsMoveType                `json:"type" api:"required"`
	ExpectedDisposition InvestigateBulkListResponseActionParamsMoveExpectedDisposition `json:"expected_disposition"`
	JSON                investigateBulkListResponseActionParamsMoveJSON                `json:"-"`
}

func (*InvestigateBulkListResponseActionParamsMove) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkListResponseActionParamsMove) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkListResponseActionParamsMoveDestination ¶ added in v7.7.0 

type InvestigateBulkListResponseActionParamsMoveDestination string
const (
	InvestigateBulkListResponseActionParamsMoveDestinationInbox                     InvestigateBulkListResponseActionParamsMoveDestination = "Inbox"
	InvestigateBulkListResponseActionParamsMoveDestinationJunkEmail                 InvestigateBulkListResponseActionParamsMoveDestination = "JunkEmail"
	InvestigateBulkListResponseActionParamsMoveDestinationDeletedItems              InvestigateBulkListResponseActionParamsMoveDestination = "DeletedItems"
	InvestigateBulkListResponseActionParamsMoveDestinationRecoverableItemsDeletions InvestigateBulkListResponseActionParamsMoveDestination = "RecoverableItemsDeletions"
	InvestigateBulkListResponseActionParamsMoveDestinationRecoverableItemsPurges    InvestigateBulkListResponseActionParamsMoveDestination = "RecoverableItemsPurges"
)

func (InvestigateBulkListResponseActionParamsMoveDestination) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkListResponseActionParamsMoveDestination) IsKnown() bool

type InvestigateBulkListResponseActionParamsMoveExpectedDisposition ¶ added in v7.7.0 

type InvestigateBulkListResponseActionParamsMoveExpectedDisposition string
const (
	InvestigateBulkListResponseActionParamsMoveExpectedDispositionMalicious    InvestigateBulkListResponseActionParamsMoveExpectedDisposition = "MALICIOUS"
	InvestigateBulkListResponseActionParamsMoveExpectedDispositionMaliciousBec InvestigateBulkListResponseActionParamsMoveExpectedDisposition = "MALICIOUS-BEC"
	InvestigateBulkListResponseActionParamsMoveExpectedDispositionSuspicious   InvestigateBulkListResponseActionParamsMoveExpectedDisposition = "SUSPICIOUS"
	InvestigateBulkListResponseActionParamsMoveExpectedDispositionSpoof        InvestigateBulkListResponseActionParamsMoveExpectedDisposition = "SPOOF"
	InvestigateBulkListResponseActionParamsMoveExpectedDispositionSpam         InvestigateBulkListResponseActionParamsMoveExpectedDisposition = "SPAM"
	InvestigateBulkListResponseActionParamsMoveExpectedDispositionBulk         InvestigateBulkListResponseActionParamsMoveExpectedDisposition = "BULK"
	InvestigateBulkListResponseActionParamsMoveExpectedDispositionEncrypted    InvestigateBulkListResponseActionParamsMoveExpectedDisposition = "ENCRYPTED"
	InvestigateBulkListResponseActionParamsMoveExpectedDispositionExternal     InvestigateBulkListResponseActionParamsMoveExpectedDisposition = "EXTERNAL"
	InvestigateBulkListResponseActionParamsMoveExpectedDispositionUnknown      InvestigateBulkListResponseActionParamsMoveExpectedDisposition = "UNKNOWN"
	InvestigateBulkListResponseActionParamsMoveExpectedDispositionNone         InvestigateBulkListResponseActionParamsMoveExpectedDisposition = "NONE"
)

func (InvestigateBulkListResponseActionParamsMoveExpectedDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkListResponseActionParamsMoveExpectedDisposition) IsKnown() bool

type InvestigateBulkListResponseActionParamsMoveType ¶ added in v7.7.0 

type InvestigateBulkListResponseActionParamsMoveType string
const (
	InvestigateBulkListResponseActionParamsMoveTypeMove InvestigateBulkListResponseActionParamsMoveType = "MOVE"
)

func (InvestigateBulkListResponseActionParamsMoveType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkListResponseActionParamsMoveType) IsKnown() bool

type InvestigateBulkListResponseActionParamsRelease ¶ added in v7.7.0 

type InvestigateBulkListResponseActionParamsRelease struct {
	Type InvestigateBulkListResponseActionParamsReleaseType `json:"type" api:"required"`
	JSON investigateBulkListResponseActionParamsReleaseJSON `json:"-"`
}

func (*InvestigateBulkListResponseActionParamsRelease) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkListResponseActionParamsRelease) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkListResponseActionParamsReleaseType ¶ added in v7.7.0 

type InvestigateBulkListResponseActionParamsReleaseType string
const (
	InvestigateBulkListResponseActionParamsReleaseTypeRelease InvestigateBulkListResponseActionParamsReleaseType = "RELEASE"
)

func (InvestigateBulkListResponseActionParamsReleaseType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkListResponseActionParamsReleaseType) IsKnown() bool

type InvestigateBulkListResponseActionParamsType ¶ added in v7.7.0 

type InvestigateBulkListResponseActionParamsType string
const (
	InvestigateBulkListResponseActionParamsTypeMove    InvestigateBulkListResponseActionParamsType = "MOVE"
	InvestigateBulkListResponseActionParamsTypeRelease InvestigateBulkListResponseActionParamsType = "RELEASE"
)

func (InvestigateBulkListResponseActionParamsType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkListResponseActionParamsType) IsKnown() bool

type InvestigateBulkListResponseActionParamsUnion ¶ added in v7.7.0 

type InvestigateBulkListResponseActionParamsUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by InvestigateBulkListResponseActionParamsMove or InvestigateBulkListResponseActionParamsRelease.

type InvestigateBulkListResponseActionType ¶ added in v7.7.0 

type InvestigateBulkListResponseActionType string
const (
	InvestigateBulkListResponseActionTypeMove    InvestigateBulkListResponseActionType = "MOVE"
	InvestigateBulkListResponseActionTypeRelease InvestigateBulkListResponseActionType = "RELEASE"
)

func (InvestigateBulkListResponseActionType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkListResponseActionType) IsKnown() bool

type InvestigateBulkListResponseSearchParams ¶ added in v7.7.0 

type InvestigateBulkListResponseSearchParams struct {
	// Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of
	// life: November 1, 2026.
	//
	// Deprecated: Use GET /investigate/{investigate_id}/action_log instead.
	ActionLog bool   `json:"action_log"`
	AlertID   string `json:"alert_id" api:"nullable"`
	// Delivery status of the message.
	DeliveryStatus InvestigateBulkListResponseSearchParamsDeliveryStatus `json:"delivery_status"`
	DetectionsOnly bool                                                  `json:"detections_only"`
	Domain         string                                                `json:"domain" api:"nullable"`
	// End of search date range
	End              time.Time                                               `json:"end" format:"date-time"`
	ExactSubject     string                                                  `json:"exact_subject" api:"nullable"`
	FinalDisposition InvestigateBulkListResponseSearchParamsFinalDisposition `json:"final_disposition"`
	MessageAction    InvestigateBulkListResponseSearchParamsMessageAction    `json:"message_action" api:"nullable"`
	MessageID        string                                                  `json:"message_id" api:"nullable"`
	Metric           string                                                  `json:"metric" api:"nullable"`
	Query            string                                                  `json:"query" api:"nullable"`
	Recipient        string                                                  `json:"recipient" api:"nullable"`
	Sender           string                                                  `json:"sender" api:"nullable"`
	// Beginning of search date range
	Start       time.Time                                   `json:"start" format:"date-time"`
	Subject     string                                      `json:"subject" api:"nullable"`
	Submissions bool                                        `json:"submissions"`
	JSON        investigateBulkListResponseSearchParamsJSON `json:"-"`
}

func (*InvestigateBulkListResponseSearchParams) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkListResponseSearchParams) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkListResponseSearchParamsDeliveryStatus ¶ added in v7.7.0 

type InvestigateBulkListResponseSearchParamsDeliveryStatus string

Delivery status of the message. 

const (
	InvestigateBulkListResponseSearchParamsDeliveryStatusDelivered   InvestigateBulkListResponseSearchParamsDeliveryStatus = "delivered"
	InvestigateBulkListResponseSearchParamsDeliveryStatusMoved       InvestigateBulkListResponseSearchParamsDeliveryStatus = "moved"
	InvestigateBulkListResponseSearchParamsDeliveryStatusQuarantined InvestigateBulkListResponseSearchParamsDeliveryStatus = "quarantined"
	InvestigateBulkListResponseSearchParamsDeliveryStatusRejected    InvestigateBulkListResponseSearchParamsDeliveryStatus = "rejected"
	InvestigateBulkListResponseSearchParamsDeliveryStatusDeferred    InvestigateBulkListResponseSearchParamsDeliveryStatus = "deferred"
	InvestigateBulkListResponseSearchParamsDeliveryStatusBounced     InvestigateBulkListResponseSearchParamsDeliveryStatus = "bounced"
	InvestigateBulkListResponseSearchParamsDeliveryStatusQueued      InvestigateBulkListResponseSearchParamsDeliveryStatus = "queued"
)

func (InvestigateBulkListResponseSearchParamsDeliveryStatus) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkListResponseSearchParamsDeliveryStatus) IsKnown() bool

type InvestigateBulkListResponseSearchParamsFinalDisposition ¶ added in v7.7.0 

type InvestigateBulkListResponseSearchParamsFinalDisposition string
const (
	InvestigateBulkListResponseSearchParamsFinalDispositionMalicious    InvestigateBulkListResponseSearchParamsFinalDisposition = "MALICIOUS"
	InvestigateBulkListResponseSearchParamsFinalDispositionMaliciousBec InvestigateBulkListResponseSearchParamsFinalDisposition = "MALICIOUS-BEC"
	InvestigateBulkListResponseSearchParamsFinalDispositionSuspicious   InvestigateBulkListResponseSearchParamsFinalDisposition = "SUSPICIOUS"
	InvestigateBulkListResponseSearchParamsFinalDispositionSpoof        InvestigateBulkListResponseSearchParamsFinalDisposition = "SPOOF"
	InvestigateBulkListResponseSearchParamsFinalDispositionSpam         InvestigateBulkListResponseSearchParamsFinalDisposition = "SPAM"
	InvestigateBulkListResponseSearchParamsFinalDispositionBulk         InvestigateBulkListResponseSearchParamsFinalDisposition = "BULK"
	InvestigateBulkListResponseSearchParamsFinalDispositionEncrypted    InvestigateBulkListResponseSearchParamsFinalDisposition = "ENCRYPTED"
	InvestigateBulkListResponseSearchParamsFinalDispositionExternal     InvestigateBulkListResponseSearchParamsFinalDisposition = "EXTERNAL"
	InvestigateBulkListResponseSearchParamsFinalDispositionUnknown      InvestigateBulkListResponseSearchParamsFinalDisposition = "UNKNOWN"
	InvestigateBulkListResponseSearchParamsFinalDispositionNone         InvestigateBulkListResponseSearchParamsFinalDisposition = "NONE"
)

func (InvestigateBulkListResponseSearchParamsFinalDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkListResponseSearchParamsFinalDisposition) IsKnown() bool

type InvestigateBulkListResponseSearchParamsMessageAction ¶ added in v7.7.0 

type InvestigateBulkListResponseSearchParamsMessageAction string
const (
	InvestigateBulkListResponseSearchParamsMessageActionPreview            InvestigateBulkListResponseSearchParamsMessageAction = "PREVIEW"
	InvestigateBulkListResponseSearchParamsMessageActionQuarantineReleased InvestigateBulkListResponseSearchParamsMessageAction = "QUARANTINE_RELEASED"
	InvestigateBulkListResponseSearchParamsMessageActionMoved              InvestigateBulkListResponseSearchParamsMessageAction = "MOVED"
)

func (InvestigateBulkListResponseSearchParamsMessageAction) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkListResponseSearchParamsMessageAction) IsKnown() bool

type InvestigateBulkListResponseStatus ¶ added in v7.7.0 

type InvestigateBulkListResponseStatus string
const (
	InvestigateBulkListResponseStatusPending     InvestigateBulkListResponseStatus = "PENDING"
	InvestigateBulkListResponseStatusDiscovering InvestigateBulkListResponseStatus = "DISCOVERING"
	InvestigateBulkListResponseStatusProcessing  InvestigateBulkListResponseStatus = "PROCESSING"
	InvestigateBulkListResponseStatusCompleted   InvestigateBulkListResponseStatus = "COMPLETED"
	InvestigateBulkListResponseStatusFailed      InvestigateBulkListResponseStatus = "FAILED"
	InvestigateBulkListResponseStatusCancelled   InvestigateBulkListResponseStatus = "CANCELLED"
	InvestigateBulkListResponseStatusSkipped     InvestigateBulkListResponseStatus = "SKIPPED"
)

func (InvestigateBulkListResponseStatus) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkListResponseStatus) IsKnown() bool

type InvestigateBulkMessageListParams ¶ added in v7.7.0 

type InvestigateBulkMessageListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Current page within paginated list of results.
	Page param.Field[int64] `query:"page"`
	// The number of results per page. Maximum value is 1000.
	PerPage param.Field[int64]                                  `query:"per_page"`
	Status  param.Field[InvestigateBulkMessageListParamsStatus] `query:"status"`
}

func (InvestigateBulkMessageListParams) URLQuery ¶ added in v7.7.0 

func (r InvestigateBulkMessageListParams) URLQuery() (v url.Values)

URLQuery serializes InvestigateBulkMessageListParams's query parameters as `url.Values`.

type InvestigateBulkMessageListParamsStatus ¶ added in v7.7.0 

type InvestigateBulkMessageListParamsStatus string
const (
	InvestigateBulkMessageListParamsStatusPending     InvestigateBulkMessageListParamsStatus = "PENDING"
	InvestigateBulkMessageListParamsStatusDiscovering InvestigateBulkMessageListParamsStatus = "DISCOVERING"
	InvestigateBulkMessageListParamsStatusProcessing  InvestigateBulkMessageListParamsStatus = "PROCESSING"
	InvestigateBulkMessageListParamsStatusCompleted   InvestigateBulkMessageListParamsStatus = "COMPLETED"
	InvestigateBulkMessageListParamsStatusFailed      InvestigateBulkMessageListParamsStatus = "FAILED"
	InvestigateBulkMessageListParamsStatusCancelled   InvestigateBulkMessageListParamsStatus = "CANCELLED"
	InvestigateBulkMessageListParamsStatusSkipped     InvestigateBulkMessageListParamsStatus = "SKIPPED"
)

func (InvestigateBulkMessageListParamsStatus) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkMessageListParamsStatus) IsKnown() bool

type InvestigateBulkMessageListResponse ¶ added in v7.7.0 

type InvestigateBulkMessageListResponse struct {
	ActionParams   InvestigateBulkMessageListResponseActionParams `json:"action_params" api:"required"`
	ActionType     InvestigateBulkMessageListResponseActionType   `json:"action_type" api:"required"`
	CreatedAt      time.Time                                      `json:"created_at" api:"required" format:"date-time"`
	MessageID      string                                         `json:"message_id" api:"required" format:"uuid"`
	PostfixID      string                                         `json:"postfix_id" api:"required"`
	RetryCount     int64                                          `json:"retry_count" api:"required"`
	Status         InvestigateBulkMessageListResponseStatus       `json:"status" api:"required"`
	AlertID        string                                         `json:"alert_id" api:"nullable"`
	EmailMessageID string                                         `json:"email_message_id" api:"nullable"`
	ProcessedAt    time.Time                                      `json:"processed_at" api:"nullable" format:"date-time"`
	// When to retry the action if it failed
	RetryAfter    time.Time                              `json:"retry_after" api:"nullable" format:"date-time"`
	StatusMessage string                                 `json:"status_message" api:"nullable"`
	JSON          investigateBulkMessageListResponseJSON `json:"-"`
}

func (*InvestigateBulkMessageListResponse) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkMessageListResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkMessageListResponseActionParams ¶ added in v7.7.0 

type InvestigateBulkMessageListResponseActionParams struct {
	ClientRecipient     string                                                            `json:"client_recipient" api:"required"`
	Type                InvestigateBulkMessageListResponseActionParamsType                `json:"type" api:"required"`
	Destination         InvestigateBulkMessageListResponseActionParamsDestination         `json:"destination"`
	ExpectedDisposition InvestigateBulkMessageListResponseActionParamsExpectedDisposition `json:"expected_disposition"`
	JSON                investigateBulkMessageListResponseActionParamsJSON                `json:"-"`
	// contains filtered or unexported fields
}

func (InvestigateBulkMessageListResponseActionParams) AsUnion ¶ added in v7.7.0 

func (r InvestigateBulkMessageListResponseActionParams) AsUnion() InvestigateBulkMessageListResponseActionParamsUnion

AsUnion returns a InvestigateBulkMessageListResponseActionParamsUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are InvestigateBulkMessageListResponseActionParamsMove, InvestigateBulkMessageListResponseActionParamsRelease.

func (*InvestigateBulkMessageListResponseActionParams) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkMessageListResponseActionParams) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkMessageListResponseActionParamsDestination ¶ added in v7.7.0 

type InvestigateBulkMessageListResponseActionParamsDestination string
const (
	InvestigateBulkMessageListResponseActionParamsDestinationInbox                     InvestigateBulkMessageListResponseActionParamsDestination = "Inbox"
	InvestigateBulkMessageListResponseActionParamsDestinationJunkEmail                 InvestigateBulkMessageListResponseActionParamsDestination = "JunkEmail"
	InvestigateBulkMessageListResponseActionParamsDestinationDeletedItems              InvestigateBulkMessageListResponseActionParamsDestination = "DeletedItems"
	InvestigateBulkMessageListResponseActionParamsDestinationRecoverableItemsDeletions InvestigateBulkMessageListResponseActionParamsDestination = "RecoverableItemsDeletions"
	InvestigateBulkMessageListResponseActionParamsDestinationRecoverableItemsPurges    InvestigateBulkMessageListResponseActionParamsDestination = "RecoverableItemsPurges"
)

func (InvestigateBulkMessageListResponseActionParamsDestination) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkMessageListResponseActionParamsDestination) IsKnown() bool

type InvestigateBulkMessageListResponseActionParamsExpectedDisposition ¶ added in v7.7.0 

type InvestigateBulkMessageListResponseActionParamsExpectedDisposition string
const (
	InvestigateBulkMessageListResponseActionParamsExpectedDispositionMalicious    InvestigateBulkMessageListResponseActionParamsExpectedDisposition = "MALICIOUS"
	InvestigateBulkMessageListResponseActionParamsExpectedDispositionMaliciousBec InvestigateBulkMessageListResponseActionParamsExpectedDisposition = "MALICIOUS-BEC"
	InvestigateBulkMessageListResponseActionParamsExpectedDispositionSuspicious   InvestigateBulkMessageListResponseActionParamsExpectedDisposition = "SUSPICIOUS"
	InvestigateBulkMessageListResponseActionParamsExpectedDispositionSpoof        InvestigateBulkMessageListResponseActionParamsExpectedDisposition = "SPOOF"
	InvestigateBulkMessageListResponseActionParamsExpectedDispositionSpam         InvestigateBulkMessageListResponseActionParamsExpectedDisposition = "SPAM"
	InvestigateBulkMessageListResponseActionParamsExpectedDispositionBulk         InvestigateBulkMessageListResponseActionParamsExpectedDisposition = "BULK"
	InvestigateBulkMessageListResponseActionParamsExpectedDispositionEncrypted    InvestigateBulkMessageListResponseActionParamsExpectedDisposition = "ENCRYPTED"
	InvestigateBulkMessageListResponseActionParamsExpectedDispositionExternal     InvestigateBulkMessageListResponseActionParamsExpectedDisposition = "EXTERNAL"
	InvestigateBulkMessageListResponseActionParamsExpectedDispositionUnknown      InvestigateBulkMessageListResponseActionParamsExpectedDisposition = "UNKNOWN"
	InvestigateBulkMessageListResponseActionParamsExpectedDispositionNone         InvestigateBulkMessageListResponseActionParamsExpectedDisposition = "NONE"
)

func (InvestigateBulkMessageListResponseActionParamsExpectedDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkMessageListResponseActionParamsExpectedDisposition) IsKnown() bool

type InvestigateBulkMessageListResponseActionParamsMove ¶ added in v7.7.0 

type InvestigateBulkMessageListResponseActionParamsMove struct {
	ClientRecipient     string                                                                `json:"client_recipient" api:"required"`
	Destination         InvestigateBulkMessageListResponseActionParamsMoveDestination         `json:"destination" api:"required"`
	Type                InvestigateBulkMessageListResponseActionParamsMoveType                `json:"type" api:"required"`
	ExpectedDisposition InvestigateBulkMessageListResponseActionParamsMoveExpectedDisposition `json:"expected_disposition"`
	JSON                investigateBulkMessageListResponseActionParamsMoveJSON                `json:"-"`
}

func (*InvestigateBulkMessageListResponseActionParamsMove) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkMessageListResponseActionParamsMove) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkMessageListResponseActionParamsMoveDestination ¶ added in v7.7.0 

type InvestigateBulkMessageListResponseActionParamsMoveDestination string
const (
	InvestigateBulkMessageListResponseActionParamsMoveDestinationInbox                     InvestigateBulkMessageListResponseActionParamsMoveDestination = "Inbox"
	InvestigateBulkMessageListResponseActionParamsMoveDestinationJunkEmail                 InvestigateBulkMessageListResponseActionParamsMoveDestination = "JunkEmail"
	InvestigateBulkMessageListResponseActionParamsMoveDestinationDeletedItems              InvestigateBulkMessageListResponseActionParamsMoveDestination = "DeletedItems"
	InvestigateBulkMessageListResponseActionParamsMoveDestinationRecoverableItemsDeletions InvestigateBulkMessageListResponseActionParamsMoveDestination = "RecoverableItemsDeletions"
	InvestigateBulkMessageListResponseActionParamsMoveDestinationRecoverableItemsPurges    InvestigateBulkMessageListResponseActionParamsMoveDestination = "RecoverableItemsPurges"
)

func (InvestigateBulkMessageListResponseActionParamsMoveDestination) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkMessageListResponseActionParamsMoveDestination) IsKnown() bool

type InvestigateBulkMessageListResponseActionParamsMoveExpectedDisposition ¶ added in v7.7.0 

type InvestigateBulkMessageListResponseActionParamsMoveExpectedDisposition string
const (
	InvestigateBulkMessageListResponseActionParamsMoveExpectedDispositionMalicious    InvestigateBulkMessageListResponseActionParamsMoveExpectedDisposition = "MALICIOUS"
	InvestigateBulkMessageListResponseActionParamsMoveExpectedDispositionMaliciousBec InvestigateBulkMessageListResponseActionParamsMoveExpectedDisposition = "MALICIOUS-BEC"
	InvestigateBulkMessageListResponseActionParamsMoveExpectedDispositionSuspicious   InvestigateBulkMessageListResponseActionParamsMoveExpectedDisposition = "SUSPICIOUS"
	InvestigateBulkMessageListResponseActionParamsMoveExpectedDispositionSpoof        InvestigateBulkMessageListResponseActionParamsMoveExpectedDisposition = "SPOOF"
	InvestigateBulkMessageListResponseActionParamsMoveExpectedDispositionSpam         InvestigateBulkMessageListResponseActionParamsMoveExpectedDisposition = "SPAM"
	InvestigateBulkMessageListResponseActionParamsMoveExpectedDispositionBulk         InvestigateBulkMessageListResponseActionParamsMoveExpectedDisposition = "BULK"
	InvestigateBulkMessageListResponseActionParamsMoveExpectedDispositionEncrypted    InvestigateBulkMessageListResponseActionParamsMoveExpectedDisposition = "ENCRYPTED"
	InvestigateBulkMessageListResponseActionParamsMoveExpectedDispositionExternal     InvestigateBulkMessageListResponseActionParamsMoveExpectedDisposition = "EXTERNAL"
	InvestigateBulkMessageListResponseActionParamsMoveExpectedDispositionUnknown      InvestigateBulkMessageListResponseActionParamsMoveExpectedDisposition = "UNKNOWN"
	InvestigateBulkMessageListResponseActionParamsMoveExpectedDispositionNone         InvestigateBulkMessageListResponseActionParamsMoveExpectedDisposition = "NONE"
)

func (InvestigateBulkMessageListResponseActionParamsMoveExpectedDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkMessageListResponseActionParamsMoveExpectedDisposition) IsKnown() bool

type InvestigateBulkMessageListResponseActionParamsMoveType ¶ added in v7.7.0 

type InvestigateBulkMessageListResponseActionParamsMoveType string
const (
	InvestigateBulkMessageListResponseActionParamsMoveTypeMove InvestigateBulkMessageListResponseActionParamsMoveType = "MOVE"
)

func (InvestigateBulkMessageListResponseActionParamsMoveType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkMessageListResponseActionParamsMoveType) IsKnown() bool

type InvestigateBulkMessageListResponseActionParamsRelease ¶ added in v7.7.0 

type InvestigateBulkMessageListResponseActionParamsRelease struct {
	ClientRecipient string                                                    `json:"client_recipient" api:"required"`
	Type            InvestigateBulkMessageListResponseActionParamsReleaseType `json:"type" api:"required"`
	JSON            investigateBulkMessageListResponseActionParamsReleaseJSON `json:"-"`
}

func (*InvestigateBulkMessageListResponseActionParamsRelease) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkMessageListResponseActionParamsRelease) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkMessageListResponseActionParamsReleaseType ¶ added in v7.7.0 

type InvestigateBulkMessageListResponseActionParamsReleaseType string
const (
	InvestigateBulkMessageListResponseActionParamsReleaseTypeRelease InvestigateBulkMessageListResponseActionParamsReleaseType = "RELEASE"
)

func (InvestigateBulkMessageListResponseActionParamsReleaseType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkMessageListResponseActionParamsReleaseType) IsKnown() bool

type InvestigateBulkMessageListResponseActionParamsType ¶ added in v7.7.0 

type InvestigateBulkMessageListResponseActionParamsType string
const (
	InvestigateBulkMessageListResponseActionParamsTypeMove    InvestigateBulkMessageListResponseActionParamsType = "MOVE"
	InvestigateBulkMessageListResponseActionParamsTypeRelease InvestigateBulkMessageListResponseActionParamsType = "RELEASE"
)

func (InvestigateBulkMessageListResponseActionParamsType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkMessageListResponseActionParamsType) IsKnown() bool

type InvestigateBulkMessageListResponseActionParamsUnion ¶ added in v7.7.0 

type InvestigateBulkMessageListResponseActionParamsUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by InvestigateBulkMessageListResponseActionParamsMove or InvestigateBulkMessageListResponseActionParamsRelease.

type InvestigateBulkMessageListResponseActionType ¶ added in v7.7.0 

type InvestigateBulkMessageListResponseActionType string
const (
	InvestigateBulkMessageListResponseActionTypeMove    InvestigateBulkMessageListResponseActionType = "MOVE"
	InvestigateBulkMessageListResponseActionTypeRelease InvestigateBulkMessageListResponseActionType = "RELEASE"
)

func (InvestigateBulkMessageListResponseActionType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkMessageListResponseActionType) IsKnown() bool

type InvestigateBulkMessageListResponseStatus ¶ added in v7.7.0 

type InvestigateBulkMessageListResponseStatus string
const (
	InvestigateBulkMessageListResponseStatusPending     InvestigateBulkMessageListResponseStatus = "PENDING"
	InvestigateBulkMessageListResponseStatusDiscovering InvestigateBulkMessageListResponseStatus = "DISCOVERING"
	InvestigateBulkMessageListResponseStatusProcessing  InvestigateBulkMessageListResponseStatus = "PROCESSING"
	InvestigateBulkMessageListResponseStatusCompleted   InvestigateBulkMessageListResponseStatus = "COMPLETED"
	InvestigateBulkMessageListResponseStatusFailed      InvestigateBulkMessageListResponseStatus = "FAILED"
	InvestigateBulkMessageListResponseStatusCancelled   InvestigateBulkMessageListResponseStatus = "CANCELLED"
	InvestigateBulkMessageListResponseStatusSkipped     InvestigateBulkMessageListResponseStatus = "SKIPPED"
)

func (InvestigateBulkMessageListResponseStatus) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkMessageListResponseStatus) IsKnown() bool

type InvestigateBulkMessageService ¶ added in v7.7.0 

type InvestigateBulkMessageService struct {
	Options []option.RequestOption
}

InvestigateBulkMessageService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateBulkMessageService method instead.

func NewInvestigateBulkMessageService ¶ added in v7.7.0 

func NewInvestigateBulkMessageService(opts ...option.RequestOption) (r *InvestigateBulkMessageService)

NewInvestigateBulkMessageService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateBulkMessageService) List ¶ added in v7.7.0 

func (r *InvestigateBulkMessageService) List(ctx context.Context, jobID string, params InvestigateBulkMessageListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[InvestigateBulkMessageListResponse], err error)

List messages for a bulk action job

func (*InvestigateBulkMessageService) ListAutoPaging ¶ added in v7.7.0 

func (r *InvestigateBulkMessageService) ListAutoPaging(ctx context.Context, jobID string, params InvestigateBulkMessageListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[InvestigateBulkMessageListResponse]

List messages for a bulk action job

type InvestigateBulkNewParams ¶ added in v7.7.0 

type InvestigateBulkNewParams struct {
	// Identifier.
	AccountID           param.Field[string]                                      `path:"account_id" api:"required"`
	Action              param.Field[InvestigateBulkNewParamsAction]              `json:"action" api:"required"`
	SearchParams        param.Field[InvestigateBulkNewParamsSearchParams]        `json:"search_params" api:"required"`
	Comment             param.Field[string]                                      `json:"comment"`
	Destination         param.Field[InvestigateBulkNewParamsDestination]         `json:"destination"`
	ExpectedDisposition param.Field[InvestigateBulkNewParamsExpectedDisposition] `json:"expected_disposition"`
}

func (InvestigateBulkNewParams) MarshalJSON ¶ added in v7.7.0 

func (r InvestigateBulkNewParams) MarshalJSON() (data []byte, err error)

type InvestigateBulkNewParamsAction ¶ added in v7.7.0 

type InvestigateBulkNewParamsAction string
const (
	InvestigateBulkNewParamsActionMove    InvestigateBulkNewParamsAction = "MOVE"
	InvestigateBulkNewParamsActionRelease InvestigateBulkNewParamsAction = "RELEASE"
)

func (InvestigateBulkNewParamsAction) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewParamsAction) IsKnown() bool

type InvestigateBulkNewParamsDestination ¶ added in v7.7.0 

type InvestigateBulkNewParamsDestination string
const (
	InvestigateBulkNewParamsDestinationInbox                     InvestigateBulkNewParamsDestination = "Inbox"
	InvestigateBulkNewParamsDestinationJunkEmail                 InvestigateBulkNewParamsDestination = "JunkEmail"
	InvestigateBulkNewParamsDestinationDeletedItems              InvestigateBulkNewParamsDestination = "DeletedItems"
	InvestigateBulkNewParamsDestinationRecoverableItemsDeletions InvestigateBulkNewParamsDestination = "RecoverableItemsDeletions"
	InvestigateBulkNewParamsDestinationRecoverableItemsPurges    InvestigateBulkNewParamsDestination = "RecoverableItemsPurges"
)

func (InvestigateBulkNewParamsDestination) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewParamsDestination) IsKnown() bool

type InvestigateBulkNewParamsExpectedDisposition ¶ added in v7.7.0 

type InvestigateBulkNewParamsExpectedDisposition string
const (
	InvestigateBulkNewParamsExpectedDispositionMalicious    InvestigateBulkNewParamsExpectedDisposition = "MALICIOUS"
	InvestigateBulkNewParamsExpectedDispositionMaliciousBec InvestigateBulkNewParamsExpectedDisposition = "MALICIOUS-BEC"
	InvestigateBulkNewParamsExpectedDispositionSuspicious   InvestigateBulkNewParamsExpectedDisposition = "SUSPICIOUS"
	InvestigateBulkNewParamsExpectedDispositionSpoof        InvestigateBulkNewParamsExpectedDisposition = "SPOOF"
	InvestigateBulkNewParamsExpectedDispositionSpam         InvestigateBulkNewParamsExpectedDisposition = "SPAM"
	InvestigateBulkNewParamsExpectedDispositionBulk         InvestigateBulkNewParamsExpectedDisposition = "BULK"
	InvestigateBulkNewParamsExpectedDispositionEncrypted    InvestigateBulkNewParamsExpectedDisposition = "ENCRYPTED"
	InvestigateBulkNewParamsExpectedDispositionExternal     InvestigateBulkNewParamsExpectedDisposition = "EXTERNAL"
	InvestigateBulkNewParamsExpectedDispositionUnknown      InvestigateBulkNewParamsExpectedDisposition = "UNKNOWN"
	InvestigateBulkNewParamsExpectedDispositionNone         InvestigateBulkNewParamsExpectedDisposition = "NONE"
)

func (InvestigateBulkNewParamsExpectedDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewParamsExpectedDisposition) IsKnown() bool

type InvestigateBulkNewParamsSearchParams ¶ added in v7.7.0 

type InvestigateBulkNewParamsSearchParams struct {
	// Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of
	// life: November 1, 2026.
	//
	// Deprecated: Use GET /investigate/{investigate_id}/action_log instead.
	ActionLog param.Field[bool]   `json:"action_log"`
	AlertID   param.Field[string] `json:"alert_id"`
	// Delivery status of the message.
	DeliveryStatus param.Field[InvestigateBulkNewParamsSearchParamsDeliveryStatus] `json:"delivery_status"`
	DetectionsOnly param.Field[bool]                                               `json:"detections_only"`
	Domain         param.Field[string]                                             `json:"domain"`
	// End of search date range
	End              param.Field[time.Time]                                            `json:"end" format:"date-time"`
	ExactSubject     param.Field[string]                                               `json:"exact_subject"`
	FinalDisposition param.Field[InvestigateBulkNewParamsSearchParamsFinalDisposition] `json:"final_disposition"`
	MessageAction    param.Field[InvestigateBulkNewParamsSearchParamsMessageAction]    `json:"message_action"`
	MessageID        param.Field[string]                                               `json:"message_id"`
	Metric           param.Field[string]                                               `json:"metric"`
	Query            param.Field[string]                                               `json:"query"`
	Recipient        param.Field[string]                                               `json:"recipient"`
	Sender           param.Field[string]                                               `json:"sender"`
	// Beginning of search date range
	Start       param.Field[time.Time] `json:"start" format:"date-time"`
	Subject     param.Field[string]    `json:"subject"`
	Submissions param.Field[bool]      `json:"submissions"`
}

func (InvestigateBulkNewParamsSearchParams) MarshalJSON ¶ added in v7.7.0 

func (r InvestigateBulkNewParamsSearchParams) MarshalJSON() (data []byte, err error)

type InvestigateBulkNewParamsSearchParamsDeliveryStatus ¶ added in v7.7.0 

type InvestigateBulkNewParamsSearchParamsDeliveryStatus string

Delivery status of the message. 

const (
	InvestigateBulkNewParamsSearchParamsDeliveryStatusDelivered   InvestigateBulkNewParamsSearchParamsDeliveryStatus = "delivered"
	InvestigateBulkNewParamsSearchParamsDeliveryStatusMoved       InvestigateBulkNewParamsSearchParamsDeliveryStatus = "moved"
	InvestigateBulkNewParamsSearchParamsDeliveryStatusQuarantined InvestigateBulkNewParamsSearchParamsDeliveryStatus = "quarantined"
	InvestigateBulkNewParamsSearchParamsDeliveryStatusRejected    InvestigateBulkNewParamsSearchParamsDeliveryStatus = "rejected"
	InvestigateBulkNewParamsSearchParamsDeliveryStatusDeferred    InvestigateBulkNewParamsSearchParamsDeliveryStatus = "deferred"
	InvestigateBulkNewParamsSearchParamsDeliveryStatusBounced     InvestigateBulkNewParamsSearchParamsDeliveryStatus = "bounced"
	InvestigateBulkNewParamsSearchParamsDeliveryStatusQueued      InvestigateBulkNewParamsSearchParamsDeliveryStatus = "queued"
)

func (InvestigateBulkNewParamsSearchParamsDeliveryStatus) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewParamsSearchParamsDeliveryStatus) IsKnown() bool

type InvestigateBulkNewParamsSearchParamsFinalDisposition ¶ added in v7.7.0 

type InvestigateBulkNewParamsSearchParamsFinalDisposition string
const (
	InvestigateBulkNewParamsSearchParamsFinalDispositionMalicious    InvestigateBulkNewParamsSearchParamsFinalDisposition = "MALICIOUS"
	InvestigateBulkNewParamsSearchParamsFinalDispositionMaliciousBec InvestigateBulkNewParamsSearchParamsFinalDisposition = "MALICIOUS-BEC"
	InvestigateBulkNewParamsSearchParamsFinalDispositionSuspicious   InvestigateBulkNewParamsSearchParamsFinalDisposition = "SUSPICIOUS"
	InvestigateBulkNewParamsSearchParamsFinalDispositionSpoof        InvestigateBulkNewParamsSearchParamsFinalDisposition = "SPOOF"
	InvestigateBulkNewParamsSearchParamsFinalDispositionSpam         InvestigateBulkNewParamsSearchParamsFinalDisposition = "SPAM"
	InvestigateBulkNewParamsSearchParamsFinalDispositionBulk         InvestigateBulkNewParamsSearchParamsFinalDisposition = "BULK"
	InvestigateBulkNewParamsSearchParamsFinalDispositionEncrypted    InvestigateBulkNewParamsSearchParamsFinalDisposition = "ENCRYPTED"
	InvestigateBulkNewParamsSearchParamsFinalDispositionExternal     InvestigateBulkNewParamsSearchParamsFinalDisposition = "EXTERNAL"
	InvestigateBulkNewParamsSearchParamsFinalDispositionUnknown      InvestigateBulkNewParamsSearchParamsFinalDisposition = "UNKNOWN"
	InvestigateBulkNewParamsSearchParamsFinalDispositionNone         InvestigateBulkNewParamsSearchParamsFinalDisposition = "NONE"
)

func (InvestigateBulkNewParamsSearchParamsFinalDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewParamsSearchParamsFinalDisposition) IsKnown() bool

type InvestigateBulkNewParamsSearchParamsMessageAction ¶ added in v7.7.0 

type InvestigateBulkNewParamsSearchParamsMessageAction string
const (
	InvestigateBulkNewParamsSearchParamsMessageActionPreview            InvestigateBulkNewParamsSearchParamsMessageAction = "PREVIEW"
	InvestigateBulkNewParamsSearchParamsMessageActionQuarantineReleased InvestigateBulkNewParamsSearchParamsMessageAction = "QUARANTINE_RELEASED"
	InvestigateBulkNewParamsSearchParamsMessageActionMoved              InvestigateBulkNewParamsSearchParamsMessageAction = "MOVED"
)

func (InvestigateBulkNewParamsSearchParamsMessageAction) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewParamsSearchParamsMessageAction) IsKnown() bool

type InvestigateBulkNewResponse ¶ added in v7.7.0 

type InvestigateBulkNewResponse struct {
	ActionParams            InvestigateBulkNewResponseActionParams `json:"action_params" api:"required"`
	ActionType              InvestigateBulkNewResponseActionType   `json:"action_type" api:"required"`
	CreatedAt               time.Time                              `json:"created_at" api:"required" format:"date-time"`
	JobID                   string                                 `json:"job_id" api:"required" format:"uuid"`
	MessagesFailed          int64                                  `json:"messages_failed" api:"required"`
	MessagesPending         int64                                  `json:"messages_pending" api:"required"`
	MessagesSuccessful      int64                                  `json:"messages_successful" api:"required"`
	SearchParams            InvestigateBulkNewResponseSearchParams `json:"search_params" api:"required"`
	Status                  InvestigateBulkNewResponseStatus       `json:"status" api:"required"`
	TotalMessagesDiscovered int64                                  `json:"total_messages_discovered" api:"required"`
	Comment                 string                                 `json:"comment" api:"nullable"`
	CompletedAt             time.Time                              `json:"completed_at" api:"nullable" format:"date-time"`
	StartedAt               time.Time                              `json:"started_at" api:"nullable" format:"date-time"`
	StatusMessage           string                                 `json:"status_message" api:"nullable"`
	JSON                    investigateBulkNewResponseJSON         `json:"-"`
}

func (*InvestigateBulkNewResponse) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkNewResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkNewResponseActionParams ¶ added in v7.7.0 

type InvestigateBulkNewResponseActionParams struct {
	Type                InvestigateBulkNewResponseActionParamsType                `json:"type" api:"required"`
	Destination         InvestigateBulkNewResponseActionParamsDestination         `json:"destination"`
	ExpectedDisposition InvestigateBulkNewResponseActionParamsExpectedDisposition `json:"expected_disposition"`
	JSON                investigateBulkNewResponseActionParamsJSON                `json:"-"`
	// contains filtered or unexported fields
}

func (InvestigateBulkNewResponseActionParams) AsUnion ¶ added in v7.7.0 

func (r InvestigateBulkNewResponseActionParams) AsUnion() InvestigateBulkNewResponseActionParamsUnion

AsUnion returns a InvestigateBulkNewResponseActionParamsUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are InvestigateBulkNewResponseActionParamsMove, InvestigateBulkNewResponseActionParamsRelease.

func (*InvestigateBulkNewResponseActionParams) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkNewResponseActionParams) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkNewResponseActionParamsDestination ¶ added in v7.7.0 

type InvestigateBulkNewResponseActionParamsDestination string
const (
	InvestigateBulkNewResponseActionParamsDestinationInbox                     InvestigateBulkNewResponseActionParamsDestination = "Inbox"
	InvestigateBulkNewResponseActionParamsDestinationJunkEmail                 InvestigateBulkNewResponseActionParamsDestination = "JunkEmail"
	InvestigateBulkNewResponseActionParamsDestinationDeletedItems              InvestigateBulkNewResponseActionParamsDestination = "DeletedItems"
	InvestigateBulkNewResponseActionParamsDestinationRecoverableItemsDeletions InvestigateBulkNewResponseActionParamsDestination = "RecoverableItemsDeletions"
	InvestigateBulkNewResponseActionParamsDestinationRecoverableItemsPurges    InvestigateBulkNewResponseActionParamsDestination = "RecoverableItemsPurges"
)

func (InvestigateBulkNewResponseActionParamsDestination) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewResponseActionParamsDestination) IsKnown() bool

type InvestigateBulkNewResponseActionParamsExpectedDisposition ¶ added in v7.7.0 

type InvestigateBulkNewResponseActionParamsExpectedDisposition string
const (
	InvestigateBulkNewResponseActionParamsExpectedDispositionMalicious    InvestigateBulkNewResponseActionParamsExpectedDisposition = "MALICIOUS"
	InvestigateBulkNewResponseActionParamsExpectedDispositionMaliciousBec InvestigateBulkNewResponseActionParamsExpectedDisposition = "MALICIOUS-BEC"
	InvestigateBulkNewResponseActionParamsExpectedDispositionSuspicious   InvestigateBulkNewResponseActionParamsExpectedDisposition = "SUSPICIOUS"
	InvestigateBulkNewResponseActionParamsExpectedDispositionSpoof        InvestigateBulkNewResponseActionParamsExpectedDisposition = "SPOOF"
	InvestigateBulkNewResponseActionParamsExpectedDispositionSpam         InvestigateBulkNewResponseActionParamsExpectedDisposition = "SPAM"
	InvestigateBulkNewResponseActionParamsExpectedDispositionBulk         InvestigateBulkNewResponseActionParamsExpectedDisposition = "BULK"
	InvestigateBulkNewResponseActionParamsExpectedDispositionEncrypted    InvestigateBulkNewResponseActionParamsExpectedDisposition = "ENCRYPTED"
	InvestigateBulkNewResponseActionParamsExpectedDispositionExternal     InvestigateBulkNewResponseActionParamsExpectedDisposition = "EXTERNAL"
	InvestigateBulkNewResponseActionParamsExpectedDispositionUnknown      InvestigateBulkNewResponseActionParamsExpectedDisposition = "UNKNOWN"
	InvestigateBulkNewResponseActionParamsExpectedDispositionNone         InvestigateBulkNewResponseActionParamsExpectedDisposition = "NONE"
)

func (InvestigateBulkNewResponseActionParamsExpectedDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewResponseActionParamsExpectedDisposition) IsKnown() bool

type InvestigateBulkNewResponseActionParamsMove ¶ added in v7.7.0 

type InvestigateBulkNewResponseActionParamsMove struct {
	Destination         InvestigateBulkNewResponseActionParamsMoveDestination         `json:"destination" api:"required"`
	Type                InvestigateBulkNewResponseActionParamsMoveType                `json:"type" api:"required"`
	ExpectedDisposition InvestigateBulkNewResponseActionParamsMoveExpectedDisposition `json:"expected_disposition"`
	JSON                investigateBulkNewResponseActionParamsMoveJSON                `json:"-"`
}

func (*InvestigateBulkNewResponseActionParamsMove) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkNewResponseActionParamsMove) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkNewResponseActionParamsMoveDestination ¶ added in v7.7.0 

type InvestigateBulkNewResponseActionParamsMoveDestination string
const (
	InvestigateBulkNewResponseActionParamsMoveDestinationInbox                     InvestigateBulkNewResponseActionParamsMoveDestination = "Inbox"
	InvestigateBulkNewResponseActionParamsMoveDestinationJunkEmail                 InvestigateBulkNewResponseActionParamsMoveDestination = "JunkEmail"
	InvestigateBulkNewResponseActionParamsMoveDestinationDeletedItems              InvestigateBulkNewResponseActionParamsMoveDestination = "DeletedItems"
	InvestigateBulkNewResponseActionParamsMoveDestinationRecoverableItemsDeletions InvestigateBulkNewResponseActionParamsMoveDestination = "RecoverableItemsDeletions"
	InvestigateBulkNewResponseActionParamsMoveDestinationRecoverableItemsPurges    InvestigateBulkNewResponseActionParamsMoveDestination = "RecoverableItemsPurges"
)

func (InvestigateBulkNewResponseActionParamsMoveDestination) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewResponseActionParamsMoveDestination) IsKnown() bool

type InvestigateBulkNewResponseActionParamsMoveExpectedDisposition ¶ added in v7.7.0 

type InvestigateBulkNewResponseActionParamsMoveExpectedDisposition string
const (
	InvestigateBulkNewResponseActionParamsMoveExpectedDispositionMalicious    InvestigateBulkNewResponseActionParamsMoveExpectedDisposition = "MALICIOUS"
	InvestigateBulkNewResponseActionParamsMoveExpectedDispositionMaliciousBec InvestigateBulkNewResponseActionParamsMoveExpectedDisposition = "MALICIOUS-BEC"
	InvestigateBulkNewResponseActionParamsMoveExpectedDispositionSuspicious   InvestigateBulkNewResponseActionParamsMoveExpectedDisposition = "SUSPICIOUS"
	InvestigateBulkNewResponseActionParamsMoveExpectedDispositionSpoof        InvestigateBulkNewResponseActionParamsMoveExpectedDisposition = "SPOOF"
	InvestigateBulkNewResponseActionParamsMoveExpectedDispositionSpam         InvestigateBulkNewResponseActionParamsMoveExpectedDisposition = "SPAM"
	InvestigateBulkNewResponseActionParamsMoveExpectedDispositionBulk         InvestigateBulkNewResponseActionParamsMoveExpectedDisposition = "BULK"
	InvestigateBulkNewResponseActionParamsMoveExpectedDispositionEncrypted    InvestigateBulkNewResponseActionParamsMoveExpectedDisposition = "ENCRYPTED"
	InvestigateBulkNewResponseActionParamsMoveExpectedDispositionExternal     InvestigateBulkNewResponseActionParamsMoveExpectedDisposition = "EXTERNAL"
	InvestigateBulkNewResponseActionParamsMoveExpectedDispositionUnknown      InvestigateBulkNewResponseActionParamsMoveExpectedDisposition = "UNKNOWN"
	InvestigateBulkNewResponseActionParamsMoveExpectedDispositionNone         InvestigateBulkNewResponseActionParamsMoveExpectedDisposition = "NONE"
)

func (InvestigateBulkNewResponseActionParamsMoveExpectedDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewResponseActionParamsMoveExpectedDisposition) IsKnown() bool

type InvestigateBulkNewResponseActionParamsMoveType ¶ added in v7.7.0 

type InvestigateBulkNewResponseActionParamsMoveType string
const (
	InvestigateBulkNewResponseActionParamsMoveTypeMove InvestigateBulkNewResponseActionParamsMoveType = "MOVE"
)

func (InvestigateBulkNewResponseActionParamsMoveType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewResponseActionParamsMoveType) IsKnown() bool

type InvestigateBulkNewResponseActionParamsRelease ¶ added in v7.7.0 

type InvestigateBulkNewResponseActionParamsRelease struct {
	Type InvestigateBulkNewResponseActionParamsReleaseType `json:"type" api:"required"`
	JSON investigateBulkNewResponseActionParamsReleaseJSON `json:"-"`
}

func (*InvestigateBulkNewResponseActionParamsRelease) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkNewResponseActionParamsRelease) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkNewResponseActionParamsReleaseType ¶ added in v7.7.0 

type InvestigateBulkNewResponseActionParamsReleaseType string
const (
	InvestigateBulkNewResponseActionParamsReleaseTypeRelease InvestigateBulkNewResponseActionParamsReleaseType = "RELEASE"
)

func (InvestigateBulkNewResponseActionParamsReleaseType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewResponseActionParamsReleaseType) IsKnown() bool

type InvestigateBulkNewResponseActionParamsType ¶ added in v7.7.0 

type InvestigateBulkNewResponseActionParamsType string
const (
	InvestigateBulkNewResponseActionParamsTypeMove    InvestigateBulkNewResponseActionParamsType = "MOVE"
	InvestigateBulkNewResponseActionParamsTypeRelease InvestigateBulkNewResponseActionParamsType = "RELEASE"
)

func (InvestigateBulkNewResponseActionParamsType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewResponseActionParamsType) IsKnown() bool

type InvestigateBulkNewResponseActionParamsUnion ¶ added in v7.7.0 

type InvestigateBulkNewResponseActionParamsUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by InvestigateBulkNewResponseActionParamsMove or InvestigateBulkNewResponseActionParamsRelease.

type InvestigateBulkNewResponseActionType ¶ added in v7.7.0 

type InvestigateBulkNewResponseActionType string
const (
	InvestigateBulkNewResponseActionTypeMove    InvestigateBulkNewResponseActionType = "MOVE"
	InvestigateBulkNewResponseActionTypeRelease InvestigateBulkNewResponseActionType = "RELEASE"
)

func (InvestigateBulkNewResponseActionType) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewResponseActionType) IsKnown() bool

type InvestigateBulkNewResponseEnvelope ¶ added in v7.7.0 

type InvestigateBulkNewResponseEnvelope struct {
	Errors   []InvestigateBulkNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []InvestigateBulkNewResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   InvestigateBulkNewResponse                   `json:"result" api:"required"`
	// Whether the API call was successful.
	Success InvestigateBulkNewResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    investigateBulkNewResponseEnvelopeJSON    `json:"-"`
}

func (*InvestigateBulkNewResponseEnvelope) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkNewResponseEnvelopeErrors ¶ added in v7.7.0 

type InvestigateBulkNewResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code" api:"required"`
	Message          string                                         `json:"message" api:"required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           InvestigateBulkNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             investigateBulkNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*InvestigateBulkNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkNewResponseEnvelopeErrorsSource ¶ added in v7.7.0 

type InvestigateBulkNewResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    investigateBulkNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*InvestigateBulkNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkNewResponseEnvelopeMessages ¶ added in v7.7.0 

type InvestigateBulkNewResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code" api:"required"`
	Message          string                                           `json:"message" api:"required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           InvestigateBulkNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             investigateBulkNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*InvestigateBulkNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkNewResponseEnvelopeMessagesSource ¶ added in v7.7.0 

type InvestigateBulkNewResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    investigateBulkNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*InvestigateBulkNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkNewResponseEnvelopeSuccess ¶ added in v7.7.0 

type InvestigateBulkNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	InvestigateBulkNewResponseEnvelopeSuccessTrue InvestigateBulkNewResponseEnvelopeSuccess = true
)

func (InvestigateBulkNewResponseEnvelopeSuccess) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewResponseEnvelopeSuccess) IsKnown() bool

type InvestigateBulkNewResponseSearchParams ¶ added in v7.7.0 

type InvestigateBulkNewResponseSearchParams struct {
	// Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of
	// life: November 1, 2026.
	//
	// Deprecated: Use GET /investigate/{investigate_id}/action_log instead.
	ActionLog bool   `json:"action_log"`
	AlertID   string `json:"alert_id" api:"nullable"`
	// Delivery status of the message.
	DeliveryStatus InvestigateBulkNewResponseSearchParamsDeliveryStatus `json:"delivery_status"`
	DetectionsOnly bool                                                 `json:"detections_only"`
	Domain         string                                               `json:"domain" api:"nullable"`
	// End of search date range
	End              time.Time                                              `json:"end" format:"date-time"`
	ExactSubject     string                                                 `json:"exact_subject" api:"nullable"`
	FinalDisposition InvestigateBulkNewResponseSearchParamsFinalDisposition `json:"final_disposition"`
	MessageAction    InvestigateBulkNewResponseSearchParamsMessageAction    `json:"message_action" api:"nullable"`
	MessageID        string                                                 `json:"message_id" api:"nullable"`
	Metric           string                                                 `json:"metric" api:"nullable"`
	Query            string                                                 `json:"query" api:"nullable"`
	Recipient        string                                                 `json:"recipient" api:"nullable"`
	Sender           string                                                 `json:"sender" api:"nullable"`
	// Beginning of search date range
	Start       time.Time                                  `json:"start" format:"date-time"`
	Subject     string                                     `json:"subject" api:"nullable"`
	Submissions bool                                       `json:"submissions"`
	JSON        investigateBulkNewResponseSearchParamsJSON `json:"-"`
}

func (*InvestigateBulkNewResponseSearchParams) UnmarshalJSON ¶ added in v7.7.0 

func (r *InvestigateBulkNewResponseSearchParams) UnmarshalJSON(data []byte) (err error)

type InvestigateBulkNewResponseSearchParamsDeliveryStatus ¶ added in v7.7.0 

type InvestigateBulkNewResponseSearchParamsDeliveryStatus string

Delivery status of the message. 

const (
	InvestigateBulkNewResponseSearchParamsDeliveryStatusDelivered   InvestigateBulkNewResponseSearchParamsDeliveryStatus = "delivered"
	InvestigateBulkNewResponseSearchParamsDeliveryStatusMoved       InvestigateBulkNewResponseSearchParamsDeliveryStatus = "moved"
	InvestigateBulkNewResponseSearchParamsDeliveryStatusQuarantined InvestigateBulkNewResponseSearchParamsDeliveryStatus = "quarantined"
	InvestigateBulkNewResponseSearchParamsDeliveryStatusRejected    InvestigateBulkNewResponseSearchParamsDeliveryStatus = "rejected"
	InvestigateBulkNewResponseSearchParamsDeliveryStatusDeferred    InvestigateBulkNewResponseSearchParamsDeliveryStatus = "deferred"
	InvestigateBulkNewResponseSearchParamsDeliveryStatusBounced     InvestigateBulkNewResponseSearchParamsDeliveryStatus = "bounced"
	InvestigateBulkNewResponseSearchParamsDeliveryStatusQueued      InvestigateBulkNewResponseSearchParamsDeliveryStatus = "queued"
)

func (InvestigateBulkNewResponseSearchParamsDeliveryStatus) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewResponseSearchParamsDeliveryStatus) IsKnown() bool

type InvestigateBulkNewResponseSearchParamsFinalDisposition ¶ added in v7.7.0 

type InvestigateBulkNewResponseSearchParamsFinalDisposition string
const (
	InvestigateBulkNewResponseSearchParamsFinalDispositionMalicious    InvestigateBulkNewResponseSearchParamsFinalDisposition = "MALICIOUS"
	InvestigateBulkNewResponseSearchParamsFinalDispositionMaliciousBec InvestigateBulkNewResponseSearchParamsFinalDisposition = "MALICIOUS-BEC"
	InvestigateBulkNewResponseSearchParamsFinalDispositionSuspicious   InvestigateBulkNewResponseSearchParamsFinalDisposition = "SUSPICIOUS"
	InvestigateBulkNewResponseSearchParamsFinalDispositionSpoof        InvestigateBulkNewResponseSearchParamsFinalDisposition = "SPOOF"
	InvestigateBulkNewResponseSearchParamsFinalDispositionSpam         InvestigateBulkNewResponseSearchParamsFinalDisposition = "SPAM"
	InvestigateBulkNewResponseSearchParamsFinalDispositionBulk         InvestigateBulkNewResponseSearchParamsFinalDisposition = "BULK"
	InvestigateBulkNewResponseSearchParamsFinalDispositionEncrypted    InvestigateBulkNewResponseSearchParamsFinalDisposition = "ENCRYPTED"
	InvestigateBulkNewResponseSearchParamsFinalDispositionExternal     InvestigateBulkNewResponseSearchParamsFinalDisposition = "EXTERNAL"
	InvestigateBulkNewResponseSearchParamsFinalDispositionUnknown      InvestigateBulkNewResponseSearchParamsFinalDisposition = "UNKNOWN"
	InvestigateBulkNewResponseSearchParamsFinalDispositionNone         InvestigateBulkNewResponseSearchParamsFinalDisposition = "NONE"
)

func (InvestigateBulkNewResponseSearchParamsFinalDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewResponseSearchParamsFinalDisposition) IsKnown() bool

type InvestigateBulkNewResponseSearchParamsMessageAction ¶ added in v7.7.0 

type InvestigateBulkNewResponseSearchParamsMessageAction string
const (
	InvestigateBulkNewResponseSearchParamsMessageActionPreview            InvestigateBulkNewResponseSearchParamsMessageAction = "PREVIEW"
	InvestigateBulkNewResponseSearchParamsMessageActionQuarantineReleased InvestigateBulkNewResponseSearchParamsMessageAction = "QUARANTINE_RELEASED"
	InvestigateBulkNewResponseSearchParamsMessageActionMoved              InvestigateBulkNewResponseSearchParamsMessageAction = "MOVED"
)

func (InvestigateBulkNewResponseSearchParamsMessageAction) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewResponseSearchParamsMessageAction) IsKnown() bool

type InvestigateBulkNewResponseStatus ¶ added in v7.7.0 

type InvestigateBulkNewResponseStatus string
const (
	InvestigateBulkNewResponseStatusPending     InvestigateBulkNewResponseStatus = "PENDING"
	InvestigateBulkNewResponseStatusDiscovering InvestigateBulkNewResponseStatus = "DISCOVERING"
	InvestigateBulkNewResponseStatusProcessing  InvestigateBulkNewResponseStatus = "PROCESSING"
	InvestigateBulkNewResponseStatusCompleted   InvestigateBulkNewResponseStatus = "COMPLETED"
	InvestigateBulkNewResponseStatusFailed      InvestigateBulkNewResponseStatus = "FAILED"
	InvestigateBulkNewResponseStatusCancelled   InvestigateBulkNewResponseStatus = "CANCELLED"
	InvestigateBulkNewResponseStatusSkipped     InvestigateBulkNewResponseStatus = "SKIPPED"
)

func (InvestigateBulkNewResponseStatus) IsKnown ¶ added in v7.7.0 

func (r InvestigateBulkNewResponseStatus) IsKnown() bool

type InvestigateBulkService ¶ added in v7.7.0 

type InvestigateBulkService struct {
	Options  []option.RequestOption
	Cancel   *InvestigateBulkCancelService
	Messages *InvestigateBulkMessageService
}

InvestigateBulkService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateBulkService method instead.

func NewInvestigateBulkService ¶ added in v7.7.0 

func NewInvestigateBulkService(opts ...option.RequestOption) (r *InvestigateBulkService)

NewInvestigateBulkService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateBulkService) Delete ¶ added in v7.7.0 

func (r *InvestigateBulkService) Delete(ctx context.Context, jobID string, body InvestigateBulkDeleteParams, opts ...option.RequestOption) (res *InvestigateBulkDeleteResponse, err error)

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.

func (*InvestigateBulkService) Get ¶ added in v7.7.0 

func (r *InvestigateBulkService) Get(ctx context.Context, jobID string, query InvestigateBulkGetParams, opts ...option.RequestOption) (res *InvestigateBulkGetResponse, err error)

Get bulk action job details

func (*InvestigateBulkService) List ¶ added in v7.7.0 

func (r *InvestigateBulkService) List(ctx context.Context, params InvestigateBulkListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[InvestigateBulkListResponse], err error)

List bulk action jobs

func (*InvestigateBulkService) ListAutoPaging ¶ added in v7.7.0 

func (r *InvestigateBulkService) ListAutoPaging(ctx context.Context, params InvestigateBulkListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[InvestigateBulkListResponse]

List bulk action jobs

func (*InvestigateBulkService) New ¶ added in v7.7.0 

func (r *InvestigateBulkService) New(ctx context.Context, params InvestigateBulkNewParams, opts ...option.RequestOption) (res *InvestigateBulkNewResponse, err error)

Create a bulk action job

type InvestigateDetectionGetParams ¶ 

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

type InvestigateDetectionGetResponse ¶ 

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:"-"`
}

func (*InvestigateDetectionGetResponse) UnmarshalJSON ¶ 

func (r *InvestigateDetectionGetResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseAttachment ¶ 

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:"-"`
}

func (*InvestigateDetectionGetResponseAttachment) UnmarshalJSON ¶ 

func (r *InvestigateDetectionGetResponseAttachment) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseAttachmentsDetection ¶ 

type InvestigateDetectionGetResponseAttachmentsDetection string

Detection result for this attachment 

const (
	InvestigateDetectionGetResponseAttachmentsDetectionMalicious    InvestigateDetectionGetResponseAttachmentsDetection = "MALICIOUS"
	InvestigateDetectionGetResponseAttachmentsDetectionMaliciousBec InvestigateDetectionGetResponseAttachmentsDetection = "MALICIOUS-BEC"
	InvestigateDetectionGetResponseAttachmentsDetectionSuspicious   InvestigateDetectionGetResponseAttachmentsDetection = "SUSPICIOUS"
	InvestigateDetectionGetResponseAttachmentsDetectionSpoof        InvestigateDetectionGetResponseAttachmentsDetection = "SPOOF"
	InvestigateDetectionGetResponseAttachmentsDetectionSpam         InvestigateDetectionGetResponseAttachmentsDetection = "SPAM"
	InvestigateDetectionGetResponseAttachmentsDetectionBulk         InvestigateDetectionGetResponseAttachmentsDetection = "BULK"
	InvestigateDetectionGetResponseAttachmentsDetectionEncrypted    InvestigateDetectionGetResponseAttachmentsDetection = "ENCRYPTED"
	InvestigateDetectionGetResponseAttachmentsDetectionExternal     InvestigateDetectionGetResponseAttachmentsDetection = "EXTERNAL"
	InvestigateDetectionGetResponseAttachmentsDetectionUnknown      InvestigateDetectionGetResponseAttachmentsDetection = "UNKNOWN"
	InvestigateDetectionGetResponseAttachmentsDetectionNone         InvestigateDetectionGetResponseAttachmentsDetection = "NONE"
)

func (InvestigateDetectionGetResponseAttachmentsDetection) IsKnown ¶ 

func (r InvestigateDetectionGetResponseAttachmentsDetection) IsKnown() bool

type InvestigateDetectionGetResponseEnvelope ¶ 

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:"-"`
}

func (*InvestigateDetectionGetResponseEnvelope) UnmarshalJSON ¶ 

func (r *InvestigateDetectionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseEnvelopeErrors ¶ 

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:"-"`
}

func (*InvestigateDetectionGetResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *InvestigateDetectionGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseEnvelopeErrorsSource ¶ 

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

func (*InvestigateDetectionGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *InvestigateDetectionGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseEnvelopeMessages ¶ 

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:"-"`
}

func (*InvestigateDetectionGetResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *InvestigateDetectionGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseEnvelopeMessagesSource ¶ 

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

func (*InvestigateDetectionGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *InvestigateDetectionGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseEnvelopeSuccess ¶ 

type InvestigateDetectionGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	InvestigateDetectionGetResponseEnvelopeSuccessTrue InvestigateDetectionGetResponseEnvelopeSuccess = true
)

func (InvestigateDetectionGetResponseEnvelopeSuccess) IsKnown ¶ 

func (r InvestigateDetectionGetResponseEnvelopeSuccess) IsKnown() bool

type InvestigateDetectionGetResponseFinalDisposition ¶ 

type InvestigateDetectionGetResponseFinalDisposition string
const (
	InvestigateDetectionGetResponseFinalDispositionMalicious    InvestigateDetectionGetResponseFinalDisposition = "MALICIOUS"
	InvestigateDetectionGetResponseFinalDispositionMaliciousBec InvestigateDetectionGetResponseFinalDisposition = "MALICIOUS-BEC"
	InvestigateDetectionGetResponseFinalDispositionSuspicious   InvestigateDetectionGetResponseFinalDisposition = "SUSPICIOUS"
	InvestigateDetectionGetResponseFinalDispositionSpoof        InvestigateDetectionGetResponseFinalDisposition = "SPOOF"
	InvestigateDetectionGetResponseFinalDispositionSpam         InvestigateDetectionGetResponseFinalDisposition = "SPAM"
	InvestigateDetectionGetResponseFinalDispositionBulk         InvestigateDetectionGetResponseFinalDisposition = "BULK"
	InvestigateDetectionGetResponseFinalDispositionEncrypted    InvestigateDetectionGetResponseFinalDisposition = "ENCRYPTED"
	InvestigateDetectionGetResponseFinalDispositionExternal     InvestigateDetectionGetResponseFinalDisposition = "EXTERNAL"
	InvestigateDetectionGetResponseFinalDispositionUnknown      InvestigateDetectionGetResponseFinalDisposition = "UNKNOWN"
	InvestigateDetectionGetResponseFinalDispositionNone         InvestigateDetectionGetResponseFinalDisposition = "NONE"
)

func (InvestigateDetectionGetResponseFinalDisposition) IsKnown ¶ 

func (r InvestigateDetectionGetResponseFinalDisposition) IsKnown() bool

type InvestigateDetectionGetResponseFinding ¶ 

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:"-"`
}

func (*InvestigateDetectionGetResponseFinding) UnmarshalJSON ¶ 

func (r *InvestigateDetectionGetResponseFinding) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseFindingsDetection ¶ 

type InvestigateDetectionGetResponseFindingsDetection string
const (
	InvestigateDetectionGetResponseFindingsDetectionMalicious    InvestigateDetectionGetResponseFindingsDetection = "MALICIOUS"
	InvestigateDetectionGetResponseFindingsDetectionMaliciousBec InvestigateDetectionGetResponseFindingsDetection = "MALICIOUS-BEC"
	InvestigateDetectionGetResponseFindingsDetectionSuspicious   InvestigateDetectionGetResponseFindingsDetection = "SUSPICIOUS"
	InvestigateDetectionGetResponseFindingsDetectionSpoof        InvestigateDetectionGetResponseFindingsDetection = "SPOOF"
	InvestigateDetectionGetResponseFindingsDetectionSpam         InvestigateDetectionGetResponseFindingsDetection = "SPAM"
	InvestigateDetectionGetResponseFindingsDetectionBulk         InvestigateDetectionGetResponseFindingsDetection = "BULK"
	InvestigateDetectionGetResponseFindingsDetectionEncrypted    InvestigateDetectionGetResponseFindingsDetection = "ENCRYPTED"
	InvestigateDetectionGetResponseFindingsDetectionExternal     InvestigateDetectionGetResponseFindingsDetection = "EXTERNAL"
	InvestigateDetectionGetResponseFindingsDetectionUnknown      InvestigateDetectionGetResponseFindingsDetection = "UNKNOWN"
	InvestigateDetectionGetResponseFindingsDetectionNone         InvestigateDetectionGetResponseFindingsDetection = "NONE"
)

func (InvestigateDetectionGetResponseFindingsDetection) IsKnown ¶ 

func (r InvestigateDetectionGetResponseFindingsDetection) IsKnown() bool

type InvestigateDetectionGetResponseHeader ¶ 

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

func (*InvestigateDetectionGetResponseHeader) UnmarshalJSON ¶ 

func (r *InvestigateDetectionGetResponseHeader) UnmarshalJSON(data []byte) (err error)
type InvestigateDetectionGetResponseLink struct {
	Href string                                  `json:"href" api:"required"`
	Text string                                  `json:"text" api:"nullable"`
	JSON investigateDetectionGetResponseLinkJSON `json:"-"`
}

func (*InvestigateDetectionGetResponseLink) UnmarshalJSON ¶ 

func (r *InvestigateDetectionGetResponseLink) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseSenderInfo ¶ 

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:"-"`
}

func (*InvestigateDetectionGetResponseSenderInfo) UnmarshalJSON ¶ 

func (r *InvestigateDetectionGetResponseSenderInfo) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseThreatCategory ¶ 

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

func (*InvestigateDetectionGetResponseThreatCategory) UnmarshalJSON ¶ 

func (r *InvestigateDetectionGetResponseThreatCategory) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseValidation ¶ 

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

func (*InvestigateDetectionGetResponseValidation) UnmarshalJSON ¶ 

func (r *InvestigateDetectionGetResponseValidation) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseValidationDKIM ¶ 

type InvestigateDetectionGetResponseValidationDKIM string
const (
	InvestigateDetectionGetResponseValidationDKIMPass    InvestigateDetectionGetResponseValidationDKIM = "pass"
	InvestigateDetectionGetResponseValidationDKIMNeutral InvestigateDetectionGetResponseValidationDKIM = "neutral"
	InvestigateDetectionGetResponseValidationDKIMFail    InvestigateDetectionGetResponseValidationDKIM = "fail"
	InvestigateDetectionGetResponseValidationDKIMError   InvestigateDetectionGetResponseValidationDKIM = "error"
	InvestigateDetectionGetResponseValidationDKIMNone    InvestigateDetectionGetResponseValidationDKIM = "none"
)

func (InvestigateDetectionGetResponseValidationDKIM) IsKnown ¶ 

func (r InvestigateDetectionGetResponseValidationDKIM) IsKnown() bool

type InvestigateDetectionGetResponseValidationDMARC ¶ 

type InvestigateDetectionGetResponseValidationDMARC string
const (
	InvestigateDetectionGetResponseValidationDMARCPass    InvestigateDetectionGetResponseValidationDMARC = "pass"
	InvestigateDetectionGetResponseValidationDMARCNeutral InvestigateDetectionGetResponseValidationDMARC = "neutral"
	InvestigateDetectionGetResponseValidationDMARCFail    InvestigateDetectionGetResponseValidationDMARC = "fail"
	InvestigateDetectionGetResponseValidationDMARCError   InvestigateDetectionGetResponseValidationDMARC = "error"
	InvestigateDetectionGetResponseValidationDMARCNone    InvestigateDetectionGetResponseValidationDMARC = "none"
)

func (InvestigateDetectionGetResponseValidationDMARC) IsKnown ¶ 

func (r InvestigateDetectionGetResponseValidationDMARC) IsKnown() bool

type InvestigateDetectionGetResponseValidationSPF ¶ 

type InvestigateDetectionGetResponseValidationSPF string
const (
	InvestigateDetectionGetResponseValidationSPFPass    InvestigateDetectionGetResponseValidationSPF = "pass"
	InvestigateDetectionGetResponseValidationSPFNeutral InvestigateDetectionGetResponseValidationSPF = "neutral"
	InvestigateDetectionGetResponseValidationSPFFail    InvestigateDetectionGetResponseValidationSPF = "fail"
	InvestigateDetectionGetResponseValidationSPFError   InvestigateDetectionGetResponseValidationSPF = "error"
	InvestigateDetectionGetResponseValidationSPFNone    InvestigateDetectionGetResponseValidationSPF = "none"
)

func (InvestigateDetectionGetResponseValidationSPF) IsKnown ¶ 

func (r InvestigateDetectionGetResponseValidationSPF) IsKnown() bool

type InvestigateDetectionService ¶ 

type InvestigateDetectionService struct {
	Options []option.RequestOption
}

InvestigateDetectionService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateDetectionService method instead.

func NewInvestigateDetectionService ¶ 

func NewInvestigateDetectionService(opts ...option.RequestOption) (r *InvestigateDetectionService)

NewInvestigateDetectionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateDetectionService) Get ¶ 

func (r *InvestigateDetectionService) Get(ctx context.Context, investigateID string, query InvestigateDetectionGetParams, opts ...option.RequestOption) (res *InvestigateDetectionGetResponse, err error)

Returns detection details such as threat categories and sender information for non-benign messages.

type InvestigateGetParams ¶ 

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"`
}

func (InvestigateGetParams) URLQuery ¶ 

func (r InvestigateGetParams) URLQuery() (v url.Values)

URLQuery serializes InvestigateGetParams's query parameters as `url.Values`.

type InvestigateGetResponse ¶ 

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: Use GET /investigate/{investigate_id}/action_log instead.
	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: Use `scanned_at` instead.
	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: Use the `findings` field from GET
	// /investigate/{investigate_id}/detections instead.
	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:"-"`
}

func (*InvestigateGetResponse) UnmarshalJSON ¶ 

func (r *InvestigateGetResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponseActionLog ¶ 

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: Use `completed_at` instead.
	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:"-"`
}

func (*InvestigateGetResponseActionLog) UnmarshalJSON ¶ 

func (r *InvestigateGetResponseActionLog) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponseActionLogOperation ¶ 

type InvestigateGetResponseActionLogOperation string

Type of action performed 

const (
	InvestigateGetResponseActionLogOperationMove              InvestigateGetResponseActionLogOperation = "MOVE"
	InvestigateGetResponseActionLogOperationRelease           InvestigateGetResponseActionLogOperation = "RELEASE"
	InvestigateGetResponseActionLogOperationReclassify        InvestigateGetResponseActionLogOperation = "RECLASSIFY"
	InvestigateGetResponseActionLogOperationSubmission        InvestigateGetResponseActionLogOperation = "SUBMISSION"
	InvestigateGetResponseActionLogOperationQuarantineRelease InvestigateGetResponseActionLogOperation = "QUARANTINE_RELEASE"
	InvestigateGetResponseActionLogOperationPreview           InvestigateGetResponseActionLogOperation = "PREVIEW"
)

func (InvestigateGetResponseActionLogOperation) IsKnown ¶ 

func (r InvestigateGetResponseActionLogOperation) IsKnown() bool

type InvestigateGetResponseActionLogProperties ¶ 

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:"-"`
}

Additional properties for the action

func (*InvestigateGetResponseActionLogProperties) UnmarshalJSON ¶ 

func (r *InvestigateGetResponseActionLogProperties) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponseDeliveryMode ¶ 

type InvestigateGetResponseDeliveryMode string
const (
	InvestigateGetResponseDeliveryModeDirect                InvestigateGetResponseDeliveryMode = "DIRECT"
	InvestigateGetResponseDeliveryModeBcc                   InvestigateGetResponseDeliveryMode = "BCC"
	InvestigateGetResponseDeliveryModeJournal               InvestigateGetResponseDeliveryMode = "JOURNAL"
	InvestigateGetResponseDeliveryModeReviewSubmission      InvestigateGetResponseDeliveryMode = "REVIEW_SUBMISSION"
	InvestigateGetResponseDeliveryModeDMARCUnverified       InvestigateGetResponseDeliveryMode = "DMARC_UNVERIFIED"
	InvestigateGetResponseDeliveryModeDMARCFailureReport    InvestigateGetResponseDeliveryMode = "DMARC_FAILURE_REPORT"
	InvestigateGetResponseDeliveryModeDMARCAggregateReport  InvestigateGetResponseDeliveryMode = "DMARC_AGGREGATE_REPORT"
	InvestigateGetResponseDeliveryModeThreatIntelSubmission InvestigateGetResponseDeliveryMode = "THREAT_INTEL_SUBMISSION"
	InvestigateGetResponseDeliveryModeSimulationSubmission  InvestigateGetResponseDeliveryMode = "SIMULATION_SUBMISSION"
	InvestigateGetResponseDeliveryModeAPI                   InvestigateGetResponseDeliveryMode = "API"
	InvestigateGetResponseDeliveryModeRetroScan             InvestigateGetResponseDeliveryMode = "RETRO_SCAN"
)

func (InvestigateGetResponseDeliveryMode) IsKnown ¶ 

func (r InvestigateGetResponseDeliveryMode) IsKnown() bool

type InvestigateGetResponseDeliveryStatus ¶ 

type InvestigateGetResponseDeliveryStatus string

Delivery status of the message. 

const (
	InvestigateGetResponseDeliveryStatusDelivered   InvestigateGetResponseDeliveryStatus = "delivered"
	InvestigateGetResponseDeliveryStatusMoved       InvestigateGetResponseDeliveryStatus = "moved"
	InvestigateGetResponseDeliveryStatusQuarantined InvestigateGetResponseDeliveryStatus = "quarantined"
	InvestigateGetResponseDeliveryStatusRejected    InvestigateGetResponseDeliveryStatus = "rejected"
	InvestigateGetResponseDeliveryStatusDeferred    InvestigateGetResponseDeliveryStatus = "deferred"
	InvestigateGetResponseDeliveryStatusBounced     InvestigateGetResponseDeliveryStatus = "bounced"
	InvestigateGetResponseDeliveryStatusQueued      InvestigateGetResponseDeliveryStatus = "queued"
)

func (InvestigateGetResponseDeliveryStatus) IsKnown ¶ 

func (r InvestigateGetResponseDeliveryStatus) IsKnown() bool

type InvestigateGetResponseEnvelope ¶ 

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:"-"`
}

func (*InvestigateGetResponseEnvelope) UnmarshalJSON ¶ 

func (r *InvestigateGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponseEnvelopeErrors ¶ 

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:"-"`
}

func (*InvestigateGetResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *InvestigateGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponseEnvelopeErrorsSource ¶ 

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

func (*InvestigateGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *InvestigateGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponseEnvelopeMessages ¶ 

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:"-"`
}

func (*InvestigateGetResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *InvestigateGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponseEnvelopeMessagesSource ¶ 

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

func (*InvestigateGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *InvestigateGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponseEnvelopeSuccess ¶ 

type InvestigateGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	InvestigateGetResponseEnvelopeSuccessTrue InvestigateGetResponseEnvelopeSuccess = true
)

func (InvestigateGetResponseEnvelopeSuccess) IsKnown ¶ 

func (r InvestigateGetResponseEnvelopeSuccess) IsKnown() bool

type InvestigateGetResponseFinalDisposition ¶ 

type InvestigateGetResponseFinalDisposition string
const (
	InvestigateGetResponseFinalDispositionMalicious    InvestigateGetResponseFinalDisposition = "MALICIOUS"
	InvestigateGetResponseFinalDispositionMaliciousBec InvestigateGetResponseFinalDisposition = "MALICIOUS-BEC"
	InvestigateGetResponseFinalDispositionSuspicious   InvestigateGetResponseFinalDisposition = "SUSPICIOUS"
	InvestigateGetResponseFinalDispositionSpoof        InvestigateGetResponseFinalDisposition = "SPOOF"
	InvestigateGetResponseFinalDispositionSpam         InvestigateGetResponseFinalDisposition = "SPAM"
	InvestigateGetResponseFinalDispositionBulk         InvestigateGetResponseFinalDisposition = "BULK"
	InvestigateGetResponseFinalDispositionEncrypted    InvestigateGetResponseFinalDisposition = "ENCRYPTED"
	InvestigateGetResponseFinalDispositionExternal     InvestigateGetResponseFinalDisposition = "EXTERNAL"
	InvestigateGetResponseFinalDispositionUnknown      InvestigateGetResponseFinalDisposition = "UNKNOWN"
	InvestigateGetResponseFinalDispositionNone         InvestigateGetResponseFinalDisposition = "NONE"
)

func (InvestigateGetResponseFinalDisposition) IsKnown ¶ 

func (r InvestigateGetResponseFinalDisposition) IsKnown() bool

type InvestigateGetResponseFinding ¶ 

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:"-"`
}

func (*InvestigateGetResponseFinding) UnmarshalJSON ¶ 

func (r *InvestigateGetResponseFinding) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponseFindingsDetection ¶ 

type InvestigateGetResponseFindingsDetection string
const (
	InvestigateGetResponseFindingsDetectionMalicious    InvestigateGetResponseFindingsDetection = "MALICIOUS"
	InvestigateGetResponseFindingsDetectionMaliciousBec InvestigateGetResponseFindingsDetection = "MALICIOUS-BEC"
	InvestigateGetResponseFindingsDetectionSuspicious   InvestigateGetResponseFindingsDetection = "SUSPICIOUS"
	InvestigateGetResponseFindingsDetectionSpoof        InvestigateGetResponseFindingsDetection = "SPOOF"
	InvestigateGetResponseFindingsDetectionSpam         InvestigateGetResponseFindingsDetection = "SPAM"
	InvestigateGetResponseFindingsDetectionBulk         InvestigateGetResponseFindingsDetection = "BULK"
	InvestigateGetResponseFindingsDetectionEncrypted    InvestigateGetResponseFindingsDetection = "ENCRYPTED"
	InvestigateGetResponseFindingsDetectionExternal     InvestigateGetResponseFindingsDetection = "EXTERNAL"
	InvestigateGetResponseFindingsDetectionUnknown      InvestigateGetResponseFindingsDetection = "UNKNOWN"
	InvestigateGetResponseFindingsDetectionNone         InvestigateGetResponseFindingsDetection = "NONE"
)

func (InvestigateGetResponseFindingsDetection) IsKnown ¶ 

func (r InvestigateGetResponseFindingsDetection) IsKnown() bool

type InvestigateGetResponsePostDeliveryOperation ¶ 

type InvestigateGetResponsePostDeliveryOperation string
const (
	InvestigateGetResponsePostDeliveryOperationPreview           InvestigateGetResponsePostDeliveryOperation = "PREVIEW"
	InvestigateGetResponsePostDeliveryOperationQuarantineRelease InvestigateGetResponsePostDeliveryOperation = "QUARANTINE_RELEASE"
	InvestigateGetResponsePostDeliveryOperationSubmission        InvestigateGetResponsePostDeliveryOperation = "SUBMISSION"
	InvestigateGetResponsePostDeliveryOperationMove              InvestigateGetResponsePostDeliveryOperation = "MOVE"
)

func (InvestigateGetResponsePostDeliveryOperation) IsKnown ¶ 

func (r InvestigateGetResponsePostDeliveryOperation) IsKnown() bool

type InvestigateGetResponseProperties ¶ 

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:"-"`
}

Message processing properties

func (*InvestigateGetResponseProperties) UnmarshalJSON ¶ 

func (r *InvestigateGetResponseProperties) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponsePropertiesAllowlistedPatternType ¶ 

type InvestigateGetResponsePropertiesAllowlistedPatternType string

Type of allowlist pattern 

const (
	InvestigateGetResponsePropertiesAllowlistedPatternTypeQuarantineRelease       InvestigateGetResponsePropertiesAllowlistedPatternType = "quarantine_release"
	InvestigateGetResponsePropertiesAllowlistedPatternTypeAcceptableSender        InvestigateGetResponsePropertiesAllowlistedPatternType = "acceptable_sender"
	InvestigateGetResponsePropertiesAllowlistedPatternTypeAllowedSender           InvestigateGetResponsePropertiesAllowlistedPatternType = "allowed_sender"
	InvestigateGetResponsePropertiesAllowlistedPatternTypeAllowedRecipient        InvestigateGetResponsePropertiesAllowlistedPatternType = "allowed_recipient"
	InvestigateGetResponsePropertiesAllowlistedPatternTypeDomainSimilarity        InvestigateGetResponsePropertiesAllowlistedPatternType = "domain_similarity"
	InvestigateGetResponsePropertiesAllowlistedPatternTypeDomainRecency           InvestigateGetResponsePropertiesAllowlistedPatternType = "domain_recency"
	InvestigateGetResponsePropertiesAllowlistedPatternTypeManagedAcceptableSender InvestigateGetResponsePropertiesAllowlistedPatternType = "managed_acceptable_sender"
	InvestigateGetResponsePropertiesAllowlistedPatternTypeOutboundNdr             InvestigateGetResponsePropertiesAllowlistedPatternType = "outbound_ndr"
)

func (InvestigateGetResponsePropertiesAllowlistedPatternType) IsKnown ¶ 

func (r InvestigateGetResponsePropertiesAllowlistedPatternType) IsKnown() bool

type InvestigateGetResponsePropertiesWhitelistedPatternType ¶ 

type InvestigateGetResponsePropertiesWhitelistedPatternType string

Legacy field for allowlist pattern type 

const (
	InvestigateGetResponsePropertiesWhitelistedPatternTypeQuarantineRelease       InvestigateGetResponsePropertiesWhitelistedPatternType = "quarantine_release"
	InvestigateGetResponsePropertiesWhitelistedPatternTypeAcceptableSender        InvestigateGetResponsePropertiesWhitelistedPatternType = "acceptable_sender"
	InvestigateGetResponsePropertiesWhitelistedPatternTypeAllowedSender           InvestigateGetResponsePropertiesWhitelistedPatternType = "allowed_sender"
	InvestigateGetResponsePropertiesWhitelistedPatternTypeAllowedRecipient        InvestigateGetResponsePropertiesWhitelistedPatternType = "allowed_recipient"
	InvestigateGetResponsePropertiesWhitelistedPatternTypeDomainSimilarity        InvestigateGetResponsePropertiesWhitelistedPatternType = "domain_similarity"
	InvestigateGetResponsePropertiesWhitelistedPatternTypeDomainRecency           InvestigateGetResponsePropertiesWhitelistedPatternType = "domain_recency"
	InvestigateGetResponsePropertiesWhitelistedPatternTypeManagedAcceptableSender InvestigateGetResponsePropertiesWhitelistedPatternType = "managed_acceptable_sender"
	InvestigateGetResponsePropertiesWhitelistedPatternTypeOutboundNdr             InvestigateGetResponsePropertiesWhitelistedPatternType = "outbound_ndr"
)

func (InvestigateGetResponsePropertiesWhitelistedPatternType) IsKnown ¶ 

func (r InvestigateGetResponsePropertiesWhitelistedPatternType) IsKnown() bool

type InvestigateGetResponseValidation ¶ 

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

func (*InvestigateGetResponseValidation) UnmarshalJSON ¶ 

func (r *InvestigateGetResponseValidation) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponseValidationDKIM ¶ 

type InvestigateGetResponseValidationDKIM string
const (
	InvestigateGetResponseValidationDKIMPass    InvestigateGetResponseValidationDKIM = "pass"
	InvestigateGetResponseValidationDKIMNeutral InvestigateGetResponseValidationDKIM = "neutral"
	InvestigateGetResponseValidationDKIMFail    InvestigateGetResponseValidationDKIM = "fail"
	InvestigateGetResponseValidationDKIMError   InvestigateGetResponseValidationDKIM = "error"
	InvestigateGetResponseValidationDKIMNone    InvestigateGetResponseValidationDKIM = "none"
)

func (InvestigateGetResponseValidationDKIM) IsKnown ¶ 

func (r InvestigateGetResponseValidationDKIM) IsKnown() bool

type InvestigateGetResponseValidationDMARC ¶ 

type InvestigateGetResponseValidationDMARC string
const (
	InvestigateGetResponseValidationDMARCPass    InvestigateGetResponseValidationDMARC = "pass"
	InvestigateGetResponseValidationDMARCNeutral InvestigateGetResponseValidationDMARC = "neutral"
	InvestigateGetResponseValidationDMARCFail    InvestigateGetResponseValidationDMARC = "fail"
	InvestigateGetResponseValidationDMARCError   InvestigateGetResponseValidationDMARC = "error"
	InvestigateGetResponseValidationDMARCNone    InvestigateGetResponseValidationDMARC = "none"
)

func (InvestigateGetResponseValidationDMARC) IsKnown ¶ 

func (r InvestigateGetResponseValidationDMARC) IsKnown() bool

type InvestigateGetResponseValidationSPF ¶ 

type InvestigateGetResponseValidationSPF string
const (
	InvestigateGetResponseValidationSPFPass    InvestigateGetResponseValidationSPF = "pass"
	InvestigateGetResponseValidationSPFNeutral InvestigateGetResponseValidationSPF = "neutral"
	InvestigateGetResponseValidationSPFFail    InvestigateGetResponseValidationSPF = "fail"
	InvestigateGetResponseValidationSPFError   InvestigateGetResponseValidationSPF = "error"
	InvestigateGetResponseValidationSPFNone    InvestigateGetResponseValidationSPF = "none"
)

func (InvestigateGetResponseValidationSPF) IsKnown ¶ 

func (r InvestigateGetResponseValidationSPF) IsKnown() bool

type InvestigateListParams ¶ 

type InvestigateListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	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"`
}

func (InvestigateListParams) URLQuery ¶ 

func (r InvestigateListParams) URLQuery() (v url.Values)

URLQuery serializes InvestigateListParams's query parameters as `url.Values`.

type InvestigateListParamsDeliveryStatus ¶ 

type InvestigateListParamsDeliveryStatus string

Delivery status to filter by. 

const (
	InvestigateListParamsDeliveryStatusDelivered   InvestigateListParamsDeliveryStatus = "delivered"
	InvestigateListParamsDeliveryStatusMoved       InvestigateListParamsDeliveryStatus = "moved"
	InvestigateListParamsDeliveryStatusQuarantined InvestigateListParamsDeliveryStatus = "quarantined"
	InvestigateListParamsDeliveryStatusRejected    InvestigateListParamsDeliveryStatus = "rejected"
	InvestigateListParamsDeliveryStatusDeferred    InvestigateListParamsDeliveryStatus = "deferred"
	InvestigateListParamsDeliveryStatusBounced     InvestigateListParamsDeliveryStatus = "bounced"
	InvestigateListParamsDeliveryStatusQueued      InvestigateListParamsDeliveryStatus = "queued"
)

func (InvestigateListParamsDeliveryStatus) IsKnown ¶ 

func (r InvestigateListParamsDeliveryStatus) IsKnown() bool

type InvestigateListParamsFinalDisposition ¶ 

type InvestigateListParamsFinalDisposition string

Dispositions to filter by. 

const (
	InvestigateListParamsFinalDispositionMalicious  InvestigateListParamsFinalDisposition = "MALICIOUS"
	InvestigateListParamsFinalDispositionSuspicious InvestigateListParamsFinalDisposition = "SUSPICIOUS"
	InvestigateListParamsFinalDispositionSpoof      InvestigateListParamsFinalDisposition = "SPOOF"
	InvestigateListParamsFinalDispositionSpam       InvestigateListParamsFinalDisposition = "SPAM"
	InvestigateListParamsFinalDispositionBulk       InvestigateListParamsFinalDisposition = "BULK"
	InvestigateListParamsFinalDispositionNone       InvestigateListParamsFinalDisposition = "NONE"
)

func (InvestigateListParamsFinalDisposition) IsKnown ¶ 

func (r InvestigateListParamsFinalDisposition) IsKnown() bool

type InvestigateListParamsMessageAction ¶ 

type InvestigateListParamsMessageAction string

Message actions to filter by. 

const (
	InvestigateListParamsMessageActionPreview            InvestigateListParamsMessageAction = "PREVIEW"
	InvestigateListParamsMessageActionQuarantineReleased InvestigateListParamsMessageAction = "QUARANTINE_RELEASED"
	InvestigateListParamsMessageActionMoved              InvestigateListParamsMessageAction = "MOVED"
)

func (InvestigateListParamsMessageAction) IsKnown ¶ 

func (r InvestigateListParamsMessageAction) IsKnown() bool

type InvestigateListResponse ¶ 

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: Use GET /investigate/{investigate_id}/action_log instead.
	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: Use `scanned_at` instead.
	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: Use the `findings` field from GET
	// /investigate/{investigate_id}/detections instead.
	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:"-"`
}

func (*InvestigateListResponse) UnmarshalJSON ¶ 

func (r *InvestigateListResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateListResponseActionLog ¶ 

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: Use `completed_at` instead.
	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:"-"`
}

func (*InvestigateListResponseActionLog) UnmarshalJSON ¶ 

func (r *InvestigateListResponseActionLog) UnmarshalJSON(data []byte) (err error)

type InvestigateListResponseActionLogOperation ¶ 

type InvestigateListResponseActionLogOperation string

Type of action performed 

const (
	InvestigateListResponseActionLogOperationMove              InvestigateListResponseActionLogOperation = "MOVE"
	InvestigateListResponseActionLogOperationRelease           InvestigateListResponseActionLogOperation = "RELEASE"
	InvestigateListResponseActionLogOperationReclassify        InvestigateListResponseActionLogOperation = "RECLASSIFY"
	InvestigateListResponseActionLogOperationSubmission        InvestigateListResponseActionLogOperation = "SUBMISSION"
	InvestigateListResponseActionLogOperationQuarantineRelease InvestigateListResponseActionLogOperation = "QUARANTINE_RELEASE"
	InvestigateListResponseActionLogOperationPreview           InvestigateListResponseActionLogOperation = "PREVIEW"
)

func (InvestigateListResponseActionLogOperation) IsKnown ¶ 

func (r InvestigateListResponseActionLogOperation) IsKnown() bool

type InvestigateListResponseActionLogProperties ¶ 

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:"-"`
}

Additional properties for the action

func (*InvestigateListResponseActionLogProperties) UnmarshalJSON ¶ 

func (r *InvestigateListResponseActionLogProperties) UnmarshalJSON(data []byte) (err error)

type InvestigateListResponseDeliveryMode ¶ 

type InvestigateListResponseDeliveryMode string
const (
	InvestigateListResponseDeliveryModeDirect                InvestigateListResponseDeliveryMode = "DIRECT"
	InvestigateListResponseDeliveryModeBcc                   InvestigateListResponseDeliveryMode = "BCC"
	InvestigateListResponseDeliveryModeJournal               InvestigateListResponseDeliveryMode = "JOURNAL"
	InvestigateListResponseDeliveryModeReviewSubmission      InvestigateListResponseDeliveryMode = "REVIEW_SUBMISSION"
	InvestigateListResponseDeliveryModeDMARCUnverified       InvestigateListResponseDeliveryMode = "DMARC_UNVERIFIED"
	InvestigateListResponseDeliveryModeDMARCFailureReport    InvestigateListResponseDeliveryMode = "DMARC_FAILURE_REPORT"
	InvestigateListResponseDeliveryModeDMARCAggregateReport  InvestigateListResponseDeliveryMode = "DMARC_AGGREGATE_REPORT"
	InvestigateListResponseDeliveryModeThreatIntelSubmission InvestigateListResponseDeliveryMode = "THREAT_INTEL_SUBMISSION"
	InvestigateListResponseDeliveryModeSimulationSubmission  InvestigateListResponseDeliveryMode = "SIMULATION_SUBMISSION"
	InvestigateListResponseDeliveryModeAPI                   InvestigateListResponseDeliveryMode = "API"
	InvestigateListResponseDeliveryModeRetroScan             InvestigateListResponseDeliveryMode = "RETRO_SCAN"
)

func (InvestigateListResponseDeliveryMode) IsKnown ¶ 

func (r InvestigateListResponseDeliveryMode) IsKnown() bool

type InvestigateListResponseDeliveryStatus ¶ 

type InvestigateListResponseDeliveryStatus string

Delivery status of the message. 

const (
	InvestigateListResponseDeliveryStatusDelivered   InvestigateListResponseDeliveryStatus = "delivered"
	InvestigateListResponseDeliveryStatusMoved       InvestigateListResponseDeliveryStatus = "moved"
	InvestigateListResponseDeliveryStatusQuarantined InvestigateListResponseDeliveryStatus = "quarantined"
	InvestigateListResponseDeliveryStatusRejected    InvestigateListResponseDeliveryStatus = "rejected"
	InvestigateListResponseDeliveryStatusDeferred    InvestigateListResponseDeliveryStatus = "deferred"
	InvestigateListResponseDeliveryStatusBounced     InvestigateListResponseDeliveryStatus = "bounced"
	InvestigateListResponseDeliveryStatusQueued      InvestigateListResponseDeliveryStatus = "queued"
)

func (InvestigateListResponseDeliveryStatus) IsKnown ¶ 

func (r InvestigateListResponseDeliveryStatus) IsKnown() bool

type InvestigateListResponseFinalDisposition ¶ 

type InvestigateListResponseFinalDisposition string
const (
	InvestigateListResponseFinalDispositionMalicious    InvestigateListResponseFinalDisposition = "MALICIOUS"
	InvestigateListResponseFinalDispositionMaliciousBec InvestigateListResponseFinalDisposition = "MALICIOUS-BEC"
	InvestigateListResponseFinalDispositionSuspicious   InvestigateListResponseFinalDisposition = "SUSPICIOUS"
	InvestigateListResponseFinalDispositionSpoof        InvestigateListResponseFinalDisposition = "SPOOF"
	InvestigateListResponseFinalDispositionSpam         InvestigateListResponseFinalDisposition = "SPAM"
	InvestigateListResponseFinalDispositionBulk         InvestigateListResponseFinalDisposition = "BULK"
	InvestigateListResponseFinalDispositionEncrypted    InvestigateListResponseFinalDisposition = "ENCRYPTED"
	InvestigateListResponseFinalDispositionExternal     InvestigateListResponseFinalDisposition = "EXTERNAL"
	InvestigateListResponseFinalDispositionUnknown      InvestigateListResponseFinalDisposition = "UNKNOWN"
	InvestigateListResponseFinalDispositionNone         InvestigateListResponseFinalDisposition = "NONE"
)

func (InvestigateListResponseFinalDisposition) IsKnown ¶ 

func (r InvestigateListResponseFinalDisposition) IsKnown() bool

type InvestigateListResponseFinding ¶ 

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:"-"`
}

func (*InvestigateListResponseFinding) UnmarshalJSON ¶ 

func (r *InvestigateListResponseFinding) UnmarshalJSON(data []byte) (err error)

type InvestigateListResponseFindingsDetection ¶ 

type InvestigateListResponseFindingsDetection string
const (
	InvestigateListResponseFindingsDetectionMalicious    InvestigateListResponseFindingsDetection = "MALICIOUS"
	InvestigateListResponseFindingsDetectionMaliciousBec InvestigateListResponseFindingsDetection = "MALICIOUS-BEC"
	InvestigateListResponseFindingsDetectionSuspicious   InvestigateListResponseFindingsDetection = "SUSPICIOUS"
	InvestigateListResponseFindingsDetectionSpoof        InvestigateListResponseFindingsDetection = "SPOOF"
	InvestigateListResponseFindingsDetectionSpam         InvestigateListResponseFindingsDetection = "SPAM"
	InvestigateListResponseFindingsDetectionBulk         InvestigateListResponseFindingsDetection = "BULK"
	InvestigateListResponseFindingsDetectionEncrypted    InvestigateListResponseFindingsDetection = "ENCRYPTED"
	InvestigateListResponseFindingsDetectionExternal     InvestigateListResponseFindingsDetection = "EXTERNAL"
	InvestigateListResponseFindingsDetectionUnknown      InvestigateListResponseFindingsDetection = "UNKNOWN"
	InvestigateListResponseFindingsDetectionNone         InvestigateListResponseFindingsDetection = "NONE"
)

func (InvestigateListResponseFindingsDetection) IsKnown ¶ 

func (r InvestigateListResponseFindingsDetection) IsKnown() bool

type InvestigateListResponsePostDeliveryOperation ¶ 

type InvestigateListResponsePostDeliveryOperation string
const (
	InvestigateListResponsePostDeliveryOperationPreview           InvestigateListResponsePostDeliveryOperation = "PREVIEW"
	InvestigateListResponsePostDeliveryOperationQuarantineRelease InvestigateListResponsePostDeliveryOperation = "QUARANTINE_RELEASE"
	InvestigateListResponsePostDeliveryOperationSubmission        InvestigateListResponsePostDeliveryOperation = "SUBMISSION"
	InvestigateListResponsePostDeliveryOperationMove              InvestigateListResponsePostDeliveryOperation = "MOVE"
)

func (InvestigateListResponsePostDeliveryOperation) IsKnown ¶ 

func (r InvestigateListResponsePostDeliveryOperation) IsKnown() bool

type InvestigateListResponseProperties ¶ 

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:"-"`
}

Message processing properties

func (*InvestigateListResponseProperties) UnmarshalJSON ¶ 

func (r *InvestigateListResponseProperties) UnmarshalJSON(data []byte) (err error)

type InvestigateListResponsePropertiesAllowlistedPatternType ¶ 

type InvestigateListResponsePropertiesAllowlistedPatternType string

Type of allowlist pattern 

const (
	InvestigateListResponsePropertiesAllowlistedPatternTypeQuarantineRelease       InvestigateListResponsePropertiesAllowlistedPatternType = "quarantine_release"
	InvestigateListResponsePropertiesAllowlistedPatternTypeAcceptableSender        InvestigateListResponsePropertiesAllowlistedPatternType = "acceptable_sender"
	InvestigateListResponsePropertiesAllowlistedPatternTypeAllowedSender           InvestigateListResponsePropertiesAllowlistedPatternType = "allowed_sender"
	InvestigateListResponsePropertiesAllowlistedPatternTypeAllowedRecipient        InvestigateListResponsePropertiesAllowlistedPatternType = "allowed_recipient"
	InvestigateListResponsePropertiesAllowlistedPatternTypeDomainSimilarity        InvestigateListResponsePropertiesAllowlistedPatternType = "domain_similarity"
	InvestigateListResponsePropertiesAllowlistedPatternTypeDomainRecency           InvestigateListResponsePropertiesAllowlistedPatternType = "domain_recency"
	InvestigateListResponsePropertiesAllowlistedPatternTypeManagedAcceptableSender InvestigateListResponsePropertiesAllowlistedPatternType = "managed_acceptable_sender"
	InvestigateListResponsePropertiesAllowlistedPatternTypeOutboundNdr             InvestigateListResponsePropertiesAllowlistedPatternType = "outbound_ndr"
)

func (InvestigateListResponsePropertiesAllowlistedPatternType) IsKnown ¶ 

func (r InvestigateListResponsePropertiesAllowlistedPatternType) IsKnown() bool

type InvestigateListResponsePropertiesWhitelistedPatternType ¶ 

type InvestigateListResponsePropertiesWhitelistedPatternType string

Legacy field for allowlist pattern type 

const (
	InvestigateListResponsePropertiesWhitelistedPatternTypeQuarantineRelease       InvestigateListResponsePropertiesWhitelistedPatternType = "quarantine_release"
	InvestigateListResponsePropertiesWhitelistedPatternTypeAcceptableSender        InvestigateListResponsePropertiesWhitelistedPatternType = "acceptable_sender"
	InvestigateListResponsePropertiesWhitelistedPatternTypeAllowedSender           InvestigateListResponsePropertiesWhitelistedPatternType = "allowed_sender"
	InvestigateListResponsePropertiesWhitelistedPatternTypeAllowedRecipient        InvestigateListResponsePropertiesWhitelistedPatternType = "allowed_recipient"
	InvestigateListResponsePropertiesWhitelistedPatternTypeDomainSimilarity        InvestigateListResponsePropertiesWhitelistedPatternType = "domain_similarity"
	InvestigateListResponsePropertiesWhitelistedPatternTypeDomainRecency           InvestigateListResponsePropertiesWhitelistedPatternType = "domain_recency"
	InvestigateListResponsePropertiesWhitelistedPatternTypeManagedAcceptableSender InvestigateListResponsePropertiesWhitelistedPatternType = "managed_acceptable_sender"
	InvestigateListResponsePropertiesWhitelistedPatternTypeOutboundNdr             InvestigateListResponsePropertiesWhitelistedPatternType = "outbound_ndr"
)

func (InvestigateListResponsePropertiesWhitelistedPatternType) IsKnown ¶ 

func (r InvestigateListResponsePropertiesWhitelistedPatternType) IsKnown() bool

type InvestigateListResponseValidation ¶ 

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

func (*InvestigateListResponseValidation) UnmarshalJSON ¶ 

func (r *InvestigateListResponseValidation) UnmarshalJSON(data []byte) (err error)

type InvestigateListResponseValidationDKIM ¶ 

type InvestigateListResponseValidationDKIM string
const (
	InvestigateListResponseValidationDKIMPass    InvestigateListResponseValidationDKIM = "pass"
	InvestigateListResponseValidationDKIMNeutral InvestigateListResponseValidationDKIM = "neutral"
	InvestigateListResponseValidationDKIMFail    InvestigateListResponseValidationDKIM = "fail"
	InvestigateListResponseValidationDKIMError   InvestigateListResponseValidationDKIM = "error"
	InvestigateListResponseValidationDKIMNone    InvestigateListResponseValidationDKIM = "none"
)

func (InvestigateListResponseValidationDKIM) IsKnown ¶ 

func (r InvestigateListResponseValidationDKIM) IsKnown() bool

type InvestigateListResponseValidationDMARC ¶ 

type InvestigateListResponseValidationDMARC string
const (
	InvestigateListResponseValidationDMARCPass    InvestigateListResponseValidationDMARC = "pass"
	InvestigateListResponseValidationDMARCNeutral InvestigateListResponseValidationDMARC = "neutral"
	InvestigateListResponseValidationDMARCFail    InvestigateListResponseValidationDMARC = "fail"
	InvestigateListResponseValidationDMARCError   InvestigateListResponseValidationDMARC = "error"
	InvestigateListResponseValidationDMARCNone    InvestigateListResponseValidationDMARC = "none"
)

func (InvestigateListResponseValidationDMARC) IsKnown ¶ 

func (r InvestigateListResponseValidationDMARC) IsKnown() bool

type InvestigateListResponseValidationSPF ¶ 

type InvestigateListResponseValidationSPF string
const (
	InvestigateListResponseValidationSPFPass    InvestigateListResponseValidationSPF = "pass"
	InvestigateListResponseValidationSPFNeutral InvestigateListResponseValidationSPF = "neutral"
	InvestigateListResponseValidationSPFFail    InvestigateListResponseValidationSPF = "fail"
	InvestigateListResponseValidationSPFError   InvestigateListResponseValidationSPF = "error"
	InvestigateListResponseValidationSPFNone    InvestigateListResponseValidationSPF = "none"
)

func (InvestigateListResponseValidationSPF) IsKnown ¶ 

func (r InvestigateListResponseValidationSPF) IsKnown() bool

type InvestigateMoveBulkParams ¶ 

type InvestigateMoveBulkParams struct {
	// Identifier.
	AccountID           param.Field[string]                                       `path:"account_id" api:"required"`
	Destination         param.Field[InvestigateMoveBulkParamsDestination]         `json:"destination" api:"required"`
	ExpectedDisposition param.Field[InvestigateMoveBulkParamsExpectedDisposition] `json:"expected_disposition"`
	// 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"`
}

func (InvestigateMoveBulkParams) MarshalJSON ¶ 

func (r InvestigateMoveBulkParams) MarshalJSON() (data []byte, err error)

type InvestigateMoveBulkParamsDestination ¶ 

type InvestigateMoveBulkParamsDestination string
const (
	InvestigateMoveBulkParamsDestinationInbox                     InvestigateMoveBulkParamsDestination = "Inbox"
	InvestigateMoveBulkParamsDestinationJunkEmail                 InvestigateMoveBulkParamsDestination = "JunkEmail"
	InvestigateMoveBulkParamsDestinationDeletedItems              InvestigateMoveBulkParamsDestination = "DeletedItems"
	InvestigateMoveBulkParamsDestinationRecoverableItemsDeletions InvestigateMoveBulkParamsDestination = "RecoverableItemsDeletions"
	InvestigateMoveBulkParamsDestinationRecoverableItemsPurges    InvestigateMoveBulkParamsDestination = "RecoverableItemsPurges"
)

func (InvestigateMoveBulkParamsDestination) IsKnown ¶ 

func (r InvestigateMoveBulkParamsDestination) IsKnown() bool

type InvestigateMoveBulkParamsExpectedDisposition ¶ added in v7.7.0 

type InvestigateMoveBulkParamsExpectedDisposition string
const (
	InvestigateMoveBulkParamsExpectedDispositionMalicious    InvestigateMoveBulkParamsExpectedDisposition = "MALICIOUS"
	InvestigateMoveBulkParamsExpectedDispositionMaliciousBec InvestigateMoveBulkParamsExpectedDisposition = "MALICIOUS-BEC"
	InvestigateMoveBulkParamsExpectedDispositionSuspicious   InvestigateMoveBulkParamsExpectedDisposition = "SUSPICIOUS"
	InvestigateMoveBulkParamsExpectedDispositionSpoof        InvestigateMoveBulkParamsExpectedDisposition = "SPOOF"
	InvestigateMoveBulkParamsExpectedDispositionSpam         InvestigateMoveBulkParamsExpectedDisposition = "SPAM"
	InvestigateMoveBulkParamsExpectedDispositionBulk         InvestigateMoveBulkParamsExpectedDisposition = "BULK"
	InvestigateMoveBulkParamsExpectedDispositionEncrypted    InvestigateMoveBulkParamsExpectedDisposition = "ENCRYPTED"
	InvestigateMoveBulkParamsExpectedDispositionExternal     InvestigateMoveBulkParamsExpectedDisposition = "EXTERNAL"
	InvestigateMoveBulkParamsExpectedDispositionUnknown      InvestigateMoveBulkParamsExpectedDisposition = "UNKNOWN"
	InvestigateMoveBulkParamsExpectedDispositionNone         InvestigateMoveBulkParamsExpectedDisposition = "NONE"
)

func (InvestigateMoveBulkParamsExpectedDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateMoveBulkParamsExpectedDisposition) IsKnown() bool

type InvestigateMoveBulkResponse ¶ 

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: Use `completed_at` instead.
	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: This field is 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:"-"`
}

func (*InvestigateMoveBulkResponse) UnmarshalJSON ¶ 

func (r *InvestigateMoveBulkResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateMoveNewParams ¶ 

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

func (InvestigateMoveNewParams) MarshalJSON ¶ 

func (r InvestigateMoveNewParams) MarshalJSON() (data []byte, err error)

type InvestigateMoveNewParamsDestination ¶ 

type InvestigateMoveNewParamsDestination string
const (
	InvestigateMoveNewParamsDestinationInbox                     InvestigateMoveNewParamsDestination = "Inbox"
	InvestigateMoveNewParamsDestinationJunkEmail                 InvestigateMoveNewParamsDestination = "JunkEmail"
	InvestigateMoveNewParamsDestinationDeletedItems              InvestigateMoveNewParamsDestination = "DeletedItems"
	InvestigateMoveNewParamsDestinationRecoverableItemsDeletions InvestigateMoveNewParamsDestination = "RecoverableItemsDeletions"
	InvestigateMoveNewParamsDestinationRecoverableItemsPurges    InvestigateMoveNewParamsDestination = "RecoverableItemsPurges"
)

func (InvestigateMoveNewParamsDestination) IsKnown ¶ 

func (r InvestigateMoveNewParamsDestination) IsKnown() bool

type InvestigateMoveNewParamsExpectedDisposition ¶ added in v7.7.0 

type InvestigateMoveNewParamsExpectedDisposition string
const (
	InvestigateMoveNewParamsExpectedDispositionMalicious    InvestigateMoveNewParamsExpectedDisposition = "MALICIOUS"
	InvestigateMoveNewParamsExpectedDispositionMaliciousBec InvestigateMoveNewParamsExpectedDisposition = "MALICIOUS-BEC"
	InvestigateMoveNewParamsExpectedDispositionSuspicious   InvestigateMoveNewParamsExpectedDisposition = "SUSPICIOUS"
	InvestigateMoveNewParamsExpectedDispositionSpoof        InvestigateMoveNewParamsExpectedDisposition = "SPOOF"
	InvestigateMoveNewParamsExpectedDispositionSpam         InvestigateMoveNewParamsExpectedDisposition = "SPAM"
	InvestigateMoveNewParamsExpectedDispositionBulk         InvestigateMoveNewParamsExpectedDisposition = "BULK"
	InvestigateMoveNewParamsExpectedDispositionEncrypted    InvestigateMoveNewParamsExpectedDisposition = "ENCRYPTED"
	InvestigateMoveNewParamsExpectedDispositionExternal     InvestigateMoveNewParamsExpectedDisposition = "EXTERNAL"
	InvestigateMoveNewParamsExpectedDispositionUnknown      InvestigateMoveNewParamsExpectedDisposition = "UNKNOWN"
	InvestigateMoveNewParamsExpectedDispositionNone         InvestigateMoveNewParamsExpectedDisposition = "NONE"
)

func (InvestigateMoveNewParamsExpectedDisposition) IsKnown ¶ added in v7.7.0 

func (r InvestigateMoveNewParamsExpectedDisposition) IsKnown() bool

type InvestigateMoveNewResponse ¶ 

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: Use `completed_at` instead.
	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: This field is 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:"-"`
}

func (*InvestigateMoveNewResponse) UnmarshalJSON ¶ 

func (r *InvestigateMoveNewResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateMoveService ¶ 

type InvestigateMoveService struct {
	Options []option.RequestOption
}

InvestigateMoveService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateMoveService method instead.

func NewInvestigateMoveService ¶ 

func NewInvestigateMoveService(opts ...option.RequestOption) (r *InvestigateMoveService)

NewInvestigateMoveService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateMoveService) Bulk ¶ 

func (r *InvestigateMoveService) Bulk(ctx context.Context, params InvestigateMoveBulkParams, opts ...option.RequestOption) (res *pagination.SinglePage[InvestigateMoveBulkResponse], err error)

Moves multiple messages to a specified mailbox folder (Inbox, JunkEmail, DeletedItems, RecoverableItemsDeletions, or RecoverableItemsPurges). Requires active integration.

func (*InvestigateMoveService) BulkAutoPaging ¶ 

func (r *InvestigateMoveService) BulkAutoPaging(ctx context.Context, params InvestigateMoveBulkParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[InvestigateMoveBulkResponse]

Moves multiple messages to a specified mailbox folder (Inbox, JunkEmail, DeletedItems, RecoverableItemsDeletions, or RecoverableItemsPurges). Requires active integration.

func (*InvestigateMoveService) New ¶ 

func (r *InvestigateMoveService) New(ctx context.Context, investigateID string, params InvestigateMoveNewParams, opts ...option.RequestOption) (res *pagination.SinglePage[InvestigateMoveNewResponse], err error)

Moves a single message to a specified mailbox folder (Inbox, JunkEmail, DeletedItems, RecoverableItemsDeletions, or RecoverableItemsPurges). Requires active integration.

func (*InvestigateMoveService) NewAutoPaging ¶ 

func (r *InvestigateMoveService) NewAutoPaging(ctx context.Context, investigateID string, params InvestigateMoveNewParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[InvestigateMoveNewResponse]

Moves a single message to a specified mailbox folder (Inbox, JunkEmail, DeletedItems, RecoverableItemsDeletions, or RecoverableItemsPurges). Requires active integration.

type InvestigatePreviewGetParams ¶ 

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

type InvestigatePreviewGetResponse ¶ 

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

func (*InvestigatePreviewGetResponse) UnmarshalJSON ¶ 

func (r *InvestigatePreviewGetResponse) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewGetResponseEnvelope ¶ 

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:"-"`
}

func (*InvestigatePreviewGetResponseEnvelope) UnmarshalJSON ¶ 

func (r *InvestigatePreviewGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewGetResponseEnvelopeErrors ¶ 

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:"-"`
}

func (*InvestigatePreviewGetResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *InvestigatePreviewGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewGetResponseEnvelopeErrorsSource ¶ 

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

func (*InvestigatePreviewGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *InvestigatePreviewGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewGetResponseEnvelopeMessages ¶ 

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:"-"`
}

func (*InvestigatePreviewGetResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *InvestigatePreviewGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewGetResponseEnvelopeMessagesSource ¶ 

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

func (*InvestigatePreviewGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *InvestigatePreviewGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewGetResponseEnvelopeSuccess ¶ 

type InvestigatePreviewGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	InvestigatePreviewGetResponseEnvelopeSuccessTrue InvestigatePreviewGetResponseEnvelopeSuccess = true
)

func (InvestigatePreviewGetResponseEnvelopeSuccess) IsKnown ¶ 

func (r InvestigatePreviewGetResponseEnvelopeSuccess) IsKnown() bool

type InvestigatePreviewNewParams ¶ 

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"`
}

func (InvestigatePreviewNewParams) MarshalJSON ¶ 

func (r InvestigatePreviewNewParams) MarshalJSON() (data []byte, err error)

type InvestigatePreviewNewResponse ¶ 

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

func (*InvestigatePreviewNewResponse) UnmarshalJSON ¶ 

func (r *InvestigatePreviewNewResponse) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewNewResponseEnvelope ¶ 

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:"-"`
}

func (*InvestigatePreviewNewResponseEnvelope) UnmarshalJSON ¶ 

func (r *InvestigatePreviewNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewNewResponseEnvelopeErrors ¶ 

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:"-"`
}

func (*InvestigatePreviewNewResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *InvestigatePreviewNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewNewResponseEnvelopeErrorsSource ¶ 

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

func (*InvestigatePreviewNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *InvestigatePreviewNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewNewResponseEnvelopeMessages ¶ 

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:"-"`
}

func (*InvestigatePreviewNewResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *InvestigatePreviewNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewNewResponseEnvelopeMessagesSource ¶ 

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

func (*InvestigatePreviewNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *InvestigatePreviewNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewNewResponseEnvelopeSuccess ¶ 

type InvestigatePreviewNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	InvestigatePreviewNewResponseEnvelopeSuccessTrue InvestigatePreviewNewResponseEnvelopeSuccess = true
)

func (InvestigatePreviewNewResponseEnvelopeSuccess) IsKnown ¶ 

func (r InvestigatePreviewNewResponseEnvelopeSuccess) IsKnown() bool

type InvestigatePreviewService ¶ 

type InvestigatePreviewService struct {
	Options []option.RequestOption
}

InvestigatePreviewService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigatePreviewService method instead.

func NewInvestigatePreviewService ¶ 

func NewInvestigatePreviewService(opts ...option.RequestOption) (r *InvestigatePreviewService)

NewInvestigatePreviewService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigatePreviewService) Get ¶ 

func (r *InvestigatePreviewService) Get(ctx context.Context, investigateID string, query InvestigatePreviewGetParams, opts ...option.RequestOption) (res *InvestigatePreviewGetResponse, err error)

Returns a preview of the message body as a base64 encoded PNG image for non-benign messages.

func (*InvestigatePreviewService) New ¶ 

func (r *InvestigatePreviewService) New(ctx context.Context, params InvestigatePreviewNewParams, opts ...option.RequestOption) (res *InvestigatePreviewNewResponse, err error)

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.

type InvestigateRawGetParams ¶ 

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

type InvestigateRawGetResponse ¶ 

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

func (*InvestigateRawGetResponse) UnmarshalJSON ¶ 

func (r *InvestigateRawGetResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateRawGetResponseEnvelope ¶ 

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:"-"`
}

func (*InvestigateRawGetResponseEnvelope) UnmarshalJSON ¶ 

func (r *InvestigateRawGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigateRawGetResponseEnvelopeErrors ¶ 

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:"-"`
}

func (*InvestigateRawGetResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *InvestigateRawGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type InvestigateRawGetResponseEnvelopeErrorsSource ¶ 

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

func (*InvestigateRawGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *InvestigateRawGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type InvestigateRawGetResponseEnvelopeMessages ¶ 

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:"-"`
}

func (*InvestigateRawGetResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *InvestigateRawGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type InvestigateRawGetResponseEnvelopeMessagesSource ¶ 

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

func (*InvestigateRawGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *InvestigateRawGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type InvestigateRawGetResponseEnvelopeSuccess ¶ 

type InvestigateRawGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	InvestigateRawGetResponseEnvelopeSuccessTrue InvestigateRawGetResponseEnvelopeSuccess = true
)

func (InvestigateRawGetResponseEnvelopeSuccess) IsKnown ¶ 

func (r InvestigateRawGetResponseEnvelopeSuccess) IsKnown() bool

type InvestigateRawService ¶ 

type InvestigateRawService struct {
	Options []option.RequestOption
}

InvestigateRawService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateRawService method instead.

func NewInvestigateRawService ¶ 

func NewInvestigateRawService(opts ...option.RequestOption) (r *InvestigateRawService)

NewInvestigateRawService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateRawService) Get ¶ 

func (r *InvestigateRawService) Get(ctx context.Context, investigateID string, query InvestigateRawGetParams, opts ...option.RequestOption) (res *InvestigateRawGetResponse, err error)

Returns the raw eml of any non-benign message.

type InvestigateReclassifyNewParams ¶ 

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"`
}

func (InvestigateReclassifyNewParams) MarshalJSON ¶ 

func (r InvestigateReclassifyNewParams) MarshalJSON() (data []byte, err error)

type InvestigateReclassifyNewParamsExpectedDisposition ¶ 

type InvestigateReclassifyNewParamsExpectedDisposition string
const (
	InvestigateReclassifyNewParamsExpectedDispositionNone       InvestigateReclassifyNewParamsExpectedDisposition = "NONE"
	InvestigateReclassifyNewParamsExpectedDispositionBulk       InvestigateReclassifyNewParamsExpectedDisposition = "BULK"
	InvestigateReclassifyNewParamsExpectedDispositionMalicious  InvestigateReclassifyNewParamsExpectedDisposition = "MALICIOUS"
	InvestigateReclassifyNewParamsExpectedDispositionSpam       InvestigateReclassifyNewParamsExpectedDisposition = "SPAM"
	InvestigateReclassifyNewParamsExpectedDispositionSpoof      InvestigateReclassifyNewParamsExpectedDisposition = "SPOOF"
	InvestigateReclassifyNewParamsExpectedDispositionSuspicious InvestigateReclassifyNewParamsExpectedDisposition = "SUSPICIOUS"
)

func (InvestigateReclassifyNewParamsExpectedDisposition) IsKnown ¶ 

func (r InvestigateReclassifyNewParamsExpectedDisposition) IsKnown() bool

type InvestigateReclassifyNewResponse ¶ 

type InvestigateReclassifyNewResponse = interface{}

type InvestigateReclassifyNewResponseEnvelope ¶ 

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:"-"`
}

func (*InvestigateReclassifyNewResponseEnvelope) UnmarshalJSON ¶ 

func (r *InvestigateReclassifyNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigateReclassifyNewResponseEnvelopeErrors ¶ 

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:"-"`
}

func (*InvestigateReclassifyNewResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *InvestigateReclassifyNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type InvestigateReclassifyNewResponseEnvelopeErrorsSource ¶ 

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

func (*InvestigateReclassifyNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *InvestigateReclassifyNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type InvestigateReclassifyNewResponseEnvelopeMessages ¶ 

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:"-"`
}

func (*InvestigateReclassifyNewResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *InvestigateReclassifyNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type InvestigateReclassifyNewResponseEnvelopeMessagesSource ¶ 

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

func (*InvestigateReclassifyNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *InvestigateReclassifyNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type InvestigateReclassifyNewResponseEnvelopeSuccess ¶ 

type InvestigateReclassifyNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	InvestigateReclassifyNewResponseEnvelopeSuccessTrue InvestigateReclassifyNewResponseEnvelopeSuccess = true
)

func (InvestigateReclassifyNewResponseEnvelopeSuccess) IsKnown ¶ 

func (r InvestigateReclassifyNewResponseEnvelopeSuccess) IsKnown() bool

type InvestigateReclassifyService ¶ 

type InvestigateReclassifyService struct {
	Options []option.RequestOption
}

InvestigateReclassifyService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateReclassifyService method instead.

func NewInvestigateReclassifyService ¶ 

func NewInvestigateReclassifyService(opts ...option.RequestOption) (r *InvestigateReclassifyService)

NewInvestigateReclassifyService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateReclassifyService) New ¶ 

func (r *InvestigateReclassifyService) New(ctx context.Context, investigateID string, params InvestigateReclassifyNewParams, opts ...option.RequestOption) (res *InvestigateReclassifyNewResponse, err error)

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.

type InvestigateReleaseBulkParams ¶ 

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

func (InvestigateReleaseBulkParams) MarshalJSON ¶ 

func (r InvestigateReleaseBulkParams) MarshalJSON() (data []byte, err error)

type InvestigateReleaseBulkResponse ¶ 

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: Use `id` instead.
	PostfixID   string                             `json:"postfix_id"`
	Undelivered []string                           `json:"undelivered" api:"nullable"`
	JSON        investigateReleaseBulkResponseJSON `json:"-"`
}

func (*InvestigateReleaseBulkResponse) UnmarshalJSON ¶ 

func (r *InvestigateReleaseBulkResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateReleaseService ¶ 

type InvestigateReleaseService struct {
	Options []option.RequestOption
}

InvestigateReleaseService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateReleaseService method instead.

func NewInvestigateReleaseService ¶ 

func NewInvestigateReleaseService(opts ...option.RequestOption) (r *InvestigateReleaseService)

NewInvestigateReleaseService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateReleaseService) Bulk ¶ 

func (r *InvestigateReleaseService) Bulk(ctx context.Context, params InvestigateReleaseBulkParams, opts ...option.RequestOption) (res *pagination.SinglePage[InvestigateReleaseBulkResponse], err error)

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.

func (*InvestigateReleaseService) BulkAutoPaging ¶ 

func (r *InvestigateReleaseService) BulkAutoPaging(ctx context.Context, params InvestigateReleaseBulkParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[InvestigateReleaseBulkResponse]

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.

type InvestigateService ¶ 

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

InvestigateService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateService method instead.

func NewInvestigateService ¶ 

func NewInvestigateService(opts ...option.RequestOption) (r *InvestigateService)

NewInvestigateService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateService) Get ¶ 

func (r *InvestigateService) Get(ctx context.Context, investigateID string, params InvestigateGetParams, opts ...option.RequestOption) (res *InvestigateGetResponse, err error)

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.

func (*InvestigateService) List ¶ 

func (r *InvestigateService) List(ctx context.Context, params InvestigateListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[InvestigateListResponse], err error)

Returns information for each email that matches the search parameter(s).

func (*InvestigateService) ListAutoPaging ¶ 

func (r *InvestigateService) ListAutoPaging(ctx context.Context, params InvestigateListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[InvestigateListResponse]

Returns information for each email that matches the search parameter(s).

type InvestigateTraceGetParams ¶ 

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

type InvestigateTraceGetResponse ¶ 

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

func (*InvestigateTraceGetResponse) UnmarshalJSON ¶ 

func (r *InvestigateTraceGetResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceGetResponseEnvelope ¶ 

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:"-"`
}

func (*InvestigateTraceGetResponseEnvelope) UnmarshalJSON ¶ 

func (r *InvestigateTraceGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceGetResponseEnvelopeErrors ¶ 

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:"-"`
}

func (*InvestigateTraceGetResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *InvestigateTraceGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceGetResponseEnvelopeErrorsSource ¶ 

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

func (*InvestigateTraceGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *InvestigateTraceGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceGetResponseEnvelopeMessages ¶ 

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:"-"`
}

func (*InvestigateTraceGetResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *InvestigateTraceGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceGetResponseEnvelopeMessagesSource ¶ 

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

func (*InvestigateTraceGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *InvestigateTraceGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceGetResponseEnvelopeSuccess ¶ 

type InvestigateTraceGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	InvestigateTraceGetResponseEnvelopeSuccessTrue InvestigateTraceGetResponseEnvelopeSuccess = true
)

func (InvestigateTraceGetResponseEnvelopeSuccess) IsKnown ¶ 

func (r InvestigateTraceGetResponseEnvelopeSuccess) IsKnown() bool

type InvestigateTraceGetResponseInbound ¶ 

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

func (*InvestigateTraceGetResponseInbound) UnmarshalJSON ¶ 

func (r *InvestigateTraceGetResponseInbound) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceGetResponseInboundLine ¶ 

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: Use `logged_at` instead.
	Ts   string                                     `json:"ts"`
	JSON investigateTraceGetResponseInboundLineJSON `json:"-"`
}

func (*InvestigateTraceGetResponseInboundLine) UnmarshalJSON ¶ 

func (r *InvestigateTraceGetResponseInboundLine) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceGetResponseOutbound ¶ 

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

func (*InvestigateTraceGetResponseOutbound) UnmarshalJSON ¶ 

func (r *InvestigateTraceGetResponseOutbound) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceGetResponseOutboundLine ¶ 

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: Use `logged_at` instead.
	Ts   string                                      `json:"ts"`
	JSON investigateTraceGetResponseOutboundLineJSON `json:"-"`
}

func (*InvestigateTraceGetResponseOutboundLine) UnmarshalJSON ¶ 

func (r *InvestigateTraceGetResponseOutboundLine) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceService ¶ 

type InvestigateTraceService struct {
	Options []option.RequestOption
}

InvestigateTraceService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateTraceService method instead.

func NewInvestigateTraceService ¶ 

func NewInvestigateTraceService(opts ...option.RequestOption) (r *InvestigateTraceService)

NewInvestigateTraceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateTraceService) Get ¶ 

func (r *InvestigateTraceService) Get(ctx context.Context, investigateID string, query InvestigateTraceGetParams, opts ...option.RequestOption) (res *InvestigateTraceGetResponse, err error)

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.

type Member ¶ 

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess ¶ 

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup ¶ 

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta ¶ 

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup ¶ 

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta ¶ 

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope ¶ 

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject ¶ 

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy ¶ 

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus ¶ 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser ¶ 

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission ¶ 

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant ¶ 

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam ¶ 

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type PhishguardReportListParams ¶ 

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"`
}

func (PhishguardReportListParams) URLQuery ¶ 

func (r PhishguardReportListParams) URLQuery() (v url.Values)

URLQuery serializes PhishguardReportListParams's query parameters as `url.Values`.

type PhishguardReportListResponse ¶ 

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: Use `created_at` instead.
	Ts        time.Time                        `json:"ts" format:"date-time"`
	UpdatedAt time.Time                        `json:"updated_at" api:"nullable" format:"date-time"`
	JSON      phishguardReportListResponseJSON `json:"-"`
}

func (*PhishguardReportListResponse) UnmarshalJSON ¶ 

func (r *PhishguardReportListResponse) UnmarshalJSON(data []byte) (err error)

type PhishguardReportListResponseDisposition ¶ 

type PhishguardReportListResponseDisposition string
const (
	PhishguardReportListResponseDispositionMalicious    PhishguardReportListResponseDisposition = "MALICIOUS"
	PhishguardReportListResponseDispositionMaliciousBec PhishguardReportListResponseDisposition = "MALICIOUS-BEC"
	PhishguardReportListResponseDispositionSuspicious   PhishguardReportListResponseDisposition = "SUSPICIOUS"
	PhishguardReportListResponseDispositionSpoof        PhishguardReportListResponseDisposition = "SPOOF"
	PhishguardReportListResponseDispositionSpam         PhishguardReportListResponseDisposition = "SPAM"
	PhishguardReportListResponseDispositionBulk         PhishguardReportListResponseDisposition = "BULK"
	PhishguardReportListResponseDispositionEncrypted    PhishguardReportListResponseDisposition = "ENCRYPTED"
	PhishguardReportListResponseDispositionExternal     PhishguardReportListResponseDisposition = "EXTERNAL"
	PhishguardReportListResponseDispositionUnknown      PhishguardReportListResponseDisposition = "UNKNOWN"
	PhishguardReportListResponseDispositionNone         PhishguardReportListResponseDisposition = "NONE"
)

func (PhishguardReportListResponseDisposition) IsKnown ¶ 

func (r PhishguardReportListResponseDisposition) IsKnown() bool

type PhishguardReportListResponseFields ¶ 

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: Use `occurred_at` instead.
	Ts   time.Time                              `json:"ts" format:"date-time"`
	JSON phishguardReportListResponseFieldsJSON `json:"-"`
}

func (*PhishguardReportListResponseFields) UnmarshalJSON ¶ 

func (r *PhishguardReportListResponseFields) UnmarshalJSON(data []byte) (err error)

type PhishguardReportListResponseTag ¶ 

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

func (*PhishguardReportListResponseTag) UnmarshalJSON ¶ 

func (r *PhishguardReportListResponseTag) UnmarshalJSON(data []byte) (err error)

type PhishguardReportService ¶ 

type PhishguardReportService struct {
	Options []option.RequestOption
}

PhishguardReportService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPhishguardReportService method instead.

func NewPhishguardReportService ¶ 

func NewPhishguardReportService(opts ...option.RequestOption) (r *PhishguardReportService)

NewPhishguardReportService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*PhishguardReportService) List ¶ 

func (r *PhishguardReportService) List(ctx context.Context, params PhishguardReportListParams, opts ...option.RequestOption) (res *pagination.SinglePage[PhishguardReportListResponse], err error)

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.

func (*PhishguardReportService) ListAutoPaging ¶ 

func (r *PhishguardReportService) ListAutoPaging(ctx context.Context, params PhishguardReportListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[PhishguardReportListResponse]

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.

type PhishguardService ¶ 

type PhishguardService struct {
	Options []option.RequestOption
	Reports *PhishguardReportService
}

PhishguardService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPhishguardService method instead.

func NewPhishguardService ¶ 

func NewPhishguardService(opts ...option.RequestOption) (r *PhishguardService)

NewPhishguardService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type RatePlan ¶ 

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID ¶ 

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam ¶ 

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo ¶ 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource ¶ 

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role ¶ 

type Role = shared.Role

This is an alias to an internal type.

type RoleParam ¶ 

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions ¶ 

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam ¶ 

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SettingAllowPolicyDeleteParams ¶ 

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

type SettingAllowPolicyDeleteResponse ¶ 

type SettingAllowPolicyDeleteResponse struct {
	// Allow policy identifier
	ID   string                               `json:"id" api:"required" format:"uuid"`
	JSON settingAllowPolicyDeleteResponseJSON `json:"-"`
}

func (*SettingAllowPolicyDeleteResponse) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyDeleteResponse) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyDeleteResponseEnvelope ¶ 

type SettingAllowPolicyDeleteResponseEnvelope struct {
	Errors   []SettingAllowPolicyDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingAllowPolicyDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingAllowPolicyDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SettingAllowPolicyDeleteResponse                `json:"result"`
	JSON    settingAllowPolicyDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*SettingAllowPolicyDeleteResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyDeleteResponseEnvelopeErrors ¶ 

type SettingAllowPolicyDeleteResponseEnvelopeErrors struct {
	Code             int64                                                `json:"code" api:"required"`
	Message          string                                               `json:"message" api:"required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           SettingAllowPolicyDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingAllowPolicyDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingAllowPolicyDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyDeleteResponseEnvelopeErrorsSource ¶ 

type SettingAllowPolicyDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    settingAllowPolicyDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingAllowPolicyDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyDeleteResponseEnvelopeMessages ¶ 

type SettingAllowPolicyDeleteResponseEnvelopeMessages struct {
	Code             int64                                                  `json:"code" api:"required"`
	Message          string                                                 `json:"message" api:"required"`
	DocumentationURL string                                                 `json:"documentation_url"`
	Source           SettingAllowPolicyDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingAllowPolicyDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingAllowPolicyDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyDeleteResponseEnvelopeMessagesSource ¶ 

type SettingAllowPolicyDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                     `json:"pointer"`
	JSON    settingAllowPolicyDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingAllowPolicyDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyDeleteResponseEnvelopeSuccess ¶ 

type SettingAllowPolicyDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingAllowPolicyDeleteResponseEnvelopeSuccessTrue SettingAllowPolicyDeleteResponseEnvelopeSuccess = true
)

func (SettingAllowPolicyDeleteResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingAllowPolicyDeleteResponseEnvelopeSuccess) IsKnown() bool

type SettingAllowPolicyEditParams ¶ 

type SettingAllowPolicyEditParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Comments  param.Field[string] `json:"comments"`
	// 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 param.Field[bool] `json:"is_acceptable_sender"`
	// Messages to this recipient will bypass all detections
	IsExemptRecipient param.Field[bool] `json:"is_exempt_recipient"`
	// Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life:
	// July 1, 2026.
	IsRecipient param.Field[bool] `json:"is_recipient"`
	IsRegex     param.Field[bool] `json:"is_regex"`
	// Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life:
	// July 1, 2026.
	IsSender param.Field[bool] `json:"is_sender"`
	// Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life:
	// July 1, 2026.
	IsSpoof param.Field[bool] `json:"is_spoof"`
	// Messages from this sender will bypass all detections and link following
	IsTrustedSender param.Field[bool]   `json:"is_trusted_sender"`
	Pattern         param.Field[string] `json:"pattern"`
	// Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when
	// creating or updating policies, but may be returned for existing entries.
	PatternType param.Field[SettingAllowPolicyEditParamsPatternType] `json:"pattern_type"`
	// Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors
	// policies that pass authentication.
	VerifySender param.Field[bool] `json:"verify_sender"`
}

func (SettingAllowPolicyEditParams) MarshalJSON ¶ 

func (r SettingAllowPolicyEditParams) MarshalJSON() (data []byte, err error)

type SettingAllowPolicyEditParamsPatternType ¶ 

type SettingAllowPolicyEditParamsPatternType string

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries. 

const (
	SettingAllowPolicyEditParamsPatternTypeEmail   SettingAllowPolicyEditParamsPatternType = "EMAIL"
	SettingAllowPolicyEditParamsPatternTypeDomain  SettingAllowPolicyEditParamsPatternType = "DOMAIN"
	SettingAllowPolicyEditParamsPatternTypeIP      SettingAllowPolicyEditParamsPatternType = "IP"
	SettingAllowPolicyEditParamsPatternTypeUnknown SettingAllowPolicyEditParamsPatternType = "UNKNOWN"
)

func (SettingAllowPolicyEditParamsPatternType) IsKnown ¶ 

func (r SettingAllowPolicyEditParamsPatternType) IsKnown() bool

type SettingAllowPolicyEditResponse ¶ 

type SettingAllowPolicyEditResponse struct {
	// Allow policy identifier
	ID        string    `json:"id" api:"required" format:"uuid"`
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time `json:"last_modified" api:"required" format:"date-time"`
	Comments     string    `json:"comments" api:"nullable"`
	// 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 bool `json:"is_acceptable_sender"`
	// Messages to this recipient will bypass all detections
	IsExemptRecipient bool `json:"is_exempt_recipient"`
	// Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life:
	// July 1, 2026.
	//
	// Deprecated: Use `is_exempt_recipient` instead.
	IsRecipient bool `json:"is_recipient"`
	IsRegex     bool `json:"is_regex"`
	// Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life:
	// July 1, 2026.
	//
	// Deprecated: Use `is_trusted_sender` instead.
	IsSender bool `json:"is_sender"`
	// Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life:
	// July 1, 2026.
	//
	// Deprecated: Use `is_acceptable_sender` instead.
	IsSpoof bool `json:"is_spoof"`
	// Messages from this sender will bypass all detections and link following
	IsTrustedSender bool      `json:"is_trusted_sender"`
	ModifiedAt      time.Time `json:"modified_at" format:"date-time"`
	Pattern         string    `json:"pattern"`
	// Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when
	// creating or updating policies, but may be returned for existing entries.
	PatternType SettingAllowPolicyEditResponsePatternType `json:"pattern_type"`
	// Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors
	// policies that pass authentication.
	VerifySender bool                               `json:"verify_sender"`
	JSON         settingAllowPolicyEditResponseJSON `json:"-"`
}

An email allow policy

func (*SettingAllowPolicyEditResponse) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyEditResponse) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyEditResponseEnvelope ¶ 

type SettingAllowPolicyEditResponseEnvelope struct {
	Errors   []SettingAllowPolicyEditResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingAllowPolicyEditResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingAllowPolicyEditResponseEnvelopeSuccess `json:"success" api:"required"`
	// An email allow policy
	Result SettingAllowPolicyEditResponse             `json:"result"`
	JSON   settingAllowPolicyEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingAllowPolicyEditResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyEditResponseEnvelopeErrors ¶ 

type SettingAllowPolicyEditResponseEnvelopeErrors struct {
	Code             int64                                              `json:"code" api:"required"`
	Message          string                                             `json:"message" api:"required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           SettingAllowPolicyEditResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingAllowPolicyEditResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingAllowPolicyEditResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyEditResponseEnvelopeErrorsSource ¶ 

type SettingAllowPolicyEditResponseEnvelopeErrorsSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    settingAllowPolicyEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingAllowPolicyEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyEditResponseEnvelopeMessages ¶ 

type SettingAllowPolicyEditResponseEnvelopeMessages struct {
	Code             int64                                                `json:"code" api:"required"`
	Message          string                                               `json:"message" api:"required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           SettingAllowPolicyEditResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingAllowPolicyEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingAllowPolicyEditResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyEditResponseEnvelopeMessagesSource ¶ 

type SettingAllowPolicyEditResponseEnvelopeMessagesSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    settingAllowPolicyEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingAllowPolicyEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyEditResponseEnvelopeSuccess ¶ 

type SettingAllowPolicyEditResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingAllowPolicyEditResponseEnvelopeSuccessTrue SettingAllowPolicyEditResponseEnvelopeSuccess = true
)

func (SettingAllowPolicyEditResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingAllowPolicyEditResponseEnvelopeSuccess) IsKnown() bool

type SettingAllowPolicyEditResponsePatternType ¶ 

type SettingAllowPolicyEditResponsePatternType string

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries. 

const (
	SettingAllowPolicyEditResponsePatternTypeEmail   SettingAllowPolicyEditResponsePatternType = "EMAIL"
	SettingAllowPolicyEditResponsePatternTypeDomain  SettingAllowPolicyEditResponsePatternType = "DOMAIN"
	SettingAllowPolicyEditResponsePatternTypeIP      SettingAllowPolicyEditResponsePatternType = "IP"
	SettingAllowPolicyEditResponsePatternTypeUnknown SettingAllowPolicyEditResponsePatternType = "UNKNOWN"
)

func (SettingAllowPolicyEditResponsePatternType) IsKnown ¶ 

func (r SettingAllowPolicyEditResponsePatternType) IsKnown() bool

type SettingAllowPolicyGetParams ¶ 

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

type SettingAllowPolicyGetResponse ¶ 

type SettingAllowPolicyGetResponse struct {
	// Allow policy identifier
	ID        string    `json:"id" api:"required" format:"uuid"`
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time `json:"last_modified" api:"required" format:"date-time"`
	Comments     string    `json:"comments" api:"nullable"`
	// 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 bool `json:"is_acceptable_sender"`
	// Messages to this recipient will bypass all detections
	IsExemptRecipient bool `json:"is_exempt_recipient"`
	// Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life:
	// July 1, 2026.
	//
	// Deprecated: Use `is_exempt_recipient` instead.
	IsRecipient bool `json:"is_recipient"`
	IsRegex     bool `json:"is_regex"`
	// Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life:
	// July 1, 2026.
	//
	// Deprecated: Use `is_trusted_sender` instead.
	IsSender bool `json:"is_sender"`
	// Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life:
	// July 1, 2026.
	//
	// Deprecated: Use `is_acceptable_sender` instead.
	IsSpoof bool `json:"is_spoof"`
	// Messages from this sender will bypass all detections and link following
	IsTrustedSender bool      `json:"is_trusted_sender"`
	ModifiedAt      time.Time `json:"modified_at" format:"date-time"`
	Pattern         string    `json:"pattern"`
	// Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when
	// creating or updating policies, but may be returned for existing entries.
	PatternType SettingAllowPolicyGetResponsePatternType `json:"pattern_type"`
	// Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors
	// policies that pass authentication.
	VerifySender bool                              `json:"verify_sender"`
	JSON         settingAllowPolicyGetResponseJSON `json:"-"`
}

An email allow policy

func (*SettingAllowPolicyGetResponse) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyGetResponse) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyGetResponseEnvelope ¶ 

type SettingAllowPolicyGetResponseEnvelope struct {
	Errors   []SettingAllowPolicyGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingAllowPolicyGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingAllowPolicyGetResponseEnvelopeSuccess `json:"success" api:"required"`
	// An email allow policy
	Result SettingAllowPolicyGetResponse             `json:"result"`
	JSON   settingAllowPolicyGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingAllowPolicyGetResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyGetResponseEnvelopeErrors ¶ 

type SettingAllowPolicyGetResponseEnvelopeErrors struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           SettingAllowPolicyGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingAllowPolicyGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingAllowPolicyGetResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyGetResponseEnvelopeErrorsSource ¶ 

type SettingAllowPolicyGetResponseEnvelopeErrorsSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    settingAllowPolicyGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingAllowPolicyGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyGetResponseEnvelopeMessages ¶ 

type SettingAllowPolicyGetResponseEnvelopeMessages struct {
	Code             int64                                               `json:"code" api:"required"`
	Message          string                                              `json:"message" api:"required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           SettingAllowPolicyGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingAllowPolicyGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingAllowPolicyGetResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyGetResponseEnvelopeMessagesSource ¶ 

type SettingAllowPolicyGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    settingAllowPolicyGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingAllowPolicyGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyGetResponseEnvelopeSuccess ¶ 

type SettingAllowPolicyGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingAllowPolicyGetResponseEnvelopeSuccessTrue SettingAllowPolicyGetResponseEnvelopeSuccess = true
)

func (SettingAllowPolicyGetResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingAllowPolicyGetResponseEnvelopeSuccess) IsKnown() bool

type SettingAllowPolicyGetResponsePatternType ¶ 

type SettingAllowPolicyGetResponsePatternType string

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries. 

const (
	SettingAllowPolicyGetResponsePatternTypeEmail   SettingAllowPolicyGetResponsePatternType = "EMAIL"
	SettingAllowPolicyGetResponsePatternTypeDomain  SettingAllowPolicyGetResponsePatternType = "DOMAIN"
	SettingAllowPolicyGetResponsePatternTypeIP      SettingAllowPolicyGetResponsePatternType = "IP"
	SettingAllowPolicyGetResponsePatternTypeUnknown SettingAllowPolicyGetResponsePatternType = "UNKNOWN"
)

func (SettingAllowPolicyGetResponsePatternType) IsKnown ¶ 

func (r SettingAllowPolicyGetResponsePatternType) IsKnown() bool

type SettingAllowPolicyListParams ¶ 

type SettingAllowPolicyListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The sorting direction.
	Direction param.Field[SettingAllowPolicyListParamsDirection] `query:"direction"`
	// Filter to show only policies where messages from the sender are exempted from
	// Spam, Spoof, and Bulk dispositions (not Malicious or Suspicious).
	IsAcceptableSender param.Field[bool] `query:"is_acceptable_sender"`
	// Filter to show only policies where messages to the recipient bypass all
	// detections.
	IsExemptRecipient param.Field[bool] `query:"is_exempt_recipient"`
	// Filter to show only policies where messages from the sender bypass all
	// detections and link following.
	IsTrustedSender param.Field[bool] `query:"is_trusted_sender"`
	// Field to sort by.
	Order param.Field[SettingAllowPolicyListParamsOrder] `query:"order"`
	// Current page within paginated list of results.
	Page    param.Field[int64]  `query:"page"`
	Pattern param.Field[string] `query:"pattern"`
	// Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when
	// creating or updating policies, but may be returned for existing entries.
	PatternType param.Field[SettingAllowPolicyListParamsPatternType] `query:"pattern_type"`
	// The number of results per page. Maximum value is 1000.
	PerPage param.Field[int64] `query:"per_page"`
	// Search term for filtering records. Behavior may change.
	Search param.Field[string] `query:"search"`
	// Filter to show only policies that enforce DMARC, SPF, or DKIM authentication.
	VerifySender param.Field[bool] `query:"verify_sender"`
}

func (SettingAllowPolicyListParams) URLQuery ¶ 

func (r SettingAllowPolicyListParams) URLQuery() (v url.Values)

URLQuery serializes SettingAllowPolicyListParams's query parameters as `url.Values`.

type SettingAllowPolicyListParamsDirection ¶ 

type SettingAllowPolicyListParamsDirection string

The sorting direction. 

const (
	SettingAllowPolicyListParamsDirectionAsc  SettingAllowPolicyListParamsDirection = "asc"
	SettingAllowPolicyListParamsDirectionDesc SettingAllowPolicyListParamsDirection = "desc"
)

func (SettingAllowPolicyListParamsDirection) IsKnown ¶ 

func (r SettingAllowPolicyListParamsDirection) IsKnown() bool

type SettingAllowPolicyListParamsOrder ¶ 

type SettingAllowPolicyListParamsOrder string

Field to sort by. 

const (
	SettingAllowPolicyListParamsOrderPattern   SettingAllowPolicyListParamsOrder = "pattern"
	SettingAllowPolicyListParamsOrderCreatedAt SettingAllowPolicyListParamsOrder = "created_at"
)

func (SettingAllowPolicyListParamsOrder) IsKnown ¶ 

func (r SettingAllowPolicyListParamsOrder) IsKnown() bool

type SettingAllowPolicyListParamsPatternType ¶ 

type SettingAllowPolicyListParamsPatternType string

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries. 

const (
	SettingAllowPolicyListParamsPatternTypeEmail   SettingAllowPolicyListParamsPatternType = "EMAIL"
	SettingAllowPolicyListParamsPatternTypeDomain  SettingAllowPolicyListParamsPatternType = "DOMAIN"
	SettingAllowPolicyListParamsPatternTypeIP      SettingAllowPolicyListParamsPatternType = "IP"
	SettingAllowPolicyListParamsPatternTypeUnknown SettingAllowPolicyListParamsPatternType = "UNKNOWN"
)

func (SettingAllowPolicyListParamsPatternType) IsKnown ¶ 

func (r SettingAllowPolicyListParamsPatternType) IsKnown() bool

type SettingAllowPolicyListResponse ¶ 

type SettingAllowPolicyListResponse struct {
	// Allow policy identifier
	ID        string    `json:"id" api:"required" format:"uuid"`
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time `json:"last_modified" api:"required" format:"date-time"`
	Comments     string    `json:"comments" api:"nullable"`
	// 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 bool `json:"is_acceptable_sender"`
	// Messages to this recipient will bypass all detections
	IsExemptRecipient bool `json:"is_exempt_recipient"`
	// Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life:
	// July 1, 2026.
	//
	// Deprecated: Use `is_exempt_recipient` instead.
	IsRecipient bool `json:"is_recipient"`
	IsRegex     bool `json:"is_regex"`
	// Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life:
	// July 1, 2026.
	//
	// Deprecated: Use `is_trusted_sender` instead.
	IsSender bool `json:"is_sender"`
	// Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life:
	// July 1, 2026.
	//
	// Deprecated: Use `is_acceptable_sender` instead.
	IsSpoof bool `json:"is_spoof"`
	// Messages from this sender will bypass all detections and link following
	IsTrustedSender bool      `json:"is_trusted_sender"`
	ModifiedAt      time.Time `json:"modified_at" format:"date-time"`
	Pattern         string    `json:"pattern"`
	// Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when
	// creating or updating policies, but may be returned for existing entries.
	PatternType SettingAllowPolicyListResponsePatternType `json:"pattern_type"`
	// Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors
	// policies that pass authentication.
	VerifySender bool                               `json:"verify_sender"`
	JSON         settingAllowPolicyListResponseJSON `json:"-"`
}

An email allow policy

func (*SettingAllowPolicyListResponse) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyListResponse) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyListResponsePatternType ¶ 

type SettingAllowPolicyListResponsePatternType string

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries. 

const (
	SettingAllowPolicyListResponsePatternTypeEmail   SettingAllowPolicyListResponsePatternType = "EMAIL"
	SettingAllowPolicyListResponsePatternTypeDomain  SettingAllowPolicyListResponsePatternType = "DOMAIN"
	SettingAllowPolicyListResponsePatternTypeIP      SettingAllowPolicyListResponsePatternType = "IP"
	SettingAllowPolicyListResponsePatternTypeUnknown SettingAllowPolicyListResponsePatternType = "UNKNOWN"
)

func (SettingAllowPolicyListResponsePatternType) IsKnown ¶ 

func (r SettingAllowPolicyListResponsePatternType) IsKnown() bool

type SettingAllowPolicyNewParams ¶ 

type SettingAllowPolicyNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// 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 param.Field[bool] `json:"is_acceptable_sender" api:"required"`
	// Messages to this recipient will bypass all detections
	IsExemptRecipient param.Field[bool] `json:"is_exempt_recipient" api:"required"`
	IsRegex           param.Field[bool] `json:"is_regex" api:"required"`
	// Messages from this sender will bypass all detections and link following
	IsTrustedSender param.Field[bool]   `json:"is_trusted_sender" api:"required"`
	Pattern         param.Field[string] `json:"pattern" api:"required"`
	// Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when
	// creating or updating policies, but may be returned for existing entries.
	PatternType param.Field[SettingAllowPolicyNewParamsPatternType] `json:"pattern_type" api:"required"`
	// Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors
	// policies that pass authentication.
	VerifySender param.Field[bool]   `json:"verify_sender" api:"required"`
	Comments     param.Field[string] `json:"comments"`
	// Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life:
	// July 1, 2026.
	IsRecipient param.Field[bool] `json:"is_recipient"`
	// Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life:
	// July 1, 2026.
	IsSender param.Field[bool] `json:"is_sender"`
	// Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life:
	// July 1, 2026.
	IsSpoof param.Field[bool] `json:"is_spoof"`
}

func (SettingAllowPolicyNewParams) MarshalJSON ¶ 

func (r SettingAllowPolicyNewParams) MarshalJSON() (data []byte, err error)

type SettingAllowPolicyNewParamsPatternType ¶ 

type SettingAllowPolicyNewParamsPatternType string

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries. 

const (
	SettingAllowPolicyNewParamsPatternTypeEmail   SettingAllowPolicyNewParamsPatternType = "EMAIL"
	SettingAllowPolicyNewParamsPatternTypeDomain  SettingAllowPolicyNewParamsPatternType = "DOMAIN"
	SettingAllowPolicyNewParamsPatternTypeIP      SettingAllowPolicyNewParamsPatternType = "IP"
	SettingAllowPolicyNewParamsPatternTypeUnknown SettingAllowPolicyNewParamsPatternType = "UNKNOWN"
)

func (SettingAllowPolicyNewParamsPatternType) IsKnown ¶ 

func (r SettingAllowPolicyNewParamsPatternType) IsKnown() bool

type SettingAllowPolicyNewResponse ¶ 

type SettingAllowPolicyNewResponse struct {
	// Allow policy identifier
	ID        string    `json:"id" api:"required" format:"uuid"`
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time `json:"last_modified" api:"required" format:"date-time"`
	Comments     string    `json:"comments" api:"nullable"`
	// 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 bool `json:"is_acceptable_sender"`
	// Messages to this recipient will bypass all detections
	IsExemptRecipient bool `json:"is_exempt_recipient"`
	// Deprecated as of July 1, 2025. Use `is_exempt_recipient` instead. End of life:
	// July 1, 2026.
	//
	// Deprecated: Use `is_exempt_recipient` instead.
	IsRecipient bool `json:"is_recipient"`
	IsRegex     bool `json:"is_regex"`
	// Deprecated as of July 1, 2025. Use `is_trusted_sender` instead. End of life:
	// July 1, 2026.
	//
	// Deprecated: Use `is_trusted_sender` instead.
	IsSender bool `json:"is_sender"`
	// Deprecated as of July 1, 2025. Use `is_acceptable_sender` instead. End of life:
	// July 1, 2026.
	//
	// Deprecated: Use `is_acceptable_sender` instead.
	IsSpoof bool `json:"is_spoof"`
	// Messages from this sender will bypass all detections and link following
	IsTrustedSender bool      `json:"is_trusted_sender"`
	ModifiedAt      time.Time `json:"modified_at" format:"date-time"`
	Pattern         string    `json:"pattern"`
	// Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when
	// creating or updating policies, but may be returned for existing entries.
	PatternType SettingAllowPolicyNewResponsePatternType `json:"pattern_type"`
	// Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors
	// policies that pass authentication.
	VerifySender bool                              `json:"verify_sender"`
	JSON         settingAllowPolicyNewResponseJSON `json:"-"`
}

An email allow policy

func (*SettingAllowPolicyNewResponse) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyNewResponse) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyNewResponseEnvelope ¶ 

type SettingAllowPolicyNewResponseEnvelope struct {
	Errors   []SettingAllowPolicyNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingAllowPolicyNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingAllowPolicyNewResponseEnvelopeSuccess `json:"success" api:"required"`
	// An email allow policy
	Result SettingAllowPolicyNewResponse             `json:"result"`
	JSON   settingAllowPolicyNewResponseEnvelopeJSON `json:"-"`
}

func (*SettingAllowPolicyNewResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyNewResponseEnvelopeErrors ¶ 

type SettingAllowPolicyNewResponseEnvelopeErrors struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           SettingAllowPolicyNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingAllowPolicyNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingAllowPolicyNewResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyNewResponseEnvelopeErrorsSource ¶ 

type SettingAllowPolicyNewResponseEnvelopeErrorsSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    settingAllowPolicyNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingAllowPolicyNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyNewResponseEnvelopeMessages ¶ 

type SettingAllowPolicyNewResponseEnvelopeMessages struct {
	Code             int64                                               `json:"code" api:"required"`
	Message          string                                              `json:"message" api:"required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           SettingAllowPolicyNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingAllowPolicyNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingAllowPolicyNewResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyNewResponseEnvelopeMessagesSource ¶ 

type SettingAllowPolicyNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    settingAllowPolicyNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingAllowPolicyNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingAllowPolicyNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyNewResponseEnvelopeSuccess ¶ 

type SettingAllowPolicyNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingAllowPolicyNewResponseEnvelopeSuccessTrue SettingAllowPolicyNewResponseEnvelopeSuccess = true
)

func (SettingAllowPolicyNewResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingAllowPolicyNewResponseEnvelopeSuccess) IsKnown() bool

type SettingAllowPolicyNewResponsePatternType ¶ 

type SettingAllowPolicyNewResponsePatternType string

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries. 

const (
	SettingAllowPolicyNewResponsePatternTypeEmail   SettingAllowPolicyNewResponsePatternType = "EMAIL"
	SettingAllowPolicyNewResponsePatternTypeDomain  SettingAllowPolicyNewResponsePatternType = "DOMAIN"
	SettingAllowPolicyNewResponsePatternTypeIP      SettingAllowPolicyNewResponsePatternType = "IP"
	SettingAllowPolicyNewResponsePatternTypeUnknown SettingAllowPolicyNewResponsePatternType = "UNKNOWN"
)

func (SettingAllowPolicyNewResponsePatternType) IsKnown ¶ 

func (r SettingAllowPolicyNewResponsePatternType) IsKnown() bool

type SettingAllowPolicyService ¶ 

type SettingAllowPolicyService struct {
	Options []option.RequestOption
}

SettingAllowPolicyService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSettingAllowPolicyService method instead.

func NewSettingAllowPolicyService ¶ 

func NewSettingAllowPolicyService(opts ...option.RequestOption) (r *SettingAllowPolicyService)

NewSettingAllowPolicyService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SettingAllowPolicyService) Delete ¶ 

func (r *SettingAllowPolicyService) Delete(ctx context.Context, policyID string, body SettingAllowPolicyDeleteParams, opts ...option.RequestOption) (res *SettingAllowPolicyDeleteResponse, err error)

Removes an allow policy. After deletion, emails matching this pattern will be subject to normal security scanning and disposition actions.

func (*SettingAllowPolicyService) Edit ¶ 

func (r *SettingAllowPolicyService) Edit(ctx context.Context, policyID string, params SettingAllowPolicyEditParams, opts ...option.RequestOption) (res *SettingAllowPolicyEditResponse, err error)

Updates an existing allow policy. Only provided fields will be modified. Changes take effect for new emails matching the pattern.

func (*SettingAllowPolicyService) Get ¶ 

func (r *SettingAllowPolicyService) Get(ctx context.Context, policyID string, query SettingAllowPolicyGetParams, opts ...option.RequestOption) (res *SettingAllowPolicyGetResponse, err error)

Retrieves details for a specific allow policy including its pattern, dispositions that are exempted, and whether it applies to all detections.

func (*SettingAllowPolicyService) List ¶ 

func (r *SettingAllowPolicyService) List(ctx context.Context, params SettingAllowPolicyListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SettingAllowPolicyListResponse], err error)

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.

func (*SettingAllowPolicyService) ListAutoPaging ¶ 

func (r *SettingAllowPolicyService) ListAutoPaging(ctx context.Context, params SettingAllowPolicyListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SettingAllowPolicyListResponse]

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.

func (*SettingAllowPolicyService) New ¶ 

func (r *SettingAllowPolicyService) New(ctx context.Context, params SettingAllowPolicyNewParams, opts ...option.RequestOption) (res *SettingAllowPolicyNewResponse, err error)

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.

type SettingBlockSenderDeleteParams ¶ 

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

type SettingBlockSenderDeleteResponse ¶ 

type SettingBlockSenderDeleteResponse struct {
	// Blocked sender pattern identifier
	ID   string                               `json:"id" api:"required" format:"uuid"`
	JSON settingBlockSenderDeleteResponseJSON `json:"-"`
}

func (*SettingBlockSenderDeleteResponse) UnmarshalJSON ¶ 

func (r *SettingBlockSenderDeleteResponse) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderDeleteResponseEnvelope ¶ 

type SettingBlockSenderDeleteResponseEnvelope struct {
	Errors   []SettingBlockSenderDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingBlockSenderDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingBlockSenderDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SettingBlockSenderDeleteResponse                `json:"result"`
	JSON    settingBlockSenderDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*SettingBlockSenderDeleteResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingBlockSenderDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderDeleteResponseEnvelopeErrors ¶ 

type SettingBlockSenderDeleteResponseEnvelopeErrors struct {
	Code             int64                                                `json:"code" api:"required"`
	Message          string                                               `json:"message" api:"required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           SettingBlockSenderDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingBlockSenderDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingBlockSenderDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingBlockSenderDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderDeleteResponseEnvelopeErrorsSource ¶ 

type SettingBlockSenderDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    settingBlockSenderDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingBlockSenderDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingBlockSenderDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderDeleteResponseEnvelopeMessages ¶ 

type SettingBlockSenderDeleteResponseEnvelopeMessages struct {
	Code             int64                                                  `json:"code" api:"required"`
	Message          string                                                 `json:"message" api:"required"`
	DocumentationURL string                                                 `json:"documentation_url"`
	Source           SettingBlockSenderDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingBlockSenderDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingBlockSenderDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingBlockSenderDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderDeleteResponseEnvelopeMessagesSource ¶ 

type SettingBlockSenderDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                     `json:"pointer"`
	JSON    settingBlockSenderDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingBlockSenderDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingBlockSenderDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderDeleteResponseEnvelopeSuccess ¶ 

type SettingBlockSenderDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingBlockSenderDeleteResponseEnvelopeSuccessTrue SettingBlockSenderDeleteResponseEnvelopeSuccess = true
)

func (SettingBlockSenderDeleteResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingBlockSenderDeleteResponseEnvelopeSuccess) IsKnown() bool

type SettingBlockSenderEditParams ¶ 

type SettingBlockSenderEditParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Comments  param.Field[string] `json:"comments"`
	IsRegex   param.Field[bool]   `json:"is_regex"`
	Pattern   param.Field[string] `json:"pattern"`
	// Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when
	// creating or updating policies, but may be returned for existing entries.
	PatternType param.Field[SettingBlockSenderEditParamsPatternType] `json:"pattern_type"`
}

func (SettingBlockSenderEditParams) MarshalJSON ¶ 

func (r SettingBlockSenderEditParams) MarshalJSON() (data []byte, err error)

type SettingBlockSenderEditParamsPatternType ¶ 

type SettingBlockSenderEditParamsPatternType string

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries. 

const (
	SettingBlockSenderEditParamsPatternTypeEmail   SettingBlockSenderEditParamsPatternType = "EMAIL"
	SettingBlockSenderEditParamsPatternTypeDomain  SettingBlockSenderEditParamsPatternType = "DOMAIN"
	SettingBlockSenderEditParamsPatternTypeIP      SettingBlockSenderEditParamsPatternType = "IP"
	SettingBlockSenderEditParamsPatternTypeUnknown SettingBlockSenderEditParamsPatternType = "UNKNOWN"
)

func (SettingBlockSenderEditParamsPatternType) IsKnown ¶ 

func (r SettingBlockSenderEditParamsPatternType) IsKnown() bool

type SettingBlockSenderEditResponse ¶ 

type SettingBlockSenderEditResponse struct {
	// Blocked sender pattern identifier
	ID        string    `json:"id" format:"uuid"`
	Comments  string    `json:"comments" api:"nullable"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	IsRegex   bool      `json:"is_regex"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time `json:"modified_at" format:"date-time"`
	Pattern      string    `json:"pattern"`
	// Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when
	// creating or updating policies, but may be returned for existing entries.
	PatternType SettingBlockSenderEditResponsePatternType `json:"pattern_type"`
	JSON        settingBlockSenderEditResponseJSON        `json:"-"`
}

A blocked sender pattern

func (*SettingBlockSenderEditResponse) UnmarshalJSON ¶ 

func (r *SettingBlockSenderEditResponse) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderEditResponseEnvelope ¶ 

type SettingBlockSenderEditResponseEnvelope struct {
	Errors   []SettingBlockSenderEditResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingBlockSenderEditResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingBlockSenderEditResponseEnvelopeSuccess `json:"success" api:"required"`
	// A blocked sender pattern
	Result SettingBlockSenderEditResponse             `json:"result"`
	JSON   settingBlockSenderEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingBlockSenderEditResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingBlockSenderEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderEditResponseEnvelopeErrors ¶ 

type SettingBlockSenderEditResponseEnvelopeErrors struct {
	Code             int64                                              `json:"code" api:"required"`
	Message          string                                             `json:"message" api:"required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           SettingBlockSenderEditResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingBlockSenderEditResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingBlockSenderEditResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingBlockSenderEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderEditResponseEnvelopeErrorsSource ¶ 

type SettingBlockSenderEditResponseEnvelopeErrorsSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    settingBlockSenderEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingBlockSenderEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingBlockSenderEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderEditResponseEnvelopeMessages ¶ 

type SettingBlockSenderEditResponseEnvelopeMessages struct {
	Code             int64                                                `json:"code" api:"required"`
	Message          string                                               `json:"message" api:"required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           SettingBlockSenderEditResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingBlockSenderEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingBlockSenderEditResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingBlockSenderEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderEditResponseEnvelopeMessagesSource ¶ 

type SettingBlockSenderEditResponseEnvelopeMessagesSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    settingBlockSenderEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingBlockSenderEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingBlockSenderEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderEditResponseEnvelopeSuccess ¶ 

type SettingBlockSenderEditResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingBlockSenderEditResponseEnvelopeSuccessTrue SettingBlockSenderEditResponseEnvelopeSuccess = true
)

func (SettingBlockSenderEditResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingBlockSenderEditResponseEnvelopeSuccess) IsKnown() bool

type SettingBlockSenderEditResponsePatternType ¶ 

type SettingBlockSenderEditResponsePatternType string

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries. 

const (
	SettingBlockSenderEditResponsePatternTypeEmail   SettingBlockSenderEditResponsePatternType = "EMAIL"
	SettingBlockSenderEditResponsePatternTypeDomain  SettingBlockSenderEditResponsePatternType = "DOMAIN"
	SettingBlockSenderEditResponsePatternTypeIP      SettingBlockSenderEditResponsePatternType = "IP"
	SettingBlockSenderEditResponsePatternTypeUnknown SettingBlockSenderEditResponsePatternType = "UNKNOWN"
)

func (SettingBlockSenderEditResponsePatternType) IsKnown ¶ 

func (r SettingBlockSenderEditResponsePatternType) IsKnown() bool

type SettingBlockSenderGetParams ¶ 

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

type SettingBlockSenderGetResponse ¶ 

type SettingBlockSenderGetResponse struct {
	// Blocked sender pattern identifier
	ID        string    `json:"id" format:"uuid"`
	Comments  string    `json:"comments" api:"nullable"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	IsRegex   bool      `json:"is_regex"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time `json:"modified_at" format:"date-time"`
	Pattern      string    `json:"pattern"`
	// Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when
	// creating or updating policies, but may be returned for existing entries.
	PatternType SettingBlockSenderGetResponsePatternType `json:"pattern_type"`
	JSON        settingBlockSenderGetResponseJSON        `json:"-"`
}

A blocked sender pattern

func (*SettingBlockSenderGetResponse) UnmarshalJSON ¶ 

func (r *SettingBlockSenderGetResponse) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderGetResponseEnvelope ¶ 

type SettingBlockSenderGetResponseEnvelope struct {
	Errors   []SettingBlockSenderGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingBlockSenderGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingBlockSenderGetResponseEnvelopeSuccess `json:"success" api:"required"`
	// A blocked sender pattern
	Result SettingBlockSenderGetResponse             `json:"result"`
	JSON   settingBlockSenderGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingBlockSenderGetResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingBlockSenderGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderGetResponseEnvelopeErrors ¶ 

type SettingBlockSenderGetResponseEnvelopeErrors struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           SettingBlockSenderGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingBlockSenderGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingBlockSenderGetResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingBlockSenderGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderGetResponseEnvelopeErrorsSource ¶ 

type SettingBlockSenderGetResponseEnvelopeErrorsSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    settingBlockSenderGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingBlockSenderGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingBlockSenderGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderGetResponseEnvelopeMessages ¶ 

type SettingBlockSenderGetResponseEnvelopeMessages struct {
	Code             int64                                               `json:"code" api:"required"`
	Message          string                                              `json:"message" api:"required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           SettingBlockSenderGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingBlockSenderGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingBlockSenderGetResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingBlockSenderGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderGetResponseEnvelopeMessagesSource ¶ 

type SettingBlockSenderGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    settingBlockSenderGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingBlockSenderGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingBlockSenderGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderGetResponseEnvelopeSuccess ¶ 

type SettingBlockSenderGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingBlockSenderGetResponseEnvelopeSuccessTrue SettingBlockSenderGetResponseEnvelopeSuccess = true
)

func (SettingBlockSenderGetResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingBlockSenderGetResponseEnvelopeSuccess) IsKnown() bool

type SettingBlockSenderGetResponsePatternType ¶ 

type SettingBlockSenderGetResponsePatternType string

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries. 

const (
	SettingBlockSenderGetResponsePatternTypeEmail   SettingBlockSenderGetResponsePatternType = "EMAIL"
	SettingBlockSenderGetResponsePatternTypeDomain  SettingBlockSenderGetResponsePatternType = "DOMAIN"
	SettingBlockSenderGetResponsePatternTypeIP      SettingBlockSenderGetResponsePatternType = "IP"
	SettingBlockSenderGetResponsePatternTypeUnknown SettingBlockSenderGetResponsePatternType = "UNKNOWN"
)

func (SettingBlockSenderGetResponsePatternType) IsKnown ¶ 

func (r SettingBlockSenderGetResponsePatternType) IsKnown() bool

type SettingBlockSenderListParams ¶ 

type SettingBlockSenderListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The sorting direction.
	Direction param.Field[SettingBlockSenderListParamsDirection] `query:"direction"`
	// Field to sort by.
	Order param.Field[SettingBlockSenderListParamsOrder] `query:"order"`
	// Current page within paginated list of results.
	Page param.Field[int64] `query:"page"`
	// Filter by pattern value.
	Pattern param.Field[string] `query:"pattern"`
	// Filter by pattern type.
	PatternType param.Field[SettingBlockSenderListParamsPatternType] `query:"pattern_type"`
	// The number of results per page. Maximum value is 1000.
	PerPage param.Field[int64] `query:"per_page"`
	// Search term for filtering records. Behavior may change.
	Search param.Field[string] `query:"search"`
}

func (SettingBlockSenderListParams) URLQuery ¶ 

func (r SettingBlockSenderListParams) URLQuery() (v url.Values)

URLQuery serializes SettingBlockSenderListParams's query parameters as `url.Values`.

type SettingBlockSenderListParamsDirection ¶ 

type SettingBlockSenderListParamsDirection string

The sorting direction. 

const (
	SettingBlockSenderListParamsDirectionAsc  SettingBlockSenderListParamsDirection = "asc"
	SettingBlockSenderListParamsDirectionDesc SettingBlockSenderListParamsDirection = "desc"
)

func (SettingBlockSenderListParamsDirection) IsKnown ¶ 

func (r SettingBlockSenderListParamsDirection) IsKnown() bool

type SettingBlockSenderListParamsOrder ¶ 

type SettingBlockSenderListParamsOrder string

Field to sort by. 

const (
	SettingBlockSenderListParamsOrderPattern   SettingBlockSenderListParamsOrder = "pattern"
	SettingBlockSenderListParamsOrderCreatedAt SettingBlockSenderListParamsOrder = "created_at"
)

func (SettingBlockSenderListParamsOrder) IsKnown ¶ 

func (r SettingBlockSenderListParamsOrder) IsKnown() bool

type SettingBlockSenderListParamsPatternType ¶ 

type SettingBlockSenderListParamsPatternType string

Filter by pattern type. 

const (
	SettingBlockSenderListParamsPatternTypeEmail   SettingBlockSenderListParamsPatternType = "EMAIL"
	SettingBlockSenderListParamsPatternTypeDomain  SettingBlockSenderListParamsPatternType = "DOMAIN"
	SettingBlockSenderListParamsPatternTypeIP      SettingBlockSenderListParamsPatternType = "IP"
	SettingBlockSenderListParamsPatternTypeUnknown SettingBlockSenderListParamsPatternType = "UNKNOWN"
)

func (SettingBlockSenderListParamsPatternType) IsKnown ¶ 

func (r SettingBlockSenderListParamsPatternType) IsKnown() bool

type SettingBlockSenderListResponse ¶ 

type SettingBlockSenderListResponse struct {
	// Blocked sender pattern identifier
	ID        string    `json:"id" format:"uuid"`
	Comments  string    `json:"comments" api:"nullable"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	IsRegex   bool      `json:"is_regex"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time `json:"modified_at" format:"date-time"`
	Pattern      string    `json:"pattern"`
	// Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when
	// creating or updating policies, but may be returned for existing entries.
	PatternType SettingBlockSenderListResponsePatternType `json:"pattern_type"`
	JSON        settingBlockSenderListResponseJSON        `json:"-"`
}

A blocked sender pattern

func (*SettingBlockSenderListResponse) UnmarshalJSON ¶ 

func (r *SettingBlockSenderListResponse) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderListResponsePatternType ¶ 

type SettingBlockSenderListResponsePatternType string

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries. 

const (
	SettingBlockSenderListResponsePatternTypeEmail   SettingBlockSenderListResponsePatternType = "EMAIL"
	SettingBlockSenderListResponsePatternTypeDomain  SettingBlockSenderListResponsePatternType = "DOMAIN"
	SettingBlockSenderListResponsePatternTypeIP      SettingBlockSenderListResponsePatternType = "IP"
	SettingBlockSenderListResponsePatternTypeUnknown SettingBlockSenderListResponsePatternType = "UNKNOWN"
)

func (SettingBlockSenderListResponsePatternType) IsKnown ¶ 

func (r SettingBlockSenderListResponsePatternType) IsKnown() bool

type SettingBlockSenderNewParams ¶ 

type SettingBlockSenderNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	IsRegex   param.Field[bool]   `json:"is_regex" api:"required"`
	Pattern   param.Field[string] `json:"pattern" api:"required"`
	// Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when
	// creating or updating policies, but may be returned for existing entries.
	PatternType param.Field[SettingBlockSenderNewParamsPatternType] `json:"pattern_type" api:"required"`
	Comments    param.Field[string]                                 `json:"comments"`
}

func (SettingBlockSenderNewParams) MarshalJSON ¶ 

func (r SettingBlockSenderNewParams) MarshalJSON() (data []byte, err error)

type SettingBlockSenderNewParamsPatternType ¶ 

type SettingBlockSenderNewParamsPatternType string

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries. 

const (
	SettingBlockSenderNewParamsPatternTypeEmail   SettingBlockSenderNewParamsPatternType = "EMAIL"
	SettingBlockSenderNewParamsPatternTypeDomain  SettingBlockSenderNewParamsPatternType = "DOMAIN"
	SettingBlockSenderNewParamsPatternTypeIP      SettingBlockSenderNewParamsPatternType = "IP"
	SettingBlockSenderNewParamsPatternTypeUnknown SettingBlockSenderNewParamsPatternType = "UNKNOWN"
)

func (SettingBlockSenderNewParamsPatternType) IsKnown ¶ 

func (r SettingBlockSenderNewParamsPatternType) IsKnown() bool

type SettingBlockSenderNewResponse ¶ 

type SettingBlockSenderNewResponse struct {
	// Blocked sender pattern identifier
	ID        string    `json:"id" format:"uuid"`
	Comments  string    `json:"comments" api:"nullable"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	IsRegex   bool      `json:"is_regex"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time `json:"modified_at" format:"date-time"`
	Pattern      string    `json:"pattern"`
	// Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when
	// creating or updating policies, but may be returned for existing entries.
	PatternType SettingBlockSenderNewResponsePatternType `json:"pattern_type"`
	JSON        settingBlockSenderNewResponseJSON        `json:"-"`
}

A blocked sender pattern

func (*SettingBlockSenderNewResponse) UnmarshalJSON ¶ 

func (r *SettingBlockSenderNewResponse) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderNewResponseEnvelope ¶ 

type SettingBlockSenderNewResponseEnvelope struct {
	Errors   []SettingBlockSenderNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingBlockSenderNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingBlockSenderNewResponseEnvelopeSuccess `json:"success" api:"required"`
	// A blocked sender pattern
	Result SettingBlockSenderNewResponse             `json:"result"`
	JSON   settingBlockSenderNewResponseEnvelopeJSON `json:"-"`
}

func (*SettingBlockSenderNewResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingBlockSenderNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderNewResponseEnvelopeErrors ¶ 

type SettingBlockSenderNewResponseEnvelopeErrors struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           SettingBlockSenderNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingBlockSenderNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingBlockSenderNewResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingBlockSenderNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderNewResponseEnvelopeErrorsSource ¶ 

type SettingBlockSenderNewResponseEnvelopeErrorsSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    settingBlockSenderNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingBlockSenderNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingBlockSenderNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderNewResponseEnvelopeMessages ¶ 

type SettingBlockSenderNewResponseEnvelopeMessages struct {
	Code             int64                                               `json:"code" api:"required"`
	Message          string                                              `json:"message" api:"required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           SettingBlockSenderNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingBlockSenderNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingBlockSenderNewResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingBlockSenderNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderNewResponseEnvelopeMessagesSource ¶ 

type SettingBlockSenderNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    settingBlockSenderNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingBlockSenderNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingBlockSenderNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderNewResponseEnvelopeSuccess ¶ 

type SettingBlockSenderNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingBlockSenderNewResponseEnvelopeSuccessTrue SettingBlockSenderNewResponseEnvelopeSuccess = true
)

func (SettingBlockSenderNewResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingBlockSenderNewResponseEnvelopeSuccess) IsKnown() bool

type SettingBlockSenderNewResponsePatternType ¶ 

type SettingBlockSenderNewResponsePatternType string

Type of pattern matching. Note: UNKNOWN is deprecated and cannot be used when creating or updating policies, but may be returned for existing entries. 

const (
	SettingBlockSenderNewResponsePatternTypeEmail   SettingBlockSenderNewResponsePatternType = "EMAIL"
	SettingBlockSenderNewResponsePatternTypeDomain  SettingBlockSenderNewResponsePatternType = "DOMAIN"
	SettingBlockSenderNewResponsePatternTypeIP      SettingBlockSenderNewResponsePatternType = "IP"
	SettingBlockSenderNewResponsePatternTypeUnknown SettingBlockSenderNewResponsePatternType = "UNKNOWN"
)

func (SettingBlockSenderNewResponsePatternType) IsKnown ¶ 

func (r SettingBlockSenderNewResponsePatternType) IsKnown() bool

type SettingBlockSenderService ¶ 

type SettingBlockSenderService struct {
	Options []option.RequestOption
}

SettingBlockSenderService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSettingBlockSenderService method instead.

func NewSettingBlockSenderService ¶ 

func NewSettingBlockSenderService(opts ...option.RequestOption) (r *SettingBlockSenderService)

NewSettingBlockSenderService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SettingBlockSenderService) Delete ¶ 

func (r *SettingBlockSenderService) Delete(ctx context.Context, patternID string, body SettingBlockSenderDeleteParams, opts ...option.RequestOption) (res *SettingBlockSenderDeleteResponse, err error)

Removes a blocked sender pattern. After deletion, emails from this sender will no longer be automatically blocked based on this rule.

func (*SettingBlockSenderService) Edit ¶ 

func (r *SettingBlockSenderService) Edit(ctx context.Context, patternID string, params SettingBlockSenderEditParams, opts ...option.RequestOption) (res *SettingBlockSenderEditResponse, err error)

Updates an existing blocked sender pattern. Only provided fields will be modified. The pattern will continue blocking emails until deleted.

func (*SettingBlockSenderService) Get ¶ 

func (r *SettingBlockSenderService) Get(ctx context.Context, patternID string, query SettingBlockSenderGetParams, opts ...option.RequestOption) (res *SettingBlockSenderGetResponse, err error)

Retrieves details for a specific blocked sender pattern including its pattern type, value, and metadata.

func (*SettingBlockSenderService) List ¶ 

func (r *SettingBlockSenderService) List(ctx context.Context, params SettingBlockSenderListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SettingBlockSenderListResponse], err error)

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.

func (*SettingBlockSenderService) ListAutoPaging ¶ 

func (r *SettingBlockSenderService) ListAutoPaging(ctx context.Context, params SettingBlockSenderListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SettingBlockSenderListResponse]

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.

func (*SettingBlockSenderService) New ¶ 

func (r *SettingBlockSenderService) New(ctx context.Context, params SettingBlockSenderNewParams, opts ...option.RequestOption) (res *SettingBlockSenderNewResponse, err error)

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.

type SettingDomainDeleteParams ¶ 

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

type SettingDomainDeleteResponse ¶ 

type SettingDomainDeleteResponse struct {
	// Domain identifier
	ID   string                          `json:"id" api:"required" format:"uuid"`
	JSON settingDomainDeleteResponseJSON `json:"-"`
}

func (*SettingDomainDeleteResponse) UnmarshalJSON ¶ 

func (r *SettingDomainDeleteResponse) UnmarshalJSON(data []byte) (err error)

type SettingDomainDeleteResponseEnvelope ¶ 

type SettingDomainDeleteResponseEnvelope struct {
	Errors   []SettingDomainDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingDomainDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingDomainDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SettingDomainDeleteResponse                `json:"result"`
	JSON    settingDomainDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*SettingDomainDeleteResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingDomainDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingDomainDeleteResponseEnvelopeErrors ¶ 

type SettingDomainDeleteResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code" api:"required"`
	Message          string                                          `json:"message" api:"required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           SettingDomainDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingDomainDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingDomainDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingDomainDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingDomainDeleteResponseEnvelopeErrorsSource ¶ 

type SettingDomainDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    settingDomainDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingDomainDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingDomainDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingDomainDeleteResponseEnvelopeMessages ¶ 

type SettingDomainDeleteResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           SettingDomainDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingDomainDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingDomainDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingDomainDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingDomainDeleteResponseEnvelopeMessagesSource ¶ 

type SettingDomainDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    settingDomainDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingDomainDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingDomainDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingDomainDeleteResponseEnvelopeSuccess ¶ 

type SettingDomainDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingDomainDeleteResponseEnvelopeSuccessTrue SettingDomainDeleteResponseEnvelopeSuccess = true
)

func (SettingDomainDeleteResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingDomainDeleteResponseEnvelopeSuccess) IsKnown() bool

type SettingDomainEditParams ¶ 

type SettingDomainEditParams struct {
	// Identifier.
	AccountID            param.Field[string]                                       `path:"account_id" api:"required"`
	AllowedDeliveryModes param.Field[[]SettingDomainEditParamsAllowedDeliveryMode] `json:"allowed_delivery_modes"`
	Domain               param.Field[string]                                       `json:"domain"`
	DropDispositions     param.Field[[]SettingDomainEditParamsDropDisposition]     `json:"drop_dispositions"`
	Folder               param.Field[SettingDomainEditParamsFolder]                `json:"folder"`
	IntegrationID        param.Field[string]                                       `json:"integration_id" format:"uuid"`
	IPRestrictions       param.Field[[]string]                                     `json:"ip_restrictions"`
	LookbackHops         param.Field[int64]                                        `json:"lookback_hops"`
	Regions              param.Field[[]SettingDomainEditParamsRegion]              `json:"regions"`
	RequireTLSInbound    param.Field[bool]                                         `json:"require_tls_inbound"`
	RequireTLSOutbound   param.Field[bool]                                         `json:"require_tls_outbound"`
	Transport            param.Field[string]                                       `json:"transport"`
}

func (SettingDomainEditParams) MarshalJSON ¶ 

func (r SettingDomainEditParams) MarshalJSON() (data []byte, err error)

type SettingDomainEditParamsAllowedDeliveryMode ¶ 

type SettingDomainEditParamsAllowedDeliveryMode string
const (
	SettingDomainEditParamsAllowedDeliveryModeDirect    SettingDomainEditParamsAllowedDeliveryMode = "DIRECT"
	SettingDomainEditParamsAllowedDeliveryModeBcc       SettingDomainEditParamsAllowedDeliveryMode = "BCC"
	SettingDomainEditParamsAllowedDeliveryModeJournal   SettingDomainEditParamsAllowedDeliveryMode = "JOURNAL"
	SettingDomainEditParamsAllowedDeliveryModeAPI       SettingDomainEditParamsAllowedDeliveryMode = "API"
	SettingDomainEditParamsAllowedDeliveryModeRetroScan SettingDomainEditParamsAllowedDeliveryMode = "RETRO_SCAN"
)

func (SettingDomainEditParamsAllowedDeliveryMode) IsKnown ¶ 

func (r SettingDomainEditParamsAllowedDeliveryMode) IsKnown() bool

type SettingDomainEditParamsDropDisposition ¶ 

type SettingDomainEditParamsDropDisposition string
const (
	SettingDomainEditParamsDropDispositionMalicious    SettingDomainEditParamsDropDisposition = "MALICIOUS"
	SettingDomainEditParamsDropDispositionMaliciousBec SettingDomainEditParamsDropDisposition = "MALICIOUS-BEC"
	SettingDomainEditParamsDropDispositionSuspicious   SettingDomainEditParamsDropDisposition = "SUSPICIOUS"
	SettingDomainEditParamsDropDispositionSpoof        SettingDomainEditParamsDropDisposition = "SPOOF"
	SettingDomainEditParamsDropDispositionSpam         SettingDomainEditParamsDropDisposition = "SPAM"
	SettingDomainEditParamsDropDispositionBulk         SettingDomainEditParamsDropDisposition = "BULK"
	SettingDomainEditParamsDropDispositionEncrypted    SettingDomainEditParamsDropDisposition = "ENCRYPTED"
	SettingDomainEditParamsDropDispositionExternal     SettingDomainEditParamsDropDisposition = "EXTERNAL"
	SettingDomainEditParamsDropDispositionUnknown      SettingDomainEditParamsDropDisposition = "UNKNOWN"
	SettingDomainEditParamsDropDispositionNone         SettingDomainEditParamsDropDisposition = "NONE"
)

func (SettingDomainEditParamsDropDisposition) IsKnown ¶ 

func (r SettingDomainEditParamsDropDisposition) IsKnown() bool

type SettingDomainEditParamsFolder ¶ 

type SettingDomainEditParamsFolder string
const (
	SettingDomainEditParamsFolderAllItems SettingDomainEditParamsFolder = "AllItems"
	SettingDomainEditParamsFolderInbox    SettingDomainEditParamsFolder = "Inbox"
)

func (SettingDomainEditParamsFolder) IsKnown ¶ 

func (r SettingDomainEditParamsFolder) IsKnown() bool

type SettingDomainEditParamsRegion ¶ 

type SettingDomainEditParamsRegion string
const (
	SettingDomainEditParamsRegionGlobal SettingDomainEditParamsRegion = "GLOBAL"
	SettingDomainEditParamsRegionAu     SettingDomainEditParamsRegion = "AU"
	SettingDomainEditParamsRegionDe     SettingDomainEditParamsRegion = "DE"
	SettingDomainEditParamsRegionIn     SettingDomainEditParamsRegion = "IN"
	SettingDomainEditParamsRegionUs     SettingDomainEditParamsRegion = "US"
)

func (SettingDomainEditParamsRegion) IsKnown ¶ 

func (r SettingDomainEditParamsRegion) IsKnown() bool

type SettingDomainEditResponse ¶ 

type SettingDomainEditResponse struct {
	// Domain identifier
	ID                   string                                         `json:"id" format:"uuid"`
	AllowedDeliveryModes []SettingDomainEditResponseAllowedDeliveryMode `json:"allowed_delivery_modes"`
	Authorization        SettingDomainEditResponseAuthorization         `json:"authorization"`
	CreatedAt            time.Time                                      `json:"created_at" format:"date-time"`
	DMARCStatus          SettingDomainEditResponseDMARCStatus           `json:"dmarc_status"`
	Domain               string                                         `json:"domain"`
	DropDispositions     []SettingDomainEditResponseDropDisposition     `json:"drop_dispositions"`
	EmailsProcessed      SettingDomainEditResponseEmailsProcessed       `json:"emails_processed"`
	Folder               SettingDomainEditResponseFolder                `json:"folder"`
	InboxProvider        SettingDomainEditResponseInboxProvider         `json:"inbox_provider" api:"nullable"`
	IntegrationID        string                                         `json:"integration_id" api:"nullable" format:"uuid"`
	IPRestrictions       []string                                       `json:"ip_restrictions"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified       time.Time                          `json:"last_modified" format:"date-time"`
	LookbackHops       int64                              `json:"lookback_hops"`
	ModifiedAt         time.Time                          `json:"modified_at" format:"date-time"`
	O365TenantID       string                             `json:"o365_tenant_id" api:"nullable"`
	Regions            []SettingDomainEditResponseRegion  `json:"regions"`
	RequireTLSInbound  bool                               `json:"require_tls_inbound" api:"nullable"`
	RequireTLSOutbound bool                               `json:"require_tls_outbound" api:"nullable"`
	SPFStatus          SettingDomainEditResponseSPFStatus `json:"spf_status"`
	Status             SettingDomainEditResponseStatus    `json:"status"`
	Transport          string                             `json:"transport"`
	JSON               settingDomainEditResponseJSON      `json:"-"`
}

func (*SettingDomainEditResponse) UnmarshalJSON ¶ 

func (r *SettingDomainEditResponse) UnmarshalJSON(data []byte) (err error)

type SettingDomainEditResponseAllowedDeliveryMode ¶ 

type SettingDomainEditResponseAllowedDeliveryMode string
const (
	SettingDomainEditResponseAllowedDeliveryModeDirect    SettingDomainEditResponseAllowedDeliveryMode = "DIRECT"
	SettingDomainEditResponseAllowedDeliveryModeBcc       SettingDomainEditResponseAllowedDeliveryMode = "BCC"
	SettingDomainEditResponseAllowedDeliveryModeJournal   SettingDomainEditResponseAllowedDeliveryMode = "JOURNAL"
	SettingDomainEditResponseAllowedDeliveryModeAPI       SettingDomainEditResponseAllowedDeliveryMode = "API"
	SettingDomainEditResponseAllowedDeliveryModeRetroScan SettingDomainEditResponseAllowedDeliveryMode = "RETRO_SCAN"
)

func (SettingDomainEditResponseAllowedDeliveryMode) IsKnown ¶ 

func (r SettingDomainEditResponseAllowedDeliveryMode) IsKnown() bool

type SettingDomainEditResponseAuthorization ¶ 

type SettingDomainEditResponseAuthorization struct {
	Authorized    bool                                       `json:"authorized" api:"required"`
	Timestamp     time.Time                                  `json:"timestamp" api:"required" format:"date-time"`
	StatusMessage string                                     `json:"status_message" api:"nullable"`
	JSON          settingDomainEditResponseAuthorizationJSON `json:"-"`
}

func (*SettingDomainEditResponseAuthorization) UnmarshalJSON ¶ 

func (r *SettingDomainEditResponseAuthorization) UnmarshalJSON(data []byte) (err error)

type SettingDomainEditResponseDMARCStatus ¶ 

type SettingDomainEditResponseDMARCStatus string
const (
	SettingDomainEditResponseDMARCStatusNone    SettingDomainEditResponseDMARCStatus = "none"
	SettingDomainEditResponseDMARCStatusGood    SettingDomainEditResponseDMARCStatus = "good"
	SettingDomainEditResponseDMARCStatusInvalid SettingDomainEditResponseDMARCStatus = "invalid"
)

func (SettingDomainEditResponseDMARCStatus) IsKnown ¶ 

func (r SettingDomainEditResponseDMARCStatus) IsKnown() bool

type SettingDomainEditResponseDropDisposition ¶ 

type SettingDomainEditResponseDropDisposition string
const (
	SettingDomainEditResponseDropDispositionMalicious    SettingDomainEditResponseDropDisposition = "MALICIOUS"
	SettingDomainEditResponseDropDispositionMaliciousBec SettingDomainEditResponseDropDisposition = "MALICIOUS-BEC"
	SettingDomainEditResponseDropDispositionSuspicious   SettingDomainEditResponseDropDisposition = "SUSPICIOUS"
	SettingDomainEditResponseDropDispositionSpoof        SettingDomainEditResponseDropDisposition = "SPOOF"
	SettingDomainEditResponseDropDispositionSpam         SettingDomainEditResponseDropDisposition = "SPAM"
	SettingDomainEditResponseDropDispositionBulk         SettingDomainEditResponseDropDisposition = "BULK"
	SettingDomainEditResponseDropDispositionEncrypted    SettingDomainEditResponseDropDisposition = "ENCRYPTED"
	SettingDomainEditResponseDropDispositionExternal     SettingDomainEditResponseDropDisposition = "EXTERNAL"
	SettingDomainEditResponseDropDispositionUnknown      SettingDomainEditResponseDropDisposition = "UNKNOWN"
	SettingDomainEditResponseDropDispositionNone         SettingDomainEditResponseDropDisposition = "NONE"
)

func (SettingDomainEditResponseDropDisposition) IsKnown ¶ 

func (r SettingDomainEditResponseDropDisposition) IsKnown() bool

type SettingDomainEditResponseEmailsProcessed ¶ 

type SettingDomainEditResponseEmailsProcessed struct {
	Timestamp                    time.Time                                    `json:"timestamp" api:"required" format:"date-time"`
	TotalEmailsProcessed         int64                                        `json:"total_emails_processed" api:"required"`
	TotalEmailsProcessedPrevious int64                                        `json:"total_emails_processed_previous" api:"required"`
	JSON                         settingDomainEditResponseEmailsProcessedJSON `json:"-"`
}

func (*SettingDomainEditResponseEmailsProcessed) UnmarshalJSON ¶ 

func (r *SettingDomainEditResponseEmailsProcessed) UnmarshalJSON(data []byte) (err error)

type SettingDomainEditResponseEnvelope ¶ 

type SettingDomainEditResponseEnvelope struct {
	Errors   []SettingDomainEditResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingDomainEditResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingDomainEditResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SettingDomainEditResponse                `json:"result"`
	JSON    settingDomainEditResponseEnvelopeJSON    `json:"-"`
}

func (*SettingDomainEditResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingDomainEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingDomainEditResponseEnvelopeErrors ¶ 

type SettingDomainEditResponseEnvelopeErrors struct {
	Code             int64                                         `json:"code" api:"required"`
	Message          string                                        `json:"message" api:"required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           SettingDomainEditResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingDomainEditResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingDomainEditResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingDomainEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingDomainEditResponseEnvelopeErrorsSource ¶ 

type SettingDomainEditResponseEnvelopeErrorsSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    settingDomainEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingDomainEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingDomainEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingDomainEditResponseEnvelopeMessages ¶ 

type SettingDomainEditResponseEnvelopeMessages struct {
	Code             int64                                           `json:"code" api:"required"`
	Message          string                                          `json:"message" api:"required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           SettingDomainEditResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingDomainEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingDomainEditResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingDomainEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingDomainEditResponseEnvelopeMessagesSource ¶ 

type SettingDomainEditResponseEnvelopeMessagesSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    settingDomainEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingDomainEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingDomainEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingDomainEditResponseEnvelopeSuccess ¶ 

type SettingDomainEditResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingDomainEditResponseEnvelopeSuccessTrue SettingDomainEditResponseEnvelopeSuccess = true
)

func (SettingDomainEditResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingDomainEditResponseEnvelopeSuccess) IsKnown() bool

type SettingDomainEditResponseFolder ¶ 

type SettingDomainEditResponseFolder string
const (
	SettingDomainEditResponseFolderAllItems SettingDomainEditResponseFolder = "AllItems"
	SettingDomainEditResponseFolderInbox    SettingDomainEditResponseFolder = "Inbox"
)

func (SettingDomainEditResponseFolder) IsKnown ¶ 

func (r SettingDomainEditResponseFolder) IsKnown() bool

type SettingDomainEditResponseInboxProvider ¶ 

type SettingDomainEditResponseInboxProvider string
const (
	SettingDomainEditResponseInboxProviderMicrosoft SettingDomainEditResponseInboxProvider = "Microsoft"
	SettingDomainEditResponseInboxProviderGoogle    SettingDomainEditResponseInboxProvider = "Google"
)

func (SettingDomainEditResponseInboxProvider) IsKnown ¶ 

func (r SettingDomainEditResponseInboxProvider) IsKnown() bool

type SettingDomainEditResponseRegion ¶ 

type SettingDomainEditResponseRegion string
const (
	SettingDomainEditResponseRegionGlobal SettingDomainEditResponseRegion = "GLOBAL"
	SettingDomainEditResponseRegionAu     SettingDomainEditResponseRegion = "AU"
	SettingDomainEditResponseRegionDe     SettingDomainEditResponseRegion = "DE"
	SettingDomainEditResponseRegionIn     SettingDomainEditResponseRegion = "IN"
	SettingDomainEditResponseRegionUs     SettingDomainEditResponseRegion = "US"
)

func (SettingDomainEditResponseRegion) IsKnown ¶ 

func (r SettingDomainEditResponseRegion) IsKnown() bool

type SettingDomainEditResponseSPFStatus ¶ 

type SettingDomainEditResponseSPFStatus string
const (
	SettingDomainEditResponseSPFStatusNone    SettingDomainEditResponseSPFStatus = "none"
	SettingDomainEditResponseSPFStatusGood    SettingDomainEditResponseSPFStatus = "good"
	SettingDomainEditResponseSPFStatusNeutral SettingDomainEditResponseSPFStatus = "neutral"
	SettingDomainEditResponseSPFStatusOpen    SettingDomainEditResponseSPFStatus = "open"
	SettingDomainEditResponseSPFStatusInvalid SettingDomainEditResponseSPFStatus = "invalid"
)

func (SettingDomainEditResponseSPFStatus) IsKnown ¶ 

func (r SettingDomainEditResponseSPFStatus) IsKnown() bool

type SettingDomainEditResponseStatus ¶ 

type SettingDomainEditResponseStatus string
const (
	SettingDomainEditResponseStatusPending SettingDomainEditResponseStatus = "pending"
	SettingDomainEditResponseStatusActive  SettingDomainEditResponseStatus = "active"
	SettingDomainEditResponseStatusFailed  SettingDomainEditResponseStatus = "failed"
	SettingDomainEditResponseStatusTimeout SettingDomainEditResponseStatus = "timeout"
)

func (SettingDomainEditResponseStatus) IsKnown ¶ 

func (r SettingDomainEditResponseStatus) IsKnown() bool

type SettingDomainGetParams ¶ 

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

type SettingDomainGetResponse ¶ 

type SettingDomainGetResponse struct {
	// Domain identifier
	ID                   string                                        `json:"id" format:"uuid"`
	AllowedDeliveryModes []SettingDomainGetResponseAllowedDeliveryMode `json:"allowed_delivery_modes"`
	Authorization        SettingDomainGetResponseAuthorization         `json:"authorization"`
	CreatedAt            time.Time                                     `json:"created_at" format:"date-time"`
	DMARCStatus          SettingDomainGetResponseDMARCStatus           `json:"dmarc_status"`
	Domain               string                                        `json:"domain"`
	DropDispositions     []SettingDomainGetResponseDropDisposition     `json:"drop_dispositions"`
	EmailsProcessed      SettingDomainGetResponseEmailsProcessed       `json:"emails_processed"`
	Folder               SettingDomainGetResponseFolder                `json:"folder"`
	InboxProvider        SettingDomainGetResponseInboxProvider         `json:"inbox_provider" api:"nullable"`
	IntegrationID        string                                        `json:"integration_id" api:"nullable" format:"uuid"`
	IPRestrictions       []string                                      `json:"ip_restrictions"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified       time.Time                         `json:"last_modified" format:"date-time"`
	LookbackHops       int64                             `json:"lookback_hops"`
	ModifiedAt         time.Time                         `json:"modified_at" format:"date-time"`
	O365TenantID       string                            `json:"o365_tenant_id" api:"nullable"`
	Regions            []SettingDomainGetResponseRegion  `json:"regions"`
	RequireTLSInbound  bool                              `json:"require_tls_inbound" api:"nullable"`
	RequireTLSOutbound bool                              `json:"require_tls_outbound" api:"nullable"`
	SPFStatus          SettingDomainGetResponseSPFStatus `json:"spf_status"`
	Status             SettingDomainGetResponseStatus    `json:"status"`
	Transport          string                            `json:"transport"`
	JSON               settingDomainGetResponseJSON      `json:"-"`
}

func (*SettingDomainGetResponse) UnmarshalJSON ¶ 

func (r *SettingDomainGetResponse) UnmarshalJSON(data []byte) (err error)

type SettingDomainGetResponseAllowedDeliveryMode ¶ 

type SettingDomainGetResponseAllowedDeliveryMode string
const (
	SettingDomainGetResponseAllowedDeliveryModeDirect    SettingDomainGetResponseAllowedDeliveryMode = "DIRECT"
	SettingDomainGetResponseAllowedDeliveryModeBcc       SettingDomainGetResponseAllowedDeliveryMode = "BCC"
	SettingDomainGetResponseAllowedDeliveryModeJournal   SettingDomainGetResponseAllowedDeliveryMode = "JOURNAL"
	SettingDomainGetResponseAllowedDeliveryModeAPI       SettingDomainGetResponseAllowedDeliveryMode = "API"
	SettingDomainGetResponseAllowedDeliveryModeRetroScan SettingDomainGetResponseAllowedDeliveryMode = "RETRO_SCAN"
)

func (SettingDomainGetResponseAllowedDeliveryMode) IsKnown ¶ 

func (r SettingDomainGetResponseAllowedDeliveryMode) IsKnown() bool

type SettingDomainGetResponseAuthorization ¶ 

type SettingDomainGetResponseAuthorization struct {
	Authorized    bool                                      `json:"authorized" api:"required"`
	Timestamp     time.Time                                 `json:"timestamp" api:"required" format:"date-time"`
	StatusMessage string                                    `json:"status_message" api:"nullable"`
	JSON          settingDomainGetResponseAuthorizationJSON `json:"-"`
}

func (*SettingDomainGetResponseAuthorization) UnmarshalJSON ¶ 

func (r *SettingDomainGetResponseAuthorization) UnmarshalJSON(data []byte) (err error)

type SettingDomainGetResponseDMARCStatus ¶ 

type SettingDomainGetResponseDMARCStatus string
const (
	SettingDomainGetResponseDMARCStatusNone    SettingDomainGetResponseDMARCStatus = "none"
	SettingDomainGetResponseDMARCStatusGood    SettingDomainGetResponseDMARCStatus = "good"
	SettingDomainGetResponseDMARCStatusInvalid SettingDomainGetResponseDMARCStatus = "invalid"
)

func (SettingDomainGetResponseDMARCStatus) IsKnown ¶ 

func (r SettingDomainGetResponseDMARCStatus) IsKnown() bool

type SettingDomainGetResponseDropDisposition ¶ 

type SettingDomainGetResponseDropDisposition string
const (
	SettingDomainGetResponseDropDispositionMalicious    SettingDomainGetResponseDropDisposition = "MALICIOUS"
	SettingDomainGetResponseDropDispositionMaliciousBec SettingDomainGetResponseDropDisposition = "MALICIOUS-BEC"
	SettingDomainGetResponseDropDispositionSuspicious   SettingDomainGetResponseDropDisposition = "SUSPICIOUS"
	SettingDomainGetResponseDropDispositionSpoof        SettingDomainGetResponseDropDisposition = "SPOOF"
	SettingDomainGetResponseDropDispositionSpam         SettingDomainGetResponseDropDisposition = "SPAM"
	SettingDomainGetResponseDropDispositionBulk         SettingDomainGetResponseDropDisposition = "BULK"
	SettingDomainGetResponseDropDispositionEncrypted    SettingDomainGetResponseDropDisposition = "ENCRYPTED"
	SettingDomainGetResponseDropDispositionExternal     SettingDomainGetResponseDropDisposition = "EXTERNAL"
	SettingDomainGetResponseDropDispositionUnknown      SettingDomainGetResponseDropDisposition = "UNKNOWN"
	SettingDomainGetResponseDropDispositionNone         SettingDomainGetResponseDropDisposition = "NONE"
)

func (SettingDomainGetResponseDropDisposition) IsKnown ¶ 

func (r SettingDomainGetResponseDropDisposition) IsKnown() bool

type SettingDomainGetResponseEmailsProcessed ¶ 

type SettingDomainGetResponseEmailsProcessed struct {
	Timestamp                    time.Time                                   `json:"timestamp" api:"required" format:"date-time"`
	TotalEmailsProcessed         int64                                       `json:"total_emails_processed" api:"required"`
	TotalEmailsProcessedPrevious int64                                       `json:"total_emails_processed_previous" api:"required"`
	JSON                         settingDomainGetResponseEmailsProcessedJSON `json:"-"`
}

func (*SettingDomainGetResponseEmailsProcessed) UnmarshalJSON ¶ 

func (r *SettingDomainGetResponseEmailsProcessed) UnmarshalJSON(data []byte) (err error)

type SettingDomainGetResponseEnvelope ¶ 

type SettingDomainGetResponseEnvelope struct {
	Errors   []SettingDomainGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingDomainGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingDomainGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SettingDomainGetResponse                `json:"result"`
	JSON    settingDomainGetResponseEnvelopeJSON    `json:"-"`
}

func (*SettingDomainGetResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingDomainGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingDomainGetResponseEnvelopeErrors ¶ 

type SettingDomainGetResponseEnvelopeErrors struct {
	Code             int64                                        `json:"code" api:"required"`
	Message          string                                       `json:"message" api:"required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           SettingDomainGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingDomainGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingDomainGetResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingDomainGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingDomainGetResponseEnvelopeErrorsSource ¶ 

type SettingDomainGetResponseEnvelopeErrorsSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    settingDomainGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingDomainGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingDomainGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingDomainGetResponseEnvelopeMessages ¶ 

type SettingDomainGetResponseEnvelopeMessages struct {
	Code             int64                                          `json:"code" api:"required"`
	Message          string                                         `json:"message" api:"required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           SettingDomainGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingDomainGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingDomainGetResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingDomainGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingDomainGetResponseEnvelopeMessagesSource ¶ 

type SettingDomainGetResponseEnvelopeMessagesSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    settingDomainGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingDomainGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingDomainGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingDomainGetResponseEnvelopeSuccess ¶ 

type SettingDomainGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingDomainGetResponseEnvelopeSuccessTrue SettingDomainGetResponseEnvelopeSuccess = true
)

func (SettingDomainGetResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingDomainGetResponseEnvelopeSuccess) IsKnown() bool

type SettingDomainGetResponseFolder ¶ 

type SettingDomainGetResponseFolder string
const (
	SettingDomainGetResponseFolderAllItems SettingDomainGetResponseFolder = "AllItems"
	SettingDomainGetResponseFolderInbox    SettingDomainGetResponseFolder = "Inbox"
)

func (SettingDomainGetResponseFolder) IsKnown ¶ 

func (r SettingDomainGetResponseFolder) IsKnown() bool

type SettingDomainGetResponseInboxProvider ¶ 

type SettingDomainGetResponseInboxProvider string
const (
	SettingDomainGetResponseInboxProviderMicrosoft SettingDomainGetResponseInboxProvider = "Microsoft"
	SettingDomainGetResponseInboxProviderGoogle    SettingDomainGetResponseInboxProvider = "Google"
)

func (SettingDomainGetResponseInboxProvider) IsKnown ¶ 

func (r SettingDomainGetResponseInboxProvider) IsKnown() bool

type SettingDomainGetResponseRegion ¶ 

type SettingDomainGetResponseRegion string
const (
	SettingDomainGetResponseRegionGlobal SettingDomainGetResponseRegion = "GLOBAL"
	SettingDomainGetResponseRegionAu     SettingDomainGetResponseRegion = "AU"
	SettingDomainGetResponseRegionDe     SettingDomainGetResponseRegion = "DE"
	SettingDomainGetResponseRegionIn     SettingDomainGetResponseRegion = "IN"
	SettingDomainGetResponseRegionUs     SettingDomainGetResponseRegion = "US"
)

func (SettingDomainGetResponseRegion) IsKnown ¶ 

func (r SettingDomainGetResponseRegion) IsKnown() bool

type SettingDomainGetResponseSPFStatus ¶ 

type SettingDomainGetResponseSPFStatus string
const (
	SettingDomainGetResponseSPFStatusNone    SettingDomainGetResponseSPFStatus = "none"
	SettingDomainGetResponseSPFStatusGood    SettingDomainGetResponseSPFStatus = "good"
	SettingDomainGetResponseSPFStatusNeutral SettingDomainGetResponseSPFStatus = "neutral"
	SettingDomainGetResponseSPFStatusOpen    SettingDomainGetResponseSPFStatus = "open"
	SettingDomainGetResponseSPFStatusInvalid SettingDomainGetResponseSPFStatus = "invalid"
)

func (SettingDomainGetResponseSPFStatus) IsKnown ¶ 

func (r SettingDomainGetResponseSPFStatus) IsKnown() bool

type SettingDomainGetResponseStatus ¶ 

type SettingDomainGetResponseStatus string
const (
	SettingDomainGetResponseStatusPending SettingDomainGetResponseStatus = "pending"
	SettingDomainGetResponseStatusActive  SettingDomainGetResponseStatus = "active"
	SettingDomainGetResponseStatusFailed  SettingDomainGetResponseStatus = "failed"
	SettingDomainGetResponseStatusTimeout SettingDomainGetResponseStatus = "timeout"
)

func (SettingDomainGetResponseStatus) IsKnown ¶ 

func (r SettingDomainGetResponseStatus) IsKnown() bool

type SettingDomainListParams ¶ 

type SettingDomainListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Currently active delivery mode to filter by.
	ActiveDeliveryMode param.Field[SettingDomainListParamsActiveDeliveryMode] `query:"active_delivery_mode"`
	// Delivery mode to filter by.
	AllowedDeliveryMode param.Field[SettingDomainListParamsAllowedDeliveryMode] `query:"allowed_delivery_mode"`
	// The sorting direction.
	Direction param.Field[SettingDomainListParamsDirection] `query:"direction"`
	// Domain names to filter by.
	Domain param.Field[[]string] `query:"domain"`
	// Integration ID to filter by.
	IntegrationID param.Field[string] `query:"integration_id" format:"uuid"`
	// Field to sort by.
	Order param.Field[SettingDomainListParamsOrder] `query:"order"`
	// Current page within paginated list of results.
	Page param.Field[int64] `query:"page"`
	// The number of results per page. Maximum value is 1000.
	PerPage param.Field[int64] `query:"per_page"`
	// Search term for filtering records. Behavior may change.
	Search param.Field[string] `query:"search"`
	// Filters response to domains with the provided status.
	Status param.Field[SettingDomainListParamsStatus] `query:"status"`
}

func (SettingDomainListParams) URLQuery ¶ 

func (r SettingDomainListParams) URLQuery() (v url.Values)

URLQuery serializes SettingDomainListParams's query parameters as `url.Values`.

type SettingDomainListParamsActiveDeliveryMode ¶ 

type SettingDomainListParamsActiveDeliveryMode string

Currently active delivery mode to filter by. 

const (
	SettingDomainListParamsActiveDeliveryModeDirect    SettingDomainListParamsActiveDeliveryMode = "DIRECT"
	SettingDomainListParamsActiveDeliveryModeBcc       SettingDomainListParamsActiveDeliveryMode = "BCC"
	SettingDomainListParamsActiveDeliveryModeJournal   SettingDomainListParamsActiveDeliveryMode = "JOURNAL"
	SettingDomainListParamsActiveDeliveryModeAPI       SettingDomainListParamsActiveDeliveryMode = "API"
	SettingDomainListParamsActiveDeliveryModeRetroScan SettingDomainListParamsActiveDeliveryMode = "RETRO_SCAN"
)

func (SettingDomainListParamsActiveDeliveryMode) IsKnown ¶ 

func (r SettingDomainListParamsActiveDeliveryMode) IsKnown() bool

type SettingDomainListParamsAllowedDeliveryMode ¶ 

type SettingDomainListParamsAllowedDeliveryMode string

Delivery mode to filter by. 

const (
	SettingDomainListParamsAllowedDeliveryModeDirect    SettingDomainListParamsAllowedDeliveryMode = "DIRECT"
	SettingDomainListParamsAllowedDeliveryModeBcc       SettingDomainListParamsAllowedDeliveryMode = "BCC"
	SettingDomainListParamsAllowedDeliveryModeJournal   SettingDomainListParamsAllowedDeliveryMode = "JOURNAL"
	SettingDomainListParamsAllowedDeliveryModeAPI       SettingDomainListParamsAllowedDeliveryMode = "API"
	SettingDomainListParamsAllowedDeliveryModeRetroScan SettingDomainListParamsAllowedDeliveryMode = "RETRO_SCAN"
)

func (SettingDomainListParamsAllowedDeliveryMode) IsKnown ¶ 

func (r SettingDomainListParamsAllowedDeliveryMode) IsKnown() bool

type SettingDomainListParamsDirection ¶ 

type SettingDomainListParamsDirection string

The sorting direction. 

const (
	SettingDomainListParamsDirectionAsc  SettingDomainListParamsDirection = "asc"
	SettingDomainListParamsDirectionDesc SettingDomainListParamsDirection = "desc"
)

func (SettingDomainListParamsDirection) IsKnown ¶ 

func (r SettingDomainListParamsDirection) IsKnown() bool

type SettingDomainListParamsOrder ¶ 

type SettingDomainListParamsOrder string

Field to sort by. 

const (
	SettingDomainListParamsOrderDomain    SettingDomainListParamsOrder = "domain"
	SettingDomainListParamsOrderCreatedAt SettingDomainListParamsOrder = "created_at"
)

func (SettingDomainListParamsOrder) IsKnown ¶ 

func (r SettingDomainListParamsOrder) IsKnown() bool

type SettingDomainListParamsStatus ¶ 

type SettingDomainListParamsStatus string

Filters response to domains with the provided status. 

const (
	SettingDomainListParamsStatusPending SettingDomainListParamsStatus = "pending"
	SettingDomainListParamsStatusActive  SettingDomainListParamsStatus = "active"
	SettingDomainListParamsStatusFailed  SettingDomainListParamsStatus = "failed"
	SettingDomainListParamsStatusTimeout SettingDomainListParamsStatus = "timeout"
)

func (SettingDomainListParamsStatus) IsKnown ¶ 

func (r SettingDomainListParamsStatus) IsKnown() bool

type SettingDomainListResponse ¶ 

type SettingDomainListResponse struct {
	// Domain identifier
	ID                   string                                         `json:"id" format:"uuid"`
	AllowedDeliveryModes []SettingDomainListResponseAllowedDeliveryMode `json:"allowed_delivery_modes"`
	Authorization        SettingDomainListResponseAuthorization         `json:"authorization"`
	CreatedAt            time.Time                                      `json:"created_at" format:"date-time"`
	DMARCStatus          SettingDomainListResponseDMARCStatus           `json:"dmarc_status"`
	Domain               string                                         `json:"domain"`
	DropDispositions     []SettingDomainListResponseDropDisposition     `json:"drop_dispositions"`
	EmailsProcessed      SettingDomainListResponseEmailsProcessed       `json:"emails_processed"`
	Folder               SettingDomainListResponseFolder                `json:"folder"`
	InboxProvider        SettingDomainListResponseInboxProvider         `json:"inbox_provider" api:"nullable"`
	IntegrationID        string                                         `json:"integration_id" api:"nullable" format:"uuid"`
	IPRestrictions       []string                                       `json:"ip_restrictions"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified       time.Time                          `json:"last_modified" format:"date-time"`
	LookbackHops       int64                              `json:"lookback_hops"`
	ModifiedAt         time.Time                          `json:"modified_at" format:"date-time"`
	O365TenantID       string                             `json:"o365_tenant_id" api:"nullable"`
	Regions            []SettingDomainListResponseRegion  `json:"regions"`
	RequireTLSInbound  bool                               `json:"require_tls_inbound" api:"nullable"`
	RequireTLSOutbound bool                               `json:"require_tls_outbound" api:"nullable"`
	SPFStatus          SettingDomainListResponseSPFStatus `json:"spf_status"`
	Status             SettingDomainListResponseStatus    `json:"status"`
	Transport          string                             `json:"transport"`
	JSON               settingDomainListResponseJSON      `json:"-"`
}

func (*SettingDomainListResponse) UnmarshalJSON ¶ 

func (r *SettingDomainListResponse) UnmarshalJSON(data []byte) (err error)

type SettingDomainListResponseAllowedDeliveryMode ¶ 

type SettingDomainListResponseAllowedDeliveryMode string
const (
	SettingDomainListResponseAllowedDeliveryModeDirect    SettingDomainListResponseAllowedDeliveryMode = "DIRECT"
	SettingDomainListResponseAllowedDeliveryModeBcc       SettingDomainListResponseAllowedDeliveryMode = "BCC"
	SettingDomainListResponseAllowedDeliveryModeJournal   SettingDomainListResponseAllowedDeliveryMode = "JOURNAL"
	SettingDomainListResponseAllowedDeliveryModeAPI       SettingDomainListResponseAllowedDeliveryMode = "API"
	SettingDomainListResponseAllowedDeliveryModeRetroScan SettingDomainListResponseAllowedDeliveryMode = "RETRO_SCAN"
)

func (SettingDomainListResponseAllowedDeliveryMode) IsKnown ¶ 

func (r SettingDomainListResponseAllowedDeliveryMode) IsKnown() bool

type SettingDomainListResponseAuthorization ¶ 

type SettingDomainListResponseAuthorization struct {
	Authorized    bool                                       `json:"authorized" api:"required"`
	Timestamp     time.Time                                  `json:"timestamp" api:"required" format:"date-time"`
	StatusMessage string                                     `json:"status_message" api:"nullable"`
	JSON          settingDomainListResponseAuthorizationJSON `json:"-"`
}

func (*SettingDomainListResponseAuthorization) UnmarshalJSON ¶ 

func (r *SettingDomainListResponseAuthorization) UnmarshalJSON(data []byte) (err error)

type SettingDomainListResponseDMARCStatus ¶ 

type SettingDomainListResponseDMARCStatus string
const (
	SettingDomainListResponseDMARCStatusNone    SettingDomainListResponseDMARCStatus = "none"
	SettingDomainListResponseDMARCStatusGood    SettingDomainListResponseDMARCStatus = "good"
	SettingDomainListResponseDMARCStatusInvalid SettingDomainListResponseDMARCStatus = "invalid"
)

func (SettingDomainListResponseDMARCStatus) IsKnown ¶ 

func (r SettingDomainListResponseDMARCStatus) IsKnown() bool

type SettingDomainListResponseDropDisposition ¶ 

type SettingDomainListResponseDropDisposition string
const (
	SettingDomainListResponseDropDispositionMalicious    SettingDomainListResponseDropDisposition = "MALICIOUS"
	SettingDomainListResponseDropDispositionMaliciousBec SettingDomainListResponseDropDisposition = "MALICIOUS-BEC"
	SettingDomainListResponseDropDispositionSuspicious   SettingDomainListResponseDropDisposition = "SUSPICIOUS"
	SettingDomainListResponseDropDispositionSpoof        SettingDomainListResponseDropDisposition = "SPOOF"
	SettingDomainListResponseDropDispositionSpam         SettingDomainListResponseDropDisposition = "SPAM"
	SettingDomainListResponseDropDispositionBulk         SettingDomainListResponseDropDisposition = "BULK"
	SettingDomainListResponseDropDispositionEncrypted    SettingDomainListResponseDropDisposition = "ENCRYPTED"
	SettingDomainListResponseDropDispositionExternal     SettingDomainListResponseDropDisposition = "EXTERNAL"
	SettingDomainListResponseDropDispositionUnknown      SettingDomainListResponseDropDisposition = "UNKNOWN"
	SettingDomainListResponseDropDispositionNone         SettingDomainListResponseDropDisposition = "NONE"
)

func (SettingDomainListResponseDropDisposition) IsKnown ¶ 

func (r SettingDomainListResponseDropDisposition) IsKnown() bool

type SettingDomainListResponseEmailsProcessed ¶ 

type SettingDomainListResponseEmailsProcessed struct {
	Timestamp                    time.Time                                    `json:"timestamp" api:"required" format:"date-time"`
	TotalEmailsProcessed         int64                                        `json:"total_emails_processed" api:"required"`
	TotalEmailsProcessedPrevious int64                                        `json:"total_emails_processed_previous" api:"required"`
	JSON                         settingDomainListResponseEmailsProcessedJSON `json:"-"`
}

func (*SettingDomainListResponseEmailsProcessed) UnmarshalJSON ¶ 

func (r *SettingDomainListResponseEmailsProcessed) UnmarshalJSON(data []byte) (err error)

type SettingDomainListResponseFolder ¶ 

type SettingDomainListResponseFolder string
const (
	SettingDomainListResponseFolderAllItems SettingDomainListResponseFolder = "AllItems"
	SettingDomainListResponseFolderInbox    SettingDomainListResponseFolder = "Inbox"
)

func (SettingDomainListResponseFolder) IsKnown ¶ 

func (r SettingDomainListResponseFolder) IsKnown() bool

type SettingDomainListResponseInboxProvider ¶ 

type SettingDomainListResponseInboxProvider string
const (
	SettingDomainListResponseInboxProviderMicrosoft SettingDomainListResponseInboxProvider = "Microsoft"
	SettingDomainListResponseInboxProviderGoogle    SettingDomainListResponseInboxProvider = "Google"
)

func (SettingDomainListResponseInboxProvider) IsKnown ¶ 

func (r SettingDomainListResponseInboxProvider) IsKnown() bool

type SettingDomainListResponseRegion ¶ 

type SettingDomainListResponseRegion string
const (
	SettingDomainListResponseRegionGlobal SettingDomainListResponseRegion = "GLOBAL"
	SettingDomainListResponseRegionAu     SettingDomainListResponseRegion = "AU"
	SettingDomainListResponseRegionDe     SettingDomainListResponseRegion = "DE"
	SettingDomainListResponseRegionIn     SettingDomainListResponseRegion = "IN"
	SettingDomainListResponseRegionUs     SettingDomainListResponseRegion = "US"
)

func (SettingDomainListResponseRegion) IsKnown ¶ 

func (r SettingDomainListResponseRegion) IsKnown() bool

type SettingDomainListResponseSPFStatus ¶ 

type SettingDomainListResponseSPFStatus string
const (
	SettingDomainListResponseSPFStatusNone    SettingDomainListResponseSPFStatus = "none"
	SettingDomainListResponseSPFStatusGood    SettingDomainListResponseSPFStatus = "good"
	SettingDomainListResponseSPFStatusNeutral SettingDomainListResponseSPFStatus = "neutral"
	SettingDomainListResponseSPFStatusOpen    SettingDomainListResponseSPFStatus = "open"
	SettingDomainListResponseSPFStatusInvalid SettingDomainListResponseSPFStatus = "invalid"
)

func (SettingDomainListResponseSPFStatus) IsKnown ¶ 

func (r SettingDomainListResponseSPFStatus) IsKnown() bool

type SettingDomainListResponseStatus ¶ 

type SettingDomainListResponseStatus string
const (
	SettingDomainListResponseStatusPending SettingDomainListResponseStatus = "pending"
	SettingDomainListResponseStatusActive  SettingDomainListResponseStatus = "active"
	SettingDomainListResponseStatusFailed  SettingDomainListResponseStatus = "failed"
	SettingDomainListResponseStatusTimeout SettingDomainListResponseStatus = "timeout"
)

func (SettingDomainListResponseStatus) IsKnown ¶ 

func (r SettingDomainListResponseStatus) IsKnown() bool

type SettingDomainService ¶ 

type SettingDomainService struct {
	Options []option.RequestOption
}

SettingDomainService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSettingDomainService method instead.

func NewSettingDomainService ¶ 

func NewSettingDomainService(opts ...option.RequestOption) (r *SettingDomainService)

NewSettingDomainService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SettingDomainService) Delete ¶ 

func (r *SettingDomainService) Delete(ctx context.Context, domainID string, body SettingDomainDeleteParams, opts ...option.RequestOption) (res *SettingDomainDeleteResponse, err error)

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.

func (*SettingDomainService) Edit ¶ 

func (r *SettingDomainService) Edit(ctx context.Context, domainID string, params SettingDomainEditParams, opts ...option.RequestOption) (res *SettingDomainEditResponse, err error)

Updates configuration for a protected email domain. Only provided fields will be modified. Changes affect delivery mode, security settings, and regional processing.

func (*SettingDomainService) Get ¶ 

func (r *SettingDomainService) Get(ctx context.Context, domainID string, query SettingDomainGetParams, opts ...option.RequestOption) (res *SettingDomainGetResponse, err error)

Retrieves detailed information for a specific protected email domain including its delivery configuration, SPF/DMARC status, and authorization state.

func (*SettingDomainService) List ¶ 

func (r *SettingDomainService) List(ctx context.Context, params SettingDomainListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SettingDomainListResponse], err error)

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.

func (*SettingDomainService) ListAutoPaging ¶ 

func (r *SettingDomainService) ListAutoPaging(ctx context.Context, params SettingDomainListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SettingDomainListResponse]

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.

type SettingImpersonationRegistryDeleteParams ¶ 

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

type SettingImpersonationRegistryDeleteResponse ¶ 

type SettingImpersonationRegistryDeleteResponse struct {
	// Impersonation registry entry identifier
	ID   string                                         `json:"id" api:"required" format:"uuid"`
	JSON settingImpersonationRegistryDeleteResponseJSON `json:"-"`
}

func (*SettingImpersonationRegistryDeleteResponse) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryDeleteResponse) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryDeleteResponseEnvelope ¶ 

type SettingImpersonationRegistryDeleteResponseEnvelope struct {
	Errors   []SettingImpersonationRegistryDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingImpersonationRegistryDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingImpersonationRegistryDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SettingImpersonationRegistryDeleteResponse                `json:"result"`
	JSON    settingImpersonationRegistryDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*SettingImpersonationRegistryDeleteResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryDeleteResponseEnvelopeErrors ¶ 

type SettingImpersonationRegistryDeleteResponseEnvelopeErrors struct {
	Code             int64                                                          `json:"code" api:"required"`
	Message          string                                                         `json:"message" api:"required"`
	DocumentationURL string                                                         `json:"documentation_url"`
	Source           SettingImpersonationRegistryDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingImpersonationRegistryDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingImpersonationRegistryDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryDeleteResponseEnvelopeErrorsSource ¶ 

type SettingImpersonationRegistryDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                             `json:"pointer"`
	JSON    settingImpersonationRegistryDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingImpersonationRegistryDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryDeleteResponseEnvelopeMessages ¶ 

type SettingImpersonationRegistryDeleteResponseEnvelopeMessages struct {
	Code             int64                                                            `json:"code" api:"required"`
	Message          string                                                           `json:"message" api:"required"`
	DocumentationURL string                                                           `json:"documentation_url"`
	Source           SettingImpersonationRegistryDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingImpersonationRegistryDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingImpersonationRegistryDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryDeleteResponseEnvelopeMessagesSource ¶ 

type SettingImpersonationRegistryDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                               `json:"pointer"`
	JSON    settingImpersonationRegistryDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingImpersonationRegistryDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryDeleteResponseEnvelopeSuccess ¶ 

type SettingImpersonationRegistryDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingImpersonationRegistryDeleteResponseEnvelopeSuccessTrue SettingImpersonationRegistryDeleteResponseEnvelopeSuccess = true
)

func (SettingImpersonationRegistryDeleteResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingImpersonationRegistryDeleteResponseEnvelopeSuccess) IsKnown() bool

type SettingImpersonationRegistryEditParams ¶ 

type SettingImpersonationRegistryEditParams struct {
	// Identifier.
	AccountID               param.Field[string]                                           `path:"account_id" api:"required"`
	Comments                param.Field[string]                                           `json:"comments"`
	DirectoryID             param.Field[int64]                                            `json:"directory_id"`
	DirectoryNodeID         param.Field[int64]                                            `json:"directory_node_id"`
	Email                   param.Field[string]                                           `json:"email"`
	ExternalDirectoryNodeID param.Field[string]                                           `json:"external_directory_node_id"`
	IsEmailRegex            param.Field[bool]                                             `json:"is_email_regex"`
	Name                    param.Field[string]                                           `json:"name"`
	Provenance              param.Field[SettingImpersonationRegistryEditParamsProvenance] `json:"provenance"`
}

func (SettingImpersonationRegistryEditParams) MarshalJSON ¶ 

func (r SettingImpersonationRegistryEditParams) MarshalJSON() (data []byte, err error)

type SettingImpersonationRegistryEditParamsProvenance ¶ 

type SettingImpersonationRegistryEditParamsProvenance string
const (
	SettingImpersonationRegistryEditParamsProvenanceA1SInternal           SettingImpersonationRegistryEditParamsProvenance = "A1S_INTERNAL"
	SettingImpersonationRegistryEditParamsProvenanceSnoopyCasbOffice365   SettingImpersonationRegistryEditParamsProvenance = "SNOOPY-CASB_OFFICE_365"
	SettingImpersonationRegistryEditParamsProvenanceSnoopyOffice365       SettingImpersonationRegistryEditParamsProvenance = "SNOOPY-OFFICE_365"
	SettingImpersonationRegistryEditParamsProvenanceSnoopyGoogleDirectory SettingImpersonationRegistryEditParamsProvenance = "SNOOPY-GOOGLE_DIRECTORY"
)

func (SettingImpersonationRegistryEditParamsProvenance) IsKnown ¶ 

func (r SettingImpersonationRegistryEditParamsProvenance) IsKnown() bool

type SettingImpersonationRegistryEditResponse ¶ 

type SettingImpersonationRegistryEditResponse struct {
	// Impersonation registry entry identifier
	ID              string    `json:"id" format:"uuid"`
	Comments        string    `json:"comments" api:"nullable"`
	CreatedAt       time.Time `json:"created_at" format:"date-time"`
	DirectoryID     int64     `json:"directory_id" api:"nullable"`
	DirectoryNodeID int64     `json:"directory_node_id" api:"nullable"`
	Email           string    `json:"email"`
	// Deprecated: This field is deprecated.
	ExternalDirectoryNodeID string `json:"external_directory_node_id" api:"nullable"`
	IsEmailRegex            bool   `json:"is_email_regex"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                                          `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                                          `json:"modified_at" format:"date-time"`
	Name         string                                             `json:"name"`
	Provenance   SettingImpersonationRegistryEditResponseProvenance `json:"provenance"`
	JSON         settingImpersonationRegistryEditResponseJSON       `json:"-"`
}

An impersonation registry entry

func (*SettingImpersonationRegistryEditResponse) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryEditResponse) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryEditResponseEnvelope ¶ 

type SettingImpersonationRegistryEditResponseEnvelope struct {
	Errors   []SettingImpersonationRegistryEditResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingImpersonationRegistryEditResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingImpersonationRegistryEditResponseEnvelopeSuccess `json:"success" api:"required"`
	// An impersonation registry entry
	Result SettingImpersonationRegistryEditResponse             `json:"result"`
	JSON   settingImpersonationRegistryEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingImpersonationRegistryEditResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryEditResponseEnvelopeErrors ¶ 

type SettingImpersonationRegistryEditResponseEnvelopeErrors struct {
	Code             int64                                                        `json:"code" api:"required"`
	Message          string                                                       `json:"message" api:"required"`
	DocumentationURL string                                                       `json:"documentation_url"`
	Source           SettingImpersonationRegistryEditResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingImpersonationRegistryEditResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingImpersonationRegistryEditResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryEditResponseEnvelopeErrorsSource ¶ 

type SettingImpersonationRegistryEditResponseEnvelopeErrorsSource struct {
	Pointer string                                                           `json:"pointer"`
	JSON    settingImpersonationRegistryEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingImpersonationRegistryEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryEditResponseEnvelopeMessages ¶ 

type SettingImpersonationRegistryEditResponseEnvelopeMessages struct {
	Code             int64                                                          `json:"code" api:"required"`
	Message          string                                                         `json:"message" api:"required"`
	DocumentationURL string                                                         `json:"documentation_url"`
	Source           SettingImpersonationRegistryEditResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingImpersonationRegistryEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingImpersonationRegistryEditResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryEditResponseEnvelopeMessagesSource ¶ 

type SettingImpersonationRegistryEditResponseEnvelopeMessagesSource struct {
	Pointer string                                                             `json:"pointer"`
	JSON    settingImpersonationRegistryEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingImpersonationRegistryEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryEditResponseEnvelopeSuccess ¶ 

type SettingImpersonationRegistryEditResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingImpersonationRegistryEditResponseEnvelopeSuccessTrue SettingImpersonationRegistryEditResponseEnvelopeSuccess = true
)

func (SettingImpersonationRegistryEditResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingImpersonationRegistryEditResponseEnvelopeSuccess) IsKnown() bool

type SettingImpersonationRegistryEditResponseProvenance ¶ 

type SettingImpersonationRegistryEditResponseProvenance string
const (
	SettingImpersonationRegistryEditResponseProvenanceA1SInternal           SettingImpersonationRegistryEditResponseProvenance = "A1S_INTERNAL"
	SettingImpersonationRegistryEditResponseProvenanceSnoopyCasbOffice365   SettingImpersonationRegistryEditResponseProvenance = "SNOOPY-CASB_OFFICE_365"
	SettingImpersonationRegistryEditResponseProvenanceSnoopyOffice365       SettingImpersonationRegistryEditResponseProvenance = "SNOOPY-OFFICE_365"
	SettingImpersonationRegistryEditResponseProvenanceSnoopyGoogleDirectory SettingImpersonationRegistryEditResponseProvenance = "SNOOPY-GOOGLE_DIRECTORY"
)

func (SettingImpersonationRegistryEditResponseProvenance) IsKnown ¶ 

func (r SettingImpersonationRegistryEditResponseProvenance) IsKnown() bool

type SettingImpersonationRegistryGetParams ¶ 

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

type SettingImpersonationRegistryGetResponse ¶ 

type SettingImpersonationRegistryGetResponse struct {
	// Impersonation registry entry identifier
	ID              string    `json:"id" format:"uuid"`
	Comments        string    `json:"comments" api:"nullable"`
	CreatedAt       time.Time `json:"created_at" format:"date-time"`
	DirectoryID     int64     `json:"directory_id" api:"nullable"`
	DirectoryNodeID int64     `json:"directory_node_id" api:"nullable"`
	Email           string    `json:"email"`
	// Deprecated: This field is deprecated.
	ExternalDirectoryNodeID string `json:"external_directory_node_id" api:"nullable"`
	IsEmailRegex            bool   `json:"is_email_regex"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                                         `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                                         `json:"modified_at" format:"date-time"`
	Name         string                                            `json:"name"`
	Provenance   SettingImpersonationRegistryGetResponseProvenance `json:"provenance"`
	JSON         settingImpersonationRegistryGetResponseJSON       `json:"-"`
}

An impersonation registry entry

func (*SettingImpersonationRegistryGetResponse) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryGetResponse) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryGetResponseEnvelope ¶ 

type SettingImpersonationRegistryGetResponseEnvelope struct {
	Errors   []SettingImpersonationRegistryGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingImpersonationRegistryGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingImpersonationRegistryGetResponseEnvelopeSuccess `json:"success" api:"required"`
	// An impersonation registry entry
	Result SettingImpersonationRegistryGetResponse             `json:"result"`
	JSON   settingImpersonationRegistryGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingImpersonationRegistryGetResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryGetResponseEnvelopeErrors ¶ 

type SettingImpersonationRegistryGetResponseEnvelopeErrors struct {
	Code             int64                                                       `json:"code" api:"required"`
	Message          string                                                      `json:"message" api:"required"`
	DocumentationURL string                                                      `json:"documentation_url"`
	Source           SettingImpersonationRegistryGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingImpersonationRegistryGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingImpersonationRegistryGetResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryGetResponseEnvelopeErrorsSource ¶ 

type SettingImpersonationRegistryGetResponseEnvelopeErrorsSource struct {
	Pointer string                                                          `json:"pointer"`
	JSON    settingImpersonationRegistryGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingImpersonationRegistryGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryGetResponseEnvelopeMessages ¶ 

type SettingImpersonationRegistryGetResponseEnvelopeMessages struct {
	Code             int64                                                         `json:"code" api:"required"`
	Message          string                                                        `json:"message" api:"required"`
	DocumentationURL string                                                        `json:"documentation_url"`
	Source           SettingImpersonationRegistryGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingImpersonationRegistryGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingImpersonationRegistryGetResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryGetResponseEnvelopeMessagesSource ¶ 

type SettingImpersonationRegistryGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                            `json:"pointer"`
	JSON    settingImpersonationRegistryGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingImpersonationRegistryGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryGetResponseEnvelopeSuccess ¶ 

type SettingImpersonationRegistryGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingImpersonationRegistryGetResponseEnvelopeSuccessTrue SettingImpersonationRegistryGetResponseEnvelopeSuccess = true
)

func (SettingImpersonationRegistryGetResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingImpersonationRegistryGetResponseEnvelopeSuccess) IsKnown() bool

type SettingImpersonationRegistryGetResponseProvenance ¶ 

type SettingImpersonationRegistryGetResponseProvenance string
const (
	SettingImpersonationRegistryGetResponseProvenanceA1SInternal           SettingImpersonationRegistryGetResponseProvenance = "A1S_INTERNAL"
	SettingImpersonationRegistryGetResponseProvenanceSnoopyCasbOffice365   SettingImpersonationRegistryGetResponseProvenance = "SNOOPY-CASB_OFFICE_365"
	SettingImpersonationRegistryGetResponseProvenanceSnoopyOffice365       SettingImpersonationRegistryGetResponseProvenance = "SNOOPY-OFFICE_365"
	SettingImpersonationRegistryGetResponseProvenanceSnoopyGoogleDirectory SettingImpersonationRegistryGetResponseProvenance = "SNOOPY-GOOGLE_DIRECTORY"
)

func (SettingImpersonationRegistryGetResponseProvenance) IsKnown ¶ 

func (r SettingImpersonationRegistryGetResponseProvenance) IsKnown() bool

type SettingImpersonationRegistryListParams ¶ 

type SettingImpersonationRegistryListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The sorting direction.
	Direction param.Field[SettingImpersonationRegistryListParamsDirection] `query:"direction"`
	// Field to sort by.
	Order param.Field[SettingImpersonationRegistryListParamsOrder] `query:"order"`
	// Current page within paginated list of results.
	Page param.Field[int64] `query:"page"`
	// The number of results per page. Maximum value is 1000.
	PerPage    param.Field[int64]                                            `query:"per_page"`
	Provenance param.Field[SettingImpersonationRegistryListParamsProvenance] `query:"provenance"`
	// Search term for filtering records. Behavior may change.
	Search param.Field[string] `query:"search"`
}

func (SettingImpersonationRegistryListParams) URLQuery ¶ 

func (r SettingImpersonationRegistryListParams) URLQuery() (v url.Values)

URLQuery serializes SettingImpersonationRegistryListParams's query parameters as `url.Values`.

type SettingImpersonationRegistryListParamsDirection ¶ 

type SettingImpersonationRegistryListParamsDirection string

The sorting direction. 

const (
	SettingImpersonationRegistryListParamsDirectionAsc  SettingImpersonationRegistryListParamsDirection = "asc"
	SettingImpersonationRegistryListParamsDirectionDesc SettingImpersonationRegistryListParamsDirection = "desc"
)

func (SettingImpersonationRegistryListParamsDirection) IsKnown ¶ 

func (r SettingImpersonationRegistryListParamsDirection) IsKnown() bool

type SettingImpersonationRegistryListParamsOrder ¶ 

type SettingImpersonationRegistryListParamsOrder string

Field to sort by. 

const (
	SettingImpersonationRegistryListParamsOrderName      SettingImpersonationRegistryListParamsOrder = "name"
	SettingImpersonationRegistryListParamsOrderEmail     SettingImpersonationRegistryListParamsOrder = "email"
	SettingImpersonationRegistryListParamsOrderCreatedAt SettingImpersonationRegistryListParamsOrder = "created_at"
)

func (SettingImpersonationRegistryListParamsOrder) IsKnown ¶ 

func (r SettingImpersonationRegistryListParamsOrder) IsKnown() bool

type SettingImpersonationRegistryListParamsProvenance ¶ 

type SettingImpersonationRegistryListParamsProvenance string
const (
	SettingImpersonationRegistryListParamsProvenanceA1SInternal           SettingImpersonationRegistryListParamsProvenance = "A1S_INTERNAL"
	SettingImpersonationRegistryListParamsProvenanceSnoopyCasbOffice365   SettingImpersonationRegistryListParamsProvenance = "SNOOPY-CASB_OFFICE_365"
	SettingImpersonationRegistryListParamsProvenanceSnoopyOffice365       SettingImpersonationRegistryListParamsProvenance = "SNOOPY-OFFICE_365"
	SettingImpersonationRegistryListParamsProvenanceSnoopyGoogleDirectory SettingImpersonationRegistryListParamsProvenance = "SNOOPY-GOOGLE_DIRECTORY"
)

func (SettingImpersonationRegistryListParamsProvenance) IsKnown ¶ 

func (r SettingImpersonationRegistryListParamsProvenance) IsKnown() bool

type SettingImpersonationRegistryListResponse ¶ 

type SettingImpersonationRegistryListResponse struct {
	// Impersonation registry entry identifier
	ID              string    `json:"id" format:"uuid"`
	Comments        string    `json:"comments" api:"nullable"`
	CreatedAt       time.Time `json:"created_at" format:"date-time"`
	DirectoryID     int64     `json:"directory_id" api:"nullable"`
	DirectoryNodeID int64     `json:"directory_node_id" api:"nullable"`
	Email           string    `json:"email"`
	// Deprecated: This field is deprecated.
	ExternalDirectoryNodeID string `json:"external_directory_node_id" api:"nullable"`
	IsEmailRegex            bool   `json:"is_email_regex"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                                          `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                                          `json:"modified_at" format:"date-time"`
	Name         string                                             `json:"name"`
	Provenance   SettingImpersonationRegistryListResponseProvenance `json:"provenance"`
	JSON         settingImpersonationRegistryListResponseJSON       `json:"-"`
}

An impersonation registry entry

func (*SettingImpersonationRegistryListResponse) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryListResponse) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryListResponseProvenance ¶ 

type SettingImpersonationRegistryListResponseProvenance string
const (
	SettingImpersonationRegistryListResponseProvenanceA1SInternal           SettingImpersonationRegistryListResponseProvenance = "A1S_INTERNAL"
	SettingImpersonationRegistryListResponseProvenanceSnoopyCasbOffice365   SettingImpersonationRegistryListResponseProvenance = "SNOOPY-CASB_OFFICE_365"
	SettingImpersonationRegistryListResponseProvenanceSnoopyOffice365       SettingImpersonationRegistryListResponseProvenance = "SNOOPY-OFFICE_365"
	SettingImpersonationRegistryListResponseProvenanceSnoopyGoogleDirectory SettingImpersonationRegistryListResponseProvenance = "SNOOPY-GOOGLE_DIRECTORY"
)

func (SettingImpersonationRegistryListResponseProvenance) IsKnown ¶ 

func (r SettingImpersonationRegistryListResponseProvenance) IsKnown() bool

type SettingImpersonationRegistryNewParams ¶ 

type SettingImpersonationRegistryNewParams struct {
	// Identifier.
	AccountID               param.Field[string]                                          `path:"account_id" api:"required"`
	Email                   param.Field[string]                                          `json:"email" api:"required"`
	IsEmailRegex            param.Field[bool]                                            `json:"is_email_regex" api:"required"`
	Name                    param.Field[string]                                          `json:"name" api:"required"`
	Comments                param.Field[string]                                          `json:"comments"`
	DirectoryID             param.Field[int64]                                           `json:"directory_id"`
	DirectoryNodeID         param.Field[int64]                                           `json:"directory_node_id"`
	ExternalDirectoryNodeID param.Field[string]                                          `json:"external_directory_node_id"`
	Provenance              param.Field[SettingImpersonationRegistryNewParamsProvenance] `json:"provenance"`
}

func (SettingImpersonationRegistryNewParams) MarshalJSON ¶ 

func (r SettingImpersonationRegistryNewParams) MarshalJSON() (data []byte, err error)

type SettingImpersonationRegistryNewParamsProvenance ¶ 

type SettingImpersonationRegistryNewParamsProvenance string
const (
	SettingImpersonationRegistryNewParamsProvenanceA1SInternal           SettingImpersonationRegistryNewParamsProvenance = "A1S_INTERNAL"
	SettingImpersonationRegistryNewParamsProvenanceSnoopyCasbOffice365   SettingImpersonationRegistryNewParamsProvenance = "SNOOPY-CASB_OFFICE_365"
	SettingImpersonationRegistryNewParamsProvenanceSnoopyOffice365       SettingImpersonationRegistryNewParamsProvenance = "SNOOPY-OFFICE_365"
	SettingImpersonationRegistryNewParamsProvenanceSnoopyGoogleDirectory SettingImpersonationRegistryNewParamsProvenance = "SNOOPY-GOOGLE_DIRECTORY"
)

func (SettingImpersonationRegistryNewParamsProvenance) IsKnown ¶ 

func (r SettingImpersonationRegistryNewParamsProvenance) IsKnown() bool

type SettingImpersonationRegistryNewResponse ¶ 

type SettingImpersonationRegistryNewResponse struct {
	// Impersonation registry entry identifier
	ID              string    `json:"id" format:"uuid"`
	Comments        string    `json:"comments" api:"nullable"`
	CreatedAt       time.Time `json:"created_at" format:"date-time"`
	DirectoryID     int64     `json:"directory_id" api:"nullable"`
	DirectoryNodeID int64     `json:"directory_node_id" api:"nullable"`
	Email           string    `json:"email"`
	// Deprecated: This field is deprecated.
	ExternalDirectoryNodeID string `json:"external_directory_node_id" api:"nullable"`
	IsEmailRegex            bool   `json:"is_email_regex"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                                         `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                                         `json:"modified_at" format:"date-time"`
	Name         string                                            `json:"name"`
	Provenance   SettingImpersonationRegistryNewResponseProvenance `json:"provenance"`
	JSON         settingImpersonationRegistryNewResponseJSON       `json:"-"`
}

An impersonation registry entry

func (*SettingImpersonationRegistryNewResponse) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryNewResponse) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryNewResponseEnvelope ¶ 

type SettingImpersonationRegistryNewResponseEnvelope struct {
	Errors   []SettingImpersonationRegistryNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingImpersonationRegistryNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingImpersonationRegistryNewResponseEnvelopeSuccess `json:"success" api:"required"`
	// An impersonation registry entry
	Result SettingImpersonationRegistryNewResponse             `json:"result"`
	JSON   settingImpersonationRegistryNewResponseEnvelopeJSON `json:"-"`
}

func (*SettingImpersonationRegistryNewResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryNewResponseEnvelopeErrors ¶ 

type SettingImpersonationRegistryNewResponseEnvelopeErrors struct {
	Code             int64                                                       `json:"code" api:"required"`
	Message          string                                                      `json:"message" api:"required"`
	DocumentationURL string                                                      `json:"documentation_url"`
	Source           SettingImpersonationRegistryNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingImpersonationRegistryNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingImpersonationRegistryNewResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryNewResponseEnvelopeErrorsSource ¶ 

type SettingImpersonationRegistryNewResponseEnvelopeErrorsSource struct {
	Pointer string                                                          `json:"pointer"`
	JSON    settingImpersonationRegistryNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingImpersonationRegistryNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryNewResponseEnvelopeMessages ¶ 

type SettingImpersonationRegistryNewResponseEnvelopeMessages struct {
	Code             int64                                                         `json:"code" api:"required"`
	Message          string                                                        `json:"message" api:"required"`
	DocumentationURL string                                                        `json:"documentation_url"`
	Source           SettingImpersonationRegistryNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingImpersonationRegistryNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingImpersonationRegistryNewResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryNewResponseEnvelopeMessagesSource ¶ 

type SettingImpersonationRegistryNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                            `json:"pointer"`
	JSON    settingImpersonationRegistryNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingImpersonationRegistryNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingImpersonationRegistryNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryNewResponseEnvelopeSuccess ¶ 

type SettingImpersonationRegistryNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingImpersonationRegistryNewResponseEnvelopeSuccessTrue SettingImpersonationRegistryNewResponseEnvelopeSuccess = true
)

func (SettingImpersonationRegistryNewResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingImpersonationRegistryNewResponseEnvelopeSuccess) IsKnown() bool

type SettingImpersonationRegistryNewResponseProvenance ¶ 

type SettingImpersonationRegistryNewResponseProvenance string
const (
	SettingImpersonationRegistryNewResponseProvenanceA1SInternal           SettingImpersonationRegistryNewResponseProvenance = "A1S_INTERNAL"
	SettingImpersonationRegistryNewResponseProvenanceSnoopyCasbOffice365   SettingImpersonationRegistryNewResponseProvenance = "SNOOPY-CASB_OFFICE_365"
	SettingImpersonationRegistryNewResponseProvenanceSnoopyOffice365       SettingImpersonationRegistryNewResponseProvenance = "SNOOPY-OFFICE_365"
	SettingImpersonationRegistryNewResponseProvenanceSnoopyGoogleDirectory SettingImpersonationRegistryNewResponseProvenance = "SNOOPY-GOOGLE_DIRECTORY"
)

func (SettingImpersonationRegistryNewResponseProvenance) IsKnown ¶ 

func (r SettingImpersonationRegistryNewResponseProvenance) IsKnown() bool

type SettingImpersonationRegistryService ¶ 

type SettingImpersonationRegistryService struct {
	Options []option.RequestOption
}

SettingImpersonationRegistryService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSettingImpersonationRegistryService method instead.

func NewSettingImpersonationRegistryService ¶ 

func NewSettingImpersonationRegistryService(opts ...option.RequestOption) (r *SettingImpersonationRegistryService)

NewSettingImpersonationRegistryService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SettingImpersonationRegistryService) Delete ¶ 

func (r *SettingImpersonationRegistryService) Delete(ctx context.Context, impersonationRegistryID string, body SettingImpersonationRegistryDeleteParams, opts ...option.RequestOption) (res *SettingImpersonationRegistryDeleteResponse, err error)

Removes an entry from the impersonation registry. After deletion, this identity will no longer be protected from impersonation.

func (*SettingImpersonationRegistryService) Edit ¶ 

func (r *SettingImpersonationRegistryService) Edit(ctx context.Context, impersonationRegistryID string, params SettingImpersonationRegistryEditParams, opts ...option.RequestOption) (res *SettingImpersonationRegistryEditResponse, err error)

Updates an existing impersonation registry entry. Only provided fields will be modified. Directory-synced entries can't be updated.

func (*SettingImpersonationRegistryService) Get ¶ 

func (r *SettingImpersonationRegistryService) Get(ctx context.Context, impersonationRegistryID string, query SettingImpersonationRegistryGetParams, opts ...option.RequestOption) (res *SettingImpersonationRegistryGetResponse, err error)

Retrieves details for a specific impersonation registry entry including the protected identity, email pattern, and synchronization source if directory-synced.

func (*SettingImpersonationRegistryService) List ¶ 

func (r *SettingImpersonationRegistryService) List(ctx context.Context, params SettingImpersonationRegistryListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SettingImpersonationRegistryListResponse], err error)

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.

func (*SettingImpersonationRegistryService) ListAutoPaging ¶ 

func (r *SettingImpersonationRegistryService) ListAutoPaging(ctx context.Context, params SettingImpersonationRegistryListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SettingImpersonationRegistryListResponse]

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.

func (*SettingImpersonationRegistryService) New ¶ 

func (r *SettingImpersonationRegistryService) New(ctx context.Context, params SettingImpersonationRegistryNewParams, opts ...option.RequestOption) (res *SettingImpersonationRegistryNewResponse, err error)

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.

type SettingSendingDomainRestrictionDeleteParams ¶ added in v7.4.0 

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

type SettingSendingDomainRestrictionDeleteResponse ¶ added in v7.4.0 

type SettingSendingDomainRestrictionDeleteResponse struct {
	// Sending domain restriction identifier.
	ID   string                                            `json:"id" api:"required" format:"uuid"`
	JSON settingSendingDomainRestrictionDeleteResponseJSON `json:"-"`
}

func (*SettingSendingDomainRestrictionDeleteResponse) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionDeleteResponse) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionDeleteResponseEnvelope ¶ added in v7.4.0 

type SettingSendingDomainRestrictionDeleteResponseEnvelope struct {
	Errors   []SettingSendingDomainRestrictionDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingSendingDomainRestrictionDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingSendingDomainRestrictionDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SettingSendingDomainRestrictionDeleteResponse                `json:"result"`
	JSON    settingSendingDomainRestrictionDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*SettingSendingDomainRestrictionDeleteResponseEnvelope) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionDeleteResponseEnvelopeErrors ¶ added in v7.4.0 

type SettingSendingDomainRestrictionDeleteResponseEnvelopeErrors struct {
	Code             int64                                                             `json:"code" api:"required"`
	Message          string                                                            `json:"message" api:"required"`
	DocumentationURL string                                                            `json:"documentation_url"`
	Source           SettingSendingDomainRestrictionDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingSendingDomainRestrictionDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingSendingDomainRestrictionDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionDeleteResponseEnvelopeErrorsSource ¶ added in v7.4.0 

type SettingSendingDomainRestrictionDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                                `json:"pointer"`
	JSON    settingSendingDomainRestrictionDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingSendingDomainRestrictionDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionDeleteResponseEnvelopeMessages ¶ added in v7.4.0 

type SettingSendingDomainRestrictionDeleteResponseEnvelopeMessages struct {
	Code             int64                                                               `json:"code" api:"required"`
	Message          string                                                              `json:"message" api:"required"`
	DocumentationURL string                                                              `json:"documentation_url"`
	Source           SettingSendingDomainRestrictionDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingSendingDomainRestrictionDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingSendingDomainRestrictionDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionDeleteResponseEnvelopeMessagesSource ¶ added in v7.4.0 

type SettingSendingDomainRestrictionDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                                  `json:"pointer"`
	JSON    settingSendingDomainRestrictionDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingSendingDomainRestrictionDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionDeleteResponseEnvelopeSuccess ¶ added in v7.4.0 

type SettingSendingDomainRestrictionDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingSendingDomainRestrictionDeleteResponseEnvelopeSuccessTrue SettingSendingDomainRestrictionDeleteResponseEnvelopeSuccess = true
)

func (SettingSendingDomainRestrictionDeleteResponseEnvelopeSuccess) IsKnown ¶ added in v7.4.0 

func (r SettingSendingDomainRestrictionDeleteResponseEnvelopeSuccess) IsKnown() bool

type SettingSendingDomainRestrictionEditParams ¶ added in v7.4.0 

type SettingSendingDomainRestrictionEditParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Comments  param.Field[string] `json:"comments"`
	// Domain that requires TLS enforcement.
	Domain param.Field[string] `json:"domain"`
	// Excluded subdomains that are exempt from TLS requirements.
	Exclude param.Field[[]string] `json:"exclude"`
}

func (SettingSendingDomainRestrictionEditParams) MarshalJSON ¶ added in v7.4.0 

func (r SettingSendingDomainRestrictionEditParams) MarshalJSON() (data []byte, err error)

type SettingSendingDomainRestrictionEditResponse ¶ added in v7.4.0 

type SettingSendingDomainRestrictionEditResponse struct {
	// Sending domain restriction identifier.
	ID        string    `json:"id" format:"uuid"`
	Comments  string    `json:"comments" api:"nullable"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Domain that requires TLS enforcement.
	Domain string `json:"domain"`
	// Excluded subdomains that are exempt from TLS requirements.
	Exclude []string `json:"exclude"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                                       `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                                       `json:"modified_at" format:"date-time"`
	JSON         settingSendingDomainRestrictionEditResponseJSON `json:"-"`
}

A sending domain restriction that enforces TLS (Transport Layer Security) requirements for emails from specific domains. If TLS is required, mail without TLS from the specified domain will be dropped.

func (*SettingSendingDomainRestrictionEditResponse) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionEditResponse) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionEditResponseEnvelope ¶ added in v7.4.0 

type SettingSendingDomainRestrictionEditResponseEnvelope struct {
	Errors   []SettingSendingDomainRestrictionEditResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingSendingDomainRestrictionEditResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingSendingDomainRestrictionEditResponseEnvelopeSuccess `json:"success" api:"required"`
	// A sending domain restriction that enforces TLS (Transport Layer Security)
	// requirements for emails from specific domains. If TLS is required, mail without
	// TLS from the specified domain will be dropped.
	Result SettingSendingDomainRestrictionEditResponse             `json:"result"`
	JSON   settingSendingDomainRestrictionEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingSendingDomainRestrictionEditResponseEnvelope) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionEditResponseEnvelopeErrors ¶ added in v7.4.0 

type SettingSendingDomainRestrictionEditResponseEnvelopeErrors struct {
	Code             int64                                                           `json:"code" api:"required"`
	Message          string                                                          `json:"message" api:"required"`
	DocumentationURL string                                                          `json:"documentation_url"`
	Source           SettingSendingDomainRestrictionEditResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingSendingDomainRestrictionEditResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingSendingDomainRestrictionEditResponseEnvelopeErrors) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionEditResponseEnvelopeErrorsSource ¶ added in v7.4.0 

type SettingSendingDomainRestrictionEditResponseEnvelopeErrorsSource struct {
	Pointer string                                                              `json:"pointer"`
	JSON    settingSendingDomainRestrictionEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingSendingDomainRestrictionEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionEditResponseEnvelopeMessages ¶ added in v7.4.0 

type SettingSendingDomainRestrictionEditResponseEnvelopeMessages struct {
	Code             int64                                                             `json:"code" api:"required"`
	Message          string                                                            `json:"message" api:"required"`
	DocumentationURL string                                                            `json:"documentation_url"`
	Source           SettingSendingDomainRestrictionEditResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingSendingDomainRestrictionEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingSendingDomainRestrictionEditResponseEnvelopeMessages) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionEditResponseEnvelopeMessagesSource ¶ added in v7.4.0 

type SettingSendingDomainRestrictionEditResponseEnvelopeMessagesSource struct {
	Pointer string                                                                `json:"pointer"`
	JSON    settingSendingDomainRestrictionEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingSendingDomainRestrictionEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionEditResponseEnvelopeSuccess ¶ added in v7.4.0 

type SettingSendingDomainRestrictionEditResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingSendingDomainRestrictionEditResponseEnvelopeSuccessTrue SettingSendingDomainRestrictionEditResponseEnvelopeSuccess = true
)

func (SettingSendingDomainRestrictionEditResponseEnvelopeSuccess) IsKnown ¶ added in v7.4.0 

func (r SettingSendingDomainRestrictionEditResponseEnvelopeSuccess) IsKnown() bool

type SettingSendingDomainRestrictionGetParams ¶ added in v7.4.0 

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

type SettingSendingDomainRestrictionGetResponse ¶ added in v7.4.0 

type SettingSendingDomainRestrictionGetResponse struct {
	// Sending domain restriction identifier.
	ID        string    `json:"id" format:"uuid"`
	Comments  string    `json:"comments" api:"nullable"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Domain that requires TLS enforcement.
	Domain string `json:"domain"`
	// Excluded subdomains that are exempt from TLS requirements.
	Exclude []string `json:"exclude"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                                      `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                                      `json:"modified_at" format:"date-time"`
	JSON         settingSendingDomainRestrictionGetResponseJSON `json:"-"`
}

A sending domain restriction that enforces TLS (Transport Layer Security) requirements for emails from specific domains. If TLS is required, mail without TLS from the specified domain will be dropped.

func (*SettingSendingDomainRestrictionGetResponse) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionGetResponse) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionGetResponseEnvelope ¶ added in v7.4.0 

type SettingSendingDomainRestrictionGetResponseEnvelope struct {
	Errors   []SettingSendingDomainRestrictionGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingSendingDomainRestrictionGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingSendingDomainRestrictionGetResponseEnvelopeSuccess `json:"success" api:"required"`
	// A sending domain restriction that enforces TLS (Transport Layer Security)
	// requirements for emails from specific domains. If TLS is required, mail without
	// TLS from the specified domain will be dropped.
	Result SettingSendingDomainRestrictionGetResponse             `json:"result"`
	JSON   settingSendingDomainRestrictionGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingSendingDomainRestrictionGetResponseEnvelope) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionGetResponseEnvelopeErrors ¶ added in v7.4.0 

type SettingSendingDomainRestrictionGetResponseEnvelopeErrors struct {
	Code             int64                                                          `json:"code" api:"required"`
	Message          string                                                         `json:"message" api:"required"`
	DocumentationURL string                                                         `json:"documentation_url"`
	Source           SettingSendingDomainRestrictionGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingSendingDomainRestrictionGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingSendingDomainRestrictionGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionGetResponseEnvelopeErrorsSource ¶ added in v7.4.0 

type SettingSendingDomainRestrictionGetResponseEnvelopeErrorsSource struct {
	Pointer string                                                             `json:"pointer"`
	JSON    settingSendingDomainRestrictionGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingSendingDomainRestrictionGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionGetResponseEnvelopeMessages ¶ added in v7.4.0 

type SettingSendingDomainRestrictionGetResponseEnvelopeMessages struct {
	Code             int64                                                            `json:"code" api:"required"`
	Message          string                                                           `json:"message" api:"required"`
	DocumentationURL string                                                           `json:"documentation_url"`
	Source           SettingSendingDomainRestrictionGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingSendingDomainRestrictionGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingSendingDomainRestrictionGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionGetResponseEnvelopeMessagesSource ¶ added in v7.4.0 

type SettingSendingDomainRestrictionGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                               `json:"pointer"`
	JSON    settingSendingDomainRestrictionGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingSendingDomainRestrictionGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionGetResponseEnvelopeSuccess ¶ added in v7.4.0 

type SettingSendingDomainRestrictionGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingSendingDomainRestrictionGetResponseEnvelopeSuccessTrue SettingSendingDomainRestrictionGetResponseEnvelopeSuccess = true
)

func (SettingSendingDomainRestrictionGetResponseEnvelopeSuccess) IsKnown ¶ added in v7.4.0 

func (r SettingSendingDomainRestrictionGetResponseEnvelopeSuccess) IsKnown() bool

type SettingSendingDomainRestrictionListParams ¶ added in v7.4.0 

type SettingSendingDomainRestrictionListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The sorting direction.
	Direction param.Field[SettingSendingDomainRestrictionListParamsDirection] `query:"direction"`
	// Field to sort by.
	Order param.Field[SettingSendingDomainRestrictionListParamsOrder] `query:"order"`
	// Current page within paginated list of results.
	Page param.Field[int64] `query:"page"`
	// The number of results per page. Maximum value is 1000.
	PerPage param.Field[int64] `query:"per_page"`
	// Search term for filtering records. Behavior may change.
	Search param.Field[string] `query:"search"`
}

func (SettingSendingDomainRestrictionListParams) URLQuery ¶ added in v7.4.0 

func (r SettingSendingDomainRestrictionListParams) URLQuery() (v url.Values)

URLQuery serializes SettingSendingDomainRestrictionListParams's query parameters as `url.Values`.

type SettingSendingDomainRestrictionListParamsDirection ¶ added in v7.4.0 

type SettingSendingDomainRestrictionListParamsDirection string

The sorting direction. 

const (
	SettingSendingDomainRestrictionListParamsDirectionAsc  SettingSendingDomainRestrictionListParamsDirection = "asc"
	SettingSendingDomainRestrictionListParamsDirectionDesc SettingSendingDomainRestrictionListParamsDirection = "desc"
)

func (SettingSendingDomainRestrictionListParamsDirection) IsKnown ¶ added in v7.4.0 

func (r SettingSendingDomainRestrictionListParamsDirection) IsKnown() bool

type SettingSendingDomainRestrictionListParamsOrder ¶ added in v7.4.0 

type SettingSendingDomainRestrictionListParamsOrder string

Field to sort by. 

const (
	SettingSendingDomainRestrictionListParamsOrderDomain    SettingSendingDomainRestrictionListParamsOrder = "domain"
	SettingSendingDomainRestrictionListParamsOrderCreatedAt SettingSendingDomainRestrictionListParamsOrder = "created_at"
)

func (SettingSendingDomainRestrictionListParamsOrder) IsKnown ¶ added in v7.4.0 

func (r SettingSendingDomainRestrictionListParamsOrder) IsKnown() bool

type SettingSendingDomainRestrictionListResponse ¶ added in v7.4.0 

type SettingSendingDomainRestrictionListResponse struct {
	// Sending domain restriction identifier.
	ID        string    `json:"id" format:"uuid"`
	Comments  string    `json:"comments" api:"nullable"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Domain that requires TLS enforcement.
	Domain string `json:"domain"`
	// Excluded subdomains that are exempt from TLS requirements.
	Exclude []string `json:"exclude"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                                       `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                                       `json:"modified_at" format:"date-time"`
	JSON         settingSendingDomainRestrictionListResponseJSON `json:"-"`
}

A sending domain restriction that enforces TLS (Transport Layer Security) requirements for emails from specific domains. If TLS is required, mail without TLS from the specified domain will be dropped.

func (*SettingSendingDomainRestrictionListResponse) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionListResponse) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionNewParams ¶ added in v7.4.0 

type SettingSendingDomainRestrictionNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Domain that requires TLS enforcement.
	Domain param.Field[string] `json:"domain" api:"required"`
	// Excluded subdomains that are exempt from TLS requirements.
	Exclude  param.Field[[]string] `json:"exclude" api:"required"`
	Comments param.Field[string]   `json:"comments"`
}

func (SettingSendingDomainRestrictionNewParams) MarshalJSON ¶ added in v7.4.0 

func (r SettingSendingDomainRestrictionNewParams) MarshalJSON() (data []byte, err error)

type SettingSendingDomainRestrictionNewResponse ¶ added in v7.4.0 

type SettingSendingDomainRestrictionNewResponse struct {
	// Sending domain restriction identifier.
	ID        string    `json:"id" format:"uuid"`
	Comments  string    `json:"comments" api:"nullable"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Domain that requires TLS enforcement.
	Domain string `json:"domain"`
	// Excluded subdomains that are exempt from TLS requirements.
	Exclude []string `json:"exclude"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                                      `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                                      `json:"modified_at" format:"date-time"`
	JSON         settingSendingDomainRestrictionNewResponseJSON `json:"-"`
}

A sending domain restriction that enforces TLS (Transport Layer Security) requirements for emails from specific domains. If TLS is required, mail without TLS from the specified domain will be dropped.

func (*SettingSendingDomainRestrictionNewResponse) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionNewResponse) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionNewResponseEnvelope ¶ added in v7.4.0 

type SettingSendingDomainRestrictionNewResponseEnvelope struct {
	Errors   []SettingSendingDomainRestrictionNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingSendingDomainRestrictionNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingSendingDomainRestrictionNewResponseEnvelopeSuccess `json:"success" api:"required"`
	// A sending domain restriction that enforces TLS (Transport Layer Security)
	// requirements for emails from specific domains. If TLS is required, mail without
	// TLS from the specified domain will be dropped.
	Result SettingSendingDomainRestrictionNewResponse             `json:"result"`
	JSON   settingSendingDomainRestrictionNewResponseEnvelopeJSON `json:"-"`
}

func (*SettingSendingDomainRestrictionNewResponseEnvelope) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionNewResponseEnvelopeErrors ¶ added in v7.4.0 

type SettingSendingDomainRestrictionNewResponseEnvelopeErrors struct {
	Code             int64                                                          `json:"code" api:"required"`
	Message          string                                                         `json:"message" api:"required"`
	DocumentationURL string                                                         `json:"documentation_url"`
	Source           SettingSendingDomainRestrictionNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingSendingDomainRestrictionNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingSendingDomainRestrictionNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionNewResponseEnvelopeErrorsSource ¶ added in v7.4.0 

type SettingSendingDomainRestrictionNewResponseEnvelopeErrorsSource struct {
	Pointer string                                                             `json:"pointer"`
	JSON    settingSendingDomainRestrictionNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingSendingDomainRestrictionNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionNewResponseEnvelopeMessages ¶ added in v7.4.0 

type SettingSendingDomainRestrictionNewResponseEnvelopeMessages struct {
	Code             int64                                                            `json:"code" api:"required"`
	Message          string                                                           `json:"message" api:"required"`
	DocumentationURL string                                                           `json:"documentation_url"`
	Source           SettingSendingDomainRestrictionNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingSendingDomainRestrictionNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingSendingDomainRestrictionNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionNewResponseEnvelopeMessagesSource ¶ added in v7.4.0 

type SettingSendingDomainRestrictionNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                               `json:"pointer"`
	JSON    settingSendingDomainRestrictionNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingSendingDomainRestrictionNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingSendingDomainRestrictionNewResponseEnvelopeSuccess ¶ added in v7.4.0 

type SettingSendingDomainRestrictionNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingSendingDomainRestrictionNewResponseEnvelopeSuccessTrue SettingSendingDomainRestrictionNewResponseEnvelopeSuccess = true
)

func (SettingSendingDomainRestrictionNewResponseEnvelopeSuccess) IsKnown ¶ added in v7.4.0 

func (r SettingSendingDomainRestrictionNewResponseEnvelopeSuccess) IsKnown() bool

type SettingSendingDomainRestrictionService ¶ added in v7.4.0 

type SettingSendingDomainRestrictionService struct {
	Options []option.RequestOption
}

SettingSendingDomainRestrictionService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSettingSendingDomainRestrictionService method instead.

func NewSettingSendingDomainRestrictionService ¶ added in v7.4.0 

func NewSettingSendingDomainRestrictionService(opts ...option.RequestOption) (r *SettingSendingDomainRestrictionService)

NewSettingSendingDomainRestrictionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SettingSendingDomainRestrictionService) Delete ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionService) Delete(ctx context.Context, sendingDomainRestrictionID string, body SettingSendingDomainRestrictionDeleteParams, opts ...option.RequestOption) (res *SettingSendingDomainRestrictionDeleteResponse, err error)

Removes a sending domain restriction. After deletion, TLS will no longer be enforced for emails from this domain.

func (*SettingSendingDomainRestrictionService) Edit ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionService) Edit(ctx context.Context, sendingDomainRestrictionID string, params SettingSendingDomainRestrictionEditParams, opts ...option.RequestOption) (res *SettingSendingDomainRestrictionEditResponse, err error)

Updates an existing sending domain restriction. Only provided fields will be modified. Changes affect which domains require TLS and which subdomains are excluded.

func (*SettingSendingDomainRestrictionService) Get ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionService) Get(ctx context.Context, sendingDomainRestrictionID string, query SettingSendingDomainRestrictionGetParams, opts ...option.RequestOption) (res *SettingSendingDomainRestrictionGetResponse, err error)

Retrieves details for a specific sending domain restriction including the domain requiring TLS and any excluded subdomains exempt from the TLS requirement.

func (*SettingSendingDomainRestrictionService) List ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionService) List(ctx context.Context, params SettingSendingDomainRestrictionListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SettingSendingDomainRestrictionListResponse], err error)

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.

func (*SettingSendingDomainRestrictionService) ListAutoPaging ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionService) ListAutoPaging(ctx context.Context, params SettingSendingDomainRestrictionListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SettingSendingDomainRestrictionListResponse]

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.

func (*SettingSendingDomainRestrictionService) New ¶ added in v7.4.0 

func (r *SettingSendingDomainRestrictionService) New(ctx context.Context, params SettingSendingDomainRestrictionNewParams, opts ...option.RequestOption) (res *SettingSendingDomainRestrictionNewResponse, err error)

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.

type SettingService ¶ 

type SettingService struct {
	Options                   []option.RequestOption
	AllowPolicies             *SettingAllowPolicyService
	BlockSenders              *SettingBlockSenderService
	Domains                   *SettingDomainService
	ImpersonationRegistry     *SettingImpersonationRegistryService
	SendingDomainRestrictions *SettingSendingDomainRestrictionService
	TrustedDomains            *SettingTrustedDomainService
	URLIgnorePatterns         *SettingURLIgnorePatternService
}

SettingService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSettingService method instead.

func NewSettingService ¶ 

func NewSettingService(opts ...option.RequestOption) (r *SettingService)

NewSettingService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type SettingTrustedDomainDeleteParams ¶ 

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

type SettingTrustedDomainDeleteResponse ¶ 

type SettingTrustedDomainDeleteResponse struct {
	// Trusted domain identifier
	ID   string                                 `json:"id" api:"required" format:"uuid"`
	JSON settingTrustedDomainDeleteResponseJSON `json:"-"`
}

func (*SettingTrustedDomainDeleteResponse) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainDeleteResponse) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainDeleteResponseEnvelope ¶ 

type SettingTrustedDomainDeleteResponseEnvelope struct {
	Errors   []SettingTrustedDomainDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingTrustedDomainDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingTrustedDomainDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SettingTrustedDomainDeleteResponse                `json:"result"`
	JSON    settingTrustedDomainDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*SettingTrustedDomainDeleteResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainDeleteResponseEnvelopeErrors ¶ 

type SettingTrustedDomainDeleteResponseEnvelopeErrors struct {
	Code             int64                                                  `json:"code" api:"required"`
	Message          string                                                 `json:"message" api:"required"`
	DocumentationURL string                                                 `json:"documentation_url"`
	Source           SettingTrustedDomainDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingTrustedDomainDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingTrustedDomainDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainDeleteResponseEnvelopeErrorsSource ¶ 

type SettingTrustedDomainDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                     `json:"pointer"`
	JSON    settingTrustedDomainDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingTrustedDomainDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainDeleteResponseEnvelopeMessages ¶ 

type SettingTrustedDomainDeleteResponseEnvelopeMessages struct {
	Code             int64                                                    `json:"code" api:"required"`
	Message          string                                                   `json:"message" api:"required"`
	DocumentationURL string                                                   `json:"documentation_url"`
	Source           SettingTrustedDomainDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingTrustedDomainDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingTrustedDomainDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainDeleteResponseEnvelopeMessagesSource ¶ 

type SettingTrustedDomainDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                       `json:"pointer"`
	JSON    settingTrustedDomainDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingTrustedDomainDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainDeleteResponseEnvelopeSuccess ¶ 

type SettingTrustedDomainDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingTrustedDomainDeleteResponseEnvelopeSuccessTrue SettingTrustedDomainDeleteResponseEnvelopeSuccess = true
)

func (SettingTrustedDomainDeleteResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingTrustedDomainDeleteResponseEnvelopeSuccess) IsKnown() bool

type SettingTrustedDomainEditParams ¶ 

type SettingTrustedDomainEditParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Comments  param.Field[string] `json:"comments"`
	// Select to prevent recently registered domains from triggering a Suspicious or
	// Malicious disposition.
	IsRecent param.Field[bool] `json:"is_recent"`
	IsRegex  param.Field[bool] `json:"is_regex"`
	// Select for partner or other approved domains that have similar spelling to your
	// connected domains. Prevents listed domains from triggering a Spoof disposition.
	IsSimilarity param.Field[bool]   `json:"is_similarity"`
	Pattern      param.Field[string] `json:"pattern"`
}

func (SettingTrustedDomainEditParams) MarshalJSON ¶ 

func (r SettingTrustedDomainEditParams) MarshalJSON() (data []byte, err error)

type SettingTrustedDomainEditResponse ¶ 

type SettingTrustedDomainEditResponse struct {
	// Trusted domain identifier
	ID        string    `json:"id" format:"uuid"`
	Comments  string    `json:"comments" api:"nullable"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Select to prevent recently registered domains from triggering a Suspicious or
	// Malicious disposition.
	IsRecent bool `json:"is_recent"`
	IsRegex  bool `json:"is_regex"`
	// Select for partner or other approved domains that have similar spelling to your
	// connected domains. Prevents listed domains from triggering a Spoof disposition.
	IsSimilarity bool `json:"is_similarity"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                            `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                            `json:"modified_at" format:"date-time"`
	Pattern      string                               `json:"pattern"`
	JSON         settingTrustedDomainEditResponseJSON `json:"-"`
}

A trusted email domain

func (*SettingTrustedDomainEditResponse) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainEditResponse) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainEditResponseEnvelope ¶ 

type SettingTrustedDomainEditResponseEnvelope struct {
	Errors   []SettingTrustedDomainEditResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingTrustedDomainEditResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingTrustedDomainEditResponseEnvelopeSuccess `json:"success" api:"required"`
	// A trusted email domain
	Result SettingTrustedDomainEditResponse             `json:"result"`
	JSON   settingTrustedDomainEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingTrustedDomainEditResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainEditResponseEnvelopeErrors ¶ 

type SettingTrustedDomainEditResponseEnvelopeErrors struct {
	Code             int64                                                `json:"code" api:"required"`
	Message          string                                               `json:"message" api:"required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           SettingTrustedDomainEditResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingTrustedDomainEditResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingTrustedDomainEditResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainEditResponseEnvelopeErrorsSource ¶ 

type SettingTrustedDomainEditResponseEnvelopeErrorsSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    settingTrustedDomainEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingTrustedDomainEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainEditResponseEnvelopeMessages ¶ 

type SettingTrustedDomainEditResponseEnvelopeMessages struct {
	Code             int64                                                  `json:"code" api:"required"`
	Message          string                                                 `json:"message" api:"required"`
	DocumentationURL string                                                 `json:"documentation_url"`
	Source           SettingTrustedDomainEditResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingTrustedDomainEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingTrustedDomainEditResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainEditResponseEnvelopeMessagesSource ¶ 

type SettingTrustedDomainEditResponseEnvelopeMessagesSource struct {
	Pointer string                                                     `json:"pointer"`
	JSON    settingTrustedDomainEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingTrustedDomainEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainEditResponseEnvelopeSuccess ¶ 

type SettingTrustedDomainEditResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingTrustedDomainEditResponseEnvelopeSuccessTrue SettingTrustedDomainEditResponseEnvelopeSuccess = true
)

func (SettingTrustedDomainEditResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingTrustedDomainEditResponseEnvelopeSuccess) IsKnown() bool

type SettingTrustedDomainGetParams ¶ 

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

type SettingTrustedDomainGetResponse ¶ 

type SettingTrustedDomainGetResponse struct {
	// Trusted domain identifier
	ID        string    `json:"id" format:"uuid"`
	Comments  string    `json:"comments" api:"nullable"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Select to prevent recently registered domains from triggering a Suspicious or
	// Malicious disposition.
	IsRecent bool `json:"is_recent"`
	IsRegex  bool `json:"is_regex"`
	// Select for partner or other approved domains that have similar spelling to your
	// connected domains. Prevents listed domains from triggering a Spoof disposition.
	IsSimilarity bool `json:"is_similarity"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                           `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                           `json:"modified_at" format:"date-time"`
	Pattern      string                              `json:"pattern"`
	JSON         settingTrustedDomainGetResponseJSON `json:"-"`
}

A trusted email domain

func (*SettingTrustedDomainGetResponse) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainGetResponse) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainGetResponseEnvelope ¶ 

type SettingTrustedDomainGetResponseEnvelope struct {
	Errors   []SettingTrustedDomainGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingTrustedDomainGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingTrustedDomainGetResponseEnvelopeSuccess `json:"success" api:"required"`
	// A trusted email domain
	Result SettingTrustedDomainGetResponse             `json:"result"`
	JSON   settingTrustedDomainGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingTrustedDomainGetResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainGetResponseEnvelopeErrors ¶ 

type SettingTrustedDomainGetResponseEnvelopeErrors struct {
	Code             int64                                               `json:"code" api:"required"`
	Message          string                                              `json:"message" api:"required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           SettingTrustedDomainGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingTrustedDomainGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingTrustedDomainGetResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainGetResponseEnvelopeErrorsSource ¶ 

type SettingTrustedDomainGetResponseEnvelopeErrorsSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    settingTrustedDomainGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingTrustedDomainGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainGetResponseEnvelopeMessages ¶ 

type SettingTrustedDomainGetResponseEnvelopeMessages struct {
	Code             int64                                                 `json:"code" api:"required"`
	Message          string                                                `json:"message" api:"required"`
	DocumentationURL string                                                `json:"documentation_url"`
	Source           SettingTrustedDomainGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingTrustedDomainGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingTrustedDomainGetResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainGetResponseEnvelopeMessagesSource ¶ 

type SettingTrustedDomainGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                    `json:"pointer"`
	JSON    settingTrustedDomainGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingTrustedDomainGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainGetResponseEnvelopeSuccess ¶ 

type SettingTrustedDomainGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingTrustedDomainGetResponseEnvelopeSuccessTrue SettingTrustedDomainGetResponseEnvelopeSuccess = true
)

func (SettingTrustedDomainGetResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingTrustedDomainGetResponseEnvelopeSuccess) IsKnown() bool

type SettingTrustedDomainListParams ¶ 

type SettingTrustedDomainListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The sorting direction.
	Direction param.Field[SettingTrustedDomainListParamsDirection] `query:"direction"`
	// Filter to show only recently registered domains that are trusted to prevent
	// triggering Suspicious or Malicious dispositions.
	IsRecent param.Field[bool] `query:"is_recent"`
	// Filter to show only proximity domains (partner or approved domains with similar
	// spelling to connected domains) that prevent Spoof dispositions.
	IsSimilarity param.Field[bool] `query:"is_similarity"`
	// Field to sort by.
	Order param.Field[SettingTrustedDomainListParamsOrder] `query:"order"`
	// Current page within paginated list of results.
	Page    param.Field[int64]  `query:"page"`
	Pattern param.Field[string] `query:"pattern"`
	// The number of results per page. Maximum value is 1000.
	PerPage param.Field[int64] `query:"per_page"`
	// Search term for filtering records. Behavior may change.
	Search param.Field[string] `query:"search"`
}

func (SettingTrustedDomainListParams) URLQuery ¶ 

func (r SettingTrustedDomainListParams) URLQuery() (v url.Values)

URLQuery serializes SettingTrustedDomainListParams's query parameters as `url.Values`.

type SettingTrustedDomainListParamsDirection ¶ 

type SettingTrustedDomainListParamsDirection string

The sorting direction. 

const (
	SettingTrustedDomainListParamsDirectionAsc  SettingTrustedDomainListParamsDirection = "asc"
	SettingTrustedDomainListParamsDirectionDesc SettingTrustedDomainListParamsDirection = "desc"
)

func (SettingTrustedDomainListParamsDirection) IsKnown ¶ 

func (r SettingTrustedDomainListParamsDirection) IsKnown() bool

type SettingTrustedDomainListParamsOrder ¶ 

type SettingTrustedDomainListParamsOrder string

Field to sort by. 

const (
	SettingTrustedDomainListParamsOrderPattern   SettingTrustedDomainListParamsOrder = "pattern"
	SettingTrustedDomainListParamsOrderCreatedAt SettingTrustedDomainListParamsOrder = "created_at"
)

func (SettingTrustedDomainListParamsOrder) IsKnown ¶ 

func (r SettingTrustedDomainListParamsOrder) IsKnown() bool

type SettingTrustedDomainListResponse ¶ 

type SettingTrustedDomainListResponse struct {
	// Trusted domain identifier
	ID        string    `json:"id" format:"uuid"`
	Comments  string    `json:"comments" api:"nullable"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Select to prevent recently registered domains from triggering a Suspicious or
	// Malicious disposition.
	IsRecent bool `json:"is_recent"`
	IsRegex  bool `json:"is_regex"`
	// Select for partner or other approved domains that have similar spelling to your
	// connected domains. Prevents listed domains from triggering a Spoof disposition.
	IsSimilarity bool `json:"is_similarity"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                            `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                            `json:"modified_at" format:"date-time"`
	Pattern      string                               `json:"pattern"`
	JSON         settingTrustedDomainListResponseJSON `json:"-"`
}

A trusted email domain

func (*SettingTrustedDomainListResponse) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainListResponse) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainNewParams ¶ 

type SettingTrustedDomainNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Select to prevent recently registered domains from triggering a Suspicious or
	// Malicious disposition.
	IsRecent param.Field[bool] `json:"is_recent" api:"required"`
	IsRegex  param.Field[bool] `json:"is_regex" api:"required"`
	// Select for partner or other approved domains that have similar spelling to your
	// connected domains. Prevents listed domains from triggering a Spoof disposition.
	IsSimilarity param.Field[bool]   `json:"is_similarity" api:"required"`
	Pattern      param.Field[string] `json:"pattern" api:"required"`
	Comments     param.Field[string] `json:"comments"`
}

func (SettingTrustedDomainNewParams) MarshalJSON ¶ 

func (r SettingTrustedDomainNewParams) MarshalJSON() (data []byte, err error)

type SettingTrustedDomainNewResponse ¶ 

type SettingTrustedDomainNewResponse struct {
	// Trusted domain identifier
	ID        string    `json:"id" format:"uuid"`
	Comments  string    `json:"comments" api:"nullable"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Select to prevent recently registered domains from triggering a Suspicious or
	// Malicious disposition.
	IsRecent bool `json:"is_recent"`
	IsRegex  bool `json:"is_regex"`
	// Select for partner or other approved domains that have similar spelling to your
	// connected domains. Prevents listed domains from triggering a Spoof disposition.
	IsSimilarity bool `json:"is_similarity"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                           `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                           `json:"modified_at" format:"date-time"`
	Pattern      string                              `json:"pattern"`
	JSON         settingTrustedDomainNewResponseJSON `json:"-"`
}

A trusted email domain

func (*SettingTrustedDomainNewResponse) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainNewResponse) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainNewResponseEnvelope ¶ 

type SettingTrustedDomainNewResponseEnvelope struct {
	Errors   []SettingTrustedDomainNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingTrustedDomainNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingTrustedDomainNewResponseEnvelopeSuccess `json:"success" api:"required"`
	// A trusted email domain
	Result SettingTrustedDomainNewResponse             `json:"result"`
	JSON   settingTrustedDomainNewResponseEnvelopeJSON `json:"-"`
}

func (*SettingTrustedDomainNewResponseEnvelope) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainNewResponseEnvelopeErrors ¶ 

type SettingTrustedDomainNewResponseEnvelopeErrors struct {
	Code             int64                                               `json:"code" api:"required"`
	Message          string                                              `json:"message" api:"required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           SettingTrustedDomainNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingTrustedDomainNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingTrustedDomainNewResponseEnvelopeErrors) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainNewResponseEnvelopeErrorsSource ¶ 

type SettingTrustedDomainNewResponseEnvelopeErrorsSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    settingTrustedDomainNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingTrustedDomainNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainNewResponseEnvelopeMessages ¶ 

type SettingTrustedDomainNewResponseEnvelopeMessages struct {
	Code             int64                                                 `json:"code" api:"required"`
	Message          string                                                `json:"message" api:"required"`
	DocumentationURL string                                                `json:"documentation_url"`
	Source           SettingTrustedDomainNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingTrustedDomainNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingTrustedDomainNewResponseEnvelopeMessages) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainNewResponseEnvelopeMessagesSource ¶ 

type SettingTrustedDomainNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                    `json:"pointer"`
	JSON    settingTrustedDomainNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingTrustedDomainNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

func (r *SettingTrustedDomainNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainNewResponseEnvelopeSuccess ¶ 

type SettingTrustedDomainNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingTrustedDomainNewResponseEnvelopeSuccessTrue SettingTrustedDomainNewResponseEnvelopeSuccess = true
)

func (SettingTrustedDomainNewResponseEnvelopeSuccess) IsKnown ¶ 

func (r SettingTrustedDomainNewResponseEnvelopeSuccess) IsKnown() bool

type SettingTrustedDomainService ¶ 

type SettingTrustedDomainService struct {
	Options []option.RequestOption
}

SettingTrustedDomainService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSettingTrustedDomainService method instead.

func NewSettingTrustedDomainService ¶ 

func NewSettingTrustedDomainService(opts ...option.RequestOption) (r *SettingTrustedDomainService)

NewSettingTrustedDomainService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SettingTrustedDomainService) Delete ¶ 

func (r *SettingTrustedDomainService) Delete(ctx context.Context, trustedDomainID string, body SettingTrustedDomainDeleteParams, opts ...option.RequestOption) (res *SettingTrustedDomainDeleteResponse, err error)

Removes a trusted domain pattern. After deletion, emails from this domain will be subject to normal recent domain and similarity checks.

func (*SettingTrustedDomainService) Edit ¶ 

func (r *SettingTrustedDomainService) Edit(ctx context.Context, trustedDomainID string, params SettingTrustedDomainEditParams, opts ...option.RequestOption) (res *SettingTrustedDomainEditResponse, err error)

Updates an existing trusted domain pattern. Only provided fields will be modified. Changes take effect for new emails matching the pattern.

func (*SettingTrustedDomainService) Get ¶ 

func (r *SettingTrustedDomainService) Get(ctx context.Context, trustedDomainID string, query SettingTrustedDomainGetParams, opts ...option.RequestOption) (res *SettingTrustedDomainGetResponse, err error)

Retrieves details for a specific trusted domain pattern including its pattern value, whether it uses regex matching, and which detection types it affects.

func (*SettingTrustedDomainService) List ¶ 

func (r *SettingTrustedDomainService) List(ctx context.Context, params SettingTrustedDomainListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SettingTrustedDomainListResponse], err error)

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.

func (*SettingTrustedDomainService) ListAutoPaging ¶ 

func (r *SettingTrustedDomainService) ListAutoPaging(ctx context.Context, params SettingTrustedDomainListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SettingTrustedDomainListResponse]

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.

func (*SettingTrustedDomainService) New ¶ 

func (r *SettingTrustedDomainService) New(ctx context.Context, params SettingTrustedDomainNewParams, opts ...option.RequestOption) (res *SettingTrustedDomainNewResponse, err error)

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.

type SettingURLIgnorePatternDeleteParams ¶ added in v7.4.0 

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

type SettingURLIgnorePatternDeleteResponse ¶ added in v7.4.0 

type SettingURLIgnorePatternDeleteResponse struct {
	// URL ignore pattern identifier
	ID   string                                    `json:"id" api:"required" format:"uuid"`
	JSON settingURLIgnorePatternDeleteResponseJSON `json:"-"`
}

func (*SettingURLIgnorePatternDeleteResponse) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternDeleteResponse) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternDeleteResponseEnvelope ¶ added in v7.4.0 

type SettingURLIgnorePatternDeleteResponseEnvelope struct {
	Errors   []SettingURLIgnorePatternDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingURLIgnorePatternDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingURLIgnorePatternDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SettingURLIgnorePatternDeleteResponse                `json:"result"`
	JSON    settingURLIgnorePatternDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*SettingURLIgnorePatternDeleteResponseEnvelope) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternDeleteResponseEnvelopeErrors ¶ added in v7.4.0 

type SettingURLIgnorePatternDeleteResponseEnvelopeErrors struct {
	Code             int64                                                     `json:"code" api:"required"`
	Message          string                                                    `json:"message" api:"required"`
	DocumentationURL string                                                    `json:"documentation_url"`
	Source           SettingURLIgnorePatternDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingURLIgnorePatternDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingURLIgnorePatternDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternDeleteResponseEnvelopeErrorsSource ¶ added in v7.4.0 

type SettingURLIgnorePatternDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                        `json:"pointer"`
	JSON    settingURLIgnorePatternDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingURLIgnorePatternDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternDeleteResponseEnvelopeMessages ¶ added in v7.4.0 

type SettingURLIgnorePatternDeleteResponseEnvelopeMessages struct {
	Code             int64                                                       `json:"code" api:"required"`
	Message          string                                                      `json:"message" api:"required"`
	DocumentationURL string                                                      `json:"documentation_url"`
	Source           SettingURLIgnorePatternDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingURLIgnorePatternDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingURLIgnorePatternDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternDeleteResponseEnvelopeMessagesSource ¶ added in v7.4.0 

type SettingURLIgnorePatternDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                          `json:"pointer"`
	JSON    settingURLIgnorePatternDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingURLIgnorePatternDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternDeleteResponseEnvelopeSuccess ¶ added in v7.4.0 

type SettingURLIgnorePatternDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingURLIgnorePatternDeleteResponseEnvelopeSuccessTrue SettingURLIgnorePatternDeleteResponseEnvelopeSuccess = true
)

func (SettingURLIgnorePatternDeleteResponseEnvelopeSuccess) IsKnown ¶ added in v7.4.0 

func (r SettingURLIgnorePatternDeleteResponseEnvelopeSuccess) IsKnown() bool

type SettingURLIgnorePatternEditParams ¶ added in v7.4.0 

type SettingURLIgnorePatternEditParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Optional note describing the reason for the ignore pattern.
	Comments param.Field[string] `json:"comments"`
	// Regular expression matching URLs that should not be rewritten.
	Pattern param.Field[string] `json:"pattern"`
}

func (SettingURLIgnorePatternEditParams) MarshalJSON ¶ added in v7.4.0 

func (r SettingURLIgnorePatternEditParams) MarshalJSON() (data []byte, err error)

type SettingURLIgnorePatternEditResponse ¶ added in v7.4.0 

type SettingURLIgnorePatternEditResponse struct {
	// URL ignore pattern identifier
	ID        string    `json:"id" api:"required" format:"uuid"`
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Regular expression matching URLs that should not be rewritten.
	Pattern string `json:"pattern" api:"required"`
	// Optional note describing the reason for the ignore pattern.
	Comments string `json:"comments" api:"nullable"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                               `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                               `json:"modified_at" format:"date-time"`
	JSON         settingURLIgnorePatternEditResponseJSON `json:"-"`
}

A URL ignore pattern that exempts matching URLs from being rewritten by Email Security.

func (*SettingURLIgnorePatternEditResponse) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternEditResponse) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternEditResponseEnvelope ¶ added in v7.4.0 

type SettingURLIgnorePatternEditResponseEnvelope struct {
	Errors   []SettingURLIgnorePatternEditResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingURLIgnorePatternEditResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingURLIgnorePatternEditResponseEnvelopeSuccess `json:"success" api:"required"`
	// A URL ignore pattern that exempts matching URLs from being rewritten by Email
	// Security.
	Result SettingURLIgnorePatternEditResponse             `json:"result"`
	JSON   settingURLIgnorePatternEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingURLIgnorePatternEditResponseEnvelope) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternEditResponseEnvelopeErrors ¶ added in v7.4.0 

type SettingURLIgnorePatternEditResponseEnvelopeErrors struct {
	Code             int64                                                   `json:"code" api:"required"`
	Message          string                                                  `json:"message" api:"required"`
	DocumentationURL string                                                  `json:"documentation_url"`
	Source           SettingURLIgnorePatternEditResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingURLIgnorePatternEditResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingURLIgnorePatternEditResponseEnvelopeErrors) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternEditResponseEnvelopeErrorsSource ¶ added in v7.4.0 

type SettingURLIgnorePatternEditResponseEnvelopeErrorsSource struct {
	Pointer string                                                      `json:"pointer"`
	JSON    settingURLIgnorePatternEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingURLIgnorePatternEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternEditResponseEnvelopeMessages ¶ added in v7.4.0 

type SettingURLIgnorePatternEditResponseEnvelopeMessages struct {
	Code             int64                                                     `json:"code" api:"required"`
	Message          string                                                    `json:"message" api:"required"`
	DocumentationURL string                                                    `json:"documentation_url"`
	Source           SettingURLIgnorePatternEditResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingURLIgnorePatternEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingURLIgnorePatternEditResponseEnvelopeMessages) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternEditResponseEnvelopeMessagesSource ¶ added in v7.4.0 

type SettingURLIgnorePatternEditResponseEnvelopeMessagesSource struct {
	Pointer string                                                        `json:"pointer"`
	JSON    settingURLIgnorePatternEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingURLIgnorePatternEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternEditResponseEnvelopeSuccess ¶ added in v7.4.0 

type SettingURLIgnorePatternEditResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingURLIgnorePatternEditResponseEnvelopeSuccessTrue SettingURLIgnorePatternEditResponseEnvelopeSuccess = true
)

func (SettingURLIgnorePatternEditResponseEnvelopeSuccess) IsKnown ¶ added in v7.4.0 

func (r SettingURLIgnorePatternEditResponseEnvelopeSuccess) IsKnown() bool

type SettingURLIgnorePatternGetParams ¶ added in v7.4.0 

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

type SettingURLIgnorePatternGetResponse ¶ added in v7.4.0 

type SettingURLIgnorePatternGetResponse struct {
	// URL ignore pattern identifier
	ID        string    `json:"id" api:"required" format:"uuid"`
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Regular expression matching URLs that should not be rewritten.
	Pattern string `json:"pattern" api:"required"`
	// Optional note describing the reason for the ignore pattern.
	Comments string `json:"comments" api:"nullable"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                              `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                              `json:"modified_at" format:"date-time"`
	JSON         settingURLIgnorePatternGetResponseJSON `json:"-"`
}

A URL ignore pattern that exempts matching URLs from being rewritten by Email Security.

func (*SettingURLIgnorePatternGetResponse) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternGetResponse) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternGetResponseEnvelope ¶ added in v7.4.0 

type SettingURLIgnorePatternGetResponseEnvelope struct {
	Errors   []SettingURLIgnorePatternGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingURLIgnorePatternGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingURLIgnorePatternGetResponseEnvelopeSuccess `json:"success" api:"required"`
	// A URL ignore pattern that exempts matching URLs from being rewritten by Email
	// Security.
	Result SettingURLIgnorePatternGetResponse             `json:"result"`
	JSON   settingURLIgnorePatternGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingURLIgnorePatternGetResponseEnvelope) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternGetResponseEnvelopeErrors ¶ added in v7.4.0 

type SettingURLIgnorePatternGetResponseEnvelopeErrors struct {
	Code             int64                                                  `json:"code" api:"required"`
	Message          string                                                 `json:"message" api:"required"`
	DocumentationURL string                                                 `json:"documentation_url"`
	Source           SettingURLIgnorePatternGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingURLIgnorePatternGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingURLIgnorePatternGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternGetResponseEnvelopeErrorsSource ¶ added in v7.4.0 

type SettingURLIgnorePatternGetResponseEnvelopeErrorsSource struct {
	Pointer string                                                     `json:"pointer"`
	JSON    settingURLIgnorePatternGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingURLIgnorePatternGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternGetResponseEnvelopeMessages ¶ added in v7.4.0 

type SettingURLIgnorePatternGetResponseEnvelopeMessages struct {
	Code             int64                                                    `json:"code" api:"required"`
	Message          string                                                   `json:"message" api:"required"`
	DocumentationURL string                                                   `json:"documentation_url"`
	Source           SettingURLIgnorePatternGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingURLIgnorePatternGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingURLIgnorePatternGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternGetResponseEnvelopeMessagesSource ¶ added in v7.4.0 

type SettingURLIgnorePatternGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                       `json:"pointer"`
	JSON    settingURLIgnorePatternGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingURLIgnorePatternGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternGetResponseEnvelopeSuccess ¶ added in v7.4.0 

type SettingURLIgnorePatternGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingURLIgnorePatternGetResponseEnvelopeSuccessTrue SettingURLIgnorePatternGetResponseEnvelopeSuccess = true
)

func (SettingURLIgnorePatternGetResponseEnvelopeSuccess) IsKnown ¶ added in v7.4.0 

func (r SettingURLIgnorePatternGetResponseEnvelopeSuccess) IsKnown() bool

type SettingURLIgnorePatternListParams ¶ added in v7.4.0 

type SettingURLIgnorePatternListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Current page within paginated list of results.
	Page param.Field[int64] `query:"page"`
	// The number of results per page. Maximum value is 1000.
	PerPage param.Field[int64] `query:"per_page"`
}

func (SettingURLIgnorePatternListParams) URLQuery ¶ added in v7.4.0 

func (r SettingURLIgnorePatternListParams) URLQuery() (v url.Values)

URLQuery serializes SettingURLIgnorePatternListParams's query parameters as `url.Values`.

type SettingURLIgnorePatternListResponse ¶ added in v7.4.0 

type SettingURLIgnorePatternListResponse struct {
	// URL ignore pattern identifier
	ID        string    `json:"id" api:"required" format:"uuid"`
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Regular expression matching URLs that should not be rewritten.
	Pattern string `json:"pattern" api:"required"`
	// Optional note describing the reason for the ignore pattern.
	Comments string `json:"comments" api:"nullable"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                               `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                               `json:"modified_at" format:"date-time"`
	JSON         settingURLIgnorePatternListResponseJSON `json:"-"`
}

A URL ignore pattern that exempts matching URLs from being rewritten by Email Security.

func (*SettingURLIgnorePatternListResponse) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternListResponse) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternNewParams ¶ added in v7.4.0 

type SettingURLIgnorePatternNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Regular expression matching URLs that should not be rewritten.
	Pattern param.Field[string] `json:"pattern" api:"required"`
	// Optional note describing the reason for the ignore pattern.
	Comments param.Field[string] `json:"comments"`
}

func (SettingURLIgnorePatternNewParams) MarshalJSON ¶ added in v7.4.0 

func (r SettingURLIgnorePatternNewParams) MarshalJSON() (data []byte, err error)

type SettingURLIgnorePatternNewResponse ¶ added in v7.4.0 

type SettingURLIgnorePatternNewResponse struct {
	// URL ignore pattern identifier
	ID        string    `json:"id" api:"required" format:"uuid"`
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Regular expression matching URLs that should not be rewritten.
	Pattern string `json:"pattern" api:"required"`
	// Optional note describing the reason for the ignore pattern.
	Comments string `json:"comments" api:"nullable"`
	// Deprecated, use `modified_at` instead. End of life: November 1, 2026.
	//
	// Deprecated: Use `modified_at` instead.
	LastModified time.Time                              `json:"last_modified" format:"date-time"`
	ModifiedAt   time.Time                              `json:"modified_at" format:"date-time"`
	JSON         settingURLIgnorePatternNewResponseJSON `json:"-"`
}

A URL ignore pattern that exempts matching URLs from being rewritten by Email Security.

func (*SettingURLIgnorePatternNewResponse) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternNewResponse) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternNewResponseEnvelope ¶ added in v7.4.0 

type SettingURLIgnorePatternNewResponseEnvelope struct {
	Errors   []SettingURLIgnorePatternNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SettingURLIgnorePatternNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SettingURLIgnorePatternNewResponseEnvelopeSuccess `json:"success" api:"required"`
	// A URL ignore pattern that exempts matching URLs from being rewritten by Email
	// Security.
	Result SettingURLIgnorePatternNewResponse             `json:"result"`
	JSON   settingURLIgnorePatternNewResponseEnvelopeJSON `json:"-"`
}

func (*SettingURLIgnorePatternNewResponseEnvelope) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternNewResponseEnvelopeErrors ¶ added in v7.4.0 

type SettingURLIgnorePatternNewResponseEnvelopeErrors struct {
	Code             int64                                                  `json:"code" api:"required"`
	Message          string                                                 `json:"message" api:"required"`
	DocumentationURL string                                                 `json:"documentation_url"`
	Source           SettingURLIgnorePatternNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             settingURLIgnorePatternNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SettingURLIgnorePatternNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternNewResponseEnvelopeErrorsSource ¶ added in v7.4.0 

type SettingURLIgnorePatternNewResponseEnvelopeErrorsSource struct {
	Pointer string                                                     `json:"pointer"`
	JSON    settingURLIgnorePatternNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SettingURLIgnorePatternNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternNewResponseEnvelopeMessages ¶ added in v7.4.0 

type SettingURLIgnorePatternNewResponseEnvelopeMessages struct {
	Code             int64                                                    `json:"code" api:"required"`
	Message          string                                                   `json:"message" api:"required"`
	DocumentationURL string                                                   `json:"documentation_url"`
	Source           SettingURLIgnorePatternNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             settingURLIgnorePatternNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SettingURLIgnorePatternNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternNewResponseEnvelopeMessagesSource ¶ added in v7.4.0 

type SettingURLIgnorePatternNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                       `json:"pointer"`
	JSON    settingURLIgnorePatternNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SettingURLIgnorePatternNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type SettingURLIgnorePatternNewResponseEnvelopeSuccess ¶ added in v7.4.0 

type SettingURLIgnorePatternNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SettingURLIgnorePatternNewResponseEnvelopeSuccessTrue SettingURLIgnorePatternNewResponseEnvelopeSuccess = true
)

func (SettingURLIgnorePatternNewResponseEnvelopeSuccess) IsKnown ¶ added in v7.4.0 

func (r SettingURLIgnorePatternNewResponseEnvelopeSuccess) IsKnown() bool

type SettingURLIgnorePatternService ¶ added in v7.4.0 

type SettingURLIgnorePatternService struct {
	Options []option.RequestOption
}

SettingURLIgnorePatternService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSettingURLIgnorePatternService method instead.

func NewSettingURLIgnorePatternService ¶ added in v7.4.0 

func NewSettingURLIgnorePatternService(opts ...option.RequestOption) (r *SettingURLIgnorePatternService)

NewSettingURLIgnorePatternService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SettingURLIgnorePatternService) Delete ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternService) Delete(ctx context.Context, patternID string, body SettingURLIgnorePatternDeleteParams, opts ...option.RequestOption) (res *SettingURLIgnorePatternDeleteResponse, err error)

Removes a URL rewrite ignore pattern. After deletion, URLs matching this pattern will be rewritten again.

func (*SettingURLIgnorePatternService) Edit ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternService) Edit(ctx context.Context, patternID string, params SettingURLIgnorePatternEditParams, opts ...option.RequestOption) (res *SettingURLIgnorePatternEditResponse, err error)

Updates an existing URL rewrite ignore pattern. Only provided fields will be modified.

func (*SettingURLIgnorePatternService) Get ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternService) Get(ctx context.Context, patternID string, query SettingURLIgnorePatternGetParams, opts ...option.RequestOption) (res *SettingURLIgnorePatternGetResponse, err error)

Returns a single URL rewrite ignore pattern by its identifier.

func (*SettingURLIgnorePatternService) List ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternService) List(ctx context.Context, params SettingURLIgnorePatternListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SettingURLIgnorePatternListResponse], err error)

Returns a paginated list of URL rewrite ignore patterns for the account. URLs matching these patterns will not be rewritten.

func (*SettingURLIgnorePatternService) ListAutoPaging ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternService) ListAutoPaging(ctx context.Context, params SettingURLIgnorePatternListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SettingURLIgnorePatternListResponse]

Returns a paginated list of URL rewrite ignore patterns for the account. URLs matching these patterns will not be rewritten.

func (*SettingURLIgnorePatternService) New ¶ added in v7.4.0 

func (r *SettingURLIgnorePatternService) New(ctx context.Context, params SettingURLIgnorePatternNewParams, opts ...option.RequestOption) (res *SettingURLIgnorePatternNewResponse, err error)

Creates a new URL rewrite ignore pattern. URLs matching this pattern will not be rewritten.

type SortDirection ¶ 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type SubmissionListParams ¶ 

type SubmissionListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The end of the search date range. Defaults to `now`.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// 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   param.Field[bool]                                    `query:"escalated_from_user"`
	OriginalDisposition param.Field[SubmissionListParamsOriginalDisposition] `query:"original_disposition"`
	OutcomeDisposition  param.Field[SubmissionListParamsOutcomeDisposition]  `query:"outcome_disposition"`
	// Current page within paginated list of results.
	Page param.Field[int64] `query:"page"`
	// The number of results per page. Maximum value is 1000.
	PerPage              param.Field[int64]                                    `query:"per_page"`
	Query                param.Field[string]                                   `query:"query"`
	RequestedDisposition param.Field[SubmissionListParamsRequestedDisposition] `query:"requested_disposition"`
	// The beginning of the search date range. Defaults to `now - 30 days`.
	Start        param.Field[time.Time]                `query:"start" format:"date-time"`
	Status       param.Field[string]                   `query:"status"`
	SubmissionID param.Field[string]                   `query:"submission_id"`
	Type         param.Field[SubmissionListParamsType] `query:"type"`
}

func (SubmissionListParams) URLQuery ¶ 

func (r SubmissionListParams) URLQuery() (v url.Values)

URLQuery serializes SubmissionListParams's query parameters as `url.Values`.

type SubmissionListParamsOriginalDisposition ¶ 

type SubmissionListParamsOriginalDisposition string
const (
	SubmissionListParamsOriginalDispositionMalicious  SubmissionListParamsOriginalDisposition = "MALICIOUS"
	SubmissionListParamsOriginalDispositionSuspicious SubmissionListParamsOriginalDisposition = "SUSPICIOUS"
	SubmissionListParamsOriginalDispositionSpoof      SubmissionListParamsOriginalDisposition = "SPOOF"
	SubmissionListParamsOriginalDispositionSpam       SubmissionListParamsOriginalDisposition = "SPAM"
	SubmissionListParamsOriginalDispositionBulk       SubmissionListParamsOriginalDisposition = "BULK"
	SubmissionListParamsOriginalDispositionNone       SubmissionListParamsOriginalDisposition = "NONE"
)

func (SubmissionListParamsOriginalDisposition) IsKnown ¶ 

func (r SubmissionListParamsOriginalDisposition) IsKnown() bool

type SubmissionListParamsOutcomeDisposition ¶ 

type SubmissionListParamsOutcomeDisposition string
const (
	SubmissionListParamsOutcomeDispositionMalicious  SubmissionListParamsOutcomeDisposition = "MALICIOUS"
	SubmissionListParamsOutcomeDispositionSuspicious SubmissionListParamsOutcomeDisposition = "SUSPICIOUS"
	SubmissionListParamsOutcomeDispositionSpoof      SubmissionListParamsOutcomeDisposition = "SPOOF"
	SubmissionListParamsOutcomeDispositionSpam       SubmissionListParamsOutcomeDisposition = "SPAM"
	SubmissionListParamsOutcomeDispositionBulk       SubmissionListParamsOutcomeDisposition = "BULK"
	SubmissionListParamsOutcomeDispositionNone       SubmissionListParamsOutcomeDisposition = "NONE"
)

func (SubmissionListParamsOutcomeDisposition) IsKnown ¶ 

func (r SubmissionListParamsOutcomeDisposition) IsKnown() bool

type SubmissionListParamsRequestedDisposition ¶ 

type SubmissionListParamsRequestedDisposition string
const (
	SubmissionListParamsRequestedDispositionMalicious  SubmissionListParamsRequestedDisposition = "MALICIOUS"
	SubmissionListParamsRequestedDispositionSuspicious SubmissionListParamsRequestedDisposition = "SUSPICIOUS"
	SubmissionListParamsRequestedDispositionSpoof      SubmissionListParamsRequestedDisposition = "SPOOF"
	SubmissionListParamsRequestedDispositionSpam       SubmissionListParamsRequestedDisposition = "SPAM"
	SubmissionListParamsRequestedDispositionBulk       SubmissionListParamsRequestedDisposition = "BULK"
	SubmissionListParamsRequestedDispositionNone       SubmissionListParamsRequestedDisposition = "NONE"
)

func (SubmissionListParamsRequestedDisposition) IsKnown ¶ 

func (r SubmissionListParamsRequestedDisposition) IsKnown() bool

type SubmissionListParamsType ¶ 

type SubmissionListParamsType string
const (
	SubmissionListParamsTypeTeam SubmissionListParamsType = "TEAM"
	SubmissionListParamsTypeUser SubmissionListParamsType = "USER"
)

func (SubmissionListParamsType) IsKnown ¶ 

func (r SubmissionListParamsType) IsKnown() bool

type SubmissionListResponse ¶ 

type SubmissionListResponse struct {
	// When the submission was requested (UTC).
	RequestedAt           time.Time                                 `json:"requested_at" api:"required" format:"date-time"`
	SubmissionID          string                                    `json:"submission_id" api:"required"`
	CustomerStatus        SubmissionListResponseCustomerStatus      `json:"customer_status" api:"nullable"`
	EscalatedAs           SubmissionListResponseEscalatedAs         `json:"escalated_as" api:"nullable"`
	EscalatedAt           time.Time                                 `json:"escalated_at" api:"nullable" format:"date-time"`
	EscalatedBy           string                                    `json:"escalated_by" api:"nullable"`
	EscalatedSubmissionID string                                    `json:"escalated_submission_id" api:"nullable"`
	OriginalDisposition   SubmissionListResponseOriginalDisposition `json:"original_disposition" api:"nullable"`
	OriginalEdfHash       string                                    `json:"original_edf_hash" api:"nullable"`
	// The postfix ID of the original message that was submitted
	OriginalPostfixID    string                                     `json:"original_postfix_id" api:"nullable"`
	Outcome              string                                     `json:"outcome" api:"nullable"`
	OutcomeDisposition   SubmissionListResponseOutcomeDisposition   `json:"outcome_disposition" api:"nullable"`
	RequestedBy          string                                     `json:"requested_by" api:"nullable"`
	RequestedDisposition SubmissionListResponseRequestedDisposition `json:"requested_disposition" api:"nullable"`
	// Deprecated, use `requested_at` instead
	//
	// Deprecated: Use `requested_at` instead.
	RequestedTs string `json:"requested_ts"`
	Status      string `json:"status" api:"nullable"`
	Subject     string `json:"subject" api:"nullable"`
	// Whether the submission was created by a team member or an end user.
	Type SubmissionListResponseType `json:"type" api:"nullable"`
	JSON submissionListResponseJSON `json:"-"`
}

func (*SubmissionListResponse) UnmarshalJSON ¶ 

func (r *SubmissionListResponse) UnmarshalJSON(data []byte) (err error)

type SubmissionListResponseCustomerStatus ¶ 

type SubmissionListResponseCustomerStatus string
const (
	SubmissionListResponseCustomerStatusEscalated  SubmissionListResponseCustomerStatus = "escalated"
	SubmissionListResponseCustomerStatusReviewed   SubmissionListResponseCustomerStatus = "reviewed"
	SubmissionListResponseCustomerStatusUnreviewed SubmissionListResponseCustomerStatus = "unreviewed"
)

func (SubmissionListResponseCustomerStatus) IsKnown ¶ 

func (r SubmissionListResponseCustomerStatus) IsKnown() bool

type SubmissionListResponseEscalatedAs ¶ 

type SubmissionListResponseEscalatedAs string
const (
	SubmissionListResponseEscalatedAsMalicious  SubmissionListResponseEscalatedAs = "MALICIOUS"
	SubmissionListResponseEscalatedAsSuspicious SubmissionListResponseEscalatedAs = "SUSPICIOUS"
	SubmissionListResponseEscalatedAsSpoof      SubmissionListResponseEscalatedAs = "SPOOF"
	SubmissionListResponseEscalatedAsSpam       SubmissionListResponseEscalatedAs = "SPAM"
	SubmissionListResponseEscalatedAsBulk       SubmissionListResponseEscalatedAs = "BULK"
	SubmissionListResponseEscalatedAsNone       SubmissionListResponseEscalatedAs = "NONE"
)

func (SubmissionListResponseEscalatedAs) IsKnown ¶ 

func (r SubmissionListResponseEscalatedAs) IsKnown() bool

type SubmissionListResponseOriginalDisposition ¶ 

type SubmissionListResponseOriginalDisposition string
const (
	SubmissionListResponseOriginalDispositionMalicious  SubmissionListResponseOriginalDisposition = "MALICIOUS"
	SubmissionListResponseOriginalDispositionSuspicious SubmissionListResponseOriginalDisposition = "SUSPICIOUS"
	SubmissionListResponseOriginalDispositionSpoof      SubmissionListResponseOriginalDisposition = "SPOOF"
	SubmissionListResponseOriginalDispositionSpam       SubmissionListResponseOriginalDisposition = "SPAM"
	SubmissionListResponseOriginalDispositionBulk       SubmissionListResponseOriginalDisposition = "BULK"
	SubmissionListResponseOriginalDispositionNone       SubmissionListResponseOriginalDisposition = "NONE"
)

func (SubmissionListResponseOriginalDisposition) IsKnown ¶ 

func (r SubmissionListResponseOriginalDisposition) IsKnown() bool

type SubmissionListResponseOutcomeDisposition ¶ 

type SubmissionListResponseOutcomeDisposition string
const (
	SubmissionListResponseOutcomeDispositionMalicious  SubmissionListResponseOutcomeDisposition = "MALICIOUS"
	SubmissionListResponseOutcomeDispositionSuspicious SubmissionListResponseOutcomeDisposition = "SUSPICIOUS"
	SubmissionListResponseOutcomeDispositionSpoof      SubmissionListResponseOutcomeDisposition = "SPOOF"
	SubmissionListResponseOutcomeDispositionSpam       SubmissionListResponseOutcomeDisposition = "SPAM"
	SubmissionListResponseOutcomeDispositionBulk       SubmissionListResponseOutcomeDisposition = "BULK"
	SubmissionListResponseOutcomeDispositionNone       SubmissionListResponseOutcomeDisposition = "NONE"
)

func (SubmissionListResponseOutcomeDisposition) IsKnown ¶ 

func (r SubmissionListResponseOutcomeDisposition) IsKnown() bool

type SubmissionListResponseRequestedDisposition ¶ 

type SubmissionListResponseRequestedDisposition string
const (
	SubmissionListResponseRequestedDispositionMalicious  SubmissionListResponseRequestedDisposition = "MALICIOUS"
	SubmissionListResponseRequestedDispositionSuspicious SubmissionListResponseRequestedDisposition = "SUSPICIOUS"
	SubmissionListResponseRequestedDispositionSpoof      SubmissionListResponseRequestedDisposition = "SPOOF"
	SubmissionListResponseRequestedDispositionSpam       SubmissionListResponseRequestedDisposition = "SPAM"
	SubmissionListResponseRequestedDispositionBulk       SubmissionListResponseRequestedDisposition = "BULK"
	SubmissionListResponseRequestedDispositionNone       SubmissionListResponseRequestedDisposition = "NONE"
)

func (SubmissionListResponseRequestedDisposition) IsKnown ¶ 

func (r SubmissionListResponseRequestedDisposition) IsKnown() bool

type SubmissionListResponseType ¶ 

type SubmissionListResponseType string

Whether the submission was created by a team member or an end user. 

const (
	SubmissionListResponseTypeTeam SubmissionListResponseType = "Team"
	SubmissionListResponseTypeUser SubmissionListResponseType = "User"
)

func (SubmissionListResponseType) IsKnown ¶ 

func (r SubmissionListResponseType) IsKnown() bool

type SubmissionService ¶ 

type SubmissionService struct {
	Options []option.RequestOption
}

SubmissionService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSubmissionService method instead.

func NewSubmissionService ¶ 

func NewSubmissionService(opts ...option.RequestOption) (r *SubmissionService)

NewSubmissionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SubmissionService) List ¶ 

func (r *SubmissionService) List(ctx context.Context, params SubmissionListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SubmissionListResponse], err error)

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.

func (*SubmissionService) ListAutoPaging ¶ 

func (r *SubmissionService) ListAutoPaging(ctx context.Context, params SubmissionListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SubmissionListResponse]

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.

type Subscription ¶ 

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency ¶ 

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam ¶ 

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState ¶ 

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token ¶ 

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition ¶ 

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList ¶ 

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam ¶ 

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam ¶ 

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP ¶ 

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam ¶ 

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam ¶ 

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy ¶ 

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect ¶ 

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam ¶ 

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup ¶ 

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam ¶ 

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta ¶ 

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam ¶ 

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested ¶ 

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam ¶ 

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString ¶ 

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam ¶ 

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion ¶ 

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam ¶ 

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus ¶ 

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue ¶ 

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

Source Files ¶

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.