zaraz

package
v6.2.0 Latest Latest
Warning

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

Go to latest
Published: Oct 23, 2025 License: Apache-2.0 Imports: 17 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 ButtonTextTranslation

type ButtonTextTranslation struct {
	// Object where keys are language codes
	AcceptAll map[string]string `json:"accept_all,required"`
	// Object where keys are language codes
	ConfirmMyChoices map[string]string `json:"confirm_my_choices,required"`
	// Object where keys are language codes
	RejectAll map[string]string         `json:"reject_all,required"`
	JSON      buttonTextTranslationJSON `json:"-"`
}

func (*ButtonTextTranslation) UnmarshalJSON

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

type ButtonTextTranslationParam

type ButtonTextTranslationParam struct {
	// Object where keys are language codes
	AcceptAll param.Field[map[string]string] `json:"accept_all,required"`
	// Object where keys are language codes
	ConfirmMyChoices param.Field[map[string]string] `json:"confirm_my_choices,required"`
	// Object where keys are language codes
	RejectAll param.Field[map[string]string] `json:"reject_all,required"`
}

func (ButtonTextTranslationParam) MarshalJSON

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

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 ConfigGetParams

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

type ConfigGetResponseEnvelope

type ConfigGetResponseEnvelope struct {
	Errors   []ConfigGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ConfigGetResponseEnvelopeMessages `json:"messages,required"`
	// Zaraz configuration
	Result Configuration `json:"result,required"`
	// Whether the API call was successful
	Success bool                          `json:"success,required"`
	JSON    configGetResponseEnvelopeJSON `json:"-"`
}

func (*ConfigGetResponseEnvelope) UnmarshalJSON

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

type ConfigGetResponseEnvelopeErrors

type ConfigGetResponseEnvelopeErrors struct {
	Code             int64                                 `json:"code,required"`
	Message          string                                `json:"message,required"`
	DocumentationURL string                                `json:"documentation_url"`
	Source           ConfigGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             configGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ConfigGetResponseEnvelopeErrors) UnmarshalJSON

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

type ConfigGetResponseEnvelopeErrorsSource

type ConfigGetResponseEnvelopeErrorsSource struct {
	Pointer string                                    `json:"pointer"`
	JSON    configGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ConfigGetResponseEnvelopeErrorsSource) UnmarshalJSON

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

type ConfigGetResponseEnvelopeMessages

type ConfigGetResponseEnvelopeMessages struct {
	Code             int64                                   `json:"code,required"`
	Message          string                                  `json:"message,required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           ConfigGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             configGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ConfigGetResponseEnvelopeMessages) UnmarshalJSON

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

type ConfigGetResponseEnvelopeMessagesSource

type ConfigGetResponseEnvelopeMessagesSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    configGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ConfigGetResponseEnvelopeMessagesSource) UnmarshalJSON

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

type ConfigService

type ConfigService struct {
	Options []option.RequestOption
}

ConfigService 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 NewConfigService method instead.

func NewConfigService

func NewConfigService(opts ...option.RequestOption) (r *ConfigService)

NewConfigService 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 (*ConfigService) Get

func (r *ConfigService) Get(ctx context.Context, query ConfigGetParams, opts ...option.RequestOption) (res *Configuration, err error)

Gets latest Zaraz configuration for a zone. It can be preview or published configuration, whichever was the last updated. Secret variables values will not be included.

func (*ConfigService) Update

func (r *ConfigService) Update(ctx context.Context, params ConfigUpdateParams, opts ...option.RequestOption) (res *Configuration, err error)

Updates Zaraz configuration for a zone.

type ConfigUpdateParams

type ConfigUpdateParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Data layer compatibility mode enabled.
	DataLayer param.Field[bool] `json:"dataLayer,required"`
	// The key for Zaraz debug mode.
	DebugKey param.Field[string] `json:"debugKey,required"`
	// General Zaraz settings.
	Settings param.Field[ConfigUpdateParamsSettings] `json:"settings,required"`
	// Tools set up under Zaraz configuration, where key is the alpha-numeric tool ID
	// and value is the tool configuration object.
	Tools param.Field[map[string]ConfigUpdateParamsToolsUnion] `json:"tools,required"`
	// Triggers set up under Zaraz configuration, where key is the trigger
	// alpha-numeric ID and value is the trigger configuration.
	Triggers param.Field[map[string]ConfigUpdateParamsTriggers] `json:"triggers,required"`
	// Variables set up under Zaraz configuration, where key is the variable
	// alpha-numeric ID and value is the variable configuration. Values of variables of
	// type secret are not included.
	Variables param.Field[map[string]ConfigUpdateParamsVariablesUnion] `json:"variables,required"`
	// Zaraz internal version of the config.
	ZarazVersion param.Field[int64] `json:"zarazVersion,required"`
	// Cloudflare Monitoring settings.
	Analytics param.Field[ConfigUpdateParamsAnalytics] `json:"analytics"`
	// Consent management configuration.
	Consent param.Field[ConfigUpdateParamsConsent] `json:"consent"`
	// Single Page Application support enabled.
	HistoryChange param.Field[bool] `json:"historyChange"`
}

func (ConfigUpdateParams) MarshalJSON

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

type ConfigUpdateParamsAnalytics

type ConfigUpdateParamsAnalytics struct {
	// Consent purpose assigned to Monitoring.
	DefaultPurpose param.Field[string] `json:"defaultPurpose"`
	// Whether Advanced Monitoring reports are enabled.
	Enabled param.Field[bool] `json:"enabled"`
	// Session expiration time (seconds).
	SessionExpTime param.Field[int64] `json:"sessionExpTime"`
}

Cloudflare Monitoring settings.

func (ConfigUpdateParamsAnalytics) MarshalJSON

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

type ConfigUpdateParamsConsent

type ConfigUpdateParamsConsent struct {
	Enabled                param.Field[bool]                       `json:"enabled,required"`
	ButtonTextTranslations param.Field[ButtonTextTranslationParam] `json:"buttonTextTranslations"`
	CompanyEmail           param.Field[string]                     `json:"companyEmail"`
	CompanyName            param.Field[string]                     `json:"companyName"`
	CompanyStreetAddress   param.Field[string]                     `json:"companyStreetAddress"`
	ConsentModalIntroHTML  param.Field[string]                     `json:"consentModalIntroHTML"`
	// Object where keys are language codes
	ConsentModalIntroHTMLWithTranslations param.Field[map[string]string] `json:"consentModalIntroHTMLWithTranslations"`
	CookieName                            param.Field[string]            `json:"cookieName"`
	CustomCSS                             param.Field[string]            `json:"customCSS"`
	CustomIntroDisclaimerDismissed        param.Field[bool]              `json:"customIntroDisclaimerDismissed"`
	DefaultLanguage                       param.Field[string]            `json:"defaultLanguage"`
	HideModal                             param.Field[bool]              `json:"hideModal"`
	// Object where keys are purpose alpha-numeric IDs
	Purposes param.Field[map[string]ConfigUpdateParamsConsentPurposes] `json:"purposes"`
	// Object where keys are purpose alpha-numeric IDs
	PurposesWithTranslations param.Field[map[string]ConfigUpdateParamsConsentPurposesWithTranslations] `json:"purposesWithTranslations"`
	TcfCompliant             param.Field[bool]                                                         `json:"tcfCompliant"`
}

Consent management configuration.

func (ConfigUpdateParamsConsent) MarshalJSON

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

type ConfigUpdateParamsConsentPurposes

type ConfigUpdateParamsConsentPurposes struct {
	Description param.Field[string] `json:"description,required"`
	Name        param.Field[string] `json:"name,required"`
}

func (ConfigUpdateParamsConsentPurposes) MarshalJSON

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

type ConfigUpdateParamsConsentPurposesWithTranslations

type ConfigUpdateParamsConsentPurposesWithTranslations struct {
	// Object where keys are language codes
	Description param.Field[map[string]string] `json:"description,required"`
	// Object where keys are language codes
	Name  param.Field[map[string]string] `json:"name,required"`
	Order param.Field[int64]             `json:"order,required"`
}

func (ConfigUpdateParamsConsentPurposesWithTranslations) MarshalJSON

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

type ConfigUpdateParamsSettings

type ConfigUpdateParamsSettings struct {
	// Automatic injection of Zaraz scripts enabled.
	AutoInjectScript param.Field[bool] `json:"autoInjectScript,required"`
	// Details of the worker that receives and edits Zaraz Context object.
	ContextEnricher param.Field[ConfigUpdateParamsSettingsContextEnricher] `json:"contextEnricher"`
	// The domain Zaraz will use for writing and reading its cookies.
	CookieDomain param.Field[string] `json:"cookieDomain"`
	// Ecommerce API enabled.
	Ecommerce param.Field[bool] `json:"ecommerce"`
	// Custom endpoint for server-side track events.
	EventsAPIPath param.Field[string] `json:"eventsApiPath"`
	// Hiding external referrer URL enabled.
	HideExternalReferer param.Field[bool] `json:"hideExternalReferer"`
	// Trimming IP address enabled.
	HideIPAddress param.Field[bool] `json:"hideIPAddress"`
	// Removing URL query params enabled.
	HideQueryParams param.Field[bool] `json:"hideQueryParams"`
	// Removing sensitive data from User Aagent string enabled.
	HideUserAgent param.Field[bool] `json:"hideUserAgent"`
	// Custom endpoint for Zaraz init script.
	InitPath param.Field[string] `json:"initPath"`
	// Injection of Zaraz scripts into iframes enabled.
	InjectIframes param.Field[bool] `json:"injectIframes"`
	// Custom path for Managed Components server functionalities.
	McRootPath param.Field[string] `json:"mcRootPath"`
	// Custom endpoint for Zaraz main script.
	ScriptPath param.Field[string] `json:"scriptPath"`
	// Custom endpoint for Zaraz tracking requests.
	TrackPath param.Field[string] `json:"trackPath"`
}

General Zaraz settings.

func (ConfigUpdateParamsSettings) MarshalJSON

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

type ConfigUpdateParamsSettingsContextEnricher

type ConfigUpdateParamsSettingsContextEnricher struct {
	EscapedWorkerName param.Field[string] `json:"escapedWorkerName,required"`
	WorkerTag         param.Field[string] `json:"workerTag,required"`
}

Details of the worker that receives and edits Zaraz Context object.

func (ConfigUpdateParamsSettingsContextEnricher) MarshalJSON

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

type ConfigUpdateParamsTools

type ConfigUpdateParamsTools struct {
	BlockingTriggers param.Field[interface{}] `json:"blockingTriggers,required"`
	// Tool's internal name
	Component     param.Field[string]      `json:"component,required"`
	DefaultFields param.Field[interface{}] `json:"defaultFields,required"`
	// Whether tool is enabled
	Enabled param.Field[bool] `json:"enabled,required"`
	// Tool's name defined by the user
	Name        param.Field[string]                      `json:"name,required"`
	Permissions param.Field[interface{}]                 `json:"permissions,required"`
	Settings    param.Field[interface{}]                 `json:"settings,required"`
	Type        param.Field[ConfigUpdateParamsToolsType] `json:"type,required"`
	Actions     param.Field[interface{}]                 `json:"actions"`
	// Default consent purpose ID
	DefaultPurpose param.Field[string]      `json:"defaultPurpose"`
	NeoEvents      param.Field[interface{}] `json:"neoEvents"`
	// Vendor name for TCF compliant consent modal, required for Custom Managed
	// Components and Custom HTML tool with a defaultPurpose assigned
	VendorName param.Field[string] `json:"vendorName"`
	// Vendor's Privacy Policy URL for TCF compliant consent modal, required for Custom
	// Managed Components and Custom HTML tool with a defaultPurpose assigned
	VendorPolicyURL param.Field[string]      `json:"vendorPolicyUrl"`
	Worker          param.Field[interface{}] `json:"worker"`
}

func (ConfigUpdateParamsTools) MarshalJSON

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

type ConfigUpdateParamsToolsType

type ConfigUpdateParamsToolsType string
const (
	ConfigUpdateParamsToolsTypeComponent ConfigUpdateParamsToolsType = "component"
	ConfigUpdateParamsToolsTypeCustomMc  ConfigUpdateParamsToolsType = "custom-mc"
)

func (ConfigUpdateParamsToolsType) IsKnown

func (r ConfigUpdateParamsToolsType) IsKnown() bool

type ConfigUpdateParamsToolsUnion

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

Satisfied by zaraz.ConfigUpdateParamsToolsZarazManagedComponent, zaraz.ConfigUpdateParamsToolsWorker, ConfigUpdateParamsTools.

type ConfigUpdateParamsToolsWorker

type ConfigUpdateParamsToolsWorker struct {
	// List of blocking trigger IDs
	BlockingTriggers param.Field[[]string] `json:"blockingTriggers,required"`
	// Tool's internal name
	Component param.Field[string] `json:"component,required"`
	// Default fields for tool's actions
	DefaultFields param.Field[map[string]ConfigUpdateParamsToolsWorkerDefaultFieldsUnion] `json:"defaultFields,required"`
	// Whether tool is enabled
	Enabled param.Field[bool] `json:"enabled,required"`
	// Tool's name defined by the user
	Name param.Field[string] `json:"name,required"`
	// List of permissions granted to the component
	Permissions param.Field[[]string] `json:"permissions,required"`
	// Tool's settings
	Settings param.Field[map[string]ConfigUpdateParamsToolsWorkerSettingsUnion] `json:"settings,required"`
	Type     param.Field[ConfigUpdateParamsToolsWorkerType]                     `json:"type,required"`
	// Cloudflare worker that acts as a managed component
	Worker param.Field[ConfigUpdateParamsToolsWorkerWorker] `json:"worker,required"`
	// Actions configured on a tool. Either this or neoEvents field is required.
	Actions param.Field[map[string]NeoEventParam] `json:"actions"`
	// Default consent purpose ID
	DefaultPurpose param.Field[string] `json:"defaultPurpose"`
	// DEPRECATED - List of actions configured on a tool. Either this or actions field
	// is required. If both are present, actions field will take precedence.
	NeoEvents param.Field[[]NeoEventParam] `json:"neoEvents"`
	// Vendor name for TCF compliant consent modal, required for Custom Managed
	// Components and Custom HTML tool with a defaultPurpose assigned
	VendorName param.Field[string] `json:"vendorName"`
	// Vendor's Privacy Policy URL for TCF compliant consent modal, required for Custom
	// Managed Components and Custom HTML tool with a defaultPurpose assigned
	VendorPolicyURL param.Field[string] `json:"vendorPolicyUrl"`
}

func (ConfigUpdateParamsToolsWorker) MarshalJSON

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

type ConfigUpdateParamsToolsWorkerDefaultFieldsUnion

type ConfigUpdateParamsToolsWorkerDefaultFieldsUnion interface {
	ImplementsConfigUpdateParamsToolsWorkerDefaultFieldsUnion()
}

Satisfied by shared.UnionString, shared.UnionBool.

type ConfigUpdateParamsToolsWorkerSettingsUnion

type ConfigUpdateParamsToolsWorkerSettingsUnion interface {
	ImplementsConfigUpdateParamsToolsWorkerSettingsUnion()
}

Satisfied by shared.UnionString, shared.UnionBool.

type ConfigUpdateParamsToolsWorkerType

type ConfigUpdateParamsToolsWorkerType string
const (
	ConfigUpdateParamsToolsWorkerTypeCustomMc ConfigUpdateParamsToolsWorkerType = "custom-mc"
)

func (ConfigUpdateParamsToolsWorkerType) IsKnown

type ConfigUpdateParamsToolsWorkerWorker

type ConfigUpdateParamsToolsWorkerWorker struct {
	EscapedWorkerName param.Field[string] `json:"escapedWorkerName,required"`
	WorkerTag         param.Field[string] `json:"workerTag,required"`
}

Cloudflare worker that acts as a managed component

func (ConfigUpdateParamsToolsWorkerWorker) MarshalJSON

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

type ConfigUpdateParamsToolsZarazManagedComponent

type ConfigUpdateParamsToolsZarazManagedComponent struct {
	// List of blocking trigger IDs
	BlockingTriggers param.Field[[]string] `json:"blockingTriggers,required"`
	// Tool's internal name
	Component param.Field[string] `json:"component,required"`
	// Default fields for tool's actions
	DefaultFields param.Field[map[string]ConfigUpdateParamsToolsZarazManagedComponentDefaultFieldsUnion] `json:"defaultFields,required"`
	// Whether tool is enabled
	Enabled param.Field[bool] `json:"enabled,required"`
	// Tool's name defined by the user
	Name param.Field[string] `json:"name,required"`
	// List of permissions granted to the component
	Permissions param.Field[[]string] `json:"permissions,required"`
	// Tool's settings
	Settings param.Field[map[string]ConfigUpdateParamsToolsZarazManagedComponentSettingsUnion] `json:"settings,required"`
	Type     param.Field[ConfigUpdateParamsToolsZarazManagedComponentType]                     `json:"type,required"`
	// Actions configured on a tool. Either this or neoEvents field is required.
	Actions param.Field[map[string]NeoEventParam] `json:"actions"`
	// Default consent purpose ID
	DefaultPurpose param.Field[string] `json:"defaultPurpose"`
	// DEPRECATED - List of actions configured on a tool. Either this or actions field
	// is required. If both are present, actions field will take precedence.
	NeoEvents param.Field[[]NeoEventParam] `json:"neoEvents"`
	// Vendor name for TCF compliant consent modal, required for Custom Managed
	// Components and Custom HTML tool with a defaultPurpose assigned
	VendorName param.Field[string] `json:"vendorName"`
	// Vendor's Privacy Policy URL for TCF compliant consent modal, required for Custom
	// Managed Components and Custom HTML tool with a defaultPurpose assigned
	VendorPolicyURL param.Field[string] `json:"vendorPolicyUrl"`
}

func (ConfigUpdateParamsToolsZarazManagedComponent) MarshalJSON

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

type ConfigUpdateParamsToolsZarazManagedComponentDefaultFieldsUnion

type ConfigUpdateParamsToolsZarazManagedComponentDefaultFieldsUnion interface {
	ImplementsConfigUpdateParamsToolsZarazManagedComponentDefaultFieldsUnion()
}

Satisfied by shared.UnionString, shared.UnionBool.

type ConfigUpdateParamsToolsZarazManagedComponentSettingsUnion

type ConfigUpdateParamsToolsZarazManagedComponentSettingsUnion interface {
	ImplementsConfigUpdateParamsToolsZarazManagedComponentSettingsUnion()
}

Satisfied by shared.UnionString, shared.UnionBool.

type ConfigUpdateParamsToolsZarazManagedComponentType

type ConfigUpdateParamsToolsZarazManagedComponentType string
const (
	ConfigUpdateParamsToolsZarazManagedComponentTypeComponent ConfigUpdateParamsToolsZarazManagedComponentType = "component"
)

func (ConfigUpdateParamsToolsZarazManagedComponentType) IsKnown

type ConfigUpdateParamsTriggers

type ConfigUpdateParamsTriggers struct {
	// Rules defining when the trigger is not fired.
	ExcludeRules param.Field[[]ConfigUpdateParamsTriggersExcludeRuleUnion] `json:"excludeRules,required"`
	// Rules defining when the trigger is fired.
	LoadRules param.Field[[]ConfigUpdateParamsTriggersLoadRuleUnion] `json:"loadRules,required"`
	// Trigger name.
	Name param.Field[string] `json:"name,required"`
	// Trigger description.
	Description param.Field[string]                           `json:"description"`
	System      param.Field[ConfigUpdateParamsTriggersSystem] `json:"system"`
}

func (ConfigUpdateParamsTriggers) MarshalJSON

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

type ConfigUpdateParamsTriggersExcludeRule

type ConfigUpdateParamsTriggersExcludeRule struct {
	ID       param.Field[string]                                       `json:"id,required"`
	Action   param.Field[ConfigUpdateParamsTriggersExcludeRulesAction] `json:"action"`
	Match    param.Field[string]                                       `json:"match"`
	Op       param.Field[ConfigUpdateParamsTriggersExcludeRulesOp]     `json:"op"`
	Settings param.Field[interface{}]                                  `json:"settings"`
	Value    param.Field[string]                                       `json:"value"`
}

func (ConfigUpdateParamsTriggersExcludeRule) MarshalJSON

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

type ConfigUpdateParamsTriggersExcludeRulesAction

type ConfigUpdateParamsTriggersExcludeRulesAction string
const (
	ConfigUpdateParamsTriggersExcludeRulesActionClickListener     ConfigUpdateParamsTriggersExcludeRulesAction = "clickListener"
	ConfigUpdateParamsTriggersExcludeRulesActionTimer             ConfigUpdateParamsTriggersExcludeRulesAction = "timer"
	ConfigUpdateParamsTriggersExcludeRulesActionFormSubmission    ConfigUpdateParamsTriggersExcludeRulesAction = "formSubmission"
	ConfigUpdateParamsTriggersExcludeRulesActionVariableMatch     ConfigUpdateParamsTriggersExcludeRulesAction = "variableMatch"
	ConfigUpdateParamsTriggersExcludeRulesActionScrollDepth       ConfigUpdateParamsTriggersExcludeRulesAction = "scrollDepth"
	ConfigUpdateParamsTriggersExcludeRulesActionElementVisibility ConfigUpdateParamsTriggersExcludeRulesAction = "elementVisibility"
)

func (ConfigUpdateParamsTriggersExcludeRulesAction) IsKnown

type ConfigUpdateParamsTriggersExcludeRulesOp

type ConfigUpdateParamsTriggersExcludeRulesOp string
const (
	ConfigUpdateParamsTriggersExcludeRulesOpContains           ConfigUpdateParamsTriggersExcludeRulesOp = "CONTAINS"
	ConfigUpdateParamsTriggersExcludeRulesOpEquals             ConfigUpdateParamsTriggersExcludeRulesOp = "EQUALS"
	ConfigUpdateParamsTriggersExcludeRulesOpStartsWith         ConfigUpdateParamsTriggersExcludeRulesOp = "STARTS_WITH"
	ConfigUpdateParamsTriggersExcludeRulesOpEndsWith           ConfigUpdateParamsTriggersExcludeRulesOp = "ENDS_WITH"
	ConfigUpdateParamsTriggersExcludeRulesOpMatchRegex         ConfigUpdateParamsTriggersExcludeRulesOp = "MATCH_REGEX"
	ConfigUpdateParamsTriggersExcludeRulesOpNotMatchRegex      ConfigUpdateParamsTriggersExcludeRulesOp = "NOT_MATCH_REGEX"
	ConfigUpdateParamsTriggersExcludeRulesOpGreaterThan        ConfigUpdateParamsTriggersExcludeRulesOp = "GREATER_THAN"
	ConfigUpdateParamsTriggersExcludeRulesOpGreaterThanOrEqual ConfigUpdateParamsTriggersExcludeRulesOp = "GREATER_THAN_OR_EQUAL"
	ConfigUpdateParamsTriggersExcludeRulesOpLessThan           ConfigUpdateParamsTriggersExcludeRulesOp = "LESS_THAN"
	ConfigUpdateParamsTriggersExcludeRulesOpLessThanOrEqual    ConfigUpdateParamsTriggersExcludeRulesOp = "LESS_THAN_OR_EQUAL"
)

func (ConfigUpdateParamsTriggersExcludeRulesOp) IsKnown

type ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRule

type ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRule struct {
	ID       param.Field[string]                                                               `json:"id,required"`
	Action   param.Field[ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleAction]   `json:"action,required"`
	Settings param.Field[ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleSettings] `json:"settings,required"`
}

func (ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRule) MarshalJSON

type ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleAction

type ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleAction string
const (
	ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleActionClickListener ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleAction = "clickListener"
)

func (ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleAction) IsKnown

type ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleSettings

type ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleSettings struct {
	Selector    param.Field[string]                                                                   `json:"selector,required"`
	Type        param.Field[ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleSettingsType] `json:"type,required"`
	WaitForTags param.Field[int64]                                                                    `json:"waitForTags,required"`
}

func (ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleSettings) MarshalJSON

type ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleSettingsType

type ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleSettingsType string
const (
	ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleSettingsTypeXpath ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleSettingsType = "xpath"
	ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleSettingsTypeCSS   ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleSettingsType = "css"
)

func (ConfigUpdateParamsTriggersExcludeRulesZarazClickListenerRuleSettingsType) IsKnown

type ConfigUpdateParamsTriggersExcludeRulesZarazElementVisibilityRule

type ConfigUpdateParamsTriggersExcludeRulesZarazElementVisibilityRule struct {
	ID       param.Field[string]                                                                   `json:"id,required"`
	Action   param.Field[ConfigUpdateParamsTriggersExcludeRulesZarazElementVisibilityRuleAction]   `json:"action,required"`
	Settings param.Field[ConfigUpdateParamsTriggersExcludeRulesZarazElementVisibilityRuleSettings] `json:"settings,required"`
}

func (ConfigUpdateParamsTriggersExcludeRulesZarazElementVisibilityRule) MarshalJSON

type ConfigUpdateParamsTriggersExcludeRulesZarazElementVisibilityRuleAction

type ConfigUpdateParamsTriggersExcludeRulesZarazElementVisibilityRuleAction string
const (
	ConfigUpdateParamsTriggersExcludeRulesZarazElementVisibilityRuleActionElementVisibility ConfigUpdateParamsTriggersExcludeRulesZarazElementVisibilityRuleAction = "elementVisibility"
)

func (ConfigUpdateParamsTriggersExcludeRulesZarazElementVisibilityRuleAction) IsKnown

type ConfigUpdateParamsTriggersExcludeRulesZarazElementVisibilityRuleSettings

type ConfigUpdateParamsTriggersExcludeRulesZarazElementVisibilityRuleSettings struct {
	Selector param.Field[string] `json:"selector,required"`
}

func (ConfigUpdateParamsTriggersExcludeRulesZarazElementVisibilityRuleSettings) MarshalJSON

type ConfigUpdateParamsTriggersExcludeRulesZarazFormSubmissionRule

type ConfigUpdateParamsTriggersExcludeRulesZarazFormSubmissionRule struct {
	ID       param.Field[string]                                                                `json:"id,required"`
	Action   param.Field[ConfigUpdateParamsTriggersExcludeRulesZarazFormSubmissionRuleAction]   `json:"action,required"`
	Settings param.Field[ConfigUpdateParamsTriggersExcludeRulesZarazFormSubmissionRuleSettings] `json:"settings,required"`
}

func (ConfigUpdateParamsTriggersExcludeRulesZarazFormSubmissionRule) MarshalJSON

type ConfigUpdateParamsTriggersExcludeRulesZarazFormSubmissionRuleAction

type ConfigUpdateParamsTriggersExcludeRulesZarazFormSubmissionRuleAction string
const (
	ConfigUpdateParamsTriggersExcludeRulesZarazFormSubmissionRuleActionFormSubmission ConfigUpdateParamsTriggersExcludeRulesZarazFormSubmissionRuleAction = "formSubmission"
)

func (ConfigUpdateParamsTriggersExcludeRulesZarazFormSubmissionRuleAction) IsKnown

type ConfigUpdateParamsTriggersExcludeRulesZarazFormSubmissionRuleSettings

type ConfigUpdateParamsTriggersExcludeRulesZarazFormSubmissionRuleSettings struct {
	Selector param.Field[string] `json:"selector,required"`
	Validate param.Field[bool]   `json:"validate,required"`
}

func (ConfigUpdateParamsTriggersExcludeRulesZarazFormSubmissionRuleSettings) MarshalJSON

type ConfigUpdateParamsTriggersExcludeRulesZarazLoadRule

type ConfigUpdateParamsTriggersExcludeRulesZarazLoadRule struct {
	ID    param.Field[string]                                                `json:"id,required"`
	Match param.Field[string]                                                `json:"match,required"`
	Op    param.Field[ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOp] `json:"op,required"`
	Value param.Field[string]                                                `json:"value,required"`
}

func (ConfigUpdateParamsTriggersExcludeRulesZarazLoadRule) MarshalJSON

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

type ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOp

type ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOp string
const (
	ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOpContains           ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOp = "CONTAINS"
	ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOpEquals             ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOp = "EQUALS"
	ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOpStartsWith         ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOp = "STARTS_WITH"
	ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOpEndsWith           ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOp = "ENDS_WITH"
	ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOpMatchRegex         ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOp = "MATCH_REGEX"
	ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOpNotMatchRegex      ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOp = "NOT_MATCH_REGEX"
	ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOpGreaterThan        ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOp = "GREATER_THAN"
	ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOpGreaterThanOrEqual ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOp = "GREATER_THAN_OR_EQUAL"
	ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOpLessThan           ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOp = "LESS_THAN"
	ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOpLessThanOrEqual    ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOp = "LESS_THAN_OR_EQUAL"
)

func (ConfigUpdateParamsTriggersExcludeRulesZarazLoadRuleOp) IsKnown

type ConfigUpdateParamsTriggersExcludeRulesZarazScrollDepthRule

type ConfigUpdateParamsTriggersExcludeRulesZarazScrollDepthRule struct {
	ID       param.Field[string]                                                             `json:"id,required"`
	Action   param.Field[ConfigUpdateParamsTriggersExcludeRulesZarazScrollDepthRuleAction]   `json:"action,required"`
	Settings param.Field[ConfigUpdateParamsTriggersExcludeRulesZarazScrollDepthRuleSettings] `json:"settings,required"`
}

func (ConfigUpdateParamsTriggersExcludeRulesZarazScrollDepthRule) MarshalJSON

type ConfigUpdateParamsTriggersExcludeRulesZarazScrollDepthRuleAction

type ConfigUpdateParamsTriggersExcludeRulesZarazScrollDepthRuleAction string
const (
	ConfigUpdateParamsTriggersExcludeRulesZarazScrollDepthRuleActionScrollDepth ConfigUpdateParamsTriggersExcludeRulesZarazScrollDepthRuleAction = "scrollDepth"
)

func (ConfigUpdateParamsTriggersExcludeRulesZarazScrollDepthRuleAction) IsKnown

type ConfigUpdateParamsTriggersExcludeRulesZarazScrollDepthRuleSettings

type ConfigUpdateParamsTriggersExcludeRulesZarazScrollDepthRuleSettings struct {
	Positions param.Field[string] `json:"positions,required"`
}

func (ConfigUpdateParamsTriggersExcludeRulesZarazScrollDepthRuleSettings) MarshalJSON

type ConfigUpdateParamsTriggersExcludeRulesZarazTimerRule

type ConfigUpdateParamsTriggersExcludeRulesZarazTimerRule struct {
	ID       param.Field[string]                                                       `json:"id,required"`
	Action   param.Field[ConfigUpdateParamsTriggersExcludeRulesZarazTimerRuleAction]   `json:"action,required"`
	Settings param.Field[ConfigUpdateParamsTriggersExcludeRulesZarazTimerRuleSettings] `json:"settings,required"`
}

func (ConfigUpdateParamsTriggersExcludeRulesZarazTimerRule) MarshalJSON

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

type ConfigUpdateParamsTriggersExcludeRulesZarazTimerRuleAction

type ConfigUpdateParamsTriggersExcludeRulesZarazTimerRuleAction string
const (
	ConfigUpdateParamsTriggersExcludeRulesZarazTimerRuleActionTimer ConfigUpdateParamsTriggersExcludeRulesZarazTimerRuleAction = "timer"
)

func (ConfigUpdateParamsTriggersExcludeRulesZarazTimerRuleAction) IsKnown

type ConfigUpdateParamsTriggersExcludeRulesZarazTimerRuleSettings

type ConfigUpdateParamsTriggersExcludeRulesZarazTimerRuleSettings struct {
	Interval param.Field[int64] `json:"interval,required"`
	Limit    param.Field[int64] `json:"limit,required"`
}

func (ConfigUpdateParamsTriggersExcludeRulesZarazTimerRuleSettings) MarshalJSON

type ConfigUpdateParamsTriggersExcludeRulesZarazVariableMatchRule

type ConfigUpdateParamsTriggersExcludeRulesZarazVariableMatchRule struct {
	ID       param.Field[string]                                                               `json:"id,required"`
	Action   param.Field[ConfigUpdateParamsTriggersExcludeRulesZarazVariableMatchRuleAction]   `json:"action,required"`
	Settings param.Field[ConfigUpdateParamsTriggersExcludeRulesZarazVariableMatchRuleSettings] `json:"settings,required"`
}

func (ConfigUpdateParamsTriggersExcludeRulesZarazVariableMatchRule) MarshalJSON

type ConfigUpdateParamsTriggersExcludeRulesZarazVariableMatchRuleAction

type ConfigUpdateParamsTriggersExcludeRulesZarazVariableMatchRuleAction string
const (
	ConfigUpdateParamsTriggersExcludeRulesZarazVariableMatchRuleActionVariableMatch ConfigUpdateParamsTriggersExcludeRulesZarazVariableMatchRuleAction = "variableMatch"
)

func (ConfigUpdateParamsTriggersExcludeRulesZarazVariableMatchRuleAction) IsKnown

type ConfigUpdateParamsTriggersExcludeRulesZarazVariableMatchRuleSettings

type ConfigUpdateParamsTriggersExcludeRulesZarazVariableMatchRuleSettings struct {
	Match    param.Field[string] `json:"match,required"`
	Variable param.Field[string] `json:"variable,required"`
}

func (ConfigUpdateParamsTriggersExcludeRulesZarazVariableMatchRuleSettings) MarshalJSON

type ConfigUpdateParamsTriggersLoadRule

type ConfigUpdateParamsTriggersLoadRule struct {
	ID       param.Field[string]                                    `json:"id,required"`
	Action   param.Field[ConfigUpdateParamsTriggersLoadRulesAction] `json:"action"`
	Match    param.Field[string]                                    `json:"match"`
	Op       param.Field[ConfigUpdateParamsTriggersLoadRulesOp]     `json:"op"`
	Settings param.Field[interface{}]                               `json:"settings"`
	Value    param.Field[string]                                    `json:"value"`
}

func (ConfigUpdateParamsTriggersLoadRule) MarshalJSON

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

type ConfigUpdateParamsTriggersLoadRulesAction

type ConfigUpdateParamsTriggersLoadRulesAction string
const (
	ConfigUpdateParamsTriggersLoadRulesActionClickListener     ConfigUpdateParamsTriggersLoadRulesAction = "clickListener"
	ConfigUpdateParamsTriggersLoadRulesActionTimer             ConfigUpdateParamsTriggersLoadRulesAction = "timer"
	ConfigUpdateParamsTriggersLoadRulesActionFormSubmission    ConfigUpdateParamsTriggersLoadRulesAction = "formSubmission"
	ConfigUpdateParamsTriggersLoadRulesActionVariableMatch     ConfigUpdateParamsTriggersLoadRulesAction = "variableMatch"
	ConfigUpdateParamsTriggersLoadRulesActionScrollDepth       ConfigUpdateParamsTriggersLoadRulesAction = "scrollDepth"
	ConfigUpdateParamsTriggersLoadRulesActionElementVisibility ConfigUpdateParamsTriggersLoadRulesAction = "elementVisibility"
)

func (ConfigUpdateParamsTriggersLoadRulesAction) IsKnown

type ConfigUpdateParamsTriggersLoadRulesOp

type ConfigUpdateParamsTriggersLoadRulesOp string
const (
	ConfigUpdateParamsTriggersLoadRulesOpContains           ConfigUpdateParamsTriggersLoadRulesOp = "CONTAINS"
	ConfigUpdateParamsTriggersLoadRulesOpEquals             ConfigUpdateParamsTriggersLoadRulesOp = "EQUALS"
	ConfigUpdateParamsTriggersLoadRulesOpStartsWith         ConfigUpdateParamsTriggersLoadRulesOp = "STARTS_WITH"
	ConfigUpdateParamsTriggersLoadRulesOpEndsWith           ConfigUpdateParamsTriggersLoadRulesOp = "ENDS_WITH"
	ConfigUpdateParamsTriggersLoadRulesOpMatchRegex         ConfigUpdateParamsTriggersLoadRulesOp = "MATCH_REGEX"
	ConfigUpdateParamsTriggersLoadRulesOpNotMatchRegex      ConfigUpdateParamsTriggersLoadRulesOp = "NOT_MATCH_REGEX"
	ConfigUpdateParamsTriggersLoadRulesOpGreaterThan        ConfigUpdateParamsTriggersLoadRulesOp = "GREATER_THAN"
	ConfigUpdateParamsTriggersLoadRulesOpGreaterThanOrEqual ConfigUpdateParamsTriggersLoadRulesOp = "GREATER_THAN_OR_EQUAL"
	ConfigUpdateParamsTriggersLoadRulesOpLessThan           ConfigUpdateParamsTriggersLoadRulesOp = "LESS_THAN"
	ConfigUpdateParamsTriggersLoadRulesOpLessThanOrEqual    ConfigUpdateParamsTriggersLoadRulesOp = "LESS_THAN_OR_EQUAL"
)

func (ConfigUpdateParamsTriggersLoadRulesOp) IsKnown

type ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRule

type ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRule struct {
	ID       param.Field[string]                                                            `json:"id,required"`
	Action   param.Field[ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleAction]   `json:"action,required"`
	Settings param.Field[ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleSettings] `json:"settings,required"`
}

func (ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRule) MarshalJSON

type ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleAction

type ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleAction string
const (
	ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleActionClickListener ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleAction = "clickListener"
)

func (ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleAction) IsKnown

type ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleSettings

type ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleSettings struct {
	Selector    param.Field[string]                                                                `json:"selector,required"`
	Type        param.Field[ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleSettingsType] `json:"type,required"`
	WaitForTags param.Field[int64]                                                                 `json:"waitForTags,required"`
}

func (ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleSettings) MarshalJSON

type ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleSettingsType

type ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleSettingsType string
const (
	ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleSettingsTypeXpath ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleSettingsType = "xpath"
	ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleSettingsTypeCSS   ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleSettingsType = "css"
)

func (ConfigUpdateParamsTriggersLoadRulesZarazClickListenerRuleSettingsType) IsKnown

type ConfigUpdateParamsTriggersLoadRulesZarazElementVisibilityRule

type ConfigUpdateParamsTriggersLoadRulesZarazElementVisibilityRule struct {
	ID       param.Field[string]                                                                `json:"id,required"`
	Action   param.Field[ConfigUpdateParamsTriggersLoadRulesZarazElementVisibilityRuleAction]   `json:"action,required"`
	Settings param.Field[ConfigUpdateParamsTriggersLoadRulesZarazElementVisibilityRuleSettings] `json:"settings,required"`
}

func (ConfigUpdateParamsTriggersLoadRulesZarazElementVisibilityRule) MarshalJSON

type ConfigUpdateParamsTriggersLoadRulesZarazElementVisibilityRuleAction

type ConfigUpdateParamsTriggersLoadRulesZarazElementVisibilityRuleAction string
const (
	ConfigUpdateParamsTriggersLoadRulesZarazElementVisibilityRuleActionElementVisibility ConfigUpdateParamsTriggersLoadRulesZarazElementVisibilityRuleAction = "elementVisibility"
)

func (ConfigUpdateParamsTriggersLoadRulesZarazElementVisibilityRuleAction) IsKnown

type ConfigUpdateParamsTriggersLoadRulesZarazElementVisibilityRuleSettings

type ConfigUpdateParamsTriggersLoadRulesZarazElementVisibilityRuleSettings struct {
	Selector param.Field[string] `json:"selector,required"`
}

func (ConfigUpdateParamsTriggersLoadRulesZarazElementVisibilityRuleSettings) MarshalJSON

type ConfigUpdateParamsTriggersLoadRulesZarazFormSubmissionRule

type ConfigUpdateParamsTriggersLoadRulesZarazFormSubmissionRule struct {
	ID       param.Field[string]                                                             `json:"id,required"`
	Action   param.Field[ConfigUpdateParamsTriggersLoadRulesZarazFormSubmissionRuleAction]   `json:"action,required"`
	Settings param.Field[ConfigUpdateParamsTriggersLoadRulesZarazFormSubmissionRuleSettings] `json:"settings,required"`
}

func (ConfigUpdateParamsTriggersLoadRulesZarazFormSubmissionRule) MarshalJSON

type ConfigUpdateParamsTriggersLoadRulesZarazFormSubmissionRuleAction

type ConfigUpdateParamsTriggersLoadRulesZarazFormSubmissionRuleAction string
const (
	ConfigUpdateParamsTriggersLoadRulesZarazFormSubmissionRuleActionFormSubmission ConfigUpdateParamsTriggersLoadRulesZarazFormSubmissionRuleAction = "formSubmission"
)

func (ConfigUpdateParamsTriggersLoadRulesZarazFormSubmissionRuleAction) IsKnown

type ConfigUpdateParamsTriggersLoadRulesZarazFormSubmissionRuleSettings

type ConfigUpdateParamsTriggersLoadRulesZarazFormSubmissionRuleSettings struct {
	Selector param.Field[string] `json:"selector,required"`
	Validate param.Field[bool]   `json:"validate,required"`
}

func (ConfigUpdateParamsTriggersLoadRulesZarazFormSubmissionRuleSettings) MarshalJSON

type ConfigUpdateParamsTriggersLoadRulesZarazLoadRule

type ConfigUpdateParamsTriggersLoadRulesZarazLoadRule struct {
	ID    param.Field[string]                                             `json:"id,required"`
	Match param.Field[string]                                             `json:"match,required"`
	Op    param.Field[ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOp] `json:"op,required"`
	Value param.Field[string]                                             `json:"value,required"`
}

func (ConfigUpdateParamsTriggersLoadRulesZarazLoadRule) MarshalJSON

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

type ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOp

type ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOp string
const (
	ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOpContains           ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOp = "CONTAINS"
	ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOpEquals             ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOp = "EQUALS"
	ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOpStartsWith         ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOp = "STARTS_WITH"
	ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOpEndsWith           ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOp = "ENDS_WITH"
	ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOpMatchRegex         ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOp = "MATCH_REGEX"
	ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOpNotMatchRegex      ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOp = "NOT_MATCH_REGEX"
	ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOpGreaterThan        ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOp = "GREATER_THAN"
	ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOpGreaterThanOrEqual ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOp = "GREATER_THAN_OR_EQUAL"
	ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOpLessThan           ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOp = "LESS_THAN"
	ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOpLessThanOrEqual    ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOp = "LESS_THAN_OR_EQUAL"
)

func (ConfigUpdateParamsTriggersLoadRulesZarazLoadRuleOp) IsKnown

type ConfigUpdateParamsTriggersLoadRulesZarazScrollDepthRule

type ConfigUpdateParamsTriggersLoadRulesZarazScrollDepthRule struct {
	ID       param.Field[string]                                                          `json:"id,required"`
	Action   param.Field[ConfigUpdateParamsTriggersLoadRulesZarazScrollDepthRuleAction]   `json:"action,required"`
	Settings param.Field[ConfigUpdateParamsTriggersLoadRulesZarazScrollDepthRuleSettings] `json:"settings,required"`
}

func (ConfigUpdateParamsTriggersLoadRulesZarazScrollDepthRule) MarshalJSON

type ConfigUpdateParamsTriggersLoadRulesZarazScrollDepthRuleAction

type ConfigUpdateParamsTriggersLoadRulesZarazScrollDepthRuleAction string
const (
	ConfigUpdateParamsTriggersLoadRulesZarazScrollDepthRuleActionScrollDepth ConfigUpdateParamsTriggersLoadRulesZarazScrollDepthRuleAction = "scrollDepth"
)

func (ConfigUpdateParamsTriggersLoadRulesZarazScrollDepthRuleAction) IsKnown

type ConfigUpdateParamsTriggersLoadRulesZarazScrollDepthRuleSettings

type ConfigUpdateParamsTriggersLoadRulesZarazScrollDepthRuleSettings struct {
	Positions param.Field[string] `json:"positions,required"`
}

func (ConfigUpdateParamsTriggersLoadRulesZarazScrollDepthRuleSettings) MarshalJSON

type ConfigUpdateParamsTriggersLoadRulesZarazTimerRule

type ConfigUpdateParamsTriggersLoadRulesZarazTimerRule struct {
	ID       param.Field[string]                                                    `json:"id,required"`
	Action   param.Field[ConfigUpdateParamsTriggersLoadRulesZarazTimerRuleAction]   `json:"action,required"`
	Settings param.Field[ConfigUpdateParamsTriggersLoadRulesZarazTimerRuleSettings] `json:"settings,required"`
}

func (ConfigUpdateParamsTriggersLoadRulesZarazTimerRule) MarshalJSON

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

type ConfigUpdateParamsTriggersLoadRulesZarazTimerRuleAction

type ConfigUpdateParamsTriggersLoadRulesZarazTimerRuleAction string
const (
	ConfigUpdateParamsTriggersLoadRulesZarazTimerRuleActionTimer ConfigUpdateParamsTriggersLoadRulesZarazTimerRuleAction = "timer"
)

func (ConfigUpdateParamsTriggersLoadRulesZarazTimerRuleAction) IsKnown

type ConfigUpdateParamsTriggersLoadRulesZarazTimerRuleSettings

type ConfigUpdateParamsTriggersLoadRulesZarazTimerRuleSettings struct {
	Interval param.Field[int64] `json:"interval,required"`
	Limit    param.Field[int64] `json:"limit,required"`
}

func (ConfigUpdateParamsTriggersLoadRulesZarazTimerRuleSettings) MarshalJSON

type ConfigUpdateParamsTriggersLoadRulesZarazVariableMatchRule

type ConfigUpdateParamsTriggersLoadRulesZarazVariableMatchRule struct {
	ID       param.Field[string]                                                            `json:"id,required"`
	Action   param.Field[ConfigUpdateParamsTriggersLoadRulesZarazVariableMatchRuleAction]   `json:"action,required"`
	Settings param.Field[ConfigUpdateParamsTriggersLoadRulesZarazVariableMatchRuleSettings] `json:"settings,required"`
}

func (ConfigUpdateParamsTriggersLoadRulesZarazVariableMatchRule) MarshalJSON

type ConfigUpdateParamsTriggersLoadRulesZarazVariableMatchRuleAction

type ConfigUpdateParamsTriggersLoadRulesZarazVariableMatchRuleAction string
const (
	ConfigUpdateParamsTriggersLoadRulesZarazVariableMatchRuleActionVariableMatch ConfigUpdateParamsTriggersLoadRulesZarazVariableMatchRuleAction = "variableMatch"
)

func (ConfigUpdateParamsTriggersLoadRulesZarazVariableMatchRuleAction) IsKnown

type ConfigUpdateParamsTriggersLoadRulesZarazVariableMatchRuleSettings

type ConfigUpdateParamsTriggersLoadRulesZarazVariableMatchRuleSettings struct {
	Match    param.Field[string] `json:"match,required"`
	Variable param.Field[string] `json:"variable,required"`
}

func (ConfigUpdateParamsTriggersLoadRulesZarazVariableMatchRuleSettings) MarshalJSON

type ConfigUpdateParamsTriggersSystem

type ConfigUpdateParamsTriggersSystem string
const (
	ConfigUpdateParamsTriggersSystemPageload ConfigUpdateParamsTriggersSystem = "pageload"
)

func (ConfigUpdateParamsTriggersSystem) IsKnown

type ConfigUpdateParamsVariables

type ConfigUpdateParamsVariables struct {
	Name  param.Field[string]                          `json:"name,required"`
	Type  param.Field[ConfigUpdateParamsVariablesType] `json:"type,required"`
	Value param.Field[interface{}]                     `json:"value,required"`
}

func (ConfigUpdateParamsVariables) MarshalJSON

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

type ConfigUpdateParamsVariablesType

type ConfigUpdateParamsVariablesType string
const (
	ConfigUpdateParamsVariablesTypeString ConfigUpdateParamsVariablesType = "string"
	ConfigUpdateParamsVariablesTypeSecret ConfigUpdateParamsVariablesType = "secret"
	ConfigUpdateParamsVariablesTypeWorker ConfigUpdateParamsVariablesType = "worker"
)

func (ConfigUpdateParamsVariablesType) IsKnown

type ConfigUpdateParamsVariablesZarazSecretVariable

type ConfigUpdateParamsVariablesZarazSecretVariable struct {
	Name  param.Field[string]                                             `json:"name,required"`
	Type  param.Field[ConfigUpdateParamsVariablesZarazSecretVariableType] `json:"type,required"`
	Value param.Field[string]                                             `json:"value,required"`
}

func (ConfigUpdateParamsVariablesZarazSecretVariable) MarshalJSON

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

type ConfigUpdateParamsVariablesZarazSecretVariableType

type ConfigUpdateParamsVariablesZarazSecretVariableType string
const (
	ConfigUpdateParamsVariablesZarazSecretVariableTypeSecret ConfigUpdateParamsVariablesZarazSecretVariableType = "secret"
)

func (ConfigUpdateParamsVariablesZarazSecretVariableType) IsKnown

type ConfigUpdateParamsVariablesZarazStringVariable

type ConfigUpdateParamsVariablesZarazStringVariable struct {
	Name  param.Field[string]                                             `json:"name,required"`
	Type  param.Field[ConfigUpdateParamsVariablesZarazStringVariableType] `json:"type,required"`
	Value param.Field[string]                                             `json:"value,required"`
}

func (ConfigUpdateParamsVariablesZarazStringVariable) MarshalJSON

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

type ConfigUpdateParamsVariablesZarazStringVariableType

type ConfigUpdateParamsVariablesZarazStringVariableType string
const (
	ConfigUpdateParamsVariablesZarazStringVariableTypeString ConfigUpdateParamsVariablesZarazStringVariableType = "string"
)

func (ConfigUpdateParamsVariablesZarazStringVariableType) IsKnown

type ConfigUpdateParamsVariablesZarazWorkerVariable

type ConfigUpdateParamsVariablesZarazWorkerVariable struct {
	Name  param.Field[string]                                              `json:"name,required"`
	Type  param.Field[ConfigUpdateParamsVariablesZarazWorkerVariableType]  `json:"type,required"`
	Value param.Field[ConfigUpdateParamsVariablesZarazWorkerVariableValue] `json:"value,required"`
}

func (ConfigUpdateParamsVariablesZarazWorkerVariable) MarshalJSON

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

type ConfigUpdateParamsVariablesZarazWorkerVariableType

type ConfigUpdateParamsVariablesZarazWorkerVariableType string
const (
	ConfigUpdateParamsVariablesZarazWorkerVariableTypeWorker ConfigUpdateParamsVariablesZarazWorkerVariableType = "worker"
)

func (ConfigUpdateParamsVariablesZarazWorkerVariableType) IsKnown

type ConfigUpdateParamsVariablesZarazWorkerVariableValue

type ConfigUpdateParamsVariablesZarazWorkerVariableValue struct {
	EscapedWorkerName param.Field[string] `json:"escapedWorkerName,required"`
	WorkerTag         param.Field[string] `json:"workerTag,required"`
}

func (ConfigUpdateParamsVariablesZarazWorkerVariableValue) MarshalJSON

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

type ConfigUpdateResponseEnvelope

type ConfigUpdateResponseEnvelope struct {
	Errors   []ConfigUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ConfigUpdateResponseEnvelopeMessages `json:"messages,required"`
	// Zaraz configuration
	Result Configuration `json:"result,required"`
	// Whether the API call was successful
	Success bool                             `json:"success,required"`
	JSON    configUpdateResponseEnvelopeJSON `json:"-"`
}

func (*ConfigUpdateResponseEnvelope) UnmarshalJSON

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

type ConfigUpdateResponseEnvelopeErrors

type ConfigUpdateResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code,required"`
	Message          string                                   `json:"message,required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           ConfigUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             configUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ConfigUpdateResponseEnvelopeErrors) UnmarshalJSON

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

type ConfigUpdateResponseEnvelopeErrorsSource

type ConfigUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    configUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ConfigUpdateResponseEnvelopeErrorsSource) UnmarshalJSON

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

type ConfigUpdateResponseEnvelopeMessages

type ConfigUpdateResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code,required"`
	Message          string                                     `json:"message,required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           ConfigUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             configUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ConfigUpdateResponseEnvelopeMessages) UnmarshalJSON

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

type ConfigUpdateResponseEnvelopeMessagesSource

type ConfigUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    configUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ConfigUpdateResponseEnvelopeMessagesSource) UnmarshalJSON

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

type Configuration

type Configuration struct {
	// Data layer compatibility mode enabled.
	DataLayer bool `json:"dataLayer,required"`
	// The key for Zaraz debug mode.
	DebugKey string `json:"debugKey,required"`
	// General Zaraz settings.
	Settings ConfigurationSettings `json:"settings,required"`
	// Tools set up under Zaraz configuration, where key is the alpha-numeric tool ID
	// and value is the tool configuration object.
	Tools map[string]ConfigurationTool `json:"tools,required"`
	// Triggers set up under Zaraz configuration, where key is the trigger
	// alpha-numeric ID and value is the trigger configuration.
	Triggers map[string]ConfigurationTrigger `json:"triggers,required"`
	// Variables set up under Zaraz configuration, where key is the variable
	// alpha-numeric ID and value is the variable configuration. Values of variables of
	// type secret are not included.
	Variables map[string]ConfigurationVariable `json:"variables,required"`
	// Zaraz internal version of the config.
	ZarazVersion int64 `json:"zarazVersion,required"`
	// Cloudflare Monitoring settings.
	Analytics ConfigurationAnalytics `json:"analytics"`
	// Consent management configuration.
	Consent ConfigurationConsent `json:"consent"`
	// Single Page Application support enabled.
	HistoryChange bool              `json:"historyChange"`
	JSON          configurationJSON `json:"-"`
}

Zaraz configuration

func (*Configuration) UnmarshalJSON

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

type ConfigurationAnalytics

type ConfigurationAnalytics struct {
	// Consent purpose assigned to Monitoring.
	DefaultPurpose string `json:"defaultPurpose"`
	// Whether Advanced Monitoring reports are enabled.
	Enabled bool `json:"enabled"`
	// Session expiration time (seconds).
	SessionExpTime int64                      `json:"sessionExpTime"`
	JSON           configurationAnalyticsJSON `json:"-"`
}

Cloudflare Monitoring settings.

func (*ConfigurationAnalytics) UnmarshalJSON

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

type ConfigurationConsent

type ConfigurationConsent struct {
	Enabled                bool                  `json:"enabled,required"`
	ButtonTextTranslations ButtonTextTranslation `json:"buttonTextTranslations"`
	CompanyEmail           string                `json:"companyEmail"`
	CompanyName            string                `json:"companyName"`
	CompanyStreetAddress   string                `json:"companyStreetAddress"`
	ConsentModalIntroHTML  string                `json:"consentModalIntroHTML"`
	// Object where keys are language codes
	ConsentModalIntroHTMLWithTranslations map[string]string `json:"consentModalIntroHTMLWithTranslations"`
	CookieName                            string            `json:"cookieName"`
	CustomCSS                             string            `json:"customCSS"`
	CustomIntroDisclaimerDismissed        bool              `json:"customIntroDisclaimerDismissed"`
	DefaultLanguage                       string            `json:"defaultLanguage"`
	HideModal                             bool              `json:"hideModal"`
	// Object where keys are purpose alpha-numeric IDs
	Purposes map[string]ConfigurationConsentPurpose `json:"purposes"`
	// Object where keys are purpose alpha-numeric IDs
	PurposesWithTranslations map[string]ConfigurationConsentPurposesWithTranslation `json:"purposesWithTranslations"`
	TcfCompliant             bool                                                   `json:"tcfCompliant"`
	JSON                     configurationConsentJSON                               `json:"-"`
}

Consent management configuration.

func (*ConfigurationConsent) UnmarshalJSON

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

type ConfigurationConsentPurpose

type ConfigurationConsentPurpose struct {
	Description string                          `json:"description,required"`
	Name        string                          `json:"name,required"`
	JSON        configurationConsentPurposeJSON `json:"-"`
}

func (*ConfigurationConsentPurpose) UnmarshalJSON

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

type ConfigurationConsentPurposesWithTranslation

type ConfigurationConsentPurposesWithTranslation struct {
	// Object where keys are language codes
	Description map[string]string `json:"description,required"`
	// Object where keys are language codes
	Name  map[string]string                               `json:"name,required"`
	Order int64                                           `json:"order,required"`
	JSON  configurationConsentPurposesWithTranslationJSON `json:"-"`
}

func (*ConfigurationConsentPurposesWithTranslation) UnmarshalJSON

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

type ConfigurationSettings

type ConfigurationSettings struct {
	// Automatic injection of Zaraz scripts enabled.
	AutoInjectScript bool `json:"autoInjectScript,required"`
	// Details of the worker that receives and edits Zaraz Context object.
	ContextEnricher ConfigurationSettingsContextEnricher `json:"contextEnricher"`
	// The domain Zaraz will use for writing and reading its cookies.
	CookieDomain string `json:"cookieDomain"`
	// Ecommerce API enabled.
	Ecommerce bool `json:"ecommerce"`
	// Custom endpoint for server-side track events.
	EventsAPIPath string `json:"eventsApiPath"`
	// Hiding external referrer URL enabled.
	HideExternalReferer bool `json:"hideExternalReferer"`
	// Trimming IP address enabled.
	HideIPAddress bool `json:"hideIPAddress"`
	// Removing URL query params enabled.
	HideQueryParams bool `json:"hideQueryParams"`
	// Removing sensitive data from User Aagent string enabled.
	HideUserAgent bool `json:"hideUserAgent"`
	// Custom endpoint for Zaraz init script.
	InitPath string `json:"initPath"`
	// Injection of Zaraz scripts into iframes enabled.
	InjectIframes bool `json:"injectIframes"`
	// Custom path for Managed Components server functionalities.
	McRootPath string `json:"mcRootPath"`
	// Custom endpoint for Zaraz main script.
	ScriptPath string `json:"scriptPath"`
	// Custom endpoint for Zaraz tracking requests.
	TrackPath string                    `json:"trackPath"`
	JSON      configurationSettingsJSON `json:"-"`
}

General Zaraz settings.

func (*ConfigurationSettings) UnmarshalJSON

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

type ConfigurationSettingsContextEnricher

type ConfigurationSettingsContextEnricher struct {
	EscapedWorkerName string                                   `json:"escapedWorkerName,required"`
	WorkerTag         string                                   `json:"workerTag,required"`
	JSON              configurationSettingsContextEnricherJSON `json:"-"`
}

Details of the worker that receives and edits Zaraz Context object.

func (*ConfigurationSettingsContextEnricher) UnmarshalJSON

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

type ConfigurationTool

type ConfigurationTool struct {
	// This field can have the runtime type of [[]string].
	BlockingTriggers interface{} `json:"blockingTriggers,required"`
	// Tool's internal name
	Component string `json:"component,required"`
	// This field can have the runtime type of
	// [map[string]ConfigurationToolsZarazManagedComponentDefaultFieldsUnion],
	// [map[string]ConfigurationToolsWorkerDefaultFieldsUnion].
	DefaultFields interface{} `json:"defaultFields,required"`
	// Whether tool is enabled
	Enabled bool `json:"enabled,required"`
	// Tool's name defined by the user
	Name string `json:"name,required"`
	// This field can have the runtime type of [[]string].
	Permissions interface{} `json:"permissions,required"`
	// This field can have the runtime type of
	// [map[string]ConfigurationToolsZarazManagedComponentSettingsUnion],
	// [map[string]ConfigurationToolsWorkerSettingsUnion].
	Settings interface{}            `json:"settings,required"`
	Type     ConfigurationToolsType `json:"type,required"`
	// This field can have the runtime type of [map[string]NeoEvent].
	Actions interface{} `json:"actions"`
	// Default consent purpose ID
	DefaultPurpose string `json:"defaultPurpose"`
	// This field can have the runtime type of [[]NeoEvent].
	NeoEvents interface{} `json:"neoEvents"`
	// Vendor name for TCF compliant consent modal, required for Custom Managed
	// Components and Custom HTML tool with a defaultPurpose assigned
	VendorName string `json:"vendorName"`
	// Vendor's Privacy Policy URL for TCF compliant consent modal, required for Custom
	// Managed Components and Custom HTML tool with a defaultPurpose assigned
	VendorPolicyURL string `json:"vendorPolicyUrl"`
	// This field can have the runtime type of [ConfigurationToolsWorkerWorker].
	Worker interface{}           `json:"worker"`
	JSON   configurationToolJSON `json:"-"`
	// contains filtered or unexported fields
}

func (ConfigurationTool) AsUnion

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

Possible runtime types of the union are ConfigurationToolsZarazManagedComponent, ConfigurationToolsWorker.

func (*ConfigurationTool) UnmarshalJSON

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

type ConfigurationToolsType

type ConfigurationToolsType string
const (
	ConfigurationToolsTypeComponent ConfigurationToolsType = "component"
	ConfigurationToolsTypeCustomMc  ConfigurationToolsType = "custom-mc"
)

func (ConfigurationToolsType) IsKnown

func (r ConfigurationToolsType) IsKnown() bool

type ConfigurationToolsUnion

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

Union satisfied by ConfigurationToolsZarazManagedComponent or ConfigurationToolsWorker.

type ConfigurationToolsWorker

type ConfigurationToolsWorker struct {
	// List of blocking trigger IDs
	BlockingTriggers []string `json:"blockingTriggers,required"`
	// Tool's internal name
	Component string `json:"component,required"`
	// Default fields for tool's actions
	DefaultFields map[string]ConfigurationToolsWorkerDefaultFieldsUnion `json:"defaultFields,required"`
	// Whether tool is enabled
	Enabled bool `json:"enabled,required"`
	// Tool's name defined by the user
	Name string `json:"name,required"`
	// List of permissions granted to the component
	Permissions []string `json:"permissions,required"`
	// Tool's settings
	Settings map[string]ConfigurationToolsWorkerSettingsUnion `json:"settings,required"`
	Type     ConfigurationToolsWorkerType                     `json:"type,required"`
	// Cloudflare worker that acts as a managed component
	Worker ConfigurationToolsWorkerWorker `json:"worker,required"`
	// Actions configured on a tool. Either this or neoEvents field is required.
	Actions map[string]NeoEvent `json:"actions"`
	// Default consent purpose ID
	DefaultPurpose string `json:"defaultPurpose"`
	// DEPRECATED - List of actions configured on a tool. Either this or actions field
	// is required. If both are present, actions field will take precedence.
	NeoEvents []NeoEvent `json:"neoEvents"`
	// Vendor name for TCF compliant consent modal, required for Custom Managed
	// Components and Custom HTML tool with a defaultPurpose assigned
	VendorName string `json:"vendorName"`
	// Vendor's Privacy Policy URL for TCF compliant consent modal, required for Custom
	// Managed Components and Custom HTML tool with a defaultPurpose assigned
	VendorPolicyURL string                       `json:"vendorPolicyUrl"`
	JSON            configurationToolsWorkerJSON `json:"-"`
}

func (*ConfigurationToolsWorker) UnmarshalJSON

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

type ConfigurationToolsWorkerDefaultFieldsUnion

type ConfigurationToolsWorkerDefaultFieldsUnion interface {
	ImplementsConfigurationToolsWorkerDefaultFieldsUnion()
}

Union satisfied by shared.UnionString or shared.UnionBool.

type ConfigurationToolsWorkerSettingsUnion

type ConfigurationToolsWorkerSettingsUnion interface {
	ImplementsConfigurationToolsWorkerSettingsUnion()
}

Union satisfied by shared.UnionString or shared.UnionBool.

type ConfigurationToolsWorkerType

type ConfigurationToolsWorkerType string
const (
	ConfigurationToolsWorkerTypeCustomMc ConfigurationToolsWorkerType = "custom-mc"
)

func (ConfigurationToolsWorkerType) IsKnown

func (r ConfigurationToolsWorkerType) IsKnown() bool

type ConfigurationToolsWorkerWorker

type ConfigurationToolsWorkerWorker struct {
	EscapedWorkerName string                             `json:"escapedWorkerName,required"`
	WorkerTag         string                             `json:"workerTag,required"`
	JSON              configurationToolsWorkerWorkerJSON `json:"-"`
}

Cloudflare worker that acts as a managed component

func (*ConfigurationToolsWorkerWorker) UnmarshalJSON

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

type ConfigurationToolsZarazManagedComponent

type ConfigurationToolsZarazManagedComponent struct {
	// List of blocking trigger IDs
	BlockingTriggers []string `json:"blockingTriggers,required"`
	// Tool's internal name
	Component string `json:"component,required"`
	// Default fields for tool's actions
	DefaultFields map[string]ConfigurationToolsZarazManagedComponentDefaultFieldsUnion `json:"defaultFields,required"`
	// Whether tool is enabled
	Enabled bool `json:"enabled,required"`
	// Tool's name defined by the user
	Name string `json:"name,required"`
	// List of permissions granted to the component
	Permissions []string `json:"permissions,required"`
	// Tool's settings
	Settings map[string]ConfigurationToolsZarazManagedComponentSettingsUnion `json:"settings,required"`
	Type     ConfigurationToolsZarazManagedComponentType                     `json:"type,required"`
	// Actions configured on a tool. Either this or neoEvents field is required.
	Actions map[string]NeoEvent `json:"actions"`
	// Default consent purpose ID
	DefaultPurpose string `json:"defaultPurpose"`
	// DEPRECATED - List of actions configured on a tool. Either this or actions field
	// is required. If both are present, actions field will take precedence.
	NeoEvents []NeoEvent `json:"neoEvents"`
	// Vendor name for TCF compliant consent modal, required for Custom Managed
	// Components and Custom HTML tool with a defaultPurpose assigned
	VendorName string `json:"vendorName"`
	// Vendor's Privacy Policy URL for TCF compliant consent modal, required for Custom
	// Managed Components and Custom HTML tool with a defaultPurpose assigned
	VendorPolicyURL string                                      `json:"vendorPolicyUrl"`
	JSON            configurationToolsZarazManagedComponentJSON `json:"-"`
}

func (*ConfigurationToolsZarazManagedComponent) UnmarshalJSON

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

type ConfigurationToolsZarazManagedComponentDefaultFieldsUnion

type ConfigurationToolsZarazManagedComponentDefaultFieldsUnion interface {
	ImplementsConfigurationToolsZarazManagedComponentDefaultFieldsUnion()
}

Union satisfied by shared.UnionString or shared.UnionBool.

type ConfigurationToolsZarazManagedComponentSettingsUnion

type ConfigurationToolsZarazManagedComponentSettingsUnion interface {
	ImplementsConfigurationToolsZarazManagedComponentSettingsUnion()
}

Union satisfied by shared.UnionString or shared.UnionBool.

type ConfigurationToolsZarazManagedComponentType

type ConfigurationToolsZarazManagedComponentType string
const (
	ConfigurationToolsZarazManagedComponentTypeComponent ConfigurationToolsZarazManagedComponentType = "component"
)

func (ConfigurationToolsZarazManagedComponentType) IsKnown

type ConfigurationTrigger

type ConfigurationTrigger struct {
	// Rules defining when the trigger is not fired.
	ExcludeRules []ConfigurationTriggersExcludeRule `json:"excludeRules,required"`
	// Rules defining when the trigger is fired.
	LoadRules []ConfigurationTriggersLoadRule `json:"loadRules,required"`
	// Trigger name.
	Name string `json:"name,required"`
	// Trigger description.
	Description string                      `json:"description"`
	System      ConfigurationTriggersSystem `json:"system"`
	JSON        configurationTriggerJSON    `json:"-"`
}

func (*ConfigurationTrigger) UnmarshalJSON

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

type ConfigurationTriggersExcludeRule

type ConfigurationTriggersExcludeRule struct {
	ID     string                                  `json:"id,required"`
	Action ConfigurationTriggersExcludeRulesAction `json:"action"`
	Match  string                                  `json:"match"`
	Op     ConfigurationTriggersExcludeRulesOp     `json:"op"`
	// This field can have the runtime type of
	// [ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettings],
	// [ConfigurationTriggersExcludeRulesZarazTimerRuleSettings],
	// [ConfigurationTriggersExcludeRulesZarazFormSubmissionRuleSettings],
	// [ConfigurationTriggersExcludeRulesZarazVariableMatchRuleSettings],
	// [ConfigurationTriggersExcludeRulesZarazScrollDepthRuleSettings],
	// [ConfigurationTriggersExcludeRulesZarazElementVisibilityRuleSettings].
	Settings interface{}                          `json:"settings"`
	Value    string                               `json:"value"`
	JSON     configurationTriggersExcludeRuleJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*ConfigurationTriggersExcludeRule) UnmarshalJSON

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

type ConfigurationTriggersExcludeRulesAction

type ConfigurationTriggersExcludeRulesAction string
const (
	ConfigurationTriggersExcludeRulesActionClickListener     ConfigurationTriggersExcludeRulesAction = "clickListener"
	ConfigurationTriggersExcludeRulesActionTimer             ConfigurationTriggersExcludeRulesAction = "timer"
	ConfigurationTriggersExcludeRulesActionFormSubmission    ConfigurationTriggersExcludeRulesAction = "formSubmission"
	ConfigurationTriggersExcludeRulesActionVariableMatch     ConfigurationTriggersExcludeRulesAction = "variableMatch"
	ConfigurationTriggersExcludeRulesActionScrollDepth       ConfigurationTriggersExcludeRulesAction = "scrollDepth"
	ConfigurationTriggersExcludeRulesActionElementVisibility ConfigurationTriggersExcludeRulesAction = "elementVisibility"
)

func (ConfigurationTriggersExcludeRulesAction) IsKnown

type ConfigurationTriggersExcludeRulesOp

type ConfigurationTriggersExcludeRulesOp string
const (
	ConfigurationTriggersExcludeRulesOpContains           ConfigurationTriggersExcludeRulesOp = "CONTAINS"
	ConfigurationTriggersExcludeRulesOpEquals             ConfigurationTriggersExcludeRulesOp = "EQUALS"
	ConfigurationTriggersExcludeRulesOpStartsWith         ConfigurationTriggersExcludeRulesOp = "STARTS_WITH"
	ConfigurationTriggersExcludeRulesOpEndsWith           ConfigurationTriggersExcludeRulesOp = "ENDS_WITH"
	ConfigurationTriggersExcludeRulesOpMatchRegex         ConfigurationTriggersExcludeRulesOp = "MATCH_REGEX"
	ConfigurationTriggersExcludeRulesOpNotMatchRegex      ConfigurationTriggersExcludeRulesOp = "NOT_MATCH_REGEX"
	ConfigurationTriggersExcludeRulesOpGreaterThan        ConfigurationTriggersExcludeRulesOp = "GREATER_THAN"
	ConfigurationTriggersExcludeRulesOpGreaterThanOrEqual ConfigurationTriggersExcludeRulesOp = "GREATER_THAN_OR_EQUAL"
	ConfigurationTriggersExcludeRulesOpLessThan           ConfigurationTriggersExcludeRulesOp = "LESS_THAN"
	ConfigurationTriggersExcludeRulesOpLessThanOrEqual    ConfigurationTriggersExcludeRulesOp = "LESS_THAN_OR_EQUAL"
)

func (ConfigurationTriggersExcludeRulesOp) IsKnown

type ConfigurationTriggersExcludeRulesZarazClickListenerRule

type ConfigurationTriggersExcludeRulesZarazClickListenerRule struct {
	ID       string                                                          `json:"id,required"`
	Action   ConfigurationTriggersExcludeRulesZarazClickListenerRuleAction   `json:"action,required"`
	Settings ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettings `json:"settings,required"`
	JSON     configurationTriggersExcludeRulesZarazClickListenerRuleJSON     `json:"-"`
}

func (*ConfigurationTriggersExcludeRulesZarazClickListenerRule) UnmarshalJSON

type ConfigurationTriggersExcludeRulesZarazClickListenerRuleAction

type ConfigurationTriggersExcludeRulesZarazClickListenerRuleAction string
const (
	ConfigurationTriggersExcludeRulesZarazClickListenerRuleActionClickListener ConfigurationTriggersExcludeRulesZarazClickListenerRuleAction = "clickListener"
)

func (ConfigurationTriggersExcludeRulesZarazClickListenerRuleAction) IsKnown

type ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettings

type ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettings struct {
	Selector    string                                                              `json:"selector,required"`
	Type        ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsType `json:"type,required"`
	WaitForTags int64                                                               `json:"waitForTags,required"`
	JSON        configurationTriggersExcludeRulesZarazClickListenerRuleSettingsJSON `json:"-"`
}

func (*ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettings) UnmarshalJSON

type ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsType

type ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsType string
const (
	ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsTypeXpath ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsType = "xpath"
	ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsTypeCSS   ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsType = "css"
)

func (ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsType) IsKnown

type ConfigurationTriggersExcludeRulesZarazElementVisibilityRule

type ConfigurationTriggersExcludeRulesZarazElementVisibilityRule struct {
	ID       string                                                              `json:"id,required"`
	Action   ConfigurationTriggersExcludeRulesZarazElementVisibilityRuleAction   `json:"action,required"`
	Settings ConfigurationTriggersExcludeRulesZarazElementVisibilityRuleSettings `json:"settings,required"`
	JSON     configurationTriggersExcludeRulesZarazElementVisibilityRuleJSON     `json:"-"`
}

func (*ConfigurationTriggersExcludeRulesZarazElementVisibilityRule) UnmarshalJSON

type ConfigurationTriggersExcludeRulesZarazElementVisibilityRuleAction

type ConfigurationTriggersExcludeRulesZarazElementVisibilityRuleAction string
const (
	ConfigurationTriggersExcludeRulesZarazElementVisibilityRuleActionElementVisibility ConfigurationTriggersExcludeRulesZarazElementVisibilityRuleAction = "elementVisibility"
)

func (ConfigurationTriggersExcludeRulesZarazElementVisibilityRuleAction) IsKnown

type ConfigurationTriggersExcludeRulesZarazElementVisibilityRuleSettings

type ConfigurationTriggersExcludeRulesZarazElementVisibilityRuleSettings struct {
	Selector string                                                                  `json:"selector,required"`
	JSON     configurationTriggersExcludeRulesZarazElementVisibilityRuleSettingsJSON `json:"-"`
}

func (*ConfigurationTriggersExcludeRulesZarazElementVisibilityRuleSettings) UnmarshalJSON

type ConfigurationTriggersExcludeRulesZarazFormSubmissionRule

type ConfigurationTriggersExcludeRulesZarazFormSubmissionRule struct {
	ID       string                                                           `json:"id,required"`
	Action   ConfigurationTriggersExcludeRulesZarazFormSubmissionRuleAction   `json:"action,required"`
	Settings ConfigurationTriggersExcludeRulesZarazFormSubmissionRuleSettings `json:"settings,required"`
	JSON     configurationTriggersExcludeRulesZarazFormSubmissionRuleJSON     `json:"-"`
}

func (*ConfigurationTriggersExcludeRulesZarazFormSubmissionRule) UnmarshalJSON

type ConfigurationTriggersExcludeRulesZarazFormSubmissionRuleAction

type ConfigurationTriggersExcludeRulesZarazFormSubmissionRuleAction string
const (
	ConfigurationTriggersExcludeRulesZarazFormSubmissionRuleActionFormSubmission ConfigurationTriggersExcludeRulesZarazFormSubmissionRuleAction = "formSubmission"
)

func (ConfigurationTriggersExcludeRulesZarazFormSubmissionRuleAction) IsKnown

type ConfigurationTriggersExcludeRulesZarazFormSubmissionRuleSettings

type ConfigurationTriggersExcludeRulesZarazFormSubmissionRuleSettings struct {
	Selector string                                                               `json:"selector,required"`
	Validate bool                                                                 `json:"validate,required"`
	JSON     configurationTriggersExcludeRulesZarazFormSubmissionRuleSettingsJSON `json:"-"`
}

func (*ConfigurationTriggersExcludeRulesZarazFormSubmissionRuleSettings) UnmarshalJSON

type ConfigurationTriggersExcludeRulesZarazLoadRule

type ConfigurationTriggersExcludeRulesZarazLoadRule struct {
	ID    string                                             `json:"id,required"`
	Match string                                             `json:"match,required"`
	Op    ConfigurationTriggersExcludeRulesZarazLoadRuleOp   `json:"op,required"`
	Value string                                             `json:"value,required"`
	JSON  configurationTriggersExcludeRulesZarazLoadRuleJSON `json:"-"`
}

func (*ConfigurationTriggersExcludeRulesZarazLoadRule) UnmarshalJSON

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

type ConfigurationTriggersExcludeRulesZarazLoadRuleOp

type ConfigurationTriggersExcludeRulesZarazLoadRuleOp string
const (
	ConfigurationTriggersExcludeRulesZarazLoadRuleOpContains           ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "CONTAINS"
	ConfigurationTriggersExcludeRulesZarazLoadRuleOpEquals             ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "EQUALS"
	ConfigurationTriggersExcludeRulesZarazLoadRuleOpStartsWith         ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "STARTS_WITH"
	ConfigurationTriggersExcludeRulesZarazLoadRuleOpEndsWith           ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "ENDS_WITH"
	ConfigurationTriggersExcludeRulesZarazLoadRuleOpMatchRegex         ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "MATCH_REGEX"
	ConfigurationTriggersExcludeRulesZarazLoadRuleOpNotMatchRegex      ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "NOT_MATCH_REGEX"
	ConfigurationTriggersExcludeRulesZarazLoadRuleOpGreaterThan        ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "GREATER_THAN"
	ConfigurationTriggersExcludeRulesZarazLoadRuleOpGreaterThanOrEqual ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "GREATER_THAN_OR_EQUAL"
	ConfigurationTriggersExcludeRulesZarazLoadRuleOpLessThan           ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "LESS_THAN"
	ConfigurationTriggersExcludeRulesZarazLoadRuleOpLessThanOrEqual    ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "LESS_THAN_OR_EQUAL"
)

func (ConfigurationTriggersExcludeRulesZarazLoadRuleOp) IsKnown

type ConfigurationTriggersExcludeRulesZarazScrollDepthRule

type ConfigurationTriggersExcludeRulesZarazScrollDepthRule struct {
	ID       string                                                        `json:"id,required"`
	Action   ConfigurationTriggersExcludeRulesZarazScrollDepthRuleAction   `json:"action,required"`
	Settings ConfigurationTriggersExcludeRulesZarazScrollDepthRuleSettings `json:"settings,required"`
	JSON     configurationTriggersExcludeRulesZarazScrollDepthRuleJSON     `json:"-"`
}

func (*ConfigurationTriggersExcludeRulesZarazScrollDepthRule) UnmarshalJSON

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

type ConfigurationTriggersExcludeRulesZarazScrollDepthRuleAction

type ConfigurationTriggersExcludeRulesZarazScrollDepthRuleAction string
const (
	ConfigurationTriggersExcludeRulesZarazScrollDepthRuleActionScrollDepth ConfigurationTriggersExcludeRulesZarazScrollDepthRuleAction = "scrollDepth"
)

func (ConfigurationTriggersExcludeRulesZarazScrollDepthRuleAction) IsKnown

type ConfigurationTriggersExcludeRulesZarazScrollDepthRuleSettings

type ConfigurationTriggersExcludeRulesZarazScrollDepthRuleSettings struct {
	Positions string                                                            `json:"positions,required"`
	JSON      configurationTriggersExcludeRulesZarazScrollDepthRuleSettingsJSON `json:"-"`
}

func (*ConfigurationTriggersExcludeRulesZarazScrollDepthRuleSettings) UnmarshalJSON

type ConfigurationTriggersExcludeRulesZarazTimerRule

type ConfigurationTriggersExcludeRulesZarazTimerRule struct {
	ID       string                                                  `json:"id,required"`
	Action   ConfigurationTriggersExcludeRulesZarazTimerRuleAction   `json:"action,required"`
	Settings ConfigurationTriggersExcludeRulesZarazTimerRuleSettings `json:"settings,required"`
	JSON     configurationTriggersExcludeRulesZarazTimerRuleJSON     `json:"-"`
}

func (*ConfigurationTriggersExcludeRulesZarazTimerRule) UnmarshalJSON

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

type ConfigurationTriggersExcludeRulesZarazTimerRuleAction

type ConfigurationTriggersExcludeRulesZarazTimerRuleAction string
const (
	ConfigurationTriggersExcludeRulesZarazTimerRuleActionTimer ConfigurationTriggersExcludeRulesZarazTimerRuleAction = "timer"
)

func (ConfigurationTriggersExcludeRulesZarazTimerRuleAction) IsKnown

type ConfigurationTriggersExcludeRulesZarazTimerRuleSettings

type ConfigurationTriggersExcludeRulesZarazTimerRuleSettings struct {
	Interval int64                                                       `json:"interval,required"`
	Limit    int64                                                       `json:"limit,required"`
	JSON     configurationTriggersExcludeRulesZarazTimerRuleSettingsJSON `json:"-"`
}

func (*ConfigurationTriggersExcludeRulesZarazTimerRuleSettings) UnmarshalJSON

type ConfigurationTriggersExcludeRulesZarazVariableMatchRule

type ConfigurationTriggersExcludeRulesZarazVariableMatchRule struct {
	ID       string                                                          `json:"id,required"`
	Action   ConfigurationTriggersExcludeRulesZarazVariableMatchRuleAction   `json:"action,required"`
	Settings ConfigurationTriggersExcludeRulesZarazVariableMatchRuleSettings `json:"settings,required"`
	JSON     configurationTriggersExcludeRulesZarazVariableMatchRuleJSON     `json:"-"`
}

func (*ConfigurationTriggersExcludeRulesZarazVariableMatchRule) UnmarshalJSON

type ConfigurationTriggersExcludeRulesZarazVariableMatchRuleAction

type ConfigurationTriggersExcludeRulesZarazVariableMatchRuleAction string
const (
	ConfigurationTriggersExcludeRulesZarazVariableMatchRuleActionVariableMatch ConfigurationTriggersExcludeRulesZarazVariableMatchRuleAction = "variableMatch"
)

func (ConfigurationTriggersExcludeRulesZarazVariableMatchRuleAction) IsKnown

type ConfigurationTriggersExcludeRulesZarazVariableMatchRuleSettings

type ConfigurationTriggersExcludeRulesZarazVariableMatchRuleSettings struct {
	Match    string                                                              `json:"match,required"`
	Variable string                                                              `json:"variable,required"`
	JSON     configurationTriggersExcludeRulesZarazVariableMatchRuleSettingsJSON `json:"-"`
}

func (*ConfigurationTriggersExcludeRulesZarazVariableMatchRuleSettings) UnmarshalJSON

type ConfigurationTriggersLoadRule

type ConfigurationTriggersLoadRule struct {
	ID     string                               `json:"id,required"`
	Action ConfigurationTriggersLoadRulesAction `json:"action"`
	Match  string                               `json:"match"`
	Op     ConfigurationTriggersLoadRulesOp     `json:"op"`
	// This field can have the runtime type of
	// [ConfigurationTriggersLoadRulesZarazClickListenerRuleSettings],
	// [ConfigurationTriggersLoadRulesZarazTimerRuleSettings],
	// [ConfigurationTriggersLoadRulesZarazFormSubmissionRuleSettings],
	// [ConfigurationTriggersLoadRulesZarazVariableMatchRuleSettings],
	// [ConfigurationTriggersLoadRulesZarazScrollDepthRuleSettings],
	// [ConfigurationTriggersLoadRulesZarazElementVisibilityRuleSettings].
	Settings interface{}                       `json:"settings"`
	Value    string                            `json:"value"`
	JSON     configurationTriggersLoadRuleJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*ConfigurationTriggersLoadRule) UnmarshalJSON

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

type ConfigurationTriggersLoadRulesAction

type ConfigurationTriggersLoadRulesAction string
const (
	ConfigurationTriggersLoadRulesActionClickListener     ConfigurationTriggersLoadRulesAction = "clickListener"
	ConfigurationTriggersLoadRulesActionTimer             ConfigurationTriggersLoadRulesAction = "timer"
	ConfigurationTriggersLoadRulesActionFormSubmission    ConfigurationTriggersLoadRulesAction = "formSubmission"
	ConfigurationTriggersLoadRulesActionVariableMatch     ConfigurationTriggersLoadRulesAction = "variableMatch"
	ConfigurationTriggersLoadRulesActionScrollDepth       ConfigurationTriggersLoadRulesAction = "scrollDepth"
	ConfigurationTriggersLoadRulesActionElementVisibility ConfigurationTriggersLoadRulesAction = "elementVisibility"
)

func (ConfigurationTriggersLoadRulesAction) IsKnown

type ConfigurationTriggersLoadRulesOp

type ConfigurationTriggersLoadRulesOp string
const (
	ConfigurationTriggersLoadRulesOpContains           ConfigurationTriggersLoadRulesOp = "CONTAINS"
	ConfigurationTriggersLoadRulesOpEquals             ConfigurationTriggersLoadRulesOp = "EQUALS"
	ConfigurationTriggersLoadRulesOpStartsWith         ConfigurationTriggersLoadRulesOp = "STARTS_WITH"
	ConfigurationTriggersLoadRulesOpEndsWith           ConfigurationTriggersLoadRulesOp = "ENDS_WITH"
	ConfigurationTriggersLoadRulesOpMatchRegex         ConfigurationTriggersLoadRulesOp = "MATCH_REGEX"
	ConfigurationTriggersLoadRulesOpNotMatchRegex      ConfigurationTriggersLoadRulesOp = "NOT_MATCH_REGEX"
	ConfigurationTriggersLoadRulesOpGreaterThan        ConfigurationTriggersLoadRulesOp = "GREATER_THAN"
	ConfigurationTriggersLoadRulesOpGreaterThanOrEqual ConfigurationTriggersLoadRulesOp = "GREATER_THAN_OR_EQUAL"
	ConfigurationTriggersLoadRulesOpLessThan           ConfigurationTriggersLoadRulesOp = "LESS_THAN"
	ConfigurationTriggersLoadRulesOpLessThanOrEqual    ConfigurationTriggersLoadRulesOp = "LESS_THAN_OR_EQUAL"
)

func (ConfigurationTriggersLoadRulesOp) IsKnown

type ConfigurationTriggersLoadRulesZarazClickListenerRule

type ConfigurationTriggersLoadRulesZarazClickListenerRule struct {
	ID       string                                                       `json:"id,required"`
	Action   ConfigurationTriggersLoadRulesZarazClickListenerRuleAction   `json:"action,required"`
	Settings ConfigurationTriggersLoadRulesZarazClickListenerRuleSettings `json:"settings,required"`
	JSON     configurationTriggersLoadRulesZarazClickListenerRuleJSON     `json:"-"`
}

func (*ConfigurationTriggersLoadRulesZarazClickListenerRule) UnmarshalJSON

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

type ConfigurationTriggersLoadRulesZarazClickListenerRuleAction

type ConfigurationTriggersLoadRulesZarazClickListenerRuleAction string
const (
	ConfigurationTriggersLoadRulesZarazClickListenerRuleActionClickListener ConfigurationTriggersLoadRulesZarazClickListenerRuleAction = "clickListener"
)

func (ConfigurationTriggersLoadRulesZarazClickListenerRuleAction) IsKnown

type ConfigurationTriggersLoadRulesZarazClickListenerRuleSettings

type ConfigurationTriggersLoadRulesZarazClickListenerRuleSettings struct {
	Selector    string                                                           `json:"selector,required"`
	Type        ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsType `json:"type,required"`
	WaitForTags int64                                                            `json:"waitForTags,required"`
	JSON        configurationTriggersLoadRulesZarazClickListenerRuleSettingsJSON `json:"-"`
}

func (*ConfigurationTriggersLoadRulesZarazClickListenerRuleSettings) UnmarshalJSON

type ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsType

type ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsType string
const (
	ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsTypeXpath ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsType = "xpath"
	ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsTypeCSS   ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsType = "css"
)

func (ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsType) IsKnown

type ConfigurationTriggersLoadRulesZarazElementVisibilityRule

type ConfigurationTriggersLoadRulesZarazElementVisibilityRule struct {
	ID       string                                                           `json:"id,required"`
	Action   ConfigurationTriggersLoadRulesZarazElementVisibilityRuleAction   `json:"action,required"`
	Settings ConfigurationTriggersLoadRulesZarazElementVisibilityRuleSettings `json:"settings,required"`
	JSON     configurationTriggersLoadRulesZarazElementVisibilityRuleJSON     `json:"-"`
}

func (*ConfigurationTriggersLoadRulesZarazElementVisibilityRule) UnmarshalJSON

type ConfigurationTriggersLoadRulesZarazElementVisibilityRuleAction

type ConfigurationTriggersLoadRulesZarazElementVisibilityRuleAction string
const (
	ConfigurationTriggersLoadRulesZarazElementVisibilityRuleActionElementVisibility ConfigurationTriggersLoadRulesZarazElementVisibilityRuleAction = "elementVisibility"
)

func (ConfigurationTriggersLoadRulesZarazElementVisibilityRuleAction) IsKnown

type ConfigurationTriggersLoadRulesZarazElementVisibilityRuleSettings

type ConfigurationTriggersLoadRulesZarazElementVisibilityRuleSettings struct {
	Selector string                                                               `json:"selector,required"`
	JSON     configurationTriggersLoadRulesZarazElementVisibilityRuleSettingsJSON `json:"-"`
}

func (*ConfigurationTriggersLoadRulesZarazElementVisibilityRuleSettings) UnmarshalJSON

type ConfigurationTriggersLoadRulesZarazFormSubmissionRule

type ConfigurationTriggersLoadRulesZarazFormSubmissionRule struct {
	ID       string                                                        `json:"id,required"`
	Action   ConfigurationTriggersLoadRulesZarazFormSubmissionRuleAction   `json:"action,required"`
	Settings ConfigurationTriggersLoadRulesZarazFormSubmissionRuleSettings `json:"settings,required"`
	JSON     configurationTriggersLoadRulesZarazFormSubmissionRuleJSON     `json:"-"`
}

func (*ConfigurationTriggersLoadRulesZarazFormSubmissionRule) UnmarshalJSON

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

type ConfigurationTriggersLoadRulesZarazFormSubmissionRuleAction

type ConfigurationTriggersLoadRulesZarazFormSubmissionRuleAction string
const (
	ConfigurationTriggersLoadRulesZarazFormSubmissionRuleActionFormSubmission ConfigurationTriggersLoadRulesZarazFormSubmissionRuleAction = "formSubmission"
)

func (ConfigurationTriggersLoadRulesZarazFormSubmissionRuleAction) IsKnown

type ConfigurationTriggersLoadRulesZarazFormSubmissionRuleSettings

type ConfigurationTriggersLoadRulesZarazFormSubmissionRuleSettings struct {
	Selector string                                                            `json:"selector,required"`
	Validate bool                                                              `json:"validate,required"`
	JSON     configurationTriggersLoadRulesZarazFormSubmissionRuleSettingsJSON `json:"-"`
}

func (*ConfigurationTriggersLoadRulesZarazFormSubmissionRuleSettings) UnmarshalJSON

type ConfigurationTriggersLoadRulesZarazLoadRule

type ConfigurationTriggersLoadRulesZarazLoadRule struct {
	ID    string                                          `json:"id,required"`
	Match string                                          `json:"match,required"`
	Op    ConfigurationTriggersLoadRulesZarazLoadRuleOp   `json:"op,required"`
	Value string                                          `json:"value,required"`
	JSON  configurationTriggersLoadRulesZarazLoadRuleJSON `json:"-"`
}

func (*ConfigurationTriggersLoadRulesZarazLoadRule) UnmarshalJSON

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

type ConfigurationTriggersLoadRulesZarazLoadRuleOp

type ConfigurationTriggersLoadRulesZarazLoadRuleOp string
const (
	ConfigurationTriggersLoadRulesZarazLoadRuleOpContains           ConfigurationTriggersLoadRulesZarazLoadRuleOp = "CONTAINS"
	ConfigurationTriggersLoadRulesZarazLoadRuleOpEquals             ConfigurationTriggersLoadRulesZarazLoadRuleOp = "EQUALS"
	ConfigurationTriggersLoadRulesZarazLoadRuleOpStartsWith         ConfigurationTriggersLoadRulesZarazLoadRuleOp = "STARTS_WITH"
	ConfigurationTriggersLoadRulesZarazLoadRuleOpEndsWith           ConfigurationTriggersLoadRulesZarazLoadRuleOp = "ENDS_WITH"
	ConfigurationTriggersLoadRulesZarazLoadRuleOpMatchRegex         ConfigurationTriggersLoadRulesZarazLoadRuleOp = "MATCH_REGEX"
	ConfigurationTriggersLoadRulesZarazLoadRuleOpNotMatchRegex      ConfigurationTriggersLoadRulesZarazLoadRuleOp = "NOT_MATCH_REGEX"
	ConfigurationTriggersLoadRulesZarazLoadRuleOpGreaterThan        ConfigurationTriggersLoadRulesZarazLoadRuleOp = "GREATER_THAN"
	ConfigurationTriggersLoadRulesZarazLoadRuleOpGreaterThanOrEqual ConfigurationTriggersLoadRulesZarazLoadRuleOp = "GREATER_THAN_OR_EQUAL"
	ConfigurationTriggersLoadRulesZarazLoadRuleOpLessThan           ConfigurationTriggersLoadRulesZarazLoadRuleOp = "LESS_THAN"
	ConfigurationTriggersLoadRulesZarazLoadRuleOpLessThanOrEqual    ConfigurationTriggersLoadRulesZarazLoadRuleOp = "LESS_THAN_OR_EQUAL"
)

func (ConfigurationTriggersLoadRulesZarazLoadRuleOp) IsKnown

type ConfigurationTriggersLoadRulesZarazScrollDepthRule

type ConfigurationTriggersLoadRulesZarazScrollDepthRule struct {
	ID       string                                                     `json:"id,required"`
	Action   ConfigurationTriggersLoadRulesZarazScrollDepthRuleAction   `json:"action,required"`
	Settings ConfigurationTriggersLoadRulesZarazScrollDepthRuleSettings `json:"settings,required"`
	JSON     configurationTriggersLoadRulesZarazScrollDepthRuleJSON     `json:"-"`
}

func (*ConfigurationTriggersLoadRulesZarazScrollDepthRule) UnmarshalJSON

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

type ConfigurationTriggersLoadRulesZarazScrollDepthRuleAction

type ConfigurationTriggersLoadRulesZarazScrollDepthRuleAction string
const (
	ConfigurationTriggersLoadRulesZarazScrollDepthRuleActionScrollDepth ConfigurationTriggersLoadRulesZarazScrollDepthRuleAction = "scrollDepth"
)

func (ConfigurationTriggersLoadRulesZarazScrollDepthRuleAction) IsKnown

type ConfigurationTriggersLoadRulesZarazScrollDepthRuleSettings

type ConfigurationTriggersLoadRulesZarazScrollDepthRuleSettings struct {
	Positions string                                                         `json:"positions,required"`
	JSON      configurationTriggersLoadRulesZarazScrollDepthRuleSettingsJSON `json:"-"`
}

func (*ConfigurationTriggersLoadRulesZarazScrollDepthRuleSettings) UnmarshalJSON

type ConfigurationTriggersLoadRulesZarazTimerRule

type ConfigurationTriggersLoadRulesZarazTimerRule struct {
	ID       string                                               `json:"id,required"`
	Action   ConfigurationTriggersLoadRulesZarazTimerRuleAction   `json:"action,required"`
	Settings ConfigurationTriggersLoadRulesZarazTimerRuleSettings `json:"settings,required"`
	JSON     configurationTriggersLoadRulesZarazTimerRuleJSON     `json:"-"`
}

func (*ConfigurationTriggersLoadRulesZarazTimerRule) UnmarshalJSON

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

type ConfigurationTriggersLoadRulesZarazTimerRuleAction

type ConfigurationTriggersLoadRulesZarazTimerRuleAction string
const (
	ConfigurationTriggersLoadRulesZarazTimerRuleActionTimer ConfigurationTriggersLoadRulesZarazTimerRuleAction = "timer"
)

func (ConfigurationTriggersLoadRulesZarazTimerRuleAction) IsKnown

type ConfigurationTriggersLoadRulesZarazTimerRuleSettings

type ConfigurationTriggersLoadRulesZarazTimerRuleSettings struct {
	Interval int64                                                    `json:"interval,required"`
	Limit    int64                                                    `json:"limit,required"`
	JSON     configurationTriggersLoadRulesZarazTimerRuleSettingsJSON `json:"-"`
}

func (*ConfigurationTriggersLoadRulesZarazTimerRuleSettings) UnmarshalJSON

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

type ConfigurationTriggersLoadRulesZarazVariableMatchRule

type ConfigurationTriggersLoadRulesZarazVariableMatchRule struct {
	ID       string                                                       `json:"id,required"`
	Action   ConfigurationTriggersLoadRulesZarazVariableMatchRuleAction   `json:"action,required"`
	Settings ConfigurationTriggersLoadRulesZarazVariableMatchRuleSettings `json:"settings,required"`
	JSON     configurationTriggersLoadRulesZarazVariableMatchRuleJSON     `json:"-"`
}

func (*ConfigurationTriggersLoadRulesZarazVariableMatchRule) UnmarshalJSON

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

type ConfigurationTriggersLoadRulesZarazVariableMatchRuleAction

type ConfigurationTriggersLoadRulesZarazVariableMatchRuleAction string
const (
	ConfigurationTriggersLoadRulesZarazVariableMatchRuleActionVariableMatch ConfigurationTriggersLoadRulesZarazVariableMatchRuleAction = "variableMatch"
)

func (ConfigurationTriggersLoadRulesZarazVariableMatchRuleAction) IsKnown

type ConfigurationTriggersLoadRulesZarazVariableMatchRuleSettings

type ConfigurationTriggersLoadRulesZarazVariableMatchRuleSettings struct {
	Match    string                                                           `json:"match,required"`
	Variable string                                                           `json:"variable,required"`
	JSON     configurationTriggersLoadRulesZarazVariableMatchRuleSettingsJSON `json:"-"`
}

func (*ConfigurationTriggersLoadRulesZarazVariableMatchRuleSettings) UnmarshalJSON

type ConfigurationTriggersSystem

type ConfigurationTriggersSystem string
const (
	ConfigurationTriggersSystemPageload ConfigurationTriggersSystem = "pageload"
)

func (ConfigurationTriggersSystem) IsKnown

func (r ConfigurationTriggersSystem) IsKnown() bool

type ConfigurationVariable

type ConfigurationVariable struct {
	Name string                     `json:"name,required"`
	Type ConfigurationVariablesType `json:"type,required"`
	// This field can have the runtime type of [string],
	// [ConfigurationVariablesZarazWorkerVariableValue].
	Value interface{}               `json:"value,required"`
	JSON  configurationVariableJSON `json:"-"`
	// contains filtered or unexported fields
}

func (ConfigurationVariable) AsUnion

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

Possible runtime types of the union are ConfigurationVariablesZarazStringVariable, ConfigurationVariablesZarazSecretVariable, ConfigurationVariablesZarazWorkerVariable.

func (*ConfigurationVariable) UnmarshalJSON

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

type ConfigurationVariablesType

type ConfigurationVariablesType string
const (
	ConfigurationVariablesTypeString ConfigurationVariablesType = "string"
	ConfigurationVariablesTypeSecret ConfigurationVariablesType = "secret"
	ConfigurationVariablesTypeWorker ConfigurationVariablesType = "worker"
)

func (ConfigurationVariablesType) IsKnown

func (r ConfigurationVariablesType) IsKnown() bool

type ConfigurationVariablesUnion

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

Union satisfied by ConfigurationVariablesZarazStringVariable, ConfigurationVariablesZarazSecretVariable or ConfigurationVariablesZarazWorkerVariable.

type ConfigurationVariablesZarazSecretVariable

type ConfigurationVariablesZarazSecretVariable struct {
	Name  string                                        `json:"name,required"`
	Type  ConfigurationVariablesZarazSecretVariableType `json:"type,required"`
	Value string                                        `json:"value,required"`
	JSON  configurationVariablesZarazSecretVariableJSON `json:"-"`
}

func (*ConfigurationVariablesZarazSecretVariable) UnmarshalJSON

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

type ConfigurationVariablesZarazSecretVariableType

type ConfigurationVariablesZarazSecretVariableType string
const (
	ConfigurationVariablesZarazSecretVariableTypeSecret ConfigurationVariablesZarazSecretVariableType = "secret"
)

func (ConfigurationVariablesZarazSecretVariableType) IsKnown

type ConfigurationVariablesZarazStringVariable

type ConfigurationVariablesZarazStringVariable struct {
	Name  string                                        `json:"name,required"`
	Type  ConfigurationVariablesZarazStringVariableType `json:"type,required"`
	Value string                                        `json:"value,required"`
	JSON  configurationVariablesZarazStringVariableJSON `json:"-"`
}

func (*ConfigurationVariablesZarazStringVariable) UnmarshalJSON

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

type ConfigurationVariablesZarazStringVariableType

type ConfigurationVariablesZarazStringVariableType string
const (
	ConfigurationVariablesZarazStringVariableTypeString ConfigurationVariablesZarazStringVariableType = "string"
)

func (ConfigurationVariablesZarazStringVariableType) IsKnown

type ConfigurationVariablesZarazWorkerVariable

type ConfigurationVariablesZarazWorkerVariable struct {
	Name  string                                         `json:"name,required"`
	Type  ConfigurationVariablesZarazWorkerVariableType  `json:"type,required"`
	Value ConfigurationVariablesZarazWorkerVariableValue `json:"value,required"`
	JSON  configurationVariablesZarazWorkerVariableJSON  `json:"-"`
}

func (*ConfigurationVariablesZarazWorkerVariable) UnmarshalJSON

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

type ConfigurationVariablesZarazWorkerVariableType

type ConfigurationVariablesZarazWorkerVariableType string
const (
	ConfigurationVariablesZarazWorkerVariableTypeWorker ConfigurationVariablesZarazWorkerVariableType = "worker"
)

func (ConfigurationVariablesZarazWorkerVariableType) IsKnown

type ConfigurationVariablesZarazWorkerVariableValue

type ConfigurationVariablesZarazWorkerVariableValue struct {
	EscapedWorkerName string                                             `json:"escapedWorkerName,required"`
	WorkerTag         string                                             `json:"workerTag,required"`
	JSON              configurationVariablesZarazWorkerVariableValueJSON `json:"-"`
}

func (*ConfigurationVariablesZarazWorkerVariableValue) UnmarshalJSON

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

type DefaultGetParams

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

type DefaultGetResponseEnvelope

type DefaultGetResponseEnvelope struct {
	Errors   []DefaultGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DefaultGetResponseEnvelopeMessages `json:"messages,required"`
	// Zaraz configuration
	Result Configuration `json:"result,required"`
	// Whether the API call was successful
	Success bool                           `json:"success,required"`
	JSON    defaultGetResponseEnvelopeJSON `json:"-"`
}

func (*DefaultGetResponseEnvelope) UnmarshalJSON

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

type DefaultGetResponseEnvelopeErrors

type DefaultGetResponseEnvelopeErrors struct {
	Code             int64                                  `json:"code,required"`
	Message          string                                 `json:"message,required"`
	DocumentationURL string                                 `json:"documentation_url"`
	Source           DefaultGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             defaultGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*DefaultGetResponseEnvelopeErrors) UnmarshalJSON

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

type DefaultGetResponseEnvelopeErrorsSource

type DefaultGetResponseEnvelopeErrorsSource struct {
	Pointer string                                     `json:"pointer"`
	JSON    defaultGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*DefaultGetResponseEnvelopeErrorsSource) UnmarshalJSON

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

type DefaultGetResponseEnvelopeMessages

type DefaultGetResponseEnvelopeMessages struct {
	Code             int64                                    `json:"code,required"`
	Message          string                                   `json:"message,required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           DefaultGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             defaultGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*DefaultGetResponseEnvelopeMessages) UnmarshalJSON

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

type DefaultGetResponseEnvelopeMessagesSource

type DefaultGetResponseEnvelopeMessagesSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    defaultGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*DefaultGetResponseEnvelopeMessagesSource) UnmarshalJSON

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

type DefaultService

type DefaultService struct {
	Options []option.RequestOption
}

DefaultService 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 NewDefaultService method instead.

func NewDefaultService

func NewDefaultService(opts ...option.RequestOption) (r *DefaultService)

NewDefaultService 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 (*DefaultService) Get

func (r *DefaultService) Get(ctx context.Context, query DefaultGetParams, opts ...option.RequestOption) (res *Configuration, err error)

Gets default Zaraz configuration for a zone.

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 ExportGetParams

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

type ExportService

type ExportService struct {
	Options []option.RequestOption
}

ExportService 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 NewExportService method instead.

func NewExportService

func NewExportService(opts ...option.RequestOption) (r *ExportService)

NewExportService 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 (*ExportService) Get

func (r *ExportService) Get(ctx context.Context, query ExportGetParams, opts ...option.RequestOption) (res *Configuration, err error)

Exports full current published Zaraz configuration for a zone, secret variables included.

type HistoryConfigGetParams

type HistoryConfigGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Comma separated list of Zaraz configuration IDs
	IDs param.Field[[]int64] `query:"ids,required"`
}

func (HistoryConfigGetParams) URLQuery

func (r HistoryConfigGetParams) URLQuery() (v url.Values)

URLQuery serializes HistoryConfigGetParams's query parameters as `url.Values`.

type HistoryConfigGetResponse

type HistoryConfigGetResponse map[string]HistoryConfigGetResponseItem

type HistoryConfigGetResponseEnvelope

type HistoryConfigGetResponseEnvelope struct {
	Errors   []HistoryConfigGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []HistoryConfigGetResponseEnvelopeMessages `json:"messages,required"`
	// Object where keys are numericc onfiguration IDs
	Result HistoryConfigGetResponse `json:"result,required"`
	// Whether the API call was successful
	Success bool                                 `json:"success,required"`
	JSON    historyConfigGetResponseEnvelopeJSON `json:"-"`
}

func (*HistoryConfigGetResponseEnvelope) UnmarshalJSON

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

type HistoryConfigGetResponseEnvelopeErrors

type HistoryConfigGetResponseEnvelopeErrors struct {
	Code             int64                                        `json:"code,required"`
	Message          string                                       `json:"message,required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           HistoryConfigGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             historyConfigGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*HistoryConfigGetResponseEnvelopeErrors) UnmarshalJSON

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

type HistoryConfigGetResponseEnvelopeErrorsSource

type HistoryConfigGetResponseEnvelopeErrorsSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    historyConfigGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*HistoryConfigGetResponseEnvelopeErrorsSource) UnmarshalJSON

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

type HistoryConfigGetResponseEnvelopeMessages

type HistoryConfigGetResponseEnvelopeMessages struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           HistoryConfigGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             historyConfigGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*HistoryConfigGetResponseEnvelopeMessages) UnmarshalJSON

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

type HistoryConfigGetResponseEnvelopeMessagesSource

type HistoryConfigGetResponseEnvelopeMessagesSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    historyConfigGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*HistoryConfigGetResponseEnvelopeMessagesSource) UnmarshalJSON

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

type HistoryConfigGetResponseItem

type HistoryConfigGetResponseItem struct {
	// ID of the configuration
	ID int64 `json:"id,required"`
	// Zaraz configuration
	Config Configuration `json:"config,required"`
	// Date and time the configuration was created
	CreatedAt time.Time `json:"createdAt,required" format:"date-time"`
	// Date and time the configuration was last updated
	UpdatedAt time.Time `json:"updatedAt,required" format:"date-time"`
	// Alpha-numeric ID of the account user who published the configuration
	UserID string                           `json:"userId,required"`
	JSON   historyConfigGetResponseItemJSON `json:"-"`
}

func (*HistoryConfigGetResponseItem) UnmarshalJSON

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

type HistoryConfigService

type HistoryConfigService struct {
	Options []option.RequestOption
}

HistoryConfigService 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 NewHistoryConfigService method instead.

func NewHistoryConfigService

func NewHistoryConfigService(opts ...option.RequestOption) (r *HistoryConfigService)

NewHistoryConfigService 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 (*HistoryConfigService) Get

Gets a history of published Zaraz configurations by ID(s) for a zone.

type HistoryListParams

type HistoryListParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Maximum amount of results to list. Default value is 10.
	Limit param.Field[int64] `query:"limit"`
	// Ordinal number to start listing the results with. Default value is 0.
	Offset param.Field[int64] `query:"offset"`
	// The field to sort by. Default is updated_at.
	SortField param.Field[HistoryListParamsSortField] `query:"sortField"`
	// Sorting order. Default is DESC.
	SortOrder param.Field[HistoryListParamsSortOrder] `query:"sortOrder"`
}

func (HistoryListParams) URLQuery

func (r HistoryListParams) URLQuery() (v url.Values)

URLQuery serializes HistoryListParams's query parameters as `url.Values`.

type HistoryListParamsSortField

type HistoryListParamsSortField string

The field to sort by. Default is updated_at.

const (
	HistoryListParamsSortFieldID          HistoryListParamsSortField = "id"
	HistoryListParamsSortFieldUserID      HistoryListParamsSortField = "user_id"
	HistoryListParamsSortFieldDescription HistoryListParamsSortField = "description"
	HistoryListParamsSortFieldCreatedAt   HistoryListParamsSortField = "created_at"
	HistoryListParamsSortFieldUpdatedAt   HistoryListParamsSortField = "updated_at"
)

func (HistoryListParamsSortField) IsKnown

func (r HistoryListParamsSortField) IsKnown() bool

type HistoryListParamsSortOrder

type HistoryListParamsSortOrder string

Sorting order. Default is DESC.

const (
	HistoryListParamsSortOrderDesc HistoryListParamsSortOrder = "DESC"
	HistoryListParamsSortOrderAsc  HistoryListParamsSortOrder = "ASC"
)

func (HistoryListParamsSortOrder) IsKnown

func (r HistoryListParamsSortOrder) IsKnown() bool

type HistoryListResponse

type HistoryListResponse struct {
	// ID of the configuration
	ID int64 `json:"id,required"`
	// Date and time the configuration was created
	CreatedAt time.Time `json:"createdAt,required" format:"date-time"`
	// Configuration description provided by the user who published this configuration
	Description string `json:"description,required"`
	// Date and time the configuration was last updated
	UpdatedAt time.Time `json:"updatedAt,required" format:"date-time"`
	// Alpha-numeric ID of the account user who published the configuration
	UserID string                  `json:"userId,required"`
	JSON   historyListResponseJSON `json:"-"`
}

func (*HistoryListResponse) UnmarshalJSON

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

type HistoryService

type HistoryService struct {
	Options []option.RequestOption
	Configs *HistoryConfigService
}

HistoryService 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 NewHistoryService method instead.

func NewHistoryService

func NewHistoryService(opts ...option.RequestOption) (r *HistoryService)

NewHistoryService 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 (*HistoryService) List

Lists a history of published Zaraz configuration records for a zone.

func (*HistoryService) ListAutoPaging

Lists a history of published Zaraz configuration records for a zone.

func (*HistoryService) Update

func (r *HistoryService) Update(ctx context.Context, params HistoryUpdateParams, opts ...option.RequestOption) (res *Configuration, err error)

Restores a historical published Zaraz configuration by ID for a zone.

type HistoryUpdateParams

type HistoryUpdateParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// ID of the Zaraz configuration to restore.
	Body int64 `json:"body,required"`
}

func (HistoryUpdateParams) MarshalJSON

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

type HistoryUpdateResponseEnvelope

type HistoryUpdateResponseEnvelope struct {
	Errors   []HistoryUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []HistoryUpdateResponseEnvelopeMessages `json:"messages,required"`
	// Zaraz configuration
	Result Configuration `json:"result,required"`
	// Whether the API call was successful
	Success bool                              `json:"success,required"`
	JSON    historyUpdateResponseEnvelopeJSON `json:"-"`
}

func (*HistoryUpdateResponseEnvelope) UnmarshalJSON

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

type HistoryUpdateResponseEnvelopeErrors

type HistoryUpdateResponseEnvelopeErrors struct {
	Code             int64                                     `json:"code,required"`
	Message          string                                    `json:"message,required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           HistoryUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             historyUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*HistoryUpdateResponseEnvelopeErrors) UnmarshalJSON

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

type HistoryUpdateResponseEnvelopeErrorsSource

type HistoryUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    historyUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*HistoryUpdateResponseEnvelopeErrorsSource) UnmarshalJSON

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

type HistoryUpdateResponseEnvelopeMessages

type HistoryUpdateResponseEnvelopeMessages struct {
	Code             int64                                       `json:"code,required"`
	Message          string                                      `json:"message,required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           HistoryUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             historyUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*HistoryUpdateResponseEnvelopeMessages) UnmarshalJSON

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

type HistoryUpdateResponseEnvelopeMessagesSource

type HistoryUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    historyUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*HistoryUpdateResponseEnvelopeMessagesSource) UnmarshalJSON

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

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 NeoEvent

type NeoEvent struct {
	// Tool event type
	ActionType string `json:"actionType,required"`
	// List of blocking triggers IDs
	BlockingTriggers []string `json:"blockingTriggers,required"`
	// Event payload
	Data interface{} `json:"data,required"`
	// List of firing triggers IDs
	FiringTriggers []string     `json:"firingTriggers,required"`
	JSON           neoEventJSON `json:"-"`
}

func (*NeoEvent) UnmarshalJSON

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

type NeoEventParam

type NeoEventParam struct {
	// Tool event type
	ActionType param.Field[string] `json:"actionType,required"`
	// List of blocking triggers IDs
	BlockingTriggers param.Field[[]string] `json:"blockingTriggers,required"`
	// Event payload
	Data param.Field[interface{}] `json:"data,required"`
	// List of firing triggers IDs
	FiringTriggers param.Field[[]string] `json:"firingTriggers,required"`
}

func (NeoEventParam) MarshalJSON

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

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 PublishNewParams

type PublishNewParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Zaraz configuration description.
	Body string `json:"body"`
}

func (PublishNewParams) MarshalJSON

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

type PublishNewResponseEnvelope

type PublishNewResponseEnvelope struct {
	Errors   []PublishNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []PublishNewResponseEnvelopeMessages `json:"messages,required"`
	Result   string                               `json:"result,required"`
	// Whether the API call was successful
	Success bool                           `json:"success,required"`
	JSON    publishNewResponseEnvelopeJSON `json:"-"`
}

func (*PublishNewResponseEnvelope) UnmarshalJSON

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

type PublishNewResponseEnvelopeErrors

type PublishNewResponseEnvelopeErrors struct {
	Code             int64                                  `json:"code,required"`
	Message          string                                 `json:"message,required"`
	DocumentationURL string                                 `json:"documentation_url"`
	Source           PublishNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             publishNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*PublishNewResponseEnvelopeErrors) UnmarshalJSON

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

type PublishNewResponseEnvelopeErrorsSource

type PublishNewResponseEnvelopeErrorsSource struct {
	Pointer string                                     `json:"pointer"`
	JSON    publishNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*PublishNewResponseEnvelopeErrorsSource) UnmarshalJSON

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

type PublishNewResponseEnvelopeMessages

type PublishNewResponseEnvelopeMessages struct {
	Code             int64                                    `json:"code,required"`
	Message          string                                   `json:"message,required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           PublishNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             publishNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*PublishNewResponseEnvelopeMessages) UnmarshalJSON

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

type PublishNewResponseEnvelopeMessagesSource

type PublishNewResponseEnvelopeMessagesSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    publishNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*PublishNewResponseEnvelopeMessagesSource) UnmarshalJSON

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

type PublishService

type PublishService struct {
	Options []option.RequestOption
}

PublishService 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 NewPublishService method instead.

func NewPublishService

func NewPublishService(opts ...option.RequestOption) (r *PublishService)

NewPublishService 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 (*PublishService) New

func (r *PublishService) New(ctx context.Context, params PublishNewParams, opts ...option.RequestOption) (res *string, err error)

Publish current Zaraz preview configuration for a zone.

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

type Workflow

type Workflow string

Zaraz workflow

const (
	WorkflowRealtime Workflow = "realtime"
	WorkflowPreview  Workflow = "preview"
)

func (Workflow) IsKnown

func (r Workflow) IsKnown() bool

type WorkflowGetParams

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

type WorkflowGetResponseEnvelope

type WorkflowGetResponseEnvelope struct {
	Errors   []WorkflowGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []WorkflowGetResponseEnvelopeMessages `json:"messages,required"`
	// Zaraz workflow
	Result Workflow `json:"result,required"`
	// Whether the API call was successful
	Success bool                            `json:"success,required"`
	JSON    workflowGetResponseEnvelopeJSON `json:"-"`
}

func (*WorkflowGetResponseEnvelope) UnmarshalJSON

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

type WorkflowGetResponseEnvelopeErrors

type WorkflowGetResponseEnvelopeErrors struct {
	Code             int64                                   `json:"code,required"`
	Message          string                                  `json:"message,required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           WorkflowGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             workflowGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*WorkflowGetResponseEnvelopeErrors) UnmarshalJSON

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

type WorkflowGetResponseEnvelopeErrorsSource

type WorkflowGetResponseEnvelopeErrorsSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    workflowGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*WorkflowGetResponseEnvelopeErrorsSource) UnmarshalJSON

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

type WorkflowGetResponseEnvelopeMessages

type WorkflowGetResponseEnvelopeMessages struct {
	Code             int64                                     `json:"code,required"`
	Message          string                                    `json:"message,required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           WorkflowGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             workflowGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*WorkflowGetResponseEnvelopeMessages) UnmarshalJSON

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

type WorkflowGetResponseEnvelopeMessagesSource

type WorkflowGetResponseEnvelopeMessagesSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    workflowGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*WorkflowGetResponseEnvelopeMessagesSource) UnmarshalJSON

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

type WorkflowService

type WorkflowService struct {
	Options []option.RequestOption
}

WorkflowService 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 NewWorkflowService method instead.

func NewWorkflowService

func NewWorkflowService(opts ...option.RequestOption) (r *WorkflowService)

NewWorkflowService 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 (*WorkflowService) Get

func (r *WorkflowService) Get(ctx context.Context, query WorkflowGetParams, opts ...option.RequestOption) (res *Workflow, err error)

Gets Zaraz workflow for a zone.

type ZarazService

type ZarazService struct {
	Options  []option.RequestOption
	Config   *ConfigService
	Default  *DefaultService
	Export   *ExportService
	History  *HistoryService
	Publish  *PublishService
	Workflow *WorkflowService
}

ZarazService 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 NewZarazService method instead.

func NewZarazService

func NewZarazService(opts ...option.RequestOption) (r *ZarazService)

NewZarazService 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 (*ZarazService) Update

func (r *ZarazService) Update(ctx context.Context, params ZarazUpdateParams, opts ...option.RequestOption) (res *Workflow, err error)

Updates Zaraz workflow for a zone.

type ZarazUpdateParams

type ZarazUpdateParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Zaraz workflow
	Workflow Workflow `json:"workflow,required"`
}

func (ZarazUpdateParams) MarshalJSON

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

type ZarazUpdateResponseEnvelope

type ZarazUpdateResponseEnvelope struct {
	Errors   []ZarazUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ZarazUpdateResponseEnvelopeMessages `json:"messages,required"`
	// Zaraz workflow
	Result Workflow `json:"result,required"`
	// Whether the API call was successful
	Success bool                            `json:"success,required"`
	JSON    zarazUpdateResponseEnvelopeJSON `json:"-"`
}

func (*ZarazUpdateResponseEnvelope) UnmarshalJSON

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

type ZarazUpdateResponseEnvelopeErrors

type ZarazUpdateResponseEnvelopeErrors struct {
	Code             int64                                   `json:"code,required"`
	Message          string                                  `json:"message,required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           ZarazUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             zarazUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ZarazUpdateResponseEnvelopeErrors) UnmarshalJSON

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

type ZarazUpdateResponseEnvelopeErrorsSource

type ZarazUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    zarazUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ZarazUpdateResponseEnvelopeErrorsSource) UnmarshalJSON

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

type ZarazUpdateResponseEnvelopeMessages

type ZarazUpdateResponseEnvelopeMessages struct {
	Code             int64                                     `json:"code,required"`
	Message          string                                    `json:"message,required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           ZarazUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             zarazUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ZarazUpdateResponseEnvelopeMessages) UnmarshalJSON

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

type ZarazUpdateResponseEnvelopeMessagesSource

type ZarazUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    zarazUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ZarazUpdateResponseEnvelopeMessagesSource) UnmarshalJSON

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

Jump to

Keyboard shortcuts

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