sendgrid-ruby 1.1.6 → 6.6.2

data/examples/helpers/stats/example.rb

@@ -0,0 +1,42 @@
+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, 1)
+to = Date.new(2017, 10, 12)
+
+email_stats = stats.by_day(from, to)
+
+email_stats.metrics
+
+unless 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, 1)
+to = Date.new(2017, 10, 12)
+category = 'abcd'
+
+email_stats = stats.by_week(from, to, category)
+
+unless 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

data/examples/ips/ips.rb

@@ -0,0 +1,164 @@
+require 'sendgrid-ruby'
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+##################################################
+# Retrieve all IP addresses #
+# GET /ips #
+
+params = JSON.parse('{"subuser": "test_string", "ip": "test_string", "limit": 1, "exclude_whitelabels": "true", "offset": 1}')
+response = sg.client.ips.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all assigned IPs #
+# GET /ips/assigned #
+
+response = sg.client.ips.assigned.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve unassigned IPs #
+# GET /ips #
+
+params = {}
+response = sg.client.ips.get(query_params: params)
+all_ips = JSON.parse(response.body)
+unassigned_ips = all_ips.select { |ip| ip.subusers.empty? }
+puts response.status_code
+puts response.body
+puts unassigned_ips
+puts response.headers
+
+##################################################
+# Create an IP pool. #
+# POST /ips/pools #
+
+data = JSON.parse('{
+  "name": "marketing"
+}')
+response = sg.client.ips.pools.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all IP pools. #
+# GET /ips/pools #
+
+response = sg.client.ips.pools.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update an IP pools name. #
+# PUT /ips/pools/{pool_name} #
+
+data = JSON.parse('{
+  "name": "new_pool_name"
+}')
+pool_name = 'test_url_param'
+response = sg.client.ips.pools._(pool_name).put(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all IPs in a specified pool. #
+# GET /ips/pools/{pool_name} #
+
+pool_name = 'test_url_param'
+response = sg.client.ips.pools._(pool_name).get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete an IP pool. #
+# DELETE /ips/pools/{pool_name} #
+
+pool_name = 'test_url_param'
+response = sg.client.ips.pools._(pool_name).delete
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Add an IP address to a pool #
+# POST /ips/pools/{pool_name}/ips #
+
+data = JSON.parse('{
+  "ip": "0.0.0.0"
+}')
+pool_name = 'test_url_param'
+response = sg.client.ips.pools._(pool_name).ips.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Remove an IP address from a pool. #
+# DELETE /ips/pools/{pool_name}/ips/{ip} #
+
+pool_name = 'test_url_param'
+ip = 'test_url_param'
+response = sg.client.ips.pools._(pool_name).ips._(ip).delete
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Add an IP to warmup #
+# POST /ips/warmup #
+
+data = JSON.parse('{
+  "ip": "0.0.0.0"
+}')
+response = sg.client.ips.warmup.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all IPs currently in warmup #
+# GET /ips/warmup #
+
+response = sg.client.ips.warmup.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve warmup status for a specific IP address #
+# GET /ips/warmup/{ip_address} #
+
+ip_address = 'test_url_param'
+response = sg.client.ips.warmup._(ip_address).get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Remove an IP from warmup #
+# DELETE /ips/warmup/{ip_address} #
+
+ip_address = 'test_url_param'
+response = sg.client.ips.warmup._(ip_address).delete
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all IP pools an IP address belongs to #
+# GET /ips/{ip_address} #
+
+ip_address = 'test_url_param'
+response = sg.client.ips._(ip_address).get
+puts response.status_code
+puts response.body
+puts response.headers

data/examples/mail/mail.rb

@@ -0,0 +1,170 @@
+require 'sendgrid-ruby'
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+##################################################
+# Create a batch ID #
+# POST /mail/batch #
+
+response = sg.client.mail.batch.post
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Validate batch ID #
+# GET /mail/batch/{batch_id} #
+
+batch_id = 'test_url_param'
+response = sg.client.mail.batch._(batch_id).get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# v3 Mail Send #
+# POST /mail/send #
+# This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-ruby/blob/HEAD/lib/sendgrid/helpers/mail/README.md).
+
+data = JSON.parse('{
+  "asm": {
+    "group_id": 1,
+    "groups_to_display": [
+      1,
+      2,
+      3
+    ]
+  },
+  "attachments": [
+    {
+      "content": "[BASE64 encoded content block here]",
+      "content_id": "ii_139db99fdb5c3704",
+      "disposition": "inline",
+      "filename": "file1.jpg",
+      "name": "file1",
+      "type": "jpg"
+    }
+  ],
+  "batch_id": "[YOUR BATCH ID GOES HERE]",
+  "categories": [
+    "category1",
+    "category2"
+  ],
+  "content": [
+    {
+      "type": "text/html",
+      "value": "<html><p>Hello, world!</p><img src=[CID GOES HERE]></img></html>"
+    }
+  ],
+  "custom_args": {
+    "New Argument 1": "New Value 1",
+    "activationAttempt": "1",
+    "customerAccountNumber": "[CUSTOMER ACCOUNT NUMBER GOES HERE]"
+  },
+  "from": {
+    "email": "sam.smith@example.com",
+    "name": "Sam Smith"
+  },
+  "headers": {},
+  "ip_pool_name": "[YOUR POOL NAME GOES HERE]",
+  "mail_settings": {
+    "bcc": {
+      "email": "ben.doe@example.com",
+      "enable": true
+    },
+    "bypass_list_management": {
+      "enable": true
+    },
+    "footer": {
+      "enable": true,
+      "html": "<p>Thanks</br>The Twilio SendGrid Team</p>",
+      "text": "Thanks,/n The Twilio SendGrid Team"
+    },
+    "sandbox_mode": {
+      "enable": false
+    },
+    "spam_check": {
+      "enable": true,
+      "post_to_url": "http://example.com/compliance",
+      "threshold": 3
+    }
+  },
+  "personalizations": [
+    {
+      "bcc": [
+        {
+          "email": "sam.doe@example.com",
+          "name": "Sam Doe"
+        }
+      ],
+      "cc": [
+        {
+          "email": "jane.doe@example.com",
+          "name": "Jane Doe"
+        }
+      ],
+      "custom_args": {
+        "New Argument 1": "New Value 1",
+        "activationAttempt": "1",
+        "customerAccountNumber": "[CUSTOMER ACCOUNT NUMBER GOES HERE]"
+      },
+      "headers": {
+        "X-Accept-Language": "en",
+        "X-Mailer": "MyApp"
+      },
+      "send_at": 1409348513,
+      "subject": "Hello, World!",
+      "substitutions": {
+        "id": "substitutions",
+        "type": "object"
+      },
+      "to": [
+        {
+          "email": "john.doe@example.com",
+          "name": "John Doe"
+        }
+      ]
+    }
+  ],
+  "reply_to": {
+    "email": "sam.smith@example.com",
+    "name": "Sam Smith"
+  },
+  "sections": {
+    "section": {
+      ":sectionName1": "section 1 text",
+      ":sectionName2": "section 2 text"
+    }
+  },
+  "send_at": 1409348513,
+  "subject": "Hello, World!",
+  "template_id": "[YOUR TEMPLATE ID GOES HERE]",
+  "tracking_settings": {
+    "click_tracking": {
+      "enable": true,
+      "enable_text": true
+    },
+    "ganalytics": {
+      "enable": true,
+      "utm_campaign": "[NAME OF YOUR REFERRER SOURCE]",
+      "utm_content": "[USE THIS SPACE TO DIFFERENTIATE YOUR EMAIL FROM ADS]",
+      "utm_medium": "[NAME OF YOUR MARKETING MEDIUM e.g. email]",
+      "utm_name": "[NAME OF YOUR CAMPAIGN]",
+      "utm_term": "[IDENTIFY PAID KEYWORDS HERE]"
+    },
+    "open_tracking": {
+      "enable": true,
+      "substitution_tag": "%opentrack"
+    },
+    "subscription_tracking": {
+      "enable": true,
+      "html": "If you would like to unsubscribe and stop receiving these emails <% clickhere %>.",
+      "substitution_tag": "<%click here%>",
+      "text": "If you would like to unsubscribe and stop receiveing these emails <% click here %>."
+    }
+  }
+}')
+response = sg.client.mail._('send').post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers

data/examples/mailboxproviders/mailboxproviders.rb

@@ -0,0 +1,13 @@
+require 'sendgrid-ruby'
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+##################################################
+# Retrieve email statistics by mailbox provider. #
+# GET /mailbox_providers/stats #
+
+params = JSON.parse('{"end_date": "2016-04-01", "mailbox_providers": "test_string", "aggregated_by": "day", "limit": 1, "offset": 1, "start_date": "2016-01-01"}')
+response = sg.client.mailbox_providers.stats.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers

data/examples/mailsettings/mailsettings.rb

@@ -0,0 +1,216 @@
+require 'sendgrid-ruby'
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+##################################################
+# Retrieve all mail settings #
+# GET /mail_settings #
+
+params = JSON.parse('{"limit": 1, "offset": 1}')
+response = sg.client.mail_settings.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update address whitelist mail settings #
+# PATCH /mail_settings/address_whitelist #
+
+data = JSON.parse('{
+  "enabled": true,
+  "list": [
+    "email1@example.com",
+    "example.com"
+  ]
+}')
+response = sg.client.mail_settings.address_whitelist.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve address whitelist mail settings #
+# GET /mail_settings/address_whitelist #
+
+response = sg.client.mail_settings.address_whitelist.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update BCC mail settings #
+# PATCH /mail_settings/bcc #
+
+data = JSON.parse('{
+  "email": "email@example.com",
+  "enabled": false
+}')
+response = sg.client.mail_settings.bcc.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all BCC mail settings #
+# GET /mail_settings/bcc #
+
+response = sg.client.mail_settings.bcc.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update bounce purge mail settings #
+# PATCH /mail_settings/bounce_purge #
+
+data = JSON.parse('{
+  "enabled": true,
+  "hard_bounces": 5,
+  "soft_bounces": 5
+}')
+response = sg.client.mail_settings.bounce_purge.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve bounce purge mail settings #
+# GET /mail_settings/bounce_purge #
+
+response = sg.client.mail_settings.bounce_purge.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update footer mail settings #
+# PATCH /mail_settings/footer #
+
+data = JSON.parse('{
+  "enabled": true,
+  "html_content": "...",
+  "plain_content": "..."
+}')
+response = sg.client.mail_settings.footer.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve footer mail settings #
+# GET /mail_settings/footer #
+
+response = sg.client.mail_settings.footer.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update forward bounce mail settings #
+# PATCH /mail_settings/forward_bounce #
+
+data = JSON.parse('{
+  "email": "example@example.com",
+  "enabled": true
+}')
+response = sg.client.mail_settings.forward_bounce.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve forward bounce mail settings #
+# GET /mail_settings/forward_bounce #
+
+response = sg.client.mail_settings.forward_bounce.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update forward spam mail settings #
+# PATCH /mail_settings/forward_spam #
+
+data = JSON.parse('{
+  "email": "",
+  "enabled": false
+}')
+response = sg.client.mail_settings.forward_spam.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve forward spam mail settings #
+# GET /mail_settings/forward_spam #
+
+response = sg.client.mail_settings.forward_spam.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update plain content mail settings #
+# PATCH /mail_settings/plain_content #
+
+data = JSON.parse('{
+  "enabled": false
+}')
+response = sg.client.mail_settings.plain_content.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve plain content mail settings #
+# GET /mail_settings/plain_content #
+
+response = sg.client.mail_settings.plain_content.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update spam check mail settings #
+# PATCH /mail_settings/spam_check #
+
+data = JSON.parse('{
+  "enabled": true,
+  "max_score": 5,
+  "url": "url"
+}')
+response = sg.client.mail_settings.spam_check.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve spam check mail settings #
+# GET /mail_settings/spam_check #
+
+response = sg.client.mail_settings.spam_check.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update template mail settings #
+# PATCH /mail_settings/template #
+
+data = JSON.parse('{
+  "enabled": true,
+  "html_content": "<% body %>"
+}')
+response = sg.client.mail_settings.template.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve legacy template mail settings #
+# GET /mail_settings/template #
+
+response = sg.client.mail_settings.template.get
+puts response.status_code
+puts response.body
+puts response.headers

data/examples/partnersettings/partnersettings.rb

@@ -0,0 +1,36 @@
+require 'sendgrid-ruby'
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+##################################################
+# Returns a list of all partner settings. #
+# GET /partner_settings #
+
+params = JSON.parse('{"limit": 1, "offset": 1}')
+response = sg.client.partner_settings.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Updates New Relic partner settings. #
+# PATCH /partner_settings/new_relic #
+
+data = JSON.parse('{
+  "enable_subuser_statistics": true,
+  "enabled": true,
+  "license_key": ""
+}')
+response = sg.client.partner_settings.new_relic.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Returns all New Relic partner settings. #
+# GET /partner_settings/new_relic #
+
+response = sg.client.partner_settings.new_relic.get
+puts response.status_code
+puts response.body
+puts response.headers

data/examples/scopes/scopes.rb

@@ -0,0 +1,59 @@
+require_relative '../../lib/sendgrid-ruby'
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+##################################################
+# Retrieve a list of scopes for which this user has access. #
+# GET /scopes #
+
+response = sg.client.scopes.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update the name & scopes of an API Key #
+# PUT /api_keys/{api_key_id} #
+
+scopes = [
+  "user.profile.read",
+  "user.profile.update"
+]
+
+data = {
+  "name": "A New Hope",
+  "scopes": scopes
+}
+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
+
+# The above method shows how to update the scopes
+# To get various scopes that each of the endpoint has, use the following
+
+# To get all admin permissions
+scopes = SendGrid::Scope.admin_permissions
+
+# To get all read only permissions
+scopes = SendGrid::Scope.read_only_permissions
+
+# There are two methods for each endpoints, namely
+# {endpoint}_read_only_permissions and {endpoint}_full_access_permissions
+
+# These are the endpoints :
+# alerts, api_keys, asm_groups, billing, categories, credentials, stats, ips, mail_settings, mail,
+# marketing_campaigns, partner_settings, scheduled_sends, subusers, suppression, teammates,
+# templates, tracking_settings, user_settings, webhooks, whitelabel, access_settings
+
+# read only permissions for alerts
+scopes = SendGrid::Scope.alerts_read_only_permissions
+
+# full access permissions for alerts
+scopes = SendGrid::Scope.alerts_full_access_permissions
+
+# read only permissions for billing
+scopes = SendGrid::Scope.billing_read_only_permissions
+
+# full access permissions for billing
+scopes = SendGrid::Scope.billing_full_access_permissions