m3ter API — CompoundAggregation

naftiko: 1.0.0-alpha2
info:
  label: m3ter API — CompoundAggregation
  description: 'm3ter API — CompoundAggregation. 5 operations. Lead operation: List CompoundAggregations. Self-contained Naftiko
    capability covering one M3ter business surface.'
  tags:
  - M3ter
  - CompoundAggregation
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    M3TER_API_KEY: M3TER_API_KEY
capability:
  consumes:
  - type: http
    namespace: m3ter-compoundaggregation
    baseUri: https://api.m3ter.com
    description: m3ter API — CompoundAggregation business capability. Self-contained, no shared references.
    resources:
    - name: organizations-orgId-compoundaggregations
      path: /organizations/{orgId}/compoundaggregations
      operations:
      - name: listcompoundaggregations
        method: GET
        description: List CompoundAggregations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) for your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: pageSize
          in: query
          type: integer
          description: Specifies the maximum number of CompoundAggregations to retrieve per page.
        - name: nextToken
          in: query
          type: string
          description: The `nextToken` for multi-page retrievals. It is used to fetch the next page of CompoundAggregations
            in a paginated list.
        - name: productId
          in: query
          type: array
          description: An optional parameter to filter the CompoundAggregations based on specific Product unique identifiers
            (UUIDs).
        - name: ids
          in: query
          type: array
          description: An optional parameter to retrieve specific CompoundAggregations based on their unique identifiers (UUIDs).
        - name: codes
          in: query
          type: array
          description: An optional parameter to retrieve specific CompoundAggregations based on their short codes.
      - name: postcompoundaggregation
        method: POST
        description: Create CompoundAggregation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) for your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-orgId-compoundaggregations-id
      path: /organizations/{orgId}/compoundaggregations/{id}
      operations:
      - name: getcompoundaggregation
        method: GET
        description: Retrieve CompoundAggregation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) for your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: id
          in: path
          type: string
          description: The unique identifier (UUID) of the CompoundAggregation to retrieve.
          required: true
      - name: putcompoundaggregation
        method: PUT
        description: Update CompoundAggregation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) for your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: id
          in: path
          type: string
          description: The unique identifier (UUID) of the CompoundAggregation to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecompoundaggregation
        method: DELETE
        description: Delete CompoundAggregation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) for your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: id
          in: path
          type: string
          description: The unique identifier (UUID) of the CompoundAggregation to delete.
          required: true
    authentication:
      type: bearer
      token: '{{env.M3TER_API_KEY}}'
  exposes:
  - type: rest
    namespace: m3ter-compoundaggregation-rest
    port: 8080
    description: REST adapter for m3ter API — CompoundAggregation. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organizations/{orgid}/compoundaggregations
      name: organizations-orgid-compoundaggregations
      description: REST surface for organizations-orgId-compoundaggregations.
      operations:
      - method: GET
        name: listcompoundaggregations
        description: List CompoundAggregations
        call: m3ter-compoundaggregation.listcompoundaggregations
        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: postcompoundaggregation
        description: Create CompoundAggregation
        call: m3ter-compoundaggregation.postcompoundaggregation
        with:
          orgId: rest.orgId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/compoundaggregations/{id}
      name: organizations-orgid-compoundaggregations-id
      description: REST surface for organizations-orgId-compoundaggregations-id.
      operations:
      - method: GET
        name: getcompoundaggregation
        description: Retrieve CompoundAggregation
        call: m3ter-compoundaggregation.getcompoundaggregation
        with:
          orgId: rest.orgId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putcompoundaggregation
        description: Update CompoundAggregation
        call: m3ter-compoundaggregation.putcompoundaggregation
        with:
          orgId: rest.orgId
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecompoundaggregation
        description: Delete CompoundAggregation
        call: m3ter-compoundaggregation.deletecompoundaggregation
        with:
          orgId: rest.orgId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: m3ter-compoundaggregation-mcp
    port: 9090
    transport: http
    description: MCP adapter for m3ter API — CompoundAggregation. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-compoundaggregations
      description: List CompoundAggregations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-compoundaggregation.listcompoundaggregations
      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-compoundaggregation
      description: Create CompoundAggregation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: m3ter-compoundaggregation.postcompoundaggregation
      with:
        orgId: tools.orgId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-compoundaggregation
      description: Retrieve CompoundAggregation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-compoundaggregation.getcompoundaggregation
      with:
        orgId: tools.orgId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-compoundaggregation
      description: Update CompoundAggregation
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: m3ter-compoundaggregation.putcompoundaggregation
      with:
        orgId: tools.orgId
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-compoundaggregation
      description: Delete CompoundAggregation
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: m3ter-compoundaggregation.deletecompoundaggregation
      with:
        orgId: tools.orgId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.