com.gu.contentapi.client

model

package model

Visibility
  1. Public
  2. All

Type Members

  1. case class Asset(type: String, mimeType: Option[String], file: Option[String], typeData: Map[String, String]) extends Product with Serializable

  2. case class Collection(id: String, type: String, title: Option[String], groups: List[String], lastModified: DateTime, modifiedBy: String, curatedContent: List[CuratedContent], backfill: Option[String]) extends Product with Serializable

  3. case class CollectionQuery(collectionId: String, parameterHolder: Map[String, Parameter] = Map.empty) extends ContentApiQuery with ShowParameters[CollectionQuery] with ShowReferencesParameters[CollectionQuery] with FilterParameters[CollectionQuery] with FilterExtendedParameters[CollectionQuery] with Product with Serializable

  4. case class CollectionResponse(status: String, userTier: String, total: Int, startIndex: Int, pageSize: Int, currentPage: Int, pages: Int, collection: Collection) extends Product with Serializable

  5. case class Content(id: String, sectionId: Option[String], sectionName: Option[String], webPublicationDateOption: Option[DateTime], webTitle: String, webUrl: String, apiUrl: String, fields: Option[Map[String, String]] = None, tags: List[Tag] = Nil, elements: Option[List[Element]], references: List[Reference] = Nil, isExpired: Option[Boolean] = None) extends ContentType with Product with Serializable

  6. sealed trait ContentApiQuery extends AnyRef

  7. trait ContentParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  8. sealed trait ContentType extends AnyRef

  9. case class CuratedContent(id: String, sectionId: Option[String], sectionName: Option[String], webPublicationDate: DateTime, webTitle: String, webUrl: String, apiUrl: String, fields: Option[Map[String, String]] = None, tags: List[Tag] = Nil, elements: Option[List[Element]], references: List[Reference] = Nil, isExpired: Option[Boolean] = None, metadata: Option[CuratedMetadata]) extends ContentType with Product with Serializable

  10. case class CuratedMetadata(trailText: Option[String], headline: Option[String], imageAdjustment: Option[String], group: Option[Int], supportingContent: List[SupportingContent], showKickerTag: Option[Boolean], showKickerSection: Option[Boolean], showKickerCustom: Option[Boolean], customKicker: Option[String]) extends Metadata with Product with Serializable

  11. case class Edition(id: String, webTitle: String, webUrl: String, apiUrl: String, code: String) extends Product with Serializable

  12. trait EditionParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  13. case class Element(id: String, relation: String, type: String, galleryIndex: Option[Int] = None, assets: List[Asset]) extends Product with Serializable

  14. trait FilterExtendedParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  15. trait FilterParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  16. trait FilterSearchParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  17. trait FilterTagParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  18. case class ItemQuery(id: String, parameterHolder: Map[String, Parameter] = Map.empty) extends ContentApiQuery with EditionParameters[ItemQuery] with ContentParameters[ItemQuery] with ShowParameters[ItemQuery] with ShowReferencesParameters[ItemQuery] with ShowExtendedParameters[ItemQuery] with PaginationParameters[ItemQuery] with OrderingParameters[ItemQuery] with FilterParameters[ItemQuery] with FilterExtendedParameters[ItemQuery] with FilterSearchParameters[ItemQuery] with Product with Serializable

  19. case class ItemResponse(status: String, userTier: String, total: Option[Int], startIndex: Option[Int], pageSize: Option[Int], currentPage: Option[Int], pages: Option[Int], orderBy: Option[String], tag: Option[Tag], edition: Option[Edition], section: Option[Section], content: Option[Content], results: List[Content], relatedContent: List[Content], editorsPicks: List[Content], mostViewed: List[Content], storyPackage: List[Content], leadContent: List[Content]) extends Product with Serializable

  20. case class MediaEncoding(format: String, file: String) extends Product with Serializable

  21. sealed trait Metadata extends AnyRef

  22. trait OrderingParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  23. trait PaginationParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  24. case class Podcast(linkUrl: String, copyright: String, author: String, subscriptionUrl: Option[String], explicit: Boolean) extends Product with Serializable

  25. case class Reference(type: String, id: String) extends Product with Serializable

  26. case class SearchQuery(parameterHolder: Map[String, Parameter] = Map.empty) extends ContentApiQuery with ContentParameters[SearchQuery] with ShowParameters[SearchQuery] with ShowReferencesParameters[SearchQuery] with OrderingParameters[SearchQuery] with PaginationParameters[SearchQuery] with FilterParameters[SearchQuery] with FilterExtendedParameters[SearchQuery] with FilterSearchParameters[SearchQuery] with Product with Serializable

  27. case class SearchResponse(status: String, userTier: String, total: Int, startIndex: Int, pageSize: Int, currentPage: Int, pages: Int, orderBy: String, results: List[Content]) extends Product with Serializable

  28. case class Section(id: String, webTitle: String, webUrl: String, apiUrl: String, editions: List[Edition]) extends Product with Serializable

  29. case class SectionsQuery(parameterHolder: Map[String, Parameter] = Map.empty) extends ContentApiQuery with FilterSearchParameters[SectionsQuery] with Product with Serializable

  30. case class SectionsResponse(status: String, userTier: String, total: Int, results: List[Section]) extends Product with Serializable

  31. trait ShowExtendedParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  32. trait ShowParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  33. trait ShowReferencesParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

  34. case class SupportingContent(id: String, sectionId: Option[String], sectionName: Option[String], webPublicationDate: DateTime, webTitle: String, webUrl: String, apiUrl: String, fields: Option[Map[String, String]] = None, tags: List[Tag] = Nil, elements: Option[List[Element]], references: List[Reference] = Nil, isExpired: Option[Boolean] = None, metadata: Option[SupportingMetadata]) extends ContentType with Product with Serializable

  35. case class SupportingMetadata(trailText: Option[String], headline: Option[String], imageAdjustment: Option[String], showKickerTag: Option[Boolean], showKickerSection: Option[Boolean], showKickerCustom: Option[Boolean], customKicker: Option[String]) extends Metadata with Product with Serializable

  36. case class Tag(id: String, type: String, sectionId: Option[String] = None, sectionName: Option[String] = None, webTitle: String, webUrl: String, apiUrl: String, references: List[Reference] = Nil, description: Option[String] = None, bio: Option[String] = None, bylineImageUrl: Option[String] = None, bylineLargeImageUrl: Option[String] = None, podcast: Option[Podcast] = None, firstName: Option[String] = None, lastName: Option[String] = None, emailAddress: Option[String] = None, twitterHandle: Option[String] = None) extends Product with Serializable

  37. case class TagsQuery(parameterHolder: Map[String, Parameter] = Map.empty) extends ContentApiQuery with ShowReferencesParameters[TagsQuery] with PaginationParameters[TagsQuery] with FilterParameters[TagsQuery] with FilterTagParameters[TagsQuery] with FilterSearchParameters[TagsQuery] with Product with Serializable

  38. case class TagsResponse(status: String, userTier: String, total: Int, startIndex: Int, pageSize: Int, currentPage: Int, pages: Int, results: List[Tag]) extends Product with Serializable

Ungrouped