# 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 Purchase Offer Codes API
  version: 1.0.0
extends: openapi/ios-inapppurchaseoffercodes-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: 9
- target: $.paths['/v1/inAppPurchaseOfferCodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an offer code for an in-app purchase
      effect: write
      questions:
      - How do I create a promotional offer code campaign for an in-app purchase?
      - Can I set up offer codes for a one-time in-app purchase, not just subscriptions?
      instructions:
      - text: Create an in-app purchase offer code with {offer}.
        slots:
          offer: requestBody.data
      - text: Set up a new offer code campaign for my in-app purchase using {offer}.
        slots:
          offer: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/inAppPurchaseOfferCodes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an in-app purchase offer code
      effect: read
      questions:
      - What are the settings of one in-app purchase offer code, like eligibility and status?
      - Can I fetch an offer code along with its custom codes and prices?
      instructions:
      - text: Get in-app purchase offer code {offer}.
        slots:
          offer: path.id
      - text: Fetch offer code {offer} and include {include}.
        slots:
          offer: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/inAppPurchaseOfferCodes/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an in-app purchase offer code
      effect: write
      questions:
      - How do I turn off or change an existing in-app purchase offer code?
      - Can I edit an offer code after it's been created?
      instructions:
      - text: Update in-app purchase offer code {offer} with {changes}.
        slots:
          offer: path.id
          changes: requestBody.data
      - text: Deactivate offer code {offer} by setting {changes}.
        slots:
          offer: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/inAppPurchaseOfferCodes/{id}/relationships/customCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom code IDs for an offer code
      effect: read
      questions:
      - Which custom code IDs belong to an in-app purchase offer code?
      - Can I get just the identifiers of an offer's vanity codes?
      instructions:
      - text: List only the custom code IDs under offer code {offer}.
        slots:
          offer: path.id
      - text: Return up to {limit} custom code identifiers for offer {offer}.
        slots:
          limit: query.limit
          offer: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/inAppPurchaseOfferCodes/{id}/customCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom codes for an in-app purchase offer
      effect: read
      questions:
      - What custom, human-readable codes have I created for an in-app purchase offer, and how many redemptions does each allow?
      - Can I see the full details and expiration of each custom code under an offer?
      instructions:
      - text: Show the full custom codes, with expiry and quantity, for offer code {offer}.
        slots:
          offer: path.id
      - text: Fetch the vanity codes defined for in-app purchase offer {offer}.
        slots:
          offer: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/inAppPurchaseOfferCodes/{id}/relationships/oneTimeUseCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List one-time-use code batch IDs for an offer
      effect: read
      questions:
      - Which one-time-use code batch IDs exist for an in-app purchase offer?
      - Can I get only the IDs of generated single-use code sets?
      instructions:
      - text: List only the one-time-use code batch IDs for offer {offer}.
        slots:
          offer: path.id
      - text: Return up to {limit} single-use code set identifiers for offer code {offer}.
        slots:
          limit: query.limit
          offer: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/inAppPurchaseOfferCodes/{id}/oneTimeUseCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List one-time-use code batches for an offer
      effect: read
      questions:
      - What batches of single-use redemption codes have been generated for an in-app purchase offer?
      - Can I see how many one-time codes were generated in each batch and when they expire?
      instructions:
      - text: Show the full one-time-use code batches for offer code {offer}.
        slots:
          offer: path.id
      - text: Fetch details of every single-use code set generated for offer {offer}.
        slots:
          offer: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/inAppPurchaseOfferCodes/{id}/relationships/prices'].get
  update:
    x-apievangelist-phrasing:
      intent: List price IDs for an in-app purchase offer code
      effect: read
      questions:
      - Which price record IDs are attached to an in-app purchase offer code?
      - Can I get only the identifiers of an offer's territory prices?
      instructions:
      - text: List only the price IDs for offer code {offer}.
        slots:
          offer: path.id
      - text: Return up to {limit} price identifiers attached to offer {offer}.
        slots:
          limit: query.limit
          offer: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/inAppPurchaseOfferCodes/{id}/prices'].get
  update:
    x-apievangelist-phrasing:
      intent: List territory prices for an offer code
      effect: read
      questions:
      - What does an in-app purchase offer code cost in each territory?
      - Can I check an offer code's price for just one country or region?
      instructions:
      - text: Show the full territory prices for offer code {offer}.
        slots:
          offer: path.id
      - text: Get the price of offer {offer} in territory {territory}.
        slots:
          offer: path.id
          territory: query.filter[territory]
      method: generated
      generated: '2026-10-01'