sendgrid-ruby 6.3.2 → 6.3.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (120) hide show
  1. checksums.yaml +4 -4
  2. data/.codeclimate.yml +1 -1
  3. data/.rubocop.yml +8 -0
  4. data/.rubocop_todo.yml +109 -0
  5. data/.travis.yml +2 -3
  6. data/CHANGELOG.md +61 -9
  7. data/CONTRIBUTING.md +10 -20
  8. data/FIRST_TIMERS.md +79 -0
  9. data/ISSUE_TEMPLATE.md +5 -1
  10. data/{LICENSE.md → LICENSE} +0 -0
  11. data/Makefile +3 -2
  12. data/PULL_REQUEST_TEMPLATE.md +5 -5
  13. data/README.md +24 -29
  14. data/Rakefile +2 -3
  15. data/TROUBLESHOOTING.md +5 -5
  16. data/USAGE.md +146 -39
  17. data/examples/accesssettings/accesssettings.rb +9 -12
  18. data/examples/alerts/alerts.rb +8 -11
  19. data/examples/apikeys/apikeys.rb +12 -15
  20. data/examples/asm/asm.rb +27 -30
  21. data/examples/browsers/browsers.rb +0 -3
  22. data/examples/campaigns/campaigns.rb +29 -32
  23. data/examples/categories/categories.rb +0 -3
  24. data/examples/clients/clients.rb +1 -4
  25. data/examples/contactdb/contactdb.rb +63 -66
  26. data/examples/devices/devices.rb +0 -3
  27. data/examples/emailactivity/emailactivity.rb +52 -0
  28. data/examples/geo/geo.rb +0 -3
  29. data/examples/helpers/eventwebhook/example.rb +4 -4
  30. data/examples/helpers/mail/example.rb +19 -13
  31. data/examples/helpers/settings/example.rb +1 -1
  32. data/examples/helpers/stats/example.rb +4 -4
  33. data/examples/ips/ips.rb +19 -22
  34. data/examples/mail/mail.rb +72 -75
  35. data/examples/mailboxproviders/mailboxproviders.rb +0 -3
  36. data/examples/mailsettings/mailsettings.rb +21 -24
  37. data/examples/partnersettings/partnersettings.rb +3 -6
  38. data/examples/scopes/scopes.rb +8 -10
  39. data/examples/senderauthentication/senderauthentication.rb +41 -44
  40. data/examples/senders/senders.rb +28 -31
  41. data/examples/stats/stats.rb +0 -3
  42. data/examples/subusers/subusers.rb +17 -20
  43. data/examples/suppression/suppression.rb +15 -18
  44. data/examples/templates/templates.rb +29 -31
  45. data/examples/trackingsettings/trackingsettings.rb +14 -17
  46. data/examples/user/user.rb +41 -44
  47. data/lib/rack/sendgrid_webhook_verification.rb +5 -2
  48. data/lib/sendgrid/base_interface.rb +2 -1
  49. data/lib/sendgrid/helpers/eventwebhook/eventwebhook.rb +4 -6
  50. data/lib/sendgrid/helpers/inbound/README.md +5 -5
  51. data/lib/sendgrid/helpers/inbound/app.rb +2 -2
  52. data/lib/sendgrid/helpers/inbound/public/index.html +1 -1
  53. data/lib/sendgrid/helpers/inbound/send.rb +3 -3
  54. data/lib/sendgrid/helpers/ip_management/ip_management.rb +1 -1
  55. data/lib/sendgrid/helpers/mail/README.md +3 -3
  56. data/lib/sendgrid/helpers/mail/asm.rb +6 -18
  57. data/lib/sendgrid/helpers/mail/attachment.rb +12 -42
  58. data/lib/sendgrid/helpers/mail/bcc_settings.rb +6 -18
  59. data/lib/sendgrid/helpers/mail/bypass_list_management.rb +8 -18
  60. data/lib/sendgrid/helpers/mail/category.rb +2 -2
  61. data/lib/sendgrid/helpers/mail/click_tracking.rb +6 -18
  62. data/lib/sendgrid/helpers/mail/content.rb +4 -3
  63. data/lib/sendgrid/helpers/mail/custom_arg.rb +6 -10
  64. data/lib/sendgrid/helpers/mail/email.rb +5 -4
  65. data/lib/sendgrid/helpers/mail/footer.rb +7 -27
  66. data/lib/sendgrid/helpers/mail/ganalytics.rb +10 -54
  67. data/lib/sendgrid/helpers/mail/header.rb +6 -10
  68. data/lib/sendgrid/helpers/mail/mail.rb +30 -48
  69. data/lib/sendgrid/helpers/mail/mail_settings.rb +9 -25
  70. data/lib/sendgrid/helpers/mail/open_tracking.rb +6 -18
  71. data/lib/sendgrid/helpers/mail/personalization.rb +34 -27
  72. data/lib/sendgrid/helpers/mail/section.rb +6 -10
  73. data/lib/sendgrid/helpers/mail/spam_check.rb +7 -27
  74. data/lib/sendgrid/helpers/mail/subscription_tracking.rb +8 -36
  75. data/lib/sendgrid/helpers/mail/substitution.rb +6 -10
  76. data/lib/sendgrid/helpers/mail/tracking_settings.rb +8 -20
  77. data/lib/sendgrid/helpers/permissions/scope.rb +2 -2
  78. data/lib/sendgrid/helpers/settings/README.md +2 -2
  79. data/lib/sendgrid/helpers/settings/settings.rb +1 -1
  80. data/lib/sendgrid/helpers/settings/tracking_settings_dto.rb +3 -5
  81. data/lib/sendgrid/helpers/stats/metrics.rb +5 -5
  82. data/lib/sendgrid/sendgrid.rb +1 -1
  83. data/lib/sendgrid/twilio_email.rb +1 -1
  84. data/lib/sendgrid/version.rb +1 -1
  85. data/mail_helper_v3.md +12 -12
  86. data/sendgrid-ruby.gemspec +8 -9
  87. data/spec/fixtures/event_webhook.rb +17 -11
  88. data/spec/rack/sendgrid_webhook_verification_spec.rb +30 -4
  89. data/spec/sendgrid/helpers/eventwebhook/eventwebhook_spec.rb +38 -36
  90. data/spec/sendgrid/helpers/settings/mail_settings_dto_spec.rb +1 -1
  91. data/spec/sendgrid/helpers/settings/partner_settings_dto_spec.rb +1 -1
  92. data/spec/sendgrid/helpers/settings/settings_spec.rb +2 -2
  93. data/spec/sendgrid/helpers/settings/tracking_settings_dto_spec.rb +1 -1
  94. data/spec/sendgrid/helpers/settings/user_settings_dto_spec.rb +1 -1
  95. data/spec/sendgrid/helpers/stats/email_stats_spec.rb +22 -23
  96. data/spec/sendgrid/helpers/stats/metrics_spec.rb +19 -20
  97. data/spec/sendgrid/helpers/stats/stats_response_spec.rb +22 -23
  98. data/spec/spec_helper.rb +1 -1
  99. data/static/img/github-fork.png +0 -0
  100. data/static/img/github-sign-up.png +0 -0
  101. data/test/sendgrid/helpers/mail/test_attachment.rb +4 -6
  102. data/test/sendgrid/helpers/mail/test_category.rb +0 -2
  103. data/test/sendgrid/helpers/mail/test_email.rb +9 -11
  104. data/test/sendgrid/helpers/mail/test_mail.rb +101 -102
  105. data/test/sendgrid/helpers/mail/test_personalizations.rb +106 -93
  106. data/test/sendgrid/permissions/test_scopes.rb +1 -3
  107. data/test/sendgrid/test_sendgrid-ruby.rb +1947 -1959
  108. data/twilio_sendgrid_logo.png +0 -0
  109. data/use-cases/README.md +16 -0
  110. data/use-cases/domain-authentication.md +5 -0
  111. data/use-cases/email-statistics.md +52 -0
  112. data/use-cases/legacy-templates.md +98 -0
  113. data/use-cases/sms.md +39 -0
  114. data/use-cases/transactional-templates.md +111 -0
  115. data/use-cases/twilio-email.md +13 -0
  116. data/use-cases/twilio-setup.md +54 -0
  117. metadata +52 -41
  118. data/USE_CASES.md +0 -405
  119. data/docker/Dockerfile +0 -12
  120. data/docker/README.md +0 -30
@@ -1,5 +1,9 @@
1
1
  <!--
2
2
  If this is a feature request, make sure you search Issues for an existing request before creating a new one!
3
+
4
+ Please utilize the template below to help us resolve your issue.
5
+
6
+ Note that many issues can be resolved by updating to the latest version.
3
7
  -->
4
8
 
5
9
  ### Issue Summary
@@ -21,6 +25,6 @@ A summary of the issue and the environment in which it occurs. If suitable, incl
21
25
  ```
22
26
 
23
27
  ### Technical details:
24
- * sendgrid-ruby version:
28
+ * sendgrid-ruby version:
25
29
  * ruby version:
26
30
 
File without changes
data/Makefile CHANGED
@@ -4,11 +4,12 @@ install:
4
4
  gem install bundler:2.1.2; bundle install
5
5
 
6
6
  test:
7
- bundle exec rake spec
7
+ bundle exec rake
8
+ rubocop
8
9
 
9
10
  test-integ: test
10
11
 
11
12
  version ?= ruby:latest
12
13
  test-docker:
13
- curl -s https://raw.githubusercontent.com/sendgrid/sendgrid-oai/master/prism/prism.sh -o prism.sh
14
+ curl -s https://raw.githubusercontent.com/sendgrid/sendgrid-oai/HEAD/prism/prism.sh -o prism.sh
14
15
  version=$(version) bash ./prism.sh
@@ -19,13 +19,13 @@ Closes #2
19
19
  A short description of what this PR does.
20
20
 
21
21
  ### Checklist
22
- - [ ] I acknowledge that all my contributions will be made under the project's license
22
+ - [x] I acknowledge that all my contributions will be made under the project's license
23
23
  - [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
24
- - [ ] I have read the [Contribution Guidelines](CONTRIBUTING.md) and my PR follows them
24
+ - [ ] I have read the [Contribution Guidelines](https://github.com/sendgrid/sendgrid-ruby/blob/main/CONTRIBUTING.md) and my PR follows them
25
25
  - [ ] I have titled the PR appropriately
26
- - [ ] I have updated my branch with the master branch
26
+ - [ ] I have updated my branch with the main branch
27
27
  - [ ] I have added tests that prove my fix is effective or that my feature works
28
- - [ ] I have added necessary documentation about the functionality in the appropriate .md file
28
+ - [ ] I have added the necessary documentation about the functionality in the appropriate .md file
29
29
  - [ ] I have added inline documentation to the code I modified
30
30
 
31
- If you have questions, please file a [support ticket](https://twilio.com/help/contact), or create a GitHub Issue in this repository.
31
+ If you have questions, please file a [support ticket](https://support.sendgrid.com), or create a GitHub Issue in this repository.
data/README.md CHANGED
@@ -1,20 +1,22 @@
1
- ![Twilio SendGrid Logo](https://github.com/sendgrid/sendgrid-python/raw/master/twilio_sendgrid_logo.png)
1
+ ![Twilio SendGrid Logo](twilio_sendgrid_logo.png)
2
2
 
3
- [![Travis Badge](https://travis-ci.org/sendgrid/sendgrid-ruby.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-ruby)
3
+ [![Travis Badge](https://travis-ci.com/sendgrid/sendgrid-ruby.svg?branch=main)](https://travis-ci.com/sendgrid/sendgrid-ruby)
4
4
  [![Gem Version](https://badge.fury.io/rb/sendgrid-ruby.svg)](https://badge.fury.io/rb/sendgrid-ruby)
5
5
  [![Email Notifications Badge](https://dx.sendgrid.com/badge/ruby)](https://dx.sendgrid.com/newsletter/ruby)
6
- [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md)
6
+ [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
7
7
  [![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid)
8
8
  [![GitHub contributors](https://img.shields.io/github/contributors/sendgrid/sendgrid-ruby.svg)](https://github.com/sendgrid/sendgrid-ruby/graphs/contributors)
9
9
  [![Open Source Helpers](https://www.codetriage.com/sendgrid/sendgrid-ruby/badges/users.svg)](https://www.codetriage.com/sendgrid/sendgrid-ruby)
10
10
 
11
11
  **NEW:** Subscribe to email [notifications](https://dx.sendgrid.com/newsletter/ruby) for releases and breaking changes.
12
12
 
13
+ **The default branch name for this repository has been changed to `main` as of 07/27/2020.**
14
+
13
15
  **This library allows you to quickly and easily use the Twilio SendGrid Web API v3 via Ruby.**
14
16
 
15
17
  Version 3.X.X+ of this library provides full support for all Twilio SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint).
16
18
 
17
- This library represents the beginning of a new path for Twilio SendGrid. We want this library to be community driven and Twilio SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-ruby/issues) and [pull requests](https://github.com/sendgrid/sendgrid-ruby/blob/master/CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
19
+ This library represents the beginning of a new path for Twilio SendGrid. We want this library to be community driven and Twilio SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-ruby/issues) and [pull requests](CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
18
20
 
19
21
  Please browse the rest of this README for further details.
20
22
 
@@ -29,7 +31,6 @@ We appreciate your continued support, thank you!
29
31
  * [Usage](#usage)
30
32
  * [Use Cases](#use_cases)
31
33
  * [Announcements](#announcements)
32
- * [Roadmap](#roadmap)
33
34
  * [How to Contribute](#contribute)
34
35
  * [Troubleshooting](#troubleshooting)
35
36
  * [About](#about)
@@ -40,7 +41,7 @@ We appreciate your continued support, thank you!
40
41
 
41
42
  ## Prerequisites
42
43
 
43
- - Ruby version >= 2.4 (except version [2.6.0](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md#ruby-versions))
44
+ - Ruby version >= 2.4 (except version [2.6.0](TROUBLESHOOTING.md#ruby-versions))
44
45
  - The Twilio SendGrid service, starting at the [free level](https://sendgrid.com/free?source=sendgrid-ruby)
45
46
 
46
47
  ## Setup Environment Variables
@@ -81,7 +82,7 @@ gem install sendgrid-ruby
81
82
 
82
83
  ## Hello Email
83
84
 
84
- The following is the minimum needed code to send an email with the [/mail/send Helper](https://github.com/sendgrid/sendgrid-ruby/tree/master/lib/sendgrid/helpers/mail) ([here](https://github.com/sendgrid/sendgrid-ruby/blob/master/examples/helpers/mail/example.rb#L21) is a full example):
85
+ The following is the minimum needed code to send an email with the [/mail/send Helper](lib/sendgrid/helpers/mail) ([here](examples/helpers/mail/example.rb#L21) is a full example):
85
86
 
86
87
  ### With Mail Helper Class
87
88
 
@@ -103,11 +104,11 @@ puts response.parsed_body
103
104
  puts response.headers
104
105
  ```
105
106
 
106
- For more complex scenarios, please do not use the above constructor and instead build your own personalization object as [demonstrated here](https://github.com/sendgrid/sendgrid-ruby/blob/master/examples/helpers/mail/example.rb#L21).
107
+ For more complex scenarios, please do not use the above constructor and instead build your own personalization object as [demonstrated here](examples/helpers/mail/example.rb#L21).
107
108
 
108
109
  ### Without Mail Helper Class
109
110
 
110
- The following is the minimum needed code to send an email without the /mail/send Helper ([here](https://github.com/sendgrid/sendgrid-ruby/blob/master/examples/mail/mail.rb#L26) is a full example):
111
+ The following is the minimum needed code to send an email without the /mail/send Helper ([here](examples/mail/mail.rb#L26) is a full example):
111
112
 
112
113
  ```ruby
113
114
  require 'sendgrid-ruby'
@@ -169,50 +170,44 @@ puts response.headers
169
170
  <a name="inbound"></a>
170
171
  # Processing Inbound Email
171
172
 
172
- Please see [our helper](https://github.com/sendgrid/sendgrid-ruby/tree/master/lib/sendgrid/helpers/inbound) for utilizing our Inbound Parse webhook.
173
+ Please see [our helper](lib/sendgrid/helpers/inbound) for utilizing our Inbound Parse webhook.
173
174
 
174
175
  <a name="usage"></a>
175
176
  # Usage
176
177
 
177
178
  - [Twilio SendGrid Docs](https://sendgrid.com/docs/API_Reference/index.html)
178
- - [Library Usage Docs](https://github.com/sendgrid/sendgrid-ruby/tree/master/USAGE.md)
179
- - [Example Code](https://github.com/sendgrid/sendgrid-ruby/tree/master/examples)
179
+ - [Library Usage Docs](USAGE.md)
180
+ - [Example Code](examples)
180
181
  - [How-to: Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html)
181
- - [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-ruby/tree/master/lib/sendgrid/helpers/mail) - build a request object payload for a v3 /mail/send API call.
182
- - [Settings Helper](https://github.com/sendgrid/sendgrid-ruby/tree/master/lib/sendgrid/helpers/settings)
182
+ - [v3 Web API Mail Send Helper](lib/sendgrid/helpers/mail) - build a request object payload for a v3 /mail/send API call.
183
+ - [Settings Helper](lib/sendgrid/helpers/settings)
183
184
 
184
185
  <a name="use_cases"></a>
185
186
  # Use Cases
186
187
 
187
- [Examples of common API use cases](https://github.com/sendgrid/sendgrid-ruby/blob/master/USE_CASES.md), such as how to send an email with a transactional template.
188
+ [Examples of common API use cases](use-cases), such as how to send an email with a transactional template.
188
189
 
189
190
  <a name="announcements"></a>
190
191
  # Announcements
191
192
 
192
193
  Please see our announcement regarding [breaking changes](https://github.com/sendgrid/sendgrid-ruby/issues/94). Your support is appreciated!
193
194
 
194
- All updates to this library are documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-ruby/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-ruby/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/ruby) for releases and breaking changes.
195
-
196
- <a name="roadmap"></a>
197
- # Roadmap
198
-
199
- If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/sendgrid/sendgrid-ruby/issues) and [pull requests](https://github.com/sendgrid/sendgrid-ruby/pulls). We would love to hear your feedback.
195
+ All updates to this library are documented in our [CHANGELOG](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-ruby/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/ruby) for releases and breaking changes.
200
196
 
201
197
  <a name="contribute"></a>
202
198
  # How to Contribute
203
199
 
204
- We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-ruby/tree/master/CONTRIBUTING.md) guide for details.
200
+ We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details.
205
201
 
206
- - [Feature Request](https://github.com/sendgrid/sendgrid-ruby/tree/master/CONTRIBUTING.md#feature_request)
207
- - [Bug Reports](https://github.com/sendgrid/sendgrid-ruby/tree/master/CONTRIBUTING.md#submit_a_bug_report)
208
- - [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/sendgrid-ruby/tree/master/CONTRIBUTING.md#cla)
209
- - [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-ruby/tree/master/CONTRIBUTING.md#improvements_to_the_codebase)
210
- - [Review Pull Requests](https://github.com/sendgrid/sendgrid-ruby/blob/master/CONTRIBUTING.md#code-reviews)
202
+ - [Feature Request](CONTRIBUTING.md#feature_request)
203
+ - [Bug Reports](CONTRIBUTING.md#submit_a_bug_report)
204
+ - [Improvements to the Codebase](CONTRIBUTING.md#improvements_to_the_codebase)
205
+ - [Review Pull Requests](CONTRIBUTING.md#code-reviews)
211
206
 
212
207
  <a name="troubleshooting"></a>
213
208
  # Troubleshooting
214
209
 
215
- Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md) for common library issues.
210
+ Please see our [troubleshooting guide](TROUBLESHOOTING.md) for common library issues.
216
211
 
217
212
  <a name="about"></a>
218
213
  # About
@@ -225,4 +220,4 @@ If you've instead found a bug in the library or would like new features added, g
225
220
 
226
221
  <a name="license"></a>
227
222
  # License
228
- [The MIT License (MIT)](LICENSE.md)
223
+ [The MIT License (MIT)](LICENSE)
data/Rakefile CHANGED
@@ -10,6 +10,5 @@ end
10
10
 
11
11
  RSpec::Core::RakeTask.new(:spec)
12
12
 
13
- desc "Run tests"
14
- task default: [:spec, :test]
15
-
13
+ desc 'Run tests'
14
+ task default: %i[spec test]
@@ -28,7 +28,7 @@ Please review [our guide](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/
28
28
 
29
29
  [Here](https://github.com/sendgrid/sendgrid-ruby/tree/0fbf579c0f7ed1dff87adc4957c4dc5a6b257068) is the last working version with v2 support.
30
30
 
31
- Using rubygems:
31
+ Using RubyGems:
32
32
 
33
33
  Add this line to your application's Gemfile:
34
34
 
@@ -73,7 +73,7 @@ end
73
73
  <a name="versioning"></a>
74
74
  ## Versioning
75
75
 
76
- We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release, since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](https://github.com/sendgrid/sendgrid-ruby/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-ruby/releases) section.
76
+ We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with your code and never auto-update to the latest version. Especially when there is a MAJOR point release since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-ruby/releases) section.
77
77
 
78
78
  <a name="environment"></a>
79
79
  ## Environment Variables and Your Twilio SendGrid API Key
@@ -88,7 +88,7 @@ becomes
88
88
 
89
89
  `sg = SendGrid::API.new(api_key: 'SENDGRID_API_KEY')`
90
90
 
91
- In the first case SENDGRID_API_KEY is in reference to the name of the environment variable, while the second case references the actual Twilio SendGrid API Key.
91
+ In the first case, SENDGRID_API_KEY is in reference to the name of the environment variable, while the second case references the actual Twilio SendGrid API Key.
92
92
 
93
93
  <a name="package-manager"></a>
94
94
  ## Using the Package Manager
@@ -118,9 +118,9 @@ gem install sendgrid-ruby -v X.X.X
118
118
  <a name="rails-specifics"></a>
119
119
  ## Rails Specifics
120
120
 
121
- - Namespace collision between Rails own `Mail` class and sendgrid class `Mail`. To avoid that issues please use `SendGrid::Mail` instead.
121
+ - Namespace collision between Rails own `Mail` class and sendgrid class `Mail`. To avoid that issues please use `SendGrid:: Mail` instead.
122
122
 
123
- - Possibility of a namespace collision between the sendgrid class `Email` and your own defined `Email` class. To avoid these issues, you can skip the `include SendGrid` line and use the `SendGrid::` prefix for Email. Please see this [SO answer](https://stackoverflow.com/questions/41508464/rails-model-name-conflict-with-included-gem?noredirect=1#comment70223099_41508464) for specifics.
123
+ - The possibility of a namespace collision between the sendgrid class `Email` and your own defined `Email` class. To avoid these issues, you can skip the `include SendGrid` line and use the `SendGrid::` prefix for Email. Please see this [SO answer](https://stackoverflow.com/questions/41508464/rails-model-name-conflict-with-included-gem?noredirect=1#comment70223099_41508464) for specifics.
124
124
 
125
125
  <a name="ruby-versions"></a>
126
126
  ## Ruby Versions
data/USAGE.md CHANGED
@@ -21,6 +21,7 @@ sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
21
21
  * [CLIENTS](#clients)
22
22
  * [CONTACTDB](#contactdb)
23
23
  * [DEVICES](#devices)
24
+ * [EMAIL ACTIVITY](#email-activity)
24
25
  * [GEO](#geo)
25
26
  * [IPS](#ips)
26
27
  * [MAIL](#mail)
@@ -290,7 +291,7 @@ puts response.headers
290
291
 
291
292
  **This endpoint allows you to create a new random API Key for the user.**
292
293
 
293
- A JSON request body containing a "name" property is required. If number of maximum keys is reached, HTTP 403 will be returned.
294
+ A JSON request body containing a "name" property is required. If the number of maximum keys is reached, HTTP 403 will be returned.
294
295
 
295
296
  There is a limit of 100 API Keys on your account.
296
297
 
@@ -406,7 +407,7 @@ puts response.headers
406
407
 
407
408
  **This endpoint allows you to revoke an existing API Key**
408
409
 
409
- Authentications using this API Key will fail after this request is made, with some small propagation delay.If the API Key ID does not exist an HTTP 404 will be returned.
410
+ Authentications using this API Key will fail after this request is made, with some small propagation delay. If the API Key ID does not exist an HTTP 404 will be returned.
410
411
 
411
412
  The API Keys feature allows customers to be able to generate an API Key credential which can be used for authentication with the Twilio SendGrid v3 Web API or the [Mail API Endpoint](https://sendgrid.com/docs/API_Reference/Web_API/mail.html).
412
413
 
@@ -967,7 +968,7 @@ puts response.headers
967
968
 
968
969
  **This endpoint allows you to send a test campaign.**
969
970
 
970
- To send to multiple addresses, use an array for the JSON "to" value ["one@address","two@address"]
971
+ To send to multiple addresses, use an array for the JSON "to" value ["one@address", "two@address"]
971
972
 
972
973
  For more information:
973
974
 
@@ -1417,7 +1418,7 @@ puts response.headers
1417
1418
  ```
1418
1419
  ## Delete Recipient
1419
1420
 
1420
- **This endpoint allows you to deletes one or more recipients.**
1421
+ **This endpoint allows you to delete one or more recipients.**
1421
1422
 
1422
1423
  The body of an API call to this endpoint must include an array of recipient IDs of the recipients you want to delete.
1423
1424
 
@@ -1529,7 +1530,7 @@ puts response.headers
1529
1530
 
1530
1531
  **This endpoint allows you to retrieve the lists that a given recipient belongs to.**
1531
1532
 
1532
- Each recipient can be on many lists. This endpoint gives you all of the lists that any one recipient has been added to.
1533
+ Each recipient can be on many lists. This endpoint gives you all of the lists that anyone recipient has been added to.
1533
1534
 
1534
1535
  The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.
1535
1536
 
@@ -1686,7 +1687,7 @@ puts response.headers
1686
1687
  ```
1687
1688
  ## Delete a segment
1688
1689
 
1689
- **This endpoint allows you to delete a segment from your recipients database.**
1690
+ **This endpoint allows you to delete a segment from your recipient's database.**
1690
1691
 
1691
1692
  You also have the option to delete all the contacts from your Marketing Campaigns recipient database who were in this segment.
1692
1693
 
@@ -1736,10 +1737,10 @@ puts response.headers
1736
1737
  ## Available Device Types
1737
1738
  | **Device** | **Description** | **Example** |
1738
1739
  |---|---|---|
1739
- | Desktop | Email software on desktop computer. | I.E., Outlook, Sparrow, or Apple Mail. |
1740
- | Webmail | A web-based email client. | I.E., Yahoo, Google, AOL, or Outlook.com. |
1741
- | Phone | A smart phone. | iPhone, Android, Blackberry, etc.
1742
- | Tablet | A tablet computer. | iPad, android based tablet, etc. |
1740
+ | Desktop | Email software on a desktop computer. | I.E., Outlook, Sparrow, or Apple Mail. |
1741
+ | Webmail | A web-based email client. | I.E., Yahoo, Google, AOL, or Outlook.com. |
1742
+ | Phone | A smartphone. | iPhone, Android, Blackberry, etc.
1743
+ | Tablet | A tablet computer. | iPad, Android-based tablet, etc. |
1743
1744
  | Other | An unrecognized device. |
1744
1745
 
1745
1746
  Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/index.html).
@@ -1754,6 +1755,112 @@ puts response.status_code
1754
1755
  puts response.body
1755
1756
  puts response.headers
1756
1757
  ```
1758
+
1759
+ <a name="email-activity"></a>
1760
+ # EMAIL ACTIVITY
1761
+
1762
+ ## Filter all messages
1763
+ > In order to gain access to the Email Activity Feed API, you must purchase [additional email activity history](https://app.sendgrid.com/settings/billing/addons/email_activity).
1764
+
1765
+ Filter all messages to search your Email Activity.
1766
+
1767
+ Queries may need to be [URL encoded](https://meyerweb.com/eric/tools/dencoder/). URL encoding depends on how you're using the API - if you are trying it out here, or using one of the Libraries, we handle the encoding for you. If you are using cURL, or your own implementation, you probably need to encode it.
1768
+
1769
+ Queries have this format:
1770
+
1771
+ `query={query_type}="{query_content}"`
1772
+
1773
+ encoded, this would look like this:
1774
+
1775
+ `query=type%3D%22query_content%22`
1776
+
1777
+ for example:
1778
+
1779
+ Filter by a specific email - `query=to_email%3D%22example%40example.com%22`
1780
+
1781
+ Filter by subject line - `query=subject%3d%22A%20Great%20Subject%22`
1782
+
1783
+ You can filter by other operators besides `=`. We also accept `!=`, `<`, and `>`.
1784
+
1785
+ For a tutorial on how to get started, check out [Getting Started with the Email Activity API](https://sendgrid.com/docs/API_Reference/Web_API_v3/Tutorials/getting_started_email_activity_api.html).
1786
+
1787
+ For information about building combined queries, see [Building compound Email Activity queries](https://sendgrid.com/docs/API_Reference/Web_API_v3/Tutorials/getting_started_email_activity_api.html#-Creating-compound-queries).
1788
+
1789
+ ### GET /messages
1790
+ ```ruby
1791
+ require 'erb'
1792
+
1793
+ filter_key = 'to_email'
1794
+ filter_operator = ERB::Util.url_encode('=')
1795
+ filter_value = 'testing@sendgrid.net'
1796
+ filter_value = ERB::Util.url_encode(format('"%s"', filter_value))
1797
+ query_params = {}
1798
+ query_params['query'] = format("%s%s%s", filter_key, filter_operator, filter_value)
1799
+ query_params['limit'] = '1'
1800
+
1801
+ params = query_params
1802
+ response = sg.client.messages.get(query_params: params)
1803
+ puts response.status_code
1804
+ puts response.body
1805
+ puts response.headers
1806
+ ```
1807
+
1808
+ ## Filter messages by message ID
1809
+
1810
+ > In order to gain access to the Email Activity Feed API, you must purchase [additional email activity history](https://app.sendgrid.com/settings/billing/addons/email_activity).
1811
+
1812
+ Get all of the details about the specified message.
1813
+
1814
+ ### GET /messages/{msg_id}
1815
+
1816
+ ```ruby
1817
+ msg_id = "test_url_param"
1818
+ response = sg.client.messages._(msg_id).get()
1819
+ puts response.status_code
1820
+ puts response.body
1821
+ puts response.headers
1822
+ ```
1823
+
1824
+
1825
+ ## Request a CSV
1826
+
1827
+ ### POST /messages/download
1828
+
1829
+ > In order to gain access to the Email Activity Feed API, you must purchase [additional email activity history](https://app.sendgrid.com/settings/billing/addons/email_activity).
1830
+
1831
+ This request kicks of a process to generate a CSV file. When the file is generated, the email that is listed as the account owner gets an email that links out to the file that is ready for download. The link expires in 3 days.
1832
+
1833
+ The CSV fill contain the last 1 million messages. This endpoint will be rate limited to 1 request every 12 hours.
1834
+
1835
+ ```ruby
1836
+ response = sg.client.messages.download.post()
1837
+ puts response.status_code
1838
+ puts response.body
1839
+ puts response.headers
1840
+ ```
1841
+
1842
+ ## Download CSV
1843
+
1844
+ ### GET /messages/download/{download_uuid}
1845
+
1846
+ > In order to gain access to the Email Activity Feed API, you must purchase [additional email activity history](https://app.sendgrid.com/settings/billing/addons/email_activity).
1847
+
1848
+ Download the CSV that you requested with the POST Request a CSV.
1849
+
1850
+ When the file is generated, the email that is listed as the account owner gets an email that links out to the file that is ready for download. The link expires in 3 days.
1851
+
1852
+ The CSV fill contain the last 1 million messages. This endpoint will be rate limited to 1 request every 12 hours.
1853
+
1854
+ ```ruby
1855
+ download_uuid = "test_url_param"
1856
+ response = sg.client.messages.download._(download_uuid).get
1857
+ puts response.status_code
1858
+ puts response.body
1859
+ puts response.headers
1860
+ ```
1861
+
1862
+
1863
+
1757
1864
  <a name="geo"></a>
1758
1865
  # GEO
1759
1866
 
@@ -1782,7 +1889,7 @@ puts response.headers
1782
1889
 
1783
1890
  **This endpoint allows you to retrieve a list of all assigned and unassigned IPs.**
1784
1891
 
1785
- Response includes warm up status, pools, assigned subusers, and authentica info. The start_date field corresponds to when warmup started for that IP.
1892
+ The response includes warm up status, pools, assigned sub users, and authentication info. The start_date field corresponds to when warmup started for that IP.
1786
1893
 
1787
1894
  A single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it.
1788
1895
 
@@ -2055,7 +2162,7 @@ puts response.headers
2055
2162
 
2056
2163
  **This endpoint allows you to generate a new batch ID. This batch ID can be associated with scheduled sends via the mail/send endpoint.**
2057
2164
 
2058
- If you set the SMTPAPI header `batch_id`, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at anytime up to 10 minutes before the schedule date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint.
2165
+ If you set the SMTPAPI header `batch_id`, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at any time up to 10 minutes before the scheduled date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint.
2059
2166
 
2060
2167
  More Information:
2061
2168
 
@@ -2074,7 +2181,7 @@ puts response.headers
2074
2181
 
2075
2182
  **This endpoint allows you to validate a batch ID.**
2076
2183
 
2077
- If you set the SMTPAPI header `batch_id`, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at anytime up to 10 minutes before the schedule date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint.
2184
+ If you set the SMTPAPI header `batch_id`, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at any time up to 10 minutes before the scheduled date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint.
2078
2185
 
2079
2186
  More Information:
2080
2187
 
@@ -2092,7 +2199,7 @@ puts response.headers
2092
2199
  ```
2093
2200
  ## v3 Mail Send
2094
2201
 
2095
- This endpoint allows you to send email over Twilio SendGrid's v3 Web API, the most recent version of our API. If you are looking for documentation about the v2 Mail Send endpoint, please see our [v2 API Reference](https://sendgrid.com/docs/API_Reference/Web_API/mail.html).
2202
+ This endpoint allows you to send an email over Twilio SendGrid's v3 Web API, the most recent version of our API. If you are looking for documentation about the v2 Mail Send endpoint, please see our [v2 API Reference](https://sendgrid.com/docs/API_Reference/Web_API/mail.html).
2096
2203
 
2097
2204
  * Top level parameters are referred to as "global".
2098
2205
  * Individual fields within the personalizations array will override any other global, or message level, parameters that are defined outside of personalizations.
@@ -2103,7 +2210,7 @@ For more detailed information about how to use the v3 Mail Send endpoint, please
2103
2210
 
2104
2211
  ### POST /mail/send
2105
2212
 
2106
- This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-ruby/blob/master/lib/sendgrid/helpers/mail/README.md).
2213
+ This endpoint has a helper, check it out [here](lib/sendgrid/helpers/mail/README.md).
2107
2214
 
2108
2215
  ```ruby
2109
2216
  data = JSON.parse('{
@@ -2313,7 +2420,7 @@ puts response.headers
2313
2420
 
2314
2421
  **This endpoint allows you to update your current BCC mail settings.**
2315
2422
 
2316
- When the BCC mail setting is enabled, Twilio SendGrid will automatically send a blind carbon copy (BCC) to an address for every email sent without adding that address to the header. Please note that only one email address may be entered in this field, if you wish to distribute BCCs to multiple addresses you will need to create a distribution group or use forwarding rules.
2423
+ When the BCC mail setting is enabled, Twilio SendGrid will automatically send a blind carbon copy (BCC) to an address for every email sent without adding that address to the header. Please note that only one email address may be entered in this field if you wish to distribute BCCs to multiple addresses you will need to create a distribution group or use forwarding rules.
2317
2424
 
2318
2425
  Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).
2319
2426
 
@@ -2334,7 +2441,7 @@ puts response.headers
2334
2441
 
2335
2442
  **This endpoint allows you to retrieve your current BCC mail settings.**
2336
2443
 
2337
- When the BCC mail setting is enabled, Twilio SendGrid will automatically send a blind carbon copy (BCC) to an address for every email sent without adding that address to the header. Please note that only one email address may be entered in this field, if you wish to distribute BCCs to multiple addresses you will need to create a distribution group or use forwarding rules.
2444
+ When the BCC mail setting is enabled, Twilio SendGrid will automatically send a blind carbon copy (BCC) to an address for every email sent without adding that address to the header. Please note that only one email address may be entered in this field if you wish to distribute BCCs to multiple addresses you will need to create a distribution group or use forwarding rules.
2338
2445
 
2339
2446
  Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html).
2340
2447
 
@@ -2725,7 +2832,7 @@ puts response.headers
2725
2832
 
2726
2833
  *You may create up to 100 unique sender identities.*
2727
2834
 
2728
- Sender Identities are required to be verified before use. If your domain has been authenticated, it will auto verify on creation. Otherwise an email will be sent to the `from.email`.
2835
+ Sender Identities are required to be verified before use. If your domain has been authenticated, it will auto verify on creation. Otherwise, an email will be sent to the `from.email`.
2729
2836
 
2730
2837
  ### POST /senders
2731
2838
 
@@ -2757,7 +2864,7 @@ puts response.headers
2757
2864
 
2758
2865
  **This endpoint allows you to retrieve a list of all sender identities that have been created for your account.**
2759
2866
 
2760
- Sender Identities are required to be verified before use. If your domain has been authenticated, it will auto verify on creation. Otherwise an email will be sent to the `from.email`.
2867
+ Sender Identities are required to be verified before use. If your domain has been authenticated, it will auto verify on creation. Otherwise, an email will be sent to the `from.email`.
2761
2868
 
2762
2869
  ### GET /senders
2763
2870
 
@@ -2772,7 +2879,7 @@ puts response.headers
2772
2879
 
2773
2880
  **This endpoint allows you to update a sender identity.**
2774
2881
 
2775
- Updates to `from.email` require re-verification. If your domain has been authenticated, it will auto verify on creation. Otherwise an email will be sent to the `from.email`.
2882
+ Updates to `from.email` require re-verification. If your domain has been authenticated, it will auto verify on creation. Otherwise, an email will be sent to the `from.email`.
2776
2883
 
2777
2884
  Partial updates are allowed, but fields that are marked as "required" in the POST (create) endpoint must not be nil if that field is included in the PATCH request.
2778
2885
 
@@ -2807,7 +2914,7 @@ puts response.headers
2807
2914
 
2808
2915
  **This endpoint allows you to retrieve a specific sender identity.**
2809
2916
 
2810
- Sender Identities are required to be verified before use. If your domain has been authenticated, it will auto verify on creation. Otherwise an email will be sent to the `from.email`.
2917
+ Sender Identities are required to be verified before use. If your domain has been authenticated, it will auto verify on creation. Otherwise, an email will be sent to the `from.email`.
2811
2918
 
2812
2919
  ### GET /senders/{sender_id}
2813
2920
 
@@ -2823,7 +2930,7 @@ puts response.headers
2823
2930
 
2824
2931
  **This endpoint allows you to delete one of your sender identities.**
2825
2932
 
2826
- Sender Identities are required to be verified before use. If your domain has been authenticated, it will auto verify on creation. Otherwise an email will be sent to the `from.email`.
2933
+ Sender Identities are required to be verified before use. If your domain has been authenticated, it will auto verify on creation. Otherwise, an email will be sent to the `from.email`.
2827
2934
 
2828
2935
  ### DELETE /senders/{sender_id}
2829
2936
 
@@ -2839,7 +2946,7 @@ puts response.headers
2839
2946
 
2840
2947
  **This endpoint allows you to resend a sender identity verification email.**
2841
2948
 
2842
- Sender Identities are required to be verified before use. If your domain has been authenticated, it will auto verify on creation. Otherwise an email will be sent to the `from.email`.
2949
+ Sender Identities are required to be verified before use. If your domain has been authenticated, it will auto verify on creation. Otherwise, an email will be sent to the `from.email`.
2843
2950
 
2844
2951
  ### POST /senders/{sender_id}/resend_verification
2845
2952
 
@@ -3090,7 +3197,7 @@ puts response.status_code
3090
3197
  puts response.body
3091
3198
  puts response.headers
3092
3199
  ```
3093
- ## Remove an IP from a domain authenticaiton.
3200
+ ## Remove an IP from a domain authentication.
3094
3201
 
3095
3202
  **This endpoint allows you to remove a domain's IP address from that domain's authentication.**
3096
3203
 
@@ -3517,7 +3624,7 @@ puts response.headers
3517
3624
  ```
3518
3625
  ## Retrieve Subuser Reputations
3519
3626
 
3520
- Subuser sender reputations give a good idea how well a sender is doing with regards to how recipients and recipient servers react to the mail that is being received. When a bounce, spam report, or other negative action happens on a sent email, it will effect your sender rating.
3627
+ Subuser sender reputations give a good idea how well a sender is doing with regards to how recipients and recipient servers react to the mail that is being received. When a bounce, spam report, or other negative action happens on a sent email, it will affect your sender rating.
3521
3628
 
3522
3629
  This endpoint allows you to request the reputations for your subusers.
3523
3630
 
@@ -3531,6 +3638,7 @@ puts response.status_code
3531
3638
  puts response.body
3532
3639
  puts response.headers
3533
3640
  ```
3641
+
3534
3642
  ## Retrieve email statistics for your subusers.
3535
3643
 
3536
3644
  **This endpoint allows you to retrieve the email statistics for the given subusers.**
@@ -3594,7 +3702,6 @@ puts response.headers
3594
3702
  ## Enable/disable a subuser
3595
3703
 
3596
3704
  This endpoint allows you to enable or disable a subuser.
3597
-
3598
3705
  For more information about Subusers:
3599
3706
 
3600
3707
  * [User Guide > Subusers](https://sendgrid.com/docs/User_Guide/Settings/Subusers/index.html)
@@ -3903,7 +4010,7 @@ puts response.headers
3903
4010
 
3904
4011
  **This endpoint allows you to remove an email address from your bounce list.**
3905
4012
 
3906
- Bounces are messages that are returned to the server that sent it. This endpoint allows you to delete a single email addresses from your bounce list.
4013
+ Bounces are messages that are returned to the server that sent it. This endpoint allows you to delete a single email address from your bounce list.
3907
4014
 
3908
4015
  For more information see:
3909
4016
 
@@ -3926,7 +4033,7 @@ puts response.headers
3926
4033
 
3927
4034
  **This endpoint allows you to retrieve a list of all invalid email addresses.**
3928
4035
 
3929
- An invalid email occurs when you attempt to send email to an address that is formatted in a manner that does not meet internet email format standards or the email does not exist at the recipients mail server.
4036
+ An invalid email occurs when you attempt to send email to an address that is formatted in a manner that does not meet internet email format standards or the email does not exist at the recipient's mail server.
3930
4037
 
3931
4038
  Examples include addresses without the @ sign or addresses that include certain special characters and/or spaces. This response can come from our own server or the recipient mail server.
3932
4039
 
@@ -3951,7 +4058,7 @@ There are two options for deleting invalid email addresses:
3951
4058
  1) You can delete all invalid email addresses by setting `delete_all` to true in the request body.
3952
4059
  2) You can delete some invalid email addresses by specifying certain addresses in an array in the request body.
3953
4060
 
3954
- An invalid email occurs when you attempt to send email to an address that is formatted in a manner that does not meet internet email format standards or the email does not exist at the recipients mail server.
4061
+ An invalid email occurs when you attempt to send email to an address that is formatted in a manner that does not meet internet email format standards or the email does not exist at the recipient's mail server.
3955
4062
 
3956
4063
  Examples include addresses without the @ sign or addresses that include certain special characters and/or spaces. This response can come from our own server or the recipient mail server.
3957
4064
 
@@ -3975,9 +4082,9 @@ puts response.headers
3975
4082
  ```
3976
4083
  ## Retrieve a specific invalid email
3977
4084
 
3978
- **This endpoint allows you to retrieve a specific invalid email addresses.**
4085
+ **This endpoint allows you to retrieve a specific invalid email address.**
3979
4086
 
3980
- An invalid email occurs when you attempt to send email to an address that is formatted in a manner that does not meet internet email format standards or the email does not exist at the recipients mail server.
4087
+ An invalid email occurs when you attempt to send email to an address that is formatted in a manner that does not meet internet email format standards or the email does not exist at the recipient's mail server.
3981
4088
 
3982
4089
  Examples include addresses without the @ sign or addresses that include certain special characters and/or spaces. This response can come from our own server or the recipient mail server.
3983
4090
 
@@ -3997,7 +4104,7 @@ puts response.headers
3997
4104
 
3998
4105
  **This endpoint allows you to remove a specific email address from the invalid email address list.**
3999
4106
 
4000
- An invalid email occurs when you attempt to send email to an address that is formatted in a manner that does not meet internet email format standards or the email does not exist at the recipients mail server.
4107
+ An invalid email occurs when you attempt to send email to an address that is formatted in a manner that does not meet internet email format standards or the email does not exist at the recipient's mail server.
4001
4108
 
4002
4109
  Examples include addresses without the @ sign or addresses that include certain special characters and/or spaces. This response can come from our own server or the recipient mail server.
4003
4110
 
@@ -4145,9 +4252,9 @@ Transactional templates are templates created specifically for transactional ema
4145
4252
 
4146
4253
  ### GET /templates
4147
4254
 
4148
-
4149
4255
  ```ruby
4150
- response = sg.client.templates.get()
4256
+ params = JSON.parse('{"generations": "legacy,dynamic"}')
4257
+ response = sg.client.templates.get(query_params: params)
4151
4258
  puts response.status_code
4152
4259
  puts response.body
4153
4260
  puts response.headers
@@ -4695,7 +4802,7 @@ puts response.headers
4695
4802
  If the maximum number of cancellations/pauses are added, HTTP 400 will
4696
4803
  be returned.
4697
4804
 
4698
- The Cancel Scheduled Sends feature allows the customer to cancel a scheduled send based on a Batch ID included in the SMTPAPI header.Scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled.
4805
+ The Cancel Scheduled Sends feature allows the customer to cancel a scheduled send based on a Batch ID included in the SMTPAPI header. Scheduled sends canceled less than 10 minutes before the scheduled time are not guaranteed to be canceled.
4699
4806
 
4700
4807
  ### POST /user/scheduled_sends
4701
4808
 
@@ -4714,7 +4821,7 @@ puts response.headers
4714
4821
 
4715
4822
  **This endpoint allows you to retrieve all cancel/paused scheduled send information.**
4716
4823
 
4717
- The Cancel Scheduled Sends feature allows the customer to cancel a scheduled send based on a Batch ID included in the SMTPAPI header.Scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled.
4824
+ The Cancel Scheduled Sends feature allows the customer to cancel a scheduled send based on a Batch ID included in the SMTPAPI header. Scheduled sends canceled less than 10 minutes before the scheduled time are not guaranteed to be canceled.
4718
4825
 
4719
4826
  ### GET /user/scheduled_sends
4720
4827
 
@@ -4729,7 +4836,7 @@ puts response.headers
4729
4836
 
4730
4837
  **This endpoint allows you to update the status of a scheduled send for the given `batch_id`.**
4731
4838
 
4732
- The Cancel Scheduled Sends feature allows the customer to cancel a scheduled send based on a Batch ID included in the SMTPAPI header.Scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled.
4839
+ The Cancel Scheduled Sends feature allows the customer to cancel a scheduled send based on a Batch ID included in the SMTPAPI header. Scheduled sends canceled less than 10 minutes before the scheduled time are not guaranteed to be canceled.
4733
4840
 
4734
4841
  ### PATCH /user/scheduled_sends/{batch_id}
4735
4842
 
@@ -4748,7 +4855,7 @@ puts response.headers
4748
4855
 
4749
4856
  **This endpoint allows you to retrieve the cancel/paused scheduled send information for a specific `batch_id`.**
4750
4857
 
4751
- The Cancel Scheduled Sends feature allows the customer to cancel a scheduled send based on a Batch ID included in the SMTPAPI header.Scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled.
4858
+ The Cancel Scheduled Sends feature allows the customer to cancel a scheduled send based on a Batch ID included in the SMTPAPI header. Scheduled sends canceled less than 10 minutes before the scheduled time are not guaranteed to be canceled.
4752
4859
 
4753
4860
  ### GET /user/scheduled_sends/{batch_id}
4754
4861
 
@@ -4764,7 +4871,7 @@ puts response.headers
4764
4871
 
4765
4872
  **This endpoint allows you to delete the cancellation/pause of a scheduled send.**
4766
4873
 
4767
- The Cancel Scheduled Sends feature allows the customer to cancel a scheduled send based on a Batch ID included in the SMTPAPI header.Scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled.
4874
+ The Cancel Scheduled Sends feature allows the customer to cancel a scheduled send based on a Batch ID included in the SMTPAPI header. Scheduled sends canceled less than 10 minutes before the scheduled time are not guaranteed to be canceled.
4768
4875
 
4769
4876
  ### DELETE /user/scheduled_sends/{batch_id}
4770
4877