API Reference — subpackage_conditionSets

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_conditionSets
  description: 'API Reference — subpackage_conditionSets. 2 operations. Lead operation: List condition sets <Badge intent="info"
    minimal outlined>OAuth Scope: condition_sets:read</Badge>. Self-contained Naftiko capability covering one Beehiiv business
    surface.'
  tags:
  - Beehiiv
  - subpackage_conditionSets
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BEEHIIV_API_KEY: BEEHIIV_API_KEY
capability:
  consumes:
  - type: http
    namespace: beehiiv-subpackage-conditionsets
    baseUri: https://api.beehiiv.com/v2
    description: API Reference — subpackage_conditionSets business capability. Self-contained, no shared references.
    resources:
    - name: publications-publicationId-condition_sets
      path: /publications/{publicationId}/condition_sets
      operations:
      - name: index
        method: GET
        description: 'List condition sets <Badge intent="info" minimal outlined>OAuth Scope: condition_sets:read</Badge>'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: publicationId
          in: path
          type: string
          description: The prefixed ID of the publication object
          required: true
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default
            is 10.
        - name: cursor
          in: query
          type: string
          description: '**Cursor-based pagination (recommended)**: Use this opaque cursor token to fetch the next page of
            results. When provided, pagination will use cursor-based metho'
        - name: page
          in: query
          type: integer
          description: '**Offset-based pagination (deprecated)**: Page number for offset-based pagination. Please migrate
            to cursor-based pagination using the `cursor` parameter. If no'
        - name: purpose
          in: query
          type: string
          description: Filter condition sets by purpose. When not specified, all active condition sets are returned.
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
    - name: publications-publicationId-condition_sets-conditionSetId
      path: /publications/{publicationId}/condition_sets/{conditionSetId}
      operations:
      - name: show
        method: GET
        description: 'Get condition set <Badge intent="info" minimal outlined>OAuth Scope: condition_sets:read</Badge>'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: publicationId
          in: path
          type: string
          description: The prefixed ID of the publication object
          required: true
        - name: conditionSetId
          in: path
          type: string
          description: The UUID of the condition set object
          required: true
        - name: expand[]
          in: query
          type: array
          description: Optionally expand the response to include additional data.<br> `stats` - Calculates and returns the
            active subscriber count for this condition set synchronously
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
    authentication:
      type: bearer
      token: '{{env.BEEHIIV_API_KEY}}'
  exposes:
  - type: rest
    namespace: beehiiv-subpackage-conditionsets-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_conditionSets. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/publications/{publicationid}/condition-sets
      name: publications-publicationid-condition-sets
      description: REST surface for publications-publicationId-condition_sets.
      operations:
      - method: GET
        name: index
        description: 'List condition sets <Badge intent="info" minimal outlined>OAuth Scope: condition_sets:read</Badge>'
        call: beehiiv-subpackage-conditionsets.index
        with:
          publicationId: rest.publicationId
          limit: rest.limit
          cursor: rest.cursor
          page: rest.page
          purpose: rest.purpose
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/publications/{publicationid}/condition-sets/{conditionsetid}
      name: publications-publicationid-condition-sets-conditionsetid
      description: REST surface for publications-publicationId-condition_sets-conditionSetId.
      operations:
      - method: GET
        name: show
        description: 'Get condition set <Badge intent="info" minimal outlined>OAuth Scope: condition_sets:read</Badge>'
        call: beehiiv-subpackage-conditionsets.show
        with:
          publicationId: rest.publicationId
          conditionSetId: rest.conditionSetId
          expand[]: rest.expand[]
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: beehiiv-subpackage-conditionsets-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_conditionSets. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-condition-sets-badge-intent-info
      description: 'List condition sets <Badge intent="info" minimal outlined>OAuth Scope: condition_sets:read</Badge>'
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: beehiiv-subpackage-conditionsets.index
      with:
        publicationId: tools.publicationId
        limit: tools.limit
        cursor: tools.cursor
        page: tools.page
        purpose: tools.purpose
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-condition-set-badge-intent-info
      description: 'Get condition set <Badge intent="info" minimal outlined>OAuth Scope: condition_sets:read</Badge>'
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: beehiiv-subpackage-conditionsets.show
      with:
        publicationId: tools.publicationId
        conditionSetId: tools.conditionSetId
        expand[]: tools.expand[]
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.