API Evangelist conversational phrasing for Token.io's Open Banking API for TPPs Sub TPPs 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.io's Open Banking API for TPPs Sub TPPs API
  version: 1.0.0
extends: openapi/token-io-sub-tpps-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: 8
- target: $.paths['/member/sub-tpps'].get
  update:
    x-apievangelist-phrasing:
      intent: List a reseller's sub-TPPs
      effect: read
      questions:
      - Which sub-TPPs have I onboarded as a reseller?
      - Can I filter sub-TPPs by company name or registration date?
      instructions:
      - text: List {limit} of my sub-TPPs.
        slots:
          limit: query.page.limit
      - text: Show {limit} sub-TPPs with company names {names}.
        slots:
          limit: query.page.limit
          names: query.filter.byCompanyNames
      method: generated
      generated: '2026-09-26'
- target: $.paths['/member/sub-tpps'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sub-TPP
      effect: write
      questions:
      - How do I add a new merchant as a sub-TPP under my reseller account?
      - Can a reseller create sub-TPPs through the API?
      instructions:
      - text: Create a new sub-TPP under my reseller account.
      - text: Onboard a new merchant as a sub-TPP.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/member/sub-tpps/{subTppId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sub-TPP
      effect: read
      questions:
      - What details are stored for one of my sub-TPPs?
      - Can I look up a sub-TPP by id?
      instructions:
      - text: Get sub-TPP {sub_tpp_id}.
        slots:
          sub_tpp_id: path.subTppId
      - text: Show the details of sub-TPP {sub_tpp_id}.
        slots:
          sub_tpp_id: path.subTppId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/member/sub-tpps/{subTppId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sub-TPP
      effect: destructive
      questions:
      - Can I remove a sub-TPP from my reseller account?
      - What happens when a sub-TPP is deleted?
      instructions:
      - text: Delete sub-TPP {sub_tpp_id}.
        slots:
          sub_tpp_id: path.subTppId
      - text: Remove sub-TPP {sub_tpp_id} from my reseller account.
        slots:
          sub_tpp_id: path.subTppId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/member/sub-tpps/{subTppId}/children'].get
  update:
    x-apievangelist-phrasing:
      intent: List a sub-TPP's children
      effect: read
      questions:
      - Which child sub-TPPs sit under a given sub-TPP?
      - Can sub-TPPs be nested, and how do I see the children?
      instructions:
      - text: List the children of sub-TPP {sub_tpp_id}.
        slots:
          sub_tpp_id: path.subTppId
      - text: Show child sub-TPPs under {sub_tpp_id}.
        slots:
          sub_tpp_id: path.subTppId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/member/sub-tpps/{sub_tpp_id}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List a sub-TPP's documents
      effect: read
      questions:
      - Which onboarding documents has a sub-TPP uploaded?
      - Can I filter a sub-TPP's documents by status?
      instructions:
      - text: List documents for sub-TPP {sub_tpp_id}.
        slots:
          sub_tpp_id: path.sub_tpp_id
      - text: Show sub-TPP {sub_tpp_id}'s documents with statuses {statuses}.
        slots:
          sub_tpp_id: path.sub_tpp_id
          statuses: query.statuses
      method: generated
      generated: '2026-09-26'
- target: $.paths['/member/sub-tpps/{sub_tpp_id}/upload-document/{document_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a document for a sub-TPP
      effect: write
      questions:
      - How do I upload a KYB document for a sub-TPP?
      - Which file types can I upload as sub-TPP documents?
      instructions:
      - text: Upload {file} as a {file_type} for document {document_id} of sub-TPP {sub_tpp_id}.
        slots:
          file: requestBody.file
          file_type: requestBody.file_type
          document_id: path.document_id
          sub_tpp_id: path.sub_tpp_id
      - text: Attach file {file} to sub-TPP {sub_tpp_id} document {document_id}, type {file_type}.
        slots:
          file: requestBody.file
          sub_tpp_id: path.sub_tpp_id
          document_id: path.document_id
          file_type: requestBody.file_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/member/sub-tpps/{sub_tpp_id}/documents/{document_id}/view'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a link to view a sub-TPP document
      effect: read
      questions:
      - How can I securely view or download a document a sub-TPP uploaded?
      - Does the document view link expire?
      instructions:
      - text: Get a pre-signed URL for document {document_id} of sub-TPP {sub_tpp_id}.
        slots:
          document_id: path.document_id
          sub_tpp_id: path.sub_tpp_id
      - text: Give me a download link for sub-TPP {sub_tpp_id}'s document {document_id}.
        slots:
          sub_tpp_id: path.sub_tpp_id
          document_id: path.document_id
      method: generated
      generated: '2026-09-26'