# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Method Elements API
  version: 1.0.0
extends: openapi/methodfi-elements-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['/elements/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an element token for the frontend
      effect: write
      questions:
      - How do I generate a client-side token to launch an element for an entity?
      - Do element tokens expire and are they scoped to one entity?
      instructions:
      - text: Create a {type} element token for entity {entity}.
        slots:
          type: requestBody.type
          entity: requestBody.entity_id
      - text: Generate an element token of element type {element_type} for entity {entity} and type {type}.
        slots:
          element_type: requestBody.element_type
          entity: requestBody.entity_id
          type: requestBody.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/elements/token/{pk_elem_id}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of a completed element
      effect: read
      questions:
      - How do I get the data a user entered during an element flow?
      - Can I read results once an element session has completed?
      instructions:
      - text: Get the results for element token {token}.
        slots:
          token: path.pk_elem_id
      - text: Show the data collected in element session for token {token}.
        slots:
          token: path.pk_elem_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/elements/sessions/{session_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an element session
      effect: read
      questions:
      - Can I look up an element session by its session ID?
      - What state is a particular element session in?
      instructions:
      - text: Get element session {session}.
        slots:
          session: path.session_id
      - text: Check the current state of element session {session}.
        slots:
          session: path.session_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/elements/sessions/{session_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an element session
      effect: write
      questions:
      - Is it possible to modify an element session after it has started?
      - Can I change an existing element session by its ID?
      instructions:
      - text: Update element session {session}.
        slots:
          session: path.session_id
      - text: Apply changes to element session {session}.
        slots:
          session: path.session_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/elements/accounts/exchange'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange account details for an element flow
      effect: write
      questions:
      - How do I exchange account information server-side during an element flow?
      - Where does the server-side account exchange step fit in elements?
      instructions:
      - text: Exchange the account from an element flow under API version {version}.
        slots:
          version: header.Method-Version
      - text: Run the server-side account exchange for the current element.
      method: generated
      generated: '2026-10-01'