Twilio SendGrid IP Warmup API — IP Warmup

naftiko: 1.0.0-alpha2
info:
  label: Twilio SendGrid IP Warmup API — IP Warmup
  description: 'Twilio SendGrid IP Warmup API — IP Warmup. 4 operations. Lead operation: Start warming up an IP address. Self-contained
    Naftiko capability covering one Sendgrid business surface.'
  tags:
  - Sendgrid
  - IP Warmup
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SENDGRID_API_KEY: SENDGRID_API_KEY
capability:
  consumes:
  - type: http
    namespace: tsg_ip_warmup_v3-ip-warmup
    baseUri: https://api.sendgrid.com
    description: Twilio SendGrid IP Warmup API — IP Warmup business capability. Self-contained, no shared references.
    resources:
    - name: v3-ips-warmup
      path: /v3/ips/warmup
      operations:
      - name: warmupip
        method: POST
        description: Start warming up an IP address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: listwarmupip
        method: GET
        description: Retrieve all IPs currently in warmup
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v3-ips-warmup-ip_address
      path: /v3/ips/warmup/{ip_address}
      operations:
      - name: getwarmupip
        method: GET
        description: Retrieve the warmup status for a specific IP address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: stopipwarmup
        method: DELETE
        description: Stop warming up an IP address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SENDGRID_API_KEY}}'
  exposes:
  - type: rest
    namespace: tsg_ip_warmup_v3-ip-warmup-rest
    port: 8080
    description: REST adapter for Twilio SendGrid IP Warmup API — IP Warmup. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v3/ips/warmup
      name: v3-ips-warmup
      description: REST surface for v3-ips-warmup.
      operations:
      - method: POST
        name: warmupip
        description: Start warming up an IP address
        call: tsg_ip_warmup_v3-ip-warmup.warmupip
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listwarmupip
        description: Retrieve all IPs currently in warmup
        call: tsg_ip_warmup_v3-ip-warmup.listwarmupip
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/ips/warmup/{ip-address}
      name: v3-ips-warmup-ip-address
      description: REST surface for v3-ips-warmup-ip_address.
      operations:
      - method: GET
        name: getwarmupip
        description: Retrieve the warmup status for a specific IP address
        call: tsg_ip_warmup_v3-ip-warmup.getwarmupip
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: stopipwarmup
        description: Stop warming up an IP address
        call: tsg_ip_warmup_v3-ip-warmup.stopipwarmup
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: tsg_ip_warmup_v3-ip-warmup-mcp
    port: 9090
    transport: http
    description: MCP adapter for Twilio SendGrid IP Warmup API — IP Warmup. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: start-warming-up-ip-address
      description: Start warming up an IP address
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: tsg_ip_warmup_v3-ip-warmup.warmupip
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-all-ips-currently-warmup
      description: Retrieve all IPs currently in warmup
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tsg_ip_warmup_v3-ip-warmup.listwarmupip
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-warmup-status-specific-ip
      description: Retrieve the warmup status for a specific IP address
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tsg_ip_warmup_v3-ip-warmup.getwarmupip
      outputParameters:
      - type: object
        mapping: $.
    - name: stop-warming-up-ip-address
      description: Stop warming up an IP address
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: tsg_ip_warmup_v3-ip-warmup.stopipwarmup
      outputParameters:
      - type: object
        mapping: $.