m3ter API — StatementDefinition

naftiko: 1.0.0-alpha2
info:
  label: m3ter API — StatementDefinition
  description: 'm3ter API — StatementDefinition. 5 operations. Lead operation: List StatementDefinitions. Self-contained Naftiko
    capability covering one M3ter business surface.'
  tags:
  - M3ter
  - StatementDefinition
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    M3TER_API_KEY: M3TER_API_KEY
capability:
  consumes:
  - type: http
    namespace: m3ter-statementdefinition
    baseUri: https://api.m3ter.com
    description: m3ter API — StatementDefinition business capability. Self-contained, no shared references.
    resources:
    - name: organizations-orgId-statementdefinitions
      path: /organizations/{orgId}/statementdefinitions
      operations:
      - name: liststatementdefinitions
        method: GET
        description: List StatementDefinitions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) of 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 StatementDefinitions 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 StatementDefinitions
            in a paginated list.
      - name: poststatementdefinition
        method: POST
        description: Create StatementDefinition
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) of 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-statementdefinitions-id
      path: /organizations/{orgId}/statementdefinitions/{id}
      operations:
      - name: getstatementdefinition
        method: GET
        description: Retrieve StatementDefinition
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) of 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 StatementDefinition to retrieve.
          required: true
      - name: putstatementdefinition
        method: PUT
        description: Update StatementDefinition
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
          required: true
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletestatementdefinition
        method: DELETE
        description: Delete StatementDefinition
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The unique identifier (UUID) of 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 StatementDefinition to delete.
          required: true
    authentication:
      type: bearer
      token: '{{env.M3TER_API_KEY}}'
  exposes:
  - type: rest
    namespace: m3ter-statementdefinition-rest
    port: 8080
    description: REST adapter for m3ter API — StatementDefinition. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organizations/{orgid}/statementdefinitions
      name: organizations-orgid-statementdefinitions
      description: REST surface for organizations-orgId-statementdefinitions.
      operations:
      - method: GET
        name: liststatementdefinitions
        description: List StatementDefinitions
        call: m3ter-statementdefinition.liststatementdefinitions
        with:
          orgId: rest.orgId
          pageSize: rest.pageSize
          nextToken: rest.nextToken
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: poststatementdefinition
        description: Create StatementDefinition
        call: m3ter-statementdefinition.poststatementdefinition
        with:
          orgId: rest.orgId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/statementdefinitions/{id}
      name: organizations-orgid-statementdefinitions-id
      description: REST surface for organizations-orgId-statementdefinitions-id.
      operations:
      - method: GET
        name: getstatementdefinition
        description: Retrieve StatementDefinition
        call: m3ter-statementdefinition.getstatementdefinition
        with:
          orgId: rest.orgId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putstatementdefinition
        description: Update StatementDefinition
        call: m3ter-statementdefinition.putstatementdefinition
        with:
          orgId: rest.orgId
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletestatementdefinition
        description: Delete StatementDefinition
        call: m3ter-statementdefinition.deletestatementdefinition
        with:
          orgId: rest.orgId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: m3ter-statementdefinition-mcp
    port: 9090
    transport: http
    description: MCP adapter for m3ter API — StatementDefinition. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-statementdefinitions
      description: List StatementDefinitions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-statementdefinition.liststatementdefinitions
      with:
        orgId: tools.orgId
        pageSize: tools.pageSize
        nextToken: tools.nextToken
      outputParameters:
      - type: object
        mapping: $.
    - name: create-statementdefinition
      description: Create StatementDefinition
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: m3ter-statementdefinition.poststatementdefinition
      with:
        orgId: tools.orgId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-statementdefinition
      description: Retrieve StatementDefinition
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-statementdefinition.getstatementdefinition
      with:
        orgId: tools.orgId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-statementdefinition
      description: Update StatementDefinition
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: m3ter-statementdefinition.putstatementdefinition
      with:
        orgId: tools.orgId
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-statementdefinition
      description: Delete StatementDefinition
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: m3ter-statementdefinition.deletestatementdefinition
      with:
        orgId: tools.orgId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.