sendgrid-ruby 1.1.6 → 6.6.2

data/examples/suppression/suppression.rb

@@ -0,0 +1,198 @@
+require 'sendgrid-ruby'
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+##################################################
+# Retrieve all blocks #
+# GET /suppression/blocks #
+
+params = JSON.parse('{"start_time": 1, "limit": 1, "end_time": 1, "offset": 1}')
+response = sg.client.suppression.blocks.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete blocks #
+# DELETE /suppression/blocks #
+
+data = JSON.parse('{
+  "delete_all": false,
+  "emails": [
+    "example1@example.com",
+    "example2@example.com"
+  ]
+}')
+response = sg.client.suppression.blocks.delete(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve a specific block #
+# GET /suppression/blocks/{email} #
+
+email = 'test_url_param'
+response = sg.client.suppression.blocks._(email).get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a specific block #
+# DELETE /suppression/blocks/{email} #
+
+email = 'test_url_param'
+response = sg.client.suppression.blocks._(email).delete
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all bounces #
+# GET /suppression/bounces #
+
+params = JSON.parse('{"start_time": 1, "end_time": 1}')
+response = sg.client.suppression.bounces.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete bounces #
+# DELETE /suppression/bounces #
+
+data = JSON.parse('{
+  "delete_all": true,
+  "emails": [
+    "example@example.com",
+    "example2@example.com"
+  ]
+}')
+response = sg.client.suppression.bounces.delete(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve a Bounce #
+# GET /suppression/bounces/{email} #
+
+email = 'test_url_param'
+response = sg.client.suppression.bounces._(email).get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a bounce #
+# DELETE /suppression/bounces/{email} #
+
+params = JSON.parse('{"email_address": "example@example.com"}')
+email = 'test_url_param'
+response = sg.client.suppression.bounces._(email).delete(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all invalid emails #
+# GET /suppression/invalid_emails #
+
+params = JSON.parse('{"start_time": 1, "limit": 1, "end_time": 1, "offset": 1}')
+response = sg.client.suppression.invalid_emails.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete invalid emails #
+# DELETE /suppression/invalid_emails #
+
+data = JSON.parse('{
+  "delete_all": false,
+  "emails": [
+    "example1@example.com",
+    "example2@example.com"
+  ]
+}')
+response = sg.client.suppression.invalid_emails.delete(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve a specific invalid email #
+# GET /suppression/invalid_emails/{email} #
+
+email = 'test_url_param'
+response = sg.client.suppression.invalid_emails._(email).get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a specific invalid email #
+# DELETE /suppression/invalid_emails/{email} #
+
+email = 'test_url_param'
+response = sg.client.suppression.invalid_emails._(email).delete
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve a specific spam report #
+# GET /suppression/spam_report/{email} #
+
+email = 'test_url_param'
+response = sg.client.suppression.spam_report._(email).get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a specific spam report #
+# DELETE /suppression/spam_report/{email} #
+
+email = 'test_url_param'
+response = sg.client.suppression.spam_reports._(email).delete
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all spam reports #
+# GET /suppression/spam_reports #
+
+params = JSON.parse('{"start_time": 1, "limit": 1, "end_time": 1, "offset": 1}')
+response = sg.client.suppression.spam_reports.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete spam reports #
+# DELETE /suppression/spam_reports #
+
+data = JSON.parse('{
+  "delete_all": false,
+  "emails": [
+    "example1@example.com",
+    "example2@example.com"
+  ]
+}')
+response = sg.client.suppression.spam_reports.delete(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all global suppressions #
+# GET /suppression/unsubscribes #
+
+params = JSON.parse('{"start_time": 1, "limit": 1, "end_time": 1, "offset": 1}')
+response = sg.client.suppression.unsubscribes.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers

data/examples/templates/templates.rb

@@ -0,0 +1,127 @@
+require 'sendgrid-ruby'
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+##################################################
+# Create a transactional template. #
+# POST /templates #
+
+data = JSON.parse('{
+  "name": "example_name"
+}')
+response = sg.client.templates.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve all transactional templates (legacy & dynamic). #
+# GET /templates #
+
+params = JSON.parse('{"generations": "legacy,dynamic"}')
+response = sg.client.templates.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Edit a transactional template. #
+# PATCH /templates/{template_id} #
+
+data = JSON.parse('{
+  "name": "new_example_name"
+}')
+template_id = 'test_url_param'
+response = sg.client.templates._(template_id).patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve a single transactional template. #
+# GET /templates/{template_id} #
+
+template_id = 'test_url_param'
+response = sg.client.templates._(template_id).get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a template. #
+# DELETE /templates/{template_id} #
+
+template_id = 'test_url_param'
+response = sg.client.templates._(template_id).delete
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Create a new transactional template version. #
+# POST /templates/{template_id}/versions #
+
+data = JSON.parse('{
+  "active": 1,
+  "html_content": "<%body%>",
+  "name": "example_version_name",
+  "plain_content": "<%body%>",
+  "subject": "<%subject%>",
+  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543"
+}')
+template_id = 'test_url_param'
+response = sg.client.templates._(template_id).versions.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Edit a transactional template version. #
+# PATCH /templates/{template_id}/versions/{version_id} #
+
+data = JSON.parse('{
+  "active": 1,
+  "html_content": "<%body%>",
+  "name": "updated_example_name",
+  "plain_content": "<%body%>",
+  "subject": "<%subject%>"
+}')
+template_id = 'test_url_param'
+version_id = 'test_url_param'
+response = sg.client.templates._(template_id).versions._(version_id).patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve a specific transactional template version. #
+# GET /templates/{template_id}/versions/{version_id} #
+
+template_id = 'test_url_param'
+version_id = 'test_url_param'
+response = sg.client.templates._(template_id).versions._(version_id).get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Delete a transactional template version. #
+# DELETE /templates/{template_id}/versions/{version_id} #
+
+template_id = 'test_url_param'
+version_id = 'test_url_param'
+response = sg.client.templates._(template_id).versions._(version_id).delete
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Activate a transactional template version. #
+# POST /templates/{template_id}/versions/{version_id}/activate #
+
+template_id = 'test_url_param'
+version_id = 'test_url_param'
+response = sg.client.templates._(template_id).versions._(version_id).activate.post
+puts response.status_code
+puts response.body
+puts response.headers

data/examples/trackingsettings/trackingsettings.rb

@@ -0,0 +1,107 @@
+require 'sendgrid-ruby'
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+
+##################################################
+# Retrieve Tracking Settings #
+# GET /tracking_settings #
+
+params = JSON.parse('{"limit": 1, "offset": 1}')
+response = sg.client.tracking_settings.get(query_params: params)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update Click Tracking Settings #
+# PATCH /tracking_settings/click #
+
+data = JSON.parse('{
+  "enabled": true
+}')
+response = sg.client.tracking_settings.click.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve Click Track Settings #
+# GET /tracking_settings/click #
+
+response = sg.client.tracking_settings.click.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update Google Analytics Settings #
+# PATCH /tracking_settings/google_analytics #
+
+data = JSON.parse('{
+  "enabled": true,
+  "utm_campaign": "website",
+  "utm_content": "",
+  "utm_medium": "email",
+  "utm_source": "sendgrid.com",
+  "utm_term": ""
+}')
+response = sg.client.tracking_settings.google_analytics.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve Google Analytics Settings #
+# GET /tracking_settings/google_analytics #
+
+response = sg.client.tracking_settings.google_analytics.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update Open Tracking Settings #
+# PATCH /tracking_settings/open #
+
+data = JSON.parse('{
+  "enabled": true
+}')
+response = sg.client.tracking_settings.open.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Get Open Tracking Settings #
+# GET /tracking_settings/open #
+
+response = sg.client.tracking_settings.open.get
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Update Subscription Tracking Settings #
+# PATCH /tracking_settings/subscription #
+
+data = JSON.parse('{
+  "enabled": true,
+  "html_content": "html content",
+  "landing": "landing page html",
+  "plain_content": "text content",
+  "replace": "replacement tag",
+  "url": "url"
+}')
+response = sg.client.tracking_settings.subscription.patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+
+##################################################
+# Retrieve Subscription Tracking Settings #
+# GET /tracking_settings/subscription #
+
+response = sg.client.tracking_settings.subscription.get
+puts response.status_code
+puts response.body
+puts response.headers