Sendoso Sending Platform API — Sends

naftiko: 1.0.0-alpha2
info:
  label: Sendoso Sending Platform API — Sends
  description: 'Sendoso Sending Platform API — Sends. 4 operations. Lead operation: List Sends. Self-contained Naftiko capability
    covering one Sendoso business surface.'
  tags:
  - Sendoso
  - Sends
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SENDOSO_API_KEY: SENDOSO_API_KEY
capability:
  consumes:
  - type: http
    namespace: sendoso-sends
    baseUri: https://app.sendoso.com/api/v2
    description: Sendoso Sending Platform API — Sends business capability. Self-contained, no shared references.
    resources:
    - name: sends
      path: /sends
      operations:
      - name: listsends
        method: GET
        description: List Sends
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
          description: Page number for pagination
        - name: per_page
          in: query
          type: integer
          description: Results per page
        - name: status
          in: query
          type: string
          description: Filter by send status
        - name: start_date
          in: query
          type: string
          description: Filter sends created on or after this date
        - name: end_date
          in: query
          type: string
          description: Filter sends created on or before this date
      - name: createsend
        method: POST
        description: Create Send
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sends-send_id
      path: /sends/{send_id}
      operations:
      - name: retrievesend
        method: GET
        description: Retrieve Send
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: cancelsend
        method: DELETE
        description: Cancel Send
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-Api-Key
      value: '{{env.SENDOSO_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: sendoso-sends-rest
    port: 8080
    description: REST adapter for Sendoso Sending Platform API — Sends. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/sends
      name: sends
      description: REST surface for sends.
      operations:
      - method: GET
        name: listsends
        description: List Sends
        call: sendoso-sends.listsends
        with:
          page: rest.page
          per_page: rest.per_page
          status: rest.status
          start_date: rest.start_date
          end_date: rest.end_date
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsend
        description: Create Send
        call: sendoso-sends.createsend
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sends/{send-id}
      name: sends-send-id
      description: REST surface for sends-send_id.
      operations:
      - method: GET
        name: retrievesend
        description: Retrieve Send
        call: sendoso-sends.retrievesend
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: cancelsend
        description: Cancel Send
        call: sendoso-sends.cancelsend
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sendoso-sends-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sendoso Sending Platform API — Sends. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-sends
      description: List Sends
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sendoso-sends.listsends
      with:
        page: tools.page
        per_page: tools.per_page
        status: tools.status
        start_date: tools.start_date
        end_date: tools.end_date
      outputParameters:
      - type: object
        mapping: $.
    - name: create-send
      description: Create Send
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sendoso-sends.createsend
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-send
      description: Retrieve Send
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sendoso-sends.retrievesend
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-send
      description: Cancel Send
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: sendoso-sends.cancelsend
      outputParameters:
      - type: object
        mapping: $.