m3ter API — Aggregation

naftiko: 1.0.0-alpha2
info:
  label: m3ter API — Aggregation
  description: 'm3ter API — Aggregation. 5 operations. Lead operation: List Aggregations. Self-contained Naftiko capability
    covering one M3ter business surface.'
  tags:
  - M3ter
  - Aggregation
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    M3TER_API_KEY: M3TER_API_KEY
capability:
  consumes:
  - type: http
    namespace: m3ter-aggregation
    baseUri: https://api.m3ter.com
    description: m3ter API — Aggregation business capability. Self-contained, no shared references.
    resources:
    - name: organizations-orgId-aggregations
      path: /organizations/{orgId}/aggregations
      operations:
      - name: listaggregations
        method: GET
        description: List Aggregations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter
            service.
          required: true
        - name: pageSize
          in: query
          type: integer
          description: Number of Aggregations to retrieve per page.
        - name: nextToken
          in: query
          type: string
          description: '`nextToken` for multi-page retrievals.'
        - name: productId
          in: query
          type: array
          description: The UUIDs of the Products to retrieve Aggregations for.
        - name: ids
          in: query
          type: array
          description: List of Aggregation IDs to retrieve.
        - name: codes
          in: query
          type: array
          description: List of Aggregation codes to retrieve. These are unique short codes to identify each Aggregation.
      - name: postaggregation
        method: POST
        description: Create Aggregation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter
            service.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-orgId-aggregations-id
      path: /organizations/{orgId}/aggregations/{id}
      operations:
      - name: getaggregation
        method: GET
        description: Retrieve Aggregation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter
            service.
          required: true
        - name: id
          in: path
          type: string
          description: The UUID of the Aggregation to retrieve.
          required: true
      - name: putaggregation
        method: PUT
        description: Update Aggregation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter
            service.
          required: true
        - name: id
          in: path
          type: string
          description: The UUID of the Aggregation to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteaggregation
        method: DELETE
        description: Delete Aggregation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter
            service.
          required: true
        - name: id
          in: path
          type: string
          description: The UUID of the Aggregation to delete.
          required: true
    authentication:
      type: bearer
      token: '{{env.M3TER_API_KEY}}'
  exposes:
  - type: rest
    namespace: m3ter-aggregation-rest
    port: 8080
    description: REST adapter for m3ter API — Aggregation. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/organizations/{orgid}/aggregations
      name: organizations-orgid-aggregations
      description: REST surface for organizations-orgId-aggregations.
      operations:
      - method: GET
        name: listaggregations
        description: List Aggregations
        call: m3ter-aggregation.listaggregations
        with:
          orgId: rest.orgId
          pageSize: rest.pageSize
          nextToken: rest.nextToken
          productId: rest.productId
          ids: rest.ids
          codes: rest.codes
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postaggregation
        description: Create Aggregation
        call: m3ter-aggregation.postaggregation
        with:
          orgId: rest.orgId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/aggregations/{id}
      name: organizations-orgid-aggregations-id
      description: REST surface for organizations-orgId-aggregations-id.
      operations:
      - method: GET
        name: getaggregation
        description: Retrieve Aggregation
        call: m3ter-aggregation.getaggregation
        with:
          orgId: rest.orgId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putaggregation
        description: Update Aggregation
        call: m3ter-aggregation.putaggregation
        with:
          orgId: rest.orgId
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteaggregation
        description: Delete Aggregation
        call: m3ter-aggregation.deleteaggregation
        with:
          orgId: rest.orgId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: m3ter-aggregation-mcp
    port: 9090
    transport: http
    description: MCP adapter for m3ter API — Aggregation. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-aggregations
      description: List Aggregations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-aggregation.listaggregations
      with:
        orgId: tools.orgId
        pageSize: tools.pageSize
        nextToken: tools.nextToken
        productId: tools.productId
        ids: tools.ids
        codes: tools.codes
      outputParameters:
      - type: object
        mapping: $.
    - name: create-aggregation
      description: Create Aggregation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: m3ter-aggregation.postaggregation
      with:
        orgId: tools.orgId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-aggregation
      description: Retrieve Aggregation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-aggregation.getaggregation
      with:
        orgId: tools.orgId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-aggregation
      description: Update Aggregation
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: m3ter-aggregation.putaggregation
      with:
        orgId: tools.orgId
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-aggregation
      description: Delete Aggregation
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: m3ter-aggregation.deleteaggregation
      with:
        orgId: tools.orgId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.