Telnyx API — Requirement Groups

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Requirement Groups
  description: 'Telnyx API — Requirement Groups. 8 operations. Lead operation: Update requirement group for a phone number
    order. Self-contained Naftiko capability covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Requirement 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-requirement-groups
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Requirement Groups business capability. Self-contained, no shared references.
    resources:
    - name: number_order_phone_numbers-id-requirement_group
      path: /number_order_phone_numbers/{id}/requirement_group
      operations:
      - name: updatenumberorderphonenumberrequirementgroup
        method: POST
        description: Update requirement group for a phone number order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the number order phone number
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: requirement_groups
      path: /requirement_groups
      operations:
      - name: getrequirementgroups
        method: GET
        description: List requirement groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[country_code], filter[phone_number_type],
            filter[action], filter[status], filter[customer_r'
      - name: createrequirementgroup
        method: POST
        description: Create a new requirement group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: requirement_groups-id
      path: /requirement_groups/{id}
      operations:
      - name: deleterequirementgroup
        method: DELETE
        description: Delete a requirement group by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the requirement group
          required: true
      - name: getrequirementgroup
        method: GET
        description: Get a single requirement group by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the requirement group to retrieve
          required: true
      - name: updaterequirementgroup
        method: PATCH
        description: Update requirement values in requirement group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the requirement group
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: requirement_groups-id-submit_for_approval
      path: /requirement_groups/{id}/submit_for_approval
      operations:
      - name: submitrequirementgroup
        method: POST
        description: Submit a Requirement Group for Approval
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the requirement group to submit
          required: true
    - name: sub_number_orders-id-requirement_group
      path: /sub_number_orders/{id}/requirement_group
      operations:
      - name: updatesubnumberorderrequirementgroup
        method: POST
        description: Update requirement group for a sub number order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the sub number order
          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-requirement-groups-rest
    port: 8080
    description: REST adapter for Telnyx API — Requirement Groups. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/number-order-phone-numbers/{id}/requirement-group
      name: number-order-phone-numbers-id-requirement-group
      description: REST surface for number_order_phone_numbers-id-requirement_group.
      operations:
      - method: POST
        name: updatenumberorderphonenumberrequirementgroup
        description: Update requirement group for a phone number order
        call: telnyx-requirement-groups.updatenumberorderphonenumberrequirementgroup
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/requirement-groups
      name: requirement-groups
      description: REST surface for requirement_groups.
      operations:
      - method: GET
        name: getrequirementgroups
        description: List requirement groups
        call: telnyx-requirement-groups.getrequirementgroups
        with:
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createrequirementgroup
        description: Create a new requirement group
        call: telnyx-requirement-groups.createrequirementgroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/requirement-groups/{id}
      name: requirement-groups-id
      description: REST surface for requirement_groups-id.
      operations:
      - method: DELETE
        name: deleterequirementgroup
        description: Delete a requirement group by ID
        call: telnyx-requirement-groups.deleterequirementgroup
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getrequirementgroup
        description: Get a single requirement group by ID
        call: telnyx-requirement-groups.getrequirementgroup
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updaterequirementgroup
        description: Update requirement values in requirement group
        call: telnyx-requirement-groups.updaterequirementgroup
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/requirement-groups/{id}/submit-for-approval
      name: requirement-groups-id-submit-for-approval
      description: REST surface for requirement_groups-id-submit_for_approval.
      operations:
      - method: POST
        name: submitrequirementgroup
        description: Submit a Requirement Group for Approval
        call: telnyx-requirement-groups.submitrequirementgroup
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sub-number-orders/{id}/requirement-group
      name: sub-number-orders-id-requirement-group
      description: REST surface for sub_number_orders-id-requirement_group.
      operations:
      - method: POST
        name: updatesubnumberorderrequirementgroup
        description: Update requirement group for a sub number order
        call: telnyx-requirement-groups.updatesubnumberorderrequirementgroup
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-requirement-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — Requirement Groups. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: update-requirement-group-phone-number
      description: Update requirement group for a phone number order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-requirement-groups.updatenumberorderphonenumberrequirementgroup
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-requirement-groups
      description: List requirement groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-requirement-groups.getrequirementgroups
      with:
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-requirement-group
      description: Create a new requirement group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-requirement-groups.createrequirementgroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-requirement-group-id
      description: Delete a requirement group by ID
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-requirement-groups.deleterequirementgroup
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-single-requirement-group-id
      description: Get a single requirement group by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-requirement-groups.getrequirementgroup
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-requirement-values-requirement-group
      description: Update requirement values in requirement group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: telnyx-requirement-groups.updaterequirementgroup
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: submit-requirement-group-approval
      description: Submit a Requirement Group for Approval
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-requirement-groups.submitrequirementgroup
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-requirement-group-sub-number
      description: Update requirement group for a sub number order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-requirement-groups.updatesubnumberorderrequirementgroup
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.