Socket
Socket
Sign inDemoInstall

sib-api-v3-sdk

Package Overview
Dependencies
38
Maintainers
2
Versions
42
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 7.0.3 to 7.0.4

2

docs/CreateEmailCampaign.md

@@ -25,3 +25,3 @@ # SibApiV3Sdk.CreateEmailCampaign

**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]
**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'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]

@@ -28,0 +28,0 @@

@@ -8,3 +8,3 @@ # SibApiV3Sdk.CreateSmsCampaign

**sender** | **String** | Name of the sender. The number of characters is limited to 11 |
**content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | [optional]
**content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS |
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]

@@ -11,0 +11,0 @@ **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]

@@ -7,4 +7,4 @@ # SibApiV3Sdk.CreateSmsCampaignRecipients

**listIds** | **[Number]** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty |
**exclusionListIds** | **[Number]** | List ids which have to be excluded from a campaign |
**exclusionListIds** | **[Number]** | List ids which have to be excluded from a campaign | [optional]

@@ -18,3 +18,4 @@ # SibApiV3Sdk.GetAggregatedReport

**invalid** | **Number** | Number of invalid emails for the timeframe |
**unsubscribed** | **Number** | Number of unsubscribed emails for the timeframe |

@@ -44,4 +44,6 @@ # SibApiV3Sdk.GetEmailEventReportEvents

* `unsubscribed` (value: `"unsubscribed"`)

@@ -18,3 +18,4 @@ # SibApiV3Sdk.GetReportsReports

**invalid** | **Number** | Number of invalid emails for the date |
**unsubscribed** | **Number** | Number of unsubscribed emails for the date |

@@ -11,3 +11,2 @@ # SibApiV3Sdk.GetSmsCampaignOverview

**scheduledAt** | **Date** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
**testSent** | **Boolean** | Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent) |
**sender** | **String** | Sender of the SMS Campaign |

@@ -32,3 +31,3 @@ **createdAt** | **Date** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |

* `in_process` (value: `"in_process"`)
* `inProcess` (value: `"inProcess"`)

@@ -35,0 +34,0 @@

@@ -12,3 +12,3 @@ # SibApiV3Sdk.SendEmail

**attachment** | [**[SendEmailAttachment]**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, [{'content':'base64 encoded content 1', 'name':'attcahment1'}, {'content':'base64 encoded content 2', 'name':'attcahment2'}]. | [optional]
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'X-Mailin-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', 'X-Mailin-IP':'1.2.3.4'} | [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]
**attributes** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} | [optional]

@@ -15,0 +15,0 @@ **tags** | **[String]** | Tag your emails to find them more easily | [optional]

@@ -15,7 +15,7 @@ # SibApiV3Sdk.SendSmtpEmail

**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]
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'X-Mailin-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', 'X-Mailin-IP':'1.2.3.4'} | [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]
**templateId** | **Number** | Id of the template | [optional]
**params** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. | [optional]
**params** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if template is in New Template Language format. | [optional]
**tags** | **[String]** | Tag your emails to find them more easily | [optional]

@@ -9,3 +9,3 @@ # SibApiV3Sdk.SendTransacSms

**content** | **String** | Content of the message. If more than 160 characters long, will be sent as multiple text messages |
**type** | **String** | Type of the SMS | [optional] [default to 'transactional']
**type** | **String** | Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. | [optional] [default to 'transactional']
**tag** | **String** | Tag of the message | [optional]

@@ -12,0 +12,0 @@ **webUrl** | **String** | Webhook to call for each event triggered by the message (delivered etc.) | [optional]

@@ -187,2 +187,4 @@ # SibApiV3Sdk.SMSCampaignsApi

'status': "status_example", // String | Status of campaign.
'startDate': new Date("2013-10-20T19:20:30+01:00"), // Date | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
'endDate': new Date("2013-10-20T19:20:30+01:00"), // Date | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
'limit': 500, // Number | Number limitation for the result returned

@@ -204,2 +206,4 @@ 'offset': 0 // Number | Beginning point in the list to retrieve from.

**status** | **String**| Status of campaign. | [optional]
**startDate** | **Date**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
**endDate** | **Date**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
**limit** | **Number**| Number limitation for the result returned | [optional] [default to 500]

@@ -206,0 +210,0 @@ **offset** | **Number**| Beginning point in the list to retrieve from. | [optional] [default to 0]

@@ -23,4 +23,4 @@ # SibApiV3Sdk.UpdateEmailCampaign

**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]
**params** | **Object** | Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
{
"name": "sib-api-v3-sdk",
"version": "7.0.3",
"version": "7.0.4",
"description": "Official SendinBlue provided RESTFul API V3 nodejs library",

@@ -5,0 +5,0 @@ "license": "ISC",

@@ -215,2 +215,4 @@ /**

* @param {module:model/String} opts.status Status of campaign.
* @param {Date} opts.startDate Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
* @param {Date} opts.endDate Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
* @param {Number} opts.limit Number limitation for the result returned (default to 500)

@@ -229,2 +231,4 @@ * @param {Number} opts.offset Beginning point in the list to retrieve from. (default to 0)

'status': opts['status'],
'startDate': opts['startDate'],
'endDate': opts['endDate'],
'limit': opts['limit'],

@@ -256,2 +260,4 @@ 'offset': opts['offset'],

* @param {module:model/String} opts.status Status of campaign.
* @param {Date} opts.startDate Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
* @param {Date} opts.endDate Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
* @param {Number} opts.limit Number limitation for the result returned (default to 500)

@@ -258,0 +264,0 @@ * @param {Number} opts.offset Beginning point in the list to retrieve from. (default to 0)

@@ -246,3 +246,3 @@ /**

/**
* Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'
* Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
* @member {Object} params

@@ -249,0 +249,0 @@ */

@@ -49,4 +49,5 @@ /**

* @param sender {String} Name of the sender. The number of characters is limited to 11
* @param content {String} Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS
*/
var exports = function(name, sender) {
var exports = function(name, sender, content) {
var _this = this;

@@ -56,5 +57,5 @@

_this['sender'] = sender;
_this['content'] = content;
};

@@ -61,0 +62,0 @@

@@ -48,9 +48,8 @@ /**

* @param listIds {Array.<Number>} Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty
* @param exclusionListIds {Array.<Number>} List ids which have to be excluded from a campaign
*/
var exports = function(listIds, exclusionListIds) {
var exports = function(listIds) {
var _this = this;
_this['listIds'] = listIds;
_this['exclusionListIds'] = exclusionListIds;
};

@@ -57,0 +56,0 @@

@@ -59,4 +59,5 @@ /**

* @param invalid {Number} Number of invalid emails for the timeframe
* @param unsubscribed {Number} Number of unsubscribed emails for the timeframe
*/
var exports = function(range, requests, delivered, hardBounces, softBounces, clicks, uniqueClicks, opens, uniqueOpens, spamReports, blocked, invalid) {
var exports = function(range, requests, delivered, hardBounces, softBounces, clicks, uniqueClicks, opens, uniqueOpens, spamReports, blocked, invalid, unsubscribed) {
var _this = this;

@@ -76,2 +77,3 @@

_this['invalid'] = invalid;
_this['unsubscribed'] = unsubscribed;
};

@@ -126,2 +128,5 @@

}
if (data.hasOwnProperty('unsubscribed')) {
obj['unsubscribed'] = ApiClient.convertToType(data['unsubscribed'], 'Number');
}
}

@@ -191,2 +196,7 @@ return obj;

exports.prototype['invalid'] = undefined;
/**
* Number of unsubscribed emails for the timeframe
* @member {Number} unsubscribed
*/
exports.prototype['unsubscribed'] = undefined;

@@ -193,0 +203,0 @@

@@ -224,3 +224,8 @@ /**

*/
"blocked": "blocked" };
"blocked": "blocked",
/**
* value: "unsubscribed"
* @const
*/
"unsubscribed": "unsubscribed" };

@@ -227,0 +232,0 @@

@@ -59,4 +59,5 @@ /**

* @param invalid {Number} Number of invalid emails for the date
* @param unsubscribed {Number} Number of unsubscribed emails for the date
*/
var exports = function(_date, requests, delivered, hardBounces, softBounces, clicks, uniqueClicks, opens, uniqueOpens, spamReports, blocked, invalid) {
var exports = function(_date, requests, delivered, hardBounces, softBounces, clicks, uniqueClicks, opens, uniqueOpens, spamReports, blocked, invalid, unsubscribed) {
var _this = this;

@@ -76,2 +77,3 @@

_this['invalid'] = invalid;
_this['unsubscribed'] = unsubscribed;
};

@@ -126,2 +128,5 @@

}
if (data.hasOwnProperty('unsubscribed')) {
obj['unsubscribed'] = ApiClient.convertToType(data['unsubscribed'], 'Number');
}
}

@@ -191,2 +196,7 @@ return obj;

exports.prototype['invalid'] = undefined;
/**
* Number of unsubscribed emails for the date
* @member {Number} unsubscribed
*/
exports.prototype['unsubscribed'] = undefined;

@@ -193,0 +203,0 @@

@@ -53,3 +53,2 @@ /**

* @param scheduledAt {Date} UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format
* @param testSent {Boolean} Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent)
* @param sender {String} Sender of the SMS Campaign

@@ -61,6 +60,6 @@ * @param createdAt {Date} Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

*/
var exports = function(id, name, status, content, scheduledAt, testSent, sender, createdAt, modifiedAt, recipients, statistics) {
var exports = function(id, name, status, content, scheduledAt, sender, createdAt, modifiedAt, recipients, statistics) {
var _this = this;
GetSmsCampaignOverview.call(_this, id, name, status, content, scheduledAt, testSent, sender, createdAt, modifiedAt);
GetSmsCampaignOverview.call(_this, id, name, status, content, scheduledAt, sender, createdAt, modifiedAt);
_this['recipients'] = recipients;

@@ -133,8 +132,2 @@ _this['statistics'] = statistics;

/**
* Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent)
* @member {Boolean} testSent
*/
exports.prototype['testSent'] = undefined;
/**
* Sender of the SMS Campaign

@@ -141,0 +134,0 @@ * @member {String} sender

@@ -52,3 +52,2 @@ /**

* @param scheduledAt {Date} UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format
* @param testSent {Boolean} Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent)
* @param sender {String} Sender of the SMS Campaign

@@ -58,3 +57,3 @@ * @param createdAt {Date} Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

*/
var exports = function(id, name, status, content, scheduledAt, testSent, sender, createdAt, modifiedAt) {
var exports = function(id, name, status, content, scheduledAt, sender, createdAt, modifiedAt) {
var _this = this;

@@ -67,3 +66,2 @@

_this['scheduledAt'] = scheduledAt;
_this['testSent'] = testSent;
_this['sender'] = sender;

@@ -100,5 +98,2 @@ _this['createdAt'] = createdAt;

}
if (data.hasOwnProperty('testSent')) {
obj['testSent'] = ApiClient.convertToType(data['testSent'], 'Boolean');
}
if (data.hasOwnProperty('sender')) {

@@ -143,7 +138,2 @@ obj['sender'] = ApiClient.convertToType(data['sender'], 'String');

/**
* Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent)
* @member {Boolean} testSent
*/
exports.prototype['testSent'] = undefined;
/**
* Sender of the SMS Campaign

@@ -197,6 +187,6 @@ * @member {String} sender

/**
* value: "in_process"
* value: "inProcess"
* @const
*/
"in_process": "in_process" };
"inProcess": "inProcess" };

@@ -203,0 +193,0 @@

@@ -136,3 +136,3 @@ /**

/**
* Pass the set of headers that shall be sent along the mail headers in the original email. 'X-Mailin-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', 'X-Mailin-IP':'1.2.3.4'}
* 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'}
* @member {Object} headers

@@ -139,0 +139,0 @@ */

@@ -165,3 +165,3 @@ /**

/**
* Pass the set of headers that shall be sent along the mail headers in the original email. 'X-Mailin-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', 'X-Mailin-IP':'1.2.3.4'}
* 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'}
* @member {Object} headers

@@ -176,3 +176,3 @@ */

/**
* Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}.
* Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if template is in New Template Language format.
* @member {Object} params

@@ -179,0 +179,0 @@ */

@@ -111,3 +111,3 @@ /**

/**
* Type of the SMS
* Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc.
* @member {module:model/SendTransacSms.TypeEnum} type

@@ -114,0 +114,0 @@ * @default 'transactional'

@@ -225,3 +225,3 @@ /**

/**
* Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}.
* Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
* @member {Object} params

@@ -228,0 +228,0 @@ */

@@ -132,4 +132,10 @@ /**

it('should have the property unsubscribed (base name: "unsubscribed")', function() {
// uncomment below and update the code to test the property unsubscribed
//var instane = new SibApiV3Sdk.GetAggregatedReport();
//expect(instance).to.be();
});
});
}));

@@ -132,4 +132,10 @@ /**

it('should have the property unsubscribed (base name: "unsubscribed")', function() {
// uncomment below and update the code to test the property unsubscribed
//var instane = new SibApiV3Sdk.GetReportsReports();
//expect(instance).to.be();
});
});
}));

@@ -90,8 +90,2 @@ /**

it('should have the property testSent (base name: "testSent")', function() {
// uncomment below and update the code to test the property testSent
//var instane = new SibApiV3Sdk.GetSmsCampaignOverview();
//expect(instance).to.be();
});
it('should have the property sender (base name: "sender")', function() {

@@ -98,0 +92,0 @@ // uncomment below and update the code to test the property sender

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc