Twilio SendGrid User API — Users API

naftiko: 1.0.0-alpha2
info:
  label: Twilio SendGrid User API — Users API
  description: 'Twilio SendGrid User API — Users API. 9 operations. Lead operation: Get a user''s account information.. Self-contained
    Naftiko capability covering one Sendgrid business surface.'
  tags:
  - Sendgrid
  - Users API
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SENDGRID_API_KEY: SENDGRID_API_KEY
capability:
  consumes:
  - type: http
    namespace: tsg_user_v3-users-api
    baseUri: https://api.sendgrid.com
    description: Twilio SendGrid User API — Users API business capability. Self-contained, no shared references.
    resources:
    - name: v3-user-account
      path: /v3/user/account
      operations:
      - name: listaccount
        method: GET
        description: Get a user's account information.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v3-user-credits
      path: /v3/user/credits
      operations:
      - name: listcredit
        method: GET
        description: Retrieve your credit balance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v3-user-email
      path: /v3/user/email
      operations:
      - name: listemail
        method: GET
        description: Retrieve your account email address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateemail
        method: PUT
        description: Update your account email address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v3-user-password
      path: /v3/user/password
      operations:
      - name: updatepassword
        method: PUT
        description: Update your password
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v3-user-profile
      path: /v3/user/profile
      operations:
      - name: listprofile
        method: GET
        description: Get a user's profile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateprofile
        method: PATCH
        description: Update a user's profile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v3-user-username
      path: /v3/user/username
      operations:
      - name: listusername
        method: GET
        description: Retrieve your username
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateusername
        method: PUT
        description: Update your username
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.SENDGRID_API_KEY}}'
  exposes:
  - type: rest
    namespace: tsg_user_v3-users-api-rest
    port: 8080
    description: REST adapter for Twilio SendGrid User API — Users API. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v3/user/account
      name: v3-user-account
      description: REST surface for v3-user-account.
      operations:
      - method: GET
        name: listaccount
        description: Get a user's account information.
        call: tsg_user_v3-users-api.listaccount
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/user/credits
      name: v3-user-credits
      description: REST surface for v3-user-credits.
      operations:
      - method: GET
        name: listcredit
        description: Retrieve your credit balance
        call: tsg_user_v3-users-api.listcredit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/user/email
      name: v3-user-email
      description: REST surface for v3-user-email.
      operations:
      - method: GET
        name: listemail
        description: Retrieve your account email address
        call: tsg_user_v3-users-api.listemail
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateemail
        description: Update your account email address
        call: tsg_user_v3-users-api.updateemail
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/user/password
      name: v3-user-password
      description: REST surface for v3-user-password.
      operations:
      - method: PUT
        name: updatepassword
        description: Update your password
        call: tsg_user_v3-users-api.updatepassword
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/user/profile
      name: v3-user-profile
      description: REST surface for v3-user-profile.
      operations:
      - method: GET
        name: listprofile
        description: Get a user's profile
        call: tsg_user_v3-users-api.listprofile
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateprofile
        description: Update a user's profile
        call: tsg_user_v3-users-api.updateprofile
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/user/username
      name: v3-user-username
      description: REST surface for v3-user-username.
      operations:
      - method: GET
        name: listusername
        description: Retrieve your username
        call: tsg_user_v3-users-api.listusername
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateusername
        description: Update your username
        call: tsg_user_v3-users-api.updateusername
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: tsg_user_v3-users-api-mcp
    port: 9090
    transport: http
    description: MCP adapter for Twilio SendGrid User API — Users API. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-user-s-account-information
      description: Get a user's account information.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tsg_user_v3-users-api.listaccount
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-your-credit-balance
      description: Retrieve your credit balance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tsg_user_v3-users-api.listcredit
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-your-account-email-address
      description: Retrieve your account email address
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tsg_user_v3-users-api.listemail
      outputParameters:
      - type: object
        mapping: $.
    - name: update-your-account-email-address
      description: Update your account email address
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: tsg_user_v3-users-api.updateemail
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-your-password
      description: Update your password
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: tsg_user_v3-users-api.updatepassword
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-user-s-profile
      description: Get a user's profile
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tsg_user_v3-users-api.listprofile
      outputParameters:
      - type: object
        mapping: $.
    - name: update-user-s-profile
      description: Update a user's profile
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: tsg_user_v3-users-api.updateprofile
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-your-username
      description: Retrieve your username
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tsg_user_v3-users-api.listusername
      outputParameters:
      - type: object
        mapping: $.
    - name: update-your-username
      description: Update your username
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: tsg_user_v3-users-api.updateusername
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.