# 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 Connects API
  version: 1.0.0
extends: openapi/methodfi-entity-connects-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: 5
- target: $.paths['/entities/{entityId}/connect'].get
  update:
    x-apievangelist-phrasing:
      intent: List connect sessions for an entity
      effect: read
      questions:
      - Which connect sessions have been run for this entity?
      - Can I list an entity's connect sessions created within a date range?
      instructions:
      - text: List connect sessions for entity {entity}.
        slots:
          entity: path.entityId
      - text: Show connect sessions for entity {entity} from {from_date} to {to_date}.
        slots:
          entity: path.entityId
          from_date: query.from_date
          to_date: query.to_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{entityId}/connect'].post
  update:
    x-apievangelist-phrasing:
      intent: Discover an entity's liability accounts
      effect: write
      questions:
      - How do I find all of a person's liability accounts automatically?
      - Can I enable products and subscriptions on the accounts a connect finds?
      instructions:
      - text: Run a connect session for entity {entity}.
        slots:
          entity: path.entityId
      - text: Connect entity {entity} and enable products {products} on found accounts.
        slots:
          entity: path.entityId
          products: requestBody.products
      - text: Connect entity {entity} and subscribe the accounts to {subscriptions}.
        slots:
          entity: path.entityId
          subscriptions: requestBody.subscriptions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{entityId}/connect/{cxnId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one entity connect session
      effect: read
      questions:
      - What did a particular connect session find for an entity?
      - Can I fetch one connect session and expand its accounts?
      instructions:
      - text: Get connect session {connect} for entity {entity}.
        slots:
          connect: path.cxnId
          entity: path.entityId
      - text: Show connect session {connect} on entity {entity} with {expand} expanded.
        slots:
          connect: path.cxnId
          entity: path.entityId
          expand: query.expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{entityId}/manual_connect'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect an entity using supplied tradelines
      effect: write
      questions:
      - Can I connect an entity using tradelines I already have from a bureau?
      - How do I create a manual connect session instead of an automatic one?
      instructions:
      - text: Manually connect entity {entity} with tradelines {tradelines} from bureau {bureau}.
        slots:
          entity: path.entityId
          tradelines: requestBody.tradelines
          bureau: requestBody.bureau
      - text: Create a manual connect for entity {entity} using {bureau} tradelines {tradelines}.
        slots:
          entity: path.entityId
          bureau: requestBody.bureau
          tradelines: requestBody.tradelines
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{entityId}/manual_connect/{mcxnId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one manual connect session
      effect: read
      questions:
      - What happened with a manual connect session I submitted?
      - Can I look up a manual connect session by its ID?
      instructions:
      - text: Get manual connect session {manual_connect} for entity {entity}.
        slots:
          manual_connect: path.mcxnId
          entity: path.entityId
      - text: Check the status of manual connect {manual_connect} on entity {entity}.
        slots:
          manual_connect: path.mcxnId
          entity: path.entityId
      method: generated
      generated: '2026-10-01'