# 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 Credit Scores API
  version: 1.0.0
extends: openapi/methodfi-entity-credit-scores-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: 3
- target: $.paths['/entities/{entityId}/credit_scores'].get
  update:
    x-apievangelist-phrasing:
      intent: List credit scores pulled for an entity
      effect: read
      questions:
      - Can I see every credit score pulled for one person?
      - How do I list an entity's credit scores within a date range?
      instructions:
      - text: List credit scores for entity {entity}.
        slots:
          entity: path.entityId
      - text: Show credit scores 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}/credit_scores'].post
  update:
    x-apievangelist-phrasing:
      intent: Pull a new credit score for an entity
      effect: write
      questions:
      - How do I request a fresh credit score for a person?
      - Can I start a new credit score retrieval for an entity?
      instructions:
      - text: Pull a new credit score for entity {entity}.
        slots:
          entity: path.entityId
      - text: Request a credit score for entity {entity} with idempotency key {key}.
        slots:
          entity: path.entityId
          key: header.Idempotency-Key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{entityId}/credit_scores/{crsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one credit score record
      effect: read
      questions:
      - What score did a specific credit score request return?
      - Can I fetch a credit score record by its ID?
      instructions:
      - text: Get credit score {score} for entity {entity}.
        slots:
          score: path.crsId
          entity: path.entityId
      - text: Show the result of credit score request {score} on entity {entity}.
        slots:
          score: path.crsId
          entity: path.entityId
      method: generated
      generated: '2026-10-01'