summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorElmer Thomas <elmer@thinkingserious.com>2016-06-13 18:15:46 -0700
committerElmer Thomas <elmer@thinkingserious.com>2016-06-13 18:15:46 -0700
commitaffdb34bf79df79c497b8079e0d7769a89e133fd (patch)
treefd8f4d330100ff0869ffd65c01e701a28f8c67cc
parent1313e7e8bfbf35994b79b6b7a1bb84cb40c4f328 (diff)
downloadsendgrid-nodejs-affdb34bf79df79c497b8079e0d7769a89e133fd.zip
sendgrid-nodejs-affdb34bf79df79c497b8079e0d7769a89e133fd.tar.gz
sendgrid-nodejs-affdb34bf79df79c497b8079e0d7769a89e133fd.tar.bz2
Version Bump v3.0.0: full v3 Web API support
-rw-r--r--CHANGELOG.md4
-rw-r--r--README.md75
-rw-r--r--USAGE.md10
-rw-r--r--examples/accesssettings/accesssettings.js3
-rw-r--r--examples/apikeys/apikeys.js2
-rw-r--r--examples/asm/asm.js3
-rw-r--r--examples/browsers/browsers.js13
-rw-r--r--examples/campaigns/campaigns.js5
-rw-r--r--examples/categories/categories.js31
-rw-r--r--examples/clients/clients.js12
-rw-r--r--examples/contactdb/contactdb.js23
-rw-r--r--examples/devices/devices.js11
-rw-r--r--examples/geo/geo.js13
-rw-r--r--examples/helpers/mail/example.js2
-rw-r--r--examples/ips/ips.js11
-rw-r--r--examples/mail/mail.js146
-rw-r--r--examples/mailboxproviders/mailboxproviders.js13
-rw-r--r--examples/mailsettings/mailsettings.js5
-rw-r--r--examples/partnersettings/partnersettings.js5
-rw-r--r--examples/scopes/scopes.js2
-rw-r--r--examples/stats/stats.js11
-rw-r--r--examples/subusers/subusers.js52
-rw-r--r--examples/suppression/suppression.js34
-rw-r--r--examples/templates/templates.js2
-rw-r--r--examples/trackingsettings/trackingsettings.js5
-rw-r--r--examples/user/user.js11
-rw-r--r--examples/whitelabel/whitelabel.js23
-rw-r--r--lib/helpers/mail/README.md4
28 files changed, 267 insertions, 264 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index cd69833..b2109ec 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,13 +1,13 @@
# Change Log
All notable changes to this project will be documented in this file.
-## [3.0.0] - XXXX-XX-XX
+## [3.0.0] - 2016-06-13
### Added
- Breaking change to support the v3 Web API
- New HTTP client
- v3 Mail Send helper
-## [2.0.0] - XXXX-XX-XX
+## [2.0.0] - 2015-10-13
## Fixed
- Add cc now uses the WebAPI instead of the SMTPApi. Read disclaimer for details
diff --git a/README.md b/README.md
index c911244..e4b348d 100644
--- a/README.md
+++ b/README.md
@@ -5,32 +5,24 @@
# Announcements
-**NOTE: The `/mail/send/beta` endpoint is currently in beta!
-
-Since this is not a general release, we do not recommend POSTing production level traffic through this endpoint or integrating your production servers with this endpoint.
-
-When this endpoint is ready for general release, your code will require an update in order to use the official URI.
-
-By using this endpoint, you accept that you may encounter bugs and that the endpoint may be taken down for maintenance at any time. We cannot guarantee the continued availability of this beta endpoint. We hope that you like this new endpoint and we appreciate any [feedback](dx+mail-beta@sendgrid.com) that you can send our way.**
-
-**BREAKING CHANGE as of XXXX.XX.XX**
+**BREAKING CHANGE as of 2016.06.14**
Version 3.0.0 brings you full support for all Web API v3 endpoints. We
have the following resources to get you started quickly:
- [SendGrid
Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html)
-- [Usage Docs](https://github.com/sendgrid/sendgrid-nodejs/blob/v3beta/USAGE.md)
+- [Usage Docs](https://github.com/sendgrid/sendgrid-nodejs/blob/master/USAGE.md)
- [Example
- Code](https://github.com/sendgrid/sendgrid-nodejs/tree/v3beta/examples)
+ Code](https://github.com/sendgrid/sendgrid-nodejs/tree/master/examples)
Thank you for your continued support!
-All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-nodejs/blob/v3beta/CHANGELOG.md).
+All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CHANGELOG.md).
# Installation
-## Environment Variables
+## Setup Environment Variables
First, get your free SendGrid account [here](https://sendgrid.com/free?source=sendgrid-nodejs).
@@ -42,44 +34,7 @@ echo "sendgrid.env" >> .gitignore
source ./sendgrid.env
```
-## TRYING OUT THE V3 BETA MAIL SEND
-
-```bash
-git clone -b v3beta --single-branch https://github.com/sendgrid/sendgrid-nodejs.git
-cd sendgrid-nodejs
-npm install
-```
-
-* Update the to and from [emails](https://github.com/sendgrid/sendgrid-nodejs/blob/v3beta/examples/helpers/mail/example.js#L4).
-
-```bash
-node examples/helpers/mail/example.js
-```
-
-## TRYING OUT THE V3 BETA WEB API
-
-```bash
-git clone -b v3beta --single-branch https://github.com/sendgrid/sendgrid-nodejs.git
-```
-
-* Check out the documentation for [Web API v3 endpoints](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html).
-* Review the corresponding [examples](https://github.com/sendgrid/sendgrid-nodejs/blob/v3beta/examples).
-
-```bash
-touch test.js
-```
-
-Copy the desired example into `test.js`.
-
-Change the path to the Sendgrid library to `./lib/sendgrid.js`.
-
-```
-node test.js
-```
-
-* Check out the documentation for [Web API v3 /mail/send/beta endpoint](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html).
-
-## Once we are out of v3 BETA, the following will apply
+## Install Package
The following recommended installation requires [npm](https://npmjs.org/). If you are unfamiliar with npm, see the [npm docs](https://npmjs.org/doc/). Npm comes installed with Node.js since node version 0.8.x therefore you likely already have it.
@@ -132,7 +87,7 @@ npm install sendgrid
var requestBody = mail.toJSON()
var request = sg.emptyRequest()
requestPost.method = 'POST'
- requestPost.path = '/v3/mail/send/beta'
+ requestPost.path = '/v3/mail/send'
requestPost.body = requestBody
sg.API(requestPost, function (response) {
console.log(response.statusCode)
@@ -144,7 +99,7 @@ npm install sendgrid
## General v3 Web API Usage
```javascript
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
// GET Collection
var request = sg.emptyRequest()
@@ -160,9 +115,9 @@ sg.API(requestGet, function (response) {
# Usage
- [SendGrid Docs](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html)
-- [Usage Docs](https://github.com/sendgrid/sendgrid-nodejs/blob/v3beta/USAGE.md)
-- [Example Code](https://github.com/sendgrid/sendgrid-nodejs/tree/v3beta/examples)
-- [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-nodejs/tree/v3beta/lib/helpers/mail/README.md
+- [Usage Docs](https://github.com/sendgrid/sendgrid-nodejs/blob/master/USAGE.md)
+- [Example Code](https://github.com/sendgrid/sendgrid-nodejs/tree/master/examples)
+- [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-nodejs/tree/master/lib/helpers/mail/README.md
## Roadmap
@@ -170,11 +125,11 @@ If you are intersted in the future direction of this project, please take a look
## How to Contribute
-We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-nodejs/tree/v3beta/CONTRIBUTING.md) guide for details.
+We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md) guide for details.
-* [Feature Request](https://github.com/sendgrid/sendgrid-nodejs/tree/v3beta/CONTRIBUTING.md#feature_request)
-* [Bug Reports](https://github.com/sendgrid/sendgrid-nodejs/tree/v3beta/CONTRIBUTING.md#submit_a_bug_report)
-* [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-nodejs/tree/v3beta/CONTRIBUTING.md#improvements_to_the_codebase)
+* [Feature Request](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#feature_request)
+* [Bug Reports](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#submit_a_bug_report)
+* [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#improvements_to_the_codebase)
# About
diff --git a/USAGE.md b/USAGE.md
index 1084308..2caffb1 100644
--- a/USAGE.md
+++ b/USAGE.md
@@ -3,7 +3,7 @@ This documentation is based on our [OAI specification](https://github.com/sendgr
# INITIALIZATION
```javascript
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
```
# Table of Contents
@@ -2296,7 +2296,7 @@ More Information:
console.log(response.headers)
})
```
-## v3 Mail Send Beta
+## v3 Mail Send
This endpoint allows you to send email over SendGrids 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).
@@ -2307,9 +2307,9 @@ For an overview of the v3 Mail Send endpoint, please visit our [v3 API Reference
For more detailed information about how to use the v3 Mail Send endpoint, please visit our [Classroom](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/index.html).
-### POST /mail/send/beta
+### POST /mail/send
-// This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-nodejs/blob/v3beta/lib/helpers/mail/README.md).
+// This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/lib/helpers/mail/README.md).
```javascript
var request = sg.emptyRequest()
@@ -2457,7 +2457,7 @@ For more detailed information about how to use the v3 Mail Send endpoint, please
}
};
request.method = 'POST'
- request.path = '/v3/mail/send/beta'
+ request.path = '/v3/mail/send'
sg.API(request, function (response) {
console.log(response.statusCode)
console.log(response.body)
diff --git a/examples/accesssettings/accesssettings.js b/examples/accesssettings/accesssettings.js
index d8364fa..527ca78 100644
--- a/examples/accesssettings/accesssettings.js
+++ b/examples/accesssettings/accesssettings.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Retrieve all recent access attempts
@@ -7,6 +7,7 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
var request = sg.emptyRequest()
request.queryParams["limit"] = '1'
+
request.method = 'GET'
request.path = '/v3/access_settings/activity'
sg.API(request, function (response) {
diff --git a/examples/apikeys/apikeys.js b/examples/apikeys/apikeys.js
index 3eb2ea2..2bfb434 100644
--- a/examples/apikeys/apikeys.js
+++ b/examples/apikeys/apikeys.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Create API keys
diff --git a/examples/asm/asm.js b/examples/asm/asm.js
index 1f3bbc9..5eaceaf 100644
--- a/examples/asm/asm.js
+++ b/examples/asm/asm.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Create a new suppression group
@@ -26,6 +26,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["id"] = '1'
+
request.method = 'GET'
request.path = '/v3/asm/groups'
sg.API(request, function (response) {
diff --git a/examples/browsers/browsers.js b/examples/browsers/browsers.js
index 04046c3..890104b 100644
--- a/examples/browsers/browsers.js
+++ b/examples/browsers/browsers.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Retrieve email statistics by browser.
@@ -7,11 +7,12 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
-request.queryParams["aggregated_by"] = 'day'
-request.queryParams["browsers"] = 'test_string'
-request.queryParams["limit"] = 'test_string'
-request.queryParams["offset"] = 'test_string'
-request.queryParams["start_date"] = '2016-01-01'
+ request.queryParams["aggregated_by"] = 'day'
+ request.queryParams["browsers"] = 'test_string'
+ request.queryParams["limit"] = 'test_string'
+ request.queryParams["offset"] = 'test_string'
+ request.queryParams["start_date"] = '2016-01-01'
+
request.method = 'GET'
request.path = '/v3/browsers/stats'
sg.API(request, function (response) {
diff --git a/examples/campaigns/campaigns.js b/examples/campaigns/campaigns.js
index 821c3db..2e79e8e 100644
--- a/examples/campaigns/campaigns.js
+++ b/examples/campaigns/campaigns.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Create a Campaign
@@ -41,7 +41,8 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["limit"] = '0'
-request.queryParams["offset"] = '0'
+ request.queryParams["offset"] = '0'
+
request.method = 'GET'
request.path = '/v3/campaigns'
sg.API(request, function (response) {
diff --git a/examples/categories/categories.js b/examples/categories/categories.js
index 04e8579..dc12f38 100644
--- a/examples/categories/categories.js
+++ b/examples/categories/categories.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Retrieve all categories
@@ -7,8 +7,9 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
var request = sg.emptyRequest()
request.queryParams["category"] = 'test_string'
-request.queryParams["limit"] = '1'
-request.queryParams["offset"] = '1'
+ request.queryParams["limit"] = '1'
+ request.queryParams["offset"] = '1'
+
request.method = 'GET'
request.path = '/v3/categories'
sg.API(request, function (response) {
@@ -24,11 +25,12 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
-request.queryParams["aggregated_by"] = 'day'
-request.queryParams["limit"] = '1'
-request.queryParams["offset"] = '1'
-request.queryParams["start_date"] = '2016-01-01'
-request.queryParams["categories"] = 'test_string'
+ request.queryParams["aggregated_by"] = 'day'
+ request.queryParams["limit"] = '1'
+ request.queryParams["offset"] = '1'
+ request.queryParams["start_date"] = '2016-01-01'
+ request.queryParams["categories"] = 'test_string'
+
request.method = 'GET'
request.path = '/v3/categories/stats'
sg.API(request, function (response) {
@@ -44,12 +46,13 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
-request.queryParams["aggregated_by"] = 'day'
-request.queryParams["limit"] = '1'
-request.queryParams["sort_by_metric"] = 'test_string'
-request.queryParams["offset"] = '1'
-request.queryParams["start_date"] = '2016-01-01'
-request.queryParams["sort_by_direction"] = 'asc'
+ request.queryParams["aggregated_by"] = 'day'
+ request.queryParams["limit"] = '1'
+ request.queryParams["sort_by_metric"] = 'test_string'
+ request.queryParams["offset"] = '1'
+ request.queryParams["start_date"] = '2016-01-01'
+ request.queryParams["sort_by_direction"] = 'asc'
+
request.method = 'GET'
request.path = '/v3/categories/stats/sums'
sg.API(request, function (response) {
diff --git a/examples/clients/clients.js b/examples/clients/clients.js
index d018a81..277b524 100644
--- a/examples/clients/clients.js
+++ b/examples/clients/clients.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Retrieve email statistics by client type.
@@ -7,8 +7,9 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
var request = sg.emptyRequest()
request.queryParams["aggregated_by"] = 'day'
-request.queryParams["start_date"] = '2016-01-01'
-request.queryParams["end_date"] = '2016-04-01'
+ request.queryParams["start_date"] = '2016-01-01'
+ request.queryParams["end_date"] = '2016-04-01'
+
request.method = 'GET'
request.path = '/v3/clients/stats'
sg.API(request, function (response) {
@@ -24,8 +25,9 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["aggregated_by"] = 'day'
-request.queryParams["start_date"] = '2016-01-01'
-request.queryParams["end_date"] = '2016-04-01'
+ request.queryParams["start_date"] = '2016-01-01'
+ request.queryParams["end_date"] = '2016-04-01'
+
request.method = 'GET'
request.path = '/v3/clients/{client_type}/stats'
sg.API(request, function (response) {
diff --git a/examples/contactdb/contactdb.js b/examples/contactdb/contactdb.js
index f2139b5..645c828 100644
--- a/examples/contactdb/contactdb.js
+++ b/examples/contactdb/contactdb.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Create a Custom Field
@@ -121,6 +121,7 @@ request.body = {
"name": "newlistname"
};
request.queryParams["list_id"] = '0'
+
request.method = 'PATCH'
request.path = '/v3/contactdb/lists/{list_id}'
sg.API(request, function (response) {
@@ -136,6 +137,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["list_id"] = '0'
+
request.method = 'GET'
request.path = '/v3/contactdb/lists/{list_id}'
sg.API(request, function (response) {
@@ -151,6 +153,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["delete_contacts"] = 'true'
+
request.method = 'DELETE'
request.path = '/v3/contactdb/lists/{list_id}'
sg.API(request, function (response) {
@@ -184,8 +187,9 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["page"] = '1'
-request.queryParams["page_size"] = '1'
-request.queryParams["list_id"] = '0'
+ request.queryParams["page_size"] = '1'
+ request.queryParams["list_id"] = '0'
+
request.method = 'GET'
request.path = '/v3/contactdb/lists/{list_id}/recipients'
sg.API(request, function (response) {
@@ -215,7 +219,8 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["recipient_id"] = '0'
-request.queryParams["list_id"] = '0'
+ request.queryParams["list_id"] = '0'
+
request.method = 'DELETE'
request.path = '/v3/contactdb/lists/{list_id}/recipients/{recipient_id}'
sg.API(request, function (response) {
@@ -280,7 +285,8 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["page"] = '1'
-request.queryParams["page_size"] = '1'
+ request.queryParams["page_size"] = '1'
+
request.method = 'GET'
request.path = '/v3/contactdb/recipients'
sg.API(request, function (response) {
@@ -342,6 +348,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["{field_name}"] = 'test_string'
+
request.method = 'GET'
request.path = '/v3/contactdb/recipients/search'
sg.API(request, function (response) {
@@ -477,6 +484,7 @@ request.body = {
"name": "The Millers"
};
request.queryParams["segment_id"] = 'test_string'
+
request.method = 'PATCH'
request.path = '/v3/contactdb/segments/{segment_id}'
sg.API(request, function (response) {
@@ -492,6 +500,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["segment_id"] = '0'
+
request.method = 'GET'
request.path = '/v3/contactdb/segments/{segment_id}'
sg.API(request, function (response) {
@@ -507,6 +516,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["delete_contacts"] = 'true'
+
request.method = 'DELETE'
request.path = '/v3/contactdb/segments/{segment_id}'
sg.API(request, function (response) {
@@ -522,7 +532,8 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["page"] = '1'
-request.queryParams["page_size"] = '1'
+ request.queryParams["page_size"] = '1'
+
request.method = 'GET'
request.path = '/v3/contactdb/segments/{segment_id}/recipients'
sg.API(request, function (response) {
diff --git a/examples/devices/devices.js b/examples/devices/devices.js
index a41a102..26c3f21 100644
--- a/examples/devices/devices.js
+++ b/examples/devices/devices.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Retrieve email statistics by device type.
@@ -7,10 +7,11 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
var request = sg.emptyRequest()
request.queryParams["aggregated_by"] = 'day'
-request.queryParams["limit"] = '1'
-request.queryParams["start_date"] = '2016-01-01'
-request.queryParams["end_date"] = '2016-04-01'
-request.queryParams["offset"] = '1'
+ request.queryParams["limit"] = '1'
+ request.queryParams["start_date"] = '2016-01-01'
+ request.queryParams["end_date"] = '2016-04-01'
+ request.queryParams["offset"] = '1'
+
request.method = 'GET'
request.path = '/v3/devices/stats'
sg.API(request, function (response) {
diff --git a/examples/geo/geo.js b/examples/geo/geo.js
index 4389d92..1afd644 100644
--- a/examples/geo/geo.js
+++ b/examples/geo/geo.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Retrieve email statistics by country and state/province.
@@ -7,11 +7,12 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
-request.queryParams["country"] = 'US'
-request.queryParams["aggregated_by"] = 'day'
-request.queryParams["limit"] = '1'
-request.queryParams["offset"] = '1'
-request.queryParams["start_date"] = '2016-01-01'
+ request.queryParams["country"] = 'US'
+ request.queryParams["aggregated_by"] = 'day'
+ request.queryParams["limit"] = '1'
+ request.queryParams["offset"] = '1'
+ request.queryParams["start_date"] = '2016-01-01'
+
request.method = 'GET'
request.path = '/v3/geo/stats'
sg.API(request, function (response) {
diff --git a/examples/helpers/mail/example.js b/examples/helpers/mail/example.js
index ab5640d..4959fe0 100644
--- a/examples/helpers/mail/example.js
+++ b/examples/helpers/mail/example.js
@@ -142,7 +142,7 @@ function send(toSend){
var emptyRequest = require('sendgrid-rest').request
var requestPost = JSON.parse(JSON.stringify(emptyRequest))
requestPost.method = 'POST'
- requestPost.path = '/v3/mail/send/beta'
+ requestPost.path = '/v3/mail/send'
requestPost.requestBody = requestBody
sg.API(requestPost, function (response) {
console.log(response.statusCode)
diff --git a/examples/ips/ips.js b/examples/ips/ips.js
index cb4d0fb..746465c 100644
--- a/examples/ips/ips.js
+++ b/examples/ips/ips.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Retrieve all IP addresses
@@ -7,10 +7,11 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
var request = sg.emptyRequest()
request.queryParams["subuser"] = 'test_string'
-request.queryParams["ip"] = 'test_string'
-request.queryParams["limit"] = '1'
-request.queryParams["exclude_whitelabels"] = 'true'
-request.queryParams["offset"] = '1'
+ request.queryParams["ip"] = 'test_string'
+ request.queryParams["limit"] = '1'
+ request.queryParams["exclude_whitelabels"] = 'true'
+ request.queryParams["offset"] = '1'
+
request.method = 'GET'
request.path = '/v3/ips'
sg.API(request, function (response) {
diff --git a/examples/mail/mail.js b/examples/mail/mail.js
index 009f10e..44af771 100644
--- a/examples/mail/mail.js
+++ b/examples/mail/mail.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Create a batch ID
@@ -29,157 +29,157 @@ sg.API(request, function (response) {
})
///////////////////////////////////////////////////
-// v3 Mail Send Beta
-// POST /mail/send/beta
+// v3 Mail Send
+// POST /mail/send
-// This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-nodejs/blob/v3beta/lib/helpers/mail/README.md).
+// This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/lib/helpers/mail/README.md).
var request = sg.emptyRequest()
request.body = {
"asm": {
- "group_id": 1,
+ "group_id": 1,
"groups_to_display": [
- 1,
- 2,
+ 1,
+ 2,
3
]
- },
+ },
"attachments": [
{
- "content": "[BASE64 encoded content block here]",
- "content_id": "ii_139db99fdb5c3704",
- "disposition": "inline",
- "filename": "file1.jpg",
- "name": "file1",
+ "content": "[BASE64 encoded content block here]",
+ "content_id": "ii_139db99fdb5c3704",
+ "disposition": "inline",
+ "filename": "file1.jpg",
+ "name": "file1",
"type": "jpg"
}
- ],
- "batch_id": "[YOUR BATCH ID GOES HERE]",
+ ],
+ "batch_id": "[YOUR BATCH ID GOES HERE]",
"categories": [
- "category1",
+ "category1",
"category2"
- ],
+ ],
"content": [
{
- "type": "text/html",
+ "type": "text/html",
"value": "<html><p>Hello, world!</p><img src=[CID GOES HERE]></img></html>"
}
- ],
+ ],
"custom_args": {
- "New Argument 1": "New Value 1",
- "activationAttempt": "1",
+ "New Argument 1": "New Value 1",
+ "activationAttempt": "1",
"customerAccountNumber": "[CUSTOMER ACCOUNT NUMBER GOES HERE]"
- },
+ },
"from": {
- "email": "sam.smith@example.com",
+ "email": "sam.smith@example.com",
"name": "Sam Smith"
- },
- "headers": {},
- "ip_pool_name": "[YOUR POOL NAME GOES HERE]",
+ },
+ "headers": {},
+ "ip_pool_name": "[YOUR POOL NAME GOES HERE]",
"mail_settings": {
"bcc": {
- "email": "ben.doe@example.com",
+ "email": "ben.doe@example.com",
"enable": true
- },
+ },
"bypass_list_management": {
"enable": true
- },
+ },
"footer": {
- "enable": true,
- "html": "<p>Thanks</br>The SendGrid Team</p>",
+ "enable": true,
+ "html": "<p>Thanks</br>The SendGrid Team</p>",
"text": "Thanks,/n The SendGrid Team"
- },
+ },
"sandbox_mode": {
"enable": false
- },
+ },
"spam_check": {
- "enable": true,
- "post_to_url": "http://example.com/compliance",
+ "enable": true,
+ "post_to_url": "http://example.com/compliance",
"threshold": 3
}
- },
+ },
"personalizations": [
{
"bcc": [
{
- "email": "sam.doe@example.com",
+ "email": "sam.doe@example.com",
"name": "Sam Doe"
}
- ],
+ ],
"cc": [
{
- "email": "jane.doe@example.com",
+ "email": "jane.doe@example.com",
"name": "Jane Doe"
}
- ],
+ ],
"custom_args": {
- "New Argument 1": "New Value 1",
- "activationAttempt": "1",
+ "New Argument 1": "New Value 1",
+ "activationAttempt": "1",
"customerAccountNumber": "[CUSTOMER ACCOUNT NUMBER GOES HERE]"
- },
+ },
"headers": {
- "X-Accept-Language": "en",
+ "X-Accept-Language": "en",
"X-Mailer": "MyApp"
- },
- "send_at": 1409348513,
- "subject": "Hello, World!",
+ },
+ "send_at": 1409348513,
+ "subject": "Hello, World!",
"substitutions": {
"sub": {
"%name%": [
- "John",
- "Jane",
+ "John",
+ "Jane",
"Sam"
]
}
- },
+ },
"to": [
{
- "email": "john.doe@example.com",
+ "email": "john.doe@example.com",
"name": "John Doe"
}
]
}
- ],
+ ],
"reply_to": {
- "email": "sam.smith@example.com",
+ "email": "sam.smith@example.com",
"name": "Sam Smith"
- },
+ },
"sections": {
"section": {
- ":sectionName1": "section 1 text",
+ ":sectionName1": "section 1 text",
":sectionName2": "section 2 text"
}
- },
- "send_at": 1409348513,
- "subject": "Hello, World!",
- "template_id": "[YOUR TEMPLATE ID GOES HERE]",
+ },
+ "send_at": 1409348513,
+ "subject": "Hello, World!",
+ "template_id": "[YOUR TEMPLATE ID GOES HERE]",
"tracking_settings": {
"click_tracking": {
- "enable": true,
+ "enable": true,
"enable_text": true
- },
+ },
"ganalytics": {
- "enable": true,
- "utm_campaign": "[NAME OF YOUR REFERRER SOURCE]",
- "utm_content": "[USE THIS SPACE TO DIFFERENTIATE YOUR EMAIL FROM ADS]",
- "utm_medium": "[NAME OF YOUR MARKETING MEDIUM e.g. email]",
- "utm_name": "[NAME OF YOUR CAMPAIGN]",
+ "enable": true,
+ "utm_campaign": "[NAME OF YOUR REFERRER SOURCE]",
+ "utm_content": "[USE THIS SPACE TO DIFFERENTIATE YOUR EMAIL FROM ADS]",
+ "utm_medium": "[NAME OF YOUR MARKETING MEDIUM e.g. email]",
+ "utm_name": "[NAME OF YOUR CAMPAIGN]",
"utm_term": "[IDENTIFY PAID KEYWORDS HERE]"
- },
+ },
"open_tracking": {
- "enable": true,
+ "enable": true,
"substitution_tag": "%opentrack"
- },
+ },
"subscription_tracking": {
- "enable": true,
- "html": "If you would like to unsubscribe and stop receiving these emails <% clickhere %>.",
- "substitution_tag": "<%click here%>",
+ "enable": true,
+ "html": "If you would like to unsubscribe and stop receiving these emails <% clickhere %>.",
+ "substitution_tag": "<%click here%>",
"text": "If you would like to unsubscribe and stop receiveing these emails <% click here %>."
}
}
};
request.method = 'POST'
-request.path = '/v3/mail/send/beta'
+request.path = '/v3/mail/send'
sg.API(request, function (response) {
console.log(response.statusCode)
console.log(response.body)
diff --git a/examples/mailboxproviders/mailboxproviders.js b/examples/mailboxproviders/mailboxproviders.js
index 18779a1..33670df 100644
--- a/examples/mailboxproviders/mailboxproviders.js
+++ b/examples/mailboxproviders/mailboxproviders.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Retrieve email statistics by mailbox provider.
@@ -7,11 +7,12 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
-request.queryParams["mailbox_providers"] = 'test_string'
-request.queryParams["aggregated_by"] = 'day'
-request.queryParams["limit"] = '1'
-request.queryParams["offset"] = '1'
-request.queryParams["start_date"] = '2016-01-01'
+ request.queryParams["mailbox_providers"] = 'test_string'
+ request.queryParams["aggregated_by"] = 'day'
+ request.queryParams["limit"] = '1'
+ request.queryParams["offset"] = '1'
+ request.queryParams["start_date"] = '2016-01-01'
+
request.method = 'GET'
request.path = '/v3/mailbox_providers/stats'
sg.API(request, function (response) {
diff --git a/examples/mailsettings/mailsettings.js b/examples/mailsettings/mailsettings.js
index 2c7cc80..c2e1ee7 100644
--- a/examples/mailsettings/mailsettings.js
+++ b/examples/mailsettings/mailsettings.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Retrieve all mail settings
@@ -7,7 +7,8 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
var request = sg.emptyRequest()
request.queryParams["limit"] = '1'
-request.queryParams["offset"] = '1'
+ request.queryParams["offset"] = '1'
+
request.method = 'GET'
request.path = '/v3/mail_settings'
sg.API(request, function (response) {
diff --git a/examples/partnersettings/partnersettings.js b/examples/partnersettings/partnersettings.js
index 945785b..dbc20d1 100644
--- a/examples/partnersettings/partnersettings.js
+++ b/examples/partnersettings/partnersettings.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Returns a list of all partner settings.
@@ -7,7 +7,8 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
var request = sg.emptyRequest()
request.queryParams["limit"] = '1'
-request.queryParams["offset"] = '1'
+ request.queryParams["offset"] = '1'
+
request.method = 'GET'
request.path = '/v3/partner_settings'
sg.API(request, function (response) {
diff --git a/examples/scopes/scopes.js b/examples/scopes/scopes.js
index 2a7e2a0..6b1cdc6 100644
--- a/examples/scopes/scopes.js
+++ b/examples/scopes/scopes.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Retrieve a list of scopes for which this user has access.
diff --git a/examples/stats/stats.js b/examples/stats/stats.js
index c57b19d..c40e8e3 100644
--- a/examples/stats/stats.js
+++ b/examples/stats/stats.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Retrieve global email statistics
@@ -7,10 +7,11 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
var request = sg.emptyRequest()
request.queryParams["aggregated_by"] = 'day'
-request.queryParams["limit"] = '1'
-request.queryParams["start_date"] = '2016-01-01'
-request.queryParams["end_date"] = '2016-04-01'
-request.queryParams["offset"] = '1'
+ request.queryParams["limit"] = '1'
+ request.queryParams["start_date"] = '2016-01-01'
+ request.queryParams["end_date"] = '2016-04-01'
+ request.queryParams["offset"] = '1'
+
request.method = 'GET'
request.path = '/v3/stats'
sg.API(request, function (response) {
diff --git a/examples/subusers/subusers.js b/examples/subusers/subusers.js
index d075988..0705e84 100644
--- a/examples/subusers/subusers.js
+++ b/examples/subusers/subusers.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Create Subuser
@@ -30,8 +30,9 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["username"] = 'test_string'
-request.queryParams["limit"] = '0'
-request.queryParams["offset"] = '0'
+ request.queryParams["limit"] = '0'
+ request.queryParams["offset"] = '0'
+
request.method = 'GET'
request.path = '/v3/subusers'
sg.API(request, function (response) {
@@ -47,6 +48,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["usernames"] = 'test_string'
+
request.method = 'GET'
request.path = '/v3/subusers/reputations'
sg.API(request, function (response) {
@@ -62,11 +64,12 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
-request.queryParams["aggregated_by"] = 'day'
-request.queryParams["limit"] = '1'
-request.queryParams["offset"] = '1'
-request.queryParams["start_date"] = '2016-01-01'
-request.queryParams["subusers"] = 'test_string'
+ request.queryParams["aggregated_by"] = 'day'
+ request.queryParams["limit"] = '1'
+ request.queryParams["offset"] = '1'
+ request.queryParams["start_date"] = '2016-01-01'
+ request.queryParams["subusers"] = 'test_string'
+
request.method = 'GET'
request.path = '/v3/subusers/stats'
sg.API(request, function (response) {
@@ -82,11 +85,12 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["subuser"] = 'test_string'
-request.queryParams["limit"] = '1'
-request.queryParams["sort_by_metric"] = 'test_string'
-request.queryParams["offset"] = '1'
-request.queryParams["date"] = 'test_string'
-request.queryParams["sort_by_direction"] = 'asc'
+ request.queryParams["limit"] = '1'
+ request.queryParams["sort_by_metric"] = 'test_string'
+ request.queryParams["offset"] = '1'
+ request.queryParams["date"] = 'test_string'
+ request.queryParams["sort_by_direction"] = 'asc'
+
request.method = 'GET'
request.path = '/v3/subusers/stats/monthly'
sg.API(request, function (response) {
@@ -102,12 +106,13 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
-request.queryParams["aggregated_by"] = 'day'
-request.queryParams["limit"] = '1'
-request.queryParams["sort_by_metric"] = 'test_string'
-request.queryParams["offset"] = '1'
-request.queryParams["start_date"] = '2016-01-01'
-request.queryParams["sort_by_direction"] = 'asc'
+ request.queryParams["aggregated_by"] = 'day'
+ request.queryParams["limit"] = '1'
+ request.queryParams["sort_by_metric"] = 'test_string'
+ request.queryParams["offset"] = '1'
+ request.queryParams["start_date"] = '2016-01-01'
+ request.queryParams["sort_by_direction"] = 'asc'
+
request.method = 'GET'
request.path = '/v3/subusers/stats/sums'
sg.API(request, function (response) {
@@ -235,10 +240,11 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["date"] = 'test_string'
-request.queryParams["sort_by_direction"] = 'asc'
-request.queryParams["limit"] = '0'
-request.queryParams["sort_by_metric"] = 'test_string'
-request.queryParams["offset"] = '1'
+ request.queryParams["sort_by_direction"] = 'asc'
+ request.queryParams["limit"] = '0'
+ request.queryParams["sort_by_metric"] = 'test_string'
+ request.queryParams["offset"] = '1'
+
request.method = 'GET'
request.path = '/v3/subusers/{subuser_name}/stats/monthly'
sg.API(request, function (response) {
diff --git a/examples/suppression/suppression.js b/examples/suppression/suppression.js
index be135ec..6b607e1 100644
--- a/examples/suppression/suppression.js
+++ b/examples/suppression/suppression.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Retrieve all blocks
@@ -7,9 +7,10 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
var request = sg.emptyRequest()
request.queryParams["start_time"] = '1'
-request.queryParams["limit"] = '1'
-request.queryParams["end_time"] = '1'
-request.queryParams["offset"] = '1'
+ request.queryParams["limit"] = '1'
+ request.queryParams["end_time"] = '1'
+ request.queryParams["offset"] = '1'
+
request.method = 'GET'
request.path = '/v3/suppression/blocks'
sg.API(request, function (response) {
@@ -74,7 +75,8 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["start_time"] = '0'
-request.queryParams["end_time"] = '0'
+ request.queryParams["end_time"] = '0'
+
request.method = 'GET'
request.path = '/v3/suppression/bounces'
sg.API(request, function (response) {
@@ -125,6 +127,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["email_address"] = 'example@example.com'
+
request.method = 'DELETE'
request.path = '/v3/suppression/bounces/{email}'
sg.API(request, function (response) {
@@ -140,9 +143,10 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["start_time"] = '1'
-request.queryParams["limit"] = '1'
-request.queryParams["end_time"] = '1'
-request.queryParams["offset"] = '1'
+ request.queryParams["limit"] = '1'
+ request.queryParams["end_time"] = '1'
+ request.queryParams["offset"] = '1'
+
request.method = 'GET'
request.path = '/v3/suppression/invalid_emails'
sg.API(request, function (response) {
@@ -235,9 +239,10 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["start_time"] = '1'
-request.queryParams["limit"] = '1'
-request.queryParams["end_time"] = '1'
-request.queryParams["offset"] = '1'
+ request.queryParams["limit"] = '1'
+ request.queryParams["end_time"] = '1'
+ request.queryParams["offset"] = '1'
+
request.method = 'GET'
request.path = '/v3/suppression/spam_reports'
sg.API(request, function (response) {
@@ -274,9 +279,10 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["start_time"] = '1'
-request.queryParams["limit"] = '1'
-request.queryParams["end_time"] = '1'
-request.queryParams["offset"] = '1'
+ request.queryParams["limit"] = '1'
+ request.queryParams["end_time"] = '1'
+ request.queryParams["offset"] = '1'
+
request.method = 'GET'
request.path = '/v3/suppression/unsubscribes'
sg.API(request, function (response) {
diff --git a/examples/templates/templates.js b/examples/templates/templates.js
index 36e5af6..9c5f4c3 100644
--- a/examples/templates/templates.js
+++ b/examples/templates/templates.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Create a transactional template.
diff --git a/examples/trackingsettings/trackingsettings.js b/examples/trackingsettings/trackingsettings.js
index 9e67b37..23ee781 100644
--- a/examples/trackingsettings/trackingsettings.js
+++ b/examples/trackingsettings/trackingsettings.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Retrieve Tracking Settings
@@ -7,7 +7,8 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
var request = sg.emptyRequest()
request.queryParams["limit"] = '1'
-request.queryParams["offset"] = '1'
+ request.queryParams["offset"] = '1'
+
request.method = 'GET'
request.path = '/v3/tracking_settings'
sg.API(request, function (response) {
diff --git a/examples/user/user.js b/examples/user/user.js
index b2b49c2..461e949 100644
--- a/examples/user/user.js
+++ b/examples/user/user.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Get a user's account information.
@@ -331,10 +331,11 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["aggregated_by"] = 'day'
-request.queryParams["limit"] = 'test_string'
-request.queryParams["start_date"] = '2016-01-01'
-request.queryParams["end_date"] = '2016-04-01'
-request.queryParams["offset"] = 'test_string'
+ request.queryParams["limit"] = 'test_string'
+ request.queryParams["start_date"] = '2016-01-01'
+ request.queryParams["end_date"] = '2016-04-01'
+ request.queryParams["offset"] = 'test_string'
+
request.method = 'GET'
request.path = '/v3/user/webhooks/parse/stats'
sg.API(request, function (response) {
diff --git a/examples/whitelabel/whitelabel.js b/examples/whitelabel/whitelabel.js
index a9532b1..748489e 100644
--- a/examples/whitelabel/whitelabel.js
+++ b/examples/whitelabel/whitelabel.js
@@ -1,4 +1,4 @@
-var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
+var sg = require('sendgrid-nodejs').SendGrid(process.env.SENDGRID_API_KEY)
///////////////////////////////////////////////////
// Create a domain whitelabel.
@@ -33,10 +33,11 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["username"] = 'test_string'
-request.queryParams["domain"] = 'test_string'
-request.queryParams["exclude_subusers"] = 'true'
-request.queryParams["limit"] = '1'
-request.queryParams["offset"] = '1'
+ request.queryParams["domain"] = 'test_string'
+ request.queryParams["exclude_subusers"] = 'true'
+ request.queryParams["limit"] = '1'
+ request.queryParams["offset"] = '1'
+
request.method = 'GET'
request.path = '/v3/whitelabel/domains'
sg.API(request, function (response) {
@@ -221,8 +222,9 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["ip"] = 'test_string'
-request.queryParams["limit"] = '1'
-request.queryParams["offset"] = '1'
+ request.queryParams["limit"] = '1'
+ request.queryParams["offset"] = '1'
+
request.method = 'GET'
request.path = '/v3/whitelabel/ips'
sg.API(request, function (response) {
@@ -285,7 +287,8 @@ request.body = {
"subdomain": "mail"
};
request.queryParams["limit"] = '1'
-request.queryParams["offset"] = '1'
+ request.queryParams["offset"] = '1'
+
request.method = 'POST'
request.path = '/v3/whitelabel/links'
sg.API(request, function (response) {
@@ -301,6 +304,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["limit"] = '1'
+
request.method = 'GET'
request.path = '/v3/whitelabel/links'
sg.API(request, function (response) {
@@ -316,6 +320,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["domain"] = 'test_string'
+
request.method = 'GET'
request.path = '/v3/whitelabel/links/default'
sg.API(request, function (response) {
@@ -331,6 +336,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["username"] = 'test_string'
+
request.method = 'GET'
request.path = '/v3/whitelabel/links/subuser'
sg.API(request, function (response) {
@@ -346,6 +352,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["username"] = 'test_string'
+
request.method = 'DELETE'
request.path = '/v3/whitelabel/links/subuser'
sg.API(request, function (response) {
diff --git a/lib/helpers/mail/README.md b/lib/helpers/mail/README.md
index 4ba3385..48570cd 100644
--- a/lib/helpers/mail/README.md
+++ b/lib/helpers/mail/README.md
@@ -2,7 +2,7 @@
# Quick Start
-Run the [example](https://github.com/sendgrid/sendgrid-nodejs/tree/v3beta/examples) (make sure you have set your environment variable to include your SENDGRID_API_KEY).
+Run the [example](https://github.com/sendgrid/sendgrid-nodejs/tree/master/examples) (make sure you have set your environment variable to include your SENDGRID_API_KEY).
```bash
node examples/helpers/mail/example.js
@@ -10,5 +10,5 @@ node examples/helpers/mail/example.js
## Usage
-- See the [example](https://github.com/sendgrid/sendgrid-nodejs/tree/v3beta/examples) for a complete working example.
+- See the [example](https://github.com/sendgrid/sendgrid-nodejs/tree/master/examples) for a complete working example.
- [Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/overview.html) \ No newline at end of file