subscriptions

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: 12 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 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 SubscriptionDeleteParams 

type SubscriptionDeleteParams struct {
	Body interface{} `json:"body,required"`
}

func (SubscriptionDeleteParams) MarshalJSON 

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

type SubscriptionDeleteResponse 

type SubscriptionDeleteResponse struct {
	// Subscription identifier tag.
	SubscriptionID string                         `json:"subscription_id"`
	JSON           subscriptionDeleteResponseJSON `json:"-"`
}

func (*SubscriptionDeleteResponse) UnmarshalJSON 

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

type SubscriptionDeleteResponseEnvelope 

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

func (*SubscriptionDeleteResponseEnvelope) UnmarshalJSON 

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

type SubscriptionDeleteResponseEnvelopeSuccess 

type SubscriptionDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SubscriptionDeleteResponseEnvelopeSuccessTrue SubscriptionDeleteResponseEnvelopeSuccess = true
)

func (SubscriptionDeleteResponseEnvelopeSuccess) IsKnown 

func (r SubscriptionDeleteResponseEnvelopeSuccess) IsKnown() bool

type SubscriptionGetResponseEnvelope 

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

func (*SubscriptionGetResponseEnvelope) UnmarshalJSON 

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

type SubscriptionGetResponseEnvelopeSuccess 

type SubscriptionGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SubscriptionGetResponseEnvelopeSuccessTrue SubscriptionGetResponseEnvelopeSuccess = true
)

func (SubscriptionGetResponseEnvelopeSuccess) IsKnown 

func (r SubscriptionGetResponseEnvelopeSuccess) IsKnown() bool

type SubscriptionGetResponseUnion 

type SubscriptionGetResponseUnion interface {
	ImplementsSubscriptionsSubscriptionGetResponseUnion()
}

Union satisfied by subscriptions.SubscriptionGetResponseUnknown or shared.UnionString.

type SubscriptionNewParams 

type SubscriptionNewParams struct {
	Subscription user.SubscriptionParam `json:"subscription,required"`
}

func (SubscriptionNewParams) MarshalJSON 

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

type SubscriptionNewResponseEnvelope 

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

func (*SubscriptionNewResponseEnvelope) UnmarshalJSON 

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

type SubscriptionNewResponseEnvelopeSuccess 

type SubscriptionNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SubscriptionNewResponseEnvelopeSuccessTrue SubscriptionNewResponseEnvelopeSuccess = true
)

func (SubscriptionNewResponseEnvelopeSuccess) IsKnown 

func (r SubscriptionNewResponseEnvelopeSuccess) IsKnown() bool

type SubscriptionNewResponseUnion 

type SubscriptionNewResponseUnion interface {
	ImplementsSubscriptionsSubscriptionNewResponseUnion()
}

Union satisfied by subscriptions.SubscriptionNewResponseUnknown or shared.UnionString.

type SubscriptionService 

type SubscriptionService struct {
	Options []option.RequestOption
}

SubscriptionService 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 NewSubscriptionService method instead.

func NewSubscriptionService 

func NewSubscriptionService(opts ...option.RequestOption) (r *SubscriptionService)

NewSubscriptionService 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 (*SubscriptionService) Delete 

func (r *SubscriptionService) Delete(ctx context.Context, accountIdentifier string, subscriptionIdentifier string, body SubscriptionDeleteParams, opts ...option.RequestOption) (res *SubscriptionDeleteResponse, err error)

Deletes an account's subscription.

func (*SubscriptionService) Get 

func (r *SubscriptionService) Get(ctx context.Context, identifier string, opts ...option.RequestOption) (res *SubscriptionGetResponseUnion, err error)

Lists zone subscription details.

func (*SubscriptionService) List 

func (r *SubscriptionService) List(ctx context.Context, accountIdentifier string, opts ...option.RequestOption) (res *pagination.SinglePage[user.Subscription], err error)

Lists all of an account's subscriptions.

func (*SubscriptionService) ListAutoPaging 

func (r *SubscriptionService) ListAutoPaging(ctx context.Context, accountIdentifier string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[user.Subscription]

Lists all of an account's subscriptions.

func (*SubscriptionService) New 

func (r *SubscriptionService) New(ctx context.Context, identifier string, body SubscriptionNewParams, opts ...option.RequestOption) (res *SubscriptionNewResponseUnion, err error)

Create a zone subscription, either plan or add-ons.

func (*SubscriptionService) Update 

func (r *SubscriptionService) Update(ctx context.Context, accountIdentifier string, subscriptionIdentifier string, body SubscriptionUpdateParams, opts ...option.RequestOption) (res *SubscriptionUpdateResponseUnion, err error)

Updates an account subscription.

type SubscriptionUpdateParams 

type SubscriptionUpdateParams struct {
	Subscription user.SubscriptionParam `json:"subscription,required"`
}

func (SubscriptionUpdateParams) MarshalJSON 

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

type SubscriptionUpdateResponseEnvelope 

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

func (*SubscriptionUpdateResponseEnvelope) UnmarshalJSON 

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

type SubscriptionUpdateResponseEnvelopeSuccess 

type SubscriptionUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SubscriptionUpdateResponseEnvelopeSuccessTrue SubscriptionUpdateResponseEnvelopeSuccess = true
)

func (SubscriptionUpdateResponseEnvelopeSuccess) IsKnown 

func (r SubscriptionUpdateResponseEnvelopeSuccess) IsKnown() bool

type SubscriptionUpdateResponseUnion 

type SubscriptionUpdateResponseUnion interface {
	ImplementsSubscriptionsSubscriptionUpdateResponseUnion()
}

Union satisfied by subscriptions.SubscriptionUpdateResponseUnknown or shared.UnionString.

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.