sendgrid-ruby 1.1.6 → 3.0.0

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

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

data/examples/helpers/mail/example.rb

@@ -0,0 +1,130 @@
+require 'sendgrid-ruby'
+include SendGrid
+require 'json'
+
+def hello_world
+  from = Email.new(email: 'test@example.com')
+  subject = 'Hello World from the SendGrid Ruby Library'
+  to = Email.new(email: 'test@example.com')
+  content = Content.new(type: 'text/plain', value: 'some text here')
+  mail = Mail.new(from, subject, to, content)
+  # puts JSON.pretty_generate(mail.to_json)
+  puts mail.to_json
+
+  sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'], host: 'https://api.sendgrid.com')
+  response = sg.client.mail._('send').post(request_body: mail.to_json)
+  puts response.status_code
+  puts response.response_body
+  puts response.response_headers
+end
+
+def kitchen_sink
+  mail = Mail.new
+  mail.from = Email.new(email: 'test@example.com')
+  mail.subject = 'Hello World from the SendGrid Ruby Library'
+  personalization = Personalization.new
+  personalization.to = Email.new(email: 'test1@example.com', name: 'Example User')
+  personalization.to = Email.new(email: 'test2@example.com', name: 'Example User')
+  personalization.cc = Email.new(email: 'test3@example.com', name: 'Example User')
+  personalization.cc = Email.new(email: 'test4@example.com', name: 'Example User')
+  personalization.bcc = Email.new(email: 'test5@example.com', name: 'Example User')
+  personalization.bcc = Email.new(email: 'test6@example.com', name: 'Example User')
+  personalization.subject = 'Hello World from the Personalized SendGrid Python Library'
+  personalization.headers = Header.new(key: 'X-Test', value: 'True')
+  personalization.headers = Header.new(key: 'X-Mock', value: 'False')
+  personalization.substitutions = Substitution.new(key: '%name%', value: 'Example User')
+  personalization.substitutions = Substitution.new(key: '%city%', value: 'Denver')
+  personalization.custom_args = CustomArg.new(key: 'user_id', value: '343')
+  personalization.custom_args = CustomArg.new(key: 'type', value: 'marketing')
+  personalization.send_at = 1443636843
+  mail.personalizations = personalization
+
+  personalization2 = Personalization.new
+  personalization2.to = Email.new(email: 'test1@example.com', name: 'Example User')
+  personalization2.to = Email.new(email: 'test2@example.com', name: 'Example User')
+  personalization2.cc = Email.new(email: 'test3@example.com', name: 'Example User')
+  personalization2.cc = Email.new(email: 'test4@example.com', name: 'Example User')
+  personalization2.bcc = Email.new(email: 'test5@example.com', name: 'Example User')
+  personalization2.bcc = Email.new(email: 'test6@example.com', name: 'Example User')
+  personalization2.subject = 'Hello World from the Personalized SendGrid Python Library'
+  personalization2.headers = Header.new(key: 'X-Test', value: 'True')
+  personalization2.headers = Header.new(key: 'X-Mock', value: 'False')
+  personalization2.substitutions = Substitution.new(key: '%name%', value: 'Example User')
+  personalization2.substitutions = Substitution.new(key: '%city%', value: 'Denver')
+  personalization2.custom_args = CustomArg.new(key: 'user_id', value: '343')
+  personalization2.custom_args = CustomArg.new(key: 'type', value: 'marketing')
+  personalization2.send_at = 1443636843
+  mail.personalizations = personalization2
+
+  mail.contents = Content.new(type: 'text/plain', value: 'some text here')
+  mail.contents = Content.new(type: 'text/html', value: '<html><body>some text here</body></html>')
+
+  attachment = Attachment.new
+  attachment.content = 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gQ3JhcyBwdW12'
+  attachment.type = 'application/pdf'
+  attachment.filename = 'balance_001.pdf'
+  attachment.disposition = 'attachment'
+  attachment.content_id = 'Balance Sheet'
+
+  mail.attachments = attachment
+
+  attachment2 = Attachment.new
+  attachment2.content = 'BwdW'
+  attachment2.type = 'image/png'
+  attachment2.filename = 'banner.png'
+  attachment2.disposition = 'inline'
+  attachment2.content_id = 'Banner'
+  mail.attachments = attachment2
+
+  mail.template_id = '13b8f94f-bcae-4ec6-b752-70d6cb59f932'
+
+  mail.sections = Section.new(key: '%section1%', value: 'Substitution Text for Section 1')
+  mail.sections = Section.new(key: '%section2%', value: 'Substitution Text for Section 2')
+
+  mail.headers = Header.new(key: 'X-Test3', value: 'test3')
+  mail.headers = Header.new(key: 'X-Test4', value: 'test4')
+
+  mail.categories = Category.new(name: 'May')
+  mail.categories = Category.new(name: '2016')
+
+  mail.custom_args = CustomArg.new(key: 'campaign', value: 'welcome')
+  mail.custom_args = CustomArg.new(key: 'weekday', value: 'morning')
+
+  mail.send_at = 1443636842
+
+  # This must be a valid [batch ID](https://sendgrid.com/docs/API_Reference/SMTP_API/scheduling_parameters.html) to work
+  # mail.batch_id = 'sendgrid_batch_id'
+
+  mail.asm = ASM.new(group_id: 99, groups_to_display: [4,5,6,7,8])
+
+  mail.ip_pool_name = '23'
+
+  mail_settings = MailSettings.new
+  mail_settings.bcc = BccSettings.new(enable: true, email: 'test@example.com')
+  mail_settings.bypass_list_management = BypassListManagement.new(enable: true)
+  mail_settings.footer = Footer.new(enable: true, text: 'Footer Text', html: '<html><body>Footer Text</body></html>')
+  mail_settings.sandbox_mode = SandBoxMode.new(enable: true)
+  mail_settings.spam_check = SpamCheck.new(enable: true, threshold: 1, post_to_url: 'https://spamcatcher.sendgrid.com')
+  mail.mail_settings = mail_settings
+
+  tracking_settings = TrackingSettings.new
+  tracking_settings.click_tracking = ClickTracking.new(enable: false, enable_text: false)
+  tracking_settings.open_tracking = OpenTracking.new(enable: true, substitution_tag: 'Optional tag to replace with the open image in the body of the message')
+  tracking_settings.subscription_tracking = SubscriptionTracking.new(enable: true, text: 'text to insert into the text/plain portion of the message', html: 'html to insert into the text/html portion of the message', substitution_tag: 'Optional tag to replace with the open image in the body of the message')
+  tracking_settings.ganalytics = Ganalytics.new(enable: true, utm_source: 'some source', utm_medium: 'some medium', utm_term: 'some term', utm_content: 'some content', utm_campaign: 'some campaign')
+  mail.tracking_settings = tracking_settings
+
+  mail.reply_to = Email.new(email: 'test@example.com')
+
+  # puts JSON.pretty_generate(mail.to_json)
+  puts mail.to_json
+
+  sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'], host: 'https://api.sendgrid.com')
+  response = sg.client.mail._('send').post(request_body: mail.to_json)
+  puts response.status_code
+  puts response.response_body
+  puts response.response_headers
+end
+
+hello_world
+kitchen_sink

data/examples/ips/ips.rb

@@ -0,0 +1,167 @@
+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 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
+
+##################################################
+# 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,191 @@
+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 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/master/lib/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 SendGrid Team</p>",
+      "text": "Thanks,/n The 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": {
+        "sub": {
+          "%name%": [
+            "John",
+            "Jane",
+            "Sam"
+          ]
+        }
+      },
+      "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
+