Telnyx API — SIM Card Groups

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — SIM Card Groups
  description: 'Telnyx API — SIM Card Groups. 9 operations. Lead operation: Get all SIM card groups. Self-contained Naftiko
    capability covering one Telnyx business surface.'
  tags:
  - Telnyx
  - SIM Card 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-sim-card-groups
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — SIM Card Groups business capability. Self-contained, no shared references.
    resources:
    - name: sim_card_groups
      path: /sim_card_groups
      operations:
      - name: getallsimcardgroups
        method: GET
        description: Get all SIM card groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter[name]
          in: query
          type: string
          description: A valid SIM card group name.
        - name: filter[private_wireless_gateway_id]
          in: query
          type: string
          description: A Private Wireless Gateway ID associated with the group.
        - name: filter[wireless_blocklist_id]
          in: query
          type: string
          description: A Wireless Blocklist ID associated with the group.
      - name: createsimcardgroup
        method: POST
        description: Create a SIM card group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sim_card_groups-id
      path: /sim_card_groups/{id}
      operations:
      - name: deletesimcardgroup
        method: DELETE
        description: Delete a SIM card group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getsimcardgroup
        method: GET
        description: Get SIM card group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatesimcardgroup
        method: PATCH
        description: Update a SIM card group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sim_card_groups-id-actions-remove_private_wireless_gateway
      path: /sim_card_groups/{id}/actions/remove_private_wireless_gateway
      operations:
      - name: removesimcardgroupprivatewirelessgateway
        method: POST
        description: Request Private Wireless Gateway removal from SIM card group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sim_card_groups-id-actions-remove_wireless_blocklist
      path: /sim_card_groups/{id}/actions/remove_wireless_blocklist
      operations:
      - name: removewirelessblocklistforsimcardgroup
        method: POST
        description: Request Wireless Blocklist removal from SIM card group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sim_card_groups-id-actions-set_private_wireless_gateway
      path: /sim_card_groups/{id}/actions/set_private_wireless_gateway
      operations:
      - name: setprivatewirelessgatewayforsimcardgroup
        method: POST
        description: Request Private Wireless Gateway assignment for SIM card group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sim_card_groups-id-actions-set_wireless_blocklist
      path: /sim_card_groups/{id}/actions/set_wireless_blocklist
      operations:
      - name: setwirelessblocklistforsimcardgroup
        method: POST
        description: Request Wireless Blocklist assignment for SIM card group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - 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-sim-card-groups-rest
    port: 8080
    description: REST adapter for Telnyx API — SIM Card Groups. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/sim-card-groups
      name: sim-card-groups
      description: REST surface for sim_card_groups.
      operations:
      - method: GET
        name: getallsimcardgroups
        description: Get all SIM card groups
        call: telnyx-sim-card-groups.getallsimcardgroups
        with:
          filter[name]: rest.filter[name]
          filter[private_wireless_gateway_id]: rest.filter[private_wireless_gateway_id]
          filter[wireless_blocklist_id]: rest.filter[wireless_blocklist_id]
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsimcardgroup
        description: Create a SIM card group
        call: telnyx-sim-card-groups.createsimcardgroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-card-groups/{id}
      name: sim-card-groups-id
      description: REST surface for sim_card_groups-id.
      operations:
      - method: DELETE
        name: deletesimcardgroup
        description: Delete a SIM card group
        call: telnyx-sim-card-groups.deletesimcardgroup
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getsimcardgroup
        description: Get SIM card group
        call: telnyx-sim-card-groups.getsimcardgroup
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatesimcardgroup
        description: Update a SIM card group
        call: telnyx-sim-card-groups.updatesimcardgroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-card-groups/{id}/actions/remove-private-wireless-gateway
      name: sim-card-groups-id-actions-remove-private-wireless-gateway
      description: REST surface for sim_card_groups-id-actions-remove_private_wireless_gateway.
      operations:
      - method: POST
        name: removesimcardgroupprivatewirelessgateway
        description: Request Private Wireless Gateway removal from SIM card group
        call: telnyx-sim-card-groups.removesimcardgroupprivatewirelessgateway
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-card-groups/{id}/actions/remove-wireless-blocklist
      name: sim-card-groups-id-actions-remove-wireless-blocklist
      description: REST surface for sim_card_groups-id-actions-remove_wireless_blocklist.
      operations:
      - method: POST
        name: removewirelessblocklistforsimcardgroup
        description: Request Wireless Blocklist removal from SIM card group
        call: telnyx-sim-card-groups.removewirelessblocklistforsimcardgroup
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-card-groups/{id}/actions/set-private-wireless-gateway
      name: sim-card-groups-id-actions-set-private-wireless-gateway
      description: REST surface for sim_card_groups-id-actions-set_private_wireless_gateway.
      operations:
      - method: POST
        name: setprivatewirelessgatewayforsimcardgroup
        description: Request Private Wireless Gateway assignment for SIM card group
        call: telnyx-sim-card-groups.setprivatewirelessgatewayforsimcardgroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-card-groups/{id}/actions/set-wireless-blocklist
      name: sim-card-groups-id-actions-set-wireless-blocklist
      description: REST surface for sim_card_groups-id-actions-set_wireless_blocklist.
      operations:
      - method: POST
        name: setwirelessblocklistforsimcardgroup
        description: Request Wireless Blocklist assignment for SIM card group
        call: telnyx-sim-card-groups.setwirelessblocklistforsimcardgroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-sim-card-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — SIM Card Groups. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-all-sim-card-groups
      description: Get all SIM card groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-sim-card-groups.getallsimcardgroups
      with:
        filter[name]: tools.filter[name]
        filter[private_wireless_gateway_id]: tools.filter[private_wireless_gateway_id]
        filter[wireless_blocklist_id]: tools.filter[wireless_blocklist_id]
      outputParameters:
      - type: object
        mapping: $.
    - name: create-sim-card-group
      description: Create a SIM card group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-sim-card-groups.createsimcardgroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-sim-card-group
      description: Delete a SIM card group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-sim-card-groups.deletesimcardgroup
      outputParameters:
      - type: object
        mapping: $.
    - name: get-sim-card-group
      description: Get SIM card group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-sim-card-groups.getsimcardgroup
      outputParameters:
      - type: object
        mapping: $.
    - name: update-sim-card-group
      description: Update a SIM card group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: telnyx-sim-card-groups.updatesimcardgroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: request-private-wireless-gateway-removal
      description: Request Private Wireless Gateway removal from SIM card group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-sim-card-groups.removesimcardgroupprivatewirelessgateway
      outputParameters:
      - type: object
        mapping: $.
    - name: request-wireless-blocklist-removal-sim
      description: Request Wireless Blocklist removal from SIM card group
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: telnyx-sim-card-groups.removewirelessblocklistforsimcardgroup
      outputParameters:
      - type: object
        mapping: $.
    - name: request-private-wireless-gateway-assignment
      description: Request Private Wireless Gateway assignment for SIM card group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-sim-card-groups.setprivatewirelessgatewayforsimcardgroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: request-wireless-blocklist-assignment-sim
      description: Request Wireless Blocklist assignment for SIM card group
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: telnyx-sim-card-groups.setwirelessblocklistforsimcardgroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.