@leosprograms/vf-graphql/build/agent.proposal.js

Reference GraphQL implementation of the ValueFlows spec

// Generated by scripts/build.js - edit the *.gql file instead!

module.exports = `
##
#
# Agent <> Proposal query API
#
# Provides information about the relationships between agents and proposals.
# Allows flagging Proposals for interest by agents who have an interest in
# completing them.
#
# @package  vf-graphql
# @since    2022-04-12
#
##

type Proposal {
  publishedTo: [ProposedTo!]

  "Grouping around something to create a boundary or context, used for documenting, accounting, planning."
  inScopeOf: [AccountingScope!]
}

##
#  API call input and output types
##

input ProposalCreateParams {
  "(\`AccountingScope\`) Grouping around something to create a boundary or context, used for documenting, accounting, planning."
  inScopeOf: [ID!]
}

input ProposalUpdateParams {
  "(\`AccountingScope\`) Grouping around something to create a boundary or context, used for documenting, accounting, planning."
  inScopeOf: [ID!]
}

"""
An agent to which the proposal is to be published.  A proposal can be published to many agents.
"""
type ProposedTo {
  id: ID!
  revisionId: ID!

  "The agent to which the proposal is published."
  proposedTo: Agent!

  "The proposal that is published to a specific agent."
  proposed: Proposal!
}

type ProposedToResponse {
  proposedTo: ProposedTo!
}

interface Agent {
  proposals(first: Int, after: String, last: Int, before: String): ProposalConnection
  proposalsInScope(first: Int, after: String, last: Int, before: String): ProposalConnection
  proposalsTo(first: Int, after: String, last: Int, before: String): ProposalConnection
}

type Person implements Agent {
  proposals(first: Int, after: String, last: Int, before: String): ProposalConnection
  proposalsInScope(first: Int, after: String, last: Int, before: String): ProposalConnection
  proposalsTo(first: Int, after: String, last: Int, before: String): ProposalConnection
}

type Organization implements Agent {
  proposals(first: Int, after: String, last: Int, before: String): ProposalConnection
  proposalsInScope(first: Int, after: String, last: Int, before: String): ProposalConnection
  proposalsTo(first: Int, after: String, last: Int, before: String): ProposalConnection
}

type Mutation {
  """
  Send a proposal to another agent.
  @param proposed the (\`Proposal\`) to send to an involved agent
  @param proposedTo the (\`Agent\`) to include in the proposal
  """
  proposeTo(proposed: ID!, proposedTo: ID!): ProposedToResponse!
  deleteProposedTo(revisionId: ID!): Boolean!
}

`