Merge pull request #4 from sendinblue/feature_add-attachment-url-in-templates

Add attachment url in transactional template send

Author: ekta-slit

README.md

@@ -424,6 +424,7 @@ Class | Method | HTTP request | Description
  - [SendinBlueApi.SmsCampaignsRecipients](docs/SmsCampaignsRecipients.md)
  - [SendinBlueApi.SmtpTemplate](docs/SmtpTemplate.md)
  - [SendinBlueApi.SmtpTemplate1](docs/SmtpTemplate1.md)
+ - [SendinBlueApi.SmtpemailAttachment](docs/SmtpemailAttachment.md)
  - [SendinBlueApi.SmtpemailBcc](docs/SmtpemailBcc.md)
  - [SendinBlueApi.SmtpemailCc](docs/SmtpemailCc.md)
  - [SendinBlueApi.SmtpemailReplyTo](docs/SmtpemailReplyTo.md)
@@ -463,4 +464,4 @@ Be sure to visit the SendinBlue official [documentation website](https://sendinb
 
 If you find a bug, please post the issue on [Github](https://github.com/sendinblue/APIv3-nodejs-library/issues).
 
-As always, if you need additional assistance, drop us a note [here](https://account.sendinblue.com/support).
+As always, if you need additional assistance, drop us a note [here](https://account.sendinblue.com/support).

docs/CreateEmailCampaign.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **toField** | **String** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, use [FNAME] [LNAME]. These attributes must already exist in your contact database | [optional] 
 **recipients** | [**EmailCampaignsRecipients**](EmailCampaignsRecipients.md) |  | [optional] 
 **attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extensions allowed xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf | [optional] 
-**inlineImageActivation** | **Boolean** | Use true to embedded the images in your email. Final size of the email should be less than 5MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false]
+**inlineImageActivation** | **Boolean** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false]
 **mirrorActive** | **Boolean** | Use true to enable the mirror link | [optional] 
 **recurring** | **Boolean** | For trigger campagins use false to make sure a contact receives the same campaign only once | [optional] [default to false]
 **type** | **String** | Type of the campaign | 

docs/EmailCampaign.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **toField** | **String** | This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add [FNAME] [LNAME]. To use the contact attributes here, these must already exist in SendinBlue account | [optional] 
 **recipients** | [**EmailCampaignscampaignIdRecipients**](EmailCampaignscampaignIdRecipients.md) |  | [optional] 
 **attachmentUrl** | **String** | Absolute url of the attachment. Url not allowed from local machine. File must be hosted somewhere.Possilbe extension values are xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf | [optional] 
-**inlineImageActivation** | **Boolean** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 5MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. | [optional] [default to false]
+**inlineImageActivation** | **Boolean** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. | [optional] [default to false]
 **mirrorActive** | **Boolean** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] 
 **recurring** | **Boolean** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] [default to false]
 **footer** | **String** | Footer of the email campaign | [optional] 

docs/EmailCampaigns.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **toField** | **String** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, use [FNAME] [LNAME]. These attributes must already exist in your contact database | [optional] 
 **recipients** | [**EmailCampaignsRecipients**](EmailCampaignsRecipients.md) |  | [optional] 
 **attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extensions allowed xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf | [optional] 
-**inlineImageActivation** | **Boolean** | Use true to embedded the images in your email. Final size of the email should be less than 5MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false]
+**inlineImageActivation** | **Boolean** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false]
 **mirrorActive** | **Boolean** | Use true to enable the mirror link | [optional] 
 **recurring** | **Boolean** | For trigger campagins use false to make sure a contact receives the same campaign only once | [optional] [default to false]
 **type** | **String** | Type of the campaign | 

docs/SMTPApi.md

@@ -282,7 +282,7 @@ apiInstance.getSmtpReport(opts, callback);
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **limit** | **Number**| Number of documents returned per page | [optional] [default to 100]
+ **limit** | **Number**| Number of documents returned per page | [optional] [default to 50]
  **offset** | **Number**| Index of the first document on the page | [optional] [default to 0]
  **startDate** | **Date**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional] 
  **endDate** | **Date**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional] 
@@ -369,7 +369,7 @@ apiKey.apiKey = 'YOUR API KEY';
 var apiInstance = new SendinBlueApi.SMTPApi();
 
 var opts = { 
-  'templateStatus': false, // Boolean | Filter on the status of the template. Active = true, inactive = false
+  'templateStatus': true, // Boolean | Filter on the status of the template. Active = true, inactive = false
   'limit': 50, // Number | Number of documents returned per page
   'offset': 0 // Number | Index of the first document in the page
 };
@@ -388,8 +388,8 @@ apiInstance.getSmtpTemplates(opts, callback);
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **templateStatus** | **Boolean**| Filter on the status of the template. Active = true, inactive = false | [optional] [default to false]
- **limit** | **Number**| Number of documents returned per page | [optional] [default to 500]
+ **templateStatus** | **Boolean**| Filter on the status of the template. Active = true, inactive = false | [optional] 
+ **limit** | **Number**| Number of documents returned per page | [optional] [default to 50]
  **offset** | **Number**| Index of the first document in the page | [optional] [default to 0]
 
 ### Return type

docs/SendEmail.md

@@ -7,7 +7,8 @@ Name | Type | Description | Notes
 **emailBcc** | **[String]** | Email addresses of the recipients in bcc | [optional] 
 **emailCc** | **[String]** | Email addresses of the recipients in cc | [optional] 
 **replyTo** | **String** | Email on which campaign recipients will be able to reply to | [optional] 
-**attachment** | [**[SmtptemplatestemplateIdsendAttachment]**](SmtptemplatestemplateIdsendAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment. Name can be used in both cases to define the attachment name. It is mandatory in case of content. Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] 
+**attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] 
+**attachment** | [**[SmtptemplatestemplateIdsendAttachment]**](SmtptemplatestemplateIdsendAttachment.md) | Pass the base64 content of the attachment. Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] 
 **headers** | **{String: String}** |  | [optional] 
 **attributes** | **{String: String}** |  | [optional] 
 

docs/SendEmail1.md

@@ -7,7 +7,8 @@ Name | Type | Description | Notes
 **emailBcc** | **[String]** | Email addresses of the recipients in bcc | [optional] 
 **emailCc** | **[String]** | Email addresses of the recipients in cc | [optional] 
 **replyTo** | **String** | Email on which campaign recipients will be able to reply to | [optional] 
-**attachment** | [**[SmtptemplatestemplateIdsendAttachment]**](SmtptemplatestemplateIdsendAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment. Name can be used in both cases to define the attachment name. It is mandatory in case of content. Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] 
+**attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] 
+**attachment** | [**[SmtptemplatestemplateIdsendAttachment]**](SmtptemplatestemplateIdsendAttachment.md) | Pass the base64 content of the attachment. Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] 
 **headers** | **{String: String}** |  | [optional] 
 **attributes** | **{String: String}** |  | [optional] 
 

docs/SendSmtpEmail.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **textContent** | **String** | Plain Text body of the message | [optional] 
 **subject** | **String** | Subject of the message | 
 **replyTo** | [**SmtpemailReplyTo**](SmtpemailReplyTo.md) |  | [optional] 
-**attachment** | [**[SmtptemplatestemplateIdsendAttachment]**](SmtptemplatestemplateIdsendAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment. Name can be used in both cases to define the attachment name. It is mandatory in case of content. Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] 
+**attachment** | [**[SmtpemailAttachment]**](SmtpemailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment. Name can be used in both cases to define the attachment name. It is mandatory in case of content. Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] 
 **headers** | **{String: String}** |  | [optional] 
 
 

docs/SendSmtpEmail1.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **textContent** | **String** | Plain Text body of the message | [optional] 
 **subject** | **String** | Subject of the message | 
 **replyTo** | [**SmtpemailReplyTo**](SmtpemailReplyTo.md) |  | [optional] 
-**attachment** | [**[SmtptemplatestemplateIdsendAttachment]**](SmtptemplatestemplateIdsendAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment. Name can be used in both cases to define the attachment name. It is mandatory in case of content. Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] 
+**attachment** | [**[SmtpemailAttachment]**](SmtpemailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment. Name can be used in both cases to define the attachment name. It is mandatory in case of content. Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] 
 **headers** | **{String: String}** |  | [optional] 
 
 

docs/SmtpemailAttachment.md

@@ -0,0 +1,10 @@
+# SendinBlueApi.SmtpemailAttachment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | Absolute url of the attachment (no local file). | [optional] 
+**content** | **Blob** | Base64 encoded chunk data of the attachment generated on the fly | [optional] 
+**name** | **String** | Required for content. Name of the attachment | [optional] 
+
+

docs/SmtptemplatestemplateIdsendAttachment.md

@@ -3,7 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**url** | **String** | Absolute url of the attachment (no local file). | [optional] 
 **content** | **Blob** | Base64 encoded chunk data of the attachment generated on the fly | [optional] 
 **name** | **String** | Required for content. Name of the attachment | [optional] 
 

docs/TransactionalSMSApi.md

@@ -52,7 +52,7 @@ apiInstance.getSmsEvents(opts, callback);
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **limit** | **Number**| Number of documents per page | [optional] [default to 100]
+ **limit** | **Number**| Number of documents per page | [optional] [default to 50]
  **startDate** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional] 
  **endDate** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional] 
  **offset** | **Number**| Index of the first document of the page | [optional] [default to 0]

docs/UpdateEmailCampaign.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **toField** | **String** | This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add [FNAME] [LNAME]. To use the contact attributes here, these must already exist in SendinBlue account | [optional] 
 **recipients** | [**EmailCampaignscampaignIdRecipients**](EmailCampaignscampaignIdRecipients.md) |  | [optional] 
 **attachmentUrl** | **String** | Absolute url of the attachment. Url not allowed from local machine. File must be hosted somewhere.Possilbe extension values are xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf | [optional] 
-**inlineImageActivation** | **Boolean** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 5MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. | [optional] [default to false]
+**inlineImageActivation** | **Boolean** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. | [optional] [default to false]
 **mirrorActive** | **Boolean** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] 
 **recurring** | **Boolean** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] [default to false]
 **footer** | **String** | Footer of the email campaign | [optional] 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sendinblue-apiv3",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Official SendinBlue provided RESTFul API V3 nodejs library",
   "license": "ISC",
   "main": "src/index.js",

src/api/SMTPApi.js

@@ -349,7 +349,7 @@
     /**
      * Get the list of SMTP templates
      * @param {Object} opts Optional parameters
-     * @param {Boolean} opts.templateStatus Filter on the status of the template. Active = true, inactive = false (default to false)
+     * @param {Boolean} opts.templateStatus Filter on the status of the template. Active = true, inactive = false
      * @param {Number} opts.limit Number of documents returned per page (default to 50)
      * @param {Number} opts.offset Index of the first document in the page (default to 0)
      * @param {module:api/SMTPApi~getSmtpTemplatesCallback} callback The callback function, accepting three arguments: error, data, response