orion/schema.graphql

# -----------------------------------------------
# !!! THIS FILE WAS GENERATED BY TYPE-GRAPHQL !!!
# !!!   DO NOT MODIFY THIS FILE BY YOURSELF   !!!
# -----------------------------------------------

type Admin {
  isKilled: Boolean!
}

type CategoryFeaturedVideos {
  categoryFeaturedVideos: [FeaturedVideo!]!
  categoryId: ID!
}

type ChannelFollowsInfo {
  follows: Int!
  id: ID!
}

type ChannelReportInfo {
  channelId: ID!
  createdAt: DateTime!
  id: ID!
  rationale: String!
  reporterIp: String!
}

enum ChannelReportOrderByInput {
  createdAt_ASC
  createdAt_DESC
}

input ChannelReportsWhereInput {
  channelId: ID
  createdAt_gt: DateTime
  createdAt_lt: DateTime
  reporterIp: String
}

"""
The javascript `Date` as string. Type represents date and time as the ISO Date string.
"""
scalar DateTime

type EntityViewsInfo {
  id: ID!
  views: Int!
}

type FeaturedVideo {
  videoCutUrl: String
  videoId: ID!
}

input FeaturedVideoInput {
  videoCutUrl: String
  videoId: ID!
}

type GeneratedSignature {
  """App signature converted to hexadecimal string."""
  signature: String!
}

type Mutation {
  """Add a single view to the target video's count"""
  addVideoView(categoryId: ID, channelId: ID!, videoId: ID!): EntityViewsInfo!

  """Add a single follow to the target channel"""
  followChannel(channelId: ID!): ChannelFollowsInfo!

  """Report a channel"""
  reportChannel(channelId: ID!, rationale: String!): ChannelReportInfo!

  """Report a video"""
  reportVideo(rationale: String!, videoId: ID!): VideoReportInfo!
  setCategoryFeaturedVideos(categoryId: ID!, videos: [FeaturedVideoInput!]!): [FeaturedVideo!]!
  setKillSwitch(isKilled: Boolean!): Admin!
  setVideoHero(newVideoHero: VideoHeroInput!): VideoHero!
  signAppActionCommitment(assets: String!, creatorId: String!, rawAction: String!, rawAppActionMetadata: String!): GeneratedSignature!

  """Remove a single follow from the target channel"""
  unfollowChannel(channelId: ID!): ChannelFollowsInfo!
}

type Query {
  """Set killed instance"""
  admin: Admin!

  """Get featured videos for all categories"""
  allCategoriesFeaturedVideos(videosLimit: Int!): [CategoryFeaturedVideos!]!

  """Get featured videos for a given video category"""
  categoryFeaturedVideos(categoryId: ID!): [FeaturedVideo!]!

  """Get list of most viewed categories in a given time period"""
  mostViewedCategories(
    limit: Int

    """timePeriodDays must take one of the following values: 7, 30"""
    timePeriodDays: Int!
  ): [EntityViewsInfo!]

  """Get list of most viewed categories of all time"""
  mostViewedCategoriesAllTime(limit: Int!): [EntityViewsInfo!]
  reportedChannels(limit: Int = 30, orderBy: ChannelReportOrderByInput = createdAt_DESC, skip: Int, where: ChannelReportsWhereInput): [ChannelReportInfo!]!
  reportedVideos(limit: Int = 30, orderBy: VideoReportOrderByInput = createdAt_DESC, skip: Int, where: VideoReportsWhereInput): [VideoReportInfo!]!

  """Get current video hero"""
  videoHero: VideoHero!
}

type VideoHero {
  heroPosterUrl: String!
  heroTitle: String!
  heroVideoCutUrl: String!
  videoId: ID!
}

input VideoHeroInput {
  heroPosterUrl: String!
  heroTitle: String!
  heroVideoCutUrl: String!
  videoId: ID!
}

type VideoReportInfo {
  createdAt: DateTime!
  id: ID!
  rationale: String!
  reporterIp: String!
  videoId: ID!
}

enum VideoReportOrderByInput {
  createdAt_ASC
  createdAt_DESC
}

input VideoReportsWhereInput {
  createdAt_gt: DateTime
  createdAt_lt: DateTime
  reporterIp: String
  videoId: ID
}