sib-api-v3-sdk
Advanced tools
Comparing version 7.0.4 to 7.0.5
@@ -8,3 +8,3 @@ # SibApiV3Sdk.CreateWebhook | ||
| **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 & 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 & delivered | | ||
| **type** | **String** | Type of the webhook | [optional] [default to 'transactional'] | ||
@@ -11,0 +11,0 @@ |
@@ -7,3 +7,3 @@ # SibApiV3Sdk.GetSmsEventReportEvents | ||
| **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 | | ||
@@ -10,0 +10,0 @@ **event** | **String** | Event which occurred | |
@@ -14,3 +14,4 @@ # SibApiV3Sdk.RequestContactImport | ||
| **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 = 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 ) | [optional] [default to false] | ||
@@ -7,3 +7,3 @@ # SibApiV3Sdk.RequestSmsRecipientExport | ||
| **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 'all'] | ||
| **recipientsType** | **String** | Filter the recipients based on how they interacted with the campaign | | ||
@@ -10,0 +10,0 @@ |
@@ -6,8 +6,8 @@ # SibApiV3Sdk.SendReportEmail | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **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 'html'] | ||
| **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 | | ||
@@ -14,0 +14,0 @@ |
@@ -8,3 +8,6 @@ # SibApiV3Sdk.SendSms | ||
| **messageId** | **Number** | | | ||
| **smsCount** | **Number** | Count of SMS'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] | ||
@@ -14,3 +14,3 @@ # SibApiV3Sdk.SendSmtpEmail | ||
| **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, [{'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 ) | [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, [{'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 ) | [optional] | ||
| **headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} | [optional] | ||
@@ -17,0 +17,0 @@ **templateId** | **Number** | Id of the template | [optional] |
@@ -6,4 +6,4 @@ # SibApiV3Sdk.SendTestSms | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **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] | ||
@@ -380,3 +380,3 @@ # SibApiV3Sdk.SMSCampaignsApi | ||
| # **sendTestSms** | ||
| > sendTestSms(campaignId, sendTestSms) | ||
| > sendTestSms(campaignId, phoneNumber) | ||
@@ -400,5 +400,5 @@ Send an SMS | ||
| 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.'); | ||
@@ -416,3 +416,3 @@ }, function(error) { | ||
| **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 | | ||
@@ -419,0 +419,0 @@ ### Return type |
@@ -6,3 +6,3 @@ # SibApiV3Sdk.UpdateCampaignStatus | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **status** | **String** | | [optional] | ||
| **status** | **String** | Note:- replicateTemplate status will be available only for template type campaigns. | [optional] | ||
@@ -9,0 +9,0 @@ |
@@ -6,3 +6,3 @@ # SibApiV3Sdk.UpdateContact | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. For eg. {'FNAME':'Ellie', 'LNAME':'Roger'} | [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. { 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'} | [optional] | ||
| **emailBlacklisted** | **Boolean** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional] | ||
@@ -9,0 +9,0 @@ **smsBlacklisted** | **Boolean** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional] |
| ISC License | ||
| Copyright (c) 2018, SendinBlue | ||
| Copyright (c) 2019, SendinBlue | ||
@@ -5,0 +5,0 @@ Permission to use, copy, modify, and/or distribute this software for any |
| { | ||
| "name": "sib-api-v3-sdk", | ||
| "version": "7.0.4", | ||
| "version": "7.0.5", | ||
| "description": "Official SendinBlue provided RESTFul API V3 nodejs library", | ||
@@ -5,0 +5,0 @@ "license": "ISC", |
@@ -444,7 +444,7 @@ /** | ||
| * @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; | ||
@@ -456,5 +456,5 @@ // verify the required parameter 'campaignId' is set | ||
| // 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"); | ||
| } | ||
@@ -490,7 +490,7 @@ | ||
| * @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) { | ||
@@ -497,0 +497,0 @@ return response_and_data.data; |
@@ -48,4 +48,5 @@ /** | ||
| * @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; | ||
@@ -55,4 +56,4 @@ | ||
| _this['events'] = events; | ||
| }; | ||
@@ -59,0 +60,0 @@ |
@@ -48,3 +48,3 @@ /** | ||
| * @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 | ||
@@ -107,3 +107,3 @@ * @param event {module:model/GetSmsEventReportEvents.EventEnum} Event which occurred | ||
| /** | ||
| * Date on which the event has been generated | ||
| * UTC date-time on which the event has been generated | ||
| * @member {Date} date | ||
@@ -110,0 +110,0 @@ */ |
@@ -96,2 +96,5 @@ /** | ||
| } | ||
| if (data.hasOwnProperty('emptyContactsAttributes')) { | ||
| obj['emptyContactsAttributes'] = ApiClient.convertToType(data['emptyContactsAttributes'], 'Boolean'); | ||
| } | ||
| } | ||
@@ -143,2 +146,8 @@ return obj; | ||
| 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; | ||
@@ -145,0 +154,0 @@ |
@@ -85,5 +85,4 @@ /** | ||
| * @member {module:model/RequestSmsRecipientExport.RecipientsTypeEnum} recipientsType | ||
| * @default 'all' | ||
| */ | ||
| exports.prototype['recipientsType'] = 'all'; | ||
| exports.prototype['recipientsType'] = undefined; | ||
@@ -90,0 +89,0 @@ |
@@ -48,12 +48,12 @@ /** | ||
| * @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; | ||
| }; | ||
@@ -107,4 +107,5 @@ | ||
| * @member {module:model/SendReportEmail.ContentTypeEnum} contentType | ||
| * @default 'html' | ||
| */ | ||
| exports.prototype['contentType'] = undefined; | ||
| exports.prototype['contentType'] = 'html'; | ||
| /** | ||
@@ -111,0 +112,0 @@ * Email addresses of the recipients in bcc |
@@ -74,2 +74,11 @@ /** | ||
| } | ||
| 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'); | ||
| } | ||
| } | ||
@@ -87,2 +96,17 @@ return obj; | ||
| 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; | ||
@@ -89,0 +113,0 @@ |
@@ -160,3 +160,3 @@ /** | ||
| /** | ||
| * 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 | ||
@@ -163,0 +163,0 @@ */ |
@@ -65,4 +65,4 @@ /** | ||
| if (data.hasOwnProperty('phoneNumbers')) { | ||
| obj['phoneNumbers'] = ApiClient.convertToType(data['phoneNumbers'], ['String']); | ||
| if (data.hasOwnProperty('phoneNumber')) { | ||
| obj['phoneNumber'] = ApiClient.convertToType(data['phoneNumber'], 'String'); | ||
| } | ||
@@ -74,6 +74,6 @@ } | ||
| /** | ||
| * 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; | ||
@@ -80,0 +80,0 @@ |
@@ -74,2 +74,3 @@ /** | ||
| /** | ||
| * Note:- replicateTemplate status will be available only for template type campaigns. | ||
| * @member {module:model/UpdateCampaignStatus.StatusEnum} status | ||
@@ -76,0 +77,0 @@ */ |
@@ -93,3 +93,3 @@ /** | ||
| /** | ||
| * Pass the set of attributes to be updated. These attributes must be present in your account. For eg. {'FNAME':'Ellie', 'LNAME':'Roger'} | ||
| * 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. { 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'} | ||
| * @member {Object} attributes | ||
@@ -96,0 +96,0 @@ */ |
@@ -108,4 +108,10 @@ /** | ||
| it('should have the property emptyContactsAttributes (base name: "emptyContactsAttributes")', function() { | ||
| // uncomment below and update the code to test the property emptyContactsAttributes | ||
| //var instane = new SibApiV3Sdk.RequestContactImport(); | ||
| //expect(instance).to.be(); | ||
| }); | ||
| }); | ||
| })); |
@@ -72,4 +72,22 @@ /** | ||
| it('should have the property smsCount (base name: "smsCount")', function() { | ||
| // uncomment below and update the code to test the property smsCount | ||
| //var instane = new SibApiV3Sdk.SendSms(); | ||
| //expect(instance).to.be(); | ||
| }); | ||
| it('should have the property usedCredits (base name: "usedCredits")', function() { | ||
| // uncomment below and update the code to test the property usedCredits | ||
| //var instane = new SibApiV3Sdk.SendSms(); | ||
| //expect(instance).to.be(); | ||
| }); | ||
| it('should have the property remainingCredits (base name: "remainingCredits")', function() { | ||
| // uncomment below and update the code to test the property remainingCredits | ||
| //var instane = new SibApiV3Sdk.SendSms(); | ||
| //expect(instance).to.be(); | ||
| }); | ||
| }); | ||
| })); |
@@ -60,4 +60,4 @@ /** | ||
| it('should have the property phoneNumbers (base name: "phoneNumbers")', function() { | ||
| // uncomment below and update the code to test the property phoneNumbers | ||
| it('should have the property phoneNumber (base name: "phoneNumber")', function() { | ||
| // uncomment below and update the code to test the property phoneNumber | ||
| //var instane = new SibApiV3Sdk.SendTestSms(); | ||
@@ -69,2 +69,2 @@ //expect(instance).to.be(); | ||
| })); | ||
| })); |
No alert changes
Improved metrics
- Total package byte prevSize
- increased by0.27%
1821305
- Lines of code
- increased by0.18%
35153
No dependency changes