thrift

Type Members

trait Alias extends ThriftStruct with Product2[String, Long] with ValidatingThriftStruct[Alias] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Alias.apply for construction if you don't need to specify passthrough fields.
trait Asset extends ThriftStruct with Product4[AssetType, String, String, Option[AssetFields]] with ValidatingThriftStruct[Asset] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Asset.apply for construction if you don't need to specify passthrough fields.
trait AssetFields extends ThriftStruct with Product15[Option[String], Option[String], Option[Boolean], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[Int], Option[String], Option[String], Option[Int], Option[Boolean], Option[Long]] with ValidatingThriftStruct[AssetFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.AssetFields.apply for construction if you don't need to specify passthrough fields.
sealed trait AssetType extends ThriftEnum with Serializable

Supported asset types
Supported asset types

Annotations
@Generated()
trait AtomID extends ThriftStruct with Product2[String, AtomType] with ValidatingThriftStruct[AtomID] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.AtomID.apply for construction if you don't need to specify passthrough fields.
sealed trait AtomType extends ThriftEnum with Serializable

Annotations
@Generated()
trait AudioElementFields extends ThriftStruct with Product17[Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[Int], Option[Int], Option[Int], Option[Int], Option[Boolean], Option[Boolean], Option[String], Option[String], Option[Boolean]] with ValidatingThriftStruct[AudioElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.AudioElementFields.apply for construction if you don't need to specify passthrough fields.
trait Block extends ThriftStruct with Product13[String, Option[BlockAttributes], Option[User], Option[Long], Option[Seq[Element]], Option[Long], Option[Long], Option[User], Option[Boolean], Option[Long], Option[String], Option[String], Option[Seq[Tag]]] with ValidatingThriftStruct[Block] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Block.apply for construction if you don't need to specify passthrough fields.
trait BlockAttributes extends ThriftStruct with Product5[Option[Boolean], Option[Boolean], Option[String], Option[Boolean], Option[MembershipPlaceholder]] with ValidatingThriftStruct[BlockAttributes] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.BlockAttributes.apply for construction if you don't need to specify passthrough fields.
trait CalloutElementFields extends ThriftStruct with Product5[Option[String], Option[Boolean], Option[String], Option[String], Option[String]] with ValidatingThriftStruct[CalloutElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.CalloutElementFields.apply for construction if you don't need to specify passthrough fields.
trait CartoonElementFields extends ThriftStruct with Product8[Option[Seq[CartoonVariant]], Option[String], Option[String], Option[String], Option[String], Option[String], Option[Boolean], Option[String]] with ValidatingThriftStruct[CartoonElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.CartoonElementFields.apply for construction if you don't need to specify passthrough fields.
trait CartoonImage extends ThriftStruct with Product5[String, String, Option[Int], Option[Int], Option[String]] with ValidatingThriftStruct[CartoonImage] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.CartoonImage.apply for construction if you don't need to specify passthrough fields.
trait CartoonVariant extends ThriftStruct with Product2[String, Seq[CartoonImage]] with ValidatingThriftStruct[CartoonVariant] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.CartoonVariant.apply for construction if you don't need to specify passthrough fields.
trait ChangeRecord extends ThriftStruct with Product2[Long, Option[User]] with ValidatingThriftStruct[ChangeRecord] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.ChangeRecord.apply for construction if you don't need to specify passthrough fields.
trait Channel extends ThriftStruct with Product2[String, ChannelFields] with ValidatingThriftStruct[Channel] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Channel.apply for construction if you don't need to specify passthrough fields.
trait ChannelFields extends ThriftStruct with Product3[Boolean, Option[Long], Option[Long]] with ValidatingThriftStruct[ChannelFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.ChannelFields.apply for construction if you don't need to specify passthrough fields.
trait CodeElementFields extends ThriftStruct with Product2[Option[String], Option[String]] with ValidatingThriftStruct[CodeElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.CodeElementFields.apply for construction if you don't need to specify passthrough fields.
trait Comment extends ThriftStruct with Product2[String, String] with ValidatingThriftStruct[Comment] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Comment.apply for construction if you don't need to specify passthrough fields.
trait CommentElementFields extends ThriftStruct with Product12[Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[Int], Option[String], Option[Boolean]] with ValidatingThriftStruct[CommentElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.CommentElementFields.apply for construction if you don't need to specify passthrough fields.
trait Content extends ThriftStruct with Product with ValidatingThriftStruct[Content] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Content.apply for construction if you don't need to specify passthrough fields.
trait ContentAtomElementFields extends ThriftStruct with Product4[String, String, Option[String], Option[Boolean]] with ValidatingThriftStruct[ContentAtomElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.ContentAtomElementFields.apply for construction if you don't need to specify passthrough fields.
trait ContentChangeDetails extends ThriftStruct with Product6[Option[ChangeRecord], Option[ChangeRecord], Option[ChangeRecord], Option[ChangeRecord], Option[Long], Option[String]] with ValidatingThriftStruct[ContentChangeDetails] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.ContentChangeDetails.apply for construction if you don't need to specify passthrough fields.
trait ContentFields extends ThriftStruct with Product19[Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[Int], Option[Long], Option[Short], Option[String], Option[MembershipTier], Option[Int], Option[String], Option[String], Option[Int], Option[String], Option[Int]] with ValidatingThriftStruct[ContentFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.ContentFields.apply for construction if you don't need to specify passthrough fields.
trait ContentSettings extends ThriftStruct with Product with ValidatingThriftStruct[ContentSettings] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.ContentSettings.apply for construction if you don't need to specify passthrough fields.
sealed trait ContentType extends ThriftEnum with Serializable

Content types supported by flexible content
Content types supported by flexible content

Annotations
@Generated()
trait Element extends ThriftStruct with Product with ValidatingThriftStruct[Element] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Element.apply for construction if you don't need to specify passthrough fields.
trait ElementFields extends ThriftStruct with Product with ValidatingThriftStruct[ElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.ElementFields.apply for construction if you don't need to specify passthrough fields.
sealed trait ElementType extends ThriftEnum with Serializable

The supported Element types, the types inform what fields to expect and how the Element renders as HTML
The supported Element types, the types inform what fields to expect and how the Element renders as HTML

Annotations
@Generated()
trait EmbedElementFields extends ThriftStruct with Product6[Option[String], Option[Boolean], Option[String], Option[Boolean], Option[String], Option[String]] with ValidatingThriftStruct[EmbedElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.EmbedElementFields.apply for construction if you don't need to specify passthrough fields.
trait Event extends ThriftStruct with Product6[EventType, Long, String, Long, Option[Content], Option[Seq[String]]] with ValidatingThriftStruct[Event] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Event.apply for construction if you don't need to specify passthrough fields.
sealed trait EventType extends ThriftEnum with Serializable

The event type describe the resource state
The event type describe the resource state

Annotations
@Generated()
trait Expiry extends ThriftStruct with Product2[Option[ExpiryDetails], Option[ExpiryDetails]] with ValidatingThriftStruct[Expiry] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Expiry.apply for construction if you don't need to specify passthrough fields.
trait ExpiryDetails extends ThriftStruct with Product3[Boolean, Option[Long], Option[Long]] with ValidatingThriftStruct[ExpiryDetails] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.ExpiryDetails.apply for construction if you don't need to specify passthrough fields.
trait Identifiers extends ThriftStruct with Product7[String, Long, Option[String], Option[String], Option[String], Option[String], Option[String]] with ValidatingThriftStruct[Identifiers] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Identifiers.apply for construction if you don't need to specify passthrough fields.
trait Image extends ThriftStruct with Product2[Option[ImageFields], Option[Seq[Asset]]] with ValidatingThriftStruct[Image] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Image.apply for construction if you don't need to specify passthrough fields.
trait ImageElementFields extends ThriftStruct with Product14[Option[String], Option[String], Option[Boolean], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String]] with ValidatingThriftStruct[ImageElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.ImageElementFields.apply for construction if you don't need to specify passthrough fields.
trait ImageFields extends ThriftStruct with Product14[Option[String], Option[String], Option[String], Option[String], Option[Boolean], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String]] with ValidatingThriftStruct[ImageFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.ImageFields.apply for construction if you don't need to specify passthrough fields.
trait InstagramElementFields extends ThriftStruct with Product10[String, String, String, String, String, Option[String], Option[Int], Option[String], Option[String], Option[String]] with ValidatingThriftStruct[InstagramElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.InstagramElementFields.apply for construction if you don't need to specify passthrough fields.
trait InteractiveElementFields extends ThriftStruct with Product11[Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[Boolean]] with ValidatingThriftStruct[InteractiveElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.InteractiveElementFields.apply for construction if you don't need to specify passthrough fields.
trait ListElementFields extends ThriftStruct with Product2[Seq[ListItem], Option[ListType]] with ValidatingThriftStruct[ListElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.ListElementFields.apply for construction if you don't need to specify passthrough fields.
trait ListItem extends ThriftStruct with Product2[Seq[Element], Option[String]] with ValidatingThriftStruct[ListItem] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.ListItem.apply for construction if you don't need to specify passthrough fields.
sealed trait ListType extends ThriftEnum with Serializable

Annotations
@Generated()
trait MembershipElementFields extends ThriftStruct with Product12[Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[Long], Option[Long], Option[String]] with ValidatingThriftStruct[MembershipElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.MembershipElementFields.apply for construction if you don't need to specify passthrough fields.
trait MembershipPlaceholder extends ThriftStruct with Product1[Option[String]] with ValidatingThriftStruct[MembershipPlaceholder] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.MembershipPlaceholder.apply for construction if you don't need to specify passthrough fields.
sealed trait MembershipTier extends ThriftEnum with Serializable

Annotations
@Generated()
trait Newspaper extends ThriftStruct with Product3[Tag, Tag, Tag] with ValidatingThriftStruct[Newspaper] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Newspaper.apply for construction if you don't need to specify passthrough fields.
sealed trait Office extends ThriftEnum with Serializable

Offices supported by flexible content
Offices supported by flexible content

Annotations
@Generated()
trait PullquoteElementFields extends ThriftStruct with Product3[Option[String], Option[String], Option[String]] with ValidatingThriftStruct[PullquoteElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.PullquoteElementFields.apply for construction if you don't need to specify passthrough fields.
trait RecipeElementFields extends ThriftStruct with Product1[Option[String]] with ValidatingThriftStruct[RecipeElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.RecipeElementFields.apply for construction if you don't need to specify passthrough fields.
trait Reference extends ThriftStruct with Product2[String, String] with ValidatingThriftStruct[Reference] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Reference.apply for construction if you don't need to specify passthrough fields.
trait RichLinkElementFields extends ThriftStruct with Product6[Option[String], Option[String], Option[String], Option[String], Option[String], Option[Sponsorship]] with ValidatingThriftStruct[RichLinkElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.RichLinkElementFields.apply for construction if you don't need to specify passthrough fields.
trait Rights extends ThriftStruct with Product3[Boolean, Boolean, Boolean] with ValidatingThriftStruct[Rights] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Rights.apply for construction if you don't need to specify passthrough fields.
trait Section extends ThriftStruct with Product4[Long, Option[String], Option[String], Option[String]] with ValidatingThriftStruct[Section] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Section.apply for construction if you don't need to specify passthrough fields.
trait Sponsorship extends ThriftStruct with Product2[SponsorshipType, String] with ValidatingThriftStruct[Sponsorship] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Sponsorship.apply for construction if you don't need to specify passthrough fields.
sealed trait SponsorshipType extends ThriftEnum with Serializable

Annotations
@Generated()
trait StandardElementFields extends ThriftStruct with Product12[Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[Int], Option[Int], Option[String], Option[String], Option[Boolean]] with ValidatingThriftStruct[StandardElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.StandardElementFields.apply for construction if you don't need to specify passthrough fields.
trait Tag extends ThriftStruct with Product8[Long, Option[String], Option[String], Option[String], Option[String], Option[Section], Option[String], Option[String]] with ValidatingThriftStruct[Tag] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Tag.apply for construction if you don't need to specify passthrough fields.
trait TagUsage extends ThriftStruct with Product2[Tag, Boolean] with ValidatingThriftStruct[TagUsage] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.TagUsage.apply for construction if you don't need to specify passthrough fields.
trait Taxonomy extends ThriftStruct with Product6[Option[Seq[TagUsage]], Option[Seq[Tag]], Option[Tag], Option[Newspaper], Option[Seq[Reference]], Option[Seq[Tag]]] with ValidatingThriftStruct[Taxonomy] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.Taxonomy.apply for construction if you don't need to specify passthrough fields.
trait TextElementFields extends ThriftStruct with Product2[Option[String], Option[String]] with ValidatingThriftStruct[TextElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.TextElementFields.apply for construction if you don't need to specify passthrough fields.
trait TweetElementFields extends ThriftStruct with Product7[Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[Boolean]] with ValidatingThriftStruct[TweetElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.TweetElementFields.apply for construction if you don't need to specify passthrough fields.
trait User extends ThriftStruct with Product3[String, Option[String], Option[String]] with ValidatingThriftStruct[User] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.User.apply for construction if you don't need to specify passthrough fields.
trait VideoElementFields extends ThriftStruct with Product with ValidatingThriftStruct[VideoElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.VideoElementFields.apply for construction if you don't need to specify passthrough fields.
trait VineElementFields extends ThriftStruct with Product11[String, String, String, String, String, Option[String], Option[Int], Option[Int], Option[String], Option[String], Option[String]] with ValidatingThriftStruct[VineElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.VineElementFields.apply for construction if you don't need to specify passthrough fields.
trait WitnessElementFields extends ThriftStruct with Product with ValidatingThriftStruct[WitnessElementFields] with Serializable

Prefer the companion object's com.gu.flexiblecontent.model.thrift.WitnessElementFields.apply for construction if you don't need to specify passthrough fields.

Value Members

object Alias extends ValidatingThriftStructCodec3[Alias] with Serializable
object Asset extends ValidatingThriftStructCodec3[Asset] with Serializable

An Asset represents an asset file and relevant metadata.
An Asset represents an asset file and relevant metadata.
An image or video will have multiple Assets representing different crops, scalings or qualities. The consumer can pick the appropriate Asset to render for their usage and client device size etc.
object AssetFields extends ValidatingThriftStructCodec3[AssetFields] with Serializable

The metadata relating to a particular Asset
object AssetType extends ThriftEnumObject[AssetType] with Product with Serializable

Supported asset types
Supported asset types

Annotations
@Generated()
object AtomID extends ValidatingThriftStructCodec3[AtomID] with Serializable
object AtomType extends ThriftEnumObject[AtomType] with Product with Serializable

Annotations
@Generated()
object AudioElementFields extends ValidatingThriftStructCodec3[AudioElementFields] with Serializable

The metadata relating to an audio element
object Block extends ValidatingThriftStructCodec3[Block] with Serializable

The block is the main container of body text for content.
The block is the main container of body text for content. Most content is made up of a single main media Block and a single body Block, live blogs are made up of multiple body Blocks, each Block representing an individual update.
Each Block is individually referencable and publishable. Blocks are made up of a number of sub elements
object BlockAttributes extends ValidatingThriftStructCodec3[BlockAttributes] with Serializable

BlockAttributes are used in liveblogs to mark certain updates as key events or summary blocks
object CalloutElementFields extends ValidatingThriftStructCodec3[CalloutElementFields] with Serializable

Callout element
object CartoonElementFields extends ValidatingThriftStructCodec3[CartoonElementFields] with Serializable

Cartoon element
object CartoonImage extends ValidatingThriftStructCodec3[CartoonImage] with Serializable
object CartoonVariant extends ValidatingThriftStructCodec3[CartoonVariant] with Serializable
object ChangeRecord extends ValidatingThriftStructCodec3[ChangeRecord] with Serializable

A record of a change, reocrds when and who performed the change
object Channel extends ValidatingThriftStructCodec3[Channel] with Serializable

A channel is a set of fields that allows consumers of CAPI to publish to products (e.g.
A channel is a set of fields that allows consumers of CAPI to publish to products (e.g. Kindle, Editions, Newsletters) independently of publishing to the web.
If content is 'available' on a channel, we expose it to consumers looking for that channel.
Content made available on a channel can appear in CAPI _before_ it is published to the web.
Access to channel content is restricted to certain consumers (so we don't leak channel content to consumers looking for web content).
e.g.) The Kindle edition generator builds the Kindle issue using the channel markup information. It calls a CAPI endpoint which returns all content marked as 'isAvailable' on the Kindle channel. This includes both content that is published to the web, and content that has yet to be published.
This is useful because the Kindle, as a 'replica' of the print edition, often contains content we are not ready to publish to the web, and channels allow us to time the content's publication to different products (or even publish content exclusively to that product).
object ChannelFields extends ValidatingThriftStructCodec3[ChannelFields] with Serializable
object CodeElementFields extends ValidatingThriftStructCodec3[CodeElementFields] with Serializable

Code element
object Comment extends ValidatingThriftStructCodec3[Comment] with Serializable

This struct represents a comment
object CommentElementFields extends ValidatingThriftStructCodec3[CommentElementFields] with Serializable

The metadata relating to a comment element
object Content extends ValidatingThriftStructCodec3[Content] with Serializable

This struct represents the content item
object ContentAtomElementFields extends ValidatingThriftStructCodec3[ContentAtomElementFields] with Serializable

Content Atom element
object ContentChangeDetails extends ValidatingThriftStructCodec3[ContentChangeDetails] with Serializable

Audit information about changes to content
object ContentFields extends ValidatingThriftStructCodec3[ContentFields] with Serializable

ContentFields is a collection of fields for the content.
ContentFields is a collection of fields for the content. Fields are used to represent the furniture of the content that displays with the content or to trail the content.
values stored as fields are typically seen by the end user, in contrast to values stored as settings
object ContentSettings extends ValidatingThriftStructCodec3[ContentSettings] with Serializable

ContentSettings is a collection of settings that update how content is displayed and what is shown alongside the the content.
ContentSettings is a collection of settings that update how content is displayed and what is shown alongside the the content.
values stored as settings are not seen by the end user directly.
object ContentType extends ThriftEnumObject[ContentType] with Product with Serializable

Content types supported by flexible content
Content types supported by flexible content

Annotations
@Generated()
object Element extends ValidatingThriftStructCodec3[Element] with Serializable

An Element represents a fragment of content, This might be some text, an image, an embed etc.
An Element represents a fragment of content, This might be some text, an image, an embed etc. By building up a list of Elements a rich content body can be constructed flexibly.
object ElementFields extends ValidatingThriftStructCodec3[ElementFields] with Serializable

The fields that configure the Element.
object ElementType extends ThriftEnumObject[ElementType] with Product with Serializable

The supported Element types, the types inform what fields to expect and how the Element renders as HTML
The supported Element types, the types inform what fields to expect and how the Element renders as HTML

Annotations
@Generated()
object EmbedElementFields extends ValidatingThriftStructCodec3[EmbedElementFields] with Serializable
object Event extends ValidatingThriftStructCodec3[Event] with Serializable
object EventType extends ThriftEnumObject[EventType] with Product with Serializable

The event type describe the resource state
The event type describe the resource state

Annotations
@Generated()
object Expiry extends ValidatingThriftStructCodec3[Expiry] with Serializable

Expiry represents the ways content can expire
object ExpiryDetails extends ValidatingThriftStructCodec3[ExpiryDetails] with Serializable

Details of how and if content id expired
object Identifiers extends ValidatingThriftStructCodec3[Identifiers] with Serializable

This struct represents the bundle of identifiers that content can be looked up by.
object Image extends ValidatingThriftStructCodec3[Image] with Serializable

A raw image, as opposed to wrapped in an Element with type = IMAGE.
A raw image, as opposed to wrapped in an Element with type = IMAGE. This is used for content thumbnails
object ImageElementFields extends ValidatingThriftStructCodec3[ImageElementFields] with Serializable

The metadata relating to a image element.
The metadata relating to a image element. Fun fact: this is EXACTLY the same as ImageFields except the fields are in a different order.
object ImageFields extends ValidatingThriftStructCodec3[ImageFields] with Serializable

Image metadata, this is a image specific subset of ElementFields.
Image metadata, this is a image specific subset of ElementFields.
TODO want to get rid of this type because it's exactly the same as ImageElementFields (apart from the order of fields). But this is a breaking change. Will have to wait until v2.
object InstagramElementFields extends ValidatingThriftStructCodec3[InstagramElementFields] with Serializable

Instagram element
object InteractiveElementFields extends ValidatingThriftStructCodec3[InteractiveElementFields] with Serializable

The metadata relating to an interactive element
object ListElementFields extends ValidatingThriftStructCodec3[ListElementFields] with Serializable
object ListItem extends ValidatingThriftStructCodec3[ListItem] with Serializable
object ListType extends ThriftEnumObject[ListType] with Product with Serializable

Annotations
@Generated()
object MembershipElementFields extends ValidatingThriftStructCodec3[MembershipElementFields] with Serializable

The metadata relating to a membership element
object MembershipPlaceholder extends ValidatingThriftStructCodec3[MembershipPlaceholder] with Serializable
object MembershipTier extends ThriftEnumObject[MembershipTier] with Product with Serializable

Annotations
@Generated()
object Newspaper extends ValidatingThriftStructCodec3[Newspaper] with Serializable

Represents where the contant appears in the newspaper
Represents where the contant appears in the newspaper
The book is the physical printed thing (G1, G2 etc), the bookSection is the subsection of the book (news, business, obituries etc.) and the publication is the physical publication(The Guardian, The Observer). This information, along with the newspaperPageNumber and newspaperPublicationDate fields, is used to produce the daily newspaper navigation pages.
object Office extends ThriftEnumObject[Office] with Product with Serializable

Offices supported by flexible content
Offices supported by flexible content

Annotations
@Generated()
object PullquoteElementFields extends ValidatingThriftStructCodec3[PullquoteElementFields] with Serializable

The metadata relating to a pull quote element
object RecipeElementFields extends ValidatingThriftStructCodec3[RecipeElementFields] with Serializable

Recipe element
object Reference extends ValidatingThriftStructCodec3[Reference] with Serializable

An external reference applied to content
An external reference applied to content
An external reference typically refers to a thing in another system or a real world thing. Examples include the isbn of a book the content is reviewing or a cricket match.
object RichLinkElementFields extends ValidatingThriftStructCodec3[RichLinkElementFields] with Serializable

The metadata relating to a rich-link element
object Rights extends ValidatingThriftStructCodec3[Rights] with Serializable

the rights profile of a content item
object Section extends ValidatingThriftStructCodec3[Section] with Serializable

Represents a section.
Represents a section.
All tags exist within a section and the content's section is derived from the section of the most important tag.
object Sponsorship extends ValidatingThriftStructCodec3[Sponsorship] with Serializable
object SponsorshipType extends ThriftEnumObject[SponsorshipType] with Product with Serializable

Annotations
@Generated()
object StandardElementFields extends ValidatingThriftStructCodec3[StandardElementFields] with Serializable

The metadata relating to a map, document or table element
object Tag extends ValidatingThriftStructCodec3[Tag] with Serializable

Represents a tag applied to content
Represents a tag applied to content
The id is the only required field, all the rest of the data can be looked up using the id.
object TagUsage extends ValidatingThriftStructCodec3[TagUsage] with Serializable

Represents a Tag's application to content.
Represents a Tag's application to content.
Includes the Tag and if the tag <-> content relationship is marked as lead
object Taxonomy extends ValidatingThriftStructCodec3[Taxonomy] with Serializable

Taxonomy represents the tags and references of a piece of content
object TextElementFields extends ValidatingThriftStructCodec3[TextElementFields] with Serializable

The metadata relating to a text element
object TweetElementFields extends ValidatingThriftStructCodec3[TweetElementFields] with Serializable

The metadata relating to a tweet element
object User extends ValidatingThriftStructCodec3[User] with Serializable

this stucture represents the composer user
object VideoElementFields extends ValidatingThriftStructCodec3[VideoElementFields] with Serializable

The metadata relating to a video element
object VineElementFields extends ValidatingThriftStructCodec3[VineElementFields] with Serializable

Vine element
object WitnessElementFields extends ValidatingThriftStructCodec3[WitnessElementFields] with Serializable

The metadata relating to a Witness element

package thrift

Type Members

trait Alias extends ThriftStruct with Product2[String, Long] with ValidatingThriftStruct[Alias] with Serializable

trait Asset extends ThriftStruct with Product4[AssetType, String, String, Option[AssetFields]] with ValidatingThriftStruct[Asset] with Serializable

sealed trait AssetType extends ThriftEnum with Serializable

trait AtomID extends ThriftStruct with Product2[String, AtomType] with ValidatingThriftStruct[AtomID] with Serializable

sealed trait AtomType extends ThriftEnum with Serializable

trait BlockAttributes extends ThriftStruct with Product5[Option[Boolean], Option[Boolean], Option[String], Option[Boolean], Option[MembershipPlaceholder]] with ValidatingThriftStruct[BlockAttributes] with Serializable

trait CalloutElementFields extends ThriftStruct with Product5[Option[String], Option[Boolean], Option[String], Option[String], Option[String]] with ValidatingThriftStruct[CalloutElementFields] with Serializable

trait CartoonElementFields extends ThriftStruct with Product8[Option[Seq[CartoonVariant]], Option[String], Option[String], Option[String], Option[String], Option[String], Option[Boolean], Option[String]] with ValidatingThriftStruct[CartoonElementFields] with Serializable

trait CartoonImage extends ThriftStruct with Product5[String, String, Option[Int], Option[Int], Option[String]] with ValidatingThriftStruct[CartoonImage] with Serializable

trait CartoonVariant extends ThriftStruct with Product2[String, Seq[CartoonImage]] with ValidatingThriftStruct[CartoonVariant] with Serializable

trait ChangeRecord extends ThriftStruct with Product2[Long, Option[User]] with ValidatingThriftStruct[ChangeRecord] with Serializable

trait Channel extends ThriftStruct with Product2[String, ChannelFields] with ValidatingThriftStruct[Channel] with Serializable

trait ChannelFields extends ThriftStruct with Product3[Boolean, Option[Long], Option[Long]] with ValidatingThriftStruct[ChannelFields] with Serializable

trait CodeElementFields extends ThriftStruct with Product2[Option[String], Option[String]] with ValidatingThriftStruct[CodeElementFields] with Serializable

trait Comment extends ThriftStruct with Product2[String, String] with ValidatingThriftStruct[Comment] with Serializable

trait Content extends ThriftStruct with Product with ValidatingThriftStruct[Content] with Serializable

trait ContentAtomElementFields extends ThriftStruct with Product4[String, String, Option[String], Option[Boolean]] with ValidatingThriftStruct[ContentAtomElementFields] with Serializable

trait ContentChangeDetails extends ThriftStruct with Product6[Option[ChangeRecord], Option[ChangeRecord], Option[ChangeRecord], Option[ChangeRecord], Option[Long], Option[String]] with ValidatingThriftStruct[ContentChangeDetails] with Serializable

trait ContentSettings extends ThriftStruct with Product with ValidatingThriftStruct[ContentSettings] with Serializable

sealed trait ContentType extends ThriftEnum with Serializable

trait Element extends ThriftStruct with Product with ValidatingThriftStruct[Element] with Serializable

trait ElementFields extends ThriftStruct with Product with ValidatingThriftStruct[ElementFields] with Serializable

sealed trait ElementType extends ThriftEnum with Serializable

trait EmbedElementFields extends ThriftStruct with Product6[Option[String], Option[Boolean], Option[String], Option[Boolean], Option[String], Option[String]] with ValidatingThriftStruct[EmbedElementFields] with Serializable

trait Event extends ThriftStruct with Product6[EventType, Long, String, Long, Option[Content], Option[Seq[String]]] with ValidatingThriftStruct[Event] with Serializable

sealed trait EventType extends ThriftEnum with Serializable

trait Expiry extends ThriftStruct with Product2[Option[ExpiryDetails], Option[ExpiryDetails]] with ValidatingThriftStruct[Expiry] with Serializable

trait ExpiryDetails extends ThriftStruct with Product3[Boolean, Option[Long], Option[Long]] with ValidatingThriftStruct[ExpiryDetails] with Serializable

trait Identifiers extends ThriftStruct with Product7[String, Long, Option[String], Option[String], Option[String], Option[String], Option[String]] with ValidatingThriftStruct[Identifiers] with Serializable

trait Image extends ThriftStruct with Product2[Option[ImageFields], Option[Seq[Asset]]] with ValidatingThriftStruct[Image] with Serializable

trait InstagramElementFields extends ThriftStruct with Product10[String, String, String, String, String, Option[String], Option[Int], Option[String], Option[String], Option[String]] with ValidatingThriftStruct[InstagramElementFields] with Serializable

trait ListElementFields extends ThriftStruct with Product2[Seq[ListItem], Option[ListType]] with ValidatingThriftStruct[ListElementFields] with Serializable

trait ListItem extends ThriftStruct with Product2[Seq[Element], Option[String]] with ValidatingThriftStruct[ListItem] with Serializable

sealed trait ListType extends ThriftEnum with Serializable

trait MembershipPlaceholder extends ThriftStruct with Product1[Option[String]] with ValidatingThriftStruct[MembershipPlaceholder] with Serializable

sealed trait MembershipTier extends ThriftEnum with Serializable

trait Newspaper extends ThriftStruct with Product3[Tag, Tag, Tag] with ValidatingThriftStruct[Newspaper] with Serializable

sealed trait Office extends ThriftEnum with Serializable

trait PullquoteElementFields extends ThriftStruct with Product3[Option[String], Option[String], Option[String]] with ValidatingThriftStruct[PullquoteElementFields] with Serializable

trait RecipeElementFields extends ThriftStruct with Product1[Option[String]] with ValidatingThriftStruct[RecipeElementFields] with Serializable

trait Reference extends ThriftStruct with Product2[String, String] with ValidatingThriftStruct[Reference] with Serializable

trait RichLinkElementFields extends ThriftStruct with Product6[Option[String], Option[String], Option[String], Option[String], Option[String], Option[Sponsorship]] with ValidatingThriftStruct[RichLinkElementFields] with Serializable

trait Rights extends ThriftStruct with Product3[Boolean, Boolean, Boolean] with ValidatingThriftStruct[Rights] with Serializable

trait Section extends ThriftStruct with Product4[Long, Option[String], Option[String], Option[String]] with ValidatingThriftStruct[Section] with Serializable

trait Sponsorship extends ThriftStruct with Product2[SponsorshipType, String] with ValidatingThriftStruct[Sponsorship] with Serializable

sealed trait SponsorshipType extends ThriftEnum with Serializable

trait Tag extends ThriftStruct with Product8[Long, Option[String], Option[String], Option[String], Option[String], Option[Section], Option[String], Option[String]] with ValidatingThriftStruct[Tag] with Serializable

trait TagUsage extends ThriftStruct with Product2[Tag, Boolean] with ValidatingThriftStruct[TagUsage] with Serializable

trait Taxonomy extends ThriftStruct with Product6[Option[Seq[TagUsage]], Option[Seq[Tag]], Option[Tag], Option[Newspaper], Option[Seq[Reference]], Option[Seq[Tag]]] with ValidatingThriftStruct[Taxonomy] with Serializable

trait TextElementFields extends ThriftStruct with Product2[Option[String], Option[String]] with ValidatingThriftStruct[TextElementFields] with Serializable

trait TweetElementFields extends ThriftStruct with Product7[Option[String], Option[String], Option[String], Option[String], Option[String], Option[String], Option[Boolean]] with ValidatingThriftStruct[TweetElementFields] with Serializable

trait User extends ThriftStruct with Product3[String, Option[String], Option[String]] with ValidatingThriftStruct[User] with Serializable

trait VideoElementFields extends ThriftStruct with Product with ValidatingThriftStruct[VideoElementFields] with Serializable

trait VineElementFields extends ThriftStruct with Product11[String, String, String, String, String, Option[String], Option[Int], Option[Int], Option[String], Option[String], Option[String]] with ValidatingThriftStruct[VineElementFields] with Serializable

trait WitnessElementFields extends ThriftStruct with Product with ValidatingThriftStruct[WitnessElementFields] with Serializable

Value Members

object Alias extends ValidatingThriftStructCodec3[Alias] with Serializable

object Asset extends ValidatingThriftStructCodec3[Asset] with Serializable

object AssetFields extends ValidatingThriftStructCodec3[AssetFields] with Serializable

object AssetType extends ThriftEnumObject[AssetType] with Product with Serializable

object AtomID extends ValidatingThriftStructCodec3[AtomID] with Serializable

object AtomType extends ThriftEnumObject[AtomType] with Product with Serializable

object AudioElementFields extends ValidatingThriftStructCodec3[AudioElementFields] with Serializable

object Block extends ValidatingThriftStructCodec3[Block] with Serializable

object BlockAttributes extends ValidatingThriftStructCodec3[BlockAttributes] with Serializable

object CalloutElementFields extends ValidatingThriftStructCodec3[CalloutElementFields] with Serializable

object CartoonElementFields extends ValidatingThriftStructCodec3[CartoonElementFields] with Serializable

object CartoonImage extends ValidatingThriftStructCodec3[CartoonImage] with Serializable

object CartoonVariant extends ValidatingThriftStructCodec3[CartoonVariant] with Serializable

object ChangeRecord extends ValidatingThriftStructCodec3[ChangeRecord] with Serializable

object Channel extends ValidatingThriftStructCodec3[Channel] with Serializable

object ChannelFields extends ValidatingThriftStructCodec3[ChannelFields] with Serializable

object CodeElementFields extends ValidatingThriftStructCodec3[CodeElementFields] with Serializable

object Comment extends ValidatingThriftStructCodec3[Comment] with Serializable

object CommentElementFields extends ValidatingThriftStructCodec3[CommentElementFields] with Serializable

object Content extends ValidatingThriftStructCodec3[Content] with Serializable

object ContentAtomElementFields extends ValidatingThriftStructCodec3[ContentAtomElementFields] with Serializable