Update documentation for mailjet_apiv3_nodejs version v5

guides-sms/_export-sms_stats.md

@@ -15,6 +15,29 @@ https://api.mailjet.com/v4/sms/export \
 -H 'Content-Type: application/json' \
 -d '{"FromTS": 1033552800, "ToTS": 1033574400}'
 ```
+```javascript
+/**
+ *  Create : Create a CSV export file with a list of SMS messages for a specific time period
+ * */
+const mailjet = require('node-mailjet')
+  .smsConnect(process.env.MJ_API_TOKEN)
+
+const request = mailjet
+  .post('sms', { version: 'v4' })
+  .action('export')
+  .request({
+    FromTS: 1033552800,
+    ToTS: 1033574400
+  })
+
+request
+  .then((result) => {
+    console.log(result.body)
+  })
+  .catch((err) => {
+    console.log(err.statusCode)
+  })
+```
 
 A `POST` on the [`/sms/export`](/sms-api/v4/sms-export/) endpoint gives you the ability to request a CSV export file to be generated. With your request you are required to submit a specific timeframe using the `FromTS` and `ToTS` properties.
 
@@ -56,6 +79,27 @@ curl -s -X GET \
 -H "Authorization: Bearer $MJ_TOKEN" \
 https://api.mailjet.com/v4/sms/export/$ID
 ```
+```javascript
+/**
+ *  View : Check the status of an export request and retrieve the download URL, if ready
+ * */
+const mailjet = require('node-mailjet')
+  .smsConnect(process.env.MJ_API_TOKEN)
+
+const request = mailjet
+  .get('sms', { version: 'v4' })
+  .action('export')
+  .id($ID)
+  .request()
+
+request
+  .then((result) => {
+    console.log(result.body)
+  })
+  .catch((err) => {
+    console.log(err.statusCode)
+  })
+```
 
 Use `GET` on [`/sms/export/{RequestID}`](/sms-api/v4/sms-export/) to check the status of your export request, and to retrieve the download URL, once the export file is ready.
 

guides-sms/_filtering-resources.md

@@ -24,6 +24,25 @@ curl -s \
 	-H "Authorization: Bearer $MJ_TOKEN" \
 	https://api.mailjet.com/v4/sms?Limit=100 
 ```
+```javascript
+/**
+ *  View : List of 100 SMS messages
+ * */
+const mailjet = require('node-mailjet')
+  .smsConnect(process.env.MJ_API_TOKEN)
+
+const request = mailjet
+  .get('sms', { version: 'v4' })
+  .request({}, { Limit: 100 })
+
+request
+  .then((result) => {
+    console.log(result.body)
+  })
+  .catch((err) => {
+    console.log(err.statusCode)
+  })
+```
 
 
 You can limit the number of results by applying the <code>Limit</code> filter. The default value is 10 and the maximum value is 1000. `Limit=0` delivers the maximum amount of results - 1000.
@@ -39,6 +58,25 @@ curl -s \
 	-H "Authorization: Bearer $MJ_TOKEN" \
 	https://api.mailjet.com/v4/sms?Offset=25000 
 ```
+```javascript
+/**
+ *  View : List of SMS messages with Offset, starting with the 25000th contact
+ * */
+const mailjet = require('node-mailjet')
+  .smsConnect(process.env.MJ_API_TOKEN)
+
+const request = mailjet
+  .get('sms', { version: 'v4' })
+  .request({}, { Offset: 25000 })
+
+request
+  .then((result) => {
+    console.log(result.body)
+  })
+  .catch((err) => {
+    console.log(err.statusCode)
+  })
+```
 
 You can use the <code>Offset</code> filter to retrieve a list starting from a certain offset.
 <div></div>
@@ -50,6 +88,25 @@ curl -s \
 	-H "Authorization: Bearer $MJ_TOKEN" \
 	https://api.mailjet.com/v4/sms?Limit=150\&Offset=25000 
 ```
+```javascript
+/**
+ *  View : List of SMS with Limit and Offset, retrieves a list of 150 SMS starting with the 25000th contact
+ * */
+const mailjet = require('node-mailjet')
+  .smsConnect(process.env.MJ_API_TOKEN)
+
+const request = mailjet
+  .get('sms', { version: 'v4' })
+  .request({}, { Limit: 150, Offset: 25000 })
+
+request
+  .then((result) => {
+    console.log(result.body)
+  })
+  .catch((err) => {
+    console.log(err.statusCode)
+  })
+```
 
 The <code>Offset</code> filter can be combined with the <code>Limit</code> filter.
 
@@ -64,7 +121,25 @@ curl -s \
 	-H "Authorization: Bearer $MJ_TOKEN" \
 	https://api.mailjet.com/v4/sms?FromTS=1519862400\&ToTS=1520640000 
 ```
-
+```javascript
+/**
+ *  View : List of contacts sent between March 1st 2018 00:00 UTC and March 10th 2018 00:00 UTC
+ * */
+const mailjet = require('node-mailjet')
+  .smsConnect(process.env.MJ_API_TOKEN)
+
+const request = mailjet
+  .get('sms', { version: 'v4' })
+  .request({}, { FromTS: 1519862400, ToTS: 1520640000 })
+
+request
+  .then((result) => {
+    console.log(result.body)
+  })
+  .catch((err) => {
+    console.log(err.statusCode)
+  })
+```
 
 Use the `FromTS` and `ToTS` filters (Unix timestamp) to specify a time period, for which to retrieve the information you need.
 

guides-sms/_getting-started.md

@@ -41,6 +41,26 @@ curl -X POST \
   "Text": "Hello World!"
 }'
 ```
+```javascript
+const mailjet = require('node-mailjet')
+  .smsConnect(process.env.MJ_API_TOKEN)
+
+const request = mailjet
+  .post('sms-send', { version: 'v4' })
+  .request({
+    From: "InfoSMS",
+    To: "+33600000000",
+    Text: "Hello World!"
+  })
+
+request
+  .then((result) => {
+    console.log(result.body)
+  })
+  .catch((err) => {
+    console.log(err.statusCode)
+  })
+```
 
 Fill your sending information in the payload. Three properties are required:
 

guides-sms/_send-sms-api.md

@@ -28,6 +28,29 @@ curl -X POST \
     "From": "MJPilot"
   }'
 ```
+```javascript
+/**
+ *  Create : Send SMS Message to a selected recipient.
+ * */
+const mailjet = require('node-mailjet')
+  .smsConnect(process.env.MJ_API_TOKEN)
+
+const request = mailjet
+  .post('sms-send', { version: 'v4' })
+  .request({
+    From: "MJPilot",
+    To: "+33600000000",
+    Text: "Have a nice SMS flight with Mailjet !"
+  })
+
+request
+  .then((result) => {
+    console.log(result.body)
+  })
+  .catch((err) => {
+    console.log(err.statusCode)
+  })
+```
 
 In the code sample you can see a `POST` request with an Authorization header that includes the token value.
 

guides-sms/_sms-stats.md

@@ -8,6 +8,25 @@ curl -s -X GET \
 -H "Authorization: Bearer $MJ_TOKEN" \
 https://api.mailjet.com/v4/sms?FromTS=1033552800&ToTS=1033574400
 ```
+```javascript
+/**
+ *  View : Retrieve a list of SMS messages sent during a specific time period
+ * */
+const mailjet = require('node-mailjet')
+  .smsConnect(process.env.MJ_API_TOKEN)
+
+const request = mailjet
+  .get('sms', { version: 'v4' })
+  .request({}, { FromTS: 1033552800, ToTS: 1033574400 })
+
+request
+  .then((result) => {
+    console.log(result.body)
+  })
+  .catch((err) => {
+    console.log(err.statusCode)
+  })
+```
 
 With `GET` on the [`/sms`](/sms-api/v4/sms/) endpoint you are able to view details for a list of existing messages - `Status`, `Cost`, `MessageID`, sender and recipient, `CreationTS` and `SentTS` timestamps etc.
 
@@ -70,6 +89,25 @@ curl -s -X GET \
 -H "Authorization: Bearer $MJ_TOKEN" \
 https://api.mailjet.com/v4/sms?To=+33600000000
 ```
+```javascript
+/**
+ *  View : Retrieve a list of SMS messages sent to a specific recipient
+ * */
+const mailjet = require('node-mailjet')
+  .smsConnect(process.env.MJ_API_TOKEN)
+
+const request = mailjet
+  .get('sms', { version: 'v4' })
+  .request({}, { To: '+33600000000' })
+
+request
+  .then((result) => {
+    console.log(result.body)
+  })
+  .catch((err) => {
+    console.log(err.statusCode)
+  })
+```
 
 >API Response
 
@@ -128,6 +166,25 @@ curl -s -X GET \
 -H "Authorization: Bearer $MJ_TOKEN" \
 https://api.mailjet.com/v4/sms?StatusCode=1,2
 ```
+```javascript
+/**
+ *  View : Retrieve a list of SMS messages that were successfully sent, or are being currently sent
+ * */
+const mailjet = require('node-mailjet')
+  .smsConnect(process.env.MJ_API_TOKEN)
+
+const request = mailjet
+  .get('sms', { version: 'v4' })
+  .request({}, { StatusCode: '1,2' })
+
+request
+  .then((result) => {
+    console.log(result.body)
+  })
+  .catch((err) => {
+    console.log(err.statusCode)
+  })
+```
 
 >API Response
 
@@ -208,6 +265,26 @@ curl -s -X GET \
 -H "Authorization: Bearer $MJ_TOKEN" \
 https://api.mailjet.com/v4/sms/744ecf8c-9fed-4ec9-acd0-9b326671f5df
 ```
+```javascript
+/**
+ *  View : Retrieve a specific SMS Message
+ * */
+const mailjet = require('node-mailjet')
+  .smsConnect(process.env.MJ_API_TOKEN)
+
+const request = mailjet
+  .get('sms', { version: 'v4' })
+  .id('744ecf8c-9fed-4ec9-acd0-9b326671f5df') // your id
+  .request()
+
+request
+  .then((result) => {
+    console.log(result.body)
+  })
+  .catch((err) => {
+    console.log(err.statusCode)
+  })
+```
 
 >API Response
 
@@ -247,6 +324,26 @@ curl -s -X GET \
 -H "Authorization: Bearer $MJ_TOKEN" \
 https://api.mailjet.com/v4/sms/count?FromTS=1033552800&ToTS=1033574400
 ```
+```javascript
+/**
+ *  View : Retrieve the number of SMS messages that were processed within a specific timeframe
+ * */
+const mailjet = require('node-mailjet')
+  .smsConnect(process.env.MJ_API_TOKEN)
+
+const request = mailjet
+  .get('sms', { version: 'v4' })
+  .action('count')
+  .request({}, { FromTS: 1033552800, ToTS: 1033574400 })
+
+request
+  .then((result) => {
+    console.log(result.body)
+  })
+  .catch((err) => {
+    console.log(err.statusCode)
+  })
+```
 
 >API Response