Contents

# Quickly and easily access the Twilio SendGrid API.
module SendGrid
  class API < BaseInterface
    # * *Args* :
    #   - +api_key+ -> your Twilio SendGrid API key
    #   - +host+ -> the base URL for the API
    #   - +request_headers+ -> any headers that you want to be globally applied
    #   - +version+ -> the version of the API you wish to access,
    #                  currently only "v3" is supported
    #   - +impersonate_subuser+ -> the subuser to impersonate, will be passed
    #                              in the "On-Behalf-Of" header
    #
    def initialize(api_key:, host: nil, request_headers: nil, version: nil, impersonate_subuser: nil)
      auth = "Bearer #{api_key}"
      host ||= 'https://api.sendgrid.com'

      super(auth: auth, host: host, request_headers: request_headers, version: version, impersonate_subuser: impersonate_subuser)
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
sendgrid-ruby-6.3.9	lib/sendgrid/sendgrid.rb
sendgrid-ruby-6.3.8	lib/sendgrid/sendgrid.rb
sendgrid-ruby-6.3.7	lib/sendgrid/sendgrid.rb
sendgrid-ruby-6.3.6	lib/sendgrid/sendgrid.rb
sendgrid-ruby-6.3.5	lib/sendgrid/sendgrid.rb