Hunter API — Campaigns

naftiko: 1.0.0-alpha2
info:
  label: Hunter API — Campaigns
  description: 'Hunter API — Campaigns. 5 operations. Lead operation: Hunter List Campaigns. Self-contained Naftiko capability
    covering one Hunter business surface.'
  tags:
  - Hunter
  - Campaigns
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HUNTER_API_KEY: HUNTER_API_KEY
capability:
  consumes:
  - type: http
    namespace: hunter-campaigns
    baseUri: https://api.hunter.io/v2
    description: Hunter API — Campaigns business capability. Self-contained, no shared references.
    resources:
    - name: campaigns
      path: /campaigns
      operations:
      - name: listcampaigns
        method: GET
        description: Hunter List Campaigns
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Maximum number of campaigns to return. Default is 20, max is 100.
        - name: offset
          in: query
          type: integer
          description: Number of campaigns to skip for pagination.
        - name: started
          in: query
          type: boolean
          description: Filter by whether the campaign has been started.
        - name: archived
          in: query
          type: boolean
          description: Filter by whether the campaign has been archived.
    - name: campaigns-id-recipients
      path: /campaigns/{id}/recipients
      operations:
      - name: listcampaignrecipients
        method: GET
        description: Hunter List Campaign Recipients
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Maximum number of recipients to return.
        - name: offset
          in: query
          type: integer
          description: Number of recipients to skip for pagination.
      - name: addcampaignrecipients
        method: POST
        description: Hunter Add Campaign Recipients
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: cancelcampaignrecipients
        method: DELETE
        description: Hunter Cancel Campaign Recipients
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: campaigns-id-start
      path: /campaigns/{id}/start
      operations:
      - name: startcampaign
        method: POST
        description: Hunter Start Campaign
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.HUNTER_API_KEY}}'
  exposes:
  - type: rest
    namespace: hunter-campaigns-rest
    port: 8080
    description: REST adapter for Hunter 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: Hunter List Campaigns
        call: hunter-campaigns.listcampaigns
        with:
          limit: rest.limit
          offset: rest.offset
          started: rest.started
          archived: rest.archived
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/campaigns/{id}/recipients
      name: campaigns-id-recipients
      description: REST surface for campaigns-id-recipients.
      operations:
      - method: GET
        name: listcampaignrecipients
        description: Hunter List Campaign Recipients
        call: hunter-campaigns.listcampaignrecipients
        with:
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addcampaignrecipients
        description: Hunter Add Campaign Recipients
        call: hunter-campaigns.addcampaignrecipients
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: cancelcampaignrecipients
        description: Hunter Cancel Campaign Recipients
        call: hunter-campaigns.cancelcampaignrecipients
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/campaigns/{id}/start
      name: campaigns-id-start
      description: REST surface for campaigns-id-start.
      operations:
      - method: POST
        name: startcampaign
        description: Hunter Start Campaign
        call: hunter-campaigns.startcampaign
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: hunter-campaigns-mcp
    port: 9090
    transport: http
    description: MCP adapter for Hunter API — Campaigns. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: hunter-list-campaigns
      description: Hunter List Campaigns
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hunter-campaigns.listcampaigns
      with:
        limit: tools.limit
        offset: tools.offset
        started: tools.started
        archived: tools.archived
      outputParameters:
      - type: object
        mapping: $.
    - name: hunter-list-campaign-recipients
      description: Hunter List Campaign Recipients
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hunter-campaigns.listcampaignrecipients
      with:
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: hunter-add-campaign-recipients
      description: Hunter Add Campaign Recipients
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: hunter-campaigns.addcampaignrecipients
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hunter-cancel-campaign-recipients
      description: Hunter Cancel Campaign Recipients
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: hunter-campaigns.cancelcampaignrecipients
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hunter-start-campaign
      description: Hunter Start Campaign
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: hunter-campaigns.startcampaign
      outputParameters:
      - type: object
        mapping: $.