Bandwidth Phone Numbers API — Orders

naftiko: 1.0.0-alpha2
info:
  label: Bandwidth Phone Numbers API — Orders
  description: 'Bandwidth Phone Numbers API — Orders. 3 operations. Lead operation: Create a phone number order. Self-contained
    Naftiko capability covering one Bandwidth business surface.'
  tags:
  - Bandwidth
  - Orders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BANDWIDTH_API_KEY: BANDWIDTH_API_KEY
capability:
  consumes:
  - type: http
    namespace: phone-numbers-orders
    baseUri: https://dashboard.bandwidth.com/api
    description: Bandwidth Phone Numbers API — Orders business capability. Self-contained, no shared references.
    resources:
    - name: accounts-accountId-orders
      path: /accounts/{accountId}/orders
      operations:
      - name: createorder
        method: POST
        description: Create a phone number order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listorders
        method: GET
        description: List phone number orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: Filter by order status
        - name: startDate
          in: query
          type: string
          description: Filter orders created on or after this date
        - name: endDate
          in: query
          type: string
          description: Filter orders created on or before this date
    - name: accounts-accountId-orders-orderId
      path: /accounts/{accountId}/orders/{orderId}
      operations:
      - name: getorder
        method: GET
        description: Get order details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.BANDWIDTH_USER}}'
      password: '{{env.BANDWIDTH_PASS}}'
  exposes:
  - type: rest
    namespace: phone-numbers-orders-rest
    port: 8080
    description: REST adapter for Bandwidth Phone Numbers API — Orders. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/accounts/{accountid}/orders
      name: accounts-accountid-orders
      description: REST surface for accounts-accountId-orders.
      operations:
      - method: POST
        name: createorder
        description: Create a phone number order
        call: phone-numbers-orders.createorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listorders
        description: List phone number orders
        call: phone-numbers-orders.listorders
        with:
          status: rest.status
          startDate: rest.startDate
          endDate: rest.endDate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/accounts/{accountid}/orders/{orderid}
      name: accounts-accountid-orders-orderid
      description: REST surface for accounts-accountId-orders-orderId.
      operations:
      - method: GET
        name: getorder
        description: Get order details
        call: phone-numbers-orders.getorder
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: phone-numbers-orders-mcp
    port: 9090
    transport: http
    description: MCP adapter for Bandwidth Phone Numbers API — Orders. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-phone-number-order
      description: Create a phone number order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: phone-numbers-orders.createorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-phone-number-orders
      description: List phone number orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: phone-numbers-orders.listorders
      with:
        status: tools.status
        startDate: tools.startDate
        endDate: tools.endDate
      outputParameters:
      - type: object
        mapping: $.
    - name: get-order-details
      description: Get order details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: phone-numbers-orders.getorder
      outputParameters:
      - type: object
        mapping: $.