calls

package
v2.3.0 Latest Latest
Warning

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

 Go to latest Published: Jun 18, 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 CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

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.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

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 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 CallDeleteParams 

type CallDeleteParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

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 CallGetParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

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 CallListParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

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
	TURN    *TURNService
}

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[string], 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[string]

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 

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

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
	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 CloudflareTunnelStatus added in v2.3.0 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

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 MemberParam added in v2.1.0 

type MemberParam = shared.MemberParam

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 MemberRolesPermissionsParam added in v2.1.0 

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberStatus added in v2.3.0 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUserParam added in v2.1.0 

type MemberUserParam = shared.MemberUserParam

Details of the user associated to the membership.

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 SortDirection added in v2.2.0 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type TURNKeyDeleteParams added in v2.3.0 

type TURNKeyDeleteParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type TURNKeyDeleteResponseEnvelope added in v2.3.0 

type TURNKeyDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success TURNKeyDeleteResponseEnvelopeSuccess `json:"success,required"`
	// Bearer token
	Result string                            `json:"result"`
	JSON   turnKeyDeleteResponseEnvelopeJSON `json:"-"`
}

func (*TURNKeyDeleteResponseEnvelope) UnmarshalJSON added in v2.3.0 

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

type TURNKeyDeleteResponseEnvelopeSuccess added in v2.3.0 

type TURNKeyDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TURNKeyDeleteResponseEnvelopeSuccessTrue TURNKeyDeleteResponseEnvelopeSuccess = true
)

func (TURNKeyDeleteResponseEnvelopeSuccess) IsKnown added in v2.3.0 

func (r TURNKeyDeleteResponseEnvelopeSuccess) IsKnown() bool

type TURNKeyGetParams added in v2.3.0 

type TURNKeyGetParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type TURNKeyGetResponseEnvelope added in v2.3.0 

type TURNKeyGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success TURNKeyGetResponseEnvelopeSuccess `json:"success,required"`
	// Bearer token
	Result string                         `json:"result"`
	JSON   turnKeyGetResponseEnvelopeJSON `json:"-"`
}

func (*TURNKeyGetResponseEnvelope) UnmarshalJSON added in v2.3.0 

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

type TURNKeyGetResponseEnvelopeSuccess added in v2.3.0 

type TURNKeyGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TURNKeyGetResponseEnvelopeSuccessTrue TURNKeyGetResponseEnvelopeSuccess = true
)

func (TURNKeyGetResponseEnvelopeSuccess) IsKnown added in v2.3.0 

func (r TURNKeyGetResponseEnvelopeSuccess) IsKnown() bool

type TURNKeyListParams added in v2.3.0 

type TURNKeyListParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type TURNKeyNewParams added in v2.3.0 

type TURNKeyNewParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// A short description of a TURN key, not shown to end users.
	Name param.Field[string] `json:"name"`
}

func (TURNKeyNewParams) MarshalJSON added in v2.3.0 

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

type TURNKeyNewResponse added in v2.3.0 

type TURNKeyNewResponse struct {
	// The date and time the item was created.
	Created time.Time `json:"created" format:"date-time"`
	// Bearer token
	Key string `json:"key"`
	// The date and time the item was last modified.
	Modified time.Time `json:"modified" format:"date-time"`
	// A short description of a TURN key, not shown to end users.
	Name string `json:"name"`
	// A Cloudflare-generated unique identifier for a item.
	UID  string                 `json:"uid"`
	JSON turnKeyNewResponseJSON `json:"-"`
}

func (*TURNKeyNewResponse) UnmarshalJSON added in v2.3.0 

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

type TURNKeyService added in v2.3.0 

type TURNKeyService struct {
	Options []option.RequestOption
}

TURNKeyService 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 NewTURNKeyService method instead.

func NewTURNKeyService added in v2.3.0 

func NewTURNKeyService(opts ...option.RequestOption) (r *TURNKeyService)

NewTURNKeyService 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 (*TURNKeyService) Delete added in v2.3.0 

func (r *TURNKeyService) Delete(ctx context.Context, keyID string, body TURNKeyDeleteParams, opts ...option.RequestOption) (res *string, err error)

Deletes a TURN key from Cloudflare Calls

func (*TURNKeyService) Get added in v2.3.0 

func (r *TURNKeyService) Get(ctx context.Context, keyID string, query TURNKeyGetParams, opts ...option.RequestOption) (res *string, err error)

Fetches details for a single TURN key.

func (*TURNKeyService) List added in v2.3.0 

func (r *TURNKeyService) List(ctx context.Context, query TURNKeyListParams, opts ...option.RequestOption) (res *pagination.SinglePage[string], err error)

Lists all TURN keys in the Cloudflare account

func (*TURNKeyService) ListAutoPaging added in v2.3.0 

func (r *TURNKeyService) ListAutoPaging(ctx context.Context, query TURNKeyListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[string]

Lists all TURN keys in the Cloudflare account

func (*TURNKeyService) New added in v2.3.0 

func (r *TURNKeyService) New(ctx context.Context, params TURNKeyNewParams, opts ...option.RequestOption) (res *TURNKeyNewResponse, err error)

Creates a new Cloudflare Calls TURN key.

func (*TURNKeyService) Update added in v2.3.0 

func (r *TURNKeyService) Update(ctx context.Context, keyID string, params TURNKeyUpdateParams, opts ...option.RequestOption) (res *string, err error)

Edit details for a single TURN key.

type TURNKeyUpdateParams added in v2.3.0 

type TURNKeyUpdateParams struct {
	// The account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// A short description of a TURN key, not shown to end users.
	Name param.Field[string] `json:"name"`
}

func (TURNKeyUpdateParams) MarshalJSON added in v2.3.0 

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

type TURNKeyUpdateResponseEnvelope added in v2.3.0 

type TURNKeyUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success TURNKeyUpdateResponseEnvelopeSuccess `json:"success,required"`
	// Bearer token
	Result string                            `json:"result"`
	JSON   turnKeyUpdateResponseEnvelopeJSON `json:"-"`
}

func (*TURNKeyUpdateResponseEnvelope) UnmarshalJSON added in v2.3.0 

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

type TURNKeyUpdateResponseEnvelopeSuccess added in v2.3.0 

type TURNKeyUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TURNKeyUpdateResponseEnvelopeSuccessTrue TURNKeyUpdateResponseEnvelopeSuccess = true
)

func (TURNKeyUpdateResponseEnvelopeSuccess) IsKnown added in v2.3.0 

func (r TURNKeyUpdateResponseEnvelopeSuccess) IsKnown() bool

type TURNService added in v2.3.0 

type TURNService struct {
	Options []option.RequestOption
	Keys    *TURNKeyService
}

TURNService 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 NewTURNService method instead.

func NewTURNService added in v2.3.0 

func NewTURNService(opts ...option.RequestOption) (r *TURNService)

NewTURNService 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.

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.