# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Iterable In App API
  version: 1.0.0
extends: openapi/iterable-in-app-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['/api/inApp/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a scheduled in-app message
      effect: destructive
      questions:
      - Can I cancel an in-app message that's scheduled for one user?
      - What identifies the in-app message I want to cancel?
      instructions:
      - text: Cancel the in-app message from campaign {campaignId} to {email}.
        slots:
          campaignId: requestBody.campaignId
          email: requestBody.email
      - text: Cancel scheduled in-app message {scheduledMessageId}.
        slots:
          scheduledMessageId: requestBody.scheduledMessageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/inApp/getMessages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's mobile in-app messages
      effect: read
      questions:
      - How do I fetch a user's pending in-app messages including app-specific ones?
      - Can I limit how many in-app messages come back for a platform?
      instructions:
      - text: Get {count} in-app messages for {email}.
        slots:
          count: query.count
          email: query.email
      - text: Fetch {count} in-app messages for user {userId} on {platform} app {packageName}.
        slots:
          count: query.count
          userId: query.userId
          platform: query.platform
          packageName: query.packageName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/inApp/getPriorityMessage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's most relevant in-app message
      effect: read
      questions:
      - Which single in-app message should I show this user first?
      - Can I get just the highest-priority in-app message for a user?
      instructions:
      - text: Get the most relevant in-app message for {email}.
        slots:
          email: query.email
      - text: Fetch the priority in-app message for user {userId} on {platform}.
        slots:
          userId: query.userId
          platform: query.platform
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/inApp/target'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an in-app notification to a user
      effect: write
      questions:
      - How do I send an in-app notification to one user from a campaign?
      - Can I schedule an in-app message and override profile data?
      instructions:
      - text: Send in-app campaign {campaignId} to {recipientEmail}.
        slots:
          campaignId: requestBody.campaignId
          recipientEmail: requestBody.recipientEmail
      - text: Send in-app campaign {campaignId} to user {recipientUserId} at {sendAt}.
        slots:
          campaignId: requestBody.campaignId
          recipientUserId: requestBody.recipientUserId
          sendAt: requestBody.sendAt
      method: generated
      generated: '2026-10-01'
- target: $.paths['/inApp/getMessages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get pending in-app messages for a user
      effect: read
      questions:
      - What in-app messages are waiting to be shown to a user?
      - Can an SDK fetch pending in-app content for a specific platform?
      instructions:
      - text: Get pending in-app messages for {email}.
        slots:
          email: query.email
      - text: Using the SDK-style inApp endpoint, return at most {count} pending messages to display for user {userId} on {platform}.
        slots:
          count: query.count
          userId: query.userId
          platform: query.platform
      method: generated
      generated: '2026-10-01'