Telnyx API — Addresses

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Addresses
  description: 'Telnyx API — Addresses. 6 operations. Lead operation: List all addresses. Self-contained Naftiko capability
    covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Addresses
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-addresses
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Addresses business capability. Self-contained, no shared references.
    resources:
    - name: addresses
      path: /addresses
      operations:
      - name: findaddresses
        method: GET
        description: List all addresses
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createaddress
        method: POST
        description: Creates an address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: addresses-actions-validate
      path: /addresses/actions/validate
      operations:
      - name: validateaddress
        method: POST
        description: Validate an address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: addresses-id
      path: /addresses/{id}
      operations:
      - name: deleteaddress
        method: DELETE
        description: Deletes an address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: address ID
          required: true
      - name: getaddress
        method: GET
        description: Retrieve an address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: address ID
          required: true
    - name: addresses-id-actions-accept_suggestions
      path: /addresses/{id}/actions/accept_suggestions
      operations:
      - name: acceptaddresssuggestions
        method: POST
        description: Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads
          of the numbers associated with it to Microsoft.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The UUID of the address that should be accepted.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.TELNYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: telnyx-addresses-rest
    port: 8080
    description: REST adapter for Telnyx API — Addresses. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/addresses
      name: addresses
      description: REST surface for addresses.
      operations:
      - method: GET
        name: findaddresses
        description: List all addresses
        call: telnyx-addresses.findaddresses
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createaddress
        description: Creates an address
        call: telnyx-addresses.createaddress
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/addresses/actions/validate
      name: addresses-actions-validate
      description: REST surface for addresses-actions-validate.
      operations:
      - method: POST
        name: validateaddress
        description: Validate an address
        call: telnyx-addresses.validateaddress
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/addresses/{id}
      name: addresses-id
      description: REST surface for addresses-id.
      operations:
      - method: DELETE
        name: deleteaddress
        description: Deletes an address
        call: telnyx-addresses.deleteaddress
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getaddress
        description: Retrieve an address
        call: telnyx-addresses.getaddress
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/addresses/{id}/actions/accept-suggestions
      name: addresses-id-actions-accept-suggestions
      description: REST surface for addresses-id-actions-accept_suggestions.
      operations:
      - method: POST
        name: acceptaddresssuggestions
        description: Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads
          of the numbers associated with it to Microsoft.
        call: telnyx-addresses.acceptaddresssuggestions
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-addresses-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — Addresses. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-all-addresses
      description: List all addresses
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-addresses.findaddresses
      outputParameters:
      - type: object
        mapping: $.
    - name: creates-address
      description: Creates an address
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-addresses.createaddress
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-address
      description: Validate an address
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: telnyx-addresses.validateaddress
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: deletes-address
      description: Deletes an address
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-addresses.deleteaddress
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-address
      description: Retrieve an address
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-addresses.getaddress
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: accepts-this-address-suggestion-new
      description: Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads
        of the numbers associated with it to Microsoft.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-addresses.acceptaddresssuggestions
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.