Documentation ¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CallDeleteParams
- type CallDeleteResponseEnvelope
- type CallDeleteResponseEnvelopeSuccess
- type CallGetParams
- type CallGetResponseEnvelope
- type CallGetResponseEnvelopeSuccess
- type CallListParams
- type CallNewParams
- type CallNewResponseEnvelope
- type CallNewResponseEnvelopeSuccess
- type CallService
- func (r *CallService) Delete(ctx context.Context, appID string, body CallDeleteParams, ...) (res *CallsApp, err error)
- func (r *CallService) Get(ctx context.Context, appID string, query CallGetParams, ...) (res *CallsApp, err error)
- func (r *CallService) List(ctx context.Context, query CallListParams, opts ...option.RequestOption) (res *pagination.SinglePage[CallsApp], err error)
- func (r *CallService) ListAutoPaging(ctx context.Context, query CallListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[CallsApp]
- func (r *CallService) New(ctx context.Context, params CallNewParams, opts ...option.RequestOption) (res *CallsAppWithSecret, err error)
- func (r *CallService) Update(ctx context.Context, appID string, params CallUpdateParams, ...) (res *CallsApp, err error)
- type CallUpdateParams
- type CallUpdateResponseEnvelope
- type CallUpdateResponseEnvelopeSuccess
- type CallsApp
- type CallsAppWithSecret
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type Member
- type MemberParam
- type MemberRole
- type MemberRoleParam
- type MemberRolesPermissions
- type MemberRolesPermissionsParam
- type MemberUser
- type MemberUserParam
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type ResponseInfo
- type Role
- type SortDirection
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 CallDeleteParams ¶
type CallDeleteResponseEnvelope ¶
type CallDeleteResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` // Whether the API call was successful Success CallDeleteResponseEnvelopeSuccess `json:"success,required"` Result CallsApp `json:"result"` JSON callDeleteResponseEnvelopeJSON `json:"-"` }
func (*CallDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *CallDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CallDeleteResponseEnvelopeSuccess ¶
type CallDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
CallDeleteResponseEnvelopeSuccessTrue CallDeleteResponseEnvelopeSuccess = true
)
func (CallDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r CallDeleteResponseEnvelopeSuccess) IsKnown() bool
type CallGetParams ¶
type CallGetResponseEnvelope ¶
type CallGetResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` // Whether the API call was successful Success CallGetResponseEnvelopeSuccess `json:"success,required"` Result CallsApp `json:"result"` JSON callGetResponseEnvelopeJSON `json:"-"` }
func (*CallGetResponseEnvelope) UnmarshalJSON ¶
func (r *CallGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CallGetResponseEnvelopeSuccess ¶
type CallGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
CallGetResponseEnvelopeSuccessTrue CallGetResponseEnvelopeSuccess = true
)
func (CallGetResponseEnvelopeSuccess) IsKnown ¶
func (r CallGetResponseEnvelopeSuccess) IsKnown() bool
type CallListParams ¶
type CallNewParams ¶
type CallNewParams struct { // The account identifier tag. AccountID param.Field[string] `path:"account_id,required"` // A short description of Calls app, not shown to end users. Name param.Field[string] `json:"name"` }
func (CallNewParams) MarshalJSON ¶
func (r CallNewParams) MarshalJSON() (data []byte, err error)
type CallNewResponseEnvelope ¶
type CallNewResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` // Whether the API call was successful Success CallNewResponseEnvelopeSuccess `json:"success,required"` Result CallsAppWithSecret `json:"result"` JSON callNewResponseEnvelopeJSON `json:"-"` }
func (*CallNewResponseEnvelope) UnmarshalJSON ¶
func (r *CallNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CallNewResponseEnvelopeSuccess ¶
type CallNewResponseEnvelopeSuccess bool
Whether the API call was successful
const (
CallNewResponseEnvelopeSuccessTrue CallNewResponseEnvelopeSuccess = true
)
func (CallNewResponseEnvelopeSuccess) IsKnown ¶
func (r CallNewResponseEnvelopeSuccess) IsKnown() bool
type CallService ¶
type CallService struct {
Options []option.RequestOption
}
CallService 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 NewCallService method instead.
func NewCallService ¶
func NewCallService(opts ...option.RequestOption) (r *CallService)
NewCallService 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 (*CallService) Delete ¶
func (r *CallService) Delete(ctx context.Context, appID string, body CallDeleteParams, opts ...option.RequestOption) (res *CallsApp, err error)
Deletes an app from Cloudflare Calls
func (*CallService) Get ¶
func (r *CallService) Get(ctx context.Context, appID string, query CallGetParams, opts ...option.RequestOption) (res *CallsApp, err error)
Fetches details for a single Calls app.
func (*CallService) List ¶
func (r *CallService) List(ctx context.Context, query CallListParams, opts ...option.RequestOption) (res *pagination.SinglePage[CallsApp], err error)
Lists all apps in the Cloudflare account
func (*CallService) ListAutoPaging ¶
func (r *CallService) ListAutoPaging(ctx context.Context, query CallListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[CallsApp]
Lists all apps in the Cloudflare account
func (*CallService) New ¶
func (r *CallService) New(ctx context.Context, params CallNewParams, opts ...option.RequestOption) (res *CallsAppWithSecret, err error)
Creates a new Cloudflare calls app. An app is an unique enviroment where each Session can access all Tracks within the app.
func (*CallService) Update ¶
func (r *CallService) Update(ctx context.Context, appID string, params CallUpdateParams, opts ...option.RequestOption) (res *CallsApp, err error)
Edit details for a single app.
type CallUpdateParams ¶
type CallUpdateParams struct { // The account identifier tag. AccountID param.Field[string] `path:"account_id,required"` // A short description of Calls app, not shown to end users. Name param.Field[string] `json:"name"` }
func (CallUpdateParams) MarshalJSON ¶
func (r CallUpdateParams) MarshalJSON() (data []byte, err error)
type CallUpdateResponseEnvelope ¶
type CallUpdateResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` // Whether the API call was successful Success CallUpdateResponseEnvelopeSuccess `json:"success,required"` Result CallsApp `json:"result"` JSON callUpdateResponseEnvelopeJSON `json:"-"` }
func (*CallUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *CallUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CallUpdateResponseEnvelopeSuccess ¶
type CallUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
CallUpdateResponseEnvelopeSuccessTrue CallUpdateResponseEnvelopeSuccess = true
)
func (CallUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r CallUpdateResponseEnvelopeSuccess) IsKnown() bool
type CallsApp ¶
type CallsApp struct { // The date and time the item was created. Created time.Time `json:"created" format:"date-time"` // The date and time the item was last modified. Modified time.Time `json:"modified" format:"date-time"` // A short description of Calls app, not shown to end users. Name string `json:"name"` // A Cloudflare-generated unique identifier for a item. UID string `json:"uid"` JSON callsAppJSON `json:"-"` }
func (*CallsApp) UnmarshalJSON ¶
type CallsAppWithSecret ¶
type CallsAppWithSecret struct { // The date and time the item was created. Created time.Time `json:"created" format:"date-time"` // The date and time the item was last modified. Modified time.Time `json:"modified" format:"date-time"` // A short description of Calls app, not shown to end users. Name string `json:"name"` // Bearer token to use the Calls API. Secret string `json:"secret"` // A Cloudflare-generated unique identifier for a item. UID string `json:"uid"` JSON callsAppWithSecretJSON `json:"-"` }
func (*CallsAppWithSecret) UnmarshalJSON ¶
func (r *CallsAppWithSecret) UnmarshalJSON(data []byte) (err error)
type CertificateCA ¶ added in v2.2.0
type CertificateCA = shared.CertificateCA
The Certificate Authority that will issue the certificate
This is an alias to an internal type.
type CertificateRequestType ¶ added in v2.2.0
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 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 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 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 SortDirection ¶ added in v2.2.0
type SortDirection = shared.SortDirection
Direction to order DNS records in.
This is an alias to an internal type.