rate_plans

package
v2.0.0 Latest Latest
Warning

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

 Go to latest Published: Apr 12, 2024 License: Apache-2.0 Imports: 9 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 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 CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

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 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 struct {
	// Plan identifier tag.
	ID string `json:"id"`
	// Array of available components values for the plan.
	Components []RatePlanComponent `json:"components"`
	// The monetary unit in which pricing information is displayed.
	Currency string `json:"currency"`
	// The duration of the plan subscription.
	Duration float64 `json:"duration"`
	// The frequency at which you will be billed for this plan.
	Frequency RatePlanFrequency `json:"frequency"`
	// The plan name.
	Name string       `json:"name"`
	JSON ratePlanJSON `json:"-"`
}

func (*RatePlan) UnmarshalJSON 

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

type RatePlanComponent 

type RatePlanComponent struct {
	// The default amount allocated.
	Default float64 `json:"default"`
	// The unique component.
	Name RatePlanComponentsName `json:"name"`
	// The unit price of the addon.
	UnitPrice float64               `json:"unit_price"`
	JSON      ratePlanComponentJSON `json:"-"`
}

func (*RatePlanComponent) UnmarshalJSON 

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

type RatePlanComponentParam 

type RatePlanComponentParam struct {
	// The default amount allocated.
	Default param.Field[float64] `json:"default"`
	// The unique component.
	Name param.Field[RatePlanComponentsName] `json:"name"`
}

func (RatePlanComponentParam) MarshalJSON 

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

type RatePlanComponentsName 

type RatePlanComponentsName string

The unique component. 

const (
	RatePlanComponentsNameZones                       RatePlanComponentsName = "zones"
	RatePlanComponentsNamePageRules                   RatePlanComponentsName = "page_rules"
	RatePlanComponentsNameDedicatedCertificates       RatePlanComponentsName = "dedicated_certificates"
	RatePlanComponentsNameDedicatedCertificatesCustom RatePlanComponentsName = "dedicated_certificates_custom"
)

func (RatePlanComponentsName) IsKnown 

func (r RatePlanComponentsName) IsKnown() bool

type RatePlanFrequency 

type RatePlanFrequency string

The frequency at which you will be billed for this plan. 

const (
	RatePlanFrequencyWeekly    RatePlanFrequency = "weekly"
	RatePlanFrequencyMonthly   RatePlanFrequency = "monthly"
	RatePlanFrequencyQuarterly RatePlanFrequency = "quarterly"
	RatePlanFrequencyYearly    RatePlanFrequency = "yearly"
)

func (RatePlanFrequency) IsKnown 

func (r RatePlanFrequency) IsKnown() bool

type RatePlanGetResponseEnvelope 

type RatePlanGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   []RatePlan            `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    RatePlanGetResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo RatePlanGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       ratePlanGetResponseEnvelopeJSON       `json:"-"`
}

func (*RatePlanGetResponseEnvelope) UnmarshalJSON 

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

type RatePlanGetResponseEnvelopeResultInfo 

type RatePlanGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                   `json:"total_count"`
	JSON       ratePlanGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*RatePlanGetResponseEnvelopeResultInfo) UnmarshalJSON 

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

type RatePlanGetResponseEnvelopeSuccess 

type RatePlanGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RatePlanGetResponseEnvelopeSuccessTrue RatePlanGetResponseEnvelopeSuccess = true
)

func (RatePlanGetResponseEnvelopeSuccess) IsKnown 

func (r RatePlanGetResponseEnvelopeSuccess) IsKnown() bool

type RatePlanParam 

type RatePlanParam struct {
	// Array of available components values for the plan.
	Components param.Field[[]RatePlanComponentParam] `json:"components"`
	// The duration of the plan subscription.
	Duration param.Field[float64] `json:"duration"`
}

func (RatePlanParam) MarshalJSON 

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

type RatePlanService 

type RatePlanService struct {
	Options []option.RequestOption
}

RatePlanService 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 NewRatePlanService method instead.

func NewRatePlanService 

func NewRatePlanService(opts ...option.RequestOption) (r *RatePlanService)

NewRatePlanService 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 (*RatePlanService) Get 

func (r *RatePlanService) Get(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *[]RatePlan, err error)

Lists all rate plans the zone can subscribe to.

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 User 

type User = shared.User

This is an alias to an internal type.

type UserParam 

type UserParam = shared.UserParam

This is an alias to an internal type.

type UserRole 

type UserRole = shared.UserRole

This is an alias to an internal type.

type UserRoleParam 

type UserRoleParam = shared.UserRoleParam

This is an alias to an internal type.

type UserRolesPermissions 

type UserRolesPermissions = shared.UserRolesPermissions

This is an alias to an internal type.

type UserRolesPermissionsParam 

type UserRolesPermissionsParam = shared.UserRolesPermissionsParam

This is an alias to an internal type.

type UserUser 

type UserUser = shared.UserUser

This is an alias to an internal type.

type UserUserParam 

type UserUserParam = shared.UserUserParam

This is an alias to an internal type.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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