# 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 Law API
  version: 1.0.0
extends: openapi/thehiveryiq-com-law-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: 18
- target: $.paths['/v1/law/freight/template/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List freight arbitration templates
      effect: read
      questions:
      - Which freight arbitration templates are available to list?
      - Can I pull the full list of freight arbitration terms before drafting a shipping contract?
      instructions:
      - text: List the freight arbitration templates.
      - text: List freight arbitration templates, passing {metadata} with the request.
        slots:
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List the freight law agents
      effect: read
      questions:
      - Which agents handle freight arbitration in the law service?
      - What agents sit behind the freight contract and dispute workflow?
      instructions:
      - text: Show me the agents that run freight arbitration.
      - text: List the freight law agents.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/freight/template'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the freight contract template
      effect: read
      questions:
      - What does the freight contract template look like before I file one?
      - What fields does the freight arbitration template expect for a shipment?
      instructions:
      - text: Fetch the freight contract template.
      - text: Show me the default freight arbitration template.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/freight/contract'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a bonded freight contract
      effect: write
      questions:
      - How do I set up a freight contract between a shipper, broker, carrier and consignee?
      - Can a freight contract carry a USDC bond alongside the agreed rate?
      - What details about the lane, pickup and delivery windows go into a freight contract?
      instructions:
      - text: Create a freight contract from {lane_origin} to {lane_dest} at {agreed_rate_usdc} USDC with a {bond_amount_usdc} USDC bond.
        slots:
          lane_origin: requestBody.lane_origin
          lane_dest: requestBody.lane_dest
          agreed_rate_usdc: requestBody.agreed_rate_usdc
          bond_amount_usdc: requestBody.bond_amount_usdc
      - text: Open a freight contract between shipper {shipper_did} and carrier {carrier_did} via broker {broker_did} for consignee {consignee_did}.
        slots:
          shipper_did: requestBody.shipper_did
          carrier_did: requestBody.carrier_did
          broker_did: requestBody.broker_did
          consignee_did: requestBody.consignee_did
      - text: Record a class {freight_class} shipment weighing {weight_lb} lb declared at {declared_value_usd} USD in a new freight contract.
        slots:
          freight_class: requestBody.freight_class
          weight_lb: requestBody.weight_lb
          declared_value_usd: requestBody.declared_value_usd
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/freight/contract/{contract_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a freight contract
      effect: read
      questions:
      - How can I look up the terms of a freight contract I already created?
      - Where do I see the parties and bond on an existing freight contract?
      instructions:
      - text: Show freight contract {contract_id}.
        slots:
          contract_id: path.contract_id
      - text: Pull up the details of freight contract {contract_id}.
        slots:
          contract_id: path.contract_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/freight/dispute'].post
  update:
    x-apievangelist-phrasing:
      intent: File a dispute on a freight contract
      effect: write
      questions:
      - How do I file a dispute against a freight contract when a shipment goes wrong?
      - Can I attach evidence when disputing a freight delivery?
      instructions:
      - text: File a freight dispute on contract {contract_id} for {dispute_condition}, filed by {filer_did}.
        slots:
          contract_id: requestBody.contract_id
          dispute_condition: requestBody.dispute_condition
          filer_did: requestBody.filer_did
      - text: Dispute freight contract {contract_id} as {filer_did} with evidence {evidence}.
        slots:
          contract_id: requestBody.contract_id
          filer_did: requestBody.filer_did
          evidence: requestBody.evidence
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/freight/webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a freight exception event by webhook
      effect: write
      questions:
      - Can I push freight exception events from Zapier or my ERP into the law service?
      - Where do broker freight exception webhooks get posted?
      instructions:
      - text: Post this freight exception event to the freight webhook.
      - text: Forward our shipment exception alert to the freight exception webhook.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/freight/dispute/{dispute_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a freight dispute
      effect: read
      questions:
      - How do I check where a freight dispute stands?
      - What was decided on the freight dispute I filed?
      instructions:
      - text: Show freight dispute {dispute_id}.
        slots:
          dispute_id: path.dispute_id
      - text: Check the status of freight dispute {dispute_id}.
        slots:
          dispute_id: path.dispute_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/freight/economics'].get
  update:
    x-apievangelist-phrasing:
      intent: View freight arbitration economics
      effect: read
      questions:
      - What are the economics of the freight arbitration service?
      - How much revenue does freight arbitration generate?
      instructions:
      - text: Show me the freight arbitration economics.
      - text: Report the freight dispute economics.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/insurance/template/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List insurance arbitration templates
      effect: read
      questions:
      - Which insurance claim arbitration templates can I list?
      - Can I see every insurance arbitration template before opening a claim contract?
      instructions:
      - text: List the insurance arbitration templates.
      - text: List insurance arbitration templates, sending {metadata} with the call.
        slots:
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/insurance/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List the insurance law agents
      effect: read
      questions:
      - Which agents run insurance claim arbitration?
      - What agents are involved in the insurance dispute workflow?
      instructions:
      - text: Show me the agents that handle insurance arbitration.
      - text: List the insurance law agents.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/insurance/template'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the insurance claim contract template
      effect: read
      questions:
      - What does the insurance claim contract template contain?
      - What fields does an insurance arbitration contract need?
      instructions:
      - text: Fetch the insurance claim contract template.
      - text: Show me the default insurance arbitration template.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/insurance/contract'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an insurance claim contract
      effect: write
      questions:
      - How do I register an insurance claim for arbitration between insured and insurer?
      - Can I record a policy's coverage limit and deductible along with the claim?
      - What has to be bonded by the insurer when opening an insurance claim contract?
      instructions:
      - text: Open an insurance claim contract for policy {policy_id}, claim {claim_id}, claiming {claimed_amount_usdc} USDC.
        slots:
          policy_id: requestBody.policy_id
          claim_id: requestBody.claim_id
          claimed_amount_usdc: requestBody.claimed_amount_usdc
      - text: Create an insurance contract between insured {insured_did} and insurer {insurer_did} with adjuster {claims_adjuster_agent_did}.
        slots:
          insured_did: requestBody.insured_did
          insurer_did: requestBody.insurer_did
          claims_adjuster_agent_did: requestBody.claims_adjuster_agent_did
      - text: File a {claim_type} claim from {incident_date} under a {coverage_limit_usdc} USDC limit and {deductible_usdc} USDC deductible.
        slots:
          claim_type: requestBody.claim_type
          incident_date: requestBody.incident_date
          coverage_limit_usdc: requestBody.coverage_limit_usdc
          deductible_usdc: requestBody.deductible_usdc
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/insurance/contract/{contract_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an insurance claim contract
      effect: read
      questions:
      - How can I review an insurance claim contract I already opened?
      - Where do I see the coverage and claim amount on an existing insurance contract?
      instructions:
      - text: Show insurance contract {contract_id}.
        slots:
          contract_id: path.contract_id
      - text: Pull up the details of insurance claim contract {contract_id}.
        slots:
          contract_id: path.contract_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/insurance/dispute'].post
  update:
    x-apievangelist-phrasing:
      intent: Dispute an insurance claim decision
      effect: write
      questions:
      - How do I dispute a denied insurance claim?
      - Can I challenge the amount an adjuster proposed on my insurance claim?
      instructions:
      - text: Dispute insurance contract {contract_id} as {filer_did}.
        slots:
          contract_id: requestBody.contract_id
          filer_did: requestBody.filer_did
      - text: Challenge the adjuster's {adjuster_proposed_usdc} USDC offer on insurance contract {contract_id} filed by {filer_did}.
        slots:
          adjuster_proposed_usdc: requestBody.adjuster_proposed_usdc
          contract_id: requestBody.contract_id
          filer_did: requestBody.filer_did
      - text: Contest the claim denial reason {denial_reason_claimed} on insurance contract {contract_id} from {filer_did}.
        slots:
          denial_reason_claimed: requestBody.denial_reason_claimed
          contract_id: requestBody.contract_id
          filer_did: requestBody.filer_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/insurance/webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an insurance exception event by webhook
      effect: write
      questions:
      - Can an MGA push insurance claim exception events into the law service?
      - Where do insurance exception webhooks get posted?
      instructions:
      - text: Post this insurance exception event to the insurance webhook.
      - text: Forward our claims exception alert to the insurance exception webhook.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/insurance/dispute/{dispute_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an insurance dispute
      effect: read
      questions:
      - How do I check the outcome of an insurance claim dispute?
      - Where can I see the status of the insurance dispute I raised?
      instructions:
      - text: Show insurance dispute {dispute_id}.
        slots:
          dispute_id: path.dispute_id
      - text: Check the status of insurance dispute {dispute_id}.
        slots:
          dispute_id: path.dispute_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/law/insurance/economics'].get
  update:
    x-apievangelist-phrasing:
      intent: View insurance arbitration economics
      effect: read
      questions:
      - What are the economics of the insurance arbitration service?
      - How much revenue does insurance claim arbitration bring in?
      instructions:
      - text: Show me the insurance arbitration economics.
      - text: Report the insurance dispute economics.
      method: generated
      generated: '2026-09-26'