# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Square Cash Drawers API
  version: 1.0.0
extends: openapi/square-cash-drawers-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/cash-drawers/shifts'].get
  update:
    x-apievangelist-phrasing:
      intent: List cash drawer shifts
      effect: read
      questions:
      - How do I see all cash drawer shifts at a location for last month?
      - Can I list drawer shifts within a date range?
      instructions:
      - text: List cash drawer shifts at location {location_id}.
        slots:
          location_id: query.location_id
      - text: Show drawer shifts at {location_id} from {begin_time} to {end_time}.
        slots:
          location_id: query.location_id
          begin_time: query.begin_time
          end_time: query.end_time
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/cash-drawers/shifts/{shift_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a cash drawer shift summary
      effect: read
      questions:
      - What were the expected and counted cash amounts for one drawer shift?
      - How do I get the summary of a single cash drawer shift?
      instructions:
      - text: Get cash drawer shift {shift_id} at location {location_id}.
        slots:
          shift_id: path.shift_id
          location_id: query.location_id
      - text: Show the summary of drawer shift {shift_id} for {location_id}.
        slots:
          shift_id: path.shift_id
          location_id: query.location_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/cash-drawers/shifts/{shift_id}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events in a cash drawer shift
      effect: read
      questions:
      - Which cash payments, paid-ins and paid-outs happened during a drawer shift?
      - Can I page through the event log of one cash drawer shift?
      instructions:
      - text: List events for drawer shift {shift_id} at location {location_id}.
        slots:
          shift_id: path.shift_id
          location_id: query.location_id
      - text: Show the activity log of shift {shift_id} at {location_id}.
        slots:
          shift_id: path.shift_id
          location_id: query.location_id
      method: generated
      generated: '2026-10-01'