# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for App Store Connect App Events API
  version: 1.0.0
extends: openapi/ios-app-events-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: 6
- target: $.paths['/v1/appEvents'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an in-app event
      effect: write
      questions:
      - How do I create an in-app event to feature on the App Store?
      - Can I schedule a new in-app event like a challenge or live event through the API?
      instructions:
      - text: Create an in-app event with {event}.
        slots:
          event: requestBody.data
      - text: Set up a new App Store in-app event for my app using {event}.
        slots:
          event: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appEvents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an in-app event
      effect: read
      questions:
      - What are the dates, badge and status of one in-app event?
      - Can I fetch an in-app event along with its localizations?
      instructions:
      - text: Get in-app event {event}.
        slots:
          event: path.id
      - text: Fetch in-app event {event} and include {include}.
        slots:
          event: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appEvents/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an in-app event
      effect: destructive
      questions:
      - How do I delete an in-app event I don't want to run?
      - Can I remove an in-app event from my app entirely?
      instructions:
      - text: Delete in-app event {event}.
        slots:
          event: path.id
      - text: Remove the App Store event {event} from my app.
        slots:
          event: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appEvents/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an in-app event
      effect: write
      questions:
      - How do I change the schedule or badge of an existing in-app event?
      - Can I edit an in-app event's details after it's created?
      instructions:
      - text: Update in-app event {event} with {changes}.
        slots:
          event: path.id
          changes: requestBody.data
      - text: Reschedule App Store event {event} using {changes}.
        slots:
          event: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appEvents/{id}/relationships/localizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List localization IDs for an in-app event
      effect: read
      questions:
      - Which localization IDs exist for an in-app event?
      - Can I get only the identifiers of an event's translated versions?
      instructions:
      - text: List only the localization IDs for in-app event {event}.
        slots:
          event: path.id
      - text: Return up to {limit} localization identifiers for event {event}.
        slots:
          limit: query.limit
          event: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/appEvents/{id}/localizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List an in-app event's localized text and media
      effect: read
      questions:
      - What names and descriptions have I written for an in-app event in each language?
      - Can I see an event's localizations with their screenshots and video clips?
      instructions:
      - text: Show the full localizations for in-app event {event}.
        slots:
          event: path.id
      - text: Fetch the translated copy for event {event} and include {include}.
        slots:
          event: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'