# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mobile Notifications API
  version: 1.0.0
extends: openapi/punchh-notifications-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: 5
- target: $.paths['/api2/mobile/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List a guest's push notifications
      effect: read
      questions:
      - Which push notifications has a guest received in the app?
      - Can I limit how many notifications come back?
      instructions:
      - text: Show my latest notifications.
      - text: Fetch my {qty} most recent push notifications.
        slots:
          qty: requestBody.qty
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/notifications/id'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a guest's notification
      effect: destructive
      questions:
      - How does a guest clear a notification from their inbox?
      - Can a single push notification be removed from the app?
      instructions:
      - text: Delete notification {id}.
        slots:
          id: path.id
      - text: Remove push notification {id} from my inbox.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List rich messages for a guest
      effect: read
      questions:
      - What rich messages are available for a guest to view in the app?
      - Where does the app get the styling to render a rich message?
      instructions:
      - text: Fetch my rich messages.
      - text: List rich messages for app client {client}.
        slots:
          client: requestBody.client
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/message_readerships'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark rich messages as read
      effect: write
      questions:
      - Can I mark a guest's user-specific rich messages as read?
      - Which rich message types support read receipts?
      instructions:
      - text: Mark rich messages {messages} as read.
        slots:
          messages: requestBody.user_rich_notifications
      - text: Record that I've read message {messages}.
        slots:
          messages: requestBody.user_rich_notifications
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/message_readerships/{message_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a rich message
      effect: destructive
      questions:
      - How does a guest dismiss a user-specific rich message for good?
      - Can rich messages be deleted from the app?
      instructions:
      - text: Delete rich message {message_id}.
        slots:
          message_id: path.message_id
      - text: Dismiss message {message_id} from my message center.
        slots:
          message_id: path.message_id
      method: generated
      generated: '2026-10-01'