summaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorElmer Thomas <elmer@thinkingserious.com>2016-06-08 10:34:44 -0700
committerElmer Thomas <elmer@thinkingserious.com>2016-06-08 10:34:44 -0700
commit15ca3f187b4fd34ab2642f94bf18a4e1e09f4fd5 (patch)
tree488a191b16d3e9aa91d611c797dd2e25f6a7e732 /examples
parent1e5f641635666857f4301c929db4cf205043b6eb (diff)
downloadsendgrid-nodejs-15ca3f187b4fd34ab2642f94bf18a4e1e09f4fd5.zip
sendgrid-nodejs-15ca3f187b4fd34ab2642f94bf18a4e1e09f4fd5.tar.gz
sendgrid-nodejs-15ca3f187b4fd34ab2642f94bf18a4e1e09f4fd5.tar.bz2
Simplified setting the request object
Diffstat (limited to 'examples')
-rw-r--r--examples/accesssettings/accesssettings.js54
-rw-r--r--examples/apikeys/apikeys.js54
-rw-r--r--examples/asm/asm.js132
-rw-r--r--examples/browsers/browsers.js9
-rw-r--r--examples/campaigns/campaigns.js99
-rw-r--r--examples/categories/categories.js27
-rw-r--r--examples/clients/clients.js18
-rw-r--r--examples/contactdb/contactdb.js279
-rw-r--r--examples/devices/devices.js9
-rw-r--r--examples/geo/geo.js9
-rw-r--r--examples/ips/ips.js126
-rw-r--r--examples/mail/mail.js27
-rw-r--r--examples/mailboxproviders/mailboxproviders.js9
-rw-r--r--examples/mailsettings/mailsettings.js171
-rw-r--r--examples/partnersettings/partnersettings.js27
-rw-r--r--examples/scopes/scopes.js9
-rw-r--r--examples/stats/stats.js9
-rw-r--r--examples/subusers/subusers.js126
-rw-r--r--examples/suppression/suppression.js153
-rw-r--r--examples/templates/templates.js90
-rw-r--r--examples/trackingsettings/trackingsettings.js81
-rw-r--r--examples/user/user.js189
-rw-r--r--examples/whitelabel/whitelabel.js243
23 files changed, 882 insertions, 1068 deletions
diff --git a/examples/accesssettings/accesssettings.js b/examples/accesssettings/accesssettings.js
index 53f23f8..e94021a 100644
--- a/examples/accesssettings/accesssettings.js
+++ b/examples/accesssettings/accesssettings.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Retrieve all recent access attempts #
-# GET /access_settings/activity #
+///////////////////////////////////////////////////
+// Retrieve all recent access attempts
+// GET /access_settings/activity
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["limit"] = '1'
request.method = 'GET'
request.path = '/v3/access_settings/activity'
@@ -15,12 +14,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Add one or more IPs to the whitelist #
-# POST /access_settings/whitelist #
+///////////////////////////////////////////////////
+// Add one or more IPs to the whitelist
+// POST /access_settings/whitelist
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"ips": [
{
@@ -42,12 +40,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a list of currently whitelisted IPs #
-# GET /access_settings/whitelist #
+///////////////////////////////////////////////////
+// Retrieve a list of currently whitelisted IPs
+// GET /access_settings/whitelist
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/access_settings/whitelist'
sg.API(request, function (response) {
@@ -56,12 +53,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Remove one or more IPs from the whitelist #
-# DELETE /access_settings/whitelist #
+///////////////////////////////////////////////////
+// Remove one or more IPs from the whitelist
+// DELETE /access_settings/whitelist
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"ids": [
1,
@@ -77,12 +73,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a specific whitelisted IP #
-# GET /access_settings/whitelist/{rule_id} #
+///////////////////////////////////////////////////
+// Retrieve a specific whitelisted IP
+// GET /access_settings/whitelist/{rule_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/access_settings/whitelist/{rule_id}'
sg.API(request, function (response) {
@@ -91,12 +86,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Remove a specific IP from the whitelist #
-# DELETE /access_settings/whitelist/{rule_id} #
+///////////////////////////////////////////////////
+// Remove a specific IP from the whitelist
+// DELETE /access_settings/whitelist/{rule_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/access_settings/whitelist/{rule_id}'
sg.API(request, function (response) {
diff --git a/examples/apikeys/apikeys.js b/examples/apikeys/apikeys.js
index ece538d..d7ff328 100644
--- a/examples/apikeys/apikeys.js
+++ b/examples/apikeys/apikeys.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Create API keys #
-# POST /api_keys #
+///////////////////////////////////////////////////
+// Create API keys
+// POST /api_keys
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"name": "My API Key",
"scopes": [
@@ -22,12 +21,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all API Keys belonging to the authenticated user #
-# GET /api_keys #
+///////////////////////////////////////////////////
+// Retrieve all API Keys belonging to the authenticated user
+// GET /api_keys
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/api_keys'
sg.API(request, function (response) {
@@ -36,12 +34,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update the name & scopes of an API Key #
-# PUT /api_keys/{api_key_id} #
+///////////////////////////////////////////////////
+// Update the name & scopes of an API Key
+// PUT /api_keys/{api_key_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"name": "A New Hope",
"scopes": [
@@ -57,12 +54,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update API keys #
-# PATCH /api_keys/{api_key_id} #
+///////////////////////////////////////////////////
+// Update API keys
+// PATCH /api_keys/{api_key_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"name": "A New Hope"
};
@@ -74,12 +70,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve an existing API Key #
-# GET /api_keys/{api_key_id} #
+///////////////////////////////////////////////////
+// Retrieve an existing API Key
+// GET /api_keys/{api_key_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/api_keys/{api_key_id}'
sg.API(request, function (response) {
@@ -88,12 +83,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete API keys #
-# DELETE /api_keys/{api_key_id} #
+///////////////////////////////////////////////////
+// Delete API keys
+// DELETE /api_keys/{api_key_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/api_keys/{api_key_id}'
sg.API(request, function (response) {
diff --git a/examples/asm/asm.js b/examples/asm/asm.js
index 5c2bf35..d8828cd 100644
--- a/examples/asm/asm.js
+++ b/examples/asm/asm.js
@@ -1,15 +1,14 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Create a Group #
-# POST /asm/groups #
+///////////////////////////////////////////////////
+// Create a new suppression group
+// POST /asm/groups
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
- "description": "A group description",
- "is_default": false,
- "name": "A group name"
+ "description": "Suggestions for products our users might like.",
+ "is_default": true,
+ "name": "Product Suggestions"
};
request.method = 'POST'
request.path = '/v3/asm/groups'
@@ -19,12 +18,12 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all suppression groups associated with the user. #
-# GET /asm/groups #
+///////////////////////////////////////////////////
+// Retrieve information about multiple suppression groups
+// GET /asm/groups
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
+request.queryParams["id"] = '1'
request.method = 'GET'
request.path = '/v3/asm/groups'
sg.API(request, function (response) {
@@ -33,12 +32,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update a suppression group. #
-# PATCH /asm/groups/{group_id} #
+///////////////////////////////////////////////////
+// Update a suppression group.
+// PATCH /asm/groups/{group_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"description": "Suggestions for items our users might like.",
"id": 103,
@@ -52,12 +50,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Get information on a single suppression group. #
-# GET /asm/groups/{group_id} #
+///////////////////////////////////////////////////
+// Get information on a single suppression group.
+// GET /asm/groups/{group_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/asm/groups/{group_id}'
sg.API(request, function (response) {
@@ -66,12 +63,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a suppression group. #
-# DELETE /asm/groups/{group_id} #
+///////////////////////////////////////////////////
+// Delete a suppression group.
+// DELETE /asm/groups/{group_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/asm/groups/{group_id}'
sg.API(request, function (response) {
@@ -80,12 +76,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Add suppressions to a suppression group #
-# POST /asm/groups/{group_id}/suppressions #
+///////////////////////////////////////////////////
+// Add suppressions to a suppression group
+// POST /asm/groups/{group_id}/suppressions
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"recipient_emails": [
"test1@example.com",
@@ -100,12 +95,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all suppressions for a suppression group #
-# GET /asm/groups/{group_id}/suppressions #
+///////////////////////////////////////////////////
+// Retrieve all suppressions for a suppression group
+// GET /asm/groups/{group_id}/suppressions
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/asm/groups/{group_id}/suppressions'
sg.API(request, function (response) {
@@ -114,12 +108,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a suppression from a suppression group #
-# DELETE /asm/groups/{group_id}/suppressions/{email} #
+///////////////////////////////////////////////////
+// Delete a suppression from a suppression group
+// DELETE /asm/groups/{group_id}/suppressions/{email}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/asm/groups/{group_id}/suppressions/{email}'
sg.API(request, function (response) {
@@ -128,12 +121,24 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Add recipient addresses to the global suppression group. #
-# POST /asm/suppressions/global #
+///////////////////////////////////////////////////
+// Retrieve all suppressions
+// GET /asm/suppressions
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
+request.method = 'GET'
+request.path = '/v3/asm/suppressions'
+sg.API(request, function (response) {
+ console.log(response.statusCode)
+ console.log(response.body)
+ console.log(response.headers)
+})
+
+///////////////////////////////////////////////////
+// Add recipient addresses to the global suppression group.
+// POST /asm/suppressions/global
+
+var request = sg.emptyRequest
request.body = {
"recipient_emails": [
"test1@example.com",
@@ -148,12 +153,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a Global Suppression #
-# GET /asm/suppressions/global/{email} #
+///////////////////////////////////////////////////
+// Retrieve a Global Suppression
+// GET /asm/suppressions/global/{email}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/asm/suppressions/global/{email}'
sg.API(request, function (response) {
@@ -162,12 +166,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a Global Suppression #
-# DELETE /asm/suppressions/global/{email} #
+///////////////////////////////////////////////////
+// Delete a Global Suppression
+// DELETE /asm/suppressions/global/{email}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/asm/suppressions/global/{email}'
sg.API(request, function (response) {
@@ -176,3 +179,16 @@ sg.API(request, function (response) {
console.log(response.headers)
})
+///////////////////////////////////////////////////
+// Retrieve all suppression groups for an email address
+// GET /asm/suppressions/{email}
+
+var request = sg.emptyRequest
+request.method = 'GET'
+request.path = '/v3/asm/suppressions/{email}'
+sg.API(request, function (response) {
+ console.log(response.statusCode)
+ console.log(response.body)
+ console.log(response.headers)
+})
+
diff --git a/examples/browsers/browsers.js b/examples/browsers/browsers.js
index e3cd6c2..a2fab23 100644
--- a/examples/browsers/browsers.js
+++ b/examples/browsers/browsers.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Retrieve email statistics by browser. #
-# GET /browsers/stats #
+///////////////////////////////////////////////////
+// Retrieve email statistics by browser.
+// GET /browsers/stats
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["end_date"] = '2016-04-01'
request.queryParams["aggregated_by"] = 'day'
request.queryParams["browsers"] = 'test_string'
diff --git a/examples/campaigns/campaigns.js b/examples/campaigns/campaigns.js
index fc788ff..38a83e8 100644
--- a/examples/campaigns/campaigns.js
+++ b/examples/campaigns/campaigns.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Create a Campaign #
-# POST /campaigns #
+///////////////////////////////////////////////////
+// Create a Campaign
+// POST /campaigns
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"categories": [
"spring line"
@@ -34,12 +33,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all Campaigns #
-# GET /campaigns #
+///////////////////////////////////////////////////
+// Retrieve all Campaigns
+// GET /campaigns
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["limit"] = '0'
request.queryParams["offset"] = '0'
request.method = 'GET'
@@ -50,12 +48,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update a Campaign #
-# PATCH /campaigns/{campaign_id} #
+///////////////////////////////////////////////////
+// Update a Campaign
+// PATCH /campaigns/{campaign_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"categories": [
"summer line"
@@ -73,12 +70,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a single campaign #
-# GET /campaigns/{campaign_id} #
+///////////////////////////////////////////////////
+// Retrieve a single campaign
+// GET /campaigns/{campaign_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/campaigns/{campaign_id}'
sg.API(request, function (response) {
@@ -87,12 +83,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a Campaign #
-# DELETE /campaigns/{campaign_id} #
+///////////////////////////////////////////////////
+// Delete a Campaign
+// DELETE /campaigns/{campaign_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/campaigns/{campaign_id}'
sg.API(request, function (response) {
@@ -101,12 +96,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update a Scheduled Campaign #
-# PATCH /campaigns/{campaign_id}/schedules #
+///////////////////////////////////////////////////
+// Update a Scheduled Campaign
+// PATCH /campaigns/{campaign_id}/schedules
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"send_at": 1489451436
};
@@ -118,12 +112,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Schedule a Campaign #
-# POST /campaigns/{campaign_id}/schedules #
+///////////////////////////////////////////////////
+// Schedule a Campaign
+// POST /campaigns/{campaign_id}/schedules
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"send_at": 1489771528
};
@@ -135,12 +128,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# View Scheduled Time of a Campaign #
-# GET /campaigns/{campaign_id}/schedules #
+///////////////////////////////////////////////////
+// View Scheduled Time of a Campaign
+// GET /campaigns/{campaign_id}/schedules
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/campaigns/{campaign_id}/schedules'
sg.API(request, function (response) {
@@ -149,12 +141,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Unschedule a Scheduled Campaign #
-# DELETE /campaigns/{campaign_id}/schedules #
+///////////////////////////////////////////////////
+// Unschedule a Scheduled Campaign
+// DELETE /campaigns/{campaign_id}/schedules
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/campaigns/{campaign_id}/schedules'
sg.API(request, function (response) {
@@ -163,12 +154,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Send a Campaign #
-# POST /campaigns/{campaign_id}/schedules/now #
+///////////////////////////////////////////////////
+// Send a Campaign
+// POST /campaigns/{campaign_id}/schedules/now
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'POST'
request.path = '/v3/campaigns/{campaign_id}/schedules/now'
sg.API(request, function (response) {
@@ -177,12 +167,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Send a Test Campaign #
-# POST /campaigns/{campaign_id}/schedules/test #
+///////////////////////////////////////////////////
+// Send a Test Campaign
+// POST /campaigns/{campaign_id}/schedules/test
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"to": "your.email@example.com"
};
diff --git a/examples/categories/categories.js b/examples/categories/categories.js
index 7928953..e9d2153 100644
--- a/examples/categories/categories.js
+++ b/examples/categories/categories.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Retrieve all categories #
-# GET /categories #
+///////////////////////////////////////////////////
+// Retrieve all categories
+// GET /categories
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["category"] = 'test_string'
request.queryParams["limit"] = '1'
request.queryParams["offset"] = '1'
@@ -17,12 +16,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve Email Statistics for Categories #
-# GET /categories/stats #
+///////////////////////////////////////////////////
+// Retrieve Email Statistics for Categories
+// GET /categories/stats
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["end_date"] = '2016-04-01'
request.queryParams["aggregated_by"] = 'day'
request.queryParams["limit"] = '1'
@@ -37,12 +35,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve sums of email stats for each category [Needs: Stats object defined, has category ID?] #
-# GET /categories/stats/sums #
+///////////////////////////////////////////////////
+// Retrieve sums of email stats for each category [Needs: Stats object defined, has category ID?]
+// GET /categories/stats/sums
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["end_date"] = '2016-04-01'
request.queryParams["aggregated_by"] = 'day'
request.queryParams["limit"] = '1'
diff --git a/examples/clients/clients.js b/examples/clients/clients.js
index ca95658..4cd8cae 100644
--- a/examples/clients/clients.js
+++ b/examples/clients/clients.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Retrieve email statistics by client type. #
-# GET /clients/stats #
+///////////////////////////////////////////////////
+// Retrieve email statistics by client type.
+// GET /clients/stats
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["aggregated_by"] = 'day'
request.queryParams["start_date"] = '2016-01-01'
request.queryParams["end_date"] = '2016-04-01'
@@ -17,12 +16,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve stats by a specific client type. #
-# GET /clients/{client_type}/stats #
+///////////////////////////////////////////////////
+// Retrieve stats by a specific client type.
+// GET /clients/{client_type}/stats
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["aggregated_by"] = 'day'
request.queryParams["start_date"] = '2016-01-01'
request.queryParams["end_date"] = '2016-04-01'
diff --git a/examples/contactdb/contactdb.js b/examples/contactdb/contactdb.js
index 06e459b..cc73c16 100644
--- a/examples/contactdb/contactdb.js
+++ b/examples/contactdb/contactdb.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Create a Custom Field #
-# POST /contactdb/custom_fields #
+///////////////////////////////////////////////////
+// Create a Custom Field
+// POST /contactdb/custom_fields
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"name": "pet",
"type": "text"
@@ -18,12 +17,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all custom fields #
-# GET /contactdb/custom_fields #
+///////////////////////////////////////////////////
+// Retrieve all custom fields
+// GET /contactdb/custom_fields
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/contactdb/custom_fields'
sg.API(request, function (response) {
@@ -32,12 +30,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a Custom Field #
-# GET /contactdb/custom_fields/{custom_field_id} #
+///////////////////////////////////////////////////
+// Retrieve a Custom Field
+// GET /contactdb/custom_fields/{custom_field_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/contactdb/custom_fields/{custom_field_id}'
sg.API(request, function (response) {
@@ -46,12 +43,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a Custom Field #
-# DELETE /contactdb/custom_fields/{custom_field_id} #
+///////////////////////////////////////////////////
+// Delete a Custom Field
+// DELETE /contactdb/custom_fields/{custom_field_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/contactdb/custom_fields/{custom_field_id}'
sg.API(request, function (response) {
@@ -60,12 +56,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Create a List #
-# POST /contactdb/lists #
+///////////////////////////////////////////////////
+// Create a List
+// POST /contactdb/lists
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"name": "your list name"
};
@@ -77,12 +72,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all lists #
-# GET /contactdb/lists #
+///////////////////////////////////////////////////
+// Retrieve all lists
+// GET /contactdb/lists
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/contactdb/lists'
sg.API(request, function (response) {
@@ -91,12 +85,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete Multiple lists #
-# DELETE /contactdb/lists #
+///////////////////////////////////////////////////
+// Delete Multiple lists
+// DELETE /contactdb/lists
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = [
1,
2,
@@ -111,12 +104,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update a List #
-# PATCH /contactdb/lists/{list_id} #
+///////////////////////////////////////////////////
+// Update a List
+// PATCH /contactdb/lists/{list_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"name": "newlistname"
};
@@ -129,12 +121,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a single list #
-# GET /contactdb/lists/{list_id} #
+///////////////////////////////////////////////////
+// Retrieve a single list
+// GET /contactdb/lists/{list_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["list_id"] = '0'
request.method = 'GET'
request.path = '/v3/contactdb/lists/{list_id}'
@@ -144,12 +135,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a List #
-# DELETE /contactdb/lists/{list_id} #
+///////////////////////////////////////////////////
+// Delete a List
+// DELETE /contactdb/lists/{list_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["delete_contacts"] = 'true'
request.method = 'DELETE'
request.path = '/v3/contactdb/lists/{list_id}'
@@ -159,12 +149,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Add Multiple Recipients to a List #
-# POST /contactdb/lists/{list_id}/recipients #
+///////////////////////////////////////////////////
+// Add Multiple Recipients to a List
+// POST /contactdb/lists/{list_id}/recipients
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = [
"recipient_id1",
"recipient_id2"
@@ -177,12 +166,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all recipients on a List #
-# GET /contactdb/lists/{list_id}/recipients #
+///////////////////////////////////////////////////
+// Retrieve all recipients on a List
+// GET /contactdb/lists/{list_id}/recipients
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["page"] = '1'
request.queryParams["page_size"] = '1'
request.queryParams["list_id"] = '0'
@@ -194,12 +182,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Add a Single Recipient to a List #
-# POST /contactdb/lists/{list_id}/recipients/{recipient_id} #
+///////////////////////////////////////////////////
+// Add a Single Recipient to a List
+// POST /contactdb/lists/{list_id}/recipients/{recipient_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'POST'
request.path = '/v3/contactdb/lists/{list_id}/recipients/{recipient_id}'
sg.API(request, function (response) {
@@ -208,12 +195,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a Single Recipient from a Single List #
-# DELETE /contactdb/lists/{list_id}/recipients/{recipient_id} #
+///////////////////////////////////////////////////
+// Delete a Single Recipient from a Single List
+// DELETE /contactdb/lists/{list_id}/recipients/{recipient_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["recipient_id"] = '0'
request.queryParams["list_id"] = '0'
request.method = 'DELETE'
@@ -224,12 +210,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update Recipient #
-# PATCH /contactdb/recipients #
+///////////////////////////////////////////////////
+// Update Recipient
+// PATCH /contactdb/recipients
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = [
{
"email": "jones@example.com",
@@ -245,12 +230,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Add recipients #
-# POST /contactdb/recipients #
+///////////////////////////////////////////////////
+// Add recipients
+// POST /contactdb/recipients
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = [
{
"age": 25,
@@ -273,12 +257,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve recipients #
-# GET /contactdb/recipients #
+///////////////////////////////////////////////////
+// Retrieve recipients
+// GET /contactdb/recipients
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["page"] = '1'
request.queryParams["page_size"] = '1'
request.method = 'GET'
@@ -289,12 +272,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete Recipient #
-# DELETE /contactdb/recipients #
+///////////////////////////////////////////////////
+// Delete Recipient
+// DELETE /contactdb/recipients
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = [
"recipient_id1",
"recipient_id2"
@@ -307,12 +289,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve the count of billable recipients #
-# GET /contactdb/recipients/billable_count #
+///////////////////////////////////////////////////
+// Retrieve the count of billable recipients
+// GET /contactdb/recipients/billable_count
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/contactdb/recipients/billable_count'
sg.API(request, function (response) {
@@ -321,12 +302,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a Count of Recipients #
-# GET /contactdb/recipients/count #
+///////////////////////////////////////////////////
+// Retrieve a Count of Recipients
+// GET /contactdb/recipients/count
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/contactdb/recipients/count'
sg.API(request, function (response) {
@@ -335,12 +315,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve recipients matching search criteria #
-# GET /contactdb/recipients/search #
+///////////////////////////////////////////////////
+// Retrieve recipients matching search criteria
+// GET /contactdb/recipients/search
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["{field_name}"] = 'test_string'
request.method = 'GET'
request.path = '/v3/contactdb/recipients/search'
@@ -350,12 +329,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a single recipient #
-# GET /contactdb/recipients/{recipient_id} #
+///////////////////////////////////////////////////
+// Retrieve a single recipient
+// GET /contactdb/recipients/{recipient_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/contactdb/recipients/{recipient_id}'
sg.API(request, function (response) {
@@ -364,12 +342,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a Recipient #
-# DELETE /contactdb/recipients/{recipient_id} #
+///////////////////////////////////////////////////
+// Delete a Recipient
+// DELETE /contactdb/recipients/{recipient_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/contactdb/recipients/{recipient_id}'
sg.API(request, function (response) {
@@ -378,12 +355,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve the lists that a recipient is on #
-# GET /contactdb/recipients/{recipient_id}/lists #
+///////////////////////////////////////////////////
+// Retrieve the lists that a recipient is on
+// GET /contactdb/recipients/{recipient_id}/lists
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/contactdb/recipients/{recipient_id}/lists'
sg.API(request, function (response) {
@@ -392,12 +368,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve reserved fields #
-# GET /contactdb/reserved_fields #
+///////////////////////////////////////////////////
+// Retrieve reserved fields
+// GET /contactdb/reserved_fields
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/contactdb/reserved_fields'
sg.API(request, function (response) {
@@ -406,12 +381,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Create a Segment #
-# POST /contactdb/segments #
+///////////////////////////////////////////////////
+// Create a Segment
+// POST /contactdb/segments
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"conditions": [
{
@@ -444,12 +418,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all segments #
-# GET /contactdb/segments #
+///////////////////////////////////////////////////
+// Retrieve all segments
+// GET /contactdb/segments
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/contactdb/segments'
sg.API(request, function (response) {
@@ -458,12 +431,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update a segment #
-# PATCH /contactdb/segments/{segment_id} #
+///////////////////////////////////////////////////
+// Update a segment
+// PATCH /contactdb/segments/{segment_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"conditions": [
{
@@ -485,12 +457,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a segment #
-# GET /contactdb/segments/{segment_id} #
+///////////////////////////////////////////////////
+// Retrieve a segment
+// GET /contactdb/segments/{segment_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["segment_id"] = '0'
request.method = 'GET'
request.path = '/v3/contactdb/segments/{segment_id}'
@@ -500,12 +471,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a segment #
-# DELETE /contactdb/segments/{segment_id} #
+///////////////////////////////////////////////////
+// Delete a segment
+// DELETE /contactdb/segments/{segment_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["delete_contacts"] = 'true'
request.method = 'DELETE'
request.path = '/v3/contactdb/segments/{segment_id}'
@@ -515,12 +485,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve recipients on a segment #
-# GET /contactdb/segments/{segment_id}/recipients #
+///////////////////////////////////////////////////
+// Retrieve recipients on a segment
+// GET /contactdb/segments/{segment_id}/recipients
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["page"] = '1'
request.queryParams["page_size"] = '1'
request.method = 'GET'
diff --git a/examples/devices/devices.js b/examples/devices/devices.js
index a94828b..2dbf30b 100644
--- a/examples/devices/devices.js
+++ b/examples/devices/devices.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Retrieve email statistics by device type. #
-# GET /devices/stats #
+///////////////////////////////////////////////////
+// Retrieve email statistics by device type.
+// GET /devices/stats
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["aggregated_by"] = 'day'
request.queryParams["limit"] = '1'
request.queryParams["start_date"] = '2016-01-01'
diff --git a/examples/geo/geo.js b/examples/geo/geo.js
index 2b5cbc5..df1e768 100644
--- a/examples/geo/geo.js
+++ b/examples/geo/geo.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Retrieve email statistics by country and state/province. #
-# GET /geo/stats #
+///////////////////////////////////////////////////
+// Retrieve email statistics by country and state/province.
+// GET /geo/stats
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["end_date"] = '2016-04-01'
request.queryParams["country"] = 'US'
request.queryParams["aggregated_by"] = 'day'
diff --git a/examples/ips/ips.js b/examples/ips/ips.js
index 457eab4..6d66173 100644
--- a/examples/ips/ips.js
+++ b/examples/ips/ips.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Retrieve all IP addresses #
-# GET /ips #
+///////////////////////////////////////////////////
+// Retrieve all IP addresses
+// GET /ips
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["subuser"] = 'test_string'
request.queryParams["ip"] = 'test_string'
request.queryParams["limit"] = '1'
@@ -19,12 +18,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all assigned IPs #
-# GET /ips/assigned #
+///////////////////////////////////////////////////
+// Retrieve all assigned IPs
+// GET /ips/assigned
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/ips/assigned'
sg.API(request, function (response) {
@@ -33,12 +31,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Create an IP pool. #
-# POST /ips/pools #
+///////////////////////////////////////////////////
+// Create an IP pool.
+// POST /ips/pools
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"name": "marketing"
};
@@ -50,12 +47,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all IP pools. #
-# GET /ips/pools #
+///////////////////////////////////////////////////
+// Retrieve all IP pools.
+// GET /ips/pools
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/ips/pools'
sg.API(request, function (response) {
@@ -64,12 +60,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update an IP pools name. #
-# PUT /ips/pools/{pool_name} #
+///////////////////////////////////////////////////
+// Update an IP pools name.
+// PUT /ips/pools/{pool_name}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"name": "new_pool_name"
};
@@ -81,12 +76,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all IPs in a specified pool. #
-# GET /ips/pools/{pool_name} #
+///////////////////////////////////////////////////
+// Retrieve all IPs in a specified pool.
+// GET /ips/pools/{pool_name}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/ips/pools/{pool_name}'
sg.API(request, function (response) {
@@ -95,12 +89,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete an IP pool. #
-# DELETE /ips/pools/{pool_name} #
+///////////////////////////////////////////////////
+// Delete an IP pool.
+// DELETE /ips/pools/{pool_name}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/ips/pools/{pool_name}'
sg.API(request, function (response) {
@@ -109,12 +102,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Add an IP address to a pool #
-# POST /ips/pools/{pool_name}/ips #
+///////////////////////////////////////////////////
+// Add an IP address to a pool
+// POST /ips/pools/{pool_name}/ips
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"ip": "0.0.0.0"
};
@@ -126,12 +118,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Remove an IP address from a pool. #
-# DELETE /ips/pools/{pool_name}/ips/{ip} #
+///////////////////////////////////////////////////
+// Remove an IP address from a pool.
+// DELETE /ips/pools/{pool_name}/ips/{ip}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/ips/pools/{pool_name}/ips/{ip}'
sg.API(request, function (response) {
@@ -140,12 +131,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Add an IP to warmup #
-# POST /ips/warmup #
+///////////////////////////////////////////////////
+// Add an IP to warmup
+// POST /ips/warmup
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"ip": "0.0.0.0"
};
@@ -157,12 +147,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all IPs currently in warmup #
-# GET /ips/warmup #
+///////////////////////////////////////////////////
+// Retrieve all IPs currently in warmup
+// GET /ips/warmup
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/ips/warmup'
sg.API(request, function (response) {
@@ -171,12 +160,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve warmup status for a specific IP address #
-# GET /ips/warmup/{ip_address} #
+///////////////////////////////////////////////////
+// Retrieve warmup status for a specific IP address
+// GET /ips/warmup/{ip_address}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/ips/warmup/{ip_address}'
sg.API(request, function (response) {
@@ -185,12 +173,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Remove an IP from warmup #
-# DELETE /ips/warmup/{ip_address} #
+///////////////////////////////////////////////////
+// Remove an IP from warmup
+// DELETE /ips/warmup/{ip_address}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/ips/warmup/{ip_address}'
sg.API(request, function (response) {
@@ -199,12 +186,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all IP pools an IP address belongs to #
-# GET /ips/{ip_address} #
+///////////////////////////////////////////////////
+// Retrieve all IP pools an IP address belongs to
+// GET /ips/{ip_address}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/ips/{ip_address}'
sg.API(request, function (response) {
diff --git a/examples/mail/mail.js b/examples/mail/mail.js
index ee133b3..0301c8f 100644
--- a/examples/mail/mail.js
+++ b/examples/mail/mail.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Create a batch ID #
-# POST /mail/batch #
+///////////////////////////////////////////////////
+// Create a batch ID
+// POST /mail/batch
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'POST'
request.path = '/v3/mail/batch'
sg.API(request, function (response) {
@@ -14,12 +13,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Validate batch ID #
-# GET /mail/batch/{batch_id} #
+///////////////////////////////////////////////////
+// Validate batch ID
+// GET /mail/batch/{batch_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/mail/batch/{batch_id}'
sg.API(request, function (response) {
@@ -28,12 +26,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# v3 Mail Send Beta #
-# POST /mail/send/beta #
+///////////////////////////////////////////////////
+// v3 Mail Send Beta
+// POST /mail/send/beta
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"asm": {
"group_id": 1,
diff --git a/examples/mailboxproviders/mailboxproviders.js b/examples/mailboxproviders/mailboxproviders.js
index 2eb5304..604cf40 100644
--- a/examples/mailboxproviders/mailboxproviders.js
+++ b/examples/mailboxproviders/mailboxproviders.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Retrieve email statistics by mailbox provider. #
-# GET /mailbox_providers/stats #
+///////////////////////////////////////////////////
+// Retrieve email statistics by mailbox provider.
+// GET /mailbox_providers/stats
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["end_date"] = '2016-04-01'
request.queryParams["mailbox_providers"] = 'test_string'
request.queryParams["aggregated_by"] = 'day'
diff --git a/examples/mailsettings/mailsettings.js b/examples/mailsettings/mailsettings.js
index 1d87c72..d9ae91a 100644
--- a/examples/mailsettings/mailsettings.js
+++ b/examples/mailsettings/mailsettings.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Retrieve all mail settings #
-# GET /mail_settings #
+///////////////////////////////////////////////////
+// Retrieve all mail settings
+// GET /mail_settings
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["limit"] = '1'
request.queryParams["offset"] = '1'
request.method = 'GET'
@@ -16,12 +15,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update address whitelist mail settings #
-# PATCH /mail_settings/address_whitelist #
+///////////////////////////////////////////////////
+// Update address whitelist mail settings
+// PATCH /mail_settings/address_whitelist
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"enabled": true,
"list": [
@@ -37,12 +35,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve address whitelist mail settings #
-# GET /mail_settings/address_whitelist #
+///////////////////////////////////////////////////
+// Retrieve address whitelist mail settings
+// GET /mail_settings/address_whitelist
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/mail_settings/address_whitelist'
sg.API(request, function (response) {
@@ -51,12 +48,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update BCC mail settings #
-# PATCH /mail_settings/bcc #
+///////////////////////////////////////////////////
+// Update BCC mail settings
+// PATCH /mail_settings/bcc
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"email": "email@example.com",
"enabled": false
@@ -69,12 +65,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all BCC mail settings #
-# GET /mail_settings/bcc #
+///////////////////////////////////////////////////
+// Retrieve all BCC mail settings
+// GET /mail_settings/bcc
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/mail_settings/bcc'
sg.API(request, function (response) {
@@ -83,12 +78,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update bounce purge mail settings #
-# PATCH /mail_settings/bounce_purge #
+///////////////////////////////////////////////////
+// Update bounce purge mail settings
+// PATCH /mail_settings/bounce_purge
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"enabled": true,
"hard_bounces": 5,
@@ -102,12 +96,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve bounce purge mail settings #
-# GET /mail_settings/bounce_purge #
+///////////////////////////////////////////////////
+// Retrieve bounce purge mail settings
+// GET /mail_settings/bounce_purge
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/mail_settings/bounce_purge'
sg.API(request, function (response) {
@@ -116,12 +109,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update footer mail settings #
-# PATCH /mail_settings/footer #
+///////////////////////////////////////////////////
+// Update footer mail settings
+// PATCH /mail_settings/footer
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"enabled": true,
"html_content": "...",
@@ -135,12 +127,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve footer mail settings #
-# GET /mail_settings/footer #
+///////////////////////////////////////////////////
+// Retrieve footer mail settings
+// GET /mail_settings/footer
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/mail_settings/footer'
sg.API(request, function (response) {
@@ -149,12 +140,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update forward bounce mail settings #
-# PATCH /mail_settings/forward_bounce #
+///////////////////////////////////////////////////
+// Update forward bounce mail settings
+// PATCH /mail_settings/forward_bounce
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"email": "example@example.com",
"enabled": true
@@ -167,12 +157,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve forward bounce mail settings #
-# GET /mail_settings/forward_bounce #
+///////////////////////////////////////////////////
+// Retrieve forward bounce mail settings
+// GET /mail_settings/forward_bounce
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/mail_settings/forward_bounce'
sg.API(request, function (response) {
@@ -181,12 +170,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update forward spam mail settings #
-# PATCH /mail_settings/forward_spam #
+///////////////////////////////////////////////////
+// Update forward spam mail settings
+// PATCH /mail_settings/forward_spam
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"email": "",
"enabled": false
@@ -199,12 +187,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve forward spam mail settings #
-# GET /mail_settings/forward_spam #
+///////////////////////////////////////////////////
+// Retrieve forward spam mail settings
+// GET /mail_settings/forward_spam
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/mail_settings/forward_spam'
sg.API(request, function (response) {
@@ -213,12 +200,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update plain content mail settings #
-# PATCH /mail_settings/plain_content #
+///////////////////////////////////////////////////
+// Update plain content mail settings
+// PATCH /mail_settings/plain_content
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"enabled": false
};
@@ -230,12 +216,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve plain content mail settings #
-# GET /mail_settings/plain_content #
+///////////////////////////////////////////////////
+// Retrieve plain content mail settings
+// GET /mail_settings/plain_content
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/mail_settings/plain_content'
sg.API(request, function (response) {
@@ -244,12 +229,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update spam check mail settings #
-# PATCH /mail_settings/spam_check #
+///////////////////////////////////////////////////
+// Update spam check mail settings
+// PATCH /mail_settings/spam_check
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"enabled": true,
"max_score": 5,
@@ -263,12 +247,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve spam check mail settings #
-# GET /mail_settings/spam_check #
+///////////////////////////////////////////////////
+// Retrieve spam check mail settings
+// GET /mail_settings/spam_check
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/mail_settings/spam_check'
sg.API(request, function (response) {
@@ -277,12 +260,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update template mail settings #
-# PATCH /mail_settings/template #
+///////////////////////////////////////////////////
+// Update template mail settings
+// PATCH /mail_settings/template
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"enabled": true,
"html_content": "<% body %>"
@@ -295,12 +277,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve legacy template mail settings #
-# GET /mail_settings/template #
+///////////////////////////////////////////////////
+// Retrieve legacy template mail settings
+// GET /mail_settings/template
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/mail_settings/template'
sg.API(request, function (response) {
diff --git a/examples/partnersettings/partnersettings.js b/examples/partnersettings/partnersettings.js
index 617dc45..0b2239a 100644
--- a/examples/partnersettings/partnersettings.js
+++ b/examples/partnersettings/partnersettings.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Returns a list of all partner settings. #
-# GET /partner_settings #
+///////////////////////////////////////////////////
+// Returns a list of all partner settings.
+// GET /partner_settings
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["limit"] = '1'
request.queryParams["offset"] = '1'
request.method = 'GET'
@@ -16,12 +15,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Updates New Relic partner settings. #
-# PATCH /partner_settings/new_relic #
+///////////////////////////////////////////////////
+// Updates New Relic partner settings.
+// PATCH /partner_settings/new_relic
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"enable_subuser_statistics": true,
"enabled": true,
@@ -35,12 +33,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Returns all New Relic partner settings. #
-# GET /partner_settings/new_relic #
+///////////////////////////////////////////////////
+// Returns all New Relic partner settings.
+// GET /partner_settings/new_relic
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/partner_settings/new_relic'
sg.API(request, function (response) {
diff --git a/examples/scopes/scopes.js b/examples/scopes/scopes.js
index 008f4d0..d5545bf 100644
--- a/examples/scopes/scopes.js
+++ b/examples/scopes/scopes.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Retrieve a list of scopes for which this user has access. #
-# GET /scopes #
+///////////////////////////////////////////////////
+// Retrieve a list of scopes for which this user has access.
+// GET /scopes
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/scopes'
sg.API(request, function (response) {
diff --git a/examples/stats/stats.js b/examples/stats/stats.js
index 1dc8f9a..e1ca239 100644
--- a/examples/stats/stats.js
+++ b/examples/stats/stats.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Retrieve global email statistics #
-# GET /stats #
+///////////////////////////////////////////////////
+// Retrieve global email statistics
+// GET /stats
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["aggregated_by"] = 'day'
request.queryParams["limit"] = '1'
request.queryParams["start_date"] = '2016-01-01'
diff --git a/examples/subusers/subusers.js b/examples/subusers/subusers.js
index 3926c91..cd57de4 100644
--- a/examples/subusers/subusers.js
+++ b/examples/subusers/subusers.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Create Subuser #
-# POST /subusers #
+///////////////////////////////////////////////////
+// Create Subuser
+// POST /subusers
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"email": "John@example.com",
"ips": [
@@ -23,12 +22,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# List all Subusers #
-# GET /subusers #
+///////////////////////////////////////////////////
+// List all Subusers
+// GET /subusers
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["username"] = 'test_string'
request.queryParams["limit"] = '0'
request.queryParams["offset"] = '0'
@@ -40,12 +38,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve Subuser Reputations #
-# GET /subusers/reputations #
+///////////////////////////////////////////////////
+// Retrieve Subuser Reputations
+// GET /subusers/reputations
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["usernames"] = 'test_string'
request.method = 'GET'
request.path = '/v3/subusers/reputations'
@@ -55,12 +52,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve email statistics for your subusers. #
-# GET /subusers/stats #
+///////////////////////////////////////////////////
+// Retrieve email statistics for your subusers.
+// GET /subusers/stats
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["end_date"] = '2016-04-01'
request.queryParams["aggregated_by"] = 'day'
request.queryParams["limit"] = '1'
@@ -75,12 +71,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve monthly stats for all subusers #
-# GET /subusers/stats/monthly #
+///////////////////////////////////////////////////
+// Retrieve monthly stats for all subusers
+// GET /subusers/stats/monthly
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["subuser"] = 'test_string'
request.queryParams["limit"] = '1'
request.queryParams["sort_by_metric"] = 'test_string'
@@ -95,12 +90,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve the totals for each email statistic metric for all subusers. #
-# GET /subusers/stats/sums #
+///////////////////////////////////////////////////
+// Retrieve the totals for each email statistic metric for all subusers.
+// GET /subusers/stats/sums
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["end_date"] = '2016-04-01'
request.queryParams["aggregated_by"] = 'day'
request.queryParams["limit"] = '1'
@@ -116,12 +110,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Enable/disable a subuser #
-# PATCH /subusers/{subuser_name} #
+///////////////////////////////////////////////////
+// Enable/disable a subuser
+// PATCH /subusers/{subuser_name}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"disabled": false
};
@@ -133,12 +126,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a subuser #
-# DELETE /subusers/{subuser_name} #
+///////////////////////////////////////////////////
+// Delete a subuser
+// DELETE /subusers/{subuser_name}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/subusers/{subuser_name}'
sg.API(request, function (response) {
@@ -147,12 +139,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update IPs assigned to a subuser #
-# PUT /subusers/{subuser_name}/ips #
+///////////////////////////////////////////////////
+// Update IPs assigned to a subuser
+// PUT /subusers/{subuser_name}/ips
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = [
"127.0.0.1"
];
@@ -164,12 +155,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update Monitor Settings for a subuser #
-# PUT /subusers/{subuser_name}/monitor #
+///////////////////////////////////////////////////
+// Update Monitor Settings for a subuser
+// PUT /subusers/{subuser_name}/monitor
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"email": "example@example.com",
"frequency": 500
@@ -182,12 +172,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Create monitor settings #
-# POST /subusers/{subuser_name}/monitor #
+///////////////////////////////////////////////////
+// Create monitor settings
+// POST /subusers/{subuser_name}/monitor
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"email": "example@example.com",
"frequency": 50000
@@ -200,12 +189,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve monitor settings for a subuser #
-# GET /subusers/{subuser_name}/monitor #
+///////////////////////////////////////////////////
+// Retrieve monitor settings for a subuser
+// GET /subusers/{subuser_name}/monitor
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/subusers/{subuser_name}/monitor'
sg.API(request, function (response) {
@@ -214,12 +202,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete monitor settings #
-# DELETE /subusers/{subuser_name}/monitor #
+///////////////////////////////////////////////////
+// Delete monitor settings
+// DELETE /subusers/{subuser_name}/monitor
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/subusers/{subuser_name}/monitor'
sg.API(request, function (response) {
@@ -228,12 +215,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve the monthly email statistics for a single subuser #
-# GET /subusers/{subuser_name}/stats/monthly #
+///////////////////////////////////////////////////
+// Retrieve the monthly email statistics for a single subuser
+// GET /subusers/{subuser_name}/stats/monthly
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["date"] = 'test_string'
request.queryParams["sort_by_direction"] = 'asc'
request.queryParams["limit"] = '0'
diff --git a/examples/suppression/suppression.js b/examples/suppression/suppression.js
index 9d5ee49..e91a9f0 100644
--- a/examples/suppression/suppression.js
+++ b/examples/suppression/suppression.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Retrieve all blocks #
-# GET /suppression/blocks #
+///////////////////////////////////////////////////
+// Retrieve all blocks
+// GET /suppression/blocks
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["start_time"] = '1'
request.queryParams["limit"] = '1'
request.queryParams["end_time"] = '1'
@@ -18,12 +17,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete blocks #
-# DELETE /suppression/blocks #
+///////////////////////////////////////////////////
+// Delete blocks
+// DELETE /suppression/blocks
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"delete_all": false,
"emails": [
@@ -39,12 +37,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a specific block #
-# GET /suppression/blocks/{email} #
+///////////////////////////////////////////////////
+// Retrieve a specific block
+// GET /suppression/blocks/{email}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/suppression/blocks/{email}'
sg.API(request, function (response) {
@@ -53,12 +50,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a specific block #
-# DELETE /suppression/blocks/{email} #
+///////////////////////////////////////////////////
+// Delete a specific block
+// DELETE /suppression/blocks/{email}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/suppression/blocks/{email}'
sg.API(request, function (response) {
@@ -67,12 +63,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all bounces #
-# GET /suppression/bounces #
+///////////////////////////////////////////////////
+// Retrieve all bounces
+// GET /suppression/bounces
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["start_time"] = '0'
request.queryParams["end_time"] = '0'
request.method = 'GET'
@@ -83,12 +78,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete bounces #
-# DELETE /suppression/bounces #
+///////////////////////////////////////////////////
+// Delete bounces
+// DELETE /suppression/bounces
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"delete_all": true,
"emails": [
@@ -104,12 +98,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a Bounce #
-# GET /suppression/bounces/{email} #
+///////////////////////////////////////////////////
+// Retrieve a Bounce
+// GET /suppression/bounces/{email}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/suppression/bounces/{email}'
sg.API(request, function (response) {
@@ -118,12 +111,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a bounce #
-# DELETE /suppression/bounces/{email} #
+///////////////////////////////////////////////////
+// Delete a bounce
+// DELETE /suppression/bounces/{email}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["email_address"] = 'example@example.com'
request.method = 'DELETE'
request.path = '/v3/suppression/bounces/{email}'
@@ -133,12 +125,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all invalid emails #
-# GET /suppression/invalid_emails #
+///////////////////////////////////////////////////
+// Retrieve all invalid emails
+// GET /suppression/invalid_emails
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["start_time"] = '1'
request.queryParams["limit"] = '1'
request.queryParams["end_time"] = '1'
@@ -151,12 +142,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete invalid emails #
-# DELETE /suppression/invalid_emails #
+///////////////////////////////////////////////////
+// Delete invalid emails
+// DELETE /suppression/invalid_emails
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"delete_all": false,
"emails": [
@@ -172,12 +162,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a specific invalid email #
-# GET /suppression/invalid_emails/{email} #
+///////////////////////////////////////////////////
+// Retrieve a specific invalid email
+// GET /suppression/invalid_emails/{email}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/suppression/invalid_emails/{email}'
sg.API(request, function (response) {
@@ -186,12 +175,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a specific invalid email #
-# DELETE /suppression/invalid_emails/{email} #
+///////////////////////////////////////////////////
+// Delete a specific invalid email
+// DELETE /suppression/invalid_emails/{email}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/suppression/invalid_emails/{email}'
sg.API(request, function (response) {
@@ -200,12 +188,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a specific spam report #
-# GET /suppression/spam_report/{email} #
+///////////////////////////////////////////////////
+// Retrieve a specific spam report
+// GET /suppression/spam_report/{email}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/suppression/spam_report/{email}'
sg.API(request, function (response) {
@@ -214,12 +201,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a specific spam report #
-# DELETE /suppression/spam_report/{email} #
+///////////////////////////////////////////////////
+// Delete a specific spam report
+// DELETE /suppression/spam_report/{email}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/suppression/spam_report/{email}'
sg.API(request, function (response) {
@@ -228,12 +214,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all spam reports #
-# GET /suppression/spam_reports #
+///////////////////////////////////////////////////
+// Retrieve all spam reports
+// GET /suppression/spam_reports
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["start_time"] = '1'
request.queryParams["limit"] = '1'
request.queryParams["end_time"] = '1'
@@ -246,12 +231,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete spam reports #
-# DELETE /suppression/spam_reports #
+///////////////////////////////////////////////////
+// Delete spam reports
+// DELETE /suppression/spam_reports
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"delete_all": false,
"emails": [
@@ -267,12 +251,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all global suppressions #
-# GET /suppression/unsubscribes #
+///////////////////////////////////////////////////
+// Retrieve all global suppressions
+// GET /suppression/unsubscribes
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["start_time"] = '1'
request.queryParams["limit"] = '1'
request.queryParams["end_time"] = '1'
diff --git a/examples/templates/templates.js b/examples/templates/templates.js
index c529523..5f8bd07 100644
--- a/examples/templates/templates.js
+++ b/examples/templates/templates.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Create a transactional template. #
-# POST /templates #
+///////////////////////////////////////////////////
+// Create a transactional template.
+// POST /templates
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"name": "example_name"
};
@@ -17,12 +16,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all transactional templates. #
-# GET /templates #
+///////////////////////////////////////////////////
+// Retrieve all transactional templates.
+// GET /templates
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/templates'
sg.API(request, function (response) {
@@ -31,12 +29,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Edit a transactional template. #
-# PATCH /templates/{template_id} #
+///////////////////////////////////////////////////
+// Edit a transactional template.
+// PATCH /templates/{template_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"name": "new_example_name"
};
@@ -48,12 +45,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a single transactional template. #
-# GET /templates/{template_id} #
+///////////////////////////////////////////////////
+// Retrieve a single transactional template.
+// GET /templates/{template_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/templates/{template_id}'
sg.API(request, function (response) {
@@ -62,12 +58,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a template. #
-# DELETE /templates/{template_id} #
+///////////////////////////////////////////////////
+// Delete a template.
+// DELETE /templates/{template_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/templates/{template_id}'
sg.API(request, function (response) {
@@ -76,12 +71,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Create a new transactional template version. #
-# POST /templates/{template_id}/versions #
+///////////////////////////////////////////////////
+// Create a new transactional template version.
+// POST /templates/{template_id}/versions
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"active": 1,
"html_content": "<%body%>",
@@ -98,12 +92,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Edit a transactional template version. #
-# PATCH /templates/{template_id}/versions/{version_id} #
+///////////////////////////////////////////////////
+// Edit a transactional template version.
+// PATCH /templates/{template_id}/versions/{version_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"active": 1,
"html_content": "<%body%>",
@@ -119,12 +112,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a specific transactional template version. #
-# GET /templates/{template_id}/versions/{version_id} #
+///////////////////////////////////////////////////
+// Retrieve a specific transactional template version.
+// GET /templates/{template_id}/versions/{version_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/templates/{template_id}/versions/{version_id}'
sg.API(request, function (response) {
@@ -133,12 +125,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a transactional template version. #
-# DELETE /templates/{template_id}/versions/{version_id} #
+///////////////////////////////////////////////////
+// Delete a transactional template version.
+// DELETE /templates/{template_id}/versions/{version_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/templates/{template_id}/versions/{version_id}'
sg.API(request, function (response) {
@@ -147,12 +138,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Activate a transactional template version. #
-# POST /templates/{template_id}/versions/{version_id}/activate #
+///////////////////////////////////////////////////
+// Activate a transactional template version.
+// POST /templates/{template_id}/versions/{version_id}/activate
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'POST'
request.path = '/v3/templates/{template_id}/versions/{version_id}/activate'
sg.API(request, function (response) {
diff --git a/examples/trackingsettings/trackingsettings.js b/examples/trackingsettings/trackingsettings.js
index 0b5e93b..9e870ee 100644
--- a/examples/trackingsettings/trackingsettings.js
+++ b/examples/trackingsettings/trackingsettings.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Retrieve Tracking Settings #
-# GET /tracking_settings #
+///////////////////////////////////////////////////
+// Retrieve Tracking Settings
+// GET /tracking_settings
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["limit"] = '1'
request.queryParams["offset"] = '1'
request.method = 'GET'
@@ -16,12 +15,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update Click Tracking Settings #
-# PATCH /tracking_settings/click #
+///////////////////////////////////////////////////
+// Update Click Tracking Settings
+// PATCH /tracking_settings/click
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"enabled": true
};
@@ -33,12 +31,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve Click Track Settings #
-# GET /tracking_settings/click #
+///////////////////////////////////////////////////
+// Retrieve Click Track Settings
+// GET /tracking_settings/click
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/tracking_settings/click'
sg.API(request, function (response) {
@@ -47,12 +44,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update Google Analytics Settings #
-# PATCH /tracking_settings/google_analytics #
+///////////////////////////////////////////////////
+// Update Google Analytics Settings
+// PATCH /tracking_settings/google_analytics
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"enabled": true,
"utm_campaign": "website",
@@ -69,12 +65,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve Google Analytics Settings #
-# GET /tracking_settings/google_analytics #
+///////////////////////////////////////////////////
+// Retrieve Google Analytics Settings
+// GET /tracking_settings/google_analytics
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/tracking_settings/google_analytics'
sg.API(request, function (response) {
@@ -83,12 +78,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update Open Tracking Settings #
-# PATCH /tracking_settings/open #
+///////////////////////////////////////////////////
+// Update Open Tracking Settings
+// PATCH /tracking_settings/open
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"enabled": true
};
@@ -100,12 +94,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Get Open Tracking Settings #
-# GET /tracking_settings/open #
+///////////////////////////////////////////////////
+// Get Open Tracking Settings
+// GET /tracking_settings/open
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/tracking_settings/open'
sg.API(request, function (response) {
@@ -114,12 +107,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update Subscription Tracking Settings #
-# PATCH /tracking_settings/subscription #
+///////////////////////////////////////////////////
+// Update Subscription Tracking Settings
+// PATCH /tracking_settings/subscription
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"enabled": true,
"html_content": "html content",
@@ -136,12 +128,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve Subscription Tracking Settings #
-# GET /tracking_settings/subscription #
+///////////////////////////////////////////////////
+// Retrieve Subscription Tracking Settings
+// GET /tracking_settings/subscription
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/tracking_settings/subscription'
sg.API(request, function (response) {
diff --git a/examples/user/user.js b/examples/user/user.js
index cee95e7..02a2434 100644
--- a/examples/user/user.js
+++ b/examples/user/user.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Get a user's account information. #
-# GET /user/account #
+///////////////////////////////////////////////////
+// Get a user's account information.
+// GET /user/account
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/user/account'
sg.API(request, function (response) {
@@ -14,12 +13,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve your credit balance #
-# GET /user/credits #
+///////////////////////////////////////////////////
+// Retrieve your credit balance
+// GET /user/credits
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/user/credits'
sg.API(request, function (response) {
@@ -28,12 +26,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update your account email address #
-# PUT /user/email #
+///////////////////////////////////////////////////
+// Update your account email address
+// PUT /user/email
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"email": "example@example.com"
};
@@ -45,12 +42,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve your account email address #
-# GET /user/email #
+///////////////////////////////////////////////////
+// Retrieve your account email address
+// GET /user/email
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/user/email'
sg.API(request, function (response) {
@@ -59,12 +55,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update your password #
-# PUT /user/password #
+///////////////////////////////////////////////////
+// Update your password
+// PUT /user/password
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"new_password": "new_password",
"old_password": "old_password"
@@ -77,12 +72,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update a user's profile #
-# PATCH /user/profile #
+///////////////////////////////////////////////////
+// Update a user's profile
+// PATCH /user/profile
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"city": "Orange",
"first_name": "Example",
@@ -96,12 +90,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Get a user's profile #
-# GET /user/profile #
+///////////////////////////////////////////////////
+// Get a user's profile
+// GET /user/profile
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/user/profile'
sg.API(request, function (response) {
@@ -110,12 +103,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Cancel or pause a scheduled send #
-# POST /user/scheduled_sends #
+///////////////////////////////////////////////////
+// Cancel or pause a scheduled send
+// POST /user/scheduled_sends
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"batch_id": "YOUR_BATCH_ID",
"status": "pause"
@@ -128,12 +120,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all scheduled sends #
-# GET /user/scheduled_sends #
+///////////////////////////////////////////////////
+// Retrieve all scheduled sends
+// GET /user/scheduled_sends
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/user/scheduled_sends'
sg.API(request, function (response) {
@@ -142,12 +133,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update user scheduled send information #
-# PATCH /user/scheduled_sends/{batch_id} #
+///////////////////////////////////////////////////
+// Update user scheduled send information
+// PATCH /user/scheduled_sends/{batch_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"status": "pause"
};
@@ -159,12 +149,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve scheduled send #
-# GET /user/scheduled_sends/{batch_id} #
+///////////////////////////////////////////////////
+// Retrieve scheduled send
+// GET /user/scheduled_sends/{batch_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/user/scheduled_sends/{batch_id}'
sg.API(request, function (response) {
@@ -173,12 +162,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a cancellation or pause of a scheduled send #
-# DELETE /user/scheduled_sends/{batch_id} #
+///////////////////////////////////////////////////
+// Delete a cancellation or pause of a scheduled send
+// DELETE /user/scheduled_sends/{batch_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/user/scheduled_sends/{batch_id}'
sg.API(request, function (response) {
@@ -187,12 +175,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update Enforced TLS settings #
-# PATCH /user/settings/enforced_tls #
+///////////////////////////////////////////////////
+// Update Enforced TLS settings
+// PATCH /user/settings/enforced_tls
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"require_tls": true,
"require_valid_cert": false
@@ -205,12 +192,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve current Enforced TLS settings. #
-# GET /user/settings/enforced_tls #
+///////////////////////////////////////////////////
+// Retrieve current Enforced TLS settings.
+// GET /user/settings/enforced_tls
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/user/settings/enforced_tls'
sg.API(request, function (response) {
@@ -219,12 +205,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update your username #
-# PUT /user/username #
+///////////////////////////////////////////////////
+// Update your username
+// PUT /user/username
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"username": "test_username"
};
@@ -236,12 +221,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve your username #
-# GET /user/username #
+///////////////////////////////////////////////////
+// Retrieve your username
+// GET /user/username
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/user/username'
sg.API(request, function (response) {
@@ -250,12 +234,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update Event Notification Settings #
-# PATCH /user/webhooks/event/settings #
+///////////////////////////////////////////////////
+// Update Event Notification Settings
+// PATCH /user/webhooks/event/settings
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"bounce": true,
"click": true,
@@ -279,12 +262,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve Event Webhook settings #
-# GET /user/webhooks/event/settings #
+///////////////////////////////////////////////////
+// Retrieve Event Webhook settings
+// GET /user/webhooks/event/settings
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/user/webhooks/event/settings'
sg.API(request, function (response) {
@@ -293,12 +275,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Test Event Notification Settings #
-# POST /user/webhooks/event/test #
+///////////////////////////////////////////////////
+// Test Event Notification Settings
+// POST /user/webhooks/event/test
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"url": "url"
};
@@ -310,12 +291,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve Parse Webhook settings #
-# GET /user/webhooks/parse/settings #
+///////////////////////////////////////////////////
+// Retrieve Parse Webhook settings
+// GET /user/webhooks/parse/settings
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/user/webhooks/parse/settings'
sg.API(request, function (response) {
@@ -324,12 +304,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieves Inbound Parse Webhook statistics. #
-# GET /user/webhooks/parse/stats #
+///////////////////////////////////////////////////
+// Retrieves Inbound Parse Webhook statistics.
+// GET /user/webhooks/parse/stats
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["aggregated_by"] = 'day'
request.queryParams["limit"] = 'test_string'
request.queryParams["start_date"] = '2016-01-01'
diff --git a/examples/whitelabel/whitelabel.js b/examples/whitelabel/whitelabel.js
index 094ab1d..87f4a3d 100644
--- a/examples/whitelabel/whitelabel.js
+++ b/examples/whitelabel/whitelabel.js
@@ -1,11 +1,10 @@
var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
-##################################################
-# Create a domain whitelabel. #
-# POST /whitelabel/domains #
+///////////////////////////////////////////////////
+// Create a domain whitelabel.
+// POST /whitelabel/domains
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"automatic_security": false,
"custom_spf": true,
@@ -26,12 +25,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# List all domain whitelabels. #
-# GET /whitelabel/domains #
+///////////////////////////////////////////////////
+// List all domain whitelabels.
+// GET /whitelabel/domains
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["username"] = 'test_string'
request.queryParams["domain"] = 'test_string'
request.queryParams["exclude_subusers"] = 'true'
@@ -45,12 +43,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Get the default domain whitelabel. #
-# GET /whitelabel/domains/default #
+///////////////////////////////////////////////////
+// Get the default domain whitelabel.
+// GET /whitelabel/domains/default
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/whitelabel/domains/default'
sg.API(request, function (response) {
@@ -59,12 +56,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# List the domain whitelabel associated with the given user. #
-# GET /whitelabel/domains/subuser #
+///////////////////////////////////////////////////
+// List the domain whitelabel associated with the given user.
+// GET /whitelabel/domains/subuser
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/whitelabel/domains/subuser'
sg.API(request, function (response) {
@@ -73,12 +69,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Disassociate a domain whitelabel from a given user. #
-# DELETE /whitelabel/domains/subuser #
+///////////////////////////////////////////////////
+// Disassociate a domain whitelabel from a given user.
+// DELETE /whitelabel/domains/subuser
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/whitelabel/domains/subuser'
sg.API(request, function (response) {
@@ -87,12 +82,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update a domain whitelabel. #
-# PATCH /whitelabel/domains/{domain_id} #
+///////////////////////////////////////////////////
+// Update a domain whitelabel.
+// PATCH /whitelabel/domains/{domain_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"custom_spf": true,
"default": false
@@ -105,12 +99,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a domain whitelabel. #
-# GET /whitelabel/domains/{domain_id} #
+///////////////////////////////////////////////////
+// Retrieve a domain whitelabel.
+// GET /whitelabel/domains/{domain_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/whitelabel/domains/{domain_id}'
sg.API(request, function (response) {
@@ -119,12 +112,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a domain whitelabel. #
-# DELETE /whitelabel/domains/{domain_id} #
+///////////////////////////////////////////////////
+// Delete a domain whitelabel.
+// DELETE /whitelabel/domains/{domain_id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/whitelabel/domains/{domain_id}'
sg.API(request, function (response) {
@@ -133,12 +125,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Associate a domain whitelabel with a given user. #
-# POST /whitelabel/domains/{domain_id}/subuser #
+///////////////////////////////////////////////////
+// Associate a domain whitelabel with a given user.
+// POST /whitelabel/domains/{domain_id}/subuser
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"username": "jane@example.com"
};
@@ -150,12 +141,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Add an IP to a domain whitelabel. #
-# POST /whitelabel/domains/{id}/ips #
+///////////////////////////////////////////////////
+// Add an IP to a domain whitelabel.
+// POST /whitelabel/domains/{id}/ips
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"ip": "192.168.0.1"
};
@@ -167,12 +157,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Remove an IP from a domain whitelabel. #
-# DELETE /whitelabel/domains/{id}/ips/{ip} #
+///////////////////////////////////////////////////
+// Remove an IP from a domain whitelabel.
+// DELETE /whitelabel/domains/{id}/ips/{ip}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/whitelabel/domains/{id}/ips/{ip}'
sg.API(request, function (response) {
@@ -181,12 +170,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Validate a domain whitelabel. #
-# POST /whitelabel/domains/{id}/validate #
+///////////////////////////////////////////////////
+// Validate a domain whitelabel.
+// POST /whitelabel/domains/{id}/validate
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'POST'
request.path = '/v3/whitelabel/domains/{id}/validate'
sg.API(request, function (response) {
@@ -195,12 +183,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Create an IP whitelabel #
-# POST /whitelabel/ips #
+///////////////////////////////////////////////////
+// Create an IP whitelabel
+// POST /whitelabel/ips
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"domain": "example.com",
"ip": "192.168.1.1",
@@ -214,12 +201,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all IP whitelabels #
-# GET /whitelabel/ips #
+///////////////////////////////////////////////////
+// Retrieve all IP whitelabels
+// GET /whitelabel/ips
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["ip"] = 'test_string'
request.queryParams["limit"] = '1'
request.queryParams["offset"] = '1'
@@ -231,12 +217,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve an IP whitelabel #
-# GET /whitelabel/ips/{id} #
+///////////////////////////////////////////////////
+// Retrieve an IP whitelabel
+// GET /whitelabel/ips/{id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/whitelabel/ips/{id}'
sg.API(request, function (response) {
@@ -245,12 +230,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete an IP whitelabel #
-# DELETE /whitelabel/ips/{id} #
+///////////////////////////////////////////////////
+// Delete an IP whitelabel
+// DELETE /whitelabel/ips/{id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/whitelabel/ips/{id}'
sg.API(request, function (response) {
@@ -259,12 +243,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Validate an IP whitelabel #
-# POST /whitelabel/ips/{id}/validate #
+///////////////////////////////////////////////////
+// Validate an IP whitelabel
+// POST /whitelabel/ips/{id}/validate
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'POST'
request.path = '/v3/whitelabel/ips/{id}/validate'
sg.API(request, function (response) {
@@ -273,12 +256,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Create a Link Whitelabel #
-# POST /whitelabel/links #
+///////////////////////////////////////////////////
+// Create a Link Whitelabel
+// POST /whitelabel/links
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"default": true,
"domain": "example.com",
@@ -294,12 +276,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve all link whitelabels #
-# GET /whitelabel/links #
+///////////////////////////////////////////////////
+// Retrieve all link whitelabels
+// GET /whitelabel/links
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["limit"] = '1'
request.method = 'GET'
request.path = '/v3/whitelabel/links'
@@ -309,12 +290,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a Default Link Whitelabel #
-# GET /whitelabel/links/default #
+///////////////////////////////////////////////////
+// Retrieve a Default Link Whitelabel
+// GET /whitelabel/links/default
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["domain"] = 'test_string'
request.method = 'GET'
request.path = '/v3/whitelabel/links/default'
@@ -324,12 +304,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve Associated Link Whitelabel #
-# GET /whitelabel/links/subuser #
+///////////////////////////////////////////////////
+// Retrieve Associated Link Whitelabel
+// GET /whitelabel/links/subuser
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["username"] = 'test_string'
request.method = 'GET'
request.path = '/v3/whitelabel/links/subuser'
@@ -339,12 +318,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Disassociate a Link Whitelabel #
-# DELETE /whitelabel/links/subuser #
+///////////////////////////////////////////////////
+// Disassociate a Link Whitelabel
+// DELETE /whitelabel/links/subuser
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.queryParams["username"] = 'test_string'
request.method = 'DELETE'
request.path = '/v3/whitelabel/links/subuser'
@@ -354,12 +332,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Update a Link Whitelabel #
-# PATCH /whitelabel/links/{id} #
+///////////////////////////////////////////////////
+// Update a Link Whitelabel
+// PATCH /whitelabel/links/{id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"default": true
};
@@ -371,12 +348,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Retrieve a Link Whitelabel #
-# GET /whitelabel/links/{id} #
+///////////////////////////////////////////////////
+// Retrieve a Link Whitelabel
+// GET /whitelabel/links/{id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'GET'
request.path = '/v3/whitelabel/links/{id}'
sg.API(request, function (response) {
@@ -385,12 +361,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Delete a Link Whitelabel #
-# DELETE /whitelabel/links/{id} #
+///////////////////////////////////////////////////
+// Delete a Link Whitelabel
+// DELETE /whitelabel/links/{id}
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'DELETE'
request.path = '/v3/whitelabel/links/{id}'
sg.API(request, function (response) {
@@ -399,12 +374,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Validate a Link Whitelabel #
-# POST /whitelabel/links/{id}/validate #
+///////////////////////////////////////////////////
+// Validate a Link Whitelabel
+// POST /whitelabel/links/{id}/validate
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.method = 'POST'
request.path = '/v3/whitelabel/links/{id}/validate'
sg.API(request, function (response) {
@@ -413,12 +387,11 @@ sg.API(request, function (response) {
console.log(response.headers)
})
-##################################################
-# Associate a Link Whitelabel #
-# POST /whitelabel/links/{link_id}/subuser #
+///////////////////////////////////////////////////
+// Associate a Link Whitelabel
+// POST /whitelabel/links/{link_id}/subuser
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = sg.emptyRequest
request.body = {
"username": "jane@example.com"
};