# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Method Entity Subscriptions API
  version: 1.0.0
extends: openapi/methodfi-entity-subscriptions-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: 4
- target: $.paths['/entities/{entityId}/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscriptions for an entity
      effect: read
      questions:
      - Which subscriptions is this entity enrolled in?
      - Can I see all of a person's active subscriptions?
      instructions:
      - text: List subscriptions for entity {entity}.
        slots:
          entity: path.entityId
      - text: Show what entity {entity} is enrolled in.
        slots:
          entity: path.entityId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{entityId}/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe an entity to a product
      effect: write
      questions:
      - How do I enroll an entity in a recurring subscription?
      - Can I pass extra settings when subscribing an entity?
      instructions:
      - text: Enroll entity {entity} in {enroll}.
        slots:
          entity: path.entityId
          enroll: requestBody.enroll
      - text: Subscribe entity {entity} to {enroll} with payload {payload}.
        slots:
          entity: path.entityId
          enroll: requestBody.enroll
          payload: requestBody.payload
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{entityId}/subscriptions/{subId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one entity subscription
      effect: read
      questions:
      - Is a specific entity subscription still active?
      - Can I fetch an entity subscription by its ID?
      instructions:
      - text: Get subscription {subscription} for entity {entity}.
        slots:
          subscription: path.subId
          entity: path.entityId
      - text: Check the status of subscription {subscription} on entity {entity}.
        slots:
          subscription: path.subId
          entity: path.entityId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{entityId}/subscriptions/{subId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an entity subscription
      effect: destructive
      questions:
      - How do I stop an entity's subscription?
      - Can I unenroll a person from ongoing monitoring?
      instructions:
      - text: Delete subscription {subscription} for entity {entity}.
        slots:
          subscription: path.subId
          entity: path.entityId
      - text: Unenroll entity {entity} from subscription {subscription}.
        slots:
          entity: path.entityId
          subscription: path.subId
      method: generated
      generated: '2026-10-01'