m3ter API — ExportSchedule

naftiko: 1.0.0-alpha2
info:
  label: m3ter API — ExportSchedule
  description: 'm3ter API — ExportSchedule. 5 operations. Lead operation: List Schedules. Self-contained Naftiko capability
    covering one M3ter business surface.'
  tags:
  - M3ter
  - ExportSchedule
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    M3TER_API_KEY: M3TER_API_KEY
capability:
  consumes:
  - type: http
    namespace: m3ter-exportschedule
    baseUri: https://api.m3ter.com
    description: m3ter API — ExportSchedule business capability. Self-contained, no shared references.
    resources:
    - name: organizations-orgId-dataexports-schedules
      path: /organizations/{orgId}/dataexports/schedules
      operations:
      - name: listschedules
        method: GET
        description: List Schedules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the organization
          required: true
        - name: pageSize
          in: query
          type: integer
          description: Number of schedules to retrieve per page
        - name: nextToken
          in: query
          type: string
          description: '`nextToken` for multi page retrievals'
        - name: ids
          in: query
          type: array
          description: Data Export Schedule IDs to filter the returned list by.
      - name: createschedule
        method: POST
        description: Create Schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the organization
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-orgId-dataexports-schedules-id
      path: /organizations/{orgId}/dataexports/schedules/{id}
      operations:
      - name: getschedule
        method: GET
        description: Retrieve Schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the organization
          required: true
        - name: id
          in: path
          type: string
          description: The UUID of the Schedule to retrieve.
          required: true
      - name: updateschedule
        method: PUT
        description: Update Schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the organization
          required: true
        - name: id
          in: path
          type: string
          description: The UUID of the Schedule to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteschedule
        method: DELETE
        description: Delete Schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the organization
          required: true
        - name: id
          in: path
          type: string
          description: The UUID of the Schedule to delete.
          required: true
    authentication:
      type: bearer
      token: '{{env.M3TER_API_KEY}}'
  exposes:
  - type: rest
    namespace: m3ter-exportschedule-rest
    port: 8080
    description: REST adapter for m3ter API — ExportSchedule. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/organizations/{orgid}/dataexports/schedules
      name: organizations-orgid-dataexports-schedules
      description: REST surface for organizations-orgId-dataexports-schedules.
      operations:
      - method: GET
        name: listschedules
        description: List Schedules
        call: m3ter-exportschedule.listschedules
        with:
          orgId: rest.orgId
          pageSize: rest.pageSize
          nextToken: rest.nextToken
          ids: rest.ids
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createschedule
        description: Create Schedule
        call: m3ter-exportschedule.createschedule
        with:
          orgId: rest.orgId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/dataexports/schedules/{id}
      name: organizations-orgid-dataexports-schedules-id
      description: REST surface for organizations-orgId-dataexports-schedules-id.
      operations:
      - method: GET
        name: getschedule
        description: Retrieve Schedule
        call: m3ter-exportschedule.getschedule
        with:
          orgId: rest.orgId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateschedule
        description: Update Schedule
        call: m3ter-exportschedule.updateschedule
        with:
          orgId: rest.orgId
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteschedule
        description: Delete Schedule
        call: m3ter-exportschedule.deleteschedule
        with:
          orgId: rest.orgId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: m3ter-exportschedule-mcp
    port: 9090
    transport: http
    description: MCP adapter for m3ter API — ExportSchedule. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-schedules
      description: List Schedules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-exportschedule.listschedules
      with:
        orgId: tools.orgId
        pageSize: tools.pageSize
        nextToken: tools.nextToken
        ids: tools.ids
      outputParameters:
      - type: object
        mapping: $.
    - name: create-schedule
      description: Create Schedule
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: m3ter-exportschedule.createschedule
      with:
        orgId: tools.orgId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-schedule
      description: Retrieve Schedule
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-exportschedule.getschedule
      with:
        orgId: tools.orgId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-schedule
      description: Update Schedule
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: m3ter-exportschedule.updateschedule
      with:
        orgId: tools.orgId
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-schedule
      description: Delete Schedule
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: m3ter-exportschedule.deleteschedule
      with:
        orgId: tools.orgId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.