Telnyx API — Number Portout

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Number Portout
  description: 'Telnyx API — Number Portout. 14 operations. Lead operation: List portout requests. Self-contained Naftiko
    capability covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Number Portout
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-number-portout
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Number Portout business capability. Self-contained, no shared references.
    resources:
    - name: portouts
      path: /portouts
      operations:
      - name: listportoutrequest
        method: GET
        description: List portout requests
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[carrier_name], filter[country_code],
            filter[country_code_in], filter[foc_date], filter[inse'
    - name: portouts-events
      path: /portouts/events
      operations:
      - name: listportoutevents
        method: GET
        description: List all port-out events
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[event_type], filter[portout_id],
            filter[created_at]'
    - name: portouts-events-id
      path: /portouts/events/{id}
      operations:
      - name: showportoutevent
        method: GET
        description: Show a port-out event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifies the port-out event.
          required: true
    - name: portouts-events-id-republish
      path: /portouts/events/{id}/republish
      operations:
      - name: republishportoutevent
        method: POST
        description: Republish a port-out event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifies the port-out event.
          required: true
    - name: portouts-rejections-portout_id
      path: /portouts/rejections/{portout_id}
      operations:
      - name: listportoutrejections
        method: GET
        description: List eligible port-out rejection codes for a specific order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: portout_id
          in: path
          type: string
          description: Identifies a port out order.
          required: true
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[code], filter[code][in]'
    - name: portouts-reports
      path: /portouts/reports
      operations:
      - name: listportoutreports
        method: GET
        description: List port-out related reports
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[report_type], filter[status]'
      - name: createportoutreport
        method: POST
        description: Create a port-out related report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: portouts-reports-id
      path: /portouts/reports/{id}
      operations:
      - name: getportoutreport
        method: GET
        description: Retrieve a report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifies a report.
          required: true
    - name: portouts-id
      path: /portouts/{id}
      operations:
      - name: findportoutrequest
        method: GET
        description: Get a portout request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Portout id
          required: true
    - name: portouts-id-comments
      path: /portouts/{id}/comments
      operations:
      - name: findportoutcomments
        method: GET
        description: List all comments for a portout request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Portout id
          required: true
      - name: postportrequestcomment
        method: POST
        description: Create a comment on a portout request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Portout id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: portouts-id-supporting_documents
      path: /portouts/{id}/supporting_documents
      operations:
      - name: getportrequestsupportingdocuments
        method: GET
        description: List supporting documents on a portout request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Portout id
          required: true
      - name: postportrequestsupportingdocuments
        method: POST
        description: Create a list of supporting documents on a portout request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Portout id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: portouts-id-status
      path: /portouts/{id}/{status}
      operations:
      - name: updateportoutstatus
        method: PATCH
        description: Update Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Portout id
          required: true
        - name: status
          in: path
          type: string
          description: Updated portout status
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.TELNYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: telnyx-number-portout-rest
    port: 8080
    description: REST adapter for Telnyx API — Number Portout. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/portouts
      name: portouts
      description: REST surface for portouts.
      operations:
      - method: GET
        name: listportoutrequest
        description: List portout requests
        call: telnyx-number-portout.listportoutrequest
        with:
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/portouts/events
      name: portouts-events
      description: REST surface for portouts-events.
      operations:
      - method: GET
        name: listportoutevents
        description: List all port-out events
        call: telnyx-number-portout.listportoutevents
        with:
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/portouts/events/{id}
      name: portouts-events-id
      description: REST surface for portouts-events-id.
      operations:
      - method: GET
        name: showportoutevent
        description: Show a port-out event
        call: telnyx-number-portout.showportoutevent
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/portouts/events/{id}/republish
      name: portouts-events-id-republish
      description: REST surface for portouts-events-id-republish.
      operations:
      - method: POST
        name: republishportoutevent
        description: Republish a port-out event
        call: telnyx-number-portout.republishportoutevent
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/portouts/rejections/{portout-id}
      name: portouts-rejections-portout-id
      description: REST surface for portouts-rejections-portout_id.
      operations:
      - method: GET
        name: listportoutrejections
        description: List eligible port-out rejection codes for a specific order
        call: telnyx-number-portout.listportoutrejections
        with:
          portout_id: rest.portout_id
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/portouts/reports
      name: portouts-reports
      description: REST surface for portouts-reports.
      operations:
      - method: GET
        name: listportoutreports
        description: List port-out related reports
        call: telnyx-number-portout.listportoutreports
        with:
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createportoutreport
        description: Create a port-out related report
        call: telnyx-number-portout.createportoutreport
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/portouts/reports/{id}
      name: portouts-reports-id
      description: REST surface for portouts-reports-id.
      operations:
      - method: GET
        name: getportoutreport
        description: Retrieve a report
        call: telnyx-number-portout.getportoutreport
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/portouts/{id}
      name: portouts-id
      description: REST surface for portouts-id.
      operations:
      - method: GET
        name: findportoutrequest
        description: Get a portout request
        call: telnyx-number-portout.findportoutrequest
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/portouts/{id}/comments
      name: portouts-id-comments
      description: REST surface for portouts-id-comments.
      operations:
      - method: GET
        name: findportoutcomments
        description: List all comments for a portout request
        call: telnyx-number-portout.findportoutcomments
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postportrequestcomment
        description: Create a comment on a portout request
        call: telnyx-number-portout.postportrequestcomment
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/portouts/{id}/supporting-documents
      name: portouts-id-supporting-documents
      description: REST surface for portouts-id-supporting_documents.
      operations:
      - method: GET
        name: getportrequestsupportingdocuments
        description: List supporting documents on a portout request
        call: telnyx-number-portout.getportrequestsupportingdocuments
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postportrequestsupportingdocuments
        description: Create a list of supporting documents on a portout request
        call: telnyx-number-portout.postportrequestsupportingdocuments
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/portouts/{id}/{status}
      name: portouts-id-status
      description: REST surface for portouts-id-status.
      operations:
      - method: PATCH
        name: updateportoutstatus
        description: Update Status
        call: telnyx-number-portout.updateportoutstatus
        with:
          id: rest.id
          status: rest.status
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-number-portout-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — Number Portout. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-portout-requests
      description: List portout requests
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-number-portout.listportoutrequest
      with:
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-port-out-events
      description: List all port-out events
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-number-portout.listportoutevents
      with:
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: show-port-out-event
      description: Show a port-out event
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-number-portout.showportoutevent
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: republish-port-out-event
      description: Republish a port-out event
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-number-portout.republishportoutevent
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: list-eligible-port-out-rejection
      description: List eligible port-out rejection codes for a specific order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-number-portout.listportoutrejections
      with:
        portout_id: tools.portout_id
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: list-port-out-related-reports
      description: List port-out related reports
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-number-portout.listportoutreports
      with:
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: create-port-out-related-report
      description: Create a port-out related report
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-number-portout.createportoutreport
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-report
      description: Retrieve a report
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-number-portout.getportoutreport
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-portout-request
      description: Get a portout request
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-number-portout.findportoutrequest
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-comments-portout-request
      description: List all comments for a portout request
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-number-portout.findportoutcomments
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: create-comment-portout-request
      description: Create a comment on a portout request
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-number-portout.postportrequestcomment
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-supporting-documents-portout-request
      description: List supporting documents on a portout request
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-number-portout.getportrequestsupportingdocuments
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: create-list-supporting-documents-portout
      description: Create a list of supporting documents on a portout request
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: telnyx-number-portout.postportrequestsupportingdocuments
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-status
      description: Update Status
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: telnyx-number-portout.updateportoutstatus
      with:
        id: tools.id
        status: tools.status
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.