Telnyx API — Phone Number Reservations

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Phone Number Reservations
  description: 'Telnyx API — Phone Number Reservations. 4 operations. Lead operation: List number reservations. Self-contained
    Naftiko capability covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Phone Number Reservations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-phone-number-reservations
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Phone Number Reservations business capability. Self-contained, no shared references.
    resources:
    - name: number_reservations
      path: /number_reservations
      operations:
      - name: listnumberreservations
        method: GET
        description: List number reservations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[status], filter[created_at],
            filter[phone_numbers.phone_number], filter[customer_reference]'
      - name: createnumberreservation
        method: POST
        description: Create a number reservation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: number_reservations-number_reservation_id
      path: /number_reservations/{number_reservation_id}
      operations:
      - name: retrievenumberreservation
        method: GET
        description: Retrieve a number reservation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: number_reservation_id
          in: path
          type: string
          description: The number reservation ID.
          required: true
    - name: number_reservations-number_reservation_id-actions-extend
      path: /number_reservations/{number_reservation_id}/actions/extend
      operations:
      - name: extendnumberreservationexpirytime
        method: POST
        description: Extend a number reservation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: number_reservation_id
          in: path
          type: string
          description: The number reservation ID.
          required: true
    authentication:
      type: bearer
      token: '{{env.TELNYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: telnyx-phone-number-reservations-rest
    port: 8080
    description: REST adapter for Telnyx API — Phone Number Reservations. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/number-reservations
      name: number-reservations
      description: REST surface for number_reservations.
      operations:
      - method: GET
        name: listnumberreservations
        description: List number reservations
        call: telnyx-phone-number-reservations.listnumberreservations
        with:
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createnumberreservation
        description: Create a number reservation
        call: telnyx-phone-number-reservations.createnumberreservation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/number-reservations/{number-reservation-id}
      name: number-reservations-number-reservation-id
      description: REST surface for number_reservations-number_reservation_id.
      operations:
      - method: GET
        name: retrievenumberreservation
        description: Retrieve a number reservation
        call: telnyx-phone-number-reservations.retrievenumberreservation
        with:
          number_reservation_id: rest.number_reservation_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/number-reservations/{number-reservation-id}/actions/extend
      name: number-reservations-number-reservation-id-actions-extend
      description: REST surface for number_reservations-number_reservation_id-actions-extend.
      operations:
      - method: POST
        name: extendnumberreservationexpirytime
        description: Extend a number reservation
        call: telnyx-phone-number-reservations.extendnumberreservationexpirytime
        with:
          number_reservation_id: rest.number_reservation_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-phone-number-reservations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — Phone Number Reservations. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-number-reservations
      description: List number reservations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-phone-number-reservations.listnumberreservations
      with:
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: create-number-reservation
      description: Create a number reservation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-phone-number-reservations.createnumberreservation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-number-reservation
      description: Retrieve a number reservation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-phone-number-reservations.retrievenumberreservation
      with:
        number_reservation_id: tools.number_reservation_id
      outputParameters:
      - type: object
        mapping: $.
    - name: extend-number-reservation
      description: Extend a number reservation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-phone-number-reservations.extendnumberreservationexpirytime
      with:
        number_reservation_id: tools.number_reservation_id
      outputParameters:
      - type: object
        mapping: $.