Telnyx API — Requirements

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Requirements
  description: 'Telnyx API — Requirements. 2 operations. Lead operation: List all requirements. Self-contained Naftiko capability
    covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Requirements
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-requirements
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Requirements business capability. Self-contained, no shared references.
    resources:
    - name: requirements
      path: /requirements
      operations:
      - name: listrequirements
        method: GET
        description: List all requirements
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: requirements-id
      path: /requirements/{id}
      operations:
      - name: retrievedocumentrequirements
        method: GET
        description: Retrieve a document requirement
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.TELNYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: telnyx-requirements-rest
    port: 8080
    description: REST adapter for Telnyx API — Requirements. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/requirements
      name: requirements
      description: REST surface for requirements.
      operations:
      - method: GET
        name: listrequirements
        description: List all requirements
        call: telnyx-requirements.listrequirements
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/requirements/{id}
      name: requirements-id
      description: REST surface for requirements-id.
      operations:
      - method: GET
        name: retrievedocumentrequirements
        description: Retrieve a document requirement
        call: telnyx-requirements.retrievedocumentrequirements
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-requirements-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — Requirements. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-all-requirements
      description: List all requirements
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-requirements.listrequirements
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-document-requirement
      description: Retrieve a document requirement
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-requirements.retrievedocumentrequirements
      outputParameters:
      - type: object
        mapping: $.