@valueflows/vf-graphql/build/commitment.js

Reference GraphQL implementation of the ValueFlows spec

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

module.exports = `
##
#
# Commitment module
#
# @depends  action.gql
# @depends  measurement.gql
# @package  vf-graphql
# @since    2019-02-11
#
##

"""
A planned economic flow that has been promised by an agent to another agent.
"""
type Commitment {
  id: ID!
  revisionId: ID!

  "Relates a commitment to a verb, such as consume, produce, work, improve, etc."
  action: Action!

  "References a concept in a common taxonomy or other classification scheme for purposes of categorization or grouping."
  resourceClassifiedAs: [URI!]

  "The amount and unit of the economic resource counted or inventoried."
  resourceQuantity: Measure

  "The amount and unit of the work or use or citation effort-based action. This is often a time duration, but also could be cycle counts or other measures of effort or usefulness."
  effortQuantity: Measure

  "The planned beginning of the commitment."
  hasBeginning: DateTime

  "The planned end of the commitment."
  hasEnd: DateTime

  "The planned date/time for the commitment. Can be used instead of beginning and end."
  hasPointInTime: DateTime

  "The time something is expected to be complete."
  due: DateTime

  "The creation time of the commitment."
  created: DateTime

  "The commitment is complete or not.  This is irrespective of if the original goal has been met, and indicates that no more will be done."
  finished: Boolean

  "A textual description or comment."
  note: String

  "Reference to an agreement between agents which specifies the rules or policies or calculations which govern this commitment."
  agreedIn: URI

  "The commitment can be safely deleted, has no dependent information."
  deletable: Boolean

  "The intent which this commitment satisfies."
  satisfies: Intent
}

##
# API input and output types
##

input CommitmentCreateParams {
  "(\`Action\`) Relates a commitment to a verb, such as consume, produce, work, improve, etc."
  action: ID!

  "References a concept in a common taxonomy or other classification scheme for purposes of categorization or grouping."
  resourceClassifiedAs: [URI!]

  "The amount and unit of the economic resource counted or inventoried."
  resourceQuantity: IMeasure

  "The amount and unit of the work or use or citation effort-based action. This is often a time duration, but also could be cycle counts or other measures of effort or usefulness."
  effortQuantity: IMeasure

  "The planned beginning of the commitment."
  hasBeginning: DateTime

  "The planned end of the commitment."
  hasEnd: DateTime

  "The planned date/time for the commitment. Can be used instead of beginning and end."
  hasPointInTime: DateTime

  "The time something is expected to be complete."
  due: DateTime

  "The commitment is complete or not.  This is irrespective of if the original goal has been met, and indicates that no more will be done."
  finished: Boolean

  "A textual description or comment."
  note: String

  "Reference to an agreement between agents which specifies the rules or policies or calculations which govern this commitment."
  agreedIn: URI

  "The intent which this commitment satisfies."
  satisfies: ID
}

input CommitmentUpdateParams {
  revisionId: ID!

  "References a concept in a common taxonomy or other classification scheme for purposes of categorization or grouping."
  resourceClassifiedAs: [URI!]

  "The amount and unit of the economic resource counted or inventoried."
  resourceQuantity: IMeasure

  "The amount and unit of the work or use or citation effort-based action. This is often a time duration, but also could be cycle counts or other measures of effort or usefulness."
  effortQuantity: IMeasure

  "The planned beginning of the commitment."
  hasBeginning: DateTime

  "The planned end of the commitment."
  hasEnd: DateTime

  "The planned date/time for the commitment. Can be used instead of beginning and end."
  hasPointInTime: DateTime

  "The time something is expected to be complete."
  due: DateTime

  "The commitment is complete or not.  This is irrespective of if the original goal has been met, and indicates that no more will be done."
  finished: Boolean

  "A textual description or comment."
  note: String

  "Reference to an agreement between agents which specifies the rules or policies or calculations which govern this commitment."
  agreedIn: URI

  "The intent which this commitment satisfies."
  satisfies: ID
}

type CommitmentResponse {
  commitment: Commitment!
}

type CommitmentConnection {
  edges: [CommitmentEdge!]!
  pageInfo: PageInfo!
}

type CommitmentEdge {
  node: Commitment!
  cursor: String!
}

type Query {
  commitment(id: ID!): Commitment
  commitments(
    first: Int
    after: String
    last: Int
    before: String
  ): CommitmentConnection!
}

type Mutation {
  createCommitment(commitment: CommitmentCreateParams!): CommitmentResponse!
  updateCommitment(commitment: CommitmentUpdateParams!): CommitmentResponse!
  deleteCommitment(revisionId: ID!): Boolean!
}

`