# 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 Win Back Offers API
  version: 1.0.0
extends: openapi/ios-winbackoffers-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/winBackOffers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a win-back offer
      effect: write
      questions:
      - How do I create a win-back offer to bring lapsed subscribers back?
      - Can I set territory prices when creating a win-back offer?
      instructions:
      - text: Create a win-back offer from {offer}.
        slots:
          offer: requestBody.data
      - text: Set up win-back offer {offer} with prices {prices}.
        slots:
          offer: requestBody.data
          prices: requestBody.included
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/winBackOffers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a win-back offer
      effect: read
      questions:
      - What eligibility rules and dates does one of my win-back offers have?
      - Can I look up a win-back offer by its ID?
      instructions:
      - text: Show win-back offer {id}.
        slots:
          id: path.id
      - text: Fetch the settings of win-back offer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/winBackOffers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a win-back offer
      effect: destructive
      questions:
      - Can I delete a win-back offer I set up by mistake?
      - What happens to a win-back offer once I remove it?
      instructions:
      - text: Delete win-back offer {id}.
        slots:
          id: path.id
      - text: Remove win-back offer {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/winBackOffers/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a win-back offer
      effect: write
      questions:
      - Can I change the end date or priority of a win-back offer?
      - Which settings on an existing win-back offer are editable?
      instructions:
      - text: Update win-back offer {id} with {changes}.
        slots:
          id: path.id
          changes: requestBody.data
      - text: Extend the end date of win-back offer {id} using {changes}.
        slots:
          id: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/winBackOffers/{id}/relationships/prices'].get
  update:
    x-apievangelist-phrasing:
      intent: List price IDs for a win-back offer
      effect: read
      questions:
      - Which price IDs are attached to my win-back offer?
      - Can I fetch only the identifiers of a win-back offer's prices?
      instructions:
      - text: List the price IDs linked to win-back offer {id}.
        slots:
          id: path.id
      - text: Return only price references for win-back offer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/winBackOffers/{id}/prices'].get
  update:
    x-apievangelist-phrasing:
      intent: List a win-back offer's prices by territory
      effect: read
      questions:
      - What does my win-back offer cost in each country?
      - Can I check a win-back offer's price in one territory?
      instructions:
      - text: Show the full prices for win-back offer {id}.
        slots:
          id: path.id
      - text: Get win-back offer {id}'s price in territory {territory}.
        slots:
          id: path.id
          territory: query.filter[territory]
      method: generated
      generated: '2026-10-01'