Telnyx API — Billing Groups

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Billing Groups
  description: 'Telnyx API — Billing Groups. 5 operations. Lead operation: List all billing groups. Self-contained Naftiko
    capability covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Billing Groups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-billing-groups
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Billing Groups business capability. Self-contained, no shared references.
    resources:
    - name: billing_groups
      path: /billing_groups
      operations:
      - name: listbillinggroups
        method: GET
        description: List all billing groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: object
          description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]'
      - name: createbillinggroup
        method: POST
        description: Create a billing group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: billing_groups-id
      path: /billing_groups/{id}
      operations:
      - name: deletebillinggroup
        method: DELETE
        description: Delete a billing group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The id of the billing group
          required: true
      - name: getbillinggroup
        method: GET
        description: Get a billing group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The id of the billing group
          required: true
      - name: updatebillinggroup
        method: PATCH
        description: Update a billing group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The id of the billing group
          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-billing-groups-rest
    port: 8080
    description: REST adapter for Telnyx API — Billing Groups. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/billing-groups
      name: billing-groups
      description: REST surface for billing_groups.
      operations:
      - method: GET
        name: listbillinggroups
        description: List all billing groups
        call: telnyx-billing-groups.listbillinggroups
        with:
          page: rest.page
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createbillinggroup
        description: Create a billing group
        call: telnyx-billing-groups.createbillinggroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/billing-groups/{id}
      name: billing-groups-id
      description: REST surface for billing_groups-id.
      operations:
      - method: DELETE
        name: deletebillinggroup
        description: Delete a billing group
        call: telnyx-billing-groups.deletebillinggroup
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getbillinggroup
        description: Get a billing group
        call: telnyx-billing-groups.getbillinggroup
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatebillinggroup
        description: Update a billing group
        call: telnyx-billing-groups.updatebillinggroup
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-billing-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — Billing Groups. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-all-billing-groups
      description: List all billing groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-billing-groups.listbillinggroups
      with:
        page: tools.page
      outputParameters:
      - type: object
        mapping: $.
    - name: create-billing-group
      description: Create a billing group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-billing-groups.createbillinggroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-billing-group
      description: Delete a billing group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-billing-groups.deletebillinggroup
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-billing-group
      description: Get a billing group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-billing-groups.getbillinggroup
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-billing-group
      description: Update a billing group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: telnyx-billing-groups.updatebillinggroup
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.