sendgrid-ruby 1.1.6 → 3.0.0

data/examples/mailboxproviders/mailboxproviders.rb

@@ -0,0 +1,29 @@
+require 'sendgrid-ruby'
+
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import com.sendgrid.Client;
+import com.sendgrid.Method;
+import com.sendgrid.Request;
+import com.sendgrid.Response;
+import com.sendgrid.SendGrid;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+##################################################
+# 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,232 @@
+require 'sendgrid-ruby'
+
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import com.sendgrid.Client;
+import com.sendgrid.Method;
+import com.sendgrid.Request;
+import com.sendgrid.Response;
+import com.sendgrid.SendGrid;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+##################################################
+# 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,52 @@
+require 'sendgrid-ruby'
+
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import com.sendgrid.Client;
+import com.sendgrid.Method;
+import com.sendgrid.Request;
+import com.sendgrid.Response;
+import com.sendgrid.SendGrid;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+##################################################
+# 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,28 @@
+require 'sendgrid-ruby'
+
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import com.sendgrid.Client;
+import com.sendgrid.Method;
+import com.sendgrid.Request;
+import com.sendgrid.Response;
+import com.sendgrid.SendGrid;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+##################################################
+# 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
+

data/examples/stats/stats.rb

@@ -0,0 +1,29 @@
+require 'sendgrid-ruby'
+
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import com.sendgrid.Client;
+import com.sendgrid.Method;
+import com.sendgrid.Request;
+import com.sendgrid.Response;
+import com.sendgrid.SendGrid;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+##################################################
+# Retrieve global email statistics #
+# GET /stats #
+
+params = JSON.parse('{"aggregated_by": "day", "limit": 1, "start_date": "2016-01-01", "end_date": "2016-04-01", "offset": 1}')
+response = sg.client.stats.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+

data/examples/subusers/subusers.rb

@@ -0,0 +1,182 @@
+require 'sendgrid-ruby'
+
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import com.sendgrid.Client;
+import com.sendgrid.Method;
+import com.sendgrid.Request;
+import com.sendgrid.Response;
+import com.sendgrid.SendGrid;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+##################################################
+# Create Subuser #
+# POST /subusers #
+
+data = JSON.parse('{
+  "email": "John@example.com", 
+  "ips": [
+    "1.1.1.1", 
+    "2.2.2.2"
+  ], 
+  "password": "johns_password", 
+  "username": "John@example.com"
+}')
+response = sg.client.subusers.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# List all Subusers #
+# GET /subusers #
+
+params = JSON.parse('{"username": "test_string", "limit": 0, "offset": 0}')
+response = sg.client.subusers.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve Subuser Reputations #
+# GET /subusers/reputations #
+
+params = JSON.parse('{"usernames": "test_string"}')
+response = sg.client.subusers.reputations.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve email statistics for your subusers. #
+# GET /subusers/stats #
+
+params = JSON.parse('{"end_date": "2016-04-01", "aggregated_by": "day", "limit": 1, "offset": 1, "start_date": "2016-01-01", "subusers": "test_string"}')
+response = sg.client.subusers.stats.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve monthly stats for all subusers #
+# GET /subusers/stats/monthly #
+
+params = JSON.parse('{"subuser": "test_string", "limit": 1, "sort_by_metric": "test_string", "offset": 1, "date": "test_string", "sort_by_direction": "asc"}')
+response = sg.client.subusers.stats.monthly.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+#  Retrieve the totals for each email statistic metric for all subusers. #
+# GET /subusers/stats/sums #
+
+params = JSON.parse('{"end_date": "2016-04-01", "aggregated_by": "day", "limit": 1, "sort_by_metric": "test_string", "offset": 1, "start_date": "2016-01-01", "sort_by_direction": "asc"}')
+response = sg.client.subusers.stats.sums.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Enable/disable a subuser #
+# PATCH /subusers/{subuser_name} #
+
+data = JSON.parse('{
+  "disabled": false
+}')
+subuser_name = "test_url_param"
+response = sg.client.subusers._(subuser_name).patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a subuser #
+# DELETE /subusers/{subuser_name} #
+
+subuser_name = "test_url_param"
+response = sg.client.subusers._(subuser_name).delete()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update IPs assigned to a subuser #
+# PUT /subusers/{subuser_name}/ips #
+
+data = JSON.parse('[
+  "127.0.0.1"
+]')
+subuser_name = "test_url_param"
+response = sg.client.subusers._(subuser_name).ips.put(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update Monitor Settings for a subuser #
+# PUT /subusers/{subuser_name}/monitor #
+
+data = JSON.parse('{
+  "email": "example@example.com", 
+  "frequency": 500
+}')
+subuser_name = "test_url_param"
+response = sg.client.subusers._(subuser_name).monitor.put(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Create monitor settings #
+# POST /subusers/{subuser_name}/monitor #
+
+data = JSON.parse('{
+  "email": "example@example.com", 
+  "frequency": 50000
+}')
+subuser_name = "test_url_param"
+response = sg.client.subusers._(subuser_name).monitor.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve monitor settings for a subuser #
+# GET /subusers/{subuser_name}/monitor #
+
+subuser_name = "test_url_param"
+response = sg.client.subusers._(subuser_name).monitor.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete monitor settings #
+# DELETE /subusers/{subuser_name}/monitor #
+
+subuser_name = "test_url_param"
+response = sg.client.subusers._(subuser_name).monitor.delete()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve the monthly email statistics for a single subuser #
+# GET /subusers/{subuser_name}/stats/monthly #
+
+params = JSON.parse('{"date": "test_string", "sort_by_direction": "asc", "limit": 0, "sort_by_metric": "test_string", "offset": 1}')
+subuser_name = "test_url_param"
+response = sg.client.subusers._(subuser_name).stats.monthly.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+