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

Reference GraphQL implementation of the ValueFlows spec

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

module.exports = `
##
#
# Claim module
#
# Facilitates claiming of future events in return for contributions already given.
#
# @package  vf-graphql
# @since    2019-02-11
#
##

"""
A claim for a future economic event(s) in reciprocity for an economic event that already occurred. For example, a claim for payment for goods received.
"""
type Claim {
  id: ID!
  revisionId: ID!

  "Relates a claim 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 economic event which already occurred which this claim has been made against."
  triggeredBy: EconomicEvent!

  "The time the claim is expected to be settled."
  due: DateTime

  "The data on which the claim was made."
  created: DateTime

  "The claim 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 claim."
  agreedIn: URI

  # inverse relationships and queries

  settledBy(first: Int, after: String, last: Int, before: String): SettlementConnection
}

"""
Represents many-to-many relationships between claim and economic events that fully or partially settle one or more claims.
"""
type Settlement {
  id: ID!
  revisionId: ID!

  "A claim which is fully or partially settled by an economic event."
  settles: Claim!

  "The economic event fully or partially settling a claim."
  settledBy: EconomicEvent!

  "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

  "A textual description or comment."
  note: String
}



input ClaimCreateParams {
  "(\`Action\`) Relates a claim 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 time the claim is expected to be settled."
  due: DateTime

  "(\`EconomicEvent\`) The economic event which already occurred which this claim has been made against."
  triggeredBy: ID!

  "The data on which the claim was made."
  created: DateTime

  "The claim 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 claim."
  agreedIn: URI
}

input ClaimUpdateParams {
  revisionId: ID!

  "(\`Action\`) Relates a claim 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 time the claim is expected to be settled."
  due: DateTime

  "(\`EconomicEvent\`) The economic event which already occurred which this claim has been made against."
  triggeredBy: ID

  "The data on which the claim was made."
  created: DateTime

  "The claim 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 claim."
  agreedIn: URI
}

type ClaimResponse {
  claim: Claim!
}



input SettlementCreateParams {
  "(\`Claim\`) A claim which is fully or partially settled by an economic event."
  settles: ID!

  "(\`EconomicEvent\`) The economic event fully or partially settling a claim."
  settledBy: ID!

  "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

  "A textual description or comment."
  note: String
}

input SettlementUpdateParams {
  revisionId: ID!

  "(\`Claim\`) A claim which is fully or partially settled by an economic event."
  settles: ID

  "(\`EconomicEvent\`) The economic event fully or partially settling a claim."
  settledBy: ID

  "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

  "A textual description or comment."
  note: String
}

type SettlementResponse {
  settlement: Settlement!
}



type ClaimConnection {
  edges: [ClaimEdge!]!
  pageInfo: PageInfo!
}

type ClaimEdge {
  node: Claim!
  cursor: String!
}

type SettlementConnection {
  edges: [SettlementEdge!]!
  pageInfo: PageInfo!
}

type SettlementEdge {
  node: Settlement!
  cursor: String!
}

type Query {
  claim(id: ID!): Claim
  claims(first: Int, after: String, last: Int, before: String): ClaimConnection!

  settlement(id: ID!): Settlement
  settlements(first: Int, after: String, last: Int, before: String): SettlementConnection!
}

type Mutation {
  createClaim(claim: ClaimCreateParams!): ClaimResponse!
  updateClaim(claim: ClaimUpdateParams!): ClaimResponse!
  deleteClaim(revisionId: ID!): Boolean!

  createSettlement(settlement: SettlementCreateParams!): SettlementResponse!
  updateSettlement(settlement: SettlementUpdateParams!): SettlementResponse!
  deleteSettlement(revisionId: ID!): Boolean!
}

`