API Evangelist conversational phrasing for Token Consents API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Token Consents API
  version: 1.0.0
extends: openapi/token-io-consents-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v2/consents'].get
  update:
    x-apievangelist-phrasing:
      intent: List account information consents
      effect: read
      questions:
      - Which of my v2 consents are about to expire?
      - Can I filter consents by status or by the date they were created?
      - Which consents need the user to reconfirm soon?
      instructions:
      - text: List consents with statuses {statuses}.
        slots:
          statuses: query.statuses
      - text: Show consents created after {created_after} for PSU reference {psu_ref}.
        slots:
          created_after: query.createdAfter
          psu_ref: query.externalPsuReference
      - text: List consents that must be reconfirmed before {reconfirm_before}.
        slots:
          reconfirm_before: query.reconfirmByBefore
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/consents'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a new account information consent
      effect: write
      questions:
      - How can I ask a user for consent to read their bank account data?
      - Can I set how many days of transaction history a consent covers?
      instructions:
      - text: Request a consent at bank {bank_id} with permissions {permissions}.
        slots:
          bank_id: requestBody.bankId
          permissions: requestBody.permissions
      - text: Request consent at bank {bank_id} covering {days} days of history, redirecting to {callback_url}.
        slots:
          bank_id: requestBody.bankId
          days: requestBody.transactionHistoryDays
          callback_url: requestBody.callbackUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/consents/{consentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one account information consent
      effect: read
      questions:
      - What's the current status of a specific consent?
      - Can I check when a given consent expires?
      instructions:
      - text: Get consent {consent_id}.
        slots:
          consent_id: query.consentId
      - text: Show the status and expiry of consent {consent_id}.
        slots:
          consent_id: query.consentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/consents/{consentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an account information consent
      effect: destructive
      questions:
      - Can I revoke a user's consent so I stop accessing their account data?
      - What happens to data access once a consent is revoked?
      instructions:
      - text: Revoke consent {consent_id}.
        slots:
          consent_id: query.consentId
      - text: Stop account access by revoking consent {consent_id}.
        slots:
          consent_id: query.consentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/consents/{consentId}/authentications'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete bank authentication for a consent
      effect: write
      questions:
      - After the bank redirects back, how do I finish authenticating a consent?
      - Where do I pass the bank's callback query to complete a consent?
      instructions:
      - text: Confirm authentication for consent {consent_id} with callback query {query}.
        slots:
          consent_id: requestBody.consentId
          query: requestBody.query
      - text: Finish the bank authentication of consent {consent_id}.
        slots:
          consent_id: requestBody.consentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/consents/{consentId}/confirmations'].post
  update:
    x-apievangelist-phrasing:
      intent: Record that the user reconfirmed a consent
      effect: write
      questions:
      - Can I record that a user reconfirmed their consent to keep it active?
      - Is there a way to log the time a PSU confirmed their consent?
      instructions:
      - text: Reconfirm consent {consent_id} as confirmed by the user at {confirmed_at}.
        slots:
          consent_id: requestBody.consentId
          confirmed_at: requestBody.psuConfirmedAt
      - text: Mark consent {consent_id} as reconfirmed by the user.
        slots:
          consent_id: requestBody.consentId
      method: generated
      generated: '2026-09-26'