sib-api-v3-sdk - npm Package Compare versions

Comparing version 7.0.2 to 7.0.3

docs/CreateEmailCampaign.md

@@ -9,8 +9,9 @@ # SibApiV3Sdk.CreateEmailCampaign
 **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] 
@@ -25,2 +26,3 @@ **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]
 **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] 
 
@@ -27,0 +29,0 @@

docs/CreateSmtpTemplate.md

@@ -13,3 +13,3 @@ # SibApiV3Sdk.CreateSmtpTemplate
 **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] 
@@ -16,0 +16,0 @@ **isActive** | **Boolean** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional]

docs/UpdateEmailCampaign.md

@@ -14,3 +14,3 @@ # SibApiV3Sdk.UpdateEmailCampaign
 **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] 
@@ -24,3 +24,4 @@ **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]
 **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

@@ -13,3 +13,3 @@ # SibApiV3Sdk.UpdateSmtpTemplate
 **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] 
@@ -16,0 +16,0 @@ **isActive** | **Boolean** | Status of the template. isActive = false means template is inactive, isActive = true means template is active | [optional]

package.json

 {
   "name": "sib-api-v3-sdk",
-  "version": "7.0.2",
+  "version": "7.0.3",
   "description": "Official SendinBlue provided RESTFul API V3 nodejs library",
@@ -5,0 +5,0 @@ "license": "ISC",

src/model/CreateEmailCampaign.js

@@ -101,2 +101,5 @@ /**
       }
+      if (data.hasOwnProperty('templateId')) {
+        obj['templateId'] = ApiClient.convertToType(data['templateId'], 'Number');
+      }
       if (data.hasOwnProperty('scheduledAt')) {
@@ -141,2 +144,5 @@ obj['scheduledAt'] = ApiClient.convertToType(data['scheduledAt'], 'Date');
       }
+      if (data.hasOwnProperty('params')) {
+        obj['params'] = ApiClient.convertToType(data['params'], Object);
+      }
     }
@@ -161,3 +167,3 @@ return obj;
   /**
-   * 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
@@ -167,3 +173,3 @@ */
   /**
-   * 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
@@ -173,2 +179,7 @@ */
   /**
+   * 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.
@@ -189,3 +200,3 @@ * @member {Date} scheduledAt
   /**
-   * 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
@@ -240,2 +251,7 @@ */
   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;
 
@@ -242,0 +258,0 @@

src/model/CreateSmtpTemplate.js

@@ -146,3 +146,3 @@ /**
   /**
-   * 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
@@ -149,0 +149,0 @@ */

src/model/UpdateEmailCampaign.js

@@ -132,2 +132,5 @@ /**
       }
+      if (data.hasOwnProperty('params')) {
+        obj['params'] = ApiClient.convertToType(data['params'], Object);
+      }
     }
@@ -177,3 +180,3 @@ return obj;
   /**
-   * 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
@@ -223,2 +226,7 @@ */
   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;
 
@@ -225,0 +233,0 @@

src/model/UpdateSmtpTemplate.js

@@ -143,3 +143,3 @@ /**
   /**
-   * 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
@@ -146,0 +146,0 @@ */

test/model/CreateEmailCampaign.spec.js

@@ -90,2 +90,8 @@ /**
 
+    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() {
@@ -169,4 +175,10 @@ // uncomment below and update the code to test the property scheduledAt
 
+    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();
+    });
+
   });
 
 }));

test/model/UpdateEmailCampaign.spec.js

@@ -162,4 +162,10 @@ /**
 
+    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.UpdateEmailCampaign();
+      //expect(instance).to.be();
+    });
+
   });
 
 }));

No alert changes

Improved metrics

Total package byte prevSize

1811803

increased by0.19%

Lines of code

35064

increased by0.11%

No dependency changes