sendgrid-ruby 1.1.6 → 3.0.0

data/examples/accesssettings/accesssettings.rb

@@ -0,0 +1,89 @@
+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 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 #
+
+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/apikeys/apikeys.rb

@@ -0,0 +1,95 @@
+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 API keys #
+# POST /api_keys #
+
+data = JSON.parse('{
+  "name": "My API Key", 
+  "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 #
+
+response = sg.client.api_keys.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} #
+
+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
+

data/examples/asm/asm.rb

@@ -0,0 +1,169 @@
+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 a new suppression group #
+# POST /asm/groups #
+
+data = JSON.parse('{
+  "description": "Suggestions for products our users might like.", 
+  "is_default": true, 
+  "name": "Product Suggestions"
+}')
+response = sg.client.asm.groups.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve information about multiple suppression groups #
+# GET /asm/groups #
+
+params = JSON.parse('{"id": 1}')
+response = sg.client.asm.groups.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update a suppression group. #
+# PATCH /asm/groups/{group_id} #
+
+data = JSON.parse('{
+  "description": "Suggestions for items our users might like.", 
+  "id": 103, 
+  "name": "Item Suggestions"
+}')
+group_id = "test_url_param"
+response = sg.client.asm.groups._(group_id).patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Get information on a single suppression group. #
+# GET /asm/groups/{group_id} #
+
+group_id = "test_url_param"
+response = sg.client.asm.groups._(group_id).get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a suppression group. #
+# DELETE /asm/groups/{group_id} #
+
+group_id = "test_url_param"
+response = sg.client.asm.groups._(group_id).delete()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Add suppressions to a suppression group #
+# POST /asm/groups/{group_id}/suppressions #
+
+data = JSON.parse('{
+  "recipient_emails": [
+    "test1@example.com", 
+    "test2@example.com"
+  ]
+}')
+group_id = "test_url_param"
+response = sg.client.asm.groups._(group_id).suppressions.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all suppressions for a suppression group #
+# GET /asm/groups/{group_id}/suppressions #
+
+group_id = "test_url_param"
+response = sg.client.asm.groups._(group_id).suppressions.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a suppression from a suppression group #
+# DELETE /asm/groups/{group_id}/suppressions/{email} #
+
+group_id = "test_url_param"
+email = "test_url_param"
+response = sg.client.asm.groups._(group_id).suppressions._(email).delete()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all suppressions #
+# GET /asm/suppressions #
+
+response = sg.client.asm.suppressions.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Add recipient addresses to the global suppression group. #
+# POST /asm/suppressions/global #
+
+data = JSON.parse('{
+  "recipient_emails": [
+    "test1@example.com", 
+    "test2@example.com"
+  ]
+}')
+response = sg.client.asm.suppressions.global.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve a Global Suppression #
+# GET /asm/suppressions/global/{email} #
+
+email = "test_url_param"
+response = sg.client.asm.suppressions.global._(email).get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a Global Suppression #
+# DELETE /asm/suppressions/global/{email} #
+
+email = "test_url_param"
+response = sg.client.asm.suppressions.global._(email).delete()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all suppression groups for an email address #
+# GET /asm/suppressions/{email} #
+
+email = "test_url_param"
+response = sg.client.asm.suppressions._(email).get()
+puts response.status_code
+puts response.body
+puts response.headers
+

data/examples/browsers/browsers.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 browser.  #
+# GET /browsers/stats #
+
+params = JSON.parse('{"end_date": "2016-04-01", "aggregated_by": "day", "browsers": "test_string", "limit": "test_string", "offset": "test_string", "start_date": "2016-01-01"}')
+response = sg.client.browsers.stats.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+

data/examples/campaigns/campaigns.rb

@@ -0,0 +1,166 @@
+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 a Campaign #
+# POST /campaigns #
+
+data = JSON.parse('{
+  "categories": [
+    "spring line"
+  ], 
+  "custom_unsubscribe_url": "", 
+  "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>", 
+  "ip_pool": "marketing", 
+  "list_ids": [
+    110, 
+    124
+  ], 
+  "plain_content": "Check out our spring line!", 
+  "segment_ids": [
+    110
+  ], 
+  "sender_id": 124451, 
+  "subject": "New Products for Spring!", 
+  "suppression_group_id": 42, 
+  "title": "March Newsletter"
+}')
+response = sg.client.campaigns.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all Campaigns #
+# GET /campaigns #
+
+params = JSON.parse('{"limit": 0, "offset": 0}')
+response = sg.client.campaigns.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update a Campaign #
+# PATCH /campaigns/{campaign_id} #
+
+data = JSON.parse('{
+  "categories": [
+    "summer line"
+  ], 
+  "html_content": "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>", 
+  "plain_content": "Check out our summer line!", 
+  "subject": "New Products for Summer!", 
+  "title": "May Newsletter"
+}')
+campaign_id = "test_url_param"
+response = sg.client.campaigns._(campaign_id).patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve a single campaign #
+# GET /campaigns/{campaign_id} #
+
+campaign_id = "test_url_param"
+response = sg.client.campaigns._(campaign_id).get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a Campaign #
+# DELETE /campaigns/{campaign_id} #
+
+campaign_id = "test_url_param"
+response = sg.client.campaigns._(campaign_id).delete()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update a Scheduled Campaign #
+# PATCH /campaigns/{campaign_id}/schedules #
+
+data = JSON.parse('{
+  "send_at": 1489451436
+}')
+campaign_id = "test_url_param"
+response = sg.client.campaigns._(campaign_id).schedules.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Schedule a Campaign #
+# POST /campaigns/{campaign_id}/schedules #
+
+data = JSON.parse('{
+  "send_at": 1489771528
+}')
+campaign_id = "test_url_param"
+response = sg.client.campaigns._(campaign_id).schedules.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# View Scheduled Time of a Campaign #
+# GET /campaigns/{campaign_id}/schedules #
+
+campaign_id = "test_url_param"
+response = sg.client.campaigns._(campaign_id).schedules.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Unschedule a Scheduled Campaign #
+# DELETE /campaigns/{campaign_id}/schedules #
+
+campaign_id = "test_url_param"
+response = sg.client.campaigns._(campaign_id).schedules.delete()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Send a Campaign #
+# POST /campaigns/{campaign_id}/schedules/now #
+
+campaign_id = "test_url_param"
+response = sg.client.campaigns._(campaign_id).schedules.now.post()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Send a Test Campaign #
+# POST /campaigns/{campaign_id}/schedules/test #
+
+data = JSON.parse('{
+  "to": "your.email@example.com"
+}')
+campaign_id = "test_url_param"
+response = sg.client.campaigns._(campaign_id).schedules.test.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+