Merge pull request #43 from sendinblue/feature_emailCampaign-updates

New params added in emailCampaigns

Author: ekta-slit

docs/CreateEmailCampaign.md

@@ -6,12 +6,13 @@ Name | Type | Description | Notes
 **tag** | **String** | Tag of the campaign | [optional] 
 **sender** | [**CreateEmailCampaignSender**](CreateEmailCampaignSender.md) |  | 
 **name** | **String** | Name of the campaign | 
-**htmlContent** | **String** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional] 
-**htmlUrl** | **String** | Mandatory if htmlContent is empty. Url to the message (HTML) | [optional] 
+**htmlContent** | **String** | Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) | [optional] 
+**htmlUrl** | **String** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional] 
+**templateId** | **Number** | Mandatory if htmlContent and htmlUrl are empty. Id of the SMTP template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional] 
 **scheduledAt** | **Date** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] 
 **subject** | **String** | Subject of the campaign | 
 **replyTo** | **String** | Email on which the campaign recipients will be able to reply to | [optional] 
-**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] 
+**toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] 
 **recipients** | [**CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) |  | [optional] 
 **attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] 
 **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]
@@ -21,6 +22,7 @@ Name | Type | Description | Notes
 **footer** | **String** | Footer of the email campaign | [optional] 
 **header** | **String** | Header of the email campaign | [optional] 
 **utmCampaign** | **String** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional] 
+**params** | **Object** | Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic' | [optional] 
 
 
 <a name="TypeEnum"></a>

docs/CreateSmtpTemplate.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **htmlUrl** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] 
 **subject** | **String** | Subject of the template | 
 **replyTo** | **String** | Email on which campaign recipients will be able to reply to | [optional] 
-**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] 
+**toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] 
 **attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] 
 **isActive** | **Boolean** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional] 
 

docs/UpdateEmailCampaign.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **scheduledAt** | **Date** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] 
 **subject** | **String** | Subject of the campaign | [optional] 
 **replyTo** | **String** | Email on which campaign recipients will be able to reply to | [optional] 
-**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] 
+**toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] 
 **recipients** | [**UpdateEmailCampaignRecipients**](UpdateEmailCampaignRecipients.md) |  | [optional] 
 **attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [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 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]
@@ -20,5 +20,6 @@ Name | Type | Description | Notes
 **footer** | **String** | Footer of the email campaign | [optional] 
 **header** | **String** | Header of the email campaign | [optional] 
 **utmCampaign** | **String** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional] 
+**params** | **Object** | Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. | [optional] 
 
 

docs/UpdateSmtpTemplate.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **htmlUrl** | **String** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional] 
 **subject** | **String** | Subject of the email | [optional] 
 **replyTo** | **String** | Email on which campaign recipients will be able to reply to | [optional] 
-**toField** | **String** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These attributes must already exist in contacts database | [optional] 
+**toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] 
 **attachmentUrl** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] 
 **isActive** | **Boolean** | Status of the template. isActive = false means template is inactive, isActive = true means template is active | [optional] 
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sib-api-v3-sdk",
-  "version": "7.0.2",
+  "version": "7.0.3",
   "description": "Official SendinBlue provided RESTFul API V3 nodejs library",
   "license": "ISC",
   "main": "src/index.js",

src/model/CreateEmailCampaign.js

@@ -98,6 +98,9 @@
       if (data.hasOwnProperty('htmlUrl')) {
         obj['htmlUrl'] = ApiClient.convertToType(data['htmlUrl'], 'String');
       }
+      if (data.hasOwnProperty('templateId')) {
+        obj['templateId'] = ApiClient.convertToType(data['templateId'], 'Number');
+      }
       if (data.hasOwnProperty('scheduledAt')) {
         obj['scheduledAt'] = ApiClient.convertToType(data['scheduledAt'], 'Date');
       }
@@ -137,6 +140,9 @@
       if (data.hasOwnProperty('utmCampaign')) {
         obj['utmCampaign'] = ApiClient.convertToType(data['utmCampaign'], 'String');
       }
+      if (data.hasOwnProperty('params')) {
+        obj['params'] = ApiClient.convertToType(data['params'], Object);
+      }
     }
     return obj;
   }
@@ -156,15 +162,20 @@
    */
   exports.prototype['name'] = undefined;
   /**
-   * Mandatory if htmlUrl is empty. Body of the message (HTML)
+   * Mandatory if htmlUrl and templateId are empty. Body of the message (HTML)
    * @member {String} htmlContent
    */
   exports.prototype['htmlContent'] = undefined;
   /**
-   * Mandatory if htmlContent is empty. Url to the message (HTML)
+   * Mandatory if htmlContent and templateId are empty. Url to the message (HTML)
    * @member {String} htmlUrl
    */
   exports.prototype['htmlUrl'] = undefined;
+  /**
+   * Mandatory if htmlContent and htmlUrl are empty. Id of the SMTP template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature.
+   * @member {Number} templateId
+   */
+  exports.prototype['templateId'] = undefined;
   /**
    * Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
    * @member {Date} scheduledAt
@@ -181,7 +192,7 @@
    */
   exports.prototype['replyTo'] = undefined;
   /**
-   * 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
+   * To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
    * @member {String} toField
    */
   exports.prototype['toField'] = undefined;
@@ -231,6 +242,11 @@
    * @member {String} utmCampaign
    */
   exports.prototype['utmCampaign'] = undefined;
+  /**
+   * Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'
+   * @member {Object} params
+   */
+  exports.prototype['params'] = undefined;
 
 
   /**

src/model/CreateSmtpTemplate.js

@@ -143,7 +143,7 @@
    */
   exports.prototype['replyTo'] = undefined;
   /**
-   * 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
+   * To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
    * @member {String} toField
    */
   exports.prototype['toField'] = undefined;

src/model/UpdateEmailCampaign.js

@@ -129,6 +129,9 @@
       if (data.hasOwnProperty('utmCampaign')) {
         obj['utmCampaign'] = ApiClient.convertToType(data['utmCampaign'], 'String');
       }
+      if (data.hasOwnProperty('params')) {
+        obj['params'] = ApiClient.convertToType(data['params'], Object);
+      }
     }
     return obj;
   }
@@ -173,7 +176,7 @@
    */
   exports.prototype['replyTo'] = undefined;
   /**
-   * 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
+   * To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
    * @member {String} toField
    */
   exports.prototype['toField'] = undefined;
@@ -218,6 +221,11 @@
    * @member {String} utmCampaign
    */
   exports.prototype['utmCampaign'] = undefined;
+  /**
+   * Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}.
+   * @member {Object} params
+   */
+  exports.prototype['params'] = undefined;
 
 
 

src/model/UpdateSmtpTemplate.js

@@ -140,7 +140,7 @@
    */
   exports.prototype['replyTo'] = undefined;
   /**
-   * To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These attributes must already exist in contacts database
+   * To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
    * @member {String} toField
    */
   exports.prototype['toField'] = undefined;

test/model/CreateEmailCampaign.spec.js

@@ -87,6 +87,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property templateId (base name: "templateId")', function() {
+      // uncomment below and update the code to test the property templateId
+      //var instane = new SibApiV3Sdk.CreateEmailCampaign();
+      //expect(instance).to.be();
+    });
+
     it('should have the property scheduledAt (base name: "scheduledAt")', function() {
       // uncomment below and update the code to test the property scheduledAt
       //var instane = new SibApiV3Sdk.CreateEmailCampaign();
@@ -165,6 +171,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property params (base name: "params")', function() {
+      // uncomment below and update the code to test the property params
+      //var instane = new SibApiV3Sdk.CreateEmailCampaign();
+      //expect(instance).to.be();
+    });
+
   });
 
 }));