# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for App Push Mobile Client Device API
  version: 1.0.0
extends: openapi/listrak-app-push-mobile-client-device-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: 4
- target: $.paths['/device'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a device for push notifications
      effect: write
      questions:
      - How do I register a new phone so my app can receive Listrak push notifications?
      - What do I need to send when registering a mobile device, like its token and platform?
      instructions:
      - text: Register a new device with push token {deviceToken} on platform {devicePlatformType}.
        slots:
          deviceToken: requestBody.deviceToken
          devicePlatformType: requestBody.devicePlatformType
      - text: Register device token {deviceToken} for {devicePlatformType} with push subscription set to {subscribed}.
        slots:
          deviceToken: requestBody.deviceToken
          devicePlatformType: requestBody.devicePlatformType
          subscribed: requestBody.subscribed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/device/{deviceUid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a registered push device
      effect: read
      questions:
      - Can I see what information is stored for a push device I registered?
      - What app version and OS does a registered device report?
      instructions:
      - text: Show me the stored details for push device {deviceUid}.
        slots:
          deviceUid: path.deviceUid
      - text: Look up which OS and app version device {deviceUid} is on.
        slots:
          deviceUid: path.deviceUid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/device/{deviceUid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a push device's registration
      effect: write
      questions:
      - How do I fully replace a device record with a new token and platform?
      - Can I overwrite every field on an existing push device registration at once?
      instructions:
      - text: Replace the whole registration for device {deviceUid} with token {deviceToken} on {devicePlatformType}.
        slots:
          deviceUid: path.deviceUid
          deviceToken: requestBody.deviceToken
          devicePlatformType: requestBody.devicePlatformType
      - text: Overwrite device {deviceUid} with a full update, setting subscribed to {subscribed}.
        slots:
          deviceUid: path.deviceUid
          subscribed: requestBody.subscribed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/device/{deviceUid}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a push device
      effect: write
      questions:
      - Can I change just one field on a push device, like its app version, without resending everything?
      - How do I unsubscribe a single device from push without replacing its whole record?
      instructions:
      - text: Patch only the app version of device {deviceUid} to {mobileAppVersion}.
        slots:
          deviceUid: path.deviceUid
          mobileAppVersion: requestBody.mobileAppVersion
      - text: Patch device {deviceUid} so it is no longer subscribed to push.
        slots:
          deviceUid: path.deviceUid
      method: generated
      generated: '2026-09-26'