API Evangelist conversational phrasing for Thehiveryiq Com Tradefinance API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Thehiveryiq Com Tradefinance API
  version: 1.0.0
extends: openapi/thehiveryiq-com-tradefinance-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 12
- target: $.paths['/v1/tradefinance/template/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List trade finance contract templates
      effect: read
      questions:
      - Which trade finance contract templates are available to list?
      - Can I filter the template list by passing metadata?
      instructions:
      - text: List the trade finance templates.
      - text: List trade finance templates matching metadata {metadata}.
        slots:
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradefinance/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List the trade finance agents
      effect: read
      questions:
      - Which agents take part in a trade finance contract?
      - What roles do the trade finance agents play?
      instructions:
      - text: List the trade finance agents.
      - text: Show me the agents behind trade finance.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradefinance/template'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the trade finance contract template
      effect: read
      questions:
      - What fields does a trade finance contract need?
      - Can I see the default trade finance template before drafting a contract?
      instructions:
      - text: Get the trade finance contract template.
      - text: Show me the blank trade finance template.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradefinance/contract'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a trade finance contract
      effect: write
      questions:
      - How do I set up a trade finance contract between an importer and an exporter?
      - Can a contract specify Incoterms, ports, HS code and pickup and delivery windows?
      - Is a bank guarantor or bond required when creating a trade contract?
      instructions:
      - text: Create a trade contract from importer {importer_did} to exporter {exporter_did} for HS code {hs_code}.
        slots:
          importer_did: requestBody.importer_did
          exporter_did: requestBody.exporter_did
          hs_code: requestBody.hs_code
      - text: Draft a {incoterm} contract shipping from {origin_port} to {destination_port} worth {contract_value_usd} USD.
        slots:
          incoterm: requestBody.incoterm
          origin_port: requestBody.origin_port
          destination_port: requestBody.destination_port
          contract_value_usd: requestBody.contract_value_usd
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradefinance/contract/{contract_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a trade finance contract
      effect: read
      questions:
      - What are the terms and parties of a trade contract I already created?
      - Can I look up a trade finance contract by its ID?
      instructions:
      - text: Show me trade contract {contract_id}.
        slots:
          contract_id: path.contract_id
      - text: Get the details of contract {contract_id}.
        slots:
          contract_id: path.contract_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradefinance/fund'].post
  update:
    x-apievangelist-phrasing:
      intent: Fund a trade finance contract
      effect: write
      questions:
      - How do I put money into escrow for a trade contract?
      - Who can fund a trade finance contract?
      instructions:
      - text: Fund contract {contract_id} as {funder_did}.
        slots:
          contract_id: requestBody.contract_id
          funder_did: requestBody.funder_did
      - text: Have {funder_did} fund the escrow for contract {contract_id}.
        slots:
          contract_id: requestBody.contract_id
          funder_did: requestBody.funder_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradefinance/milestone-tick'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a shipment milestone on a contract
      effect: write
      questions:
      - How do I record that a shipment reached a milestone on a trade contract?
      - Can I attach evidence when ticking a contract milestone by hand?
      instructions:
      - text: Mark milestone {milestone} on contract {contract_id}.
        slots:
          milestone: requestBody.milestone
          contract_id: requestBody.contract_id
      - text: Tick {milestone} for contract {contract_id} with evidence {evidence}.
        slots:
          milestone: requestBody.milestone
          contract_id: requestBody.contract_id
          evidence: requestBody.evidence
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradefinance/escrow/{contract_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a contract's escrow
      effect: read
      questions:
      - How much is held in escrow for my trade contract, and has it settled?
      - What's the escrow state of a trade finance contract?
      instructions:
      - text: Show me the escrow for contract {contract_id}.
        slots:
          contract_id: path.contract_id
      - text: Check escrow status on contract {contract_id}.
        slots:
          contract_id: path.contract_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradefinance/dispute'].post
  update:
    x-apievangelist-phrasing:
      intent: File a dispute on a trade contract
      effect: write
      questions:
      - How do I raise a dispute when a shipment goes wrong?
      - Can I submit evidence along with a trade finance dispute?
      instructions:
      - text: File a dispute on contract {contract_id} for {dispute_condition} as {filer_did}.
        slots:
          contract_id: requestBody.contract_id
          dispute_condition: requestBody.dispute_condition
          filer_did: requestBody.filer_did
      - text: Dispute contract {contract_id} over {dispute_condition}, filed by {filer_did}, with evidence {evidence}.
        slots:
          contract_id: requestBody.contract_id
          dispute_condition: requestBody.dispute_condition
          filer_did: requestBody.filer_did
          evidence: requestBody.evidence
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradefinance/webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a shipment tracking event
      effect: write
      questions:
      - Can my freight tracking system push shipment events into trade finance?
      - What happens when a DELIVERED milestone or an exception event arrives by webhook?
      instructions:
      - text: Send this tracking event to the trade finance webhook.
      - text: Post a shipment exception event to the tracking webhook.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradefinance/dispute/{dispute_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a trade finance dispute
      effect: read
      questions:
      - What's the outcome of a trade dispute I filed?
      - Can I look up a trade finance dispute by its ID?
      instructions:
      - text: Show me dispute {dispute_id}.
        slots:
          dispute_id: path.dispute_id
      - text: Get the status of trade dispute {dispute_id}.
        slots:
          dispute_id: path.dispute_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tradefinance/economics'].get
  update:
    x-apievangelist-phrasing:
      intent: View trade finance economics
      effect: read
      questions:
      - What are the fees and economics of the trade finance service?
      - How does trade finance make money per contract?
      instructions:
      - text: Show me the trade finance economics.
      - text: Get the trade finance fee breakdown.
      method: generated
      generated: '2026-09-26'