API Evangelist conversational phrasing for App Store Connect In App Purchases API

# 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 In App Purchases API
  version: 1.0.0
extends: openapi/ios-inapppurchases-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: 23
- target: $.paths['/v1/inAppPurchases/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an in-app purchase (legacy v1)
      effect: read
      questions:
      - Can I still fetch an in-app purchase through the older v1 endpoint?
      - What does the legacy v1 record for one of my in-app purchases contain?
      instructions:
      - text: Fetch in-app purchase {id} using the legacy v1 endpoint.
        slots:
          id: path.id
      - text: Show the v1 record for in-app purchase {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an in-app purchase
      effect: write
      questions:
      - How do I set up a new in-app purchase for my app in App Store Connect?
      - What do I need to send to register a new in-app product?
      instructions:
      - text: Create a new in-app purchase with {data}.
        slots:
          data: requestBody.data
      - text: 'Register this in-app product for my app: {data}.'
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an in-app purchase
      effect: read
      questions:
      - Where can I look up the current details of one in-app purchase?
      - Can I see an in-app product's full record by its ID?
      instructions:
      - text: Get in-app purchase {id}.
        slots:
          id: path.id
      - text: Show me the details of in-app product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an in-app purchase
      effect: destructive
      questions:
      - Can I remove an in-app purchase I no longer want to sell?
      - Is it possible to delete an in-app product from App Store Connect entirely?
      instructions:
      - text: Delete in-app purchase {id}.
        slots:
          id: path.id
      - text: Remove in-app product {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an in-app purchase
      effect: write
      questions:
      - How do I change the settings of an existing in-app purchase?
      - Can I edit an in-app product after creating it?
      instructions:
      - text: Update in-app purchase {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: 'Apply these changes to in-app product {id}: {data}.'
        slots:
          id: path.id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/relationships/appStoreReviewScreenshot'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the review screenshot ID of an in-app purchase
      effect: read
      questions:
      - Which review screenshot ID is linked to my in-app purchase?
      - Is there a lightweight way to get only the App Store review screenshot reference for an in-app product?
      instructions:
      - text: Give me only the review screenshot ID linked to in-app purchase {id}.
        slots:
          id: path.id
      - text: Return the review screenshot linkage for in-app product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/appStoreReviewScreenshot'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an in-app purchase's review screenshot
      effect: read
      questions:
      - Where do I see the screenshot I submitted for App Store review of an in-app purchase?
      - What are the full details of the review screenshot attached to my in-app product?
      instructions:
      - text: Show the App Store review screenshot for in-app purchase {id}.
        slots:
          id: path.id
      - text: Fetch the full review screenshot record of in-app product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/relationships/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the hosted content ID of an in-app purchase
      effect: read
      questions:
      - Which hosted content ID belongs to my in-app purchase?
      - Can I get just the content reference for an in-app product without its details?
      instructions:
      - text: Give me only the hosted content ID for in-app purchase {id}.
        slots:
          id: path.id
      - text: Return the content linkage of in-app product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an in-app purchase's hosted content
      effect: read
      questions:
      - How can I check the hosted content attached to an in-app purchase?
      - What does the downloadable content record for my in-app product look like?
      instructions:
      - text: Show the hosted content details for in-app purchase {id}.
        slots:
          id: path.id
      - text: Fetch the full content record attached to in-app product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/relationships/iapPriceSchedule'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the price schedule ID of an in-app purchase
      effect: read
      questions:
      - What's the price schedule ID for my in-app purchase?
      - Can I fetch only the price schedule reference of an in-app product?
      instructions:
      - text: Give me only the price schedule ID of in-app purchase {id}.
        slots:
          id: path.id
      - text: Return the price schedule linkage for in-app product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/iapPriceSchedule'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an in-app purchase's price schedule
      effect: read
      questions:
      - How do I see the pricing schedule set for an in-app purchase?
      - What does the full price schedule of my in-app product look like?
      instructions:
      - text: Show the price schedule for in-app purchase {id}.
        slots:
          id: path.id
      - text: Fetch the full pricing schedule details of in-app product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/relationships/images'].get
  update:
    x-apievangelist-phrasing:
      intent: List image IDs of an in-app purchase
      effect: read
      questions:
      - Which image IDs are attached to my in-app purchase?
      - Can I list only the image references of an in-app product?
      instructions:
      - text: List only the image IDs linked to in-app purchase {id}.
        slots:
          id: path.id
      - text: Return up to {limit} image linkages for in-app product {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/images'].get
  update:
    x-apievangelist-phrasing:
      intent: List an in-app purchase's images
      effect: read
      questions:
      - Where can I see all the images uploaded for an in-app purchase?
      - What images does my in-app product have, with their details?
      instructions:
      - text: Show the images for in-app purchase {id}.
        slots:
          id: path.id
      - text: List up to {limit} images with full details for in-app product {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/relationships/inAppPurchaseAvailability'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the availability ID of an in-app purchase
      effect: read
      questions:
      - What's the availability record ID for my in-app purchase?
      - Can I get only the availability reference of an in-app product?
      instructions:
      - text: Give me only the availability ID of in-app purchase {id}.
        slots:
          id: path.id
      - text: Return the availability linkage of in-app product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/inAppPurchaseAvailability'].get
  update:
    x-apievangelist-phrasing:
      intent: Get where an in-app purchase is available
      effect: read
      questions:
      - In which territories is my in-app purchase available?
      - How do I check the availability settings of an in-app product?
      instructions:
      - text: Show where in-app purchase {id} is available.
        slots:
          id: path.id
      - text: Fetch the full availability settings of in-app product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/relationships/inAppPurchaseLocalizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List localization IDs of an in-app purchase
      effect: read
      questions:
      - Which localization IDs exist for my in-app purchase?
      - Can I list only the localization references of an in-app product?
      instructions:
      - text: List only the localization IDs for in-app purchase {id}.
        slots:
          id: path.id
      - text: Return up to {limit} localization linkages of in-app product {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/inAppPurchaseLocalizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List an in-app purchase's localizations
      effect: read
      questions:
      - Where can I see the localized display text of an in-app purchase?
      - Which languages has my in-app product been localized into?
      instructions:
      - text: Show the localizations of in-app purchase {id}.
        slots:
          id: path.id
      - text: List up to {limit} localized display entries for in-app product {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/relationships/offerCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List offer code IDs of an in-app purchase
      effect: read
      questions:
      - Which offer code IDs are attached to my in-app purchase?
      - Can I get only the offer code references for an in-app product?
      instructions:
      - text: List only the offer code IDs for in-app purchase {id}.
        slots:
          id: path.id
      - text: Return up to {limit} offer code linkages of in-app product {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/offerCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List an in-app purchase's offer codes
      effect: read
      questions:
      - How do I see the offer codes created for an in-app purchase?
      - Can I filter an in-app product's offer codes by territory?
      instructions:
      - text: Show the offer codes for in-app purchase {id}.
        slots:
          id: path.id
      - text: List offer codes of in-app product {id} available in {territory}.
        slots:
          id: path.id
          territory: query.filter[territory]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/relationships/pricePoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List price point IDs of an in-app purchase
      effect: read
      questions:
      - Which price point IDs apply to my in-app purchase?
      - Can I list only the price point references of an in-app product?
      instructions:
      - text: List only the price point IDs of in-app purchase {id}.
        slots:
          id: path.id
      - text: Return up to {limit} price point linkages for in-app product {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/pricePoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List price points for an in-app purchase
      effect: read
      questions:
      - What price tiers can I choose for an in-app purchase?
      - Is there a way to see an in-app product's price points for one territory?
      instructions:
      - text: Show the available price points for in-app purchase {id}.
        slots:
          id: path.id
      - text: List price points of in-app product {id} in {territory}.
        slots:
          id: path.id
          territory: query.filter[territory]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/relationships/promotedPurchase'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the promoted purchase ID of an in-app purchase
      effect: read
      questions:
      - What's the promoted purchase ID linked to my in-app purchase?
      - Can I get only the promoted purchase reference of an in-app product?
      instructions:
      - text: Give me only the promoted purchase ID of in-app purchase {id}.
        slots:
          id: path.id
      - text: Return the promoted purchase linkage for in-app product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/inAppPurchases/{id}/promotedPurchase'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an in-app purchase's promoted purchase
      effect: read
      questions:
      - Is my in-app purchase being promoted on the App Store?
      - Where do I see the promoted purchase details for an in-app product?
      instructions:
      - text: Show the promoted purchase for in-app purchase {id}.
        slots:
          id: path.id
      - text: Fetch the full promoted purchase record of in-app product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'