summaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
Diffstat (limited to 'examples')
-rw-r--r--examples/alerts/alerts.js80
-rw-r--r--examples/apikeys/apikeys.js3
-rw-r--r--examples/asm/asm.js21
-rw-r--r--examples/campaigns/campaigns.js4
-rw-r--r--examples/contactdb/contactdb.js15
-rw-r--r--examples/mail/mail.js134
-rw-r--r--examples/subusers/subusers.js6
-rw-r--r--examples/suppression/suppression.js4
-rw-r--r--examples/user/user.js69
9 files changed, 254 insertions, 82 deletions
diff --git a/examples/alerts/alerts.js b/examples/alerts/alerts.js
new file mode 100644
index 0000000..01a4fc9
--- /dev/null
+++ b/examples/alerts/alerts.js
@@ -0,0 +1,80 @@
+var sg = require('sendgrid').SendGrid(process.env.SENDGRID_API_KEY)
+
+///////////////////////////////////////////////////
+// Create a new Alert
+// POST /alerts
+
+
+var request = sg.emptyRequest()
+request.body = {
+ "email_to": "example@example.com",
+ "frequency": "daily",
+ "type": "stats_notification"
+};
+request.method = 'POST'
+request.path = '/v3/alerts'
+sg.API(request, function (response) {
+ console.log(response.statusCode)
+ console.log(response.body)
+ console.log(response.headers)
+})
+
+///////////////////////////////////////////////////
+// Retrieve all alerts
+// GET /alerts
+
+
+var request = sg.emptyRequest()
+request.method = 'GET'
+request.path = '/v3/alerts'
+sg.API(request, function (response) {
+ console.log(response.statusCode)
+ console.log(response.body)
+ console.log(response.headers)
+})
+
+///////////////////////////////////////////////////
+// Update an alert
+// PATCH /alerts/{alert_id}
+
+
+var request = sg.emptyRequest()
+request.body = {
+ "email_to": "example@example.com"
+};
+request.method = 'PATCH'
+request.path = '/v3/alerts/{alert_id}'
+sg.API(request, function (response) {
+ console.log(response.statusCode)
+ console.log(response.body)
+ console.log(response.headers)
+})
+
+///////////////////////////////////////////////////
+// Retrieve a specific alert
+// GET /alerts/{alert_id}
+
+
+var request = sg.emptyRequest()
+request.method = 'GET'
+request.path = '/v3/alerts/{alert_id}'
+sg.API(request, function (response) {
+ console.log(response.statusCode)
+ console.log(response.body)
+ console.log(response.headers)
+})
+
+///////////////////////////////////////////////////
+// Delete an alert
+// DELETE /alerts/{alert_id}
+
+
+var request = sg.emptyRequest()
+request.method = 'DELETE'
+request.path = '/v3/alerts/{alert_id}'
+sg.API(request, function (response) {
+ console.log(response.statusCode)
+ console.log(response.body)
+ console.log(response.headers)
+})
+
diff --git a/examples/apikeys/apikeys.js b/examples/apikeys/apikeys.js
index b4420ef..11d311f 100644
--- a/examples/apikeys/apikeys.js
+++ b/examples/apikeys/apikeys.js
@@ -8,6 +8,7 @@ var sg = require('sendgrid').SendGrid(process.env.SENDGRID_API_KEY)
var request = sg.emptyRequest()
request.body = {
"name": "My API Key",
+ "sample": "data",
"scopes": [
"mail.send",
"alerts.create",
@@ -28,6 +29,8 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
+request.queryParams["limit"] = '1'
+
request.method = 'GET'
request.path = '/v3/api_keys'
sg.API(request, function (response) {
diff --git a/examples/asm/asm.js b/examples/asm/asm.js
index 3fcf195..ecbcca6 100644
--- a/examples/asm/asm.js
+++ b/examples/asm/asm.js
@@ -117,6 +117,27 @@ sg.API(request, function (response) {
})
///////////////////////////////////////////////////
+// Search for suppressions within a group
+// POST /asm/groups/{group_id}/suppressions/search
+
+
+var request = sg.emptyRequest()
+request.body = {
+ "recipient_emails": [
+ "exists1@example.com",
+ "exists2@example.com",
+ "doesnotexists@example.com"
+ ]
+};
+request.method = 'POST'
+request.path = '/v3/asm/groups/{group_id}/suppressions/search'
+sg.API(request, function (response) {
+ console.log(response.statusCode)
+ console.log(response.body)
+ console.log(response.headers)
+})
+
+///////////////////////////////////////////////////
// Delete a suppression from a suppression group
// DELETE /asm/groups/{group_id}/suppressions/{email}
diff --git a/examples/campaigns/campaigns.js b/examples/campaigns/campaigns.js
index a2c1407..83f66a0 100644
--- a/examples/campaigns/campaigns.js
+++ b/examples/campaigns/campaigns.js
@@ -40,8 +40,8 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
-request.queryParams["limit"] = '0'
- request.queryParams["offset"] = '0'
+request.queryParams["limit"] = '1'
+ request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/campaigns'
diff --git a/examples/contactdb/contactdb.js b/examples/contactdb/contactdb.js
index 2ffba33..71152c1 100644
--- a/examples/contactdb/contactdb.js
+++ b/examples/contactdb/contactdb.js
@@ -120,7 +120,7 @@ var request = sg.emptyRequest()
request.body = {
"name": "newlistname"
};
-request.queryParams["list_id"] = '0'
+request.queryParams["list_id"] = '1'
request.method = 'PATCH'
request.path = '/v3/contactdb/lists/{list_id}'
@@ -136,7 +136,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
-request.queryParams["list_id"] = '0'
+request.queryParams["list_id"] = '1'
request.method = 'GET'
request.path = '/v3/contactdb/lists/{list_id}'
@@ -188,7 +188,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["page"] = '1'
request.queryParams["page_size"] = '1'
- request.queryParams["list_id"] = '0'
+ request.queryParams["list_id"] = '1'
request.method = 'GET'
request.path = '/v3/contactdb/lists/{list_id}/recipients'
@@ -218,8 +218,8 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
-request.queryParams["recipient_id"] = '0'
- request.queryParams["list_id"] = '0'
+request.queryParams["recipient_id"] = '1'
+ request.queryParams["list_id"] = '1'
request.method = 'DELETE'
request.path = '/v3/contactdb/lists/{list_id}/recipients/{recipient_id}'
@@ -347,7 +347,8 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
-request.queryParams["{field_name}"] = 'test_string'
+request.queryParams["%7Bfield_name%7D"] = 'test_string'
+ request.queryParams["{field_name}"] = 'test_string'
request.method = 'GET'
request.path = '/v3/contactdb/recipients/search'
@@ -499,7 +500,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
-request.queryParams["segment_id"] = '0'
+request.queryParams["segment_id"] = '1'
request.method = 'GET'
request.path = '/v3/contactdb/segments/{segment_id}'
diff --git a/examples/mail/mail.js b/examples/mail/mail.js
index 8d98078..ed4b73f 100644
--- a/examples/mail/mail.js
+++ b/examples/mail/mail.js
@@ -37,138 +37,138 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.body = {
"asm": {
- "group_id": 1,
+ "group_id": 1,
"groups_to_display": [
- 1,
- 2,
+ 1,
+ 2,
3
]
- },
+ },
"attachments": [
{
- "content": "[BASE64 encoded content block here]",
- "content_id": "ii_139db99fdb5c3704",
- "disposition": "inline",
- "filename": "file1.jpg",
- "name": "file1",
+ "content": "[BASE64 encoded content block here]",
+ "content_id": "ii_139db99fdb5c3704",
+ "disposition": "inline",
+ "filename": "file1.jpg",
+ "name": "file1",
"type": "jpg"
}
- ],
- "batch_id": "[YOUR BATCH ID GOES HERE]",
+ ],
+ "batch_id": "[YOUR BATCH ID GOES HERE]",
"categories": [
- "category1",
+ "category1",
"category2"
- ],
+ ],
"content": [
{
- "type": "text/html",
+ "type": "text/html",
"value": "<html><p>Hello, world!</p><img src=[CID GOES HERE]></img></html>"
}
- ],
+ ],
"custom_args": {
- "New Argument 1": "New Value 1",
- "activationAttempt": "1",
+ "New Argument 1": "New Value 1",
+ "activationAttempt": "1",
"customerAccountNumber": "[CUSTOMER ACCOUNT NUMBER GOES HERE]"
- },
+ },
"from": {
- "email": "sam.smith@example.com",
+ "email": "sam.smith@example.com",
"name": "Sam Smith"
- },
- "headers": {},
- "ip_pool_name": "[YOUR POOL NAME GOES HERE]",
+ },
+ "headers": {},
+ "ip_pool_name": "[YOUR POOL NAME GOES HERE]",
"mail_settings": {
"bcc": {
- "email": "ben.doe@example.com",
+ "email": "ben.doe@example.com",
"enable": true
- },
+ },
"bypass_list_management": {
"enable": true
- },
+ },
"footer": {
- "enable": true,
- "html": "<p>Thanks</br>The SendGrid Team</p>",
+ "enable": true,
+ "html": "<p>Thanks</br>The SendGrid Team</p>",
"text": "Thanks,/n The SendGrid Team"
- },
+ },
"sandbox_mode": {
"enable": false
- },
+ },
"spam_check": {
- "enable": true,
- "post_to_url": "http://example.com/compliance",
+ "enable": true,
+ "post_to_url": "http://example.com/compliance",
"threshold": 3
}
- },
+ },
"personalizations": [
{
"bcc": [
{
- "email": "sam.doe@example.com",
+ "email": "sam.doe@example.com",
"name": "Sam Doe"
}
- ],
+ ],
"cc": [
{
- "email": "jane.doe@example.com",
+ "email": "jane.doe@example.com",
"name": "Jane Doe"
}
- ],
+ ],
"custom_args": {
- "New Argument 1": "New Value 1",
- "activationAttempt": "1",
+ "New Argument 1": "New Value 1",
+ "activationAttempt": "1",
"customerAccountNumber": "[CUSTOMER ACCOUNT NUMBER GOES HERE]"
- },
+ },
"headers": {
- "X-Accept-Language": "en",
+ "X-Accept-Language": "en",
"X-Mailer": "MyApp"
- },
- "send_at": 1409348513,
- "subject": "Hello, World!",
+ },
+ "send_at": 1409348513,
+ "subject": "Hello, World!",
"substitutions": {
- "id": "substitutions",
+ "id": "substitutions",
"type": "object"
- },
+ },
"to": [
{
- "email": "john.doe@example.com",
+ "email": "john.doe@example.com",
"name": "John Doe"
}
]
}
- ],
+ ],
"reply_to": {
- "email": "sam.smith@example.com",
+ "email": "sam.smith@example.com",
"name": "Sam Smith"
- },
+ },
"sections": {
"section": {
- ":sectionName1": "section 1 text",
+ ":sectionName1": "section 1 text",
":sectionName2": "section 2 text"
}
- },
- "send_at": 1409348513,
- "subject": "Hello, World!",
- "template_id": "[YOUR TEMPLATE ID GOES HERE]",
+ },
+ "send_at": 1409348513,
+ "subject": "Hello, World!",
+ "template_id": "[YOUR TEMPLATE ID GOES HERE]",
"tracking_settings": {
"click_tracking": {
- "enable": true,
+ "enable": true,
"enable_text": true
- },
+ },
"ganalytics": {
- "enable": true,
- "utm_campaign": "[NAME OF YOUR REFERRER SOURCE]",
- "utm_content": "[USE THIS SPACE TO DIFFERENTIATE YOUR EMAIL FROM ADS]",
- "utm_medium": "[NAME OF YOUR MARKETING MEDIUM e.g. email]",
- "utm_name": "[NAME OF YOUR CAMPAIGN]",
+ "enable": true,
+ "utm_campaign": "[NAME OF YOUR REFERRER SOURCE]",
+ "utm_content": "[USE THIS SPACE TO DIFFERENTIATE YOUR EMAIL FROM ADS]",
+ "utm_medium": "[NAME OF YOUR MARKETING MEDIUM e.g. email]",
+ "utm_name": "[NAME OF YOUR CAMPAIGN]",
"utm_term": "[IDENTIFY PAID KEYWORDS HERE]"
- },
+ },
"open_tracking": {
- "enable": true,
+ "enable": true,
"substitution_tag": "%opentrack"
- },
+ },
"subscription_tracking": {
- "enable": true,
- "html": "If you would like to unsubscribe and stop receiving these emails <% clickhere %>.",
- "substitution_tag": "<%click here%>",
+ "enable": true,
+ "html": "If you would like to unsubscribe and stop receiving these emails <% clickhere %>.",
+ "substitution_tag": "<%click here%>",
"text": "If you would like to unsubscribe and stop receiveing these emails <% click here %>."
}
}
diff --git a/examples/subusers/subusers.js b/examples/subusers/subusers.js
index f72650e..8f03f49 100644
--- a/examples/subusers/subusers.js
+++ b/examples/subusers/subusers.js
@@ -30,8 +30,8 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["username"] = 'test_string'
- request.queryParams["limit"] = '0'
- request.queryParams["offset"] = '0'
+ request.queryParams["limit"] = '1'
+ request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/subusers'
@@ -241,7 +241,7 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
request.queryParams["date"] = 'test_string'
request.queryParams["sort_by_direction"] = 'asc'
- request.queryParams["limit"] = '0'
+ request.queryParams["limit"] = '1'
request.queryParams["sort_by_metric"] = 'test_string'
request.queryParams["offset"] = '1'
diff --git a/examples/suppression/suppression.js b/examples/suppression/suppression.js
index 107e19c..4faf209 100644
--- a/examples/suppression/suppression.js
+++ b/examples/suppression/suppression.js
@@ -74,8 +74,8 @@ sg.API(request, function (response) {
var request = sg.emptyRequest()
-request.queryParams["start_time"] = '0'
- request.queryParams["end_time"] = '0'
+request.queryParams["start_time"] = '1'
+ request.queryParams["end_time"] = '1'
request.method = 'GET'
request.path = '/v3/suppression/bounces'
diff --git a/examples/user/user.js b/examples/user/user.js
index 3046178..7b2305c 100644
--- a/examples/user/user.js
+++ b/examples/user/user.js
@@ -311,7 +311,27 @@ sg.API(request, function (response) {
})
///////////////////////////////////////////////////
-// Retrieve Parse Webhook settings
+// Create a parse setting
+// POST /user/webhooks/parse/settings
+
+
+var request = sg.emptyRequest()
+request.body = {
+ "hostname": "myhostname.com",
+ "send_raw": false,
+ "spam_check": true,
+ "url": "http://email.myhosthame.com"
+};
+request.method = 'POST'
+request.path = '/v3/user/webhooks/parse/settings'
+sg.API(request, function (response) {
+ console.log(response.statusCode)
+ console.log(response.body)
+ console.log(response.headers)
+})
+
+///////////////////////////////////////////////////
+// Retrieve all parse settings
// GET /user/webhooks/parse/settings
@@ -325,6 +345,53 @@ sg.API(request, function (response) {
})
///////////////////////////////////////////////////
+// Update a parse setting
+// PATCH /user/webhooks/parse/settings/{hostname}
+
+
+var request = sg.emptyRequest()
+request.body = {
+ "send_raw": true,
+ "spam_check": false,
+ "url": "http://newdomain.com/parse"
+};
+request.method = 'PATCH'
+request.path = '/v3/user/webhooks/parse/settings/{hostname}'
+sg.API(request, function (response) {
+ console.log(response.statusCode)
+ console.log(response.body)
+ console.log(response.headers)
+})
+
+///////////////////////////////////////////////////
+// Retrieve a specific parse setting
+// GET /user/webhooks/parse/settings/{hostname}
+
+
+var request = sg.emptyRequest()
+request.method = 'GET'
+request.path = '/v3/user/webhooks/parse/settings/{hostname}'
+sg.API(request, function (response) {
+ console.log(response.statusCode)
+ console.log(response.body)
+ console.log(response.headers)
+})
+
+///////////////////////////////////////////////////
+// Delete a parse setting
+// DELETE /user/webhooks/parse/settings/{hostname}
+
+
+var request = sg.emptyRequest()
+request.method = 'DELETE'
+request.path = '/v3/user/webhooks/parse/settings/{hostname}'
+sg.API(request, function (response) {
+ console.log(response.statusCode)
+ console.log(response.body)
+ console.log(response.headers)
+})
+
+///////////////////////////////////////////////////
// Retrieves Inbound Parse Webhook statistics.
// GET /user/webhooks/parse/stats
generated by cgit v1.1 at 2025-05-11 22:57:58 +0000