model

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 AssetTypeData(aspectRatio: Option[String], altText: Option[String], isInappropriateForAdverts: Option[Boolean], caption: Option[String], credit: Option[String], embeddable: Option[Boolean], photographer: Option[String], source: Option[String], stillImageUrl: Option[String], width: Option[Int], height: Option[Int], name: Option[String], secureFile: Option[String]) extends Product with Serializable

   

3. case class AudioTypeData(html: Option[String], source: Option[String], description: Option[String], title: Option[String], credit: Option[String], caption: Option[String]) extends Product with Serializable

   

4. case class Block(id: String, bodyHtml: String, bodyTextSummary: String, title: Option[String], attributes: Map[String, String], published: Boolean, createdDate: Option[DateTime], firstPublishedDate: Option[DateTime], publishedDate: Option[DateTime], lastModifiedDate: Option[DateTime], contributors: Seq[String], createdBy: Option[User], lastModifiedBy: Option[User], elements: Seq[BlockElement] = Nil) extends Product with Serializable

   

   A block of content.

   A block of content.

   id

   a unique ID

   bodyHtml

   the HTML body of the block

   bodyTextSummary

   the textual content of the block, with HTML tags stripped. This will not include any non-textual content such as pullquotes, tweet embeds, etc.

   title

   the block's title, if it has one

   attributes

   metadata about the block e.g. this will contain "keyEvent" -> "true" if the block is a key event, or "summary" -> "true" if it is a summary

   published

   whether this block is currently live

   createdDate

   the first time this block was created

   firstPublishedDate

   the first time this block was published

   publishedDate

   the last time this block was published

   lastModifiedDate

   the last time this block was modified

   contributors

   people who contributed to this block

   createdBy

   person who created this block

   lastModifiedBy

   person who last modified this block

5. case class BlockAsset(type: String, mimeType: String, file: String, typeData: AssetTypeData) extends Product with Serializable

   

6. case class BlockElement(type: String, assets: Seq[BlockAsset] = Nil, textTypeData: Option[TextTypeData] = None, videoTypeData: Option[VideoTypeData] = None, tweetTypeData: Option[TweetTypeData] = None, imageTypeData: Option[ImageTypeData] = None, audioTypeData: Option[AudioTypeData] = None, pullquoteTypeData: Option[PullquoteTypeData] = None) extends Product with Serializable

   

7. case class Blocks(main: Option[Block], body: Option[Seq[Block]]) extends Product with Serializable

   

   The blocks that make up a piece of content.

   The blocks that make up a piece of content.

   main

   The main block, which will include the main image and other furniture

   body

   The block(s) that make up the body of the content. For a liveblog there may be multiple blocks. Any other content will have only one block.

8. 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, blocks: Option[Blocks] = None, rights: Option[Rights] = None, crossword: Option[Crossword] = None) extends ContentType with Product with Serializable

   

9. sealed trait ContentApiQuery extends AnyRef

   

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

    

11. sealed trait ContentType extends AnyRef

    

12. case class Crossword(name: String, type: String, number: Int, date: String, dimensions: CrosswordDimensions, entries: Seq[CrosswordEntry], solutionAvailable: Boolean, hasNumbers: Boolean, randomCluesOrdering: Boolean, instructions: Option[String], creator: Option[CrosswordCreator], pdf: Option[String], annotatedSolution: Option[String]) extends Product with Serializable

    

13. case class CrosswordCreator(name: String, webUrl: String) extends Product with Serializable

    

14. case class CrosswordDimensions(cols: Int, rows: Int) extends Product with Serializable

    

15. case class CrosswordEntry(id: String, number: Option[Int], humanNumber: Option[String], direction: Option[String], position: Option[CrosswordPosition], separatorLocations: Option[Map[String, Seq[Int]]], length: Option[Int], clue: Option[String], group: Option[Seq[String]], solution: Option[String], format: Option[String]) extends Product with Serializable

    

16. case class CrosswordPosition(x: Int, y: Int) extends Product with Serializable

    

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

    

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

    

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

    

20. case class EditionsResponse(status: String, userTier: String, total: Int, results: List[NetworkFront]) extends Product with Serializable

    

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

    

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

    

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

    

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

    

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

    

26. case class ImageTypeData(caption: Option[String], copyright: Option[String], displayCredit: Option[Boolean], credit: Option[String], source: Option[String], photographer: Option[String], alt: Option[String], mediaId: Option[String], mediaApiUri: Option[String], picdarUrn: Option[String], suppliersReference: Option[String], imageType: Option[String]) extends Product with Serializable

    

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

    

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

    

29. case class NetworkFront(id: String, path: String, edition: String, webTitle: String, webUrl: String, apiUrl: String) extends Product with Serializable

    

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

    

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

    

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

    

33. case class PullquoteTypeData(html: Option[String], attribution: Option[String]) extends Product with Serializable

    

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

    

35. case class RemovedContentQuery(parameterHolder: Map[String, Parameter] = Map.empty) extends ContentApiQuery with RemovedReasonParameters[RemovedContentQuery] with PaginationParameters[RemovedContentQuery] with OrderingParameters[RemovedContentQuery] with Product with Serializable

    

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

    

37. trait RemovedReasonParameters[Owner <: Parameters[Owner]] extends Parameters[Owner]

    

38. case class Rights(subscriptionDatabases: Boolean = false, developerCommunity: Boolean = false, syndicatable: Boolean = false) extends Product with Serializable

    

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

    

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

    

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

    

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

    

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

    

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

    

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

    

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

    

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

    

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

    

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

    

50. case class TextTypeData(html: Option[String]) extends Product with Serializable

    

51. case class TweetTypeData(source: Option[String], url: Option[String], id: Option[String], html: Option[String], originalUrl: Option[String]) extends Product with Serializable

    

52. case class User(email: String, firstName: Option[String], lastName: Option[String]) extends Product with Serializable

    

53. case class VideoTypeData(url: Option[String], description: Option[String], title: Option[String], html: Option[String]) extends Product with Serializable