Report API for SMS campaigns updates & other mixed changes

ekta-slit · ekta-slit · commit c5f1277584ca · 2019-01-10T18:16:24.000+05:30
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 ISC License
 
-Copyright (c) 2018, SendinBlue
+Copyright (c) 2019, SendinBlue
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above
diff --git a/docs/CreateWebhook.md b/docs/CreateWebhook.md
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **url** | **String** | URL of the webhook | 
 **description** | **String** | Description of the webhook | [optional] 
-**events** | **[String]** | Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition &amp; delivered | [optional] 
+**events** | **[String]** | Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition &amp; delivered | 
 **type** | **String** | Type of the webhook | [optional] [default to &#39;transactional&#39;]
 
 
diff --git a/docs/GetSmsEventReportEvents.md b/docs/GetSmsEventReportEvents.md
@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **phoneNumber** | **String** | Phone number which has generated the event | 
-**_date** | **Date** | Date on which the event has been generated | 
+**_date** | **Date** | UTC date-time on which the event has been generated | 
 **messageId** | **String** | Message ID which generated the event | 
 **event** | **String** | Event which occurred | 
 **reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional] 
diff --git a/docs/RequestContactImport.md b/docs/RequestContactImport.md
@@ -11,5 +11,6 @@ Name | Type | Description | Notes
 **emailBlacklist** | **Boolean** | To blacklist all the contacts for email | [optional] [default to false]
 **smsBlacklist** | **Boolean** | To blacklist all the contacts for sms | [optional] [default to false]
 **updateExistingContacts** | **Boolean** | To facilitate the choice to update the existing contacts | [optional] [default to true]
+**emptyContactsAttributes** | **Boolean** | To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes &#x3D; true means the empty fields in your import will erase any attribute that currently contain data in SendinBlue, &amp; emptyContactsAttributes &#x3D; false means the empty fields will not affect your existing data ( only available if &#x60;updateExistingContacts&#x60; set to true ) | [optional] [default to false]
 
 
diff --git a/docs/RequestSmsRecipientExport.md b/docs/RequestSmsRecipientExport.md
@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **notifyURL** | **String** | URL that will be called once the export process is finished | [optional] 
-**recipientsType** | **String** | Filter the recipients based on how they interacted with the campaign | [default to &#39;all&#39;]
+**recipientsType** | **String** | Filter the recipients based on how they interacted with the campaign | 
 
 
 <a name="RecipientsTypeEnum"></a>
diff --git a/docs/SMSCampaignsApi.md b/docs/SMSCampaignsApi.md
@@ -377,7 +377,7 @@ null (empty response body)
 
 <a name="sendTestSms"></a>
 # **sendTestSms**
-> sendTestSms(campaignId, sendTestSms)
+> sendTestSms(campaignId, phoneNumber)
 
 Send an SMS
 
@@ -396,9 +396,9 @@ var apiInstance = new SibApiV3Sdk.SMSCampaignsApi();
 
 var campaignId = 789; // Number | Id of the SMS campaign
 
-var sendTestSms = new SibApiV3Sdk.SendTestSms(); // SendTestSms | Mobile number to which send the test
+var phoneNumber = new SibApiV3Sdk.SendTestSms(); // SendTestSms | Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted
 
-apiInstance.sendTestSms(campaignId, sendTestSms).then(function() {
+apiInstance.sendTestSms(campaignId, phoneNumber).then(function() {
   console.log('API called successfully.');
 }, function(error) {
   console.error(error);
@@ -411,7 +411,7 @@ apiInstance.sendTestSms(campaignId, sendTestSms).then(function() {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **campaignId** | **Number**| Id of the SMS campaign | 
- **sendTestSms** | [**SendTestSms**](SendTestSms.md)| Mobile number to which send the test | 
+ **phoneNumber** | [**SendTestSms**](SendTestSms.md)| Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted | 
 
 ### Return type
 
diff --git a/docs/SendReportEmail.md b/docs/SendReportEmail.md
@@ -3,12 +3,12 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**subject** | **String** | Subject of the email message | [optional] 
-**to** | **[String]** | Email addresses of the recipients | [optional] 
-**contentType** | **String** | Type of the message body | [optional] 
+**subject** | **String** | Subject of the email message | 
+**to** | **[String]** | Email addresses of the recipients | 
+**contentType** | **String** | Type of the message body | [optional] [default to &#39;html&#39;]
 **bcc** | **[String]** | Email addresses of the recipients in bcc | [optional] 
 **cc** | **[String]** | Email addresses of the recipients in cc | [optional] 
-**body** | **String** | Body of the email message | [optional] 
+**body** | **String** | Body of the email message | 
 
 
 <a name="ContentTypeEnum"></a>
diff --git a/docs/SendSms.md b/docs/SendSms.md
@@ -5,5 +5,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **reference** | **String** |  | 
 **messageId** | **Number** |  | 
+**smsCount** | **Number** | Count of SMS&#39;s to send multiple text messages | [optional] 
+**usedCredits** | **Number** | SMS credits used per text message | [optional] 
+**remainingCredits** | **Number** | Remaining SMS credits of the user | [optional] 
 
 
diff --git a/docs/SendSmtpEmail.md b/docs/SendSmtpEmail.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **textContent** | **String** | Plain Text body of the message ( Ignored if &#39;templateId&#39; is passed ) | [optional] 
 **subject** | **String** | Subject of the message. Mandatory if &#39;templateId&#39; is not passed | [optional] 
 **replyTo** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) |  | [optional] 
-**attachment** | [**[SendSmtpEmailAttachment]**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, [{&#39;url&#39;:&#39;https://attachment.domain.com/myAttachmentFromUrl.jpg&#39;, &#39;name&#39;:&#39;My attachment 1&#39;}, {&#39;content&#39;:&#39;base64 exmaple content&#39;, &#39;name&#39;:&#39;My attachment 2&#39;}]. Allowed extensions for attachment file: 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 ( Ignored if &#39;templateId&#39; is passed ) | [optional] 
+**attachment** | [**[SendSmtpEmailAttachment]**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, [{&#39;url&#39;:&#39;https://attachment.domain.com/myAttachmentFromUrl.jpg&#39;, &#39;name&#39;:&#39;My attachment 1&#39;}, {&#39;content&#39;:&#39;base64 exmaple content&#39;, &#39;name&#39;:&#39;My attachment 2&#39;}]. Allowed extensions for attachment file: 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, eps and odt ( Ignored if &#39;templateId&#39; is passed ) | [optional] 
 **headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. &#39;sender.ip&#39; header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {&#39;Content-Type&#39;:&#39;text/html&#39;, &#39;charset&#39;:&#39;iso-8859-1&#39;, &#39;sender.ip&#39;:&#39;1.2.3.4&#39;} | [optional] 
 **templateId** | **Number** | Id of the template | [optional] 
 **params** | **Object** | Pass the set of attributes to customize the template. For example, {&#39;FNAME&#39;:&#39;Joe&#39;, &#39;LNAME&#39;:&#39;Doe&#39;}. It&#39;s considered only if template is in New Template Language format. | [optional] 
diff --git a/docs/SendTestSms.md b/docs/SendTestSms.md
@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**phoneNumbers** | **[String]** | Mobile number with the country code to send test SMS. The mobile number defined here must belong to one of your contacts in SendinBlue account and must not be blacklisted | [optional] 
+**phoneNumber** | **String** | Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted | [optional] 
 
 
diff --git a/docs/UpdateCampaignStatus.md b/docs/UpdateCampaignStatus.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**status** | **String** |  | [optional] 
+**status** | **String** | Note:- replicateTemplate status will be available only for template type campaigns. | [optional] 
 
 
 <a name="StatusEnum"></a>
diff --git a/docs/UpdateContact.md b/docs/UpdateContact.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. For eg. {&#39;FNAME&#39;:&#39;Ellie&#39;, &#39;LNAME&#39;:&#39;Roger&#39;} | [optional] 
+**attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For eg. { &#39;EMAIL&#39;:&#39;newemail@domain.com&#39;, &#39;FNAME&#39;:&#39;Ellie&#39;, &#39;LNAME&#39;:&#39;Roger&#39;} | [optional] 
 **emailBlacklisted** | **Boolean** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted &#x3D; true) | [optional] 
 **smsBlacklisted** | **Boolean** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted &#x3D; true) | [optional] 
 **listIds** | **[Number]** | Ids of the lists to add the contact to | [optional] 
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "sib-api-v3-sdk",
-  "version": "7.0.4",
+  "version": "7.0.5",
   "description": "Official SendinBlue provided RESTFul API V3 nodejs library",
   "license": "ISC",
   "main": "src/index.js",
diff --git a/src/api/SMSCampaignsApi.js b/src/api/SMSCampaignsApi.js
@@ -441,20 +441,20 @@
     /**
      * Send an SMS
      * @param {Number} campaignId Id of the SMS campaign
-     * @param {module:model/SendTestSms} sendTestSms Mobile number to which send the test
+     * @param {module:model/SendTestSms} phoneNumber Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
      */
-    this.sendTestSmsWithHttpInfo = function(campaignId, sendTestSms) {
-      var postBody = sendTestSms;
+    this.sendTestSmsWithHttpInfo = function(campaignId, phoneNumber) {
+      var postBody = phoneNumber;
 
       // verify the required parameter 'campaignId' is set
       if (campaignId === undefined || campaignId === null) {
         throw new Error("Missing the required parameter 'campaignId' when calling sendTestSms");
       }
 
-      // verify the required parameter 'sendTestSms' is set
-      if (sendTestSms === undefined || sendTestSms === null) {
-        throw new Error("Missing the required parameter 'sendTestSms' when calling sendTestSms");
+      // verify the required parameter 'phoneNumber' is set
+      if (phoneNumber === undefined || phoneNumber === null) {
+        throw new Error("Missing the required parameter 'phoneNumber' when calling sendTestSms");
       }
 
 
@@ -485,11 +485,11 @@
     /**
      * Send an SMS
      * @param {Number} campaignId Id of the SMS campaign
-     * @param {module:model/SendTestSms} sendTestSms Mobile number to which send the test
+     * @param {module:model/SendTestSms} phoneNumber Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */
-    this.sendTestSms = function(campaignId, sendTestSms) {
-      return this.sendTestSmsWithHttpInfo(campaignId, sendTestSms)
+    this.sendTestSms = function(campaignId, phoneNumber) {
+      return this.sendTestSmsWithHttpInfo(campaignId, phoneNumber)
         .then(function(response_and_data) {
           return response_and_data.data;
         });
diff --git a/src/model/CreateWebhook.js b/src/model/CreateWebhook.js
@@ -45,13 +45,14 @@
    * @alias module:model/CreateWebhook
    * @class
    * @param url {String} URL of the webhook
+   * @param events {Array.<module:model/CreateWebhook.EventsEnum>} Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition & delivered
    */
-  var exports = function(url) {
+  var exports = function(url, events) {
     var _this = this;
 
     _this['url'] = url;
 
-
+    _this['events'] = events;
 
   };
 
diff --git a/src/model/GetSmsEventReportEvents.js b/src/model/GetSmsEventReportEvents.js
@@ -45,7 +45,7 @@
    * @alias module:model/GetSmsEventReportEvents
    * @class
    * @param phoneNumber {String} Phone number which has generated the event
-   * @param _date {Date} Date on which the event has been generated
+   * @param _date {Date} UTC date-time on which the event has been generated
    * @param messageId {String} Message ID which generated the event
    * @param event {module:model/GetSmsEventReportEvents.EventEnum} Event which occurred
    */
@@ -103,7 +103,7 @@
    */
   exports.prototype['phoneNumber'] = undefined;
   /**
-   * Date on which the event has been generated
+   * UTC date-time on which the event has been generated
    * @member {Date} date
    */
   exports.prototype['date'] = undefined;
diff --git a/src/model/RequestContactImport.js b/src/model/RequestContactImport.js
@@ -93,6 +93,9 @@
       if (data.hasOwnProperty('updateExistingContacts')) {
         obj['updateExistingContacts'] = ApiClient.convertToType(data['updateExistingContacts'], 'Boolean');
       }
+      if (data.hasOwnProperty('emptyContactsAttributes')) {
+        obj['emptyContactsAttributes'] = ApiClient.convertToType(data['emptyContactsAttributes'], 'Boolean');
+      }
     }
     return obj;
   }
@@ -139,6 +142,12 @@
    * @default true
    */
   exports.prototype['updateExistingContacts'] = true;
+  /**
+   * To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in SendinBlue, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if `updateExistingContacts` set to true )
+   * @member {Boolean} emptyContactsAttributes
+   * @default false
+   */
+  exports.prototype['emptyContactsAttributes'] = false;
 
 
 
diff --git a/src/model/RequestSmsRecipientExport.js b/src/model/RequestSmsRecipientExport.js
@@ -82,9 +82,8 @@
   /**
    * Filter the recipients based on how they interacted with the campaign
    * @member {module:model/RequestSmsRecipientExport.RecipientsTypeEnum} recipientsType
-   * @default 'all'
    */
-  exports.prototype['recipientsType'] = 'all';
+  exports.prototype['recipientsType'] = undefined;
 
 
   /**
diff --git a/src/model/SendReportEmail.js b/src/model/SendReportEmail.js
@@ -45,16 +45,16 @@
    * Email sending credentials including subject, body, to, cc etc.
    * @alias module:model/SendReportEmail
    * @class
+   * @param subject {String} Subject of the email message
+   * @param to {Array.<String>} Email addresses of the recipients
+   * @param body {String} Body of the email message
    */
-  var exports = function() {
+  var exports = function(subject, to, body) {
     var _this = this;
 
-
-
-
-
-
-
+    _this['subject'] = subject;
+    _this['to'] = to;
+    _this['body'] = body;
   };
 
   /**
@@ -103,8 +103,9 @@
   /**
    * Type of the message body
    * @member {module:model/SendReportEmail.ContentTypeEnum} contentType
+   * @default 'html'
    */
-  exports.prototype['contentType'] = undefined;
+  exports.prototype['contentType'] = 'html';
   /**
    * Email addresses of the recipients in bcc
    * @member {Array.<String>} bcc
diff --git a/src/model/SendSms.js b/src/model/SendSms.js
@@ -71,6 +71,15 @@
       if (data.hasOwnProperty('messageId')) {
         obj['messageId'] = ApiClient.convertToType(data['messageId'], 'Number');
       }
+      if (data.hasOwnProperty('smsCount')) {
+        obj['smsCount'] = ApiClient.convertToType(data['smsCount'], 'Number');
+      }
+      if (data.hasOwnProperty('usedCredits')) {
+        obj['usedCredits'] = ApiClient.convertToType(data['usedCredits'], 'Number');
+      }
+      if (data.hasOwnProperty('remainingCredits')) {
+        obj['remainingCredits'] = ApiClient.convertToType(data['remainingCredits'], 'Number');
+      }
     }
     return obj;
   }
@@ -83,6 +92,21 @@
    * @member {Number} messageId
    */
   exports.prototype['messageId'] = undefined;
+  /**
+   * Count of SMS's to send multiple text messages
+   * @member {Number} smsCount
+   */
+  exports.prototype['smsCount'] = undefined;
+  /**
+   * SMS credits used per text message
+   * @member {Number} usedCredits
+   */
+  exports.prototype['usedCredits'] = undefined;
+  /**
+   * Remaining SMS credits of the user
+   * @member {Number} remainingCredits
+   */
+  exports.prototype['remainingCredits'] = undefined;
 
 
 
diff --git a/src/model/SendSmtpEmail.js b/src/model/SendSmtpEmail.js
@@ -157,7 +157,7 @@
    */
   exports.prototype['replyTo'] = undefined;
   /**
-   * Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, [{'url':'https://attachment.domain.com/myAttachmentFromUrl.jpg', 'name':'My attachment 1'}, {'content':'base64 exmaple content', 'name':'My attachment 2'}]. Allowed extensions for attachment file: 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 ( Ignored if 'templateId' is passed )
+   * Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, [{'url':'https://attachment.domain.com/myAttachmentFromUrl.jpg', 'name':'My attachment 1'}, {'content':'base64 exmaple content', 'name':'My attachment 2'}]. Allowed extensions for attachment file: 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, eps and odt ( Ignored if 'templateId' is passed )
    * @member {Array.<module:model/SendSmtpEmailAttachment>} attachment
    */
   exports.prototype['attachment'] = undefined;
diff --git a/src/model/SendTestSms.js b/src/model/SendTestSms.js
@@ -62,18 +62,18 @@
     if (data) {
       obj = obj || new exports();
 
-      if (data.hasOwnProperty('phoneNumbers')) {
-        obj['phoneNumbers'] = ApiClient.convertToType(data['phoneNumbers'], ['String']);
+      if (data.hasOwnProperty('phoneNumber')) {
+        obj['phoneNumber'] = ApiClient.convertToType(data['phoneNumber'], 'String');
       }
     }
     return obj;
   }
 
   /**
-   * Mobile number with the country code to send test SMS. The mobile number defined here must belong to one of your contacts in SendinBlue account and must not be blacklisted
-   * @member {Array.<String>} phoneNumbers
+   * Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted
+   * @member {String} phoneNumber
    */
-  exports.prototype['phoneNumbers'] = undefined;
+  exports.prototype['phoneNumber'] = undefined;
 
 
 
diff --git a/src/model/UpdateCampaignStatus.js b/src/model/UpdateCampaignStatus.js
@@ -71,6 +71,7 @@
   }
 
   /**
+   * Note:- replicateTemplate status will be available only for template type campaigns.
    * @member {module:model/UpdateCampaignStatus.StatusEnum} status
    */
   exports.prototype['status'] = undefined;
diff --git a/src/model/UpdateContact.js b/src/model/UpdateContact.js
diff --git a/test/model/RequestContactImport.spec.js b/test/model/RequestContactImport.spec.js
diff --git a/test/model/SendSms.spec.js b/test/model/SendSms.spec.js
diff --git a/test/model/SendTestSms.spec.js b/test/model/SendTestSms.spec.js
