Bandwidth Toll-Free Verification API — Toll-Free Verification

naftiko: 1.0.0-alpha2
info:
  label: Bandwidth Toll-Free Verification API — Toll-Free Verification
  description: 'Bandwidth Toll-Free Verification API — Toll-Free Verification. 4 operations. Lead operation: List toll-free
    verification requests. Self-contained Naftiko capability covering one Bandwidth business surface.'
  tags:
  - Bandwidth
  - Toll-Free Verification
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BANDWIDTH_API_KEY: BANDWIDTH_API_KEY
capability:
  consumes:
  - type: http
    namespace: toll-free-verification-toll-free-verification
    baseUri: https://dashboard.bandwidth.com/api
    description: Bandwidth Toll-Free Verification API — Toll-Free Verification business capability. Self-contained, no shared
      references.
    resources:
    - name: accounts-accountId-tollFreeVerification
      path: /accounts/{accountId}/tollFreeVerification
      operations:
      - name: listtollfreeverifications
        method: GET
        description: List toll-free verification requests
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: Filter by verification status
        - name: telephoneNumber
          in: query
          type: string
          description: Filter by toll-free telephone number
      - name: createtollfreeverification
        method: POST
        description: Submit a toll-free verification request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: accounts-accountId-tollFreeVerification-verificationId
      path: /accounts/{accountId}/tollFreeVerification/{verificationId}
      operations:
      - name: gettollfreeverification
        method: GET
        description: Get toll-free verification details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatetollfreeverification
        method: PUT
        description: Update a toll-free verification request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.BANDWIDTH_USER}}'
      password: '{{env.BANDWIDTH_PASS}}'
  exposes:
  - type: rest
    namespace: toll-free-verification-toll-free-verification-rest
    port: 8080
    description: REST adapter for Bandwidth Toll-Free Verification API — Toll-Free Verification. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/accounts/{accountid}/tollfreeverification
      name: accounts-accountid-tollfreeverification
      description: REST surface for accounts-accountId-tollFreeVerification.
      operations:
      - method: GET
        name: listtollfreeverifications
        description: List toll-free verification requests
        call: toll-free-verification-toll-free-verification.listtollfreeverifications
        with:
          status: rest.status
          telephoneNumber: rest.telephoneNumber
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createtollfreeverification
        description: Submit a toll-free verification request
        call: toll-free-verification-toll-free-verification.createtollfreeverification
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/accounts/{accountid}/tollfreeverification/{verificationid}
      name: accounts-accountid-tollfreeverification-verificationid
      description: REST surface for accounts-accountId-tollFreeVerification-verificationId.
      operations:
      - method: GET
        name: gettollfreeverification
        description: Get toll-free verification details
        call: toll-free-verification-toll-free-verification.gettollfreeverification
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatetollfreeverification
        description: Update a toll-free verification request
        call: toll-free-verification-toll-free-verification.updatetollfreeverification
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: toll-free-verification-toll-free-verification-mcp
    port: 9090
    transport: http
    description: MCP adapter for Bandwidth Toll-Free Verification API — Toll-Free Verification. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: list-toll-free-verification-requests
      description: List toll-free verification requests
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: toll-free-verification-toll-free-verification.listtollfreeverifications
      with:
        status: tools.status
        telephoneNumber: tools.telephoneNumber
      outputParameters:
      - type: object
        mapping: $.
    - name: submit-toll-free-verification-request
      description: Submit a toll-free verification request
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: toll-free-verification-toll-free-verification.createtollfreeverification
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-toll-free-verification-details
      description: Get toll-free verification details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: toll-free-verification-toll-free-verification.gettollfreeverification
      outputParameters:
      - type: object
        mapping: $.
    - name: update-toll-free-verification-request
      description: Update a toll-free verification request
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: toll-free-verification-toll-free-verification.updatetollfreeverification
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.