monetization

package
v7.13.0 Latest Latest
Warning

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

Go to latest
Published: Oct 12, 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 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 MonetizationRule

type MonetizationRule struct {
	// Optional on input. Include the ID of an existing payment rule to update it in
	// place, preserving its stable identity across the full-ruleset replacement; omit
	// it to create a new rule. An ID that does not match an existing payment rule in
	// the zone is rejected. Rules omitted from the request are deleted.
	ID string `json:"id"`
	// 0x-prefixed 20-byte hexadecimal Ethereum address. Mixed-case addresses must
	// carry a valid EIP-55 checksum; all-lowercase or all-uppercase addresses are also
	// accepted. The address must pass wallet screening whenever its rule is deployed
	// or patched.
	Address     string `json:"address"`
	Description string `json:"description"`
	Enabled     bool   `json:"enabled"`
	// Wirefilter expression identifying the requests that require payment. Forwarded
	// verbatim to the Rulesets API, which validates its syntax.
	Expression string `json:"expression"`
	// Price in the smallest indivisible unit of the configured payment token, encoded
	// as a decimal string. Must be a canonical decimal integer in [1000, 100000000]:
	// no leading zeros, and a bare JSON number is rejected. The price is required for
	// the fixed-price schemes ("exact" and "upto") and must be at least 1000, the
	// smallest amount the payment facilitator can settle ($0.001 for a 6-decimal token
	// such as USDC), and at most 100000000 ($100 for a 6-decimal token). When the
	// scheme is "origin_controlled" the origin server sets pricing dynamically and the
	// rule carries no price: the field must be omitted — any provided value, including
	// "0", is rejected because it would not be enforced. Responses always encode this
	// as a string and omit it for "origin_controlled" rules; the pattern matches
	// exactly the set of values the server accepts.
	Price string `json:"price"`
	// X402 payment scheme. "exact" requires the specified payment amount; "upto"
	// permits a payment up to the specified amount. Both fixed-price schemes require
	// the price field.
	Scheme MonetizationRuleScheme `json:"scheme"`
	JSON   monetizationRuleJSON   `json:"-"`
	// contains filtered or unexported fields
}

Payment rule with a fixed price set at configuration time.

func (MonetizationRule) AsUnion

AsUnion returns a MonetizationRuleUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are MonetizationRuleMonetizationRulesMonetizationRuleInputFixedPrice, MonetizationRuleMonetizationRulesMonetizationRuleInputOriginControlled.

func (*MonetizationRule) UnmarshalJSON

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

type MonetizationRuleCollection

type MonetizationRuleCollection struct {
	// The zone's payment rules, in the order they are evaluated. Empty when the zone
	// has no payment rules.
	Rules []MonetizationRule             `json:"rules" api:"required"`
	JSON  monetizationRuleCollectionJSON `json:"-"`
}

The zone's payment rules. Mirrors the shape of the ruleset submitted to the deploy endpoint, so the response can be read back as the desired state.

func (*MonetizationRuleCollection) UnmarshalJSON

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

type MonetizationRuleInputFixedPrice

type MonetizationRuleInputFixedPrice struct {
	// 0x-prefixed 20-byte hexadecimal Ethereum address. Mixed-case addresses must
	// carry a valid EIP-55 checksum; all-lowercase or all-uppercase addresses are also
	// accepted. The address must pass wallet screening whenever its rule is deployed
	// or patched.
	Address string `json:"address" api:"required"`
	// Wirefilter expression identifying the requests that require payment. Forwarded
	// verbatim to the Rulesets API, which validates its syntax.
	Expression string `json:"expression" api:"required"`
	// Price in the smallest indivisible unit of the configured payment token, encoded
	// as a decimal string. Must be a canonical decimal integer in [1000, 100000000]:
	// no leading zeros, and a bare JSON number is rejected. The price is required for
	// the fixed-price schemes ("exact" and "upto") and must be at least 1000, the
	// smallest amount the payment facilitator can settle ($0.001 for a 6-decimal token
	// such as USDC), and at most 100000000 ($100 for a 6-decimal token). When the
	// scheme is "origin_controlled" the origin server sets pricing dynamically and the
	// rule carries no price: the field must be omitted — any provided value, including
	// "0", is rejected because it would not be enforced. Responses always encode this
	// as a string and omit it for "origin_controlled" rules; the pattern matches
	// exactly the set of values the server accepts.
	Price string `json:"price" api:"required"`
	// X402 payment scheme. "exact" requires the specified payment amount; "upto"
	// permits a payment up to the specified amount. Both fixed-price schemes require
	// the price field.
	Scheme MonetizationRuleInputFixedPriceScheme `json:"scheme" api:"required"`
	// Optional on input. Include the ID of an existing payment rule to update it in
	// place, preserving its stable identity across the full-ruleset replacement; omit
	// it to create a new rule. An ID that does not match an existing payment rule in
	// the zone is rejected. Rules omitted from the request are deleted.
	ID          string                              `json:"id"`
	Description string                              `json:"description"`
	Enabled     bool                                `json:"enabled"`
	JSON        monetizationRuleInputFixedPriceJSON `json:"-"`
}

Payment rule with a fixed price set at configuration time.

func (*MonetizationRuleInputFixedPrice) UnmarshalJSON

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

type MonetizationRuleInputFixedPriceParam

type MonetizationRuleInputFixedPriceParam struct {
	// 0x-prefixed 20-byte hexadecimal Ethereum address. Mixed-case addresses must
	// carry a valid EIP-55 checksum; all-lowercase or all-uppercase addresses are also
	// accepted. The address must pass wallet screening whenever its rule is deployed
	// or patched.
	Address param.Field[string] `json:"address" api:"required"`
	// Wirefilter expression identifying the requests that require payment. Forwarded
	// verbatim to the Rulesets API, which validates its syntax.
	Expression param.Field[string] `json:"expression" api:"required"`
	// Price in the smallest indivisible unit of the configured payment token, encoded
	// as a decimal string. Must be a canonical decimal integer in [1000, 100000000]:
	// no leading zeros, and a bare JSON number is rejected. The price is required for
	// the fixed-price schemes ("exact" and "upto") and must be at least 1000, the
	// smallest amount the payment facilitator can settle ($0.001 for a 6-decimal token
	// such as USDC), and at most 100000000 ($100 for a 6-decimal token). When the
	// scheme is "origin_controlled" the origin server sets pricing dynamically and the
	// rule carries no price: the field must be omitted — any provided value, including
	// "0", is rejected because it would not be enforced. Responses always encode this
	// as a string and omit it for "origin_controlled" rules; the pattern matches
	// exactly the set of values the server accepts.
	Price param.Field[string] `json:"price" api:"required"`
	// X402 payment scheme. "exact" requires the specified payment amount; "upto"
	// permits a payment up to the specified amount. Both fixed-price schemes require
	// the price field.
	Scheme param.Field[MonetizationRuleInputFixedPriceScheme] `json:"scheme" api:"required"`
	// Optional on input. Include the ID of an existing payment rule to update it in
	// place, preserving its stable identity across the full-ruleset replacement; omit
	// it to create a new rule. An ID that does not match an existing payment rule in
	// the zone is rejected. Rules omitted from the request are deleted.
	ID          param.Field[string] `json:"id"`
	Description param.Field[string] `json:"description"`
	Enabled     param.Field[bool]   `json:"enabled"`
}

Payment rule with a fixed price set at configuration time.

func (MonetizationRuleInputFixedPriceParam) MarshalJSON

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

type MonetizationRuleInputFixedPriceScheme

type MonetizationRuleInputFixedPriceScheme string

X402 payment scheme. "exact" requires the specified payment amount; "upto" permits a payment up to the specified amount. Both fixed-price schemes require the price field.

const (
	MonetizationRuleInputFixedPriceSchemeExact MonetizationRuleInputFixedPriceScheme = "exact"
	MonetizationRuleInputFixedPriceSchemeUpto  MonetizationRuleInputFixedPriceScheme = "upto"
)

func (MonetizationRuleInputFixedPriceScheme) IsKnown

type MonetizationRuleInputOriginControlled

type MonetizationRuleInputOriginControlled struct {
	// 0x-prefixed 20-byte hexadecimal Ethereum address. Mixed-case addresses must
	// carry a valid EIP-55 checksum; all-lowercase or all-uppercase addresses are also
	// accepted. The address must pass wallet screening whenever its rule is deployed
	// or patched.
	Address string `json:"address" api:"required"`
	// Wirefilter expression identifying the requests that require payment. Forwarded
	// verbatim to the Rulesets API, which validates its syntax.
	Expression string `json:"expression" api:"required"`
	// X402 payment scheme. "origin_controlled" lets the origin server set pricing
	// dynamically; the rule carries no price and the price field must be omitted.
	Scheme MonetizationRuleInputOriginControlledScheme `json:"scheme" api:"required"`
	// Optional on input. Include the ID of an existing payment rule to update it in
	// place, preserving its stable identity across the full-ruleset replacement; omit
	// it to create a new rule. An ID that does not match an existing payment rule in
	// the zone is rejected. Rules omitted from the request are deleted.
	ID          string                                    `json:"id"`
	Description string                                    `json:"description"`
	Enabled     bool                                      `json:"enabled"`
	JSON        monetizationRuleInputOriginControlledJSON `json:"-"`
}

Payment rule whose price the origin server sets dynamically. The rule carries no price and the price field must be omitted — any provided value, including "0", is rejected because it would not be enforced.

func (*MonetizationRuleInputOriginControlled) UnmarshalJSON

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

type MonetizationRuleInputOriginControlledParam

type MonetizationRuleInputOriginControlledParam struct {
	// 0x-prefixed 20-byte hexadecimal Ethereum address. Mixed-case addresses must
	// carry a valid EIP-55 checksum; all-lowercase or all-uppercase addresses are also
	// accepted. The address must pass wallet screening whenever its rule is deployed
	// or patched.
	Address param.Field[string] `json:"address" api:"required"`
	// Wirefilter expression identifying the requests that require payment. Forwarded
	// verbatim to the Rulesets API, which validates its syntax.
	Expression param.Field[string] `json:"expression" api:"required"`
	// X402 payment scheme. "origin_controlled" lets the origin server set pricing
	// dynamically; the rule carries no price and the price field must be omitted.
	Scheme param.Field[MonetizationRuleInputOriginControlledScheme] `json:"scheme" api:"required"`
	// Optional on input. Include the ID of an existing payment rule to update it in
	// place, preserving its stable identity across the full-ruleset replacement; omit
	// it to create a new rule. An ID that does not match an existing payment rule in
	// the zone is rejected. Rules omitted from the request are deleted.
	ID          param.Field[string] `json:"id"`
	Description param.Field[string] `json:"description"`
	Enabled     param.Field[bool]   `json:"enabled"`
}

Payment rule whose price the origin server sets dynamically. The rule carries no price and the price field must be omitted — any provided value, including "0", is rejected because it would not be enforced.

func (MonetizationRuleInputOriginControlledParam) MarshalJSON

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

type MonetizationRuleInputOriginControlledScheme

type MonetizationRuleInputOriginControlledScheme string

X402 payment scheme. "origin_controlled" lets the origin server set pricing dynamically; the rule carries no price and the price field must be omitted.

const (
	MonetizationRuleInputOriginControlledSchemeOriginControlled MonetizationRuleInputOriginControlledScheme = "origin_controlled"
)

func (MonetizationRuleInputOriginControlledScheme) IsKnown

type MonetizationRuleInputParam

type MonetizationRuleInputParam struct {
	// 0x-prefixed 20-byte hexadecimal Ethereum address. Mixed-case addresses must
	// carry a valid EIP-55 checksum; all-lowercase or all-uppercase addresses are also
	// accepted. The address must pass wallet screening whenever its rule is deployed
	// or patched.
	Address param.Field[string] `json:"address" api:"required"`
	// Wirefilter expression identifying the requests that require payment. Forwarded
	// verbatim to the Rulesets API, which validates its syntax.
	Expression param.Field[string] `json:"expression" api:"required"`
	// X402 payment scheme. "exact" requires the specified payment amount; "upto"
	// permits a payment up to the specified amount. Both fixed-price schemes require
	// the price field.
	Scheme param.Field[MonetizationRuleInputScheme] `json:"scheme" api:"required"`
	// Optional on input. Include the ID of an existing payment rule to update it in
	// place, preserving its stable identity across the full-ruleset replacement; omit
	// it to create a new rule. An ID that does not match an existing payment rule in
	// the zone is rejected. Rules omitted from the request are deleted.
	ID          param.Field[string] `json:"id"`
	Description param.Field[string] `json:"description"`
	Enabled     param.Field[bool]   `json:"enabled"`
	// Price in the smallest indivisible unit of the configured payment token, encoded
	// as a decimal string. Must be a canonical decimal integer in [1000, 100000000]:
	// no leading zeros, and a bare JSON number is rejected. The price is required for
	// the fixed-price schemes ("exact" and "upto") and must be at least 1000, the
	// smallest amount the payment facilitator can settle ($0.001 for a 6-decimal token
	// such as USDC), and at most 100000000 ($100 for a 6-decimal token). When the
	// scheme is "origin_controlled" the origin server sets pricing dynamically and the
	// rule carries no price: the field must be omitted — any provided value, including
	// "0", is rejected because it would not be enforced. Responses always encode this
	// as a string and omit it for "origin_controlled" rules; the pattern matches
	// exactly the set of values the server accepts.
	Price param.Field[string] `json:"price"`
}

Payment rule with a fixed price set at configuration time.

func (MonetizationRuleInputParam) MarshalJSON

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

type MonetizationRuleInputScheme

type MonetizationRuleInputScheme string

X402 payment scheme. "exact" requires the specified payment amount; "upto" permits a payment up to the specified amount. Both fixed-price schemes require the price field.

const (
	MonetizationRuleInputSchemeExact            MonetizationRuleInputScheme = "exact"
	MonetizationRuleInputSchemeUpto             MonetizationRuleInputScheme = "upto"
	MonetizationRuleInputSchemeOriginControlled MonetizationRuleInputScheme = "origin_controlled"
)

func (MonetizationRuleInputScheme) IsKnown

func (r MonetizationRuleInputScheme) IsKnown() bool

type MonetizationRuleInputUnionParam

type MonetizationRuleInputUnionParam interface {
	// contains filtered or unexported methods
}

Payment rule with a fixed price set at configuration time.

Satisfied by monetization.MonetizationRuleInputFixedPriceParam, monetization.MonetizationRuleInputOriginControlledParam, MonetizationRuleInputParam.

type MonetizationRuleMonetizationRulesMonetizationRuleInputFixedPrice

type MonetizationRuleMonetizationRulesMonetizationRuleInputFixedPrice struct {
	// The server-assigned unique ID of the payment rule. Stable across full-ruleset
	// replacements.
	ID   string                                                               `json:"id" api:"required"`
	JSON monetizationRuleMonetizationRulesMonetizationRuleInputFixedPriceJSON `json:"-"`
	MonetizationRuleInputFixedPrice
}

Payment rule with a fixed price set at configuration time.

func (*MonetizationRuleMonetizationRulesMonetizationRuleInputFixedPrice) UnmarshalJSON

type MonetizationRuleMonetizationRulesMonetizationRuleInputOriginControlled

type MonetizationRuleMonetizationRulesMonetizationRuleInputOriginControlled struct {
	// The server-assigned unique ID of the payment rule. Stable across full-ruleset
	// replacements.
	ID   string                                                                     `json:"id" api:"required"`
	JSON monetizationRuleMonetizationRulesMonetizationRuleInputOriginControlledJSON `json:"-"`
	MonetizationRuleInputOriginControlled
}

Payment rule whose price the origin server sets dynamically. The rule carries no price and the price field must be omitted — any provided value, including "0", is rejected because it would not be enforced.

func (*MonetizationRuleMonetizationRulesMonetizationRuleInputOriginControlled) UnmarshalJSON

type MonetizationRulePatchParam

type MonetizationRulePatchParam struct {
	// 0x-prefixed 20-byte hexadecimal Ethereum address. Mixed-case addresses must
	// carry a valid EIP-55 checksum; all-lowercase or all-uppercase addresses are also
	// accepted. The effective address must pass wallet screening whenever the rule is
	// patched.
	Address     param.Field[string] `json:"address"`
	Description param.Field[string] `json:"description"`
	Enabled     param.Field[bool]   `json:"enabled"`
	// Wirefilter expression identifying the requests that require payment. Forwarded
	// verbatim to the Rulesets API, which validates its syntax.
	Expression param.Field[string] `json:"expression"`
	// Price in the smallest indivisible unit of the configured payment token, encoded
	// as a decimal string. Must be a canonical decimal integer in [1000, 100000000]:
	// no leading zeros, and a bare JSON number is rejected. The price is required for
	// the fixed-price schemes ("exact" and "upto") and must be at least 1000, the
	// smallest amount the payment facilitator can settle ($0.001 for a 6-decimal token
	// such as USDC), and at most 100000000 ($100 for a 6-decimal token). When the
	// scheme is "origin_controlled" the origin server sets pricing dynamically and the
	// rule carries no price: the field must be omitted — any provided value, including
	// "0", is rejected because it would not be enforced. Responses always encode this
	// as a string and omit it for "origin_controlled" rules; the pattern matches
	// exactly the set of values the server accepts.
	Price param.Field[string] `json:"price"`
	// X402 payment scheme. "exact" requires the specified payment amount; "upto"
	// permits a payment up to the specified amount; "origin_controlled" lets the
	// origin server set pricing dynamically, in which case the rule carries no price
	// and the price field must be omitted.
	Scheme param.Field[MonetizationRulePatchScheme] `json:"scheme"`
}

Partial update to a single payment rule. Only the fields present are modified; omitted fields keep their existing values.

func (MonetizationRulePatchParam) MarshalJSON

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

type MonetizationRulePatchScheme

type MonetizationRulePatchScheme string

X402 payment scheme. "exact" requires the specified payment amount; "upto" permits a payment up to the specified amount; "origin_controlled" lets the origin server set pricing dynamically, in which case the rule carries no price and the price field must be omitted.

const (
	MonetizationRulePatchSchemeExact            MonetizationRulePatchScheme = "exact"
	MonetizationRulePatchSchemeUpto             MonetizationRulePatchScheme = "upto"
	MonetizationRulePatchSchemeOriginControlled MonetizationRulePatchScheme = "origin_controlled"
)

func (MonetizationRulePatchScheme) IsKnown

func (r MonetizationRulePatchScheme) IsKnown() bool

type MonetizationRuleScheme

type MonetizationRuleScheme string

X402 payment scheme. "exact" requires the specified payment amount; "upto" permits a payment up to the specified amount. Both fixed-price schemes require the price field.

const (
	MonetizationRuleSchemeExact            MonetizationRuleScheme = "exact"
	MonetizationRuleSchemeUpto             MonetizationRuleScheme = "upto"
	MonetizationRuleSchemeOriginControlled MonetizationRuleScheme = "origin_controlled"
)

func (MonetizationRuleScheme) IsKnown

func (r MonetizationRuleScheme) IsKnown() bool

type MonetizationRuleUnion

type MonetizationRuleUnion interface {
	// contains filtered or unexported methods
}

Payment rule with a fixed price set at configuration time.

Union satisfied by MonetizationRuleMonetizationRulesMonetizationRuleInputFixedPrice or MonetizationRuleMonetizationRulesMonetizationRuleInputOriginControlled.

type MonetizationRulesetInputParam

type MonetizationRulesetInputParam struct {
	// Full desired Payment Required ruleset. An empty array clears all payment rules.
	// The ruleset may contain at most 40 unique wallet addresses; address comparison
	// is case-insensitive. Every address must pass wallet screening before deployment.
	Rules param.Field[[]MonetizationRuleInputUnionParam] `json:"rules" api:"required"`
}

func (MonetizationRulesetInputParam) MarshalJSON

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

type MonetizationService

type MonetizationService struct {
	Options []option.RequestOption
	Rules   *RuleService
}

MonetizationService 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 NewMonetizationService method instead.

func NewMonetizationService

func NewMonetizationService(opts ...option.RequestOption) (r *MonetizationService)

NewMonetizationService 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 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 RuleDeleteParams

type RuleDeleteParams struct {
	// The unique ID of the zone.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
}

type RuleDeleteResponseEnvelope

type RuleDeleteResponseEnvelope struct {
	Errors   []RuleDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RuleDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// The zone's payment rules. Mirrors the shape of the ruleset submitted to the
	// deploy endpoint, so the response can be read back as the desired state.
	Result  MonetizationRuleCollection        `json:"result" api:"required"`
	Success RuleDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    ruleDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*RuleDeleteResponseEnvelope) UnmarshalJSON

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

type RuleDeleteResponseEnvelopeErrors

type RuleDeleteResponseEnvelopeErrors struct {
	Code    int64                                `json:"code"`
	Message string                               `json:"message"`
	JSON    ruleDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RuleDeleteResponseEnvelopeErrors) UnmarshalJSON

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

type RuleDeleteResponseEnvelopeMessages

type RuleDeleteResponseEnvelopeMessages struct {
	Code    int64                                  `json:"code"`
	Message string                                 `json:"message"`
	JSON    ruleDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RuleDeleteResponseEnvelopeMessages) UnmarshalJSON

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

type RuleDeleteResponseEnvelopeSuccess

type RuleDeleteResponseEnvelopeSuccess bool
const (
	RuleDeleteResponseEnvelopeSuccessTrue RuleDeleteResponseEnvelopeSuccess = true
)

func (RuleDeleteResponseEnvelopeSuccess) IsKnown

type RuleDeleteRuleParams

type RuleDeleteRuleParams struct {
	// The unique ID of the zone.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
}

type RuleDeleteRuleResponseEnvelope

type RuleDeleteRuleResponseEnvelope struct {
	Errors   []RuleDeleteRuleResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RuleDeleteRuleResponseEnvelopeMessages `json:"messages" api:"required"`
	// The zone's payment rules. Mirrors the shape of the ruleset submitted to the
	// deploy endpoint, so the response can be read back as the desired state.
	Result  MonetizationRuleCollection            `json:"result" api:"required"`
	Success RuleDeleteRuleResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    ruleDeleteRuleResponseEnvelopeJSON    `json:"-"`
}

func (*RuleDeleteRuleResponseEnvelope) UnmarshalJSON

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

type RuleDeleteRuleResponseEnvelopeErrors

type RuleDeleteRuleResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code"`
	Message string                                   `json:"message"`
	JSON    ruleDeleteRuleResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RuleDeleteRuleResponseEnvelopeErrors) UnmarshalJSON

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

type RuleDeleteRuleResponseEnvelopeMessages

type RuleDeleteRuleResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code"`
	Message string                                     `json:"message"`
	JSON    ruleDeleteRuleResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RuleDeleteRuleResponseEnvelopeMessages) UnmarshalJSON

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

type RuleDeleteRuleResponseEnvelopeSuccess

type RuleDeleteRuleResponseEnvelopeSuccess bool
const (
	RuleDeleteRuleResponseEnvelopeSuccessTrue RuleDeleteRuleResponseEnvelopeSuccess = true
)

func (RuleDeleteRuleResponseEnvelopeSuccess) IsKnown

type RuleEditRuleParams

type RuleEditRuleParams struct {
	// The unique ID of the zone.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
	// Partial update to a single payment rule. Only the fields present are modified;
	// omitted fields keep their existing values.
	MonetizationRulePatch MonetizationRulePatchParam `json:"monetization_rule_patch" api:"required"`
}

func (RuleEditRuleParams) MarshalJSON

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

type RuleEditRuleResponseEnvelope

type RuleEditRuleResponseEnvelope struct {
	Errors   []RuleEditRuleResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RuleEditRuleResponseEnvelopeMessages `json:"messages" api:"required"`
	// The zone's payment rules. Mirrors the shape of the ruleset submitted to the
	// deploy endpoint, so the response can be read back as the desired state.
	Result  MonetizationRuleCollection          `json:"result" api:"required"`
	Success RuleEditRuleResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    ruleEditRuleResponseEnvelopeJSON    `json:"-"`
}

func (*RuleEditRuleResponseEnvelope) UnmarshalJSON

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

type RuleEditRuleResponseEnvelopeErrors

type RuleEditRuleResponseEnvelopeErrors struct {
	Code    int64                                  `json:"code"`
	Message string                                 `json:"message"`
	JSON    ruleEditRuleResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RuleEditRuleResponseEnvelopeErrors) UnmarshalJSON

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

type RuleEditRuleResponseEnvelopeMessages

type RuleEditRuleResponseEnvelopeMessages struct {
	Code    int64                                    `json:"code"`
	Message string                                   `json:"message"`
	JSON    ruleEditRuleResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RuleEditRuleResponseEnvelopeMessages) UnmarshalJSON

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

type RuleEditRuleResponseEnvelopeSuccess

type RuleEditRuleResponseEnvelopeSuccess bool
const (
	RuleEditRuleResponseEnvelopeSuccessTrue RuleEditRuleResponseEnvelopeSuccess = true
)

func (RuleEditRuleResponseEnvelopeSuccess) IsKnown

type RuleGetParams

type RuleGetParams struct {
	// The unique ID of the zone.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
}

type RuleGetResponseEnvelope

type RuleGetResponseEnvelope struct {
	Errors   []RuleGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RuleGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// The zone's payment rules. Mirrors the shape of the ruleset submitted to the
	// deploy endpoint, so the response can be read back as the desired state.
	Result  MonetizationRuleCollection     `json:"result" api:"required"`
	Success RuleGetResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    ruleGetResponseEnvelopeJSON    `json:"-"`
}

func (*RuleGetResponseEnvelope) UnmarshalJSON

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

type RuleGetResponseEnvelopeErrors

type RuleGetResponseEnvelopeErrors struct {
	Code    int64                             `json:"code"`
	Message string                            `json:"message"`
	JSON    ruleGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RuleGetResponseEnvelopeErrors) UnmarshalJSON

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

type RuleGetResponseEnvelopeMessages

type RuleGetResponseEnvelopeMessages struct {
	Code    int64                               `json:"code"`
	Message string                              `json:"message"`
	JSON    ruleGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RuleGetResponseEnvelopeMessages) UnmarshalJSON

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

type RuleGetResponseEnvelopeSuccess

type RuleGetResponseEnvelopeSuccess bool
const (
	RuleGetResponseEnvelopeSuccessTrue RuleGetResponseEnvelopeSuccess = true
)

func (RuleGetResponseEnvelopeSuccess) IsKnown

type RuleGetRuleParams

type RuleGetRuleParams struct {
	// The unique ID of the zone.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
}

type RuleGetRuleResponseEnvelope

type RuleGetRuleResponseEnvelope struct {
	Errors   []RuleGetRuleResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RuleGetRuleResponseEnvelopeMessages `json:"messages" api:"required"`
	// Payment rule with a fixed price set at configuration time.
	Result  MonetizationRule                   `json:"result" api:"required"`
	Success RuleGetRuleResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    ruleGetRuleResponseEnvelopeJSON    `json:"-"`
}

func (*RuleGetRuleResponseEnvelope) UnmarshalJSON

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

type RuleGetRuleResponseEnvelopeErrors

type RuleGetRuleResponseEnvelopeErrors struct {
	Code    int64                                 `json:"code"`
	Message string                                `json:"message"`
	JSON    ruleGetRuleResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RuleGetRuleResponseEnvelopeErrors) UnmarshalJSON

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

type RuleGetRuleResponseEnvelopeMessages

type RuleGetRuleResponseEnvelopeMessages struct {
	Code    int64                                   `json:"code"`
	Message string                                  `json:"message"`
	JSON    ruleGetRuleResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RuleGetRuleResponseEnvelopeMessages) UnmarshalJSON

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

type RuleGetRuleResponseEnvelopeSuccess

type RuleGetRuleResponseEnvelopeSuccess bool
const (
	RuleGetRuleResponseEnvelopeSuccessTrue RuleGetRuleResponseEnvelopeSuccess = true
)

func (RuleGetRuleResponseEnvelopeSuccess) IsKnown

type RuleService

type RuleService struct {
	Options []option.RequestOption
}

RuleService 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 NewRuleService method instead.

func NewRuleService

func NewRuleService(opts ...option.RequestOption) (r *RuleService)

NewRuleService 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 (*RuleService) Delete

Removes every Payment Required rule from the zone. Any rules the service does not own are preserved. Deleting a zone with no payment rules is a no-op. Returns the resulting (empty) rule collection.

func (*RuleService) DeleteRule

func (r *RuleService) DeleteRule(ctx context.Context, ruleID string, body RuleDeleteRuleParams, opts ...option.RequestOption) (res *MonetizationRuleCollection, err error)

Removes a single Payment Required rule identified by its ID. Every other rule is preserved. Returns the resulting rule collection.

func (*RuleService) EditRule

func (r *RuleService) EditRule(ctx context.Context, ruleID string, params RuleEditRuleParams, opts ...option.RequestOption) (res *MonetizationRuleCollection, err error)

Applies a partial update to a single Payment Required rule. Only the fields present in the request body are changed; omitted fields keep their current values. Returns the full resulting rule collection.

func (*RuleService) Get

Returns the currently deployed Payment Required rules for a zone. A zone with no Payment Required ruleset returns 404.

func (*RuleService) GetRule

func (r *RuleService) GetRule(ctx context.Context, ruleID string, query RuleGetRuleParams, opts ...option.RequestOption) (res *MonetizationRule, err error)

Returns a single Payment Required rule identified by its ID.

func (*RuleService) Update

Replaces the zone's Payment Required ruleset with the submitted desired state. Submit an empty rules array to clear all payment rules.

type RuleUpdateParams

type RuleUpdateParams struct {
	// The unique ID of the zone.
	ZoneID                   param.Field[string]           `path:"zone_id" api:"required"`
	MonetizationRulesetInput MonetizationRulesetInputParam `json:"monetization_ruleset_input" api:"required"`
}

func (RuleUpdateParams) MarshalJSON

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

type RuleUpdateResponseEnvelope

type RuleUpdateResponseEnvelope struct {
	Errors   []RuleUpdateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []RuleUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	// The zone's payment rules. Mirrors the shape of the ruleset submitted to the
	// deploy endpoint, so the response can be read back as the desired state.
	Result  MonetizationRuleCollection        `json:"result" api:"required"`
	Success RuleUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    ruleUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*RuleUpdateResponseEnvelope) UnmarshalJSON

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

type RuleUpdateResponseEnvelopeErrors

type RuleUpdateResponseEnvelopeErrors struct {
	Code    int64                                `json:"code"`
	Message string                               `json:"message"`
	JSON    ruleUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RuleUpdateResponseEnvelopeErrors) UnmarshalJSON

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

type RuleUpdateResponseEnvelopeMessages

type RuleUpdateResponseEnvelopeMessages struct {
	Code    int64                                  `json:"code"`
	Message string                                 `json:"message"`
	JSON    ruleUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RuleUpdateResponseEnvelopeMessages) UnmarshalJSON

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

type RuleUpdateResponseEnvelopeSuccess

type RuleUpdateResponseEnvelopeSuccess bool
const (
	RuleUpdateResponseEnvelopeSuccessTrue RuleUpdateResponseEnvelopeSuccess = true
)

func (RuleUpdateResponseEnvelopeSuccess) IsKnown

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