calls

package
v7.4.0 Latest Latest
Warning

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

 Go to latest Published: May 29, 2026 License: Apache-2.0 Imports: 13 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 CertificateCASSLCom = shared.CertificateCASSLCom

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 CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

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 CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

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 MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

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 RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source 
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source 
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source 
const RatePlanIDProPlus = shared.RatePlanIDProPlus

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.

View Source 
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source 
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source 
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source 
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source 
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source 
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source 
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source 
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source 
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source 
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source 
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source 
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source 
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ASN ¶ 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam ¶ 

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 CallService ¶ 

type CallService struct {
	Options []option.RequestOption
	SFU     *SFUService
	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.

type CertificateCA ¶ 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate.

This is an alias to an internal type.

type CertificateRequestType ¶ 

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 CloudflareTunnelConfigSrc ¶ 

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

This is an alias to an internal type.

type CloudflareTunnelConnection ¶ 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus ¶ 

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 ErrorDataSource ¶ 

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type Member ¶ 

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess ¶ 

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup ¶ 

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta ¶ 

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup ¶ 

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta ¶ 

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope ¶ 

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject ¶ 

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy ¶ 

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus ¶ 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser ¶ 

type MemberUser = shared.MemberUser

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 RatePlan ¶ 

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID ¶ 

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam ¶ 

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo ¶ 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource ¶ 

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role ¶ 

type Role = shared.Role

This is an alias to an internal type.

type RoleParam ¶ 

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions ¶ 

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam ¶ 

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SFUDeleteParams ¶ 

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

type SFUDeleteResponse ¶ 

type SFUDeleteResponse 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 sfuDeleteResponseJSON `json:"-"`
}

func (*SFUDeleteResponse) UnmarshalJSON ¶ 

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

type SFUDeleteResponseEnvelope ¶ 

type SFUDeleteResponseEnvelope struct {
	Errors   []SFUDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SFUDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SFUDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SFUDeleteResponse                `json:"result"`
	JSON    sfuDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*SFUDeleteResponseEnvelope) UnmarshalJSON ¶ 

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

type SFUDeleteResponseEnvelopeErrors ¶ 

type SFUDeleteResponseEnvelopeErrors struct {
	Code             int64                                 `json:"code" api:"required"`
	Message          string                                `json:"message" api:"required"`
	DocumentationURL string                                `json:"documentation_url"`
	Source           SFUDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             sfuDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SFUDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ 

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

type SFUDeleteResponseEnvelopeErrorsSource ¶ 

type SFUDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                    `json:"pointer"`
	JSON    sfuDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SFUDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

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

type SFUDeleteResponseEnvelopeMessages ¶ 

type SFUDeleteResponseEnvelopeMessages struct {
	Code             int64                                   `json:"code" api:"required"`
	Message          string                                  `json:"message" api:"required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           SFUDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             sfuDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SFUDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ 

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

type SFUDeleteResponseEnvelopeMessagesSource ¶ 

type SFUDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    sfuDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SFUDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

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

type SFUDeleteResponseEnvelopeSuccess ¶ 

type SFUDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SFUDeleteResponseEnvelopeSuccessTrue SFUDeleteResponseEnvelopeSuccess = true
)

func (SFUDeleteResponseEnvelopeSuccess) IsKnown ¶ 

func (r SFUDeleteResponseEnvelopeSuccess) IsKnown() bool

type SFUGetParams ¶ 

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

type SFUGetResponse ¶ 

type SFUGetResponse 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 sfuGetResponseJSON `json:"-"`
}

func (*SFUGetResponse) UnmarshalJSON ¶ 

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

type SFUGetResponseEnvelope ¶ 

type SFUGetResponseEnvelope struct {
	Errors   []SFUGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SFUGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SFUGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SFUGetResponse                `json:"result"`
	JSON    sfuGetResponseEnvelopeJSON    `json:"-"`
}

func (*SFUGetResponseEnvelope) UnmarshalJSON ¶ 

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

type SFUGetResponseEnvelopeErrors ¶ 

type SFUGetResponseEnvelopeErrors struct {
	Code             int64                              `json:"code" api:"required"`
	Message          string                             `json:"message" api:"required"`
	DocumentationURL string                             `json:"documentation_url"`
	Source           SFUGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             sfuGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SFUGetResponseEnvelopeErrors) UnmarshalJSON ¶ 

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

type SFUGetResponseEnvelopeErrorsSource ¶ 

type SFUGetResponseEnvelopeErrorsSource struct {
	Pointer string                                 `json:"pointer"`
	JSON    sfuGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SFUGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

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

type SFUGetResponseEnvelopeMessages ¶ 

type SFUGetResponseEnvelopeMessages struct {
	Code             int64                                `json:"code" api:"required"`
	Message          string                               `json:"message" api:"required"`
	DocumentationURL string                               `json:"documentation_url"`
	Source           SFUGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             sfuGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SFUGetResponseEnvelopeMessages) UnmarshalJSON ¶ 

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

type SFUGetResponseEnvelopeMessagesSource ¶ 

type SFUGetResponseEnvelopeMessagesSource struct {
	Pointer string                                   `json:"pointer"`
	JSON    sfuGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SFUGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

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

type SFUGetResponseEnvelopeSuccess ¶ 

type SFUGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SFUGetResponseEnvelopeSuccessTrue SFUGetResponseEnvelopeSuccess = true
)

func (SFUGetResponseEnvelopeSuccess) IsKnown ¶ 

func (r SFUGetResponseEnvelopeSuccess) IsKnown() bool

type SFUListParams ¶ 

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

type SFUListResponse ¶ 

type SFUListResponse 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 sfuListResponseJSON `json:"-"`
}

func (*SFUListResponse) UnmarshalJSON ¶ 

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

type SFUNewParams ¶ 

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

func (SFUNewParams) MarshalJSON ¶ 

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

type SFUNewResponse ¶ 

type SFUNewResponse 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 sfuNewResponseJSON `json:"-"`
}

func (*SFUNewResponse) UnmarshalJSON ¶ 

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

type SFUNewResponseEnvelope ¶ 

type SFUNewResponseEnvelope struct {
	Errors   []SFUNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SFUNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SFUNewResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SFUNewResponse                `json:"result"`
	JSON    sfuNewResponseEnvelopeJSON    `json:"-"`
}

func (*SFUNewResponseEnvelope) UnmarshalJSON ¶ 

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

type SFUNewResponseEnvelopeErrors ¶ 

type SFUNewResponseEnvelopeErrors struct {
	Code             int64                              `json:"code" api:"required"`
	Message          string                             `json:"message" api:"required"`
	DocumentationURL string                             `json:"documentation_url"`
	Source           SFUNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             sfuNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SFUNewResponseEnvelopeErrors) UnmarshalJSON ¶ 

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

type SFUNewResponseEnvelopeErrorsSource ¶ 

type SFUNewResponseEnvelopeErrorsSource struct {
	Pointer string                                 `json:"pointer"`
	JSON    sfuNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SFUNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

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

type SFUNewResponseEnvelopeMessages ¶ 

type SFUNewResponseEnvelopeMessages struct {
	Code             int64                                `json:"code" api:"required"`
	Message          string                               `json:"message" api:"required"`
	DocumentationURL string                               `json:"documentation_url"`
	Source           SFUNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             sfuNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SFUNewResponseEnvelopeMessages) UnmarshalJSON ¶ 

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

type SFUNewResponseEnvelopeMessagesSource ¶ 

type SFUNewResponseEnvelopeMessagesSource struct {
	Pointer string                                   `json:"pointer"`
	JSON    sfuNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SFUNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

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

type SFUNewResponseEnvelopeSuccess ¶ 

type SFUNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SFUNewResponseEnvelopeSuccessTrue SFUNewResponseEnvelopeSuccess = true
)

func (SFUNewResponseEnvelopeSuccess) IsKnown ¶ 

func (r SFUNewResponseEnvelopeSuccess) IsKnown() bool

type SFUService ¶ 

type SFUService struct {
	Options []option.RequestOption
}

SFUService 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 NewSFUService method instead.

func NewSFUService ¶ 

func NewSFUService(opts ...option.RequestOption) (r *SFUService)

NewSFUService 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 (*SFUService) Delete ¶ 

func (r *SFUService) Delete(ctx context.Context, appID string, body SFUDeleteParams, opts ...option.RequestOption) (res *SFUDeleteResponse, err error)

Deletes an app from Cloudflare Calls

func (*SFUService) Get ¶ 

func (r *SFUService) Get(ctx context.Context, appID string, query SFUGetParams, opts ...option.RequestOption) (res *SFUGetResponse, err error)

Fetches details for a single Calls app.

func (*SFUService) List ¶ 

func (r *SFUService) List(ctx context.Context, query SFUListParams, opts ...option.RequestOption) (res *pagination.SinglePage[SFUListResponse], err error)

Lists all apps in the Cloudflare account

func (*SFUService) ListAutoPaging ¶ 

func (r *SFUService) ListAutoPaging(ctx context.Context, query SFUListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[SFUListResponse]

Lists all apps in the Cloudflare account

func (*SFUService) New ¶ 

func (r *SFUService) New(ctx context.Context, params SFUNewParams, opts ...option.RequestOption) (res *SFUNewResponse, 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 (*SFUService) Update ¶ 

func (r *SFUService) Update(ctx context.Context, appID string, params SFUUpdateParams, opts ...option.RequestOption) (res *SFUUpdateResponse, err error)

Edit details for a single app.

type SFUUpdateParams ¶ 

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

func (SFUUpdateParams) MarshalJSON ¶ 

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

type SFUUpdateResponse ¶ 

type SFUUpdateResponse 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 sfuUpdateResponseJSON `json:"-"`
}

func (*SFUUpdateResponse) UnmarshalJSON ¶ 

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

type SFUUpdateResponseEnvelope ¶ 

type SFUUpdateResponseEnvelope struct {
	Errors   []SFUUpdateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SFUUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SFUUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SFUUpdateResponse                `json:"result"`
	JSON    sfuUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*SFUUpdateResponseEnvelope) UnmarshalJSON ¶ 

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

type SFUUpdateResponseEnvelopeErrors ¶ 

type SFUUpdateResponseEnvelopeErrors struct {
	Code             int64                                 `json:"code" api:"required"`
	Message          string                                `json:"message" api:"required"`
	DocumentationURL string                                `json:"documentation_url"`
	Source           SFUUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             sfuUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SFUUpdateResponseEnvelopeErrors) UnmarshalJSON ¶ 

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

type SFUUpdateResponseEnvelopeErrorsSource ¶ 

type SFUUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                    `json:"pointer"`
	JSON    sfuUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SFUUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

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

type SFUUpdateResponseEnvelopeMessages ¶ 

type SFUUpdateResponseEnvelopeMessages struct {
	Code             int64                                   `json:"code" api:"required"`
	Message          string                                  `json:"message" api:"required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           SFUUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             sfuUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SFUUpdateResponseEnvelopeMessages) UnmarshalJSON ¶ 

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

type SFUUpdateResponseEnvelopeMessagesSource ¶ 

type SFUUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    sfuUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SFUUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

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

type SFUUpdateResponseEnvelopeSuccess ¶ 

type SFUUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	SFUUpdateResponseEnvelopeSuccessTrue SFUUpdateResponseEnvelopeSuccess = true
)

func (SFUUpdateResponseEnvelopeSuccess) IsKnown ¶ 

func (r SFUUpdateResponseEnvelopeSuccess) IsKnown() bool

type SortDirection ¶ 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription ¶ 

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency ¶ 

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam ¶ 

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState ¶ 

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type TURNDeleteParams ¶ 

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

type TURNDeleteResponse ¶ 

type TURNDeleteResponse 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 turnDeleteResponseJSON `json:"-"`
}

func (*TURNDeleteResponse) UnmarshalJSON ¶ 

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

type TURNDeleteResponseEnvelope ¶ 

type TURNDeleteResponseEnvelope struct {
	Errors   []TURNDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []TURNDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success TURNDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  TURNDeleteResponse                `json:"result"`
	JSON    turnDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*TURNDeleteResponseEnvelope) UnmarshalJSON ¶ 

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

type TURNDeleteResponseEnvelopeErrors ¶ 

type TURNDeleteResponseEnvelopeErrors struct {
	Code             int64                                  `json:"code" api:"required"`
	Message          string                                 `json:"message" api:"required"`
	DocumentationURL string                                 `json:"documentation_url"`
	Source           TURNDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             turnDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*TURNDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ 

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

type TURNDeleteResponseEnvelopeErrorsSource ¶ 

type TURNDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                     `json:"pointer"`
	JSON    turnDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*TURNDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

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

type TURNDeleteResponseEnvelopeMessages ¶ 

type TURNDeleteResponseEnvelopeMessages struct {
	Code             int64                                    `json:"code" api:"required"`
	Message          string                                   `json:"message" api:"required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           TURNDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             turnDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*TURNDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ 

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

type TURNDeleteResponseEnvelopeMessagesSource ¶ 

type TURNDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    turnDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*TURNDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

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

type TURNDeleteResponseEnvelopeSuccess ¶ 

type TURNDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	TURNDeleteResponseEnvelopeSuccessTrue TURNDeleteResponseEnvelopeSuccess = true
)

func (TURNDeleteResponseEnvelopeSuccess) IsKnown ¶ 

func (r TURNDeleteResponseEnvelopeSuccess) IsKnown() bool

type TURNGetParams ¶ 

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

type TURNGetResponse ¶ 

type TURNGetResponse 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 turnGetResponseJSON `json:"-"`
}

func (*TURNGetResponse) UnmarshalJSON ¶ 

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

type TURNGetResponseEnvelope ¶ 

type TURNGetResponseEnvelope struct {
	Errors   []TURNGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []TURNGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success TURNGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  TURNGetResponse                `json:"result"`
	JSON    turnGetResponseEnvelopeJSON    `json:"-"`
}

func (*TURNGetResponseEnvelope) UnmarshalJSON ¶ 

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

type TURNGetResponseEnvelopeErrors ¶ 

type TURNGetResponseEnvelopeErrors struct {
	Code             int64                               `json:"code" api:"required"`
	Message          string                              `json:"message" api:"required"`
	DocumentationURL string                              `json:"documentation_url"`
	Source           TURNGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             turnGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*TURNGetResponseEnvelopeErrors) UnmarshalJSON ¶ 

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

type TURNGetResponseEnvelopeErrorsSource ¶ 

type TURNGetResponseEnvelopeErrorsSource struct {
	Pointer string                                  `json:"pointer"`
	JSON    turnGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*TURNGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

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

type TURNGetResponseEnvelopeMessages ¶ 

type TURNGetResponseEnvelopeMessages struct {
	Code             int64                                 `json:"code" api:"required"`
	Message          string                                `json:"message" api:"required"`
	DocumentationURL string                                `json:"documentation_url"`
	Source           TURNGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             turnGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*TURNGetResponseEnvelopeMessages) UnmarshalJSON ¶ 

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

type TURNGetResponseEnvelopeMessagesSource ¶ 

type TURNGetResponseEnvelopeMessagesSource struct {
	Pointer string                                    `json:"pointer"`
	JSON    turnGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*TURNGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

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

type TURNGetResponseEnvelopeSuccess ¶ 

type TURNGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	TURNGetResponseEnvelopeSuccessTrue TURNGetResponseEnvelopeSuccess = true
)

func (TURNGetResponseEnvelopeSuccess) IsKnown ¶ 

func (r TURNGetResponseEnvelopeSuccess) IsKnown() bool

type TURNListParams ¶ 

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

type TURNListResponse ¶ 

type TURNListResponse 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 turnListResponseJSON `json:"-"`
}

func (*TURNListResponse) UnmarshalJSON ¶ 

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

type TURNNewParams ¶ 

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

func (TURNNewParams) MarshalJSON ¶ 

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

type TURNNewResponse ¶ 

type TURNNewResponse 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 turnNewResponseJSON `json:"-"`
}

func (*TURNNewResponse) UnmarshalJSON ¶ 

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

type TURNNewResponseEnvelope ¶ 

type TURNNewResponseEnvelope struct {
	Errors   []TURNNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []TURNNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success TURNNewResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  TURNNewResponse                `json:"result"`
	JSON    turnNewResponseEnvelopeJSON    `json:"-"`
}

func (*TURNNewResponseEnvelope) UnmarshalJSON ¶ 

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

type TURNNewResponseEnvelopeErrors ¶ 

type TURNNewResponseEnvelopeErrors struct {
	Code             int64                               `json:"code" api:"required"`
	Message          string                              `json:"message" api:"required"`
	DocumentationURL string                              `json:"documentation_url"`
	Source           TURNNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             turnNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*TURNNewResponseEnvelopeErrors) UnmarshalJSON ¶ 

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

type TURNNewResponseEnvelopeErrorsSource ¶ 

type TURNNewResponseEnvelopeErrorsSource struct {
	Pointer string                                  `json:"pointer"`
	JSON    turnNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*TURNNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

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

type TURNNewResponseEnvelopeMessages ¶ 

type TURNNewResponseEnvelopeMessages struct {
	Code             int64                                 `json:"code" api:"required"`
	Message          string                                `json:"message" api:"required"`
	DocumentationURL string                                `json:"documentation_url"`
	Source           TURNNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             turnNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*TURNNewResponseEnvelopeMessages) UnmarshalJSON ¶ 

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

type TURNNewResponseEnvelopeMessagesSource ¶ 

type TURNNewResponseEnvelopeMessagesSource struct {
	Pointer string                                    `json:"pointer"`
	JSON    turnNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*TURNNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

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

type TURNNewResponseEnvelopeSuccess ¶ 

type TURNNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	TURNNewResponseEnvelopeSuccessTrue TURNNewResponseEnvelopeSuccess = true
)

func (TURNNewResponseEnvelopeSuccess) IsKnown ¶ 

func (r TURNNewResponseEnvelopeSuccess) IsKnown() bool

type TURNService ¶ 

type TURNService struct {
	Options []option.RequestOption
}

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 ¶ 

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.

func (*TURNService) Delete ¶ 

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

Deletes a TURN key from Cloudflare Calls

func (*TURNService) Get ¶ 

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

Fetches details for a single TURN key.

func (*TURNService) List ¶ 

func (r *TURNService) List(ctx context.Context, query TURNListParams, opts ...option.RequestOption) (res *pagination.SinglePage[TURNListResponse], err error)

Lists all TURN keys in the Cloudflare account

func (*TURNService) ListAutoPaging ¶ 

func (r *TURNService) ListAutoPaging(ctx context.Context, query TURNListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[TURNListResponse]

Lists all TURN keys in the Cloudflare account

func (*TURNService) New ¶ 

func (r *TURNService) New(ctx context.Context, params TURNNewParams, opts ...option.RequestOption) (res *TURNNewResponse, err error)

Creates a new Cloudflare Calls TURN key.

func (*TURNService) Update ¶ 

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

Edit details for a single TURN key.

type TURNUpdateParams ¶ 

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

func (TURNUpdateParams) MarshalJSON ¶ 

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

type TURNUpdateResponse ¶ 

type TURNUpdateResponse 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 turnUpdateResponseJSON `json:"-"`
}

func (*TURNUpdateResponse) UnmarshalJSON ¶ 

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

type TURNUpdateResponseEnvelope ¶ 

type TURNUpdateResponseEnvelope struct {
	Errors   []TURNUpdateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []TURNUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success TURNUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  TURNUpdateResponse                `json:"result"`
	JSON    turnUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*TURNUpdateResponseEnvelope) UnmarshalJSON ¶ 

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

type TURNUpdateResponseEnvelopeErrors ¶ 

type TURNUpdateResponseEnvelopeErrors struct {
	Code             int64                                  `json:"code" api:"required"`
	Message          string                                 `json:"message" api:"required"`
	DocumentationURL string                                 `json:"documentation_url"`
	Source           TURNUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             turnUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*TURNUpdateResponseEnvelopeErrors) UnmarshalJSON ¶ 

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

type TURNUpdateResponseEnvelopeErrorsSource ¶ 

type TURNUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                     `json:"pointer"`
	JSON    turnUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*TURNUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶ 

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

type TURNUpdateResponseEnvelopeMessages ¶ 

type TURNUpdateResponseEnvelopeMessages struct {
	Code             int64                                    `json:"code" api:"required"`
	Message          string                                   `json:"message" api:"required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           TURNUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             turnUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*TURNUpdateResponseEnvelopeMessages) UnmarshalJSON ¶ 

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

type TURNUpdateResponseEnvelopeMessagesSource ¶ 

type TURNUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    turnUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*TURNUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶ 

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

type TURNUpdateResponseEnvelopeSuccess ¶ 

type TURNUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	TURNUpdateResponseEnvelopeSuccessTrue TURNUpdateResponseEnvelopeSuccess = true
)

func (TURNUpdateResponseEnvelopeSuccess) IsKnown ¶ 

func (r TURNUpdateResponseEnvelopeSuccess) IsKnown() bool

type Token ¶ 

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition ¶ 

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList ¶ 

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam ¶ 

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam ¶ 

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP ¶ 

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam ¶ 

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam ¶ 

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy ¶ 

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect ¶ 

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam ¶ 

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup ¶ 

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam ¶ 

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta ¶ 

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam ¶ 

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested ¶ 

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam ¶ 

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString ¶ 

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam ¶ 

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion ¶ 

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam ¶ 

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus ¶ 

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue ¶ 

type TokenValue = shared.TokenValue

The token value.

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.