cloudforce_one

package
v7.13.0 Latest Latest
Warning

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

 Go to latest Published: Oct 12, 2026 License: Apache-2.0 Imports: 19 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 BinaryStorageGetParams 

type BinaryStorageGetParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type BinaryStorageNewParams 

type BinaryStorageNewParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The binary file content to upload.
	File param.Field[io.Reader] `json:"file" api:"required" format:"binary"`
}

func (BinaryStorageNewParams) MarshalMultipart 

func (r BinaryStorageNewParams) MarshalMultipart() (data []byte, contentType string, err error)

type BinaryStorageNewResponse 

type BinaryStorageNewResponse struct {
	ContentType string                       `json:"content_type" api:"required"`
	Md5         string                       `json:"md5" api:"required"`
	Sha1        string                       `json:"sha1" api:"required"`
	Sha256      string                       `json:"sha256" api:"required"`
	JSON        binaryStorageNewResponseJSON `json:"-"`
}

func (*BinaryStorageNewResponse) UnmarshalJSON 

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

type BinaryStorageService 

type BinaryStorageService struct {
	Options []option.RequestOption
}

BinaryStorageService 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 NewBinaryStorageService method instead.

func NewBinaryStorageService 

func NewBinaryStorageService(opts ...option.RequestOption) (r *BinaryStorageService)

NewBinaryStorageService 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 (*BinaryStorageService) Get 

func (r *BinaryStorageService) Get(ctx context.Context, hash string, query BinaryStorageGetParams, opts ...option.RequestOption) (err error)

Retrieves a binary file from the Cloudforce One binary storage for analysis.

func (*BinaryStorageService) New 

func (r *BinaryStorageService) New(ctx context.Context, params BinaryStorageNewParams, opts ...option.RequestOption) (res *BinaryStorageNewResponse, err error)

Uploads a binary file to Cloudforce One's binary database for malware analysis and threat intelligence correlation.

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 CloudforceOneService 

type CloudforceOneService struct {
	Options       []option.RequestOption
	BinaryStorage *BinaryStorageService
	Requests      *RequestService
	Scans         *ScanService
	ThreatEvents  *ThreatEventService
	// Threat Signals API for managing threat intelligence feeds, articles, indicators,
	// and AI skills in Cloudforce One.
	//
	// ## Prerequisites
	//
	//  1. **API token** — requests must use an API token with Cloudforce One
	//     permissions; write operations (creating, editing, or deleting feeds, skills,
	//     and tags) require write access.
	//  2. **Plan limits** — access on the Free plan is limited; feed quotas and managed
	//     default skills apply.
	ThreatSignals *ThreatSignalService
}

CloudforceOneService 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 NewCloudforceOneService method instead.

func NewCloudforceOneService 

func NewCloudforceOneService(opts ...option.RequestOption) (r *CloudforceOneService)

NewCloudforceOneService 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 Item 

type Item struct {
	// UUID.
	ID string `json:"id" api:"required"`
	// Request content.
	Content  string    `json:"content" api:"required"`
	Created  time.Time `json:"created" api:"required" format:"date-time"`
	Priority time.Time `json:"priority" api:"required" format:"date-time"`
	// Requested information from request.
	Request string `json:"request" api:"required"`
	// Brief description of the request.
	Summary string `json:"summary" api:"required"`
	// The CISA defined Traffic Light Protocol (TLP).
	TLP       ItemTLP   `json:"tlp" api:"required"`
	Updated   time.Time `json:"updated" api:"required" format:"date-time"`
	Completed time.Time `json:"completed" format:"date-time"`
	// Tokens for the request messages.
	MessageTokens int64 `json:"message_tokens"`
	// Readable Request ID.
	ReadableID string `json:"readable_id"`
	// Request Status.
	Status ItemStatus `json:"status"`
	// Tokens for the request.
	Tokens int64    `json:"tokens"`
	JSON   itemJSON `json:"-"`
}

func (*Item) UnmarshalJSON 

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

type ItemStatus 

type ItemStatus string

Request Status. 

const (
	ItemStatusOpen      ItemStatus = "open"
	ItemStatusAccepted  ItemStatus = "accepted"
	ItemStatusReported  ItemStatus = "reported"
	ItemStatusApproved  ItemStatus = "approved"
	ItemStatusCompleted ItemStatus = "completed"
	ItemStatusDeclined  ItemStatus = "declined"
)

func (ItemStatus) IsKnown 

func (r ItemStatus) IsKnown() bool

type ItemTLP 

type ItemTLP string

The CISA defined Traffic Light Protocol (TLP). 

const (
	ItemTLPClear       ItemTLP = "clear"
	ItemTLPAmber       ItemTLP = "amber"
	ItemTLPAmberStrict ItemTLP = "amber-strict"
	ItemTLPGreen       ItemTLP = "green"
	ItemTLPRed         ItemTLP = "red"
)

func (ItemTLP) IsKnown 

func (r ItemTLP) IsKnown() bool

type Label 

type Label = string

type LabelParam 

type LabelParam = string

type ListItem 

type ListItem struct {
	// UUID.
	ID string `json:"id" api:"required"`
	// Request creation time.
	Created  time.Time        `json:"created" api:"required" format:"date-time"`
	Priority ListItemPriority `json:"priority" api:"required"`
	// Requested information from request.
	Request string `json:"request" api:"required"`
	// Brief description of the request.
	Summary string `json:"summary" api:"required"`
	// The CISA defined Traffic Light Protocol (TLP).
	TLP ListItemTLP `json:"tlp" api:"required"`
	// Request last updated time.
	Updated time.Time `json:"updated" api:"required" format:"date-time"`
	// Request completion time.
	Completed time.Time `json:"completed" format:"date-time"`
	// Tokens for the request messages.
	MessageTokens int64 `json:"message_tokens"`
	// Readable Request ID.
	ReadableID string `json:"readable_id"`
	// Request Status.
	Status ListItemStatus `json:"status"`
	// Tokens for the request.
	Tokens int64        `json:"tokens"`
	JSON   listItemJSON `json:"-"`
}

func (*ListItem) UnmarshalJSON 

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

type ListItemPriority 

type ListItemPriority string
const (
	ListItemPriorityRoutine ListItemPriority = "routine"
	ListItemPriorityHigh    ListItemPriority = "high"
	ListItemPriorityUrgent  ListItemPriority = "urgent"
)

func (ListItemPriority) IsKnown 

func (r ListItemPriority) IsKnown() bool

type ListItemStatus 

type ListItemStatus string

Request Status. 

const (
	ListItemStatusOpen      ListItemStatus = "open"
	ListItemStatusAccepted  ListItemStatus = "accepted"
	ListItemStatusReported  ListItemStatus = "reported"
	ListItemStatusApproved  ListItemStatus = "approved"
	ListItemStatusCompleted ListItemStatus = "completed"
	ListItemStatusDeclined  ListItemStatus = "declined"
)

func (ListItemStatus) IsKnown 

func (r ListItemStatus) IsKnown() bool

type ListItemTLP 

type ListItemTLP string

The CISA defined Traffic Light Protocol (TLP). 

const (
	ListItemTLPClear       ListItemTLP = "clear"
	ListItemTLPAmber       ListItemTLP = "amber"
	ListItemTLPAmberStrict ListItemTLP = "amber-strict"
	ListItemTLPGreen       ListItemTLP = "green"
	ListItemTLPRed         ListItemTLP = "red"
)

func (ListItemTLP) IsKnown 

func (r ListItemTLP) IsKnown() bool

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 Message 

type Message struct {
	// Message ID.
	ID int64 `json:"id" api:"required"`
	// Author of message.
	Author string `json:"author" api:"required"`
	// Content of message.
	Content string `json:"content" api:"required"`
	// Whether the message is a follow-on request.
	IsFollowOnRequest bool `json:"is_follow_on_request" api:"required"`
	// Defines the message last updated time.
	Updated time.Time `json:"updated" api:"required" format:"date-time"`
	// Defines the message creation time.
	Created time.Time   `json:"created" format:"date-time"`
	JSON    messageJSON `json:"-"`
}

func (*Message) UnmarshalJSON 

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

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 Priority 

type Priority struct {
	// UUID.
	ID string `json:"id" api:"required"`
	// Priority creation time.
	Created time.Time `json:"created" api:"required" format:"date-time"`
	// List of labels.
	Labels []Label `json:"labels" api:"required"`
	// Priority.
	Priority int64 `json:"priority" api:"required"`
	// Requirement.
	Requirement string `json:"requirement" api:"required"`
	// The CISA defined Traffic Light Protocol (TLP).
	TLP PriorityTLP `json:"tlp" api:"required"`
	// Priority last updated time.
	Updated time.Time    `json:"updated" api:"required" format:"date-time"`
	JSON    priorityJSON `json:"-"`
}

func (*Priority) UnmarshalJSON 

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

type PriorityEditParam 

type PriorityEditParam struct {
	// List of labels.
	Labels param.Field[[]LabelParam] `json:"labels" api:"required"`
	// Priority.
	Priority param.Field[int64] `json:"priority" api:"required"`
	// Requirement.
	Requirement param.Field[string] `json:"requirement" api:"required"`
	// The CISA defined Traffic Light Protocol (TLP).
	TLP param.Field[PriorityEditTLP] `json:"tlp" api:"required"`
}

func (PriorityEditParam) MarshalJSON 

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

type PriorityEditTLP 

type PriorityEditTLP string

The CISA defined Traffic Light Protocol (TLP). 

const (
	PriorityEditTLPClear       PriorityEditTLP = "clear"
	PriorityEditTLPAmber       PriorityEditTLP = "amber"
	PriorityEditTLPAmberStrict PriorityEditTLP = "amber-strict"
	PriorityEditTLPGreen       PriorityEditTLP = "green"
	PriorityEditTLPRed         PriorityEditTLP = "red"
)

func (PriorityEditTLP) IsKnown 

func (r PriorityEditTLP) IsKnown() bool

type PriorityTLP 

type PriorityTLP string

The CISA defined Traffic Light Protocol (TLP). 

const (
	PriorityTLPClear       PriorityTLP = "clear"
	PriorityTLPAmber       PriorityTLP = "amber"
	PriorityTLPAmberStrict PriorityTLP = "amber-strict"
	PriorityTLPGreen       PriorityTLP = "green"
	PriorityTLPRed         PriorityTLP = "red"
)

func (PriorityTLP) IsKnown 

func (r PriorityTLP) IsKnown() bool

type Quota 

type Quota struct {
	// Anniversary date is when annual quota limit is refreshed.
	AnniversaryDate time.Time `json:"anniversary_date" format:"date-time"`
	// Quarter anniversary date is when quota limit is refreshed each quarter.
	QuarterAnniversaryDate time.Time `json:"quarter_anniversary_date" format:"date-time"`
	// Tokens for the quarter.
	Quota int64 `json:"quota"`
	// Tokens remaining for the quarter.
	Remaining int64     `json:"remaining"`
	JSON      quotaJSON `json:"-"`
}

func (*Quota) UnmarshalJSON 

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

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 RequestAssetDeleteParams 

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

type RequestAssetDeleteResponse 

type RequestAssetDeleteResponse struct {
	Errors   []RequestAssetDeleteResponseError   `json:"errors" api:"required"`
	Messages []RequestAssetDeleteResponseMessage `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestAssetDeleteResponseSuccess `json:"success" api:"required"`
	JSON    requestAssetDeleteResponseJSON    `json:"-"`
}

func (*RequestAssetDeleteResponse) UnmarshalJSON 

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

type RequestAssetDeleteResponseError 

type RequestAssetDeleteResponseError struct {
	Code             int64                                  `json:"code" api:"required"`
	Message          string                                 `json:"message" api:"required"`
	DocumentationURL string                                 `json:"documentation_url"`
	Source           RequestAssetDeleteResponseErrorsSource `json:"source"`
	JSON             requestAssetDeleteResponseErrorJSON    `json:"-"`
}

func (*RequestAssetDeleteResponseError) UnmarshalJSON 

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

type RequestAssetDeleteResponseErrorsSource 

type RequestAssetDeleteResponseErrorsSource struct {
	Pointer string                                     `json:"pointer"`
	JSON    requestAssetDeleteResponseErrorsSourceJSON `json:"-"`
}

func (*RequestAssetDeleteResponseErrorsSource) UnmarshalJSON 

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

type RequestAssetDeleteResponseMessage 

type RequestAssetDeleteResponseMessage struct {
	Code             int64                                    `json:"code" api:"required"`
	Message          string                                   `json:"message" api:"required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           RequestAssetDeleteResponseMessagesSource `json:"source"`
	JSON             requestAssetDeleteResponseMessageJSON    `json:"-"`
}

func (*RequestAssetDeleteResponseMessage) UnmarshalJSON 

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

type RequestAssetDeleteResponseMessagesSource 

type RequestAssetDeleteResponseMessagesSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    requestAssetDeleteResponseMessagesSourceJSON `json:"-"`
}

func (*RequestAssetDeleteResponseMessagesSource) UnmarshalJSON 

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

type RequestAssetDeleteResponseSuccess 

type RequestAssetDeleteResponseSuccess bool

Whether the API call was successful. 

const (
	RequestAssetDeleteResponseSuccessTrue RequestAssetDeleteResponseSuccess = true
)

func (RequestAssetDeleteResponseSuccess) IsKnown 

func (r RequestAssetDeleteResponseSuccess) IsKnown() bool

type RequestAssetGetParams 

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

type RequestAssetGetResponse 

type RequestAssetGetResponse struct {
	// Asset ID.
	ID int64 `json:"id" api:"required"`
	// Asset name.
	Name string `json:"name" api:"required"`
	// Defines the asset creation time.
	Created time.Time `json:"created" format:"date-time"`
	// Asset description.
	Description string `json:"description"`
	// Asset file type.
	FileType string                      `json:"file_type"`
	JSON     requestAssetGetResponseJSON `json:"-"`
}

func (*RequestAssetGetResponse) UnmarshalJSON 

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

type RequestAssetNewParams 

type RequestAssetNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Page number of results.
	Page param.Field[int64] `json:"page" api:"required"`
	// Number of results per page.
	PerPage param.Field[int64] `json:"per_page" api:"required"`
}

func (RequestAssetNewParams) MarshalJSON 

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

type RequestAssetNewResponse 

type RequestAssetNewResponse struct {
	// Asset ID.
	ID int64 `json:"id" api:"required"`
	// Asset name.
	Name string `json:"name" api:"required"`
	// Defines the asset creation time.
	Created time.Time `json:"created" format:"date-time"`
	// Asset description.
	Description string `json:"description"`
	// Asset file type.
	FileType string                      `json:"file_type"`
	JSON     requestAssetNewResponseJSON `json:"-"`
}

func (*RequestAssetNewResponse) UnmarshalJSON 

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

type RequestAssetService 

type RequestAssetService struct {
	Options []option.RequestOption
}

RequestAssetService 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 NewRequestAssetService method instead.

func NewRequestAssetService 

func NewRequestAssetService(opts ...option.RequestOption) (r *RequestAssetService)

NewRequestAssetService 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 (*RequestAssetService) Delete 

func (r *RequestAssetService) Delete(ctx context.Context, requestID string, assetID string, body RequestAssetDeleteParams, opts ...option.RequestOption) (res *RequestAssetDeleteResponse, err error)

Removes an asset from a Cloudforce One intelligence request.

func (*RequestAssetService) Get 

func (r *RequestAssetService) Get(ctx context.Context, requestID string, assetID string, query RequestAssetGetParams, opts ...option.RequestOption) (res *pagination.SinglePage[RequestAssetGetResponse], err error)

Retrieves an asset attached to a Cloudforce One intelligence request.

func (*RequestAssetService) GetAutoPaging 

func (r *RequestAssetService) GetAutoPaging(ctx context.Context, requestID string, assetID string, query RequestAssetGetParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RequestAssetGetResponse]

Retrieves an asset attached to a Cloudforce One intelligence request.

func (*RequestAssetService) New 

func (r *RequestAssetService) New(ctx context.Context, requestID string, params RequestAssetNewParams, opts ...option.RequestOption) (res *pagination.SinglePage[RequestAssetNewResponse], err error)

Lists assets attached to a Cloudforce One intelligence request.

func (*RequestAssetService) NewAutoPaging 

func (r *RequestAssetService) NewAutoPaging(ctx context.Context, requestID string, params RequestAssetNewParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RequestAssetNewResponse]

Lists assets attached to a Cloudforce One intelligence request.

func (*RequestAssetService) Update 

func (r *RequestAssetService) Update(ctx context.Context, requestID string, assetID string, params RequestAssetUpdateParams, opts ...option.RequestOption) (res *RequestAssetUpdateResponse, err error)

Updates an asset in a Cloudforce One intelligence request.

type RequestAssetUpdateParams 

type RequestAssetUpdateParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Asset file to upload.
	Source param.Field[string] `json:"source"`
}

func (RequestAssetUpdateParams) MarshalJSON 

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

type RequestAssetUpdateResponse 

type RequestAssetUpdateResponse struct {
	// Asset ID.
	ID int64 `json:"id" api:"required"`
	// Asset name.
	Name string `json:"name" api:"required"`
	// Defines the asset creation time.
	Created time.Time `json:"created" format:"date-time"`
	// Asset description.
	Description string `json:"description"`
	// Asset file type.
	FileType string                         `json:"file_type"`
	JSON     requestAssetUpdateResponseJSON `json:"-"`
}

func (*RequestAssetUpdateResponse) UnmarshalJSON 

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

type RequestAssetUpdateResponseEnvelope 

type RequestAssetUpdateResponseEnvelope struct {
	Errors   []RequestAssetUpdateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RequestAssetUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestAssetUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  RequestAssetUpdateResponse                `json:"result"`
	JSON    requestAssetUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*RequestAssetUpdateResponseEnvelope) UnmarshalJSON 

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

type RequestAssetUpdateResponseEnvelopeErrors 

type RequestAssetUpdateResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code" api:"required"`
	Message          string                                         `json:"message" api:"required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           RequestAssetUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             requestAssetUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RequestAssetUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type RequestAssetUpdateResponseEnvelopeErrorsSource 

type RequestAssetUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    requestAssetUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RequestAssetUpdateResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type RequestAssetUpdateResponseEnvelopeMessages 

type RequestAssetUpdateResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code" api:"required"`
	Message          string                                           `json:"message" api:"required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           RequestAssetUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             requestAssetUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RequestAssetUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type RequestAssetUpdateResponseEnvelopeMessagesSource 

type RequestAssetUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    requestAssetUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RequestAssetUpdateResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type RequestAssetUpdateResponseEnvelopeSuccess 

type RequestAssetUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RequestAssetUpdateResponseEnvelopeSuccessTrue RequestAssetUpdateResponseEnvelopeSuccess = true
)

func (RequestAssetUpdateResponseEnvelopeSuccess) IsKnown 

func (r RequestAssetUpdateResponseEnvelopeSuccess) IsKnown() bool

type RequestConstants 

type RequestConstants struct {
	Priority []RequestConstantsPriority `json:"priority"`
	Status   []RequestConstantsStatus   `json:"status"`
	TLP      []RequestConstantsTLP      `json:"tlp"`
	JSON     requestConstantsJSON       `json:"-"`
}

func (*RequestConstants) UnmarshalJSON 

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

type RequestConstantsParams 

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

type RequestConstantsPriority 

type RequestConstantsPriority string
const (
	RequestConstantsPriorityRoutine RequestConstantsPriority = "routine"
	RequestConstantsPriorityHigh    RequestConstantsPriority = "high"
	RequestConstantsPriorityUrgent  RequestConstantsPriority = "urgent"
)

func (RequestConstantsPriority) IsKnown 

func (r RequestConstantsPriority) IsKnown() bool

type RequestConstantsResponseEnvelope 

type RequestConstantsResponseEnvelope struct {
	Errors   []RequestConstantsResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RequestConstantsResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestConstantsResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  RequestConstants                        `json:"result"`
	JSON    requestConstantsResponseEnvelopeJSON    `json:"-"`
}

func (*RequestConstantsResponseEnvelope) UnmarshalJSON 

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

type RequestConstantsResponseEnvelopeErrors 

type RequestConstantsResponseEnvelopeErrors struct {
	Code             int64                                        `json:"code" api:"required"`
	Message          string                                       `json:"message" api:"required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           RequestConstantsResponseEnvelopeErrorsSource `json:"source"`
	JSON             requestConstantsResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RequestConstantsResponseEnvelopeErrors) UnmarshalJSON 

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

type RequestConstantsResponseEnvelopeErrorsSource 

type RequestConstantsResponseEnvelopeErrorsSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    requestConstantsResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RequestConstantsResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type RequestConstantsResponseEnvelopeMessages 

type RequestConstantsResponseEnvelopeMessages struct {
	Code             int64                                          `json:"code" api:"required"`
	Message          string                                         `json:"message" api:"required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           RequestConstantsResponseEnvelopeMessagesSource `json:"source"`
	JSON             requestConstantsResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RequestConstantsResponseEnvelopeMessages) UnmarshalJSON 

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

type RequestConstantsResponseEnvelopeMessagesSource 

type RequestConstantsResponseEnvelopeMessagesSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    requestConstantsResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RequestConstantsResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type RequestConstantsResponseEnvelopeSuccess 

type RequestConstantsResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RequestConstantsResponseEnvelopeSuccessTrue RequestConstantsResponseEnvelopeSuccess = true
)

func (RequestConstantsResponseEnvelopeSuccess) IsKnown 

func (r RequestConstantsResponseEnvelopeSuccess) IsKnown() bool

type RequestConstantsStatus 

type RequestConstantsStatus string

Request Status. 

const (
	RequestConstantsStatusOpen      RequestConstantsStatus = "open"
	RequestConstantsStatusAccepted  RequestConstantsStatus = "accepted"
	RequestConstantsStatusReported  RequestConstantsStatus = "reported"
	RequestConstantsStatusApproved  RequestConstantsStatus = "approved"
	RequestConstantsStatusCompleted RequestConstantsStatus = "completed"
	RequestConstantsStatusDeclined  RequestConstantsStatus = "declined"
)

func (RequestConstantsStatus) IsKnown 

func (r RequestConstantsStatus) IsKnown() bool

type RequestConstantsTLP 

type RequestConstantsTLP string

The CISA defined Traffic Light Protocol (TLP). 

const (
	RequestConstantsTLPClear       RequestConstantsTLP = "clear"
	RequestConstantsTLPAmber       RequestConstantsTLP = "amber"
	RequestConstantsTLPAmberStrict RequestConstantsTLP = "amber-strict"
	RequestConstantsTLPGreen       RequestConstantsTLP = "green"
	RequestConstantsTLPRed         RequestConstantsTLP = "red"
)

func (RequestConstantsTLP) IsKnown 

func (r RequestConstantsTLP) IsKnown() bool

type RequestDeleteParams 

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

type RequestDeleteResponse 

type RequestDeleteResponse struct {
	Errors   []RequestDeleteResponseError   `json:"errors" api:"required"`
	Messages []RequestDeleteResponseMessage `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestDeleteResponseSuccess `json:"success" api:"required"`
	JSON    requestDeleteResponseJSON    `json:"-"`
}

func (*RequestDeleteResponse) UnmarshalJSON 

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

type RequestDeleteResponseError 

type RequestDeleteResponseError struct {
	Code             int64                             `json:"code" api:"required"`
	Message          string                            `json:"message" api:"required"`
	DocumentationURL string                            `json:"documentation_url"`
	Source           RequestDeleteResponseErrorsSource `json:"source"`
	JSON             requestDeleteResponseErrorJSON    `json:"-"`
}

func (*RequestDeleteResponseError) UnmarshalJSON 

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

type RequestDeleteResponseErrorsSource 

type RequestDeleteResponseErrorsSource struct {
	Pointer string                                `json:"pointer"`
	JSON    requestDeleteResponseErrorsSourceJSON `json:"-"`
}

func (*RequestDeleteResponseErrorsSource) UnmarshalJSON 

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

type RequestDeleteResponseMessage 

type RequestDeleteResponseMessage struct {
	Code             int64                               `json:"code" api:"required"`
	Message          string                              `json:"message" api:"required"`
	DocumentationURL string                              `json:"documentation_url"`
	Source           RequestDeleteResponseMessagesSource `json:"source"`
	JSON             requestDeleteResponseMessageJSON    `json:"-"`
}

func (*RequestDeleteResponseMessage) UnmarshalJSON 

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

type RequestDeleteResponseMessagesSource 

type RequestDeleteResponseMessagesSource struct {
	Pointer string                                  `json:"pointer"`
	JSON    requestDeleteResponseMessagesSourceJSON `json:"-"`
}

func (*RequestDeleteResponseMessagesSource) UnmarshalJSON 

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

type RequestDeleteResponseSuccess 

type RequestDeleteResponseSuccess bool

Whether the API call was successful. 

const (
	RequestDeleteResponseSuccessTrue RequestDeleteResponseSuccess = true
)

func (RequestDeleteResponseSuccess) IsKnown 

func (r RequestDeleteResponseSuccess) IsKnown() bool

type RequestGetParams 

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

type RequestGetResponseEnvelope 

type RequestGetResponseEnvelope struct {
	Errors   []RequestGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RequestGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  Item                              `json:"result"`
	JSON    requestGetResponseEnvelopeJSON    `json:"-"`
}

func (*RequestGetResponseEnvelope) UnmarshalJSON 

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

type RequestGetResponseEnvelopeErrors 

type RequestGetResponseEnvelopeErrors struct {
	Code             int64                                  `json:"code" api:"required"`
	Message          string                                 `json:"message" api:"required"`
	DocumentationURL string                                 `json:"documentation_url"`
	Source           RequestGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             requestGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RequestGetResponseEnvelopeErrors) UnmarshalJSON 

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

type RequestGetResponseEnvelopeErrorsSource 

type RequestGetResponseEnvelopeErrorsSource struct {
	Pointer string                                     `json:"pointer"`
	JSON    requestGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RequestGetResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type RequestGetResponseEnvelopeMessages 

type RequestGetResponseEnvelopeMessages struct {
	Code             int64                                    `json:"code" api:"required"`
	Message          string                                   `json:"message" api:"required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           RequestGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             requestGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RequestGetResponseEnvelopeMessages) UnmarshalJSON 

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

type RequestGetResponseEnvelopeMessagesSource 

type RequestGetResponseEnvelopeMessagesSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    requestGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RequestGetResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type RequestGetResponseEnvelopeSuccess 

type RequestGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RequestGetResponseEnvelopeSuccessTrue RequestGetResponseEnvelopeSuccess = true
)

func (RequestGetResponseEnvelopeSuccess) IsKnown 

func (r RequestGetResponseEnvelopeSuccess) IsKnown() bool

type RequestListParams 

type RequestListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Page number of results.
	Page param.Field[int64] `json:"page" api:"required"`
	// Number of results per page.
	PerPage param.Field[int64] `json:"per_page" api:"required"`
	// Retrieve requests completed after this time.
	CompletedAfter param.Field[time.Time] `json:"completed_after" format:"date-time"`
	// Retrieve requests completed before this time.
	CompletedBefore param.Field[time.Time] `json:"completed_before" format:"date-time"`
	// Retrieve requests created after this time.
	CreatedAfter param.Field[time.Time] `json:"created_after" format:"date-time"`
	// Retrieve requests created before this time.
	CreatedBefore param.Field[time.Time] `json:"created_before" format:"date-time"`
	// Requested information from request.
	RequestType param.Field[string] `json:"request_type"`
	// Field to sort results by.
	SortBy param.Field[string] `json:"sort_by"`
	// Sort order (asc or desc).
	SortOrder param.Field[RequestListParamsSortOrder] `json:"sort_order"`
	// Request Status.
	Status param.Field[RequestListParamsStatus] `json:"status"`
}

func (RequestListParams) MarshalJSON 

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

type RequestListParamsSortOrder 

type RequestListParamsSortOrder string

Sort order (asc or desc). 

const (
	RequestListParamsSortOrderAsc  RequestListParamsSortOrder = "asc"
	RequestListParamsSortOrderDesc RequestListParamsSortOrder = "desc"
)

func (RequestListParamsSortOrder) IsKnown 

func (r RequestListParamsSortOrder) IsKnown() bool

type RequestListParamsStatus 

type RequestListParamsStatus string

Request Status. 

const (
	RequestListParamsStatusOpen      RequestListParamsStatus = "open"
	RequestListParamsStatusAccepted  RequestListParamsStatus = "accepted"
	RequestListParamsStatusReported  RequestListParamsStatus = "reported"
	RequestListParamsStatusApproved  RequestListParamsStatus = "approved"
	RequestListParamsStatusCompleted RequestListParamsStatus = "completed"
	RequestListParamsStatusDeclined  RequestListParamsStatus = "declined"
)

func (RequestListParamsStatus) IsKnown 

func (r RequestListParamsStatus) IsKnown() bool

type RequestMessageDeleteParams 

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

type RequestMessageDeleteResponse 

type RequestMessageDeleteResponse struct {
	Errors   []RequestMessageDeleteResponseError   `json:"errors" api:"required"`
	Messages []RequestMessageDeleteResponseMessage `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestMessageDeleteResponseSuccess `json:"success" api:"required"`
	JSON    requestMessageDeleteResponseJSON    `json:"-"`
}

func (*RequestMessageDeleteResponse) UnmarshalJSON 

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

type RequestMessageDeleteResponseError 

type RequestMessageDeleteResponseError struct {
	Code             int64                                    `json:"code" api:"required"`
	Message          string                                   `json:"message" api:"required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           RequestMessageDeleteResponseErrorsSource `json:"source"`
	JSON             requestMessageDeleteResponseErrorJSON    `json:"-"`
}

func (*RequestMessageDeleteResponseError) UnmarshalJSON 

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

type RequestMessageDeleteResponseErrorsSource 

type RequestMessageDeleteResponseErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    requestMessageDeleteResponseErrorsSourceJSON `json:"-"`
}

func (*RequestMessageDeleteResponseErrorsSource) UnmarshalJSON 

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

type RequestMessageDeleteResponseMessage 

type RequestMessageDeleteResponseMessage struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           RequestMessageDeleteResponseMessagesSource `json:"source"`
	JSON             requestMessageDeleteResponseMessageJSON    `json:"-"`
}

func (*RequestMessageDeleteResponseMessage) UnmarshalJSON 

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

type RequestMessageDeleteResponseMessagesSource 

type RequestMessageDeleteResponseMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    requestMessageDeleteResponseMessagesSourceJSON `json:"-"`
}

func (*RequestMessageDeleteResponseMessagesSource) UnmarshalJSON 

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

type RequestMessageDeleteResponseSuccess 

type RequestMessageDeleteResponseSuccess bool

Whether the API call was successful. 

const (
	RequestMessageDeleteResponseSuccessTrue RequestMessageDeleteResponseSuccess = true
)

func (RequestMessageDeleteResponseSuccess) IsKnown 

func (r RequestMessageDeleteResponseSuccess) IsKnown() bool

type RequestMessageGetParams 

type RequestMessageGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Page number of results.
	Page param.Field[int64] `json:"page" api:"required"`
	// Number of results per page.
	PerPage param.Field[int64] `json:"per_page" api:"required"`
	// Retrieve mes ges created after this time.
	After param.Field[time.Time] `json:"after" format:"date-time"`
	// Retrieve messages created before this time.
	Before param.Field[time.Time] `json:"before" format:"date-time"`
	// Field to sort results by.
	SortBy param.Field[string] `json:"sort_by"`
	// Sort order (asc or desc).
	SortOrder param.Field[RequestMessageGetParamsSortOrder] `json:"sort_order"`
}

func (RequestMessageGetParams) MarshalJSON 

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

type RequestMessageGetParamsSortOrder 

type RequestMessageGetParamsSortOrder string

Sort order (asc or desc). 

const (
	RequestMessageGetParamsSortOrderAsc  RequestMessageGetParamsSortOrder = "asc"
	RequestMessageGetParamsSortOrderDesc RequestMessageGetParamsSortOrder = "desc"
)

func (RequestMessageGetParamsSortOrder) IsKnown 

func (r RequestMessageGetParamsSortOrder) IsKnown() bool

type RequestMessageNewParams 

type RequestMessageNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Content of message.
	Content param.Field[string] `json:"content"`
}

func (RequestMessageNewParams) MarshalJSON 

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

type RequestMessageNewResponseEnvelope 

type RequestMessageNewResponseEnvelope struct {
	Errors   []RequestMessageNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RequestMessageNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestMessageNewResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  Message                                  `json:"result"`
	JSON    requestMessageNewResponseEnvelopeJSON    `json:"-"`
}

func (*RequestMessageNewResponseEnvelope) UnmarshalJSON 

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

type RequestMessageNewResponseEnvelopeErrors 

type RequestMessageNewResponseEnvelopeErrors struct {
	Code             int64                                         `json:"code" api:"required"`
	Message          string                                        `json:"message" api:"required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           RequestMessageNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             requestMessageNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RequestMessageNewResponseEnvelopeErrors) UnmarshalJSON 

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

type RequestMessageNewResponseEnvelopeErrorsSource 

type RequestMessageNewResponseEnvelopeErrorsSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    requestMessageNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RequestMessageNewResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type RequestMessageNewResponseEnvelopeMessages 

type RequestMessageNewResponseEnvelopeMessages struct {
	Code             int64                                           `json:"code" api:"required"`
	Message          string                                          `json:"message" api:"required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           RequestMessageNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             requestMessageNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RequestMessageNewResponseEnvelopeMessages) UnmarshalJSON 

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

type RequestMessageNewResponseEnvelopeMessagesSource 

type RequestMessageNewResponseEnvelopeMessagesSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    requestMessageNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RequestMessageNewResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type RequestMessageNewResponseEnvelopeSuccess 

type RequestMessageNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RequestMessageNewResponseEnvelopeSuccessTrue RequestMessageNewResponseEnvelopeSuccess = true
)

func (RequestMessageNewResponseEnvelopeSuccess) IsKnown 

func (r RequestMessageNewResponseEnvelopeSuccess) IsKnown() bool

type RequestMessageService 

type RequestMessageService struct {
	Options []option.RequestOption
}

RequestMessageService 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 NewRequestMessageService method instead.

func NewRequestMessageService 

func NewRequestMessageService(opts ...option.RequestOption) (r *RequestMessageService)

NewRequestMessageService 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 (*RequestMessageService) Delete 

func (r *RequestMessageService) Delete(ctx context.Context, requestID string, messageID int64, body RequestMessageDeleteParams, opts ...option.RequestOption) (res *RequestMessageDeleteResponse, err error)

Removes a message from a Cloudforce One intelligence request thread.

func (*RequestMessageService) Get 

func (r *RequestMessageService) Get(ctx context.Context, requestID string, params RequestMessageGetParams, opts ...option.RequestOption) (res *pagination.SinglePage[Message], err error)

Lists messages in a Cloudforce One intelligence request conversation.

func (*RequestMessageService) GetAutoPaging 

func (r *RequestMessageService) GetAutoPaging(ctx context.Context, requestID string, params RequestMessageGetParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Message]

Lists messages in a Cloudforce One intelligence request conversation.

func (*RequestMessageService) New 

func (r *RequestMessageService) New(ctx context.Context, requestID string, params RequestMessageNewParams, opts ...option.RequestOption) (res *Message, err error)

Adds a message to a Cloudforce One intelligence request conversation.

func (*RequestMessageService) Update 

func (r *RequestMessageService) Update(ctx context.Context, requestID string, messageID int64, params RequestMessageUpdateParams, opts ...option.RequestOption) (res *Message, err error)

Updates a message in a Cloudforce One intelligence request thread.

type RequestMessageUpdateParams 

type RequestMessageUpdateParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Content of message.
	Content param.Field[string] `json:"content"`
}

func (RequestMessageUpdateParams) MarshalJSON 

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

type RequestMessageUpdateResponseEnvelope 

type RequestMessageUpdateResponseEnvelope struct {
	Errors   []RequestMessageUpdateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RequestMessageUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestMessageUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  Message                                     `json:"result"`
	JSON    requestMessageUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*RequestMessageUpdateResponseEnvelope) UnmarshalJSON 

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

type RequestMessageUpdateResponseEnvelopeErrors 

type RequestMessageUpdateResponseEnvelopeErrors struct {
	Code             int64                                            `json:"code" api:"required"`
	Message          string                                           `json:"message" api:"required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           RequestMessageUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             requestMessageUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RequestMessageUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type RequestMessageUpdateResponseEnvelopeErrorsSource 

type RequestMessageUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    requestMessageUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RequestMessageUpdateResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type RequestMessageUpdateResponseEnvelopeMessages 

type RequestMessageUpdateResponseEnvelopeMessages struct {
	Code             int64                                              `json:"code" api:"required"`
	Message          string                                             `json:"message" api:"required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           RequestMessageUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             requestMessageUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RequestMessageUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type RequestMessageUpdateResponseEnvelopeMessagesSource 

type RequestMessageUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    requestMessageUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RequestMessageUpdateResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type RequestMessageUpdateResponseEnvelopeSuccess 

type RequestMessageUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RequestMessageUpdateResponseEnvelopeSuccessTrue RequestMessageUpdateResponseEnvelopeSuccess = true
)

func (RequestMessageUpdateResponseEnvelopeSuccess) IsKnown 

func (r RequestMessageUpdateResponseEnvelopeSuccess) IsKnown() bool

type RequestNewParams 

type RequestNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Request content.
	Content param.Field[string] `json:"content"`
	// Priority for analyzing the request.
	Priority param.Field[string] `json:"priority"`
	// Requested information from request.
	RequestType param.Field[string] `json:"request_type"`
	// Brief description of the request.
	Summary param.Field[string] `json:"summary"`
	// The CISA defined Traffic Light Protocol (TLP).
	TLP param.Field[RequestNewParamsTLP] `json:"tlp"`
}

func (RequestNewParams) MarshalJSON 

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

type RequestNewParamsTLP 

type RequestNewParamsTLP string

The CISA defined Traffic Light Protocol (TLP). 

const (
	RequestNewParamsTLPClear       RequestNewParamsTLP = "clear"
	RequestNewParamsTLPAmber       RequestNewParamsTLP = "amber"
	RequestNewParamsTLPAmberStrict RequestNewParamsTLP = "amber-strict"
	RequestNewParamsTLPGreen       RequestNewParamsTLP = "green"
	RequestNewParamsTLPRed         RequestNewParamsTLP = "red"
)

func (RequestNewParamsTLP) IsKnown 

func (r RequestNewParamsTLP) IsKnown() bool

type RequestNewResponseEnvelope 

type RequestNewResponseEnvelope struct {
	Errors   []RequestNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RequestNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestNewResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  Item                              `json:"result"`
	JSON    requestNewResponseEnvelopeJSON    `json:"-"`
}

func (*RequestNewResponseEnvelope) UnmarshalJSON 

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

type RequestNewResponseEnvelopeErrors 

type RequestNewResponseEnvelopeErrors struct {
	Code             int64                                  `json:"code" api:"required"`
	Message          string                                 `json:"message" api:"required"`
	DocumentationURL string                                 `json:"documentation_url"`
	Source           RequestNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             requestNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RequestNewResponseEnvelopeErrors) UnmarshalJSON 

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

type RequestNewResponseEnvelopeErrorsSource 

type RequestNewResponseEnvelopeErrorsSource struct {
	Pointer string                                     `json:"pointer"`
	JSON    requestNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RequestNewResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type RequestNewResponseEnvelopeMessages 

type RequestNewResponseEnvelopeMessages struct {
	Code             int64                                    `json:"code" api:"required"`
	Message          string                                   `json:"message" api:"required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           RequestNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             requestNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RequestNewResponseEnvelopeMessages) UnmarshalJSON 

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

type RequestNewResponseEnvelopeMessagesSource 

type RequestNewResponseEnvelopeMessagesSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    requestNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RequestNewResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type RequestNewResponseEnvelopeSuccess 

type RequestNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RequestNewResponseEnvelopeSuccessTrue RequestNewResponseEnvelopeSuccess = true
)

func (RequestNewResponseEnvelopeSuccess) IsKnown 

func (r RequestNewResponseEnvelopeSuccess) IsKnown() bool

type RequestPriorityDeleteParams 

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

type RequestPriorityDeleteResponse 

type RequestPriorityDeleteResponse struct {
	Errors   []RequestPriorityDeleteResponseError   `json:"errors" api:"required"`
	Messages []RequestPriorityDeleteResponseMessage `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestPriorityDeleteResponseSuccess `json:"success" api:"required"`
	JSON    requestPriorityDeleteResponseJSON    `json:"-"`
}

func (*RequestPriorityDeleteResponse) UnmarshalJSON 

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

type RequestPriorityDeleteResponseError 

type RequestPriorityDeleteResponseError struct {
	Code             int64                                     `json:"code" api:"required"`
	Message          string                                    `json:"message" api:"required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           RequestPriorityDeleteResponseErrorsSource `json:"source"`
	JSON             requestPriorityDeleteResponseErrorJSON    `json:"-"`
}

func (*RequestPriorityDeleteResponseError) UnmarshalJSON 

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

type RequestPriorityDeleteResponseErrorsSource 

type RequestPriorityDeleteResponseErrorsSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    requestPriorityDeleteResponseErrorsSourceJSON `json:"-"`
}

func (*RequestPriorityDeleteResponseErrorsSource) UnmarshalJSON 

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

type RequestPriorityDeleteResponseMessage 

type RequestPriorityDeleteResponseMessage struct {
	Code             int64                                       `json:"code" api:"required"`
	Message          string                                      `json:"message" api:"required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           RequestPriorityDeleteResponseMessagesSource `json:"source"`
	JSON             requestPriorityDeleteResponseMessageJSON    `json:"-"`
}

func (*RequestPriorityDeleteResponseMessage) UnmarshalJSON 

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

type RequestPriorityDeleteResponseMessagesSource 

type RequestPriorityDeleteResponseMessagesSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    requestPriorityDeleteResponseMessagesSourceJSON `json:"-"`
}

func (*RequestPriorityDeleteResponseMessagesSource) UnmarshalJSON 

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

type RequestPriorityDeleteResponseSuccess 

type RequestPriorityDeleteResponseSuccess bool

Whether the API call was successful. 

const (
	RequestPriorityDeleteResponseSuccessTrue RequestPriorityDeleteResponseSuccess = true
)

func (RequestPriorityDeleteResponseSuccess) IsKnown 

func (r RequestPriorityDeleteResponseSuccess) IsKnown() bool

type RequestPriorityGetParams 

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

type RequestPriorityGetResponseEnvelope 

type RequestPriorityGetResponseEnvelope struct {
	Errors   []RequestPriorityGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RequestPriorityGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestPriorityGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  Item                                      `json:"result"`
	JSON    requestPriorityGetResponseEnvelopeJSON    `json:"-"`
}

func (*RequestPriorityGetResponseEnvelope) UnmarshalJSON 

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

type RequestPriorityGetResponseEnvelopeErrors 

type RequestPriorityGetResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code" api:"required"`
	Message          string                                         `json:"message" api:"required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           RequestPriorityGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             requestPriorityGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RequestPriorityGetResponseEnvelopeErrors) UnmarshalJSON 

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

type RequestPriorityGetResponseEnvelopeErrorsSource 

type RequestPriorityGetResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    requestPriorityGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RequestPriorityGetResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type RequestPriorityGetResponseEnvelopeMessages 

type RequestPriorityGetResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code" api:"required"`
	Message          string                                           `json:"message" api:"required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           RequestPriorityGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             requestPriorityGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RequestPriorityGetResponseEnvelopeMessages) UnmarshalJSON 

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

type RequestPriorityGetResponseEnvelopeMessagesSource 

type RequestPriorityGetResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    requestPriorityGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RequestPriorityGetResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type RequestPriorityGetResponseEnvelopeSuccess 

type RequestPriorityGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RequestPriorityGetResponseEnvelopeSuccessTrue RequestPriorityGetResponseEnvelopeSuccess = true
)

func (RequestPriorityGetResponseEnvelopeSuccess) IsKnown 

func (r RequestPriorityGetResponseEnvelopeSuccess) IsKnown() bool

type RequestPriorityNewParams 

type RequestPriorityNewParams struct {
	// Identifier.
	AccountID    param.Field[string] `path:"account_id" api:"required"`
	PriorityEdit PriorityEditParam   `json:"priority_edit" api:"required"`
}

func (RequestPriorityNewParams) MarshalJSON 

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

type RequestPriorityNewResponseEnvelope 

type RequestPriorityNewResponseEnvelope struct {
	Errors   []RequestPriorityNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RequestPriorityNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestPriorityNewResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  Priority                                  `json:"result"`
	JSON    requestPriorityNewResponseEnvelopeJSON    `json:"-"`
}

func (*RequestPriorityNewResponseEnvelope) UnmarshalJSON 

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

type RequestPriorityNewResponseEnvelopeErrors 

type RequestPriorityNewResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code" api:"required"`
	Message          string                                         `json:"message" api:"required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           RequestPriorityNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             requestPriorityNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RequestPriorityNewResponseEnvelopeErrors) UnmarshalJSON 

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

type RequestPriorityNewResponseEnvelopeErrorsSource 

type RequestPriorityNewResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    requestPriorityNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RequestPriorityNewResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type RequestPriorityNewResponseEnvelopeMessages 

type RequestPriorityNewResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code" api:"required"`
	Message          string                                           `json:"message" api:"required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           RequestPriorityNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             requestPriorityNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RequestPriorityNewResponseEnvelopeMessages) UnmarshalJSON 

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

type RequestPriorityNewResponseEnvelopeMessagesSource 

type RequestPriorityNewResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    requestPriorityNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RequestPriorityNewResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type RequestPriorityNewResponseEnvelopeSuccess 

type RequestPriorityNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RequestPriorityNewResponseEnvelopeSuccessTrue RequestPriorityNewResponseEnvelopeSuccess = true
)

func (RequestPriorityNewResponseEnvelopeSuccess) IsKnown 

func (r RequestPriorityNewResponseEnvelopeSuccess) IsKnown() bool

type RequestPriorityQuotaParams 

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

type RequestPriorityQuotaResponseEnvelope 

type RequestPriorityQuotaResponseEnvelope struct {
	Errors   []RequestPriorityQuotaResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RequestPriorityQuotaResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestPriorityQuotaResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  Quota                                       `json:"result"`
	JSON    requestPriorityQuotaResponseEnvelopeJSON    `json:"-"`
}

func (*RequestPriorityQuotaResponseEnvelope) UnmarshalJSON 

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

type RequestPriorityQuotaResponseEnvelopeErrors 

type RequestPriorityQuotaResponseEnvelopeErrors struct {
	Code             int64                                            `json:"code" api:"required"`
	Message          string                                           `json:"message" api:"required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           RequestPriorityQuotaResponseEnvelopeErrorsSource `json:"source"`
	JSON             requestPriorityQuotaResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RequestPriorityQuotaResponseEnvelopeErrors) UnmarshalJSON 

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

type RequestPriorityQuotaResponseEnvelopeErrorsSource 

type RequestPriorityQuotaResponseEnvelopeErrorsSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    requestPriorityQuotaResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RequestPriorityQuotaResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type RequestPriorityQuotaResponseEnvelopeMessages 

type RequestPriorityQuotaResponseEnvelopeMessages struct {
	Code             int64                                              `json:"code" api:"required"`
	Message          string                                             `json:"message" api:"required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           RequestPriorityQuotaResponseEnvelopeMessagesSource `json:"source"`
	JSON             requestPriorityQuotaResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RequestPriorityQuotaResponseEnvelopeMessages) UnmarshalJSON 

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

type RequestPriorityQuotaResponseEnvelopeMessagesSource 

type RequestPriorityQuotaResponseEnvelopeMessagesSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    requestPriorityQuotaResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RequestPriorityQuotaResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type RequestPriorityQuotaResponseEnvelopeSuccess 

type RequestPriorityQuotaResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RequestPriorityQuotaResponseEnvelopeSuccessTrue RequestPriorityQuotaResponseEnvelopeSuccess = true
)

func (RequestPriorityQuotaResponseEnvelopeSuccess) IsKnown 

func (r RequestPriorityQuotaResponseEnvelopeSuccess) IsKnown() bool

type RequestPriorityService 

type RequestPriorityService struct {
	Options []option.RequestOption
}

RequestPriorityService 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 NewRequestPriorityService method instead.

func NewRequestPriorityService 

func NewRequestPriorityService(opts ...option.RequestOption) (r *RequestPriorityService)

NewRequestPriorityService 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 (*RequestPriorityService) Delete 

func (r *RequestPriorityService) Delete(ctx context.Context, priorityID string, body RequestPriorityDeleteParams, opts ...option.RequestOption) (res *RequestPriorityDeleteResponse, err error)

Deletes a priority intelligence request from Cloudforce One.

func (*RequestPriorityService) Get 

func (r *RequestPriorityService) Get(ctx context.Context, priorityID string, query RequestPriorityGetParams, opts ...option.RequestOption) (res *Item, err error)

Retrieves a specific priority intelligence request from Cloudforce One.

func (*RequestPriorityService) New 

func (r *RequestPriorityService) New(ctx context.Context, params RequestPriorityNewParams, opts ...option.RequestOption) (res *Priority, err error)

Creates a new priority intelligence request in Cloudforce One.

func (*RequestPriorityService) Quota 

func (r *RequestPriorityService) Quota(ctx context.Context, query RequestPriorityQuotaParams, opts ...option.RequestOption) (res *Quota, err error)

Retrieves quota usage for Cloudforce One priority requests.

func (*RequestPriorityService) Update 

func (r *RequestPriorityService) Update(ctx context.Context, priorityID string, params RequestPriorityUpdateParams, opts ...option.RequestOption) (res *Item, err error)

Updates a priority intelligence request in Cloudforce One.

type RequestPriorityUpdateParams 

type RequestPriorityUpdateParams struct {
	// Identifier.
	AccountID    param.Field[string] `path:"account_id" api:"required"`
	PriorityEdit PriorityEditParam   `json:"priority_edit" api:"required"`
}

func (RequestPriorityUpdateParams) MarshalJSON 

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

type RequestPriorityUpdateResponseEnvelope 

type RequestPriorityUpdateResponseEnvelope struct {
	Errors   []RequestPriorityUpdateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RequestPriorityUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestPriorityUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  Item                                         `json:"result"`
	JSON    requestPriorityUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*RequestPriorityUpdateResponseEnvelope) UnmarshalJSON 

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

type RequestPriorityUpdateResponseEnvelopeErrors 

type RequestPriorityUpdateResponseEnvelopeErrors struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           RequestPriorityUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             requestPriorityUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RequestPriorityUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type RequestPriorityUpdateResponseEnvelopeErrorsSource 

type RequestPriorityUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    requestPriorityUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RequestPriorityUpdateResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type RequestPriorityUpdateResponseEnvelopeMessages 

type RequestPriorityUpdateResponseEnvelopeMessages struct {
	Code             int64                                               `json:"code" api:"required"`
	Message          string                                              `json:"message" api:"required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           RequestPriorityUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             requestPriorityUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RequestPriorityUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type RequestPriorityUpdateResponseEnvelopeMessagesSource 

type RequestPriorityUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    requestPriorityUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RequestPriorityUpdateResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type RequestPriorityUpdateResponseEnvelopeSuccess 

type RequestPriorityUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RequestPriorityUpdateResponseEnvelopeSuccessTrue RequestPriorityUpdateResponseEnvelopeSuccess = true
)

func (RequestPriorityUpdateResponseEnvelopeSuccess) IsKnown 

func (r RequestPriorityUpdateResponseEnvelopeSuccess) IsKnown() bool

type RequestQuotaParams 

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

type RequestQuotaResponseEnvelope 

type RequestQuotaResponseEnvelope struct {
	Errors   []RequestQuotaResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RequestQuotaResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestQuotaResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  Quota                               `json:"result"`
	JSON    requestQuotaResponseEnvelopeJSON    `json:"-"`
}

func (*RequestQuotaResponseEnvelope) UnmarshalJSON 

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

type RequestQuotaResponseEnvelopeErrors 

type RequestQuotaResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code" api:"required"`
	Message          string                                   `json:"message" api:"required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           RequestQuotaResponseEnvelopeErrorsSource `json:"source"`
	JSON             requestQuotaResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RequestQuotaResponseEnvelopeErrors) UnmarshalJSON 

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

type RequestQuotaResponseEnvelopeErrorsSource 

type RequestQuotaResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    requestQuotaResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RequestQuotaResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type RequestQuotaResponseEnvelopeMessages 

type RequestQuotaResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           RequestQuotaResponseEnvelopeMessagesSource `json:"source"`
	JSON             requestQuotaResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RequestQuotaResponseEnvelopeMessages) UnmarshalJSON 

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

type RequestQuotaResponseEnvelopeMessagesSource 

type RequestQuotaResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    requestQuotaResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RequestQuotaResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type RequestQuotaResponseEnvelopeSuccess 

type RequestQuotaResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RequestQuotaResponseEnvelopeSuccessTrue RequestQuotaResponseEnvelopeSuccess = true
)

func (RequestQuotaResponseEnvelopeSuccess) IsKnown 

func (r RequestQuotaResponseEnvelopeSuccess) IsKnown() bool

type RequestService 

type RequestService struct {
	Options  []option.RequestOption
	Message  *RequestMessageService
	Priority *RequestPriorityService
	Assets   *RequestAssetService
}

RequestService 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 NewRequestService method instead.

func NewRequestService 

func NewRequestService(opts ...option.RequestOption) (r *RequestService)

NewRequestService 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 (*RequestService) Constants 

func (r *RequestService) Constants(ctx context.Context, query RequestConstantsParams, opts ...option.RequestOption) (res *RequestConstants, err error)

Retrieves constant values used in Cloudforce One requests, including valid statuses and types.

func (*RequestService) Delete 

func (r *RequestService) Delete(ctx context.Context, requestID string, body RequestDeleteParams, opts ...option.RequestOption) (res *RequestDeleteResponse, err error)

Deletes a Cloudforce One intelligence request and all associated data.

func (*RequestService) Get 

func (r *RequestService) Get(ctx context.Context, requestID string, query RequestGetParams, opts ...option.RequestOption) (res *Item, err error)

Retrieves details for a specific Cloudforce One intelligence request.

func (*RequestService) List 

func (r *RequestService) List(ctx context.Context, params RequestListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ListItem], err error)

Lists Cloudforce One intelligence requests with filtering and pagination.

func (*RequestService) ListAutoPaging 

func (r *RequestService) ListAutoPaging(ctx context.Context, params RequestListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ListItem]

Lists Cloudforce One intelligence requests with filtering and pagination.

func (*RequestService) New 

func (r *RequestService) New(ctx context.Context, params RequestNewParams, opts ...option.RequestOption) (res *Item, err error)

Creating a request adds the request into the Cloudforce One queue for analysis. In addition to the content, a short title, type, priority, and releasability should be provided. If one is not provided, a default will be assigned.

func (*RequestService) Quota 

func (r *RequestService) Quota(ctx context.Context, query RequestQuotaParams, opts ...option.RequestOption) (res *Quota, err error)

Retrieves quota usage for Cloudforce One standard requests.

func (*RequestService) Types 

func (r *RequestService) Types(ctx context.Context, query RequestTypesParams, opts ...option.RequestOption) (res *pagination.SinglePage[string], err error)

Lists available request types for Cloudforce One intelligence requests.

func (*RequestService) TypesAutoPaging 

func (r *RequestService) TypesAutoPaging(ctx context.Context, query RequestTypesParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[string]

Lists available request types for Cloudforce One intelligence requests.

func (*RequestService) Update 

func (r *RequestService) Update(ctx context.Context, requestID string, params RequestUpdateParams, opts ...option.RequestOption) (res *Item, err error)

Updating a request alters the request in the Cloudforce One queue. This API may be used to update any attributes of the request after the initial submission. Only fields that you choose to update need to be add to the request body.

type RequestTypes 

type RequestTypes []string

type RequestTypesParams 

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

type RequestUpdateParams 

type RequestUpdateParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Request content.
	Content param.Field[string] `json:"content"`
	// Priority for analyzing the request.
	Priority param.Field[string] `json:"priority"`
	// Requested information from request.
	RequestType param.Field[string] `json:"request_type"`
	// Brief description of the request.
	Summary param.Field[string] `json:"summary"`
	// The CISA defined Traffic Light Protocol (TLP).
	TLP param.Field[RequestUpdateParamsTLP] `json:"tlp"`
}

func (RequestUpdateParams) MarshalJSON 

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

type RequestUpdateParamsTLP 

type RequestUpdateParamsTLP string

The CISA defined Traffic Light Protocol (TLP). 

const (
	RequestUpdateParamsTLPClear       RequestUpdateParamsTLP = "clear"
	RequestUpdateParamsTLPAmber       RequestUpdateParamsTLP = "amber"
	RequestUpdateParamsTLPAmberStrict RequestUpdateParamsTLP = "amber-strict"
	RequestUpdateParamsTLPGreen       RequestUpdateParamsTLP = "green"
	RequestUpdateParamsTLPRed         RequestUpdateParamsTLP = "red"
)

func (RequestUpdateParamsTLP) IsKnown 

func (r RequestUpdateParamsTLP) IsKnown() bool

type RequestUpdateResponseEnvelope 

type RequestUpdateResponseEnvelope struct {
	Errors   []RequestUpdateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RequestUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success RequestUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  Item                                 `json:"result"`
	JSON    requestUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*RequestUpdateResponseEnvelope) UnmarshalJSON 

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

type RequestUpdateResponseEnvelopeErrors 

type RequestUpdateResponseEnvelopeErrors struct {
	Code             int64                                     `json:"code" api:"required"`
	Message          string                                    `json:"message" api:"required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           RequestUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             requestUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RequestUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type RequestUpdateResponseEnvelopeErrorsSource 

type RequestUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    requestUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RequestUpdateResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type RequestUpdateResponseEnvelopeMessages 

type RequestUpdateResponseEnvelopeMessages struct {
	Code             int64                                       `json:"code" api:"required"`
	Message          string                                      `json:"message" api:"required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           RequestUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             requestUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RequestUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type RequestUpdateResponseEnvelopeMessagesSource 

type RequestUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    requestUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RequestUpdateResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type RequestUpdateResponseEnvelopeSuccess 

type RequestUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RequestUpdateResponseEnvelopeSuccessTrue RequestUpdateResponseEnvelopeSuccess = true
)

func (RequestUpdateResponseEnvelopeSuccess) IsKnown 

func (r RequestUpdateResponseEnvelopeSuccess) IsKnown() bool

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 ScanConfigDeleteParams 

type ScanConfigDeleteParams struct {
	// Defines the Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ScanConfigDeleteResponse 

type ScanConfigDeleteResponse = interface{}

type ScanConfigDeleteResponseEnvelope 

type ScanConfigDeleteResponseEnvelope struct {
	Errors   []string                             `json:"errors" api:"required"`
	Messages []string                             `json:"messages" api:"required"`
	Result   ScanConfigDeleteResponse             `json:"result" api:"required"`
	Success  bool                                 `json:"success" api:"required"`
	JSON     scanConfigDeleteResponseEnvelopeJSON `json:"-"`
}

func (*ScanConfigDeleteResponseEnvelope) UnmarshalJSON 

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

type ScanConfigEditParams 

type ScanConfigEditParams struct {
	// Defines the Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Defines the number of days between each scan (0 = One-off scan).
	Frequency param.Field[float64] `json:"frequency"`
	// Defines a list of IP addresses or CIDR blocks to scan. The maximum number of
	// total IP addresses allowed is 5000.
	IPs param.Field[[]string] `json:"ips"`
	// Defines a list of ports to scan. Valid values are:"default", "all", or a
	// comma-separated list of ports or range of ports (e.g. ["1-80", "443"]).
	// "default" scans the 100 most commonly open ports.
	Ports param.Field[[]string] `json:"ports"`
}

func (ScanConfigEditParams) MarshalJSON 

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

type ScanConfigEditResponse 

type ScanConfigEditResponse struct {
	// Defines the Config ID.
	ID        string `json:"id" api:"required"`
	AccountID string `json:"account_id" api:"required"`
	// Defines the number of days between each scan (0 = One-off scan).
	Frequency float64 `json:"frequency" api:"required"`
	// Defines a list of IP addresses or CIDR blocks to scan. The maximum number of
	// total IP addresses allowed is 5000.
	IPs []string `json:"ips" api:"required"`
	// Defines a list of ports to scan. Valid values are:"default", "all", or a
	// comma-separated list of ports or range of ports (e.g. ["1-80", "443"]).
	// "default" scans the 100 most commonly open ports.
	Ports []string                   `json:"ports" api:"required"`
	JSON  scanConfigEditResponseJSON `json:"-"`
}

func (*ScanConfigEditResponse) UnmarshalJSON 

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

type ScanConfigEditResponseEnvelope 

type ScanConfigEditResponseEnvelope struct {
	Errors   []ScanConfigEditResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ScanConfigEditResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success ScanConfigEditResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  ScanConfigEditResponse                `json:"result"`
	JSON    scanConfigEditResponseEnvelopeJSON    `json:"-"`
}

func (*ScanConfigEditResponseEnvelope) UnmarshalJSON 

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

type ScanConfigEditResponseEnvelopeErrors 

type ScanConfigEditResponseEnvelopeErrors struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           ScanConfigEditResponseEnvelopeErrorsSource `json:"source"`
	JSON             scanConfigEditResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScanConfigEditResponseEnvelopeErrors) UnmarshalJSON 

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

type ScanConfigEditResponseEnvelopeErrorsSource 

type ScanConfigEditResponseEnvelopeErrorsSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    scanConfigEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScanConfigEditResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type ScanConfigEditResponseEnvelopeMessages 

type ScanConfigEditResponseEnvelopeMessages struct {
	Code             int64                                        `json:"code" api:"required"`
	Message          string                                       `json:"message" api:"required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           ScanConfigEditResponseEnvelopeMessagesSource `json:"source"`
	JSON             scanConfigEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScanConfigEditResponseEnvelopeMessages) UnmarshalJSON 

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

type ScanConfigEditResponseEnvelopeMessagesSource 

type ScanConfigEditResponseEnvelopeMessagesSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    scanConfigEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScanConfigEditResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type ScanConfigEditResponseEnvelopeSuccess 

type ScanConfigEditResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	ScanConfigEditResponseEnvelopeSuccessTrue ScanConfigEditResponseEnvelopeSuccess = true
)

func (ScanConfigEditResponseEnvelopeSuccess) IsKnown 

func (r ScanConfigEditResponseEnvelopeSuccess) IsKnown() bool

type ScanConfigListParams 

type ScanConfigListParams struct {
	// Defines the Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ScanConfigListResponse 

type ScanConfigListResponse struct {
	// Defines the Config ID.
	ID        string `json:"id" api:"required"`
	AccountID string `json:"account_id" api:"required"`
	// Defines the number of days between each scan (0 = One-off scan).
	Frequency float64 `json:"frequency" api:"required"`
	// Defines a list of IP addresses or CIDR blocks to scan. The maximum number of
	// total IP addresses allowed is 5000.
	IPs []string `json:"ips" api:"required"`
	// Defines a list of ports to scan. Valid values are:"default", "all", or a
	// comma-separated list of ports or range of ports (e.g. ["1-80", "443"]).
	// "default" scans the 100 most commonly open ports.
	Ports []string                   `json:"ports" api:"required"`
	JSON  scanConfigListResponseJSON `json:"-"`
}

func (*ScanConfigListResponse) UnmarshalJSON 

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

type ScanConfigNewParams 

type ScanConfigNewParams struct {
	// Defines the Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Defines a list of IP addresses or CIDR blocks to scan. The maximum number of
	// total IP addresses allowed is 5000.
	IPs param.Field[[]string] `json:"ips" api:"required"`
	// Defines the number of days between each scan (0 = One-off scan).
	Frequency param.Field[float64] `json:"frequency"`
	// Defines a list of ports to scan. Valid values are:"default", "all", or a
	// comma-separated list of ports or range of ports (e.g. ["1-80", "443"]).
	// "default" scans the 100 most commonly open ports.
	Ports param.Field[[]string] `json:"ports"`
}

func (ScanConfigNewParams) MarshalJSON 

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

type ScanConfigNewResponse 

type ScanConfigNewResponse struct {
	// Defines the Config ID.
	ID        string `json:"id" api:"required"`
	AccountID string `json:"account_id" api:"required"`
	// Defines the number of days between each scan (0 = One-off scan).
	Frequency float64 `json:"frequency" api:"required"`
	// Defines a list of IP addresses or CIDR blocks to scan. The maximum number of
	// total IP addresses allowed is 5000.
	IPs []string `json:"ips" api:"required"`
	// Defines a list of ports to scan. Valid values are:"default", "all", or a
	// comma-separated list of ports or range of ports (e.g. ["1-80", "443"]).
	// "default" scans the 100 most commonly open ports.
	Ports []string                  `json:"ports" api:"required"`
	JSON  scanConfigNewResponseJSON `json:"-"`
}

func (*ScanConfigNewResponse) UnmarshalJSON 

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

type ScanConfigNewResponseEnvelope 

type ScanConfigNewResponseEnvelope struct {
	Errors   []ScanConfigNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ScanConfigNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success ScanConfigNewResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  ScanConfigNewResponse                `json:"result"`
	JSON    scanConfigNewResponseEnvelopeJSON    `json:"-"`
}

func (*ScanConfigNewResponseEnvelope) UnmarshalJSON 

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

type ScanConfigNewResponseEnvelopeErrors 

type ScanConfigNewResponseEnvelopeErrors struct {
	Code             int64                                     `json:"code" api:"required"`
	Message          string                                    `json:"message" api:"required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           ScanConfigNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             scanConfigNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScanConfigNewResponseEnvelopeErrors) UnmarshalJSON 

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

type ScanConfigNewResponseEnvelopeErrorsSource 

type ScanConfigNewResponseEnvelopeErrorsSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    scanConfigNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScanConfigNewResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type ScanConfigNewResponseEnvelopeMessages 

type ScanConfigNewResponseEnvelopeMessages struct {
	Code             int64                                       `json:"code" api:"required"`
	Message          string                                      `json:"message" api:"required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           ScanConfigNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             scanConfigNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScanConfigNewResponseEnvelopeMessages) UnmarshalJSON 

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

type ScanConfigNewResponseEnvelopeMessagesSource 

type ScanConfigNewResponseEnvelopeMessagesSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    scanConfigNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScanConfigNewResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type ScanConfigNewResponseEnvelopeSuccess 

type ScanConfigNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	ScanConfigNewResponseEnvelopeSuccessTrue ScanConfigNewResponseEnvelopeSuccess = true
)

func (ScanConfigNewResponseEnvelopeSuccess) IsKnown 

func (r ScanConfigNewResponseEnvelopeSuccess) IsKnown() bool

type ScanConfigService 

type ScanConfigService struct {
	Options []option.RequestOption
}

ScanConfigService 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 NewScanConfigService method instead.

func NewScanConfigService 

func NewScanConfigService(opts ...option.RequestOption) (r *ScanConfigService)

NewScanConfigService 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 (*ScanConfigService) Delete 

func (r *ScanConfigService) Delete(ctx context.Context, configID string, body ScanConfigDeleteParams, opts ...option.RequestOption) (res *ScanConfigDeleteResponse, err error)

Deletes a scan configuration from Cloudforce One's network scanning service.

func (*ScanConfigService) Edit 

func (r *ScanConfigService) Edit(ctx context.Context, configID string, params ScanConfigEditParams, opts ...option.RequestOption) (res *ScanConfigEditResponse, err error)

Updates an existing scan configuration in Cloudforce One's network scanning service.

func (*ScanConfigService) List 

func (r *ScanConfigService) List(ctx context.Context, query ScanConfigListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ScanConfigListResponse], err error)

Lists scan configurations for Cloudforce One's network scanning service.

func (*ScanConfigService) ListAutoPaging 

func (r *ScanConfigService) ListAutoPaging(ctx context.Context, query ScanConfigListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ScanConfigListResponse]

Lists scan configurations for Cloudforce One's network scanning service.

func (*ScanConfigService) New 

func (r *ScanConfigService) New(ctx context.Context, params ScanConfigNewParams, opts ...option.RequestOption) (res *ScanConfigNewResponse, err error)

Creates a new scan configuration for Cloudforce One's network scanning service.

type ScanResult 

type ScanResult struct {
	Number float64        `json:"number"`
	Proto  string         `json:"proto"`
	Status string         `json:"status"`
	JSON   scanResultJSON `json:"-"`
}

func (*ScanResult) UnmarshalJSON 

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

type ScanResultGetParams 

type ScanResultGetParams struct {
	// Defines the Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ScanResultGetResponse 

type ScanResultGetResponse struct {
	OneOneOneOne []ScanResult              `json:"1.1.1.1" api:"required"`
	JSON         scanResultGetResponseJSON `json:"-"`
}

func (*ScanResultGetResponse) UnmarshalJSON 

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

type ScanResultGetResponseEnvelope 

type ScanResultGetResponseEnvelope struct {
	Errors   []string                          `json:"errors" api:"required"`
	Messages []string                          `json:"messages" api:"required"`
	Result   ScanResultGetResponse             `json:"result" api:"required"`
	Success  bool                              `json:"success" api:"required"`
	JSON     scanResultGetResponseEnvelopeJSON `json:"-"`
}

func (*ScanResultGetResponseEnvelope) UnmarshalJSON 

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

type ScanResultService 

type ScanResultService struct {
	Options []option.RequestOption
}

ScanResultService 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 NewScanResultService method instead.

func NewScanResultService 

func NewScanResultService(opts ...option.RequestOption) (r *ScanResultService)

NewScanResultService 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 (*ScanResultService) Get 

func (r *ScanResultService) Get(ctx context.Context, configID string, query ScanResultGetParams, opts ...option.RequestOption) (res *ScanResultGetResponse, err error)

Retrieves the latest scan results for a Cloudforce One scan configuration, including discovered open ports.

type ScanService 

type ScanService struct {
	Options []option.RequestOption
	Results *ScanResultService
	Config  *ScanConfigService
}

ScanService 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 NewScanService method instead.

func NewScanService 

func NewScanService(opts ...option.RequestOption) (r *ScanService)

NewScanService 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 SortDirection 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

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 ThreatEventAggregateListParams added in v7.8.0 

type ThreatEventAggregateListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Column(s) to aggregate by - single column or comma-separated list (e.g.,
	// 'attacker', 'targetIndustry', 'attacker,targetIndustry')
	AggregateBy param.Field[string] `query:"aggregateBy" api:"required"`
	// Dataset UUIDs to filter by, or one standalone scope value: 'all'/'\*' or
	// 'operational' for readable intelligence datasets (isAnalytics=false), or
	// 'analytics' for readable analytics datasets (isAnalytics=true). Scope values
	// query at most 50 datasets. If not provided, uses the default dataset.
	DatasetID param.Field[[]string] `query:"datasetId"`
	// End date for filtering (ISO 8601 format, e.g., '2024-12-31')
	EndDate param.Field[string] `query:"endDate"`
	// Whether to group results by date (daily aggregation)
	GroupByDate param.Field[bool] `query:"groupByDate"`
	// Maximum number of results to return
	Limit param.Field[float64] `query:"limit"`
	// Start date for filtering (ISO 8601 format, e.g., '2024-01-01')
	StartDate param.Field[string] `query:"startDate"`
}

func (ThreatEventAggregateListParams) URLQuery added in v7.8.0 

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

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

type ThreatEventAggregateListResponse added in v7.8.0 

type ThreatEventAggregateListResponse struct {
	// Column(s) that were aggregated by
	AggregateBy string `json:"aggregateBy" api:"required"`
	// Array of aggregation results with dynamic fields based on aggregateBy columns
	Aggregations []ThreatEventAggregateListResponseAggregation `json:"aggregations" api:"required"`
	// Total number of events in the aggregation
	Total float64 `json:"total" api:"required"`
	// Date range used for filtering
	DateRange ThreatEventAggregateListResponseDateRange `json:"dateRange"`
	JSON      threatEventAggregateListResponseJSON      `json:"-"`
}

func (*ThreatEventAggregateListResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventAggregateListResponseAggregation added in v7.8.0 

type ThreatEventAggregateListResponseAggregation struct {
	// Number of events for this aggregation
	Count float64 `json:"count" api:"required"`
	// Date (if groupByDate is true)
	Date        string                                          `json:"date"`
	ExtraFields map[string]string                               `json:"-" api:"extrafields"`
	JSON        threatEventAggregateListResponseAggregationJSON `json:"-"`
}

func (*ThreatEventAggregateListResponseAggregation) UnmarshalJSON added in v7.8.0 

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

type ThreatEventAggregateListResponseDateRange added in v7.8.0 

type ThreatEventAggregateListResponseDateRange struct {
	EndDate   string                                        `json:"endDate"`
	StartDate string                                        `json:"startDate"`
	JSON      threatEventAggregateListResponseDateRangeJSON `json:"-"`
}

Date range used for filtering

func (*ThreatEventAggregateListResponseDateRange) UnmarshalJSON added in v7.8.0 

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

type ThreatEventAggregateService added in v7.8.0 

type ThreatEventAggregateService struct {
	Options []option.RequestOption
}

ThreatEventAggregateService 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 NewThreatEventAggregateService method instead.

func NewThreatEventAggregateService added in v7.8.0 

func NewThreatEventAggregateService(opts ...option.RequestOption) (r *ThreatEventAggregateService)

NewThreatEventAggregateService 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 (*ThreatEventAggregateService) List added in v7.8.0 

func (r *ThreatEventAggregateService) List(ctx context.Context, params ThreatEventAggregateListParams, opts ...option.RequestOption) (res *ThreatEventAggregateListResponse, err error)

Aggregate threat events by one or more columns (e.g., attacker, targetIndustry) with optional date filtering and daily grouping. Supports multi-dimensional aggregation for cross-analysis.

type ThreatEventAttackerListParams 

type ThreatEventAttackerListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Array of dataset IDs to query attackers from. If not provided, uses the default
	// dataset.
	DatasetIDs param.Field[[]string] `query:"datasetIds"`
}

func (ThreatEventAttackerListParams) URLQuery 

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

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

type ThreatEventAttackerListResponse 

type ThreatEventAttackerListResponse struct {
	Items ThreatEventAttackerListResponseItems `json:"items" api:"required"`
	Type  string                               `json:"type" api:"required"`
	JSON  threatEventAttackerListResponseJSON  `json:"-"`
}

func (*ThreatEventAttackerListResponse) UnmarshalJSON 

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

type ThreatEventAttackerListResponseItems 

type ThreatEventAttackerListResponseItems struct {
	Type string                                   `json:"type" api:"required"`
	JSON threatEventAttackerListResponseItemsJSON `json:"-"`
}

func (*ThreatEventAttackerListResponseItems) UnmarshalJSON 

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

type ThreatEventAttackerService 

type ThreatEventAttackerService struct {
	Options []option.RequestOption
}

ThreatEventAttackerService 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 NewThreatEventAttackerService method instead.

func NewThreatEventAttackerService 

func NewThreatEventAttackerService(opts ...option.RequestOption) (r *ThreatEventAttackerService)

NewThreatEventAttackerService 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 (*ThreatEventAttackerService) List 

func (r *ThreatEventAttackerService) List(ctx context.Context, params ThreatEventAttackerListParams, opts ...option.RequestOption) (res *ThreatEventAttackerListResponse, err error)

Lists known threat attackers tracked in Cloudforce One threat intelligence.

type ThreatEventBulkNewParams 

type ThreatEventBulkNewParams struct {
	// Account ID.
	AccountID param.Field[string]                         `path:"account_id" api:"required"`
	Data      param.Field[[]ThreatEventBulkNewParamsData] `json:"data" api:"required"`
	DatasetID param.Field[string]                         `json:"datasetId" api:"required"`
	// When true, response includes array of created event UUIDs and shard IDs. Useful
	// for tracking which events were created and where.
	IncludeCreatedEvents param.Field[bool] `json:"includeCreatedEvents"`
}

func (ThreatEventBulkNewParams) MarshalJSON 

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

type ThreatEventBulkNewParamsData 

type ThreatEventBulkNewParamsData struct {
	Category        param.Field[string]                          `json:"category" api:"required"`
	Date            param.Field[time.Time]                       `json:"date" api:"required" format:"date-time"`
	Event           param.Field[string]                          `json:"event" api:"required"`
	Raw             param.Field[ThreatEventBulkNewParamsDataRaw] `json:"raw" api:"required"`
	TLP             param.Field[string]                          `json:"tlp" api:"required"`
	AccountID       param.Field[float64]                         `json:"accountId"`
	Attacker        param.Field[string]                          `json:"attacker"`
	AttackerCountry param.Field[string]                          `json:"attackerCountry"`
	DatasetID       param.Field[string]                          `json:"datasetId"`
	Indicator       param.Field[string]                          `json:"indicator"`
	// Array of indicators for this event. Supports multiple indicators per event for
	// complex scenarios.
	Indicators     param.Field[[]ThreatEventBulkNewParamsDataIndicator] `json:"indicators"`
	IndicatorType  param.Field[string]                                  `json:"indicatorType"`
	Insight        param.Field[string]                                  `json:"insight"`
	Tags           param.Field[[]string]                                `json:"tags"`
	TargetCountry  param.Field[string]                                  `json:"targetCountry"`
	TargetIndustry param.Field[string]                                  `json:"targetIndustry"`
}

func (ThreatEventBulkNewParamsData) MarshalJSON 

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

type ThreatEventBulkNewParamsDataIndicator 

type ThreatEventBulkNewParamsDataIndicator struct {
	// The type of indicator (e.g., DOMAIN, IP, JA3, HASH)
	IndicatorType param.Field[string] `json:"indicatorType" api:"required"`
	// The indicator value (e.g., domain name, IP address, hash)
	Value param.Field[string] `json:"value" api:"required"`
}

func (ThreatEventBulkNewParamsDataIndicator) MarshalJSON 

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

type ThreatEventBulkNewParamsDataRaw 

type ThreatEventBulkNewParamsDataRaw struct {
	Data   param.Field[map[string]interface{}] `json:"data" api:"required"`
	Source param.Field[string]                 `json:"source"`
	TLP    param.Field[string]                 `json:"tlp"`
}

func (ThreatEventBulkNewParamsDataRaw) MarshalJSON 

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

type ThreatEventBulkNewRelationshipsParams added in v7.8.0 

type ThreatEventBulkNewRelationshipsParams struct {
	// Account ID.
	AccountID param.Field[string]                                      `path:"account_id" api:"required"`
	Data      param.Field[[]ThreatEventBulkNewRelationshipsParamsData] `json:"data" api:"required"`
	DatasetID param.Field[string]                                      `json:"datasetId" api:"required"`
}

func (ThreatEventBulkNewRelationshipsParams) MarshalJSON added in v7.8.0 

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

type ThreatEventBulkNewRelationshipsParamsData added in v7.8.0 

type ThreatEventBulkNewRelationshipsParamsData struct {
	Category        param.Field[string]                                       `json:"category" api:"required"`
	Date            param.Field[time.Time]                                    `json:"date" api:"required" format:"date-time"`
	Event           param.Field[string]                                       `json:"event" api:"required"`
	Raw             param.Field[ThreatEventBulkNewRelationshipsParamsDataRaw] `json:"raw" api:"required"`
	TLP             param.Field[string]                                       `json:"tlp" api:"required"`
	AccountID       param.Field[float64]                                      `json:"accountId"`
	Attacker        param.Field[string]                                       `json:"attacker"`
	AttackerCountry param.Field[string]                                       `json:"attackerCountry"`
	DatasetID       param.Field[string]                                       `json:"datasetId"`
	Indicator       param.Field[string]                                       `json:"indicator"`
	// Array of indicators for this event. Supports multiple indicators per event for
	// complex scenarios.
	Indicators     param.Field[[]ThreatEventBulkNewRelationshipsParamsDataIndicator] `json:"indicators"`
	IndicatorType  param.Field[string]                                               `json:"indicatorType"`
	Insight        param.Field[string]                                               `json:"insight"`
	Tags           param.Field[[]string]                                             `json:"tags"`
	TargetCountry  param.Field[string]                                               `json:"targetCountry"`
	TargetIndustry param.Field[string]                                               `json:"targetIndustry"`
}

func (ThreatEventBulkNewRelationshipsParamsData) MarshalJSON added in v7.8.0 

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

type ThreatEventBulkNewRelationshipsParamsDataIndicator added in v7.8.0 

type ThreatEventBulkNewRelationshipsParamsDataIndicator struct {
	// The type of indicator (e.g., DOMAIN, IP, JA3, HASH)
	IndicatorType param.Field[string] `json:"indicatorType" api:"required"`
	// The indicator value (e.g., domain name, IP address, hash)
	Value param.Field[string] `json:"value" api:"required"`
}

func (ThreatEventBulkNewRelationshipsParamsDataIndicator) MarshalJSON added in v7.8.0 

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

type ThreatEventBulkNewRelationshipsParamsDataRaw added in v7.8.0 

type ThreatEventBulkNewRelationshipsParamsDataRaw struct {
	Data   param.Field[map[string]interface{}] `json:"data" api:"required"`
	Source param.Field[string]                 `json:"source"`
	TLP    param.Field[string]                 `json:"tlp"`
}

func (ThreatEventBulkNewRelationshipsParamsDataRaw) MarshalJSON added in v7.8.0 

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

type ThreatEventBulkNewRelationshipsResponse added in v7.8.0 

type ThreatEventBulkNewRelationshipsResponse struct {
	// Number of events created
	CreatedEventsCount float64 `json:"createdEventsCount" api:"required"`
	// Number of indicators created
	CreatedIndicatorsCount float64 `json:"createdIndicatorsCount" api:"required"`
	// Number of relationships created
	CreatedRelationshipsCount float64 `json:"createdRelationshipsCount" api:"required"`
	// Number of errors encountered
	ErrorCount float64 `json:"errorCount" api:"required"`
	// Array of error details
	Errors []ThreatEventBulkNewRelationshipsResponseError `json:"errors"`
	JSON   threatEventBulkNewRelationshipsResponseJSON    `json:"-"`
}

Result of bulk relationship creation operation

func (*ThreatEventBulkNewRelationshipsResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventBulkNewRelationshipsResponseError added in v7.8.0 

type ThreatEventBulkNewRelationshipsResponseError struct {
	// Error message
	Error string `json:"error" api:"required"`
	// Index of the event that caused the error
	EventIndex float64                                          `json:"eventIndex" api:"required"`
	JSON       threatEventBulkNewRelationshipsResponseErrorJSON `json:"-"`
}

func (*ThreatEventBulkNewRelationshipsResponseError) UnmarshalJSON added in v7.8.0 

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

type ThreatEventBulkNewResponse 

type ThreatEventBulkNewResponse struct {
	// Number of events created
	CreatedEventsCount float64 `json:"createdEventsCount" api:"required"`
	// Number of new tags created in SoT
	CreatedTagsCount float64 `json:"createdTagsCount" api:"required"`
	// Number of errors encountered
	ErrorCount float64 `json:"errorCount" api:"required"`
	// Number of indicators queued for async processing
	QueuedIndicatorsCount float64 `json:"queuedIndicatorsCount" api:"required"`
	// Correlation ID for async indicator processing
	CreateBulkEventsRequestID string `json:"createBulkEventsRequestId" format:"uuid"`
	// Array of created events with UUIDs and shard locations. Only present when
	// includeCreatedEvents=true
	CreatedEvents []ThreatEventBulkNewResponseCreatedEvent `json:"createdEvents"`
	// Array of error details
	Errors []ThreatEventBulkNewResponseError `json:"errors"`
	JSON   threatEventBulkNewResponseJSON    `json:"-"`
}

Detailed result of bulk event creation with auto-tag management

func (*ThreatEventBulkNewResponse) UnmarshalJSON 

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

type ThreatEventBulkNewResponseCreatedEvent 

type ThreatEventBulkNewResponseCreatedEvent struct {
	// Original index in the input data array
	EventIndex float64 `json:"eventIndex" api:"required"`
	// Dataset ID of the shard where the event was created
	ShardID string `json:"shardId" api:"required"`
	// UUID of the created event
	UUID string                                     `json:"uuid" api:"required" format:"uuid"`
	JSON threatEventBulkNewResponseCreatedEventJSON `json:"-"`
}

func (*ThreatEventBulkNewResponseCreatedEvent) UnmarshalJSON 

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

type ThreatEventBulkNewResponseError 

type ThreatEventBulkNewResponseError struct {
	// Error message
	Error string `json:"error" api:"required"`
	// Index of the event that caused the error
	EventIndex float64                             `json:"eventIndex" api:"required"`
	JSON       threatEventBulkNewResponseErrorJSON `json:"-"`
}

func (*ThreatEventBulkNewResponseError) UnmarshalJSON 

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

type ThreatEventCategoryCatalogListParams added in v7.8.0 

type ThreatEventCategoryCatalogListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventCategoryCatalogListResponse added in v7.8.0 

type ThreatEventCategoryCatalogListResponse struct {
	KillChain   float64                                    `json:"killChain" api:"required"`
	Name        string                                     `json:"name" api:"required"`
	UUID        string                                     `json:"uuid" api:"required"`
	MitreAttack []string                                   `json:"mitreAttack"`
	MitreCapec  []string                                   `json:"mitreCapec"`
	Shortname   string                                     `json:"shortname"`
	JSON        threatEventCategoryCatalogListResponseJSON `json:"-"`
}

func (*ThreatEventCategoryCatalogListResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventCategoryCatalogService added in v7.8.0 

type ThreatEventCategoryCatalogService struct {
	Options []option.RequestOption
}

ThreatEventCategoryCatalogService 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 NewThreatEventCategoryCatalogService method instead.

func NewThreatEventCategoryCatalogService added in v7.8.0 

func NewThreatEventCategoryCatalogService(opts ...option.RequestOption) (r *ThreatEventCategoryCatalogService)

NewThreatEventCategoryCatalogService 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 (*ThreatEventCategoryCatalogService) List added in v7.8.0 

func (r *ThreatEventCategoryCatalogService) List(ctx context.Context, query ThreatEventCategoryCatalogListParams, opts ...option.RequestOption) (res *[]ThreatEventCategoryCatalogListResponse, err error)

Lists categories

type ThreatEventCategoryDeleteParams 

type ThreatEventCategoryDeleteParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventCategoryDeleteResponse 

type ThreatEventCategoryDeleteResponse struct {
	UUID string                                `json:"uuid" api:"required"`
	JSON threatEventCategoryDeleteResponseJSON `json:"-"`
}

func (*ThreatEventCategoryDeleteResponse) UnmarshalJSON 

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

type ThreatEventCategoryEditParams 

type ThreatEventCategoryEditParams struct {
	// Account ID.
	AccountID   param.Field[string]   `path:"account_id" api:"required"`
	KillChain   param.Field[float64]  `json:"killChain"`
	MitreAttack param.Field[[]string] `json:"mitreAttack"`
	MitreCapec  param.Field[[]string] `json:"mitreCapec"`
	Name        param.Field[string]   `json:"name"`
	Shortname   param.Field[string]   `json:"shortname"`
}

func (ThreatEventCategoryEditParams) MarshalJSON 

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

type ThreatEventCategoryEditResponse 

type ThreatEventCategoryEditResponse struct {
	KillChain   float64                             `json:"killChain" api:"required"`
	Name        string                              `json:"name" api:"required"`
	UUID        string                              `json:"uuid" api:"required"`
	MitreAttack []string                            `json:"mitreAttack"`
	MitreCapec  []string                            `json:"mitreCapec"`
	Shortname   string                              `json:"shortname"`
	JSON        threatEventCategoryEditResponseJSON `json:"-"`
}

func (*ThreatEventCategoryEditResponse) UnmarshalJSON 

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

type ThreatEventCategoryGetParams 

type ThreatEventCategoryGetParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventCategoryGetResponse 

type ThreatEventCategoryGetResponse struct {
	KillChain   float64                            `json:"killChain" api:"required"`
	Name        string                             `json:"name" api:"required"`
	UUID        string                             `json:"uuid" api:"required"`
	MitreAttack []string                           `json:"mitreAttack"`
	MitreCapec  []string                           `json:"mitreCapec"`
	Shortname   string                             `json:"shortname"`
	JSON        threatEventCategoryGetResponseJSON `json:"-"`
}

func (*ThreatEventCategoryGetResponse) UnmarshalJSON 

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

type ThreatEventCategoryListParams 

type ThreatEventCategoryListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Array of dataset IDs to query categories from. If not provided, uses the default
	// dataset.
	DatasetIDs param.Field[[]string] `query:"datasetIds"`
}

func (ThreatEventCategoryListParams) URLQuery 

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

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

type ThreatEventCategoryListResponse 

type ThreatEventCategoryListResponse struct {
	KillChain   float64                             `json:"killChain" api:"required"`
	Name        string                              `json:"name" api:"required"`
	UUID        string                              `json:"uuid" api:"required"`
	MitreAttack []string                            `json:"mitreAttack"`
	MitreCapec  []string                            `json:"mitreCapec"`
	Shortname   string                              `json:"shortname"`
	JSON        threatEventCategoryListResponseJSON `json:"-"`
}

func (*ThreatEventCategoryListResponse) UnmarshalJSON 

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

type ThreatEventCategoryNewParams 

type ThreatEventCategoryNewParams struct {
	// Account ID.
	AccountID   param.Field[string]   `path:"account_id" api:"required"`
	KillChain   param.Field[float64]  `json:"killChain" api:"required"`
	Name        param.Field[string]   `json:"name" api:"required"`
	MitreAttack param.Field[[]string] `json:"mitreAttack"`
	MitreCapec  param.Field[[]string] `json:"mitreCapec"`
	Shortname   param.Field[string]   `json:"shortname"`
}

func (ThreatEventCategoryNewParams) MarshalJSON 

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

type ThreatEventCategoryNewResponse 

type ThreatEventCategoryNewResponse struct {
	KillChain   float64                            `json:"killChain" api:"required"`
	Name        string                             `json:"name" api:"required"`
	UUID        string                             `json:"uuid" api:"required"`
	MitreAttack []string                           `json:"mitreAttack"`
	MitreCapec  []string                           `json:"mitreCapec"`
	Shortname   string                             `json:"shortname"`
	JSON        threatEventCategoryNewResponseJSON `json:"-"`
}

func (*ThreatEventCategoryNewResponse) UnmarshalJSON 

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

type ThreatEventCategoryService 

type ThreatEventCategoryService struct {
	Options []option.RequestOption
	Catalog *ThreatEventCategoryCatalogService
}

ThreatEventCategoryService 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 NewThreatEventCategoryService method instead.

func NewThreatEventCategoryService 

func NewThreatEventCategoryService(opts ...option.RequestOption) (r *ThreatEventCategoryService)

NewThreatEventCategoryService 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 (*ThreatEventCategoryService) Delete deprecated 

func (r *ThreatEventCategoryService) Delete(ctx context.Context, categoryID string, body ThreatEventCategoryDeleteParams, opts ...option.RequestOption) (res *ThreatEventCategoryDeleteResponse, err error)

Deprecated; use DELETE /events/event-categories/by-id/{category_id}. Available through 2026-11-28.

Deprecated: Use DELETE /events/event-categories/by-id/{category_id} before 2026-11-28.

func (*ThreatEventCategoryService) Edit deprecated 

func (r *ThreatEventCategoryService) Edit(ctx context.Context, categoryID string, params ThreatEventCategoryEditParams, opts ...option.RequestOption) (res *ThreatEventCategoryEditResponse, err error)

Deprecated; use PATCH /events/event-categories/by-id/{category_id}. Available through 2026-11-28.

Deprecated: Use PATCH /events/event-categories/by-id/{category_id} before 2026-11-28.

func (*ThreatEventCategoryService) Get deprecated 

func (r *ThreatEventCategoryService) Get(ctx context.Context, categoryID string, query ThreatEventCategoryGetParams, opts ...option.RequestOption) (res *ThreatEventCategoryGetResponse, err error)

Deprecated; use GET /events/event-categories/by-id/{category_id}. Available through 2026-11-28.

Deprecated: Use GET /events/event-categories/by-id/{category_id} before 2026-11-28.

func (*ThreatEventCategoryService) List 

func (r *ThreatEventCategoryService) List(ctx context.Context, params ThreatEventCategoryListParams, opts ...option.RequestOption) (res *[]ThreatEventCategoryListResponse, err error)

Lists all threat event categories configured for classifying and organizing threat events.

func (*ThreatEventCategoryService) New 

func (r *ThreatEventCategoryService) New(ctx context.Context, params ThreatEventCategoryNewParams, opts ...option.RequestOption) (res *ThreatEventCategoryNewResponse, err error)

Creates a new threat event category in Cloudforce One for organizing and classifying threat events.

type ThreatEventCountryListParams 

type ThreatEventCountryListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventCountryListResponse 

type ThreatEventCountryListResponse struct {
	Result  []ThreatEventCountryListResponseResult `json:"result" api:"required"`
	Success string                                 `json:"success" api:"required"`
	JSON    threatEventCountryListResponseJSON     `json:"-"`
}

func (*ThreatEventCountryListResponse) UnmarshalJSON 

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

type ThreatEventCountryListResponseResult 

type ThreatEventCountryListResponseResult struct {
	Alpha2 string                                   `json:"alpha2" api:"required"`
	Alpha3 string                                   `json:"alpha3" api:"required"`
	Name   string                                   `json:"name" api:"required"`
	JSON   threatEventCountryListResponseResultJSON `json:"-"`
}

func (*ThreatEventCountryListResponseResult) UnmarshalJSON 

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

type ThreatEventCountryService 

type ThreatEventCountryService struct {
	Options []option.RequestOption
}

ThreatEventCountryService 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 NewThreatEventCountryService method instead.

func NewThreatEventCountryService 

func NewThreatEventCountryService(opts ...option.RequestOption) (r *ThreatEventCountryService)

NewThreatEventCountryService 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 (*ThreatEventCountryService) List 

func (r *ThreatEventCountryService) List(ctx context.Context, query ThreatEventCountryListParams, opts ...option.RequestOption) (res *[]ThreatEventCountryListResponse, err error)

Lists countries referenced in Cloudforce One threat intelligence data.

type ThreatEventCronService 

type ThreatEventCronService struct {
	Options []option.RequestOption
}

ThreatEventCronService 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 NewThreatEventCronService method instead.

func NewThreatEventCronService 

func NewThreatEventCronService(opts ...option.RequestOption) (r *ThreatEventCronService)

NewThreatEventCronService 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 ThreatEventDatasetDeleteParams added in v7.8.0 

type ThreatEventDatasetDeleteParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventDatasetDeleteResponse added in v7.8.0 

type ThreatEventDatasetDeleteResponse struct {
	Name string                               `json:"name" api:"required"`
	UUID string                               `json:"uuid" api:"required"`
	JSON threatEventDatasetDeleteResponseJSON `json:"-"`
}

func (*ThreatEventDatasetDeleteResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventDatasetEditParams 

type ThreatEventDatasetEditParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// If true, then anyone can search the dataset. If false, then its limited to the
	// account.
	IsPublic param.Field[bool] `json:"isPublic" api:"required"`
	// Used to describe the dataset within the account context.
	Name param.Field[string] `json:"name" api:"required"`
}

func (ThreatEventDatasetEditParams) MarshalJSON 

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

type ThreatEventDatasetEditResponse 

type ThreatEventDatasetEditResponse struct {
	IsAnalytics bool                               `json:"isAnalytics" api:"required"`
	IsPublic    bool                               `json:"isPublic" api:"required"`
	Name        string                             `json:"name" api:"required"`
	UUID        string                             `json:"uuid" api:"required"`
	JSON        threatEventDatasetEditResponseJSON `json:"-"`
}

func (*ThreatEventDatasetEditResponse) UnmarshalJSON 

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

type ThreatEventDatasetEventGetParams added in v7.8.0 

type ThreatEventDatasetEventGetParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventDatasetEventGetResponse added in v7.8.0 

type ThreatEventDatasetEventGetResponse struct {
	Attacker              string                                 `json:"attacker" api:"required"`
	AttackerCountry       string                                 `json:"attackerCountry" api:"required"`
	AttackerCountryAlpha3 string                                 `json:"attackerCountryAlpha3" api:"required"`
	Category              string                                 `json:"category" api:"required"`
	DatasetID             string                                 `json:"datasetId" api:"required"`
	Date                  string                                 `json:"date" api:"required"`
	Event                 string                                 `json:"event" api:"required"`
	HasChildren           bool                                   `json:"hasChildren" api:"required"`
	Indicator             string                                 `json:"indicator" api:"required"`
	IndicatorType         string                                 `json:"indicatorType" api:"required"`
	IndicatorTypeID       float64                                `json:"indicatorTypeId" api:"required"`
	KillChain             float64                                `json:"killChain" api:"required"`
	MitreAttack           []string                               `json:"mitreAttack" api:"required"`
	MitreCapec            []string                               `json:"mitreCapec" api:"required"`
	NumReferenced         float64                                `json:"numReferenced" api:"required"`
	NumReferences         float64                                `json:"numReferences" api:"required"`
	RawID                 string                                 `json:"rawId" api:"required"`
	Referenced            []string                               `json:"referenced" api:"required"`
	ReferencedIDs         []float64                              `json:"referencedIds" api:"required"`
	References            []string                               `json:"references" api:"required"`
	ReferencesIDs         []float64                              `json:"referencesIds" api:"required"`
	Tags                  []string                               `json:"tags" api:"required"`
	TargetCountry         string                                 `json:"targetCountry" api:"required"`
	TargetCountryAlpha3   string                                 `json:"targetCountryAlpha3" api:"required"`
	TargetIndustry        string                                 `json:"targetIndustry" api:"required"`
	TLP                   string                                 `json:"tlp" api:"required"`
	UUID                  string                                 `json:"uuid" api:"required"`
	Insight               string                                 `json:"insight"`
	ReleasabilityID       string                                 `json:"releasabilityId"`
	JSON                  threatEventDatasetEventGetResponseJSON `json:"-"`
}

func (*ThreatEventDatasetEventGetResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventDatasetEventService added in v7.8.0 

type ThreatEventDatasetEventService struct {
	Options []option.RequestOption
}

ThreatEventDatasetEventService 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 NewThreatEventDatasetEventService method instead.

func NewThreatEventDatasetEventService added in v7.8.0 

func NewThreatEventDatasetEventService(opts ...option.RequestOption) (r *ThreatEventDatasetEventService)

NewThreatEventDatasetEventService 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 (*ThreatEventDatasetEventService) Get added in v7.8.0 

func (r *ThreatEventDatasetEventService) Get(ctx context.Context, datasetID string, eventID string, query ThreatEventDatasetEventGetParams, opts ...option.RequestOption) (res *ThreatEventDatasetEventGetResponse, err error)

Retrieves a specific event by its UUID.

type ThreatEventDatasetGetParams 

type ThreatEventDatasetGetParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventDatasetGetResponse 

type ThreatEventDatasetGetResponse struct {
	IsAnalytics bool                              `json:"isAnalytics" api:"required"`
	IsPublic    bool                              `json:"isPublic" api:"required"`
	Name        string                            `json:"name" api:"required"`
	UUID        string                            `json:"uuid" api:"required"`
	JSON        threatEventDatasetGetResponseJSON `json:"-"`
}

func (*ThreatEventDatasetGetResponse) UnmarshalJSON 

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

type ThreatEventDatasetHealthService 

type ThreatEventDatasetHealthService struct {
	Options []option.RequestOption
}

ThreatEventDatasetHealthService 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 NewThreatEventDatasetHealthService method instead.

func NewThreatEventDatasetHealthService 

func NewThreatEventDatasetHealthService(opts ...option.RequestOption) (r *ThreatEventDatasetHealthService)

NewThreatEventDatasetHealthService 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 ThreatEventDatasetListParams 

type ThreatEventDatasetListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// When true, include soft-deleted datasets in the response. Each item includes a
	// `deletedAt` field (ISO 8601 or null). Default: false.
	IncludeDeleted param.Field[bool] `query:"includeDeleted"`
}

func (ThreatEventDatasetListParams) URLQuery added in v7.7.0 

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

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

type ThreatEventDatasetListResponse 

type ThreatEventDatasetListResponse struct {
	// Effective indicator mutation capability after account/dataset authorization and
	// dataset storage capability are applied. API Gateway method permissions are
	// separate and must also allow the requested operation.
	IndicatorWriteMode ThreatEventDatasetListResponseIndicatorWriteMode `json:"indicatorWriteMode" api:"required"`
	IsAnalytics        bool                                             `json:"isAnalytics" api:"required"`
	IsPublic           bool                                             `json:"isPublic" api:"required"`
	Name               string                                           `json:"name" api:"required"`
	UUID               string                                           `json:"uuid" api:"required"`
	DeletedAt          string                                           `json:"deletedAt"`
	JSON               threatEventDatasetListResponseJSON               `json:"-"`
}

func (*ThreatEventDatasetListResponse) UnmarshalJSON 

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

type ThreatEventDatasetListResponseIndicatorWriteMode added in v7.9.0 

type ThreatEventDatasetListResponseIndicatorWriteMode string

Effective indicator mutation capability after account/dataset authorization and dataset storage capability are applied. API Gateway method permissions are separate and must also allow the requested operation. 

const (
	ThreatEventDatasetListResponseIndicatorWriteModeReadOnly   ThreatEventDatasetListResponseIndicatorWriteMode = "read_only"
	ThreatEventDatasetListResponseIndicatorWriteModeCreateOnly ThreatEventDatasetListResponseIndicatorWriteMode = "create_only"
	ThreatEventDatasetListResponseIndicatorWriteModeFull       ThreatEventDatasetListResponseIndicatorWriteMode = "full"
)

func (ThreatEventDatasetListResponseIndicatorWriteMode) IsKnown added in v7.9.0 

func (r ThreatEventDatasetListResponseIndicatorWriteMode) IsKnown() bool

type ThreatEventDatasetNewParams 

type ThreatEventDatasetNewParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// If true, then anyone can search the dataset. If false, then its limited to the
	// account.
	IsPublic param.Field[bool] `json:"isPublic" api:"required"`
	// Used to describe the dataset within the account context.
	Name param.Field[string] `json:"name" api:"required"`
}

func (ThreatEventDatasetNewParams) MarshalJSON 

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

type ThreatEventDatasetNewResponse 

type ThreatEventDatasetNewResponse struct {
	IsAnalytics bool                              `json:"isAnalytics" api:"required"`
	IsPublic    bool                              `json:"isPublic" api:"required"`
	Name        string                            `json:"name" api:"required"`
	UUID        string                            `json:"uuid" api:"required"`
	JSON        threatEventDatasetNewResponseJSON `json:"-"`
}

func (*ThreatEventDatasetNewResponse) UnmarshalJSON 

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

type ThreatEventDatasetRawParams 

type ThreatEventDatasetRawParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventDatasetRawResponse 

type ThreatEventDatasetRawResponse struct {
	ID        float64                           `json:"id" api:"required"`
	AccountID float64                           `json:"accountId" api:"required"`
	Created   string                            `json:"created" api:"required"`
	Data      string                            `json:"data" api:"required"`
	Source    string                            `json:"source" api:"required"`
	TLP       string                            `json:"tlp" api:"required"`
	JSON      threatEventDatasetRawResponseJSON `json:"-"`
}

func (*ThreatEventDatasetRawResponse) UnmarshalJSON 

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

type ThreatEventDatasetService 

type ThreatEventDatasetService struct {
	Options []option.RequestOption
	Health  *ThreatEventDatasetHealthService
	Events  *ThreatEventDatasetEventService
}

ThreatEventDatasetService 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 NewThreatEventDatasetService method instead.

func NewThreatEventDatasetService 

func NewThreatEventDatasetService(opts ...option.RequestOption) (r *ThreatEventDatasetService)

NewThreatEventDatasetService 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 (*ThreatEventDatasetService) Delete added in v7.8.0 

func (r *ThreatEventDatasetService) Delete(ctx context.Context, datasetID string, body ThreatEventDatasetDeleteParams, opts ...option.RequestOption) (res *ThreatEventDatasetDeleteResponse, err error)

Soft-deletes a dataset given a datasetId.

func (*ThreatEventDatasetService) Edit 

func (r *ThreatEventDatasetService) Edit(ctx context.Context, datasetID string, params ThreatEventDatasetEditParams, opts ...option.RequestOption) (res *ThreatEventDatasetEditResponse, err error)

Partially updates a threat event dataset in Cloudforce One, modifying specific fields without replacing the entire dataset configuration.

func (*ThreatEventDatasetService) Get 

func (r *ThreatEventDatasetService) Get(ctx context.Context, datasetID string, query ThreatEventDatasetGetParams, opts ...option.RequestOption) (res *ThreatEventDatasetGetResponse, err error)

Retrieves details for a specific threat event dataset.

func (*ThreatEventDatasetService) List 

func (r *ThreatEventDatasetService) List(ctx context.Context, params ThreatEventDatasetListParams, opts ...option.RequestOption) (res *[]ThreatEventDatasetListResponse, err error)

Lists all threat event datasets configured in Cloudforce One.

func (*ThreatEventDatasetService) New 

func (r *ThreatEventDatasetService) New(ctx context.Context, params ThreatEventDatasetNewParams, opts ...option.RequestOption) (res *ThreatEventDatasetNewResponse, err error)

Creates a new threat event dataset in Cloudforce One for organizing related threat events.

func (*ThreatEventDatasetService) Raw deprecated 

func (r *ThreatEventDatasetService) Raw(ctx context.Context, datasetID string, eventID string, query ThreatEventDatasetRawParams, opts ...option.RequestOption) (res *ThreatEventDatasetRawResponse, err error)

Deprecated; use GET /events/datasets/{dataset_id}/events/{event_id}/raw. Available through 2026-11-28.

Deprecated: Use GET /events/datasets/{dataset_id}/events/{event_id}/raw before 2026-11-28.

type ThreatEventEditParams 

type ThreatEventEditParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Dataset ID containing the event to update.
	DatasetID       param.Field[string]                   `json:"datasetId" api:"required"`
	Attacker        param.Field[string]                   `json:"attacker"`
	AttackerCountry param.Field[string]                   `json:"attackerCountry"`
	Category        param.Field[string]                   `json:"category"`
	CreatedAt       param.Field[time.Time]                `json:"createdAt" format:"date-time"`
	Date            param.Field[time.Time]                `json:"date" format:"date-time"`
	Event           param.Field[string]                   `json:"event"`
	Indicator       param.Field[string]                   `json:"indicator"`
	IndicatorType   param.Field[string]                   `json:"indicatorType"`
	Insight         param.Field[string]                   `json:"insight"`
	Raw             param.Field[ThreatEventEditParamsRaw] `json:"raw"`
	TargetCountry   param.Field[string]                   `json:"targetCountry"`
	TargetIndustry  param.Field[string]                   `json:"targetIndustry"`
	TLP             param.Field[string]                   `json:"tlp"`
}

func (ThreatEventEditParams) MarshalJSON 

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

type ThreatEventEditParamsRaw 

type ThreatEventEditParamsRaw struct {
	Data   param.Field[map[string]interface{}] `json:"data"`
	Source param.Field[string]                 `json:"source"`
	TLP    param.Field[string]                 `json:"tlp"`
}

func (ThreatEventEditParamsRaw) MarshalJSON 

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

type ThreatEventEditResponse 

type ThreatEventEditResponse struct {
	Attacker              string                      `json:"attacker" api:"required"`
	AttackerCountry       string                      `json:"attackerCountry" api:"required"`
	AttackerCountryAlpha3 string                      `json:"attackerCountryAlpha3" api:"required"`
	Category              string                      `json:"category" api:"required"`
	DatasetID             string                      `json:"datasetId" api:"required"`
	Date                  string                      `json:"date" api:"required"`
	Event                 string                      `json:"event" api:"required"`
	HasChildren           bool                        `json:"hasChildren" api:"required"`
	Indicator             string                      `json:"indicator" api:"required"`
	IndicatorType         string                      `json:"indicatorType" api:"required"`
	IndicatorTypeID       float64                     `json:"indicatorTypeId" api:"required"`
	KillChain             float64                     `json:"killChain" api:"required"`
	MitreAttack           []string                    `json:"mitreAttack" api:"required"`
	MitreCapec            []string                    `json:"mitreCapec" api:"required"`
	NumReferenced         float64                     `json:"numReferenced" api:"required"`
	NumReferences         float64                     `json:"numReferences" api:"required"`
	RawID                 string                      `json:"rawId" api:"required"`
	Referenced            []string                    `json:"referenced" api:"required"`
	ReferencedIDs         []float64                   `json:"referencedIds" api:"required"`
	References            []string                    `json:"references" api:"required"`
	ReferencesIDs         []float64                   `json:"referencesIds" api:"required"`
	Tags                  []string                    `json:"tags" api:"required"`
	TargetCountry         string                      `json:"targetCountry" api:"required"`
	TargetCountryAlpha3   string                      `json:"targetCountryAlpha3" api:"required"`
	TargetIndustry        string                      `json:"targetIndustry" api:"required"`
	TLP                   string                      `json:"tlp" api:"required"`
	UUID                  string                      `json:"uuid" api:"required"`
	Insight               string                      `json:"insight"`
	ReleasabilityID       string                      `json:"releasabilityId"`
	JSON                  threatEventEditResponseJSON `json:"-"`
}

func (*ThreatEventEditResponse) UnmarshalJSON 

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

type ThreatEventEventTagDeleteParams 

type ThreatEventEventTagDeleteParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventEventTagDeleteResponse 

type ThreatEventEventTagDeleteResponse struct {
	Success bool                                  `json:"success" api:"required"`
	JSON    threatEventEventTagDeleteResponseJSON `json:"-"`
}

func (*ThreatEventEventTagDeleteResponse) UnmarshalJSON 

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

type ThreatEventEventTagDeleteResponseEnvelope 

type ThreatEventEventTagDeleteResponseEnvelope struct {
	Result  ThreatEventEventTagDeleteResponse             `json:"result" api:"required"`
	Success bool                                          `json:"success" api:"required"`
	JSON    threatEventEventTagDeleteResponseEnvelopeJSON `json:"-"`
}

func (*ThreatEventEventTagDeleteResponseEnvelope) UnmarshalJSON 

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

type ThreatEventEventTagNewParams 

type ThreatEventEventTagNewParams struct {
	// Account ID.
	AccountID param.Field[string]   `path:"account_id" api:"required"`
	Tags      param.Field[[]string] `json:"tags" api:"required"`
}

func (ThreatEventEventTagNewParams) MarshalJSON 

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

type ThreatEventEventTagNewResponse 

type ThreatEventEventTagNewResponse struct {
	Success bool                               `json:"success" api:"required"`
	JSON    threatEventEventTagNewResponseJSON `json:"-"`
}

func (*ThreatEventEventTagNewResponse) UnmarshalJSON 

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

type ThreatEventEventTagNewResponseEnvelope 

type ThreatEventEventTagNewResponseEnvelope struct {
	Result  ThreatEventEventTagNewResponse             `json:"result" api:"required"`
	Success bool                                       `json:"success" api:"required"`
	JSON    threatEventEventTagNewResponseEnvelopeJSON `json:"-"`
}

func (*ThreatEventEventTagNewResponseEnvelope) UnmarshalJSON 

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

type ThreatEventEventTagService 

type ThreatEventEventTagService struct {
	Options []option.RequestOption
}

ThreatEventEventTagService 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 NewThreatEventEventTagService method instead.

func NewThreatEventEventTagService 

func NewThreatEventEventTagService(opts ...option.RequestOption) (r *ThreatEventEventTagService)

NewThreatEventEventTagService 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 (*ThreatEventEventTagService) Delete 

func (r *ThreatEventEventTagService) Delete(ctx context.Context, eventID string, body ThreatEventEventTagDeleteParams, opts ...option.RequestOption) (res *ThreatEventEventTagDeleteResponse, err error)

Removes a tag from a threat event in Cloudforce One.

func (*ThreatEventEventTagService) New 

func (r *ThreatEventEventTagService) New(ctx context.Context, eventID string, params ThreatEventEventTagNewParams, opts ...option.RequestOption) (res *ThreatEventEventTagNewResponse, err error)

Adds a tag to a threat event in Cloudforce One for classification and filtering.

type ThreatEventGetParams 

type ThreatEventGetParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventGetResponse 

type ThreatEventGetResponse struct {
	Attacker              string                     `json:"attacker" api:"required"`
	AttackerCountry       string                     `json:"attackerCountry" api:"required"`
	AttackerCountryAlpha3 string                     `json:"attackerCountryAlpha3" api:"required"`
	Category              string                     `json:"category" api:"required"`
	DatasetID             string                     `json:"datasetId" api:"required"`
	Date                  string                     `json:"date" api:"required"`
	Event                 string                     `json:"event" api:"required"`
	HasChildren           bool                       `json:"hasChildren" api:"required"`
	Indicator             string                     `json:"indicator" api:"required"`
	IndicatorType         string                     `json:"indicatorType" api:"required"`
	IndicatorTypeID       float64                    `json:"indicatorTypeId" api:"required"`
	KillChain             float64                    `json:"killChain" api:"required"`
	MitreAttack           []string                   `json:"mitreAttack" api:"required"`
	MitreCapec            []string                   `json:"mitreCapec" api:"required"`
	NumReferenced         float64                    `json:"numReferenced" api:"required"`
	NumReferences         float64                    `json:"numReferences" api:"required"`
	RawID                 string                     `json:"rawId" api:"required"`
	Referenced            []string                   `json:"referenced" api:"required"`
	ReferencedIDs         []float64                  `json:"referencedIds" api:"required"`
	References            []string                   `json:"references" api:"required"`
	ReferencesIDs         []float64                  `json:"referencesIds" api:"required"`
	Tags                  []string                   `json:"tags" api:"required"`
	TargetCountry         string                     `json:"targetCountry" api:"required"`
	TargetCountryAlpha3   string                     `json:"targetCountryAlpha3" api:"required"`
	TargetIndustry        string                     `json:"targetIndustry" api:"required"`
	TLP                   string                     `json:"tlp" api:"required"`
	UUID                  string                     `json:"uuid" api:"required"`
	Insight               string                     `json:"insight"`
	ReleasabilityID       string                     `json:"releasabilityId"`
	JSON                  threatEventGetResponseJSON `json:"-"`
}

func (*ThreatEventGetResponse) UnmarshalJSON 

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

type ThreatEventGraphListParams added in v7.8.0 

type ThreatEventGraphListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Opaque pagination token. Only valid when seeds has exactly 1 entry; 400
	// otherwise.
	Cursor param.Field[string] `query:"cursor"`
	// Comma-separated dataset UUIDs to restrict neighbor scope, or one standalone
	// scope value: 'operational' for readable intelligence datasets
	// (isAnalytics=false), 'analytics' for readable analytics datasets
	// (isAnalytics=true), or 'all'/'\*' for every readable dataset including analytics
	// datasets (the graph reads analytics relationships from R2). Intersected with
	// access grants.
	DatasetIDs param.Field[[]string] `query:"datasetIds"`
	// Edge direction relative to each seed: out (seed→neighbors), in (neighbors→seed),
	// both (default).
	Direction param.Field[string] `query:"direction"`
	// Comma-separated list of response sections to expand (hydrate). Allowed: `nodes`.
	// Omitting `expand` returns identifier-only nodes.
	Expand param.Field[[]string] `query:"expand"`
	// Hydration strategy for neighbor nodes when expand=nodes is set. r2_join
	// (default): use R2 JOIN query + DO fallback. do_only: use plain R2 query +
	// hydrate all neighbors via Durable Objects.
	Hydration param.Field[string] `query:"hydration"`
	// Max neighbors per seed (default: 100, max: 1000). Values above 1000 return 400.
	Limit param.Field[float64] `query:"limit"`
	// Total accumulated node cap across all seeds (default: 500, max: 1000). Values
	// above 1000 return 400.
	MaxNodes param.Field[float64] `query:"max_nodes"`
	// Comma-separated relationship types to filter by. Allowed: tagged_with,
	// appears_in, related_to, caused_by, attributed_to.
	RelationshipTypes param.Field[[]string] `query:"relationshipTypes"`
	// Comma-separated compact seed ids (type:uuid). Example:
	// seeds=event:550e8400-...,indicator:661fa920-... Provide 1–50 entries; omitting
	// seeds returns 400.
	Seeds param.Field[[]string] `query:"seeds"`
}

func (ThreatEventGraphListParams) URLQuery added in v7.8.0 

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

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

type ThreatEventGraphListResponse added in v7.8.0 

type ThreatEventGraphListResponse struct {
	Edges []ThreatEventGraphListResponseEdge `json:"edges" api:"required"`
	// Focal node object (legacy single-seed). Null when unavailable.
	Node  map[string]interface{}           `json:"node" api:"required,nullable"`
	Nodes []map[string]interface{}         `json:"nodes" api:"required"`
	JSON  threatEventGraphListResponseJSON `json:"-"`
}

func (*ThreatEventGraphListResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventGraphListResponseEdge added in v7.8.0 

type ThreatEventGraphListResponseEdge struct {
	// Deterministic composite edge id (source→target:relationshipType)
	ID               string `json:"id" api:"required"`
	RelationshipType string `json:"relationshipType" api:"required"`
	// Compact id of the source node (type:uuid)
	Source     string `json:"source" api:"required"`
	SourceID   string `json:"sourceId" api:"required"`
	SourceType string `json:"sourceType" api:"required"`
	// Compact id of the target node (type:uuid)
	Target     string                               `json:"target" api:"required"`
	TargetID   string                               `json:"targetId" api:"required"`
	TargetType string                               `json:"targetType" api:"required"`
	JSON       threatEventGraphListResponseEdgeJSON `json:"-"`
}

func (*ThreatEventGraphListResponseEdge) UnmarshalJSON added in v7.8.0 

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

type ThreatEventGraphListResponseEnvelope added in v7.8.0 

type ThreatEventGraphListResponseEnvelope struct {
	Errors     []map[string]interface{}                       `json:"errors" api:"required"`
	Messages   []map[string]interface{}                       `json:"messages" api:"required"`
	Result     ThreatEventGraphListResponse                   `json:"result" api:"required"`
	Success    bool                                           `json:"success" api:"required"`
	ResultInfo ThreatEventGraphListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       threatEventGraphListResponseEnvelopeJSON       `json:"-"`
}

func (*ThreatEventGraphListResponseEnvelope) UnmarshalJSON added in v7.8.0 

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

type ThreatEventGraphListResponseEnvelopeResultInfo added in v7.8.0 

type ThreatEventGraphListResponseEnvelopeResultInfo struct {
	// Number of nodes in result.nodes (seeds + neighbors)
	Count float64 `json:"count" api:"required"`
	// Number of edges in result.edges
	EdgeCount float64 `json:"edge_count" api:"required"`
	// Total query time in milliseconds
	QueryTimeMs float64 `json:"query_time_ms" api:"required"`
	// Total count of nodes (same as count for this endpoint)
	TotalCount float64 `json:"total_count" api:"required"`
	// Opaque pagination cursor for the next page; null when exhausted or for
	// multi-seed requests (single-seed only)
	Cursor string `json:"cursor" api:"nullable"`
	// Traversal depth reached (always 1 for single-level)
	DepthReached float64 `json:"depth_reached"`
	// True when a cursor is available for the next page (single-seed only)
	HasMore bool `json:"has_more"`
	// Composite ids of the seed node(s) (type:uuid). Always an array, even for one
	// seed.
	Seeds []string `json:"seeds"`
	// True when results were capped (per-seed limit or max_nodes)
	Truncated bool                                               `json:"truncated"`
	JSON      threatEventGraphListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*ThreatEventGraphListResponseEnvelopeResultInfo) UnmarshalJSON added in v7.8.0 

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

type ThreatEventGraphService added in v7.8.0 

type ThreatEventGraphService struct {
	Options []option.RequestOption
}

ThreatEventGraphService 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 NewThreatEventGraphService method instead.

func NewThreatEventGraphService added in v7.8.0 

func NewThreatEventGraphService(opts ...option.RequestOption) (r *ThreatEventGraphService)

NewThreatEventGraphService 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 (*ThreatEventGraphService) List added in v7.8.0 

func (r *ThreatEventGraphService) List(ctx context.Context, params ThreatEventGraphListParams, opts ...option.RequestOption) (res *ThreatEventGraphListResponse, err error)

Expands the single-level relationship neighborhood of one or more seed nodes (event, indicator, or tag) from R2 Data Catalog. Seeds use compact id format (type:uuid), e.g. "event:550e8400-...". Multi-seed requests merge and deduplicate results server-side. Hydrates neighbor entities with summary data from Durable Objects. Supports filtering by relationship type and dataset scope.

type ThreatEventGraphqlNewParams added in v7.8.0 

type ThreatEventGraphqlNewParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventGraphqlNewResponse added in v7.8.0 

type ThreatEventGraphqlNewResponse struct {
	Data   interface{}                       `json:"data" api:"nullable"`
	Errors []interface{}                     `json:"errors" api:"nullable"`
	JSON   threatEventGraphqlNewResponseJSON `json:"-"`
}

func (*ThreatEventGraphqlNewResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventGraphqlService added in v7.8.0 

type ThreatEventGraphqlService struct {
	Options []option.RequestOption
}

ThreatEventGraphqlService 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 NewThreatEventGraphqlService method instead.

func NewThreatEventGraphqlService added in v7.8.0 

func NewThreatEventGraphqlService(opts ...option.RequestOption) (r *ThreatEventGraphqlService)

NewThreatEventGraphqlService 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 (*ThreatEventGraphqlService) New added in v7.8.0 

func (r *ThreatEventGraphqlService) New(ctx context.Context, body ThreatEventGraphqlNewParams, opts ...option.RequestOption) (res *ThreatEventGraphqlNewResponse, err error)

Execute GraphQL aggregations over threat events. Supports multi-dimensional group-bys, optional date range filtering, and multi-dataset aggregation.

type ThreatEventIndicatorAggregateListParams added in v7.8.0 

type ThreatEventIndicatorAggregateListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Column(s) to aggregate by - single column or comma-separated list (e.g.,
	// 'indicatorType', 'value', 'indicatorType,value')
	AggregateBy param.Field[string] `query:"aggregateBy" api:"required"`
	// Filter indicators created after this date/datetime (ISO 8601, e.g., '2024-01-01'
	// or '2024-01-01T00:00:00Z')
	CreatedAfter param.Field[ThreatEventIndicatorAggregateListParamsCreatedAfterUnion] `query:"createdAfter" format:"date-time"`
	// Filter indicators created before this date/datetime (ISO 8601, e.g.,
	// '2024-12-31' or '2024-12-31T23:59:59Z')
	CreatedBefore param.Field[ThreatEventIndicatorAggregateListParamsCreatedBeforeUnion] `query:"createdBefore" format:"date-time"`
	// Dataset UUIDs to filter by, or one standalone scope value: 'operational' for
	// readable intelligence datasets (isAnalytics=false), 'analytics' for readable
	// analytics datasets (isAnalytics=true), or 'all'/'\*' for every readable dataset
	// including analytics datasets. If not provided, aggregates across all accessible
	// datasets, including analytics datasets.
	DatasetIDs param.Field[[]string] `query:"datasetIds"`
	// For measure=relationships: only count indicator→event links whose relationship
	// was created/observed on or after this date (ISO 8601). Bounds the activity view
	// to recently-observed links. Note: this filters by the relationship's createdAt
	// (link-observation time), not the underlying event's business date.
	EventDateAfter param.Field[string] `query:"eventDateAfter"`
	// For measure=relationships: only count indicator→event links whose relationship
	// was created/observed on or before this date (ISO 8601). Bounds the activity view
	// by the relationship's createdAt (link-observation time), not the underlying
	// event's business date.
	EventDateBefore param.Field[string] `query:"eventDateBefore"`
	// Maximum number of aggregation results to return (1-100)
	Limit param.Field[float64] `query:"limit"`
	// What to count per group: 'indicators' (catalog rows, default) or 'relationships'
	// (linked events per indicator). Use 'relationships' for 'top indicator by event
	// activity'.
	Measure param.Field[ThreatEventIndicatorAggregateListParamsMeasure] `query:"measure"`
	// Scope to indicators associated with this tag/actor UUID. Combine with
	// measure=relationships for 'top indicator for an actor'.
	TagUUID param.Field[string] `query:"tagUuid"`
}

func (ThreatEventIndicatorAggregateListParams) URLQuery added in v7.8.0 

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

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

type ThreatEventIndicatorAggregateListParamsCreatedAfterUnion added in v7.9.0 

type ThreatEventIndicatorAggregateListParamsCreatedAfterUnion interface {
	ImplementsThreatEventIndicatorAggregateListParamsCreatedAfterUnion()
}

Filter indicators created after this date/datetime (ISO 8601, e.g., '2024-01-01' or '2024-01-01T00:00:00Z')

Satisfied by shared.UnionTime, shared.UnionString.

type ThreatEventIndicatorAggregateListParamsCreatedBeforeUnion added in v7.9.0 

type ThreatEventIndicatorAggregateListParamsCreatedBeforeUnion interface {
	ImplementsThreatEventIndicatorAggregateListParamsCreatedBeforeUnion()
}

Filter indicators created before this date/datetime (ISO 8601, e.g., '2024-12-31' or '2024-12-31T23:59:59Z')

Satisfied by shared.UnionTime, shared.UnionString.

type ThreatEventIndicatorAggregateListParamsMeasure added in v7.8.0 

type ThreatEventIndicatorAggregateListParamsMeasure string

What to count per group: 'indicators' (catalog rows, default) or 'relationships' (linked events per indicator). Use 'relationships' for 'top indicator by event activity'. 

const (
	ThreatEventIndicatorAggregateListParamsMeasureIndicators    ThreatEventIndicatorAggregateListParamsMeasure = "indicators"
	ThreatEventIndicatorAggregateListParamsMeasureRelationships ThreatEventIndicatorAggregateListParamsMeasure = "relationships"
)

func (ThreatEventIndicatorAggregateListParamsMeasure) IsKnown added in v7.8.0 

func (r ThreatEventIndicatorAggregateListParamsMeasure) IsKnown() bool

type ThreatEventIndicatorAggregateListResponse added in v7.8.0 

type ThreatEventIndicatorAggregateListResponse struct {
	// Column(s) that were aggregated by
	AggregateBy string `json:"aggregateBy" api:"required"`
	// Array of aggregation results with dynamic fields based on aggregateBy columns
	Aggregations []ThreatEventIndicatorAggregateListResponseAggregation `json:"aggregations" api:"required"`
	// Number of datasets whose aggregation failed and were excluded from the result
	FailedDatasets float64 `json:"failedDatasets" api:"required"`
	// Total count in the aggregation: indicator rows when measure=indicators, or
	// linked-event rows when measure=relationships
	Total float64                                       `json:"total" api:"required"`
	JSON  threatEventIndicatorAggregateListResponseJSON `json:"-"`
}

func (*ThreatEventIndicatorAggregateListResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorAggregateListResponseAggregation added in v7.8.0 

type ThreatEventIndicatorAggregateListResponseAggregation struct {
	// Number of indicators for this aggregation
	Count       float64                                                  `json:"count" api:"required"`
	ExtraFields map[string]string                                        `json:"-" api:"extrafields"`
	JSON        threatEventIndicatorAggregateListResponseAggregationJSON `json:"-"`
}

func (*ThreatEventIndicatorAggregateListResponseAggregation) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorAggregateService added in v7.8.0 

type ThreatEventIndicatorAggregateService struct {
	Options []option.RequestOption
}

ThreatEventIndicatorAggregateService 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 NewThreatEventIndicatorAggregateService method instead.

func NewThreatEventIndicatorAggregateService added in v7.8.0 

func NewThreatEventIndicatorAggregateService(opts ...option.RequestOption) (r *ThreatEventIndicatorAggregateService)

NewThreatEventIndicatorAggregateService 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 (*ThreatEventIndicatorAggregateService) List added in v7.8.0 

func (r *ThreatEventIndicatorAggregateService) List(ctx context.Context, params ThreatEventIndicatorAggregateListParams, opts ...option.RequestOption) (res *ThreatEventIndicatorAggregateListResponse, err error)

Aggregate threat indicators by one or more columns (e.g., indicatorType, value) across datasets. Returns top-N groups ordered by count.

type ThreatEventIndicatorByDatasetGetParams added in v7.8.0 

type ThreatEventIndicatorByDatasetGetParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventIndicatorByDatasetGetResponse added in v7.8.0 

type ThreatEventIndicatorByDatasetGetResponse struct {
	CreatedAt     time.Time `json:"createdAt" api:"required" format:"date-time"`
	IndicatorType string    `json:"indicatorType" api:"required"`
	UpdatedAt     time.Time `json:"updatedAt" api:"required" format:"date-time"`
	UUID          string    `json:"uuid" api:"required"`
	Value         string    `json:"value" api:"required"`
	// The dataset ID this indicator belongs to. Included in list responses.
	DatasetID string `json:"datasetId"`
	// Related events, capped by `relatedEventsLimit` (default 2). Check
	// `relatedEventsHasMore` to detect a capped list; pass `relatedEventsLimit=-1` to
	// retrieve all of them.
	RelatedEvents []ThreatEventIndicatorByDatasetGetResponseRelatedEvent `json:"relatedEvents"`
	// True when this indicator appears in more events than `relatedEvents` contains
	// because `relatedEventsLimit` capped the list. Pass `relatedEventsLimit=-1` to
	// retrieve every related event.
	RelatedEventsHasMore bool                                          `json:"relatedEventsHasMore"`
	Tags                 []ThreatEventIndicatorByDatasetGetResponseTag `json:"tags"`
	// Traffic Light Protocol designation. UPPERCASE. Possible values: CLEAR, GREEN,
	// AMBER, AMBER-STRICT, RED, PURPLE. Null when not set.
	TLP  string                                       `json:"tlp" api:"nullable"`
	JSON threatEventIndicatorByDatasetGetResponseJSON `json:"-"`
}

func (*ThreatEventIndicatorByDatasetGetResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorByDatasetGetResponseRelatedEvent added in v7.8.0 

type ThreatEventIndicatorByDatasetGetResponseRelatedEvent struct {
	DatasetID string `json:"datasetId" api:"required"`
	EventID   string `json:"eventId" api:"required"`
	// ISO 8601 date of the related event. Null for legacy relationships created before
	// event-date tracking was added.
	EventDate string                                                   `json:"eventDate" api:"nullable"`
	JSON      threatEventIndicatorByDatasetGetResponseRelatedEventJSON `json:"-"`
}

func (*ThreatEventIndicatorByDatasetGetResponseRelatedEvent) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorByDatasetGetResponseTag added in v7.8.0 

type ThreatEventIndicatorByDatasetGetResponseTag struct {
	// The UUID of the tag category, or null when the tag is uncategorized.
	CategoryID   string                                          `json:"categoryId" api:"nullable"`
	CategoryName string                                          `json:"categoryName"`
	UUID         string                                          `json:"uuid"`
	Value        string                                          `json:"value"`
	JSON         threatEventIndicatorByDatasetGetResponseTagJSON `json:"-"`
}

func (*ThreatEventIndicatorByDatasetGetResponseTag) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorByDatasetListParams added in v7.8.0 

type ThreatEventIndicatorByDatasetListParams struct {
	// Account ID.
	AccountID     param.Field[string] `path:"account_id" api:"required"`
	IndicatorType param.Field[string] `query:"indicatorType"`
	// Filter by indicator value (substring match)
	Name     param.Field[string]  `query:"name"`
	Page     param.Field[float64] `query:"page"`
	PageSize param.Field[float64] `query:"pageSize"`
	// Filter indicators by related event UUID(s). Multiple UUIDs can be provided by
	// repeating the parameter.
	RelatedEvent param.Field[[]string] `query:"relatedEvent"`
}

func (ThreatEventIndicatorByDatasetListParams) URLQuery added in v7.8.0 

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

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

type ThreatEventIndicatorByDatasetListResponse added in v7.8.0 

type ThreatEventIndicatorByDatasetListResponse struct {
	Indicators []ThreatEventIndicatorByDatasetListResponseIndicator `json:"indicators" api:"required"`
	Pagination ThreatEventIndicatorByDatasetListResponsePagination  `json:"pagination" api:"required"`
	JSON       threatEventIndicatorByDatasetListResponseJSON        `json:"-"`
}

func (*ThreatEventIndicatorByDatasetListResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorByDatasetListResponseIndicator added in v7.8.0 

type ThreatEventIndicatorByDatasetListResponseIndicator struct {
	CreatedAt     time.Time `json:"createdAt" api:"required" format:"date-time"`
	IndicatorType string    `json:"indicatorType" api:"required"`
	// RSS article sources from which this indicator was extracted.
	Sources   []ThreatEventIndicatorByDatasetListResponseIndicatorsSource `json:"sources" api:"required"`
	UpdatedAt time.Time                                                   `json:"updatedAt" api:"required" format:"date-time"`
	UUID      string                                                      `json:"uuid" api:"required"`
	Value     string                                                      `json:"value" api:"required"`
	// The dataset ID this indicator belongs to. Included in list responses.
	DatasetID string `json:"datasetId"`
	// Related events, capped by `relatedEventsLimit` (default 2). Check
	// `relatedEventsHasMore` to detect a capped list; pass `relatedEventsLimit=-1` to
	// retrieve all of them.
	RelatedEvents []ThreatEventIndicatorByDatasetListResponseIndicatorsRelatedEvent `json:"relatedEvents"`
	// True when this indicator appears in more events than `relatedEvents` contains
	// because `relatedEventsLimit` capped the list. Pass `relatedEventsLimit=-1` to
	// retrieve every related event.
	RelatedEventsHasMore bool                                                     `json:"relatedEventsHasMore"`
	Tags                 []ThreatEventIndicatorByDatasetListResponseIndicatorsTag `json:"tags"`
	// Traffic Light Protocol designation. UPPERCASE. Possible values: CLEAR, GREEN,
	// AMBER, AMBER-STRICT, RED, PURPLE. Null when not set.
	TLP  string                                                 `json:"tlp" api:"nullable"`
	JSON threatEventIndicatorByDatasetListResponseIndicatorJSON `json:"-"`
}

func (*ThreatEventIndicatorByDatasetListResponseIndicator) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorByDatasetListResponseIndicatorsRelatedEvent added in v7.8.0 

type ThreatEventIndicatorByDatasetListResponseIndicatorsRelatedEvent struct {
	DatasetID string `json:"datasetId" api:"required"`
	EventID   string `json:"eventId" api:"required"`
	// ISO 8601 date of the related event. Null for legacy relationships created before
	// event-date tracking was added.
	EventDate string                                                              `json:"eventDate" api:"nullable"`
	JSON      threatEventIndicatorByDatasetListResponseIndicatorsRelatedEventJSON `json:"-"`
}

func (*ThreatEventIndicatorByDatasetListResponseIndicatorsRelatedEvent) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorByDatasetListResponseIndicatorsSource added in v7.10.0 

type ThreatEventIndicatorByDatasetListResponseIndicatorsSource struct {
	ResourceID   string                                                                 `json:"resourceId" api:"required" format:"uuid"`
	ResourceType ThreatEventIndicatorByDatasetListResponseIndicatorsSourcesResourceType `json:"resourceType" api:"required"`
	System       ThreatEventIndicatorByDatasetListResponseIndicatorsSourcesSystem       `json:"system" api:"required"`
	// Threat Signals article title; null for historical provenance without a stored
	// title.
	Title string                                                        `json:"title" api:"required,nullable"`
	JSON  threatEventIndicatorByDatasetListResponseIndicatorsSourceJSON `json:"-"`
}

func (*ThreatEventIndicatorByDatasetListResponseIndicatorsSource) UnmarshalJSON added in v7.10.0 

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

type ThreatEventIndicatorByDatasetListResponseIndicatorsSourcesResourceType added in v7.10.0 

type ThreatEventIndicatorByDatasetListResponseIndicatorsSourcesResourceType string
const (
	ThreatEventIndicatorByDatasetListResponseIndicatorsSourcesResourceTypeArticle ThreatEventIndicatorByDatasetListResponseIndicatorsSourcesResourceType = "article"
)

func (ThreatEventIndicatorByDatasetListResponseIndicatorsSourcesResourceType) IsKnown added in v7.10.0 

func (r ThreatEventIndicatorByDatasetListResponseIndicatorsSourcesResourceType) IsKnown() bool

type ThreatEventIndicatorByDatasetListResponseIndicatorsSourcesSystem added in v7.10.0 

type ThreatEventIndicatorByDatasetListResponseIndicatorsSourcesSystem string
const (
	ThreatEventIndicatorByDatasetListResponseIndicatorsSourcesSystemThreatSignals ThreatEventIndicatorByDatasetListResponseIndicatorsSourcesSystem = "threat-signals"
)

func (ThreatEventIndicatorByDatasetListResponseIndicatorsSourcesSystem) IsKnown added in v7.10.0 

func (r ThreatEventIndicatorByDatasetListResponseIndicatorsSourcesSystem) IsKnown() bool

type ThreatEventIndicatorByDatasetListResponseIndicatorsTag added in v7.8.0 

type ThreatEventIndicatorByDatasetListResponseIndicatorsTag struct {
	// The UUID of the tag category, or null when the tag is uncategorized.
	CategoryID   string                                                     `json:"categoryId" api:"nullable"`
	CategoryName string                                                     `json:"categoryName"`
	UUID         string                                                     `json:"uuid"`
	Value        string                                                     `json:"value"`
	JSON         threatEventIndicatorByDatasetListResponseIndicatorsTagJSON `json:"-"`
}

func (*ThreatEventIndicatorByDatasetListResponseIndicatorsTag) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorByDatasetListResponsePagination added in v7.8.0 

type ThreatEventIndicatorByDatasetListResponsePagination struct {
	Page       float64                                                 `json:"page" api:"required"`
	PageSize   float64                                                 `json:"pageSize" api:"required"`
	TotalCount float64                                                 `json:"totalCount" api:"required"`
	TotalPages float64                                                 `json:"totalPages" api:"required"`
	JSON       threatEventIndicatorByDatasetListResponsePaginationJSON `json:"-"`
}

func (*ThreatEventIndicatorByDatasetListResponsePagination) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorByDatasetService added in v7.8.0 

type ThreatEventIndicatorByDatasetService struct {
	Options []option.RequestOption
	Tags    *ThreatEventIndicatorByDatasetTagService
}

ThreatEventIndicatorByDatasetService 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 NewThreatEventIndicatorByDatasetService method instead.

func NewThreatEventIndicatorByDatasetService added in v7.8.0 

func NewThreatEventIndicatorByDatasetService(opts ...option.RequestOption) (r *ThreatEventIndicatorByDatasetService)

NewThreatEventIndicatorByDatasetService 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 (*ThreatEventIndicatorByDatasetService) Get added in v7.8.0 

func (r *ThreatEventIndicatorByDatasetService) Get(ctx context.Context, datasetID string, indicatorID string, query ThreatEventIndicatorByDatasetGetParams, opts ...option.RequestOption) (res *ThreatEventIndicatorByDatasetGetResponse, err error)

Retrieves a specific indicator by its UUID.

func (*ThreatEventIndicatorByDatasetService) List deprecated added in v7.8.0 

func (r *ThreatEventIndicatorByDatasetService) List(ctx context.Context, datasetID string, params ThreatEventIndicatorByDatasetListParams, opts ...option.RequestOption) (res *ThreatEventIndicatorByDatasetListResponse, err error)

This method is deprecated. Please use /events/indicators to retrieve a paginated list of indicators.

Deprecated: Use indicators.list instead (GET /accounts/{account_id}/cloudforce-one/events/indicators).

type ThreatEventIndicatorByDatasetTagListParams added in v7.8.0 

type ThreatEventIndicatorByDatasetTagListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventIndicatorByDatasetTagListResponse added in v7.8.0 

type ThreatEventIndicatorByDatasetTagListResponse = interface{}

type ThreatEventIndicatorByDatasetTagService added in v7.8.0 

type ThreatEventIndicatorByDatasetTagService struct {
	Options []option.RequestOption
}

ThreatEventIndicatorByDatasetTagService 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 NewThreatEventIndicatorByDatasetTagService method instead.

func NewThreatEventIndicatorByDatasetTagService added in v7.8.0 

func NewThreatEventIndicatorByDatasetTagService(opts ...option.RequestOption) (r *ThreatEventIndicatorByDatasetTagService)

NewThreatEventIndicatorByDatasetTagService 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 (*ThreatEventIndicatorByDatasetTagService) List added in v7.8.0 

func (r *ThreatEventIndicatorByDatasetTagService) List(ctx context.Context, datasetID string, query ThreatEventIndicatorByDatasetTagListParams, opts ...option.RequestOption) (res *[]ThreatEventIndicatorByDatasetTagListResponse, err error)

Returns all mirrored tags from the indicator dataset (DO mirror table). No pagination.

type ThreatEventIndicatorListParams added in v7.8.0 

type ThreatEventIndicatorListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Cache strategy. 'from-graph' serves results from the graph-node KV cache when
	// all requested UUIDs are cached; falls back to normal path on partial/zero hit.
	// Cannot be combined with `cursor`.
	Cache param.Field[ThreatEventIndicatorListParamsCache] `query:"cache"`
	// Filter indicators created on or after this date. Must use ISO 8601 format (e.g.,
	// '2024-01-15T00:00:00Z').
	CreatedAfter param.Field[time.Time] `query:"createdAfter" format:"date-time"`
	// Filter indicators created on or before this date. Must use ISO 8601 format
	// (e.g., '2024-12-31T23:59:59Z').
	CreatedBefore param.Field[time.Time] `query:"createdBefore" format:"date-time"`
	// Opaque cursor from a previous response's `pagination.cursor`. When provided, all
	// filters, datasetIds, page, `pageSize`, `includeTags` and `relatedEventsLimit`
	// come from the cursor — do not resend them. Sending any filter, `page`,
	// `pageSize`, `includeTags`, `relatedEventsLimit`, `includeTotalCount=true`, or
	// `cache=from-graph` alongside a cursor yields a 400 `CursorFilterConflictError`.
	// A cursor issued for a different entity, an unsupported version, or a dataset
	// that has since been reconfigured as analytics-only yields a 400
	// `InvalidCursorError`.
	Cursor param.Field[string] `query:"cursor"`
	// Dataset UUIDs to query, or one standalone scope value: 'all'/'\*' or
	// 'operational' for readable intelligence datasets (isAnalytics=false), or
	// 'analytics' for readable analytics datasets (isAnalytics=true). If not provided,
	// uses the default dataset.
	DatasetIDs param.Field[[]string] `query:"datasetIds"`
	// Output format for indicator data. 'json' returns the default format, 'stix2'
	// returns STIX 2.1 Indicator SDOs, 'taxii' returns a TAXII 2.1 Envelope with
	// Content-Type application/taxii+json;version=2.1.
	Format param.Field[ThreatEventIndicatorListParamsFormat] `query:"format"`
	// Whether to include full tag details for each indicator. Defaults to true.
	IncludeTags param.Field[bool] `query:"includeTags"`
	// Whether to compute total count via COUNT(\*). Defaults to false for performance.
	// total_count is null unless this is true and the complete fan-out succeeds.
	IncludeTotalCount param.Field[bool]   `query:"includeTotalCount"`
	IndicatorType     param.Field[string] `query:"indicatorType"`
	// Filter indicators by value using substring match (LIKE). Legacy alternative to
	// structured search.
	Name     param.Field[string]  `query:"name"`
	Page     param.Field[float64] `query:"page"`
	PageSize param.Field[float64] `query:"pageSize"`
	// Filter by related event IDs
	RelatedEvents param.Field[[]string] `query:"relatedEvents"`
	// Limit the number of related events returned per indicator. Default: 2. Set to 0
	// for none, -1 for all events. For JSON responses, when the limit hides events,
	// the indicator carries `relatedEventsHasMore: true` and the response includes an
	// advisory message — the cap is never applied silently. STIX and TAXII
	// representations do not include related-event data.
	RelatedEventsLimit param.Field[float64] `query:"relatedEventsLimit"`
	// Structured search as a JSON array of {field, op, value} objects. Searchable
	// fields: value, indicatorType, uuid. Supports operators: equals, not, contains,
	// startsWith, endsWith, gt, lt, gte, lte, like, in, find. Use the 'in' operator
	// with an array value to bulk-check up to 100 indicators in a single request, e.g.
	// search=[{"field":"value","op":"in","value":["evil.com","bad.org"]}]. Multiple
	// conditions are AND'd together. Max 10 conditions per request.
	Search param.Field[[]ThreatEventIndicatorListParamsSearch] `query:"search"`
	// Filter by tag values or UUIDs. Indicators must have at least one of the
	// specified tags (OR logic). Supports both tag UUID and tag value.
	Tags param.Field[[]string] `query:"tags"`
	// Structured tag-metadata filter as a JSON array of {field, op, value} objects.
	// Operates against the per-dataset IndicatorTag mirror so you can find indicators
	// by tag attributes (origin country, motive, sophistication, priority, etc.)
	// without a separate Tags lookup. Common dashboard usage: drill from a country
	// into indicators, e.g.
	// tagSearch=[{"field":"originCountryISO","op":"in","value":["IR","CN"]}]. Country
	// values may be passed as alpha-2, alpha-3, name, or alias (e.g. "iran").
	// Operators: equals, not, gt/gte/lt/lte (numeric only),
	// contains/like/find/startsWith/endsWith (string only), in. AND-joined across
	// entries; combined with `tags`, a matching tag must satisfy both. Max 10 entries
	// per request, max 100 values per 'in'. Performance notes: `originCountryISO` uses
	// its B-tree index for equals/not/in. `priority` uses its B-tree index for numeric
	// comparisons. Other string columns (`actorCategory`, `motive`, etc.) are
	// case-insensitive and unindexed; current catalog size makes this a non-issue.
	// `endsWith` and `aliasGroupNames` contains/like are leading-wildcard scans and
	// slow on large result sets. `aliasGroupNames` matches on the JSON-encoded text,
	// so substrings can cross alias boundaries ("apt28" also matches "apt280" when
	// both appear in the same tag's alias list).
	TagSearch param.Field[[]ThreatEventIndicatorListParamsTagSearch] `query:"tagSearch"`
}

func (ThreatEventIndicatorListParams) URLQuery added in v7.8.0 

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

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

type ThreatEventIndicatorListParamsCache added in v7.8.0 

type ThreatEventIndicatorListParamsCache string

Cache strategy. 'from-graph' serves results from the graph-node KV cache when all requested UUIDs are cached; falls back to normal path on partial/zero hit. Cannot be combined with `cursor`. 

const (
	ThreatEventIndicatorListParamsCacheFromGraph ThreatEventIndicatorListParamsCache = "from-graph"
)

func (ThreatEventIndicatorListParamsCache) IsKnown added in v7.8.0 

func (r ThreatEventIndicatorListParamsCache) IsKnown() bool

type ThreatEventIndicatorListParamsFormat added in v7.8.0 

type ThreatEventIndicatorListParamsFormat string

Output format for indicator data. 'json' returns the default format, 'stix2' returns STIX 2.1 Indicator SDOs, 'taxii' returns a TAXII 2.1 Envelope with Content-Type application/taxii+json;version=2.1. 

const (
	ThreatEventIndicatorListParamsFormatJson  ThreatEventIndicatorListParamsFormat = "json"
	ThreatEventIndicatorListParamsFormatStix2 ThreatEventIndicatorListParamsFormat = "stix2"
	ThreatEventIndicatorListParamsFormatTaxii ThreatEventIndicatorListParamsFormat = "taxii"
)

func (ThreatEventIndicatorListParamsFormat) IsKnown added in v7.8.0 

func (r ThreatEventIndicatorListParamsFormat) IsKnown() bool

type ThreatEventIndicatorListParamsSearch added in v7.8.0 

type ThreatEventIndicatorListParamsSearch struct {
	// The indicator field to search on. Allowed: value, indicatorType, uuid.
	Field param.Field[ThreatEventIndicatorListParamsSearchField] `query:"field" api:"required"`
	// Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g.
	// {field:'value', op:'in', value:['evil.com','bad.org']}.
	Op param.Field[ThreatEventIndicatorListParamsSearchOp] `query:"op" api:"required"`
	// Search value. String for most operators. Array of strings for 'in' operator (max
	// 100 items).
	Value param.Field[ThreatEventIndicatorListParamsSearchValueUnion] `query:"value" api:"required"`
}

func (ThreatEventIndicatorListParamsSearch) URLQuery added in v7.8.0 

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

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

type ThreatEventIndicatorListParamsSearchField added in v7.8.0 

type ThreatEventIndicatorListParamsSearchField string

The indicator field to search on. Allowed: value, indicatorType, uuid. 

const (
	ThreatEventIndicatorListParamsSearchFieldValue         ThreatEventIndicatorListParamsSearchField = "value"
	ThreatEventIndicatorListParamsSearchFieldIndicatorType ThreatEventIndicatorListParamsSearchField = "indicatorType"
	ThreatEventIndicatorListParamsSearchFieldUUID          ThreatEventIndicatorListParamsSearchField = "uuid"
)

func (ThreatEventIndicatorListParamsSearchField) IsKnown added in v7.8.0 

func (r ThreatEventIndicatorListParamsSearchField) IsKnown() bool

type ThreatEventIndicatorListParamsSearchOp added in v7.8.0 

type ThreatEventIndicatorListParamsSearchOp string

Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g. {field:'value', op:'in', value:['evil.com','bad.org']}. 

const (
	ThreatEventIndicatorListParamsSearchOpEquals     ThreatEventIndicatorListParamsSearchOp = "equals"
	ThreatEventIndicatorListParamsSearchOpNot        ThreatEventIndicatorListParamsSearchOp = "not"
	ThreatEventIndicatorListParamsSearchOpGt         ThreatEventIndicatorListParamsSearchOp = "gt"
	ThreatEventIndicatorListParamsSearchOpGte        ThreatEventIndicatorListParamsSearchOp = "gte"
	ThreatEventIndicatorListParamsSearchOpLt         ThreatEventIndicatorListParamsSearchOp = "lt"
	ThreatEventIndicatorListParamsSearchOpLte        ThreatEventIndicatorListParamsSearchOp = "lte"
	ThreatEventIndicatorListParamsSearchOpLike       ThreatEventIndicatorListParamsSearchOp = "like"
	ThreatEventIndicatorListParamsSearchOpContains   ThreatEventIndicatorListParamsSearchOp = "contains"
	ThreatEventIndicatorListParamsSearchOpStartsWith ThreatEventIndicatorListParamsSearchOp = "startsWith"
	ThreatEventIndicatorListParamsSearchOpEndsWith   ThreatEventIndicatorListParamsSearchOp = "endsWith"
	ThreatEventIndicatorListParamsSearchOpIn         ThreatEventIndicatorListParamsSearchOp = "in"
	ThreatEventIndicatorListParamsSearchOpFind       ThreatEventIndicatorListParamsSearchOp = "find"
)

func (ThreatEventIndicatorListParamsSearchOp) IsKnown added in v7.8.0 

func (r ThreatEventIndicatorListParamsSearchOp) IsKnown() bool

type ThreatEventIndicatorListParamsSearchValueArray added in v7.8.0 

type ThreatEventIndicatorListParamsSearchValueArray []string

func (ThreatEventIndicatorListParamsSearchValueArray) ImplementsThreatEventIndicatorListParamsSearchValueUnion added in v7.8.0 

func (r ThreatEventIndicatorListParamsSearchValueArray) ImplementsThreatEventIndicatorListParamsSearchValueUnion()

type ThreatEventIndicatorListParamsSearchValueUnion added in v7.8.0 

type ThreatEventIndicatorListParamsSearchValueUnion interface {
	ImplementsThreatEventIndicatorListParamsSearchValueUnion()
}

Search value. String for most operators. Array of strings for 'in' operator (max 100 items).

Satisfied by shared.UnionString, cloudforce_one.ThreatEventIndicatorListParamsSearchValueArray.

type ThreatEventIndicatorListParamsTagSearch added in v7.8.0 

type ThreatEventIndicatorListParamsTagSearch struct {
	// Tag mirror field to filter on. Allowed: value, categoryId, actorCategory,
	// aliasGroupNames, attributionConfidence, attributionOrganization, motive,
	// opsecLevel, originCountryISO, sophisticationLevel, priority, analyticPriority.
	// Filters operate against the per-dataset IndicatorTag mirror (which is kept in
	// sync with the Tags SoT by the tag-propagation workflow).
	Field param.Field[ThreatEventIndicatorListParamsTagSearchField] `query:"field" api:"required"`
	// Search operator. Use 'in' for bulk OR within a single field, e.g.
	// {field:"originCountryISO", op:"in", value:["IR","CN"]}.
	Op param.Field[ThreatEventIndicatorListParamsTagSearchOp] `query:"op" api:"required"`
	// Search value. String or number for most operators. Array for 'in' (max 100
	// items). Country values may be passed as alpha-2, alpha-3, name, or common alias
	// (e.g. "iran", "IR", "IRN") and are normalized to alpha-2 server-side.
	Value param.Field[ThreatEventIndicatorListParamsTagSearchValueUnion] `query:"value"`
}

func (ThreatEventIndicatorListParamsTagSearch) URLQuery added in v7.8.0 

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

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

type ThreatEventIndicatorListParamsTagSearchField added in v7.8.0 

type ThreatEventIndicatorListParamsTagSearchField string

Tag mirror field to filter on. Allowed: value, categoryId, actorCategory, aliasGroupNames, attributionConfidence, attributionOrganization, motive, opsecLevel, originCountryISO, sophisticationLevel, priority, analyticPriority. Filters operate against the per-dataset IndicatorTag mirror (which is kept in sync with the Tags SoT by the tag-propagation workflow). 

const (
	ThreatEventIndicatorListParamsTagSearchFieldValue                   ThreatEventIndicatorListParamsTagSearchField = "value"
	ThreatEventIndicatorListParamsTagSearchFieldCategoryID              ThreatEventIndicatorListParamsTagSearchField = "categoryId"
	ThreatEventIndicatorListParamsTagSearchFieldActorCategory           ThreatEventIndicatorListParamsTagSearchField = "actorCategory"
	ThreatEventIndicatorListParamsTagSearchFieldAliasGroupNames         ThreatEventIndicatorListParamsTagSearchField = "aliasGroupNames"
	ThreatEventIndicatorListParamsTagSearchFieldAttributionConfidence   ThreatEventIndicatorListParamsTagSearchField = "attributionConfidence"
	ThreatEventIndicatorListParamsTagSearchFieldAttributionOrganization ThreatEventIndicatorListParamsTagSearchField = "attributionOrganization"
	ThreatEventIndicatorListParamsTagSearchFieldMotive                  ThreatEventIndicatorListParamsTagSearchField = "motive"
	ThreatEventIndicatorListParamsTagSearchFieldOpsecLevel              ThreatEventIndicatorListParamsTagSearchField = "opsecLevel"
	ThreatEventIndicatorListParamsTagSearchFieldOriginCountryISO        ThreatEventIndicatorListParamsTagSearchField = "originCountryISO"
	ThreatEventIndicatorListParamsTagSearchFieldSophisticationLevel     ThreatEventIndicatorListParamsTagSearchField = "sophisticationLevel"
	ThreatEventIndicatorListParamsTagSearchFieldPriority                ThreatEventIndicatorListParamsTagSearchField = "priority"
	ThreatEventIndicatorListParamsTagSearchFieldAnalyticPriority        ThreatEventIndicatorListParamsTagSearchField = "analyticPriority"
)

func (ThreatEventIndicatorListParamsTagSearchField) IsKnown added in v7.8.0 

func (r ThreatEventIndicatorListParamsTagSearchField) IsKnown() bool

type ThreatEventIndicatorListParamsTagSearchOp added in v7.8.0 

type ThreatEventIndicatorListParamsTagSearchOp string

Search operator. Use 'in' for bulk OR within a single field, e.g. {field:"originCountryISO", op:"in", value:["IR","CN"]}. 

const (
	ThreatEventIndicatorListParamsTagSearchOpEquals     ThreatEventIndicatorListParamsTagSearchOp = "equals"
	ThreatEventIndicatorListParamsTagSearchOpNot        ThreatEventIndicatorListParamsTagSearchOp = "not"
	ThreatEventIndicatorListParamsTagSearchOpGt         ThreatEventIndicatorListParamsTagSearchOp = "gt"
	ThreatEventIndicatorListParamsTagSearchOpGte        ThreatEventIndicatorListParamsTagSearchOp = "gte"
	ThreatEventIndicatorListParamsTagSearchOpLt         ThreatEventIndicatorListParamsTagSearchOp = "lt"
	ThreatEventIndicatorListParamsTagSearchOpLte        ThreatEventIndicatorListParamsTagSearchOp = "lte"
	ThreatEventIndicatorListParamsTagSearchOpLike       ThreatEventIndicatorListParamsTagSearchOp = "like"
	ThreatEventIndicatorListParamsTagSearchOpContains   ThreatEventIndicatorListParamsTagSearchOp = "contains"
	ThreatEventIndicatorListParamsTagSearchOpStartsWith ThreatEventIndicatorListParamsTagSearchOp = "startsWith"
	ThreatEventIndicatorListParamsTagSearchOpEndsWith   ThreatEventIndicatorListParamsTagSearchOp = "endsWith"
	ThreatEventIndicatorListParamsTagSearchOpIn         ThreatEventIndicatorListParamsTagSearchOp = "in"
	ThreatEventIndicatorListParamsTagSearchOpFind       ThreatEventIndicatorListParamsTagSearchOp = "find"
)

func (ThreatEventIndicatorListParamsTagSearchOp) IsKnown added in v7.8.0 

func (r ThreatEventIndicatorListParamsTagSearchOp) IsKnown() bool

type ThreatEventIndicatorListParamsTagSearchValueArray added in v7.8.0 

type ThreatEventIndicatorListParamsTagSearchValueArray []ThreatEventIndicatorListParamsTagSearchValueArrayItemUnion

func (ThreatEventIndicatorListParamsTagSearchValueArray) ImplementsThreatEventIndicatorListParamsTagSearchValueUnion added in v7.8.0 

func (r ThreatEventIndicatorListParamsTagSearchValueArray) ImplementsThreatEventIndicatorListParamsTagSearchValueUnion()

type ThreatEventIndicatorListParamsTagSearchValueArrayItemUnion added in v7.8.0 

type ThreatEventIndicatorListParamsTagSearchValueArrayItemUnion interface {
	ImplementsThreatEventIndicatorListParamsTagSearchValueArrayItemUnion()
}

Satisfied by shared.UnionString, shared.UnionFloat.

type ThreatEventIndicatorListParamsTagSearchValueUnion added in v7.8.0 

type ThreatEventIndicatorListParamsTagSearchValueUnion interface {
	ImplementsThreatEventIndicatorListParamsTagSearchValueUnion()
}

Search value. String or number for most operators. Array for 'in' (max 100 items). Country values may be passed as alpha-2, alpha-3, name, or common alias (e.g. "iran", "IR", "IRN") and are normalized to alpha-2 server-side.

Satisfied by shared.UnionString, shared.UnionFloat, cloudforce_one.ThreatEventIndicatorListParamsTagSearchValueArray.

type ThreatEventIndicatorListResponse added in v7.8.0 

type ThreatEventIndicatorListResponse struct {
	Properties ThreatEventIndicatorListResponseProperties `json:"properties" api:"required"`
	Type       string                                     `json:"type" api:"required"`
	JSON       threatEventIndicatorListResponseJSON       `json:"-"`
}

func (*ThreatEventIndicatorListResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorListResponseProperties added in v7.8.0 

type ThreatEventIndicatorListResponseProperties struct {
	Completeness ThreatEventIndicatorListResponsePropertiesCompleteness `json:"completeness" api:"required"`
	Indicators   ThreatEventIndicatorListResponsePropertiesIndicators   `json:"indicators" api:"required"`
	Pagination   ThreatEventIndicatorListResponsePropertiesPagination   `json:"pagination" api:"required"`
	JSON         threatEventIndicatorListResponsePropertiesJSON         `json:"-"`
}

func (*ThreatEventIndicatorListResponseProperties) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorListResponsePropertiesCompleteness added in v7.9.0 

type ThreatEventIndicatorListResponsePropertiesCompleteness struct {
	Properties ThreatEventIndicatorListResponsePropertiesCompletenessProperties `json:"properties" api:"required"`
	Type       string                                                           `json:"type" api:"required"`
	JSON       threatEventIndicatorListResponsePropertiesCompletenessJSON       `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesCompleteness) UnmarshalJSON added in v7.9.0 

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

type ThreatEventIndicatorListResponsePropertiesCompletenessProperties added in v7.9.0 

type ThreatEventIndicatorListResponsePropertiesCompletenessProperties struct {
	Complete       ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesComplete       `json:"complete" api:"required"`
	FailedDatasets ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasets `json:"failedDatasets" api:"required"`
	FailedShards   ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShards   `json:"failedShards" api:"required"`
	Warnings       ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarnings       `json:"warnings" api:"required"`
	JSON           threatEventIndicatorListResponsePropertiesCompletenessPropertiesJSON           `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesCompletenessProperties) UnmarshalJSON added in v7.9.0 

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

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesComplete added in v7.9.0 

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesComplete struct {
	Type string                                                                       `json:"type" api:"required"`
	JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesCompleteJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesComplete) UnmarshalJSON added in v7.9.0 

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

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasets added in v7.9.0 

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasets struct {
	Items ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasetsItems `json:"items" api:"required"`
	Type  string                                                                              `json:"type" api:"required"`
	JSON  threatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasetsJSON  `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasets) UnmarshalJSON added in v7.9.0 

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

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasetsItems added in v7.9.0 

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasetsItems struct {
	Type string                                                                                  `json:"type" api:"required"`
	JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasetsItemsJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedDatasetsItems) UnmarshalJSON added in v7.9.0 

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

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShards added in v7.9.0 

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShards struct {
	Items ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItems `json:"items" api:"required"`
	Type  string                                                                            `json:"type" api:"required"`
	JSON  threatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsJSON  `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShards) UnmarshalJSON added in v7.9.0 

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

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItems added in v7.9.0 

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItems struct {
	Properties ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsProperties `json:"properties" api:"required"`
	Type       string                                                                                      `json:"type" api:"required"`
	JSON       threatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsJSON       `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItems) UnmarshalJSON added in v7.9.0 

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

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsProperties added in v7.9.0 

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsProperties struct {
	DatasetID ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesDatasetID `json:"datasetId" api:"required"`
	ShardID   ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesShardID   `json:"shardId" api:"required"`
	JSON      threatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesJSON      `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsProperties) UnmarshalJSON added in v7.9.0 

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

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesDatasetID added in v7.9.0 

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesDatasetID struct {
	Type string                                                                                                   `json:"type" api:"required"`
	JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesDatasetIDJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesDatasetID) UnmarshalJSON added in v7.9.0 

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

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesShardID added in v7.9.0 

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesShardID struct {
	Type string                                                                                                 `json:"type" api:"required"`
	JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesShardIDJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesFailedShardsItemsPropertiesShardID) UnmarshalJSON added in v7.9.0 

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

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarnings added in v7.9.0 

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarnings struct {
	Items ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarningsItems `json:"items" api:"required"`
	Type  string                                                                        `json:"type" api:"required"`
	JSON  threatEventIndicatorListResponsePropertiesCompletenessPropertiesWarningsJSON  `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarnings) UnmarshalJSON added in v7.9.0 

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

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarningsItems added in v7.9.0 

type ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarningsItems struct {
	Type string                                                                            `json:"type" api:"required"`
	JSON threatEventIndicatorListResponsePropertiesCompletenessPropertiesWarningsItemsJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesCompletenessPropertiesWarningsItems) UnmarshalJSON added in v7.9.0 

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

type ThreatEventIndicatorListResponsePropertiesIndicators added in v7.8.0 

type ThreatEventIndicatorListResponsePropertiesIndicators struct {
	Items ThreatEventIndicatorListResponsePropertiesIndicatorsItems `json:"items" api:"required"`
	Type  string                                                    `json:"type" api:"required"`
	JSON  threatEventIndicatorListResponsePropertiesIndicatorsJSON  `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesIndicators) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorListResponsePropertiesIndicatorsItems added in v7.8.0 

type ThreatEventIndicatorListResponsePropertiesIndicatorsItems struct {
	CreatedAt     time.Time `json:"createdAt" api:"required" format:"date-time"`
	IndicatorType string    `json:"indicatorType" api:"required"`
	// RSS article sources from which this indicator was extracted.
	Sources   []ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSource `json:"sources" api:"required"`
	UpdatedAt time.Time                                                         `json:"updatedAt" api:"required" format:"date-time"`
	UUID      string                                                            `json:"uuid" api:"required"`
	Value     string                                                            `json:"value" api:"required"`
	// The dataset ID this indicator belongs to. Included in list responses.
	DatasetID string `json:"datasetId"`
	// Related events, capped by `relatedEventsLimit` (default 2). Check
	// `relatedEventsHasMore` to detect a capped list; pass `relatedEventsLimit=-1` to
	// retrieve all of them.
	RelatedEvents []ThreatEventIndicatorListResponsePropertiesIndicatorsItemsRelatedEvent `json:"relatedEvents"`
	// True when this indicator appears in more events than `relatedEvents` contains
	// because `relatedEventsLimit` capped the list. Pass `relatedEventsLimit=-1` to
	// retrieve every related event.
	RelatedEventsHasMore bool                                                           `json:"relatedEventsHasMore"`
	Tags                 []ThreatEventIndicatorListResponsePropertiesIndicatorsItemsTag `json:"tags"`
	// Traffic Light Protocol designation. UPPERCASE. Possible values: CLEAR, GREEN,
	// AMBER, AMBER-STRICT, RED, PURPLE. Null when not set.
	TLP  string                                                        `json:"tlp" api:"nullable"`
	JSON threatEventIndicatorListResponsePropertiesIndicatorsItemsJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesIndicatorsItems) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsRelatedEvent added in v7.8.0 

type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsRelatedEvent struct {
	DatasetID string `json:"datasetId" api:"required"`
	EventID   string `json:"eventId" api:"required"`
	// ISO 8601 date of the related event. Null for legacy relationships created before
	// event-date tracking was added.
	EventDate string                                                                    `json:"eventDate" api:"nullable"`
	JSON      threatEventIndicatorListResponsePropertiesIndicatorsItemsRelatedEventJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesIndicatorsItemsRelatedEvent) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSource added in v7.10.0 

type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSource struct {
	ResourceID   string                                                                       `json:"resourceId" api:"required" format:"uuid"`
	ResourceType ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSourcesResourceType `json:"resourceType" api:"required"`
	System       ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSourcesSystem       `json:"system" api:"required"`
	// Threat Signals article title; null for historical provenance without a stored
	// title.
	Title string                                                              `json:"title" api:"required,nullable"`
	JSON  threatEventIndicatorListResponsePropertiesIndicatorsItemsSourceJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSource) UnmarshalJSON added in v7.10.0 

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

type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSourcesResourceType added in v7.10.0 

type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSourcesResourceType string
const (
	ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSourcesResourceTypeArticle ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSourcesResourceType = "article"
)

func (ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSourcesResourceType) IsKnown added in v7.10.0 

func (r ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSourcesResourceType) IsKnown() bool

type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSourcesSystem added in v7.10.0 

type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSourcesSystem string
const (
	ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSourcesSystemThreatSignals ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSourcesSystem = "threat-signals"
)

func (ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSourcesSystem) IsKnown added in v7.10.0 

func (r ThreatEventIndicatorListResponsePropertiesIndicatorsItemsSourcesSystem) IsKnown() bool

type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsTag added in v7.8.0 

type ThreatEventIndicatorListResponsePropertiesIndicatorsItemsTag struct {
	// The UUID of the tag category, or null when the tag is uncategorized.
	CategoryID   string                                                           `json:"categoryId" api:"nullable"`
	CategoryName string                                                           `json:"categoryName"`
	UUID         string                                                           `json:"uuid"`
	Value        string                                                           `json:"value"`
	JSON         threatEventIndicatorListResponsePropertiesIndicatorsItemsTagJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesIndicatorsItemsTag) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorListResponsePropertiesPagination added in v7.8.0 

type ThreatEventIndicatorListResponsePropertiesPagination struct {
	Properties ThreatEventIndicatorListResponsePropertiesPaginationProperties `json:"properties" api:"required"`
	Type       string                                                         `json:"type" api:"required"`
	JSON       threatEventIndicatorListResponsePropertiesPaginationJSON       `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesPagination) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorListResponsePropertiesPaginationProperties added in v7.8.0 

type ThreatEventIndicatorListResponsePropertiesPaginationProperties struct {
	Count             ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCount             `json:"count" api:"required"`
	Cursor            ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCursor            `json:"cursor" api:"required"`
	HasMore           ThreatEventIndicatorListResponsePropertiesPaginationPropertiesHasMore           `json:"has_more" api:"required"`
	Page              ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPage              `json:"page" api:"required"`
	PerPage           ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPerPage           `json:"per_page" api:"required"`
	TotalCount        ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCount        `json:"total_count" api:"required"`
	TotalCountIsExact ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCountIsExact `json:"total_count_is_exact" api:"required"`
	JSON              threatEventIndicatorListResponsePropertiesPaginationPropertiesJSON              `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesPaginationProperties) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCount added in v7.8.0 

type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCount struct {
	Type string                                                                  `json:"type" api:"required"`
	JSON threatEventIndicatorListResponsePropertiesPaginationPropertiesCountJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCount) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCursor added in v7.9.0 

type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCursor struct {
	Description string                                                                   `json:"description" api:"required"`
	Nullable    bool                                                                     `json:"nullable" api:"required"`
	Type        string                                                                   `json:"type" api:"required"`
	JSON        threatEventIndicatorListResponsePropertiesPaginationPropertiesCursorJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesPaginationPropertiesCursor) UnmarshalJSON added in v7.9.0 

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

type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesHasMore added in v7.9.0 

type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesHasMore struct {
	Description string                                                                    `json:"description" api:"required"`
	Type        string                                                                    `json:"type" api:"required"`
	JSON        threatEventIndicatorListResponsePropertiesPaginationPropertiesHasMoreJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesPaginationPropertiesHasMore) UnmarshalJSON added in v7.9.0 

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

type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPage added in v7.8.0 

type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPage struct {
	Type string                                                                 `json:"type" api:"required"`
	JSON threatEventIndicatorListResponsePropertiesPaginationPropertiesPageJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPage) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPerPage added in v7.8.0 

type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPerPage struct {
	Type string                                                                    `json:"type" api:"required"`
	JSON threatEventIndicatorListResponsePropertiesPaginationPropertiesPerPageJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesPaginationPropertiesPerPage) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCount added in v7.8.0 

type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCount struct {
	Description string                                                                       `json:"description" api:"required"`
	Nullable    bool                                                                         `json:"nullable" api:"required"`
	Type        string                                                                       `json:"type" api:"required"`
	JSON        threatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCountJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCount) UnmarshalJSON added in v7.8.0 

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

type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCountIsExact added in v7.9.0 

type ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCountIsExact struct {
	Description string                                                                              `json:"description" api:"required"`
	Type        string                                                                              `json:"type" api:"required"`
	JSON        threatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCountIsExactJSON `json:"-"`
}

func (*ThreatEventIndicatorListResponsePropertiesPaginationPropertiesTotalCountIsExact) UnmarshalJSON added in v7.9.0 

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

type ThreatEventIndicatorService added in v7.8.0 

type ThreatEventIndicatorService struct {
	Options   []option.RequestOption
	Aggregate *ThreatEventIndicatorAggregateService
	Types     *ThreatEventIndicatorTypeService
	ByDataset *ThreatEventIndicatorByDatasetService
}

ThreatEventIndicatorService 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 NewThreatEventIndicatorService method instead.

func NewThreatEventIndicatorService added in v7.8.0 

func NewThreatEventIndicatorService(opts ...option.RequestOption) (r *ThreatEventIndicatorService)

NewThreatEventIndicatorService 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 (*ThreatEventIndicatorService) List added in v7.8.0 

func (r *ThreatEventIndicatorService) List(ctx context.Context, params ThreatEventIndicatorListParams, opts ...option.RequestOption) (res *ThreatEventIndicatorListResponse, err error)

Retrieves indicators across specified datasets, ordered by createdAt descending then UUID, dataset ID, and shard ID ascending. Use one standalone datasetIds scope value: 'all'/'\*' or 'operational' for readable intelligence datasets (isAnalytics=false), or 'analytics' for readable analytics datasets (isAnalytics=true). If no datasetIds are provided, uses the default dataset.

type ThreatEventIndicatorTypeListParams 

type ThreatEventIndicatorTypeListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Dataset UUIDs to query, or one standalone scope value: 'operational' for
	// readable intelligence datasets (isAnalytics=false), 'analytics' for readable
	// analytics datasets (isAnalytics=true), or 'all'/'\*' for every readable dataset
	// including analytics datasets. If not provided, queries all accessible datasets,
	// including analytics datasets.
	DatasetIDs param.Field[[]string] `query:"datasetIds"`
}

func (ThreatEventIndicatorTypeListParams) URLQuery added in v7.8.0 

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

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

type ThreatEventIndicatorTypeListResponse 

type ThreatEventIndicatorTypeListResponse struct {
	Items ThreatEventIndicatorTypeListResponseItems `json:"items" api:"required"`
	Type  string                                    `json:"type" api:"required"`
	JSON  threatEventIndicatorTypeListResponseJSON  `json:"-"`
}

func (*ThreatEventIndicatorTypeListResponse) UnmarshalJSON 

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

type ThreatEventIndicatorTypeListResponseItems 

type ThreatEventIndicatorTypeListResponseItems struct {
	Type string                                        `json:"type" api:"required"`
	JSON threatEventIndicatorTypeListResponseItemsJSON `json:"-"`
}

func (*ThreatEventIndicatorTypeListResponseItems) UnmarshalJSON 

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

type ThreatEventIndicatorTypeService 

type ThreatEventIndicatorTypeService struct {
	Options []option.RequestOption
}

ThreatEventIndicatorTypeService 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 NewThreatEventIndicatorTypeService method instead.

func NewThreatEventIndicatorTypeService 

func NewThreatEventIndicatorTypeService(opts ...option.RequestOption) (r *ThreatEventIndicatorTypeService)

NewThreatEventIndicatorTypeService 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 (*ThreatEventIndicatorTypeService) List 

func (r *ThreatEventIndicatorTypeService) List(ctx context.Context, params ThreatEventIndicatorTypeListParams, opts ...option.RequestOption) (res *ThreatEventIndicatorTypeListResponse, err error)

Lists indicator types across multiple datasets

type ThreatEventInsightService 

type ThreatEventInsightService struct {
	Options []option.RequestOption
}

ThreatEventInsightService 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 NewThreatEventInsightService method instead.

func NewThreatEventInsightService 

func NewThreatEventInsightService(opts ...option.RequestOption) (r *ThreatEventInsightService)

NewThreatEventInsightService 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 ThreatEventListParams 

type ThreatEventListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Cache strategy. 'from-graph' serves results from the graph-node KV cache when
	// all requested UUIDs are cached; falls back to normal path on partial/zero hit.
	Cache param.Field[ThreatEventListParamsCache] `query:"cache"`
	// Cursor for pagination. When provided, filters are embedded in the cursor so you
	// only need to pass cursor and pageSize. Returned in the previous response's
	// result_info.cursor field. Use cursor-based pagination for deep pagination
	// (beyond 100,000 records) or for optimal performance.
	Cursor param.Field[string] `query:"cursor"`
	// Dataset UUIDs to query, or one standalone scope value: 'all'/'\*' or
	// 'operational' for readable intelligence datasets (isAnalytics=false), or
	// 'analytics' for readable analytics datasets (isAnalytics=true). Scope values
	// query at most 50 datasets. If not provided, uses the default dataset.
	DatasetID    param.Field[[]string]                    `query:"datasetId"`
	ForceRefresh param.Field[bool]                        `query:"forceRefresh"`
	Format       param.Field[ThreatEventListParamsFormat] `query:"format"`
	Order        param.Field[ThreatEventListParamsOrder]  `query:"order"`
	OrderBy      param.Field[string]                      `query:"orderBy"`
	// Page number (1-indexed) for offset-based pagination. Limited to offset of
	// 100,000 records. For deep pagination, use cursor-based pagination instead.
	Page param.Field[float64] `query:"page"`
	// Number of results per page. Maximum 25,000.
	PageSize param.Field[float64]                            `query:"pageSize"`
	Search   param.Field[[]ThreatEventListParamsSearchUnion] `query:"search"`
	// JSON-encoded. OR branches of structured search filters. Filters within a branch
	// are AND'd, branches are OR'd, and the result is AND'd with `search`:
	// `AND(search) AND OR(AND(branch 1), ...)`. Max 8 branches of 1-10 conditions
	// each. Not supported for analytics datasets, and `indicator` filters are not yet
	// supported inside branches. Cursor pages carry the original branches, so do not
	// resend them with `cursor`.
	SearchBranches param.Field[[][]ThreatEventListParamsSearchBranchUnion] `query:"searchBranches"`
}

func (ThreatEventListParams) URLQuery 

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

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

type ThreatEventListParamsCache added in v7.8.0 

type ThreatEventListParamsCache string

Cache strategy. 'from-graph' serves results from the graph-node KV cache when all requested UUIDs are cached; falls back to normal path on partial/zero hit. 

const (
	ThreatEventListParamsCacheFromGraph ThreatEventListParamsCache = "from-graph"
)

func (ThreatEventListParamsCache) IsKnown added in v7.8.0 

func (r ThreatEventListParamsCache) IsKnown() bool

type ThreatEventListParamsFormat 

type ThreatEventListParamsFormat string
const (
	ThreatEventListParamsFormatJson  ThreatEventListParamsFormat = "json"
	ThreatEventListParamsFormatStix2 ThreatEventListParamsFormat = "stix2"
	ThreatEventListParamsFormatTaxii ThreatEventListParamsFormat = "taxii"
)

func (ThreatEventListParamsFormat) IsKnown 

func (r ThreatEventListParamsFormat) IsKnown() bool

type ThreatEventListParamsOrder 

type ThreatEventListParamsOrder string
const (
	ThreatEventListParamsOrderAsc  ThreatEventListParamsOrder = "asc"
	ThreatEventListParamsOrderDesc ThreatEventListParamsOrder = "desc"
)

func (ThreatEventListParamsOrder) IsKnown 

func (r ThreatEventListParamsOrder) IsKnown() bool

type ThreatEventListParamsSearch 

type ThreatEventListParamsSearch struct {
	Field param.Field[ThreatEventListParamsSearchField] `json:"field" api:"required"`
	Op    param.Field[ThreatEventListParamsSearchOp]    `json:"op" api:"required"`
	Value param.Field[interface{}]                      `json:"value" api:"required"`
}

func (ThreatEventListParamsSearch) MarshalJSON added in v7.10.0 

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

type ThreatEventListParamsSearchBranch 

type ThreatEventListParamsSearchBranch struct {
	Field param.Field[ThreatEventListParamsSearchBranchesField] `json:"field" api:"required"`
	Op    param.Field[ThreatEventListParamsSearchBranchesOp]    `json:"op" api:"required"`
	Value param.Field[interface{}]                              `json:"value" api:"required"`
}

func (ThreatEventListParamsSearchBranch) MarshalJSON 

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

type ThreatEventListParamsSearchBranchUnion 

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

Satisfied by cloudforce_one.ThreatEventListParamsSearchBranchesObject, cloudforce_one.ThreatEventListParamsSearchBranchesObject, cloudforce_one.ThreatEventListParamsSearchBranchesObject, cloudforce_one.ThreatEventListParamsSearchBranchesObject, cloudforce_one.ThreatEventListParamsSearchBranchesObject, cloudforce_one.ThreatEventListParamsSearchBranchesObject, ThreatEventListParamsSearchBranch.

type ThreatEventListParamsSearchBranchesField 

type ThreatEventListParamsSearchBranchesField string
const (
	ThreatEventListParamsSearchBranchesFieldAttacker        ThreatEventListParamsSearchBranchesField = "attacker"
	ThreatEventListParamsSearchBranchesFieldAttackerCountry ThreatEventListParamsSearchBranchesField = "attackerCountry"
	ThreatEventListParamsSearchBranchesFieldCategory        ThreatEventListParamsSearchBranchesField = "category"
	ThreatEventListParamsSearchBranchesFieldCreatedAt       ThreatEventListParamsSearchBranchesField = "createdAt"
	ThreatEventListParamsSearchBranchesFieldDate            ThreatEventListParamsSearchBranchesField = "date"
	ThreatEventListParamsSearchBranchesFieldEvent           ThreatEventListParamsSearchBranchesField = "event"
	ThreatEventListParamsSearchBranchesFieldIndicator       ThreatEventListParamsSearchBranchesField = "indicator"
	ThreatEventListParamsSearchBranchesFieldIndicatorType   ThreatEventListParamsSearchBranchesField = "indicatorType"
	ThreatEventListParamsSearchBranchesFieldMitreAttack     ThreatEventListParamsSearchBranchesField = "mitreAttack"
	ThreatEventListParamsSearchBranchesFieldMitreCapec      ThreatEventListParamsSearchBranchesField = "mitreCapec"
	ThreatEventListParamsSearchBranchesFieldTags            ThreatEventListParamsSearchBranchesField = "tags"
	ThreatEventListParamsSearchBranchesFieldTargetCountry   ThreatEventListParamsSearchBranchesField = "targetCountry"
	ThreatEventListParamsSearchBranchesFieldTargetIndustry  ThreatEventListParamsSearchBranchesField = "targetIndustry"
	ThreatEventListParamsSearchBranchesFieldTLP             ThreatEventListParamsSearchBranchesField = "tlp"
	ThreatEventListParamsSearchBranchesFieldUUID            ThreatEventListParamsSearchBranchesField = "uuid"
	ThreatEventListParamsSearchBranchesFieldKillChain       ThreatEventListParamsSearchBranchesField = "killChain"
	ThreatEventListParamsSearchBranchesFieldHasChildren     ThreatEventListParamsSearchBranchesField = "hasChildren"
)

func (ThreatEventListParamsSearchBranchesField) IsKnown 

func (r ThreatEventListParamsSearchBranchesField) IsKnown() bool

type ThreatEventListParamsSearchBranchesObject 

type ThreatEventListParamsSearchBranchesObject struct {
	Field param.Field[ThreatEventListParamsSearchBranchesObjectField] `query:"field" api:"required"`
	Op    param.Field[ThreatEventListParamsSearchBranchesObjectOp]    `query:"op" api:"required"`
	Value param.Field[string]                                         `query:"value" api:"required"`
}

func (ThreatEventListParamsSearchBranchesObject) URLQuery 

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

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

type ThreatEventListParamsSearchBranchesObjectField 

type ThreatEventListParamsSearchBranchesObjectField string
const (
	ThreatEventListParamsSearchBranchesObjectFieldAttacker        ThreatEventListParamsSearchBranchesObjectField = "attacker"
	ThreatEventListParamsSearchBranchesObjectFieldAttackerCountry ThreatEventListParamsSearchBranchesObjectField = "attackerCountry"
	ThreatEventListParamsSearchBranchesObjectFieldCategory        ThreatEventListParamsSearchBranchesObjectField = "category"
	ThreatEventListParamsSearchBranchesObjectFieldCreatedAt       ThreatEventListParamsSearchBranchesObjectField = "createdAt"
	ThreatEventListParamsSearchBranchesObjectFieldDate            ThreatEventListParamsSearchBranchesObjectField = "date"
	ThreatEventListParamsSearchBranchesObjectFieldEvent           ThreatEventListParamsSearchBranchesObjectField = "event"
	ThreatEventListParamsSearchBranchesObjectFieldIndicator       ThreatEventListParamsSearchBranchesObjectField = "indicator"
	ThreatEventListParamsSearchBranchesObjectFieldIndicatorType   ThreatEventListParamsSearchBranchesObjectField = "indicatorType"
	ThreatEventListParamsSearchBranchesObjectFieldMitreAttack     ThreatEventListParamsSearchBranchesObjectField = "mitreAttack"
	ThreatEventListParamsSearchBranchesObjectFieldMitreCapec      ThreatEventListParamsSearchBranchesObjectField = "mitreCapec"
	ThreatEventListParamsSearchBranchesObjectFieldTags            ThreatEventListParamsSearchBranchesObjectField = "tags"
	ThreatEventListParamsSearchBranchesObjectFieldTargetCountry   ThreatEventListParamsSearchBranchesObjectField = "targetCountry"
	ThreatEventListParamsSearchBranchesObjectFieldTargetIndustry  ThreatEventListParamsSearchBranchesObjectField = "targetIndustry"
	ThreatEventListParamsSearchBranchesObjectFieldTLP             ThreatEventListParamsSearchBranchesObjectField = "tlp"
	ThreatEventListParamsSearchBranchesObjectFieldUUID            ThreatEventListParamsSearchBranchesObjectField = "uuid"
)

func (ThreatEventListParamsSearchBranchesObjectField) IsKnown 

func (r ThreatEventListParamsSearchBranchesObjectField) IsKnown() bool

type ThreatEventListParamsSearchBranchesObjectOp 

type ThreatEventListParamsSearchBranchesObjectOp string
const (
	ThreatEventListParamsSearchBranchesObjectOpEquals     ThreatEventListParamsSearchBranchesObjectOp = "equals"
	ThreatEventListParamsSearchBranchesObjectOpNot        ThreatEventListParamsSearchBranchesObjectOp = "not"
	ThreatEventListParamsSearchBranchesObjectOpGt         ThreatEventListParamsSearchBranchesObjectOp = "gt"
	ThreatEventListParamsSearchBranchesObjectOpGte        ThreatEventListParamsSearchBranchesObjectOp = "gte"
	ThreatEventListParamsSearchBranchesObjectOpLt         ThreatEventListParamsSearchBranchesObjectOp = "lt"
	ThreatEventListParamsSearchBranchesObjectOpLte        ThreatEventListParamsSearchBranchesObjectOp = "lte"
	ThreatEventListParamsSearchBranchesObjectOpLike       ThreatEventListParamsSearchBranchesObjectOp = "like"
	ThreatEventListParamsSearchBranchesObjectOpContains   ThreatEventListParamsSearchBranchesObjectOp = "contains"
	ThreatEventListParamsSearchBranchesObjectOpStartsWith ThreatEventListParamsSearchBranchesObjectOp = "startsWith"
	ThreatEventListParamsSearchBranchesObjectOpEndsWith   ThreatEventListParamsSearchBranchesObjectOp = "endsWith"
	ThreatEventListParamsSearchBranchesObjectOpFind       ThreatEventListParamsSearchBranchesObjectOp = "find"
)

func (ThreatEventListParamsSearchBranchesObjectOp) IsKnown 

func (r ThreatEventListParamsSearchBranchesObjectOp) IsKnown() bool

type ThreatEventListParamsSearchBranchesOp 

type ThreatEventListParamsSearchBranchesOp string
const (
	ThreatEventListParamsSearchBranchesOpEquals     ThreatEventListParamsSearchBranchesOp = "equals"
	ThreatEventListParamsSearchBranchesOpNot        ThreatEventListParamsSearchBranchesOp = "not"
	ThreatEventListParamsSearchBranchesOpGt         ThreatEventListParamsSearchBranchesOp = "gt"
	ThreatEventListParamsSearchBranchesOpGte        ThreatEventListParamsSearchBranchesOp = "gte"
	ThreatEventListParamsSearchBranchesOpLt         ThreatEventListParamsSearchBranchesOp = "lt"
	ThreatEventListParamsSearchBranchesOpLte        ThreatEventListParamsSearchBranchesOp = "lte"
	ThreatEventListParamsSearchBranchesOpLike       ThreatEventListParamsSearchBranchesOp = "like"
	ThreatEventListParamsSearchBranchesOpContains   ThreatEventListParamsSearchBranchesOp = "contains"
	ThreatEventListParamsSearchBranchesOpStartsWith ThreatEventListParamsSearchBranchesOp = "startsWith"
	ThreatEventListParamsSearchBranchesOpEndsWith   ThreatEventListParamsSearchBranchesOp = "endsWith"
	ThreatEventListParamsSearchBranchesOpFind       ThreatEventListParamsSearchBranchesOp = "find"
	ThreatEventListParamsSearchBranchesOpIn         ThreatEventListParamsSearchBranchesOp = "in"
)

func (ThreatEventListParamsSearchBranchesOp) IsKnown 

func (r ThreatEventListParamsSearchBranchesOp) IsKnown() bool

type ThreatEventListParamsSearchField added in v7.10.0 

type ThreatEventListParamsSearchField string
const (
	ThreatEventListParamsSearchFieldAttacker        ThreatEventListParamsSearchField = "attacker"
	ThreatEventListParamsSearchFieldAttackerCountry ThreatEventListParamsSearchField = "attackerCountry"
	ThreatEventListParamsSearchFieldCategory        ThreatEventListParamsSearchField = "category"
	ThreatEventListParamsSearchFieldCreatedAt       ThreatEventListParamsSearchField = "createdAt"
	ThreatEventListParamsSearchFieldDate            ThreatEventListParamsSearchField = "date"
	ThreatEventListParamsSearchFieldEvent           ThreatEventListParamsSearchField = "event"
	ThreatEventListParamsSearchFieldIndicator       ThreatEventListParamsSearchField = "indicator"
	ThreatEventListParamsSearchFieldIndicatorType   ThreatEventListParamsSearchField = "indicatorType"
	ThreatEventListParamsSearchFieldMitreAttack     ThreatEventListParamsSearchField = "mitreAttack"
	ThreatEventListParamsSearchFieldMitreCapec      ThreatEventListParamsSearchField = "mitreCapec"
	ThreatEventListParamsSearchFieldTags            ThreatEventListParamsSearchField = "tags"
	ThreatEventListParamsSearchFieldTargetCountry   ThreatEventListParamsSearchField = "targetCountry"
	ThreatEventListParamsSearchFieldTargetIndustry  ThreatEventListParamsSearchField = "targetIndustry"
	ThreatEventListParamsSearchFieldTLP             ThreatEventListParamsSearchField = "tlp"
	ThreatEventListParamsSearchFieldUUID            ThreatEventListParamsSearchField = "uuid"
	ThreatEventListParamsSearchFieldKillChain       ThreatEventListParamsSearchField = "killChain"
	ThreatEventListParamsSearchFieldHasChildren     ThreatEventListParamsSearchField = "hasChildren"
)

func (ThreatEventListParamsSearchField) IsKnown added in v7.10.0 

func (r ThreatEventListParamsSearchField) IsKnown() bool

type ThreatEventListParamsSearchObject added in v7.10.0 

type ThreatEventListParamsSearchObject struct {
	Field param.Field[ThreatEventListParamsSearchObjectField] `query:"field" api:"required"`
	Op    param.Field[ThreatEventListParamsSearchObjectOp]    `query:"op" api:"required"`
	Value param.Field[string]                                 `query:"value" api:"required"`
}

func (ThreatEventListParamsSearchObject) URLQuery added in v7.10.0 

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

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

type ThreatEventListParamsSearchObjectField added in v7.10.0 

type ThreatEventListParamsSearchObjectField string
const (
	ThreatEventListParamsSearchObjectFieldAttacker        ThreatEventListParamsSearchObjectField = "attacker"
	ThreatEventListParamsSearchObjectFieldAttackerCountry ThreatEventListParamsSearchObjectField = "attackerCountry"
	ThreatEventListParamsSearchObjectFieldCategory        ThreatEventListParamsSearchObjectField = "category"
	ThreatEventListParamsSearchObjectFieldCreatedAt       ThreatEventListParamsSearchObjectField = "createdAt"
	ThreatEventListParamsSearchObjectFieldDate            ThreatEventListParamsSearchObjectField = "date"
	ThreatEventListParamsSearchObjectFieldEvent           ThreatEventListParamsSearchObjectField = "event"
	ThreatEventListParamsSearchObjectFieldIndicator       ThreatEventListParamsSearchObjectField = "indicator"
	ThreatEventListParamsSearchObjectFieldIndicatorType   ThreatEventListParamsSearchObjectField = "indicatorType"
	ThreatEventListParamsSearchObjectFieldMitreAttack     ThreatEventListParamsSearchObjectField = "mitreAttack"
	ThreatEventListParamsSearchObjectFieldMitreCapec      ThreatEventListParamsSearchObjectField = "mitreCapec"
	ThreatEventListParamsSearchObjectFieldTags            ThreatEventListParamsSearchObjectField = "tags"
	ThreatEventListParamsSearchObjectFieldTargetCountry   ThreatEventListParamsSearchObjectField = "targetCountry"
	ThreatEventListParamsSearchObjectFieldTargetIndustry  ThreatEventListParamsSearchObjectField = "targetIndustry"
	ThreatEventListParamsSearchObjectFieldTLP             ThreatEventListParamsSearchObjectField = "tlp"
	ThreatEventListParamsSearchObjectFieldUUID            ThreatEventListParamsSearchObjectField = "uuid"
)

func (ThreatEventListParamsSearchObjectField) IsKnown added in v7.10.0 

func (r ThreatEventListParamsSearchObjectField) IsKnown() bool

type ThreatEventListParamsSearchObjectOp added in v7.10.0 

type ThreatEventListParamsSearchObjectOp string
const (
	ThreatEventListParamsSearchObjectOpEquals     ThreatEventListParamsSearchObjectOp = "equals"
	ThreatEventListParamsSearchObjectOpNot        ThreatEventListParamsSearchObjectOp = "not"
	ThreatEventListParamsSearchObjectOpGt         ThreatEventListParamsSearchObjectOp = "gt"
	ThreatEventListParamsSearchObjectOpGte        ThreatEventListParamsSearchObjectOp = "gte"
	ThreatEventListParamsSearchObjectOpLt         ThreatEventListParamsSearchObjectOp = "lt"
	ThreatEventListParamsSearchObjectOpLte        ThreatEventListParamsSearchObjectOp = "lte"
	ThreatEventListParamsSearchObjectOpLike       ThreatEventListParamsSearchObjectOp = "like"
	ThreatEventListParamsSearchObjectOpContains   ThreatEventListParamsSearchObjectOp = "contains"
	ThreatEventListParamsSearchObjectOpStartsWith ThreatEventListParamsSearchObjectOp = "startsWith"
	ThreatEventListParamsSearchObjectOpEndsWith   ThreatEventListParamsSearchObjectOp = "endsWith"
	ThreatEventListParamsSearchObjectOpFind       ThreatEventListParamsSearchObjectOp = "find"
)

func (ThreatEventListParamsSearchObjectOp) IsKnown added in v7.10.0 

func (r ThreatEventListParamsSearchObjectOp) IsKnown() bool

type ThreatEventListParamsSearchOp 

type ThreatEventListParamsSearchOp string
const (
	ThreatEventListParamsSearchOpEquals     ThreatEventListParamsSearchOp = "equals"
	ThreatEventListParamsSearchOpNot        ThreatEventListParamsSearchOp = "not"
	ThreatEventListParamsSearchOpGt         ThreatEventListParamsSearchOp = "gt"
	ThreatEventListParamsSearchOpGte        ThreatEventListParamsSearchOp = "gte"
	ThreatEventListParamsSearchOpLt         ThreatEventListParamsSearchOp = "lt"
	ThreatEventListParamsSearchOpLte        ThreatEventListParamsSearchOp = "lte"
	ThreatEventListParamsSearchOpLike       ThreatEventListParamsSearchOp = "like"
	ThreatEventListParamsSearchOpContains   ThreatEventListParamsSearchOp = "contains"
	ThreatEventListParamsSearchOpStartsWith ThreatEventListParamsSearchOp = "startsWith"
	ThreatEventListParamsSearchOpEndsWith   ThreatEventListParamsSearchOp = "endsWith"
	ThreatEventListParamsSearchOpFind       ThreatEventListParamsSearchOp = "find"
	ThreatEventListParamsSearchOpIn         ThreatEventListParamsSearchOp = "in"
)

func (ThreatEventListParamsSearchOp) IsKnown 

func (r ThreatEventListParamsSearchOp) IsKnown() bool

type ThreatEventListParamsSearchUnion added in v7.10.0 

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

Satisfied by cloudforce_one.ThreatEventListParamsSearchObject, cloudforce_one.ThreatEventListParamsSearchObject, cloudforce_one.ThreatEventListParamsSearchObject, cloudforce_one.ThreatEventListParamsSearchObject, cloudforce_one.ThreatEventListParamsSearchObject, cloudforce_one.ThreatEventListParamsSearchObject, ThreatEventListParamsSearch.

type ThreatEventListResponse 

type ThreatEventListResponse struct {
	Attacker              string                      `json:"attacker" api:"required"`
	AttackerCountry       string                      `json:"attackerCountry" api:"required"`
	AttackerCountryAlpha3 string                      `json:"attackerCountryAlpha3" api:"required"`
	Category              string                      `json:"category" api:"required"`
	DatasetID             string                      `json:"datasetId" api:"required"`
	Date                  string                      `json:"date" api:"required"`
	Event                 string                      `json:"event" api:"required"`
	HasChildren           bool                        `json:"hasChildren" api:"required"`
	Indicator             string                      `json:"indicator" api:"required"`
	IndicatorType         string                      `json:"indicatorType" api:"required"`
	IndicatorTypeID       float64                     `json:"indicatorTypeId" api:"required"`
	KillChain             float64                     `json:"killChain" api:"required"`
	MitreAttack           []string                    `json:"mitreAttack" api:"required"`
	MitreCapec            []string                    `json:"mitreCapec" api:"required"`
	NumReferenced         float64                     `json:"numReferenced" api:"required"`
	NumReferences         float64                     `json:"numReferences" api:"required"`
	RawID                 string                      `json:"rawId" api:"required"`
	Referenced            []string                    `json:"referenced" api:"required"`
	ReferencedIDs         []float64                   `json:"referencedIds" api:"required"`
	References            []string                    `json:"references" api:"required"`
	ReferencesIDs         []float64                   `json:"referencesIds" api:"required"`
	Tags                  []string                    `json:"tags" api:"required"`
	TargetCountry         string                      `json:"targetCountry" api:"required"`
	TargetCountryAlpha3   string                      `json:"targetCountryAlpha3" api:"required"`
	TargetIndustry        string                      `json:"targetIndustry" api:"required"`
	TLP                   string                      `json:"tlp" api:"required"`
	UUID                  string                      `json:"uuid" api:"required"`
	Insight               string                      `json:"insight"`
	ReleasabilityID       string                      `json:"releasabilityId"`
	JSON                  threatEventListResponseJSON `json:"-"`
}

func (*ThreatEventListResponse) UnmarshalJSON 

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

type ThreatEventNewParams 

type ThreatEventNewParams struct {
	// Account ID.
	PathAccountID   param.Field[string]                  `path:"account_id" api:"required"`
	Category        param.Field[string]                  `json:"category" api:"required"`
	Date            param.Field[time.Time]               `json:"date" api:"required" format:"date-time"`
	Event           param.Field[string]                  `json:"event" api:"required"`
	Raw             param.Field[ThreatEventNewParamsRaw] `json:"raw" api:"required"`
	TLP             param.Field[string]                  `json:"tlp" api:"required"`
	BodyAccountID   param.Field[float64]                 `json:"accountId"`
	Attacker        param.Field[string]                  `json:"attacker"`
	AttackerCountry param.Field[string]                  `json:"attackerCountry"`
	DatasetID       param.Field[string]                  `json:"datasetId"`
	Indicator       param.Field[string]                  `json:"indicator"`
	// Array of indicators for this event. Supports multiple indicators per event for
	// complex scenarios.
	Indicators    param.Field[[]ThreatEventNewParamsIndicator] `json:"indicators"`
	IndicatorType param.Field[string]                          `json:"indicatorType"`
	Insight       param.Field[string]                          `json:"insight"`
	// Controlled provenance for an event and its indicators derived from a Threat
	// Signals article.
	Source         param.Field[ThreatEventNewParamsSource] `json:"source"`
	Tags           param.Field[[]string]                   `json:"tags"`
	TargetCountry  param.Field[string]                     `json:"targetCountry"`
	TargetIndustry param.Field[string]                     `json:"targetIndustry"`
}

func (ThreatEventNewParams) MarshalJSON 

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

type ThreatEventNewParamsIndicator 

type ThreatEventNewParamsIndicator struct {
	// The type of indicator (e.g., DOMAIN, IP, JA3, HASH)
	IndicatorType param.Field[string] `json:"indicatorType" api:"required"`
	// The indicator value (e.g., domain name, IP address, hash)
	Value param.Field[string] `json:"value" api:"required"`
}

func (ThreatEventNewParamsIndicator) MarshalJSON 

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

type ThreatEventNewParamsRaw 

type ThreatEventNewParamsRaw struct {
	Data   param.Field[map[string]interface{}] `json:"data" api:"required"`
	Source param.Field[string]                 `json:"source"`
	TLP    param.Field[string]                 `json:"tlp"`
}

func (ThreatEventNewParamsRaw) MarshalJSON 

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

type ThreatEventNewParamsSource added in v7.10.0 

type ThreatEventNewParamsSource struct {
	ResourceID   param.Field[string]                                 `json:"resourceId" api:"required" format:"uuid"`
	ResourceType param.Field[ThreatEventNewParamsSourceResourceType] `json:"resourceType" api:"required"`
	System       param.Field[ThreatEventNewParamsSourceSystem]       `json:"system" api:"required"`
	// Threat Signals article title; null for historical provenance without a stored
	// title.
	Title param.Field[string] `json:"title"`
}

Controlled provenance for an event and its indicators derived from a Threat Signals article.

func (ThreatEventNewParamsSource) MarshalJSON added in v7.10.0 

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

type ThreatEventNewParamsSourceResourceType added in v7.10.0 

type ThreatEventNewParamsSourceResourceType string
const (
	ThreatEventNewParamsSourceResourceTypeArticle ThreatEventNewParamsSourceResourceType = "article"
)

func (ThreatEventNewParamsSourceResourceType) IsKnown added in v7.10.0 

func (r ThreatEventNewParamsSourceResourceType) IsKnown() bool

type ThreatEventNewParamsSourceSystem added in v7.10.0 

type ThreatEventNewParamsSourceSystem string
const (
	ThreatEventNewParamsSourceSystemThreatSignals ThreatEventNewParamsSourceSystem = "threat-signals"
)

func (ThreatEventNewParamsSourceSystem) IsKnown added in v7.10.0 

func (r ThreatEventNewParamsSourceSystem) IsKnown() bool

type ThreatEventNewResponse 

type ThreatEventNewResponse struct {
	Attacker              string                     `json:"attacker" api:"required"`
	AttackerCountry       string                     `json:"attackerCountry" api:"required"`
	AttackerCountryAlpha3 string                     `json:"attackerCountryAlpha3" api:"required"`
	Category              string                     `json:"category" api:"required"`
	DatasetID             string                     `json:"datasetId" api:"required"`
	Date                  string                     `json:"date" api:"required"`
	Event                 string                     `json:"event" api:"required"`
	HasChildren           bool                       `json:"hasChildren" api:"required"`
	Indicator             string                     `json:"indicator" api:"required"`
	IndicatorType         string                     `json:"indicatorType" api:"required"`
	IndicatorTypeID       float64                    `json:"indicatorTypeId" api:"required"`
	KillChain             float64                    `json:"killChain" api:"required"`
	MitreAttack           []string                   `json:"mitreAttack" api:"required"`
	MitreCapec            []string                   `json:"mitreCapec" api:"required"`
	NumReferenced         float64                    `json:"numReferenced" api:"required"`
	NumReferences         float64                    `json:"numReferences" api:"required"`
	RawID                 string                     `json:"rawId" api:"required"`
	Referenced            []string                   `json:"referenced" api:"required"`
	ReferencedIDs         []float64                  `json:"referencedIds" api:"required"`
	References            []string                   `json:"references" api:"required"`
	ReferencesIDs         []float64                  `json:"referencesIds" api:"required"`
	Tags                  []string                   `json:"tags" api:"required"`
	TargetCountry         string                     `json:"targetCountry" api:"required"`
	TargetCountryAlpha3   string                     `json:"targetCountryAlpha3" api:"required"`
	TargetIndustry        string                     `json:"targetIndustry" api:"required"`
	TLP                   string                     `json:"tlp" api:"required"`
	UUID                  string                     `json:"uuid" api:"required"`
	Insight               string                     `json:"insight"`
	ReleasabilityID       string                     `json:"releasabilityId"`
	JSON                  threatEventNewResponseJSON `json:"-"`
}

func (*ThreatEventNewResponse) UnmarshalJSON 

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

type ThreatEventQueryDeleteParams added in v7.8.0 

type ThreatEventQueryDeleteParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventQueryEditParams added in v7.8.0 

type ThreatEventQueryEditParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Enable alerts for this query
	AlertEnabled param.Field[bool] `json:"alert_enabled"`
	// Enable alert rollup for this query
	AlertRollupEnabled param.Field[bool] `json:"alert_rollup_enabled"`
	// Unique name for the saved query
	Name param.Field[string] `json:"name"`
	// JSON string containing the query parameters
	QueryJson param.Field[string] `json:"query_json"`
	// Enable rule for this query
	RuleEnabled param.Field[bool] `json:"rule_enabled"`
	// Scope for the rule
	RuleScope param.Field[string] `json:"rule_scope"`
}

func (ThreatEventQueryEditParams) MarshalJSON added in v7.8.0 

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

type ThreatEventQueryEditResponse added in v7.8.0 

type ThreatEventQueryEditResponse struct {
	// Unique identifier for the saved query
	ID int64 `json:"id" api:"required"`
	// Account ID
	AccountID int64 `json:"account_id" api:"required"`
	// Whether alerts are enabled
	AlertEnabled bool `json:"alert_enabled" api:"required"`
	// Whether alert rollup is enabled
	AlertRollupEnabled bool `json:"alert_rollup_enabled" api:"required"`
	// Creation timestamp
	CreatedAt string `json:"created_at" api:"required"`
	// Name of the saved query
	Name string `json:"name" api:"required"`
	// JSON string containing the query parameters
	QueryJson string `json:"query_json" api:"required"`
	// Whether rule is enabled
	RuleEnabled bool `json:"rule_enabled" api:"required"`
	// Last update timestamp
	UpdatedAt string `json:"updated_at" api:"required"`
	// Email of the user who created the query
	UserEmail string `json:"user_email" api:"required"`
	// Intel Indicator Feed ID (numeric)
	CustomThreatFeedID int64 `json:"custom_threat_feed_id" api:"nullable"`
	// WAF rules list ID for blocking
	RuleListID string `json:"rule_list_id"`
	// Scope for the rule
	RuleScope string                           `json:"rule_scope"`
	JSON      threatEventQueryEditResponseJSON `json:"-"`
}

func (*ThreatEventQueryEditResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventQueryGetParams added in v7.8.0 

type ThreatEventQueryGetParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventQueryGetResponse added in v7.8.0 

type ThreatEventQueryGetResponse struct {
	// Unique identifier for the saved query
	ID int64 `json:"id" api:"required"`
	// Account ID
	AccountID int64 `json:"account_id" api:"required"`
	// Whether alerts are enabled
	AlertEnabled bool `json:"alert_enabled" api:"required"`
	// Whether alert rollup is enabled
	AlertRollupEnabled bool `json:"alert_rollup_enabled" api:"required"`
	// Creation timestamp
	CreatedAt string `json:"created_at" api:"required"`
	// Name of the saved query
	Name string `json:"name" api:"required"`
	// JSON string containing the query parameters
	QueryJson string `json:"query_json" api:"required"`
	// Whether rule is enabled
	RuleEnabled bool `json:"rule_enabled" api:"required"`
	// Last update timestamp
	UpdatedAt string `json:"updated_at" api:"required"`
	// Email of the user who created the query
	UserEmail string `json:"user_email" api:"required"`
	// Intel Indicator Feed ID (numeric)
	CustomThreatFeedID int64 `json:"custom_threat_feed_id" api:"nullable"`
	// WAF rules list ID for blocking
	RuleListID string `json:"rule_list_id"`
	// Scope for the rule
	RuleScope string                          `json:"rule_scope"`
	JSON      threatEventQueryGetResponseJSON `json:"-"`
}

func (*ThreatEventQueryGetResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventQueryListParams added in v7.8.0 

type ThreatEventQueryListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventQueryListResponse added in v7.8.0 

type ThreatEventQueryListResponse struct {
	// Unique identifier for the saved query
	ID int64 `json:"id" api:"required"`
	// Account ID
	AccountID int64 `json:"account_id" api:"required"`
	// Whether alerts are enabled
	AlertEnabled bool `json:"alert_enabled" api:"required"`
	// Whether alert rollup is enabled
	AlertRollupEnabled bool `json:"alert_rollup_enabled" api:"required"`
	// Creation timestamp
	CreatedAt string `json:"created_at" api:"required"`
	// Name of the saved query
	Name string `json:"name" api:"required"`
	// JSON string containing the query parameters
	QueryJson string `json:"query_json" api:"required"`
	// Whether rule is enabled
	RuleEnabled bool `json:"rule_enabled" api:"required"`
	// Last update timestamp
	UpdatedAt string `json:"updated_at" api:"required"`
	// Email of the user who created the query
	UserEmail string `json:"user_email" api:"required"`
	// Intel Indicator Feed ID (numeric)
	CustomThreatFeedID int64 `json:"custom_threat_feed_id" api:"nullable"`
	// WAF rules list ID for blocking
	RuleListID string `json:"rule_list_id"`
	// Scope for the rule
	RuleScope string                           `json:"rule_scope"`
	JSON      threatEventQueryListResponseJSON `json:"-"`
}

func (*ThreatEventQueryListResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventQueryNewParams added in v7.8.0 

type ThreatEventQueryNewParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Enable alerts for this query
	AlertEnabled param.Field[bool] `json:"alert_enabled" api:"required"`
	// Enable alert rollup for this query
	AlertRollupEnabled param.Field[bool] `json:"alert_rollup_enabled" api:"required"`
	// Unique name for the saved query
	Name param.Field[string] `json:"name" api:"required"`
	// JSON string containing the query parameters
	QueryJson param.Field[string] `json:"query_json" api:"required"`
	// Enable rule for this query
	RuleEnabled param.Field[bool] `json:"rule_enabled" api:"required"`
	// Scope for the rule
	RuleScope param.Field[string] `json:"rule_scope"`
}

func (ThreatEventQueryNewParams) MarshalJSON added in v7.8.0 

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

type ThreatEventQueryNewResponse added in v7.8.0 

type ThreatEventQueryNewResponse struct {
	// Unique identifier for the saved query
	ID int64 `json:"id" api:"required"`
	// Account ID
	AccountID int64 `json:"account_id" api:"required"`
	// Whether alerts are enabled
	AlertEnabled bool `json:"alert_enabled" api:"required"`
	// Whether alert rollup is enabled
	AlertRollupEnabled bool `json:"alert_rollup_enabled" api:"required"`
	// Creation timestamp
	CreatedAt string `json:"created_at" api:"required"`
	// Name of the saved query
	Name string `json:"name" api:"required"`
	// JSON string containing the query parameters
	QueryJson string `json:"query_json" api:"required"`
	// Whether rule is enabled
	RuleEnabled bool `json:"rule_enabled" api:"required"`
	// Last update timestamp
	UpdatedAt string `json:"updated_at" api:"required"`
	// Email of the user who created the query
	UserEmail string `json:"user_email" api:"required"`
	// Intel Indicator Feed ID (numeric)
	CustomThreatFeedID int64 `json:"custom_threat_feed_id" api:"nullable"`
	// WAF rules list ID for blocking
	RuleListID string `json:"rule_list_id"`
	// Scope for the rule
	RuleScope string                          `json:"rule_scope"`
	JSON      threatEventQueryNewResponseJSON `json:"-"`
}

func (*ThreatEventQueryNewResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventQueryService added in v7.8.0 

type ThreatEventQueryService struct {
	Options []option.RequestOption
}

ThreatEventQueryService 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 NewThreatEventQueryService method instead.

func NewThreatEventQueryService added in v7.8.0 

func NewThreatEventQueryService(opts ...option.RequestOption) (r *ThreatEventQueryService)

NewThreatEventQueryService 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 (*ThreatEventQueryService) Delete added in v7.8.0 

func (r *ThreatEventQueryService) Delete(ctx context.Context, queryID int64, body ThreatEventQueryDeleteParams, opts ...option.RequestOption) (err error)

Delete a saved event query by its ID

func (*ThreatEventQueryService) Edit added in v7.8.0 

func (r *ThreatEventQueryService) Edit(ctx context.Context, queryID int64, params ThreatEventQueryEditParams, opts ...option.RequestOption) (res *ThreatEventQueryEditResponse, err error)

Update an existing saved event query by its ID

func (*ThreatEventQueryService) Get added in v7.8.0 

func (r *ThreatEventQueryService) Get(ctx context.Context, queryID int64, query ThreatEventQueryGetParams, opts ...option.RequestOption) (res *ThreatEventQueryGetResponse, err error)

Retrieve a saved event query by its ID

func (*ThreatEventQueryService) List added in v7.8.0 

func (r *ThreatEventQueryService) List(ctx context.Context, query ThreatEventQueryListParams, opts ...option.RequestOption) (res *[]ThreatEventQueryListResponse, err error)

Retrieve all saved event queries for the account

func (*ThreatEventQueryService) New added in v7.8.0 

func (r *ThreatEventQueryService) New(ctx context.Context, params ThreatEventQueryNewParams, opts ...option.RequestOption) (res *ThreatEventQueryNewResponse, err error)

Create a new saved event query for the account

type ThreatEventRawEditParams 

type ThreatEventRawEditParams struct {
	// Account ID.
	AccountID param.Field[string]      `path:"account_id" api:"required"`
	Data      param.Field[interface{}] `json:"data"`
	Source    param.Field[string]      `json:"source"`
	TLP       param.Field[string]      `json:"tlp"`
}

func (ThreatEventRawEditParams) MarshalJSON 

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

type ThreatEventRawEditResponse 

type ThreatEventRawEditResponse struct {
	ID   string                         `json:"id" api:"required"`
	Data interface{}                    `json:"data" api:"required"`
	JSON threatEventRawEditResponseJSON `json:"-"`
}

func (*ThreatEventRawEditResponse) UnmarshalJSON 

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

type ThreatEventRawGetParams 

type ThreatEventRawGetParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventRawGetResponse 

type ThreatEventRawGetResponse struct {
	ID        string                        `json:"id" api:"required"`
	AccountID float64                       `json:"accountId" api:"required"`
	Created   string                        `json:"created" api:"required"`
	Data      interface{}                   `json:"data" api:"required"`
	Source    string                        `json:"source" api:"required"`
	TLP       string                        `json:"tlp" api:"required"`
	JSON      threatEventRawGetResponseJSON `json:"-"`
}

func (*ThreatEventRawGetResponse) UnmarshalJSON 

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

type ThreatEventRawService 

type ThreatEventRawService struct {
	Options []option.RequestOption
}

ThreatEventRawService 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 NewThreatEventRawService method instead.

func NewThreatEventRawService 

func NewThreatEventRawService(opts ...option.RequestOption) (r *ThreatEventRawService)

NewThreatEventRawService 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 (*ThreatEventRawService) Edit 

func (r *ThreatEventRawService) Edit(ctx context.Context, eventID string, rawID string, params ThreatEventRawEditParams, opts ...option.RequestOption) (res *ThreatEventRawEditResponse, err error)

Partially updates raw threat event data in Cloudforce One, modifying specific fields of the event.

func (*ThreatEventRawService) Get 

func (r *ThreatEventRawService) Get(ctx context.Context, eventID string, rawID string, query ThreatEventRawGetParams, opts ...option.RequestOption) (res *ThreatEventRawGetResponse, err error)

Retrieves raw threat event data for a specific event in Cloudforce One.

type ThreatEventRelateDeleteParams 

type ThreatEventRelateDeleteParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventRelateDeleteResponse 

type ThreatEventRelateDeleteResponse struct {
	Success bool                                `json:"success" api:"required"`
	JSON    threatEventRelateDeleteResponseJSON `json:"-"`
}

func (*ThreatEventRelateDeleteResponse) UnmarshalJSON 

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

type ThreatEventRelateDeleteResponseEnvelope 

type ThreatEventRelateDeleteResponseEnvelope struct {
	Result  ThreatEventRelateDeleteResponse             `json:"result" api:"required"`
	Success bool                                        `json:"success" api:"required"`
	JSON    threatEventRelateDeleteResponseEnvelopeJSON `json:"-"`
}

func (*ThreatEventRelateDeleteResponseEnvelope) UnmarshalJSON 

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

type ThreatEventRelateService 

type ThreatEventRelateService struct {
	Options []option.RequestOption
}

ThreatEventRelateService 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 NewThreatEventRelateService method instead.

func NewThreatEventRelateService 

func NewThreatEventRelateService(opts ...option.RequestOption) (r *ThreatEventRelateService)

NewThreatEventRelateService 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 (*ThreatEventRelateService) Delete 

func (r *ThreatEventRelateService) Delete(ctx context.Context, eventID string, body ThreatEventRelateDeleteParams, opts ...option.RequestOption) (res *ThreatEventRelateDeleteResponse, err error)

Removes a reference link between related threat events in Cloudforce One.

type ThreatEventRelationshipListParams added in v7.8.0 

type ThreatEventRelationshipListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The dataset ID to search within.
	DatasetID param.Field[string] `query:"datasetId" api:"required"`
	// The direction to traverse the graph. Defaults to 'both' to search all.
	Direction param.Field[ThreatEventRelationshipListParamsDirection] `query:"direction"`
	// Whether to include the starting event in the results. Defaults to true.
	IncludeParent param.Field[bool] `query:"includeParent"`
	// An optional array of indicator type IDs to filter the results by.
	IndicatorTypeIDs param.Field[[]string] `query:"indicatorTypeIds"`
	// The maximum depth to traverse. Defaults to 5.
	MaxDepth param.Field[float64] `query:"maxDepth"`
	Page     param.Field[float64] `query:"page"`
	PageSize param.Field[float64] `query:"pageSize"`
	// An optional array of relationship types to filter by.
	RelationshipTypes param.Field[ThreatEventRelationshipListParamsRelationshipTypesUnion] `query:"relationshipTypes"`
}

func (ThreatEventRelationshipListParams) URLQuery added in v7.8.0 

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

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

type ThreatEventRelationshipListParamsDirection added in v7.8.0 

type ThreatEventRelationshipListParamsDirection string

The direction to traverse the graph. Defaults to 'both' to search all. 

const (
	ThreatEventRelationshipListParamsDirectionAncestors   ThreatEventRelationshipListParamsDirection = "ancestors"
	ThreatEventRelationshipListParamsDirectionDescendants ThreatEventRelationshipListParamsDirection = "descendants"
	ThreatEventRelationshipListParamsDirectionBoth        ThreatEventRelationshipListParamsDirection = "both"
)

func (ThreatEventRelationshipListParamsDirection) IsKnown added in v7.8.0 

func (r ThreatEventRelationshipListParamsDirection) IsKnown() bool

type ThreatEventRelationshipListParamsRelationshipTypesArray added in v7.8.0 

type ThreatEventRelationshipListParamsRelationshipTypesArray []string

func (ThreatEventRelationshipListParamsRelationshipTypesArray) ImplementsThreatEventRelationshipListParamsRelationshipTypesUnion added in v7.8.0 

func (r ThreatEventRelationshipListParamsRelationshipTypesArray) ImplementsThreatEventRelationshipListParamsRelationshipTypesUnion()

type ThreatEventRelationshipListParamsRelationshipTypesUnion added in v7.8.0 

type ThreatEventRelationshipListParamsRelationshipTypesUnion interface {
	ImplementsThreatEventRelationshipListParamsRelationshipTypesUnion()
}

An optional array of relationship types to filter by.

Satisfied by shared.UnionString, cloudforce_one.ThreatEventRelationshipListParamsRelationshipTypesArray.

type ThreatEventRelationshipListResponse added in v7.8.0 

type ThreatEventRelationshipListResponse struct {
	Attacker              string                                  `json:"attacker" api:"required"`
	AttackerCountry       string                                  `json:"attackerCountry" api:"required"`
	AttackerCountryAlpha3 string                                  `json:"attackerCountryAlpha3" api:"required"`
	Category              string                                  `json:"category" api:"required"`
	DatasetID             string                                  `json:"datasetId" api:"required"`
	Date                  string                                  `json:"date" api:"required"`
	Event                 string                                  `json:"event" api:"required"`
	HasChildren           bool                                    `json:"hasChildren" api:"required"`
	Indicator             string                                  `json:"indicator" api:"required"`
	IndicatorType         string                                  `json:"indicatorType" api:"required"`
	IndicatorTypeID       float64                                 `json:"indicatorTypeId" api:"required"`
	KillChain             float64                                 `json:"killChain" api:"required"`
	MitreAttack           []string                                `json:"mitreAttack" api:"required"`
	MitreCapec            []string                                `json:"mitreCapec" api:"required"`
	NumReferenced         float64                                 `json:"numReferenced" api:"required"`
	NumReferences         float64                                 `json:"numReferences" api:"required"`
	RawID                 string                                  `json:"rawId" api:"required"`
	Referenced            []string                                `json:"referenced" api:"required"`
	ReferencedIDs         []float64                               `json:"referencedIds" api:"required"`
	References            []string                                `json:"references" api:"required"`
	ReferencesIDs         []float64                               `json:"referencesIds" api:"required"`
	Tags                  []string                                `json:"tags" api:"required"`
	TargetCountry         string                                  `json:"targetCountry" api:"required"`
	TargetCountryAlpha3   string                                  `json:"targetCountryAlpha3" api:"required"`
	TargetIndustry        string                                  `json:"targetIndustry" api:"required"`
	TLP                   string                                  `json:"tlp" api:"required"`
	UUID                  string                                  `json:"uuid" api:"required"`
	Insight               string                                  `json:"insight"`
	ReleasabilityID       string                                  `json:"releasabilityId"`
	JSON                  threatEventRelationshipListResponseJSON `json:"-"`
}

func (*ThreatEventRelationshipListResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventRelationshipService added in v7.8.0 

type ThreatEventRelationshipService struct {
	Options []option.RequestOption
}

ThreatEventRelationshipService 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 NewThreatEventRelationshipService method instead.

func NewThreatEventRelationshipService added in v7.8.0 

func NewThreatEventRelationshipService(opts ...option.RequestOption) (r *ThreatEventRelationshipService)

NewThreatEventRelationshipService 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 (*ThreatEventRelationshipService) List deprecated added in v7.8.0 

func (r *ThreatEventRelationshipService) List(ctx context.Context, eventID string, params ThreatEventRelationshipListParams, opts ...option.RequestOption) (res *[]ThreatEventRelationshipListResponse, err error)

Deprecated; use GET /events/by-id/{event_id}/relationships. Available through 2026-11-28.

Deprecated: Use GET /events/by-id/{event_id}/relationships before 2026-11-28.

type ThreatEventService 

type ThreatEventService struct {
	Options          []option.RequestOption
	Aggregate        *ThreatEventAggregateService
	Graphql          *ThreatEventGraphqlService
	Graph            *ThreatEventGraphService
	Queries          *ThreatEventQueryService
	Relationships    *ThreatEventRelationshipService
	Indicators       *ThreatEventIndicatorService
	Attackers        *ThreatEventAttackerService
	Categories       *ThreatEventCategoryService
	Countries        *ThreatEventCountryService
	Crons            *ThreatEventCronService
	Datasets         *ThreatEventDatasetService
	Raw              *ThreatEventRawService
	Relate           *ThreatEventRelateService
	Tags             *ThreatEventTagService
	EventTags        *ThreatEventEventTagService
	TargetIndustries *ThreatEventTargetIndustryService
	Insights         *ThreatEventInsightService
}

ThreatEventService 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 NewThreatEventService method instead.

func NewThreatEventService 

func NewThreatEventService(opts ...option.RequestOption) (r *ThreatEventService)

NewThreatEventService 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 (*ThreatEventService) BulkNew 

func (r *ThreatEventService) BulkNew(ctx context.Context, params ThreatEventBulkNewParams, opts ...option.RequestOption) (res *ThreatEventBulkNewResponse, err error)

The `datasetId` parameter must be defined. To list existing datasets (and their IDs) in your account, use the [`List Datasets`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/list/) endpoint.

func (*ThreatEventService) BulkNewRelationships deprecated added in v7.8.0 

func (r *ThreatEventService) BulkNewRelationships(ctx context.Context, params ThreatEventBulkNewRelationshipsParams, opts ...option.RequestOption) (res *ThreatEventBulkNewRelationshipsResponse, err error)

This method is deprecated. Please use `event_create_bulk` instead

Deprecated: This endpoint is deprecated and will be removed in a future version.

func (*ThreatEventService) Edit 

func (r *ThreatEventService) Edit(ctx context.Context, eventID string, params ThreatEventEditParams, opts ...option.RequestOption) (res *ThreatEventEditResponse, err error)

Partially updates a threat event in Cloudforce One, modifying specific fields without replacing the entire event.

func (*ThreatEventService) Get deprecated 

func (r *ThreatEventService) Get(ctx context.Context, eventID string, query ThreatEventGetParams, opts ...option.RequestOption) (res *ThreatEventGetResponse, err error)

This Method is deprecated. Please use /events/dataset/:dataset_id/events/:event_id instead.

Deprecated: Use datasets.events.get instead (GET /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/events/{event_id}).

func (*ThreatEventService) List 

func (r *ThreatEventService) List(ctx context.Context, params ThreatEventListParams, opts ...option.RequestOption) (res *[]ThreatEventListResponse, err error)

Use one standalone `datasetId` scope value: 'all'/'\*' or 'operational' for readable intelligence datasets (isAnalytics=false), or 'analytics' for readable analytics datasets (isAnalytics=true). Scope values query at most 50 datasets and must be used alone. When `datasetId` is unspecified, events are listed from the default Cloudforce One Threat Events dataset. To list existing datasets, use the [`List Datasets`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/list/) endpoint.

func (*ThreatEventService) New 

func (r *ThreatEventService) New(ctx context.Context, params ThreatEventNewParams, opts ...option.RequestOption) (res *ThreatEventNewResponse, err error)

To create a dataset, see the [`Create Dataset`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/create/) endpoint. When `datasetId` parameter is unspecified, it will be created in a default dataset named `Cloudforce One Threat Events`.

type ThreatEventTagCategoryDeleteParams added in v7.8.0 

type ThreatEventTagCategoryDeleteParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventTagCategoryDeleteResponse added in v7.8.0 

type ThreatEventTagCategoryDeleteResponse struct {
	UUID string                                   `json:"uuid" api:"required"`
	JSON threatEventTagCategoryDeleteResponseJSON `json:"-"`
}

func (*ThreatEventTagCategoryDeleteResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagCategoryEditParams added in v7.8.0 

type ThreatEventTagCategoryEditParams struct {
	// Account ID.
	AccountID   param.Field[string] `path:"account_id" api:"required"`
	Description param.Field[string] `json:"description"`
	Name        param.Field[string] `json:"name"`
	// Optional array of FieldDefinition objects. When provided, replaces the existing
	// field schema. When omitted, the existing schema is preserved.
	Schema param.Field[[]ThreatEventTagCategoryEditParamsSchema] `json:"schema"`
}

func (ThreatEventTagCategoryEditParams) MarshalJSON added in v7.8.0 

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

type ThreatEventTagCategoryEditParamsSchema added in v7.10.0 

type ThreatEventTagCategoryEditParamsSchema struct {
	Key           param.Field[string]                                            `json:"key" api:"required"`
	Kind          param.Field[ThreatEventTagCategoryEditParamsSchemaKind]        `json:"kind" api:"required"`
	AllowedValues param.Field[[]string]                                          `json:"allowedValues"`
	Annotations   param.Field[ThreatEventTagCategoryEditParamsSchemaAnnotations] `json:"annotations"`
	// Marks a field as unavailable for new values while retaining its definition for
	// historical values.
	Deprecated param.Field[bool] `json:"deprecated"`
	// Enum values unavailable for new writes but retained in allowedValues for
	// historical display.
	DeprecatedValues param.Field[[]string]                                               `json:"deprecatedValues"`
	Element          param.Field[interface{}]                                            `json:"element"`
	Enforcement      param.Field[ThreatEventTagCategoryEditParamsSchemaEnforcement]      `json:"enforcement"`
	Format           param.Field[ThreatEventTagCategoryEditParamsSchemaFormat]           `json:"format"`
	Label            param.Field[string]                                                 `json:"label"`
	MaxLength        param.Field[int64]                                                  `json:"maxLength"`
	NumberConstraint param.Field[ThreatEventTagCategoryEditParamsSchemaNumberConstraint] `json:"numberConstraint"`
	// Map of property key to FieldDefinition for object fields. Required when kind is
	// 'object'. See FieldDefinition (recursive).
	Properties param.Field[map[string]interface{}] `json:"properties"`
	Required   param.Field[bool]                   `json:"required"`
}

func (ThreatEventTagCategoryEditParamsSchema) MarshalJSON added in v7.10.0 

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

type ThreatEventTagCategoryEditParamsSchemaAnnotations added in v7.10.0 

type ThreatEventTagCategoryEditParamsSchemaAnnotations struct {
	Confidence param.Field[bool] `json:"confidence"`
	TLP        param.Field[bool] `json:"tlp"`
}

func (ThreatEventTagCategoryEditParamsSchemaAnnotations) MarshalJSON added in v7.10.0 

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

type ThreatEventTagCategoryEditParamsSchemaEnforcement added in v7.10.0 

type ThreatEventTagCategoryEditParamsSchemaEnforcement string
const (
	ThreatEventTagCategoryEditParamsSchemaEnforcementError ThreatEventTagCategoryEditParamsSchemaEnforcement = "error"
	ThreatEventTagCategoryEditParamsSchemaEnforcementWarn  ThreatEventTagCategoryEditParamsSchemaEnforcement = "warn"
	ThreatEventTagCategoryEditParamsSchemaEnforcementOff   ThreatEventTagCategoryEditParamsSchemaEnforcement = "off"
)

func (ThreatEventTagCategoryEditParamsSchemaEnforcement) IsKnown added in v7.10.0 

func (r ThreatEventTagCategoryEditParamsSchemaEnforcement) IsKnown() bool

type ThreatEventTagCategoryEditParamsSchemaFormat added in v7.10.0 

type ThreatEventTagCategoryEditParamsSchemaFormat string
const (
	ThreatEventTagCategoryEditParamsSchemaFormatDate     ThreatEventTagCategoryEditParamsSchemaFormat = "date"
	ThreatEventTagCategoryEditParamsSchemaFormatURL      ThreatEventTagCategoryEditParamsSchemaFormat = "url"
	ThreatEventTagCategoryEditParamsSchemaFormatDuration ThreatEventTagCategoryEditParamsSchemaFormat = "duration"
	ThreatEventTagCategoryEditParamsSchemaFormatCountry  ThreatEventTagCategoryEditParamsSchemaFormat = "country"
)

func (ThreatEventTagCategoryEditParamsSchemaFormat) IsKnown added in v7.10.0 

func (r ThreatEventTagCategoryEditParamsSchemaFormat) IsKnown() bool

type ThreatEventTagCategoryEditParamsSchemaKind added in v7.10.0 

type ThreatEventTagCategoryEditParamsSchemaKind string
const (
	ThreatEventTagCategoryEditParamsSchemaKindString ThreatEventTagCategoryEditParamsSchemaKind = "string"
	ThreatEventTagCategoryEditParamsSchemaKindNumber ThreatEventTagCategoryEditParamsSchemaKind = "number"
	ThreatEventTagCategoryEditParamsSchemaKindEnum   ThreatEventTagCategoryEditParamsSchemaKind = "enum"
	ThreatEventTagCategoryEditParamsSchemaKindDate   ThreatEventTagCategoryEditParamsSchemaKind = "date"
	ThreatEventTagCategoryEditParamsSchemaKindArray  ThreatEventTagCategoryEditParamsSchemaKind = "array"
	ThreatEventTagCategoryEditParamsSchemaKindObject ThreatEventTagCategoryEditParamsSchemaKind = "object"
)

func (ThreatEventTagCategoryEditParamsSchemaKind) IsKnown added in v7.10.0 

func (r ThreatEventTagCategoryEditParamsSchemaKind) IsKnown() bool

type ThreatEventTagCategoryEditParamsSchemaNumberConstraint added in v7.10.0 

type ThreatEventTagCategoryEditParamsSchemaNumberConstraint struct {
	Integer param.Field[bool]    `json:"integer"`
	Max     param.Field[float64] `json:"max"`
	Min     param.Field[float64] `json:"min"`
}

func (ThreatEventTagCategoryEditParamsSchemaNumberConstraint) MarshalJSON added in v7.10.0 

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

type ThreatEventTagCategoryEditResponse added in v7.8.0 

type ThreatEventTagCategoryEditResponse struct {
	Name        string `json:"name" api:"required"`
	UUID        string `json:"uuid" api:"required"`
	CreatedAt   string `json:"createdAt"`
	Description string `json:"description"`
	// Parsed FieldDefinition[] defining custom fields for this category, or null if
	// none.
	Schema    []ThreatEventTagCategoryEditResponseSchema `json:"schema" api:"nullable"`
	UpdatedAt string                                     `json:"updatedAt"`
	JSON      threatEventTagCategoryEditResponseJSON     `json:"-"`
}

func (*ThreatEventTagCategoryEditResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagCategoryEditResponseSchema added in v7.10.0 

type ThreatEventTagCategoryEditResponseSchema struct {
	Key           string                                              `json:"key" api:"required"`
	Kind          ThreatEventTagCategoryEditResponseSchemaKind        `json:"kind" api:"required"`
	AllowedValues []string                                            `json:"allowedValues"`
	Annotations   ThreatEventTagCategoryEditResponseSchemaAnnotations `json:"annotations"`
	// Marks a field as unavailable for new values while retaining its definition for
	// historical values.
	Deprecated bool `json:"deprecated"`
	// Enum values unavailable for new writes but retained in allowedValues for
	// historical display.
	DeprecatedValues []string                                                 `json:"deprecatedValues"`
	Element          interface{}                                              `json:"element"`
	Enforcement      ThreatEventTagCategoryEditResponseSchemaEnforcement      `json:"enforcement"`
	Format           ThreatEventTagCategoryEditResponseSchemaFormat           `json:"format"`
	Label            string                                                   `json:"label"`
	MaxLength        int64                                                    `json:"maxLength"`
	NumberConstraint ThreatEventTagCategoryEditResponseSchemaNumberConstraint `json:"numberConstraint"`
	// Map of property key to FieldDefinition for object fields. Required when kind is
	// 'object'. See FieldDefinition (recursive).
	Properties map[string]interface{}                       `json:"properties"`
	Required   bool                                         `json:"required"`
	JSON       threatEventTagCategoryEditResponseSchemaJSON `json:"-"`
}

func (*ThreatEventTagCategoryEditResponseSchema) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagCategoryEditResponseSchemaAnnotations added in v7.10.0 

type ThreatEventTagCategoryEditResponseSchemaAnnotations struct {
	Confidence bool                                                    `json:"confidence"`
	TLP        bool                                                    `json:"tlp"`
	JSON       threatEventTagCategoryEditResponseSchemaAnnotationsJSON `json:"-"`
}

func (*ThreatEventTagCategoryEditResponseSchemaAnnotations) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagCategoryEditResponseSchemaEnforcement added in v7.10.0 

type ThreatEventTagCategoryEditResponseSchemaEnforcement string
const (
	ThreatEventTagCategoryEditResponseSchemaEnforcementError ThreatEventTagCategoryEditResponseSchemaEnforcement = "error"
	ThreatEventTagCategoryEditResponseSchemaEnforcementWarn  ThreatEventTagCategoryEditResponseSchemaEnforcement = "warn"
	ThreatEventTagCategoryEditResponseSchemaEnforcementOff   ThreatEventTagCategoryEditResponseSchemaEnforcement = "off"
)

func (ThreatEventTagCategoryEditResponseSchemaEnforcement) IsKnown added in v7.10.0 

func (r ThreatEventTagCategoryEditResponseSchemaEnforcement) IsKnown() bool

type ThreatEventTagCategoryEditResponseSchemaFormat added in v7.10.0 

type ThreatEventTagCategoryEditResponseSchemaFormat string
const (
	ThreatEventTagCategoryEditResponseSchemaFormatDate     ThreatEventTagCategoryEditResponseSchemaFormat = "date"
	ThreatEventTagCategoryEditResponseSchemaFormatURL      ThreatEventTagCategoryEditResponseSchemaFormat = "url"
	ThreatEventTagCategoryEditResponseSchemaFormatDuration ThreatEventTagCategoryEditResponseSchemaFormat = "duration"
	ThreatEventTagCategoryEditResponseSchemaFormatCountry  ThreatEventTagCategoryEditResponseSchemaFormat = "country"
)

func (ThreatEventTagCategoryEditResponseSchemaFormat) IsKnown added in v7.10.0 

func (r ThreatEventTagCategoryEditResponseSchemaFormat) IsKnown() bool

type ThreatEventTagCategoryEditResponseSchemaKind added in v7.10.0 

type ThreatEventTagCategoryEditResponseSchemaKind string
const (
	ThreatEventTagCategoryEditResponseSchemaKindString ThreatEventTagCategoryEditResponseSchemaKind = "string"
	ThreatEventTagCategoryEditResponseSchemaKindNumber ThreatEventTagCategoryEditResponseSchemaKind = "number"
	ThreatEventTagCategoryEditResponseSchemaKindEnum   ThreatEventTagCategoryEditResponseSchemaKind = "enum"
	ThreatEventTagCategoryEditResponseSchemaKindDate   ThreatEventTagCategoryEditResponseSchemaKind = "date"
	ThreatEventTagCategoryEditResponseSchemaKindArray  ThreatEventTagCategoryEditResponseSchemaKind = "array"
	ThreatEventTagCategoryEditResponseSchemaKindObject ThreatEventTagCategoryEditResponseSchemaKind = "object"
)

func (ThreatEventTagCategoryEditResponseSchemaKind) IsKnown added in v7.10.0 

func (r ThreatEventTagCategoryEditResponseSchemaKind) IsKnown() bool

type ThreatEventTagCategoryEditResponseSchemaNumberConstraint added in v7.10.0 

type ThreatEventTagCategoryEditResponseSchemaNumberConstraint struct {
	Integer bool                                                         `json:"integer"`
	Max     float64                                                      `json:"max"`
	Min     float64                                                      `json:"min"`
	JSON    threatEventTagCategoryEditResponseSchemaNumberConstraintJSON `json:"-"`
}

func (*ThreatEventTagCategoryEditResponseSchemaNumberConstraint) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagCategoryListParams added in v7.8.0 

type ThreatEventTagCategoryListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Search    param.Field[string] `query:"search"`
}

func (ThreatEventTagCategoryListParams) URLQuery added in v7.8.0 

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

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

type ThreatEventTagCategoryListResponse added in v7.8.0 

type ThreatEventTagCategoryListResponse struct {
	Categories []ThreatEventTagCategoryListResponseCategory `json:"categories" api:"required"`
	JSON       threatEventTagCategoryListResponseJSON       `json:"-"`
}

func (*ThreatEventTagCategoryListResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagCategoryListResponseCategoriesSchema added in v7.10.0 

type ThreatEventTagCategoryListResponseCategoriesSchema struct {
	Key           string                                                        `json:"key" api:"required"`
	Kind          ThreatEventTagCategoryListResponseCategoriesSchemaKind        `json:"kind" api:"required"`
	AllowedValues []string                                                      `json:"allowedValues"`
	Annotations   ThreatEventTagCategoryListResponseCategoriesSchemaAnnotations `json:"annotations"`
	// Marks a field as unavailable for new values while retaining its definition for
	// historical values.
	Deprecated bool `json:"deprecated"`
	// Enum values unavailable for new writes but retained in allowedValues for
	// historical display.
	DeprecatedValues []string                                                           `json:"deprecatedValues"`
	Element          interface{}                                                        `json:"element"`
	Enforcement      ThreatEventTagCategoryListResponseCategoriesSchemaEnforcement      `json:"enforcement"`
	Format           ThreatEventTagCategoryListResponseCategoriesSchemaFormat           `json:"format"`
	Label            string                                                             `json:"label"`
	MaxLength        int64                                                              `json:"maxLength"`
	NumberConstraint ThreatEventTagCategoryListResponseCategoriesSchemaNumberConstraint `json:"numberConstraint"`
	// Map of property key to FieldDefinition for object fields. Required when kind is
	// 'object'. See FieldDefinition (recursive).
	Properties map[string]interface{}                                 `json:"properties"`
	Required   bool                                                   `json:"required"`
	JSON       threatEventTagCategoryListResponseCategoriesSchemaJSON `json:"-"`
}

func (*ThreatEventTagCategoryListResponseCategoriesSchema) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagCategoryListResponseCategoriesSchemaAnnotations added in v7.10.0 

type ThreatEventTagCategoryListResponseCategoriesSchemaAnnotations struct {
	Confidence bool                                                              `json:"confidence"`
	TLP        bool                                                              `json:"tlp"`
	JSON       threatEventTagCategoryListResponseCategoriesSchemaAnnotationsJSON `json:"-"`
}

func (*ThreatEventTagCategoryListResponseCategoriesSchemaAnnotations) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagCategoryListResponseCategoriesSchemaEnforcement added in v7.10.0 

type ThreatEventTagCategoryListResponseCategoriesSchemaEnforcement string
const (
	ThreatEventTagCategoryListResponseCategoriesSchemaEnforcementError ThreatEventTagCategoryListResponseCategoriesSchemaEnforcement = "error"
	ThreatEventTagCategoryListResponseCategoriesSchemaEnforcementWarn  ThreatEventTagCategoryListResponseCategoriesSchemaEnforcement = "warn"
	ThreatEventTagCategoryListResponseCategoriesSchemaEnforcementOff   ThreatEventTagCategoryListResponseCategoriesSchemaEnforcement = "off"
)

func (ThreatEventTagCategoryListResponseCategoriesSchemaEnforcement) IsKnown added in v7.10.0 

func (r ThreatEventTagCategoryListResponseCategoriesSchemaEnforcement) IsKnown() bool

type ThreatEventTagCategoryListResponseCategoriesSchemaFormat added in v7.10.0 

type ThreatEventTagCategoryListResponseCategoriesSchemaFormat string
const (
	ThreatEventTagCategoryListResponseCategoriesSchemaFormatDate     ThreatEventTagCategoryListResponseCategoriesSchemaFormat = "date"
	ThreatEventTagCategoryListResponseCategoriesSchemaFormatURL      ThreatEventTagCategoryListResponseCategoriesSchemaFormat = "url"
	ThreatEventTagCategoryListResponseCategoriesSchemaFormatDuration ThreatEventTagCategoryListResponseCategoriesSchemaFormat = "duration"
	ThreatEventTagCategoryListResponseCategoriesSchemaFormatCountry  ThreatEventTagCategoryListResponseCategoriesSchemaFormat = "country"
)

func (ThreatEventTagCategoryListResponseCategoriesSchemaFormat) IsKnown added in v7.10.0 

func (r ThreatEventTagCategoryListResponseCategoriesSchemaFormat) IsKnown() bool

type ThreatEventTagCategoryListResponseCategoriesSchemaKind added in v7.10.0 

type ThreatEventTagCategoryListResponseCategoriesSchemaKind string
const (
	ThreatEventTagCategoryListResponseCategoriesSchemaKindString ThreatEventTagCategoryListResponseCategoriesSchemaKind = "string"
	ThreatEventTagCategoryListResponseCategoriesSchemaKindNumber ThreatEventTagCategoryListResponseCategoriesSchemaKind = "number"
	ThreatEventTagCategoryListResponseCategoriesSchemaKindEnum   ThreatEventTagCategoryListResponseCategoriesSchemaKind = "enum"
	ThreatEventTagCategoryListResponseCategoriesSchemaKindDate   ThreatEventTagCategoryListResponseCategoriesSchemaKind = "date"
	ThreatEventTagCategoryListResponseCategoriesSchemaKindArray  ThreatEventTagCategoryListResponseCategoriesSchemaKind = "array"
	ThreatEventTagCategoryListResponseCategoriesSchemaKindObject ThreatEventTagCategoryListResponseCategoriesSchemaKind = "object"
)

func (ThreatEventTagCategoryListResponseCategoriesSchemaKind) IsKnown added in v7.10.0 

func (r ThreatEventTagCategoryListResponseCategoriesSchemaKind) IsKnown() bool

type ThreatEventTagCategoryListResponseCategoriesSchemaNumberConstraint added in v7.10.0 

type ThreatEventTagCategoryListResponseCategoriesSchemaNumberConstraint struct {
	Integer bool                                                                   `json:"integer"`
	Max     float64                                                                `json:"max"`
	Min     float64                                                                `json:"min"`
	JSON    threatEventTagCategoryListResponseCategoriesSchemaNumberConstraintJSON `json:"-"`
}

func (*ThreatEventTagCategoryListResponseCategoriesSchemaNumberConstraint) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagCategoryListResponseCategory added in v7.8.0 

type ThreatEventTagCategoryListResponseCategory struct {
	Name        string `json:"name" api:"required"`
	UUID        string `json:"uuid" api:"required"`
	CreatedAt   string `json:"createdAt"`
	Description string `json:"description"`
	// Parsed FieldDefinition[] defining custom fields for this category, or null if
	// none.
	Schema    []ThreatEventTagCategoryListResponseCategoriesSchema `json:"schema" api:"nullable"`
	UpdatedAt string                                               `json:"updatedAt"`
	JSON      threatEventTagCategoryListResponseCategoryJSON       `json:"-"`
}

func (*ThreatEventTagCategoryListResponseCategory) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagCategoryNewParams added in v7.8.0 

type ThreatEventTagCategoryNewParams struct {
	// Account ID.
	AccountID   param.Field[string] `path:"account_id" api:"required"`
	Name        param.Field[string] `json:"name" api:"required"`
	Description param.Field[string] `json:"description"`
	// Optional array of FieldDefinition objects defining custom fields for tags in
	// this category. Persisted as JSON; returned as a parsed array.
	Schema param.Field[[]ThreatEventTagCategoryNewParamsSchema] `json:"schema"`
}

func (ThreatEventTagCategoryNewParams) MarshalJSON added in v7.8.0 

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

type ThreatEventTagCategoryNewParamsSchema added in v7.10.0 

type ThreatEventTagCategoryNewParamsSchema struct {
	Key           param.Field[string]                                           `json:"key" api:"required"`
	Kind          param.Field[ThreatEventTagCategoryNewParamsSchemaKind]        `json:"kind" api:"required"`
	AllowedValues param.Field[[]string]                                         `json:"allowedValues"`
	Annotations   param.Field[ThreatEventTagCategoryNewParamsSchemaAnnotations] `json:"annotations"`
	// Marks a field as unavailable for new values while retaining its definition for
	// historical values.
	Deprecated param.Field[bool] `json:"deprecated"`
	// Enum values unavailable for new writes but retained in allowedValues for
	// historical display.
	DeprecatedValues param.Field[[]string]                                              `json:"deprecatedValues"`
	Element          param.Field[interface{}]                                           `json:"element"`
	Enforcement      param.Field[ThreatEventTagCategoryNewParamsSchemaEnforcement]      `json:"enforcement"`
	Format           param.Field[ThreatEventTagCategoryNewParamsSchemaFormat]           `json:"format"`
	Label            param.Field[string]                                                `json:"label"`
	MaxLength        param.Field[int64]                                                 `json:"maxLength"`
	NumberConstraint param.Field[ThreatEventTagCategoryNewParamsSchemaNumberConstraint] `json:"numberConstraint"`
	// Map of property key to FieldDefinition for object fields. Required when kind is
	// 'object'. See FieldDefinition (recursive).
	Properties param.Field[map[string]interface{}] `json:"properties"`
	Required   param.Field[bool]                   `json:"required"`
}

func (ThreatEventTagCategoryNewParamsSchema) MarshalJSON added in v7.10.0 

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

type ThreatEventTagCategoryNewParamsSchemaAnnotations added in v7.10.0 

type ThreatEventTagCategoryNewParamsSchemaAnnotations struct {
	Confidence param.Field[bool] `json:"confidence"`
	TLP        param.Field[bool] `json:"tlp"`
}

func (ThreatEventTagCategoryNewParamsSchemaAnnotations) MarshalJSON added in v7.10.0 

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

type ThreatEventTagCategoryNewParamsSchemaEnforcement added in v7.10.0 

type ThreatEventTagCategoryNewParamsSchemaEnforcement string
const (
	ThreatEventTagCategoryNewParamsSchemaEnforcementError ThreatEventTagCategoryNewParamsSchemaEnforcement = "error"
	ThreatEventTagCategoryNewParamsSchemaEnforcementWarn  ThreatEventTagCategoryNewParamsSchemaEnforcement = "warn"
	ThreatEventTagCategoryNewParamsSchemaEnforcementOff   ThreatEventTagCategoryNewParamsSchemaEnforcement = "off"
)

func (ThreatEventTagCategoryNewParamsSchemaEnforcement) IsKnown added in v7.10.0 

func (r ThreatEventTagCategoryNewParamsSchemaEnforcement) IsKnown() bool

type ThreatEventTagCategoryNewParamsSchemaFormat added in v7.10.0 

type ThreatEventTagCategoryNewParamsSchemaFormat string
const (
	ThreatEventTagCategoryNewParamsSchemaFormatDate     ThreatEventTagCategoryNewParamsSchemaFormat = "date"
	ThreatEventTagCategoryNewParamsSchemaFormatURL      ThreatEventTagCategoryNewParamsSchemaFormat = "url"
	ThreatEventTagCategoryNewParamsSchemaFormatDuration ThreatEventTagCategoryNewParamsSchemaFormat = "duration"
	ThreatEventTagCategoryNewParamsSchemaFormatCountry  ThreatEventTagCategoryNewParamsSchemaFormat = "country"
)

func (ThreatEventTagCategoryNewParamsSchemaFormat) IsKnown added in v7.10.0 

func (r ThreatEventTagCategoryNewParamsSchemaFormat) IsKnown() bool

type ThreatEventTagCategoryNewParamsSchemaKind added in v7.10.0 

type ThreatEventTagCategoryNewParamsSchemaKind string
const (
	ThreatEventTagCategoryNewParamsSchemaKindString ThreatEventTagCategoryNewParamsSchemaKind = "string"
	ThreatEventTagCategoryNewParamsSchemaKindNumber ThreatEventTagCategoryNewParamsSchemaKind = "number"
	ThreatEventTagCategoryNewParamsSchemaKindEnum   ThreatEventTagCategoryNewParamsSchemaKind = "enum"
	ThreatEventTagCategoryNewParamsSchemaKindDate   ThreatEventTagCategoryNewParamsSchemaKind = "date"
	ThreatEventTagCategoryNewParamsSchemaKindArray  ThreatEventTagCategoryNewParamsSchemaKind = "array"
	ThreatEventTagCategoryNewParamsSchemaKindObject ThreatEventTagCategoryNewParamsSchemaKind = "object"
)

func (ThreatEventTagCategoryNewParamsSchemaKind) IsKnown added in v7.10.0 

func (r ThreatEventTagCategoryNewParamsSchemaKind) IsKnown() bool

type ThreatEventTagCategoryNewParamsSchemaNumberConstraint added in v7.10.0 

type ThreatEventTagCategoryNewParamsSchemaNumberConstraint struct {
	Integer param.Field[bool]    `json:"integer"`
	Max     param.Field[float64] `json:"max"`
	Min     param.Field[float64] `json:"min"`
}

func (ThreatEventTagCategoryNewParamsSchemaNumberConstraint) MarshalJSON added in v7.10.0 

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

type ThreatEventTagCategoryNewResponse added in v7.8.0 

type ThreatEventTagCategoryNewResponse struct {
	Name        string `json:"name" api:"required"`
	UUID        string `json:"uuid" api:"required"`
	CreatedAt   string `json:"createdAt"`
	Description string `json:"description"`
	// Parsed FieldDefinition[] defining custom fields for this category, or null if
	// none.
	Schema    []ThreatEventTagCategoryNewResponseSchema `json:"schema" api:"nullable"`
	UpdatedAt string                                    `json:"updatedAt"`
	JSON      threatEventTagCategoryNewResponseJSON     `json:"-"`
}

func (*ThreatEventTagCategoryNewResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagCategoryNewResponseSchema added in v7.10.0 

type ThreatEventTagCategoryNewResponseSchema struct {
	Key           string                                             `json:"key" api:"required"`
	Kind          ThreatEventTagCategoryNewResponseSchemaKind        `json:"kind" api:"required"`
	AllowedValues []string                                           `json:"allowedValues"`
	Annotations   ThreatEventTagCategoryNewResponseSchemaAnnotations `json:"annotations"`
	// Marks a field as unavailable for new values while retaining its definition for
	// historical values.
	Deprecated bool `json:"deprecated"`
	// Enum values unavailable for new writes but retained in allowedValues for
	// historical display.
	DeprecatedValues []string                                                `json:"deprecatedValues"`
	Element          interface{}                                             `json:"element"`
	Enforcement      ThreatEventTagCategoryNewResponseSchemaEnforcement      `json:"enforcement"`
	Format           ThreatEventTagCategoryNewResponseSchemaFormat           `json:"format"`
	Label            string                                                  `json:"label"`
	MaxLength        int64                                                   `json:"maxLength"`
	NumberConstraint ThreatEventTagCategoryNewResponseSchemaNumberConstraint `json:"numberConstraint"`
	// Map of property key to FieldDefinition for object fields. Required when kind is
	// 'object'. See FieldDefinition (recursive).
	Properties map[string]interface{}                      `json:"properties"`
	Required   bool                                        `json:"required"`
	JSON       threatEventTagCategoryNewResponseSchemaJSON `json:"-"`
}

func (*ThreatEventTagCategoryNewResponseSchema) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagCategoryNewResponseSchemaAnnotations added in v7.10.0 

type ThreatEventTagCategoryNewResponseSchemaAnnotations struct {
	Confidence bool                                                   `json:"confidence"`
	TLP        bool                                                   `json:"tlp"`
	JSON       threatEventTagCategoryNewResponseSchemaAnnotationsJSON `json:"-"`
}

func (*ThreatEventTagCategoryNewResponseSchemaAnnotations) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagCategoryNewResponseSchemaEnforcement added in v7.10.0 

type ThreatEventTagCategoryNewResponseSchemaEnforcement string
const (
	ThreatEventTagCategoryNewResponseSchemaEnforcementError ThreatEventTagCategoryNewResponseSchemaEnforcement = "error"
	ThreatEventTagCategoryNewResponseSchemaEnforcementWarn  ThreatEventTagCategoryNewResponseSchemaEnforcement = "warn"
	ThreatEventTagCategoryNewResponseSchemaEnforcementOff   ThreatEventTagCategoryNewResponseSchemaEnforcement = "off"
)

func (ThreatEventTagCategoryNewResponseSchemaEnforcement) IsKnown added in v7.10.0 

func (r ThreatEventTagCategoryNewResponseSchemaEnforcement) IsKnown() bool

type ThreatEventTagCategoryNewResponseSchemaFormat added in v7.10.0 

type ThreatEventTagCategoryNewResponseSchemaFormat string
const (
	ThreatEventTagCategoryNewResponseSchemaFormatDate     ThreatEventTagCategoryNewResponseSchemaFormat = "date"
	ThreatEventTagCategoryNewResponseSchemaFormatURL      ThreatEventTagCategoryNewResponseSchemaFormat = "url"
	ThreatEventTagCategoryNewResponseSchemaFormatDuration ThreatEventTagCategoryNewResponseSchemaFormat = "duration"
	ThreatEventTagCategoryNewResponseSchemaFormatCountry  ThreatEventTagCategoryNewResponseSchemaFormat = "country"
)

func (ThreatEventTagCategoryNewResponseSchemaFormat) IsKnown added in v7.10.0 

func (r ThreatEventTagCategoryNewResponseSchemaFormat) IsKnown() bool

type ThreatEventTagCategoryNewResponseSchemaKind added in v7.10.0 

type ThreatEventTagCategoryNewResponseSchemaKind string
const (
	ThreatEventTagCategoryNewResponseSchemaKindString ThreatEventTagCategoryNewResponseSchemaKind = "string"
	ThreatEventTagCategoryNewResponseSchemaKindNumber ThreatEventTagCategoryNewResponseSchemaKind = "number"
	ThreatEventTagCategoryNewResponseSchemaKindEnum   ThreatEventTagCategoryNewResponseSchemaKind = "enum"
	ThreatEventTagCategoryNewResponseSchemaKindDate   ThreatEventTagCategoryNewResponseSchemaKind = "date"
	ThreatEventTagCategoryNewResponseSchemaKindArray  ThreatEventTagCategoryNewResponseSchemaKind = "array"
	ThreatEventTagCategoryNewResponseSchemaKindObject ThreatEventTagCategoryNewResponseSchemaKind = "object"
)

func (ThreatEventTagCategoryNewResponseSchemaKind) IsKnown added in v7.10.0 

func (r ThreatEventTagCategoryNewResponseSchemaKind) IsKnown() bool

type ThreatEventTagCategoryNewResponseSchemaNumberConstraint added in v7.10.0 

type ThreatEventTagCategoryNewResponseSchemaNumberConstraint struct {
	Integer bool                                                        `json:"integer"`
	Max     float64                                                     `json:"max"`
	Min     float64                                                     `json:"min"`
	JSON    threatEventTagCategoryNewResponseSchemaNumberConstraintJSON `json:"-"`
}

func (*ThreatEventTagCategoryNewResponseSchemaNumberConstraint) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagCategoryService added in v7.8.0 

type ThreatEventTagCategoryService struct {
	Options []option.RequestOption
}

ThreatEventTagCategoryService 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 NewThreatEventTagCategoryService method instead.

func NewThreatEventTagCategoryService added in v7.8.0 

func NewThreatEventTagCategoryService(opts ...option.RequestOption) (r *ThreatEventTagCategoryService)

NewThreatEventTagCategoryService 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 (*ThreatEventTagCategoryService) Delete deprecated added in v7.8.0 

func (r *ThreatEventTagCategoryService) Delete(ctx context.Context, categoryUUID string, body ThreatEventTagCategoryDeleteParams, opts ...option.RequestOption) (res *ThreatEventTagCategoryDeleteResponse, err error)

Deprecated; use DELETE /events/tag-categories/{category_uuid}. Available through 2026-11-28.

Deprecated: Use DELETE /events/tag-categories/{category_uuid} before 2026-11-28.

func (*ThreatEventTagCategoryService) Edit deprecated added in v7.8.0 

func (r *ThreatEventTagCategoryService) Edit(ctx context.Context, categoryUUID string, params ThreatEventTagCategoryEditParams, opts ...option.RequestOption) (res *ThreatEventTagCategoryEditResponse, err error)

Deprecated; use PATCH /events/tag-categories/{category_uuid}. Available through 2026-11-28.

Deprecated: Use PATCH /events/tag-categories/{category_uuid} before 2026-11-28.

func (*ThreatEventTagCategoryService) List added in v7.8.0 

func (r *ThreatEventTagCategoryService) List(ctx context.Context, params ThreatEventTagCategoryListParams, opts ...option.RequestOption) (res *ThreatEventTagCategoryListResponse, err error)

Returns all Source-of-Truth tag categories for an account.

func (*ThreatEventTagCategoryService) New added in v7.8.0 

func (r *ThreatEventTagCategoryService) New(ctx context.Context, params ThreatEventTagCategoryNewParams, opts ...option.RequestOption) (res *ThreatEventTagCategoryNewResponse, err error)

Creates a new Source-of-Truth tag category for an account.

type ThreatEventTagDeleteParams added in v7.8.0 

type ThreatEventTagDeleteParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventTagDeleteResponse added in v7.8.0 

type ThreatEventTagDeleteResponse struct {
	UUID string                           `json:"uuid" api:"required"`
	JSON threatEventTagDeleteResponseJSON `json:"-"`
}

func (*ThreatEventTagDeleteResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagEditParams added in v7.8.0 

type ThreatEventTagEditParams struct {
	// Account ID.
	AccountID      param.Field[string]                                      `path:"account_id" api:"required"`
	ActiveDuration param.Field[ThreatEventTagEditParamsActiveDurationUnion] `json:"activeDuration"`
	ActorCategory  param.Field[ThreatEventTagEditParamsActorCategoryUnion]  `json:"actorCategory"`
	// Structured aliases ({ value, confidence 1-10, tlp }). Public: returned to all
	// accounts with per-entry TLP filtering (entries with tlp: purple are removed for
	// non-CFONE accounts).
	Aliases                 param.Field[[]ThreatEventTagEditParamsAlias]                      `json:"aliases"`
	AliasGroupNames         param.Field[[]string]                                             `json:"aliasGroupNames"`
	AliasGroupNamesInternal param.Field[[]string]                                             `json:"aliasGroupNamesInternal"`
	AttributionOrganization param.Field[ThreatEventTagEditParamsAttributionOrganizationUnion] `json:"attributionOrganization"`
	// Tag type (category) UUID. When changed, existing `properties` are re-validated
	// against the new category's schema (400 on mismatch). Set to null to unlink
	// (typeless; properties stop being validated).
	CategoryUUID param.Field[string] `json:"categoryUuid"`
	// Overall tag confidence (1-10). Omit to preserve existing.
	Confidence param.Field[int64] `json:"confidence"`
	// Date of discovery (ISO YYYY-MM-DD). Omit to preserve existing.
	DateOfDiscovery        param.Field[string]   `json:"dateOfDiscovery"`
	Description            param.Field[string]   `json:"description"`
	ExternalReferenceLinks param.Field[[]string] `json:"externalReferenceLinks"`
	// Structured external references ({ url, description }). Public: returned to all
	// accounts.
	ExternalReferences param.Field[[]ThreatEventTagEditParamsExternalReference] `json:"externalReferences"`
	// Owner-private structured aliases ({ value, confidence 1-10, tlp }). Returned to
	// the owning account and omitted from shared-catalog non-owner responses.
	InternalAliases     param.Field[[]ThreatEventTagEditParamsInternalAlias]       `json:"internalAliases"`
	InternalDescription param.Field[string]                                        `json:"internalDescription"`
	LastSeen            param.Field[string]                                        `json:"lastSeen"`
	Motive              param.Field[ThreatEventTagEditParamsMotiveUnion]           `json:"motive"`
	OpsecLevel          param.Field[ThreatEventTagEditParamsOpsecLevelUnion]       `json:"opsecLevel"`
	OriginCountryISO    param.Field[ThreatEventTagEditParamsOriginCountryISOUnion] `json:"originCountryISO"`
	Priority            param.Field[ThreatEventTagEditParamsPriorityUnion]         `json:"priority"`
	// Custom field values blob. When omitted, the existing value is preserved. When
	// provided, performs a shallow per-key merge over the stored value (unmentioned
	// keys are retained). Setting an individual key to null deletes that key.
	// Validation runs against the merged result, so a partial update may omit a
	// schema-required key if the stored value supplies it.
	Properties          param.Field[map[string]interface{}]                           `json:"properties"`
	SophisticationLevel param.Field[ThreatEventTagEditParamsSophisticationLevelUnion] `json:"sophisticationLevel"`
	// Tag-level TLP marking. Omit to preserve existing. Cannot be cleared to null.
	TLP   param.Field[ThreatEventTagEditParamsTLP] `json:"tlp"`
	Value param.Field[string]                      `json:"value"`
}

func (ThreatEventTagEditParams) MarshalJSON added in v7.8.0 

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

type ThreatEventTagEditParamsActiveDurationObject added in v7.10.0 

type ThreatEventTagEditParamsActiveDurationObject struct {
	Value      param.Field[string]                                          `json:"value" api:"required"`
	Confidence param.Field[int64]                                           `json:"confidence"`
	TLP        param.Field[ThreatEventTagEditParamsActiveDurationObjectTLP] `json:"tlp"`
}

func (ThreatEventTagEditParamsActiveDurationObject) ImplementsThreatEventTagEditParamsActiveDurationUnion added in v7.10.0 

func (r ThreatEventTagEditParamsActiveDurationObject) ImplementsThreatEventTagEditParamsActiveDurationUnion()

func (ThreatEventTagEditParamsActiveDurationObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagEditParamsActiveDurationObjectTLP added in v7.10.0 

type ThreatEventTagEditParamsActiveDurationObjectTLP string
const (
	ThreatEventTagEditParamsActiveDurationObjectTLPRed                  ThreatEventTagEditParamsActiveDurationObjectTLP = "red"
	ThreatEventTagEditParamsActiveDurationObjectTLPAmber                ThreatEventTagEditParamsActiveDurationObjectTLP = "amber"
	ThreatEventTagEditParamsActiveDurationObjectTLPAmberStrict          ThreatEventTagEditParamsActiveDurationObjectTLP = "amber-strict"
	ThreatEventTagEditParamsActiveDurationObjectTLPGreen                ThreatEventTagEditParamsActiveDurationObjectTLP = "green"
	ThreatEventTagEditParamsActiveDurationObjectTLPClear                ThreatEventTagEditParamsActiveDurationObjectTLP = "clear"
	ThreatEventTagEditParamsActiveDurationObjectTLPPurple               ThreatEventTagEditParamsActiveDurationObjectTLP = "purple"
	ThreatEventTagEditParamsActiveDurationObjectTLPAmberStrictLowercase ThreatEventTagEditParamsActiveDurationObjectTLP = "amber+strict"
)

func (ThreatEventTagEditParamsActiveDurationObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditParamsActiveDurationObjectTLP) IsKnown() bool

type ThreatEventTagEditParamsActiveDurationUnion added in v7.10.0 

type ThreatEventTagEditParamsActiveDurationUnion interface {
	ImplementsThreatEventTagEditParamsActiveDurationUnion()
}

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagEditParamsActiveDurationObject.

type ThreatEventTagEditParamsActorCategoryObject added in v7.10.0 

type ThreatEventTagEditParamsActorCategoryObject struct {
	Value      param.Field[string]                                         `json:"value" api:"required"`
	Confidence param.Field[int64]                                          `json:"confidence"`
	TLP        param.Field[ThreatEventTagEditParamsActorCategoryObjectTLP] `json:"tlp"`
}

func (ThreatEventTagEditParamsActorCategoryObject) ImplementsThreatEventTagEditParamsActorCategoryUnion added in v7.10.0 

func (r ThreatEventTagEditParamsActorCategoryObject) ImplementsThreatEventTagEditParamsActorCategoryUnion()

func (ThreatEventTagEditParamsActorCategoryObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagEditParamsActorCategoryObjectTLP added in v7.10.0 

type ThreatEventTagEditParamsActorCategoryObjectTLP string
const (
	ThreatEventTagEditParamsActorCategoryObjectTLPRed                  ThreatEventTagEditParamsActorCategoryObjectTLP = "red"
	ThreatEventTagEditParamsActorCategoryObjectTLPAmber                ThreatEventTagEditParamsActorCategoryObjectTLP = "amber"
	ThreatEventTagEditParamsActorCategoryObjectTLPAmberStrict          ThreatEventTagEditParamsActorCategoryObjectTLP = "amber-strict"
	ThreatEventTagEditParamsActorCategoryObjectTLPGreen                ThreatEventTagEditParamsActorCategoryObjectTLP = "green"
	ThreatEventTagEditParamsActorCategoryObjectTLPClear                ThreatEventTagEditParamsActorCategoryObjectTLP = "clear"
	ThreatEventTagEditParamsActorCategoryObjectTLPPurple               ThreatEventTagEditParamsActorCategoryObjectTLP = "purple"
	ThreatEventTagEditParamsActorCategoryObjectTLPAmberStrictLowercase ThreatEventTagEditParamsActorCategoryObjectTLP = "amber+strict"
)

func (ThreatEventTagEditParamsActorCategoryObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditParamsActorCategoryObjectTLP) IsKnown() bool

type ThreatEventTagEditParamsActorCategoryUnion added in v7.10.0 

type ThreatEventTagEditParamsActorCategoryUnion interface {
	ImplementsThreatEventTagEditParamsActorCategoryUnion()
}

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagEditParamsActorCategoryObject.

type ThreatEventTagEditParamsAlias added in v7.8.0 

type ThreatEventTagEditParamsAlias struct {
	Value      param.Field[string]                             `json:"value" api:"required"`
	Confidence param.Field[int64]                              `json:"confidence"`
	TLP        param.Field[ThreatEventTagEditParamsAliasesTLP] `json:"tlp"`
}

func (ThreatEventTagEditParamsAlias) MarshalJSON added in v7.8.0 

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

type ThreatEventTagEditParamsAliasesTLP added in v7.8.0 

type ThreatEventTagEditParamsAliasesTLP string
const (
	ThreatEventTagEditParamsAliasesTLPRed                  ThreatEventTagEditParamsAliasesTLP = "red"
	ThreatEventTagEditParamsAliasesTLPAmber                ThreatEventTagEditParamsAliasesTLP = "amber"
	ThreatEventTagEditParamsAliasesTLPAmberStrict          ThreatEventTagEditParamsAliasesTLP = "amber-strict"
	ThreatEventTagEditParamsAliasesTLPGreen                ThreatEventTagEditParamsAliasesTLP = "green"
	ThreatEventTagEditParamsAliasesTLPClear                ThreatEventTagEditParamsAliasesTLP = "clear"
	ThreatEventTagEditParamsAliasesTLPPurple               ThreatEventTagEditParamsAliasesTLP = "purple"
	ThreatEventTagEditParamsAliasesTLPAmberStrictLowercase ThreatEventTagEditParamsAliasesTLP = "amber+strict"
)

func (ThreatEventTagEditParamsAliasesTLP) IsKnown added in v7.8.0 

func (r ThreatEventTagEditParamsAliasesTLP) IsKnown() bool

type ThreatEventTagEditParamsAttributionOrganizationObject added in v7.10.0 

type ThreatEventTagEditParamsAttributionOrganizationObject struct {
	Value      param.Field[string]                                                   `json:"value" api:"required"`
	Confidence param.Field[int64]                                                    `json:"confidence"`
	TLP        param.Field[ThreatEventTagEditParamsAttributionOrganizationObjectTLP] `json:"tlp"`
}

func (ThreatEventTagEditParamsAttributionOrganizationObject) ImplementsThreatEventTagEditParamsAttributionOrganizationUnion added in v7.10.0 

func (r ThreatEventTagEditParamsAttributionOrganizationObject) ImplementsThreatEventTagEditParamsAttributionOrganizationUnion()

func (ThreatEventTagEditParamsAttributionOrganizationObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagEditParamsAttributionOrganizationObjectTLP added in v7.10.0 

type ThreatEventTagEditParamsAttributionOrganizationObjectTLP string
const (
	ThreatEventTagEditParamsAttributionOrganizationObjectTLPRed                  ThreatEventTagEditParamsAttributionOrganizationObjectTLP = "red"
	ThreatEventTagEditParamsAttributionOrganizationObjectTLPAmber                ThreatEventTagEditParamsAttributionOrganizationObjectTLP = "amber"
	ThreatEventTagEditParamsAttributionOrganizationObjectTLPAmberStrict          ThreatEventTagEditParamsAttributionOrganizationObjectTLP = "amber-strict"
	ThreatEventTagEditParamsAttributionOrganizationObjectTLPGreen                ThreatEventTagEditParamsAttributionOrganizationObjectTLP = "green"
	ThreatEventTagEditParamsAttributionOrganizationObjectTLPClear                ThreatEventTagEditParamsAttributionOrganizationObjectTLP = "clear"
	ThreatEventTagEditParamsAttributionOrganizationObjectTLPPurple               ThreatEventTagEditParamsAttributionOrganizationObjectTLP = "purple"
	ThreatEventTagEditParamsAttributionOrganizationObjectTLPAmberStrictLowercase ThreatEventTagEditParamsAttributionOrganizationObjectTLP = "amber+strict"
)

func (ThreatEventTagEditParamsAttributionOrganizationObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditParamsAttributionOrganizationObjectTLP) IsKnown() bool

type ThreatEventTagEditParamsAttributionOrganizationUnion added in v7.10.0 

type ThreatEventTagEditParamsAttributionOrganizationUnion interface {
	ImplementsThreatEventTagEditParamsAttributionOrganizationUnion()
}

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagEditParamsAttributionOrganizationObject.

type ThreatEventTagEditParamsExternalReference added in v7.8.0 

type ThreatEventTagEditParamsExternalReference struct {
	URL         param.Field[string] `json:"url" api:"required"`
	Description param.Field[string] `json:"description"`
}

func (ThreatEventTagEditParamsExternalReference) MarshalJSON added in v7.8.0 

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

type ThreatEventTagEditParamsInternalAlias added in v7.8.0 

type ThreatEventTagEditParamsInternalAlias struct {
	Value      param.Field[string]                                     `json:"value" api:"required"`
	Confidence param.Field[int64]                                      `json:"confidence"`
	TLP        param.Field[ThreatEventTagEditParamsInternalAliasesTLP] `json:"tlp"`
}

func (ThreatEventTagEditParamsInternalAlias) MarshalJSON added in v7.8.0 

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

type ThreatEventTagEditParamsInternalAliasesTLP added in v7.8.0 

type ThreatEventTagEditParamsInternalAliasesTLP string
const (
	ThreatEventTagEditParamsInternalAliasesTLPRed                  ThreatEventTagEditParamsInternalAliasesTLP = "red"
	ThreatEventTagEditParamsInternalAliasesTLPAmber                ThreatEventTagEditParamsInternalAliasesTLP = "amber"
	ThreatEventTagEditParamsInternalAliasesTLPAmberStrict          ThreatEventTagEditParamsInternalAliasesTLP = "amber-strict"
	ThreatEventTagEditParamsInternalAliasesTLPGreen                ThreatEventTagEditParamsInternalAliasesTLP = "green"
	ThreatEventTagEditParamsInternalAliasesTLPClear                ThreatEventTagEditParamsInternalAliasesTLP = "clear"
	ThreatEventTagEditParamsInternalAliasesTLPPurple               ThreatEventTagEditParamsInternalAliasesTLP = "purple"
	ThreatEventTagEditParamsInternalAliasesTLPAmberStrictLowercase ThreatEventTagEditParamsInternalAliasesTLP = "amber+strict"
)

func (ThreatEventTagEditParamsInternalAliasesTLP) IsKnown added in v7.8.0 

func (r ThreatEventTagEditParamsInternalAliasesTLP) IsKnown() bool

type ThreatEventTagEditParamsMotiveObject added in v7.10.0 

type ThreatEventTagEditParamsMotiveObject struct {
	Value      param.Field[string]                                  `json:"value" api:"required"`
	Confidence param.Field[int64]                                   `json:"confidence"`
	TLP        param.Field[ThreatEventTagEditParamsMotiveObjectTLP] `json:"tlp"`
}

func (ThreatEventTagEditParamsMotiveObject) ImplementsThreatEventTagEditParamsMotiveUnion added in v7.10.0 

func (r ThreatEventTagEditParamsMotiveObject) ImplementsThreatEventTagEditParamsMotiveUnion()

func (ThreatEventTagEditParamsMotiveObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagEditParamsMotiveObjectTLP added in v7.10.0 

type ThreatEventTagEditParamsMotiveObjectTLP string
const (
	ThreatEventTagEditParamsMotiveObjectTLPRed                  ThreatEventTagEditParamsMotiveObjectTLP = "red"
	ThreatEventTagEditParamsMotiveObjectTLPAmber                ThreatEventTagEditParamsMotiveObjectTLP = "amber"
	ThreatEventTagEditParamsMotiveObjectTLPAmberStrict          ThreatEventTagEditParamsMotiveObjectTLP = "amber-strict"
	ThreatEventTagEditParamsMotiveObjectTLPGreen                ThreatEventTagEditParamsMotiveObjectTLP = "green"
	ThreatEventTagEditParamsMotiveObjectTLPClear                ThreatEventTagEditParamsMotiveObjectTLP = "clear"
	ThreatEventTagEditParamsMotiveObjectTLPPurple               ThreatEventTagEditParamsMotiveObjectTLP = "purple"
	ThreatEventTagEditParamsMotiveObjectTLPAmberStrictLowercase ThreatEventTagEditParamsMotiveObjectTLP = "amber+strict"
)

func (ThreatEventTagEditParamsMotiveObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditParamsMotiveObjectTLP) IsKnown() bool

type ThreatEventTagEditParamsMotiveUnion added in v7.10.0 

type ThreatEventTagEditParamsMotiveUnion interface {
	ImplementsThreatEventTagEditParamsMotiveUnion()
}

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagEditParamsMotiveObject.

type ThreatEventTagEditParamsOpsecLevelObject added in v7.10.0 

type ThreatEventTagEditParamsOpsecLevelObject struct {
	Value      param.Field[string]                                      `json:"value" api:"required"`
	Confidence param.Field[int64]                                       `json:"confidence"`
	TLP        param.Field[ThreatEventTagEditParamsOpsecLevelObjectTLP] `json:"tlp"`
}

func (ThreatEventTagEditParamsOpsecLevelObject) ImplementsThreatEventTagEditParamsOpsecLevelUnion added in v7.10.0 

func (r ThreatEventTagEditParamsOpsecLevelObject) ImplementsThreatEventTagEditParamsOpsecLevelUnion()

func (ThreatEventTagEditParamsOpsecLevelObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagEditParamsOpsecLevelObjectTLP added in v7.10.0 

type ThreatEventTagEditParamsOpsecLevelObjectTLP string
const (
	ThreatEventTagEditParamsOpsecLevelObjectTLPRed                  ThreatEventTagEditParamsOpsecLevelObjectTLP = "red"
	ThreatEventTagEditParamsOpsecLevelObjectTLPAmber                ThreatEventTagEditParamsOpsecLevelObjectTLP = "amber"
	ThreatEventTagEditParamsOpsecLevelObjectTLPAmberStrict          ThreatEventTagEditParamsOpsecLevelObjectTLP = "amber-strict"
	ThreatEventTagEditParamsOpsecLevelObjectTLPGreen                ThreatEventTagEditParamsOpsecLevelObjectTLP = "green"
	ThreatEventTagEditParamsOpsecLevelObjectTLPClear                ThreatEventTagEditParamsOpsecLevelObjectTLP = "clear"
	ThreatEventTagEditParamsOpsecLevelObjectTLPPurple               ThreatEventTagEditParamsOpsecLevelObjectTLP = "purple"
	ThreatEventTagEditParamsOpsecLevelObjectTLPAmberStrictLowercase ThreatEventTagEditParamsOpsecLevelObjectTLP = "amber+strict"
)

func (ThreatEventTagEditParamsOpsecLevelObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditParamsOpsecLevelObjectTLP) IsKnown() bool

type ThreatEventTagEditParamsOpsecLevelUnion added in v7.10.0 

type ThreatEventTagEditParamsOpsecLevelUnion interface {
	ImplementsThreatEventTagEditParamsOpsecLevelUnion()
}

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagEditParamsOpsecLevelObject.

type ThreatEventTagEditParamsOriginCountryISOObject added in v7.10.0 

type ThreatEventTagEditParamsOriginCountryISOObject struct {
	Value      param.Field[string]                                            `json:"value" api:"required"`
	Confidence param.Field[int64]                                             `json:"confidence"`
	TLP        param.Field[ThreatEventTagEditParamsOriginCountryISOObjectTLP] `json:"tlp"`
}

func (ThreatEventTagEditParamsOriginCountryISOObject) ImplementsThreatEventTagEditParamsOriginCountryISOUnion added in v7.10.0 

func (r ThreatEventTagEditParamsOriginCountryISOObject) ImplementsThreatEventTagEditParamsOriginCountryISOUnion()

func (ThreatEventTagEditParamsOriginCountryISOObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagEditParamsOriginCountryISOObjectTLP added in v7.10.0 

type ThreatEventTagEditParamsOriginCountryISOObjectTLP string
const (
	ThreatEventTagEditParamsOriginCountryISOObjectTLPRed                  ThreatEventTagEditParamsOriginCountryISOObjectTLP = "red"
	ThreatEventTagEditParamsOriginCountryISOObjectTLPAmber                ThreatEventTagEditParamsOriginCountryISOObjectTLP = "amber"
	ThreatEventTagEditParamsOriginCountryISOObjectTLPAmberStrict          ThreatEventTagEditParamsOriginCountryISOObjectTLP = "amber-strict"
	ThreatEventTagEditParamsOriginCountryISOObjectTLPGreen                ThreatEventTagEditParamsOriginCountryISOObjectTLP = "green"
	ThreatEventTagEditParamsOriginCountryISOObjectTLPClear                ThreatEventTagEditParamsOriginCountryISOObjectTLP = "clear"
	ThreatEventTagEditParamsOriginCountryISOObjectTLPPurple               ThreatEventTagEditParamsOriginCountryISOObjectTLP = "purple"
	ThreatEventTagEditParamsOriginCountryISOObjectTLPAmberStrictLowercase ThreatEventTagEditParamsOriginCountryISOObjectTLP = "amber+strict"
)

func (ThreatEventTagEditParamsOriginCountryISOObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditParamsOriginCountryISOObjectTLP) IsKnown() bool

type ThreatEventTagEditParamsOriginCountryISOUnion added in v7.10.0 

type ThreatEventTagEditParamsOriginCountryISOUnion interface {
	ImplementsThreatEventTagEditParamsOriginCountryISOUnion()
}

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagEditParamsOriginCountryISOObject.

type ThreatEventTagEditParamsPriorityObject added in v7.10.0 

type ThreatEventTagEditParamsPriorityObject struct {
	Value      param.Field[float64]                                   `json:"value" api:"required"`
	Confidence param.Field[int64]                                     `json:"confidence"`
	TLP        param.Field[ThreatEventTagEditParamsPriorityObjectTLP] `json:"tlp"`
}

func (ThreatEventTagEditParamsPriorityObject) ImplementsThreatEventTagEditParamsPriorityUnion added in v7.10.0 

func (r ThreatEventTagEditParamsPriorityObject) ImplementsThreatEventTagEditParamsPriorityUnion()

func (ThreatEventTagEditParamsPriorityObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagEditParamsPriorityObjectTLP added in v7.10.0 

type ThreatEventTagEditParamsPriorityObjectTLP string
const (
	ThreatEventTagEditParamsPriorityObjectTLPRed                  ThreatEventTagEditParamsPriorityObjectTLP = "red"
	ThreatEventTagEditParamsPriorityObjectTLPAmber                ThreatEventTagEditParamsPriorityObjectTLP = "amber"
	ThreatEventTagEditParamsPriorityObjectTLPAmberStrict          ThreatEventTagEditParamsPriorityObjectTLP = "amber-strict"
	ThreatEventTagEditParamsPriorityObjectTLPGreen                ThreatEventTagEditParamsPriorityObjectTLP = "green"
	ThreatEventTagEditParamsPriorityObjectTLPClear                ThreatEventTagEditParamsPriorityObjectTLP = "clear"
	ThreatEventTagEditParamsPriorityObjectTLPPurple               ThreatEventTagEditParamsPriorityObjectTLP = "purple"
	ThreatEventTagEditParamsPriorityObjectTLPAmberStrictLowercase ThreatEventTagEditParamsPriorityObjectTLP = "amber+strict"
)

func (ThreatEventTagEditParamsPriorityObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditParamsPriorityObjectTLP) IsKnown() bool

type ThreatEventTagEditParamsPriorityUnion added in v7.10.0 

type ThreatEventTagEditParamsPriorityUnion interface {
	ImplementsThreatEventTagEditParamsPriorityUnion()
}

Satisfied by shared.UnionFloat, cloudforce_one.ThreatEventTagEditParamsPriorityObject.

type ThreatEventTagEditParamsSophisticationLevelObject added in v7.10.0 

type ThreatEventTagEditParamsSophisticationLevelObject struct {
	Value      param.Field[string]                                               `json:"value" api:"required"`
	Confidence param.Field[int64]                                                `json:"confidence"`
	TLP        param.Field[ThreatEventTagEditParamsSophisticationLevelObjectTLP] `json:"tlp"`
}

func (ThreatEventTagEditParamsSophisticationLevelObject) ImplementsThreatEventTagEditParamsSophisticationLevelUnion added in v7.10.0 

func (r ThreatEventTagEditParamsSophisticationLevelObject) ImplementsThreatEventTagEditParamsSophisticationLevelUnion()

func (ThreatEventTagEditParamsSophisticationLevelObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagEditParamsSophisticationLevelObjectTLP added in v7.10.0 

type ThreatEventTagEditParamsSophisticationLevelObjectTLP string
const (
	ThreatEventTagEditParamsSophisticationLevelObjectTLPRed                  ThreatEventTagEditParamsSophisticationLevelObjectTLP = "red"
	ThreatEventTagEditParamsSophisticationLevelObjectTLPAmber                ThreatEventTagEditParamsSophisticationLevelObjectTLP = "amber"
	ThreatEventTagEditParamsSophisticationLevelObjectTLPAmberStrict          ThreatEventTagEditParamsSophisticationLevelObjectTLP = "amber-strict"
	ThreatEventTagEditParamsSophisticationLevelObjectTLPGreen                ThreatEventTagEditParamsSophisticationLevelObjectTLP = "green"
	ThreatEventTagEditParamsSophisticationLevelObjectTLPClear                ThreatEventTagEditParamsSophisticationLevelObjectTLP = "clear"
	ThreatEventTagEditParamsSophisticationLevelObjectTLPPurple               ThreatEventTagEditParamsSophisticationLevelObjectTLP = "purple"
	ThreatEventTagEditParamsSophisticationLevelObjectTLPAmberStrictLowercase ThreatEventTagEditParamsSophisticationLevelObjectTLP = "amber+strict"
)

func (ThreatEventTagEditParamsSophisticationLevelObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditParamsSophisticationLevelObjectTLP) IsKnown() bool

type ThreatEventTagEditParamsSophisticationLevelUnion added in v7.10.0 

type ThreatEventTagEditParamsSophisticationLevelUnion interface {
	ImplementsThreatEventTagEditParamsSophisticationLevelUnion()
}

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagEditParamsSophisticationLevelObject.

type ThreatEventTagEditParamsTLP added in v7.10.0 

type ThreatEventTagEditParamsTLP string

Tag-level TLP marking. Omit to preserve existing. Cannot be cleared to null. 

const (
	ThreatEventTagEditParamsTLPRed                  ThreatEventTagEditParamsTLP = "red"
	ThreatEventTagEditParamsTLPAmber                ThreatEventTagEditParamsTLP = "amber"
	ThreatEventTagEditParamsTLPAmberStrict          ThreatEventTagEditParamsTLP = "amber-strict"
	ThreatEventTagEditParamsTLPGreen                ThreatEventTagEditParamsTLP = "green"
	ThreatEventTagEditParamsTLPClear                ThreatEventTagEditParamsTLP = "clear"
	ThreatEventTagEditParamsTLPPurple               ThreatEventTagEditParamsTLP = "purple"
	ThreatEventTagEditParamsTLPAmberStrictLowercase ThreatEventTagEditParamsTLP = "amber+strict"
)

func (ThreatEventTagEditParamsTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditParamsTLP) IsKnown() bool

type ThreatEventTagEditResponse added in v7.8.0 

type ThreatEventTagEditResponse struct {
	UUID                    string                                            `json:"uuid" api:"required"`
	Value                   string                                            `json:"value" api:"required"`
	ActiveDuration          string                                            `json:"activeDuration"`
	ActiveDurationAnnotated ThreatEventTagEditResponseActiveDurationAnnotated `json:"activeDuration_annotated" api:"nullable"`
	ActorCategory           string                                            `json:"actorCategory"`
	ActorCategoryAnnotated  ThreatEventTagEditResponseActorCategoryAnnotated  `json:"actorCategory_annotated" api:"nullable"`
	// Structured aliases ({ value, confidence 1-10, tlp }). Public: returned to all
	// accounts with per-entry TLP filtering (entries with tlp: purple are removed for
	// non-CFONE accounts).
	Aliases                          []ThreatEventTagEditResponseAlias                          `json:"aliases"`
	AliasGroupNames                  []string                                                   `json:"aliasGroupNames"`
	AliasGroupNamesInternal          []string                                                   `json:"aliasGroupNamesInternal"`
	AttributionOrganization          string                                                     `json:"attributionOrganization"`
	AttributionOrganizationAnnotated ThreatEventTagEditResponseAttributionOrganizationAnnotated `json:"attributionOrganization_annotated" api:"nullable"`
	CategoryName                     string                                                     `json:"categoryName"`
	CategoryUUID                     string                                                     `json:"categoryUuid"`
	// Overall tag confidence (1-10).
	Confidence             int64    `json:"confidence" api:"nullable"`
	CreatedAt              string   `json:"createdAt"`
	DateOfDiscovery        string   `json:"dateOfDiscovery"`
	Description            string   `json:"description"`
	ExternalReferenceLinks []string `json:"externalReferenceLinks"`
	// Structured external references ({ url, description }). Public: returned to all
	// accounts.
	ExternalReferences          []ThreatEventTagEditResponseExternalReference           `json:"externalReferences"`
	ExternalReferencesAnnotated []ThreatEventTagEditResponseExternalReferencesAnnotated `json:"externalReferences_annotated" api:"nullable"`
	// Owner-private structured aliases ({ value, confidence 1-10, tlp }). Returned to
	// the owning account and omitted from shared-catalog non-owner responses.
	InternalAliases     []ThreatEventTagEditResponseInternalAlias     `json:"internalAliases"`
	InternalDescription string                                        `json:"internalDescription"`
	LastSeen            string                                        `json:"lastSeen"`
	Motive              string                                        `json:"motive"`
	MotiveAnnotated     ThreatEventTagEditResponseMotiveAnnotated     `json:"motive_annotated" api:"nullable"`
	OpsecLevel          string                                        `json:"opsecLevel"`
	OpsecLevelAnnotated ThreatEventTagEditResponseOpsecLevelAnnotated `json:"opsecLevel_annotated" api:"nullable"`
	// ISO country code (alpha-2 or alpha-3). Normalized to uppercase on read. Null
	// when stored value is blank/whitespace.
	OriginCountryISO          string                                              `json:"originCountryISO" api:"nullable"`
	OriginCountryISOAnnotated ThreatEventTagEditResponseOriginCountryISOAnnotated `json:"originCountryISO_annotated" api:"nullable"`
	Priority                  float64                                             `json:"priority"`
	PriorityAnnotated         ThreatEventTagEditResponsePriorityAnnotated         `json:"priority_annotated" api:"nullable"`
	// Parsed custom field values. Null when the tag has no custom fields.
	Properties                   map[string]interface{}                                 `json:"properties" api:"nullable"`
	SophisticationLevel          string                                                 `json:"sophisticationLevel"`
	SophisticationLevelAnnotated ThreatEventTagEditResponseSophisticationLevelAnnotated `json:"sophisticationLevel_annotated" api:"nullable"`
	// Tag-level TLP handling marking.
	TLP       ThreatEventTagEditResponseTLP  `json:"tlp" api:"nullable"`
	UpdatedAt string                         `json:"updatedAt"`
	Version   float64                        `json:"version"`
	JSON      threatEventTagEditResponseJSON `json:"-"`
}

func (*ThreatEventTagEditResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagEditResponseActiveDurationAnnotated added in v7.10.0 

type ThreatEventTagEditResponseActiveDurationAnnotated struct {
	Value string                                                `json:"value" api:"required"`
	TLP   ThreatEventTagEditResponseActiveDurationAnnotatedTLP  `json:"tlp"`
	JSON  threatEventTagEditResponseActiveDurationAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagEditResponseActiveDurationAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagEditResponseActiveDurationAnnotatedTLP added in v7.10.0 

type ThreatEventTagEditResponseActiveDurationAnnotatedTLP string
const (
	ThreatEventTagEditResponseActiveDurationAnnotatedTLPRed                  ThreatEventTagEditResponseActiveDurationAnnotatedTLP = "red"
	ThreatEventTagEditResponseActiveDurationAnnotatedTLPAmber                ThreatEventTagEditResponseActiveDurationAnnotatedTLP = "amber"
	ThreatEventTagEditResponseActiveDurationAnnotatedTLPAmberStrict          ThreatEventTagEditResponseActiveDurationAnnotatedTLP = "amber-strict"
	ThreatEventTagEditResponseActiveDurationAnnotatedTLPGreen                ThreatEventTagEditResponseActiveDurationAnnotatedTLP = "green"
	ThreatEventTagEditResponseActiveDurationAnnotatedTLPClear                ThreatEventTagEditResponseActiveDurationAnnotatedTLP = "clear"
	ThreatEventTagEditResponseActiveDurationAnnotatedTLPPurple               ThreatEventTagEditResponseActiveDurationAnnotatedTLP = "purple"
	ThreatEventTagEditResponseActiveDurationAnnotatedTLPAmberStrictLowercase ThreatEventTagEditResponseActiveDurationAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagEditResponseActiveDurationAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditResponseActiveDurationAnnotatedTLP) IsKnown() bool

type ThreatEventTagEditResponseActorCategoryAnnotated added in v7.10.0 

type ThreatEventTagEditResponseActorCategoryAnnotated struct {
	Value      string                                               `json:"value" api:"required"`
	Confidence float64                                              `json:"confidence"`
	TLP        ThreatEventTagEditResponseActorCategoryAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagEditResponseActorCategoryAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagEditResponseActorCategoryAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagEditResponseActorCategoryAnnotatedTLP added in v7.10.0 

type ThreatEventTagEditResponseActorCategoryAnnotatedTLP string
const (
	ThreatEventTagEditResponseActorCategoryAnnotatedTLPRed                  ThreatEventTagEditResponseActorCategoryAnnotatedTLP = "red"
	ThreatEventTagEditResponseActorCategoryAnnotatedTLPAmber                ThreatEventTagEditResponseActorCategoryAnnotatedTLP = "amber"
	ThreatEventTagEditResponseActorCategoryAnnotatedTLPAmberStrict          ThreatEventTagEditResponseActorCategoryAnnotatedTLP = "amber-strict"
	ThreatEventTagEditResponseActorCategoryAnnotatedTLPGreen                ThreatEventTagEditResponseActorCategoryAnnotatedTLP = "green"
	ThreatEventTagEditResponseActorCategoryAnnotatedTLPClear                ThreatEventTagEditResponseActorCategoryAnnotatedTLP = "clear"
	ThreatEventTagEditResponseActorCategoryAnnotatedTLPPurple               ThreatEventTagEditResponseActorCategoryAnnotatedTLP = "purple"
	ThreatEventTagEditResponseActorCategoryAnnotatedTLPAmberStrictLowercase ThreatEventTagEditResponseActorCategoryAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagEditResponseActorCategoryAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditResponseActorCategoryAnnotatedTLP) IsKnown() bool

type ThreatEventTagEditResponseAlias added in v7.8.0 

type ThreatEventTagEditResponseAlias struct {
	Value      string                               `json:"value" api:"required"`
	Confidence int64                                `json:"confidence" api:"nullable"`
	TLP        ThreatEventTagEditResponseAliasesTLP `json:"tlp" api:"nullable"`
	JSON       threatEventTagEditResponseAliasJSON  `json:"-"`
}

func (*ThreatEventTagEditResponseAlias) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagEditResponseAliasesTLP added in v7.8.0 

type ThreatEventTagEditResponseAliasesTLP string
const (
	ThreatEventTagEditResponseAliasesTLPRed                  ThreatEventTagEditResponseAliasesTLP = "red"
	ThreatEventTagEditResponseAliasesTLPAmber                ThreatEventTagEditResponseAliasesTLP = "amber"
	ThreatEventTagEditResponseAliasesTLPAmberStrict          ThreatEventTagEditResponseAliasesTLP = "amber-strict"
	ThreatEventTagEditResponseAliasesTLPGreen                ThreatEventTagEditResponseAliasesTLP = "green"
	ThreatEventTagEditResponseAliasesTLPClear                ThreatEventTagEditResponseAliasesTLP = "clear"
	ThreatEventTagEditResponseAliasesTLPPurple               ThreatEventTagEditResponseAliasesTLP = "purple"
	ThreatEventTagEditResponseAliasesTLPAmberStrictLowercase ThreatEventTagEditResponseAliasesTLP = "amber+strict"
)

func (ThreatEventTagEditResponseAliasesTLP) IsKnown added in v7.8.0 

func (r ThreatEventTagEditResponseAliasesTLP) IsKnown() bool

type ThreatEventTagEditResponseAttributionOrganizationAnnotated added in v7.10.0 

type ThreatEventTagEditResponseAttributionOrganizationAnnotated struct {
	Value      string                                                         `json:"value" api:"required"`
	Confidence float64                                                        `json:"confidence"`
	TLP        ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagEditResponseAttributionOrganizationAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagEditResponseAttributionOrganizationAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLP added in v7.10.0 

type ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLP string
const (
	ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLPRed                  ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLP = "red"
	ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLPAmber                ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLP = "amber"
	ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLPAmberStrict          ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLP = "amber-strict"
	ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLPGreen                ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLP = "green"
	ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLPClear                ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLP = "clear"
	ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLPPurple               ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLP = "purple"
	ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLPAmberStrictLowercase ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditResponseAttributionOrganizationAnnotatedTLP) IsKnown() bool

type ThreatEventTagEditResponseExternalReference added in v7.8.0 

type ThreatEventTagEditResponseExternalReference struct {
	URL         string                                          `json:"url" api:"required"`
	Description string                                          `json:"description" api:"nullable"`
	JSON        threatEventTagEditResponseExternalReferenceJSON `json:"-"`
}

func (*ThreatEventTagEditResponseExternalReference) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagEditResponseExternalReferencesAnnotated added in v7.10.0 

type ThreatEventTagEditResponseExternalReferencesAnnotated struct {
	Value string                                                    `json:"value" api:"required"`
	TLP   ThreatEventTagEditResponseExternalReferencesAnnotatedTLP  `json:"tlp"`
	JSON  threatEventTagEditResponseExternalReferencesAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagEditResponseExternalReferencesAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagEditResponseExternalReferencesAnnotatedTLP added in v7.10.0 

type ThreatEventTagEditResponseExternalReferencesAnnotatedTLP string
const (
	ThreatEventTagEditResponseExternalReferencesAnnotatedTLPRed                  ThreatEventTagEditResponseExternalReferencesAnnotatedTLP = "red"
	ThreatEventTagEditResponseExternalReferencesAnnotatedTLPAmber                ThreatEventTagEditResponseExternalReferencesAnnotatedTLP = "amber"
	ThreatEventTagEditResponseExternalReferencesAnnotatedTLPAmberStrict          ThreatEventTagEditResponseExternalReferencesAnnotatedTLP = "amber-strict"
	ThreatEventTagEditResponseExternalReferencesAnnotatedTLPGreen                ThreatEventTagEditResponseExternalReferencesAnnotatedTLP = "green"
	ThreatEventTagEditResponseExternalReferencesAnnotatedTLPClear                ThreatEventTagEditResponseExternalReferencesAnnotatedTLP = "clear"
	ThreatEventTagEditResponseExternalReferencesAnnotatedTLPPurple               ThreatEventTagEditResponseExternalReferencesAnnotatedTLP = "purple"
	ThreatEventTagEditResponseExternalReferencesAnnotatedTLPAmberStrictLowercase ThreatEventTagEditResponseExternalReferencesAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagEditResponseExternalReferencesAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditResponseExternalReferencesAnnotatedTLP) IsKnown() bool

type ThreatEventTagEditResponseInternalAlias added in v7.8.0 

type ThreatEventTagEditResponseInternalAlias struct {
	Value      string                                       `json:"value" api:"required"`
	Confidence int64                                        `json:"confidence" api:"nullable"`
	TLP        ThreatEventTagEditResponseInternalAliasesTLP `json:"tlp" api:"nullable"`
	JSON       threatEventTagEditResponseInternalAliasJSON  `json:"-"`
}

func (*ThreatEventTagEditResponseInternalAlias) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagEditResponseInternalAliasesTLP added in v7.8.0 

type ThreatEventTagEditResponseInternalAliasesTLP string
const (
	ThreatEventTagEditResponseInternalAliasesTLPRed                  ThreatEventTagEditResponseInternalAliasesTLP = "red"
	ThreatEventTagEditResponseInternalAliasesTLPAmber                ThreatEventTagEditResponseInternalAliasesTLP = "amber"
	ThreatEventTagEditResponseInternalAliasesTLPAmberStrict          ThreatEventTagEditResponseInternalAliasesTLP = "amber-strict"
	ThreatEventTagEditResponseInternalAliasesTLPGreen                ThreatEventTagEditResponseInternalAliasesTLP = "green"
	ThreatEventTagEditResponseInternalAliasesTLPClear                ThreatEventTagEditResponseInternalAliasesTLP = "clear"
	ThreatEventTagEditResponseInternalAliasesTLPPurple               ThreatEventTagEditResponseInternalAliasesTLP = "purple"
	ThreatEventTagEditResponseInternalAliasesTLPAmberStrictLowercase ThreatEventTagEditResponseInternalAliasesTLP = "amber+strict"
)

func (ThreatEventTagEditResponseInternalAliasesTLP) IsKnown added in v7.8.0 

func (r ThreatEventTagEditResponseInternalAliasesTLP) IsKnown() bool

type ThreatEventTagEditResponseMotiveAnnotated added in v7.10.0 

type ThreatEventTagEditResponseMotiveAnnotated struct {
	Value      string                                        `json:"value" api:"required"`
	Confidence float64                                       `json:"confidence"`
	TLP        ThreatEventTagEditResponseMotiveAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagEditResponseMotiveAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagEditResponseMotiveAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagEditResponseMotiveAnnotatedTLP added in v7.10.0 

type ThreatEventTagEditResponseMotiveAnnotatedTLP string
const (
	ThreatEventTagEditResponseMotiveAnnotatedTLPRed                  ThreatEventTagEditResponseMotiveAnnotatedTLP = "red"
	ThreatEventTagEditResponseMotiveAnnotatedTLPAmber                ThreatEventTagEditResponseMotiveAnnotatedTLP = "amber"
	ThreatEventTagEditResponseMotiveAnnotatedTLPAmberStrict          ThreatEventTagEditResponseMotiveAnnotatedTLP = "amber-strict"
	ThreatEventTagEditResponseMotiveAnnotatedTLPGreen                ThreatEventTagEditResponseMotiveAnnotatedTLP = "green"
	ThreatEventTagEditResponseMotiveAnnotatedTLPClear                ThreatEventTagEditResponseMotiveAnnotatedTLP = "clear"
	ThreatEventTagEditResponseMotiveAnnotatedTLPPurple               ThreatEventTagEditResponseMotiveAnnotatedTLP = "purple"
	ThreatEventTagEditResponseMotiveAnnotatedTLPAmberStrictLowercase ThreatEventTagEditResponseMotiveAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagEditResponseMotiveAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditResponseMotiveAnnotatedTLP) IsKnown() bool

type ThreatEventTagEditResponseOpsecLevelAnnotated added in v7.10.0 

type ThreatEventTagEditResponseOpsecLevelAnnotated struct {
	Value      string                                            `json:"value" api:"required"`
	Confidence float64                                           `json:"confidence"`
	TLP        ThreatEventTagEditResponseOpsecLevelAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagEditResponseOpsecLevelAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagEditResponseOpsecLevelAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagEditResponseOpsecLevelAnnotatedTLP added in v7.10.0 

type ThreatEventTagEditResponseOpsecLevelAnnotatedTLP string
const (
	ThreatEventTagEditResponseOpsecLevelAnnotatedTLPRed                  ThreatEventTagEditResponseOpsecLevelAnnotatedTLP = "red"
	ThreatEventTagEditResponseOpsecLevelAnnotatedTLPAmber                ThreatEventTagEditResponseOpsecLevelAnnotatedTLP = "amber"
	ThreatEventTagEditResponseOpsecLevelAnnotatedTLPAmberStrict          ThreatEventTagEditResponseOpsecLevelAnnotatedTLP = "amber-strict"
	ThreatEventTagEditResponseOpsecLevelAnnotatedTLPGreen                ThreatEventTagEditResponseOpsecLevelAnnotatedTLP = "green"
	ThreatEventTagEditResponseOpsecLevelAnnotatedTLPClear                ThreatEventTagEditResponseOpsecLevelAnnotatedTLP = "clear"
	ThreatEventTagEditResponseOpsecLevelAnnotatedTLPPurple               ThreatEventTagEditResponseOpsecLevelAnnotatedTLP = "purple"
	ThreatEventTagEditResponseOpsecLevelAnnotatedTLPAmberStrictLowercase ThreatEventTagEditResponseOpsecLevelAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagEditResponseOpsecLevelAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditResponseOpsecLevelAnnotatedTLP) IsKnown() bool

type ThreatEventTagEditResponseOriginCountryISOAnnotated added in v7.10.0 

type ThreatEventTagEditResponseOriginCountryISOAnnotated struct {
	Value      string                                                  `json:"value" api:"required,nullable"`
	Confidence float64                                                 `json:"confidence"`
	TLP        ThreatEventTagEditResponseOriginCountryISOAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagEditResponseOriginCountryISOAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagEditResponseOriginCountryISOAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagEditResponseOriginCountryISOAnnotatedTLP added in v7.10.0 

type ThreatEventTagEditResponseOriginCountryISOAnnotatedTLP string
const (
	ThreatEventTagEditResponseOriginCountryISOAnnotatedTLPRed                  ThreatEventTagEditResponseOriginCountryISOAnnotatedTLP = "red"
	ThreatEventTagEditResponseOriginCountryISOAnnotatedTLPAmber                ThreatEventTagEditResponseOriginCountryISOAnnotatedTLP = "amber"
	ThreatEventTagEditResponseOriginCountryISOAnnotatedTLPAmberStrict          ThreatEventTagEditResponseOriginCountryISOAnnotatedTLP = "amber-strict"
	ThreatEventTagEditResponseOriginCountryISOAnnotatedTLPGreen                ThreatEventTagEditResponseOriginCountryISOAnnotatedTLP = "green"
	ThreatEventTagEditResponseOriginCountryISOAnnotatedTLPClear                ThreatEventTagEditResponseOriginCountryISOAnnotatedTLP = "clear"
	ThreatEventTagEditResponseOriginCountryISOAnnotatedTLPPurple               ThreatEventTagEditResponseOriginCountryISOAnnotatedTLP = "purple"
	ThreatEventTagEditResponseOriginCountryISOAnnotatedTLPAmberStrictLowercase ThreatEventTagEditResponseOriginCountryISOAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagEditResponseOriginCountryISOAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditResponseOriginCountryISOAnnotatedTLP) IsKnown() bool

type ThreatEventTagEditResponsePriorityAnnotated added in v7.10.0 

type ThreatEventTagEditResponsePriorityAnnotated struct {
	Value float64                                         `json:"value" api:"required"`
	TLP   ThreatEventTagEditResponsePriorityAnnotatedTLP  `json:"tlp"`
	JSON  threatEventTagEditResponsePriorityAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagEditResponsePriorityAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagEditResponsePriorityAnnotatedTLP added in v7.10.0 

type ThreatEventTagEditResponsePriorityAnnotatedTLP string
const (
	ThreatEventTagEditResponsePriorityAnnotatedTLPRed                  ThreatEventTagEditResponsePriorityAnnotatedTLP = "red"
	ThreatEventTagEditResponsePriorityAnnotatedTLPAmber                ThreatEventTagEditResponsePriorityAnnotatedTLP = "amber"
	ThreatEventTagEditResponsePriorityAnnotatedTLPAmberStrict          ThreatEventTagEditResponsePriorityAnnotatedTLP = "amber-strict"
	ThreatEventTagEditResponsePriorityAnnotatedTLPGreen                ThreatEventTagEditResponsePriorityAnnotatedTLP = "green"
	ThreatEventTagEditResponsePriorityAnnotatedTLPClear                ThreatEventTagEditResponsePriorityAnnotatedTLP = "clear"
	ThreatEventTagEditResponsePriorityAnnotatedTLPPurple               ThreatEventTagEditResponsePriorityAnnotatedTLP = "purple"
	ThreatEventTagEditResponsePriorityAnnotatedTLPAmberStrictLowercase ThreatEventTagEditResponsePriorityAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagEditResponsePriorityAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditResponsePriorityAnnotatedTLP) IsKnown() bool

type ThreatEventTagEditResponseSophisticationLevelAnnotated added in v7.10.0 

type ThreatEventTagEditResponseSophisticationLevelAnnotated struct {
	Value      string                                                     `json:"value" api:"required"`
	Confidence float64                                                    `json:"confidence"`
	TLP        ThreatEventTagEditResponseSophisticationLevelAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagEditResponseSophisticationLevelAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagEditResponseSophisticationLevelAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagEditResponseSophisticationLevelAnnotatedTLP added in v7.10.0 

type ThreatEventTagEditResponseSophisticationLevelAnnotatedTLP string
const (
	ThreatEventTagEditResponseSophisticationLevelAnnotatedTLPRed                  ThreatEventTagEditResponseSophisticationLevelAnnotatedTLP = "red"
	ThreatEventTagEditResponseSophisticationLevelAnnotatedTLPAmber                ThreatEventTagEditResponseSophisticationLevelAnnotatedTLP = "amber"
	ThreatEventTagEditResponseSophisticationLevelAnnotatedTLPAmberStrict          ThreatEventTagEditResponseSophisticationLevelAnnotatedTLP = "amber-strict"
	ThreatEventTagEditResponseSophisticationLevelAnnotatedTLPGreen                ThreatEventTagEditResponseSophisticationLevelAnnotatedTLP = "green"
	ThreatEventTagEditResponseSophisticationLevelAnnotatedTLPClear                ThreatEventTagEditResponseSophisticationLevelAnnotatedTLP = "clear"
	ThreatEventTagEditResponseSophisticationLevelAnnotatedTLPPurple               ThreatEventTagEditResponseSophisticationLevelAnnotatedTLP = "purple"
	ThreatEventTagEditResponseSophisticationLevelAnnotatedTLPAmberStrictLowercase ThreatEventTagEditResponseSophisticationLevelAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagEditResponseSophisticationLevelAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditResponseSophisticationLevelAnnotatedTLP) IsKnown() bool

type ThreatEventTagEditResponseTLP added in v7.10.0 

type ThreatEventTagEditResponseTLP string

Tag-level TLP handling marking. 

const (
	ThreatEventTagEditResponseTLPRed                  ThreatEventTagEditResponseTLP = "red"
	ThreatEventTagEditResponseTLPAmber                ThreatEventTagEditResponseTLP = "amber"
	ThreatEventTagEditResponseTLPAmberStrict          ThreatEventTagEditResponseTLP = "amber-strict"
	ThreatEventTagEditResponseTLPGreen                ThreatEventTagEditResponseTLP = "green"
	ThreatEventTagEditResponseTLPClear                ThreatEventTagEditResponseTLP = "clear"
	ThreatEventTagEditResponseTLPPurple               ThreatEventTagEditResponseTLP = "purple"
	ThreatEventTagEditResponseTLPAmberStrictLowercase ThreatEventTagEditResponseTLP = "amber+strict"
)

func (ThreatEventTagEditResponseTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagEditResponseTLP) IsKnown() bool

type ThreatEventTagIndicatorByDatasetListParams added in v7.8.0 

type ThreatEventTagIndicatorByDatasetListParams struct {
	// Account ID.
	AccountID     param.Field[string]  `path:"account_id" api:"required"`
	IndicatorType param.Field[string]  `query:"indicatorType"`
	Page          param.Field[float64] `query:"page"`
	PageSize      param.Field[float64] `query:"pageSize"`
	// Filter indicators by related event UUID(s). Multiple UUIDs can be provided by
	// repeating the parameter.
	RelatedEvent param.Field[[]string] `query:"relatedEvent"`
	// Structured search as a JSON array of {field, op, value} objects. Searchable
	// fields: value, indicatorType. Multiple conditions are AND'd together. Max 10
	// conditions per request.
	Search param.Field[[]ThreatEventTagIndicatorByDatasetListParamsSearch] `query:"search"`
}

func (ThreatEventTagIndicatorByDatasetListParams) URLQuery added in v7.8.0 

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

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

type ThreatEventTagIndicatorByDatasetListParamsSearch added in v7.8.0 

type ThreatEventTagIndicatorByDatasetListParamsSearch struct {
	// The indicator field to search on. Allowed: value, indicatorType, uuid.
	Field param.Field[ThreatEventTagIndicatorByDatasetListParamsSearchField] `query:"field" api:"required"`
	// Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g.
	// {field:'value', op:'in', value:['evil.com','bad.org']}.
	Op param.Field[ThreatEventTagIndicatorByDatasetListParamsSearchOp] `query:"op" api:"required"`
	// Search value. String for most operators. Array of strings for 'in' operator (max
	// 100 items).
	Value param.Field[ThreatEventTagIndicatorByDatasetListParamsSearchValueUnion] `query:"value" api:"required"`
}

func (ThreatEventTagIndicatorByDatasetListParamsSearch) URLQuery added in v7.8.0 

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

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

type ThreatEventTagIndicatorByDatasetListParamsSearchField added in v7.8.0 

type ThreatEventTagIndicatorByDatasetListParamsSearchField string

The indicator field to search on. Allowed: value, indicatorType, uuid. 

const (
	ThreatEventTagIndicatorByDatasetListParamsSearchFieldValue         ThreatEventTagIndicatorByDatasetListParamsSearchField = "value"
	ThreatEventTagIndicatorByDatasetListParamsSearchFieldIndicatorType ThreatEventTagIndicatorByDatasetListParamsSearchField = "indicatorType"
	ThreatEventTagIndicatorByDatasetListParamsSearchFieldUUID          ThreatEventTagIndicatorByDatasetListParamsSearchField = "uuid"
)

func (ThreatEventTagIndicatorByDatasetListParamsSearchField) IsKnown added in v7.8.0 

func (r ThreatEventTagIndicatorByDatasetListParamsSearchField) IsKnown() bool

type ThreatEventTagIndicatorByDatasetListParamsSearchOp added in v7.8.0 

type ThreatEventTagIndicatorByDatasetListParamsSearchOp string

Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g. {field:'value', op:'in', value:['evil.com','bad.org']}. 

const (
	ThreatEventTagIndicatorByDatasetListParamsSearchOpEquals     ThreatEventTagIndicatorByDatasetListParamsSearchOp = "equals"
	ThreatEventTagIndicatorByDatasetListParamsSearchOpNot        ThreatEventTagIndicatorByDatasetListParamsSearchOp = "not"
	ThreatEventTagIndicatorByDatasetListParamsSearchOpGt         ThreatEventTagIndicatorByDatasetListParamsSearchOp = "gt"
	ThreatEventTagIndicatorByDatasetListParamsSearchOpGte        ThreatEventTagIndicatorByDatasetListParamsSearchOp = "gte"
	ThreatEventTagIndicatorByDatasetListParamsSearchOpLt         ThreatEventTagIndicatorByDatasetListParamsSearchOp = "lt"
	ThreatEventTagIndicatorByDatasetListParamsSearchOpLte        ThreatEventTagIndicatorByDatasetListParamsSearchOp = "lte"
	ThreatEventTagIndicatorByDatasetListParamsSearchOpLike       ThreatEventTagIndicatorByDatasetListParamsSearchOp = "like"
	ThreatEventTagIndicatorByDatasetListParamsSearchOpContains   ThreatEventTagIndicatorByDatasetListParamsSearchOp = "contains"
	ThreatEventTagIndicatorByDatasetListParamsSearchOpStartsWith ThreatEventTagIndicatorByDatasetListParamsSearchOp = "startsWith"
	ThreatEventTagIndicatorByDatasetListParamsSearchOpEndsWith   ThreatEventTagIndicatorByDatasetListParamsSearchOp = "endsWith"
	ThreatEventTagIndicatorByDatasetListParamsSearchOpIn         ThreatEventTagIndicatorByDatasetListParamsSearchOp = "in"
	ThreatEventTagIndicatorByDatasetListParamsSearchOpFind       ThreatEventTagIndicatorByDatasetListParamsSearchOp = "find"
)

func (ThreatEventTagIndicatorByDatasetListParamsSearchOp) IsKnown added in v7.8.0 

func (r ThreatEventTagIndicatorByDatasetListParamsSearchOp) IsKnown() bool

type ThreatEventTagIndicatorByDatasetListParamsSearchValueArray added in v7.8.0 

type ThreatEventTagIndicatorByDatasetListParamsSearchValueArray []string

func (ThreatEventTagIndicatorByDatasetListParamsSearchValueArray) ImplementsThreatEventTagIndicatorByDatasetListParamsSearchValueUnion added in v7.8.0 

func (r ThreatEventTagIndicatorByDatasetListParamsSearchValueArray) ImplementsThreatEventTagIndicatorByDatasetListParamsSearchValueUnion()

type ThreatEventTagIndicatorByDatasetListParamsSearchValueUnion added in v7.8.0 

type ThreatEventTagIndicatorByDatasetListParamsSearchValueUnion interface {
	ImplementsThreatEventTagIndicatorByDatasetListParamsSearchValueUnion()
}

Search value. String for most operators. Array of strings for 'in' operator (max 100 items).

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagIndicatorByDatasetListParamsSearchValueArray.

type ThreatEventTagIndicatorByDatasetListResponse added in v7.8.0 

type ThreatEventTagIndicatorByDatasetListResponse struct {
	Indicators []ThreatEventTagIndicatorByDatasetListResponseIndicator `json:"indicators" api:"required"`
	Pagination ThreatEventTagIndicatorByDatasetListResponsePagination  `json:"pagination" api:"required"`
	JSON       threatEventTagIndicatorByDatasetListResponseJSON        `json:"-"`
}

func (*ThreatEventTagIndicatorByDatasetListResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagIndicatorByDatasetListResponseIndicator added in v7.8.0 

type ThreatEventTagIndicatorByDatasetListResponseIndicator struct {
	CreatedAt     time.Time `json:"createdAt" api:"required" format:"date-time"`
	IndicatorType string    `json:"indicatorType" api:"required"`
	UpdatedAt     time.Time `json:"updatedAt" api:"required" format:"date-time"`
	UUID          string    `json:"uuid" api:"required"`
	Value         string    `json:"value" api:"required"`
	// The dataset ID this indicator belongs to. Included in list responses.
	DatasetID string `json:"datasetId"`
	// Related events, capped by `relatedEventsLimit` (default 2). Check
	// `relatedEventsHasMore` to detect a capped list; pass `relatedEventsLimit=-1` to
	// retrieve all of them.
	RelatedEvents []ThreatEventTagIndicatorByDatasetListResponseIndicatorsRelatedEvent `json:"relatedEvents"`
	// True when this indicator appears in more events than `relatedEvents` contains
	// because `relatedEventsLimit` capped the list. Pass `relatedEventsLimit=-1` to
	// retrieve every related event.
	RelatedEventsHasMore bool                                                        `json:"relatedEventsHasMore"`
	Tags                 []ThreatEventTagIndicatorByDatasetListResponseIndicatorsTag `json:"tags"`
	// Traffic Light Protocol designation. UPPERCASE. Possible values: CLEAR, GREEN,
	// AMBER, AMBER-STRICT, RED, PURPLE. Null when not set.
	TLP  string                                                    `json:"tlp" api:"nullable"`
	JSON threatEventTagIndicatorByDatasetListResponseIndicatorJSON `json:"-"`
}

func (*ThreatEventTagIndicatorByDatasetListResponseIndicator) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagIndicatorByDatasetListResponseIndicatorsRelatedEvent added in v7.8.0 

type ThreatEventTagIndicatorByDatasetListResponseIndicatorsRelatedEvent struct {
	DatasetID string `json:"datasetId" api:"required"`
	EventID   string `json:"eventId" api:"required"`
	// ISO 8601 date of the related event. Null for legacy relationships created before
	// event-date tracking was added.
	EventDate string                                                                 `json:"eventDate" api:"nullable"`
	JSON      threatEventTagIndicatorByDatasetListResponseIndicatorsRelatedEventJSON `json:"-"`
}

func (*ThreatEventTagIndicatorByDatasetListResponseIndicatorsRelatedEvent) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagIndicatorByDatasetListResponseIndicatorsTag added in v7.8.0 

type ThreatEventTagIndicatorByDatasetListResponseIndicatorsTag struct {
	// The UUID of the tag category, or null when the tag is uncategorized.
	CategoryID   string                                                        `json:"categoryId" api:"nullable"`
	CategoryName string                                                        `json:"categoryName"`
	UUID         string                                                        `json:"uuid"`
	Value        string                                                        `json:"value"`
	JSON         threatEventTagIndicatorByDatasetListResponseIndicatorsTagJSON `json:"-"`
}

func (*ThreatEventTagIndicatorByDatasetListResponseIndicatorsTag) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagIndicatorByDatasetListResponsePagination added in v7.8.0 

type ThreatEventTagIndicatorByDatasetListResponsePagination struct {
	Page       float64                                                    `json:"page" api:"required"`
	PageSize   float64                                                    `json:"pageSize" api:"required"`
	TotalCount float64                                                    `json:"totalCount" api:"required"`
	TotalPages float64                                                    `json:"totalPages" api:"required"`
	JSON       threatEventTagIndicatorByDatasetListResponsePaginationJSON `json:"-"`
}

func (*ThreatEventTagIndicatorByDatasetListResponsePagination) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagIndicatorByDatasetService added in v7.8.0 

type ThreatEventTagIndicatorByDatasetService struct {
	Options []option.RequestOption
}

ThreatEventTagIndicatorByDatasetService 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 NewThreatEventTagIndicatorByDatasetService method instead.

func NewThreatEventTagIndicatorByDatasetService added in v7.8.0 

func NewThreatEventTagIndicatorByDatasetService(opts ...option.RequestOption) (r *ThreatEventTagIndicatorByDatasetService)

NewThreatEventTagIndicatorByDatasetService 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 (*ThreatEventTagIndicatorByDatasetService) List deprecated added in v7.8.0 

func (r *ThreatEventTagIndicatorByDatasetService) List(ctx context.Context, datasetID string, tagUUID string, params ThreatEventTagIndicatorByDatasetListParams, opts ...option.RequestOption) (res *ThreatEventTagIndicatorByDatasetListResponse, err error)

This endpoint is deprecated. Use GET /:account_id/events/tags/:tag_uuid/indicators with the optional datasetIds query parameter instead. Returns indicators associated with the provided tag UUID within a single dataset's indicator shards, with pagination.

Deprecated: Use list instead (GET /accounts/{account_id}/cloudforce-one/events/tags/{tag_uuid}/indicators).

type ThreatEventTagIndicatorListParams added in v7.8.0 

type ThreatEventTagIndicatorListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Dataset UUIDs to scope to (repeat the param for multiple), or one standalone
	// scope value: 'all'/'\*' or 'operational' for readable intelligence datasets
	// (isAnalytics=false), or 'analytics' for readable analytics datasets
	// (isAnalytics=true). Analytics datasets do not expose tag associations, so
	// 'analytics' returns an empty result. Omit for 'all'.
	DatasetIDs    param.Field[[]string] `query:"datasetIds"`
	IndicatorType param.Field[string]   `query:"indicatorType"`
	Page          param.Field[float64]  `query:"page"`
	PageSize      param.Field[float64]  `query:"pageSize"`
	// Filter indicators by related event UUID(s). Multiple UUIDs can be provided by
	// repeating the parameter.
	RelatedEvent param.Field[[]string] `query:"relatedEvent"`
	// Structured search as a JSON array of {field, op, value} objects. Searchable
	// fields: value, indicatorType. Multiple conditions are AND'd together. Max 10
	// conditions per request.
	Search param.Field[[]ThreatEventTagIndicatorListParamsSearch] `query:"search"`
}

func (ThreatEventTagIndicatorListParams) URLQuery added in v7.8.0 

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

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

type ThreatEventTagIndicatorListParamsSearch added in v7.8.0 

type ThreatEventTagIndicatorListParamsSearch struct {
	// The indicator field to search on. Allowed: value, indicatorType, uuid.
	Field param.Field[ThreatEventTagIndicatorListParamsSearchField] `query:"field" api:"required"`
	// Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g.
	// {field:'value', op:'in', value:['evil.com','bad.org']}.
	Op param.Field[ThreatEventTagIndicatorListParamsSearchOp] `query:"op" api:"required"`
	// Search value. String for most operators. Array of strings for 'in' operator (max
	// 100 items).
	Value param.Field[ThreatEventTagIndicatorListParamsSearchValueUnion] `query:"value" api:"required"`
}

func (ThreatEventTagIndicatorListParamsSearch) URLQuery added in v7.8.0 

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

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

type ThreatEventTagIndicatorListParamsSearchField added in v7.8.0 

type ThreatEventTagIndicatorListParamsSearchField string

The indicator field to search on. Allowed: value, indicatorType, uuid. 

const (
	ThreatEventTagIndicatorListParamsSearchFieldValue         ThreatEventTagIndicatorListParamsSearchField = "value"
	ThreatEventTagIndicatorListParamsSearchFieldIndicatorType ThreatEventTagIndicatorListParamsSearchField = "indicatorType"
	ThreatEventTagIndicatorListParamsSearchFieldUUID          ThreatEventTagIndicatorListParamsSearchField = "uuid"
)

func (ThreatEventTagIndicatorListParamsSearchField) IsKnown added in v7.8.0 

func (r ThreatEventTagIndicatorListParamsSearchField) IsKnown() bool

type ThreatEventTagIndicatorListParamsSearchOp added in v7.8.0 

type ThreatEventTagIndicatorListParamsSearchOp string

Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g. {field:'value', op:'in', value:['evil.com','bad.org']}. 

const (
	ThreatEventTagIndicatorListParamsSearchOpEquals     ThreatEventTagIndicatorListParamsSearchOp = "equals"
	ThreatEventTagIndicatorListParamsSearchOpNot        ThreatEventTagIndicatorListParamsSearchOp = "not"
	ThreatEventTagIndicatorListParamsSearchOpGt         ThreatEventTagIndicatorListParamsSearchOp = "gt"
	ThreatEventTagIndicatorListParamsSearchOpGte        ThreatEventTagIndicatorListParamsSearchOp = "gte"
	ThreatEventTagIndicatorListParamsSearchOpLt         ThreatEventTagIndicatorListParamsSearchOp = "lt"
	ThreatEventTagIndicatorListParamsSearchOpLte        ThreatEventTagIndicatorListParamsSearchOp = "lte"
	ThreatEventTagIndicatorListParamsSearchOpLike       ThreatEventTagIndicatorListParamsSearchOp = "like"
	ThreatEventTagIndicatorListParamsSearchOpContains   ThreatEventTagIndicatorListParamsSearchOp = "contains"
	ThreatEventTagIndicatorListParamsSearchOpStartsWith ThreatEventTagIndicatorListParamsSearchOp = "startsWith"
	ThreatEventTagIndicatorListParamsSearchOpEndsWith   ThreatEventTagIndicatorListParamsSearchOp = "endsWith"
	ThreatEventTagIndicatorListParamsSearchOpIn         ThreatEventTagIndicatorListParamsSearchOp = "in"
	ThreatEventTagIndicatorListParamsSearchOpFind       ThreatEventTagIndicatorListParamsSearchOp = "find"
)

func (ThreatEventTagIndicatorListParamsSearchOp) IsKnown added in v7.8.0 

func (r ThreatEventTagIndicatorListParamsSearchOp) IsKnown() bool

type ThreatEventTagIndicatorListParamsSearchValueArray added in v7.8.0 

type ThreatEventTagIndicatorListParamsSearchValueArray []string

func (ThreatEventTagIndicatorListParamsSearchValueArray) ImplementsThreatEventTagIndicatorListParamsSearchValueUnion added in v7.8.0 

func (r ThreatEventTagIndicatorListParamsSearchValueArray) ImplementsThreatEventTagIndicatorListParamsSearchValueUnion()

type ThreatEventTagIndicatorListParamsSearchValueUnion added in v7.8.0 

type ThreatEventTagIndicatorListParamsSearchValueUnion interface {
	ImplementsThreatEventTagIndicatorListParamsSearchValueUnion()
}

Search value. String for most operators. Array of strings for 'in' operator (max 100 items).

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagIndicatorListParamsSearchValueArray.

type ThreatEventTagIndicatorListResponse added in v7.8.0 

type ThreatEventTagIndicatorListResponse struct {
	Indicators []ThreatEventTagIndicatorListResponseIndicator `json:"indicators" api:"required"`
	Pagination ThreatEventTagIndicatorListResponsePagination  `json:"pagination" api:"required"`
	JSON       threatEventTagIndicatorListResponseJSON        `json:"-"`
}

func (*ThreatEventTagIndicatorListResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagIndicatorListResponseIndicator added in v7.8.0 

type ThreatEventTagIndicatorListResponseIndicator struct {
	CreatedAt     time.Time `json:"createdAt" api:"required" format:"date-time"`
	IndicatorType string    `json:"indicatorType" api:"required"`
	UpdatedAt     time.Time `json:"updatedAt" api:"required" format:"date-time"`
	UUID          string    `json:"uuid" api:"required"`
	Value         string    `json:"value" api:"required"`
	// The dataset ID this indicator belongs to. Included in list responses.
	DatasetID string `json:"datasetId"`
	// Related events, capped by `relatedEventsLimit` (default 2). Check
	// `relatedEventsHasMore` to detect a capped list; pass `relatedEventsLimit=-1` to
	// retrieve all of them.
	RelatedEvents []ThreatEventTagIndicatorListResponseIndicatorsRelatedEvent `json:"relatedEvents"`
	// True when this indicator appears in more events than `relatedEvents` contains
	// because `relatedEventsLimit` capped the list. Pass `relatedEventsLimit=-1` to
	// retrieve every related event.
	RelatedEventsHasMore bool                                               `json:"relatedEventsHasMore"`
	Tags                 []ThreatEventTagIndicatorListResponseIndicatorsTag `json:"tags"`
	// Traffic Light Protocol designation. UPPERCASE. Possible values: CLEAR, GREEN,
	// AMBER, AMBER-STRICT, RED, PURPLE. Null when not set.
	TLP  string                                           `json:"tlp" api:"nullable"`
	JSON threatEventTagIndicatorListResponseIndicatorJSON `json:"-"`
}

func (*ThreatEventTagIndicatorListResponseIndicator) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagIndicatorListResponseIndicatorsRelatedEvent added in v7.8.0 

type ThreatEventTagIndicatorListResponseIndicatorsRelatedEvent struct {
	DatasetID string `json:"datasetId" api:"required"`
	EventID   string `json:"eventId" api:"required"`
	// ISO 8601 date of the related event. Null for legacy relationships created before
	// event-date tracking was added.
	EventDate string                                                        `json:"eventDate" api:"nullable"`
	JSON      threatEventTagIndicatorListResponseIndicatorsRelatedEventJSON `json:"-"`
}

func (*ThreatEventTagIndicatorListResponseIndicatorsRelatedEvent) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagIndicatorListResponseIndicatorsTag added in v7.8.0 

type ThreatEventTagIndicatorListResponseIndicatorsTag struct {
	// The UUID of the tag category, or null when the tag is uncategorized.
	CategoryID   string                                               `json:"categoryId" api:"nullable"`
	CategoryName string                                               `json:"categoryName"`
	UUID         string                                               `json:"uuid"`
	Value        string                                               `json:"value"`
	JSON         threatEventTagIndicatorListResponseIndicatorsTagJSON `json:"-"`
}

func (*ThreatEventTagIndicatorListResponseIndicatorsTag) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagIndicatorListResponsePagination added in v7.8.0 

type ThreatEventTagIndicatorListResponsePagination struct {
	Page       float64                                           `json:"page" api:"required"`
	PageSize   float64                                           `json:"pageSize" api:"required"`
	TotalCount float64                                           `json:"totalCount" api:"required"`
	TotalPages float64                                           `json:"totalPages" api:"required"`
	JSON       threatEventTagIndicatorListResponsePaginationJSON `json:"-"`
}

func (*ThreatEventTagIndicatorListResponsePagination) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagIndicatorService added in v7.8.0 

type ThreatEventTagIndicatorService struct {
	Options   []option.RequestOption
	ByDataset *ThreatEventTagIndicatorByDatasetService
}

ThreatEventTagIndicatorService 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 NewThreatEventTagIndicatorService method instead.

func NewThreatEventTagIndicatorService added in v7.8.0 

func NewThreatEventTagIndicatorService(opts ...option.RequestOption) (r *ThreatEventTagIndicatorService)

NewThreatEventTagIndicatorService 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 (*ThreatEventTagIndicatorService) List added in v7.8.0 

func (r *ThreatEventTagIndicatorService) List(ctx context.Context, tagUUID string, params ThreatEventTagIndicatorListParams, opts ...option.RequestOption) (res *ThreatEventTagIndicatorListResponse, err error)

Returns indicators associated with the provided tag UUID, with pagination. By default fans out across every intelligence (isAnalytics=false) indicator dataset the account can read; pass datasetIds to scope to dataset UUIDs or a scope value. Analytics datasets do not expose tag associations, so the analytics scope returns an empty result.

type ThreatEventTagListParams added in v7.8.0 

type ThreatEventTagListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Cache strategy. 'from-graph' serves results from the graph-node KV cache when
	// all requested UUIDs are cached; falls back to normal path on partial/zero hit.
	Cache        param.Field[ThreatEventTagListParamsCache] `query:"cache"`
	CategoryUUID param.Field[string]                        `query:"categoryUuid"`
	// Structured filters as a JSON array of {field, op, value} objects. Searchable
	// fields: uuid, value, categoryName, description, dateOfDiscovery, tlp,
	// confidence, actorCategory, motive, attributionOrganization, originCountryISO,
	// aliases, externalReferences, opsecLevel, sophisticationLevel, activeDuration,
	// priority, lastSeen, aliasGroupNames. Operators: equals, not, contains,
	// startsWith, endsWith, gt, lt, gte, lte, like, in, find. Use 'in' for bulk OR
	// within a single field, e.g.
	// filters=[{"field":"originCountryISO","op":"in","value":["IR","CN"]}]. Multiple
	// entries are AND-joined. Max 10 entries per request, max 100 values per 'in'.
	// Per-field notes: `uuid` accepts only 'equals' and 'in' (other operators throw
	// ValidationError) — matched against the canonical lowercase storage but callers
	// may pass either case (the server lowercases before comparison); index-backed by
	// the column's UNIQUE constraint and intended for batched UUID → tag resolution.
	// `originCountryISO` uses its B-tree index for equals/not/in. `priority` uses its
	// B-tree index for numeric comparisons. Other string columns (`actorCategory`,
	// `motive`, etc.) are case-insensitive and unindexed; current catalog size makes
	// this a non-issue. `endsWith` and `aliasGroupNames` contains/like are
	// leading-wildcard scans and slow on large result sets. `aliasGroupNames` matches
	// on the JSON-encoded text, so substrings can cross alias boundaries (a search for
	// "apt28" will also match "apt280" if both appear in the same tag's alias list).
	Filters  param.Field[[]ThreatEventTagListParamsFilter] `query:"filters"`
	Page     param.Field[float64]                          `query:"page"`
	PageSize param.Field[float64]                          `query:"pageSize"`
	// Free-text substring match on tag value AND custom-field properties. Searches
	// case-insensitively inside both `Tag.value` and the serialized `Tag.properties`
	// JSON blob (keys, values, and annotation metadata like confidence/tlp are all
	// searchable). Same serialized-text tradeoff as `aliasGroupNames` — substrings can
	// cross JSON boundaries.
	Search param.Field[string] `query:"search"`
}

func (ThreatEventTagListParams) URLQuery added in v7.8.0 

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

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

type ThreatEventTagListParamsCache added in v7.8.0 

type ThreatEventTagListParamsCache string

Cache strategy. 'from-graph' serves results from the graph-node KV cache when all requested UUIDs are cached; falls back to normal path on partial/zero hit. 

const (
	ThreatEventTagListParamsCacheFromGraph ThreatEventTagListParamsCache = "from-graph"
)

func (ThreatEventTagListParamsCache) IsKnown added in v7.8.0 

func (r ThreatEventTagListParamsCache) IsKnown() bool

type ThreatEventTagListParamsFilter added in v7.8.0 

type ThreatEventTagListParamsFilter struct {
	// Tag field to search on. Allowed first-class fields: uuid, value, categoryName,
	// description, dateOfDiscovery, tlp, confidence, actorCategory, motive,
	// attributionOrganization, originCountryISO, aliases, externalReferences,
	// opsecLevel, sophisticationLevel, activeDuration, priority, lastSeen,
	// aliasGroupNames. Also supports properties.<key> to filter on custom field values
	// (matches both raw values and annotated {value,confidence,tlp} shapes via
	// COALESCE), and properties.<key>.tlp / properties.<key>.confidence to filter
	// directly on annotation sub-fields.
	Field param.Field[string] `query:"field" api:"required"`
	// Search operator. Use 'in' for bulk OR within a single field.
	Op param.Field[ThreatEventTagListParamsFiltersOp] `query:"op" api:"required"`
	// Search value. String or number for most operators. Array for 'in' (max 100
	// items).
	Value param.Field[ThreatEventTagListParamsFiltersValueUnion] `query:"value"`
}

func (ThreatEventTagListParamsFilter) URLQuery added in v7.8.0 

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

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

type ThreatEventTagListParamsFiltersOp added in v7.8.0 

type ThreatEventTagListParamsFiltersOp string

Search operator. Use 'in' for bulk OR within a single field. 

const (
	ThreatEventTagListParamsFiltersOpEquals     ThreatEventTagListParamsFiltersOp = "equals"
	ThreatEventTagListParamsFiltersOpNot        ThreatEventTagListParamsFiltersOp = "not"
	ThreatEventTagListParamsFiltersOpGt         ThreatEventTagListParamsFiltersOp = "gt"
	ThreatEventTagListParamsFiltersOpGte        ThreatEventTagListParamsFiltersOp = "gte"
	ThreatEventTagListParamsFiltersOpLt         ThreatEventTagListParamsFiltersOp = "lt"
	ThreatEventTagListParamsFiltersOpLte        ThreatEventTagListParamsFiltersOp = "lte"
	ThreatEventTagListParamsFiltersOpLike       ThreatEventTagListParamsFiltersOp = "like"
	ThreatEventTagListParamsFiltersOpContains   ThreatEventTagListParamsFiltersOp = "contains"
	ThreatEventTagListParamsFiltersOpStartsWith ThreatEventTagListParamsFiltersOp = "startsWith"
	ThreatEventTagListParamsFiltersOpEndsWith   ThreatEventTagListParamsFiltersOp = "endsWith"
	ThreatEventTagListParamsFiltersOpIn         ThreatEventTagListParamsFiltersOp = "in"
	ThreatEventTagListParamsFiltersOpFind       ThreatEventTagListParamsFiltersOp = "find"
)

func (ThreatEventTagListParamsFiltersOp) IsKnown added in v7.8.0 

func (r ThreatEventTagListParamsFiltersOp) IsKnown() bool

type ThreatEventTagListParamsFiltersValueArray added in v7.8.0 

type ThreatEventTagListParamsFiltersValueArray []ThreatEventTagListParamsFiltersValueArrayItemUnion

func (ThreatEventTagListParamsFiltersValueArray) ImplementsThreatEventTagListParamsFiltersValueUnion added in v7.8.0 

func (r ThreatEventTagListParamsFiltersValueArray) ImplementsThreatEventTagListParamsFiltersValueUnion()

type ThreatEventTagListParamsFiltersValueArrayItemUnion added in v7.8.0 

type ThreatEventTagListParamsFiltersValueArrayItemUnion interface {
	ImplementsThreatEventTagListParamsFiltersValueArrayItemUnion()
}

Satisfied by shared.UnionString, shared.UnionFloat.

type ThreatEventTagListParamsFiltersValueUnion added in v7.8.0 

type ThreatEventTagListParamsFiltersValueUnion interface {
	ImplementsThreatEventTagListParamsFiltersValueUnion()
}

Search value. String or number for most operators. Array for 'in' (max 100 items).

Satisfied by shared.UnionString, shared.UnionFloat, cloudforce_one.ThreatEventTagListParamsFiltersValueArray.

type ThreatEventTagListResponse added in v7.8.0 

type ThreatEventTagListResponse struct {
	Pagination ThreatEventTagListResponsePagination `json:"pagination" api:"required"`
	Tags       []ThreatEventTagListResponseTag      `json:"tags" api:"required"`
	JSON       threatEventTagListResponseJSON       `json:"-"`
}

func (*ThreatEventTagListResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagListResponsePagination added in v7.8.0 

type ThreatEventTagListResponsePagination struct {
	Page       float64                                  `json:"page" api:"required"`
	PageSize   float64                                  `json:"pageSize" api:"required"`
	TotalCount float64                                  `json:"totalCount" api:"required"`
	TotalPages float64                                  `json:"totalPages" api:"required"`
	JSON       threatEventTagListResponsePaginationJSON `json:"-"`
}

func (*ThreatEventTagListResponsePagination) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagListResponseTag added in v7.8.0 

type ThreatEventTagListResponseTag struct {
	UUID                    string                                                `json:"uuid" api:"required"`
	Value                   string                                                `json:"value" api:"required"`
	ActiveDuration          string                                                `json:"activeDuration"`
	ActiveDurationAnnotated ThreatEventTagListResponseTagsActiveDurationAnnotated `json:"activeDuration_annotated" api:"nullable"`
	ActorCategory           string                                                `json:"actorCategory"`
	ActorCategoryAnnotated  ThreatEventTagListResponseTagsActorCategoryAnnotated  `json:"actorCategory_annotated" api:"nullable"`
	// Structured aliases ({ value, confidence 1-10, tlp }). Public: returned to all
	// accounts with per-entry TLP filtering (entries with tlp: purple are removed for
	// non-CFONE accounts).
	Aliases                          []ThreatEventTagListResponseTagsAlias                          `json:"aliases"`
	AliasGroupNames                  []string                                                       `json:"aliasGroupNames"`
	AliasGroupNamesInternal          []string                                                       `json:"aliasGroupNamesInternal"`
	AttributionOrganization          string                                                         `json:"attributionOrganization"`
	AttributionOrganizationAnnotated ThreatEventTagListResponseTagsAttributionOrganizationAnnotated `json:"attributionOrganization_annotated" api:"nullable"`
	CategoryName                     string                                                         `json:"categoryName"`
	CategoryUUID                     string                                                         `json:"categoryUuid"`
	// Overall tag confidence (1-10).
	Confidence             int64    `json:"confidence" api:"nullable"`
	CreatedAt              string   `json:"createdAt"`
	DateOfDiscovery        string   `json:"dateOfDiscovery"`
	Description            string   `json:"description"`
	ExternalReferenceLinks []string `json:"externalReferenceLinks"`
	// Structured external references ({ url, description }). Public: returned to all
	// accounts.
	ExternalReferences          []ThreatEventTagListResponseTagsExternalReference           `json:"externalReferences"`
	ExternalReferencesAnnotated []ThreatEventTagListResponseTagsExternalReferencesAnnotated `json:"externalReferences_annotated" api:"nullable"`
	// Owner-private structured aliases ({ value, confidence 1-10, tlp }). Returned to
	// the owning account and omitted from shared-catalog non-owner responses.
	InternalAliases     []ThreatEventTagListResponseTagsInternalAlias     `json:"internalAliases"`
	InternalDescription string                                            `json:"internalDescription"`
	LastSeen            string                                            `json:"lastSeen"`
	Motive              string                                            `json:"motive"`
	MotiveAnnotated     ThreatEventTagListResponseTagsMotiveAnnotated     `json:"motive_annotated" api:"nullable"`
	OpsecLevel          string                                            `json:"opsecLevel"`
	OpsecLevelAnnotated ThreatEventTagListResponseTagsOpsecLevelAnnotated `json:"opsecLevel_annotated" api:"nullable"`
	// ISO country code (alpha-2 or alpha-3). Normalized to uppercase on read. Null
	// when stored value is blank/whitespace.
	OriginCountryISO          string                                                  `json:"originCountryISO" api:"nullable"`
	OriginCountryISOAnnotated ThreatEventTagListResponseTagsOriginCountryISOAnnotated `json:"originCountryISO_annotated" api:"nullable"`
	Priority                  float64                                                 `json:"priority"`
	PriorityAnnotated         ThreatEventTagListResponseTagsPriorityAnnotated         `json:"priority_annotated" api:"nullable"`
	// Parsed custom field values. Null when the tag has no custom fields.
	Properties                   map[string]interface{}                                     `json:"properties" api:"nullable"`
	SophisticationLevel          string                                                     `json:"sophisticationLevel"`
	SophisticationLevelAnnotated ThreatEventTagListResponseTagsSophisticationLevelAnnotated `json:"sophisticationLevel_annotated" api:"nullable"`
	// Tag-level TLP handling marking.
	TLP       ThreatEventTagListResponseTagsTLP `json:"tlp" api:"nullable"`
	UpdatedAt string                            `json:"updatedAt"`
	Version   float64                           `json:"version"`
	JSON      threatEventTagListResponseTagJSON `json:"-"`
}

func (*ThreatEventTagListResponseTag) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagListResponseTagsActiveDurationAnnotated added in v7.10.0 

type ThreatEventTagListResponseTagsActiveDurationAnnotated struct {
	Value string                                                    `json:"value" api:"required"`
	TLP   ThreatEventTagListResponseTagsActiveDurationAnnotatedTLP  `json:"tlp"`
	JSON  threatEventTagListResponseTagsActiveDurationAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagListResponseTagsActiveDurationAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagListResponseTagsActiveDurationAnnotatedTLP added in v7.10.0 

type ThreatEventTagListResponseTagsActiveDurationAnnotatedTLP string
const (
	ThreatEventTagListResponseTagsActiveDurationAnnotatedTLPRed                  ThreatEventTagListResponseTagsActiveDurationAnnotatedTLP = "red"
	ThreatEventTagListResponseTagsActiveDurationAnnotatedTLPAmber                ThreatEventTagListResponseTagsActiveDurationAnnotatedTLP = "amber"
	ThreatEventTagListResponseTagsActiveDurationAnnotatedTLPAmberStrict          ThreatEventTagListResponseTagsActiveDurationAnnotatedTLP = "amber-strict"
	ThreatEventTagListResponseTagsActiveDurationAnnotatedTLPGreen                ThreatEventTagListResponseTagsActiveDurationAnnotatedTLP = "green"
	ThreatEventTagListResponseTagsActiveDurationAnnotatedTLPClear                ThreatEventTagListResponseTagsActiveDurationAnnotatedTLP = "clear"
	ThreatEventTagListResponseTagsActiveDurationAnnotatedTLPPurple               ThreatEventTagListResponseTagsActiveDurationAnnotatedTLP = "purple"
	ThreatEventTagListResponseTagsActiveDurationAnnotatedTLPAmberStrictLowercase ThreatEventTagListResponseTagsActiveDurationAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagListResponseTagsActiveDurationAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagListResponseTagsActiveDurationAnnotatedTLP) IsKnown() bool

type ThreatEventTagListResponseTagsActorCategoryAnnotated added in v7.10.0 

type ThreatEventTagListResponseTagsActorCategoryAnnotated struct {
	Value      string                                                   `json:"value" api:"required"`
	Confidence float64                                                  `json:"confidence"`
	TLP        ThreatEventTagListResponseTagsActorCategoryAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagListResponseTagsActorCategoryAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagListResponseTagsActorCategoryAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagListResponseTagsActorCategoryAnnotatedTLP added in v7.10.0 

type ThreatEventTagListResponseTagsActorCategoryAnnotatedTLP string
const (
	ThreatEventTagListResponseTagsActorCategoryAnnotatedTLPRed                  ThreatEventTagListResponseTagsActorCategoryAnnotatedTLP = "red"
	ThreatEventTagListResponseTagsActorCategoryAnnotatedTLPAmber                ThreatEventTagListResponseTagsActorCategoryAnnotatedTLP = "amber"
	ThreatEventTagListResponseTagsActorCategoryAnnotatedTLPAmberStrict          ThreatEventTagListResponseTagsActorCategoryAnnotatedTLP = "amber-strict"
	ThreatEventTagListResponseTagsActorCategoryAnnotatedTLPGreen                ThreatEventTagListResponseTagsActorCategoryAnnotatedTLP = "green"
	ThreatEventTagListResponseTagsActorCategoryAnnotatedTLPClear                ThreatEventTagListResponseTagsActorCategoryAnnotatedTLP = "clear"
	ThreatEventTagListResponseTagsActorCategoryAnnotatedTLPPurple               ThreatEventTagListResponseTagsActorCategoryAnnotatedTLP = "purple"
	ThreatEventTagListResponseTagsActorCategoryAnnotatedTLPAmberStrictLowercase ThreatEventTagListResponseTagsActorCategoryAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagListResponseTagsActorCategoryAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagListResponseTagsActorCategoryAnnotatedTLP) IsKnown() bool

type ThreatEventTagListResponseTagsAlias added in v7.8.0 

type ThreatEventTagListResponseTagsAlias struct {
	Value      string                                   `json:"value" api:"required"`
	Confidence int64                                    `json:"confidence" api:"nullable"`
	TLP        ThreatEventTagListResponseTagsAliasesTLP `json:"tlp" api:"nullable"`
	JSON       threatEventTagListResponseTagsAliasJSON  `json:"-"`
}

func (*ThreatEventTagListResponseTagsAlias) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagListResponseTagsAliasesTLP added in v7.8.0 

type ThreatEventTagListResponseTagsAliasesTLP string
const (
	ThreatEventTagListResponseTagsAliasesTLPRed                  ThreatEventTagListResponseTagsAliasesTLP = "red"
	ThreatEventTagListResponseTagsAliasesTLPAmber                ThreatEventTagListResponseTagsAliasesTLP = "amber"
	ThreatEventTagListResponseTagsAliasesTLPAmberStrict          ThreatEventTagListResponseTagsAliasesTLP = "amber-strict"
	ThreatEventTagListResponseTagsAliasesTLPGreen                ThreatEventTagListResponseTagsAliasesTLP = "green"
	ThreatEventTagListResponseTagsAliasesTLPClear                ThreatEventTagListResponseTagsAliasesTLP = "clear"
	ThreatEventTagListResponseTagsAliasesTLPPurple               ThreatEventTagListResponseTagsAliasesTLP = "purple"
	ThreatEventTagListResponseTagsAliasesTLPAmberStrictLowercase ThreatEventTagListResponseTagsAliasesTLP = "amber+strict"
)

func (ThreatEventTagListResponseTagsAliasesTLP) IsKnown added in v7.8.0 

func (r ThreatEventTagListResponseTagsAliasesTLP) IsKnown() bool

type ThreatEventTagListResponseTagsAttributionOrganizationAnnotated added in v7.10.0 

type ThreatEventTagListResponseTagsAttributionOrganizationAnnotated struct {
	Value      string                                                             `json:"value" api:"required"`
	Confidence float64                                                            `json:"confidence"`
	TLP        ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagListResponseTagsAttributionOrganizationAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagListResponseTagsAttributionOrganizationAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLP added in v7.10.0 

type ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLP string
const (
	ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLPRed                  ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLP = "red"
	ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLPAmber                ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLP = "amber"
	ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLPAmberStrict          ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLP = "amber-strict"
	ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLPGreen                ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLP = "green"
	ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLPClear                ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLP = "clear"
	ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLPPurple               ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLP = "purple"
	ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLPAmberStrictLowercase ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagListResponseTagsAttributionOrganizationAnnotatedTLP) IsKnown() bool

type ThreatEventTagListResponseTagsExternalReference added in v7.8.0 

type ThreatEventTagListResponseTagsExternalReference struct {
	URL         string                                              `json:"url" api:"required"`
	Description string                                              `json:"description" api:"nullable"`
	JSON        threatEventTagListResponseTagsExternalReferenceJSON `json:"-"`
}

func (*ThreatEventTagListResponseTagsExternalReference) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagListResponseTagsExternalReferencesAnnotated added in v7.10.0 

type ThreatEventTagListResponseTagsExternalReferencesAnnotated struct {
	Value string                                                        `json:"value" api:"required"`
	TLP   ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLP  `json:"tlp"`
	JSON  threatEventTagListResponseTagsExternalReferencesAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagListResponseTagsExternalReferencesAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLP added in v7.10.0 

type ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLP string
const (
	ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLPRed                  ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLP = "red"
	ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLPAmber                ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLP = "amber"
	ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLPAmberStrict          ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLP = "amber-strict"
	ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLPGreen                ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLP = "green"
	ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLPClear                ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLP = "clear"
	ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLPPurple               ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLP = "purple"
	ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLPAmberStrictLowercase ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagListResponseTagsExternalReferencesAnnotatedTLP) IsKnown() bool

type ThreatEventTagListResponseTagsInternalAlias added in v7.8.0 

type ThreatEventTagListResponseTagsInternalAlias struct {
	Value      string                                           `json:"value" api:"required"`
	Confidence int64                                            `json:"confidence" api:"nullable"`
	TLP        ThreatEventTagListResponseTagsInternalAliasesTLP `json:"tlp" api:"nullable"`
	JSON       threatEventTagListResponseTagsInternalAliasJSON  `json:"-"`
}

func (*ThreatEventTagListResponseTagsInternalAlias) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTagListResponseTagsInternalAliasesTLP added in v7.8.0 

type ThreatEventTagListResponseTagsInternalAliasesTLP string
const (
	ThreatEventTagListResponseTagsInternalAliasesTLPRed                  ThreatEventTagListResponseTagsInternalAliasesTLP = "red"
	ThreatEventTagListResponseTagsInternalAliasesTLPAmber                ThreatEventTagListResponseTagsInternalAliasesTLP = "amber"
	ThreatEventTagListResponseTagsInternalAliasesTLPAmberStrict          ThreatEventTagListResponseTagsInternalAliasesTLP = "amber-strict"
	ThreatEventTagListResponseTagsInternalAliasesTLPGreen                ThreatEventTagListResponseTagsInternalAliasesTLP = "green"
	ThreatEventTagListResponseTagsInternalAliasesTLPClear                ThreatEventTagListResponseTagsInternalAliasesTLP = "clear"
	ThreatEventTagListResponseTagsInternalAliasesTLPPurple               ThreatEventTagListResponseTagsInternalAliasesTLP = "purple"
	ThreatEventTagListResponseTagsInternalAliasesTLPAmberStrictLowercase ThreatEventTagListResponseTagsInternalAliasesTLP = "amber+strict"
)

func (ThreatEventTagListResponseTagsInternalAliasesTLP) IsKnown added in v7.8.0 

func (r ThreatEventTagListResponseTagsInternalAliasesTLP) IsKnown() bool

type ThreatEventTagListResponseTagsMotiveAnnotated added in v7.10.0 

type ThreatEventTagListResponseTagsMotiveAnnotated struct {
	Value      string                                            `json:"value" api:"required"`
	Confidence float64                                           `json:"confidence"`
	TLP        ThreatEventTagListResponseTagsMotiveAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagListResponseTagsMotiveAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagListResponseTagsMotiveAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagListResponseTagsMotiveAnnotatedTLP added in v7.10.0 

type ThreatEventTagListResponseTagsMotiveAnnotatedTLP string
const (
	ThreatEventTagListResponseTagsMotiveAnnotatedTLPRed                  ThreatEventTagListResponseTagsMotiveAnnotatedTLP = "red"
	ThreatEventTagListResponseTagsMotiveAnnotatedTLPAmber                ThreatEventTagListResponseTagsMotiveAnnotatedTLP = "amber"
	ThreatEventTagListResponseTagsMotiveAnnotatedTLPAmberStrict          ThreatEventTagListResponseTagsMotiveAnnotatedTLP = "amber-strict"
	ThreatEventTagListResponseTagsMotiveAnnotatedTLPGreen                ThreatEventTagListResponseTagsMotiveAnnotatedTLP = "green"
	ThreatEventTagListResponseTagsMotiveAnnotatedTLPClear                ThreatEventTagListResponseTagsMotiveAnnotatedTLP = "clear"
	ThreatEventTagListResponseTagsMotiveAnnotatedTLPPurple               ThreatEventTagListResponseTagsMotiveAnnotatedTLP = "purple"
	ThreatEventTagListResponseTagsMotiveAnnotatedTLPAmberStrictLowercase ThreatEventTagListResponseTagsMotiveAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagListResponseTagsMotiveAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagListResponseTagsMotiveAnnotatedTLP) IsKnown() bool

type ThreatEventTagListResponseTagsOpsecLevelAnnotated added in v7.10.0 

type ThreatEventTagListResponseTagsOpsecLevelAnnotated struct {
	Value      string                                                `json:"value" api:"required"`
	Confidence float64                                               `json:"confidence"`
	TLP        ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagListResponseTagsOpsecLevelAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagListResponseTagsOpsecLevelAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLP added in v7.10.0 

type ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLP string
const (
	ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLPRed                  ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLP = "red"
	ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLPAmber                ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLP = "amber"
	ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLPAmberStrict          ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLP = "amber-strict"
	ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLPGreen                ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLP = "green"
	ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLPClear                ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLP = "clear"
	ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLPPurple               ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLP = "purple"
	ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLPAmberStrictLowercase ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagListResponseTagsOpsecLevelAnnotatedTLP) IsKnown() bool

type ThreatEventTagListResponseTagsOriginCountryISOAnnotated added in v7.10.0 

type ThreatEventTagListResponseTagsOriginCountryISOAnnotated struct {
	Value      string                                                      `json:"value" api:"required,nullable"`
	Confidence float64                                                     `json:"confidence"`
	TLP        ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagListResponseTagsOriginCountryISOAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagListResponseTagsOriginCountryISOAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLP added in v7.10.0 

type ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLP string
const (
	ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLPRed                  ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLP = "red"
	ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLPAmber                ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLP = "amber"
	ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLPAmberStrict          ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLP = "amber-strict"
	ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLPGreen                ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLP = "green"
	ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLPClear                ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLP = "clear"
	ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLPPurple               ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLP = "purple"
	ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLPAmberStrictLowercase ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagListResponseTagsOriginCountryISOAnnotatedTLP) IsKnown() bool

type ThreatEventTagListResponseTagsPriorityAnnotated added in v7.10.0 

type ThreatEventTagListResponseTagsPriorityAnnotated struct {
	Value float64                                             `json:"value" api:"required"`
	TLP   ThreatEventTagListResponseTagsPriorityAnnotatedTLP  `json:"tlp"`
	JSON  threatEventTagListResponseTagsPriorityAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagListResponseTagsPriorityAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagListResponseTagsPriorityAnnotatedTLP added in v7.10.0 

type ThreatEventTagListResponseTagsPriorityAnnotatedTLP string
const (
	ThreatEventTagListResponseTagsPriorityAnnotatedTLPRed                  ThreatEventTagListResponseTagsPriorityAnnotatedTLP = "red"
	ThreatEventTagListResponseTagsPriorityAnnotatedTLPAmber                ThreatEventTagListResponseTagsPriorityAnnotatedTLP = "amber"
	ThreatEventTagListResponseTagsPriorityAnnotatedTLPAmberStrict          ThreatEventTagListResponseTagsPriorityAnnotatedTLP = "amber-strict"
	ThreatEventTagListResponseTagsPriorityAnnotatedTLPGreen                ThreatEventTagListResponseTagsPriorityAnnotatedTLP = "green"
	ThreatEventTagListResponseTagsPriorityAnnotatedTLPClear                ThreatEventTagListResponseTagsPriorityAnnotatedTLP = "clear"
	ThreatEventTagListResponseTagsPriorityAnnotatedTLPPurple               ThreatEventTagListResponseTagsPriorityAnnotatedTLP = "purple"
	ThreatEventTagListResponseTagsPriorityAnnotatedTLPAmberStrictLowercase ThreatEventTagListResponseTagsPriorityAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagListResponseTagsPriorityAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagListResponseTagsPriorityAnnotatedTLP) IsKnown() bool

type ThreatEventTagListResponseTagsSophisticationLevelAnnotated added in v7.10.0 

type ThreatEventTagListResponseTagsSophisticationLevelAnnotated struct {
	Value      string                                                         `json:"value" api:"required"`
	Confidence float64                                                        `json:"confidence"`
	TLP        ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagListResponseTagsSophisticationLevelAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagListResponseTagsSophisticationLevelAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLP added in v7.10.0 

type ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLP string
const (
	ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLPRed                  ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLP = "red"
	ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLPAmber                ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLP = "amber"
	ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLPAmberStrict          ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLP = "amber-strict"
	ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLPGreen                ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLP = "green"
	ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLPClear                ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLP = "clear"
	ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLPPurple               ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLP = "purple"
	ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLPAmberStrictLowercase ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagListResponseTagsSophisticationLevelAnnotatedTLP) IsKnown() bool

type ThreatEventTagListResponseTagsTLP added in v7.10.0 

type ThreatEventTagListResponseTagsTLP string

Tag-level TLP handling marking. 

const (
	ThreatEventTagListResponseTagsTLPRed                  ThreatEventTagListResponseTagsTLP = "red"
	ThreatEventTagListResponseTagsTLPAmber                ThreatEventTagListResponseTagsTLP = "amber"
	ThreatEventTagListResponseTagsTLPAmberStrict          ThreatEventTagListResponseTagsTLP = "amber-strict"
	ThreatEventTagListResponseTagsTLPGreen                ThreatEventTagListResponseTagsTLP = "green"
	ThreatEventTagListResponseTagsTLPClear                ThreatEventTagListResponseTagsTLP = "clear"
	ThreatEventTagListResponseTagsTLPPurple               ThreatEventTagListResponseTagsTLP = "purple"
	ThreatEventTagListResponseTagsTLPAmberStrictLowercase ThreatEventTagListResponseTagsTLP = "amber+strict"
)

func (ThreatEventTagListResponseTagsTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagListResponseTagsTLP) IsKnown() bool

type ThreatEventTagNewParams 

type ThreatEventTagNewParams struct {
	// Account ID.
	AccountID      param.Field[string]                                     `path:"account_id" api:"required"`
	Value          param.Field[string]                                     `json:"value" api:"required"`
	ActiveDuration param.Field[ThreatEventTagNewParamsActiveDurationUnion] `json:"activeDuration"`
	ActorCategory  param.Field[ThreatEventTagNewParamsActorCategoryUnion]  `json:"actorCategory"`
	// Structured aliases ({ value, confidence 1-10, tlp }). Public: returned to all
	// accounts with per-entry TLP filtering (entries with tlp: purple are removed for
	// non-CFONE accounts).
	Aliases                 param.Field[[]ThreatEventTagNewParamsAlias]                      `json:"aliases"`
	AliasGroupNames         param.Field[[]string]                                            `json:"aliasGroupNames"`
	AliasGroupNamesInternal param.Field[[]string]                                            `json:"aliasGroupNamesInternal"`
	AttributionOrganization param.Field[ThreatEventTagNewParamsAttributionOrganizationUnion] `json:"attributionOrganization"`
	// Tag type (category) UUID. Optional — when present, `properties` is validated
	// against this category's schema. When absent, the tag is typeless and properties
	// are accepted free-form.
	CategoryUUID param.Field[string] `json:"categoryUuid"`
	// Overall tag confidence (1-10). Optional.
	Confidence param.Field[int64] `json:"confidence"`
	// Date of discovery (ISO YYYY-MM-DD). Optional.
	DateOfDiscovery        param.Field[string]   `json:"dateOfDiscovery"`
	Description            param.Field[string]   `json:"description"`
	ExternalReferenceLinks param.Field[[]string] `json:"externalReferenceLinks"`
	// Structured external references ({ url, description }). Public: returned to all
	// accounts.
	ExternalReferences param.Field[[]ThreatEventTagNewParamsExternalReference] `json:"externalReferences"`
	// Owner-private structured aliases ({ value, confidence 1-10, tlp }). Returned to
	// the owning account and omitted from shared-catalog non-owner responses.
	InternalAliases     param.Field[[]ThreatEventTagNewParamsInternalAlias]       `json:"internalAliases"`
	InternalDescription param.Field[string]                                       `json:"internalDescription"`
	LastSeen            param.Field[string]                                       `json:"lastSeen"`
	Motive              param.Field[ThreatEventTagNewParamsMotiveUnion]           `json:"motive"`
	OpsecLevel          param.Field[ThreatEventTagNewParamsOpsecLevelUnion]       `json:"opsecLevel"`
	OriginCountryISO    param.Field[ThreatEventTagNewParamsOriginCountryISOUnion] `json:"originCountryISO"`
	Priority            param.Field[ThreatEventTagNewParamsPriorityUnion]         `json:"priority"`
	// Structured metadata blob. Optional. When `categoryUuid` is given, validated
	// against this category's schema on write. When typeless, accepted free-form. Use
	// `{}` for a tag with no custom data.
	Properties          param.Field[map[string]interface{}]                          `json:"properties"`
	SophisticationLevel param.Field[ThreatEventTagNewParamsSophisticationLevelUnion] `json:"sophisticationLevel"`
	// Tag-level TLP handling marking. Optional. Allowed values: red, amber,
	// amber-strict, green, clear, purple, amber+strict.
	TLP param.Field[ThreatEventTagNewParamsTLP] `json:"tlp"`
}

func (ThreatEventTagNewParams) MarshalJSON 

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

type ThreatEventTagNewParamsActiveDurationObject added in v7.10.0 

type ThreatEventTagNewParamsActiveDurationObject struct {
	Value      param.Field[string]                                         `json:"value" api:"required"`
	Confidence param.Field[int64]                                          `json:"confidence"`
	TLP        param.Field[ThreatEventTagNewParamsActiveDurationObjectTLP] `json:"tlp"`
}

func (ThreatEventTagNewParamsActiveDurationObject) ImplementsThreatEventTagNewParamsActiveDurationUnion added in v7.10.0 

func (r ThreatEventTagNewParamsActiveDurationObject) ImplementsThreatEventTagNewParamsActiveDurationUnion()

func (ThreatEventTagNewParamsActiveDurationObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagNewParamsActiveDurationObjectTLP added in v7.10.0 

type ThreatEventTagNewParamsActiveDurationObjectTLP string
const (
	ThreatEventTagNewParamsActiveDurationObjectTLPRed                  ThreatEventTagNewParamsActiveDurationObjectTLP = "red"
	ThreatEventTagNewParamsActiveDurationObjectTLPAmber                ThreatEventTagNewParamsActiveDurationObjectTLP = "amber"
	ThreatEventTagNewParamsActiveDurationObjectTLPAmberStrict          ThreatEventTagNewParamsActiveDurationObjectTLP = "amber-strict"
	ThreatEventTagNewParamsActiveDurationObjectTLPGreen                ThreatEventTagNewParamsActiveDurationObjectTLP = "green"
	ThreatEventTagNewParamsActiveDurationObjectTLPClear                ThreatEventTagNewParamsActiveDurationObjectTLP = "clear"
	ThreatEventTagNewParamsActiveDurationObjectTLPPurple               ThreatEventTagNewParamsActiveDurationObjectTLP = "purple"
	ThreatEventTagNewParamsActiveDurationObjectTLPAmberStrictLowercase ThreatEventTagNewParamsActiveDurationObjectTLP = "amber+strict"
)

func (ThreatEventTagNewParamsActiveDurationObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewParamsActiveDurationObjectTLP) IsKnown() bool

type ThreatEventTagNewParamsActiveDurationUnion added in v7.10.0 

type ThreatEventTagNewParamsActiveDurationUnion interface {
	ImplementsThreatEventTagNewParamsActiveDurationUnion()
}

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagNewParamsActiveDurationObject.

type ThreatEventTagNewParamsActorCategoryObject added in v7.10.0 

type ThreatEventTagNewParamsActorCategoryObject struct {
	Value      param.Field[string]                                        `json:"value" api:"required"`
	Confidence param.Field[int64]                                         `json:"confidence"`
	TLP        param.Field[ThreatEventTagNewParamsActorCategoryObjectTLP] `json:"tlp"`
}

func (ThreatEventTagNewParamsActorCategoryObject) ImplementsThreatEventTagNewParamsActorCategoryUnion added in v7.10.0 

func (r ThreatEventTagNewParamsActorCategoryObject) ImplementsThreatEventTagNewParamsActorCategoryUnion()

func (ThreatEventTagNewParamsActorCategoryObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagNewParamsActorCategoryObjectTLP added in v7.10.0 

type ThreatEventTagNewParamsActorCategoryObjectTLP string
const (
	ThreatEventTagNewParamsActorCategoryObjectTLPRed                  ThreatEventTagNewParamsActorCategoryObjectTLP = "red"
	ThreatEventTagNewParamsActorCategoryObjectTLPAmber                ThreatEventTagNewParamsActorCategoryObjectTLP = "amber"
	ThreatEventTagNewParamsActorCategoryObjectTLPAmberStrict          ThreatEventTagNewParamsActorCategoryObjectTLP = "amber-strict"
	ThreatEventTagNewParamsActorCategoryObjectTLPGreen                ThreatEventTagNewParamsActorCategoryObjectTLP = "green"
	ThreatEventTagNewParamsActorCategoryObjectTLPClear                ThreatEventTagNewParamsActorCategoryObjectTLP = "clear"
	ThreatEventTagNewParamsActorCategoryObjectTLPPurple               ThreatEventTagNewParamsActorCategoryObjectTLP = "purple"
	ThreatEventTagNewParamsActorCategoryObjectTLPAmberStrictLowercase ThreatEventTagNewParamsActorCategoryObjectTLP = "amber+strict"
)

func (ThreatEventTagNewParamsActorCategoryObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewParamsActorCategoryObjectTLP) IsKnown() bool

type ThreatEventTagNewParamsActorCategoryUnion added in v7.10.0 

type ThreatEventTagNewParamsActorCategoryUnion interface {
	ImplementsThreatEventTagNewParamsActorCategoryUnion()
}

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagNewParamsActorCategoryObject.

type ThreatEventTagNewParamsAlias added in v7.7.0 

type ThreatEventTagNewParamsAlias struct {
	Value      param.Field[string]                            `json:"value" api:"required"`
	Confidence param.Field[int64]                             `json:"confidence"`
	TLP        param.Field[ThreatEventTagNewParamsAliasesTLP] `json:"tlp"`
}

func (ThreatEventTagNewParamsAlias) MarshalJSON added in v7.7.0 

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

type ThreatEventTagNewParamsAliasesTLP added in v7.7.0 

type ThreatEventTagNewParamsAliasesTLP string
const (
	ThreatEventTagNewParamsAliasesTLPRed                  ThreatEventTagNewParamsAliasesTLP = "red"
	ThreatEventTagNewParamsAliasesTLPAmber                ThreatEventTagNewParamsAliasesTLP = "amber"
	ThreatEventTagNewParamsAliasesTLPAmberStrict          ThreatEventTagNewParamsAliasesTLP = "amber-strict"
	ThreatEventTagNewParamsAliasesTLPGreen                ThreatEventTagNewParamsAliasesTLP = "green"
	ThreatEventTagNewParamsAliasesTLPClear                ThreatEventTagNewParamsAliasesTLP = "clear"
	ThreatEventTagNewParamsAliasesTLPPurple               ThreatEventTagNewParamsAliasesTLP = "purple"
	ThreatEventTagNewParamsAliasesTLPAmberStrictLowercase ThreatEventTagNewParamsAliasesTLP = "amber+strict"
)

func (ThreatEventTagNewParamsAliasesTLP) IsKnown added in v7.7.0 

func (r ThreatEventTagNewParamsAliasesTLP) IsKnown() bool

type ThreatEventTagNewParamsAttributionOrganizationObject added in v7.10.0 

type ThreatEventTagNewParamsAttributionOrganizationObject struct {
	Value      param.Field[string]                                                  `json:"value" api:"required"`
	Confidence param.Field[int64]                                                   `json:"confidence"`
	TLP        param.Field[ThreatEventTagNewParamsAttributionOrganizationObjectTLP] `json:"tlp"`
}

func (ThreatEventTagNewParamsAttributionOrganizationObject) ImplementsThreatEventTagNewParamsAttributionOrganizationUnion added in v7.10.0 

func (r ThreatEventTagNewParamsAttributionOrganizationObject) ImplementsThreatEventTagNewParamsAttributionOrganizationUnion()

func (ThreatEventTagNewParamsAttributionOrganizationObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagNewParamsAttributionOrganizationObjectTLP added in v7.10.0 

type ThreatEventTagNewParamsAttributionOrganizationObjectTLP string
const (
	ThreatEventTagNewParamsAttributionOrganizationObjectTLPRed                  ThreatEventTagNewParamsAttributionOrganizationObjectTLP = "red"
	ThreatEventTagNewParamsAttributionOrganizationObjectTLPAmber                ThreatEventTagNewParamsAttributionOrganizationObjectTLP = "amber"
	ThreatEventTagNewParamsAttributionOrganizationObjectTLPAmberStrict          ThreatEventTagNewParamsAttributionOrganizationObjectTLP = "amber-strict"
	ThreatEventTagNewParamsAttributionOrganizationObjectTLPGreen                ThreatEventTagNewParamsAttributionOrganizationObjectTLP = "green"
	ThreatEventTagNewParamsAttributionOrganizationObjectTLPClear                ThreatEventTagNewParamsAttributionOrganizationObjectTLP = "clear"
	ThreatEventTagNewParamsAttributionOrganizationObjectTLPPurple               ThreatEventTagNewParamsAttributionOrganizationObjectTLP = "purple"
	ThreatEventTagNewParamsAttributionOrganizationObjectTLPAmberStrictLowercase ThreatEventTagNewParamsAttributionOrganizationObjectTLP = "amber+strict"
)

func (ThreatEventTagNewParamsAttributionOrganizationObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewParamsAttributionOrganizationObjectTLP) IsKnown() bool

type ThreatEventTagNewParamsAttributionOrganizationUnion added in v7.10.0 

type ThreatEventTagNewParamsAttributionOrganizationUnion interface {
	ImplementsThreatEventTagNewParamsAttributionOrganizationUnion()
}

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagNewParamsAttributionOrganizationObject.

type ThreatEventTagNewParamsExternalReference added in v7.7.0 

type ThreatEventTagNewParamsExternalReference struct {
	URL         param.Field[string] `json:"url" api:"required"`
	Description param.Field[string] `json:"description"`
}

func (ThreatEventTagNewParamsExternalReference) MarshalJSON added in v7.7.0 

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

type ThreatEventTagNewParamsInternalAlias added in v7.7.0 

type ThreatEventTagNewParamsInternalAlias struct {
	Value      param.Field[string]                                    `json:"value" api:"required"`
	Confidence param.Field[int64]                                     `json:"confidence"`
	TLP        param.Field[ThreatEventTagNewParamsInternalAliasesTLP] `json:"tlp"`
}

func (ThreatEventTagNewParamsInternalAlias) MarshalJSON added in v7.7.0 

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

type ThreatEventTagNewParamsInternalAliasesTLP added in v7.7.0 

type ThreatEventTagNewParamsInternalAliasesTLP string
const (
	ThreatEventTagNewParamsInternalAliasesTLPRed                  ThreatEventTagNewParamsInternalAliasesTLP = "red"
	ThreatEventTagNewParamsInternalAliasesTLPAmber                ThreatEventTagNewParamsInternalAliasesTLP = "amber"
	ThreatEventTagNewParamsInternalAliasesTLPAmberStrict          ThreatEventTagNewParamsInternalAliasesTLP = "amber-strict"
	ThreatEventTagNewParamsInternalAliasesTLPGreen                ThreatEventTagNewParamsInternalAliasesTLP = "green"
	ThreatEventTagNewParamsInternalAliasesTLPClear                ThreatEventTagNewParamsInternalAliasesTLP = "clear"
	ThreatEventTagNewParamsInternalAliasesTLPPurple               ThreatEventTagNewParamsInternalAliasesTLP = "purple"
	ThreatEventTagNewParamsInternalAliasesTLPAmberStrictLowercase ThreatEventTagNewParamsInternalAliasesTLP = "amber+strict"
)

func (ThreatEventTagNewParamsInternalAliasesTLP) IsKnown added in v7.7.0 

func (r ThreatEventTagNewParamsInternalAliasesTLP) IsKnown() bool

type ThreatEventTagNewParamsMotiveObject added in v7.10.0 

type ThreatEventTagNewParamsMotiveObject struct {
	Value      param.Field[string]                                 `json:"value" api:"required"`
	Confidence param.Field[int64]                                  `json:"confidence"`
	TLP        param.Field[ThreatEventTagNewParamsMotiveObjectTLP] `json:"tlp"`
}

func (ThreatEventTagNewParamsMotiveObject) ImplementsThreatEventTagNewParamsMotiveUnion added in v7.10.0 

func (r ThreatEventTagNewParamsMotiveObject) ImplementsThreatEventTagNewParamsMotiveUnion()

func (ThreatEventTagNewParamsMotiveObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagNewParamsMotiveObjectTLP added in v7.10.0 

type ThreatEventTagNewParamsMotiveObjectTLP string
const (
	ThreatEventTagNewParamsMotiveObjectTLPRed                  ThreatEventTagNewParamsMotiveObjectTLP = "red"
	ThreatEventTagNewParamsMotiveObjectTLPAmber                ThreatEventTagNewParamsMotiveObjectTLP = "amber"
	ThreatEventTagNewParamsMotiveObjectTLPAmberStrict          ThreatEventTagNewParamsMotiveObjectTLP = "amber-strict"
	ThreatEventTagNewParamsMotiveObjectTLPGreen                ThreatEventTagNewParamsMotiveObjectTLP = "green"
	ThreatEventTagNewParamsMotiveObjectTLPClear                ThreatEventTagNewParamsMotiveObjectTLP = "clear"
	ThreatEventTagNewParamsMotiveObjectTLPPurple               ThreatEventTagNewParamsMotiveObjectTLP = "purple"
	ThreatEventTagNewParamsMotiveObjectTLPAmberStrictLowercase ThreatEventTagNewParamsMotiveObjectTLP = "amber+strict"
)

func (ThreatEventTagNewParamsMotiveObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewParamsMotiveObjectTLP) IsKnown() bool

type ThreatEventTagNewParamsMotiveUnion added in v7.10.0 

type ThreatEventTagNewParamsMotiveUnion interface {
	ImplementsThreatEventTagNewParamsMotiveUnion()
}

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagNewParamsMotiveObject.

type ThreatEventTagNewParamsOpsecLevelObject added in v7.10.0 

type ThreatEventTagNewParamsOpsecLevelObject struct {
	Value      param.Field[string]                                     `json:"value" api:"required"`
	Confidence param.Field[int64]                                      `json:"confidence"`
	TLP        param.Field[ThreatEventTagNewParamsOpsecLevelObjectTLP] `json:"tlp"`
}

func (ThreatEventTagNewParamsOpsecLevelObject) ImplementsThreatEventTagNewParamsOpsecLevelUnion added in v7.10.0 

func (r ThreatEventTagNewParamsOpsecLevelObject) ImplementsThreatEventTagNewParamsOpsecLevelUnion()

func (ThreatEventTagNewParamsOpsecLevelObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagNewParamsOpsecLevelObjectTLP added in v7.10.0 

type ThreatEventTagNewParamsOpsecLevelObjectTLP string
const (
	ThreatEventTagNewParamsOpsecLevelObjectTLPRed                  ThreatEventTagNewParamsOpsecLevelObjectTLP = "red"
	ThreatEventTagNewParamsOpsecLevelObjectTLPAmber                ThreatEventTagNewParamsOpsecLevelObjectTLP = "amber"
	ThreatEventTagNewParamsOpsecLevelObjectTLPAmberStrict          ThreatEventTagNewParamsOpsecLevelObjectTLP = "amber-strict"
	ThreatEventTagNewParamsOpsecLevelObjectTLPGreen                ThreatEventTagNewParamsOpsecLevelObjectTLP = "green"
	ThreatEventTagNewParamsOpsecLevelObjectTLPClear                ThreatEventTagNewParamsOpsecLevelObjectTLP = "clear"
	ThreatEventTagNewParamsOpsecLevelObjectTLPPurple               ThreatEventTagNewParamsOpsecLevelObjectTLP = "purple"
	ThreatEventTagNewParamsOpsecLevelObjectTLPAmberStrictLowercase ThreatEventTagNewParamsOpsecLevelObjectTLP = "amber+strict"
)

func (ThreatEventTagNewParamsOpsecLevelObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewParamsOpsecLevelObjectTLP) IsKnown() bool

type ThreatEventTagNewParamsOpsecLevelUnion added in v7.10.0 

type ThreatEventTagNewParamsOpsecLevelUnion interface {
	ImplementsThreatEventTagNewParamsOpsecLevelUnion()
}

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagNewParamsOpsecLevelObject.

type ThreatEventTagNewParamsOriginCountryISOObject added in v7.10.0 

type ThreatEventTagNewParamsOriginCountryISOObject struct {
	Value      param.Field[string]                                           `json:"value" api:"required"`
	Confidence param.Field[int64]                                            `json:"confidence"`
	TLP        param.Field[ThreatEventTagNewParamsOriginCountryISOObjectTLP] `json:"tlp"`
}

func (ThreatEventTagNewParamsOriginCountryISOObject) ImplementsThreatEventTagNewParamsOriginCountryISOUnion added in v7.10.0 

func (r ThreatEventTagNewParamsOriginCountryISOObject) ImplementsThreatEventTagNewParamsOriginCountryISOUnion()

func (ThreatEventTagNewParamsOriginCountryISOObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagNewParamsOriginCountryISOObjectTLP added in v7.10.0 

type ThreatEventTagNewParamsOriginCountryISOObjectTLP string
const (
	ThreatEventTagNewParamsOriginCountryISOObjectTLPRed                  ThreatEventTagNewParamsOriginCountryISOObjectTLP = "red"
	ThreatEventTagNewParamsOriginCountryISOObjectTLPAmber                ThreatEventTagNewParamsOriginCountryISOObjectTLP = "amber"
	ThreatEventTagNewParamsOriginCountryISOObjectTLPAmberStrict          ThreatEventTagNewParamsOriginCountryISOObjectTLP = "amber-strict"
	ThreatEventTagNewParamsOriginCountryISOObjectTLPGreen                ThreatEventTagNewParamsOriginCountryISOObjectTLP = "green"
	ThreatEventTagNewParamsOriginCountryISOObjectTLPClear                ThreatEventTagNewParamsOriginCountryISOObjectTLP = "clear"
	ThreatEventTagNewParamsOriginCountryISOObjectTLPPurple               ThreatEventTagNewParamsOriginCountryISOObjectTLP = "purple"
	ThreatEventTagNewParamsOriginCountryISOObjectTLPAmberStrictLowercase ThreatEventTagNewParamsOriginCountryISOObjectTLP = "amber+strict"
)

func (ThreatEventTagNewParamsOriginCountryISOObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewParamsOriginCountryISOObjectTLP) IsKnown() bool

type ThreatEventTagNewParamsOriginCountryISOUnion added in v7.10.0 

type ThreatEventTagNewParamsOriginCountryISOUnion interface {
	ImplementsThreatEventTagNewParamsOriginCountryISOUnion()
}

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagNewParamsOriginCountryISOObject.

type ThreatEventTagNewParamsPriorityObject added in v7.10.0 

type ThreatEventTagNewParamsPriorityObject struct {
	Value      param.Field[float64]                                  `json:"value" api:"required"`
	Confidence param.Field[int64]                                    `json:"confidence"`
	TLP        param.Field[ThreatEventTagNewParamsPriorityObjectTLP] `json:"tlp"`
}

func (ThreatEventTagNewParamsPriorityObject) ImplementsThreatEventTagNewParamsPriorityUnion added in v7.10.0 

func (r ThreatEventTagNewParamsPriorityObject) ImplementsThreatEventTagNewParamsPriorityUnion()

func (ThreatEventTagNewParamsPriorityObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagNewParamsPriorityObjectTLP added in v7.10.0 

type ThreatEventTagNewParamsPriorityObjectTLP string
const (
	ThreatEventTagNewParamsPriorityObjectTLPRed                  ThreatEventTagNewParamsPriorityObjectTLP = "red"
	ThreatEventTagNewParamsPriorityObjectTLPAmber                ThreatEventTagNewParamsPriorityObjectTLP = "amber"
	ThreatEventTagNewParamsPriorityObjectTLPAmberStrict          ThreatEventTagNewParamsPriorityObjectTLP = "amber-strict"
	ThreatEventTagNewParamsPriorityObjectTLPGreen                ThreatEventTagNewParamsPriorityObjectTLP = "green"
	ThreatEventTagNewParamsPriorityObjectTLPClear                ThreatEventTagNewParamsPriorityObjectTLP = "clear"
	ThreatEventTagNewParamsPriorityObjectTLPPurple               ThreatEventTagNewParamsPriorityObjectTLP = "purple"
	ThreatEventTagNewParamsPriorityObjectTLPAmberStrictLowercase ThreatEventTagNewParamsPriorityObjectTLP = "amber+strict"
)

func (ThreatEventTagNewParamsPriorityObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewParamsPriorityObjectTLP) IsKnown() bool

type ThreatEventTagNewParamsPriorityUnion added in v7.10.0 

type ThreatEventTagNewParamsPriorityUnion interface {
	ImplementsThreatEventTagNewParamsPriorityUnion()
}

Satisfied by shared.UnionFloat, cloudforce_one.ThreatEventTagNewParamsPriorityObject.

type ThreatEventTagNewParamsSophisticationLevelObject added in v7.10.0 

type ThreatEventTagNewParamsSophisticationLevelObject struct {
	Value      param.Field[string]                                              `json:"value" api:"required"`
	Confidence param.Field[int64]                                               `json:"confidence"`
	TLP        param.Field[ThreatEventTagNewParamsSophisticationLevelObjectTLP] `json:"tlp"`
}

func (ThreatEventTagNewParamsSophisticationLevelObject) ImplementsThreatEventTagNewParamsSophisticationLevelUnion added in v7.10.0 

func (r ThreatEventTagNewParamsSophisticationLevelObject) ImplementsThreatEventTagNewParamsSophisticationLevelUnion()

func (ThreatEventTagNewParamsSophisticationLevelObject) MarshalJSON added in v7.10.0 

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

type ThreatEventTagNewParamsSophisticationLevelObjectTLP added in v7.10.0 

type ThreatEventTagNewParamsSophisticationLevelObjectTLP string
const (
	ThreatEventTagNewParamsSophisticationLevelObjectTLPRed                  ThreatEventTagNewParamsSophisticationLevelObjectTLP = "red"
	ThreatEventTagNewParamsSophisticationLevelObjectTLPAmber                ThreatEventTagNewParamsSophisticationLevelObjectTLP = "amber"
	ThreatEventTagNewParamsSophisticationLevelObjectTLPAmberStrict          ThreatEventTagNewParamsSophisticationLevelObjectTLP = "amber-strict"
	ThreatEventTagNewParamsSophisticationLevelObjectTLPGreen                ThreatEventTagNewParamsSophisticationLevelObjectTLP = "green"
	ThreatEventTagNewParamsSophisticationLevelObjectTLPClear                ThreatEventTagNewParamsSophisticationLevelObjectTLP = "clear"
	ThreatEventTagNewParamsSophisticationLevelObjectTLPPurple               ThreatEventTagNewParamsSophisticationLevelObjectTLP = "purple"
	ThreatEventTagNewParamsSophisticationLevelObjectTLPAmberStrictLowercase ThreatEventTagNewParamsSophisticationLevelObjectTLP = "amber+strict"
)

func (ThreatEventTagNewParamsSophisticationLevelObjectTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewParamsSophisticationLevelObjectTLP) IsKnown() bool

type ThreatEventTagNewParamsSophisticationLevelUnion added in v7.10.0 

type ThreatEventTagNewParamsSophisticationLevelUnion interface {
	ImplementsThreatEventTagNewParamsSophisticationLevelUnion()
}

Satisfied by shared.UnionString, cloudforce_one.ThreatEventTagNewParamsSophisticationLevelObject.

type ThreatEventTagNewParamsTLP added in v7.10.0 

type ThreatEventTagNewParamsTLP string

Tag-level TLP handling marking. Optional. Allowed values: red, amber, amber-strict, green, clear, purple, amber+strict. 

const (
	ThreatEventTagNewParamsTLPRed                  ThreatEventTagNewParamsTLP = "red"
	ThreatEventTagNewParamsTLPAmber                ThreatEventTagNewParamsTLP = "amber"
	ThreatEventTagNewParamsTLPAmberStrict          ThreatEventTagNewParamsTLP = "amber-strict"
	ThreatEventTagNewParamsTLPGreen                ThreatEventTagNewParamsTLP = "green"
	ThreatEventTagNewParamsTLPClear                ThreatEventTagNewParamsTLP = "clear"
	ThreatEventTagNewParamsTLPPurple               ThreatEventTagNewParamsTLP = "purple"
	ThreatEventTagNewParamsTLPAmberStrictLowercase ThreatEventTagNewParamsTLP = "amber+strict"
)

func (ThreatEventTagNewParamsTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewParamsTLP) IsKnown() bool

type ThreatEventTagNewResponse 

type ThreatEventTagNewResponse struct {
	UUID                    string                                           `json:"uuid" api:"required"`
	Value                   string                                           `json:"value" api:"required"`
	ActiveDuration          string                                           `json:"activeDuration"`
	ActiveDurationAnnotated ThreatEventTagNewResponseActiveDurationAnnotated `json:"activeDuration_annotated" api:"nullable"`
	ActorCategory           string                                           `json:"actorCategory"`
	ActorCategoryAnnotated  ThreatEventTagNewResponseActorCategoryAnnotated  `json:"actorCategory_annotated" api:"nullable"`
	// Structured aliases ({ value, confidence 1-10, tlp }). Public: returned to all
	// accounts with per-entry TLP filtering (entries with tlp: purple are removed for
	// non-CFONE accounts).
	Aliases                          []ThreatEventTagNewResponseAlias                          `json:"aliases"`
	AliasGroupNames                  []string                                                  `json:"aliasGroupNames"`
	AliasGroupNamesInternal          []string                                                  `json:"aliasGroupNamesInternal"`
	AttributionOrganization          string                                                    `json:"attributionOrganization"`
	AttributionOrganizationAnnotated ThreatEventTagNewResponseAttributionOrganizationAnnotated `json:"attributionOrganization_annotated" api:"nullable"`
	CategoryName                     string                                                    `json:"categoryName"`
	CategoryUUID                     string                                                    `json:"categoryUuid"`
	// Overall tag confidence (1-10).
	Confidence             int64    `json:"confidence" api:"nullable"`
	CreatedAt              string   `json:"createdAt"`
	DateOfDiscovery        string   `json:"dateOfDiscovery"`
	Description            string   `json:"description"`
	ExternalReferenceLinks []string `json:"externalReferenceLinks"`
	// Structured external references ({ url, description }). Public: returned to all
	// accounts.
	ExternalReferences          []ThreatEventTagNewResponseExternalReference           `json:"externalReferences"`
	ExternalReferencesAnnotated []ThreatEventTagNewResponseExternalReferencesAnnotated `json:"externalReferences_annotated" api:"nullable"`
	// Owner-private structured aliases ({ value, confidence 1-10, tlp }). Returned to
	// the owning account and omitted from shared-catalog non-owner responses.
	InternalAliases     []ThreatEventTagNewResponseInternalAlias     `json:"internalAliases"`
	InternalDescription string                                       `json:"internalDescription"`
	LastSeen            string                                       `json:"lastSeen"`
	Motive              string                                       `json:"motive"`
	MotiveAnnotated     ThreatEventTagNewResponseMotiveAnnotated     `json:"motive_annotated" api:"nullable"`
	OpsecLevel          string                                       `json:"opsecLevel"`
	OpsecLevelAnnotated ThreatEventTagNewResponseOpsecLevelAnnotated `json:"opsecLevel_annotated" api:"nullable"`
	// ISO country code (alpha-2 or alpha-3). Normalized to uppercase on read. Null
	// when stored value is blank/whitespace.
	OriginCountryISO          string                                             `json:"originCountryISO" api:"nullable"`
	OriginCountryISOAnnotated ThreatEventTagNewResponseOriginCountryISOAnnotated `json:"originCountryISO_annotated" api:"nullable"`
	Priority                  float64                                            `json:"priority"`
	PriorityAnnotated         ThreatEventTagNewResponsePriorityAnnotated         `json:"priority_annotated" api:"nullable"`
	// Parsed custom field values. Null when the tag has no custom fields.
	Properties                   map[string]interface{}                                `json:"properties" api:"nullable"`
	SophisticationLevel          string                                                `json:"sophisticationLevel"`
	SophisticationLevelAnnotated ThreatEventTagNewResponseSophisticationLevelAnnotated `json:"sophisticationLevel_annotated" api:"nullable"`
	// Tag-level TLP handling marking.
	TLP       ThreatEventTagNewResponseTLP  `json:"tlp" api:"nullable"`
	UpdatedAt string                        `json:"updatedAt"`
	Version   float64                       `json:"version"`
	JSON      threatEventTagNewResponseJSON `json:"-"`
}

func (*ThreatEventTagNewResponse) UnmarshalJSON 

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

type ThreatEventTagNewResponseActiveDurationAnnotated added in v7.10.0 

type ThreatEventTagNewResponseActiveDurationAnnotated struct {
	Value string                                               `json:"value" api:"required"`
	TLP   ThreatEventTagNewResponseActiveDurationAnnotatedTLP  `json:"tlp"`
	JSON  threatEventTagNewResponseActiveDurationAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagNewResponseActiveDurationAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagNewResponseActiveDurationAnnotatedTLP added in v7.10.0 

type ThreatEventTagNewResponseActiveDurationAnnotatedTLP string
const (
	ThreatEventTagNewResponseActiveDurationAnnotatedTLPRed                  ThreatEventTagNewResponseActiveDurationAnnotatedTLP = "red"
	ThreatEventTagNewResponseActiveDurationAnnotatedTLPAmber                ThreatEventTagNewResponseActiveDurationAnnotatedTLP = "amber"
	ThreatEventTagNewResponseActiveDurationAnnotatedTLPAmberStrict          ThreatEventTagNewResponseActiveDurationAnnotatedTLP = "amber-strict"
	ThreatEventTagNewResponseActiveDurationAnnotatedTLPGreen                ThreatEventTagNewResponseActiveDurationAnnotatedTLP = "green"
	ThreatEventTagNewResponseActiveDurationAnnotatedTLPClear                ThreatEventTagNewResponseActiveDurationAnnotatedTLP = "clear"
	ThreatEventTagNewResponseActiveDurationAnnotatedTLPPurple               ThreatEventTagNewResponseActiveDurationAnnotatedTLP = "purple"
	ThreatEventTagNewResponseActiveDurationAnnotatedTLPAmberStrictLowercase ThreatEventTagNewResponseActiveDurationAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagNewResponseActiveDurationAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewResponseActiveDurationAnnotatedTLP) IsKnown() bool

type ThreatEventTagNewResponseActorCategoryAnnotated added in v7.10.0 

type ThreatEventTagNewResponseActorCategoryAnnotated struct {
	Value      string                                              `json:"value" api:"required"`
	Confidence float64                                             `json:"confidence"`
	TLP        ThreatEventTagNewResponseActorCategoryAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagNewResponseActorCategoryAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagNewResponseActorCategoryAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagNewResponseActorCategoryAnnotatedTLP added in v7.10.0 

type ThreatEventTagNewResponseActorCategoryAnnotatedTLP string
const (
	ThreatEventTagNewResponseActorCategoryAnnotatedTLPRed                  ThreatEventTagNewResponseActorCategoryAnnotatedTLP = "red"
	ThreatEventTagNewResponseActorCategoryAnnotatedTLPAmber                ThreatEventTagNewResponseActorCategoryAnnotatedTLP = "amber"
	ThreatEventTagNewResponseActorCategoryAnnotatedTLPAmberStrict          ThreatEventTagNewResponseActorCategoryAnnotatedTLP = "amber-strict"
	ThreatEventTagNewResponseActorCategoryAnnotatedTLPGreen                ThreatEventTagNewResponseActorCategoryAnnotatedTLP = "green"
	ThreatEventTagNewResponseActorCategoryAnnotatedTLPClear                ThreatEventTagNewResponseActorCategoryAnnotatedTLP = "clear"
	ThreatEventTagNewResponseActorCategoryAnnotatedTLPPurple               ThreatEventTagNewResponseActorCategoryAnnotatedTLP = "purple"
	ThreatEventTagNewResponseActorCategoryAnnotatedTLPAmberStrictLowercase ThreatEventTagNewResponseActorCategoryAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagNewResponseActorCategoryAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewResponseActorCategoryAnnotatedTLP) IsKnown() bool

type ThreatEventTagNewResponseAlias added in v7.7.0 

type ThreatEventTagNewResponseAlias struct {
	Value      string                              `json:"value" api:"required"`
	Confidence int64                               `json:"confidence" api:"nullable"`
	TLP        ThreatEventTagNewResponseAliasesTLP `json:"tlp" api:"nullable"`
	JSON       threatEventTagNewResponseAliasJSON  `json:"-"`
}

func (*ThreatEventTagNewResponseAlias) UnmarshalJSON added in v7.7.0 

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

type ThreatEventTagNewResponseAliasesTLP added in v7.7.0 

type ThreatEventTagNewResponseAliasesTLP string
const (
	ThreatEventTagNewResponseAliasesTLPRed                  ThreatEventTagNewResponseAliasesTLP = "red"
	ThreatEventTagNewResponseAliasesTLPAmber                ThreatEventTagNewResponseAliasesTLP = "amber"
	ThreatEventTagNewResponseAliasesTLPAmberStrict          ThreatEventTagNewResponseAliasesTLP = "amber-strict"
	ThreatEventTagNewResponseAliasesTLPGreen                ThreatEventTagNewResponseAliasesTLP = "green"
	ThreatEventTagNewResponseAliasesTLPClear                ThreatEventTagNewResponseAliasesTLP = "clear"
	ThreatEventTagNewResponseAliasesTLPPurple               ThreatEventTagNewResponseAliasesTLP = "purple"
	ThreatEventTagNewResponseAliasesTLPAmberStrictLowercase ThreatEventTagNewResponseAliasesTLP = "amber+strict"
)

func (ThreatEventTagNewResponseAliasesTLP) IsKnown added in v7.7.0 

func (r ThreatEventTagNewResponseAliasesTLP) IsKnown() bool

type ThreatEventTagNewResponseAttributionOrganizationAnnotated added in v7.10.0 

type ThreatEventTagNewResponseAttributionOrganizationAnnotated struct {
	Value      string                                                        `json:"value" api:"required"`
	Confidence float64                                                       `json:"confidence"`
	TLP        ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagNewResponseAttributionOrganizationAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagNewResponseAttributionOrganizationAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLP added in v7.10.0 

type ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLP string
const (
	ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLPRed                  ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLP = "red"
	ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLPAmber                ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLP = "amber"
	ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLPAmberStrict          ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLP = "amber-strict"
	ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLPGreen                ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLP = "green"
	ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLPClear                ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLP = "clear"
	ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLPPurple               ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLP = "purple"
	ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLPAmberStrictLowercase ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewResponseAttributionOrganizationAnnotatedTLP) IsKnown() bool

type ThreatEventTagNewResponseExternalReference added in v7.7.0 

type ThreatEventTagNewResponseExternalReference struct {
	URL         string                                         `json:"url" api:"required"`
	Description string                                         `json:"description" api:"nullable"`
	JSON        threatEventTagNewResponseExternalReferenceJSON `json:"-"`
}

func (*ThreatEventTagNewResponseExternalReference) UnmarshalJSON added in v7.7.0 

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

type ThreatEventTagNewResponseExternalReferencesAnnotated added in v7.10.0 

type ThreatEventTagNewResponseExternalReferencesAnnotated struct {
	Value string                                                   `json:"value" api:"required"`
	TLP   ThreatEventTagNewResponseExternalReferencesAnnotatedTLP  `json:"tlp"`
	JSON  threatEventTagNewResponseExternalReferencesAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagNewResponseExternalReferencesAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagNewResponseExternalReferencesAnnotatedTLP added in v7.10.0 

type ThreatEventTagNewResponseExternalReferencesAnnotatedTLP string
const (
	ThreatEventTagNewResponseExternalReferencesAnnotatedTLPRed                  ThreatEventTagNewResponseExternalReferencesAnnotatedTLP = "red"
	ThreatEventTagNewResponseExternalReferencesAnnotatedTLPAmber                ThreatEventTagNewResponseExternalReferencesAnnotatedTLP = "amber"
	ThreatEventTagNewResponseExternalReferencesAnnotatedTLPAmberStrict          ThreatEventTagNewResponseExternalReferencesAnnotatedTLP = "amber-strict"
	ThreatEventTagNewResponseExternalReferencesAnnotatedTLPGreen                ThreatEventTagNewResponseExternalReferencesAnnotatedTLP = "green"
	ThreatEventTagNewResponseExternalReferencesAnnotatedTLPClear                ThreatEventTagNewResponseExternalReferencesAnnotatedTLP = "clear"
	ThreatEventTagNewResponseExternalReferencesAnnotatedTLPPurple               ThreatEventTagNewResponseExternalReferencesAnnotatedTLP = "purple"
	ThreatEventTagNewResponseExternalReferencesAnnotatedTLPAmberStrictLowercase ThreatEventTagNewResponseExternalReferencesAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagNewResponseExternalReferencesAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewResponseExternalReferencesAnnotatedTLP) IsKnown() bool

type ThreatEventTagNewResponseInternalAlias added in v7.7.0 

type ThreatEventTagNewResponseInternalAlias struct {
	Value      string                                      `json:"value" api:"required"`
	Confidence int64                                       `json:"confidence" api:"nullable"`
	TLP        ThreatEventTagNewResponseInternalAliasesTLP `json:"tlp" api:"nullable"`
	JSON       threatEventTagNewResponseInternalAliasJSON  `json:"-"`
}

func (*ThreatEventTagNewResponseInternalAlias) UnmarshalJSON added in v7.7.0 

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

type ThreatEventTagNewResponseInternalAliasesTLP added in v7.7.0 

type ThreatEventTagNewResponseInternalAliasesTLP string
const (
	ThreatEventTagNewResponseInternalAliasesTLPRed                  ThreatEventTagNewResponseInternalAliasesTLP = "red"
	ThreatEventTagNewResponseInternalAliasesTLPAmber                ThreatEventTagNewResponseInternalAliasesTLP = "amber"
	ThreatEventTagNewResponseInternalAliasesTLPAmberStrict          ThreatEventTagNewResponseInternalAliasesTLP = "amber-strict"
	ThreatEventTagNewResponseInternalAliasesTLPGreen                ThreatEventTagNewResponseInternalAliasesTLP = "green"
	ThreatEventTagNewResponseInternalAliasesTLPClear                ThreatEventTagNewResponseInternalAliasesTLP = "clear"
	ThreatEventTagNewResponseInternalAliasesTLPPurple               ThreatEventTagNewResponseInternalAliasesTLP = "purple"
	ThreatEventTagNewResponseInternalAliasesTLPAmberStrictLowercase ThreatEventTagNewResponseInternalAliasesTLP = "amber+strict"
)

func (ThreatEventTagNewResponseInternalAliasesTLP) IsKnown added in v7.7.0 

func (r ThreatEventTagNewResponseInternalAliasesTLP) IsKnown() bool

type ThreatEventTagNewResponseMotiveAnnotated added in v7.10.0 

type ThreatEventTagNewResponseMotiveAnnotated struct {
	Value      string                                       `json:"value" api:"required"`
	Confidence float64                                      `json:"confidence"`
	TLP        ThreatEventTagNewResponseMotiveAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagNewResponseMotiveAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagNewResponseMotiveAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagNewResponseMotiveAnnotatedTLP added in v7.10.0 

type ThreatEventTagNewResponseMotiveAnnotatedTLP string
const (
	ThreatEventTagNewResponseMotiveAnnotatedTLPRed                  ThreatEventTagNewResponseMotiveAnnotatedTLP = "red"
	ThreatEventTagNewResponseMotiveAnnotatedTLPAmber                ThreatEventTagNewResponseMotiveAnnotatedTLP = "amber"
	ThreatEventTagNewResponseMotiveAnnotatedTLPAmberStrict          ThreatEventTagNewResponseMotiveAnnotatedTLP = "amber-strict"
	ThreatEventTagNewResponseMotiveAnnotatedTLPGreen                ThreatEventTagNewResponseMotiveAnnotatedTLP = "green"
	ThreatEventTagNewResponseMotiveAnnotatedTLPClear                ThreatEventTagNewResponseMotiveAnnotatedTLP = "clear"
	ThreatEventTagNewResponseMotiveAnnotatedTLPPurple               ThreatEventTagNewResponseMotiveAnnotatedTLP = "purple"
	ThreatEventTagNewResponseMotiveAnnotatedTLPAmberStrictLowercase ThreatEventTagNewResponseMotiveAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagNewResponseMotiveAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewResponseMotiveAnnotatedTLP) IsKnown() bool

type ThreatEventTagNewResponseOpsecLevelAnnotated added in v7.10.0 

type ThreatEventTagNewResponseOpsecLevelAnnotated struct {
	Value      string                                           `json:"value" api:"required"`
	Confidence float64                                          `json:"confidence"`
	TLP        ThreatEventTagNewResponseOpsecLevelAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagNewResponseOpsecLevelAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagNewResponseOpsecLevelAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagNewResponseOpsecLevelAnnotatedTLP added in v7.10.0 

type ThreatEventTagNewResponseOpsecLevelAnnotatedTLP string
const (
	ThreatEventTagNewResponseOpsecLevelAnnotatedTLPRed                  ThreatEventTagNewResponseOpsecLevelAnnotatedTLP = "red"
	ThreatEventTagNewResponseOpsecLevelAnnotatedTLPAmber                ThreatEventTagNewResponseOpsecLevelAnnotatedTLP = "amber"
	ThreatEventTagNewResponseOpsecLevelAnnotatedTLPAmberStrict          ThreatEventTagNewResponseOpsecLevelAnnotatedTLP = "amber-strict"
	ThreatEventTagNewResponseOpsecLevelAnnotatedTLPGreen                ThreatEventTagNewResponseOpsecLevelAnnotatedTLP = "green"
	ThreatEventTagNewResponseOpsecLevelAnnotatedTLPClear                ThreatEventTagNewResponseOpsecLevelAnnotatedTLP = "clear"
	ThreatEventTagNewResponseOpsecLevelAnnotatedTLPPurple               ThreatEventTagNewResponseOpsecLevelAnnotatedTLP = "purple"
	ThreatEventTagNewResponseOpsecLevelAnnotatedTLPAmberStrictLowercase ThreatEventTagNewResponseOpsecLevelAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagNewResponseOpsecLevelAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewResponseOpsecLevelAnnotatedTLP) IsKnown() bool

type ThreatEventTagNewResponseOriginCountryISOAnnotated added in v7.10.0 

type ThreatEventTagNewResponseOriginCountryISOAnnotated struct {
	Value      string                                                 `json:"value" api:"required,nullable"`
	Confidence float64                                                `json:"confidence"`
	TLP        ThreatEventTagNewResponseOriginCountryISOAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagNewResponseOriginCountryISOAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagNewResponseOriginCountryISOAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagNewResponseOriginCountryISOAnnotatedTLP added in v7.10.0 

type ThreatEventTagNewResponseOriginCountryISOAnnotatedTLP string
const (
	ThreatEventTagNewResponseOriginCountryISOAnnotatedTLPRed                  ThreatEventTagNewResponseOriginCountryISOAnnotatedTLP = "red"
	ThreatEventTagNewResponseOriginCountryISOAnnotatedTLPAmber                ThreatEventTagNewResponseOriginCountryISOAnnotatedTLP = "amber"
	ThreatEventTagNewResponseOriginCountryISOAnnotatedTLPAmberStrict          ThreatEventTagNewResponseOriginCountryISOAnnotatedTLP = "amber-strict"
	ThreatEventTagNewResponseOriginCountryISOAnnotatedTLPGreen                ThreatEventTagNewResponseOriginCountryISOAnnotatedTLP = "green"
	ThreatEventTagNewResponseOriginCountryISOAnnotatedTLPClear                ThreatEventTagNewResponseOriginCountryISOAnnotatedTLP = "clear"
	ThreatEventTagNewResponseOriginCountryISOAnnotatedTLPPurple               ThreatEventTagNewResponseOriginCountryISOAnnotatedTLP = "purple"
	ThreatEventTagNewResponseOriginCountryISOAnnotatedTLPAmberStrictLowercase ThreatEventTagNewResponseOriginCountryISOAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagNewResponseOriginCountryISOAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewResponseOriginCountryISOAnnotatedTLP) IsKnown() bool

type ThreatEventTagNewResponsePriorityAnnotated added in v7.10.0 

type ThreatEventTagNewResponsePriorityAnnotated struct {
	Value float64                                        `json:"value" api:"required"`
	TLP   ThreatEventTagNewResponsePriorityAnnotatedTLP  `json:"tlp"`
	JSON  threatEventTagNewResponsePriorityAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagNewResponsePriorityAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagNewResponsePriorityAnnotatedTLP added in v7.10.0 

type ThreatEventTagNewResponsePriorityAnnotatedTLP string
const (
	ThreatEventTagNewResponsePriorityAnnotatedTLPRed                  ThreatEventTagNewResponsePriorityAnnotatedTLP = "red"
	ThreatEventTagNewResponsePriorityAnnotatedTLPAmber                ThreatEventTagNewResponsePriorityAnnotatedTLP = "amber"
	ThreatEventTagNewResponsePriorityAnnotatedTLPAmberStrict          ThreatEventTagNewResponsePriorityAnnotatedTLP = "amber-strict"
	ThreatEventTagNewResponsePriorityAnnotatedTLPGreen                ThreatEventTagNewResponsePriorityAnnotatedTLP = "green"
	ThreatEventTagNewResponsePriorityAnnotatedTLPClear                ThreatEventTagNewResponsePriorityAnnotatedTLP = "clear"
	ThreatEventTagNewResponsePriorityAnnotatedTLPPurple               ThreatEventTagNewResponsePriorityAnnotatedTLP = "purple"
	ThreatEventTagNewResponsePriorityAnnotatedTLPAmberStrictLowercase ThreatEventTagNewResponsePriorityAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagNewResponsePriorityAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewResponsePriorityAnnotatedTLP) IsKnown() bool

type ThreatEventTagNewResponseSophisticationLevelAnnotated added in v7.10.0 

type ThreatEventTagNewResponseSophisticationLevelAnnotated struct {
	Value      string                                                    `json:"value" api:"required"`
	Confidence float64                                                   `json:"confidence"`
	TLP        ThreatEventTagNewResponseSophisticationLevelAnnotatedTLP  `json:"tlp"`
	JSON       threatEventTagNewResponseSophisticationLevelAnnotatedJSON `json:"-"`
}

func (*ThreatEventTagNewResponseSophisticationLevelAnnotated) UnmarshalJSON added in v7.10.0 

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

type ThreatEventTagNewResponseSophisticationLevelAnnotatedTLP added in v7.10.0 

type ThreatEventTagNewResponseSophisticationLevelAnnotatedTLP string
const (
	ThreatEventTagNewResponseSophisticationLevelAnnotatedTLPRed                  ThreatEventTagNewResponseSophisticationLevelAnnotatedTLP = "red"
	ThreatEventTagNewResponseSophisticationLevelAnnotatedTLPAmber                ThreatEventTagNewResponseSophisticationLevelAnnotatedTLP = "amber"
	ThreatEventTagNewResponseSophisticationLevelAnnotatedTLPAmberStrict          ThreatEventTagNewResponseSophisticationLevelAnnotatedTLP = "amber-strict"
	ThreatEventTagNewResponseSophisticationLevelAnnotatedTLPGreen                ThreatEventTagNewResponseSophisticationLevelAnnotatedTLP = "green"
	ThreatEventTagNewResponseSophisticationLevelAnnotatedTLPClear                ThreatEventTagNewResponseSophisticationLevelAnnotatedTLP = "clear"
	ThreatEventTagNewResponseSophisticationLevelAnnotatedTLPPurple               ThreatEventTagNewResponseSophisticationLevelAnnotatedTLP = "purple"
	ThreatEventTagNewResponseSophisticationLevelAnnotatedTLPAmberStrictLowercase ThreatEventTagNewResponseSophisticationLevelAnnotatedTLP = "amber+strict"
)

func (ThreatEventTagNewResponseSophisticationLevelAnnotatedTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewResponseSophisticationLevelAnnotatedTLP) IsKnown() bool

type ThreatEventTagNewResponseTLP added in v7.10.0 

type ThreatEventTagNewResponseTLP string

Tag-level TLP handling marking. 

const (
	ThreatEventTagNewResponseTLPRed                  ThreatEventTagNewResponseTLP = "red"
	ThreatEventTagNewResponseTLPAmber                ThreatEventTagNewResponseTLP = "amber"
	ThreatEventTagNewResponseTLPAmberStrict          ThreatEventTagNewResponseTLP = "amber-strict"
	ThreatEventTagNewResponseTLPGreen                ThreatEventTagNewResponseTLP = "green"
	ThreatEventTagNewResponseTLPClear                ThreatEventTagNewResponseTLP = "clear"
	ThreatEventTagNewResponseTLPPurple               ThreatEventTagNewResponseTLP = "purple"
	ThreatEventTagNewResponseTLPAmberStrictLowercase ThreatEventTagNewResponseTLP = "amber+strict"
)

func (ThreatEventTagNewResponseTLP) IsKnown added in v7.10.0 

func (r ThreatEventTagNewResponseTLP) IsKnown() bool

type ThreatEventTagService 

type ThreatEventTagService struct {
	Options    []option.RequestOption
	Categories *ThreatEventTagCategoryService
	Indicators *ThreatEventTagIndicatorService
}

ThreatEventTagService 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 NewThreatEventTagService method instead.

func NewThreatEventTagService 

func NewThreatEventTagService(opts ...option.RequestOption) (r *ThreatEventTagService)

NewThreatEventTagService 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 (*ThreatEventTagService) Delete added in v7.8.0 

func (r *ThreatEventTagService) Delete(ctx context.Context, tagUUID string, body ThreatEventTagDeleteParams, opts ...option.RequestOption) (res *ThreatEventTagDeleteResponse, err error)

Deletes a Source-of-Truth tag by UUID.

func (*ThreatEventTagService) Edit added in v7.8.0 

func (r *ThreatEventTagService) Edit(ctx context.Context, tagUUID string, params ThreatEventTagEditParams, opts ...option.RequestOption) (res *ThreatEventTagEditResponse, err error)

Updates an account-owned Source-of-Truth tag by UUID and returns its complete owner projection.

func (*ThreatEventTagService) List added in v7.8.0 

func (r *ThreatEventTagService) List(ctx context.Context, params ThreatEventTagListParams, opts ...option.RequestOption) (res *ThreatEventTagListResponse, err error)

Returns all Source-of-Truth tags for an account. Supports legacy free-text `search` on tag value and `categoryUuid` exact match, plus a structured `filters` JSON array for filtering by metadata fields (originCountryISO, actorCategory, motive, priority, etc.). The authenticated account owns these account-scoped tags and receives their complete owner projection. Country values may be passed as alpha-2, alpha-3, name, or common alias. Purple TLP remains CFONE-only.

func (*ThreatEventTagService) New 

func (r *ThreatEventTagService) New(ctx context.Context, params ThreatEventTagNewParams, opts ...option.RequestOption) (res *ThreatEventTagNewResponse, err error)

Creates an account-owned tag for threat events and returns its complete owner projection.

type ThreatEventTargetIndustryByDatasetListParams added in v7.8.0 

type ThreatEventTargetIndustryByDatasetListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventTargetIndustryByDatasetListResponse added in v7.8.0 

type ThreatEventTargetIndustryByDatasetListResponse struct {
	Items ThreatEventTargetIndustryByDatasetListResponseItems `json:"items" api:"required"`
	Type  string                                              `json:"type" api:"required"`
	JSON  threatEventTargetIndustryByDatasetListResponseJSON  `json:"-"`
}

func (*ThreatEventTargetIndustryByDatasetListResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTargetIndustryByDatasetListResponseItems added in v7.8.0 

type ThreatEventTargetIndustryByDatasetListResponseItems struct {
	Type string                                                  `json:"type" api:"required"`
	JSON threatEventTargetIndustryByDatasetListResponseItemsJSON `json:"-"`
}

func (*ThreatEventTargetIndustryByDatasetListResponseItems) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTargetIndustryByDatasetService added in v7.8.0 

type ThreatEventTargetIndustryByDatasetService struct {
	Options []option.RequestOption
}

ThreatEventTargetIndustryByDatasetService 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 NewThreatEventTargetIndustryByDatasetService method instead.

func NewThreatEventTargetIndustryByDatasetService added in v7.8.0 

func NewThreatEventTargetIndustryByDatasetService(opts ...option.RequestOption) (r *ThreatEventTargetIndustryByDatasetService)

NewThreatEventTargetIndustryByDatasetService 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 (*ThreatEventTargetIndustryByDatasetService) List added in v7.8.0 

func (r *ThreatEventTargetIndustryByDatasetService) List(ctx context.Context, datasetID string, query ThreatEventTargetIndustryByDatasetListParams, opts ...option.RequestOption) (res *ThreatEventTargetIndustryByDatasetListResponse, err error)

Lists all target industries for a specific dataset

type ThreatEventTargetIndustryCatalogListParams added in v7.8.0 

type ThreatEventTargetIndustryCatalogListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ThreatEventTargetIndustryCatalogListResponse added in v7.8.0 

type ThreatEventTargetIndustryCatalogListResponse struct {
	Items ThreatEventTargetIndustryCatalogListResponseItems `json:"items" api:"required"`
	Type  string                                            `json:"type" api:"required"`
	JSON  threatEventTargetIndustryCatalogListResponseJSON  `json:"-"`
}

func (*ThreatEventTargetIndustryCatalogListResponse) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTargetIndustryCatalogListResponseItems added in v7.8.0 

type ThreatEventTargetIndustryCatalogListResponseItems struct {
	Type string                                                `json:"type" api:"required"`
	JSON threatEventTargetIndustryCatalogListResponseItemsJSON `json:"-"`
}

func (*ThreatEventTargetIndustryCatalogListResponseItems) UnmarshalJSON added in v7.8.0 

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

type ThreatEventTargetIndustryCatalogService added in v7.8.0 

type ThreatEventTargetIndustryCatalogService struct {
	Options []option.RequestOption
}

ThreatEventTargetIndustryCatalogService 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 NewThreatEventTargetIndustryCatalogService method instead.

func NewThreatEventTargetIndustryCatalogService added in v7.8.0 

func NewThreatEventTargetIndustryCatalogService(opts ...option.RequestOption) (r *ThreatEventTargetIndustryCatalogService)

NewThreatEventTargetIndustryCatalogService 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 (*ThreatEventTargetIndustryCatalogService) List added in v7.8.0 

func (r *ThreatEventTargetIndustryCatalogService) List(ctx context.Context, query ThreatEventTargetIndustryCatalogListParams, opts ...option.RequestOption) (res *ThreatEventTargetIndustryCatalogListResponse, err error)

Lists all target industries from industry map catalog

type ThreatEventTargetIndustryListParams 

type ThreatEventTargetIndustryListParams struct {
	// Account ID.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Array of dataset IDs to query target industries from. If not provided, uses the
	// default dataset.
	DatasetIDs param.Field[[]string] `query:"datasetIds"`
}

func (ThreatEventTargetIndustryListParams) URLQuery 

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

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

type ThreatEventTargetIndustryListResponse 

type ThreatEventTargetIndustryListResponse struct {
	Items ThreatEventTargetIndustryListResponseItems `json:"items" api:"required"`
	Type  string                                     `json:"type" api:"required"`
	JSON  threatEventTargetIndustryListResponseJSON  `json:"-"`
}

func (*ThreatEventTargetIndustryListResponse) UnmarshalJSON 

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

type ThreatEventTargetIndustryListResponseItems 

type ThreatEventTargetIndustryListResponseItems struct {
	Type string                                         `json:"type" api:"required"`
	JSON threatEventTargetIndustryListResponseItemsJSON `json:"-"`
}

func (*ThreatEventTargetIndustryListResponseItems) UnmarshalJSON 

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

type ThreatEventTargetIndustryService 

type ThreatEventTargetIndustryService struct {
	Options   []option.RequestOption
	ByDataset *ThreatEventTargetIndustryByDatasetService
	Catalog   *ThreatEventTargetIndustryCatalogService
}

ThreatEventTargetIndustryService 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 NewThreatEventTargetIndustryService method instead.

func NewThreatEventTargetIndustryService 

func NewThreatEventTargetIndustryService(opts ...option.RequestOption) (r *ThreatEventTargetIndustryService)

NewThreatEventTargetIndustryService 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 (*ThreatEventTargetIndustryService) List 

func (r *ThreatEventTargetIndustryService) List(ctx context.Context, params ThreatEventTargetIndustryListParams, opts ...option.RequestOption) (res *ThreatEventTargetIndustryListResponse, err error)

Retrieves the catalog of industry classifications used in Cloudforce One threat intelligence.

type ThreatSignalArticleBulkEditParams 

type ThreatSignalArticleBulkEditParams struct {
	AccountID  param.Field[string]   `path:"account_id" api:"required"`
	ArticleIDs param.Field[[]string] `json:"article_ids" api:"required" format:"uuid"`
	Read       param.Field[bool]     `json:"read" api:"required"`
}

func (ThreatSignalArticleBulkEditParams) MarshalJSON 

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

type ThreatSignalArticleBulkEditResponse 

type ThreatSignalArticleBulkEditResponse struct {
	UpdatedCount float64                                 `json:"updated_count" api:"required"`
	JSON         threatSignalArticleBulkEditResponseJSON `json:"-"`
}

func (*ThreatSignalArticleBulkEditResponse) UnmarshalJSON 

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

type ThreatSignalArticleBulkEditResponseEnvelope 

type ThreatSignalArticleBulkEditResponseEnvelope struct {
	Errors   []ThreatSignalArticleBulkEditResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ThreatSignalArticleBulkEditResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   ThreatSignalArticleBulkEditResponse                   `json:"result" api:"required"`
	Success  ThreatSignalArticleBulkEditResponseEnvelopeSuccess    `json:"success" api:"required"`
	JSON     threatSignalArticleBulkEditResponseEnvelopeJSON       `json:"-"`
}

func (*ThreatSignalArticleBulkEditResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalArticleBulkEditResponseEnvelopeErrors 

type ThreatSignalArticleBulkEditResponseEnvelopeErrors struct {
	Message string                                                `json:"message" api:"required"`
	JSON    threatSignalArticleBulkEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalArticleBulkEditResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalArticleBulkEditResponseEnvelopeMessages 

type ThreatSignalArticleBulkEditResponseEnvelopeMessages struct {
	Message string  `json:"message" api:"required"`
	Code    float64 `json:"code"`
	// The current count of custom feeds for the account.
	CustomFeedCount int64 `json:"custom_feed_count"`
	// The custom feed limit for the account.
	CustomFeedLimit int64                                                     `json:"custom_feed_limit"`
	Expected        string                                                    `json:"expected"`
	Path            []string                                                  `json:"path"`
	Reason          ThreatSignalArticleBulkEditResponseEnvelopeMessagesReason `json:"reason"`
	JSON            threatSignalArticleBulkEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ThreatSignalArticleBulkEditResponseEnvelopeMessages) UnmarshalJSON 

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

type ThreatSignalArticleBulkEditResponseEnvelopeMessagesReason 

type ThreatSignalArticleBulkEditResponseEnvelopeMessagesReason string
const (
	ThreatSignalArticleBulkEditResponseEnvelopeMessagesReasonThreatSignalsFeedLimit           ThreatSignalArticleBulkEditResponseEnvelopeMessagesReason = "threat_signals_feed_limit"
	ThreatSignalArticleBulkEditResponseEnvelopeMessagesReasonFreeCustomSkillsDisabled         ThreatSignalArticleBulkEditResponseEnvelopeMessagesReason = "free_custom_skills_disabled"
	ThreatSignalArticleBulkEditResponseEnvelopeMessagesReasonFreeSkillRunDisabled             ThreatSignalArticleBulkEditResponseEnvelopeMessagesReason = "free_skill_run_disabled"
	ThreatSignalArticleBulkEditResponseEnvelopeMessagesReasonFreeTierReconciliationInProgress ThreatSignalArticleBulkEditResponseEnvelopeMessagesReason = "free_tier_reconciliation_in_progress"
	ThreatSignalArticleBulkEditResponseEnvelopeMessagesReasonFreeTierReconciliationFailed     ThreatSignalArticleBulkEditResponseEnvelopeMessagesReason = "free_tier_reconciliation_failed"
	ThreatSignalArticleBulkEditResponseEnvelopeMessagesReasonRawContentExpired                ThreatSignalArticleBulkEditResponseEnvelopeMessagesReason = "raw_content_expired"
	ThreatSignalArticleBulkEditResponseEnvelopeMessagesReasonCuratedVisibilityChanged         ThreatSignalArticleBulkEditResponseEnvelopeMessagesReason = "curated_visibility_changed"
)

func (ThreatSignalArticleBulkEditResponseEnvelopeMessagesReason) IsKnown 

func (r ThreatSignalArticleBulkEditResponseEnvelopeMessagesReason) IsKnown() bool

type ThreatSignalArticleBulkEditResponseEnvelopeSuccess 

type ThreatSignalArticleBulkEditResponseEnvelopeSuccess bool
const (
	ThreatSignalArticleBulkEditResponseEnvelopeSuccessTrue ThreatSignalArticleBulkEditResponseEnvelopeSuccess = true
)

func (ThreatSignalArticleBulkEditResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalArticleBulkEditResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalArticleContentGetParams 

type ThreatSignalArticleContentGetParams struct {
	AccountID param.Field[string]                                    `path:"account_id" api:"required"`
	Format    param.Field[ThreatSignalArticleContentGetParamsFormat] `query:"format"`
}

func (ThreatSignalArticleContentGetParams) URLQuery 

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

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

type ThreatSignalArticleContentGetParamsFormat 

type ThreatSignalArticleContentGetParamsFormat string
const (
	ThreatSignalArticleContentGetParamsFormatText ThreatSignalArticleContentGetParamsFormat = "text"
	ThreatSignalArticleContentGetParamsFormatHTML ThreatSignalArticleContentGetParamsFormat = "html"
)

func (ThreatSignalArticleContentGetParamsFormat) IsKnown 

func (r ThreatSignalArticleContentGetParamsFormat) IsKnown() bool

type ThreatSignalArticleContentService 

type ThreatSignalArticleContentService struct {
	Options []option.RequestOption
}

ThreatSignalArticleContentService 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 NewThreatSignalArticleContentService method instead.

func NewThreatSignalArticleContentService 

func NewThreatSignalArticleContentService(opts ...option.RequestOption) (r *ThreatSignalArticleContentService)

NewThreatSignalArticleContentService 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 (*ThreatSignalArticleContentService) Get 

func (r *ThreatSignalArticleContentService) Get(ctx context.Context, articleID string, params ThreatSignalArticleContentGetParams, opts ...option.RequestOption) (res *string, err error)

Retrieves the stored body of a Threat Signals article as plain text or HTML.

type ThreatSignalArticleEditParams 

type ThreatSignalArticleEditParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Read      param.Field[bool]   `json:"read" api:"required"`
}

func (ThreatSignalArticleEditParams) MarshalJSON 

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

type ThreatSignalArticleEditResponse 

type ThreatSignalArticleEditResponse struct {
	ID              string                                      `json:"id" api:"required" format:"uuid"`
	BulletPoints    ThreatSignalArticleEditResponseBulletPoints `json:"bullet_points" api:"required,nullable"`
	ContentR2Key    string                                      `json:"content_r2_key" api:"required,nullable"`
	FeedDisplayName string                                      `json:"feed_display_name" api:"required,nullable"`
	FeedID          string                                      `json:"feed_id" api:"required" format:"uuid"`
	FetchedAt       string                                      `json:"fetched_at" api:"required"`
	// Progress of the article's indicator extraction and IOC contextualization run.
	// complete and failed are terminal; unknown means no run has been recorded.
	IndicatorExtractionStatus ThreatSignalArticleEditResponseIndicatorExtractionStatus `json:"indicator_extraction_status" api:"required"`
	Link                      string                                                   `json:"link" api:"required,nullable"`
	Metadata                  map[string]interface{}                                   `json:"metadata" api:"required,nullable"`
	PublishedAt               string                                                   `json:"published_at" api:"required,nullable"`
	Read                      bool                                                     `json:"read" api:"required"`
	ReadAt                    string                                                   `json:"read_at" api:"required,nullable"`
	SourceCount               float64                                                  `json:"source_count" api:"required"`
	// Persisted enrichment summary. Null until enrichment produces a summary.
	Summary         string                               `json:"summary" api:"required,nullable"`
	SummaryR2Key    string                               `json:"summary_r2_key" api:"required,nullable"`
	Tags            []ThreatSignalArticleEditResponseTag `json:"tags" api:"required"`
	Title           string                               `json:"title" api:"required,nullable"`
	SkillVersion    string                               `json:"skill_version" api:"nullable"`
	TagSkillVersion string                               `json:"tag_skill_version" api:"nullable"`
	JSON            threatSignalArticleEditResponseJSON  `json:"-"`
}

func (*ThreatSignalArticleEditResponse) UnmarshalJSON 

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

type ThreatSignalArticleEditResponseBulletPoints 

type ThreatSignalArticleEditResponseBulletPoints struct {
	Impact       string                                          `json:"impact" api:"required"`
	WhatHappened string                                          `json:"what_happened" api:"required"`
	WhoAffected  string                                          `json:"who_affected" api:"required"`
	JSON         threatSignalArticleEditResponseBulletPointsJSON `json:"-"`
}

func (*ThreatSignalArticleEditResponseBulletPoints) UnmarshalJSON 

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

type ThreatSignalArticleEditResponseEnvelope 

type ThreatSignalArticleEditResponseEnvelope struct {
	Errors  []ThreatSignalArticleEditResponseEnvelopeErrors `json:"errors" api:"required"`
	Result  ThreatSignalArticleEditResponse                 `json:"result" api:"required"`
	Success ThreatSignalArticleEditResponseEnvelopeSuccess  `json:"success" api:"required"`
	JSON    threatSignalArticleEditResponseEnvelopeJSON     `json:"-"`
}

func (*ThreatSignalArticleEditResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalArticleEditResponseEnvelopeErrors 

type ThreatSignalArticleEditResponseEnvelopeErrors struct {
	Message string                                            `json:"message" api:"required"`
	JSON    threatSignalArticleEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalArticleEditResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalArticleEditResponseEnvelopeSuccess 

type ThreatSignalArticleEditResponseEnvelopeSuccess bool
const (
	ThreatSignalArticleEditResponseEnvelopeSuccessTrue ThreatSignalArticleEditResponseEnvelopeSuccess = true
)

func (ThreatSignalArticleEditResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalArticleEditResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalArticleEditResponseIndicatorExtractionStatus 

type ThreatSignalArticleEditResponseIndicatorExtractionStatus string

Progress of the article's indicator extraction and IOC contextualization run. complete and failed are terminal; unknown means no run has been recorded. 

const (
	ThreatSignalArticleEditResponseIndicatorExtractionStatusInProgress ThreatSignalArticleEditResponseIndicatorExtractionStatus = "in_progress"
	ThreatSignalArticleEditResponseIndicatorExtractionStatusComplete   ThreatSignalArticleEditResponseIndicatorExtractionStatus = "complete"
	ThreatSignalArticleEditResponseIndicatorExtractionStatusFailed     ThreatSignalArticleEditResponseIndicatorExtractionStatus = "failed"
	ThreatSignalArticleEditResponseIndicatorExtractionStatusUnknown    ThreatSignalArticleEditResponseIndicatorExtractionStatus = "unknown"
)

func (ThreatSignalArticleEditResponseIndicatorExtractionStatus) IsKnown 

func (r ThreatSignalArticleEditResponseIndicatorExtractionStatus) IsKnown() bool

type ThreatSignalArticleEditResponseTag 

type ThreatSignalArticleEditResponseTag struct {
	AppliedBy  ThreatSignalArticleEditResponseTagsAppliedBy `json:"applied_by" api:"required"`
	CategoryID string                                       `json:"categoryId" api:"required,nullable" format:"uuid"`
	UUID       string                                       `json:"uuid" api:"required" format:"uuid"`
	Value      string                                       `json:"value" api:"required"`
	JSON       threatSignalArticleEditResponseTagJSON       `json:"-"`
}

func (*ThreatSignalArticleEditResponseTag) UnmarshalJSON 

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

type ThreatSignalArticleEditResponseTagsAppliedBy 

type ThreatSignalArticleEditResponseTagsAppliedBy string
const (
	ThreatSignalArticleEditResponseTagsAppliedByAI      ThreatSignalArticleEditResponseTagsAppliedBy = "ai"
	ThreatSignalArticleEditResponseTagsAppliedByAnalyst ThreatSignalArticleEditResponseTagsAppliedBy = "analyst"
	ThreatSignalArticleEditResponseTagsAppliedBySystem  ThreatSignalArticleEditResponseTagsAppliedBy = "system"
)

func (ThreatSignalArticleEditResponseTagsAppliedBy) IsKnown 

func (r ThreatSignalArticleEditResponseTagsAppliedBy) IsKnown() bool

type ThreatSignalArticleGetParams 

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

type ThreatSignalArticleGetResponse 

type ThreatSignalArticleGetResponse struct {
	ID              string                                     `json:"id" api:"required" format:"uuid"`
	BulletPoints    ThreatSignalArticleGetResponseBulletPoints `json:"bullet_points" api:"required,nullable"`
	ContentR2Key    string                                     `json:"content_r2_key" api:"required,nullable"`
	FeedDisplayName string                                     `json:"feed_display_name" api:"required,nullable"`
	FeedID          string                                     `json:"feed_id" api:"required" format:"uuid"`
	FetchedAt       string                                     `json:"fetched_at" api:"required"`
	// Progress of the article's indicator extraction and IOC contextualization run.
	// complete and failed are terminal; unknown means no run has been recorded.
	IndicatorExtractionStatus ThreatSignalArticleGetResponseIndicatorExtractionStatus `json:"indicator_extraction_status" api:"required"`
	Link                      string                                                  `json:"link" api:"required,nullable"`
	Metadata                  map[string]interface{}                                  `json:"metadata" api:"required,nullable"`
	PublishedAt               string                                                  `json:"published_at" api:"required,nullable"`
	Read                      bool                                                    `json:"read" api:"required"`
	ReadAt                    string                                                  `json:"read_at" api:"required,nullable"`
	SourceCount               float64                                                 `json:"source_count" api:"required"`
	// Persisted enrichment summary. Null until enrichment produces a summary.
	Summary         string                              `json:"summary" api:"required,nullable"`
	SummaryR2Key    string                              `json:"summary_r2_key" api:"required,nullable"`
	Tags            []ThreatSignalArticleGetResponseTag `json:"tags" api:"required"`
	Title           string                              `json:"title" api:"required,nullable"`
	SkillVersion    string                              `json:"skill_version" api:"nullable"`
	TagSkillVersion string                              `json:"tag_skill_version" api:"nullable"`
	JSON            threatSignalArticleGetResponseJSON  `json:"-"`
}

func (*ThreatSignalArticleGetResponse) UnmarshalJSON 

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

type ThreatSignalArticleGetResponseBulletPoints 

type ThreatSignalArticleGetResponseBulletPoints struct {
	Impact       string                                         `json:"impact" api:"required"`
	WhatHappened string                                         `json:"what_happened" api:"required"`
	WhoAffected  string                                         `json:"who_affected" api:"required"`
	JSON         threatSignalArticleGetResponseBulletPointsJSON `json:"-"`
}

func (*ThreatSignalArticleGetResponseBulletPoints) UnmarshalJSON 

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

type ThreatSignalArticleGetResponseEnvelope 

type ThreatSignalArticleGetResponseEnvelope struct {
	Errors  []ThreatSignalArticleGetResponseEnvelopeErrors `json:"errors" api:"required"`
	Result  ThreatSignalArticleGetResponse                 `json:"result" api:"required"`
	Success ThreatSignalArticleGetResponseEnvelopeSuccess  `json:"success" api:"required"`
	JSON    threatSignalArticleGetResponseEnvelopeJSON     `json:"-"`
}

func (*ThreatSignalArticleGetResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalArticleGetResponseEnvelopeErrors 

type ThreatSignalArticleGetResponseEnvelopeErrors struct {
	Message string                                           `json:"message" api:"required"`
	JSON    threatSignalArticleGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalArticleGetResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalArticleGetResponseEnvelopeSuccess 

type ThreatSignalArticleGetResponseEnvelopeSuccess bool
const (
	ThreatSignalArticleGetResponseEnvelopeSuccessTrue ThreatSignalArticleGetResponseEnvelopeSuccess = true
)

func (ThreatSignalArticleGetResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalArticleGetResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalArticleGetResponseIndicatorExtractionStatus 

type ThreatSignalArticleGetResponseIndicatorExtractionStatus string

Progress of the article's indicator extraction and IOC contextualization run. complete and failed are terminal; unknown means no run has been recorded. 

const (
	ThreatSignalArticleGetResponseIndicatorExtractionStatusInProgress ThreatSignalArticleGetResponseIndicatorExtractionStatus = "in_progress"
	ThreatSignalArticleGetResponseIndicatorExtractionStatusComplete   ThreatSignalArticleGetResponseIndicatorExtractionStatus = "complete"
	ThreatSignalArticleGetResponseIndicatorExtractionStatusFailed     ThreatSignalArticleGetResponseIndicatorExtractionStatus = "failed"
	ThreatSignalArticleGetResponseIndicatorExtractionStatusUnknown    ThreatSignalArticleGetResponseIndicatorExtractionStatus = "unknown"
)

func (ThreatSignalArticleGetResponseIndicatorExtractionStatus) IsKnown 

func (r ThreatSignalArticleGetResponseIndicatorExtractionStatus) IsKnown() bool

type ThreatSignalArticleGetResponseTag 

type ThreatSignalArticleGetResponseTag struct {
	AppliedBy  ThreatSignalArticleGetResponseTagsAppliedBy `json:"applied_by" api:"required"`
	CategoryID string                                      `json:"categoryId" api:"required,nullable" format:"uuid"`
	UUID       string                                      `json:"uuid" api:"required" format:"uuid"`
	Value      string                                      `json:"value" api:"required"`
	JSON       threatSignalArticleGetResponseTagJSON       `json:"-"`
}

func (*ThreatSignalArticleGetResponseTag) UnmarshalJSON 

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

type ThreatSignalArticleGetResponseTagsAppliedBy 

type ThreatSignalArticleGetResponseTagsAppliedBy string
const (
	ThreatSignalArticleGetResponseTagsAppliedByAI      ThreatSignalArticleGetResponseTagsAppliedBy = "ai"
	ThreatSignalArticleGetResponseTagsAppliedByAnalyst ThreatSignalArticleGetResponseTagsAppliedBy = "analyst"
	ThreatSignalArticleGetResponseTagsAppliedBySystem  ThreatSignalArticleGetResponseTagsAppliedBy = "system"
)

func (ThreatSignalArticleGetResponseTagsAppliedBy) IsKnown 

func (r ThreatSignalArticleGetResponseTagsAppliedBy) IsKnown() bool

type ThreatSignalArticleListParams 

type ThreatSignalArticleListParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Repeatable article UUID filter. Returns the union of matching account-owned
	// articles; use this to list every Threat Signals article referenced by an
	// indicator's sources.
	ArticleID param.Field[[]string] `query:"article_id" format:"uuid"`
	// Opaque cursor from a previous response's `next_cursor`. When provided,
	// pagination, ordering, totals, and article filters come from the cursor. Sending
	// `per_page`, `sort`, `include_total`, or any article filter alongside it returns
	// a 400 `CursorFilterConflictError`.
	Cursor          param.Field[string]                                  `query:"cursor"`
	FeedCategory    param.Field[string]                                  `query:"feed_category"`
	FeedID          param.Field[string]                                  `query:"feed_id" format:"uuid"`
	FetchedAfter    param.Field[time.Time]                               `query:"fetched_after" format:"date-time"`
	FetchedBefore   param.Field[time.Time]                               `query:"fetched_before" format:"date-time"`
	IncludeTotal    param.Field[bool]                                    `query:"include_total"`
	PerPage         param.Field[int64]                                   `query:"per_page"`
	PublishedAfter  param.Field[time.Time]                               `query:"published_after" format:"date-time"`
	PublishedBefore param.Field[time.Time]                               `query:"published_before" format:"date-time"`
	Read            param.Field[bool]                                    `query:"read"`
	Search          param.Field[string]                                  `query:"search"`
	Sort            param.Field[string]                                  `query:"sort"`
	SourceType      param.Field[ThreatSignalArticleListParamsSourceType] `query:"source_type"`
	// Legacy human-readable tag-value filter. Ignored when tag_id is supplied; prefer
	// tag_id.
	Tag param.Field[string] `query:"tag"`
	// Assignment provenance filter. When combined with tag_id or tag_category_id, the
	// matching assignment must have this provenance.
	TagAppliedBy param.Field[ThreatSignalArticleListParamsTagAppliedBy] `query:"tag_applied_by"`
	// Legacy category-name disambiguator for tag. It has no effect without tag; prefer
	// tag_category_id.
	TagCategory param.Field[string] `query:"tag_category"`
	// Repeatable tag-category UUID filter. An article matches any selected category;
	// when tag_id is also present, the tag and category groups are ANDed.
	TagCategoryID param.Field[[]string] `query:"tag_category_id" format:"uuid"`
	// Repeatable tag UUID filter. An article matches any selected tag.
	TagID param.Field[[]string] `query:"tag_id" format:"uuid"`
}

func (ThreatSignalArticleListParams) URLQuery 

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

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

type ThreatSignalArticleListParamsSourceType 

type ThreatSignalArticleListParamsSourceType string
const (
	ThreatSignalArticleListParamsSourceTypeCurated ThreatSignalArticleListParamsSourceType = "curated"
	ThreatSignalArticleListParamsSourceTypeCustom  ThreatSignalArticleListParamsSourceType = "custom"
)

func (ThreatSignalArticleListParamsSourceType) IsKnown 

func (r ThreatSignalArticleListParamsSourceType) IsKnown() bool

type ThreatSignalArticleListParamsTagAppliedBy 

type ThreatSignalArticleListParamsTagAppliedBy string

Assignment provenance filter. When combined with tag_id or tag_category_id, the matching assignment must have this provenance. 

const (
	ThreatSignalArticleListParamsTagAppliedByAI      ThreatSignalArticleListParamsTagAppliedBy = "ai"
	ThreatSignalArticleListParamsTagAppliedByAnalyst ThreatSignalArticleListParamsTagAppliedBy = "analyst"
	ThreatSignalArticleListParamsTagAppliedBySystem  ThreatSignalArticleListParamsTagAppliedBy = "system"
)

func (ThreatSignalArticleListParamsTagAppliedBy) IsKnown 

func (r ThreatSignalArticleListParamsTagAppliedBy) IsKnown() bool

type ThreatSignalArticleListResponse 

type ThreatSignalArticleListResponse struct {
	Articles          []ThreatSignalArticleListResponseArticle `json:"articles" api:"required"`
	HasMore           bool                                     `json:"has_more" api:"required"`
	NextCursor        string                                   `json:"next_cursor" api:"required,nullable"`
	TotalCount        float64                                  `json:"total_count" api:"required,nullable"`
	TotalCountIsExact bool                                     `json:"total_count_is_exact" api:"required"`
	JSON              threatSignalArticleListResponseJSON      `json:"-"`
}

func (*ThreatSignalArticleListResponse) UnmarshalJSON 

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

type ThreatSignalArticleListResponseArticle 

type ThreatSignalArticleListResponseArticle struct {
	ID string `json:"id" api:"required" format:"uuid"`
	// Threat Events dataset identifier for the article redirect. Null when the account
	// feeds dataset mapping is unavailable.
	DatasetID string `json:"dataset_id" api:"required,nullable"`
	// Threat Events event identifier associated with this article for a UI redirect.
	// Null when no event has been linked.
	EventID         string `json:"event_id" api:"required,nullable"`
	FeedDisplayName string `json:"feed_display_name" api:"required,nullable"`
	FeedID          string `json:"feed_id" api:"required" format:"uuid"`
	FetchedAt       string `json:"fetched_at" api:"required"`
	Link            string `json:"link" api:"required,nullable"`
	PublishedAt     string `json:"published_at" api:"required,nullable"`
	Read            bool   `json:"read" api:"required"`
	ReadAt          string `json:"read_at" api:"required,nullable"`
	// Persisted enrichment summary. Null until enrichment produces a summary.
	Summary string                                       `json:"summary" api:"required,nullable"`
	Tags    []ThreatSignalArticleListResponseArticlesTag `json:"tags" api:"required"`
	Title   string                                       `json:"title" api:"required,nullable"`
	JSON    threatSignalArticleListResponseArticleJSON   `json:"-"`
}

func (*ThreatSignalArticleListResponseArticle) UnmarshalJSON 

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

type ThreatSignalArticleListResponseArticlesTag 

type ThreatSignalArticleListResponseArticlesTag struct {
	AppliedBy  ThreatSignalArticleListResponseArticlesTagsAppliedBy `json:"applied_by" api:"required"`
	CategoryID string                                               `json:"categoryId" api:"required,nullable" format:"uuid"`
	UUID       string                                               `json:"uuid" api:"required" format:"uuid"`
	Value      string                                               `json:"value" api:"required"`
	JSON       threatSignalArticleListResponseArticlesTagJSON       `json:"-"`
}

func (*ThreatSignalArticleListResponseArticlesTag) UnmarshalJSON 

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

type ThreatSignalArticleListResponseArticlesTagsAppliedBy 

type ThreatSignalArticleListResponseArticlesTagsAppliedBy string
const (
	ThreatSignalArticleListResponseArticlesTagsAppliedByAI      ThreatSignalArticleListResponseArticlesTagsAppliedBy = "ai"
	ThreatSignalArticleListResponseArticlesTagsAppliedByAnalyst ThreatSignalArticleListResponseArticlesTagsAppliedBy = "analyst"
	ThreatSignalArticleListResponseArticlesTagsAppliedBySystem  ThreatSignalArticleListResponseArticlesTagsAppliedBy = "system"
)

func (ThreatSignalArticleListResponseArticlesTagsAppliedBy) IsKnown 

func (r ThreatSignalArticleListResponseArticlesTagsAppliedBy) IsKnown() bool

type ThreatSignalArticleListResponseEnvelope 

type ThreatSignalArticleListResponseEnvelope struct {
	Errors  []ThreatSignalArticleListResponseEnvelopeErrors `json:"errors" api:"required"`
	Result  ThreatSignalArticleListResponse                 `json:"result" api:"required"`
	Success ThreatSignalArticleListResponseEnvelopeSuccess  `json:"success" api:"required"`
	JSON    threatSignalArticleListResponseEnvelopeJSON     `json:"-"`
}

func (*ThreatSignalArticleListResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalArticleListResponseEnvelopeErrors 

type ThreatSignalArticleListResponseEnvelopeErrors struct {
	Message string                                            `json:"message" api:"required"`
	JSON    threatSignalArticleListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalArticleListResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalArticleListResponseEnvelopeSuccess 

type ThreatSignalArticleListResponseEnvelopeSuccess bool
const (
	ThreatSignalArticleListResponseEnvelopeSuccessTrue ThreatSignalArticleListResponseEnvelopeSuccess = true
)

func (ThreatSignalArticleListResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalArticleListResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalArticleService 

type ThreatSignalArticleService struct {
	Options      []option.RequestOption
	Content      *ThreatSignalArticleContentService
	Tags         *ThreatSignalArticleTagService
	SkillOutputs *ThreatSignalArticleSkillOutputService
}

ThreatSignalArticleService 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 NewThreatSignalArticleService method instead.

func NewThreatSignalArticleService 

func NewThreatSignalArticleService(opts ...option.RequestOption) (r *ThreatSignalArticleService)

NewThreatSignalArticleService 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 (*ThreatSignalArticleService) BulkEdit 

func (r *ThreatSignalArticleService) BulkEdit(ctx context.Context, params ThreatSignalArticleBulkEditParams, opts ...option.RequestOption) (res *ThreatSignalArticleBulkEditResponse, err error)

Marks up to 50 Threat Signals articles as read or unread.

func (*ThreatSignalArticleService) Edit 

func (r *ThreatSignalArticleService) Edit(ctx context.Context, articleID string, params ThreatSignalArticleEditParams, opts ...option.RequestOption) (res *ThreatSignalArticleEditResponse, err error)

Marks a Threat Signals article as read or unread.

func (*ThreatSignalArticleService) Get 

func (r *ThreatSignalArticleService) Get(ctx context.Context, articleID string, query ThreatSignalArticleGetParams, opts ...option.RequestOption) (res *ThreatSignalArticleGetResponse, err error)

Retrieves a Threat Signals article with its summary, tags and indicator status.

func (*ThreatSignalArticleService) List 

func (r *ThreatSignalArticleService) List(ctx context.Context, params ThreatSignalArticleListParams, opts ...option.RequestOption) (res *ThreatSignalArticleListResponse, err error)

Lists articles from the account's Threat Signals feeds.

type ThreatSignalArticleSkillOutputGetParams 

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

type ThreatSignalArticleSkillOutputGetResponse 

type ThreatSignalArticleSkillOutputGetResponse struct {
	ArticleID          string `json:"article_id" api:"required" format:"uuid"`
	CustomSkillVersion string `json:"custom_skill_version" api:"required,nullable"`
	// JSON-encoded output schema of the skill. Null when the skill no longer exists.
	OutputSchema string `json:"output_schema" api:"required,nullable"`
	SkillID      string `json:"skill_id" api:"required"`
	// Skill output. Parsed JSON when the stored output is valid JSON, otherwise the
	// raw string.
	CustomOutput interface{}                                   `json:"custom_output"`
	JSON         threatSignalArticleSkillOutputGetResponseJSON `json:"-"`
}

func (*ThreatSignalArticleSkillOutputGetResponse) UnmarshalJSON 

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

type ThreatSignalArticleSkillOutputGetResponseEnvelope 

type ThreatSignalArticleSkillOutputGetResponseEnvelope struct {
	Errors   []ThreatSignalArticleSkillOutputGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ThreatSignalArticleSkillOutputGetResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   ThreatSignalArticleSkillOutputGetResponse                   `json:"result" api:"required"`
	Success  ThreatSignalArticleSkillOutputGetResponseEnvelopeSuccess    `json:"success" api:"required"`
	JSON     threatSignalArticleSkillOutputGetResponseEnvelopeJSON       `json:"-"`
}

func (*ThreatSignalArticleSkillOutputGetResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalArticleSkillOutputGetResponseEnvelopeErrors 

type ThreatSignalArticleSkillOutputGetResponseEnvelopeErrors struct {
	Message string                                                      `json:"message" api:"required"`
	JSON    threatSignalArticleSkillOutputGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalArticleSkillOutputGetResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalArticleSkillOutputGetResponseEnvelopeMessages 

type ThreatSignalArticleSkillOutputGetResponseEnvelopeMessages struct {
	Message string  `json:"message" api:"required"`
	Code    float64 `json:"code"`
	// The current count of custom feeds for the account.
	CustomFeedCount int64 `json:"custom_feed_count"`
	// The custom feed limit for the account.
	CustomFeedLimit int64                                                           `json:"custom_feed_limit"`
	Expected        string                                                          `json:"expected"`
	Path            []string                                                        `json:"path"`
	Reason          ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReason `json:"reason"`
	JSON            threatSignalArticleSkillOutputGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ThreatSignalArticleSkillOutputGetResponseEnvelopeMessages) UnmarshalJSON 

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

type ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReason 

type ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReason string
const (
	ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReasonThreatSignalsFeedLimit           ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReason = "threat_signals_feed_limit"
	ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReasonFreeCustomSkillsDisabled         ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReason = "free_custom_skills_disabled"
	ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReasonFreeSkillRunDisabled             ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReason = "free_skill_run_disabled"
	ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReasonFreeTierReconciliationInProgress ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReason = "free_tier_reconciliation_in_progress"
	ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReasonFreeTierReconciliationFailed     ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReason = "free_tier_reconciliation_failed"
	ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReasonRawContentExpired                ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReason = "raw_content_expired"
	ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReasonCuratedVisibilityChanged         ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReason = "curated_visibility_changed"
)

func (ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReason) IsKnown 

func (r ThreatSignalArticleSkillOutputGetResponseEnvelopeMessagesReason) IsKnown() bool

type ThreatSignalArticleSkillOutputGetResponseEnvelopeSuccess 

type ThreatSignalArticleSkillOutputGetResponseEnvelopeSuccess bool
const (
	ThreatSignalArticleSkillOutputGetResponseEnvelopeSuccessTrue ThreatSignalArticleSkillOutputGetResponseEnvelopeSuccess = true
)

func (ThreatSignalArticleSkillOutputGetResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalArticleSkillOutputGetResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalArticleSkillOutputService 

type ThreatSignalArticleSkillOutputService struct {
	Options []option.RequestOption
}

ThreatSignalArticleSkillOutputService 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 NewThreatSignalArticleSkillOutputService method instead.

func NewThreatSignalArticleSkillOutputService 

func NewThreatSignalArticleSkillOutputService(opts ...option.RequestOption) (r *ThreatSignalArticleSkillOutputService)

NewThreatSignalArticleSkillOutputService 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 (*ThreatSignalArticleSkillOutputService) Get 

func (r *ThreatSignalArticleSkillOutputService) Get(ctx context.Context, articleID string, skillID string, query ThreatSignalArticleSkillOutputGetParams, opts ...option.RequestOption) (res *ThreatSignalArticleSkillOutputGetResponse, err error)

Retrieves the stored output of a skill for a Threat Signals article.

type ThreatSignalArticleTagDeleteParams 

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

type ThreatSignalArticleTagDeleteResponse 

type ThreatSignalArticleTagDeleteResponse struct {
	AppliedBy  ThreatSignalArticleTagDeleteResponseAppliedBy `json:"applied_by" api:"required"`
	CategoryID string                                        `json:"categoryId" api:"required,nullable" format:"uuid"`
	UUID       string                                        `json:"uuid" api:"required" format:"uuid"`
	Value      string                                        `json:"value" api:"required"`
	JSON       threatSignalArticleTagDeleteResponseJSON      `json:"-"`
}

func (*ThreatSignalArticleTagDeleteResponse) UnmarshalJSON 

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

type ThreatSignalArticleTagDeleteResponseAppliedBy 

type ThreatSignalArticleTagDeleteResponseAppliedBy string
const (
	ThreatSignalArticleTagDeleteResponseAppliedByAI      ThreatSignalArticleTagDeleteResponseAppliedBy = "ai"
	ThreatSignalArticleTagDeleteResponseAppliedByAnalyst ThreatSignalArticleTagDeleteResponseAppliedBy = "analyst"
	ThreatSignalArticleTagDeleteResponseAppliedBySystem  ThreatSignalArticleTagDeleteResponseAppliedBy = "system"
)

func (ThreatSignalArticleTagDeleteResponseAppliedBy) IsKnown 

func (r ThreatSignalArticleTagDeleteResponseAppliedBy) IsKnown() bool

type ThreatSignalArticleTagDeleteResponseEnvelope 

type ThreatSignalArticleTagDeleteResponseEnvelope struct {
	Errors   []ThreatSignalArticleTagDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ThreatSignalArticleTagDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   ThreatSignalArticleTagDeleteResponse                   `json:"result" api:"required"`
	Success  ThreatSignalArticleTagDeleteResponseEnvelopeSuccess    `json:"success" api:"required"`
	JSON     threatSignalArticleTagDeleteResponseEnvelopeJSON       `json:"-"`
}

func (*ThreatSignalArticleTagDeleteResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalArticleTagDeleteResponseEnvelopeErrors 

type ThreatSignalArticleTagDeleteResponseEnvelopeErrors struct {
	Message string                                                 `json:"message" api:"required"`
	JSON    threatSignalArticleTagDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalArticleTagDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalArticleTagDeleteResponseEnvelopeMessages 

type ThreatSignalArticleTagDeleteResponseEnvelopeMessages struct {
	Message string  `json:"message" api:"required"`
	Code    float64 `json:"code"`
	// The current count of custom feeds for the account.
	CustomFeedCount int64 `json:"custom_feed_count"`
	// The custom feed limit for the account.
	CustomFeedLimit int64                                                      `json:"custom_feed_limit"`
	Expected        string                                                     `json:"expected"`
	Path            []string                                                   `json:"path"`
	Reason          ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReason `json:"reason"`
	JSON            threatSignalArticleTagDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ThreatSignalArticleTagDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReason 

type ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReason string
const (
	ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReasonThreatSignalsFeedLimit           ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReason = "threat_signals_feed_limit"
	ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReasonFreeCustomSkillsDisabled         ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReason = "free_custom_skills_disabled"
	ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReasonFreeSkillRunDisabled             ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReason = "free_skill_run_disabled"
	ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReasonFreeTierReconciliationInProgress ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReason = "free_tier_reconciliation_in_progress"
	ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReasonFreeTierReconciliationFailed     ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReason = "free_tier_reconciliation_failed"
	ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReasonRawContentExpired                ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReason = "raw_content_expired"
	ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReasonCuratedVisibilityChanged         ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReason = "curated_visibility_changed"
)

func (ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReason) IsKnown 

func (r ThreatSignalArticleTagDeleteResponseEnvelopeMessagesReason) IsKnown() bool

type ThreatSignalArticleTagDeleteResponseEnvelopeSuccess 

type ThreatSignalArticleTagDeleteResponseEnvelopeSuccess bool
const (
	ThreatSignalArticleTagDeleteResponseEnvelopeSuccessTrue ThreatSignalArticleTagDeleteResponseEnvelopeSuccess = true
)

func (ThreatSignalArticleTagDeleteResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalArticleTagDeleteResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalArticleTagGenerateParams 

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

type ThreatSignalArticleTagGenerateResponse 

type ThreatSignalArticleTagGenerateResponse struct {
	TagSkillVersion string `json:"tag_skill_version" api:"required"`
	// Final hydrated assignment set; may be empty when no applicable tags are
	// selected.
	Tags []ThreatSignalArticleTagGenerateResponseTag `json:"tags" api:"required"`
	JSON threatSignalArticleTagGenerateResponseJSON  `json:"-"`
}

func (*ThreatSignalArticleTagGenerateResponse) UnmarshalJSON 

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

type ThreatSignalArticleTagGenerateResponseEnvelope 

type ThreatSignalArticleTagGenerateResponseEnvelope struct {
	Errors   []ThreatSignalArticleTagGenerateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ThreatSignalArticleTagGenerateResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   ThreatSignalArticleTagGenerateResponse                   `json:"result" api:"required"`
	Success  ThreatSignalArticleTagGenerateResponseEnvelopeSuccess    `json:"success" api:"required"`
	JSON     threatSignalArticleTagGenerateResponseEnvelopeJSON       `json:"-"`
}

func (*ThreatSignalArticleTagGenerateResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalArticleTagGenerateResponseEnvelopeErrors 

type ThreatSignalArticleTagGenerateResponseEnvelopeErrors struct {
	Message string                                                   `json:"message" api:"required"`
	JSON    threatSignalArticleTagGenerateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalArticleTagGenerateResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalArticleTagGenerateResponseEnvelopeMessages 

type ThreatSignalArticleTagGenerateResponseEnvelopeMessages struct {
	Message string  `json:"message" api:"required"`
	Code    float64 `json:"code"`
	// The current count of custom feeds for the account.
	CustomFeedCount int64 `json:"custom_feed_count"`
	// The custom feed limit for the account.
	CustomFeedLimit int64                                                        `json:"custom_feed_limit"`
	Expected        string                                                       `json:"expected"`
	Path            []string                                                     `json:"path"`
	Reason          ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReason `json:"reason"`
	JSON            threatSignalArticleTagGenerateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ThreatSignalArticleTagGenerateResponseEnvelopeMessages) UnmarshalJSON 

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

type ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReason 

type ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReason string
const (
	ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReasonThreatSignalsFeedLimit           ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReason = "threat_signals_feed_limit"
	ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReasonFreeCustomSkillsDisabled         ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReason = "free_custom_skills_disabled"
	ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReasonFreeSkillRunDisabled             ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReason = "free_skill_run_disabled"
	ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReasonFreeTierReconciliationInProgress ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReason = "free_tier_reconciliation_in_progress"
	ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReasonFreeTierReconciliationFailed     ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReason = "free_tier_reconciliation_failed"
	ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReasonRawContentExpired                ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReason = "raw_content_expired"
	ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReasonCuratedVisibilityChanged         ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReason = "curated_visibility_changed"
)

func (ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReason) IsKnown 

func (r ThreatSignalArticleTagGenerateResponseEnvelopeMessagesReason) IsKnown() bool

type ThreatSignalArticleTagGenerateResponseEnvelopeSuccess 

type ThreatSignalArticleTagGenerateResponseEnvelopeSuccess bool
const (
	ThreatSignalArticleTagGenerateResponseEnvelopeSuccessTrue ThreatSignalArticleTagGenerateResponseEnvelopeSuccess = true
)

func (ThreatSignalArticleTagGenerateResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalArticleTagGenerateResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalArticleTagGenerateResponseTag 

type ThreatSignalArticleTagGenerateResponseTag struct {
	AppliedBy  ThreatSignalArticleTagGenerateResponseTagsAppliedBy `json:"applied_by" api:"required"`
	CategoryID string                                              `json:"categoryId" api:"required,nullable" format:"uuid"`
	UUID       string                                              `json:"uuid" api:"required" format:"uuid"`
	Value      string                                              `json:"value" api:"required"`
	JSON       threatSignalArticleTagGenerateResponseTagJSON       `json:"-"`
}

func (*ThreatSignalArticleTagGenerateResponseTag) UnmarshalJSON 

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

type ThreatSignalArticleTagGenerateResponseTagsAppliedBy 

type ThreatSignalArticleTagGenerateResponseTagsAppliedBy string
const (
	ThreatSignalArticleTagGenerateResponseTagsAppliedByAI      ThreatSignalArticleTagGenerateResponseTagsAppliedBy = "ai"
	ThreatSignalArticleTagGenerateResponseTagsAppliedByAnalyst ThreatSignalArticleTagGenerateResponseTagsAppliedBy = "analyst"
	ThreatSignalArticleTagGenerateResponseTagsAppliedBySystem  ThreatSignalArticleTagGenerateResponseTagsAppliedBy = "system"
)

func (ThreatSignalArticleTagGenerateResponseTagsAppliedBy) IsKnown 

func (r ThreatSignalArticleTagGenerateResponseTagsAppliedBy) IsKnown() bool

type ThreatSignalArticleTagNewParams 

type ThreatSignalArticleTagNewParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	TagID     param.Field[string] `json:"tag_id" api:"required" format:"uuid"`
}

func (ThreatSignalArticleTagNewParams) MarshalJSON 

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

type ThreatSignalArticleTagNewResponse 

type ThreatSignalArticleTagNewResponse struct {
	AppliedBy  ThreatSignalArticleTagNewResponseAppliedBy `json:"applied_by" api:"required"`
	CategoryID string                                     `json:"categoryId" api:"required,nullable" format:"uuid"`
	UUID       string                                     `json:"uuid" api:"required" format:"uuid"`
	Value      string                                     `json:"value" api:"required"`
	JSON       threatSignalArticleTagNewResponseJSON      `json:"-"`
}

func (*ThreatSignalArticleTagNewResponse) UnmarshalJSON 

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

type ThreatSignalArticleTagNewResponseAppliedBy 

type ThreatSignalArticleTagNewResponseAppliedBy string
const (
	ThreatSignalArticleTagNewResponseAppliedByAI      ThreatSignalArticleTagNewResponseAppliedBy = "ai"
	ThreatSignalArticleTagNewResponseAppliedByAnalyst ThreatSignalArticleTagNewResponseAppliedBy = "analyst"
	ThreatSignalArticleTagNewResponseAppliedBySystem  ThreatSignalArticleTagNewResponseAppliedBy = "system"
)

func (ThreatSignalArticleTagNewResponseAppliedBy) IsKnown 

func (r ThreatSignalArticleTagNewResponseAppliedBy) IsKnown() bool

type ThreatSignalArticleTagNewResponseEnvelope 

type ThreatSignalArticleTagNewResponseEnvelope struct {
	Errors   []ThreatSignalArticleTagNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ThreatSignalArticleTagNewResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   ThreatSignalArticleTagNewResponse                   `json:"result" api:"required"`
	Success  ThreatSignalArticleTagNewResponseEnvelopeSuccess    `json:"success" api:"required"`
	JSON     threatSignalArticleTagNewResponseEnvelopeJSON       `json:"-"`
}

func (*ThreatSignalArticleTagNewResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalArticleTagNewResponseEnvelopeErrors 

type ThreatSignalArticleTagNewResponseEnvelopeErrors struct {
	Message string                                              `json:"message" api:"required"`
	JSON    threatSignalArticleTagNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalArticleTagNewResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalArticleTagNewResponseEnvelopeMessages 

type ThreatSignalArticleTagNewResponseEnvelopeMessages struct {
	Message string  `json:"message" api:"required"`
	Code    float64 `json:"code"`
	// The current count of custom feeds for the account.
	CustomFeedCount int64 `json:"custom_feed_count"`
	// The custom feed limit for the account.
	CustomFeedLimit int64                                                   `json:"custom_feed_limit"`
	Expected        string                                                  `json:"expected"`
	Path            []string                                                `json:"path"`
	Reason          ThreatSignalArticleTagNewResponseEnvelopeMessagesReason `json:"reason"`
	JSON            threatSignalArticleTagNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ThreatSignalArticleTagNewResponseEnvelopeMessages) UnmarshalJSON 

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

type ThreatSignalArticleTagNewResponseEnvelopeMessagesReason 

type ThreatSignalArticleTagNewResponseEnvelopeMessagesReason string
const (
	ThreatSignalArticleTagNewResponseEnvelopeMessagesReasonThreatSignalsFeedLimit           ThreatSignalArticleTagNewResponseEnvelopeMessagesReason = "threat_signals_feed_limit"
	ThreatSignalArticleTagNewResponseEnvelopeMessagesReasonFreeCustomSkillsDisabled         ThreatSignalArticleTagNewResponseEnvelopeMessagesReason = "free_custom_skills_disabled"
	ThreatSignalArticleTagNewResponseEnvelopeMessagesReasonFreeSkillRunDisabled             ThreatSignalArticleTagNewResponseEnvelopeMessagesReason = "free_skill_run_disabled"
	ThreatSignalArticleTagNewResponseEnvelopeMessagesReasonFreeTierReconciliationInProgress ThreatSignalArticleTagNewResponseEnvelopeMessagesReason = "free_tier_reconciliation_in_progress"
	ThreatSignalArticleTagNewResponseEnvelopeMessagesReasonFreeTierReconciliationFailed     ThreatSignalArticleTagNewResponseEnvelopeMessagesReason = "free_tier_reconciliation_failed"
	ThreatSignalArticleTagNewResponseEnvelopeMessagesReasonRawContentExpired                ThreatSignalArticleTagNewResponseEnvelopeMessagesReason = "raw_content_expired"
	ThreatSignalArticleTagNewResponseEnvelopeMessagesReasonCuratedVisibilityChanged         ThreatSignalArticleTagNewResponseEnvelopeMessagesReason = "curated_visibility_changed"
)

func (ThreatSignalArticleTagNewResponseEnvelopeMessagesReason) IsKnown 

func (r ThreatSignalArticleTagNewResponseEnvelopeMessagesReason) IsKnown() bool

type ThreatSignalArticleTagNewResponseEnvelopeSuccess 

type ThreatSignalArticleTagNewResponseEnvelopeSuccess bool
const (
	ThreatSignalArticleTagNewResponseEnvelopeSuccessTrue ThreatSignalArticleTagNewResponseEnvelopeSuccess = true
)

func (ThreatSignalArticleTagNewResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalArticleTagNewResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalArticleTagService 

type ThreatSignalArticleTagService struct {
	Options []option.RequestOption
}

ThreatSignalArticleTagService 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 NewThreatSignalArticleTagService method instead.

func NewThreatSignalArticleTagService 

func NewThreatSignalArticleTagService(opts ...option.RequestOption) (r *ThreatSignalArticleTagService)

NewThreatSignalArticleTagService 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 (*ThreatSignalArticleTagService) Delete 

func (r *ThreatSignalArticleTagService) Delete(ctx context.Context, articleID string, tagID string, body ThreatSignalArticleTagDeleteParams, opts ...option.RequestOption) (res *ThreatSignalArticleTagDeleteResponse, err error)

Removes a tag from a Threat Signals article.

func (*ThreatSignalArticleTagService) Generate 

func (r *ThreatSignalArticleTagService) Generate(ctx context.Context, articleID string, body ThreatSignalArticleTagGenerateParams, opts ...option.RequestOption) (res *ThreatSignalArticleTagGenerateResponse, err error)

Runs the default AI tagging skill on an article and replaces its AI-applied tags.

func (*ThreatSignalArticleTagService) New 

func (r *ThreatSignalArticleTagService) New(ctx context.Context, articleID string, params ThreatSignalArticleTagNewParams, opts ...option.RequestOption) (res *ThreatSignalArticleTagNewResponse, err error)

Applies a tag from the account's tag catalog to a Threat Signals article.

type ThreatSignalCategoryListParams 

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

type ThreatSignalCategoryListResponse 

type ThreatSignalCategoryListResponse struct {
	Categories []ThreatSignalCategoryListResponseCategory `json:"categories" api:"required"`
	JSON       threatSignalCategoryListResponseJSON       `json:"-"`
}

func (*ThreatSignalCategoryListResponse) UnmarshalJSON 

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

type ThreatSignalCategoryListResponseCategory 

type ThreatSignalCategoryListResponseCategory struct {
	// Wire value accepted by the feed `category_id` field.
	ID string `json:"id" api:"required" format:"uuid"`
	// Plain-language description of the category.
	Description string `json:"description" api:"required"`
	// Human-readable display label.
	Name string                                       `json:"name" api:"required"`
	JSON threatSignalCategoryListResponseCategoryJSON `json:"-"`
}

func (*ThreatSignalCategoryListResponseCategory) UnmarshalJSON 

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

type ThreatSignalCategoryListResponseEnvelope 

type ThreatSignalCategoryListResponseEnvelope struct {
	Errors  []ThreatSignalCategoryListResponseEnvelopeErrors `json:"errors" api:"required"`
	Result  ThreatSignalCategoryListResponse                 `json:"result" api:"required"`
	Success ThreatSignalCategoryListResponseEnvelopeSuccess  `json:"success" api:"required"`
	JSON    threatSignalCategoryListResponseEnvelopeJSON     `json:"-"`
}

func (*ThreatSignalCategoryListResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalCategoryListResponseEnvelopeErrors 

type ThreatSignalCategoryListResponseEnvelopeErrors struct {
	Message string                                             `json:"message" api:"required"`
	JSON    threatSignalCategoryListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalCategoryListResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalCategoryListResponseEnvelopeSuccess 

type ThreatSignalCategoryListResponseEnvelopeSuccess bool
const (
	ThreatSignalCategoryListResponseEnvelopeSuccessTrue ThreatSignalCategoryListResponseEnvelopeSuccess = true
)

func (ThreatSignalCategoryListResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalCategoryListResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalCategoryService 

type ThreatSignalCategoryService struct {
	Options []option.RequestOption
}

ThreatSignalCategoryService 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 NewThreatSignalCategoryService method instead.

func NewThreatSignalCategoryService 

func NewThreatSignalCategoryService(opts ...option.RequestOption) (r *ThreatSignalCategoryService)

NewThreatSignalCategoryService 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 (*ThreatSignalCategoryService) List 

func (r *ThreatSignalCategoryService) List(ctx context.Context, query ThreatSignalCategoryListParams, opts ...option.RequestOption) (res *ThreatSignalCategoryListResponse, err error)

Lists the predefined categories that can be assigned to feeds.

type ThreatSignalFeedDeleteParams 

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

type ThreatSignalFeedDeleteResponse 

type ThreatSignalFeedDeleteResponse struct {
	ID string `json:"id" api:"required" format:"uuid"`
	// Feed category identifier. Null when unset.
	CategoryID string `json:"category_id" api:"required,nullable"`
	// Display name of the feed category. Null when unset or unresolvable.
	CategoryName string `json:"category_name" api:"required,nullable"`
	CreatedAt    string `json:"created_at" api:"required"`
	// Curated catalog feed this subscription was created from. Null for custom feeds.
	CuratedFeedID string `json:"curated_feed_id" api:"required,nullable"`
	DisplayName   string `json:"display_name" api:"required,nullable"`
	Enabled       bool   `json:"enabled" api:"required"`
	LastPolledAt  string `json:"last_polled_at" api:"required,nullable"`
	PollIntervalS int64  `json:"poll_interval_s" api:"required"`
	// `custom` for a feed added by URL, `curated` for a curated catalog feed.
	SourceType string `json:"source_type" api:"required"`
	// Polling health: `active`, or `error` after a failed poll.
	Status       string                             `json:"status" api:"required"`
	SubscribedAt string                             `json:"subscribed_at" api:"required,nullable"`
	Title        string                             `json:"title" api:"required,nullable"`
	UpdatedAt    string                             `json:"updated_at" api:"required"`
	URL          string                             `json:"url" api:"required"`
	JSON         threatSignalFeedDeleteResponseJSON `json:"-"`
}

func (*ThreatSignalFeedDeleteResponse) UnmarshalJSON 

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

type ThreatSignalFeedDeleteResponseEnvelope 

type ThreatSignalFeedDeleteResponseEnvelope struct {
	Errors   []ThreatSignalFeedDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ThreatSignalFeedDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   ThreatSignalFeedDeleteResponse                   `json:"result" api:"required"`
	Success  ThreatSignalFeedDeleteResponseEnvelopeSuccess    `json:"success" api:"required"`
	JSON     threatSignalFeedDeleteResponseEnvelopeJSON       `json:"-"`
}

func (*ThreatSignalFeedDeleteResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalFeedDeleteResponseEnvelopeErrors 

type ThreatSignalFeedDeleteResponseEnvelopeErrors struct {
	Message string                                           `json:"message" api:"required"`
	JSON    threatSignalFeedDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalFeedDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalFeedDeleteResponseEnvelopeMessages 

type ThreatSignalFeedDeleteResponseEnvelopeMessages struct {
	Message string  `json:"message" api:"required"`
	Code    float64 `json:"code"`
	// The current count of custom feeds for the account.
	CustomFeedCount int64 `json:"custom_feed_count"`
	// The custom feed limit for the account.
	CustomFeedLimit int64                                                `json:"custom_feed_limit"`
	Expected        string                                               `json:"expected"`
	Path            []string                                             `json:"path"`
	Reason          ThreatSignalFeedDeleteResponseEnvelopeMessagesReason `json:"reason"`
	JSON            threatSignalFeedDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ThreatSignalFeedDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type ThreatSignalFeedDeleteResponseEnvelopeMessagesReason 

type ThreatSignalFeedDeleteResponseEnvelopeMessagesReason string
const (
	ThreatSignalFeedDeleteResponseEnvelopeMessagesReasonThreatSignalsFeedLimit           ThreatSignalFeedDeleteResponseEnvelopeMessagesReason = "threat_signals_feed_limit"
	ThreatSignalFeedDeleteResponseEnvelopeMessagesReasonFreeCustomSkillsDisabled         ThreatSignalFeedDeleteResponseEnvelopeMessagesReason = "free_custom_skills_disabled"
	ThreatSignalFeedDeleteResponseEnvelopeMessagesReasonFreeSkillRunDisabled             ThreatSignalFeedDeleteResponseEnvelopeMessagesReason = "free_skill_run_disabled"
	ThreatSignalFeedDeleteResponseEnvelopeMessagesReasonFreeTierReconciliationInProgress ThreatSignalFeedDeleteResponseEnvelopeMessagesReason = "free_tier_reconciliation_in_progress"
	ThreatSignalFeedDeleteResponseEnvelopeMessagesReasonFreeTierReconciliationFailed     ThreatSignalFeedDeleteResponseEnvelopeMessagesReason = "free_tier_reconciliation_failed"
	ThreatSignalFeedDeleteResponseEnvelopeMessagesReasonRawContentExpired                ThreatSignalFeedDeleteResponseEnvelopeMessagesReason = "raw_content_expired"
	ThreatSignalFeedDeleteResponseEnvelopeMessagesReasonCuratedVisibilityChanged         ThreatSignalFeedDeleteResponseEnvelopeMessagesReason = "curated_visibility_changed"
)

func (ThreatSignalFeedDeleteResponseEnvelopeMessagesReason) IsKnown 

func (r ThreatSignalFeedDeleteResponseEnvelopeMessagesReason) IsKnown() bool

type ThreatSignalFeedDeleteResponseEnvelopeSuccess 

type ThreatSignalFeedDeleteResponseEnvelopeSuccess bool
const (
	ThreatSignalFeedDeleteResponseEnvelopeSuccessTrue ThreatSignalFeedDeleteResponseEnvelopeSuccess = true
)

func (ThreatSignalFeedDeleteResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalFeedDeleteResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalFeedEditParams 

type ThreatSignalFeedEditParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// One of the predefined Threat Signals feed categories; see GET
	// /:account_id/v2/threat-signals/categories.
	CategoryID    param.Field[ThreatSignalFeedEditParamsCategoryID] `json:"category_id"`
	DisplayName   param.Field[string]                               `json:"display_name"`
	Enabled       param.Field[bool]                                 `json:"enabled"`
	PollIntervalS param.Field[int64]                                `json:"poll_interval_s"`
	Title         param.Field[string]                               `json:"title"`
}

func (ThreatSignalFeedEditParams) MarshalJSON 

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

type ThreatSignalFeedEditParamsCategoryID 

type ThreatSignalFeedEditParamsCategoryID string

One of the predefined Threat Signals feed categories; see GET /:account_id/v2/threat-signals/categories. 

const (
	ThreatSignalFeedEditParamsCategoryIDB12a0fd6F7b9_5393_9ef3F888d506c550  ThreatSignalFeedEditParamsCategoryID = "b12a0fd6-f7b9-5393-9ef3-f888d506c550"
	ThreatSignalFeedEditParamsCategoryIDD5b70eaa626f5761B55b6d9590df49fb    ThreatSignalFeedEditParamsCategoryID = "d5b70eaa-626f-5761-b55b-6d9590df49fb"
	ThreatSignalFeedEditParamsCategoryID3b572d2b890d5286_9433F18c85079030   ThreatSignalFeedEditParamsCategoryID = "3b572d2b-890d-5286-9433-f18c85079030"
	ThreatSignalFeedEditParamsCategoryID17f90d3b37d3_5241_8ad4_7d6abbc2006c ThreatSignalFeedEditParamsCategoryID = "17f90d3b-37d3-5241-8ad4-7d6abbc2006c"
	ThreatSignalFeedEditParamsCategoryIDC68f28e9_7e8f5d4b853bF3076893a9ee   ThreatSignalFeedEditParamsCategoryID = "c68f28e9-7e8f-5d4b-853b-f3076893a9ee"
	ThreatSignalFeedEditParamsCategoryIDBb0e4a94_38ab5c14_80a7_28cee9f4b139 ThreatSignalFeedEditParamsCategoryID = "bb0e4a94-38ab-5c14-80a7-28cee9f4b139"
	ThreatSignalFeedEditParamsCategoryIDB1ef66d9A73c58dcB269_22d34dfd11f4   ThreatSignalFeedEditParamsCategoryID = "b1ef66d9-a73c-58dc-b269-22d34dfd11f4"
	ThreatSignalFeedEditParamsCategoryIDAb02a976_0a20_5c76A553_7f6325afacfe ThreatSignalFeedEditParamsCategoryID = "ab02a976-0a20-5c76-a553-7f6325afacfe"
)

func (ThreatSignalFeedEditParamsCategoryID) IsKnown 

func (r ThreatSignalFeedEditParamsCategoryID) IsKnown() bool

type ThreatSignalFeedEditResponse 

type ThreatSignalFeedEditResponse struct {
	ID string `json:"id" api:"required" format:"uuid"`
	// Feed category identifier. Null when unset.
	CategoryID string `json:"category_id" api:"required,nullable"`
	// Display name of the feed category. Null when unset or unresolvable.
	CategoryName string `json:"category_name" api:"required,nullable"`
	CreatedAt    string `json:"created_at" api:"required"`
	// Curated catalog feed this subscription was created from. Null for custom feeds.
	CuratedFeedID string `json:"curated_feed_id" api:"required,nullable"`
	DisplayName   string `json:"display_name" api:"required,nullable"`
	Enabled       bool   `json:"enabled" api:"required"`
	LastPolledAt  string `json:"last_polled_at" api:"required,nullable"`
	PollIntervalS int64  `json:"poll_interval_s" api:"required"`
	// `custom` for a feed added by URL, `curated` for a curated catalog feed.
	SourceType string `json:"source_type" api:"required"`
	// Polling health: `active`, or `error` after a failed poll.
	Status       string                           `json:"status" api:"required"`
	SubscribedAt string                           `json:"subscribed_at" api:"required,nullable"`
	Title        string                           `json:"title" api:"required,nullable"`
	UpdatedAt    string                           `json:"updated_at" api:"required"`
	URL          string                           `json:"url" api:"required"`
	JSON         threatSignalFeedEditResponseJSON `json:"-"`
}

func (*ThreatSignalFeedEditResponse) UnmarshalJSON 

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

type ThreatSignalFeedEditResponseEnvelope 

type ThreatSignalFeedEditResponseEnvelope struct {
	Errors   []ThreatSignalFeedEditResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ThreatSignalFeedEditResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   ThreatSignalFeedEditResponse                   `json:"result" api:"required"`
	Success  ThreatSignalFeedEditResponseEnvelopeSuccess    `json:"success" api:"required"`
	JSON     threatSignalFeedEditResponseEnvelopeJSON       `json:"-"`
}

func (*ThreatSignalFeedEditResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalFeedEditResponseEnvelopeErrors 

type ThreatSignalFeedEditResponseEnvelopeErrors struct {
	Message string                                         `json:"message" api:"required"`
	JSON    threatSignalFeedEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalFeedEditResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalFeedEditResponseEnvelopeMessages 

type ThreatSignalFeedEditResponseEnvelopeMessages struct {
	Message string  `json:"message" api:"required"`
	Code    float64 `json:"code"`
	// The current count of custom feeds for the account.
	CustomFeedCount int64 `json:"custom_feed_count"`
	// The custom feed limit for the account.
	CustomFeedLimit int64                                              `json:"custom_feed_limit"`
	Expected        string                                             `json:"expected"`
	Path            []string                                           `json:"path"`
	Reason          ThreatSignalFeedEditResponseEnvelopeMessagesReason `json:"reason"`
	JSON            threatSignalFeedEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ThreatSignalFeedEditResponseEnvelopeMessages) UnmarshalJSON 

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

type ThreatSignalFeedEditResponseEnvelopeMessagesReason 

type ThreatSignalFeedEditResponseEnvelopeMessagesReason string
const (
	ThreatSignalFeedEditResponseEnvelopeMessagesReasonThreatSignalsFeedLimit           ThreatSignalFeedEditResponseEnvelopeMessagesReason = "threat_signals_feed_limit"
	ThreatSignalFeedEditResponseEnvelopeMessagesReasonFreeCustomSkillsDisabled         ThreatSignalFeedEditResponseEnvelopeMessagesReason = "free_custom_skills_disabled"
	ThreatSignalFeedEditResponseEnvelopeMessagesReasonFreeSkillRunDisabled             ThreatSignalFeedEditResponseEnvelopeMessagesReason = "free_skill_run_disabled"
	ThreatSignalFeedEditResponseEnvelopeMessagesReasonFreeTierReconciliationInProgress ThreatSignalFeedEditResponseEnvelopeMessagesReason = "free_tier_reconciliation_in_progress"
	ThreatSignalFeedEditResponseEnvelopeMessagesReasonFreeTierReconciliationFailed     ThreatSignalFeedEditResponseEnvelopeMessagesReason = "free_tier_reconciliation_failed"
	ThreatSignalFeedEditResponseEnvelopeMessagesReasonRawContentExpired                ThreatSignalFeedEditResponseEnvelopeMessagesReason = "raw_content_expired"
	ThreatSignalFeedEditResponseEnvelopeMessagesReasonCuratedVisibilityChanged         ThreatSignalFeedEditResponseEnvelopeMessagesReason = "curated_visibility_changed"
)

func (ThreatSignalFeedEditResponseEnvelopeMessagesReason) IsKnown 

func (r ThreatSignalFeedEditResponseEnvelopeMessagesReason) IsKnown() bool

type ThreatSignalFeedEditResponseEnvelopeSuccess 

type ThreatSignalFeedEditResponseEnvelopeSuccess bool
const (
	ThreatSignalFeedEditResponseEnvelopeSuccessTrue ThreatSignalFeedEditResponseEnvelopeSuccess = true
)

func (ThreatSignalFeedEditResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalFeedEditResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalFeedListParams 

type ThreatSignalFeedListParams struct {
	AccountID  param.Field[string]                               `path:"account_id" api:"required"`
	Category   param.Field[string]                               `query:"category"`
	Enabled    param.Field[bool]                                 `query:"enabled"`
	Limit      param.Field[int64]                                `query:"limit"`
	Page       param.Field[int64]                                `query:"page"`
	PerPage    param.Field[int64]                                `query:"per_page"`
	Sort       param.Field[string]                               `query:"sort"`
	SourceType param.Field[ThreatSignalFeedListParamsSourceType] `query:"source_type"`
	Status     param.Field[string]                               `query:"status"`
}

func (ThreatSignalFeedListParams) URLQuery 

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

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

type ThreatSignalFeedListParamsSourceType 

type ThreatSignalFeedListParamsSourceType string
const (
	ThreatSignalFeedListParamsSourceTypeCurated ThreatSignalFeedListParamsSourceType = "curated"
	ThreatSignalFeedListParamsSourceTypeCustom  ThreatSignalFeedListParamsSourceType = "custom"
)

func (ThreatSignalFeedListParamsSourceType) IsKnown 

func (r ThreatSignalFeedListParamsSourceType) IsKnown() bool

type ThreatSignalFeedListResponse 

type ThreatSignalFeedListResponse struct {
	// Number of feeds on this page.
	Count int64 `json:"count" api:"required"`
	// The current count of custom feeds for the account.
	CustomFeedCount int64 `json:"custom_feed_count" api:"required"`
	// The resolved custom feed limit for the account.
	CustomFeedLimit int64                              `json:"custom_feed_limit" api:"required"`
	Feeds           []ThreatSignalFeedListResponseFeed `json:"feeds" api:"required"`
	Page            int64                              `json:"page" api:"required"`
	PerPage         int64                              `json:"per_page" api:"required"`
	TotalCount      int64                              `json:"total_count" api:"required"`
	JSON            threatSignalFeedListResponseJSON   `json:"-"`
}

func (*ThreatSignalFeedListResponse) UnmarshalJSON 

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

type ThreatSignalFeedListResponseFeed 

type ThreatSignalFeedListResponseFeed struct {
	ID string `json:"id" api:"required" format:"uuid"`
	// Feed category identifier. Null when unset.
	CategoryID string `json:"category_id" api:"required,nullable"`
	// Display name of the feed category. Null when unset or unresolvable.
	CategoryName string `json:"category_name" api:"required,nullable"`
	CreatedAt    string `json:"created_at" api:"required"`
	// Curated catalog feed this subscription was created from. Null for custom feeds.
	CuratedFeedID string `json:"curated_feed_id" api:"required,nullable"`
	DisplayName   string `json:"display_name" api:"required,nullable"`
	Enabled       bool   `json:"enabled" api:"required"`
	LastPolledAt  string `json:"last_polled_at" api:"required,nullable"`
	PollIntervalS int64  `json:"poll_interval_s" api:"required"`
	// `custom` for a feed added by URL, `curated` for a curated catalog feed.
	SourceType string `json:"source_type" api:"required"`
	// Polling health: `active`, or `error` after a failed poll.
	Status       string                               `json:"status" api:"required"`
	SubscribedAt string                               `json:"subscribed_at" api:"required,nullable"`
	Title        string                               `json:"title" api:"required,nullable"`
	UpdatedAt    string                               `json:"updated_at" api:"required"`
	URL          string                               `json:"url" api:"required"`
	JSON         threatSignalFeedListResponseFeedJSON `json:"-"`
}

func (*ThreatSignalFeedListResponseFeed) UnmarshalJSON 

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

type ThreatSignalFeedNewParams 

type ThreatSignalFeedNewParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// One of the predefined Threat Signals feed categories; see GET
	// /:account_id/v2/threat-signals/categories.
	CategoryID    param.Field[ThreatSignalFeedNewParamsCategoryID] `json:"category_id"`
	CuratedFeedID param.Field[string]                              `json:"curated_feed_id" format:"uuid"`
	DisplayName   param.Field[string]                              `json:"display_name"`
	Enabled       param.Field[bool]                                `json:"enabled"`
	PollIntervalS param.Field[int64]                               `json:"poll_interval_s"`
	Title         param.Field[string]                              `json:"title"`
	URL           param.Field[string]                              `json:"url" format:"uri"`
}

func (ThreatSignalFeedNewParams) MarshalJSON 

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

type ThreatSignalFeedNewParamsCategoryID 

type ThreatSignalFeedNewParamsCategoryID string

One of the predefined Threat Signals feed categories; see GET /:account_id/v2/threat-signals/categories. 

const (
	ThreatSignalFeedNewParamsCategoryIDB12a0fd6F7b9_5393_9ef3F888d506c550  ThreatSignalFeedNewParamsCategoryID = "b12a0fd6-f7b9-5393-9ef3-f888d506c550"
	ThreatSignalFeedNewParamsCategoryIDD5b70eaa626f5761B55b6d9590df49fb    ThreatSignalFeedNewParamsCategoryID = "d5b70eaa-626f-5761-b55b-6d9590df49fb"
	ThreatSignalFeedNewParamsCategoryID3b572d2b890d5286_9433F18c85079030   ThreatSignalFeedNewParamsCategoryID = "3b572d2b-890d-5286-9433-f18c85079030"
	ThreatSignalFeedNewParamsCategoryID17f90d3b37d3_5241_8ad4_7d6abbc2006c ThreatSignalFeedNewParamsCategoryID = "17f90d3b-37d3-5241-8ad4-7d6abbc2006c"
	ThreatSignalFeedNewParamsCategoryIDC68f28e9_7e8f5d4b853bF3076893a9ee   ThreatSignalFeedNewParamsCategoryID = "c68f28e9-7e8f-5d4b-853b-f3076893a9ee"
	ThreatSignalFeedNewParamsCategoryIDBb0e4a94_38ab5c14_80a7_28cee9f4b139 ThreatSignalFeedNewParamsCategoryID = "bb0e4a94-38ab-5c14-80a7-28cee9f4b139"
	ThreatSignalFeedNewParamsCategoryIDB1ef66d9A73c58dcB269_22d34dfd11f4   ThreatSignalFeedNewParamsCategoryID = "b1ef66d9-a73c-58dc-b269-22d34dfd11f4"
	ThreatSignalFeedNewParamsCategoryIDAb02a976_0a20_5c76A553_7f6325afacfe ThreatSignalFeedNewParamsCategoryID = "ab02a976-0a20-5c76-a553-7f6325afacfe"
)

func (ThreatSignalFeedNewParamsCategoryID) IsKnown 

func (r ThreatSignalFeedNewParamsCategoryID) IsKnown() bool

type ThreatSignalFeedNewResponse 

type ThreatSignalFeedNewResponse struct {
	ID string `json:"id" api:"required" format:"uuid"`
	// Feed category identifier. Null when unset.
	CategoryID string `json:"category_id" api:"required,nullable"`
	// Display name of the feed category. Null when unset or unresolvable.
	CategoryName string `json:"category_name" api:"required,nullable"`
	CreatedAt    string `json:"created_at" api:"required"`
	// Curated catalog feed this subscription was created from. Null for custom feeds.
	CuratedFeedID string `json:"curated_feed_id" api:"required,nullable"`
	DisplayName   string `json:"display_name" api:"required,nullable"`
	Enabled       bool   `json:"enabled" api:"required"`
	LastPolledAt  string `json:"last_polled_at" api:"required,nullable"`
	PollIntervalS int64  `json:"poll_interval_s" api:"required"`
	// `custom` for a feed added by URL, `curated` for a curated catalog feed.
	SourceType string `json:"source_type" api:"required"`
	// Polling health: `active`, or `error` after a failed poll.
	Status       string                          `json:"status" api:"required"`
	SubscribedAt string                          `json:"subscribed_at" api:"required,nullable"`
	Title        string                          `json:"title" api:"required,nullable"`
	UpdatedAt    string                          `json:"updated_at" api:"required"`
	URL          string                          `json:"url" api:"required"`
	JSON         threatSignalFeedNewResponseJSON `json:"-"`
}

func (*ThreatSignalFeedNewResponse) UnmarshalJSON 

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

type ThreatSignalFeedNewResponseEnvelope 

type ThreatSignalFeedNewResponseEnvelope struct {
	Errors   []ThreatSignalFeedNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ThreatSignalFeedNewResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   ThreatSignalFeedNewResponse                   `json:"result" api:"required"`
	Success  ThreatSignalFeedNewResponseEnvelopeSuccess    `json:"success" api:"required"`
	JSON     threatSignalFeedNewResponseEnvelopeJSON       `json:"-"`
}

func (*ThreatSignalFeedNewResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalFeedNewResponseEnvelopeErrors 

type ThreatSignalFeedNewResponseEnvelopeErrors struct {
	Message string                                        `json:"message" api:"required"`
	JSON    threatSignalFeedNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalFeedNewResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalFeedNewResponseEnvelopeMessages 

type ThreatSignalFeedNewResponseEnvelopeMessages struct {
	Message string  `json:"message" api:"required"`
	Code    float64 `json:"code"`
	// The current count of custom feeds for the account.
	CustomFeedCount int64 `json:"custom_feed_count"`
	// The custom feed limit for the account.
	CustomFeedLimit int64                                             `json:"custom_feed_limit"`
	Expected        string                                            `json:"expected"`
	Path            []string                                          `json:"path"`
	Reason          ThreatSignalFeedNewResponseEnvelopeMessagesReason `json:"reason"`
	JSON            threatSignalFeedNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ThreatSignalFeedNewResponseEnvelopeMessages) UnmarshalJSON 

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

type ThreatSignalFeedNewResponseEnvelopeMessagesReason 

type ThreatSignalFeedNewResponseEnvelopeMessagesReason string
const (
	ThreatSignalFeedNewResponseEnvelopeMessagesReasonThreatSignalsFeedLimit           ThreatSignalFeedNewResponseEnvelopeMessagesReason = "threat_signals_feed_limit"
	ThreatSignalFeedNewResponseEnvelopeMessagesReasonFreeCustomSkillsDisabled         ThreatSignalFeedNewResponseEnvelopeMessagesReason = "free_custom_skills_disabled"
	ThreatSignalFeedNewResponseEnvelopeMessagesReasonFreeSkillRunDisabled             ThreatSignalFeedNewResponseEnvelopeMessagesReason = "free_skill_run_disabled"
	ThreatSignalFeedNewResponseEnvelopeMessagesReasonFreeTierReconciliationInProgress ThreatSignalFeedNewResponseEnvelopeMessagesReason = "free_tier_reconciliation_in_progress"
	ThreatSignalFeedNewResponseEnvelopeMessagesReasonFreeTierReconciliationFailed     ThreatSignalFeedNewResponseEnvelopeMessagesReason = "free_tier_reconciliation_failed"
	ThreatSignalFeedNewResponseEnvelopeMessagesReasonRawContentExpired                ThreatSignalFeedNewResponseEnvelopeMessagesReason = "raw_content_expired"
	ThreatSignalFeedNewResponseEnvelopeMessagesReasonCuratedVisibilityChanged         ThreatSignalFeedNewResponseEnvelopeMessagesReason = "curated_visibility_changed"
)

func (ThreatSignalFeedNewResponseEnvelopeMessagesReason) IsKnown 

func (r ThreatSignalFeedNewResponseEnvelopeMessagesReason) IsKnown() bool

type ThreatSignalFeedNewResponseEnvelopeSuccess 

type ThreatSignalFeedNewResponseEnvelopeSuccess bool
const (
	ThreatSignalFeedNewResponseEnvelopeSuccessTrue ThreatSignalFeedNewResponseEnvelopeSuccess = true
)

func (ThreatSignalFeedNewResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalFeedNewResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalFeedPollParams 

type ThreatSignalFeedPollParams struct {
	AccountID param.Field[string]                           `path:"account_id" api:"required"`
	FeedID    param.Field[ThreatSignalFeedPollParamsFeedID] `query:"feed_id"`
}

func (ThreatSignalFeedPollParams) URLQuery 

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

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

type ThreatSignalFeedPollParamsFeedID 

type ThreatSignalFeedPollParamsFeedID string
const (
	ThreatSignalFeedPollParamsFeedIDAll ThreatSignalFeedPollParamsFeedID = "all"
)

func (ThreatSignalFeedPollParamsFeedID) IsKnown 

func (r ThreatSignalFeedPollParamsFeedID) IsKnown() bool

type ThreatSignalFeedPollResponse 

type ThreatSignalFeedPollResponse struct {
	Errors    float64                            `json:"errors" api:"required"`
	Feeds     []ThreatSignalFeedPollResponseFeed `json:"feeds" api:"required"`
	Triggered float64                            `json:"triggered" api:"required"`
	JSON      threatSignalFeedPollResponseJSON   `json:"-"`
}

func (*ThreatSignalFeedPollResponse) UnmarshalJSON 

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

type ThreatSignalFeedPollResponseEnvelope 

type ThreatSignalFeedPollResponseEnvelope struct {
	Errors  []ThreatSignalFeedPollResponseEnvelopeErrors `json:"errors" api:"required"`
	Result  ThreatSignalFeedPollResponse                 `json:"result" api:"required"`
	Success ThreatSignalFeedPollResponseEnvelopeSuccess  `json:"success" api:"required"`
	JSON    threatSignalFeedPollResponseEnvelopeJSON     `json:"-"`
}

func (*ThreatSignalFeedPollResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalFeedPollResponseEnvelopeErrors 

type ThreatSignalFeedPollResponseEnvelopeErrors struct {
	Message string                                         `json:"message" api:"required"`
	JSON    threatSignalFeedPollResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalFeedPollResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalFeedPollResponseEnvelopeSuccess 

type ThreatSignalFeedPollResponseEnvelopeSuccess bool
const (
	ThreatSignalFeedPollResponseEnvelopeSuccessTrue ThreatSignalFeedPollResponseEnvelopeSuccess = true
)

func (ThreatSignalFeedPollResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalFeedPollResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalFeedPollResponseFeed 

type ThreatSignalFeedPollResponseFeed struct {
	FeedID      string                                  `json:"feed_id" api:"required" format:"uuid"`
	Status      ThreatSignalFeedPollResponseFeedsStatus `json:"status" api:"required"`
	WorkflowID  string                                  `json:"workflow_id" api:"required"`
	FeedEnabled bool                                    `json:"feed_enabled"`
	JSON        threatSignalFeedPollResponseFeedJSON    `json:"-"`
}

func (*ThreatSignalFeedPollResponseFeed) UnmarshalJSON 

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

type ThreatSignalFeedPollResponseFeedsStatus 

type ThreatSignalFeedPollResponseFeedsStatus string
const (
	ThreatSignalFeedPollResponseFeedsStatusWorkflowCreated ThreatSignalFeedPollResponseFeedsStatus = "workflow_created"
	ThreatSignalFeedPollResponseFeedsStatusError           ThreatSignalFeedPollResponseFeedsStatus = "error"
)

func (ThreatSignalFeedPollResponseFeedsStatus) IsKnown 

func (r ThreatSignalFeedPollResponseFeedsStatus) IsKnown() bool

type ThreatSignalFeedRawGetParams 

type ThreatSignalFeedRawGetParams struct {
	AccountID param.Field[string]                             `path:"account_id" api:"required"`
	Format    param.Field[ThreatSignalFeedRawGetParamsFormat] `query:"format"`
}

func (ThreatSignalFeedRawGetParams) URLQuery 

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

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

type ThreatSignalFeedRawGetParamsFormat 

type ThreatSignalFeedRawGetParamsFormat string
const (
	ThreatSignalFeedRawGetParamsFormatXml ThreatSignalFeedRawGetParamsFormat = "xml"
)

func (ThreatSignalFeedRawGetParamsFormat) IsKnown 

func (r ThreatSignalFeedRawGetParamsFormat) IsKnown() bool

type ThreatSignalFeedRawService 

type ThreatSignalFeedRawService struct {
	Options []option.RequestOption
}

ThreatSignalFeedRawService 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 NewThreatSignalFeedRawService method instead.

func NewThreatSignalFeedRawService 

func NewThreatSignalFeedRawService(opts ...option.RequestOption) (r *ThreatSignalFeedRawService)

NewThreatSignalFeedRawService 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 (*ThreatSignalFeedRawService) Get 

func (r *ThreatSignalFeedRawService) Get(ctx context.Context, feedID string, params ThreatSignalFeedRawGetParams, opts ...option.RequestOption) (res *string, err error)

Retrieves the feed document fetched by the most recent poll.

type ThreatSignalFeedService 

type ThreatSignalFeedService struct {
	Options []option.RequestOption
	Raw     *ThreatSignalFeedRawService
	Skills  *ThreatSignalFeedSkillService
}

ThreatSignalFeedService 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 NewThreatSignalFeedService method instead.

func NewThreatSignalFeedService 

func NewThreatSignalFeedService(opts ...option.RequestOption) (r *ThreatSignalFeedService)

NewThreatSignalFeedService 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 (*ThreatSignalFeedService) Delete 

func (r *ThreatSignalFeedService) Delete(ctx context.Context, feedID string, body ThreatSignalFeedDeleteParams, opts ...option.RequestOption) (res *ThreatSignalFeedDeleteResponse, err error)

Unsubscribes the account from a Threat Signals feed and deletes its articles.

func (*ThreatSignalFeedService) Edit 

func (r *ThreatSignalFeedService) Edit(ctx context.Context, feedID string, params ThreatSignalFeedEditParams, opts ...option.RequestOption) (res *ThreatSignalFeedEditResponse, err error)

Updates a Threat Signals feed subscription.

func (*ThreatSignalFeedService) List 

func (r *ThreatSignalFeedService) List(ctx context.Context, params ThreatSignalFeedListParams, opts ...option.RequestOption) (res *pagination.V4PagePagination[ThreatSignalFeedListResponse], err error)

Lists the account's Threat Signals feed subscriptions.

func (*ThreatSignalFeedService) ListAutoPaging 

func (r *ThreatSignalFeedService) ListAutoPaging(ctx context.Context, params ThreatSignalFeedListParams, opts ...option.RequestOption) *pagination.V4PagePaginationAutoPager[ThreatSignalFeedListResponse]

Lists the account's Threat Signals feed subscriptions.

func (*ThreatSignalFeedService) New 

func (r *ThreatSignalFeedService) New(ctx context.Context, params ThreatSignalFeedNewParams, opts ...option.RequestOption) (res *ThreatSignalFeedNewResponse, err error)

Subscribes the account to a custom or curated Threat Signals feed.

func (*ThreatSignalFeedService) Poll 

func (r *ThreatSignalFeedService) Poll(ctx context.Context, params ThreatSignalFeedPollParams, opts ...option.RequestOption) (res *ThreatSignalFeedPollResponse, err error)

Starts an immediate poll of one or all Threat Signals feeds.

type ThreatSignalFeedSkillGetParams 

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

type ThreatSignalFeedSkillGetResponse 

type ThreatSignalFeedSkillGetResponse struct {
	FeedID string                                  `json:"feed_id" api:"required" format:"uuid"`
	Skills []ThreatSignalFeedSkillGetResponseSkill `json:"skills" api:"required"`
	JSON   threatSignalFeedSkillGetResponseJSON    `json:"-"`
}

func (*ThreatSignalFeedSkillGetResponse) UnmarshalJSON 

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

type ThreatSignalFeedSkillGetResponseEnvelope 

type ThreatSignalFeedSkillGetResponseEnvelope struct {
	Errors   []ThreatSignalFeedSkillGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ThreatSignalFeedSkillGetResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   ThreatSignalFeedSkillGetResponse                   `json:"result" api:"required"`
	Success  ThreatSignalFeedSkillGetResponseEnvelopeSuccess    `json:"success" api:"required"`
	JSON     threatSignalFeedSkillGetResponseEnvelopeJSON       `json:"-"`
}

func (*ThreatSignalFeedSkillGetResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalFeedSkillGetResponseEnvelopeErrors 

type ThreatSignalFeedSkillGetResponseEnvelopeErrors struct {
	Message string                                             `json:"message" api:"required"`
	JSON    threatSignalFeedSkillGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalFeedSkillGetResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalFeedSkillGetResponseEnvelopeMessages 

type ThreatSignalFeedSkillGetResponseEnvelopeMessages struct {
	Message string  `json:"message" api:"required"`
	Code    float64 `json:"code"`
	// The current count of custom feeds for the account.
	CustomFeedCount int64 `json:"custom_feed_count"`
	// The custom feed limit for the account.
	CustomFeedLimit int64                                                  `json:"custom_feed_limit"`
	Expected        string                                                 `json:"expected"`
	Path            []string                                               `json:"path"`
	Reason          ThreatSignalFeedSkillGetResponseEnvelopeMessagesReason `json:"reason"`
	JSON            threatSignalFeedSkillGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ThreatSignalFeedSkillGetResponseEnvelopeMessages) UnmarshalJSON 

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

type ThreatSignalFeedSkillGetResponseEnvelopeMessagesReason 

type ThreatSignalFeedSkillGetResponseEnvelopeMessagesReason string
const (
	ThreatSignalFeedSkillGetResponseEnvelopeMessagesReasonThreatSignalsFeedLimit           ThreatSignalFeedSkillGetResponseEnvelopeMessagesReason = "threat_signals_feed_limit"
	ThreatSignalFeedSkillGetResponseEnvelopeMessagesReasonFreeCustomSkillsDisabled         ThreatSignalFeedSkillGetResponseEnvelopeMessagesReason = "free_custom_skills_disabled"
	ThreatSignalFeedSkillGetResponseEnvelopeMessagesReasonFreeSkillRunDisabled             ThreatSignalFeedSkillGetResponseEnvelopeMessagesReason = "free_skill_run_disabled"
	ThreatSignalFeedSkillGetResponseEnvelopeMessagesReasonFreeTierReconciliationInProgress ThreatSignalFeedSkillGetResponseEnvelopeMessagesReason = "free_tier_reconciliation_in_progress"
	ThreatSignalFeedSkillGetResponseEnvelopeMessagesReasonFreeTierReconciliationFailed     ThreatSignalFeedSkillGetResponseEnvelopeMessagesReason = "free_tier_reconciliation_failed"
	ThreatSignalFeedSkillGetResponseEnvelopeMessagesReasonRawContentExpired                ThreatSignalFeedSkillGetResponseEnvelopeMessagesReason = "raw_content_expired"
	ThreatSignalFeedSkillGetResponseEnvelopeMessagesReasonCuratedVisibilityChanged         ThreatSignalFeedSkillGetResponseEnvelopeMessagesReason = "curated_visibility_changed"
)

func (ThreatSignalFeedSkillGetResponseEnvelopeMessagesReason) IsKnown 

func (r ThreatSignalFeedSkillGetResponseEnvelopeMessagesReason) IsKnown() bool

type ThreatSignalFeedSkillGetResponseEnvelopeSuccess 

type ThreatSignalFeedSkillGetResponseEnvelopeSuccess bool
const (
	ThreatSignalFeedSkillGetResponseEnvelopeSuccessTrue ThreatSignalFeedSkillGetResponseEnvelopeSuccess = true
)

func (ThreatSignalFeedSkillGetResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalFeedSkillGetResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalFeedSkillGetResponseSkill 

type ThreatSignalFeedSkillGetResponseSkill struct {
	ID string `json:"id" api:"required"`
	// JSON-encoded skill configuration. Always null for default skills.
	Config    string `json:"config" api:"required,nullable"`
	CreatedAt string `json:"created_at" api:"required"`
	// 1 when active, 0 when inactive.
	IsActive int64  `json:"is_active" api:"required"`
	Name     string `json:"name" api:"required"`
	// JSON-encoded JSON Schema the skill output must satisfy.
	OutputSchema string `json:"output_schema" api:"required,nullable"`
	Prompt       string `json:"prompt" api:"required"`
	// `default` for Cloudforce One managed skills (read-only), `custom` for account
	// skills.
	Source    ThreatSignalFeedSkillGetResponseSkillsSource `json:"source" api:"required"`
	Type      string                                       `json:"type" api:"required"`
	UpdatedAt string                                       `json:"updated_at" api:"required"`
	JSON      threatSignalFeedSkillGetResponseSkillJSON    `json:"-"`
}

func (*ThreatSignalFeedSkillGetResponseSkill) UnmarshalJSON 

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

type ThreatSignalFeedSkillGetResponseSkillsSource 

type ThreatSignalFeedSkillGetResponseSkillsSource string

`default` for Cloudforce One managed skills (read-only), `custom` for account skills. 

const (
	ThreatSignalFeedSkillGetResponseSkillsSourceDefault ThreatSignalFeedSkillGetResponseSkillsSource = "default"
	ThreatSignalFeedSkillGetResponseSkillsSourceCustom  ThreatSignalFeedSkillGetResponseSkillsSource = "custom"
)

func (ThreatSignalFeedSkillGetResponseSkillsSource) IsKnown 

func (r ThreatSignalFeedSkillGetResponseSkillsSource) IsKnown() bool

type ThreatSignalFeedSkillService 

type ThreatSignalFeedSkillService struct {
	Options []option.RequestOption
}

ThreatSignalFeedSkillService 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 NewThreatSignalFeedSkillService method instead.

func NewThreatSignalFeedSkillService 

func NewThreatSignalFeedSkillService(opts ...option.RequestOption) (r *ThreatSignalFeedSkillService)

NewThreatSignalFeedSkillService 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 (*ThreatSignalFeedSkillService) Get 

func (r *ThreatSignalFeedSkillService) Get(ctx context.Context, feedID string, query ThreatSignalFeedSkillGetParams, opts ...option.RequestOption) (res *ThreatSignalFeedSkillGetResponse, err error)

Retrieves the effective skill pipeline for a Threat Signals feed.

func (*ThreatSignalFeedSkillService) Update 

func (r *ThreatSignalFeedSkillService) Update(ctx context.Context, feedID string, params ThreatSignalFeedSkillUpdateParams, opts ...option.RequestOption) (res *ThreatSignalFeedSkillUpdateResponse, err error)

Replaces the ordered custom skills assigned to a Threat Signals feed.

type ThreatSignalFeedSkillUpdateParams 

type ThreatSignalFeedSkillUpdateParams struct {
	AccountID param.Field[string]   `path:"account_id" api:"required"`
	SkillIDs  param.Field[[]string] `json:"skill_ids" api:"required" format:"uuid"`
}

func (ThreatSignalFeedSkillUpdateParams) MarshalJSON 

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

type ThreatSignalFeedSkillUpdateResponse 

type ThreatSignalFeedSkillUpdateResponse struct {
	FeedID string                                     `json:"feed_id" api:"required" format:"uuid"`
	Skills []ThreatSignalFeedSkillUpdateResponseSkill `json:"skills" api:"required"`
	JSON   threatSignalFeedSkillUpdateResponseJSON    `json:"-"`
}

func (*ThreatSignalFeedSkillUpdateResponse) UnmarshalJSON 

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

type ThreatSignalFeedSkillUpdateResponseEnvelope 

type ThreatSignalFeedSkillUpdateResponseEnvelope struct {
	Errors   []ThreatSignalFeedSkillUpdateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ThreatSignalFeedSkillUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   ThreatSignalFeedSkillUpdateResponse                   `json:"result" api:"required"`
	Success  ThreatSignalFeedSkillUpdateResponseEnvelopeSuccess    `json:"success" api:"required"`
	JSON     threatSignalFeedSkillUpdateResponseEnvelopeJSON       `json:"-"`
}

func (*ThreatSignalFeedSkillUpdateResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalFeedSkillUpdateResponseEnvelopeErrors 

type ThreatSignalFeedSkillUpdateResponseEnvelopeErrors struct {
	Message string                                                `json:"message" api:"required"`
	JSON    threatSignalFeedSkillUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalFeedSkillUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalFeedSkillUpdateResponseEnvelopeMessages 

type ThreatSignalFeedSkillUpdateResponseEnvelopeMessages struct {
	Message string  `json:"message" api:"required"`
	Code    float64 `json:"code"`
	// The current count of custom feeds for the account.
	CustomFeedCount int64 `json:"custom_feed_count"`
	// The custom feed limit for the account.
	CustomFeedLimit int64                                                     `json:"custom_feed_limit"`
	Expected        string                                                    `json:"expected"`
	Path            []string                                                  `json:"path"`
	Reason          ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReason `json:"reason"`
	JSON            threatSignalFeedSkillUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ThreatSignalFeedSkillUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReason 

type ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReason string
const (
	ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReasonThreatSignalsFeedLimit           ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReason = "threat_signals_feed_limit"
	ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReasonFreeCustomSkillsDisabled         ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReason = "free_custom_skills_disabled"
	ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReasonFreeSkillRunDisabled             ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReason = "free_skill_run_disabled"
	ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReasonFreeTierReconciliationInProgress ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReason = "free_tier_reconciliation_in_progress"
	ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReasonFreeTierReconciliationFailed     ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReason = "free_tier_reconciliation_failed"
	ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReasonRawContentExpired                ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReason = "raw_content_expired"
	ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReasonCuratedVisibilityChanged         ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReason = "curated_visibility_changed"
)

func (ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReason) IsKnown 

func (r ThreatSignalFeedSkillUpdateResponseEnvelopeMessagesReason) IsKnown() bool

type ThreatSignalFeedSkillUpdateResponseEnvelopeSuccess 

type ThreatSignalFeedSkillUpdateResponseEnvelopeSuccess bool
const (
	ThreatSignalFeedSkillUpdateResponseEnvelopeSuccessTrue ThreatSignalFeedSkillUpdateResponseEnvelopeSuccess = true
)

func (ThreatSignalFeedSkillUpdateResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalFeedSkillUpdateResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalFeedSkillUpdateResponseSkill 

type ThreatSignalFeedSkillUpdateResponseSkill struct {
	// Zero-based pipeline position.
	Position int64                                        `json:"position" api:"required"`
	SkillID  string                                       `json:"skill_id" api:"required"`
	JSON     threatSignalFeedSkillUpdateResponseSkillJSON `json:"-"`
}

func (*ThreatSignalFeedSkillUpdateResponseSkill) UnmarshalJSON 

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

type ThreatSignalIndicatorListParams 

type ThreatSignalIndicatorListParams struct {
	AccountID    param.Field[string] `path:"account_id" api:"required"`
	ArticleID    param.Field[string] `query:"article_id" format:"uuid"`
	Cursor       param.Field[string] `query:"cursor"`
	FeedID       param.Field[string] `query:"feed_id" format:"uuid"`
	IncludeTotal param.Field[bool]   `query:"include_total"`
	PerPage      param.Field[int64]  `query:"per_page"`
	// NFC-normalized and trimmed, case-insensitive literal substring search of
	// indicator values. Requires 3–500 Unicode code points; the upper code-point bound
	// is described here because OpenAPI string length cannot precisely express it
	// without imposing UTF-16 semantics.
	Search param.Field[string] `query:"search"`
	Sort   param.Field[string] `query:"sort"`
}

func (ThreatSignalIndicatorListParams) URLQuery 

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

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

type ThreatSignalIndicatorListResponse 

type ThreatSignalIndicatorListResponse struct {
	Indicators []ThreatSignalIndicatorListResponseIndicator `json:"indicators" api:"required"`
	Pagination ThreatSignalIndicatorListResponsePagination  `json:"pagination" api:"required"`
	JSON       threatSignalIndicatorListResponseJSON        `json:"-"`
}

func (*ThreatSignalIndicatorListResponse) UnmarshalJSON 

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

type ThreatSignalIndicatorListResponseEnvelope 

type ThreatSignalIndicatorListResponseEnvelope struct {
	Errors  []ThreatSignalIndicatorListResponseEnvelopeErrors `json:"errors" api:"required"`
	Result  ThreatSignalIndicatorListResponse                 `json:"result" api:"required"`
	Success ThreatSignalIndicatorListResponseEnvelopeSuccess  `json:"success" api:"required"`
	JSON    threatSignalIndicatorListResponseEnvelopeJSON     `json:"-"`
}

func (*ThreatSignalIndicatorListResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalIndicatorListResponseEnvelopeErrors 

type ThreatSignalIndicatorListResponseEnvelopeErrors struct {
	Message string                                              `json:"message" api:"required"`
	JSON    threatSignalIndicatorListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalIndicatorListResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalIndicatorListResponseEnvelopeSuccess 

type ThreatSignalIndicatorListResponseEnvelopeSuccess bool
const (
	ThreatSignalIndicatorListResponseEnvelopeSuccessTrue ThreatSignalIndicatorListResponseEnvelopeSuccess = true
)

func (ThreatSignalIndicatorListResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalIndicatorListResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalIndicatorListResponseIndicator 

type ThreatSignalIndicatorListResponseIndicator struct {
	ID           string `json:"id" api:"required" format:"uuid"`
	ArticleID    string `json:"article_id" api:"required" format:"uuid"`
	ArticleTitle string `json:"article_title" api:"required,nullable"`
	// Threat Events dataset identifier for navigating from this indicator. Null when
	// the account feeds dataset mapping is unavailable.
	DatasetID       string                                         `json:"dataset_id" api:"required,nullable"`
	FeedDisplayName string                                         `json:"feed_display_name" api:"required,nullable"`
	FeedID          string                                         `json:"feed_id" api:"required" format:"uuid"`
	Type            string                                         `json:"type" api:"required"`
	Value           string                                         `json:"value" api:"required"`
	JSON            threatSignalIndicatorListResponseIndicatorJSON `json:"-"`
}

func (*ThreatSignalIndicatorListResponseIndicator) UnmarshalJSON 

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

type ThreatSignalIndicatorListResponsePagination 

type ThreatSignalIndicatorListResponsePagination struct {
	Count   int64  `json:"count" api:"required"`
	Cursor  string `json:"cursor" api:"required,nullable"`
	HasMore bool   `json:"has_more" api:"required"`
	// Ordinal of this cursor page; not a total-results offset.
	Page              int64                                           `json:"page" api:"required"`
	PerPage           int64                                           `json:"per_page" api:"required"`
	TotalCount        int64                                           `json:"total_count" api:"required,nullable"`
	TotalCountIsExact bool                                            `json:"total_count_is_exact" api:"required"`
	JSON              threatSignalIndicatorListResponsePaginationJSON `json:"-"`
}

func (*ThreatSignalIndicatorListResponsePagination) UnmarshalJSON 

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

type ThreatSignalIndicatorService 

type ThreatSignalIndicatorService struct {
	Options []option.RequestOption
}

ThreatSignalIndicatorService 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 NewThreatSignalIndicatorService method instead.

func NewThreatSignalIndicatorService 

func NewThreatSignalIndicatorService(opts ...option.RequestOption) (r *ThreatSignalIndicatorService)

NewThreatSignalIndicatorService 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 (*ThreatSignalIndicatorService) List 

func (r *ThreatSignalIndicatorService) List(ctx context.Context, params ThreatSignalIndicatorListParams, opts ...option.RequestOption) (res *ThreatSignalIndicatorListResponse, err error)

Lists indicators of compromise extracted from the account's Threat Signals articles.

type ThreatSignalSearchSearchParams 

type ThreatSignalSearchSearchParams struct {
	AccountID  param.Field[string]                                   `path:"account_id" api:"required"`
	Query      param.Field[string]                                   `query:"query" api:"required"`
	FeedID     param.Field[string]                                   `query:"feed_id" format:"uuid"`
	MaxResults param.Field[ThreatSignalSearchSearchParamsMaxResults] `query:"max_results"`
}

func (ThreatSignalSearchSearchParams) URLQuery 

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

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

type ThreatSignalSearchSearchParamsMaxResults 

type ThreatSignalSearchSearchParamsMaxResults string
const (
	ThreatSignalSearchSearchParamsMaxResultsEmpty ThreatSignalSearchSearchParamsMaxResults = ""
)

func (ThreatSignalSearchSearchParamsMaxResults) IsKnown 

func (r ThreatSignalSearchSearchParamsMaxResults) IsKnown() bool

type ThreatSignalSearchSearchResponse 

type ThreatSignalSearchSearchResponse struct {
	// Number of unique article candidates returned in this response. Equal to
	// results.length.
	Count   int64                                    `json:"count" api:"required"`
	Results []ThreatSignalSearchSearchResponseResult `json:"results" api:"required"`
	JSON    threatSignalSearchSearchResponseJSON     `json:"-"`
}

func (*ThreatSignalSearchSearchResponse) UnmarshalJSON 

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

type ThreatSignalSearchSearchResponseEnvelope 

type ThreatSignalSearchSearchResponseEnvelope struct {
	Errors  []ThreatSignalSearchSearchResponseEnvelopeErrors `json:"errors" api:"required"`
	Result  ThreatSignalSearchSearchResponse                 `json:"result" api:"required"`
	Success ThreatSignalSearchSearchResponseEnvelopeSuccess  `json:"success" api:"required"`
	JSON    threatSignalSearchSearchResponseEnvelopeJSON     `json:"-"`
}

func (*ThreatSignalSearchSearchResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalSearchSearchResponseEnvelopeErrors 

type ThreatSignalSearchSearchResponseEnvelopeErrors struct {
	Message string                                             `json:"message" api:"required"`
	JSON    threatSignalSearchSearchResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalSearchSearchResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalSearchSearchResponseEnvelopeSuccess 

type ThreatSignalSearchSearchResponseEnvelopeSuccess bool
const (
	ThreatSignalSearchSearchResponseEnvelopeSuccessTrue ThreatSignalSearchSearchResponseEnvelopeSuccess = true
)

func (ThreatSignalSearchSearchResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalSearchSearchResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalSearchSearchResponseResult 

type ThreatSignalSearchSearchResponseResult struct {
	ArticleID string                                     `json:"article_id" api:"required" format:"uuid"`
	DatasetID string                                     `json:"dataset_id" api:"required,nullable" format:"uuid"`
	EventID   string                                     `json:"event_id" api:"required,nullable" format:"uuid"`
	FeedID    string                                     `json:"feed_id" api:"required" format:"uuid"`
	Score     float64                                    `json:"score" api:"required"`
	Text      string                                     `json:"text" api:"required"`
	JSON      threatSignalSearchSearchResponseResultJSON `json:"-"`
}

func (*ThreatSignalSearchSearchResponseResult) UnmarshalJSON 

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

type ThreatSignalSearchService 

type ThreatSignalSearchService struct {
	Options []option.RequestOption
}

ThreatSignalSearchService 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 NewThreatSignalSearchService method instead.

func NewThreatSignalSearchService 

func NewThreatSignalSearchService(opts ...option.RequestOption) (r *ThreatSignalSearchService)

NewThreatSignalSearchService 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 (*ThreatSignalSearchService) Search 

func (r *ThreatSignalSearchService) Search(ctx context.Context, params ThreatSignalSearchSearchParams, opts ...option.RequestOption) (res *ThreatSignalSearchSearchResponse, err error)

Searches the account's Threat Signals articles using keyword and semantic retrieval.

type ThreatSignalService 

type ThreatSignalService struct {
	Options    []option.RequestOption
	Search     *ThreatSignalSearchService
	Categories *ThreatSignalCategoryService
	Feeds      *ThreatSignalFeedService
	Articles   *ThreatSignalArticleService
	Indicators *ThreatSignalIndicatorService
	Skills     *ThreatSignalSkillService
}

Threat Signals API for managing threat intelligence feeds, articles, indicators, and AI skills in Cloudforce One.

## Prerequisites

  1. **API token** — requests must use an API token with Cloudforce One permissions; write operations (creating, editing, or deleting feeds, skills, and tags) require write access.
  2. **Plan limits** — access on the Free plan is limited; feed quotas and managed default skills apply.

ThreatSignalService 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 NewThreatSignalService method instead.

func NewThreatSignalService 

func NewThreatSignalService(opts ...option.RequestOption) (r *ThreatSignalService)

NewThreatSignalService 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 ThreatSignalSkillDeleteParams 

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

type ThreatSignalSkillDeleteResponse 

type ThreatSignalSkillDeleteResponse struct {
	ID string `json:"id" api:"required"`
	// JSON-encoded skill configuration. Always null for default skills.
	Config    string `json:"config" api:"required,nullable"`
	CreatedAt string `json:"created_at" api:"required"`
	// 1 when active, 0 when inactive.
	IsActive int64  `json:"is_active" api:"required"`
	Name     string `json:"name" api:"required"`
	// JSON-encoded JSON Schema the skill output must satisfy.
	OutputSchema string `json:"output_schema" api:"required,nullable"`
	Prompt       string `json:"prompt" api:"required"`
	// `default` for Cloudforce One managed skills (read-only), `custom` for account
	// skills.
	Source    ThreatSignalSkillDeleteResponseSource `json:"source" api:"required"`
	Type      string                                `json:"type" api:"required"`
	UpdatedAt string                                `json:"updated_at" api:"required"`
	JSON      threatSignalSkillDeleteResponseJSON   `json:"-"`
}

func (*ThreatSignalSkillDeleteResponse) UnmarshalJSON 

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

type ThreatSignalSkillDeleteResponseEnvelope 

type ThreatSignalSkillDeleteResponseEnvelope struct {
	Errors   []ThreatSignalSkillDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ThreatSignalSkillDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   ThreatSignalSkillDeleteResponse                   `json:"result" api:"required"`
	Success  ThreatSignalSkillDeleteResponseEnvelopeSuccess    `json:"success" api:"required"`
	JSON     threatSignalSkillDeleteResponseEnvelopeJSON       `json:"-"`
}

func (*ThreatSignalSkillDeleteResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalSkillDeleteResponseEnvelopeErrors 

type ThreatSignalSkillDeleteResponseEnvelopeErrors struct {
	Message string                                            `json:"message" api:"required"`
	JSON    threatSignalSkillDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalSkillDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalSkillDeleteResponseEnvelopeMessages 

type ThreatSignalSkillDeleteResponseEnvelopeMessages struct {
	Message string  `json:"message" api:"required"`
	Code    float64 `json:"code"`
	// The current count of custom feeds for the account.
	CustomFeedCount int64 `json:"custom_feed_count"`
	// The custom feed limit for the account.
	CustomFeedLimit int64                                                 `json:"custom_feed_limit"`
	Expected        string                                                `json:"expected"`
	Path            []string                                              `json:"path"`
	Reason          ThreatSignalSkillDeleteResponseEnvelopeMessagesReason `json:"reason"`
	JSON            threatSignalSkillDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ThreatSignalSkillDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type ThreatSignalSkillDeleteResponseEnvelopeMessagesReason 

type ThreatSignalSkillDeleteResponseEnvelopeMessagesReason string
const (
	ThreatSignalSkillDeleteResponseEnvelopeMessagesReasonThreatSignalsFeedLimit           ThreatSignalSkillDeleteResponseEnvelopeMessagesReason = "threat_signals_feed_limit"
	ThreatSignalSkillDeleteResponseEnvelopeMessagesReasonFreeCustomSkillsDisabled         ThreatSignalSkillDeleteResponseEnvelopeMessagesReason = "free_custom_skills_disabled"
	ThreatSignalSkillDeleteResponseEnvelopeMessagesReasonFreeSkillRunDisabled             ThreatSignalSkillDeleteResponseEnvelopeMessagesReason = "free_skill_run_disabled"
	ThreatSignalSkillDeleteResponseEnvelopeMessagesReasonFreeTierReconciliationInProgress ThreatSignalSkillDeleteResponseEnvelopeMessagesReason = "free_tier_reconciliation_in_progress"
	ThreatSignalSkillDeleteResponseEnvelopeMessagesReasonFreeTierReconciliationFailed     ThreatSignalSkillDeleteResponseEnvelopeMessagesReason = "free_tier_reconciliation_failed"
	ThreatSignalSkillDeleteResponseEnvelopeMessagesReasonRawContentExpired                ThreatSignalSkillDeleteResponseEnvelopeMessagesReason = "raw_content_expired"
	ThreatSignalSkillDeleteResponseEnvelopeMessagesReasonCuratedVisibilityChanged         ThreatSignalSkillDeleteResponseEnvelopeMessagesReason = "curated_visibility_changed"
)

func (ThreatSignalSkillDeleteResponseEnvelopeMessagesReason) IsKnown 

func (r ThreatSignalSkillDeleteResponseEnvelopeMessagesReason) IsKnown() bool

type ThreatSignalSkillDeleteResponseEnvelopeSuccess 

type ThreatSignalSkillDeleteResponseEnvelopeSuccess bool
const (
	ThreatSignalSkillDeleteResponseEnvelopeSuccessTrue ThreatSignalSkillDeleteResponseEnvelopeSuccess = true
)

func (ThreatSignalSkillDeleteResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalSkillDeleteResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalSkillDeleteResponseSource 

type ThreatSignalSkillDeleteResponseSource string

`default` for Cloudforce One managed skills (read-only), `custom` for account skills. 

const (
	ThreatSignalSkillDeleteResponseSourceDefault ThreatSignalSkillDeleteResponseSource = "default"
	ThreatSignalSkillDeleteResponseSourceCustom  ThreatSignalSkillDeleteResponseSource = "custom"
)

func (ThreatSignalSkillDeleteResponseSource) IsKnown 

func (r ThreatSignalSkillDeleteResponseSource) IsKnown() bool

type ThreatSignalSkillEditParams 

type ThreatSignalSkillEditParams struct {
	AccountID    param.Field[string] `path:"account_id" api:"required"`
	Config       param.Field[string] `json:"config"`
	IsActive     param.Field[bool]   `json:"is_active"`
	Name         param.Field[string] `json:"name"`
	OutputSchema param.Field[string] `json:"output_schema"`
	Prompt       param.Field[string] `json:"prompt"`
}

func (ThreatSignalSkillEditParams) MarshalJSON 

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

type ThreatSignalSkillEditResponse 

type ThreatSignalSkillEditResponse struct {
	ID string `json:"id" api:"required"`
	// JSON-encoded skill configuration. Always null for default skills.
	Config    string `json:"config" api:"required,nullable"`
	CreatedAt string `json:"created_at" api:"required"`
	// 1 when active, 0 when inactive.
	IsActive int64  `json:"is_active" api:"required"`
	Name     string `json:"name" api:"required"`
	// JSON-encoded JSON Schema the skill output must satisfy.
	OutputSchema string `json:"output_schema" api:"required,nullable"`
	Prompt       string `json:"prompt" api:"required"`
	// `default` for Cloudforce One managed skills (read-only), `custom` for account
	// skills.
	Source    ThreatSignalSkillEditResponseSource `json:"source" api:"required"`
	Type      string                              `json:"type" api:"required"`
	UpdatedAt string                              `json:"updated_at" api:"required"`
	JSON      threatSignalSkillEditResponseJSON   `json:"-"`
}

func (*ThreatSignalSkillEditResponse) UnmarshalJSON 

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

type ThreatSignalSkillEditResponseEnvelope 

type ThreatSignalSkillEditResponseEnvelope struct {
	Errors   []ThreatSignalSkillEditResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ThreatSignalSkillEditResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   ThreatSignalSkillEditResponse                   `json:"result" api:"required"`
	Success  ThreatSignalSkillEditResponseEnvelopeSuccess    `json:"success" api:"required"`
	JSON     threatSignalSkillEditResponseEnvelopeJSON       `json:"-"`
}

func (*ThreatSignalSkillEditResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalSkillEditResponseEnvelopeErrors 

type ThreatSignalSkillEditResponseEnvelopeErrors struct {
	Message string                                          `json:"message" api:"required"`
	JSON    threatSignalSkillEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalSkillEditResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalSkillEditResponseEnvelopeMessages 

type ThreatSignalSkillEditResponseEnvelopeMessages struct {
	Message string  `json:"message" api:"required"`
	Code    float64 `json:"code"`
	// The current count of custom feeds for the account.
	CustomFeedCount int64 `json:"custom_feed_count"`
	// The custom feed limit for the account.
	CustomFeedLimit int64                                               `json:"custom_feed_limit"`
	Expected        string                                              `json:"expected"`
	Path            []string                                            `json:"path"`
	Reason          ThreatSignalSkillEditResponseEnvelopeMessagesReason `json:"reason"`
	JSON            threatSignalSkillEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ThreatSignalSkillEditResponseEnvelopeMessages) UnmarshalJSON 

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

type ThreatSignalSkillEditResponseEnvelopeMessagesReason 

type ThreatSignalSkillEditResponseEnvelopeMessagesReason string
const (
	ThreatSignalSkillEditResponseEnvelopeMessagesReasonThreatSignalsFeedLimit           ThreatSignalSkillEditResponseEnvelopeMessagesReason = "threat_signals_feed_limit"
	ThreatSignalSkillEditResponseEnvelopeMessagesReasonFreeCustomSkillsDisabled         ThreatSignalSkillEditResponseEnvelopeMessagesReason = "free_custom_skills_disabled"
	ThreatSignalSkillEditResponseEnvelopeMessagesReasonFreeSkillRunDisabled             ThreatSignalSkillEditResponseEnvelopeMessagesReason = "free_skill_run_disabled"
	ThreatSignalSkillEditResponseEnvelopeMessagesReasonFreeTierReconciliationInProgress ThreatSignalSkillEditResponseEnvelopeMessagesReason = "free_tier_reconciliation_in_progress"
	ThreatSignalSkillEditResponseEnvelopeMessagesReasonFreeTierReconciliationFailed     ThreatSignalSkillEditResponseEnvelopeMessagesReason = "free_tier_reconciliation_failed"
	ThreatSignalSkillEditResponseEnvelopeMessagesReasonRawContentExpired                ThreatSignalSkillEditResponseEnvelopeMessagesReason = "raw_content_expired"
	ThreatSignalSkillEditResponseEnvelopeMessagesReasonCuratedVisibilityChanged         ThreatSignalSkillEditResponseEnvelopeMessagesReason = "curated_visibility_changed"
)

func (ThreatSignalSkillEditResponseEnvelopeMessagesReason) IsKnown 

func (r ThreatSignalSkillEditResponseEnvelopeMessagesReason) IsKnown() bool

type ThreatSignalSkillEditResponseEnvelopeSuccess 

type ThreatSignalSkillEditResponseEnvelopeSuccess bool
const (
	ThreatSignalSkillEditResponseEnvelopeSuccessTrue ThreatSignalSkillEditResponseEnvelopeSuccess = true
)

func (ThreatSignalSkillEditResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalSkillEditResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalSkillEditResponseSource 

type ThreatSignalSkillEditResponseSource string

`default` for Cloudforce One managed skills (read-only), `custom` for account skills. 

const (
	ThreatSignalSkillEditResponseSourceDefault ThreatSignalSkillEditResponseSource = "default"
	ThreatSignalSkillEditResponseSourceCustom  ThreatSignalSkillEditResponseSource = "custom"
)

func (ThreatSignalSkillEditResponseSource) IsKnown 

func (r ThreatSignalSkillEditResponseSource) IsKnown() bool

type ThreatSignalSkillGetParams 

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

type ThreatSignalSkillGetResponse 

type ThreatSignalSkillGetResponse struct {
	ID string `json:"id" api:"required"`
	// JSON-encoded skill configuration. Always null for default skills.
	Config    string `json:"config" api:"required,nullable"`
	CreatedAt string `json:"created_at" api:"required"`
	// 1 when active, 0 when inactive.
	IsActive int64  `json:"is_active" api:"required"`
	Name     string `json:"name" api:"required"`
	// JSON-encoded JSON Schema the skill output must satisfy.
	OutputSchema string `json:"output_schema" api:"required,nullable"`
	Prompt       string `json:"prompt" api:"required"`
	// `default` for Cloudforce One managed skills (read-only), `custom` for account
	// skills.
	Source    ThreatSignalSkillGetResponseSource `json:"source" api:"required"`
	Type      string                             `json:"type" api:"required"`
	UpdatedAt string                             `json:"updated_at" api:"required"`
	JSON      threatSignalSkillGetResponseJSON   `json:"-"`
}

func (*ThreatSignalSkillGetResponse) UnmarshalJSON 

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

type ThreatSignalSkillGetResponseEnvelope 

type ThreatSignalSkillGetResponseEnvelope struct {
	Errors   []ThreatSignalSkillGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ThreatSignalSkillGetResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   ThreatSignalSkillGetResponse                   `json:"result" api:"required"`
	Success  ThreatSignalSkillGetResponseEnvelopeSuccess    `json:"success" api:"required"`
	JSON     threatSignalSkillGetResponseEnvelopeJSON       `json:"-"`
}

func (*ThreatSignalSkillGetResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalSkillGetResponseEnvelopeErrors 

type ThreatSignalSkillGetResponseEnvelopeErrors struct {
	Message string                                         `json:"message" api:"required"`
	JSON    threatSignalSkillGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalSkillGetResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalSkillGetResponseEnvelopeMessages 

type ThreatSignalSkillGetResponseEnvelopeMessages struct {
	Message string  `json:"message" api:"required"`
	Code    float64 `json:"code"`
	// The current count of custom feeds for the account.
	CustomFeedCount int64 `json:"custom_feed_count"`
	// The custom feed limit for the account.
	CustomFeedLimit int64                                              `json:"custom_feed_limit"`
	Expected        string                                             `json:"expected"`
	Path            []string                                           `json:"path"`
	Reason          ThreatSignalSkillGetResponseEnvelopeMessagesReason `json:"reason"`
	JSON            threatSignalSkillGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ThreatSignalSkillGetResponseEnvelopeMessages) UnmarshalJSON 

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

type ThreatSignalSkillGetResponseEnvelopeMessagesReason 

type ThreatSignalSkillGetResponseEnvelopeMessagesReason string
const (
	ThreatSignalSkillGetResponseEnvelopeMessagesReasonThreatSignalsFeedLimit           ThreatSignalSkillGetResponseEnvelopeMessagesReason = "threat_signals_feed_limit"
	ThreatSignalSkillGetResponseEnvelopeMessagesReasonFreeCustomSkillsDisabled         ThreatSignalSkillGetResponseEnvelopeMessagesReason = "free_custom_skills_disabled"
	ThreatSignalSkillGetResponseEnvelopeMessagesReasonFreeSkillRunDisabled             ThreatSignalSkillGetResponseEnvelopeMessagesReason = "free_skill_run_disabled"
	ThreatSignalSkillGetResponseEnvelopeMessagesReasonFreeTierReconciliationInProgress ThreatSignalSkillGetResponseEnvelopeMessagesReason = "free_tier_reconciliation_in_progress"
	ThreatSignalSkillGetResponseEnvelopeMessagesReasonFreeTierReconciliationFailed     ThreatSignalSkillGetResponseEnvelopeMessagesReason = "free_tier_reconciliation_failed"
	ThreatSignalSkillGetResponseEnvelopeMessagesReasonRawContentExpired                ThreatSignalSkillGetResponseEnvelopeMessagesReason = "raw_content_expired"
	ThreatSignalSkillGetResponseEnvelopeMessagesReasonCuratedVisibilityChanged         ThreatSignalSkillGetResponseEnvelopeMessagesReason = "curated_visibility_changed"
)

func (ThreatSignalSkillGetResponseEnvelopeMessagesReason) IsKnown 

func (r ThreatSignalSkillGetResponseEnvelopeMessagesReason) IsKnown() bool

type ThreatSignalSkillGetResponseEnvelopeSuccess 

type ThreatSignalSkillGetResponseEnvelopeSuccess bool
const (
	ThreatSignalSkillGetResponseEnvelopeSuccessTrue ThreatSignalSkillGetResponseEnvelopeSuccess = true
)

func (ThreatSignalSkillGetResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalSkillGetResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalSkillGetResponseSource 

type ThreatSignalSkillGetResponseSource string

`default` for Cloudforce One managed skills (read-only), `custom` for account skills. 

const (
	ThreatSignalSkillGetResponseSourceDefault ThreatSignalSkillGetResponseSource = "default"
	ThreatSignalSkillGetResponseSourceCustom  ThreatSignalSkillGetResponseSource = "custom"
)

func (ThreatSignalSkillGetResponseSource) IsKnown 

func (r ThreatSignalSkillGetResponseSource) IsKnown() bool

type ThreatSignalSkillListParams 

type ThreatSignalSkillListParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Page      param.Field[int64]  `query:"page"`
	PerPage   param.Field[int64]  `query:"per_page"`
}

func (ThreatSignalSkillListParams) URLQuery 

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

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

type ThreatSignalSkillListResponse 

type ThreatSignalSkillListResponse struct {
	// Number of skills on this page.
	Count int64 `json:"count" api:"required"`
	// Whether the authenticated account may access custom-skill capabilities under
	// Stakeout's Threat Signals access-mode policy. This is a policy availability
	// indicator, not a row-existence indicator. False for threat_signals_only mode;
	// true for entitled, allowlisted, cfone_internal, and service modes.
	CustomSkillsAvailable bool                                 `json:"custom_skills_available" api:"required"`
	Page                  int64                                `json:"page" api:"required"`
	PerPage               int64                                `json:"per_page" api:"required"`
	Skills                []ThreatSignalSkillListResponseSkill `json:"skills" api:"required"`
	TotalCount            int64                                `json:"total_count" api:"required"`
	JSON                  threatSignalSkillListResponseJSON    `json:"-"`
}

func (*ThreatSignalSkillListResponse) UnmarshalJSON 

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

type ThreatSignalSkillListResponseSkill 

type ThreatSignalSkillListResponseSkill struct {
	ID string `json:"id" api:"required"`
	// JSON-encoded skill configuration. Always null for default skills.
	Config    string `json:"config" api:"required,nullable"`
	CreatedAt string `json:"created_at" api:"required"`
	// 1 when active, 0 when inactive.
	IsActive int64  `json:"is_active" api:"required"`
	Name     string `json:"name" api:"required"`
	// JSON-encoded JSON Schema the skill output must satisfy.
	OutputSchema string `json:"output_schema" api:"required,nullable"`
	Prompt       string `json:"prompt" api:"required"`
	// `default` for Cloudforce One managed skills (read-only), `custom` for account
	// skills.
	Source    ThreatSignalSkillListResponseSkillsSource `json:"source" api:"required"`
	Type      string                                    `json:"type" api:"required"`
	UpdatedAt string                                    `json:"updated_at" api:"required"`
	JSON      threatSignalSkillListResponseSkillJSON    `json:"-"`
}

func (*ThreatSignalSkillListResponseSkill) UnmarshalJSON 

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

type ThreatSignalSkillListResponseSkillsSource 

type ThreatSignalSkillListResponseSkillsSource string

`default` for Cloudforce One managed skills (read-only), `custom` for account skills. 

const (
	ThreatSignalSkillListResponseSkillsSourceDefault ThreatSignalSkillListResponseSkillsSource = "default"
	ThreatSignalSkillListResponseSkillsSourceCustom  ThreatSignalSkillListResponseSkillsSource = "custom"
)

func (ThreatSignalSkillListResponseSkillsSource) IsKnown 

func (r ThreatSignalSkillListResponseSkillsSource) IsKnown() bool

type ThreatSignalSkillNewParams 

type ThreatSignalSkillNewParams struct {
	AccountID    param.Field[string]                         `path:"account_id" api:"required"`
	Name         param.Field[string]                         `json:"name" api:"required"`
	OutputSchema param.Field[string]                         `json:"output_schema" api:"required"`
	Prompt       param.Field[string]                         `json:"prompt" api:"required"`
	Type         param.Field[ThreatSignalSkillNewParamsType] `json:"type" api:"required"`
}

func (ThreatSignalSkillNewParams) MarshalJSON 

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

type ThreatSignalSkillNewParamsType 

type ThreatSignalSkillNewParamsType string
const (
	ThreatSignalSkillNewParamsTypeSummary ThreatSignalSkillNewParamsType = "summary"
	ThreatSignalSkillNewParamsTypeTags    ThreatSignalSkillNewParamsType = "tags"
)

func (ThreatSignalSkillNewParamsType) IsKnown 

func (r ThreatSignalSkillNewParamsType) IsKnown() bool

type ThreatSignalSkillNewResponse 

type ThreatSignalSkillNewResponse struct {
	ID string `json:"id" api:"required"`
	// JSON-encoded skill configuration. Always null for default skills.
	Config    string `json:"config" api:"required,nullable"`
	CreatedAt string `json:"created_at" api:"required"`
	// 1 when active, 0 when inactive.
	IsActive int64  `json:"is_active" api:"required"`
	Name     string `json:"name" api:"required"`
	// JSON-encoded JSON Schema the skill output must satisfy.
	OutputSchema string `json:"output_schema" api:"required,nullable"`
	Prompt       string `json:"prompt" api:"required"`
	// `default` for Cloudforce One managed skills (read-only), `custom` for account
	// skills.
	Source    ThreatSignalSkillNewResponseSource `json:"source" api:"required"`
	Type      string                             `json:"type" api:"required"`
	UpdatedAt string                             `json:"updated_at" api:"required"`
	JSON      threatSignalSkillNewResponseJSON   `json:"-"`
}

func (*ThreatSignalSkillNewResponse) UnmarshalJSON 

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

type ThreatSignalSkillNewResponseEnvelope 

type ThreatSignalSkillNewResponseEnvelope struct {
	Errors   []ThreatSignalSkillNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ThreatSignalSkillNewResponseEnvelopeMessages `json:"messages" api:"required"`
	Result   ThreatSignalSkillNewResponse                   `json:"result" api:"required"`
	Success  ThreatSignalSkillNewResponseEnvelopeSuccess    `json:"success" api:"required"`
	JSON     threatSignalSkillNewResponseEnvelopeJSON       `json:"-"`
}

func (*ThreatSignalSkillNewResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalSkillNewResponseEnvelopeErrors 

type ThreatSignalSkillNewResponseEnvelopeErrors struct {
	Message string                                         `json:"message" api:"required"`
	JSON    threatSignalSkillNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalSkillNewResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalSkillNewResponseEnvelopeMessages 

type ThreatSignalSkillNewResponseEnvelopeMessages struct {
	Message string  `json:"message" api:"required"`
	Code    float64 `json:"code"`
	// The current count of custom feeds for the account.
	CustomFeedCount int64 `json:"custom_feed_count"`
	// The custom feed limit for the account.
	CustomFeedLimit int64                                              `json:"custom_feed_limit"`
	Expected        string                                             `json:"expected"`
	Path            []string                                           `json:"path"`
	Reason          ThreatSignalSkillNewResponseEnvelopeMessagesReason `json:"reason"`
	JSON            threatSignalSkillNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ThreatSignalSkillNewResponseEnvelopeMessages) UnmarshalJSON 

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

type ThreatSignalSkillNewResponseEnvelopeMessagesReason 

type ThreatSignalSkillNewResponseEnvelopeMessagesReason string
const (
	ThreatSignalSkillNewResponseEnvelopeMessagesReasonThreatSignalsFeedLimit           ThreatSignalSkillNewResponseEnvelopeMessagesReason = "threat_signals_feed_limit"
	ThreatSignalSkillNewResponseEnvelopeMessagesReasonFreeCustomSkillsDisabled         ThreatSignalSkillNewResponseEnvelopeMessagesReason = "free_custom_skills_disabled"
	ThreatSignalSkillNewResponseEnvelopeMessagesReasonFreeSkillRunDisabled             ThreatSignalSkillNewResponseEnvelopeMessagesReason = "free_skill_run_disabled"
	ThreatSignalSkillNewResponseEnvelopeMessagesReasonFreeTierReconciliationInProgress ThreatSignalSkillNewResponseEnvelopeMessagesReason = "free_tier_reconciliation_in_progress"
	ThreatSignalSkillNewResponseEnvelopeMessagesReasonFreeTierReconciliationFailed     ThreatSignalSkillNewResponseEnvelopeMessagesReason = "free_tier_reconciliation_failed"
	ThreatSignalSkillNewResponseEnvelopeMessagesReasonRawContentExpired                ThreatSignalSkillNewResponseEnvelopeMessagesReason = "raw_content_expired"
	ThreatSignalSkillNewResponseEnvelopeMessagesReasonCuratedVisibilityChanged         ThreatSignalSkillNewResponseEnvelopeMessagesReason = "curated_visibility_changed"
)

func (ThreatSignalSkillNewResponseEnvelopeMessagesReason) IsKnown 

func (r ThreatSignalSkillNewResponseEnvelopeMessagesReason) IsKnown() bool

type ThreatSignalSkillNewResponseEnvelopeSuccess 

type ThreatSignalSkillNewResponseEnvelopeSuccess bool
const (
	ThreatSignalSkillNewResponseEnvelopeSuccessTrue ThreatSignalSkillNewResponseEnvelopeSuccess = true
)

func (ThreatSignalSkillNewResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalSkillNewResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalSkillNewResponseSource 

type ThreatSignalSkillNewResponseSource string

`default` for Cloudforce One managed skills (read-only), `custom` for account skills. 

const (
	ThreatSignalSkillNewResponseSourceDefault ThreatSignalSkillNewResponseSource = "default"
	ThreatSignalSkillNewResponseSourceCustom  ThreatSignalSkillNewResponseSource = "custom"
)

func (ThreatSignalSkillNewResponseSource) IsKnown 

func (r ThreatSignalSkillNewResponseSource) IsKnown() bool

type ThreatSignalSkillService 

type ThreatSignalSkillService struct {
	Options       []option.RequestOption
	TagCategories *ThreatSignalSkillTagCategoryService
}

ThreatSignalSkillService 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 NewThreatSignalSkillService method instead.

func NewThreatSignalSkillService 

func NewThreatSignalSkillService(opts ...option.RequestOption) (r *ThreatSignalSkillService)

NewThreatSignalSkillService 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 (*ThreatSignalSkillService) Delete 

func (r *ThreatSignalSkillService) Delete(ctx context.Context, skillID string, body ThreatSignalSkillDeleteParams, opts ...option.RequestOption) (res *ThreatSignalSkillDeleteResponse, err error)

Deletes a custom skill. Default skills cannot be deleted.

func (*ThreatSignalSkillService) Edit 

func (r *ThreatSignalSkillService) Edit(ctx context.Context, skillID string, params ThreatSignalSkillEditParams, opts ...option.RequestOption) (res *ThreatSignalSkillEditResponse, err error)

Updates a custom skill. Default skills are read-only.

func (*ThreatSignalSkillService) Get 

func (r *ThreatSignalSkillService) Get(ctx context.Context, skillID string, query ThreatSignalSkillGetParams, opts ...option.RequestOption) (res *ThreatSignalSkillGetResponse, err error)

Retrieves a default or custom skill by ID.

func (*ThreatSignalSkillService) List 

func (r *ThreatSignalSkillService) List(ctx context.Context, params ThreatSignalSkillListParams, opts ...option.RequestOption) (res *pagination.V4PagePagination[ThreatSignalSkillListResponse], err error)

Lists the default and custom skills available to the account.

func (*ThreatSignalSkillService) ListAutoPaging 

func (r *ThreatSignalSkillService) ListAutoPaging(ctx context.Context, params ThreatSignalSkillListParams, opts ...option.RequestOption) *pagination.V4PagePaginationAutoPager[ThreatSignalSkillListResponse]

Lists the default and custom skills available to the account.

func (*ThreatSignalSkillService) New 

func (r *ThreatSignalSkillService) New(ctx context.Context, params ThreatSignalSkillNewParams, opts ...option.RequestOption) (res *ThreatSignalSkillNewResponse, err error)

Creates a custom AI skill for the account.

type ThreatSignalSkillTagCategoryGetParams 

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

type ThreatSignalSkillTagCategoryGetParamsSkillID 

type ThreatSignalSkillTagCategoryGetParamsSkillID string
const (
	ThreatSignalSkillTagCategoryGetParamsSkillIDDefaultTaggingSkill ThreatSignalSkillTagCategoryGetParamsSkillID = "default-tagging-skill"
)

func (ThreatSignalSkillTagCategoryGetParamsSkillID) IsKnown 

func (r ThreatSignalSkillTagCategoryGetParamsSkillID) IsKnown() bool

type ThreatSignalSkillTagCategoryGetResponse 

type ThreatSignalSkillTagCategoryGetResponse struct {
	CategoryUUIDs []string                                       `json:"category_uuids" api:"required" format:"uuid"`
	SkillID       ThreatSignalSkillTagCategoryGetResponseSkillID `json:"skill_id" api:"required"`
	JSON          threatSignalSkillTagCategoryGetResponseJSON    `json:"-"`
}

func (*ThreatSignalSkillTagCategoryGetResponse) UnmarshalJSON 

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

type ThreatSignalSkillTagCategoryGetResponseEnvelope 

type ThreatSignalSkillTagCategoryGetResponseEnvelope struct {
	Errors  []ThreatSignalSkillTagCategoryGetResponseEnvelopeErrors `json:"errors" api:"required"`
	Result  ThreatSignalSkillTagCategoryGetResponse                 `json:"result" api:"required"`
	Success ThreatSignalSkillTagCategoryGetResponseEnvelopeSuccess  `json:"success" api:"required"`
	JSON    threatSignalSkillTagCategoryGetResponseEnvelopeJSON     `json:"-"`
}

func (*ThreatSignalSkillTagCategoryGetResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalSkillTagCategoryGetResponseEnvelopeErrors 

type ThreatSignalSkillTagCategoryGetResponseEnvelopeErrors struct {
	Message string                                                    `json:"message" api:"required"`
	JSON    threatSignalSkillTagCategoryGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalSkillTagCategoryGetResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalSkillTagCategoryGetResponseEnvelopeSuccess 

type ThreatSignalSkillTagCategoryGetResponseEnvelopeSuccess bool
const (
	ThreatSignalSkillTagCategoryGetResponseEnvelopeSuccessTrue ThreatSignalSkillTagCategoryGetResponseEnvelopeSuccess = true
)

func (ThreatSignalSkillTagCategoryGetResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalSkillTagCategoryGetResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalSkillTagCategoryGetResponseSkillID 

type ThreatSignalSkillTagCategoryGetResponseSkillID string
const (
	ThreatSignalSkillTagCategoryGetResponseSkillIDDefaultTaggingSkill ThreatSignalSkillTagCategoryGetResponseSkillID = "default-tagging-skill"
)

func (ThreatSignalSkillTagCategoryGetResponseSkillID) IsKnown 

func (r ThreatSignalSkillTagCategoryGetResponseSkillID) IsKnown() bool

type ThreatSignalSkillTagCategoryService 

type ThreatSignalSkillTagCategoryService struct {
	Options []option.RequestOption
}

ThreatSignalSkillTagCategoryService 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 NewThreatSignalSkillTagCategoryService method instead.

func NewThreatSignalSkillTagCategoryService 

func NewThreatSignalSkillTagCategoryService(opts ...option.RequestOption) (r *ThreatSignalSkillTagCategoryService)

NewThreatSignalSkillTagCategoryService 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 (*ThreatSignalSkillTagCategoryService) Get 

func (r *ThreatSignalSkillTagCategoryService) Get(ctx context.Context, skillID ThreatSignalSkillTagCategoryGetParamsSkillID, query ThreatSignalSkillTagCategoryGetParams, opts ...option.RequestOption) (res *ThreatSignalSkillTagCategoryGetResponse, err error)

Retrieves the tag categories the default tagging skill may choose tags from.

func (*ThreatSignalSkillTagCategoryService) Update 

func (r *ThreatSignalSkillTagCategoryService) Update(ctx context.Context, skillID ThreatSignalSkillTagCategoryUpdateParamsSkillID, params ThreatSignalSkillTagCategoryUpdateParams, opts ...option.RequestOption) (res *ThreatSignalSkillTagCategoryUpdateResponse, err error)

Replaces the tag categories the default tagging skill may choose tags from.

type ThreatSignalSkillTagCategoryUpdateParams 

type ThreatSignalSkillTagCategoryUpdateParams struct {
	AccountID     param.Field[string]   `path:"account_id" api:"required"`
	CategoryUUIDs param.Field[[]string] `json:"category_uuids" api:"required" format:"uuid"`
}

func (ThreatSignalSkillTagCategoryUpdateParams) MarshalJSON 

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

type ThreatSignalSkillTagCategoryUpdateParamsSkillID 

type ThreatSignalSkillTagCategoryUpdateParamsSkillID string
const (
	ThreatSignalSkillTagCategoryUpdateParamsSkillIDDefaultTaggingSkill ThreatSignalSkillTagCategoryUpdateParamsSkillID = "default-tagging-skill"
)

func (ThreatSignalSkillTagCategoryUpdateParamsSkillID) IsKnown 

func (r ThreatSignalSkillTagCategoryUpdateParamsSkillID) IsKnown() bool

type ThreatSignalSkillTagCategoryUpdateResponse 

type ThreatSignalSkillTagCategoryUpdateResponse struct {
	CategoryUUIDs []string                                          `json:"category_uuids" api:"required" format:"uuid"`
	SkillID       ThreatSignalSkillTagCategoryUpdateResponseSkillID `json:"skill_id" api:"required"`
	JSON          threatSignalSkillTagCategoryUpdateResponseJSON    `json:"-"`
}

func (*ThreatSignalSkillTagCategoryUpdateResponse) UnmarshalJSON 

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

type ThreatSignalSkillTagCategoryUpdateResponseEnvelope 

type ThreatSignalSkillTagCategoryUpdateResponseEnvelope struct {
	Errors  []ThreatSignalSkillTagCategoryUpdateResponseEnvelopeErrors `json:"errors" api:"required"`
	Result  ThreatSignalSkillTagCategoryUpdateResponse                 `json:"result" api:"required"`
	Success ThreatSignalSkillTagCategoryUpdateResponseEnvelopeSuccess  `json:"success" api:"required"`
	JSON    threatSignalSkillTagCategoryUpdateResponseEnvelopeJSON     `json:"-"`
}

func (*ThreatSignalSkillTagCategoryUpdateResponseEnvelope) UnmarshalJSON 

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

type ThreatSignalSkillTagCategoryUpdateResponseEnvelopeErrors 

type ThreatSignalSkillTagCategoryUpdateResponseEnvelopeErrors struct {
	Message string                                                       `json:"message" api:"required"`
	JSON    threatSignalSkillTagCategoryUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ThreatSignalSkillTagCategoryUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type ThreatSignalSkillTagCategoryUpdateResponseEnvelopeSuccess 

type ThreatSignalSkillTagCategoryUpdateResponseEnvelopeSuccess bool
const (
	ThreatSignalSkillTagCategoryUpdateResponseEnvelopeSuccessTrue ThreatSignalSkillTagCategoryUpdateResponseEnvelopeSuccess = true
)

func (ThreatSignalSkillTagCategoryUpdateResponseEnvelopeSuccess) IsKnown 

func (r ThreatSignalSkillTagCategoryUpdateResponseEnvelopeSuccess) IsKnown() bool

type ThreatSignalSkillTagCategoryUpdateResponseSkillID 

type ThreatSignalSkillTagCategoryUpdateResponseSkillID string
const (
	ThreatSignalSkillTagCategoryUpdateResponseSkillIDDefaultTaggingSkill ThreatSignalSkillTagCategoryUpdateResponseSkillID = "default-tagging-skill"
)

func (ThreatSignalSkillTagCategoryUpdateResponseSkillID) IsKnown 

func (r ThreatSignalSkillTagCategoryUpdateResponseSkillID) IsKnown() bool

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.