Litmus Email Analytics API — Campaigns

naftiko: 1.0.0-alpha2
info:
  label: Litmus Email Analytics API — Campaigns
  description: 'Litmus Email Analytics API — Campaigns. 4 operations. Lead operation: Litmus List campaigns. Self-contained
    Naftiko capability covering one Litmus business surface.'
  tags:
  - Litmus
  - Campaigns
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LITMUS_API_KEY: LITMUS_API_KEY
capability:
  consumes:
  - type: http
    namespace: email-analytics-campaigns
    baseUri: https://analytics-api.litmus.com/api/v1
    description: Litmus Email Analytics API — Campaigns business capability. Self-contained, no shared references.
    resources:
    - name: campaigns
      path: /campaigns
      operations:
      - name: listcampaigns
        method: GET
        description: Litmus List campaigns
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createcampaign
        method: POST
        description: Litmus Create a campaign
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: campaigns-campaignGuid
      path: /campaigns/{campaignGuid}
      operations:
      - name: getcampaign
        method: GET
        description: Litmus Get a campaign
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletecampaign
        method: DELETE
        description: Litmus Delete a campaign
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.LITMUS_USER}}'
      password: '{{env.LITMUS_PASS}}'
  exposes:
  - type: rest
    namespace: email-analytics-campaigns-rest
    port: 8080
    description: REST adapter for Litmus Email Analytics API — Campaigns. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/campaigns
      name: campaigns
      description: REST surface for campaigns.
      operations:
      - method: GET
        name: listcampaigns
        description: Litmus List campaigns
        call: email-analytics-campaigns.listcampaigns
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcampaign
        description: Litmus Create a campaign
        call: email-analytics-campaigns.createcampaign
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/campaigns/{campaignguid}
      name: campaigns-campaignguid
      description: REST surface for campaigns-campaignGuid.
      operations:
      - method: GET
        name: getcampaign
        description: Litmus Get a campaign
        call: email-analytics-campaigns.getcampaign
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecampaign
        description: Litmus Delete a campaign
        call: email-analytics-campaigns.deletecampaign
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: email-analytics-campaigns-mcp
    port: 9090
    transport: http
    description: MCP adapter for Litmus Email Analytics API — Campaigns. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: litmus-list-campaigns
      description: Litmus List campaigns
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: email-analytics-campaigns.listcampaigns
      outputParameters:
      - type: object
        mapping: $.
    - name: litmus-create-campaign
      description: Litmus Create a campaign
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: email-analytics-campaigns.createcampaign
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: litmus-get-campaign
      description: Litmus Get a campaign
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: email-analytics-campaigns.getcampaign
      outputParameters:
      - type: object
        mapping: $.
    - name: litmus-delete-campaign
      description: Litmus Delete a campaign
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: email-analytics-campaigns.deletecampaign
      outputParameters:
      - type: object
        mapping: $.