RubyGems - sendgrid-ruby - Versions diffs - 1.1.6 → 6.0.4 - Mend

sendgrid-ruby 1.1.6 → 6.0.4

Files changed (136) hide show

checksums.yaml +5 -5
data/.codeclimate.yml +21 -0
data/.env_sample +1 -3
data/.gitignore +1 -0
data/.travis.yml +28 -17
data/CHANGELOG.md +231 -1
data/CODE_OF_CONDUCT.md +73 -0
data/CONTRIBUTING.md +214 -0
data/Gemfile +5 -4
data/ISSUE_TEMPLATE.md +26 -0
data/LICENSE.md +21 -0
data/Makefile +7 -0
data/PULL_REQUEST_TEMPLATE.md +31 -0
data/README.md +161 -225
data/Rakefile +9 -2
data/TROUBLESHOOTING.md +137 -0
data/UPGRADE.md +5 -0
data/USAGE.md +5037 -0
data/USE_CASES.md +377 -0
data/config.ru +4 -0
data/docker/Dockerfile +12 -0
data/docker/README.md +30 -0
data/examples/accesssettings/accesssettings.rb +83 -0
data/examples/alerts/alerts.rb +62 -0
data/examples/apikeys/apikeys.rb +84 -0
data/examples/asm/asm.rb +173 -0
data/examples/browsers/browsers.rb +16 -0
data/examples/campaigns/campaigns.rb +153 -0
data/examples/categories/categories.rb +36 -0
data/examples/clients/clients.rb +27 -0
data/examples/contactdb/contactdb.rb +395 -0
data/examples/devices/devices.rb +16 -0
data/examples/geo/geo.rb +16 -0
data/examples/helpers/mail/example.rb +147 -0
data/examples/helpers/settings/example.rb +23 -0
data/examples/helpers/stats/example.rb +42 -0
data/examples/ips/ips.rb +167 -0
data/examples/mail/mail.rb +173 -0
data/examples/mailboxproviders/mailboxproviders.rb +16 -0
data/examples/mailsettings/mailsettings.rb +219 -0
data/examples/partnersettings/partnersettings.rb +39 -0
data/examples/scopes/scopes.rb +61 -0
data/examples/senderauthentication/senderauthentication.rb +310 -0
data/examples/senders/senders.rb +98 -0
data/examples/stats/stats.rb +16 -0
data/examples/subusers/subusers.rb +169 -0
data/examples/suppression/suppression.rb +201 -0
data/examples/templates/templates.rb +129 -0
data/examples/trackingsettings/trackingsettings.rb +110 -0
data/examples/user/user.rb +293 -0
data/gemfiles/Sinatra_1.gemfile +6 -0
data/gemfiles/Sinatra_2.gemfile +6 -0
data/lib/sendgrid/client.rb +33 -57
data/lib/sendgrid/helpers/inbound/README.md +98 -0
data/lib/sendgrid/helpers/inbound/app.rb +32 -0
data/lib/sendgrid/helpers/inbound/config.yml +26 -0
data/lib/sendgrid/helpers/inbound/public/index.html +10 -0
data/lib/sendgrid/helpers/inbound/sample_data/default_data.txt +58 -0
data/lib/sendgrid/helpers/inbound/sample_data/raw_data.txt +57 -0
data/lib/sendgrid/helpers/inbound/sample_data/raw_data_with_attachments.txt +298 -0
data/lib/sendgrid/helpers/inbound/send.rb +26 -0
data/lib/sendgrid/helpers/ip_management/ip_management.rb +17 -0
data/lib/sendgrid/helpers/mail/README.md +14 -0
data/lib/sendgrid/helpers/mail/asm.rb +33 -0
data/lib/sendgrid/helpers/mail/attachment.rb +86 -0
data/lib/sendgrid/helpers/mail/bcc_settings.rb +33 -0
data/lib/sendgrid/helpers/mail/bypass_list_management.rb +43 -0
data/lib/sendgrid/helpers/mail/category.rb +20 -0
data/lib/sendgrid/helpers/mail/click_tracking.rb +33 -0
data/lib/sendgrid/helpers/mail/content.rb +20 -0
data/lib/sendgrid/helpers/mail/custom_arg.rb +24 -0
data/lib/sendgrid/helpers/mail/email.rb +29 -0
data/lib/sendgrid/helpers/mail/footer.rb +43 -0
data/lib/sendgrid/helpers/mail/ganalytics.rb +74 -0
data/lib/sendgrid/helpers/mail/header.rb +24 -0
data/lib/sendgrid/helpers/mail/mail.rb +140 -0
data/lib/sendgrid/helpers/mail/mail_settings.rb +63 -0
data/lib/sendgrid/helpers/mail/open_tracking.rb +33 -0
data/lib/sendgrid/helpers/mail/personalization.rb +82 -0
data/lib/sendgrid/helpers/mail/section.rb +24 -0
data/lib/sendgrid/helpers/mail/spam_check.rb +43 -0
data/lib/sendgrid/helpers/mail/subscription_tracking.rb +53 -0
data/lib/sendgrid/helpers/mail/substitution.rb +24 -0
data/lib/sendgrid/helpers/mail/tracking_settings.rb +53 -0
data/lib/sendgrid/helpers/permissions/scope.rb +28 -0
data/lib/sendgrid/helpers/permissions/scopes.yml +309 -0
data/lib/sendgrid/helpers/settings/README.md +14 -0
data/lib/sendgrid/helpers/settings/mail_settings_dto.rb +13 -0
data/lib/sendgrid/helpers/settings/partner_settings_dto.rb +13 -0
data/lib/sendgrid/helpers/settings/settings.rb +28 -0
data/lib/sendgrid/helpers/settings/tracking_settings_dto.rb +24 -0
data/lib/sendgrid/helpers/settings/user_settings_dto.rb +13 -0
data/lib/sendgrid/helpers/stats/email_stats.rb +46 -0
data/lib/sendgrid/helpers/stats/metrics.rb +35 -0
data/lib/sendgrid/helpers/stats/stats_response.rb +31 -0
data/lib/sendgrid/version.rb +1 -1
data/lib/sendgrid-ruby.rb +27 -6
data/mail_helper_v3.md +390 -0
data/sendgrid-ruby.gemspec +13 -17
data/spec/sendgrid/helpers/ip_management/ip_management_spec.rb +12 -0
data/spec/sendgrid/helpers/settings/mail_settings_dto_spec.rb +32 -0
data/spec/sendgrid/helpers/settings/partner_settings_dto_spec.rb +24 -0
data/spec/sendgrid/helpers/settings/settings_spec.rb +25 -0
data/spec/sendgrid/helpers/settings/tracking_settings_dto_spec.rb +27 -0
data/spec/sendgrid/helpers/settings/user_settings_dto_spec.rb +24 -0
data/spec/sendgrid/helpers/stats/email_stats_spec.rb +112 -0
data/spec/sendgrid/helpers/stats/metrics_spec.rb +46 -0
data/spec/sendgrid/helpers/stats/stats_response_spec.rb +76 -0
data/spec/spec_helper.rb +10 -1
data/test/prism.sh +42 -0
data/test/sendgrid/helpers/mail/test_attachment.rb +35 -0
data/test/sendgrid/helpers/mail/test_category.rb +27 -0
data/test/sendgrid/helpers/mail/test_email.rb +34 -0
data/test/sendgrid/helpers/mail/test_mail.rb +261 -0
data/test/sendgrid/helpers/mail/test_personalizations.rb +161 -0
data/test/sendgrid/permissions/test_scopes.rb +38 -0
data/test/sendgrid/test_sendgrid-ruby.rb +2751 -0
metadata +149 -115
data/.rspec +0 -2
data/.rubocop.yml +0 -30
data/FETCH_HEAD +0 -0
data/Guardfile +0 -10
data/LICENSE.txt +0 -22
data/example.rb +0 -41
data/lib/sendgrid/exceptions.rb +0 -7
data/lib/sendgrid/mail.rb +0 -182
data/lib/sendgrid/recipient.rb +0 -29
data/lib/sendgrid/response.rb +0 -14
data/lib/sendgrid/template.rb +0 -26
data/lib/sendgrid/template_mailer.rb +0 -59
data/spec/lib/sendgrid/client_spec.rb +0 -87
data/spec/lib/sendgrid/mail_spec.rb +0 -151
data/spec/lib/sendgrid/recipient_spec.rb +0 -91
data/spec/lib/sendgrid/template_mailer_spec.rb +0 -86
data/spec/lib/sendgrid/template_spec.rb +0 -61
data/spec/lib/sendgrid_spec.rb +0 -7

data/USE_CASES.md ADDED Viewed

@@ -0,0 +1,377 @@
+This documentation provides examples for specific use cases. Please [open an issue](https://github.com/sendgrid/sendgrid-ruby/issues) or make a pull request for any use cases you would like us to document here. Thank you!
+# Table of Contents
+* [Transactional Templates](#transactional-templates)
+  * [With Mail Helper Class](#with-mail-helper-class)
+  * [Without Mail Helper Class](#without-mail-helper-class)
+* [Legacy Templates](#legacy-templates)
+  * [With Mail Helper Class](#with-mail-helper-class-1)
+  * [Without Mail Helper Class](#without-mail-helper-class-1)
+  * [Adding Attachments](#adding-attachments)
+* [How to Setup a Domain Authentication](#how-to-setup-a-domain-authentication)
+* [How to View Email Statistics](#how-to-view-email-statistics)
+* [Send a SMS Message](#send-a-sms-message)
+  * [1. Obtain a Free Twilio Account](#1-obtain-a-free-twilio-account)
+  * [2. Update Your Environment Variables](#2-update-your-environment-variables)
+    * [Mac](#mac)
+    * [Windows](#windows)
+  * [3. Install the Twilio Helper Library](#3-install-the-twilio-helper-library)
+  * [4. Setup Work](#4-setup-work)
+  * [5. Send an SMS](#5-send-an-sms)
+<a name="transactional-templates"></a>
+# Transactional Templates
+For this example, we assume you have created a [transactional template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html) in the UI or via the API. Following is the template content we used for testing.
+Template ID (replace with your own):
+```text
+d-2c214ac919e84170b21855cc129b4a5f
+```
+Email Subject:
+```text
+{{subject}}
+```
+Template Body:
+```html
+<html>
+  <head>
+    <title></title>
+  </head>
+  <body>
+    Hello {{name}},
+    <br/><br/>
+    I'm glad you are trying out the template feature!
+    <br/><br/>
+    I hope you are having a great day in {{city}} :)
+    <br/><br/>
+  </body>
+</html>
+```
+## With Mail Helper Class
+```ruby
+require 'sendgrid-ruby'
+include SendGrid
+mail = Mail.new
+mail.from = Email.new(email: 'test@example.com')
+personalization = Personalization.new
+personalization.add_to(Email.new(email: 'test@example.com'))
+personalization.add_dynamic_template_data({
+    "subject" => "Testing Templates",
+    "name" => "Example User",
+    "city" => "Denver"
+  })
+mail.add_personalization(personalization)
+mail.template_id = 'd-2c214ac919e84170b21855cc129b4a5f'
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+begin
+    response = sg.client.mail._("send").post(request_body: mail.to_json)
+rescue Exception => e
+    puts e.message
+end
+puts response.status_code
+puts response.body
+puts response.parsed_body
+puts response.headers
+```
+## Without Mail Helper Class
+```ruby
+require 'sendgrid-ruby'
+include SendGrid
+data = JSON.parse('{
+  "personalizations": [
+    {
+      "to": [
+        {
+          "email": "test@example.com"
+        }
+      ],
+      "dynamic_template_data": {
+        "subject": "Testing Templates",
+        "name": "Example User",
+        "city": "Denver"
+      }
+    }
+  ],
+  "from": {
+    "email": "test@example.com"
+  },
+  "template_id": "d-2c214ac919e84170b21855cc129b4a5f"
+}')
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+begin
+    response = sg.client.mail._("send").post(request_body: data)
+rescue Exception => e
+    puts e.message
+end
+puts response.status_code
+puts response.body
+puts response.parsed_body
+puts response.headers
+```
+<a name="legacy-templates"></a>
+# Legacy Templates
+For this example, we assume you have created a [legacy template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html). Following is the template content we used for testing.
+Template ID (replace with your own):
+```text
+13b8f94f-bcae-4ec6-b752-70d6cb59f932
+```
+Email Subject:
+```text
+<%subject%>
+```
+Template Body:
+```html
+<html>
+<head>
+	<title></title>
+</head>
+<body>
+Hello -name-,
+<br /><br/>
+I'm glad you are trying out the template feature!
+<br /><br/>
+<%body%>
+<br /><br/>
+I hope you are having a great day in -city- :)
+<br /><br/>
+</body>
+</html>
+```
+## With Mail Helper Class
+```ruby
+require 'sendgrid-ruby'
+include SendGrid
+mail = SendGrid::Mail.new
+mail.from = Email.new(email: 'test@example.com')
+mail.subject = 'I\'m replacing the subject tag'
+personalization = Personalization.new
+personalization.add_to(Email.new(email: 'test@example.com'))
+personalization.add_substitution(Substitution.new(key: '-name-', value: 'Example User'))
+personalization.add_substitution(Substitution.new(key: '-city-', value: 'Denver'))
+mail.add_personalization(personalization)
+mail.template_id = '13b8f94f-bcae-4ec6-b752-70d6cb59f932'
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+begin
+    response = sg.client.mail._("send").post(request_body: mail.to_json)
+rescue Exception => e
+    puts e.message
+end
+puts response.status_code
+puts response.body
+puts response.parsed_body
+puts response.headers
+```
+## Without Mail Helper Class
+```ruby
+require 'sendgrid-ruby'
+include SendGrid
+data = JSON.parse('{
+  "personalizations": [
+    {
+      "to": [
+        {
+          "email": "test@example.com"
+        }
+      ],
+      "substitutions": {
+        "-name-": "Example User",
+        "-city-": "Denver"
+      },
+      "subject": "I\'m replacing the subject tag"
+    }
+  ],
+  "from": {
+    "email": "test@example.com"
+  },
+  "template_id": "13b8f94f-bcae-4ec6-b752-70d6cb59f932"
+}')
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+begin
+    response = sg.client.mail._("send").post(request_body: data)
+rescue Exception => e
+    puts e.message
+end
+puts response.status_code
+puts response.body
+puts response.parsed_body
+puts response.headers
+```
+## Adding Attachments
+```ruby
+attachment = Attachment.new
+attachment.content = Base64.strict_encode64(File.open(fpath, 'rb').read)
+attachment.type = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+attachment.filename = fname
+attachment.disposition = 'attachment'
+attachment.content_id = 'Reports Sheet'
+mail.add_attachment(attachment)
+```
+Attachments must be base64 encoded, using Base64's strict_encode64 where no line feeds are added.
+<a name="domain-authentication"></a>
+# How to Setup a Domain Authentication
+You can find documentation for how to setup a domain authentication via the UI [here](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication/) and via API [here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/client/USAGE.md#sender-authentication).
+Find more information about all of SendGrid's authentication related documentation [here](https://sendgrid.com/docs/ui/account-and-settings/).
+<a name="email-statistics"></a>
+# How to View Email Statistics
+You can find documentation for how to view your email statistics via the UI [here](https://app.sendgrid.com/statistics) and via API [here](https://github.com/sendgrid/sendgrid-ruby/blob/master/USAGE.md#stats).
+Alternatively, we can post events to a URL of your choice via our [Event Webhook](https://sendgrid.com/docs/API_Reference/Webhooks/event.html) about events that occur as Twilio SendGrid processes your email.
+You can also use the email statistics helper to make it easier to interact with the API.
+```ruby
+require 'sendgrid-ruby'
+require 'date'
+include SendGrid
+sg_client = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']).client
+stats = SendGrid::EmailStats.new(sendgrid_client: sg_client)
+# Fetch stats by day, between 2 dates
+from = Date.new(2017, 10, 01)
+to = Date.new(2017, 10, 12)
+email_stats = stats.by_day(from, to)
+email_stats.metrics
+if !email_stats.error?
+  email_stats.metrics.each do |metric|
+    puts "Date - #{metric.date}"
+    puts "Number of Requests - #{metric.requests}"
+    puts "Bounces - #{metric.bounces}"
+    puts "Opens - #{metric.opens}"
+    puts "Clicks - #{metric.clicks}"
+  end
+end
+# Fetch stats by week, between 2 dates for a category
+from = Date.new(2017, 10, 01)
+to = Date.new(2017, 10, 12)
+category = 'abcd'
+email_stats = stats.by_week(from, to, category)
+if !email_stats.error?
+  email_stats.metrics.each do |metric|
+    puts "Date - #{metric.date}"
+    puts "Number of Requests - #{metric.requests}"
+    puts "Bounces - #{metric.bounces}"
+    puts "Opens - #{metric.opens}"
+    puts "Clicks - #{metric.clicks}"
+  end
+end
+```
+<a name="sms"></a>
+# Send a SMS Message
+Following are the steps to add Twilio SMS to your app:
+## 1. Obtain a Free Twilio Account
+Sign up for a free Twilio account [here](https://www.twilio.com/try-twilio?source=sendgrid-ruby).
+## 2. Update Your Environment Variables
+You can obtain your Account Sid and Auth Token from [twilio.com/console](https://twilio.com/console).
+### Mac
+```bash
+echo "export TWILIO_ACCOUNT_SID='YOUR_TWILIO_ACCOUNT_SID'" > twilio.env
+echo "export TWILIO_AUTH_TOKEN='YOUR_TWILIO_AUTH_TOKEN'" >> twilio.env
+echo "twilio.env" >> .gitignore
+source ./twilio.env
+```
+### Windows
+Temporarily set the environment variable (accessible only during the current CLI session):
+```bash
+set TWILIO_ACCOUNT_SID=YOUR_TWILIO_ACCOUNT_SID
+set TWILIO_AUTH_TOKEN=YOUR_TWILIO_AUTH_TOKEN
+```
+Permanently set the environment variable (accessible in all subsequent CLI sessions):
+```bash
+setx TWILIO_ACCOUNT_SID "YOUR_TWILIO_ACCOUNT_SID"
+setx TWILIO_AUTH_TOKEN "YOUR_TWILIO_AUTH_TOKEN"
+```
+## 3. Install the Twilio Helper Library
+To install using [Bundler][bundler] grab the latest stable version:
+```ruby
+gem 'twilio-ruby', '~> 5.23.1'
+```
+To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
+```bash
+gem install twilio-ruby -v 5.23.1
+```
+## 4. Setup Work
+```ruby
+require 'twilio-ruby'
+# put your own credentials here
+account_sid = ENV['TWILIO_ACCOUNT_SID']
+auth_token = ENV['TWILIO_AUTH_TOKEN']
+# set up a client to talk to the Twilio REST API
+@client = Twilio::REST::Client.new account_sid, auth_token
+```
+## 5. Send an SMS
+```ruby
+@client.api.account.messages.create(
+  from: '+14159341234',
+  to: '+16105557069',
+  body: 'Hey there!'
+)
+```
+For more information, please visit the [Twilio SMS Ruby documentation](https://www.twilio.com/docs/sms/quickstart/ruby).

data/config.ru ADDED Viewed

@@ -0,0 +1,4 @@
+require './lib/sendgrid/helpers/inbound/app'
+use Rack::Reloader, 0
+run Main

data/docker/Dockerfile ADDED Viewed

@@ -0,0 +1,12 @@
+FROM ruby:2.4.2-jessie
+# Clone sendgrid-ruby
+WORKDIR /sources
+RUN git clone https://github.com/sendgrid/sendgrid-ruby.git
+# Bundle
+WORKDIR /sources/sendgrid-ruby
+RUN bundle install
+# Install prism
+RUN curl https://raw.githubusercontent.com/stoplightio/prism/master/install.sh | sh

data/docker/README.md ADDED Viewed

@@ -0,0 +1,30 @@
+# Docker image for sendgrid-ruby
+## Quickstart
+1. [Install Docker](https://docs.docker.com/engine/installation/) on your machine.
+2. Run `docker run --rm -it sendgrid/sendgrid-ruby irb`.
+3. Run `require './lib/sendgrid-ruby.rb'`.
+## Poke around
+If you would like to just poke around in the image and check some examples:
+```sh
+docker run --rm -it sendgrid/sendgrid-ruby bash
+```
+If you want to mount your fork or specific version of the gem:
+```sh
+docker run --rm -v /path/to/local/sendgrid-ruby:/sources/sendgrid-ruby -it sendgrid/sendgrid-ruby bash
+```
+## Running tests
+If you would like to run the tests present in the image:
+```sh
+docker run --rm sendgrid/sendgrid-ruby rake
+```
+If you want to run tests on your fork or a specific version, mount the codebase onto the image:
+```sh
+docker run --rm -v /path/to/local/sendgrid-ruby:/sources/sendgrid-ruby sendgrid/sendgrid-ruby rake
+```

data/examples/accesssettings/accesssettings.rb ADDED Viewed

@@ -0,0 +1,83 @@
+require 'sendgrid-ruby'
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+##################################################
+# Retrieve all recent access attempts #
+# GET /access_settings/activity #
+params = JSON.parse('{"limit": 1}')
+response = sg.client.access_settings.activity.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+##################################################
+# Add one or more IPs to the whitelist #
+# POST /access_settings/whitelist #
+data = JSON.parse('{
+  "ips": [
+    {
+      "ip": "192.168.1.1"
+    },
+    {
+      "ip": "192.*.*.*"
+    },
+    {
+      "ip": "192.168.1.3/32"
+    }
+  ]
+}')
+response = sg.client.access_settings.whitelist.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+##################################################
+# Retrieve a list of currently whitelisted IPs #
+# GET /access_settings/whitelist #
+response = sg.client.access_settings.whitelist.get()
+puts response.status_code
+puts response.body
+puts response.headers
+##################################################
+# Remove one or more IPs from the whitelist #
+# DELETE /access_settings/whitelist #
+data = JSON.parse('{
+  "ids": [
+    1,
+    2,
+    3
+  ]
+}')
+response = sg.client.access_settings.whitelist.delete(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+##################################################
+# Retrieve a specific whitelisted IP #
+# GET /access_settings/whitelist/{rule_id} #
+rule_id = "test_url_param"
+response = sg.client.access_settings.whitelist._(rule_id).get()
+puts response.status_code
+puts response.body
+puts response.headers
+##################################################
+# Remove a specific IP from the whitelist #
+# DELETE /access_settings/whitelist/{rule_id} #
+rule_id = "test_url_param"
+response = sg.client.access_settings.whitelist._(rule_id).delete()
+puts response.status_code
+puts response.body
+puts response.headers

data/examples/alerts/alerts.rb ADDED Viewed

@@ -0,0 +1,62 @@
+require 'sendgrid-ruby'
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+##################################################
+# Create a new Alert #
+# POST /alerts #
+data = JSON.parse('{
+  "email_to": "example@example.com",
+  "frequency": "daily",
+  "type": "stats_notification"
+}')
+response = sg.client.alerts.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+##################################################
+# Retrieve all alerts #
+# GET /alerts #
+response = sg.client.alerts.get()
+puts response.status_code
+puts response.body
+puts response.headers
+##################################################
+# Update an alert #
+# PATCH /alerts/{alert_id} #
+data = JSON.parse('{
+  "email_to": "example@example.com"
+}')
+alert_id = "test_url_param"
+response = sg.client.alerts._(alert_id).patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+##################################################
+# Retrieve a specific alert #
+# GET /alerts/{alert_id} #
+alert_id = "test_url_param"
+response = sg.client.alerts._(alert_id).get()
+puts response.status_code
+puts response.body
+puts response.headers
+##################################################
+# Delete an alert #
+# DELETE /alerts/{alert_id} #
+alert_id = "test_url_param"
+response = sg.client.alerts._(alert_id).delete()
+puts response.status_code
+puts response.body
+puts response.headers

data/examples/apikeys/apikeys.rb ADDED Viewed

@@ -0,0 +1,84 @@
+require 'sendgrid-ruby'
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+##################################################
+# Create API keys #
+# POST /api_keys #
+data = JSON.parse('{
+  "name": "My API Key",
+  "sample": "data",
+  "scopes": [
+    "mail.send",
+    "alerts.create",
+    "alerts.read"
+  ]
+}')
+response = sg.client.api_keys.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+##################################################
+# Retrieve all API Keys belonging to the authenticated user #
+# GET /api_keys #
+params = JSON.parse('{"limit": 1}')
+response = sg.client.api_keys.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+##################################################
+# Update the name & scopes of an API Key #
+# PUT /api_keys/{api_key_id} #
+data = JSON.parse('{
+  "name": "A New Hope",
+  "scopes": [
+    "user.profile.read",
+    "user.profile.update"
+  ]
+}')
+api_key_id = "test_url_param"
+response = sg.client.api_keys._(api_key_id).put(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+##################################################
+# Update API keys #
+# PATCH /api_keys/{api_key_id} #
+data = JSON.parse('{
+  "name": "A New Hope"
+}')
+api_key_id = "test_url_param"
+response = sg.client.api_keys._(api_key_id).patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+##################################################
+# Retrieve an existing API Key #
+# GET /api_keys/{api_key_id} #
+api_key_id = "test_url_param"
+response = sg.client.api_keys._(api_key_id).get()
+puts response.status_code
+puts response.body
+puts response.headers
+##################################################
+# Delete API keys #
+# DELETE /api_keys/{api_key_id} #
+api_key_id = "test_url_param"
+response = sg.client.api_keys._(api_key_id).delete()
+puts response.status_code
+puts response.body
+puts response.headers