sendgrid-ruby 5.3.0 → 6.7.0

data/examples/ips/ips.rb

@@ -1,9 +1,7 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Retrieve all IP addresses #
 # GET /ips #
@@ -18,11 +16,24 @@ puts response.headers
 # Retrieve all assigned IPs #
 # GET /ips/assigned #
 
-response = sg.client.ips.assigned.get()
+response = sg.client.ips.assigned.get
 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 #
@@ -39,7 +50,7 @@ puts response.headers
 # Retrieve all IP pools. #
 # GET /ips/pools #
 
-response = sg.client.ips.pools.get()
+response = sg.client.ips.pools.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -51,7 +62,7 @@ puts response.headers
 data = JSON.parse('{
   "name": "new_pool_name"
 }')
-pool_name = "test_url_param"
+pool_name = 'test_url_param'
 response = sg.client.ips.pools._(pool_name).put(request_body: data)
 puts response.status_code
 puts response.body
@@ -61,8 +72,8 @@ 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()
+pool_name = 'test_url_param'
+response = sg.client.ips.pools._(pool_name).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -71,8 +82,8 @@ 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()
+pool_name = 'test_url_param'
+response = sg.client.ips.pools._(pool_name).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -84,7 +95,7 @@ puts response.headers
 data = JSON.parse('{
   "ip": "0.0.0.0"
 }')
-pool_name = "test_url_param"
+pool_name = 'test_url_param'
 response = sg.client.ips.pools._(pool_name).ips.post(request_body: data)
 puts response.status_code
 puts response.body
@@ -94,9 +105,9 @@ 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()
+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
@@ -117,7 +128,7 @@ puts response.headers
 # Retrieve all IPs currently in warmup #
 # GET /ips/warmup #
 
-response = sg.client.ips.warmup.get()
+response = sg.client.ips.warmup.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -126,8 +137,8 @@ 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()
+ip_address = 'test_url_param'
+response = sg.client.ips.warmup._(ip_address).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -136,8 +147,8 @@ 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()
+ip_address = 'test_url_param'
+response = sg.client.ips.warmup._(ip_address).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -146,9 +157,8 @@ 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()
+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

@@ -1,14 +1,12 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Create a batch ID #
 # POST /mail/batch #
 
-response = sg.client.mail.batch.post()
+response = sg.client.mail.batch.post
 puts response.status_code
 puts response.body
 puts response.headers
@@ -17,8 +15,8 @@ puts response.headers
 # Validate batch ID #
 # GET /mail/batch/{batch_id} #
 
-batch_id = "test_url_param"
-response = sg.client.mail.batch._(batch_id).get()
+batch_id = 'test_url_param'
+response = sg.client.mail.batch._(batch_id).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -26,148 +24,147 @@ 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).
+# This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-ruby/blob/HEAD/lib/sendgrid/helpers/mail/README.md).
 
 data = JSON.parse('{
   "asm": {
-    "group_id": 1, 
+    "group_id": 1,
     "groups_to_display": [
-      1, 
-      2, 
+      1,
+      2,
       3
     ]
-  }, 
+  },
   "attachments": [
     {
-      "content": "[BASE64 encoded content block here]", 
-      "content_id": "ii_139db99fdb5c3704", 
-      "disposition": "inline", 
-      "filename": "file1.jpg", 
-      "name": "file1", 
+      "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]", 
+  ],
+  "batch_id": "[YOUR BATCH ID GOES HERE]",
   "categories": [
-    "category1", 
+    "category1",
     "category2"
-  ], 
+  ],
   "content": [
     {
-      "type": "text/html", 
+      "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", 
+    "New Argument 1": "New Value 1",
+    "activationAttempt": "1",
     "customerAccountNumber": "[CUSTOMER ACCOUNT NUMBER GOES HERE]"
-  }, 
+  },
   "from": {
-    "email": "sam.smith@example.com", 
+    "email": "sam.smith@example.com",
     "name": "Sam Smith"
-  }, 
-  "headers": {}, 
-  "ip_pool_name": "[YOUR POOL NAME GOES HERE]", 
+  },
+  "headers": {},
+  "ip_pool_name": "[YOUR POOL NAME GOES HERE]",
   "mail_settings": {
     "bcc": {
-      "email": "ben.doe@example.com", 
+      "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"
-    }, 
+      "enable": true,
+      "html": "<p>Thanks</br>The Twilio SendGrid Team</p>",
+      "text": "Thanks,/n The Twilio SendGrid Team"
+    },
     "sandbox_mode": {
       "enable": false
-    }, 
+    },
     "spam_check": {
-      "enable": true, 
-      "post_to_url": "http://example.com/compliance", 
+      "enable": true,
+      "post_to_url": "http://example.com/compliance",
       "threshold": 3
     }
-  }, 
+  },
   "personalizations": [
     {
       "bcc": [
         {
-          "email": "sam.doe@example.com", 
+          "email": "sam.doe@example.com",
           "name": "Sam Doe"
         }
-      ], 
+      ],
       "cc": [
         {
-          "email": "jane.doe@example.com", 
+          "email": "jane.doe@example.com",
           "name": "Jane Doe"
         }
-      ], 
+      ],
       "custom_args": {
-        "New Argument 1": "New Value 1", 
-        "activationAttempt": "1", 
+        "New Argument 1": "New Value 1",
+        "activationAttempt": "1",
         "customerAccountNumber": "[CUSTOMER ACCOUNT NUMBER GOES HERE]"
-      }, 
+      },
       "headers": {
-        "X-Accept-Language": "en", 
+        "X-Accept-Language": "en",
         "X-Mailer": "MyApp"
-      }, 
-      "send_at": 1409348513, 
-      "subject": "Hello, World!", 
+      },
+      "send_at": 1409348513,
+      "subject": "Hello, World!",
       "substitutions": {
-        "id": "substitutions", 
+        "id": "substitutions",
         "type": "object"
-      }, 
+      },
       "to": [
         {
-          "email": "john.doe@example.com", 
+          "email": "john.doe@example.com",
           "name": "John Doe"
         }
       ]
     }
-  ], 
+  ],
   "reply_to": {
-    "email": "sam.smith@example.com", 
+    "email": "sam.smith@example.com",
     "name": "Sam Smith"
-  }, 
+  },
   "sections": {
     "section": {
-      ":sectionName1": "section 1 text", 
+      ":sectionName1": "section 1 text",
       ":sectionName2": "section 2 text"
     }
-  }, 
-  "send_at": 1409348513, 
-  "subject": "Hello, World!", 
-  "template_id": "[YOUR TEMPLATE ID GOES HERE]", 
+  },
+  "send_at": 1409348513,
+  "subject": "Hello, World!",
+  "template_id": "[YOUR TEMPLATE ID GOES HERE]",
   "tracking_settings": {
     "click_tracking": {
-      "enable": true, 
+      "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]", 
+      "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, 
+      "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%>", 
+      "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)
+response = sg.client.mail._('send').post(request_body: data)
 puts response.status_code
 puts response.body
 puts response.headers
-

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,15 +1,59 @@
-require 'sendgrid-ruby'
-
-
+require_relative '../../lib/sendgrid-ruby'
 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
+
+##################################################
+# 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