sendgrid-ruby 1.1.6 → 6.6.2

data/examples/senderauthentication/senderauthentication.rb

@@ -0,0 +1,307 @@
+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",
+  "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 authentications. #
+# 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 authentication. #
+# GET /whitelabel/domains/default #
+
+response = sg.client.whitelabel.domains.default.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# List the domain authentication 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 authentication 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 authentication. #
+# 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 authentication. #
+# 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 authentication. #
+# 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 authentication 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 authentication. #
+# 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 authentication. #
+# 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 authentication. #
+# 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 a reverse DNS record #
+# 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 a reverse DNS record #
+# 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 a reverse DNS record #
+# 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 a reverse DNS record #
+# 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 a reverse DNS record #
+# 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 Branded Link #
+# 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 brandings #
+# 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 Branding #
+# 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 Branding #
+# 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 Branding #
+# 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 Branding #
+# 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 Branding #
+# 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 Branding #
+# 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 Branding #
+# 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 Branding #
+# 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

data/examples/senders/senders.rb

@@ -0,0 +1,95 @@
+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",
+  "from": {
+    "email": "from@example.com",
+    "name": "Example INC"
+  },
+  "nickname": "My Sender ID",
+  "reply_to": {
+    "email": "replyto@example.com",
+    "name": "Example INC"
+  },
+  "state": "Colorado",
+  "zip": "80202"
+}')
+response = sg.client.senders.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Get all Sender Identities #
+# GET /senders #
+
+response = sg.client.senders.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update a Sender Identity #
+# PATCH /senders/{sender_id} #
+
+data = JSON.parse('{
+  "address": "123 Elm St.",
+  "address_2": "Apt. 456",
+  "city": "Denver",
+  "country": "United States",
+  "from": {
+    "email": "from@example.com",
+    "name": "Example INC"
+  },
+  "nickname": "My Sender ID",
+  "reply_to": {
+    "email": "replyto@example.com",
+    "name": "Example INC"
+  },
+  "state": "Colorado",
+  "zip": "80202"
+}')
+sender_id = 'test_url_param'
+response = sg.client.senders._(sender_id).patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# View a Sender Identity #
+# GET /senders/{sender_id} #
+
+sender_id = 'test_url_param'
+response = sg.client.senders._(sender_id).get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a Sender Identity #
+# DELETE /senders/{sender_id} #
+
+sender_id = 'test_url_param'
+response = sg.client.senders._(sender_id).delete
+puts response.status_code
+puts response.body
+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
+puts response.status_code
+puts response.body
+puts response.headers

data/examples/stats/stats.rb

@@ -0,0 +1,13 @@
+require 'sendgrid-ruby'
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+##################################################
+# Retrieve global email statistics #
+# GET /stats #
+
+params = JSON.parse('{"aggregated_by": "day", "limit": 1, "start_date": "2016-01-01", "end_date": "2016-04-01", "offset": 1}')
+response = sg.client.stats.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers

data/examples/subusers/subusers.rb

@@ -0,0 +1,166 @@
+require 'sendgrid-ruby'
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+##################################################
+# Create Subuser #
+# POST /subusers #
+
+data = JSON.parse('{
+  "email": "John@example.com",
+  "ips": [
+    "1.1.1.1",
+    "2.2.2.2"
+  ],
+  "password": "johns_password",
+  "username": "John@example.com"
+}')
+response = sg.client.subusers.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# List all Subusers #
+# GET /subusers #
+
+params = JSON.parse('{"username": "test_string", "limit": 1, "offset": 1}')
+response = sg.client.subusers.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve Subuser Reputations #
+# GET /subusers/reputations #
+
+params = JSON.parse('{"usernames": "test_string"}')
+response = sg.client.subusers.reputations.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve email statistics for your subusers. #
+# GET /subusers/stats #
+
+params = JSON.parse('{"end_date": "2016-04-01", "aggregated_by": "day", "limit": 1, "offset": 1, "start_date": "2016-01-01", "subusers": "test_string"}')
+response = sg.client.subusers.stats.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve monthly stats for all subusers #
+# GET /subusers/stats/monthly #
+
+params = JSON.parse('{"subuser": "test_string", "limit": 1, "sort_by_metric": "test_string", "offset": 1, "date": "test_string", "sort_by_direction": "asc"}')
+response = sg.client.subusers.stats.monthly.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+#  Retrieve the totals for each email statistic metric for all subusers. #
+# GET /subusers/stats/sums #
+
+params = JSON.parse('{"end_date": "2016-04-01", "aggregated_by": "day", "limit": 1, "sort_by_metric": "test_string", "offset": 1, "start_date": "2016-01-01", "sort_by_direction": "asc"}')
+response = sg.client.subusers.stats.sums.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Enable/disable a subuser #
+# PATCH /subusers/{subuser_name} #
+
+data = JSON.parse('{
+  "disabled": false
+}')
+subuser_name = 'test_url_param'
+response = sg.client.subusers._(subuser_name).patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a subuser #
+# DELETE /subusers/{subuser_name} #
+
+subuser_name = 'test_url_param'
+response = sg.client.subusers._(subuser_name).delete
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update IPs assigned to a subuser #
+# PUT /subusers/{subuser_name}/ips #
+
+data = JSON.parse('[
+  "127.0.0.1"
+]')
+subuser_name = 'test_url_param'
+response = sg.client.subusers._(subuser_name).ips.put(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update Monitor Settings for a subuser #
+# PUT /subusers/{subuser_name}/monitor #
+
+data = JSON.parse('{
+  "email": "example@example.com",
+  "frequency": 500
+}')
+subuser_name = 'test_url_param'
+response = sg.client.subusers._(subuser_name).monitor.put(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Create monitor settings #
+# POST /subusers/{subuser_name}/monitor #
+
+data = JSON.parse('{
+  "email": "example@example.com",
+  "frequency": 50000
+}')
+subuser_name = 'test_url_param'
+response = sg.client.subusers._(subuser_name).monitor.post(request_body: data)
+puts response.status_code
+puts response.body
+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
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete monitor settings #
+# DELETE /subusers/{subuser_name}/monitor #
+
+subuser_name = 'test_url_param'
+response = sg.client.subusers._(subuser_name).monitor.delete
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve the monthly email statistics for a single subuser #
+# 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'
+response = sg.client.subusers._(subuser_name).stats.monthly.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers