cloudflare

type AssetCollect struct{}

type AssetSync struct {
	// Disable is used to disable the asset sync operation from Cloudflare
	Disable bool `json:"disable,omitempty" jsonschema:"title=Disable,description=Disable the syncing of domains from Cloudflare Registrar"`
	// FilterExpr limits imported records to envelopes matching the CEL expression
	FilterExpr string `` /* 181-byte string literal not displayed */
}

type Client struct{}

type ClientConfig struct {
	// AccountID is the Cloudflare account this client is scoped to
	AccountID string
	// APIToken is the raw Cloudflare API token, needed by calls made outside the SDK client
	// (e.g. Browser Rendering requests issued directly by the domain scan enrichment operation)
	APIToken string
	// DomainScan configures vendor/technology classification for onboarding domain scan
	// reports; runtime client only
	DomainScan domainscan.ReportConfig
}

type CloudflareClient struct {
	*cf.Client
	// Config holds the account scope and domain scan settings this client was built with
	Config ClientConfig
}

type CredentialSchema struct {
	// APIToken is the Cloudflare API token with permissions to read account and zone metadata
	APIToken string `json:"apiToken"          jsonschema:"required,title=API Token"`
	// AccountID is the Cloudflare account identifier used for account-scoped API calls
	AccountID string `` /* 137-byte string literal not displayed */
}

type DirectorySync struct {
	// Disable is used to disable the directory sync operation from Cloudflare
	Disable bool `json:"disable,omitempty" jsonschema:"title=Disable,description=Disable the syncing of users and groups from Cloudflare"`
	// FilterExpr limits imported records to envelopes matching the CEL expression
	FilterExpr string `` /* 216-byte string literal not displayed */
}

type DomainScanBuildReport struct {
	// InternalScanID is the openlane Scan record id the built report belongs to
	InternalScanID string `json:"internalScanId"`
	// Result is the completed URL Scanner task result to build the report from, allowed to be empty
	// so if the url scanner failed the enrichment data can still be used for a partial report
	Result json.RawMessage `json:"result,omitempty"`
	// Enrichment is the company profile, compliance, and DNS vendor data gathered via
	// DomainScanGatherEnrichment
	Enrichment domainscan.Enrichment `json:"enrichment"`
}

type DomainScanBuildReportResult struct {
	// Data is the structured scan report, ready to persist on the Scan record
	Data map[string]any `json:"data"`
}

type DomainScanGatherEnrichment struct {
	// Domain is the domain to gather enrichment for
	Domain string `json:"domain"`
	// ForceRefresh bypasses Cloudflare's Browser Rendering cache, forcing a fresh render
	ForceRefresh bool `json:"forceRefresh,omitempty"`
}

type DomainScanGatherEnrichmentResult struct {
	// Enrichment is the gathered company profile, compliance, and DNS vendor data
	Enrichment domainscan.Enrichment `json:"enrichment"`
}

type DomainScanImport struct {
	// OrganizationID is the organization the created records belong to
	OrganizationID string `json:"organizationId"`
	// ScanIDs are the Scan records the created records should link back to
	ScanIDs []string `json:"scanIds"`
	// Platforms are the accepted platforms, if any
	Platforms []DomainScanImportPlatform `json:"platforms,omitempty"`
	// Systems are the accepted system details
	Systems []DomainScanImportSystem `json:"systems,omitempty"`
	// Vendors are the accepted vendors
	Vendors []DomainScanImportVendor `json:"vendors"`
	// Assets are the accepted assets
	Assets []DomainScanImportAsset `json:"assets"`
	// Findings are the accepted findings
	Findings []DomainScanImportFinding `json:"findings,omitempty"`
}

type DomainScanImportAsset struct {
	// Ref is a client-assigned identifier for this asset, referenced by AssetRefs elsewhere in the envelope
	Ref string `json:"ref"`
	// Name is the asset's display name
	Name string `json:"name"`
	// Identifier is the asset's domain, IP, or other unique identifier
	Identifier string `json:"identifier,omitempty"`
	// Website is the asset's URL, if known
	Website string `json:"website,omitempty"`
	// Categories are the asset's detected categories
	Categories []string `json:"categories,omitempty"`
}

type DomainScanImportFinding struct {
	// Category is the finding's category
	Category string `json:"category,omitempty"`
	// Description is the finding's description
	Description string `json:"description,omitempty"`
	// Severity is the finding's severity
	Severity string `json:"severity,omitempty"`
	// Domain is the domain this finding was raised against, if known
	Domain string `json:"domain,omitempty"`
}

type DomainScanImportPlatform struct {
	// Ref is a client-assigned identifier for this platform, referenced by PlatformRefs elsewhere in the envelope
	Ref string `json:"ref"`
	// Name is the platform's name
	Name string `json:"name"`
	// Description is the platform's description
	Description string `json:"description,omitempty"`
	// EntityRefs are the Refs of accepted vendors linked to this platform
	EntityRefs []string `json:"entityRefs,omitempty"`
	// AssetRefs are the Refs of accepted assets linked to this platform
	AssetRefs []string `json:"assetRefs,omitempty"`
}

type DomainScanImportSystem struct {
	// Name is the system's name
	Name string `json:"name"`
	// Description is the system's description
	Description string `json:"description,omitempty"`
	// EntityRefs are the Refs of accepted vendors linked to this system
	EntityRefs []string `json:"entityRefs,omitempty"`
	// AssetRefs are the Refs of accepted assets linked to this system
	AssetRefs []string `json:"assetRefs,omitempty"`
	// PlatformRefs are the Refs of accepted platforms this system belongs to
	PlatformRefs []string `json:"platformRefs,omitempty"`
}

type DomainScanImportVendor struct {
	// Ref is a client-assigned identifier for this vendor, referenced by EntityRefs elsewhere in the envelope
	Ref string `json:"ref"`
	// Name is the vendor's name
	Name string `json:"name"`
	// LegalName is the vendor's raw legal entity name, if known and different from Name
	LegalName string `json:"legalName,omitempty"`
	// Domain is the vendor's domain, if known
	Domain string `json:"domain,omitempty"`
	// Categories are the vendor's detected categories
	Categories []string `json:"categories,omitempty"`
}

type DomainScanPoll struct {
	// ScanResultID is the scan ID returned by DomainScanSubmit
	ScanResultID string `json:"scanResultId"`
}

type DomainScanPollEnvelope struct {
	// OrganizationID is the organization that owns the scan
	OrganizationID string `json:"organizationId"`
	// ScanResultID is the scan ID returned by Cloudflare's URL Scanner on submission
	ScanResultID string `json:"scanResultId"`
	// InternalScanID is the id of the Scan record created when the scan was submitted;
	// the poll cycle updates this same record rather than creating a new one on completion
	InternalScanID string `json:"internalScanId"`
	// Attempt is the number of poll cycles already attempted for this scan
	Attempt int `json:"attempt"`
	// SiblingScanIDs lists every internal Scan ID submitted together with this one
	// so the last one to finish can gather and combine every sibling's report into a single notification
	SiblingScanIDs []string `json:"siblingScanIds"`
}

type DomainScanPollHandler func(context.Context, DomainScanPollEnvelope) (done bool, err error)

type DomainScanPollResult struct {
	// Result is the raw URL Scanner result payload
	Result *url_scanner.ScanGetResponse `json:"result"`
	// TaskErrors lists task-level errors reported alongside the result, if any
	TaskErrors ScanTaskErrors `json:"taskErrors,omitempty"`
	// NotReady is true when Cloudflare reported the scan isn't available yet (either not yet
	// indexed, or still running) rather than a genuine fetch failure. The caller's own poll
	// backoff/retry schedule is responsible for trying again, not this operation
	NotReady bool `json:"notReady,omitempty"`
}

type DomainScanRequest struct {
	// OrganizationID is the organization the scan belongs to, only used when dispatched without an  Integration
	// customer-facing calls always derive the organization from their resolved Integration instead, ignoring this field
	OrganizationID string `json:"organizationId,omitempty"`
	// Domain is the domain to scan
	Domain string `json:"domain" jsonschema:"required,title=Domain,description=Domain to scan"`
	// ForceRefresh bypasses Cloudflare's Browser Rendering cache, forcing a fresh render
	// instead of reusing one from a previous scan of the same domain
	ForceRefresh bool `json:"forceRefresh,omitempty" jsonschema:"title=Force Refresh,description=Bypass the render cache and force a fresh scan"`
	// GroupID links this scan to sibling scans requested together so they can be recombined into a
	// single notification once the whole group finishes
	GroupID string `json:"groupId,omitempty"`
}

type DomainScanRequestResult struct {
	// Message describes what happened
	Message string `json:"message"`
	// ScanID is the id of the Scan record for this request
	ScanID string `json:"scanId"`
}

type DomainScanSubmit struct {
	// Domains is the list of domains to submit for scanning
	Domains []string `json:"domains"`
}

type DomainScanSubmitResult struct {
	// Scans is the list of scan tasks created by Cloudflare's URL Scanner
	Scans []url_scanner.ScanBulkNewResponse `json:"scans"`
}

type FindingsCollect struct{}

type FindingsSync struct {
	// Disable is used to disable the findings sync operation from Cloudflare
	Disable bool `` /* 136-byte string literal not displayed */
	// FilterExpr limits imported records to envelopes matching the CEL expression
	FilterExpr string `` /* 185-byte string literal not displayed */
}

type HealthCheck struct {
	// Status is the token verification status returned by Cloudflare
	Status string `json:"status,omitempty"`
	// ExpiresOn is the token expiry time if set
	ExpiresOn string `json:"expiresOn,omitempty"`
}

type InstallationMetadata struct {
	// AccountID is the Cloudflare account identifier used for account-scoped collection
	AccountID string `json:"accountId,omitempty" jsonschema:"title=Account ID"`
}

type RuntimeConfig struct {
	// APIToken is the Cloudflare API token for the operator-owned account
	APIToken string `` /* 126-byte string literal not displayed */
	// AccountID is the Cloudflare account identifier for the operator-owned account
	AccountID string `json:"accountid" koanf:"accountid" jsonschema:"description=Cloudflare account ID for the operator-owned account"`
	// DomainScan configures vendor/technology classification and enrichment behavior for
	// onboarding domain scan reports
	DomainScan domainscan.ReportConfig `` /* 153-byte string literal not displayed */
}

type ScanTaskError struct {
	Name    string `json:"name"`
	Message string `json:"message"`
	Detail  string `json:"detail"`
	Code    int    `json:"code"`
}

type ScanTaskErrors []ScanTaskError

type UserInput struct {
	// DirectorySync includes the configuration for identity accounts from Cloudflare members
	DirectorySync DirectorySync `json:"directorySync,omitempty" jsonschema:"title=Directory Account Sync"`
	// AssetSync includes the configuration for Cloudflare domains as assets
	AssetSync AssetSync `json:"assetSync,omitempty" jsonschema:"title=Cloudflare Asset Sync"`
	// FindingsSync includes the configuration for findings from Cloudflare Security Center insights
	FindingsSync FindingsSync `json:"findingSync,omitempty" jsonschema:"title=Security Insights Sync"`
}