sendgrid-ruby 1.1.6 → 3.0.0

data/examples/user/user.rb

@@ -0,0 +1,256 @@
+require 'sendgrid-ruby'
+
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import com.sendgrid.Client;
+import com.sendgrid.Method;
+import com.sendgrid.Request;
+import com.sendgrid.Response;
+import com.sendgrid.SendGrid;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+##################################################
+# Get a user's account information. #
+# GET /user/account #
+
+response = sg.client.user.account.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve your credit balance #
+# GET /user/credits #
+
+response = sg.client.user.credits.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update your account email address #
+# PUT /user/email #
+
+data = JSON.parse('{
+  "email": "example@example.com"
+}')
+response = sg.client.user.email.put(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve your account email address #
+# GET /user/email #
+
+response = sg.client.user.email.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update your password #
+# PUT /user/password #
+
+data = JSON.parse('{
+  "new_password": "new_password", 
+  "old_password": "old_password"
+}')
+response = sg.client.user.password.put(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update a user's profile #
+# PATCH /user/profile #
+
+data = JSON.parse('{
+  "city": "Orange", 
+  "first_name": "Example", 
+  "last_name": "User"
+}')
+response = sg.client.user.profile.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Get a user's profile #
+# GET /user/profile #
+
+response = sg.client.user.profile.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Cancel or pause a scheduled send #
+# POST /user/scheduled_sends #
+
+data = JSON.parse('{
+  "batch_id": "YOUR_BATCH_ID", 
+  "status": "pause"
+}')
+response = sg.client.user.scheduled_sends.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all scheduled sends #
+# GET /user/scheduled_sends #
+
+response = sg.client.user.scheduled_sends.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update user scheduled send information #
+# PATCH /user/scheduled_sends/{batch_id} #
+
+data = JSON.parse('{
+  "status": "pause"
+}')
+batch_id = "test_url_param"
+response = sg.client.user.scheduled_sends._(batch_id).patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve scheduled send #
+# GET /user/scheduled_sends/{batch_id} #
+
+batch_id = "test_url_param"
+response = sg.client.user.scheduled_sends._(batch_id).get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a cancellation or pause of a scheduled send #
+# DELETE /user/scheduled_sends/{batch_id} #
+
+batch_id = "test_url_param"
+response = sg.client.user.scheduled_sends._(batch_id).delete()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update Enforced TLS settings #
+# PATCH /user/settings/enforced_tls #
+
+data = JSON.parse('{
+  "require_tls": true, 
+  "require_valid_cert": false
+}')
+response = sg.client.user.settings.enforced_tls.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve current Enforced TLS settings. #
+# GET /user/settings/enforced_tls #
+
+response = sg.client.user.settings.enforced_tls.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update your username #
+# PUT /user/username #
+
+data = JSON.parse('{
+  "username": "test_username"
+}')
+response = sg.client.user.username.put(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve your username #
+# GET /user/username #
+
+response = sg.client.user.username.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update Event Notification Settings #
+# PATCH /user/webhooks/event/settings #
+
+data = JSON.parse('{
+  "bounce": true, 
+  "click": true, 
+  "deferred": true, 
+  "delivered": true, 
+  "dropped": true, 
+  "enabled": true, 
+  "group_resubscribe": true, 
+  "group_unsubscribe": true, 
+  "open": true, 
+  "processed": true, 
+  "spam_report": true, 
+  "unsubscribe": true, 
+  "url": "url"
+}')
+response = sg.client.user.webhooks.event.settings.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve Event Webhook settings #
+# GET /user/webhooks/event/settings #
+
+response = sg.client.user.webhooks.event.settings.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Test Event Notification Settings  #
+# POST /user/webhooks/event/test #
+
+data = JSON.parse('{
+  "url": "url"
+}')
+response = sg.client.user.webhooks.event.test.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve Parse Webhook settings #
+# GET /user/webhooks/parse/settings #
+
+response = sg.client.user.webhooks.parse.settings.get()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieves Inbound Parse Webhook statistics. #
+# GET /user/webhooks/parse/stats #
+
+params = JSON.parse('{"aggregated_by": "day", "limit": "test_string", "start_date": "2016-01-01", "end_date": "2016-04-01", "offset": "test_string"}')
+response = sg.client.user.webhooks.parse.stats.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+

data/examples/whitelabel/whitelabel.rb

@@ -0,0 +1,323 @@
+require 'sendgrid-ruby'
+
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import com.sendgrid.Client;
+import com.sendgrid.Method;
+import com.sendgrid.Request;
+import com.sendgrid.Response;
+import com.sendgrid.SendGrid;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+##################################################
+# Create a domain whitelabel. #
+# POST /whitelabel/domains #
+
+data = JSON.parse('{
+  "automatic_security": false, 
+  "custom_spf": true, 
+  "default": true, 
+  "domain": "example.com", 
+  "ips": [
+    "192.168.1.1", 
+    "192.168.1.2"
+  ], 
+  "subdomain": "news", 
+  "username": "john@example.com"
+}')
+response = sg.client.whitelabel.domains.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# List all domain whitelabels. #
+# GET /whitelabel/domains #
+
+params = JSON.parse('{"username": "test_string", "domain": "test_string", "exclude_subusers": "true", "limit": 1, "offset": 1}')
+response = sg.client.whitelabel.domains.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Get the default domain whitelabel. #
+# GET /whitelabel/domains/default #
+
+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. #
+# GET /whitelabel/domains/subuser #
+
+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. #
+# DELETE /whitelabel/domains/subuser #
+
+response = sg.client.whitelabel.domains.subuser.delete()
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update a domain whitelabel. #
+# PATCH /whitelabel/domains/{domain_id} #
+
+data = JSON.parse('{
+  "custom_spf": true, 
+  "default": false
+}')
+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. #
+# GET /whitelabel/domains/{domain_id} #
+
+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 /whitelabel/domains/{domain_id} #
+
+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. #
+# POST /whitelabel/domains/{domain_id}/subuser #
+
+data = JSON.parse('{
+  "username": "jane@example.com"
+}')
+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. #
+# POST /whitelabel/domains/{id}/ips #
+
+data = JSON.parse('{
+  "ip": "192.168.0.1"
+}')
+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. #
+# DELETE /whitelabel/domains/{id}/ips/{ip} #
+
+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. #
+# POST /whitelabel/domains/{id}/validate #
+
+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 #
+# POST /whitelabel/ips #
+
+data = JSON.parse('{
+  "domain": "example.com", 
+  "ip": "192.168.1.1", 
+  "subdomain": "email"
+}')
+response = sg.client.whitelabel.ips.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all IP whitelabels #
+# GET /whitelabel/ips #
+
+params = JSON.parse('{"ip": "test_string", "limit": 1, "offset": 1}')
+response = sg.client.whitelabel.ips.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve an IP whitelabel #
+# GET /whitelabel/ips/{id} #
+
+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 /whitelabel/ips/{id} #
+
+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 #
+# POST /whitelabel/ips/{id}/validate #
+
+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 #
+# POST /whitelabel/links #
+
+data = JSON.parse('{
+  "default": true, 
+  "domain": "example.com", 
+  "subdomain": "mail"
+}')
+params = JSON.parse('{"limit": 1, "offset": 1}')
+response = sg.client.whitelabel.links.post(request_body: data, query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all link whitelabels #
+# GET /whitelabel/links #
+
+params = JSON.parse('{"limit": 1}')
+response = sg.client.whitelabel.links.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve a Default Link Whitelabel #
+# GET /whitelabel/links/default #
+
+params = JSON.parse('{"domain": "test_string"}')
+response = sg.client.whitelabel.links.default.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve Associated Link Whitelabel #
+# GET /whitelabel/links/subuser #
+
+params = JSON.parse('{"username": "test_string"}')
+response = sg.client.whitelabel.links.subuser.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Disassociate a Link Whitelabel #
+# DELETE /whitelabel/links/subuser #
+
+params = JSON.parse('{"username": "test_string"}')
+response = sg.client.whitelabel.links.subuser.delete(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update a Link Whitelabel #
+# PATCH /whitelabel/links/{id} #
+
+data = JSON.parse('{
+  "default": true
+}')
+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 #
+# GET /whitelabel/links/{id} #
+
+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 /whitelabel/links/{id} #
+
+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 #
+# POST /whitelabel/links/{id}/validate #
+
+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 #
+# POST /whitelabel/links/{link_id}/subuser #
+
+data = JSON.parse('{
+  "username": "jane@example.com"
+}')
+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
+