sendgrid-ruby 5.3.0 → 6.7.0

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

@@ -1,23 +1,21 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
-# Create a domain whitelabel. #
+# 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)
@@ -26,7 +24,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,120 +34,120 @@ 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()
+response = sg.client.whitelabel.domains.default.get
 puts response.status_code
 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()
+response = sg.client.whitelabel.domains.subuser.get
 puts response.status_code
 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()
+response = sg.client.whitelabel.domains.subuser.delete
 puts response.status_code
 puts response.body
 puts response.headers
 
 ##################################################
-# Update a domain whitelabel. #
+# Update a domain authentication. #
 # 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
 puts response.headers
 
 ##################################################
-# Retrieve a domain whitelabel. #
+# 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
 
 ##################################################
-# Delete a domain whitelabel. #
+# 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
 
 ##################################################
-# 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('{
   "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
 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('{
   "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
 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"
-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
 
 ##################################################
-# Validate a domain whitelabel. #
+# 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
 
 ##################################################
-# Create an IP whitelabel #
+# Create a reverse DNS record #
 # 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)
@@ -158,7 +156,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,42 +166,42 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve an IP whitelabel #
+# 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
 
 ##################################################
-# Delete an IP whitelabel #
+# 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
 
 ##################################################
-# Validate an IP whitelabel #
+# 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
 
 ##################################################
-# Create a Link Whitelabel #
+# Create a Branded Link #
 # 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}')
@@ -213,7 +211,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 +221,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 +231,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 +241,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,58 +251,57 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Update a Link Whitelabel #
+# Update a Link Branding #
 # PATCH /whitelabel/links/{id} #
 
 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
 puts response.headers
 
 ##################################################
-# Retrieve a Link Whitelabel #
+# 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
 
 ##################################################
-# Delete a Link Whitelabel #
+# 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
 
 ##################################################
-# Validate a Link Whitelabel #
+# 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
 
 ##################################################
-# Associate a Link Whitelabel #
+# Associate a Link Branding #
 # POST /whitelabel/links/{link_id}/subuser #
 
 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
-

data/examples/senders/senders.rb

@@ -1,28 +1,26 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Create a Sender Identity #
 # POST /senders #
 
 data = JSON.parse('{
-  "address": "123 Elm St.", 
-  "address_2": "Apt. 456", 
-  "city": "Denver", 
-  "country": "United States", 
+  "address": "123 Elm St.",
+  "address_2": "Apt. 456",
+  "city": "Denver",
+  "country": "United States",
   "from": {
-    "email": "from@example.com", 
+    "email": "from@example.com",
     "name": "Example INC"
-  }, 
-  "nickname": "My Sender ID", 
+  },
+  "nickname": "My Sender ID",
   "reply_to": {
-    "email": "replyto@example.com", 
+    "email": "replyto@example.com",
     "name": "Example INC"
-  }, 
-  "state": "Colorado", 
+  },
+  "state": "Colorado",
   "zip": "80202"
 }')
 response = sg.client.senders.post(request_body: data)
@@ -34,7 +32,7 @@ puts response.headers
 # Get all Sender Identities #
 # GET /senders #
 
-response = sg.client.senders.get()
+response = sg.client.senders.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -44,23 +42,23 @@ puts response.headers
 # PATCH /senders/{sender_id} #
 
 data = JSON.parse('{
-  "address": "123 Elm St.", 
-  "address_2": "Apt. 456", 
-  "city": "Denver", 
-  "country": "United States", 
+  "address": "123 Elm St.",
+  "address_2": "Apt. 456",
+  "city": "Denver",
+  "country": "United States",
   "from": {
-    "email": "from@example.com", 
+    "email": "from@example.com",
     "name": "Example INC"
-  }, 
-  "nickname": "My Sender ID", 
+  },
+  "nickname": "My Sender ID",
   "reply_to": {
-    "email": "replyto@example.com", 
+    "email": "replyto@example.com",
     "name": "Example INC"
-  }, 
-  "state": "Colorado", 
+  },
+  "state": "Colorado",
   "zip": "80202"
 }')
-sender_id = "test_url_param"
+sender_id = 'test_url_param'
 response = sg.client.senders._(sender_id).patch(request_body: data)
 puts response.status_code
 puts response.body
@@ -70,8 +68,8 @@ puts response.headers
 # View a Sender Identity #
 # GET /senders/{sender_id} #
 
-sender_id = "test_url_param"
-response = sg.client.senders._(sender_id).get()
+sender_id = 'test_url_param'
+response = sg.client.senders._(sender_id).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -80,8 +78,8 @@ puts response.headers
 # Delete a Sender Identity #
 # DELETE /senders/{sender_id} #
 
-sender_id = "test_url_param"
-response = sg.client.senders._(sender_id).delete()
+sender_id = 'test_url_param'
+response = sg.client.senders._(sender_id).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -90,9 +88,8 @@ puts response.headers
 # Resend Sender Identity Verification #
 # POST /senders/{sender_id}/resend_verification #
 
-sender_id = "test_url_param"
-response = sg.client.senders._(sender_id).resend_verification.post()
+sender_id = 'test_url_param'
+response = sg.client.senders._(sender_id).resend_verification.post
 puts response.status_code
 puts response.body
 puts response.headers
-

data/examples/stats/stats.rb

@@ -1,9 +1,7 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Retrieve global email statistics #
 # GET /stats #
@@ -13,4 +11,3 @@ response = sg.client.stats.get(query_params: params)
 puts response.status_code
 puts response.body
 puts response.headers
-

data/examples/subusers/subusers.rb

@@ -1,20 +1,18 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Create Subuser #
 # POST /subusers #
 
 data = JSON.parse('{
-  "email": "John@example.com", 
+  "email": "John@example.com",
   "ips": [
-    "1.1.1.1", 
+    "1.1.1.1",
     "2.2.2.2"
-  ], 
-  "password": "johns_password", 
+  ],
+  "password": "johns_password",
   "username": "John@example.com"
 }')
 response = sg.client.subusers.post(request_body: data)
@@ -79,7 +77,7 @@ puts response.headers
 data = JSON.parse('{
   "disabled": false
 }')
-subuser_name = "test_url_param"
+subuser_name = 'test_url_param'
 response = sg.client.subusers._(subuser_name).patch(request_body: data)
 puts response.status_code
 puts response.body
@@ -89,8 +87,8 @@ puts response.headers
 # Delete a subuser #
 # DELETE /subusers/{subuser_name} #
 
-subuser_name = "test_url_param"
-response = sg.client.subusers._(subuser_name).delete()
+subuser_name = 'test_url_param'
+response = sg.client.subusers._(subuser_name).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -102,7 +100,7 @@ puts response.headers
 data = JSON.parse('[
   "127.0.0.1"
 ]')
-subuser_name = "test_url_param"
+subuser_name = 'test_url_param'
 response = sg.client.subusers._(subuser_name).ips.put(request_body: data)
 puts response.status_code
 puts response.body
@@ -113,10 +111,10 @@ puts response.headers
 # PUT /subusers/{subuser_name}/monitor #
 
 data = JSON.parse('{
-  "email": "example@example.com", 
+  "email": "example@example.com",
   "frequency": 500
 }')
-subuser_name = "test_url_param"
+subuser_name = 'test_url_param'
 response = sg.client.subusers._(subuser_name).monitor.put(request_body: data)
 puts response.status_code
 puts response.body
@@ -127,10 +125,10 @@ puts response.headers
 # POST /subusers/{subuser_name}/monitor #
 
 data = JSON.parse('{
-  "email": "example@example.com", 
+  "email": "example@example.com",
   "frequency": 50000
 }')
-subuser_name = "test_url_param"
+subuser_name = 'test_url_param'
 response = sg.client.subusers._(subuser_name).monitor.post(request_body: data)
 puts response.status_code
 puts response.body
@@ -140,8 +138,8 @@ puts response.headers
 # Retrieve monitor settings for a subuser #
 # GET /subusers/{subuser_name}/monitor #
 
-subuser_name = "test_url_param"
-response = sg.client.subusers._(subuser_name).monitor.get()
+subuser_name = 'test_url_param'
+response = sg.client.subusers._(subuser_name).monitor.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -150,8 +148,8 @@ puts response.headers
 # Delete monitor settings #
 # DELETE /subusers/{subuser_name}/monitor #
 
-subuser_name = "test_url_param"
-response = sg.client.subusers._(subuser_name).monitor.delete()
+subuser_name = 'test_url_param'
+response = sg.client.subusers._(subuser_name).monitor.delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -161,9 +159,8 @@ puts response.headers
 # GET /subusers/{subuser_name}/stats/monthly #
 
 params = JSON.parse('{"date": "test_string", "sort_by_direction": "asc", "limit": 1, "sort_by_metric": "test_string", "offset": 1}')
-subuser_name = "test_url_param"
+subuser_name = 'test_url_param'
 response = sg.client.subusers._(subuser_name).stats.monthly.get(query_params: params)
 puts response.status_code
 puts response.body
 puts response.headers
-