# 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 Subscription Groups API
  version: 1.0.0
extends: openapi/ios-subscription-groups-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: 8
- target: $.paths['/v1/subscriptionGroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subscription group
      effect: write
      questions:
      - How do I create a new subscription group for my auto-renewable subscriptions?
      - Can I set up a subscription group through the App Store Connect API?
      instructions:
      - text: Create a subscription group with {group}.
        slots:
          group: requestBody.data
      - text: Add a new auto-renewable subscription group to my app using {group}.
        slots:
          group: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionGroups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription group
      effect: read
      questions:
      - What's the reference name of one subscription group?
      - Can I fetch a subscription group along with its subscriptions and localizations?
      instructions:
      - text: Get subscription group {group}.
        slots:
          group: path.id
      - text: Fetch subscription group {group} and include {include}.
        slots:
          group: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionGroups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subscription group
      effect: destructive
      questions:
      - How do I delete a subscription group I never used?
      - Can a subscription group be removed entirely?
      instructions:
      - text: Delete subscription group {group}.
        slots:
          group: path.id
      - text: Remove the auto-renewable subscription group {group}.
        slots:
          group: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionGroups/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or update a subscription group
      effect: write
      questions:
      - How do I rename a subscription group's reference name?
      - Can I edit a subscription group after creating it?
      instructions:
      - text: Update subscription group {group} with {changes}.
        slots:
          group: path.id
          changes: requestBody.data
      - text: Rename the reference name of group {group} using {changes}.
        slots:
          group: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionGroups/{id}/relationships/subscriptionGroupLocalizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List localization IDs for a subscription group
      effect: read
      questions:
      - Which localization IDs are attached to a subscription group?
      - Can I get only the identifiers of a group's translated display names?
      instructions:
      - text: List only the localization IDs for subscription group {group}.
        slots:
          group: path.id
      - text: Return up to {limit} group localization identifiers for {group}.
        slots:
          limit: query.limit
          group: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionGroups/{id}/subscriptionGroupLocalizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List a subscription group's localized names
      effect: read
      questions:
      - What display names and custom app names have I set for a subscription group in each language?
      - Can I see every translation of a subscription group with its review state?
      instructions:
      - text: Show the full localized names for subscription group {group}.
        slots:
          group: path.id
      - text: Fetch every language entry for group {group}, up to {limit}.
        slots:
          group: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionGroups/{id}/relationships/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscription IDs in a group
      effect: read
      questions:
      - Which subscription IDs are in a given subscription group?
      - Can I get just the identifiers of the subscriptions inside a group?
      instructions:
      - text: List only the subscription IDs in group {group}.
        slots:
          group: path.id
      - text: Return up to {limit} subscription identifiers from group {group}.
        slots:
          limit: query.limit
          group: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptionGroups/{id}/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the subscriptions in a group
      effect: read
      questions:
      - What subscriptions, with their durations and states, are in one of my subscription groups?
      - Can I find a subscription in a group by its product ID or name?
      - Which subscriptions in a group are still waiting for review?
      instructions:
      - text: Show the full subscriptions in group {group}.
        slots:
          group: path.id
      - text: Find the subscription with product ID {product_id} in group {group}.
        slots:
          product_id: query.filter[productId]
          group: path.id
      - text: List subscriptions in group {group} whose state is {state}.
        slots:
          group: path.id
          state: query.filter[state]
      method: generated
      generated: '2026-10-01'