sendgrid-ruby 4.0.8 → 6.0.0

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

data/examples/ips/ips.rb

@@ -23,6 +23,19 @@ 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/examples/mail/mail.rb

@@ -79,8 +79,8 @@ data = JSON.parse('{
     }, 
     "footer": {
       "enable": true, 
-      "html": "<p>Thanks</br>The SendGrid Team</p>", 
-      "text": "Thanks,/n The SendGrid Team"
+      "html": "<p>Thanks</br>The Twilio SendGrid Team</p>", 
+      "text": "Thanks,/n The Twilio SendGrid Team"
     }, 
     "sandbox_mode": {
       "enable": false

data/examples/scopes/scopes.rb

@@ -1,9 +1,7 @@
-require 'sendgrid-ruby'
-
+require_relative '../../lib/sendgrid-ruby.rb'
 
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Retrieve a list of scopes for which this user has access. #
 # GET /scopes #
@@ -13,3 +11,51 @@ 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

data/examples/{whitelabel/whitelabel.rb → senderauthentication/senderauthentication.rb}

@@ -5,7 +5,7 @@ sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
 
 ##################################################
-# Create a domain whitelabel. #
+# Create a domain authentication. #
 # POST /whitelabel/domains #
 
 data = JSON.parse('{
@@ -26,7 +26,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# List all domain whitelabels. #
+# List all domain authentications. #
 # GET /whitelabel/domains #
 
 params = JSON.parse('{"username": "test_string", "domain": "test_string", "exclude_subusers": "true", "limit": 1, "offset": 1}')
@@ -36,7 +36,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Get the default domain whitelabel. #
+# Get the default domain authentication. #
 # GET /whitelabel/domains/default #
 
 response = sg.client.whitelabel.domains.default.get()
@@ -45,7 +45,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# List the domain whitelabel associated with the given user. #
+# List the domain authentication associated with the given user. #
 # GET /whitelabel/domains/subuser #
 
 response = sg.client.whitelabel.domains.subuser.get()
@@ -54,7 +54,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Disassociate a domain whitelabel from a given user. #
+# Disassociate a domain authentication from a given user. #
 # DELETE /whitelabel/domains/subuser #
 
 response = sg.client.whitelabel.domains.subuser.delete()
@@ -63,7 +63,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Update a domain whitelabel. #
+# Update a domain authentication. #
 # PATCH /whitelabel/domains/{domain_id} #
 
 data = JSON.parse('{
@@ -77,7 +77,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve a domain whitelabel. #
+# Retrieve a domain authentication. #
 # GET /whitelabel/domains/{domain_id} #
 
 domain_id = "test_url_param"
@@ -87,7 +87,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Delete a domain whitelabel. #
+# Delete a domain authentication. #
 # DELETE /whitelabel/domains/{domain_id} #
 
 domain_id = "test_url_param"
@@ -97,7 +97,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Associate a domain whitelabel with a given user. #
+# Associate a domain authentication with a given user. #
 # POST /whitelabel/domains/{domain_id}/subuser #
 
 data = JSON.parse('{
@@ -110,7 +110,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Add an IP to a domain whitelabel. #
+# Add an IP to a domain authentication. #
 # POST /whitelabel/domains/{id}/ips #
 
 data = JSON.parse('{
@@ -123,7 +123,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Remove an IP from a domain whitelabel. #
+# Remove an IP from a domain authentication. #
 # DELETE /whitelabel/domains/{id}/ips/{ip} #
 
 id = "test_url_param"
@@ -134,7 +134,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Validate a domain whitelabel. #
+# Validate a domain authentication. #
 # POST /whitelabel/domains/{id}/validate #
 
 id = "test_url_param"
@@ -144,7 +144,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Create an IP whitelabel #
+# Create a reverse DNS record #
 # POST /whitelabel/ips #
 
 data = JSON.parse('{
@@ -158,7 +158,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve all IP whitelabels #
+# Retrieve a reverse DNS record #
 # GET /whitelabel/ips #
 
 params = JSON.parse('{"ip": "test_string", "limit": 1, "offset": 1}')
@@ -168,7 +168,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve an IP whitelabel #
+# Retrieve a reverse DNS record #
 # GET /whitelabel/ips/{id} #
 
 id = "test_url_param"
@@ -178,7 +178,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Delete an IP whitelabel #
+# Delete a reverse DNS record #
 # DELETE /whitelabel/ips/{id} #
 
 id = "test_url_param"
@@ -188,7 +188,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Validate an IP whitelabel #
+# Validate a reverse DNS record #
 # POST /whitelabel/ips/{id}/validate #
 
 id = "test_url_param"
@@ -198,7 +198,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Create a Link Whitelabel #
+# Create a Branded Link #
 # POST /whitelabel/links #
 
 data = JSON.parse('{
@@ -213,7 +213,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve all link whitelabels #
+# Retrieve all link brandings #
 # GET /whitelabel/links #
 
 params = JSON.parse('{"limit": 1}')
@@ -223,7 +223,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve a Default Link Whitelabel #
+# Retrieve a Default Link Branding #
 # GET /whitelabel/links/default #
 
 params = JSON.parse('{"domain": "test_string"}')
@@ -233,7 +233,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve Associated Link Whitelabel #
+# Retrieve Associated Link Branding #
 # GET /whitelabel/links/subuser #
 
 params = JSON.parse('{"username": "test_string"}')
@@ -243,7 +243,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Disassociate a Link Whitelabel #
+# Disassociate a Link Branding #
 # DELETE /whitelabel/links/subuser #
 
 params = JSON.parse('{"username": "test_string"}')
@@ -253,7 +253,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Update a Link Whitelabel #
+# Update a Link Branding #
 # PATCH /whitelabel/links/{id} #
 
 data = JSON.parse('{
@@ -266,7 +266,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve a Link Whitelabel #
+# Retrieve a Link Branding #
 # GET /whitelabel/links/{id} #
 
 id = "test_url_param"
@@ -276,7 +276,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Delete a Link Whitelabel #
+# Delete a Link Branding #
 # DELETE /whitelabel/links/{id} #
 
 id = "test_url_param"
@@ -286,7 +286,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Validate a Link Whitelabel #
+# Validate a Link Branding #
 # POST /whitelabel/links/{id}/validate #
 
 id = "test_url_param"
@@ -296,7 +296,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Associate a Link Whitelabel #
+# Associate a Link Branding #
 # POST /whitelabel/links/{link_id}/subuser #
 
 data = JSON.parse('{

data/examples/suppression/suppression.rb

@@ -19,9 +19,9 @@ puts response.headers
 # DELETE /suppression/blocks #
 
 data = JSON.parse('{
-  "delete_all": false, 
+  "delete_all": false,
   "emails": [
-    "example1@example.com", 
+    "example1@example.com",
     "example2@example.com"
   ]
 }')
@@ -65,9 +65,9 @@ puts response.headers
 # DELETE /suppression/bounces #
 
 data = JSON.parse('{
-  "delete_all": true, 
+  "delete_all": true,
   "emails": [
-    "example@example.com", 
+    "example@example.com",
     "example2@example.com"
   ]
 }')
@@ -112,9 +112,9 @@ puts response.headers
 # DELETE /suppression/invalid_emails #
 
 data = JSON.parse('{
-  "delete_all": false, 
+  "delete_all": false,
   "emails": [
-    "example1@example.com", 
+    "example1@example.com",
     "example2@example.com"
   ]
 }')
@@ -148,7 +148,7 @@ puts response.headers
 # GET /suppression/spam_report/{email} #
 
 email = "test_url_param"
-response = sg.client.suppression.spam_report._(email).get()
+response = sg.client.suppression.spam_reports._(email).get()
 puts response.status_code
 puts response.body
 puts response.headers
@@ -158,7 +158,7 @@ puts response.headers
 # DELETE /suppression/spam_report/{email} #
 
 email = "test_url_param"
-response = sg.client.suppression.spam_report._(email).delete()
+response = sg.client.suppression.spam_reports._(email).delete()
 puts response.status_code
 puts response.body
 puts response.headers
@@ -178,9 +178,9 @@ puts response.headers
 # DELETE /suppression/spam_reports #
 
 data = JSON.parse('{
-  "delete_all": false, 
+  "delete_all": false,
   "emails": [
-    "example1@example.com", 
+    "example1@example.com",
     "example2@example.com"
   ]
 }')