# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Unity Economy Currencies API
  version: 1.0.0
extends: openapi/unity-currencies-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v2/projects/{projectId}/environments/{environmentId}/players/{playerId}/currencies'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a player's currency balances
      effect: read
      questions:
      - How many coins and gems does a particular player have?
      - Can I see all of a player's in-game currency balances?
      instructions:
      - text: Show currency balances for player {playerId} in project {projectId}, environment {environmentId}.
        slots:
          playerId: path.playerId
          projectId: path.projectId
          environmentId: path.environmentId
      - text: Get all currencies held by {playerId} (project {projectId}, env {environmentId}).
        slots:
          playerId: path.playerId
          projectId: path.projectId
          environmentId: path.environmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectId}/environments/{environmentId}/players/{playerId}/currencies/{currencyId}/increment'].post
  update:
    x-apievangelist-phrasing:
      intent: Add currency to a player's balance
      effect: write
      questions:
      - Can I grant a player extra coins as a reward?
      - Is there a write lock to avoid conflicting balance increases?
      instructions:
      - text: Give player {playerId} {amount} of currency {currencyId} in project {projectId}, environment {environmentId}.
        slots:
          playerId: path.playerId
          amount: requestBody.amount
          currencyId: path.currencyId
          projectId: path.projectId
          environmentId: path.environmentId
      - text: Increase {playerId}'s {currencyId} balance by {amount} using write lock {writeLock} (project {projectId}, env {environmentId}).
        slots:
          playerId: path.playerId
          currencyId: path.currencyId
          amount: requestBody.amount
          writeLock: requestBody.writeLock
          projectId: path.projectId
          environmentId: path.environmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectId}/environments/{environmentId}/players/{playerId}/currencies/{currencyId}/decrement'].post
  update:
    x-apievangelist-phrasing:
      intent: Deduct currency from a player's balance
      effect: write
      questions:
      - Can I take coins away from a player's balance?
      - What call reduces a player's currency when they spend it?
      instructions:
      - text: Deduct {amount} of {currencyId} from player {playerId} in project {projectId}, environment {environmentId}.
        slots:
          amount: requestBody.amount
          currencyId: path.currencyId
          playerId: path.playerId
          projectId: path.projectId
          environmentId: path.environmentId
      - text: Decrease {playerId}'s {currencyId} balance by {amount} with write lock {writeLock} (project {projectId}, env {environmentId}).
        slots:
          playerId: path.playerId
          currencyId: path.currencyId
          amount: requestBody.amount
          writeLock: requestBody.writeLock
          projectId: path.projectId
          environmentId: path.environmentId
      method: generated
      generated: '2026-10-01'