API Evangelist conversational phrasing for Storefront V1 API Specification Loyalty API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Storefront V1 API Specification Loyalty API
  version: 1.0.0
extends: openapi/doordash-loyalty-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: 9
- target: $.paths['/storefront/api/v1/loyalty/get_balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's loyalty balance
      effect: read
      questions:
      - How many loyalty points does a user have?
      - Can I check a user's loyalty balance with the loyalty provider?
      instructions:
      - text: Get the loyalty balance for user {external_user_id} on provider {provider}.
        slots:
          external_user_id: query.external_user_id
          provider: query.provider
      - text: Check how many points user {external_user_id} has with reference {provider_reference_id}.
        slots:
          external_user_id: query.external_user_id
          provider_reference_id: query.provider_reference_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/storefront/api/v1/loyalty/profile'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a user's loyalty member profile
      effect: read
      questions:
      - What's in a user's loyalty member profile?
      - Can I include loyalty info when fetching a member profile?
      instructions:
      - text: Get the loyalty member profile for session {session_id}.
        slots:
          session_id: requestBody.session_id
      - text: Fetch the member profile with loyalty info for session {session_id} on integration {integration_id}.
        slots:
          session_id: requestBody.session_id
          integration_id: requestBody.integration_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/storefront/api/v1/loyalty/revoke_session'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a user's loyalty session
      effect: destructive
      questions:
      - How do I log a user out of the loyalty provider?
      - Can I revoke a user's loyalty session?
      instructions:
      - text: Revoke loyalty session {session_id} for integration {integration_id}.
        slots:
          session_id: requestBody.session_id
          integration_id: requestBody.integration_id
      - text: Log session {session_id} out of the loyalty provider.
        slots:
          session_id: requestBody.session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/storefront/api/v1/loyalty/delete_account'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a user's account
      effect: destructive
      questions:
      - How do I delete a user's loyalty account?
      - Can a user permanently close their account from the app?
      instructions:
      - text: Delete the account for session {session_id} on integration {integration_id}.
        slots:
          session_id: requestBody.session_id
          integration_id: requestBody.integration_id
      - text: Permanently remove the user account behind session {session_id}.
        slots:
          session_id: requestBody.session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/storefront/api/v1/loyalty/session'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a user's loyalty session info
      effect: read
      questions:
      - What session info does the loyalty provider hold for a user?
      - Is a user's loyalty session still valid?
      instructions:
      - text: Get loyalty session info for {session_id}.
        slots:
          session_id: requestBody.session_id
      - text: Look up session {session_id} with the loyalty provider on integration {integration_id}.
        slots:
          session_id: requestBody.session_id
          integration_id: requestBody.integration_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/storefront/api/v1/loyalty/qr_code'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a user's loyalty QR code
      effect: read
      questions:
      - Where do I get a user's loyalty QR code to show at a store?
      - Can I set the size of the loyalty QR code image?
      instructions:
      - text: Generate a loyalty QR code for session {session} at store {store_id}.
        slots:
          session: requestBody.session
          store_id: requestBody.store_id
      - text: Make a {width}x{height} loyalty QR code for session {session} at store {store_id}.
        slots:
          width: requestBody.width
          height: requestBody.height
          session: requestBody.session
          store_id: requestBody.store_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/storefront/api/v1/loyalty/get_user_rewards'].post
  update:
    x-apievangelist-phrasing:
      intent: List a user's loyalty rewards at a store
      effect: read
      questions:
      - Which loyalty rewards can a user redeem at a store?
      - Can I see a user's rewards for one particular store?
      instructions:
      - text: List loyalty rewards for session {session_id} at store {store_id}.
        slots:
          session_id: requestBody.session_id
          store_id: requestBody.store_id
      - text: Show the rewards available to session {session_id} at store {store_id}.
        slots:
          session_id: requestBody.session_id
          store_id: requestBody.store_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/storefront/api/v1/loyalty/store/check_in'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a user in at a store for points
      effect: write
      questions:
      - How does a user check in at a store to earn loyalty points?
      - Can I pass the user's location when checking in?
      instructions:
      - text: Check session {session} in at store {store_id}.
        slots:
          session: requestBody.session
          store_id: requestBody.store_id
      - text: Check in session {session} at store {store_id} from {latitude},{longitude}.
        slots:
          session: requestBody.session
          store_id: requestBody.store_id
          latitude: requestBody.latitude
          longitude: requestBody.longitude
      method: generated
      generated: '2026-09-26'
- target: $.paths['/storefront/api/v1/loyalty/store/redeem'].post
  update:
    x-apievangelist-phrasing:
      intent: Redeem a loyalty reward in store
      effect: write
      questions:
      - How do I redeem a customer's loyalty reward in store?
      - Can a customer use a loyalty promotion at the counter?
      instructions:
      - text: Redeem reward {promotion_id} for session {session}.
        slots:
          promotion_id: requestBody.promotion_id
          session: requestBody.session
      - text: Apply loyalty reward {promotion_id} in store for session {session}.
        slots:
          promotion_id: requestBody.promotion_id
          session: requestBody.session
      method: generated
      generated: '2026-09-26'