sendgrid-ruby 3.0.4 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47ab0f76ba5ebb4ebd4f28a91784fee3a8d09735
-  data.tar.gz: 9deac819a5d81f7a751565907b47d192def9059d
+  metadata.gz: f9e089f11c9fcefbb345b5031cb7319a423c31c5
+  data.tar.gz: bbdce0d5b46c388c7e31c383531a2d026e800d3a
 SHA512:
-  metadata.gz: a01165aec370f954165d911a6611cfd5287beea63cad6fec47dc9d34f58e6a6cf3fefb98c2618ee9fe4c299ce528608a1817b6aa8921906f00ad630a5c42b80b
-  data.tar.gz: 2646d05bcaa3191dcd3d96db634edacefb37e9efd5fecf300ea2b563d0fab00cfd939cb5ce35f70ce518eb54237c5b7e612ad1dbf5f3b67058a2452b65f7a9e8
+  metadata.gz: 9120ecc8f69f5b16f05ebf7a6302594063f80c13be13b44bb8fd08e7563baed25fa050af579db1b0f8a06f3c836f1ca9c631e5b3b0da998448aae2756a5bae93
+  data.tar.gz: 607643666e9f63e9f0d46f9e50c348da837c330d01645db804fc6cdde24b93a8580d506f2e232f9df690da5d885de5c4f18685e6d40a8c4414002bf209037787

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [3.0.5] - 2016-07-05 ##
+### Added
+- Accept: application/json header per https://sendgrid.com/docs/API_Reference/Web_API_v3/How_To_Use_The_Web_API_v3/requests.html
+
+### Updated
+- Content based on our updated [Swagger/OAI doc](https://github.com/sendgrid/sendgrid-oai)
+
 ## [3.0.4] - 2016-06-15 ##
 ### Added
 - Updated dependency on ruby-http-client

data/README.md

@@ -7,9 +7,9 @@
 
 **BREAKING CHANGE as of 2016.06.14**
 
-Version `2.0.0` is a breaking change for the entire library.
+Version `3.X.X` is a breaking change for the entire library.
 
-Version 2.0.0 brings you full support for all Web API v3 endpoints. We
+Version 3.X.X brings you full support for all Web API v3 endpoints. We
 have the following resources to get you started quickly:
 
 -   [SendGrid
@@ -18,6 +18,7 @@ have the following resources to get you started quickly:
     Documentation](https://github.com/sendgrid/sendgrid-ruby/tree/master/USAGE.md)
 -   [Example
     Code](https://github.com/sendgrid/sendgrid-ruby/tree/master/examples)
+-   [Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html)
 
 Thank you for your continued support!
 
@@ -58,7 +59,7 @@ gem install sendgrid-ruby
 
 ## Dependencies
 
-- The SendGrid Service, starting at the [free level](https://sendgrid.com/free?source=sendgrid-ruby))
+- The SendGrid Service, starting at the [free level](https://sendgrid.com/free?source=sendgrid-ruby)
 - [Ruby-HTTP-Client](https://github.com/sendgrid/ruby-http-client)
 
 # Quick Start

data/USAGE.md

@@ -12,6 +12,7 @@ sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 # Table of Contents
 
 * [ACCESS SETTINGS](#access_settings)
+* [ALERTS](#alerts)
 * [API KEYS](#api_keys)
 * [ASM](#asm)
 * [BROWSERS](#browsers)
@@ -165,6 +166,115 @@ puts response.status_code
 puts response.body
 puts response.headers
 ```
+<a name="alerts"></a>
+# ALERTS
+
+## Create a new Alert
+
+**This endpoint allows you to create a new alert.**
+
+Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics.
+* Usage alerts allow you to set the threshold at which an alert will be sent.
+* Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, "daily", "weekly", or "monthly".
+
+For more information about alerts, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/alerts.html).
+
+### POST /alerts
+
+
+```ruby
+data = JSON.parse('{
+  "email_to": "example@example.com",
+  "frequency": "daily",
+  "type": "stats_notification"
+}')
+response = sg.client.alerts.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+```
+## Retrieve all alerts
+
+**This endpoint allows you to retieve all of your alerts.**
+
+Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics.
+* Usage alerts allow you to set the threshold at which an alert will be sent.
+* Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, "daily", "weekly", or "monthly".
+
+For more information about alerts, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/alerts.html).
+
+### GET /alerts
+
+
+```ruby
+response = sg.client.alerts.get()
+puts response.status_code
+puts response.body
+puts response.headers
+```
+## Update an alert
+
+**This endpoint allows you to update an alert.**
+
+Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics.
+* Usage alerts allow you to set the threshold at which an alert will be sent.
+* Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, "daily", "weekly", or "monthly".
+
+For more information about alerts, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/alerts.html).
+
+### PATCH /alerts/{alert_id}
+
+
+```ruby
+data = JSON.parse('{
+  "email_to": "example@example.com"
+}')
+alert_id = "test_url_param"
+response = sg.client.alerts._(alert_id).patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+```
+## Retrieve a specific alert
+
+**This endpoint allows you to retrieve a specific alert.**
+
+Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics.
+* Usage alerts allow you to set the threshold at which an alert will be sent.
+* Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, "daily", "weekly", or "monthly".
+
+For more information about alerts, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/alerts.html).
+
+### GET /alerts/{alert_id}
+
+
+```ruby
+alert_id = "test_url_param"
+response = sg.client.alerts._(alert_id).get()
+puts response.status_code
+puts response.body
+puts response.headers
+```
+## Delete an alert
+
+**This endpoint allows you to delete an alert.**
+
+Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics.
+* Usage alerts allow you to set the threshold at which an alert will be sent.
+* Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, "daily", "weekly", or "monthly".
+
+For more information about alerts, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/alerts.html).
+
+### DELETE /alerts/{alert_id}
+
+
+```ruby
+alert_id = "test_url_param"
+response = sg.client.alerts._(alert_id).delete()
+puts response.status_code
+puts response.body
+puts response.headers
+```
 <a name="api_keys"></a>
 # API KEYS
 
@@ -186,6 +296,7 @@ See the [API Key Permissions List](https://sendgrid.com/docs/API_Reference/Web_A
 ```ruby
 data = JSON.parse('{
   "name": "My API Key",
+  "sample": "data",
   "scopes": [
     "mail.send",
     "alerts.create",
@@ -207,7 +318,8 @@ The API Keys feature allows customers to be able to generate an API Key credenti
 
 
 ```ruby
-response = sg.client.api_keys.get()
+params = JSON.parse('{"limit": 1}')
+response = sg.client.api_keys.get(query_params: params)
 puts response.status_code
 puts response.body
 puts response.headers
@@ -339,6 +451,10 @@ puts response.headers
 
 This endpoint will return information for each group ID that you include in your request. To add a group ID to your request, simply append `&id=` followed by the group ID.
 
+Suppressions are a list of email addresses that will not receive content sent under a given [group](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html).
+
+Suppression groups, or [unsubscribe groups](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html), allow you to label a category of content that you regularly send. This gives your recipients the ability to opt out of a specific set of your email. For example, you might define a group for your transactional email, and one for your marketing email so that your users can continue recieving your transactional email witout having to receive your marketing content.
+
 ### GET /asm/groups
 
 
@@ -456,6 +572,31 @@ puts response.status_code
 puts response.body
 puts response.headers
 ```
+## Search for suppressions within a group
+
+**This endpoint allows you to search a suppression group for multiple suppressions.**
+
+When given a list of email addresses and a group ID, this endpoint will return only the email addresses that have been unsubscribed from the given group.
+
+Suppressions are a list of email addresses that will not receive content sent under a given [group](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html).
+
+### POST /asm/groups/{group_id}/suppressions/search
+
+
+```ruby
+data = JSON.parse('{
+  "recipient_emails": [
+    "exists1@example.com",
+    "exists2@example.com",
+    "doesnotexists@example.com"
+  ]
+}')
+group_id = "test_url_param"
+response = sg.client.asm.groups._(group_id).suppressions.search.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+```
 ## Delete a suppression from a suppression group
 
 **This endpoint allows you to remove a suppressed email address from the given suppression group.**
@@ -477,7 +618,7 @@ puts response.headers
 
 **This endpoint allows you to retrieve a list of all suppressions.**
 
-Suppressions are email addresses that can be added to [groups](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html) to prevent certain types of emails from being delivered to those addresses.
+Suppressions are a list of email addresses that will not receive content sent under a given [group](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html).
 
 ### GET /asm/suppressions
 
@@ -545,9 +686,9 @@ puts response.headers
 ```
 ## Retrieve all suppression groups for an email address
 
-**This endpoint will return a list of all suppression groups, indicating if the given email address is suppressed for each group.**
+**This endpoint returns the list of all groups that the given email address has been unsubscribed from.**
 
-Suppressions are email addresses that can be added to [groups](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html) to prevent certain types of emails from being delivered to those addresses.
+Suppressions are a list of email addresses that will not receive content sent under a given [group](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html).
 
 ### GET /asm/suppressions/{email}
 
@@ -640,7 +781,7 @@ For more information:
 
 
 ```ruby
-params = JSON.parse('{"limit": 0, "offset": 0}')
+params = JSON.parse('{"limit": 1, "offset": 1}')
 response = sg.client.campaigns.get(query_params: params)
 puts response.status_code
 puts response.body
@@ -1069,7 +1210,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
 data = JSON.parse('{
   "name": "newlistname"
 }')
-params = JSON.parse('{"list_id": 0}')
+params = JSON.parse('{"list_id": 1}')
 list_id = "test_url_param"
 response = sg.client.contactdb.lists._(list_id).patch(request_body: data, query_params: params)
 puts response.status_code
@@ -1086,7 +1227,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
 
 
 ```ruby
-params = JSON.parse('{"list_id": 0}')
+params = JSON.parse('{"list_id": 1}')
 list_id = "test_url_param"
 response = sg.client.contactdb.lists._(list_id).get(query_params: params)
 puts response.status_code
@@ -1142,7 +1283,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
 
 
 ```ruby
-params = JSON.parse('{"page": 1, "page_size": 1, "list_id": 0}')
+params = JSON.parse('{"page": 1, "page_size": 1, "list_id": 1}')
 list_id = "test_url_param"
 response = sg.client.contactdb.lists._(list_id).recipients.get(query_params: params)
 puts response.status_code
@@ -1176,7 +1317,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
 
 
 ```ruby
-params = JSON.parse('{"recipient_id": 0, "list_id": 0}')
+params = JSON.parse('{"recipient_id": 1, "list_id": 1}')
 list_id = "test_url_param"
 recipient_id = "test_url_param"
 response = sg.client.contactdb.lists._(list_id).recipients._(recipient_id).delete(query_params: params)
@@ -1328,7 +1469,7 @@ The contactdb is a database of your contacts for [SendGrid Marketing Campaigns](
 
 
 ```ruby
-params = JSON.parse('{"{field_name}": "test_string"}')
+params = JSON.parse('{"%7Bfield_name%7D": "test_string", "{field_name}": "test_string"}')
 response = sg.client.contactdb.recipients.search.get(query_params: params)
 puts response.status_code
 puts response.body
@@ -1518,7 +1659,7 @@ For more information about segments in Marketing Campaigns, please see our [User
 
 
 ```ruby
-params = JSON.parse('{"segment_id": 0}')
+params = JSON.parse('{"segment_id": 1}')
 segment_id = "test_url_param"
 response = sg.client.contactdb.segments._(segment_id).get(query_params: params)
 puts response.status_code
@@ -2036,13 +2177,8 @@ data = JSON.parse('{
       "send_at": 1409348513,
       "subject": "Hello, World!",
       "substitutions": {
-        "sub": {
-          "%name%": [
-            "John",
-            "Jane",
-            "Sam"
-          ]
-        }
+        "id": "substitutions",
+        "type": "object"
       },
       "to": [
         {
@@ -2624,7 +2760,7 @@ For more information about Subusers:
 
 
 ```ruby
-params = JSON.parse('{"username": "test_string", "limit": 0, "offset": 0}')
+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
@@ -2848,7 +2984,7 @@ For more information, see our [User Guide](https://sendgrid.com/docs/User_Guide/
 
 
 ```ruby
-params = JSON.parse('{"date": "test_string", "sort_by_direction": "asc", "limit": 0, "sort_by_metric": "test_string", "offset": 1}')
+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
@@ -2949,7 +3085,7 @@ For more information see:
 
 
 ```ruby
-params = JSON.parse('{"start_time": 0, "end_time": 0}')
+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
@@ -4015,11 +4151,32 @@ puts response.status_code
 puts response.body
 puts response.headers
 ```
-## Retrieve Parse Webhook settings
+## Create a parse setting
+
+**This endpoint allows you to create a new inbound parse setting.**
+
+The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the content, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
 
-**This endpoint allows you to retrieve your current inbound parse webhook settings.**
+### POST /user/webhooks/parse/settings
 
-SendGrid can parse the attachments and contents of incoming emails. The Parse API will POST the parsed email to a URL that you specify. For more information, see our Inbound [Parse Webhook documentation](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
+
+```ruby
+data = JSON.parse('{
+  "hostname": "myhostname.com",
+  "send_raw": false,
+  "spam_check": true,
+  "url": "http://email.myhosthame.com"
+}')
+response = sg.client.user.webhooks.parse.settings.post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+```
+## Retrieve all parse settings
+
+**This endpoint allows you to retrieve all of your current inbound parse settings.**
+
+The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
 
 ### GET /user/webhooks/parse/settings
 
@@ -4030,6 +4187,59 @@ puts response.status_code
 puts response.body
 puts response.headers
 ```
+## Update a parse setting
+
+**This endpoint allows you to update a specific inbound parse setting.**
+
+The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
+
+### PATCH /user/webhooks/parse/settings/{hostname}
+
+
+```ruby
+data = JSON.parse('{
+  "send_raw": true,
+  "spam_check": false,
+  "url": "http://newdomain.com/parse"
+}')
+hostname = "test_url_param"
+response = sg.client.user.webhooks.parse.settings._(hostname).patch(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+```
+## Retrieve a specific parse setting
+
+**This endpoint allows you to retrieve a specific inbound parse setting.**
+
+The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
+
+### GET /user/webhooks/parse/settings/{hostname}
+
+
+```ruby
+hostname = "test_url_param"
+response = sg.client.user.webhooks.parse.settings._(hostname).get()
+puts response.status_code
+puts response.body
+puts response.headers
+```
+## Delete a parse setting
+
+**This endpoint allows you to delete a specific inbound parse setting.**
+
+The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
+
+### DELETE /user/webhooks/parse/settings/{hostname}
+
+
+```ruby
+hostname = "test_url_param"
+response = sg.client.user.webhooks.parse.settings._(hostname).delete()
+puts response.status_code
+puts response.body
+puts response.headers
+```
 ## Retrieves Inbound Parse Webhook statistics.
 
 **This endpoint allows you to retrieve the statistics for your Parse Webhook useage.**