schema.graphql

directive @oneOf on INPUT_OBJECT

type AppEnumCollection {
  QuestionTypeEnum: [AppEnumCollectionQuestionTypeEnum!]!
  OrdinalTypeEnum: [AppEnumCollectionOrdinalTypeEnum!]!
}

type AppEnumCollectionOrdinalTypeEnum {
  key: OrdinalTypeEnum!
  label: String!
  value: Int!
}

type AppEnumCollectionQuestionTypeEnum {
  key: QuestionTypeEnum!
  label: String!
  value: Int!
}

"""Model representing case study of national society for specific tool."""
input CaseStudyFilter {
  id: ID
  tool: ToolFilter
  AND: CaseStudyFilter
  OR: CaseStudyFilter
  NOT: CaseStudyFilter
  DISTINCT: Boolean
}

input CaseStudyOrder @oneOf {
  id: Ordering
}

"""Model representing case study of national society for specific tool."""
type CaseStudyType {
  id: ID!
  title: String!
  toolId: ID!
  content: String!
  coverImage: DjangoFileType
  link: String!
}

type CaseStudyTypeOffsetPaginated {
  pageInfo: OffsetPaginationInfo!

  """Total count of existing results."""
  totalCount: Int!

  """List of paginated results."""
  results: [CaseStudyType!]!
}

"""Model representing catalog where a tool belongs to."""
input CatalogFilter {
  id: ID
  showInHelpMeChoose: Boolean
  AND: CatalogFilter
  OR: CatalogFilter
  NOT: CatalogFilter
  DISTINCT: Boolean
}

input CatalogOrder @oneOf {
  id: Ordering
}

"""Model representing catalog where a tool belongs to."""
type CatalogType {
  id: ID!
  name: String!
  showInHelpMeChoose: Boolean!
  description: String!
  questions: [QuestionType!]!
}

type CatalogTypeOffsetPaginated {
  pageInfo: OffsetPaginationInfo!

  """Total count of existing results."""
  totalCount: Int!

  """List of paginated results."""
  results: [CatalogType!]!
}

"""Model representing option of checkbox question."""
type CheckboxOptionType {
  id: ID!
  question: QuestionTitleType!
  order: Int!
  text: String!
}

input ContactRequestInput {
  name: String!
  email: String!
  nationalSociety: String!
  content: String!
  captchaHashkey: String!
  captchaCode: String!
}

"""Model representing contact where anyone can react out to the admins."""
type ContactRequestType {
  id: ID!
  name: String!
  email: String!
  createdAt: DateTime!
  content: String
  nationalSociety: String!
}

type ContactRequestTypeMutationResponseType {
  ok: Boolean!
  errors: CustomErrorType
  result: ContactRequestType
}

union CreateContactRequestPayload = ContactRequestTypeMutationResponseType | OperationInfo

union CreateDemoRequestPayload = RequestDemoTypeMutationResponseType | OperationInfo

union CreateUserSubmissionPayload = UserSubmissionTypeMutationResponseType | OperationInfo

"""A generic type to return error messages"""
scalar CustomErrorType

"""Date with time (isoformat)"""
scalar DateTime

type DjangoFileType {
  name: String!
  size: Int!
  url: String!
}

type DjangoModelType {
  pk: ID!
}

type Mutation {
  createContactRequest(data: ContactRequestInput!): CreateContactRequestPayload!
  createDemoRequest(data: RequestDemoInput!): CreateDemoRequestPayload!
  createUserSubmission(data: UserSubmissionInput!): CreateUserSubmissionPayload!
}

type OffsetPaginationInfo {
  offset: Int!
  limit: Int
}

input OffsetPaginationInput {
  offset: Int! = 0
  limit: Int
}

type OperationInfo {
  """List of messages returned by the operation."""
  messages: [OperationMessage!]!
}

type OperationMessage {
  """The kind of this message."""
  kind: OperationMessageKind!

  """The error message."""
  message: String!

  """
  The field that caused the error, or `null` if it isn't associated with any particular field.
  """
  field: String

  """The error code, or `null` if no error code was set."""
  code: String
}

enum OperationMessageKind {
  INFO
  WARNING
  ERROR
  PERMISSION
  VALIDATION
}

enum Ordering {
  ASC
  ASC_NULLS_FIRST
  ASC_NULLS_LAST
  DESC
  DESC_NULLS_FIRST
  DESC_NULLS_LAST
}

enum OrdinalTypeEnum {
  NOT_AVAILABLE
  ONE
  TWO
  THREE
  FOUR
}

type Query {
  catalogs(pagination: OffsetPaginationInput, filters: CatalogFilter, order: CatalogOrder): CatalogTypeOffsetPaginated!
  catalog(id: ID!): CatalogType!
  tools(pagination: OffsetPaginationInput, filters: ToolFilter, order: ToolOrder): ToolTypeOffsetPaginated!
  tool(id: ID!): ToolType!
  recommendationResults(pagination: OffsetPaginationInput, filters: RecommendationResultFilter, order: RecommendationResultOrder): RecommendationResultTypeOffsetPaginated!
  recommendationResult(id: ID!): RecommendationResultType!
  caseStudies(pagination: OffsetPaginationInput, filters: CaseStudyFilter, order: CaseStudyOrder): CaseStudyTypeOffsetPaginated!
  caseStudy(id: ID!): CaseStudyType!
  me: UserMeType
  enums: AppEnumCollection!
}

"""Model representing question within a catalog."""
type QuestionTitleType {
  id: ID!
  title: String!
  questionType: QuestionTypeEnum!
  description: String!
  order: Int!
}

"""Model representing question within a catalog."""
type QuestionType {
  id: ID!
  catalogId: ID!
  questionType: QuestionTypeEnum!
  title: String!
  description: String!
  order: Int!
  labelNa: String!
  label1: String!
  label2: String!
  label3: String!
  label4: String!
  options: [CheckboxOptionType!]!
}

enum QuestionTypeEnum {
  ORDINAL
  CHECKBOX
}

"""Model representing recommended tools for a submission."""
input RecommendationResultFilter {
  id: ID
  submission: UserSubmissionFilter
  AND: RecommendationResultFilter
  OR: RecommendationResultFilter
  NOT: RecommendationResultFilter
  DISTINCT: Boolean
}

input RecommendationResultOrder @oneOf {
  id: Ordering
  rank: Ordering
}

"""Model representing recommended tools for a submission."""
type RecommendationResultType {
  id: ID!
  submission: UserSubmissionType!
  rank: Int!

  """Proximity score - lower is better (closer match)"""
  score: Float!
  tool: ToolType!
}

type RecommendationResultTypeOffsetPaginated {
  pageInfo: OffsetPaginationInfo!

  """Total count of existing results."""
  totalCount: Int!

  """List of paginated results."""
  results: [RecommendationResultType!]!
}

input RequestDemoInput {
  name: String!
  email: String!
  content: String!
  nationalSociety: String!
  tool: Int!
  captchaHashkey: String!
  captchaCode: String!
}

"""
Model representing contact where anyone can request the tool demo to the admins.
"""
type RequestDemoType {
  id: ID!
  name: String!
  email: String!
  createdAt: DateTime!
  content: String
  nationalSociety: String!
  tool: DjangoModelType!
}

type RequestDemoTypeMutationResponseType {
  ok: Boolean!
  errors: CustomErrorType
  result: RequestDemoType
}

"""Model representing tool's selection of question and its answer."""
type ToolAnswerType {
  id: ID!
  toolId: ID!
  question: QuestionTitleType!
  description: String!
  ordinalValue: Int
  selectedOptions: [CheckboxOptionType!]!
}

"""Model representing tool."""
input ToolFilter {
  id: ID
  catalogs: CatalogFilter
  AND: ToolFilter
  OR: ToolFilter
  NOT: ToolFilter
  DISTINCT: Boolean
}

input ToolOrder @oneOf {
  id: Ordering
}

"""Model representing tool."""
type ToolType {
  id: ID!
  catalogs: [CatalogType!]!
  name: String!
  tagline: String!
  description: String!
  videoLink: String
  toolLink: String
  logo: DjangoFileType
  answers: [ToolAnswerType!]!
}

type ToolTypeOffsetPaginated {
  pageInfo: OffsetPaginationInfo!

  """Total count of existing results."""
  totalCount: Int!

  """List of paginated results."""
  results: [ToolType!]!
}

input UserAnswerInput {
  question: ID!
  ordinalValue: Int
  selectedOptions: [ID!]
}

"""Model representing a user's answer to a specific question."""
type UserAnswerType {
  question: QuestionTitleType!
  ordinalValue: Int
  selectedOptions: [CheckboxOptionType!]!
}

"""Custom user model with email as unique identifier."""
type UserMeType {
  id: ID!
  firstName: String!
  lastName: String!
  displayName: String!
  anonymizedEmail: String!
  email: String!
}

"""Model representing a user's submission of answers for a catalog."""
input UserSubmissionFilter {
  id: ID
  AND: UserSubmissionFilter
  OR: UserSubmissionFilter
  NOT: UserSubmissionFilter
  DISTINCT: Boolean
}

input UserSubmissionInput {
  catalog: ID!
  answers: [UserAnswerInput!]!
}

type UserSubmissionType {
  id: ID!
  catalogId: ID!
  answers: [UserAnswerType!]!
}

type UserSubmissionTypeMutationResponseType {
  ok: Boolean!
  errors: CustomErrorType
  result: UserSubmissionType
}