ai_gateway

package
v4.2.0 Latest Latest
Warning

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

Go to latest
Published: Mar 18, 2025 License: Apache-2.0 Imports: 16 Imported by: 1

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 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 AIGatewayDeleteParams

type AIGatewayDeleteParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type AIGatewayDeleteResponse

type AIGatewayDeleteResponse struct {
	// gateway id
	ID                      string                                       `json:"id,required"`
	AccountID               string                                       `json:"account_id,required"`
	AccountTag              string                                       `json:"account_tag,required"`
	CacheInvalidateOnUpdate bool                                         `json:"cache_invalidate_on_update,required"`
	CacheTTL                int64                                        `json:"cache_ttl,required,nullable"`
	CollectLogs             bool                                         `json:"collect_logs,required"`
	CreatedAt               time.Time                                    `json:"created_at,required" format:"date-time"`
	InternalID              string                                       `json:"internal_id,required" format:"uuid"`
	ModifiedAt              time.Time                                    `json:"modified_at,required" format:"date-time"`
	RateLimitingInterval    int64                                        `json:"rate_limiting_interval,required,nullable"`
	RateLimitingLimit       int64                                        `json:"rate_limiting_limit,required,nullable"`
	RateLimitingTechnique   AIGatewayDeleteResponseRateLimitingTechnique `json:"rate_limiting_technique,required"`
	Authentication          bool                                         `json:"authentication"`
	LogManagement           int64                                        `json:"log_management,nullable"`
	LogManagementStrategy   AIGatewayDeleteResponseLogManagementStrategy `json:"log_management_strategy,nullable"`
	Logpush                 bool                                         `json:"logpush"`
	LogpushPublicKey        string                                       `json:"logpush_public_key,nullable"`
	JSON                    aiGatewayDeleteResponseJSON                  `json:"-"`
}

func (*AIGatewayDeleteResponse) UnmarshalJSON

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

type AIGatewayDeleteResponseEnvelope

type AIGatewayDeleteResponseEnvelope struct {
	Result  AIGatewayDeleteResponse             `json:"result,required"`
	Success bool                                `json:"success,required"`
	JSON    aiGatewayDeleteResponseEnvelopeJSON `json:"-"`
}

func (*AIGatewayDeleteResponseEnvelope) UnmarshalJSON

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

type AIGatewayDeleteResponseLogManagementStrategy added in v4.2.0

type AIGatewayDeleteResponseLogManagementStrategy string
const (
	AIGatewayDeleteResponseLogManagementStrategyStopInserting AIGatewayDeleteResponseLogManagementStrategy = "STOP_INSERTING"
	AIGatewayDeleteResponseLogManagementStrategyDeleteOldest  AIGatewayDeleteResponseLogManagementStrategy = "DELETE_OLDEST"
)

func (AIGatewayDeleteResponseLogManagementStrategy) IsKnown added in v4.2.0

type AIGatewayDeleteResponseRateLimitingTechnique

type AIGatewayDeleteResponseRateLimitingTechnique string
const (
	AIGatewayDeleteResponseRateLimitingTechniqueFixed   AIGatewayDeleteResponseRateLimitingTechnique = "fixed"
	AIGatewayDeleteResponseRateLimitingTechniqueSliding AIGatewayDeleteResponseRateLimitingTechnique = "sliding"
)

func (AIGatewayDeleteResponseRateLimitingTechnique) IsKnown

type AIGatewayGetParams

type AIGatewayGetParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type AIGatewayGetResponse

type AIGatewayGetResponse struct {
	// gateway id
	ID                      string                                    `json:"id,required"`
	AccountID               string                                    `json:"account_id,required"`
	AccountTag              string                                    `json:"account_tag,required"`
	CacheInvalidateOnUpdate bool                                      `json:"cache_invalidate_on_update,required"`
	CacheTTL                int64                                     `json:"cache_ttl,required,nullable"`
	CollectLogs             bool                                      `json:"collect_logs,required"`
	CreatedAt               time.Time                                 `json:"created_at,required" format:"date-time"`
	InternalID              string                                    `json:"internal_id,required" format:"uuid"`
	ModifiedAt              time.Time                                 `json:"modified_at,required" format:"date-time"`
	RateLimitingInterval    int64                                     `json:"rate_limiting_interval,required,nullable"`
	RateLimitingLimit       int64                                     `json:"rate_limiting_limit,required,nullable"`
	RateLimitingTechnique   AIGatewayGetResponseRateLimitingTechnique `json:"rate_limiting_technique,required"`
	Authentication          bool                                      `json:"authentication"`
	LogManagement           int64                                     `json:"log_management,nullable"`
	LogManagementStrategy   AIGatewayGetResponseLogManagementStrategy `json:"log_management_strategy,nullable"`
	Logpush                 bool                                      `json:"logpush"`
	LogpushPublicKey        string                                    `json:"logpush_public_key,nullable"`
	JSON                    aiGatewayGetResponseJSON                  `json:"-"`
}

func (*AIGatewayGetResponse) UnmarshalJSON

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

type AIGatewayGetResponseEnvelope

type AIGatewayGetResponseEnvelope struct {
	Result  AIGatewayGetResponse             `json:"result,required"`
	Success bool                             `json:"success,required"`
	JSON    aiGatewayGetResponseEnvelopeJSON `json:"-"`
}

func (*AIGatewayGetResponseEnvelope) UnmarshalJSON

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

type AIGatewayGetResponseLogManagementStrategy added in v4.2.0

type AIGatewayGetResponseLogManagementStrategy string
const (
	AIGatewayGetResponseLogManagementStrategyStopInserting AIGatewayGetResponseLogManagementStrategy = "STOP_INSERTING"
	AIGatewayGetResponseLogManagementStrategyDeleteOldest  AIGatewayGetResponseLogManagementStrategy = "DELETE_OLDEST"
)

func (AIGatewayGetResponseLogManagementStrategy) IsKnown added in v4.2.0

type AIGatewayGetResponseRateLimitingTechnique

type AIGatewayGetResponseRateLimitingTechnique string
const (
	AIGatewayGetResponseRateLimitingTechniqueFixed   AIGatewayGetResponseRateLimitingTechnique = "fixed"
	AIGatewayGetResponseRateLimitingTechniqueSliding AIGatewayGetResponseRateLimitingTechnique = "sliding"
)

func (AIGatewayGetResponseRateLimitingTechnique) IsKnown

type AIGatewayListParams

type AIGatewayListParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	Page      param.Field[int64]  `query:"page"`
	PerPage   param.Field[int64]  `query:"per_page"`
	// Search by id
	Search param.Field[string] `query:"search"`
}

func (AIGatewayListParams) URLQuery

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

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

type AIGatewayListResponse

type AIGatewayListResponse struct {
	// gateway id
	ID                      string                                     `json:"id,required"`
	AccountID               string                                     `json:"account_id,required"`
	AccountTag              string                                     `json:"account_tag,required"`
	CacheInvalidateOnUpdate bool                                       `json:"cache_invalidate_on_update,required"`
	CacheTTL                int64                                      `json:"cache_ttl,required,nullable"`
	CollectLogs             bool                                       `json:"collect_logs,required"`
	CreatedAt               time.Time                                  `json:"created_at,required" format:"date-time"`
	InternalID              string                                     `json:"internal_id,required" format:"uuid"`
	ModifiedAt              time.Time                                  `json:"modified_at,required" format:"date-time"`
	RateLimitingInterval    int64                                      `json:"rate_limiting_interval,required,nullable"`
	RateLimitingLimit       int64                                      `json:"rate_limiting_limit,required,nullable"`
	RateLimitingTechnique   AIGatewayListResponseRateLimitingTechnique `json:"rate_limiting_technique,required"`
	Authentication          bool                                       `json:"authentication"`
	LogManagement           int64                                      `json:"log_management,nullable"`
	LogManagementStrategy   AIGatewayListResponseLogManagementStrategy `json:"log_management_strategy,nullable"`
	Logpush                 bool                                       `json:"logpush"`
	LogpushPublicKey        string                                     `json:"logpush_public_key,nullable"`
	JSON                    aiGatewayListResponseJSON                  `json:"-"`
}

func (*AIGatewayListResponse) UnmarshalJSON

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

type AIGatewayListResponseLogManagementStrategy added in v4.2.0

type AIGatewayListResponseLogManagementStrategy string
const (
	AIGatewayListResponseLogManagementStrategyStopInserting AIGatewayListResponseLogManagementStrategy = "STOP_INSERTING"
	AIGatewayListResponseLogManagementStrategyDeleteOldest  AIGatewayListResponseLogManagementStrategy = "DELETE_OLDEST"
)

func (AIGatewayListResponseLogManagementStrategy) IsKnown added in v4.2.0

type AIGatewayListResponseRateLimitingTechnique

type AIGatewayListResponseRateLimitingTechnique string
const (
	AIGatewayListResponseRateLimitingTechniqueFixed   AIGatewayListResponseRateLimitingTechnique = "fixed"
	AIGatewayListResponseRateLimitingTechniqueSliding AIGatewayListResponseRateLimitingTechnique = "sliding"
)

func (AIGatewayListResponseRateLimitingTechnique) IsKnown

type AIGatewayNewParams

type AIGatewayNewParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	// gateway id
	ID                      param.Field[string]                                  `json:"id,required"`
	CacheInvalidateOnUpdate param.Field[bool]                                    `json:"cache_invalidate_on_update,required"`
	CacheTTL                param.Field[int64]                                   `json:"cache_ttl,required"`
	CollectLogs             param.Field[bool]                                    `json:"collect_logs,required"`
	RateLimitingInterval    param.Field[int64]                                   `json:"rate_limiting_interval,required"`
	RateLimitingLimit       param.Field[int64]                                   `json:"rate_limiting_limit,required"`
	RateLimitingTechnique   param.Field[AIGatewayNewParamsRateLimitingTechnique] `json:"rate_limiting_technique,required"`
	Authentication          param.Field[bool]                                    `json:"authentication"`
	LogManagement           param.Field[int64]                                   `json:"log_management"`
	LogManagementStrategy   param.Field[AIGatewayNewParamsLogManagementStrategy] `json:"log_management_strategy"`
	Logpush                 param.Field[bool]                                    `json:"logpush"`
	LogpushPublicKey        param.Field[string]                                  `json:"logpush_public_key"`
}

func (AIGatewayNewParams) MarshalJSON

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

type AIGatewayNewParamsLogManagementStrategy added in v4.2.0

type AIGatewayNewParamsLogManagementStrategy string
const (
	AIGatewayNewParamsLogManagementStrategyStopInserting AIGatewayNewParamsLogManagementStrategy = "STOP_INSERTING"
	AIGatewayNewParamsLogManagementStrategyDeleteOldest  AIGatewayNewParamsLogManagementStrategy = "DELETE_OLDEST"
)

func (AIGatewayNewParamsLogManagementStrategy) IsKnown added in v4.2.0

type AIGatewayNewParamsRateLimitingTechnique

type AIGatewayNewParamsRateLimitingTechnique string
const (
	AIGatewayNewParamsRateLimitingTechniqueFixed   AIGatewayNewParamsRateLimitingTechnique = "fixed"
	AIGatewayNewParamsRateLimitingTechniqueSliding AIGatewayNewParamsRateLimitingTechnique = "sliding"
)

func (AIGatewayNewParamsRateLimitingTechnique) IsKnown

type AIGatewayNewResponse

type AIGatewayNewResponse struct {
	// gateway id
	ID                      string                                    `json:"id,required"`
	AccountID               string                                    `json:"account_id,required"`
	AccountTag              string                                    `json:"account_tag,required"`
	CacheInvalidateOnUpdate bool                                      `json:"cache_invalidate_on_update,required"`
	CacheTTL                int64                                     `json:"cache_ttl,required,nullable"`
	CollectLogs             bool                                      `json:"collect_logs,required"`
	CreatedAt               time.Time                                 `json:"created_at,required" format:"date-time"`
	InternalID              string                                    `json:"internal_id,required" format:"uuid"`
	ModifiedAt              time.Time                                 `json:"modified_at,required" format:"date-time"`
	RateLimitingInterval    int64                                     `json:"rate_limiting_interval,required,nullable"`
	RateLimitingLimit       int64                                     `json:"rate_limiting_limit,required,nullable"`
	RateLimitingTechnique   AIGatewayNewResponseRateLimitingTechnique `json:"rate_limiting_technique,required"`
	Authentication          bool                                      `json:"authentication"`
	LogManagement           int64                                     `json:"log_management,nullable"`
	LogManagementStrategy   AIGatewayNewResponseLogManagementStrategy `json:"log_management_strategy,nullable"`
	Logpush                 bool                                      `json:"logpush"`
	LogpushPublicKey        string                                    `json:"logpush_public_key,nullable"`
	JSON                    aiGatewayNewResponseJSON                  `json:"-"`
}

func (*AIGatewayNewResponse) UnmarshalJSON

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

type AIGatewayNewResponseEnvelope

type AIGatewayNewResponseEnvelope struct {
	Result  AIGatewayNewResponse             `json:"result,required"`
	Success bool                             `json:"success,required"`
	JSON    aiGatewayNewResponseEnvelopeJSON `json:"-"`
}

func (*AIGatewayNewResponseEnvelope) UnmarshalJSON

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

type AIGatewayNewResponseLogManagementStrategy added in v4.2.0

type AIGatewayNewResponseLogManagementStrategy string
const (
	AIGatewayNewResponseLogManagementStrategyStopInserting AIGatewayNewResponseLogManagementStrategy = "STOP_INSERTING"
	AIGatewayNewResponseLogManagementStrategyDeleteOldest  AIGatewayNewResponseLogManagementStrategy = "DELETE_OLDEST"
)

func (AIGatewayNewResponseLogManagementStrategy) IsKnown added in v4.2.0

type AIGatewayNewResponseRateLimitingTechnique

type AIGatewayNewResponseRateLimitingTechnique string
const (
	AIGatewayNewResponseRateLimitingTechniqueFixed   AIGatewayNewResponseRateLimitingTechnique = "fixed"
	AIGatewayNewResponseRateLimitingTechniqueSliding AIGatewayNewResponseRateLimitingTechnique = "sliding"
)

func (AIGatewayNewResponseRateLimitingTechnique) IsKnown

type AIGatewayService

type AIGatewayService struct {
	Options         []option.RequestOption
	EvaluationTypes *EvaluationTypeService
	Logs            *LogService
	Datasets        *DatasetService
	Evaluations     *EvaluationService
	URLs            *URLService
}

AIGatewayService 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 NewAIGatewayService method instead.

func NewAIGatewayService

func NewAIGatewayService(opts ...option.RequestOption) (r *AIGatewayService)

NewAIGatewayService 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 (*AIGatewayService) Delete

Delete a Gateway

func (*AIGatewayService) Get

Fetch a Gateway

func (*AIGatewayService) List

List Gateways

func (*AIGatewayService) ListAutoPaging

List Gateways

func (*AIGatewayService) New

Create a new Gateway

func (*AIGatewayService) Update

Update a Gateway

type AIGatewayUpdateParams

type AIGatewayUpdateParams struct {
	AccountID               param.Field[string]                                     `path:"account_id,required"`
	CacheInvalidateOnUpdate param.Field[bool]                                       `json:"cache_invalidate_on_update,required"`
	CacheTTL                param.Field[int64]                                      `json:"cache_ttl,required"`
	CollectLogs             param.Field[bool]                                       `json:"collect_logs,required"`
	RateLimitingInterval    param.Field[int64]                                      `json:"rate_limiting_interval,required"`
	RateLimitingLimit       param.Field[int64]                                      `json:"rate_limiting_limit,required"`
	RateLimitingTechnique   param.Field[AIGatewayUpdateParamsRateLimitingTechnique] `json:"rate_limiting_technique,required"`
	Authentication          param.Field[bool]                                       `json:"authentication"`
	LogManagement           param.Field[int64]                                      `json:"log_management"`
	LogManagementStrategy   param.Field[AIGatewayUpdateParamsLogManagementStrategy] `json:"log_management_strategy"`
	Logpush                 param.Field[bool]                                       `json:"logpush"`
	LogpushPublicKey        param.Field[string]                                     `json:"logpush_public_key"`
}

func (AIGatewayUpdateParams) MarshalJSON

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

type AIGatewayUpdateParamsLogManagementStrategy added in v4.2.0

type AIGatewayUpdateParamsLogManagementStrategy string
const (
	AIGatewayUpdateParamsLogManagementStrategyStopInserting AIGatewayUpdateParamsLogManagementStrategy = "STOP_INSERTING"
	AIGatewayUpdateParamsLogManagementStrategyDeleteOldest  AIGatewayUpdateParamsLogManagementStrategy = "DELETE_OLDEST"
)

func (AIGatewayUpdateParamsLogManagementStrategy) IsKnown added in v4.2.0

type AIGatewayUpdateParamsRateLimitingTechnique

type AIGatewayUpdateParamsRateLimitingTechnique string
const (
	AIGatewayUpdateParamsRateLimitingTechniqueFixed   AIGatewayUpdateParamsRateLimitingTechnique = "fixed"
	AIGatewayUpdateParamsRateLimitingTechniqueSliding AIGatewayUpdateParamsRateLimitingTechnique = "sliding"
)

func (AIGatewayUpdateParamsRateLimitingTechnique) IsKnown

type AIGatewayUpdateResponse

type AIGatewayUpdateResponse struct {
	// gateway id
	ID                      string                                       `json:"id,required"`
	AccountID               string                                       `json:"account_id,required"`
	AccountTag              string                                       `json:"account_tag,required"`
	CacheInvalidateOnUpdate bool                                         `json:"cache_invalidate_on_update,required"`
	CacheTTL                int64                                        `json:"cache_ttl,required,nullable"`
	CollectLogs             bool                                         `json:"collect_logs,required"`
	CreatedAt               time.Time                                    `json:"created_at,required" format:"date-time"`
	InternalID              string                                       `json:"internal_id,required" format:"uuid"`
	ModifiedAt              time.Time                                    `json:"modified_at,required" format:"date-time"`
	RateLimitingInterval    int64                                        `json:"rate_limiting_interval,required,nullable"`
	RateLimitingLimit       int64                                        `json:"rate_limiting_limit,required,nullable"`
	RateLimitingTechnique   AIGatewayUpdateResponseRateLimitingTechnique `json:"rate_limiting_technique,required"`
	Authentication          bool                                         `json:"authentication"`
	LogManagement           int64                                        `json:"log_management,nullable"`
	LogManagementStrategy   AIGatewayUpdateResponseLogManagementStrategy `json:"log_management_strategy,nullable"`
	Logpush                 bool                                         `json:"logpush"`
	LogpushPublicKey        string                                       `json:"logpush_public_key,nullable"`
	JSON                    aiGatewayUpdateResponseJSON                  `json:"-"`
}

func (*AIGatewayUpdateResponse) UnmarshalJSON

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

type AIGatewayUpdateResponseEnvelope

type AIGatewayUpdateResponseEnvelope struct {
	Result  AIGatewayUpdateResponse             `json:"result,required"`
	Success bool                                `json:"success,required"`
	JSON    aiGatewayUpdateResponseEnvelopeJSON `json:"-"`
}

func (*AIGatewayUpdateResponseEnvelope) UnmarshalJSON

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

type AIGatewayUpdateResponseLogManagementStrategy added in v4.2.0

type AIGatewayUpdateResponseLogManagementStrategy string
const (
	AIGatewayUpdateResponseLogManagementStrategyStopInserting AIGatewayUpdateResponseLogManagementStrategy = "STOP_INSERTING"
	AIGatewayUpdateResponseLogManagementStrategyDeleteOldest  AIGatewayUpdateResponseLogManagementStrategy = "DELETE_OLDEST"
)

func (AIGatewayUpdateResponseLogManagementStrategy) IsKnown added in v4.2.0

type AIGatewayUpdateResponseRateLimitingTechnique

type AIGatewayUpdateResponseRateLimitingTechnique string
const (
	AIGatewayUpdateResponseRateLimitingTechniqueFixed   AIGatewayUpdateResponseRateLimitingTechnique = "fixed"
	AIGatewayUpdateResponseRateLimitingTechniqueSliding AIGatewayUpdateResponseRateLimitingTechnique = "sliding"
)

func (AIGatewayUpdateResponseRateLimitingTechnique) IsKnown

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

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

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType

type CertificateRequestType = shared.CertificateRequestType

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

This is an alias to an internal type.

type CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type 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 DatasetDeleteParams

type DatasetDeleteParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type DatasetDeleteResponse

type DatasetDeleteResponse struct {
	ID         string                        `json:"id,required"`
	AccountID  string                        `json:"account_id,required"`
	AccountTag string                        `json:"account_tag,required"`
	CreatedAt  time.Time                     `json:"created_at,required" format:"date-time"`
	Enable     bool                          `json:"enable,required"`
	Filters    []DatasetDeleteResponseFilter `json:"filters,required"`
	// gateway id
	GatewayID  string                    `json:"gateway_id,required"`
	ModifiedAt time.Time                 `json:"modified_at,required" format:"date-time"`
	Name       string                    `json:"name,required"`
	JSON       datasetDeleteResponseJSON `json:"-"`
}

func (*DatasetDeleteResponse) UnmarshalJSON

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

type DatasetDeleteResponseEnvelope

type DatasetDeleteResponseEnvelope struct {
	Result  DatasetDeleteResponse             `json:"result,required"`
	Success bool                              `json:"success,required"`
	JSON    datasetDeleteResponseEnvelopeJSON `json:"-"`
}

func (*DatasetDeleteResponseEnvelope) UnmarshalJSON

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

type DatasetDeleteResponseFilter

type DatasetDeleteResponseFilter struct {
	Key      DatasetDeleteResponseFiltersKey          `json:"key,required"`
	Operator DatasetDeleteResponseFiltersOperator     `json:"operator,required"`
	Value    []DatasetDeleteResponseFiltersValueUnion `json:"value,required"`
	JSON     datasetDeleteResponseFilterJSON          `json:"-"`
}

func (*DatasetDeleteResponseFilter) UnmarshalJSON

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

type DatasetDeleteResponseFiltersKey

type DatasetDeleteResponseFiltersKey string
const (
	DatasetDeleteResponseFiltersKeyCreatedAt           DatasetDeleteResponseFiltersKey = "created_at"
	DatasetDeleteResponseFiltersKeyRequestContentType  DatasetDeleteResponseFiltersKey = "request_content_type"
	DatasetDeleteResponseFiltersKeyResponseContentType DatasetDeleteResponseFiltersKey = "response_content_type"
	DatasetDeleteResponseFiltersKeySuccess             DatasetDeleteResponseFiltersKey = "success"
	DatasetDeleteResponseFiltersKeyCached              DatasetDeleteResponseFiltersKey = "cached"
	DatasetDeleteResponseFiltersKeyProvider            DatasetDeleteResponseFiltersKey = "provider"
	DatasetDeleteResponseFiltersKeyModel               DatasetDeleteResponseFiltersKey = "model"
	DatasetDeleteResponseFiltersKeyCost                DatasetDeleteResponseFiltersKey = "cost"
	DatasetDeleteResponseFiltersKeyTokens              DatasetDeleteResponseFiltersKey = "tokens"
	DatasetDeleteResponseFiltersKeyTokensIn            DatasetDeleteResponseFiltersKey = "tokens_in"
	DatasetDeleteResponseFiltersKeyTokensOut           DatasetDeleteResponseFiltersKey = "tokens_out"
	DatasetDeleteResponseFiltersKeyDuration            DatasetDeleteResponseFiltersKey = "duration"
	DatasetDeleteResponseFiltersKeyFeedback            DatasetDeleteResponseFiltersKey = "feedback"
)

func (DatasetDeleteResponseFiltersKey) IsKnown

type DatasetDeleteResponseFiltersOperator

type DatasetDeleteResponseFiltersOperator string
const (
	DatasetDeleteResponseFiltersOperatorEq       DatasetDeleteResponseFiltersOperator = "eq"
	DatasetDeleteResponseFiltersOperatorContains DatasetDeleteResponseFiltersOperator = "contains"
	DatasetDeleteResponseFiltersOperatorLt       DatasetDeleteResponseFiltersOperator = "lt"
	DatasetDeleteResponseFiltersOperatorGt       DatasetDeleteResponseFiltersOperator = "gt"
)

func (DatasetDeleteResponseFiltersOperator) IsKnown

type DatasetDeleteResponseFiltersValueUnion

type DatasetDeleteResponseFiltersValueUnion interface {
	ImplementsDatasetDeleteResponseFiltersValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type DatasetGetParams

type DatasetGetParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type DatasetGetResponse

type DatasetGetResponse struct {
	ID         string                     `json:"id,required"`
	AccountID  string                     `json:"account_id,required"`
	AccountTag string                     `json:"account_tag,required"`
	CreatedAt  time.Time                  `json:"created_at,required" format:"date-time"`
	Enable     bool                       `json:"enable,required"`
	Filters    []DatasetGetResponseFilter `json:"filters,required"`
	// gateway id
	GatewayID  string                 `json:"gateway_id,required"`
	ModifiedAt time.Time              `json:"modified_at,required" format:"date-time"`
	Name       string                 `json:"name,required"`
	JSON       datasetGetResponseJSON `json:"-"`
}

func (*DatasetGetResponse) UnmarshalJSON

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

type DatasetGetResponseEnvelope

type DatasetGetResponseEnvelope struct {
	Result  DatasetGetResponse             `json:"result,required"`
	Success bool                           `json:"success,required"`
	JSON    datasetGetResponseEnvelopeJSON `json:"-"`
}

func (*DatasetGetResponseEnvelope) UnmarshalJSON

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

type DatasetGetResponseFilter

type DatasetGetResponseFilter struct {
	Key      DatasetGetResponseFiltersKey          `json:"key,required"`
	Operator DatasetGetResponseFiltersOperator     `json:"operator,required"`
	Value    []DatasetGetResponseFiltersValueUnion `json:"value,required"`
	JSON     datasetGetResponseFilterJSON          `json:"-"`
}

func (*DatasetGetResponseFilter) UnmarshalJSON

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

type DatasetGetResponseFiltersKey

type DatasetGetResponseFiltersKey string
const (
	DatasetGetResponseFiltersKeyCreatedAt           DatasetGetResponseFiltersKey = "created_at"
	DatasetGetResponseFiltersKeyRequestContentType  DatasetGetResponseFiltersKey = "request_content_type"
	DatasetGetResponseFiltersKeyResponseContentType DatasetGetResponseFiltersKey = "response_content_type"
	DatasetGetResponseFiltersKeySuccess             DatasetGetResponseFiltersKey = "success"
	DatasetGetResponseFiltersKeyCached              DatasetGetResponseFiltersKey = "cached"
	DatasetGetResponseFiltersKeyProvider            DatasetGetResponseFiltersKey = "provider"
	DatasetGetResponseFiltersKeyModel               DatasetGetResponseFiltersKey = "model"
	DatasetGetResponseFiltersKeyCost                DatasetGetResponseFiltersKey = "cost"
	DatasetGetResponseFiltersKeyTokens              DatasetGetResponseFiltersKey = "tokens"
	DatasetGetResponseFiltersKeyTokensIn            DatasetGetResponseFiltersKey = "tokens_in"
	DatasetGetResponseFiltersKeyTokensOut           DatasetGetResponseFiltersKey = "tokens_out"
	DatasetGetResponseFiltersKeyDuration            DatasetGetResponseFiltersKey = "duration"
	DatasetGetResponseFiltersKeyFeedback            DatasetGetResponseFiltersKey = "feedback"
)

func (DatasetGetResponseFiltersKey) IsKnown

func (r DatasetGetResponseFiltersKey) IsKnown() bool

type DatasetGetResponseFiltersOperator

type DatasetGetResponseFiltersOperator string
const (
	DatasetGetResponseFiltersOperatorEq       DatasetGetResponseFiltersOperator = "eq"
	DatasetGetResponseFiltersOperatorContains DatasetGetResponseFiltersOperator = "contains"
	DatasetGetResponseFiltersOperatorLt       DatasetGetResponseFiltersOperator = "lt"
	DatasetGetResponseFiltersOperatorGt       DatasetGetResponseFiltersOperator = "gt"
)

func (DatasetGetResponseFiltersOperator) IsKnown

type DatasetGetResponseFiltersValueUnion

type DatasetGetResponseFiltersValueUnion interface {
	ImplementsDatasetGetResponseFiltersValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type DatasetListParams

type DatasetListParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	Enable    param.Field[bool]   `query:"enable"`
	Name      param.Field[string] `query:"name"`
	Page      param.Field[int64]  `query:"page"`
	PerPage   param.Field[int64]  `query:"per_page"`
	// Search by id, name, filters
	Search param.Field[string] `query:"search"`
}

func (DatasetListParams) URLQuery

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

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

type DatasetListResponse

type DatasetListResponse struct {
	ID         string                      `json:"id,required"`
	AccountID  string                      `json:"account_id,required"`
	AccountTag string                      `json:"account_tag,required"`
	CreatedAt  time.Time                   `json:"created_at,required" format:"date-time"`
	Enable     bool                        `json:"enable,required"`
	Filters    []DatasetListResponseFilter `json:"filters,required"`
	// gateway id
	GatewayID  string                  `json:"gateway_id,required"`
	ModifiedAt time.Time               `json:"modified_at,required" format:"date-time"`
	Name       string                  `json:"name,required"`
	JSON       datasetListResponseJSON `json:"-"`
}

func (*DatasetListResponse) UnmarshalJSON

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

type DatasetListResponseFilter

type DatasetListResponseFilter struct {
	Key      DatasetListResponseFiltersKey          `json:"key,required"`
	Operator DatasetListResponseFiltersOperator     `json:"operator,required"`
	Value    []DatasetListResponseFiltersValueUnion `json:"value,required"`
	JSON     datasetListResponseFilterJSON          `json:"-"`
}

func (*DatasetListResponseFilter) UnmarshalJSON

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

type DatasetListResponseFiltersKey

type DatasetListResponseFiltersKey string
const (
	DatasetListResponseFiltersKeyCreatedAt           DatasetListResponseFiltersKey = "created_at"
	DatasetListResponseFiltersKeyRequestContentType  DatasetListResponseFiltersKey = "request_content_type"
	DatasetListResponseFiltersKeyResponseContentType DatasetListResponseFiltersKey = "response_content_type"
	DatasetListResponseFiltersKeySuccess             DatasetListResponseFiltersKey = "success"
	DatasetListResponseFiltersKeyCached              DatasetListResponseFiltersKey = "cached"
	DatasetListResponseFiltersKeyProvider            DatasetListResponseFiltersKey = "provider"
	DatasetListResponseFiltersKeyModel               DatasetListResponseFiltersKey = "model"
	DatasetListResponseFiltersKeyCost                DatasetListResponseFiltersKey = "cost"
	DatasetListResponseFiltersKeyTokens              DatasetListResponseFiltersKey = "tokens"
	DatasetListResponseFiltersKeyTokensIn            DatasetListResponseFiltersKey = "tokens_in"
	DatasetListResponseFiltersKeyTokensOut           DatasetListResponseFiltersKey = "tokens_out"
	DatasetListResponseFiltersKeyDuration            DatasetListResponseFiltersKey = "duration"
	DatasetListResponseFiltersKeyFeedback            DatasetListResponseFiltersKey = "feedback"
)

func (DatasetListResponseFiltersKey) IsKnown

func (r DatasetListResponseFiltersKey) IsKnown() bool

type DatasetListResponseFiltersOperator

type DatasetListResponseFiltersOperator string
const (
	DatasetListResponseFiltersOperatorEq       DatasetListResponseFiltersOperator = "eq"
	DatasetListResponseFiltersOperatorContains DatasetListResponseFiltersOperator = "contains"
	DatasetListResponseFiltersOperatorLt       DatasetListResponseFiltersOperator = "lt"
	DatasetListResponseFiltersOperatorGt       DatasetListResponseFiltersOperator = "gt"
)

func (DatasetListResponseFiltersOperator) IsKnown

type DatasetListResponseFiltersValueUnion

type DatasetListResponseFiltersValueUnion interface {
	ImplementsDatasetListResponseFiltersValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type DatasetNewParams

type DatasetNewParams struct {
	AccountID param.Field[string]                   `path:"account_id,required"`
	Enable    param.Field[bool]                     `json:"enable,required"`
	Filters   param.Field[[]DatasetNewParamsFilter] `json:"filters,required"`
	Name      param.Field[string]                   `json:"name,required"`
}

func (DatasetNewParams) MarshalJSON

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

type DatasetNewParamsFilter

type DatasetNewParamsFilter struct {
	Key      param.Field[DatasetNewParamsFiltersKey]          `json:"key,required"`
	Operator param.Field[DatasetNewParamsFiltersOperator]     `json:"operator,required"`
	Value    param.Field[[]DatasetNewParamsFiltersValueUnion] `json:"value,required"`
}

func (DatasetNewParamsFilter) MarshalJSON

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

type DatasetNewParamsFiltersKey

type DatasetNewParamsFiltersKey string
const (
	DatasetNewParamsFiltersKeyCreatedAt           DatasetNewParamsFiltersKey = "created_at"
	DatasetNewParamsFiltersKeyRequestContentType  DatasetNewParamsFiltersKey = "request_content_type"
	DatasetNewParamsFiltersKeyResponseContentType DatasetNewParamsFiltersKey = "response_content_type"
	DatasetNewParamsFiltersKeySuccess             DatasetNewParamsFiltersKey = "success"
	DatasetNewParamsFiltersKeyCached              DatasetNewParamsFiltersKey = "cached"
	DatasetNewParamsFiltersKeyProvider            DatasetNewParamsFiltersKey = "provider"
	DatasetNewParamsFiltersKeyModel               DatasetNewParamsFiltersKey = "model"
	DatasetNewParamsFiltersKeyCost                DatasetNewParamsFiltersKey = "cost"
	DatasetNewParamsFiltersKeyTokens              DatasetNewParamsFiltersKey = "tokens"
	DatasetNewParamsFiltersKeyTokensIn            DatasetNewParamsFiltersKey = "tokens_in"
	DatasetNewParamsFiltersKeyTokensOut           DatasetNewParamsFiltersKey = "tokens_out"
	DatasetNewParamsFiltersKeyDuration            DatasetNewParamsFiltersKey = "duration"
	DatasetNewParamsFiltersKeyFeedback            DatasetNewParamsFiltersKey = "feedback"
)

func (DatasetNewParamsFiltersKey) IsKnown

func (r DatasetNewParamsFiltersKey) IsKnown() bool

type DatasetNewParamsFiltersOperator

type DatasetNewParamsFiltersOperator string
const (
	DatasetNewParamsFiltersOperatorEq       DatasetNewParamsFiltersOperator = "eq"
	DatasetNewParamsFiltersOperatorContains DatasetNewParamsFiltersOperator = "contains"
	DatasetNewParamsFiltersOperatorLt       DatasetNewParamsFiltersOperator = "lt"
	DatasetNewParamsFiltersOperatorGt       DatasetNewParamsFiltersOperator = "gt"
)

func (DatasetNewParamsFiltersOperator) IsKnown

type DatasetNewParamsFiltersValueUnion

type DatasetNewParamsFiltersValueUnion interface {
	ImplementsDatasetNewParamsFiltersValueUnion()
}

Satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool.

type DatasetNewResponse

type DatasetNewResponse struct {
	ID         string                     `json:"id,required"`
	AccountID  string                     `json:"account_id,required"`
	AccountTag string                     `json:"account_tag,required"`
	CreatedAt  time.Time                  `json:"created_at,required" format:"date-time"`
	Enable     bool                       `json:"enable,required"`
	Filters    []DatasetNewResponseFilter `json:"filters,required"`
	// gateway id
	GatewayID  string                 `json:"gateway_id,required"`
	ModifiedAt time.Time              `json:"modified_at,required" format:"date-time"`
	Name       string                 `json:"name,required"`
	JSON       datasetNewResponseJSON `json:"-"`
}

func (*DatasetNewResponse) UnmarshalJSON

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

type DatasetNewResponseEnvelope

type DatasetNewResponseEnvelope struct {
	Result  DatasetNewResponse             `json:"result,required"`
	Success bool                           `json:"success,required"`
	JSON    datasetNewResponseEnvelopeJSON `json:"-"`
}

func (*DatasetNewResponseEnvelope) UnmarshalJSON

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

type DatasetNewResponseFilter

type DatasetNewResponseFilter struct {
	Key      DatasetNewResponseFiltersKey          `json:"key,required"`
	Operator DatasetNewResponseFiltersOperator     `json:"operator,required"`
	Value    []DatasetNewResponseFiltersValueUnion `json:"value,required"`
	JSON     datasetNewResponseFilterJSON          `json:"-"`
}

func (*DatasetNewResponseFilter) UnmarshalJSON

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

type DatasetNewResponseFiltersKey

type DatasetNewResponseFiltersKey string
const (
	DatasetNewResponseFiltersKeyCreatedAt           DatasetNewResponseFiltersKey = "created_at"
	DatasetNewResponseFiltersKeyRequestContentType  DatasetNewResponseFiltersKey = "request_content_type"
	DatasetNewResponseFiltersKeyResponseContentType DatasetNewResponseFiltersKey = "response_content_type"
	DatasetNewResponseFiltersKeySuccess             DatasetNewResponseFiltersKey = "success"
	DatasetNewResponseFiltersKeyCached              DatasetNewResponseFiltersKey = "cached"
	DatasetNewResponseFiltersKeyProvider            DatasetNewResponseFiltersKey = "provider"
	DatasetNewResponseFiltersKeyModel               DatasetNewResponseFiltersKey = "model"
	DatasetNewResponseFiltersKeyCost                DatasetNewResponseFiltersKey = "cost"
	DatasetNewResponseFiltersKeyTokens              DatasetNewResponseFiltersKey = "tokens"
	DatasetNewResponseFiltersKeyTokensIn            DatasetNewResponseFiltersKey = "tokens_in"
	DatasetNewResponseFiltersKeyTokensOut           DatasetNewResponseFiltersKey = "tokens_out"
	DatasetNewResponseFiltersKeyDuration            DatasetNewResponseFiltersKey = "duration"
	DatasetNewResponseFiltersKeyFeedback            DatasetNewResponseFiltersKey = "feedback"
)

func (DatasetNewResponseFiltersKey) IsKnown

func (r DatasetNewResponseFiltersKey) IsKnown() bool

type DatasetNewResponseFiltersOperator

type DatasetNewResponseFiltersOperator string
const (
	DatasetNewResponseFiltersOperatorEq       DatasetNewResponseFiltersOperator = "eq"
	DatasetNewResponseFiltersOperatorContains DatasetNewResponseFiltersOperator = "contains"
	DatasetNewResponseFiltersOperatorLt       DatasetNewResponseFiltersOperator = "lt"
	DatasetNewResponseFiltersOperatorGt       DatasetNewResponseFiltersOperator = "gt"
)

func (DatasetNewResponseFiltersOperator) IsKnown

type DatasetNewResponseFiltersValueUnion

type DatasetNewResponseFiltersValueUnion interface {
	ImplementsDatasetNewResponseFiltersValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type DatasetService

type DatasetService struct {
	Options []option.RequestOption
}

DatasetService 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 NewDatasetService method instead.

func NewDatasetService

func NewDatasetService(opts ...option.RequestOption) (r *DatasetService)

NewDatasetService 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 (*DatasetService) Delete

func (r *DatasetService) Delete(ctx context.Context, gatewayID string, id string, body DatasetDeleteParams, opts ...option.RequestOption) (res *DatasetDeleteResponse, err error)

Delete a Dataset

func (*DatasetService) Get

func (r *DatasetService) Get(ctx context.Context, gatewayID string, id string, query DatasetGetParams, opts ...option.RequestOption) (res *DatasetGetResponse, err error)

Fetch a Dataset

func (*DatasetService) List

List Datasets

func (*DatasetService) ListAutoPaging

List Datasets

func (*DatasetService) New

func (r *DatasetService) New(ctx context.Context, gatewayID string, params DatasetNewParams, opts ...option.RequestOption) (res *DatasetNewResponse, err error)

Create a new Dataset

func (*DatasetService) Update

func (r *DatasetService) Update(ctx context.Context, gatewayID string, id string, params DatasetUpdateParams, opts ...option.RequestOption) (res *DatasetUpdateResponse, err error)

Update a Dataset

type DatasetUpdateParams

type DatasetUpdateParams struct {
	AccountID param.Field[string]                      `path:"account_id,required"`
	Enable    param.Field[bool]                        `json:"enable,required"`
	Filters   param.Field[[]DatasetUpdateParamsFilter] `json:"filters,required"`
	Name      param.Field[string]                      `json:"name,required"`
}

func (DatasetUpdateParams) MarshalJSON

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

type DatasetUpdateParamsFilter

type DatasetUpdateParamsFilter struct {
	Key      param.Field[DatasetUpdateParamsFiltersKey]          `json:"key,required"`
	Operator param.Field[DatasetUpdateParamsFiltersOperator]     `json:"operator,required"`
	Value    param.Field[[]DatasetUpdateParamsFiltersValueUnion] `json:"value,required"`
}

func (DatasetUpdateParamsFilter) MarshalJSON

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

type DatasetUpdateParamsFiltersKey

type DatasetUpdateParamsFiltersKey string
const (
	DatasetUpdateParamsFiltersKeyCreatedAt           DatasetUpdateParamsFiltersKey = "created_at"
	DatasetUpdateParamsFiltersKeyRequestContentType  DatasetUpdateParamsFiltersKey = "request_content_type"
	DatasetUpdateParamsFiltersKeyResponseContentType DatasetUpdateParamsFiltersKey = "response_content_type"
	DatasetUpdateParamsFiltersKeySuccess             DatasetUpdateParamsFiltersKey = "success"
	DatasetUpdateParamsFiltersKeyCached              DatasetUpdateParamsFiltersKey = "cached"
	DatasetUpdateParamsFiltersKeyProvider            DatasetUpdateParamsFiltersKey = "provider"
	DatasetUpdateParamsFiltersKeyModel               DatasetUpdateParamsFiltersKey = "model"
	DatasetUpdateParamsFiltersKeyCost                DatasetUpdateParamsFiltersKey = "cost"
	DatasetUpdateParamsFiltersKeyTokens              DatasetUpdateParamsFiltersKey = "tokens"
	DatasetUpdateParamsFiltersKeyTokensIn            DatasetUpdateParamsFiltersKey = "tokens_in"
	DatasetUpdateParamsFiltersKeyTokensOut           DatasetUpdateParamsFiltersKey = "tokens_out"
	DatasetUpdateParamsFiltersKeyDuration            DatasetUpdateParamsFiltersKey = "duration"
	DatasetUpdateParamsFiltersKeyFeedback            DatasetUpdateParamsFiltersKey = "feedback"
)

func (DatasetUpdateParamsFiltersKey) IsKnown

func (r DatasetUpdateParamsFiltersKey) IsKnown() bool

type DatasetUpdateParamsFiltersOperator

type DatasetUpdateParamsFiltersOperator string
const (
	DatasetUpdateParamsFiltersOperatorEq       DatasetUpdateParamsFiltersOperator = "eq"
	DatasetUpdateParamsFiltersOperatorContains DatasetUpdateParamsFiltersOperator = "contains"
	DatasetUpdateParamsFiltersOperatorLt       DatasetUpdateParamsFiltersOperator = "lt"
	DatasetUpdateParamsFiltersOperatorGt       DatasetUpdateParamsFiltersOperator = "gt"
)

func (DatasetUpdateParamsFiltersOperator) IsKnown

type DatasetUpdateParamsFiltersValueUnion

type DatasetUpdateParamsFiltersValueUnion interface {
	ImplementsDatasetUpdateParamsFiltersValueUnion()
}

Satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool.

type DatasetUpdateResponse

type DatasetUpdateResponse struct {
	ID         string                        `json:"id,required"`
	AccountID  string                        `json:"account_id,required"`
	AccountTag string                        `json:"account_tag,required"`
	CreatedAt  time.Time                     `json:"created_at,required" format:"date-time"`
	Enable     bool                          `json:"enable,required"`
	Filters    []DatasetUpdateResponseFilter `json:"filters,required"`
	// gateway id
	GatewayID  string                    `json:"gateway_id,required"`
	ModifiedAt time.Time                 `json:"modified_at,required" format:"date-time"`
	Name       string                    `json:"name,required"`
	JSON       datasetUpdateResponseJSON `json:"-"`
}

func (*DatasetUpdateResponse) UnmarshalJSON

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

type DatasetUpdateResponseEnvelope

type DatasetUpdateResponseEnvelope struct {
	Result  DatasetUpdateResponse             `json:"result,required"`
	Success bool                              `json:"success,required"`
	JSON    datasetUpdateResponseEnvelopeJSON `json:"-"`
}

func (*DatasetUpdateResponseEnvelope) UnmarshalJSON

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

type DatasetUpdateResponseFilter

type DatasetUpdateResponseFilter struct {
	Key      DatasetUpdateResponseFiltersKey          `json:"key,required"`
	Operator DatasetUpdateResponseFiltersOperator     `json:"operator,required"`
	Value    []DatasetUpdateResponseFiltersValueUnion `json:"value,required"`
	JSON     datasetUpdateResponseFilterJSON          `json:"-"`
}

func (*DatasetUpdateResponseFilter) UnmarshalJSON

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

type DatasetUpdateResponseFiltersKey

type DatasetUpdateResponseFiltersKey string
const (
	DatasetUpdateResponseFiltersKeyCreatedAt           DatasetUpdateResponseFiltersKey = "created_at"
	DatasetUpdateResponseFiltersKeyRequestContentType  DatasetUpdateResponseFiltersKey = "request_content_type"
	DatasetUpdateResponseFiltersKeyResponseContentType DatasetUpdateResponseFiltersKey = "response_content_type"
	DatasetUpdateResponseFiltersKeySuccess             DatasetUpdateResponseFiltersKey = "success"
	DatasetUpdateResponseFiltersKeyCached              DatasetUpdateResponseFiltersKey = "cached"
	DatasetUpdateResponseFiltersKeyProvider            DatasetUpdateResponseFiltersKey = "provider"
	DatasetUpdateResponseFiltersKeyModel               DatasetUpdateResponseFiltersKey = "model"
	DatasetUpdateResponseFiltersKeyCost                DatasetUpdateResponseFiltersKey = "cost"
	DatasetUpdateResponseFiltersKeyTokens              DatasetUpdateResponseFiltersKey = "tokens"
	DatasetUpdateResponseFiltersKeyTokensIn            DatasetUpdateResponseFiltersKey = "tokens_in"
	DatasetUpdateResponseFiltersKeyTokensOut           DatasetUpdateResponseFiltersKey = "tokens_out"
	DatasetUpdateResponseFiltersKeyDuration            DatasetUpdateResponseFiltersKey = "duration"
	DatasetUpdateResponseFiltersKeyFeedback            DatasetUpdateResponseFiltersKey = "feedback"
)

func (DatasetUpdateResponseFiltersKey) IsKnown

type DatasetUpdateResponseFiltersOperator

type DatasetUpdateResponseFiltersOperator string
const (
	DatasetUpdateResponseFiltersOperatorEq       DatasetUpdateResponseFiltersOperator = "eq"
	DatasetUpdateResponseFiltersOperatorContains DatasetUpdateResponseFiltersOperator = "contains"
	DatasetUpdateResponseFiltersOperatorLt       DatasetUpdateResponseFiltersOperator = "lt"
	DatasetUpdateResponseFiltersOperatorGt       DatasetUpdateResponseFiltersOperator = "gt"
)

func (DatasetUpdateResponseFiltersOperator) IsKnown

type DatasetUpdateResponseFiltersValueUnion

type DatasetUpdateResponseFiltersValueUnion interface {
	ImplementsDatasetUpdateResponseFiltersValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource added in v4.2.0

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type EvaluationDeleteParams

type EvaluationDeleteParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type EvaluationDeleteResponse

type EvaluationDeleteResponse struct {
	ID         string                            `json:"id,required"`
	AccountID  string                            `json:"account_id,required"`
	AccountTag string                            `json:"account_tag,required"`
	CreatedAt  time.Time                         `json:"created_at,required" format:"date-time"`
	Datasets   []EvaluationDeleteResponseDataset `json:"datasets,required"`
	// gateway id
	GatewayID  string                           `json:"gateway_id,required"`
	ModifiedAt time.Time                        `json:"modified_at,required" format:"date-time"`
	Name       string                           `json:"name,required"`
	Processed  bool                             `json:"processed,required"`
	Results    []EvaluationDeleteResponseResult `json:"results,required"`
	TotalLogs  float64                          `json:"total_logs,required"`
	JSON       evaluationDeleteResponseJSON     `json:"-"`
}

func (*EvaluationDeleteResponse) UnmarshalJSON

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

type EvaluationDeleteResponseDataset

type EvaluationDeleteResponseDataset struct {
	ID         string                                   `json:"id,required"`
	AccountID  string                                   `json:"account_id,required"`
	AccountTag string                                   `json:"account_tag,required"`
	CreatedAt  time.Time                                `json:"created_at,required" format:"date-time"`
	Enable     bool                                     `json:"enable,required"`
	Filters    []EvaluationDeleteResponseDatasetsFilter `json:"filters,required"`
	// gateway id
	GatewayID  string                              `json:"gateway_id,required"`
	ModifiedAt time.Time                           `json:"modified_at,required" format:"date-time"`
	Name       string                              `json:"name,required"`
	JSON       evaluationDeleteResponseDatasetJSON `json:"-"`
}

func (*EvaluationDeleteResponseDataset) UnmarshalJSON

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

type EvaluationDeleteResponseDatasetsFilter

type EvaluationDeleteResponseDatasetsFilter struct {
	Key      EvaluationDeleteResponseDatasetsFiltersKey          `json:"key,required"`
	Operator EvaluationDeleteResponseDatasetsFiltersOperator     `json:"operator,required"`
	Value    []EvaluationDeleteResponseDatasetsFiltersValueUnion `json:"value,required"`
	JSON     evaluationDeleteResponseDatasetsFilterJSON          `json:"-"`
}

func (*EvaluationDeleteResponseDatasetsFilter) UnmarshalJSON

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

type EvaluationDeleteResponseDatasetsFiltersKey

type EvaluationDeleteResponseDatasetsFiltersKey string
const (
	EvaluationDeleteResponseDatasetsFiltersKeyCreatedAt           EvaluationDeleteResponseDatasetsFiltersKey = "created_at"
	EvaluationDeleteResponseDatasetsFiltersKeyRequestContentType  EvaluationDeleteResponseDatasetsFiltersKey = "request_content_type"
	EvaluationDeleteResponseDatasetsFiltersKeyResponseContentType EvaluationDeleteResponseDatasetsFiltersKey = "response_content_type"
	EvaluationDeleteResponseDatasetsFiltersKeySuccess             EvaluationDeleteResponseDatasetsFiltersKey = "success"
	EvaluationDeleteResponseDatasetsFiltersKeyCached              EvaluationDeleteResponseDatasetsFiltersKey = "cached"
	EvaluationDeleteResponseDatasetsFiltersKeyProvider            EvaluationDeleteResponseDatasetsFiltersKey = "provider"
	EvaluationDeleteResponseDatasetsFiltersKeyModel               EvaluationDeleteResponseDatasetsFiltersKey = "model"
	EvaluationDeleteResponseDatasetsFiltersKeyCost                EvaluationDeleteResponseDatasetsFiltersKey = "cost"
	EvaluationDeleteResponseDatasetsFiltersKeyTokens              EvaluationDeleteResponseDatasetsFiltersKey = "tokens"
	EvaluationDeleteResponseDatasetsFiltersKeyTokensIn            EvaluationDeleteResponseDatasetsFiltersKey = "tokens_in"
	EvaluationDeleteResponseDatasetsFiltersKeyTokensOut           EvaluationDeleteResponseDatasetsFiltersKey = "tokens_out"
	EvaluationDeleteResponseDatasetsFiltersKeyDuration            EvaluationDeleteResponseDatasetsFiltersKey = "duration"
	EvaluationDeleteResponseDatasetsFiltersKeyFeedback            EvaluationDeleteResponseDatasetsFiltersKey = "feedback"
)

func (EvaluationDeleteResponseDatasetsFiltersKey) IsKnown

type EvaluationDeleteResponseDatasetsFiltersOperator

type EvaluationDeleteResponseDatasetsFiltersOperator string
const (
	EvaluationDeleteResponseDatasetsFiltersOperatorEq       EvaluationDeleteResponseDatasetsFiltersOperator = "eq"
	EvaluationDeleteResponseDatasetsFiltersOperatorContains EvaluationDeleteResponseDatasetsFiltersOperator = "contains"
	EvaluationDeleteResponseDatasetsFiltersOperatorLt       EvaluationDeleteResponseDatasetsFiltersOperator = "lt"
	EvaluationDeleteResponseDatasetsFiltersOperatorGt       EvaluationDeleteResponseDatasetsFiltersOperator = "gt"
)

func (EvaluationDeleteResponseDatasetsFiltersOperator) IsKnown

type EvaluationDeleteResponseDatasetsFiltersValueUnion

type EvaluationDeleteResponseDatasetsFiltersValueUnion interface {
	ImplementsEvaluationDeleteResponseDatasetsFiltersValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type EvaluationDeleteResponseEnvelope

type EvaluationDeleteResponseEnvelope struct {
	Result  EvaluationDeleteResponse             `json:"result,required"`
	Success bool                                 `json:"success,required"`
	JSON    evaluationDeleteResponseEnvelopeJSON `json:"-"`
}

func (*EvaluationDeleteResponseEnvelope) UnmarshalJSON

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

type EvaluationDeleteResponseResult

type EvaluationDeleteResponseResult struct {
	ID                string                             `json:"id,required"`
	CreatedAt         time.Time                          `json:"created_at,required" format:"date-time"`
	EvaluationID      string                             `json:"evaluation_id,required"`
	EvaluationTypeID  string                             `json:"evaluation_type_id,required"`
	ModifiedAt        time.Time                          `json:"modified_at,required" format:"date-time"`
	Result            string                             `json:"result,required"`
	Status            float64                            `json:"status,required"`
	StatusDescription string                             `json:"status_description,required"`
	TotalLogs         float64                            `json:"total_logs,required"`
	JSON              evaluationDeleteResponseResultJSON `json:"-"`
}

func (*EvaluationDeleteResponseResult) UnmarshalJSON

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

type EvaluationGetParams

type EvaluationGetParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type EvaluationGetResponse

type EvaluationGetResponse struct {
	ID         string                         `json:"id,required"`
	AccountID  string                         `json:"account_id,required"`
	AccountTag string                         `json:"account_tag,required"`
	CreatedAt  time.Time                      `json:"created_at,required" format:"date-time"`
	Datasets   []EvaluationGetResponseDataset `json:"datasets,required"`
	// gateway id
	GatewayID  string                        `json:"gateway_id,required"`
	ModifiedAt time.Time                     `json:"modified_at,required" format:"date-time"`
	Name       string                        `json:"name,required"`
	Processed  bool                          `json:"processed,required"`
	Results    []EvaluationGetResponseResult `json:"results,required"`
	TotalLogs  float64                       `json:"total_logs,required"`
	JSON       evaluationGetResponseJSON     `json:"-"`
}

func (*EvaluationGetResponse) UnmarshalJSON

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

type EvaluationGetResponseDataset

type EvaluationGetResponseDataset struct {
	ID         string                                `json:"id,required"`
	AccountID  string                                `json:"account_id,required"`
	AccountTag string                                `json:"account_tag,required"`
	CreatedAt  time.Time                             `json:"created_at,required" format:"date-time"`
	Enable     bool                                  `json:"enable,required"`
	Filters    []EvaluationGetResponseDatasetsFilter `json:"filters,required"`
	// gateway id
	GatewayID  string                           `json:"gateway_id,required"`
	ModifiedAt time.Time                        `json:"modified_at,required" format:"date-time"`
	Name       string                           `json:"name,required"`
	JSON       evaluationGetResponseDatasetJSON `json:"-"`
}

func (*EvaluationGetResponseDataset) UnmarshalJSON

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

type EvaluationGetResponseDatasetsFilter

type EvaluationGetResponseDatasetsFilter struct {
	Key      EvaluationGetResponseDatasetsFiltersKey          `json:"key,required"`
	Operator EvaluationGetResponseDatasetsFiltersOperator     `json:"operator,required"`
	Value    []EvaluationGetResponseDatasetsFiltersValueUnion `json:"value,required"`
	JSON     evaluationGetResponseDatasetsFilterJSON          `json:"-"`
}

func (*EvaluationGetResponseDatasetsFilter) UnmarshalJSON

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

type EvaluationGetResponseDatasetsFiltersKey

type EvaluationGetResponseDatasetsFiltersKey string
const (
	EvaluationGetResponseDatasetsFiltersKeyCreatedAt           EvaluationGetResponseDatasetsFiltersKey = "created_at"
	EvaluationGetResponseDatasetsFiltersKeyRequestContentType  EvaluationGetResponseDatasetsFiltersKey = "request_content_type"
	EvaluationGetResponseDatasetsFiltersKeyResponseContentType EvaluationGetResponseDatasetsFiltersKey = "response_content_type"
	EvaluationGetResponseDatasetsFiltersKeySuccess             EvaluationGetResponseDatasetsFiltersKey = "success"
	EvaluationGetResponseDatasetsFiltersKeyCached              EvaluationGetResponseDatasetsFiltersKey = "cached"
	EvaluationGetResponseDatasetsFiltersKeyProvider            EvaluationGetResponseDatasetsFiltersKey = "provider"
	EvaluationGetResponseDatasetsFiltersKeyModel               EvaluationGetResponseDatasetsFiltersKey = "model"
	EvaluationGetResponseDatasetsFiltersKeyCost                EvaluationGetResponseDatasetsFiltersKey = "cost"
	EvaluationGetResponseDatasetsFiltersKeyTokens              EvaluationGetResponseDatasetsFiltersKey = "tokens"
	EvaluationGetResponseDatasetsFiltersKeyTokensIn            EvaluationGetResponseDatasetsFiltersKey = "tokens_in"
	EvaluationGetResponseDatasetsFiltersKeyTokensOut           EvaluationGetResponseDatasetsFiltersKey = "tokens_out"
	EvaluationGetResponseDatasetsFiltersKeyDuration            EvaluationGetResponseDatasetsFiltersKey = "duration"
	EvaluationGetResponseDatasetsFiltersKeyFeedback            EvaluationGetResponseDatasetsFiltersKey = "feedback"
)

func (EvaluationGetResponseDatasetsFiltersKey) IsKnown

type EvaluationGetResponseDatasetsFiltersOperator

type EvaluationGetResponseDatasetsFiltersOperator string
const (
	EvaluationGetResponseDatasetsFiltersOperatorEq       EvaluationGetResponseDatasetsFiltersOperator = "eq"
	EvaluationGetResponseDatasetsFiltersOperatorContains EvaluationGetResponseDatasetsFiltersOperator = "contains"
	EvaluationGetResponseDatasetsFiltersOperatorLt       EvaluationGetResponseDatasetsFiltersOperator = "lt"
	EvaluationGetResponseDatasetsFiltersOperatorGt       EvaluationGetResponseDatasetsFiltersOperator = "gt"
)

func (EvaluationGetResponseDatasetsFiltersOperator) IsKnown

type EvaluationGetResponseDatasetsFiltersValueUnion

type EvaluationGetResponseDatasetsFiltersValueUnion interface {
	ImplementsEvaluationGetResponseDatasetsFiltersValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type EvaluationGetResponseEnvelope

type EvaluationGetResponseEnvelope struct {
	Result  EvaluationGetResponse             `json:"result,required"`
	Success bool                              `json:"success,required"`
	JSON    evaluationGetResponseEnvelopeJSON `json:"-"`
}

func (*EvaluationGetResponseEnvelope) UnmarshalJSON

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

type EvaluationGetResponseResult

type EvaluationGetResponseResult struct {
	ID                string                          `json:"id,required"`
	CreatedAt         time.Time                       `json:"created_at,required" format:"date-time"`
	EvaluationID      string                          `json:"evaluation_id,required"`
	EvaluationTypeID  string                          `json:"evaluation_type_id,required"`
	ModifiedAt        time.Time                       `json:"modified_at,required" format:"date-time"`
	Result            string                          `json:"result,required"`
	Status            float64                         `json:"status,required"`
	StatusDescription string                          `json:"status_description,required"`
	TotalLogs         float64                         `json:"total_logs,required"`
	JSON              evaluationGetResponseResultJSON `json:"-"`
}

func (*EvaluationGetResponseResult) UnmarshalJSON

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

type EvaluationListParams

type EvaluationListParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	Name      param.Field[string] `query:"name"`
	Page      param.Field[int64]  `query:"page"`
	PerPage   param.Field[int64]  `query:"per_page"`
	Processed param.Field[bool]   `query:"processed"`
	// Search by id, name
	Search param.Field[string] `query:"search"`
}

func (EvaluationListParams) URLQuery

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

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

type EvaluationListResponse

type EvaluationListResponse struct {
	ID         string                          `json:"id,required"`
	AccountID  string                          `json:"account_id,required"`
	AccountTag string                          `json:"account_tag,required"`
	CreatedAt  time.Time                       `json:"created_at,required" format:"date-time"`
	Datasets   []EvaluationListResponseDataset `json:"datasets,required"`
	// gateway id
	GatewayID  string                         `json:"gateway_id,required"`
	ModifiedAt time.Time                      `json:"modified_at,required" format:"date-time"`
	Name       string                         `json:"name,required"`
	Processed  bool                           `json:"processed,required"`
	Results    []EvaluationListResponseResult `json:"results,required"`
	TotalLogs  float64                        `json:"total_logs,required"`
	JSON       evaluationListResponseJSON     `json:"-"`
}

func (*EvaluationListResponse) UnmarshalJSON

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

type EvaluationListResponseDataset

type EvaluationListResponseDataset struct {
	ID         string                                 `json:"id,required"`
	AccountID  string                                 `json:"account_id,required"`
	AccountTag string                                 `json:"account_tag,required"`
	CreatedAt  time.Time                              `json:"created_at,required" format:"date-time"`
	Enable     bool                                   `json:"enable,required"`
	Filters    []EvaluationListResponseDatasetsFilter `json:"filters,required"`
	// gateway id
	GatewayID  string                            `json:"gateway_id,required"`
	ModifiedAt time.Time                         `json:"modified_at,required" format:"date-time"`
	Name       string                            `json:"name,required"`
	JSON       evaluationListResponseDatasetJSON `json:"-"`
}

func (*EvaluationListResponseDataset) UnmarshalJSON

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

type EvaluationListResponseDatasetsFilter

type EvaluationListResponseDatasetsFilter struct {
	Key      EvaluationListResponseDatasetsFiltersKey          `json:"key,required"`
	Operator EvaluationListResponseDatasetsFiltersOperator     `json:"operator,required"`
	Value    []EvaluationListResponseDatasetsFiltersValueUnion `json:"value,required"`
	JSON     evaluationListResponseDatasetsFilterJSON          `json:"-"`
}

func (*EvaluationListResponseDatasetsFilter) UnmarshalJSON

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

type EvaluationListResponseDatasetsFiltersKey

type EvaluationListResponseDatasetsFiltersKey string
const (
	EvaluationListResponseDatasetsFiltersKeyCreatedAt           EvaluationListResponseDatasetsFiltersKey = "created_at"
	EvaluationListResponseDatasetsFiltersKeyRequestContentType  EvaluationListResponseDatasetsFiltersKey = "request_content_type"
	EvaluationListResponseDatasetsFiltersKeyResponseContentType EvaluationListResponseDatasetsFiltersKey = "response_content_type"
	EvaluationListResponseDatasetsFiltersKeySuccess             EvaluationListResponseDatasetsFiltersKey = "success"
	EvaluationListResponseDatasetsFiltersKeyCached              EvaluationListResponseDatasetsFiltersKey = "cached"
	EvaluationListResponseDatasetsFiltersKeyProvider            EvaluationListResponseDatasetsFiltersKey = "provider"
	EvaluationListResponseDatasetsFiltersKeyModel               EvaluationListResponseDatasetsFiltersKey = "model"
	EvaluationListResponseDatasetsFiltersKeyCost                EvaluationListResponseDatasetsFiltersKey = "cost"
	EvaluationListResponseDatasetsFiltersKeyTokens              EvaluationListResponseDatasetsFiltersKey = "tokens"
	EvaluationListResponseDatasetsFiltersKeyTokensIn            EvaluationListResponseDatasetsFiltersKey = "tokens_in"
	EvaluationListResponseDatasetsFiltersKeyTokensOut           EvaluationListResponseDatasetsFiltersKey = "tokens_out"
	EvaluationListResponseDatasetsFiltersKeyDuration            EvaluationListResponseDatasetsFiltersKey = "duration"
	EvaluationListResponseDatasetsFiltersKeyFeedback            EvaluationListResponseDatasetsFiltersKey = "feedback"
)

func (EvaluationListResponseDatasetsFiltersKey) IsKnown

type EvaluationListResponseDatasetsFiltersOperator

type EvaluationListResponseDatasetsFiltersOperator string
const (
	EvaluationListResponseDatasetsFiltersOperatorEq       EvaluationListResponseDatasetsFiltersOperator = "eq"
	EvaluationListResponseDatasetsFiltersOperatorContains EvaluationListResponseDatasetsFiltersOperator = "contains"
	EvaluationListResponseDatasetsFiltersOperatorLt       EvaluationListResponseDatasetsFiltersOperator = "lt"
	EvaluationListResponseDatasetsFiltersOperatorGt       EvaluationListResponseDatasetsFiltersOperator = "gt"
)

func (EvaluationListResponseDatasetsFiltersOperator) IsKnown

type EvaluationListResponseDatasetsFiltersValueUnion

type EvaluationListResponseDatasetsFiltersValueUnion interface {
	ImplementsEvaluationListResponseDatasetsFiltersValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type EvaluationListResponseResult

type EvaluationListResponseResult struct {
	ID                string                           `json:"id,required"`
	CreatedAt         time.Time                        `json:"created_at,required" format:"date-time"`
	EvaluationID      string                           `json:"evaluation_id,required"`
	EvaluationTypeID  string                           `json:"evaluation_type_id,required"`
	ModifiedAt        time.Time                        `json:"modified_at,required" format:"date-time"`
	Result            string                           `json:"result,required"`
	Status            float64                          `json:"status,required"`
	StatusDescription string                           `json:"status_description,required"`
	TotalLogs         float64                          `json:"total_logs,required"`
	JSON              evaluationListResponseResultJSON `json:"-"`
}

func (*EvaluationListResponseResult) UnmarshalJSON

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

type EvaluationNewParams

type EvaluationNewParams struct {
	AccountID         param.Field[string]   `path:"account_id,required"`
	DatasetIDs        param.Field[[]string] `json:"dataset_ids,required"`
	EvaluationTypeIDs param.Field[[]string] `json:"evaluation_type_ids,required"`
	Name              param.Field[string]   `json:"name,required"`
}

func (EvaluationNewParams) MarshalJSON

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

type EvaluationNewResponse

type EvaluationNewResponse struct {
	ID         string                         `json:"id,required"`
	AccountID  string                         `json:"account_id,required"`
	AccountTag string                         `json:"account_tag,required"`
	CreatedAt  time.Time                      `json:"created_at,required" format:"date-time"`
	Datasets   []EvaluationNewResponseDataset `json:"datasets,required"`
	// gateway id
	GatewayID  string                        `json:"gateway_id,required"`
	ModifiedAt time.Time                     `json:"modified_at,required" format:"date-time"`
	Name       string                        `json:"name,required"`
	Processed  bool                          `json:"processed,required"`
	Results    []EvaluationNewResponseResult `json:"results,required"`
	TotalLogs  float64                       `json:"total_logs,required"`
	JSON       evaluationNewResponseJSON     `json:"-"`
}

func (*EvaluationNewResponse) UnmarshalJSON

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

type EvaluationNewResponseDataset

type EvaluationNewResponseDataset struct {
	ID         string                                `json:"id,required"`
	AccountID  string                                `json:"account_id,required"`
	AccountTag string                                `json:"account_tag,required"`
	CreatedAt  time.Time                             `json:"created_at,required" format:"date-time"`
	Enable     bool                                  `json:"enable,required"`
	Filters    []EvaluationNewResponseDatasetsFilter `json:"filters,required"`
	// gateway id
	GatewayID  string                           `json:"gateway_id,required"`
	ModifiedAt time.Time                        `json:"modified_at,required" format:"date-time"`
	Name       string                           `json:"name,required"`
	JSON       evaluationNewResponseDatasetJSON `json:"-"`
}

func (*EvaluationNewResponseDataset) UnmarshalJSON

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

type EvaluationNewResponseDatasetsFilter

type EvaluationNewResponseDatasetsFilter struct {
	Key      EvaluationNewResponseDatasetsFiltersKey          `json:"key,required"`
	Operator EvaluationNewResponseDatasetsFiltersOperator     `json:"operator,required"`
	Value    []EvaluationNewResponseDatasetsFiltersValueUnion `json:"value,required"`
	JSON     evaluationNewResponseDatasetsFilterJSON          `json:"-"`
}

func (*EvaluationNewResponseDatasetsFilter) UnmarshalJSON

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

type EvaluationNewResponseDatasetsFiltersKey

type EvaluationNewResponseDatasetsFiltersKey string
const (
	EvaluationNewResponseDatasetsFiltersKeyCreatedAt           EvaluationNewResponseDatasetsFiltersKey = "created_at"
	EvaluationNewResponseDatasetsFiltersKeyRequestContentType  EvaluationNewResponseDatasetsFiltersKey = "request_content_type"
	EvaluationNewResponseDatasetsFiltersKeyResponseContentType EvaluationNewResponseDatasetsFiltersKey = "response_content_type"
	EvaluationNewResponseDatasetsFiltersKeySuccess             EvaluationNewResponseDatasetsFiltersKey = "success"
	EvaluationNewResponseDatasetsFiltersKeyCached              EvaluationNewResponseDatasetsFiltersKey = "cached"
	EvaluationNewResponseDatasetsFiltersKeyProvider            EvaluationNewResponseDatasetsFiltersKey = "provider"
	EvaluationNewResponseDatasetsFiltersKeyModel               EvaluationNewResponseDatasetsFiltersKey = "model"
	EvaluationNewResponseDatasetsFiltersKeyCost                EvaluationNewResponseDatasetsFiltersKey = "cost"
	EvaluationNewResponseDatasetsFiltersKeyTokens              EvaluationNewResponseDatasetsFiltersKey = "tokens"
	EvaluationNewResponseDatasetsFiltersKeyTokensIn            EvaluationNewResponseDatasetsFiltersKey = "tokens_in"
	EvaluationNewResponseDatasetsFiltersKeyTokensOut           EvaluationNewResponseDatasetsFiltersKey = "tokens_out"
	EvaluationNewResponseDatasetsFiltersKeyDuration            EvaluationNewResponseDatasetsFiltersKey = "duration"
	EvaluationNewResponseDatasetsFiltersKeyFeedback            EvaluationNewResponseDatasetsFiltersKey = "feedback"
)

func (EvaluationNewResponseDatasetsFiltersKey) IsKnown

type EvaluationNewResponseDatasetsFiltersOperator

type EvaluationNewResponseDatasetsFiltersOperator string
const (
	EvaluationNewResponseDatasetsFiltersOperatorEq       EvaluationNewResponseDatasetsFiltersOperator = "eq"
	EvaluationNewResponseDatasetsFiltersOperatorContains EvaluationNewResponseDatasetsFiltersOperator = "contains"
	EvaluationNewResponseDatasetsFiltersOperatorLt       EvaluationNewResponseDatasetsFiltersOperator = "lt"
	EvaluationNewResponseDatasetsFiltersOperatorGt       EvaluationNewResponseDatasetsFiltersOperator = "gt"
)

func (EvaluationNewResponseDatasetsFiltersOperator) IsKnown

type EvaluationNewResponseDatasetsFiltersValueUnion

type EvaluationNewResponseDatasetsFiltersValueUnion interface {
	ImplementsEvaluationNewResponseDatasetsFiltersValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type EvaluationNewResponseEnvelope

type EvaluationNewResponseEnvelope struct {
	Result  EvaluationNewResponse             `json:"result,required"`
	Success bool                              `json:"success,required"`
	JSON    evaluationNewResponseEnvelopeJSON `json:"-"`
}

func (*EvaluationNewResponseEnvelope) UnmarshalJSON

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

type EvaluationNewResponseResult

type EvaluationNewResponseResult struct {
	ID                string                          `json:"id,required"`
	CreatedAt         time.Time                       `json:"created_at,required" format:"date-time"`
	EvaluationID      string                          `json:"evaluation_id,required"`
	EvaluationTypeID  string                          `json:"evaluation_type_id,required"`
	ModifiedAt        time.Time                       `json:"modified_at,required" format:"date-time"`
	Result            string                          `json:"result,required"`
	Status            float64                         `json:"status,required"`
	StatusDescription string                          `json:"status_description,required"`
	TotalLogs         float64                         `json:"total_logs,required"`
	JSON              evaluationNewResponseResultJSON `json:"-"`
}

func (*EvaluationNewResponseResult) UnmarshalJSON

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

type EvaluationService

type EvaluationService struct {
	Options []option.RequestOption
}

EvaluationService 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 NewEvaluationService method instead.

func NewEvaluationService

func NewEvaluationService(opts ...option.RequestOption) (r *EvaluationService)

NewEvaluationService 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 (*EvaluationService) Delete

Delete a Evaluation

func (*EvaluationService) Get

func (r *EvaluationService) Get(ctx context.Context, gatewayID string, id string, query EvaluationGetParams, opts ...option.RequestOption) (res *EvaluationGetResponse, err error)

Fetch a Evaluation

func (*EvaluationService) List

List Evaluations

func (*EvaluationService) ListAutoPaging

List Evaluations

func (*EvaluationService) New

func (r *EvaluationService) New(ctx context.Context, gatewayID string, params EvaluationNewParams, opts ...option.RequestOption) (res *EvaluationNewResponse, err error)

Create a new Evaluation

type EvaluationTypeListParams added in v4.1.0

type EvaluationTypeListParams struct {
	AccountID        param.Field[string]                                   `path:"account_id,required"`
	OrderBy          param.Field[string]                                   `query:"order_by"`
	OrderByDirection param.Field[EvaluationTypeListParamsOrderByDirection] `query:"order_by_direction"`
	Page             param.Field[int64]                                    `query:"page"`
	PerPage          param.Field[int64]                                    `query:"per_page"`
}

func (EvaluationTypeListParams) URLQuery added in v4.1.0

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

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

type EvaluationTypeListParamsOrderByDirection added in v4.1.0

type EvaluationTypeListParamsOrderByDirection string
const (
	EvaluationTypeListParamsOrderByDirectionAsc  EvaluationTypeListParamsOrderByDirection = "asc"
	EvaluationTypeListParamsOrderByDirectionDesc EvaluationTypeListParamsOrderByDirection = "desc"
)

func (EvaluationTypeListParamsOrderByDirection) IsKnown added in v4.1.0

type EvaluationTypeListResponse added in v4.1.0

type EvaluationTypeListResponse struct {
	ID          string                         `json:"id,required"`
	CreatedAt   time.Time                      `json:"created_at,required" format:"date-time"`
	Description string                         `json:"description,required"`
	Enable      bool                           `json:"enable,required"`
	Mandatory   bool                           `json:"mandatory,required"`
	ModifiedAt  time.Time                      `json:"modified_at,required" format:"date-time"`
	Name        string                         `json:"name,required"`
	Type        string                         `json:"type,required"`
	JSON        evaluationTypeListResponseJSON `json:"-"`
}

func (*EvaluationTypeListResponse) UnmarshalJSON added in v4.1.0

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

type EvaluationTypeService

type EvaluationTypeService struct {
	Options []option.RequestOption
}

EvaluationTypeService 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 NewEvaluationTypeService method instead.

func NewEvaluationTypeService

func NewEvaluationTypeService(opts ...option.RequestOption) (r *EvaluationTypeService)

NewEvaluationTypeService 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 (*EvaluationTypeService) List added in v4.1.0

List Evaluators

func (*EvaluationTypeService) ListAutoPaging added in v4.1.0

List Evaluators

type LogDeleteParams

type LogDeleteParams struct {
	AccountID        param.Field[string]                          `path:"account_id,required"`
	Filters          param.Field[[]LogDeleteParamsFilter]         `query:"filters"`
	Limit            param.Field[int64]                           `query:"limit"`
	OrderBy          param.Field[LogDeleteParamsOrderBy]          `query:"order_by"`
	OrderByDirection param.Field[LogDeleteParamsOrderByDirection] `query:"order_by_direction"`
}

func (LogDeleteParams) URLQuery

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

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

type LogDeleteParamsFilter

type LogDeleteParamsFilter struct {
	Key      param.Field[LogDeleteParamsFiltersKey]          `query:"key,required"`
	Operator param.Field[LogDeleteParamsFiltersOperator]     `query:"operator,required"`
	Value    param.Field[[]LogDeleteParamsFiltersValueUnion] `query:"value,required"`
}

func (LogDeleteParamsFilter) URLQuery

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

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

type LogDeleteParamsFiltersKey

type LogDeleteParamsFiltersKey string
const (
	LogDeleteParamsFiltersKeyID                  LogDeleteParamsFiltersKey = "id"
	LogDeleteParamsFiltersKeyCreatedAt           LogDeleteParamsFiltersKey = "created_at"
	LogDeleteParamsFiltersKeyRequestContentType  LogDeleteParamsFiltersKey = "request_content_type"
	LogDeleteParamsFiltersKeyResponseContentType LogDeleteParamsFiltersKey = "response_content_type"
	LogDeleteParamsFiltersKeySuccess             LogDeleteParamsFiltersKey = "success"
	LogDeleteParamsFiltersKeyCached              LogDeleteParamsFiltersKey = "cached"
	LogDeleteParamsFiltersKeyProvider            LogDeleteParamsFiltersKey = "provider"
	LogDeleteParamsFiltersKeyModel               LogDeleteParamsFiltersKey = "model"
	LogDeleteParamsFiltersKeyModelType           LogDeleteParamsFiltersKey = "model_type"
	LogDeleteParamsFiltersKeyCost                LogDeleteParamsFiltersKey = "cost"
	LogDeleteParamsFiltersKeyTokens              LogDeleteParamsFiltersKey = "tokens"
	LogDeleteParamsFiltersKeyTokensIn            LogDeleteParamsFiltersKey = "tokens_in"
	LogDeleteParamsFiltersKeyTokensOut           LogDeleteParamsFiltersKey = "tokens_out"
	LogDeleteParamsFiltersKeyDuration            LogDeleteParamsFiltersKey = "duration"
	LogDeleteParamsFiltersKeyFeedback            LogDeleteParamsFiltersKey = "feedback"
	LogDeleteParamsFiltersKeyEventID             LogDeleteParamsFiltersKey = "event_id"
	LogDeleteParamsFiltersKeyRequestType         LogDeleteParamsFiltersKey = "request_type"
	LogDeleteParamsFiltersKeyMetadataKey         LogDeleteParamsFiltersKey = "metadata.key"
	LogDeleteParamsFiltersKeyMetadataValue       LogDeleteParamsFiltersKey = "metadata.value"
	LogDeleteParamsFiltersKeyPromptsPromptID     LogDeleteParamsFiltersKey = "prompts.prompt_id"
	LogDeleteParamsFiltersKeyPromptsVersionID    LogDeleteParamsFiltersKey = "prompts.version_id"
)

func (LogDeleteParamsFiltersKey) IsKnown

func (r LogDeleteParamsFiltersKey) IsKnown() bool

type LogDeleteParamsFiltersOperator

type LogDeleteParamsFiltersOperator string
const (
	LogDeleteParamsFiltersOperatorEq       LogDeleteParamsFiltersOperator = "eq"
	LogDeleteParamsFiltersOperatorNeq      LogDeleteParamsFiltersOperator = "neq"
	LogDeleteParamsFiltersOperatorContains LogDeleteParamsFiltersOperator = "contains"
	LogDeleteParamsFiltersOperatorLt       LogDeleteParamsFiltersOperator = "lt"
	LogDeleteParamsFiltersOperatorGt       LogDeleteParamsFiltersOperator = "gt"
)

func (LogDeleteParamsFiltersOperator) IsKnown

type LogDeleteParamsFiltersValueUnion

type LogDeleteParamsFiltersValueUnion interface {
	ImplementsLogDeleteParamsFiltersValueUnion()
}

Satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool.

type LogDeleteParamsOrderBy

type LogDeleteParamsOrderBy string
const (
	LogDeleteParamsOrderByCreatedAt LogDeleteParamsOrderBy = "created_at"
	LogDeleteParamsOrderByProvider  LogDeleteParamsOrderBy = "provider"
	LogDeleteParamsOrderByModel     LogDeleteParamsOrderBy = "model"
	LogDeleteParamsOrderByModelType LogDeleteParamsOrderBy = "model_type"
	LogDeleteParamsOrderBySuccess   LogDeleteParamsOrderBy = "success"
	LogDeleteParamsOrderByCached    LogDeleteParamsOrderBy = "cached"
	LogDeleteParamsOrderByCost      LogDeleteParamsOrderBy = "cost"
	LogDeleteParamsOrderByTokensIn  LogDeleteParamsOrderBy = "tokens_in"
	LogDeleteParamsOrderByTokensOut LogDeleteParamsOrderBy = "tokens_out"
	LogDeleteParamsOrderByDuration  LogDeleteParamsOrderBy = "duration"
	LogDeleteParamsOrderByFeedback  LogDeleteParamsOrderBy = "feedback"
)

func (LogDeleteParamsOrderBy) IsKnown

func (r LogDeleteParamsOrderBy) IsKnown() bool

type LogDeleteParamsOrderByDirection

type LogDeleteParamsOrderByDirection string
const (
	LogDeleteParamsOrderByDirectionAsc  LogDeleteParamsOrderByDirection = "asc"
	LogDeleteParamsOrderByDirectionDesc LogDeleteParamsOrderByDirection = "desc"
)

func (LogDeleteParamsOrderByDirection) IsKnown

type LogDeleteResponse

type LogDeleteResponse struct {
	Success bool                  `json:"success,required"`
	JSON    logDeleteResponseJSON `json:"-"`
}

func (*LogDeleteResponse) UnmarshalJSON

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

type LogEditParams

type LogEditParams struct {
	AccountID param.Field[string]                                `path:"account_id,required"`
	Feedback  param.Field[float64]                               `json:"feedback"`
	Metadata  param.Field[map[string]LogEditParamsMetadataUnion] `json:"metadata"`
	Score     param.Field[float64]                               `json:"score"`
}

func (LogEditParams) MarshalJSON

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

type LogEditParamsMetadataUnion

type LogEditParamsMetadataUnion interface {
	ImplementsLogEditParamsMetadataUnion()
}

Satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool.

type LogEditResponse

type LogEditResponse = interface{}

type LogEditResponseEnvelope

type LogEditResponseEnvelope struct {
	Result  LogEditResponse             `json:"result,required"`
	Success bool                        `json:"success,required"`
	JSON    logEditResponseEnvelopeJSON `json:"-"`
}

func (*LogEditResponseEnvelope) UnmarshalJSON

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

type LogGetParams

type LogGetParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type LogGetResponse

type LogGetResponse struct {
	ID                   string             `json:"id,required"`
	Cached               bool               `json:"cached,required"`
	CreatedAt            time.Time          `json:"created_at,required" format:"date-time"`
	Duration             int64              `json:"duration,required"`
	Model                string             `json:"model,required"`
	Path                 string             `json:"path,required"`
	Provider             string             `json:"provider,required"`
	Success              bool               `json:"success,required"`
	TokensIn             int64              `json:"tokens_in,required,nullable"`
	TokensOut            int64              `json:"tokens_out,required,nullable"`
	Cost                 float64            `json:"cost"`
	CustomCost           bool               `json:"custom_cost"`
	Metadata             string             `json:"metadata"`
	ModelType            string             `json:"model_type"`
	RequestContentType   string             `json:"request_content_type"`
	RequestHead          string             `json:"request_head"`
	RequestHeadComplete  bool               `json:"request_head_complete"`
	RequestSize          int64              `json:"request_size"`
	RequestType          string             `json:"request_type"`
	ResponseContentType  string             `json:"response_content_type"`
	ResponseHead         string             `json:"response_head"`
	ResponseHeadComplete bool               `json:"response_head_complete"`
	ResponseSize         int64              `json:"response_size"`
	StatusCode           int64              `json:"status_code"`
	Step                 int64              `json:"step"`
	JSON                 logGetResponseJSON `json:"-"`
}

func (*LogGetResponse) UnmarshalJSON

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

type LogGetResponseEnvelope

type LogGetResponseEnvelope struct {
	Result  LogGetResponse             `json:"result,required"`
	Success bool                       `json:"success,required"`
	JSON    logGetResponseEnvelopeJSON `json:"-"`
}

func (*LogGetResponseEnvelope) UnmarshalJSON

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

type LogListParams

type LogListParams struct {
	AccountID           param.Field[string]                        `path:"account_id,required"`
	Cached              param.Field[bool]                          `query:"cached"`
	Direction           param.Field[LogListParamsDirection]        `query:"direction"`
	EndDate             param.Field[time.Time]                     `query:"end_date" format:"date-time"`
	Feedback            param.Field[LogListParamsFeedback]         `query:"feedback"`
	Filters             param.Field[[]LogListParamsFilter]         `query:"filters"`
	MaxCost             param.Field[float64]                       `query:"max_cost"`
	MaxDuration         param.Field[float64]                       `query:"max_duration"`
	MaxTokensIn         param.Field[float64]                       `query:"max_tokens_in"`
	MaxTokensOut        param.Field[float64]                       `query:"max_tokens_out"`
	MaxTotalTokens      param.Field[float64]                       `query:"max_total_tokens"`
	MetaInfo            param.Field[bool]                          `query:"meta_info"`
	MinCost             param.Field[float64]                       `query:"min_cost"`
	MinDuration         param.Field[float64]                       `query:"min_duration"`
	MinTokensIn         param.Field[float64]                       `query:"min_tokens_in"`
	MinTokensOut        param.Field[float64]                       `query:"min_tokens_out"`
	MinTotalTokens      param.Field[float64]                       `query:"min_total_tokens"`
	Model               param.Field[string]                        `query:"model"`
	ModelType           param.Field[string]                        `query:"model_type"`
	OrderBy             param.Field[LogListParamsOrderBy]          `query:"order_by"`
	OrderByDirection    param.Field[LogListParamsOrderByDirection] `query:"order_by_direction"`
	Page                param.Field[int64]                         `query:"page"`
	PerPage             param.Field[int64]                         `query:"per_page"`
	Provider            param.Field[string]                        `query:"provider"`
	RequestContentType  param.Field[string]                        `query:"request_content_type"`
	ResponseContentType param.Field[string]                        `query:"response_content_type"`
	Search              param.Field[string]                        `query:"search"`
	StartDate           param.Field[time.Time]                     `query:"start_date" format:"date-time"`
	Success             param.Field[bool]                          `query:"success"`
}

func (LogListParams) URLQuery

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

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

type LogListParamsDirection

type LogListParamsDirection string
const (
	LogListParamsDirectionAsc  LogListParamsDirection = "asc"
	LogListParamsDirectionDesc LogListParamsDirection = "desc"
)

func (LogListParamsDirection) IsKnown

func (r LogListParamsDirection) IsKnown() bool

type LogListParamsFeedback

type LogListParamsFeedback float64
const (
	LogListParamsFeedback0 LogListParamsFeedback = 0
	LogListParamsFeedback1 LogListParamsFeedback = 1
)

func (LogListParamsFeedback) IsKnown

func (r LogListParamsFeedback) IsKnown() bool

type LogListParamsFilter

type LogListParamsFilter struct {
	Key      param.Field[LogListParamsFiltersKey]          `query:"key,required"`
	Operator param.Field[LogListParamsFiltersOperator]     `query:"operator,required"`
	Value    param.Field[[]LogListParamsFiltersValueUnion] `query:"value,required"`
}

func (LogListParamsFilter) URLQuery

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

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

type LogListParamsFiltersKey

type LogListParamsFiltersKey string
const (
	LogListParamsFiltersKeyID                  LogListParamsFiltersKey = "id"
	LogListParamsFiltersKeyCreatedAt           LogListParamsFiltersKey = "created_at"
	LogListParamsFiltersKeyRequestContentType  LogListParamsFiltersKey = "request_content_type"
	LogListParamsFiltersKeyResponseContentType LogListParamsFiltersKey = "response_content_type"
	LogListParamsFiltersKeySuccess             LogListParamsFiltersKey = "success"
	LogListParamsFiltersKeyCached              LogListParamsFiltersKey = "cached"
	LogListParamsFiltersKeyProvider            LogListParamsFiltersKey = "provider"
	LogListParamsFiltersKeyModel               LogListParamsFiltersKey = "model"
	LogListParamsFiltersKeyModelType           LogListParamsFiltersKey = "model_type"
	LogListParamsFiltersKeyCost                LogListParamsFiltersKey = "cost"
	LogListParamsFiltersKeyTokens              LogListParamsFiltersKey = "tokens"
	LogListParamsFiltersKeyTokensIn            LogListParamsFiltersKey = "tokens_in"
	LogListParamsFiltersKeyTokensOut           LogListParamsFiltersKey = "tokens_out"
	LogListParamsFiltersKeyDuration            LogListParamsFiltersKey = "duration"
	LogListParamsFiltersKeyFeedback            LogListParamsFiltersKey = "feedback"
	LogListParamsFiltersKeyEventID             LogListParamsFiltersKey = "event_id"
	LogListParamsFiltersKeyRequestType         LogListParamsFiltersKey = "request_type"
	LogListParamsFiltersKeyMetadataKey         LogListParamsFiltersKey = "metadata.key"
	LogListParamsFiltersKeyMetadataValue       LogListParamsFiltersKey = "metadata.value"
	LogListParamsFiltersKeyPromptsPromptID     LogListParamsFiltersKey = "prompts.prompt_id"
	LogListParamsFiltersKeyPromptsVersionID    LogListParamsFiltersKey = "prompts.version_id"
)

func (LogListParamsFiltersKey) IsKnown

func (r LogListParamsFiltersKey) IsKnown() bool

type LogListParamsFiltersOperator

type LogListParamsFiltersOperator string
const (
	LogListParamsFiltersOperatorEq       LogListParamsFiltersOperator = "eq"
	LogListParamsFiltersOperatorNeq      LogListParamsFiltersOperator = "neq"
	LogListParamsFiltersOperatorContains LogListParamsFiltersOperator = "contains"
	LogListParamsFiltersOperatorLt       LogListParamsFiltersOperator = "lt"
	LogListParamsFiltersOperatorGt       LogListParamsFiltersOperator = "gt"
)

func (LogListParamsFiltersOperator) IsKnown

func (r LogListParamsFiltersOperator) IsKnown() bool

type LogListParamsFiltersValueUnion

type LogListParamsFiltersValueUnion interface {
	ImplementsLogListParamsFiltersValueUnion()
}

Satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool.

type LogListParamsOrderBy

type LogListParamsOrderBy string
const (
	LogListParamsOrderByCreatedAt LogListParamsOrderBy = "created_at"
	LogListParamsOrderByProvider  LogListParamsOrderBy = "provider"
	LogListParamsOrderByModel     LogListParamsOrderBy = "model"
	LogListParamsOrderByModelType LogListParamsOrderBy = "model_type"
	LogListParamsOrderBySuccess   LogListParamsOrderBy = "success"
	LogListParamsOrderByCached    LogListParamsOrderBy = "cached"
)

func (LogListParamsOrderBy) IsKnown

func (r LogListParamsOrderBy) IsKnown() bool

type LogListParamsOrderByDirection

type LogListParamsOrderByDirection string
const (
	LogListParamsOrderByDirectionAsc  LogListParamsOrderByDirection = "asc"
	LogListParamsOrderByDirectionDesc LogListParamsOrderByDirection = "desc"
)

func (LogListParamsOrderByDirection) IsKnown

func (r LogListParamsOrderByDirection) IsKnown() bool

type LogListResponse

type LogListResponse struct {
	ID                  string              `json:"id,required"`
	Cached              bool                `json:"cached,required"`
	CreatedAt           time.Time           `json:"created_at,required" format:"date-time"`
	Duration            int64               `json:"duration,required"`
	Model               string              `json:"model,required"`
	Path                string              `json:"path,required"`
	Provider            string              `json:"provider,required"`
	Success             bool                `json:"success,required"`
	TokensIn            int64               `json:"tokens_in,required,nullable"`
	TokensOut           int64               `json:"tokens_out,required,nullable"`
	Cost                float64             `json:"cost"`
	CustomCost          bool                `json:"custom_cost"`
	Metadata            string              `json:"metadata"`
	ModelType           string              `json:"model_type"`
	RequestContentType  string              `json:"request_content_type"`
	RequestType         string              `json:"request_type"`
	ResponseContentType string              `json:"response_content_type"`
	StatusCode          int64               `json:"status_code"`
	Step                int64               `json:"step"`
	JSON                logListResponseJSON `json:"-"`
}

func (*LogListResponse) UnmarshalJSON

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

type LogRequestParams

type LogRequestParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type LogRequestResponse

type LogRequestResponse = interface{}

type LogResponseParams

type LogResponseParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type LogResponseResponse

type LogResponseResponse = interface{}

type LogService

type LogService struct {
	Options []option.RequestOption
}

LogService 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 NewLogService method instead.

func NewLogService

func NewLogService(opts ...option.RequestOption) (r *LogService)

NewLogService 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 (*LogService) Delete

func (r *LogService) Delete(ctx context.Context, gatewayID string, params LogDeleteParams, opts ...option.RequestOption) (res *LogDeleteResponse, err error)

Delete Gateway Logs

func (*LogService) Edit

func (r *LogService) Edit(ctx context.Context, gatewayID string, id string, params LogEditParams, opts ...option.RequestOption) (res *LogEditResponse, err error)

Patch Gateway Log

func (*LogService) Get

func (r *LogService) Get(ctx context.Context, gatewayID string, id string, query LogGetParams, opts ...option.RequestOption) (res *LogGetResponse, err error)

Get Gateway Log Detail

func (*LogService) List

List Gateway Logs

func (*LogService) ListAutoPaging

List Gateway Logs

func (*LogService) Request

func (r *LogService) Request(ctx context.Context, gatewayID string, id string, query LogRequestParams, opts ...option.RequestOption) (res *LogRequestResponse, err error)

Get Gateway Log Request

func (*LogService) Response

func (r *LogService) Response(ctx context.Context, gatewayID string, id string, query LogResponseParams, opts ...option.RequestOption) (res *LogResponseResponse, err error)

Get Gateway Log Response

type Member

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

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

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

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

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

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

This is an alias to an internal type.

type MemberPolicy

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID added in v4.1.0

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type 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 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 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 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.

type URLGetParams added in v4.2.0

type URLGetParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type URLGetResponseEnvelope added in v4.2.0

type URLGetResponseEnvelope struct {
	Result  string                     `json:"result,required"`
	Success bool                       `json:"success,required"`
	JSON    urlGetResponseEnvelopeJSON `json:"-"`
}

func (*URLGetResponseEnvelope) UnmarshalJSON added in v4.2.0

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

type URLService added in v4.2.0

type URLService struct {
	Options []option.RequestOption
}

URLService 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 NewURLService method instead.

func NewURLService added in v4.2.0

func NewURLService(opts ...option.RequestOption) (r *URLService)

NewURLService 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 (*URLService) Get added in v4.2.0

func (r *URLService) Get(ctx context.Context, gatewayID string, provider string, query URLGetParams, opts ...option.RequestOption) (res *string, err error)

Get Gateway URL

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL