Transactional Email API — offers

naftiko: 1.0.0-alpha2
info:
  label: Transactional Email API — offers
  description: 'Transactional Email API — offers. 4 operations. Lead operation: Get information about subscribed offers. Self-contained
    Naftiko capability covering one Scaleway business surface.'
  tags:
  - Scaleway
  - offers
  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-offers
    baseUri: https://api.scaleway.com
    description: Transactional Email API — offers business capability. Self-contained, no shared references.
    resources:
    - name: transactional-email-v1alpha1-regions-region-offer-subscriptions
      path: /transactional-email/v1alpha1/regions/{region}/offer-subscriptions
      operations:
      - name: listoffersubscriptions
        method: GET
        description: Get information about subscribed offers
        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: project_id
          in: query
          type: string
          description: ID of the Project. (UUID format)
          required: true
      - name: updateoffersubscription
        method: PATCH
        description: Update a subscribed offer
        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-offers
      path: /transactional-email/v1alpha1/regions/{region}/offers
      operations:
      - name: listoffers
        method: GET
        description: List the available offers.
        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: transactional-email-v1alpha1-regions-region-pools
      path: /transactional-email/v1alpha1/regions/{region}/pools
      operations:
      - name: listpools
        method: GET
        description: Get information about a sending pool.
        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: page
          in: query
          type: integer
          description: Requested page number. Value must be greater or equal to 1.
        - name: page_size
          in: query
          type: integer
          description: Requested page size. Value must be between 1 and 1000.
        - name: project_id
          in: query
          type: string
          description: ID of the Project. (UUID format)
          required: true
    authentication:
      type: apikey
      key: X-Auth-Token
      value: '{{env.SCALEWAY_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: transactional-email-offers-rest
    port: 8080
    description: REST adapter for Transactional Email API — offers. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/transactional-email/v1alpha1/regions/{region}/offer-subscriptions
      name: transactional-email-v1alpha1-regions-region-offer-subscriptions
      description: REST surface for transactional-email-v1alpha1-regions-region-offer-subscriptions.
      operations:
      - method: GET
        name: listoffersubscriptions
        description: Get information about subscribed offers
        call: transactional-email-offers.listoffersubscriptions
        with:
          region: rest.region
          project_id: rest.project_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateoffersubscription
        description: Update a subscribed offer
        call: transactional-email-offers.updateoffersubscription
        with:
          region: rest.region
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/transactional-email/v1alpha1/regions/{region}/offers
      name: transactional-email-v1alpha1-regions-region-offers
      description: REST surface for transactional-email-v1alpha1-regions-region-offers.
      operations:
      - method: GET
        name: listoffers
        description: List the available offers.
        call: transactional-email-offers.listoffers
        with:
          region: rest.region
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/transactional-email/v1alpha1/regions/{region}/pools
      name: transactional-email-v1alpha1-regions-region-pools
      description: REST surface for transactional-email-v1alpha1-regions-region-pools.
      operations:
      - method: GET
        name: listpools
        description: Get information about a sending pool.
        call: transactional-email-offers.listpools
        with:
          region: rest.region
          page: rest.page
          page_size: rest.page_size
          project_id: rest.project_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: transactional-email-offers-mcp
    port: 9090
    transport: http
    description: MCP adapter for Transactional Email API — offers. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-information-about-subscribed-offers
      description: Get information about subscribed offers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: transactional-email-offers.listoffersubscriptions
      with:
        region: tools.region
        project_id: tools.project_id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-subscribed-offer
      description: Update a subscribed offer
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: transactional-email-offers.updateoffersubscription
      with:
        region: tools.region
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-available-offers
      description: List the available offers.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: transactional-email-offers.listoffers
      with:
        region: tools.region
      outputParameters:
      - type: object
        mapping: $.
    - name: get-information-about-sending-pool
      description: Get information about a sending pool.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: transactional-email-offers.listpools
      with:
        region: tools.region
        page: tools.page
        page_size: tools.page_size
        project_id: tools.project_id
      outputParameters:
      - type: object
        mapping: $.