email_sending

package
v7.3.0 Latest Latest
Warning

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

Go to latest
Published: May 20, 2026 License: Apache-2.0 Imports: 14 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 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 EmailSendingSendParams

type EmailSendingSendParams struct {
	// Identifier of the account.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Sender email address. Either a plain string or an object with address and name.
	From param.Field[EmailSendingSendParamsFromUnion] `json:"from" api:"required"`
	// Email subject line.
	Subject param.Field[string] `json:"subject" api:"required"`
	// Recipient(s). A single email string or an array of email strings.
	To param.Field[EmailSendingSendParamsToUnion] `json:"to" api:"required"`
	// File attachments and inline images.
	Attachments param.Field[[]EmailSendingSendParamsAttachmentUnion] `json:"attachments"`
	// BCC recipient(s). A single email string or an array of email strings.
	Bcc param.Field[EmailSendingSendParamsBccUnion] `json:"bcc"`
	// CC recipient(s). A single email string or an array of email strings.
	Cc param.Field[EmailSendingSendParamsCcUnion] `json:"cc"`
	// Custom email headers as key-value pairs.
	Headers param.Field[map[string]string] `json:"headers"`
	// HTML body of the email. At least one of text or html must be provided.
	HTML param.Field[string] `json:"html"`
	// Reply-to address. Either a plain string or an object with address and name.
	ReplyTo param.Field[EmailSendingSendParamsReplyToUnion] `json:"reply_to"`
	// Plain text body of the email. At least one of text or html must be provided.
	Text param.Field[string] `json:"text"`
}

func (EmailSendingSendParams) MarshalJSON

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

type EmailSendingSendParamsAttachment

type EmailSendingSendParamsAttachment struct {
	// Base64-encoded content of the attachment.
	Content param.Field[string] `json:"content" api:"required"`
	// Must be 'inline'. Indicates the attachment is embedded in the email body.
	Disposition param.Field[EmailSendingSendParamsAttachmentsDisposition] `json:"disposition" api:"required"`
	// Filename for the attachment.
	Filename param.Field[string] `json:"filename" api:"required"`
	// MIME type of the attachment (e.g., 'image/png', 'text/plain').
	Type param.Field[string] `json:"type" api:"required"`
	// Content ID used to reference this attachment in HTML via cid: URI (e.g.,
	// <img src="cid:logo">).
	ContentID param.Field[string] `json:"content_id"`
}

func (EmailSendingSendParamsAttachment) MarshalJSON

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

type EmailSendingSendParamsAttachmentsDisposition

type EmailSendingSendParamsAttachmentsDisposition string

Must be 'inline'. Indicates the attachment is embedded in the email body.

const (
	EmailSendingSendParamsAttachmentsDispositionInline     EmailSendingSendParamsAttachmentsDisposition = "inline"
	EmailSendingSendParamsAttachmentsDispositionAttachment EmailSendingSendParamsAttachmentsDisposition = "attachment"
)

func (EmailSendingSendParamsAttachmentsDisposition) IsKnown

type EmailSendingSendParamsAttachmentsEmailSendingEmailAttachment

type EmailSendingSendParamsAttachmentsEmailSendingEmailAttachment struct {
	// Base64-encoded content of the attachment.
	Content param.Field[string] `json:"content" api:"required"`
	// Must be 'attachment'. Indicates a standard file attachment.
	Disposition param.Field[EmailSendingSendParamsAttachmentsEmailSendingEmailAttachmentDisposition] `json:"disposition" api:"required"`
	// Filename for the attachment.
	Filename param.Field[string] `json:"filename" api:"required"`
	// MIME type of the attachment (e.g., 'application/pdf', 'text/plain').
	Type param.Field[string] `json:"type" api:"required"`
}

func (EmailSendingSendParamsAttachmentsEmailSendingEmailAttachment) MarshalJSON

type EmailSendingSendParamsAttachmentsEmailSendingEmailAttachmentDisposition

type EmailSendingSendParamsAttachmentsEmailSendingEmailAttachmentDisposition string

Must be 'attachment'. Indicates a standard file attachment.

const (
	EmailSendingSendParamsAttachmentsEmailSendingEmailAttachmentDispositionAttachment EmailSendingSendParamsAttachmentsEmailSendingEmailAttachmentDisposition = "attachment"
)

func (EmailSendingSendParamsAttachmentsEmailSendingEmailAttachmentDisposition) IsKnown

type EmailSendingSendParamsAttachmentsEmailSendingEmailInlineAttachment

type EmailSendingSendParamsAttachmentsEmailSendingEmailInlineAttachment struct {
	// Base64-encoded content of the attachment.
	Content param.Field[string] `json:"content" api:"required"`
	// Content ID used to reference this attachment in HTML via cid: URI (e.g.,
	// <img src="cid:logo">).
	ContentID param.Field[string] `json:"content_id" api:"required"`
	// Must be 'inline'. Indicates the attachment is embedded in the email body.
	Disposition param.Field[EmailSendingSendParamsAttachmentsEmailSendingEmailInlineAttachmentDisposition] `json:"disposition" api:"required"`
	// Filename for the attachment.
	Filename param.Field[string] `json:"filename" api:"required"`
	// MIME type of the attachment (e.g., 'image/png', 'text/plain').
	Type param.Field[string] `json:"type" api:"required"`
}

func (EmailSendingSendParamsAttachmentsEmailSendingEmailInlineAttachment) MarshalJSON

type EmailSendingSendParamsAttachmentsEmailSendingEmailInlineAttachmentDisposition

type EmailSendingSendParamsAttachmentsEmailSendingEmailInlineAttachmentDisposition string

Must be 'inline'. Indicates the attachment is embedded in the email body.

const (
	EmailSendingSendParamsAttachmentsEmailSendingEmailInlineAttachmentDispositionInline EmailSendingSendParamsAttachmentsEmailSendingEmailInlineAttachmentDisposition = "inline"
)

func (EmailSendingSendParamsAttachmentsEmailSendingEmailInlineAttachmentDisposition) IsKnown

type EmailSendingSendParamsBccEmailSendingEmailAddressList

type EmailSendingSendParamsBccEmailSendingEmailAddressList []string

func (EmailSendingSendParamsBccEmailSendingEmailAddressList) ImplementsEmailSendingSendParamsBccUnion

func (r EmailSendingSendParamsBccEmailSendingEmailAddressList) ImplementsEmailSendingSendParamsBccUnion()

type EmailSendingSendParamsBccUnion

type EmailSendingSendParamsBccUnion interface {
	ImplementsEmailSendingSendParamsBccUnion()
}

BCC recipient(s). A single email string or an array of email strings.

Satisfied by shared.UnionString, email_sending.EmailSendingSendParamsBccEmailSendingEmailAddressList.

type EmailSendingSendParamsCcEmailSendingEmailAddressList

type EmailSendingSendParamsCcEmailSendingEmailAddressList []string

func (EmailSendingSendParamsCcEmailSendingEmailAddressList) ImplementsEmailSendingSendParamsCcUnion

func (r EmailSendingSendParamsCcEmailSendingEmailAddressList) ImplementsEmailSendingSendParamsCcUnion()

type EmailSendingSendParamsCcUnion

type EmailSendingSendParamsCcUnion interface {
	ImplementsEmailSendingSendParamsCcUnion()
}

CC recipient(s). A single email string or an array of email strings.

Satisfied by shared.UnionString, email_sending.EmailSendingSendParamsCcEmailSendingEmailAddressList.

type EmailSendingSendParamsFromEmailSendingEmailAddressObject

type EmailSendingSendParamsFromEmailSendingEmailAddressObject struct {
	// Email address (e.g., 'user@example.com').
	Address param.Field[string] `json:"address" api:"required"`
	// Display name for the email address (e.g., 'John Doe').
	Name param.Field[string] `json:"name" api:"required"`
}

func (EmailSendingSendParamsFromEmailSendingEmailAddressObject) ImplementsEmailSendingSendParamsFromUnion

func (r EmailSendingSendParamsFromEmailSendingEmailAddressObject) ImplementsEmailSendingSendParamsFromUnion()

func (EmailSendingSendParamsFromEmailSendingEmailAddressObject) MarshalJSON

type EmailSendingSendParamsFromUnion

type EmailSendingSendParamsFromUnion interface {
	ImplementsEmailSendingSendParamsFromUnion()
}

Sender email address. Either a plain string or an object with address and name.

Satisfied by shared.UnionString, email_sending.EmailSendingSendParamsFromEmailSendingEmailAddressObject.

type EmailSendingSendParamsReplyToEmailSendingEmailAddressObject

type EmailSendingSendParamsReplyToEmailSendingEmailAddressObject struct {
	// Email address (e.g., 'user@example.com').
	Address param.Field[string] `json:"address" api:"required"`
	// Display name for the email address (e.g., 'John Doe').
	Name param.Field[string] `json:"name" api:"required"`
}

func (EmailSendingSendParamsReplyToEmailSendingEmailAddressObject) ImplementsEmailSendingSendParamsReplyToUnion

func (r EmailSendingSendParamsReplyToEmailSendingEmailAddressObject) ImplementsEmailSendingSendParamsReplyToUnion()

func (EmailSendingSendParamsReplyToEmailSendingEmailAddressObject) MarshalJSON

type EmailSendingSendParamsReplyToUnion

type EmailSendingSendParamsReplyToUnion interface {
	ImplementsEmailSendingSendParamsReplyToUnion()
}

Reply-to address. Either a plain string or an object with address and name.

Satisfied by shared.UnionString, email_sending.EmailSendingSendParamsReplyToEmailSendingEmailAddressObject.

type EmailSendingSendParamsToEmailSendingEmailAddressList

type EmailSendingSendParamsToEmailSendingEmailAddressList []string

func (EmailSendingSendParamsToEmailSendingEmailAddressList) ImplementsEmailSendingSendParamsToUnion

func (r EmailSendingSendParamsToEmailSendingEmailAddressList) ImplementsEmailSendingSendParamsToUnion()

type EmailSendingSendParamsToUnion

type EmailSendingSendParamsToUnion interface {
	ImplementsEmailSendingSendParamsToUnion()
}

Recipient(s). A single email string or an array of email strings.

Satisfied by shared.UnionString, email_sending.EmailSendingSendParamsToEmailSendingEmailAddressList.

type EmailSendingSendRawParams

type EmailSendingSendRawParams struct {
	// Identifier of the account.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Sender email address.
	From param.Field[string] `json:"from" api:"required"`
	// The full MIME-encoded email message. Should include standard RFC 5322 headers
	// such as From, To, Subject, and Content-Type. The from and recipients fields in
	// the request body control SMTP envelope routing; the From and To headers in the
	// MIME message control what the recipient's email client displays.
	MimeMessage param.Field[string] `json:"mime_message" api:"required"`
	// List of recipient email addresses.
	Recipients param.Field[[]string] `json:"recipients" api:"required"`
}

func (EmailSendingSendRawParams) MarshalJSON

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

type EmailSendingSendRawResponse

type EmailSendingSendRawResponse struct {
	// Email addresses to which the message was delivered immediately.
	Delivered []string `json:"delivered" api:"required"`
	// Email addresses that permanently bounced.
	PermanentBounces []string `json:"permanent_bounces" api:"required"`
	// Email addresses for which delivery was queued for later.
	Queued []string                        `json:"queued" api:"required"`
	JSON   emailSendingSendRawResponseJSON `json:"-"`
}

func (*EmailSendingSendRawResponse) UnmarshalJSON

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

type EmailSendingSendRawResponseEnvelope

type EmailSendingSendRawResponseEnvelope struct {
	Errors     []EmailSendingSendRawResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages   []EmailSendingSendRawResponseEnvelopeMessages `json:"messages" api:"required"`
	Result     EmailSendingSendRawResponse                   `json:"result" api:"required"`
	Success    EmailSendingSendRawResponseEnvelopeSuccess    `json:"success" api:"required"`
	ResultInfo EmailSendingSendRawResponseEnvelopeResultInfo `json:"result_info"`
	JSON       emailSendingSendRawResponseEnvelopeJSON       `json:"-"`
}

func (*EmailSendingSendRawResponseEnvelope) UnmarshalJSON

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

type EmailSendingSendRawResponseEnvelopeErrors

type EmailSendingSendRawResponseEnvelopeErrors struct {
	Code    float64                                       `json:"code" api:"required"`
	Message string                                        `json:"message" api:"required"`
	JSON    emailSendingSendRawResponseEnvelopeErrorsJSON `json:"-"`
}

func (*EmailSendingSendRawResponseEnvelopeErrors) UnmarshalJSON

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

type EmailSendingSendRawResponseEnvelopeMessages

type EmailSendingSendRawResponseEnvelopeMessages struct {
	Code    float64                                         `json:"code" api:"required"`
	Message string                                          `json:"message" api:"required"`
	JSON    emailSendingSendRawResponseEnvelopeMessagesJSON `json:"-"`
}

func (*EmailSendingSendRawResponseEnvelopeMessages) UnmarshalJSON

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

type EmailSendingSendRawResponseEnvelopeResultInfo

type EmailSendingSendRawResponseEnvelopeResultInfo struct {
	Count      float64                                           `json:"count" api:"required"`
	PerPage    float64                                           `json:"per_page" api:"required"`
	TotalCount float64                                           `json:"total_count" api:"required"`
	Cursor     string                                            `json:"cursor"`
	Page       float64                                           `json:"page"`
	JSON       emailSendingSendRawResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*EmailSendingSendRawResponseEnvelopeResultInfo) UnmarshalJSON

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

type EmailSendingSendRawResponseEnvelopeSuccess

type EmailSendingSendRawResponseEnvelopeSuccess bool
const (
	EmailSendingSendRawResponseEnvelopeSuccessTrue EmailSendingSendRawResponseEnvelopeSuccess = true
)

func (EmailSendingSendRawResponseEnvelopeSuccess) IsKnown

type EmailSendingSendResponse

type EmailSendingSendResponse struct {
	// Email addresses to which the message was delivered immediately.
	Delivered []string `json:"delivered" api:"required"`
	// Email addresses that permanently bounced.
	PermanentBounces []string `json:"permanent_bounces" api:"required"`
	// Email addresses for which delivery was queued for later.
	Queued []string                     `json:"queued" api:"required"`
	JSON   emailSendingSendResponseJSON `json:"-"`
}

func (*EmailSendingSendResponse) UnmarshalJSON

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

type EmailSendingSendResponseEnvelope

type EmailSendingSendResponseEnvelope struct {
	Errors     []EmailSendingSendResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages   []EmailSendingSendResponseEnvelopeMessages `json:"messages" api:"required"`
	Result     EmailSendingSendResponse                   `json:"result" api:"required"`
	Success    EmailSendingSendResponseEnvelopeSuccess    `json:"success" api:"required"`
	ResultInfo EmailSendingSendResponseEnvelopeResultInfo `json:"result_info"`
	JSON       emailSendingSendResponseEnvelopeJSON       `json:"-"`
}

func (*EmailSendingSendResponseEnvelope) UnmarshalJSON

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

type EmailSendingSendResponseEnvelopeErrors

type EmailSendingSendResponseEnvelopeErrors struct {
	Code    float64                                    `json:"code" api:"required"`
	Message string                                     `json:"message" api:"required"`
	JSON    emailSendingSendResponseEnvelopeErrorsJSON `json:"-"`
}

func (*EmailSendingSendResponseEnvelopeErrors) UnmarshalJSON

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

type EmailSendingSendResponseEnvelopeMessages

type EmailSendingSendResponseEnvelopeMessages struct {
	Code    float64                                      `json:"code" api:"required"`
	Message string                                       `json:"message" api:"required"`
	JSON    emailSendingSendResponseEnvelopeMessagesJSON `json:"-"`
}

func (*EmailSendingSendResponseEnvelopeMessages) UnmarshalJSON

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

type EmailSendingSendResponseEnvelopeResultInfo

type EmailSendingSendResponseEnvelopeResultInfo struct {
	Count      float64                                        `json:"count" api:"required"`
	PerPage    float64                                        `json:"per_page" api:"required"`
	TotalCount float64                                        `json:"total_count" api:"required"`
	Cursor     string                                         `json:"cursor"`
	Page       float64                                        `json:"page"`
	JSON       emailSendingSendResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*EmailSendingSendResponseEnvelopeResultInfo) UnmarshalJSON

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

type EmailSendingSendResponseEnvelopeSuccess

type EmailSendingSendResponseEnvelopeSuccess bool
const (
	EmailSendingSendResponseEnvelopeSuccessTrue EmailSendingSendResponseEnvelopeSuccess = true
)

func (EmailSendingSendResponseEnvelopeSuccess) IsKnown

type EmailSendingService

type EmailSendingService struct {
	Options    []option.RequestOption
	Subdomains *SubdomainService
}

EmailSendingService 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 NewEmailSendingService method instead.

func NewEmailSendingService

func NewEmailSendingService(opts ...option.RequestOption) (r *EmailSendingService)

NewEmailSendingService 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 (*EmailSendingService) Send

Send an email

func (*EmailSendingService) SendRaw

Send a raw MIME email

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 SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type SubdomainDNSGetParams

type SubdomainDNSGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
}

type SubdomainDNSService

type SubdomainDNSService struct {
	Options []option.RequestOption
}

SubdomainDNSService 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 NewSubdomainDNSService method instead.

func NewSubdomainDNSService

func NewSubdomainDNSService(opts ...option.RequestOption) (r *SubdomainDNSService)

NewSubdomainDNSService 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 (*SubdomainDNSService) Get

Returns the expected DNS records for a sending subdomain.

func (*SubdomainDNSService) GetAutoPaging

Returns the expected DNS records for a sending subdomain.

type SubdomainDeleteParams

type SubdomainDeleteParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
}

type SubdomainDeleteResponse

type SubdomainDeleteResponse struct {
	Errors   []SubdomainDeleteResponseError   `json:"errors" api:"required"`
	Messages []SubdomainDeleteResponseMessage `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SubdomainDeleteResponseSuccess `json:"success" api:"required"`
	JSON    subdomainDeleteResponseJSON    `json:"-"`
}

func (*SubdomainDeleteResponse) UnmarshalJSON

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

type SubdomainDeleteResponseError

type SubdomainDeleteResponseError struct {
	Code             int64                               `json:"code" api:"required"`
	Message          string                              `json:"message" api:"required"`
	DocumentationURL string                              `json:"documentation_url"`
	Source           SubdomainDeleteResponseErrorsSource `json:"source"`
	JSON             subdomainDeleteResponseErrorJSON    `json:"-"`
}

func (*SubdomainDeleteResponseError) UnmarshalJSON

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

type SubdomainDeleteResponseErrorsSource

type SubdomainDeleteResponseErrorsSource struct {
	Pointer string                                  `json:"pointer"`
	JSON    subdomainDeleteResponseErrorsSourceJSON `json:"-"`
}

func (*SubdomainDeleteResponseErrorsSource) UnmarshalJSON

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

type SubdomainDeleteResponseMessage

type SubdomainDeleteResponseMessage struct {
	Code             int64                                 `json:"code" api:"required"`
	Message          string                                `json:"message" api:"required"`
	DocumentationURL string                                `json:"documentation_url"`
	Source           SubdomainDeleteResponseMessagesSource `json:"source"`
	JSON             subdomainDeleteResponseMessageJSON    `json:"-"`
}

func (*SubdomainDeleteResponseMessage) UnmarshalJSON

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

type SubdomainDeleteResponseMessagesSource

type SubdomainDeleteResponseMessagesSource struct {
	Pointer string                                    `json:"pointer"`
	JSON    subdomainDeleteResponseMessagesSourceJSON `json:"-"`
}

func (*SubdomainDeleteResponseMessagesSource) UnmarshalJSON

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

type SubdomainDeleteResponseSuccess

type SubdomainDeleteResponseSuccess bool

Whether the API call was successful.

const (
	SubdomainDeleteResponseSuccessTrue SubdomainDeleteResponseSuccess = true
)

func (SubdomainDeleteResponseSuccess) IsKnown

type SubdomainGetParams

type SubdomainGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
}

type SubdomainGetResponse

type SubdomainGetResponse struct {
	// Whether Email Sending is enabled on this subdomain.
	Enabled bool `json:"enabled" api:"required"`
	// The subdomain domain name.
	Name string `json:"name" api:"required"`
	// Sending subdomain identifier.
	Tag string `json:"tag" api:"required"`
	// The date and time the destination address has been created.
	Created time.Time `json:"created" format:"date-time"`
	// The DKIM selector used for email signing.
	DKIMSelector string `json:"dkim_selector"`
	// The date and time the destination address was last modified.
	Modified time.Time `json:"modified" format:"date-time"`
	// The return-path domain used for bounce handling.
	ReturnPathDomain string                   `json:"return_path_domain"`
	JSON             subdomainGetResponseJSON `json:"-"`
}

func (*SubdomainGetResponse) UnmarshalJSON

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

type SubdomainGetResponseEnvelope

type SubdomainGetResponseEnvelope struct {
	Errors   []SubdomainGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SubdomainGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SubdomainGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SubdomainGetResponse                `json:"result"`
	JSON    subdomainGetResponseEnvelopeJSON    `json:"-"`
}

func (*SubdomainGetResponseEnvelope) UnmarshalJSON

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

type SubdomainGetResponseEnvelopeErrors

type SubdomainGetResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code" api:"required"`
	Message          string                                   `json:"message" api:"required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           SubdomainGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             subdomainGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SubdomainGetResponseEnvelopeErrors) UnmarshalJSON

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

type SubdomainGetResponseEnvelopeErrorsSource

type SubdomainGetResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    subdomainGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SubdomainGetResponseEnvelopeErrorsSource) UnmarshalJSON

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

type SubdomainGetResponseEnvelopeMessages

type SubdomainGetResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           SubdomainGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             subdomainGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SubdomainGetResponseEnvelopeMessages) UnmarshalJSON

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

type SubdomainGetResponseEnvelopeMessagesSource

type SubdomainGetResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    subdomainGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SubdomainGetResponseEnvelopeMessagesSource) UnmarshalJSON

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

type SubdomainGetResponseEnvelopeSuccess

type SubdomainGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SubdomainGetResponseEnvelopeSuccessTrue SubdomainGetResponseEnvelopeSuccess = true
)

func (SubdomainGetResponseEnvelopeSuccess) IsKnown

type SubdomainListParams

type SubdomainListParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
}

type SubdomainListResponse

type SubdomainListResponse struct {
	// Whether Email Sending is enabled on this subdomain.
	Enabled bool `json:"enabled" api:"required"`
	// The subdomain domain name.
	Name string `json:"name" api:"required"`
	// Sending subdomain identifier.
	Tag string `json:"tag" api:"required"`
	// The date and time the destination address has been created.
	Created time.Time `json:"created" format:"date-time"`
	// The DKIM selector used for email signing.
	DKIMSelector string `json:"dkim_selector"`
	// The date and time the destination address was last modified.
	Modified time.Time `json:"modified" format:"date-time"`
	// The return-path domain used for bounce handling.
	ReturnPathDomain string                    `json:"return_path_domain"`
	JSON             subdomainListResponseJSON `json:"-"`
}

func (*SubdomainListResponse) UnmarshalJSON

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

type SubdomainNewParams

type SubdomainNewParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
	// The subdomain name. Must be within the zone.
	Name param.Field[string] `json:"name" api:"required"`
}

func (SubdomainNewParams) MarshalJSON

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

type SubdomainNewResponse

type SubdomainNewResponse struct {
	// Whether Email Sending is enabled on this subdomain.
	Enabled bool `json:"enabled" api:"required"`
	// The subdomain domain name.
	Name string `json:"name" api:"required"`
	// Sending subdomain identifier.
	Tag string `json:"tag" api:"required"`
	// The date and time the destination address has been created.
	Created time.Time `json:"created" format:"date-time"`
	// The DKIM selector used for email signing.
	DKIMSelector string `json:"dkim_selector"`
	// The date and time the destination address was last modified.
	Modified time.Time `json:"modified" format:"date-time"`
	// The return-path domain used for bounce handling.
	ReturnPathDomain string                   `json:"return_path_domain"`
	JSON             subdomainNewResponseJSON `json:"-"`
}

func (*SubdomainNewResponse) UnmarshalJSON

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

type SubdomainNewResponseEnvelope

type SubdomainNewResponseEnvelope struct {
	Errors   []SubdomainNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SubdomainNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SubdomainNewResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SubdomainNewResponse                `json:"result"`
	JSON    subdomainNewResponseEnvelopeJSON    `json:"-"`
}

func (*SubdomainNewResponseEnvelope) UnmarshalJSON

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

type SubdomainNewResponseEnvelopeErrors

type SubdomainNewResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code" api:"required"`
	Message          string                                   `json:"message" api:"required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           SubdomainNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             subdomainNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SubdomainNewResponseEnvelopeErrors) UnmarshalJSON

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

type SubdomainNewResponseEnvelopeErrorsSource

type SubdomainNewResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    subdomainNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SubdomainNewResponseEnvelopeErrorsSource) UnmarshalJSON

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

type SubdomainNewResponseEnvelopeMessages

type SubdomainNewResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           SubdomainNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             subdomainNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SubdomainNewResponseEnvelopeMessages) UnmarshalJSON

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

type SubdomainNewResponseEnvelopeMessagesSource

type SubdomainNewResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    subdomainNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SubdomainNewResponseEnvelopeMessagesSource) UnmarshalJSON

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

type SubdomainNewResponseEnvelopeSuccess

type SubdomainNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SubdomainNewResponseEnvelopeSuccessTrue SubdomainNewResponseEnvelopeSuccess = true
)

func (SubdomainNewResponseEnvelopeSuccess) IsKnown

type SubdomainService

type SubdomainService struct {
	Options []option.RequestOption
	DNS     *SubdomainDNSService
}

SubdomainService 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 NewSubdomainService method instead.

func NewSubdomainService

func NewSubdomainService(opts ...option.RequestOption) (r *SubdomainService)

NewSubdomainService 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 (*SubdomainService) Delete

func (r *SubdomainService) Delete(ctx context.Context, subdomainID string, body SubdomainDeleteParams, opts ...option.RequestOption) (res *SubdomainDeleteResponse, err error)

Disables sending on a subdomain and removes its DNS records. If routing is still active on the subdomain, only sending is disabled.

func (*SubdomainService) Get

func (r *SubdomainService) Get(ctx context.Context, subdomainID string, query SubdomainGetParams, opts ...option.RequestOption) (res *SubdomainGetResponse, err error)

Gets information for a specific sending subdomain.

func (*SubdomainService) List

Lists all sending-enabled subdomains for the zone.

func (*SubdomainService) ListAutoPaging

Lists all sending-enabled subdomains for the zone.

func (*SubdomainService) New

Creates a new sending subdomain or re-enables sending on an existing subdomain that had it disabled. If zone-level Email Sending has not been enabled yet, the zone flag is automatically set when the entitlement is present.

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL