m3ter API — Invitations

naftiko: 1.0.0-alpha2
info:
  label: m3ter API — Invitations
  description: 'm3ter API — Invitations. 3 operations. Lead operation: Retrieve Invitations. Self-contained Naftiko capability
    covering one M3ter business surface.'
  tags:
  - M3ter
  - Invitations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    M3TER_API_KEY: M3TER_API_KEY
capability:
  consumes:
  - type: http
    namespace: m3ter-invitations
    baseUri: https://api.m3ter.com
    description: m3ter API — Invitations business capability. Self-contained, no shared references.
    resources:
    - name: organizations-orgId-invitations
      path: /organizations/{orgId}/invitations
      operations:
      - name: listorguserinvitations
        method: GET
        description: Retrieve Invitations
        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 invitations to retrieve per page.
        - name: nextToken
          in: query
          type: string
          description: '`nextToken` for multi page retrievals.'
      - name: createorguserinvitation
        method: POST
        description: Invite User to Organization
        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-invitations-id
      path: /organizations/{orgId}/invitations/{id}
      operations:
      - name: getorguserinvitation
        method: GET
        description: Retrieve Invitation
        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: UUID of the specific invitation to retrieve.
          required: true
    authentication:
      type: bearer
      token: '{{env.M3TER_API_KEY}}'
  exposes:
  - type: rest
    namespace: m3ter-invitations-rest
    port: 8080
    description: REST adapter for m3ter API — Invitations. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/organizations/{orgid}/invitations
      name: organizations-orgid-invitations
      description: REST surface for organizations-orgId-invitations.
      operations:
      - method: GET
        name: listorguserinvitations
        description: Retrieve Invitations
        call: m3ter-invitations.listorguserinvitations
        with:
          orgId: rest.orgId
          pageSize: rest.pageSize
          nextToken: rest.nextToken
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createorguserinvitation
        description: Invite User to Organization
        call: m3ter-invitations.createorguserinvitation
        with:
          orgId: rest.orgId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/invitations/{id}
      name: organizations-orgid-invitations-id
      description: REST surface for organizations-orgId-invitations-id.
      operations:
      - method: GET
        name: getorguserinvitation
        description: Retrieve Invitation
        call: m3ter-invitations.getorguserinvitation
        with:
          orgId: rest.orgId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: m3ter-invitations-mcp
    port: 9090
    transport: http
    description: MCP adapter for m3ter API — Invitations. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: retrieve-invitations
      description: Retrieve Invitations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-invitations.listorguserinvitations
      with:
        orgId: tools.orgId
        pageSize: tools.pageSize
        nextToken: tools.nextToken
      outputParameters:
      - type: object
        mapping: $.
    - name: invite-user-organization
      description: Invite User to Organization
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: m3ter-invitations.createorguserinvitation
      with:
        orgId: tools.orgId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-invitation
      description: Retrieve Invitation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-invitations.getorguserinvitation
      with:
        orgId: tools.orgId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.