Transactional Email API — Blocklist

naftiko: 1.0.0-alpha2
info:
  label: Transactional Email API — Blocklist
  description: 'Transactional Email API — Blocklist. 3 operations. Lead operation: List blocklists. Self-contained Naftiko
    capability covering one Scaleway business surface.'
  tags:
  - Scaleway
  - Blocklist
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SCALEWAY_API_KEY: SCALEWAY_API_KEY
capability:
  consumes:
  - type: http
    namespace: transactional-email-blocklist
    baseUri: https://api.scaleway.com
    description: Transactional Email API — Blocklist business capability. Self-contained, no shared references.
    resources:
    - name: transactional-email-v1alpha1-regions-region-blocklists
      path: /transactional-email/v1alpha1/regions/{region}/blocklists
      operations:
      - name: listblocklists
        method: GET
        description: List blocklists
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: region
          in: path
          type: string
          description: The region you want to target
          required: true
        - name: order_by
          in: query
          type: string
          description: (Optional) List blocklist corresponding to specific criteria.
        - name: page
          in: query
          type: integer
          description: (Optional) Requested page number. Value must be greater or equal to 1.
        - name: page_size
          in: query
          type: integer
          description: (Optional) Requested page size. Value must be between 1 and 100.
        - name: domain_id
          in: query
          type: string
          description: (Optional) Filter by a domain ID. (UUID format)
          required: true
        - name: email
          in: query
          type: string
          description: (Optional) Filter by an email address.
        - name: type
          in: query
          type: string
          description: (Optional) Filter by a blocklist type.
        - name: custom
          in: query
          type: boolean
          description: (Optional) Filter by custom blocklist (true) or automatic Transactional Email blocklist (false).
      - name: bulkcreateblocklists
        method: POST
        description: Bulk create blocklists
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: region
          in: path
          type: string
          description: The region you want to target
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: transactional-email-v1alpha1-regions-region-blocklists-blocklist_id
      path: /transactional-email/v1alpha1/regions/{region}/blocklists/{blocklist_id}
      operations:
      - name: deleteblocklist
        method: DELETE
        description: Delete a blocklist
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: region
          in: path
          type: string
          description: The region you want to target
          required: true
        - name: blocklist_id
          in: path
          type: string
          description: ID of the blocklist to delete. (UUID format)
          required: true
    authentication:
      type: apikey
      key: X-Auth-Token
      value: '{{env.SCALEWAY_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: transactional-email-blocklist-rest
    port: 8080
    description: REST adapter for Transactional Email API — Blocklist. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/transactional-email/v1alpha1/regions/{region}/blocklists
      name: transactional-email-v1alpha1-regions-region-blocklists
      description: REST surface for transactional-email-v1alpha1-regions-region-blocklists.
      operations:
      - method: GET
        name: listblocklists
        description: List blocklists
        call: transactional-email-blocklist.listblocklists
        with:
          region: rest.region
          order_by: rest.order_by
          page: rest.page
          page_size: rest.page_size
          domain_id: rest.domain_id
          email: rest.email
          type: rest.type
          custom: rest.custom
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: bulkcreateblocklists
        description: Bulk create blocklists
        call: transactional-email-blocklist.bulkcreateblocklists
        with:
          region: rest.region
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/transactional-email/v1alpha1/regions/{region}/blocklists/{blocklist-id}
      name: transactional-email-v1alpha1-regions-region-blocklists-blocklist-id
      description: REST surface for transactional-email-v1alpha1-regions-region-blocklists-blocklist_id.
      operations:
      - method: DELETE
        name: deleteblocklist
        description: Delete a blocklist
        call: transactional-email-blocklist.deleteblocklist
        with:
          region: rest.region
          blocklist_id: rest.blocklist_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: transactional-email-blocklist-mcp
    port: 9090
    transport: http
    description: MCP adapter for Transactional Email API — Blocklist. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-blocklists
      description: List blocklists
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: transactional-email-blocklist.listblocklists
      with:
        region: tools.region
        order_by: tools.order_by
        page: tools.page
        page_size: tools.page_size
        domain_id: tools.domain_id
        email: tools.email
        type: tools.type
        custom: tools.custom
      outputParameters:
      - type: object
        mapping: $.
    - name: bulk-create-blocklists
      description: Bulk create blocklists
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: transactional-email-blocklist.bulkcreateblocklists
      with:
        region: tools.region
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-blocklist
      description: Delete a blocklist
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: transactional-email-blocklist.deleteblocklist
      with:
        region: tools.region
        blocklist_id: tools.blocklist_id
      outputParameters:
      - type: object
        mapping: $.