available_rate_plans

Documentation

Index

• type AvailableRatePlanGetResponse
  • func (r *AvailableRatePlanGetResponse) UnmarshalJSON(data []byte) (err error)
• type AvailableRatePlanGetResponseComponent
  • func (r *AvailableRatePlanGetResponseComponent) UnmarshalJSON(data []byte) (err error)
• type AvailableRatePlanGetResponseComponentsName
• type AvailableRatePlanGetResponseEnvelope
  • func (r *AvailableRatePlanGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
• type AvailableRatePlanGetResponseEnvelopeErrors
  • func (r *AvailableRatePlanGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
• type AvailableRatePlanGetResponseEnvelopeMessages
  • func (r *AvailableRatePlanGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
• type AvailableRatePlanGetResponseEnvelopeResultInfo
  • func (r *AvailableRatePlanGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)
• type AvailableRatePlanGetResponseEnvelopeSuccess
• type AvailableRatePlanGetResponseFrequency
• type AvailableRatePlanService
  • func NewAvailableRatePlanService(opts ...option.RequestOption) (r *AvailableRatePlanService)
  • func (r *AvailableRatePlanService) Get(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *[]AvailableRatePlanGetResponse, err error)
• type Error

Types

type AvailableRatePlanGetResponse

type AvailableRatePlanGetResponse struct {
	// Plan identifier tag.
	ID string `json:"id"`
	// Array of available components values for the plan.
	Components []AvailableRatePlanGetResponseComponent `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 AvailableRatePlanGetResponseFrequency `json:"frequency"`
	// The plan name.
	Name string                           `json:"name"`
	JSON availableRatePlanGetResponseJSON `json:"-"`
}

func (*AvailableRatePlanGetResponse) UnmarshalJSON

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

type AvailableRatePlanGetResponseComponent

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

func (*AvailableRatePlanGetResponseComponent) UnmarshalJSON

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

type AvailableRatePlanGetResponseComponentsName

type AvailableRatePlanGetResponseComponentsName string

The unique component.

const (
	AvailableRatePlanGetResponseComponentsNameZones                       AvailableRatePlanGetResponseComponentsName = "zones"
	AvailableRatePlanGetResponseComponentsNamePageRules                   AvailableRatePlanGetResponseComponentsName = "page_rules"
	AvailableRatePlanGetResponseComponentsNameDedicatedCertificates       AvailableRatePlanGetResponseComponentsName = "dedicated_certificates"
	AvailableRatePlanGetResponseComponentsNameDedicatedCertificatesCustom AvailableRatePlanGetResponseComponentsName = "dedicated_certificates_custom"
)

type AvailableRatePlanGetResponseEnvelope

type AvailableRatePlanGetResponseEnvelope struct {
	Errors   []AvailableRatePlanGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AvailableRatePlanGetResponseEnvelopeMessages `json:"messages,required"`
	Result   []AvailableRatePlanGetResponse                 `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    AvailableRatePlanGetResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo AvailableRatePlanGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       availableRatePlanGetResponseEnvelopeJSON       `json:"-"`
}

func (*AvailableRatePlanGetResponseEnvelope) UnmarshalJSON

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

type AvailableRatePlanGetResponseEnvelopeErrors

type AvailableRatePlanGetResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    availableRatePlanGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*AvailableRatePlanGetResponseEnvelopeErrors) UnmarshalJSON

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

type AvailableRatePlanGetResponseEnvelopeMessages

type AvailableRatePlanGetResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    availableRatePlanGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*AvailableRatePlanGetResponseEnvelopeMessages) UnmarshalJSON

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

type AvailableRatePlanGetResponseEnvelopeResultInfo

type AvailableRatePlanGetResponseEnvelopeResultInfo 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       availableRatePlanGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*AvailableRatePlanGetResponseEnvelopeResultInfo) UnmarshalJSON

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

type AvailableRatePlanGetResponseEnvelopeSuccess

type AvailableRatePlanGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	AvailableRatePlanGetResponseEnvelopeSuccessTrue AvailableRatePlanGetResponseEnvelopeSuccess = true
)

type AvailableRatePlanGetResponseFrequency

type AvailableRatePlanGetResponseFrequency string

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

const (
	AvailableRatePlanGetResponseFrequencyWeekly    AvailableRatePlanGetResponseFrequency = "weekly"
	AvailableRatePlanGetResponseFrequencyMonthly   AvailableRatePlanGetResponseFrequency = "monthly"
	AvailableRatePlanGetResponseFrequencyQuarterly AvailableRatePlanGetResponseFrequency = "quarterly"
	AvailableRatePlanGetResponseFrequencyYearly    AvailableRatePlanGetResponseFrequency = "yearly"
)

type AvailableRatePlanService

type AvailableRatePlanService struct {
	Options []option.RequestOption
}

AvailableRatePlanService 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 NewAvailableRatePlanService method instead.

func NewAvailableRatePlanService

func NewAvailableRatePlanService(opts ...option.RequestOption) (r *AvailableRatePlanService)

NewAvailableRatePlanService 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 (*AvailableRatePlanService) Get

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

Lists all rate plans the zone can subscribe to.

type Error

type Error = apierror.Error