web3

package
v6.6.0 Latest Latest
Warning

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

 Go to latest Published: Jan 16, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source 
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source 
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source 
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source 
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source 
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source 
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source 
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source 
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source 
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source 
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source 
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source 
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source 
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source 
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source 
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

type AuditLogActorType = shared.AuditLogActorType

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

This is an alias to an internal type.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType 

type CertificateRequestType = shared.CertificateRequestType

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

This is an alias to an internal type.

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type CloudflareTunnelConfigSrc 

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

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

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

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

This is an alias to an internal type.

type CloudflareTunnelTunType 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type ContentList 

type ContentList struct {
	// Behavior of the content list.
	Action ContentListAction `json:"action"`
	JSON   contentListJSON   `json:"-"`
}

func (*ContentList) UnmarshalJSON 

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

type ContentListAction 

type ContentListAction string

Behavior of the content list. 

const (
	ContentListActionBlock ContentListAction = "block"
)

func (ContentListAction) IsKnown 

func (r ContentListAction) IsKnown() bool

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource 

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type Hostname 

type Hostname struct {
	// Specify the identifier of the hostname.
	ID        string    `json:"id"`
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// Specify an optional description of the hostname.
	Description string `json:"description"`
	// Specify the DNSLink value used if the target is ipfs.
	Dnslink    string    `json:"dnslink"`
	ModifiedOn time.Time `json:"modified_on" format:"date-time"`
	// Specify the hostname that points to the target gateway via CNAME.
	Name string `json:"name"`
	// Specifies the status of the hostname's activation.
	Status HostnameStatus `json:"status"`
	// Specify the target gateway of the hostname.
	Target HostnameTarget `json:"target"`
	JSON   hostnameJSON   `json:"-"`
}

func (*Hostname) UnmarshalJSON 

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

type HostnameDeleteParams 

type HostnameDeleteParams struct {
	// Specify the identifier of the hostname.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type HostnameDeleteResponse 

type HostnameDeleteResponse struct {
	// Specify the identifier of the hostname.
	ID   string                     `json:"id,required"`
	JSON hostnameDeleteResponseJSON `json:"-"`
}

func (*HostnameDeleteResponse) UnmarshalJSON 

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

type HostnameDeleteResponseEnvelope 

type HostnameDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo  `json:"errors,required"`
	Messages []shared.ResponseInfo  `json:"messages,required"`
	Result   HostnameDeleteResponse `json:"result,required,nullable"`
	// Specifies whether the API call was successful.
	Success HostnameDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    hostnameDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*HostnameDeleteResponseEnvelope) UnmarshalJSON 

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

type HostnameDeleteResponseEnvelopeSuccess 

type HostnameDeleteResponseEnvelopeSuccess bool

Specifies whether the API call was successful. 

const (
	HostnameDeleteResponseEnvelopeSuccessTrue HostnameDeleteResponseEnvelopeSuccess = true
)

func (HostnameDeleteResponseEnvelopeSuccess) IsKnown 

func (r HostnameDeleteResponseEnvelopeSuccess) IsKnown() bool

type HostnameEditParams 

type HostnameEditParams struct {
	// Specify the identifier of the hostname.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Specify an optional description of the hostname.
	Description param.Field[string] `json:"description"`
	// Specify the DNSLink value used if the target is ipfs.
	Dnslink param.Field[string] `json:"dnslink"`
}

func (HostnameEditParams) MarshalJSON 

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

type HostnameEditResponseEnvelope 

type HostnameEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   Hostname              `json:"result,required"`
	// Specifies whether the API call was successful.
	Success HostnameEditResponseEnvelopeSuccess `json:"success,required"`
	// Provides the API response.
	ResultInfo interface{}                      `json:"result_info"`
	JSON       hostnameEditResponseEnvelopeJSON `json:"-"`
}

func (*HostnameEditResponseEnvelope) UnmarshalJSON 

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

type HostnameEditResponseEnvelopeSuccess 

type HostnameEditResponseEnvelopeSuccess bool

Specifies whether the API call was successful. 

const (
	HostnameEditResponseEnvelopeSuccessTrue HostnameEditResponseEnvelopeSuccess = true
)

func (HostnameEditResponseEnvelopeSuccess) IsKnown 

func (r HostnameEditResponseEnvelopeSuccess) IsKnown() bool

type HostnameGetParams 

type HostnameGetParams struct {
	// Specify the identifier of the hostname.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type HostnameGetResponseEnvelope 

type HostnameGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   Hostname              `json:"result,required"`
	// Specifies whether the API call was successful.
	Success HostnameGetResponseEnvelopeSuccess `json:"success,required"`
	// Provides the API response.
	ResultInfo interface{}                     `json:"result_info"`
	JSON       hostnameGetResponseEnvelopeJSON `json:"-"`
}

func (*HostnameGetResponseEnvelope) UnmarshalJSON 

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

type HostnameGetResponseEnvelopeSuccess 

type HostnameGetResponseEnvelopeSuccess bool

Specifies whether the API call was successful. 

const (
	HostnameGetResponseEnvelopeSuccessTrue HostnameGetResponseEnvelopeSuccess = true
)

func (HostnameGetResponseEnvelopeSuccess) IsKnown 

func (r HostnameGetResponseEnvelopeSuccess) IsKnown() bool

type HostnameIPFSUniversalPathContentListEntryDeleteParams 

type HostnameIPFSUniversalPathContentListEntryDeleteParams struct {
	// Specify the identifier of the hostname.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type HostnameIPFSUniversalPathContentListEntryDeleteResponse 

type HostnameIPFSUniversalPathContentListEntryDeleteResponse struct {
	// Specify the identifier of the hostname.
	ID   string                                                      `json:"id,required"`
	JSON hostnameIPFSUniversalPathContentListEntryDeleteResponseJSON `json:"-"`
}

func (*HostnameIPFSUniversalPathContentListEntryDeleteResponse) UnmarshalJSON 

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

type HostnameIPFSUniversalPathContentListEntryDeleteResponseEnvelope 

type HostnameIPFSUniversalPathContentListEntryDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo                                   `json:"errors,required"`
	Messages []shared.ResponseInfo                                   `json:"messages,required"`
	Result   HostnameIPFSUniversalPathContentListEntryDeleteResponse `json:"result,required,nullable"`
	// Specifies whether the API call was successful.
	Success HostnameIPFSUniversalPathContentListEntryDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    hostnameIPFSUniversalPathContentListEntryDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*HostnameIPFSUniversalPathContentListEntryDeleteResponseEnvelope) UnmarshalJSON 

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

type HostnameIPFSUniversalPathContentListEntryDeleteResponseEnvelopeSuccess 

type HostnameIPFSUniversalPathContentListEntryDeleteResponseEnvelopeSuccess bool

Specifies whether the API call was successful. 

const (
	HostnameIPFSUniversalPathContentListEntryDeleteResponseEnvelopeSuccessTrue HostnameIPFSUniversalPathContentListEntryDeleteResponseEnvelopeSuccess = true
)

func (HostnameIPFSUniversalPathContentListEntryDeleteResponseEnvelopeSuccess) IsKnown 

func (r HostnameIPFSUniversalPathContentListEntryDeleteResponseEnvelopeSuccess) IsKnown() bool

type HostnameIPFSUniversalPathContentListEntryGetParams 

type HostnameIPFSUniversalPathContentListEntryGetParams struct {
	// Specify the identifier of the hostname.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type HostnameIPFSUniversalPathContentListEntryGetResponse 

type HostnameIPFSUniversalPathContentListEntryGetResponse struct {
	// Specify the identifier of the hostname.
	ID string `json:"id"`
	// Specify the CID or content path of content to block.
	Content   string    `json:"content"`
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// Specify an optional description of the content list entry.
	Description string    `json:"description"`
	ModifiedOn  time.Time `json:"modified_on" format:"date-time"`
	// Specify the type of content list entry to block.
	Type HostnameIPFSUniversalPathContentListEntryGetResponseType `json:"type"`
	JSON hostnameIPFSUniversalPathContentListEntryGetResponseJSON `json:"-"`
}

Specify a content list entry to block.

func (*HostnameIPFSUniversalPathContentListEntryGetResponse) UnmarshalJSON 

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

type HostnameIPFSUniversalPathContentListEntryGetResponseEnvelope 

type HostnameIPFSUniversalPathContentListEntryGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Specify a content list entry to block.
	Result HostnameIPFSUniversalPathContentListEntryGetResponse `json:"result,required"`
	// Specifies whether the API call was successful.
	Success HostnameIPFSUniversalPathContentListEntryGetResponseEnvelopeSuccess `json:"success,required"`
	// Provides the API response.
	ResultInfo interface{}                                                      `json:"result_info"`
	JSON       hostnameIPFSUniversalPathContentListEntryGetResponseEnvelopeJSON `json:"-"`
}

func (*HostnameIPFSUniversalPathContentListEntryGetResponseEnvelope) UnmarshalJSON 

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

type HostnameIPFSUniversalPathContentListEntryGetResponseEnvelopeSuccess 

type HostnameIPFSUniversalPathContentListEntryGetResponseEnvelopeSuccess bool

Specifies whether the API call was successful. 

const (
	HostnameIPFSUniversalPathContentListEntryGetResponseEnvelopeSuccessTrue HostnameIPFSUniversalPathContentListEntryGetResponseEnvelopeSuccess = true
)

func (HostnameIPFSUniversalPathContentListEntryGetResponseEnvelopeSuccess) IsKnown 

func (r HostnameIPFSUniversalPathContentListEntryGetResponseEnvelopeSuccess) IsKnown() bool

type HostnameIPFSUniversalPathContentListEntryGetResponseType 

type HostnameIPFSUniversalPathContentListEntryGetResponseType string

Specify the type of content list entry to block. 

const (
	HostnameIPFSUniversalPathContentListEntryGetResponseTypeCid         HostnameIPFSUniversalPathContentListEntryGetResponseType = "cid"
	HostnameIPFSUniversalPathContentListEntryGetResponseTypeContentPath HostnameIPFSUniversalPathContentListEntryGetResponseType = "content_path"
)

func (HostnameIPFSUniversalPathContentListEntryGetResponseType) IsKnown 

func (r HostnameIPFSUniversalPathContentListEntryGetResponseType) IsKnown() bool

type HostnameIPFSUniversalPathContentListEntryListParams 

type HostnameIPFSUniversalPathContentListEntryListParams struct {
	// Specify the identifier of the hostname.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type HostnameIPFSUniversalPathContentListEntryListResponse 

type HostnameIPFSUniversalPathContentListEntryListResponse struct {
	// Provides content list entries.
	Entries []HostnameIPFSUniversalPathContentListEntryListResponseEntry `json:"entries"`
	JSON    hostnameIPFSUniversalPathContentListEntryListResponseJSON    `json:"-"`
}

func (*HostnameIPFSUniversalPathContentListEntryListResponse) UnmarshalJSON 

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

type HostnameIPFSUniversalPathContentListEntryListResponseEntriesType 

type HostnameIPFSUniversalPathContentListEntryListResponseEntriesType string

Specify the type of content list entry to block. 

const (
	HostnameIPFSUniversalPathContentListEntryListResponseEntriesTypeCid         HostnameIPFSUniversalPathContentListEntryListResponseEntriesType = "cid"
	HostnameIPFSUniversalPathContentListEntryListResponseEntriesTypeContentPath HostnameIPFSUniversalPathContentListEntryListResponseEntriesType = "content_path"
)

func (HostnameIPFSUniversalPathContentListEntryListResponseEntriesType) IsKnown 

func (r HostnameIPFSUniversalPathContentListEntryListResponseEntriesType) IsKnown() bool

type HostnameIPFSUniversalPathContentListEntryListResponseEntry 

type HostnameIPFSUniversalPathContentListEntryListResponseEntry struct {
	// Specify the identifier of the hostname.
	ID string `json:"id"`
	// Specify the CID or content path of content to block.
	Content   string    `json:"content"`
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// Specify an optional description of the content list entry.
	Description string    `json:"description"`
	ModifiedOn  time.Time `json:"modified_on" format:"date-time"`
	// Specify the type of content list entry to block.
	Type HostnameIPFSUniversalPathContentListEntryListResponseEntriesType `json:"type"`
	JSON hostnameIPFSUniversalPathContentListEntryListResponseEntryJSON   `json:"-"`
}

Specify a content list entry to block.

func (*HostnameIPFSUniversalPathContentListEntryListResponseEntry) UnmarshalJSON 

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

type HostnameIPFSUniversalPathContentListEntryListResponseEnvelope 

type HostnameIPFSUniversalPathContentListEntryListResponseEnvelope struct {
	Errors   []shared.ResponseInfo                                 `json:"errors,required"`
	Messages []shared.ResponseInfo                                 `json:"messages,required"`
	Result   HostnameIPFSUniversalPathContentListEntryListResponse `json:"result,required,nullable"`
	// Specifies whether the API call was successful.
	Success    HostnameIPFSUniversalPathContentListEntryListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo HostnameIPFSUniversalPathContentListEntryListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       hostnameIPFSUniversalPathContentListEntryListResponseEnvelopeJSON       `json:"-"`
}

func (*HostnameIPFSUniversalPathContentListEntryListResponseEnvelope) UnmarshalJSON 

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

type HostnameIPFSUniversalPathContentListEntryListResponseEnvelopeResultInfo 

type HostnameIPFSUniversalPathContentListEntryListResponseEnvelopeResultInfo struct {
	// Specifies the total number of results for the requested service.
	Count float64 `json:"count"`
	// Specifies the current page within paginated list of results.
	Page float64 `json:"page"`
	// Specifies the number of results per page of results.
	PerPage float64 `json:"per_page"`
	// Specifies the total results available without any search parameters.
	TotalCount float64                                                                     `json:"total_count"`
	JSON       hostnameIPFSUniversalPathContentListEntryListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*HostnameIPFSUniversalPathContentListEntryListResponseEnvelopeResultInfo) UnmarshalJSON 

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

type HostnameIPFSUniversalPathContentListEntryListResponseEnvelopeSuccess 

type HostnameIPFSUniversalPathContentListEntryListResponseEnvelopeSuccess bool

Specifies whether the API call was successful. 

const (
	HostnameIPFSUniversalPathContentListEntryListResponseEnvelopeSuccessTrue HostnameIPFSUniversalPathContentListEntryListResponseEnvelopeSuccess = true
)

func (HostnameIPFSUniversalPathContentListEntryListResponseEnvelopeSuccess) IsKnown 

func (r HostnameIPFSUniversalPathContentListEntryListResponseEnvelopeSuccess) IsKnown() bool

type HostnameIPFSUniversalPathContentListEntryNewParams 

type HostnameIPFSUniversalPathContentListEntryNewParams struct {
	// Specify the identifier of the hostname.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Specify the CID or content path of content to block.
	Content param.Field[string] `json:"content,required"`
	// Specify the type of content list entry to block.
	Type param.Field[HostnameIPFSUniversalPathContentListEntryNewParamsType] `json:"type,required"`
	// Specify an optional description of the content list entry.
	Description param.Field[string] `json:"description"`
}

func (HostnameIPFSUniversalPathContentListEntryNewParams) MarshalJSON 

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

type HostnameIPFSUniversalPathContentListEntryNewParamsType 

type HostnameIPFSUniversalPathContentListEntryNewParamsType string

Specify the type of content list entry to block. 

const (
	HostnameIPFSUniversalPathContentListEntryNewParamsTypeCid         HostnameIPFSUniversalPathContentListEntryNewParamsType = "cid"
	HostnameIPFSUniversalPathContentListEntryNewParamsTypeContentPath HostnameIPFSUniversalPathContentListEntryNewParamsType = "content_path"
)

func (HostnameIPFSUniversalPathContentListEntryNewParamsType) IsKnown 

func (r HostnameIPFSUniversalPathContentListEntryNewParamsType) IsKnown() bool

type HostnameIPFSUniversalPathContentListEntryNewResponse 

type HostnameIPFSUniversalPathContentListEntryNewResponse struct {
	// Specify the identifier of the hostname.
	ID string `json:"id"`
	// Specify the CID or content path of content to block.
	Content   string    `json:"content"`
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// Specify an optional description of the content list entry.
	Description string    `json:"description"`
	ModifiedOn  time.Time `json:"modified_on" format:"date-time"`
	// Specify the type of content list entry to block.
	Type HostnameIPFSUniversalPathContentListEntryNewResponseType `json:"type"`
	JSON hostnameIPFSUniversalPathContentListEntryNewResponseJSON `json:"-"`
}

Specify a content list entry to block.

func (*HostnameIPFSUniversalPathContentListEntryNewResponse) UnmarshalJSON 

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

type HostnameIPFSUniversalPathContentListEntryNewResponseEnvelope 

type HostnameIPFSUniversalPathContentListEntryNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Specify a content list entry to block.
	Result HostnameIPFSUniversalPathContentListEntryNewResponse `json:"result,required"`
	// Specifies whether the API call was successful.
	Success HostnameIPFSUniversalPathContentListEntryNewResponseEnvelopeSuccess `json:"success,required"`
	// Provides the API response.
	ResultInfo interface{}                                                      `json:"result_info"`
	JSON       hostnameIPFSUniversalPathContentListEntryNewResponseEnvelopeJSON `json:"-"`
}

func (*HostnameIPFSUniversalPathContentListEntryNewResponseEnvelope) UnmarshalJSON 

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

type HostnameIPFSUniversalPathContentListEntryNewResponseEnvelopeSuccess 

type HostnameIPFSUniversalPathContentListEntryNewResponseEnvelopeSuccess bool

Specifies whether the API call was successful. 

const (
	HostnameIPFSUniversalPathContentListEntryNewResponseEnvelopeSuccessTrue HostnameIPFSUniversalPathContentListEntryNewResponseEnvelopeSuccess = true
)

func (HostnameIPFSUniversalPathContentListEntryNewResponseEnvelopeSuccess) IsKnown 

func (r HostnameIPFSUniversalPathContentListEntryNewResponseEnvelopeSuccess) IsKnown() bool

type HostnameIPFSUniversalPathContentListEntryNewResponseType 

type HostnameIPFSUniversalPathContentListEntryNewResponseType string

Specify the type of content list entry to block. 

const (
	HostnameIPFSUniversalPathContentListEntryNewResponseTypeCid         HostnameIPFSUniversalPathContentListEntryNewResponseType = "cid"
	HostnameIPFSUniversalPathContentListEntryNewResponseTypeContentPath HostnameIPFSUniversalPathContentListEntryNewResponseType = "content_path"
)

func (HostnameIPFSUniversalPathContentListEntryNewResponseType) IsKnown 

func (r HostnameIPFSUniversalPathContentListEntryNewResponseType) IsKnown() bool

type HostnameIPFSUniversalPathContentListEntryService 

type HostnameIPFSUniversalPathContentListEntryService struct {
	Options []option.RequestOption
}

HostnameIPFSUniversalPathContentListEntryService 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 NewHostnameIPFSUniversalPathContentListEntryService method instead.

func NewHostnameIPFSUniversalPathContentListEntryService 

func NewHostnameIPFSUniversalPathContentListEntryService(opts ...option.RequestOption) (r *HostnameIPFSUniversalPathContentListEntryService)

NewHostnameIPFSUniversalPathContentListEntryService 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 (*HostnameIPFSUniversalPathContentListEntryService) Delete 

func (r *HostnameIPFSUniversalPathContentListEntryService) Delete(ctx context.Context, identifier string, contentListEntryIdentifier string, body HostnameIPFSUniversalPathContentListEntryDeleteParams, opts ...option.RequestOption) (res *HostnameIPFSUniversalPathContentListEntryDeleteResponse, err error)

Delete IPFS Universal Path Gateway Content List Entry

func (*HostnameIPFSUniversalPathContentListEntryService) Get 

func (r *HostnameIPFSUniversalPathContentListEntryService) Get(ctx context.Context, identifier string, contentListEntryIdentifier string, query HostnameIPFSUniversalPathContentListEntryGetParams, opts ...option.RequestOption) (res *HostnameIPFSUniversalPathContentListEntryGetResponse, err error)

IPFS Universal Path Gateway Content List Entry Details

func (*HostnameIPFSUniversalPathContentListEntryService) List 

func (r *HostnameIPFSUniversalPathContentListEntryService) List(ctx context.Context, identifier string, query HostnameIPFSUniversalPathContentListEntryListParams, opts ...option.RequestOption) (res *HostnameIPFSUniversalPathContentListEntryListResponse, err error)

List IPFS Universal Path Gateway Content List Entries

func (*HostnameIPFSUniversalPathContentListEntryService) New 

func (r *HostnameIPFSUniversalPathContentListEntryService) New(ctx context.Context, identifier string, params HostnameIPFSUniversalPathContentListEntryNewParams, opts ...option.RequestOption) (res *HostnameIPFSUniversalPathContentListEntryNewResponse, err error)

Create IPFS Universal Path Gateway Content List Entry

func (*HostnameIPFSUniversalPathContentListEntryService) Update 

func (r *HostnameIPFSUniversalPathContentListEntryService) Update(ctx context.Context, identifier string, contentListEntryIdentifier string, params HostnameIPFSUniversalPathContentListEntryUpdateParams, opts ...option.RequestOption) (res *HostnameIPFSUniversalPathContentListEntryUpdateResponse, err error)

Edit IPFS Universal Path Gateway Content List Entry

type HostnameIPFSUniversalPathContentListEntryUpdateParams 

type HostnameIPFSUniversalPathContentListEntryUpdateParams struct {
	// Specify the identifier of the hostname.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Specify the CID or content path of content to block.
	Content param.Field[string] `json:"content,required"`
	// Specify the type of content list entry to block.
	Type param.Field[HostnameIPFSUniversalPathContentListEntryUpdateParamsType] `json:"type,required"`
	// Specify an optional description of the content list entry.
	Description param.Field[string] `json:"description"`
}

func (HostnameIPFSUniversalPathContentListEntryUpdateParams) MarshalJSON 

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

type HostnameIPFSUniversalPathContentListEntryUpdateParamsType 

type HostnameIPFSUniversalPathContentListEntryUpdateParamsType string

Specify the type of content list entry to block. 

const (
	HostnameIPFSUniversalPathContentListEntryUpdateParamsTypeCid         HostnameIPFSUniversalPathContentListEntryUpdateParamsType = "cid"
	HostnameIPFSUniversalPathContentListEntryUpdateParamsTypeContentPath HostnameIPFSUniversalPathContentListEntryUpdateParamsType = "content_path"
)

func (HostnameIPFSUniversalPathContentListEntryUpdateParamsType) IsKnown 

func (r HostnameIPFSUniversalPathContentListEntryUpdateParamsType) IsKnown() bool

type HostnameIPFSUniversalPathContentListEntryUpdateResponse 

type HostnameIPFSUniversalPathContentListEntryUpdateResponse struct {
	// Specify the identifier of the hostname.
	ID string `json:"id"`
	// Specify the CID or content path of content to block.
	Content   string    `json:"content"`
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// Specify an optional description of the content list entry.
	Description string    `json:"description"`
	ModifiedOn  time.Time `json:"modified_on" format:"date-time"`
	// Specify the type of content list entry to block.
	Type HostnameIPFSUniversalPathContentListEntryUpdateResponseType `json:"type"`
	JSON hostnameIPFSUniversalPathContentListEntryUpdateResponseJSON `json:"-"`
}

Specify a content list entry to block.

func (*HostnameIPFSUniversalPathContentListEntryUpdateResponse) UnmarshalJSON 

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

type HostnameIPFSUniversalPathContentListEntryUpdateResponseEnvelope 

type HostnameIPFSUniversalPathContentListEntryUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Specify a content list entry to block.
	Result HostnameIPFSUniversalPathContentListEntryUpdateResponse `json:"result,required"`
	// Specifies whether the API call was successful.
	Success HostnameIPFSUniversalPathContentListEntryUpdateResponseEnvelopeSuccess `json:"success,required"`
	// Provides the API response.
	ResultInfo interface{}                                                         `json:"result_info"`
	JSON       hostnameIPFSUniversalPathContentListEntryUpdateResponseEnvelopeJSON `json:"-"`
}

func (*HostnameIPFSUniversalPathContentListEntryUpdateResponseEnvelope) UnmarshalJSON 

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

type HostnameIPFSUniversalPathContentListEntryUpdateResponseEnvelopeSuccess 

type HostnameIPFSUniversalPathContentListEntryUpdateResponseEnvelopeSuccess bool

Specifies whether the API call was successful. 

const (
	HostnameIPFSUniversalPathContentListEntryUpdateResponseEnvelopeSuccessTrue HostnameIPFSUniversalPathContentListEntryUpdateResponseEnvelopeSuccess = true
)

func (HostnameIPFSUniversalPathContentListEntryUpdateResponseEnvelopeSuccess) IsKnown 

func (r HostnameIPFSUniversalPathContentListEntryUpdateResponseEnvelopeSuccess) IsKnown() bool

type HostnameIPFSUniversalPathContentListEntryUpdateResponseType 

type HostnameIPFSUniversalPathContentListEntryUpdateResponseType string

Specify the type of content list entry to block. 

const (
	HostnameIPFSUniversalPathContentListEntryUpdateResponseTypeCid         HostnameIPFSUniversalPathContentListEntryUpdateResponseType = "cid"
	HostnameIPFSUniversalPathContentListEntryUpdateResponseTypeContentPath HostnameIPFSUniversalPathContentListEntryUpdateResponseType = "content_path"
)

func (HostnameIPFSUniversalPathContentListEntryUpdateResponseType) IsKnown 

func (r HostnameIPFSUniversalPathContentListEntryUpdateResponseType) IsKnown() bool

type HostnameIPFSUniversalPathContentListGetParams 

type HostnameIPFSUniversalPathContentListGetParams struct {
	// Specify the identifier of the hostname.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type HostnameIPFSUniversalPathContentListGetResponseEnvelope 

type HostnameIPFSUniversalPathContentListGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   ContentList           `json:"result,required"`
	// Specifies whether the API call was successful.
	Success HostnameIPFSUniversalPathContentListGetResponseEnvelopeSuccess `json:"success,required"`
	// Provides the API response.
	ResultInfo interface{}                                                 `json:"result_info"`
	JSON       hostnameIPFSUniversalPathContentListGetResponseEnvelopeJSON `json:"-"`
}

func (*HostnameIPFSUniversalPathContentListGetResponseEnvelope) UnmarshalJSON 

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

type HostnameIPFSUniversalPathContentListGetResponseEnvelopeSuccess 

type HostnameIPFSUniversalPathContentListGetResponseEnvelopeSuccess bool

Specifies whether the API call was successful. 

const (
	HostnameIPFSUniversalPathContentListGetResponseEnvelopeSuccessTrue HostnameIPFSUniversalPathContentListGetResponseEnvelopeSuccess = true
)

func (HostnameIPFSUniversalPathContentListGetResponseEnvelopeSuccess) IsKnown 

func (r HostnameIPFSUniversalPathContentListGetResponseEnvelopeSuccess) IsKnown() bool

type HostnameIPFSUniversalPathContentListService 

type HostnameIPFSUniversalPathContentListService struct {
	Options []option.RequestOption
	Entries *HostnameIPFSUniversalPathContentListEntryService
}

HostnameIPFSUniversalPathContentListService 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 NewHostnameIPFSUniversalPathContentListService method instead.

func NewHostnameIPFSUniversalPathContentListService 

func NewHostnameIPFSUniversalPathContentListService(opts ...option.RequestOption) (r *HostnameIPFSUniversalPathContentListService)

NewHostnameIPFSUniversalPathContentListService 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 (*HostnameIPFSUniversalPathContentListService) Get 

func (r *HostnameIPFSUniversalPathContentListService) Get(ctx context.Context, identifier string, query HostnameIPFSUniversalPathContentListGetParams, opts ...option.RequestOption) (res *ContentList, err error)

IPFS Universal Path Gateway Content List Details

func (*HostnameIPFSUniversalPathContentListService) Update 

func (r *HostnameIPFSUniversalPathContentListService) Update(ctx context.Context, identifier string, params HostnameIPFSUniversalPathContentListUpdateParams, opts ...option.RequestOption) (res *ContentList, err error)

Update IPFS Universal Path Gateway Content List

type HostnameIPFSUniversalPathContentListUpdateParams 

type HostnameIPFSUniversalPathContentListUpdateParams struct {
	// Specify the identifier of the hostname.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Behavior of the content list.
	Action param.Field[HostnameIPFSUniversalPathContentListUpdateParamsAction] `json:"action,required"`
	// Provides content list entries.
	Entries param.Field[[]HostnameIPFSUniversalPathContentListUpdateParamsEntry] `json:"entries,required"`
}

func (HostnameIPFSUniversalPathContentListUpdateParams) MarshalJSON 

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

type HostnameIPFSUniversalPathContentListUpdateParamsAction 

type HostnameIPFSUniversalPathContentListUpdateParamsAction string

Behavior of the content list. 

const (
	HostnameIPFSUniversalPathContentListUpdateParamsActionBlock HostnameIPFSUniversalPathContentListUpdateParamsAction = "block"
)

func (HostnameIPFSUniversalPathContentListUpdateParamsAction) IsKnown 

func (r HostnameIPFSUniversalPathContentListUpdateParamsAction) IsKnown() bool

type HostnameIPFSUniversalPathContentListUpdateParamsEntriesType 

type HostnameIPFSUniversalPathContentListUpdateParamsEntriesType string

Specify the type of content list entry to block. 

const (
	HostnameIPFSUniversalPathContentListUpdateParamsEntriesTypeCid         HostnameIPFSUniversalPathContentListUpdateParamsEntriesType = "cid"
	HostnameIPFSUniversalPathContentListUpdateParamsEntriesTypeContentPath HostnameIPFSUniversalPathContentListUpdateParamsEntriesType = "content_path"
)

func (HostnameIPFSUniversalPathContentListUpdateParamsEntriesType) IsKnown 

func (r HostnameIPFSUniversalPathContentListUpdateParamsEntriesType) IsKnown() bool

type HostnameIPFSUniversalPathContentListUpdateParamsEntry 

type HostnameIPFSUniversalPathContentListUpdateParamsEntry struct {
	// Specify the CID or content path of content to block.
	Content param.Field[string] `json:"content"`
	// Specify an optional description of the content list entry.
	Description param.Field[string] `json:"description"`
	// Specify the type of content list entry to block.
	Type param.Field[HostnameIPFSUniversalPathContentListUpdateParamsEntriesType] `json:"type"`
}

Specify a content list entry to block.

func (HostnameIPFSUniversalPathContentListUpdateParamsEntry) MarshalJSON 

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

type HostnameIPFSUniversalPathContentListUpdateResponseEnvelope 

type HostnameIPFSUniversalPathContentListUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   ContentList           `json:"result,required"`
	// Specifies whether the API call was successful.
	Success HostnameIPFSUniversalPathContentListUpdateResponseEnvelopeSuccess `json:"success,required"`
	// Provides the API response.
	ResultInfo interface{}                                                    `json:"result_info"`
	JSON       hostnameIPFSUniversalPathContentListUpdateResponseEnvelopeJSON `json:"-"`
}

func (*HostnameIPFSUniversalPathContentListUpdateResponseEnvelope) UnmarshalJSON 

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

type HostnameIPFSUniversalPathContentListUpdateResponseEnvelopeSuccess 

type HostnameIPFSUniversalPathContentListUpdateResponseEnvelopeSuccess bool

Specifies whether the API call was successful. 

const (
	HostnameIPFSUniversalPathContentListUpdateResponseEnvelopeSuccessTrue HostnameIPFSUniversalPathContentListUpdateResponseEnvelopeSuccess = true
)

func (HostnameIPFSUniversalPathContentListUpdateResponseEnvelopeSuccess) IsKnown 

func (r HostnameIPFSUniversalPathContentListUpdateResponseEnvelopeSuccess) IsKnown() bool

type HostnameIPFSUniversalPathService 

type HostnameIPFSUniversalPathService struct {
	Options      []option.RequestOption
	ContentLists *HostnameIPFSUniversalPathContentListService
}

HostnameIPFSUniversalPathService 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 NewHostnameIPFSUniversalPathService method instead.

func NewHostnameIPFSUniversalPathService 

func NewHostnameIPFSUniversalPathService(opts ...option.RequestOption) (r *HostnameIPFSUniversalPathService)

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

type HostnameListParams 

type HostnameListParams struct {
	// Specify the identifier of the hostname.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type HostnameNewParams 

type HostnameNewParams struct {
	// Specify the identifier of the hostname.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Specify the hostname that points to the target gateway via CNAME.
	Name param.Field[string] `json:"name,required"`
	// Specify the target gateway of the hostname.
	Target param.Field[HostnameNewParamsTarget] `json:"target,required"`
	// Specify an optional description of the hostname.
	Description param.Field[string] `json:"description"`
	// Specify the DNSLink value used if the target is ipfs.
	Dnslink param.Field[string] `json:"dnslink"`
}

func (HostnameNewParams) MarshalJSON 

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

type HostnameNewParamsTarget 

type HostnameNewParamsTarget string

Specify the target gateway of the hostname. 

const (
	HostnameNewParamsTargetEthereum          HostnameNewParamsTarget = "ethereum"
	HostnameNewParamsTargetIPFS              HostnameNewParamsTarget = "ipfs"
	HostnameNewParamsTargetIPFSUniversalPath HostnameNewParamsTarget = "ipfs_universal_path"
)

func (HostnameNewParamsTarget) IsKnown 

func (r HostnameNewParamsTarget) IsKnown() bool

type HostnameNewResponseEnvelope 

type HostnameNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   Hostname              `json:"result,required"`
	// Specifies whether the API call was successful.
	Success HostnameNewResponseEnvelopeSuccess `json:"success,required"`
	// Provides the API response.
	ResultInfo interface{}                     `json:"result_info"`
	JSON       hostnameNewResponseEnvelopeJSON `json:"-"`
}

func (*HostnameNewResponseEnvelope) UnmarshalJSON 

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

type HostnameNewResponseEnvelopeSuccess 

type HostnameNewResponseEnvelopeSuccess bool

Specifies whether the API call was successful. 

const (
	HostnameNewResponseEnvelopeSuccessTrue HostnameNewResponseEnvelopeSuccess = true
)

func (HostnameNewResponseEnvelopeSuccess) IsKnown 

func (r HostnameNewResponseEnvelopeSuccess) IsKnown() bool

type HostnameService 

type HostnameService struct {
	Options            []option.RequestOption
	IPFSUniversalPaths *HostnameIPFSUniversalPathService
}

HostnameService 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 NewHostnameService method instead.

func NewHostnameService 

func NewHostnameService(opts ...option.RequestOption) (r *HostnameService)

NewHostnameService 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 (*HostnameService) Delete 

func (r *HostnameService) Delete(ctx context.Context, identifier string, body HostnameDeleteParams, opts ...option.RequestOption) (res *HostnameDeleteResponse, err error)

Delete Web3 Hostname

func (*HostnameService) Edit 

func (r *HostnameService) Edit(ctx context.Context, identifier string, params HostnameEditParams, opts ...option.RequestOption) (res *Hostname, err error)

Edit Web3 Hostname

func (*HostnameService) Get 

func (r *HostnameService) Get(ctx context.Context, identifier string, query HostnameGetParams, opts ...option.RequestOption) (res *Hostname, err error)

Web3 Hostname Details

func (*HostnameService) List 

func (r *HostnameService) List(ctx context.Context, query HostnameListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Hostname], err error)

List Web3 Hostnames

func (*HostnameService) ListAutoPaging 

func (r *HostnameService) ListAutoPaging(ctx context.Context, query HostnameListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Hostname]

List Web3 Hostnames

func (*HostnameService) New 

func (r *HostnameService) New(ctx context.Context, params HostnameNewParams, opts ...option.RequestOption) (res *Hostname, err error)

Create Web3 Hostname

type HostnameStatus 

type HostnameStatus string

Specifies the status of the hostname's activation. 

const (
	HostnameStatusActive   HostnameStatus = "active"
	HostnameStatusPending  HostnameStatus = "pending"
	HostnameStatusDeleting HostnameStatus = "deleting"
	HostnameStatusError    HostnameStatus = "error"
)

func (HostnameStatus) IsKnown 

func (r HostnameStatus) IsKnown() bool

type HostnameTarget 

type HostnameTarget string

Specify the target gateway of the hostname. 

const (
	HostnameTargetEthereum          HostnameTarget = "ethereum"
	HostnameTargetIPFS              HostnameTarget = "ipfs"
	HostnameTargetIPFSUniversalPath HostnameTarget = "ipfs_universal_path"
)

func (HostnameTarget) IsKnown 

func (r HostnameTarget) IsKnown() bool

type Member 

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess 

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup 

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

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

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta 

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup 

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta 

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope 

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

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

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject 

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

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

This is an alias to an internal type.

type MemberPolicy 

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser 

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type 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 

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam 

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource 

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type RoleParam 

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions 

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam 

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

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

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam 

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString 

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam 

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion 

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam 

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus 

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue 

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

type Web3Service 

type Web3Service struct {
	Options   []option.RequestOption
	Hostnames *HostnameService
}

Web3Service 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 NewWeb3Service method instead.

func NewWeb3Service 

func NewWeb3Service(opts ...option.RequestOption) (r *Web3Service)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.