argo

type ASN ¶ added in v2.1.0

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam ¶ added in v2.1.0

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type ArgoService ¶

type ArgoService struct {
	Options       []option.RequestOption
	SmartRouting  *SmartRoutingService
	TieredCaching *TieredCachingService
}

ArgoService 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 NewArgoService method instead.

func NewArgoService(opts ...option.RequestOption) (r *ArgoService)

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 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 CloudflareTunnelTunType ¶

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error ¶

type Error = apierror.Error

type ErrorData ¶

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type Member ¶ added in v2.1.0

type Member = shared.Member

This is an alias to an internal type.

type MemberParam ¶ added in v2.1.0

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRole ¶ added in v2.1.0

type MemberRole = shared.MemberRole

This is an alias to an internal type.

type MemberRoleParam ¶ added in v2.1.0

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissions ¶ added in v2.1.0

type MemberRolesPermissions = shared.MemberRolesPermissions

This is an alias to an internal type.

type MemberRolesPermissionsParam ¶ added in v2.1.0

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberUser ¶ added in v2.1.0

type MemberUser = shared.MemberUser

This is an alias to an internal type.

type MemberUserParam ¶ added in v2.1.0

type MemberUserParam = shared.MemberUserParam

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 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 SmartRoutingEditParams ¶

type SmartRoutingEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Enables Argo Smart Routing.
	Value param.Field[SmartRoutingEditParamsValue] `json:"value,required"`
}

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

type SmartRoutingEditParamsValue ¶

type SmartRoutingEditParamsValue string

Enables Argo Smart Routing.

const (
	SmartRoutingEditParamsValueOn  SmartRoutingEditParamsValue = "on"
	SmartRoutingEditParamsValueOff SmartRoutingEditParamsValue = "off"
)

func (r SmartRoutingEditParamsValue) IsKnown() bool

type SmartRoutingEditResponseEnvelope ¶

type SmartRoutingEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo         `json:"errors,required"`
	Messages []shared.ResponseInfo         `json:"messages,required"`
	Result   SmartRoutingEditResponseUnion `json:"result,required"`
	// Whether the API call was successful
	Success SmartRoutingEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    smartRoutingEditResponseEnvelopeJSON    `json:"-"`
}

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

type SmartRoutingEditResponseEnvelopeSuccess ¶

type SmartRoutingEditResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	SmartRoutingEditResponseEnvelopeSuccessTrue SmartRoutingEditResponseEnvelopeSuccess = true
)

func (r SmartRoutingEditResponseEnvelopeSuccess) IsKnown() bool

type SmartRoutingEditResponseUnion ¶

type SmartRoutingEditResponseUnion interface {
	ImplementsArgoSmartRoutingEditResponseUnion()
}

Union satisfied by argo.SmartRoutingEditResponseUnknown or shared.UnionString.

type SmartRoutingGetParams ¶

type SmartRoutingGetParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type SmartRoutingGetResponseEnvelope ¶

type SmartRoutingGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo        `json:"errors,required"`
	Messages []shared.ResponseInfo        `json:"messages,required"`
	Result   SmartRoutingGetResponseUnion `json:"result,required"`
	// Whether the API call was successful
	Success SmartRoutingGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    smartRoutingGetResponseEnvelopeJSON    `json:"-"`
}

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

type SmartRoutingGetResponseEnvelopeSuccess ¶

type SmartRoutingGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	SmartRoutingGetResponseEnvelopeSuccessTrue SmartRoutingGetResponseEnvelopeSuccess = true
)

func (r SmartRoutingGetResponseEnvelopeSuccess) IsKnown() bool

type SmartRoutingGetResponseUnion ¶

type SmartRoutingGetResponseUnion interface {
	ImplementsArgoSmartRoutingGetResponseUnion()
}

Union satisfied by argo.SmartRoutingGetResponseUnknown or shared.UnionString.

type SmartRoutingService ¶

type SmartRoutingService struct {
	Options []option.RequestOption
}

SmartRoutingService 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 NewSmartRoutingService method instead.

func NewSmartRoutingService(opts ...option.RequestOption) (r *SmartRoutingService)

func (r *SmartRoutingService) Edit(ctx context.Context, params SmartRoutingEditParams, opts ...option.RequestOption) (res *SmartRoutingEditResponseUnion, err error)

func (r *SmartRoutingService) Get(ctx context.Context, query SmartRoutingGetParams, opts ...option.RequestOption) (res *SmartRoutingGetResponseUnion, err error)

type TieredCachingEditParams ¶

type TieredCachingEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Enables Tiered Caching.
	Value param.Field[TieredCachingEditParamsValue] `json:"value,required"`
}

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

type TieredCachingEditParamsValue ¶

type TieredCachingEditParamsValue string

Enables Tiered Caching.

const (
	TieredCachingEditParamsValueOn  TieredCachingEditParamsValue = "on"
	TieredCachingEditParamsValueOff TieredCachingEditParamsValue = "off"
)

func (r TieredCachingEditParamsValue) IsKnown() bool

type TieredCachingEditResponseEnvelope ¶

type TieredCachingEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo          `json:"errors,required"`
	Messages []shared.ResponseInfo          `json:"messages,required"`
	Result   TieredCachingEditResponseUnion `json:"result,required"`
	// Whether the API call was successful
	Success TieredCachingEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    tieredCachingEditResponseEnvelopeJSON    `json:"-"`
}

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

type TieredCachingEditResponseEnvelopeSuccess ¶

type TieredCachingEditResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	TieredCachingEditResponseEnvelopeSuccessTrue TieredCachingEditResponseEnvelopeSuccess = true
)

func (r TieredCachingEditResponseEnvelopeSuccess) IsKnown() bool

type TieredCachingEditResponseUnion ¶

type TieredCachingEditResponseUnion interface {
	ImplementsArgoTieredCachingEditResponseUnion()
}

Union satisfied by argo.TieredCachingEditResponseUnknown or shared.UnionString.

type TieredCachingGetParams ¶

type TieredCachingGetParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type TieredCachingGetResponseEnvelope ¶

type TieredCachingGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo         `json:"errors,required"`
	Messages []shared.ResponseInfo         `json:"messages,required"`
	Result   TieredCachingGetResponseUnion `json:"result,required"`
	// Whether the API call was successful
	Success TieredCachingGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    tieredCachingGetResponseEnvelopeJSON    `json:"-"`
}

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

type TieredCachingGetResponseEnvelopeSuccess ¶

type TieredCachingGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	TieredCachingGetResponseEnvelopeSuccessTrue TieredCachingGetResponseEnvelopeSuccess = true
)

func (r TieredCachingGetResponseEnvelopeSuccess) IsKnown() bool

type TieredCachingGetResponseUnion ¶

type TieredCachingGetResponseUnion interface {
	ImplementsArgoTieredCachingGetResponseUnion()
}

Union satisfied by argo.TieredCachingGetResponseUnknown or shared.UnionString.

type TieredCachingService ¶

type TieredCachingService struct {
	Options []option.RequestOption
}

TieredCachingService 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 NewTieredCachingService method instead.

func NewTieredCachingService(opts ...option.RequestOption) (r *TieredCachingService)

func (r *TieredCachingService) Edit(ctx context.Context, params TieredCachingEditParams, opts ...option.RequestOption) (res *TieredCachingEditResponseUnion, err error)

func (r *TieredCachingService) Get(ctx context.Context, query TieredCachingGetParams, opts ...option.RequestOption) (res *TieredCachingGetResponseUnion, err error)