# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mobile Invitations API
  version: 1.0.0
extends: openapi/punchh-invitations-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/invitations'].get
  update:
    x-apievangelist-phrasing:
      intent: List a guest's pending invitations
      effect: read
      questions:
      - Which gift card invitations are still waiting for this guest?
      - Can I see all pending invitations a user has?
      instructions:
      - text: List my pending invitations.
      - text: Show the guest's open gift card invitations for client {client}.
        slots:
          client: requestBody.client
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/invitations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a claim token to hand off a gift card
      effect: write
      questions:
      - How do I generate a claim link or token so someone else can take my gift card?
      - What's the first step to transfer a gift card through an invitation?
      instructions:
      - text: Create a claim token for gift card {uuid}.
        slots:
          uuid: requestBody.uuid
      - text: Generate an invitation claim token so gift card {uuid} can be transferred.
        slots:
          uuid: requestBody.uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/invitations/check_status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a gift card claim token is valid
      effect: read
      questions:
      - Is this gift card claim token still valid?
      - Can I check a claim token's status before redeeming it?
      instructions:
      - text: Check the status of claim token {claim_token}.
        slots:
          claim_token: requestBody.claim_token
      - text: Is claim token {claim_token} still usable? Verify it.
        slots:
          claim_token: requestBody.claim_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/invitations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a gift card invitation
      effect: destructive
      questions:
      - How do I cancel a gift card invitation I sent by mistake?
      - Does deleting an invitation also remove its claim token?
      instructions:
      - text: Delete invitation {id} and its claim token.
        slots:
          id: path.id
      - text: Cancel gift card invitation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/invitations/transfer'].patch
  update:
    x-apievangelist-phrasing:
      intent: Claim a gift card with an invitation token
      effect: write
      questions:
      - How does the recipient accept a gift card that was sent with a claim token?
      - Can a gift card be moved to my account using an invitation token?
      instructions:
      - text: Claim the gift card using token {claim_token}.
        slots:
          claim_token: requestBody.claim_token
      - text: Transfer the invited gift card to me with claim token {claim_token}.
        slots:
          claim_token: requestBody.claim_token
      method: generated
      generated: '2026-10-01'