sendgrid-ruby 1.1.6 → 6.0.4

data/examples/contactdb/contactdb.rb

@@ -0,0 +1,395 @@
+require 'sendgrid-ruby'
+
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+
+##################################################
+# Create a Custom Field #
+# POST /contactdb/custom_fields #
+
+data = JSON.parse('{
+  "name": "pet", 
+  "type": "text"
+}')
+response = sg.client.contactdb.custom_fields.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all custom fields #
+# GET /contactdb/custom_fields #
+
+response = sg.client.contactdb.custom_fields.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve a Custom Field #
+# GET /contactdb/custom_fields/{custom_field_id} #
+
+custom_field_id = "test_url_param"
+response = sg.client.contactdb.custom_fields._(custom_field_id).get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a Custom Field #
+# DELETE /contactdb/custom_fields/{custom_field_id} #
+
+custom_field_id = "test_url_param"
+response = sg.client.contactdb.custom_fields._(custom_field_id).delete()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Create a List #
+# POST /contactdb/lists #
+
+data = JSON.parse('{
+  "name": "your list name"
+}')
+response = sg.client.contactdb.lists.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all lists #
+# GET /contactdb/lists #
+
+response = sg.client.contactdb.lists.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete Multiple lists #
+# DELETE /contactdb/lists #
+
+data = JSON.parse('[
+  1, 
+  2, 
+  3, 
+  4
+]')
+response = sg.client.contactdb.lists.delete(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update a List #
+# PATCH /contactdb/lists/{list_id} #
+
+data = JSON.parse('{
+  "name": "newlistname"
+}')
+params = JSON.parse('{"list_id": 1}')
+list_id = "test_url_param"
+response = sg.client.contactdb.lists._(list_id).patch(request_body: data, query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve a single list #
+# GET /contactdb/lists/{list_id} #
+
+params = JSON.parse('{"list_id": 1}')
+list_id = "test_url_param"
+response = sg.client.contactdb.lists._(list_id).get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a List #
+# DELETE /contactdb/lists/{list_id} #
+
+params = JSON.parse('{"delete_contacts": "true"}')
+list_id = "test_url_param"
+response = sg.client.contactdb.lists._(list_id).delete(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Add Multiple Recipients to a List #
+# POST /contactdb/lists/{list_id}/recipients #
+
+data = JSON.parse('[
+  "recipient_id1", 
+  "recipient_id2"
+]')
+list_id = "test_url_param"
+response = sg.client.contactdb.lists._(list_id).recipients.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all recipients on a List #
+# GET /contactdb/lists/{list_id}/recipients #
+
+params = JSON.parse('{"page": 1, "page_size": 1, "list_id": 1}')
+list_id = "test_url_param"
+response = sg.client.contactdb.lists._(list_id).recipients.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Add a Single Recipient to a List #
+# POST /contactdb/lists/{list_id}/recipients/{recipient_id} #
+
+list_id = "test_url_param"
+recipient_id = "test_url_param"
+response = sg.client.contactdb.lists._(list_id).recipients._(recipient_id).post()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a Single Recipient from a Single List #
+# DELETE /contactdb/lists/{list_id}/recipients/{recipient_id} #
+
+params = JSON.parse('{"recipient_id": 1, "list_id": 1}')
+list_id = "test_url_param"
+recipient_id = "test_url_param"
+response = sg.client.contactdb.lists._(list_id).recipients._(recipient_id).delete(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update Recipient #
+# PATCH /contactdb/recipients #
+
+data = JSON.parse('[
+  {
+    "email": "jones@example.com", 
+    "first_name": "Guy", 
+    "last_name": "Jones"
+  }
+]')
+response = sg.client.contactdb.recipients.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Add recipients #
+# POST /contactdb/recipients #
+
+data = JSON.parse('[
+  {
+    "age": 25, 
+    "email": "example@example.com", 
+    "first_name": "", 
+    "last_name": "User"
+  }, 
+  {
+    "age": 25, 
+    "email": "example2@example.com", 
+    "first_name": "Example", 
+    "last_name": "User"
+  }
+]')
+response = sg.client.contactdb.recipients.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve recipients #
+# GET /contactdb/recipients #
+
+params = JSON.parse('{"page": 1, "page_size": 1}')
+response = sg.client.contactdb.recipients.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete Recipient #
+# DELETE /contactdb/recipients #
+
+data = JSON.parse('[
+  "recipient_id1", 
+  "recipient_id2"
+]')
+response = sg.client.contactdb.recipients.delete(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve the count of billable recipients #
+# GET /contactdb/recipients/billable_count #
+
+response = sg.client.contactdb.recipients.billable_count.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve a Count of Recipients #
+# GET /contactdb/recipients/count #
+
+response = sg.client.contactdb.recipients.count.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve recipients matching search criteria #
+# GET /contactdb/recipients/search #
+
+params = JSON.parse('{"{field_name}": "test_string"}')
+response = sg.client.contactdb.recipients.search.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve a single recipient #
+# GET /contactdb/recipients/{recipient_id} #
+
+recipient_id = "test_url_param"
+response = sg.client.contactdb.recipients._(recipient_id).get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a Recipient #
+# DELETE /contactdb/recipients/{recipient_id} #
+
+recipient_id = "test_url_param"
+response = sg.client.contactdb.recipients._(recipient_id).delete()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve the lists that a recipient is on #
+# GET /contactdb/recipients/{recipient_id}/lists #
+
+recipient_id = "test_url_param"
+response = sg.client.contactdb.recipients._(recipient_id).lists.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve reserved fields #
+# GET /contactdb/reserved_fields #
+
+response = sg.client.contactdb.reserved_fields.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Create a Segment #
+# POST /contactdb/segments #
+
+data = JSON.parse('{
+  "conditions": [
+    {
+      "and_or": "", 
+      "field": "last_name", 
+      "operator": "eq", 
+      "value": "Miller"
+    }, 
+    {
+      "and_or": "and", 
+      "field": "last_clicked", 
+      "operator": "gt", 
+      "value": "01/02/2015"
+    }, 
+    {
+      "and_or": "or", 
+      "field": "clicks.campaign_identifier", 
+      "operator": "eq", 
+      "value": "513"
+    }
+  ], 
+  "list_id": 4, 
+  "name": "Last Name Miller"
+}')
+response = sg.client.contactdb.segments.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all segments #
+# GET /contactdb/segments #
+
+response = sg.client.contactdb.segments.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update a segment #
+# PATCH /contactdb/segments/{segment_id} #
+
+data = JSON.parse('{
+  "conditions": [
+    {
+      "and_or": "", 
+      "field": "last_name", 
+      "operator": "eq", 
+      "value": "Miller"
+    }
+  ], 
+  "list_id": 5, 
+  "name": "The Millers"
+}')
+params = JSON.parse('{"segment_id": "test_string"}')
+segment_id = "test_url_param"
+response = sg.client.contactdb.segments._(segment_id).patch(request_body: data, query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve a segment #
+# GET /contactdb/segments/{segment_id} #
+
+params = JSON.parse('{"segment_id": 1}')
+segment_id = "test_url_param"
+response = sg.client.contactdb.segments._(segment_id).get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a segment #
+# DELETE /contactdb/segments/{segment_id} #
+
+params = JSON.parse('{"delete_contacts": "true"}')
+segment_id = "test_url_param"
+response = sg.client.contactdb.segments._(segment_id).delete(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve recipients on a segment #
+# GET /contactdb/segments/{segment_id}/recipients #
+
+params = JSON.parse('{"page": 1, "page_size": 1}')
+segment_id = "test_url_param"
+response = sg.client.contactdb.segments._(segment_id).recipients.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+

data/examples/devices/devices.rb

@@ -0,0 +1,16 @@
+require 'sendgrid-ruby'
+
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+
+##################################################
+# 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,16 @@
+require 'sendgrid-ruby'
+
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+
+##################################################
+# 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,147 @@
+require 'sendgrid-ruby'
+include SendGrid
+require 'json'
+
+def hello_world
+  from = Email.new(email: 'test@example.com')
+  subject = 'Hello World from the Twilio SendGrid Ruby Library'
+  to = Email.new(email: 'test@example.com')
+  content = Content.new(type: 'text/plain', value: 'some text here')
+  mail = SendGrid::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.body
+  puts response.headers
+end
+
+def kitchen_sink
+  mail = SendGrid::Mail.new
+  mail.from = Email.new(email: 'test@example.com')
+  mail.subject = 'Hello World from the Twilio SendGrid Ruby Library'
+  personalization = Personalization.new
+  personalization.add_to(Email.new(email: 'test1@example.com', name: 'Example User'))
+  personalization.add_to(Email.new(email: 'test2@example.com', name: 'Example User'))
+  personalization.add_cc(Email.new(email: 'test3@example.com', name: 'Example User'))
+  personalization.add_cc(Email.new(email: 'test4@example.com', name: 'Example User'))
+  personalization.add_bcc(Email.new(email: 'test5@example.com', name: 'Example User'))
+  personalization.add_bcc(Email.new(email: 'test6@example.com', name: 'Example User'))
+  personalization.subject = 'Hello World from the Personalized Twilio SendGrid Ruby Library'
+  personalization.add_header(Header.new(key: 'X-Test', value: 'True'))
+  personalization.add_header(Header.new(key: 'X-Mock', value: 'False'))
+  personalization.add_substitution(Substitution.new(key: '%name%', value: 'Example User'))
+  personalization.add_substitution(Substitution.new(key: '%city%', value: 'Denver'))
+  personalization.add_custom_arg(CustomArg.new(key: 'user_id', value: '343'))
+  personalization.add_custom_arg(CustomArg.new(key: 'type', value: 'marketing'))
+  personalization.send_at = 1443636843
+  mail.add_personalization(personalization)
+
+  personalization2 = Personalization.new
+  personalization2.add_to(Email.new(email: 'test1@example.com', name: 'Example User'))
+  personalization2.add_to(Email.new(email: 'test2@example.com', name: 'Example User'))
+  personalization2.add_cc(Email.new(email: 'test3@example.com', name: 'Example User'))
+  personalization2.add_cc(Email.new(email: 'test4@example.com', name: 'Example User'))
+  personalization2.add_bcc(Email.new(email: 'test5@example.com', name: 'Example User'))
+  personalization2.add_bcc(Email.new(email: 'test6@example.com', name: 'Example User'))
+  personalization2.subject = 'Hello World from the Personalized Twilio SendGrid Ruby Library'
+  personalization2.add_header(Header.new(key: 'X-Test', value: 'True'))
+  personalization2.add_header(Header.new(key: 'X-Mock', value: 'False'))
+  personalization2.add_substitution(Substitution.new(key: '%name%', value: 'Example User'))
+  personalization2.add_substitution(Substitution.new(key: '%city%', value: 'Denver'))
+  personalization2.add_custom_arg(CustomArg.new(key: 'user_id', value: '343'))
+  personalization2.add_custom_arg(CustomArg.new(key: 'type', value: 'marketing'))
+  personalization2.send_at = 1443636843
+  mail.add_personalization(personalization2)
+
+  mail.add_content(Content.new(type: 'text/plain', value: 'some text here'))
+  mail.add_content(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.add_attachment(attachment)
+
+  attachment2 = Attachment.new
+  attachment2.content = 'BwdW'
+  attachment2.type = 'image/png'
+  attachment2.filename = 'banner.png'
+  attachment2.disposition = 'inline'
+  attachment2.content_id = 'Banner'
+  mail.add_attachment(attachment2)
+
+  mail.template_id = '13b8f94f-bcae-4ec6-b752-70d6cb59f932'
+
+  mail.add_section(Section.new(key: '%section1%', value: 'Substitution Text for Section 1'))
+  mail.add_section(Section.new(key: '%section2%', value: 'Substitution Text for Section 2'))
+
+  mail.add_header(Header.new(key: 'X-Test3', value: 'test3'))
+  mail.add_header(Header.new(key: 'X-Test4', value: 'test4'))
+
+  mail.add_category(Category.new(name: 'May'))
+  mail.add_category(Category.new(name: '2016'))
+
+  mail.add_custom_arg(CustomArg.new(key: 'campaign', value: 'welcome'))
+  mail.add_custom_arg(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.body
+  puts response.headers
+end
+
+def dynamic_template_data_hello_world
+  mail = Mail.new
+  mail.template_id = '' # a non-legacy template id
+  mail.from = Email.new(email: 'test@example.com')
+  subject = 'Dynamic Template Data Hello World from the Twilio SendGrid Ruby Library'
+  mail.subject = subject
+  personalization = Personalization.new
+  personalization.add_to(Email.new(email: 'test1@example.com', name: 'Example User'))
+  personalization.add_dynamic_template_data({
+    "variable" => [
+      {"foo" => "bar"}, {"foo" => "baz"}
+    ]
+  })
+  mail.add_personalization(personalization)
+end
+
+hello_world
+kitchen_sink
+dynamic_template_data_hello_world
+

data/examples/helpers/settings/example.rb

@@ -0,0 +1,23 @@
+require 'sendgrid-ruby'
+include SendGrid
+
+sg_client = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']).client
+settings = SendGrid::Settings.new(sendgrid_client: sg_client)
+
+# Fetch settings
+response = settings.bcc
+puts response.status_code
+puts response.body
+puts response.headers
+
+# Turn on bcc settings
+response = settings.update_bcc(enabled: true, email: "email@example.com")
+puts response.status_code
+puts response.body
+puts response.headers
+
+# Turn off bcc settings
+response = settings.update_bcc(enabled: false)
+puts response.status_code
+puts response.body
+puts response.headers

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, 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