sendgrid-ruby 6.3.1 → 6.3.6

data/examples/mailboxproviders/mailboxproviders.rb

@@ -1,9 +1,7 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Retrieve email statistics by mailbox provider. #
 # GET /mailbox_providers/stats #
@@ -13,4 +11,3 @@ 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

@@ -1,9 +1,7 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Retrieve all mail settings #
 # GET /mail_settings #
@@ -19,9 +17,9 @@ puts response.headers
 # PATCH /mail_settings/address_whitelist #
 
 data = JSON.parse('{
-  "enabled": true, 
+  "enabled": true,
   "list": [
-    "email1@example.com", 
+    "email1@example.com",
     "example.com"
   ]
 }')
@@ -34,7 +32,7 @@ puts response.headers
 # Retrieve address whitelist mail settings #
 # GET /mail_settings/address_whitelist #
 
-response = sg.client.mail_settings.address_whitelist.get()
+response = sg.client.mail_settings.address_whitelist.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -44,7 +42,7 @@ puts response.headers
 # PATCH /mail_settings/bcc #
 
 data = JSON.parse('{
-  "email": "email@example.com", 
+  "email": "email@example.com",
   "enabled": false
 }')
 response = sg.client.mail_settings.bcc.patch(request_body: data)
@@ -56,7 +54,7 @@ puts response.headers
 # Retrieve all BCC mail settings #
 # GET /mail_settings/bcc #
 
-response = sg.client.mail_settings.bcc.get()
+response = sg.client.mail_settings.bcc.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -66,8 +64,8 @@ puts response.headers
 # PATCH /mail_settings/bounce_purge #
 
 data = JSON.parse('{
-  "enabled": true, 
-  "hard_bounces": 5, 
+  "enabled": true,
+  "hard_bounces": 5,
   "soft_bounces": 5
 }')
 response = sg.client.mail_settings.bounce_purge.patch(request_body: data)
@@ -79,7 +77,7 @@ puts response.headers
 # Retrieve bounce purge mail settings #
 # GET /mail_settings/bounce_purge #
 
-response = sg.client.mail_settings.bounce_purge.get()
+response = sg.client.mail_settings.bounce_purge.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -89,8 +87,8 @@ puts response.headers
 # PATCH /mail_settings/footer #
 
 data = JSON.parse('{
-  "enabled": true, 
-  "html_content": "...", 
+  "enabled": true,
+  "html_content": "...",
   "plain_content": "..."
 }')
 response = sg.client.mail_settings.footer.patch(request_body: data)
@@ -102,7 +100,7 @@ puts response.headers
 # Retrieve footer mail settings #
 # GET /mail_settings/footer #
 
-response = sg.client.mail_settings.footer.get()
+response = sg.client.mail_settings.footer.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -112,7 +110,7 @@ puts response.headers
 # PATCH /mail_settings/forward_bounce #
 
 data = JSON.parse('{
-  "email": "example@example.com", 
+  "email": "example@example.com",
   "enabled": true
 }')
 response = sg.client.mail_settings.forward_bounce.patch(request_body: data)
@@ -124,7 +122,7 @@ puts response.headers
 # Retrieve forward bounce mail settings #
 # GET /mail_settings/forward_bounce #
 
-response = sg.client.mail_settings.forward_bounce.get()
+response = sg.client.mail_settings.forward_bounce.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -134,7 +132,7 @@ puts response.headers
 # PATCH /mail_settings/forward_spam #
 
 data = JSON.parse('{
-  "email": "", 
+  "email": "",
   "enabled": false
 }')
 response = sg.client.mail_settings.forward_spam.patch(request_body: data)
@@ -146,7 +144,7 @@ puts response.headers
 # Retrieve forward spam mail settings #
 # GET /mail_settings/forward_spam #
 
-response = sg.client.mail_settings.forward_spam.get()
+response = sg.client.mail_settings.forward_spam.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -167,7 +165,7 @@ puts response.headers
 # Retrieve plain content mail settings #
 # GET /mail_settings/plain_content #
 
-response = sg.client.mail_settings.plain_content.get()
+response = sg.client.mail_settings.plain_content.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -177,8 +175,8 @@ puts response.headers
 # PATCH /mail_settings/spam_check #
 
 data = JSON.parse('{
-  "enabled": true, 
-  "max_score": 5, 
+  "enabled": true,
+  "max_score": 5,
   "url": "url"
 }')
 response = sg.client.mail_settings.spam_check.patch(request_body: data)
@@ -190,7 +188,7 @@ puts response.headers
 # Retrieve spam check mail settings #
 # GET /mail_settings/spam_check #
 
-response = sg.client.mail_settings.spam_check.get()
+response = sg.client.mail_settings.spam_check.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -200,7 +198,7 @@ puts response.headers
 # PATCH /mail_settings/template #
 
 data = JSON.parse('{
-  "enabled": true, 
+  "enabled": true,
   "html_content": "<% body %>"
 }')
 response = sg.client.mail_settings.template.patch(request_body: data)
@@ -212,8 +210,7 @@ puts response.headers
 # Retrieve legacy template mail settings #
 # GET /mail_settings/template #
 
-response = sg.client.mail_settings.template.get()
+response = sg.client.mail_settings.template.get
 puts response.status_code
 puts response.body
 puts response.headers
-

data/examples/partnersettings/partnersettings.rb

@@ -1,9 +1,7 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Returns a list of all partner settings. #
 # GET /partner_settings #
@@ -19,8 +17,8 @@ puts response.headers
 # PATCH /partner_settings/new_relic #
 
 data = JSON.parse('{
-  "enable_subuser_statistics": true, 
-  "enabled": true, 
+  "enable_subuser_statistics": true,
+  "enabled": true,
   "license_key": ""
 }')
 response = sg.client.partner_settings.new_relic.patch(request_body: data)
@@ -32,8 +30,7 @@ puts response.headers
 # Returns all New Relic partner settings. #
 # GET /partner_settings/new_relic #
 
-response = sg.client.partner_settings.new_relic.get()
+response = sg.client.partner_settings.new_relic.get
 puts response.status_code
 puts response.body
 puts response.headers
-

data/examples/scopes/scopes.rb

@@ -1,12 +1,11 @@
 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 #
 
-response = sg.client.scopes.get()
+response = sg.client.scopes.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -15,14 +14,13 @@ puts response.headers
 # Update the name & scopes of an API Key #
 # PUT /api_keys/{api_key_id} #
 
-
 scopes = [
-  "user.profile.read", 
+  "user.profile.read",
   "user.profile.update"
 ]
 
 data = {
-  "name": "A New Hope", 
+  "name": "A New Hope",
   "scopes": scopes
 }
 api_key_id = "test_url_param"
@@ -44,8 +42,8 @@ scopes = SendGrid::Scope.read_only_permissions
 # {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, 
+# 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
@@ -54,8 +52,8 @@ scopes = SendGrid::Scope.alerts_read_only_permissions
 # full access permissions for alerts
 scopes = SendGrid::Scope.alerts_full_access_permissions
 
-# read only permissions for billing 
+# read only permissions for billing
 scopes = SendGrid::Scope.billing_read_only_permissions
 
 # full access permissions for billing
-scopes = SendGrid::Scope.billing_full_access_permissions
+scopes = SendGrid::Scope.billing_full_access_permissions

data/examples/senderauthentication/senderauthentication.rb

@@ -1,23 +1,21 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Create a domain authentication. #
 # POST /whitelabel/domains #
 
 data = JSON.parse('{
-  "automatic_security": false, 
-  "custom_spf": true, 
-  "default": true, 
-  "domain": "example.com", 
+  "automatic_security": false,
+  "custom_spf": true,
+  "default": true,
+  "domain": "example.com",
   "ips": [
-    "192.168.1.1", 
+    "192.168.1.1",
     "192.168.1.2"
-  ], 
-  "subdomain": "news", 
+  ],
+  "subdomain": "news",
   "username": "john@example.com"
 }')
 response = sg.client.whitelabel.domains.post(request_body: data)
@@ -39,7 +37,7 @@ puts response.headers
 # Get the default domain authentication. #
 # GET /whitelabel/domains/default #
 
-response = sg.client.whitelabel.domains.default.get()
+response = sg.client.whitelabel.domains.default.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -48,7 +46,7 @@ puts response.headers
 # List the domain authentication associated with the given user. #
 # GET /whitelabel/domains/subuser #
 
-response = sg.client.whitelabel.domains.subuser.get()
+response = sg.client.whitelabel.domains.subuser.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -57,7 +55,7 @@ puts response.headers
 # Disassociate a domain authentication from a given user. #
 # DELETE /whitelabel/domains/subuser #
 
-response = sg.client.whitelabel.domains.subuser.delete()
+response = sg.client.whitelabel.domains.subuser.delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -67,10 +65,10 @@ puts response.headers
 # PATCH /whitelabel/domains/{domain_id} #
 
 data = JSON.parse('{
-  "custom_spf": true, 
+  "custom_spf": true,
   "default": false
 }')
-domain_id = "test_url_param"
+domain_id = 'test_url_param'
 response = sg.client.whitelabel.domains._(domain_id).patch(request_body: data)
 puts response.status_code
 puts response.body
@@ -80,8 +78,8 @@ puts response.headers
 # Retrieve a domain authentication. #
 # GET /whitelabel/domains/{domain_id} #
 
-domain_id = "test_url_param"
-response = sg.client.whitelabel.domains._(domain_id).get()
+domain_id = 'test_url_param'
+response = sg.client.whitelabel.domains._(domain_id).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -90,8 +88,8 @@ puts response.headers
 # Delete a domain authentication. #
 # DELETE /whitelabel/domains/{domain_id} #
 
-domain_id = "test_url_param"
-response = sg.client.whitelabel.domains._(domain_id).delete()
+domain_id = 'test_url_param'
+response = sg.client.whitelabel.domains._(domain_id).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -103,7 +101,7 @@ puts response.headers
 data = JSON.parse('{
   "username": "jane@example.com"
 }')
-domain_id = "test_url_param"
+domain_id = 'test_url_param'
 response = sg.client.whitelabel.domains._(domain_id).subuser.post(request_body: data)
 puts response.status_code
 puts response.body
@@ -116,7 +114,7 @@ puts response.headers
 data = JSON.parse('{
   "ip": "192.168.0.1"
 }')
-id = "test_url_param"
+id = 'test_url_param'
 response = sg.client.whitelabel.domains._(id).ips.post(request_body: data)
 puts response.status_code
 puts response.body
@@ -126,9 +124,9 @@ puts response.headers
 # Remove an IP from a domain authentication. #
 # DELETE /whitelabel/domains/{id}/ips/{ip} #
 
-id = "test_url_param"
-ip = "test_url_param"
-response = sg.client.whitelabel.domains._(id).ips._(ip).delete()
+id = 'test_url_param'
+ip = 'test_url_param'
+response = sg.client.whitelabel.domains._(id).ips._(ip).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -137,8 +135,8 @@ puts response.headers
 # Validate a domain authentication. #
 # POST /whitelabel/domains/{id}/validate #
 
-id = "test_url_param"
-response = sg.client.whitelabel.domains._(id).validate.post()
+id = 'test_url_param'
+response = sg.client.whitelabel.domains._(id).validate.post
 puts response.status_code
 puts response.body
 puts response.headers
@@ -148,8 +146,8 @@ puts response.headers
 # POST /whitelabel/ips #
 
 data = JSON.parse('{
-  "domain": "example.com", 
-  "ip": "192.168.1.1", 
+  "domain": "example.com",
+  "ip": "192.168.1.1",
   "subdomain": "email"
 }')
 response = sg.client.whitelabel.ips.post(request_body: data)
@@ -171,8 +169,8 @@ puts response.headers
 # Retrieve a reverse DNS record #
 # GET /whitelabel/ips/{id} #
 
-id = "test_url_param"
-response = sg.client.whitelabel.ips._(id).get()
+id = 'test_url_param'
+response = sg.client.whitelabel.ips._(id).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -181,8 +179,8 @@ puts response.headers
 # Delete a reverse DNS record #
 # DELETE /whitelabel/ips/{id} #
 
-id = "test_url_param"
-response = sg.client.whitelabel.ips._(id).delete()
+id = 'test_url_param'
+response = sg.client.whitelabel.ips._(id).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -191,8 +189,8 @@ puts response.headers
 # Validate a reverse DNS record #
 # POST /whitelabel/ips/{id}/validate #
 
-id = "test_url_param"
-response = sg.client.whitelabel.ips._(id).validate.post()
+id = 'test_url_param'
+response = sg.client.whitelabel.ips._(id).validate.post
 puts response.status_code
 puts response.body
 puts response.headers
@@ -202,8 +200,8 @@ puts response.headers
 # POST /whitelabel/links #
 
 data = JSON.parse('{
-  "default": true, 
-  "domain": "example.com", 
+  "default": true,
+  "domain": "example.com",
   "subdomain": "mail"
 }')
 params = JSON.parse('{"limit": 1, "offset": 1}')
@@ -259,7 +257,7 @@ puts response.headers
 data = JSON.parse('{
   "default": true
 }')
-id = "test_url_param"
+id = 'test_url_param'
 response = sg.client.whitelabel.links._(id).patch(request_body: data)
 puts response.status_code
 puts response.body
@@ -269,8 +267,8 @@ puts response.headers
 # Retrieve a Link Branding #
 # GET /whitelabel/links/{id} #
 
-id = "test_url_param"
-response = sg.client.whitelabel.links._(id).get()
+id = 'test_url_param'
+response = sg.client.whitelabel.links._(id).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -279,8 +277,8 @@ puts response.headers
 # Delete a Link Branding #
 # DELETE /whitelabel/links/{id} #
 
-id = "test_url_param"
-response = sg.client.whitelabel.links._(id).delete()
+id = 'test_url_param'
+response = sg.client.whitelabel.links._(id).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -289,8 +287,8 @@ puts response.headers
 # Validate a Link Branding #
 # POST /whitelabel/links/{id}/validate #
 
-id = "test_url_param"
-response = sg.client.whitelabel.links._(id).validate.post()
+id = 'test_url_param'
+response = sg.client.whitelabel.links._(id).validate.post
 puts response.status_code
 puts response.body
 puts response.headers
@@ -302,9 +300,8 @@ puts response.headers
 data = JSON.parse('{
   "username": "jane@example.com"
 }')
-link_id = "test_url_param"
+link_id = 'test_url_param'
 response = sg.client.whitelabel.links._(link_id).subuser.post(request_body: data)
 puts response.status_code
 puts response.body
 puts response.headers
-