generated

package
v0.2.3 Latest Latest
Warning

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

 Go to latest Published: Sep 12, 2026 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Code generated by Ridu. DO NOT EDIT.

Index

Constants

View Source 
const CTABlockType = "cta"

CTABlockType is the immutable stored discriminator.

View Source 
const CalloutBlockType = "callout"

CalloutBlockType is the immutable stored discriminator.

View Source 
const ContentBlockType = "content"

ContentBlockType is the immutable stored discriminator.

View Source 
const HeroBlockType = "hero"

HeroBlockType is the immutable stored discriminator.

View Source 
const MediaBlockType = "media"

MediaBlockType is the immutable stored discriminator.

Variables

View Source 
var ArticlesCollection = core.NewTypedCollection[Article, ArticleCreate, ArticleUpdate]("articles")
View Source 
var ArticlesCollectionAllLocales = core.NewTypedAllLocalesCollection[ArticleAllLocales]("articles")

ArticlesCollectionAllLocales reads all translations with optional population and projection.

View Source 
var AssetsCollection = core.NewTypedCollection[Asset, AssetCreate, AssetUpdate]("assets")
View Source 
var AssetsCollectionAllLocales = core.NewTypedAllLocalesCollection[AssetAllLocales]("assets")

AssetsCollectionAllLocales reads all translations with optional population and projection.

View Source 
var CampaignsCollection = core.NewTypedCollection[Campaign, CampaignCreate, CampaignUpdate]("campaigns")
View Source 
var CampaignsCollectionAllLocales = core.NewTypedAllLocalesCollection[CampaignAllLocales]("campaigns")

CampaignsCollectionAllLocales reads all translations with optional population and projection.

View Source 
var PagesCollection = core.NewTypedCollection[Page, PageCreate, PageUpdate]("pages")
View Source 
var PagesCollectionAllLocales = core.NewTypedAllLocalesCollection[PageAllLocales]("pages")

PagesCollectionAllLocales reads all translations with optional population and projection.

Functions

This section is empty.

Types

type Article 

type Article struct {
	ID        string `json:"id"`
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt"`
	Status    string `json:"_status"`
	Revision  int    `json:"_revision"`
	// Title may be omitted by access rules or projection.
	Title *string `json:"title,omitempty"`
	// Body may be omitted by access rules or projection.
	Body *richtext.Document[ArticlesBodyBlocksBlockPayload] `json:"body,omitempty"`
	// LocalizedBody may be omitted by access rules or projection.
	LocalizedBody *richtext.Document[ArticlesLocalizedBodyBlocksBlockPayload] `json:"localizedBody,omitempty"`
}

Article is a single-locale read. Authored fields can be omitted by access rules or projection.

func (*Article) UnmarshalJSON 

func (value *Article) UnmarshalJSON(data []byte) error

type ArticleAllLocales 

type ArticleAllLocales struct {
	ID        string `json:"id"`
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt"`
	Status    string `json:"_status"`
	Revision  int    `json:"_revision"`
	// Title may be omitted by access rules or projection.
	Title *string `json:"title,omitempty"`
	// Body may be omitted by access rules or projection.
	Body *richtext.Document[ArticlesBodyBlocksBlockAllLocalesPayload] `json:"body,omitempty"`
	// LocalizedBody may be omitted by access rules or projection.
	// Locale-code map; missing locales are absent translations.
	LocalizedBody *map[string]*richtext.Document[ArticlesLocalizedBodyBlocksBlockAllLocalesValuePayload] `json:"localizedBody,omitempty"`
}

ArticleAllLocales is an all-locales read: localized fields contain locale-code maps.

func (*ArticleAllLocales) UnmarshalJSON 

func (value *ArticleAllLocales) UnmarshalJSON(data []byte) error

type ArticleCreate 

type ArticleCreate struct {
	// Title is required when creating this value.
	Title string `json:"title"`
	// Body: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Body *core.Input[richtext.Document[ArticlesBodyBlocksBlockInputPayload]] `json:"body,omitempty"`
	// LocalizedBody: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	LocalizedBody *core.Input[richtext.Document[ArticlesLocalizedBodyBlocksBlockInputPayload]] `json:"localizedBody,omitempty"`
}

ArticleCreate supplies a new document. Required values are concrete; defaulted values may be omitted, and nullable values use core.Set or core.Null.

func (*ArticleCreate) UnmarshalJSON 

func (value *ArticleCreate) UnmarshalJSON(data []byte) error

type ArticleUpdate 

type ArticleUpdate struct {
	// Title: nil omits the field; a pointer sends a value. Null is not allowed.
	Title *string `json:"title,omitempty"`
	// Body: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Body *core.Input[richtext.Document[ArticlesBodyBlocksBlockUpdatePayload]] `json:"body,omitempty"`
	// LocalizedBody: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	LocalizedBody *core.Input[richtext.Document[ArticlesLocalizedBodyBlocksBlockUpdatePayload]] `json:"localizedBody,omitempty"`
}

ArticleUpdate edits a document. Nil fields are unchanged; supplied block lists replace order and membership.

func (*ArticleUpdate) UnmarshalJSON 

func (value *ArticleUpdate) UnmarshalJSON(data []byte) error

type ArticlesBodyBlocksBlock 

type ArticlesBodyBlocksBlock []ArticlesBodyBlocksBlockBlock

ArticlesBodyBlocksBlock is an ordered list of block pointers. Nil rows are invalid.

func (ArticlesBodyBlocksBlock) MarshalJSON 

func (rows ArticlesBodyBlocksBlock) MarshalJSON() ([]byte, error)

func (*ArticlesBodyBlocksBlock) Retain 

func (rows *ArticlesBodyBlocksBlock) Retain() (ArticlesBodyBlocksBlockUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*ArticlesBodyBlocksBlock) UnmarshalJSON 

func (rows *ArticlesBodyBlocksBlock) UnmarshalJSON(data []byte) error

type ArticlesBodyBlocksBlockAllLocales 

type ArticlesBodyBlocksBlockAllLocales []ArticlesBodyBlocksBlockAllLocalesBlock

ArticlesBodyBlocksBlockAllLocales is an ordered list of block pointers. Nil rows are invalid. Localized children contain locale-code maps; use ordinary output types for a single locale.

func (ArticlesBodyBlocksBlockAllLocales) MarshalJSON 

func (rows ArticlesBodyBlocksBlockAllLocales) MarshalJSON() ([]byte, error)

func (*ArticlesBodyBlocksBlockAllLocales) Retain 

func (rows *ArticlesBodyBlocksBlockAllLocales) Retain() (ArticlesBodyBlocksBlockUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*ArticlesBodyBlocksBlockAllLocales) UnmarshalJSON 

func (rows *ArticlesBodyBlocksBlockAllLocales) UnmarshalJSON(data []byte) error

type ArticlesBodyBlocksBlockAllLocalesBlock 

type ArticlesBodyBlocksBlockAllLocalesBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

ArticlesBodyBlocksBlockAllLocalesBlock admits only generated block pointers; decoding returns those same pointer types.

type ArticlesBodyBlocksBlockAllLocalesPayload 

type ArticlesBodyBlocksBlockAllLocalesPayload struct {
	Value ArticlesBodyBlocksBlockAllLocalesBlock
}

ArticlesBodyBlocksBlockAllLocalesPayload is one typed detached payload, with scalar JSON encoding.

func (ArticlesBodyBlocksBlockAllLocalesPayload) MarshalJSON 

func (p ArticlesBodyBlocksBlockAllLocalesPayload) MarshalJSON() ([]byte, error)

func (ArticlesBodyBlocksBlockAllLocalesPayload) Retain 

func (payload ArticlesBodyBlocksBlockAllLocalesPayload) Retain() (ArticlesBodyBlocksBlockUpdatePayload, error)

Retain creates a key-only update for this embedded occurrence, without copying redacted, localized or populated authored fields. Use revision checks when saving.

func (*ArticlesBodyBlocksBlockAllLocalesPayload) UnmarshalJSON 

func (p *ArticlesBodyBlocksBlockAllLocalesPayload) UnmarshalJSON(data []byte) error

type ArticlesBodyBlocksBlockAllLocalesValue 

type ArticlesBodyBlocksBlockAllLocalesValue []ArticlesBodyBlocksBlockAllLocalesValueBlock

ArticlesBodyBlocksBlockAllLocalesValue is an ordered list of block pointers. Nil rows are invalid. This is one locale's value beneath a localized container in an all-locales response. Children are ordinary values; populated target documents still have all-locales shapes.

func (ArticlesBodyBlocksBlockAllLocalesValue) MarshalJSON 

func (rows ArticlesBodyBlocksBlockAllLocalesValue) MarshalJSON() ([]byte, error)

func (*ArticlesBodyBlocksBlockAllLocalesValue) Retain 

func (rows *ArticlesBodyBlocksBlockAllLocalesValue) Retain() (ArticlesBodyBlocksBlockUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*ArticlesBodyBlocksBlockAllLocalesValue) UnmarshalJSON 

func (rows *ArticlesBodyBlocksBlockAllLocalesValue) UnmarshalJSON(data []byte) error

type ArticlesBodyBlocksBlockAllLocalesValueBlock 

type ArticlesBodyBlocksBlockAllLocalesValueBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

ArticlesBodyBlocksBlockAllLocalesValueBlock admits only generated block pointers; decoding returns those same pointer types.

type ArticlesBodyBlocksBlockAllLocalesValuePayload 

type ArticlesBodyBlocksBlockAllLocalesValuePayload struct {
	Value ArticlesBodyBlocksBlockAllLocalesValueBlock
}

ArticlesBodyBlocksBlockAllLocalesValuePayload is one typed detached payload, with scalar JSON encoding.

func (ArticlesBodyBlocksBlockAllLocalesValuePayload) MarshalJSON 

func (p ArticlesBodyBlocksBlockAllLocalesValuePayload) MarshalJSON() ([]byte, error)

func (ArticlesBodyBlocksBlockAllLocalesValuePayload) Retain 

func (payload ArticlesBodyBlocksBlockAllLocalesValuePayload) Retain() (ArticlesBodyBlocksBlockUpdatePayload, error)

Retain creates a key-only update for this embedded occurrence, without copying redacted, localized or populated authored fields. Use revision checks when saving.

func (*ArticlesBodyBlocksBlockAllLocalesValuePayload) UnmarshalJSON 

func (p *ArticlesBodyBlocksBlockAllLocalesValuePayload) UnmarshalJSON(data []byte) error

type ArticlesBodyBlocksBlockBlock 

type ArticlesBodyBlocksBlockBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

ArticlesBodyBlocksBlockBlock admits only generated block pointers; decoding returns those same pointer types.

type ArticlesBodyBlocksBlockInput 

type ArticlesBodyBlocksBlockInput []ArticlesBodyBlocksBlockInputBlock

ArticlesBodyBlocksBlockInput is an ordered list of block pointers. Nil rows are invalid.

func (ArticlesBodyBlocksBlockInput) MarshalJSON 

func (rows ArticlesBodyBlocksBlockInput) MarshalJSON() ([]byte, error)

func (*ArticlesBodyBlocksBlockInput) UnmarshalJSON 

func (rows *ArticlesBodyBlocksBlockInput) UnmarshalJSON(data []byte) error

type ArticlesBodyBlocksBlockInputBlock 

type ArticlesBodyBlocksBlockInputBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

ArticlesBodyBlocksBlockInputBlock admits only generated block pointers; decoding returns those same pointer types.

type ArticlesBodyBlocksBlockInputPayload 

type ArticlesBodyBlocksBlockInputPayload struct {
	Value ArticlesBodyBlocksBlockInputBlock
}

ArticlesBodyBlocksBlockInputPayload is one typed detached payload, with scalar JSON encoding.

func (ArticlesBodyBlocksBlockInputPayload) MarshalJSON 

func (p ArticlesBodyBlocksBlockInputPayload) MarshalJSON() ([]byte, error)

func (*ArticlesBodyBlocksBlockInputPayload) UnmarshalJSON 

func (p *ArticlesBodyBlocksBlockInputPayload) UnmarshalJSON(data []byte) error

type ArticlesBodyBlocksBlockPayload 

type ArticlesBodyBlocksBlockPayload struct{ Value ArticlesBodyBlocksBlockBlock }

ArticlesBodyBlocksBlockPayload is one typed detached payload, with scalar JSON encoding.

func (ArticlesBodyBlocksBlockPayload) MarshalJSON 

func (p ArticlesBodyBlocksBlockPayload) MarshalJSON() ([]byte, error)

func (ArticlesBodyBlocksBlockPayload) Retain 

func (payload ArticlesBodyBlocksBlockPayload) Retain() (ArticlesBodyBlocksBlockUpdatePayload, error)

Retain creates a key-only update for this embedded occurrence, without copying redacted, localized or populated authored fields. Use revision checks when saving.

func (*ArticlesBodyBlocksBlockPayload) UnmarshalJSON 

func (p *ArticlesBodyBlocksBlockPayload) UnmarshalJSON(data []byte) error

type ArticlesBodyBlocksBlockUpdate 

type ArticlesBodyBlocksBlockUpdate []ArticlesBodyBlocksBlockUpdateBlock

ArticlesBodyBlocksBlockUpdate is an ordered list of block pointers. Nil rows are invalid. Saving this list replaces order and membership: omitted occurrences are removed. Start with a read list's Retain method to preserve untouched blocks.

func (ArticlesBodyBlocksBlockUpdate) MarshalJSON 

func (rows ArticlesBodyBlocksBlockUpdate) MarshalJSON() ([]byte, error)

func (*ArticlesBodyBlocksBlockUpdate) UnmarshalJSON 

func (rows *ArticlesBodyBlocksBlockUpdate) UnmarshalJSON(data []byte) error

type ArticlesBodyBlocksBlockUpdateBlock 

type ArticlesBodyBlocksBlockUpdateBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

ArticlesBodyBlocksBlockUpdateBlock admits only generated block pointers; decoding returns those same pointer types. Use keyed Update pointers for existing occurrences and Input pointers for new occurrences.

type ArticlesBodyBlocksBlockUpdatePayload 

type ArticlesBodyBlocksBlockUpdatePayload struct {
	Value ArticlesBodyBlocksBlockUpdateBlock
}

ArticlesBodyBlocksBlockUpdatePayload is one typed detached payload, with scalar JSON encoding.

func (ArticlesBodyBlocksBlockUpdatePayload) MarshalJSON 

func (p ArticlesBodyBlocksBlockUpdatePayload) MarshalJSON() ([]byte, error)

func (*ArticlesBodyBlocksBlockUpdatePayload) UnmarshalJSON 

func (p *ArticlesBodyBlocksBlockUpdatePayload) UnmarshalJSON(data []byte) error

type ArticlesLocalizedBodyBlocksBlock 

type ArticlesLocalizedBodyBlocksBlock []ArticlesLocalizedBodyBlocksBlockBlock

ArticlesLocalizedBodyBlocksBlock is an ordered list of block pointers. Nil rows are invalid.

func (ArticlesLocalizedBodyBlocksBlock) MarshalJSON 

func (rows ArticlesLocalizedBodyBlocksBlock) MarshalJSON() ([]byte, error)

func (*ArticlesLocalizedBodyBlocksBlock) Retain 

func (rows *ArticlesLocalizedBodyBlocksBlock) Retain() (ArticlesLocalizedBodyBlocksBlockUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*ArticlesLocalizedBodyBlocksBlock) UnmarshalJSON 

func (rows *ArticlesLocalizedBodyBlocksBlock) UnmarshalJSON(data []byte) error

type ArticlesLocalizedBodyBlocksBlockAllLocales 

type ArticlesLocalizedBodyBlocksBlockAllLocales []ArticlesLocalizedBodyBlocksBlockAllLocalesBlock

ArticlesLocalizedBodyBlocksBlockAllLocales is an ordered list of block pointers. Nil rows are invalid. Localized children contain locale-code maps; use ordinary output types for a single locale.

func (ArticlesLocalizedBodyBlocksBlockAllLocales) MarshalJSON 

func (rows ArticlesLocalizedBodyBlocksBlockAllLocales) MarshalJSON() ([]byte, error)

func (*ArticlesLocalizedBodyBlocksBlockAllLocales) Retain 

func (rows *ArticlesLocalizedBodyBlocksBlockAllLocales) Retain() (ArticlesLocalizedBodyBlocksBlockUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*ArticlesLocalizedBodyBlocksBlockAllLocales) UnmarshalJSON 

func (rows *ArticlesLocalizedBodyBlocksBlockAllLocales) UnmarshalJSON(data []byte) error

type ArticlesLocalizedBodyBlocksBlockAllLocalesBlock 

type ArticlesLocalizedBodyBlocksBlockAllLocalesBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

ArticlesLocalizedBodyBlocksBlockAllLocalesBlock admits only generated block pointers; decoding returns those same pointer types.

type ArticlesLocalizedBodyBlocksBlockAllLocalesPayload 

type ArticlesLocalizedBodyBlocksBlockAllLocalesPayload struct {
	Value ArticlesLocalizedBodyBlocksBlockAllLocalesBlock
}

ArticlesLocalizedBodyBlocksBlockAllLocalesPayload is one typed detached payload, with scalar JSON encoding.

func (ArticlesLocalizedBodyBlocksBlockAllLocalesPayload) MarshalJSON 

func (p ArticlesLocalizedBodyBlocksBlockAllLocalesPayload) MarshalJSON() ([]byte, error)

func (ArticlesLocalizedBodyBlocksBlockAllLocalesPayload) Retain 

func (payload ArticlesLocalizedBodyBlocksBlockAllLocalesPayload) Retain() (ArticlesLocalizedBodyBlocksBlockUpdatePayload, error)

Retain creates a key-only update for this embedded occurrence, without copying redacted, localized or populated authored fields. Use revision checks when saving.

func (*ArticlesLocalizedBodyBlocksBlockAllLocalesPayload) UnmarshalJSON 

func (p *ArticlesLocalizedBodyBlocksBlockAllLocalesPayload) UnmarshalJSON(data []byte) error

type ArticlesLocalizedBodyBlocksBlockAllLocalesValue 

type ArticlesLocalizedBodyBlocksBlockAllLocalesValue []ArticlesLocalizedBodyBlocksBlockAllLocalesValueBlock

ArticlesLocalizedBodyBlocksBlockAllLocalesValue is an ordered list of block pointers. Nil rows are invalid. This is one locale's value beneath a localized container in an all-locales response. Children are ordinary values; populated target documents still have all-locales shapes.

func (ArticlesLocalizedBodyBlocksBlockAllLocalesValue) MarshalJSON 

func (rows ArticlesLocalizedBodyBlocksBlockAllLocalesValue) MarshalJSON() ([]byte, error)

func (*ArticlesLocalizedBodyBlocksBlockAllLocalesValue) Retain 

func (rows *ArticlesLocalizedBodyBlocksBlockAllLocalesValue) Retain() (ArticlesLocalizedBodyBlocksBlockUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*ArticlesLocalizedBodyBlocksBlockAllLocalesValue) UnmarshalJSON 

func (rows *ArticlesLocalizedBodyBlocksBlockAllLocalesValue) UnmarshalJSON(data []byte) error

type ArticlesLocalizedBodyBlocksBlockAllLocalesValueBlock 

type ArticlesLocalizedBodyBlocksBlockAllLocalesValueBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

ArticlesLocalizedBodyBlocksBlockAllLocalesValueBlock admits only generated block pointers; decoding returns those same pointer types.

type ArticlesLocalizedBodyBlocksBlockAllLocalesValuePayload 

type ArticlesLocalizedBodyBlocksBlockAllLocalesValuePayload struct {
	Value ArticlesLocalizedBodyBlocksBlockAllLocalesValueBlock
}

ArticlesLocalizedBodyBlocksBlockAllLocalesValuePayload is one typed detached payload, with scalar JSON encoding.

func (ArticlesLocalizedBodyBlocksBlockAllLocalesValuePayload) MarshalJSON 

func (p ArticlesLocalizedBodyBlocksBlockAllLocalesValuePayload) MarshalJSON() ([]byte, error)

func (ArticlesLocalizedBodyBlocksBlockAllLocalesValuePayload) Retain 

func (payload ArticlesLocalizedBodyBlocksBlockAllLocalesValuePayload) Retain() (ArticlesLocalizedBodyBlocksBlockUpdatePayload, error)

Retain creates a key-only update for this embedded occurrence, without copying redacted, localized or populated authored fields. Use revision checks when saving.

func (*ArticlesLocalizedBodyBlocksBlockAllLocalesValuePayload) UnmarshalJSON 

func (p *ArticlesLocalizedBodyBlocksBlockAllLocalesValuePayload) UnmarshalJSON(data []byte) error

type ArticlesLocalizedBodyBlocksBlockBlock 

type ArticlesLocalizedBodyBlocksBlockBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

ArticlesLocalizedBodyBlocksBlockBlock admits only generated block pointers; decoding returns those same pointer types.

type ArticlesLocalizedBodyBlocksBlockInput 

type ArticlesLocalizedBodyBlocksBlockInput []ArticlesLocalizedBodyBlocksBlockInputBlock

ArticlesLocalizedBodyBlocksBlockInput is an ordered list of block pointers. Nil rows are invalid.

func (ArticlesLocalizedBodyBlocksBlockInput) MarshalJSON 

func (rows ArticlesLocalizedBodyBlocksBlockInput) MarshalJSON() ([]byte, error)

func (*ArticlesLocalizedBodyBlocksBlockInput) UnmarshalJSON 

func (rows *ArticlesLocalizedBodyBlocksBlockInput) UnmarshalJSON(data []byte) error

type ArticlesLocalizedBodyBlocksBlockInputBlock 

type ArticlesLocalizedBodyBlocksBlockInputBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

ArticlesLocalizedBodyBlocksBlockInputBlock admits only generated block pointers; decoding returns those same pointer types.

type ArticlesLocalizedBodyBlocksBlockInputPayload 

type ArticlesLocalizedBodyBlocksBlockInputPayload struct {
	Value ArticlesLocalizedBodyBlocksBlockInputBlock
}

ArticlesLocalizedBodyBlocksBlockInputPayload is one typed detached payload, with scalar JSON encoding.

func (ArticlesLocalizedBodyBlocksBlockInputPayload) MarshalJSON 

func (p ArticlesLocalizedBodyBlocksBlockInputPayload) MarshalJSON() ([]byte, error)

func (*ArticlesLocalizedBodyBlocksBlockInputPayload) UnmarshalJSON 

func (p *ArticlesLocalizedBodyBlocksBlockInputPayload) UnmarshalJSON(data []byte) error

type ArticlesLocalizedBodyBlocksBlockPayload 

type ArticlesLocalizedBodyBlocksBlockPayload struct {
	Value ArticlesLocalizedBodyBlocksBlockBlock
}

ArticlesLocalizedBodyBlocksBlockPayload is one typed detached payload, with scalar JSON encoding.

func (ArticlesLocalizedBodyBlocksBlockPayload) MarshalJSON 

func (p ArticlesLocalizedBodyBlocksBlockPayload) MarshalJSON() ([]byte, error)

func (ArticlesLocalizedBodyBlocksBlockPayload) Retain 

func (payload ArticlesLocalizedBodyBlocksBlockPayload) Retain() (ArticlesLocalizedBodyBlocksBlockUpdatePayload, error)

Retain creates a key-only update for this embedded occurrence, without copying redacted, localized or populated authored fields. Use revision checks when saving.

func (*ArticlesLocalizedBodyBlocksBlockPayload) UnmarshalJSON 

func (p *ArticlesLocalizedBodyBlocksBlockPayload) UnmarshalJSON(data []byte) error

type ArticlesLocalizedBodyBlocksBlockUpdate 

type ArticlesLocalizedBodyBlocksBlockUpdate []ArticlesLocalizedBodyBlocksBlockUpdateBlock

ArticlesLocalizedBodyBlocksBlockUpdate is an ordered list of block pointers. Nil rows are invalid. Saving this list replaces order and membership: omitted occurrences are removed. Start with a read list's Retain method to preserve untouched blocks.

func (ArticlesLocalizedBodyBlocksBlockUpdate) MarshalJSON 

func (rows ArticlesLocalizedBodyBlocksBlockUpdate) MarshalJSON() ([]byte, error)

func (*ArticlesLocalizedBodyBlocksBlockUpdate) UnmarshalJSON 

func (rows *ArticlesLocalizedBodyBlocksBlockUpdate) UnmarshalJSON(data []byte) error

type ArticlesLocalizedBodyBlocksBlockUpdateBlock 

type ArticlesLocalizedBodyBlocksBlockUpdateBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

ArticlesLocalizedBodyBlocksBlockUpdateBlock admits only generated block pointers; decoding returns those same pointer types. Use keyed Update pointers for existing occurrences and Input pointers for new occurrences.

type ArticlesLocalizedBodyBlocksBlockUpdatePayload 

type ArticlesLocalizedBodyBlocksBlockUpdatePayload struct {
	Value ArticlesLocalizedBodyBlocksBlockUpdateBlock
}

ArticlesLocalizedBodyBlocksBlockUpdatePayload is one typed detached payload, with scalar JSON encoding.

func (ArticlesLocalizedBodyBlocksBlockUpdatePayload) MarshalJSON 

func (p ArticlesLocalizedBodyBlocksBlockUpdatePayload) MarshalJSON() ([]byte, error)

func (*ArticlesLocalizedBodyBlocksBlockUpdatePayload) UnmarshalJSON 

func (p *ArticlesLocalizedBodyBlocksBlockUpdatePayload) UnmarshalJSON(data []byte) error

type Asset 

type Asset struct {
	ID        string `json:"id"`
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt"`
	// Title may be omitted by access rules or projection.
	Title *string `json:"title,omitempty"`
	// URL may be omitted by access rules or projection.
	URL *string `json:"url,omitempty"`
}

Asset is a single-locale read. Authored fields can be omitted by access rules or projection.

func (*Asset) UnmarshalJSON 

func (value *Asset) UnmarshalJSON(data []byte) error

type AssetAllLocales 

type AssetAllLocales struct {
	ID        string `json:"id"`
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt"`
	// Title may be omitted by access rules or projection.
	Title *string `json:"title,omitempty"`
	// URL may be omitted by access rules or projection.
	URL *string `json:"url,omitempty"`
}

AssetAllLocales is an all-locales read: localized fields contain locale-code maps.

func (*AssetAllLocales) UnmarshalJSON 

func (value *AssetAllLocales) UnmarshalJSON(data []byte) error

type AssetCreate 

type AssetCreate struct {
	// Title is required when creating this value.
	Title string `json:"title"`
	// URL is required when creating this value.
	URL string `json:"url"`
}

AssetCreate supplies a new document. Required values are concrete; defaulted values may be omitted, and nullable values use core.Set or core.Null.

func (*AssetCreate) UnmarshalJSON 

func (value *AssetCreate) UnmarshalJSON(data []byte) error

type AssetUpdate 

type AssetUpdate struct {
	// Title: nil omits the field; a pointer sends a value. Null is not allowed.
	Title *string `json:"title,omitempty"`
	// URL: nil omits the field; a pointer sends a value. Null is not allowed.
	URL *string `json:"url,omitempty"`
}

AssetUpdate edits a document. Nil fields are unchanged; supplied block lists replace order and membership.

func (*AssetUpdate) UnmarshalJSON 

func (value *AssetUpdate) UnmarshalJSON(data []byte) error

type BlockOptional 

type BlockOptional[T any] struct{ Value *T }

BlockOptional preserves omitted, explicit null, and concrete nullable block children. A nil outer pointer is absent; a nil Value is explicit JSON null.

func (*BlockOptional[T]) Get 

func (value *BlockOptional[T]) Get() (T, bool)

Get returns the concrete value, or the zero value and false for omission or null. Inspect the outer pointer and Value only when omission and null must be distinguished.

func (BlockOptional[T]) MarshalJSON 

func (value BlockOptional[T]) MarshalJSON() ([]byte, error)

func (*BlockOptional[T]) UnmarshalJSON 

func (value *BlockOptional[T]) UnmarshalJSON(data []byte) error

type CTA 

type CTA struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// BlockName: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	BlockName *BlockOptional[string] `json:"blockName,omitempty"`
	// Label may be omitted by access rules or projection.
	Label *string `json:"label,omitempty"`
	// Destination: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Destination *BlockOptional[Reference[Page]] `json:"destination,omitempty"`
}

CTA is a generated block. Use *CTA in block lists and type switches. Authored children may be omitted by access rules or projection, even when required on create. Create with CTAInput. To edit, retain the read list and modify its CTAUpdate pointers.

func (*CTA) BlockKey 

func (value *CTA) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*CTA) BlockType 

func (*CTA) BlockType() string

BlockType returns the immutable stored discriminator.

func (CTA) MarshalJSON 

func (value CTA) MarshalJSON() ([]byte, error)

func (*CTA) UnmarshalJSON 

func (value *CTA) UnmarshalJSON(data []byte) error

type CTAAllLocales 

type CTAAllLocales struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// BlockName: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	BlockName *BlockOptional[string] `json:"blockName,omitempty"`
	// Label may be omitted by access rules or projection.
	// Locale-code map; missing locales are absent translations.
	Label *map[string]string `json:"label,omitempty"`
	// Destination: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Destination *BlockOptional[Reference[PageAllLocales]] `json:"destination,omitempty"`
}

CTAAllLocales is a generated block. Use *CTAAllLocales in block lists and type switches. Authored children may be omitted by access rules or projection, even when required on create.

func (*CTAAllLocales) BlockKey 

func (value *CTAAllLocales) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*CTAAllLocales) BlockType 

func (*CTAAllLocales) BlockType() string

BlockType returns the immutable stored discriminator.

func (CTAAllLocales) MarshalJSON 

func (value CTAAllLocales) MarshalJSON() ([]byte, error)

func (*CTAAllLocales) UnmarshalJSON 

func (value *CTAAllLocales) UnmarshalJSON(data []byte) error

type CTAAllLocalesValue 

type CTAAllLocalesValue struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// BlockName: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	BlockName *BlockOptional[string] `json:"blockName,omitempty"`
	// Label may be omitted by access rules or projection.
	Label *string `json:"label,omitempty"`
	// Destination: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Destination *BlockOptional[Reference[PageAllLocales]] `json:"destination,omitempty"`
}

CTAAllLocalesValue is a generated block. Use *CTAAllLocalesValue in block lists and type switches. Authored children may be omitted by access rules or projection, even when required on create.

func (*CTAAllLocalesValue) BlockKey 

func (value *CTAAllLocalesValue) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*CTAAllLocalesValue) BlockType 

func (*CTAAllLocalesValue) BlockType() string

BlockType returns the immutable stored discriminator.

func (CTAAllLocalesValue) MarshalJSON 

func (value CTAAllLocalesValue) MarshalJSON() ([]byte, error)

func (*CTAAllLocalesValue) UnmarshalJSON 

func (value *CTAAllLocalesValue) UnmarshalJSON(data []byte) error

type CTAInput 

type CTAInput struct {
	// Key identifies this occurrence; omit it for a new server-assigned identity.
	Key string `json:"_key,omitempty"`
	// BlockName: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	BlockName *core.Input[string] `json:"blockName,omitempty"`
	// Label is required when creating this value.
	Label string `json:"label"`
	// Destination: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Destination *core.Input[string] `json:"destination,omitempty"`
}

CTAInput is a generated block. Use *CTAInput in block lists and type switches. Input supplies a new occurrence's required fields. An empty Key requests a server-assigned key. Read this block as CTA; edit an existing occurrence with CTAUpdate.

func (*CTAInput) BlockKey 

func (value *CTAInput) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*CTAInput) BlockType 

func (*CTAInput) BlockType() string

BlockType returns the immutable stored discriminator.

func (CTAInput) MarshalJSON 

func (value CTAInput) MarshalJSON() ([]byte, error)

func (*CTAInput) UnmarshalJSON 

func (value *CTAInput) UnmarshalJSON(data []byte) error

type CTAUpdate 

type CTAUpdate struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// BlockName: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	BlockName *core.Input[string] `json:"blockName,omitempty"`
	// Label: nil omits the field; a pointer sends a value. Null is not allowed.
	Label *string `json:"label,omitempty"`
	// Destination: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Destination *core.Input[string] `json:"destination,omitempty"`
}

CTAUpdate is a generated block. Use *CTAUpdate in block lists and type switches. Update retains an existing occurrence by Key. Omitted children remain unchanged. The engine verifies that the key belongs to an existing occurrence of this variant. Start with the read list's Retain method; use CTAInput for additions.

func (*CTAUpdate) BlockKey 

func (value *CTAUpdate) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*CTAUpdate) BlockType 

func (*CTAUpdate) BlockType() string

BlockType returns the immutable stored discriminator.

func (CTAUpdate) MarshalJSON 

func (value CTAUpdate) MarshalJSON() ([]byte, error)

func (*CTAUpdate) UnmarshalJSON 

func (value *CTAUpdate) UnmarshalJSON(data []byte) error

type Callout 

type Callout struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// BlockName: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	BlockName *BlockOptional[string] `json:"blockName,omitempty"`
	// Title may be omitted by access rules or projection.
	Title *string `json:"title,omitempty"`
	// Message: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Message *BlockOptional[string] `json:"message,omitempty"`
	// Detail: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Detail *BlockOptional[richtext.Document[CalloutDetailBlocksBlockPayload]] `json:"detail,omitempty"`
	// Aside: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Aside *BlockOptional[richtext.Document[CalloutAsideBlocksBlockPayload]] `json:"aside,omitempty"`
}

Callout is a generated block. Use *Callout in block lists and type switches. Authored children may be omitted by access rules or projection, even when required on create. Create with CalloutInput. To edit, retain the read list and modify its CalloutUpdate pointers.

func (*Callout) BlockKey 

func (value *Callout) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*Callout) BlockType 

func (*Callout) BlockType() string

BlockType returns the immutable stored discriminator.

func (Callout) MarshalJSON 

func (value Callout) MarshalJSON() ([]byte, error)

func (*Callout) UnmarshalJSON 

func (value *Callout) UnmarshalJSON(data []byte) error

type CalloutAllLocales 

type CalloutAllLocales struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// BlockName: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	BlockName *BlockOptional[string] `json:"blockName,omitempty"`
	// Title may be omitted by access rules or projection.
	Title *string `json:"title,omitempty"`
	// Message: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	// Locale-code map; missing locales are absent translations.
	Message *BlockOptional[map[string]*string] `json:"message,omitempty"`
	// Detail: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Detail *BlockOptional[richtext.Document[CalloutDetailBlocksBlockAllLocalesPayload]] `json:"detail,omitempty"`
	// Aside: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Aside *BlockOptional[richtext.Document[CalloutAsideBlocksBlockAllLocalesPayload]] `json:"aside,omitempty"`
}

CalloutAllLocales is a generated block. Use *CalloutAllLocales in block lists and type switches. Authored children may be omitted by access rules or projection, even when required on create.

func (*CalloutAllLocales) BlockKey 

func (value *CalloutAllLocales) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*CalloutAllLocales) BlockType 

func (*CalloutAllLocales) BlockType() string

BlockType returns the immutable stored discriminator.

func (CalloutAllLocales) MarshalJSON 

func (value CalloutAllLocales) MarshalJSON() ([]byte, error)

func (*CalloutAllLocales) UnmarshalJSON 

func (value *CalloutAllLocales) UnmarshalJSON(data []byte) error

type CalloutAllLocalesValue 

type CalloutAllLocalesValue struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// BlockName: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	BlockName *BlockOptional[string] `json:"blockName,omitempty"`
	// Title may be omitted by access rules or projection.
	Title *string `json:"title,omitempty"`
	// Message: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Message *BlockOptional[string] `json:"message,omitempty"`
	// Detail: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Detail *BlockOptional[richtext.Document[CalloutDetailBlocksBlockAllLocalesValuePayload]] `json:"detail,omitempty"`
	// Aside: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Aside *BlockOptional[richtext.Document[CalloutAsideBlocksBlockAllLocalesValuePayload]] `json:"aside,omitempty"`
}

CalloutAllLocalesValue is a generated block. Use *CalloutAllLocalesValue in block lists and type switches. Authored children may be omitted by access rules or projection, even when required on create.

func (*CalloutAllLocalesValue) BlockKey 

func (value *CalloutAllLocalesValue) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*CalloutAllLocalesValue) BlockType 

func (*CalloutAllLocalesValue) BlockType() string

BlockType returns the immutable stored discriminator.

func (CalloutAllLocalesValue) MarshalJSON 

func (value CalloutAllLocalesValue) MarshalJSON() ([]byte, error)

func (*CalloutAllLocalesValue) UnmarshalJSON 

func (value *CalloutAllLocalesValue) UnmarshalJSON(data []byte) error

type CalloutAsideBlocksBlock 

type CalloutAsideBlocksBlock []CalloutAsideBlocksBlockBlock

CalloutAsideBlocksBlock is an ordered list of block pointers. Nil rows are invalid.

func (CalloutAsideBlocksBlock) MarshalJSON 

func (rows CalloutAsideBlocksBlock) MarshalJSON() ([]byte, error)

func (*CalloutAsideBlocksBlock) Retain 

func (rows *CalloutAsideBlocksBlock) Retain() (CalloutAsideBlocksBlockUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*CalloutAsideBlocksBlock) UnmarshalJSON 

func (rows *CalloutAsideBlocksBlock) UnmarshalJSON(data []byte) error

type CalloutAsideBlocksBlockAllLocales 

type CalloutAsideBlocksBlockAllLocales []CalloutAsideBlocksBlockAllLocalesBlock

CalloutAsideBlocksBlockAllLocales is an ordered list of block pointers. Nil rows are invalid. Localized children contain locale-code maps; use ordinary output types for a single locale.

func (CalloutAsideBlocksBlockAllLocales) MarshalJSON 

func (rows CalloutAsideBlocksBlockAllLocales) MarshalJSON() ([]byte, error)

func (*CalloutAsideBlocksBlockAllLocales) Retain 

func (rows *CalloutAsideBlocksBlockAllLocales) Retain() (CalloutAsideBlocksBlockUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*CalloutAsideBlocksBlockAllLocales) UnmarshalJSON 

func (rows *CalloutAsideBlocksBlockAllLocales) UnmarshalJSON(data []byte) error

type CalloutAsideBlocksBlockAllLocalesBlock 

type CalloutAsideBlocksBlockAllLocalesBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

CalloutAsideBlocksBlockAllLocalesBlock admits only generated block pointers; decoding returns those same pointer types.

type CalloutAsideBlocksBlockAllLocalesPayload 

type CalloutAsideBlocksBlockAllLocalesPayload struct {
	Value CalloutAsideBlocksBlockAllLocalesBlock
}

CalloutAsideBlocksBlockAllLocalesPayload is one typed detached payload, with scalar JSON encoding.

func (CalloutAsideBlocksBlockAllLocalesPayload) MarshalJSON 

func (p CalloutAsideBlocksBlockAllLocalesPayload) MarshalJSON() ([]byte, error)

func (CalloutAsideBlocksBlockAllLocalesPayload) Retain 

func (payload CalloutAsideBlocksBlockAllLocalesPayload) Retain() (CalloutAsideBlocksBlockUpdatePayload, error)

Retain creates a key-only update for this embedded occurrence, without copying redacted, localized or populated authored fields. Use revision checks when saving.

func (*CalloutAsideBlocksBlockAllLocalesPayload) UnmarshalJSON 

func (p *CalloutAsideBlocksBlockAllLocalesPayload) UnmarshalJSON(data []byte) error

type CalloutAsideBlocksBlockAllLocalesValue 

type CalloutAsideBlocksBlockAllLocalesValue []CalloutAsideBlocksBlockAllLocalesValueBlock

CalloutAsideBlocksBlockAllLocalesValue is an ordered list of block pointers. Nil rows are invalid. This is one locale's value beneath a localized container in an all-locales response. Children are ordinary values; populated target documents still have all-locales shapes.

func (CalloutAsideBlocksBlockAllLocalesValue) MarshalJSON 

func (rows CalloutAsideBlocksBlockAllLocalesValue) MarshalJSON() ([]byte, error)

func (*CalloutAsideBlocksBlockAllLocalesValue) Retain 

func (rows *CalloutAsideBlocksBlockAllLocalesValue) Retain() (CalloutAsideBlocksBlockUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*CalloutAsideBlocksBlockAllLocalesValue) UnmarshalJSON 

func (rows *CalloutAsideBlocksBlockAllLocalesValue) UnmarshalJSON(data []byte) error

type CalloutAsideBlocksBlockAllLocalesValueBlock 

type CalloutAsideBlocksBlockAllLocalesValueBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

CalloutAsideBlocksBlockAllLocalesValueBlock admits only generated block pointers; decoding returns those same pointer types.

type CalloutAsideBlocksBlockAllLocalesValuePayload 

type CalloutAsideBlocksBlockAllLocalesValuePayload struct {
	Value CalloutAsideBlocksBlockAllLocalesValueBlock
}

CalloutAsideBlocksBlockAllLocalesValuePayload is one typed detached payload, with scalar JSON encoding.

func (CalloutAsideBlocksBlockAllLocalesValuePayload) MarshalJSON 

func (p CalloutAsideBlocksBlockAllLocalesValuePayload) MarshalJSON() ([]byte, error)

func (CalloutAsideBlocksBlockAllLocalesValuePayload) Retain 

func (payload CalloutAsideBlocksBlockAllLocalesValuePayload) Retain() (CalloutAsideBlocksBlockUpdatePayload, error)

Retain creates a key-only update for this embedded occurrence, without copying redacted, localized or populated authored fields. Use revision checks when saving.

func (*CalloutAsideBlocksBlockAllLocalesValuePayload) UnmarshalJSON 

func (p *CalloutAsideBlocksBlockAllLocalesValuePayload) UnmarshalJSON(data []byte) error

type CalloutAsideBlocksBlockBlock 

type CalloutAsideBlocksBlockBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

CalloutAsideBlocksBlockBlock admits only generated block pointers; decoding returns those same pointer types.

type CalloutAsideBlocksBlockInput 

type CalloutAsideBlocksBlockInput []CalloutAsideBlocksBlockInputBlock

CalloutAsideBlocksBlockInput is an ordered list of block pointers. Nil rows are invalid.

func (CalloutAsideBlocksBlockInput) MarshalJSON 

func (rows CalloutAsideBlocksBlockInput) MarshalJSON() ([]byte, error)

func (*CalloutAsideBlocksBlockInput) UnmarshalJSON 

func (rows *CalloutAsideBlocksBlockInput) UnmarshalJSON(data []byte) error

type CalloutAsideBlocksBlockInputBlock 

type CalloutAsideBlocksBlockInputBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

CalloutAsideBlocksBlockInputBlock admits only generated block pointers; decoding returns those same pointer types.

type CalloutAsideBlocksBlockInputPayload 

type CalloutAsideBlocksBlockInputPayload struct {
	Value CalloutAsideBlocksBlockInputBlock
}

CalloutAsideBlocksBlockInputPayload is one typed detached payload, with scalar JSON encoding.

func (CalloutAsideBlocksBlockInputPayload) MarshalJSON 

func (p CalloutAsideBlocksBlockInputPayload) MarshalJSON() ([]byte, error)

func (*CalloutAsideBlocksBlockInputPayload) UnmarshalJSON 

func (p *CalloutAsideBlocksBlockInputPayload) UnmarshalJSON(data []byte) error

type CalloutAsideBlocksBlockPayload 

type CalloutAsideBlocksBlockPayload struct{ Value CalloutAsideBlocksBlockBlock }

CalloutAsideBlocksBlockPayload is one typed detached payload, with scalar JSON encoding.

func (CalloutAsideBlocksBlockPayload) MarshalJSON 

func (p CalloutAsideBlocksBlockPayload) MarshalJSON() ([]byte, error)

func (CalloutAsideBlocksBlockPayload) Retain 

func (payload CalloutAsideBlocksBlockPayload) Retain() (CalloutAsideBlocksBlockUpdatePayload, error)

Retain creates a key-only update for this embedded occurrence, without copying redacted, localized or populated authored fields. Use revision checks when saving.

func (*CalloutAsideBlocksBlockPayload) UnmarshalJSON 

func (p *CalloutAsideBlocksBlockPayload) UnmarshalJSON(data []byte) error

type CalloutAsideBlocksBlockUpdate 

type CalloutAsideBlocksBlockUpdate []CalloutAsideBlocksBlockUpdateBlock

CalloutAsideBlocksBlockUpdate is an ordered list of block pointers. Nil rows are invalid. Saving this list replaces order and membership: omitted occurrences are removed. Start with a read list's Retain method to preserve untouched blocks.

func (CalloutAsideBlocksBlockUpdate) MarshalJSON 

func (rows CalloutAsideBlocksBlockUpdate) MarshalJSON() ([]byte, error)

func (*CalloutAsideBlocksBlockUpdate) UnmarshalJSON 

func (rows *CalloutAsideBlocksBlockUpdate) UnmarshalJSON(data []byte) error

type CalloutAsideBlocksBlockUpdateBlock 

type CalloutAsideBlocksBlockUpdateBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

CalloutAsideBlocksBlockUpdateBlock admits only generated block pointers; decoding returns those same pointer types. Use keyed Update pointers for existing occurrences and Input pointers for new occurrences.

type CalloutAsideBlocksBlockUpdatePayload 

type CalloutAsideBlocksBlockUpdatePayload struct {
	Value CalloutAsideBlocksBlockUpdateBlock
}

CalloutAsideBlocksBlockUpdatePayload is one typed detached payload, with scalar JSON encoding.

func (CalloutAsideBlocksBlockUpdatePayload) MarshalJSON 

func (p CalloutAsideBlocksBlockUpdatePayload) MarshalJSON() ([]byte, error)

func (*CalloutAsideBlocksBlockUpdatePayload) UnmarshalJSON 

func (p *CalloutAsideBlocksBlockUpdatePayload) UnmarshalJSON(data []byte) error

type CalloutDetailBlocksBlock 

type CalloutDetailBlocksBlock []CalloutDetailBlocksBlockBlock

CalloutDetailBlocksBlock is an ordered list of block pointers. Nil rows are invalid.

func (CalloutDetailBlocksBlock) MarshalJSON 

func (rows CalloutDetailBlocksBlock) MarshalJSON() ([]byte, error)

func (*CalloutDetailBlocksBlock) Retain 

func (rows *CalloutDetailBlocksBlock) Retain() (CalloutDetailBlocksBlockUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*CalloutDetailBlocksBlock) UnmarshalJSON 

func (rows *CalloutDetailBlocksBlock) UnmarshalJSON(data []byte) error

type CalloutDetailBlocksBlockAllLocales 

type CalloutDetailBlocksBlockAllLocales []CalloutDetailBlocksBlockAllLocalesBlock

CalloutDetailBlocksBlockAllLocales is an ordered list of block pointers. Nil rows are invalid. Localized children contain locale-code maps; use ordinary output types for a single locale.

func (CalloutDetailBlocksBlockAllLocales) MarshalJSON 

func (rows CalloutDetailBlocksBlockAllLocales) MarshalJSON() ([]byte, error)

func (*CalloutDetailBlocksBlockAllLocales) Retain 

func (rows *CalloutDetailBlocksBlockAllLocales) Retain() (CalloutDetailBlocksBlockUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*CalloutDetailBlocksBlockAllLocales) UnmarshalJSON 

func (rows *CalloutDetailBlocksBlockAllLocales) UnmarshalJSON(data []byte) error

type CalloutDetailBlocksBlockAllLocalesBlock 

type CalloutDetailBlocksBlockAllLocalesBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

CalloutDetailBlocksBlockAllLocalesBlock admits only generated block pointers; decoding returns those same pointer types.

type CalloutDetailBlocksBlockAllLocalesPayload 

type CalloutDetailBlocksBlockAllLocalesPayload struct {
	Value CalloutDetailBlocksBlockAllLocalesBlock
}

CalloutDetailBlocksBlockAllLocalesPayload is one typed detached payload, with scalar JSON encoding.

func (CalloutDetailBlocksBlockAllLocalesPayload) MarshalJSON 

func (p CalloutDetailBlocksBlockAllLocalesPayload) MarshalJSON() ([]byte, error)

func (CalloutDetailBlocksBlockAllLocalesPayload) Retain 

func (payload CalloutDetailBlocksBlockAllLocalesPayload) Retain() (CalloutDetailBlocksBlockUpdatePayload, error)

Retain creates a key-only update for this embedded occurrence, without copying redacted, localized or populated authored fields. Use revision checks when saving.

func (*CalloutDetailBlocksBlockAllLocalesPayload) UnmarshalJSON 

func (p *CalloutDetailBlocksBlockAllLocalesPayload) UnmarshalJSON(data []byte) error

type CalloutDetailBlocksBlockAllLocalesValue 

type CalloutDetailBlocksBlockAllLocalesValue []CalloutDetailBlocksBlockAllLocalesValueBlock

CalloutDetailBlocksBlockAllLocalesValue is an ordered list of block pointers. Nil rows are invalid. This is one locale's value beneath a localized container in an all-locales response. Children are ordinary values; populated target documents still have all-locales shapes.

func (CalloutDetailBlocksBlockAllLocalesValue) MarshalJSON 

func (rows CalloutDetailBlocksBlockAllLocalesValue) MarshalJSON() ([]byte, error)

func (*CalloutDetailBlocksBlockAllLocalesValue) Retain 

func (rows *CalloutDetailBlocksBlockAllLocalesValue) Retain() (CalloutDetailBlocksBlockUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*CalloutDetailBlocksBlockAllLocalesValue) UnmarshalJSON 

func (rows *CalloutDetailBlocksBlockAllLocalesValue) UnmarshalJSON(data []byte) error

type CalloutDetailBlocksBlockAllLocalesValueBlock 

type CalloutDetailBlocksBlockAllLocalesValueBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

CalloutDetailBlocksBlockAllLocalesValueBlock admits only generated block pointers; decoding returns those same pointer types.

type CalloutDetailBlocksBlockAllLocalesValuePayload 

type CalloutDetailBlocksBlockAllLocalesValuePayload struct {
	Value CalloutDetailBlocksBlockAllLocalesValueBlock
}

CalloutDetailBlocksBlockAllLocalesValuePayload is one typed detached payload, with scalar JSON encoding.

func (CalloutDetailBlocksBlockAllLocalesValuePayload) MarshalJSON 

func (p CalloutDetailBlocksBlockAllLocalesValuePayload) MarshalJSON() ([]byte, error)

func (CalloutDetailBlocksBlockAllLocalesValuePayload) Retain 

func (payload CalloutDetailBlocksBlockAllLocalesValuePayload) Retain() (CalloutDetailBlocksBlockUpdatePayload, error)

Retain creates a key-only update for this embedded occurrence, without copying redacted, localized or populated authored fields. Use revision checks when saving.

func (*CalloutDetailBlocksBlockAllLocalesValuePayload) UnmarshalJSON 

func (p *CalloutDetailBlocksBlockAllLocalesValuePayload) UnmarshalJSON(data []byte) error

type CalloutDetailBlocksBlockBlock 

type CalloutDetailBlocksBlockBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

CalloutDetailBlocksBlockBlock admits only generated block pointers; decoding returns those same pointer types.

type CalloutDetailBlocksBlockInput 

type CalloutDetailBlocksBlockInput []CalloutDetailBlocksBlockInputBlock

CalloutDetailBlocksBlockInput is an ordered list of block pointers. Nil rows are invalid.

func (CalloutDetailBlocksBlockInput) MarshalJSON 

func (rows CalloutDetailBlocksBlockInput) MarshalJSON() ([]byte, error)

func (*CalloutDetailBlocksBlockInput) UnmarshalJSON 

func (rows *CalloutDetailBlocksBlockInput) UnmarshalJSON(data []byte) error

type CalloutDetailBlocksBlockInputBlock 

type CalloutDetailBlocksBlockInputBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

CalloutDetailBlocksBlockInputBlock admits only generated block pointers; decoding returns those same pointer types.

type CalloutDetailBlocksBlockInputPayload 

type CalloutDetailBlocksBlockInputPayload struct {
	Value CalloutDetailBlocksBlockInputBlock
}

CalloutDetailBlocksBlockInputPayload is one typed detached payload, with scalar JSON encoding.

func (CalloutDetailBlocksBlockInputPayload) MarshalJSON 

func (p CalloutDetailBlocksBlockInputPayload) MarshalJSON() ([]byte, error)

func (*CalloutDetailBlocksBlockInputPayload) UnmarshalJSON 

func (p *CalloutDetailBlocksBlockInputPayload) UnmarshalJSON(data []byte) error

type CalloutDetailBlocksBlockPayload 

type CalloutDetailBlocksBlockPayload struct{ Value CalloutDetailBlocksBlockBlock }

CalloutDetailBlocksBlockPayload is one typed detached payload, with scalar JSON encoding.

func (CalloutDetailBlocksBlockPayload) MarshalJSON 

func (p CalloutDetailBlocksBlockPayload) MarshalJSON() ([]byte, error)

func (CalloutDetailBlocksBlockPayload) Retain 

func (payload CalloutDetailBlocksBlockPayload) Retain() (CalloutDetailBlocksBlockUpdatePayload, error)

Retain creates a key-only update for this embedded occurrence, without copying redacted, localized or populated authored fields. Use revision checks when saving.

func (*CalloutDetailBlocksBlockPayload) UnmarshalJSON 

func (p *CalloutDetailBlocksBlockPayload) UnmarshalJSON(data []byte) error

type CalloutDetailBlocksBlockUpdate 

type CalloutDetailBlocksBlockUpdate []CalloutDetailBlocksBlockUpdateBlock

CalloutDetailBlocksBlockUpdate is an ordered list of block pointers. Nil rows are invalid. Saving this list replaces order and membership: omitted occurrences are removed. Start with a read list's Retain method to preserve untouched blocks.

func (CalloutDetailBlocksBlockUpdate) MarshalJSON 

func (rows CalloutDetailBlocksBlockUpdate) MarshalJSON() ([]byte, error)

func (*CalloutDetailBlocksBlockUpdate) UnmarshalJSON 

func (rows *CalloutDetailBlocksBlockUpdate) UnmarshalJSON(data []byte) error

type CalloutDetailBlocksBlockUpdateBlock 

type CalloutDetailBlocksBlockUpdateBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

CalloutDetailBlocksBlockUpdateBlock admits only generated block pointers; decoding returns those same pointer types. Use keyed Update pointers for existing occurrences and Input pointers for new occurrences.

type CalloutDetailBlocksBlockUpdatePayload 

type CalloutDetailBlocksBlockUpdatePayload struct {
	Value CalloutDetailBlocksBlockUpdateBlock
}

CalloutDetailBlocksBlockUpdatePayload is one typed detached payload, with scalar JSON encoding.

func (CalloutDetailBlocksBlockUpdatePayload) MarshalJSON 

func (p CalloutDetailBlocksBlockUpdatePayload) MarshalJSON() ([]byte, error)

func (*CalloutDetailBlocksBlockUpdatePayload) UnmarshalJSON 

func (p *CalloutDetailBlocksBlockUpdatePayload) UnmarshalJSON(data []byte) error

type CalloutInput 

type CalloutInput struct {
	// Key identifies this occurrence; omit it for a new server-assigned identity.
	Key string `json:"_key,omitempty"`
	// BlockName: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	BlockName *core.Input[string] `json:"blockName,omitempty"`
	// Title is required when creating this value.
	Title string `json:"title"`
	// Message: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Message *core.Input[string] `json:"message,omitempty"`
	// Detail: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Detail *core.Input[richtext.Document[CalloutDetailBlocksBlockInputPayload]] `json:"detail,omitempty"`
	// Aside: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Aside *core.Input[richtext.Document[CalloutAsideBlocksBlockInputPayload]] `json:"aside,omitempty"`
}

CalloutInput is a generated block. Use *CalloutInput in block lists and type switches. Input supplies a new occurrence's required fields. An empty Key requests a server-assigned key. Read this block as Callout; edit an existing occurrence with CalloutUpdate.

func (*CalloutInput) BlockKey 

func (value *CalloutInput) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*CalloutInput) BlockType 

func (*CalloutInput) BlockType() string

BlockType returns the immutable stored discriminator.

func (CalloutInput) MarshalJSON 

func (value CalloutInput) MarshalJSON() ([]byte, error)

func (*CalloutInput) UnmarshalJSON 

func (value *CalloutInput) UnmarshalJSON(data []byte) error

type CalloutUpdate 

type CalloutUpdate struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// BlockName: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	BlockName *core.Input[string] `json:"blockName,omitempty"`
	// Title: nil omits the field; a pointer sends a value. Null is not allowed.
	Title *string `json:"title,omitempty"`
	// Message: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Message *core.Input[string] `json:"message,omitempty"`
	// Detail: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Detail *core.Input[richtext.Document[CalloutDetailBlocksBlockUpdatePayload]] `json:"detail,omitempty"`
	// Aside: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Aside *core.Input[richtext.Document[CalloutAsideBlocksBlockUpdatePayload]] `json:"aside,omitempty"`
}

CalloutUpdate is a generated block. Use *CalloutUpdate in block lists and type switches. Update retains an existing occurrence by Key. Omitted children remain unchanged. The engine verifies that the key belongs to an existing occurrence of this variant. Start with the read list's Retain method; use CalloutInput for additions.

func (*CalloutUpdate) BlockKey 

func (value *CalloutUpdate) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*CalloutUpdate) BlockType 

func (*CalloutUpdate) BlockType() string

BlockType returns the immutable stored discriminator.

func (CalloutUpdate) MarshalJSON 

func (value CalloutUpdate) MarshalJSON() ([]byte, error)

func (*CalloutUpdate) UnmarshalJSON 

func (value *CalloutUpdate) UnmarshalJSON(data []byte) error

type Campaign 

type Campaign struct {
	ID        string `json:"id"`
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt"`
	// Title may be omitted by access rules or projection.
	Title *string `json:"title,omitempty"`
	// Layout may be omitted by access rules or projection.
	Layout *CampaignsLayout `json:"layout,omitempty"`
}

Campaign is a single-locale read. Authored fields can be omitted by access rules or projection.

func (*Campaign) UnmarshalJSON 

func (value *Campaign) UnmarshalJSON(data []byte) error

type CampaignAllLocales 

type CampaignAllLocales struct {
	ID        string `json:"id"`
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt"`
	// Title may be omitted by access rules or projection.
	Title *string `json:"title,omitempty"`
	// Layout may be omitted by access rules or projection.
	Layout *CampaignsLayoutAllLocales `json:"layout,omitempty"`
}

CampaignAllLocales is an all-locales read: localized fields contain locale-code maps.

func (*CampaignAllLocales) UnmarshalJSON 

func (value *CampaignAllLocales) UnmarshalJSON(data []byte) error

type CampaignCreate 

type CampaignCreate struct {
	// Title: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Title *core.Input[string] `json:"title,omitempty"`
	// Layout: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Layout *core.Input[CampaignsLayoutInput] `json:"layout,omitempty"`
}

CampaignCreate supplies a new document. Required values are concrete; defaulted values may be omitted, and nullable values use core.Set or core.Null.

func (*CampaignCreate) UnmarshalJSON 

func (value *CampaignCreate) UnmarshalJSON(data []byte) error

type CampaignUpdate 

type CampaignUpdate struct {
	// Title: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Title *core.Input[string] `json:"title,omitempty"`
	// Layout: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	// A supplied list replaces order and membership; use the read list's Retain method to preserve untouched blocks.
	Layout *core.Input[CampaignsLayoutUpdate] `json:"layout,omitempty"`
}

CampaignUpdate edits a document. Nil fields are unchanged; supplied block lists replace order and membership.

func (*CampaignUpdate) UnmarshalJSON 

func (value *CampaignUpdate) UnmarshalJSON(data []byte) error

type CampaignsLayout 

type CampaignsLayout []CampaignsLayoutBlock

CampaignsLayout is an ordered list of block pointers. Nil rows are invalid.

func (CampaignsLayout) MarshalJSON 

func (rows CampaignsLayout) MarshalJSON() ([]byte, error)

func (*CampaignsLayout) Retain 

func (rows *CampaignsLayout) Retain() (CampaignsLayoutUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*CampaignsLayout) UnmarshalJSON 

func (rows *CampaignsLayout) UnmarshalJSON(data []byte) error

type CampaignsLayoutAllLocales 

type CampaignsLayoutAllLocales []CampaignsLayoutAllLocalesBlock

CampaignsLayoutAllLocales is an ordered list of block pointers. Nil rows are invalid. Localized children contain locale-code maps; use ordinary output types for a single locale.

func (CampaignsLayoutAllLocales) MarshalJSON 

func (rows CampaignsLayoutAllLocales) MarshalJSON() ([]byte, error)

func (*CampaignsLayoutAllLocales) Retain 

func (rows *CampaignsLayoutAllLocales) Retain() (CampaignsLayoutUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*CampaignsLayoutAllLocales) UnmarshalJSON 

func (rows *CampaignsLayoutAllLocales) UnmarshalJSON(data []byte) error

type CampaignsLayoutAllLocalesBlock 

type CampaignsLayoutAllLocalesBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

CampaignsLayoutAllLocalesBlock admits only generated block pointers; decoding returns those same pointer types.

type CampaignsLayoutAllLocalesValue 

type CampaignsLayoutAllLocalesValue []CampaignsLayoutAllLocalesValueBlock

CampaignsLayoutAllLocalesValue is an ordered list of block pointers. Nil rows are invalid. This is one locale's value beneath a localized container in an all-locales response. Children are ordinary values; populated target documents still have all-locales shapes.

func (CampaignsLayoutAllLocalesValue) MarshalJSON 

func (rows CampaignsLayoutAllLocalesValue) MarshalJSON() ([]byte, error)

func (*CampaignsLayoutAllLocalesValue) Retain 

func (rows *CampaignsLayoutAllLocalesValue) Retain() (CampaignsLayoutUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*CampaignsLayoutAllLocalesValue) UnmarshalJSON 

func (rows *CampaignsLayoutAllLocalesValue) UnmarshalJSON(data []byte) error

type CampaignsLayoutAllLocalesValueBlock 

type CampaignsLayoutAllLocalesValueBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

CampaignsLayoutAllLocalesValueBlock admits only generated block pointers; decoding returns those same pointer types.

type CampaignsLayoutBlock 

type CampaignsLayoutBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

CampaignsLayoutBlock admits only generated block pointers; decoding returns those same pointer types.

type CampaignsLayoutInput 

type CampaignsLayoutInput []CampaignsLayoutInputBlock

CampaignsLayoutInput is an ordered list of block pointers. Nil rows are invalid.

func (CampaignsLayoutInput) MarshalJSON 

func (rows CampaignsLayoutInput) MarshalJSON() ([]byte, error)

func (*CampaignsLayoutInput) UnmarshalJSON 

func (rows *CampaignsLayoutInput) UnmarshalJSON(data []byte) error

type CampaignsLayoutInputBlock 

type CampaignsLayoutInputBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

CampaignsLayoutInputBlock admits only generated block pointers; decoding returns those same pointer types.

type CampaignsLayoutUpdate 

type CampaignsLayoutUpdate []CampaignsLayoutUpdateBlock

CampaignsLayoutUpdate is an ordered list of block pointers. Nil rows are invalid. Saving this list replaces order and membership: omitted occurrences are removed. Start with a read list's Retain method to preserve untouched blocks.

func (CampaignsLayoutUpdate) MarshalJSON 

func (rows CampaignsLayoutUpdate) MarshalJSON() ([]byte, error)

func (*CampaignsLayoutUpdate) UnmarshalJSON 

func (rows *CampaignsLayoutUpdate) UnmarshalJSON(data []byte) error

type CampaignsLayoutUpdateBlock 

type CampaignsLayoutUpdateBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

CampaignsLayoutUpdateBlock admits only generated block pointers; decoding returns those same pointer types. Use keyed Update pointers for existing occurrences and Input pointers for new occurrences.

type Content 

type Content struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// Title: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Title *BlockOptional[string] `json:"title,omitempty"`
	// Body: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Body *BlockOptional[richtext.Document[ContentBodyBlocksBlockPayload]] `json:"body,omitempty"`
	// Links: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Links *BlockOptional[ContentLinks] `json:"links,omitempty"`
}

Content is a generated block. Use *Content in block lists and type switches. Authored children may be omitted by access rules or projection, even when required on create. Create with ContentInput. To edit, retain the read list and modify its ContentUpdate pointers.

func (*Content) BlockKey 

func (value *Content) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*Content) BlockType 

func (*Content) BlockType() string

BlockType returns the immutable stored discriminator.

func (Content) MarshalJSON 

func (value Content) MarshalJSON() ([]byte, error)

func (*Content) UnmarshalJSON 

func (value *Content) UnmarshalJSON(data []byte) error

type ContentAllLocales 

type ContentAllLocales struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// Title: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	// Locale-code map; missing locales are absent translations.
	Title *BlockOptional[map[string]*string] `json:"title,omitempty"`
	// Body: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Body *BlockOptional[richtext.Document[ContentBodyBlocksBlockAllLocalesPayload]] `json:"body,omitempty"`
	// Links: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Links *BlockOptional[ContentLinksAllLocales] `json:"links,omitempty"`
}

ContentAllLocales is a generated block. Use *ContentAllLocales in block lists and type switches. Authored children may be omitted by access rules or projection, even when required on create.

func (*ContentAllLocales) BlockKey 

func (value *ContentAllLocales) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*ContentAllLocales) BlockType 

func (*ContentAllLocales) BlockType() string

BlockType returns the immutable stored discriminator.

func (ContentAllLocales) MarshalJSON 

func (value ContentAllLocales) MarshalJSON() ([]byte, error)

func (*ContentAllLocales) UnmarshalJSON 

func (value *ContentAllLocales) UnmarshalJSON(data []byte) error

type ContentAllLocalesValue 

type ContentAllLocalesValue struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// Title: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Title *BlockOptional[string] `json:"title,omitempty"`
	// Body: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Body *BlockOptional[richtext.Document[ContentBodyBlocksBlockAllLocalesValuePayload]] `json:"body,omitempty"`
	// Links: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Links *BlockOptional[ContentLinksAllLocalesValue] `json:"links,omitempty"`
}

ContentAllLocalesValue is a generated block. Use *ContentAllLocalesValue in block lists and type switches. Authored children may be omitted by access rules or projection, even when required on create.

func (*ContentAllLocalesValue) BlockKey 

func (value *ContentAllLocalesValue) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*ContentAllLocalesValue) BlockType 

func (*ContentAllLocalesValue) BlockType() string

BlockType returns the immutable stored discriminator.

func (ContentAllLocalesValue) MarshalJSON 

func (value ContentAllLocalesValue) MarshalJSON() ([]byte, error)

func (*ContentAllLocalesValue) UnmarshalJSON 

func (value *ContentAllLocalesValue) UnmarshalJSON(data []byte) error

type ContentBodyBlocksBlock 

type ContentBodyBlocksBlock []ContentBodyBlocksBlockBlock

ContentBodyBlocksBlock is an ordered list of block pointers. Nil rows are invalid.

func (ContentBodyBlocksBlock) MarshalJSON 

func (rows ContentBodyBlocksBlock) MarshalJSON() ([]byte, error)

func (*ContentBodyBlocksBlock) Retain 

func (rows *ContentBodyBlocksBlock) Retain() (ContentBodyBlocksBlockUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*ContentBodyBlocksBlock) UnmarshalJSON 

func (rows *ContentBodyBlocksBlock) UnmarshalJSON(data []byte) error

type ContentBodyBlocksBlockAllLocales 

type ContentBodyBlocksBlockAllLocales []ContentBodyBlocksBlockAllLocalesBlock

ContentBodyBlocksBlockAllLocales is an ordered list of block pointers. Nil rows are invalid. Localized children contain locale-code maps; use ordinary output types for a single locale.

func (ContentBodyBlocksBlockAllLocales) MarshalJSON 

func (rows ContentBodyBlocksBlockAllLocales) MarshalJSON() ([]byte, error)

func (*ContentBodyBlocksBlockAllLocales) Retain 

func (rows *ContentBodyBlocksBlockAllLocales) Retain() (ContentBodyBlocksBlockUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*ContentBodyBlocksBlockAllLocales) UnmarshalJSON 

func (rows *ContentBodyBlocksBlockAllLocales) UnmarshalJSON(data []byte) error

type ContentBodyBlocksBlockAllLocalesBlock 

type ContentBodyBlocksBlockAllLocalesBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

ContentBodyBlocksBlockAllLocalesBlock admits only generated block pointers; decoding returns those same pointer types.

type ContentBodyBlocksBlockAllLocalesPayload 

type ContentBodyBlocksBlockAllLocalesPayload struct {
	Value ContentBodyBlocksBlockAllLocalesBlock
}

ContentBodyBlocksBlockAllLocalesPayload is one typed detached payload, with scalar JSON encoding.

func (ContentBodyBlocksBlockAllLocalesPayload) MarshalJSON 

func (p ContentBodyBlocksBlockAllLocalesPayload) MarshalJSON() ([]byte, error)

func (ContentBodyBlocksBlockAllLocalesPayload) Retain 

func (payload ContentBodyBlocksBlockAllLocalesPayload) Retain() (ContentBodyBlocksBlockUpdatePayload, error)

Retain creates a key-only update for this embedded occurrence, without copying redacted, localized or populated authored fields. Use revision checks when saving.

func (*ContentBodyBlocksBlockAllLocalesPayload) UnmarshalJSON 

func (p *ContentBodyBlocksBlockAllLocalesPayload) UnmarshalJSON(data []byte) error

type ContentBodyBlocksBlockAllLocalesValue 

type ContentBodyBlocksBlockAllLocalesValue []ContentBodyBlocksBlockAllLocalesValueBlock

ContentBodyBlocksBlockAllLocalesValue is an ordered list of block pointers. Nil rows are invalid. This is one locale's value beneath a localized container in an all-locales response. Children are ordinary values; populated target documents still have all-locales shapes.

func (ContentBodyBlocksBlockAllLocalesValue) MarshalJSON 

func (rows ContentBodyBlocksBlockAllLocalesValue) MarshalJSON() ([]byte, error)

func (*ContentBodyBlocksBlockAllLocalesValue) Retain 

func (rows *ContentBodyBlocksBlockAllLocalesValue) Retain() (ContentBodyBlocksBlockUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*ContentBodyBlocksBlockAllLocalesValue) UnmarshalJSON 

func (rows *ContentBodyBlocksBlockAllLocalesValue) UnmarshalJSON(data []byte) error

type ContentBodyBlocksBlockAllLocalesValueBlock 

type ContentBodyBlocksBlockAllLocalesValueBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

ContentBodyBlocksBlockAllLocalesValueBlock admits only generated block pointers; decoding returns those same pointer types.

type ContentBodyBlocksBlockAllLocalesValuePayload 

type ContentBodyBlocksBlockAllLocalesValuePayload struct {
	Value ContentBodyBlocksBlockAllLocalesValueBlock
}

ContentBodyBlocksBlockAllLocalesValuePayload is one typed detached payload, with scalar JSON encoding.

func (ContentBodyBlocksBlockAllLocalesValuePayload) MarshalJSON 

func (p ContentBodyBlocksBlockAllLocalesValuePayload) MarshalJSON() ([]byte, error)

func (ContentBodyBlocksBlockAllLocalesValuePayload) Retain 

func (payload ContentBodyBlocksBlockAllLocalesValuePayload) Retain() (ContentBodyBlocksBlockUpdatePayload, error)

Retain creates a key-only update for this embedded occurrence, without copying redacted, localized or populated authored fields. Use revision checks when saving.

func (*ContentBodyBlocksBlockAllLocalesValuePayload) UnmarshalJSON 

func (p *ContentBodyBlocksBlockAllLocalesValuePayload) UnmarshalJSON(data []byte) error

type ContentBodyBlocksBlockBlock 

type ContentBodyBlocksBlockBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

ContentBodyBlocksBlockBlock admits only generated block pointers; decoding returns those same pointer types.

type ContentBodyBlocksBlockInput 

type ContentBodyBlocksBlockInput []ContentBodyBlocksBlockInputBlock

ContentBodyBlocksBlockInput is an ordered list of block pointers. Nil rows are invalid.

func (ContentBodyBlocksBlockInput) MarshalJSON 

func (rows ContentBodyBlocksBlockInput) MarshalJSON() ([]byte, error)

func (*ContentBodyBlocksBlockInput) UnmarshalJSON 

func (rows *ContentBodyBlocksBlockInput) UnmarshalJSON(data []byte) error

type ContentBodyBlocksBlockInputBlock 

type ContentBodyBlocksBlockInputBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

ContentBodyBlocksBlockInputBlock admits only generated block pointers; decoding returns those same pointer types.

type ContentBodyBlocksBlockInputPayload 

type ContentBodyBlocksBlockInputPayload struct {
	Value ContentBodyBlocksBlockInputBlock
}

ContentBodyBlocksBlockInputPayload is one typed detached payload, with scalar JSON encoding.

func (ContentBodyBlocksBlockInputPayload) MarshalJSON 

func (p ContentBodyBlocksBlockInputPayload) MarshalJSON() ([]byte, error)

func (*ContentBodyBlocksBlockInputPayload) UnmarshalJSON 

func (p *ContentBodyBlocksBlockInputPayload) UnmarshalJSON(data []byte) error

type ContentBodyBlocksBlockPayload 

type ContentBodyBlocksBlockPayload struct{ Value ContentBodyBlocksBlockBlock }

ContentBodyBlocksBlockPayload is one typed detached payload, with scalar JSON encoding.

func (ContentBodyBlocksBlockPayload) MarshalJSON 

func (p ContentBodyBlocksBlockPayload) MarshalJSON() ([]byte, error)

func (ContentBodyBlocksBlockPayload) Retain 

func (payload ContentBodyBlocksBlockPayload) Retain() (ContentBodyBlocksBlockUpdatePayload, error)

Retain creates a key-only update for this embedded occurrence, without copying redacted, localized or populated authored fields. Use revision checks when saving.

func (*ContentBodyBlocksBlockPayload) UnmarshalJSON 

func (p *ContentBodyBlocksBlockPayload) UnmarshalJSON(data []byte) error

type ContentBodyBlocksBlockUpdate 

type ContentBodyBlocksBlockUpdate []ContentBodyBlocksBlockUpdateBlock

ContentBodyBlocksBlockUpdate is an ordered list of block pointers. Nil rows are invalid. Saving this list replaces order and membership: omitted occurrences are removed. Start with a read list's Retain method to preserve untouched blocks.

func (ContentBodyBlocksBlockUpdate) MarshalJSON 

func (rows ContentBodyBlocksBlockUpdate) MarshalJSON() ([]byte, error)

func (*ContentBodyBlocksBlockUpdate) UnmarshalJSON 

func (rows *ContentBodyBlocksBlockUpdate) UnmarshalJSON(data []byte) error

type ContentBodyBlocksBlockUpdateBlock 

type ContentBodyBlocksBlockUpdateBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

ContentBodyBlocksBlockUpdateBlock admits only generated block pointers; decoding returns those same pointer types. Use keyed Update pointers for existing occurrences and Input pointers for new occurrences.

type ContentBodyBlocksBlockUpdatePayload 

type ContentBodyBlocksBlockUpdatePayload struct {
	Value ContentBodyBlocksBlockUpdateBlock
}

ContentBodyBlocksBlockUpdatePayload is one typed detached payload, with scalar JSON encoding.

func (ContentBodyBlocksBlockUpdatePayload) MarshalJSON 

func (p ContentBodyBlocksBlockUpdatePayload) MarshalJSON() ([]byte, error)

func (*ContentBodyBlocksBlockUpdatePayload) UnmarshalJSON 

func (p *ContentBodyBlocksBlockUpdatePayload) UnmarshalJSON(data []byte) error

type ContentInput 

type ContentInput struct {
	// Key identifies this occurrence; omit it for a new server-assigned identity.
	Key string `json:"_key,omitempty"`
	// Title: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Title *core.Input[string] `json:"title,omitempty"`
	// Body: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Body *core.Input[richtext.Document[ContentBodyBlocksBlockInputPayload]] `json:"body,omitempty"`
	// Links: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Links *core.Input[[]ContentLinksRowInput] `json:"links,omitempty"`
}

ContentInput is a generated block. Use *ContentInput in block lists and type switches. Input supplies a new occurrence's required fields. An empty Key requests a server-assigned key. Read this block as Content; edit an existing occurrence with ContentUpdate.

func (*ContentInput) BlockKey 

func (value *ContentInput) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*ContentInput) BlockType 

func (*ContentInput) BlockType() string

BlockType returns the immutable stored discriminator.

func (ContentInput) MarshalJSON 

func (value ContentInput) MarshalJSON() ([]byte, error)

func (*ContentInput) UnmarshalJSON 

func (value *ContentInput) UnmarshalJSON(data []byte) error
type ContentLinks []ContentLinksRow

ContentLinks contains concrete array rows. Use Retain before editing existing rows.

func (ContentLinks) MarshalJSON 

func (rows ContentLinks) MarshalJSON() ([]byte, error)

func (ContentLinks) Retain 

func (rows ContentLinks) Retain() (ContentLinksUpdate, error)

Retain creates fresh key-only update pointers in the same order. It copies no authored fields. Edit the pointers, append new input pointers, or explicitly remove/reorder rows. Save with a revision check. Nil lists, empty keys and duplicate keys fail without returning a partial list. An explicitly empty list produces an empty update list.

func (*ContentLinks) UnmarshalJSON 

func (rows *ContentLinks) UnmarshalJSON(data []byte) error

type ContentLinksAllLocales 

type ContentLinksAllLocales []ContentLinksRowAllLocales

ContentLinksAllLocales contains concrete array rows. Use Retain before editing existing rows.

func (ContentLinksAllLocales) MarshalJSON 

func (rows ContentLinksAllLocales) MarshalJSON() ([]byte, error)

func (ContentLinksAllLocales) Retain 

func (rows ContentLinksAllLocales) Retain() (ContentLinksUpdate, error)

Retain creates fresh key-only update pointers in the same order. It copies no authored fields. Edit the pointers, append new input pointers, or explicitly remove/reorder rows. Save with a revision check. Nil lists, empty keys and duplicate keys fail without returning a partial list. An explicitly empty list produces an empty update list.

func (*ContentLinksAllLocales) UnmarshalJSON 

func (rows *ContentLinksAllLocales) UnmarshalJSON(data []byte) error

type ContentLinksAllLocalesValue 

type ContentLinksAllLocalesValue []ContentLinksRowAllLocalesValue

ContentLinksAllLocalesValue contains concrete array rows. Use Retain before editing existing rows.

func (ContentLinksAllLocalesValue) MarshalJSON 

func (rows ContentLinksAllLocalesValue) MarshalJSON() ([]byte, error)

func (ContentLinksAllLocalesValue) Retain 

func (rows ContentLinksAllLocalesValue) Retain() (ContentLinksUpdate, error)

Retain creates fresh key-only update pointers in the same order. It copies no authored fields. Edit the pointers, append new input pointers, or explicitly remove/reorder rows. Save with a revision check. Nil lists, empty keys and duplicate keys fail without returning a partial list. An explicitly empty list produces an empty update list.

func (*ContentLinksAllLocalesValue) UnmarshalJSON 

func (rows *ContentLinksAllLocalesValue) UnmarshalJSON(data []byte) error

type ContentLinksRow 

type ContentLinksRow struct {
	Key string `json:"_key"`
	// Label may be omitted by access rules or projection.
	Label *string `json:"label,omitempty"`
	// Href may be omitted by access rules or projection.
	Href *string `json:"href,omitempty"`
}

func (ContentLinksRow) MarshalJSON 

func (value ContentLinksRow) MarshalJSON() ([]byte, error)

func (*ContentLinksRow) RowKey 

func (value *ContentLinksRow) RowKey() string

RowKey returns the occurrence identity, or an empty string for a nil or unkeyed row.

func (*ContentLinksRow) UnmarshalJSON 

func (value *ContentLinksRow) UnmarshalJSON(data []byte) error

type ContentLinksRowAllLocales 

type ContentLinksRowAllLocales struct {
	Key string `json:"_key"`
	// Label may be omitted by access rules or projection.
	Label *string `json:"label,omitempty"`
	// Href may be omitted by access rules or projection.
	Href *string `json:"href,omitempty"`
}

func (ContentLinksRowAllLocales) MarshalJSON 

func (value ContentLinksRowAllLocales) MarshalJSON() ([]byte, error)

func (*ContentLinksRowAllLocales) RowKey 

func (value *ContentLinksRowAllLocales) RowKey() string

RowKey returns the occurrence identity, or an empty string for a nil or unkeyed row.

func (*ContentLinksRowAllLocales) UnmarshalJSON 

func (value *ContentLinksRowAllLocales) UnmarshalJSON(data []byte) error

type ContentLinksRowAllLocalesValue 

type ContentLinksRowAllLocalesValue struct {
	Key string `json:"_key"`
	// Label may be omitted by access rules or projection.
	Label *string `json:"label,omitempty"`
	// Href may be omitted by access rules or projection.
	Href *string `json:"href,omitempty"`
}

func (ContentLinksRowAllLocalesValue) MarshalJSON 

func (value ContentLinksRowAllLocalesValue) MarshalJSON() ([]byte, error)

func (*ContentLinksRowAllLocalesValue) RowKey 

func (value *ContentLinksRowAllLocalesValue) RowKey() string

RowKey returns the occurrence identity, or an empty string for a nil or unkeyed row.

func (*ContentLinksRowAllLocalesValue) UnmarshalJSON 

func (value *ContentLinksRowAllLocalesValue) UnmarshalJSON(data []byte) error

type ContentLinksRowInput 

type ContentLinksRowInput struct {
	Key string `json:"_key,omitempty"`
	// Label is required when creating this value.
	Label string `json:"label"`
	// Href is required when creating this value.
	Href string `json:"href"`
}

func (ContentLinksRowInput) MarshalJSON 

func (value ContentLinksRowInput) MarshalJSON() ([]byte, error)

func (*ContentLinksRowInput) RowKey 

func (value *ContentLinksRowInput) RowKey() string

RowKey returns the occurrence identity, or an empty string for a nil or unkeyed row.

func (*ContentLinksRowInput) UnmarshalJSON 

func (value *ContentLinksRowInput) UnmarshalJSON(data []byte) error

type ContentLinksRowUpdate 

type ContentLinksRowUpdate struct {
	Key string `json:"_key,omitempty"`
	// Label: nil omits the field; a pointer sends a value. Null is not allowed.
	Label *string `json:"label,omitempty"`
	// Href: nil omits the field; a pointer sends a value. Null is not allowed.
	Href *string `json:"href,omitempty"`
}

func (ContentLinksRowUpdate) MarshalJSON 

func (value ContentLinksRowUpdate) MarshalJSON() ([]byte, error)

func (*ContentLinksRowUpdate) RowKey 

func (value *ContentLinksRowUpdate) RowKey() string

RowKey returns the occurrence identity, or an empty string for a nil or unkeyed row.

func (*ContentLinksRowUpdate) UnmarshalJSON 

func (value *ContentLinksRowUpdate) UnmarshalJSON(data []byte) error

type ContentLinksUpdate 

type ContentLinksUpdate []ContentLinksUpdateRow

func (ContentLinksUpdate) MarshalJSON 

func (rows ContentLinksUpdate) MarshalJSON() ([]byte, error)

func (*ContentLinksUpdate) UnmarshalJSON 

func (rows *ContentLinksUpdate) UnmarshalJSON(data []byte) error

type ContentLinksUpdateRow 

type ContentLinksUpdateRow interface {
	RowKey() string
	// contains filtered or unexported methods
}

ContentLinksUpdateRow admits new input and retained update pointers. RowKey exposes identity without a type assertion.

type ContentUpdate 

type ContentUpdate struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// Title: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Title *core.Input[string] `json:"title,omitempty"`
	// Body: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Body *core.Input[richtext.Document[ContentBodyBlocksBlockUpdatePayload]] `json:"body,omitempty"`
	// Links: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Links *core.Input[ContentLinksUpdate] `json:"links,omitempty"`
}

ContentUpdate is a generated block. Use *ContentUpdate in block lists and type switches. Update retains an existing occurrence by Key. Omitted children remain unchanged. The engine verifies that the key belongs to an existing occurrence of this variant. Start with the read list's Retain method; use ContentInput for additions.

func (*ContentUpdate) BlockKey 

func (value *ContentUpdate) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*ContentUpdate) BlockType 

func (*ContentUpdate) BlockType() string

BlockType returns the immutable stored discriminator.

func (ContentUpdate) MarshalJSON 

func (value ContentUpdate) MarshalJSON() ([]byte, error)

func (*ContentUpdate) UnmarshalJSON 

func (value *ContentUpdate) UnmarshalJSON(data []byte) error

type ContractError 

type ContractError struct {
	Operation     string
	Container     string
	Path          string
	Discriminator string
	Reason        string
	Err           error
}

ContractError identifies an encode, decode or retain failure without including the document or field payload. Path is relative to Container and includes nested field names and array indexes. Use errors.As to inspect it; Unwrap preserves the underlying JSON or plugin error.

func (*ContractError) Error 

func (err *ContractError) Error() string

func (*ContractError) Unwrap 

func (err *ContractError) Unwrap() error

type Hero 

type Hero struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// Heading may be omitted by access rules or projection.
	Heading *string `json:"heading,omitempty"`
	// Appearance: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Appearance *BlockOptional[HeroAppearance] `json:"appearance,omitempty"`
}

Hero is a generated block. Use *Hero in block lists and type switches. Authored children may be omitted by access rules or projection, even when required on create. Create with HeroInput. To edit, retain the read list and modify its HeroUpdate pointers.

func (*Hero) BlockKey 

func (value *Hero) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*Hero) BlockType 

func (*Hero) BlockType() string

BlockType returns the immutable stored discriminator.

func (Hero) MarshalJSON 

func (value Hero) MarshalJSON() ([]byte, error)

func (*Hero) UnmarshalJSON 

func (value *Hero) UnmarshalJSON(data []byte) error

type HeroAllLocales 

type HeroAllLocales struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// Heading may be omitted by access rules or projection.
	// Locale-code map; missing locales are absent translations.
	Heading *map[string]string `json:"heading,omitempty"`
	// Appearance: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Appearance *BlockOptional[HeroAppearanceAllLocales] `json:"appearance,omitempty"`
}

HeroAllLocales is a generated block. Use *HeroAllLocales in block lists and type switches. Authored children may be omitted by access rules or projection, even when required on create.

func (*HeroAllLocales) BlockKey 

func (value *HeroAllLocales) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*HeroAllLocales) BlockType 

func (*HeroAllLocales) BlockType() string

BlockType returns the immutable stored discriminator.

func (HeroAllLocales) MarshalJSON 

func (value HeroAllLocales) MarshalJSON() ([]byte, error)

func (*HeroAllLocales) UnmarshalJSON 

func (value *HeroAllLocales) UnmarshalJSON(data []byte) error

type HeroAllLocalesValue 

type HeroAllLocalesValue struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// Heading may be omitted by access rules or projection.
	Heading *string `json:"heading,omitempty"`
	// Appearance: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Appearance *BlockOptional[HeroAppearanceAllLocalesValue] `json:"appearance,omitempty"`
}

HeroAllLocalesValue is a generated block. Use *HeroAllLocalesValue in block lists and type switches. Authored children may be omitted by access rules or projection, even when required on create.

func (*HeroAllLocalesValue) BlockKey 

func (value *HeroAllLocalesValue) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*HeroAllLocalesValue) BlockType 

func (*HeroAllLocalesValue) BlockType() string

BlockType returns the immutable stored discriminator.

func (HeroAllLocalesValue) MarshalJSON 

func (value HeroAllLocalesValue) MarshalJSON() ([]byte, error)

func (*HeroAllLocalesValue) UnmarshalJSON 

func (value *HeroAllLocalesValue) UnmarshalJSON(data []byte) error

type HeroAppearance 

type HeroAppearance struct {
	// Tone: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Tone *BlockOptional[HeroAppearanceTone] `json:"tone,omitempty"`
}

func (HeroAppearance) MarshalJSON 

func (value HeroAppearance) MarshalJSON() ([]byte, error)

func (*HeroAppearance) UnmarshalJSON 

func (value *HeroAppearance) UnmarshalJSON(data []byte) error

type HeroAppearanceAllLocales 

type HeroAppearanceAllLocales struct {
	// Tone: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Tone *BlockOptional[HeroAppearanceTone] `json:"tone,omitempty"`
}

func (HeroAppearanceAllLocales) MarshalJSON 

func (value HeroAppearanceAllLocales) MarshalJSON() ([]byte, error)

func (*HeroAppearanceAllLocales) UnmarshalJSON 

func (value *HeroAppearanceAllLocales) UnmarshalJSON(data []byte) error

type HeroAppearanceAllLocalesValue 

type HeroAppearanceAllLocalesValue struct {
	// Tone: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Tone *BlockOptional[HeroAppearanceTone] `json:"tone,omitempty"`
}

func (HeroAppearanceAllLocalesValue) MarshalJSON 

func (value HeroAppearanceAllLocalesValue) MarshalJSON() ([]byte, error)

func (*HeroAppearanceAllLocalesValue) UnmarshalJSON 

func (value *HeroAppearanceAllLocalesValue) UnmarshalJSON(data []byte) error

type HeroAppearanceInput 

type HeroAppearanceInput struct {
	// Tone: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Tone *core.Input[HeroAppearanceTone] `json:"tone,omitempty"`
}

func (HeroAppearanceInput) MarshalJSON 

func (value HeroAppearanceInput) MarshalJSON() ([]byte, error)

func (*HeroAppearanceInput) UnmarshalJSON 

func (value *HeroAppearanceInput) UnmarshalJSON(data []byte) error

type HeroAppearanceTone 

type HeroAppearanceTone string

HeroAppearanceTone is a configured option for tone. The operation engine validates values. 

const HeroAppearanceToneDark HeroAppearanceTone = "dark"

HeroAppearanceToneDark selects "dark". 

const HeroAppearanceToneLight HeroAppearanceTone = "light"

HeroAppearanceToneLight selects "light".

type HeroAppearanceUpdate 

type HeroAppearanceUpdate struct {
	// Tone: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Tone *core.Input[HeroAppearanceTone] `json:"tone,omitempty"`
}

func (HeroAppearanceUpdate) MarshalJSON 

func (value HeroAppearanceUpdate) MarshalJSON() ([]byte, error)

func (*HeroAppearanceUpdate) UnmarshalJSON 

func (value *HeroAppearanceUpdate) UnmarshalJSON(data []byte) error

type HeroInput 

type HeroInput struct {
	// Key identifies this occurrence; omit it for a new server-assigned identity.
	Key string `json:"_key,omitempty"`
	// Heading is required when creating this value.
	Heading string `json:"heading"`
	// Appearance: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Appearance *core.Input[HeroAppearanceInput] `json:"appearance,omitempty"`
}

HeroInput is a generated block. Use *HeroInput in block lists and type switches. Input supplies a new occurrence's required fields. An empty Key requests a server-assigned key. Read this block as Hero; edit an existing occurrence with HeroUpdate.

func (*HeroInput) BlockKey 

func (value *HeroInput) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*HeroInput) BlockType 

func (*HeroInput) BlockType() string

BlockType returns the immutable stored discriminator.

func (HeroInput) MarshalJSON 

func (value HeroInput) MarshalJSON() ([]byte, error)

func (*HeroInput) UnmarshalJSON 

func (value *HeroInput) UnmarshalJSON(data []byte) error

type HeroUpdate 

type HeroUpdate struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// Heading: nil omits the field; a pointer sends a value. Null is not allowed.
	Heading *string `json:"heading,omitempty"`
	// Appearance: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Appearance *core.Input[HeroAppearanceUpdate] `json:"appearance,omitempty"`
}

HeroUpdate is a generated block. Use *HeroUpdate in block lists and type switches. Update retains an existing occurrence by Key. Omitted children remain unchanged. The engine verifies that the key belongs to an existing occurrence of this variant. Start with the read list's Retain method; use HeroInput for additions.

func (*HeroUpdate) BlockKey 

func (value *HeroUpdate) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*HeroUpdate) BlockType 

func (*HeroUpdate) BlockType() string

BlockType returns the immutable stored discriminator.

func (HeroUpdate) MarshalJSON 

func (value HeroUpdate) MarshalJSON() ([]byte, error)

func (*HeroUpdate) UnmarshalJSON 

func (value *HeroUpdate) UnmarshalJSON(data []byte) error

type Media 

type Media struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// Asset may be omitted by access rules or projection.
	Asset *Reference[Asset] `json:"asset,omitempty"`
	// Caption: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Caption *BlockOptional[string] `json:"caption,omitempty"`
}

Media is a generated block. Use *Media in block lists and type switches. Authored children may be omitted by access rules or projection, even when required on create. Create with MediaInput. To edit, retain the read list and modify its MediaUpdate pointers.

func (*Media) BlockKey 

func (value *Media) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*Media) BlockType 

func (*Media) BlockType() string

BlockType returns the immutable stored discriminator.

func (Media) MarshalJSON 

func (value Media) MarshalJSON() ([]byte, error)

func (*Media) UnmarshalJSON 

func (value *Media) UnmarshalJSON(data []byte) error

type MediaAllLocales 

type MediaAllLocales struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// Asset may be omitted by access rules or projection.
	Asset *Reference[AssetAllLocales] `json:"asset,omitempty"`
	// Caption: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	// Locale-code map; missing locales are absent translations.
	Caption *BlockOptional[map[string]*string] `json:"caption,omitempty"`
}

MediaAllLocales is a generated block. Use *MediaAllLocales in block lists and type switches. Authored children may be omitted by access rules or projection, even when required on create.

func (*MediaAllLocales) BlockKey 

func (value *MediaAllLocales) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*MediaAllLocales) BlockType 

func (*MediaAllLocales) BlockType() string

BlockType returns the immutable stored discriminator.

func (MediaAllLocales) MarshalJSON 

func (value MediaAllLocales) MarshalJSON() ([]byte, error)

func (*MediaAllLocales) UnmarshalJSON 

func (value *MediaAllLocales) UnmarshalJSON(data []byte) error

type MediaAllLocalesValue 

type MediaAllLocalesValue struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// Asset may be omitted by access rules or projection.
	Asset *Reference[AssetAllLocales] `json:"asset,omitempty"`
	// Caption: nil means omitted; a wrapper with nil Value means null. Get returns a concrete value when present.
	Caption *BlockOptional[string] `json:"caption,omitempty"`
}

MediaAllLocalesValue is a generated block. Use *MediaAllLocalesValue in block lists and type switches. Authored children may be omitted by access rules or projection, even when required on create.

func (*MediaAllLocalesValue) BlockKey 

func (value *MediaAllLocalesValue) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*MediaAllLocalesValue) BlockType 

func (*MediaAllLocalesValue) BlockType() string

BlockType returns the immutable stored discriminator.

func (MediaAllLocalesValue) MarshalJSON 

func (value MediaAllLocalesValue) MarshalJSON() ([]byte, error)

func (*MediaAllLocalesValue) UnmarshalJSON 

func (value *MediaAllLocalesValue) UnmarshalJSON(data []byte) error

type MediaInput 

type MediaInput struct {
	// Key identifies this occurrence; omit it for a new server-assigned identity.
	Key string `json:"_key,omitempty"`
	// Asset is required when creating this value.
	Asset string `json:"asset"`
	// Caption: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Caption *core.Input[string] `json:"caption,omitempty"`
}

MediaInput is a generated block. Use *MediaInput in block lists and type switches. Input supplies a new occurrence's required fields. An empty Key requests a server-assigned key. Read this block as Media; edit an existing occurrence with MediaUpdate.

func (*MediaInput) BlockKey 

func (value *MediaInput) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*MediaInput) BlockType 

func (*MediaInput) BlockType() string

BlockType returns the immutable stored discriminator.

func (MediaInput) MarshalJSON 

func (value MediaInput) MarshalJSON() ([]byte, error)

func (*MediaInput) UnmarshalJSON 

func (value *MediaInput) UnmarshalJSON(data []byte) error

type MediaUpdate 

type MediaUpdate struct {
	// Key is the required identity of this existing occurrence.
	Key string `json:"_key"`
	// Asset: nil omits the field; a pointer sends a value. Null is not allowed.
	Asset *string `json:"asset,omitempty"`
	// Caption: nil omits the field; core.Set sends a value; core.Null sends explicit null.
	Caption *core.Input[string] `json:"caption,omitempty"`
}

MediaUpdate is a generated block. Use *MediaUpdate in block lists and type switches. Update retains an existing occurrence by Key. Omitted children remain unchanged. The engine verifies that the key belongs to an existing occurrence of this variant. Start with the read list's Retain method; use MediaInput for additions.

func (*MediaUpdate) BlockKey 

func (value *MediaUpdate) BlockKey() string

BlockKey returns the occurrence identity, or an empty string for a nil or new block.

func (*MediaUpdate) BlockType 

func (*MediaUpdate) BlockType() string

BlockType returns the immutable stored discriminator.

func (MediaUpdate) MarshalJSON 

func (value MediaUpdate) MarshalJSON() ([]byte, error)

func (*MediaUpdate) UnmarshalJSON 

func (value *MediaUpdate) UnmarshalJSON(data []byte) error

type Page 

type Page struct {
	ID        string `json:"id"`
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt"`
	Status    string `json:"_status"`
	Revision  int    `json:"_revision"`
	// Title may be omitted by access rules or projection.
	Title *string `json:"title,omitempty"`
	// Layout may be omitted by access rules or projection.
	Layout *PagesLayout `json:"layout,omitempty"`
}

Page is a single-locale read. Authored fields can be omitted by access rules or projection.

func (*Page) UnmarshalJSON 

func (value *Page) UnmarshalJSON(data []byte) error

type PageAllLocales 

type PageAllLocales struct {
	ID        string `json:"id"`
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt"`
	Status    string `json:"_status"`
	Revision  int    `json:"_revision"`
	// Title may be omitted by access rules or projection.
	Title *string `json:"title,omitempty"`
	// Layout may be omitted by access rules or projection.
	Layout *PagesLayoutAllLocales `json:"layout,omitempty"`
}

PageAllLocales is an all-locales read: localized fields contain locale-code maps.

func (*PageAllLocales) UnmarshalJSON 

func (value *PageAllLocales) UnmarshalJSON(data []byte) error

type PageCreate 

type PageCreate struct {
	// Title is required when creating this value.
	Title string `json:"title"`
	// Layout requires core.NonNull(value); JSON null is rejected.
	Layout core.NonNullInput[PagesLayoutInput] `json:"layout"`
}

PageCreate supplies a new document. Required values are concrete; defaulted values may be omitted, and nullable values use core.Set or core.Null.

func (*PageCreate) UnmarshalJSON 

func (value *PageCreate) UnmarshalJSON(data []byte) error

type PageUpdate 

type PageUpdate struct {
	// Title: nil omits the field; a pointer sends a value. Null is not allowed.
	Title *string `json:"title,omitempty"`
	// Layout: nil omits the field; core.SetNonNull sends a value and rejects JSON null.
	// A supplied list replaces order and membership; use the read list's Retain method to preserve untouched blocks.
	Layout *core.NonNullInput[PagesLayoutUpdate] `json:"layout,omitempty"`
}

PageUpdate edits a document. Nil fields are unchanged; supplied block lists replace order and membership.

func (*PageUpdate) UnmarshalJSON 

func (value *PageUpdate) UnmarshalJSON(data []byte) error

type PagesLayout 

type PagesLayout []PagesLayoutBlock

PagesLayout is an ordered list of block pointers. Nil rows are invalid.

func (PagesLayout) MarshalJSON 

func (rows PagesLayout) MarshalJSON() ([]byte, error)

func (*PagesLayout) Retain 

func (rows *PagesLayout) Retain() (PagesLayoutUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*PagesLayout) UnmarshalJSON 

func (rows *PagesLayout) UnmarshalJSON(data []byte) error

type PagesLayoutAllLocales 

type PagesLayoutAllLocales []PagesLayoutAllLocalesBlock

PagesLayoutAllLocales is an ordered list of block pointers. Nil rows are invalid. Localized children contain locale-code maps; use ordinary output types for a single locale.

func (PagesLayoutAllLocales) MarshalJSON 

func (rows PagesLayoutAllLocales) MarshalJSON() ([]byte, error)

func (*PagesLayoutAllLocales) Retain 

func (rows *PagesLayoutAllLocales) Retain() (PagesLayoutUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*PagesLayoutAllLocales) UnmarshalJSON 

func (rows *PagesLayoutAllLocales) UnmarshalJSON(data []byte) error

type PagesLayoutAllLocalesBlock 

type PagesLayoutAllLocalesBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

PagesLayoutAllLocalesBlock admits only generated block pointers; decoding returns those same pointer types.

type PagesLayoutAllLocalesValue 

type PagesLayoutAllLocalesValue []PagesLayoutAllLocalesValueBlock

PagesLayoutAllLocalesValue is an ordered list of block pointers. Nil rows are invalid. This is one locale's value beneath a localized container in an all-locales response. Children are ordinary values; populated target documents still have all-locales shapes.

func (PagesLayoutAllLocalesValue) MarshalJSON 

func (rows PagesLayoutAllLocalesValue) MarshalJSON() ([]byte, error)

func (*PagesLayoutAllLocalesValue) Retain 

func (rows *PagesLayoutAllLocalesValue) Retain() (PagesLayoutUpdate, error)

Retain creates fresh key-only updates in the same order, preserving every occurrence. Edit the returned update pointers, append new input pointers, or explicitly remove/reorder entries. No authored fields are copied, including redacted, localized or populated values. An absent list, nil row, empty key or duplicate key returns an error and no partial list. An explicitly empty list returns an empty update list. Use revision checks when saving edits.

func (*PagesLayoutAllLocalesValue) UnmarshalJSON 

func (rows *PagesLayoutAllLocalesValue) UnmarshalJSON(data []byte) error

type PagesLayoutAllLocalesValueBlock 

type PagesLayoutAllLocalesValueBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

PagesLayoutAllLocalesValueBlock admits only generated block pointers; decoding returns those same pointer types.

type PagesLayoutBlock 

type PagesLayoutBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

PagesLayoutBlock admits only generated block pointers; decoding returns those same pointer types.

type PagesLayoutInput 

type PagesLayoutInput []PagesLayoutInputBlock

PagesLayoutInput is an ordered list of block pointers. Nil rows are invalid.

func (PagesLayoutInput) MarshalJSON 

func (rows PagesLayoutInput) MarshalJSON() ([]byte, error)

func (*PagesLayoutInput) UnmarshalJSON 

func (rows *PagesLayoutInput) UnmarshalJSON(data []byte) error

type PagesLayoutInputBlock 

type PagesLayoutInputBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

PagesLayoutInputBlock admits only generated block pointers; decoding returns those same pointer types.

type PagesLayoutUpdate 

type PagesLayoutUpdate []PagesLayoutUpdateBlock

PagesLayoutUpdate is an ordered list of block pointers. Nil rows are invalid. Saving this list replaces order and membership: omitted occurrences are removed. Start with a read list's Retain method to preserve untouched blocks.

func (PagesLayoutUpdate) MarshalJSON 

func (rows PagesLayoutUpdate) MarshalJSON() ([]byte, error)

func (*PagesLayoutUpdate) UnmarshalJSON 

func (rows *PagesLayoutUpdate) UnmarshalJSON(data []byte) error

type PagesLayoutUpdateBlock 

type PagesLayoutUpdateBlock interface {
	BlockType() string
	BlockKey() string
	// contains filtered or unexported methods
}

PagesLayoutUpdateBlock admits only generated block pointers; decoding returns those same pointer types. Use keyed Update pointers for existing occurrences and Input pointers for new occurrences.

type Reference 

type Reference[T any] struct {
	ID       string
	Document *T
}

Reference preserves canonical IDs and populated target documents.

func (Reference[T]) MarshalJSON 

func (value Reference[T]) MarshalJSON() ([]byte, error)

func (*Reference[T]) UnmarshalJSON 

func (value *Reference[T]) UnmarshalJSON(data []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.